1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1065 2010/05/22 00:55:08 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: # ------------------------------ Find server with least workload from spare.tab
669:
670: sub spareserver {
671: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
672: my $spare_server;
673: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
674: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
675: : $userloadpercent;
676:
677: foreach my $try_server (@{ $spareid{'primary'} }) {
678: ($spare_server, $lowest_load) =
679: &compare_server_load($try_server, $spare_server, $lowest_load);
680: }
681:
682: my $found_server = ($spare_server ne '' && $lowest_load < 100);
683:
684: if (!$found_server) {
685: foreach my $try_server (@{ $spareid{'default'} }) {
686: ($spare_server, $lowest_load) =
687: &compare_server_load($try_server, $spare_server, $lowest_load);
688: }
689: }
690:
691: if (!$want_server_name) {
692: my $protocol = 'http';
693: if ($protocol{$spare_server} eq 'https') {
694: $protocol = $protocol{$spare_server};
695: }
696: if (defined($spare_server)) {
697: my $hostname = &hostname($spare_server);
698: if (defined($hostname)) {
699: $spare_server = $protocol.'://'.$hostname;
700: }
701: }
702: }
703: return $spare_server;
704: }
705:
706: sub compare_server_load {
707: my ($try_server, $spare_server, $lowest_load) = @_;
708:
709: my $loadans = &reply('load', $try_server);
710: my $userloadans = &reply('userload',$try_server);
711:
712: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
713: next; #didn't get a number from the server
714: }
715:
716: my $load;
717: if ($loadans =~ /\d/) {
718: if ($userloadans =~ /\d/) {
719: #both are numbers, pick the bigger one
720: $load = ($loadans > $userloadans) ? $loadans
721: : $userloadans;
722: } else {
723: $load = $loadans;
724: }
725: } else {
726: $load = $userloadans;
727: }
728:
729: if (($load =~ /\d/) && ($load < $lowest_load)) {
730: $spare_server = $try_server;
731: $lowest_load = $load;
732: }
733: return ($spare_server,$lowest_load);
734: }
735:
736: # --------------------------- ask offload servers if user already has a session
737: sub find_existing_session {
738: my ($udom,$uname) = @_;
739: foreach my $try_server (@{ $spareid{'primary'} },
740: @{ $spareid{'default'} }) {
741: return $try_server if (&has_user_session($try_server, $udom, $uname));
742: }
743: return;
744: }
745:
746: # -------------------------------- ask if server already has a session for user
747: sub has_user_session {
748: my ($lonid,$udom,$uname) = @_;
749: my $result = &reply(join(':','userhassession',
750: map {&escape($_)} ($udom,$uname)),$lonid);
751: return 1 if ($result eq 'ok');
752:
753: return 0;
754: }
755:
756: # --------------------------------------------- Try to change a user's password
757:
758: sub changepass {
759: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
760: $currentpass = &escape($currentpass);
761: $newpass = &escape($newpass);
762: my $lonhost = $perlvar{'lonHostID'};
763: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
764: $server);
765: if (! $answer) {
766: &logthis("No reply on password change request to $server ".
767: "by $uname in domain $udom.");
768: } elsif ($answer =~ "^ok") {
769: &logthis("$uname in $udom successfully changed their password ".
770: "on $server.");
771: } elsif ($answer =~ "^pwchange_failure") {
772: &logthis("$uname in $udom was unable to change their password ".
773: "on $server. The action was blocked by either lcpasswd ".
774: "or pwchange");
775: } elsif ($answer =~ "^non_authorized") {
776: &logthis("$uname in $udom did not get their password correct when ".
777: "attempting to change it on $server.");
778: } elsif ($answer =~ "^auth_mode_error") {
779: &logthis("$uname in $udom attempted to change their password despite ".
780: "not being locally or internally authenticated on $server.");
781: } elsif ($answer =~ "^unknown_user") {
782: &logthis("$uname in $udom attempted to change their password ".
783: "on $server but were unable to because $server is not ".
784: "their home server.");
785: } elsif ($answer =~ "^refused") {
786: &logthis("$server refused to change $uname in $udom password because ".
787: "it was sent an unencrypted request to change the password.");
788: } elsif ($answer =~ "invalid_client") {
789: &logthis("$server refused to change $uname in $udom password because ".
790: "it was a reset by e-mail originating from an invalid server.");
791: }
792: return $answer;
793: }
794:
795: # ----------------------- Try to determine user's current authentication scheme
796:
797: sub queryauthenticate {
798: my ($uname,$udom)=@_;
799: my $uhome=&homeserver($uname,$udom);
800: if (!$uhome) {
801: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
802: return 'no_host';
803: }
804: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
805: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
806: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
807: }
808: return $answer;
809: }
810:
811: # --------- Try to authenticate user from domain's lib servers (first this one)
812:
813: sub authenticate {
814: my ($uname,$upass,$udom,$checkdefauth)=@_;
815: $upass=&escape($upass);
816: $uname= &LONCAPA::clean_username($uname);
817: my $uhome=&homeserver($uname,$udom,1);
818: my $newhome;
819: if ((!$uhome) || ($uhome eq 'no_host')) {
820: # Maybe the machine was offline and only re-appeared again recently?
821: &reconlonc();
822: # One more
823: $uhome=&homeserver($uname,$udom,1);
824: if (($uhome eq 'no_host') && $checkdefauth) {
825: if (defined(&domain($udom,'primary'))) {
826: $newhome=&domain($udom,'primary');
827: }
828: if ($newhome ne '') {
829: $uhome = $newhome;
830: }
831: }
832: if ((!$uhome) || ($uhome eq 'no_host')) {
833: &logthis("User $uname at $udom is unknown in authenticate");
834: return 'no_host';
835: }
836: }
837: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
838: if ($answer eq 'authorized') {
839: if ($newhome) {
840: &logthis("User $uname at $udom authorized by $uhome, but needs account");
841: return 'no_account_on_host';
842: } else {
843: &logthis("User $uname at $udom authorized by $uhome");
844: return $uhome;
845: }
846: }
847: if ($answer eq 'non_authorized') {
848: &logthis("User $uname at $udom rejected by $uhome");
849: return 'no_host';
850: }
851: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
852: return 'no_host';
853: }
854:
855: # ---------------------- Find the homebase for a user from domain's lib servers
856:
857: my %homecache;
858: sub homeserver {
859: my ($uname,$udom,$ignoreBadCache)=@_;
860: my $index="$uname:$udom";
861:
862: if (exists($homecache{$index})) { return $homecache{$index}; }
863:
864: my %servers = &get_servers($udom,'library');
865: foreach my $tryserver (keys(%servers)) {
866: next if ($ignoreBadCache ne 'true' &&
867: exists($badServerCache{$tryserver}));
868:
869: my $answer=reply("home:$udom:$uname",$tryserver);
870: if ($answer eq 'found') {
871: delete($badServerCache{$tryserver});
872: return $homecache{$index}=$tryserver;
873: } elsif ($answer eq 'no_host') {
874: $badServerCache{$tryserver}=1;
875: }
876: }
877: return 'no_host';
878: }
879:
880: # ------------------------------------- Find the usernames behind a list of IDs
881:
882: sub idget {
883: my ($udom,@ids)=@_;
884: my %returnhash=();
885:
886: my %servers = &get_servers($udom,'library');
887: foreach my $tryserver (keys(%servers)) {
888: my $idlist=join('&',@ids);
889: $idlist=~tr/A-Z/a-z/;
890: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
891: my @answer=();
892: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
893: @answer=split(/\&/,$reply);
894: } ;
895: my $i;
896: for ($i=0;$i<=$#ids;$i++) {
897: if ($answer[$i]) {
898: $returnhash{$ids[$i]}=$answer[$i];
899: }
900: }
901: }
902: return %returnhash;
903: }
904:
905: # ------------------------------------- Find the IDs behind a list of usernames
906:
907: sub idrget {
908: my ($udom,@unames)=@_;
909: my %returnhash=();
910: foreach my $uname (@unames) {
911: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
912: }
913: return %returnhash;
914: }
915:
916: # ------------------------------- Store away a list of names and associated IDs
917:
918: sub idput {
919: my ($udom,%ids)=@_;
920: my %servers=();
921: foreach my $uname (keys(%ids)) {
922: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
923: my $uhom=&homeserver($uname,$udom);
924: if ($uhom ne 'no_host') {
925: my $id=&escape($ids{$uname});
926: $id=~tr/A-Z/a-z/;
927: my $esc_unam=&escape($uname);
928: if ($servers{$uhom}) {
929: $servers{$uhom}.='&'.$id.'='.$esc_unam;
930: } else {
931: $servers{$uhom}=$id.'='.$esc_unam;
932: }
933: }
934: }
935: foreach my $server (keys(%servers)) {
936: &critical('idput:'.$udom.':'.$servers{$server},$server);
937: }
938: }
939:
940: # ------------------------------dump from db file owned by domainconfig user
941: sub dump_dom {
942: my ($namespace,$udom,$regexp,$range)=@_;
943: if (!$udom) {
944: $udom=$env{'user.domain'};
945: }
946: my %returnhash;
947: if ($udom) {
948: my $uname = &get_domainconfiguser($udom);
949: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
950: }
951: return %returnhash;
952: }
953:
954: # ------------------------------------------ get items from domain db files
955:
956: sub get_dom {
957: my ($namespace,$storearr,$udom,$uhome)=@_;
958: my $items='';
959: foreach my $item (@$storearr) {
960: $items.=&escape($item).'&';
961: }
962: $items=~s/\&$//;
963: if (!$udom) {
964: $udom=$env{'user.domain'};
965: if (defined(&domain($udom,'primary'))) {
966: $uhome=&domain($udom,'primary');
967: } else {
968: undef($uhome);
969: }
970: } else {
971: if (!$uhome) {
972: if (defined(&domain($udom,'primary'))) {
973: $uhome=&domain($udom,'primary');
974: }
975: }
976: }
977: if ($udom && $uhome && ($uhome ne 'no_host')) {
978: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
979: my %returnhash;
980: if ($rep eq '' || $rep =~ /^error: 2 /) {
981: return %returnhash;
982: }
983: my @pairs=split(/\&/,$rep);
984: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
985: return @pairs;
986: }
987: my $i=0;
988: foreach my $item (@$storearr) {
989: $returnhash{$item}=&thaw_unescape($pairs[$i]);
990: $i++;
991: }
992: return %returnhash;
993: } else {
994: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
995: }
996: }
997:
998: # -------------------------------------------- put items in domain db files
999:
1000: sub put_dom {
1001: my ($namespace,$storehash,$udom,$uhome)=@_;
1002: if (!$udom) {
1003: $udom=$env{'user.domain'};
1004: if (defined(&domain($udom,'primary'))) {
1005: $uhome=&domain($udom,'primary');
1006: } else {
1007: undef($uhome);
1008: }
1009: } else {
1010: if (!$uhome) {
1011: if (defined(&domain($udom,'primary'))) {
1012: $uhome=&domain($udom,'primary');
1013: }
1014: }
1015: }
1016: if ($udom && $uhome && ($uhome ne 'no_host')) {
1017: my $items='';
1018: foreach my $item (keys(%$storehash)) {
1019: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1020: }
1021: $items=~s/\&$//;
1022: return &reply("putdom:$udom:$namespace:$items",$uhome);
1023: } else {
1024: &logthis("put_dom failed - no homeserver and/or domain");
1025: }
1026: }
1027:
1028: # --------------------- newput for items in db file owned by domainconfig user
1029: sub newput_dom {
1030: my ($namespace,$storehash,$udom) = @_;
1031: my $result;
1032: if (!$udom) {
1033: $udom=$env{'user.domain'};
1034: }
1035: if ($udom) {
1036: my $uname = &get_domainconfiguser($udom);
1037: $result = &newput($namespace,$storehash,$udom,$uname);
1038: }
1039: return $result;
1040: }
1041:
1042: # --------------------- delete for items in db file owned by domainconfig user
1043: sub del_dom {
1044: my ($namespace,$storearr,$udom)=@_;
1045: if (ref($storearr) eq 'ARRAY') {
1046: if (!$udom) {
1047: $udom=$env{'user.domain'};
1048: }
1049: if ($udom) {
1050: my $uname = &get_domainconfiguser($udom);
1051: return &del($namespace,$storearr,$udom,$uname);
1052: }
1053: }
1054: }
1055:
1056: # ----------------------------------construct domainconfig user for a domain
1057: sub get_domainconfiguser {
1058: my ($udom) = @_;
1059: return $udom.'-domainconfig';
1060: }
1061:
1062: sub retrieve_inst_usertypes {
1063: my ($udom) = @_;
1064: my (%returnhash,@order);
1065: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1066: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1067: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1068: %returnhash = %{$domdefs{'inststatustypes'}};
1069: @order = @{$domdefs{'inststatusorder'}};
1070: } else {
1071: if (defined(&domain($udom,'primary'))) {
1072: my $uhome=&domain($udom,'primary');
1073: my $rep=&reply("inst_usertypes:$udom",$uhome);
1074: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1075: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1076: return (\%returnhash,\@order);
1077: }
1078: my ($hashitems,$orderitems) = split(/:/,$rep);
1079: my @pairs=split(/\&/,$hashitems);
1080: foreach my $item (@pairs) {
1081: my ($key,$value)=split(/=/,$item,2);
1082: $key = &unescape($key);
1083: next if ($key =~ /^error: 2 /);
1084: $returnhash{$key}=&thaw_unescape($value);
1085: }
1086: my @esc_order = split(/\&/,$orderitems);
1087: foreach my $item (@esc_order) {
1088: push(@order,&unescape($item));
1089: }
1090: } else {
1091: &logthis("get_dom failed - no primary domain server for $udom");
1092: }
1093: }
1094: return (\%returnhash,\@order);
1095: }
1096:
1097: sub is_domainimage {
1098: my ($url) = @_;
1099: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1100: if (&domain($1) ne '') {
1101: return '1';
1102: }
1103: }
1104: return;
1105: }
1106:
1107: sub inst_directory_query {
1108: my ($srch) = @_;
1109: my $udom = $srch->{'srchdomain'};
1110: my %results;
1111: my $homeserver = &domain($udom,'primary');
1112: my $outcome;
1113: if ($homeserver ne '') {
1114: my $queryid=&reply("querysend:instdirsearch:".
1115: &escape($srch->{'srchby'}).':'.
1116: &escape($srch->{'srchterm'}).':'.
1117: &escape($srch->{'srchtype'}),$homeserver);
1118: my $host=&hostname($homeserver);
1119: if ($queryid !~/^\Q$host\E\_/) {
1120: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1121: return;
1122: }
1123: my $response = &get_query_reply($queryid);
1124: my $maxtries = 5;
1125: my $tries = 1;
1126: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1127: $response = &get_query_reply($queryid);
1128: $tries ++;
1129: }
1130:
1131: if (!&error($response) && $response ne 'refused') {
1132: if ($response eq 'unavailable') {
1133: $outcome = $response;
1134: } else {
1135: $outcome = 'ok';
1136: my @matches = split(/\n/,$response);
1137: foreach my $match (@matches) {
1138: my ($key,$value) = split(/=/,$match);
1139: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1140: }
1141: }
1142: }
1143: }
1144: return ($outcome,%results);
1145: }
1146:
1147: sub usersearch {
1148: my ($srch) = @_;
1149: my $dom = $srch->{'srchdomain'};
1150: my %results;
1151: my %libserv = &all_library();
1152: my $query = 'usersearch';
1153: foreach my $tryserver (keys(%libserv)) {
1154: if (&host_domain($tryserver) eq $dom) {
1155: my $host=&hostname($tryserver);
1156: my $queryid=
1157: &reply("querysend:".&escape($query).':'.
1158: &escape($srch->{'srchby'}).':'.
1159: &escape($srch->{'srchtype'}).':'.
1160: &escape($srch->{'srchterm'}),$tryserver);
1161: if ($queryid !~/^\Q$host\E\_/) {
1162: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1163: next;
1164: }
1165: my $reply = &get_query_reply($queryid);
1166: my $maxtries = 1;
1167: my $tries = 1;
1168: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1169: $reply = &get_query_reply($queryid);
1170: $tries ++;
1171: }
1172: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1173: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1174: } else {
1175: my @matches;
1176: if ($reply =~ /\n/) {
1177: @matches = split(/\n/,$reply);
1178: } else {
1179: @matches = split(/\&/,$reply);
1180: }
1181: foreach my $match (@matches) {
1182: my ($uname,$udom,%userhash);
1183: foreach my $entry (split(/:/,$match)) {
1184: my ($key,$value) =
1185: map {&unescape($_);} split(/=/,$entry);
1186: $userhash{$key} = $value;
1187: if ($key eq 'username') {
1188: $uname = $value;
1189: } elsif ($key eq 'domain') {
1190: $udom = $value;
1191: }
1192: }
1193: $results{$uname.':'.$udom} = \%userhash;
1194: }
1195: }
1196: }
1197: }
1198: return %results;
1199: }
1200:
1201: sub get_instuser {
1202: my ($udom,$uname,$id) = @_;
1203: my $homeserver = &domain($udom,'primary');
1204: my ($outcome,%results);
1205: if ($homeserver ne '') {
1206: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1207: &escape($id).':'.&escape($udom),$homeserver);
1208: my $host=&hostname($homeserver);
1209: if ($queryid !~/^\Q$host\E\_/) {
1210: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1211: return;
1212: }
1213: my $response = &get_query_reply($queryid);
1214: my $maxtries = 5;
1215: my $tries = 1;
1216: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1217: $response = &get_query_reply($queryid);
1218: $tries ++;
1219: }
1220: if (!&error($response) && $response ne 'refused') {
1221: if ($response eq 'unavailable') {
1222: $outcome = $response;
1223: } else {
1224: $outcome = 'ok';
1225: my @matches = split(/\n/,$response);
1226: foreach my $match (@matches) {
1227: my ($key,$value) = split(/=/,$match);
1228: $results{&unescape($key)} = &thaw_unescape($value);
1229: }
1230: }
1231: }
1232: }
1233: my %userinfo;
1234: if (ref($results{$uname}) eq 'HASH') {
1235: %userinfo = %{$results{$uname}};
1236: }
1237: return ($outcome,%userinfo);
1238: }
1239:
1240: sub inst_rulecheck {
1241: my ($udom,$uname,$id,$item,$rules) = @_;
1242: my %returnhash;
1243: if ($udom ne '') {
1244: if (ref($rules) eq 'ARRAY') {
1245: @{$rules} = map {&escape($_);} (@{$rules});
1246: my $rulestr = join(':',@{$rules});
1247: my $homeserver=&domain($udom,'primary');
1248: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1249: my $response;
1250: if ($item eq 'username') {
1251: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1252: ':'.&escape($uname).':'.$rulestr,
1253: $homeserver));
1254: } elsif ($item eq 'id') {
1255: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1256: ':'.&escape($id).':'.$rulestr,
1257: $homeserver));
1258: } elsif ($item eq 'selfcreate') {
1259: $response=&unescape(&reply('instselfcreatecheck:'.
1260: &escape($udom).':'.&escape($uname).
1261: ':'.$rulestr,$homeserver));
1262: }
1263: if ($response ne 'refused') {
1264: my @pairs=split(/\&/,$response);
1265: foreach my $item (@pairs) {
1266: my ($key,$value)=split(/=/,$item,2);
1267: $key = &unescape($key);
1268: next if ($key =~ /^error: 2 /);
1269: $returnhash{$key}=&thaw_unescape($value);
1270: }
1271: }
1272: }
1273: }
1274: }
1275: return %returnhash;
1276: }
1277:
1278: sub inst_userrules {
1279: my ($udom,$check) = @_;
1280: my (%ruleshash,@ruleorder);
1281: if ($udom ne '') {
1282: my $homeserver=&domain($udom,'primary');
1283: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1284: my $response;
1285: if ($check eq 'id') {
1286: $response=&reply('instidrules:'.&escape($udom),
1287: $homeserver);
1288: } elsif ($check eq 'email') {
1289: $response=&reply('instemailrules:'.&escape($udom),
1290: $homeserver);
1291: } else {
1292: $response=&reply('instuserrules:'.&escape($udom),
1293: $homeserver);
1294: }
1295: if (($response ne 'refused') && ($response ne 'error') &&
1296: ($response ne 'unknown_cmd') &&
1297: ($response ne 'no_such_host')) {
1298: my ($hashitems,$orderitems) = split(/:/,$response);
1299: my @pairs=split(/\&/,$hashitems);
1300: foreach my $item (@pairs) {
1301: my ($key,$value)=split(/=/,$item,2);
1302: $key = &unescape($key);
1303: next if ($key =~ /^error: 2 /);
1304: $ruleshash{$key}=&thaw_unescape($value);
1305: }
1306: my @esc_order = split(/\&/,$orderitems);
1307: foreach my $item (@esc_order) {
1308: push(@ruleorder,&unescape($item));
1309: }
1310: }
1311: }
1312: }
1313: return (\%ruleshash,\@ruleorder);
1314: }
1315:
1316: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1317:
1318: sub get_domain_defaults {
1319: my ($domain) = @_;
1320: my $cachetime = 60*60*24;
1321: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1322: if (defined($cached)) {
1323: if (ref($result) eq 'HASH') {
1324: return %{$result};
1325: }
1326: }
1327: my %domdefaults;
1328: my %domconfig =
1329: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1330: 'requestcourses','inststatus',
1331: 'coursedefaults'],$domain);
1332: if (ref($domconfig{'defaults'}) eq 'HASH') {
1333: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1334: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1335: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1336: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1337: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1338: } else {
1339: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1340: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1341: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1342: }
1343: if (ref($domconfig{'quotas'}) eq 'HASH') {
1344: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1345: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1346: } else {
1347: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1348: }
1349: my @usertools = ('aboutme','blog','portfolio');
1350: foreach my $item (@usertools) {
1351: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1352: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1353: }
1354: }
1355: }
1356: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1357: foreach my $item ('official','unofficial','community') {
1358: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1359: }
1360: }
1361: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1362: foreach my $item ('inststatustypes','inststatusorder') {
1363: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1364: }
1365: }
1366: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1367: foreach my $item ('canuse_pdfforms') {
1368: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1369: }
1370: }
1371: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1372: $cachetime);
1373: return %domdefaults;
1374: }
1375:
1376: # --------------------------------------------------- Assign a key to a student
1377:
1378: sub assign_access_key {
1379: #
1380: # a valid key looks like uname:udom#comments
1381: # comments are being appended
1382: #
1383: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1384: $kdom=
1385: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1386: $knum=
1387: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1388: $cdom=
1389: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1390: $cnum=
1391: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1392: $udom=$env{'user.name'} unless (defined($udom));
1393: $uname=$env{'user.domain'} unless (defined($uname));
1394: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1395: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1396: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1397: # assigned to this person
1398: # - this should not happen,
1399: # unless something went wrong
1400: # the first time around
1401: # ready to assign
1402: $logentry=$1.'; '.$logentry;
1403: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1404: $kdom,$knum) eq 'ok') {
1405: # key now belongs to user
1406: my $envkey='key.'.$cdom.'_'.$cnum;
1407: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1408: &appenv({'environment.'.$envkey => $ckey});
1409: return 'ok';
1410: } else {
1411: return
1412: 'error: Count not permanently assign key, will need to be re-entered later.';
1413: }
1414: } else {
1415: return 'error: Could not assign key, try again later.';
1416: }
1417: } elsif (!$existing{$ckey}) {
1418: # the key does not exist
1419: return 'error: The key does not exist';
1420: } else {
1421: # the key is somebody else's
1422: return 'error: The key is already in use';
1423: }
1424: }
1425:
1426: # ------------------------------------------ put an additional comment on a key
1427:
1428: sub comment_access_key {
1429: #
1430: # a valid key looks like uname:udom#comments
1431: # comments are being appended
1432: #
1433: my ($ckey,$cdom,$cnum,$logentry)=@_;
1434: $cdom=
1435: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1436: $cnum=
1437: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1438: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1439: if ($existing{$ckey}) {
1440: $existing{$ckey}.='; '.$logentry;
1441: # ready to assign
1442: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1443: $cdom,$cnum) eq 'ok') {
1444: return 'ok';
1445: } else {
1446: return 'error: Count not store comment.';
1447: }
1448: } else {
1449: # the key does not exist
1450: return 'error: The key does not exist';
1451: }
1452: }
1453:
1454: # ------------------------------------------------------ Generate a set of keys
1455:
1456: sub generate_access_keys {
1457: my ($number,$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: unless (&allowed('mky',$cdom)) { return 0; }
1463: unless (($cdom) && ($cnum)) { return 0; }
1464: if ($number>10000) { return 0; }
1465: sleep(2); # make sure don't get same seed twice
1466: srand(time()^($$+($$<<15))); # from "Programming Perl"
1467: my $total=0;
1468: for (my $i=1;$i<=$number;$i++) {
1469: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1470: sprintf("%lx",int(100000*rand)).'-'.
1471: sprintf("%lx",int(100000*rand));
1472: $newkey=~s/1/g/g; # folks mix up 1 and l
1473: $newkey=~s/0/h/g; # and also 0 and O
1474: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1475: if ($existing{$newkey}) {
1476: $i--;
1477: } else {
1478: if (&put('accesskeys',
1479: { $newkey => '# generated '.localtime().
1480: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1481: '; '.$logentry },
1482: $cdom,$cnum) eq 'ok') {
1483: $total++;
1484: }
1485: }
1486: }
1487: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1488: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1489: return $total;
1490: }
1491:
1492: # ------------------------------------------------------- Validate an accesskey
1493:
1494: sub validate_access_key {
1495: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1496: $cdom=
1497: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1498: $cnum=
1499: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1500: $udom=$env{'user.domain'} unless (defined($udom));
1501: $uname=$env{'user.name'} unless (defined($uname));
1502: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1503: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1504: }
1505:
1506: # ------------------------------------- Find the section of student in a course
1507: sub devalidate_getsection_cache {
1508: my ($udom,$unam,$courseid)=@_;
1509: my $hashid="$udom:$unam:$courseid";
1510: &devalidate_cache_new('getsection',$hashid);
1511: }
1512:
1513: sub courseid_to_courseurl {
1514: my ($courseid) = @_;
1515: #already url style courseid
1516: return $courseid if ($courseid =~ m{^/});
1517:
1518: if (exists($env{'course.'.$courseid.'.num'})) {
1519: my $cnum = $env{'course.'.$courseid.'.num'};
1520: my $cdom = $env{'course.'.$courseid.'.domain'};
1521: return "/$cdom/$cnum";
1522: }
1523:
1524: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1525: if (exists($courseinfo{'num'})) {
1526: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1527: }
1528:
1529: return undef;
1530: }
1531:
1532: sub getsection {
1533: my ($udom,$unam,$courseid)=@_;
1534: my $cachetime=1800;
1535:
1536: my $hashid="$udom:$unam:$courseid";
1537: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1538: if (defined($cached)) { return $result; }
1539:
1540: my %Pending;
1541: my %Expired;
1542: #
1543: # Each role can either have not started yet (pending), be active,
1544: # or have expired.
1545: #
1546: # If there is an active role, we are done.
1547: #
1548: # If there is more than one role which has not started yet,
1549: # choose the one which will start sooner
1550: # If there is one role which has not started yet, return it.
1551: #
1552: # If there is more than one expired role, choose the one which ended last.
1553: # If there is a role which has expired, return it.
1554: #
1555: $courseid = &courseid_to_courseurl($courseid);
1556: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1557: foreach my $key (keys(%roleshash)) {
1558: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1559: my $section=$1;
1560: if ($key eq $courseid.'_st') { $section=''; }
1561: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1562: my $now=time;
1563: if (defined($end) && $end && ($now > $end)) {
1564: $Expired{$end}=$section;
1565: next;
1566: }
1567: if (defined($start) && $start && ($now < $start)) {
1568: $Pending{$start}=$section;
1569: next;
1570: }
1571: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1572: }
1573: #
1574: # Presumedly there will be few matching roles from the above
1575: # loop and the sorting time will be negligible.
1576: if (scalar(keys(%Pending))) {
1577: my ($time) = sort {$a <=> $b} keys(%Pending);
1578: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1579: }
1580: if (scalar(keys(%Expired))) {
1581: my @sorted = sort {$a <=> $b} keys(%Expired);
1582: my $time = pop(@sorted);
1583: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1584: }
1585: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1586: }
1587:
1588: sub save_cache {
1589: &purge_remembered();
1590: #&Apache::loncommon::validate_page();
1591: undef(%env);
1592: undef($env_loaded);
1593: }
1594:
1595: my $to_remember=-1;
1596: my %remembered;
1597: my %accessed;
1598: my $kicks=0;
1599: my $hits=0;
1600: sub make_key {
1601: my ($name,$id) = @_;
1602: if (length($id) > 65
1603: && length(&escape($id)) > 200) {
1604: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1605: }
1606: return &escape($name.':'.$id);
1607: }
1608:
1609: sub devalidate_cache_new {
1610: my ($name,$id,$debug) = @_;
1611: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1612: $id=&make_key($name,$id);
1613: $memcache->delete($id);
1614: delete($remembered{$id});
1615: delete($accessed{$id});
1616: }
1617:
1618: sub is_cached_new {
1619: my ($name,$id,$debug) = @_;
1620: $id=&make_key($name,$id);
1621: if (exists($remembered{$id})) {
1622: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1623: $accessed{$id}=[&gettimeofday()];
1624: $hits++;
1625: return ($remembered{$id},1);
1626: }
1627: my $value = $memcache->get($id);
1628: if (!(defined($value))) {
1629: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1630: return (undef,undef);
1631: }
1632: if ($value eq '__undef__') {
1633: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1634: $value=undef;
1635: }
1636: &make_room($id,$value,$debug);
1637: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1638: return ($value,1);
1639: }
1640:
1641: sub do_cache_new {
1642: my ($name,$id,$value,$time,$debug) = @_;
1643: $id=&make_key($name,$id);
1644: my $setvalue=$value;
1645: if (!defined($setvalue)) {
1646: $setvalue='__undef__';
1647: }
1648: if (!defined($time) ) {
1649: $time=600;
1650: }
1651: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1652: my $result = $memcache->set($id,$setvalue,$time);
1653: if (! $result) {
1654: &logthis("caching of id -> $id failed");
1655: $memcache->disconnect_all();
1656: }
1657: # need to make a copy of $value
1658: &make_room($id,$value,$debug);
1659: return $value;
1660: }
1661:
1662: sub make_room {
1663: my ($id,$value,$debug)=@_;
1664:
1665: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1666: : $value;
1667: if ($to_remember<0) { return; }
1668: $accessed{$id}=[&gettimeofday()];
1669: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1670: my $to_kick;
1671: my $max_time=0;
1672: foreach my $other (keys(%accessed)) {
1673: if (&tv_interval($accessed{$other}) > $max_time) {
1674: $to_kick=$other;
1675: $max_time=&tv_interval($accessed{$other});
1676: }
1677: }
1678: delete($remembered{$to_kick});
1679: delete($accessed{$to_kick});
1680: $kicks++;
1681: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1682: return;
1683: }
1684:
1685: sub purge_remembered {
1686: #&logthis("Tossing ".scalar(keys(%remembered)));
1687: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1688: undef(%remembered);
1689: undef(%accessed);
1690: }
1691: # ------------------------------------- Read an entry from a user's environment
1692:
1693: sub userenvironment {
1694: my ($udom,$unam,@what)=@_;
1695: my $items;
1696: foreach my $item (@what) {
1697: $items.=&escape($item).'&';
1698: }
1699: $items=~s/\&$//;
1700: my %returnhash=();
1701: my $uhome = &homeserver($unam,$udom);
1702: unless ($uhome eq 'no_host') {
1703: my @answer=split(/\&/,
1704: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1705: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
1706: return %returnhash;
1707: }
1708: my $i;
1709: for ($i=0;$i<=$#what;$i++) {
1710: $returnhash{$what[$i]}=&unescape($answer[$i]);
1711: }
1712: }
1713: return %returnhash;
1714: }
1715:
1716: # ---------------------------------------------------------- Get a studentphoto
1717: sub studentphoto {
1718: my ($udom,$unam,$ext) = @_;
1719: my $home=&Apache::lonnet::homeserver($unam,$udom);
1720: if (defined($env{'request.course.id'})) {
1721: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1722: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1723: return(&retrievestudentphoto($udom,$unam,$ext));
1724: } else {
1725: my ($result,$perm_reqd)=
1726: &Apache::lonnet::auto_photo_permission($unam,$udom);
1727: if ($result eq 'ok') {
1728: if (!($perm_reqd eq 'yes')) {
1729: return(&retrievestudentphoto($udom,$unam,$ext));
1730: }
1731: }
1732: }
1733: }
1734: } else {
1735: my ($result,$perm_reqd) =
1736: &Apache::lonnet::auto_photo_permission($unam,$udom);
1737: if ($result eq 'ok') {
1738: if (!($perm_reqd eq 'yes')) {
1739: return(&retrievestudentphoto($udom,$unam,$ext));
1740: }
1741: }
1742: }
1743: return '/adm/lonKaputt/lonlogo_broken.gif';
1744: }
1745:
1746: sub retrievestudentphoto {
1747: my ($udom,$unam,$ext,$type) = @_;
1748: my $home=&Apache::lonnet::homeserver($unam,$udom);
1749: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1750: if ($ret eq 'ok') {
1751: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1752: if ($type eq 'thumbnail') {
1753: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1754: }
1755: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1756: return $tokenurl;
1757: } else {
1758: if ($type eq 'thumbnail') {
1759: return '/adm/lonKaputt/genericstudent_tn.gif';
1760: } else {
1761: return '/adm/lonKaputt/lonlogo_broken.gif';
1762: }
1763: }
1764: }
1765:
1766: # -------------------------------------------------------------------- New chat
1767:
1768: sub chatsend {
1769: my ($newentry,$anon,$group)=@_;
1770: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1771: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1772: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1773: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1774: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1775: &escape($newentry)).':'.$group,$chome);
1776: }
1777:
1778: # ------------------------------------------ Find current version of a resource
1779:
1780: sub getversion {
1781: my $fname=&clutter(shift);
1782: unless ($fname=~/^\/res\//) { return -1; }
1783: return ¤tversion(&filelocation('',$fname));
1784: }
1785:
1786: sub currentversion {
1787: my $fname=shift;
1788: my ($result,$cached)=&is_cached_new('resversion',$fname);
1789: if (defined($cached)) { return $result; }
1790: my $author=$fname;
1791: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1792: my ($udom,$uname)=split(/\//,$author);
1793: my $home=homeserver($uname,$udom);
1794: if ($home eq 'no_host') {
1795: return -1;
1796: }
1797: my $answer=reply("currentversion:$fname",$home);
1798: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1799: return -1;
1800: }
1801: return &do_cache_new('resversion',$fname,$answer,600);
1802: }
1803:
1804: # ----------------------------- Subscribe to a resource, return URL if possible
1805:
1806: sub subscribe {
1807: my $fname=shift;
1808: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1809: $fname=~s/[\n\r]//g;
1810: my $author=$fname;
1811: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1812: my ($udom,$uname)=split(/\//,$author);
1813: my $home=homeserver($uname,$udom);
1814: if ($home eq 'no_host') {
1815: return 'not_found';
1816: }
1817: my $answer=reply("sub:$fname",$home);
1818: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1819: $answer.=' by '.$home;
1820: }
1821: return $answer;
1822: }
1823:
1824: # -------------------------------------------------------------- Replicate file
1825:
1826: sub repcopy {
1827: my $filename=shift;
1828: $filename=~s/\/+/\//g;
1829: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1830: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1831: if ($filename=~m|^/home/httpd/html/userfiles/| or
1832: $filename=~m -^/*(uploaded|editupload)/-) {
1833: return &repcopy_userfile($filename);
1834: }
1835: $filename=~s/[\n\r]//g;
1836: my $transname="$filename.in.transfer";
1837: # FIXME: this should flock
1838: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1839: my $remoteurl=subscribe($filename);
1840: if ($remoteurl =~ /^con_lost by/) {
1841: &logthis("Subscribe returned $remoteurl: $filename");
1842: return 'unavailable';
1843: } elsif ($remoteurl eq 'not_found') {
1844: #&logthis("Subscribe returned not_found: $filename");
1845: return 'not_found';
1846: } elsif ($remoteurl =~ /^rejected by/) {
1847: &logthis("Subscribe returned $remoteurl: $filename");
1848: return 'forbidden';
1849: } elsif ($remoteurl eq 'directory') {
1850: return 'ok';
1851: } else {
1852: my $author=$filename;
1853: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1854: my ($udom,$uname)=split(/\//,$author);
1855: my $home=homeserver($uname,$udom);
1856: unless ($home eq $perlvar{'lonHostID'}) {
1857: my @parts=split(/\//,$filename);
1858: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1859: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1860: &logthis("Malconfiguration for replication: $filename");
1861: return 'bad_request';
1862: }
1863: my $count;
1864: for ($count=5;$count<$#parts;$count++) {
1865: $path.="/$parts[$count]";
1866: if ((-e $path)!=1) {
1867: mkdir($path,0777);
1868: }
1869: }
1870: my $ua=new LWP::UserAgent;
1871: my $request=new HTTP::Request('GET',"$remoteurl");
1872: my $response=$ua->request($request,$transname);
1873: if ($response->is_error()) {
1874: unlink($transname);
1875: my $message=$response->status_line;
1876: &logthis("<font color=\"blue\">WARNING:"
1877: ." LWP get: $message: $filename</font>");
1878: return 'unavailable';
1879: } else {
1880: if ($remoteurl!~/\.meta$/) {
1881: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1882: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1883: if ($mresponse->is_error()) {
1884: unlink($filename.'.meta');
1885: &logthis(
1886: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1887: }
1888: }
1889: rename($transname,$filename);
1890: return 'ok';
1891: }
1892: }
1893: }
1894: }
1895:
1896: # ------------------------------------------------ Get server side include body
1897: sub ssi_body {
1898: my ($filelink,%form)=@_;
1899: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1900: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1901: }
1902: my $output='';
1903: my $response;
1904: if ($filelink=~/^https?\:/) {
1905: ($output,$response)=&externalssi($filelink);
1906: } else {
1907: $filelink .= $filelink=~/\?/ ? '&' : '?';
1908: $filelink .= 'inhibitmenu=yes';
1909: ($output,$response)=&ssi($filelink,%form);
1910: }
1911: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1912: $output=~s/^.*?\<body[^\>]*\>//si;
1913: $output=~s/\<\/body\s*\>.*?$//si;
1914: if (wantarray) {
1915: return ($output, $response);
1916: } else {
1917: return $output;
1918: }
1919: }
1920:
1921: # --------------------------------------------------------- Server Side Include
1922:
1923: sub absolute_url {
1924: my ($host_name) = @_;
1925: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1926: if ($host_name eq '') {
1927: $host_name = $ENV{'SERVER_NAME'};
1928: }
1929: return $protocol.$host_name;
1930: }
1931:
1932: #
1933: # Server side include.
1934: # Parameters:
1935: # fn Possibly encrypted resource name/id.
1936: # form Hash that describes how the rendering should be done
1937: # and other things.
1938: # Returns:
1939: # Scalar context: The content of the response.
1940: # Array context: 2 element list of the content and the full response object.
1941: #
1942: sub ssi {
1943:
1944: my ($fn,%form)=@_;
1945: my $ua=new LWP::UserAgent;
1946: my $request;
1947:
1948: $form{'no_update_last_known'}=1;
1949: &Apache::lonenc::check_encrypt(\$fn);
1950: if (%form) {
1951: $request=new HTTP::Request('POST',&absolute_url().$fn);
1952: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1953: } else {
1954: $request=new HTTP::Request('GET',&absolute_url().$fn);
1955: }
1956:
1957: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1958: my $response=$ua->request($request);
1959:
1960: if (wantarray) {
1961: return ($response->content, $response);
1962: } else {
1963: return $response->content;
1964: }
1965: }
1966:
1967: sub externalssi {
1968: my ($url)=@_;
1969: my $ua=new LWP::UserAgent;
1970: my $request=new HTTP::Request('GET',$url);
1971: my $response=$ua->request($request);
1972: if (wantarray) {
1973: return ($response->content, $response);
1974: } else {
1975: return $response->content;
1976: }
1977: }
1978:
1979: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1980:
1981: sub allowuploaded {
1982: my ($srcurl,$url)=@_;
1983: $url=&clutter(&declutter($url));
1984: my $dir=$url;
1985: $dir=~s/\/[^\/]+$//;
1986: my %httpref=();
1987: my $httpurl=&hreflocation('',$url);
1988: $httpref{'httpref.'.$httpurl}=$srcurl;
1989: &Apache::lonnet::appenv(\%httpref);
1990: }
1991:
1992: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1993: # input: action, courseID, current domain, intended
1994: # path to file, source of file, instruction to parse file for objects,
1995: # ref to hash for embedded objects,
1996: # ref to hash for codebase of java objects.
1997: #
1998: # output: url to file (if action was uploaddoc),
1999: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2000: #
2001: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2002: # course.
2003: #
2004: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2005: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2006: # course's home server.
2007: #
2008: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2009: # be copied from $source (current location) to
2010: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2011: # and will then be copied to
2012: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2013: # course's home server.
2014: #
2015: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2016: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2017: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2018: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2019: # in course's home server.
2020: #
2021:
2022: sub process_coursefile {
2023: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
2024: my $fetchresult;
2025: my $home=&homeserver($docuname,$docudom);
2026: if ($action eq 'propagate') {
2027: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2028: $home);
2029: } else {
2030: my $fpath = '';
2031: my $fname = $file;
2032: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2033: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2034: my $filepath = &build_filepath($fpath);
2035: if ($action eq 'copy') {
2036: if ($source eq '') {
2037: $fetchresult = 'no source file';
2038: return $fetchresult;
2039: } else {
2040: my $destination = $filepath.'/'.$fname;
2041: rename($source,$destination);
2042: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2043: $home);
2044: }
2045: } elsif ($action eq 'uploaddoc') {
2046: open(my $fh,'>'.$filepath.'/'.$fname);
2047: print $fh $env{'form.'.$source};
2048: close($fh);
2049: if ($parser eq 'parse') {
2050: my $mm = new File::MMagic;
2051: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2052: if ($mime_type eq 'text/html') {
2053: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2054: unless ($parse_result eq 'ok') {
2055: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2056: }
2057: }
2058: }
2059: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2060: $home);
2061: if ($fetchresult eq 'ok') {
2062: return '/uploaded/'.$fpath.'/'.$fname;
2063: } else {
2064: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2065: ' to host '.$home.': '.$fetchresult);
2066: return '/adm/notfound.html';
2067: }
2068: }
2069: }
2070: unless ( $fetchresult eq 'ok') {
2071: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2072: ' to host '.$home.': '.$fetchresult);
2073: }
2074: return $fetchresult;
2075: }
2076:
2077: sub build_filepath {
2078: my ($fpath) = @_;
2079: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2080: unless ($fpath eq '') {
2081: my @parts=split('/',$fpath);
2082: foreach my $part (@parts) {
2083: $filepath.= '/'.$part;
2084: if ((-e $filepath)!=1) {
2085: mkdir($filepath,0777);
2086: }
2087: }
2088: }
2089: return $filepath;
2090: }
2091:
2092: sub store_edited_file {
2093: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2094: my $file = $primary_url;
2095: $file =~ s#^/uploaded/$docudom/$docuname/##;
2096: my $fpath = '';
2097: my $fname = $file;
2098: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2099: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2100: my $filepath = &build_filepath($fpath);
2101: open(my $fh,'>'.$filepath.'/'.$fname);
2102: print $fh $content;
2103: close($fh);
2104: my $home=&homeserver($docuname,$docudom);
2105: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2106: $home);
2107: if ($$fetchresult eq 'ok') {
2108: return '/uploaded/'.$fpath.'/'.$fname;
2109: } else {
2110: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2111: ' to host '.$home.': '.$$fetchresult);
2112: return '/adm/notfound.html';
2113: }
2114: }
2115:
2116: sub clean_filename {
2117: my ($fname,$args)=@_;
2118: # Replace Windows backslashes by forward slashes
2119: $fname=~s/\\/\//g;
2120: if (!$args->{'keep_path'}) {
2121: # Get rid of everything but the actual filename
2122: $fname=~s/^.*\/([^\/]+)$/$1/;
2123: }
2124: # Replace spaces by underscores
2125: $fname=~s/\s+/\_/g;
2126: # Replace all other weird characters by nothing
2127: $fname=~s{[^/\w\.\-]}{}g;
2128: # Replace all .\d. sequences with _\d. so they no longer look like version
2129: # numbers
2130: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2131: return $fname;
2132: }
2133: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2134: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2135: # image with the same aspect ratio as the original, but with dimensions which do
2136: # not exceed $resizewidth and $resizeheight.
2137:
2138: sub resizeImage {
2139: my ($img_path,$resizewidth,$resizeheight) = @_;
2140: my $ima = Image::Magick->new;
2141: my $resized;
2142: if (-e $img_path) {
2143: $ima->Read($img_path);
2144: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2145: my $width = $ima->Get('width');
2146: my $height = $ima->Get('height');
2147: if ($width > $resizewidth) {
2148: my $factor = $width/$resizewidth;
2149: my $newheight = $height/$factor;
2150: $ima->Scale(width=>$resizewidth,height=>$newheight);
2151: $resized = 1;
2152: }
2153: }
2154: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2155: my $width = $ima->Get('width');
2156: my $height = $ima->Get('height');
2157: if ($height > $resizeheight) {
2158: my $factor = $height/$resizeheight;
2159: my $newwidth = $width/$factor;
2160: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2161: $resized = 1;
2162: }
2163: }
2164: if ($resized) {
2165: $ima->Write($img_path);
2166: }
2167: }
2168: return;
2169: }
2170:
2171: # --------------- Take an uploaded file and put it into the userfiles directory
2172: # input: $formname - the contents of the file are in $env{"form.$formname"}
2173: # the desired filenam is in $env{"form.$formname.filename"}
2174: # $coursedoc - if true up to the current course
2175: # if false
2176: # $subdir - directory in userfile to store the file into
2177: # $parser - instruction to parse file for objects ($parser = parse)
2178: # $allfiles - reference to hash for embedded objects
2179: # $codebase - reference to hash for codebase of java objects
2180: # $desuname - username for permanent storage of uploaded file
2181: # $dsetudom - domain for permanaent storage of uploaded file
2182: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2183: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2184: # $resizewidth - width (pixels) to which to resize uploaded image
2185: # $resizeheight - height (pixels) to which to resize uploaded image
2186: #
2187: # output: url of file in userspace, or error: <message>
2188: # or /adm/notfound.html if failure to upload occurse
2189:
2190: sub userfileupload {
2191: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2192: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight)=@_;
2193: if (!defined($subdir)) { $subdir='unknown'; }
2194: my $fname=$env{'form.'.$formname.'.filename'};
2195: $fname=&clean_filename($fname);
2196: # See if there is anything left
2197: unless ($fname) { return 'error: no uploaded file'; }
2198: chop($env{'form.'.$formname});
2199: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2200: my $now = time;
2201: my $filepath = 'tmp/helprequests/'.$now;
2202: my @parts=split(/\//,$filepath);
2203: my $fullpath = $perlvar{'lonDaemons'};
2204: for (my $i=0;$i<@parts;$i++) {
2205: $fullpath .= '/'.$parts[$i];
2206: if ((-e $fullpath)!=1) {
2207: mkdir($fullpath,0777);
2208: }
2209: }
2210: open(my $fh,'>'.$fullpath.'/'.$fname);
2211: print $fh $env{'form.'.$formname};
2212: close($fh);
2213: return $fullpath.'/'.$fname;
2214: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2215: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2216: '_'.$env{'user.domain'}.'/pending';
2217: my @parts=split(/\//,$filepath);
2218: my $fullpath = $perlvar{'lonDaemons'};
2219: for (my $i=0;$i<@parts;$i++) {
2220: $fullpath .= '/'.$parts[$i];
2221: if ((-e $fullpath)!=1) {
2222: mkdir($fullpath,0777);
2223: }
2224: }
2225: open(my $fh,'>'.$fullpath.'/'.$fname);
2226: print $fh $env{'form.'.$formname};
2227: close($fh);
2228: return $fullpath.'/'.$fname;
2229: }
2230: if ($subdir eq 'scantron') {
2231: $fname = 'scantron_orig_'.$fname;
2232: } else {
2233: # Create the directory if not present
2234: $fname="$subdir/$fname";
2235: }
2236: if ($coursedoc) {
2237: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2238: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2239: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2240: return &finishuserfileupload($docuname,$docudom,
2241: $formname,$fname,$parser,$allfiles,
2242: $codebase,$thumbwidth,$thumbheight,
2243: $resizewidth,$resizeheight);
2244: } else {
2245: $fname=$env{'form.folder'}.'/'.$fname;
2246: return &process_coursefile('uploaddoc',$docuname,$docudom,
2247: $fname,$formname,$parser,
2248: $allfiles,$codebase);
2249: }
2250: } elsif (defined($destuname)) {
2251: my $docuname=$destuname;
2252: my $docudom=$destudom;
2253: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2254: $parser,$allfiles,$codebase,
2255: $thumbwidth,$thumbheight,
2256: $resizewidth,$resizeheight);
2257:
2258: } else {
2259: my $docuname=$env{'user.name'};
2260: my $docudom=$env{'user.domain'};
2261: if (exists($env{'form.group'})) {
2262: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2263: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2264: }
2265: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2266: $parser,$allfiles,$codebase,
2267: $thumbwidth,$thumbheight,
2268: $resizewidth,$resizeheight);
2269: }
2270: }
2271:
2272: sub finishuserfileupload {
2273: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2274: $thumbwidth,$thumbheight,$resizewidth,$resizeheight) = @_;
2275: my $path=$docudom.'/'.$docuname.'/';
2276: my $filepath=$perlvar{'lonDocRoot'};
2277:
2278: my ($fnamepath,$file,$fetchthumb);
2279: $file=$fname;
2280: if ($fname=~m|/|) {
2281: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2282: $path.=$fnamepath.'/';
2283: }
2284: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2285: my $count;
2286: for ($count=4;$count<=$#parts;$count++) {
2287: $filepath.="/$parts[$count]";
2288: if ((-e $filepath)!=1) {
2289: mkdir($filepath,0777);
2290: }
2291: }
2292:
2293: # Save the file
2294: {
2295: if (!open(FH,'>'.$filepath.'/'.$file)) {
2296: &logthis('Failed to create '.$filepath.'/'.$file);
2297: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2298: return '/adm/notfound.html';
2299: }
2300: if (!print FH ($env{'form.'.$formname})) {
2301: &logthis('Failed to write to '.$filepath.'/'.$file);
2302: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2303: return '/adm/notfound.html';
2304: }
2305: close(FH);
2306: if ($resizewidth && $resizeheight) {
2307: my $mm = new File::MMagic;
2308: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2309: if ($mime_type =~ m{^image/}) {
2310: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2311: }
2312: }
2313: }
2314: if ($parser eq 'parse') {
2315: my $mm = new File::MMagic;
2316: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2317: if ($mime_type eq 'text/html') {
2318: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2319: $allfiles,$codebase);
2320: unless ($parse_result eq 'ok') {
2321: &logthis('Failed to parse '.$filepath.$file.
2322: ' for embedded media: '.$parse_result);
2323: }
2324: }
2325: }
2326: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2327: my $input = $filepath.'/'.$file;
2328: my $output = $filepath.'/'.'tn-'.$file;
2329: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2330: system("convert -sample $thumbsize $input $output");
2331: if (-e $filepath.'/'.'tn-'.$file) {
2332: $fetchthumb = 1;
2333: }
2334: }
2335:
2336: # Notify homeserver to grep it
2337: #
2338: my $docuhome=&homeserver($docuname,$docudom);
2339: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
2340: if ($fetchresult eq 'ok') {
2341: if ($fetchthumb) {
2342: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2343: if ($thumbresult ne 'ok') {
2344: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2345: $docuhome.': '.$thumbresult);
2346: }
2347: }
2348: #
2349: # Return the URL to it
2350: return '/uploaded/'.$path.$file;
2351: } else {
2352: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2353: ': '.$fetchresult);
2354: return '/adm/notfound.html';
2355: }
2356: }
2357:
2358: sub extract_embedded_items {
2359: my ($fullpath,$allfiles,$codebase,$content) = @_;
2360: my @state = ();
2361: my %javafiles = (
2362: codebase => '',
2363: code => '',
2364: archive => ''
2365: );
2366: my %mediafiles = (
2367: src => '',
2368: movie => '',
2369: );
2370: my $p;
2371: if ($content) {
2372: $p = HTML::LCParser->new($content);
2373: } else {
2374: $p = HTML::LCParser->new($fullpath);
2375: }
2376: while (my $t=$p->get_token()) {
2377: if ($t->[0] eq 'S') {
2378: my ($tagname, $attr) = ($t->[1],$t->[2]);
2379: push(@state, $tagname);
2380: if (lc($tagname) eq 'allow') {
2381: &add_filetype($allfiles,$attr->{'src'},'src');
2382: }
2383: if (lc($tagname) eq 'img') {
2384: &add_filetype($allfiles,$attr->{'src'},'src');
2385: }
2386: if (lc($tagname) eq 'a') {
2387: &add_filetype($allfiles,$attr->{'href'},'href');
2388: }
2389: if (lc($tagname) eq 'script') {
2390: if ($attr->{'archive'} =~ /\.jar$/i) {
2391: &add_filetype($allfiles,$attr->{'archive'},'archive');
2392: } else {
2393: &add_filetype($allfiles,$attr->{'src'},'src');
2394: }
2395: }
2396: if (lc($tagname) eq 'link') {
2397: if (lc($attr->{'rel'}) eq 'stylesheet') {
2398: &add_filetype($allfiles,$attr->{'href'},'href');
2399: }
2400: }
2401: if (lc($tagname) eq 'object' ||
2402: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2403: foreach my $item (keys(%javafiles)) {
2404: $javafiles{$item} = '';
2405: }
2406: }
2407: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2408: my $name = lc($attr->{'name'});
2409: foreach my $item (keys(%javafiles)) {
2410: if ($name eq $item) {
2411: $javafiles{$item} = $attr->{'value'};
2412: last;
2413: }
2414: }
2415: foreach my $item (keys(%mediafiles)) {
2416: if ($name eq $item) {
2417: &add_filetype($allfiles, $attr->{'value'}, 'value');
2418: last;
2419: }
2420: }
2421: }
2422: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2423: foreach my $item (keys(%javafiles)) {
2424: if ($attr->{$item}) {
2425: $javafiles{$item} = $attr->{$item};
2426: last;
2427: }
2428: }
2429: foreach my $item (keys(%mediafiles)) {
2430: if ($attr->{$item}) {
2431: &add_filetype($allfiles,$attr->{$item},$item);
2432: last;
2433: }
2434: }
2435: }
2436: } elsif ($t->[0] eq 'E') {
2437: my ($tagname) = ($t->[1]);
2438: if ($javafiles{'codebase'} ne '') {
2439: $javafiles{'codebase'} .= '/';
2440: }
2441: if (lc($tagname) eq 'applet' ||
2442: lc($tagname) eq 'object' ||
2443: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2444: ) {
2445: foreach my $item (keys(%javafiles)) {
2446: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2447: my $file=$javafiles{'codebase'}.$javafiles{$item};
2448: &add_filetype($allfiles,$file,$item);
2449: }
2450: }
2451: }
2452: pop @state;
2453: }
2454: }
2455: return 'ok';
2456: }
2457:
2458: sub add_filetype {
2459: my ($allfiles,$file,$type)=@_;
2460: if (exists($allfiles->{$file})) {
2461: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2462: push(@{$allfiles->{$file}}, &escape($type));
2463: }
2464: } else {
2465: @{$allfiles->{$file}} = (&escape($type));
2466: }
2467: }
2468:
2469: sub removeuploadedurl {
2470: my ($url)=@_;
2471: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
2472: return &removeuserfile($uname,$udom,$fname);
2473: }
2474:
2475: sub removeuserfile {
2476: my ($docuname,$docudom,$fname)=@_;
2477: my $home=&homeserver($docuname,$docudom);
2478: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
2479: if ($result eq 'ok') {
2480: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2481: my $metafile = $fname.'.meta';
2482: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
2483: my $url = "/uploaded/$docudom/$docuname/$fname";
2484: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2485: my $sqlresult =
2486: &update_portfolio_table($docuname,$docudom,$file,
2487: 'portfolio_metadata',$group,
2488: 'delete');
2489: }
2490: }
2491: return $result;
2492: }
2493:
2494: sub mkdiruserfile {
2495: my ($docuname,$docudom,$dir)=@_;
2496: my $home=&homeserver($docuname,$docudom);
2497: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2498: }
2499:
2500: sub renameuserfile {
2501: my ($docuname,$docudom,$old,$new)=@_;
2502: my $home=&homeserver($docuname,$docudom);
2503: my $result = &reply("renameuserfile:$docudom:$docuname:".
2504: &escape("$old").':'.&escape("$new"),$home);
2505: if ($result eq 'ok') {
2506: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2507: my $oldmeta = $old.'.meta';
2508: my $newmeta = $new.'.meta';
2509: my $metaresult =
2510: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
2511: my $url = "/uploaded/$docudom/$docuname/$old";
2512: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
2513: my $sqlresult =
2514: &update_portfolio_table($docuname,$docudom,$file,
2515: 'portfolio_metadata',$group,
2516: 'delete');
2517: }
2518: }
2519: return $result;
2520: }
2521:
2522: # ------------------------------------------------------------------------- Log
2523:
2524: sub log {
2525: my ($dom,$nam,$hom,$what)=@_;
2526: return critical("log:$dom:$nam:$what",$hom);
2527: }
2528:
2529: # ------------------------------------------------------------------ Course Log
2530: #
2531: # This routine flushes several buffers of non-mission-critical nature
2532: #
2533:
2534: sub flushcourselogs {
2535: &logthis('Flushing log buffers');
2536: #
2537: # course logs
2538: # This is a log of all transactions in a course, which can be used
2539: # for data mining purposes
2540: #
2541: # It also collects the courseid database, which lists last transaction
2542: # times and course titles for all courseids
2543: #
2544: my %courseidbuffer=();
2545: foreach my $crsid (keys(%courselogs)) {
2546: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
2547: &escape($courselogs{$crsid}),
2548: $coursehombuf{$crsid}) eq 'ok') {
2549: delete $courselogs{$crsid};
2550: } else {
2551: &logthis('Failed to flush log buffer for '.$crsid);
2552: if (length($courselogs{$crsid})>40000) {
2553: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
2554: " exceeded maximum size, deleting.</font>");
2555: delete $courselogs{$crsid};
2556: }
2557: }
2558: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
2559: 'description' => $coursedescrbuf{$crsid},
2560: 'inst_code' => $courseinstcodebuf{$crsid},
2561: 'type' => $coursetypebuf{$crsid},
2562: 'owner' => $courseownerbuf{$crsid},
2563: };
2564: }
2565: #
2566: # Write course id database (reverse lookup) to homeserver of courses
2567: # Is used in pickcourse
2568: #
2569: foreach my $crs_home (keys(%courseidbuffer)) {
2570: my $response = &courseidput(&host_domain($crs_home),
2571: $courseidbuffer{$crs_home},
2572: $crs_home,'timeonly');
2573: }
2574: #
2575: # File accesses
2576: # Writes to the dynamic metadata of resources to get hit counts, etc.
2577: #
2578: foreach my $entry (keys(%accesshash)) {
2579: if ($entry =~ /___count$/) {
2580: my ($dom,$name);
2581: ($dom,$name,undef)=
2582: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
2583: if (! defined($dom) || $dom eq '' ||
2584: ! defined($name) || $name eq '') {
2585: my $cid = $env{'request.course.id'};
2586: $dom = $env{'request.'.$cid.'.domain'};
2587: $name = $env{'request.'.$cid.'.num'};
2588: }
2589: my $value = $accesshash{$entry};
2590: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2591: my %temphash=($url => $value);
2592: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2593: if ($result eq 'ok') {
2594: delete $accesshash{$entry};
2595: } elsif ($result eq 'unknown_cmd') {
2596: # Target server has old code running on it.
2597: my %temphash=($entry => $value);
2598: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2599: delete $accesshash{$entry};
2600: }
2601: }
2602: } else {
2603: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
2604: my %temphash=($entry => $accesshash{$entry});
2605: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2606: delete $accesshash{$entry};
2607: }
2608: }
2609: }
2610: #
2611: # Roles
2612: # Reverse lookup of user roles for course faculty/staff and co-authorship
2613: #
2614: foreach my $entry (keys(%userrolehash)) {
2615: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
2616: split(/\:/,$entry);
2617: if (&Apache::lonnet::put('nohist_userroles',
2618: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
2619: $rudom,$runame) eq 'ok') {
2620: delete $userrolehash{$entry};
2621: }
2622: }
2623: #
2624: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2625: #
2626: my %domrolebuffer = ();
2627: foreach my $entry (keys(%domainrolehash)) {
2628: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
2629: if ($domrolebuffer{$rudom}) {
2630: $domrolebuffer{$rudom}.='&'.&escape($entry).
2631: '='.&escape($domainrolehash{$entry});
2632: } else {
2633: $domrolebuffer{$rudom}.=&escape($entry).
2634: '='.&escape($domainrolehash{$entry});
2635: }
2636: delete $domainrolehash{$entry};
2637: }
2638: foreach my $dom (keys(%domrolebuffer)) {
2639: my %servers = &get_servers($dom,'library');
2640: foreach my $tryserver (keys(%servers)) {
2641: unless (&reply('domroleput:'.$dom.':'.
2642: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2643: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2644: }
2645: }
2646: }
2647: $dumpcount++;
2648: }
2649:
2650: sub courselog {
2651: my $what=shift;
2652: $what=time.':'.$what;
2653: unless ($env{'request.course.id'}) { return ''; }
2654: $coursedombuf{$env{'request.course.id'}}=
2655: $env{'course.'.$env{'request.course.id'}.'.domain'};
2656: $coursenumbuf{$env{'request.course.id'}}=
2657: $env{'course.'.$env{'request.course.id'}.'.num'};
2658: $coursehombuf{$env{'request.course.id'}}=
2659: $env{'course.'.$env{'request.course.id'}.'.home'};
2660: $coursedescrbuf{$env{'request.course.id'}}=
2661: $env{'course.'.$env{'request.course.id'}.'.description'};
2662: $courseinstcodebuf{$env{'request.course.id'}}=
2663: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2664: $courseownerbuf{$env{'request.course.id'}}=
2665: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
2666: $coursetypebuf{$env{'request.course.id'}}=
2667: $env{'course.'.$env{'request.course.id'}.'.type'};
2668: if (defined $courselogs{$env{'request.course.id'}}) {
2669: $courselogs{$env{'request.course.id'}}.='&'.$what;
2670: } else {
2671: $courselogs{$env{'request.course.id'}}.=$what;
2672: }
2673: if (length($courselogs{$env{'request.course.id'}})>4048) {
2674: &flushcourselogs();
2675: }
2676: }
2677:
2678: sub courseacclog {
2679: my $fnsymb=shift;
2680: unless ($env{'request.course.id'}) { return ''; }
2681: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
2682: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
2683: $what.=':POST';
2684: # FIXME: Probably ought to escape things....
2685: foreach my $key (keys(%env)) {
2686: if ($key=~/^form\.(.*)/) {
2687: my $formitem = $1;
2688: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2689: $what.=':'.$formitem.'='.$env{$key};
2690: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2691: $what.=':'.$formitem.'='.$env{$key};
2692: }
2693: }
2694: }
2695: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2696: # FIXME: We should not be depending on a form parameter that someone
2697: # editing lonsearchcat.pm might change in the future.
2698: if ($env{'form.phase'} eq 'course_search') {
2699: $what.= ':POST';
2700: # FIXME: Probably ought to escape things....
2701: foreach my $element ('courseexp','crsfulltext','crsrelated',
2702: 'crsdiscuss') {
2703: $what.=':'.$element.'='.$env{'form.'.$element};
2704: }
2705: }
2706: }
2707: &courselog($what);
2708: }
2709:
2710: sub countacc {
2711: my $url=&declutter(shift);
2712: return if (! defined($url) || $url eq '');
2713: unless ($env{'request.course.id'}) { return ''; }
2714: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
2715: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
2716: $accesshash{$key}++;
2717: }
2718:
2719: sub linklog {
2720: my ($from,$to)=@_;
2721: $from=&declutter($from);
2722: $to=&declutter($to);
2723: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2724: $accesshash{$to.'___'.$from.'___goto'}=1;
2725: }
2726:
2727: sub userrolelog {
2728: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
2729: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
2730: ($trole=~/^in/) || ($trole=~/^cc/) ||
2731: ($trole=~/^ep/) || ($trole=~/^cr/) ||
2732: ($trole=~/^ta/) || ($trole=~/^co/)) {
2733: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2734: $userrolehash
2735: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2736: =$tend.':'.$tstart;
2737: }
2738: if (($env{'request.role'} =~ /dc\./) &&
2739: (($trole=~/^au/) || ($trole=~/^in/) ||
2740: ($trole=~/^cc/) || ($trole=~/^ep/) ||
2741: ($trole=~/^cr/) || ($trole=~/^ta/) ||
2742: ($trole=~/^co/))) {
2743: $userrolehash
2744: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2745: =$tend.':'.$tstart;
2746: }
2747: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2748: ($trole=~/^li/) || ($trole=~/^li/) ||
2749: ($trole=~/^au/) || ($trole=~/^dg/) ||
2750: ($trole=~/^sc/)) {
2751: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2752: $domainrolehash
2753: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2754: = $tend.':'.$tstart;
2755: }
2756: }
2757:
2758: sub courserolelog {
2759: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2760: if (($trole eq 'cc') || ($trole eq 'in') ||
2761: ($trole eq 'ep') || ($trole eq 'ad') ||
2762: ($trole eq 'ta') || ($trole eq 'st') ||
2763: ($trole=~/^cr/) || ($trole eq 'gr') ||
2764: ($trole eq 'co')) {
2765: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2766: my $cdom = $1;
2767: my $cnum = $2;
2768: my $sec = $3;
2769: my $namespace = 'rolelog';
2770: my %storehash = (
2771: role => $trole,
2772: start => $tstart,
2773: end => $tend,
2774: selfenroll => $selfenroll,
2775: context => $context,
2776: );
2777: if ($trole eq 'gr') {
2778: $namespace = 'groupslog';
2779: $storehash{'group'} = $sec;
2780: } else {
2781: $storehash{'section'} = $sec;
2782: }
2783: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
2784: if (($trole ne 'st') || ($sec ne '')) {
2785: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2786: }
2787: }
2788: }
2789: return;
2790: }
2791:
2792: sub get_course_adv_roles {
2793: my ($cid,$codes) = @_;
2794: $cid=$env{'request.course.id'} unless (defined($cid));
2795: my %coursehash=&coursedescription($cid);
2796: my $crstype = &Apache::loncommon::course_type($cid);
2797: my %nothide=();
2798: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2799: if ($user !~ /:/) {
2800: $nothide{join(':',split(/[\@]/,$user))}=1;
2801: } else {
2802: $nothide{$user}=1;
2803: }
2804: }
2805: my %returnhash=();
2806: my %dumphash=
2807: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2808: my $now=time;
2809: my %privileged;
2810: foreach my $entry (keys(%dumphash)) {
2811: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2812: if (($tstart) && ($tstart<0)) { next; }
2813: if (($tend) && ($tend<$now)) { next; }
2814: if (($tstart) && ($now<$tstart)) { next; }
2815: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2816: if ($username eq '' || $domain eq '') { next; }
2817: unless (ref($privileged{$domain}) eq 'HASH') {
2818: my %dompersonnel =
2819: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2820: $privileged{$domain} = {};
2821: foreach my $server (keys(%dompersonnel)) {
2822: if (ref($dompersonnel{$server}) eq 'HASH') {
2823: foreach my $user (keys(%{$dompersonnel{$server}})) {
2824: my ($trole,$uname,$udom) = split(/:/,$user);
2825: $privileged{$udom}{$uname} = 1;
2826: }
2827: }
2828: }
2829: }
2830: if ((exists($privileged{$domain}{$username})) &&
2831: (!$nothide{$username.':'.$domain})) { next; }
2832: if ($role eq 'cr') { next; }
2833: if ($codes) {
2834: if ($section) { $role .= ':'.$section; }
2835: if ($returnhash{$role}) {
2836: $returnhash{$role}.=','.$username.':'.$domain;
2837: } else {
2838: $returnhash{$role}=$username.':'.$domain;
2839: }
2840: } else {
2841: my $key=&plaintext($role,$crstype);
2842: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
2843: if ($returnhash{$key}) {
2844: $returnhash{$key}.=','.$username.':'.$domain;
2845: } else {
2846: $returnhash{$key}=$username.':'.$domain;
2847: }
2848: }
2849: }
2850: return %returnhash;
2851: }
2852:
2853: sub get_my_roles {
2854: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2855: unless (defined($uname)) { $uname=$env{'user.name'}; }
2856: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2857: my (%dumphash,%nothide);
2858: if ($context eq 'userroles') {
2859: %dumphash = &dump('roles',$udom,$uname);
2860: } else {
2861: %dumphash=
2862: &dump('nohist_userroles',$udom,$uname);
2863: if ($hidepriv) {
2864: my %coursehash=&coursedescription($udom.'_'.$uname);
2865: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2866: if ($user !~ /:/) {
2867: $nothide{join(':',split(/[\@]/,$user))} = 1;
2868: } else {
2869: $nothide{$user} = 1;
2870: }
2871: }
2872: }
2873: }
2874: my %returnhash=();
2875: my $now=time;
2876: my %privileged;
2877: foreach my $entry (keys(%dumphash)) {
2878: my ($role,$tend,$tstart);
2879: if ($context eq 'userroles') {
2880: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2881: } else {
2882: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2883: }
2884: if (($tstart) && ($tstart<0)) { next; }
2885: my $status = 'active';
2886: if (($tend) && ($tend<=$now)) {
2887: $status = 'previous';
2888: }
2889: if (($tstart) && ($now<$tstart)) {
2890: $status = 'future';
2891: }
2892: if (ref($types) eq 'ARRAY') {
2893: if (!grep(/^\Q$status\E$/,@{$types})) {
2894: next;
2895: }
2896: } else {
2897: if ($status ne 'active') {
2898: next;
2899: }
2900: }
2901: my ($rolecode,$username,$domain,$section,$area);
2902: if ($context eq 'userroles') {
2903: ($area,$rolecode) = split(/_/,$entry);
2904: (undef,$domain,$username,$section) = split(/\//,$area);
2905: } else {
2906: ($role,$username,$domain,$section) = split(/\:/,$entry);
2907: }
2908: if (ref($roledoms) eq 'ARRAY') {
2909: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2910: next;
2911: }
2912: }
2913: if (ref($roles) eq 'ARRAY') {
2914: if (!grep(/^\Q$role\E$/,@{$roles})) {
2915: if ($role =~ /^cr\//) {
2916: if (!grep(/^cr$/,@{$roles})) {
2917: next;
2918: }
2919: } else {
2920: next;
2921: }
2922: }
2923: }
2924: if ($hidepriv) {
2925: if ($context eq 'userroles') {
2926: if ((&privileged($username,$domain)) &&
2927: (!$nothide{$username.':'.$domain})) {
2928: next;
2929: }
2930: } else {
2931: unless (ref($privileged{$domain}) eq 'HASH') {
2932: my %dompersonnel =
2933: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2934: $privileged{$domain} = {};
2935: if (keys(%dompersonnel)) {
2936: foreach my $server (keys(%dompersonnel)) {
2937: if (ref($dompersonnel{$server}) eq 'HASH') {
2938: foreach my $user (keys(%{$dompersonnel{$server}})) {
2939: my ($trole,$uname,$udom) = split(/:/,$user);
2940: $privileged{$udom}{$uname} = $trole;
2941: }
2942: }
2943: }
2944: }
2945: }
2946: if (exists($privileged{$domain}{$username})) {
2947: if (!$nothide{$username.':'.$domain}) {
2948: next;
2949: }
2950: }
2951: }
2952: }
2953: if ($withsec) {
2954: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2955: $tstart.':'.$tend;
2956: } else {
2957: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2958: }
2959: }
2960: return %returnhash;
2961: }
2962:
2963: # ----------------------------------------------------- Frontpage Announcements
2964: #
2965: #
2966:
2967: sub postannounce {
2968: my ($server,$text)=@_;
2969: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2970: unless ($text=~/\w/) { $text=''; }
2971: return &reply('setannounce:'.&escape($text),$server);
2972: }
2973:
2974: sub getannounce {
2975:
2976: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2977: my $announcement='';
2978: while (my $line = <$fh>) { $announcement .= $line; }
2979: close($fh);
2980: if ($announcement=~/\w/) {
2981: return
2982: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2983: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2984: } else {
2985: return '';
2986: }
2987: } else {
2988: return '';
2989: }
2990: }
2991:
2992: # ---------------------------------------------------------- Course ID routines
2993: # Deal with domain's nohist_courseid.db files
2994: #
2995:
2996: sub courseidput {
2997: my ($domain,$storehash,$coursehome,$caller) = @_;
2998: return unless (ref($storehash) eq 'HASH');
2999: my $outcome;
3000: if ($caller eq 'timeonly') {
3001: my $cids = '';
3002: foreach my $item (keys(%$storehash)) {
3003: $cids.=&escape($item).'&';
3004: }
3005: $cids=~s/\&$//;
3006: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3007: $coursehome);
3008: } else {
3009: my $items = '';
3010: foreach my $item (keys(%$storehash)) {
3011: $items.= &escape($item).'='.
3012: &freeze_escape($$storehash{$item}).'&';
3013: }
3014: $items=~s/\&$//;
3015: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3016: $coursehome);
3017: }
3018: if ($outcome eq 'unknown_cmd') {
3019: my $what;
3020: foreach my $cid (keys(%$storehash)) {
3021: $what .= &escape($cid).'=';
3022: foreach my $item ('description','inst_code','owner','type') {
3023: $what .= &escape($storehash->{$cid}{$item}).':';
3024: }
3025: $what =~ s/\:$/&/;
3026: }
3027: $what =~ s/\&$//;
3028: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3029: } else {
3030: return $outcome;
3031: }
3032: }
3033:
3034: sub courseiddump {
3035: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3036: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3037: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3038: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
3039: my $as_hash = 1;
3040: my %returnhash;
3041: if (!$domfilter) { $domfilter=''; }
3042: my %libserv = &all_library();
3043: foreach my $tryserver (keys(%libserv)) {
3044: if ( ( $hostidflag == 1
3045: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3046: || (!defined($hostidflag)) ) {
3047:
3048: if (($domfilter eq '') ||
3049: (&host_domain($tryserver) eq $domfilter)) {
3050: my $rep =
3051: &reply('courseiddump:'.&host_domain($tryserver).':'.
3052: $sincefilter.':'.&escape($descfilter).':'.
3053: &escape($instcodefilter).':'.&escape($ownerfilter).
3054: ':'.&escape($coursefilter).':'.&escape($typefilter).
3055: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3056: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3057: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3058: &escape($cc_clone).':'.$cloneonly.':'.
3059: &escape($createdbefore).':'.&escape($createdafter).':'.
3060: &escape($creationcontext),$tryserver);
3061: my @pairs=split(/\&/,$rep);
3062: foreach my $item (@pairs) {
3063: my ($key,$value)=split(/\=/,$item,2);
3064: $key = &unescape($key);
3065: next if ($key =~ /^error: 2 /);
3066: my $result = &thaw_unescape($value);
3067: if (ref($result) eq 'HASH') {
3068: $returnhash{$key}=$result;
3069: } else {
3070: my @responses = split(/:/,$value);
3071: my @items = ('description','inst_code','owner','type');
3072: for (my $i=0; $i<@responses; $i++) {
3073: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3074: }
3075: }
3076: }
3077: }
3078: }
3079: }
3080: return %returnhash;
3081: }
3082:
3083: sub courselastaccess {
3084: my ($cdom,$cnum,$hostidref) = @_;
3085: my %returnhash;
3086: if ($cdom && $cnum) {
3087: my $chome = &homeserver($cnum,$cdom);
3088: if ($chome ne 'no_host') {
3089: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3090: &extract_lastaccess(\%returnhash,$rep);
3091: }
3092: } else {
3093: if (!$cdom) { $cdom=''; }
3094: my %libserv = &all_library();
3095: foreach my $tryserver (keys(%libserv)) {
3096: if (ref($hostidref) eq 'ARRAY') {
3097: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3098: }
3099: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3100: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3101: &extract_lastaccess(\%returnhash,$rep);
3102: }
3103: }
3104: }
3105: return %returnhash;
3106: }
3107:
3108: sub extract_lastaccess {
3109: my ($returnhash,$rep) = @_;
3110: if (ref($returnhash) eq 'HASH') {
3111: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3112: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3113: $rep eq '') {
3114: my @pairs=split(/\&/,$rep);
3115: foreach my $item (@pairs) {
3116: my ($key,$value)=split(/\=/,$item,2);
3117: $key = &unescape($key);
3118: next if ($key =~ /^error: 2 /);
3119: $returnhash->{$key} = &thaw_unescape($value);
3120: }
3121: }
3122: }
3123: return;
3124: }
3125:
3126: # ---------------------------------------------------------- DC e-mail
3127:
3128: sub dcmailput {
3129: my ($domain,$msgid,$message,$server)=@_;
3130: my $status = &Apache::lonnet::critical(
3131: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3132: &escape($message),$server);
3133: return $status;
3134: }
3135:
3136: sub dcmaildump {
3137: my ($dom,$startdate,$enddate,$senders) = @_;
3138: my %returnhash=();
3139:
3140: if (defined(&domain($dom,'primary'))) {
3141: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3142: &escape($enddate).':';
3143: my @esc_senders=map { &escape($_)} @$senders;
3144: $cmd.=&escape(join('&',@esc_senders));
3145: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3146: my ($key,$value) = split(/\=/,$line,2);
3147: if (($key) && ($value)) {
3148: $returnhash{&unescape($key)} = &unescape($value);
3149: }
3150: }
3151: }
3152: return %returnhash;
3153: }
3154: # ---------------------------------------------------------- Domain roles
3155:
3156: sub get_domain_roles {
3157: my ($dom,$roles,$startdate,$enddate)=@_;
3158: if ((!defined($startdate)) || ($startdate eq '')) {
3159: $startdate = '.';
3160: }
3161: if ((!defined($enddate)) || ($enddate eq '')) {
3162: $enddate = '.';
3163: }
3164: my $rolelist;
3165: if (ref($roles) eq 'ARRAY') {
3166: $rolelist = join(':',@{$roles});
3167: }
3168: my %personnel = ();
3169:
3170: my %servers = &get_servers($dom,'library');
3171: foreach my $tryserver (keys(%servers)) {
3172: %{$personnel{$tryserver}}=();
3173: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3174: &escape($startdate).':'.
3175: &escape($enddate).':'.
3176: &escape($rolelist), $tryserver))) {
3177: my ($key,$value) = split(/\=/,$line,2);
3178: if (($key) && ($value)) {
3179: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3180: }
3181: }
3182: }
3183: return %personnel;
3184: }
3185:
3186: # ----------------------------------------------------------- Interval timing
3187:
3188: sub get_first_access {
3189: my ($type,$argsymb)=@_;
3190: my ($symb,$courseid,$udom,$uname)=&whichuser();
3191: if ($argsymb) { $symb=$argsymb; }
3192: my ($map,$id,$res)=&decode_symb($symb);
3193: if ($type eq 'course') {
3194: $res='course';
3195: } elsif ($type eq 'map') {
3196: $res=&symbread($map);
3197: } else {
3198: $res=$symb;
3199: }
3200: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3201: return $times{"$courseid\0$res"};
3202: }
3203:
3204: sub set_first_access {
3205: my ($type)=@_;
3206: my ($symb,$courseid,$udom,$uname)=&whichuser();
3207: my ($map,$id,$res)=&decode_symb($symb);
3208: if ($type eq 'course') {
3209: $res='course';
3210: } elsif ($type eq 'map') {
3211: $res=&symbread($map);
3212: } else {
3213: $res=$symb;
3214: }
3215: my $firstaccess=&get_first_access($type,$symb);
3216: if (!$firstaccess) {
3217: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3218: }
3219: return 'already_set';
3220: }
3221:
3222: # --------------------------------------------- Set Expire Date for Spreadsheet
3223:
3224: sub expirespread {
3225: my ($uname,$udom,$stype,$usymb)=@_;
3226: my $cid=$env{'request.course.id'};
3227: if ($cid) {
3228: my $now=time;
3229: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3230: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3231: $env{'course.'.$cid.'.num'}.
3232: ':nohist_expirationdates:'.
3233: &escape($key).'='.$now,
3234: $env{'course.'.$cid.'.home'})
3235: }
3236: return 'ok';
3237: }
3238:
3239: # ----------------------------------------------------- Devalidate Spreadsheets
3240:
3241: sub devalidate {
3242: my ($symb,$uname,$udom)=@_;
3243: my $cid=$env{'request.course.id'};
3244: if ($cid) {
3245: # delete the stored spreadsheets for
3246: # - the student level sheet of this user in course's homespace
3247: # - the assessment level sheet for this resource
3248: # for this user in user's homespace
3249: # - current conditional state info
3250: my $key=$uname.':'.$udom.':';
3251: my $status=
3252: &del('nohist_calculatedsheets',
3253: [$key.'studentcalc:'],
3254: $env{'course.'.$cid.'.domain'},
3255: $env{'course.'.$cid.'.num'})
3256: .' '.
3257: &del('nohist_calculatedsheets_'.$cid,
3258: [$key.'assesscalc:'.$symb],$udom,$uname);
3259: unless ($status eq 'ok ok') {
3260: &logthis('Could not devalidate spreadsheet '.
3261: $uname.' at '.$udom.' for '.
3262: $symb.': '.$status);
3263: }
3264: &delenv('user.state.'.$cid);
3265: }
3266: }
3267:
3268: sub get_scalar {
3269: my ($string,$end) = @_;
3270: my $value;
3271: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3272: $value = $1;
3273: } elsif ($$string =~ s/^([^&]*?)&//) {
3274: $value = $1;
3275: }
3276: return &unescape($value);
3277: }
3278:
3279: sub array2str {
3280: my (@array) = @_;
3281: my $result=&arrayref2str(\@array);
3282: $result=~s/^__ARRAY_REF__//;
3283: $result=~s/__END_ARRAY_REF__$//;
3284: return $result;
3285: }
3286:
3287: sub arrayref2str {
3288: my ($arrayref) = @_;
3289: my $result='__ARRAY_REF__';
3290: foreach my $elem (@$arrayref) {
3291: if(ref($elem) eq 'ARRAY') {
3292: $result.=&arrayref2str($elem).'&';
3293: } elsif(ref($elem) eq 'HASH') {
3294: $result.=&hashref2str($elem).'&';
3295: } elsif(ref($elem)) {
3296: #print("Got a ref of ".(ref($elem))." skipping.");
3297: } else {
3298: $result.=&escape($elem).'&';
3299: }
3300: }
3301: $result=~s/\&$//;
3302: $result .= '__END_ARRAY_REF__';
3303: return $result;
3304: }
3305:
3306: sub hash2str {
3307: my (%hash) = @_;
3308: my $result=&hashref2str(\%hash);
3309: $result=~s/^__HASH_REF__//;
3310: $result=~s/__END_HASH_REF__$//;
3311: return $result;
3312: }
3313:
3314: sub hashref2str {
3315: my ($hashref)=@_;
3316: my $result='__HASH_REF__';
3317: foreach my $key (sort(keys(%$hashref))) {
3318: if (ref($key) eq 'ARRAY') {
3319: $result.=&arrayref2str($key).'=';
3320: } elsif (ref($key) eq 'HASH') {
3321: $result.=&hashref2str($key).'=';
3322: } elsif (ref($key)) {
3323: $result.='=';
3324: #print("Got a ref of ".(ref($key))." skipping.");
3325: } else {
3326: if ($key) {$result.=&escape($key).'=';} else { last; }
3327: }
3328:
3329: if(ref($hashref->{$key}) eq 'ARRAY') {
3330: $result.=&arrayref2str($hashref->{$key}).'&';
3331: } elsif(ref($hashref->{$key}) eq 'HASH') {
3332: $result.=&hashref2str($hashref->{$key}).'&';
3333: } elsif(ref($hashref->{$key})) {
3334: $result.='&';
3335: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3336: } else {
3337: $result.=&escape($hashref->{$key}).'&';
3338: }
3339: }
3340: $result=~s/\&$//;
3341: $result .= '__END_HASH_REF__';
3342: return $result;
3343: }
3344:
3345: sub str2hash {
3346: my ($string)=@_;
3347: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3348: return %$hash;
3349: }
3350:
3351: sub str2hashref {
3352: my ($string) = @_;
3353:
3354: my %hash;
3355:
3356: if($string !~ /^__HASH_REF__/) {
3357: if (! ($string eq '' || !defined($string))) {
3358: $hash{'error'}='Not hash reference';
3359: }
3360: return (\%hash, $string);
3361: }
3362:
3363: $string =~ s/^__HASH_REF__//;
3364:
3365: while($string !~ /^__END_HASH_REF__/) {
3366: #key
3367: my $key='';
3368: if($string =~ /^__HASH_REF__/) {
3369: ($key, $string)=&str2hashref($string);
3370: if(defined($key->{'error'})) {
3371: $hash{'error'}='Bad data';
3372: return (\%hash, $string);
3373: }
3374: } elsif($string =~ /^__ARRAY_REF__/) {
3375: ($key, $string)=&str2arrayref($string);
3376: if($key->[0] eq 'Array reference error') {
3377: $hash{'error'}='Bad data';
3378: return (\%hash, $string);
3379: }
3380: } else {
3381: $string =~ s/^(.*?)=//;
3382: $key=&unescape($1);
3383: }
3384: $string =~ s/^=//;
3385:
3386: #value
3387: my $value='';
3388: if($string =~ /^__HASH_REF__/) {
3389: ($value, $string)=&str2hashref($string);
3390: if(defined($value->{'error'})) {
3391: $hash{'error'}='Bad data';
3392: return (\%hash, $string);
3393: }
3394: } elsif($string =~ /^__ARRAY_REF__/) {
3395: ($value, $string)=&str2arrayref($string);
3396: if($value->[0] eq 'Array reference error') {
3397: $hash{'error'}='Bad data';
3398: return (\%hash, $string);
3399: }
3400: } else {
3401: $value=&get_scalar(\$string,'__END_HASH_REF__');
3402: }
3403: $string =~ s/^&//;
3404:
3405: $hash{$key}=$value;
3406: }
3407:
3408: $string =~ s/^__END_HASH_REF__//;
3409:
3410: return (\%hash, $string);
3411: }
3412:
3413: sub str2array {
3414: my ($string)=@_;
3415: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3416: return @$array;
3417: }
3418:
3419: sub str2arrayref {
3420: my ($string) = @_;
3421: my @array;
3422:
3423: if($string !~ /^__ARRAY_REF__/) {
3424: if (! ($string eq '' || !defined($string))) {
3425: $array[0]='Array reference error';
3426: }
3427: return (\@array, $string);
3428: }
3429:
3430: $string =~ s/^__ARRAY_REF__//;
3431:
3432: while($string !~ /^__END_ARRAY_REF__/) {
3433: my $value='';
3434: if($string =~ /^__HASH_REF__/) {
3435: ($value, $string)=&str2hashref($string);
3436: if(defined($value->{'error'})) {
3437: $array[0] ='Array reference error';
3438: return (\@array, $string);
3439: }
3440: } elsif($string =~ /^__ARRAY_REF__/) {
3441: ($value, $string)=&str2arrayref($string);
3442: if($value->[0] eq 'Array reference error') {
3443: $array[0] ='Array reference error';
3444: return (\@array, $string);
3445: }
3446: } else {
3447: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3448: }
3449: $string =~ s/^&//;
3450:
3451: push(@array, $value);
3452: }
3453:
3454: $string =~ s/^__END_ARRAY_REF__//;
3455:
3456: return (\@array, $string);
3457: }
3458:
3459: # -------------------------------------------------------------------Temp Store
3460:
3461: sub tmpreset {
3462: my ($symb,$namespace,$domain,$stuname) = @_;
3463: if (!$symb) {
3464: $symb=&symbread();
3465: if (!$symb) { $symb= $env{'request.url'}; }
3466: }
3467: $symb=escape($symb);
3468:
3469: if (!$namespace) { $namespace=$env{'request.state'}; }
3470: $namespace=~s/\//\_/g;
3471: $namespace=~s/\W//g;
3472:
3473: if (!$domain) { $domain=$env{'user.domain'}; }
3474: if (!$stuname) { $stuname=$env{'user.name'}; }
3475: if ($domain eq 'public' && $stuname eq 'public') {
3476: $stuname=$ENV{'REMOTE_ADDR'};
3477: }
3478: my $path=$perlvar{'lonDaemons'}.'/tmp';
3479: my %hash;
3480: if (tie(%hash,'GDBM_File',
3481: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3482: &GDBM_WRCREAT(),0640)) {
3483: foreach my $key (keys(%hash)) {
3484: if ($key=~ /:$symb/) {
3485: delete($hash{$key});
3486: }
3487: }
3488: }
3489: }
3490:
3491: sub tmpstore {
3492: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3493:
3494: if (!$symb) {
3495: $symb=&symbread();
3496: if (!$symb) { $symb= $env{'request.url'}; }
3497: }
3498: $symb=escape($symb);
3499:
3500: if (!$namespace) {
3501: # I don't think we would ever want to store this for a course.
3502: # it seems this will only be used if we don't have a course.
3503: #$namespace=$env{'request.course.id'};
3504: #if (!$namespace) {
3505: $namespace=$env{'request.state'};
3506: #}
3507: }
3508: $namespace=~s/\//\_/g;
3509: $namespace=~s/\W//g;
3510: if (!$domain) { $domain=$env{'user.domain'}; }
3511: if (!$stuname) { $stuname=$env{'user.name'}; }
3512: if ($domain eq 'public' && $stuname eq 'public') {
3513: $stuname=$ENV{'REMOTE_ADDR'};
3514: }
3515: my $now=time;
3516: my %hash;
3517: my $path=$perlvar{'lonDaemons'}.'/tmp';
3518: if (tie(%hash,'GDBM_File',
3519: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3520: &GDBM_WRCREAT(),0640)) {
3521: $hash{"version:$symb"}++;
3522: my $version=$hash{"version:$symb"};
3523: my $allkeys='';
3524: foreach my $key (keys(%$storehash)) {
3525: $allkeys.=$key.':';
3526: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3527: }
3528: $hash{"$version:$symb:timestamp"}=$now;
3529: $allkeys.='timestamp';
3530: $hash{"$version:keys:$symb"}=$allkeys;
3531: if (untie(%hash)) {
3532: return 'ok';
3533: } else {
3534: return "error:$!";
3535: }
3536: } else {
3537: return "error:$!";
3538: }
3539: }
3540:
3541: # -----------------------------------------------------------------Temp Restore
3542:
3543: sub tmprestore {
3544: my ($symb,$namespace,$domain,$stuname) = @_;
3545:
3546: if (!$symb) {
3547: $symb=&symbread();
3548: if (!$symb) { $symb= $env{'request.url'}; }
3549: }
3550: $symb=escape($symb);
3551:
3552: if (!$namespace) { $namespace=$env{'request.state'}; }
3553:
3554: if (!$domain) { $domain=$env{'user.domain'}; }
3555: if (!$stuname) { $stuname=$env{'user.name'}; }
3556: if ($domain eq 'public' && $stuname eq 'public') {
3557: $stuname=$ENV{'REMOTE_ADDR'};
3558: }
3559: my %returnhash;
3560: $namespace=~s/\//\_/g;
3561: $namespace=~s/\W//g;
3562: my %hash;
3563: my $path=$perlvar{'lonDaemons'}.'/tmp';
3564: if (tie(%hash,'GDBM_File',
3565: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3566: &GDBM_READER(),0640)) {
3567: my $version=$hash{"version:$symb"};
3568: $returnhash{'version'}=$version;
3569: my $scope;
3570: for ($scope=1;$scope<=$version;$scope++) {
3571: my $vkeys=$hash{"$scope:keys:$symb"};
3572: my @keys=split(/:/,$vkeys);
3573: my $key;
3574: $returnhash{"$scope:keys"}=$vkeys;
3575: foreach $key (@keys) {
3576: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3577: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3578: }
3579: }
3580: if (!(untie(%hash))) {
3581: return "error:$!";
3582: }
3583: } else {
3584: return "error:$!";
3585: }
3586: return %returnhash;
3587: }
3588:
3589: # ----------------------------------------------------------------------- Store
3590:
3591: sub store {
3592: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3593: my $home='';
3594:
3595: if ($stuname) { $home=&homeserver($stuname,$domain); }
3596:
3597: $symb=&symbclean($symb);
3598: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3599:
3600: if (!$domain) { $domain=$env{'user.domain'}; }
3601: if (!$stuname) { $stuname=$env{'user.name'}; }
3602:
3603: &devalidate($symb,$stuname,$domain);
3604:
3605: $symb=escape($symb);
3606: if (!$namespace) {
3607: unless ($namespace=$env{'request.course.id'}) {
3608: return '';
3609: }
3610: }
3611: if (!$home) { $home=$env{'user.home'}; }
3612:
3613: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3614: $$storehash{'host'}=$perlvar{'lonHostID'};
3615:
3616: my $namevalue='';
3617: foreach my $key (keys(%$storehash)) {
3618: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3619: }
3620: $namevalue=~s/\&$//;
3621: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3622: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3623: }
3624:
3625: # -------------------------------------------------------------- Critical Store
3626:
3627: sub cstore {
3628: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3629: my $home='';
3630:
3631: if ($stuname) { $home=&homeserver($stuname,$domain); }
3632:
3633: $symb=&symbclean($symb);
3634: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3635:
3636: if (!$domain) { $domain=$env{'user.domain'}; }
3637: if (!$stuname) { $stuname=$env{'user.name'}; }
3638:
3639: &devalidate($symb,$stuname,$domain);
3640:
3641: $symb=escape($symb);
3642: if (!$namespace) {
3643: unless ($namespace=$env{'request.course.id'}) {
3644: return '';
3645: }
3646: }
3647: if (!$home) { $home=$env{'user.home'}; }
3648:
3649: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3650: $$storehash{'host'}=$perlvar{'lonHostID'};
3651:
3652: my $namevalue='';
3653: foreach my $key (keys(%$storehash)) {
3654: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3655: }
3656: $namevalue=~s/\&$//;
3657: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3658: return critical
3659: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3660: }
3661:
3662: # --------------------------------------------------------------------- Restore
3663:
3664: sub restore {
3665: my ($symb,$namespace,$domain,$stuname) = @_;
3666: my $home='';
3667:
3668: if ($stuname) { $home=&homeserver($stuname,$domain); }
3669:
3670: if (!$symb) {
3671: unless ($symb=escape(&symbread())) { return ''; }
3672: } else {
3673: $symb=&escape(&symbclean($symb));
3674: }
3675: if (!$namespace) {
3676: unless ($namespace=$env{'request.course.id'}) {
3677: return '';
3678: }
3679: }
3680: if (!$domain) { $domain=$env{'user.domain'}; }
3681: if (!$stuname) { $stuname=$env{'user.name'}; }
3682: if (!$home) { $home=$env{'user.home'}; }
3683: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3684:
3685: my %returnhash=();
3686: foreach my $line (split(/\&/,$answer)) {
3687: my ($name,$value)=split(/\=/,$line);
3688: $returnhash{&unescape($name)}=&thaw_unescape($value);
3689: }
3690: my $version;
3691: for ($version=1;$version<=$returnhash{'version'};$version++) {
3692: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3693: $returnhash{$item}=$returnhash{$version.':'.$item};
3694: }
3695: }
3696: return %returnhash;
3697: }
3698:
3699: # ---------------------------------------------------------- Course Description
3700:
3701: sub coursedescription {
3702: my ($courseid,$args)=@_;
3703: $courseid=~s/^\///;
3704: $courseid=~s/\_/\//g;
3705: my ($cdomain,$cnum)=split(/\//,$courseid);
3706: my $chome=&homeserver($cnum,$cdomain);
3707: my $normalid=$cdomain.'_'.$cnum;
3708: # need to always cache even if we get errors otherwise we keep
3709: # trying and trying and trying to get the course description.
3710: my %envhash=();
3711: my %returnhash=();
3712:
3713: my $expiretime=600;
3714: if ($env{'request.course.id'} eq $normalid) {
3715: $expiretime=120;
3716: }
3717:
3718: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3719: if (!$args->{'freshen_cache'}
3720: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3721: foreach my $key (keys(%env)) {
3722: next if ($key !~ /^\Q$prefix\E(.*)/);
3723: my ($setting) = $1;
3724: $returnhash{$setting} = $env{$key};
3725: }
3726: return %returnhash;
3727: }
3728:
3729: # get the data agin
3730: if (!$args->{'one_time'}) {
3731: $envhash{'course.'.$normalid.'.last_cache'}=time;
3732: }
3733:
3734: if ($chome ne 'no_host') {
3735: %returnhash=&dump('environment',$cdomain,$cnum);
3736: if (!exists($returnhash{'con_lost'})) {
3737: $returnhash{'home'}= $chome;
3738: $returnhash{'domain'} = $cdomain;
3739: $returnhash{'num'} = $cnum;
3740: if (!defined($returnhash{'type'})) {
3741: $returnhash{'type'} = 'Course';
3742: }
3743: while (my ($name,$value) = each %returnhash) {
3744: $envhash{'course.'.$normalid.'.'.$name}=$value;
3745: }
3746: $returnhash{'url'}=&clutter($returnhash{'url'});
3747: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3748: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3749: $envhash{'course.'.$normalid.'.home'}=$chome;
3750: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3751: $envhash{'course.'.$normalid.'.num'}=$cnum;
3752: }
3753: }
3754: if (!$args->{'one_time'}) {
3755: &appenv(\%envhash);
3756: }
3757: return %returnhash;
3758: }
3759:
3760: # -------------------------------------------------See if a user is privileged
3761:
3762: sub privileged {
3763: my ($username,$domain)=@_;
3764: my $rolesdump=&reply("dump:$domain:$username:roles",
3765: &homeserver($username,$domain));
3766: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3767: ($rolesdump =~ /^error:/)) {
3768: return 0;
3769: }
3770: my $now=time;
3771: if ($rolesdump ne '') {
3772: foreach my $entry (split(/&/,$rolesdump)) {
3773: if ($entry!~/^rolesdef_/) {
3774: my ($area,$role)=split(/=/,$entry);
3775: $area=~s/\_\w\w$//;
3776: my ($trole,$tend,$tstart)=split(/_/,$role);
3777: if (($trole eq 'dc') || ($trole eq 'su')) {
3778: my $active=1;
3779: if ($tend) {
3780: if ($tend<$now) { $active=0; }
3781: }
3782: if ($tstart) {
3783: if ($tstart>$now) { $active=0; }
3784: }
3785: if ($active) { return 1; }
3786: }
3787: }
3788: }
3789: }
3790: return 0;
3791: }
3792:
3793: # -------------------------------------------------------- Get user privileges
3794:
3795: sub rolesinit {
3796: my ($domain,$username,$authhost)=@_;
3797: my $now=time;
3798: my %userroles = ('user.login.time' => $now);
3799: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3800: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3801: ($rolesdump =~ /^error:/)) {
3802: return \%userroles;
3803: }
3804: my %allroles=();
3805: my %allgroups=();
3806: my $group_privs;
3807:
3808: if ($rolesdump ne '') {
3809: foreach my $entry (split(/&/,$rolesdump)) {
3810: if ($entry!~/^rolesdef_/) {
3811: my ($area,$role)=split(/=/,$entry);
3812: $area=~s/\_\w\w$//;
3813: my ($trole,$tend,$tstart,$group_privs);
3814: if ($role=~/^cr/) {
3815: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3816: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3817: ($tend,$tstart)=split('_',$trest);
3818: } else {
3819: $trole=$role;
3820: }
3821: } elsif ($role =~ m|^gr/|) {
3822: ($trole,$tend,$tstart) = split(/_/,$role);
3823: ($trole,$group_privs) = split(/\//,$trole);
3824: $group_privs = &unescape($group_privs);
3825: } else {
3826: ($trole,$tend,$tstart)=split(/_/,$role);
3827: }
3828: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3829: $username);
3830: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3831: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3832: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3833: if (($area ne '') && ($trole ne '')) {
3834: my $spec=$trole.'.'.$area;
3835: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3836: if ($trole =~ /^cr\//) {
3837: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3838: } elsif ($trole eq 'gr') {
3839: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3840: } else {
3841: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3842: }
3843: }
3844: }
3845: }
3846: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3847: $userroles{'user.adv'} = $adv;
3848: $userroles{'user.author'} = $author;
3849: $env{'user.adv'}=$adv;
3850: }
3851: return \%userroles;
3852: }
3853:
3854: sub set_arearole {
3855: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3856: # log the associated role with the area
3857: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3858: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3859: }
3860:
3861: sub custom_roleprivs {
3862: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3863: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3864: my $homsvr=homeserver($rauthor,$rdomain);
3865: if (&hostname($homsvr) ne '') {
3866: my ($rdummy,$roledef)=
3867: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3868: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3869: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3870: if (defined($syspriv)) {
3871: if ($trest =~ /^$match_community$/) {
3872: $syspriv =~ s/bre\&S//;
3873: }
3874: $$allroles{'cm./'}.=':'.$syspriv;
3875: $$allroles{$spec.'./'}.=':'.$syspriv;
3876: }
3877: if ($tdomain ne '') {
3878: if (defined($dompriv)) {
3879: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3880: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3881: }
3882: if (($trest ne '') && (defined($coursepriv))) {
3883: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3884: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3885: }
3886: }
3887: }
3888: }
3889: }
3890:
3891: sub group_roleprivs {
3892: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3893: my $access = 1;
3894: my $now = time;
3895: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3896: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3897: if ($access) {
3898: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3899: $$allgroups{$course}{$group} .=':'.$group_privs;
3900: }
3901: }
3902:
3903: sub standard_roleprivs {
3904: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3905: if (defined($pr{$trole.':s'})) {
3906: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3907: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3908: }
3909: if ($tdomain ne '') {
3910: if (defined($pr{$trole.':d'})) {
3911: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3912: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3913: }
3914: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3915: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3916: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3917: }
3918: }
3919: }
3920:
3921: sub set_userprivs {
3922: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
3923: my $author=0;
3924: my $adv=0;
3925: my %grouproles = ();
3926: if (keys(%{$allgroups}) > 0) {
3927: my @groupkeys;
3928: foreach my $role (keys(%{$allroles})) {
3929: push(@groupkeys,$role);
3930: }
3931: if (ref($groups_roles) eq 'HASH') {
3932: foreach my $key (keys(%{$groups_roles})) {
3933: unless (grep(/^\Q$key\E$/,@groupkeys)) {
3934: push(@groupkeys,$key);
3935: }
3936: }
3937: }
3938: if (@groupkeys > 0) {
3939: foreach my $role (@groupkeys) {
3940: my ($trole,$area,$sec,$extendedarea);
3941: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3942: $trole = $1;
3943: $area = $2;
3944: $sec = $3;
3945: $extendedarea = $area.$sec;
3946: if (exists($$allgroups{$area})) {
3947: foreach my $group (keys(%{$$allgroups{$area}})) {
3948: my $spec = $trole.'.'.$extendedarea;
3949: $grouproles{$spec.'.'.$area.'/'.$group} =
3950: $$allgroups{$area}{$group};
3951: }
3952: }
3953: }
3954: }
3955: }
3956: }
3957: foreach my $group (keys(%grouproles)) {
3958: $$allroles{$group} = $grouproles{$group};
3959: }
3960: foreach my $role (keys(%{$allroles})) {
3961: my %thesepriv;
3962: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
3963: foreach my $item (split(/:/,$$allroles{$role})) {
3964: if ($item ne '') {
3965: my ($privilege,$restrictions)=split(/&/,$item);
3966: if ($restrictions eq '') {
3967: $thesepriv{$privilege}='F';
3968: } elsif ($thesepriv{$privilege} ne 'F') {
3969: $thesepriv{$privilege}.=$restrictions;
3970: }
3971: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3972: }
3973: }
3974: my $thesestr='';
3975: foreach my $priv (keys(%thesepriv)) {
3976: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3977: }
3978: $userroles->{'user.priv.'.$role} = $thesestr;
3979: }
3980: return ($author,$adv);
3981: }
3982:
3983: sub role_status {
3984: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
3985: my @pwhere = ();
3986: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
3987: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
3988: unless (!defined($$role) || $$role eq '') {
3989: $$where=join('.',@pwhere);
3990: $$trolecode=$$role.'.'.$$where;
3991: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
3992: $$tstatus='is';
3993: if ($$tstart && $$tstart>$then) {
3994: $$tstatus='future';
3995: if ($$tstart<$now) {
3996: if ($$tstart && $$tstart>$refresh) {
3997: if (($$where ne '') && ($$role ne '')) {
3998: my (%allroles,%allgroups,$group_privs,
3999: %groups_roles,@rolecodes);
4000: my %userroles = (
4001: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4002: );
4003: @rolecodes = ('cm');
4004: my $spec=$$role.'.'.$$where;
4005: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4006: if ($$role =~ /^cr\//) {
4007: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4008: push(@rolecodes,'cr');
4009: } elsif ($$role eq 'gr') {
4010: push(@rolecodes,$$role);
4011: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4012: $env{'user.name'});
4013: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
4014: (undef,my $group_privs) = split(/\//,$trole);
4015: $group_privs = &unescape($group_privs);
4016: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4017: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
4018: if (keys(%course_roles) > 0) {
4019: my ($tnum) = ($trest =~ /^($match_courseid)/);
4020: if ($tdomain ne '' && $tnum ne '') {
4021: foreach my $key (keys(%course_roles)) {
4022: if ($key =~ /^\Q$tnum\E:\Q$tdomain\E:([^:]+):?([^:]*)/) {
4023: my $crsrole = $1;
4024: my $crssec = $2;
4025: if ($crsrole =~ /^cr/) {
4026: unless (grep(/^cr$/,@rolecodes)) {
4027: push(@rolecodes,'cr');
4028: }
4029: } else {
4030: unless(grep(/^\Q$crsrole\E$/,@rolecodes)) {
4031: push(@rolecodes,$crsrole);
4032: }
4033: }
4034: my $rolekey = $crsrole.'./'.$tdomain.'/'.$tnum;
4035: if ($crssec ne '') {
4036: $rolekey .= '/'.$crssec;
4037: }
4038: $rolekey .= './';
4039: $groups_roles{$rolekey} = \@rolecodes;
4040: }
4041: }
4042: }
4043: }
4044: } else {
4045: push(@rolecodes,$$role);
4046: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4047: }
4048: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4049: &appenv(\%userroles,\@rolecodes);
4050: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4051: }
4052: }
4053: $$tstatus = 'is';
4054: }
4055: }
4056: if ($$tend) {
4057: if ($$tend<$then) {
4058: $$tstatus='expired';
4059: } elsif ($$tend<$now) {
4060: $$tstatus='will_not';
4061: }
4062: }
4063: }
4064: }
4065: }
4066:
4067: sub check_adhoc_privs {
4068: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
4069: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4070: if ($env{$cckey}) {
4071: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
4072: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
4073: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4074: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4075: }
4076: } else {
4077: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4078: }
4079: }
4080:
4081: sub set_adhoc_privileges {
4082: # role can be cc or ca
4083: my ($dcdom,$pickedcourse,$role) = @_;
4084: my $area = '/'.$dcdom.'/'.$pickedcourse;
4085: my $spec = $role.'.'.$area;
4086: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4087: $env{'user.name'});
4088: my %ccrole = ();
4089: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4090: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4091: &appenv(\%userroles,[$role,'cm']);
4092: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4093: &appenv( {'request.role' => $spec,
4094: 'request.role.domain' => $dcdom,
4095: 'request.course.sec' => ''
4096: }
4097: );
4098: my $tadv=0;
4099: if (&allowed('adv') eq 'F') { $tadv=1; }
4100: &appenv({'request.role.adv' => $tadv});
4101: }
4102:
4103: # --------------------------------------------------------------- get interface
4104:
4105: sub get {
4106: my ($namespace,$storearr,$udomain,$uname)=@_;
4107: my $items='';
4108: foreach my $item (@$storearr) {
4109: $items.=&escape($item).'&';
4110: }
4111: $items=~s/\&$//;
4112: if (!$udomain) { $udomain=$env{'user.domain'}; }
4113: if (!$uname) { $uname=$env{'user.name'}; }
4114: my $uhome=&homeserver($uname,$udomain);
4115:
4116: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4117: my @pairs=split(/\&/,$rep);
4118: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4119: return @pairs;
4120: }
4121: my %returnhash=();
4122: my $i=0;
4123: foreach my $item (@$storearr) {
4124: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4125: $i++;
4126: }
4127: return %returnhash;
4128: }
4129:
4130: # --------------------------------------------------------------- del interface
4131:
4132: sub del {
4133: my ($namespace,$storearr,$udomain,$uname)=@_;
4134: my $items='';
4135: foreach my $item (@$storearr) {
4136: $items.=&escape($item).'&';
4137: }
4138:
4139: $items=~s/\&$//;
4140: if (!$udomain) { $udomain=$env{'user.domain'}; }
4141: if (!$uname) { $uname=$env{'user.name'}; }
4142: my $uhome=&homeserver($uname,$udomain);
4143: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4144: }
4145:
4146: # -------------------------------------------------------------- dump interface
4147:
4148: sub dump {
4149: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4150: if (!$udomain) { $udomain=$env{'user.domain'}; }
4151: if (!$uname) { $uname=$env{'user.name'}; }
4152: my $uhome=&homeserver($uname,$udomain);
4153: if ($regexp) {
4154: $regexp=&escape($regexp);
4155: } else {
4156: $regexp='.';
4157: }
4158: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4159: my @pairs=split(/\&/,$rep);
4160: my %returnhash=();
4161: foreach my $item (@pairs) {
4162: my ($key,$value)=split(/=/,$item,2);
4163: $key = &unescape($key);
4164: next if ($key =~ /^error: 2 /);
4165: $returnhash{$key}=&thaw_unescape($value);
4166: }
4167: return %returnhash;
4168: }
4169:
4170: # --------------------------------------------------------- dumpstore interface
4171:
4172: sub dumpstore {
4173: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4174: if (!$udomain) { $udomain=$env{'user.domain'}; }
4175: if (!$uname) { $uname=$env{'user.name'}; }
4176: my $uhome=&homeserver($uname,$udomain);
4177: if ($regexp) {
4178: $regexp=&escape($regexp);
4179: } else {
4180: $regexp='.';
4181: }
4182: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4183: my @pairs=split(/\&/,$rep);
4184: my %returnhash=();
4185: foreach my $item (@pairs) {
4186: my ($key,$value)=split(/=/,$item,2);
4187: next if ($key =~ /^error: 2 /);
4188: $returnhash{$key}=&thaw_unescape($value);
4189: }
4190: return %returnhash;
4191: }
4192:
4193: # -------------------------------------------------------------- keys interface
4194:
4195: sub getkeys {
4196: my ($namespace,$udomain,$uname)=@_;
4197: if (!$udomain) { $udomain=$env{'user.domain'}; }
4198: if (!$uname) { $uname=$env{'user.name'}; }
4199: my $uhome=&homeserver($uname,$udomain);
4200: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4201: my @keyarray=();
4202: foreach my $key (split(/\&/,$rep)) {
4203: next if ($key =~ /^error: 2 /);
4204: push(@keyarray,&unescape($key));
4205: }
4206: return @keyarray;
4207: }
4208:
4209: # --------------------------------------------------------------- currentdump
4210: sub currentdump {
4211: my ($courseid,$sdom,$sname)=@_;
4212: $courseid = $env{'request.course.id'} if (! defined($courseid));
4213: $sdom = $env{'user.domain'} if (! defined($sdom));
4214: $sname = $env{'user.name'} if (! defined($sname));
4215: my $uhome = &homeserver($sname,$sdom);
4216: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4217: return if ($rep =~ /^(error:|no_such_host)/);
4218: #
4219: my %returnhash=();
4220: #
4221: if ($rep eq "unknown_cmd") {
4222: # an old lond will not know currentdump
4223: # Do a dump and make it look like a currentdump
4224: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
4225: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4226: my %hash = @tmp;
4227: @tmp=();
4228: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
4229: } else {
4230: my @pairs=split(/\&/,$rep);
4231: foreach my $pair (@pairs) {
4232: my ($key,$value)=split(/=/,$pair,2);
4233: my ($symb,$param) = split(/:/,$key);
4234: $returnhash{&unescape($symb)}->{&unescape($param)} =
4235: &thaw_unescape($value);
4236: }
4237: }
4238: return %returnhash;
4239: }
4240:
4241: sub convert_dump_to_currentdump{
4242: my %hash = %{shift()};
4243: my %returnhash;
4244: # Code ripped from lond, essentially. The only difference
4245: # here is the unescaping done by lonnet::dump(). Conceivably
4246: # we might run in to problems with parameter names =~ /^v\./
4247: while (my ($key,$value) = each(%hash)) {
4248: my ($v,$symb,$param) = split(/:/,$key);
4249: $symb = &unescape($symb);
4250: $param = &unescape($param);
4251: next if ($v eq 'version' || $symb eq 'keys');
4252: next if (exists($returnhash{$symb}) &&
4253: exists($returnhash{$symb}->{$param}) &&
4254: $returnhash{$symb}->{'v.'.$param} > $v);
4255: $returnhash{$symb}->{$param}=$value;
4256: $returnhash{$symb}->{'v.'.$param}=$v;
4257: }
4258: #
4259: # Remove all of the keys in the hashes which keep track of
4260: # the version of the parameter.
4261: while (my ($symb,$param_hash) = each(%returnhash)) {
4262: # use a foreach because we are going to delete from the hash.
4263: foreach my $key (keys(%$param_hash)) {
4264: delete($param_hash->{$key}) if ($key =~ /^v\./);
4265: }
4266: }
4267: return \%returnhash;
4268: }
4269:
4270: # ------------------------------------------------------ critical inc interface
4271:
4272: sub cinc {
4273: return &inc(@_,'critical');
4274: }
4275:
4276: # --------------------------------------------------------------- inc interface
4277:
4278: sub inc {
4279: my ($namespace,$store,$udomain,$uname,$critical) = @_;
4280: if (!$udomain) { $udomain=$env{'user.domain'}; }
4281: if (!$uname) { $uname=$env{'user.name'}; }
4282: my $uhome=&homeserver($uname,$udomain);
4283: my $items='';
4284: if (! ref($store)) {
4285: # got a single value, so use that instead
4286: $items = &escape($store).'=&';
4287: } elsif (ref($store) eq 'SCALAR') {
4288: $items = &escape($$store).'=&';
4289: } elsif (ref($store) eq 'ARRAY') {
4290: $items = join('=&',map {&escape($_);} @{$store});
4291: } elsif (ref($store) eq 'HASH') {
4292: while (my($key,$value) = each(%{$store})) {
4293: $items.= &escape($key).'='.&escape($value).'&';
4294: }
4295: }
4296: $items=~s/\&$//;
4297: if ($critical) {
4298: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4299: } else {
4300: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4301: }
4302: }
4303:
4304: # --------------------------------------------------------------- put interface
4305:
4306: sub put {
4307: my ($namespace,$storehash,$udomain,$uname)=@_;
4308: if (!$udomain) { $udomain=$env{'user.domain'}; }
4309: if (!$uname) { $uname=$env{'user.name'}; }
4310: my $uhome=&homeserver($uname,$udomain);
4311: my $items='';
4312: foreach my $item (keys(%$storehash)) {
4313: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4314: }
4315: $items=~s/\&$//;
4316: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4317: }
4318:
4319: # ------------------------------------------------------------ newput interface
4320:
4321: sub newput {
4322: my ($namespace,$storehash,$udomain,$uname)=@_;
4323: if (!$udomain) { $udomain=$env{'user.domain'}; }
4324: if (!$uname) { $uname=$env{'user.name'}; }
4325: my $uhome=&homeserver($uname,$udomain);
4326: my $items='';
4327: foreach my $key (keys(%$storehash)) {
4328: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4329: }
4330: $items=~s/\&$//;
4331: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4332: }
4333:
4334: # --------------------------------------------------------- putstore interface
4335:
4336: sub putstore {
4337: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4338: if (!$udomain) { $udomain=$env{'user.domain'}; }
4339: if (!$uname) { $uname=$env{'user.name'}; }
4340: my $uhome=&homeserver($uname,$udomain);
4341: my $items='';
4342: foreach my $key (keys(%$storehash)) {
4343: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
4344: }
4345: $items=~s/\&$//;
4346: my $esc_symb=&escape($symb);
4347: my $esc_v=&escape($version);
4348: my $reply =
4349: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
4350: $uhome);
4351: if ($reply eq 'unknown_cmd') {
4352: # gfall back to way things use to be done
4353: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4354: $uname);
4355: }
4356: return $reply;
4357: }
4358:
4359: sub old_putstore {
4360: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4361: if (!$udomain) { $udomain=$env{'user.domain'}; }
4362: if (!$uname) { $uname=$env{'user.name'}; }
4363: my $uhome=&homeserver($uname,$udomain);
4364: my %newstorehash;
4365: foreach my $item (keys(%$storehash)) {
4366: my $key = $version.':'.&escape($symb).':'.$item;
4367: $newstorehash{$key} = $storehash->{$item};
4368: }
4369: my $items='';
4370: my %allitems = ();
4371: foreach my $item (keys(%newstorehash)) {
4372: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
4373: my $key = $1.':keys:'.$2;
4374: $allitems{$key} .= $3.':';
4375: }
4376: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
4377: }
4378: foreach my $item (keys(%allitems)) {
4379: $allitems{$item} =~ s/\:$//;
4380: $items.= $item.'='.$allitems{$item}.'&';
4381: }
4382: $items=~s/\&$//;
4383: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4384: }
4385:
4386: # ------------------------------------------------------ critical put interface
4387:
4388: sub cput {
4389: my ($namespace,$storehash,$udomain,$uname)=@_;
4390: if (!$udomain) { $udomain=$env{'user.domain'}; }
4391: if (!$uname) { $uname=$env{'user.name'}; }
4392: my $uhome=&homeserver($uname,$udomain);
4393: my $items='';
4394: foreach my $item (keys(%$storehash)) {
4395: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4396: }
4397: $items=~s/\&$//;
4398: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
4399: }
4400:
4401: # -------------------------------------------------------------- eget interface
4402:
4403: sub eget {
4404: my ($namespace,$storearr,$udomain,$uname)=@_;
4405: my $items='';
4406: foreach my $item (@$storearr) {
4407: $items.=&escape($item).'&';
4408: }
4409: $items=~s/\&$//;
4410: if (!$udomain) { $udomain=$env{'user.domain'}; }
4411: if (!$uname) { $uname=$env{'user.name'}; }
4412: my $uhome=&homeserver($uname,$udomain);
4413: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
4414: my @pairs=split(/\&/,$rep);
4415: my %returnhash=();
4416: my $i=0;
4417: foreach my $item (@$storearr) {
4418: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4419: $i++;
4420: }
4421: return %returnhash;
4422: }
4423:
4424: # ------------------------------------------------------------ tmpput interface
4425: sub tmpput {
4426: my ($storehash,$server,$context)=@_;
4427: my $items='';
4428: foreach my $item (keys(%$storehash)) {
4429: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4430: }
4431: $items=~s/\&$//;
4432: if (defined($context)) {
4433: $items .= ':'.&escape($context);
4434: }
4435: return &reply("tmpput:$items",$server);
4436: }
4437:
4438: # ------------------------------------------------------------ tmpget interface
4439: sub tmpget {
4440: my ($token,$server)=@_;
4441: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4442: my $rep=&reply("tmpget:$token",$server);
4443: my %returnhash;
4444: foreach my $item (split(/\&/,$rep)) {
4445: my ($key,$value)=split(/=/,$item);
4446: next if ($key =~ /^error: 2 /);
4447: $returnhash{&unescape($key)}=&thaw_unescape($value);
4448: }
4449: return %returnhash;
4450: }
4451:
4452: # ------------------------------------------------------------ tmpget interface
4453: sub tmpdel {
4454: my ($token,$server)=@_;
4455: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4456: return &reply("tmpdel:$token",$server);
4457: }
4458:
4459: # -------------------------------------------------- portfolio access checking
4460:
4461: sub portfolio_access {
4462: my ($requrl) = @_;
4463: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4464: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4465: if ($result) {
4466: my %setters;
4467: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4468: my ($startblock,$endblock) =
4469: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4470: if ($startblock && $endblock) {
4471: return 'B';
4472: }
4473: } else {
4474: my ($startblock,$endblock) =
4475: &Apache::loncommon::blockcheck(\%setters,'port');
4476: if ($startblock && $endblock) {
4477: return 'B';
4478: }
4479: }
4480: }
4481: if ($result eq 'ok') {
4482: return 'F';
4483: } elsif ($result =~ /^[^:]+:guest_/) {
4484: return 'A';
4485: }
4486: return '';
4487: }
4488:
4489: sub get_portfolio_access {
4490: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4491:
4492: if (!ref($access_hash)) {
4493: my $current_perms = &get_portfile_permissions($udom,$unum);
4494: my %access_controls = &get_access_controls($current_perms,$group,
4495: $file_name);
4496: $access_hash = $access_controls{$file_name};
4497: }
4498:
4499: my ($public,$guest,@domains,@users,@courses,@groups);
4500: my $now = time;
4501: if (ref($access_hash) eq 'HASH') {
4502: foreach my $key (keys(%{$access_hash})) {
4503: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4504: if ($start > $now) {
4505: next;
4506: }
4507: if ($end && $end<$now) {
4508: next;
4509: }
4510: if ($scope eq 'public') {
4511: $public = $key;
4512: last;
4513: } elsif ($scope eq 'guest') {
4514: $guest = $key;
4515: } elsif ($scope eq 'domains') {
4516: push(@domains,$key);
4517: } elsif ($scope eq 'users') {
4518: push(@users,$key);
4519: } elsif ($scope eq 'course') {
4520: push(@courses,$key);
4521: } elsif ($scope eq 'group') {
4522: push(@groups,$key);
4523: }
4524: }
4525: if ($public) {
4526: return 'ok';
4527: }
4528: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4529: if ($guest) {
4530: return $guest;
4531: }
4532: } else {
4533: if (@domains > 0) {
4534: foreach my $domkey (@domains) {
4535: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4536: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4537: return 'ok';
4538: }
4539: }
4540: }
4541: }
4542: if (@users > 0) {
4543: foreach my $userkey (@users) {
4544: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4545: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4546: if (ref($item) eq 'HASH') {
4547: if (($item->{'uname'} eq $env{'user.name'}) &&
4548: ($item->{'udom'} eq $env{'user.domain'})) {
4549: return 'ok';
4550: }
4551: }
4552: }
4553: }
4554: }
4555: }
4556: my %roleshash;
4557: my @courses_and_groups = @courses;
4558: push(@courses_and_groups,@groups);
4559: if (@courses_and_groups > 0) {
4560: my (%allgroups,%allroles);
4561: my ($start,$end,$role,$sec,$group);
4562: foreach my $envkey (%env) {
4563: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4564: my $cid = $2.'_'.$3;
4565: if ($1 eq 'gr') {
4566: $group = $4;
4567: $allgroups{$cid}{$group} = $env{$envkey};
4568: } else {
4569: if ($4 eq '') {
4570: $sec = 'none';
4571: } else {
4572: $sec = $4;
4573: }
4574: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4575: }
4576: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4577: my $cid = $2.'_'.$3;
4578: if ($4 eq '') {
4579: $sec = 'none';
4580: } else {
4581: $sec = $4;
4582: }
4583: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4584: }
4585: }
4586: if (keys(%allroles) == 0) {
4587: return;
4588: }
4589: foreach my $key (@courses_and_groups) {
4590: my %content = %{$$access_hash{$key}};
4591: my $cnum = $content{'number'};
4592: my $cdom = $content{'domain'};
4593: my $cid = $cdom.'_'.$cnum;
4594: if (!exists($allroles{$cid})) {
4595: next;
4596: }
4597: foreach my $role_id (keys(%{$content{'roles'}})) {
4598: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4599: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4600: my @status = @{$content{'roles'}{$role_id}{'access'}};
4601: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4602: foreach my $role (keys(%{$allroles{$cid}})) {
4603: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4604: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4605: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4606: if (grep/^all$/,@sections) {
4607: return 'ok';
4608: } else {
4609: if (grep/^$sec$/,@sections) {
4610: return 'ok';
4611: }
4612: }
4613: }
4614: }
4615: if (keys(%{$allgroups{$cid}}) == 0) {
4616: if (grep/^none$/,@groups) {
4617: return 'ok';
4618: }
4619: } else {
4620: if (grep/^all$/,@groups) {
4621: return 'ok';
4622: }
4623: foreach my $group (keys(%{$allgroups{$cid}})) {
4624: if (grep/^$group$/,@groups) {
4625: return 'ok';
4626: }
4627: }
4628: }
4629: }
4630: }
4631: }
4632: }
4633: }
4634: if ($guest) {
4635: return $guest;
4636: }
4637: }
4638: }
4639: return;
4640: }
4641:
4642: sub course_group_datechecker {
4643: my ($dates,$now,$status) = @_;
4644: my ($start,$end) = split(/\./,$dates);
4645: if (!$start && !$end) {
4646: return 'ok';
4647: }
4648: if (grep/^active$/,@{$status}) {
4649: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4650: return 'ok';
4651: }
4652: }
4653: if (grep/^previous$/,@{$status}) {
4654: if ($end > $now ) {
4655: return 'ok';
4656: }
4657: }
4658: if (grep/^future$/,@{$status}) {
4659: if ($start > $now) {
4660: return 'ok';
4661: }
4662: }
4663: return;
4664: }
4665:
4666: sub parse_portfolio_url {
4667: my ($url) = @_;
4668:
4669: my ($type,$udom,$unum,$group,$file_name);
4670:
4671: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4672: $type = 1;
4673: $udom = $1;
4674: $unum = $2;
4675: $file_name = $3;
4676: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4677: $type = 2;
4678: $udom = $1;
4679: $unum = $2;
4680: $group = $3;
4681: $file_name = $3.'/'.$4;
4682: }
4683: if (wantarray) {
4684: return ($type,$udom,$unum,$file_name,$group);
4685: }
4686: return $type;
4687: }
4688:
4689: sub is_portfolio_url {
4690: my ($url) = @_;
4691: return scalar(&parse_portfolio_url($url));
4692: }
4693:
4694: sub is_portfolio_file {
4695: my ($file) = @_;
4696: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4697: return 1;
4698: }
4699: return;
4700: }
4701:
4702: sub usertools_access {
4703: my ($uname,$udom,$tool,$action,$context) = @_;
4704: my ($access,%tools);
4705: if ($context eq '') {
4706: $context = 'tools';
4707: }
4708: if ($context eq 'requestcourses') {
4709: %tools = (
4710: official => 1,
4711: unofficial => 1,
4712: community => 1,
4713: );
4714: } else {
4715: %tools = (
4716: aboutme => 1,
4717: blog => 1,
4718: portfolio => 1,
4719: );
4720: }
4721: return if (!defined($tools{$tool}));
4722:
4723: if ((!defined($udom)) || (!defined($uname))) {
4724: $udom = $env{'user.domain'};
4725: $uname = $env{'user.name'};
4726: }
4727:
4728: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4729: if ($action ne 'reload') {
4730: if ($context eq 'requestcourses') {
4731: return $env{'environment.canrequest.'.$tool};
4732: } else {
4733: return $env{'environment.availabletools.'.$tool};
4734: }
4735: }
4736: }
4737:
4738: my ($toolstatus,$inststatus);
4739:
4740: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4741: ($action ne 'reload')) {
4742: $toolstatus = $env{'environment.'.$context.'.'.$tool};
4743: $inststatus = $env{'environment.inststatus'};
4744: } else {
4745: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
4746: $toolstatus = $userenv{$context.'.'.$tool};
4747: $inststatus = $userenv{'inststatus'};
4748: }
4749:
4750: if ($toolstatus ne '') {
4751: if ($toolstatus) {
4752: $access = 1;
4753: } else {
4754: $access = 0;
4755: }
4756: return $access;
4757: }
4758:
4759: my $is_adv = &is_advanced_user($udom,$uname);
4760: my %domdef = &get_domain_defaults($udom);
4761: if (ref($domdef{$tool}) eq 'HASH') {
4762: if ($is_adv) {
4763: if ($domdef{$tool}{'_LC_adv'} ne '') {
4764: if ($domdef{$tool}{'_LC_adv'}) {
4765: $access = 1;
4766: } else {
4767: $access = 0;
4768: }
4769: return $access;
4770: }
4771: }
4772: if ($inststatus ne '') {
4773: my ($hasaccess,$hasnoaccess);
4774: foreach my $affiliation (split(/:/,$inststatus)) {
4775: if ($domdef{$tool}{$affiliation} ne '') {
4776: if ($domdef{$tool}{$affiliation}) {
4777: $hasaccess = 1;
4778: } else {
4779: $hasnoaccess = 1;
4780: }
4781: }
4782: }
4783: if ($hasaccess || $hasnoaccess) {
4784: if ($hasaccess) {
4785: $access = 1;
4786: } elsif ($hasnoaccess) {
4787: $access = 0;
4788: }
4789: return $access;
4790: }
4791: } else {
4792: if ($domdef{$tool}{'default'} ne '') {
4793: if ($domdef{$tool}{'default'}) {
4794: $access = 1;
4795: } elsif ($domdef{$tool}{'default'} == 0) {
4796: $access = 0;
4797: }
4798: return $access;
4799: }
4800: }
4801: } else {
4802: if ($context eq 'tools') {
4803: $access = 1;
4804: } else {
4805: $access = 0;
4806: }
4807: return $access;
4808: }
4809: }
4810:
4811: sub is_course_owner {
4812: my ($cdom,$cnum,$udom,$uname) = @_;
4813: if (($udom eq '') || ($uname eq '')) {
4814: $udom = $env{'user.domain'};
4815: $uname = $env{'user.name'};
4816: }
4817: unless (($udom eq '') || ($uname eq '')) {
4818: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4819: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4820: return 1;
4821: } else {
4822: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4823: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4824: return 1;
4825: }
4826: }
4827: }
4828: }
4829: return;
4830: }
4831:
4832: sub is_advanced_user {
4833: my ($udom,$uname) = @_;
4834: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4835: my %allroles;
4836: my $is_adv;
4837: foreach my $role (keys(%roleshash)) {
4838: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4839: my $area = '/'.$tdomain.'/'.$trest;
4840: if ($sec ne '') {
4841: $area .= '/'.$sec;
4842: }
4843: if (($area ne '') && ($trole ne '')) {
4844: my $spec=$trole.'.'.$area;
4845: if ($trole =~ /^cr\//) {
4846: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4847: } elsif ($trole ne 'gr') {
4848: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4849: }
4850: }
4851: }
4852: foreach my $role (keys(%allroles)) {
4853: last if ($is_adv);
4854: foreach my $item (split(/:/,$allroles{$role})) {
4855: if ($item ne '') {
4856: my ($privilege,$restrictions)=split(/&/,$item);
4857: if ($privilege eq 'adv') {
4858: $is_adv = 1;
4859: last;
4860: }
4861: }
4862: }
4863: }
4864: return $is_adv;
4865: }
4866:
4867: sub check_can_request {
4868: my ($dom,$can_request,$request_domains) = @_;
4869: my $canreq = 0;
4870: my ($types,$typename) = &Apache::loncommon::course_types();
4871: my @options = ('approval','validate','autolimit');
4872: my $optregex = join('|',@options);
4873: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4874: foreach my $type (@{$types}) {
4875: if (&usertools_access($env{'user.name'},
4876: $env{'user.domain'},
4877: $type,undef,'requestcourses')) {
4878: $canreq ++;
4879: if (ref($request_domains) eq 'HASH') {
4880: push(@{$request_domains->{$type}},$env{'user.domain'});
4881: }
4882: if ($dom eq $env{'user.domain'}) {
4883: $can_request->{$type} = 1;
4884: }
4885: }
4886: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4887: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4888: if (@curr > 0) {
4889: foreach my $item (@curr) {
4890: if (ref($request_domains) eq 'HASH') {
4891: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4892: if ($otherdom ne '') {
4893: if (ref($request_domains->{$type}) eq 'ARRAY') {
4894: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4895: push(@{$request_domains->{$type}},$otherdom);
4896: }
4897: } else {
4898: push(@{$request_domains->{$type}},$otherdom);
4899: }
4900: }
4901: }
4902: }
4903: unless($dom eq $env{'user.domain'}) {
4904: $canreq ++;
4905: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4906: $can_request->{$type} = 1;
4907: }
4908: }
4909: }
4910: }
4911: }
4912: }
4913: return $canreq;
4914: }
4915:
4916: # ---------------------------------------------- Custom access rule evaluation
4917:
4918: sub customaccess {
4919: my ($priv,$uri)=@_;
4920: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
4921: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
4922: $udom = &LONCAPA::clean_domain($udom);
4923: $ucrs = &LONCAPA::clean_username($ucrs);
4924: my $access=0;
4925: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
4926: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4927: if ($type eq 'user') {
4928: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4929: my ($tdom,$tuname)=split(m{/},$scope);
4930: if ($tdom) {
4931: if ($tdom ne $env{'user.domain'}) { next; }
4932: }
4933: if ($tuname) {
4934: if ($tuname ne $env{'user.name'}) { next; }
4935: }
4936: $access=($effect eq 'allow');
4937: last;
4938: }
4939: } else {
4940: if ($role) {
4941: if ($role ne $urole) { next; }
4942: }
4943: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4944: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4945: if ($tdom) {
4946: if ($tdom ne $udom) { next; }
4947: }
4948: if ($tcrs) {
4949: if ($tcrs ne $ucrs) { next; }
4950: }
4951: if ($tsec) {
4952: if ($tsec ne $usec) { next; }
4953: }
4954: $access=($effect eq 'allow');
4955: last;
4956: }
4957: if ($realm eq '' && $role eq '') {
4958: $access=($effect eq 'allow');
4959: }
4960: }
4961: }
4962: return $access;
4963: }
4964:
4965: # ------------------------------------------------- Check for a user privilege
4966:
4967: sub allowed {
4968: my ($priv,$uri,$symb,$role)=@_;
4969: my $ver_orguri=$uri;
4970: $uri=&deversion($uri);
4971: my $orguri=$uri;
4972: $uri=&declutter($uri);
4973:
4974: if ($priv eq 'evb') {
4975: # Evade communication block restrictions for specified role in a course
4976: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4977: return $1;
4978: } else {
4979: return;
4980: }
4981: }
4982:
4983: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
4984: # Free bre access to adm and meta resources
4985: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
4986: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4987: && ($priv eq 'bre')) {
4988: return 'F';
4989: }
4990:
4991: # Free bre access to user's own portfolio contents
4992: my ($space,$domain,$name,@dir)=split('/',$uri);
4993: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
4994: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
4995: my %setters;
4996: my ($startblock,$endblock) =
4997: &Apache::loncommon::blockcheck(\%setters,'port');
4998: if ($startblock && $endblock) {
4999: return 'B';
5000: } else {
5001: return 'F';
5002: }
5003: }
5004:
5005: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
5006: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5007: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5008: if (exists($env{'request.course.id'})) {
5009: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5010: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5011: if (($domain eq $cdom) && ($name eq $cnum)) {
5012: my $courseprivid=$env{'request.course.id'};
5013: $courseprivid=~s/\_/\//;
5014: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5015: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5016: return $1;
5017: } else {
5018: if ($env{'request.course.sec'}) {
5019: $courseprivid.='/'.$env{'request.course.sec'};
5020: }
5021: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5022: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5023: return $2;
5024: }
5025: }
5026: }
5027: }
5028: }
5029:
5030: # Free bre to public access
5031:
5032: if ($priv eq 'bre') {
5033: my $copyright=&metadata($uri,'copyright');
5034: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
5035: return 'F';
5036: }
5037: if ($copyright eq 'priv') {
5038: $uri=~/([^\/]+)\/([^\/]+)\//;
5039: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
5040: return '';
5041: }
5042: }
5043: if ($copyright eq 'domain') {
5044: $uri=~/([^\/]+)\/([^\/]+)\//;
5045: unless (($env{'user.domain'} eq $1) ||
5046: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
5047: return '';
5048: }
5049: }
5050: if ($env{'request.role'}=~ /li\.\//) {
5051: # Library role, so allow browsing of resources in this domain.
5052: return 'F';
5053: }
5054: if ($copyright eq 'custom') {
5055: unless (&customaccess($priv,$uri)) { return ''; }
5056: }
5057: }
5058: # Domain coordinator is trying to create a course
5059: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
5060: # uri is the requested domain in this case.
5061: # comparison to 'request.role.domain' shows if the user has selected
5062: # a role of dc for the domain in question.
5063: return 'F' if ($uri eq $env{'request.role.domain'});
5064: }
5065:
5066: my $thisallowed='';
5067: my $statecond=0;
5068: my $courseprivid='';
5069:
5070: my $ownaccess;
5071: # Community Coordinator or Assistant Co-author browsing resource space.
5072: if (($priv eq 'bro') && ($env{'user.author'})) {
5073: if ($uri eq '') {
5074: $ownaccess = 1;
5075: } else {
5076: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5077: my $udom = $env{'user.domain'};
5078: my $uname = $env{'user.name'};
5079: if ($uri =~ m{^\Q$udom\E/?$}) {
5080: $ownaccess = 1;
5081: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
5082: unless ($uri =~ m{\.\./}) {
5083: $ownaccess = 1;
5084: }
5085: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5086: my $now = time;
5087: if ($uri =~ m{^([^/]+)/?$}) {
5088: my $adom = $1;
5089: foreach my $key (keys(%env)) {
5090: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
5091: my ($start,$end) = split('.',$env{$key});
5092: if (($now >= $start) && (!$end || $end < $now)) {
5093: $ownaccess = 1;
5094: last;
5095: }
5096: }
5097: }
5098: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5099: my $adom = $1;
5100: my $aname = $2;
5101: foreach my $role ('ca','aa') {
5102: if ($env{"user.role.$role./$adom/$aname"}) {
5103: my ($start,$end) =
5104: split('.',$env{"user.role.$role./$adom/$aname"});
5105: if (($now >= $start) && (!$end || $end < $now)) {
5106: $ownaccess = 1;
5107: last;
5108: }
5109: }
5110: }
5111: }
5112: }
5113: }
5114: }
5115: }
5116:
5117: # Course
5118:
5119: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
5120: unless (($priv eq 'bro') && (!$ownaccess)) {
5121: $thisallowed.=$1;
5122: }
5123: }
5124:
5125: # Domain
5126:
5127: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
5128: =~/\Q$priv\E\&([^\:]*)/) {
5129: unless (($priv eq 'bro') && (!$ownaccess)) {
5130: $thisallowed.=$1;
5131: }
5132: }
5133:
5134: # Course: uri itself is a course
5135: my $courseuri=$uri;
5136: $courseuri=~s/\_(\d)/\/$1/;
5137: $courseuri=~s/^([^\/])/\/$1/;
5138:
5139: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
5140: =~/\Q$priv\E\&([^\:]*)/) {
5141: unless (($priv eq 'bro') && (!$ownaccess)) {
5142: $thisallowed.=$1;
5143: }
5144: }
5145:
5146: # URI is an uploaded document for this course, default permissions don't matter
5147: # not allowing 'edit' access (editupload) to uploaded course docs
5148: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
5149: $thisallowed='';
5150: my ($match)=&is_on_map($uri);
5151: if ($match) {
5152: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5153: =~/\Q$priv\E\&([^\:]*)/) {
5154: $thisallowed.=$1;
5155: }
5156: } else {
5157: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
5158: if ($refuri) {
5159: if ($refuri =~ m|^/adm/|) {
5160: $thisallowed='F';
5161: } else {
5162: $refuri=&declutter($refuri);
5163: my ($match) = &is_on_map($refuri);
5164: if ($match) {
5165: $thisallowed='F';
5166: }
5167: }
5168: }
5169: }
5170: }
5171:
5172: if ($priv eq 'bre'
5173: && $thisallowed ne 'F'
5174: && $thisallowed ne '2'
5175: && &is_portfolio_url($uri)) {
5176: $thisallowed = &portfolio_access($uri);
5177: }
5178:
5179: # Full access at system, domain or course-wide level? Exit.
5180: if ($thisallowed=~/F/) {
5181: return 'F';
5182: }
5183:
5184: # If this is generating or modifying users, exit with special codes
5185:
5186: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5187: if (($priv eq 'cca') || ($priv eq 'caa')) {
5188: my ($audom,$auname)=split('/',$uri);
5189: # no author name given, so this just checks on the general right to make a co-author in this domain
5190: unless ($auname) { return $thisallowed; }
5191: # an author name is given, so we are about to actually make a co-author for a certain account
5192: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5193: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5194: ($audom ne $env{'request.role.domain'}))) { return ''; }
5195: }
5196: return $thisallowed;
5197: }
5198: #
5199: # Gathered so far: system, domain and course wide privileges
5200: #
5201: # Course: See if uri or referer is an individual resource that is part of
5202: # the course
5203:
5204: if ($env{'request.course.id'}) {
5205:
5206: $courseprivid=$env{'request.course.id'};
5207: if ($env{'request.course.sec'}) {
5208: $courseprivid.='/'.$env{'request.course.sec'};
5209: }
5210: $courseprivid=~s/\_/\//;
5211: my $checkreferer=1;
5212: my ($match,$cond)=&is_on_map($uri);
5213: if ($match) {
5214: $statecond=$cond;
5215: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5216: =~/\Q$priv\E\&([^\:]*)/) {
5217: $thisallowed.=$1;
5218: $checkreferer=0;
5219: }
5220: }
5221:
5222: if ($checkreferer) {
5223: my $refuri=$env{'httpref.'.$orguri};
5224: unless ($refuri) {
5225: foreach my $key (keys(%env)) {
5226: if ($key=~/^httpref\..*\*/) {
5227: my $pattern=$key;
5228: $pattern=~s/^httpref\.\/res\///;
5229: $pattern=~s/\*/\[\^\/\]\+/g;
5230: $pattern=~s/\//\\\//g;
5231: if ($orguri=~/$pattern/) {
5232: $refuri=$env{$key};
5233: }
5234: }
5235: }
5236: }
5237:
5238: if ($refuri) {
5239: $refuri=&declutter($refuri);
5240: my ($match,$cond)=&is_on_map($refuri);
5241: if ($match) {
5242: my $refstatecond=$cond;
5243: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5244: =~/\Q$priv\E\&([^\:]*)/) {
5245: $thisallowed.=$1;
5246: $uri=$refuri;
5247: $statecond=$refstatecond;
5248: }
5249: }
5250: }
5251: }
5252: }
5253:
5254: #
5255: # Gathered now: all privileges that could apply, and condition number
5256: #
5257: #
5258: # Full or no access?
5259: #
5260:
5261: if ($thisallowed=~/F/) {
5262: return 'F';
5263: }
5264:
5265: unless ($thisallowed) {
5266: return '';
5267: }
5268:
5269: # Restrictions exist, deal with them
5270: #
5271: # C:according to course preferences
5272: # R:according to resource settings
5273: # L:unless locked
5274: # X:according to user session state
5275: #
5276:
5277: # Possibly locked functionality, check all courses
5278: # Locks might take effect only after 10 minutes cache expiration for other
5279: # courses, and 2 minutes for current course
5280:
5281: my $envkey;
5282: if ($thisallowed=~/L/) {
5283: foreach $envkey (keys(%env)) {
5284: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5285: my $courseid=$2;
5286: my $roleid=$1.'.'.$2;
5287: $courseid=~s/^\///;
5288: my $expiretime=600;
5289: if ($env{'request.role'} eq $roleid) {
5290: $expiretime=120;
5291: }
5292: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5293: my $prefix='course.'.$cdom.'_'.$cnum.'.';
5294: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
5295: &coursedescription($courseid,{'freshen_cache' => 1});
5296: }
5297: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5298: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5299: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5300: &log($env{'user.domain'},$env{'user.name'},
5301: $env{'user.home'},
5302: 'Locked by res: '.$priv.' for '.$uri.' due to '.
5303: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5304: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5305: return '';
5306: }
5307: }
5308: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5309: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5310: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5311: &log($env{'user.domain'},$env{'user.name'},
5312: $env{'user.home'},
5313: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
5314: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5315: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5316: return '';
5317: }
5318: }
5319: }
5320: }
5321: }
5322:
5323: #
5324: # Rest of the restrictions depend on selected course
5325: #
5326:
5327: unless ($env{'request.course.id'}) {
5328: if ($thisallowed eq 'A') {
5329: return 'A';
5330: } elsif ($thisallowed eq 'B') {
5331: return 'B';
5332: } else {
5333: return '1';
5334: }
5335: }
5336:
5337: #
5338: # Now user is definitely in a course
5339: #
5340:
5341:
5342: # Course preferences
5343:
5344: if ($thisallowed=~/C/) {
5345: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5346: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5347: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
5348: =~/\Q$rolecode\E/) {
5349: if ($priv ne 'pch') {
5350: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5351: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5352: $env{'request.course.id'});
5353: }
5354: return '';
5355: }
5356:
5357: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
5358: =~/\Q$unamedom\E/) {
5359: if ($priv ne 'pch') {
5360: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5361: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5362: $env{'request.course.id'});
5363: }
5364: return '';
5365: }
5366: }
5367:
5368: # Resource preferences
5369:
5370: if ($thisallowed=~/R/) {
5371: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5372: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
5373: if ($priv ne 'pch') {
5374: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5375: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5376: }
5377: return '';
5378: }
5379: }
5380:
5381: # Restricted by state or randomout?
5382:
5383: if ($thisallowed=~/X/) {
5384: if ($env{'acc.randomout'}) {
5385: if (!$symb) { $symb=&symbread($uri,1); }
5386: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
5387: return '';
5388: }
5389: }
5390: if (&condval($statecond)) {
5391: return '2';
5392: } else {
5393: return '';
5394: }
5395: }
5396:
5397: if ($thisallowed eq 'A') {
5398: return 'A';
5399: } elsif ($thisallowed eq 'B') {
5400: return 'B';
5401: }
5402: return 'F';
5403: }
5404:
5405: sub split_uri_for_cond {
5406: my $uri=&deversion(&declutter(shift));
5407: my @uriparts=split(/\//,$uri);
5408: my $filename=pop(@uriparts);
5409: my $pathname=join('/',@uriparts);
5410: return ($pathname,$filename);
5411: }
5412: # --------------------------------------------------- Is a resource on the map?
5413:
5414: sub is_on_map {
5415: my ($pathname,$filename) = &split_uri_for_cond(shift);
5416: #Trying to find the conditional for the file
5417: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
5418: /\&\Q$filename\E\:([\d\|]+)\&/);
5419: if ($match) {
5420: return (1,$1);
5421: } else {
5422: return (0,0);
5423: }
5424: }
5425:
5426: # --------------------------------------------------------- Get symb from alias
5427:
5428: sub get_symb_from_alias {
5429: my $symb=shift;
5430: my ($map,$resid,$url)=&decode_symb($symb);
5431: # Already is a symb
5432: if ($url) { return $symb; }
5433: # Must be an alias
5434: my $aliassymb='';
5435: my %bighash;
5436: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5437: &GDBM_READER(),0640)) {
5438: my $rid=$bighash{'mapalias_'.$symb};
5439: if ($rid) {
5440: my ($mapid,$resid)=split(/\./,$rid);
5441: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5442: $resid,$bighash{'src_'.$rid});
5443: }
5444: untie %bighash;
5445: }
5446: return $aliassymb;
5447: }
5448:
5449: # ----------------------------------------------------------------- Define Role
5450:
5451: sub definerole {
5452: if (allowed('mcr','/')) {
5453: my ($rolename,$sysrole,$domrole,$courole)=@_;
5454: foreach my $role (split(':',$sysrole)) {
5455: my ($crole,$cqual)=split(/\&/,$role);
5456: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5457: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5458: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5459: return "refused:s:$crole&$cqual";
5460: }
5461: }
5462: }
5463: foreach my $role (split(':',$domrole)) {
5464: my ($crole,$cqual)=split(/\&/,$role);
5465: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5466: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5467: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
5468: return "refused:d:$crole&$cqual";
5469: }
5470: }
5471: }
5472: foreach my $role (split(':',$courole)) {
5473: my ($crole,$cqual)=split(/\&/,$role);
5474: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5475: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5476: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5477: return "refused:c:$crole&$cqual";
5478: }
5479: }
5480: }
5481: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5482: "$env{'user.domain'}:$env{'user.name'}:".
5483: "rolesdef_$rolename=".
5484: escape($sysrole.'_'.$domrole.'_'.$courole);
5485: return reply($command,$env{'user.home'});
5486: } else {
5487: return 'refused';
5488: }
5489: }
5490:
5491: # ---------------- Make a metadata query against the network of library servers
5492:
5493: sub metadata_query {
5494: my ($query,$custom,$customshow,$server_array)=@_;
5495: my %rhash;
5496: my %libserv = &all_library();
5497: my @server_list = (defined($server_array) ? @$server_array
5498: : keys(%libserv) );
5499: for my $server (@server_list) {
5500: #SD remove this
5501: &logthis("Querying server:$server");
5502: unless ($custom or $customshow) {
5503: my $reply=&reply("querysend:".&escape($query),$server);
5504: $rhash{$server}=$reply;
5505: }
5506: else {
5507: my $reply=&reply("querysend:".&escape($query).':'.
5508: &escape($custom).':'.&escape($customshow),
5509: $server);
5510: $rhash{$server}=$reply;
5511: }
5512: }
5513: return \%rhash;
5514: }
5515:
5516: # ----------------------------------------- Send log queries and wait for reply
5517:
5518: sub log_query {
5519: my ($uname,$udom,$query,%filters)=@_;
5520: my $uhome=&homeserver($uname,$udom);
5521: if ($uhome eq 'no_host') { return 'error: no_host'; }
5522: my $uhost=&hostname($uhome);
5523: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
5524: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5525: $uhome);
5526: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
5527: return get_query_reply($queryid);
5528: }
5529:
5530: # -------------------------- Update MySQL table for portfolio file
5531:
5532: sub update_portfolio_table {
5533: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
5534: if ($group ne '') {
5535: $file_name =~s /^\Q$group\E//;
5536: }
5537: my $homeserver = &homeserver($uname,$udom);
5538: my $queryid=
5539: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5540: ':'.&escape($file_name).':'.$action,$homeserver);
5541: my $reply = &get_query_reply($queryid);
5542: return $reply;
5543: }
5544:
5545: # -------------------------- Update MySQL allusers table
5546:
5547: sub update_allusers_table {
5548: my ($uname,$udom,$names) = @_;
5549: my $homeserver = &homeserver($uname,$udom);
5550: my $queryid=
5551: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5552: 'lastname='.&escape($names->{'lastname'}).'%%'.
5553: 'firstname='.&escape($names->{'firstname'}).'%%'.
5554: 'middlename='.&escape($names->{'middlename'}).'%%'.
5555: 'generation='.&escape($names->{'generation'}).'%%'.
5556: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5557: 'id='.&escape($names->{'id'}),$homeserver);
5558: my $reply = &get_query_reply($queryid);
5559: return $reply;
5560: }
5561:
5562: # ------- Request retrieval of institutional classlists for course(s)
5563:
5564: sub fetch_enrollment_query {
5565: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
5566: my $homeserver;
5567: my $maxtries = 1;
5568: if ($context eq 'automated') {
5569: $homeserver = $perlvar{'lonHostID'};
5570: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
5571: } else {
5572: $homeserver = &homeserver($cnum,$dom);
5573: }
5574: my $host=&hostname($homeserver);
5575: my $cmd = '';
5576: foreach my $affiliate (keys(%{$affiliatesref})) {
5577: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5578: }
5579: $cmd =~ s/%%$//;
5580: $cmd = &escape($cmd);
5581: my $query = 'fetchenrollment';
5582: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
5583: unless ($queryid=~/^\Q$host\E\_/) {
5584: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5585: return 'error: '.$queryid;
5586: }
5587: my $reply = &get_query_reply($queryid);
5588: my $tries = 1;
5589: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5590: $reply = &get_query_reply($queryid);
5591: $tries ++;
5592: }
5593: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5594: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5595: } else {
5596: my @responses = split(/:/,$reply);
5597: if ($homeserver eq $perlvar{'lonHostID'}) {
5598: foreach my $line (@responses) {
5599: my ($key,$value) = split(/=/,$line,2);
5600: $$replyref{$key} = $value;
5601: }
5602: } else {
5603: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
5604: foreach my $line (@responses) {
5605: my ($key,$value) = split(/=/,$line);
5606: $$replyref{$key} = $value;
5607: if ($value > 0) {
5608: foreach my $item (@{$$affiliatesref{$key}}) {
5609: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
5610: my $destname = $pathname.'/'.$filename;
5611: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
5612: if ($xml_classlist =~ /^error/) {
5613: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5614: } else {
5615: if ( open(FILE,">$destname") ) {
5616: print FILE &unescape($xml_classlist);
5617: close(FILE);
5618: } else {
5619: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
5620: }
5621: }
5622: }
5623: }
5624: }
5625: }
5626: return 'ok';
5627: }
5628: return 'error';
5629: }
5630:
5631: sub get_query_reply {
5632: my $queryid=shift;
5633: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5634: my $reply='';
5635: for (1..100) {
5636: sleep 2;
5637: if (-e $replyfile.'.end') {
5638: if (open(my $fh,$replyfile)) {
5639: $reply = join('',<$fh>);
5640: close($fh);
5641: } else { return 'error: reply_file_error'; }
5642: return &unescape($reply);
5643: }
5644: }
5645: return 'timeout:'.$queryid;
5646: }
5647:
5648: sub courselog_query {
5649: #
5650: # possible filters:
5651: # url: url or symb
5652: # username
5653: # domain
5654: # action: view, submit, grade
5655: # start: timestamp
5656: # end: timestamp
5657: #
5658: my (%filters)=@_;
5659: unless ($env{'request.course.id'}) { return 'no_course'; }
5660: if ($filters{'url'}) {
5661: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5662: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5663: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5664: }
5665: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5666: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
5667: return &log_query($cname,$cdom,'courselog',%filters);
5668: }
5669:
5670: sub userlog_query {
5671: #
5672: # possible filters:
5673: # action: log check role
5674: # start: timestamp
5675: # end: timestamp
5676: #
5677: my ($uname,$udom,%filters)=@_;
5678: return &log_query($uname,$udom,'userlog',%filters);
5679: }
5680:
5681: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5682:
5683: sub auto_run {
5684: my ($cnum,$cdom) = @_;
5685: my $response = 0;
5686: my $settings;
5687: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5688: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5689: $settings = $domconfig{'autoenroll'};
5690: if ($settings->{'run'} eq '1') {
5691: $response = 1;
5692: }
5693: } else {
5694: my $homeserver;
5695: if (&is_course($cdom,$cnum)) {
5696: $homeserver = &homeserver($cnum,$cdom);
5697: } else {
5698: $homeserver = &domain($cdom,'primary');
5699: }
5700: if ($homeserver ne 'no_host') {
5701: $response = &reply('autorun:'.$cdom,$homeserver);
5702: }
5703: }
5704: return $response;
5705: }
5706:
5707: sub auto_get_sections {
5708: my ($cnum,$cdom,$inst_coursecode) = @_;
5709: my $homeserver;
5710: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5711: $homeserver = &homeserver($cnum,$cdom);
5712: }
5713: if (!defined($homeserver)) {
5714: if ($cdom =~ /^$match_domain$/) {
5715: $homeserver = &domain($cdom,'primary');
5716: }
5717: }
5718: my @secs;
5719: if (defined($homeserver)) {
5720: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5721: unless ($response eq 'refused') {
5722: @secs = split(/:/,$response);
5723: }
5724: }
5725: return @secs;
5726: }
5727:
5728: sub auto_new_course {
5729: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5730: my $homeserver = &homeserver($cnum,$cdom);
5731: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
5732: return $response;
5733: }
5734:
5735: sub auto_validate_courseID {
5736: my ($cnum,$cdom,$inst_course_id) = @_;
5737: my $homeserver = &homeserver($cnum,$cdom);
5738: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5739: return $response;
5740: }
5741:
5742: sub auto_validate_instcode {
5743: my ($cnum,$cdom,$instcode,$owner) = @_;
5744: my ($homeserver,$response);
5745: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5746: $homeserver = &homeserver($cnum,$cdom);
5747: }
5748: if (!defined($homeserver)) {
5749: if ($cdom =~ /^$match_domain$/) {
5750: $homeserver = &domain($cdom,'primary');
5751: }
5752: }
5753: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
5754: &escape($instcode).':'.&escape($owner),$homeserver));
5755: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5756: return ($outcome,$description);
5757: }
5758:
5759: sub auto_create_password {
5760: my ($cnum,$cdom,$authparam,$udom) = @_;
5761: my ($homeserver,$response);
5762: my $create_passwd = 0;
5763: my $authchk = '';
5764: if ($udom =~ /^$match_domain$/) {
5765: $homeserver = &domain($udom,'primary');
5766: }
5767: if ($homeserver eq '') {
5768: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5769: $homeserver = &homeserver($cnum,$cdom);
5770: }
5771: }
5772: if ($homeserver eq '') {
5773: $authchk = 'nodomain';
5774: } else {
5775: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5776: if ($response eq 'refused') {
5777: $authchk = 'refused';
5778: } else {
5779: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5780: }
5781: }
5782: return ($authparam,$create_passwd,$authchk);
5783: }
5784:
5785: sub auto_photo_permission {
5786: my ($cnum,$cdom,$students) = @_;
5787: my $homeserver = &homeserver($cnum,$cdom);
5788: my ($outcome,$perm_reqd,$conditions) =
5789: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5790: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5791: return (undef,undef);
5792: }
5793: return ($outcome,$perm_reqd,$conditions);
5794: }
5795:
5796: sub auto_checkphotos {
5797: my ($uname,$udom,$pid) = @_;
5798: my $homeserver = &homeserver($uname,$udom);
5799: my ($result,$resulttype);
5800: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5801: &escape($uname).':'.&escape($pid),
5802: $homeserver));
5803: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5804: return (undef,undef);
5805: }
5806: if ($outcome) {
5807: ($result,$resulttype) = split(/:/,$outcome);
5808: }
5809: return ($result,$resulttype);
5810: }
5811:
5812: sub auto_photochoice {
5813: my ($cnum,$cdom) = @_;
5814: my $homeserver = &homeserver($cnum,$cdom);
5815: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5816: &escape($cdom),
5817: $homeserver)));
5818: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5819: return (undef,undef);
5820: }
5821: return ($update,$comment);
5822: }
5823:
5824: sub auto_photoupdate {
5825: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5826: my $homeserver = &homeserver($cnum,$dom);
5827: my $host=&hostname($homeserver);
5828: my $cmd = '';
5829: my $maxtries = 1;
5830: foreach my $affiliate (keys(%{$affiliatesref})) {
5831: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5832: }
5833: $cmd =~ s/%%$//;
5834: $cmd = &escape($cmd);
5835: my $query = 'institutionalphotos';
5836: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5837: unless ($queryid=~/^\Q$host\E\_/) {
5838: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5839: return 'error: '.$queryid;
5840: }
5841: my $reply = &get_query_reply($queryid);
5842: my $tries = 1;
5843: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5844: $reply = &get_query_reply($queryid);
5845: $tries ++;
5846: }
5847: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5848: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5849: } else {
5850: my @responses = split(/:/,$reply);
5851: my $outcome = shift(@responses);
5852: foreach my $item (@responses) {
5853: my ($key,$value) = split(/=/,$item);
5854: $$photo{$key} = $value;
5855: }
5856: return $outcome;
5857: }
5858: return 'error';
5859: }
5860:
5861: sub auto_instcode_format {
5862: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5863: $cat_order) = @_;
5864: my $courses = '';
5865: my @homeservers;
5866: if ($caller eq 'global') {
5867: my %servers = &get_servers($codedom,'library');
5868: foreach my $tryserver (keys(%servers)) {
5869: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5870: push(@homeservers,$tryserver);
5871: }
5872: }
5873: } elsif ($caller eq 'requests') {
5874: if ($codedom =~ /^$match_domain$/) {
5875: my $chome = &domain($codedom,'primary');
5876: unless ($chome eq 'no_host') {
5877: push(@homeservers,$chome);
5878: }
5879: }
5880: } else {
5881: push(@homeservers,&homeserver($caller,$codedom));
5882: }
5883: foreach my $code (keys(%{$instcodes})) {
5884: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
5885: }
5886: chop($courses);
5887: my $ok_response = 0;
5888: my $response;
5889: while (@homeservers > 0 && $ok_response == 0) {
5890: my $server = shift(@homeservers);
5891: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5892: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5893: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
5894: split(/:/,$response);
5895: %{$codes} = (%{$codes},&str2hash($codes_str));
5896: push(@{$codetitles},&str2array($codetitles_str));
5897: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5898: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5899: $ok_response = 1;
5900: }
5901: }
5902: if ($ok_response) {
5903: return 'ok';
5904: } else {
5905: return $response;
5906: }
5907: }
5908:
5909: sub auto_instcode_defaults {
5910: my ($domain,$returnhash,$code_order) = @_;
5911: my @homeservers;
5912:
5913: my %servers = &get_servers($domain,'library');
5914: foreach my $tryserver (keys(%servers)) {
5915: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5916: push(@homeservers,$tryserver);
5917: }
5918: }
5919:
5920: my $response;
5921: foreach my $server (@homeservers) {
5922: $response=&reply('autoinstcodedefaults:'.$domain,$server);
5923: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5924:
5925: foreach my $pair (split(/\&/,$response)) {
5926: my ($name,$value)=split(/\=/,$pair);
5927: if ($name eq 'code_order') {
5928: @{$code_order} = split(/\&/,&unescape($value));
5929: } else {
5930: $returnhash->{&unescape($name)}=&unescape($value);
5931: }
5932: }
5933: return 'ok';
5934: }
5935:
5936: return $response;
5937: }
5938:
5939: sub auto_possible_instcodes {
5940: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
5941: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
5942: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
5943: return;
5944: }
5945: my (@homeservers,$uhome);
5946: if (defined(&domain($domain,'primary'))) {
5947: $uhome=&domain($domain,'primary');
5948: push(@homeservers,&domain($domain,'primary'));
5949: } else {
5950: my %servers = &get_servers($domain,'library');
5951: foreach my $tryserver (keys(%servers)) {
5952: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5953: push(@homeservers,$tryserver);
5954: }
5955: }
5956: }
5957: my $response;
5958: foreach my $server (@homeservers) {
5959: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5960: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5961: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
5962: split(':',$response);
5963: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5964: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
5965: foreach my $item (split('&',$cat_title)) {
5966: my ($name,$value)=split('=',$item);
5967: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
5968: }
5969: foreach my $item (split('&',$cat_order)) {
5970: my ($name,$value)=split('=',$item);
5971: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
5972: }
5973: return 'ok';
5974: }
5975: return $response;
5976: }
5977:
5978: sub auto_courserequest_checks {
5979: my ($dom) = @_;
5980: my ($homeserver,%validations);
5981: if ($dom =~ /^$match_domain$/) {
5982: $homeserver = &domain($dom,'primary');
5983: }
5984: unless ($homeserver eq 'no_host') {
5985: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
5986: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
5987: my @items = split(/&/,$response);
5988: foreach my $item (@items) {
5989: my ($key,$value) = split('=',$item);
5990: $validations{&unescape($key)} = &thaw_unescape($value);
5991: }
5992: }
5993: }
5994: return %validations;
5995: }
5996:
5997: sub auto_courserequest_validation {
5998: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
5999: my ($homeserver,$response);
6000: if ($dom =~ /^$match_domain$/) {
6001: $homeserver = &domain($dom,'primary');
6002: }
6003: unless ($homeserver eq 'no_host') {
6004:
6005: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
6006: ':'.&escape($crstype).':'.&escape($inststatuslist).
6007: ':'.&escape($instcode).':'.&escape($instseclist),
6008: $homeserver));
6009: }
6010: return $response;
6011: }
6012:
6013: sub auto_validate_class_sec {
6014: my ($cdom,$cnum,$owners,$inst_class) = @_;
6015: my $homeserver = &homeserver($cnum,$cdom);
6016: my $ownerlist;
6017: if (ref($owners) eq 'ARRAY') {
6018: $ownerlist = join(',',@{$owners});
6019: } else {
6020: $ownerlist = $owners;
6021: }
6022: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
6023: &escape($ownerlist).':'.$cdom,$homeserver);
6024: return $response;
6025: }
6026:
6027: # ------------------------------------------------------- Course Group routines
6028:
6029: sub get_coursegroups {
6030: my ($cdom,$cnum,$group,$namespace) = @_;
6031: return(&dump($namespace,$cdom,$cnum,$group));
6032: }
6033:
6034: sub modify_coursegroup {
6035: my ($cdom,$cnum,$groupsettings) = @_;
6036: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6037: }
6038:
6039: sub toggle_coursegroup_status {
6040: my ($cdom,$cnum,$group,$action) = @_;
6041: my ($from_namespace,$to_namespace);
6042: if ($action eq 'delete') {
6043: $from_namespace = 'coursegroups';
6044: $to_namespace = 'deleted_groups';
6045: } else {
6046: $from_namespace = 'deleted_groups';
6047: $to_namespace = 'coursegroups';
6048: }
6049: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
6050: if (my $tmp = &error(%curr_group)) {
6051: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6052: return ('read error',$tmp);
6053: } else {
6054: my %savedsettings = %curr_group;
6055: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
6056: my $deloutcome;
6057: if ($result eq 'ok') {
6058: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
6059: } else {
6060: return ('write error',$result);
6061: }
6062: if ($deloutcome eq 'ok') {
6063: return 'ok';
6064: } else {
6065: return ('delete error',$deloutcome);
6066: }
6067: }
6068: }
6069:
6070: sub modify_group_roles {
6071: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
6072: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6073: my $role = 'gr/'.&escape($userprivs);
6074: my ($uname,$udom) = split(/:/,$user);
6075: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
6076: if ($result eq 'ok') {
6077: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6078: }
6079: return $result;
6080: }
6081:
6082: sub modify_coursegroup_membership {
6083: my ($cdom,$cnum,$membership) = @_;
6084: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6085: return $result;
6086: }
6087:
6088: sub get_active_groups {
6089: my ($udom,$uname,$cdom,$cnum) = @_;
6090: my $now = time;
6091: my %groups = ();
6092: foreach my $key (keys(%env)) {
6093: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
6094: my ($start,$end) = split(/\./,$env{$key});
6095: if (($end!=0) && ($end<$now)) { next; }
6096: if (($start!=0) && ($start>$now)) { next; }
6097: if ($1 eq $cdom && $2 eq $cnum) {
6098: $groups{$3} = $env{$key} ;
6099: }
6100: }
6101: }
6102: return %groups;
6103: }
6104:
6105: sub get_group_membership {
6106: my ($cdom,$cnum,$group) = @_;
6107: return(&dump('groupmembership',$cdom,$cnum,$group));
6108: }
6109:
6110: sub get_users_groups {
6111: my ($udom,$uname,$courseid) = @_;
6112: my @usersgroups;
6113: my $cachetime=1800;
6114:
6115: my $hashid="$udom:$uname:$courseid";
6116: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6117: if (defined($cached)) {
6118: @usersgroups = split(/:/,$grouplist);
6119: } else {
6120: $grouplist = '';
6121: my $courseurl = &courseid_to_courseurl($courseid);
6122: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
6123: my $access_end = $env{'course.'.$courseid.
6124: '.default_enrollment_end_date'};
6125: my $now = time;
6126: foreach my $key (keys(%roleshash)) {
6127: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6128: my $group = $1;
6129: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6130: my $start = $2;
6131: my $end = $1;
6132: if ($start == -1) { next; } # deleted from group
6133: if (($start!=0) && ($start>$now)) { next; }
6134: if (($end!=0) && ($end<$now)) {
6135: if ($access_end && $access_end < $now) {
6136: if ($access_end - $end < 86400) {
6137: push(@usersgroups,$group);
6138: }
6139: }
6140: next;
6141: }
6142: push(@usersgroups,$group);
6143: }
6144: }
6145: }
6146: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6147: $grouplist = join(':',@usersgroups);
6148: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
6149: }
6150: return @usersgroups;
6151: }
6152:
6153: sub devalidate_getgroups_cache {
6154: my ($udom,$uname,$cdom,$cnum)=@_;
6155: my $courseid = $cdom.'_'.$cnum;
6156:
6157: my $hashid="$udom:$uname:$courseid";
6158: &devalidate_cache_new('getgroups',$hashid);
6159: }
6160:
6161: # ------------------------------------------------------------------ Plain Text
6162:
6163: sub plaintext {
6164: my ($short,$type,$cid,$forcedefault) = @_;
6165: if ($short =~ m{^cr/}) {
6166: return (split('/',$short))[-1];
6167: }
6168: if (!defined($cid)) {
6169: $cid = $env{'request.course.id'};
6170: }
6171: my %rolenames = (
6172: Course => 'std',
6173: Community => 'alt1',
6174: );
6175: if ($cid ne '') {
6176: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6177: unless ($forcedefault) {
6178: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6179: &Apache::lonlocal::mt_escape(\$roletext);
6180: return &Apache::lonlocal::mt($roletext);
6181: }
6182: }
6183: }
6184: if ((defined($type)) && (defined($rolenames{$type})) &&
6185: (defined($rolenames{$type})) &&
6186: (defined($prp{$short}{$rolenames{$type}}))) {
6187: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
6188: } elsif ($cid ne '') {
6189: my $crstype = $env{'course.'.$cid.'.type'};
6190: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6191: (defined($prp{$short}{$rolenames{$crstype}}))) {
6192: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6193: }
6194: }
6195: return &Apache::lonlocal::mt($prp{$short}{'std'});
6196: }
6197:
6198: # ----------------------------------------------------------------- Assign Role
6199:
6200: sub assignrole {
6201: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6202: $context)=@_;
6203: my $mrole;
6204: if ($role =~ /^cr\//) {
6205: my $cwosec=$url;
6206: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6207: unless (&allowed('ccr',$cwosec)) {
6208: my $refused = 1;
6209: if ($context eq 'requestcourses') {
6210: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6211: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6212: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6213: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6214: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6215: if ($crsenv{'internal.courseowner'} eq
6216: $env{'user.name'}.':'.$env{'user.domain'}) {
6217: $refused = '';
6218: }
6219: }
6220: }
6221: }
6222: }
6223: if ($refused) {
6224: &logthis('Refused custom assignrole: '.
6225: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6226: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6227: return 'refused';
6228: }
6229: }
6230: $mrole='cr';
6231: } elsif ($role =~ /^gr\//) {
6232: my $cwogrp=$url;
6233: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
6234: unless (&allowed('mdg',$cwogrp)) {
6235: &logthis('Refused group assignrole: '.
6236: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6237: $env{'user.name'}.' at '.$env{'user.domain'});
6238: return 'refused';
6239: }
6240: $mrole='gr';
6241: } else {
6242: my $cwosec=$url;
6243: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6244: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6245: my $refused;
6246: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6247: if (!(&allowed('c'.$role,$url))) {
6248: $refused = 1;
6249: }
6250: } else {
6251: $refused = 1;
6252: }
6253: if ($refused) {
6254: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6255: if (!$selfenroll && $context eq 'course') {
6256: my %crsenv;
6257: if ($role eq 'cc' || $role eq 'co') {
6258: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6259: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6260: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6261: if ($crsenv{'internal.courseowner'} eq
6262: $env{'user.name'}.':'.$env{'user.domain'}) {
6263: $refused = '';
6264: }
6265: }
6266: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6267: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6268: if ($crsenv{'internal.courseowner'} eq
6269: $env{'user.name'}.':'.$env{'user.domain'}) {
6270: $refused = '';
6271: }
6272: }
6273: }
6274: }
6275: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6276: $refused = '';
6277: } elsif ($context eq 'requestcourses') {
6278: my @possroles = ('st','ta','ep','in','cc','co');
6279: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
6280: my $wrongcc;
6281: if ($cnum =~ /^$match_community$/) {
6282: $wrongcc = 1 if ($role eq 'cc');
6283: } else {
6284: $wrongcc = 1 if ($role eq 'co');
6285: }
6286: unless ($wrongcc) {
6287: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6288: if ($crsenv{'internal.courseowner'} eq
6289: $env{'user.name'}.':'.$env{'user.domain'}) {
6290: $refused = '';
6291: }
6292: }
6293: }
6294: }
6295: if ($refused) {
6296: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6297: ' '.$role.' '.$end.' '.$start.' by '.
6298: $env{'user.name'}.' at '.$env{'user.domain'});
6299: return 'refused';
6300: }
6301: }
6302: }
6303: $mrole=$role;
6304: }
6305: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6306: "$udom:$uname:$url".'_'."$mrole=$role";
6307: if ($end) { $command.='_'.$end; }
6308: if ($start) {
6309: if ($end) {
6310: $command.='_'.$start;
6311: } else {
6312: $command.='_0_'.$start;
6313: }
6314: }
6315: my $origstart = $start;
6316: my $origend = $end;
6317: my $delflag;
6318: # actually delete
6319: if ($deleteflag) {
6320: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
6321: # modify command to delete the role
6322: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
6323: "$udom:$uname:$url".'_'."$mrole";
6324: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
6325: # set start and finish to negative values for userrolelog
6326: $start=-1;
6327: $end=-1;
6328: $delflag = 1;
6329: }
6330: }
6331: # send command
6332: my $answer=&reply($command,&homeserver($uname,$udom));
6333: # log new user role if status is ok
6334: if ($answer eq 'ok') {
6335: &userrolelog($role,$uname,$udom,$url,$start,$end);
6336: # for course roles, perform group memberships changes triggered by role change.
6337: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
6338: unless ($role =~ /^gr/) {
6339: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
6340: $origstart,$selfenroll,$context);
6341: }
6342: if ($role eq 'cc') {
6343: &autoupdate_coowners($url,$end,$start,$uname,$udom);
6344: }
6345: }
6346: return $answer;
6347: }
6348:
6349: sub autoupdate_coowners {
6350: my ($url,$end,$start,$uname,$udom) = @_;
6351: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
6352: if (($cdom ne '') && ($cnum ne '')) {
6353: my $now = time;
6354: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
6355: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
6356: my %coursehash = &coursedescription($cdom.'_'.$cnum);
6357: my $instcode = $coursehash{'internal.coursecode'};
6358: if ($instcode ne '') {
6359: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
6360: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
6361: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
6362: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
6363: if ($result eq 'valid') {
6364: if ($coursehash{'internal.co-owners'}) {
6365: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6366: push(@newcoowners,$coowner);
6367: }
6368: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
6369: push(@newcoowners,$uname.':'.$udom);
6370: }
6371: @newcoowners = sort(@newcoowners);
6372: } else {
6373: push(@newcoowners,$uname.':'.$udom);
6374: }
6375: } else {
6376: if ($coursehash{'internal.co-owners'}) {
6377: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6378: unless ($coowner eq $uname.':'.$udom) {
6379: push(@newcoowners,$coowner);
6380: }
6381: }
6382: unless (@newcoowners > 0) {
6383: $delcoowners = 1;
6384: $coowners = '';
6385: }
6386: }
6387: }
6388: if (@newcoowners || $delcoowners) {
6389: &store_coowners($cdom,$cnum,$coursehash{'home'},
6390: $delcoowners,@newcoowners);
6391: }
6392: }
6393: }
6394: }
6395: }
6396: }
6397: }
6398:
6399: sub store_coowners {
6400: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
6401: my $cid = $cdom.'_'.$cnum;
6402: my ($coowners,$delresult,$putresult);
6403: if (@newcoowners) {
6404: $coowners = join(',',@newcoowners);
6405: my %coownershash = (
6406: 'internal.co-owners' => $coowners,
6407: );
6408: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
6409: if ($putresult eq 'ok') {
6410: if ($env{'course.'.$cid.'.num'} eq $cnum) {
6411: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
6412: }
6413: }
6414: }
6415: if ($delcoowners) {
6416: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
6417: if ($delresult eq 'ok') {
6418: if ($env{'course.'.$cid.'.internal.co-owners'}) {
6419: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
6420: }
6421: }
6422: }
6423: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
6424: my %crsinfo =
6425: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6426: if (ref($crsinfo{$cid}) eq 'HASH') {
6427: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
6428: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
6429: }
6430: }
6431: }
6432:
6433: # -------------------------------------------------- Modify user authentication
6434: # Overrides without validation
6435:
6436: sub modifyuserauth {
6437: my ($udom,$uname,$umode,$upass)=@_;
6438: my $uhome=&homeserver($uname,$udom);
6439: unless (&allowed('mau',$udom)) { return 'refused'; }
6440: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
6441: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6442: ' in domain '.$env{'request.role.domain'});
6443: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6444: &escape($upass),$uhome);
6445: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
6446: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6447: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6448: &log($udom,,$uname,$uhome,
6449: 'Authentication changed by '.$env{'user.domain'}.', '.
6450: $env{'user.name'}.', '.$umode.
6451: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6452: unless ($reply eq 'ok') {
6453: &logthis('Authentication mode error: '.$reply);
6454: return 'error: '.$reply;
6455: }
6456: return 'ok';
6457: }
6458:
6459: # --------------------------------------------------------------- Modify a user
6460:
6461: sub modifyuser {
6462: my ($udom, $uname, $uid,
6463: $umode, $upass, $first,
6464: $middle, $last, $gene,
6465: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
6466: $udom= &LONCAPA::clean_domain($udom);
6467: $uname=&LONCAPA::clean_username($uname);
6468: my $showcandelete = 'none';
6469: if (ref($candelete) eq 'ARRAY') {
6470: if (@{$candelete} > 0) {
6471: $showcandelete = join(', ',@{$candelete});
6472: }
6473: }
6474: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
6475: $umode.', '.$first.', '.$middle.', '.
6476: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
6477: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6478: ' desiredhome not specified').
6479: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6480: ' in domain '.$env{'request.role.domain'});
6481: my $uhome=&homeserver($uname,$udom,'true');
6482: # ----------------------------------------------------------------- Create User
6483: if (($uhome eq 'no_host') &&
6484: (($umode && $upass) || ($umode eq 'localauth'))) {
6485: my $unhome='';
6486: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
6487: $unhome = $desiredhome;
6488: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6489: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
6490: } else { # load balancing routine for determining $unhome
6491: my $loadm=10000000;
6492: my %servers = &get_servers($udom,'library');
6493: foreach my $tryserver (keys(%servers)) {
6494: my $answer=reply('load',$tryserver);
6495: if (($answer=~/\d+/) && ($answer<$loadm)) {
6496: $loadm=$answer;
6497: $unhome=$tryserver;
6498: }
6499: }
6500: }
6501: if (($unhome eq '') || ($unhome eq 'no_host')) {
6502: return 'error: unable to find a home server for '.$uname.
6503: ' in domain '.$udom;
6504: }
6505: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6506: &escape($upass),$unhome);
6507: unless ($reply eq 'ok') {
6508: return 'error: '.$reply;
6509: }
6510: $uhome=&homeserver($uname,$udom,'true');
6511: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
6512: return 'error: unable verify users home machine.';
6513: }
6514: } # End of creation of new user
6515: # ---------------------------------------------------------------------- Add ID
6516: if ($uid) {
6517: $uid=~tr/A-Z/a-z/;
6518: my %uidhash=&idrget($udom,$uname);
6519: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6520: && (!$forceid)) {
6521: unless ($uid eq $uidhash{$uname}) {
6522: return 'error: user id "'.$uid.'" does not match '.
6523: 'current user id "'.$uidhash{$uname}.'".';
6524: }
6525: } else {
6526: &idput($udom,($uname => $uid));
6527: }
6528: }
6529: # -------------------------------------------------------------- Add names, etc
6530: my @tmp=&get('environment',
6531: ['firstname','middlename','lastname','generation','id',
6532: 'permanentemail','inststatus'],
6533: $udom,$uname);
6534: my %names;
6535: if ($tmp[0] =~ m/^error:.*/) {
6536: %names=();
6537: } else {
6538: %names = @tmp;
6539: }
6540: #
6541: # If name, email and/or uid are blank (e.g., because an uploaded file
6542: # of users did not contain them), do not overwrite existing values
6543: # unless field is in $candelete array ref.
6544: #
6545:
6546: my @fields = ('firstname','middlename','lastname','generation',
6547: 'permanentemail','id');
6548: my %newvalues;
6549: if (ref($candelete) eq 'ARRAY') {
6550: foreach my $field (@fields) {
6551: if (grep(/^\Q$field\E$/,@{$candelete})) {
6552: if ($field eq 'firstname') {
6553: $names{$field} = $first;
6554: } elsif ($field eq 'middlename') {
6555: $names{$field} = $middle;
6556: } elsif ($field eq 'lastname') {
6557: $names{$field} = $last;
6558: } elsif ($field eq 'generation') {
6559: $names{$field} = $gene;
6560: } elsif ($field eq 'permanentemail') {
6561: $names{$field} = $email;
6562: } elsif ($field eq 'id') {
6563: $names{$field} = $uid;
6564: }
6565: }
6566: }
6567: }
6568: if ($first) { $names{'firstname'} = $first; }
6569: if (defined($middle)) { $names{'middlename'} = $middle; }
6570: if ($last) { $names{'lastname'} = $last; }
6571: if (defined($gene)) { $names{'generation'} = $gene; }
6572: if ($email) {
6573: $email=~s/[^\w\@\.\-\,]//gs;
6574: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
6575: }
6576: if ($uid) { $names{'id'} = $uid; }
6577: if (defined($inststatus)) {
6578: $names{'inststatus'} = '';
6579: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6580: if (ref($usertypes) eq 'HASH') {
6581: my @okstatuses;
6582: foreach my $item (split(/:/,$inststatus)) {
6583: if (defined($usertypes->{$item})) {
6584: push(@okstatuses,$item);
6585: }
6586: }
6587: if (@okstatuses) {
6588: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6589: }
6590: }
6591: }
6592: my $reply = &put('environment', \%names, $udom,$uname);
6593: if ($reply ne 'ok') { return 'error: '.$reply; }
6594: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
6595: &devalidate_cache_new('namescache',$uname.':'.$udom);
6596: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6597: $umode.', '.$first.', '.$middle.', '.
6598: $last.', '.$gene.', '.$email.', '.$inststatus;
6599: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6600: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6601: } else {
6602: $logmsg .= ' during self creation';
6603: }
6604: &logthis($logmsg);
6605: return 'ok';
6606: }
6607:
6608: # -------------------------------------------------------------- Modify student
6609:
6610: sub modifystudent {
6611: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
6612: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
6613: $selfenroll,$context,$inststatus)=@_;
6614: if (!$cid) {
6615: unless ($cid=$env{'request.course.id'}) {
6616: return 'not_in_class';
6617: }
6618: }
6619: # --------------------------------------------------------------- Make the user
6620: my $reply=&modifyuser
6621: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
6622: $desiredhome,$email,$inststatus);
6623: unless ($reply eq 'ok') { return $reply; }
6624: # This will cause &modify_student_enrollment to get the uid from the
6625: # students environment
6626: $uid = undef if (!$forceid);
6627: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
6628: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
6629: return $reply;
6630: }
6631:
6632: sub modify_student_enrollment {
6633: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
6634: my ($cdom,$cnum,$chome);
6635: if (!$cid) {
6636: unless ($cid=$env{'request.course.id'}) {
6637: return 'not_in_class';
6638: }
6639: $cdom=$env{'course.'.$cid.'.domain'};
6640: $cnum=$env{'course.'.$cid.'.num'};
6641: } else {
6642: ($cdom,$cnum)=split(/_/,$cid);
6643: }
6644: $chome=$env{'course.'.$cid.'.home'};
6645: if (!$chome) {
6646: $chome=&homeserver($cnum,$cdom);
6647: }
6648: if (!$chome) { return 'unknown_course'; }
6649: # Make sure the user exists
6650: my $uhome=&homeserver($uname,$udom);
6651: if (($uhome eq '') || ($uhome eq 'no_host')) {
6652: return 'error: no such user';
6653: }
6654: # Get student data if we were not given enough information
6655: if (!defined($first) || $first eq '' ||
6656: !defined($last) || $last eq '' ||
6657: !defined($uid) || $uid eq '' ||
6658: !defined($middle) || $middle eq '' ||
6659: !defined($gene) || $gene eq '') {
6660: # They did not supply us with enough data to enroll the student, so
6661: # we need to pick up more information.
6662: my %tmp = &get('environment',
6663: ['firstname','middlename','lastname', 'generation','id']
6664: ,$udom,$uname);
6665:
6666: #foreach my $key (keys(%tmp)) {
6667: # &logthis("key $key = ".$tmp{$key});
6668: #}
6669: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6670: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6671: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
6672: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
6673: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6674: }
6675: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
6676: my $reply=cput('classlist',
6677: {"$uname:$udom" =>
6678: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
6679: $cdom,$cnum);
6680: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6681: return 'error: '.$reply;
6682: } else {
6683: &devalidate_getsection_cache($udom,$uname,$cid);
6684: }
6685: # Add student role to user
6686: my $uurl='/'.$cid;
6687: $uurl=~s/\_/\//g;
6688: if ($usec) {
6689: $uurl.='/'.$usec;
6690: }
6691: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
6692: }
6693:
6694: sub format_name {
6695: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6696: my $name;
6697: if ($first ne 'lastname') {
6698: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6699: } else {
6700: if ($lastname=~/\S/) {
6701: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6702: $name=~s/\s+,/,/;
6703: } else {
6704: $name.= $firstname.' '.$middlename.' '.$generation;
6705: }
6706: }
6707: $name=~s/^\s+//;
6708: $name=~s/\s+$//;
6709: $name=~s/\s+/ /g;
6710: return $name;
6711: }
6712:
6713: # ------------------------------------------------- Write to course preferences
6714:
6715: sub writecoursepref {
6716: my ($courseid,%prefs)=@_;
6717: $courseid=~s/^\///;
6718: $courseid=~s/\_/\//g;
6719: my ($cdomain,$cnum)=split(/\//,$courseid);
6720: my $chome=homeserver($cnum,$cdomain);
6721: if (($chome eq '') || ($chome eq 'no_host')) {
6722: return 'error: no such course';
6723: }
6724: my $cstring='';
6725: foreach my $pref (keys(%prefs)) {
6726: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
6727: }
6728: $cstring=~s/\&$//;
6729: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6730: }
6731:
6732: # ---------------------------------------------------------- Make/modify course
6733:
6734: sub createcourse {
6735: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6736: $course_owner,$crstype,$cnum,$context,$category)=@_;
6737: $url=&declutter($url);
6738: my $cid='';
6739: if ($context eq 'requestcourses') {
6740: my $can_create = 0;
6741: my ($ownername,$ownerdom) = split(':',$course_owner);
6742: if ($udom eq $ownerdom) {
6743: if (&usertools_access($ownername,$ownerdom,$category,undef,
6744: $context)) {
6745: $can_create = 1;
6746: }
6747: } else {
6748: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6749: $category);
6750: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6751: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6752: if (@curr > 0) {
6753: my @options = qw(approval validate autolimit);
6754: my $optregex = join('|',@options);
6755: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6756: $can_create = 1;
6757: }
6758: }
6759: }
6760: }
6761: if ($can_create) {
6762: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6763: unless (&allowed('ccc',$udom)) {
6764: return 'refused';
6765: }
6766: }
6767: } else {
6768: return 'refused';
6769: }
6770: } elsif (!&allowed('ccc',$udom)) {
6771: return 'refused';
6772: }
6773: # --------------------------------------------------------------- Get Unique ID
6774: my $uname;
6775: if ($cnum =~ /^$match_courseid$/) {
6776: my $chome=&homeserver($cnum,$udom,'true');
6777: if (($chome eq '') || ($chome eq 'no_host')) {
6778: $uname = $cnum;
6779: } else {
6780: $uname = &generate_coursenum($udom,$crstype);
6781: }
6782: } else {
6783: $uname = &generate_coursenum($udom,$crstype);
6784: }
6785: return $uname if ($uname =~ /^error/);
6786: # -------------------------------------------------- Check supplied server name
6787: if (!defined($course_server)) {
6788: if (defined(&domain($udom,'primary'))) {
6789: $course_server = &domain($udom,'primary');
6790: } else {
6791: $course_server = $env{'user.home'};
6792: }
6793: }
6794: my %host_servers =
6795: &Apache::lonnet::get_servers($udom,'library');
6796: unless ($host_servers{$course_server}) {
6797: return 'error: invalid home server for course: '.$course_server;
6798: }
6799: # ------------------------------------------------------------- Make the course
6800: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
6801: $course_server);
6802: unless ($reply eq 'ok') { return 'error: '.$reply; }
6803: my $uhome=&homeserver($uname,$udom,'true');
6804: if (($uhome eq '') || ($uhome eq 'no_host')) {
6805: return 'error: no such course';
6806: }
6807: # ----------------------------------------------------------------- Course made
6808: # log existence
6809: my $now = time;
6810: my $newcourse = {
6811: $udom.'_'.$uname => {
6812: description => $description,
6813: inst_code => $inst_code,
6814: owner => $course_owner,
6815: type => $crstype,
6816: creator => $env{'user.name'}.':'.
6817: $env{'user.domain'},
6818: created => $now,
6819: context => $context,
6820: },
6821: };
6822: &courseidput($udom,$newcourse,$uhome,'notime');
6823: # set toplevel url
6824: my $topurl=$url;
6825: unless ($nonstandard) {
6826: # ------------------------------------------ For standard courses, make top url
6827: my $mapurl=&clutter($url);
6828: if ($mapurl eq '/res/') { $mapurl=''; }
6829: $env{'form.initmap'}=(<<ENDINITMAP);
6830: <map>
6831: <resource id="1" type="start"></resource>
6832: <resource id="2" src="$mapurl"></resource>
6833: <resource id="3" type="finish"></resource>
6834: <link index="1" from="1" to="2"></link>
6835: <link index="2" from="2" to="3"></link>
6836: </map>
6837: ENDINITMAP
6838: $topurl=&declutter(
6839: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
6840: );
6841: }
6842: # ----------------------------------------------------------- Write preferences
6843: &writecoursepref($udom.'_'.$uname,
6844: ('description' => $description,
6845: 'url' => $topurl,
6846: 'internal.creator' => $env{'user.name'}.':'.
6847: $env{'user.domain'},
6848: 'internal.created' => $now,
6849: 'internal.creationcontext' => $context)
6850: );
6851: return '/'.$udom.'/'.$uname;
6852: }
6853:
6854: # ------------------------------------------------------------------- Create ID
6855: sub generate_coursenum {
6856: my ($udom,$crstype) = @_;
6857: my $domdesc = &domain($udom);
6858: return 'error: invalid domain' if ($domdesc eq '');
6859: my $first;
6860: if ($crstype eq 'Community') {
6861: $first = '0';
6862: } else {
6863: $first = int(1+rand(9));
6864: }
6865: my $uname=$first.
6866: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6867: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6868: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6869: # ----------------------------------------------- Make sure that does not exist
6870: my $uhome=&homeserver($uname,$udom,'true');
6871: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6872: if ($crstype eq 'Community') {
6873: $first = '0';
6874: } else {
6875: $first = int(1+rand(9));
6876: }
6877: $uname=$first.
6878: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6879: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6880: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6881: $uhome=&homeserver($uname,$udom,'true');
6882: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6883: return 'error: unable to generate unique course-ID';
6884: }
6885: }
6886: return $uname;
6887: }
6888:
6889: sub is_course {
6890: my ($cdom,$cnum) = @_;
6891: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
6892: undef,'.');
6893: if (exists($courses{$cdom.'_'.$cnum})) {
6894: return 1;
6895: }
6896: return 0;
6897: }
6898:
6899: sub store_userdata {
6900: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
6901: my $result;
6902: if ($datakey ne '') {
6903: if (ref($storehash) eq 'HASH') {
6904: if ($udom eq '' || $uname eq '') {
6905: $udom = $env{'user.domain'};
6906: $uname = $env{'user.name'};
6907: }
6908: my $uhome=&homeserver($uname,$udom);
6909: if (($uhome eq '') || ($uhome eq 'no_host')) {
6910: $result = 'error: no_host';
6911: } else {
6912: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6913: $storehash->{'host'} = $perlvar{'lonHostID'};
6914:
6915: my $namevalue='';
6916: foreach my $key (keys(%{$storehash})) {
6917: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6918: }
6919: $namevalue=~s/\&$//;
6920: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
6921: "$namespace:$datakey:$namevalue",$uhome);
6922: }
6923: } else {
6924: $result = 'error: data to store was not a hash reference';
6925: }
6926: } else {
6927: $result= 'error: invalid requestkey';
6928: }
6929: return $result;
6930: }
6931:
6932: # ---------------------------------------------------------- Assign Custom Role
6933:
6934: sub assigncustomrole {
6935: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
6936: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
6937: $end,$start,$deleteflag,$selfenroll,$context);
6938: }
6939:
6940: # ----------------------------------------------------------------- Revoke Role
6941:
6942: sub revokerole {
6943: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
6944: my $now=time;
6945: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
6946: }
6947:
6948: # ---------------------------------------------------------- Revoke Custom Role
6949:
6950: sub revokecustomrole {
6951: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
6952: my $now=time;
6953: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
6954: $deleteflag,$selfenroll,$context);
6955: }
6956:
6957: # ------------------------------------------------------------ Disk usage
6958: sub diskusage {
6959: my ($udom,$uname,$directorypath,$getpropath)=@_;
6960: $directorypath =~ s/\/$//;
6961: my $listing=&reply('du2:'.&escape($directorypath).':'
6962: .&escape($getpropath).':'.&escape($uname).':'
6963: .&escape($udom),homeserver($uname,$udom));
6964: if ($listing eq 'unknown_cmd') {
6965: if ($getpropath) {
6966: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6967: }
6968: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6969: }
6970: return $listing;
6971: }
6972:
6973: sub is_locked {
6974: my ($file_name, $domain, $user) = @_;
6975: my @check;
6976: my $is_locked;
6977: push @check, $file_name;
6978: my %locked = &get('file_permissions',\@check,
6979: $env{'user.domain'},$env{'user.name'});
6980: my ($tmp)=keys(%locked);
6981: if ($tmp=~/^error:/) { undef(%locked); }
6982:
6983: if (ref($locked{$file_name}) eq 'ARRAY') {
6984: $is_locked = 'false';
6985: foreach my $entry (@{$locked{$file_name}}) {
6986: if (ref($entry) eq 'ARRAY') {
6987: $is_locked = 'true';
6988: last;
6989: }
6990: }
6991: } else {
6992: $is_locked = 'false';
6993: }
6994: }
6995:
6996: sub declutter_portfile {
6997: my ($file) = @_;
6998: $file =~ s{^(/portfolio/|portfolio/)}{/};
6999: return $file;
7000: }
7001:
7002: # ------------------------------------------------------------- Mark as Read Only
7003:
7004: sub mark_as_readonly {
7005: my ($domain,$user,$files,$what) = @_;
7006: my %current_permissions = &dump('file_permissions',$domain,$user);
7007: my ($tmp)=keys(%current_permissions);
7008: if ($tmp=~/^error:/) { undef(%current_permissions); }
7009: foreach my $file (@{$files}) {
7010: $file = &declutter_portfile($file);
7011: push(@{$current_permissions{$file}},$what);
7012: }
7013: &put('file_permissions',\%current_permissions,$domain,$user);
7014: return;
7015: }
7016:
7017: # ------------------------------------------------------------Save Selected Files
7018:
7019: sub save_selected_files {
7020: my ($user, $path, @files) = @_;
7021: my $filename = $user."savedfiles";
7022: my @other_files = &files_not_in_path($user, $path);
7023: open (OUT, '>'.$tmpdir.$filename);
7024: foreach my $file (@files) {
7025: print (OUT $env{'form.currentpath'}.$file."\n");
7026: }
7027: foreach my $file (@other_files) {
7028: print (OUT $file."\n");
7029: }
7030: close (OUT);
7031: return 'ok';
7032: }
7033:
7034: sub clear_selected_files {
7035: my ($user) = @_;
7036: my $filename = $user."savedfiles";
7037: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7038: print (OUT undef);
7039: close (OUT);
7040: return ("ok");
7041: }
7042:
7043: sub files_in_path {
7044: my ($user, $path) = @_;
7045: my $filename = $user."savedfiles";
7046: my %return_files;
7047: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7048: while (my $line_in = <IN>) {
7049: chomp ($line_in);
7050: my @paths_and_file = split (m!/!, $line_in);
7051: my $file_part = pop (@paths_and_file);
7052: my $path_part = join ('/', @paths_and_file);
7053: $path_part.='/';
7054: my $path_and_file = $path_part.$file_part;
7055: if ($path_part eq $path) {
7056: $return_files{$file_part}= 'selected';
7057: }
7058: }
7059: close (IN);
7060: return (\%return_files);
7061: }
7062:
7063: # called in portfolio select mode, to show files selected NOT in current directory
7064: sub files_not_in_path {
7065: my ($user, $path) = @_;
7066: my $filename = $user."savedfiles";
7067: my @return_files;
7068: my $path_part;
7069: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7070: while (my $line = <IN>) {
7071: #ok, I know it's clunky, but I want it to work
7072: my @paths_and_file = split(m|/|, $line);
7073: my $file_part = pop(@paths_and_file);
7074: chomp($file_part);
7075: my $path_part = join('/', @paths_and_file);
7076: $path_part .= '/';
7077: my $path_and_file = $path_part.$file_part;
7078: if ($path_part ne $path) {
7079: push(@return_files, ($path_and_file));
7080: }
7081: }
7082: close(OUT);
7083: return (@return_files);
7084: }
7085:
7086: #----------------------------------------------Get portfolio file permissions
7087:
7088: sub get_portfile_permissions {
7089: my ($domain,$user) = @_;
7090: my %current_permissions = &dump('file_permissions',$domain,$user);
7091: my ($tmp)=keys(%current_permissions);
7092: if ($tmp=~/^error:/) { undef(%current_permissions); }
7093: return \%current_permissions;
7094: }
7095:
7096: #---------------------------------------------Get portfolio file access controls
7097:
7098: sub get_access_controls {
7099: my ($current_permissions,$group,$file) = @_;
7100: my %access;
7101: my $real_file = $file;
7102: $file =~ s/\.meta$//;
7103: if (defined($file)) {
7104: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7105: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
7106: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
7107: }
7108: }
7109: } else {
7110: foreach my $key (keys(%{$current_permissions})) {
7111: if ($key =~ /\0accesscontrol$/) {
7112: if (defined($group)) {
7113: if ($key !~ m-^\Q$group\E/-) {
7114: next;
7115: }
7116: }
7117: my ($fullpath) = split(/\0/,$key);
7118: if (ref($$current_permissions{$key}) eq 'HASH') {
7119: foreach my $control (keys(%{$$current_permissions{$key}})) {
7120: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7121: }
7122: }
7123: }
7124: }
7125: }
7126: return %access;
7127: }
7128:
7129: sub modify_access_controls {
7130: my ($file_name,$changes,$domain,$user)=@_;
7131: my ($outcome,$deloutcome);
7132: my %store_permissions;
7133: my %new_values;
7134: my %new_control;
7135: my %translation;
7136: my @deletions = ();
7137: my $now = time;
7138: if (exists($$changes{'activate'})) {
7139: if (ref($$changes{'activate'}) eq 'HASH') {
7140: my @newitems = sort(keys(%{$$changes{'activate'}}));
7141: my $numnew = scalar(@newitems);
7142: for (my $i=0; $i<$numnew; $i++) {
7143: my $newkey = $newitems[$i];
7144: my $newid = &Apache::loncommon::get_cgi_id();
7145: if ($newkey =~ /^\d+:/) {
7146: $newkey =~ s/^(\d+)/$newid/;
7147: $translation{$1} = $newid;
7148: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7149: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7150: $translation{$1} = $newid;
7151: }
7152: $new_values{$file_name."\0".$newkey} =
7153: $$changes{'activate'}{$newitems[$i]};
7154: $new_control{$newkey} = $now;
7155: }
7156: }
7157: }
7158: my %todelete;
7159: my %changed_items;
7160: foreach my $action ('delete','update') {
7161: if (exists($$changes{$action})) {
7162: if (ref($$changes{$action}) eq 'HASH') {
7163: foreach my $key (keys(%{$$changes{$action}})) {
7164: my ($itemnum) = ($key =~ /^([^:]+):/);
7165: if ($action eq 'delete') {
7166: $todelete{$itemnum} = 1;
7167: } else {
7168: $changed_items{$itemnum} = $key;
7169: }
7170: }
7171: }
7172: }
7173: }
7174: # get lock on access controls for file.
7175: my $lockhash = {
7176: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7177: ':'.$env{'user.domain'},
7178: };
7179: my $tries = 0;
7180: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7181:
7182: while (($gotlock ne 'ok') && $tries <3) {
7183: $tries ++;
7184: sleep 1;
7185: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7186: }
7187: if ($gotlock eq 'ok') {
7188: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7189: my ($tmp)=keys(%curr_permissions);
7190: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7191: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7192: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7193: if (ref($curr_controls) eq 'HASH') {
7194: foreach my $control_item (keys(%{$curr_controls})) {
7195: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7196: if (defined($todelete{$itemnum})) {
7197: push(@deletions,$file_name."\0".$control_item);
7198: } else {
7199: if (defined($changed_items{$itemnum})) {
7200: $new_control{$changed_items{$itemnum}} = $now;
7201: push(@deletions,$file_name."\0".$control_item);
7202: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7203: } else {
7204: $new_control{$control_item} = $$curr_controls{$control_item};
7205: }
7206: }
7207: }
7208: }
7209: }
7210: my ($group);
7211: if (&is_course($domain,$user)) {
7212: ($group,my $file) = split(/\//,$file_name,2);
7213: }
7214: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7215: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7216: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7217: # remove lock
7218: my @del_lock = ($file_name."\0".'locked_access_records');
7219: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
7220: my $sqlresult =
7221: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
7222: $group);
7223: } else {
7224: $outcome = "error: could not obtain lockfile\n";
7225: }
7226: return ($outcome,$deloutcome,\%new_values,\%translation);
7227: }
7228:
7229: sub make_public_indefinitely {
7230: my ($requrl) = @_;
7231: my $now = time;
7232: my $action = 'activate';
7233: my $aclnum = 0;
7234: if (&is_portfolio_url($requrl)) {
7235: my (undef,$udom,$unum,$file_name,$group) =
7236: &parse_portfolio_url($requrl);
7237: my $current_perms = &get_portfile_permissions($udom,$unum);
7238: my %access_controls = &get_access_controls($current_perms,
7239: $group,$file_name);
7240: foreach my $key (keys(%{$access_controls{$file_name}})) {
7241: my ($num,$scope,$end,$start) =
7242: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7243: if ($scope eq 'public') {
7244: if ($start <= $now && $end == 0) {
7245: $action = 'none';
7246: } else {
7247: $action = 'update';
7248: $aclnum = $num;
7249: }
7250: last;
7251: }
7252: }
7253: if ($action eq 'none') {
7254: return 'ok';
7255: } else {
7256: my %changes;
7257: my $newend = 0;
7258: my $newstart = $now;
7259: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7260: $changes{$action}{$newkey} = {
7261: type => 'public',
7262: time => {
7263: start => $newstart,
7264: end => $newend,
7265: },
7266: };
7267: my ($outcome,$deloutcome,$new_values,$translation) =
7268: &modify_access_controls($file_name,\%changes,$udom,$unum);
7269: return $outcome;
7270: }
7271: } else {
7272: return 'invalid';
7273: }
7274: }
7275:
7276: #------------------------------------------------------Get Marked as Read Only
7277:
7278: sub get_marked_as_readonly {
7279: my ($domain,$user,$what,$group) = @_;
7280: my $current_permissions = &get_portfile_permissions($domain,$user);
7281: my @readonly_files;
7282: my $cmp1=$what;
7283: if (ref($what)) { $cmp1=join('',@{$what}) };
7284: while (my ($file_name,$value) = each(%{$current_permissions})) {
7285: if (defined($group)) {
7286: if ($file_name !~ m-^\Q$group\E/-) {
7287: next;
7288: }
7289: }
7290: if (ref($value) eq "ARRAY"){
7291: foreach my $stored_what (@{$value}) {
7292: my $cmp2=$stored_what;
7293: if (ref($stored_what) eq 'ARRAY') {
7294: $cmp2=join('',@{$stored_what});
7295: }
7296: if ($cmp1 eq $cmp2) {
7297: push(@readonly_files, $file_name);
7298: last;
7299: } elsif (!defined($what)) {
7300: push(@readonly_files, $file_name);
7301: last;
7302: }
7303: }
7304: }
7305: }
7306: return @readonly_files;
7307: }
7308: #-----------------------------------------------------------Get Marked as Read Only Hash
7309:
7310: sub get_marked_as_readonly_hash {
7311: my ($current_permissions,$group,$what) = @_;
7312: my %readonly_files;
7313: while (my ($file_name,$value) = each(%{$current_permissions})) {
7314: if (defined($group)) {
7315: if ($file_name !~ m-^\Q$group\E/-) {
7316: next;
7317: }
7318: }
7319: if (ref($value) eq "ARRAY"){
7320: foreach my $stored_what (@{$value}) {
7321: if (ref($stored_what) eq 'ARRAY') {
7322: foreach my $lock_descriptor(@{$stored_what}) {
7323: if ($lock_descriptor eq 'graded') {
7324: $readonly_files{$file_name} = 'graded';
7325: } elsif ($lock_descriptor eq 'handback') {
7326: $readonly_files{$file_name} = 'handback';
7327: } else {
7328: if (!exists($readonly_files{$file_name})) {
7329: $readonly_files{$file_name} = 'locked';
7330: }
7331: }
7332: }
7333: }
7334: }
7335: }
7336: }
7337: return %readonly_files;
7338: }
7339: # ------------------------------------------------------------ Unmark as Read Only
7340:
7341: sub unmark_as_readonly {
7342: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7343: # for portfolio submissions, $what contains [$symb,$crsid]
7344: my ($domain,$user,$what,$file_name,$group) = @_;
7345: $file_name = &declutter_portfile($file_name);
7346: my $symb_crs = $what;
7347: if (ref($what)) { $symb_crs=join('',@$what); }
7348: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
7349: my ($tmp)=keys(%current_permissions);
7350: if ($tmp=~/^error:/) { undef(%current_permissions); }
7351: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
7352: foreach my $file (@readonly_files) {
7353: my $clean_file = &declutter_portfile($file);
7354: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
7355: my $current_locks = $current_permissions{$file};
7356: my @new_locks;
7357: my @del_keys;
7358: if (ref($current_locks) eq "ARRAY"){
7359: foreach my $locker (@{$current_locks}) {
7360: my $compare=$locker;
7361: if (ref($locker) eq 'ARRAY') {
7362: $compare=join('',@{$locker});
7363: if ($compare ne $symb_crs) {
7364: push(@new_locks, $locker);
7365: }
7366: }
7367: }
7368: if (scalar(@new_locks) > 0) {
7369: $current_permissions{$file} = \@new_locks;
7370: } else {
7371: push(@del_keys, $file);
7372: &del('file_permissions',\@del_keys, $domain, $user);
7373: delete($current_permissions{$file});
7374: }
7375: }
7376: }
7377: &put('file_permissions',\%current_permissions,$domain,$user);
7378: return;
7379: }
7380:
7381: # ------------------------------------------------------------ Directory lister
7382:
7383: sub dirlist {
7384: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
7385: $uri=~s/^\///;
7386: $uri=~s/\/$//;
7387: my ($udom, $uname);
7388: if ($getuserdir) {
7389: $udom = $userdomain;
7390: $uname = $username;
7391: } else {
7392: (undef,$udom,$uname)=split(/\//,$uri);
7393: if(defined($userdomain)) {
7394: $udom = $userdomain;
7395: }
7396: if(defined($username)) {
7397: $uname = $username;
7398: }
7399: }
7400: my ($dirRoot,$listing,@listing_results);
7401:
7402: $dirRoot = $perlvar{'lonDocRoot'};
7403: if (defined($getpropath)) {
7404: $dirRoot = &propath($udom,$uname);
7405: $dirRoot =~ s/\/$//;
7406: } elsif (defined($getuserdir)) {
7407: my $subdir=$uname.'__';
7408: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7409: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7410: ."/$udom/$subdir/$uname";
7411: } elsif (defined($alternateRoot)) {
7412: $dirRoot = $alternateRoot;
7413: }
7414:
7415: if($udom) {
7416: if($uname) {
7417: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
7418: .$getuserdir.':'.&escape($dirRoot)
7419: .':'.&escape($uname).':'.&escape($udom),
7420: &homeserver($uname,$udom));
7421: if ($listing eq 'unknown_cmd') {
7422: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7423: &homeserver($uname,$udom));
7424: } else {
7425: @listing_results = map { &unescape($_); } split(/:/,$listing);
7426: }
7427: if ($listing eq 'unknown_cmd') {
7428: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7429: &homeserver($uname,$udom));
7430: @listing_results = split(/:/,$listing);
7431: } else {
7432: @listing_results = map { &unescape($_); } split(/:/,$listing);
7433: }
7434: return @listing_results;
7435: } elsif(!$alternateRoot) {
7436: my %allusers;
7437: my %servers = &get_servers($udom,'library');
7438: foreach my $tryserver (keys(%servers)) {
7439: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7440: &escape($udom),$tryserver);
7441: if ($listing eq 'unknown_cmd') {
7442: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7443: $udom, $tryserver);
7444: } else {
7445: @listing_results = map { &unescape($_); } split(/:/,$listing);
7446: }
7447: if ($listing eq 'unknown_cmd') {
7448: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7449: $udom, $tryserver);
7450: @listing_results = split(/:/,$listing);
7451: } else {
7452: @listing_results =
7453: map { &unescape($_); } split(/:/,$listing);
7454: }
7455: if ($listing_results[0] ne 'no_such_dir' &&
7456: $listing_results[0] ne 'empty' &&
7457: $listing_results[0] ne 'con_lost') {
7458: foreach my $line (@listing_results) {
7459: my ($entry) = split(/&/,$line,2);
7460: $allusers{$entry} = 1;
7461: }
7462: }
7463: }
7464: my $alluserstr='';
7465: foreach my $user (sort(keys(%allusers))) {
7466: $alluserstr.=$user.'&user:';
7467: }
7468: $alluserstr=~s/:$//;
7469: return split(/:/,$alluserstr);
7470: } else {
7471: return ('missing user name');
7472: }
7473: } elsif(!defined($getpropath)) {
7474: my @all_domains = sort(&all_domains());
7475: foreach my $domain (@all_domains) {
7476: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7477: }
7478: return @all_domains;
7479: } else {
7480: return ('missing domain');
7481: }
7482: }
7483:
7484: # --------------------------------------------- GetFileTimestamp
7485: # This function utilizes dirlist and returns the date stamp for
7486: # when it was last modified. It will also return an error of -1
7487: # if an error occurs
7488:
7489: sub GetFileTimestamp {
7490: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
7491: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7492: $studentName = &LONCAPA::clean_username($studentName);
7493: my ($fileStat) =
7494: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7495: undef,$getuserdir);
7496: my @stats = split('&', $fileStat);
7497: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7498: # @stats contains first the filename, then the stat output
7499: return $stats[10]; # so this is 10 instead of 9.
7500: } else {
7501: return -1;
7502: }
7503: }
7504:
7505: sub stat_file {
7506: my ($uri) = @_;
7507: $uri = &clutter_with_no_wrapper($uri);
7508:
7509: my ($udom,$uname,$file);
7510: if ($uri =~ m-^/(uploaded|editupload)/-) {
7511: ($udom,$uname,$file) =
7512: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
7513: $file = 'userfiles/'.$file;
7514: }
7515: if ($uri =~ m-^/res/-) {
7516: ($udom,$uname) =
7517: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
7518: $file = $uri;
7519: }
7520:
7521: if (!$udom || !$uname || !$file) {
7522: # unable to handle the uri
7523: return ();
7524: }
7525: my $getpropath;
7526: if ($file =~ /^userfiles\//) {
7527: $getpropath = 1;
7528: }
7529: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
7530: my @stats = split('&', $result);
7531:
7532: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7533: shift(@stats); #filename is first
7534: return @stats;
7535: }
7536: return ();
7537: }
7538:
7539: # -------------------------------------------------------- Value of a Condition
7540:
7541: # gets the value of a specific preevaluated condition
7542: # stored in the string $env{user.state.<cid>}
7543: # or looks up a condition reference in the bighash and if if hasn't
7544: # already been evaluated recurses into docondval to get the value of
7545: # the condition, then memoizing it to
7546: # $env{user.state.<cid>.<condition>}
7547: sub directcondval {
7548: my $number=shift;
7549: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
7550: &Apache::lonuserstate::evalstate();
7551: }
7552: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7553: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7554: } elsif ($number =~ /^_/) {
7555: my $sub_condition;
7556: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7557: &GDBM_READER(),0640)) {
7558: $sub_condition=$bighash{'conditions'.$number};
7559: untie(%bighash);
7560: }
7561: my $value = &docondval($sub_condition);
7562: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
7563: return $value;
7564: }
7565: if ($env{'user.state.'.$env{'request.course.id'}}) {
7566: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
7567: } else {
7568: return 2;
7569: }
7570: }
7571:
7572: # get the collection of conditions for this resource
7573: sub condval {
7574: my $condidx=shift;
7575: my $allpathcond='';
7576: foreach my $cond (split(/\|/,$condidx)) {
7577: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7578: $allpathcond.=
7579: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7580: }
7581: }
7582: $allpathcond=~s/\|$//;
7583: return &docondval($allpathcond);
7584: }
7585:
7586: #evaluates an expression of conditions
7587: sub docondval {
7588: my ($allpathcond) = @_;
7589: my $result=0;
7590: if ($env{'request.course.id'}
7591: && defined($allpathcond)) {
7592: my $operand='|';
7593: my @stack;
7594: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7595: if ($chunk eq '(') {
7596: push @stack,($operand,$result);
7597: } elsif ($chunk eq ')') {
7598: my $before=pop @stack;
7599: if (pop @stack eq '&') {
7600: $result=$result>$before?$before:$result;
7601: } else {
7602: $result=$result>$before?$result:$before;
7603: }
7604: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7605: $operand=$chunk;
7606: } else {
7607: my $new=directcondval($chunk);
7608: if ($operand eq '&') {
7609: $result=$result>$new?$new:$result;
7610: } else {
7611: $result=$result>$new?$result:$new;
7612: }
7613: }
7614: }
7615: }
7616: return $result;
7617: }
7618:
7619: # ---------------------------------------------------- Devalidate courseresdata
7620:
7621: sub devalidatecourseresdata {
7622: my ($coursenum,$coursedomain)=@_;
7623: my $hashid=$coursenum.':'.$coursedomain;
7624: &devalidate_cache_new('courseres',$hashid);
7625: }
7626:
7627:
7628: # --------------------------------------------------- Course Resourcedata Query
7629: #
7630: # Parameters:
7631: # $coursenum - Number of the course.
7632: # $coursedomain - Domain at which the course was created.
7633: # Returns:
7634: # A hash of the course parameters along (I think) with timestamps
7635: # and version info.
7636:
7637: sub get_courseresdata {
7638: my ($coursenum,$coursedomain)=@_;
7639: my $coursehom=&homeserver($coursenum,$coursedomain);
7640: my $hashid=$coursenum.':'.$coursedomain;
7641: my ($result,$cached)=&is_cached_new('courseres',$hashid);
7642: my %dumpreply;
7643: unless (defined($cached)) {
7644: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
7645: $result=\%dumpreply;
7646: my ($tmp) = keys(%dumpreply);
7647: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7648: &do_cache_new('courseres',$hashid,$result,600);
7649: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7650: return $tmp;
7651: } elsif ($tmp =~ /^(error)/) {
7652: $result=undef;
7653: &do_cache_new('courseres',$hashid,$result,600);
7654: }
7655: }
7656: return $result;
7657: }
7658:
7659: sub devalidateuserresdata {
7660: my ($uname,$udom)=@_;
7661: my $hashid="$udom:$uname";
7662: &devalidate_cache_new('userres',$hashid);
7663: }
7664:
7665: sub get_userresdata {
7666: my ($uname,$udom)=@_;
7667: #most student don\'t have any data set, check if there is some data
7668: if (&EXT_cache_status($udom,$uname)) { return undef; }
7669:
7670: my $hashid="$udom:$uname";
7671: my ($result,$cached)=&is_cached_new('userres',$hashid);
7672: if (!defined($cached)) {
7673: my %resourcedata=&dump('resourcedata',$udom,$uname);
7674: $result=\%resourcedata;
7675: &do_cache_new('userres',$hashid,$result,600);
7676: }
7677: my ($tmp)=keys(%$result);
7678: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7679: return $result;
7680: }
7681: #error 2 occurs when the .db doesn't exist
7682: if ($tmp!~/error: 2 /) {
7683: &logthis("<font color=\"blue\">WARNING:".
7684: " Trying to get resource data for ".
7685: $uname." at ".$udom.": ".
7686: $tmp."</font>");
7687: } elsif ($tmp=~/error: 2 /) {
7688: #&EXT_cache_set($udom,$uname);
7689: &do_cache_new('userres',$hashid,undef,600);
7690: undef($tmp); # not really an error so don't send it back
7691: }
7692: return $tmp;
7693: }
7694: #----------------------------------------------- resdata - return resource data
7695: # Purpose:
7696: # Return resource data for either users or for a course.
7697: # Parameters:
7698: # $name - Course/user name.
7699: # $domain - Name of the domain the user/course is registered on.
7700: # $type - Type of thing $name is (must be 'course' or 'user'
7701: # @which - Array of names of resources desired.
7702: # Returns:
7703: # The value of the first reasource in @which that is found in the
7704: # resource hash.
7705: # Exceptional Conditions:
7706: # If the $type passed in is not valid (not the string 'course' or
7707: # 'user', an undefined reference is returned.
7708: # If none of the resources are found, an undef is returned
7709: sub resdata {
7710: my ($name,$domain,$type,@which)=@_;
7711: my $result;
7712: if ($type eq 'course') {
7713: $result=&get_courseresdata($name,$domain);
7714: } elsif ($type eq 'user') {
7715: $result=&get_userresdata($name,$domain);
7716: }
7717: if (!ref($result)) { return $result; }
7718: foreach my $item (@which) {
7719: if (defined($result->{$item->[0]})) {
7720: return [$result->{$item->[0]},$item->[1]];
7721: }
7722: }
7723: return undef;
7724: }
7725:
7726: #
7727: # EXT resource caching routines
7728: #
7729:
7730: sub clear_EXT_cache_status {
7731: &delenv('cache.EXT.');
7732: }
7733:
7734: sub EXT_cache_status {
7735: my ($target_domain,$target_user) = @_;
7736: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7737: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
7738: # We know already the user has no data
7739: return 1;
7740: } else {
7741: return 0;
7742: }
7743: }
7744:
7745: sub EXT_cache_set {
7746: my ($target_domain,$target_user) = @_;
7747: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7748: #&appenv({$cachename => time});
7749: }
7750:
7751: # --------------------------------------------------------- Value of a Variable
7752: sub EXT {
7753:
7754: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
7755: unless ($varname) { return ''; }
7756: #get real user name/domain, courseid and symb
7757: my $courseid;
7758: my $publicuser;
7759: if ($symbparm) {
7760: $symbparm=&get_symb_from_alias($symbparm);
7761: }
7762: if (!($uname && $udom)) {
7763: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
7764: if (!$symbparm) { $symbparm=$cursymb; }
7765: } else {
7766: $courseid=$env{'request.course.id'};
7767: }
7768: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7769: my $rest;
7770: if (defined($therest[0])) {
7771: $rest=join('.',@therest);
7772: } else {
7773: $rest='';
7774: }
7775:
7776: my $qualifierrest=$qualifier;
7777: if ($rest) { $qualifierrest.='.'.$rest; }
7778: my $spacequalifierrest=$space;
7779: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
7780: if ($realm eq 'user') {
7781: # --------------------------------------------------------------- user.resource
7782: if ($space eq 'resource') {
7783: if ( (defined($Apache::lonhomework::parsing_a_problem)
7784: || defined($Apache::lonhomework::parsing_a_task))
7785: &&
7786: ($symbparm eq &symbread()) ) {
7787: # if we are in the middle of processing the resource the
7788: # get the value we are planning on committing
7789: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7790: return $Apache::lonhomework::results{$qualifierrest};
7791: } else {
7792: return $Apache::lonhomework::history{$qualifierrest};
7793: }
7794: } else {
7795: my %restored;
7796: if ($publicuser || $env{'request.state'} eq 'construct') {
7797: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7798: } else {
7799: %restored=&restore($symbparm,$courseid,$udom,$uname);
7800: }
7801: return $restored{$qualifierrest};
7802: }
7803: # ----------------------------------------------------------------- user.access
7804: } elsif ($space eq 'access') {
7805: # FIXME - not supporting calls for a specific user
7806: return &allowed($qualifier,$rest);
7807: # ------------------------------------------ user.preferences, user.environment
7808: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
7809: if (($uname eq $env{'user.name'}) &&
7810: ($udom eq $env{'user.domain'})) {
7811: return $env{join('.',('environment',$qualifierrest))};
7812: } else {
7813: my %returnhash;
7814: if (!$publicuser) {
7815: %returnhash=&userenvironment($udom,$uname,
7816: $qualifierrest);
7817: }
7818: return $returnhash{$qualifierrest};
7819: }
7820: # ----------------------------------------------------------------- user.course
7821: } elsif ($space eq 'course') {
7822: # FIXME - not supporting calls for a specific user
7823: return $env{join('.',('request.course',$qualifier))};
7824: # ------------------------------------------------------------------- user.role
7825: } elsif ($space eq 'role') {
7826: # FIXME - not supporting calls for a specific user
7827: my ($role,$where)=split(/\./,$env{'request.role'});
7828: if ($qualifier eq 'value') {
7829: return $role;
7830: } elsif ($qualifier eq 'extent') {
7831: return $where;
7832: }
7833: # ----------------------------------------------------------------- user.domain
7834: } elsif ($space eq 'domain') {
7835: return $udom;
7836: # ------------------------------------------------------------------- user.name
7837: } elsif ($space eq 'name') {
7838: return $uname;
7839: # ---------------------------------------------------- Any other user namespace
7840: } else {
7841: my %reply;
7842: if (!$publicuser) {
7843: %reply=&get($space,[$qualifierrest],$udom,$uname);
7844: }
7845: return $reply{$qualifierrest};
7846: }
7847: } elsif ($realm eq 'query') {
7848: # ---------------------------------------------- pull stuff out of query string
7849: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7850: [$spacequalifierrest]);
7851: return $env{'form.'.$spacequalifierrest};
7852: } elsif ($realm eq 'request') {
7853: # ------------------------------------------------------------- request.browser
7854: if ($space eq 'browser') {
7855: if ($qualifier eq 'textremote') {
7856: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
7857: return 1;
7858: } else {
7859: return 0;
7860: }
7861: } else {
7862: return $env{'browser.'.$qualifier};
7863: }
7864: # ------------------------------------------------------------ request.filename
7865: } else {
7866: return $env{'request.'.$spacequalifierrest};
7867: }
7868: } elsif ($realm eq 'course') {
7869: # ---------------------------------------------------------- course.description
7870: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
7871: } elsif ($realm eq 'resource') {
7872:
7873: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
7874: if (!$symbparm) { $symbparm=&symbread(); }
7875: }
7876:
7877: if ($space eq 'title') {
7878: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7879: return &gettitle($symbparm);
7880: }
7881:
7882: if ($space eq 'map') {
7883: my ($map) = &decode_symb($symbparm);
7884: return &symbread($map);
7885: }
7886: if ($space eq 'filename') {
7887: if ($symbparm) {
7888: return &clutter((&decode_symb($symbparm))[2]);
7889: }
7890: return &hreflocation('',$env{'request.filename'});
7891: }
7892:
7893: my ($section, $group, @groups);
7894: my ($courselevelm,$courselevel);
7895: if ($symbparm && defined($courseid) &&
7896: $courseid eq $env{'request.course.id'}) {
7897:
7898: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
7899:
7900: # ----------------------------------------------------- Cascading lookup scheme
7901: my $symbp=$symbparm;
7902: my $mapp=&deversion((&decode_symb($symbp))[0]);
7903:
7904: my $symbparm=$symbp.'.'.$spacequalifierrest;
7905: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7906:
7907: if (($env{'user.name'} eq $uname) &&
7908: ($env{'user.domain'} eq $udom)) {
7909: $section=$env{'request.course.sec'};
7910: @groups = split(/:/,$env{'request.course.groups'});
7911: @groups=&sort_course_groups($courseid,@groups);
7912: } else {
7913: if (! defined($usection)) {
7914: $section=&getsection($udom,$uname,$courseid);
7915: } else {
7916: $section = $usection;
7917: }
7918: @groups = &get_users_groups($udom,$uname,$courseid);
7919: }
7920:
7921: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7922: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7923: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7924:
7925: $courselevel=$courseid.'.'.$spacequalifierrest;
7926: my $courselevelr=$courseid.'.'.$symbparm;
7927: $courselevelm=$courseid.'.'.$mapparm;
7928:
7929: # ----------------------------------------------------------- first, check user
7930:
7931: my $userreply=&resdata($uname,$udom,'user',
7932: ([$courselevelr,'resource'],
7933: [$courselevelm,'map' ],
7934: [$courselevel, 'course' ]));
7935: if (defined($userreply)) { return &get_reply($userreply); }
7936:
7937: # ------------------------------------------------ second, check some of course
7938: my $coursereply;
7939: if (@groups > 0) {
7940: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7941: $mapparm,$spacequalifierrest);
7942: if (defined($coursereply)) { return &get_reply($coursereply); }
7943: }
7944:
7945: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7946: $env{'course.'.$courseid.'.domain'},
7947: 'course',
7948: ([$seclevelr, 'resource'],
7949: [$seclevelm, 'map' ],
7950: [$seclevel, 'course' ],
7951: [$courselevelr,'resource']));
7952: if (defined($coursereply)) { return &get_reply($coursereply); }
7953:
7954: # ------------------------------------------------------ third, check map parms
7955: my %parmhash=();
7956: my $thisparm='';
7957: if (tie(%parmhash,'GDBM_File',
7958: $env{'request.course.fn'}.'_parms.db',
7959: &GDBM_READER(),0640)) {
7960: $thisparm=$parmhash{$symbparm};
7961: untie(%parmhash);
7962: }
7963: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
7964: }
7965: # ------------------------------------------ fourth, look in resource metadata
7966:
7967: $spacequalifierrest=~s/\./\_/;
7968: my $filename;
7969: if (!$symbparm) { $symbparm=&symbread(); }
7970: if ($symbparm) {
7971: $filename=(&decode_symb($symbparm))[2];
7972: } else {
7973: $filename=$env{'request.filename'};
7974: }
7975: my $metadata=&metadata($filename,$spacequalifierrest);
7976: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7977: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
7978: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7979:
7980: # ---------------------------------------------- fourth, look in rest of course
7981: if ($symbparm && defined($courseid) &&
7982: $courseid eq $env{'request.course.id'}) {
7983: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7984: $env{'course.'.$courseid.'.domain'},
7985: 'course',
7986: ([$courselevelm,'map' ],
7987: [$courselevel, 'course']));
7988: if (defined($coursereply)) { return &get_reply($coursereply); }
7989: }
7990: # ------------------------------------------------------------------ Cascade up
7991: unless ($space eq '0') {
7992: my @parts=split(/_/,$space);
7993: my $id=pop(@parts);
7994: my $part=join('_',@parts);
7995: if ($part eq '') { $part='0'; }
7996: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
7997: $symbparm,$udom,$uname,$section,1);
7998: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
7999: }
8000: if ($recurse) { return undef; }
8001: my $pack_def=&packages_tab_default($filename,$varname);
8002: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
8003: # ---------------------------------------------------- Any other user namespace
8004: } elsif ($realm eq 'environment') {
8005: # ----------------------------------------------------------------- environment
8006: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
8007: return $env{'environment.'.$spacequalifierrest};
8008: } else {
8009: if ($uname eq 'anonymous' && $udom eq '') {
8010: return '';
8011: }
8012: my %returnhash=&userenvironment($udom,$uname,
8013: $spacequalifierrest);
8014: return $returnhash{$spacequalifierrest};
8015: }
8016: } elsif ($realm eq 'system') {
8017: # ----------------------------------------------------------------- system.time
8018: if ($space eq 'time') {
8019: return time;
8020: }
8021: } elsif ($realm eq 'server') {
8022: # ----------------------------------------------------------------- system.time
8023: if ($space eq 'name') {
8024: return $ENV{'SERVER_NAME'};
8025: }
8026: }
8027: return '';
8028: }
8029:
8030: sub get_reply {
8031: my ($reply_value) = @_;
8032: if (ref($reply_value) eq 'ARRAY') {
8033: if (wantarray) {
8034: return @$reply_value;
8035: }
8036: return $reply_value->[0];
8037: } else {
8038: return $reply_value;
8039: }
8040: }
8041:
8042: sub check_group_parms {
8043: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8044: my @groupitems = ();
8045: my $resultitem;
8046: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
8047: foreach my $group (@{$groups}) {
8048: foreach my $level (@levels) {
8049: my $item = $courseid.'.['.$group.'].'.$level->[0];
8050: push(@groupitems,[$item,$level->[1]]);
8051: }
8052: }
8053: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8054: $env{'course.'.$courseid.'.domain'},
8055: 'course',@groupitems);
8056: return $coursereply;
8057: }
8058:
8059: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
8060: my ($courseid,@groups) = @_;
8061: @groups = sort(@groups);
8062: return @groups;
8063: }
8064:
8065: sub packages_tab_default {
8066: my ($uri,$varname)=@_;
8067: my (undef,$part,$name)=split(/\./,$varname);
8068:
8069: my (@extension,@specifics,$do_default);
8070: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
8071: my ($pack_type,$pack_part)=split(/_/,$package,2);
8072: if ($pack_type eq 'default') {
8073: $do_default=1;
8074: } elsif ($pack_type eq 'extension') {
8075: push(@extension,[$package,$pack_type,$pack_part]);
8076: } elsif ($pack_part eq $part || $pack_type eq 'part') {
8077: # only look at packages defaults for packages that this id is
8078: push(@specifics,[$package,$pack_type,$pack_part]);
8079: }
8080: }
8081: # first look for a package that matches the requested part id
8082: foreach my $package (@specifics) {
8083: my (undef,$pack_type,$pack_part)=@{$package};
8084: next if ($pack_part ne $part);
8085: if (defined($packagetab{"$pack_type&$name&default"})) {
8086: return $packagetab{"$pack_type&$name&default"};
8087: }
8088: }
8089: # look for any possible matching non extension_ package
8090: foreach my $package (@specifics) {
8091: my (undef,$pack_type,$pack_part)=@{$package};
8092: if (defined($packagetab{"$pack_type&$name&default"})) {
8093: return $packagetab{"$pack_type&$name&default"};
8094: }
8095: if ($pack_type eq 'part') { $pack_part='0'; }
8096: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8097: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
8098: }
8099: }
8100: # look for any posible extension_ match
8101: foreach my $package (@extension) {
8102: my ($package,$pack_type)=@{$package};
8103: if (defined($packagetab{"$pack_type&$name&default"})) {
8104: return $packagetab{"$pack_type&$name&default"};
8105: }
8106: if (defined($packagetab{$package."&$name&default"})) {
8107: return $packagetab{$package."&$name&default"};
8108: }
8109: }
8110: # look for a global default setting
8111: if ($do_default && defined($packagetab{"default&$name&default"})) {
8112: return $packagetab{"default&$name&default"};
8113: }
8114: return undef;
8115: }
8116:
8117: sub add_prefix_and_part {
8118: my ($prefix,$part)=@_;
8119: my $keyroot;
8120: if (defined($prefix) && $prefix !~ /^__/) {
8121: # prefix that has a part already
8122: $keyroot=$prefix;
8123: } elsif (defined($prefix)) {
8124: # prefix that is missing a part
8125: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8126: } else {
8127: # no prefix at all
8128: if (defined($part)) { $keyroot='_'.$part; }
8129: }
8130: return $keyroot;
8131: }
8132:
8133: # ---------------------------------------------------------------- Get metadata
8134:
8135: my %metaentry;
8136: sub metadata {
8137: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
8138: $uri=&declutter($uri);
8139: # if it is a non metadata possible uri return quickly
8140: if (($uri eq '') ||
8141: (($uri =~ m|^/*adm/|) &&
8142: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
8143: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8144: return undef;
8145: }
8146: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8147: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
8148: return undef;
8149: }
8150: my $filename=$uri;
8151: $uri=~s/\.meta$//;
8152: #
8153: # Is the metadata already cached?
8154: # Look at timestamp of caching
8155: # Everything is cached by the main uri, libraries are never directly cached
8156: #
8157: if (!defined($liburi)) {
8158: my ($result,$cached)=&is_cached_new('meta',$uri);
8159: if (defined($cached)) { return $result->{':'.$what}; }
8160: }
8161: {
8162: #
8163: # Is this a recursive call for a library?
8164: #
8165: # if (! exists($metacache{$uri})) {
8166: # $metacache{$uri}={};
8167: # }
8168: my $cachetime = 60*60;
8169: if ($liburi) {
8170: $liburi=&declutter($liburi);
8171: $filename=$liburi;
8172: } else {
8173: &devalidate_cache_new('meta',$uri);
8174: undef(%metaentry);
8175: }
8176: my %metathesekeys=();
8177: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
8178: my $metastring;
8179: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
8180: my $which = &hreflocation('','/'.($liburi || $uri));
8181: $metastring =
8182: &Apache::lonnet::ssi_body($which,
8183: ('grade_target' => 'meta'));
8184: $cachetime = 1; # only want this cached in the child not long term
8185: } elsif ($uri !~ m -^(editupload)/-) {
8186: my $file=&filelocation('',&clutter($filename));
8187: #push(@{$metaentry{$uri.'.file'}},$file);
8188: $metastring=&getfile($file);
8189: }
8190: my $parser=HTML::LCParser->new(\$metastring);
8191: my $token;
8192: undef %metathesekeys;
8193: while ($token=$parser->get_token) {
8194: if ($token->[0] eq 'S') {
8195: if (defined($token->[2]->{'package'})) {
8196: #
8197: # This is a package - get package info
8198: #
8199: my $package=$token->[2]->{'package'};
8200: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8201: if (defined($token->[2]->{'id'})) {
8202: $keyroot.='_'.$token->[2]->{'id'};
8203: }
8204: if ($metaentry{':packages'}) {
8205: $metaentry{':packages'}.=','.$package.$keyroot;
8206: } else {
8207: $metaentry{':packages'}=$package.$keyroot;
8208: }
8209: foreach my $pack_entry (keys(%packagetab)) {
8210: my $part=$keyroot;
8211: $part=~s/^\_//;
8212: if ($pack_entry=~/^\Q$package\E\&/ ||
8213: $pack_entry=~/^\Q$package\E_0\&/) {
8214: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
8215: # ignore package.tab specified default values
8216: # here &package_tab_default() will fetch those
8217: if ($subp eq 'default') { next; }
8218: my $value=$packagetab{$pack_entry};
8219: my $unikey;
8220: if ($pack =~ /_0$/) {
8221: $unikey='parameter_0_'.$name;
8222: $part=0;
8223: } else {
8224: $unikey='parameter'.$keyroot.'_'.$name;
8225: }
8226: if ($subp eq 'display') {
8227: $value.=' [Part: '.$part.']';
8228: }
8229: $metaentry{':'.$unikey.'.part'}=$part;
8230: $metathesekeys{$unikey}=1;
8231: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8232: $metaentry{':'.$unikey.'.'.$subp}=$value;
8233: }
8234: if (defined($metaentry{':'.$unikey.'.default'})) {
8235: $metaentry{':'.$unikey}=
8236: $metaentry{':'.$unikey.'.default'};
8237: }
8238: }
8239: }
8240: } else {
8241: #
8242: # This is not a package - some other kind of start tag
8243: #
8244: my $entry=$token->[1];
8245: my $unikey;
8246: if ($entry eq 'import') {
8247: $unikey='';
8248: } else {
8249: $unikey=$entry;
8250: }
8251: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8252:
8253: if (defined($token->[2]->{'id'})) {
8254: $unikey.='_'.$token->[2]->{'id'};
8255: }
8256:
8257: if ($entry eq 'import') {
8258: #
8259: # Importing a library here
8260: #
8261: if ($depthcount<20) {
8262: my $location=$parser->get_text('/import');
8263: my $dir=$filename;
8264: $dir=~s|[^/]*$||;
8265: $location=&filelocation($dir,$location);
8266: my $metadata =
8267: &metadata($uri,'keys', $location,$unikey,
8268: $depthcount+1);
8269: foreach my $meta (split(',',$metadata)) {
8270: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8271: $metathesekeys{$meta}=1;
8272: }
8273: }
8274: } else {
8275:
8276: if (defined($token->[2]->{'name'})) {
8277: $unikey.='_'.$token->[2]->{'name'};
8278: }
8279: $metathesekeys{$unikey}=1;
8280: foreach my $param (@{$token->[3]}) {
8281: $metaentry{':'.$unikey.'.'.$param} =
8282: $token->[2]->{$param};
8283: }
8284: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
8285: my $default=$metaentry{':'.$unikey.'.default'};
8286: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8287: # only ws inside the tag, and not in default, so use default
8288: # as value
8289: $metaentry{':'.$unikey}=$default;
8290: } elsif ( $internaltext =~ /\S/ ) {
8291: # something interesting inside the tag
8292: $metaentry{':'.$unikey}=$internaltext;
8293: } else {
8294: # no interesting values, don't set a default
8295: }
8296: # end of not-a-package not-a-library import
8297: }
8298: # end of not-a-package start tag
8299: }
8300: # the next is the end of "start tag"
8301: }
8302: }
8303: my ($extension) = ($uri =~ /\.(\w+)$/);
8304: $extension = lc($extension);
8305: if ($extension eq 'htm') { $extension='html'; }
8306:
8307: foreach my $key (keys(%packagetab)) {
8308: #no specific packages #how's our extension
8309: if ($key!~/^extension_\Q$extension\E&/) { next; }
8310: &metadata_create_package_def($uri,$key,'extension_'.$extension,
8311: \%metathesekeys);
8312: }
8313:
8314: if (!exists($metaentry{':packages'})
8315: || $packagetab{"import_defaults&extension_$extension"}) {
8316: foreach my $key (keys(%packagetab)) {
8317: #no specific packages well let's get default then
8318: if ($key!~/^default&/) { next; }
8319: &metadata_create_package_def($uri,$key,'default',
8320: \%metathesekeys);
8321: }
8322: }
8323: # are there custom rights to evaluate
8324: if ($metaentry{':copyright'} eq 'custom') {
8325:
8326: #
8327: # Importing a rights file here
8328: #
8329: unless ($depthcount) {
8330: my $location=$metaentry{':customdistributionfile'};
8331: my $dir=$filename;
8332: $dir=~s|[^/]*$||;
8333: $location=&filelocation($dir,$location);
8334: my $rights_metadata =
8335: &metadata($uri,'keys',$location,'_rights',
8336: $depthcount+1);
8337: foreach my $rights (split(',',$rights_metadata)) {
8338: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8339: $metathesekeys{$rights}=1;
8340: }
8341: }
8342: }
8343: # uniqifiy package listing
8344: my %seen;
8345: my @uniq_packages =
8346: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8347: $metaentry{':packages'} = join(',',@uniq_packages);
8348:
8349: $metaentry{':keys'} = join(',',keys(%metathesekeys));
8350: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8351: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
8352: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
8353: # this is the end of "was not already recently cached
8354: }
8355: return $metaentry{':'.$what};
8356: }
8357:
8358: sub metadata_create_package_def {
8359: my ($uri,$key,$package,$metathesekeys)=@_;
8360: my ($pack,$name,$subp)=split(/\&/,$key);
8361: if ($subp eq 'default') { next; }
8362:
8363: if (defined($metaentry{':packages'})) {
8364: $metaentry{':packages'}.=','.$package;
8365: } else {
8366: $metaentry{':packages'}=$package;
8367: }
8368: my $value=$packagetab{$key};
8369: my $unikey;
8370: $unikey='parameter_0_'.$name;
8371: $metaentry{':'.$unikey.'.part'}=0;
8372: $$metathesekeys{$unikey}=1;
8373: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8374: $metaentry{':'.$unikey.'.'.$subp}=$value;
8375: }
8376: if (defined($metaentry{':'.$unikey.'.default'})) {
8377: $metaentry{':'.$unikey}=
8378: $metaentry{':'.$unikey.'.default'};
8379: }
8380: }
8381:
8382: sub metadata_generate_part0 {
8383: my ($metadata,$metacache,$uri) = @_;
8384: my %allnames;
8385: foreach my $metakey (keys(%$metadata)) {
8386: if ($metakey=~/^parameter\_(.*)/) {
8387: my $part=$$metacache{':'.$metakey.'.part'};
8388: my $name=$$metacache{':'.$metakey.'.name'};
8389: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
8390: $allnames{$name}=$part;
8391: }
8392: }
8393: }
8394: foreach my $name (keys(%allnames)) {
8395: $$metadata{"parameter_0_$name"}=1;
8396: my $key=":parameter_0_$name";
8397: $$metacache{"$key.part"}='0';
8398: $$metacache{"$key.name"}=$name;
8399: $$metacache{"$key.type"}=$$metacache{':parameter_'.
8400: $allnames{$name}.'_'.$name.
8401: '.type'};
8402: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
8403: '.display'};
8404: my $expr='[Part: '.$allnames{$name}.']';
8405: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
8406: $$metacache{"$key.display"}=$olddis;
8407: }
8408: }
8409:
8410: # ------------------------------------------------------ Devalidate title cache
8411:
8412: sub devalidate_title_cache {
8413: my ($url)=@_;
8414: if (!$env{'request.course.id'}) { return; }
8415: my $symb=&symbread($url);
8416: if (!$symb) { return; }
8417: my $key=$env{'request.course.id'}."\0".$symb;
8418: &devalidate_cache_new('title',$key);
8419: }
8420:
8421: # ------------------------------------------------- Get the title of a course
8422:
8423: sub current_course_title {
8424: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8425: }
8426: # ------------------------------------------------- Get the title of a resource
8427:
8428: sub gettitle {
8429: my $urlsymb=shift;
8430: my $symb=&symbread($urlsymb);
8431: if ($symb) {
8432: my $key=$env{'request.course.id'}."\0".$symb;
8433: my ($result,$cached)=&is_cached_new('title',$key);
8434: if (defined($cached)) {
8435: return $result;
8436: }
8437: my ($map,$resid,$url)=&decode_symb($symb);
8438: my $title='';
8439: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8440: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8441: } else {
8442: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8443: &GDBM_READER(),0640)) {
8444: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8445: $title=$bighash{'title_'.$mapid.'.'.$resid};
8446: untie(%bighash);
8447: }
8448: }
8449: $title=~s/\&colon\;/\:/gs;
8450: if ($title) {
8451: return &do_cache_new('title',$key,$title,600);
8452: }
8453: $urlsymb=$url;
8454: }
8455: my $title=&metadata($urlsymb,'title');
8456: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8457: return $title;
8458: }
8459:
8460: sub get_slot {
8461: my ($which,$cnum,$cdom)=@_;
8462: if (!$cnum || !$cdom) {
8463: (undef,my $courseid)=&whichuser();
8464: $cdom=$env{'course.'.$courseid.'.domain'};
8465: $cnum=$env{'course.'.$courseid.'.num'};
8466: }
8467: my $key=join("\0",'slots',$cdom,$cnum,$which);
8468: my %slotinfo;
8469: if (exists($remembered{$key})) {
8470: $slotinfo{$which} = $remembered{$key};
8471: } else {
8472: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8473: &Apache::lonhomework::showhash(%slotinfo);
8474: my ($tmp)=keys(%slotinfo);
8475: if ($tmp=~/^error:/) { return (); }
8476: $remembered{$key} = $slotinfo{$which};
8477: }
8478: if (ref($slotinfo{$which}) eq 'HASH') {
8479: return %{$slotinfo{$which}};
8480: }
8481: return $slotinfo{$which};
8482: }
8483: # ------------------------------------------------- Update symbolic store links
8484:
8485: sub symblist {
8486: my ($mapname,%newhash)=@_;
8487: $mapname=&deversion(&declutter($mapname));
8488: my %hash;
8489: if (($env{'request.course.fn'}) && (%newhash)) {
8490: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8491: &GDBM_WRCREAT(),0640)) {
8492: foreach my $url (keys(%newhash)) {
8493: next if ($url eq 'last_known'
8494: && $env{'form.no_update_last_known'});
8495: $hash{declutter($url)}=&encode_symb($mapname,
8496: $newhash{$url}->[1],
8497: $newhash{$url}->[0]);
8498: }
8499: if (untie(%hash)) {
8500: return 'ok';
8501: }
8502: }
8503: }
8504: return 'error';
8505: }
8506:
8507: # --------------------------------------------------------------- Verify a symb
8508:
8509: sub symbverify {
8510: my ($symb,$thisurl)=@_;
8511: my $thisfn=$thisurl;
8512: $thisfn=&declutter($thisfn);
8513: # direct jump to resource in page or to a sequence - will construct own symbs
8514: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8515: # check URL part
8516: my ($map,$resid,$url)=&decode_symb($symb);
8517:
8518: unless ($url eq $thisfn) { return 0; }
8519:
8520: $symb=&symbclean($symb);
8521: $thisurl=&deversion($thisurl);
8522: $thisfn=&deversion($thisfn);
8523:
8524: my %bighash;
8525: my $okay=0;
8526:
8527: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8528: &GDBM_READER(),0640)) {
8529: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8530: $thisurl =~ s/\?.+$//;
8531: }
8532: my $ids=$bighash{'ids_'.&clutter($thisurl)};
8533: unless ($ids) {
8534: $ids=$bighash{'ids_/'.$thisurl};
8535: }
8536: if ($ids) {
8537: # ------------------------------------------------------------------- Has ID(s)
8538: foreach my $id (split(/\,/,$ids)) {
8539: my ($mapid,$resid)=split(/\./,$id);
8540: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8541: $symb =~ s/\?.+$//;
8542: }
8543: if (
8544: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8545: eq $symb) {
8546: if (($env{'request.role.adv'}) ||
8547: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
8548: $okay=1;
8549: }
8550: }
8551: }
8552: }
8553: untie(%bighash);
8554: }
8555: return $okay;
8556: }
8557:
8558: # --------------------------------------------------------------- Clean-up symb
8559:
8560: sub symbclean {
8561: my $symb=shift;
8562: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8563: # remove version from map
8564: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
8565:
8566: # remove version from URL
8567: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
8568:
8569: # remove wrapper
8570:
8571: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
8572: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
8573: return $symb;
8574: }
8575:
8576: # ---------------------------------------------- Split symb to find map and url
8577:
8578: sub encode_symb {
8579: my ($map,$resid,$url)=@_;
8580: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8581: }
8582:
8583: sub decode_symb {
8584: my $symb=shift;
8585: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8586: my ($map,$resid,$url)=split(/___/,$symb);
8587: return (&fixversion($map),$resid,&fixversion($url));
8588: }
8589:
8590: sub fixversion {
8591: my $fn=shift;
8592: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
8593: my %bighash;
8594: my $uri=&clutter($fn);
8595: my $key=$env{'request.course.id'}.'_'.$uri;
8596: # is this cached?
8597: my ($result,$cached)=&is_cached_new('courseresversion',$key);
8598: if (defined($cached)) { return $result; }
8599: # unfortunately not cached, or expired
8600: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8601: &GDBM_READER(),0640)) {
8602: if ($bighash{'version_'.$uri}) {
8603: my $version=$bighash{'version_'.$uri};
8604: unless (($version eq 'mostrecent') ||
8605: ($version==&getversion($uri))) {
8606: $uri=~s/\.(\w+)$/\.$version\.$1/;
8607: }
8608: }
8609: untie %bighash;
8610: }
8611: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
8612: }
8613:
8614: sub deversion {
8615: my $url=shift;
8616: $url=~s/\.\d+\.(\w+)$/\.$1/;
8617: return $url;
8618: }
8619:
8620: # ------------------------------------------------------ Return symb list entry
8621:
8622: sub symbread {
8623: my ($thisfn,$donotrecurse)=@_;
8624: my $cache_str='request.symbread.cached.'.$thisfn;
8625: if (defined($env{$cache_str})) { return $env{$cache_str}; }
8626: # no filename provided? try from environment
8627: unless ($thisfn) {
8628: if ($env{'request.symb'}) {
8629: return $env{$cache_str}=&symbclean($env{'request.symb'});
8630: }
8631: $thisfn=$env{'request.filename'};
8632: }
8633: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8634: # is that filename actually a symb? Verify, clean, and return
8635: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
8636: if (&symbverify($thisfn,$1)) {
8637: return $env{$cache_str}=&symbclean($thisfn);
8638: }
8639: }
8640: $thisfn=declutter($thisfn);
8641: my %hash;
8642: my %bighash;
8643: my $syval='';
8644: if (($env{'request.course.fn'}) && ($thisfn)) {
8645: my $targetfn = $thisfn;
8646: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
8647: $targetfn = 'adm/wrapper/'.$thisfn;
8648: }
8649: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8650: $targetfn=$1;
8651: }
8652: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8653: &GDBM_READER(),0640)) {
8654: $syval=$hash{$targetfn};
8655: untie(%hash);
8656: }
8657: # ---------------------------------------------------------- There was an entry
8658: if ($syval) {
8659: #unless ($syval=~/\_\d+$/) {
8660: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
8661: #&appenv({'request.ambiguous' => $thisfn});
8662: #return $env{$cache_str}='';
8663: #}
8664: #$syval.=$1;
8665: #}
8666: } else {
8667: # ------------------------------------------------------- Was not in symb table
8668: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8669: &GDBM_READER(),0640)) {
8670: # ---------------------------------------------- Get ID(s) for current resource
8671: my $ids=$bighash{'ids_'.&clutter($thisfn)};
8672: unless ($ids) {
8673: $ids=$bighash{'ids_/'.$thisfn};
8674: }
8675: unless ($ids) {
8676: # alias?
8677: $ids=$bighash{'mapalias_'.$thisfn};
8678: }
8679: if ($ids) {
8680: # ------------------------------------------------------------------- Has ID(s)
8681: my @possibilities=split(/\,/,$ids);
8682: if ($#possibilities==0) {
8683: # ----------------------------------------------- There is only one possibility
8684: my ($mapid,$resid)=split(/\./,$ids);
8685: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8686: $resid,$thisfn);
8687: } elsif (!$donotrecurse) {
8688: # ------------------------------------------ There is more than one possibility
8689: my $realpossible=0;
8690: foreach my $id (@possibilities) {
8691: my $file=$bighash{'src_'.$id};
8692: if (&allowed('bre',$file)) {
8693: my ($mapid,$resid)=split(/\./,$id);
8694: if ($bighash{'map_type_'.$mapid} ne 'page') {
8695: $realpossible++;
8696: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8697: $resid,$thisfn);
8698: }
8699: }
8700: }
8701: if ($realpossible!=1) { $syval=''; }
8702: } else {
8703: $syval='';
8704: }
8705: }
8706: untie(%bighash)
8707: }
8708: }
8709: if ($syval) {
8710: return $env{$cache_str}=$syval;
8711: }
8712: }
8713: &appenv({'request.ambiguous' => $thisfn});
8714: return $env{$cache_str}='';
8715: }
8716:
8717: # ---------------------------------------------------------- Return random seed
8718:
8719: sub numval {
8720: my $txt=shift;
8721: $txt=~tr/A-J/0-9/;
8722: $txt=~tr/a-j/0-9/;
8723: $txt=~tr/K-T/0-9/;
8724: $txt=~tr/k-t/0-9/;
8725: $txt=~tr/U-Z/0-5/;
8726: $txt=~tr/u-z/0-5/;
8727: $txt=~s/\D//g;
8728: if ($_64bit) { if ($txt > 2**32) { return -1; } }
8729: return int($txt);
8730: }
8731:
8732: sub numval2 {
8733: my $txt=shift;
8734: $txt=~tr/A-J/0-9/;
8735: $txt=~tr/a-j/0-9/;
8736: $txt=~tr/K-T/0-9/;
8737: $txt=~tr/k-t/0-9/;
8738: $txt=~tr/U-Z/0-5/;
8739: $txt=~tr/u-z/0-5/;
8740: $txt=~s/\D//g;
8741: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8742: my $total;
8743: foreach my $val (@txts) { $total+=$val; }
8744: if ($_64bit) { if ($total > 2**32) { return -1; } }
8745: return int($total);
8746: }
8747:
8748: sub numval3 {
8749: use integer;
8750: my $txt=shift;
8751: $txt=~tr/A-J/0-9/;
8752: $txt=~tr/a-j/0-9/;
8753: $txt=~tr/K-T/0-9/;
8754: $txt=~tr/k-t/0-9/;
8755: $txt=~tr/U-Z/0-5/;
8756: $txt=~tr/u-z/0-5/;
8757: $txt=~s/\D//g;
8758: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8759: my $total;
8760: foreach my $val (@txts) { $total+=$val; }
8761: if ($_64bit) { $total=(($total<<32)>>32); }
8762: return $total;
8763: }
8764:
8765: sub digest {
8766: my ($data)=@_;
8767: my $digest=&Digest::MD5::md5($data);
8768: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8769: my ($e,$f);
8770: {
8771: use integer;
8772: $e=($a+$b);
8773: $f=($c+$d);
8774: if ($_64bit) {
8775: $e=(($e<<32)>>32);
8776: $f=(($f<<32)>>32);
8777: }
8778: }
8779: if (wantarray) {
8780: return ($e,$f);
8781: } else {
8782: my $g;
8783: {
8784: use integer;
8785: $g=($e+$f);
8786: if ($_64bit) {
8787: $g=(($g<<32)>>32);
8788: }
8789: }
8790: return $g;
8791: }
8792: }
8793:
8794: sub latest_rnd_algorithm_id {
8795: return '64bit5';
8796: }
8797:
8798: sub get_rand_alg {
8799: my ($courseid)=@_;
8800: if (!$courseid) { $courseid=(&whichuser())[1]; }
8801: if ($courseid) {
8802: return $env{"course.$courseid.rndseed"};
8803: }
8804: return &latest_rnd_algorithm_id();
8805: }
8806:
8807: sub validCODE {
8808: my ($CODE)=@_;
8809: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8810: return 0;
8811: }
8812:
8813: sub getCODE {
8814: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
8815: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8816: defined($Apache::lonhomework::parsing_a_task) ) &&
8817: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
8818: return $Apache::lonhomework::history{'resource.CODE'};
8819: }
8820: return undef;
8821: }
8822:
8823: sub rndseed {
8824: my ($symb,$courseid,$domain,$username)=@_;
8825: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
8826: if (!defined($symb)) {
8827: unless ($symb=$wsymb) { return time; }
8828: }
8829: if (!$courseid) { $courseid=$wcourseid; }
8830: if (!$domain) { $domain=$wdomain; }
8831: if (!$username) { $username=$wusername }
8832: my $which=&get_rand_alg();
8833:
8834: if (defined(&getCODE())) {
8835: if ($which eq '64bit5') {
8836: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8837: } elsif ($which eq '64bit4') {
8838: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8839: } else {
8840: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8841: }
8842: } elsif ($which eq '64bit5') {
8843: return &rndseed_64bit5($symb,$courseid,$domain,$username);
8844: } elsif ($which eq '64bit4') {
8845: return &rndseed_64bit4($symb,$courseid,$domain,$username);
8846: } elsif ($which eq '64bit3') {
8847: return &rndseed_64bit3($symb,$courseid,$domain,$username);
8848: } elsif ($which eq '64bit2') {
8849: return &rndseed_64bit2($symb,$courseid,$domain,$username);
8850: } elsif ($which eq '64bit') {
8851: return &rndseed_64bit($symb,$courseid,$domain,$username);
8852: }
8853: return &rndseed_32bit($symb,$courseid,$domain,$username);
8854: }
8855:
8856: sub rndseed_32bit {
8857: my ($symb,$courseid,$domain,$username)=@_;
8858: {
8859: use integer;
8860: my $symbchck=unpack("%32C*",$symb) << 27;
8861: my $symbseed=numval($symb) << 22;
8862: my $namechck=unpack("%32C*",$username) << 17;
8863: my $nameseed=numval($username) << 12;
8864: my $domainseed=unpack("%32C*",$domain) << 7;
8865: my $courseseed=unpack("%32C*",$courseid);
8866: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
8867: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8868: #&logthis("rndseed :$num:$symb");
8869: if ($_64bit) { $num=(($num<<32)>>32); }
8870: return $num;
8871: }
8872: }
8873:
8874: sub rndseed_64bit {
8875: my ($symb,$courseid,$domain,$username)=@_;
8876: {
8877: use integer;
8878: my $symbchck=unpack("%32S*",$symb) << 21;
8879: my $symbseed=numval($symb) << 10;
8880: my $namechck=unpack("%32S*",$username);
8881:
8882: my $nameseed=numval($username) << 21;
8883: my $domainseed=unpack("%32S*",$domain) << 10;
8884: my $courseseed=unpack("%32S*",$courseid);
8885:
8886: my $num1=$symbchck+$symbseed+$namechck;
8887: my $num2=$nameseed+$domainseed+$courseseed;
8888: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8889: #&logthis("rndseed :$num:$symb");
8890: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8891: return "$num1,$num2";
8892: }
8893: }
8894:
8895: sub rndseed_64bit2 {
8896: my ($symb,$courseid,$domain,$username)=@_;
8897: {
8898: use integer;
8899: # strings need to be an even # of cahracters long, it it is odd the
8900: # last characters gets thrown away
8901: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8902: my $symbseed=numval($symb) << 10;
8903: my $namechck=unpack("%32S*",$username.' ');
8904:
8905: my $nameseed=numval($username) << 21;
8906: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8907: my $courseseed=unpack("%32S*",$courseid.' ');
8908:
8909: my $num1=$symbchck+$symbseed+$namechck;
8910: my $num2=$nameseed+$domainseed+$courseseed;
8911: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8912: #&logthis("rndseed :$num:$symb");
8913: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8914: return "$num1,$num2";
8915: }
8916: }
8917:
8918: sub rndseed_64bit3 {
8919: my ($symb,$courseid,$domain,$username)=@_;
8920: {
8921: use integer;
8922: # strings need to be an even # of cahracters long, it it is odd the
8923: # last characters gets thrown away
8924: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8925: my $symbseed=numval2($symb) << 10;
8926: my $namechck=unpack("%32S*",$username.' ');
8927:
8928: my $nameseed=numval2($username) << 21;
8929: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8930: my $courseseed=unpack("%32S*",$courseid.' ');
8931:
8932: my $num1=$symbchck+$symbseed+$namechck;
8933: my $num2=$nameseed+$domainseed+$courseseed;
8934: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8935: #&logthis("rndseed :$num1:$num2:$_64bit");
8936: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8937:
8938: return "$num1:$num2";
8939: }
8940: }
8941:
8942: sub rndseed_64bit4 {
8943: my ($symb,$courseid,$domain,$username)=@_;
8944: {
8945: use integer;
8946: # strings need to be an even # of cahracters long, it it is odd the
8947: # last characters gets thrown away
8948: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8949: my $symbseed=numval3($symb) << 10;
8950: my $namechck=unpack("%32S*",$username.' ');
8951:
8952: my $nameseed=numval3($username) << 21;
8953: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8954: my $courseseed=unpack("%32S*",$courseid.' ');
8955:
8956: my $num1=$symbchck+$symbseed+$namechck;
8957: my $num2=$nameseed+$domainseed+$courseseed;
8958: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8959: #&logthis("rndseed :$num1:$num2:$_64bit");
8960: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8961:
8962: return "$num1:$num2";
8963: }
8964: }
8965:
8966: sub rndseed_64bit5 {
8967: my ($symb,$courseid,$domain,$username)=@_;
8968: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8969: return "$num1:$num2";
8970: }
8971:
8972: sub rndseed_CODE_64bit {
8973: my ($symb,$courseid,$domain,$username)=@_;
8974: {
8975: use integer;
8976: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8977: my $symbseed=numval2($symb);
8978: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8979: my $CODEseed=numval(&getCODE());
8980: my $courseseed=unpack("%32S*",$courseid.' ');
8981: my $num1=$symbseed+$CODEchck;
8982: my $num2=$CODEseed+$courseseed+$symbchck;
8983: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8984: #&logthis("rndseed :$num1:$num2:$symb");
8985: if ($_64bit) { $num1=(($num1<<32)>>32); }
8986: if ($_64bit) { $num2=(($num2<<32)>>32); }
8987: return "$num1:$num2";
8988: }
8989: }
8990:
8991: sub rndseed_CODE_64bit4 {
8992: my ($symb,$courseid,$domain,$username)=@_;
8993: {
8994: use integer;
8995: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8996: my $symbseed=numval3($symb);
8997: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8998: my $CODEseed=numval3(&getCODE());
8999: my $courseseed=unpack("%32S*",$courseid.' ');
9000: my $num1=$symbseed+$CODEchck;
9001: my $num2=$CODEseed+$courseseed+$symbchck;
9002: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9003: #&logthis("rndseed :$num1:$num2:$symb");
9004: if ($_64bit) { $num1=(($num1<<32)>>32); }
9005: if ($_64bit) { $num2=(($num2<<32)>>32); }
9006: return "$num1:$num2";
9007: }
9008: }
9009:
9010: sub rndseed_CODE_64bit5 {
9011: my ($symb,$courseid,$domain,$username)=@_;
9012: my $code = &getCODE();
9013: my ($num1,$num2)=&digest("$symb,$courseid,$code");
9014: return "$num1:$num2";
9015: }
9016:
9017: sub setup_random_from_rndseed {
9018: my ($rndseed)=@_;
9019: if ($rndseed =~/([,:])/) {
9020: my ($num1,$num2)=split(/[,:]/,$rndseed);
9021: &Math::Random::random_set_seed(abs($num1),abs($num2));
9022: } else {
9023: &Math::Random::random_set_seed_from_phrase($rndseed);
9024: }
9025: }
9026:
9027: sub latest_receipt_algorithm_id {
9028: return 'receipt3';
9029: }
9030:
9031: sub recunique {
9032: my $fucourseid=shift;
9033: my $unique;
9034: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9035: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
9036: $unique=$env{"course.$fucourseid.internal.encseed"};
9037: } else {
9038: $unique=$perlvar{'lonReceipt'};
9039: }
9040: return unpack("%32C*",$unique);
9041: }
9042:
9043: sub recprefix {
9044: my $fucourseid=shift;
9045: my $prefix;
9046: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9047: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
9048: $prefix=$env{"course.$fucourseid.internal.encpref"};
9049: } else {
9050: $prefix=$perlvar{'lonHostID'};
9051: }
9052: return unpack("%32C*",$prefix);
9053: }
9054:
9055: sub ireceipt {
9056: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
9057:
9058: my $return =&recprefix($fucourseid).'-';
9059:
9060: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9061: $env{'request.state'} eq 'construct') {
9062: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9063: return $return;
9064: }
9065:
9066: my $cuname=unpack("%32C*",$funame);
9067: my $cudom=unpack("%32C*",$fudom);
9068: my $cucourseid=unpack("%32C*",$fucourseid);
9069: my $cusymb=unpack("%32C*",$fusymb);
9070: my $cunique=&recunique($fucourseid);
9071: my $cpart=unpack("%32S*",$part);
9072: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9073:
9074: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
9075:
9076: $return.= ($cunique%$cuname+
9077: $cunique%$cudom+
9078: $cusymb%$cuname+
9079: $cusymb%$cudom+
9080: $cucourseid%$cuname+
9081: $cucourseid%$cudom+
9082: $cpart%$cuname+
9083: $cpart%$cudom);
9084: } else {
9085: $return.= ($cunique%$cuname+
9086: $cunique%$cudom+
9087: $cusymb%$cuname+
9088: $cusymb%$cudom+
9089: $cucourseid%$cuname+
9090: $cucourseid%$cudom);
9091: }
9092: return $return;
9093: }
9094:
9095: sub receipt {
9096: my ($part)=@_;
9097: my ($symb,$courseid,$domain,$name) = &whichuser();
9098: return &ireceipt($name,$domain,$courseid,$symb,$part);
9099: }
9100:
9101: sub whichuser {
9102: my ($passedsymb)=@_;
9103: my ($symb,$courseid,$domain,$name,$publicuser);
9104: if (defined($env{'form.grade_symb'})) {
9105: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9106: my $allowed=&allowed('vgr',$tmp_courseid);
9107: if (!$allowed &&
9108: exists($env{'request.course.sec'}) &&
9109: $env{'request.course.sec'} !~ /^\s*$/) {
9110: $allowed=&allowed('vgr',$tmp_courseid.
9111: '/'.$env{'request.course.sec'});
9112: }
9113: if ($allowed) {
9114: ($symb)=&get_env_multiple('form.grade_symb');
9115: $courseid=$tmp_courseid;
9116: ($domain)=&get_env_multiple('form.grade_domain');
9117: ($name)=&get_env_multiple('form.grade_username');
9118: return ($symb,$courseid,$domain,$name,$publicuser);
9119: }
9120: }
9121: if (!$passedsymb) {
9122: $symb=&symbread();
9123: } else {
9124: $symb=$passedsymb;
9125: }
9126: $courseid=$env{'request.course.id'};
9127: $domain=$env{'user.domain'};
9128: $name=$env{'user.name'};
9129: if ($name eq 'public' && $domain eq 'public') {
9130: if (!defined($env{'form.username'})) {
9131: $env{'form.username'}.=time.rand(10000000);
9132: }
9133: $name.=$env{'form.username'};
9134: }
9135: return ($symb,$courseid,$domain,$name,$publicuser);
9136:
9137: }
9138:
9139: # ------------------------------------------------------------ Serves up a file
9140: # returns either the contents of the file or
9141: # -1 if the file doesn't exist
9142: #
9143: # if the target is a file that was uploaded via DOCS,
9144: # a check will be made to see if a current copy exists on the local server,
9145: # if it does this will be served, otherwise a copy will be retrieved from
9146: # the home server for the course and stored in /home/httpd/html/userfiles on
9147: # the local server.
9148:
9149: sub getfile {
9150: my ($file) = @_;
9151: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9152: &repcopy($file);
9153: return &readfile($file);
9154: }
9155:
9156: sub repcopy_userfile {
9157: my ($file)=@_;
9158: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
9159: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
9160: my ($cdom,$cnum,$filename) =
9161: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
9162: my $uri="/uploaded/$cdom/$cnum/$filename";
9163: if (-e "$file") {
9164: # we already have a local copy, check it out
9165: my @fileinfo = stat($file);
9166: my $rtncode;
9167: my $info;
9168: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
9169: if ($lwpresp ne 'ok') {
9170: # there is no such file anymore, even though we had a local copy
9171: if ($rtncode eq '404') {
9172: unlink($file);
9173: }
9174: return -1;
9175: }
9176: if ($info < $fileinfo[9]) {
9177: # nice, the file we have is up-to-date, just say okay
9178: return 'ok';
9179: } else {
9180: # the file is outdated, get rid of it
9181: unlink($file);
9182: }
9183: }
9184: # one way or the other, at this point, we don't have the file
9185: # construct the correct path for the file
9186: my @parts = ($cdom,$cnum);
9187: if ($filename =~ m|^(.+)/[^/]+$|) {
9188: push @parts, split(/\//,$1);
9189: }
9190: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9191: foreach my $part (@parts) {
9192: $path .= '/'.$part;
9193: if (!-e $path) {
9194: mkdir($path,0770);
9195: }
9196: }
9197: # now the path exists for sure
9198: # get a user agent
9199: my $ua=new LWP::UserAgent;
9200: my $transferfile=$file.'.in.transfer';
9201: # FIXME: this should flock
9202: if (-e $transferfile) { return 'ok'; }
9203: my $request;
9204: $uri=~s/^\///;
9205: my $homeserver = &homeserver($cnum,$cdom);
9206: my $protocol = $protocol{$homeserver};
9207: $protocol = 'http' if ($protocol ne 'https');
9208: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
9209: my $response=$ua->request($request,$transferfile);
9210: # did it work?
9211: if ($response->is_error()) {
9212: unlink($transferfile);
9213: &logthis("Userfile repcopy failed for $uri");
9214: return -1;
9215: }
9216: # worked, rename the transfer file
9217: rename($transferfile,$file);
9218: return 'ok';
9219: }
9220:
9221: sub tokenwrapper {
9222: my $uri=shift;
9223: $uri=~s|^https?\://([^/]+)||;
9224: $uri=~s|^/||;
9225: $env{'user.environment'}=~/\/([^\/]+)\.id/;
9226: my $token=$1;
9227: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9228: if ($udom && $uname && $file) {
9229: $file=~s|(\?\.*)*$||;
9230: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
9231: my $homeserver = &homeserver($uname,$udom);
9232: my $protocol = $protocol{$homeserver};
9233: $protocol = 'http' if ($protocol ne 'https');
9234: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
9235: (($uri=~/\?/)?'&':'?').'token='.$token.
9236: '&tokenissued='.$perlvar{'lonHostID'};
9237: } else {
9238: return '/adm/notfound.html';
9239: }
9240: }
9241:
9242: # call with reqtype HEAD: get last modification time
9243: # call with reqtype GET: get the file contents
9244: # Do not call this with reqtype GET for large files! It loads everything into memory
9245: #
9246: sub getuploaded {
9247: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9248: $uri=~s/^\///;
9249: my $homeserver = &homeserver($cnum,$cdom);
9250: my $protocol = $protocol{$homeserver};
9251: $protocol = 'http' if ($protocol ne 'https');
9252: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
9253: my $ua=new LWP::UserAgent;
9254: my $request=new HTTP::Request($reqtype,$uri);
9255: my $response=$ua->request($request);
9256: $$rtncode = $response->code;
9257: if (! $response->is_success()) {
9258: return 'failed';
9259: }
9260: if ($reqtype eq 'HEAD') {
9261: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
9262: } elsif ($reqtype eq 'GET') {
9263: $$info = $response->content;
9264: }
9265: return 'ok';
9266: }
9267:
9268: sub readfile {
9269: my $file = shift;
9270: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9271: my $fh;
9272: open($fh,"<$file");
9273: my $a='';
9274: while (my $line = <$fh>) { $a .= $line; }
9275: return $a;
9276: }
9277:
9278: sub filelocation {
9279: my ($dir,$file) = @_;
9280: my $location;
9281: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
9282:
9283: if ($file =~ m-^/adm/-) {
9284: $file=~s-^/adm/wrapper/-/-;
9285: $file=~s-^/adm/coursedocs/showdoc/-/-;
9286: }
9287:
9288: if ($file=~m:^/~:) { # is a contruction space reference
9289: $location = $file;
9290: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
9291: } elsif ($file=~m{^/home/$match_username/public_html/}) {
9292: # is a correct contruction space reference
9293: $location = $file;
9294: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9295: $location = $file;
9296: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
9297: my ($udom,$uname,$filename)=
9298: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
9299: my $home=&homeserver($uname,$udom);
9300: my $is_me=0;
9301: my @ids=¤t_machine_ids();
9302: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9303: if ($is_me) {
9304: $location=&propath($udom,$uname).'/userfiles/'.$filename;
9305: } else {
9306: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9307: $udom.'/'.$uname.'/'.$filename;
9308: }
9309: } elsif ($file =~ m-^/adm/-) {
9310: $location = $perlvar{'lonDocRoot'}.'/'.$file;
9311: } else {
9312: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9313: $file=~s:^/res/:/:;
9314: if ( !( $file =~ m:^/:) ) {
9315: $location = $dir. '/'.$file;
9316: } else {
9317: $location = '/home/httpd/html/res'.$file;
9318: }
9319: }
9320: $location=~s://+:/:g; # remove duplicate /
9321: while ($location=~m{/\.\./}) {
9322: if ($location =~ m{/[^/]+/\.\./}) {
9323: $location=~ s{/[^/]+/\.\./}{/}g;
9324: } else {
9325: $location=~ s{/\.\./}{/}g;
9326: }
9327: } #remove dir/..
9328: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9329: return $location;
9330: }
9331:
9332: sub hreflocation {
9333: my ($dir,$file)=@_;
9334: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
9335: $file=filelocation($dir,$file);
9336: } elsif ($file=~m-^/adm/-) {
9337: $file=~s-^/adm/wrapper/-/-;
9338: $file=~s-^/adm/coursedocs/showdoc/-/-;
9339: }
9340: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9341: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
9342: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9343: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
9344: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
9345: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
9346: -/uploaded/$1/$2/-x;
9347: }
9348: if ($file=~ m{^/userfiles/}) {
9349: $file =~ s{^/userfiles/}{/uploaded/};
9350: }
9351: return $file;
9352: }
9353:
9354: sub current_machine_domains {
9355: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9356: }
9357:
9358: sub machine_domains {
9359: my ($hostname) = @_;
9360: my @domains;
9361: my %hostname = &all_hostnames();
9362: while( my($id, $name) = each(%hostname)) {
9363: # &logthis("-$id-$name-$hostname-");
9364: if ($hostname eq $name) {
9365: push(@domains,&host_domain($id));
9366: }
9367: }
9368: return @domains;
9369: }
9370:
9371: sub current_machine_ids {
9372: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9373: }
9374:
9375: sub machine_ids {
9376: my ($hostname) = @_;
9377: $hostname ||= &hostname($perlvar{'lonHostID'});
9378: my @ids;
9379: my %name_to_host = &all_names();
9380: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9381: return @{ $name_to_host{$hostname} };
9382: }
9383: return;
9384: }
9385:
9386: sub additional_machine_domains {
9387: my @domains;
9388: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9389: while( my $line = <$fh>) {
9390: $line =~ s/\s//g;
9391: push(@domains,$line);
9392: }
9393: return @domains;
9394: }
9395:
9396: sub default_login_domain {
9397: my $domain = $perlvar{'lonDefDomain'};
9398: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9399: foreach my $posdom (¤t_machine_domains(),
9400: &additional_machine_domains()) {
9401: if (lc($posdom) eq lc($testdomain)) {
9402: $domain=$posdom;
9403: last;
9404: }
9405: }
9406: return $domain;
9407: }
9408:
9409: # ------------------------------------------------------------- Declutters URLs
9410:
9411: sub declutter {
9412: my $thisfn=shift;
9413: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
9414: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9415: $thisfn=~s/^\///;
9416: $thisfn=~s|^adm/wrapper/||;
9417: $thisfn=~s|^adm/coursedocs/showdoc/||;
9418: $thisfn=~s/^res\///;
9419: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9420: $thisfn=~s/\?.+$//;
9421: }
9422: return $thisfn;
9423: }
9424:
9425: # ------------------------------------------------------------- Clutter up URLs
9426:
9427: sub clutter {
9428: my $thisfn='/'.&declutter(shift);
9429: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
9430: || $thisfn =~ m{^/adm/(includes|pages)} ) {
9431: $thisfn='/res'.$thisfn;
9432: }
9433: if ($thisfn !~m|^/adm|) {
9434: if ($thisfn =~ m|^/ext/|) {
9435: $thisfn='/adm/wrapper'.$thisfn;
9436: } else {
9437: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9438: my $embstyle=&Apache::loncommon::fileembstyle($ext);
9439: if ($embstyle eq 'ssi'
9440: || ($embstyle eq 'hdn')
9441: || ($embstyle eq 'rat')
9442: || ($embstyle eq 'prv')
9443: || ($embstyle eq 'ign')) {
9444: #do nothing with these
9445: } elsif (($embstyle eq 'img')
9446: || ($embstyle eq 'emb')
9447: || ($embstyle eq 'wrp')) {
9448: $thisfn='/adm/wrapper'.$thisfn;
9449: } elsif ($embstyle eq 'unk'
9450: && $thisfn!~/\.(sequence|page)$/) {
9451: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
9452: } else {
9453: # &logthis("Got a blank emb style");
9454: }
9455: }
9456: }
9457: return $thisfn;
9458: }
9459:
9460: sub clutter_with_no_wrapper {
9461: my $uri = &clutter(shift);
9462: if ($uri =~ m-^/adm/-) {
9463: $uri =~ s-^/adm/wrapper/-/-;
9464: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9465: }
9466: return $uri;
9467: }
9468:
9469: sub freeze_escape {
9470: my ($value)=@_;
9471: if (ref($value)) {
9472: $value=&nfreeze($value);
9473: return '__FROZEN__'.&escape($value);
9474: }
9475: return &escape($value);
9476: }
9477:
9478:
9479: sub thaw_unescape {
9480: my ($value)=@_;
9481: if ($value =~ /^__FROZEN__/) {
9482: substr($value,0,10,undef);
9483: $value=&unescape($value);
9484: return &thaw($value);
9485: }
9486: return &unescape($value);
9487: }
9488:
9489: sub correct_line_ends {
9490: my ($result)=@_;
9491: $$result =~s/\r\n/\n/mg;
9492: $$result =~s/\r/\n/mg;
9493: }
9494: # ================================================================ Main Program
9495:
9496: sub goodbye {
9497: &logthis("Starting Shut down");
9498: #not converted to using infrastruture and probably shouldn't be
9499: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
9500: #converted
9501: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
9502: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9503: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9504: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
9505: #1.1 only
9506: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9507: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9508: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9509: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9510: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
9511: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9512: &logthis(sprintf("%-20s is %s",'hits',$hits));
9513: &flushcourselogs();
9514: &logthis("Shutting down");
9515: }
9516:
9517: sub get_dns {
9518: my ($url,$func,$ignore_cache) = @_;
9519: if (!$ignore_cache) {
9520: my ($content,$cached)=
9521: &Apache::lonnet::is_cached_new('dns',$url);
9522: if ($cached) {
9523: &$func($content);
9524: return;
9525: }
9526: }
9527:
9528: my %alldns;
9529: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9530: foreach my $dns (<$config>) {
9531: next if ($dns !~ /^\^(\S*)/x);
9532: my $line = $1;
9533: my ($host,$protocol) = split(/:/,$line);
9534: if ($protocol ne 'https') {
9535: $protocol = 'http';
9536: }
9537: $alldns{$host} = $protocol;
9538: }
9539: while (%alldns) {
9540: my ($dns) = keys(%alldns);
9541: my $ua=new LWP::UserAgent;
9542: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
9543: my $response=$ua->request($request);
9544: delete($alldns{$dns});
9545: next if ($response->is_error());
9546: my @content = split("\n",$response->content);
9547: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
9548: &$func(\@content);
9549: return;
9550: }
9551: close($config);
9552: my $which = (split('/',$url))[3];
9553: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9554: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
9555: my @content = <$config>;
9556: &$func(\@content);
9557: return;
9558: }
9559: # ------------------------------------------------------------ Read domain file
9560: {
9561: my $loaded;
9562: my %domain;
9563:
9564: sub parse_domain_tab {
9565: my ($lines) = @_;
9566: foreach my $line (@$lines) {
9567: next if ($line =~ /^(\#|\s*$ )/x);
9568:
9569: chomp($line);
9570: my ($name,@elements) = split(/:/,$line,9);
9571: my %this_domain;
9572: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9573: 'lang_def', 'city', 'longi', 'lati',
9574: 'primary') {
9575: $this_domain{$field} = shift(@elements);
9576: }
9577: $domain{$name} = \%this_domain;
9578: }
9579: }
9580:
9581: sub reset_domain_info {
9582: undef($loaded);
9583: undef(%domain);
9584: }
9585:
9586: sub load_domain_tab {
9587: my ($ignore_cache) = @_;
9588: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
9589: my $fh;
9590: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9591: my @lines = <$fh>;
9592: &parse_domain_tab(\@lines);
9593: }
9594: close($fh);
9595: $loaded = 1;
9596: }
9597:
9598: sub domain {
9599: &load_domain_tab() if (!$loaded);
9600:
9601: my ($name,$what) = @_;
9602: return if ( !exists($domain{$name}) );
9603:
9604: if (!$what) {
9605: return $domain{$name}{'description'};
9606: }
9607: return $domain{$name}{$what};
9608: }
9609:
9610: sub domain_info {
9611: &load_domain_tab() if (!$loaded);
9612: return %domain;
9613: }
9614:
9615: }
9616:
9617:
9618: # ------------------------------------------------------------- Read hosts file
9619: {
9620: my %hostname;
9621: my %hostdom;
9622: my %libserv;
9623: my $loaded;
9624: my %name_to_host;
9625:
9626: sub parse_hosts_tab {
9627: my ($file) = @_;
9628: foreach my $configline (@$file) {
9629: next if ($configline =~ /^(\#|\s*$ )/x);
9630: next if ($configline =~ /^\^/);
9631: chomp($configline);
9632: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
9633: $name=~s/\s//g;
9634: if ($id && $domain && $role && $name) {
9635: $hostname{$id}=$name;
9636: push(@{$name_to_host{$name}}, $id);
9637: $hostdom{$id}=$domain;
9638: if ($role eq 'library') { $libserv{$id}=$name; }
9639: if (defined($protocol)) {
9640: if ($protocol eq 'https') {
9641: $protocol{$id} = $protocol;
9642: } else {
9643: $protocol{$id} = 'http';
9644: }
9645: } else {
9646: $protocol{$id} = 'http';
9647: }
9648: }
9649: }
9650: }
9651:
9652: sub reset_hosts_info {
9653: &purge_remembered();
9654: &reset_domain_info();
9655: &reset_hosts_ip_info();
9656: undef(%name_to_host);
9657: undef(%hostname);
9658: undef(%hostdom);
9659: undef(%libserv);
9660: undef($loaded);
9661: }
9662:
9663: sub load_hosts_tab {
9664: my ($ignore_cache) = @_;
9665: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
9666: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9667: my @config = <$config>;
9668: &parse_hosts_tab(\@config);
9669: close($config);
9670: $loaded=1;
9671: }
9672:
9673: sub hostname {
9674: &load_hosts_tab() if (!$loaded);
9675:
9676: my ($lonid) = @_;
9677: return $hostname{$lonid};
9678: }
9679:
9680: sub all_hostnames {
9681: &load_hosts_tab() if (!$loaded);
9682:
9683: return %hostname;
9684: }
9685:
9686: sub all_names {
9687: &load_hosts_tab() if (!$loaded);
9688:
9689: return %name_to_host;
9690: }
9691:
9692: sub all_host_domain {
9693: &load_hosts_tab() if (!$loaded);
9694: return %hostdom;
9695: }
9696:
9697: sub is_library {
9698: &load_hosts_tab() if (!$loaded);
9699:
9700: return exists($libserv{$_[0]});
9701: }
9702:
9703: sub all_library {
9704: &load_hosts_tab() if (!$loaded);
9705:
9706: return %libserv;
9707: }
9708:
9709: sub unique_library {
9710: #2x reverse removes all hostnames that appear more than once
9711: my %unique = reverse &all_library();
9712: return reverse %unique;
9713: }
9714:
9715: sub get_servers {
9716: &load_hosts_tab() if (!$loaded);
9717:
9718: my ($domain,$type) = @_;
9719: my %possible_hosts = ($type eq 'library') ? %libserv
9720: : %hostname;
9721: my %result;
9722: if (ref($domain) eq 'ARRAY') {
9723: while ( my ($host,$hostname) = each(%possible_hosts)) {
9724: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
9725: $result{$host} = $hostname;
9726: }
9727: }
9728: } else {
9729: while ( my ($host,$hostname) = each(%possible_hosts)) {
9730: if ($hostdom{$host} eq $domain) {
9731: $result{$host} = $hostname;
9732: }
9733: }
9734: }
9735: return %result;
9736: }
9737:
9738: sub get_unique_servers {
9739: my %unique = reverse &get_servers(@_);
9740: return reverse %unique;
9741: }
9742:
9743: sub host_domain {
9744: &load_hosts_tab() if (!$loaded);
9745:
9746: my ($lonid) = @_;
9747: return $hostdom{$lonid};
9748: }
9749:
9750: sub all_domains {
9751: &load_hosts_tab() if (!$loaded);
9752:
9753: my %seen;
9754: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9755: return @uniq;
9756: }
9757: }
9758:
9759: {
9760: my %iphost;
9761: my %name_to_ip;
9762: my %lonid_to_ip;
9763:
9764: sub get_hosts_from_ip {
9765: my ($ip) = @_;
9766: my %iphosts = &get_iphost();
9767: if (ref($iphosts{$ip})) {
9768: return @{$iphosts{$ip}};
9769: }
9770: return;
9771: }
9772:
9773: sub reset_hosts_ip_info {
9774: undef(%iphost);
9775: undef(%name_to_ip);
9776: undef(%lonid_to_ip);
9777: }
9778:
9779: sub get_host_ip {
9780: my ($lonid) = @_;
9781: if (exists($lonid_to_ip{$lonid})) {
9782: return $lonid_to_ip{$lonid};
9783: }
9784: my $name=&hostname($lonid);
9785: my $ip = gethostbyname($name);
9786: return if (!$ip || length($ip) ne 4);
9787: $ip=inet_ntoa($ip);
9788: $name_to_ip{$name} = $ip;
9789: $lonid_to_ip{$lonid} = $ip;
9790: return $ip;
9791: }
9792:
9793: sub get_iphost {
9794: my ($ignore_cache) = @_;
9795:
9796: if (!$ignore_cache) {
9797: if (%iphost) {
9798: return %iphost;
9799: }
9800: my ($ip_info,$cached)=
9801: &Apache::lonnet::is_cached_new('iphost','iphost');
9802: if ($cached) {
9803: %iphost = %{$ip_info->[0]};
9804: %name_to_ip = %{$ip_info->[1]};
9805: %lonid_to_ip = %{$ip_info->[2]};
9806: return %iphost;
9807: }
9808: }
9809:
9810: # get yesterday's info for fallback
9811: my %old_name_to_ip;
9812: my ($ip_info,$cached)=
9813: &Apache::lonnet::is_cached_new('iphost','iphost');
9814: if ($cached) {
9815: %old_name_to_ip = %{$ip_info->[1]};
9816: }
9817:
9818: my %name_to_host = &all_names();
9819: foreach my $name (keys(%name_to_host)) {
9820: my $ip;
9821: if (!exists($name_to_ip{$name})) {
9822: $ip = gethostbyname($name);
9823: if (!$ip || length($ip) ne 4) {
9824: if (defined($old_name_to_ip{$name})) {
9825: $ip = $old_name_to_ip{$name};
9826: &logthis("Can't find $name defaulting to old $ip");
9827: } else {
9828: &logthis("Name $name no IP found");
9829: next;
9830: }
9831: } else {
9832: $ip=inet_ntoa($ip);
9833: }
9834: $name_to_ip{$name} = $ip;
9835: } else {
9836: $ip = $name_to_ip{$name};
9837: }
9838: foreach my $id (@{ $name_to_host{$name} }) {
9839: $lonid_to_ip{$id} = $ip;
9840: }
9841: push(@{$iphost{$ip}},@{$name_to_host{$name}});
9842: }
9843: &Apache::lonnet::do_cache_new('iphost','iphost',
9844: [\%iphost,\%name_to_ip,\%lonid_to_ip],
9845: 48*60*60);
9846:
9847: return %iphost;
9848: }
9849:
9850: #
9851: # Given a DNS returns the loncapa host name for that DNS
9852: #
9853: sub host_from_dns {
9854: my ($dns) = @_;
9855: my @hosts;
9856: my $ip;
9857:
9858: if (exists($name_to_ip{$dns})) {
9859: $ip = $name_to_ip{$dns};
9860: }
9861: if (!$ip) {
9862: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9863: if (length($ip) == 4) {
9864: $ip = &IO::Socket::inet_ntoa($ip);
9865: }
9866: }
9867: if ($ip) {
9868: @hosts = get_hosts_from_ip($ip);
9869: return $hosts[0];
9870: }
9871: return undef;
9872: }
9873:
9874: }
9875:
9876: BEGIN {
9877:
9878: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9879: unless ($readit) {
9880: {
9881: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9882: %perlvar = (%perlvar,%{$configvars});
9883: }
9884:
9885:
9886: # ------------------------------------------------------ Read spare server file
9887: {
9888: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
9889:
9890: while (my $configline=<$config>) {
9891: chomp($configline);
9892: if ($configline) {
9893: my ($host,$type) = split(':',$configline,2);
9894: if (!defined($type) || $type eq '') { $type = 'default' };
9895: push(@{ $spareid{$type} }, $host);
9896: }
9897: }
9898: close($config);
9899: }
9900: # ------------------------------------------------------------ Read permissions
9901: {
9902: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
9903:
9904: while (my $configline=<$config>) {
9905: chomp($configline);
9906: if ($configline) {
9907: my ($role,$perm)=split(/ /,$configline);
9908: if ($perm ne '') { $pr{$role}=$perm; }
9909: }
9910: }
9911: close($config);
9912: }
9913:
9914: # -------------------------------------------- Read plain texts for permissions
9915: {
9916: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
9917:
9918: while (my $configline=<$config>) {
9919: chomp($configline);
9920: if ($configline) {
9921: my ($short,@plain)=split(/:/,$configline);
9922: %{$prp{$short}} = ();
9923: if (@plain > 0) {
9924: $prp{$short}{'std'} = $plain[0];
9925: for (my $i=1; $i<@plain; $i++) {
9926: $prp{$short}{'alt'.$i} = $plain[$i];
9927: }
9928: }
9929: }
9930: }
9931: close($config);
9932: }
9933:
9934: # ---------------------------------------------------------- Read package table
9935: {
9936: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
9937:
9938: while (my $configline=<$config>) {
9939: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
9940: chomp($configline);
9941: my ($short,$plain)=split(/:/,$configline);
9942: my ($pack,$name)=split(/\&/,$short);
9943: if ($plain ne '') {
9944: $packagetab{$pack.'&'.$name.'&name'}=$name;
9945: $packagetab{$short}=$plain;
9946: }
9947: }
9948: close($config);
9949: }
9950:
9951: # ------------- set up temporary directory
9952: {
9953: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9954:
9955: }
9956:
9957: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9958: 'compress_threshold'=> 20_000,
9959: });
9960:
9961: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
9962: $dumpcount=0;
9963: $locknum=0;
9964:
9965: &logtouch();
9966: &logthis('<font color="yellow">INFO: Read configuration</font>');
9967: $readit=1;
9968: {
9969: use integer;
9970: my $test=(2**32)+1;
9971: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
9972: &logthis(" Detected 64bit platform ($_64bit)");
9973: }
9974: }
9975: }
9976:
9977: 1;
9978: __END__
9979:
9980: =pod
9981:
9982: =head1 NAME
9983:
9984: Apache::lonnet - Subroutines to ask questions about things in the network.
9985:
9986: =head1 SYNOPSIS
9987:
9988: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
9989:
9990: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9991:
9992: Common parameters:
9993:
9994: =over 4
9995:
9996: =item *
9997:
9998: $uname : an internal username (if $cname expecting a course Id specifically)
9999:
10000: =item *
10001:
10002: $udom : a domain (if $cdom expecting a course's domain specifically)
10003:
10004: =item *
10005:
10006: $symb : a resource instance identifier
10007:
10008: =item *
10009:
10010: $namespace : the name of a .db file that contains the data needed or
10011: being set.
10012:
10013: =back
10014:
10015: =head1 OVERVIEW
10016:
10017: lonnet provides subroutines which interact with the
10018: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
10019: about classes, users, and resources.
10020:
10021: For many of these objects you can also use this to store data about
10022: them or modify them in various ways.
10023:
10024: =head2 Symbs
10025:
10026: To identify a specific instance of a resource, LON-CAPA uses symbols
10027: or "symbs"X<symb>. These identifiers are built from the URL of the
10028: map, the resource number of the resource in the map, and the URL of
10029: the resource itself. The latter is somewhat redundant, but might help
10030: if maps change.
10031:
10032: An example is
10033:
10034: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
10035:
10036: The respective map entry is
10037:
10038: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10039: title="Problem 2">
10040: </resource>
10041:
10042: Symbs are used by the random number generator, as well as to store and
10043: restore data specific to a certain instance of for example a problem.
10044:
10045: =head2 Storing And Retrieving Data
10046:
10047: X<store()>X<cstore()>X<restore()>Three of the most important functions
10048: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10049: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10050: is is the non-critical message twin of cstore. These functions are for
10051: handlers to store a perl hash to a user's permanent data space in an
10052: easy manner, and to retrieve it again on another call. It is expected
10053: that a handler would use this once at the beginning to retrieve data,
10054: and then again once at the end to send only the new data back.
10055:
10056: The data is stored in the user's data directory on the user's
10057: homeserver under the ID of the course.
10058:
10059: The hash that is returned by restore will have all of the previous
10060: value for all of the elements of the hash.
10061:
10062: Example:
10063:
10064: #creating a hash
10065: my %hash;
10066: $hash{'foo'}='bar';
10067:
10068: #storing it
10069: &Apache::lonnet::cstore(\%hash);
10070:
10071: #changing a value
10072: $hash{'foo'}='notbar';
10073:
10074: #adding a new value
10075: $hash{'bar'}='foo';
10076: &Apache::lonnet::cstore(\%hash);
10077:
10078: #retrieving the hash
10079: my %history=&Apache::lonnet::restore();
10080:
10081: #print the hash
10082: foreach my $key (sort(keys(%history))) {
10083: print("\%history{$key} = $history{$key}");
10084: }
10085:
10086: Will print out:
10087:
10088: %history{1:foo} = bar
10089: %history{1:keys} = foo:timestamp
10090: %history{1:timestamp} = 990455579
10091: %history{2:bar} = foo
10092: %history{2:foo} = notbar
10093: %history{2:keys} = foo:bar:timestamp
10094: %history{2:timestamp} = 990455580
10095: %history{bar} = foo
10096: %history{foo} = notbar
10097: %history{timestamp} = 990455580
10098: %history{version} = 2
10099:
10100: Note that the special hash entries C<keys>, C<version> and
10101: C<timestamp> were added to the hash. C<version> will be equal to the
10102: total number of versions of the data that have been stored. The
10103: C<timestamp> attribute will be the UNIX time the hash was
10104: stored. C<keys> is available in every historical section to list which
10105: keys were added or changed at a specific historical revision of a
10106: hash.
10107:
10108: B<Warning>: do not store the hash that restore returns directly. This
10109: will cause a mess since it will restore the historical keys as if the
10110: were new keys. I.E. 1:foo will become 1:1:foo etc.
10111:
10112: Calling convention:
10113:
10114: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10115: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
10116:
10117: For more detailed information, see lonnet specific documentation.
10118:
10119: =head1 RETURN MESSAGES
10120:
10121: =over 4
10122:
10123: =item * B<con_lost>: unable to contact remote host
10124:
10125: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10126: when the connection is brought back up
10127:
10128: =item * B<con_failed>: unable to contact remote host and unable to save message
10129: for later delivery
10130:
10131: =item * B<error:>: an error a occurred, a description of the error follows the :
10132:
10133: =item * B<no_such_host>: unable to fund a host associated with the user/domain
10134: that was requested
10135:
10136: =back
10137:
10138: =head1 PUBLIC SUBROUTINES
10139:
10140: =head2 Session Environment Functions
10141:
10142: =over 4
10143:
10144: =item *
10145: X<appenv()>
10146: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
10147: the user envirnoment file, and will be restored for each access this
10148: user makes during this session, also modifies the %env for the current
10149: process. Optional rolesarrayref - if defined contains a reference to an array
10150: of roles which are exempt from the restriction on modifying user.role entries
10151: in the user's environment.db and in %env.
10152:
10153: =item *
10154: X<delenv()>
10155: B<delenv($delthis,$regexp)>: removes all items from the session
10156: environment file that begin with $delthis. If the
10157: optional second arg - $regexp - is true, $delthis is treated as a
10158: regular expression, otherwise \Q$delthis\E is used.
10159: The values are also deleted from the current processes %env.
10160:
10161: =item * get_env_multiple($name)
10162:
10163: gets $name from the %env hash, it seemlessly handles the cases where multiple
10164: values may be defined and end up as an array ref.
10165:
10166: returns an array of values
10167:
10168: =back
10169:
10170: =head2 User Information
10171:
10172: =over 4
10173:
10174: =item *
10175: X<queryauthenticate()>
10176: B<queryauthenticate($uname,$udom)>: try to determine user's current
10177: authentication scheme
10178:
10179: =item *
10180: X<authenticate()>
10181: B<authenticate($uname,$upass,$udom)>: try to
10182: authenticate user from domain's lib servers (first use the current
10183: one). C<$upass> should be the users password.
10184:
10185: =item *
10186: X<homeserver()>
10187: B<homeserver($uname,$udom)>: find the server which has
10188: the user's directory and files (there must be only one), this caches
10189: the answer, and also caches if there is a borken connection.
10190:
10191: =item *
10192: X<idget()>
10193: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10194: (IDs are a unique resource in a domain, there must be only 1 ID per
10195: username, and only 1 username per ID in a specific domain) (returns
10196: hash: id=>name,id=>name)
10197:
10198: =item *
10199: X<idrget()>
10200: B<idrget($udom,@unames)>: find the IDs behind a list of
10201: usernames (returns hash: name=>id,name=>id)
10202:
10203: =item *
10204: X<idput()>
10205: B<idput($udom,%ids)>: store away a list of names and associated IDs
10206:
10207: =item *
10208: X<rolesinit()>
10209: B<rolesinit($udom,$username,$authhost)>: get user privileges
10210:
10211: =item *
10212: X<getsection()>
10213: B<getsection($udom,$uname,$cname)>: finds the section of student in the
10214: course $cname, return section name/number or '' for "not in course"
10215: and '-1' for "no section"
10216:
10217: =item *
10218: X<userenvironment()>
10219: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
10220: passed in @what from the requested user's environment, returns a hash
10221:
10222: =item *
10223: X<userlog_query()>
10224: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10225: activity.log file. %filters defines filters applied when parsing the
10226: log file. These can be start or end timestamps, or the type of action
10227: - log to look for Login or Logout events, check for Checkin or
10228: Checkout, role for role selection. The response is in the form
10229: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10230: escaped strings of the action recorded in the activity.log file.
10231:
10232: =back
10233:
10234: =head2 User Roles
10235:
10236: =over 4
10237:
10238: =item *
10239:
10240: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
10241: F: full access
10242: U,I,K: authentication modes (cxx only)
10243: '': forbidden
10244: 1: user needs to choose course
10245: 2: browse allowed
10246: A: passphrase authentication needed
10247:
10248: =item *
10249:
10250: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10251: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10252: and course level
10253:
10254: =item *
10255:
10256: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10257: (rolesplain.tab); plain text explanation of a user role term.
10258: $type is Course (default) or Community.
10259: If $forcedefault evaluates to true, text returned will be default
10260: text for $type. Otherwise, if this is a course, the text returned
10261: will be a custom name for the role (if defined in the course's
10262: environment). If no custom name is defined the default is returned.
10263:
10264: =item *
10265:
10266: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
10267: All arguments are optional. Returns a hash of a roles, either for
10268: co-author/assistant author roles for a user's Construction Space
10269: (default), or if $context is 'userroles', roles for the user himself,
10270: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10271: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10272: For each key, value is set to colon-separated start and end times for
10273: the role. If no username and domain are specified, will default to
10274: current user/domain. Types, roles, and roledoms are references to arrays
10275: of role statuses (active, future or previous), roles
10276: (e.g., cc,in, st etc.) and domains of the roles which can be used
10277: to restrict the list of roles reported. If no array ref is
10278: provided for types, will default to return only active roles.
10279:
10280: =back
10281:
10282: =head2 User Modification
10283:
10284: =over 4
10285:
10286: =item *
10287:
10288: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
10289: user for the level given by URL. Optional start and end dates (leave empty
10290: string or zero for "no date")
10291:
10292: =item *
10293:
10294: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10295: change a users, password, possible return values are: ok,
10296: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10297: refused
10298:
10299: =item *
10300:
10301: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
10302:
10303: =item *
10304:
10305: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
10306: $forceid,$desiredhome,$email,$inststatus,$candelete) :
10307:
10308: will update user information (firstname,middlename,lastname,generation,
10309: permanentemail), and if forceid is true, student/employee ID also.
10310: A user's institutional affiliation(s) can also be updated.
10311: User information fields will not be overwritten with empty entries
10312: unless the field is included in the $candelete array reference.
10313: This array is included when a single user is modified via "Manage Users",
10314: or when Autoupdate.pl is run by cron in a domain.
10315:
10316: =item *
10317:
10318: modifystudent
10319:
10320: modify a student's enrollment and identification information.
10321: The course id is resolved based on the current users environment.
10322: This means the envoking user must be a course coordinator or otherwise
10323: associated with a course.
10324:
10325: This call is essentially a wrapper for lonnet::modifyuser and
10326: lonnet::modify_student_enrollment
10327:
10328: Inputs:
10329:
10330: =over 4
10331:
10332: =item B<$udom> Student's loncapa domain
10333:
10334: =item B<$uname> Student's loncapa login name
10335:
10336: =item B<$uid> Student/Employee ID
10337:
10338: =item B<$umode> Student's authentication mode
10339:
10340: =item B<$upass> Student's password
10341:
10342: =item B<$first> Student's first name
10343:
10344: =item B<$middle> Student's middle name
10345:
10346: =item B<$last> Student's last name
10347:
10348: =item B<$gene> Student's generation
10349:
10350: =item B<$usec> Student's section in course
10351:
10352: =item B<$end> Unix time of the roles expiration
10353:
10354: =item B<$start> Unix time of the roles start date
10355:
10356: =item B<$forceid> If defined, allow $uid to be changed
10357:
10358: =item B<$desiredhome> server to use as home server for student
10359:
10360: =item B<$email> Student's permanent e-mail address
10361:
10362: =item B<$type> Type of enrollment (auto or manual)
10363:
10364: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10365:
10366: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
10367:
10368: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
10369:
10370: =item B<$context> role change context (shown in User Management Logs display in a course)
10371:
10372: =item B<$inststatus> institutional status of user - : separated string of escaped status types
10373:
10374: =back
10375:
10376: =item *
10377:
10378: modify_student_enrollment
10379:
10380: Change a students enrollment status in a class. The environment variable
10381: 'role.request.course' must be defined for this function to proceed.
10382:
10383: Inputs:
10384:
10385: =over 4
10386:
10387: =item $udom, students domain
10388:
10389: =item $uname, students name
10390:
10391: =item $uid, students user id
10392:
10393: =item $first, students first name
10394:
10395: =item $middle
10396:
10397: =item $last
10398:
10399: =item $gene
10400:
10401: =item $usec
10402:
10403: =item $end
10404:
10405: =item $start
10406:
10407: =item $type
10408:
10409: =item $locktype
10410:
10411: =item $cid
10412:
10413: =item $selfenroll
10414:
10415: =item $context
10416:
10417: =back
10418:
10419:
10420: =item *
10421:
10422: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10423: custom role; give a custom role to a user for the level given by URL. Specify
10424: name and domain of role author, and role name
10425:
10426: =item *
10427:
10428: revokerole($udom,$uname,$url,$role) : revoke a role for url
10429:
10430: =item *
10431:
10432: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10433:
10434: =back
10435:
10436: =head2 Course Infomation
10437:
10438: =over 4
10439:
10440: =item *
10441:
10442: coursedescription($courseid) : returns a hash of information about the
10443: specified course id, including all environment settings for the
10444: course, the description of the course will be in the hash under the
10445: key 'description'
10446:
10447: =item *
10448:
10449: resdata($name,$domain,$type,@which) : request for current parameter
10450: setting for a specific $type, where $type is either 'course' or 'user',
10451: @what should be a list of parameters to ask about. This routine caches
10452: answers for 5 minutes.
10453:
10454: =item *
10455:
10456: get_courseresdata($courseid, $domain) : dump the entire course resource
10457: data base, returning a hash that is keyed by the resource name and has
10458: values that are the resource value. I believe that the timestamps and
10459: versions are also returned.
10460:
10461:
10462: =back
10463:
10464: =head2 Course Modification
10465:
10466: =over 4
10467:
10468: =item *
10469:
10470: writecoursepref($courseid,%prefs) : write preferences (environment
10471: database) for a course
10472:
10473: =item *
10474:
10475: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10476:
10477: =item *
10478:
10479: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
10480:
10481: =back
10482:
10483: =head2 Resource Subroutines
10484:
10485: =over 4
10486:
10487: =item *
10488:
10489: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
10490:
10491: =item *
10492:
10493: repcopy($filename) : subscribes to the requested file, and attempts to
10494: replicate from the owning library server, Might return
10495: 'unavailable', 'not_found', 'forbidden', 'ok', or
10496: 'bad_request', also attempts to grab the metadata for the
10497: resource. Expects the local filesystem pathname
10498: (/home/httpd/html/res/....)
10499:
10500: =back
10501:
10502: =head2 Resource Information
10503:
10504: =over 4
10505:
10506: =item *
10507:
10508: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10509: a vairety of different possible values, $varname should be a request
10510: string, and the other parameters can be used to specify who and what
10511: one is asking about.
10512:
10513: Possible values for $varname are environment.lastname (or other item
10514: from the envirnment hash), user.name (or someother aspect about the
10515: user), resource.0.maxtries (or some other part and parameter of a
10516: resource)
10517:
10518: =item *
10519:
10520: directcondval($number) : get current value of a condition; reads from a state
10521: string
10522:
10523: =item *
10524:
10525: condval($condidx) : value of condition index based on state
10526:
10527: =item *
10528:
10529: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10530: resource's metadata, $what should be either a specific key, or either
10531: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10532: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10533:
10534: this function automatically caches all requests
10535:
10536: =item *
10537:
10538: metadata_query($query,$custom,$customshow) : make a metadata query against the
10539: network of library servers; returns file handle of where SQL and regex results
10540: will be stored for query
10541:
10542: =item *
10543:
10544: symbread($filename) : return symbolic list entry (filename argument optional);
10545: returns the data handle
10546:
10547: =item *
10548:
10549: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
10550: a possible symb for the URL in $thisfn, and if is an encryypted
10551: resource that the user accessed using /enc/ returns a 1 on success, 0
10552: on failure, user must be in a course, as it assumes the existance of
10553: the course initial hash, and uses $env('request.course.id'}
10554:
10555:
10556: =item *
10557:
10558: symbclean($symb) : removes versions numbers from a symb, returns the
10559: cleaned symb
10560:
10561: =item *
10562:
10563: is_on_map($uri) : checks if the $uri is somewhere on the current
10564: course map, user must be in a course for it to work.
10565:
10566: =item *
10567:
10568: numval($salt) : return random seed value (addend for rndseed)
10569:
10570: =item *
10571:
10572: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10573: a random seed, all arguments are optional, if they aren't sent it uses the
10574: environment to derive them. Note: if symb isn't sent and it can't get one
10575: from &symbread it will use the current time as its return value
10576:
10577: =item *
10578:
10579: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10580: unfakeable, receipt
10581:
10582: =item *
10583:
10584: receipt() : API to ireceipt working off of env values; given out to users
10585:
10586: =item *
10587:
10588: countacc($url) : count the number of accesses to a given URL
10589:
10590: =item *
10591:
10592: 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
10593:
10594: =item *
10595:
10596: 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)
10597:
10598: =item *
10599:
10600: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
10601:
10602: =item *
10603:
10604: devalidate($symb) : devalidate temporary spreadsheet calculations,
10605: forcing spreadsheet to reevaluate the resource scores next time.
10606:
10607: =back
10608:
10609: =head2 Storing/Retreiving Data
10610:
10611: =over 4
10612:
10613: =item *
10614:
10615: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10616: for this url; hashref needs to be given and should be a \%hashname; the
10617: remaining args aren't required and if they aren't passed or are '' they will
10618: be derived from the env
10619:
10620: =item *
10621:
10622: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10623: uses critical subroutine
10624:
10625: =item *
10626:
10627: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10628: all args are optional
10629:
10630: =item *
10631:
10632: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10633: dumps the complete (or key matching regexp) namespace into a hash
10634: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10635: normally &store()ed into
10636:
10637: $range should be either an integer '100' (give me the first 100
10638: matching records)
10639: or be two integers sperated by a - with no spaces
10640: '30-50' (give me the 30th through the 50th matching
10641: records)
10642:
10643:
10644: =item *
10645:
10646: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10647: replaces a &store() version of data with a replacement set of data
10648: for a particular resource in a namespace passed in the $storehash hash
10649: reference
10650:
10651: =item *
10652:
10653: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10654: works very similar to store/cstore, but all data is stored in a
10655: temporary location and can be reset using tmpreset, $storehash should
10656: be a hash reference, returns nothing on success
10657:
10658: =item *
10659:
10660: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10661: similar to restore, but all data is stored in a temporary location and
10662: can be reset using tmpreset. Returns a hash of values on success,
10663: error string otherwise.
10664:
10665: =item *
10666:
10667: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10668: deltes all keys for $symb form the temporary storage hash.
10669:
10670: =item *
10671:
10672: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10673: reference filled in from namesp ($udom and $uname are optional)
10674:
10675: =item *
10676:
10677: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10678: namesp ($udom and $uname are optional)
10679:
10680: =item *
10681:
10682: dump($namespace,$udom,$uname,$regexp,$range) :
10683: dumps the complete (or key matching regexp) namespace into a hash
10684: ($udom, $uname, $regexp, $range are optional)
10685:
10686: $range should be either an integer '100' (give me the first 100
10687: matching records)
10688: or be two integers sperated by a - with no spaces
10689: '30-50' (give me the 30th through the 50th matching
10690: records)
10691: =item *
10692:
10693: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10694: $store can be a scalar, an array reference, or if the amount to be
10695: incremented is > 1, a hash reference.
10696:
10697: ($udom and $uname are optional)
10698:
10699: =item *
10700:
10701: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10702: ($udom and $uname are optional)
10703:
10704: =item *
10705:
10706: cput($namespace,$storehash,$udom,$uname) : critical put
10707: ($udom and $uname are optional)
10708:
10709: =item *
10710:
10711: newput($namespace,$storehash,$udom,$uname) :
10712:
10713: Attempts to store the items in the $storehash, but only if they don't
10714: currently exist, if this succeeds you can be certain that you have
10715: successfully created a new key value pair in the $namespace db.
10716:
10717:
10718: Args:
10719: $namespace: name of database to store values to
10720: $storehash: hashref to store to the db
10721: $udom: (optional) domain of user containing the db
10722: $uname: (optional) name of user caontaining the db
10723:
10724: Returns:
10725: 'ok' -> succeeded in storing all keys of $storehash
10726: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10727: least <key> already existed in the db (other
10728: requested keys may also already exist)
10729: 'error: <msg>' -> unable to tie the DB or other error occurred
10730: 'con_lost' -> unable to contact request server
10731: 'refused' -> action was not allowed by remote machine
10732:
10733:
10734: =item *
10735:
10736: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10737: reference filled in from namesp (encrypts the return communication)
10738: ($udom and $uname are optional)
10739:
10740: =item *
10741:
10742: log($udom,$name,$home,$message) : write to permanent log for user; use
10743: critical subroutine
10744:
10745: =item *
10746:
10747: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10748: array reference filled in from namespace found in domain level on either
10749: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
10750:
10751: =item *
10752:
10753: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10754: domain level either on specified domain server ($uhome) or primary domain
10755: server ($udom and $uhome are optional)
10756:
10757: =item *
10758:
10759: get_domain_defaults($target_domain) : returns hash with defaults for
10760: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10761: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10762: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10763: Values are retrieved from cache (if current), or from domain's configuration.db
10764: (if available), or lastly from values in lonTabs/dns_domain,tab,
10765: or lonTabs/domain.tab.
10766:
10767: %domdefaults = &get_auth_defaults($target_domain);
10768:
10769: =back
10770:
10771: =head2 Network Status Functions
10772:
10773: =over 4
10774:
10775: =item *
10776:
10777: dirlist($uri) : return directory list based on URI
10778:
10779: =item *
10780:
10781: spareserver() : find server with least workload from spare.tab
10782:
10783:
10784: =item *
10785:
10786: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10787: if there is no corresponding loncapa host.
10788:
10789: =back
10790:
10791:
10792: =head2 Apache Request
10793:
10794: =over 4
10795:
10796: =item *
10797:
10798: ssi($url,%hash) : server side include, does a complete request cycle on url to
10799: localhost, posts hash
10800:
10801: =back
10802:
10803: =head2 Data to String to Data
10804:
10805: =over 4
10806:
10807: =item *
10808:
10809: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10810: and '&' separators, supports elements that are arrayrefs and hashrefs
10811:
10812: =item *
10813:
10814: hashref2str($hashref) : convert a hashref into a string complete with
10815: escaping and '=' and '&' separators, supports elements that are
10816: arrayrefs and hashrefs
10817:
10818: =item *
10819:
10820: arrayref2str($arrayref) : convert an arrayref into a string complete
10821: with escaping and '&' separators, supports elements that are arrayrefs
10822: and hashrefs
10823:
10824: =item *
10825:
10826: str2hash($string) : convert string to hash using unescaping and
10827: splitting on '=' and '&', supports elements that are arrayrefs and
10828: hashrefs
10829:
10830: =item *
10831:
10832: str2array($string) : convert string to hash using unescaping and
10833: splitting on '&', supports elements that are arrayrefs and hashrefs
10834:
10835: =back
10836:
10837: =head2 Logging Routines
10838:
10839: =over 4
10840:
10841: These routines allow one to make log messages in the lonnet.log and
10842: lonnet.perm logfiles.
10843:
10844: =item *
10845:
10846: logtouch() : make sure the logfile, lonnet.log, exists
10847:
10848: =item *
10849:
10850: logthis() : append message to the normal lonnet.log file, it gets
10851: preiodically rolled over and deleted.
10852:
10853: =item *
10854:
10855: logperm() : append a permanent message to lonnet.perm.log, this log
10856: file never gets deleted by any automated portion of the system, only
10857: messages of critical importance should go in here.
10858:
10859: =back
10860:
10861: =head2 General File Helper Routines
10862:
10863: =over 4
10864:
10865: =item *
10866:
10867: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10868: (a) files in /uploaded
10869: (i) If a local copy of the file exists -
10870: compares modification date of local copy with last-modified date for
10871: definitive version stored on home server for course. If local copy is
10872: stale, requests a new version from the home server and stores it.
10873: If the original has been removed from the home server, then local copy
10874: is unlinked.
10875: (ii) If local copy does not exist -
10876: requests the file from the home server and stores it.
10877:
10878: If $caller is 'uploadrep':
10879: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10880: for request for files originally uploaded via DOCS.
10881: - returns 'ok' if fresh local copy now available, -1 otherwise.
10882:
10883: Otherwise:
10884: This indicates a call from the content generation phase of the request.
10885: - returns the entire contents of the file or -1.
10886:
10887: (b) files in /res
10888: - returns the entire contents of a file or -1;
10889: it properly subscribes to and replicates the file if neccessary.
10890:
10891:
10892: =item *
10893:
10894: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10895: reference
10896:
10897: returns either a stat() list of data about the file or an empty list
10898: if the file doesn't exist or couldn't find out about it (connection
10899: problems or user unknown)
10900:
10901: =item *
10902:
10903: filelocation($dir,$file) : returns file system location of a file
10904: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10905: directory that relative $file lookups are to looked in ($dir of /a/dir
10906: and a file of ../bob will become /a/bob)
10907:
10908: =item *
10909:
10910: hreflocation($dir,$file) : returns file system location or a URL; same as
10911: filelocation except for hrefs
10912:
10913: =item *
10914:
10915: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10916:
10917: =back
10918:
10919: =head2 Usererfile file routines (/uploaded*)
10920:
10921: =over 4
10922:
10923: =item *
10924:
10925: userfileupload(): main rotine for putting a file in a user or course's
10926: filespace, arguments are,
10927:
10928: formname - required - this is the name of the element in $env where the
10929: filename, and the contents of the file to create/modifed exist
10930: the filename is in $env{'form.'.$formname.'.filename'} and the
10931: contents of the file is located in $env{'form.'.$formname}
10932: coursedoc - if true, store the file in the course of the active role
10933: of the current user
10934: subdir - required - subdirectory to put the file in under ../userfiles/
10935: if undefined, it will be placed in "unknown"
10936:
10937: (This routine calls clean_filename() to remove any dangerous
10938: characters from the filename, and then calls finuserfileupload() to
10939: complete the transaction)
10940:
10941: returns either the url of the uploaded file (/uploaded/....) if successful
10942: and /adm/notfound.html if unsuccessful
10943:
10944: =item *
10945:
10946: clean_filename(): routine for cleaing a filename up for storage in
10947: userfile space, argument is:
10948:
10949: filename - proposed filename
10950:
10951: returns: the new clean filename
10952:
10953: =item *
10954:
10955: finishuserfileupload(): routine that creaes and sends the file to
10956: userspace, probably shouldn't be called directly
10957:
10958: docuname: username or courseid of destination for the file
10959: docudom: domain of user/course of destination for the file
10960: formname: same as for userfileupload()
10961: fname: filename (inculding subdirectories) for the file
10962:
10963: returns either the url of the uploaded file (/uploaded/....) if successful
10964: and /adm/notfound.html if unsuccessful
10965:
10966: =item *
10967:
10968: renameuserfile(): renames an existing userfile to a new name
10969:
10970: Args:
10971: docuname: username or courseid of destination for the file
10972: docudom: domain of user/course of destination for the file
10973: old: current file name (including any subdirs under userfiles)
10974: new: desired file name (including any subdirs under userfiles)
10975:
10976: =item *
10977:
10978: mkdiruserfile(): creates a directory is a userfiles dir
10979:
10980: Args:
10981: docuname: username or courseid of destination for the file
10982: docudom: domain of user/course of destination for the file
10983: dir: dir to create (including any subdirs under userfiles)
10984:
10985: =item *
10986:
10987: removeuserfile(): removes a file that exists in userfiles
10988:
10989: Args:
10990: docuname: username or courseid of destination for the file
10991: docudom: domain of user/course of destination for the file
10992: fname: filname to delete (including any subdirs under userfiles)
10993:
10994: =item *
10995:
10996: removeuploadedurl(): convience function for removeuserfile()
10997:
10998: Args:
10999: url: a full /uploaded/... url to delete
11000:
11001: =item *
11002:
11003: get_portfile_permissions():
11004: Args:
11005: domain: domain of user or course contain the portfolio files
11006: user: name of user or num of course contain the portfolio files
11007: Returns:
11008: hashref of a dump of the proper file_permissions.db
11009:
11010:
11011: =item *
11012:
11013: get_access_controls():
11014:
11015: Args:
11016: current_permissions: the hash ref returned from get_portfile_permissions()
11017: group: (optional) the group you want the files associated with
11018: file: (optional) the file you want access info on
11019:
11020: Returns:
11021: a hash (keys are file names) of hashes containing
11022: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
11023: values are XML containing access control settings (see below)
11024:
11025: Internal notes:
11026:
11027: access controls are stored in file_permissions.db as key=value pairs.
11028: key -> path to file/file_name\0uniqueID:scope_end_start
11029: where scope -> public,guest,course,group,domains or users.
11030: end -> UNIX time for end of access (0 -> no end date)
11031: start -> UNIX time for start of access
11032:
11033: value -> XML description of access control
11034: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
11035: <start></start>
11036: <end></end>
11037:
11038: <password></password> for scope type = guest
11039:
11040: <domain></domain> for scope type = course or group
11041: <number></number>
11042: <roles id="">
11043: <role></role>
11044: <access></access>
11045: <section></section>
11046: <group></group>
11047: </roles>
11048:
11049: <dom></dom> for scope type = domains
11050:
11051: <users> for scope type = users
11052: <user>
11053: <uname></uname>
11054: <udom></udom>
11055: </user>
11056: </users>
11057: </scope>
11058:
11059: Access data is also aggregated for each file in an additional key=value pair:
11060: key -> path to file/file_name\0accesscontrol
11061: value -> reference to hash
11062: hash contains key = value pairs
11063: where key = uniqueID:scope_end_start
11064: value = UNIX time record was last updated
11065:
11066: Used to improve speed of look-ups of access controls for each file.
11067:
11068: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11069:
11070: modify_access_controls():
11071:
11072: Modifies access controls for a portfolio file
11073: Args
11074: 1. file name
11075: 2. reference to hash of required changes,
11076: 3. domain
11077: 4. username
11078: where domain,username are the domain of the portfolio owner
11079: (either a user or a course)
11080:
11081: Returns:
11082: 1. result of additions or updates ('ok' or 'error', with error message).
11083: 2. result of deletions ('ok' or 'error', with error message).
11084: 3. reference to hash of any new or updated access controls.
11085: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11086: key = integer (inbound ID)
11087: value = uniqueID
11088:
11089: =back
11090:
11091: =head2 HTTP Helper Routines
11092:
11093: =over 4
11094:
11095: =item *
11096:
11097: escape() : unpack non-word characters into CGI-compatible hex codes
11098:
11099: =item *
11100:
11101: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11102:
11103: =back
11104:
11105: =head1 PRIVATE SUBROUTINES
11106:
11107: =head2 Underlying communication routines (Shouldn't call)
11108:
11109: =over 4
11110:
11111: =item *
11112:
11113: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11114:
11115: =item *
11116:
11117: reply() : uses subreply to send a message to remote machine, logs all failures
11118:
11119: =item *
11120:
11121: critical() : passes a critical message to another server; if cannot
11122: get through then place message in connection buffer directory and
11123: returns con_delayed, if incapable of saving message, returns
11124: con_failed
11125:
11126: =item *
11127:
11128: reconlonc() : tries to reconnect lonc client processes.
11129:
11130: =back
11131:
11132: =head2 Resource Access Logging
11133:
11134: =over 4
11135:
11136: =item *
11137:
11138: flushcourselogs() : flush (save) buffer logs and access logs
11139:
11140: =item *
11141:
11142: courselog($what) : save message for course in hash
11143:
11144: =item *
11145:
11146: courseacclog($what) : save message for course using &courselog(). Perform
11147: special processing for specific resource types (problems, exams, quizzes, etc).
11148:
11149: =item *
11150:
11151: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11152: as a PerlChildExitHandler
11153:
11154: =back
11155:
11156: =head2 Other
11157:
11158: =over 4
11159:
11160: =item *
11161:
11162: symblist($mapname,%newhash) : update symbolic storage links
11163:
11164: =back
11165:
11166: =cut
11167:
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