1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1056.2.4 2010/05/22 13:50:19 raeburn Exp $
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: #
28: ###
29:
30: =pod
31:
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:
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:
71: package Apache::lonnet;
72:
73: use strict;
74: use LWP::UserAgent();
75: use HTTP::Date;
76: use Image::Magick;
77:
78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
79: $_64bit %env %protocol);
80:
81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
82: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
84: %courseownerbuf, %coursetypebuf,$locknum);
85:
86: use IO::Socket;
87: use GDBM_File;
88: use HTML::LCParser;
89: use Fcntl qw(:flock);
90: use Storable qw(thaw nfreeze);
91: use Time::HiRes qw( gettimeofday tv_interval );
92: use Cache::Memcached;
93: use Digest::MD5;
94: use Math::Random;
95: use File::MMagic;
96: use LONCAPA qw(:DEFAULT :match);
97: use LONCAPA::Configuration;
98:
99: my $readit;
100: my $max_connection_retries = 10; # Or some such value.
101:
102: require Exporter;
103:
104: our @ISA = qw (Exporter);
105: our @EXPORT = qw(%env);
106:
107:
108: # --------------------------------------------------------------------- Logging
109: {
110: my $logid;
111: sub instructor_log {
112: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
113: if (($cnum eq '') || ($cdom eq '')) {
114: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
115: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
116: }
117: $logid++;
118: my $now = time();
119: my $id=$now.'00000'.$$.'00000'.$logid;
120: return &Apache::lonnet::put('nohist_'.$hash_name,
121: { $id => {
122: 'exe_uname' => $env{'user.name'},
123: 'exe_udom' => $env{'user.domain'},
124: 'exe_time' => $now,
125: 'exe_ip' => $ENV{'REMOTE_ADDR'},
126: 'delflag' => $delflag,
127: 'logentry' => $storehash,
128: 'uname' => $uname,
129: 'udom' => $udom,
130: }
131: },$cdom,$cnum);
132: }
133: }
134:
135: sub logtouch {
136: my $execdir=$perlvar{'lonDaemons'};
137: unless (-e "$execdir/logs/lonnet.log") {
138: open(my $fh,">>$execdir/logs/lonnet.log");
139: close $fh;
140: }
141: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
142: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
143: }
144:
145: sub logthis {
146: my $message=shift;
147: my $execdir=$perlvar{'lonDaemons'};
148: my $now=time;
149: my $local=localtime($now);
150: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
151: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
152: print $fh $logstring;
153: close($fh);
154: }
155: return 1;
156: }
157:
158: sub logperm {
159: my $message=shift;
160: my $execdir=$perlvar{'lonDaemons'};
161: my $now=time;
162: my $local=localtime($now);
163: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
164: print $fh "$now:$message:$local\n";
165: close($fh);
166: }
167: return 1;
168: }
169:
170: sub create_connection {
171: my ($hostname,$lonid) = @_;
172: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
173: Type => SOCK_STREAM,
174: Timeout => 10);
175: return 0 if (!$client);
176: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
177: my $result = <$client>;
178: chomp($result);
179: return 1 if ($result eq 'done');
180: return 0;
181: }
182:
183: sub get_server_timezone {
184: my ($cnum,$cdom) = @_;
185: my $home=&homeserver($cnum,$cdom);
186: if ($home ne 'no_host') {
187: my $cachetime = 24*3600;
188: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
189: if (defined($cached)) {
190: return $timezone;
191: } else {
192: my $timezone = &reply('servertimezone',$home);
193: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
194: }
195: }
196: }
197:
198: sub get_server_loncaparev {
199: my ($dom,$lonhost) = @_;
200: if (defined($lonhost)) {
201: if (!defined(&hostname($lonhost))) {
202: undef($lonhost);
203: }
204: }
205: if (!defined($lonhost)) {
206: if (defined(&domain($dom,'primary'))) {
207: $lonhost=&domain($dom,'primary');
208: if ($lonhost eq 'no_host') {
209: undef($lonhost);
210: }
211: }
212: }
213: if (defined($lonhost)) {
214: my $cachetime = 24*3600;
215: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
216: if (defined($cached)) {
217: return $loncaparev;
218: } else {
219: my $loncaparev = &reply('serverloncaparev',$lonhost);
220: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
221: }
222: }
223: }
224:
225: # -------------------------------------------------- Non-critical communication
226: sub subreply {
227: my ($cmd,$server)=@_;
228: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
229: #
230: # With loncnew process trimming, there's a timing hole between lonc server
231: # process exit and the master server picking up the listen on the AF_UNIX
232: # socket. In that time interval, a lock file will exist:
233:
234: my $lockfile=$peerfile.".lock";
235: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
236: sleep(1);
237: }
238: # At this point, either a loncnew parent is listening or an old lonc
239: # or loncnew child is listening so we can connect or everything's dead.
240: #
241: # We'll give the connection a few tries before abandoning it. If
242: # connection is not possible, we'll con_lost back to the client.
243: #
244: my $client;
245: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
246: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
247: Type => SOCK_STREAM,
248: Timeout => 10);
249: if ($client) {
250: last; # Connected!
251: } else {
252: &create_connection(&hostname($server),$server);
253: }
254: sleep(1); # Try again later if failed connection.
255: }
256: my $answer;
257: if ($client) {
258: print $client "sethost:$server:$cmd\n";
259: $answer=<$client>;
260: if (!$answer) { $answer="con_lost"; }
261: chomp($answer);
262: } else {
263: $answer = 'con_lost'; # Failed connection.
264: }
265: return $answer;
266: }
267:
268: sub reply {
269: my ($cmd,$server)=@_;
270: unless (defined(&hostname($server))) { return 'no_such_host'; }
271: my $answer=subreply($cmd,$server);
272: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
273: &logthis("<font color=\"blue\">WARNING:".
274: " $cmd to $server returned $answer</font>");
275: }
276: return $answer;
277: }
278:
279: # ----------------------------------------------------------- Send USR1 to lonc
280:
281: sub reconlonc {
282: my ($lonid) = @_;
283: my $hostname = &hostname($lonid);
284: if ($lonid) {
285: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
286: if ($hostname && -e $peerfile) {
287: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
288: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
289: Type => SOCK_STREAM,
290: Timeout => 10);
291: if ($client) {
292: print $client ("reset_retries\n");
293: my $answer=<$client>;
294: #reset just this one.
295: }
296: }
297: return;
298: }
299:
300: &logthis("Trying to reconnect lonc");
301: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
302: if (open(my $fh,"<$loncfile")) {
303: my $loncpid=<$fh>;
304: chomp($loncpid);
305: if (kill 0 => $loncpid) {
306: &logthis("lonc at pid $loncpid responding, sending USR1");
307: kill USR1 => $loncpid;
308: sleep 1;
309: } else {
310: &logthis(
311: "<font color=\"blue\">WARNING:".
312: " lonc at pid $loncpid not responding, giving up</font>");
313: }
314: } else {
315: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
316: }
317: }
318:
319: # ------------------------------------------------------ Critical communication
320:
321: sub critical {
322: my ($cmd,$server)=@_;
323: unless (&hostname($server)) {
324: &logthis("<font color=\"blue\">WARNING:".
325: " Critical message to unknown server ($server)</font>");
326: return 'no_such_host';
327: }
328: my $answer=reply($cmd,$server);
329: if ($answer eq 'con_lost') {
330: &reconlonc("$perlvar{'lonSockDir'}/$server");
331: my $answer=reply($cmd,$server);
332: if ($answer eq 'con_lost') {
333: my $now=time;
334: my $middlename=$cmd;
335: $middlename=substr($middlename,0,16);
336: $middlename=~s/\W//g;
337: my $dfilename=
338: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
339: $dumpcount++;
340: {
341: my $dfh;
342: if (open($dfh,">$dfilename")) {
343: print $dfh "$cmd\n";
344: close($dfh);
345: }
346: }
347: sleep 2;
348: my $wcmd='';
349: {
350: my $dfh;
351: if (open($dfh,"<$dfilename")) {
352: $wcmd=<$dfh>;
353: close($dfh);
354: }
355: }
356: chomp($wcmd);
357: if ($wcmd eq $cmd) {
358: &logthis("<font color=\"blue\">WARNING: ".
359: "Connection buffer $dfilename: $cmd</font>");
360: &logperm("D:$server:$cmd");
361: return 'con_delayed';
362: } else {
363: &logthis("<font color=\"red\">CRITICAL:"
364: ." Critical connection failed: $server $cmd</font>");
365: &logperm("F:$server:$cmd");
366: return 'con_failed';
367: }
368: }
369: }
370: return $answer;
371: }
372:
373: # ------------------------------------------- check if return value is an error
374:
375: sub error {
376: my ($result) = @_;
377: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
378: if ($2 == 2) { return undef; }
379: return $1;
380: }
381: return undef;
382: }
383:
384: sub convert_and_load_session_env {
385: my ($lonidsdir,$handle)=@_;
386: my @profile;
387: {
388: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
389: if (!$opened) {
390: return 0;
391: }
392: flock($idf,LOCK_SH);
393: @profile=<$idf>;
394: close($idf);
395: }
396: my %temp_env;
397: foreach my $line (@profile) {
398: if ($line !~ m/=/) {
399: return 0;
400: }
401: chomp($line);
402: my ($envname,$envvalue)=split(/=/,$line,2);
403: $temp_env{&unescape($envname)} = &unescape($envvalue);
404: }
405: unlink("$lonidsdir/$handle.id");
406: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
407: 0640)) {
408: %disk_env = %temp_env;
409: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
410: untie(%disk_env);
411: }
412: return 1;
413: }
414:
415: # ------------------------------------------- Transfer profile into environment
416: my $env_loaded;
417: sub transfer_profile_to_env {
418: my ($lonidsdir,$handle,$force_transfer) = @_;
419: if (!$force_transfer && $env_loaded) { return; }
420:
421: if (!defined($lonidsdir)) {
422: $lonidsdir = $perlvar{'lonIDsDir'};
423: }
424: if (!defined($handle)) {
425: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
426: }
427:
428: my $convert;
429: {
430: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
431: if (!$opened) {
432: return;
433: }
434: flock($idf,LOCK_SH);
435: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
436: &GDBM_READER(),0640)) {
437: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
438: untie(%disk_env);
439: } else {
440: $convert = 1;
441: }
442: }
443: if ($convert) {
444: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
445: &logthis("Failed to load session, or convert session.");
446: }
447: }
448:
449: my %remove;
450: while ( my $envname = each(%env) ) {
451: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
452: if ($time < time-300) {
453: $remove{$key}++;
454: }
455: }
456: }
457:
458: $env{'user.environment'} = "$lonidsdir/$handle.id";
459: $env_loaded=1;
460: foreach my $expired_key (keys(%remove)) {
461: &delenv($expired_key);
462: }
463: }
464:
465: # ---------------------------------------------------- Check for valid session
466: sub check_for_valid_session {
467: my ($r) = @_;
468: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
469: my $lonid=$cookies{'lonID'};
470: return undef if (!$lonid);
471:
472: my $handle=&LONCAPA::clean_handle($lonid->value);
473: my $lonidsdir=$r->dir_config('lonIDsDir');
474: return undef if (!-e "$lonidsdir/$handle.id");
475:
476: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
477: return undef if (!$opened);
478:
479: flock($idf,LOCK_SH);
480: my %disk_env;
481: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
482: &GDBM_READER(),0640)) {
483: return undef;
484: }
485:
486: if (!defined($disk_env{'user.name'})
487: || !defined($disk_env{'user.domain'})) {
488: return undef;
489: }
490: return $handle;
491: }
492:
493: sub timed_flock {
494: my ($file,$lock_type) = @_;
495: my $failed=0;
496: eval {
497: local $SIG{__DIE__}='DEFAULT';
498: local $SIG{ALRM}=sub {
499: $failed=1;
500: die("failed lock");
501: };
502: alarm(13);
503: flock($file,$lock_type);
504: alarm(0);
505: };
506: if ($failed) {
507: return undef;
508: } else {
509: return 1;
510: }
511: }
512:
513: # ---------------------------------------------------------- Append Environment
514:
515: sub appenv {
516: my ($newenv,$roles) = @_;
517: if (ref($newenv) eq 'HASH') {
518: foreach my $key (keys(%{$newenv})) {
519: my $refused = 0;
520: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
521: $refused = 1;
522: if (ref($roles) eq 'ARRAY') {
523: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
524: if (grep(/^\Q$role\E$/,@{$roles})) {
525: $refused = 0;
526: }
527: }
528: }
529: if ($refused) {
530: &logthis("<font color=\"blue\">WARNING: ".
531: "Attempt to modify environment ".$key." to ".$newenv->{$key}
532: .'</font>');
533: delete($newenv->{$key});
534: } else {
535: $env{$key}=$newenv->{$key};
536: }
537: }
538: my $opened = open(my $env_file,'+<',$env{'user.environment'});
539: if ($opened
540: && &timed_flock($env_file,LOCK_EX)
541: &&
542: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
543: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
544: while (my ($key,$value) = each(%{$newenv})) {
545: $disk_env{$key} = $value;
546: }
547: untie(%disk_env);
548: }
549: }
550: return 'ok';
551: }
552: # ----------------------------------------------------- Delete from Environment
553:
554: sub delenv {
555: my ($delthis,$regexp) = @_;
556: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
557: &logthis("<font color=\"blue\">WARNING: ".
558: "Attempt to delete from environment ".$delthis);
559: return 'error';
560: }
561: my $opened = open(my $env_file,'+<',$env{'user.environment'});
562: if ($opened
563: && &timed_flock($env_file,LOCK_EX)
564: &&
565: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
566: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
567: foreach my $key (keys(%disk_env)) {
568: if ($regexp) {
569: if ($key=~/^$delthis/) {
570: delete($env{$key});
571: delete($disk_env{$key});
572: }
573: } else {
574: if ($key=~/^\Q$delthis\E/) {
575: delete($env{$key});
576: delete($disk_env{$key});
577: }
578: }
579: }
580: untie(%disk_env);
581: }
582: return 'ok';
583: }
584:
585: sub get_env_multiple {
586: my ($name) = @_;
587: my @values;
588: if (defined($env{$name})) {
589: # exists is it an array
590: if (ref($env{$name})) {
591: @values=@{ $env{$name} };
592: } else {
593: $values[0]=$env{$name};
594: }
595: }
596: return(@values);
597: }
598:
599: # ------------------------------------------------------------------- Locking
600:
601: sub set_lock {
602: my ($text)=@_;
603: $locknum++;
604: my $id=$$.'-'.$locknum;
605: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
606: 'session.lock.'.$id => $text});
607: return $id;
608: }
609:
610: sub get_locks {
611: my $num=0;
612: my %texts=();
613: foreach my $lock (split(/\,/,$env{'session.locks'})) {
614: if ($lock=~/\w/) {
615: $num++;
616: $texts{$lock}=$env{'session.lock.'.$lock};
617: }
618: }
619: return ($num,%texts);
620: }
621:
622: sub remove_lock {
623: my ($id)=@_;
624: my $newlocks='';
625: foreach my $lock (split(/\,/,$env{'session.locks'})) {
626: if (($lock=~/\w/) && ($lock ne $id)) {
627: $newlocks.=','.$lock;
628: }
629: }
630: &appenv({'session.locks' => $newlocks});
631: &delenv('session.lock.'.$id);
632: }
633:
634: sub remove_all_locks {
635: my $activelocks=$env{'session.locks'};
636: foreach my $lock (split(/\,/,$env{'session.locks'})) {
637: if ($lock=~/\w/) {
638: &remove_lock($lock);
639: }
640: }
641: }
642:
643:
644: # ------------------------------------------ Find out current server userload
645: sub userload {
646: my $numusers=0;
647: {
648: opendir(LONIDS,$perlvar{'lonIDsDir'});
649: my $filename;
650: my $curtime=time;
651: while ($filename=readdir(LONIDS)) {
652: next if ($filename eq '.' || $filename eq '..');
653: next if ($filename =~ /publicuser_\d+\.id/);
654: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
655: if ($curtime-$mtime < 1800) { $numusers++; }
656: }
657: closedir(LONIDS);
658: }
659: my $userloadpercent=0;
660: my $maxuserload=$perlvar{'lonUserLoadLim'};
661: if ($maxuserload) {
662: $userloadpercent=100*$numusers/$maxuserload;
663: }
664: $userloadpercent=sprintf("%.2f",$userloadpercent);
665: return $userloadpercent;
666: }
667:
668: # ------------------------------------------ Fight off request when overloaded
669:
670: sub overloaderror {
671: my ($r,$checkserver)=@_;
672: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
673: my $loadavg;
674: if ($checkserver eq $perlvar{'lonHostID'}) {
675: open(my $loadfile,'/proc/loadavg');
676: $loadavg=<$loadfile>;
677: $loadavg =~ s/\s.*//g;
678: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
679: close($loadfile);
680: } else {
681: $loadavg=&reply('load',$checkserver);
682: }
683: my $overload=$loadavg-100;
684: if ($overload>0) {
685: $r->err_headers_out->{'Retry-After'}=$overload;
686: $r->log_error('Overload of '.$overload.' on '.$checkserver);
687: return 413;
688: }
689: return '';
690: }
691:
692: # ------------------------------ Find server with least workload from spare.tab
693:
694: sub spareserver {
695: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
696: my $spare_server;
697: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
698: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
699: : $userloadpercent;
700:
701: foreach my $try_server (@{ $spareid{'primary'} }) {
702: ($spare_server, $lowest_load) =
703: &compare_server_load($try_server, $spare_server, $lowest_load);
704: }
705:
706: my $found_server = ($spare_server ne '' && $lowest_load < 100);
707:
708: if (!$found_server) {
709: foreach my $try_server (@{ $spareid{'default'} }) {
710: ($spare_server, $lowest_load) =
711: &compare_server_load($try_server, $spare_server, $lowest_load);
712: }
713: }
714:
715: if (!$want_server_name) {
716: my $protocol = 'http';
717: if ($protocol{$spare_server} eq 'https') {
718: $protocol = $protocol{$spare_server};
719: }
720: if (defined($spare_server)) {
721: my $hostname = &hostname($spare_server);
722: if (defined($hostname)) {
723: $spare_server = $protocol.'://'.$hostname;
724: }
725: }
726: }
727: return $spare_server;
728: }
729:
730: sub compare_server_load {
731: my ($try_server, $spare_server, $lowest_load) = @_;
732:
733: my $loadans = &reply('load', $try_server);
734: my $userloadans = &reply('userload',$try_server);
735:
736: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
737: next; #didn't get a number from the server
738: }
739:
740: my $load;
741: if ($loadans =~ /\d/) {
742: if ($userloadans =~ /\d/) {
743: #both are numbers, pick the bigger one
744: $load = ($loadans > $userloadans) ? $loadans
745: : $userloadans;
746: } else {
747: $load = $loadans;
748: }
749: } else {
750: $load = $userloadans;
751: }
752:
753: if (($load =~ /\d/) && ($load < $lowest_load)) {
754: $spare_server = $try_server;
755: $lowest_load = $load;
756: }
757: return ($spare_server,$lowest_load);
758: }
759:
760: # --------------------------- ask offload servers if user already has a session
761: sub find_existing_session {
762: my ($udom,$uname) = @_;
763: foreach my $try_server (@{ $spareid{'primary'} },
764: @{ $spareid{'default'} }) {
765: return $try_server if (&has_user_session($try_server, $udom, $uname));
766: }
767: return;
768: }
769:
770: # -------------------------------- ask if server already has a session for user
771: sub has_user_session {
772: my ($lonid,$udom,$uname) = @_;
773: my $result = &reply(join(':','userhassession',
774: map {&escape($_)} ($udom,$uname)),$lonid);
775: return 1 if ($result eq 'ok');
776:
777: return 0;
778: }
779:
780: # --------------------------------------------- Try to change a user's password
781:
782: sub changepass {
783: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
784: $currentpass = &escape($currentpass);
785: $newpass = &escape($newpass);
786: my $lonhost = $perlvar{'lonHostID'};
787: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
788: $server);
789: if (! $answer) {
790: &logthis("No reply on password change request to $server ".
791: "by $uname in domain $udom.");
792: } elsif ($answer =~ "^ok") {
793: &logthis("$uname in $udom successfully changed their password ".
794: "on $server.");
795: } elsif ($answer =~ "^pwchange_failure") {
796: &logthis("$uname in $udom was unable to change their password ".
797: "on $server. The action was blocked by either lcpasswd ".
798: "or pwchange");
799: } elsif ($answer =~ "^non_authorized") {
800: &logthis("$uname in $udom did not get their password correct when ".
801: "attempting to change it on $server.");
802: } elsif ($answer =~ "^auth_mode_error") {
803: &logthis("$uname in $udom attempted to change their password despite ".
804: "not being locally or internally authenticated on $server.");
805: } elsif ($answer =~ "^unknown_user") {
806: &logthis("$uname in $udom attempted to change their password ".
807: "on $server but were unable to because $server is not ".
808: "their home server.");
809: } elsif ($answer =~ "^refused") {
810: &logthis("$server refused to change $uname in $udom password because ".
811: "it was sent an unencrypted request to change the password.");
812: } elsif ($answer =~ "invalid_client") {
813: &logthis("$server refused to change $uname in $udom password because ".
814: "it was a reset by e-mail originating from an invalid server.");
815: }
816: return $answer;
817: }
818:
819: # ----------------------- Try to determine user's current authentication scheme
820:
821: sub queryauthenticate {
822: my ($uname,$udom)=@_;
823: my $uhome=&homeserver($uname,$udom);
824: if (!$uhome) {
825: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
826: return 'no_host';
827: }
828: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
829: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
830: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
831: }
832: return $answer;
833: }
834:
835: # --------- Try to authenticate user from domain's lib servers (first this one)
836:
837: sub authenticate {
838: my ($uname,$upass,$udom,$checkdefauth)=@_;
839: $upass=&escape($upass);
840: $uname= &LONCAPA::clean_username($uname);
841: my $uhome=&homeserver($uname,$udom,1);
842: my $newhome;
843: if ((!$uhome) || ($uhome eq 'no_host')) {
844: # Maybe the machine was offline and only re-appeared again recently?
845: &reconlonc();
846: # One more
847: $uhome=&homeserver($uname,$udom,1);
848: if (($uhome eq 'no_host') && $checkdefauth) {
849: if (defined(&domain($udom,'primary'))) {
850: $newhome=&domain($udom,'primary');
851: }
852: if ($newhome ne '') {
853: $uhome = $newhome;
854: }
855: }
856: if ((!$uhome) || ($uhome eq 'no_host')) {
857: &logthis("User $uname at $udom is unknown in authenticate");
858: return 'no_host';
859: }
860: }
861: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
862: if ($answer eq 'authorized') {
863: if ($newhome) {
864: &logthis("User $uname at $udom authorized by $uhome, but needs account");
865: return 'no_account_on_host';
866: } else {
867: &logthis("User $uname at $udom authorized by $uhome");
868: return $uhome;
869: }
870: }
871: if ($answer eq 'non_authorized') {
872: &logthis("User $uname at $udom rejected by $uhome");
873: return 'no_host';
874: }
875: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
876: return 'no_host';
877: }
878:
879: # ---------------------- Find the homebase for a user from domain's lib servers
880:
881: my %homecache;
882: sub homeserver {
883: my ($uname,$udom,$ignoreBadCache)=@_;
884: my $index="$uname:$udom";
885:
886: if (exists($homecache{$index})) { return $homecache{$index}; }
887:
888: my %servers = &get_servers($udom,'library');
889: foreach my $tryserver (keys(%servers)) {
890: next if ($ignoreBadCache ne 'true' &&
891: exists($badServerCache{$tryserver}));
892:
893: my $answer=reply("home:$udom:$uname",$tryserver);
894: if ($answer eq 'found') {
895: delete($badServerCache{$tryserver});
896: return $homecache{$index}=$tryserver;
897: } elsif ($answer eq 'no_host') {
898: $badServerCache{$tryserver}=1;
899: }
900: }
901: return 'no_host';
902: }
903:
904: # ------------------------------------- Find the usernames behind a list of IDs
905:
906: sub idget {
907: my ($udom,@ids)=@_;
908: my %returnhash=();
909:
910: my %servers = &get_servers($udom,'library');
911: foreach my $tryserver (keys(%servers)) {
912: my $idlist=join('&',@ids);
913: $idlist=~tr/A-Z/a-z/;
914: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
915: my @answer=();
916: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
917: @answer=split(/\&/,$reply);
918: } ;
919: my $i;
920: for ($i=0;$i<=$#ids;$i++) {
921: if ($answer[$i]) {
922: $returnhash{$ids[$i]}=$answer[$i];
923: }
924: }
925: }
926: return %returnhash;
927: }
928:
929: # ------------------------------------- Find the IDs behind a list of usernames
930:
931: sub idrget {
932: my ($udom,@unames)=@_;
933: my %returnhash=();
934: foreach my $uname (@unames) {
935: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
936: }
937: return %returnhash;
938: }
939:
940: # ------------------------------- Store away a list of names and associated IDs
941:
942: sub idput {
943: my ($udom,%ids)=@_;
944: my %servers=();
945: foreach my $uname (keys(%ids)) {
946: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
947: my $uhom=&homeserver($uname,$udom);
948: if ($uhom ne 'no_host') {
949: my $id=&escape($ids{$uname});
950: $id=~tr/A-Z/a-z/;
951: my $esc_unam=&escape($uname);
952: if ($servers{$uhom}) {
953: $servers{$uhom}.='&'.$id.'='.$esc_unam;
954: } else {
955: $servers{$uhom}=$id.'='.$esc_unam;
956: }
957: }
958: }
959: foreach my $server (keys(%servers)) {
960: &critical('idput:'.$udom.':'.$servers{$server},$server);
961: }
962: }
963:
964: # ------------------------------dump from db file owned by domainconfig user
965: sub dump_dom {
966: my ($namespace,$udom,$regexp,$range)=@_;
967: if (!$udom) {
968: $udom=$env{'user.domain'};
969: }
970: my %returnhash;
971: if ($udom) {
972: my $uname = &get_domainconfiguser($udom);
973: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
974: }
975: return %returnhash;
976: }
977:
978: # ------------------------------------------ get items from domain db files
979:
980: sub get_dom {
981: my ($namespace,$storearr,$udom,$uhome)=@_;
982: my $items='';
983: foreach my $item (@$storearr) {
984: $items.=&escape($item).'&';
985: }
986: $items=~s/\&$//;
987: if (!$udom) {
988: $udom=$env{'user.domain'};
989: if (defined(&domain($udom,'primary'))) {
990: $uhome=&domain($udom,'primary');
991: } else {
992: undef($uhome);
993: }
994: } else {
995: if (!$uhome) {
996: if (defined(&domain($udom,'primary'))) {
997: $uhome=&domain($udom,'primary');
998: }
999: }
1000: }
1001: if ($udom && $uhome && ($uhome ne 'no_host')) {
1002: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1003: my %returnhash;
1004: if ($rep eq '' || $rep =~ /^error: 2 /) {
1005: return %returnhash;
1006: }
1007: my @pairs=split(/\&/,$rep);
1008: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1009: return @pairs;
1010: }
1011: my $i=0;
1012: foreach my $item (@$storearr) {
1013: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1014: $i++;
1015: }
1016: return %returnhash;
1017: } else {
1018: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1019: }
1020: }
1021:
1022: # -------------------------------------------- put items in domain db files
1023:
1024: sub put_dom {
1025: my ($namespace,$storehash,$udom,$uhome)=@_;
1026: if (!$udom) {
1027: $udom=$env{'user.domain'};
1028: if (defined(&domain($udom,'primary'))) {
1029: $uhome=&domain($udom,'primary');
1030: } else {
1031: undef($uhome);
1032: }
1033: } else {
1034: if (!$uhome) {
1035: if (defined(&domain($udom,'primary'))) {
1036: $uhome=&domain($udom,'primary');
1037: }
1038: }
1039: }
1040: if ($udom && $uhome && ($uhome ne 'no_host')) {
1041: my $items='';
1042: foreach my $item (keys(%$storehash)) {
1043: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1044: }
1045: $items=~s/\&$//;
1046: return &reply("putdom:$udom:$namespace:$items",$uhome);
1047: } else {
1048: &logthis("put_dom failed - no homeserver and/or domain");
1049: }
1050: }
1051:
1052: # --------------------- newput for items in db file owned by domainconfig user
1053: sub newput_dom {
1054: my ($namespace,$storehash,$udom) = @_;
1055: my $result;
1056: if (!$udom) {
1057: $udom=$env{'user.domain'};
1058: }
1059: if ($udom) {
1060: my $uname = &get_domainconfiguser($udom);
1061: $result = &newput($namespace,$storehash,$udom,$uname);
1062: }
1063: return $result;
1064: }
1065:
1066: # --------------------- delete for items in db file owned by domainconfig user
1067: sub del_dom {
1068: my ($namespace,$storearr,$udom)=@_;
1069: if (ref($storearr) eq 'ARRAY') {
1070: if (!$udom) {
1071: $udom=$env{'user.domain'};
1072: }
1073: if ($udom) {
1074: my $uname = &get_domainconfiguser($udom);
1075: return &del($namespace,$storearr,$udom,$uname);
1076: }
1077: }
1078: }
1079:
1080: # ----------------------------------construct domainconfig user for a domain
1081: sub get_domainconfiguser {
1082: my ($udom) = @_;
1083: return $udom.'-domainconfig';
1084: }
1085:
1086: sub retrieve_inst_usertypes {
1087: my ($udom) = @_;
1088: my (%returnhash,@order);
1089: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1090: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1091: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1092: %returnhash = %{$domdefs{'inststatustypes'}};
1093: @order = @{$domdefs{'inststatusorder'}};
1094: } else {
1095: if (defined(&domain($udom,'primary'))) {
1096: my $uhome=&domain($udom,'primary');
1097: my $rep=&reply("inst_usertypes:$udom",$uhome);
1098: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1099: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1100: return (\%returnhash,\@order);
1101: }
1102: my ($hashitems,$orderitems) = split(/:/,$rep);
1103: my @pairs=split(/\&/,$hashitems);
1104: foreach my $item (@pairs) {
1105: my ($key,$value)=split(/=/,$item,2);
1106: $key = &unescape($key);
1107: next if ($key =~ /^error: 2 /);
1108: $returnhash{$key}=&thaw_unescape($value);
1109: }
1110: my @esc_order = split(/\&/,$orderitems);
1111: foreach my $item (@esc_order) {
1112: push(@order,&unescape($item));
1113: }
1114: } else {
1115: &logthis("get_dom failed - no primary domain server for $udom");
1116: }
1117: }
1118: return (\%returnhash,\@order);
1119: }
1120:
1121: sub is_domainimage {
1122: my ($url) = @_;
1123: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1124: if (&domain($1) ne '') {
1125: return '1';
1126: }
1127: }
1128: return;
1129: }
1130:
1131: sub inst_directory_query {
1132: my ($srch) = @_;
1133: my $udom = $srch->{'srchdomain'};
1134: my %results;
1135: my $homeserver = &domain($udom,'primary');
1136: my $outcome;
1137: if ($homeserver ne '') {
1138: my $queryid=&reply("querysend:instdirsearch:".
1139: &escape($srch->{'srchby'}).':'.
1140: &escape($srch->{'srchterm'}).':'.
1141: &escape($srch->{'srchtype'}),$homeserver);
1142: my $host=&hostname($homeserver);
1143: if ($queryid !~/^\Q$host\E\_/) {
1144: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1145: return;
1146: }
1147: my $response = &get_query_reply($queryid);
1148: my $maxtries = 5;
1149: my $tries = 1;
1150: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1151: $response = &get_query_reply($queryid);
1152: $tries ++;
1153: }
1154:
1155: if (!&error($response) && $response ne 'refused') {
1156: if ($response eq 'unavailable') {
1157: $outcome = $response;
1158: } else {
1159: $outcome = 'ok';
1160: my @matches = split(/\n/,$response);
1161: foreach my $match (@matches) {
1162: my ($key,$value) = split(/=/,$match);
1163: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1164: }
1165: }
1166: }
1167: }
1168: return ($outcome,%results);
1169: }
1170:
1171: sub usersearch {
1172: my ($srch) = @_;
1173: my $dom = $srch->{'srchdomain'};
1174: my %results;
1175: my %libserv = &all_library();
1176: my $query = 'usersearch';
1177: foreach my $tryserver (keys(%libserv)) {
1178: if (&host_domain($tryserver) eq $dom) {
1179: my $host=&hostname($tryserver);
1180: my $queryid=
1181: &reply("querysend:".&escape($query).':'.
1182: &escape($srch->{'srchby'}).':'.
1183: &escape($srch->{'srchtype'}).':'.
1184: &escape($srch->{'srchterm'}),$tryserver);
1185: if ($queryid !~/^\Q$host\E\_/) {
1186: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1187: next;
1188: }
1189: my $reply = &get_query_reply($queryid);
1190: my $maxtries = 1;
1191: my $tries = 1;
1192: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1193: $reply = &get_query_reply($queryid);
1194: $tries ++;
1195: }
1196: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1197: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1198: } else {
1199: my @matches;
1200: if ($reply =~ /\n/) {
1201: @matches = split(/\n/,$reply);
1202: } else {
1203: @matches = split(/\&/,$reply);
1204: }
1205: foreach my $match (@matches) {
1206: my ($uname,$udom,%userhash);
1207: foreach my $entry (split(/:/,$match)) {
1208: my ($key,$value) =
1209: map {&unescape($_);} split(/=/,$entry);
1210: $userhash{$key} = $value;
1211: if ($key eq 'username') {
1212: $uname = $value;
1213: } elsif ($key eq 'domain') {
1214: $udom = $value;
1215: }
1216: }
1217: $results{$uname.':'.$udom} = \%userhash;
1218: }
1219: }
1220: }
1221: }
1222: return %results;
1223: }
1224:
1225: sub get_instuser {
1226: my ($udom,$uname,$id) = @_;
1227: my $homeserver = &domain($udom,'primary');
1228: my ($outcome,%results);
1229: if ($homeserver ne '') {
1230: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1231: &escape($id).':'.&escape($udom),$homeserver);
1232: my $host=&hostname($homeserver);
1233: if ($queryid !~/^\Q$host\E\_/) {
1234: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1235: return;
1236: }
1237: my $response = &get_query_reply($queryid);
1238: my $maxtries = 5;
1239: my $tries = 1;
1240: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1241: $response = &get_query_reply($queryid);
1242: $tries ++;
1243: }
1244: if (!&error($response) && $response ne 'refused') {
1245: if ($response eq 'unavailable') {
1246: $outcome = $response;
1247: } else {
1248: $outcome = 'ok';
1249: my @matches = split(/\n/,$response);
1250: foreach my $match (@matches) {
1251: my ($key,$value) = split(/=/,$match);
1252: $results{&unescape($key)} = &thaw_unescape($value);
1253: }
1254: }
1255: }
1256: }
1257: my %userinfo;
1258: if (ref($results{$uname}) eq 'HASH') {
1259: %userinfo = %{$results{$uname}};
1260: }
1261: return ($outcome,%userinfo);
1262: }
1263:
1264: sub inst_rulecheck {
1265: my ($udom,$uname,$id,$item,$rules) = @_;
1266: my %returnhash;
1267: if ($udom ne '') {
1268: if (ref($rules) eq 'ARRAY') {
1269: @{$rules} = map {&escape($_);} (@{$rules});
1270: my $rulestr = join(':',@{$rules});
1271: my $homeserver=&domain($udom,'primary');
1272: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1273: my $response;
1274: if ($item eq 'username') {
1275: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1276: ':'.&escape($uname).':'.$rulestr,
1277: $homeserver));
1278: } elsif ($item eq 'id') {
1279: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1280: ':'.&escape($id).':'.$rulestr,
1281: $homeserver));
1282: } elsif ($item eq 'selfcreate') {
1283: $response=&unescape(&reply('instselfcreatecheck:'.
1284: &escape($udom).':'.&escape($uname).
1285: ':'.$rulestr,$homeserver));
1286: }
1287: if ($response ne 'refused') {
1288: my @pairs=split(/\&/,$response);
1289: foreach my $item (@pairs) {
1290: my ($key,$value)=split(/=/,$item,2);
1291: $key = &unescape($key);
1292: next if ($key =~ /^error: 2 /);
1293: $returnhash{$key}=&thaw_unescape($value);
1294: }
1295: }
1296: }
1297: }
1298: }
1299: return %returnhash;
1300: }
1301:
1302: sub inst_userrules {
1303: my ($udom,$check) = @_;
1304: my (%ruleshash,@ruleorder);
1305: if ($udom ne '') {
1306: my $homeserver=&domain($udom,'primary');
1307: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1308: my $response;
1309: if ($check eq 'id') {
1310: $response=&reply('instidrules:'.&escape($udom),
1311: $homeserver);
1312: } elsif ($check eq 'email') {
1313: $response=&reply('instemailrules:'.&escape($udom),
1314: $homeserver);
1315: } else {
1316: $response=&reply('instuserrules:'.&escape($udom),
1317: $homeserver);
1318: }
1319: if (($response ne 'refused') && ($response ne 'error') &&
1320: ($response ne 'unknown_cmd') &&
1321: ($response ne 'no_such_host')) {
1322: my ($hashitems,$orderitems) = split(/:/,$response);
1323: my @pairs=split(/\&/,$hashitems);
1324: foreach my $item (@pairs) {
1325: my ($key,$value)=split(/=/,$item,2);
1326: $key = &unescape($key);
1327: next if ($key =~ /^error: 2 /);
1328: $ruleshash{$key}=&thaw_unescape($value);
1329: }
1330: my @esc_order = split(/\&/,$orderitems);
1331: foreach my $item (@esc_order) {
1332: push(@ruleorder,&unescape($item));
1333: }
1334: }
1335: }
1336: }
1337: return (\%ruleshash,\@ruleorder);
1338: }
1339:
1340: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1341:
1342: sub get_domain_defaults {
1343: my ($domain) = @_;
1344: my $cachetime = 60*60*24;
1345: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1346: if (defined($cached)) {
1347: if (ref($result) eq 'HASH') {
1348: return %{$result};
1349: }
1350: }
1351: my %domdefaults;
1352: my %domconfig =
1353: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1354: 'requestcourses','inststatus',
1355: 'coursedefaults'],$domain);
1356: if (ref($domconfig{'defaults'}) eq 'HASH') {
1357: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1358: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1359: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1360: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1361: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1362: } else {
1363: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1364: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1365: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1366: }
1367: if (ref($domconfig{'quotas'}) eq 'HASH') {
1368: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1369: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1370: } else {
1371: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1372: }
1373: my @usertools = ('aboutme','blog','portfolio');
1374: foreach my $item (@usertools) {
1375: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1376: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1377: }
1378: }
1379: }
1380: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1381: foreach my $item ('official','unofficial','community') {
1382: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1383: }
1384: }
1385: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1386: foreach my $item ('inststatustypes','inststatusorder') {
1387: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1388: }
1389: }
1390: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1391: foreach my $item ('canuse_pdfforms') {
1392: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1393: }
1394: }
1395: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1396: $cachetime);
1397: return %domdefaults;
1398: }
1399:
1400: # --------------------------------------------------- Assign a key to a student
1401:
1402: sub assign_access_key {
1403: #
1404: # a valid key looks like uname:udom#comments
1405: # comments are being appended
1406: #
1407: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1408: $kdom=
1409: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1410: $knum=
1411: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1412: $cdom=
1413: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1414: $cnum=
1415: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1416: $udom=$env{'user.name'} unless (defined($udom));
1417: $uname=$env{'user.domain'} unless (defined($uname));
1418: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1419: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1420: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1421: # assigned to this person
1422: # - this should not happen,
1423: # unless something went wrong
1424: # the first time around
1425: # ready to assign
1426: $logentry=$1.'; '.$logentry;
1427: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1428: $kdom,$knum) eq 'ok') {
1429: # key now belongs to user
1430: my $envkey='key.'.$cdom.'_'.$cnum;
1431: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1432: &appenv({'environment.'.$envkey => $ckey});
1433: return 'ok';
1434: } else {
1435: return
1436: 'error: Count not permanently assign key, will need to be re-entered later.';
1437: }
1438: } else {
1439: return 'error: Could not assign key, try again later.';
1440: }
1441: } elsif (!$existing{$ckey}) {
1442: # the key does not exist
1443: return 'error: The key does not exist';
1444: } else {
1445: # the key is somebody else's
1446: return 'error: The key is already in use';
1447: }
1448: }
1449:
1450: # ------------------------------------------ put an additional comment on a key
1451:
1452: sub comment_access_key {
1453: #
1454: # a valid key looks like uname:udom#comments
1455: # comments are being appended
1456: #
1457: my ($ckey,$cdom,$cnum,$logentry)=@_;
1458: $cdom=
1459: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1460: $cnum=
1461: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1462: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1463: if ($existing{$ckey}) {
1464: $existing{$ckey}.='; '.$logentry;
1465: # ready to assign
1466: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1467: $cdom,$cnum) eq 'ok') {
1468: return 'ok';
1469: } else {
1470: return 'error: Count not store comment.';
1471: }
1472: } else {
1473: # the key does not exist
1474: return 'error: The key does not exist';
1475: }
1476: }
1477:
1478: # ------------------------------------------------------ Generate a set of keys
1479:
1480: sub generate_access_keys {
1481: my ($number,$cdom,$cnum,$logentry)=@_;
1482: $cdom=
1483: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1484: $cnum=
1485: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1486: unless (&allowed('mky',$cdom)) { return 0; }
1487: unless (($cdom) && ($cnum)) { return 0; }
1488: if ($number>10000) { return 0; }
1489: sleep(2); # make sure don't get same seed twice
1490: srand(time()^($$+($$<<15))); # from "Programming Perl"
1491: my $total=0;
1492: for (my $i=1;$i<=$number;$i++) {
1493: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1494: sprintf("%lx",int(100000*rand)).'-'.
1495: sprintf("%lx",int(100000*rand));
1496: $newkey=~s/1/g/g; # folks mix up 1 and l
1497: $newkey=~s/0/h/g; # and also 0 and O
1498: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1499: if ($existing{$newkey}) {
1500: $i--;
1501: } else {
1502: if (&put('accesskeys',
1503: { $newkey => '# generated '.localtime().
1504: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1505: '; '.$logentry },
1506: $cdom,$cnum) eq 'ok') {
1507: $total++;
1508: }
1509: }
1510: }
1511: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1512: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1513: return $total;
1514: }
1515:
1516: # ------------------------------------------------------- Validate an accesskey
1517:
1518: sub validate_access_key {
1519: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1520: $cdom=
1521: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1522: $cnum=
1523: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1524: $udom=$env{'user.domain'} unless (defined($udom));
1525: $uname=$env{'user.name'} unless (defined($uname));
1526: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1527: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1528: }
1529:
1530: # ------------------------------------- Find the section of student in a course
1531: sub devalidate_getsection_cache {
1532: my ($udom,$unam,$courseid)=@_;
1533: my $hashid="$udom:$unam:$courseid";
1534: &devalidate_cache_new('getsection',$hashid);
1535: }
1536:
1537: sub courseid_to_courseurl {
1538: my ($courseid) = @_;
1539: #already url style courseid
1540: return $courseid if ($courseid =~ m{^/});
1541:
1542: if (exists($env{'course.'.$courseid.'.num'})) {
1543: my $cnum = $env{'course.'.$courseid.'.num'};
1544: my $cdom = $env{'course.'.$courseid.'.domain'};
1545: return "/$cdom/$cnum";
1546: }
1547:
1548: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1549: if (exists($courseinfo{'num'})) {
1550: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1551: }
1552:
1553: return undef;
1554: }
1555:
1556: sub getsection {
1557: my ($udom,$unam,$courseid)=@_;
1558: my $cachetime=1800;
1559:
1560: my $hashid="$udom:$unam:$courseid";
1561: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1562: if (defined($cached)) { return $result; }
1563:
1564: my %Pending;
1565: my %Expired;
1566: #
1567: # Each role can either have not started yet (pending), be active,
1568: # or have expired.
1569: #
1570: # If there is an active role, we are done.
1571: #
1572: # If there is more than one role which has not started yet,
1573: # choose the one which will start sooner
1574: # If there is one role which has not started yet, return it.
1575: #
1576: # If there is more than one expired role, choose the one which ended last.
1577: # If there is a role which has expired, return it.
1578: #
1579: $courseid = &courseid_to_courseurl($courseid);
1580: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1581: foreach my $key (keys(%roleshash)) {
1582: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1583: my $section=$1;
1584: if ($key eq $courseid.'_st') { $section=''; }
1585: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1586: my $now=time;
1587: if (defined($end) && $end && ($now > $end)) {
1588: $Expired{$end}=$section;
1589: next;
1590: }
1591: if (defined($start) && $start && ($now < $start)) {
1592: $Pending{$start}=$section;
1593: next;
1594: }
1595: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1596: }
1597: #
1598: # Presumedly there will be few matching roles from the above
1599: # loop and the sorting time will be negligible.
1600: if (scalar(keys(%Pending))) {
1601: my ($time) = sort {$a <=> $b} keys(%Pending);
1602: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1603: }
1604: if (scalar(keys(%Expired))) {
1605: my @sorted = sort {$a <=> $b} keys(%Expired);
1606: my $time = pop(@sorted);
1607: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1608: }
1609: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1610: }
1611:
1612: sub save_cache {
1613: &purge_remembered();
1614: #&Apache::loncommon::validate_page();
1615: undef(%env);
1616: undef($env_loaded);
1617: }
1618:
1619: my $to_remember=-1;
1620: my %remembered;
1621: my %accessed;
1622: my $kicks=0;
1623: my $hits=0;
1624: sub make_key {
1625: my ($name,$id) = @_;
1626: if (length($id) > 65
1627: && length(&escape($id)) > 200) {
1628: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1629: }
1630: return &escape($name.':'.$id);
1631: }
1632:
1633: sub devalidate_cache_new {
1634: my ($name,$id,$debug) = @_;
1635: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1636: $id=&make_key($name,$id);
1637: $memcache->delete($id);
1638: delete($remembered{$id});
1639: delete($accessed{$id});
1640: }
1641:
1642: sub is_cached_new {
1643: my ($name,$id,$debug) = @_;
1644: $id=&make_key($name,$id);
1645: if (exists($remembered{$id})) {
1646: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1647: $accessed{$id}=[&gettimeofday()];
1648: $hits++;
1649: return ($remembered{$id},1);
1650: }
1651: my $value = $memcache->get($id);
1652: if (!(defined($value))) {
1653: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1654: return (undef,undef);
1655: }
1656: if ($value eq '__undef__') {
1657: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1658: $value=undef;
1659: }
1660: &make_room($id,$value,$debug);
1661: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1662: return ($value,1);
1663: }
1664:
1665: sub do_cache_new {
1666: my ($name,$id,$value,$time,$debug) = @_;
1667: $id=&make_key($name,$id);
1668: my $setvalue=$value;
1669: if (!defined($setvalue)) {
1670: $setvalue='__undef__';
1671: }
1672: if (!defined($time) ) {
1673: $time=600;
1674: }
1675: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1676: my $result = $memcache->set($id,$setvalue,$time);
1677: if (! $result) {
1678: &logthis("caching of id -> $id failed");
1679: $memcache->disconnect_all();
1680: }
1681: # need to make a copy of $value
1682: &make_room($id,$value,$debug);
1683: return $value;
1684: }
1685:
1686: sub make_room {
1687: my ($id,$value,$debug)=@_;
1688:
1689: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1690: : $value;
1691: if ($to_remember<0) { return; }
1692: $accessed{$id}=[&gettimeofday()];
1693: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1694: my $to_kick;
1695: my $max_time=0;
1696: foreach my $other (keys(%accessed)) {
1697: if (&tv_interval($accessed{$other}) > $max_time) {
1698: $to_kick=$other;
1699: $max_time=&tv_interval($accessed{$other});
1700: }
1701: }
1702: delete($remembered{$to_kick});
1703: delete($accessed{$to_kick});
1704: $kicks++;
1705: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1706: return;
1707: }
1708:
1709: sub purge_remembered {
1710: #&logthis("Tossing ".scalar(keys(%remembered)));
1711: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1712: undef(%remembered);
1713: undef(%accessed);
1714: }
1715: # ------------------------------------- Read an entry from a user's environment
1716:
1717: sub userenvironment {
1718: my ($udom,$unam,@what)=@_;
1719: my $items;
1720: foreach my $item (@what) {
1721: $items.=&escape($item).'&';
1722: }
1723: $items=~s/\&$//;
1724: my %returnhash=();
1725: my $uhome = &homeserver($unam,$udom);
1726: unless ($uhome eq 'no_host') {
1727: my @answer=split(/\&/,
1728: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1729: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
1730: return %returnhash;
1731: }
1732: my $i;
1733: for ($i=0;$i<=$#what;$i++) {
1734: $returnhash{$what[$i]}=&unescape($answer[$i]);
1735: }
1736: }
1737: return %returnhash;
1738: }
1739:
1740: # ---------------------------------------------------------- Get a studentphoto
1741: sub studentphoto {
1742: my ($udom,$unam,$ext) = @_;
1743: my $home=&Apache::lonnet::homeserver($unam,$udom);
1744: if (defined($env{'request.course.id'})) {
1745: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1746: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1747: return(&retrievestudentphoto($udom,$unam,$ext));
1748: } else {
1749: my ($result,$perm_reqd)=
1750: &Apache::lonnet::auto_photo_permission($unam,$udom);
1751: if ($result eq 'ok') {
1752: if (!($perm_reqd eq 'yes')) {
1753: return(&retrievestudentphoto($udom,$unam,$ext));
1754: }
1755: }
1756: }
1757: }
1758: } else {
1759: my ($result,$perm_reqd) =
1760: &Apache::lonnet::auto_photo_permission($unam,$udom);
1761: if ($result eq 'ok') {
1762: if (!($perm_reqd eq 'yes')) {
1763: return(&retrievestudentphoto($udom,$unam,$ext));
1764: }
1765: }
1766: }
1767: return '/adm/lonKaputt/lonlogo_broken.gif';
1768: }
1769:
1770: sub retrievestudentphoto {
1771: my ($udom,$unam,$ext,$type) = @_;
1772: my $home=&Apache::lonnet::homeserver($unam,$udom);
1773: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1774: if ($ret eq 'ok') {
1775: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1776: if ($type eq 'thumbnail') {
1777: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1778: }
1779: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1780: return $tokenurl;
1781: } else {
1782: if ($type eq 'thumbnail') {
1783: return '/adm/lonKaputt/genericstudent_tn.gif';
1784: } else {
1785: return '/adm/lonKaputt/lonlogo_broken.gif';
1786: }
1787: }
1788: }
1789:
1790: # -------------------------------------------------------------------- New chat
1791:
1792: sub chatsend {
1793: my ($newentry,$anon,$group)=@_;
1794: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1795: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1796: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1797: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1798: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1799: &escape($newentry)).':'.$group,$chome);
1800: }
1801:
1802: # ------------------------------------------ Find current version of a resource
1803:
1804: sub getversion {
1805: my $fname=&clutter(shift);
1806: unless ($fname=~/^\/res\//) { return -1; }
1807: return ¤tversion(&filelocation('',$fname));
1808: }
1809:
1810: sub currentversion {
1811: my $fname=shift;
1812: my ($result,$cached)=&is_cached_new('resversion',$fname);
1813: if (defined($cached)) { return $result; }
1814: my $author=$fname;
1815: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1816: my ($udom,$uname)=split(/\//,$author);
1817: my $home=homeserver($uname,$udom);
1818: if ($home eq 'no_host') {
1819: return -1;
1820: }
1821: my $answer=reply("currentversion:$fname",$home);
1822: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1823: return -1;
1824: }
1825: return &do_cache_new('resversion',$fname,$answer,600);
1826: }
1827:
1828: # ----------------------------- Subscribe to a resource, return URL if possible
1829:
1830: sub subscribe {
1831: my $fname=shift;
1832: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1833: $fname=~s/[\n\r]//g;
1834: my $author=$fname;
1835: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1836: my ($udom,$uname)=split(/\//,$author);
1837: my $home=homeserver($uname,$udom);
1838: if ($home eq 'no_host') {
1839: return 'not_found';
1840: }
1841: my $answer=reply("sub:$fname",$home);
1842: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1843: $answer.=' by '.$home;
1844: }
1845: return $answer;
1846: }
1847:
1848: # -------------------------------------------------------------- Replicate file
1849:
1850: sub repcopy {
1851: my $filename=shift;
1852: $filename=~s/\/+/\//g;
1853: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1854: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1855: if ($filename=~m|^/home/httpd/html/userfiles/| or
1856: $filename=~m -^/*(uploaded|editupload)/-) {
1857: return &repcopy_userfile($filename);
1858: }
1859: $filename=~s/[\n\r]//g;
1860: my $transname="$filename.in.transfer";
1861: # FIXME: this should flock
1862: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1863: my $remoteurl=subscribe($filename);
1864: if ($remoteurl =~ /^con_lost by/) {
1865: &logthis("Subscribe returned $remoteurl: $filename");
1866: return 'unavailable';
1867: } elsif ($remoteurl eq 'not_found') {
1868: #&logthis("Subscribe returned not_found: $filename");
1869: return 'not_found';
1870: } elsif ($remoteurl =~ /^rejected by/) {
1871: &logthis("Subscribe returned $remoteurl: $filename");
1872: return 'forbidden';
1873: } elsif ($remoteurl eq 'directory') {
1874: return 'ok';
1875: } else {
1876: my $author=$filename;
1877: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1878: my ($udom,$uname)=split(/\//,$author);
1879: my $home=homeserver($uname,$udom);
1880: unless ($home eq $perlvar{'lonHostID'}) {
1881: my @parts=split(/\//,$filename);
1882: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1883: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1884: &logthis("Malconfiguration for replication: $filename");
1885: return 'bad_request';
1886: }
1887: my $count;
1888: for ($count=5;$count<$#parts;$count++) {
1889: $path.="/$parts[$count]";
1890: if ((-e $path)!=1) {
1891: mkdir($path,0777);
1892: }
1893: }
1894: my $ua=new LWP::UserAgent;
1895: my $request=new HTTP::Request('GET',"$remoteurl");
1896: my $response=$ua->request($request,$transname);
1897: if ($response->is_error()) {
1898: unlink($transname);
1899: my $message=$response->status_line;
1900: &logthis("<font color=\"blue\">WARNING:"
1901: ." LWP get: $message: $filename</font>");
1902: return 'unavailable';
1903: } else {
1904: if ($remoteurl!~/\.meta$/) {
1905: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1906: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1907: if ($mresponse->is_error()) {
1908: unlink($filename.'.meta');
1909: &logthis(
1910: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1911: }
1912: }
1913: rename($transname,$filename);
1914: return 'ok';
1915: }
1916: }
1917: }
1918: }
1919:
1920: # ------------------------------------------------ Get server side include body
1921: sub ssi_body {
1922: my ($filelink,%form)=@_;
1923: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1924: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1925: }
1926: my $output='';
1927: my $response;
1928: if ($filelink=~/^https?\:/) {
1929: ($output,$response)=&externalssi($filelink);
1930: } else {
1931: $filelink .= $filelink=~/\?/ ? '&' : '?';
1932: $filelink .= 'inhibitmenu=yes';
1933: ($output,$response)=&ssi($filelink,%form);
1934: }
1935: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1936: $output=~s/^.*?\<body[^\>]*\>//si;
1937: $output=~s/\<\/body\s*\>.*?$//si;
1938: if (wantarray) {
1939: return ($output, $response);
1940: } else {
1941: return $output;
1942: }
1943: }
1944:
1945: # --------------------------------------------------------- Server Side Include
1946:
1947: sub absolute_url {
1948: my ($host_name) = @_;
1949: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1950: if ($host_name eq '') {
1951: $host_name = $ENV{'SERVER_NAME'};
1952: }
1953: return $protocol.$host_name;
1954: }
1955:
1956: #
1957: # Server side include.
1958: # Parameters:
1959: # fn Possibly encrypted resource name/id.
1960: # form Hash that describes how the rendering should be done
1961: # and other things.
1962: # Returns:
1963: # Scalar context: The content of the response.
1964: # Array context: 2 element list of the content and the full response object.
1965: #
1966: sub ssi {
1967:
1968: my ($fn,%form)=@_;
1969: my $ua=new LWP::UserAgent;
1970: my $request;
1971:
1972: $form{'no_update_last_known'}=1;
1973: &Apache::lonenc::check_encrypt(\$fn);
1974: if (%form) {
1975: $request=new HTTP::Request('POST',&absolute_url().$fn);
1976: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1977: } else {
1978: $request=new HTTP::Request('GET',&absolute_url().$fn);
1979: }
1980:
1981: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1982: my $response=$ua->request($request);
1983:
1984: if (wantarray) {
1985: return ($response->content, $response);
1986: } else {
1987: return $response->content;
1988: }
1989: }
1990:
1991: sub externalssi {
1992: my ($url)=@_;
1993: my $ua=new LWP::UserAgent;
1994: my $request=new HTTP::Request('GET',$url);
1995: my $response=$ua->request($request);
1996: if (wantarray) {
1997: return ($response->content, $response);
1998: } else {
1999: return $response->content;
2000: }
2001: }
2002:
2003: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2004:
2005: sub allowuploaded {
2006: my ($srcurl,$url)=@_;
2007: $url=&clutter(&declutter($url));
2008: my $dir=$url;
2009: $dir=~s/\/[^\/]+$//;
2010: my %httpref=();
2011: my $httpurl=&hreflocation('',$url);
2012: $httpref{'httpref.'.$httpurl}=$srcurl;
2013: &Apache::lonnet::appenv(\%httpref);
2014: }
2015:
2016: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
2017: # input: action, courseID, current domain, intended
2018: # path to file, source of file, instruction to parse file for objects,
2019: # ref to hash for embedded objects,
2020: # ref to hash for codebase of java objects.
2021: #
2022: # output: url to file (if action was uploaddoc),
2023: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2024: #
2025: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2026: # course.
2027: #
2028: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2029: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2030: # course's home server.
2031: #
2032: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2033: # be copied from $source (current location) to
2034: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2035: # and will then be copied to
2036: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2037: # course's home server.
2038: #
2039: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2040: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2041: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2042: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2043: # in course's home server.
2044: #
2045:
2046: sub process_coursefile {
2047: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
2048: my $fetchresult;
2049: my $home=&homeserver($docuname,$docudom);
2050: if ($action eq 'propagate') {
2051: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2052: $home);
2053: } else {
2054: my $fpath = '';
2055: my $fname = $file;
2056: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2057: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2058: my $filepath = &build_filepath($fpath);
2059: if ($action eq 'copy') {
2060: if ($source eq '') {
2061: $fetchresult = 'no source file';
2062: return $fetchresult;
2063: } else {
2064: my $destination = $filepath.'/'.$fname;
2065: rename($source,$destination);
2066: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2067: $home);
2068: }
2069: } elsif ($action eq 'uploaddoc') {
2070: open(my $fh,'>'.$filepath.'/'.$fname);
2071: print $fh $env{'form.'.$source};
2072: close($fh);
2073: if ($parser eq 'parse') {
2074: my $mm = new File::MMagic;
2075: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2076: if ($mime_type eq 'text/html') {
2077: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2078: unless ($parse_result eq 'ok') {
2079: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2080: }
2081: }
2082: }
2083: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2084: $home);
2085: if ($fetchresult eq 'ok') {
2086: return '/uploaded/'.$fpath.'/'.$fname;
2087: } else {
2088: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2089: ' to host '.$home.': '.$fetchresult);
2090: return '/adm/notfound.html';
2091: }
2092: }
2093: }
2094: unless ( $fetchresult eq 'ok') {
2095: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2096: ' to host '.$home.': '.$fetchresult);
2097: }
2098: return $fetchresult;
2099: }
2100:
2101: sub build_filepath {
2102: my ($fpath) = @_;
2103: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2104: unless ($fpath eq '') {
2105: my @parts=split('/',$fpath);
2106: foreach my $part (@parts) {
2107: $filepath.= '/'.$part;
2108: if ((-e $filepath)!=1) {
2109: mkdir($filepath,0777);
2110: }
2111: }
2112: }
2113: return $filepath;
2114: }
2115:
2116: sub store_edited_file {
2117: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2118: my $file = $primary_url;
2119: $file =~ s#^/uploaded/$docudom/$docuname/##;
2120: my $fpath = '';
2121: my $fname = $file;
2122: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2123: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2124: my $filepath = &build_filepath($fpath);
2125: open(my $fh,'>'.$filepath.'/'.$fname);
2126: print $fh $content;
2127: close($fh);
2128: my $home=&homeserver($docuname,$docudom);
2129: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2130: $home);
2131: if ($$fetchresult eq 'ok') {
2132: return '/uploaded/'.$fpath.'/'.$fname;
2133: } else {
2134: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2135: ' to host '.$home.': '.$$fetchresult);
2136: return '/adm/notfound.html';
2137: }
2138: }
2139:
2140: sub clean_filename {
2141: my ($fname,$args)=@_;
2142: # Replace Windows backslashes by forward slashes
2143: $fname=~s/\\/\//g;
2144: if (!$args->{'keep_path'}) {
2145: # Get rid of everything but the actual filename
2146: $fname=~s/^.*\/([^\/]+)$/$1/;
2147: }
2148: # Replace spaces by underscores
2149: $fname=~s/\s+/\_/g;
2150: # Replace all other weird characters by nothing
2151: $fname=~s{[^/\w\.\-]}{}g;
2152: # Replace all .\d. sequences with _\d. so they no longer look like version
2153: # numbers
2154: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2155: return $fname;
2156: }
2157: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2158: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2159: # image with the same aspect ratio as the original, but with dimensions which do
2160: # not exceed $resizewidth and $resizeheight.
2161:
2162: sub resizeImage {
2163: my ($img_path,$resizewidth,$resizeheight) = @_;
2164: my $ima = Image::Magick->new;
2165: my $resized;
2166: if (-e $img_path) {
2167: $ima->Read($img_path);
2168: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2169: my $width = $ima->Get('width');
2170: my $height = $ima->Get('height');
2171: if ($width > $resizewidth) {
2172: my $factor = $width/$resizewidth;
2173: my $newheight = $height/$factor;
2174: $ima->Scale(width=>$resizewidth,height=>$newheight);
2175: $resized = 1;
2176: }
2177: }
2178: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2179: my $width = $ima->Get('width');
2180: my $height = $ima->Get('height');
2181: if ($height > $resizeheight) {
2182: my $factor = $height/$resizeheight;
2183: my $newwidth = $width/$factor;
2184: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2185: $resized = 1;
2186: }
2187: }
2188: if ($resized) {
2189: $ima->Write($img_path);
2190: }
2191: }
2192: return;
2193: }
2194:
2195: # --------------- Take an uploaded file and put it into the userfiles directory
2196: # input: $formname - the contents of the file are in $env{"form.$formname"}
2197: # the desired filenam is in $env{"form.$formname.filename"}
2198: # $coursedoc - if true up to the current course
2199: # if false
2200: # $subdir - directory in userfile to store the file into
2201: # $parser - instruction to parse file for objects ($parser = parse)
2202: # $allfiles - reference to hash for embedded objects
2203: # $codebase - reference to hash for codebase of java objects
2204: # $desuname - username for permanent storage of uploaded file
2205: # $dsetudom - domain for permanaent storage of uploaded file
2206: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2207: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2208: # $resizewidth - width (pixels) to which to resize uploaded image
2209: # $resizeheight - height (pixels) to which to resize uploaded image
2210: #
2211: # output: url of file in userspace, or error: <message>
2212: # or /adm/notfound.html if failure to upload occurse
2213:
2214: sub userfileupload {
2215: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2216: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight)=@_;
2217: if (!defined($subdir)) { $subdir='unknown'; }
2218: my $fname=$env{'form.'.$formname.'.filename'};
2219: $fname=&clean_filename($fname);
2220: # See if there is anything left
2221: unless ($fname) { return 'error: no uploaded file'; }
2222: chop($env{'form.'.$formname});
2223: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2224: my $now = time;
2225: my $filepath = 'tmp/helprequests/'.$now;
2226: my @parts=split(/\//,$filepath);
2227: my $fullpath = $perlvar{'lonDaemons'};
2228: for (my $i=0;$i<@parts;$i++) {
2229: $fullpath .= '/'.$parts[$i];
2230: if ((-e $fullpath)!=1) {
2231: mkdir($fullpath,0777);
2232: }
2233: }
2234: open(my $fh,'>'.$fullpath.'/'.$fname);
2235: print $fh $env{'form.'.$formname};
2236: close($fh);
2237: return $fullpath.'/'.$fname;
2238: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2239: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2240: '_'.$env{'user.domain'}.'/pending';
2241: my @parts=split(/\//,$filepath);
2242: my $fullpath = $perlvar{'lonDaemons'};
2243: for (my $i=0;$i<@parts;$i++) {
2244: $fullpath .= '/'.$parts[$i];
2245: if ((-e $fullpath)!=1) {
2246: mkdir($fullpath,0777);
2247: }
2248: }
2249: open(my $fh,'>'.$fullpath.'/'.$fname);
2250: print $fh $env{'form.'.$formname};
2251: close($fh);
2252: return $fullpath.'/'.$fname;
2253: }
2254: if ($subdir eq 'scantron') {
2255: $fname = 'scantron_orig_'.$fname;
2256: } else {
2257: # Create the directory if not present
2258: $fname="$subdir/$fname";
2259: }
2260: if ($coursedoc) {
2261: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2262: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2263: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2264: return &finishuserfileupload($docuname,$docudom,
2265: $formname,$fname,$parser,$allfiles,
2266: $codebase,$thumbwidth,$thumbheight,
2267: $resizewidth,$resizeheight);
2268: } else {
2269: $fname=$env{'form.folder'}.'/'.$fname;
2270: return &process_coursefile('uploaddoc',$docuname,$docudom,
2271: $fname,$formname,$parser,
2272: $allfiles,$codebase);
2273: }
2274: } elsif (defined($destuname)) {
2275: my $docuname=$destuname;
2276: my $docudom=$destudom;
2277: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2278: $parser,$allfiles,$codebase,
2279: $thumbwidth,$thumbheight,
2280: $resizewidth,$resizeheight);
2281:
2282: } else {
2283: my $docuname=$env{'user.name'};
2284: my $docudom=$env{'user.domain'};
2285: if (exists($env{'form.group'})) {
2286: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2287: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2288: }
2289: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2290: $parser,$allfiles,$codebase,
2291: $thumbwidth,$thumbheight,
2292: $resizewidth,$resizeheight);
2293: }
2294: }
2295:
2296: sub finishuserfileupload {
2297: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2298: $thumbwidth,$thumbheight,$resizewidth,$resizeheight) = @_;
2299: my $path=$docudom.'/'.$docuname.'/';
2300: my $filepath=$perlvar{'lonDocRoot'};
2301:
2302: my ($fnamepath,$file,$fetchthumb);
2303: $file=$fname;
2304: if ($fname=~m|/|) {
2305: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2306: $path.=$fnamepath.'/';
2307: }
2308: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2309: my $count;
2310: for ($count=4;$count<=$#parts;$count++) {
2311: $filepath.="/$parts[$count]";
2312: if ((-e $filepath)!=1) {
2313: mkdir($filepath,0777);
2314: }
2315: }
2316:
2317: # Save the file
2318: {
2319: if (!open(FH,'>'.$filepath.'/'.$file)) {
2320: &logthis('Failed to create '.$filepath.'/'.$file);
2321: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2322: return '/adm/notfound.html';
2323: }
2324: if (!print FH ($env{'form.'.$formname})) {
2325: &logthis('Failed to write to '.$filepath.'/'.$file);
2326: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2327: return '/adm/notfound.html';
2328: }
2329: close(FH);
2330: if ($resizewidth && $resizeheight) {
2331: my $mm = new File::MMagic;
2332: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2333: if ($mime_type =~ m{^image/}) {
2334: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2335: }
2336: }
2337: }
2338: if ($parser eq 'parse') {
2339: my $mm = new File::MMagic;
2340: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2341: if ($mime_type eq 'text/html') {
2342: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2343: $allfiles,$codebase);
2344: unless ($parse_result eq 'ok') {
2345: &logthis('Failed to parse '.$filepath.$file.
2346: ' for embedded media: '.$parse_result);
2347: }
2348: }
2349: }
2350: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2351: my $input = $filepath.'/'.$file;
2352: my $output = $filepath.'/'.'tn-'.$file;
2353: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2354: system("convert -sample $thumbsize $input $output");
2355: if (-e $filepath.'/'.'tn-'.$file) {
2356: $fetchthumb = 1;
2357: }
2358: }
2359:
2360: # Notify homeserver to grep it
2361: #
2362: my $docuhome=&homeserver($docuname,$docudom);
2363: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
2364: if ($fetchresult eq 'ok') {
2365: if ($fetchthumb) {
2366: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2367: if ($thumbresult ne 'ok') {
2368: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2369: $docuhome.': '.$thumbresult);
2370: }
2371: }
2372: #
2373: # Return the URL to it
2374: return '/uploaded/'.$path.$file;
2375: } else {
2376: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2377: ': '.$fetchresult);
2378: return '/adm/notfound.html';
2379: }
2380: }
2381:
2382: sub extract_embedded_items {
2383: my ($fullpath,$allfiles,$codebase,$content) = @_;
2384: my @state = ();
2385: my %javafiles = (
2386: codebase => '',
2387: code => '',
2388: archive => ''
2389: );
2390: my %mediafiles = (
2391: src => '',
2392: movie => '',
2393: );
2394: my $p;
2395: if ($content) {
2396: $p = HTML::LCParser->new($content);
2397: } else {
2398: $p = HTML::LCParser->new($fullpath);
2399: }
2400: while (my $t=$p->get_token()) {
2401: if ($t->[0] eq 'S') {
2402: my ($tagname, $attr) = ($t->[1],$t->[2]);
2403: push(@state, $tagname);
2404: if (lc($tagname) eq 'allow') {
2405: &add_filetype($allfiles,$attr->{'src'},'src');
2406: }
2407: if (lc($tagname) eq 'img') {
2408: &add_filetype($allfiles,$attr->{'src'},'src');
2409: }
2410: if (lc($tagname) eq 'a') {
2411: &add_filetype($allfiles,$attr->{'href'},'href');
2412: }
2413: if (lc($tagname) eq 'script') {
2414: if ($attr->{'archive'} =~ /\.jar$/i) {
2415: &add_filetype($allfiles,$attr->{'archive'},'archive');
2416: } else {
2417: &add_filetype($allfiles,$attr->{'src'},'src');
2418: }
2419: }
2420: if (lc($tagname) eq 'link') {
2421: if (lc($attr->{'rel'}) eq 'stylesheet') {
2422: &add_filetype($allfiles,$attr->{'href'},'href');
2423: }
2424: }
2425: if (lc($tagname) eq 'object' ||
2426: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2427: foreach my $item (keys(%javafiles)) {
2428: $javafiles{$item} = '';
2429: }
2430: }
2431: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2432: my $name = lc($attr->{'name'});
2433: foreach my $item (keys(%javafiles)) {
2434: if ($name eq $item) {
2435: $javafiles{$item} = $attr->{'value'};
2436: last;
2437: }
2438: }
2439: foreach my $item (keys(%mediafiles)) {
2440: if ($name eq $item) {
2441: &add_filetype($allfiles, $attr->{'value'}, 'value');
2442: last;
2443: }
2444: }
2445: }
2446: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2447: foreach my $item (keys(%javafiles)) {
2448: if ($attr->{$item}) {
2449: $javafiles{$item} = $attr->{$item};
2450: last;
2451: }
2452: }
2453: foreach my $item (keys(%mediafiles)) {
2454: if ($attr->{$item}) {
2455: &add_filetype($allfiles,$attr->{$item},$item);
2456: last;
2457: }
2458: }
2459: }
2460: } elsif ($t->[0] eq 'E') {
2461: my ($tagname) = ($t->[1]);
2462: if ($javafiles{'codebase'} ne '') {
2463: $javafiles{'codebase'} .= '/';
2464: }
2465: if (lc($tagname) eq 'applet' ||
2466: lc($tagname) eq 'object' ||
2467: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2468: ) {
2469: foreach my $item (keys(%javafiles)) {
2470: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2471: my $file=$javafiles{'codebase'}.$javafiles{$item};
2472: &add_filetype($allfiles,$file,$item);
2473: }
2474: }
2475: }
2476: pop @state;
2477: }
2478: }
2479: return 'ok';
2480: }
2481:
2482: sub add_filetype {
2483: my ($allfiles,$file,$type)=@_;
2484: if (exists($allfiles->{$file})) {
2485: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2486: push(@{$allfiles->{$file}}, &escape($type));
2487: }
2488: } else {
2489: @{$allfiles->{$file}} = (&escape($type));
2490: }
2491: }
2492:
2493: sub removeuploadedurl {
2494: my ($url)=@_;
2495: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
2496: return &removeuserfile($uname,$udom,$fname);
2497: }
2498:
2499: sub removeuserfile {
2500: my ($docuname,$docudom,$fname)=@_;
2501: my $home=&homeserver($docuname,$docudom);
2502: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2503: if ($result eq 'ok') {
2504: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2505: my $metafile = $fname.'.meta';
2506: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
2507: my $url = "/uploaded/$docudom/$docuname/$fname";
2508: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2509: my $sqlresult =
2510: &update_portfolio_table($docuname,$docudom,$file,
2511: 'portfolio_metadata',$group,
2512: 'delete');
2513: }
2514: }
2515: return $result;
2516: }
2517:
2518: sub mkdiruserfile {
2519: my ($docuname,$docudom,$dir)=@_;
2520: my $home=&homeserver($docuname,$docudom);
2521: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2522: }
2523:
2524: sub renameuserfile {
2525: my ($docuname,$docudom,$old,$new)=@_;
2526: my $home=&homeserver($docuname,$docudom);
2527: my $result = &reply("renameuserfile:$docudom:$docuname:".
2528: &escape("$old").':'.&escape("$new"),$home);
2529: if ($result eq 'ok') {
2530: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2531: my $oldmeta = $old.'.meta';
2532: my $newmeta = $new.'.meta';
2533: my $metaresult =
2534: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
2535: my $url = "/uploaded/$docudom/$docuname/$old";
2536: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2537: my $sqlresult =
2538: &update_portfolio_table($docuname,$docudom,$file,
2539: 'portfolio_metadata',$group,
2540: 'delete');
2541: }
2542: }
2543: return $result;
2544: }
2545:
2546: # ------------------------------------------------------------------------- Log
2547:
2548: sub log {
2549: my ($dom,$nam,$hom,$what)=@_;
2550: return critical("log:$dom:$nam:$what",$hom);
2551: }
2552:
2553: # ------------------------------------------------------------------ Course Log
2554: #
2555: # This routine flushes several buffers of non-mission-critical nature
2556: #
2557:
2558: sub flushcourselogs {
2559: &logthis('Flushing log buffers');
2560: #
2561: # course logs
2562: # This is a log of all transactions in a course, which can be used
2563: # for data mining purposes
2564: #
2565: # It also collects the courseid database, which lists last transaction
2566: # times and course titles for all courseids
2567: #
2568: my %courseidbuffer=();
2569: foreach my $crsid (keys(%courselogs)) {
2570: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2571: &escape($courselogs{$crsid}),
2572: $coursehombuf{$crsid}) eq 'ok') {
2573: delete $courselogs{$crsid};
2574: } else {
2575: &logthis('Failed to flush log buffer for '.$crsid);
2576: if (length($courselogs{$crsid})>40000) {
2577: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2578: " exceeded maximum size, deleting.</font>");
2579: delete $courselogs{$crsid};
2580: }
2581: }
2582: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
2583: 'description' => $coursedescrbuf{$crsid},
2584: 'inst_code' => $courseinstcodebuf{$crsid},
2585: 'type' => $coursetypebuf{$crsid},
2586: 'owner' => $courseownerbuf{$crsid},
2587: };
2588: }
2589: #
2590: # Write course id database (reverse lookup) to homeserver of courses
2591: # Is used in pickcourse
2592: #
2593: foreach my $crs_home (keys(%courseidbuffer)) {
2594: my $response = &courseidput(&host_domain($crs_home),
2595: $courseidbuffer{$crs_home},
2596: $crs_home,'timeonly');
2597: }
2598: #
2599: # File accesses
2600: # Writes to the dynamic metadata of resources to get hit counts, etc.
2601: #
2602: foreach my $entry (keys(%accesshash)) {
2603: if ($entry =~ /___count$/) {
2604: my ($dom,$name);
2605: ($dom,$name,undef)=
2606: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2607: if (! defined($dom) || $dom eq '' ||
2608: ! defined($name) || $name eq '') {
2609: my $cid = $env{'request.course.id'};
2610: $dom = $env{'request.'.$cid.'.domain'};
2611: $name = $env{'request.'.$cid.'.num'};
2612: }
2613: my $value = $accesshash{$entry};
2614: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2615: my %temphash=($url => $value);
2616: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2617: if ($result eq 'ok') {
2618: delete $accesshash{$entry};
2619: } elsif ($result eq 'unknown_cmd') {
2620: # Target server has old code running on it.
2621: my %temphash=($entry => $value);
2622: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2623: delete $accesshash{$entry};
2624: }
2625: }
2626: } else {
2627: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2628: my %temphash=($entry => $accesshash{$entry});
2629: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2630: delete $accesshash{$entry};
2631: }
2632: }
2633: }
2634: #
2635: # Roles
2636: # Reverse lookup of user roles for course faculty/staff and co-authorship
2637: #
2638: foreach my $entry (keys(%userrolehash)) {
2639: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2640: split(/\:/,$entry);
2641: if (&Apache::lonnet::put('nohist_userroles',
2642: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2643: $rudom,$runame) eq 'ok') {
2644: delete $userrolehash{$entry};
2645: }
2646: }
2647: #
2648: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2649: #
2650: my %domrolebuffer = ();
2651: foreach my $entry (keys(%domainrolehash)) {
2652: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2653: if ($domrolebuffer{$rudom}) {
2654: $domrolebuffer{$rudom}.='&'.&escape($entry).
2655: '='.&escape($domainrolehash{$entry});
2656: } else {
2657: $domrolebuffer{$rudom}.=&escape($entry).
2658: '='.&escape($domainrolehash{$entry});
2659: }
2660: delete $domainrolehash{$entry};
2661: }
2662: foreach my $dom (keys(%domrolebuffer)) {
2663: my %servers = &get_servers($dom,'library');
2664: foreach my $tryserver (keys(%servers)) {
2665: unless (&reply('domroleput:'.$dom.':'.
2666: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2667: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2668: }
2669: }
2670: }
2671: $dumpcount++;
2672: }
2673:
2674: sub courselog {
2675: my $what=shift;
2676: $what=time.':'.$what;
2677: unless ($env{'request.course.id'}) { return ''; }
2678: $coursedombuf{$env{'request.course.id'}}=
2679: $env{'course.'.$env{'request.course.id'}.'.domain'};
2680: $coursenumbuf{$env{'request.course.id'}}=
2681: $env{'course.'.$env{'request.course.id'}.'.num'};
2682: $coursehombuf{$env{'request.course.id'}}=
2683: $env{'course.'.$env{'request.course.id'}.'.home'};
2684: $coursedescrbuf{$env{'request.course.id'}}=
2685: $env{'course.'.$env{'request.course.id'}.'.description'};
2686: $courseinstcodebuf{$env{'request.course.id'}}=
2687: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2688: $courseownerbuf{$env{'request.course.id'}}=
2689: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2690: $coursetypebuf{$env{'request.course.id'}}=
2691: $env{'course.'.$env{'request.course.id'}.'.type'};
2692: if (defined $courselogs{$env{'request.course.id'}}) {
2693: $courselogs{$env{'request.course.id'}}.='&'.$what;
2694: } else {
2695: $courselogs{$env{'request.course.id'}}.=$what;
2696: }
2697: if (length($courselogs{$env{'request.course.id'}})>4048) {
2698: &flushcourselogs();
2699: }
2700: }
2701:
2702: sub courseacclog {
2703: my $fnsymb=shift;
2704: unless ($env{'request.course.id'}) { return ''; }
2705: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2706: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2707: $what.=':POST';
2708: # FIXME: Probably ought to escape things....
2709: foreach my $key (keys(%env)) {
2710: if ($key=~/^form\.(.*)/) {
2711: my $formitem = $1;
2712: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2713: $what.=':'.$formitem.'='.$env{$key};
2714: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2715: $what.=':'.$formitem.'='.$env{$key};
2716: }
2717: }
2718: }
2719: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2720: # FIXME: We should not be depending on a form parameter that someone
2721: # editing lonsearchcat.pm might change in the future.
2722: if ($env{'form.phase'} eq 'course_search') {
2723: $what.= ':POST';
2724: # FIXME: Probably ought to escape things....
2725: foreach my $element ('courseexp','crsfulltext','crsrelated',
2726: 'crsdiscuss') {
2727: $what.=':'.$element.'='.$env{'form.'.$element};
2728: }
2729: }
2730: }
2731: &courselog($what);
2732: }
2733:
2734: sub countacc {
2735: my $url=&declutter(shift);
2736: return if (! defined($url) || $url eq '');
2737: unless ($env{'request.course.id'}) { return ''; }
2738: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2739: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2740: $accesshash{$key}++;
2741: }
2742:
2743: sub linklog {
2744: my ($from,$to)=@_;
2745: $from=&declutter($from);
2746: $to=&declutter($to);
2747: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2748: $accesshash{$to.'___'.$from.'___goto'}=1;
2749: }
2750:
2751: sub userrolelog {
2752: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2753: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2754: ($trole=~/^in/) || ($trole=~/^cc/) ||
2755: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2756: ($trole=~/^ta/) || ($trole=~/^co/)) {
2757: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2758: $userrolehash
2759: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2760: =$tend.':'.$tstart;
2761: }
2762: if (($env{'request.role'} =~ /dc\./) &&
2763: (($trole=~/^au/) || ($trole=~/^in/) ||
2764: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2765: ($trole=~/^cr/) || ($trole=~/^ta/) ||
2766: ($trole=~/^co/))) {
2767: $userrolehash
2768: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2769: =$tend.':'.$tstart;
2770: }
2771: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2772: ($trole=~/^li/) || ($trole=~/^li/) ||
2773: ($trole=~/^au/) || ($trole=~/^dg/) ||
2774: ($trole=~/^sc/)) {
2775: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2776: $domainrolehash
2777: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2778: = $tend.':'.$tstart;
2779: }
2780: }
2781:
2782: sub courserolelog {
2783: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2784: if (($trole eq 'cc') || ($trole eq 'in') ||
2785: ($trole eq 'ep') || ($trole eq 'ad') ||
2786: ($trole eq 'ta') || ($trole eq 'st') ||
2787: ($trole=~/^cr/) || ($trole eq 'gr') ||
2788: ($trole eq 'co')) {
2789: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2790: my $cdom = $1;
2791: my $cnum = $2;
2792: my $sec = $3;
2793: my $namespace = 'rolelog';
2794: my %storehash = (
2795: role => $trole,
2796: start => $tstart,
2797: end => $tend,
2798: selfenroll => $selfenroll,
2799: context => $context,
2800: );
2801: if ($trole eq 'gr') {
2802: $namespace = 'groupslog';
2803: $storehash{'group'} = $sec;
2804: } else {
2805: $storehash{'section'} = $sec;
2806: }
2807: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
2808: if (($trole ne 'st') || ($sec ne '')) {
2809: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2810: }
2811: }
2812: }
2813: return;
2814: }
2815:
2816: sub get_course_adv_roles {
2817: my ($cid,$codes) = @_;
2818: $cid=$env{'request.course.id'} unless (defined($cid));
2819: my %coursehash=&coursedescription($cid);
2820: my $crstype = &Apache::loncommon::course_type($cid);
2821: my %nothide=();
2822: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2823: if ($user !~ /:/) {
2824: $nothide{join(':',split(/[\@]/,$user))}=1;
2825: } else {
2826: $nothide{$user}=1;
2827: }
2828: }
2829: my %returnhash=();
2830: my %dumphash=
2831: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2832: my $now=time;
2833: my %privileged;
2834: foreach my $entry (keys(%dumphash)) {
2835: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2836: if (($tstart) && ($tstart<0)) { next; }
2837: if (($tend) && ($tend<$now)) { next; }
2838: if (($tstart) && ($now<$tstart)) { next; }
2839: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2840: if ($username eq '' || $domain eq '') { next; }
2841: unless (ref($privileged{$domain}) eq 'HASH') {
2842: my %dompersonnel =
2843: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2844: $privileged{$domain} = {};
2845: foreach my $server (keys(%dompersonnel)) {
2846: if (ref($dompersonnel{$server}) eq 'HASH') {
2847: foreach my $user (keys(%{$dompersonnel{$server}})) {
2848: my ($trole,$uname,$udom) = split(/:/,$user);
2849: $privileged{$udom}{$uname} = 1;
2850: }
2851: }
2852: }
2853: }
2854: if ((exists($privileged{$domain}{$username})) &&
2855: (!$nothide{$username.':'.$domain})) { next; }
2856: if ($role eq 'cr') { next; }
2857: if ($codes) {
2858: if ($section) { $role .= ':'.$section; }
2859: if ($returnhash{$role}) {
2860: $returnhash{$role}.=','.$username.':'.$domain;
2861: } else {
2862: $returnhash{$role}=$username.':'.$domain;
2863: }
2864: } else {
2865: my $key=&plaintext($role,$crstype);
2866: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
2867: if ($returnhash{$key}) {
2868: $returnhash{$key}.=','.$username.':'.$domain;
2869: } else {
2870: $returnhash{$key}=$username.':'.$domain;
2871: }
2872: }
2873: }
2874: return %returnhash;
2875: }
2876:
2877: sub get_my_roles {
2878: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2879: unless (defined($uname)) { $uname=$env{'user.name'}; }
2880: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2881: my (%dumphash,%nothide);
2882: if ($context eq 'userroles') {
2883: %dumphash = &dump('roles',$udom,$uname);
2884: } else {
2885: %dumphash=
2886: &dump('nohist_userroles',$udom,$uname);
2887: if ($hidepriv) {
2888: my %coursehash=&coursedescription($udom.'_'.$uname);
2889: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2890: if ($user !~ /:/) {
2891: $nothide{join(':',split(/[\@]/,$user))} = 1;
2892: } else {
2893: $nothide{$user} = 1;
2894: }
2895: }
2896: }
2897: }
2898: my %returnhash=();
2899: my $now=time;
2900: my %privileged;
2901: foreach my $entry (keys(%dumphash)) {
2902: my ($role,$tend,$tstart);
2903: if ($context eq 'userroles') {
2904: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2905: } else {
2906: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2907: }
2908: if (($tstart) && ($tstart<0)) { next; }
2909: my $status = 'active';
2910: if (($tend) && ($tend<=$now)) {
2911: $status = 'previous';
2912: }
2913: if (($tstart) && ($now<$tstart)) {
2914: $status = 'future';
2915: }
2916: if (ref($types) eq 'ARRAY') {
2917: if (!grep(/^\Q$status\E$/,@{$types})) {
2918: next;
2919: }
2920: } else {
2921: if ($status ne 'active') {
2922: next;
2923: }
2924: }
2925: my ($rolecode,$username,$domain,$section,$area);
2926: if ($context eq 'userroles') {
2927: ($area,$rolecode) = split(/_/,$entry);
2928: (undef,$domain,$username,$section) = split(/\//,$area);
2929: } else {
2930: ($role,$username,$domain,$section) = split(/\:/,$entry);
2931: }
2932: if (ref($roledoms) eq 'ARRAY') {
2933: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2934: next;
2935: }
2936: }
2937: if (ref($roles) eq 'ARRAY') {
2938: if (!grep(/^\Q$role\E$/,@{$roles})) {
2939: if ($role =~ /^cr\//) {
2940: if (!grep(/^cr$/,@{$roles})) {
2941: next;
2942: }
2943: } else {
2944: next;
2945: }
2946: }
2947: }
2948: if ($hidepriv) {
2949: if ($context eq 'userroles') {
2950: if ((&privileged($username,$domain)) &&
2951: (!$nothide{$username.':'.$domain})) {
2952: next;
2953: }
2954: } else {
2955: unless (ref($privileged{$domain}) eq 'HASH') {
2956: my %dompersonnel =
2957: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2958: $privileged{$domain} = {};
2959: if (keys(%dompersonnel)) {
2960: foreach my $server (keys(%dompersonnel)) {
2961: if (ref($dompersonnel{$server}) eq 'HASH') {
2962: foreach my $user (keys(%{$dompersonnel{$server}})) {
2963: my ($trole,$uname,$udom) = split(/:/,$user);
2964: $privileged{$udom}{$uname} = $trole;
2965: }
2966: }
2967: }
2968: }
2969: }
2970: if (exists($privileged{$domain}{$username})) {
2971: if (!$nothide{$username.':'.$domain}) {
2972: next;
2973: }
2974: }
2975: }
2976: }
2977: if ($withsec) {
2978: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2979: $tstart.':'.$tend;
2980: } else {
2981: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2982: }
2983: }
2984: return %returnhash;
2985: }
2986:
2987: # ----------------------------------------------------- Frontpage Announcements
2988: #
2989: #
2990:
2991: sub postannounce {
2992: my ($server,$text)=@_;
2993: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2994: unless ($text=~/\w/) { $text=''; }
2995: return &reply('setannounce:'.&escape($text),$server);
2996: }
2997:
2998: sub getannounce {
2999:
3000: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
3001: my $announcement='';
3002: while (my $line = <$fh>) { $announcement .= $line; }
3003: close($fh);
3004: if ($announcement=~/\w/) {
3005: return
3006: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
3007: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
3008: } else {
3009: return '';
3010: }
3011: } else {
3012: return '';
3013: }
3014: }
3015:
3016: # ---------------------------------------------------------- Course ID routines
3017: # Deal with domain's nohist_courseid.db files
3018: #
3019:
3020: sub courseidput {
3021: my ($domain,$storehash,$coursehome,$caller) = @_;
3022: return unless (ref($storehash) eq 'HASH');
3023: my $outcome;
3024: if ($caller eq 'timeonly') {
3025: my $cids = '';
3026: foreach my $item (keys(%$storehash)) {
3027: $cids.=&escape($item).'&';
3028: }
3029: $cids=~s/\&$//;
3030: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3031: $coursehome);
3032: } else {
3033: my $items = '';
3034: foreach my $item (keys(%$storehash)) {
3035: $items.= &escape($item).'='.
3036: &freeze_escape($$storehash{$item}).'&';
3037: }
3038: $items=~s/\&$//;
3039: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3040: $coursehome);
3041: }
3042: if ($outcome eq 'unknown_cmd') {
3043: my $what;
3044: foreach my $cid (keys(%$storehash)) {
3045: $what .= &escape($cid).'=';
3046: foreach my $item ('description','inst_code','owner','type') {
3047: $what .= &escape($storehash->{$cid}{$item}).':';
3048: }
3049: $what =~ s/\:$/&/;
3050: }
3051: $what =~ s/\&$//;
3052: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3053: } else {
3054: return $outcome;
3055: }
3056: }
3057:
3058: sub courseiddump {
3059: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3060: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3061: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3062: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
3063: my $as_hash = 1;
3064: my %returnhash;
3065: if (!$domfilter) { $domfilter=''; }
3066: my %libserv = &all_library();
3067: foreach my $tryserver (keys(%libserv)) {
3068: if ( ( $hostidflag == 1
3069: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3070: || (!defined($hostidflag)) ) {
3071:
3072: if (($domfilter eq '') ||
3073: (&host_domain($tryserver) eq $domfilter)) {
3074: my $rep =
3075: &reply('courseiddump:'.&host_domain($tryserver).':'.
3076: $sincefilter.':'.&escape($descfilter).':'.
3077: &escape($instcodefilter).':'.&escape($ownerfilter).
3078: ':'.&escape($coursefilter).':'.&escape($typefilter).
3079: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3080: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3081: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3082: &escape($cc_clone).':'.$cloneonly.':'.
3083: &escape($createdbefore).':'.&escape($createdafter).':'.
3084: &escape($creationcontext),$tryserver);
3085: my @pairs=split(/\&/,$rep);
3086: foreach my $item (@pairs) {
3087: my ($key,$value)=split(/\=/,$item,2);
3088: $key = &unescape($key);
3089: next if ($key =~ /^error: 2 /);
3090: my $result = &thaw_unescape($value);
3091: if (ref($result) eq 'HASH') {
3092: $returnhash{$key}=$result;
3093: } else {
3094: my @responses = split(/:/,$value);
3095: my @items = ('description','inst_code','owner','type');
3096: for (my $i=0; $i<@responses; $i++) {
3097: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3098: }
3099: }
3100: }
3101: }
3102: }
3103: }
3104: return %returnhash;
3105: }
3106:
3107: sub courselastaccess {
3108: my ($cdom,$cnum,$hostidref) = @_;
3109: my %returnhash;
3110: if ($cdom && $cnum) {
3111: my $chome = &homeserver($cnum,$cdom);
3112: if ($chome ne 'no_host') {
3113: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3114: &extract_lastaccess(\%returnhash,$rep);
3115: }
3116: } else {
3117: if (!$cdom) { $cdom=''; }
3118: my %libserv = &all_library();
3119: foreach my $tryserver (keys(%libserv)) {
3120: if (ref($hostidref) eq 'ARRAY') {
3121: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3122: }
3123: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3124: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3125: &extract_lastaccess(\%returnhash,$rep);
3126: }
3127: }
3128: }
3129: return %returnhash;
3130: }
3131:
3132: sub extract_lastaccess {
3133: my ($returnhash,$rep) = @_;
3134: if (ref($returnhash) eq 'HASH') {
3135: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3136: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3137: $rep eq '') {
3138: my @pairs=split(/\&/,$rep);
3139: foreach my $item (@pairs) {
3140: my ($key,$value)=split(/\=/,$item,2);
3141: $key = &unescape($key);
3142: next if ($key =~ /^error: 2 /);
3143: $returnhash->{$key} = &thaw_unescape($value);
3144: }
3145: }
3146: }
3147: return;
3148: }
3149:
3150: # ---------------------------------------------------------- DC e-mail
3151:
3152: sub dcmailput {
3153: my ($domain,$msgid,$message,$server)=@_;
3154: my $status = &Apache::lonnet::critical(
3155: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3156: &escape($message),$server);
3157: return $status;
3158: }
3159:
3160: sub dcmaildump {
3161: my ($dom,$startdate,$enddate,$senders) = @_;
3162: my %returnhash=();
3163:
3164: if (defined(&domain($dom,'primary'))) {
3165: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3166: &escape($enddate).':';
3167: my @esc_senders=map { &escape($_)} @$senders;
3168: $cmd.=&escape(join('&',@esc_senders));
3169: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3170: my ($key,$value) = split(/\=/,$line,2);
3171: if (($key) && ($value)) {
3172: $returnhash{&unescape($key)} = &unescape($value);
3173: }
3174: }
3175: }
3176: return %returnhash;
3177: }
3178: # ---------------------------------------------------------- Domain roles
3179:
3180: sub get_domain_roles {
3181: my ($dom,$roles,$startdate,$enddate)=@_;
3182: if ((!defined($startdate)) || ($startdate eq '')) {
3183: $startdate = '.';
3184: }
3185: if ((!defined($enddate)) || ($enddate eq '')) {
3186: $enddate = '.';
3187: }
3188: my $rolelist;
3189: if (ref($roles) eq 'ARRAY') {
3190: $rolelist = join(':',@{$roles});
3191: }
3192: my %personnel = ();
3193:
3194: my %servers = &get_servers($dom,'library');
3195: foreach my $tryserver (keys(%servers)) {
3196: %{$personnel{$tryserver}}=();
3197: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3198: &escape($startdate).':'.
3199: &escape($enddate).':'.
3200: &escape($rolelist), $tryserver))) {
3201: my ($key,$value) = split(/\=/,$line,2);
3202: if (($key) && ($value)) {
3203: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3204: }
3205: }
3206: }
3207: return %personnel;
3208: }
3209:
3210: # ----------------------------------------------------------- Check out an item
3211:
3212: sub get_first_access {
3213: my ($type,$argsymb)=@_;
3214: my ($symb,$courseid,$udom,$uname)=&whichuser();
3215: if ($argsymb) { $symb=$argsymb; }
3216: my ($map,$id,$res)=&decode_symb($symb);
3217: if ($type eq 'course') {
3218: $res='course';
3219: } elsif ($type eq 'map') {
3220: $res=&symbread($map);
3221: } else {
3222: $res=$symb;
3223: }
3224: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3225: return $times{"$courseid\0$res"};
3226: }
3227:
3228: sub set_first_access {
3229: my ($type)=@_;
3230: my ($symb,$courseid,$udom,$uname)=&whichuser();
3231: my ($map,$id,$res)=&decode_symb($symb);
3232: if ($type eq 'course') {
3233: $res='course';
3234: } elsif ($type eq 'map') {
3235: $res=&symbread($map);
3236: } else {
3237: $res=$symb;
3238: }
3239: my $firstaccess=&get_first_access($type,$symb);
3240: if (!$firstaccess) {
3241: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3242: }
3243: return 'already_set';
3244: }
3245:
3246: sub checkout {
3247: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3248: my $now=time;
3249: my $lonhost=$perlvar{'lonHostID'};
3250: my $infostr=&escape(
3251: 'CHECKOUTTOKEN&'.
3252: $tuname.'&'.
3253: $tudom.'&'.
3254: $tcrsid.'&'.
3255: $symb.'&'.
3256: $now.'&'.$ENV{'REMOTE_ADDR'});
3257: my $token=&reply('tmpput:'.$infostr,$lonhost);
3258: if ($token=~/^error\:/) {
3259: &logthis("<font color=\"blue\">WARNING: ".
3260: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3261: "</font>");
3262: return '';
3263: }
3264:
3265: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3266: $token=~tr/a-z/A-Z/;
3267:
3268: my %infohash=('resource.0.outtoken' => $token,
3269: 'resource.0.checkouttime' => $now,
3270: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
3271:
3272: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3273: return '';
3274: } else {
3275: &logthis("<font color=\"blue\">WARNING: ".
3276: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3277: "</font>");
3278: }
3279:
3280: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3281: &escape('Checkout '.$infostr.' - '.
3282: $token)) ne 'ok') {
3283: return '';
3284: } else {
3285: &logthis("<font color=\"blue\">WARNING: ".
3286: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3287: "</font>");
3288: }
3289: return $token;
3290: }
3291:
3292: # ------------------------------------------------------------ Check in an item
3293:
3294: sub checkin {
3295: my $token=shift;
3296: my $now=time;
3297: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3298: $lonhost=~tr/A-Z/a-z/;
3299: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
3300: $dtoken=~s/\W/\_/g;
3301: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
3302: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3303:
3304: unless (($tuname) && ($tudom)) {
3305: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3306: return '';
3307: }
3308:
3309: unless (&allowed('mgr',$tcrsid)) {
3310: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
3311: $env{'user.name'}.' - '.$env{'user.domain'});
3312: return '';
3313: }
3314:
3315: my %infohash=('resource.0.intoken' => $token,
3316: 'resource.0.checkintime' => $now,
3317: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
3318:
3319: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3320: return '';
3321: }
3322:
3323: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3324: &escape('Checkin - '.$token)) ne 'ok') {
3325: return '';
3326: }
3327:
3328: return ($symb,$tuname,$tudom,$tcrsid);
3329: }
3330:
3331: # --------------------------------------------- Set Expire Date for Spreadsheet
3332:
3333: sub expirespread {
3334: my ($uname,$udom,$stype,$usymb)=@_;
3335: my $cid=$env{'request.course.id'};
3336: if ($cid) {
3337: my $now=time;
3338: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3339: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3340: $env{'course.'.$cid.'.num'}.
3341: ':nohist_expirationdates:'.
3342: &escape($key).'='.$now,
3343: $env{'course.'.$cid.'.home'})
3344: }
3345: return 'ok';
3346: }
3347:
3348: # ----------------------------------------------------- Devalidate Spreadsheets
3349:
3350: sub devalidate {
3351: my ($symb,$uname,$udom)=@_;
3352: my $cid=$env{'request.course.id'};
3353: if ($cid) {
3354: # delete the stored spreadsheets for
3355: # - the student level sheet of this user in course's homespace
3356: # - the assessment level sheet for this resource
3357: # for this user in user's homespace
3358: # - current conditional state info
3359: my $key=$uname.':'.$udom.':';
3360: my $status=
3361: &del('nohist_calculatedsheets',
3362: [$key.'studentcalc:'],
3363: $env{'course.'.$cid.'.domain'},
3364: $env{'course.'.$cid.'.num'})
3365: .' '.
3366: &del('nohist_calculatedsheets_'.$cid,
3367: [$key.'assesscalc:'.$symb],$udom,$uname);
3368: unless ($status eq 'ok ok') {
3369: &logthis('Could not devalidate spreadsheet '.
3370: $uname.' at '.$udom.' for '.
3371: $symb.': '.$status);
3372: }
3373: &delenv('user.state.'.$cid);
3374: }
3375: }
3376:
3377: sub get_scalar {
3378: my ($string,$end) = @_;
3379: my $value;
3380: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3381: $value = $1;
3382: } elsif ($$string =~ s/^([^&]*?)&//) {
3383: $value = $1;
3384: }
3385: return &unescape($value);
3386: }
3387:
3388: sub array2str {
3389: my (@array) = @_;
3390: my $result=&arrayref2str(\@array);
3391: $result=~s/^__ARRAY_REF__//;
3392: $result=~s/__END_ARRAY_REF__$//;
3393: return $result;
3394: }
3395:
3396: sub arrayref2str {
3397: my ($arrayref) = @_;
3398: my $result='__ARRAY_REF__';
3399: foreach my $elem (@$arrayref) {
3400: if(ref($elem) eq 'ARRAY') {
3401: $result.=&arrayref2str($elem).'&';
3402: } elsif(ref($elem) eq 'HASH') {
3403: $result.=&hashref2str($elem).'&';
3404: } elsif(ref($elem)) {
3405: #print("Got a ref of ".(ref($elem))." skipping.");
3406: } else {
3407: $result.=&escape($elem).'&';
3408: }
3409: }
3410: $result=~s/\&$//;
3411: $result .= '__END_ARRAY_REF__';
3412: return $result;
3413: }
3414:
3415: sub hash2str {
3416: my (%hash) = @_;
3417: my $result=&hashref2str(\%hash);
3418: $result=~s/^__HASH_REF__//;
3419: $result=~s/__END_HASH_REF__$//;
3420: return $result;
3421: }
3422:
3423: sub hashref2str {
3424: my ($hashref)=@_;
3425: my $result='__HASH_REF__';
3426: foreach my $key (sort(keys(%$hashref))) {
3427: if (ref($key) eq 'ARRAY') {
3428: $result.=&arrayref2str($key).'=';
3429: } elsif (ref($key) eq 'HASH') {
3430: $result.=&hashref2str($key).'=';
3431: } elsif (ref($key)) {
3432: $result.='=';
3433: #print("Got a ref of ".(ref($key))." skipping.");
3434: } else {
3435: if ($key) {$result.=&escape($key).'=';} else { last; }
3436: }
3437:
3438: if(ref($hashref->{$key}) eq 'ARRAY') {
3439: $result.=&arrayref2str($hashref->{$key}).'&';
3440: } elsif(ref($hashref->{$key}) eq 'HASH') {
3441: $result.=&hashref2str($hashref->{$key}).'&';
3442: } elsif(ref($hashref->{$key})) {
3443: $result.='&';
3444: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3445: } else {
3446: $result.=&escape($hashref->{$key}).'&';
3447: }
3448: }
3449: $result=~s/\&$//;
3450: $result .= '__END_HASH_REF__';
3451: return $result;
3452: }
3453:
3454: sub str2hash {
3455: my ($string)=@_;
3456: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3457: return %$hash;
3458: }
3459:
3460: sub str2hashref {
3461: my ($string) = @_;
3462:
3463: my %hash;
3464:
3465: if($string !~ /^__HASH_REF__/) {
3466: if (! ($string eq '' || !defined($string))) {
3467: $hash{'error'}='Not hash reference';
3468: }
3469: return (\%hash, $string);
3470: }
3471:
3472: $string =~ s/^__HASH_REF__//;
3473:
3474: while($string !~ /^__END_HASH_REF__/) {
3475: #key
3476: my $key='';
3477: if($string =~ /^__HASH_REF__/) {
3478: ($key, $string)=&str2hashref($string);
3479: if(defined($key->{'error'})) {
3480: $hash{'error'}='Bad data';
3481: return (\%hash, $string);
3482: }
3483: } elsif($string =~ /^__ARRAY_REF__/) {
3484: ($key, $string)=&str2arrayref($string);
3485: if($key->[0] eq 'Array reference error') {
3486: $hash{'error'}='Bad data';
3487: return (\%hash, $string);
3488: }
3489: } else {
3490: $string =~ s/^(.*?)=//;
3491: $key=&unescape($1);
3492: }
3493: $string =~ s/^=//;
3494:
3495: #value
3496: my $value='';
3497: if($string =~ /^__HASH_REF__/) {
3498: ($value, $string)=&str2hashref($string);
3499: if(defined($value->{'error'})) {
3500: $hash{'error'}='Bad data';
3501: return (\%hash, $string);
3502: }
3503: } elsif($string =~ /^__ARRAY_REF__/) {
3504: ($value, $string)=&str2arrayref($string);
3505: if($value->[0] eq 'Array reference error') {
3506: $hash{'error'}='Bad data';
3507: return (\%hash, $string);
3508: }
3509: } else {
3510: $value=&get_scalar(\$string,'__END_HASH_REF__');
3511: }
3512: $string =~ s/^&//;
3513:
3514: $hash{$key}=$value;
3515: }
3516:
3517: $string =~ s/^__END_HASH_REF__//;
3518:
3519: return (\%hash, $string);
3520: }
3521:
3522: sub str2array {
3523: my ($string)=@_;
3524: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3525: return @$array;
3526: }
3527:
3528: sub str2arrayref {
3529: my ($string) = @_;
3530: my @array;
3531:
3532: if($string !~ /^__ARRAY_REF__/) {
3533: if (! ($string eq '' || !defined($string))) {
3534: $array[0]='Array reference error';
3535: }
3536: return (\@array, $string);
3537: }
3538:
3539: $string =~ s/^__ARRAY_REF__//;
3540:
3541: while($string !~ /^__END_ARRAY_REF__/) {
3542: my $value='';
3543: if($string =~ /^__HASH_REF__/) {
3544: ($value, $string)=&str2hashref($string);
3545: if(defined($value->{'error'})) {
3546: $array[0] ='Array reference error';
3547: return (\@array, $string);
3548: }
3549: } elsif($string =~ /^__ARRAY_REF__/) {
3550: ($value, $string)=&str2arrayref($string);
3551: if($value->[0] eq 'Array reference error') {
3552: $array[0] ='Array reference error';
3553: return (\@array, $string);
3554: }
3555: } else {
3556: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3557: }
3558: $string =~ s/^&//;
3559:
3560: push(@array, $value);
3561: }
3562:
3563: $string =~ s/^__END_ARRAY_REF__//;
3564:
3565: return (\@array, $string);
3566: }
3567:
3568: # -------------------------------------------------------------------Temp Store
3569:
3570: sub tmpreset {
3571: my ($symb,$namespace,$domain,$stuname) = @_;
3572: if (!$symb) {
3573: $symb=&symbread();
3574: if (!$symb) { $symb= $env{'request.url'}; }
3575: }
3576: $symb=escape($symb);
3577:
3578: if (!$namespace) { $namespace=$env{'request.state'}; }
3579: $namespace=~s/\//\_/g;
3580: $namespace=~s/\W//g;
3581:
3582: if (!$domain) { $domain=$env{'user.domain'}; }
3583: if (!$stuname) { $stuname=$env{'user.name'}; }
3584: if ($domain eq 'public' && $stuname eq 'public') {
3585: $stuname=$ENV{'REMOTE_ADDR'};
3586: }
3587: my $path=$perlvar{'lonDaemons'}.'/tmp';
3588: my %hash;
3589: if (tie(%hash,'GDBM_File',
3590: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3591: &GDBM_WRCREAT(),0640)) {
3592: foreach my $key (keys(%hash)) {
3593: if ($key=~ /:$symb/) {
3594: delete($hash{$key});
3595: }
3596: }
3597: }
3598: }
3599:
3600: sub tmpstore {
3601: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3602:
3603: if (!$symb) {
3604: $symb=&symbread();
3605: if (!$symb) { $symb= $env{'request.url'}; }
3606: }
3607: $symb=escape($symb);
3608:
3609: if (!$namespace) {
3610: # I don't think we would ever want to store this for a course.
3611: # it seems this will only be used if we don't have a course.
3612: #$namespace=$env{'request.course.id'};
3613: #if (!$namespace) {
3614: $namespace=$env{'request.state'};
3615: #}
3616: }
3617: $namespace=~s/\//\_/g;
3618: $namespace=~s/\W//g;
3619: if (!$domain) { $domain=$env{'user.domain'}; }
3620: if (!$stuname) { $stuname=$env{'user.name'}; }
3621: if ($domain eq 'public' && $stuname eq 'public') {
3622: $stuname=$ENV{'REMOTE_ADDR'};
3623: }
3624: my $now=time;
3625: my %hash;
3626: my $path=$perlvar{'lonDaemons'}.'/tmp';
3627: if (tie(%hash,'GDBM_File',
3628: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3629: &GDBM_WRCREAT(),0640)) {
3630: $hash{"version:$symb"}++;
3631: my $version=$hash{"version:$symb"};
3632: my $allkeys='';
3633: foreach my $key (keys(%$storehash)) {
3634: $allkeys.=$key.':';
3635: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3636: }
3637: $hash{"$version:$symb:timestamp"}=$now;
3638: $allkeys.='timestamp';
3639: $hash{"$version:keys:$symb"}=$allkeys;
3640: if (untie(%hash)) {
3641: return 'ok';
3642: } else {
3643: return "error:$!";
3644: }
3645: } else {
3646: return "error:$!";
3647: }
3648: }
3649:
3650: # -----------------------------------------------------------------Temp Restore
3651:
3652: sub tmprestore {
3653: my ($symb,$namespace,$domain,$stuname) = @_;
3654:
3655: if (!$symb) {
3656: $symb=&symbread();
3657: if (!$symb) { $symb= $env{'request.url'}; }
3658: }
3659: $symb=escape($symb);
3660:
3661: if (!$namespace) { $namespace=$env{'request.state'}; }
3662:
3663: if (!$domain) { $domain=$env{'user.domain'}; }
3664: if (!$stuname) { $stuname=$env{'user.name'}; }
3665: if ($domain eq 'public' && $stuname eq 'public') {
3666: $stuname=$ENV{'REMOTE_ADDR'};
3667: }
3668: my %returnhash;
3669: $namespace=~s/\//\_/g;
3670: $namespace=~s/\W//g;
3671: my %hash;
3672: my $path=$perlvar{'lonDaemons'}.'/tmp';
3673: if (tie(%hash,'GDBM_File',
3674: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3675: &GDBM_READER(),0640)) {
3676: my $version=$hash{"version:$symb"};
3677: $returnhash{'version'}=$version;
3678: my $scope;
3679: for ($scope=1;$scope<=$version;$scope++) {
3680: my $vkeys=$hash{"$scope:keys:$symb"};
3681: my @keys=split(/:/,$vkeys);
3682: my $key;
3683: $returnhash{"$scope:keys"}=$vkeys;
3684: foreach $key (@keys) {
3685: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3686: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3687: }
3688: }
3689: if (!(untie(%hash))) {
3690: return "error:$!";
3691: }
3692: } else {
3693: return "error:$!";
3694: }
3695: return %returnhash;
3696: }
3697:
3698: # ----------------------------------------------------------------------- Store
3699:
3700: sub store {
3701: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3702: my $home='';
3703:
3704: if ($stuname) { $home=&homeserver($stuname,$domain); }
3705:
3706: $symb=&symbclean($symb);
3707: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3708:
3709: if (!$domain) { $domain=$env{'user.domain'}; }
3710: if (!$stuname) { $stuname=$env{'user.name'}; }
3711:
3712: &devalidate($symb,$stuname,$domain);
3713:
3714: $symb=escape($symb);
3715: if (!$namespace) {
3716: unless ($namespace=$env{'request.course.id'}) {
3717: return '';
3718: }
3719: }
3720: if (!$home) { $home=$env{'user.home'}; }
3721:
3722: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3723: $$storehash{'host'}=$perlvar{'lonHostID'};
3724:
3725: my $namevalue='';
3726: foreach my $key (keys(%$storehash)) {
3727: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3728: }
3729: $namevalue=~s/\&$//;
3730: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3731: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3732: }
3733:
3734: # -------------------------------------------------------------- Critical Store
3735:
3736: sub cstore {
3737: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3738: my $home='';
3739:
3740: if ($stuname) { $home=&homeserver($stuname,$domain); }
3741:
3742: $symb=&symbclean($symb);
3743: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3744:
3745: if (!$domain) { $domain=$env{'user.domain'}; }
3746: if (!$stuname) { $stuname=$env{'user.name'}; }
3747:
3748: &devalidate($symb,$stuname,$domain);
3749:
3750: $symb=escape($symb);
3751: if (!$namespace) {
3752: unless ($namespace=$env{'request.course.id'}) {
3753: return '';
3754: }
3755: }
3756: if (!$home) { $home=$env{'user.home'}; }
3757:
3758: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3759: $$storehash{'host'}=$perlvar{'lonHostID'};
3760:
3761: my $namevalue='';
3762: foreach my $key (keys(%$storehash)) {
3763: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3764: }
3765: $namevalue=~s/\&$//;
3766: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3767: return critical
3768: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3769: }
3770:
3771: # --------------------------------------------------------------------- Restore
3772:
3773: sub restore {
3774: my ($symb,$namespace,$domain,$stuname) = @_;
3775: my $home='';
3776:
3777: if ($stuname) { $home=&homeserver($stuname,$domain); }
3778:
3779: if (!$symb) {
3780: unless ($symb=escape(&symbread())) { return ''; }
3781: } else {
3782: $symb=&escape(&symbclean($symb));
3783: }
3784: if (!$namespace) {
3785: unless ($namespace=$env{'request.course.id'}) {
3786: return '';
3787: }
3788: }
3789: if (!$domain) { $domain=$env{'user.domain'}; }
3790: if (!$stuname) { $stuname=$env{'user.name'}; }
3791: if (!$home) { $home=$env{'user.home'}; }
3792: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3793:
3794: my %returnhash=();
3795: foreach my $line (split(/\&/,$answer)) {
3796: my ($name,$value)=split(/\=/,$line);
3797: $returnhash{&unescape($name)}=&thaw_unescape($value);
3798: }
3799: my $version;
3800: for ($version=1;$version<=$returnhash{'version'};$version++) {
3801: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3802: $returnhash{$item}=$returnhash{$version.':'.$item};
3803: }
3804: }
3805: return %returnhash;
3806: }
3807:
3808: # ---------------------------------------------------------- Course Description
3809:
3810: sub coursedescription {
3811: my ($courseid,$args)=@_;
3812: $courseid=~s/^\///;
3813: $courseid=~s/\_/\//g;
3814: my ($cdomain,$cnum)=split(/\//,$courseid);
3815: my $chome=&homeserver($cnum,$cdomain);
3816: my $normalid=$cdomain.'_'.$cnum;
3817: # need to always cache even if we get errors otherwise we keep
3818: # trying and trying and trying to get the course description.
3819: my %envhash=();
3820: my %returnhash=();
3821:
3822: my $expiretime=600;
3823: if ($env{'request.course.id'} eq $normalid) {
3824: $expiretime=120;
3825: }
3826:
3827: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3828: if (!$args->{'freshen_cache'}
3829: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3830: foreach my $key (keys(%env)) {
3831: next if ($key !~ /^\Q$prefix\E(.*)/);
3832: my ($setting) = $1;
3833: $returnhash{$setting} = $env{$key};
3834: }
3835: return %returnhash;
3836: }
3837:
3838: # get the data agin
3839: if (!$args->{'one_time'}) {
3840: $envhash{'course.'.$normalid.'.last_cache'}=time;
3841: }
3842:
3843: if ($chome ne 'no_host') {
3844: %returnhash=&dump('environment',$cdomain,$cnum);
3845: if (!exists($returnhash{'con_lost'})) {
3846: $returnhash{'home'}= $chome;
3847: $returnhash{'domain'} = $cdomain;
3848: $returnhash{'num'} = $cnum;
3849: if (!defined($returnhash{'type'})) {
3850: $returnhash{'type'} = 'Course';
3851: }
3852: while (my ($name,$value) = each %returnhash) {
3853: $envhash{'course.'.$normalid.'.'.$name}=$value;
3854: }
3855: $returnhash{'url'}=&clutter($returnhash{'url'});
3856: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3857: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3858: $envhash{'course.'.$normalid.'.home'}=$chome;
3859: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3860: $envhash{'course.'.$normalid.'.num'}=$cnum;
3861: }
3862: }
3863: if (!$args->{'one_time'}) {
3864: &appenv(\%envhash);
3865: }
3866: return %returnhash;
3867: }
3868:
3869: # -------------------------------------------------See if a user is privileged
3870:
3871: sub privileged {
3872: my ($username,$domain)=@_;
3873: my $rolesdump=&reply("dump:$domain:$username:roles",
3874: &homeserver($username,$domain));
3875: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3876: ($rolesdump =~ /^error:/)) {
3877: return 0;
3878: }
3879: my $now=time;
3880: if ($rolesdump ne '') {
3881: foreach my $entry (split(/&/,$rolesdump)) {
3882: if ($entry!~/^rolesdef_/) {
3883: my ($area,$role)=split(/=/,$entry);
3884: $area=~s/\_\w\w$//;
3885: my ($trole,$tend,$tstart)=split(/_/,$role);
3886: if (($trole eq 'dc') || ($trole eq 'su')) {
3887: my $active=1;
3888: if ($tend) {
3889: if ($tend<$now) { $active=0; }
3890: }
3891: if ($tstart) {
3892: if ($tstart>$now) { $active=0; }
3893: }
3894: if ($active) { return 1; }
3895: }
3896: }
3897: }
3898: }
3899: return 0;
3900: }
3901:
3902: # -------------------------------------------------------- Get user privileges
3903:
3904: sub rolesinit {
3905: my ($domain,$username,$authhost)=@_;
3906: my $now=time;
3907: my %userroles = ('user.login.time' => $now);
3908: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3909: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3910: ($rolesdump =~ /^error:/)) {
3911: return \%userroles;
3912: }
3913: my %allroles=();
3914: my %allgroups=();
3915: my $group_privs;
3916:
3917: if ($rolesdump ne '') {
3918: foreach my $entry (split(/&/,$rolesdump)) {
3919: if ($entry!~/^rolesdef_/) {
3920: my ($area,$role)=split(/=/,$entry);
3921: $area=~s/\_\w\w$//;
3922: my ($trole,$tend,$tstart,$group_privs);
3923: if ($role=~/^cr/) {
3924: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3925: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3926: ($tend,$tstart)=split('_',$trest);
3927: } else {
3928: $trole=$role;
3929: }
3930: } elsif ($role =~ m|^gr/|) {
3931: ($trole,$tend,$tstart) = split(/_/,$role);
3932: ($trole,$group_privs) = split(/\//,$trole);
3933: $group_privs = &unescape($group_privs);
3934: } else {
3935: ($trole,$tend,$tstart)=split(/_/,$role);
3936: }
3937: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3938: $username);
3939: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3940: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3941: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3942: if (($area ne '') && ($trole ne '')) {
3943: my $spec=$trole.'.'.$area;
3944: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3945: if ($trole =~ /^cr\//) {
3946: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3947: } elsif ($trole eq 'gr') {
3948: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3949: } else {
3950: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3951: }
3952: }
3953: }
3954: }
3955: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3956: $userroles{'user.adv'} = $adv;
3957: $userroles{'user.author'} = $author;
3958: $env{'user.adv'}=$adv;
3959: }
3960: return \%userroles;
3961: }
3962:
3963: sub set_arearole {
3964: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3965: # log the associated role with the area
3966: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3967: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3968: }
3969:
3970: sub custom_roleprivs {
3971: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3972: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3973: my $homsvr=homeserver($rauthor,$rdomain);
3974: if (&hostname($homsvr) ne '') {
3975: my ($rdummy,$roledef)=
3976: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3977: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3978: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3979: if (defined($syspriv)) {
3980: if ($trest =~ /^$match_community$/) {
3981: $syspriv =~ s/bre\&S//;
3982: }
3983: $$allroles{'cm./'}.=':'.$syspriv;
3984: $$allroles{$spec.'./'}.=':'.$syspriv;
3985: }
3986: if ($tdomain ne '') {
3987: if (defined($dompriv)) {
3988: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3989: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3990: }
3991: if (($trest ne '') && (defined($coursepriv))) {
3992: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3993: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3994: }
3995: }
3996: }
3997: }
3998: }
3999:
4000: sub group_roleprivs {
4001: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4002: my $access = 1;
4003: my $now = time;
4004: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4005: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4006: if ($access) {
4007: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
4008: $$allgroups{$course}{$group} .=':'.$group_privs;
4009: }
4010: }
4011:
4012: sub standard_roleprivs {
4013: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4014: if (defined($pr{$trole.':s'})) {
4015: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4016: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4017: }
4018: if ($tdomain ne '') {
4019: if (defined($pr{$trole.':d'})) {
4020: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4021: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4022: }
4023: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4024: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4025: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4026: }
4027: }
4028: }
4029:
4030: sub set_userprivs {
4031: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
4032: my $author=0;
4033: my $adv=0;
4034: my %grouproles = ();
4035: if (keys(%{$allgroups}) > 0) {
4036: my @groupkeys;
4037: foreach my $role (keys(%{$allroles})) {
4038: push(@groupkeys,$role);
4039: }
4040: if (ref($groups_roles) eq 'HASH') {
4041: foreach my $key (keys(%{$groups_roles})) {
4042: unless (grep(/^\Q$key\E$/,@groupkeys)) {
4043: push(@groupkeys,$key);
4044: }
4045: }
4046: }
4047: if (@groupkeys > 0) {
4048: foreach my $role (@groupkeys) {
4049: my ($trole,$area,$sec,$extendedarea);
4050: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
4051: $trole = $1;
4052: $area = $2;
4053: $sec = $3;
4054: $extendedarea = $area.$sec;
4055: if (exists($$allgroups{$area})) {
4056: foreach my $group (keys(%{$$allgroups{$area}})) {
4057: my $spec = $trole.'.'.$extendedarea;
4058: $grouproles{$spec.'.'.$area.'/'.$group} =
4059: $$allgroups{$area}{$group};
4060: }
4061: }
4062: }
4063: }
4064: }
4065: }
4066: foreach my $group (keys(%grouproles)) {
4067: $$allroles{$group} = $grouproles{$group};
4068: }
4069: foreach my $role (keys(%{$allroles})) {
4070: my %thesepriv;
4071: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
4072: foreach my $item (split(/:/,$$allroles{$role})) {
4073: if ($item ne '') {
4074: my ($privilege,$restrictions)=split(/&/,$item);
4075: if ($restrictions eq '') {
4076: $thesepriv{$privilege}='F';
4077: } elsif ($thesepriv{$privilege} ne 'F') {
4078: $thesepriv{$privilege}.=$restrictions;
4079: }
4080: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4081: }
4082: }
4083: my $thesestr='';
4084: foreach my $priv (keys(%thesepriv)) {
4085: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4086: }
4087: $userroles->{'user.priv.'.$role} = $thesestr;
4088: }
4089: return ($author,$adv);
4090: }
4091:
4092: sub role_status {
4093: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
4094: my @pwhere = ();
4095: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4096: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4097: unless (!defined($$role) || $$role eq '') {
4098: $$where=join('.',@pwhere);
4099: $$trolecode=$$role.'.'.$$where;
4100: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4101: $$tstatus='is';
4102: if ($$tstart && $$tstart>$then) {
4103: $$tstatus='future';
4104: if ($$tstart<$now) {
4105: if ($$tstart && $$tstart>$refresh) {
4106: if (($$where ne '') && ($$role ne '')) {
4107: my (%allroles,%allgroups,$group_privs,
4108: %groups_roles,@rolecodes);
4109: my %userroles = (
4110: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4111: );
4112: @rolecodes = ('cm');
4113: my $spec=$$role.'.'.$$where;
4114: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4115: if ($$role =~ /^cr\//) {
4116: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4117: push(@rolecodes,'cr');
4118: } elsif ($$role eq 'gr') {
4119: push(@rolecodes,$$role);
4120: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4121: $env{'user.name'});
4122: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
4123: (undef,my $group_privs) = split(/\//,$trole);
4124: $group_privs = &unescape($group_privs);
4125: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4126: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
4127: if (keys(%course_roles) > 0) {
4128: my ($tnum) = ($trest =~ /^($match_courseid)/);
4129: if ($tdomain ne '' && $tnum ne '') {
4130: foreach my $key (keys(%course_roles)) {
4131: if ($key =~ /^\Q$tnum\E:\Q$tdomain\E:([^:]+):?([^:]*)/) {
4132: my $crsrole = $1;
4133: my $crssec = $2;
4134: if ($crsrole =~ /^cr/) {
4135: unless (grep(/^cr$/,@rolecodes)) {
4136: push(@rolecodes,'cr');
4137: }
4138: } else {
4139: unless(grep(/^\Q$crsrole\E$/,@rolecodes)) {
4140: push(@rolecodes,$crsrole);
4141: }
4142: }
4143: my $rolekey = $crsrole.'./'.$tdomain.'/'.$tnum;
4144: if ($crssec ne '') {
4145: $rolekey .= '/'.$crssec;
4146: }
4147: $rolekey .= './';
4148: $groups_roles{$rolekey} = \@rolecodes;
4149: }
4150: }
4151: }
4152: }
4153: } else {
4154: push(@rolecodes,$$role);
4155: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4156: }
4157: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4158: &appenv(\%userroles,\@rolecodes);
4159: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4160: }
4161: }
4162: $$tstatus = 'is';
4163: }
4164: }
4165: if ($$tend) {
4166: if ($$tend<$then) {
4167: $$tstatus='expired';
4168: } elsif ($$tend<$now) {
4169: $$tstatus='will_not';
4170: }
4171: }
4172: }
4173: }
4174: }
4175:
4176: sub check_adhoc_privs {
4177: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
4178: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4179: if ($env{$cckey}) {
4180: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
4181: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
4182: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4183: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4184: }
4185: } else {
4186: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4187: }
4188: }
4189:
4190: sub set_adhoc_privileges {
4191: # role can be cc or ca
4192: my ($dcdom,$pickedcourse,$role) = @_;
4193: my $area = '/'.$dcdom.'/'.$pickedcourse;
4194: my $spec = $role.'.'.$area;
4195: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4196: $env{'user.name'});
4197: my %ccrole = ();
4198: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4199: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4200: &appenv(\%userroles,[$role,'cm']);
4201: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4202: &appenv( {'request.role' => $spec,
4203: 'request.role.domain' => $dcdom,
4204: 'request.course.sec' => ''
4205: }
4206: );
4207: my $tadv=0;
4208: if (&allowed('adv') eq 'F') { $tadv=1; }
4209: &appenv({'request.role.adv' => $tadv});
4210: }
4211:
4212: # --------------------------------------------------------------- get interface
4213:
4214: sub get {
4215: my ($namespace,$storearr,$udomain,$uname)=@_;
4216: my $items='';
4217: foreach my $item (@$storearr) {
4218: $items.=&escape($item).'&';
4219: }
4220: $items=~s/\&$//;
4221: if (!$udomain) { $udomain=$env{'user.domain'}; }
4222: if (!$uname) { $uname=$env{'user.name'}; }
4223: my $uhome=&homeserver($uname,$udomain);
4224:
4225: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4226: my @pairs=split(/\&/,$rep);
4227: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4228: return @pairs;
4229: }
4230: my %returnhash=();
4231: my $i=0;
4232: foreach my $item (@$storearr) {
4233: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4234: $i++;
4235: }
4236: return %returnhash;
4237: }
4238:
4239: # --------------------------------------------------------------- del interface
4240:
4241: sub del {
4242: my ($namespace,$storearr,$udomain,$uname)=@_;
4243: my $items='';
4244: foreach my $item (@$storearr) {
4245: $items.=&escape($item).'&';
4246: }
4247:
4248: $items=~s/\&$//;
4249: if (!$udomain) { $udomain=$env{'user.domain'}; }
4250: if (!$uname) { $uname=$env{'user.name'}; }
4251: my $uhome=&homeserver($uname,$udomain);
4252: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4253: }
4254:
4255: # -------------------------------------------------------------- dump interface
4256:
4257: sub dump {
4258: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4259: if (!$udomain) { $udomain=$env{'user.domain'}; }
4260: if (!$uname) { $uname=$env{'user.name'}; }
4261: my $uhome=&homeserver($uname,$udomain);
4262: if ($regexp) {
4263: $regexp=&escape($regexp);
4264: } else {
4265: $regexp='.';
4266: }
4267: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4268: my @pairs=split(/\&/,$rep);
4269: my %returnhash=();
4270: foreach my $item (@pairs) {
4271: my ($key,$value)=split(/=/,$item,2);
4272: $key = &unescape($key);
4273: next if ($key =~ /^error: 2 /);
4274: $returnhash{$key}=&thaw_unescape($value);
4275: }
4276: return %returnhash;
4277: }
4278:
4279: # --------------------------------------------------------- dumpstore interface
4280:
4281: sub dumpstore {
4282: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4283: if (!$udomain) { $udomain=$env{'user.domain'}; }
4284: if (!$uname) { $uname=$env{'user.name'}; }
4285: my $uhome=&homeserver($uname,$udomain);
4286: if ($regexp) {
4287: $regexp=&escape($regexp);
4288: } else {
4289: $regexp='.';
4290: }
4291: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4292: my @pairs=split(/\&/,$rep);
4293: my %returnhash=();
4294: foreach my $item (@pairs) {
4295: my ($key,$value)=split(/=/,$item,2);
4296: next if ($key =~ /^error: 2 /);
4297: $returnhash{$key}=&thaw_unescape($value);
4298: }
4299: return %returnhash;
4300: }
4301:
4302: # -------------------------------------------------------------- keys interface
4303:
4304: sub getkeys {
4305: my ($namespace,$udomain,$uname)=@_;
4306: if (!$udomain) { $udomain=$env{'user.domain'}; }
4307: if (!$uname) { $uname=$env{'user.name'}; }
4308: my $uhome=&homeserver($uname,$udomain);
4309: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4310: my @keyarray=();
4311: foreach my $key (split(/\&/,$rep)) {
4312: next if ($key =~ /^error: 2 /);
4313: push(@keyarray,&unescape($key));
4314: }
4315: return @keyarray;
4316: }
4317:
4318: # --------------------------------------------------------------- currentdump
4319: sub currentdump {
4320: my ($courseid,$sdom,$sname)=@_;
4321: $courseid = $env{'request.course.id'} if (! defined($courseid));
4322: $sdom = $env{'user.domain'} if (! defined($sdom));
4323: $sname = $env{'user.name'} if (! defined($sname));
4324: my $uhome = &homeserver($sname,$sdom);
4325: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4326: return if ($rep =~ /^(error:|no_such_host)/);
4327: #
4328: my %returnhash=();
4329: #
4330: if ($rep eq "unknown_cmd") {
4331: # an old lond will not know currentdump
4332: # Do a dump and make it look like a currentdump
4333: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
4334: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4335: my %hash = @tmp;
4336: @tmp=();
4337: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
4338: } else {
4339: my @pairs=split(/\&/,$rep);
4340: foreach my $pair (@pairs) {
4341: my ($key,$value)=split(/=/,$pair,2);
4342: my ($symb,$param) = split(/:/,$key);
4343: $returnhash{&unescape($symb)}->{&unescape($param)} =
4344: &thaw_unescape($value);
4345: }
4346: }
4347: return %returnhash;
4348: }
4349:
4350: sub convert_dump_to_currentdump{
4351: my %hash = %{shift()};
4352: my %returnhash;
4353: # Code ripped from lond, essentially. The only difference
4354: # here is the unescaping done by lonnet::dump(). Conceivably
4355: # we might run in to problems with parameter names =~ /^v\./
4356: while (my ($key,$value) = each(%hash)) {
4357: my ($v,$symb,$param) = split(/:/,$key);
4358: $symb = &unescape($symb);
4359: $param = &unescape($param);
4360: next if ($v eq 'version' || $symb eq 'keys');
4361: next if (exists($returnhash{$symb}) &&
4362: exists($returnhash{$symb}->{$param}) &&
4363: $returnhash{$symb}->{'v.'.$param} > $v);
4364: $returnhash{$symb}->{$param}=$value;
4365: $returnhash{$symb}->{'v.'.$param}=$v;
4366: }
4367: #
4368: # Remove all of the keys in the hashes which keep track of
4369: # the version of the parameter.
4370: while (my ($symb,$param_hash) = each(%returnhash)) {
4371: # use a foreach because we are going to delete from the hash.
4372: foreach my $key (keys(%$param_hash)) {
4373: delete($param_hash->{$key}) if ($key =~ /^v\./);
4374: }
4375: }
4376: return \%returnhash;
4377: }
4378:
4379: # ------------------------------------------------------ critical inc interface
4380:
4381: sub cinc {
4382: return &inc(@_,'critical');
4383: }
4384:
4385: # --------------------------------------------------------------- inc interface
4386:
4387: sub inc {
4388: my ($namespace,$store,$udomain,$uname,$critical) = @_;
4389: if (!$udomain) { $udomain=$env{'user.domain'}; }
4390: if (!$uname) { $uname=$env{'user.name'}; }
4391: my $uhome=&homeserver($uname,$udomain);
4392: my $items='';
4393: if (! ref($store)) {
4394: # got a single value, so use that instead
4395: $items = &escape($store).'=&';
4396: } elsif (ref($store) eq 'SCALAR') {
4397: $items = &escape($$store).'=&';
4398: } elsif (ref($store) eq 'ARRAY') {
4399: $items = join('=&',map {&escape($_);} @{$store});
4400: } elsif (ref($store) eq 'HASH') {
4401: while (my($key,$value) = each(%{$store})) {
4402: $items.= &escape($key).'='.&escape($value).'&';
4403: }
4404: }
4405: $items=~s/\&$//;
4406: if ($critical) {
4407: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4408: } else {
4409: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4410: }
4411: }
4412:
4413: # --------------------------------------------------------------- put interface
4414:
4415: sub put {
4416: my ($namespace,$storehash,$udomain,$uname)=@_;
4417: if (!$udomain) { $udomain=$env{'user.domain'}; }
4418: if (!$uname) { $uname=$env{'user.name'}; }
4419: my $uhome=&homeserver($uname,$udomain);
4420: my $items='';
4421: foreach my $item (keys(%$storehash)) {
4422: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4423: }
4424: $items=~s/\&$//;
4425: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4426: }
4427:
4428: # ------------------------------------------------------------ newput interface
4429:
4430: sub newput {
4431: my ($namespace,$storehash,$udomain,$uname)=@_;
4432: if (!$udomain) { $udomain=$env{'user.domain'}; }
4433: if (!$uname) { $uname=$env{'user.name'}; }
4434: my $uhome=&homeserver($uname,$udomain);
4435: my $items='';
4436: foreach my $key (keys(%$storehash)) {
4437: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4438: }
4439: $items=~s/\&$//;
4440: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4441: }
4442:
4443: # --------------------------------------------------------- putstore interface
4444:
4445: sub putstore {
4446: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4447: if (!$udomain) { $udomain=$env{'user.domain'}; }
4448: if (!$uname) { $uname=$env{'user.name'}; }
4449: my $uhome=&homeserver($uname,$udomain);
4450: my $items='';
4451: foreach my $key (keys(%$storehash)) {
4452: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
4453: }
4454: $items=~s/\&$//;
4455: my $esc_symb=&escape($symb);
4456: my $esc_v=&escape($version);
4457: my $reply =
4458: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
4459: $uhome);
4460: if ($reply eq 'unknown_cmd') {
4461: # gfall back to way things use to be done
4462: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4463: $uname);
4464: }
4465: return $reply;
4466: }
4467:
4468: sub old_putstore {
4469: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4470: if (!$udomain) { $udomain=$env{'user.domain'}; }
4471: if (!$uname) { $uname=$env{'user.name'}; }
4472: my $uhome=&homeserver($uname,$udomain);
4473: my %newstorehash;
4474: foreach my $item (keys(%$storehash)) {
4475: my $key = $version.':'.&escape($symb).':'.$item;
4476: $newstorehash{$key} = $storehash->{$item};
4477: }
4478: my $items='';
4479: my %allitems = ();
4480: foreach my $item (keys(%newstorehash)) {
4481: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
4482: my $key = $1.':keys:'.$2;
4483: $allitems{$key} .= $3.':';
4484: }
4485: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
4486: }
4487: foreach my $item (keys(%allitems)) {
4488: $allitems{$item} =~ s/\:$//;
4489: $items.= $item.'='.$allitems{$item}.'&';
4490: }
4491: $items=~s/\&$//;
4492: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4493: }
4494:
4495: # ------------------------------------------------------ critical put interface
4496:
4497: sub cput {
4498: my ($namespace,$storehash,$udomain,$uname)=@_;
4499: if (!$udomain) { $udomain=$env{'user.domain'}; }
4500: if (!$uname) { $uname=$env{'user.name'}; }
4501: my $uhome=&homeserver($uname,$udomain);
4502: my $items='';
4503: foreach my $item (keys(%$storehash)) {
4504: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4505: }
4506: $items=~s/\&$//;
4507: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
4508: }
4509:
4510: # -------------------------------------------------------------- eget interface
4511:
4512: sub eget {
4513: my ($namespace,$storearr,$udomain,$uname)=@_;
4514: my $items='';
4515: foreach my $item (@$storearr) {
4516: $items.=&escape($item).'&';
4517: }
4518: $items=~s/\&$//;
4519: if (!$udomain) { $udomain=$env{'user.domain'}; }
4520: if (!$uname) { $uname=$env{'user.name'}; }
4521: my $uhome=&homeserver($uname,$udomain);
4522: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
4523: my @pairs=split(/\&/,$rep);
4524: my %returnhash=();
4525: my $i=0;
4526: foreach my $item (@$storearr) {
4527: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4528: $i++;
4529: }
4530: return %returnhash;
4531: }
4532:
4533: # ------------------------------------------------------------ tmpput interface
4534: sub tmpput {
4535: my ($storehash,$server,$context)=@_;
4536: my $items='';
4537: foreach my $item (keys(%$storehash)) {
4538: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4539: }
4540: $items=~s/\&$//;
4541: if (defined($context)) {
4542: $items .= ':'.&escape($context);
4543: }
4544: return &reply("tmpput:$items",$server);
4545: }
4546:
4547: # ------------------------------------------------------------ tmpget interface
4548: sub tmpget {
4549: my ($token,$server)=@_;
4550: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4551: my $rep=&reply("tmpget:$token",$server);
4552: my %returnhash;
4553: foreach my $item (split(/\&/,$rep)) {
4554: my ($key,$value)=split(/=/,$item);
4555: next if ($key =~ /^error: 2 /);
4556: $returnhash{&unescape($key)}=&thaw_unescape($value);
4557: }
4558: return %returnhash;
4559: }
4560:
4561: # ------------------------------------------------------------ tmpget interface
4562: sub tmpdel {
4563: my ($token,$server)=@_;
4564: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4565: return &reply("tmpdel:$token",$server);
4566: }
4567:
4568: # -------------------------------------------------- portfolio access checking
4569:
4570: sub portfolio_access {
4571: my ($requrl) = @_;
4572: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4573: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4574: if ($result) {
4575: my %setters;
4576: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4577: my ($startblock,$endblock) =
4578: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4579: if ($startblock && $endblock) {
4580: return 'B';
4581: }
4582: } else {
4583: my ($startblock,$endblock) =
4584: &Apache::loncommon::blockcheck(\%setters,'port');
4585: if ($startblock && $endblock) {
4586: return 'B';
4587: }
4588: }
4589: }
4590: if ($result eq 'ok') {
4591: return 'F';
4592: } elsif ($result =~ /^[^:]+:guest_/) {
4593: return 'A';
4594: }
4595: return '';
4596: }
4597:
4598: sub get_portfolio_access {
4599: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4600:
4601: if (!ref($access_hash)) {
4602: my $current_perms = &get_portfile_permissions($udom,$unum);
4603: my %access_controls = &get_access_controls($current_perms,$group,
4604: $file_name);
4605: $access_hash = $access_controls{$file_name};
4606: }
4607:
4608: my ($public,$guest,@domains,@users,@courses,@groups);
4609: my $now = time;
4610: if (ref($access_hash) eq 'HASH') {
4611: foreach my $key (keys(%{$access_hash})) {
4612: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4613: if ($start > $now) {
4614: next;
4615: }
4616: if ($end && $end<$now) {
4617: next;
4618: }
4619: if ($scope eq 'public') {
4620: $public = $key;
4621: last;
4622: } elsif ($scope eq 'guest') {
4623: $guest = $key;
4624: } elsif ($scope eq 'domains') {
4625: push(@domains,$key);
4626: } elsif ($scope eq 'users') {
4627: push(@users,$key);
4628: } elsif ($scope eq 'course') {
4629: push(@courses,$key);
4630: } elsif ($scope eq 'group') {
4631: push(@groups,$key);
4632: }
4633: }
4634: if ($public) {
4635: return 'ok';
4636: }
4637: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4638: if ($guest) {
4639: return $guest;
4640: }
4641: } else {
4642: if (@domains > 0) {
4643: foreach my $domkey (@domains) {
4644: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4645: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4646: return 'ok';
4647: }
4648: }
4649: }
4650: }
4651: if (@users > 0) {
4652: foreach my $userkey (@users) {
4653: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4654: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4655: if (ref($item) eq 'HASH') {
4656: if (($item->{'uname'} eq $env{'user.name'}) &&
4657: ($item->{'udom'} eq $env{'user.domain'})) {
4658: return 'ok';
4659: }
4660: }
4661: }
4662: }
4663: }
4664: }
4665: my %roleshash;
4666: my @courses_and_groups = @courses;
4667: push(@courses_and_groups,@groups);
4668: if (@courses_and_groups > 0) {
4669: my (%allgroups,%allroles);
4670: my ($start,$end,$role,$sec,$group);
4671: foreach my $envkey (%env) {
4672: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4673: my $cid = $2.'_'.$3;
4674: if ($1 eq 'gr') {
4675: $group = $4;
4676: $allgroups{$cid}{$group} = $env{$envkey};
4677: } else {
4678: if ($4 eq '') {
4679: $sec = 'none';
4680: } else {
4681: $sec = $4;
4682: }
4683: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4684: }
4685: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4686: my $cid = $2.'_'.$3;
4687: if ($4 eq '') {
4688: $sec = 'none';
4689: } else {
4690: $sec = $4;
4691: }
4692: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4693: }
4694: }
4695: if (keys(%allroles) == 0) {
4696: return;
4697: }
4698: foreach my $key (@courses_and_groups) {
4699: my %content = %{$$access_hash{$key}};
4700: my $cnum = $content{'number'};
4701: my $cdom = $content{'domain'};
4702: my $cid = $cdom.'_'.$cnum;
4703: if (!exists($allroles{$cid})) {
4704: next;
4705: }
4706: foreach my $role_id (keys(%{$content{'roles'}})) {
4707: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4708: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4709: my @status = @{$content{'roles'}{$role_id}{'access'}};
4710: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4711: foreach my $role (keys(%{$allroles{$cid}})) {
4712: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4713: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4714: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4715: if (grep/^all$/,@sections) {
4716: return 'ok';
4717: } else {
4718: if (grep/^$sec$/,@sections) {
4719: return 'ok';
4720: }
4721: }
4722: }
4723: }
4724: if (keys(%{$allgroups{$cid}}) == 0) {
4725: if (grep/^none$/,@groups) {
4726: return 'ok';
4727: }
4728: } else {
4729: if (grep/^all$/,@groups) {
4730: return 'ok';
4731: }
4732: foreach my $group (keys(%{$allgroups{$cid}})) {
4733: if (grep/^$group$/,@groups) {
4734: return 'ok';
4735: }
4736: }
4737: }
4738: }
4739: }
4740: }
4741: }
4742: }
4743: if ($guest) {
4744: return $guest;
4745: }
4746: }
4747: }
4748: return;
4749: }
4750:
4751: sub course_group_datechecker {
4752: my ($dates,$now,$status) = @_;
4753: my ($start,$end) = split(/\./,$dates);
4754: if (!$start && !$end) {
4755: return 'ok';
4756: }
4757: if (grep/^active$/,@{$status}) {
4758: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4759: return 'ok';
4760: }
4761: }
4762: if (grep/^previous$/,@{$status}) {
4763: if ($end > $now ) {
4764: return 'ok';
4765: }
4766: }
4767: if (grep/^future$/,@{$status}) {
4768: if ($start > $now) {
4769: return 'ok';
4770: }
4771: }
4772: return;
4773: }
4774:
4775: sub parse_portfolio_url {
4776: my ($url) = @_;
4777:
4778: my ($type,$udom,$unum,$group,$file_name);
4779:
4780: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4781: $type = 1;
4782: $udom = $1;
4783: $unum = $2;
4784: $file_name = $3;
4785: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4786: $type = 2;
4787: $udom = $1;
4788: $unum = $2;
4789: $group = $3;
4790: $file_name = $3.'/'.$4;
4791: }
4792: if (wantarray) {
4793: return ($type,$udom,$unum,$file_name,$group);
4794: }
4795: return $type;
4796: }
4797:
4798: sub is_portfolio_url {
4799: my ($url) = @_;
4800: return scalar(&parse_portfolio_url($url));
4801: }
4802:
4803: sub is_portfolio_file {
4804: my ($file) = @_;
4805: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4806: return 1;
4807: }
4808: return;
4809: }
4810:
4811: sub usertools_access {
4812: my ($uname,$udom,$tool,$action,$context) = @_;
4813: my ($access,%tools);
4814: if ($context eq '') {
4815: $context = 'tools';
4816: }
4817: if ($context eq 'requestcourses') {
4818: %tools = (
4819: official => 1,
4820: unofficial => 1,
4821: community => 1,
4822: );
4823: } else {
4824: %tools = (
4825: aboutme => 1,
4826: blog => 1,
4827: portfolio => 1,
4828: );
4829: }
4830: return if (!defined($tools{$tool}));
4831:
4832: if ((!defined($udom)) || (!defined($uname))) {
4833: $udom = $env{'user.domain'};
4834: $uname = $env{'user.name'};
4835: }
4836:
4837: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4838: if ($action ne 'reload') {
4839: if ($context eq 'requestcourses') {
4840: return $env{'environment.canrequest.'.$tool};
4841: } else {
4842: return $env{'environment.availabletools.'.$tool};
4843: }
4844: }
4845: }
4846:
4847: my ($toolstatus,$inststatus);
4848:
4849: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4850: ($action ne 'reload')) {
4851: $toolstatus = $env{'environment.'.$context.'.'.$tool};
4852: $inststatus = $env{'environment.inststatus'};
4853: } else {
4854: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
4855: $toolstatus = $userenv{$context.'.'.$tool};
4856: $inststatus = $userenv{'inststatus'};
4857: }
4858:
4859: if ($toolstatus ne '') {
4860: if ($toolstatus) {
4861: $access = 1;
4862: } else {
4863: $access = 0;
4864: }
4865: return $access;
4866: }
4867:
4868: my $is_adv = &is_advanced_user($udom,$uname);
4869: my %domdef = &get_domain_defaults($udom);
4870: if (ref($domdef{$tool}) eq 'HASH') {
4871: if ($is_adv) {
4872: if ($domdef{$tool}{'_LC_adv'} ne '') {
4873: if ($domdef{$tool}{'_LC_adv'}) {
4874: $access = 1;
4875: } else {
4876: $access = 0;
4877: }
4878: return $access;
4879: }
4880: }
4881: if ($inststatus ne '') {
4882: my ($hasaccess,$hasnoaccess);
4883: foreach my $affiliation (split(/:/,$inststatus)) {
4884: if ($domdef{$tool}{$affiliation} ne '') {
4885: if ($domdef{$tool}{$affiliation}) {
4886: $hasaccess = 1;
4887: } else {
4888: $hasnoaccess = 1;
4889: }
4890: }
4891: }
4892: if ($hasaccess || $hasnoaccess) {
4893: if ($hasaccess) {
4894: $access = 1;
4895: } elsif ($hasnoaccess) {
4896: $access = 0;
4897: }
4898: return $access;
4899: }
4900: } else {
4901: if ($domdef{$tool}{'default'} ne '') {
4902: if ($domdef{$tool}{'default'}) {
4903: $access = 1;
4904: } elsif ($domdef{$tool}{'default'} == 0) {
4905: $access = 0;
4906: }
4907: return $access;
4908: }
4909: }
4910: } else {
4911: if ($context eq 'tools') {
4912: $access = 1;
4913: } else {
4914: $access = 0;
4915: }
4916: return $access;
4917: }
4918: }
4919:
4920: sub is_course_owner {
4921: my ($cdom,$cnum,$udom,$uname) = @_;
4922: if (($udom eq '') || ($uname eq '')) {
4923: $udom = $env{'user.domain'};
4924: $uname = $env{'user.name'};
4925: }
4926: unless (($udom eq '') || ($uname eq '')) {
4927: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4928: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4929: return 1;
4930: } else {
4931: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4932: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4933: return 1;
4934: }
4935: }
4936: }
4937: }
4938: return;
4939: }
4940:
4941: sub is_advanced_user {
4942: my ($udom,$uname) = @_;
4943: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4944: my %allroles;
4945: my $is_adv;
4946: foreach my $role (keys(%roleshash)) {
4947: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4948: my $area = '/'.$tdomain.'/'.$trest;
4949: if ($sec ne '') {
4950: $area .= '/'.$sec;
4951: }
4952: if (($area ne '') && ($trole ne '')) {
4953: my $spec=$trole.'.'.$area;
4954: if ($trole =~ /^cr\//) {
4955: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4956: } elsif ($trole ne 'gr') {
4957: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4958: }
4959: }
4960: }
4961: foreach my $role (keys(%allroles)) {
4962: last if ($is_adv);
4963: foreach my $item (split(/:/,$allroles{$role})) {
4964: if ($item ne '') {
4965: my ($privilege,$restrictions)=split(/&/,$item);
4966: if ($privilege eq 'adv') {
4967: $is_adv = 1;
4968: last;
4969: }
4970: }
4971: }
4972: }
4973: return $is_adv;
4974: }
4975:
4976: sub check_can_request {
4977: my ($dom,$can_request,$request_domains) = @_;
4978: my $canreq = 0;
4979: my ($types,$typename) = &Apache::loncommon::course_types();
4980: my @options = ('approval','validate','autolimit');
4981: my $optregex = join('|',@options);
4982: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4983: foreach my $type (@{$types}) {
4984: if (&usertools_access($env{'user.name'},
4985: $env{'user.domain'},
4986: $type,undef,'requestcourses')) {
4987: $canreq ++;
4988: if (ref($request_domains) eq 'HASH') {
4989: push(@{$request_domains->{$type}},$env{'user.domain'});
4990: }
4991: if ($dom eq $env{'user.domain'}) {
4992: $can_request->{$type} = 1;
4993: }
4994: }
4995: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4996: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4997: if (@curr > 0) {
4998: foreach my $item (@curr) {
4999: if (ref($request_domains) eq 'HASH') {
5000: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
5001: if ($otherdom ne '') {
5002: if (ref($request_domains->{$type}) eq 'ARRAY') {
5003: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
5004: push(@{$request_domains->{$type}},$otherdom);
5005: }
5006: } else {
5007: push(@{$request_domains->{$type}},$otherdom);
5008: }
5009: }
5010: }
5011: }
5012: unless($dom eq $env{'user.domain'}) {
5013: $canreq ++;
5014: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
5015: $can_request->{$type} = 1;
5016: }
5017: }
5018: }
5019: }
5020: }
5021: }
5022: return $canreq;
5023: }
5024:
5025: # ---------------------------------------------- Custom access rule evaluation
5026:
5027: sub customaccess {
5028: my ($priv,$uri)=@_;
5029: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
5030: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
5031: $udom = &LONCAPA::clean_domain($udom);
5032: $ucrs = &LONCAPA::clean_username($ucrs);
5033: my $access=0;
5034: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
5035: my ($effect,$realm,$role,$type)=split(/\:/,$right);
5036: if ($type eq 'user') {
5037: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5038: my ($tdom,$tuname)=split(m{/},$scope);
5039: if ($tdom) {
5040: if ($tdom ne $env{'user.domain'}) { next; }
5041: }
5042: if ($tuname) {
5043: if ($tuname ne $env{'user.name'}) { next; }
5044: }
5045: $access=($effect eq 'allow');
5046: last;
5047: }
5048: } else {
5049: if ($role) {
5050: if ($role ne $urole) { next; }
5051: }
5052: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5053: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
5054: if ($tdom) {
5055: if ($tdom ne $udom) { next; }
5056: }
5057: if ($tcrs) {
5058: if ($tcrs ne $ucrs) { next; }
5059: }
5060: if ($tsec) {
5061: if ($tsec ne $usec) { next; }
5062: }
5063: $access=($effect eq 'allow');
5064: last;
5065: }
5066: if ($realm eq '' && $role eq '') {
5067: $access=($effect eq 'allow');
5068: }
5069: }
5070: }
5071: return $access;
5072: }
5073:
5074: # ------------------------------------------------- Check for a user privilege
5075:
5076: sub allowed {
5077: my ($priv,$uri,$symb,$role)=@_;
5078: my $ver_orguri=$uri;
5079: $uri=&deversion($uri);
5080: my $orguri=$uri;
5081: $uri=&declutter($uri);
5082:
5083: if ($priv eq 'evb') {
5084: # Evade communication block restrictions for specified role in a course
5085: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
5086: return $1;
5087: } else {
5088: return;
5089: }
5090: }
5091:
5092: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
5093: # Free bre access to adm and meta resources
5094: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
5095: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5096: && ($priv eq 'bre')) {
5097: return 'F';
5098: }
5099:
5100: # Free bre access to user's own portfolio contents
5101: my ($space,$domain,$name,@dir)=split('/',$uri);
5102: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
5103: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
5104: my %setters;
5105: my ($startblock,$endblock) =
5106: &Apache::loncommon::blockcheck(\%setters,'port');
5107: if ($startblock && $endblock) {
5108: return 'B';
5109: } else {
5110: return 'F';
5111: }
5112: }
5113:
5114: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
5115: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5116: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5117: if (exists($env{'request.course.id'})) {
5118: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5119: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5120: if (($domain eq $cdom) && ($name eq $cnum)) {
5121: my $courseprivid=$env{'request.course.id'};
5122: $courseprivid=~s/\_/\//;
5123: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5124: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5125: return $1;
5126: } else {
5127: if ($env{'request.course.sec'}) {
5128: $courseprivid.='/'.$env{'request.course.sec'};
5129: }
5130: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5131: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5132: return $2;
5133: }
5134: }
5135: }
5136: }
5137: }
5138:
5139: # Free bre to public access
5140:
5141: if ($priv eq 'bre') {
5142: my $copyright=&metadata($uri,'copyright');
5143: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
5144: return 'F';
5145: }
5146: if ($copyright eq 'priv') {
5147: $uri=~/([^\/]+)\/([^\/]+)\//;
5148: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
5149: return '';
5150: }
5151: }
5152: if ($copyright eq 'domain') {
5153: $uri=~/([^\/]+)\/([^\/]+)\//;
5154: unless (($env{'user.domain'} eq $1) ||
5155: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
5156: return '';
5157: }
5158: }
5159: if ($env{'request.role'}=~ /li\.\//) {
5160: # Library role, so allow browsing of resources in this domain.
5161: return 'F';
5162: }
5163: if ($copyright eq 'custom') {
5164: unless (&customaccess($priv,$uri)) { return ''; }
5165: }
5166: }
5167: # Domain coordinator is trying to create a course
5168: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
5169: # uri is the requested domain in this case.
5170: # comparison to 'request.role.domain' shows if the user has selected
5171: # a role of dc for the domain in question.
5172: return 'F' if ($uri eq $env{'request.role.domain'});
5173: }
5174:
5175: my $thisallowed='';
5176: my $statecond=0;
5177: my $courseprivid='';
5178:
5179: my $ownaccess;
5180: # Community Coordinator or Assistant Co-author browsing resource space.
5181: if (($priv eq 'bro') && ($env{'user.author'})) {
5182: if ($uri eq '') {
5183: $ownaccess = 1;
5184: } else {
5185: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5186: my $udom = $env{'user.domain'};
5187: my $uname = $env{'user.name'};
5188: if ($uri =~ m{^\Q$udom\E/?$}) {
5189: $ownaccess = 1;
5190: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
5191: unless ($uri =~ m{\.\./}) {
5192: $ownaccess = 1;
5193: }
5194: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5195: my $now = time;
5196: if ($uri =~ m{^([^/]+)/?$}) {
5197: my $adom = $1;
5198: foreach my $key (keys(%env)) {
5199: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
5200: my ($start,$end) = split('.',$env{$key});
5201: if (($now >= $start) && (!$end || $end < $now)) {
5202: $ownaccess = 1;
5203: last;
5204: }
5205: }
5206: }
5207: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5208: my $adom = $1;
5209: my $aname = $2;
5210: foreach my $role ('ca','aa') {
5211: if ($env{"user.role.$role./$adom/$aname"}) {
5212: my ($start,$end) =
5213: split('.',$env{"user.role.$role./$adom/$aname"});
5214: if (($now >= $start) && (!$end || $end < $now)) {
5215: $ownaccess = 1;
5216: last;
5217: }
5218: }
5219: }
5220: }
5221: }
5222: }
5223: }
5224: }
5225:
5226: # Course
5227:
5228: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
5229: unless (($priv eq 'bro') && (!$ownaccess)) {
5230: $thisallowed.=$1;
5231: }
5232: }
5233:
5234: # Domain
5235:
5236: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
5237: =~/\Q$priv\E\&([^\:]*)/) {
5238: unless (($priv eq 'bro') && (!$ownaccess)) {
5239: $thisallowed.=$1;
5240: }
5241: }
5242:
5243: # Course: uri itself is a course
5244: my $courseuri=$uri;
5245: $courseuri=~s/\_(\d)/\/$1/;
5246: $courseuri=~s/^([^\/])/\/$1/;
5247:
5248: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
5249: =~/\Q$priv\E\&([^\:]*)/) {
5250: unless (($priv eq 'bro') && (!$ownaccess)) {
5251: $thisallowed.=$1;
5252: }
5253: }
5254:
5255: # URI is an uploaded document for this course, default permissions don't matter
5256: # not allowing 'edit' access (editupload) to uploaded course docs
5257: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
5258: $thisallowed='';
5259: my ($match)=&is_on_map($uri);
5260: if ($match) {
5261: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5262: =~/\Q$priv\E\&([^\:]*)/) {
5263: $thisallowed.=$1;
5264: }
5265: } else {
5266: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
5267: if ($refuri) {
5268: if ($refuri =~ m|^/adm/|) {
5269: $thisallowed='F';
5270: } else {
5271: $refuri=&declutter($refuri);
5272: my ($match) = &is_on_map($refuri);
5273: if ($match) {
5274: $thisallowed='F';
5275: }
5276: }
5277: }
5278: }
5279: }
5280:
5281: if ($priv eq 'bre'
5282: && $thisallowed ne 'F'
5283: && $thisallowed ne '2'
5284: && &is_portfolio_url($uri)) {
5285: $thisallowed = &portfolio_access($uri);
5286: }
5287:
5288: # Full access at system, domain or course-wide level? Exit.
5289: if ($thisallowed=~/F/) {
5290: return 'F';
5291: }
5292:
5293: # If this is generating or modifying users, exit with special codes
5294:
5295: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5296: if (($priv eq 'cca') || ($priv eq 'caa')) {
5297: my ($audom,$auname)=split('/',$uri);
5298: # no author name given, so this just checks on the general right to make a co-author in this domain
5299: unless ($auname) { return $thisallowed; }
5300: # an author name is given, so we are about to actually make a co-author for a certain account
5301: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5302: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5303: ($audom ne $env{'request.role.domain'}))) { return ''; }
5304: }
5305: return $thisallowed;
5306: }
5307: #
5308: # Gathered so far: system, domain and course wide privileges
5309: #
5310: # Course: See if uri or referer is an individual resource that is part of
5311: # the course
5312:
5313: if ($env{'request.course.id'}) {
5314:
5315: $courseprivid=$env{'request.course.id'};
5316: if ($env{'request.course.sec'}) {
5317: $courseprivid.='/'.$env{'request.course.sec'};
5318: }
5319: $courseprivid=~s/\_/\//;
5320: my $checkreferer=1;
5321: my ($match,$cond)=&is_on_map($uri);
5322: if ($match) {
5323: $statecond=$cond;
5324: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5325: =~/\Q$priv\E\&([^\:]*)/) {
5326: $thisallowed.=$1;
5327: $checkreferer=0;
5328: }
5329: }
5330:
5331: if ($checkreferer) {
5332: my $refuri=$env{'httpref.'.$orguri};
5333: unless ($refuri) {
5334: foreach my $key (keys(%env)) {
5335: if ($key=~/^httpref\..*\*/) {
5336: my $pattern=$key;
5337: $pattern=~s/^httpref\.\/res\///;
5338: $pattern=~s/\*/\[\^\/\]\+/g;
5339: $pattern=~s/\//\\\//g;
5340: if ($orguri=~/$pattern/) {
5341: $refuri=$env{$key};
5342: }
5343: }
5344: }
5345: }
5346:
5347: if ($refuri) {
5348: $refuri=&declutter($refuri);
5349: my ($match,$cond)=&is_on_map($refuri);
5350: if ($match) {
5351: my $refstatecond=$cond;
5352: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5353: =~/\Q$priv\E\&([^\:]*)/) {
5354: $thisallowed.=$1;
5355: $uri=$refuri;
5356: $statecond=$refstatecond;
5357: }
5358: }
5359: }
5360: }
5361: }
5362:
5363: #
5364: # Gathered now: all privileges that could apply, and condition number
5365: #
5366: #
5367: # Full or no access?
5368: #
5369:
5370: if ($thisallowed=~/F/) {
5371: return 'F';
5372: }
5373:
5374: unless ($thisallowed) {
5375: return '';
5376: }
5377:
5378: # Restrictions exist, deal with them
5379: #
5380: # C:according to course preferences
5381: # R:according to resource settings
5382: # L:unless locked
5383: # X:according to user session state
5384: #
5385:
5386: # Possibly locked functionality, check all courses
5387: # Locks might take effect only after 10 minutes cache expiration for other
5388: # courses, and 2 minutes for current course
5389:
5390: my $envkey;
5391: if ($thisallowed=~/L/) {
5392: foreach $envkey (keys(%env)) {
5393: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5394: my $courseid=$2;
5395: my $roleid=$1.'.'.$2;
5396: $courseid=~s/^\///;
5397: my $expiretime=600;
5398: if ($env{'request.role'} eq $roleid) {
5399: $expiretime=120;
5400: }
5401: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5402: my $prefix='course.'.$cdom.'_'.$cnum.'.';
5403: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
5404: &coursedescription($courseid,{'freshen_cache' => 1});
5405: }
5406: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5407: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5408: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5409: &log($env{'user.domain'},$env{'user.name'},
5410: $env{'user.home'},
5411: 'Locked by res: '.$priv.' for '.$uri.' due to '.
5412: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5413: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5414: return '';
5415: }
5416: }
5417: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5418: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5419: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5420: &log($env{'user.domain'},$env{'user.name'},
5421: $env{'user.home'},
5422: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
5423: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5424: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5425: return '';
5426: }
5427: }
5428: }
5429: }
5430: }
5431:
5432: #
5433: # Rest of the restrictions depend on selected course
5434: #
5435:
5436: unless ($env{'request.course.id'}) {
5437: if ($thisallowed eq 'A') {
5438: return 'A';
5439: } elsif ($thisallowed eq 'B') {
5440: return 'B';
5441: } else {
5442: return '1';
5443: }
5444: }
5445:
5446: #
5447: # Now user is definitely in a course
5448: #
5449:
5450:
5451: # Course preferences
5452:
5453: if ($thisallowed=~/C/) {
5454: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5455: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5456: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
5457: =~/\Q$rolecode\E/) {
5458: if ($priv ne 'pch') {
5459: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5460: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5461: $env{'request.course.id'});
5462: }
5463: return '';
5464: }
5465:
5466: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
5467: =~/\Q$unamedom\E/) {
5468: if ($priv ne 'pch') {
5469: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5470: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5471: $env{'request.course.id'});
5472: }
5473: return '';
5474: }
5475: }
5476:
5477: # Resource preferences
5478:
5479: if ($thisallowed=~/R/) {
5480: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5481: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
5482: if ($priv ne 'pch') {
5483: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5484: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5485: }
5486: return '';
5487: }
5488: }
5489:
5490: # Restricted by state or randomout?
5491:
5492: if ($thisallowed=~/X/) {
5493: if ($env{'acc.randomout'}) {
5494: if (!$symb) { $symb=&symbread($uri,1); }
5495: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
5496: return '';
5497: }
5498: }
5499: if (&condval($statecond)) {
5500: return '2';
5501: } else {
5502: return '';
5503: }
5504: }
5505:
5506: if ($thisallowed eq 'A') {
5507: return 'A';
5508: } elsif ($thisallowed eq 'B') {
5509: return 'B';
5510: }
5511: return 'F';
5512: }
5513:
5514: sub split_uri_for_cond {
5515: my $uri=&deversion(&declutter(shift));
5516: my @uriparts=split(/\//,$uri);
5517: my $filename=pop(@uriparts);
5518: my $pathname=join('/',@uriparts);
5519: return ($pathname,$filename);
5520: }
5521: # --------------------------------------------------- Is a resource on the map?
5522:
5523: sub is_on_map {
5524: my ($pathname,$filename) = &split_uri_for_cond(shift);
5525: #Trying to find the conditional for the file
5526: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
5527: /\&\Q$filename\E\:([\d\|]+)\&/);
5528: if ($match) {
5529: return (1,$1);
5530: } else {
5531: return (0,0);
5532: }
5533: }
5534:
5535: # --------------------------------------------------------- Get symb from alias
5536:
5537: sub get_symb_from_alias {
5538: my $symb=shift;
5539: my ($map,$resid,$url)=&decode_symb($symb);
5540: # Already is a symb
5541: if ($url) { return $symb; }
5542: # Must be an alias
5543: my $aliassymb='';
5544: my %bighash;
5545: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5546: &GDBM_READER(),0640)) {
5547: my $rid=$bighash{'mapalias_'.$symb};
5548: if ($rid) {
5549: my ($mapid,$resid)=split(/\./,$rid);
5550: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5551: $resid,$bighash{'src_'.$rid});
5552: }
5553: untie %bighash;
5554: }
5555: return $aliassymb;
5556: }
5557:
5558: # ----------------------------------------------------------------- Define Role
5559:
5560: sub definerole {
5561: if (allowed('mcr','/')) {
5562: my ($rolename,$sysrole,$domrole,$courole)=@_;
5563: foreach my $role (split(':',$sysrole)) {
5564: my ($crole,$cqual)=split(/\&/,$role);
5565: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5566: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5567: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5568: return "refused:s:$crole&$cqual";
5569: }
5570: }
5571: }
5572: foreach my $role (split(':',$domrole)) {
5573: my ($crole,$cqual)=split(/\&/,$role);
5574: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5575: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5576: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
5577: return "refused:d:$crole&$cqual";
5578: }
5579: }
5580: }
5581: foreach my $role (split(':',$courole)) {
5582: my ($crole,$cqual)=split(/\&/,$role);
5583: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5584: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5585: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5586: return "refused:c:$crole&$cqual";
5587: }
5588: }
5589: }
5590: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5591: "$env{'user.domain'}:$env{'user.name'}:".
5592: "rolesdef_$rolename=".
5593: escape($sysrole.'_'.$domrole.'_'.$courole);
5594: return reply($command,$env{'user.home'});
5595: } else {
5596: return 'refused';
5597: }
5598: }
5599:
5600: # ---------------- Make a metadata query against the network of library servers
5601:
5602: sub metadata_query {
5603: my ($query,$custom,$customshow,$server_array)=@_;
5604: my %rhash;
5605: my %libserv = &all_library();
5606: my @server_list = (defined($server_array) ? @$server_array
5607: : keys(%libserv) );
5608: for my $server (@server_list) {
5609: unless ($custom or $customshow) {
5610: my $reply=&reply("querysend:".&escape($query),$server);
5611: $rhash{$server}=$reply;
5612: }
5613: else {
5614: my $reply=&reply("querysend:".&escape($query).':'.
5615: &escape($custom).':'.&escape($customshow),
5616: $server);
5617: $rhash{$server}=$reply;
5618: }
5619: }
5620: return \%rhash;
5621: }
5622:
5623: # ----------------------------------------- Send log queries and wait for reply
5624:
5625: sub log_query {
5626: my ($uname,$udom,$query,%filters)=@_;
5627: my $uhome=&homeserver($uname,$udom);
5628: if ($uhome eq 'no_host') { return 'error: no_host'; }
5629: my $uhost=&hostname($uhome);
5630: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
5631: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5632: $uhome);
5633: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
5634: return get_query_reply($queryid);
5635: }
5636:
5637: # -------------------------- Update MySQL table for portfolio file
5638:
5639: sub update_portfolio_table {
5640: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
5641: if ($group ne '') {
5642: $file_name =~s /^\Q$group\E//;
5643: }
5644: my $homeserver = &homeserver($uname,$udom);
5645: my $queryid=
5646: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5647: ':'.&escape($file_name).':'.$action,$homeserver);
5648: my $reply = &get_query_reply($queryid);
5649: return $reply;
5650: }
5651:
5652: # -------------------------- Update MySQL allusers table
5653:
5654: sub update_allusers_table {
5655: my ($uname,$udom,$names) = @_;
5656: my $homeserver = &homeserver($uname,$udom);
5657: my $queryid=
5658: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5659: 'lastname='.&escape($names->{'lastname'}).'%%'.
5660: 'firstname='.&escape($names->{'firstname'}).'%%'.
5661: 'middlename='.&escape($names->{'middlename'}).'%%'.
5662: 'generation='.&escape($names->{'generation'}).'%%'.
5663: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5664: 'id='.&escape($names->{'id'}),$homeserver);
5665: my $reply = &get_query_reply($queryid);
5666: return $reply;
5667: }
5668:
5669: # ------- Request retrieval of institutional classlists for course(s)
5670:
5671: sub fetch_enrollment_query {
5672: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
5673: my $homeserver;
5674: my $maxtries = 1;
5675: if ($context eq 'automated') {
5676: $homeserver = $perlvar{'lonHostID'};
5677: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
5678: } else {
5679: $homeserver = &homeserver($cnum,$dom);
5680: }
5681: my $host=&hostname($homeserver);
5682: my $cmd = '';
5683: foreach my $affiliate (keys(%{$affiliatesref})) {
5684: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5685: }
5686: $cmd =~ s/%%$//;
5687: $cmd = &escape($cmd);
5688: my $query = 'fetchenrollment';
5689: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
5690: unless ($queryid=~/^\Q$host\E\_/) {
5691: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5692: return 'error: '.$queryid;
5693: }
5694: my $reply = &get_query_reply($queryid);
5695: my $tries = 1;
5696: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5697: $reply = &get_query_reply($queryid);
5698: $tries ++;
5699: }
5700: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5701: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5702: } else {
5703: my @responses = split(/:/,$reply);
5704: if ($homeserver eq $perlvar{'lonHostID'}) {
5705: foreach my $line (@responses) {
5706: my ($key,$value) = split(/=/,$line,2);
5707: $$replyref{$key} = $value;
5708: }
5709: } else {
5710: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
5711: foreach my $line (@responses) {
5712: my ($key,$value) = split(/=/,$line);
5713: $$replyref{$key} = $value;
5714: if ($value > 0) {
5715: foreach my $item (@{$$affiliatesref{$key}}) {
5716: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
5717: my $destname = $pathname.'/'.$filename;
5718: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
5719: if ($xml_classlist =~ /^error/) {
5720: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5721: } else {
5722: if ( open(FILE,">$destname") ) {
5723: print FILE &unescape($xml_classlist);
5724: close(FILE);
5725: } else {
5726: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
5727: }
5728: }
5729: }
5730: }
5731: }
5732: }
5733: return 'ok';
5734: }
5735: return 'error';
5736: }
5737:
5738: sub get_query_reply {
5739: my $queryid=shift;
5740: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5741: my $reply='';
5742: for (1..100) {
5743: sleep 2;
5744: if (-e $replyfile.'.end') {
5745: if (open(my $fh,$replyfile)) {
5746: $reply = join('',<$fh>);
5747: close($fh);
5748: } else { return 'error: reply_file_error'; }
5749: return &unescape($reply);
5750: }
5751: }
5752: return 'timeout:'.$queryid;
5753: }
5754:
5755: sub courselog_query {
5756: #
5757: # possible filters:
5758: # url: url or symb
5759: # username
5760: # domain
5761: # action: view, submit, grade
5762: # start: timestamp
5763: # end: timestamp
5764: #
5765: my (%filters)=@_;
5766: unless ($env{'request.course.id'}) { return 'no_course'; }
5767: if ($filters{'url'}) {
5768: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5769: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5770: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5771: }
5772: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5773: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
5774: return &log_query($cname,$cdom,'courselog',%filters);
5775: }
5776:
5777: sub userlog_query {
5778: #
5779: # possible filters:
5780: # action: log check role
5781: # start: timestamp
5782: # end: timestamp
5783: #
5784: my ($uname,$udom,%filters)=@_;
5785: return &log_query($uname,$udom,'userlog',%filters);
5786: }
5787:
5788: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5789:
5790: sub auto_run {
5791: my ($cnum,$cdom) = @_;
5792: my $response = 0;
5793: my $settings;
5794: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5795: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5796: $settings = $domconfig{'autoenroll'};
5797: if ($settings->{'run'} eq '1') {
5798: $response = 1;
5799: }
5800: } else {
5801: my $homeserver;
5802: if (&is_course($cdom,$cnum)) {
5803: $homeserver = &homeserver($cnum,$cdom);
5804: } else {
5805: $homeserver = &domain($cdom,'primary');
5806: }
5807: if ($homeserver ne 'no_host') {
5808: $response = &reply('autorun:'.$cdom,$homeserver);
5809: }
5810: }
5811: return $response;
5812: }
5813:
5814: sub auto_get_sections {
5815: my ($cnum,$cdom,$inst_coursecode) = @_;
5816: my $homeserver;
5817: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5818: $homeserver = &homeserver($cnum,$cdom);
5819: }
5820: if (!defined($homeserver)) {
5821: if ($cdom =~ /^$match_domain$/) {
5822: $homeserver = &domain($cdom,'primary');
5823: }
5824: }
5825: my @secs;
5826: if (defined($homeserver)) {
5827: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5828: unless ($response eq 'refused') {
5829: @secs = split(/:/,$response);
5830: }
5831: }
5832: return @secs;
5833: }
5834:
5835: sub auto_new_course {
5836: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5837: my $homeserver = &homeserver($cnum,$cdom);
5838: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
5839: return $response;
5840: }
5841:
5842: sub auto_validate_courseID {
5843: my ($cnum,$cdom,$inst_course_id) = @_;
5844: my $homeserver = &homeserver($cnum,$cdom);
5845: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5846: return $response;
5847: }
5848:
5849: sub auto_validate_instcode {
5850: my ($cnum,$cdom,$instcode,$owner) = @_;
5851: my ($homeserver,$response);
5852: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5853: $homeserver = &homeserver($cnum,$cdom);
5854: }
5855: if (!defined($homeserver)) {
5856: if ($cdom =~ /^$match_domain$/) {
5857: $homeserver = &domain($cdom,'primary');
5858: }
5859: }
5860: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
5861: &escape($instcode).':'.&escape($owner),$homeserver));
5862: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5863: return ($outcome,$description);
5864: }
5865:
5866: sub auto_create_password {
5867: my ($cnum,$cdom,$authparam,$udom) = @_;
5868: my ($homeserver,$response);
5869: my $create_passwd = 0;
5870: my $authchk = '';
5871: if ($udom =~ /^$match_domain$/) {
5872: $homeserver = &domain($udom,'primary');
5873: }
5874: if ($homeserver eq '') {
5875: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5876: $homeserver = &homeserver($cnum,$cdom);
5877: }
5878: }
5879: if ($homeserver eq '') {
5880: $authchk = 'nodomain';
5881: } else {
5882: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5883: if ($response eq 'refused') {
5884: $authchk = 'refused';
5885: } else {
5886: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5887: }
5888: }
5889: return ($authparam,$create_passwd,$authchk);
5890: }
5891:
5892: sub auto_photo_permission {
5893: my ($cnum,$cdom,$students) = @_;
5894: my $homeserver = &homeserver($cnum,$cdom);
5895: my ($outcome,$perm_reqd,$conditions) =
5896: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5897: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5898: return (undef,undef);
5899: }
5900: return ($outcome,$perm_reqd,$conditions);
5901: }
5902:
5903: sub auto_checkphotos {
5904: my ($uname,$udom,$pid) = @_;
5905: my $homeserver = &homeserver($uname,$udom);
5906: my ($result,$resulttype);
5907: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5908: &escape($uname).':'.&escape($pid),
5909: $homeserver));
5910: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5911: return (undef,undef);
5912: }
5913: if ($outcome) {
5914: ($result,$resulttype) = split(/:/,$outcome);
5915: }
5916: return ($result,$resulttype);
5917: }
5918:
5919: sub auto_photochoice {
5920: my ($cnum,$cdom) = @_;
5921: my $homeserver = &homeserver($cnum,$cdom);
5922: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5923: &escape($cdom),
5924: $homeserver)));
5925: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5926: return (undef,undef);
5927: }
5928: return ($update,$comment);
5929: }
5930:
5931: sub auto_photoupdate {
5932: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5933: my $homeserver = &homeserver($cnum,$dom);
5934: my $host=&hostname($homeserver);
5935: my $cmd = '';
5936: my $maxtries = 1;
5937: foreach my $affiliate (keys(%{$affiliatesref})) {
5938: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5939: }
5940: $cmd =~ s/%%$//;
5941: $cmd = &escape($cmd);
5942: my $query = 'institutionalphotos';
5943: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5944: unless ($queryid=~/^\Q$host\E\_/) {
5945: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5946: return 'error: '.$queryid;
5947: }
5948: my $reply = &get_query_reply($queryid);
5949: my $tries = 1;
5950: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5951: $reply = &get_query_reply($queryid);
5952: $tries ++;
5953: }
5954: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5955: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5956: } else {
5957: my @responses = split(/:/,$reply);
5958: my $outcome = shift(@responses);
5959: foreach my $item (@responses) {
5960: my ($key,$value) = split(/=/,$item);
5961: $$photo{$key} = $value;
5962: }
5963: return $outcome;
5964: }
5965: return 'error';
5966: }
5967:
5968: sub auto_instcode_format {
5969: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5970: $cat_order) = @_;
5971: my $courses = '';
5972: my @homeservers;
5973: if ($caller eq 'global') {
5974: my %servers = &get_servers($codedom,'library');
5975: foreach my $tryserver (keys(%servers)) {
5976: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5977: push(@homeservers,$tryserver);
5978: }
5979: }
5980: } elsif ($caller eq 'requests') {
5981: if ($codedom =~ /^$match_domain$/) {
5982: my $chome = &domain($codedom,'primary');
5983: unless ($chome eq 'no_host') {
5984: push(@homeservers,$chome);
5985: }
5986: }
5987: } else {
5988: push(@homeservers,&homeserver($caller,$codedom));
5989: }
5990: foreach my $code (keys(%{$instcodes})) {
5991: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
5992: }
5993: chop($courses);
5994: my $ok_response = 0;
5995: my $response;
5996: while (@homeservers > 0 && $ok_response == 0) {
5997: my $server = shift(@homeservers);
5998: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5999: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
6000: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
6001: split(/:/,$response);
6002: %{$codes} = (%{$codes},&str2hash($codes_str));
6003: push(@{$codetitles},&str2array($codetitles_str));
6004: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
6005: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
6006: $ok_response = 1;
6007: }
6008: }
6009: if ($ok_response) {
6010: return 'ok';
6011: } else {
6012: return $response;
6013: }
6014: }
6015:
6016: sub auto_instcode_defaults {
6017: my ($domain,$returnhash,$code_order) = @_;
6018: my @homeservers;
6019:
6020: my %servers = &get_servers($domain,'library');
6021: foreach my $tryserver (keys(%servers)) {
6022: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6023: push(@homeservers,$tryserver);
6024: }
6025: }
6026:
6027: my $response;
6028: foreach my $server (@homeservers) {
6029: $response=&reply('autoinstcodedefaults:'.$domain,$server);
6030: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6031:
6032: foreach my $pair (split(/\&/,$response)) {
6033: my ($name,$value)=split(/\=/,$pair);
6034: if ($name eq 'code_order') {
6035: @{$code_order} = split(/\&/,&unescape($value));
6036: } else {
6037: $returnhash->{&unescape($name)}=&unescape($value);
6038: }
6039: }
6040: return 'ok';
6041: }
6042:
6043: return $response;
6044: }
6045:
6046: sub auto_possible_instcodes {
6047: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
6048: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
6049: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
6050: return;
6051: }
6052: my (@homeservers,$uhome);
6053: if (defined(&domain($domain,'primary'))) {
6054: $uhome=&domain($domain,'primary');
6055: push(@homeservers,&domain($domain,'primary'));
6056: } else {
6057: my %servers = &get_servers($domain,'library');
6058: foreach my $tryserver (keys(%servers)) {
6059: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6060: push(@homeservers,$tryserver);
6061: }
6062: }
6063: }
6064: my $response;
6065: foreach my $server (@homeservers) {
6066: $response=&reply('autopossibleinstcodes:'.$domain,$server);
6067: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6068: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
6069: split(':',$response);
6070: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
6071: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
6072: foreach my $item (split('&',$cat_title)) {
6073: my ($name,$value)=split('=',$item);
6074: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
6075: }
6076: foreach my $item (split('&',$cat_order)) {
6077: my ($name,$value)=split('=',$item);
6078: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
6079: }
6080: return 'ok';
6081: }
6082: return $response;
6083: }
6084:
6085: sub auto_courserequest_checks {
6086: my ($dom) = @_;
6087: my ($homeserver,%validations);
6088: if ($dom =~ /^$match_domain$/) {
6089: $homeserver = &domain($dom,'primary');
6090: }
6091: unless ($homeserver eq 'no_host') {
6092: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6093: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6094: my @items = split(/&/,$response);
6095: foreach my $item (@items) {
6096: my ($key,$value) = split('=',$item);
6097: $validations{&unescape($key)} = &thaw_unescape($value);
6098: }
6099: }
6100: }
6101: return %validations;
6102: }
6103:
6104: sub auto_courserequest_validation {
6105: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6106: my ($homeserver,$response);
6107: if ($dom =~ /^$match_domain$/) {
6108: $homeserver = &domain($dom,'primary');
6109: }
6110: unless ($homeserver eq 'no_host') {
6111:
6112: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
6113: ':'.&escape($crstype).':'.&escape($inststatuslist).
6114: ':'.&escape($instcode).':'.&escape($instseclist),
6115: $homeserver));
6116: }
6117: return $response;
6118: }
6119:
6120: sub auto_validate_class_sec {
6121: my ($cdom,$cnum,$owners,$inst_class) = @_;
6122: my $homeserver = &homeserver($cnum,$cdom);
6123: my $ownerlist;
6124: if (ref($owners) eq 'ARRAY') {
6125: $ownerlist = join(',',@{$owners});
6126: } else {
6127: $ownerlist = $owners;
6128: }
6129: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
6130: &escape($ownerlist).':'.$cdom,$homeserver);
6131: return $response;
6132: }
6133:
6134: # ------------------------------------------------------- Course Group routines
6135:
6136: sub get_coursegroups {
6137: my ($cdom,$cnum,$group,$namespace) = @_;
6138: return(&dump($namespace,$cdom,$cnum,$group));
6139: }
6140:
6141: sub modify_coursegroup {
6142: my ($cdom,$cnum,$groupsettings) = @_;
6143: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6144: }
6145:
6146: sub toggle_coursegroup_status {
6147: my ($cdom,$cnum,$group,$action) = @_;
6148: my ($from_namespace,$to_namespace);
6149: if ($action eq 'delete') {
6150: $from_namespace = 'coursegroups';
6151: $to_namespace = 'deleted_groups';
6152: } else {
6153: $from_namespace = 'deleted_groups';
6154: $to_namespace = 'coursegroups';
6155: }
6156: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
6157: if (my $tmp = &error(%curr_group)) {
6158: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6159: return ('read error',$tmp);
6160: } else {
6161: my %savedsettings = %curr_group;
6162: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
6163: my $deloutcome;
6164: if ($result eq 'ok') {
6165: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
6166: } else {
6167: return ('write error',$result);
6168: }
6169: if ($deloutcome eq 'ok') {
6170: return 'ok';
6171: } else {
6172: return ('delete error',$deloutcome);
6173: }
6174: }
6175: }
6176:
6177: sub modify_group_roles {
6178: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
6179: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6180: my $role = 'gr/'.&escape($userprivs);
6181: my ($uname,$udom) = split(/:/,$user);
6182: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
6183: if ($result eq 'ok') {
6184: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6185: }
6186: return $result;
6187: }
6188:
6189: sub modify_coursegroup_membership {
6190: my ($cdom,$cnum,$membership) = @_;
6191: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6192: return $result;
6193: }
6194:
6195: sub get_active_groups {
6196: my ($udom,$uname,$cdom,$cnum) = @_;
6197: my $now = time;
6198: my %groups = ();
6199: foreach my $key (keys(%env)) {
6200: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
6201: my ($start,$end) = split(/\./,$env{$key});
6202: if (($end!=0) && ($end<$now)) { next; }
6203: if (($start!=0) && ($start>$now)) { next; }
6204: if ($1 eq $cdom && $2 eq $cnum) {
6205: $groups{$3} = $env{$key} ;
6206: }
6207: }
6208: }
6209: return %groups;
6210: }
6211:
6212: sub get_group_membership {
6213: my ($cdom,$cnum,$group) = @_;
6214: return(&dump('groupmembership',$cdom,$cnum,$group));
6215: }
6216:
6217: sub get_users_groups {
6218: my ($udom,$uname,$courseid) = @_;
6219: my @usersgroups;
6220: my $cachetime=1800;
6221:
6222: my $hashid="$udom:$uname:$courseid";
6223: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6224: if (defined($cached)) {
6225: @usersgroups = split(/:/,$grouplist);
6226: } else {
6227: $grouplist = '';
6228: my $courseurl = &courseid_to_courseurl($courseid);
6229: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
6230: my $access_end = $env{'course.'.$courseid.
6231: '.default_enrollment_end_date'};
6232: my $now = time;
6233: foreach my $key (keys(%roleshash)) {
6234: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6235: my $group = $1;
6236: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6237: my $start = $2;
6238: my $end = $1;
6239: if ($start == -1) { next; } # deleted from group
6240: if (($start!=0) && ($start>$now)) { next; }
6241: if (($end!=0) && ($end<$now)) {
6242: if ($access_end && $access_end < $now) {
6243: if ($access_end - $end < 86400) {
6244: push(@usersgroups,$group);
6245: }
6246: }
6247: next;
6248: }
6249: push(@usersgroups,$group);
6250: }
6251: }
6252: }
6253: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6254: $grouplist = join(':',@usersgroups);
6255: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
6256: }
6257: return @usersgroups;
6258: }
6259:
6260: sub devalidate_getgroups_cache {
6261: my ($udom,$uname,$cdom,$cnum)=@_;
6262: my $courseid = $cdom.'_'.$cnum;
6263:
6264: my $hashid="$udom:$uname:$courseid";
6265: &devalidate_cache_new('getgroups',$hashid);
6266: }
6267:
6268: # ------------------------------------------------------------------ Plain Text
6269:
6270: sub plaintext {
6271: my ($short,$type,$cid,$forcedefault) = @_;
6272: if ($short =~ m{^cr/}) {
6273: return (split('/',$short))[-1];
6274: }
6275: if (!defined($cid)) {
6276: $cid = $env{'request.course.id'};
6277: }
6278: my %rolenames = (
6279: Course => 'std',
6280: Community => 'alt1',
6281: );
6282: if ($cid ne '') {
6283: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6284: unless ($forcedefault) {
6285: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6286: &Apache::lonlocal::mt_escape(\$roletext);
6287: return &Apache::lonlocal::mt($roletext);
6288: }
6289: }
6290: }
6291: if ((defined($type)) && (defined($rolenames{$type})) &&
6292: (defined($rolenames{$type})) &&
6293: (defined($prp{$short}{$rolenames{$type}}))) {
6294: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
6295: } elsif ($cid ne '') {
6296: my $crstype = $env{'course.'.$cid.'.type'};
6297: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6298: (defined($prp{$short}{$rolenames{$crstype}}))) {
6299: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6300: }
6301: }
6302: return &Apache::lonlocal::mt($prp{$short}{'std'});
6303: }
6304:
6305: # ----------------------------------------------------------------- Assign Role
6306:
6307: sub assignrole {
6308: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6309: $context)=@_;
6310: my $mrole;
6311: if ($role =~ /^cr\//) {
6312: my $cwosec=$url;
6313: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6314: unless (&allowed('ccr',$cwosec)) {
6315: my $refused = 1;
6316: if ($context eq 'requestcourses') {
6317: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6318: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6319: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6320: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6321: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6322: if ($crsenv{'internal.courseowner'} eq
6323: $env{'user.name'}.':'.$env{'user.domain'}) {
6324: $refused = '';
6325: }
6326: }
6327: }
6328: }
6329: }
6330: if ($refused) {
6331: &logthis('Refused custom assignrole: '.
6332: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6333: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6334: return 'refused';
6335: }
6336: }
6337: $mrole='cr';
6338: } elsif ($role =~ /^gr\//) {
6339: my $cwogrp=$url;
6340: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
6341: unless (&allowed('mdg',$cwogrp)) {
6342: &logthis('Refused group assignrole: '.
6343: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6344: $env{'user.name'}.' at '.$env{'user.domain'});
6345: return 'refused';
6346: }
6347: $mrole='gr';
6348: } else {
6349: my $cwosec=$url;
6350: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6351: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6352: my $refused;
6353: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6354: if (!(&allowed('c'.$role,$url))) {
6355: $refused = 1;
6356: }
6357: } else {
6358: $refused = 1;
6359: }
6360: if ($refused) {
6361: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6362: if (!$selfenroll && $context eq 'course') {
6363: my %crsenv;
6364: if ($role eq 'cc' || $role eq 'co') {
6365: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6366: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6367: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6368: if ($crsenv{'internal.courseowner'} eq
6369: $env{'user.name'}.':'.$env{'user.domain'}) {
6370: $refused = '';
6371: }
6372: }
6373: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6374: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6375: if ($crsenv{'internal.courseowner'} eq
6376: $env{'user.name'}.':'.$env{'user.domain'}) {
6377: $refused = '';
6378: }
6379: }
6380: }
6381: }
6382: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6383: $refused = '';
6384: } elsif ($context eq 'requestcourses') {
6385: my @possroles = ('st','ta','ep','in','cc','co');
6386: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
6387: my $wrongcc;
6388: if ($cnum =~ /^$match_community$/) {
6389: $wrongcc = 1 if ($role eq 'cc');
6390: } else {
6391: $wrongcc = 1 if ($role eq 'co');
6392: }
6393: unless ($wrongcc) {
6394: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6395: if ($crsenv{'internal.courseowner'} eq
6396: $env{'user.name'}.':'.$env{'user.domain'}) {
6397: $refused = '';
6398: }
6399: }
6400: }
6401: }
6402: if ($refused) {
6403: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6404: ' '.$role.' '.$end.' '.$start.' by '.
6405: $env{'user.name'}.' at '.$env{'user.domain'});
6406: return 'refused';
6407: }
6408: }
6409: }
6410: $mrole=$role;
6411: }
6412: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6413: "$udom:$uname:$url".'_'."$mrole=$role";
6414: if ($end) { $command.='_'.$end; }
6415: if ($start) {
6416: if ($end) {
6417: $command.='_'.$start;
6418: } else {
6419: $command.='_0_'.$start;
6420: }
6421: }
6422: my $origstart = $start;
6423: my $origend = $end;
6424: my $delflag;
6425: # actually delete
6426: if ($deleteflag) {
6427: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
6428: # modify command to delete the role
6429: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
6430: "$udom:$uname:$url".'_'."$mrole";
6431: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
6432: # set start and finish to negative values for userrolelog
6433: $start=-1;
6434: $end=-1;
6435: $delflag = 1;
6436: }
6437: }
6438: # send command
6439: my $answer=&reply($command,&homeserver($uname,$udom));
6440: # log new user role if status is ok
6441: if ($answer eq 'ok') {
6442: &userrolelog($role,$uname,$udom,$url,$start,$end);
6443: # for course roles, perform group memberships changes triggered by role change.
6444: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
6445: unless ($role =~ /^gr/) {
6446: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
6447: $origstart,$selfenroll,$context);
6448: }
6449: if ($role eq 'cc') {
6450: &autoupdate_coowners($url,$end,$start,$uname,$udom);
6451: }
6452: }
6453: return $answer;
6454: }
6455:
6456: sub autoupdate_coowners {
6457: my ($url,$end,$start,$uname,$udom) = @_;
6458: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
6459: if (($cdom ne '') && ($cnum ne '')) {
6460: my $now = time;
6461: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
6462: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
6463: my %coursehash = &coursedescription($cdom.'_'.$cnum);
6464: my $instcode = $coursehash{'internal.coursecode'};
6465: if ($instcode ne '') {
6466: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
6467: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
6468: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
6469: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
6470: if ($result eq 'valid') {
6471: if ($coursehash{'internal.co-owners'}) {
6472: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6473: push(@newcoowners,$coowner);
6474: }
6475: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
6476: push(@newcoowners,$uname.':'.$udom);
6477: }
6478: @newcoowners = sort(@newcoowners);
6479: } else {
6480: push(@newcoowners,$uname.':'.$udom);
6481: }
6482: } else {
6483: if ($coursehash{'internal.co-owners'}) {
6484: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6485: unless ($coowner eq $uname.':'.$udom) {
6486: push(@newcoowners,$coowner);
6487: }
6488: }
6489: unless (@newcoowners > 0) {
6490: $delcoowners = 1;
6491: $coowners = '';
6492: }
6493: }
6494: }
6495: if (@newcoowners || $delcoowners) {
6496: &store_coowners($cdom,$cnum,$coursehash{'home'},
6497: $delcoowners,@newcoowners);
6498: }
6499: }
6500: }
6501: }
6502: }
6503: }
6504: }
6505:
6506: sub store_coowners {
6507: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
6508: my $cid = $cdom.'_'.$cnum;
6509: my ($coowners,$delresult,$putresult);
6510: if (@newcoowners) {
6511: $coowners = join(',',@newcoowners);
6512: my %coownershash = (
6513: 'internal.co-owners' => $coowners,
6514: );
6515: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
6516: if ($putresult eq 'ok') {
6517: if ($env{'course.'.$cid.'.num'} eq $cnum) {
6518: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
6519: }
6520: }
6521: }
6522: if ($delcoowners) {
6523: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
6524: if ($delresult eq 'ok') {
6525: if ($env{'course.'.$cid.'.internal.co-owners'}) {
6526: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
6527: }
6528: }
6529: }
6530: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
6531: my %crsinfo =
6532: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6533: if (ref($crsinfo{$cid}) eq 'HASH') {
6534: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
6535: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
6536: }
6537: }
6538: }
6539:
6540: # -------------------------------------------------- Modify user authentication
6541: # Overrides without validation
6542:
6543: sub modifyuserauth {
6544: my ($udom,$uname,$umode,$upass)=@_;
6545: my $uhome=&homeserver($uname,$udom);
6546: unless (&allowed('mau',$udom)) { return 'refused'; }
6547: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
6548: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6549: ' in domain '.$env{'request.role.domain'});
6550: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6551: &escape($upass),$uhome);
6552: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
6553: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6554: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6555: &log($udom,,$uname,$uhome,
6556: 'Authentication changed by '.$env{'user.domain'}.', '.
6557: $env{'user.name'}.', '.$umode.
6558: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6559: unless ($reply eq 'ok') {
6560: &logthis('Authentication mode error: '.$reply);
6561: return 'error: '.$reply;
6562: }
6563: return 'ok';
6564: }
6565:
6566: # --------------------------------------------------------------- Modify a user
6567:
6568: sub modifyuser {
6569: my ($udom, $uname, $uid,
6570: $umode, $upass, $first,
6571: $middle, $last, $gene,
6572: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
6573: $udom= &LONCAPA::clean_domain($udom);
6574: $uname=&LONCAPA::clean_username($uname);
6575: my $showcandelete = 'none';
6576: if (ref($candelete) eq 'ARRAY') {
6577: if (@{$candelete} > 0) {
6578: $showcandelete = join(', ',@{$candelete});
6579: }
6580: }
6581: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
6582: $umode.', '.$first.', '.$middle.', '.
6583: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
6584: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6585: ' desiredhome not specified').
6586: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6587: ' in domain '.$env{'request.role.domain'});
6588: my $uhome=&homeserver($uname,$udom,'true');
6589: # ----------------------------------------------------------------- Create User
6590: if (($uhome eq 'no_host') &&
6591: (($umode && $upass) || ($umode eq 'localauth'))) {
6592: my $unhome='';
6593: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
6594: $unhome = $desiredhome;
6595: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6596: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
6597: } else { # load balancing routine for determining $unhome
6598: my $loadm=10000000;
6599: my %servers = &get_servers($udom,'library');
6600: foreach my $tryserver (keys(%servers)) {
6601: my $answer=reply('load',$tryserver);
6602: if (($answer=~/\d+/) && ($answer<$loadm)) {
6603: $loadm=$answer;
6604: $unhome=$tryserver;
6605: }
6606: }
6607: }
6608: if (($unhome eq '') || ($unhome eq 'no_host')) {
6609: return 'error: unable to find a home server for '.$uname.
6610: ' in domain '.$udom;
6611: }
6612: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6613: &escape($upass),$unhome);
6614: unless ($reply eq 'ok') {
6615: return 'error: '.$reply;
6616: }
6617: $uhome=&homeserver($uname,$udom,'true');
6618: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
6619: return 'error: unable verify users home machine.';
6620: }
6621: } # End of creation of new user
6622: # ---------------------------------------------------------------------- Add ID
6623: if ($uid) {
6624: $uid=~tr/A-Z/a-z/;
6625: my %uidhash=&idrget($udom,$uname);
6626: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6627: && (!$forceid)) {
6628: unless ($uid eq $uidhash{$uname}) {
6629: return 'error: user id "'.$uid.'" does not match '.
6630: 'current user id "'.$uidhash{$uname}.'".';
6631: }
6632: } else {
6633: &idput($udom,($uname => $uid));
6634: }
6635: }
6636: # -------------------------------------------------------------- Add names, etc
6637: my @tmp=&get('environment',
6638: ['firstname','middlename','lastname','generation','id',
6639: 'permanentemail','inststatus'],
6640: $udom,$uname);
6641: my %names;
6642: if ($tmp[0] =~ m/^error:.*/) {
6643: %names=();
6644: } else {
6645: %names = @tmp;
6646: }
6647: #
6648: # If name, email and/or uid are blank (e.g., because an uploaded file
6649: # of users did not contain them), do not overwrite existing values
6650: # unless field is in $candelete array ref.
6651: #
6652: my @fields = ('firstname','middlename','lastname','generation',
6653: 'permanentemail','id');
6654: my %newvalues;
6655: if (ref($candelete) eq 'ARRAY') {
6656: foreach my $field (@fields) {
6657: if (grep(/^\Q$field\E$/,@{$candelete})) {
6658: if ($field eq 'firstname') {
6659: $names{$field} = $first;
6660: } elsif ($field eq 'middlename') {
6661: $names{$field} = $middle;
6662: } elsif ($field eq 'lastname') {
6663: $names{$field} = $last;
6664: } elsif ($field eq 'generation') {
6665: $names{$field} = $gene;
6666: } elsif ($field eq 'permanentemail') {
6667: $names{$field} = $email;
6668: } elsif ($field eq 'id') {
6669: $names{$field} = $uid;
6670: }
6671: }
6672: }
6673: }
6674:
6675: if ($first) { $names{'firstname'} = $first; }
6676: if (defined($middle)) { $names{'middlename'} = $middle; }
6677: if ($last) { $names{'lastname'} = $last; }
6678: if (defined($gene)) { $names{'generation'} = $gene; }
6679: if ($email) {
6680: $email=~s/[^\w\@\.\-\,]//gs;
6681: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
6682: }
6683: if ($uid) { $names{'id'} = $uid; }
6684: if (defined($inststatus)) {
6685: $names{'inststatus'} = '';
6686: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6687: if (ref($usertypes) eq 'HASH') {
6688: my @okstatuses;
6689: foreach my $item (split(/:/,$inststatus)) {
6690: if (defined($usertypes->{$item})) {
6691: push(@okstatuses,$item);
6692: }
6693: }
6694: if (@okstatuses) {
6695: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6696: }
6697: }
6698: }
6699: my $reply = &put('environment', \%names, $udom,$uname);
6700: if ($reply ne 'ok') { return 'error: '.$reply; }
6701: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
6702: &devalidate_cache_new('namescache',$uname.':'.$udom);
6703: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6704: $umode.', '.$first.', '.$middle.', '.
6705: $last.', '.$gene.', '.$email.', '.$inststatus;
6706: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6707: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6708: } else {
6709: $logmsg .= ' during self creation';
6710: }
6711: &logthis($logmsg);
6712: return 'ok';
6713: }
6714:
6715: # -------------------------------------------------------------- Modify student
6716:
6717: sub modifystudent {
6718: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
6719: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
6720: $selfenroll,$context,$inststatus)=@_;
6721: if (!$cid) {
6722: unless ($cid=$env{'request.course.id'}) {
6723: return 'not_in_class';
6724: }
6725: }
6726: # --------------------------------------------------------------- Make the user
6727: my $reply=&modifyuser
6728: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
6729: $desiredhome,$email,$inststatus);
6730: unless ($reply eq 'ok') { return $reply; }
6731: # This will cause &modify_student_enrollment to get the uid from the
6732: # students environment
6733: $uid = undef if (!$forceid);
6734: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
6735: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
6736: return $reply;
6737: }
6738:
6739: sub modify_student_enrollment {
6740: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
6741: my ($cdom,$cnum,$chome);
6742: if (!$cid) {
6743: unless ($cid=$env{'request.course.id'}) {
6744: return 'not_in_class';
6745: }
6746: $cdom=$env{'course.'.$cid.'.domain'};
6747: $cnum=$env{'course.'.$cid.'.num'};
6748: } else {
6749: ($cdom,$cnum)=split(/_/,$cid);
6750: }
6751: $chome=$env{'course.'.$cid.'.home'};
6752: if (!$chome) {
6753: $chome=&homeserver($cnum,$cdom);
6754: }
6755: if (!$chome) { return 'unknown_course'; }
6756: # Make sure the user exists
6757: my $uhome=&homeserver($uname,$udom);
6758: if (($uhome eq '') || ($uhome eq 'no_host')) {
6759: return 'error: no such user';
6760: }
6761: # Get student data if we were not given enough information
6762: if (!defined($first) || $first eq '' ||
6763: !defined($last) || $last eq '' ||
6764: !defined($uid) || $uid eq '' ||
6765: !defined($middle) || $middle eq '' ||
6766: !defined($gene) || $gene eq '') {
6767: # They did not supply us with enough data to enroll the student, so
6768: # we need to pick up more information.
6769: my %tmp = &get('environment',
6770: ['firstname','middlename','lastname', 'generation','id']
6771: ,$udom,$uname);
6772:
6773: #foreach my $key (keys(%tmp)) {
6774: # &logthis("key $key = ".$tmp{$key});
6775: #}
6776: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6777: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6778: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
6779: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
6780: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6781: }
6782: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
6783: my $reply=cput('classlist',
6784: {"$uname:$udom" =>
6785: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
6786: $cdom,$cnum);
6787: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6788: return 'error: '.$reply;
6789: } else {
6790: &devalidate_getsection_cache($udom,$uname,$cid);
6791: }
6792: # Add student role to user
6793: my $uurl='/'.$cid;
6794: $uurl=~s/\_/\//g;
6795: if ($usec) {
6796: $uurl.='/'.$usec;
6797: }
6798: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
6799: }
6800:
6801: sub format_name {
6802: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6803: my $name;
6804: if ($first ne 'lastname') {
6805: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6806: } else {
6807: if ($lastname=~/\S/) {
6808: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6809: $name=~s/\s+,/,/;
6810: } else {
6811: $name.= $firstname.' '.$middlename.' '.$generation;
6812: }
6813: }
6814: $name=~s/^\s+//;
6815: $name=~s/\s+$//;
6816: $name=~s/\s+/ /g;
6817: return $name;
6818: }
6819:
6820: # ------------------------------------------------- Write to course preferences
6821:
6822: sub writecoursepref {
6823: my ($courseid,%prefs)=@_;
6824: $courseid=~s/^\///;
6825: $courseid=~s/\_/\//g;
6826: my ($cdomain,$cnum)=split(/\//,$courseid);
6827: my $chome=homeserver($cnum,$cdomain);
6828: if (($chome eq '') || ($chome eq 'no_host')) {
6829: return 'error: no such course';
6830: }
6831: my $cstring='';
6832: foreach my $pref (keys(%prefs)) {
6833: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
6834: }
6835: $cstring=~s/\&$//;
6836: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6837: }
6838:
6839: # ---------------------------------------------------------- Make/modify course
6840:
6841: sub createcourse {
6842: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6843: $course_owner,$crstype,$cnum,$context,$category)=@_;
6844: $url=&declutter($url);
6845: my $cid='';
6846: if ($context eq 'requestcourses') {
6847: my $can_create = 0;
6848: my ($ownername,$ownerdom) = split(':',$course_owner);
6849: if ($udom eq $ownerdom) {
6850: if (&usertools_access($ownername,$ownerdom,$category,undef,
6851: $context)) {
6852: $can_create = 1;
6853: }
6854: } else {
6855: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6856: $category);
6857: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6858: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6859: if (@curr > 0) {
6860: my @options = qw(approval validate autolimit);
6861: my $optregex = join('|',@options);
6862: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6863: $can_create = 1;
6864: }
6865: }
6866: }
6867: }
6868: if ($can_create) {
6869: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6870: unless (&allowed('ccc',$udom)) {
6871: return 'refused';
6872: }
6873: }
6874: } else {
6875: return 'refused';
6876: }
6877: } elsif (!&allowed('ccc',$udom)) {
6878: return 'refused';
6879: }
6880: # --------------------------------------------------------------- Get Unique ID
6881: my $uname;
6882: if ($cnum =~ /^$match_courseid$/) {
6883: my $chome=&homeserver($cnum,$udom,'true');
6884: if (($chome eq '') || ($chome eq 'no_host')) {
6885: $uname = $cnum;
6886: } else {
6887: $uname = &generate_coursenum($udom,$crstype);
6888: }
6889: } else {
6890: $uname = &generate_coursenum($udom,$crstype);
6891: }
6892: return $uname if ($uname =~ /^error/);
6893: # -------------------------------------------------- Check supplied server name
6894: if (!defined($course_server)) {
6895: if (defined(&domain($udom,'primary'))) {
6896: $course_server = &domain($udom,'primary');
6897: } else {
6898: $course_server = $env{'user.home'};
6899: }
6900: }
6901: my %host_servers =
6902: &Apache::lonnet::get_servers($udom,'library');
6903: unless ($host_servers{$course_server}) {
6904: return 'error: invalid home server for course: '.$course_server;
6905: }
6906: # ------------------------------------------------------------- Make the course
6907: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
6908: $course_server);
6909: unless ($reply eq 'ok') { return 'error: '.$reply; }
6910: my $uhome=&homeserver($uname,$udom,'true');
6911: if (($uhome eq '') || ($uhome eq 'no_host')) {
6912: return 'error: no such course';
6913: }
6914: # ----------------------------------------------------------------- Course made
6915: # log existence
6916: my $now = time;
6917: my $newcourse = {
6918: $udom.'_'.$uname => {
6919: description => $description,
6920: inst_code => $inst_code,
6921: owner => $course_owner,
6922: type => $crstype,
6923: creator => $env{'user.name'}.':'.
6924: $env{'user.domain'},
6925: created => $now,
6926: context => $context,
6927: },
6928: };
6929: &courseidput($udom,$newcourse,$uhome,'notime');
6930: # set toplevel url
6931: my $topurl=$url;
6932: unless ($nonstandard) {
6933: # ------------------------------------------ For standard courses, make top url
6934: my $mapurl=&clutter($url);
6935: if ($mapurl eq '/res/') { $mapurl=''; }
6936: $env{'form.initmap'}=(<<ENDINITMAP);
6937: <map>
6938: <resource id="1" type="start"></resource>
6939: <resource id="2" src="$mapurl"></resource>
6940: <resource id="3" type="finish"></resource>
6941: <link index="1" from="1" to="2"></link>
6942: <link index="2" from="2" to="3"></link>
6943: </map>
6944: ENDINITMAP
6945: $topurl=&declutter(
6946: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
6947: );
6948: }
6949: # ----------------------------------------------------------- Write preferences
6950: &writecoursepref($udom.'_'.$uname,
6951: ('description' => $description,
6952: 'url' => $topurl,
6953: 'internal.creator' => $env{'user.name'}.':'.
6954: $env{'user.domain'},
6955: 'internal.created' => $now,
6956: 'internal.creationcontext' => $context)
6957: );
6958: return '/'.$udom.'/'.$uname;
6959: }
6960:
6961: # ------------------------------------------------------------------- Create ID
6962: sub generate_coursenum {
6963: my ($udom,$crstype) = @_;
6964: my $domdesc = &domain($udom);
6965: return 'error: invalid domain' if ($domdesc eq '');
6966: my $first;
6967: if ($crstype eq 'Community') {
6968: $first = '0';
6969: } else {
6970: $first = int(1+rand(9));
6971: }
6972: my $uname=$first.
6973: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6974: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6975: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6976: # ----------------------------------------------- Make sure that does not exist
6977: my $uhome=&homeserver($uname,$udom,'true');
6978: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6979: if ($crstype eq 'Community') {
6980: $first = '0';
6981: } else {
6982: $first = int(1+rand(9));
6983: }
6984: $uname=$first.
6985: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6986: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6987: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6988: $uhome=&homeserver($uname,$udom,'true');
6989: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6990: return 'error: unable to generate unique course-ID';
6991: }
6992: }
6993: return $uname;
6994: }
6995:
6996: sub is_course {
6997: my ($cdom,$cnum) = @_;
6998: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
6999: undef,'.');
7000: if (exists($courses{$cdom.'_'.$cnum})) {
7001: return 1;
7002: }
7003: return 0;
7004: }
7005:
7006: sub store_userdata {
7007: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
7008: my $result;
7009: if ($datakey ne '') {
7010: if (ref($storehash) eq 'HASH') {
7011: if ($udom eq '' || $uname eq '') {
7012: $udom = $env{'user.domain'};
7013: $uname = $env{'user.name'};
7014: }
7015: my $uhome=&homeserver($uname,$udom);
7016: if (($uhome eq '') || ($uhome eq 'no_host')) {
7017: $result = 'error: no_host';
7018: } else {
7019: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
7020: $storehash->{'host'} = $perlvar{'lonHostID'};
7021:
7022: my $namevalue='';
7023: foreach my $key (keys(%{$storehash})) {
7024: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7025: }
7026: $namevalue=~s/\&$//;
7027: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
7028: "$namespace:$datakey:$namevalue",$uhome);
7029: }
7030: } else {
7031: $result = 'error: data to store was not a hash reference';
7032: }
7033: } else {
7034: $result= 'error: invalid requestkey';
7035: }
7036: return $result;
7037: }
7038:
7039: # ---------------------------------------------------------- Assign Custom Role
7040:
7041: sub assigncustomrole {
7042: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
7043: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
7044: $end,$start,$deleteflag,$selfenroll,$context);
7045: }
7046:
7047: # ----------------------------------------------------------------- Revoke Role
7048:
7049: sub revokerole {
7050: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
7051: my $now=time;
7052: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
7053: }
7054:
7055: # ---------------------------------------------------------- Revoke Custom Role
7056:
7057: sub revokecustomrole {
7058: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
7059: my $now=time;
7060: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
7061: $deleteflag,$selfenroll,$context);
7062: }
7063:
7064: # ------------------------------------------------------------ Disk usage
7065: sub diskusage {
7066: my ($udom,$uname,$directorypath,$getpropath)=@_;
7067: $directorypath =~ s/\/$//;
7068: my $listing=&reply('du2:'.&escape($directorypath).':'
7069: .&escape($getpropath).':'.&escape($uname).':'
7070: .&escape($udom),homeserver($uname,$udom));
7071: if ($listing eq 'unknown_cmd') {
7072: if ($getpropath) {
7073: $directorypath = &propath($udom,$uname).'/'.$directorypath;
7074: }
7075: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
7076: }
7077: return $listing;
7078: }
7079:
7080: sub is_locked {
7081: my ($file_name, $domain, $user) = @_;
7082: my @check;
7083: my $is_locked;
7084: push @check, $file_name;
7085: my %locked = &get('file_permissions',\@check,
7086: $env{'user.domain'},$env{'user.name'});
7087: my ($tmp)=keys(%locked);
7088: if ($tmp=~/^error:/) { undef(%locked); }
7089:
7090: if (ref($locked{$file_name}) eq 'ARRAY') {
7091: $is_locked = 'false';
7092: foreach my $entry (@{$locked{$file_name}}) {
7093: if (ref($entry) eq 'ARRAY') {
7094: $is_locked = 'true';
7095: last;
7096: }
7097: }
7098: } else {
7099: $is_locked = 'false';
7100: }
7101: }
7102:
7103: sub declutter_portfile {
7104: my ($file) = @_;
7105: $file =~ s{^(/portfolio/|portfolio/)}{/};
7106: return $file;
7107: }
7108:
7109: # ------------------------------------------------------------- Mark as Read Only
7110:
7111: sub mark_as_readonly {
7112: my ($domain,$user,$files,$what) = @_;
7113: my %current_permissions = &dump('file_permissions',$domain,$user);
7114: my ($tmp)=keys(%current_permissions);
7115: if ($tmp=~/^error:/) { undef(%current_permissions); }
7116: foreach my $file (@{$files}) {
7117: $file = &declutter_portfile($file);
7118: push(@{$current_permissions{$file}},$what);
7119: }
7120: &put('file_permissions',\%current_permissions,$domain,$user);
7121: return;
7122: }
7123:
7124: # ------------------------------------------------------------Save Selected Files
7125:
7126: sub save_selected_files {
7127: my ($user, $path, @files) = @_;
7128: my $filename = $user."savedfiles";
7129: my @other_files = &files_not_in_path($user, $path);
7130: open (OUT, '>'.$tmpdir.$filename);
7131: foreach my $file (@files) {
7132: print (OUT $env{'form.currentpath'}.$file."\n");
7133: }
7134: foreach my $file (@other_files) {
7135: print (OUT $file."\n");
7136: }
7137: close (OUT);
7138: return 'ok';
7139: }
7140:
7141: sub clear_selected_files {
7142: my ($user) = @_;
7143: my $filename = $user."savedfiles";
7144: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7145: print (OUT undef);
7146: close (OUT);
7147: return ("ok");
7148: }
7149:
7150: sub files_in_path {
7151: my ($user, $path) = @_;
7152: my $filename = $user."savedfiles";
7153: my %return_files;
7154: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7155: while (my $line_in = <IN>) {
7156: chomp ($line_in);
7157: my @paths_and_file = split (m!/!, $line_in);
7158: my $file_part = pop (@paths_and_file);
7159: my $path_part = join ('/', @paths_and_file);
7160: $path_part.='/';
7161: my $path_and_file = $path_part.$file_part;
7162: if ($path_part eq $path) {
7163: $return_files{$file_part}= 'selected';
7164: }
7165: }
7166: close (IN);
7167: return (\%return_files);
7168: }
7169:
7170: # called in portfolio select mode, to show files selected NOT in current directory
7171: sub files_not_in_path {
7172: my ($user, $path) = @_;
7173: my $filename = $user."savedfiles";
7174: my @return_files;
7175: my $path_part;
7176: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7177: while (my $line = <IN>) {
7178: #ok, I know it's clunky, but I want it to work
7179: my @paths_and_file = split(m|/|, $line);
7180: my $file_part = pop(@paths_and_file);
7181: chomp($file_part);
7182: my $path_part = join('/', @paths_and_file);
7183: $path_part .= '/';
7184: my $path_and_file = $path_part.$file_part;
7185: if ($path_part ne $path) {
7186: push(@return_files, ($path_and_file));
7187: }
7188: }
7189: close(OUT);
7190: return (@return_files);
7191: }
7192:
7193: #----------------------------------------------Get portfolio file permissions
7194:
7195: sub get_portfile_permissions {
7196: my ($domain,$user) = @_;
7197: my %current_permissions = &dump('file_permissions',$domain,$user);
7198: my ($tmp)=keys(%current_permissions);
7199: if ($tmp=~/^error:/) { undef(%current_permissions); }
7200: return \%current_permissions;
7201: }
7202:
7203: #---------------------------------------------Get portfolio file access controls
7204:
7205: sub get_access_controls {
7206: my ($current_permissions,$group,$file) = @_;
7207: my %access;
7208: my $real_file = $file;
7209: $file =~ s/\.meta$//;
7210: if (defined($file)) {
7211: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7212: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
7213: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
7214: }
7215: }
7216: } else {
7217: foreach my $key (keys(%{$current_permissions})) {
7218: if ($key =~ /\0accesscontrol$/) {
7219: if (defined($group)) {
7220: if ($key !~ m-^\Q$group\E/-) {
7221: next;
7222: }
7223: }
7224: my ($fullpath) = split(/\0/,$key);
7225: if (ref($$current_permissions{$key}) eq 'HASH') {
7226: foreach my $control (keys(%{$$current_permissions{$key}})) {
7227: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7228: }
7229: }
7230: }
7231: }
7232: }
7233: return %access;
7234: }
7235:
7236: sub modify_access_controls {
7237: my ($file_name,$changes,$domain,$user)=@_;
7238: my ($outcome,$deloutcome);
7239: my %store_permissions;
7240: my %new_values;
7241: my %new_control;
7242: my %translation;
7243: my @deletions = ();
7244: my $now = time;
7245: if (exists($$changes{'activate'})) {
7246: if (ref($$changes{'activate'}) eq 'HASH') {
7247: my @newitems = sort(keys(%{$$changes{'activate'}}));
7248: my $numnew = scalar(@newitems);
7249: for (my $i=0; $i<$numnew; $i++) {
7250: my $newkey = $newitems[$i];
7251: my $newid = &Apache::loncommon::get_cgi_id();
7252: if ($newkey =~ /^\d+:/) {
7253: $newkey =~ s/^(\d+)/$newid/;
7254: $translation{$1} = $newid;
7255: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7256: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7257: $translation{$1} = $newid;
7258: }
7259: $new_values{$file_name."\0".$newkey} =
7260: $$changes{'activate'}{$newitems[$i]};
7261: $new_control{$newkey} = $now;
7262: }
7263: }
7264: }
7265: my %todelete;
7266: my %changed_items;
7267: foreach my $action ('delete','update') {
7268: if (exists($$changes{$action})) {
7269: if (ref($$changes{$action}) eq 'HASH') {
7270: foreach my $key (keys(%{$$changes{$action}})) {
7271: my ($itemnum) = ($key =~ /^([^:]+):/);
7272: if ($action eq 'delete') {
7273: $todelete{$itemnum} = 1;
7274: } else {
7275: $changed_items{$itemnum} = $key;
7276: }
7277: }
7278: }
7279: }
7280: }
7281: # get lock on access controls for file.
7282: my $lockhash = {
7283: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7284: ':'.$env{'user.domain'},
7285: };
7286: my $tries = 0;
7287: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7288:
7289: while (($gotlock ne 'ok') && $tries <3) {
7290: $tries ++;
7291: sleep 1;
7292: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7293: }
7294: if ($gotlock eq 'ok') {
7295: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7296: my ($tmp)=keys(%curr_permissions);
7297: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7298: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7299: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7300: if (ref($curr_controls) eq 'HASH') {
7301: foreach my $control_item (keys(%{$curr_controls})) {
7302: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7303: if (defined($todelete{$itemnum})) {
7304: push(@deletions,$file_name."\0".$control_item);
7305: } else {
7306: if (defined($changed_items{$itemnum})) {
7307: $new_control{$changed_items{$itemnum}} = $now;
7308: push(@deletions,$file_name."\0".$control_item);
7309: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7310: } else {
7311: $new_control{$control_item} = $$curr_controls{$control_item};
7312: }
7313: }
7314: }
7315: }
7316: }
7317: my ($group);
7318: if (&is_course($domain,$user)) {
7319: ($group,my $file) = split(/\//,$file_name,2);
7320: }
7321: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7322: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7323: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7324: # remove lock
7325: my @del_lock = ($file_name."\0".'locked_access_records');
7326: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
7327: my $sqlresult =
7328: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
7329: $group);
7330: } else {
7331: $outcome = "error: could not obtain lockfile\n";
7332: }
7333: return ($outcome,$deloutcome,\%new_values,\%translation);
7334: }
7335:
7336: sub make_public_indefinitely {
7337: my ($requrl) = @_;
7338: my $now = time;
7339: my $action = 'activate';
7340: my $aclnum = 0;
7341: if (&is_portfolio_url($requrl)) {
7342: my (undef,$udom,$unum,$file_name,$group) =
7343: &parse_portfolio_url($requrl);
7344: my $current_perms = &get_portfile_permissions($udom,$unum);
7345: my %access_controls = &get_access_controls($current_perms,
7346: $group,$file_name);
7347: foreach my $key (keys(%{$access_controls{$file_name}})) {
7348: my ($num,$scope,$end,$start) =
7349: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7350: if ($scope eq 'public') {
7351: if ($start <= $now && $end == 0) {
7352: $action = 'none';
7353: } else {
7354: $action = 'update';
7355: $aclnum = $num;
7356: }
7357: last;
7358: }
7359: }
7360: if ($action eq 'none') {
7361: return 'ok';
7362: } else {
7363: my %changes;
7364: my $newend = 0;
7365: my $newstart = $now;
7366: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7367: $changes{$action}{$newkey} = {
7368: type => 'public',
7369: time => {
7370: start => $newstart,
7371: end => $newend,
7372: },
7373: };
7374: my ($outcome,$deloutcome,$new_values,$translation) =
7375: &modify_access_controls($file_name,\%changes,$udom,$unum);
7376: return $outcome;
7377: }
7378: } else {
7379: return 'invalid';
7380: }
7381: }
7382:
7383: #------------------------------------------------------Get Marked as Read Only
7384:
7385: sub get_marked_as_readonly {
7386: my ($domain,$user,$what,$group) = @_;
7387: my $current_permissions = &get_portfile_permissions($domain,$user);
7388: my @readonly_files;
7389: my $cmp1=$what;
7390: if (ref($what)) { $cmp1=join('',@{$what}) };
7391: while (my ($file_name,$value) = each(%{$current_permissions})) {
7392: if (defined($group)) {
7393: if ($file_name !~ m-^\Q$group\E/-) {
7394: next;
7395: }
7396: }
7397: if (ref($value) eq "ARRAY"){
7398: foreach my $stored_what (@{$value}) {
7399: my $cmp2=$stored_what;
7400: if (ref($stored_what) eq 'ARRAY') {
7401: $cmp2=join('',@{$stored_what});
7402: }
7403: if ($cmp1 eq $cmp2) {
7404: push(@readonly_files, $file_name);
7405: last;
7406: } elsif (!defined($what)) {
7407: push(@readonly_files, $file_name);
7408: last;
7409: }
7410: }
7411: }
7412: }
7413: return @readonly_files;
7414: }
7415: #-----------------------------------------------------------Get Marked as Read Only Hash
7416:
7417: sub get_marked_as_readonly_hash {
7418: my ($current_permissions,$group,$what) = @_;
7419: my %readonly_files;
7420: while (my ($file_name,$value) = each(%{$current_permissions})) {
7421: if (defined($group)) {
7422: if ($file_name !~ m-^\Q$group\E/-) {
7423: next;
7424: }
7425: }
7426: if (ref($value) eq "ARRAY"){
7427: foreach my $stored_what (@{$value}) {
7428: if (ref($stored_what) eq 'ARRAY') {
7429: foreach my $lock_descriptor(@{$stored_what}) {
7430: if ($lock_descriptor eq 'graded') {
7431: $readonly_files{$file_name} = 'graded';
7432: } elsif ($lock_descriptor eq 'handback') {
7433: $readonly_files{$file_name} = 'handback';
7434: } else {
7435: if (!exists($readonly_files{$file_name})) {
7436: $readonly_files{$file_name} = 'locked';
7437: }
7438: }
7439: }
7440: }
7441: }
7442: }
7443: }
7444: return %readonly_files;
7445: }
7446: # ------------------------------------------------------------ Unmark as Read Only
7447:
7448: sub unmark_as_readonly {
7449: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7450: # for portfolio submissions, $what contains [$symb,$crsid]
7451: my ($domain,$user,$what,$file_name,$group) = @_;
7452: $file_name = &declutter_portfile($file_name);
7453: my $symb_crs = $what;
7454: if (ref($what)) { $symb_crs=join('',@$what); }
7455: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
7456: my ($tmp)=keys(%current_permissions);
7457: if ($tmp=~/^error:/) { undef(%current_permissions); }
7458: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
7459: foreach my $file (@readonly_files) {
7460: my $clean_file = &declutter_portfile($file);
7461: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
7462: my $current_locks = $current_permissions{$file};
7463: my @new_locks;
7464: my @del_keys;
7465: if (ref($current_locks) eq "ARRAY"){
7466: foreach my $locker (@{$current_locks}) {
7467: my $compare=$locker;
7468: if (ref($locker) eq 'ARRAY') {
7469: $compare=join('',@{$locker});
7470: if ($compare ne $symb_crs) {
7471: push(@new_locks, $locker);
7472: }
7473: }
7474: }
7475: if (scalar(@new_locks) > 0) {
7476: $current_permissions{$file} = \@new_locks;
7477: } else {
7478: push(@del_keys, $file);
7479: &del('file_permissions',\@del_keys, $domain, $user);
7480: delete($current_permissions{$file});
7481: }
7482: }
7483: }
7484: &put('file_permissions',\%current_permissions,$domain,$user);
7485: return;
7486: }
7487:
7488: # ------------------------------------------------------------ Directory lister
7489:
7490: sub dirlist {
7491: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
7492: $uri=~s/^\///;
7493: $uri=~s/\/$//;
7494: my ($udom, $uname);
7495: if ($getuserdir) {
7496: $udom = $userdomain;
7497: $uname = $username;
7498: } else {
7499: (undef,$udom,$uname)=split(/\//,$uri);
7500: if(defined($userdomain)) {
7501: $udom = $userdomain;
7502: }
7503: if(defined($username)) {
7504: $uname = $username;
7505: }
7506: }
7507: my ($dirRoot,$listing,@listing_results);
7508:
7509: $dirRoot = $perlvar{'lonDocRoot'};
7510: if (defined($getpropath)) {
7511: $dirRoot = &propath($udom,$uname);
7512: $dirRoot =~ s/\/$//;
7513: } elsif (defined($getuserdir)) {
7514: my $subdir=$uname.'__';
7515: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7516: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7517: ."/$udom/$subdir/$uname";
7518: } elsif (defined($alternateRoot)) {
7519: $dirRoot = $alternateRoot;
7520: }
7521:
7522: if($udom) {
7523: if($uname) {
7524: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
7525: .$getuserdir.':'.&escape($dirRoot)
7526: .':'.&escape($uname).':'.&escape($udom),
7527: &homeserver($uname,$udom));
7528: if ($listing eq 'unknown_cmd') {
7529: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7530: &homeserver($uname,$udom));
7531: } else {
7532: @listing_results = map { &unescape($_); } split(/:/,$listing);
7533: }
7534: if ($listing eq 'unknown_cmd') {
7535: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7536: &homeserver($uname,$udom));
7537: @listing_results = split(/:/,$listing);
7538: } else {
7539: @listing_results = map { &unescape($_); } split(/:/,$listing);
7540: }
7541: return @listing_results;
7542: } elsif(!$alternateRoot) {
7543: my %allusers;
7544: my %servers = &get_servers($udom,'library');
7545: foreach my $tryserver (keys(%servers)) {
7546: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7547: &escape($udom),$tryserver);
7548: if ($listing eq 'unknown_cmd') {
7549: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7550: $udom, $tryserver);
7551: } else {
7552: @listing_results = map { &unescape($_); } split(/:/,$listing);
7553: }
7554: if ($listing eq 'unknown_cmd') {
7555: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7556: $udom, $tryserver);
7557: @listing_results = split(/:/,$listing);
7558: } else {
7559: @listing_results =
7560: map { &unescape($_); } split(/:/,$listing);
7561: }
7562: if ($listing_results[0] ne 'no_such_dir' &&
7563: $listing_results[0] ne 'empty' &&
7564: $listing_results[0] ne 'con_lost') {
7565: foreach my $line (@listing_results) {
7566: my ($entry) = split(/&/,$line,2);
7567: $allusers{$entry} = 1;
7568: }
7569: }
7570: }
7571: my $alluserstr='';
7572: foreach my $user (sort(keys(%allusers))) {
7573: $alluserstr.=$user.'&user:';
7574: }
7575: $alluserstr=~s/:$//;
7576: return split(/:/,$alluserstr);
7577: } else {
7578: return ('missing user name');
7579: }
7580: } elsif(!defined($getpropath)) {
7581: my @all_domains = sort(&all_domains());
7582: foreach my $domain (@all_domains) {
7583: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7584: }
7585: return @all_domains;
7586: } else {
7587: return ('missing domain');
7588: }
7589: }
7590:
7591: # --------------------------------------------- GetFileTimestamp
7592: # This function utilizes dirlist and returns the date stamp for
7593: # when it was last modified. It will also return an error of -1
7594: # if an error occurs
7595:
7596: sub GetFileTimestamp {
7597: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
7598: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7599: $studentName = &LONCAPA::clean_username($studentName);
7600: my ($fileStat) =
7601: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7602: undef,$getuserdir);
7603: my @stats = split('&', $fileStat);
7604: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7605: # @stats contains first the filename, then the stat output
7606: return $stats[10]; # so this is 10 instead of 9.
7607: } else {
7608: return -1;
7609: }
7610: }
7611:
7612: sub stat_file {
7613: my ($uri) = @_;
7614: $uri = &clutter_with_no_wrapper($uri);
7615:
7616: my ($udom,$uname,$file);
7617: if ($uri =~ m-^/(uploaded|editupload)/-) {
7618: ($udom,$uname,$file) =
7619: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
7620: $file = 'userfiles/'.$file;
7621: }
7622: if ($uri =~ m-^/res/-) {
7623: ($udom,$uname) =
7624: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
7625: $file = $uri;
7626: }
7627:
7628: if (!$udom || !$uname || !$file) {
7629: # unable to handle the uri
7630: return ();
7631: }
7632: my $getpropath;
7633: if ($file =~ /^userfiles\//) {
7634: $getpropath = 1;
7635: }
7636: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
7637: my @stats = split('&', $result);
7638:
7639: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7640: shift(@stats); #filename is first
7641: return @stats;
7642: }
7643: return ();
7644: }
7645:
7646: # -------------------------------------------------------- Value of a Condition
7647:
7648: # gets the value of a specific preevaluated condition
7649: # stored in the string $env{user.state.<cid>}
7650: # or looks up a condition reference in the bighash and if if hasn't
7651: # already been evaluated recurses into docondval to get the value of
7652: # the condition, then memoizing it to
7653: # $env{user.state.<cid>.<condition>}
7654: sub directcondval {
7655: my $number=shift;
7656: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
7657: &Apache::lonuserstate::evalstate();
7658: }
7659: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7660: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7661: } elsif ($number =~ /^_/) {
7662: my $sub_condition;
7663: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7664: &GDBM_READER(),0640)) {
7665: $sub_condition=$bighash{'conditions'.$number};
7666: untie(%bighash);
7667: }
7668: my $value = &docondval($sub_condition);
7669: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
7670: return $value;
7671: }
7672: if ($env{'user.state.'.$env{'request.course.id'}}) {
7673: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
7674: } else {
7675: return 2;
7676: }
7677: }
7678:
7679: # get the collection of conditions for this resource
7680: sub condval {
7681: my $condidx=shift;
7682: my $allpathcond='';
7683: foreach my $cond (split(/\|/,$condidx)) {
7684: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7685: $allpathcond.=
7686: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7687: }
7688: }
7689: $allpathcond=~s/\|$//;
7690: return &docondval($allpathcond);
7691: }
7692:
7693: #evaluates an expression of conditions
7694: sub docondval {
7695: my ($allpathcond) = @_;
7696: my $result=0;
7697: if ($env{'request.course.id'}
7698: && defined($allpathcond)) {
7699: my $operand='|';
7700: my @stack;
7701: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7702: if ($chunk eq '(') {
7703: push @stack,($operand,$result);
7704: } elsif ($chunk eq ')') {
7705: my $before=pop @stack;
7706: if (pop @stack eq '&') {
7707: $result=$result>$before?$before:$result;
7708: } else {
7709: $result=$result>$before?$result:$before;
7710: }
7711: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7712: $operand=$chunk;
7713: } else {
7714: my $new=directcondval($chunk);
7715: if ($operand eq '&') {
7716: $result=$result>$new?$new:$result;
7717: } else {
7718: $result=$result>$new?$result:$new;
7719: }
7720: }
7721: }
7722: }
7723: return $result;
7724: }
7725:
7726: # ---------------------------------------------------- Devalidate courseresdata
7727:
7728: sub devalidatecourseresdata {
7729: my ($coursenum,$coursedomain)=@_;
7730: my $hashid=$coursenum.':'.$coursedomain;
7731: &devalidate_cache_new('courseres',$hashid);
7732: }
7733:
7734:
7735: # --------------------------------------------------- Course Resourcedata Query
7736: #
7737: # Parameters:
7738: # $coursenum - Number of the course.
7739: # $coursedomain - Domain at which the course was created.
7740: # Returns:
7741: # A hash of the course parameters along (I think) with timestamps
7742: # and version info.
7743:
7744: sub get_courseresdata {
7745: my ($coursenum,$coursedomain)=@_;
7746: my $coursehom=&homeserver($coursenum,$coursedomain);
7747: my $hashid=$coursenum.':'.$coursedomain;
7748: my ($result,$cached)=&is_cached_new('courseres',$hashid);
7749: my %dumpreply;
7750: unless (defined($cached)) {
7751: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
7752: $result=\%dumpreply;
7753: my ($tmp) = keys(%dumpreply);
7754: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7755: &do_cache_new('courseres',$hashid,$result,600);
7756: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7757: return $tmp;
7758: } elsif ($tmp =~ /^(error)/) {
7759: $result=undef;
7760: &do_cache_new('courseres',$hashid,$result,600);
7761: }
7762: }
7763: return $result;
7764: }
7765:
7766: sub devalidateuserresdata {
7767: my ($uname,$udom)=@_;
7768: my $hashid="$udom:$uname";
7769: &devalidate_cache_new('userres',$hashid);
7770: }
7771:
7772: sub get_userresdata {
7773: my ($uname,$udom)=@_;
7774: #most student don\'t have any data set, check if there is some data
7775: if (&EXT_cache_status($udom,$uname)) { return undef; }
7776:
7777: my $hashid="$udom:$uname";
7778: my ($result,$cached)=&is_cached_new('userres',$hashid);
7779: if (!defined($cached)) {
7780: my %resourcedata=&dump('resourcedata',$udom,$uname);
7781: $result=\%resourcedata;
7782: &do_cache_new('userres',$hashid,$result,600);
7783: }
7784: my ($tmp)=keys(%$result);
7785: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7786: return $result;
7787: }
7788: #error 2 occurs when the .db doesn't exist
7789: if ($tmp!~/error: 2 /) {
7790: &logthis("<font color=\"blue\">WARNING:".
7791: " Trying to get resource data for ".
7792: $uname." at ".$udom.": ".
7793: $tmp."</font>");
7794: } elsif ($tmp=~/error: 2 /) {
7795: #&EXT_cache_set($udom,$uname);
7796: &do_cache_new('userres',$hashid,undef,600);
7797: undef($tmp); # not really an error so don't send it back
7798: }
7799: return $tmp;
7800: }
7801: #----------------------------------------------- resdata - return resource data
7802: # Purpose:
7803: # Return resource data for either users or for a course.
7804: # Parameters:
7805: # $name - Course/user name.
7806: # $domain - Name of the domain the user/course is registered on.
7807: # $type - Type of thing $name is (must be 'course' or 'user'
7808: # @which - Array of names of resources desired.
7809: # Returns:
7810: # The value of the first reasource in @which that is found in the
7811: # resource hash.
7812: # Exceptional Conditions:
7813: # If the $type passed in is not valid (not the string 'course' or
7814: # 'user', an undefined reference is returned.
7815: # If none of the resources are found, an undef is returned
7816: sub resdata {
7817: my ($name,$domain,$type,@which)=@_;
7818: my $result;
7819: if ($type eq 'course') {
7820: $result=&get_courseresdata($name,$domain);
7821: } elsif ($type eq 'user') {
7822: $result=&get_userresdata($name,$domain);
7823: }
7824: if (!ref($result)) { return $result; }
7825: foreach my $item (@which) {
7826: if (defined($result->{$item->[0]})) {
7827: return [$result->{$item->[0]},$item->[1]];
7828: }
7829: }
7830: return undef;
7831: }
7832:
7833: #
7834: # EXT resource caching routines
7835: #
7836:
7837: sub clear_EXT_cache_status {
7838: &delenv('cache.EXT.');
7839: }
7840:
7841: sub EXT_cache_status {
7842: my ($target_domain,$target_user) = @_;
7843: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7844: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
7845: # We know already the user has no data
7846: return 1;
7847: } else {
7848: return 0;
7849: }
7850: }
7851:
7852: sub EXT_cache_set {
7853: my ($target_domain,$target_user) = @_;
7854: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7855: #&appenv({$cachename => time});
7856: }
7857:
7858: # --------------------------------------------------------- Value of a Variable
7859: sub EXT {
7860:
7861: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
7862: unless ($varname) { return ''; }
7863: #get real user name/domain, courseid and symb
7864: my $courseid;
7865: my $publicuser;
7866: if ($symbparm) {
7867: $symbparm=&get_symb_from_alias($symbparm);
7868: }
7869: if (!($uname && $udom)) {
7870: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
7871: if (!$symbparm) { $symbparm=$cursymb; }
7872: } else {
7873: $courseid=$env{'request.course.id'};
7874: }
7875: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7876: my $rest;
7877: if (defined($therest[0])) {
7878: $rest=join('.',@therest);
7879: } else {
7880: $rest='';
7881: }
7882:
7883: my $qualifierrest=$qualifier;
7884: if ($rest) { $qualifierrest.='.'.$rest; }
7885: my $spacequalifierrest=$space;
7886: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
7887: if ($realm eq 'user') {
7888: # --------------------------------------------------------------- user.resource
7889: if ($space eq 'resource') {
7890: if ( (defined($Apache::lonhomework::parsing_a_problem)
7891: || defined($Apache::lonhomework::parsing_a_task))
7892: &&
7893: ($symbparm eq &symbread()) ) {
7894: # if we are in the middle of processing the resource the
7895: # get the value we are planning on committing
7896: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7897: return $Apache::lonhomework::results{$qualifierrest};
7898: } else {
7899: return $Apache::lonhomework::history{$qualifierrest};
7900: }
7901: } else {
7902: my %restored;
7903: if ($publicuser || $env{'request.state'} eq 'construct') {
7904: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7905: } else {
7906: %restored=&restore($symbparm,$courseid,$udom,$uname);
7907: }
7908: return $restored{$qualifierrest};
7909: }
7910: # ----------------------------------------------------------------- user.access
7911: } elsif ($space eq 'access') {
7912: # FIXME - not supporting calls for a specific user
7913: return &allowed($qualifier,$rest);
7914: # ------------------------------------------ user.preferences, user.environment
7915: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
7916: if (($uname eq $env{'user.name'}) &&
7917: ($udom eq $env{'user.domain'})) {
7918: return $env{join('.',('environment',$qualifierrest))};
7919: } else {
7920: my %returnhash;
7921: if (!$publicuser) {
7922: %returnhash=&userenvironment($udom,$uname,
7923: $qualifierrest);
7924: }
7925: return $returnhash{$qualifierrest};
7926: }
7927: # ----------------------------------------------------------------- user.course
7928: } elsif ($space eq 'course') {
7929: # FIXME - not supporting calls for a specific user
7930: return $env{join('.',('request.course',$qualifier))};
7931: # ------------------------------------------------------------------- user.role
7932: } elsif ($space eq 'role') {
7933: # FIXME - not supporting calls for a specific user
7934: my ($role,$where)=split(/\./,$env{'request.role'});
7935: if ($qualifier eq 'value') {
7936: return $role;
7937: } elsif ($qualifier eq 'extent') {
7938: return $where;
7939: }
7940: # ----------------------------------------------------------------- user.domain
7941: } elsif ($space eq 'domain') {
7942: return $udom;
7943: # ------------------------------------------------------------------- user.name
7944: } elsif ($space eq 'name') {
7945: return $uname;
7946: # ---------------------------------------------------- Any other user namespace
7947: } else {
7948: my %reply;
7949: if (!$publicuser) {
7950: %reply=&get($space,[$qualifierrest],$udom,$uname);
7951: }
7952: return $reply{$qualifierrest};
7953: }
7954: } elsif ($realm eq 'query') {
7955: # ---------------------------------------------- pull stuff out of query string
7956: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7957: [$spacequalifierrest]);
7958: return $env{'form.'.$spacequalifierrest};
7959: } elsif ($realm eq 'request') {
7960: # ------------------------------------------------------------- request.browser
7961: if ($space eq 'browser') {
7962: if ($qualifier eq 'textremote') {
7963: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
7964: return 1;
7965: } else {
7966: return 0;
7967: }
7968: } else {
7969: return $env{'browser.'.$qualifier};
7970: }
7971: # ------------------------------------------------------------ request.filename
7972: } else {
7973: return $env{'request.'.$spacequalifierrest};
7974: }
7975: } elsif ($realm eq 'course') {
7976: # ---------------------------------------------------------- course.description
7977: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
7978: } elsif ($realm eq 'resource') {
7979:
7980: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
7981: if (!$symbparm) { $symbparm=&symbread(); }
7982: }
7983:
7984: if ($space eq 'title') {
7985: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7986: return &gettitle($symbparm);
7987: }
7988:
7989: if ($space eq 'map') {
7990: my ($map) = &decode_symb($symbparm);
7991: return &symbread($map);
7992: }
7993: if ($space eq 'filename') {
7994: if ($symbparm) {
7995: return &clutter((&decode_symb($symbparm))[2]);
7996: }
7997: return &hreflocation('',$env{'request.filename'});
7998: }
7999:
8000: my ($section, $group, @groups);
8001: my ($courselevelm,$courselevel);
8002: if ($symbparm && defined($courseid) &&
8003: $courseid eq $env{'request.course.id'}) {
8004:
8005: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
8006:
8007: # ----------------------------------------------------- Cascading lookup scheme
8008: my $symbp=$symbparm;
8009: my $mapp=&deversion((&decode_symb($symbp))[0]);
8010:
8011: my $symbparm=$symbp.'.'.$spacequalifierrest;
8012: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
8013:
8014: if (($env{'user.name'} eq $uname) &&
8015: ($env{'user.domain'} eq $udom)) {
8016: $section=$env{'request.course.sec'};
8017: @groups = split(/:/,$env{'request.course.groups'});
8018: @groups=&sort_course_groups($courseid,@groups);
8019: } else {
8020: if (! defined($usection)) {
8021: $section=&getsection($udom,$uname,$courseid);
8022: } else {
8023: $section = $usection;
8024: }
8025: @groups = &get_users_groups($udom,$uname,$courseid);
8026: }
8027:
8028: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
8029: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
8030: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
8031:
8032: $courselevel=$courseid.'.'.$spacequalifierrest;
8033: my $courselevelr=$courseid.'.'.$symbparm;
8034: $courselevelm=$courseid.'.'.$mapparm;
8035:
8036: # ----------------------------------------------------------- first, check user
8037:
8038: my $userreply=&resdata($uname,$udom,'user',
8039: ([$courselevelr,'resource'],
8040: [$courselevelm,'map' ],
8041: [$courselevel, 'course' ]));
8042: if (defined($userreply)) { return &get_reply($userreply); }
8043:
8044: # ------------------------------------------------ second, check some of course
8045: my $coursereply;
8046: if (@groups > 0) {
8047: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
8048: $mapparm,$spacequalifierrest);
8049: if (defined($coursereply)) { return &get_reply($coursereply); }
8050: }
8051:
8052: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8053: $env{'course.'.$courseid.'.domain'},
8054: 'course',
8055: ([$seclevelr, 'resource'],
8056: [$seclevelm, 'map' ],
8057: [$seclevel, 'course' ],
8058: [$courselevelr,'resource']));
8059: if (defined($coursereply)) { return &get_reply($coursereply); }
8060:
8061: # ------------------------------------------------------ third, check map parms
8062: my %parmhash=();
8063: my $thisparm='';
8064: if (tie(%parmhash,'GDBM_File',
8065: $env{'request.course.fn'}.'_parms.db',
8066: &GDBM_READER(),0640)) {
8067: $thisparm=$parmhash{$symbparm};
8068: untie(%parmhash);
8069: }
8070: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
8071: }
8072: # ------------------------------------------ fourth, look in resource metadata
8073:
8074: $spacequalifierrest=~s/\./\_/;
8075: my $filename;
8076: if (!$symbparm) { $symbparm=&symbread(); }
8077: if ($symbparm) {
8078: $filename=(&decode_symb($symbparm))[2];
8079: } else {
8080: $filename=$env{'request.filename'};
8081: }
8082: my $metadata=&metadata($filename,$spacequalifierrest);
8083: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8084: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
8085: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
8086:
8087: # ---------------------------------------------- fourth, look in rest of course
8088: if ($symbparm && defined($courseid) &&
8089: $courseid eq $env{'request.course.id'}) {
8090: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8091: $env{'course.'.$courseid.'.domain'},
8092: 'course',
8093: ([$courselevelm,'map' ],
8094: [$courselevel, 'course']));
8095: if (defined($coursereply)) { return &get_reply($coursereply); }
8096: }
8097: # ------------------------------------------------------------------ Cascade up
8098: unless ($space eq '0') {
8099: my @parts=split(/_/,$space);
8100: my $id=pop(@parts);
8101: my $part=join('_',@parts);
8102: if ($part eq '') { $part='0'; }
8103: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
8104: $symbparm,$udom,$uname,$section,1);
8105: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
8106: }
8107: if ($recurse) { return undef; }
8108: my $pack_def=&packages_tab_default($filename,$varname);
8109: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
8110: # ---------------------------------------------------- Any other user namespace
8111: } elsif ($realm eq 'environment') {
8112: # ----------------------------------------------------------------- environment
8113: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
8114: return $env{'environment.'.$spacequalifierrest};
8115: } else {
8116: if ($uname eq 'anonymous' && $udom eq '') {
8117: return '';
8118: }
8119: my %returnhash=&userenvironment($udom,$uname,
8120: $spacequalifierrest);
8121: return $returnhash{$spacequalifierrest};
8122: }
8123: } elsif ($realm eq 'system') {
8124: # ----------------------------------------------------------------- system.time
8125: if ($space eq 'time') {
8126: return time;
8127: }
8128: } elsif ($realm eq 'server') {
8129: # ----------------------------------------------------------------- system.time
8130: if ($space eq 'name') {
8131: return $ENV{'SERVER_NAME'};
8132: }
8133: }
8134: return '';
8135: }
8136:
8137: sub get_reply {
8138: my ($reply_value) = @_;
8139: if (ref($reply_value) eq 'ARRAY') {
8140: if (wantarray) {
8141: return @$reply_value;
8142: }
8143: return $reply_value->[0];
8144: } else {
8145: return $reply_value;
8146: }
8147: }
8148:
8149: sub check_group_parms {
8150: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8151: my @groupitems = ();
8152: my $resultitem;
8153: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
8154: foreach my $group (@{$groups}) {
8155: foreach my $level (@levels) {
8156: my $item = $courseid.'.['.$group.'].'.$level->[0];
8157: push(@groupitems,[$item,$level->[1]]);
8158: }
8159: }
8160: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8161: $env{'course.'.$courseid.'.domain'},
8162: 'course',@groupitems);
8163: return $coursereply;
8164: }
8165:
8166: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
8167: my ($courseid,@groups) = @_;
8168: @groups = sort(@groups);
8169: return @groups;
8170: }
8171:
8172: sub packages_tab_default {
8173: my ($uri,$varname)=@_;
8174: my (undef,$part,$name)=split(/\./,$varname);
8175:
8176: my (@extension,@specifics,$do_default);
8177: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
8178: my ($pack_type,$pack_part)=split(/_/,$package,2);
8179: if ($pack_type eq 'default') {
8180: $do_default=1;
8181: } elsif ($pack_type eq 'extension') {
8182: push(@extension,[$package,$pack_type,$pack_part]);
8183: } elsif ($pack_part eq $part || $pack_type eq 'part') {
8184: # only look at packages defaults for packages that this id is
8185: push(@specifics,[$package,$pack_type,$pack_part]);
8186: }
8187: }
8188: # first look for a package that matches the requested part id
8189: foreach my $package (@specifics) {
8190: my (undef,$pack_type,$pack_part)=@{$package};
8191: next if ($pack_part ne $part);
8192: if (defined($packagetab{"$pack_type&$name&default"})) {
8193: return $packagetab{"$pack_type&$name&default"};
8194: }
8195: }
8196: # look for any possible matching non extension_ package
8197: foreach my $package (@specifics) {
8198: my (undef,$pack_type,$pack_part)=@{$package};
8199: if (defined($packagetab{"$pack_type&$name&default"})) {
8200: return $packagetab{"$pack_type&$name&default"};
8201: }
8202: if ($pack_type eq 'part') { $pack_part='0'; }
8203: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8204: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
8205: }
8206: }
8207: # look for any posible extension_ match
8208: foreach my $package (@extension) {
8209: my ($package,$pack_type)=@{$package};
8210: if (defined($packagetab{"$pack_type&$name&default"})) {
8211: return $packagetab{"$pack_type&$name&default"};
8212: }
8213: if (defined($packagetab{$package."&$name&default"})) {
8214: return $packagetab{$package."&$name&default"};
8215: }
8216: }
8217: # look for a global default setting
8218: if ($do_default && defined($packagetab{"default&$name&default"})) {
8219: return $packagetab{"default&$name&default"};
8220: }
8221: return undef;
8222: }
8223:
8224: sub add_prefix_and_part {
8225: my ($prefix,$part)=@_;
8226: my $keyroot;
8227: if (defined($prefix) && $prefix !~ /^__/) {
8228: # prefix that has a part already
8229: $keyroot=$prefix;
8230: } elsif (defined($prefix)) {
8231: # prefix that is missing a part
8232: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8233: } else {
8234: # no prefix at all
8235: if (defined($part)) { $keyroot='_'.$part; }
8236: }
8237: return $keyroot;
8238: }
8239:
8240: # ---------------------------------------------------------------- Get metadata
8241:
8242: my %metaentry;
8243: sub metadata {
8244: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
8245: $uri=&declutter($uri);
8246: # if it is a non metadata possible uri return quickly
8247: if (($uri eq '') ||
8248: (($uri =~ m|^/*adm/|) &&
8249: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
8250: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8251: return undef;
8252: }
8253: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8254: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
8255: return undef;
8256: }
8257: my $filename=$uri;
8258: $uri=~s/\.meta$//;
8259: #
8260: # Is the metadata already cached?
8261: # Look at timestamp of caching
8262: # Everything is cached by the main uri, libraries are never directly cached
8263: #
8264: if (!defined($liburi)) {
8265: my ($result,$cached)=&is_cached_new('meta',$uri);
8266: if (defined($cached)) { return $result->{':'.$what}; }
8267: }
8268: {
8269: #
8270: # Is this a recursive call for a library?
8271: #
8272: # if (! exists($metacache{$uri})) {
8273: # $metacache{$uri}={};
8274: # }
8275: my $cachetime = 60*60;
8276: if ($liburi) {
8277: $liburi=&declutter($liburi);
8278: $filename=$liburi;
8279: } else {
8280: &devalidate_cache_new('meta',$uri);
8281: undef(%metaentry);
8282: }
8283: my %metathesekeys=();
8284: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
8285: my $metastring;
8286: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
8287: my $which = &hreflocation('','/'.($liburi || $uri));
8288: $metastring =
8289: &Apache::lonnet::ssi_body($which,
8290: ('grade_target' => 'meta'));
8291: $cachetime = 1; # only want this cached in the child not long term
8292: } elsif ($uri !~ m -^(editupload)/-) {
8293: my $file=&filelocation('',&clutter($filename));
8294: #push(@{$metaentry{$uri.'.file'}},$file);
8295: $metastring=&getfile($file);
8296: }
8297: my $parser=HTML::LCParser->new(\$metastring);
8298: my $token;
8299: undef %metathesekeys;
8300: while ($token=$parser->get_token) {
8301: if ($token->[0] eq 'S') {
8302: if (defined($token->[2]->{'package'})) {
8303: #
8304: # This is a package - get package info
8305: #
8306: my $package=$token->[2]->{'package'};
8307: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8308: if (defined($token->[2]->{'id'})) {
8309: $keyroot.='_'.$token->[2]->{'id'};
8310: }
8311: if ($metaentry{':packages'}) {
8312: $metaentry{':packages'}.=','.$package.$keyroot;
8313: } else {
8314: $metaentry{':packages'}=$package.$keyroot;
8315: }
8316: foreach my $pack_entry (keys(%packagetab)) {
8317: my $part=$keyroot;
8318: $part=~s/^\_//;
8319: if ($pack_entry=~/^\Q$package\E\&/ ||
8320: $pack_entry=~/^\Q$package\E_0\&/) {
8321: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
8322: # ignore package.tab specified default values
8323: # here &package_tab_default() will fetch those
8324: if ($subp eq 'default') { next; }
8325: my $value=$packagetab{$pack_entry};
8326: my $unikey;
8327: if ($pack =~ /_0$/) {
8328: $unikey='parameter_0_'.$name;
8329: $part=0;
8330: } else {
8331: $unikey='parameter'.$keyroot.'_'.$name;
8332: }
8333: if ($subp eq 'display') {
8334: $value.=' [Part: '.$part.']';
8335: }
8336: $metaentry{':'.$unikey.'.part'}=$part;
8337: $metathesekeys{$unikey}=1;
8338: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8339: $metaentry{':'.$unikey.'.'.$subp}=$value;
8340: }
8341: if (defined($metaentry{':'.$unikey.'.default'})) {
8342: $metaentry{':'.$unikey}=
8343: $metaentry{':'.$unikey.'.default'};
8344: }
8345: }
8346: }
8347: } else {
8348: #
8349: # This is not a package - some other kind of start tag
8350: #
8351: my $entry=$token->[1];
8352: my $unikey;
8353: if ($entry eq 'import') {
8354: $unikey='';
8355: } else {
8356: $unikey=$entry;
8357: }
8358: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8359:
8360: if (defined($token->[2]->{'id'})) {
8361: $unikey.='_'.$token->[2]->{'id'};
8362: }
8363:
8364: if ($entry eq 'import') {
8365: #
8366: # Importing a library here
8367: #
8368: if ($depthcount<20) {
8369: my $location=$parser->get_text('/import');
8370: my $dir=$filename;
8371: $dir=~s|[^/]*$||;
8372: $location=&filelocation($dir,$location);
8373: my $metadata =
8374: &metadata($uri,'keys', $location,$unikey,
8375: $depthcount+1);
8376: foreach my $meta (split(',',$metadata)) {
8377: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8378: $metathesekeys{$meta}=1;
8379: }
8380: }
8381: } else {
8382:
8383: if (defined($token->[2]->{'name'})) {
8384: $unikey.='_'.$token->[2]->{'name'};
8385: }
8386: $metathesekeys{$unikey}=1;
8387: foreach my $param (@{$token->[3]}) {
8388: $metaentry{':'.$unikey.'.'.$param} =
8389: $token->[2]->{$param};
8390: }
8391: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
8392: my $default=$metaentry{':'.$unikey.'.default'};
8393: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8394: # only ws inside the tag, and not in default, so use default
8395: # as value
8396: $metaentry{':'.$unikey}=$default;
8397: } elsif ( $internaltext =~ /\S/ ) {
8398: # something interesting inside the tag
8399: $metaentry{':'.$unikey}=$internaltext;
8400: } else {
8401: # no interesting values, don't set a default
8402: }
8403: # end of not-a-package not-a-library import
8404: }
8405: # end of not-a-package start tag
8406: }
8407: # the next is the end of "start tag"
8408: }
8409: }
8410: my ($extension) = ($uri =~ /\.(\w+)$/);
8411: $extension = lc($extension);
8412: if ($extension eq 'htm') { $extension='html'; }
8413:
8414: foreach my $key (keys(%packagetab)) {
8415: #no specific packages #how's our extension
8416: if ($key!~/^extension_\Q$extension\E&/) { next; }
8417: &metadata_create_package_def($uri,$key,'extension_'.$extension,
8418: \%metathesekeys);
8419: }
8420:
8421: if (!exists($metaentry{':packages'})
8422: || $packagetab{"import_defaults&extension_$extension"}) {
8423: foreach my $key (keys(%packagetab)) {
8424: #no specific packages well let's get default then
8425: if ($key!~/^default&/) { next; }
8426: &metadata_create_package_def($uri,$key,'default',
8427: \%metathesekeys);
8428: }
8429: }
8430: # are there custom rights to evaluate
8431: if ($metaentry{':copyright'} eq 'custom') {
8432:
8433: #
8434: # Importing a rights file here
8435: #
8436: unless ($depthcount) {
8437: my $location=$metaentry{':customdistributionfile'};
8438: my $dir=$filename;
8439: $dir=~s|[^/]*$||;
8440: $location=&filelocation($dir,$location);
8441: my $rights_metadata =
8442: &metadata($uri,'keys',$location,'_rights',
8443: $depthcount+1);
8444: foreach my $rights (split(',',$rights_metadata)) {
8445: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8446: $metathesekeys{$rights}=1;
8447: }
8448: }
8449: }
8450: # uniqifiy package listing
8451: my %seen;
8452: my @uniq_packages =
8453: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8454: $metaentry{':packages'} = join(',',@uniq_packages);
8455:
8456: $metaentry{':keys'} = join(',',keys(%metathesekeys));
8457: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8458: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
8459: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
8460: # this is the end of "was not already recently cached
8461: }
8462: return $metaentry{':'.$what};
8463: }
8464:
8465: sub metadata_create_package_def {
8466: my ($uri,$key,$package,$metathesekeys)=@_;
8467: my ($pack,$name,$subp)=split(/\&/,$key);
8468: if ($subp eq 'default') { next; }
8469:
8470: if (defined($metaentry{':packages'})) {
8471: $metaentry{':packages'}.=','.$package;
8472: } else {
8473: $metaentry{':packages'}=$package;
8474: }
8475: my $value=$packagetab{$key};
8476: my $unikey;
8477: $unikey='parameter_0_'.$name;
8478: $metaentry{':'.$unikey.'.part'}=0;
8479: $$metathesekeys{$unikey}=1;
8480: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8481: $metaentry{':'.$unikey.'.'.$subp}=$value;
8482: }
8483: if (defined($metaentry{':'.$unikey.'.default'})) {
8484: $metaentry{':'.$unikey}=
8485: $metaentry{':'.$unikey.'.default'};
8486: }
8487: }
8488:
8489: sub metadata_generate_part0 {
8490: my ($metadata,$metacache,$uri) = @_;
8491: my %allnames;
8492: foreach my $metakey (keys(%$metadata)) {
8493: if ($metakey=~/^parameter\_(.*)/) {
8494: my $part=$$metacache{':'.$metakey.'.part'};
8495: my $name=$$metacache{':'.$metakey.'.name'};
8496: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
8497: $allnames{$name}=$part;
8498: }
8499: }
8500: }
8501: foreach my $name (keys(%allnames)) {
8502: $$metadata{"parameter_0_$name"}=1;
8503: my $key=":parameter_0_$name";
8504: $$metacache{"$key.part"}='0';
8505: $$metacache{"$key.name"}=$name;
8506: $$metacache{"$key.type"}=$$metacache{':parameter_'.
8507: $allnames{$name}.'_'.$name.
8508: '.type'};
8509: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
8510: '.display'};
8511: my $expr='[Part: '.$allnames{$name}.']';
8512: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
8513: $$metacache{"$key.display"}=$olddis;
8514: }
8515: }
8516:
8517: # ------------------------------------------------------ Devalidate title cache
8518:
8519: sub devalidate_title_cache {
8520: my ($url)=@_;
8521: if (!$env{'request.course.id'}) { return; }
8522: my $symb=&symbread($url);
8523: if (!$symb) { return; }
8524: my $key=$env{'request.course.id'}."\0".$symb;
8525: &devalidate_cache_new('title',$key);
8526: }
8527:
8528: # ------------------------------------------------- Get the title of a course
8529:
8530: sub current_course_title {
8531: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8532: }
8533: # ------------------------------------------------- Get the title of a resource
8534:
8535: sub gettitle {
8536: my $urlsymb=shift;
8537: my $symb=&symbread($urlsymb);
8538: if ($symb) {
8539: my $key=$env{'request.course.id'}."\0".$symb;
8540: my ($result,$cached)=&is_cached_new('title',$key);
8541: if (defined($cached)) {
8542: return $result;
8543: }
8544: my ($map,$resid,$url)=&decode_symb($symb);
8545: my $title='';
8546: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8547: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8548: } else {
8549: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8550: &GDBM_READER(),0640)) {
8551: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8552: $title=$bighash{'title_'.$mapid.'.'.$resid};
8553: untie(%bighash);
8554: }
8555: }
8556: $title=~s/\&colon\;/\:/gs;
8557: if ($title) {
8558: return &do_cache_new('title',$key,$title,600);
8559: }
8560: $urlsymb=$url;
8561: }
8562: my $title=&metadata($urlsymb,'title');
8563: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8564: return $title;
8565: }
8566:
8567: sub get_slot {
8568: my ($which,$cnum,$cdom)=@_;
8569: if (!$cnum || !$cdom) {
8570: (undef,my $courseid)=&whichuser();
8571: $cdom=$env{'course.'.$courseid.'.domain'};
8572: $cnum=$env{'course.'.$courseid.'.num'};
8573: }
8574: my $key=join("\0",'slots',$cdom,$cnum,$which);
8575: my %slotinfo;
8576: if (exists($remembered{$key})) {
8577: $slotinfo{$which} = $remembered{$key};
8578: } else {
8579: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8580: &Apache::lonhomework::showhash(%slotinfo);
8581: my ($tmp)=keys(%slotinfo);
8582: if ($tmp=~/^error:/) { return (); }
8583: $remembered{$key} = $slotinfo{$which};
8584: }
8585: if (ref($slotinfo{$which}) eq 'HASH') {
8586: return %{$slotinfo{$which}};
8587: }
8588: return $slotinfo{$which};
8589: }
8590: # ------------------------------------------------- Update symbolic store links
8591:
8592: sub symblist {
8593: my ($mapname,%newhash)=@_;
8594: $mapname=&deversion(&declutter($mapname));
8595: my %hash;
8596: if (($env{'request.course.fn'}) && (%newhash)) {
8597: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8598: &GDBM_WRCREAT(),0640)) {
8599: foreach my $url (keys(%newhash)) {
8600: next if ($url eq 'last_known'
8601: && $env{'form.no_update_last_known'});
8602: $hash{declutter($url)}=&encode_symb($mapname,
8603: $newhash{$url}->[1],
8604: $newhash{$url}->[0]);
8605: }
8606: if (untie(%hash)) {
8607: return 'ok';
8608: }
8609: }
8610: }
8611: return 'error';
8612: }
8613:
8614: # --------------------------------------------------------------- Verify a symb
8615:
8616: sub symbverify {
8617: my ($symb,$thisurl)=@_;
8618: my $thisfn=$thisurl;
8619: $thisfn=&declutter($thisfn);
8620: # direct jump to resource in page or to a sequence - will construct own symbs
8621: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8622: # check URL part
8623: my ($map,$resid,$url)=&decode_symb($symb);
8624:
8625: unless ($url eq $thisfn) { return 0; }
8626:
8627: $symb=&symbclean($symb);
8628: $thisurl=&deversion($thisurl);
8629: $thisfn=&deversion($thisfn);
8630:
8631: my %bighash;
8632: my $okay=0;
8633:
8634: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8635: &GDBM_READER(),0640)) {
8636: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8637: $thisurl =~ s/\?.+$//;
8638: }
8639: my $ids=$bighash{'ids_'.&clutter($thisurl)};
8640: unless ($ids) {
8641: $ids=$bighash{'ids_/'.$thisurl};
8642: }
8643: if ($ids) {
8644: # ------------------------------------------------------------------- Has ID(s)
8645: foreach my $id (split(/\,/,$ids)) {
8646: my ($mapid,$resid)=split(/\./,$id);
8647: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8648: $symb =~ s/\?.+$//;
8649: }
8650: if (
8651: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8652: eq $symb) {
8653: if (($env{'request.role.adv'}) ||
8654: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
8655: $okay=1;
8656: }
8657: }
8658: }
8659: }
8660: untie(%bighash);
8661: }
8662: return $okay;
8663: }
8664:
8665: # --------------------------------------------------------------- Clean-up symb
8666:
8667: sub symbclean {
8668: my $symb=shift;
8669: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8670: # remove version from map
8671: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
8672:
8673: # remove version from URL
8674: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
8675:
8676: # remove wrapper
8677:
8678: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
8679: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
8680: return $symb;
8681: }
8682:
8683: # ---------------------------------------------- Split symb to find map and url
8684:
8685: sub encode_symb {
8686: my ($map,$resid,$url)=@_;
8687: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8688: }
8689:
8690: sub decode_symb {
8691: my $symb=shift;
8692: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8693: my ($map,$resid,$url)=split(/___/,$symb);
8694: return (&fixversion($map),$resid,&fixversion($url));
8695: }
8696:
8697: sub fixversion {
8698: my $fn=shift;
8699: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
8700: my %bighash;
8701: my $uri=&clutter($fn);
8702: my $key=$env{'request.course.id'}.'_'.$uri;
8703: # is this cached?
8704: my ($result,$cached)=&is_cached_new('courseresversion',$key);
8705: if (defined($cached)) { return $result; }
8706: # unfortunately not cached, or expired
8707: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8708: &GDBM_READER(),0640)) {
8709: if ($bighash{'version_'.$uri}) {
8710: my $version=$bighash{'version_'.$uri};
8711: unless (($version eq 'mostrecent') ||
8712: ($version==&getversion($uri))) {
8713: $uri=~s/\.(\w+)$/\.$version\.$1/;
8714: }
8715: }
8716: untie %bighash;
8717: }
8718: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
8719: }
8720:
8721: sub deversion {
8722: my $url=shift;
8723: $url=~s/\.\d+\.(\w+)$/\.$1/;
8724: return $url;
8725: }
8726:
8727: # ------------------------------------------------------ Return symb list entry
8728:
8729: sub symbread {
8730: my ($thisfn,$donotrecurse)=@_;
8731: my $cache_str='request.symbread.cached.'.$thisfn;
8732: if (defined($env{$cache_str})) { return $env{$cache_str}; }
8733: # no filename provided? try from environment
8734: unless ($thisfn) {
8735: if ($env{'request.symb'}) {
8736: return $env{$cache_str}=&symbclean($env{'request.symb'});
8737: }
8738: $thisfn=$env{'request.filename'};
8739: }
8740: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8741: # is that filename actually a symb? Verify, clean, and return
8742: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
8743: if (&symbverify($thisfn,$1)) {
8744: return $env{$cache_str}=&symbclean($thisfn);
8745: }
8746: }
8747: $thisfn=declutter($thisfn);
8748: my %hash;
8749: my %bighash;
8750: my $syval='';
8751: if (($env{'request.course.fn'}) && ($thisfn)) {
8752: my $targetfn = $thisfn;
8753: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
8754: $targetfn = 'adm/wrapper/'.$thisfn;
8755: }
8756: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8757: $targetfn=$1;
8758: }
8759: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8760: &GDBM_READER(),0640)) {
8761: $syval=$hash{$targetfn};
8762: untie(%hash);
8763: }
8764: # ---------------------------------------------------------- There was an entry
8765: if ($syval) {
8766: #unless ($syval=~/\_\d+$/) {
8767: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
8768: #&appenv({'request.ambiguous' => $thisfn});
8769: #return $env{$cache_str}='';
8770: #}
8771: #$syval.=$1;
8772: #}
8773: } else {
8774: # ------------------------------------------------------- Was not in symb table
8775: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8776: &GDBM_READER(),0640)) {
8777: # ---------------------------------------------- Get ID(s) for current resource
8778: my $ids=$bighash{'ids_'.&clutter($thisfn)};
8779: unless ($ids) {
8780: $ids=$bighash{'ids_/'.$thisfn};
8781: }
8782: unless ($ids) {
8783: # alias?
8784: $ids=$bighash{'mapalias_'.$thisfn};
8785: }
8786: if ($ids) {
8787: # ------------------------------------------------------------------- Has ID(s)
8788: my @possibilities=split(/\,/,$ids);
8789: if ($#possibilities==0) {
8790: # ----------------------------------------------- There is only one possibility
8791: my ($mapid,$resid)=split(/\./,$ids);
8792: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8793: $resid,$thisfn);
8794: } elsif (!$donotrecurse) {
8795: # ------------------------------------------ There is more than one possibility
8796: my $realpossible=0;
8797: foreach my $id (@possibilities) {
8798: my $file=$bighash{'src_'.$id};
8799: if (&allowed('bre',$file)) {
8800: my ($mapid,$resid)=split(/\./,$id);
8801: if ($bighash{'map_type_'.$mapid} ne 'page') {
8802: $realpossible++;
8803: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8804: $resid,$thisfn);
8805: }
8806: }
8807: }
8808: if ($realpossible!=1) { $syval=''; }
8809: } else {
8810: $syval='';
8811: }
8812: }
8813: untie(%bighash)
8814: }
8815: }
8816: if ($syval) {
8817: return $env{$cache_str}=$syval;
8818: }
8819: }
8820: &appenv({'request.ambiguous' => $thisfn});
8821: return $env{$cache_str}='';
8822: }
8823:
8824: # ---------------------------------------------------------- Return random seed
8825:
8826: sub numval {
8827: my $txt=shift;
8828: $txt=~tr/A-J/0-9/;
8829: $txt=~tr/a-j/0-9/;
8830: $txt=~tr/K-T/0-9/;
8831: $txt=~tr/k-t/0-9/;
8832: $txt=~tr/U-Z/0-5/;
8833: $txt=~tr/u-z/0-5/;
8834: $txt=~s/\D//g;
8835: if ($_64bit) { if ($txt > 2**32) { return -1; } }
8836: return int($txt);
8837: }
8838:
8839: sub numval2 {
8840: my $txt=shift;
8841: $txt=~tr/A-J/0-9/;
8842: $txt=~tr/a-j/0-9/;
8843: $txt=~tr/K-T/0-9/;
8844: $txt=~tr/k-t/0-9/;
8845: $txt=~tr/U-Z/0-5/;
8846: $txt=~tr/u-z/0-5/;
8847: $txt=~s/\D//g;
8848: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8849: my $total;
8850: foreach my $val (@txts) { $total+=$val; }
8851: if ($_64bit) { if ($total > 2**32) { return -1; } }
8852: return int($total);
8853: }
8854:
8855: sub numval3 {
8856: use integer;
8857: my $txt=shift;
8858: $txt=~tr/A-J/0-9/;
8859: $txt=~tr/a-j/0-9/;
8860: $txt=~tr/K-T/0-9/;
8861: $txt=~tr/k-t/0-9/;
8862: $txt=~tr/U-Z/0-5/;
8863: $txt=~tr/u-z/0-5/;
8864: $txt=~s/\D//g;
8865: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8866: my $total;
8867: foreach my $val (@txts) { $total+=$val; }
8868: if ($_64bit) { $total=(($total<<32)>>32); }
8869: return $total;
8870: }
8871:
8872: sub digest {
8873: my ($data)=@_;
8874: my $digest=&Digest::MD5::md5($data);
8875: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8876: my ($e,$f);
8877: {
8878: use integer;
8879: $e=($a+$b);
8880: $f=($c+$d);
8881: if ($_64bit) {
8882: $e=(($e<<32)>>32);
8883: $f=(($f<<32)>>32);
8884: }
8885: }
8886: if (wantarray) {
8887: return ($e,$f);
8888: } else {
8889: my $g;
8890: {
8891: use integer;
8892: $g=($e+$f);
8893: if ($_64bit) {
8894: $g=(($g<<32)>>32);
8895: }
8896: }
8897: return $g;
8898: }
8899: }
8900:
8901: sub latest_rnd_algorithm_id {
8902: return '64bit5';
8903: }
8904:
8905: sub get_rand_alg {
8906: my ($courseid)=@_;
8907: if (!$courseid) { $courseid=(&whichuser())[1]; }
8908: if ($courseid) {
8909: return $env{"course.$courseid.rndseed"};
8910: }
8911: return &latest_rnd_algorithm_id();
8912: }
8913:
8914: sub validCODE {
8915: my ($CODE)=@_;
8916: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8917: return 0;
8918: }
8919:
8920: sub getCODE {
8921: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
8922: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8923: defined($Apache::lonhomework::parsing_a_task) ) &&
8924: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
8925: return $Apache::lonhomework::history{'resource.CODE'};
8926: }
8927: return undef;
8928: }
8929:
8930: sub rndseed {
8931: my ($symb,$courseid,$domain,$username)=@_;
8932: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
8933: if (!defined($symb)) {
8934: unless ($symb=$wsymb) { return time; }
8935: }
8936: if (!$courseid) { $courseid=$wcourseid; }
8937: if (!$domain) { $domain=$wdomain; }
8938: if (!$username) { $username=$wusername }
8939: my $which=&get_rand_alg();
8940:
8941: if (defined(&getCODE())) {
8942: if ($which eq '64bit5') {
8943: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8944: } elsif ($which eq '64bit4') {
8945: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8946: } else {
8947: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8948: }
8949: } elsif ($which eq '64bit5') {
8950: return &rndseed_64bit5($symb,$courseid,$domain,$username);
8951: } elsif ($which eq '64bit4') {
8952: return &rndseed_64bit4($symb,$courseid,$domain,$username);
8953: } elsif ($which eq '64bit3') {
8954: return &rndseed_64bit3($symb,$courseid,$domain,$username);
8955: } elsif ($which eq '64bit2') {
8956: return &rndseed_64bit2($symb,$courseid,$domain,$username);
8957: } elsif ($which eq '64bit') {
8958: return &rndseed_64bit($symb,$courseid,$domain,$username);
8959: }
8960: return &rndseed_32bit($symb,$courseid,$domain,$username);
8961: }
8962:
8963: sub rndseed_32bit {
8964: my ($symb,$courseid,$domain,$username)=@_;
8965: {
8966: use integer;
8967: my $symbchck=unpack("%32C*",$symb) << 27;
8968: my $symbseed=numval($symb) << 22;
8969: my $namechck=unpack("%32C*",$username) << 17;
8970: my $nameseed=numval($username) << 12;
8971: my $domainseed=unpack("%32C*",$domain) << 7;
8972: my $courseseed=unpack("%32C*",$courseid);
8973: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
8974: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8975: #&logthis("rndseed :$num:$symb");
8976: if ($_64bit) { $num=(($num<<32)>>32); }
8977: return $num;
8978: }
8979: }
8980:
8981: sub rndseed_64bit {
8982: my ($symb,$courseid,$domain,$username)=@_;
8983: {
8984: use integer;
8985: my $symbchck=unpack("%32S*",$symb) << 21;
8986: my $symbseed=numval($symb) << 10;
8987: my $namechck=unpack("%32S*",$username);
8988:
8989: my $nameseed=numval($username) << 21;
8990: my $domainseed=unpack("%32S*",$domain) << 10;
8991: my $courseseed=unpack("%32S*",$courseid);
8992:
8993: my $num1=$symbchck+$symbseed+$namechck;
8994: my $num2=$nameseed+$domainseed+$courseseed;
8995: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8996: #&logthis("rndseed :$num:$symb");
8997: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8998: return "$num1,$num2";
8999: }
9000: }
9001:
9002: sub rndseed_64bit2 {
9003: my ($symb,$courseid,$domain,$username)=@_;
9004: {
9005: use integer;
9006: # strings need to be an even # of cahracters long, it it is odd the
9007: # last characters gets thrown away
9008: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9009: my $symbseed=numval($symb) << 10;
9010: my $namechck=unpack("%32S*",$username.' ');
9011:
9012: my $nameseed=numval($username) << 21;
9013: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9014: my $courseseed=unpack("%32S*",$courseid.' ');
9015:
9016: my $num1=$symbchck+$symbseed+$namechck;
9017: my $num2=$nameseed+$domainseed+$courseseed;
9018: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9019: #&logthis("rndseed :$num:$symb");
9020: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9021: return "$num1,$num2";
9022: }
9023: }
9024:
9025: sub rndseed_64bit3 {
9026: my ($symb,$courseid,$domain,$username)=@_;
9027: {
9028: use integer;
9029: # strings need to be an even # of cahracters long, it it is odd the
9030: # last characters gets thrown away
9031: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9032: my $symbseed=numval2($symb) << 10;
9033: my $namechck=unpack("%32S*",$username.' ');
9034:
9035: my $nameseed=numval2($username) << 21;
9036: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9037: my $courseseed=unpack("%32S*",$courseid.' ');
9038:
9039: my $num1=$symbchck+$symbseed+$namechck;
9040: my $num2=$nameseed+$domainseed+$courseseed;
9041: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9042: #&logthis("rndseed :$num1:$num2:$_64bit");
9043: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9044:
9045: return "$num1:$num2";
9046: }
9047: }
9048:
9049: sub rndseed_64bit4 {
9050: my ($symb,$courseid,$domain,$username)=@_;
9051: {
9052: use integer;
9053: # strings need to be an even # of cahracters long, it it is odd the
9054: # last characters gets thrown away
9055: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9056: my $symbseed=numval3($symb) << 10;
9057: my $namechck=unpack("%32S*",$username.' ');
9058:
9059: my $nameseed=numval3($username) << 21;
9060: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9061: my $courseseed=unpack("%32S*",$courseid.' ');
9062:
9063: my $num1=$symbchck+$symbseed+$namechck;
9064: my $num2=$nameseed+$domainseed+$courseseed;
9065: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9066: #&logthis("rndseed :$num1:$num2:$_64bit");
9067: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9068:
9069: return "$num1:$num2";
9070: }
9071: }
9072:
9073: sub rndseed_64bit5 {
9074: my ($symb,$courseid,$domain,$username)=@_;
9075: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
9076: return "$num1:$num2";
9077: }
9078:
9079: sub rndseed_CODE_64bit {
9080: my ($symb,$courseid,$domain,$username)=@_;
9081: {
9082: use integer;
9083: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9084: my $symbseed=numval2($symb);
9085: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9086: my $CODEseed=numval(&getCODE());
9087: my $courseseed=unpack("%32S*",$courseid.' ');
9088: my $num1=$symbseed+$CODEchck;
9089: my $num2=$CODEseed+$courseseed+$symbchck;
9090: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9091: #&logthis("rndseed :$num1:$num2:$symb");
9092: if ($_64bit) { $num1=(($num1<<32)>>32); }
9093: if ($_64bit) { $num2=(($num2<<32)>>32); }
9094: return "$num1:$num2";
9095: }
9096: }
9097:
9098: sub rndseed_CODE_64bit4 {
9099: my ($symb,$courseid,$domain,$username)=@_;
9100: {
9101: use integer;
9102: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9103: my $symbseed=numval3($symb);
9104: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9105: my $CODEseed=numval3(&getCODE());
9106: my $courseseed=unpack("%32S*",$courseid.' ');
9107: my $num1=$symbseed+$CODEchck;
9108: my $num2=$CODEseed+$courseseed+$symbchck;
9109: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9110: #&logthis("rndseed :$num1:$num2:$symb");
9111: if ($_64bit) { $num1=(($num1<<32)>>32); }
9112: if ($_64bit) { $num2=(($num2<<32)>>32); }
9113: return "$num1:$num2";
9114: }
9115: }
9116:
9117: sub rndseed_CODE_64bit5 {
9118: my ($symb,$courseid,$domain,$username)=@_;
9119: my $code = &getCODE();
9120: my ($num1,$num2)=&digest("$symb,$courseid,$code");
9121: return "$num1:$num2";
9122: }
9123:
9124: sub setup_random_from_rndseed {
9125: my ($rndseed)=@_;
9126: if ($rndseed =~/([,:])/) {
9127: my ($num1,$num2)=split(/[,:]/,$rndseed);
9128: &Math::Random::random_set_seed(abs($num1),abs($num2));
9129: } else {
9130: &Math::Random::random_set_seed_from_phrase($rndseed);
9131: }
9132: }
9133:
9134: sub latest_receipt_algorithm_id {
9135: return 'receipt3';
9136: }
9137:
9138: sub recunique {
9139: my $fucourseid=shift;
9140: my $unique;
9141: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9142: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
9143: $unique=$env{"course.$fucourseid.internal.encseed"};
9144: } else {
9145: $unique=$perlvar{'lonReceipt'};
9146: }
9147: return unpack("%32C*",$unique);
9148: }
9149:
9150: sub recprefix {
9151: my $fucourseid=shift;
9152: my $prefix;
9153: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9154: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
9155: $prefix=$env{"course.$fucourseid.internal.encpref"};
9156: } else {
9157: $prefix=$perlvar{'lonHostID'};
9158: }
9159: return unpack("%32C*",$prefix);
9160: }
9161:
9162: sub ireceipt {
9163: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
9164:
9165: my $return =&recprefix($fucourseid).'-';
9166:
9167: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9168: $env{'request.state'} eq 'construct') {
9169: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9170: return $return;
9171: }
9172:
9173: my $cuname=unpack("%32C*",$funame);
9174: my $cudom=unpack("%32C*",$fudom);
9175: my $cucourseid=unpack("%32C*",$fucourseid);
9176: my $cusymb=unpack("%32C*",$fusymb);
9177: my $cunique=&recunique($fucourseid);
9178: my $cpart=unpack("%32S*",$part);
9179: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9180:
9181: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
9182:
9183: $return.= ($cunique%$cuname+
9184: $cunique%$cudom+
9185: $cusymb%$cuname+
9186: $cusymb%$cudom+
9187: $cucourseid%$cuname+
9188: $cucourseid%$cudom+
9189: $cpart%$cuname+
9190: $cpart%$cudom);
9191: } else {
9192: $return.= ($cunique%$cuname+
9193: $cunique%$cudom+
9194: $cusymb%$cuname+
9195: $cusymb%$cudom+
9196: $cucourseid%$cuname+
9197: $cucourseid%$cudom);
9198: }
9199: return $return;
9200: }
9201:
9202: sub receipt {
9203: my ($part)=@_;
9204: my ($symb,$courseid,$domain,$name) = &whichuser();
9205: return &ireceipt($name,$domain,$courseid,$symb,$part);
9206: }
9207:
9208: sub whichuser {
9209: my ($passedsymb)=@_;
9210: my ($symb,$courseid,$domain,$name,$publicuser);
9211: if (defined($env{'form.grade_symb'})) {
9212: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9213: my $allowed=&allowed('vgr',$tmp_courseid);
9214: if (!$allowed &&
9215: exists($env{'request.course.sec'}) &&
9216: $env{'request.course.sec'} !~ /^\s*$/) {
9217: $allowed=&allowed('vgr',$tmp_courseid.
9218: '/'.$env{'request.course.sec'});
9219: }
9220: if ($allowed) {
9221: ($symb)=&get_env_multiple('form.grade_symb');
9222: $courseid=$tmp_courseid;
9223: ($domain)=&get_env_multiple('form.grade_domain');
9224: ($name)=&get_env_multiple('form.grade_username');
9225: return ($symb,$courseid,$domain,$name,$publicuser);
9226: }
9227: }
9228: if (!$passedsymb) {
9229: $symb=&symbread();
9230: } else {
9231: $symb=$passedsymb;
9232: }
9233: $courseid=$env{'request.course.id'};
9234: $domain=$env{'user.domain'};
9235: $name=$env{'user.name'};
9236: if ($name eq 'public' && $domain eq 'public') {
9237: if (!defined($env{'form.username'})) {
9238: $env{'form.username'}.=time.rand(10000000);
9239: }
9240: $name.=$env{'form.username'};
9241: }
9242: return ($symb,$courseid,$domain,$name,$publicuser);
9243:
9244: }
9245:
9246: # ------------------------------------------------------------ Serves up a file
9247: # returns either the contents of the file or
9248: # -1 if the file doesn't exist
9249: #
9250: # if the target is a file that was uploaded via DOCS,
9251: # a check will be made to see if a current copy exists on the local server,
9252: # if it does this will be served, otherwise a copy will be retrieved from
9253: # the home server for the course and stored in /home/httpd/html/userfiles on
9254: # the local server.
9255:
9256: sub getfile {
9257: my ($file) = @_;
9258: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9259: &repcopy($file);
9260: return &readfile($file);
9261: }
9262:
9263: sub repcopy_userfile {
9264: my ($file)=@_;
9265: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9266: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
9267: my ($cdom,$cnum,$filename) =
9268: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
9269: my $uri="/uploaded/$cdom/$cnum/$filename";
9270: if (-e "$file") {
9271: # we already have a local copy, check it out
9272: my @fileinfo = stat($file);
9273: my $rtncode;
9274: my $info;
9275: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
9276: if ($lwpresp ne 'ok') {
9277: # there is no such file anymore, even though we had a local copy
9278: if ($rtncode eq '404') {
9279: unlink($file);
9280: }
9281: return -1;
9282: }
9283: if ($info < $fileinfo[9]) {
9284: # nice, the file we have is up-to-date, just say okay
9285: return 'ok';
9286: } else {
9287: # the file is outdated, get rid of it
9288: unlink($file);
9289: }
9290: }
9291: # one way or the other, at this point, we don't have the file
9292: # construct the correct path for the file
9293: my @parts = ($cdom,$cnum);
9294: if ($filename =~ m|^(.+)/[^/]+$|) {
9295: push @parts, split(/\//,$1);
9296: }
9297: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9298: foreach my $part (@parts) {
9299: $path .= '/'.$part;
9300: if (!-e $path) {
9301: mkdir($path,0770);
9302: }
9303: }
9304: # now the path exists for sure
9305: # get a user agent
9306: my $ua=new LWP::UserAgent;
9307: my $transferfile=$file.'.in.transfer';
9308: # FIXME: this should flock
9309: if (-e $transferfile) { return 'ok'; }
9310: my $request;
9311: $uri=~s/^\///;
9312: my $homeserver = &homeserver($cnum,$cdom);
9313: my $protocol = $protocol{$homeserver};
9314: $protocol = 'http' if ($protocol ne 'https');
9315: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
9316: my $response=$ua->request($request,$transferfile);
9317: # did it work?
9318: if ($response->is_error()) {
9319: unlink($transferfile);
9320: &logthis("Userfile repcopy failed for $uri");
9321: return -1;
9322: }
9323: # worked, rename the transfer file
9324: rename($transferfile,$file);
9325: return 'ok';
9326: }
9327:
9328: sub tokenwrapper {
9329: my $uri=shift;
9330: $uri=~s|^https?\://([^/]+)||;
9331: $uri=~s|^/||;
9332: $env{'user.environment'}=~/\/([^\/]+)\.id/;
9333: my $token=$1;
9334: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9335: if ($udom && $uname && $file) {
9336: $file=~s|(\?\.*)*$||;
9337: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
9338: my $homeserver = &homeserver($uname,$udom);
9339: my $protocol = $protocol{$homeserver};
9340: $protocol = 'http' if ($protocol ne 'https');
9341: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
9342: (($uri=~/\?/)?'&':'?').'token='.$token.
9343: '&tokenissued='.$perlvar{'lonHostID'};
9344: } else {
9345: return '/adm/notfound.html';
9346: }
9347: }
9348:
9349: # call with reqtype HEAD: get last modification time
9350: # call with reqtype GET: get the file contents
9351: # Do not call this with reqtype GET for large files! It loads everything into memory
9352: #
9353: sub getuploaded {
9354: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9355: $uri=~s/^\///;
9356: my $homeserver = &homeserver($cnum,$cdom);
9357: my $protocol = $protocol{$homeserver};
9358: $protocol = 'http' if ($protocol ne 'https');
9359: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
9360: my $ua=new LWP::UserAgent;
9361: my $request=new HTTP::Request($reqtype,$uri);
9362: my $response=$ua->request($request);
9363: $$rtncode = $response->code;
9364: if (! $response->is_success()) {
9365: return 'failed';
9366: }
9367: if ($reqtype eq 'HEAD') {
9368: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
9369: } elsif ($reqtype eq 'GET') {
9370: $$info = $response->content;
9371: }
9372: return 'ok';
9373: }
9374:
9375: sub readfile {
9376: my $file = shift;
9377: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9378: my $fh;
9379: open($fh,"<$file");
9380: my $a='';
9381: while (my $line = <$fh>) { $a .= $line; }
9382: return $a;
9383: }
9384:
9385: sub filelocation {
9386: my ($dir,$file) = @_;
9387: my $location;
9388: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
9389:
9390: if ($file =~ m-^/adm/-) {
9391: $file=~s-^/adm/wrapper/-/-;
9392: $file=~s-^/adm/coursedocs/showdoc/-/-;
9393: }
9394:
9395: if ($file=~m:^/~:) { # is a contruction space reference
9396: $location = $file;
9397: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
9398: } elsif ($file=~m{^/home/$match_username/public_html/}) {
9399: # is a correct contruction space reference
9400: $location = $file;
9401: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9402: $location = $file;
9403: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
9404: my ($udom,$uname,$filename)=
9405: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
9406: my $home=&homeserver($uname,$udom);
9407: my $is_me=0;
9408: my @ids=¤t_machine_ids();
9409: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9410: if ($is_me) {
9411: $location=&propath($udom,$uname).'/userfiles/'.$filename;
9412: } else {
9413: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9414: $udom.'/'.$uname.'/'.$filename;
9415: }
9416: } elsif ($file =~ m-^/adm/-) {
9417: $location = $perlvar{'lonDocRoot'}.'/'.$file;
9418: } else {
9419: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9420: $file=~s:^/res/:/:;
9421: if ( !( $file =~ m:^/:) ) {
9422: $location = $dir. '/'.$file;
9423: } else {
9424: $location = '/home/httpd/html/res'.$file;
9425: }
9426: }
9427: $location=~s://+:/:g; # remove duplicate /
9428: while ($location=~m{/\.\./}) {
9429: if ($location =~ m{/[^/]+/\.\./}) {
9430: $location=~ s{/[^/]+/\.\./}{/}g;
9431: } else {
9432: $location=~ s{/\.\./}{/}g;
9433: }
9434: } #remove dir/..
9435: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9436: return $location;
9437: }
9438:
9439: sub hreflocation {
9440: my ($dir,$file)=@_;
9441: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
9442: $file=filelocation($dir,$file);
9443: } elsif ($file=~m-^/adm/-) {
9444: $file=~s-^/adm/wrapper/-/-;
9445: $file=~s-^/adm/coursedocs/showdoc/-/-;
9446: }
9447: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9448: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
9449: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9450: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
9451: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
9452: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
9453: -/uploaded/$1/$2/-x;
9454: }
9455: if ($file=~ m{^/userfiles/}) {
9456: $file =~ s{^/userfiles/}{/uploaded/};
9457: }
9458: return $file;
9459: }
9460:
9461: sub current_machine_domains {
9462: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9463: }
9464:
9465: sub machine_domains {
9466: my ($hostname) = @_;
9467: my @domains;
9468: my %hostname = &all_hostnames();
9469: while( my($id, $name) = each(%hostname)) {
9470: # &logthis("-$id-$name-$hostname-");
9471: if ($hostname eq $name) {
9472: push(@domains,&host_domain($id));
9473: }
9474: }
9475: return @domains;
9476: }
9477:
9478: sub current_machine_ids {
9479: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9480: }
9481:
9482: sub machine_ids {
9483: my ($hostname) = @_;
9484: $hostname ||= &hostname($perlvar{'lonHostID'});
9485: my @ids;
9486: my %name_to_host = &all_names();
9487: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9488: return @{ $name_to_host{$hostname} };
9489: }
9490: return;
9491: }
9492:
9493: sub additional_machine_domains {
9494: my @domains;
9495: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9496: while( my $line = <$fh>) {
9497: $line =~ s/\s//g;
9498: push(@domains,$line);
9499: }
9500: return @domains;
9501: }
9502:
9503: sub default_login_domain {
9504: my $domain = $perlvar{'lonDefDomain'};
9505: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9506: foreach my $posdom (¤t_machine_domains(),
9507: &additional_machine_domains()) {
9508: if (lc($posdom) eq lc($testdomain)) {
9509: $domain=$posdom;
9510: last;
9511: }
9512: }
9513: return $domain;
9514: }
9515:
9516: # ------------------------------------------------------------- Declutters URLs
9517:
9518: sub declutter {
9519: my $thisfn=shift;
9520: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
9521: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9522: $thisfn=~s/^\///;
9523: $thisfn=~s|^adm/wrapper/||;
9524: $thisfn=~s|^adm/coursedocs/showdoc/||;
9525: $thisfn=~s/^res\///;
9526: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9527: $thisfn=~s/\?.+$//;
9528: }
9529: return $thisfn;
9530: }
9531:
9532: # ------------------------------------------------------------- Clutter up URLs
9533:
9534: sub clutter {
9535: my $thisfn='/'.&declutter(shift);
9536: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
9537: || $thisfn =~ m{^/adm/(includes|pages)} ) {
9538: $thisfn='/res'.$thisfn;
9539: }
9540: if ($thisfn !~m|^/adm|) {
9541: if ($thisfn =~ m|^/ext/|) {
9542: $thisfn='/adm/wrapper'.$thisfn;
9543: } else {
9544: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9545: my $embstyle=&Apache::loncommon::fileembstyle($ext);
9546: if ($embstyle eq 'ssi'
9547: || ($embstyle eq 'hdn')
9548: || ($embstyle eq 'rat')
9549: || ($embstyle eq 'prv')
9550: || ($embstyle eq 'ign')) {
9551: #do nothing with these
9552: } elsif (($embstyle eq 'img')
9553: || ($embstyle eq 'emb')
9554: || ($embstyle eq 'wrp')) {
9555: $thisfn='/adm/wrapper'.$thisfn;
9556: } elsif ($embstyle eq 'unk'
9557: && $thisfn!~/\.(sequence|page)$/) {
9558: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
9559: } else {
9560: # &logthis("Got a blank emb style");
9561: }
9562: }
9563: }
9564: return $thisfn;
9565: }
9566:
9567: sub clutter_with_no_wrapper {
9568: my $uri = &clutter(shift);
9569: if ($uri =~ m-^/adm/-) {
9570: $uri =~ s-^/adm/wrapper/-/-;
9571: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9572: }
9573: return $uri;
9574: }
9575:
9576: sub freeze_escape {
9577: my ($value)=@_;
9578: if (ref($value)) {
9579: $value=&nfreeze($value);
9580: return '__FROZEN__'.&escape($value);
9581: }
9582: return &escape($value);
9583: }
9584:
9585:
9586: sub thaw_unescape {
9587: my ($value)=@_;
9588: if ($value =~ /^__FROZEN__/) {
9589: substr($value,0,10,undef);
9590: $value=&unescape($value);
9591: return &thaw($value);
9592: }
9593: return &unescape($value);
9594: }
9595:
9596: sub correct_line_ends {
9597: my ($result)=@_;
9598: $$result =~s/\r\n/\n/mg;
9599: $$result =~s/\r/\n/mg;
9600: }
9601: # ================================================================ Main Program
9602:
9603: sub goodbye {
9604: &logthis("Starting Shut down");
9605: #not converted to using infrastruture and probably shouldn't be
9606: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
9607: #converted
9608: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
9609: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9610: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9611: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
9612: #1.1 only
9613: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9614: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9615: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9616: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9617: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
9618: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9619: &logthis(sprintf("%-20s is %s",'hits',$hits));
9620: &flushcourselogs();
9621: &logthis("Shutting down");
9622: }
9623:
9624: sub get_dns {
9625: my ($url,$func,$ignore_cache) = @_;
9626: if (!$ignore_cache) {
9627: my ($content,$cached)=
9628: &Apache::lonnet::is_cached_new('dns',$url);
9629: if ($cached) {
9630: &$func($content);
9631: return;
9632: }
9633: }
9634:
9635: my %alldns;
9636: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9637: foreach my $dns (<$config>) {
9638: next if ($dns !~ /^\^(\S*)/x);
9639: my $line = $1;
9640: my ($host,$protocol) = split(/:/,$line);
9641: if ($protocol ne 'https') {
9642: $protocol = 'http';
9643: }
9644: $alldns{$host} = $protocol;
9645: }
9646: while (%alldns) {
9647: my ($dns) = keys(%alldns);
9648: my $ua=new LWP::UserAgent;
9649: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
9650: my $response=$ua->request($request);
9651: delete($alldns{$dns});
9652: next if ($response->is_error());
9653: my @content = split("\n",$response->content);
9654: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
9655: &$func(\@content);
9656: return;
9657: }
9658: close($config);
9659: my $which = (split('/',$url))[3];
9660: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9661: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
9662: my @content = <$config>;
9663: &$func(\@content);
9664: return;
9665: }
9666: # ------------------------------------------------------------ Read domain file
9667: {
9668: my $loaded;
9669: my %domain;
9670:
9671: sub parse_domain_tab {
9672: my ($lines) = @_;
9673: foreach my $line (@$lines) {
9674: next if ($line =~ /^(\#|\s*$ )/x);
9675:
9676: chomp($line);
9677: my ($name,@elements) = split(/:/,$line,9);
9678: my %this_domain;
9679: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9680: 'lang_def', 'city', 'longi', 'lati',
9681: 'primary') {
9682: $this_domain{$field} = shift(@elements);
9683: }
9684: $domain{$name} = \%this_domain;
9685: }
9686: }
9687:
9688: sub reset_domain_info {
9689: undef($loaded);
9690: undef(%domain);
9691: }
9692:
9693: sub load_domain_tab {
9694: my ($ignore_cache) = @_;
9695: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
9696: my $fh;
9697: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9698: my @lines = <$fh>;
9699: &parse_domain_tab(\@lines);
9700: }
9701: close($fh);
9702: $loaded = 1;
9703: }
9704:
9705: sub domain {
9706: &load_domain_tab() if (!$loaded);
9707:
9708: my ($name,$what) = @_;
9709: return if ( !exists($domain{$name}) );
9710:
9711: if (!$what) {
9712: return $domain{$name}{'description'};
9713: }
9714: return $domain{$name}{$what};
9715: }
9716:
9717: sub domain_info {
9718: &load_domain_tab() if (!$loaded);
9719: return %domain;
9720: }
9721:
9722: }
9723:
9724:
9725: # ------------------------------------------------------------- Read hosts file
9726: {
9727: my %hostname;
9728: my %hostdom;
9729: my %libserv;
9730: my $loaded;
9731: my %name_to_host;
9732:
9733: sub parse_hosts_tab {
9734: my ($file) = @_;
9735: foreach my $configline (@$file) {
9736: next if ($configline =~ /^(\#|\s*$ )/x);
9737: next if ($configline =~ /^\^/);
9738: chomp($configline);
9739: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
9740: $name=~s/\s//g;
9741: if ($id && $domain && $role && $name) {
9742: $hostname{$id}=$name;
9743: push(@{$name_to_host{$name}}, $id);
9744: $hostdom{$id}=$domain;
9745: if ($role eq 'library') { $libserv{$id}=$name; }
9746: if (defined($protocol)) {
9747: if ($protocol eq 'https') {
9748: $protocol{$id} = $protocol;
9749: } else {
9750: $protocol{$id} = 'http';
9751: }
9752: } else {
9753: $protocol{$id} = 'http';
9754: }
9755: }
9756: }
9757: }
9758:
9759: sub reset_hosts_info {
9760: &purge_remembered();
9761: &reset_domain_info();
9762: &reset_hosts_ip_info();
9763: undef(%name_to_host);
9764: undef(%hostname);
9765: undef(%hostdom);
9766: undef(%libserv);
9767: undef($loaded);
9768: }
9769:
9770: sub load_hosts_tab {
9771: my ($ignore_cache) = @_;
9772: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
9773: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9774: my @config = <$config>;
9775: &parse_hosts_tab(\@config);
9776: close($config);
9777: $loaded=1;
9778: }
9779:
9780: sub hostname {
9781: &load_hosts_tab() if (!$loaded);
9782:
9783: my ($lonid) = @_;
9784: return $hostname{$lonid};
9785: }
9786:
9787: sub all_hostnames {
9788: &load_hosts_tab() if (!$loaded);
9789:
9790: return %hostname;
9791: }
9792:
9793: sub all_names {
9794: &load_hosts_tab() if (!$loaded);
9795:
9796: return %name_to_host;
9797: }
9798:
9799: sub all_host_domain {
9800: &load_hosts_tab() if (!$loaded);
9801: return %hostdom;
9802: }
9803:
9804: sub is_library {
9805: &load_hosts_tab() if (!$loaded);
9806:
9807: return exists($libserv{$_[0]});
9808: }
9809:
9810: sub all_library {
9811: &load_hosts_tab() if (!$loaded);
9812:
9813: return %libserv;
9814: }
9815:
9816: sub get_servers {
9817: &load_hosts_tab() if (!$loaded);
9818:
9819: my ($domain,$type) = @_;
9820: my %possible_hosts = ($type eq 'library') ? %libserv
9821: : %hostname;
9822: my %result;
9823: if (ref($domain) eq 'ARRAY') {
9824: while ( my ($host,$hostname) = each(%possible_hosts)) {
9825: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
9826: $result{$host} = $hostname;
9827: }
9828: }
9829: } else {
9830: while ( my ($host,$hostname) = each(%possible_hosts)) {
9831: if ($hostdom{$host} eq $domain) {
9832: $result{$host} = $hostname;
9833: }
9834: }
9835: }
9836: return %result;
9837: }
9838:
9839: sub host_domain {
9840: &load_hosts_tab() if (!$loaded);
9841:
9842: my ($lonid) = @_;
9843: return $hostdom{$lonid};
9844: }
9845:
9846: sub all_domains {
9847: &load_hosts_tab() if (!$loaded);
9848:
9849: my %seen;
9850: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9851: return @uniq;
9852: }
9853: }
9854:
9855: {
9856: my %iphost;
9857: my %name_to_ip;
9858: my %lonid_to_ip;
9859:
9860: sub get_hosts_from_ip {
9861: my ($ip) = @_;
9862: my %iphosts = &get_iphost();
9863: if (ref($iphosts{$ip})) {
9864: return @{$iphosts{$ip}};
9865: }
9866: return;
9867: }
9868:
9869: sub reset_hosts_ip_info {
9870: undef(%iphost);
9871: undef(%name_to_ip);
9872: undef(%lonid_to_ip);
9873: }
9874:
9875: sub get_host_ip {
9876: my ($lonid) = @_;
9877: if (exists($lonid_to_ip{$lonid})) {
9878: return $lonid_to_ip{$lonid};
9879: }
9880: my $name=&hostname($lonid);
9881: my $ip = gethostbyname($name);
9882: return if (!$ip || length($ip) ne 4);
9883: $ip=inet_ntoa($ip);
9884: $name_to_ip{$name} = $ip;
9885: $lonid_to_ip{$lonid} = $ip;
9886: return $ip;
9887: }
9888:
9889: sub get_iphost {
9890: my ($ignore_cache) = @_;
9891:
9892: if (!$ignore_cache) {
9893: if (%iphost) {
9894: return %iphost;
9895: }
9896: my ($ip_info,$cached)=
9897: &Apache::lonnet::is_cached_new('iphost','iphost');
9898: if ($cached) {
9899: %iphost = %{$ip_info->[0]};
9900: %name_to_ip = %{$ip_info->[1]};
9901: %lonid_to_ip = %{$ip_info->[2]};
9902: return %iphost;
9903: }
9904: }
9905:
9906: # get yesterday's info for fallback
9907: my %old_name_to_ip;
9908: my ($ip_info,$cached)=
9909: &Apache::lonnet::is_cached_new('iphost','iphost');
9910: if ($cached) {
9911: %old_name_to_ip = %{$ip_info->[1]};
9912: }
9913:
9914: my %name_to_host = &all_names();
9915: foreach my $name (keys(%name_to_host)) {
9916: my $ip;
9917: if (!exists($name_to_ip{$name})) {
9918: $ip = gethostbyname($name);
9919: if (!$ip || length($ip) ne 4) {
9920: if (defined($old_name_to_ip{$name})) {
9921: $ip = $old_name_to_ip{$name};
9922: &logthis("Can't find $name defaulting to old $ip");
9923: } else {
9924: &logthis("Name $name no IP found");
9925: next;
9926: }
9927: } else {
9928: $ip=inet_ntoa($ip);
9929: }
9930: $name_to_ip{$name} = $ip;
9931: } else {
9932: $ip = $name_to_ip{$name};
9933: }
9934: foreach my $id (@{ $name_to_host{$name} }) {
9935: $lonid_to_ip{$id} = $ip;
9936: }
9937: push(@{$iphost{$ip}},@{$name_to_host{$name}});
9938: }
9939: &Apache::lonnet::do_cache_new('iphost','iphost',
9940: [\%iphost,\%name_to_ip,\%lonid_to_ip],
9941: 48*60*60);
9942:
9943: return %iphost;
9944: }
9945:
9946: #
9947: # Given a DNS returns the loncapa host name for that DNS
9948: #
9949: sub host_from_dns {
9950: my ($dns) = @_;
9951: my @hosts;
9952: my $ip;
9953:
9954: if (exists($name_to_ip{$dns})) {
9955: $ip = $name_to_ip{$dns};
9956: }
9957: if (!$ip) {
9958: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9959: if (length($ip) == 4) {
9960: $ip = &IO::Socket::inet_ntoa($ip);
9961: }
9962: }
9963: if ($ip) {
9964: @hosts = get_hosts_from_ip($ip);
9965: return $hosts[0];
9966: }
9967: return undef;
9968: }
9969:
9970: }
9971:
9972: BEGIN {
9973:
9974: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9975: unless ($readit) {
9976: {
9977: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9978: %perlvar = (%perlvar,%{$configvars});
9979: }
9980:
9981:
9982: # ------------------------------------------------------ Read spare server file
9983: {
9984: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
9985:
9986: while (my $configline=<$config>) {
9987: chomp($configline);
9988: if ($configline) {
9989: my ($host,$type) = split(':',$configline,2);
9990: if (!defined($type) || $type eq '') { $type = 'default' };
9991: push(@{ $spareid{$type} }, $host);
9992: }
9993: }
9994: close($config);
9995: }
9996: # ------------------------------------------------------------ Read permissions
9997: {
9998: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
9999:
10000: while (my $configline=<$config>) {
10001: chomp($configline);
10002: if ($configline) {
10003: my ($role,$perm)=split(/ /,$configline);
10004: if ($perm ne '') { $pr{$role}=$perm; }
10005: }
10006: }
10007: close($config);
10008: }
10009:
10010: # -------------------------------------------- Read plain texts for permissions
10011: {
10012: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
10013:
10014: while (my $configline=<$config>) {
10015: chomp($configline);
10016: if ($configline) {
10017: my ($short,@plain)=split(/:/,$configline);
10018: %{$prp{$short}} = ();
10019: if (@plain > 0) {
10020: $prp{$short}{'std'} = $plain[0];
10021: for (my $i=1; $i<@plain; $i++) {
10022: $prp{$short}{'alt'.$i} = $plain[$i];
10023: }
10024: }
10025: }
10026: }
10027: close($config);
10028: }
10029:
10030: # ---------------------------------------------------------- Read package table
10031: {
10032: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
10033:
10034: while (my $configline=<$config>) {
10035: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
10036: chomp($configline);
10037: my ($short,$plain)=split(/:/,$configline);
10038: my ($pack,$name)=split(/\&/,$short);
10039: if ($plain ne '') {
10040: $packagetab{$pack.'&'.$name.'&name'}=$name;
10041: $packagetab{$short}=$plain;
10042: }
10043: }
10044: close($config);
10045: }
10046:
10047: # ------------- set up temporary directory
10048: {
10049: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
10050:
10051: }
10052:
10053: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
10054: 'compress_threshold'=> 20_000,
10055: });
10056:
10057: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
10058: $dumpcount=0;
10059: $locknum=0;
10060:
10061: &logtouch();
10062: &logthis('<font color="yellow">INFO: Read configuration</font>');
10063: $readit=1;
10064: {
10065: use integer;
10066: my $test=(2**32)+1;
10067: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
10068: &logthis(" Detected 64bit platform ($_64bit)");
10069: }
10070: }
10071: }
10072:
10073: 1;
10074: __END__
10075:
10076: =pod
10077:
10078: =head1 NAME
10079:
10080: Apache::lonnet - Subroutines to ask questions about things in the network.
10081:
10082: =head1 SYNOPSIS
10083:
10084: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
10085:
10086: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
10087:
10088: Common parameters:
10089:
10090: =over 4
10091:
10092: =item *
10093:
10094: $uname : an internal username (if $cname expecting a course Id specifically)
10095:
10096: =item *
10097:
10098: $udom : a domain (if $cdom expecting a course's domain specifically)
10099:
10100: =item *
10101:
10102: $symb : a resource instance identifier
10103:
10104: =item *
10105:
10106: $namespace : the name of a .db file that contains the data needed or
10107: being set.
10108:
10109: =back
10110:
10111: =head1 OVERVIEW
10112:
10113: lonnet provides subroutines which interact with the
10114: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
10115: about classes, users, and resources.
10116:
10117: For many of these objects you can also use this to store data about
10118: them or modify them in various ways.
10119:
10120: =head2 Symbs
10121:
10122: To identify a specific instance of a resource, LON-CAPA uses symbols
10123: or "symbs"X<symb>. These identifiers are built from the URL of the
10124: map, the resource number of the resource in the map, and the URL of
10125: the resource itself. The latter is somewhat redundant, but might help
10126: if maps change.
10127:
10128: An example is
10129:
10130: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
10131:
10132: The respective map entry is
10133:
10134: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10135: title="Problem 2">
10136: </resource>
10137:
10138: Symbs are used by the random number generator, as well as to store and
10139: restore data specific to a certain instance of for example a problem.
10140:
10141: =head2 Storing And Retrieving Data
10142:
10143: X<store()>X<cstore()>X<restore()>Three of the most important functions
10144: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10145: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10146: is is the non-critical message twin of cstore. These functions are for
10147: handlers to store a perl hash to a user's permanent data space in an
10148: easy manner, and to retrieve it again on another call. It is expected
10149: that a handler would use this once at the beginning to retrieve data,
10150: and then again once at the end to send only the new data back.
10151:
10152: The data is stored in the user's data directory on the user's
10153: homeserver under the ID of the course.
10154:
10155: The hash that is returned by restore will have all of the previous
10156: value for all of the elements of the hash.
10157:
10158: Example:
10159:
10160: #creating a hash
10161: my %hash;
10162: $hash{'foo'}='bar';
10163:
10164: #storing it
10165: &Apache::lonnet::cstore(\%hash);
10166:
10167: #changing a value
10168: $hash{'foo'}='notbar';
10169:
10170: #adding a new value
10171: $hash{'bar'}='foo';
10172: &Apache::lonnet::cstore(\%hash);
10173:
10174: #retrieving the hash
10175: my %history=&Apache::lonnet::restore();
10176:
10177: #print the hash
10178: foreach my $key (sort(keys(%history))) {
10179: print("\%history{$key} = $history{$key}");
10180: }
10181:
10182: Will print out:
10183:
10184: %history{1:foo} = bar
10185: %history{1:keys} = foo:timestamp
10186: %history{1:timestamp} = 990455579
10187: %history{2:bar} = foo
10188: %history{2:foo} = notbar
10189: %history{2:keys} = foo:bar:timestamp
10190: %history{2:timestamp} = 990455580
10191: %history{bar} = foo
10192: %history{foo} = notbar
10193: %history{timestamp} = 990455580
10194: %history{version} = 2
10195:
10196: Note that the special hash entries C<keys>, C<version> and
10197: C<timestamp> were added to the hash. C<version> will be equal to the
10198: total number of versions of the data that have been stored. The
10199: C<timestamp> attribute will be the UNIX time the hash was
10200: stored. C<keys> is available in every historical section to list which
10201: keys were added or changed at a specific historical revision of a
10202: hash.
10203:
10204: B<Warning>: do not store the hash that restore returns directly. This
10205: will cause a mess since it will restore the historical keys as if the
10206: were new keys. I.E. 1:foo will become 1:1:foo etc.
10207:
10208: Calling convention:
10209:
10210: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10211: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
10212:
10213: For more detailed information, see lonnet specific documentation.
10214:
10215: =head1 RETURN MESSAGES
10216:
10217: =over 4
10218:
10219: =item * B<con_lost>: unable to contact remote host
10220:
10221: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10222: when the connection is brought back up
10223:
10224: =item * B<con_failed>: unable to contact remote host and unable to save message
10225: for later delivery
10226:
10227: =item * B<error:>: an error a occurred, a description of the error follows the :
10228:
10229: =item * B<no_such_host>: unable to fund a host associated with the user/domain
10230: that was requested
10231:
10232: =back
10233:
10234: =head1 PUBLIC SUBROUTINES
10235:
10236: =head2 Session Environment Functions
10237:
10238: =over 4
10239:
10240: =item *
10241: X<appenv()>
10242: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
10243: the user envirnoment file, and will be restored for each access this
10244: user makes during this session, also modifies the %env for the current
10245: process. Optional rolesarrayref - if defined contains a reference to an array
10246: of roles which are exempt from the restriction on modifying user.role entries
10247: in the user's environment.db and in %env.
10248:
10249: =item *
10250: X<delenv()>
10251: B<delenv($delthis,$regexp)>: removes all items from the session
10252: environment file that begin with $delthis. If the
10253: optional second arg - $regexp - is true, $delthis is treated as a
10254: regular expression, otherwise \Q$delthis\E is used.
10255: The values are also deleted from the current processes %env.
10256:
10257: =item * get_env_multiple($name)
10258:
10259: gets $name from the %env hash, it seemlessly handles the cases where multiple
10260: values may be defined and end up as an array ref.
10261:
10262: returns an array of values
10263:
10264: =back
10265:
10266: =head2 User Information
10267:
10268: =over 4
10269:
10270: =item *
10271: X<queryauthenticate()>
10272: B<queryauthenticate($uname,$udom)>: try to determine user's current
10273: authentication scheme
10274:
10275: =item *
10276: X<authenticate()>
10277: B<authenticate($uname,$upass,$udom)>: try to
10278: authenticate user from domain's lib servers (first use the current
10279: one). C<$upass> should be the users password.
10280:
10281: =item *
10282: X<homeserver()>
10283: B<homeserver($uname,$udom)>: find the server which has
10284: the user's directory and files (there must be only one), this caches
10285: the answer, and also caches if there is a borken connection.
10286:
10287: =item *
10288: X<idget()>
10289: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10290: (IDs are a unique resource in a domain, there must be only 1 ID per
10291: username, and only 1 username per ID in a specific domain) (returns
10292: hash: id=>name,id=>name)
10293:
10294: =item *
10295: X<idrget()>
10296: B<idrget($udom,@unames)>: find the IDs behind a list of
10297: usernames (returns hash: name=>id,name=>id)
10298:
10299: =item *
10300: X<idput()>
10301: B<idput($udom,%ids)>: store away a list of names and associated IDs
10302:
10303: =item *
10304: X<rolesinit()>
10305: B<rolesinit($udom,$username,$authhost)>: get user privileges
10306:
10307: =item *
10308: X<getsection()>
10309: B<getsection($udom,$uname,$cname)>: finds the section of student in the
10310: course $cname, return section name/number or '' for "not in course"
10311: and '-1' for "no section"
10312:
10313: =item *
10314: X<userenvironment()>
10315: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
10316: passed in @what from the requested user's environment, returns a hash
10317:
10318: =item *
10319: X<userlog_query()>
10320: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10321: activity.log file. %filters defines filters applied when parsing the
10322: log file. These can be start or end timestamps, or the type of action
10323: - log to look for Login or Logout events, check for Checkin or
10324: Checkout, role for role selection. The response is in the form
10325: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10326: escaped strings of the action recorded in the activity.log file.
10327:
10328: =back
10329:
10330: =head2 User Roles
10331:
10332: =over 4
10333:
10334: =item *
10335:
10336: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
10337: F: full access
10338: U,I,K: authentication modes (cxx only)
10339: '': forbidden
10340: 1: user needs to choose course
10341: 2: browse allowed
10342: A: passphrase authentication needed
10343:
10344: =item *
10345:
10346: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10347: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10348: and course level
10349:
10350: =item *
10351:
10352: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10353: (rolesplain.tab); plain text explanation of a user role term.
10354: $type is Course (default) or Community.
10355: If $forcedefault evaluates to true, text returned will be default
10356: text for $type. Otherwise, if this is a course, the text returned
10357: will be a custom name for the role (if defined in the course's
10358: environment). If no custom name is defined the default is returned.
10359:
10360: =item *
10361:
10362: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
10363: All arguments are optional. Returns a hash of a roles, either for
10364: co-author/assistant author roles for a user's Construction Space
10365: (default), or if $context is 'userroles', roles for the user himself,
10366: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10367: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10368: For each key, value is set to colon-separated start and end times for
10369: the role. If no username and domain are specified, will default to
10370: current user/domain. Types, roles, and roledoms are references to arrays
10371: of role statuses (active, future or previous), roles
10372: (e.g., cc,in, st etc.) and domains of the roles which can be used
10373: to restrict the list of roles reported. If no array ref is
10374: provided for types, will default to return only active roles.
10375:
10376: =back
10377:
10378: =head2 User Modification
10379:
10380: =over 4
10381:
10382: =item *
10383:
10384: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
10385: user for the level given by URL. Optional start and end dates (leave empty
10386: string or zero for "no date")
10387:
10388: =item *
10389:
10390: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10391: change a users, password, possible return values are: ok,
10392: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10393: refused
10394:
10395: =item *
10396:
10397: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
10398:
10399: =item *
10400:
10401: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
10402: $forceid,$desiredhome,$email,$inststatus,$candelete) :
10403:
10404: will update user information (firstname,middlename,lastname,generation,
10405: permanentemail), and if forceid is true, student/employee ID also.
10406: A user's institutional affiliation(s) can also be updated.
10407: User information fields will not be overwritten with empty entries
10408: unless the field is included in the $candelete array reference.
10409: This array is included when a single user is modified via "Manage Users",
10410: or when Autoupdate.pl is run by cron in a domain.
10411:
10412: =item *
10413:
10414: modifystudent
10415:
10416: modify a student's enrollment and identification information.
10417: The course id is resolved based on the current users environment.
10418: This means the envoking user must be a course coordinator or otherwise
10419: associated with a course.
10420:
10421: This call is essentially a wrapper for lonnet::modifyuser and
10422: lonnet::modify_student_enrollment
10423:
10424: Inputs:
10425:
10426: =over 4
10427:
10428: =item B<$udom> Student's loncapa domain
10429:
10430: =item B<$uname> Student's loncapa login name
10431:
10432: =item B<$uid> Student/Employee ID
10433:
10434: =item B<$umode> Student's authentication mode
10435:
10436: =item B<$upass> Student's password
10437:
10438: =item B<$first> Student's first name
10439:
10440: =item B<$middle> Student's middle name
10441:
10442: =item B<$last> Student's last name
10443:
10444: =item B<$gene> Student's generation
10445:
10446: =item B<$usec> Student's section in course
10447:
10448: =item B<$end> Unix time of the roles expiration
10449:
10450: =item B<$start> Unix time of the roles start date
10451:
10452: =item B<$forceid> If defined, allow $uid to be changed
10453:
10454: =item B<$desiredhome> server to use as home server for student
10455:
10456: =item B<$email> Student's permanent e-mail address
10457:
10458: =item B<$type> Type of enrollment (auto or manual)
10459:
10460: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10461:
10462: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
10463:
10464: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
10465:
10466: =item B<$context> role change context (shown in User Management Logs display in a course)
10467:
10468: =item B<$inststatus> institutional status of user - : separated string of escaped status types
10469:
10470: =back
10471:
10472: =item *
10473:
10474: modify_student_enrollment
10475:
10476: Change a students enrollment status in a class. The environment variable
10477: 'role.request.course' must be defined for this function to proceed.
10478:
10479: Inputs:
10480:
10481: =over 4
10482:
10483: =item $udom, students domain
10484:
10485: =item $uname, students name
10486:
10487: =item $uid, students user id
10488:
10489: =item $first, students first name
10490:
10491: =item $middle
10492:
10493: =item $last
10494:
10495: =item $gene
10496:
10497: =item $usec
10498:
10499: =item $end
10500:
10501: =item $start
10502:
10503: =item $type
10504:
10505: =item $locktype
10506:
10507: =item $cid
10508:
10509: =item $selfenroll
10510:
10511: =item $context
10512:
10513: =back
10514:
10515:
10516: =item *
10517:
10518: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10519: custom role; give a custom role to a user for the level given by URL. Specify
10520: name and domain of role author, and role name
10521:
10522: =item *
10523:
10524: revokerole($udom,$uname,$url,$role) : revoke a role for url
10525:
10526: =item *
10527:
10528: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10529:
10530: =back
10531:
10532: =head2 Course Infomation
10533:
10534: =over 4
10535:
10536: =item *
10537:
10538: coursedescription($courseid) : returns a hash of information about the
10539: specified course id, including all environment settings for the
10540: course, the description of the course will be in the hash under the
10541: key 'description'
10542:
10543: =item *
10544:
10545: resdata($name,$domain,$type,@which) : request for current parameter
10546: setting for a specific $type, where $type is either 'course' or 'user',
10547: @what should be a list of parameters to ask about. This routine caches
10548: answers for 5 minutes.
10549:
10550: =item *
10551:
10552: get_courseresdata($courseid, $domain) : dump the entire course resource
10553: data base, returning a hash that is keyed by the resource name and has
10554: values that are the resource value. I believe that the timestamps and
10555: versions are also returned.
10556:
10557:
10558: =back
10559:
10560: =head2 Course Modification
10561:
10562: =over 4
10563:
10564: =item *
10565:
10566: writecoursepref($courseid,%prefs) : write preferences (environment
10567: database) for a course
10568:
10569: =item *
10570:
10571: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10572:
10573: =item *
10574:
10575: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
10576:
10577: =back
10578:
10579: =head2 Resource Subroutines
10580:
10581: =over 4
10582:
10583: =item *
10584:
10585: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
10586:
10587: =item *
10588:
10589: repcopy($filename) : subscribes to the requested file, and attempts to
10590: replicate from the owning library server, Might return
10591: 'unavailable', 'not_found', 'forbidden', 'ok', or
10592: 'bad_request', also attempts to grab the metadata for the
10593: resource. Expects the local filesystem pathname
10594: (/home/httpd/html/res/....)
10595:
10596: =back
10597:
10598: =head2 Resource Information
10599:
10600: =over 4
10601:
10602: =item *
10603:
10604: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10605: a vairety of different possible values, $varname should be a request
10606: string, and the other parameters can be used to specify who and what
10607: one is asking about.
10608:
10609: Possible values for $varname are environment.lastname (or other item
10610: from the envirnment hash), user.name (or someother aspect about the
10611: user), resource.0.maxtries (or some other part and parameter of a
10612: resource)
10613:
10614: =item *
10615:
10616: directcondval($number) : get current value of a condition; reads from a state
10617: string
10618:
10619: =item *
10620:
10621: condval($condidx) : value of condition index based on state
10622:
10623: =item *
10624:
10625: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10626: resource's metadata, $what should be either a specific key, or either
10627: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10628: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10629:
10630: this function automatically caches all requests
10631:
10632: =item *
10633:
10634: metadata_query($query,$custom,$customshow) : make a metadata query against the
10635: network of library servers; returns file handle of where SQL and regex results
10636: will be stored for query
10637:
10638: =item *
10639:
10640: symbread($filename) : return symbolic list entry (filename argument optional);
10641: returns the data handle
10642:
10643: =item *
10644:
10645: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
10646: a possible symb for the URL in $thisfn, and if is an encryypted
10647: resource that the user accessed using /enc/ returns a 1 on success, 0
10648: on failure, user must be in a course, as it assumes the existance of
10649: the course initial hash, and uses $env('request.course.id'}
10650:
10651:
10652: =item *
10653:
10654: symbclean($symb) : removes versions numbers from a symb, returns the
10655: cleaned symb
10656:
10657: =item *
10658:
10659: is_on_map($uri) : checks if the $uri is somewhere on the current
10660: course map, user must be in a course for it to work.
10661:
10662: =item *
10663:
10664: numval($salt) : return random seed value (addend for rndseed)
10665:
10666: =item *
10667:
10668: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10669: a random seed, all arguments are optional, if they aren't sent it uses the
10670: environment to derive them. Note: if symb isn't sent and it can't get one
10671: from &symbread it will use the current time as its return value
10672:
10673: =item *
10674:
10675: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10676: unfakeable, receipt
10677:
10678: =item *
10679:
10680: receipt() : API to ireceipt working off of env values; given out to users
10681:
10682: =item *
10683:
10684: countacc($url) : count the number of accesses to a given URL
10685:
10686: =item *
10687:
10688: 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
10689:
10690: =item *
10691:
10692: 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)
10693:
10694: =item *
10695:
10696: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
10697:
10698: =item *
10699:
10700: devalidate($symb) : devalidate temporary spreadsheet calculations,
10701: forcing spreadsheet to reevaluate the resource scores next time.
10702:
10703: =back
10704:
10705: =head2 Storing/Retreiving Data
10706:
10707: =over 4
10708:
10709: =item *
10710:
10711: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10712: for this url; hashref needs to be given and should be a \%hashname; the
10713: remaining args aren't required and if they aren't passed or are '' they will
10714: be derived from the env
10715:
10716: =item *
10717:
10718: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10719: uses critical subroutine
10720:
10721: =item *
10722:
10723: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10724: all args are optional
10725:
10726: =item *
10727:
10728: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10729: dumps the complete (or key matching regexp) namespace into a hash
10730: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10731: normally &store()ed into
10732:
10733: $range should be either an integer '100' (give me the first 100
10734: matching records)
10735: or be two integers sperated by a - with no spaces
10736: '30-50' (give me the 30th through the 50th matching
10737: records)
10738:
10739:
10740: =item *
10741:
10742: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10743: replaces a &store() version of data with a replacement set of data
10744: for a particular resource in a namespace passed in the $storehash hash
10745: reference
10746:
10747: =item *
10748:
10749: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10750: works very similar to store/cstore, but all data is stored in a
10751: temporary location and can be reset using tmpreset, $storehash should
10752: be a hash reference, returns nothing on success
10753:
10754: =item *
10755:
10756: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10757: similar to restore, but all data is stored in a temporary location and
10758: can be reset using tmpreset. Returns a hash of values on success,
10759: error string otherwise.
10760:
10761: =item *
10762:
10763: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10764: deltes all keys for $symb form the temporary storage hash.
10765:
10766: =item *
10767:
10768: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10769: reference filled in from namesp ($udom and $uname are optional)
10770:
10771: =item *
10772:
10773: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10774: namesp ($udom and $uname are optional)
10775:
10776: =item *
10777:
10778: dump($namespace,$udom,$uname,$regexp,$range) :
10779: dumps the complete (or key matching regexp) namespace into a hash
10780: ($udom, $uname, $regexp, $range are optional)
10781:
10782: $range should be either an integer '100' (give me the first 100
10783: matching records)
10784: or be two integers sperated by a - with no spaces
10785: '30-50' (give me the 30th through the 50th matching
10786: records)
10787: =item *
10788:
10789: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10790: $store can be a scalar, an array reference, or if the amount to be
10791: incremented is > 1, a hash reference.
10792:
10793: ($udom and $uname are optional)
10794:
10795: =item *
10796:
10797: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10798: ($udom and $uname are optional)
10799:
10800: =item *
10801:
10802: cput($namespace,$storehash,$udom,$uname) : critical put
10803: ($udom and $uname are optional)
10804:
10805: =item *
10806:
10807: newput($namespace,$storehash,$udom,$uname) :
10808:
10809: Attempts to store the items in the $storehash, but only if they don't
10810: currently exist, if this succeeds you can be certain that you have
10811: successfully created a new key value pair in the $namespace db.
10812:
10813:
10814: Args:
10815: $namespace: name of database to store values to
10816: $storehash: hashref to store to the db
10817: $udom: (optional) domain of user containing the db
10818: $uname: (optional) name of user caontaining the db
10819:
10820: Returns:
10821: 'ok' -> succeeded in storing all keys of $storehash
10822: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10823: least <key> already existed in the db (other
10824: requested keys may also already exist)
10825: 'error: <msg>' -> unable to tie the DB or other error occurred
10826: 'con_lost' -> unable to contact request server
10827: 'refused' -> action was not allowed by remote machine
10828:
10829:
10830: =item *
10831:
10832: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10833: reference filled in from namesp (encrypts the return communication)
10834: ($udom and $uname are optional)
10835:
10836: =item *
10837:
10838: log($udom,$name,$home,$message) : write to permanent log for user; use
10839: critical subroutine
10840:
10841: =item *
10842:
10843: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10844: array reference filled in from namespace found in domain level on either
10845: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
10846:
10847: =item *
10848:
10849: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10850: domain level either on specified domain server ($uhome) or primary domain
10851: server ($udom and $uhome are optional)
10852:
10853: =item *
10854:
10855: get_domain_defaults($target_domain) : returns hash with defaults for
10856: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10857: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10858: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10859: Values are retrieved from cache (if current), or from domain's configuration.db
10860: (if available), or lastly from values in lonTabs/dns_domain,tab,
10861: or lonTabs/domain.tab.
10862:
10863: %domdefaults = &get_auth_defaults($target_domain);
10864:
10865: =back
10866:
10867: =head2 Network Status Functions
10868:
10869: =over 4
10870:
10871: =item *
10872:
10873: dirlist($uri) : return directory list based on URI
10874:
10875: =item *
10876:
10877: spareserver() : find server with least workload from spare.tab
10878:
10879:
10880: =item *
10881:
10882: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10883: if there is no corresponding loncapa host.
10884:
10885: =back
10886:
10887:
10888: =head2 Apache Request
10889:
10890: =over 4
10891:
10892: =item *
10893:
10894: ssi($url,%hash) : server side include, does a complete request cycle on url to
10895: localhost, posts hash
10896:
10897: =back
10898:
10899: =head2 Data to String to Data
10900:
10901: =over 4
10902:
10903: =item *
10904:
10905: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10906: and '&' separators, supports elements that are arrayrefs and hashrefs
10907:
10908: =item *
10909:
10910: hashref2str($hashref) : convert a hashref into a string complete with
10911: escaping and '=' and '&' separators, supports elements that are
10912: arrayrefs and hashrefs
10913:
10914: =item *
10915:
10916: arrayref2str($arrayref) : convert an arrayref into a string complete
10917: with escaping and '&' separators, supports elements that are arrayrefs
10918: and hashrefs
10919:
10920: =item *
10921:
10922: str2hash($string) : convert string to hash using unescaping and
10923: splitting on '=' and '&', supports elements that are arrayrefs and
10924: hashrefs
10925:
10926: =item *
10927:
10928: str2array($string) : convert string to hash using unescaping and
10929: splitting on '&', supports elements that are arrayrefs and hashrefs
10930:
10931: =back
10932:
10933: =head2 Logging Routines
10934:
10935: =over 4
10936:
10937: These routines allow one to make log messages in the lonnet.log and
10938: lonnet.perm logfiles.
10939:
10940: =item *
10941:
10942: logtouch() : make sure the logfile, lonnet.log, exists
10943:
10944: =item *
10945:
10946: logthis() : append message to the normal lonnet.log file, it gets
10947: preiodically rolled over and deleted.
10948:
10949: =item *
10950:
10951: logperm() : append a permanent message to lonnet.perm.log, this log
10952: file never gets deleted by any automated portion of the system, only
10953: messages of critical importance should go in here.
10954:
10955: =back
10956:
10957: =head2 General File Helper Routines
10958:
10959: =over 4
10960:
10961: =item *
10962:
10963: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10964: (a) files in /uploaded
10965: (i) If a local copy of the file exists -
10966: compares modification date of local copy with last-modified date for
10967: definitive version stored on home server for course. If local copy is
10968: stale, requests a new version from the home server and stores it.
10969: If the original has been removed from the home server, then local copy
10970: is unlinked.
10971: (ii) If local copy does not exist -
10972: requests the file from the home server and stores it.
10973:
10974: If $caller is 'uploadrep':
10975: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10976: for request for files originally uploaded via DOCS.
10977: - returns 'ok' if fresh local copy now available, -1 otherwise.
10978:
10979: Otherwise:
10980: This indicates a call from the content generation phase of the request.
10981: - returns the entire contents of the file or -1.
10982:
10983: (b) files in /res
10984: - returns the entire contents of a file or -1;
10985: it properly subscribes to and replicates the file if neccessary.
10986:
10987:
10988: =item *
10989:
10990: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10991: reference
10992:
10993: returns either a stat() list of data about the file or an empty list
10994: if the file doesn't exist or couldn't find out about it (connection
10995: problems or user unknown)
10996:
10997: =item *
10998:
10999: filelocation($dir,$file) : returns file system location of a file
11000: based on URI; meant to be "fairly clean" absolute reference, $dir is a
11001: directory that relative $file lookups are to looked in ($dir of /a/dir
11002: and a file of ../bob will become /a/bob)
11003:
11004: =item *
11005:
11006: hreflocation($dir,$file) : returns file system location or a URL; same as
11007: filelocation except for hrefs
11008:
11009: =item *
11010:
11011: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
11012:
11013: =back
11014:
11015: =head2 Usererfile file routines (/uploaded*)
11016:
11017: =over 4
11018:
11019: =item *
11020:
11021: userfileupload(): main rotine for putting a file in a user or course's
11022: filespace, arguments are,
11023:
11024: formname - required - this is the name of the element in $env where the
11025: filename, and the contents of the file to create/modifed exist
11026: the filename is in $env{'form.'.$formname.'.filename'} and the
11027: contents of the file is located in $env{'form.'.$formname}
11028: coursedoc - if true, store the file in the course of the active role
11029: of the current user
11030: subdir - required - subdirectory to put the file in under ../userfiles/
11031: if undefined, it will be placed in "unknown"
11032:
11033: (This routine calls clean_filename() to remove any dangerous
11034: characters from the filename, and then calls finuserfileupload() to
11035: complete the transaction)
11036:
11037: returns either the url of the uploaded file (/uploaded/....) if successful
11038: and /adm/notfound.html if unsuccessful
11039:
11040: =item *
11041:
11042: clean_filename(): routine for cleaing a filename up for storage in
11043: userfile space, argument is:
11044:
11045: filename - proposed filename
11046:
11047: returns: the new clean filename
11048:
11049: =item *
11050:
11051: finishuserfileupload(): routine that creaes and sends the file to
11052: userspace, probably shouldn't be called directly
11053:
11054: docuname: username or courseid of destination for the file
11055: docudom: domain of user/course of destination for the file
11056: formname: same as for userfileupload()
11057: fname: filename (inculding subdirectories) for the file
11058:
11059: returns either the url of the uploaded file (/uploaded/....) if successful
11060: and /adm/notfound.html if unsuccessful
11061:
11062: =item *
11063:
11064: renameuserfile(): renames an existing userfile to a new name
11065:
11066: Args:
11067: docuname: username or courseid of destination for the file
11068: docudom: domain of user/course of destination for the file
11069: old: current file name (including any subdirs under userfiles)
11070: new: desired file name (including any subdirs under userfiles)
11071:
11072: =item *
11073:
11074: mkdiruserfile(): creates a directory is a userfiles dir
11075:
11076: Args:
11077: docuname: username or courseid of destination for the file
11078: docudom: domain of user/course of destination for the file
11079: dir: dir to create (including any subdirs under userfiles)
11080:
11081: =item *
11082:
11083: removeuserfile(): removes a file that exists in userfiles
11084:
11085: Args:
11086: docuname: username or courseid of destination for the file
11087: docudom: domain of user/course of destination for the file
11088: fname: filname to delete (including any subdirs under userfiles)
11089:
11090: =item *
11091:
11092: removeuploadedurl(): convience function for removeuserfile()
11093:
11094: Args:
11095: url: a full /uploaded/... url to delete
11096:
11097: =item *
11098:
11099: get_portfile_permissions():
11100: Args:
11101: domain: domain of user or course contain the portfolio files
11102: user: name of user or num of course contain the portfolio files
11103: Returns:
11104: hashref of a dump of the proper file_permissions.db
11105:
11106:
11107: =item *
11108:
11109: get_access_controls():
11110:
11111: Args:
11112: current_permissions: the hash ref returned from get_portfile_permissions()
11113: group: (optional) the group you want the files associated with
11114: file: (optional) the file you want access info on
11115:
11116: Returns:
11117: a hash (keys are file names) of hashes containing
11118: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
11119: values are XML containing access control settings (see below)
11120:
11121: Internal notes:
11122:
11123: access controls are stored in file_permissions.db as key=value pairs.
11124: key -> path to file/file_name\0uniqueID:scope_end_start
11125: where scope -> public,guest,course,group,domains or users.
11126: end -> UNIX time for end of access (0 -> no end date)
11127: start -> UNIX time for start of access
11128:
11129: value -> XML description of access control
11130: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
11131: <start></start>
11132: <end></end>
11133:
11134: <password></password> for scope type = guest
11135:
11136: <domain></domain> for scope type = course or group
11137: <number></number>
11138: <roles id="">
11139: <role></role>
11140: <access></access>
11141: <section></section>
11142: <group></group>
11143: </roles>
11144:
11145: <dom></dom> for scope type = domains
11146:
11147: <users> for scope type = users
11148: <user>
11149: <uname></uname>
11150: <udom></udom>
11151: </user>
11152: </users>
11153: </scope>
11154:
11155: Access data is also aggregated for each file in an additional key=value pair:
11156: key -> path to file/file_name\0accesscontrol
11157: value -> reference to hash
11158: hash contains key = value pairs
11159: where key = uniqueID:scope_end_start
11160: value = UNIX time record was last updated
11161:
11162: Used to improve speed of look-ups of access controls for each file.
11163:
11164: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11165:
11166: modify_access_controls():
11167:
11168: Modifies access controls for a portfolio file
11169: Args
11170: 1. file name
11171: 2. reference to hash of required changes,
11172: 3. domain
11173: 4. username
11174: where domain,username are the domain of the portfolio owner
11175: (either a user or a course)
11176:
11177: Returns:
11178: 1. result of additions or updates ('ok' or 'error', with error message).
11179: 2. result of deletions ('ok' or 'error', with error message).
11180: 3. reference to hash of any new or updated access controls.
11181: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11182: key = integer (inbound ID)
11183: value = uniqueID
11184:
11185: =back
11186:
11187: =head2 HTTP Helper Routines
11188:
11189: =over 4
11190:
11191: =item *
11192:
11193: escape() : unpack non-word characters into CGI-compatible hex codes
11194:
11195: =item *
11196:
11197: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11198:
11199: =back
11200:
11201: =head1 PRIVATE SUBROUTINES
11202:
11203: =head2 Underlying communication routines (Shouldn't call)
11204:
11205: =over 4
11206:
11207: =item *
11208:
11209: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11210:
11211: =item *
11212:
11213: reply() : uses subreply to send a message to remote machine, logs all failures
11214:
11215: =item *
11216:
11217: critical() : passes a critical message to another server; if cannot
11218: get through then place message in connection buffer directory and
11219: returns con_delayed, if incapable of saving message, returns
11220: con_failed
11221:
11222: =item *
11223:
11224: reconlonc() : tries to reconnect lonc client processes.
11225:
11226: =back
11227:
11228: =head2 Resource Access Logging
11229:
11230: =over 4
11231:
11232: =item *
11233:
11234: flushcourselogs() : flush (save) buffer logs and access logs
11235:
11236: =item *
11237:
11238: courselog($what) : save message for course in hash
11239:
11240: =item *
11241:
11242: courseacclog($what) : save message for course using &courselog(). Perform
11243: special processing for specific resource types (problems, exams, quizzes, etc).
11244:
11245: =item *
11246:
11247: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11248: as a PerlChildExitHandler
11249:
11250: =back
11251:
11252: =head2 Other
11253:
11254: =over 4
11255:
11256: =item *
11257:
11258: symblist($mapname,%newhash) : update symbolic storage links
11259:
11260: =back
11261:
11262: =cut
11263:
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