Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1048.2.2
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1048.2.2! raeburn 4: # $Id: lonnet.pm,v 1.1048.2.1 2010/01/15 00:14:01 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.977 amueller 102: my $upload_photo_form = 0; #Variable to check when user upload a photo 0=not 1=true
103:
1.619 albertel 104: require Exporter;
105:
106: our @ISA = qw (Exporter);
107: our @EXPORT = qw(%env);
108:
1.449 matthew 109:
1.1 albertel 110: # --------------------------------------------------------------------- Logging
1.729 www 111: {
112: my $logid;
113: sub instructor_log {
1.957 raeburn 114: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
115: if (($cnum eq '') || ($cdom eq '')) {
116: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
117: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
118: }
1.729 www 119: $logid++;
1.957 raeburn 120: my $now = time();
121: my $id=$now.'00000'.$$.'00000'.$logid;
1.729 www 122: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 123: { $id => {
124: 'exe_uname' => $env{'user.name'},
125: 'exe_udom' => $env{'user.domain'},
1.957 raeburn 126: 'exe_time' => $now,
1.730 www 127: 'exe_ip' => $ENV{'REMOTE_ADDR'},
128: 'delflag' => $delflag,
129: 'logentry' => $storehash,
130: 'uname' => $uname,
131: 'udom' => $udom,
132: }
1.957 raeburn 133: },$cdom,$cnum);
1.729 www 134: }
135: }
1.1 albertel 136:
1.163 harris41 137: sub logtouch {
138: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 139: unless (-e "$execdir/logs/lonnet.log") {
140: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 141: close $fh;
142: }
143: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
144: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
145: }
146:
1.1 albertel 147: sub logthis {
148: my $message=shift;
149: my $execdir=$perlvar{'lonDaemons'};
150: my $now=time;
151: my $local=localtime($now);
1.448 albertel 152: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986 foxr 153: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
154: print $fh $logstring;
1.448 albertel 155: close($fh);
156: }
1.1 albertel 157: return 1;
158: }
159:
160: sub logperm {
161: my $message=shift;
162: my $execdir=$perlvar{'lonDaemons'};
163: my $now=time;
164: my $local=localtime($now);
1.448 albertel 165: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
166: print $fh "$now:$message:$local\n";
167: close($fh);
168: }
1.1 albertel 169: return 1;
170: }
171:
1.850 albertel 172: sub create_connection {
1.853 albertel 173: my ($hostname,$lonid) = @_;
1.851 albertel 174: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 175: Type => SOCK_STREAM,
176: Timeout => 10);
177: return 0 if (!$client);
1.890 albertel 178: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 179: my $result = <$client>;
180: chomp($result);
181: return 1 if ($result eq 'done');
182: return 0;
183: }
184:
1.983 raeburn 185: sub get_server_timezone {
186: my ($cnum,$cdom) = @_;
187: my $home=&homeserver($cnum,$cdom);
188: if ($home ne 'no_host') {
189: my $cachetime = 24*3600;
190: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
191: if (defined($cached)) {
192: return $timezone;
193: } else {
194: my $timezone = &reply('servertimezone',$home);
195: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
196: }
197: }
198: }
1.850 albertel 199:
1.993 raeburn 200: sub get_server_loncaparev {
201: my ($dom,$lonhost) = @_;
202: if (defined($lonhost)) {
203: if (!defined(&hostname($lonhost))) {
204: undef($lonhost);
205: }
206: }
207: if (!defined($lonhost)) {
208: if (defined(&domain($dom,'primary'))) {
209: $lonhost=&domain($dom,'primary');
210: if ($lonhost eq 'no_host') {
211: undef($lonhost);
212: }
213: }
214: }
215: if (defined($lonhost)) {
216: my $cachetime = 24*3600;
217: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
218: if (defined($cached)) {
219: return $loncaparev;
220: } else {
221: my $loncaparev = &reply('serverloncaparev',$lonhost);
222: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
223: }
224: }
225: }
226:
1.1 albertel 227: # -------------------------------------------------- Non-critical communication
228: sub subreply {
229: my ($cmd,$server)=@_;
1.838 albertel 230: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 231: #
232: # With loncnew process trimming, there's a timing hole between lonc server
233: # process exit and the master server picking up the listen on the AF_UNIX
234: # socket. In that time interval, a lock file will exist:
235:
236: my $lockfile=$peerfile.".lock";
237: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
238: sleep(1);
239: }
240: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 241: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 242: #
1.550 foxr 243: # We'll give the connection a few tries before abandoning it. If
244: # connection is not possible, we'll con_lost back to the client.
245: #
246: my $client;
247: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
248: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
249: Type => SOCK_STREAM,
250: Timeout => 10);
1.869 albertel 251: if ($client) {
1.550 foxr 252: last; # Connected!
1.850 albertel 253: } else {
1.853 albertel 254: &create_connection(&hostname($server),$server);
1.550 foxr 255: }
1.850 albertel 256: sleep(1); # Try again later if failed connection.
1.550 foxr 257: }
258: my $answer;
259: if ($client) {
1.704 albertel 260: print $client "sethost:$server:$cmd\n";
1.550 foxr 261: $answer=<$client>;
262: if (!$answer) { $answer="con_lost"; }
263: chomp($answer);
264: } else {
265: $answer = 'con_lost'; # Failed connection.
266: }
1.1 albertel 267: return $answer;
268: }
269:
270: sub reply {
271: my ($cmd,$server)=@_;
1.838 albertel 272: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 273: my $answer=subreply($cmd,$server);
1.65 www 274: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 275: &logthis("<font color=\"blue\">WARNING:".
1.12 www 276: " $cmd to $server returned $answer</font>");
277: }
1.1 albertel 278: return $answer;
279: }
280:
281: # ----------------------------------------------------------- Send USR1 to lonc
282:
283: sub reconlonc {
1.891 albertel 284: my ($lonid) = @_;
285: my $hostname = &hostname($lonid);
286: if ($lonid) {
287: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
288: if ($hostname && -e $peerfile) {
289: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
290: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
291: Type => SOCK_STREAM,
292: Timeout => 10);
293: if ($client) {
294: print $client ("reset_retries\n");
295: my $answer=<$client>;
296: #reset just this one.
297: }
298: }
299: return;
300: }
301:
1.836 www 302: &logthis("Trying to reconnect lonc");
1.1 albertel 303: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 304: if (open(my $fh,"<$loncfile")) {
1.1 albertel 305: my $loncpid=<$fh>;
306: chomp($loncpid);
307: if (kill 0 => $loncpid) {
308: &logthis("lonc at pid $loncpid responding, sending USR1");
309: kill USR1 => $loncpid;
310: sleep 1;
1.836 www 311: } else {
1.12 www 312: &logthis(
1.672 albertel 313: "<font color=\"blue\">WARNING:".
1.12 www 314: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 315: }
316: } else {
1.836 www 317: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 318: }
319: }
320:
321: # ------------------------------------------------------ Critical communication
1.12 www 322:
1.1 albertel 323: sub critical {
324: my ($cmd,$server)=@_;
1.838 albertel 325: unless (&hostname($server)) {
1.672 albertel 326: &logthis("<font color=\"blue\">WARNING:".
1.89 www 327: " Critical message to unknown server ($server)</font>");
328: return 'no_such_host';
329: }
1.1 albertel 330: my $answer=reply($cmd,$server);
331: if ($answer eq 'con_lost') {
332: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 333: my $answer=reply($cmd,$server);
1.1 albertel 334: if ($answer eq 'con_lost') {
335: my $now=time;
336: my $middlename=$cmd;
1.5 www 337: $middlename=substr($middlename,0,16);
1.1 albertel 338: $middlename=~s/\W//g;
339: my $dfilename=
1.305 www 340: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
341: $dumpcount++;
1.1 albertel 342: {
1.448 albertel 343: my $dfh;
344: if (open($dfh,">$dfilename")) {
345: print $dfh "$cmd\n";
346: close($dfh);
347: }
1.1 albertel 348: }
349: sleep 2;
350: my $wcmd='';
351: {
1.448 albertel 352: my $dfh;
353: if (open($dfh,"<$dfilename")) {
354: $wcmd=<$dfh>;
355: close($dfh);
356: }
1.1 albertel 357: }
358: chomp($wcmd);
1.7 www 359: if ($wcmd eq $cmd) {
1.672 albertel 360: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 361: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 362: &logperm("D:$server:$cmd");
363: return 'con_delayed';
364: } else {
1.672 albertel 365: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 366: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 367: &logperm("F:$server:$cmd");
368: return 'con_failed';
369: }
370: }
371: }
372: return $answer;
1.405 albertel 373: }
374:
1.755 albertel 375: # ------------------------------------------- check if return value is an error
376:
377: sub error {
378: my ($result) = @_;
1.756 albertel 379: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 380: if ($2 == 2) { return undef; }
381: return $1;
382: }
383: return undef;
384: }
385:
1.783 albertel 386: sub convert_and_load_session_env {
387: my ($lonidsdir,$handle)=@_;
388: my @profile;
389: {
1.917 albertel 390: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
391: if (!$opened) {
1.915 albertel 392: return 0;
393: }
1.783 albertel 394: flock($idf,LOCK_SH);
395: @profile=<$idf>;
396: close($idf);
397: }
398: my %temp_env;
399: foreach my $line (@profile) {
1.786 albertel 400: if ($line !~ m/=/) {
401: return 0;
402: }
1.783 albertel 403: chomp($line);
404: my ($envname,$envvalue)=split(/=/,$line,2);
405: $temp_env{&unescape($envname)} = &unescape($envvalue);
406: }
407: unlink("$lonidsdir/$handle.id");
408: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
409: 0640)) {
410: %disk_env = %temp_env;
411: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
412: untie(%disk_env);
413: }
1.786 albertel 414: return 1;
1.783 albertel 415: }
416:
1.374 www 417: # ------------------------------------------- Transfer profile into environment
1.780 albertel 418: my $env_loaded;
419: sub transfer_profile_to_env {
1.788 albertel 420: my ($lonidsdir,$handle,$force_transfer) = @_;
421: if (!$force_transfer && $env_loaded) { return; }
1.374 www 422:
1.720 albertel 423: if (!defined($lonidsdir)) {
424: $lonidsdir = $perlvar{'lonIDsDir'};
425: }
426: if (!defined($handle)) {
427: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
428: }
429:
1.786 albertel 430: my $convert;
431: {
1.917 albertel 432: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
433: if (!$opened) {
1.915 albertel 434: return;
435: }
1.786 albertel 436: flock($idf,LOCK_SH);
437: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
438: &GDBM_READER(),0640)) {
439: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
440: untie(%disk_env);
441: } else {
442: $convert = 1;
443: }
444: }
445: if ($convert) {
446: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
447: &logthis("Failed to load session, or convert session.");
448: }
1.374 www 449: }
1.783 albertel 450:
1.786 albertel 451: my %remove;
1.783 albertel 452: while ( my $envname = each(%env) ) {
1.433 matthew 453: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
454: if ($time < time-300) {
1.783 albertel 455: $remove{$key}++;
1.433 matthew 456: }
457: }
458: }
1.783 albertel 459:
1.619 albertel 460: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 461: $env_loaded=1;
1.783 albertel 462: foreach my $expired_key (keys(%remove)) {
1.433 matthew 463: &delenv($expired_key);
1.374 www 464: }
1.1 albertel 465: }
466:
1.916 albertel 467: # ---------------------------------------------------- Check for valid session
468: sub check_for_valid_session {
469: my ($r) = @_;
470: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
471: my $lonid=$cookies{'lonID'};
472: return undef if (!$lonid);
473:
474: my $handle=&LONCAPA::clean_handle($lonid->value);
475: my $lonidsdir=$r->dir_config('lonIDsDir');
476: return undef if (!-e "$lonidsdir/$handle.id");
477:
1.917 albertel 478: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
479: return undef if (!$opened);
1.916 albertel 480:
481: flock($idf,LOCK_SH);
482: my %disk_env;
483: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
484: &GDBM_READER(),0640)) {
485: return undef;
486: }
487:
488: if (!defined($disk_env{'user.name'})
489: || !defined($disk_env{'user.domain'})) {
490: return undef;
491: }
492: return $handle;
493: }
494:
1.830 albertel 495: sub timed_flock {
496: my ($file,$lock_type) = @_;
497: my $failed=0;
498: eval {
499: local $SIG{__DIE__}='DEFAULT';
500: local $SIG{ALRM}=sub {
501: $failed=1;
502: die("failed lock");
503: };
504: alarm(13);
505: flock($file,$lock_type);
506: alarm(0);
507: };
508: if ($failed) {
509: return undef;
510: } else {
511: return 1;
512: }
513: }
514:
1.5 www 515: # ---------------------------------------------------------- Append Environment
516:
517: sub appenv {
1.949 raeburn 518: my ($newenv,$roles) = @_;
519: if (ref($newenv) eq 'HASH') {
520: foreach my $key (keys(%{$newenv})) {
521: my $refused = 0;
522: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
523: $refused = 1;
524: if (ref($roles) eq 'ARRAY') {
525: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
526: if (grep(/^\Q$role\E$/,@{$roles})) {
527: $refused = 0;
528: }
529: }
530: }
531: if ($refused) {
532: &logthis("<font color=\"blue\">WARNING: ".
533: "Attempt to modify environment ".$key." to ".$newenv->{$key}
534: .'</font>');
535: delete($newenv->{$key});
536: } else {
537: $env{$key}=$newenv->{$key};
538: }
539: }
540: my $opened = open(my $env_file,'+<',$env{'user.environment'});
541: if ($opened
542: && &timed_flock($env_file,LOCK_EX)
543: &&
544: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
545: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
546: while (my ($key,$value) = each(%{$newenv})) {
547: $disk_env{$key} = $value;
548: }
549: untie(%disk_env);
1.35 www 550: }
1.191 harris41 551: }
1.56 www 552: return 'ok';
553: }
554: # ----------------------------------------------------- Delete from Environment
555:
556: sub delenv {
1.987 raeburn 557: my ($delthis,$regexp) = @_;
1.56 www 558: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 559: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 560: "Attempt to delete from environment ".$delthis);
561: return 'error';
562: }
1.917 albertel 563: my $opened = open(my $env_file,'+<',$env{'user.environment'});
564: if ($opened
1.915 albertel 565: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 566: &&
567: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
568: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 569: foreach my $key (keys(%disk_env)) {
1.987 raeburn 570: if ($regexp) {
571: if ($key=~/^$delthis/) {
572: delete($env{$key});
573: delete($disk_env{$key});
574: }
575: } else {
576: if ($key=~/^\Q$delthis\E/) {
577: delete($env{$key});
578: delete($disk_env{$key});
579: }
580: }
1.448 albertel 581: }
1.783 albertel 582: untie(%disk_env);
1.5 www 583: }
584: return 'ok';
1.369 albertel 585: }
586:
1.790 albertel 587: sub get_env_multiple {
588: my ($name) = @_;
589: my @values;
590: if (defined($env{$name})) {
591: # exists is it an array
592: if (ref($env{$name})) {
593: @values=@{ $env{$name} };
594: } else {
595: $values[0]=$env{$name};
596: }
597: }
598: return(@values);
599: }
600:
1.958 www 601: # ------------------------------------------------------------------- Locking
602:
603: sub set_lock {
604: my ($text)=@_;
605: $locknum++;
606: my $id=$$.'-'.$locknum;
607: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
608: 'session.lock.'.$id => $text});
609: return $id;
610: }
611:
612: sub get_locks {
613: my $num=0;
614: my %texts=();
615: foreach my $lock (split(/\,/,$env{'session.locks'})) {
616: if ($lock=~/\w/) {
617: $num++;
618: $texts{$lock}=$env{'session.lock.'.$lock};
619: }
620: }
621: return ($num,%texts);
622: }
623:
624: sub remove_lock {
625: my ($id)=@_;
626: my $newlocks='';
627: foreach my $lock (split(/\,/,$env{'session.locks'})) {
628: if (($lock=~/\w/) && ($lock ne $id)) {
629: $newlocks.=','.$lock;
630: }
631: }
632: &appenv({'session.locks' => $newlocks});
633: &delenv('session.lock.'.$id);
634: }
635:
636: sub remove_all_locks {
637: my $activelocks=$env{'session.locks'};
638: foreach my $lock (split(/\,/,$env{'session.locks'})) {
639: if ($lock=~/\w/) {
640: &remove_lock($lock);
641: }
642: }
643: }
644:
645:
1.369 albertel 646: # ------------------------------------------ Find out current server userload
647: sub userload {
648: my $numusers=0;
649: {
650: opendir(LONIDS,$perlvar{'lonIDsDir'});
651: my $filename;
652: my $curtime=time;
653: while ($filename=readdir(LONIDS)) {
1.925 albertel 654: next if ($filename eq '.' || $filename eq '..');
655: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 656: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 657: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 658: }
659: closedir(LONIDS);
660: }
661: my $userloadpercent=0;
662: my $maxuserload=$perlvar{'lonUserLoadLim'};
663: if ($maxuserload) {
1.371 albertel 664: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 665: }
1.372 albertel 666: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 667: return $userloadpercent;
1.283 www 668: }
669:
670: # ------------------------------------------ Fight off request when overloaded
671:
672: sub overloaderror {
673: my ($r,$checkserver)=@_;
674: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
675: my $loadavg;
676: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 677: open(my $loadfile,'/proc/loadavg');
1.283 www 678: $loadavg=<$loadfile>;
679: $loadavg =~ s/\s.*//g;
1.285 matthew 680: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 681: close($loadfile);
1.283 www 682: } else {
683: $loadavg=&reply('load',$checkserver);
684: }
1.285 matthew 685: my $overload=$loadavg-100;
1.283 www 686: if ($overload>0) {
1.285 matthew 687: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 688: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 689: return 413;
1.283 www 690: }
691: return '';
1.5 www 692: }
1.1 albertel 693:
694: # ------------------------------ Find server with least workload from spare.tab
1.11 www 695:
1.1 albertel 696: sub spareserver {
1.670 albertel 697: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.784 albertel 698: my $spare_server;
1.370 albertel 699: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 700: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
701: : $userloadpercent;
702:
703: foreach my $try_server (@{ $spareid{'primary'} }) {
704: ($spare_server, $lowest_load) =
705: &compare_server_load($try_server, $spare_server, $lowest_load);
706: }
707:
708: my $found_server = ($spare_server ne '' && $lowest_load < 100);
709:
710: if (!$found_server) {
711: foreach my $try_server (@{ $spareid{'default'} }) {
712: ($spare_server, $lowest_load) =
713: &compare_server_load($try_server, $spare_server, $lowest_load);
714: }
715: }
716:
717: if (!$want_server_name) {
1.968 raeburn 718: my $protocol = 'http';
719: if ($protocol{$spare_server} eq 'https') {
720: $protocol = $protocol{$spare_server};
721: }
1.1001 raeburn 722: if (defined($spare_server)) {
723: my $hostname = &hostname($spare_server);
724: if (defined($hostname)) {
725: $spare_server = $protocol.'://'.$hostname;
726: }
727: }
1.784 albertel 728: }
729: return $spare_server;
730: }
731:
732: sub compare_server_load {
733: my ($try_server, $spare_server, $lowest_load) = @_;
734:
735: my $loadans = &reply('load', $try_server);
736: my $userloadans = &reply('userload',$try_server);
737:
738: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
739: next; #didn't get a number from the server
740: }
741:
742: my $load;
743: if ($loadans =~ /\d/) {
744: if ($userloadans =~ /\d/) {
745: #both are numbers, pick the bigger one
746: $load = ($loadans > $userloadans) ? $loadans
747: : $userloadans;
1.411 albertel 748: } else {
1.784 albertel 749: $load = $loadans;
1.411 albertel 750: }
1.784 albertel 751: } else {
752: $load = $userloadans;
753: }
754:
755: if (($load =~ /\d/) && ($load < $lowest_load)) {
756: $spare_server = $try_server;
757: $lowest_load = $load;
1.370 albertel 758: }
1.784 albertel 759: return ($spare_server,$lowest_load);
1.202 matthew 760: }
1.914 albertel 761:
762: # --------------------------- ask offload servers if user already has a session
763: sub find_existing_session {
764: my ($udom,$uname) = @_;
765: foreach my $try_server (@{ $spareid{'primary'} },
766: @{ $spareid{'default'} }) {
767: return $try_server if (&has_user_session($try_server, $udom, $uname));
768: }
769: return;
770: }
771:
772: # -------------------------------- ask if server already has a session for user
773: sub has_user_session {
774: my ($lonid,$udom,$uname) = @_;
775: my $result = &reply(join(':','userhassession',
776: map {&escape($_)} ($udom,$uname)),$lonid);
777: return 1 if ($result eq 'ok');
778:
779: return 0;
780: }
781:
1.202 matthew 782: # --------------------------------------------- Try to change a user's password
783:
784: sub changepass {
1.799 raeburn 785: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 786: $currentpass = &escape($currentpass);
787: $newpass = &escape($newpass);
1.1030 raeburn 788: my $lonhost = $perlvar{'lonHostID'};
789: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 790: $server);
791: if (! $answer) {
792: &logthis("No reply on password change request to $server ".
793: "by $uname in domain $udom.");
794: } elsif ($answer =~ "^ok") {
795: &logthis("$uname in $udom successfully changed their password ".
796: "on $server.");
797: } elsif ($answer =~ "^pwchange_failure") {
798: &logthis("$uname in $udom was unable to change their password ".
799: "on $server. The action was blocked by either lcpasswd ".
800: "or pwchange");
801: } elsif ($answer =~ "^non_authorized") {
802: &logthis("$uname in $udom did not get their password correct when ".
803: "attempting to change it on $server.");
804: } elsif ($answer =~ "^auth_mode_error") {
805: &logthis("$uname in $udom attempted to change their password despite ".
806: "not being locally or internally authenticated on $server.");
807: } elsif ($answer =~ "^unknown_user") {
808: &logthis("$uname in $udom attempted to change their password ".
809: "on $server but were unable to because $server is not ".
810: "their home server.");
811: } elsif ($answer =~ "^refused") {
812: &logthis("$server refused to change $uname in $udom password because ".
813: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 814: } elsif ($answer =~ "invalid_client") {
815: &logthis("$server refused to change $uname in $udom password because ".
816: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 817: }
818: return $answer;
1.1 albertel 819: }
820:
1.169 harris41 821: # ----------------------- Try to determine user's current authentication scheme
822:
823: sub queryauthenticate {
824: my ($uname,$udom)=@_;
1.456 albertel 825: my $uhome=&homeserver($uname,$udom);
826: if (!$uhome) {
827: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
828: return 'no_host';
829: }
830: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
831: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
832: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 833: }
1.456 albertel 834: return $answer;
1.169 harris41 835: }
836:
1.1 albertel 837: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 838:
1.1 albertel 839: sub authenticate {
1.952 raeburn 840: my ($uname,$upass,$udom,$checkdefauth)=@_;
1.807 albertel 841: $upass=&escape($upass);
842: $uname= &LONCAPA::clean_username($uname);
1.836 www 843: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 844: my $newhome;
1.836 www 845: if ((!$uhome) || ($uhome eq 'no_host')) {
846: # Maybe the machine was offline and only re-appeared again recently?
847: &reconlonc();
848: # One more
1.952 raeburn 849: $uhome=&homeserver($uname,$udom,1);
850: if (($uhome eq 'no_host') && $checkdefauth) {
851: if (defined(&domain($udom,'primary'))) {
852: $newhome=&domain($udom,'primary');
853: }
854: if ($newhome ne '') {
855: $uhome = $newhome;
856: }
857: }
1.836 www 858: if ((!$uhome) || ($uhome eq 'no_host')) {
859: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 860: return 'no_host';
861: }
1.1 albertel 862: }
1.952 raeburn 863: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
1.471 albertel 864: if ($answer eq 'authorized') {
1.952 raeburn 865: if ($newhome) {
866: &logthis("User $uname at $udom authorized by $uhome, but needs account");
867: return 'no_account_on_host';
868: } else {
869: &logthis("User $uname at $udom authorized by $uhome");
870: return $uhome;
871: }
1.471 albertel 872: }
873: if ($answer eq 'non_authorized') {
874: &logthis("User $uname at $udom rejected by $uhome");
875: return 'no_host';
1.9 www 876: }
1.471 albertel 877: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 878: return 'no_host';
879: }
880:
881: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 882:
1.599 albertel 883: my %homecache;
1.1 albertel 884: sub homeserver {
1.230 stredwic 885: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 886: my $index="$uname:$udom";
1.426 albertel 887:
1.599 albertel 888: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 889:
890: my %servers = &get_servers($udom,'library');
891: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 892: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 893: exists($badServerCache{$tryserver}));
1.841 albertel 894:
895: my $answer=reply("home:$udom:$uname",$tryserver);
896: if ($answer eq 'found') {
897: delete($badServerCache{$tryserver});
898: return $homecache{$index}=$tryserver;
899: } elsif ($answer eq 'no_host') {
900: $badServerCache{$tryserver}=1;
901: }
1.1 albertel 902: }
903: return 'no_host';
1.70 www 904: }
905:
906: # ------------------------------------- Find the usernames behind a list of IDs
907:
908: sub idget {
909: my ($udom,@ids)=@_;
910: my %returnhash=();
911:
1.841 albertel 912: my %servers = &get_servers($udom,'library');
913: foreach my $tryserver (keys(%servers)) {
914: my $idlist=join('&',@ids);
915: $idlist=~tr/A-Z/a-z/;
916: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
917: my @answer=();
918: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
919: @answer=split(/\&/,$reply);
920: } ;
921: my $i;
922: for ($i=0;$i<=$#ids;$i++) {
923: if ($answer[$i]) {
924: $returnhash{$ids[$i]}=$answer[$i];
925: }
926: }
927: }
1.70 www 928: return %returnhash;
929: }
930:
931: # ------------------------------------- Find the IDs behind a list of usernames
932:
933: sub idrget {
934: my ($udom,@unames)=@_;
935: my %returnhash=();
1.800 albertel 936: foreach my $uname (@unames) {
937: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 938: }
1.70 www 939: return %returnhash;
940: }
941:
942: # ------------------------------- Store away a list of names and associated IDs
943:
944: sub idput {
945: my ($udom,%ids)=@_;
946: my %servers=();
1.800 albertel 947: foreach my $uname (keys(%ids)) {
948: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
949: my $uhom=&homeserver($uname,$udom);
1.70 www 950: if ($uhom ne 'no_host') {
1.800 albertel 951: my $id=&escape($ids{$uname});
1.70 www 952: $id=~tr/A-Z/a-z/;
1.800 albertel 953: my $esc_unam=&escape($uname);
1.70 www 954: if ($servers{$uhom}) {
1.800 albertel 955: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 956: } else {
1.800 albertel 957: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 958: }
959: }
1.191 harris41 960: }
1.800 albertel 961: foreach my $server (keys(%servers)) {
962: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 963: }
1.344 www 964: }
965:
1.1023 raeburn 966: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 967: sub dump_dom {
1.1023 raeburn 968: my ($namespace,$udom,$regexp,$range)=@_;
1.1012 raeburn 969: if (!$udom) {
970: $udom=$env{'user.domain'};
971: }
972: my %returnhash;
1.1023 raeburn 973: if ($udom) {
974: my $uname = &get_domainconfiguser($udom);
975: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
1.1012 raeburn 976: }
977: return %returnhash;
978: }
979:
1.1023 raeburn 980: # ------------------------------------------ get items from domain db files
1.806 raeburn 981:
982: sub get_dom {
1.860 raeburn 983: my ($namespace,$storearr,$udom,$uhome)=@_;
1.806 raeburn 984: my $items='';
985: foreach my $item (@$storearr) {
986: $items.=&escape($item).'&';
987: }
988: $items=~s/\&$//;
1.860 raeburn 989: if (!$udom) {
990: $udom=$env{'user.domain'};
991: if (defined(&domain($udom,'primary'))) {
992: $uhome=&domain($udom,'primary');
993: } else {
1.874 albertel 994: undef($uhome);
1.860 raeburn 995: }
996: } else {
997: if (!$uhome) {
998: if (defined(&domain($udom,'primary'))) {
999: $uhome=&domain($udom,'primary');
1000: }
1001: }
1002: }
1003: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1004: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 1005: my %returnhash;
1.875 albertel 1006: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1007: return %returnhash;
1008: }
1.806 raeburn 1009: my @pairs=split(/\&/,$rep);
1010: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1011: return @pairs;
1012: }
1013: my $i=0;
1014: foreach my $item (@$storearr) {
1015: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1016: $i++;
1017: }
1018: return %returnhash;
1019: } else {
1.880 banghart 1020: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1021: }
1022: }
1023:
1024: # -------------------------------------------- put items in domain db files
1025:
1026: sub put_dom {
1.860 raeburn 1027: my ($namespace,$storehash,$udom,$uhome)=@_;
1028: if (!$udom) {
1029: $udom=$env{'user.domain'};
1030: if (defined(&domain($udom,'primary'))) {
1031: $uhome=&domain($udom,'primary');
1032: } else {
1.874 albertel 1033: undef($uhome);
1.860 raeburn 1034: }
1035: } else {
1036: if (!$uhome) {
1037: if (defined(&domain($udom,'primary'))) {
1038: $uhome=&domain($udom,'primary');
1039: }
1040: }
1041: }
1042: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1043: my $items='';
1044: foreach my $item (keys(%$storehash)) {
1045: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1046: }
1047: $items=~s/\&$//;
1048: return &reply("putdom:$udom:$namespace:$items",$uhome);
1049: } else {
1.860 raeburn 1050: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1051: }
1052: }
1053:
1.1023 raeburn 1054: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 1055: sub newput_dom {
1.1023 raeburn 1056: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 1057: my $result;
1058: if (!$udom) {
1059: $udom=$env{'user.domain'};
1060: }
1.1023 raeburn 1061: if ($udom) {
1062: my $uname = &get_domainconfiguser($udom);
1063: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 1064: }
1065: return $result;
1066: }
1067:
1.1023 raeburn 1068: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 1069: sub del_dom {
1.1023 raeburn 1070: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 1071: if (ref($storearr) eq 'ARRAY') {
1072: if (!$udom) {
1073: $udom=$env{'user.domain'};
1074: }
1.1023 raeburn 1075: if ($udom) {
1076: my $uname = &get_domainconfiguser($udom);
1077: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 1078: }
1079: }
1080: }
1081:
1.1023 raeburn 1082: # ----------------------------------construct domainconfig user for a domain
1083: sub get_domainconfiguser {
1084: my ($udom) = @_;
1085: return $udom.'-domainconfig';
1086: }
1087:
1.837 raeburn 1088: sub retrieve_inst_usertypes {
1089: my ($udom) = @_;
1090: my (%returnhash,@order);
1.989 raeburn 1091: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1092: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1093: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1094: %returnhash = %{$domdefs{'inststatustypes'}};
1095: @order = @{$domdefs{'inststatusorder'}};
1096: } else {
1097: if (defined(&domain($udom,'primary'))) {
1098: my $uhome=&domain($udom,'primary');
1099: my $rep=&reply("inst_usertypes:$udom",$uhome);
1100: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1101: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1102: return (\%returnhash,\@order);
1103: }
1104: my ($hashitems,$orderitems) = split(/:/,$rep);
1105: my @pairs=split(/\&/,$hashitems);
1106: foreach my $item (@pairs) {
1107: my ($key,$value)=split(/=/,$item,2);
1108: $key = &unescape($key);
1109: next if ($key =~ /^error: 2 /);
1110: $returnhash{$key}=&thaw_unescape($value);
1111: }
1112: my @esc_order = split(/\&/,$orderitems);
1113: foreach my $item (@esc_order) {
1114: push(@order,&unescape($item));
1115: }
1116: } else {
1117: &logthis("get_dom failed - no primary domain server for $udom");
1.837 raeburn 1118: }
1119: }
1120: return (\%returnhash,\@order);
1121: }
1122:
1.868 raeburn 1123: sub is_domainimage {
1124: my ($url) = @_;
1125: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1126: if (&domain($1) ne '') {
1127: return '1';
1128: }
1129: }
1130: return;
1131: }
1132:
1.899 raeburn 1133: sub inst_directory_query {
1134: my ($srch) = @_;
1135: my $udom = $srch->{'srchdomain'};
1136: my %results;
1137: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1138: my $outcome;
1.899 raeburn 1139: if ($homeserver ne '') {
1.904 albertel 1140: my $queryid=&reply("querysend:instdirsearch:".
1141: &escape($srch->{'srchby'}).':'.
1142: &escape($srch->{'srchterm'}).':'.
1143: &escape($srch->{'srchtype'}),$homeserver);
1144: my $host=&hostname($homeserver);
1145: if ($queryid !~/^\Q$host\E\_/) {
1146: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1147: return;
1148: }
1149: my $response = &get_query_reply($queryid);
1150: my $maxtries = 5;
1151: my $tries = 1;
1152: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1153: $response = &get_query_reply($queryid);
1154: $tries ++;
1155: }
1156:
1157: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1158: if ($response eq 'unavailable') {
1159: $outcome = $response;
1160: } else {
1161: $outcome = 'ok';
1162: my @matches = split(/\n/,$response);
1163: foreach my $match (@matches) {
1164: my ($key,$value) = split(/=/,$match);
1165: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1166: }
1.899 raeburn 1167: }
1168: }
1169: }
1.909 raeburn 1170: return ($outcome,%results);
1.899 raeburn 1171: }
1172:
1173: sub usersearch {
1174: my ($srch) = @_;
1175: my $dom = $srch->{'srchdomain'};
1176: my %results;
1177: my %libserv = &all_library();
1178: my $query = 'usersearch';
1179: foreach my $tryserver (keys(%libserv)) {
1180: if (&host_domain($tryserver) eq $dom) {
1181: my $host=&hostname($tryserver);
1182: my $queryid=
1.911 raeburn 1183: &reply("querysend:".&escape($query).':'.
1184: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1185: &escape($srch->{'srchtype'}).':'.
1186: &escape($srch->{'srchterm'}),$tryserver);
1187: if ($queryid !~/^\Q$host\E\_/) {
1188: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1189: next;
1.899 raeburn 1190: }
1191: my $reply = &get_query_reply($queryid);
1192: my $maxtries = 1;
1193: my $tries = 1;
1194: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1195: $reply = &get_query_reply($queryid);
1196: $tries ++;
1197: }
1198: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1199: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1200: } else {
1.911 raeburn 1201: my @matches;
1202: if ($reply =~ /\n/) {
1203: @matches = split(/\n/,$reply);
1204: } else {
1205: @matches = split(/\&/,$reply);
1206: }
1.899 raeburn 1207: foreach my $match (@matches) {
1208: my ($uname,$udom,%userhash);
1.911 raeburn 1209: foreach my $entry (split(/:/,$match)) {
1210: my ($key,$value) =
1211: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1212: $userhash{$key} = $value;
1213: if ($key eq 'username') {
1214: $uname = $value;
1215: } elsif ($key eq 'domain') {
1216: $udom = $value;
1.911 raeburn 1217: }
1.899 raeburn 1218: }
1219: $results{$uname.':'.$udom} = \%userhash;
1220: }
1221: }
1222: }
1223: }
1224: return %results;
1225: }
1226:
1.912 raeburn 1227: sub get_instuser {
1228: my ($udom,$uname,$id) = @_;
1229: my $homeserver = &domain($udom,'primary');
1230: my ($outcome,%results);
1231: if ($homeserver ne '') {
1232: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1233: &escape($id).':'.&escape($udom),$homeserver);
1234: my $host=&hostname($homeserver);
1235: if ($queryid !~/^\Q$host\E\_/) {
1236: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1237: return;
1238: }
1239: my $response = &get_query_reply($queryid);
1240: my $maxtries = 5;
1241: my $tries = 1;
1242: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1243: $response = &get_query_reply($queryid);
1244: $tries ++;
1245: }
1246: if (!&error($response) && $response ne 'refused') {
1247: if ($response eq 'unavailable') {
1248: $outcome = $response;
1249: } else {
1250: $outcome = 'ok';
1251: my @matches = split(/\n/,$response);
1252: foreach my $match (@matches) {
1253: my ($key,$value) = split(/=/,$match);
1254: $results{&unescape($key)} = &thaw_unescape($value);
1255: }
1256: }
1257: }
1258: }
1259: my %userinfo;
1260: if (ref($results{$uname}) eq 'HASH') {
1261: %userinfo = %{$results{$uname}};
1262: }
1263: return ($outcome,%userinfo);
1264: }
1265:
1266: sub inst_rulecheck {
1.923 raeburn 1267: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 1268: my %returnhash;
1269: if ($udom ne '') {
1270: if (ref($rules) eq 'ARRAY') {
1271: @{$rules} = map {&escape($_);} (@{$rules});
1272: my $rulestr = join(':',@{$rules});
1273: my $homeserver=&domain($udom,'primary');
1274: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1275: my $response;
1276: if ($item eq 'username') {
1277: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1278: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 1279: $homeserver));
1.923 raeburn 1280: } elsif ($item eq 'id') {
1281: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1282: ':'.&escape($id).':'.$rulestr,
1283: $homeserver));
1.945 raeburn 1284: } elsif ($item eq 'selfcreate') {
1285: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 1286: &escape($udom).':'.&escape($uname).
1287: ':'.$rulestr,$homeserver));
1.923 raeburn 1288: }
1.912 raeburn 1289: if ($response ne 'refused') {
1290: my @pairs=split(/\&/,$response);
1291: foreach my $item (@pairs) {
1292: my ($key,$value)=split(/=/,$item,2);
1293: $key = &unescape($key);
1294: next if ($key =~ /^error: 2 /);
1295: $returnhash{$key}=&thaw_unescape($value);
1296: }
1297: }
1298: }
1299: }
1300: }
1301: return %returnhash;
1302: }
1303:
1304: sub inst_userrules {
1.923 raeburn 1305: my ($udom,$check) = @_;
1.912 raeburn 1306: my (%ruleshash,@ruleorder);
1307: if ($udom ne '') {
1308: my $homeserver=&domain($udom,'primary');
1309: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1310: my $response;
1311: if ($check eq 'id') {
1312: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 1313: $homeserver);
1.943 raeburn 1314: } elsif ($check eq 'email') {
1315: $response=&reply('instemailrules:'.&escape($udom),
1316: $homeserver);
1.923 raeburn 1317: } else {
1318: $response=&reply('instuserrules:'.&escape($udom),
1319: $homeserver);
1320: }
1.912 raeburn 1321: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 1322: ($response ne 'unknown_cmd') &&
1.912 raeburn 1323: ($response ne 'no_such_host')) {
1324: my ($hashitems,$orderitems) = split(/:/,$response);
1325: my @pairs=split(/\&/,$hashitems);
1326: foreach my $item (@pairs) {
1327: my ($key,$value)=split(/=/,$item,2);
1328: $key = &unescape($key);
1329: next if ($key =~ /^error: 2 /);
1330: $ruleshash{$key}=&thaw_unescape($value);
1331: }
1332: my @esc_order = split(/\&/,$orderitems);
1333: foreach my $item (@esc_order) {
1334: push(@ruleorder,&unescape($item));
1335: }
1336: }
1337: }
1338: }
1339: return (\%ruleshash,\@ruleorder);
1340: }
1341:
1.976 raeburn 1342: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 1343:
1344: sub get_domain_defaults {
1345: my ($domain) = @_;
1346: my $cachetime = 60*60*24;
1347: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1348: if (defined($cached)) {
1349: if (ref($result) eq 'HASH') {
1350: return %{$result};
1351: }
1352: }
1353: my %domdefaults;
1354: my %domconfig =
1.989 raeburn 1355: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 1356: 'requestcourses','inststatus',
1357: 'coursedefaults'],$domain);
1.943 raeburn 1358: if (ref($domconfig{'defaults'}) eq 'HASH') {
1359: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1360: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1361: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 1362: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 1363: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.943 raeburn 1364: } else {
1365: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1366: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1367: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1368: }
1.976 raeburn 1369: if (ref($domconfig{'quotas'}) eq 'HASH') {
1370: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1371: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1372: } else {
1373: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1374: }
1375: my @usertools = ('aboutme','blog','portfolio');
1376: foreach my $item (@usertools) {
1377: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1378: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1379: }
1380: }
1381: }
1.985 raeburn 1382: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1006 raeburn 1383: foreach my $item ('official','unofficial','community') {
1.985 raeburn 1384: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1385: }
1386: }
1.989 raeburn 1387: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1388: foreach my $item ('inststatustypes','inststatusorder') {
1389: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1390: }
1391: }
1.1047 raeburn 1392: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1393: foreach my $item ('canuse_pdfforms') {
1394: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1395: }
1396: }
1.943 raeburn 1397: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1398: $cachetime);
1399: return %domdefaults;
1400: }
1401:
1.344 www 1402: # --------------------------------------------------- Assign a key to a student
1403:
1404: sub assign_access_key {
1.364 www 1405: #
1406: # a valid key looks like uname:udom#comments
1407: # comments are being appended
1408: #
1.498 www 1409: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1410: $kdom=
1.620 albertel 1411: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 1412: $knum=
1.620 albertel 1413: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 1414: $cdom=
1.620 albertel 1415: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1416: $cnum=
1.620 albertel 1417: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1418: $udom=$env{'user.name'} unless (defined($udom));
1419: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 1420: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 1421: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 1422: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 1423: # assigned to this person
1424: # - this should not happen,
1.345 www 1425: # unless something went wrong
1426: # the first time around
1427: # ready to assign
1.364 www 1428: $logentry=$1.'; '.$logentry;
1.496 www 1429: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 1430: $kdom,$knum) eq 'ok') {
1.345 www 1431: # key now belongs to user
1.346 www 1432: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 1433: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 1434: &appenv({'environment.'.$envkey => $ckey});
1.345 www 1435: return 'ok';
1436: } else {
1437: return
1438: 'error: Count not permanently assign key, will need to be re-entered later.';
1439: }
1440: } else {
1441: return 'error: Could not assign key, try again later.';
1442: }
1.364 www 1443: } elsif (!$existing{$ckey}) {
1.345 www 1444: # the key does not exist
1445: return 'error: The key does not exist';
1446: } else {
1447: # the key is somebody else's
1448: return 'error: The key is already in use';
1449: }
1.344 www 1450: }
1451:
1.364 www 1452: # ------------------------------------------ put an additional comment on a key
1453:
1454: sub comment_access_key {
1455: #
1456: # a valid key looks like uname:udom#comments
1457: # comments are being appended
1458: #
1459: my ($ckey,$cdom,$cnum,$logentry)=@_;
1460: $cdom=
1.620 albertel 1461: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 1462: $cnum=
1.620 albertel 1463: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 1464: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1465: if ($existing{$ckey}) {
1466: $existing{$ckey}.='; '.$logentry;
1467: # ready to assign
1.367 www 1468: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 1469: $cdom,$cnum) eq 'ok') {
1470: return 'ok';
1471: } else {
1472: return 'error: Count not store comment.';
1473: }
1474: } else {
1475: # the key does not exist
1476: return 'error: The key does not exist';
1477: }
1478: }
1479:
1.344 www 1480: # ------------------------------------------------------ Generate a set of keys
1481:
1482: sub generate_access_keys {
1.364 www 1483: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 1484: $cdom=
1.620 albertel 1485: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1486: $cnum=
1.620 albertel 1487: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 1488: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 1489: unless (($cdom) && ($cnum)) { return 0; }
1490: if ($number>10000) { return 0; }
1491: sleep(2); # make sure don't get same seed twice
1492: srand(time()^($$+($$<<15))); # from "Programming Perl"
1493: my $total=0;
1494: for (my $i=1;$i<=$number;$i++) {
1495: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1496: sprintf("%lx",int(100000*rand)).'-'.
1497: sprintf("%lx",int(100000*rand));
1498: $newkey=~s/1/g/g; # folks mix up 1 and l
1499: $newkey=~s/0/h/g; # and also 0 and O
1500: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1501: if ($existing{$newkey}) {
1502: $i--;
1503: } else {
1.364 www 1504: if (&put('accesskeys',
1505: { $newkey => '# generated '.localtime().
1.620 albertel 1506: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 1507: '; '.$logentry },
1508: $cdom,$cnum) eq 'ok') {
1.344 www 1509: $total++;
1510: }
1511: }
1512: }
1.620 albertel 1513: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 1514: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1515: return $total;
1516: }
1517:
1518: # ------------------------------------------------------- Validate an accesskey
1519:
1520: sub validate_access_key {
1521: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1522: $cdom=
1.620 albertel 1523: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1524: $cnum=
1.620 albertel 1525: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1526: $udom=$env{'user.domain'} unless (defined($udom));
1527: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 1528: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 1529: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 1530: }
1531:
1532: # ------------------------------------- Find the section of student in a course
1.652 albertel 1533: sub devalidate_getsection_cache {
1534: my ($udom,$unam,$courseid)=@_;
1535: my $hashid="$udom:$unam:$courseid";
1536: &devalidate_cache_new('getsection',$hashid);
1537: }
1.298 matthew 1538:
1.815 albertel 1539: sub courseid_to_courseurl {
1540: my ($courseid) = @_;
1541: #already url style courseid
1542: return $courseid if ($courseid =~ m{^/});
1543:
1544: if (exists($env{'course.'.$courseid.'.num'})) {
1545: my $cnum = $env{'course.'.$courseid.'.num'};
1546: my $cdom = $env{'course.'.$courseid.'.domain'};
1547: return "/$cdom/$cnum";
1548: }
1549:
1550: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1551: if (exists($courseinfo{'num'})) {
1552: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1553: }
1554:
1555: return undef;
1556: }
1557:
1.298 matthew 1558: sub getsection {
1559: my ($udom,$unam,$courseid)=@_;
1.599 albertel 1560: my $cachetime=1800;
1.551 albertel 1561:
1562: my $hashid="$udom:$unam:$courseid";
1.599 albertel 1563: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 1564: if (defined($cached)) { return $result; }
1565:
1.298 matthew 1566: my %Pending;
1567: my %Expired;
1568: #
1569: # Each role can either have not started yet (pending), be active,
1570: # or have expired.
1571: #
1572: # If there is an active role, we are done.
1573: #
1574: # If there is more than one role which has not started yet,
1575: # choose the one which will start sooner
1576: # If there is one role which has not started yet, return it.
1577: #
1578: # If there is more than one expired role, choose the one which ended last.
1579: # If there is a role which has expired, return it.
1580: #
1.815 albertel 1581: $courseid = &courseid_to_courseurl($courseid);
1.817 raeburn 1582: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1583: foreach my $key (keys(%roleshash)) {
1.479 albertel 1584: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 1585: my $section=$1;
1586: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 1587: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 1588: my $now=time;
1.548 albertel 1589: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 1590: $Expired{$end}=$section;
1591: next;
1592: }
1.548 albertel 1593: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 1594: $Pending{$start}=$section;
1595: next;
1596: }
1.599 albertel 1597: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 1598: }
1599: #
1600: # Presumedly there will be few matching roles from the above
1601: # loop and the sorting time will be negligible.
1602: if (scalar(keys(%Pending))) {
1603: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 1604: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 1605: }
1606: if (scalar(keys(%Expired))) {
1607: my @sorted = sort {$a <=> $b} keys(%Expired);
1608: my $time = pop(@sorted);
1.599 albertel 1609: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 1610: }
1.599 albertel 1611: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 1612: }
1.70 www 1613:
1.599 albertel 1614: sub save_cache {
1615: &purge_remembered();
1.722 albertel 1616: #&Apache::loncommon::validate_page();
1.620 albertel 1617: undef(%env);
1.780 albertel 1618: undef($env_loaded);
1.599 albertel 1619: }
1.452 albertel 1620:
1.599 albertel 1621: my $to_remember=-1;
1622: my %remembered;
1623: my %accessed;
1624: my $kicks=0;
1625: my $hits=0;
1.849 albertel 1626: sub make_key {
1627: my ($name,$id) = @_;
1.872 albertel 1628: if (length($id) > 65
1629: && length(&escape($id)) > 200) {
1630: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1631: }
1.849 albertel 1632: return &escape($name.':'.$id);
1633: }
1634:
1.599 albertel 1635: sub devalidate_cache_new {
1636: my ($name,$id,$debug) = @_;
1637: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 1638: $id=&make_key($name,$id);
1.599 albertel 1639: $memcache->delete($id);
1640: delete($remembered{$id});
1641: delete($accessed{$id});
1642: }
1643:
1644: sub is_cached_new {
1645: my ($name,$id,$debug) = @_;
1.849 albertel 1646: $id=&make_key($name,$id);
1.599 albertel 1647: if (exists($remembered{$id})) {
1648: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1649: $accessed{$id}=[&gettimeofday()];
1650: $hits++;
1651: return ($remembered{$id},1);
1652: }
1653: my $value = $memcache->get($id);
1654: if (!(defined($value))) {
1655: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 1656: return (undef,undef);
1.416 albertel 1657: }
1.599 albertel 1658: if ($value eq '__undef__') {
1659: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1660: $value=undef;
1661: }
1662: &make_room($id,$value,$debug);
1663: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1664: return ($value,1);
1665: }
1666:
1667: sub do_cache_new {
1668: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 1669: $id=&make_key($name,$id);
1.599 albertel 1670: my $setvalue=$value;
1671: if (!defined($setvalue)) {
1672: $setvalue='__undef__';
1673: }
1.623 albertel 1674: if (!defined($time) ) {
1675: $time=600;
1676: }
1.599 albertel 1677: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 1678: my $result = $memcache->set($id,$setvalue,$time);
1679: if (! $result) {
1.872 albertel 1680: &logthis("caching of id -> $id failed");
1.910 albertel 1681: $memcache->disconnect_all();
1.872 albertel 1682: }
1.600 albertel 1683: # need to make a copy of $value
1.919 albertel 1684: &make_room($id,$value,$debug);
1.599 albertel 1685: return $value;
1686: }
1687:
1688: sub make_room {
1689: my ($id,$value,$debug)=@_;
1.919 albertel 1690:
1691: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1692: : $value;
1.599 albertel 1693: if ($to_remember<0) { return; }
1694: $accessed{$id}=[&gettimeofday()];
1695: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1696: my $to_kick;
1697: my $max_time=0;
1698: foreach my $other (keys(%accessed)) {
1699: if (&tv_interval($accessed{$other}) > $max_time) {
1700: $to_kick=$other;
1701: $max_time=&tv_interval($accessed{$other});
1702: }
1703: }
1704: delete($remembered{$to_kick});
1705: delete($accessed{$to_kick});
1706: $kicks++;
1707: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 1708: return;
1709: }
1710:
1.599 albertel 1711: sub purge_remembered {
1.604 albertel 1712: #&logthis("Tossing ".scalar(keys(%remembered)));
1713: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 1714: undef(%remembered);
1715: undef(%accessed);
1.428 albertel 1716: }
1.70 www 1717: # ------------------------------------- Read an entry from a user's environment
1718:
1719: sub userenvironment {
1720: my ($udom,$unam,@what)=@_;
1.976 raeburn 1721: my $items;
1722: foreach my $item (@what) {
1723: $items.=&escape($item).'&';
1724: }
1725: $items=~s/\&$//;
1.70 www 1726: my %returnhash=();
1.1009 raeburn 1727: my $uhome = &homeserver($unam,$udom);
1728: unless ($uhome eq 'no_host') {
1729: my @answer=split(/\&/,
1730: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 1731: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
1732: return %returnhash;
1733: }
1.1009 raeburn 1734: my $i;
1735: for ($i=0;$i<=$#what;$i++) {
1736: $returnhash{$what[$i]}=&unescape($answer[$i]);
1737: }
1.70 www 1738: }
1739: return %returnhash;
1.1 albertel 1740: }
1741:
1.617 albertel 1742: # ---------------------------------------------------------- Get a studentphoto
1743: sub studentphoto {
1744: my ($udom,$unam,$ext) = @_;
1745: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 1746: if (defined($env{'request.course.id'})) {
1.708 raeburn 1747: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 1748: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1749: return(&retrievestudentphoto($udom,$unam,$ext));
1750: } else {
1751: my ($result,$perm_reqd)=
1.707 albertel 1752: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1753: if ($result eq 'ok') {
1754: if (!($perm_reqd eq 'yes')) {
1755: return(&retrievestudentphoto($udom,$unam,$ext));
1756: }
1757: }
1758: }
1759: }
1760: } else {
1761: my ($result,$perm_reqd) =
1.707 albertel 1762: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1763: if ($result eq 'ok') {
1764: if (!($perm_reqd eq 'yes')) {
1765: return(&retrievestudentphoto($udom,$unam,$ext));
1766: }
1767: }
1768: }
1769: return '/adm/lonKaputt/lonlogo_broken.gif';
1770: }
1771:
1772: sub retrievestudentphoto {
1773: my ($udom,$unam,$ext,$type) = @_;
1774: my $home=&Apache::lonnet::homeserver($unam,$udom);
1775: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1776: if ($ret eq 'ok') {
1777: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1778: if ($type eq 'thumbnail') {
1779: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1780: }
1781: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1782: return $tokenurl;
1783: } else {
1784: if ($type eq 'thumbnail') {
1785: return '/adm/lonKaputt/genericstudent_tn.gif';
1786: } else {
1787: return '/adm/lonKaputt/lonlogo_broken.gif';
1788: }
1.617 albertel 1789: }
1790: }
1791:
1.263 www 1792: # -------------------------------------------------------------------- New chat
1793:
1794: sub chatsend {
1.724 raeburn 1795: my ($newentry,$anon,$group)=@_;
1.620 albertel 1796: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1797: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1798: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1799: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1800: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1801: &escape($newentry)).':'.$group,$chome);
1.292 www 1802: }
1803:
1804: # ------------------------------------------ Find current version of a resource
1805:
1806: sub getversion {
1807: my $fname=&clutter(shift);
1808: unless ($fname=~/^\/res\//) { return -1; }
1809: return ¤tversion(&filelocation('',$fname));
1810: }
1811:
1812: sub currentversion {
1813: my $fname=shift;
1.599 albertel 1814: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1815: if (defined($cached)) { return $result; }
1.292 www 1816: my $author=$fname;
1817: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1818: my ($udom,$uname)=split(/\//,$author);
1819: my $home=homeserver($uname,$udom);
1820: if ($home eq 'no_host') {
1821: return -1;
1822: }
1823: my $answer=reply("currentversion:$fname",$home);
1824: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1825: return -1;
1826: }
1.599 albertel 1827: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1828: }
1829:
1.1 albertel 1830: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1831:
1.1 albertel 1832: sub subscribe {
1833: my $fname=shift;
1.761 raeburn 1834: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1835: $fname=~s/[\n\r]//g;
1.1 albertel 1836: my $author=$fname;
1837: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1838: my ($udom,$uname)=split(/\//,$author);
1839: my $home=homeserver($uname,$udom);
1.335 albertel 1840: if ($home eq 'no_host') {
1841: return 'not_found';
1.1 albertel 1842: }
1843: my $answer=reply("sub:$fname",$home);
1.64 www 1844: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1845: $answer.=' by '.$home;
1846: }
1.1 albertel 1847: return $answer;
1848: }
1849:
1.8 www 1850: # -------------------------------------------------------------- Replicate file
1851:
1852: sub repcopy {
1853: my $filename=shift;
1.23 www 1854: $filename=~s/\/+/\//g;
1.607 raeburn 1855: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1856: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1857: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1858: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1859: return &repcopy_userfile($filename);
1860: }
1.532 albertel 1861: $filename=~s/[\n\r]//g;
1.8 www 1862: my $transname="$filename.in.transfer";
1.828 www 1863: # FIXME: this should flock
1.607 raeburn 1864: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1865: my $remoteurl=subscribe($filename);
1.64 www 1866: if ($remoteurl =~ /^con_lost by/) {
1867: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1868: return 'unavailable';
1.8 www 1869: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1870: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1871: return 'not_found';
1.64 www 1872: } elsif ($remoteurl =~ /^rejected by/) {
1873: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1874: return 'forbidden';
1.20 www 1875: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1876: return 'ok';
1.8 www 1877: } else {
1.290 www 1878: my $author=$filename;
1879: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1880: my ($udom,$uname)=split(/\//,$author);
1881: my $home=homeserver($uname,$udom);
1882: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1883: my @parts=split(/\//,$filename);
1884: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1885: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1886: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1887: return 'bad_request';
1.8 www 1888: }
1889: my $count;
1890: for ($count=5;$count<$#parts;$count++) {
1891: $path.="/$parts[$count]";
1892: if ((-e $path)!=1) {
1893: mkdir($path,0777);
1894: }
1895: }
1896: my $ua=new LWP::UserAgent;
1897: my $request=new HTTP::Request('GET',"$remoteurl");
1898: my $response=$ua->request($request,$transname);
1899: if ($response->is_error()) {
1900: unlink($transname);
1901: my $message=$response->status_line;
1.672 albertel 1902: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1903: ." LWP get: $message: $filename</font>");
1.607 raeburn 1904: return 'unavailable';
1.8 www 1905: } else {
1.16 www 1906: if ($remoteurl!~/\.meta$/) {
1907: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1908: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1909: if ($mresponse->is_error()) {
1910: unlink($filename.'.meta');
1911: &logthis(
1.672 albertel 1912: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1913: }
1914: }
1.8 www 1915: rename($transname,$filename);
1.607 raeburn 1916: return 'ok';
1.8 www 1917: }
1.290 www 1918: }
1.8 www 1919: }
1.330 www 1920: }
1921:
1922: # ------------------------------------------------ Get server side include body
1923: sub ssi_body {
1.381 albertel 1924: my ($filelink,%form)=@_;
1.606 matthew 1925: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1926: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1927: }
1.953 www 1928: my $output='';
1929: my $response;
1.980 raeburn 1930: if ($filelink=~/^https?\:/) {
1.954 raeburn 1931: ($output,$response)=&externalssi($filelink);
1.953 www 1932: } else {
1.1004 droeschl 1933: $filelink .= $filelink=~/\?/ ? '&' : '?';
1934: $filelink .= 'inhibitmenu=yes';
1.953 www 1935: ($output,$response)=&ssi($filelink,%form);
1936: }
1.778 albertel 1937: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1938: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 1939: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 1940: if (wantarray) {
1941: return ($output, $response);
1942: } else {
1943: return $output;
1944: }
1.8 www 1945: }
1946:
1.15 www 1947: # --------------------------------------------------------- Server Side Include
1948:
1.782 albertel 1949: sub absolute_url {
1950: my ($host_name) = @_;
1951: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1952: if ($host_name eq '') {
1953: $host_name = $ENV{'SERVER_NAME'};
1954: }
1955: return $protocol.$host_name;
1956: }
1957:
1.942 foxr 1958: #
1959: # Server side include.
1960: # Parameters:
1961: # fn Possibly encrypted resource name/id.
1962: # form Hash that describes how the rendering should be done
1963: # and other things.
1.944 foxr 1964: # Returns:
1.950 raeburn 1965: # Scalar context: The content of the response.
1966: # Array context: 2 element list of the content and the full response object.
1.942 foxr 1967: #
1.15 www 1968: sub ssi {
1969:
1.944 foxr 1970: my ($fn,%form)=@_;
1.15 www 1971: my $ua=new LWP::UserAgent;
1.23 www 1972: my $request;
1.711 albertel 1973:
1974: $form{'no_update_last_known'}=1;
1.895 albertel 1975: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 1976: if (%form) {
1.782 albertel 1977: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000 raeburn 1978: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23 www 1979: } else {
1.782 albertel 1980: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 1981: }
1982:
1.15 www 1983: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1984: my $response=$ua->request($request);
1985:
1.944 foxr 1986: if (wantarray) {
1987: return ($response->content, $response);
1988: } else {
1989: return $response->content;
1.942 foxr 1990: }
1.324 www 1991: }
1992:
1993: sub externalssi {
1994: my ($url)=@_;
1995: my $ua=new LWP::UserAgent;
1996: my $request=new HTTP::Request('GET',$url);
1997: my $response=$ua->request($request);
1.954 raeburn 1998: if (wantarray) {
1999: return ($response->content, $response);
2000: } else {
2001: return $response->content;
2002: }
1.15 www 2003: }
1.254 www 2004:
1.492 albertel 2005: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2006:
2007: sub allowuploaded {
2008: my ($srcurl,$url)=@_;
2009: $url=&clutter(&declutter($url));
2010: my $dir=$url;
2011: $dir=~s/\/[^\/]+$//;
2012: my %httpref=();
2013: my $httpurl=&hreflocation('',$url);
2014: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2015: &Apache::lonnet::appenv(\%httpref);
1.254 www 2016: }
1.477 raeburn 2017:
1.478 albertel 2018: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 2019: # input: action, courseID, current domain, intended
1.637 raeburn 2020: # path to file, source of file, instruction to parse file for objects,
2021: # ref to hash for embedded objects,
2022: # ref to hash for codebase of java objects.
2023: #
1.485 raeburn 2024: # output: url to file (if action was uploaddoc),
2025: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 2026: #
1.478 albertel 2027: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2028: # course.
1.477 raeburn 2029: #
1.478 albertel 2030: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2031: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2032: # course's home server.
1.477 raeburn 2033: #
1.478 albertel 2034: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2035: # be copied from $source (current location) to
2036: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2037: # and will then be copied to
2038: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2039: # course's home server.
1.485 raeburn 2040: #
1.481 raeburn 2041: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 2042: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 2043: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2044: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2045: # in course's home server.
1.637 raeburn 2046: #
1.477 raeburn 2047:
2048: sub process_coursefile {
1.638 albertel 2049: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 2050: my $fetchresult;
1.638 albertel 2051: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 2052: if ($action eq 'propagate') {
1.638 albertel 2053: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2054: $home);
1.481 raeburn 2055: } else {
1.477 raeburn 2056: my $fpath = '';
2057: my $fname = $file;
1.478 albertel 2058: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 2059: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 2060: my $filepath = &build_filepath($fpath);
1.481 raeburn 2061: if ($action eq 'copy') {
2062: if ($source eq '') {
2063: $fetchresult = 'no source file';
2064: return $fetchresult;
2065: } else {
2066: my $destination = $filepath.'/'.$fname;
2067: rename($source,$destination);
2068: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2069: $home);
1.481 raeburn 2070: }
2071: } elsif ($action eq 'uploaddoc') {
2072: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 2073: print $fh $env{'form.'.$source};
1.481 raeburn 2074: close($fh);
1.637 raeburn 2075: if ($parser eq 'parse') {
1.1024 raeburn 2076: my $mm = new File::MMagic;
2077: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2078: if ($mime_type eq 'text/html') {
2079: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2080: unless ($parse_result eq 'ok') {
2081: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2082: }
1.637 raeburn 2083: }
2084: }
1.477 raeburn 2085: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2086: $home);
1.481 raeburn 2087: if ($fetchresult eq 'ok') {
2088: return '/uploaded/'.$fpath.'/'.$fname;
2089: } else {
2090: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2091: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 2092: return '/adm/notfound.html';
2093: }
1.477 raeburn 2094: }
2095: }
1.485 raeburn 2096: unless ( $fetchresult eq 'ok') {
1.477 raeburn 2097: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2098: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 2099: }
2100: return $fetchresult;
2101: }
2102:
1.637 raeburn 2103: sub build_filepath {
2104: my ($fpath) = @_;
2105: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2106: unless ($fpath eq '') {
2107: my @parts=split('/',$fpath);
2108: foreach my $part (@parts) {
2109: $filepath.= '/'.$part;
2110: if ((-e $filepath)!=1) {
2111: mkdir($filepath,0777);
2112: }
2113: }
2114: }
2115: return $filepath;
2116: }
2117:
2118: sub store_edited_file {
1.638 albertel 2119: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 2120: my $file = $primary_url;
2121: $file =~ s#^/uploaded/$docudom/$docuname/##;
2122: my $fpath = '';
2123: my $fname = $file;
2124: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2125: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2126: my $filepath = &build_filepath($fpath);
2127: open(my $fh,'>'.$filepath.'/'.$fname);
2128: print $fh $content;
2129: close($fh);
1.638 albertel 2130: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 2131: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2132: $home);
1.637 raeburn 2133: if ($$fetchresult eq 'ok') {
2134: return '/uploaded/'.$fpath.'/'.$fname;
2135: } else {
1.638 albertel 2136: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2137: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 2138: return '/adm/notfound.html';
2139: }
2140: }
2141:
1.531 albertel 2142: sub clean_filename {
1.831 albertel 2143: my ($fname,$args)=@_;
1.315 www 2144: # Replace Windows backslashes by forward slashes
1.257 www 2145: $fname=~s/\\/\//g;
1.831 albertel 2146: if (!$args->{'keep_path'}) {
2147: # Get rid of everything but the actual filename
2148: $fname=~s/^.*\/([^\/]+)$/$1/;
2149: }
1.315 www 2150: # Replace spaces by underscores
2151: $fname=~s/\s+/\_/g;
2152: # Replace all other weird characters by nothing
1.831 albertel 2153: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 2154: # Replace all .\d. sequences with _\d. so they no longer look like version
2155: # numbers
2156: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 2157: return $fname;
2158: }
1.984 neumanie 2159: #This Function check if a Image max 400px width and height 500px. If not then scale the image down
2160: sub resizeImage {
2161: my($img_url) = @_;
2162: my $ima = Image::Magick->new;
2163: $ima->Read($img_url);
2164: if($ima->Get('width') > 400)
2165: {
2166: my $factor = $ima->Get('width')/400;
2167: $ima->Scale( width=>400, height=>$ima->Get('height')/$factor );
2168: }
2169: if($ima->Get('height') > 500)
2170: {
2171: my $factor = $ima->Get('height')/500;
2172: $ima->Scale( width=>$ima->Get('width')/$factor, height=>500);
2173: }
2174:
2175: $ima->Write($img_url);
2176: }
1.531 albertel 2177:
1.977 amueller 2178: #Wrapper function for userphotoupload
2179: sub userphotoupload
2180: {
2181: my($formname,$subdir) = @_;
2182: $upload_photo_form = 1;
2183: return &userfileupload($formname,undef,$subdir);
2184: }
2185:
1.608 albertel 2186: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 2187: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 2188: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 2189: # $coursedoc - if true up to the current course
2190: # if false
2191: # $subdir - directory in userfile to store the file into
1.858 raeburn 2192: # $parser - instruction to parse file for objects ($parser = parse)
2193: # $allfiles - reference to hash for embedded objects
2194: # $codebase - reference to hash for codebase of java objects
2195: # $desuname - username for permanent storage of uploaded file
2196: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 2197: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2198: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.858 raeburn 2199: #
1.686 albertel 2200: # output: url of file in userspace, or error: <message>
2201: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 2202:
2203:
1.531 albertel 2204: sub userfileupload {
1.860 raeburn 2205: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2206: $destudom,$thumbwidth,$thumbheight)=@_;
1.531 albertel 2207: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 2208: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 2209: $fname=&clean_filename($fname);
1.315 www 2210: # See if there is anything left
1.257 www 2211: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 2212: chop($env{'form.'.$formname});
1.523 raeburn 2213: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2214: my $now = time;
2215: my $filepath = 'tmp/helprequests/'.$now;
2216: my @parts=split(/\//,$filepath);
2217: my $fullpath = $perlvar{'lonDaemons'};
2218: for (my $i=0;$i<@parts;$i++) {
2219: $fullpath .= '/'.$parts[$i];
2220: if ((-e $fullpath)!=1) {
2221: mkdir($fullpath,0777);
2222: }
2223: }
2224: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 2225: print $fh $env{'form.'.$formname};
1.523 raeburn 2226: close($fh);
1.741 raeburn 2227: return $fullpath.'/'.$fname;
2228: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2229: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2230: '_'.$env{'user.domain'}.'/pending';
2231: my @parts=split(/\//,$filepath);
2232: my $fullpath = $perlvar{'lonDaemons'};
2233: for (my $i=0;$i<@parts;$i++) {
2234: $fullpath .= '/'.$parts[$i];
2235: if ((-e $fullpath)!=1) {
2236: mkdir($fullpath,0777);
2237: }
2238: }
2239: open(my $fh,'>'.$fullpath.'/'.$fname);
2240: print $fh $env{'form.'.$formname};
2241: close($fh);
2242: return $fullpath.'/'.$fname;
1.523 raeburn 2243: }
1.995 raeburn 2244: if ($subdir eq 'scantron') {
2245: $fname = 'scantron_orig_'.$fname;
2246: } else {
1.258 www 2247: # Create the directory if not present
1.995 raeburn 2248: $fname="$subdir/$fname";
2249: }
1.259 www 2250: if ($coursedoc) {
1.638 albertel 2251: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2252: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 2253: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 2254: return &finishuserfileupload($docuname,$docudom,
2255: $formname,$fname,$parser,$allfiles,
1.860 raeburn 2256: $codebase,$thumbwidth,$thumbheight);
1.481 raeburn 2257: } else {
1.620 albertel 2258: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 2259: return &process_coursefile('uploaddoc',$docuname,$docudom,
2260: $fname,$formname,$parser,
2261: $allfiles,$codebase);
1.481 raeburn 2262: }
1.719 banghart 2263: } elsif (defined($destuname)) {
2264: my $docuname=$destuname;
2265: my $docudom=$destudom;
1.860 raeburn 2266: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2267: $parser,$allfiles,$codebase,
2268: $thumbwidth,$thumbheight);
1.719 banghart 2269:
1.259 www 2270: } else {
1.638 albertel 2271: my $docuname=$env{'user.name'};
2272: my $docudom=$env{'user.domain'};
1.714 raeburn 2273: if (exists($env{'form.group'})) {
2274: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2275: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2276: }
1.860 raeburn 2277: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2278: $parser,$allfiles,$codebase,
2279: $thumbwidth,$thumbheight);
1.259 www 2280: }
1.271 www 2281: }
2282:
2283: sub finishuserfileupload {
1.860 raeburn 2284: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2285: $thumbwidth,$thumbheight) = @_;
1.477 raeburn 2286: my $path=$docudom.'/'.$docuname.'/';
1.258 www 2287: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 2288:
1.860 raeburn 2289: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 2290: $file=$fname;
2291: if ($fname=~m|/|) {
2292: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2293: $path.=$fnamepath.'/';
2294: }
1.259 www 2295: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 2296: my $count;
2297: for ($count=4;$count<=$#parts;$count++) {
2298: $filepath.="/$parts[$count]";
2299: if ((-e $filepath)!=1) {
2300: mkdir($filepath,0777);
2301: }
2302: }
1.984 neumanie 2303:
1.258 www 2304: # Save the file
2305: {
1.701 albertel 2306: if (!open(FH,'>'.$filepath.'/'.$file)) {
2307: &logthis('Failed to create '.$filepath.'/'.$file);
2308: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2309: return '/adm/notfound.html';
2310: }
2311: if (!print FH ($env{'form.'.$formname})) {
2312: &logthis('Failed to write to '.$filepath.'/'.$file);
2313: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2314: return '/adm/notfound.html';
2315: }
1.570 albertel 2316: close(FH);
1.977 amueller 2317: if($upload_photo_form==1)
2318: {
1.984 neumanie 2319: resizeImage($filepath.'/'.$file);
1.977 amueller 2320: $upload_photo_form = 0;
2321: }
1.258 www 2322: }
1.637 raeburn 2323: if ($parser eq 'parse') {
1.1024 raeburn 2324: my $mm = new File::MMagic;
2325: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2326: if ($mime_type eq 'text/html') {
2327: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2328: $allfiles,$codebase);
2329: unless ($parse_result eq 'ok') {
2330: &logthis('Failed to parse '.$filepath.$file.
2331: ' for embedded media: '.$parse_result);
2332: }
1.637 raeburn 2333: }
2334: }
1.860 raeburn 2335: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2336: my $input = $filepath.'/'.$file;
2337: my $output = $filepath.'/'.'tn-'.$file;
2338: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2339: system("convert -sample $thumbsize $input $output");
2340: if (-e $filepath.'/'.'tn-'.$file) {
2341: $fetchthumb = 1;
2342: }
2343: }
1.858 raeburn 2344:
1.259 www 2345: # Notify homeserver to grep it
2346: #
1.984 neumanie 2347: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 2348: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 2349: if ($fetchresult eq 'ok') {
1.860 raeburn 2350: if ($fetchthumb) {
2351: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2352: if ($thumbresult ne 'ok') {
2353: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2354: $docuhome.': '.$thumbresult);
2355: }
2356: }
1.259 www 2357: #
1.258 www 2358: # Return the URL to it
1.494 albertel 2359: return '/uploaded/'.$path.$file;
1.263 www 2360: } else {
1.494 albertel 2361: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2362: ': '.$fetchresult);
1.263 www 2363: return '/adm/notfound.html';
1.858 raeburn 2364: }
1.493 albertel 2365: }
2366:
1.637 raeburn 2367: sub extract_embedded_items {
1.961 raeburn 2368: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 2369: my @state = ();
2370: my %javafiles = (
2371: codebase => '',
2372: code => '',
2373: archive => ''
2374: );
2375: my %mediafiles = (
2376: src => '',
2377: movie => '',
2378: );
1.648 raeburn 2379: my $p;
2380: if ($content) {
2381: $p = HTML::LCParser->new($content);
2382: } else {
1.961 raeburn 2383: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 2384: }
1.641 albertel 2385: while (my $t=$p->get_token()) {
1.640 albertel 2386: if ($t->[0] eq 'S') {
2387: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 2388: push(@state, $tagname);
1.648 raeburn 2389: if (lc($tagname) eq 'allow') {
2390: &add_filetype($allfiles,$attr->{'src'},'src');
2391: }
1.640 albertel 2392: if (lc($tagname) eq 'img') {
2393: &add_filetype($allfiles,$attr->{'src'},'src');
2394: }
1.886 albertel 2395: if (lc($tagname) eq 'a') {
2396: &add_filetype($allfiles,$attr->{'href'},'href');
2397: }
1.645 raeburn 2398: if (lc($tagname) eq 'script') {
2399: if ($attr->{'archive'} =~ /\.jar$/i) {
2400: &add_filetype($allfiles,$attr->{'archive'},'archive');
2401: } else {
2402: &add_filetype($allfiles,$attr->{'src'},'src');
2403: }
2404: }
2405: if (lc($tagname) eq 'link') {
2406: if (lc($attr->{'rel'}) eq 'stylesheet') {
2407: &add_filetype($allfiles,$attr->{'href'},'href');
2408: }
2409: }
1.640 albertel 2410: if (lc($tagname) eq 'object' ||
2411: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2412: foreach my $item (keys(%javafiles)) {
2413: $javafiles{$item} = '';
2414: }
2415: }
2416: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2417: my $name = lc($attr->{'name'});
2418: foreach my $item (keys(%javafiles)) {
2419: if ($name eq $item) {
2420: $javafiles{$item} = $attr->{'value'};
2421: last;
2422: }
2423: }
2424: foreach my $item (keys(%mediafiles)) {
2425: if ($name eq $item) {
2426: &add_filetype($allfiles, $attr->{'value'}, 'value');
2427: last;
2428: }
2429: }
2430: }
2431: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2432: foreach my $item (keys(%javafiles)) {
2433: if ($attr->{$item}) {
2434: $javafiles{$item} = $attr->{$item};
2435: last;
2436: }
2437: }
2438: foreach my $item (keys(%mediafiles)) {
2439: if ($attr->{$item}) {
2440: &add_filetype($allfiles,$attr->{$item},$item);
2441: last;
2442: }
2443: }
2444: }
2445: } elsif ($t->[0] eq 'E') {
2446: my ($tagname) = ($t->[1]);
2447: if ($javafiles{'codebase'} ne '') {
2448: $javafiles{'codebase'} .= '/';
2449: }
2450: if (lc($tagname) eq 'applet' ||
2451: lc($tagname) eq 'object' ||
2452: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2453: ) {
2454: foreach my $item (keys(%javafiles)) {
2455: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2456: my $file=$javafiles{'codebase'}.$javafiles{$item};
2457: &add_filetype($allfiles,$file,$item);
2458: }
2459: }
2460: }
2461: pop @state;
2462: }
2463: }
1.637 raeburn 2464: return 'ok';
2465: }
2466:
1.639 albertel 2467: sub add_filetype {
2468: my ($allfiles,$file,$type)=@_;
2469: if (exists($allfiles->{$file})) {
2470: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2471: push(@{$allfiles->{$file}}, &escape($type));
2472: }
2473: } else {
2474: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 2475: }
2476: }
2477:
1.493 albertel 2478: sub removeuploadedurl {
1.984 neumanie 2479: my ($url)=@_;
2480: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 2481: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 2482: }
2483:
2484: sub removeuserfile {
2485: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 2486: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2487: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 2488: if ($result eq 'ok') {
1.798 raeburn 2489: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2490: my $metafile = $fname.'.meta';
2491: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 2492: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 2493: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2494: my $sqlresult =
1.823 albertel 2495: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2496: 'portfolio_metadata',$group,
2497: 'delete');
1.798 raeburn 2498: }
2499: }
2500: return $result;
1.257 www 2501: }
1.15 www 2502:
1.530 albertel 2503: sub mkdiruserfile {
2504: my ($docuname,$docudom,$dir)=@_;
2505: my $home=&homeserver($docuname,$docudom);
2506: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2507: }
2508:
1.531 albertel 2509: sub renameuserfile {
2510: my ($docuname,$docudom,$old,$new)=@_;
2511: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2512: my $result = &reply("renameuserfile:$docudom:$docuname:".
2513: &escape("$old").':'.&escape("$new"),$home);
2514: if ($result eq 'ok') {
2515: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2516: my $oldmeta = $old.'.meta';
2517: my $newmeta = $new.'.meta';
2518: my $metaresult =
2519: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 2520: my $url = "/uploaded/$docudom/$docuname/$old";
2521: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2522: my $sqlresult =
1.823 albertel 2523: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2524: 'portfolio_metadata',$group,
2525: 'delete');
1.798 raeburn 2526: }
2527: }
2528: return $result;
1.531 albertel 2529: }
2530:
1.14 www 2531: # ------------------------------------------------------------------------- Log
2532:
2533: sub log {
2534: my ($dom,$nam,$hom,$what)=@_;
1.47 www 2535: return critical("log:$dom:$nam:$what",$hom);
1.157 www 2536: }
2537:
2538: # ------------------------------------------------------------------ Course Log
1.352 www 2539: #
2540: # This routine flushes several buffers of non-mission-critical nature
2541: #
1.157 www 2542:
2543: sub flushcourselogs {
1.352 www 2544: &logthis('Flushing log buffers');
2545: #
2546: # course logs
2547: # This is a log of all transactions in a course, which can be used
2548: # for data mining purposes
2549: #
2550: # It also collects the courseid database, which lists last transaction
2551: # times and course titles for all courseids
2552: #
2553: my %courseidbuffer=();
1.921 raeburn 2554: foreach my $crsid (keys(%courselogs)) {
1.352 www 2555: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 2556: &escape($courselogs{$crsid}),
2557: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 2558: delete $courselogs{$crsid};
2559: } else {
2560: &logthis('Failed to flush log buffer for '.$crsid);
2561: if (length($courselogs{$crsid})>40000) {
1.672 albertel 2562: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 2563: " exceeded maximum size, deleting.</font>");
2564: delete $courselogs{$crsid};
2565: }
1.352 www 2566: }
1.920 raeburn 2567: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 2568: 'description' => $coursedescrbuf{$crsid},
2569: 'inst_code' => $courseinstcodebuf{$crsid},
2570: 'type' => $coursetypebuf{$crsid},
2571: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 2572: };
1.191 harris41 2573: }
1.352 www 2574: #
2575: # Write course id database (reverse lookup) to homeserver of courses
2576: # Is used in pickcourse
2577: #
1.840 albertel 2578: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 2579: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 2580: $courseidbuffer{$crs_home},
2581: $crs_home,'timeonly');
1.352 www 2582: }
2583: #
2584: # File accesses
2585: # Writes to the dynamic metadata of resources to get hit counts, etc.
2586: #
1.449 matthew 2587: foreach my $entry (keys(%accesshash)) {
1.458 matthew 2588: if ($entry =~ /___count$/) {
2589: my ($dom,$name);
1.807 albertel 2590: ($dom,$name,undef)=
1.811 albertel 2591: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 2592: if (! defined($dom) || $dom eq '' ||
2593: ! defined($name) || $name eq '') {
1.620 albertel 2594: my $cid = $env{'request.course.id'};
2595: $dom = $env{'request.'.$cid.'.domain'};
2596: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 2597: }
1.450 matthew 2598: my $value = $accesshash{$entry};
2599: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2600: my %temphash=($url => $value);
1.449 matthew 2601: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2602: if ($result eq 'ok') {
2603: delete $accesshash{$entry};
2604: } elsif ($result eq 'unknown_cmd') {
2605: # Target server has old code running on it.
1.450 matthew 2606: my %temphash=($entry => $value);
1.449 matthew 2607: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2608: delete $accesshash{$entry};
2609: }
2610: }
2611: } else {
1.811 albertel 2612: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.450 matthew 2613: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 2614: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2615: delete $accesshash{$entry};
2616: }
1.185 www 2617: }
1.191 harris41 2618: }
1.352 www 2619: #
2620: # Roles
2621: # Reverse lookup of user roles for course faculty/staff and co-authorship
2622: #
1.800 albertel 2623: foreach my $entry (keys(%userrolehash)) {
1.351 www 2624: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 2625: split(/\:/,$entry);
2626: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 2627: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 2628: $rudom,$runame) eq 'ok') {
2629: delete $userrolehash{$entry};
2630: }
2631: }
1.662 raeburn 2632: #
2633: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2634: #
2635: my %domrolebuffer = ();
1.1000 raeburn 2636: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 2637: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 2638: if ($domrolebuffer{$rudom}) {
2639: $domrolebuffer{$rudom}.='&'.&escape($entry).
2640: '='.&escape($domainrolehash{$entry});
2641: } else {
2642: $domrolebuffer{$rudom}.=&escape($entry).
2643: '='.&escape($domainrolehash{$entry});
2644: }
2645: delete $domainrolehash{$entry};
2646: }
2647: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 2648: my %servers = &get_servers($dom,'library');
2649: foreach my $tryserver (keys(%servers)) {
2650: unless (&reply('domroleput:'.$dom.':'.
2651: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2652: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2653: }
1.662 raeburn 2654: }
2655: }
1.186 www 2656: $dumpcount++;
1.157 www 2657: }
2658:
2659: sub courselog {
2660: my $what=shift;
1.158 www 2661: $what=time.':'.$what;
1.620 albertel 2662: unless ($env{'request.course.id'}) { return ''; }
2663: $coursedombuf{$env{'request.course.id'}}=
2664: $env{'course.'.$env{'request.course.id'}.'.domain'};
2665: $coursenumbuf{$env{'request.course.id'}}=
2666: $env{'course.'.$env{'request.course.id'}.'.num'};
2667: $coursehombuf{$env{'request.course.id'}}=
2668: $env{'course.'.$env{'request.course.id'}.'.home'};
2669: $coursedescrbuf{$env{'request.course.id'}}=
2670: $env{'course.'.$env{'request.course.id'}.'.description'};
2671: $courseinstcodebuf{$env{'request.course.id'}}=
2672: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2673: $courseownerbuf{$env{'request.course.id'}}=
2674: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 2675: $coursetypebuf{$env{'request.course.id'}}=
2676: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 2677: if (defined $courselogs{$env{'request.course.id'}}) {
2678: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 2679: } else {
1.620 albertel 2680: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 2681: }
1.620 albertel 2682: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 2683: &flushcourselogs();
2684: }
1.158 www 2685: }
2686:
2687: sub courseacclog {
2688: my $fnsymb=shift;
1.620 albertel 2689: unless ($env{'request.course.id'}) { return ''; }
2690: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 2691: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 2692: $what.=':POST';
1.583 matthew 2693: # FIXME: Probably ought to escape things....
1.800 albertel 2694: foreach my $key (keys(%env)) {
2695: if ($key=~/^form\.(.*)/) {
1.975 raeburn 2696: my $formitem = $1;
2697: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2698: $what.=':'.$formitem.'='.$env{$key};
2699: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2700: $what.=':'.$formitem.'='.$env{$key};
2701: }
1.158 www 2702: }
1.191 harris41 2703: }
1.583 matthew 2704: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2705: # FIXME: We should not be depending on a form parameter that someone
2706: # editing lonsearchcat.pm might change in the future.
1.620 albertel 2707: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 2708: $what.= ':POST';
2709: # FIXME: Probably ought to escape things....
2710: foreach my $element ('courseexp','crsfulltext','crsrelated',
2711: 'crsdiscuss') {
1.620 albertel 2712: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 2713: }
2714: }
1.158 www 2715: }
2716: &courselog($what);
1.149 www 2717: }
2718:
1.185 www 2719: sub countacc {
2720: my $url=&declutter(shift);
1.458 matthew 2721: return if (! defined($url) || $url eq '');
1.620 albertel 2722: unless ($env{'request.course.id'}) { return ''; }
2723: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 2724: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 2725: $accesshash{$key}++;
1.185 www 2726: }
1.349 www 2727:
1.361 www 2728: sub linklog {
2729: my ($from,$to)=@_;
2730: $from=&declutter($from);
2731: $to=&declutter($to);
2732: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2733: $accesshash{$to.'___'.$from.'___goto'}=1;
2734: }
2735:
1.349 www 2736: sub userrolelog {
2737: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 2738: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 2739: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 2740: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1.1041 raeburn 2741: ($trole=~/^ta/) || ($trole=~/^co/)) {
1.350 www 2742: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2743: $userrolehash
2744: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 2745: =$tend.':'.$tstart;
1.662 raeburn 2746: }
1.898 albertel 2747: if (($env{'request.role'} =~ /dc\./) &&
2748: (($trole=~/^au/) || ($trole=~/^in/) ||
2749: ($trole=~/^cc/) || ($trole=~/^ep/) ||
1.1041 raeburn 2750: ($trole=~/^cr/) || ($trole=~/^ta/) ||
2751: ($trole=~/^co/))) {
1.898 albertel 2752: $userrolehash
2753: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2754: =$tend.':'.$tstart;
2755: }
1.662 raeburn 2756: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2757: ($trole=~/^li/) || ($trole=~/^li/) ||
2758: ($trole=~/^au/) || ($trole=~/^dg/) ||
2759: ($trole=~/^sc/)) {
2760: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2761: $domainrolehash
2762: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2763: = $tend.':'.$tstart;
2764: }
1.351 www 2765: }
2766:
1.957 raeburn 2767: sub courserolelog {
2768: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2769: if (($trole eq 'cc') || ($trole eq 'in') ||
2770: ($trole eq 'ep') || ($trole eq 'ad') ||
2771: ($trole eq 'ta') || ($trole eq 'st') ||
1.1044 raeburn 2772: ($trole=~/^cr/) || ($trole eq 'gr') ||
2773: ($trole eq 'co')) {
1.957 raeburn 2774: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2775: my $cdom = $1;
2776: my $cnum = $2;
2777: my $sec = $3;
2778: my $namespace = 'rolelog';
2779: my %storehash = (
2780: role => $trole,
2781: start => $tstart,
2782: end => $tend,
2783: selfenroll => $selfenroll,
2784: context => $context,
2785: );
2786: if ($trole eq 'gr') {
2787: $namespace = 'groupslog';
2788: $storehash{'group'} = $sec;
2789: } else {
2790: $storehash{'section'} = $sec;
2791: }
2792: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
1.996 raeburn 2793: if (($trole ne 'st') || ($sec ne '')) {
2794: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2795: }
1.957 raeburn 2796: }
2797: }
2798: return;
2799: }
2800:
1.351 www 2801: sub get_course_adv_roles {
1.948 raeburn 2802: my ($cid,$codes) = @_;
1.620 albertel 2803: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 2804: my %coursehash=&coursedescription($cid);
1.988 raeburn 2805: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 2806: my %nothide=();
1.800 albertel 2807: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 2808: if ($user !~ /:/) {
2809: $nothide{join(':',split(/[\@]/,$user))}=1;
2810: } else {
2811: $nothide{$user}=1;
2812: }
1.470 www 2813: }
1.351 www 2814: my %returnhash=();
2815: my %dumphash=
2816: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2817: my $now=time;
1.997 raeburn 2818: my %privileged;
1.1000 raeburn 2819: foreach my $entry (keys(%dumphash)) {
1.800 albertel 2820: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 2821: if (($tstart) && ($tstart<0)) { next; }
2822: if (($tend) && ($tend<$now)) { next; }
2823: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 2824: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 2825: if ($username eq '' || $domain eq '') { next; }
1.997 raeburn 2826: unless (ref($privileged{$domain}) eq 'HASH') {
2827: my %dompersonnel =
1.998 raeburn 2828: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
1.997 raeburn 2829: $privileged{$domain} = {};
2830: foreach my $server (keys(%dompersonnel)) {
1.999 raeburn 2831: if (ref($dompersonnel{$server}) eq 'HASH') {
1.997 raeburn 2832: foreach my $user (keys(%{$dompersonnel{$server}})) {
2833: my ($trole,$uname,$udom) = split(/:/,$user);
2834: $privileged{$udom}{$uname} = 1;
2835: }
2836: }
2837: }
2838: }
2839: if ((exists($privileged{$domain}{$username})) &&
2840: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 2841: if ($role eq 'cr') { next; }
1.948 raeburn 2842: if ($codes) {
2843: if ($section) { $role .= ':'.$section; }
2844: if ($returnhash{$role}) {
2845: $returnhash{$role}.=','.$username.':'.$domain;
2846: } else {
2847: $returnhash{$role}=$username.':'.$domain;
2848: }
1.351 www 2849: } else {
1.988 raeburn 2850: my $key=&plaintext($role,$crstype);
1.973 bisitz 2851: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 2852: if ($returnhash{$key}) {
2853: $returnhash{$key}.=','.$username.':'.$domain;
2854: } else {
2855: $returnhash{$key}=$username.':'.$domain;
2856: }
1.351 www 2857: }
1.948 raeburn 2858: }
1.400 www 2859: return %returnhash;
2860: }
2861:
2862: sub get_my_roles {
1.937 raeburn 2863: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 2864: unless (defined($uname)) { $uname=$env{'user.name'}; }
2865: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 2866: my (%dumphash,%nothide);
1.858 raeburn 2867: if ($context eq 'userroles') {
2868: %dumphash = &dump('roles',$udom,$uname);
2869: } else {
2870: %dumphash=
1.400 www 2871: &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 2872: if ($hidepriv) {
2873: my %coursehash=&coursedescription($udom.'_'.$uname);
2874: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2875: if ($user !~ /:/) {
2876: $nothide{join(':',split(/[\@]/,$user))} = 1;
2877: } else {
2878: $nothide{$user} = 1;
2879: }
2880: }
2881: }
1.858 raeburn 2882: }
1.400 www 2883: my %returnhash=();
2884: my $now=time;
1.999 raeburn 2885: my %privileged;
1.800 albertel 2886: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 2887: my ($role,$tend,$tstart);
2888: if ($context eq 'userroles') {
2889: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2890: } else {
2891: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2892: }
1.400 www 2893: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 2894: my $status = 'active';
1.939 raeburn 2895: if (($tend) && ($tend<=$now)) {
1.832 raeburn 2896: $status = 'previous';
2897: }
2898: if (($tstart) && ($now<$tstart)) {
2899: $status = 'future';
2900: }
2901: if (ref($types) eq 'ARRAY') {
2902: if (!grep(/^\Q$status\E$/,@{$types})) {
2903: next;
2904: }
2905: } else {
2906: if ($status ne 'active') {
2907: next;
2908: }
2909: }
1.867 raeburn 2910: my ($rolecode,$username,$domain,$section,$area);
2911: if ($context eq 'userroles') {
2912: ($area,$rolecode) = split(/_/,$entry);
2913: (undef,$domain,$username,$section) = split(/\//,$area);
2914: } else {
2915: ($role,$username,$domain,$section) = split(/\:/,$entry);
2916: }
1.832 raeburn 2917: if (ref($roledoms) eq 'ARRAY') {
2918: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2919: next;
2920: }
2921: }
2922: if (ref($roles) eq 'ARRAY') {
2923: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 2924: if ($role =~ /^cr\//) {
2925: if (!grep(/^cr$/,@{$roles})) {
2926: next;
2927: }
2928: } else {
2929: next;
2930: }
1.832 raeburn 2931: }
1.867 raeburn 2932: }
1.937 raeburn 2933: if ($hidepriv) {
1.999 raeburn 2934: if ($context eq 'userroles') {
2935: if ((&privileged($username,$domain)) &&
2936: (!$nothide{$username.':'.$domain})) {
2937: next;
2938: }
2939: } else {
2940: unless (ref($privileged{$domain}) eq 'HASH') {
2941: my %dompersonnel =
2942: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2943: $privileged{$domain} = {};
2944: if (keys(%dompersonnel)) {
2945: foreach my $server (keys(%dompersonnel)) {
2946: if (ref($dompersonnel{$server}) eq 'HASH') {
2947: foreach my $user (keys(%{$dompersonnel{$server}})) {
2948: my ($trole,$uname,$udom) = split(/:/,$user);
2949: $privileged{$udom}{$uname} = $trole;
2950: }
2951: }
2952: }
2953: }
2954: }
2955: if (exists($privileged{$domain}{$username})) {
2956: if (!$nothide{$username.':'.$domain}) {
2957: next;
2958: }
2959: }
1.937 raeburn 2960: }
2961: }
1.933 raeburn 2962: if ($withsec) {
2963: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2964: $tstart.':'.$tend;
2965: } else {
2966: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2967: }
1.832 raeburn 2968: }
1.373 www 2969: return %returnhash;
1.399 www 2970: }
2971:
2972: # ----------------------------------------------------- Frontpage Announcements
2973: #
2974: #
2975:
2976: sub postannounce {
2977: my ($server,$text)=@_;
1.844 albertel 2978: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 2979: unless ($text=~/\w/) { $text=''; }
2980: return &reply('setannounce:'.&escape($text),$server);
2981: }
2982:
2983: sub getannounce {
1.448 albertel 2984:
2985: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 2986: my $announcement='';
1.800 albertel 2987: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 2988: close($fh);
1.399 www 2989: if ($announcement=~/\w/) {
2990: return
2991: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 2992: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 2993: } else {
2994: return '';
2995: }
2996: } else {
2997: return '';
2998: }
1.351 www 2999: }
1.353 www 3000:
3001: # ---------------------------------------------------------- Course ID routines
3002: # Deal with domain's nohist_courseid.db files
3003: #
3004:
3005: sub courseidput {
1.921 raeburn 3006: my ($domain,$storehash,$coursehome,$caller) = @_;
3007: my $outcome;
3008: if ($caller eq 'timeonly') {
3009: my $cids = '';
3010: foreach my $item (keys(%$storehash)) {
3011: $cids.=&escape($item).'&';
3012: }
3013: $cids=~s/\&$//;
3014: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3015: $coursehome);
3016: } else {
3017: my $items = '';
3018: foreach my $item (keys(%$storehash)) {
3019: $items.= &escape($item).'='.
3020: &freeze_escape($$storehash{$item}).'&';
3021: }
3022: $items=~s/\&$//;
3023: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3024: $coursehome);
1.918 raeburn 3025: }
3026: if ($outcome eq 'unknown_cmd') {
3027: my $what;
3028: foreach my $cid (keys(%$storehash)) {
3029: $what .= &escape($cid).'=';
1.921 raeburn 3030: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 3031: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 3032: }
3033: $what =~ s/\:$/&/;
3034: }
3035: $what =~ s/\&$//;
3036: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3037: } else {
3038: return $outcome;
3039: }
1.353 www 3040: }
3041:
3042: sub courseiddump {
1.921 raeburn 3043: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 3044: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 3045: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3046: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
1.918 raeburn 3047: my $as_hash = 1;
3048: my %returnhash;
3049: if (!$domfilter) { $domfilter=''; }
1.845 albertel 3050: my %libserv = &all_library();
3051: foreach my $tryserver (keys(%libserv)) {
3052: if ( ( $hostidflag == 1
3053: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3054: || (!defined($hostidflag)) ) {
3055:
1.918 raeburn 3056: if (($domfilter eq '') ||
3057: (&host_domain($tryserver) eq $domfilter)) {
3058: my $rep =
3059: &reply('courseiddump:'.&host_domain($tryserver).':'.
3060: $sincefilter.':'.&escape($descfilter).':'.
3061: &escape($instcodefilter).':'.&escape($ownerfilter).
3062: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947 raeburn 3063: ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962 raeburn 3064: &escape($selfenrollonly).':'.&escape($catfilter).':'.
1.1008 raeburn 3065: $showhidden.':'.$caller.':'.&escape($cloner).':'.
1.1029 raeburn 3066: &escape($cc_clone).':'.$cloneonly.':'.
3067: &escape($createdbefore).':'.&escape($createdafter).':'.
3068: &escape($creationcontext),$tryserver);
1.918 raeburn 3069: my @pairs=split(/\&/,$rep);
3070: foreach my $item (@pairs) {
3071: my ($key,$value)=split(/\=/,$item,2);
3072: $key = &unescape($key);
3073: next if ($key =~ /^error: 2 /);
3074: my $result = &thaw_unescape($value);
3075: if (ref($result) eq 'HASH') {
3076: $returnhash{$key}=$result;
3077: } else {
1.921 raeburn 3078: my @responses = split(/:/,$value);
3079: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3080: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3081: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3082: }
1.1008 raeburn 3083: }
1.353 www 3084: }
3085: }
3086: }
3087: }
3088: return %returnhash;
3089: }
3090:
1.658 raeburn 3091: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3092:
3093: sub dcmailput {
1.685 raeburn 3094: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3095: my $status = &Apache::lonnet::critical(
1.740 www 3096: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3097: &escape($message),$server);
1.662 raeburn 3098: return $status;
3099: }
3100:
1.658 raeburn 3101: sub dcmaildump {
3102: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3103: my %returnhash=();
1.846 albertel 3104:
3105: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3106: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3107: &escape($enddate).':';
3108: my @esc_senders=map { &escape($_)} @$senders;
3109: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3110: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3111: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3112: if (($key) && ($value)) {
3113: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3114: }
3115: }
3116: }
3117: return %returnhash;
3118: }
1.662 raeburn 3119: # ---------------------------------------------------------- Domain roles
3120:
3121: sub get_domain_roles {
3122: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 3123: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 3124: $startdate = '.';
3125: }
1.1018 raeburn 3126: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 3127: $enddate = '.';
3128: }
1.922 raeburn 3129: my $rolelist;
3130: if (ref($roles) eq 'ARRAY') {
3131: $rolelist = join(':',@{$roles});
3132: }
1.662 raeburn 3133: my %personnel = ();
1.841 albertel 3134:
3135: my %servers = &get_servers($dom,'library');
3136: foreach my $tryserver (keys(%servers)) {
3137: %{$personnel{$tryserver}}=();
3138: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3139: &escape($startdate).':'.
3140: &escape($enddate).':'.
3141: &escape($rolelist), $tryserver))) {
3142: my ($key,$value) = split(/\=/,$line,2);
3143: if (($key) && ($value)) {
3144: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3145: }
3146: }
1.662 raeburn 3147: }
3148: return %personnel;
3149: }
1.658 raeburn 3150:
1.149 www 3151: # ----------------------------------------------------------- Check out an item
3152:
1.504 albertel 3153: sub get_first_access {
3154: my ($type,$argsymb)=@_;
1.790 albertel 3155: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3156: if ($argsymb) { $symb=$argsymb; }
3157: my ($map,$id,$res)=&decode_symb($symb);
1.926 albertel 3158: if ($type eq 'course') {
3159: $res='course';
3160: } elsif ($type eq 'map') {
1.588 albertel 3161: $res=&symbread($map);
3162: } else {
3163: $res=$symb;
3164: }
3165: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3166: return $times{"$courseid\0$res"};
1.504 albertel 3167: }
3168:
3169: sub set_first_access {
3170: my ($type)=@_;
1.790 albertel 3171: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3172: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 3173: if ($type eq 'course') {
3174: $res='course';
3175: } elsif ($type eq 'map') {
1.588 albertel 3176: $res=&symbread($map);
3177: } else {
3178: $res=$symb;
3179: }
3180: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 3181: if (!$firstaccess) {
1.588 albertel 3182: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 3183: }
3184: return 'already_set';
1.504 albertel 3185: }
3186:
1.149 www 3187: sub checkout {
3188: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3189: my $now=time;
3190: my $lonhost=$perlvar{'lonHostID'};
3191: my $infostr=&escape(
1.234 www 3192: 'CHECKOUTTOKEN&'.
1.149 www 3193: $tuname.'&'.
3194: $tudom.'&'.
3195: $tcrsid.'&'.
3196: $symb.'&'.
3197: $now.'&'.$ENV{'REMOTE_ADDR'});
3198: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 3199: if ($token=~/^error\:/) {
1.672 albertel 3200: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3201: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3202: "</font>");
3203: return '';
3204: }
3205:
1.149 www 3206: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3207: $token=~tr/a-z/A-Z/;
3208:
1.153 www 3209: my %infohash=('resource.0.outtoken' => $token,
3210: 'resource.0.checkouttime' => $now,
3211: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 3212:
3213: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3214: return '';
1.151 www 3215: } else {
1.672 albertel 3216: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3217: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3218: "</font>");
1.149 www 3219: }
3220:
3221: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3222: &escape('Checkout '.$infostr.' - '.
3223: $token)) ne 'ok') {
3224: return '';
1.151 www 3225: } else {
1.672 albertel 3226: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3227: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3228: "</font>");
1.149 www 3229: }
1.151 www 3230: return $token;
1.149 www 3231: }
3232:
3233: # ------------------------------------------------------------ Check in an item
3234:
3235: sub checkin {
3236: my $token=shift;
1.150 www 3237: my $now=time;
3238: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3239: $lonhost=~tr/A-Z/a-z/;
1.838 albertel 3240: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150 www 3241: $dtoken=~s/\W/\_/g;
1.234 www 3242: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 3243: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3244:
1.154 www 3245: unless (($tuname) && ($tudom)) {
3246: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3247: return '';
3248: }
3249:
3250: unless (&allowed('mgr',$tcrsid)) {
3251: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 3252: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 3253: return '';
3254: }
3255:
1.153 www 3256: my %infohash=('resource.0.intoken' => $token,
3257: 'resource.0.checkintime' => $now,
3258: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 3259:
3260: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3261: return '';
3262: }
3263:
3264: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3265: &escape('Checkin - '.$token)) ne 'ok') {
3266: return '';
3267: }
3268:
3269: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 3270: }
3271:
3272: # --------------------------------------------- Set Expire Date for Spreadsheet
3273:
3274: sub expirespread {
3275: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 3276: my $cid=$env{'request.course.id'};
1.110 www 3277: if ($cid) {
3278: my $now=time;
3279: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 3280: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3281: $env{'course.'.$cid.'.num'}.
1.110 www 3282: ':nohist_expirationdates:'.
3283: &escape($key).'='.$now,
1.620 albertel 3284: $env{'course.'.$cid.'.home'})
1.110 www 3285: }
3286: return 'ok';
1.14 www 3287: }
3288:
1.109 www 3289: # ----------------------------------------------------- Devalidate Spreadsheets
3290:
3291: sub devalidate {
1.325 www 3292: my ($symb,$uname,$udom)=@_;
1.620 albertel 3293: my $cid=$env{'request.course.id'};
1.109 www 3294: if ($cid) {
1.391 matthew 3295: # delete the stored spreadsheets for
3296: # - the student level sheet of this user in course's homespace
3297: # - the assessment level sheet for this resource
3298: # for this user in user's homespace
1.553 albertel 3299: # - current conditional state info
1.325 www 3300: my $key=$uname.':'.$udom.':';
1.109 www 3301: my $status=
1.299 matthew 3302: &del('nohist_calculatedsheets',
1.391 matthew 3303: [$key.'studentcalc:'],
1.620 albertel 3304: $env{'course.'.$cid.'.domain'},
3305: $env{'course.'.$cid.'.num'})
1.133 albertel 3306: .' '.
3307: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 3308: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 3309: unless ($status eq 'ok ok') {
3310: &logthis('Could not devalidate spreadsheet '.
1.325 www 3311: $uname.' at '.$udom.' for '.
1.109 www 3312: $symb.': '.$status);
1.133 albertel 3313: }
1.553 albertel 3314: &delenv('user.state.'.$cid);
1.109 www 3315: }
3316: }
3317:
1.265 albertel 3318: sub get_scalar {
3319: my ($string,$end) = @_;
3320: my $value;
3321: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3322: $value = $1;
3323: } elsif ($$string =~ s/^([^&]*?)&//) {
3324: $value = $1;
3325: }
3326: return &unescape($value);
3327: }
3328:
3329: sub array2str {
3330: my (@array) = @_;
3331: my $result=&arrayref2str(\@array);
3332: $result=~s/^__ARRAY_REF__//;
3333: $result=~s/__END_ARRAY_REF__$//;
3334: return $result;
3335: }
3336:
1.204 albertel 3337: sub arrayref2str {
3338: my ($arrayref) = @_;
1.265 albertel 3339: my $result='__ARRAY_REF__';
1.204 albertel 3340: foreach my $elem (@$arrayref) {
1.265 albertel 3341: if(ref($elem) eq 'ARRAY') {
3342: $result.=&arrayref2str($elem).'&';
3343: } elsif(ref($elem) eq 'HASH') {
3344: $result.=&hashref2str($elem).'&';
3345: } elsif(ref($elem)) {
3346: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 3347: } else {
3348: $result.=&escape($elem).'&';
3349: }
3350: }
3351: $result=~s/\&$//;
1.265 albertel 3352: $result .= '__END_ARRAY_REF__';
1.204 albertel 3353: return $result;
3354: }
3355:
1.168 albertel 3356: sub hash2str {
1.204 albertel 3357: my (%hash) = @_;
3358: my $result=&hashref2str(\%hash);
1.265 albertel 3359: $result=~s/^__HASH_REF__//;
3360: $result=~s/__END_HASH_REF__$//;
1.204 albertel 3361: return $result;
3362: }
3363:
3364: sub hashref2str {
3365: my ($hashref)=@_;
1.265 albertel 3366: my $result='__HASH_REF__';
1.800 albertel 3367: foreach my $key (sort(keys(%$hashref))) {
3368: if (ref($key) eq 'ARRAY') {
3369: $result.=&arrayref2str($key).'=';
3370: } elsif (ref($key) eq 'HASH') {
3371: $result.=&hashref2str($key).'=';
3372: } elsif (ref($key)) {
1.265 albertel 3373: $result.='=';
1.800 albertel 3374: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 3375: } else {
1.800 albertel 3376: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 3377: }
3378:
1.800 albertel 3379: if(ref($hashref->{$key}) eq 'ARRAY') {
3380: $result.=&arrayref2str($hashref->{$key}).'&';
3381: } elsif(ref($hashref->{$key}) eq 'HASH') {
3382: $result.=&hashref2str($hashref->{$key}).'&';
3383: } elsif(ref($hashref->{$key})) {
1.265 albertel 3384: $result.='&';
1.800 albertel 3385: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 3386: } else {
1.800 albertel 3387: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 3388: }
3389: }
1.168 albertel 3390: $result=~s/\&$//;
1.265 albertel 3391: $result .= '__END_HASH_REF__';
1.168 albertel 3392: return $result;
3393: }
3394:
3395: sub str2hash {
1.265 albertel 3396: my ($string)=@_;
3397: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3398: return %$hash;
3399: }
3400:
3401: sub str2hashref {
1.168 albertel 3402: my ($string) = @_;
1.265 albertel 3403:
3404: my %hash;
3405:
3406: if($string !~ /^__HASH_REF__/) {
3407: if (! ($string eq '' || !defined($string))) {
3408: $hash{'error'}='Not hash reference';
3409: }
3410: return (\%hash, $string);
3411: }
3412:
3413: $string =~ s/^__HASH_REF__//;
3414:
3415: while($string !~ /^__END_HASH_REF__/) {
3416: #key
3417: my $key='';
3418: if($string =~ /^__HASH_REF__/) {
3419: ($key, $string)=&str2hashref($string);
3420: if(defined($key->{'error'})) {
3421: $hash{'error'}='Bad data';
3422: return (\%hash, $string);
3423: }
3424: } elsif($string =~ /^__ARRAY_REF__/) {
3425: ($key, $string)=&str2arrayref($string);
3426: if($key->[0] eq 'Array reference error') {
3427: $hash{'error'}='Bad data';
3428: return (\%hash, $string);
3429: }
3430: } else {
3431: $string =~ s/^(.*?)=//;
1.267 albertel 3432: $key=&unescape($1);
1.265 albertel 3433: }
3434: $string =~ s/^=//;
3435:
3436: #value
3437: my $value='';
3438: if($string =~ /^__HASH_REF__/) {
3439: ($value, $string)=&str2hashref($string);
3440: if(defined($value->{'error'})) {
3441: $hash{'error'}='Bad data';
3442: return (\%hash, $string);
3443: }
3444: } elsif($string =~ /^__ARRAY_REF__/) {
3445: ($value, $string)=&str2arrayref($string);
3446: if($value->[0] eq 'Array reference error') {
3447: $hash{'error'}='Bad data';
3448: return (\%hash, $string);
3449: }
3450: } else {
3451: $value=&get_scalar(\$string,'__END_HASH_REF__');
3452: }
3453: $string =~ s/^&//;
3454:
3455: $hash{$key}=$value;
1.204 albertel 3456: }
1.265 albertel 3457:
3458: $string =~ s/^__END_HASH_REF__//;
3459:
3460: return (\%hash, $string);
1.204 albertel 3461: }
3462:
3463: sub str2array {
1.265 albertel 3464: my ($string)=@_;
3465: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3466: return @$array;
3467: }
3468:
3469: sub str2arrayref {
1.204 albertel 3470: my ($string) = @_;
1.265 albertel 3471: my @array;
3472:
3473: if($string !~ /^__ARRAY_REF__/) {
3474: if (! ($string eq '' || !defined($string))) {
3475: $array[0]='Array reference error';
3476: }
3477: return (\@array, $string);
3478: }
3479:
3480: $string =~ s/^__ARRAY_REF__//;
3481:
3482: while($string !~ /^__END_ARRAY_REF__/) {
3483: my $value='';
3484: if($string =~ /^__HASH_REF__/) {
3485: ($value, $string)=&str2hashref($string);
3486: if(defined($value->{'error'})) {
3487: $array[0] ='Array reference error';
3488: return (\@array, $string);
3489: }
3490: } elsif($string =~ /^__ARRAY_REF__/) {
3491: ($value, $string)=&str2arrayref($string);
3492: if($value->[0] eq 'Array reference error') {
3493: $array[0] ='Array reference error';
3494: return (\@array, $string);
3495: }
3496: } else {
3497: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3498: }
3499: $string =~ s/^&//;
3500:
3501: push(@array, $value);
1.191 harris41 3502: }
1.265 albertel 3503:
3504: $string =~ s/^__END_ARRAY_REF__//;
3505:
3506: return (\@array, $string);
1.168 albertel 3507: }
3508:
1.167 albertel 3509: # -------------------------------------------------------------------Temp Store
3510:
1.168 albertel 3511: sub tmpreset {
3512: my ($symb,$namespace,$domain,$stuname) = @_;
3513: if (!$symb) {
3514: $symb=&symbread();
1.620 albertel 3515: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3516: }
3517: $symb=escape($symb);
3518:
1.620 albertel 3519: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3520: $namespace=~s/\//\_/g;
3521: $namespace=~s/\W//g;
3522:
1.620 albertel 3523: if (!$domain) { $domain=$env{'user.domain'}; }
3524: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3525: if ($domain eq 'public' && $stuname eq 'public') {
3526: $stuname=$ENV{'REMOTE_ADDR'};
3527: }
1.168 albertel 3528: my $path=$perlvar{'lonDaemons'}.'/tmp';
3529: my %hash;
3530: if (tie(%hash,'GDBM_File',
3531: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3532: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 3533: foreach my $key (keys(%hash)) {
1.180 albertel 3534: if ($key=~ /:$symb/) {
1.168 albertel 3535: delete($hash{$key});
3536: }
3537: }
3538: }
3539: }
3540:
1.167 albertel 3541: sub tmpstore {
1.168 albertel 3542: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3543:
3544: if (!$symb) {
3545: $symb=&symbread();
1.620 albertel 3546: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3547: }
3548: $symb=escape($symb);
3549:
3550: if (!$namespace) {
3551: # I don't think we would ever want to store this for a course.
3552: # it seems this will only be used if we don't have a course.
1.620 albertel 3553: #$namespace=$env{'request.course.id'};
1.168 albertel 3554: #if (!$namespace) {
1.620 albertel 3555: $namespace=$env{'request.state'};
1.168 albertel 3556: #}
3557: }
3558: $namespace=~s/\//\_/g;
3559: $namespace=~s/\W//g;
1.620 albertel 3560: if (!$domain) { $domain=$env{'user.domain'}; }
3561: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3562: if ($domain eq 'public' && $stuname eq 'public') {
3563: $stuname=$ENV{'REMOTE_ADDR'};
3564: }
1.168 albertel 3565: my $now=time;
3566: my %hash;
3567: my $path=$perlvar{'lonDaemons'}.'/tmp';
3568: if (tie(%hash,'GDBM_File',
3569: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3570: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3571: $hash{"version:$symb"}++;
3572: my $version=$hash{"version:$symb"};
3573: my $allkeys='';
3574: foreach my $key (keys(%$storehash)) {
3575: $allkeys.=$key.':';
1.591 albertel 3576: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3577: }
3578: $hash{"$version:$symb:timestamp"}=$now;
3579: $allkeys.='timestamp';
3580: $hash{"$version:keys:$symb"}=$allkeys;
3581: if (untie(%hash)) {
3582: return 'ok';
3583: } else {
3584: return "error:$!";
3585: }
3586: } else {
3587: return "error:$!";
3588: }
3589: }
1.167 albertel 3590:
1.168 albertel 3591: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3592:
1.168 albertel 3593: sub tmprestore {
3594: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3595:
1.168 albertel 3596: if (!$symb) {
3597: $symb=&symbread();
1.620 albertel 3598: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3599: }
3600: $symb=escape($symb);
3601:
1.620 albertel 3602: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3603:
1.620 albertel 3604: if (!$domain) { $domain=$env{'user.domain'}; }
3605: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3606: if ($domain eq 'public' && $stuname eq 'public') {
3607: $stuname=$ENV{'REMOTE_ADDR'};
3608: }
1.168 albertel 3609: my %returnhash;
3610: $namespace=~s/\//\_/g;
3611: $namespace=~s/\W//g;
3612: my %hash;
3613: my $path=$perlvar{'lonDaemons'}.'/tmp';
3614: if (tie(%hash,'GDBM_File',
3615: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3616: &GDBM_READER(),0640)) {
1.168 albertel 3617: my $version=$hash{"version:$symb"};
3618: $returnhash{'version'}=$version;
3619: my $scope;
3620: for ($scope=1;$scope<=$version;$scope++) {
3621: my $vkeys=$hash{"$scope:keys:$symb"};
3622: my @keys=split(/:/,$vkeys);
3623: my $key;
3624: $returnhash{"$scope:keys"}=$vkeys;
3625: foreach $key (@keys) {
1.591 albertel 3626: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3627: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3628: }
3629: }
1.168 albertel 3630: if (!(untie(%hash))) {
3631: return "error:$!";
3632: }
3633: } else {
3634: return "error:$!";
3635: }
3636: return %returnhash;
1.167 albertel 3637: }
3638:
1.9 www 3639: # ----------------------------------------------------------------------- Store
3640:
3641: sub store {
1.124 www 3642: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3643: my $home='';
3644:
1.168 albertel 3645: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3646:
1.213 www 3647: $symb=&symbclean($symb);
1.122 albertel 3648: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3649:
1.620 albertel 3650: if (!$domain) { $domain=$env{'user.domain'}; }
3651: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3652:
3653: &devalidate($symb,$stuname,$domain);
1.109 www 3654:
3655: $symb=escape($symb);
1.187 www 3656: if (!$namespace) {
1.620 albertel 3657: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3658: return '';
3659: }
3660: }
1.620 albertel 3661: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3662:
3663: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3664: $$storehash{'host'}=$perlvar{'lonHostID'};
3665:
1.12 www 3666: my $namevalue='';
1.800 albertel 3667: foreach my $key (keys(%$storehash)) {
3668: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3669: }
1.12 www 3670: $namevalue=~s/\&$//;
1.187 www 3671: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3672: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3673: }
3674:
1.47 www 3675: # -------------------------------------------------------------- Critical Store
3676:
3677: sub cstore {
1.124 www 3678: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3679: my $home='';
3680:
1.168 albertel 3681: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3682:
1.213 www 3683: $symb=&symbclean($symb);
1.122 albertel 3684: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3685:
1.620 albertel 3686: if (!$domain) { $domain=$env{'user.domain'}; }
3687: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3688:
3689: &devalidate($symb,$stuname,$domain);
1.109 www 3690:
3691: $symb=escape($symb);
1.187 www 3692: if (!$namespace) {
1.620 albertel 3693: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3694: return '';
3695: }
3696: }
1.620 albertel 3697: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3698:
3699: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3700: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3701:
1.47 www 3702: my $namevalue='';
1.800 albertel 3703: foreach my $key (keys(%$storehash)) {
3704: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3705: }
1.47 www 3706: $namevalue=~s/\&$//;
1.187 www 3707: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3708: return critical
3709: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3710: }
3711:
1.9 www 3712: # --------------------------------------------------------------------- Restore
3713:
3714: sub restore {
1.124 www 3715: my ($symb,$namespace,$domain,$stuname) = @_;
3716: my $home='';
3717:
1.168 albertel 3718: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3719:
1.122 albertel 3720: if (!$symb) {
3721: unless ($symb=escape(&symbread())) { return ''; }
3722: } else {
1.213 www 3723: $symb=&escape(&symbclean($symb));
1.122 albertel 3724: }
1.188 www 3725: if (!$namespace) {
1.620 albertel 3726: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3727: return '';
3728: }
3729: }
1.620 albertel 3730: if (!$domain) { $domain=$env{'user.domain'}; }
3731: if (!$stuname) { $stuname=$env{'user.name'}; }
3732: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3733: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3734:
1.12 www 3735: my %returnhash=();
1.800 albertel 3736: foreach my $line (split(/\&/,$answer)) {
3737: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3738: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3739: }
1.75 www 3740: my $version;
3741: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3742: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3743: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3744: }
1.75 www 3745: }
1.13 www 3746: return %returnhash;
1.34 www 3747: }
3748:
3749: # ---------------------------------------------------------- Course Description
3750:
3751: sub coursedescription {
1.731 albertel 3752: my ($courseid,$args)=@_;
1.34 www 3753: $courseid=~s/^\///;
1.49 www 3754: $courseid=~s/\_/\//g;
1.34 www 3755: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3756: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3757: my $normalid=$cdomain.'_'.$cnum;
3758: # need to always cache even if we get errors otherwise we keep
3759: # trying and trying and trying to get the course description.
3760: my %envhash=();
3761: my %returnhash=();
1.731 albertel 3762:
3763: my $expiretime=600;
3764: if ($env{'request.course.id'} eq $normalid) {
3765: $expiretime=120;
3766: }
3767:
3768: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3769: if (!$args->{'freshen_cache'}
3770: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3771: foreach my $key (keys(%env)) {
3772: next if ($key !~ /^\Q$prefix\E(.*)/);
3773: my ($setting) = $1;
3774: $returnhash{$setting} = $env{$key};
3775: }
3776: return %returnhash;
3777: }
3778:
3779: # get the data agin
3780: if (!$args->{'one_time'}) {
3781: $envhash{'course.'.$normalid.'.last_cache'}=time;
3782: }
1.811 albertel 3783:
1.34 www 3784: if ($chome ne 'no_host') {
1.302 albertel 3785: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3786: if (!exists($returnhash{'con_lost'})) {
3787: $returnhash{'home'}= $chome;
3788: $returnhash{'domain'} = $cdomain;
3789: $returnhash{'num'} = $cnum;
1.741 raeburn 3790: if (!defined($returnhash{'type'})) {
3791: $returnhash{'type'} = 'Course';
3792: }
1.130 albertel 3793: while (my ($name,$value) = each %returnhash) {
1.53 www 3794: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3795: }
1.270 www 3796: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3797: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3798: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3799: $envhash{'course.'.$normalid.'.home'}=$chome;
3800: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3801: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3802: }
3803: }
1.731 albertel 3804: if (!$args->{'one_time'}) {
1.949 raeburn 3805: &appenv(\%envhash);
1.731 albertel 3806: }
1.302 albertel 3807: return %returnhash;
1.461 www 3808: }
3809:
3810: # -------------------------------------------------See if a user is privileged
3811:
3812: sub privileged {
3813: my ($username,$domain)=@_;
3814: my $rolesdump=&reply("dump:$domain:$username:roles",
3815: &homeserver($username,$domain));
1.1033 raeburn 3816: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3817: ($rolesdump =~ /^error:/)) {
3818: return 0;
3819: }
1.461 www 3820: my $now=time;
3821: if ($rolesdump ne '') {
1.800 albertel 3822: foreach my $entry (split(/&/,$rolesdump)) {
3823: if ($entry!~/^rolesdef_/) {
3824: my ($area,$role)=split(/=/,$entry);
1.461 www 3825: $area=~s/\_\w\w$//;
3826: my ($trole,$tend,$tstart)=split(/_/,$role);
3827: if (($trole eq 'dc') || ($trole eq 'su')) {
3828: my $active=1;
3829: if ($tend) {
3830: if ($tend<$now) { $active=0; }
3831: }
3832: if ($tstart) {
3833: if ($tstart>$now) { $active=0; }
3834: }
3835: if ($active) { return 1; }
3836: }
3837: }
3838: }
3839: }
3840: return 0;
1.9 www 3841: }
1.1 albertel 3842:
1.103 harris41 3843: # -------------------------------------------------------- Get user privileges
1.11 www 3844:
3845: sub rolesinit {
3846: my ($domain,$username,$authhost)=@_;
1.1034 raeburn 3847: my $now=time;
3848: my %userroles = ('user.login.time' => $now);
1.11 www 3849: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.1033 raeburn 3850: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3851: ($rolesdump =~ /^error:/)) {
3852: return \%userroles;
3853: }
1.11 www 3854: my %allroles=();
1.678 raeburn 3855: my %allgroups=();
3856: my $group_privs;
1.11 www 3857:
3858: if ($rolesdump ne '') {
1.800 albertel 3859: foreach my $entry (split(/&/,$rolesdump)) {
3860: if ($entry!~/^rolesdef_/) {
3861: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3862: $area=~s/\_\w\w$//;
1.678 raeburn 3863: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3864: if ($role=~/^cr/) {
1.807 albertel 3865: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3866: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3867: ($tend,$tstart)=split('_',$trest);
3868: } else {
3869: $trole=$role;
3870: }
1.678 raeburn 3871: } elsif ($role =~ m|^gr/|) {
3872: ($trole,$tend,$tstart) = split(/_/,$role);
3873: ($trole,$group_privs) = split(/\//,$trole);
3874: $group_privs = &unescape($group_privs);
1.587 albertel 3875: } else {
3876: ($trole,$tend,$tstart)=split(/_/,$role);
3877: }
1.743 albertel 3878: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3879: $username);
3880: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3881: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3882: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3883: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3884: my $spec=$trole.'.'.$area;
3885: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3886: if ($trole =~ /^cr\//) {
1.567 raeburn 3887: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3888: } elsif ($trole eq 'gr') {
3889: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3890: } else {
1.567 raeburn 3891: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3892: }
1.12 www 3893: }
1.662 raeburn 3894: }
1.191 harris41 3895: }
1.743 albertel 3896: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3897: $userroles{'user.adv'} = $adv;
3898: $userroles{'user.author'} = $author;
1.620 albertel 3899: $env{'user.adv'}=$adv;
1.11 www 3900: }
1.743 albertel 3901: return \%userroles;
1.11 www 3902: }
3903:
1.567 raeburn 3904: sub set_arearole {
3905: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3906: # log the associated role with the area
3907: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3908: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3909: }
3910:
3911: sub custom_roleprivs {
3912: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3913: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3914: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3915: if (&hostname($homsvr) ne '') {
1.567 raeburn 3916: my ($rdummy,$roledef)=
3917: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3918: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3919: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3920: if (defined($syspriv)) {
1.1043 raeburn 3921: if ($trest =~ /^$match_community$/) {
3922: $syspriv =~ s/bre\&S//;
3923: }
1.567 raeburn 3924: $$allroles{'cm./'}.=':'.$syspriv;
3925: $$allroles{$spec.'./'}.=':'.$syspriv;
3926: }
3927: if ($tdomain ne '') {
3928: if (defined($dompriv)) {
3929: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3930: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3931: }
3932: if (($trest ne '') && (defined($coursepriv))) {
3933: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3934: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3935: }
3936: }
3937: }
3938: }
3939: }
3940:
1.678 raeburn 3941: sub group_roleprivs {
3942: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3943: my $access = 1;
3944: my $now = time;
3945: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3946: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3947: if ($access) {
1.811 albertel 3948: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 3949: $$allgroups{$course}{$group} .=':'.$group_privs;
3950: }
3951: }
1.567 raeburn 3952:
3953: sub standard_roleprivs {
3954: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3955: if (defined($pr{$trole.':s'})) {
3956: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3957: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3958: }
3959: if ($tdomain ne '') {
3960: if (defined($pr{$trole.':d'})) {
3961: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3962: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3963: }
3964: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3965: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3966: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3967: }
3968: }
3969: }
3970:
3971: sub set_userprivs {
1.678 raeburn 3972: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 3973: my $author=0;
3974: my $adv=0;
1.678 raeburn 3975: my %grouproles = ();
3976: if (keys(%{$allgroups}) > 0) {
1.1000 raeburn 3977: foreach my $role (keys(%{$allroles})) {
1.681 raeburn 3978: my ($trole,$area,$sec,$extendedarea);
1.881 raeburn 3979: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
1.678 raeburn 3980: $trole = $1;
3981: $area = $2;
1.681 raeburn 3982: $sec = $3;
3983: $extendedarea = $area.$sec;
3984: if (exists($$allgroups{$area})) {
3985: foreach my $group (keys(%{$$allgroups{$area}})) {
3986: my $spec = $trole.'.'.$extendedarea;
3987: $grouproles{$spec.'.'.$area.'/'.$group} =
3988: $$allgroups{$area}{$group};
1.678 raeburn 3989: }
3990: }
3991: }
3992: }
3993: }
1.800 albertel 3994: foreach my $group (keys(%grouproles)) {
3995: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 3996: }
1.800 albertel 3997: foreach my $role (keys(%{$allroles})) {
3998: my %thesepriv;
1.941 raeburn 3999: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 4000: foreach my $item (split(/:/,$$allroles{$role})) {
4001: if ($item ne '') {
4002: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 4003: if ($restrictions eq '') {
4004: $thesepriv{$privilege}='F';
4005: } elsif ($thesepriv{$privilege} ne 'F') {
4006: $thesepriv{$privilege}.=$restrictions;
4007: }
4008: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4009: }
4010: }
4011: my $thesestr='';
1.800 albertel 4012: foreach my $priv (keys(%thesepriv)) {
4013: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4014: }
4015: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 4016: }
4017: return ($author,$adv);
4018: }
4019:
1.994 raeburn 4020: sub role_status {
1.1002 raeburn 4021: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 4022: my @pwhere = ();
4023: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4024: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4025: unless (!defined($$role) || $$role eq '') {
4026: $$where=join('.',@pwhere);
4027: $$trolecode=$$role.'.'.$$where;
4028: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4029: $$tstatus='is';
4030: if ($$tstart && $$tstart>$then) {
4031: $$tstatus='future';
1.1034 raeburn 4032: if ($$tstart<$now) {
4033: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 4034: if (($$where ne '') && ($$role ne '')) {
4035: my (%allroles,%allgroups,$group_privs);
4036: my %userroles = (
4037: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4038: );
4039: my $spec=$$role.'.'.$$where;
4040: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4041: if ($$role =~ /^cr\//) {
4042: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4043: } elsif ($$role eq 'gr') {
4044: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4045: $env{'user.name'});
4046: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
4047: (undef,my $group_privs) = split(/\//,$trole);
4048: $group_privs = &unescape($group_privs);
4049: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4050: } else {
4051: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4052: }
4053: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
4054: &appenv(\%userroles,[$$role,'cm']);
4055: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4056: }
4057: }
1.1034 raeburn 4058: $$tstatus = 'is';
1.1002 raeburn 4059: }
1.994 raeburn 4060: }
4061: if ($$tend) {
4062: if ($$tend<$then) {
4063: $$tstatus='expired';
4064: } elsif ($$tend<$now) {
4065: $$tstatus='will_not';
4066: }
4067: }
4068: }
4069: }
4070: }
4071:
1.1048.2.2! raeburn 4072: sub curr_role_status {
! 4073: my ($start,$end,$refresh,$then) = @_;
! 4074: if (($start) && ($start<0)) { return 'deleted' };
! 4075: my $status = 'active';
! 4076: if (($end) && ($end<=$then)) {
! 4077: $status = 'previous';
! 4078: }
! 4079: if (($start) && ($refresh<$start)) {
! 4080: $status = 'future';
! 4081: }
! 4082: return $status;
! 4083: }
! 4084:
! 4085: sub gather_roleprivs {
! 4086: my ($allroles,$allgroups,$userroles,$area,$role,$tstart,$tend) = @_;
! 4087: return unless ((ref($allroles) eq 'HASH') && (ref($allgroups) eq 'HASH') && (ref($userroles) eq 'HASH'));
! 4088: if (($area ne '') && ($role ne '')) {
! 4089: my $spec = $role.'.'.$area;
! 4090: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
! 4091: if ($role =~ /^cr\//) {
! 4092: &custom_roleprivs($allroles,$role,$tdomain,$trest,$spec,$area);
! 4093: } elsif ($role eq 'gr') {
! 4094: my %rolehash = &get('roles',[$area.'_'.$role],$env{'user.domain'},
! 4095: $env{'user.name'});
! 4096: my $trole = split('_',$rolehash{$area.'_'.$role},1);
! 4097: (undef,my $group_privs) = split(/\//,$trole);
! 4098: $group_privs = &unescape($group_privs);
! 4099: &group_roleprivs($allgroups,$area,$group_privs,$tend,$tstart);
! 4100: } else {
! 4101: &standard_roleprivs($allroles,$role,$tdomain,$spec,$trest,$area);
! 4102: }
! 4103: }
! 4104: return;
! 4105: }
! 4106:
1.994 raeburn 4107: sub check_adhoc_privs {
1.1002 raeburn 4108: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994 raeburn 4109: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4110: if ($env{$cckey}) {
4111: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002 raeburn 4112: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 4113: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4114: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4115: }
4116: } else {
4117: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4118: }
4119: }
4120:
4121: sub set_adhoc_privileges {
4122: # role can be cc or ca
4123: my ($dcdom,$pickedcourse,$role) = @_;
4124: my $area = '/'.$dcdom.'/'.$pickedcourse;
4125: my $spec = $role.'.'.$area;
4126: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4127: $env{'user.name'});
4128: my %ccrole = ();
4129: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4130: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4131: &appenv(\%userroles,[$role,'cm']);
4132: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4133: &appenv( {'request.role' => $spec,
4134: 'request.role.domain' => $dcdom,
4135: 'request.course.sec' => ''
4136: }
4137: );
4138: my $tadv=0;
4139: if (&allowed('adv') eq 'F') { $tadv=1; }
4140: &appenv({'request.role.adv' => $tadv});
4141: }
4142:
1.12 www 4143: # --------------------------------------------------------------- get interface
4144:
4145: sub get {
1.131 albertel 4146: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4147: my $items='';
1.800 albertel 4148: foreach my $item (@$storearr) {
4149: $items.=&escape($item).'&';
1.191 harris41 4150: }
1.12 www 4151: $items=~s/\&$//;
1.620 albertel 4152: if (!$udomain) { $udomain=$env{'user.domain'}; }
4153: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 4154: my $uhome=&homeserver($uname,$udomain);
4155:
1.133 albertel 4156: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4157: my @pairs=split(/\&/,$rep);
1.273 albertel 4158: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4159: return @pairs;
4160: }
1.15 www 4161: my %returnhash=();
1.42 www 4162: my $i=0;
1.800 albertel 4163: foreach my $item (@$storearr) {
4164: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4165: $i++;
1.191 harris41 4166: }
1.15 www 4167: return %returnhash;
1.27 www 4168: }
4169:
4170: # --------------------------------------------------------------- del interface
4171:
4172: sub del {
1.133 albertel 4173: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 4174: my $items='';
1.800 albertel 4175: foreach my $item (@$storearr) {
4176: $items.=&escape($item).'&';
1.191 harris41 4177: }
1.984 neumanie 4178:
1.27 www 4179: $items=~s/\&$//;
1.620 albertel 4180: if (!$udomain) { $udomain=$env{'user.domain'}; }
4181: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4182: my $uhome=&homeserver($uname,$udomain);
4183: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4184: }
4185:
4186: # -------------------------------------------------------------- dump interface
4187:
4188: sub dump {
1.755 albertel 4189: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4190: if (!$udomain) { $udomain=$env{'user.domain'}; }
4191: if (!$uname) { $uname=$env{'user.name'}; }
4192: my $uhome=&homeserver($uname,$udomain);
4193: if ($regexp) {
4194: $regexp=&escape($regexp);
4195: } else {
4196: $regexp='.';
4197: }
4198: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4199: my @pairs=split(/\&/,$rep);
4200: my %returnhash=();
4201: foreach my $item (@pairs) {
4202: my ($key,$value)=split(/=/,$item,2);
4203: $key = &unescape($key);
4204: next if ($key =~ /^error: 2 /);
4205: $returnhash{$key}=&thaw_unescape($value);
4206: }
4207: return %returnhash;
1.407 www 4208: }
4209:
1.717 albertel 4210: # --------------------------------------------------------- dumpstore interface
4211:
4212: sub dumpstore {
4213: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 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: next if ($key =~ /^error: 2 /);
4228: $returnhash{$key}=&thaw_unescape($value);
4229: }
4230: return %returnhash;
1.717 albertel 4231: }
4232:
1.407 www 4233: # -------------------------------------------------------------- keys interface
4234:
4235: sub getkeys {
4236: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 4237: if (!$udomain) { $udomain=$env{'user.domain'}; }
4238: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 4239: my $uhome=&homeserver($uname,$udomain);
4240: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4241: my @keyarray=();
1.800 albertel 4242: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 4243: next if ($key =~ /^error: 2 /);
1.800 albertel 4244: push(@keyarray,&unescape($key));
1.407 www 4245: }
4246: return @keyarray;
1.318 matthew 4247: }
4248:
1.319 matthew 4249: # --------------------------------------------------------------- currentdump
4250: sub currentdump {
1.328 matthew 4251: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 4252: $courseid = $env{'request.course.id'} if (! defined($courseid));
4253: $sdom = $env{'user.domain'} if (! defined($sdom));
4254: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 4255: my $uhome = &homeserver($sname,$sdom);
4256: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 4257: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 4258: #
1.318 matthew 4259: my %returnhash=();
1.319 matthew 4260: #
4261: if ($rep eq "unknown_cmd") {
4262: # an old lond will not know currentdump
4263: # Do a dump and make it look like a currentdump
1.822 albertel 4264: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 4265: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4266: my %hash = @tmp;
4267: @tmp=();
1.424 matthew 4268: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 4269: } else {
4270: my @pairs=split(/\&/,$rep);
1.800 albertel 4271: foreach my $pair (@pairs) {
4272: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 4273: my ($symb,$param) = split(/:/,$key);
4274: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 4275: &thaw_unescape($value);
1.319 matthew 4276: }
1.191 harris41 4277: }
1.12 www 4278: return %returnhash;
1.424 matthew 4279: }
4280:
4281: sub convert_dump_to_currentdump{
4282: my %hash = %{shift()};
4283: my %returnhash;
4284: # Code ripped from lond, essentially. The only difference
4285: # here is the unescaping done by lonnet::dump(). Conceivably
4286: # we might run in to problems with parameter names =~ /^v\./
4287: while (my ($key,$value) = each(%hash)) {
4288: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 4289: $symb = &unescape($symb);
4290: $param = &unescape($param);
1.424 matthew 4291: next if ($v eq 'version' || $symb eq 'keys');
4292: next if (exists($returnhash{$symb}) &&
4293: exists($returnhash{$symb}->{$param}) &&
4294: $returnhash{$symb}->{'v.'.$param} > $v);
4295: $returnhash{$symb}->{$param}=$value;
4296: $returnhash{$symb}->{'v.'.$param}=$v;
4297: }
4298: #
4299: # Remove all of the keys in the hashes which keep track of
4300: # the version of the parameter.
4301: while (my ($symb,$param_hash) = each(%returnhash)) {
4302: # use a foreach because we are going to delete from the hash.
4303: foreach my $key (keys(%$param_hash)) {
4304: delete($param_hash->{$key}) if ($key =~ /^v\./);
4305: }
4306: }
4307: return \%returnhash;
1.12 www 4308: }
4309:
1.627 albertel 4310: # ------------------------------------------------------ critical inc interface
4311:
4312: sub cinc {
4313: return &inc(@_,'critical');
4314: }
4315:
1.449 matthew 4316: # --------------------------------------------------------------- inc interface
4317:
4318: sub inc {
1.627 albertel 4319: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 4320: if (!$udomain) { $udomain=$env{'user.domain'}; }
4321: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 4322: my $uhome=&homeserver($uname,$udomain);
4323: my $items='';
4324: if (! ref($store)) {
4325: # got a single value, so use that instead
4326: $items = &escape($store).'=&';
4327: } elsif (ref($store) eq 'SCALAR') {
4328: $items = &escape($$store).'=&';
4329: } elsif (ref($store) eq 'ARRAY') {
4330: $items = join('=&',map {&escape($_);} @{$store});
4331: } elsif (ref($store) eq 'HASH') {
4332: while (my($key,$value) = each(%{$store})) {
4333: $items.= &escape($key).'='.&escape($value).'&';
4334: }
4335: }
4336: $items=~s/\&$//;
1.627 albertel 4337: if ($critical) {
4338: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4339: } else {
4340: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4341: }
1.449 matthew 4342: }
4343:
1.12 www 4344: # --------------------------------------------------------------- put interface
4345:
4346: sub put {
1.134 albertel 4347: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4348: if (!$udomain) { $udomain=$env{'user.domain'}; }
4349: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4350: my $uhome=&homeserver($uname,$udomain);
1.12 www 4351: my $items='';
1.800 albertel 4352: foreach my $item (keys(%$storehash)) {
4353: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4354: }
1.12 www 4355: $items=~s/\&$//;
1.134 albertel 4356: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 4357: }
4358:
1.631 albertel 4359: # ------------------------------------------------------------ newput interface
4360:
4361: sub newput {
4362: my ($namespace,$storehash,$udomain,$uname)=@_;
4363: if (!$udomain) { $udomain=$env{'user.domain'}; }
4364: if (!$uname) { $uname=$env{'user.name'}; }
4365: my $uhome=&homeserver($uname,$udomain);
4366: my $items='';
4367: foreach my $key (keys(%$storehash)) {
4368: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4369: }
4370: $items=~s/\&$//;
4371: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4372: }
4373:
4374: # --------------------------------------------------------- putstore interface
4375:
1.524 raeburn 4376: sub putstore {
1.715 albertel 4377: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 4378: if (!$udomain) { $udomain=$env{'user.domain'}; }
4379: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 4380: my $uhome=&homeserver($uname,$udomain);
4381: my $items='';
1.715 albertel 4382: foreach my $key (keys(%$storehash)) {
4383: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 4384: }
1.715 albertel 4385: $items=~s/\&$//;
1.716 albertel 4386: my $esc_symb=&escape($symb);
4387: my $esc_v=&escape($version);
1.715 albertel 4388: my $reply =
1.716 albertel 4389: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 4390: $uhome);
4391: if ($reply eq 'unknown_cmd') {
1.716 albertel 4392: # gfall back to way things use to be done
1.715 albertel 4393: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4394: $uname);
1.524 raeburn 4395: }
1.715 albertel 4396: return $reply;
4397: }
4398:
4399: sub old_putstore {
1.716 albertel 4400: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4401: if (!$udomain) { $udomain=$env{'user.domain'}; }
4402: if (!$uname) { $uname=$env{'user.name'}; }
4403: my $uhome=&homeserver($uname,$udomain);
4404: my %newstorehash;
1.800 albertel 4405: foreach my $item (keys(%$storehash)) {
4406: my $key = $version.':'.&escape($symb).':'.$item;
4407: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 4408: }
4409: my $items='';
4410: my %allitems = ();
1.800 albertel 4411: foreach my $item (keys(%newstorehash)) {
4412: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 4413: my $key = $1.':keys:'.$2;
4414: $allitems{$key} .= $3.':';
4415: }
1.800 albertel 4416: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 4417: }
1.800 albertel 4418: foreach my $item (keys(%allitems)) {
4419: $allitems{$item} =~ s/\:$//;
4420: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 4421: }
4422: $items=~s/\&$//;
4423: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 4424: }
4425:
1.47 www 4426: # ------------------------------------------------------ critical put interface
4427:
4428: sub cput {
1.134 albertel 4429: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4430: if (!$udomain) { $udomain=$env{'user.domain'}; }
4431: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4432: my $uhome=&homeserver($uname,$udomain);
1.47 www 4433: my $items='';
1.800 albertel 4434: foreach my $item (keys(%$storehash)) {
4435: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4436: }
1.47 www 4437: $items=~s/\&$//;
1.134 albertel 4438: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4439: }
4440:
4441: # -------------------------------------------------------------- eget interface
4442:
4443: sub eget {
1.133 albertel 4444: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4445: my $items='';
1.800 albertel 4446: foreach my $item (@$storearr) {
4447: $items.=&escape($item).'&';
1.191 harris41 4448: }
1.12 www 4449: $items=~s/\&$//;
1.620 albertel 4450: if (!$udomain) { $udomain=$env{'user.domain'}; }
4451: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4452: my $uhome=&homeserver($uname,$udomain);
4453: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4454: my @pairs=split(/\&/,$rep);
4455: my %returnhash=();
1.42 www 4456: my $i=0;
1.800 albertel 4457: foreach my $item (@$storearr) {
4458: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4459: $i++;
1.191 harris41 4460: }
1.12 www 4461: return %returnhash;
4462: }
4463:
1.667 albertel 4464: # ------------------------------------------------------------ tmpput interface
4465: sub tmpput {
1.802 raeburn 4466: my ($storehash,$server,$context)=@_;
1.667 albertel 4467: my $items='';
1.800 albertel 4468: foreach my $item (keys(%$storehash)) {
4469: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 4470: }
4471: $items=~s/\&$//;
1.802 raeburn 4472: if (defined($context)) {
4473: $items .= ':'.&escape($context);
4474: }
1.667 albertel 4475: return &reply("tmpput:$items",$server);
4476: }
4477:
4478: # ------------------------------------------------------------ tmpget interface
4479: sub tmpget {
1.688 albertel 4480: my ($token,$server)=@_;
4481: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4482: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 4483: my %returnhash;
4484: foreach my $item (split(/\&/,$rep)) {
4485: my ($key,$value)=split(/=/,$item);
1.951 raeburn 4486: next if ($key =~ /^error: 2 /);
1.667 albertel 4487: $returnhash{&unescape($key)}=&thaw_unescape($value);
4488: }
4489: return %returnhash;
4490: }
4491:
1.688 albertel 4492: # ------------------------------------------------------------ tmpget interface
4493: sub tmpdel {
4494: my ($token,$server)=@_;
4495: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4496: return &reply("tmpdel:$token",$server);
4497: }
4498:
1.765 albertel 4499: # -------------------------------------------------- portfolio access checking
4500:
4501: sub portfolio_access {
1.766 albertel 4502: my ($requrl) = @_;
1.765 albertel 4503: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4504: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 4505: if ($result) {
4506: my %setters;
4507: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4508: my ($startblock,$endblock) =
4509: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4510: if ($startblock && $endblock) {
4511: return 'B';
4512: }
4513: } else {
4514: my ($startblock,$endblock) =
4515: &Apache::loncommon::blockcheck(\%setters,'port');
4516: if ($startblock && $endblock) {
4517: return 'B';
4518: }
4519: }
4520: }
1.765 albertel 4521: if ($result eq 'ok') {
1.766 albertel 4522: return 'F';
1.765 albertel 4523: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 4524: return 'A';
1.765 albertel 4525: }
1.766 albertel 4526: return '';
1.765 albertel 4527: }
4528:
4529: sub get_portfolio_access {
1.767 albertel 4530: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4531:
4532: if (!ref($access_hash)) {
4533: my $current_perms = &get_portfile_permissions($udom,$unum);
4534: my %access_controls = &get_access_controls($current_perms,$group,
4535: $file_name);
4536: $access_hash = $access_controls{$file_name};
4537: }
4538:
1.765 albertel 4539: my ($public,$guest,@domains,@users,@courses,@groups);
4540: my $now = time;
4541: if (ref($access_hash) eq 'HASH') {
4542: foreach my $key (keys(%{$access_hash})) {
4543: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4544: if ($start > $now) {
4545: next;
4546: }
4547: if ($end && $end<$now) {
4548: next;
4549: }
4550: if ($scope eq 'public') {
4551: $public = $key;
4552: last;
4553: } elsif ($scope eq 'guest') {
4554: $guest = $key;
4555: } elsif ($scope eq 'domains') {
4556: push(@domains,$key);
4557: } elsif ($scope eq 'users') {
4558: push(@users,$key);
4559: } elsif ($scope eq 'course') {
4560: push(@courses,$key);
4561: } elsif ($scope eq 'group') {
4562: push(@groups,$key);
4563: }
4564: }
4565: if ($public) {
4566: return 'ok';
4567: }
4568: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4569: if ($guest) {
4570: return $guest;
4571: }
4572: } else {
4573: if (@domains > 0) {
4574: foreach my $domkey (@domains) {
4575: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4576: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4577: return 'ok';
4578: }
4579: }
4580: }
4581: }
4582: if (@users > 0) {
4583: foreach my $userkey (@users) {
1.865 raeburn 4584: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4585: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4586: if (ref($item) eq 'HASH') {
4587: if (($item->{'uname'} eq $env{'user.name'}) &&
4588: ($item->{'udom'} eq $env{'user.domain'})) {
4589: return 'ok';
4590: }
4591: }
4592: }
4593: }
1.765 albertel 4594: }
4595: }
4596: my %roleshash;
4597: my @courses_and_groups = @courses;
4598: push(@courses_and_groups,@groups);
4599: if (@courses_and_groups > 0) {
4600: my (%allgroups,%allroles);
4601: my ($start,$end,$role,$sec,$group);
4602: foreach my $envkey (%env) {
1.811 albertel 4603: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4604: my $cid = $2.'_'.$3;
4605: if ($1 eq 'gr') {
4606: $group = $4;
4607: $allgroups{$cid}{$group} = $env{$envkey};
4608: } else {
4609: if ($4 eq '') {
4610: $sec = 'none';
4611: } else {
4612: $sec = $4;
4613: }
4614: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4615: }
1.811 albertel 4616: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4617: my $cid = $2.'_'.$3;
4618: if ($4 eq '') {
4619: $sec = 'none';
4620: } else {
4621: $sec = $4;
4622: }
4623: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4624: }
4625: }
4626: if (keys(%allroles) == 0) {
4627: return;
4628: }
4629: foreach my $key (@courses_and_groups) {
4630: my %content = %{$$access_hash{$key}};
4631: my $cnum = $content{'number'};
4632: my $cdom = $content{'domain'};
4633: my $cid = $cdom.'_'.$cnum;
4634: if (!exists($allroles{$cid})) {
4635: next;
4636: }
4637: foreach my $role_id (keys(%{$content{'roles'}})) {
4638: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4639: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4640: my @status = @{$content{'roles'}{$role_id}{'access'}};
4641: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4642: foreach my $role (keys(%{$allroles{$cid}})) {
4643: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4644: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4645: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4646: if (grep/^all$/,@sections) {
4647: return 'ok';
4648: } else {
4649: if (grep/^$sec$/,@sections) {
4650: return 'ok';
4651: }
4652: }
4653: }
4654: }
4655: if (keys(%{$allgroups{$cid}}) == 0) {
4656: if (grep/^none$/,@groups) {
4657: return 'ok';
4658: }
4659: } else {
4660: if (grep/^all$/,@groups) {
4661: return 'ok';
4662: }
4663: foreach my $group (keys(%{$allgroups{$cid}})) {
4664: if (grep/^$group$/,@groups) {
4665: return 'ok';
4666: }
4667: }
4668: }
4669: }
4670: }
4671: }
4672: }
4673: }
4674: if ($guest) {
4675: return $guest;
4676: }
4677: }
4678: }
4679: return;
4680: }
4681:
4682: sub course_group_datechecker {
4683: my ($dates,$now,$status) = @_;
4684: my ($start,$end) = split(/\./,$dates);
4685: if (!$start && !$end) {
4686: return 'ok';
4687: }
4688: if (grep/^active$/,@{$status}) {
4689: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4690: return 'ok';
4691: }
4692: }
4693: if (grep/^previous$/,@{$status}) {
4694: if ($end > $now ) {
4695: return 'ok';
4696: }
4697: }
4698: if (grep/^future$/,@{$status}) {
4699: if ($start > $now) {
4700: return 'ok';
4701: }
4702: }
4703: return;
4704: }
4705:
4706: sub parse_portfolio_url {
4707: my ($url) = @_;
4708:
4709: my ($type,$udom,$unum,$group,$file_name);
4710:
1.823 albertel 4711: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4712: $type = 1;
4713: $udom = $1;
4714: $unum = $2;
4715: $file_name = $3;
1.823 albertel 4716: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4717: $type = 2;
4718: $udom = $1;
4719: $unum = $2;
4720: $group = $3;
4721: $file_name = $3.'/'.$4;
4722: }
4723: if (wantarray) {
4724: return ($type,$udom,$unum,$file_name,$group);
4725: }
4726: return $type;
4727: }
4728:
4729: sub is_portfolio_url {
4730: my ($url) = @_;
4731: return scalar(&parse_portfolio_url($url));
4732: }
4733:
1.798 raeburn 4734: sub is_portfolio_file {
4735: my ($file) = @_;
1.820 raeburn 4736: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4737: return 1;
4738: }
4739: return;
4740: }
4741:
1.976 raeburn 4742: sub usertools_access {
1.985 raeburn 4743: my ($uname,$udom,$tool,$action,$context) = @_;
4744: my ($access,%tools);
4745: if ($context eq '') {
4746: $context = 'tools';
4747: }
4748: if ($context eq 'requestcourses') {
4749: %tools = (
4750: official => 1,
4751: unofficial => 1,
1.1006 raeburn 4752: community => 1,
1.985 raeburn 4753: );
4754: } else {
4755: %tools = (
4756: aboutme => 1,
4757: blog => 1,
4758: portfolio => 1,
4759: );
4760: }
1.976 raeburn 4761: return if (!defined($tools{$tool}));
4762:
4763: if ((!defined($udom)) || (!defined($uname))) {
4764: $udom = $env{'user.domain'};
4765: $uname = $env{'user.name'};
4766: }
4767:
1.978 raeburn 4768: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4769: if ($action ne 'reload') {
1.985 raeburn 4770: if ($context eq 'requestcourses') {
4771: return $env{'environment.canrequest.'.$tool};
4772: } else {
4773: return $env{'environment.availabletools.'.$tool};
4774: }
4775: }
1.976 raeburn 4776: }
4777:
4778: my ($toolstatus,$inststatus);
4779:
1.985 raeburn 4780: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4781: ($action ne 'reload')) {
4782: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 4783: $inststatus = $env{'environment.inststatus'};
4784: } else {
1.1025 raeburn 4785: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
1.985 raeburn 4786: $toolstatus = $userenv{$context.'.'.$tool};
1.976 raeburn 4787: $inststatus = $userenv{'inststatus'};
4788: }
4789:
4790: if ($toolstatus ne '') {
4791: if ($toolstatus) {
4792: $access = 1;
4793: } else {
4794: $access = 0;
4795: }
4796: return $access;
4797: }
4798:
4799: my $is_adv = &is_advanced_user($udom,$uname);
4800: my %domdef = &get_domain_defaults($udom);
4801: if (ref($domdef{$tool}) eq 'HASH') {
4802: if ($is_adv) {
4803: if ($domdef{$tool}{'_LC_adv'} ne '') {
4804: if ($domdef{$tool}{'_LC_adv'}) {
4805: $access = 1;
4806: } else {
4807: $access = 0;
4808: }
4809: return $access;
4810: }
4811: }
4812: if ($inststatus ne '') {
4813: my ($hasaccess,$hasnoaccess);
4814: foreach my $affiliation (split(/:/,$inststatus)) {
4815: if ($domdef{$tool}{$affiliation} ne '') {
4816: if ($domdef{$tool}{$affiliation}) {
4817: $hasaccess = 1;
4818: } else {
4819: $hasnoaccess = 1;
4820: }
4821: }
4822: }
4823: if ($hasaccess || $hasnoaccess) {
4824: if ($hasaccess) {
4825: $access = 1;
4826: } elsif ($hasnoaccess) {
4827: $access = 0;
4828: }
4829: return $access;
4830: }
4831: } else {
4832: if ($domdef{$tool}{'default'} ne '') {
4833: if ($domdef{$tool}{'default'}) {
4834: $access = 1;
4835: } elsif ($domdef{$tool}{'default'} == 0) {
4836: $access = 0;
4837: }
4838: return $access;
4839: }
4840: }
4841: } else {
1.985 raeburn 4842: if ($context eq 'tools') {
4843: $access = 1;
4844: } else {
4845: $access = 0;
4846: }
1.976 raeburn 4847: return $access;
4848: }
4849: }
4850:
4851: sub is_advanced_user {
4852: my ($udom,$uname) = @_;
4853: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4854: my %allroles;
4855: my $is_adv;
4856: foreach my $role (keys(%roleshash)) {
4857: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4858: my $area = '/'.$tdomain.'/'.$trest;
4859: if ($sec ne '') {
4860: $area .= '/'.$sec;
4861: }
4862: if (($area ne '') && ($trole ne '')) {
4863: my $spec=$trole.'.'.$area;
4864: if ($trole =~ /^cr\//) {
4865: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4866: } elsif ($trole ne 'gr') {
4867: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4868: }
4869: }
4870: }
4871: foreach my $role (keys(%allroles)) {
4872: last if ($is_adv);
4873: foreach my $item (split(/:/,$allroles{$role})) {
4874: if ($item ne '') {
4875: my ($privilege,$restrictions)=split(/&/,$item);
4876: if ($privilege eq 'adv') {
4877: $is_adv = 1;
4878: last;
4879: }
4880: }
4881: }
4882: }
4883: return $is_adv;
4884: }
1.798 raeburn 4885:
1.1035 raeburn 4886: sub check_can_request {
1.1036 raeburn 4887: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 4888: my $canreq = 0;
4889: my ($types,$typename) = &Apache::loncommon::course_types();
4890: my @options = ('approval','validate','autolimit');
4891: my $optregex = join('|',@options);
4892: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4893: foreach my $type (@{$types}) {
4894: if (&usertools_access($env{'user.name'},
4895: $env{'user.domain'},
4896: $type,undef,'requestcourses')) {
4897: $canreq ++;
1.1036 raeburn 4898: if (ref($request_domains) eq 'HASH') {
4899: push(@{$request_domains->{$type}},$env{'user.domain'});
4900: }
1.1035 raeburn 4901: if ($dom eq $env{'user.domain'}) {
4902: $can_request->{$type} = 1;
4903: }
4904: }
4905: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4906: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4907: if (@curr > 0) {
1.1036 raeburn 4908: foreach my $item (@curr) {
4909: if (ref($request_domains) eq 'HASH') {
4910: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4911: if ($otherdom ne '') {
4912: if (ref($request_domains->{$type}) eq 'ARRAY') {
4913: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4914: push(@{$request_domains->{$type}},$otherdom);
4915: }
4916: } else {
4917: push(@{$request_domains->{$type}},$otherdom);
4918: }
4919: }
4920: }
4921: }
4922: unless($dom eq $env{'user.domain'}) {
4923: $canreq ++;
1.1035 raeburn 4924: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4925: $can_request->{$type} = 1;
4926: }
4927: }
4928: }
4929: }
4930: }
4931: }
4932: return $canreq;
4933: }
4934:
1.341 www 4935: # ---------------------------------------------- Custom access rule evaluation
4936:
4937: sub customaccess {
4938: my ($priv,$uri)=@_;
1.807 albertel 4939: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 4940: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 4941: $udom = &LONCAPA::clean_domain($udom);
4942: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 4943: my $access=0;
1.800 albertel 4944: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 4945: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4946: if ($type eq 'user') {
4947: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 4948: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 4949: if ($tdom) {
4950: if ($tdom ne $env{'user.domain'}) { next; }
4951: }
1.896 albertel 4952: if ($tuname) {
4953: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 4954: }
4955: $access=($effect eq 'allow');
4956: last;
4957: }
4958: } else {
4959: if ($role) {
4960: if ($role ne $urole) { next; }
4961: }
4962: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4963: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4964: if ($tdom) {
4965: if ($tdom ne $udom) { next; }
4966: }
4967: if ($tcrs) {
4968: if ($tcrs ne $ucrs) { next; }
4969: }
4970: if ($tsec) {
4971: if ($tsec ne $usec) { next; }
4972: }
4973: $access=($effect eq 'allow');
4974: last;
4975: }
4976: if ($realm eq '' && $role eq '') {
4977: $access=($effect eq 'allow');
4978: }
1.402 bowersj2 4979: }
1.341 www 4980: }
4981: return $access;
4982: }
4983:
1.103 harris41 4984: # ------------------------------------------------- Check for a user privilege
1.12 www 4985:
4986: sub allowed {
1.810 raeburn 4987: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 4988: my $ver_orguri=$uri;
1.439 www 4989: $uri=&deversion($uri);
1.152 www 4990: my $orguri=$uri;
1.52 www 4991: $uri=&declutter($uri);
1.809 raeburn 4992:
1.810 raeburn 4993: if ($priv eq 'evb') {
4994: # Evade communication block restrictions for specified role in a course
4995: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4996: return $1;
4997: } else {
4998: return;
4999: }
5000: }
5001:
1.620 albertel 5002: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 5003: # Free bre access to adm and meta resources
1.775 albertel 5004: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 5005: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5006: && ($priv eq 'bre')) {
1.14 www 5007: return 'F';
1.159 www 5008: }
5009:
1.545 banghart 5010: # Free bre access to user's own portfolio contents
1.714 raeburn 5011: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 5012: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 5013: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 5014: my %setters;
5015: my ($startblock,$endblock) =
5016: &Apache::loncommon::blockcheck(\%setters,'port');
5017: if ($startblock && $endblock) {
5018: return 'B';
5019: } else {
5020: return 'F';
5021: }
1.545 banghart 5022: }
5023:
1.762 raeburn 5024: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 5025: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5026: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5027: if (exists($env{'request.course.id'})) {
5028: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5029: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5030: if (($domain eq $cdom) && ($name eq $cnum)) {
5031: my $courseprivid=$env{'request.course.id'};
5032: $courseprivid=~s/\_/\//;
5033: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5034: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5035: return $1;
1.762 raeburn 5036: } else {
5037: if ($env{'request.course.sec'}) {
5038: $courseprivid.='/'.$env{'request.course.sec'};
5039: }
5040: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5041: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5042: return $2;
5043: }
1.714 raeburn 5044: }
5045: }
5046: }
5047: }
5048:
1.159 www 5049: # Free bre to public access
5050:
5051: if ($priv eq 'bre') {
1.238 www 5052: my $copyright=&metadata($uri,'copyright');
1.620 albertel 5053: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 5054: return 'F';
5055: }
1.238 www 5056: if ($copyright eq 'priv') {
5057: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5058: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 5059: return '';
5060: }
5061: }
5062: if ($copyright eq 'domain') {
5063: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5064: unless (($env{'user.domain'} eq $1) ||
5065: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 5066: return '';
5067: }
1.262 matthew 5068: }
1.620 albertel 5069: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 5070: # Library role, so allow browsing of resources in this domain.
5071: return 'F';
1.238 www 5072: }
1.341 www 5073: if ($copyright eq 'custom') {
5074: unless (&customaccess($priv,$uri)) { return ''; }
5075: }
1.14 www 5076: }
1.264 matthew 5077: # Domain coordinator is trying to create a course
1.620 albertel 5078: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 5079: # uri is the requested domain in this case.
5080: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 5081: # a role of dc for the domain in question.
1.620 albertel 5082: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 5083: }
1.29 www 5084:
1.52 www 5085: my $thisallowed='';
5086: my $statecond=0;
5087: my $courseprivid='';
5088:
1.1039 raeburn 5089: my $ownaccess;
1.1043 raeburn 5090: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 5091: if (($priv eq 'bro') && ($env{'user.author'})) {
5092: if ($uri eq '') {
5093: $ownaccess = 1;
5094: } else {
5095: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5096: my $udom = $env{'user.domain'};
5097: my $uname = $env{'user.name'};
5098: if ($uri =~ m{^\Q$udom\E/?$}) {
5099: $ownaccess = 1;
1.1040 raeburn 5100: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 5101: unless ($uri =~ m{\.\./}) {
5102: $ownaccess = 1;
5103: }
5104: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5105: my $now = time;
5106: if ($uri =~ m{^([^/]+)/?$}) {
5107: my $adom = $1;
5108: foreach my $key (keys(%env)) {
1.1042 raeburn 5109: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 5110: my ($start,$end) = split('.',$env{$key});
5111: if (($now >= $start) && (!$end || $end < $now)) {
5112: $ownaccess = 1;
5113: last;
5114: }
5115: }
5116: }
5117: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5118: my $adom = $1;
5119: my $aname = $2;
1.1042 raeburn 5120: foreach my $role ('ca','aa') {
5121: if ($env{"user.role.$role./$adom/$aname"}) {
5122: my ($start,$end) =
5123: split('.',$env{"user.role.$role./$adom/$aname"});
5124: if (($now >= $start) && (!$end || $end < $now)) {
5125: $ownaccess = 1;
5126: last;
5127: }
1.1039 raeburn 5128: }
5129: }
5130: }
5131: }
5132: }
5133: }
5134: }
5135:
1.52 www 5136: # Course
5137:
1.620 albertel 5138: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5139: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5140: $thisallowed.=$1;
5141: }
1.52 www 5142: }
1.29 www 5143:
1.52 www 5144: # Domain
5145:
1.620 albertel 5146: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 5147: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5148: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5149: $thisallowed.=$1;
5150: }
1.12 www 5151: }
1.52 www 5152:
5153: # Course: uri itself is a course
1.66 www 5154: my $courseuri=$uri;
5155: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 5156: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 5157:
1.620 albertel 5158: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 5159: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5160: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5161: $thisallowed.=$1;
5162: }
1.12 www 5163: }
1.29 www 5164:
1.665 albertel 5165: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 5166: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 5167: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 5168: $thisallowed='';
1.671 raeburn 5169: my ($match)=&is_on_map($uri);
5170: if ($match) {
5171: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5172: =~/\Q$priv\E\&([^\:]*)/) {
5173: $thisallowed.=$1;
5174: }
5175: } else {
1.705 albertel 5176: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 5177: if ($refuri) {
5178: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 5179: $thisallowed='F';
1.671 raeburn 5180: } else {
5181: $refuri=&declutter($refuri);
5182: my ($match) = &is_on_map($refuri);
5183: if ($match) {
5184: $thisallowed='F';
5185: }
1.669 raeburn 5186: }
1.671 raeburn 5187: }
5188: }
1.314 www 5189: }
1.492 albertel 5190:
1.766 albertel 5191: if ($priv eq 'bre'
5192: && $thisallowed ne 'F'
5193: && $thisallowed ne '2'
5194: && &is_portfolio_url($uri)) {
5195: $thisallowed = &portfolio_access($uri);
5196: }
5197:
1.52 www 5198: # Full access at system, domain or course-wide level? Exit.
1.29 www 5199: if ($thisallowed=~/F/) {
5200: return 'F';
5201: }
5202:
1.52 www 5203: # If this is generating or modifying users, exit with special codes
1.29 www 5204:
1.643 www 5205: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5206: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 5207: my ($audom,$auname)=split('/',$uri);
1.643 www 5208: # no author name given, so this just checks on the general right to make a co-author in this domain
5209: unless ($auname) { return $thisallowed; }
5210: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 5211: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5212: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5213: ($audom ne $env{'request.role.domain'}))) { return ''; }
5214: }
1.52 www 5215: return $thisallowed;
5216: }
5217: #
1.103 harris41 5218: # Gathered so far: system, domain and course wide privileges
1.52 www 5219: #
5220: # Course: See if uri or referer is an individual resource that is part of
5221: # the course
5222:
1.620 albertel 5223: if ($env{'request.course.id'}) {
1.232 www 5224:
1.620 albertel 5225: $courseprivid=$env{'request.course.id'};
5226: if ($env{'request.course.sec'}) {
5227: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 5228: }
5229: $courseprivid=~s/\_/\//;
5230: my $checkreferer=1;
1.232 www 5231: my ($match,$cond)=&is_on_map($uri);
5232: if ($match) {
5233: $statecond=$cond;
1.620 albertel 5234: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5235: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5236: $thisallowed.=$1;
5237: $checkreferer=0;
5238: }
1.29 www 5239: }
1.83 www 5240:
1.148 www 5241: if ($checkreferer) {
1.620 albertel 5242: my $refuri=$env{'httpref.'.$orguri};
1.148 www 5243: unless ($refuri) {
1.800 albertel 5244: foreach my $key (keys(%env)) {
5245: if ($key=~/^httpref\..*\*/) {
5246: my $pattern=$key;
1.156 www 5247: $pattern=~s/^httpref\.\/res\///;
1.148 www 5248: $pattern=~s/\*/\[\^\/\]\+/g;
5249: $pattern=~s/\//\\\//g;
1.152 www 5250: if ($orguri=~/$pattern/) {
1.800 albertel 5251: $refuri=$env{$key};
1.148 www 5252: }
5253: }
1.191 harris41 5254: }
1.148 www 5255: }
1.232 www 5256:
1.148 www 5257: if ($refuri) {
1.152 www 5258: $refuri=&declutter($refuri);
1.232 www 5259: my ($match,$cond)=&is_on_map($refuri);
5260: if ($match) {
5261: my $refstatecond=$cond;
1.620 albertel 5262: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5263: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5264: $thisallowed.=$1;
1.53 www 5265: $uri=$refuri;
5266: $statecond=$refstatecond;
1.52 www 5267: }
5268: }
1.148 www 5269: }
1.29 www 5270: }
1.52 www 5271: }
1.29 www 5272:
1.52 www 5273: #
1.103 harris41 5274: # Gathered now: all privileges that could apply, and condition number
1.52 www 5275: #
5276: #
5277: # Full or no access?
5278: #
1.29 www 5279:
1.52 www 5280: if ($thisallowed=~/F/) {
5281: return 'F';
5282: }
1.29 www 5283:
1.52 www 5284: unless ($thisallowed) {
5285: return '';
5286: }
1.29 www 5287:
1.52 www 5288: # Restrictions exist, deal with them
5289: #
5290: # C:according to course preferences
5291: # R:according to resource settings
5292: # L:unless locked
5293: # X:according to user session state
5294: #
5295:
5296: # Possibly locked functionality, check all courses
1.54 www 5297: # Locks might take effect only after 10 minutes cache expiration for other
5298: # courses, and 2 minutes for current course
1.52 www 5299:
5300: my $envkey;
5301: if ($thisallowed=~/L/) {
1.1000 raeburn 5302: foreach $envkey (keys(%env)) {
1.54 www 5303: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5304: my $courseid=$2;
5305: my $roleid=$1.'.'.$2;
1.92 www 5306: $courseid=~s/^\///;
1.54 www 5307: my $expiretime=600;
1.620 albertel 5308: if ($env{'request.role'} eq $roleid) {
1.54 www 5309: $expiretime=120;
5310: }
5311: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5312: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 5313: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 5314: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 5315: }
1.620 albertel 5316: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5317: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5318: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5319: &log($env{'user.domain'},$env{'user.name'},
5320: $env{'user.home'},
1.57 www 5321: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 5322: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5323: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5324: return '';
5325: }
5326: }
1.620 albertel 5327: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5328: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5329: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5330: &log($env{'user.domain'},$env{'user.name'},
5331: $env{'user.home'},
1.57 www 5332: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 5333: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5334: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5335: return '';
5336: }
5337: }
5338: }
1.29 www 5339: }
1.52 www 5340: }
5341:
5342: #
5343: # Rest of the restrictions depend on selected course
5344: #
5345:
1.620 albertel 5346: unless ($env{'request.course.id'}) {
1.766 albertel 5347: if ($thisallowed eq 'A') {
5348: return 'A';
1.814 raeburn 5349: } elsif ($thisallowed eq 'B') {
5350: return 'B';
1.766 albertel 5351: } else {
5352: return '1';
5353: }
1.52 www 5354: }
1.29 www 5355:
1.52 www 5356: #
5357: # Now user is definitely in a course
5358: #
1.53 www 5359:
5360:
5361: # Course preferences
5362:
5363: if ($thisallowed=~/C/) {
1.620 albertel 5364: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5365: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5366: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 5367: =~/\Q$rolecode\E/) {
1.689 albertel 5368: if ($priv ne 'pch') {
5369: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5370: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5371: $env{'request.course.id'});
5372: }
1.237 www 5373: return '';
5374: }
5375:
1.620 albertel 5376: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 5377: =~/\Q$unamedom\E/) {
1.689 albertel 5378: if ($priv ne 'pch') {
5379: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5380: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5381: $env{'request.course.id'});
5382: }
1.54 www 5383: return '';
5384: }
1.53 www 5385: }
5386:
5387: # Resource preferences
5388:
5389: if ($thisallowed=~/R/) {
1.620 albertel 5390: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 5391: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 5392: if ($priv ne 'pch') {
5393: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5394: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5395: }
5396: return '';
1.54 www 5397: }
1.53 www 5398: }
1.30 www 5399:
1.246 www 5400: # Restricted by state or randomout?
1.30 www 5401:
1.52 www 5402: if ($thisallowed=~/X/) {
1.620 albertel 5403: if ($env{'acc.randomout'}) {
1.579 albertel 5404: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 5405: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 5406: return '';
5407: }
1.247 www 5408: }
5409: if (&condval($statecond)) {
1.52 www 5410: return '2';
5411: } else {
5412: return '';
5413: }
5414: }
1.30 www 5415:
1.766 albertel 5416: if ($thisallowed eq 'A') {
5417: return 'A';
1.814 raeburn 5418: } elsif ($thisallowed eq 'B') {
5419: return 'B';
1.766 albertel 5420: }
1.52 www 5421: return 'F';
1.232 www 5422: }
5423:
1.710 albertel 5424: sub split_uri_for_cond {
5425: my $uri=&deversion(&declutter(shift));
5426: my @uriparts=split(/\//,$uri);
5427: my $filename=pop(@uriparts);
5428: my $pathname=join('/',@uriparts);
5429: return ($pathname,$filename);
5430: }
1.232 www 5431: # --------------------------------------------------- Is a resource on the map?
5432:
5433: sub is_on_map {
1.710 albertel 5434: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 5435: #Trying to find the conditional for the file
1.620 albertel 5436: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 5437: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 5438: if ($match) {
1.289 bowersj2 5439: return (1,$1);
5440: } else {
1.434 www 5441: return (0,0);
1.289 bowersj2 5442: }
1.12 www 5443: }
5444:
1.427 www 5445: # --------------------------------------------------------- Get symb from alias
5446:
5447: sub get_symb_from_alias {
5448: my $symb=shift;
5449: my ($map,$resid,$url)=&decode_symb($symb);
5450: # Already is a symb
5451: if ($url) { return $symb; }
5452: # Must be an alias
5453: my $aliassymb='';
5454: my %bighash;
1.620 albertel 5455: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 5456: &GDBM_READER(),0640)) {
5457: my $rid=$bighash{'mapalias_'.$symb};
5458: if ($rid) {
5459: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 5460: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5461: $resid,$bighash{'src_'.$rid});
1.427 www 5462: }
5463: untie %bighash;
5464: }
5465: return $aliassymb;
5466: }
5467:
1.12 www 5468: # ----------------------------------------------------------------- Define Role
5469:
5470: sub definerole {
5471: if (allowed('mcr','/')) {
5472: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 5473: foreach my $role (split(':',$sysrole)) {
5474: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5475: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5476: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5477: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5478: return "refused:s:$crole&$cqual";
5479: }
5480: }
1.191 harris41 5481: }
1.800 albertel 5482: foreach my $role (split(':',$domrole)) {
5483: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5484: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5485: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5486: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 5487: return "refused:d:$crole&$cqual";
5488: }
5489: }
1.191 harris41 5490: }
1.800 albertel 5491: foreach my $role (split(':',$courole)) {
5492: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5493: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5494: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5495: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5496: return "refused:c:$crole&$cqual";
5497: }
5498: }
1.191 harris41 5499: }
1.620 albertel 5500: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5501: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5502: "rolesdef_$rolename=".
5503: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 5504: return reply($command,$env{'user.home'});
1.12 www 5505: } else {
5506: return 'refused';
5507: }
1.105 harris41 5508: }
5509:
5510: # ---------------- Make a metadata query against the network of library servers
5511:
5512: sub metadata_query {
1.244 matthew 5513: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 5514: my %rhash;
1.845 albertel 5515: my %libserv = &all_library();
1.244 matthew 5516: my @server_list = (defined($server_array) ? @$server_array
5517: : keys(%libserv) );
5518: for my $server (@server_list) {
1.118 harris41 5519: unless ($custom or $customshow) {
5520: my $reply=&reply("querysend:".&escape($query),$server);
5521: $rhash{$server}=$reply;
5522: }
5523: else {
5524: my $reply=&reply("querysend:".&escape($query).':'.
5525: &escape($custom).':'.&escape($customshow),
5526: $server);
5527: $rhash{$server}=$reply;
5528: }
1.112 harris41 5529: }
1.118 harris41 5530: return \%rhash;
1.240 www 5531: }
5532:
5533: # ----------------------------------------- Send log queries and wait for reply
5534:
5535: sub log_query {
5536: my ($uname,$udom,$query,%filters)=@_;
5537: my $uhome=&homeserver($uname,$udom);
5538: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 5539: my $uhost=&hostname($uhome);
1.800 albertel 5540: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 5541: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5542: $uhome);
1.479 albertel 5543: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 5544: return get_query_reply($queryid);
5545: }
5546:
1.818 raeburn 5547: # -------------------------- Update MySQL table for portfolio file
5548:
5549: sub update_portfolio_table {
1.821 raeburn 5550: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 5551: if ($group ne '') {
5552: $file_name =~s /^\Q$group\E//;
5553: }
1.818 raeburn 5554: my $homeserver = &homeserver($uname,$udom);
5555: my $queryid=
1.821 raeburn 5556: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5557: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 5558: my $reply = &get_query_reply($queryid);
5559: return $reply;
5560: }
5561:
1.899 raeburn 5562: # -------------------------- Update MySQL allusers table
5563:
5564: sub update_allusers_table {
5565: my ($uname,$udom,$names) = @_;
5566: my $homeserver = &homeserver($uname,$udom);
5567: my $queryid=
5568: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5569: 'lastname='.&escape($names->{'lastname'}).'%%'.
5570: 'firstname='.&escape($names->{'firstname'}).'%%'.
5571: 'middlename='.&escape($names->{'middlename'}).'%%'.
5572: 'generation='.&escape($names->{'generation'}).'%%'.
5573: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5574: 'id='.&escape($names->{'id'}),$homeserver);
5575: my $reply = &get_query_reply($queryid);
5576: return $reply;
5577: }
5578:
1.508 raeburn 5579: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 5580:
5581: sub fetch_enrollment_query {
1.511 raeburn 5582: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 5583: my $homeserver;
1.547 raeburn 5584: my $maxtries = 1;
1.508 raeburn 5585: if ($context eq 'automated') {
5586: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 5587: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 5588: } else {
5589: $homeserver = &homeserver($cnum,$dom);
5590: }
1.838 albertel 5591: my $host=&hostname($homeserver);
1.506 raeburn 5592: my $cmd = '';
1.1000 raeburn 5593: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 5594: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 5595: }
5596: $cmd =~ s/%%$//;
5597: $cmd = &escape($cmd);
5598: my $query = 'fetchenrollment';
1.620 albertel 5599: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 5600: unless ($queryid=~/^\Q$host\E\_/) {
5601: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5602: return 'error: '.$queryid;
5603: }
1.506 raeburn 5604: my $reply = &get_query_reply($queryid);
1.547 raeburn 5605: my $tries = 1;
5606: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5607: $reply = &get_query_reply($queryid);
5608: $tries ++;
5609: }
1.526 raeburn 5610: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 5611: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 5612: } else {
1.901 albertel 5613: my @responses = split(/:/,$reply);
1.515 raeburn 5614: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 5615: foreach my $line (@responses) {
5616: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 5617: $$replyref{$key} = $value;
5618: }
5619: } else {
1.506 raeburn 5620: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 5621: foreach my $line (@responses) {
5622: my ($key,$value) = split(/=/,$line);
1.506 raeburn 5623: $$replyref{$key} = $value;
5624: if ($value > 0) {
1.800 albertel 5625: foreach my $item (@{$$affiliatesref{$key}}) {
5626: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 5627: my $destname = $pathname.'/'.$filename;
5628: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 5629: if ($xml_classlist =~ /^error/) {
5630: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5631: } else {
1.506 raeburn 5632: if ( open(FILE,">$destname") ) {
5633: print FILE &unescape($xml_classlist);
5634: close(FILE);
1.526 raeburn 5635: } else {
5636: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 5637: }
5638: }
5639: }
5640: }
5641: }
5642: }
5643: return 'ok';
5644: }
5645: return 'error';
5646: }
5647:
1.242 www 5648: sub get_query_reply {
5649: my $queryid=shift;
1.240 www 5650: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5651: my $reply='';
5652: for (1..100) {
5653: sleep 2;
5654: if (-e $replyfile.'.end') {
1.448 albertel 5655: if (open(my $fh,$replyfile)) {
1.904 albertel 5656: $reply = join('',<$fh>);
5657: close($fh);
1.240 www 5658: } else { return 'error: reply_file_error'; }
1.242 www 5659: return &unescape($reply);
5660: }
1.240 www 5661: }
1.242 www 5662: return 'timeout:'.$queryid;
1.240 www 5663: }
5664:
5665: sub courselog_query {
1.241 www 5666: #
5667: # possible filters:
5668: # url: url or symb
5669: # username
5670: # domain
5671: # action: view, submit, grade
5672: # start: timestamp
5673: # end: timestamp
5674: #
1.240 www 5675: my (%filters)=@_;
1.620 albertel 5676: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 5677: if ($filters{'url'}) {
5678: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5679: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5680: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5681: }
1.620 albertel 5682: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5683: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 5684: return &log_query($cname,$cdom,'courselog',%filters);
5685: }
5686:
5687: sub userlog_query {
1.858 raeburn 5688: #
5689: # possible filters:
5690: # action: log check role
5691: # start: timestamp
5692: # end: timestamp
5693: #
1.240 www 5694: my ($uname,$udom,%filters)=@_;
5695: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 5696: }
5697:
1.506 raeburn 5698: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5699:
5700: sub auto_run {
1.508 raeburn 5701: my ($cnum,$cdom) = @_;
1.876 raeburn 5702: my $response = 0;
5703: my $settings;
5704: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5705: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5706: $settings = $domconfig{'autoenroll'};
5707: if ($settings->{'run'} eq '1') {
5708: $response = 1;
5709: }
5710: } else {
1.934 raeburn 5711: my $homeserver;
5712: if (&is_course($cdom,$cnum)) {
5713: $homeserver = &homeserver($cnum,$cdom);
5714: } else {
5715: $homeserver = &domain($cdom,'primary');
5716: }
5717: if ($homeserver ne 'no_host') {
5718: $response = &reply('autorun:'.$cdom,$homeserver);
5719: }
1.876 raeburn 5720: }
1.506 raeburn 5721: return $response;
5722: }
1.776 albertel 5723:
1.506 raeburn 5724: sub auto_get_sections {
1.508 raeburn 5725: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 5726: my $homeserver;
5727: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5728: $homeserver = &homeserver($cnum,$cdom);
5729: }
5730: if (!defined($homeserver)) {
5731: if ($cdom =~ /^$match_domain$/) {
5732: $homeserver = &domain($cdom,'primary');
5733: }
5734: }
5735: my @secs;
5736: if (defined($homeserver)) {
5737: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5738: unless ($response eq 'refused') {
5739: @secs = split(/:/,$response);
5740: }
1.506 raeburn 5741: }
5742: return @secs;
5743: }
1.776 albertel 5744:
1.506 raeburn 5745: sub auto_new_course {
1.508 raeburn 5746: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5747: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 5748: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 5749: return $response;
5750: }
1.776 albertel 5751:
1.506 raeburn 5752: sub auto_validate_courseID {
1.508 raeburn 5753: my ($cnum,$cdom,$inst_course_id) = @_;
5754: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 5755: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 5756: return $response;
5757: }
1.776 albertel 5758:
1.1007 raeburn 5759: sub auto_validate_instcode {
1.1020 raeburn 5760: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 5761: my ($homeserver,$response);
5762: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5763: $homeserver = &homeserver($cnum,$cdom);
5764: }
5765: if (!defined($homeserver)) {
5766: if ($cdom =~ /^$match_domain$/) {
5767: $homeserver = &domain($cdom,'primary');
5768: }
5769: }
5770: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
1.1020 raeburn 5771: &escape($instcode).':'.&escape($owner),$homeserver));
1.1027 raeburn 5772: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5773: return ($outcome,$description);
1.1007 raeburn 5774: }
5775:
1.506 raeburn 5776: sub auto_create_password {
1.873 raeburn 5777: my ($cnum,$cdom,$authparam,$udom) = @_;
5778: my ($homeserver,$response);
1.506 raeburn 5779: my $create_passwd = 0;
5780: my $authchk = '';
1.873 raeburn 5781: if ($udom =~ /^$match_domain$/) {
5782: $homeserver = &domain($udom,'primary');
5783: }
5784: if ($homeserver eq '') {
5785: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5786: $homeserver = &homeserver($cnum,$cdom);
5787: }
5788: }
5789: if ($homeserver eq '') {
5790: $authchk = 'nodomain';
1.506 raeburn 5791: } else {
1.873 raeburn 5792: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5793: if ($response eq 'refused') {
5794: $authchk = 'refused';
5795: } else {
1.901 albertel 5796: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 5797: }
1.506 raeburn 5798: }
5799: return ($authparam,$create_passwd,$authchk);
5800: }
5801:
1.706 raeburn 5802: sub auto_photo_permission {
5803: my ($cnum,$cdom,$students) = @_;
5804: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 5805: my ($outcome,$perm_reqd,$conditions) =
5806: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 5807: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5808: return (undef,undef);
5809: }
1.706 raeburn 5810: return ($outcome,$perm_reqd,$conditions);
5811: }
5812:
5813: sub auto_checkphotos {
5814: my ($uname,$udom,$pid) = @_;
5815: my $homeserver = &homeserver($uname,$udom);
5816: my ($result,$resulttype);
5817: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 5818: &escape($uname).':'.&escape($pid),
5819: $homeserver));
1.709 albertel 5820: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5821: return (undef,undef);
5822: }
1.706 raeburn 5823: if ($outcome) {
5824: ($result,$resulttype) = split(/:/,$outcome);
5825: }
5826: return ($result,$resulttype);
5827: }
5828:
5829: sub auto_photochoice {
5830: my ($cnum,$cdom) = @_;
5831: my $homeserver = &homeserver($cnum,$cdom);
5832: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 5833: &escape($cdom),
5834: $homeserver)));
1.709 albertel 5835: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5836: return (undef,undef);
5837: }
1.706 raeburn 5838: return ($update,$comment);
5839: }
5840:
5841: sub auto_photoupdate {
5842: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5843: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 5844: my $host=&hostname($homeserver);
1.706 raeburn 5845: my $cmd = '';
5846: my $maxtries = 1;
1.800 albertel 5847: foreach my $affiliate (keys(%{$affiliatesref})) {
5848: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 5849: }
5850: $cmd =~ s/%%$//;
5851: $cmd = &escape($cmd);
5852: my $query = 'institutionalphotos';
5853: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5854: unless ($queryid=~/^\Q$host\E\_/) {
5855: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5856: return 'error: '.$queryid;
5857: }
5858: my $reply = &get_query_reply($queryid);
5859: my $tries = 1;
5860: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5861: $reply = &get_query_reply($queryid);
5862: $tries ++;
5863: }
5864: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5865: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5866: } else {
5867: my @responses = split(/:/,$reply);
5868: my $outcome = shift(@responses);
5869: foreach my $item (@responses) {
5870: my ($key,$value) = split(/=/,$item);
5871: $$photo{$key} = $value;
5872: }
5873: return $outcome;
5874: }
5875: return 'error';
5876: }
5877:
1.521 raeburn 5878: sub auto_instcode_format {
1.793 albertel 5879: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5880: $cat_order) = @_;
1.521 raeburn 5881: my $courses = '';
1.772 raeburn 5882: my @homeservers;
1.521 raeburn 5883: if ($caller eq 'global') {
1.841 albertel 5884: my %servers = &get_servers($codedom,'library');
5885: foreach my $tryserver (keys(%servers)) {
5886: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5887: push(@homeservers,$tryserver);
5888: }
1.584 raeburn 5889: }
1.1022 raeburn 5890: } elsif ($caller eq 'requests') {
5891: if ($codedom =~ /^$match_domain$/) {
5892: my $chome = &domain($codedom,'primary');
5893: unless ($chome eq 'no_host') {
5894: push(@homeservers,$chome);
5895: }
5896: }
1.521 raeburn 5897: } else {
1.772 raeburn 5898: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 5899: }
1.793 albertel 5900: foreach my $code (keys(%{$instcodes})) {
5901: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 5902: }
5903: chop($courses);
1.772 raeburn 5904: my $ok_response = 0;
5905: my $response;
5906: while (@homeservers > 0 && $ok_response == 0) {
5907: my $server = shift(@homeservers);
5908: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5909: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5910: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 5911: split(/:/,$response);
1.772 raeburn 5912: %{$codes} = (%{$codes},&str2hash($codes_str));
5913: push(@{$codetitles},&str2array($codetitles_str));
5914: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5915: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5916: $ok_response = 1;
5917: }
5918: }
5919: if ($ok_response) {
1.521 raeburn 5920: return 'ok';
1.772 raeburn 5921: } else {
5922: return $response;
1.521 raeburn 5923: }
5924: }
5925:
1.792 raeburn 5926: sub auto_instcode_defaults {
5927: my ($domain,$returnhash,$code_order) = @_;
5928: my @homeservers;
1.841 albertel 5929:
5930: my %servers = &get_servers($domain,'library');
5931: foreach my $tryserver (keys(%servers)) {
5932: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5933: push(@homeservers,$tryserver);
5934: }
1.792 raeburn 5935: }
1.841 albertel 5936:
1.792 raeburn 5937: my $response;
1.841 albertel 5938: foreach my $server (@homeservers) {
1.792 raeburn 5939: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 5940: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5941:
5942: foreach my $pair (split(/\&/,$response)) {
5943: my ($name,$value)=split(/\=/,$pair);
5944: if ($name eq 'code_order') {
5945: @{$code_order} = split(/\&/,&unescape($value));
5946: } else {
5947: $returnhash->{&unescape($name)}=&unescape($value);
5948: }
5949: }
5950: return 'ok';
1.792 raeburn 5951: }
1.841 albertel 5952:
5953: return $response;
1.1003 raeburn 5954: }
5955:
5956: sub auto_possible_instcodes {
1.1007 raeburn 5957: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
5958: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
5959: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
5960: return;
5961: }
1.1003 raeburn 5962: my (@homeservers,$uhome);
5963: if (defined(&domain($domain,'primary'))) {
5964: $uhome=&domain($domain,'primary');
5965: push(@homeservers,&domain($domain,'primary'));
5966: } else {
5967: my %servers = &get_servers($domain,'library');
5968: foreach my $tryserver (keys(%servers)) {
5969: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5970: push(@homeservers,$tryserver);
5971: }
5972: }
5973: }
5974: my $response;
5975: foreach my $server (@homeservers) {
5976: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5977: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 5978: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
5979: split(':',$response);
5980: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5981: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 5982: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 5983: my ($name,$value)=split('=',$item);
5984: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5985: }
5986: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 5987: my ($name,$value)=split('=',$item);
5988: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5989: }
5990: return 'ok';
5991: }
5992: return $response;
5993: }
1.792 raeburn 5994:
1.1010 raeburn 5995: sub auto_courserequest_checks {
5996: my ($dom) = @_;
1.1020 raeburn 5997: my ($homeserver,%validations);
5998: if ($dom =~ /^$match_domain$/) {
5999: $homeserver = &domain($dom,'primary');
6000: }
6001: unless ($homeserver eq 'no_host') {
6002: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6003: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6004: my @items = split(/&/,$response);
6005: foreach my $item (@items) {
6006: my ($key,$value) = split('=',$item);
6007: $validations{&unescape($key)} = &thaw_unescape($value);
6008: }
6009: }
6010: }
1.1010 raeburn 6011: return %validations;
6012: }
6013:
1.1020 raeburn 6014: sub auto_courserequest_validation {
6015: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6016: my ($homeserver,$response);
6017: if ($dom =~ /^$match_domain$/) {
6018: $homeserver = &domain($dom,'primary');
6019: }
6020: unless ($homeserver eq 'no_host') {
1.1021 raeburn 6021:
1.1020 raeburn 6022: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 6023: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 6024: ':'.&escape($instcode).':'.&escape($instseclist),
6025: $homeserver));
6026: }
6027: return $response;
6028: }
6029:
1.777 albertel 6030: sub auto_validate_class_sec {
1.918 raeburn 6031: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 6032: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 6033: my $ownerlist;
6034: if (ref($owners) eq 'ARRAY') {
6035: $ownerlist = join(',',@{$owners});
6036: } else {
6037: $ownerlist = $owners;
6038: }
1.773 raeburn 6039: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 6040: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 6041: return $response;
6042: }
6043:
1.679 raeburn 6044: # ------------------------------------------------------- Course Group routines
6045:
6046: sub get_coursegroups {
1.809 raeburn 6047: my ($cdom,$cnum,$group,$namespace) = @_;
6048: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 6049: }
6050:
1.679 raeburn 6051: sub modify_coursegroup {
6052: my ($cdom,$cnum,$groupsettings) = @_;
6053: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6054: }
6055:
1.809 raeburn 6056: sub toggle_coursegroup_status {
6057: my ($cdom,$cnum,$group,$action) = @_;
6058: my ($from_namespace,$to_namespace);
6059: if ($action eq 'delete') {
6060: $from_namespace = 'coursegroups';
6061: $to_namespace = 'deleted_groups';
6062: } else {
6063: $from_namespace = 'deleted_groups';
6064: $to_namespace = 'coursegroups';
6065: }
6066: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 6067: if (my $tmp = &error(%curr_group)) {
6068: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6069: return ('read error',$tmp);
6070: } else {
6071: my %savedsettings = %curr_group;
1.809 raeburn 6072: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 6073: my $deloutcome;
6074: if ($result eq 'ok') {
1.809 raeburn 6075: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 6076: } else {
6077: return ('write error',$result);
6078: }
6079: if ($deloutcome eq 'ok') {
6080: return 'ok';
6081: } else {
6082: return ('delete error',$deloutcome);
6083: }
6084: }
6085: }
6086:
1.679 raeburn 6087: sub modify_group_roles {
1.957 raeburn 6088: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 6089: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6090: my $role = 'gr/'.&escape($userprivs);
6091: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 6092: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 6093: if ($result eq 'ok') {
6094: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6095: }
1.679 raeburn 6096: return $result;
6097: }
6098:
6099: sub modify_coursegroup_membership {
6100: my ($cdom,$cnum,$membership) = @_;
6101: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6102: return $result;
6103: }
6104:
1.682 raeburn 6105: sub get_active_groups {
6106: my ($udom,$uname,$cdom,$cnum) = @_;
6107: my $now = time;
6108: my %groups = ();
6109: foreach my $key (keys(%env)) {
1.811 albertel 6110: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 6111: my ($start,$end) = split(/\./,$env{$key});
6112: if (($end!=0) && ($end<$now)) { next; }
6113: if (($start!=0) && ($start>$now)) { next; }
6114: if ($1 eq $cdom && $2 eq $cnum) {
6115: $groups{$3} = $env{$key} ;
6116: }
6117: }
6118: }
6119: return %groups;
6120: }
6121:
1.683 raeburn 6122: sub get_group_membership {
6123: my ($cdom,$cnum,$group) = @_;
6124: return(&dump('groupmembership',$cdom,$cnum,$group));
6125: }
6126:
6127: sub get_users_groups {
6128: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 6129: my @usersgroups;
1.683 raeburn 6130: my $cachetime=1800;
6131:
6132: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 6133: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6134: if (defined($cached)) {
1.734 albertel 6135: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 6136: } else {
6137: $grouplist = '';
1.816 raeburn 6138: my $courseurl = &courseid_to_courseurl($courseid);
6139: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 6140: my $access_end = $env{'course.'.$courseid.
6141: '.default_enrollment_end_date'};
6142: my $now = time;
6143: foreach my $key (keys(%roleshash)) {
6144: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6145: my $group = $1;
6146: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6147: my $start = $2;
6148: my $end = $1;
6149: if ($start == -1) { next; } # deleted from group
6150: if (($start!=0) && ($start>$now)) { next; }
6151: if (($end!=0) && ($end<$now)) {
6152: if ($access_end && $access_end < $now) {
6153: if ($access_end - $end < 86400) {
6154: push(@usersgroups,$group);
1.733 raeburn 6155: }
6156: }
1.817 raeburn 6157: next;
1.733 raeburn 6158: }
1.817 raeburn 6159: push(@usersgroups,$group);
1.683 raeburn 6160: }
6161: }
6162: }
1.817 raeburn 6163: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6164: $grouplist = join(':',@usersgroups);
6165: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 6166: }
1.733 raeburn 6167: return @usersgroups;
1.683 raeburn 6168: }
6169:
6170: sub devalidate_getgroups_cache {
6171: my ($udom,$uname,$cdom,$cnum)=@_;
6172: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 6173:
1.683 raeburn 6174: my $hashid="$udom:$uname:$courseid";
6175: &devalidate_cache_new('getgroups',$hashid);
6176: }
6177:
1.12 www 6178: # ------------------------------------------------------------------ Plain Text
6179:
6180: sub plaintext {
1.988 raeburn 6181: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 6182: if ($short =~ m{^cr/}) {
1.758 albertel 6183: return (split('/',$short))[-1];
6184: }
1.742 raeburn 6185: if (!defined($cid)) {
6186: $cid = $env{'request.course.id'};
6187: }
6188: my %rolenames = (
1.1008 raeburn 6189: Course => 'std',
6190: Community => 'alt1',
1.742 raeburn 6191: );
1.1037 raeburn 6192: if ($cid ne '') {
6193: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6194: unless ($forcedefault) {
6195: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6196: &Apache::lonlocal::mt_escape(\$roletext);
6197: return &Apache::lonlocal::mt($roletext);
6198: }
6199: }
6200: }
6201: if ((defined($type)) && (defined($rolenames{$type})) &&
6202: (defined($rolenames{$type})) &&
6203: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 6204: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 6205: } elsif ($cid ne '') {
6206: my $crstype = $env{'course.'.$cid.'.type'};
6207: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6208: (defined($prp{$short}{$rolenames{$crstype}}))) {
6209: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6210: }
1.742 raeburn 6211: }
1.1037 raeburn 6212: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 6213: }
6214:
6215: # ----------------------------------------------------------------- Assign Role
6216:
6217: sub assignrole {
1.957 raeburn 6218: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6219: $context)=@_;
1.21 www 6220: my $mrole;
6221: if ($role =~ /^cr\//) {
1.393 www 6222: my $cwosec=$url;
1.811 albertel 6223: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 6224: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 6225: my $refused = 1;
6226: if ($context eq 'requestcourses') {
6227: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6228: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6229: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6230: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6231: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6232: if ($crsenv{'internal.courseowner'} eq
6233: $env{'user.name'}.':'.$env{'user.domain'}) {
6234: $refused = '';
6235: }
6236: }
6237: }
6238: }
6239: }
6240: if ($refused) {
6241: &logthis('Refused custom assignrole: '.
6242: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6243: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6244: return 'refused';
6245: }
1.104 www 6246: }
1.21 www 6247: $mrole='cr';
1.678 raeburn 6248: } elsif ($role =~ /^gr\//) {
6249: my $cwogrp=$url;
1.811 albertel 6250: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 6251: unless (&allowed('mdg',$cwogrp)) {
6252: &logthis('Refused group assignrole: '.
6253: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6254: $env{'user.name'}.' at '.$env{'user.domain'});
6255: return 'refused';
6256: }
6257: $mrole='gr';
1.21 www 6258: } else {
1.82 www 6259: my $cwosec=$url;
1.811 albertel 6260: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 6261: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6262: my $refused;
6263: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6264: if (!(&allowed('c'.$role,$url))) {
6265: $refused = 1;
6266: }
6267: } else {
6268: $refused = 1;
6269: }
1.947 raeburn 6270: if ($refused) {
1.1045 raeburn 6271: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6272: if (!$selfenroll && $context eq 'course') {
6273: my %crsenv;
6274: if ($role eq 'cc' || $role eq 'co') {
6275: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6276: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6277: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6278: if ($crsenv{'internal.courseowner'} eq
6279: $env{'user.name'}.':'.$env{'user.domain'}) {
6280: $refused = '';
6281: }
6282: }
6283: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6284: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6285: if ($crsenv{'internal.courseowner'} eq
6286: $env{'user.name'}.':'.$env{'user.domain'}) {
6287: $refused = '';
6288: }
6289: }
6290: }
6291: }
6292: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 6293: $refused = '';
1.1048.2.1 raeburn 6294: } elsif (($selfenroll == 1) && ($role eq 'st') && ($cdom eq 'gci') && ($cnum eq '1H96711d710194bfegcil1')) {
6295: if ($env{'request.role'} eq 'cc./gci/9615072b469884921gcil1') {
6296: $refused = '';
6297: }
1.1017 raeburn 6298: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 6299: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 6300: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 6301: my $wrongcc;
6302: if ($cnum =~ /^$match_community$/) {
6303: $wrongcc = 1 if ($role eq 'cc');
6304: } else {
6305: $wrongcc = 1 if ($role eq 'co');
6306: }
6307: unless ($wrongcc) {
6308: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6309: if ($crsenv{'internal.courseowner'} eq
6310: $env{'user.name'}.':'.$env{'user.domain'}) {
6311: $refused = '';
6312: }
1.1017 raeburn 6313: }
6314: }
6315: }
6316: if ($refused) {
1.947 raeburn 6317: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6318: ' '.$role.' '.$end.' '.$start.' by '.
6319: $env{'user.name'}.' at '.$env{'user.domain'});
6320: return 'refused';
6321: }
1.932 raeburn 6322: }
1.104 www 6323: }
1.21 www 6324: $mrole=$role;
6325: }
1.620 albertel 6326: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 6327: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 6328: if ($end) { $command.='_'.$end; }
1.21 www 6329: if ($start) {
6330: if ($end) {
1.81 www 6331: $command.='_'.$start;
1.21 www 6332: } else {
1.81 www 6333: $command.='_0_'.$start;
1.21 www 6334: }
6335: }
1.739 raeburn 6336: my $origstart = $start;
6337: my $origend = $end;
1.957 raeburn 6338: my $delflag;
1.357 www 6339: # actually delete
6340: if ($deleteflag) {
1.373 www 6341: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 6342: # modify command to delete the role
1.620 albertel 6343: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 6344: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 6345: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 6346: # set start and finish to negative values for userrolelog
6347: $start=-1;
6348: $end=-1;
1.957 raeburn 6349: $delflag = 1;
1.357 www 6350: }
6351: }
6352: # send command
1.349 www 6353: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 6354: # log new user role if status is ok
1.349 www 6355: if ($answer eq 'ok') {
1.663 raeburn 6356: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 6357: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 6358: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 6359: unless ($role =~ /^gr/) {
6360: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 6361: $origstart,$selfenroll,$context);
1.739 raeburn 6362: }
1.349 www 6363: }
6364: return $answer;
1.169 harris41 6365: }
6366:
6367: # -------------------------------------------------- Modify user authentication
1.197 www 6368: # Overrides without validation
6369:
1.169 harris41 6370: sub modifyuserauth {
6371: my ($udom,$uname,$umode,$upass)=@_;
6372: my $uhome=&homeserver($uname,$udom);
1.197 www 6373: unless (&allowed('mau',$udom)) { return 'refused'; }
6374: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 6375: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6376: ' in domain '.$env{'request.role.domain'});
1.169 harris41 6377: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6378: &escape($upass),$uhome);
1.620 albertel 6379: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 6380: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6381: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6382: &log($udom,,$uname,$uhome,
1.620 albertel 6383: 'Authentication changed by '.$env{'user.domain'}.', '.
6384: $env{'user.name'}.', '.$umode.
1.197 www 6385: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 6386: unless ($reply eq 'ok') {
1.197 www 6387: &logthis('Authentication mode error: '.$reply);
1.169 harris41 6388: return 'error: '.$reply;
6389: }
1.170 harris41 6390: return 'ok';
1.80 www 6391: }
6392:
1.81 www 6393: # --------------------------------------------------------------- Modify a user
1.80 www 6394:
1.81 www 6395: sub modifyuser {
1.206 matthew 6396: my ($udom, $uname, $uid,
6397: $umode, $upass, $first,
6398: $middle, $last, $gene,
1.963 raeburn 6399: $forceid, $desiredhome, $email, $inststatus)=@_;
1.807 albertel 6400: $udom= &LONCAPA::clean_domain($udom);
6401: $uname=&LONCAPA::clean_username($uname);
1.81 www 6402: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 6403: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 6404: $last.', '.$gene.'(forceid: '.$forceid.')'.
6405: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6406: ' desiredhome not specified').
1.620 albertel 6407: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6408: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 6409: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 6410: # ----------------------------------------------------------------- Create User
1.406 albertel 6411: if (($uhome eq 'no_host') &&
6412: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 6413: my $unhome='';
1.844 albertel 6414: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 6415: $unhome = $desiredhome;
1.620 albertel 6416: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6417: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 6418: } else { # load balancing routine for determining $unhome
1.81 www 6419: my $loadm=10000000;
1.841 albertel 6420: my %servers = &get_servers($udom,'library');
6421: foreach my $tryserver (keys(%servers)) {
6422: my $answer=reply('load',$tryserver);
6423: if (($answer=~/\d+/) && ($answer<$loadm)) {
6424: $loadm=$answer;
6425: $unhome=$tryserver;
6426: }
1.80 www 6427: }
6428: }
6429: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 6430: return 'error: unable to find a home server for '.$uname.
6431: ' in domain '.$udom;
1.80 www 6432: }
6433: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6434: &escape($upass),$unhome);
6435: unless ($reply eq 'ok') {
6436: return 'error: '.$reply;
6437: }
1.230 stredwic 6438: $uhome=&homeserver($uname,$udom,'true');
1.80 www 6439: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 6440: return 'error: unable verify users home machine.';
1.80 www 6441: }
1.209 matthew 6442: } # End of creation of new user
1.80 www 6443: # ---------------------------------------------------------------------- Add ID
6444: if ($uid) {
6445: $uid=~tr/A-Z/a-z/;
6446: my %uidhash=&idrget($udom,$uname);
1.196 www 6447: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6448: && (!$forceid)) {
1.80 www 6449: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 6450: return 'error: user id "'.$uid.'" does not match '.
6451: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 6452: }
6453: } else {
6454: &idput($udom,($uname => $uid));
6455: }
6456: }
6457: # -------------------------------------------------------------- Add names, etc
1.313 matthew 6458: my @tmp=&get('environment',
1.899 raeburn 6459: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 6460: 'permanentemail','inststatus'],
1.134 albertel 6461: $udom,$uname);
1.313 matthew 6462: my %names;
6463: if ($tmp[0] =~ m/^error:.*/) {
6464: %names=();
6465: } else {
6466: %names = @tmp;
6467: }
1.388 www 6468: #
6469: # Make sure to not trash student environment if instructor does not bother
6470: # to supply name and email information
6471: #
6472: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 6473: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 6474: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 6475: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 6476: if ($email) {
6477: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 6478: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 6479: }
1.899 raeburn 6480: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 6481: if (defined($inststatus)) {
6482: $names{'inststatus'} = '';
6483: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6484: if (ref($usertypes) eq 'HASH') {
6485: my @okstatuses;
6486: foreach my $item (split(/:/,$inststatus)) {
6487: if (defined($usertypes->{$item})) {
6488: push(@okstatuses,$item);
6489: }
6490: }
6491: if (@okstatuses) {
6492: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6493: }
6494: }
6495: }
1.134 albertel 6496: my $reply = &put('environment', \%names, $udom,$uname);
6497: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 6498: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 6499: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.963 raeburn 6500: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6501: $umode.', '.$first.', '.$middle.', '.
6502: $last.', '.$gene.', '.$email.', '.$inststatus;
6503: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6504: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6505: } else {
6506: $logmsg .= ' during self creation';
6507: }
6508: &logthis($logmsg);
1.134 albertel 6509: return 'ok';
1.80 www 6510: }
6511:
1.81 www 6512: # -------------------------------------------------------------- Modify student
1.80 www 6513:
1.81 www 6514: sub modifystudent {
6515: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 6516: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 6517: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 6518: if (!$cid) {
1.620 albertel 6519: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6520: return 'not_in_class';
6521: }
1.80 www 6522: }
6523: # --------------------------------------------------------------- Make the user
1.81 www 6524: my $reply=&modifyuser
1.209 matthew 6525: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 6526: $desiredhome,$email,$inststatus);
1.80 www 6527: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 6528: # This will cause &modify_student_enrollment to get the uid from the
6529: # students environment
6530: $uid = undef if (!$forceid);
1.455 albertel 6531: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 6532: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 6533: return $reply;
6534: }
6535:
6536: sub modify_student_enrollment {
1.957 raeburn 6537: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 6538: my ($cdom,$cnum,$chome);
6539: if (!$cid) {
1.620 albertel 6540: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6541: return 'not_in_class';
6542: }
1.620 albertel 6543: $cdom=$env{'course.'.$cid.'.domain'};
6544: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 6545: } else {
6546: ($cdom,$cnum)=split(/_/,$cid);
6547: }
1.620 albertel 6548: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 6549: if (!$chome) {
1.457 raeburn 6550: $chome=&homeserver($cnum,$cdom);
1.297 matthew 6551: }
1.455 albertel 6552: if (!$chome) { return 'unknown_course'; }
1.297 matthew 6553: # Make sure the user exists
1.81 www 6554: my $uhome=&homeserver($uname,$udom);
6555: if (($uhome eq '') || ($uhome eq 'no_host')) {
6556: return 'error: no such user';
6557: }
1.297 matthew 6558: # Get student data if we were not given enough information
6559: if (!defined($first) || $first eq '' ||
6560: !defined($last) || $last eq '' ||
6561: !defined($uid) || $uid eq '' ||
6562: !defined($middle) || $middle eq '' ||
6563: !defined($gene) || $gene eq '') {
1.294 matthew 6564: # They did not supply us with enough data to enroll the student, so
6565: # we need to pick up more information.
1.297 matthew 6566: my %tmp = &get('environment',
1.294 matthew 6567: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 6568: ,$udom,$uname);
6569:
1.800 albertel 6570: #foreach my $key (keys(%tmp)) {
6571: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 6572: #}
1.294 matthew 6573: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6574: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6575: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 6576: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 6577: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6578: }
1.556 albertel 6579: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 6580: my $reply=cput('classlist',
6581: {"$uname:$udom" =>
1.515 raeburn 6582: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 6583: $cdom,$cnum);
1.81 www 6584: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6585: return 'error: '.$reply;
1.652 albertel 6586: } else {
6587: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 6588: }
1.297 matthew 6589: # Add student role to user
1.83 www 6590: my $uurl='/'.$cid;
1.81 www 6591: $uurl=~s/\_/\//g;
6592: if ($usec) {
6593: $uurl.='/'.$usec;
6594: }
1.957 raeburn 6595: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21 www 6596: }
6597:
1.556 albertel 6598: sub format_name {
6599: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6600: my $name;
6601: if ($first ne 'lastname') {
6602: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6603: } else {
6604: if ($lastname=~/\S/) {
6605: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6606: $name=~s/\s+,/,/;
6607: } else {
6608: $name.= $firstname.' '.$middlename.' '.$generation;
6609: }
6610: }
6611: $name=~s/^\s+//;
6612: $name=~s/\s+$//;
6613: $name=~s/\s+/ /g;
6614: return $name;
6615: }
6616:
1.84 www 6617: # ------------------------------------------------- Write to course preferences
6618:
6619: sub writecoursepref {
6620: my ($courseid,%prefs)=@_;
6621: $courseid=~s/^\///;
6622: $courseid=~s/\_/\//g;
6623: my ($cdomain,$cnum)=split(/\//,$courseid);
6624: my $chome=homeserver($cnum,$cdomain);
6625: if (($chome eq '') || ($chome eq 'no_host')) {
6626: return 'error: no such course';
6627: }
6628: my $cstring='';
1.800 albertel 6629: foreach my $pref (keys(%prefs)) {
6630: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 6631: }
1.84 www 6632: $cstring=~s/\&$//;
6633: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6634: }
6635:
6636: # ---------------------------------------------------------- Make/modify course
6637:
6638: sub createcourse {
1.741 raeburn 6639: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 6640: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 6641: $url=&declutter($url);
6642: my $cid='';
1.1028 raeburn 6643: if ($context eq 'requestcourses') {
6644: my $can_create = 0;
6645: my ($ownername,$ownerdom) = split(':',$course_owner);
6646: if ($udom eq $ownerdom) {
6647: if (&usertools_access($ownername,$ownerdom,$category,undef,
6648: $context)) {
6649: $can_create = 1;
6650: }
6651: } else {
6652: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6653: $category);
6654: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6655: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6656: if (@curr > 0) {
6657: my @options = qw(approval validate autolimit);
6658: my $optregex = join('|',@options);
6659: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6660: $can_create = 1;
6661: }
6662: }
6663: }
6664: }
6665: if ($can_create) {
6666: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6667: unless (&allowed('ccc',$udom)) {
6668: return 'refused';
6669: }
1.1017 raeburn 6670: }
6671: } else {
6672: return 'refused';
6673: }
1.1028 raeburn 6674: } elsif (!&allowed('ccc',$udom)) {
6675: return 'refused';
1.84 www 6676: }
1.1011 raeburn 6677: # --------------------------------------------------------------- Get Unique ID
6678: my $uname;
6679: if ($cnum =~ /^$match_courseid$/) {
6680: my $chome=&homeserver($cnum,$udom,'true');
6681: if (($chome eq '') || ($chome eq 'no_host')) {
6682: $uname = $cnum;
6683: } else {
1.1038 raeburn 6684: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6685: }
6686: } else {
1.1038 raeburn 6687: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6688: }
6689: return $uname if ($uname =~ /^error/);
6690: # -------------------------------------------------- Check supplied server name
1.620 albertel 6691: $course_server = $env{'user.homeserver'} if (! defined($course_server));
1.845 albertel 6692: if (! &is_library($course_server)) {
1.264 matthew 6693: return 'error:bad server name '.$course_server;
6694: }
1.84 www 6695: # ------------------------------------------------------------- Make the course
6696: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 6697: $course_server);
1.84 www 6698: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 6699: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 6700: if (($uhome eq '') || ($uhome eq 'no_host')) {
6701: return 'error: no such course';
6702: }
1.271 www 6703: # ----------------------------------------------------------------- Course made
1.516 raeburn 6704: # log existence
1.1029 raeburn 6705: my $now = time;
1.918 raeburn 6706: my $newcourse = {
6707: $udom.'_'.$uname => {
1.921 raeburn 6708: description => $description,
6709: inst_code => $inst_code,
6710: owner => $course_owner,
6711: type => $crstype,
1.1029 raeburn 6712: creator => $env{'user.name'}.':'.
6713: $env{'user.domain'},
6714: created => $now,
6715: context => $context,
1.918 raeburn 6716: },
6717: };
1.921 raeburn 6718: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 6719: # set toplevel url
1.271 www 6720: my $topurl=$url;
6721: unless ($nonstandard) {
6722: # ------------------------------------------ For standard courses, make top url
6723: my $mapurl=&clutter($url);
1.278 www 6724: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 6725: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 6726: <map>
6727: <resource id="1" type="start"></resource>
6728: <resource id="2" src="$mapurl"></resource>
6729: <resource id="3" type="finish"></resource>
6730: <link index="1" from="1" to="2"></link>
6731: <link index="2" from="2" to="3"></link>
6732: </map>
6733: ENDINITMAP
6734: $topurl=&declutter(
1.638 albertel 6735: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 6736: );
6737: }
6738: # ----------------------------------------------------------- Write preferences
1.84 www 6739: &writecoursepref($udom.'_'.$uname,
6740: ('description' => $description,
1.271 www 6741: 'url' => $topurl));
1.84 www 6742: return '/'.$udom.'/'.$uname;
6743: }
6744:
1.1011 raeburn 6745: # ------------------------------------------------------------------- Create ID
6746: sub generate_coursenum {
1.1038 raeburn 6747: my ($udom,$crstype) = @_;
1.1011 raeburn 6748: my $domdesc = &domain($udom);
6749: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 6750: my $first;
6751: if ($crstype eq 'Community') {
6752: $first = '0';
6753: } else {
6754: $first = int(1+rand(9));
6755: }
6756: my $uname=$first.
1.1011 raeburn 6757: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6758: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6759: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6760: # ----------------------------------------------- Make sure that does not exist
6761: my $uhome=&homeserver($uname,$udom,'true');
6762: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 6763: if ($crstype eq 'Community') {
6764: $first = '0';
6765: } else {
6766: $first = int(1+rand(9));
6767: }
6768: $uname=$first.
1.1011 raeburn 6769: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6770: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6771: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6772: $uhome=&homeserver($uname,$udom,'true');
6773: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6774: return 'error: unable to generate unique course-ID';
6775: }
6776: }
6777: return $uname;
6778: }
6779:
1.813 albertel 6780: sub is_course {
6781: my ($cdom,$cnum) = @_;
6782: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946 raeburn 6783: undef,'.');
1.813 albertel 6784: if (exists($courses{$cdom.'_'.$cnum})) {
6785: return 1;
6786: }
6787: return 0;
6788: }
6789:
1.1015 raeburn 6790: sub store_userdata {
6791: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 6792: my $result;
1.1016 raeburn 6793: if ($datakey ne '') {
1.1013 raeburn 6794: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 6795: if ($udom eq '' || $uname eq '') {
6796: $udom = $env{'user.domain'};
6797: $uname = $env{'user.name'};
6798: }
6799: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 6800: if (($uhome eq '') || ($uhome eq 'no_host')) {
6801: $result = 'error: no_host';
6802: } else {
6803: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6804: $storehash->{'host'} = $perlvar{'lonHostID'};
6805:
6806: my $namevalue='';
6807: foreach my $key (keys(%{$storehash})) {
6808: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6809: }
6810: $namevalue=~s/\&$//;
6811: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
1.1015 raeburn 6812: "$namespace:$datakey:$namevalue",$uhome);
1.1013 raeburn 6813: }
6814: } else {
6815: $result = 'error: data to store was not a hash reference';
6816: }
6817: } else {
6818: $result= 'error: invalid requestkey';
6819: }
6820: return $result;
6821: }
6822:
1.21 www 6823: # ---------------------------------------------------------- Assign Custom Role
6824:
6825: sub assigncustomrole {
1.957 raeburn 6826: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6827: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 6828: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 6829: }
6830:
6831: # ----------------------------------------------------------------- Revoke Role
6832:
6833: sub revokerole {
1.957 raeburn 6834: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6835: my $now=time;
1.965 raeburn 6836: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 6837: }
6838:
6839: # ---------------------------------------------------------- Revoke Custom Role
6840:
6841: sub revokecustomrole {
1.957 raeburn 6842: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6843: my $now=time;
1.357 www 6844: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 6845: $deleteflag,$selfenroll,$context);
1.17 www 6846: }
6847:
1.533 banghart 6848: # ------------------------------------------------------------ Disk usage
1.535 albertel 6849: sub diskusage {
1.955 raeburn 6850: my ($udom,$uname,$directorypath,$getpropath)=@_;
6851: $directorypath =~ s/\/$//;
6852: my $listing=&reply('du2:'.&escape($directorypath).':'
6853: .&escape($getpropath).':'.&escape($uname).':'
6854: .&escape($udom),homeserver($uname,$udom));
6855: if ($listing eq 'unknown_cmd') {
6856: if ($getpropath) {
6857: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6858: }
6859: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6860: }
1.514 albertel 6861: return $listing;
1.512 banghart 6862: }
6863:
1.566 banghart 6864: sub is_locked {
6865: my ($file_name, $domain, $user) = @_;
6866: my @check;
6867: my $is_locked;
6868: push @check, $file_name;
1.613 albertel 6869: my %locked = &get('file_permissions',\@check,
1.620 albertel 6870: $env{'user.domain'},$env{'user.name'});
1.615 albertel 6871: my ($tmp)=keys(%locked);
6872: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 6873:
1.566 banghart 6874: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 6875: $is_locked = 'false';
6876: foreach my $entry (@{$locked{$file_name}}) {
6877: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 6878: $is_locked = 'true';
6879: last;
1.745 raeburn 6880: }
6881: }
1.566 banghart 6882: } else {
6883: $is_locked = 'false';
6884: }
6885: }
6886:
1.759 albertel 6887: sub declutter_portfile {
6888: my ($file) = @_;
1.833 albertel 6889: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 6890: return $file;
6891: }
6892:
1.559 banghart 6893: # ------------------------------------------------------------- Mark as Read Only
6894:
6895: sub mark_as_readonly {
6896: my ($domain,$user,$files,$what) = @_;
1.613 albertel 6897: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 6898: my ($tmp)=keys(%current_permissions);
6899: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 6900: foreach my $file (@{$files}) {
1.759 albertel 6901: $file = &declutter_portfile($file);
1.561 banghart 6902: push(@{$current_permissions{$file}},$what);
1.559 banghart 6903: }
1.613 albertel 6904: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 6905: return;
6906: }
6907:
1.572 banghart 6908: # ------------------------------------------------------------Save Selected Files
6909:
6910: sub save_selected_files {
6911: my ($user, $path, @files) = @_;
6912: my $filename = $user."savedfiles";
1.573 banghart 6913: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 6914: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 6915: foreach my $file (@files) {
1.620 albertel 6916: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 6917: }
6918: foreach my $file (@other_files) {
1.574 banghart 6919: print (OUT $file."\n");
1.572 banghart 6920: }
1.574 banghart 6921: close (OUT);
1.572 banghart 6922: return 'ok';
6923: }
6924:
1.574 banghart 6925: sub clear_selected_files {
6926: my ($user) = @_;
6927: my $filename = $user."savedfiles";
6928: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6929: print (OUT undef);
6930: close (OUT);
6931: return ("ok");
6932: }
6933:
1.572 banghart 6934: sub files_in_path {
6935: my ($user, $path) = @_;
6936: my $filename = $user."savedfiles";
6937: my %return_files;
1.574 banghart 6938: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 6939: while (my $line_in = <IN>) {
1.574 banghart 6940: chomp ($line_in);
6941: my @paths_and_file = split (m!/!, $line_in);
6942: my $file_part = pop (@paths_and_file);
6943: my $path_part = join ('/', @paths_and_file);
1.573 banghart 6944: $path_part.='/';
6945: my $path_and_file = $path_part.$file_part;
6946: if ($path_part eq $path) {
6947: $return_files{$file_part}= 'selected';
6948: }
6949: }
1.574 banghart 6950: close (IN);
6951: return (\%return_files);
1.572 banghart 6952: }
6953:
6954: # called in portfolio select mode, to show files selected NOT in current directory
6955: sub files_not_in_path {
6956: my ($user, $path) = @_;
6957: my $filename = $user."savedfiles";
6958: my @return_files;
6959: my $path_part;
1.800 albertel 6960: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6961: while (my $line = <IN>) {
1.572 banghart 6962: #ok, I know it's clunky, but I want it to work
1.800 albertel 6963: my @paths_and_file = split(m|/|, $line);
6964: my $file_part = pop(@paths_and_file);
6965: chomp($file_part);
6966: my $path_part = join('/', @paths_and_file);
1.572 banghart 6967: $path_part .= '/';
6968: my $path_and_file = $path_part.$file_part;
6969: if ($path_part ne $path) {
1.800 albertel 6970: push(@return_files, ($path_and_file));
1.572 banghart 6971: }
6972: }
1.800 albertel 6973: close(OUT);
1.574 banghart 6974: return (@return_files);
1.572 banghart 6975: }
6976:
1.745 raeburn 6977: #----------------------------------------------Get portfolio file permissions
1.629 banghart 6978:
1.745 raeburn 6979: sub get_portfile_permissions {
6980: my ($domain,$user) = @_;
1.613 albertel 6981: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 6982: my ($tmp)=keys(%current_permissions);
6983: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 6984: return \%current_permissions;
6985: }
6986:
6987: #---------------------------------------------Get portfolio file access controls
6988:
1.749 raeburn 6989: sub get_access_controls {
1.745 raeburn 6990: my ($current_permissions,$group,$file) = @_;
1.769 albertel 6991: my %access;
6992: my $real_file = $file;
6993: $file =~ s/\.meta$//;
1.745 raeburn 6994: if (defined($file)) {
1.749 raeburn 6995: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
6996: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 6997: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 6998: }
6999: }
1.745 raeburn 7000: } else {
1.749 raeburn 7001: foreach my $key (keys(%{$current_permissions})) {
7002: if ($key =~ /\0accesscontrol$/) {
7003: if (defined($group)) {
7004: if ($key !~ m-^\Q$group\E/-) {
7005: next;
7006: }
7007: }
7008: my ($fullpath) = split(/\0/,$key);
7009: if (ref($$current_permissions{$key}) eq 'HASH') {
7010: foreach my $control (keys(%{$$current_permissions{$key}})) {
7011: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7012: }
7013: }
7014: }
7015: }
7016: }
7017: return %access;
7018: }
7019:
7020: sub modify_access_controls {
7021: my ($file_name,$changes,$domain,$user)=@_;
7022: my ($outcome,$deloutcome);
7023: my %store_permissions;
7024: my %new_values;
7025: my %new_control;
7026: my %translation;
7027: my @deletions = ();
7028: my $now = time;
7029: if (exists($$changes{'activate'})) {
7030: if (ref($$changes{'activate'}) eq 'HASH') {
7031: my @newitems = sort(keys(%{$$changes{'activate'}}));
7032: my $numnew = scalar(@newitems);
7033: for (my $i=0; $i<$numnew; $i++) {
7034: my $newkey = $newitems[$i];
7035: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 7036: if ($newkey =~ /^\d+:/) {
7037: $newkey =~ s/^(\d+)/$newid/;
7038: $translation{$1} = $newid;
7039: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7040: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7041: $translation{$1} = $newid;
7042: }
1.749 raeburn 7043: $new_values{$file_name."\0".$newkey} =
7044: $$changes{'activate'}{$newitems[$i]};
7045: $new_control{$newkey} = $now;
7046: }
7047: }
7048: }
7049: my %todelete;
7050: my %changed_items;
7051: foreach my $action ('delete','update') {
7052: if (exists($$changes{$action})) {
7053: if (ref($$changes{$action}) eq 'HASH') {
7054: foreach my $key (keys(%{$$changes{$action}})) {
7055: my ($itemnum) = ($key =~ /^([^:]+):/);
7056: if ($action eq 'delete') {
7057: $todelete{$itemnum} = 1;
7058: } else {
7059: $changed_items{$itemnum} = $key;
7060: }
7061: }
1.745 raeburn 7062: }
7063: }
1.749 raeburn 7064: }
7065: # get lock on access controls for file.
7066: my $lockhash = {
7067: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7068: ':'.$env{'user.domain'},
7069: };
7070: my $tries = 0;
7071: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7072:
7073: while (($gotlock ne 'ok') && $tries <3) {
7074: $tries ++;
7075: sleep 1;
7076: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7077: }
7078: if ($gotlock eq 'ok') {
7079: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7080: my ($tmp)=keys(%curr_permissions);
7081: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7082: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7083: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7084: if (ref($curr_controls) eq 'HASH') {
7085: foreach my $control_item (keys(%{$curr_controls})) {
7086: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7087: if (defined($todelete{$itemnum})) {
7088: push(@deletions,$file_name."\0".$control_item);
7089: } else {
7090: if (defined($changed_items{$itemnum})) {
7091: $new_control{$changed_items{$itemnum}} = $now;
7092: push(@deletions,$file_name."\0".$control_item);
7093: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7094: } else {
7095: $new_control{$control_item} = $$curr_controls{$control_item};
7096: }
7097: }
1.745 raeburn 7098: }
7099: }
7100: }
1.970 raeburn 7101: my ($group);
7102: if (&is_course($domain,$user)) {
7103: ($group,my $file) = split(/\//,$file_name,2);
7104: }
1.749 raeburn 7105: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7106: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7107: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7108: # remove lock
7109: my @del_lock = ($file_name."\0".'locked_access_records');
7110: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 7111: my $sqlresult =
1.970 raeburn 7112: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 7113: $group);
1.749 raeburn 7114: } else {
7115: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 7116: }
1.749 raeburn 7117: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 7118: }
7119:
1.827 raeburn 7120: sub make_public_indefinitely {
7121: my ($requrl) = @_;
7122: my $now = time;
7123: my $action = 'activate';
7124: my $aclnum = 0;
7125: if (&is_portfolio_url($requrl)) {
7126: my (undef,$udom,$unum,$file_name,$group) =
7127: &parse_portfolio_url($requrl);
7128: my $current_perms = &get_portfile_permissions($udom,$unum);
7129: my %access_controls = &get_access_controls($current_perms,
7130: $group,$file_name);
7131: foreach my $key (keys(%{$access_controls{$file_name}})) {
7132: my ($num,$scope,$end,$start) =
7133: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7134: if ($scope eq 'public') {
7135: if ($start <= $now && $end == 0) {
7136: $action = 'none';
7137: } else {
7138: $action = 'update';
7139: $aclnum = $num;
7140: }
7141: last;
7142: }
7143: }
7144: if ($action eq 'none') {
7145: return 'ok';
7146: } else {
7147: my %changes;
7148: my $newend = 0;
7149: my $newstart = $now;
7150: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7151: $changes{$action}{$newkey} = {
7152: type => 'public',
7153: time => {
7154: start => $newstart,
7155: end => $newend,
7156: },
7157: };
7158: my ($outcome,$deloutcome,$new_values,$translation) =
7159: &modify_access_controls($file_name,\%changes,$udom,$unum);
7160: return $outcome;
7161: }
7162: } else {
7163: return 'invalid';
7164: }
7165: }
7166:
1.745 raeburn 7167: #------------------------------------------------------Get Marked as Read Only
7168:
7169: sub get_marked_as_readonly {
7170: my ($domain,$user,$what,$group) = @_;
7171: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 7172: my @readonly_files;
1.629 banghart 7173: my $cmp1=$what;
7174: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 7175: while (my ($file_name,$value) = each(%{$current_permissions})) {
7176: if (defined($group)) {
7177: if ($file_name !~ m-^\Q$group\E/-) {
7178: next;
7179: }
7180: }
1.561 banghart 7181: if (ref($value) eq "ARRAY"){
7182: foreach my $stored_what (@{$value}) {
1.629 banghart 7183: my $cmp2=$stored_what;
1.759 albertel 7184: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 7185: $cmp2=join('',@{$stored_what});
1.745 raeburn 7186: }
1.629 banghart 7187: if ($cmp1 eq $cmp2) {
1.561 banghart 7188: push(@readonly_files, $file_name);
1.745 raeburn 7189: last;
1.563 banghart 7190: } elsif (!defined($what)) {
7191: push(@readonly_files, $file_name);
1.745 raeburn 7192: last;
1.561 banghart 7193: }
7194: }
1.745 raeburn 7195: }
1.561 banghart 7196: }
7197: return @readonly_files;
7198: }
1.577 banghart 7199: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 7200:
1.577 banghart 7201: sub get_marked_as_readonly_hash {
1.745 raeburn 7202: my ($current_permissions,$group,$what) = @_;
1.577 banghart 7203: my %readonly_files;
1.745 raeburn 7204: while (my ($file_name,$value) = each(%{$current_permissions})) {
7205: if (defined($group)) {
7206: if ($file_name !~ m-^\Q$group\E/-) {
7207: next;
7208: }
7209: }
1.577 banghart 7210: if (ref($value) eq "ARRAY"){
7211: foreach my $stored_what (@{$value}) {
1.745 raeburn 7212: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 7213: foreach my $lock_descriptor(@{$stored_what}) {
7214: if ($lock_descriptor eq 'graded') {
7215: $readonly_files{$file_name} = 'graded';
7216: } elsif ($lock_descriptor eq 'handback') {
7217: $readonly_files{$file_name} = 'handback';
7218: } else {
7219: if (!exists($readonly_files{$file_name})) {
7220: $readonly_files{$file_name} = 'locked';
7221: }
7222: }
1.745 raeburn 7223: }
1.750 banghart 7224: }
1.577 banghart 7225: }
7226: }
7227: }
7228: return %readonly_files;
7229: }
1.559 banghart 7230: # ------------------------------------------------------------ Unmark as Read Only
7231:
7232: sub unmark_as_readonly {
1.629 banghart 7233: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7234: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 7235: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 7236: $file_name = &declutter_portfile($file_name);
1.634 albertel 7237: my $symb_crs = $what;
7238: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 7239: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 7240: my ($tmp)=keys(%current_permissions);
7241: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7242: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 7243: foreach my $file (@readonly_files) {
1.759 albertel 7244: my $clean_file = &declutter_portfile($file);
7245: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 7246: my $current_locks = $current_permissions{$file};
1.563 banghart 7247: my @new_locks;
7248: my @del_keys;
7249: if (ref($current_locks) eq "ARRAY"){
7250: foreach my $locker (@{$current_locks}) {
1.632 albertel 7251: my $compare=$locker;
1.749 raeburn 7252: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 7253: $compare=join('',@{$locker});
1.746 raeburn 7254: if ($compare ne $symb_crs) {
7255: push(@new_locks, $locker);
7256: }
1.563 banghart 7257: }
7258: }
1.650 albertel 7259: if (scalar(@new_locks) > 0) {
1.563 banghart 7260: $current_permissions{$file} = \@new_locks;
7261: } else {
7262: push(@del_keys, $file);
1.613 albertel 7263: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 7264: delete($current_permissions{$file});
1.563 banghart 7265: }
7266: }
1.561 banghart 7267: }
1.613 albertel 7268: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7269: return;
7270: }
1.512 banghart 7271:
1.17 www 7272: # ------------------------------------------------------------ Directory lister
7273:
7274: sub dirlist {
1.955 raeburn 7275: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 7276: $uri=~s/^\///;
7277: $uri=~s/\/$//;
1.253 stredwic 7278: my ($udom, $uname);
1.955 raeburn 7279: if ($getuserdir) {
1.253 stredwic 7280: $udom = $userdomain;
7281: $uname = $username;
1.955 raeburn 7282: } else {
7283: (undef,$udom,$uname)=split(/\//,$uri);
7284: if(defined($userdomain)) {
7285: $udom = $userdomain;
7286: }
7287: if(defined($username)) {
7288: $uname = $username;
7289: }
1.253 stredwic 7290: }
1.955 raeburn 7291: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 7292:
1.955 raeburn 7293: $dirRoot = $perlvar{'lonDocRoot'};
7294: if (defined($getpropath)) {
7295: $dirRoot = &propath($udom,$uname);
1.253 stredwic 7296: $dirRoot =~ s/\/$//;
1.955 raeburn 7297: } elsif (defined($getuserdir)) {
7298: my $subdir=$uname.'__';
7299: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7300: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7301: ."/$udom/$subdir/$uname";
7302: } elsif (defined($alternateRoot)) {
7303: $dirRoot = $alternateRoot;
1.751 banghart 7304: }
1.253 stredwic 7305:
7306: if($udom) {
7307: if($uname) {
1.955 raeburn 7308: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 7309: .$getuserdir.':'.&escape($dirRoot)
1.955 raeburn 7310: .':'.&escape($uname).':'.&escape($udom),
7311: &homeserver($uname,$udom));
7312: if ($listing eq 'unknown_cmd') {
7313: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7314: &homeserver($uname,$udom));
7315: } else {
7316: @listing_results = map { &unescape($_); } split(/:/,$listing);
7317: }
1.605 matthew 7318: if ($listing eq 'unknown_cmd') {
1.800 albertel 7319: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7320: &homeserver($uname,$udom));
1.605 matthew 7321: @listing_results = split(/:/,$listing);
7322: } else {
7323: @listing_results = map { &unescape($_); } split(/:/,$listing);
7324: }
7325: return @listing_results;
1.955 raeburn 7326: } elsif(!$alternateRoot) {
1.800 albertel 7327: my %allusers;
1.841 albertel 7328: my %servers = &get_servers($udom,'library');
1.955 raeburn 7329: foreach my $tryserver (keys(%servers)) {
7330: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7331: &escape($udom),$tryserver);
7332: if ($listing eq 'unknown_cmd') {
7333: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7334: $udom, $tryserver);
7335: } else {
7336: @listing_results = map { &unescape($_); } split(/:/,$listing);
7337: }
1.841 albertel 7338: if ($listing eq 'unknown_cmd') {
7339: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7340: $udom, $tryserver);
7341: @listing_results = split(/:/,$listing);
7342: } else {
7343: @listing_results =
7344: map { &unescape($_); } split(/:/,$listing);
7345: }
7346: if ($listing_results[0] ne 'no_such_dir' &&
7347: $listing_results[0] ne 'empty' &&
7348: $listing_results[0] ne 'con_lost') {
7349: foreach my $line (@listing_results) {
7350: my ($entry) = split(/&/,$line,2);
7351: $allusers{$entry} = 1;
7352: }
7353: }
1.253 stredwic 7354: }
7355: my $alluserstr='';
1.800 albertel 7356: foreach my $user (sort(keys(%allusers))) {
7357: $alluserstr.=$user.'&user:';
1.253 stredwic 7358: }
7359: $alluserstr=~s/:$//;
7360: return split(/:/,$alluserstr);
7361: } else {
1.800 albertel 7362: return ('missing user name');
1.253 stredwic 7363: }
1.955 raeburn 7364: } elsif(!defined($getpropath)) {
1.841 albertel 7365: my @all_domains = sort(&all_domains());
1.955 raeburn 7366: foreach my $domain (@all_domains) {
7367: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7368: }
7369: return @all_domains;
7370: } else {
1.800 albertel 7371: return ('missing domain');
1.275 stredwic 7372: }
7373: }
7374:
7375: # --------------------------------------------- GetFileTimestamp
7376: # This function utilizes dirlist and returns the date stamp for
7377: # when it was last modified. It will also return an error of -1
7378: # if an error occurs
7379:
7380: sub GetFileTimestamp {
1.955 raeburn 7381: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 7382: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7383: $studentName = &LONCAPA::clean_username($studentName);
1.955 raeburn 7384: my ($fileStat) =
7385: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7386: undef,$getuserdir);
1.275 stredwic 7387: my @stats = split('&', $fileStat);
7388: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 7389: # @stats contains first the filename, then the stat output
7390: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 7391: } else {
7392: return -1;
1.253 stredwic 7393: }
1.26 www 7394: }
7395:
1.712 albertel 7396: sub stat_file {
7397: my ($uri) = @_;
1.787 albertel 7398: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 7399:
1.955 raeburn 7400: my ($udom,$uname,$file);
1.712 albertel 7401: if ($uri =~ m-^/(uploaded|editupload)/-) {
7402: ($udom,$uname,$file) =
1.811 albertel 7403: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 7404: $file = 'userfiles/'.$file;
7405: }
7406: if ($uri =~ m-^/res/-) {
7407: ($udom,$uname) =
1.807 albertel 7408: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 7409: $file = $uri;
7410: }
7411:
7412: if (!$udom || !$uname || !$file) {
7413: # unable to handle the uri
7414: return ();
7415: }
1.956 raeburn 7416: my $getpropath;
7417: if ($file =~ /^userfiles\//) {
7418: $getpropath = 1;
7419: }
1.955 raeburn 7420: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712 albertel 7421: my @stats = split('&', $result);
1.721 banghart 7422:
1.712 albertel 7423: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7424: shift(@stats); #filename is first
7425: return @stats;
7426: }
7427: return ();
7428: }
7429:
1.26 www 7430: # -------------------------------------------------------- Value of a Condition
7431:
1.713 albertel 7432: # gets the value of a specific preevaluated condition
7433: # stored in the string $env{user.state.<cid>}
7434: # or looks up a condition reference in the bighash and if if hasn't
7435: # already been evaluated recurses into docondval to get the value of
7436: # the condition, then memoizing it to
7437: # $env{user.state.<cid>.<condition>}
1.40 www 7438: sub directcondval {
7439: my $number=shift;
1.620 albertel 7440: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 7441: &Apache::lonuserstate::evalstate();
7442: }
1.713 albertel 7443: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7444: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7445: } elsif ($number =~ /^_/) {
7446: my $sub_condition;
7447: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7448: &GDBM_READER(),0640)) {
7449: $sub_condition=$bighash{'conditions'.$number};
7450: untie(%bighash);
7451: }
7452: my $value = &docondval($sub_condition);
1.949 raeburn 7453: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 7454: return $value;
7455: }
1.620 albertel 7456: if ($env{'user.state.'.$env{'request.course.id'}}) {
7457: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 7458: } else {
7459: return 2;
7460: }
7461: }
7462:
1.713 albertel 7463: # get the collection of conditions for this resource
1.26 www 7464: sub condval {
7465: my $condidx=shift;
1.54 www 7466: my $allpathcond='';
1.713 albertel 7467: foreach my $cond (split(/\|/,$condidx)) {
7468: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7469: $allpathcond.=
7470: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7471: }
1.191 harris41 7472: }
1.54 www 7473: $allpathcond=~s/\|$//;
1.713 albertel 7474: return &docondval($allpathcond);
7475: }
7476:
7477: #evaluates an expression of conditions
7478: sub docondval {
7479: my ($allpathcond) = @_;
7480: my $result=0;
7481: if ($env{'request.course.id'}
7482: && defined($allpathcond)) {
7483: my $operand='|';
7484: my @stack;
7485: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7486: if ($chunk eq '(') {
7487: push @stack,($operand,$result);
7488: } elsif ($chunk eq ')') {
7489: my $before=pop @stack;
7490: if (pop @stack eq '&') {
7491: $result=$result>$before?$before:$result;
7492: } else {
7493: $result=$result>$before?$result:$before;
7494: }
7495: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7496: $operand=$chunk;
7497: } else {
7498: my $new=directcondval($chunk);
7499: if ($operand eq '&') {
7500: $result=$result>$new?$new:$result;
7501: } else {
7502: $result=$result>$new?$result:$new;
7503: }
7504: }
7505: }
1.26 www 7506: }
7507: return $result;
1.421 albertel 7508: }
7509:
7510: # ---------------------------------------------------- Devalidate courseresdata
7511:
7512: sub devalidatecourseresdata {
7513: my ($coursenum,$coursedomain)=@_;
7514: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7515: &devalidate_cache_new('courseres',$hashid);
1.28 www 7516: }
7517:
1.763 www 7518:
1.200 www 7519: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 7520: #
7521: # Parameters:
7522: # $coursenum - Number of the course.
7523: # $coursedomain - Domain at which the course was created.
7524: # Returns:
7525: # A hash of the course parameters along (I think) with timestamps
7526: # and version info.
1.877 foxr 7527:
1.624 albertel 7528: sub get_courseresdata {
7529: my ($coursenum,$coursedomain)=@_;
1.200 www 7530: my $coursehom=&homeserver($coursenum,$coursedomain);
7531: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7532: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 7533: my %dumpreply;
1.417 albertel 7534: unless (defined($cached)) {
1.624 albertel 7535: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 7536: $result=\%dumpreply;
1.251 albertel 7537: my ($tmp) = keys(%dumpreply);
7538: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 7539: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 7540: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7541: return $tmp;
1.416 albertel 7542: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 7543: $result=undef;
1.599 albertel 7544: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 7545: }
7546: }
1.624 albertel 7547: return $result;
7548: }
7549:
1.633 albertel 7550: sub devalidateuserresdata {
7551: my ($uname,$udom)=@_;
7552: my $hashid="$udom:$uname";
7553: &devalidate_cache_new('userres',$hashid);
7554: }
7555:
1.624 albertel 7556: sub get_userresdata {
7557: my ($uname,$udom)=@_;
7558: #most student don\'t have any data set, check if there is some data
7559: if (&EXT_cache_status($udom,$uname)) { return undef; }
7560:
7561: my $hashid="$udom:$uname";
7562: my ($result,$cached)=&is_cached_new('userres',$hashid);
7563: if (!defined($cached)) {
7564: my %resourcedata=&dump('resourcedata',$udom,$uname);
7565: $result=\%resourcedata;
7566: &do_cache_new('userres',$hashid,$result,600);
7567: }
7568: my ($tmp)=keys(%$result);
7569: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7570: return $result;
7571: }
7572: #error 2 occurs when the .db doesn't exist
7573: if ($tmp!~/error: 2 /) {
1.672 albertel 7574: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 7575: " Trying to get resource data for ".
7576: $uname." at ".$udom.": ".
7577: $tmp."</font>");
7578: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 7579: #&EXT_cache_set($udom,$uname);
7580: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 7581: undef($tmp); # not really an error so don't send it back
1.624 albertel 7582: }
7583: return $tmp;
7584: }
1.879 foxr 7585: #----------------------------------------------- resdata - return resource data
7586: # Purpose:
7587: # Return resource data for either users or for a course.
7588: # Parameters:
7589: # $name - Course/user name.
7590: # $domain - Name of the domain the user/course is registered on.
7591: # $type - Type of thing $name is (must be 'course' or 'user'
7592: # @which - Array of names of resources desired.
7593: # Returns:
7594: # The value of the first reasource in @which that is found in the
7595: # resource hash.
7596: # Exceptional Conditions:
7597: # If the $type passed in is not valid (not the string 'course' or
7598: # 'user', an undefined reference is returned.
7599: # If none of the resources are found, an undef is returned
1.624 albertel 7600: sub resdata {
7601: my ($name,$domain,$type,@which)=@_;
7602: my $result;
7603: if ($type eq 'course') {
7604: $result=&get_courseresdata($name,$domain);
7605: } elsif ($type eq 'user') {
7606: $result=&get_userresdata($name,$domain);
7607: }
7608: if (!ref($result)) { return $result; }
1.251 albertel 7609: foreach my $item (@which) {
1.927 albertel 7610: if (defined($result->{$item->[0]})) {
7611: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 7612: }
1.250 albertel 7613: }
1.291 albertel 7614: return undef;
1.200 www 7615: }
7616:
1.379 matthew 7617: #
7618: # EXT resource caching routines
7619: #
7620:
7621: sub clear_EXT_cache_status {
1.383 albertel 7622: &delenv('cache.EXT.');
1.379 matthew 7623: }
7624:
7625: sub EXT_cache_status {
7626: my ($target_domain,$target_user) = @_;
1.383 albertel 7627: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 7628: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 7629: # We know already the user has no data
7630: return 1;
7631: } else {
7632: return 0;
7633: }
7634: }
7635:
7636: sub EXT_cache_set {
7637: my ($target_domain,$target_user) = @_;
1.383 albertel 7638: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 7639: #&appenv({$cachename => time});
1.379 matthew 7640: }
7641:
1.28 www 7642: # --------------------------------------------------------- Value of a Variable
1.58 www 7643: sub EXT {
1.715 albertel 7644:
1.395 albertel 7645: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 7646: unless ($varname) { return ''; }
1.218 albertel 7647: #get real user name/domain, courseid and symb
7648: my $courseid;
1.359 albertel 7649: my $publicuser;
1.427 www 7650: if ($symbparm) {
7651: $symbparm=&get_symb_from_alias($symbparm);
7652: }
1.218 albertel 7653: if (!($uname && $udom)) {
1.790 albertel 7654: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 7655: if (!$symbparm) { $symbparm=$cursymb; }
7656: } else {
1.620 albertel 7657: $courseid=$env{'request.course.id'};
1.218 albertel 7658: }
1.48 www 7659: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7660: my $rest;
1.320 albertel 7661: if (defined($therest[0])) {
1.48 www 7662: $rest=join('.',@therest);
7663: } else {
7664: $rest='';
7665: }
1.320 albertel 7666:
1.57 www 7667: my $qualifierrest=$qualifier;
7668: if ($rest) { $qualifierrest.='.'.$rest; }
7669: my $spacequalifierrest=$space;
7670: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 7671: if ($realm eq 'user') {
1.48 www 7672: # --------------------------------------------------------------- user.resource
7673: if ($space eq 'resource') {
1.651 albertel 7674: if ( (defined($Apache::lonhomework::parsing_a_problem)
7675: || defined($Apache::lonhomework::parsing_a_task))
7676: &&
1.744 albertel 7677: ($symbparm eq &symbread()) ) {
7678: # if we are in the middle of processing the resource the
7679: # get the value we are planning on committing
7680: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7681: return $Apache::lonhomework::results{$qualifierrest};
7682: } else {
7683: return $Apache::lonhomework::history{$qualifierrest};
7684: }
1.335 albertel 7685: } else {
1.359 albertel 7686: my %restored;
1.620 albertel 7687: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 7688: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7689: } else {
7690: %restored=&restore($symbparm,$courseid,$udom,$uname);
7691: }
1.335 albertel 7692: return $restored{$qualifierrest};
7693: }
1.48 www 7694: # ----------------------------------------------------------------- user.access
7695: } elsif ($space eq 'access') {
1.218 albertel 7696: # FIXME - not supporting calls for a specific user
1.48 www 7697: return &allowed($qualifier,$rest);
7698: # ------------------------------------------ user.preferences, user.environment
7699: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 7700: if (($uname eq $env{'user.name'}) &&
7701: ($udom eq $env{'user.domain'})) {
7702: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 7703: } else {
1.359 albertel 7704: my %returnhash;
7705: if (!$publicuser) {
7706: %returnhash=&userenvironment($udom,$uname,
7707: $qualifierrest);
7708: }
1.218 albertel 7709: return $returnhash{$qualifierrest};
7710: }
1.48 www 7711: # ----------------------------------------------------------------- user.course
7712: } elsif ($space eq 'course') {
1.218 albertel 7713: # FIXME - not supporting calls for a specific user
1.620 albertel 7714: return $env{join('.',('request.course',$qualifier))};
1.48 www 7715: # ------------------------------------------------------------------- user.role
7716: } elsif ($space eq 'role') {
1.218 albertel 7717: # FIXME - not supporting calls for a specific user
1.620 albertel 7718: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 7719: if ($qualifier eq 'value') {
7720: return $role;
7721: } elsif ($qualifier eq 'extent') {
7722: return $where;
7723: }
7724: # ----------------------------------------------------------------- user.domain
7725: } elsif ($space eq 'domain') {
1.218 albertel 7726: return $udom;
1.48 www 7727: # ------------------------------------------------------------------- user.name
7728: } elsif ($space eq 'name') {
1.218 albertel 7729: return $uname;
1.48 www 7730: # ---------------------------------------------------- Any other user namespace
1.29 www 7731: } else {
1.359 albertel 7732: my %reply;
7733: if (!$publicuser) {
7734: %reply=&get($space,[$qualifierrest],$udom,$uname);
7735: }
7736: return $reply{$qualifierrest};
1.48 www 7737: }
1.236 www 7738: } elsif ($realm eq 'query') {
7739: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 7740: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7741: [$spacequalifierrest]);
1.620 albertel 7742: return $env{'form.'.$spacequalifierrest};
1.236 www 7743: } elsif ($realm eq 'request') {
1.48 www 7744: # ------------------------------------------------------------- request.browser
7745: if ($space eq 'browser') {
1.430 www 7746: if ($qualifier eq 'textremote') {
1.676 albertel 7747: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 7748: return 1;
7749: } else {
7750: return 0;
7751: }
7752: } else {
1.620 albertel 7753: return $env{'browser.'.$qualifier};
1.430 www 7754: }
1.57 www 7755: # ------------------------------------------------------------ request.filename
7756: } else {
1.620 albertel 7757: return $env{'request.'.$spacequalifierrest};
1.29 www 7758: }
1.28 www 7759: } elsif ($realm eq 'course') {
1.48 www 7760: # ---------------------------------------------------------- course.description
1.620 albertel 7761: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 7762: } elsif ($realm eq 'resource') {
1.165 www 7763:
1.620 albertel 7764: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 7765: if (!$symbparm) { $symbparm=&symbread(); }
7766: }
1.693 albertel 7767:
7768: if ($space eq 'title') {
7769: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7770: return &gettitle($symbparm);
7771: }
7772:
7773: if ($space eq 'map') {
7774: my ($map) = &decode_symb($symbparm);
7775: return &symbread($map);
7776: }
1.905 albertel 7777: if ($space eq 'filename') {
7778: if ($symbparm) {
7779: return &clutter((&decode_symb($symbparm))[2]);
7780: }
7781: return &hreflocation('',$env{'request.filename'});
7782: }
1.693 albertel 7783:
7784: my ($section, $group, @groups);
1.593 albertel 7785: my ($courselevelm,$courselevel);
1.539 albertel 7786: if ($symbparm && defined($courseid) &&
1.620 albertel 7787: $courseid eq $env{'request.course.id'}) {
1.165 www 7788:
1.218 albertel 7789: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 7790:
1.60 www 7791: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 7792: my $symbp=$symbparm;
1.735 albertel 7793: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 7794:
7795: my $symbparm=$symbp.'.'.$spacequalifierrest;
7796: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7797:
1.620 albertel 7798: if (($env{'user.name'} eq $uname) &&
7799: ($env{'user.domain'} eq $udom)) {
7800: $section=$env{'request.course.sec'};
1.733 raeburn 7801: @groups = split(/:/,$env{'request.course.groups'});
7802: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 7803: } else {
1.539 albertel 7804: if (! defined($usection)) {
1.551 albertel 7805: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 7806: } else {
7807: $section = $usection;
7808: }
1.733 raeburn 7809: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 7810: }
7811:
7812: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7813: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7814: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7815:
1.593 albertel 7816: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 7817: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 7818: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 7819:
1.60 www 7820: # ----------------------------------------------------------- first, check user
1.624 albertel 7821:
7822: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 7823: ([$courselevelr,'resource'],
7824: [$courselevelm,'map' ],
7825: [$courselevel, 'course' ]));
1.931 albertel 7826: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 7827:
1.594 albertel 7828: # ------------------------------------------------ second, check some of course
1.684 raeburn 7829: my $coursereply;
1.691 raeburn 7830: if (@groups > 0) {
7831: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7832: $mapparm,$spacequalifierrest);
1.927 albertel 7833: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 7834: }
1.96 www 7835:
1.684 raeburn 7836: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 7837: $env{'course.'.$courseid.'.domain'},
7838: 'course',
7839: ([$seclevelr, 'resource'],
7840: [$seclevelm, 'map' ],
7841: [$seclevel, 'course' ],
7842: [$courselevelr,'resource']));
7843: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 7844:
1.60 www 7845: # ------------------------------------------------------ third, check map parms
1.218 albertel 7846: my %parmhash=();
7847: my $thisparm='';
7848: if (tie(%parmhash,'GDBM_File',
1.620 albertel 7849: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 7850: &GDBM_READER(),0640)) {
1.218 albertel 7851: $thisparm=$parmhash{$symbparm};
7852: untie(%parmhash);
7853: }
1.927 albertel 7854: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 7855: }
1.594 albertel 7856: # ------------------------------------------ fourth, look in resource metadata
1.71 www 7857:
1.218 albertel 7858: $spacequalifierrest=~s/\./\_/;
1.282 albertel 7859: my $filename;
7860: if (!$symbparm) { $symbparm=&symbread(); }
7861: if ($symbparm) {
1.409 www 7862: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 7863: } else {
1.620 albertel 7864: $filename=$env{'request.filename'};
1.282 albertel 7865: }
7866: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 7867: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 7868: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 7869: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 7870:
1.927 albertel 7871: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 7872: if ($symbparm && defined($courseid) &&
1.620 albertel 7873: $courseid eq $env{'request.course.id'}) {
1.624 albertel 7874: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7875: $env{'course.'.$courseid.'.domain'},
7876: 'course',
1.927 albertel 7877: ([$courselevelm,'map' ],
7878: [$courselevel, 'course']));
7879: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 7880: }
1.145 www 7881: # ------------------------------------------------------------------ Cascade up
1.218 albertel 7882: unless ($space eq '0') {
1.336 albertel 7883: my @parts=split(/_/,$space);
7884: my $id=pop(@parts);
7885: my $part=join('_',@parts);
7886: if ($part eq '') { $part='0'; }
1.927 albertel 7887: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 7888: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 7889: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 7890: }
1.395 albertel 7891: if ($recurse) { return undef; }
7892: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 7893: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 7894: # ---------------------------------------------------- Any other user namespace
7895: } elsif ($realm eq 'environment') {
7896: # ----------------------------------------------------------------- environment
1.620 albertel 7897: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7898: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 7899: } else {
1.770 albertel 7900: if ($uname eq 'anonymous' && $udom eq '') {
7901: return '';
7902: }
1.219 albertel 7903: my %returnhash=&userenvironment($udom,$uname,
7904: $spacequalifierrest);
7905: return $returnhash{$spacequalifierrest};
7906: }
1.28 www 7907: } elsif ($realm eq 'system') {
1.48 www 7908: # ----------------------------------------------------------------- system.time
7909: if ($space eq 'time') {
7910: return time;
7911: }
1.696 albertel 7912: } elsif ($realm eq 'server') {
7913: # ----------------------------------------------------------------- system.time
7914: if ($space eq 'name') {
7915: return $ENV{'SERVER_NAME'};
7916: }
1.28 www 7917: }
1.48 www 7918: return '';
1.61 www 7919: }
7920:
1.927 albertel 7921: sub get_reply {
7922: my ($reply_value) = @_;
1.940 raeburn 7923: if (ref($reply_value) eq 'ARRAY') {
7924: if (wantarray) {
7925: return @$reply_value;
7926: }
7927: return $reply_value->[0];
7928: } else {
7929: return $reply_value;
1.927 albertel 7930: }
7931: }
7932:
1.691 raeburn 7933: sub check_group_parms {
7934: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
7935: my @groupitems = ();
7936: my $resultitem;
1.927 albertel 7937: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 7938: foreach my $group (@{$groups}) {
7939: foreach my $level (@levels) {
1.927 albertel 7940: my $item = $courseid.'.['.$group.'].'.$level->[0];
7941: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 7942: }
7943: }
7944: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
7945: $env{'course.'.$courseid.'.domain'},
7946: 'course',@groupitems);
7947: return $coursereply;
7948: }
7949:
7950: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 7951: my ($courseid,@groups) = @_;
7952: @groups = sort(@groups);
1.691 raeburn 7953: return @groups;
7954: }
7955:
1.395 albertel 7956: sub packages_tab_default {
7957: my ($uri,$varname)=@_;
7958: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 7959:
7960: my (@extension,@specifics,$do_default);
7961: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 7962: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 7963: if ($pack_type eq 'default') {
7964: $do_default=1;
7965: } elsif ($pack_type eq 'extension') {
7966: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 7967: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 7968: # only look at packages defaults for packages that this id is
1.738 albertel 7969: push(@specifics,[$package,$pack_type,$pack_part]);
7970: }
7971: }
7972: # first look for a package that matches the requested part id
7973: foreach my $package (@specifics) {
7974: my (undef,$pack_type,$pack_part)=@{$package};
7975: next if ($pack_part ne $part);
7976: if (defined($packagetab{"$pack_type&$name&default"})) {
7977: return $packagetab{"$pack_type&$name&default"};
7978: }
7979: }
7980: # look for any possible matching non extension_ package
7981: foreach my $package (@specifics) {
7982: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 7983: if (defined($packagetab{"$pack_type&$name&default"})) {
7984: return $packagetab{"$pack_type&$name&default"};
7985: }
1.585 albertel 7986: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 7987: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
7988: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 7989: }
7990: }
1.738 albertel 7991: # look for any posible extension_ match
7992: foreach my $package (@extension) {
7993: my ($package,$pack_type)=@{$package};
7994: if (defined($packagetab{"$pack_type&$name&default"})) {
7995: return $packagetab{"$pack_type&$name&default"};
7996: }
7997: if (defined($packagetab{$package."&$name&default"})) {
7998: return $packagetab{$package."&$name&default"};
7999: }
8000: }
8001: # look for a global default setting
8002: if ($do_default && defined($packagetab{"default&$name&default"})) {
8003: return $packagetab{"default&$name&default"};
8004: }
1.395 albertel 8005: return undef;
8006: }
8007:
1.334 albertel 8008: sub add_prefix_and_part {
8009: my ($prefix,$part)=@_;
8010: my $keyroot;
8011: if (defined($prefix) && $prefix !~ /^__/) {
8012: # prefix that has a part already
8013: $keyroot=$prefix;
8014: } elsif (defined($prefix)) {
8015: # prefix that is missing a part
8016: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8017: } else {
8018: # no prefix at all
8019: if (defined($part)) { $keyroot='_'.$part; }
8020: }
8021: return $keyroot;
8022: }
8023:
1.71 www 8024: # ---------------------------------------------------------------- Get metadata
8025:
1.599 albertel 8026: my %metaentry;
1.71 www 8027: sub metadata {
1.176 www 8028: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 8029: $uri=&declutter($uri);
1.288 albertel 8030: # if it is a non metadata possible uri return quickly
1.529 albertel 8031: if (($uri eq '') ||
8032: (($uri =~ m|^/*adm/|) &&
1.698 albertel 8033: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 albertel 8034: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8035: return undef;
8036: }
8037: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8038: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 8039: return undef;
1.288 albertel 8040: }
1.73 www 8041: my $filename=$uri;
8042: $uri=~s/\.meta$//;
1.172 www 8043: #
8044: # Is the metadata already cached?
1.177 www 8045: # Look at timestamp of caching
1.172 www 8046: # Everything is cached by the main uri, libraries are never directly cached
8047: #
1.428 albertel 8048: if (!defined($liburi)) {
1.599 albertel 8049: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 8050: if (defined($cached)) { return $result->{':'.$what}; }
8051: }
8052: {
1.172 www 8053: #
8054: # Is this a recursive call for a library?
8055: #
1.599 albertel 8056: # if (! exists($metacache{$uri})) {
8057: # $metacache{$uri}={};
8058: # }
1.924 albertel 8059: my $cachetime = 60*60;
1.171 www 8060: if ($liburi) {
8061: $liburi=&declutter($liburi);
8062: $filename=$liburi;
1.401 bowersj2 8063: } else {
1.599 albertel 8064: &devalidate_cache_new('meta',$uri);
8065: undef(%metaentry);
1.401 bowersj2 8066: }
1.140 www 8067: my %metathesekeys=();
1.73 www 8068: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 8069: my $metastring;
1.924 albertel 8070: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929 albertel 8071: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 8072: $metastring =
1.929 albertel 8073: &Apache::lonnet::ssi_body($which,
1.924 albertel 8074: ('grade_target' => 'meta'));
8075: $cachetime = 1; # only want this cached in the child not long term
8076: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 8077: my $file=&filelocation('',&clutter($filename));
1.599 albertel 8078: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 8079: $metastring=&getfile($file);
1.489 albertel 8080: }
1.208 albertel 8081: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 8082: my $token;
1.140 www 8083: undef %metathesekeys;
1.71 www 8084: while ($token=$parser->get_token) {
1.339 albertel 8085: if ($token->[0] eq 'S') {
8086: if (defined($token->[2]->{'package'})) {
1.172 www 8087: #
8088: # This is a package - get package info
8089: #
1.339 albertel 8090: my $package=$token->[2]->{'package'};
8091: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8092: if (defined($token->[2]->{'id'})) {
8093: $keyroot.='_'.$token->[2]->{'id'};
8094: }
1.599 albertel 8095: if ($metaentry{':packages'}) {
8096: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 8097: } else {
1.599 albertel 8098: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 8099: }
1.736 albertel 8100: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 8101: my $part=$keyroot;
8102: $part=~s/^\_//;
1.736 albertel 8103: if ($pack_entry=~/^\Q$package\E\&/ ||
8104: $pack_entry=~/^\Q$package\E_0\&/) {
8105: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 8106: # ignore package.tab specified default values
8107: # here &package_tab_default() will fetch those
8108: if ($subp eq 'default') { next; }
1.736 albertel 8109: my $value=$packagetab{$pack_entry};
1.432 albertel 8110: my $unikey;
8111: if ($pack =~ /_0$/) {
8112: $unikey='parameter_0_'.$name;
8113: $part=0;
8114: } else {
8115: $unikey='parameter'.$keyroot.'_'.$name;
8116: }
1.339 albertel 8117: if ($subp eq 'display') {
8118: $value.=' [Part: '.$part.']';
8119: }
1.599 albertel 8120: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 8121: $metathesekeys{$unikey}=1;
1.599 albertel 8122: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8123: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 8124: }
1.599 albertel 8125: if (defined($metaentry{':'.$unikey.'.default'})) {
8126: $metaentry{':'.$unikey}=
8127: $metaentry{':'.$unikey.'.default'};
1.356 albertel 8128: }
1.339 albertel 8129: }
8130: }
8131: } else {
1.172 www 8132: #
8133: # This is not a package - some other kind of start tag
1.339 albertel 8134: #
8135: my $entry=$token->[1];
8136: my $unikey;
8137: if ($entry eq 'import') {
8138: $unikey='';
8139: } else {
8140: $unikey=$entry;
8141: }
8142: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8143:
8144: if (defined($token->[2]->{'id'})) {
8145: $unikey.='_'.$token->[2]->{'id'};
8146: }
1.175 www 8147:
1.339 albertel 8148: if ($entry eq 'import') {
1.175 www 8149: #
8150: # Importing a library here
1.339 albertel 8151: #
8152: if ($depthcount<20) {
8153: my $location=$parser->get_text('/import');
8154: my $dir=$filename;
8155: $dir=~s|[^/]*$||;
8156: $location=&filelocation($dir,$location);
1.736 albertel 8157: my $metadata =
8158: &metadata($uri,'keys', $location,$unikey,
8159: $depthcount+1);
8160: foreach my $meta (split(',',$metadata)) {
8161: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8162: $metathesekeys{$meta}=1;
1.339 albertel 8163: }
8164: }
8165: } else {
8166:
8167: if (defined($token->[2]->{'name'})) {
8168: $unikey.='_'.$token->[2]->{'name'};
8169: }
8170: $metathesekeys{$unikey}=1;
1.736 albertel 8171: foreach my $param (@{$token->[3]}) {
8172: $metaentry{':'.$unikey.'.'.$param} =
8173: $token->[2]->{$param};
1.339 albertel 8174: }
8175: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 8176: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 8177: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8178: # only ws inside the tag, and not in default, so use default
8179: # as value
1.599 albertel 8180: $metaentry{':'.$unikey}=$default;
1.908 albertel 8181: } elsif ( $internaltext =~ /\S/ ) {
8182: # something interesting inside the tag
8183: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 8184: } else {
1.908 albertel 8185: # no interesting values, don't set a default
1.339 albertel 8186: }
1.172 www 8187: # end of not-a-package not-a-library import
1.339 albertel 8188: }
1.172 www 8189: # end of not-a-package start tag
1.339 albertel 8190: }
1.172 www 8191: # the next is the end of "start tag"
1.339 albertel 8192: }
8193: }
1.483 albertel 8194: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 8195: $extension = lc($extension);
8196: if ($extension eq 'htm') { $extension='html'; }
8197:
1.737 albertel 8198: foreach my $key (keys(%packagetab)) {
1.483 albertel 8199: #no specific packages #how's our extension
8200: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 8201: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 8202: \%metathesekeys);
8203: }
1.883 albertel 8204:
8205: if (!exists($metaentry{':packages'})
8206: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 8207: foreach my $key (keys(%packagetab)) {
1.483 albertel 8208: #no specific packages well let's get default then
8209: if ($key!~/^default&/) { next; }
1.488 albertel 8210: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 8211: \%metathesekeys);
8212: }
8213: }
1.338 www 8214: # are there custom rights to evaluate
1.599 albertel 8215: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 8216:
1.338 www 8217: #
8218: # Importing a rights file here
1.339 albertel 8219: #
8220: unless ($depthcount) {
1.599 albertel 8221: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 8222: my $dir=$filename;
8223: $dir=~s|[^/]*$||;
8224: $location=&filelocation($dir,$location);
1.736 albertel 8225: my $rights_metadata =
8226: &metadata($uri,'keys',$location,'_rights',
8227: $depthcount+1);
8228: foreach my $rights (split(',',$rights_metadata)) {
8229: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8230: $metathesekeys{$rights}=1;
1.339 albertel 8231: }
8232: }
8233: }
1.737 albertel 8234: # uniqifiy package listing
8235: my %seen;
8236: my @uniq_packages =
8237: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8238: $metaentry{':packages'} = join(',',@uniq_packages);
8239:
8240: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 8241: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8242: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 8243: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 8244: # this is the end of "was not already recently cached
1.71 www 8245: }
1.599 albertel 8246: return $metaentry{':'.$what};
1.261 albertel 8247: }
8248:
1.488 albertel 8249: sub metadata_create_package_def {
1.483 albertel 8250: my ($uri,$key,$package,$metathesekeys)=@_;
8251: my ($pack,$name,$subp)=split(/\&/,$key);
8252: if ($subp eq 'default') { next; }
8253:
1.599 albertel 8254: if (defined($metaentry{':packages'})) {
8255: $metaentry{':packages'}.=','.$package;
1.483 albertel 8256: } else {
1.599 albertel 8257: $metaentry{':packages'}=$package;
1.483 albertel 8258: }
8259: my $value=$packagetab{$key};
8260: my $unikey;
8261: $unikey='parameter_0_'.$name;
1.599 albertel 8262: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 8263: $$metathesekeys{$unikey}=1;
1.599 albertel 8264: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8265: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 8266: }
1.599 albertel 8267: if (defined($metaentry{':'.$unikey.'.default'})) {
8268: $metaentry{':'.$unikey}=
8269: $metaentry{':'.$unikey.'.default'};
1.483 albertel 8270: }
8271: }
8272:
1.261 albertel 8273: sub metadata_generate_part0 {
8274: my ($metadata,$metacache,$uri) = @_;
8275: my %allnames;
1.737 albertel 8276: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 8277: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 8278: my $part=$$metacache{':'.$metakey.'.part'};
8279: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 8280: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 8281: $allnames{$name}=$part;
8282: }
8283: }
8284: }
8285: foreach my $name (keys(%allnames)) {
8286: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 8287: my $key=":parameter_0_$name";
1.261 albertel 8288: $$metacache{"$key.part"}='0';
8289: $$metacache{"$key.name"}=$name;
1.428 albertel 8290: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 8291: $allnames{$name}.'_'.$name.
8292: '.type'};
1.428 albertel 8293: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 8294: '.display'};
1.644 www 8295: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 8296: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 8297: $$metacache{"$key.display"}=$olddis;
8298: }
1.71 www 8299: }
8300:
1.764 albertel 8301: # ------------------------------------------------------ Devalidate title cache
8302:
8303: sub devalidate_title_cache {
8304: my ($url)=@_;
8305: if (!$env{'request.course.id'}) { return; }
8306: my $symb=&symbread($url);
8307: if (!$symb) { return; }
8308: my $key=$env{'request.course.id'}."\0".$symb;
8309: &devalidate_cache_new('title',$key);
8310: }
8311:
1.1014 droeschl 8312: # ------------------------------------------------- Get the title of a course
8313:
8314: sub current_course_title {
8315: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8316: }
1.301 www 8317: # ------------------------------------------------- Get the title of a resource
8318:
8319: sub gettitle {
8320: my $urlsymb=shift;
8321: my $symb=&symbread($urlsymb);
1.534 albertel 8322: if ($symb) {
1.620 albertel 8323: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 8324: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 8325: if (defined($cached)) {
8326: return $result;
8327: }
1.534 albertel 8328: my ($map,$resid,$url)=&decode_symb($symb);
8329: my $title='';
1.907 albertel 8330: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8331: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8332: } else {
8333: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8334: &GDBM_READER(),0640)) {
8335: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8336: $title=$bighash{'title_'.$mapid.'.'.$resid};
8337: untie(%bighash);
8338: }
1.534 albertel 8339: }
8340: $title=~s/\&colon\;/\:/gs;
8341: if ($title) {
1.599 albertel 8342: return &do_cache_new('title',$key,$title,600);
1.534 albertel 8343: }
8344: $urlsymb=$url;
8345: }
8346: my $title=&metadata($urlsymb,'title');
8347: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8348: return $title;
1.301 www 8349: }
1.613 albertel 8350:
1.614 albertel 8351: sub get_slot {
8352: my ($which,$cnum,$cdom)=@_;
8353: if (!$cnum || !$cdom) {
1.790 albertel 8354: (undef,my $courseid)=&whichuser();
1.620 albertel 8355: $cdom=$env{'course.'.$courseid.'.domain'};
8356: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 8357: }
1.703 albertel 8358: my $key=join("\0",'slots',$cdom,$cnum,$which);
8359: my %slotinfo;
8360: if (exists($remembered{$key})) {
8361: $slotinfo{$which} = $remembered{$key};
8362: } else {
8363: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8364: &Apache::lonhomework::showhash(%slotinfo);
8365: my ($tmp)=keys(%slotinfo);
8366: if ($tmp=~/^error:/) { return (); }
8367: $remembered{$key} = $slotinfo{$which};
8368: }
1.616 albertel 8369: if (ref($slotinfo{$which}) eq 'HASH') {
8370: return %{$slotinfo{$which}};
8371: }
8372: return $slotinfo{$which};
1.614 albertel 8373: }
1.31 www 8374: # ------------------------------------------------- Update symbolic store links
8375:
8376: sub symblist {
8377: my ($mapname,%newhash)=@_;
1.438 www 8378: $mapname=&deversion(&declutter($mapname));
1.31 www 8379: my %hash;
1.620 albertel 8380: if (($env{'request.course.fn'}) && (%newhash)) {
8381: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8382: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 8383: foreach my $url (keys(%newhash)) {
1.711 albertel 8384: next if ($url eq 'last_known'
8385: && $env{'form.no_update_last_known'});
8386: $hash{declutter($url)}=&encode_symb($mapname,
8387: $newhash{$url}->[1],
8388: $newhash{$url}->[0]);
1.191 harris41 8389: }
1.31 www 8390: if (untie(%hash)) {
8391: return 'ok';
8392: }
8393: }
8394: }
8395: return 'error';
1.212 www 8396: }
8397:
8398: # --------------------------------------------------------------- Verify a symb
8399:
8400: sub symbverify {
1.510 www 8401: my ($symb,$thisurl)=@_;
8402: my $thisfn=$thisurl;
1.439 www 8403: $thisfn=&declutter($thisfn);
1.215 www 8404: # direct jump to resource in page or to a sequence - will construct own symbs
8405: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8406: # check URL part
1.409 www 8407: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 8408:
1.431 www 8409: unless ($url eq $thisfn) { return 0; }
1.213 www 8410:
1.216 www 8411: $symb=&symbclean($symb);
1.510 www 8412: $thisurl=&deversion($thisurl);
1.439 www 8413: $thisfn=&deversion($thisfn);
1.213 www 8414:
8415: my %bighash;
8416: my $okay=0;
1.431 www 8417:
1.620 albertel 8418: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8419: &GDBM_READER(),0640)) {
1.1032 raeburn 8420: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8421: $thisurl =~ s/\?.+$//;
8422: }
1.510 www 8423: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 8424: unless ($ids) {
1.510 www 8425: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 8426: }
8427: if ($ids) {
8428: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 8429: foreach my $id (split(/\,/,$ids)) {
8430: my ($mapid,$resid)=split(/\./,$id);
1.1032 raeburn 8431: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8432: $symb =~ s/\?.+$//;
8433: }
1.216 www 8434: if (
8435: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8436: eq $symb) {
1.620 albertel 8437: if (($env{'request.role.adv'}) ||
1.800 albertel 8438: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 8439: $okay=1;
8440: }
8441: }
1.216 www 8442: }
8443: }
1.213 www 8444: untie(%bighash);
8445: }
8446: return $okay;
1.31 www 8447: }
8448:
1.210 www 8449: # --------------------------------------------------------------- Clean-up symb
8450:
8451: sub symbclean {
8452: my $symb=shift;
1.568 albertel 8453: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 8454: # remove version from map
8455: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 8456:
1.210 www 8457: # remove version from URL
8458: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 8459:
1.507 www 8460: # remove wrapper
8461:
1.510 www 8462: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 8463: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 8464: return $symb;
1.409 www 8465: }
8466:
8467: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 8468:
8469: sub encode_symb {
8470: my ($map,$resid,$url)=@_;
8471: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8472: }
1.409 www 8473:
8474: sub decode_symb {
1.568 albertel 8475: my $symb=shift;
8476: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8477: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 8478: return (&fixversion($map),$resid,&fixversion($url));
8479: }
8480:
8481: sub fixversion {
8482: my $fn=shift;
1.609 banghart 8483: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 8484: my %bighash;
8485: my $uri=&clutter($fn);
1.620 albertel 8486: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 8487: # is this cached?
1.599 albertel 8488: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 8489: if (defined($cached)) { return $result; }
8490: # unfortunately not cached, or expired
1.620 albertel 8491: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 8492: &GDBM_READER(),0640)) {
8493: if ($bighash{'version_'.$uri}) {
8494: my $version=$bighash{'version_'.$uri};
1.444 www 8495: unless (($version eq 'mostrecent') ||
8496: ($version==&getversion($uri))) {
1.440 www 8497: $uri=~s/\.(\w+)$/\.$version\.$1/;
8498: }
8499: }
8500: untie %bighash;
1.413 www 8501: }
1.599 albertel 8502: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 8503: }
8504:
8505: sub deversion {
8506: my $url=shift;
8507: $url=~s/\.\d+\.(\w+)$/\.$1/;
8508: return $url;
1.210 www 8509: }
8510:
1.31 www 8511: # ------------------------------------------------------ Return symb list entry
8512:
8513: sub symbread {
1.249 www 8514: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 8515: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 8516: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 8517: # no filename provided? try from environment
1.44 www 8518: unless ($thisfn) {
1.620 albertel 8519: if ($env{'request.symb'}) {
8520: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 8521: }
1.620 albertel 8522: $thisfn=$env{'request.filename'};
1.44 www 8523: }
1.569 albertel 8524: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 8525: # is that filename actually a symb? Verify, clean, and return
8526: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 8527: if (&symbverify($thisfn,$1)) {
1.620 albertel 8528: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 8529: }
1.242 www 8530: }
1.44 www 8531: $thisfn=declutter($thisfn);
1.31 www 8532: my %hash;
1.37 www 8533: my %bighash;
8534: my $syval='';
1.620 albertel 8535: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 8536: my $targetfn = $thisfn;
1.609 banghart 8537: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 8538: $targetfn = 'adm/wrapper/'.$thisfn;
8539: }
1.687 albertel 8540: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8541: $targetfn=$1;
8542: }
1.620 albertel 8543: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8544: &GDBM_READER(),0640)) {
1.481 raeburn 8545: $syval=$hash{$targetfn};
1.37 www 8546: untie(%hash);
8547: }
8548: # ---------------------------------------------------------- There was an entry
8549: if ($syval) {
1.601 albertel 8550: #unless ($syval=~/\_\d+$/) {
1.620 albertel 8551: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 8552: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8553: #return $env{$cache_str}='';
1.601 albertel 8554: #}
8555: #$syval.=$1;
8556: #}
1.37 www 8557: } else {
8558: # ------------------------------------------------------- Was not in symb table
1.620 albertel 8559: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8560: &GDBM_READER(),0640)) {
1.37 www 8561: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 8562: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 8563: unless ($ids) {
8564: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 8565: }
8566: unless ($ids) {
8567: # alias?
8568: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 8569: }
1.37 www 8570: if ($ids) {
8571: # ------------------------------------------------------------------- Has ID(s)
8572: my @possibilities=split(/\,/,$ids);
1.39 www 8573: if ($#possibilities==0) {
8574: # ----------------------------------------------- There is only one possibility
1.37 www 8575: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 8576: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8577: $resid,$thisfn);
1.249 www 8578: } elsif (!$donotrecurse) {
1.39 www 8579: # ------------------------------------------ There is more than one possibility
8580: my $realpossible=0;
1.800 albertel 8581: foreach my $id (@possibilities) {
8582: my $file=$bighash{'src_'.$id};
1.39 www 8583: if (&allowed('bre',$file)) {
1.800 albertel 8584: my ($mapid,$resid)=split(/\./,$id);
1.39 www 8585: if ($bighash{'map_type_'.$mapid} ne 'page') {
8586: $realpossible++;
1.626 albertel 8587: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8588: $resid,$thisfn);
1.39 www 8589: }
8590: }
1.191 harris41 8591: }
1.39 www 8592: if ($realpossible!=1) { $syval=''; }
1.249 www 8593: } else {
8594: $syval='';
1.37 www 8595: }
8596: }
8597: untie(%bighash)
1.481 raeburn 8598: }
1.31 www 8599: }
1.62 www 8600: if ($syval) {
1.620 albertel 8601: return $env{$cache_str}=$syval;
1.62 www 8602: }
1.31 www 8603: }
1.949 raeburn 8604: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8605: return $env{$cache_str}='';
1.31 www 8606: }
8607:
8608: # ---------------------------------------------------------- Return random seed
8609:
1.32 www 8610: sub numval {
8611: my $txt=shift;
8612: $txt=~tr/A-J/0-9/;
8613: $txt=~tr/a-j/0-9/;
8614: $txt=~tr/K-T/0-9/;
8615: $txt=~tr/k-t/0-9/;
8616: $txt=~tr/U-Z/0-5/;
8617: $txt=~tr/u-z/0-5/;
8618: $txt=~s/\D//g;
1.564 albertel 8619: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 8620: return int($txt);
1.368 albertel 8621: }
8622:
1.484 albertel 8623: sub numval2 {
8624: my $txt=shift;
8625: $txt=~tr/A-J/0-9/;
8626: $txt=~tr/a-j/0-9/;
8627: $txt=~tr/K-T/0-9/;
8628: $txt=~tr/k-t/0-9/;
8629: $txt=~tr/U-Z/0-5/;
8630: $txt=~tr/u-z/0-5/;
8631: $txt=~s/\D//g;
8632: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8633: my $total;
8634: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 8635: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 8636: return int($total);
8637: }
8638:
1.575 albertel 8639: sub numval3 {
8640: use integer;
8641: my $txt=shift;
8642: $txt=~tr/A-J/0-9/;
8643: $txt=~tr/a-j/0-9/;
8644: $txt=~tr/K-T/0-9/;
8645: $txt=~tr/k-t/0-9/;
8646: $txt=~tr/U-Z/0-5/;
8647: $txt=~tr/u-z/0-5/;
8648: $txt=~s/\D//g;
8649: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8650: my $total;
8651: foreach my $val (@txts) { $total+=$val; }
8652: if ($_64bit) { $total=(($total<<32)>>32); }
8653: return $total;
8654: }
8655:
1.675 albertel 8656: sub digest {
8657: my ($data)=@_;
8658: my $digest=&Digest::MD5::md5($data);
8659: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8660: my ($e,$f);
8661: {
8662: use integer;
8663: $e=($a+$b);
8664: $f=($c+$d);
8665: if ($_64bit) {
8666: $e=(($e<<32)>>32);
8667: $f=(($f<<32)>>32);
8668: }
8669: }
8670: if (wantarray) {
8671: return ($e,$f);
8672: } else {
8673: my $g;
8674: {
8675: use integer;
8676: $g=($e+$f);
8677: if ($_64bit) {
8678: $g=(($g<<32)>>32);
8679: }
8680: }
8681: return $g;
8682: }
8683: }
8684:
1.368 albertel 8685: sub latest_rnd_algorithm_id {
1.675 albertel 8686: return '64bit5';
1.366 albertel 8687: }
1.32 www 8688:
1.503 albertel 8689: sub get_rand_alg {
8690: my ($courseid)=@_;
1.790 albertel 8691: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 8692: if ($courseid) {
1.620 albertel 8693: return $env{"course.$courseid.rndseed"};
1.503 albertel 8694: }
8695: return &latest_rnd_algorithm_id();
8696: }
8697:
1.562 albertel 8698: sub validCODE {
8699: my ($CODE)=@_;
8700: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8701: return 0;
8702: }
8703:
1.491 albertel 8704: sub getCODE {
1.620 albertel 8705: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 8706: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8707: defined($Apache::lonhomework::parsing_a_task) ) &&
8708: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 8709: return $Apache::lonhomework::history{'resource.CODE'};
8710: }
8711: return undef;
8712: }
8713:
1.31 www 8714: sub rndseed {
1.155 albertel 8715: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 8716: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 8717: if (!defined($symb)) {
1.366 albertel 8718: unless ($symb=$wsymb) { return time; }
8719: }
8720: if (!$courseid) { $courseid=$wcourseid; }
8721: if (!$domain) { $domain=$wdomain; }
8722: if (!$username) { $username=$wusername }
1.503 albertel 8723: my $which=&get_rand_alg();
1.803 albertel 8724:
1.491 albertel 8725: if (defined(&getCODE())) {
1.675 albertel 8726: if ($which eq '64bit5') {
8727: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8728: } elsif ($which eq '64bit4') {
1.575 albertel 8729: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8730: } else {
8731: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8732: }
1.675 albertel 8733: } elsif ($which eq '64bit5') {
8734: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 8735: } elsif ($which eq '64bit4') {
8736: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 8737: } elsif ($which eq '64bit3') {
8738: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 8739: } elsif ($which eq '64bit2') {
8740: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 8741: } elsif ($which eq '64bit') {
8742: return &rndseed_64bit($symb,$courseid,$domain,$username);
8743: }
8744: return &rndseed_32bit($symb,$courseid,$domain,$username);
8745: }
8746:
8747: sub rndseed_32bit {
8748: my ($symb,$courseid,$domain,$username)=@_;
8749: {
8750: use integer;
8751: my $symbchck=unpack("%32C*",$symb) << 27;
8752: my $symbseed=numval($symb) << 22;
8753: my $namechck=unpack("%32C*",$username) << 17;
8754: my $nameseed=numval($username) << 12;
8755: my $domainseed=unpack("%32C*",$domain) << 7;
8756: my $courseseed=unpack("%32C*",$courseid);
8757: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 8758: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8759: #&logthis("rndseed :$num:$symb");
1.564 albertel 8760: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 8761: return $num;
8762: }
8763: }
8764:
8765: sub rndseed_64bit {
8766: my ($symb,$courseid,$domain,$username)=@_;
8767: {
8768: use integer;
8769: my $symbchck=unpack("%32S*",$symb) << 21;
8770: my $symbseed=numval($symb) << 10;
8771: my $namechck=unpack("%32S*",$username);
8772:
8773: my $nameseed=numval($username) << 21;
8774: my $domainseed=unpack("%32S*",$domain) << 10;
8775: my $courseseed=unpack("%32S*",$courseid);
8776:
8777: my $num1=$symbchck+$symbseed+$namechck;
8778: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8779: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8780: #&logthis("rndseed :$num:$symb");
1.564 albertel 8781: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 8782: return "$num1,$num2";
1.155 albertel 8783: }
1.366 albertel 8784: }
8785:
1.443 albertel 8786: sub rndseed_64bit2 {
8787: my ($symb,$courseid,$domain,$username)=@_;
8788: {
8789: use integer;
8790: # strings need to be an even # of cahracters long, it it is odd the
8791: # last characters gets thrown away
8792: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8793: my $symbseed=numval($symb) << 10;
8794: my $namechck=unpack("%32S*",$username.' ');
8795:
8796: my $nameseed=numval($username) << 21;
1.501 albertel 8797: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8798: my $courseseed=unpack("%32S*",$courseid.' ');
8799:
8800: my $num1=$symbchck+$symbseed+$namechck;
8801: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8802: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8803: #&logthis("rndseed :$num:$symb");
1.803 albertel 8804: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 8805: return "$num1,$num2";
8806: }
8807: }
8808:
8809: sub rndseed_64bit3 {
8810: my ($symb,$courseid,$domain,$username)=@_;
8811: {
8812: use integer;
8813: # strings need to be an even # of cahracters long, it it is odd the
8814: # last characters gets thrown away
8815: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8816: my $symbseed=numval2($symb) << 10;
8817: my $namechck=unpack("%32S*",$username.' ');
8818:
8819: my $nameseed=numval2($username) << 21;
1.443 albertel 8820: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8821: my $courseseed=unpack("%32S*",$courseid.' ');
8822:
8823: my $num1=$symbchck+$symbseed+$namechck;
8824: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8825: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8826: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 8827: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8828:
1.503 albertel 8829: return "$num1:$num2";
1.443 albertel 8830: }
8831: }
8832:
1.575 albertel 8833: sub rndseed_64bit4 {
8834: my ($symb,$courseid,$domain,$username)=@_;
8835: {
8836: use integer;
8837: # strings need to be an even # of cahracters long, it it is odd the
8838: # last characters gets thrown away
8839: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8840: my $symbseed=numval3($symb) << 10;
8841: my $namechck=unpack("%32S*",$username.' ');
8842:
8843: my $nameseed=numval3($username) << 21;
8844: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8845: my $courseseed=unpack("%32S*",$courseid.' ');
8846:
8847: my $num1=$symbchck+$symbseed+$namechck;
8848: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8849: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8850: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 8851: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8852:
8853: return "$num1:$num2";
8854: }
8855: }
8856:
1.675 albertel 8857: sub rndseed_64bit5 {
8858: my ($symb,$courseid,$domain,$username)=@_;
8859: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8860: return "$num1:$num2";
8861: }
8862:
1.366 albertel 8863: sub rndseed_CODE_64bit {
8864: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 8865: {
1.366 albertel 8866: use integer;
1.443 albertel 8867: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 8868: my $symbseed=numval2($symb);
1.491 albertel 8869: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8870: my $CODEseed=numval(&getCODE());
1.443 albertel 8871: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 8872: my $num1=$symbseed+$CODEchck;
8873: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8874: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8875: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 8876: if ($_64bit) { $num1=(($num1<<32)>>32); }
8877: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 8878: return "$num1:$num2";
1.366 albertel 8879: }
8880: }
8881:
1.575 albertel 8882: sub rndseed_CODE_64bit4 {
8883: my ($symb,$courseid,$domain,$username)=@_;
8884: {
8885: use integer;
8886: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8887: my $symbseed=numval3($symb);
8888: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8889: my $CODEseed=numval3(&getCODE());
8890: my $courseseed=unpack("%32S*",$courseid.' ');
8891: my $num1=$symbseed+$CODEchck;
8892: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8893: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8894: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 8895: if ($_64bit) { $num1=(($num1<<32)>>32); }
8896: if ($_64bit) { $num2=(($num2<<32)>>32); }
8897: return "$num1:$num2";
8898: }
8899: }
8900:
1.675 albertel 8901: sub rndseed_CODE_64bit5 {
8902: my ($symb,$courseid,$domain,$username)=@_;
8903: my $code = &getCODE();
8904: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8905: return "$num1:$num2";
8906: }
8907:
1.366 albertel 8908: sub setup_random_from_rndseed {
8909: my ($rndseed)=@_;
1.503 albertel 8910: if ($rndseed =~/([,:])/) {
8911: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 8912: &Math::Random::random_set_seed(abs($num1),abs($num2));
8913: } else {
8914: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 8915: }
1.36 albertel 8916: }
8917:
1.474 albertel 8918: sub latest_receipt_algorithm_id {
1.835 albertel 8919: return 'receipt3';
1.474 albertel 8920: }
8921:
1.480 www 8922: sub recunique {
8923: my $fucourseid=shift;
8924: my $unique;
1.835 albertel 8925: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
8926: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 8927: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 8928: } else {
8929: $unique=$perlvar{'lonReceipt'};
8930: }
8931: return unpack("%32C*",$unique);
8932: }
8933:
8934: sub recprefix {
8935: my $fucourseid=shift;
8936: my $prefix;
1.835 albertel 8937: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
8938: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 8939: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 8940: } else {
8941: $prefix=$perlvar{'lonHostID'};
8942: }
8943: return unpack("%32C*",$prefix);
8944: }
8945:
1.76 www 8946: sub ireceipt {
1.474 albertel 8947: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 8948:
8949: my $return =&recprefix($fucourseid).'-';
8950:
8951: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
8952: $env{'request.state'} eq 'construct') {
8953: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
8954: return $return;
8955: }
8956:
1.76 www 8957: my $cuname=unpack("%32C*",$funame);
8958: my $cudom=unpack("%32C*",$fudom);
8959: my $cucourseid=unpack("%32C*",$fucourseid);
8960: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 8961: my $cunique=&recunique($fucourseid);
1.474 albertel 8962: my $cpart=unpack("%32S*",$part);
1.835 albertel 8963: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
8964:
1.790 albertel 8965: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 8966:
8967: $return.= ($cunique%$cuname+
8968: $cunique%$cudom+
8969: $cusymb%$cuname+
8970: $cusymb%$cudom+
8971: $cucourseid%$cuname+
8972: $cucourseid%$cudom+
8973: $cpart%$cuname+
8974: $cpart%$cudom);
8975: } else {
8976: $return.= ($cunique%$cuname+
8977: $cunique%$cudom+
8978: $cusymb%$cuname+
8979: $cusymb%$cudom+
8980: $cucourseid%$cuname+
8981: $cucourseid%$cudom);
8982: }
8983: return $return;
1.76 www 8984: }
8985:
8986: sub receipt {
1.474 albertel 8987: my ($part)=@_;
1.790 albertel 8988: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 8989: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 8990: }
1.260 ng 8991:
1.790 albertel 8992: sub whichuser {
8993: my ($passedsymb)=@_;
8994: my ($symb,$courseid,$domain,$name,$publicuser);
8995: if (defined($env{'form.grade_symb'})) {
8996: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
8997: my $allowed=&allowed('vgr',$tmp_courseid);
8998: if (!$allowed &&
8999: exists($env{'request.course.sec'}) &&
9000: $env{'request.course.sec'} !~ /^\s*$/) {
9001: $allowed=&allowed('vgr',$tmp_courseid.
9002: '/'.$env{'request.course.sec'});
9003: }
9004: if ($allowed) {
9005: ($symb)=&get_env_multiple('form.grade_symb');
9006: $courseid=$tmp_courseid;
9007: ($domain)=&get_env_multiple('form.grade_domain');
9008: ($name)=&get_env_multiple('form.grade_username');
9009: return ($symb,$courseid,$domain,$name,$publicuser);
9010: }
9011: }
9012: if (!$passedsymb) {
9013: $symb=&symbread();
9014: } else {
9015: $symb=$passedsymb;
9016: }
9017: $courseid=$env{'request.course.id'};
9018: $domain=$env{'user.domain'};
9019: $name=$env{'user.name'};
9020: if ($name eq 'public' && $domain eq 'public') {
9021: if (!defined($env{'form.username'})) {
9022: $env{'form.username'}.=time.rand(10000000);
9023: }
9024: $name.=$env{'form.username'};
9025: }
9026: return ($symb,$courseid,$domain,$name,$publicuser);
9027:
9028: }
9029:
1.36 albertel 9030: # ------------------------------------------------------------ Serves up a file
1.472 albertel 9031: # returns either the contents of the file or
9032: # -1 if the file doesn't exist
1.481 raeburn 9033: #
9034: # if the target is a file that was uploaded via DOCS,
9035: # a check will be made to see if a current copy exists on the local server,
9036: # if it does this will be served, otherwise a copy will be retrieved from
9037: # the home server for the course and stored in /home/httpd/html/userfiles on
9038: # the local server.
1.472 albertel 9039:
1.36 albertel 9040: sub getfile {
1.538 albertel 9041: my ($file) = @_;
1.609 banghart 9042: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 9043: &repcopy($file);
9044: return &readfile($file);
9045: }
9046:
9047: sub repcopy_userfile {
9048: my ($file)=@_;
1.609 banghart 9049: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 9050: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 9051: my ($cdom,$cnum,$filename) =
1.811 albertel 9052: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 9053: my $uri="/uploaded/$cdom/$cnum/$filename";
9054: if (-e "$file") {
1.828 www 9055: # we already have a local copy, check it out
1.538 albertel 9056: my @fileinfo = stat($file);
1.828 www 9057: my $rtncode;
9058: my $info;
1.538 albertel 9059: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 9060: if ($lwpresp ne 'ok') {
1.828 www 9061: # there is no such file anymore, even though we had a local copy
1.482 albertel 9062: if ($rtncode eq '404') {
1.538 albertel 9063: unlink($file);
1.482 albertel 9064: }
9065: return -1;
9066: }
9067: if ($info < $fileinfo[9]) {
1.828 www 9068: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 9069: return 'ok';
1.828 www 9070: } else {
9071: # the file is outdated, get rid of it
9072: unlink($file);
1.482 albertel 9073: }
1.828 www 9074: }
9075: # one way or the other, at this point, we don't have the file
9076: # construct the correct path for the file
9077: my @parts = ($cdom,$cnum);
9078: if ($filename =~ m|^(.+)/[^/]+$|) {
9079: push @parts, split(/\//,$1);
9080: }
9081: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9082: foreach my $part (@parts) {
9083: $path .= '/'.$part;
9084: if (!-e $path) {
9085: mkdir($path,0770);
1.482 albertel 9086: }
9087: }
1.828 www 9088: # now the path exists for sure
9089: # get a user agent
9090: my $ua=new LWP::UserAgent;
9091: my $transferfile=$file.'.in.transfer';
9092: # FIXME: this should flock
9093: if (-e $transferfile) { return 'ok'; }
9094: my $request;
9095: $uri=~s/^\///;
1.980 raeburn 9096: my $homeserver = &homeserver($cnum,$cdom);
9097: my $protocol = $protocol{$homeserver};
9098: $protocol = 'http' if ($protocol ne 'https');
9099: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 9100: my $response=$ua->request($request,$transferfile);
9101: # did it work?
9102: if ($response->is_error()) {
9103: unlink($transferfile);
9104: &logthis("Userfile repcopy failed for $uri");
9105: return -1;
9106: }
9107: # worked, rename the transfer file
9108: rename($transferfile,$file);
1.607 raeburn 9109: return 'ok';
1.481 raeburn 9110: }
9111:
1.517 albertel 9112: sub tokenwrapper {
9113: my $uri=shift;
1.980 raeburn 9114: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 9115: $uri=~s|^/||;
1.620 albertel 9116: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 9117: my $token=$1;
1.552 albertel 9118: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9119: if ($udom && $uname && $file) {
9120: $file=~s|(\?\.*)*$||;
1.949 raeburn 9121: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 9122: my $homeserver = &homeserver($uname,$udom);
9123: my $protocol = $protocol{$homeserver};
9124: $protocol = 'http' if ($protocol ne 'https');
9125: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 9126: (($uri=~/\?/)?'&':'?').'token='.$token.
9127: '&tokenissued='.$perlvar{'lonHostID'};
9128: } else {
9129: return '/adm/notfound.html';
9130: }
9131: }
9132:
1.828 www 9133: # call with reqtype HEAD: get last modification time
9134: # call with reqtype GET: get the file contents
9135: # Do not call this with reqtype GET for large files! It loads everything into memory
9136: #
1.481 raeburn 9137: sub getuploaded {
9138: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9139: $uri=~s/^\///;
1.980 raeburn 9140: my $homeserver = &homeserver($cnum,$cdom);
9141: my $protocol = $protocol{$homeserver};
9142: $protocol = 'http' if ($protocol ne 'https');
9143: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 9144: my $ua=new LWP::UserAgent;
9145: my $request=new HTTP::Request($reqtype,$uri);
9146: my $response=$ua->request($request);
9147: $$rtncode = $response->code;
1.482 albertel 9148: if (! $response->is_success()) {
9149: return 'failed';
9150: }
9151: if ($reqtype eq 'HEAD') {
1.486 www 9152: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 9153: } elsif ($reqtype eq 'GET') {
9154: $$info = $response->content;
1.472 albertel 9155: }
1.482 albertel 9156: return 'ok';
1.36 albertel 9157: }
9158:
1.481 raeburn 9159: sub readfile {
9160: my $file = shift;
9161: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9162: my $fh;
9163: open($fh,"<$file");
9164: my $a='';
1.800 albertel 9165: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 9166: return $a;
9167: }
9168:
1.36 albertel 9169: sub filelocation {
1.590 banghart 9170: my ($dir,$file) = @_;
9171: my $location;
9172: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 9173:
9174: if ($file =~ m-^/adm/-) {
9175: $file=~s-^/adm/wrapper/-/-;
9176: $file=~s-^/adm/coursedocs/showdoc/-/-;
9177: }
1.882 albertel 9178:
1.590 banghart 9179: if ($file=~m:^/~:) { # is a contruction space reference
9180: $location = $file;
9181: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 9182: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 9183: # is a correct contruction space reference
9184: $location = $file;
1.956 raeburn 9185: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9186: $location = $file;
1.609 banghart 9187: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 9188: my ($udom,$uname,$filename)=
1.811 albertel 9189: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 9190: my $home=&homeserver($uname,$udom);
9191: my $is_me=0;
9192: my @ids=¤t_machine_ids();
9193: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9194: if ($is_me) {
1.955 raeburn 9195: $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 9196: } else {
9197: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9198: $udom.'/'.$uname.'/'.$filename;
9199: }
1.882 albertel 9200: } elsif ($file =~ m-^/adm/-) {
9201: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 9202: } else {
9203: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9204: $file=~s:^/res/:/:;
9205: if ( !( $file =~ m:^/:) ) {
9206: $location = $dir. '/'.$file;
9207: } else {
9208: $location = '/home/httpd/html/res'.$file;
9209: }
1.59 albertel 9210: }
1.590 banghart 9211: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 9212: while ($location=~m{/\.\./}) {
9213: if ($location =~ m{/[^/]+/\.\./}) {
9214: $location=~ s{/[^/]+/\.\./}{/}g;
9215: } else {
9216: $location=~ s{/\.\./}{/}g;
9217: }
9218: } #remove dir/..
1.590 banghart 9219: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9220: return $location;
1.46 www 9221: }
1.36 albertel 9222:
1.46 www 9223: sub hreflocation {
9224: my ($dir,$file)=@_;
1.980 raeburn 9225: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 9226: $file=filelocation($dir,$file);
1.700 albertel 9227: } elsif ($file=~m-^/adm/-) {
9228: $file=~s-^/adm/wrapper/-/-;
9229: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 9230: }
9231: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9232: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 9233: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9234: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 9235: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 9236: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 9237: -/uploaded/$1/$2/-x;
1.46 www 9238: }
1.913 albertel 9239: if ($file=~ m{^/userfiles/}) {
9240: $file =~ s{^/userfiles/}{/uploaded/};
9241: }
1.462 albertel 9242: return $file;
1.465 albertel 9243: }
9244:
9245: sub current_machine_domains {
1.853 albertel 9246: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9247: }
9248:
9249: sub machine_domains {
9250: my ($hostname) = @_;
1.465 albertel 9251: my @domains;
1.838 albertel 9252: my %hostname = &all_hostnames();
1.465 albertel 9253: while( my($id, $name) = each(%hostname)) {
1.467 matthew 9254: # &logthis("-$id-$name-$hostname-");
1.465 albertel 9255: if ($hostname eq $name) {
1.844 albertel 9256: push(@domains,&host_domain($id));
1.465 albertel 9257: }
9258: }
9259: return @domains;
9260: }
9261:
9262: sub current_machine_ids {
1.853 albertel 9263: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9264: }
9265:
9266: sub machine_ids {
9267: my ($hostname) = @_;
9268: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 9269: my @ids;
1.888 albertel 9270: my %name_to_host = &all_names();
1.889 albertel 9271: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9272: return @{ $name_to_host{$hostname} };
9273: }
9274: return;
1.31 www 9275: }
9276:
1.824 raeburn 9277: sub additional_machine_domains {
9278: my @domains;
9279: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9280: while( my $line = <$fh>) {
9281: $line =~ s/\s//g;
9282: push(@domains,$line);
9283: }
9284: return @domains;
9285: }
9286:
9287: sub default_login_domain {
9288: my $domain = $perlvar{'lonDefDomain'};
9289: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9290: foreach my $posdom (¤t_machine_domains(),
9291: &additional_machine_domains()) {
9292: if (lc($posdom) eq lc($testdomain)) {
9293: $domain=$posdom;
9294: last;
9295: }
9296: }
9297: return $domain;
9298: }
9299:
1.31 www 9300: # ------------------------------------------------------------- Declutters URLs
9301:
9302: sub declutter {
9303: my $thisfn=shift;
1.569 albertel 9304: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 9305: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 9306: $thisfn=~s/^\///;
1.697 albertel 9307: $thisfn=~s|^adm/wrapper/||;
9308: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 9309: $thisfn=~s/^res\///;
1.1032 raeburn 9310: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9311: $thisfn=~s/\?.+$//;
9312: }
1.268 www 9313: return $thisfn;
9314: }
9315:
9316: # ------------------------------------------------------------- Clutter up URLs
9317:
9318: sub clutter {
9319: my $thisfn='/'.&declutter(shift);
1.887 albertel 9320: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 9321: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 9322: $thisfn='/res'.$thisfn;
9323: }
1.1031 raeburn 9324: if ($thisfn !~m|^/adm|) {
9325: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 9326: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 9327: } else {
9328: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9329: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 9330: if ($embstyle eq 'ssi'
9331: || ($embstyle eq 'hdn')
9332: || ($embstyle eq 'rat')
9333: || ($embstyle eq 'prv')
9334: || ($embstyle eq 'ign')) {
9335: #do nothing with these
9336: } elsif (($embstyle eq 'img')
1.695 albertel 9337: || ($embstyle eq 'emb')
9338: || ($embstyle eq 'wrp')) {
9339: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 9340: } elsif ($embstyle eq 'unk'
9341: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 9342: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 9343: } else {
1.718 www 9344: # &logthis("Got a blank emb style");
1.695 albertel 9345: }
1.694 albertel 9346: }
9347: }
1.31 www 9348: return $thisfn;
1.12 www 9349: }
9350:
1.787 albertel 9351: sub clutter_with_no_wrapper {
9352: my $uri = &clutter(shift);
9353: if ($uri =~ m-^/adm/-) {
9354: $uri =~ s-^/adm/wrapper/-/-;
9355: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9356: }
9357: return $uri;
9358: }
9359:
1.557 albertel 9360: sub freeze_escape {
9361: my ($value)=@_;
9362: if (ref($value)) {
9363: $value=&nfreeze($value);
9364: return '__FROZEN__'.&escape($value);
9365: }
9366: return &escape($value);
9367: }
9368:
1.11 www 9369:
1.557 albertel 9370: sub thaw_unescape {
9371: my ($value)=@_;
9372: if ($value =~ /^__FROZEN__/) {
9373: substr($value,0,10,undef);
9374: $value=&unescape($value);
9375: return &thaw($value);
9376: }
9377: return &unescape($value);
9378: }
9379:
1.436 albertel 9380: sub correct_line_ends {
9381: my ($result)=@_;
9382: $$result =~s/\r\n/\n/mg;
9383: $$result =~s/\r/\n/mg;
1.415 albertel 9384: }
1.1 albertel 9385: # ================================================================ Main Program
9386:
1.184 www 9387: sub goodbye {
1.204 albertel 9388: &logthis("Starting Shut down");
1.443 albertel 9389: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 9390: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 9391: #converted
1.599 albertel 9392: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 9393: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9394: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9395: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 9396: #1.1 only
1.870 albertel 9397: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9398: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9399: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9400: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9401: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 9402: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9403: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 9404: &flushcourselogs();
9405: &logthis("Shutting down");
9406: }
9407:
1.852 albertel 9408: sub get_dns {
1.869 albertel 9409: my ($url,$func,$ignore_cache) = @_;
9410: if (!$ignore_cache) {
9411: my ($content,$cached)=
9412: &Apache::lonnet::is_cached_new('dns',$url);
9413: if ($cached) {
9414: &$func($content);
9415: return;
9416: }
9417: }
9418:
9419: my %alldns;
1.852 albertel 9420: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9421: foreach my $dns (<$config>) {
9422: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 9423: my $line = $1;
9424: my ($host,$protocol) = split(/:/,$line);
9425: if ($protocol ne 'https') {
9426: $protocol = 'http';
9427: }
9428: $alldns{$host} = $protocol;
1.869 albertel 9429: }
9430: while (%alldns) {
9431: my ($dns) = keys(%alldns);
1.852 albertel 9432: my $ua=new LWP::UserAgent;
1.979 raeburn 9433: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 9434: my $response=$ua->request($request);
1.979 raeburn 9435: delete($alldns{$dns});
1.852 albertel 9436: next if ($response->is_error());
9437: my @content = split("\n",$response->content);
1.869 albertel 9438: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 9439: &$func(\@content);
1.869 albertel 9440: return;
1.852 albertel 9441: }
9442: close($config);
1.871 albertel 9443: my $which = (split('/',$url))[3];
9444: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9445: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 9446: my @content = <$config>;
9447: &$func(\@content);
9448: return;
1.852 albertel 9449: }
1.327 albertel 9450: # ------------------------------------------------------------ Read domain file
9451: {
1.852 albertel 9452: my $loaded;
1.846 albertel 9453: my %domain;
9454:
1.852 albertel 9455: sub parse_domain_tab {
9456: my ($lines) = @_;
9457: foreach my $line (@$lines) {
9458: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 9459:
1.846 albertel 9460: chomp($line);
1.852 albertel 9461: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 9462: my %this_domain;
9463: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9464: 'lang_def', 'city', 'longi', 'lati',
9465: 'primary') {
9466: $this_domain{$field} = shift(@elements);
9467: }
9468: $domain{$name} = \%this_domain;
1.852 albertel 9469: }
9470: }
1.864 albertel 9471:
9472: sub reset_domain_info {
9473: undef($loaded);
9474: undef(%domain);
9475: }
9476:
1.852 albertel 9477: sub load_domain_tab {
1.869 albertel 9478: my ($ignore_cache) = @_;
9479: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 9480: my $fh;
9481: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9482: my @lines = <$fh>;
9483: &parse_domain_tab(\@lines);
1.448 albertel 9484: }
1.852 albertel 9485: close($fh);
9486: $loaded = 1;
1.327 albertel 9487: }
1.846 albertel 9488:
9489: sub domain {
1.852 albertel 9490: &load_domain_tab() if (!$loaded);
9491:
1.846 albertel 9492: my ($name,$what) = @_;
9493: return if ( !exists($domain{$name}) );
9494:
9495: if (!$what) {
9496: return $domain{$name}{'description'};
9497: }
9498: return $domain{$name}{$what};
9499: }
1.974 raeburn 9500:
9501: sub domain_info {
9502: &load_domain_tab() if (!$loaded);
9503: return %domain;
9504: }
9505:
1.327 albertel 9506: }
9507:
9508:
1.1 albertel 9509: # ------------------------------------------------------------- Read hosts file
9510: {
1.838 albertel 9511: my %hostname;
1.844 albertel 9512: my %hostdom;
1.845 albertel 9513: my %libserv;
1.852 albertel 9514: my $loaded;
1.888 albertel 9515: my %name_to_host;
1.852 albertel 9516:
9517: sub parse_hosts_tab {
9518: my ($file) = @_;
9519: foreach my $configline (@$file) {
9520: next if ($configline =~ /^(\#|\s*$ )/x);
9521: next if ($configline =~ /^\^/);
9522: chomp($configline);
1.968 raeburn 9523: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852 albertel 9524: $name=~s/\s//g;
9525: if ($id && $domain && $role && $name) {
9526: $hostname{$id}=$name;
1.888 albertel 9527: push(@{$name_to_host{$name}}, $id);
1.852 albertel 9528: $hostdom{$id}=$domain;
9529: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 9530: if (defined($protocol)) {
9531: if ($protocol eq 'https') {
9532: $protocol{$id} = $protocol;
9533: } else {
9534: $protocol{$id} = 'http';
9535: }
1.968 raeburn 9536: } else {
1.969 raeburn 9537: $protocol{$id} = 'http';
1.968 raeburn 9538: }
1.852 albertel 9539: }
9540: }
9541: }
1.864 albertel 9542:
9543: sub reset_hosts_info {
1.897 albertel 9544: &purge_remembered();
1.864 albertel 9545: &reset_domain_info();
9546: &reset_hosts_ip_info();
1.892 albertel 9547: undef(%name_to_host);
1.864 albertel 9548: undef(%hostname);
9549: undef(%hostdom);
9550: undef(%libserv);
9551: undef($loaded);
9552: }
1.1 albertel 9553:
1.852 albertel 9554: sub load_hosts_tab {
1.869 albertel 9555: my ($ignore_cache) = @_;
9556: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 9557: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9558: my @config = <$config>;
9559: &parse_hosts_tab(\@config);
9560: close($config);
9561: $loaded=1;
1.1 albertel 9562: }
1.852 albertel 9563:
1.838 albertel 9564: sub hostname {
1.852 albertel 9565: &load_hosts_tab() if (!$loaded);
9566:
1.838 albertel 9567: my ($lonid) = @_;
9568: return $hostname{$lonid};
9569: }
1.845 albertel 9570:
1.838 albertel 9571: sub all_hostnames {
1.852 albertel 9572: &load_hosts_tab() if (!$loaded);
9573:
1.838 albertel 9574: return %hostname;
9575: }
1.845 albertel 9576:
1.888 albertel 9577: sub all_names {
9578: &load_hosts_tab() if (!$loaded);
9579:
9580: return %name_to_host;
9581: }
9582:
1.974 raeburn 9583: sub all_host_domain {
9584: &load_hosts_tab() if (!$loaded);
9585: return %hostdom;
9586: }
9587:
1.845 albertel 9588: sub is_library {
1.852 albertel 9589: &load_hosts_tab() if (!$loaded);
9590:
1.845 albertel 9591: return exists($libserv{$_[0]});
9592: }
9593:
9594: sub all_library {
1.852 albertel 9595: &load_hosts_tab() if (!$loaded);
9596:
1.845 albertel 9597: return %libserv;
9598: }
9599:
1.841 albertel 9600: sub get_servers {
1.852 albertel 9601: &load_hosts_tab() if (!$loaded);
9602:
1.841 albertel 9603: my ($domain,$type) = @_;
9604: my %possible_hosts = ($type eq 'library') ? %libserv
9605: : %hostname;
9606: my %result;
1.842 albertel 9607: if (ref($domain) eq 'ARRAY') {
9608: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 9609: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 9610: $result{$host} = $hostname;
9611: }
9612: }
9613: } else {
9614: while ( my ($host,$hostname) = each(%possible_hosts)) {
9615: if ($hostdom{$host} eq $domain) {
9616: $result{$host} = $hostname;
9617: }
1.841 albertel 9618: }
9619: }
9620: return %result;
9621: }
1.845 albertel 9622:
1.844 albertel 9623: sub host_domain {
1.852 albertel 9624: &load_hosts_tab() if (!$loaded);
9625:
1.844 albertel 9626: my ($lonid) = @_;
9627: return $hostdom{$lonid};
9628: }
9629:
1.841 albertel 9630: sub all_domains {
1.852 albertel 9631: &load_hosts_tab() if (!$loaded);
9632:
1.841 albertel 9633: my %seen;
9634: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9635: return @uniq;
9636: }
1.1 albertel 9637: }
9638:
1.847 albertel 9639: {
9640: my %iphost;
1.856 albertel 9641: my %name_to_ip;
9642: my %lonid_to_ip;
1.869 albertel 9643:
1.847 albertel 9644: sub get_hosts_from_ip {
9645: my ($ip) = @_;
9646: my %iphosts = &get_iphost();
9647: if (ref($iphosts{$ip})) {
9648: return @{$iphosts{$ip}};
9649: }
9650: return;
1.839 albertel 9651: }
1.864 albertel 9652:
9653: sub reset_hosts_ip_info {
9654: undef(%iphost);
9655: undef(%name_to_ip);
9656: undef(%lonid_to_ip);
9657: }
1.856 albertel 9658:
9659: sub get_host_ip {
9660: my ($lonid) = @_;
9661: if (exists($lonid_to_ip{$lonid})) {
9662: return $lonid_to_ip{$lonid};
9663: }
9664: my $name=&hostname($lonid);
9665: my $ip = gethostbyname($name);
9666: return if (!$ip || length($ip) ne 4);
9667: $ip=inet_ntoa($ip);
9668: $name_to_ip{$name} = $ip;
9669: $lonid_to_ip{$lonid} = $ip;
9670: return $ip;
9671: }
1.847 albertel 9672:
9673: sub get_iphost {
1.869 albertel 9674: my ($ignore_cache) = @_;
1.894 albertel 9675:
1.869 albertel 9676: if (!$ignore_cache) {
9677: if (%iphost) {
9678: return %iphost;
9679: }
9680: my ($ip_info,$cached)=
9681: &Apache::lonnet::is_cached_new('iphost','iphost');
9682: if ($cached) {
9683: %iphost = %{$ip_info->[0]};
9684: %name_to_ip = %{$ip_info->[1]};
9685: %lonid_to_ip = %{$ip_info->[2]};
9686: return %iphost;
9687: }
9688: }
1.894 albertel 9689:
9690: # get yesterday's info for fallback
9691: my %old_name_to_ip;
9692: my ($ip_info,$cached)=
9693: &Apache::lonnet::is_cached_new('iphost','iphost');
9694: if ($cached) {
9695: %old_name_to_ip = %{$ip_info->[1]};
9696: }
9697:
1.888 albertel 9698: my %name_to_host = &all_names();
9699: foreach my $name (keys(%name_to_host)) {
1.847 albertel 9700: my $ip;
9701: if (!exists($name_to_ip{$name})) {
9702: $ip = gethostbyname($name);
9703: if (!$ip || length($ip) ne 4) {
1.894 albertel 9704: if (defined($old_name_to_ip{$name})) {
9705: $ip = $old_name_to_ip{$name};
9706: &logthis("Can't find $name defaulting to old $ip");
9707: } else {
9708: &logthis("Name $name no IP found");
9709: next;
9710: }
9711: } else {
9712: $ip=inet_ntoa($ip);
1.847 albertel 9713: }
9714: $name_to_ip{$name} = $ip;
9715: } else {
9716: $ip = $name_to_ip{$name};
1.653 albertel 9717: }
1.888 albertel 9718: foreach my $id (@{ $name_to_host{$name} }) {
9719: $lonid_to_ip{$id} = $ip;
9720: }
9721: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 9722: }
1.869 albertel 9723: &Apache::lonnet::do_cache_new('iphost','iphost',
9724: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 9725: 48*60*60);
1.869 albertel 9726:
1.847 albertel 9727: return %iphost;
1.598 albertel 9728: }
9729:
1.992 raeburn 9730: #
9731: # Given a DNS returns the loncapa host name for that DNS
9732: #
9733: sub host_from_dns {
9734: my ($dns) = @_;
9735: my @hosts;
9736: my $ip;
9737:
1.993 raeburn 9738: if (exists($name_to_ip{$dns})) {
1.992 raeburn 9739: $ip = $name_to_ip{$dns};
9740: }
9741: if (!$ip) {
9742: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9743: if (length($ip) == 4) {
9744: $ip = &IO::Socket::inet_ntoa($ip);
9745: }
9746: }
9747: if ($ip) {
9748: @hosts = get_hosts_from_ip($ip);
9749: return $hosts[0];
9750: }
9751: return undef;
1.986 foxr 9752: }
1.992 raeburn 9753:
1.986 foxr 9754: }
9755:
1.862 albertel 9756: BEGIN {
9757:
9758: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9759: unless ($readit) {
9760: {
9761: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9762: %perlvar = (%perlvar,%{$configvars});
9763: }
9764:
9765:
1.1 albertel 9766: # ------------------------------------------------------ Read spare server file
9767: {
1.448 albertel 9768: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 9769:
9770: while (my $configline=<$config>) {
9771: chomp($configline);
1.284 matthew 9772: if ($configline) {
1.784 albertel 9773: my ($host,$type) = split(':',$configline,2);
1.785 albertel 9774: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 9775: push(@{ $spareid{$type} }, $host);
1.1 albertel 9776: }
9777: }
1.448 albertel 9778: close($config);
1.1 albertel 9779: }
1.11 www 9780: # ------------------------------------------------------------ Read permissions
9781: {
1.448 albertel 9782: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 9783:
9784: while (my $configline=<$config>) {
1.448 albertel 9785: chomp($configline);
9786: if ($configline) {
9787: my ($role,$perm)=split(/ /,$configline);
9788: if ($perm ne '') { $pr{$role}=$perm; }
9789: }
1.11 www 9790: }
1.448 albertel 9791: close($config);
1.11 www 9792: }
9793:
9794: # -------------------------------------------- Read plain texts for permissions
9795: {
1.448 albertel 9796: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 9797:
9798: while (my $configline=<$config>) {
1.448 albertel 9799: chomp($configline);
9800: if ($configline) {
1.742 raeburn 9801: my ($short,@plain)=split(/:/,$configline);
9802: %{$prp{$short}} = ();
9803: if (@plain > 0) {
9804: $prp{$short}{'std'} = $plain[0];
9805: for (my $i=1; $i<@plain; $i++) {
9806: $prp{$short}{'alt'.$i} = $plain[$i];
9807: }
9808: }
1.448 albertel 9809: }
1.135 www 9810: }
1.448 albertel 9811: close($config);
1.135 www 9812: }
9813:
9814: # ---------------------------------------------------------- Read package table
9815: {
1.448 albertel 9816: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 9817:
9818: while (my $configline=<$config>) {
1.483 albertel 9819: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 9820: chomp($configline);
9821: my ($short,$plain)=split(/:/,$configline);
9822: my ($pack,$name)=split(/\&/,$short);
9823: if ($plain ne '') {
9824: $packagetab{$pack.'&'.$name.'&name'}=$name;
9825: $packagetab{$short}=$plain;
9826: }
1.11 www 9827: }
1.448 albertel 9828: close($config);
1.329 matthew 9829: }
9830:
9831: # ------------- set up temporary directory
9832: {
9833: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9834:
1.11 www 9835: }
9836:
1.794 albertel 9837: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9838: 'compress_threshold'=> 20_000,
9839: });
1.185 www 9840:
1.281 www 9841: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 9842: $dumpcount=0;
1.958 www 9843: $locknum=0;
1.22 www 9844:
1.163 harris41 9845: &logtouch();
1.672 albertel 9846: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 9847: $readit=1;
1.564 albertel 9848: {
9849: use integer;
9850: my $test=(2**32)+1;
1.568 albertel 9851: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 9852: &logthis(" Detected 64bit platform ($_64bit)");
9853: }
1.195 www 9854: }
1.1 albertel 9855: }
1.179 www 9856:
1.1 albertel 9857: 1;
1.191 harris41 9858: __END__
9859:
1.243 albertel 9860: =pod
9861:
1.191 harris41 9862: =head1 NAME
9863:
1.243 albertel 9864: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 9865:
9866: =head1 SYNOPSIS
9867:
1.243 albertel 9868: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 9869:
9870: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9871:
1.243 albertel 9872: Common parameters:
9873:
9874: =over 4
9875:
9876: =item *
9877:
9878: $uname : an internal username (if $cname expecting a course Id specifically)
9879:
9880: =item *
9881:
9882: $udom : a domain (if $cdom expecting a course's domain specifically)
9883:
9884: =item *
9885:
9886: $symb : a resource instance identifier
9887:
9888: =item *
9889:
9890: $namespace : the name of a .db file that contains the data needed or
9891: being set.
9892:
9893: =back
9894:
1.394 bowersj2 9895: =head1 OVERVIEW
1.191 harris41 9896:
1.394 bowersj2 9897: lonnet provides subroutines which interact with the
9898: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9899: about classes, users, and resources.
1.243 albertel 9900:
9901: For many of these objects you can also use this to store data about
9902: them or modify them in various ways.
1.191 harris41 9903:
1.394 bowersj2 9904: =head2 Symbs
1.191 harris41 9905:
1.394 bowersj2 9906: To identify a specific instance of a resource, LON-CAPA uses symbols
9907: or "symbs"X<symb>. These identifiers are built from the URL of the
9908: map, the resource number of the resource in the map, and the URL of
9909: the resource itself. The latter is somewhat redundant, but might help
9910: if maps change.
9911:
9912: An example is
9913:
9914: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
9915:
9916: The respective map entry is
9917:
9918: <resource id="19" src="/res/msu/korte/tests/part12.problem"
9919: title="Problem 2">
9920: </resource>
9921:
9922: Symbs are used by the random number generator, as well as to store and
9923: restore data specific to a certain instance of for example a problem.
9924:
9925: =head2 Storing And Retrieving Data
9926:
9927: X<store()>X<cstore()>X<restore()>Three of the most important functions
9928: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
9929: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
9930: is is the non-critical message twin of cstore. These functions are for
9931: handlers to store a perl hash to a user's permanent data space in an
9932: easy manner, and to retrieve it again on another call. It is expected
9933: that a handler would use this once at the beginning to retrieve data,
9934: and then again once at the end to send only the new data back.
9935:
9936: The data is stored in the user's data directory on the user's
9937: homeserver under the ID of the course.
9938:
9939: The hash that is returned by restore will have all of the previous
9940: value for all of the elements of the hash.
9941:
9942: Example:
9943:
9944: #creating a hash
9945: my %hash;
9946: $hash{'foo'}='bar';
9947:
9948: #storing it
9949: &Apache::lonnet::cstore(\%hash);
9950:
9951: #changing a value
9952: $hash{'foo'}='notbar';
9953:
9954: #adding a new value
9955: $hash{'bar'}='foo';
9956: &Apache::lonnet::cstore(\%hash);
9957:
9958: #retrieving the hash
9959: my %history=&Apache::lonnet::restore();
9960:
9961: #print the hash
9962: foreach my $key (sort(keys(%history))) {
9963: print("\%history{$key} = $history{$key}");
9964: }
9965:
9966: Will print out:
1.191 harris41 9967:
1.394 bowersj2 9968: %history{1:foo} = bar
9969: %history{1:keys} = foo:timestamp
9970: %history{1:timestamp} = 990455579
9971: %history{2:bar} = foo
9972: %history{2:foo} = notbar
9973: %history{2:keys} = foo:bar:timestamp
9974: %history{2:timestamp} = 990455580
9975: %history{bar} = foo
9976: %history{foo} = notbar
9977: %history{timestamp} = 990455580
9978: %history{version} = 2
9979:
9980: Note that the special hash entries C<keys>, C<version> and
9981: C<timestamp> were added to the hash. C<version> will be equal to the
9982: total number of versions of the data that have been stored. The
9983: C<timestamp> attribute will be the UNIX time the hash was
9984: stored. C<keys> is available in every historical section to list which
9985: keys were added or changed at a specific historical revision of a
9986: hash.
9987:
9988: B<Warning>: do not store the hash that restore returns directly. This
9989: will cause a mess since it will restore the historical keys as if the
9990: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 9991:
1.394 bowersj2 9992: Calling convention:
1.191 harris41 9993:
1.394 bowersj2 9994: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
9995: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 9996:
1.394 bowersj2 9997: For more detailed information, see lonnet specific documentation.
1.191 harris41 9998:
1.394 bowersj2 9999: =head1 RETURN MESSAGES
1.191 harris41 10000:
1.394 bowersj2 10001: =over 4
1.191 harris41 10002:
1.394 bowersj2 10003: =item * B<con_lost>: unable to contact remote host
1.191 harris41 10004:
1.394 bowersj2 10005: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10006: when the connection is brought back up
1.191 harris41 10007:
1.394 bowersj2 10008: =item * B<con_failed>: unable to contact remote host and unable to save message
10009: for later delivery
1.191 harris41 10010:
1.967 bisitz 10011: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 10012:
1.394 bowersj2 10013: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 10014: that was requested
1.191 harris41 10015:
1.243 albertel 10016: =back
1.191 harris41 10017:
1.243 albertel 10018: =head1 PUBLIC SUBROUTINES
1.191 harris41 10019:
1.243 albertel 10020: =head2 Session Environment Functions
1.191 harris41 10021:
1.243 albertel 10022: =over 4
1.191 harris41 10023:
1.394 bowersj2 10024: =item *
10025: X<appenv()>
1.949 raeburn 10026: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 10027: the user envirnoment file, and will be restored for each access this
1.620 albertel 10028: user makes during this session, also modifies the %env for the current
1.949 raeburn 10029: process. Optional rolesarrayref - if defined contains a reference to an array
10030: of roles which are exempt from the restriction on modifying user.role entries
10031: in the user's environment.db and in %env.
1.191 harris41 10032:
10033: =item *
1.394 bowersj2 10034: X<delenv()>
1.987 raeburn 10035: B<delenv($delthis,$regexp)>: removes all items from the session
10036: environment file that begin with $delthis. If the
10037: optional second arg - $regexp - is true, $delthis is treated as a
10038: regular expression, otherwise \Q$delthis\E is used.
10039: The values are also deleted from the current processes %env.
1.191 harris41 10040:
1.795 albertel 10041: =item * get_env_multiple($name)
10042:
10043: gets $name from the %env hash, it seemlessly handles the cases where multiple
10044: values may be defined and end up as an array ref.
10045:
10046: returns an array of values
10047:
1.243 albertel 10048: =back
10049:
10050: =head2 User Information
1.191 harris41 10051:
1.243 albertel 10052: =over 4
1.191 harris41 10053:
10054: =item *
1.394 bowersj2 10055: X<queryauthenticate()>
10056: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 10057: authentication scheme
10058:
10059: =item *
1.394 bowersj2 10060: X<authenticate()>
10061: B<authenticate($uname,$upass,$udom)>: try to
10062: authenticate user from domain's lib servers (first use the current
10063: one). C<$upass> should be the users password.
1.191 harris41 10064:
10065: =item *
1.394 bowersj2 10066: X<homeserver()>
10067: B<homeserver($uname,$udom)>: find the server which has
10068: the user's directory and files (there must be only one), this caches
10069: the answer, and also caches if there is a borken connection.
1.191 harris41 10070:
10071: =item *
1.394 bowersj2 10072: X<idget()>
10073: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10074: (IDs are a unique resource in a domain, there must be only 1 ID per
10075: username, and only 1 username per ID in a specific domain) (returns
10076: hash: id=>name,id=>name)
1.191 harris41 10077:
10078: =item *
1.394 bowersj2 10079: X<idrget()>
10080: B<idrget($udom,@unames)>: find the IDs behind a list of
10081: usernames (returns hash: name=>id,name=>id)
1.191 harris41 10082:
10083: =item *
1.394 bowersj2 10084: X<idput()>
10085: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 10086:
10087: =item *
1.394 bowersj2 10088: X<rolesinit()>
10089: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 10090:
10091: =item *
1.551 albertel 10092: X<getsection()>
10093: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 10094: course $cname, return section name/number or '' for "not in course"
10095: and '-1' for "no section"
10096:
10097: =item *
1.394 bowersj2 10098: X<userenvironment()>
10099: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 10100: passed in @what from the requested user's environment, returns a hash
10101:
1.858 raeburn 10102: =item *
10103: X<userlog_query()>
1.859 albertel 10104: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10105: activity.log file. %filters defines filters applied when parsing the
10106: log file. These can be start or end timestamps, or the type of action
10107: - log to look for Login or Logout events, check for Checkin or
10108: Checkout, role for role selection. The response is in the form
10109: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10110: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 10111:
1.243 albertel 10112: =back
10113:
10114: =head2 User Roles
10115:
10116: =over 4
10117:
10118: =item *
10119:
1.810 raeburn 10120: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 10121: F: full access
10122: U,I,K: authentication modes (cxx only)
10123: '': forbidden
10124: 1: user needs to choose course
10125: 2: browse allowed
1.766 albertel 10126: A: passphrase authentication needed
1.243 albertel 10127:
10128: =item *
10129:
10130: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10131: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10132: and course level
10133:
10134: =item *
10135:
1.988 raeburn 10136: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10137: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 10138: $type is Course (default) or Community.
1.988 raeburn 10139: If $forcedefault evaluates to true, text returned will be default
10140: text for $type. Otherwise, if this is a course, the text returned
10141: will be a custom name for the role (if defined in the course's
10142: environment). If no custom name is defined the default is returned.
10143:
1.832 raeburn 10144: =item *
10145:
1.935 raeburn 10146: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 10147: All arguments are optional. Returns a hash of a roles, either for
10148: co-author/assistant author roles for a user's Construction Space
1.906 albertel 10149: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 10150: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10151: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10152: For each key, value is set to colon-separated start and end times for
10153: the role. If no username and domain are specified, will default to
1.934 raeburn 10154: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 10155: of role statuses (active, future or previous), roles
10156: (e.g., cc,in, st etc.) and domains of the roles which can be used
10157: to restrict the list of roles reported. If no array ref is
10158: provided for types, will default to return only active roles.
1.834 albertel 10159:
1.243 albertel 10160: =back
10161:
10162: =head2 User Modification
10163:
10164: =over 4
10165:
10166: =item *
10167:
1.957 raeburn 10168: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 10169: user for the level given by URL. Optional start and end dates (leave empty
10170: string or zero for "no date")
1.191 harris41 10171:
10172: =item *
10173:
1.243 albertel 10174: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10175: change a users, password, possible return values are: ok,
10176: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10177: refused
1.191 harris41 10178:
10179: =item *
10180:
1.243 albertel 10181: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 10182:
10183: =item *
10184:
1.963 raeburn 10185: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
10186: $forceid,$desiredhome,$email,$inststatus) :
1.243 albertel 10187: modify user
1.191 harris41 10188:
10189: =item *
10190:
1.286 matthew 10191: modifystudent
10192:
1.957 raeburn 10193: modify a student's enrollment and identification information.
1.286 matthew 10194: The course id is resolved based on the current users environment.
10195: This means the envoking user must be a course coordinator or otherwise
10196: associated with a course.
10197:
1.297 matthew 10198: This call is essentially a wrapper for lonnet::modifyuser and
10199: lonnet::modify_student_enrollment
1.286 matthew 10200:
10201: Inputs:
10202:
10203: =over 4
10204:
1.957 raeburn 10205: =item B<$udom> Student's loncapa domain
1.286 matthew 10206:
1.957 raeburn 10207: =item B<$uname> Student's loncapa login name
1.286 matthew 10208:
1.964 bisitz 10209: =item B<$uid> Student/Employee ID
1.286 matthew 10210:
1.957 raeburn 10211: =item B<$umode> Student's authentication mode
1.286 matthew 10212:
1.957 raeburn 10213: =item B<$upass> Student's password
1.286 matthew 10214:
1.957 raeburn 10215: =item B<$first> Student's first name
1.286 matthew 10216:
1.957 raeburn 10217: =item B<$middle> Student's middle name
1.286 matthew 10218:
1.957 raeburn 10219: =item B<$last> Student's last name
1.286 matthew 10220:
1.957 raeburn 10221: =item B<$gene> Student's generation
1.286 matthew 10222:
1.957 raeburn 10223: =item B<$usec> Student's section in course
1.286 matthew 10224:
10225: =item B<$end> Unix time of the roles expiration
10226:
10227: =item B<$start> Unix time of the roles start date
10228:
10229: =item B<$forceid> If defined, allow $uid to be changed
10230:
10231: =item B<$desiredhome> server to use as home server for student
10232:
1.957 raeburn 10233: =item B<$email> Student's permanent e-mail address
10234:
10235: =item B<$type> Type of enrollment (auto or manual)
10236:
1.963 raeburn 10237: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10238:
10239: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 10240:
1.963 raeburn 10241: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 10242:
1.963 raeburn 10243: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 10244:
1.963 raeburn 10245: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 10246:
1.286 matthew 10247: =back
1.297 matthew 10248:
10249: =item *
10250:
10251: modify_student_enrollment
10252:
10253: Change a students enrollment status in a class. The environment variable
10254: 'role.request.course' must be defined for this function to proceed.
10255:
10256: Inputs:
10257:
10258: =over 4
10259:
10260: =item $udom, students domain
10261:
10262: =item $uname, students name
10263:
10264: =item $uid, students user id
10265:
10266: =item $first, students first name
10267:
10268: =item $middle
10269:
10270: =item $last
10271:
10272: =item $gene
10273:
10274: =item $usec
10275:
10276: =item $end
10277:
10278: =item $start
10279:
1.957 raeburn 10280: =item $type
10281:
10282: =item $locktype
10283:
10284: =item $cid
10285:
10286: =item $selfenroll
10287:
10288: =item $context
10289:
1.297 matthew 10290: =back
10291:
1.191 harris41 10292:
10293: =item *
10294:
1.243 albertel 10295: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10296: custom role; give a custom role to a user for the level given by URL. Specify
10297: name and domain of role author, and role name
1.191 harris41 10298:
10299: =item *
10300:
1.243 albertel 10301: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 10302:
10303: =item *
10304:
1.243 albertel 10305: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10306:
10307: =back
10308:
10309: =head2 Course Infomation
10310:
10311: =over 4
1.191 harris41 10312:
10313: =item *
10314:
1.631 albertel 10315: coursedescription($courseid) : returns a hash of information about the
10316: specified course id, including all environment settings for the
10317: course, the description of the course will be in the hash under the
10318: key 'description'
1.191 harris41 10319:
10320: =item *
10321:
1.624 albertel 10322: resdata($name,$domain,$type,@which) : request for current parameter
10323: setting for a specific $type, where $type is either 'course' or 'user',
10324: @what should be a list of parameters to ask about. This routine caches
10325: answers for 5 minutes.
1.243 albertel 10326:
1.877 foxr 10327: =item *
10328:
10329: get_courseresdata($courseid, $domain) : dump the entire course resource
10330: data base, returning a hash that is keyed by the resource name and has
10331: values that are the resource value. I believe that the timestamps and
10332: versions are also returned.
10333:
10334:
1.243 albertel 10335: =back
10336:
10337: =head2 Course Modification
10338:
10339: =over 4
1.191 harris41 10340:
10341: =item *
10342:
1.243 albertel 10343: writecoursepref($courseid,%prefs) : write preferences (environment
10344: database) for a course
1.191 harris41 10345:
10346: =item *
10347:
1.1011 raeburn 10348: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10349:
10350: =item *
10351:
1.1038 raeburn 10352: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 10353:
10354: =back
10355:
10356: =head2 Resource Subroutines
10357:
10358: =over 4
1.191 harris41 10359:
10360: =item *
10361:
1.243 albertel 10362: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 10363:
10364: =item *
10365:
1.243 albertel 10366: repcopy($filename) : subscribes to the requested file, and attempts to
10367: replicate from the owning library server, Might return
1.607 raeburn 10368: 'unavailable', 'not_found', 'forbidden', 'ok', or
10369: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 10370: resource. Expects the local filesystem pathname
10371: (/home/httpd/html/res/....)
10372:
10373: =back
10374:
10375: =head2 Resource Information
10376:
10377: =over 4
1.191 harris41 10378:
10379: =item *
10380:
1.243 albertel 10381: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10382: a vairety of different possible values, $varname should be a request
10383: string, and the other parameters can be used to specify who and what
10384: one is asking about.
10385:
10386: Possible values for $varname are environment.lastname (or other item
10387: from the envirnment hash), user.name (or someother aspect about the
10388: user), resource.0.maxtries (or some other part and parameter of a
10389: resource)
1.204 albertel 10390:
10391: =item *
10392:
1.243 albertel 10393: directcondval($number) : get current value of a condition; reads from a state
10394: string
1.204 albertel 10395:
10396: =item *
10397:
1.243 albertel 10398: condval($condidx) : value of condition index based on state
1.204 albertel 10399:
10400: =item *
10401:
1.243 albertel 10402: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10403: resource's metadata, $what should be either a specific key, or either
10404: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10405: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10406:
10407: this function automatically caches all requests
1.191 harris41 10408:
10409: =item *
10410:
1.243 albertel 10411: metadata_query($query,$custom,$customshow) : make a metadata query against the
10412: network of library servers; returns file handle of where SQL and regex results
10413: will be stored for query
1.191 harris41 10414:
10415: =item *
10416:
1.243 albertel 10417: symbread($filename) : return symbolic list entry (filename argument optional);
10418: returns the data handle
1.191 harris41 10419:
10420: =item *
10421:
1.243 albertel 10422: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 10423: a possible symb for the URL in $thisfn, and if is an encryypted
10424: resource that the user accessed using /enc/ returns a 1 on success, 0
10425: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 10426: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 10427:
1.191 harris41 10428:
10429: =item *
10430:
1.243 albertel 10431: symbclean($symb) : removes versions numbers from a symb, returns the
10432: cleaned symb
1.191 harris41 10433:
10434: =item *
10435:
1.243 albertel 10436: is_on_map($uri) : checks if the $uri is somewhere on the current
10437: course map, user must be in a course for it to work.
1.191 harris41 10438:
10439: =item *
10440:
1.243 albertel 10441: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 10442:
10443: =item *
10444:
1.243 albertel 10445: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10446: a random seed, all arguments are optional, if they aren't sent it uses the
10447: environment to derive them. Note: if symb isn't sent and it can't get one
10448: from &symbread it will use the current time as its return value
1.191 harris41 10449:
10450: =item *
10451:
1.243 albertel 10452: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10453: unfakeable, receipt
1.191 harris41 10454:
10455: =item *
10456:
1.620 albertel 10457: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 10458:
10459: =item *
10460:
1.243 albertel 10461: countacc($url) : count the number of accesses to a given URL
1.191 harris41 10462:
10463: =item *
10464:
1.243 albertel 10465: 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 10466:
10467: =item *
10468:
1.243 albertel 10469: 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 10470:
10471: =item *
10472:
1.243 albertel 10473: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 10474:
10475: =item *
10476:
1.243 albertel 10477: devalidate($symb) : devalidate temporary spreadsheet calculations,
10478: forcing spreadsheet to reevaluate the resource scores next time.
10479:
10480: =back
10481:
10482: =head2 Storing/Retreiving Data
10483:
10484: =over 4
1.191 harris41 10485:
10486: =item *
10487:
1.243 albertel 10488: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10489: for this url; hashref needs to be given and should be a \%hashname; the
10490: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 10491: be derived from the env
1.191 harris41 10492:
10493: =item *
10494:
1.243 albertel 10495: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10496: uses critical subroutine
1.191 harris41 10497:
10498: =item *
10499:
1.243 albertel 10500: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10501: all args are optional
1.191 harris41 10502:
10503: =item *
10504:
1.717 albertel 10505: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10506: dumps the complete (or key matching regexp) namespace into a hash
10507: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10508: normally &store()ed into
10509:
10510: $range should be either an integer '100' (give me the first 100
10511: matching records)
10512: or be two integers sperated by a - with no spaces
10513: '30-50' (give me the 30th through the 50th matching
10514: records)
10515:
10516:
10517: =item *
10518:
10519: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10520: replaces a &store() version of data with a replacement set of data
10521: for a particular resource in a namespace passed in the $storehash hash
10522: reference
10523:
10524: =item *
10525:
1.243 albertel 10526: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10527: works very similar to store/cstore, but all data is stored in a
10528: temporary location and can be reset using tmpreset, $storehash should
10529: be a hash reference, returns nothing on success
1.191 harris41 10530:
10531: =item *
10532:
1.243 albertel 10533: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10534: similar to restore, but all data is stored in a temporary location and
10535: can be reset using tmpreset. Returns a hash of values on success,
10536: error string otherwise.
1.191 harris41 10537:
10538: =item *
10539:
1.243 albertel 10540: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10541: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 10542:
10543: =item *
10544:
1.243 albertel 10545: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10546: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 10547:
10548: =item *
10549:
1.243 albertel 10550: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10551: namesp ($udom and $uname are optional)
1.191 harris41 10552:
10553: =item *
10554:
1.702 albertel 10555: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 10556: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 10557: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 10558:
1.702 albertel 10559: $range should be either an integer '100' (give me the first 100
10560: matching records)
10561: or be two integers sperated by a - with no spaces
10562: '30-50' (give me the 30th through the 50th matching
10563: records)
1.449 matthew 10564: =item *
10565:
10566: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10567: $store can be a scalar, an array reference, or if the amount to be
10568: incremented is > 1, a hash reference.
10569:
10570: ($udom and $uname are optional)
1.191 harris41 10571:
10572: =item *
10573:
1.243 albertel 10574: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10575: ($udom and $uname are optional)
1.191 harris41 10576:
10577: =item *
10578:
1.243 albertel 10579: cput($namespace,$storehash,$udom,$uname) : critical put
10580: ($udom and $uname are optional)
1.191 harris41 10581:
10582: =item *
10583:
1.748 albertel 10584: newput($namespace,$storehash,$udom,$uname) :
10585:
10586: Attempts to store the items in the $storehash, but only if they don't
10587: currently exist, if this succeeds you can be certain that you have
10588: successfully created a new key value pair in the $namespace db.
10589:
10590:
10591: Args:
10592: $namespace: name of database to store values to
10593: $storehash: hashref to store to the db
10594: $udom: (optional) domain of user containing the db
10595: $uname: (optional) name of user caontaining the db
10596:
10597: Returns:
10598: 'ok' -> succeeded in storing all keys of $storehash
10599: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10600: least <key> already existed in the db (other
10601: requested keys may also already exist)
1.967 bisitz 10602: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 10603: 'con_lost' -> unable to contact request server
10604: 'refused' -> action was not allowed by remote machine
10605:
10606:
10607: =item *
10608:
1.243 albertel 10609: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10610: reference filled in from namesp (encrypts the return communication)
10611: ($udom and $uname are optional)
1.191 harris41 10612:
10613: =item *
10614:
1.243 albertel 10615: log($udom,$name,$home,$message) : write to permanent log for user; use
10616: critical subroutine
10617:
1.806 raeburn 10618: =item *
10619:
1.860 raeburn 10620: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10621: array reference filled in from namespace found in domain level on either
10622: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 10623:
10624: =item *
10625:
1.860 raeburn 10626: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10627: domain level either on specified domain server ($uhome) or primary domain
10628: server ($udom and $uhome are optional)
1.806 raeburn 10629:
1.943 raeburn 10630: =item *
10631:
10632: get_domain_defaults($target_domain) : returns hash with defaults for
10633: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10634: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10635: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10636: Values are retrieved from cache (if current), or from domain's configuration.db
10637: (if available), or lastly from values in lonTabs/dns_domain,tab,
10638: or lonTabs/domain.tab.
10639:
10640: %domdefaults = &get_auth_defaults($target_domain);
10641:
1.243 albertel 10642: =back
10643:
10644: =head2 Network Status Functions
10645:
10646: =over 4
1.191 harris41 10647:
10648: =item *
10649:
10650: dirlist($uri) : return directory list based on URI
10651:
10652: =item *
10653:
1.243 albertel 10654: spareserver() : find server with least workload from spare.tab
10655:
1.986 foxr 10656:
10657: =item *
10658:
10659: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10660: if there is no corresponding loncapa host.
10661:
1.243 albertel 10662: =back
10663:
1.986 foxr 10664:
1.243 albertel 10665: =head2 Apache Request
10666:
10667: =over 4
1.191 harris41 10668:
10669: =item *
10670:
1.243 albertel 10671: ssi($url,%hash) : server side include, does a complete request cycle on url to
10672: localhost, posts hash
10673:
10674: =back
10675:
10676: =head2 Data to String to Data
10677:
10678: =over 4
1.191 harris41 10679:
10680: =item *
10681:
1.243 albertel 10682: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10683: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 10684:
10685: =item *
10686:
1.243 albertel 10687: hashref2str($hashref) : convert a hashref into a string complete with
10688: escaping and '=' and '&' separators, supports elements that are
10689: arrayrefs and hashrefs
1.191 harris41 10690:
10691: =item *
10692:
1.243 albertel 10693: arrayref2str($arrayref) : convert an arrayref into a string complete
10694: with escaping and '&' separators, supports elements that are arrayrefs
10695: and hashrefs
1.191 harris41 10696:
10697: =item *
10698:
1.243 albertel 10699: str2hash($string) : convert string to hash using unescaping and
10700: splitting on '=' and '&', supports elements that are arrayrefs and
10701: hashrefs
1.191 harris41 10702:
10703: =item *
10704:
1.243 albertel 10705: str2array($string) : convert string to hash using unescaping and
10706: splitting on '&', supports elements that are arrayrefs and hashrefs
10707:
10708: =back
10709:
10710: =head2 Logging Routines
10711:
10712: =over 4
10713:
10714: These routines allow one to make log messages in the lonnet.log and
10715: lonnet.perm logfiles.
1.191 harris41 10716:
10717: =item *
10718:
1.243 albertel 10719: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 10720:
10721: =item *
10722:
1.243 albertel 10723: logthis() : append message to the normal lonnet.log file, it gets
10724: preiodically rolled over and deleted.
1.191 harris41 10725:
10726: =item *
10727:
1.243 albertel 10728: logperm() : append a permanent message to lonnet.perm.log, this log
10729: file never gets deleted by any automated portion of the system, only
10730: messages of critical importance should go in here.
10731:
10732: =back
10733:
10734: =head2 General File Helper Routines
10735:
10736: =over 4
1.191 harris41 10737:
10738: =item *
10739:
1.481 raeburn 10740: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10741: (a) files in /uploaded
10742: (i) If a local copy of the file exists -
10743: compares modification date of local copy with last-modified date for
10744: definitive version stored on home server for course. If local copy is
10745: stale, requests a new version from the home server and stores it.
10746: If the original has been removed from the home server, then local copy
10747: is unlinked.
10748: (ii) If local copy does not exist -
10749: requests the file from the home server and stores it.
10750:
10751: If $caller is 'uploadrep':
10752: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10753: for request for files originally uploaded via DOCS.
10754: - returns 'ok' if fresh local copy now available, -1 otherwise.
10755:
10756: Otherwise:
10757: This indicates a call from the content generation phase of the request.
10758: - returns the entire contents of the file or -1.
10759:
10760: (b) files in /res
10761: - returns the entire contents of a file or -1;
10762: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 10763:
1.712 albertel 10764:
10765: =item *
10766:
10767: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10768: reference
10769:
10770: returns either a stat() list of data about the file or an empty list
10771: if the file doesn't exist or couldn't find out about it (connection
10772: problems or user unknown)
10773:
1.191 harris41 10774: =item *
10775:
1.243 albertel 10776: filelocation($dir,$file) : returns file system location of a file
10777: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10778: directory that relative $file lookups are to looked in ($dir of /a/dir
10779: and a file of ../bob will become /a/bob)
1.191 harris41 10780:
10781: =item *
10782:
10783: hreflocation($dir,$file) : returns file system location or a URL; same as
10784: filelocation except for hrefs
10785:
10786: =item *
10787:
10788: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10789:
1.243 albertel 10790: =back
10791:
1.608 albertel 10792: =head2 Usererfile file routines (/uploaded*)
10793:
10794: =over 4
10795:
10796: =item *
10797:
10798: userfileupload(): main rotine for putting a file in a user or course's
10799: filespace, arguments are,
10800:
1.620 albertel 10801: formname - required - this is the name of the element in $env where the
1.608 albertel 10802: filename, and the contents of the file to create/modifed exist
1.620 albertel 10803: the filename is in $env{'form.'.$formname.'.filename'} and the
10804: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 10805: coursedoc - if true, store the file in the course of the active role
10806: of the current user
10807: subdir - required - subdirectory to put the file in under ../userfiles/
10808: if undefined, it will be placed in "unknown"
10809:
10810: (This routine calls clean_filename() to remove any dangerous
10811: characters from the filename, and then calls finuserfileupload() to
10812: complete the transaction)
10813:
10814: returns either the url of the uploaded file (/uploaded/....) if successful
10815: and /adm/notfound.html if unsuccessful
10816:
10817: =item *
10818:
10819: clean_filename(): routine for cleaing a filename up for storage in
10820: userfile space, argument is:
10821:
10822: filename - proposed filename
10823:
10824: returns: the new clean filename
10825:
10826: =item *
10827:
10828: finishuserfileupload(): routine that creaes and sends the file to
10829: userspace, probably shouldn't be called directly
10830:
10831: docuname: username or courseid of destination for the file
10832: docudom: domain of user/course of destination for the file
10833: formname: same as for userfileupload()
10834: fname: filename (inculding subdirectories) for the file
10835:
10836: returns either the url of the uploaded file (/uploaded/....) if successful
10837: and /adm/notfound.html if unsuccessful
10838:
10839: =item *
10840:
10841: renameuserfile(): renames an existing userfile to a new name
10842:
10843: Args:
10844: docuname: username or courseid of destination for the file
10845: docudom: domain of user/course of destination for the file
10846: old: current file name (including any subdirs under userfiles)
10847: new: desired file name (including any subdirs under userfiles)
10848:
10849: =item *
10850:
10851: mkdiruserfile(): creates a directory is a userfiles dir
10852:
10853: Args:
10854: docuname: username or courseid of destination for the file
10855: docudom: domain of user/course of destination for the file
10856: dir: dir to create (including any subdirs under userfiles)
10857:
10858: =item *
10859:
10860: removeuserfile(): removes a file that exists in userfiles
10861:
10862: Args:
10863: docuname: username or courseid of destination for the file
10864: docudom: domain of user/course of destination for the file
10865: fname: filname to delete (including any subdirs under userfiles)
10866:
10867: =item *
10868:
10869: removeuploadedurl(): convience function for removeuserfile()
10870:
10871: Args:
10872: url: a full /uploaded/... url to delete
10873:
1.747 albertel 10874: =item *
10875:
10876: get_portfile_permissions():
10877: Args:
10878: domain: domain of user or course contain the portfolio files
10879: user: name of user or num of course contain the portfolio files
10880: Returns:
10881: hashref of a dump of the proper file_permissions.db
10882:
10883:
10884: =item *
10885:
10886: get_access_controls():
10887:
10888: Args:
10889: current_permissions: the hash ref returned from get_portfile_permissions()
10890: group: (optional) the group you want the files associated with
10891: file: (optional) the file you want access info on
10892:
10893: Returns:
1.749 raeburn 10894: a hash (keys are file names) of hashes containing
10895: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10896: values are XML containing access control settings (see below)
1.747 albertel 10897:
10898: Internal notes:
10899:
1.749 raeburn 10900: access controls are stored in file_permissions.db as key=value pairs.
10901: key -> path to file/file_name\0uniqueID:scope_end_start
10902: where scope -> public,guest,course,group,domains or users.
10903: end -> UNIX time for end of access (0 -> no end date)
10904: start -> UNIX time for start of access
10905:
10906: value -> XML description of access control
10907: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
10908: <start></start>
10909: <end></end>
10910:
10911: <password></password> for scope type = guest
10912:
10913: <domain></domain> for scope type = course or group
10914: <number></number>
10915: <roles id="">
10916: <role></role>
10917: <access></access>
10918: <section></section>
10919: <group></group>
10920: </roles>
10921:
10922: <dom></dom> for scope type = domains
10923:
10924: <users> for scope type = users
10925: <user>
10926: <uname></uname>
10927: <udom></udom>
10928: </user>
10929: </users>
10930: </scope>
10931:
10932: Access data is also aggregated for each file in an additional key=value pair:
10933: key -> path to file/file_name\0accesscontrol
10934: value -> reference to hash
10935: hash contains key = value pairs
10936: where key = uniqueID:scope_end_start
10937: value = UNIX time record was last updated
10938:
10939: Used to improve speed of look-ups of access controls for each file.
10940:
10941: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
10942:
10943: modify_access_controls():
10944:
10945: Modifies access controls for a portfolio file
10946: Args
10947: 1. file name
10948: 2. reference to hash of required changes,
10949: 3. domain
10950: 4. username
10951: where domain,username are the domain of the portfolio owner
10952: (either a user or a course)
10953:
10954: Returns:
10955: 1. result of additions or updates ('ok' or 'error', with error message).
10956: 2. result of deletions ('ok' or 'error', with error message).
10957: 3. reference to hash of any new or updated access controls.
10958: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
10959: key = integer (inbound ID)
10960: value = uniqueID
1.747 albertel 10961:
1.608 albertel 10962: =back
10963:
1.243 albertel 10964: =head2 HTTP Helper Routines
10965:
10966: =over 4
10967:
1.191 harris41 10968: =item *
10969:
10970: escape() : unpack non-word characters into CGI-compatible hex codes
10971:
10972: =item *
10973:
10974: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
10975:
1.243 albertel 10976: =back
10977:
10978: =head1 PRIVATE SUBROUTINES
10979:
10980: =head2 Underlying communication routines (Shouldn't call)
10981:
10982: =over 4
10983:
10984: =item *
10985:
10986: subreply() : tries to pass a message to lonc, returns con_lost if incapable
10987:
10988: =item *
10989:
10990: reply() : uses subreply to send a message to remote machine, logs all failures
10991:
10992: =item *
10993:
10994: critical() : passes a critical message to another server; if cannot
10995: get through then place message in connection buffer directory and
10996: returns con_delayed, if incapable of saving message, returns
10997: con_failed
10998:
10999: =item *
11000:
11001: reconlonc() : tries to reconnect lonc client processes.
11002:
11003: =back
11004:
11005: =head2 Resource Access Logging
11006:
11007: =over 4
11008:
11009: =item *
11010:
11011: flushcourselogs() : flush (save) buffer logs and access logs
11012:
11013: =item *
11014:
11015: courselog($what) : save message for course in hash
11016:
11017: =item *
11018:
11019: courseacclog($what) : save message for course using &courselog(). Perform
11020: special processing for specific resource types (problems, exams, quizzes, etc).
11021:
1.191 harris41 11022: =item *
11023:
11024: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11025: as a PerlChildExitHandler
1.243 albertel 11026:
11027: =back
11028:
11029: =head2 Other
11030:
11031: =over 4
11032:
11033: =item *
11034:
11035: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 11036:
11037: =back
11038:
11039: =cut
1.877 foxr 11040:
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