1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.1039 2009/10/31 21:38:00 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: my $upload_photo_form = 0; #Variable to check when user upload a photo 0=not 1=true
103:
104: require Exporter;
105:
106: our @ISA = qw (Exporter);
107: our @EXPORT = qw(%env);
108:
109:
110: # --------------------------------------------------------------------- Logging
111: {
112: my $logid;
113: sub instructor_log {
114: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
115: if (($cnum eq '') || ($cdom eq '')) {
116: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
117: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
118: }
119: $logid++;
120: my $now = time();
121: my $id=$now.'00000'.$$.'00000'.$logid;
122: return &Apache::lonnet::put('nohist_'.$hash_name,
123: { $id => {
124: 'exe_uname' => $env{'user.name'},
125: 'exe_udom' => $env{'user.domain'},
126: 'exe_time' => $now,
127: 'exe_ip' => $ENV{'REMOTE_ADDR'},
128: 'delflag' => $delflag,
129: 'logentry' => $storehash,
130: 'uname' => $uname,
131: 'udom' => $udom,
132: }
133: },$cdom,$cnum);
134: }
135: }
136:
137: sub logtouch {
138: my $execdir=$perlvar{'lonDaemons'};
139: unless (-e "$execdir/logs/lonnet.log") {
140: open(my $fh,">>$execdir/logs/lonnet.log");
141: close $fh;
142: }
143: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
144: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
145: }
146:
147: sub logthis {
148: my $message=shift;
149: my $execdir=$perlvar{'lonDaemons'};
150: my $now=time;
151: my $local=localtime($now);
152: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
153: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
154: print $fh $logstring;
155: close($fh);
156: }
157: return 1;
158: }
159:
160: sub logperm {
161: my $message=shift;
162: my $execdir=$perlvar{'lonDaemons'};
163: my $now=time;
164: my $local=localtime($now);
165: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
166: print $fh "$now:$message:$local\n";
167: close($fh);
168: }
169: return 1;
170: }
171:
172: sub create_connection {
173: my ($hostname,$lonid) = @_;
174: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
175: Type => SOCK_STREAM,
176: Timeout => 10);
177: return 0 if (!$client);
178: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
179: my $result = <$client>;
180: chomp($result);
181: return 1 if ($result eq 'done');
182: return 0;
183: }
184:
185: sub get_server_timezone {
186: my ($cnum,$cdom) = @_;
187: my $home=&homeserver($cnum,$cdom);
188: if ($home ne 'no_host') {
189: my $cachetime = 24*3600;
190: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
191: if (defined($cached)) {
192: return $timezone;
193: } else {
194: my $timezone = &reply('servertimezone',$home);
195: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
196: }
197: }
198: }
199:
200: sub get_server_loncaparev {
201: my ($dom,$lonhost) = @_;
202: if (defined($lonhost)) {
203: if (!defined(&hostname($lonhost))) {
204: undef($lonhost);
205: }
206: }
207: if (!defined($lonhost)) {
208: if (defined(&domain($dom,'primary'))) {
209: $lonhost=&domain($dom,'primary');
210: if ($lonhost eq 'no_host') {
211: undef($lonhost);
212: }
213: }
214: }
215: if (defined($lonhost)) {
216: my $cachetime = 24*3600;
217: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
218: if (defined($cached)) {
219: return $loncaparev;
220: } else {
221: my $loncaparev = &reply('serverloncaparev',$lonhost);
222: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
223: }
224: }
225: }
226:
227: # -------------------------------------------------- Non-critical communication
228: sub subreply {
229: my ($cmd,$server)=@_;
230: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
231: #
232: # With loncnew process trimming, there's a timing hole between lonc server
233: # process exit and the master server picking up the listen on the AF_UNIX
234: # socket. In that time interval, a lock file will exist:
235:
236: my $lockfile=$peerfile.".lock";
237: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
238: sleep(1);
239: }
240: # At this point, either a loncnew parent is listening or an old lonc
241: # or loncnew child is listening so we can connect or everything's dead.
242: #
243: # We'll give the connection a few tries before abandoning it. If
244: # connection is not possible, we'll con_lost back to the client.
245: #
246: my $client;
247: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
248: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
249: Type => SOCK_STREAM,
250: Timeout => 10);
251: if ($client) {
252: last; # Connected!
253: } else {
254: &create_connection(&hostname($server),$server);
255: }
256: sleep(1); # Try again later if failed connection.
257: }
258: my $answer;
259: if ($client) {
260: print $client "sethost:$server:$cmd\n";
261: $answer=<$client>;
262: if (!$answer) { $answer="con_lost"; }
263: chomp($answer);
264: } else {
265: $answer = 'con_lost'; # Failed connection.
266: }
267: return $answer;
268: }
269:
270: sub reply {
271: my ($cmd,$server)=@_;
272: unless (defined(&hostname($server))) { return 'no_such_host'; }
273: my $answer=subreply($cmd,$server);
274: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
275: &logthis("<font color=\"blue\">WARNING:".
276: " $cmd to $server returned $answer</font>");
277: }
278: return $answer;
279: }
280:
281: # ----------------------------------------------------------- Send USR1 to lonc
282:
283: sub reconlonc {
284: my ($lonid) = @_;
285: my $hostname = &hostname($lonid);
286: if ($lonid) {
287: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
288: if ($hostname && -e $peerfile) {
289: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
290: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
291: Type => SOCK_STREAM,
292: Timeout => 10);
293: if ($client) {
294: print $client ("reset_retries\n");
295: my $answer=<$client>;
296: #reset just this one.
297: }
298: }
299: return;
300: }
301:
302: &logthis("Trying to reconnect lonc");
303: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
304: if (open(my $fh,"<$loncfile")) {
305: my $loncpid=<$fh>;
306: chomp($loncpid);
307: if (kill 0 => $loncpid) {
308: &logthis("lonc at pid $loncpid responding, sending USR1");
309: kill USR1 => $loncpid;
310: sleep 1;
311: } else {
312: &logthis(
313: "<font color=\"blue\">WARNING:".
314: " lonc at pid $loncpid not responding, giving up</font>");
315: }
316: } else {
317: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
318: }
319: }
320:
321: # ------------------------------------------------------ Critical communication
322:
323: sub critical {
324: my ($cmd,$server)=@_;
325: unless (&hostname($server)) {
326: &logthis("<font color=\"blue\">WARNING:".
327: " Critical message to unknown server ($server)</font>");
328: return 'no_such_host';
329: }
330: my $answer=reply($cmd,$server);
331: if ($answer eq 'con_lost') {
332: &reconlonc("$perlvar{'lonSockDir'}/$server");
333: my $answer=reply($cmd,$server);
334: if ($answer eq 'con_lost') {
335: my $now=time;
336: my $middlename=$cmd;
337: $middlename=substr($middlename,0,16);
338: $middlename=~s/\W//g;
339: my $dfilename=
340: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
341: $dumpcount++;
342: {
343: my $dfh;
344: if (open($dfh,">$dfilename")) {
345: print $dfh "$cmd\n";
346: close($dfh);
347: }
348: }
349: sleep 2;
350: my $wcmd='';
351: {
352: my $dfh;
353: if (open($dfh,"<$dfilename")) {
354: $wcmd=<$dfh>;
355: close($dfh);
356: }
357: }
358: chomp($wcmd);
359: if ($wcmd eq $cmd) {
360: &logthis("<font color=\"blue\">WARNING: ".
361: "Connection buffer $dfilename: $cmd</font>");
362: &logperm("D:$server:$cmd");
363: return 'con_delayed';
364: } else {
365: &logthis("<font color=\"red\">CRITICAL:"
366: ." Critical connection failed: $server $cmd</font>");
367: &logperm("F:$server:$cmd");
368: return 'con_failed';
369: }
370: }
371: }
372: return $answer;
373: }
374:
375: # ------------------------------------------- check if return value is an error
376:
377: sub error {
378: my ($result) = @_;
379: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
380: if ($2 == 2) { return undef; }
381: return $1;
382: }
383: return undef;
384: }
385:
386: sub convert_and_load_session_env {
387: my ($lonidsdir,$handle)=@_;
388: my @profile;
389: {
390: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
391: if (!$opened) {
392: return 0;
393: }
394: flock($idf,LOCK_SH);
395: @profile=<$idf>;
396: close($idf);
397: }
398: my %temp_env;
399: foreach my $line (@profile) {
400: if ($line !~ m/=/) {
401: return 0;
402: }
403: chomp($line);
404: my ($envname,$envvalue)=split(/=/,$line,2);
405: $temp_env{&unescape($envname)} = &unescape($envvalue);
406: }
407: unlink("$lonidsdir/$handle.id");
408: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
409: 0640)) {
410: %disk_env = %temp_env;
411: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
412: untie(%disk_env);
413: }
414: return 1;
415: }
416:
417: # ------------------------------------------- Transfer profile into environment
418: my $env_loaded;
419: sub transfer_profile_to_env {
420: my ($lonidsdir,$handle,$force_transfer) = @_;
421: if (!$force_transfer && $env_loaded) { return; }
422:
423: if (!defined($lonidsdir)) {
424: $lonidsdir = $perlvar{'lonIDsDir'};
425: }
426: if (!defined($handle)) {
427: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
428: }
429:
430: my $convert;
431: {
432: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
433: if (!$opened) {
434: return;
435: }
436: flock($idf,LOCK_SH);
437: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
438: &GDBM_READER(),0640)) {
439: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
440: untie(%disk_env);
441: } else {
442: $convert = 1;
443: }
444: }
445: if ($convert) {
446: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
447: &logthis("Failed to load session, or convert session.");
448: }
449: }
450:
451: my %remove;
452: while ( my $envname = each(%env) ) {
453: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
454: if ($time < time-300) {
455: $remove{$key}++;
456: }
457: }
458: }
459:
460: $env{'user.environment'} = "$lonidsdir/$handle.id";
461: $env_loaded=1;
462: foreach my $expired_key (keys(%remove)) {
463: &delenv($expired_key);
464: }
465: }
466:
467: # ---------------------------------------------------- Check for valid session
468: sub check_for_valid_session {
469: my ($r) = @_;
470: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
471: my $lonid=$cookies{'lonID'};
472: return undef if (!$lonid);
473:
474: my $handle=&LONCAPA::clean_handle($lonid->value);
475: my $lonidsdir=$r->dir_config('lonIDsDir');
476: return undef if (!-e "$lonidsdir/$handle.id");
477:
478: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
479: return undef if (!$opened);
480:
481: flock($idf,LOCK_SH);
482: my %disk_env;
483: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
484: &GDBM_READER(),0640)) {
485: return undef;
486: }
487:
488: if (!defined($disk_env{'user.name'})
489: || !defined($disk_env{'user.domain'})) {
490: return undef;
491: }
492: return $handle;
493: }
494:
495: sub timed_flock {
496: my ($file,$lock_type) = @_;
497: my $failed=0;
498: eval {
499: local $SIG{__DIE__}='DEFAULT';
500: local $SIG{ALRM}=sub {
501: $failed=1;
502: die("failed lock");
503: };
504: alarm(13);
505: flock($file,$lock_type);
506: alarm(0);
507: };
508: if ($failed) {
509: return undef;
510: } else {
511: return 1;
512: }
513: }
514:
515: # ---------------------------------------------------------- Append Environment
516:
517: sub appenv {
518: my ($newenv,$roles) = @_;
519: if (ref($newenv) eq 'HASH') {
520: foreach my $key (keys(%{$newenv})) {
521: my $refused = 0;
522: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
523: $refused = 1;
524: if (ref($roles) eq 'ARRAY') {
525: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
526: if (grep(/^\Q$role\E$/,@{$roles})) {
527: $refused = 0;
528: }
529: }
530: }
531: if ($refused) {
532: &logthis("<font color=\"blue\">WARNING: ".
533: "Attempt to modify environment ".$key." to ".$newenv->{$key}
534: .'</font>');
535: delete($newenv->{$key});
536: } else {
537: $env{$key}=$newenv->{$key};
538: }
539: }
540: my $opened = open(my $env_file,'+<',$env{'user.environment'});
541: if ($opened
542: && &timed_flock($env_file,LOCK_EX)
543: &&
544: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
545: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
546: while (my ($key,$value) = each(%{$newenv})) {
547: $disk_env{$key} = $value;
548: }
549: untie(%disk_env);
550: }
551: }
552: return 'ok';
553: }
554: # ----------------------------------------------------- Delete from Environment
555:
556: sub delenv {
557: my ($delthis,$regexp) = @_;
558: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
559: &logthis("<font color=\"blue\">WARNING: ".
560: "Attempt to delete from environment ".$delthis);
561: return 'error';
562: }
563: my $opened = open(my $env_file,'+<',$env{'user.environment'});
564: if ($opened
565: && &timed_flock($env_file,LOCK_EX)
566: &&
567: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
568: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
569: foreach my $key (keys(%disk_env)) {
570: if ($regexp) {
571: if ($key=~/^$delthis/) {
572: delete($env{$key});
573: delete($disk_env{$key});
574: }
575: } else {
576: if ($key=~/^\Q$delthis\E/) {
577: delete($env{$key});
578: delete($disk_env{$key});
579: }
580: }
581: }
582: untie(%disk_env);
583: }
584: return 'ok';
585: }
586:
587: sub get_env_multiple {
588: my ($name) = @_;
589: my @values;
590: if (defined($env{$name})) {
591: # exists is it an array
592: if (ref($env{$name})) {
593: @values=@{ $env{$name} };
594: } else {
595: $values[0]=$env{$name};
596: }
597: }
598: return(@values);
599: }
600:
601: # ------------------------------------------------------------------- Locking
602:
603: sub set_lock {
604: my ($text)=@_;
605: $locknum++;
606: my $id=$$.'-'.$locknum;
607: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
608: 'session.lock.'.$id => $text});
609: return $id;
610: }
611:
612: sub get_locks {
613: my $num=0;
614: my %texts=();
615: foreach my $lock (split(/\,/,$env{'session.locks'})) {
616: if ($lock=~/\w/) {
617: $num++;
618: $texts{$lock}=$env{'session.lock.'.$lock};
619: }
620: }
621: return ($num,%texts);
622: }
623:
624: sub remove_lock {
625: my ($id)=@_;
626: my $newlocks='';
627: foreach my $lock (split(/\,/,$env{'session.locks'})) {
628: if (($lock=~/\w/) && ($lock ne $id)) {
629: $newlocks.=','.$lock;
630: }
631: }
632: &appenv({'session.locks' => $newlocks});
633: &delenv('session.lock.'.$id);
634: }
635:
636: sub remove_all_locks {
637: my $activelocks=$env{'session.locks'};
638: foreach my $lock (split(/\,/,$env{'session.locks'})) {
639: if ($lock=~/\w/) {
640: &remove_lock($lock);
641: }
642: }
643: }
644:
645:
646: # ------------------------------------------ Find out current server userload
647: sub userload {
648: my $numusers=0;
649: {
650: opendir(LONIDS,$perlvar{'lonIDsDir'});
651: my $filename;
652: my $curtime=time;
653: while ($filename=readdir(LONIDS)) {
654: next if ($filename eq '.' || $filename eq '..');
655: next if ($filename =~ /publicuser_\d+\.id/);
656: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
657: if ($curtime-$mtime < 1800) { $numusers++; }
658: }
659: closedir(LONIDS);
660: }
661: my $userloadpercent=0;
662: my $maxuserload=$perlvar{'lonUserLoadLim'};
663: if ($maxuserload) {
664: $userloadpercent=100*$numusers/$maxuserload;
665: }
666: $userloadpercent=sprintf("%.2f",$userloadpercent);
667: return $userloadpercent;
668: }
669:
670: # ------------------------------------------ Fight off request when overloaded
671:
672: sub overloaderror {
673: my ($r,$checkserver)=@_;
674: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
675: my $loadavg;
676: if ($checkserver eq $perlvar{'lonHostID'}) {
677: open(my $loadfile,'/proc/loadavg');
678: $loadavg=<$loadfile>;
679: $loadavg =~ s/\s.*//g;
680: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
681: close($loadfile);
682: } else {
683: $loadavg=&reply('load',$checkserver);
684: }
685: my $overload=$loadavg-100;
686: if ($overload>0) {
687: $r->err_headers_out->{'Retry-After'}=$overload;
688: $r->log_error('Overload of '.$overload.' on '.$checkserver);
689: return 413;
690: }
691: return '';
692: }
693:
694: # ------------------------------ Find server with least workload from spare.tab
695:
696: sub spareserver {
697: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
698: my $spare_server;
699: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
700: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
701: : $userloadpercent;
702:
703: foreach my $try_server (@{ $spareid{'primary'} }) {
704: ($spare_server, $lowest_load) =
705: &compare_server_load($try_server, $spare_server, $lowest_load);
706: }
707:
708: my $found_server = ($spare_server ne '' && $lowest_load < 100);
709:
710: if (!$found_server) {
711: foreach my $try_server (@{ $spareid{'default'} }) {
712: ($spare_server, $lowest_load) =
713: &compare_server_load($try_server, $spare_server, $lowest_load);
714: }
715: }
716:
717: if (!$want_server_name) {
718: my $protocol = 'http';
719: if ($protocol{$spare_server} eq 'https') {
720: $protocol = $protocol{$spare_server};
721: }
722: if (defined($spare_server)) {
723: my $hostname = &hostname($spare_server);
724: if (defined($hostname)) {
725: $spare_server = $protocol.'://'.$hostname;
726: }
727: }
728: }
729: return $spare_server;
730: }
731:
732: sub compare_server_load {
733: my ($try_server, $spare_server, $lowest_load) = @_;
734:
735: my $loadans = &reply('load', $try_server);
736: my $userloadans = &reply('userload',$try_server);
737:
738: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
739: next; #didn't get a number from the server
740: }
741:
742: my $load;
743: if ($loadans =~ /\d/) {
744: if ($userloadans =~ /\d/) {
745: #both are numbers, pick the bigger one
746: $load = ($loadans > $userloadans) ? $loadans
747: : $userloadans;
748: } else {
749: $load = $loadans;
750: }
751: } else {
752: $load = $userloadans;
753: }
754:
755: if (($load =~ /\d/) && ($load < $lowest_load)) {
756: $spare_server = $try_server;
757: $lowest_load = $load;
758: }
759: return ($spare_server,$lowest_load);
760: }
761:
762: # --------------------------- ask offload servers if user already has a session
763: sub find_existing_session {
764: my ($udom,$uname) = @_;
765: foreach my $try_server (@{ $spareid{'primary'} },
766: @{ $spareid{'default'} }) {
767: return $try_server if (&has_user_session($try_server, $udom, $uname));
768: }
769: return;
770: }
771:
772: # -------------------------------- ask if server already has a session for user
773: sub has_user_session {
774: my ($lonid,$udom,$uname) = @_;
775: my $result = &reply(join(':','userhassession',
776: map {&escape($_)} ($udom,$uname)),$lonid);
777: return 1 if ($result eq 'ok');
778:
779: return 0;
780: }
781:
782: # --------------------------------------------- Try to change a user's password
783:
784: sub changepass {
785: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
786: $currentpass = &escape($currentpass);
787: $newpass = &escape($newpass);
788: my $lonhost = $perlvar{'lonHostID'};
789: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
790: $server);
791: if (! $answer) {
792: &logthis("No reply on password change request to $server ".
793: "by $uname in domain $udom.");
794: } elsif ($answer =~ "^ok") {
795: &logthis("$uname in $udom successfully changed their password ".
796: "on $server.");
797: } elsif ($answer =~ "^pwchange_failure") {
798: &logthis("$uname in $udom was unable to change their password ".
799: "on $server. The action was blocked by either lcpasswd ".
800: "or pwchange");
801: } elsif ($answer =~ "^non_authorized") {
802: &logthis("$uname in $udom did not get their password correct when ".
803: "attempting to change it on $server.");
804: } elsif ($answer =~ "^auth_mode_error") {
805: &logthis("$uname in $udom attempted to change their password despite ".
806: "not being locally or internally authenticated on $server.");
807: } elsif ($answer =~ "^unknown_user") {
808: &logthis("$uname in $udom attempted to change their password ".
809: "on $server but were unable to because $server is not ".
810: "their home server.");
811: } elsif ($answer =~ "^refused") {
812: &logthis("$server refused to change $uname in $udom password because ".
813: "it was sent an unencrypted request to change the password.");
814: } elsif ($answer =~ "invalid_client") {
815: &logthis("$server refused to change $uname in $udom password because ".
816: "it was a reset by e-mail originating from an invalid server.");
817: }
818: return $answer;
819: }
820:
821: # ----------------------- Try to determine user's current authentication scheme
822:
823: sub queryauthenticate {
824: my ($uname,$udom)=@_;
825: my $uhome=&homeserver($uname,$udom);
826: if (!$uhome) {
827: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
828: return 'no_host';
829: }
830: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
831: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
832: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
833: }
834: return $answer;
835: }
836:
837: # --------- Try to authenticate user from domain's lib servers (first this one)
838:
839: sub authenticate {
840: my ($uname,$upass,$udom,$checkdefauth)=@_;
841: $upass=&escape($upass);
842: $uname= &LONCAPA::clean_username($uname);
843: my $uhome=&homeserver($uname,$udom,1);
844: my $newhome;
845: if ((!$uhome) || ($uhome eq 'no_host')) {
846: # Maybe the machine was offline and only re-appeared again recently?
847: &reconlonc();
848: # One more
849: $uhome=&homeserver($uname,$udom,1);
850: if (($uhome eq 'no_host') && $checkdefauth) {
851: if (defined(&domain($udom,'primary'))) {
852: $newhome=&domain($udom,'primary');
853: }
854: if ($newhome ne '') {
855: $uhome = $newhome;
856: }
857: }
858: if ((!$uhome) || ($uhome eq 'no_host')) {
859: &logthis("User $uname at $udom is unknown in authenticate");
860: return 'no_host';
861: }
862: }
863: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
864: if ($answer eq 'authorized') {
865: if ($newhome) {
866: &logthis("User $uname at $udom authorized by $uhome, but needs account");
867: return 'no_account_on_host';
868: } else {
869: &logthis("User $uname at $udom authorized by $uhome");
870: return $uhome;
871: }
872: }
873: if ($answer eq 'non_authorized') {
874: &logthis("User $uname at $udom rejected by $uhome");
875: return 'no_host';
876: }
877: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
878: return 'no_host';
879: }
880:
881: # ---------------------- Find the homebase for a user from domain's lib servers
882:
883: my %homecache;
884: sub homeserver {
885: my ($uname,$udom,$ignoreBadCache)=@_;
886: my $index="$uname:$udom";
887:
888: if (exists($homecache{$index})) { return $homecache{$index}; }
889:
890: my %servers = &get_servers($udom,'library');
891: foreach my $tryserver (keys(%servers)) {
892: next if ($ignoreBadCache ne 'true' &&
893: exists($badServerCache{$tryserver}));
894:
895: my $answer=reply("home:$udom:$uname",$tryserver);
896: if ($answer eq 'found') {
897: delete($badServerCache{$tryserver});
898: return $homecache{$index}=$tryserver;
899: } elsif ($answer eq 'no_host') {
900: $badServerCache{$tryserver}=1;
901: }
902: }
903: return 'no_host';
904: }
905:
906: # ------------------------------------- Find the usernames behind a list of IDs
907:
908: sub idget {
909: my ($udom,@ids)=@_;
910: my %returnhash=();
911:
912: my %servers = &get_servers($udom,'library');
913: foreach my $tryserver (keys(%servers)) {
914: my $idlist=join('&',@ids);
915: $idlist=~tr/A-Z/a-z/;
916: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
917: my @answer=();
918: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
919: @answer=split(/\&/,$reply);
920: } ;
921: my $i;
922: for ($i=0;$i<=$#ids;$i++) {
923: if ($answer[$i]) {
924: $returnhash{$ids[$i]}=$answer[$i];
925: }
926: }
927: }
928: return %returnhash;
929: }
930:
931: # ------------------------------------- Find the IDs behind a list of usernames
932:
933: sub idrget {
934: my ($udom,@unames)=@_;
935: my %returnhash=();
936: foreach my $uname (@unames) {
937: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
938: }
939: return %returnhash;
940: }
941:
942: # ------------------------------- Store away a list of names and associated IDs
943:
944: sub idput {
945: my ($udom,%ids)=@_;
946: my %servers=();
947: foreach my $uname (keys(%ids)) {
948: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
949: my $uhom=&homeserver($uname,$udom);
950: if ($uhom ne 'no_host') {
951: my $id=&escape($ids{$uname});
952: $id=~tr/A-Z/a-z/;
953: my $esc_unam=&escape($uname);
954: if ($servers{$uhom}) {
955: $servers{$uhom}.='&'.$id.'='.$esc_unam;
956: } else {
957: $servers{$uhom}=$id.'='.$esc_unam;
958: }
959: }
960: }
961: foreach my $server (keys(%servers)) {
962: &critical('idput:'.$udom.':'.$servers{$server},$server);
963: }
964: }
965:
966: # ------------------------------dump from db file owned by domainconfig user
967: sub dump_dom {
968: my ($namespace,$udom,$regexp,$range)=@_;
969: if (!$udom) {
970: $udom=$env{'user.domain'};
971: }
972: my %returnhash;
973: if ($udom) {
974: my $uname = &get_domainconfiguser($udom);
975: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
976: }
977: return %returnhash;
978: }
979:
980: # ------------------------------------------ get items from domain db files
981:
982: sub get_dom {
983: my ($namespace,$storearr,$udom,$uhome)=@_;
984: my $items='';
985: foreach my $item (@$storearr) {
986: $items.=&escape($item).'&';
987: }
988: $items=~s/\&$//;
989: if (!$udom) {
990: $udom=$env{'user.domain'};
991: if (defined(&domain($udom,'primary'))) {
992: $uhome=&domain($udom,'primary');
993: } else {
994: undef($uhome);
995: }
996: } else {
997: if (!$uhome) {
998: if (defined(&domain($udom,'primary'))) {
999: $uhome=&domain($udom,'primary');
1000: }
1001: }
1002: }
1003: if ($udom && $uhome && ($uhome ne 'no_host')) {
1004: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1005: my %returnhash;
1006: if ($rep eq '' || $rep =~ /^error: 2 /) {
1007: return %returnhash;
1008: }
1009: my @pairs=split(/\&/,$rep);
1010: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1011: return @pairs;
1012: }
1013: my $i=0;
1014: foreach my $item (@$storearr) {
1015: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1016: $i++;
1017: }
1018: return %returnhash;
1019: } else {
1020: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1021: }
1022: }
1023:
1024: # -------------------------------------------- put items in domain db files
1025:
1026: sub put_dom {
1027: my ($namespace,$storehash,$udom,$uhome)=@_;
1028: if (!$udom) {
1029: $udom=$env{'user.domain'};
1030: if (defined(&domain($udom,'primary'))) {
1031: $uhome=&domain($udom,'primary');
1032: } else {
1033: undef($uhome);
1034: }
1035: } else {
1036: if (!$uhome) {
1037: if (defined(&domain($udom,'primary'))) {
1038: $uhome=&domain($udom,'primary');
1039: }
1040: }
1041: }
1042: if ($udom && $uhome && ($uhome ne 'no_host')) {
1043: my $items='';
1044: foreach my $item (keys(%$storehash)) {
1045: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1046: }
1047: $items=~s/\&$//;
1048: return &reply("putdom:$udom:$namespace:$items",$uhome);
1049: } else {
1050: &logthis("put_dom failed - no homeserver and/or domain");
1051: }
1052: }
1053:
1054: # --------------------- newput for items in db file owned by domainconfig user
1055: sub newput_dom {
1056: my ($namespace,$storehash,$udom) = @_;
1057: my $result;
1058: if (!$udom) {
1059: $udom=$env{'user.domain'};
1060: }
1061: if ($udom) {
1062: my $uname = &get_domainconfiguser($udom);
1063: $result = &newput($namespace,$storehash,$udom,$uname);
1064: }
1065: return $result;
1066: }
1067:
1068: # --------------------- delete for items in db file owned by domainconfig user
1069: sub del_dom {
1070: my ($namespace,$storearr,$udom)=@_;
1071: if (ref($storearr) eq 'ARRAY') {
1072: if (!$udom) {
1073: $udom=$env{'user.domain'};
1074: }
1075: if ($udom) {
1076: my $uname = &get_domainconfiguser($udom);
1077: return &del($namespace,$storearr,$udom,$uname);
1078: }
1079: }
1080: }
1081:
1082: # ----------------------------------construct domainconfig user for a domain
1083: sub get_domainconfiguser {
1084: my ($udom) = @_;
1085: return $udom.'-domainconfig';
1086: }
1087:
1088: sub retrieve_inst_usertypes {
1089: my ($udom) = @_;
1090: my (%returnhash,@order);
1091: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1092: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1093: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1094: %returnhash = %{$domdefs{'inststatustypes'}};
1095: @order = @{$domdefs{'inststatusorder'}};
1096: } else {
1097: if (defined(&domain($udom,'primary'))) {
1098: my $uhome=&domain($udom,'primary');
1099: my $rep=&reply("inst_usertypes:$udom",$uhome);
1100: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1101: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1102: return (\%returnhash,\@order);
1103: }
1104: my ($hashitems,$orderitems) = split(/:/,$rep);
1105: my @pairs=split(/\&/,$hashitems);
1106: foreach my $item (@pairs) {
1107: my ($key,$value)=split(/=/,$item,2);
1108: $key = &unescape($key);
1109: next if ($key =~ /^error: 2 /);
1110: $returnhash{$key}=&thaw_unescape($value);
1111: }
1112: my @esc_order = split(/\&/,$orderitems);
1113: foreach my $item (@esc_order) {
1114: push(@order,&unescape($item));
1115: }
1116: } else {
1117: &logthis("get_dom failed - no primary domain server for $udom");
1118: }
1119: }
1120: return (\%returnhash,\@order);
1121: }
1122:
1123: sub is_domainimage {
1124: my ($url) = @_;
1125: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1126: if (&domain($1) ne '') {
1127: return '1';
1128: }
1129: }
1130: return;
1131: }
1132:
1133: sub inst_directory_query {
1134: my ($srch) = @_;
1135: my $udom = $srch->{'srchdomain'};
1136: my %results;
1137: my $homeserver = &domain($udom,'primary');
1138: my $outcome;
1139: if ($homeserver ne '') {
1140: my $queryid=&reply("querysend:instdirsearch:".
1141: &escape($srch->{'srchby'}).':'.
1142: &escape($srch->{'srchterm'}).':'.
1143: &escape($srch->{'srchtype'}),$homeserver);
1144: my $host=&hostname($homeserver);
1145: if ($queryid !~/^\Q$host\E\_/) {
1146: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1147: return;
1148: }
1149: my $response = &get_query_reply($queryid);
1150: my $maxtries = 5;
1151: my $tries = 1;
1152: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1153: $response = &get_query_reply($queryid);
1154: $tries ++;
1155: }
1156:
1157: if (!&error($response) && $response ne 'refused') {
1158: if ($response eq 'unavailable') {
1159: $outcome = $response;
1160: } else {
1161: $outcome = 'ok';
1162: my @matches = split(/\n/,$response);
1163: foreach my $match (@matches) {
1164: my ($key,$value) = split(/=/,$match);
1165: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1166: }
1167: }
1168: }
1169: }
1170: return ($outcome,%results);
1171: }
1172:
1173: sub usersearch {
1174: my ($srch) = @_;
1175: my $dom = $srch->{'srchdomain'};
1176: my %results;
1177: my %libserv = &all_library();
1178: my $query = 'usersearch';
1179: foreach my $tryserver (keys(%libserv)) {
1180: if (&host_domain($tryserver) eq $dom) {
1181: my $host=&hostname($tryserver);
1182: my $queryid=
1183: &reply("querysend:".&escape($query).':'.
1184: &escape($srch->{'srchby'}).':'.
1185: &escape($srch->{'srchtype'}).':'.
1186: &escape($srch->{'srchterm'}),$tryserver);
1187: if ($queryid !~/^\Q$host\E\_/) {
1188: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1189: next;
1190: }
1191: my $reply = &get_query_reply($queryid);
1192: my $maxtries = 1;
1193: my $tries = 1;
1194: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1195: $reply = &get_query_reply($queryid);
1196: $tries ++;
1197: }
1198: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1199: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1200: } else {
1201: my @matches;
1202: if ($reply =~ /\n/) {
1203: @matches = split(/\n/,$reply);
1204: } else {
1205: @matches = split(/\&/,$reply);
1206: }
1207: foreach my $match (@matches) {
1208: my ($uname,$udom,%userhash);
1209: foreach my $entry (split(/:/,$match)) {
1210: my ($key,$value) =
1211: map {&unescape($_);} split(/=/,$entry);
1212: $userhash{$key} = $value;
1213: if ($key eq 'username') {
1214: $uname = $value;
1215: } elsif ($key eq 'domain') {
1216: $udom = $value;
1217: }
1218: }
1219: $results{$uname.':'.$udom} = \%userhash;
1220: }
1221: }
1222: }
1223: }
1224: return %results;
1225: }
1226:
1227: sub get_instuser {
1228: my ($udom,$uname,$id) = @_;
1229: my $homeserver = &domain($udom,'primary');
1230: my ($outcome,%results);
1231: if ($homeserver ne '') {
1232: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1233: &escape($id).':'.&escape($udom),$homeserver);
1234: my $host=&hostname($homeserver);
1235: if ($queryid !~/^\Q$host\E\_/) {
1236: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1237: return;
1238: }
1239: my $response = &get_query_reply($queryid);
1240: my $maxtries = 5;
1241: my $tries = 1;
1242: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1243: $response = &get_query_reply($queryid);
1244: $tries ++;
1245: }
1246: if (!&error($response) && $response ne 'refused') {
1247: if ($response eq 'unavailable') {
1248: $outcome = $response;
1249: } else {
1250: $outcome = 'ok';
1251: my @matches = split(/\n/,$response);
1252: foreach my $match (@matches) {
1253: my ($key,$value) = split(/=/,$match);
1254: $results{&unescape($key)} = &thaw_unescape($value);
1255: }
1256: }
1257: }
1258: }
1259: my %userinfo;
1260: if (ref($results{$uname}) eq 'HASH') {
1261: %userinfo = %{$results{$uname}};
1262: }
1263: return ($outcome,%userinfo);
1264: }
1265:
1266: sub inst_rulecheck {
1267: my ($udom,$uname,$id,$item,$rules) = @_;
1268: my %returnhash;
1269: if ($udom ne '') {
1270: if (ref($rules) eq 'ARRAY') {
1271: @{$rules} = map {&escape($_);} (@{$rules});
1272: my $rulestr = join(':',@{$rules});
1273: my $homeserver=&domain($udom,'primary');
1274: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1275: my $response;
1276: if ($item eq 'username') {
1277: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1278: ':'.&escape($uname).':'.$rulestr,
1279: $homeserver));
1280: } elsif ($item eq 'id') {
1281: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1282: ':'.&escape($id).':'.$rulestr,
1283: $homeserver));
1284: } elsif ($item eq 'selfcreate') {
1285: $response=&unescape(&reply('instselfcreatecheck:'.
1286: &escape($udom).':'.&escape($uname).
1287: ':'.$rulestr,$homeserver));
1288: }
1289: if ($response ne 'refused') {
1290: my @pairs=split(/\&/,$response);
1291: foreach my $item (@pairs) {
1292: my ($key,$value)=split(/=/,$item,2);
1293: $key = &unescape($key);
1294: next if ($key =~ /^error: 2 /);
1295: $returnhash{$key}=&thaw_unescape($value);
1296: }
1297: }
1298: }
1299: }
1300: }
1301: return %returnhash;
1302: }
1303:
1304: sub inst_userrules {
1305: my ($udom,$check) = @_;
1306: my (%ruleshash,@ruleorder);
1307: if ($udom ne '') {
1308: my $homeserver=&domain($udom,'primary');
1309: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1310: my $response;
1311: if ($check eq 'id') {
1312: $response=&reply('instidrules:'.&escape($udom),
1313: $homeserver);
1314: } elsif ($check eq 'email') {
1315: $response=&reply('instemailrules:'.&escape($udom),
1316: $homeserver);
1317: } else {
1318: $response=&reply('instuserrules:'.&escape($udom),
1319: $homeserver);
1320: }
1321: if (($response ne 'refused') && ($response ne 'error') &&
1322: ($response ne 'unknown_cmd') &&
1323: ($response ne 'no_such_host')) {
1324: my ($hashitems,$orderitems) = split(/:/,$response);
1325: my @pairs=split(/\&/,$hashitems);
1326: foreach my $item (@pairs) {
1327: my ($key,$value)=split(/=/,$item,2);
1328: $key = &unescape($key);
1329: next if ($key =~ /^error: 2 /);
1330: $ruleshash{$key}=&thaw_unescape($value);
1331: }
1332: my @esc_order = split(/\&/,$orderitems);
1333: foreach my $item (@esc_order) {
1334: push(@ruleorder,&unescape($item));
1335: }
1336: }
1337: }
1338: }
1339: return (\%ruleshash,\@ruleorder);
1340: }
1341:
1342: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1343:
1344: sub get_domain_defaults {
1345: my ($domain) = @_;
1346: my $cachetime = 60*60*24;
1347: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1348: if (defined($cached)) {
1349: if (ref($result) eq 'HASH') {
1350: return %{$result};
1351: }
1352: }
1353: my %domdefaults;
1354: my %domconfig =
1355: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1356: 'requestcourses','inststatus'],$domain);
1357: if (ref($domconfig{'defaults'}) eq 'HASH') {
1358: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1359: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1360: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1361: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1362: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1363: } else {
1364: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1365: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1366: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1367: }
1368: if (ref($domconfig{'quotas'}) eq 'HASH') {
1369: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1370: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1371: } else {
1372: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1373: }
1374: my @usertools = ('aboutme','blog','portfolio');
1375: foreach my $item (@usertools) {
1376: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1377: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1378: }
1379: }
1380: }
1381: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1382: foreach my $item ('official','unofficial','community') {
1383: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1384: }
1385: }
1386: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1387: foreach my $item ('inststatustypes','inststatusorder') {
1388: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1389: }
1390: }
1391: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1392: $cachetime);
1393: return %domdefaults;
1394: }
1395:
1396: # --------------------------------------------------- Assign a key to a student
1397:
1398: sub assign_access_key {
1399: #
1400: # a valid key looks like uname:udom#comments
1401: # comments are being appended
1402: #
1403: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1404: $kdom=
1405: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1406: $knum=
1407: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1408: $cdom=
1409: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1410: $cnum=
1411: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1412: $udom=$env{'user.name'} unless (defined($udom));
1413: $uname=$env{'user.domain'} unless (defined($uname));
1414: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1415: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1416: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1417: # assigned to this person
1418: # - this should not happen,
1419: # unless something went wrong
1420: # the first time around
1421: # ready to assign
1422: $logentry=$1.'; '.$logentry;
1423: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1424: $kdom,$knum) eq 'ok') {
1425: # key now belongs to user
1426: my $envkey='key.'.$cdom.'_'.$cnum;
1427: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1428: &appenv({'environment.'.$envkey => $ckey});
1429: return 'ok';
1430: } else {
1431: return
1432: 'error: Count not permanently assign key, will need to be re-entered later.';
1433: }
1434: } else {
1435: return 'error: Could not assign key, try again later.';
1436: }
1437: } elsif (!$existing{$ckey}) {
1438: # the key does not exist
1439: return 'error: The key does not exist';
1440: } else {
1441: # the key is somebody else's
1442: return 'error: The key is already in use';
1443: }
1444: }
1445:
1446: # ------------------------------------------ put an additional comment on a key
1447:
1448: sub comment_access_key {
1449: #
1450: # a valid key looks like uname:udom#comments
1451: # comments are being appended
1452: #
1453: my ($ckey,$cdom,$cnum,$logentry)=@_;
1454: $cdom=
1455: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1456: $cnum=
1457: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1458: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1459: if ($existing{$ckey}) {
1460: $existing{$ckey}.='; '.$logentry;
1461: # ready to assign
1462: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1463: $cdom,$cnum) eq 'ok') {
1464: return 'ok';
1465: } else {
1466: return 'error: Count not store comment.';
1467: }
1468: } else {
1469: # the key does not exist
1470: return 'error: The key does not exist';
1471: }
1472: }
1473:
1474: # ------------------------------------------------------ Generate a set of keys
1475:
1476: sub generate_access_keys {
1477: my ($number,$cdom,$cnum,$logentry)=@_;
1478: $cdom=
1479: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1480: $cnum=
1481: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1482: unless (&allowed('mky',$cdom)) { return 0; }
1483: unless (($cdom) && ($cnum)) { return 0; }
1484: if ($number>10000) { return 0; }
1485: sleep(2); # make sure don't get same seed twice
1486: srand(time()^($$+($$<<15))); # from "Programming Perl"
1487: my $total=0;
1488: for (my $i=1;$i<=$number;$i++) {
1489: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1490: sprintf("%lx",int(100000*rand)).'-'.
1491: sprintf("%lx",int(100000*rand));
1492: $newkey=~s/1/g/g; # folks mix up 1 and l
1493: $newkey=~s/0/h/g; # and also 0 and O
1494: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1495: if ($existing{$newkey}) {
1496: $i--;
1497: } else {
1498: if (&put('accesskeys',
1499: { $newkey => '# generated '.localtime().
1500: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1501: '; '.$logentry },
1502: $cdom,$cnum) eq 'ok') {
1503: $total++;
1504: }
1505: }
1506: }
1507: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1508: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1509: return $total;
1510: }
1511:
1512: # ------------------------------------------------------- Validate an accesskey
1513:
1514: sub validate_access_key {
1515: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1516: $cdom=
1517: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1518: $cnum=
1519: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1520: $udom=$env{'user.domain'} unless (defined($udom));
1521: $uname=$env{'user.name'} unless (defined($uname));
1522: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1523: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1524: }
1525:
1526: # ------------------------------------- Find the section of student in a course
1527: sub devalidate_getsection_cache {
1528: my ($udom,$unam,$courseid)=@_;
1529: my $hashid="$udom:$unam:$courseid";
1530: &devalidate_cache_new('getsection',$hashid);
1531: }
1532:
1533: sub courseid_to_courseurl {
1534: my ($courseid) = @_;
1535: #already url style courseid
1536: return $courseid if ($courseid =~ m{^/});
1537:
1538: if (exists($env{'course.'.$courseid.'.num'})) {
1539: my $cnum = $env{'course.'.$courseid.'.num'};
1540: my $cdom = $env{'course.'.$courseid.'.domain'};
1541: return "/$cdom/$cnum";
1542: }
1543:
1544: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1545: if (exists($courseinfo{'num'})) {
1546: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1547: }
1548:
1549: return undef;
1550: }
1551:
1552: sub getsection {
1553: my ($udom,$unam,$courseid)=@_;
1554: my $cachetime=1800;
1555:
1556: my $hashid="$udom:$unam:$courseid";
1557: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1558: if (defined($cached)) { return $result; }
1559:
1560: my %Pending;
1561: my %Expired;
1562: #
1563: # Each role can either have not started yet (pending), be active,
1564: # or have expired.
1565: #
1566: # If there is an active role, we are done.
1567: #
1568: # If there is more than one role which has not started yet,
1569: # choose the one which will start sooner
1570: # If there is one role which has not started yet, return it.
1571: #
1572: # If there is more than one expired role, choose the one which ended last.
1573: # If there is a role which has expired, return it.
1574: #
1575: $courseid = &courseid_to_courseurl($courseid);
1576: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1577: foreach my $key (keys(%roleshash)) {
1578: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1579: my $section=$1;
1580: if ($key eq $courseid.'_st') { $section=''; }
1581: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1582: my $now=time;
1583: if (defined($end) && $end && ($now > $end)) {
1584: $Expired{$end}=$section;
1585: next;
1586: }
1587: if (defined($start) && $start && ($now < $start)) {
1588: $Pending{$start}=$section;
1589: next;
1590: }
1591: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1592: }
1593: #
1594: # Presumedly there will be few matching roles from the above
1595: # loop and the sorting time will be negligible.
1596: if (scalar(keys(%Pending))) {
1597: my ($time) = sort {$a <=> $b} keys(%Pending);
1598: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1599: }
1600: if (scalar(keys(%Expired))) {
1601: my @sorted = sort {$a <=> $b} keys(%Expired);
1602: my $time = pop(@sorted);
1603: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1604: }
1605: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1606: }
1607:
1608: sub save_cache {
1609: &purge_remembered();
1610: #&Apache::loncommon::validate_page();
1611: undef(%env);
1612: undef($env_loaded);
1613: }
1614:
1615: my $to_remember=-1;
1616: my %remembered;
1617: my %accessed;
1618: my $kicks=0;
1619: my $hits=0;
1620: sub make_key {
1621: my ($name,$id) = @_;
1622: if (length($id) > 65
1623: && length(&escape($id)) > 200) {
1624: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1625: }
1626: return &escape($name.':'.$id);
1627: }
1628:
1629: sub devalidate_cache_new {
1630: my ($name,$id,$debug) = @_;
1631: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1632: $id=&make_key($name,$id);
1633: $memcache->delete($id);
1634: delete($remembered{$id});
1635: delete($accessed{$id});
1636: }
1637:
1638: sub is_cached_new {
1639: my ($name,$id,$debug) = @_;
1640: $id=&make_key($name,$id);
1641: if (exists($remembered{$id})) {
1642: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1643: $accessed{$id}=[&gettimeofday()];
1644: $hits++;
1645: return ($remembered{$id},1);
1646: }
1647: my $value = $memcache->get($id);
1648: if (!(defined($value))) {
1649: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1650: return (undef,undef);
1651: }
1652: if ($value eq '__undef__') {
1653: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1654: $value=undef;
1655: }
1656: &make_room($id,$value,$debug);
1657: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1658: return ($value,1);
1659: }
1660:
1661: sub do_cache_new {
1662: my ($name,$id,$value,$time,$debug) = @_;
1663: $id=&make_key($name,$id);
1664: my $setvalue=$value;
1665: if (!defined($setvalue)) {
1666: $setvalue='__undef__';
1667: }
1668: if (!defined($time) ) {
1669: $time=600;
1670: }
1671: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1672: my $result = $memcache->set($id,$setvalue,$time);
1673: if (! $result) {
1674: &logthis("caching of id -> $id failed");
1675: $memcache->disconnect_all();
1676: }
1677: # need to make a copy of $value
1678: &make_room($id,$value,$debug);
1679: return $value;
1680: }
1681:
1682: sub make_room {
1683: my ($id,$value,$debug)=@_;
1684:
1685: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1686: : $value;
1687: if ($to_remember<0) { return; }
1688: $accessed{$id}=[&gettimeofday()];
1689: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1690: my $to_kick;
1691: my $max_time=0;
1692: foreach my $other (keys(%accessed)) {
1693: if (&tv_interval($accessed{$other}) > $max_time) {
1694: $to_kick=$other;
1695: $max_time=&tv_interval($accessed{$other});
1696: }
1697: }
1698: delete($remembered{$to_kick});
1699: delete($accessed{$to_kick});
1700: $kicks++;
1701: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1702: return;
1703: }
1704:
1705: sub purge_remembered {
1706: #&logthis("Tossing ".scalar(keys(%remembered)));
1707: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1708: undef(%remembered);
1709: undef(%accessed);
1710: }
1711: # ------------------------------------- Read an entry from a user's environment
1712:
1713: sub userenvironment {
1714: my ($udom,$unam,@what)=@_;
1715: my $items;
1716: foreach my $item (@what) {
1717: $items.=&escape($item).'&';
1718: }
1719: $items=~s/\&$//;
1720: my %returnhash=();
1721: my $uhome = &homeserver($unam,$udom);
1722: unless ($uhome eq 'no_host') {
1723: my @answer=split(/\&/,
1724: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1725: my $i;
1726: for ($i=0;$i<=$#what;$i++) {
1727: $returnhash{$what[$i]}=&unescape($answer[$i]);
1728: }
1729: }
1730: return %returnhash;
1731: }
1732:
1733: # ---------------------------------------------------------- Get a studentphoto
1734: sub studentphoto {
1735: my ($udom,$unam,$ext) = @_;
1736: my $home=&Apache::lonnet::homeserver($unam,$udom);
1737: if (defined($env{'request.course.id'})) {
1738: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1739: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1740: return(&retrievestudentphoto($udom,$unam,$ext));
1741: } else {
1742: my ($result,$perm_reqd)=
1743: &Apache::lonnet::auto_photo_permission($unam,$udom);
1744: if ($result eq 'ok') {
1745: if (!($perm_reqd eq 'yes')) {
1746: return(&retrievestudentphoto($udom,$unam,$ext));
1747: }
1748: }
1749: }
1750: }
1751: } else {
1752: my ($result,$perm_reqd) =
1753: &Apache::lonnet::auto_photo_permission($unam,$udom);
1754: if ($result eq 'ok') {
1755: if (!($perm_reqd eq 'yes')) {
1756: return(&retrievestudentphoto($udom,$unam,$ext));
1757: }
1758: }
1759: }
1760: return '/adm/lonKaputt/lonlogo_broken.gif';
1761: }
1762:
1763: sub retrievestudentphoto {
1764: my ($udom,$unam,$ext,$type) = @_;
1765: my $home=&Apache::lonnet::homeserver($unam,$udom);
1766: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1767: if ($ret eq 'ok') {
1768: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1769: if ($type eq 'thumbnail') {
1770: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1771: }
1772: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1773: return $tokenurl;
1774: } else {
1775: if ($type eq 'thumbnail') {
1776: return '/adm/lonKaputt/genericstudent_tn.gif';
1777: } else {
1778: return '/adm/lonKaputt/lonlogo_broken.gif';
1779: }
1780: }
1781: }
1782:
1783: # -------------------------------------------------------------------- New chat
1784:
1785: sub chatsend {
1786: my ($newentry,$anon,$group)=@_;
1787: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1788: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1789: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1790: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1791: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1792: &escape($newentry)).':'.$group,$chome);
1793: }
1794:
1795: # ------------------------------------------ Find current version of a resource
1796:
1797: sub getversion {
1798: my $fname=&clutter(shift);
1799: unless ($fname=~/^\/res\//) { return -1; }
1800: return ¤tversion(&filelocation('',$fname));
1801: }
1802:
1803: sub currentversion {
1804: my $fname=shift;
1805: my ($result,$cached)=&is_cached_new('resversion',$fname);
1806: if (defined($cached)) { return $result; }
1807: my $author=$fname;
1808: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1809: my ($udom,$uname)=split(/\//,$author);
1810: my $home=homeserver($uname,$udom);
1811: if ($home eq 'no_host') {
1812: return -1;
1813: }
1814: my $answer=reply("currentversion:$fname",$home);
1815: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1816: return -1;
1817: }
1818: return &do_cache_new('resversion',$fname,$answer,600);
1819: }
1820:
1821: # ----------------------------- Subscribe to a resource, return URL if possible
1822:
1823: sub subscribe {
1824: my $fname=shift;
1825: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1826: $fname=~s/[\n\r]//g;
1827: my $author=$fname;
1828: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1829: my ($udom,$uname)=split(/\//,$author);
1830: my $home=homeserver($uname,$udom);
1831: if ($home eq 'no_host') {
1832: return 'not_found';
1833: }
1834: my $answer=reply("sub:$fname",$home);
1835: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1836: $answer.=' by '.$home;
1837: }
1838: return $answer;
1839: }
1840:
1841: # -------------------------------------------------------------- Replicate file
1842:
1843: sub repcopy {
1844: my $filename=shift;
1845: $filename=~s/\/+/\//g;
1846: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1847: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1848: if ($filename=~m|^/home/httpd/html/userfiles/| or
1849: $filename=~m -^/*(uploaded|editupload)/-) {
1850: return &repcopy_userfile($filename);
1851: }
1852: $filename=~s/[\n\r]//g;
1853: my $transname="$filename.in.transfer";
1854: # FIXME: this should flock
1855: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1856: my $remoteurl=subscribe($filename);
1857: if ($remoteurl =~ /^con_lost by/) {
1858: &logthis("Subscribe returned $remoteurl: $filename");
1859: return 'unavailable';
1860: } elsif ($remoteurl eq 'not_found') {
1861: #&logthis("Subscribe returned not_found: $filename");
1862: return 'not_found';
1863: } elsif ($remoteurl =~ /^rejected by/) {
1864: &logthis("Subscribe returned $remoteurl: $filename");
1865: return 'forbidden';
1866: } elsif ($remoteurl eq 'directory') {
1867: return 'ok';
1868: } else {
1869: my $author=$filename;
1870: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1871: my ($udom,$uname)=split(/\//,$author);
1872: my $home=homeserver($uname,$udom);
1873: unless ($home eq $perlvar{'lonHostID'}) {
1874: my @parts=split(/\//,$filename);
1875: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1876: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1877: &logthis("Malconfiguration for replication: $filename");
1878: return 'bad_request';
1879: }
1880: my $count;
1881: for ($count=5;$count<$#parts;$count++) {
1882: $path.="/$parts[$count]";
1883: if ((-e $path)!=1) {
1884: mkdir($path,0777);
1885: }
1886: }
1887: my $ua=new LWP::UserAgent;
1888: my $request=new HTTP::Request('GET',"$remoteurl");
1889: my $response=$ua->request($request,$transname);
1890: if ($response->is_error()) {
1891: unlink($transname);
1892: my $message=$response->status_line;
1893: &logthis("<font color=\"blue\">WARNING:"
1894: ." LWP get: $message: $filename</font>");
1895: return 'unavailable';
1896: } else {
1897: if ($remoteurl!~/\.meta$/) {
1898: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1899: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1900: if ($mresponse->is_error()) {
1901: unlink($filename.'.meta');
1902: &logthis(
1903: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1904: }
1905: }
1906: rename($transname,$filename);
1907: return 'ok';
1908: }
1909: }
1910: }
1911: }
1912:
1913: # ------------------------------------------------ Get server side include body
1914: sub ssi_body {
1915: my ($filelink,%form)=@_;
1916: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1917: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1918: }
1919: my $output='';
1920: my $response;
1921: if ($filelink=~/^https?\:/) {
1922: ($output,$response)=&externalssi($filelink);
1923: } else {
1924: $filelink .= $filelink=~/\?/ ? '&' : '?';
1925: $filelink .= 'inhibitmenu=yes';
1926: ($output,$response)=&ssi($filelink,%form);
1927: }
1928: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1929: $output=~s/^.*?\<body[^\>]*\>//si;
1930: $output=~s/\<\/body\s*\>.*?$//si;
1931: if (wantarray) {
1932: return ($output, $response);
1933: } else {
1934: return $output;
1935: }
1936: }
1937:
1938: # --------------------------------------------------------- Server Side Include
1939:
1940: sub absolute_url {
1941: my ($host_name) = @_;
1942: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1943: if ($host_name eq '') {
1944: $host_name = $ENV{'SERVER_NAME'};
1945: }
1946: return $protocol.$host_name;
1947: }
1948:
1949: #
1950: # Server side include.
1951: # Parameters:
1952: # fn Possibly encrypted resource name/id.
1953: # form Hash that describes how the rendering should be done
1954: # and other things.
1955: # Returns:
1956: # Scalar context: The content of the response.
1957: # Array context: 2 element list of the content and the full response object.
1958: #
1959: sub ssi {
1960:
1961: my ($fn,%form)=@_;
1962: my $ua=new LWP::UserAgent;
1963: my $request;
1964:
1965: $form{'no_update_last_known'}=1;
1966: &Apache::lonenc::check_encrypt(\$fn);
1967: if (%form) {
1968: $request=new HTTP::Request('POST',&absolute_url().$fn);
1969: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1970: } else {
1971: $request=new HTTP::Request('GET',&absolute_url().$fn);
1972: }
1973:
1974: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1975: my $response=$ua->request($request);
1976:
1977: if (wantarray) {
1978: return ($response->content, $response);
1979: } else {
1980: return $response->content;
1981: }
1982: }
1983:
1984: sub externalssi {
1985: my ($url)=@_;
1986: my $ua=new LWP::UserAgent;
1987: my $request=new HTTP::Request('GET',$url);
1988: my $response=$ua->request($request);
1989: if (wantarray) {
1990: return ($response->content, $response);
1991: } else {
1992: return $response->content;
1993: }
1994: }
1995:
1996: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1997:
1998: sub allowuploaded {
1999: my ($srcurl,$url)=@_;
2000: $url=&clutter(&declutter($url));
2001: my $dir=$url;
2002: $dir=~s/\/[^\/]+$//;
2003: my %httpref=();
2004: my $httpurl=&hreflocation('',$url);
2005: $httpref{'httpref.'.$httpurl}=$srcurl;
2006: &Apache::lonnet::appenv(\%httpref);
2007: }
2008:
2009: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
2010: # input: action, courseID, current domain, intended
2011: # path to file, source of file, instruction to parse file for objects,
2012: # ref to hash for embedded objects,
2013: # ref to hash for codebase of java objects.
2014: #
2015: # output: url to file (if action was uploaddoc),
2016: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
2017: #
2018: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2019: # course.
2020: #
2021: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2022: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2023: # course's home server.
2024: #
2025: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2026: # be copied from $source (current location) to
2027: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2028: # and will then be copied to
2029: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2030: # course's home server.
2031: #
2032: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2033: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
2034: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2035: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2036: # in course's home server.
2037: #
2038:
2039: sub process_coursefile {
2040: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
2041: my $fetchresult;
2042: my $home=&homeserver($docuname,$docudom);
2043: if ($action eq 'propagate') {
2044: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2045: $home);
2046: } else {
2047: my $fpath = '';
2048: my $fname = $file;
2049: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2050: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2051: my $filepath = &build_filepath($fpath);
2052: if ($action eq 'copy') {
2053: if ($source eq '') {
2054: $fetchresult = 'no source file';
2055: return $fetchresult;
2056: } else {
2057: my $destination = $filepath.'/'.$fname;
2058: rename($source,$destination);
2059: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2060: $home);
2061: }
2062: } elsif ($action eq 'uploaddoc') {
2063: open(my $fh,'>'.$filepath.'/'.$fname);
2064: print $fh $env{'form.'.$source};
2065: close($fh);
2066: if ($parser eq 'parse') {
2067: my $mm = new File::MMagic;
2068: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2069: if ($mime_type eq 'text/html') {
2070: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2071: unless ($parse_result eq 'ok') {
2072: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2073: }
2074: }
2075: }
2076: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2077: $home);
2078: if ($fetchresult eq 'ok') {
2079: return '/uploaded/'.$fpath.'/'.$fname;
2080: } else {
2081: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2082: ' to host '.$home.': '.$fetchresult);
2083: return '/adm/notfound.html';
2084: }
2085: }
2086: }
2087: unless ( $fetchresult eq 'ok') {
2088: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2089: ' to host '.$home.': '.$fetchresult);
2090: }
2091: return $fetchresult;
2092: }
2093:
2094: sub build_filepath {
2095: my ($fpath) = @_;
2096: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2097: unless ($fpath eq '') {
2098: my @parts=split('/',$fpath);
2099: foreach my $part (@parts) {
2100: $filepath.= '/'.$part;
2101: if ((-e $filepath)!=1) {
2102: mkdir($filepath,0777);
2103: }
2104: }
2105: }
2106: return $filepath;
2107: }
2108:
2109: sub store_edited_file {
2110: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
2111: my $file = $primary_url;
2112: $file =~ s#^/uploaded/$docudom/$docuname/##;
2113: my $fpath = '';
2114: my $fname = $file;
2115: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2116: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2117: my $filepath = &build_filepath($fpath);
2118: open(my $fh,'>'.$filepath.'/'.$fname);
2119: print $fh $content;
2120: close($fh);
2121: my $home=&homeserver($docuname,$docudom);
2122: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2123: $home);
2124: if ($$fetchresult eq 'ok') {
2125: return '/uploaded/'.$fpath.'/'.$fname;
2126: } else {
2127: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2128: ' to host '.$home.': '.$$fetchresult);
2129: return '/adm/notfound.html';
2130: }
2131: }
2132:
2133: sub clean_filename {
2134: my ($fname,$args)=@_;
2135: # Replace Windows backslashes by forward slashes
2136: $fname=~s/\\/\//g;
2137: if (!$args->{'keep_path'}) {
2138: # Get rid of everything but the actual filename
2139: $fname=~s/^.*\/([^\/]+)$/$1/;
2140: }
2141: # Replace spaces by underscores
2142: $fname=~s/\s+/\_/g;
2143: # Replace all other weird characters by nothing
2144: $fname=~s{[^/\w\.\-]}{}g;
2145: # Replace all .\d. sequences with _\d. so they no longer look like version
2146: # numbers
2147: $fname=~s/\.(\d+)(?=\.)/_$1/g;
2148: return $fname;
2149: }
2150: #This Function check if a Image max 400px width and height 500px. If not then scale the image down
2151: sub resizeImage {
2152: my($img_url) = @_;
2153: my $ima = Image::Magick->new;
2154: $ima->Read($img_url);
2155: if($ima->Get('width') > 400)
2156: {
2157: my $factor = $ima->Get('width')/400;
2158: $ima->Scale( width=>400, height=>$ima->Get('height')/$factor );
2159: }
2160: if($ima->Get('height') > 500)
2161: {
2162: my $factor = $ima->Get('height')/500;
2163: $ima->Scale( width=>$ima->Get('width')/$factor, height=>500);
2164: }
2165:
2166: $ima->Write($img_url);
2167: }
2168:
2169: #Wrapper function for userphotoupload
2170: sub userphotoupload
2171: {
2172: my($formname,$subdir) = @_;
2173: $upload_photo_form = 1;
2174: return &userfileupload($formname,undef,$subdir);
2175: }
2176:
2177: # --------------- Take an uploaded file and put it into the userfiles directory
2178: # input: $formname - the contents of the file are in $env{"form.$formname"}
2179: # the desired filenam is in $env{"form.$formname.filename"}
2180: # $coursedoc - if true up to the current course
2181: # if false
2182: # $subdir - directory in userfile to store the file into
2183: # $parser - instruction to parse file for objects ($parser = parse)
2184: # $allfiles - reference to hash for embedded objects
2185: # $codebase - reference to hash for codebase of java objects
2186: # $desuname - username for permanent storage of uploaded file
2187: # $dsetudom - domain for permanaent storage of uploaded file
2188: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2189: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
2190: #
2191: # output: url of file in userspace, or error: <message>
2192: # or /adm/notfound.html if failure to upload occurse
2193:
2194:
2195: sub userfileupload {
2196: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
2197: $destudom,$thumbwidth,$thumbheight)=@_;
2198: if (!defined($subdir)) { $subdir='unknown'; }
2199: my $fname=$env{'form.'.$formname.'.filename'};
2200: $fname=&clean_filename($fname);
2201: # See if there is anything left
2202: unless ($fname) { return 'error: no uploaded file'; }
2203: chop($env{'form.'.$formname});
2204: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2205: my $now = time;
2206: my $filepath = 'tmp/helprequests/'.$now;
2207: my @parts=split(/\//,$filepath);
2208: my $fullpath = $perlvar{'lonDaemons'};
2209: for (my $i=0;$i<@parts;$i++) {
2210: $fullpath .= '/'.$parts[$i];
2211: if ((-e $fullpath)!=1) {
2212: mkdir($fullpath,0777);
2213: }
2214: }
2215: open(my $fh,'>'.$fullpath.'/'.$fname);
2216: print $fh $env{'form.'.$formname};
2217: close($fh);
2218: return $fullpath.'/'.$fname;
2219: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2220: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2221: '_'.$env{'user.domain'}.'/pending';
2222: my @parts=split(/\//,$filepath);
2223: my $fullpath = $perlvar{'lonDaemons'};
2224: for (my $i=0;$i<@parts;$i++) {
2225: $fullpath .= '/'.$parts[$i];
2226: if ((-e $fullpath)!=1) {
2227: mkdir($fullpath,0777);
2228: }
2229: }
2230: open(my $fh,'>'.$fullpath.'/'.$fname);
2231: print $fh $env{'form.'.$formname};
2232: close($fh);
2233: return $fullpath.'/'.$fname;
2234: }
2235: if ($subdir eq 'scantron') {
2236: $fname = 'scantron_orig_'.$fname;
2237: } else {
2238: # Create the directory if not present
2239: $fname="$subdir/$fname";
2240: }
2241: if ($coursedoc) {
2242: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2243: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2244: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
2245: return &finishuserfileupload($docuname,$docudom,
2246: $formname,$fname,$parser,$allfiles,
2247: $codebase,$thumbwidth,$thumbheight);
2248: } else {
2249: $fname=$env{'form.folder'}.'/'.$fname;
2250: return &process_coursefile('uploaddoc',$docuname,$docudom,
2251: $fname,$formname,$parser,
2252: $allfiles,$codebase);
2253: }
2254: } elsif (defined($destuname)) {
2255: my $docuname=$destuname;
2256: my $docudom=$destudom;
2257: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2258: $parser,$allfiles,$codebase,
2259: $thumbwidth,$thumbheight);
2260:
2261: } else {
2262: my $docuname=$env{'user.name'};
2263: my $docudom=$env{'user.domain'};
2264: if (exists($env{'form.group'})) {
2265: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2266: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2267: }
2268: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2269: $parser,$allfiles,$codebase,
2270: $thumbwidth,$thumbheight);
2271: }
2272: }
2273:
2274: sub finishuserfileupload {
2275: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
2276: $thumbwidth,$thumbheight) = @_;
2277: my $path=$docudom.'/'.$docuname.'/';
2278: my $filepath=$perlvar{'lonDocRoot'};
2279:
2280: my ($fnamepath,$file,$fetchthumb);
2281: $file=$fname;
2282: if ($fname=~m|/|) {
2283: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2284: $path.=$fnamepath.'/';
2285: }
2286: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
2287: my $count;
2288: for ($count=4;$count<=$#parts;$count++) {
2289: $filepath.="/$parts[$count]";
2290: if ((-e $filepath)!=1) {
2291: mkdir($filepath,0777);
2292: }
2293: }
2294:
2295: # Save the file
2296: {
2297: if (!open(FH,'>'.$filepath.'/'.$file)) {
2298: &logthis('Failed to create '.$filepath.'/'.$file);
2299: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2300: return '/adm/notfound.html';
2301: }
2302: if (!print FH ($env{'form.'.$formname})) {
2303: &logthis('Failed to write to '.$filepath.'/'.$file);
2304: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2305: return '/adm/notfound.html';
2306: }
2307: close(FH);
2308: if($upload_photo_form==1)
2309: {
2310: resizeImage($filepath.'/'.$file);
2311: $upload_photo_form = 0;
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/)) {
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: $userrolehash
2743: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2744: =$tend.':'.$tstart;
2745: }
2746: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2747: ($trole=~/^li/) || ($trole=~/^li/) ||
2748: ($trole=~/^au/) || ($trole=~/^dg/) ||
2749: ($trole=~/^sc/)) {
2750: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2751: $domainrolehash
2752: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2753: = $tend.':'.$tstart;
2754: }
2755: }
2756:
2757: sub courserolelog {
2758: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2759: if (($trole eq 'cc') || ($trole eq 'in') ||
2760: ($trole eq 'ep') || ($trole eq 'ad') ||
2761: ($trole eq 'ta') || ($trole eq 'st') ||
2762: ($trole=~/^cr/) || ($trole eq 'gr')) {
2763: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2764: my $cdom = $1;
2765: my $cnum = $2;
2766: my $sec = $3;
2767: my $namespace = 'rolelog';
2768: my %storehash = (
2769: role => $trole,
2770: start => $tstart,
2771: end => $tend,
2772: selfenroll => $selfenroll,
2773: context => $context,
2774: );
2775: if ($trole eq 'gr') {
2776: $namespace = 'groupslog';
2777: $storehash{'group'} = $sec;
2778: } else {
2779: $storehash{'section'} = $sec;
2780: }
2781: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
2782: if (($trole ne 'st') || ($sec ne '')) {
2783: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2784: }
2785: }
2786: }
2787: return;
2788: }
2789:
2790: sub get_course_adv_roles {
2791: my ($cid,$codes) = @_;
2792: $cid=$env{'request.course.id'} unless (defined($cid));
2793: my %coursehash=&coursedescription($cid);
2794: my $crstype = &Apache::loncommon::course_type($cid);
2795: my %nothide=();
2796: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2797: if ($user !~ /:/) {
2798: $nothide{join(':',split(/[\@]/,$user))}=1;
2799: } else {
2800: $nothide{$user}=1;
2801: }
2802: }
2803: my %returnhash=();
2804: my %dumphash=
2805: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2806: my $now=time;
2807: my %privileged;
2808: foreach my $entry (keys(%dumphash)) {
2809: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2810: if (($tstart) && ($tstart<0)) { next; }
2811: if (($tend) && ($tend<$now)) { next; }
2812: if (($tstart) && ($now<$tstart)) { next; }
2813: my ($role,$username,$domain,$section)=split(/\:/,$entry);
2814: if ($username eq '' || $domain eq '') { next; }
2815: unless (ref($privileged{$domain}) eq 'HASH') {
2816: my %dompersonnel =
2817: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2818: $privileged{$domain} = {};
2819: foreach my $server (keys(%dompersonnel)) {
2820: if (ref($dompersonnel{$server}) eq 'HASH') {
2821: foreach my $user (keys(%{$dompersonnel{$server}})) {
2822: my ($trole,$uname,$udom) = split(/:/,$user);
2823: $privileged{$udom}{$uname} = 1;
2824: }
2825: }
2826: }
2827: }
2828: if ((exists($privileged{$domain}{$username})) &&
2829: (!$nothide{$username.':'.$domain})) { next; }
2830: if ($role eq 'cr') { next; }
2831: if ($codes) {
2832: if ($section) { $role .= ':'.$section; }
2833: if ($returnhash{$role}) {
2834: $returnhash{$role}.=','.$username.':'.$domain;
2835: } else {
2836: $returnhash{$role}=$username.':'.$domain;
2837: }
2838: } else {
2839: my $key=&plaintext($role,$crstype);
2840: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
2841: if ($returnhash{$key}) {
2842: $returnhash{$key}.=','.$username.':'.$domain;
2843: } else {
2844: $returnhash{$key}=$username.':'.$domain;
2845: }
2846: }
2847: }
2848: return %returnhash;
2849: }
2850:
2851: sub get_my_roles {
2852: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
2853: unless (defined($uname)) { $uname=$env{'user.name'}; }
2854: unless (defined($udom)) { $udom=$env{'user.domain'}; }
2855: my (%dumphash,%nothide);
2856: if ($context eq 'userroles') {
2857: %dumphash = &dump('roles',$udom,$uname);
2858: } else {
2859: %dumphash=
2860: &dump('nohist_userroles',$udom,$uname);
2861: if ($hidepriv) {
2862: my %coursehash=&coursedescription($udom.'_'.$uname);
2863: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2864: if ($user !~ /:/) {
2865: $nothide{join(':',split(/[\@]/,$user))} = 1;
2866: } else {
2867: $nothide{$user} = 1;
2868: }
2869: }
2870: }
2871: }
2872: my %returnhash=();
2873: my $now=time;
2874: my %privileged;
2875: foreach my $entry (keys(%dumphash)) {
2876: my ($role,$tend,$tstart);
2877: if ($context eq 'userroles') {
2878: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2879: } else {
2880: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2881: }
2882: if (($tstart) && ($tstart<0)) { next; }
2883: my $status = 'active';
2884: if (($tend) && ($tend<=$now)) {
2885: $status = 'previous';
2886: }
2887: if (($tstart) && ($now<$tstart)) {
2888: $status = 'future';
2889: }
2890: if (ref($types) eq 'ARRAY') {
2891: if (!grep(/^\Q$status\E$/,@{$types})) {
2892: next;
2893: }
2894: } else {
2895: if ($status ne 'active') {
2896: next;
2897: }
2898: }
2899: my ($rolecode,$username,$domain,$section,$area);
2900: if ($context eq 'userroles') {
2901: ($area,$rolecode) = split(/_/,$entry);
2902: (undef,$domain,$username,$section) = split(/\//,$area);
2903: } else {
2904: ($role,$username,$domain,$section) = split(/\:/,$entry);
2905: }
2906: if (ref($roledoms) eq 'ARRAY') {
2907: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2908: next;
2909: }
2910: }
2911: if (ref($roles) eq 'ARRAY') {
2912: if (!grep(/^\Q$role\E$/,@{$roles})) {
2913: if ($role =~ /^cr\//) {
2914: if (!grep(/^cr$/,@{$roles})) {
2915: next;
2916: }
2917: } else {
2918: next;
2919: }
2920: }
2921: }
2922: if ($hidepriv) {
2923: if ($context eq 'userroles') {
2924: if ((&privileged($username,$domain)) &&
2925: (!$nothide{$username.':'.$domain})) {
2926: next;
2927: }
2928: } else {
2929: unless (ref($privileged{$domain}) eq 'HASH') {
2930: my %dompersonnel =
2931: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2932: $privileged{$domain} = {};
2933: if (keys(%dompersonnel)) {
2934: foreach my $server (keys(%dompersonnel)) {
2935: if (ref($dompersonnel{$server}) eq 'HASH') {
2936: foreach my $user (keys(%{$dompersonnel{$server}})) {
2937: my ($trole,$uname,$udom) = split(/:/,$user);
2938: $privileged{$udom}{$uname} = $trole;
2939: }
2940: }
2941: }
2942: }
2943: }
2944: if (exists($privileged{$domain}{$username})) {
2945: if (!$nothide{$username.':'.$domain}) {
2946: next;
2947: }
2948: }
2949: }
2950: }
2951: if ($withsec) {
2952: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2953: $tstart.':'.$tend;
2954: } else {
2955: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2956: }
2957: }
2958: return %returnhash;
2959: }
2960:
2961: # ----------------------------------------------------- Frontpage Announcements
2962: #
2963: #
2964:
2965: sub postannounce {
2966: my ($server,$text)=@_;
2967: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
2968: unless ($text=~/\w/) { $text=''; }
2969: return &reply('setannounce:'.&escape($text),$server);
2970: }
2971:
2972: sub getannounce {
2973:
2974: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2975: my $announcement='';
2976: while (my $line = <$fh>) { $announcement .= $line; }
2977: close($fh);
2978: if ($announcement=~/\w/) {
2979: return
2980: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2981: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2982: } else {
2983: return '';
2984: }
2985: } else {
2986: return '';
2987: }
2988: }
2989:
2990: # ---------------------------------------------------------- Course ID routines
2991: # Deal with domain's nohist_courseid.db files
2992: #
2993:
2994: sub courseidput {
2995: my ($domain,$storehash,$coursehome,$caller) = @_;
2996: my $outcome;
2997: if ($caller eq 'timeonly') {
2998: my $cids = '';
2999: foreach my $item (keys(%$storehash)) {
3000: $cids.=&escape($item).'&';
3001: }
3002: $cids=~s/\&$//;
3003: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3004: $coursehome);
3005: } else {
3006: my $items = '';
3007: foreach my $item (keys(%$storehash)) {
3008: $items.= &escape($item).'='.
3009: &freeze_escape($$storehash{$item}).'&';
3010: }
3011: $items=~s/\&$//;
3012: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3013: $coursehome);
3014: }
3015: if ($outcome eq 'unknown_cmd') {
3016: my $what;
3017: foreach my $cid (keys(%$storehash)) {
3018: $what .= &escape($cid).'=';
3019: foreach my $item ('description','inst_code','owner','type') {
3020: $what .= &escape($storehash->{$cid}{$item}).':';
3021: }
3022: $what =~ s/\:$/&/;
3023: }
3024: $what =~ s/\&$//;
3025: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3026: } else {
3027: return $outcome;
3028: }
3029: }
3030:
3031: sub courseiddump {
3032: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
3033: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
3034: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3035: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
3036: my $as_hash = 1;
3037: my %returnhash;
3038: if (!$domfilter) { $domfilter=''; }
3039: my %libserv = &all_library();
3040: foreach my $tryserver (keys(%libserv)) {
3041: if ( ( $hostidflag == 1
3042: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3043: || (!defined($hostidflag)) ) {
3044:
3045: if (($domfilter eq '') ||
3046: (&host_domain($tryserver) eq $domfilter)) {
3047: my $rep =
3048: &reply('courseiddump:'.&host_domain($tryserver).':'.
3049: $sincefilter.':'.&escape($descfilter).':'.
3050: &escape($instcodefilter).':'.&escape($ownerfilter).
3051: ':'.&escape($coursefilter).':'.&escape($typefilter).
3052: ':'.&escape($regexp_ok).':'.$as_hash.':'.
3053: &escape($selfenrollonly).':'.&escape($catfilter).':'.
3054: $showhidden.':'.$caller.':'.&escape($cloner).':'.
3055: &escape($cc_clone).':'.$cloneonly.':'.
3056: &escape($createdbefore).':'.&escape($createdafter).':'.
3057: &escape($creationcontext),$tryserver);
3058: my @pairs=split(/\&/,$rep);
3059: foreach my $item (@pairs) {
3060: my ($key,$value)=split(/\=/,$item,2);
3061: $key = &unescape($key);
3062: next if ($key =~ /^error: 2 /);
3063: my $result = &thaw_unescape($value);
3064: if (ref($result) eq 'HASH') {
3065: $returnhash{$key}=$result;
3066: } else {
3067: my @responses = split(/:/,$value);
3068: my @items = ('description','inst_code','owner','type');
3069: for (my $i=0; $i<@responses; $i++) {
3070: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
3071: }
3072: }
3073: }
3074: }
3075: }
3076: }
3077: return %returnhash;
3078: }
3079:
3080: # ---------------------------------------------------------- DC e-mail
3081:
3082: sub dcmailput {
3083: my ($domain,$msgid,$message,$server)=@_;
3084: my $status = &Apache::lonnet::critical(
3085: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3086: &escape($message),$server);
3087: return $status;
3088: }
3089:
3090: sub dcmaildump {
3091: my ($dom,$startdate,$enddate,$senders) = @_;
3092: my %returnhash=();
3093:
3094: if (defined(&domain($dom,'primary'))) {
3095: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3096: &escape($enddate).':';
3097: my @esc_senders=map { &escape($_)} @$senders;
3098: $cmd.=&escape(join('&',@esc_senders));
3099: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
3100: my ($key,$value) = split(/\=/,$line,2);
3101: if (($key) && ($value)) {
3102: $returnhash{&unescape($key)} = &unescape($value);
3103: }
3104: }
3105: }
3106: return %returnhash;
3107: }
3108: # ---------------------------------------------------------- Domain roles
3109:
3110: sub get_domain_roles {
3111: my ($dom,$roles,$startdate,$enddate)=@_;
3112: if ((!defined($startdate)) || ($startdate eq '')) {
3113: $startdate = '.';
3114: }
3115: if ((!defined($enddate)) || ($enddate eq '')) {
3116: $enddate = '.';
3117: }
3118: my $rolelist;
3119: if (ref($roles) eq 'ARRAY') {
3120: $rolelist = join(':',@{$roles});
3121: }
3122: my %personnel = ();
3123:
3124: my %servers = &get_servers($dom,'library');
3125: foreach my $tryserver (keys(%servers)) {
3126: %{$personnel{$tryserver}}=();
3127: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3128: &escape($startdate).':'.
3129: &escape($enddate).':'.
3130: &escape($rolelist), $tryserver))) {
3131: my ($key,$value) = split(/\=/,$line,2);
3132: if (($key) && ($value)) {
3133: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3134: }
3135: }
3136: }
3137: return %personnel;
3138: }
3139:
3140: # ----------------------------------------------------------- Check out an item
3141:
3142: sub get_first_access {
3143: my ($type,$argsymb)=@_;
3144: my ($symb,$courseid,$udom,$uname)=&whichuser();
3145: if ($argsymb) { $symb=$argsymb; }
3146: my ($map,$id,$res)=&decode_symb($symb);
3147: if ($type eq 'course') {
3148: $res='course';
3149: } elsif ($type eq 'map') {
3150: $res=&symbread($map);
3151: } else {
3152: $res=$symb;
3153: }
3154: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3155: return $times{"$courseid\0$res"};
3156: }
3157:
3158: sub set_first_access {
3159: my ($type)=@_;
3160: my ($symb,$courseid,$udom,$uname)=&whichuser();
3161: my ($map,$id,$res)=&decode_symb($symb);
3162: if ($type eq 'course') {
3163: $res='course';
3164: } elsif ($type eq 'map') {
3165: $res=&symbread($map);
3166: } else {
3167: $res=$symb;
3168: }
3169: my $firstaccess=&get_first_access($type,$symb);
3170: if (!$firstaccess) {
3171: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
3172: }
3173: return 'already_set';
3174: }
3175:
3176: sub checkout {
3177: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3178: my $now=time;
3179: my $lonhost=$perlvar{'lonHostID'};
3180: my $infostr=&escape(
3181: 'CHECKOUTTOKEN&'.
3182: $tuname.'&'.
3183: $tudom.'&'.
3184: $tcrsid.'&'.
3185: $symb.'&'.
3186: $now.'&'.$ENV{'REMOTE_ADDR'});
3187: my $token=&reply('tmpput:'.$infostr,$lonhost);
3188: if ($token=~/^error\:/) {
3189: &logthis("<font color=\"blue\">WARNING: ".
3190: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3191: "</font>");
3192: return '';
3193: }
3194:
3195: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3196: $token=~tr/a-z/A-Z/;
3197:
3198: my %infohash=('resource.0.outtoken' => $token,
3199: 'resource.0.checkouttime' => $now,
3200: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
3201:
3202: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3203: return '';
3204: } else {
3205: &logthis("<font color=\"blue\">WARNING: ".
3206: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3207: "</font>");
3208: }
3209:
3210: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3211: &escape('Checkout '.$infostr.' - '.
3212: $token)) ne 'ok') {
3213: return '';
3214: } else {
3215: &logthis("<font color=\"blue\">WARNING: ".
3216: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3217: "</font>");
3218: }
3219: return $token;
3220: }
3221:
3222: # ------------------------------------------------------------ Check in an item
3223:
3224: sub checkin {
3225: my $token=shift;
3226: my $now=time;
3227: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3228: $lonhost=~tr/A-Z/a-z/;
3229: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
3230: $dtoken=~s/\W/\_/g;
3231: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
3232: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3233:
3234: unless (($tuname) && ($tudom)) {
3235: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3236: return '';
3237: }
3238:
3239: unless (&allowed('mgr',$tcrsid)) {
3240: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
3241: $env{'user.name'}.' - '.$env{'user.domain'});
3242: return '';
3243: }
3244:
3245: my %infohash=('resource.0.intoken' => $token,
3246: 'resource.0.checkintime' => $now,
3247: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
3248:
3249: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3250: return '';
3251: }
3252:
3253: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3254: &escape('Checkin - '.$token)) ne 'ok') {
3255: return '';
3256: }
3257:
3258: return ($symb,$tuname,$tudom,$tcrsid);
3259: }
3260:
3261: # --------------------------------------------- Set Expire Date for Spreadsheet
3262:
3263: sub expirespread {
3264: my ($uname,$udom,$stype,$usymb)=@_;
3265: my $cid=$env{'request.course.id'};
3266: if ($cid) {
3267: my $now=time;
3268: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
3269: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3270: $env{'course.'.$cid.'.num'}.
3271: ':nohist_expirationdates:'.
3272: &escape($key).'='.$now,
3273: $env{'course.'.$cid.'.home'})
3274: }
3275: return 'ok';
3276: }
3277:
3278: # ----------------------------------------------------- Devalidate Spreadsheets
3279:
3280: sub devalidate {
3281: my ($symb,$uname,$udom)=@_;
3282: my $cid=$env{'request.course.id'};
3283: if ($cid) {
3284: # delete the stored spreadsheets for
3285: # - the student level sheet of this user in course's homespace
3286: # - the assessment level sheet for this resource
3287: # for this user in user's homespace
3288: # - current conditional state info
3289: my $key=$uname.':'.$udom.':';
3290: my $status=
3291: &del('nohist_calculatedsheets',
3292: [$key.'studentcalc:'],
3293: $env{'course.'.$cid.'.domain'},
3294: $env{'course.'.$cid.'.num'})
3295: .' '.
3296: &del('nohist_calculatedsheets_'.$cid,
3297: [$key.'assesscalc:'.$symb],$udom,$uname);
3298: unless ($status eq 'ok ok') {
3299: &logthis('Could not devalidate spreadsheet '.
3300: $uname.' at '.$udom.' for '.
3301: $symb.': '.$status);
3302: }
3303: &delenv('user.state.'.$cid);
3304: }
3305: }
3306:
3307: sub get_scalar {
3308: my ($string,$end) = @_;
3309: my $value;
3310: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3311: $value = $1;
3312: } elsif ($$string =~ s/^([^&]*?)&//) {
3313: $value = $1;
3314: }
3315: return &unescape($value);
3316: }
3317:
3318: sub array2str {
3319: my (@array) = @_;
3320: my $result=&arrayref2str(\@array);
3321: $result=~s/^__ARRAY_REF__//;
3322: $result=~s/__END_ARRAY_REF__$//;
3323: return $result;
3324: }
3325:
3326: sub arrayref2str {
3327: my ($arrayref) = @_;
3328: my $result='__ARRAY_REF__';
3329: foreach my $elem (@$arrayref) {
3330: if(ref($elem) eq 'ARRAY') {
3331: $result.=&arrayref2str($elem).'&';
3332: } elsif(ref($elem) eq 'HASH') {
3333: $result.=&hashref2str($elem).'&';
3334: } elsif(ref($elem)) {
3335: #print("Got a ref of ".(ref($elem))." skipping.");
3336: } else {
3337: $result.=&escape($elem).'&';
3338: }
3339: }
3340: $result=~s/\&$//;
3341: $result .= '__END_ARRAY_REF__';
3342: return $result;
3343: }
3344:
3345: sub hash2str {
3346: my (%hash) = @_;
3347: my $result=&hashref2str(\%hash);
3348: $result=~s/^__HASH_REF__//;
3349: $result=~s/__END_HASH_REF__$//;
3350: return $result;
3351: }
3352:
3353: sub hashref2str {
3354: my ($hashref)=@_;
3355: my $result='__HASH_REF__';
3356: foreach my $key (sort(keys(%$hashref))) {
3357: if (ref($key) eq 'ARRAY') {
3358: $result.=&arrayref2str($key).'=';
3359: } elsif (ref($key) eq 'HASH') {
3360: $result.=&hashref2str($key).'=';
3361: } elsif (ref($key)) {
3362: $result.='=';
3363: #print("Got a ref of ".(ref($key))." skipping.");
3364: } else {
3365: if ($key) {$result.=&escape($key).'=';} else { last; }
3366: }
3367:
3368: if(ref($hashref->{$key}) eq 'ARRAY') {
3369: $result.=&arrayref2str($hashref->{$key}).'&';
3370: } elsif(ref($hashref->{$key}) eq 'HASH') {
3371: $result.=&hashref2str($hashref->{$key}).'&';
3372: } elsif(ref($hashref->{$key})) {
3373: $result.='&';
3374: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
3375: } else {
3376: $result.=&escape($hashref->{$key}).'&';
3377: }
3378: }
3379: $result=~s/\&$//;
3380: $result .= '__END_HASH_REF__';
3381: return $result;
3382: }
3383:
3384: sub str2hash {
3385: my ($string)=@_;
3386: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3387: return %$hash;
3388: }
3389:
3390: sub str2hashref {
3391: my ($string) = @_;
3392:
3393: my %hash;
3394:
3395: if($string !~ /^__HASH_REF__/) {
3396: if (! ($string eq '' || !defined($string))) {
3397: $hash{'error'}='Not hash reference';
3398: }
3399: return (\%hash, $string);
3400: }
3401:
3402: $string =~ s/^__HASH_REF__//;
3403:
3404: while($string !~ /^__END_HASH_REF__/) {
3405: #key
3406: my $key='';
3407: if($string =~ /^__HASH_REF__/) {
3408: ($key, $string)=&str2hashref($string);
3409: if(defined($key->{'error'})) {
3410: $hash{'error'}='Bad data';
3411: return (\%hash, $string);
3412: }
3413: } elsif($string =~ /^__ARRAY_REF__/) {
3414: ($key, $string)=&str2arrayref($string);
3415: if($key->[0] eq 'Array reference error') {
3416: $hash{'error'}='Bad data';
3417: return (\%hash, $string);
3418: }
3419: } else {
3420: $string =~ s/^(.*?)=//;
3421: $key=&unescape($1);
3422: }
3423: $string =~ s/^=//;
3424:
3425: #value
3426: my $value='';
3427: if($string =~ /^__HASH_REF__/) {
3428: ($value, $string)=&str2hashref($string);
3429: if(defined($value->{'error'})) {
3430: $hash{'error'}='Bad data';
3431: return (\%hash, $string);
3432: }
3433: } elsif($string =~ /^__ARRAY_REF__/) {
3434: ($value, $string)=&str2arrayref($string);
3435: if($value->[0] eq 'Array reference error') {
3436: $hash{'error'}='Bad data';
3437: return (\%hash, $string);
3438: }
3439: } else {
3440: $value=&get_scalar(\$string,'__END_HASH_REF__');
3441: }
3442: $string =~ s/^&//;
3443:
3444: $hash{$key}=$value;
3445: }
3446:
3447: $string =~ s/^__END_HASH_REF__//;
3448:
3449: return (\%hash, $string);
3450: }
3451:
3452: sub str2array {
3453: my ($string)=@_;
3454: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3455: return @$array;
3456: }
3457:
3458: sub str2arrayref {
3459: my ($string) = @_;
3460: my @array;
3461:
3462: if($string !~ /^__ARRAY_REF__/) {
3463: if (! ($string eq '' || !defined($string))) {
3464: $array[0]='Array reference error';
3465: }
3466: return (\@array, $string);
3467: }
3468:
3469: $string =~ s/^__ARRAY_REF__//;
3470:
3471: while($string !~ /^__END_ARRAY_REF__/) {
3472: my $value='';
3473: if($string =~ /^__HASH_REF__/) {
3474: ($value, $string)=&str2hashref($string);
3475: if(defined($value->{'error'})) {
3476: $array[0] ='Array reference error';
3477: return (\@array, $string);
3478: }
3479: } elsif($string =~ /^__ARRAY_REF__/) {
3480: ($value, $string)=&str2arrayref($string);
3481: if($value->[0] eq 'Array reference error') {
3482: $array[0] ='Array reference error';
3483: return (\@array, $string);
3484: }
3485: } else {
3486: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3487: }
3488: $string =~ s/^&//;
3489:
3490: push(@array, $value);
3491: }
3492:
3493: $string =~ s/^__END_ARRAY_REF__//;
3494:
3495: return (\@array, $string);
3496: }
3497:
3498: # -------------------------------------------------------------------Temp Store
3499:
3500: sub tmpreset {
3501: my ($symb,$namespace,$domain,$stuname) = @_;
3502: if (!$symb) {
3503: $symb=&symbread();
3504: if (!$symb) { $symb= $env{'request.url'}; }
3505: }
3506: $symb=escape($symb);
3507:
3508: if (!$namespace) { $namespace=$env{'request.state'}; }
3509: $namespace=~s/\//\_/g;
3510: $namespace=~s/\W//g;
3511:
3512: if (!$domain) { $domain=$env{'user.domain'}; }
3513: if (!$stuname) { $stuname=$env{'user.name'}; }
3514: if ($domain eq 'public' && $stuname eq 'public') {
3515: $stuname=$ENV{'REMOTE_ADDR'};
3516: }
3517: my $path=$perlvar{'lonDaemons'}.'/tmp';
3518: my %hash;
3519: if (tie(%hash,'GDBM_File',
3520: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3521: &GDBM_WRCREAT(),0640)) {
3522: foreach my $key (keys(%hash)) {
3523: if ($key=~ /:$symb/) {
3524: delete($hash{$key});
3525: }
3526: }
3527: }
3528: }
3529:
3530: sub tmpstore {
3531: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3532:
3533: if (!$symb) {
3534: $symb=&symbread();
3535: if (!$symb) { $symb= $env{'request.url'}; }
3536: }
3537: $symb=escape($symb);
3538:
3539: if (!$namespace) {
3540: # I don't think we would ever want to store this for a course.
3541: # it seems this will only be used if we don't have a course.
3542: #$namespace=$env{'request.course.id'};
3543: #if (!$namespace) {
3544: $namespace=$env{'request.state'};
3545: #}
3546: }
3547: $namespace=~s/\//\_/g;
3548: $namespace=~s/\W//g;
3549: if (!$domain) { $domain=$env{'user.domain'}; }
3550: if (!$stuname) { $stuname=$env{'user.name'}; }
3551: if ($domain eq 'public' && $stuname eq 'public') {
3552: $stuname=$ENV{'REMOTE_ADDR'};
3553: }
3554: my $now=time;
3555: my %hash;
3556: my $path=$perlvar{'lonDaemons'}.'/tmp';
3557: if (tie(%hash,'GDBM_File',
3558: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3559: &GDBM_WRCREAT(),0640)) {
3560: $hash{"version:$symb"}++;
3561: my $version=$hash{"version:$symb"};
3562: my $allkeys='';
3563: foreach my $key (keys(%$storehash)) {
3564: $allkeys.=$key.':';
3565: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
3566: }
3567: $hash{"$version:$symb:timestamp"}=$now;
3568: $allkeys.='timestamp';
3569: $hash{"$version:keys:$symb"}=$allkeys;
3570: if (untie(%hash)) {
3571: return 'ok';
3572: } else {
3573: return "error:$!";
3574: }
3575: } else {
3576: return "error:$!";
3577: }
3578: }
3579:
3580: # -----------------------------------------------------------------Temp Restore
3581:
3582: sub tmprestore {
3583: my ($symb,$namespace,$domain,$stuname) = @_;
3584:
3585: if (!$symb) {
3586: $symb=&symbread();
3587: if (!$symb) { $symb= $env{'request.url'}; }
3588: }
3589: $symb=escape($symb);
3590:
3591: if (!$namespace) { $namespace=$env{'request.state'}; }
3592:
3593: if (!$domain) { $domain=$env{'user.domain'}; }
3594: if (!$stuname) { $stuname=$env{'user.name'}; }
3595: if ($domain eq 'public' && $stuname eq 'public') {
3596: $stuname=$ENV{'REMOTE_ADDR'};
3597: }
3598: my %returnhash;
3599: $namespace=~s/\//\_/g;
3600: $namespace=~s/\W//g;
3601: my %hash;
3602: my $path=$perlvar{'lonDaemons'}.'/tmp';
3603: if (tie(%hash,'GDBM_File',
3604: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
3605: &GDBM_READER(),0640)) {
3606: my $version=$hash{"version:$symb"};
3607: $returnhash{'version'}=$version;
3608: my $scope;
3609: for ($scope=1;$scope<=$version;$scope++) {
3610: my $vkeys=$hash{"$scope:keys:$symb"};
3611: my @keys=split(/:/,$vkeys);
3612: my $key;
3613: $returnhash{"$scope:keys"}=$vkeys;
3614: foreach $key (@keys) {
3615: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3616: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3617: }
3618: }
3619: if (!(untie(%hash))) {
3620: return "error:$!";
3621: }
3622: } else {
3623: return "error:$!";
3624: }
3625: return %returnhash;
3626: }
3627:
3628: # ----------------------------------------------------------------------- Store
3629:
3630: sub store {
3631: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3632: my $home='';
3633:
3634: if ($stuname) { $home=&homeserver($stuname,$domain); }
3635:
3636: $symb=&symbclean($symb);
3637: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3638:
3639: if (!$domain) { $domain=$env{'user.domain'}; }
3640: if (!$stuname) { $stuname=$env{'user.name'}; }
3641:
3642: &devalidate($symb,$stuname,$domain);
3643:
3644: $symb=escape($symb);
3645: if (!$namespace) {
3646: unless ($namespace=$env{'request.course.id'}) {
3647: return '';
3648: }
3649: }
3650: if (!$home) { $home=$env{'user.home'}; }
3651:
3652: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3653: $$storehash{'host'}=$perlvar{'lonHostID'};
3654:
3655: my $namevalue='';
3656: foreach my $key (keys(%$storehash)) {
3657: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3658: }
3659: $namevalue=~s/\&$//;
3660: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
3661: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3662: }
3663:
3664: # -------------------------------------------------------------- Critical Store
3665:
3666: sub cstore {
3667: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3668: my $home='';
3669:
3670: if ($stuname) { $home=&homeserver($stuname,$domain); }
3671:
3672: $symb=&symbclean($symb);
3673: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
3674:
3675: if (!$domain) { $domain=$env{'user.domain'}; }
3676: if (!$stuname) { $stuname=$env{'user.name'}; }
3677:
3678: &devalidate($symb,$stuname,$domain);
3679:
3680: $symb=escape($symb);
3681: if (!$namespace) {
3682: unless ($namespace=$env{'request.course.id'}) {
3683: return '';
3684: }
3685: }
3686: if (!$home) { $home=$env{'user.home'}; }
3687:
3688: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3689: $$storehash{'host'}=$perlvar{'lonHostID'};
3690:
3691: my $namevalue='';
3692: foreach my $key (keys(%$storehash)) {
3693: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3694: }
3695: $namevalue=~s/\&$//;
3696: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
3697: return critical
3698: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
3699: }
3700:
3701: # --------------------------------------------------------------------- Restore
3702:
3703: sub restore {
3704: my ($symb,$namespace,$domain,$stuname) = @_;
3705: my $home='';
3706:
3707: if ($stuname) { $home=&homeserver($stuname,$domain); }
3708:
3709: if (!$symb) {
3710: unless ($symb=escape(&symbread())) { return ''; }
3711: } else {
3712: $symb=&escape(&symbclean($symb));
3713: }
3714: if (!$namespace) {
3715: unless ($namespace=$env{'request.course.id'}) {
3716: return '';
3717: }
3718: }
3719: if (!$domain) { $domain=$env{'user.domain'}; }
3720: if (!$stuname) { $stuname=$env{'user.name'}; }
3721: if (!$home) { $home=$env{'user.home'}; }
3722: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3723:
3724: my %returnhash=();
3725: foreach my $line (split(/\&/,$answer)) {
3726: my ($name,$value)=split(/\=/,$line);
3727: $returnhash{&unescape($name)}=&thaw_unescape($value);
3728: }
3729: my $version;
3730: for ($version=1;$version<=$returnhash{'version'};$version++) {
3731: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3732: $returnhash{$item}=$returnhash{$version.':'.$item};
3733: }
3734: }
3735: return %returnhash;
3736: }
3737:
3738: # ---------------------------------------------------------- Course Description
3739:
3740: sub coursedescription {
3741: my ($courseid,$args)=@_;
3742: $courseid=~s/^\///;
3743: $courseid=~s/\_/\//g;
3744: my ($cdomain,$cnum)=split(/\//,$courseid);
3745: my $chome=&homeserver($cnum,$cdomain);
3746: my $normalid=$cdomain.'_'.$cnum;
3747: # need to always cache even if we get errors otherwise we keep
3748: # trying and trying and trying to get the course description.
3749: my %envhash=();
3750: my %returnhash=();
3751:
3752: my $expiretime=600;
3753: if ($env{'request.course.id'} eq $normalid) {
3754: $expiretime=120;
3755: }
3756:
3757: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3758: if (!$args->{'freshen_cache'}
3759: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3760: foreach my $key (keys(%env)) {
3761: next if ($key !~ /^\Q$prefix\E(.*)/);
3762: my ($setting) = $1;
3763: $returnhash{$setting} = $env{$key};
3764: }
3765: return %returnhash;
3766: }
3767:
3768: # get the data agin
3769: if (!$args->{'one_time'}) {
3770: $envhash{'course.'.$normalid.'.last_cache'}=time;
3771: }
3772:
3773: if ($chome ne 'no_host') {
3774: %returnhash=&dump('environment',$cdomain,$cnum);
3775: if (!exists($returnhash{'con_lost'})) {
3776: $returnhash{'home'}= $chome;
3777: $returnhash{'domain'} = $cdomain;
3778: $returnhash{'num'} = $cnum;
3779: if (!defined($returnhash{'type'})) {
3780: $returnhash{'type'} = 'Course';
3781: }
3782: while (my ($name,$value) = each %returnhash) {
3783: $envhash{'course.'.$normalid.'.'.$name}=$value;
3784: }
3785: $returnhash{'url'}=&clutter($returnhash{'url'});
3786: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
3787: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
3788: $envhash{'course.'.$normalid.'.home'}=$chome;
3789: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3790: $envhash{'course.'.$normalid.'.num'}=$cnum;
3791: }
3792: }
3793: if (!$args->{'one_time'}) {
3794: &appenv(\%envhash);
3795: }
3796: return %returnhash;
3797: }
3798:
3799: # -------------------------------------------------See if a user is privileged
3800:
3801: sub privileged {
3802: my ($username,$domain)=@_;
3803: my $rolesdump=&reply("dump:$domain:$username:roles",
3804: &homeserver($username,$domain));
3805: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3806: ($rolesdump =~ /^error:/)) {
3807: return 0;
3808: }
3809: my $now=time;
3810: if ($rolesdump ne '') {
3811: foreach my $entry (split(/&/,$rolesdump)) {
3812: if ($entry!~/^rolesdef_/) {
3813: my ($area,$role)=split(/=/,$entry);
3814: $area=~s/\_\w\w$//;
3815: my ($trole,$tend,$tstart)=split(/_/,$role);
3816: if (($trole eq 'dc') || ($trole eq 'su')) {
3817: my $active=1;
3818: if ($tend) {
3819: if ($tend<$now) { $active=0; }
3820: }
3821: if ($tstart) {
3822: if ($tstart>$now) { $active=0; }
3823: }
3824: if ($active) { return 1; }
3825: }
3826: }
3827: }
3828: }
3829: return 0;
3830: }
3831:
3832: # -------------------------------------------------------- Get user privileges
3833:
3834: sub rolesinit {
3835: my ($domain,$username,$authhost)=@_;
3836: my $now=time;
3837: my %userroles = ('user.login.time' => $now);
3838: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
3839: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3840: ($rolesdump =~ /^error:/)) {
3841: return \%userroles;
3842: }
3843: my %allroles=();
3844: my %allgroups=();
3845: my $group_privs;
3846:
3847: if ($rolesdump ne '') {
3848: foreach my $entry (split(/&/,$rolesdump)) {
3849: if ($entry!~/^rolesdef_/) {
3850: my ($area,$role)=split(/=/,$entry);
3851: $area=~s/\_\w\w$//;
3852: my ($trole,$tend,$tstart,$group_privs);
3853: if ($role=~/^cr/) {
3854: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3855: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
3856: ($tend,$tstart)=split('_',$trest);
3857: } else {
3858: $trole=$role;
3859: }
3860: } elsif ($role =~ m|^gr/|) {
3861: ($trole,$tend,$tstart) = split(/_/,$role);
3862: ($trole,$group_privs) = split(/\//,$trole);
3863: $group_privs = &unescape($group_privs);
3864: } else {
3865: ($trole,$tend,$tstart)=split(/_/,$role);
3866: }
3867: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3868: $username);
3869: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
3870: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3871: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
3872: if (($area ne '') && ($trole ne '')) {
3873: my $spec=$trole.'.'.$area;
3874: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3875: if ($trole =~ /^cr\//) {
3876: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
3877: } elsif ($trole eq 'gr') {
3878: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
3879: } else {
3880: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
3881: }
3882: }
3883: }
3884: }
3885: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3886: $userroles{'user.adv'} = $adv;
3887: $userroles{'user.author'} = $author;
3888: $env{'user.adv'}=$adv;
3889: }
3890: return \%userroles;
3891: }
3892:
3893: sub set_arearole {
3894: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3895: # log the associated role with the area
3896: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
3897: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
3898: }
3899:
3900: sub custom_roleprivs {
3901: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3902: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3903: my $homsvr=homeserver($rauthor,$rdomain);
3904: if (&hostname($homsvr) ne '') {
3905: my ($rdummy,$roledef)=
3906: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3907: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3908: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3909: if (defined($syspriv)) {
3910: $$allroles{'cm./'}.=':'.$syspriv;
3911: $$allroles{$spec.'./'}.=':'.$syspriv;
3912: }
3913: if ($tdomain ne '') {
3914: if (defined($dompriv)) {
3915: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3916: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3917: }
3918: if (($trest ne '') && (defined($coursepriv))) {
3919: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3920: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3921: }
3922: }
3923: }
3924: }
3925: }
3926:
3927: sub group_roleprivs {
3928: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3929: my $access = 1;
3930: my $now = time;
3931: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3932: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3933: if ($access) {
3934: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
3935: $$allgroups{$course}{$group} .=':'.$group_privs;
3936: }
3937: }
3938:
3939: sub standard_roleprivs {
3940: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3941: if (defined($pr{$trole.':s'})) {
3942: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3943: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3944: }
3945: if ($tdomain ne '') {
3946: if (defined($pr{$trole.':d'})) {
3947: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3948: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3949: }
3950: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3951: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3952: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3953: }
3954: }
3955: }
3956:
3957: sub set_userprivs {
3958: my ($userroles,$allroles,$allgroups) = @_;
3959: my $author=0;
3960: my $adv=0;
3961: my %grouproles = ();
3962: if (keys(%{$allgroups}) > 0) {
3963: foreach my $role (keys(%{$allroles})) {
3964: my ($trole,$area,$sec,$extendedarea);
3965: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
3966: $trole = $1;
3967: $area = $2;
3968: $sec = $3;
3969: $extendedarea = $area.$sec;
3970: if (exists($$allgroups{$area})) {
3971: foreach my $group (keys(%{$$allgroups{$area}})) {
3972: my $spec = $trole.'.'.$extendedarea;
3973: $grouproles{$spec.'.'.$area.'/'.$group} =
3974: $$allgroups{$area}{$group};
3975: }
3976: }
3977: }
3978: }
3979: }
3980: foreach my $group (keys(%grouproles)) {
3981: $$allroles{$group} = $grouproles{$group};
3982: }
3983: foreach my $role (keys(%{$allroles})) {
3984: my %thesepriv;
3985: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
3986: foreach my $item (split(/:/,$$allroles{$role})) {
3987: if ($item ne '') {
3988: my ($privilege,$restrictions)=split(/&/,$item);
3989: if ($restrictions eq '') {
3990: $thesepriv{$privilege}='F';
3991: } elsif ($thesepriv{$privilege} ne 'F') {
3992: $thesepriv{$privilege}.=$restrictions;
3993: }
3994: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3995: }
3996: }
3997: my $thesestr='';
3998: foreach my $priv (keys(%thesepriv)) {
3999: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4000: }
4001: $userroles->{'user.priv.'.$role} = $thesestr;
4002: }
4003: return ($author,$adv);
4004: }
4005:
4006: sub role_status {
4007: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
4008: my @pwhere = ();
4009: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4010: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4011: unless (!defined($$role) || $$role eq '') {
4012: $$where=join('.',@pwhere);
4013: $$trolecode=$$role.'.'.$$where;
4014: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4015: $$tstatus='is';
4016: if ($$tstart && $$tstart>$then) {
4017: $$tstatus='future';
4018: if ($$tstart<$now) {
4019: if ($$tstart && $$tstart>$refresh) {
4020: if (($$where ne '') && ($$role ne '')) {
4021: my (%allroles,%allgroups,$group_privs);
4022: my %userroles = (
4023: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4024: );
4025: my $spec=$$role.'.'.$$where;
4026: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4027: if ($$role eq 'gr') {
4028: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4029: $env{'user.name'})=@_;
4030: my ($trole) = split('_',$role,1);
4031: (undef,my $group_privs) = split(/\//,$trole);
4032: $group_privs = &unescape($group_privs);
4033: }
4034: if ($$role =~ /^cr\//) {
4035: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4036: } elsif ($$role eq 'gr') {
4037: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4038: $env{'user.name'});
4039: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
4040: (undef,my $group_privs) = split(/\//,$trole);
4041: $group_privs = &unescape($group_privs);
4042: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4043: } else {
4044: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4045: }
4046: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
4047: &appenv(\%userroles,[$$role,'cm']);
4048: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4049: }
4050: }
4051: $$tstatus = 'is';
4052: }
4053: }
4054: if ($$tend) {
4055: if ($$tend<$then) {
4056: $$tstatus='expired';
4057: } elsif ($$tend<$now) {
4058: $$tstatus='will_not';
4059: }
4060: }
4061: }
4062: }
4063: }
4064:
4065: sub check_adhoc_privs {
4066: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
4067: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4068: if ($env{$cckey}) {
4069: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
4070: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
4071: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4072: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4073: }
4074: } else {
4075: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4076: }
4077: }
4078:
4079: sub set_adhoc_privileges {
4080: # role can be cc or ca
4081: my ($dcdom,$pickedcourse,$role) = @_;
4082: my $area = '/'.$dcdom.'/'.$pickedcourse;
4083: my $spec = $role.'.'.$area;
4084: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4085: $env{'user.name'});
4086: my %ccrole = ();
4087: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4088: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4089: &appenv(\%userroles,[$role,'cm']);
4090: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4091: &appenv( {'request.role' => $spec,
4092: 'request.role.domain' => $dcdom,
4093: 'request.course.sec' => ''
4094: }
4095: );
4096: my $tadv=0;
4097: if (&allowed('adv') eq 'F') { $tadv=1; }
4098: &appenv({'request.role.adv' => $tadv});
4099: }
4100:
4101: # --------------------------------------------------------------- get interface
4102:
4103: sub get {
4104: my ($namespace,$storearr,$udomain,$uname)=@_;
4105: my $items='';
4106: foreach my $item (@$storearr) {
4107: $items.=&escape($item).'&';
4108: }
4109: $items=~s/\&$//;
4110: if (!$udomain) { $udomain=$env{'user.domain'}; }
4111: if (!$uname) { $uname=$env{'user.name'}; }
4112: my $uhome=&homeserver($uname,$udomain);
4113:
4114: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
4115: my @pairs=split(/\&/,$rep);
4116: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4117: return @pairs;
4118: }
4119: my %returnhash=();
4120: my $i=0;
4121: foreach my $item (@$storearr) {
4122: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4123: $i++;
4124: }
4125: return %returnhash;
4126: }
4127:
4128: # --------------------------------------------------------------- del interface
4129:
4130: sub del {
4131: my ($namespace,$storearr,$udomain,$uname)=@_;
4132: my $items='';
4133: foreach my $item (@$storearr) {
4134: $items.=&escape($item).'&';
4135: }
4136:
4137: $items=~s/\&$//;
4138: if (!$udomain) { $udomain=$env{'user.domain'}; }
4139: if (!$uname) { $uname=$env{'user.name'}; }
4140: my $uhome=&homeserver($uname,$udomain);
4141: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
4142: }
4143:
4144: # -------------------------------------------------------------- dump interface
4145:
4146: sub dump {
4147: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4148: if (!$udomain) { $udomain=$env{'user.domain'}; }
4149: if (!$uname) { $uname=$env{'user.name'}; }
4150: my $uhome=&homeserver($uname,$udomain);
4151: if ($regexp) {
4152: $regexp=&escape($regexp);
4153: } else {
4154: $regexp='.';
4155: }
4156: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4157: my @pairs=split(/\&/,$rep);
4158: my %returnhash=();
4159: foreach my $item (@pairs) {
4160: my ($key,$value)=split(/=/,$item,2);
4161: $key = &unescape($key);
4162: next if ($key =~ /^error: 2 /);
4163: $returnhash{$key}=&thaw_unescape($value);
4164: }
4165: return %returnhash;
4166: }
4167:
4168: # --------------------------------------------------------- dumpstore interface
4169:
4170: sub dumpstore {
4171: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4172: if (!$udomain) { $udomain=$env{'user.domain'}; }
4173: if (!$uname) { $uname=$env{'user.name'}; }
4174: my $uhome=&homeserver($uname,$udomain);
4175: if ($regexp) {
4176: $regexp=&escape($regexp);
4177: } else {
4178: $regexp='.';
4179: }
4180: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4181: my @pairs=split(/\&/,$rep);
4182: my %returnhash=();
4183: foreach my $item (@pairs) {
4184: my ($key,$value)=split(/=/,$item,2);
4185: next if ($key =~ /^error: 2 /);
4186: $returnhash{$key}=&thaw_unescape($value);
4187: }
4188: return %returnhash;
4189: }
4190:
4191: # -------------------------------------------------------------- keys interface
4192:
4193: sub getkeys {
4194: my ($namespace,$udomain,$uname)=@_;
4195: if (!$udomain) { $udomain=$env{'user.domain'}; }
4196: if (!$uname) { $uname=$env{'user.name'}; }
4197: my $uhome=&homeserver($uname,$udomain);
4198: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4199: my @keyarray=();
4200: foreach my $key (split(/\&/,$rep)) {
4201: next if ($key =~ /^error: 2 /);
4202: push(@keyarray,&unescape($key));
4203: }
4204: return @keyarray;
4205: }
4206:
4207: # --------------------------------------------------------------- currentdump
4208: sub currentdump {
4209: my ($courseid,$sdom,$sname)=@_;
4210: $courseid = $env{'request.course.id'} if (! defined($courseid));
4211: $sdom = $env{'user.domain'} if (! defined($sdom));
4212: $sname = $env{'user.name'} if (! defined($sname));
4213: my $uhome = &homeserver($sname,$sdom);
4214: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
4215: return if ($rep =~ /^(error:|no_such_host)/);
4216: #
4217: my %returnhash=();
4218: #
4219: if ($rep eq "unknown_cmd") {
4220: # an old lond will not know currentdump
4221: # Do a dump and make it look like a currentdump
4222: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
4223: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4224: my %hash = @tmp;
4225: @tmp=();
4226: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
4227: } else {
4228: my @pairs=split(/\&/,$rep);
4229: foreach my $pair (@pairs) {
4230: my ($key,$value)=split(/=/,$pair,2);
4231: my ($symb,$param) = split(/:/,$key);
4232: $returnhash{&unescape($symb)}->{&unescape($param)} =
4233: &thaw_unescape($value);
4234: }
4235: }
4236: return %returnhash;
4237: }
4238:
4239: sub convert_dump_to_currentdump{
4240: my %hash = %{shift()};
4241: my %returnhash;
4242: # Code ripped from lond, essentially. The only difference
4243: # here is the unescaping done by lonnet::dump(). Conceivably
4244: # we might run in to problems with parameter names =~ /^v\./
4245: while (my ($key,$value) = each(%hash)) {
4246: my ($v,$symb,$param) = split(/:/,$key);
4247: $symb = &unescape($symb);
4248: $param = &unescape($param);
4249: next if ($v eq 'version' || $symb eq 'keys');
4250: next if (exists($returnhash{$symb}) &&
4251: exists($returnhash{$symb}->{$param}) &&
4252: $returnhash{$symb}->{'v.'.$param} > $v);
4253: $returnhash{$symb}->{$param}=$value;
4254: $returnhash{$symb}->{'v.'.$param}=$v;
4255: }
4256: #
4257: # Remove all of the keys in the hashes which keep track of
4258: # the version of the parameter.
4259: while (my ($symb,$param_hash) = each(%returnhash)) {
4260: # use a foreach because we are going to delete from the hash.
4261: foreach my $key (keys(%$param_hash)) {
4262: delete($param_hash->{$key}) if ($key =~ /^v\./);
4263: }
4264: }
4265: return \%returnhash;
4266: }
4267:
4268: # ------------------------------------------------------ critical inc interface
4269:
4270: sub cinc {
4271: return &inc(@_,'critical');
4272: }
4273:
4274: # --------------------------------------------------------------- inc interface
4275:
4276: sub inc {
4277: my ($namespace,$store,$udomain,$uname,$critical) = @_;
4278: if (!$udomain) { $udomain=$env{'user.domain'}; }
4279: if (!$uname) { $uname=$env{'user.name'}; }
4280: my $uhome=&homeserver($uname,$udomain);
4281: my $items='';
4282: if (! ref($store)) {
4283: # got a single value, so use that instead
4284: $items = &escape($store).'=&';
4285: } elsif (ref($store) eq 'SCALAR') {
4286: $items = &escape($$store).'=&';
4287: } elsif (ref($store) eq 'ARRAY') {
4288: $items = join('=&',map {&escape($_);} @{$store});
4289: } elsif (ref($store) eq 'HASH') {
4290: while (my($key,$value) = each(%{$store})) {
4291: $items.= &escape($key).'='.&escape($value).'&';
4292: }
4293: }
4294: $items=~s/\&$//;
4295: if ($critical) {
4296: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4297: } else {
4298: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4299: }
4300: }
4301:
4302: # --------------------------------------------------------------- put interface
4303:
4304: sub put {
4305: my ($namespace,$storehash,$udomain,$uname)=@_;
4306: if (!$udomain) { $udomain=$env{'user.domain'}; }
4307: if (!$uname) { $uname=$env{'user.name'}; }
4308: my $uhome=&homeserver($uname,$udomain);
4309: my $items='';
4310: foreach my $item (keys(%$storehash)) {
4311: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4312: }
4313: $items=~s/\&$//;
4314: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4315: }
4316:
4317: # ------------------------------------------------------------ newput interface
4318:
4319: sub newput {
4320: my ($namespace,$storehash,$udomain,$uname)=@_;
4321: if (!$udomain) { $udomain=$env{'user.domain'}; }
4322: if (!$uname) { $uname=$env{'user.name'}; }
4323: my $uhome=&homeserver($uname,$udomain);
4324: my $items='';
4325: foreach my $key (keys(%$storehash)) {
4326: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4327: }
4328: $items=~s/\&$//;
4329: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4330: }
4331:
4332: # --------------------------------------------------------- putstore interface
4333:
4334: sub putstore {
4335: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4336: if (!$udomain) { $udomain=$env{'user.domain'}; }
4337: if (!$uname) { $uname=$env{'user.name'}; }
4338: my $uhome=&homeserver($uname,$udomain);
4339: my $items='';
4340: foreach my $key (keys(%$storehash)) {
4341: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
4342: }
4343: $items=~s/\&$//;
4344: my $esc_symb=&escape($symb);
4345: my $esc_v=&escape($version);
4346: my $reply =
4347: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
4348: $uhome);
4349: if ($reply eq 'unknown_cmd') {
4350: # gfall back to way things use to be done
4351: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4352: $uname);
4353: }
4354: return $reply;
4355: }
4356:
4357: sub old_putstore {
4358: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4359: if (!$udomain) { $udomain=$env{'user.domain'}; }
4360: if (!$uname) { $uname=$env{'user.name'}; }
4361: my $uhome=&homeserver($uname,$udomain);
4362: my %newstorehash;
4363: foreach my $item (keys(%$storehash)) {
4364: my $key = $version.':'.&escape($symb).':'.$item;
4365: $newstorehash{$key} = $storehash->{$item};
4366: }
4367: my $items='';
4368: my %allitems = ();
4369: foreach my $item (keys(%newstorehash)) {
4370: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
4371: my $key = $1.':keys:'.$2;
4372: $allitems{$key} .= $3.':';
4373: }
4374: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
4375: }
4376: foreach my $item (keys(%allitems)) {
4377: $allitems{$item} =~ s/\:$//;
4378: $items.= $item.'='.$allitems{$item}.'&';
4379: }
4380: $items=~s/\&$//;
4381: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
4382: }
4383:
4384: # ------------------------------------------------------ critical put interface
4385:
4386: sub cput {
4387: my ($namespace,$storehash,$udomain,$uname)=@_;
4388: if (!$udomain) { $udomain=$env{'user.domain'}; }
4389: if (!$uname) { $uname=$env{'user.name'}; }
4390: my $uhome=&homeserver($uname,$udomain);
4391: my $items='';
4392: foreach my $item (keys(%$storehash)) {
4393: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4394: }
4395: $items=~s/\&$//;
4396: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
4397: }
4398:
4399: # -------------------------------------------------------------- eget interface
4400:
4401: sub eget {
4402: my ($namespace,$storearr,$udomain,$uname)=@_;
4403: my $items='';
4404: foreach my $item (@$storearr) {
4405: $items.=&escape($item).'&';
4406: }
4407: $items=~s/\&$//;
4408: if (!$udomain) { $udomain=$env{'user.domain'}; }
4409: if (!$uname) { $uname=$env{'user.name'}; }
4410: my $uhome=&homeserver($uname,$udomain);
4411: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
4412: my @pairs=split(/\&/,$rep);
4413: my %returnhash=();
4414: my $i=0;
4415: foreach my $item (@$storearr) {
4416: $returnhash{$item}=&thaw_unescape($pairs[$i]);
4417: $i++;
4418: }
4419: return %returnhash;
4420: }
4421:
4422: # ------------------------------------------------------------ tmpput interface
4423: sub tmpput {
4424: my ($storehash,$server,$context)=@_;
4425: my $items='';
4426: foreach my $item (keys(%$storehash)) {
4427: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
4428: }
4429: $items=~s/\&$//;
4430: if (defined($context)) {
4431: $items .= ':'.&escape($context);
4432: }
4433: return &reply("tmpput:$items",$server);
4434: }
4435:
4436: # ------------------------------------------------------------ tmpget interface
4437: sub tmpget {
4438: my ($token,$server)=@_;
4439: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4440: my $rep=&reply("tmpget:$token",$server);
4441: my %returnhash;
4442: foreach my $item (split(/\&/,$rep)) {
4443: my ($key,$value)=split(/=/,$item);
4444: next if ($key =~ /^error: 2 /);
4445: $returnhash{&unescape($key)}=&thaw_unescape($value);
4446: }
4447: return %returnhash;
4448: }
4449:
4450: # ------------------------------------------------------------ tmpget interface
4451: sub tmpdel {
4452: my ($token,$server)=@_;
4453: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4454: return &reply("tmpdel:$token",$server);
4455: }
4456:
4457: # -------------------------------------------------- portfolio access checking
4458:
4459: sub portfolio_access {
4460: my ($requrl) = @_;
4461: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4462: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
4463: if ($result) {
4464: my %setters;
4465: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4466: my ($startblock,$endblock) =
4467: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4468: if ($startblock && $endblock) {
4469: return 'B';
4470: }
4471: } else {
4472: my ($startblock,$endblock) =
4473: &Apache::loncommon::blockcheck(\%setters,'port');
4474: if ($startblock && $endblock) {
4475: return 'B';
4476: }
4477: }
4478: }
4479: if ($result eq 'ok') {
4480: return 'F';
4481: } elsif ($result =~ /^[^:]+:guest_/) {
4482: return 'A';
4483: }
4484: return '';
4485: }
4486:
4487: sub get_portfolio_access {
4488: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4489:
4490: if (!ref($access_hash)) {
4491: my $current_perms = &get_portfile_permissions($udom,$unum);
4492: my %access_controls = &get_access_controls($current_perms,$group,
4493: $file_name);
4494: $access_hash = $access_controls{$file_name};
4495: }
4496:
4497: my ($public,$guest,@domains,@users,@courses,@groups);
4498: my $now = time;
4499: if (ref($access_hash) eq 'HASH') {
4500: foreach my $key (keys(%{$access_hash})) {
4501: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4502: if ($start > $now) {
4503: next;
4504: }
4505: if ($end && $end<$now) {
4506: next;
4507: }
4508: if ($scope eq 'public') {
4509: $public = $key;
4510: last;
4511: } elsif ($scope eq 'guest') {
4512: $guest = $key;
4513: } elsif ($scope eq 'domains') {
4514: push(@domains,$key);
4515: } elsif ($scope eq 'users') {
4516: push(@users,$key);
4517: } elsif ($scope eq 'course') {
4518: push(@courses,$key);
4519: } elsif ($scope eq 'group') {
4520: push(@groups,$key);
4521: }
4522: }
4523: if ($public) {
4524: return 'ok';
4525: }
4526: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4527: if ($guest) {
4528: return $guest;
4529: }
4530: } else {
4531: if (@domains > 0) {
4532: foreach my $domkey (@domains) {
4533: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4534: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4535: return 'ok';
4536: }
4537: }
4538: }
4539: }
4540: if (@users > 0) {
4541: foreach my $userkey (@users) {
4542: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4543: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4544: if (ref($item) eq 'HASH') {
4545: if (($item->{'uname'} eq $env{'user.name'}) &&
4546: ($item->{'udom'} eq $env{'user.domain'})) {
4547: return 'ok';
4548: }
4549: }
4550: }
4551: }
4552: }
4553: }
4554: my %roleshash;
4555: my @courses_and_groups = @courses;
4556: push(@courses_and_groups,@groups);
4557: if (@courses_and_groups > 0) {
4558: my (%allgroups,%allroles);
4559: my ($start,$end,$role,$sec,$group);
4560: foreach my $envkey (%env) {
4561: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
4562: my $cid = $2.'_'.$3;
4563: if ($1 eq 'gr') {
4564: $group = $4;
4565: $allgroups{$cid}{$group} = $env{$envkey};
4566: } else {
4567: if ($4 eq '') {
4568: $sec = 'none';
4569: } else {
4570: $sec = $4;
4571: }
4572: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4573: }
4574: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
4575: my $cid = $2.'_'.$3;
4576: if ($4 eq '') {
4577: $sec = 'none';
4578: } else {
4579: $sec = $4;
4580: }
4581: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4582: }
4583: }
4584: if (keys(%allroles) == 0) {
4585: return;
4586: }
4587: foreach my $key (@courses_and_groups) {
4588: my %content = %{$$access_hash{$key}};
4589: my $cnum = $content{'number'};
4590: my $cdom = $content{'domain'};
4591: my $cid = $cdom.'_'.$cnum;
4592: if (!exists($allroles{$cid})) {
4593: next;
4594: }
4595: foreach my $role_id (keys(%{$content{'roles'}})) {
4596: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4597: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4598: my @status = @{$content{'roles'}{$role_id}{'access'}};
4599: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4600: foreach my $role (keys(%{$allroles{$cid}})) {
4601: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4602: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4603: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4604: if (grep/^all$/,@sections) {
4605: return 'ok';
4606: } else {
4607: if (grep/^$sec$/,@sections) {
4608: return 'ok';
4609: }
4610: }
4611: }
4612: }
4613: if (keys(%{$allgroups{$cid}}) == 0) {
4614: if (grep/^none$/,@groups) {
4615: return 'ok';
4616: }
4617: } else {
4618: if (grep/^all$/,@groups) {
4619: return 'ok';
4620: }
4621: foreach my $group (keys(%{$allgroups{$cid}})) {
4622: if (grep/^$group$/,@groups) {
4623: return 'ok';
4624: }
4625: }
4626: }
4627: }
4628: }
4629: }
4630: }
4631: }
4632: if ($guest) {
4633: return $guest;
4634: }
4635: }
4636: }
4637: return;
4638: }
4639:
4640: sub course_group_datechecker {
4641: my ($dates,$now,$status) = @_;
4642: my ($start,$end) = split(/\./,$dates);
4643: if (!$start && !$end) {
4644: return 'ok';
4645: }
4646: if (grep/^active$/,@{$status}) {
4647: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4648: return 'ok';
4649: }
4650: }
4651: if (grep/^previous$/,@{$status}) {
4652: if ($end > $now ) {
4653: return 'ok';
4654: }
4655: }
4656: if (grep/^future$/,@{$status}) {
4657: if ($start > $now) {
4658: return 'ok';
4659: }
4660: }
4661: return;
4662: }
4663:
4664: sub parse_portfolio_url {
4665: my ($url) = @_;
4666:
4667: my ($type,$udom,$unum,$group,$file_name);
4668:
4669: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
4670: $type = 1;
4671: $udom = $1;
4672: $unum = $2;
4673: $file_name = $3;
4674: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
4675: $type = 2;
4676: $udom = $1;
4677: $unum = $2;
4678: $group = $3;
4679: $file_name = $3.'/'.$4;
4680: }
4681: if (wantarray) {
4682: return ($type,$udom,$unum,$file_name,$group);
4683: }
4684: return $type;
4685: }
4686:
4687: sub is_portfolio_url {
4688: my ($url) = @_;
4689: return scalar(&parse_portfolio_url($url));
4690: }
4691:
4692: sub is_portfolio_file {
4693: my ($file) = @_;
4694: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
4695: return 1;
4696: }
4697: return;
4698: }
4699:
4700: sub usertools_access {
4701: my ($uname,$udom,$tool,$action,$context) = @_;
4702: my ($access,%tools);
4703: if ($context eq '') {
4704: $context = 'tools';
4705: }
4706: if ($context eq 'requestcourses') {
4707: %tools = (
4708: official => 1,
4709: unofficial => 1,
4710: community => 1,
4711: );
4712: } else {
4713: %tools = (
4714: aboutme => 1,
4715: blog => 1,
4716: portfolio => 1,
4717: );
4718: }
4719: return if (!defined($tools{$tool}));
4720:
4721: if ((!defined($udom)) || (!defined($uname))) {
4722: $udom = $env{'user.domain'};
4723: $uname = $env{'user.name'};
4724: }
4725:
4726: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4727: if ($action ne 'reload') {
4728: if ($context eq 'requestcourses') {
4729: return $env{'environment.canrequest.'.$tool};
4730: } else {
4731: return $env{'environment.availabletools.'.$tool};
4732: }
4733: }
4734: }
4735:
4736: my ($toolstatus,$inststatus);
4737:
4738: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4739: ($action ne 'reload')) {
4740: $toolstatus = $env{'environment.'.$context.'.'.$tool};
4741: $inststatus = $env{'environment.inststatus'};
4742: } else {
4743: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
4744: $toolstatus = $userenv{$context.'.'.$tool};
4745: $inststatus = $userenv{'inststatus'};
4746: }
4747:
4748: if ($toolstatus ne '') {
4749: if ($toolstatus) {
4750: $access = 1;
4751: } else {
4752: $access = 0;
4753: }
4754: return $access;
4755: }
4756:
4757: my $is_adv = &is_advanced_user($udom,$uname);
4758: my %domdef = &get_domain_defaults($udom);
4759: if (ref($domdef{$tool}) eq 'HASH') {
4760: if ($is_adv) {
4761: if ($domdef{$tool}{'_LC_adv'} ne '') {
4762: if ($domdef{$tool}{'_LC_adv'}) {
4763: $access = 1;
4764: } else {
4765: $access = 0;
4766: }
4767: return $access;
4768: }
4769: }
4770: if ($inststatus ne '') {
4771: my ($hasaccess,$hasnoaccess);
4772: foreach my $affiliation (split(/:/,$inststatus)) {
4773: if ($domdef{$tool}{$affiliation} ne '') {
4774: if ($domdef{$tool}{$affiliation}) {
4775: $hasaccess = 1;
4776: } else {
4777: $hasnoaccess = 1;
4778: }
4779: }
4780: }
4781: if ($hasaccess || $hasnoaccess) {
4782: if ($hasaccess) {
4783: $access = 1;
4784: } elsif ($hasnoaccess) {
4785: $access = 0;
4786: }
4787: return $access;
4788: }
4789: } else {
4790: if ($domdef{$tool}{'default'} ne '') {
4791: if ($domdef{$tool}{'default'}) {
4792: $access = 1;
4793: } elsif ($domdef{$tool}{'default'} == 0) {
4794: $access = 0;
4795: }
4796: return $access;
4797: }
4798: }
4799: } else {
4800: if ($context eq 'tools') {
4801: $access = 1;
4802: } else {
4803: $access = 0;
4804: }
4805: return $access;
4806: }
4807: }
4808:
4809: sub is_advanced_user {
4810: my ($udom,$uname) = @_;
4811: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4812: my %allroles;
4813: my $is_adv;
4814: foreach my $role (keys(%roleshash)) {
4815: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4816: my $area = '/'.$tdomain.'/'.$trest;
4817: if ($sec ne '') {
4818: $area .= '/'.$sec;
4819: }
4820: if (($area ne '') && ($trole ne '')) {
4821: my $spec=$trole.'.'.$area;
4822: if ($trole =~ /^cr\//) {
4823: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4824: } elsif ($trole ne 'gr') {
4825: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4826: }
4827: }
4828: }
4829: foreach my $role (keys(%allroles)) {
4830: last if ($is_adv);
4831: foreach my $item (split(/:/,$allroles{$role})) {
4832: if ($item ne '') {
4833: my ($privilege,$restrictions)=split(/&/,$item);
4834: if ($privilege eq 'adv') {
4835: $is_adv = 1;
4836: last;
4837: }
4838: }
4839: }
4840: }
4841: return $is_adv;
4842: }
4843:
4844: sub check_can_request {
4845: my ($dom,$can_request,$request_domains) = @_;
4846: my $canreq = 0;
4847: my ($types,$typename) = &Apache::loncommon::course_types();
4848: my @options = ('approval','validate','autolimit');
4849: my $optregex = join('|',@options);
4850: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4851: foreach my $type (@{$types}) {
4852: if (&usertools_access($env{'user.name'},
4853: $env{'user.domain'},
4854: $type,undef,'requestcourses')) {
4855: $canreq ++;
4856: if (ref($request_domains) eq 'HASH') {
4857: push(@{$request_domains->{$type}},$env{'user.domain'});
4858: }
4859: if ($dom eq $env{'user.domain'}) {
4860: $can_request->{$type} = 1;
4861: }
4862: }
4863: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4864: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4865: if (@curr > 0) {
4866: foreach my $item (@curr) {
4867: if (ref($request_domains) eq 'HASH') {
4868: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4869: if ($otherdom ne '') {
4870: if (ref($request_domains->{$type}) eq 'ARRAY') {
4871: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4872: push(@{$request_domains->{$type}},$otherdom);
4873: }
4874: } else {
4875: push(@{$request_domains->{$type}},$otherdom);
4876: }
4877: }
4878: }
4879: }
4880: unless($dom eq $env{'user.domain'}) {
4881: $canreq ++;
4882: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4883: $can_request->{$type} = 1;
4884: }
4885: }
4886: }
4887: }
4888: }
4889: }
4890: return $canreq;
4891: }
4892:
4893: # ---------------------------------------------- Custom access rule evaluation
4894:
4895: sub customaccess {
4896: my ($priv,$uri)=@_;
4897: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
4898: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
4899: $udom = &LONCAPA::clean_domain($udom);
4900: $ucrs = &LONCAPA::clean_username($ucrs);
4901: my $access=0;
4902: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
4903: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4904: if ($type eq 'user') {
4905: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4906: my ($tdom,$tuname)=split(m{/},$scope);
4907: if ($tdom) {
4908: if ($tdom ne $env{'user.domain'}) { next; }
4909: }
4910: if ($tuname) {
4911: if ($tuname ne $env{'user.name'}) { next; }
4912: }
4913: $access=($effect eq 'allow');
4914: last;
4915: }
4916: } else {
4917: if ($role) {
4918: if ($role ne $urole) { next; }
4919: }
4920: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4921: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4922: if ($tdom) {
4923: if ($tdom ne $udom) { next; }
4924: }
4925: if ($tcrs) {
4926: if ($tcrs ne $ucrs) { next; }
4927: }
4928: if ($tsec) {
4929: if ($tsec ne $usec) { next; }
4930: }
4931: $access=($effect eq 'allow');
4932: last;
4933: }
4934: if ($realm eq '' && $role eq '') {
4935: $access=($effect eq 'allow');
4936: }
4937: }
4938: }
4939: return $access;
4940: }
4941:
4942: # ------------------------------------------------- Check for a user privilege
4943:
4944: sub allowed {
4945: my ($priv,$uri,$symb,$role)=@_;
4946: my $ver_orguri=$uri;
4947: $uri=&deversion($uri);
4948: my $orguri=$uri;
4949: $uri=&declutter($uri);
4950:
4951: if ($priv eq 'evb') {
4952: # Evade communication block restrictions for specified role in a course
4953: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4954: return $1;
4955: } else {
4956: return;
4957: }
4958: }
4959:
4960: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
4961: # Free bre access to adm and meta resources
4962: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
4963: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4964: && ($priv eq 'bre')) {
4965: return 'F';
4966: }
4967:
4968: # Free bre access to user's own portfolio contents
4969: my ($space,$domain,$name,@dir)=split('/',$uri);
4970: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
4971: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
4972: my %setters;
4973: my ($startblock,$endblock) =
4974: &Apache::loncommon::blockcheck(\%setters,'port');
4975: if ($startblock && $endblock) {
4976: return 'B';
4977: } else {
4978: return 'F';
4979: }
4980: }
4981:
4982: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
4983: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4984: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4985: if (exists($env{'request.course.id'})) {
4986: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4987: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4988: if (($domain eq $cdom) && ($name eq $cnum)) {
4989: my $courseprivid=$env{'request.course.id'};
4990: $courseprivid=~s/\_/\//;
4991: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4992: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4993: return $1;
4994: } else {
4995: if ($env{'request.course.sec'}) {
4996: $courseprivid.='/'.$env{'request.course.sec'};
4997: }
4998: if ($env{'user.priv.'.$env{'request.role'}.'./'.
4999: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5000: return $2;
5001: }
5002: }
5003: }
5004: }
5005: }
5006:
5007: # Free bre to public access
5008:
5009: if ($priv eq 'bre') {
5010: my $copyright=&metadata($uri,'copyright');
5011: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
5012: return 'F';
5013: }
5014: if ($copyright eq 'priv') {
5015: $uri=~/([^\/]+)\/([^\/]+)\//;
5016: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
5017: return '';
5018: }
5019: }
5020: if ($copyright eq 'domain') {
5021: $uri=~/([^\/]+)\/([^\/]+)\//;
5022: unless (($env{'user.domain'} eq $1) ||
5023: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
5024: return '';
5025: }
5026: }
5027: if ($env{'request.role'}=~ /li\.\//) {
5028: # Library role, so allow browsing of resources in this domain.
5029: return 'F';
5030: }
5031: if ($copyright eq 'custom') {
5032: unless (&customaccess($priv,$uri)) { return ''; }
5033: }
5034: }
5035: # Domain coordinator is trying to create a course
5036: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
5037: # uri is the requested domain in this case.
5038: # comparison to 'request.role.domain' shows if the user has selected
5039: # a role of dc for the domain in question.
5040: return 'F' if ($uri eq $env{'request.role.domain'});
5041: }
5042:
5043: my $thisallowed='';
5044: my $statecond=0;
5045: my $courseprivid='';
5046:
5047: my $ownaccess;
5048: # Community Coordinator browsing resource space.
5049: if (($priv eq 'bro') && ($env{'user.author'})) {
5050: if ($uri eq '') {
5051: $ownaccess = 1;
5052: } else {
5053: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5054: my $udom = $env{'user.domain'};
5055: my $uname = $env{'user.name'};
5056: if ($uri =~ m{^\Q$udom\E/?$}) {
5057: $ownaccess = 1;
5058: } elsif ($uri =~ m{^\Q$udom/\E/$uname/}) {
5059: unless ($uri =~ m{\.\./}) {
5060: $ownaccess = 1;
5061: }
5062: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5063: my $now = time;
5064: if ($uri =~ m{^([^/]+)/?$}) {
5065: my $adom = $1;
5066: foreach my $key (keys(%env)) {
5067: if ($key =~ m{^user\.role\.ca/\Q$adom\E}) {
5068: my ($start,$end) = split('.',$env{$key});
5069: if (($now >= $start) && (!$end || $end < $now)) {
5070: $ownaccess = 1;
5071: last;
5072: }
5073: }
5074: }
5075: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5076: my $adom = $1;
5077: my $aname = $2;
5078: if ($env{"user.role.ca./$adom/$aname"}) {
5079: my ($start,$end) =
5080: split('.',$env{"user.role.ca./$adom/$aname"});
5081: if (($now >= $start) && (!$end || $end < $now)) {
5082: $ownaccess = 1;
5083: }
5084: }
5085: }
5086: }
5087: }
5088: }
5089: }
5090:
5091: # Course
5092:
5093: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
5094: unless (($priv eq 'bro' && !$ownaccess)) {
5095: $thisallowed.=$1;
5096: }
5097: }
5098:
5099: # Domain
5100:
5101: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
5102: =~/\Q$priv\E\&([^\:]*)/) {
5103: unless (($priv eq 'bro' && !$ownaccess)) {
5104: $thisallowed.=$1;
5105: }
5106: }
5107:
5108: # Course: uri itself is a course
5109: my $courseuri=$uri;
5110: $courseuri=~s/\_(\d)/\/$1/;
5111: $courseuri=~s/^([^\/])/\/$1/;
5112:
5113: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
5114: =~/\Q$priv\E\&([^\:]*)/) {
5115: unless (($priv eq 'bro' && !$ownaccess)) {
5116: $thisallowed.=$1;
5117: }
5118: }
5119:
5120: # URI is an uploaded document for this course, default permissions don't matter
5121: # not allowing 'edit' access (editupload) to uploaded course docs
5122: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
5123: $thisallowed='';
5124: my ($match)=&is_on_map($uri);
5125: if ($match) {
5126: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5127: =~/\Q$priv\E\&([^\:]*)/) {
5128: $thisallowed.=$1;
5129: }
5130: } else {
5131: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
5132: if ($refuri) {
5133: if ($refuri =~ m|^/adm/|) {
5134: $thisallowed='F';
5135: } else {
5136: $refuri=&declutter($refuri);
5137: my ($match) = &is_on_map($refuri);
5138: if ($match) {
5139: $thisallowed='F';
5140: }
5141: }
5142: }
5143: }
5144: }
5145:
5146: if ($priv eq 'bre'
5147: && $thisallowed ne 'F'
5148: && $thisallowed ne '2'
5149: && &is_portfolio_url($uri)) {
5150: $thisallowed = &portfolio_access($uri);
5151: }
5152:
5153: # Full access at system, domain or course-wide level? Exit.
5154: if ($thisallowed=~/F/) {
5155: return 'F';
5156: }
5157:
5158: # If this is generating or modifying users, exit with special codes
5159:
5160: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5161: if (($priv eq 'cca') || ($priv eq 'caa')) {
5162: my ($audom,$auname)=split('/',$uri);
5163: # no author name given, so this just checks on the general right to make a co-author in this domain
5164: unless ($auname) { return $thisallowed; }
5165: # an author name is given, so we are about to actually make a co-author for a certain account
5166: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5167: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5168: ($audom ne $env{'request.role.domain'}))) { return ''; }
5169: }
5170: return $thisallowed;
5171: }
5172: #
5173: # Gathered so far: system, domain and course wide privileges
5174: #
5175: # Course: See if uri or referer is an individual resource that is part of
5176: # the course
5177:
5178: if ($env{'request.course.id'}) {
5179:
5180: $courseprivid=$env{'request.course.id'};
5181: if ($env{'request.course.sec'}) {
5182: $courseprivid.='/'.$env{'request.course.sec'};
5183: }
5184: $courseprivid=~s/\_/\//;
5185: my $checkreferer=1;
5186: my ($match,$cond)=&is_on_map($uri);
5187: if ($match) {
5188: $statecond=$cond;
5189: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5190: =~/\Q$priv\E\&([^\:]*)/) {
5191: $thisallowed.=$1;
5192: $checkreferer=0;
5193: }
5194: }
5195:
5196: if ($checkreferer) {
5197: my $refuri=$env{'httpref.'.$orguri};
5198: unless ($refuri) {
5199: foreach my $key (keys(%env)) {
5200: if ($key=~/^httpref\..*\*/) {
5201: my $pattern=$key;
5202: $pattern=~s/^httpref\.\/res\///;
5203: $pattern=~s/\*/\[\^\/\]\+/g;
5204: $pattern=~s/\//\\\//g;
5205: if ($orguri=~/$pattern/) {
5206: $refuri=$env{$key};
5207: }
5208: }
5209: }
5210: }
5211:
5212: if ($refuri) {
5213: $refuri=&declutter($refuri);
5214: my ($match,$cond)=&is_on_map($refuri);
5215: if ($match) {
5216: my $refstatecond=$cond;
5217: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
5218: =~/\Q$priv\E\&([^\:]*)/) {
5219: $thisallowed.=$1;
5220: $uri=$refuri;
5221: $statecond=$refstatecond;
5222: }
5223: }
5224: }
5225: }
5226: }
5227:
5228: #
5229: # Gathered now: all privileges that could apply, and condition number
5230: #
5231: #
5232: # Full or no access?
5233: #
5234:
5235: if ($thisallowed=~/F/) {
5236: return 'F';
5237: }
5238:
5239: unless ($thisallowed) {
5240: return '';
5241: }
5242:
5243: # Restrictions exist, deal with them
5244: #
5245: # C:according to course preferences
5246: # R:according to resource settings
5247: # L:unless locked
5248: # X:according to user session state
5249: #
5250:
5251: # Possibly locked functionality, check all courses
5252: # Locks might take effect only after 10 minutes cache expiration for other
5253: # courses, and 2 minutes for current course
5254:
5255: my $envkey;
5256: if ($thisallowed=~/L/) {
5257: foreach $envkey (keys(%env)) {
5258: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5259: my $courseid=$2;
5260: my $roleid=$1.'.'.$2;
5261: $courseid=~s/^\///;
5262: my $expiretime=600;
5263: if ($env{'request.role'} eq $roleid) {
5264: $expiretime=120;
5265: }
5266: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5267: my $prefix='course.'.$cdom.'_'.$cnum.'.';
5268: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
5269: &coursedescription($courseid,{'freshen_cache' => 1});
5270: }
5271: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5272: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5273: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5274: &log($env{'user.domain'},$env{'user.name'},
5275: $env{'user.home'},
5276: 'Locked by res: '.$priv.' for '.$uri.' due to '.
5277: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5278: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5279: return '';
5280: }
5281: }
5282: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5283: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5284: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5285: &log($env{'user.domain'},$env{'user.name'},
5286: $env{'user.home'},
5287: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
5288: $cdom.'/'.$cnum.'/'.$csec.' expire '.
5289: $env{$prefix.'priv.'.$priv.'.lock.expire'});
5290: return '';
5291: }
5292: }
5293: }
5294: }
5295: }
5296:
5297: #
5298: # Rest of the restrictions depend on selected course
5299: #
5300:
5301: unless ($env{'request.course.id'}) {
5302: if ($thisallowed eq 'A') {
5303: return 'A';
5304: } elsif ($thisallowed eq 'B') {
5305: return 'B';
5306: } else {
5307: return '1';
5308: }
5309: }
5310:
5311: #
5312: # Now user is definitely in a course
5313: #
5314:
5315:
5316: # Course preferences
5317:
5318: if ($thisallowed=~/C/) {
5319: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5320: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5321: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
5322: =~/\Q$rolecode\E/) {
5323: if ($priv ne 'pch') {
5324: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5325: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5326: $env{'request.course.id'});
5327: }
5328: return '';
5329: }
5330:
5331: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
5332: =~/\Q$unamedom\E/) {
5333: if ($priv ne 'pch') {
5334: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5335: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5336: $env{'request.course.id'});
5337: }
5338: return '';
5339: }
5340: }
5341:
5342: # Resource preferences
5343:
5344: if ($thisallowed=~/R/) {
5345: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5346: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
5347: if ($priv ne 'pch') {
5348: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5349: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5350: }
5351: return '';
5352: }
5353: }
5354:
5355: # Restricted by state or randomout?
5356:
5357: if ($thisallowed=~/X/) {
5358: if ($env{'acc.randomout'}) {
5359: if (!$symb) { $symb=&symbread($uri,1); }
5360: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
5361: return '';
5362: }
5363: }
5364: if (&condval($statecond)) {
5365: return '2';
5366: } else {
5367: return '';
5368: }
5369: }
5370:
5371: if ($thisallowed eq 'A') {
5372: return 'A';
5373: } elsif ($thisallowed eq 'B') {
5374: return 'B';
5375: }
5376: return 'F';
5377: }
5378:
5379: sub split_uri_for_cond {
5380: my $uri=&deversion(&declutter(shift));
5381: my @uriparts=split(/\//,$uri);
5382: my $filename=pop(@uriparts);
5383: my $pathname=join('/',@uriparts);
5384: return ($pathname,$filename);
5385: }
5386: # --------------------------------------------------- Is a resource on the map?
5387:
5388: sub is_on_map {
5389: my ($pathname,$filename) = &split_uri_for_cond(shift);
5390: #Trying to find the conditional for the file
5391: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
5392: /\&\Q$filename\E\:([\d\|]+)\&/);
5393: if ($match) {
5394: return (1,$1);
5395: } else {
5396: return (0,0);
5397: }
5398: }
5399:
5400: # --------------------------------------------------------- Get symb from alias
5401:
5402: sub get_symb_from_alias {
5403: my $symb=shift;
5404: my ($map,$resid,$url)=&decode_symb($symb);
5405: # Already is a symb
5406: if ($url) { return $symb; }
5407: # Must be an alias
5408: my $aliassymb='';
5409: my %bighash;
5410: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5411: &GDBM_READER(),0640)) {
5412: my $rid=$bighash{'mapalias_'.$symb};
5413: if ($rid) {
5414: my ($mapid,$resid)=split(/\./,$rid);
5415: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5416: $resid,$bighash{'src_'.$rid});
5417: }
5418: untie %bighash;
5419: }
5420: return $aliassymb;
5421: }
5422:
5423: # ----------------------------------------------------------------- Define Role
5424:
5425: sub definerole {
5426: if (allowed('mcr','/')) {
5427: my ($rolename,$sysrole,$domrole,$courole)=@_;
5428: foreach my $role (split(':',$sysrole)) {
5429: my ($crole,$cqual)=split(/\&/,$role);
5430: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5431: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5432: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5433: return "refused:s:$crole&$cqual";
5434: }
5435: }
5436: }
5437: foreach my $role (split(':',$domrole)) {
5438: my ($crole,$cqual)=split(/\&/,$role);
5439: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5440: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5441: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
5442: return "refused:d:$crole&$cqual";
5443: }
5444: }
5445: }
5446: foreach my $role (split(':',$courole)) {
5447: my ($crole,$cqual)=split(/\&/,$role);
5448: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5449: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5450: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
5451: return "refused:c:$crole&$cqual";
5452: }
5453: }
5454: }
5455: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5456: "$env{'user.domain'}:$env{'user.name'}:".
5457: "rolesdef_$rolename=".
5458: escape($sysrole.'_'.$domrole.'_'.$courole);
5459: return reply($command,$env{'user.home'});
5460: } else {
5461: return 'refused';
5462: }
5463: }
5464:
5465: # ---------------- Make a metadata query against the network of library servers
5466:
5467: sub metadata_query {
5468: my ($query,$custom,$customshow,$server_array)=@_;
5469: my %rhash;
5470: my %libserv = &all_library();
5471: my @server_list = (defined($server_array) ? @$server_array
5472: : keys(%libserv) );
5473: for my $server (@server_list) {
5474: unless ($custom or $customshow) {
5475: my $reply=&reply("querysend:".&escape($query),$server);
5476: $rhash{$server}=$reply;
5477: }
5478: else {
5479: my $reply=&reply("querysend:".&escape($query).':'.
5480: &escape($custom).':'.&escape($customshow),
5481: $server);
5482: $rhash{$server}=$reply;
5483: }
5484: }
5485: return \%rhash;
5486: }
5487:
5488: # ----------------------------------------- Send log queries and wait for reply
5489:
5490: sub log_query {
5491: my ($uname,$udom,$query,%filters)=@_;
5492: my $uhome=&homeserver($uname,$udom);
5493: if ($uhome eq 'no_host') { return 'error: no_host'; }
5494: my $uhost=&hostname($uhome);
5495: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
5496: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5497: $uhome);
5498: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
5499: return get_query_reply($queryid);
5500: }
5501:
5502: # -------------------------- Update MySQL table for portfolio file
5503:
5504: sub update_portfolio_table {
5505: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
5506: if ($group ne '') {
5507: $file_name =~s /^\Q$group\E//;
5508: }
5509: my $homeserver = &homeserver($uname,$udom);
5510: my $queryid=
5511: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5512: ':'.&escape($file_name).':'.$action,$homeserver);
5513: my $reply = &get_query_reply($queryid);
5514: return $reply;
5515: }
5516:
5517: # -------------------------- Update MySQL allusers table
5518:
5519: sub update_allusers_table {
5520: my ($uname,$udom,$names) = @_;
5521: my $homeserver = &homeserver($uname,$udom);
5522: my $queryid=
5523: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5524: 'lastname='.&escape($names->{'lastname'}).'%%'.
5525: 'firstname='.&escape($names->{'firstname'}).'%%'.
5526: 'middlename='.&escape($names->{'middlename'}).'%%'.
5527: 'generation='.&escape($names->{'generation'}).'%%'.
5528: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5529: 'id='.&escape($names->{'id'}),$homeserver);
5530: my $reply = &get_query_reply($queryid);
5531: return $reply;
5532: }
5533:
5534: # ------- Request retrieval of institutional classlists for course(s)
5535:
5536: sub fetch_enrollment_query {
5537: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
5538: my $homeserver;
5539: my $maxtries = 1;
5540: if ($context eq 'automated') {
5541: $homeserver = $perlvar{'lonHostID'};
5542: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
5543: } else {
5544: $homeserver = &homeserver($cnum,$dom);
5545: }
5546: my $host=&hostname($homeserver);
5547: my $cmd = '';
5548: foreach my $affiliate (keys(%{$affiliatesref})) {
5549: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5550: }
5551: $cmd =~ s/%%$//;
5552: $cmd = &escape($cmd);
5553: my $query = 'fetchenrollment';
5554: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
5555: unless ($queryid=~/^\Q$host\E\_/) {
5556: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5557: return 'error: '.$queryid;
5558: }
5559: my $reply = &get_query_reply($queryid);
5560: my $tries = 1;
5561: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5562: $reply = &get_query_reply($queryid);
5563: $tries ++;
5564: }
5565: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5566: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5567: } else {
5568: my @responses = split(/:/,$reply);
5569: if ($homeserver eq $perlvar{'lonHostID'}) {
5570: foreach my $line (@responses) {
5571: my ($key,$value) = split(/=/,$line,2);
5572: $$replyref{$key} = $value;
5573: }
5574: } else {
5575: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
5576: foreach my $line (@responses) {
5577: my ($key,$value) = split(/=/,$line);
5578: $$replyref{$key} = $value;
5579: if ($value > 0) {
5580: foreach my $item (@{$$affiliatesref{$key}}) {
5581: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
5582: my $destname = $pathname.'/'.$filename;
5583: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
5584: if ($xml_classlist =~ /^error/) {
5585: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5586: } else {
5587: if ( open(FILE,">$destname") ) {
5588: print FILE &unescape($xml_classlist);
5589: close(FILE);
5590: } else {
5591: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
5592: }
5593: }
5594: }
5595: }
5596: }
5597: }
5598: return 'ok';
5599: }
5600: return 'error';
5601: }
5602:
5603: sub get_query_reply {
5604: my $queryid=shift;
5605: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5606: my $reply='';
5607: for (1..100) {
5608: sleep 2;
5609: if (-e $replyfile.'.end') {
5610: if (open(my $fh,$replyfile)) {
5611: $reply = join('',<$fh>);
5612: close($fh);
5613: } else { return 'error: reply_file_error'; }
5614: return &unescape($reply);
5615: }
5616: }
5617: return 'timeout:'.$queryid;
5618: }
5619:
5620: sub courselog_query {
5621: #
5622: # possible filters:
5623: # url: url or symb
5624: # username
5625: # domain
5626: # action: view, submit, grade
5627: # start: timestamp
5628: # end: timestamp
5629: #
5630: my (%filters)=@_;
5631: unless ($env{'request.course.id'}) { return 'no_course'; }
5632: if ($filters{'url'}) {
5633: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5634: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5635: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5636: }
5637: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5638: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
5639: return &log_query($cname,$cdom,'courselog',%filters);
5640: }
5641:
5642: sub userlog_query {
5643: #
5644: # possible filters:
5645: # action: log check role
5646: # start: timestamp
5647: # end: timestamp
5648: #
5649: my ($uname,$udom,%filters)=@_;
5650: return &log_query($uname,$udom,'userlog',%filters);
5651: }
5652:
5653: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5654:
5655: sub auto_run {
5656: my ($cnum,$cdom) = @_;
5657: my $response = 0;
5658: my $settings;
5659: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5660: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5661: $settings = $domconfig{'autoenroll'};
5662: if ($settings->{'run'} eq '1') {
5663: $response = 1;
5664: }
5665: } else {
5666: my $homeserver;
5667: if (&is_course($cdom,$cnum)) {
5668: $homeserver = &homeserver($cnum,$cdom);
5669: } else {
5670: $homeserver = &domain($cdom,'primary');
5671: }
5672: if ($homeserver ne 'no_host') {
5673: $response = &reply('autorun:'.$cdom,$homeserver);
5674: }
5675: }
5676: return $response;
5677: }
5678:
5679: sub auto_get_sections {
5680: my ($cnum,$cdom,$inst_coursecode) = @_;
5681: my $homeserver;
5682: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5683: $homeserver = &homeserver($cnum,$cdom);
5684: }
5685: if (!defined($homeserver)) {
5686: if ($cdom =~ /^$match_domain$/) {
5687: $homeserver = &domain($cdom,'primary');
5688: }
5689: }
5690: my @secs;
5691: if (defined($homeserver)) {
5692: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5693: unless ($response eq 'refused') {
5694: @secs = split(/:/,$response);
5695: }
5696: }
5697: return @secs;
5698: }
5699:
5700: sub auto_new_course {
5701: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5702: my $homeserver = &homeserver($cnum,$cdom);
5703: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
5704: return $response;
5705: }
5706:
5707: sub auto_validate_courseID {
5708: my ($cnum,$cdom,$inst_course_id) = @_;
5709: my $homeserver = &homeserver($cnum,$cdom);
5710: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
5711: return $response;
5712: }
5713:
5714: sub auto_validate_instcode {
5715: my ($cnum,$cdom,$instcode,$owner) = @_;
5716: my ($homeserver,$response);
5717: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5718: $homeserver = &homeserver($cnum,$cdom);
5719: }
5720: if (!defined($homeserver)) {
5721: if ($cdom =~ /^$match_domain$/) {
5722: $homeserver = &domain($cdom,'primary');
5723: }
5724: }
5725: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
5726: &escape($instcode).':'.&escape($owner),$homeserver));
5727: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5728: return ($outcome,$description);
5729: }
5730:
5731: sub auto_create_password {
5732: my ($cnum,$cdom,$authparam,$udom) = @_;
5733: my ($homeserver,$response);
5734: my $create_passwd = 0;
5735: my $authchk = '';
5736: if ($udom =~ /^$match_domain$/) {
5737: $homeserver = &domain($udom,'primary');
5738: }
5739: if ($homeserver eq '') {
5740: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5741: $homeserver = &homeserver($cnum,$cdom);
5742: }
5743: }
5744: if ($homeserver eq '') {
5745: $authchk = 'nodomain';
5746: } else {
5747: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5748: if ($response eq 'refused') {
5749: $authchk = 'refused';
5750: } else {
5751: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
5752: }
5753: }
5754: return ($authparam,$create_passwd,$authchk);
5755: }
5756:
5757: sub auto_photo_permission {
5758: my ($cnum,$cdom,$students) = @_;
5759: my $homeserver = &homeserver($cnum,$cdom);
5760: my ($outcome,$perm_reqd,$conditions) =
5761: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
5762: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5763: return (undef,undef);
5764: }
5765: return ($outcome,$perm_reqd,$conditions);
5766: }
5767:
5768: sub auto_checkphotos {
5769: my ($uname,$udom,$pid) = @_;
5770: my $homeserver = &homeserver($uname,$udom);
5771: my ($result,$resulttype);
5772: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
5773: &escape($uname).':'.&escape($pid),
5774: $homeserver));
5775: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5776: return (undef,undef);
5777: }
5778: if ($outcome) {
5779: ($result,$resulttype) = split(/:/,$outcome);
5780: }
5781: return ($result,$resulttype);
5782: }
5783:
5784: sub auto_photochoice {
5785: my ($cnum,$cdom) = @_;
5786: my $homeserver = &homeserver($cnum,$cdom);
5787: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
5788: &escape($cdom),
5789: $homeserver)));
5790: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5791: return (undef,undef);
5792: }
5793: return ($update,$comment);
5794: }
5795:
5796: sub auto_photoupdate {
5797: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5798: my $homeserver = &homeserver($cnum,$dom);
5799: my $host=&hostname($homeserver);
5800: my $cmd = '';
5801: my $maxtries = 1;
5802: foreach my $affiliate (keys(%{$affiliatesref})) {
5803: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
5804: }
5805: $cmd =~ s/%%$//;
5806: $cmd = &escape($cmd);
5807: my $query = 'institutionalphotos';
5808: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5809: unless ($queryid=~/^\Q$host\E\_/) {
5810: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5811: return 'error: '.$queryid;
5812: }
5813: my $reply = &get_query_reply($queryid);
5814: my $tries = 1;
5815: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5816: $reply = &get_query_reply($queryid);
5817: $tries ++;
5818: }
5819: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5820: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5821: } else {
5822: my @responses = split(/:/,$reply);
5823: my $outcome = shift(@responses);
5824: foreach my $item (@responses) {
5825: my ($key,$value) = split(/=/,$item);
5826: $$photo{$key} = $value;
5827: }
5828: return $outcome;
5829: }
5830: return 'error';
5831: }
5832:
5833: sub auto_instcode_format {
5834: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5835: $cat_order) = @_;
5836: my $courses = '';
5837: my @homeservers;
5838: if ($caller eq 'global') {
5839: my %servers = &get_servers($codedom,'library');
5840: foreach my $tryserver (keys(%servers)) {
5841: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5842: push(@homeservers,$tryserver);
5843: }
5844: }
5845: } elsif ($caller eq 'requests') {
5846: if ($codedom =~ /^$match_domain$/) {
5847: my $chome = &domain($codedom,'primary');
5848: unless ($chome eq 'no_host') {
5849: push(@homeservers,$chome);
5850: }
5851: }
5852: } else {
5853: push(@homeservers,&homeserver($caller,$codedom));
5854: }
5855: foreach my $code (keys(%{$instcodes})) {
5856: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
5857: }
5858: chop($courses);
5859: my $ok_response = 0;
5860: my $response;
5861: while (@homeservers > 0 && $ok_response == 0) {
5862: my $server = shift(@homeservers);
5863: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5864: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5865: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
5866: split(/:/,$response);
5867: %{$codes} = (%{$codes},&str2hash($codes_str));
5868: push(@{$codetitles},&str2array($codetitles_str));
5869: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5870: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5871: $ok_response = 1;
5872: }
5873: }
5874: if ($ok_response) {
5875: return 'ok';
5876: } else {
5877: return $response;
5878: }
5879: }
5880:
5881: sub auto_instcode_defaults {
5882: my ($domain,$returnhash,$code_order) = @_;
5883: my @homeservers;
5884:
5885: my %servers = &get_servers($domain,'library');
5886: foreach my $tryserver (keys(%servers)) {
5887: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5888: push(@homeservers,$tryserver);
5889: }
5890: }
5891:
5892: my $response;
5893: foreach my $server (@homeservers) {
5894: $response=&reply('autoinstcodedefaults:'.$domain,$server);
5895: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5896:
5897: foreach my $pair (split(/\&/,$response)) {
5898: my ($name,$value)=split(/\=/,$pair);
5899: if ($name eq 'code_order') {
5900: @{$code_order} = split(/\&/,&unescape($value));
5901: } else {
5902: $returnhash->{&unescape($name)}=&unescape($value);
5903: }
5904: }
5905: return 'ok';
5906: }
5907:
5908: return $response;
5909: }
5910:
5911: sub auto_possible_instcodes {
5912: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
5913: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
5914: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
5915: return;
5916: }
5917: my (@homeservers,$uhome);
5918: if (defined(&domain($domain,'primary'))) {
5919: $uhome=&domain($domain,'primary');
5920: push(@homeservers,&domain($domain,'primary'));
5921: } else {
5922: my %servers = &get_servers($domain,'library');
5923: foreach my $tryserver (keys(%servers)) {
5924: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5925: push(@homeservers,$tryserver);
5926: }
5927: }
5928: }
5929: my $response;
5930: foreach my $server (@homeservers) {
5931: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5932: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5933: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
5934: split(':',$response);
5935: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5936: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
5937: foreach my $item (split('&',$cat_title)) {
5938: my ($name,$value)=split('=',$item);
5939: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
5940: }
5941: foreach my $item (split('&',$cat_order)) {
5942: my ($name,$value)=split('=',$item);
5943: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
5944: }
5945: return 'ok';
5946: }
5947: return $response;
5948: }
5949:
5950: sub auto_courserequest_checks {
5951: my ($dom) = @_;
5952: my ($homeserver,%validations);
5953: if ($dom =~ /^$match_domain$/) {
5954: $homeserver = &domain($dom,'primary');
5955: }
5956: unless ($homeserver eq 'no_host') {
5957: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
5958: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
5959: my @items = split(/&/,$response);
5960: foreach my $item (@items) {
5961: my ($key,$value) = split('=',$item);
5962: $validations{&unescape($key)} = &thaw_unescape($value);
5963: }
5964: }
5965: }
5966: return %validations;
5967: }
5968:
5969: sub auto_courserequest_validation {
5970: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
5971: my ($homeserver,$response);
5972: if ($dom =~ /^$match_domain$/) {
5973: $homeserver = &domain($dom,'primary');
5974: }
5975: unless ($homeserver eq 'no_host') {
5976:
5977: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
5978: ':'.&escape($crstype).':'.&escape($inststatuslist).
5979: ':'.&escape($instcode).':'.&escape($instseclist),
5980: $homeserver));
5981: }
5982: return $response;
5983: }
5984:
5985: sub auto_validate_class_sec {
5986: my ($cdom,$cnum,$owners,$inst_class) = @_;
5987: my $homeserver = &homeserver($cnum,$cdom);
5988: my $ownerlist;
5989: if (ref($owners) eq 'ARRAY') {
5990: $ownerlist = join(',',@{$owners});
5991: } else {
5992: $ownerlist = $owners;
5993: }
5994: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
5995: &escape($ownerlist).':'.$cdom,$homeserver);
5996: return $response;
5997: }
5998:
5999: # ------------------------------------------------------- Course Group routines
6000:
6001: sub get_coursegroups {
6002: my ($cdom,$cnum,$group,$namespace) = @_;
6003: return(&dump($namespace,$cdom,$cnum,$group));
6004: }
6005:
6006: sub modify_coursegroup {
6007: my ($cdom,$cnum,$groupsettings) = @_;
6008: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6009: }
6010:
6011: sub toggle_coursegroup_status {
6012: my ($cdom,$cnum,$group,$action) = @_;
6013: my ($from_namespace,$to_namespace);
6014: if ($action eq 'delete') {
6015: $from_namespace = 'coursegroups';
6016: $to_namespace = 'deleted_groups';
6017: } else {
6018: $from_namespace = 'deleted_groups';
6019: $to_namespace = 'coursegroups';
6020: }
6021: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
6022: if (my $tmp = &error(%curr_group)) {
6023: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6024: return ('read error',$tmp);
6025: } else {
6026: my %savedsettings = %curr_group;
6027: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
6028: my $deloutcome;
6029: if ($result eq 'ok') {
6030: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
6031: } else {
6032: return ('write error',$result);
6033: }
6034: if ($deloutcome eq 'ok') {
6035: return 'ok';
6036: } else {
6037: return ('delete error',$deloutcome);
6038: }
6039: }
6040: }
6041:
6042: sub modify_group_roles {
6043: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
6044: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6045: my $role = 'gr/'.&escape($userprivs);
6046: my ($uname,$udom) = split(/:/,$user);
6047: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
6048: if ($result eq 'ok') {
6049: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6050: }
6051: return $result;
6052: }
6053:
6054: sub modify_coursegroup_membership {
6055: my ($cdom,$cnum,$membership) = @_;
6056: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6057: return $result;
6058: }
6059:
6060: sub get_active_groups {
6061: my ($udom,$uname,$cdom,$cnum) = @_;
6062: my $now = time;
6063: my %groups = ();
6064: foreach my $key (keys(%env)) {
6065: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
6066: my ($start,$end) = split(/\./,$env{$key});
6067: if (($end!=0) && ($end<$now)) { next; }
6068: if (($start!=0) && ($start>$now)) { next; }
6069: if ($1 eq $cdom && $2 eq $cnum) {
6070: $groups{$3} = $env{$key} ;
6071: }
6072: }
6073: }
6074: return %groups;
6075: }
6076:
6077: sub get_group_membership {
6078: my ($cdom,$cnum,$group) = @_;
6079: return(&dump('groupmembership',$cdom,$cnum,$group));
6080: }
6081:
6082: sub get_users_groups {
6083: my ($udom,$uname,$courseid) = @_;
6084: my @usersgroups;
6085: my $cachetime=1800;
6086:
6087: my $hashid="$udom:$uname:$courseid";
6088: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6089: if (defined($cached)) {
6090: @usersgroups = split(/:/,$grouplist);
6091: } else {
6092: $grouplist = '';
6093: my $courseurl = &courseid_to_courseurl($courseid);
6094: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
6095: my $access_end = $env{'course.'.$courseid.
6096: '.default_enrollment_end_date'};
6097: my $now = time;
6098: foreach my $key (keys(%roleshash)) {
6099: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6100: my $group = $1;
6101: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6102: my $start = $2;
6103: my $end = $1;
6104: if ($start == -1) { next; } # deleted from group
6105: if (($start!=0) && ($start>$now)) { next; }
6106: if (($end!=0) && ($end<$now)) {
6107: if ($access_end && $access_end < $now) {
6108: if ($access_end - $end < 86400) {
6109: push(@usersgroups,$group);
6110: }
6111: }
6112: next;
6113: }
6114: push(@usersgroups,$group);
6115: }
6116: }
6117: }
6118: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6119: $grouplist = join(':',@usersgroups);
6120: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
6121: }
6122: return @usersgroups;
6123: }
6124:
6125: sub devalidate_getgroups_cache {
6126: my ($udom,$uname,$cdom,$cnum)=@_;
6127: my $courseid = $cdom.'_'.$cnum;
6128:
6129: my $hashid="$udom:$uname:$courseid";
6130: &devalidate_cache_new('getgroups',$hashid);
6131: }
6132:
6133: # ------------------------------------------------------------------ Plain Text
6134:
6135: sub plaintext {
6136: my ($short,$type,$cid,$forcedefault) = @_;
6137: if ($short =~ /^cr/) {
6138: return (split('/',$short))[-1];
6139: }
6140: if (!defined($cid)) {
6141: $cid = $env{'request.course.id'};
6142: }
6143: my %rolenames = (
6144: Course => 'std',
6145: Community => 'alt1',
6146: );
6147: if ($cid ne '') {
6148: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6149: unless ($forcedefault) {
6150: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6151: &Apache::lonlocal::mt_escape(\$roletext);
6152: return &Apache::lonlocal::mt($roletext);
6153: }
6154: }
6155: }
6156: if ((defined($type)) && (defined($rolenames{$type})) &&
6157: (defined($rolenames{$type})) &&
6158: (defined($prp{$short}{$rolenames{$type}}))) {
6159: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
6160: } elsif ($cid ne '') {
6161: my $crstype = $env{'course.'.$cid.'.type'};
6162: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6163: (defined($prp{$short}{$rolenames{$crstype}}))) {
6164: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6165: }
6166: }
6167: return &Apache::lonlocal::mt($prp{$short}{'std'});
6168: }
6169:
6170: # ----------------------------------------------------------------- Assign Role
6171:
6172: sub assignrole {
6173: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6174: $context)=@_;
6175: my $mrole;
6176: if ($role =~ /^cr\//) {
6177: my $cwosec=$url;
6178: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6179: unless (&allowed('ccr',$cwosec)) {
6180: my $refused = 1;
6181: if ($context eq 'requestcourses') {
6182: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6183: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6184: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6185: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6186: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6187: if ($crsenv{'internal.courseowner'} eq
6188: $env{'user.name'}.':'.$env{'user.domain'}) {
6189: $refused = '';
6190: }
6191: }
6192: }
6193: }
6194: }
6195: if ($refused) {
6196: &logthis('Refused custom assignrole: '.
6197: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6198: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6199: return 'refused';
6200: }
6201: }
6202: $mrole='cr';
6203: } elsif ($role =~ /^gr\//) {
6204: my $cwogrp=$url;
6205: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
6206: unless (&allowed('mdg',$cwogrp)) {
6207: &logthis('Refused group assignrole: '.
6208: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6209: $env{'user.name'}.' at '.$env{'user.domain'});
6210: return 'refused';
6211: }
6212: $mrole='gr';
6213: } else {
6214: my $cwosec=$url;
6215: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
6216: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6217: my $refused;
6218: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6219: if (!(&allowed('c'.$role,$url))) {
6220: $refused = 1;
6221: }
6222: } else {
6223: $refused = 1;
6224: }
6225: if ($refused) {
6226: if (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6227: $refused = '';
6228: } elsif ($context eq 'requestcourses') {
6229: my @possroles = ('st','ta','ep','in','cc');
6230: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
6231: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6232: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6233: if ($crsenv{'internal.courseowner'} eq
6234: $env{'user.name'}.':'.$env{'user.domain'}) {
6235: $refused = '';
6236: }
6237: }
6238: }
6239: if ($refused) {
6240: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6241: ' '.$role.' '.$end.' '.$start.' by '.
6242: $env{'user.name'}.' at '.$env{'user.domain'});
6243: return 'refused';
6244: }
6245: }
6246: }
6247: $mrole=$role;
6248: }
6249: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6250: "$udom:$uname:$url".'_'."$mrole=$role";
6251: if ($end) { $command.='_'.$end; }
6252: if ($start) {
6253: if ($end) {
6254: $command.='_'.$start;
6255: } else {
6256: $command.='_0_'.$start;
6257: }
6258: }
6259: my $origstart = $start;
6260: my $origend = $end;
6261: my $delflag;
6262: # actually delete
6263: if ($deleteflag) {
6264: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
6265: # modify command to delete the role
6266: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
6267: "$udom:$uname:$url".'_'."$mrole";
6268: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
6269: # set start and finish to negative values for userrolelog
6270: $start=-1;
6271: $end=-1;
6272: $delflag = 1;
6273: }
6274: }
6275: # send command
6276: my $answer=&reply($command,&homeserver($uname,$udom));
6277: # log new user role if status is ok
6278: if ($answer eq 'ok') {
6279: &userrolelog($role,$uname,$udom,$url,$start,$end);
6280: # for course roles, perform group memberships changes triggered by role change.
6281: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
6282: unless ($role =~ /^gr/) {
6283: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
6284: $origstart,$selfenroll,$context);
6285: }
6286: }
6287: return $answer;
6288: }
6289:
6290: # -------------------------------------------------- Modify user authentication
6291: # Overrides without validation
6292:
6293: sub modifyuserauth {
6294: my ($udom,$uname,$umode,$upass)=@_;
6295: my $uhome=&homeserver($uname,$udom);
6296: unless (&allowed('mau',$udom)) { return 'refused'; }
6297: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
6298: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6299: ' in domain '.$env{'request.role.domain'});
6300: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6301: &escape($upass),$uhome);
6302: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
6303: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6304: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6305: &log($udom,,$uname,$uhome,
6306: 'Authentication changed by '.$env{'user.domain'}.', '.
6307: $env{'user.name'}.', '.$umode.
6308: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6309: unless ($reply eq 'ok') {
6310: &logthis('Authentication mode error: '.$reply);
6311: return 'error: '.$reply;
6312: }
6313: return 'ok';
6314: }
6315:
6316: # --------------------------------------------------------------- Modify a user
6317:
6318: sub modifyuser {
6319: my ($udom, $uname, $uid,
6320: $umode, $upass, $first,
6321: $middle, $last, $gene,
6322: $forceid, $desiredhome, $email, $inststatus)=@_;
6323: $udom= &LONCAPA::clean_domain($udom);
6324: $uname=&LONCAPA::clean_username($uname);
6325: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
6326: $umode.', '.$first.', '.$middle.', '.
6327: $last.', '.$gene.'(forceid: '.$forceid.')'.
6328: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6329: ' desiredhome not specified').
6330: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6331: ' in domain '.$env{'request.role.domain'});
6332: my $uhome=&homeserver($uname,$udom,'true');
6333: # ----------------------------------------------------------------- Create User
6334: if (($uhome eq 'no_host') &&
6335: (($umode && $upass) || ($umode eq 'localauth'))) {
6336: my $unhome='';
6337: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
6338: $unhome = $desiredhome;
6339: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6340: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
6341: } else { # load balancing routine for determining $unhome
6342: my $loadm=10000000;
6343: my %servers = &get_servers($udom,'library');
6344: foreach my $tryserver (keys(%servers)) {
6345: my $answer=reply('load',$tryserver);
6346: if (($answer=~/\d+/) && ($answer<$loadm)) {
6347: $loadm=$answer;
6348: $unhome=$tryserver;
6349: }
6350: }
6351: }
6352: if (($unhome eq '') || ($unhome eq 'no_host')) {
6353: return 'error: unable to find a home server for '.$uname.
6354: ' in domain '.$udom;
6355: }
6356: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6357: &escape($upass),$unhome);
6358: unless ($reply eq 'ok') {
6359: return 'error: '.$reply;
6360: }
6361: $uhome=&homeserver($uname,$udom,'true');
6362: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
6363: return 'error: unable verify users home machine.';
6364: }
6365: } # End of creation of new user
6366: # ---------------------------------------------------------------------- Add ID
6367: if ($uid) {
6368: $uid=~tr/A-Z/a-z/;
6369: my %uidhash=&idrget($udom,$uname);
6370: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6371: && (!$forceid)) {
6372: unless ($uid eq $uidhash{$uname}) {
6373: return 'error: user id "'.$uid.'" does not match '.
6374: 'current user id "'.$uidhash{$uname}.'".';
6375: }
6376: } else {
6377: &idput($udom,($uname => $uid));
6378: }
6379: }
6380: # -------------------------------------------------------------- Add names, etc
6381: my @tmp=&get('environment',
6382: ['firstname','middlename','lastname','generation','id',
6383: 'permanentemail','inststatus'],
6384: $udom,$uname);
6385: my %names;
6386: if ($tmp[0] =~ m/^error:.*/) {
6387: %names=();
6388: } else {
6389: %names = @tmp;
6390: }
6391: #
6392: # Make sure to not trash student environment if instructor does not bother
6393: # to supply name and email information
6394: #
6395: if ($first) { $names{'firstname'} = $first; }
6396: if (defined($middle)) { $names{'middlename'} = $middle; }
6397: if ($last) { $names{'lastname'} = $last; }
6398: if (defined($gene)) { $names{'generation'} = $gene; }
6399: if ($email) {
6400: $email=~s/[^\w\@\.\-\,]//gs;
6401: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
6402: }
6403: if ($uid) { $names{'id'} = $uid; }
6404: if (defined($inststatus)) {
6405: $names{'inststatus'} = '';
6406: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6407: if (ref($usertypes) eq 'HASH') {
6408: my @okstatuses;
6409: foreach my $item (split(/:/,$inststatus)) {
6410: if (defined($usertypes->{$item})) {
6411: push(@okstatuses,$item);
6412: }
6413: }
6414: if (@okstatuses) {
6415: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6416: }
6417: }
6418: }
6419: my $reply = &put('environment', \%names, $udom,$uname);
6420: if ($reply ne 'ok') { return 'error: '.$reply; }
6421: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
6422: &devalidate_cache_new('namescache',$uname.':'.$udom);
6423: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6424: $umode.', '.$first.', '.$middle.', '.
6425: $last.', '.$gene.', '.$email.', '.$inststatus;
6426: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6427: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6428: } else {
6429: $logmsg .= ' during self creation';
6430: }
6431: &logthis($logmsg);
6432: return 'ok';
6433: }
6434:
6435: # -------------------------------------------------------------- Modify student
6436:
6437: sub modifystudent {
6438: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
6439: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
6440: $selfenroll,$context,$inststatus)=@_;
6441: if (!$cid) {
6442: unless ($cid=$env{'request.course.id'}) {
6443: return 'not_in_class';
6444: }
6445: }
6446: # --------------------------------------------------------------- Make the user
6447: my $reply=&modifyuser
6448: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
6449: $desiredhome,$email,$inststatus);
6450: unless ($reply eq 'ok') { return $reply; }
6451: # This will cause &modify_student_enrollment to get the uid from the
6452: # students environment
6453: $uid = undef if (!$forceid);
6454: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
6455: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
6456: return $reply;
6457: }
6458:
6459: sub modify_student_enrollment {
6460: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
6461: my ($cdom,$cnum,$chome);
6462: if (!$cid) {
6463: unless ($cid=$env{'request.course.id'}) {
6464: return 'not_in_class';
6465: }
6466: $cdom=$env{'course.'.$cid.'.domain'};
6467: $cnum=$env{'course.'.$cid.'.num'};
6468: } else {
6469: ($cdom,$cnum)=split(/_/,$cid);
6470: }
6471: $chome=$env{'course.'.$cid.'.home'};
6472: if (!$chome) {
6473: $chome=&homeserver($cnum,$cdom);
6474: }
6475: if (!$chome) { return 'unknown_course'; }
6476: # Make sure the user exists
6477: my $uhome=&homeserver($uname,$udom);
6478: if (($uhome eq '') || ($uhome eq 'no_host')) {
6479: return 'error: no such user';
6480: }
6481: # Get student data if we were not given enough information
6482: if (!defined($first) || $first eq '' ||
6483: !defined($last) || $last eq '' ||
6484: !defined($uid) || $uid eq '' ||
6485: !defined($middle) || $middle eq '' ||
6486: !defined($gene) || $gene eq '') {
6487: # They did not supply us with enough data to enroll the student, so
6488: # we need to pick up more information.
6489: my %tmp = &get('environment',
6490: ['firstname','middlename','lastname', 'generation','id']
6491: ,$udom,$uname);
6492:
6493: #foreach my $key (keys(%tmp)) {
6494: # &logthis("key $key = ".$tmp{$key});
6495: #}
6496: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6497: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6498: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
6499: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
6500: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6501: }
6502: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
6503: my $reply=cput('classlist',
6504: {"$uname:$udom" =>
6505: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
6506: $cdom,$cnum);
6507: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6508: return 'error: '.$reply;
6509: } else {
6510: &devalidate_getsection_cache($udom,$uname,$cid);
6511: }
6512: # Add student role to user
6513: my $uurl='/'.$cid;
6514: $uurl=~s/\_/\//g;
6515: if ($usec) {
6516: $uurl.='/'.$usec;
6517: }
6518: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
6519: }
6520:
6521: sub format_name {
6522: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6523: my $name;
6524: if ($first ne 'lastname') {
6525: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6526: } else {
6527: if ($lastname=~/\S/) {
6528: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6529: $name=~s/\s+,/,/;
6530: } else {
6531: $name.= $firstname.' '.$middlename.' '.$generation;
6532: }
6533: }
6534: $name=~s/^\s+//;
6535: $name=~s/\s+$//;
6536: $name=~s/\s+/ /g;
6537: return $name;
6538: }
6539:
6540: # ------------------------------------------------- Write to course preferences
6541:
6542: sub writecoursepref {
6543: my ($courseid,%prefs)=@_;
6544: $courseid=~s/^\///;
6545: $courseid=~s/\_/\//g;
6546: my ($cdomain,$cnum)=split(/\//,$courseid);
6547: my $chome=homeserver($cnum,$cdomain);
6548: if (($chome eq '') || ($chome eq 'no_host')) {
6549: return 'error: no such course';
6550: }
6551: my $cstring='';
6552: foreach my $pref (keys(%prefs)) {
6553: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
6554: }
6555: $cstring=~s/\&$//;
6556: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6557: }
6558:
6559: # ---------------------------------------------------------- Make/modify course
6560:
6561: sub createcourse {
6562: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
6563: $course_owner,$crstype,$cnum,$context,$category)=@_;
6564: $url=&declutter($url);
6565: my $cid='';
6566: if ($context eq 'requestcourses') {
6567: my $can_create = 0;
6568: my ($ownername,$ownerdom) = split(':',$course_owner);
6569: if ($udom eq $ownerdom) {
6570: if (&usertools_access($ownername,$ownerdom,$category,undef,
6571: $context)) {
6572: $can_create = 1;
6573: }
6574: } else {
6575: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6576: $category);
6577: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6578: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6579: if (@curr > 0) {
6580: my @options = qw(approval validate autolimit);
6581: my $optregex = join('|',@options);
6582: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6583: $can_create = 1;
6584: }
6585: }
6586: }
6587: }
6588: if ($can_create) {
6589: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6590: unless (&allowed('ccc',$udom)) {
6591: return 'refused';
6592: }
6593: }
6594: } else {
6595: return 'refused';
6596: }
6597: } elsif (!&allowed('ccc',$udom)) {
6598: return 'refused';
6599: }
6600: # --------------------------------------------------------------- Get Unique ID
6601: my $uname;
6602: if ($cnum =~ /^$match_courseid$/) {
6603: my $chome=&homeserver($cnum,$udom,'true');
6604: if (($chome eq '') || ($chome eq 'no_host')) {
6605: $uname = $cnum;
6606: } else {
6607: $uname = &generate_coursenum($udom,$crstype);
6608: }
6609: } else {
6610: $uname = &generate_coursenum($udom,$crstype);
6611: }
6612: return $uname if ($uname =~ /^error/);
6613: # -------------------------------------------------- Check supplied server name
6614: $course_server = $env{'user.homeserver'} if (! defined($course_server));
6615: if (! &is_library($course_server)) {
6616: return 'error:bad server name '.$course_server;
6617: }
6618: # ------------------------------------------------------------- Make the course
6619: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
6620: $course_server);
6621: unless ($reply eq 'ok') { return 'error: '.$reply; }
6622: my $uhome=&homeserver($uname,$udom,'true');
6623: if (($uhome eq '') || ($uhome eq 'no_host')) {
6624: return 'error: no such course';
6625: }
6626: # ----------------------------------------------------------------- Course made
6627: # log existence
6628: my $now = time;
6629: my $newcourse = {
6630: $udom.'_'.$uname => {
6631: description => $description,
6632: inst_code => $inst_code,
6633: owner => $course_owner,
6634: type => $crstype,
6635: creator => $env{'user.name'}.':'.
6636: $env{'user.domain'},
6637: created => $now,
6638: context => $context,
6639: },
6640: };
6641: &courseidput($udom,$newcourse,$uhome,'notime');
6642: # set toplevel url
6643: my $topurl=$url;
6644: unless ($nonstandard) {
6645: # ------------------------------------------ For standard courses, make top url
6646: my $mapurl=&clutter($url);
6647: if ($mapurl eq '/res/') { $mapurl=''; }
6648: $env{'form.initmap'}=(<<ENDINITMAP);
6649: <map>
6650: <resource id="1" type="start"></resource>
6651: <resource id="2" src="$mapurl"></resource>
6652: <resource id="3" type="finish"></resource>
6653: <link index="1" from="1" to="2"></link>
6654: <link index="2" from="2" to="3"></link>
6655: </map>
6656: ENDINITMAP
6657: $topurl=&declutter(
6658: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
6659: );
6660: }
6661: # ----------------------------------------------------------- Write preferences
6662: &writecoursepref($udom.'_'.$uname,
6663: ('description' => $description,
6664: 'url' => $topurl));
6665: return '/'.$udom.'/'.$uname;
6666: }
6667:
6668: # ------------------------------------------------------------------- Create ID
6669: sub generate_coursenum {
6670: my ($udom,$crstype) = @_;
6671: my $domdesc = &domain($udom);
6672: return 'error: invalid domain' if ($domdesc eq '');
6673: my $first;
6674: if ($crstype eq 'Community') {
6675: $first = '0';
6676: } else {
6677: $first = int(1+rand(9));
6678: }
6679: my $uname=$first.
6680: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6681: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6682: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6683: # ----------------------------------------------- Make sure that does not exist
6684: my $uhome=&homeserver($uname,$udom,'true');
6685: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6686: if ($crstype eq 'Community') {
6687: $first = '0';
6688: } else {
6689: $first = int(1+rand(9));
6690: }
6691: $uname=$first.
6692: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6693: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6694: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6695: $uhome=&homeserver($uname,$udom,'true');
6696: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6697: return 'error: unable to generate unique course-ID';
6698: }
6699: }
6700: return $uname;
6701: }
6702:
6703: sub is_course {
6704: my ($cdom,$cnum) = @_;
6705: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
6706: undef,'.');
6707: if (exists($courses{$cdom.'_'.$cnum})) {
6708: return 1;
6709: }
6710: return 0;
6711: }
6712:
6713: sub store_userdata {
6714: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
6715: my $result;
6716: if ($datakey ne '') {
6717: if (ref($storehash) eq 'HASH') {
6718: if ($udom eq '' || $uname eq '') {
6719: $udom = $env{'user.domain'};
6720: $uname = $env{'user.name'};
6721: }
6722: my $uhome=&homeserver($uname,$udom);
6723: if (($uhome eq '') || ($uhome eq 'no_host')) {
6724: $result = 'error: no_host';
6725: } else {
6726: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6727: $storehash->{'host'} = $perlvar{'lonHostID'};
6728:
6729: my $namevalue='';
6730: foreach my $key (keys(%{$storehash})) {
6731: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6732: }
6733: $namevalue=~s/\&$//;
6734: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
6735: "$namespace:$datakey:$namevalue",$uhome);
6736: }
6737: } else {
6738: $result = 'error: data to store was not a hash reference';
6739: }
6740: } else {
6741: $result= 'error: invalid requestkey';
6742: }
6743: return $result;
6744: }
6745:
6746: # ---------------------------------------------------------- Assign Custom Role
6747:
6748: sub assigncustomrole {
6749: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
6750: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
6751: $end,$start,$deleteflag,$selfenroll,$context);
6752: }
6753:
6754: # ----------------------------------------------------------------- Revoke Role
6755:
6756: sub revokerole {
6757: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
6758: my $now=time;
6759: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
6760: }
6761:
6762: # ---------------------------------------------------------- Revoke Custom Role
6763:
6764: sub revokecustomrole {
6765: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
6766: my $now=time;
6767: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
6768: $deleteflag,$selfenroll,$context);
6769: }
6770:
6771: # ------------------------------------------------------------ Disk usage
6772: sub diskusage {
6773: my ($udom,$uname,$directorypath,$getpropath)=@_;
6774: $directorypath =~ s/\/$//;
6775: my $listing=&reply('du2:'.&escape($directorypath).':'
6776: .&escape($getpropath).':'.&escape($uname).':'
6777: .&escape($udom),homeserver($uname,$udom));
6778: if ($listing eq 'unknown_cmd') {
6779: if ($getpropath) {
6780: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6781: }
6782: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6783: }
6784: return $listing;
6785: }
6786:
6787: sub is_locked {
6788: my ($file_name, $domain, $user) = @_;
6789: my @check;
6790: my $is_locked;
6791: push @check, $file_name;
6792: my %locked = &get('file_permissions',\@check,
6793: $env{'user.domain'},$env{'user.name'});
6794: my ($tmp)=keys(%locked);
6795: if ($tmp=~/^error:/) { undef(%locked); }
6796:
6797: if (ref($locked{$file_name}) eq 'ARRAY') {
6798: $is_locked = 'false';
6799: foreach my $entry (@{$locked{$file_name}}) {
6800: if (ref($entry) eq 'ARRAY') {
6801: $is_locked = 'true';
6802: last;
6803: }
6804: }
6805: } else {
6806: $is_locked = 'false';
6807: }
6808: }
6809:
6810: sub declutter_portfile {
6811: my ($file) = @_;
6812: $file =~ s{^(/portfolio/|portfolio/)}{/};
6813: return $file;
6814: }
6815:
6816: # ------------------------------------------------------------- Mark as Read Only
6817:
6818: sub mark_as_readonly {
6819: my ($domain,$user,$files,$what) = @_;
6820: my %current_permissions = &dump('file_permissions',$domain,$user);
6821: my ($tmp)=keys(%current_permissions);
6822: if ($tmp=~/^error:/) { undef(%current_permissions); }
6823: foreach my $file (@{$files}) {
6824: $file = &declutter_portfile($file);
6825: push(@{$current_permissions{$file}},$what);
6826: }
6827: &put('file_permissions',\%current_permissions,$domain,$user);
6828: return;
6829: }
6830:
6831: # ------------------------------------------------------------Save Selected Files
6832:
6833: sub save_selected_files {
6834: my ($user, $path, @files) = @_;
6835: my $filename = $user."savedfiles";
6836: my @other_files = &files_not_in_path($user, $path);
6837: open (OUT, '>'.$tmpdir.$filename);
6838: foreach my $file (@files) {
6839: print (OUT $env{'form.currentpath'}.$file."\n");
6840: }
6841: foreach my $file (@other_files) {
6842: print (OUT $file."\n");
6843: }
6844: close (OUT);
6845: return 'ok';
6846: }
6847:
6848: sub clear_selected_files {
6849: my ($user) = @_;
6850: my $filename = $user."savedfiles";
6851: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6852: print (OUT undef);
6853: close (OUT);
6854: return ("ok");
6855: }
6856:
6857: sub files_in_path {
6858: my ($user, $path) = @_;
6859: my $filename = $user."savedfiles";
6860: my %return_files;
6861: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6862: while (my $line_in = <IN>) {
6863: chomp ($line_in);
6864: my @paths_and_file = split (m!/!, $line_in);
6865: my $file_part = pop (@paths_and_file);
6866: my $path_part = join ('/', @paths_and_file);
6867: $path_part.='/';
6868: my $path_and_file = $path_part.$file_part;
6869: if ($path_part eq $path) {
6870: $return_files{$file_part}= 'selected';
6871: }
6872: }
6873: close (IN);
6874: return (\%return_files);
6875: }
6876:
6877: # called in portfolio select mode, to show files selected NOT in current directory
6878: sub files_not_in_path {
6879: my ($user, $path) = @_;
6880: my $filename = $user."savedfiles";
6881: my @return_files;
6882: my $path_part;
6883: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
6884: while (my $line = <IN>) {
6885: #ok, I know it's clunky, but I want it to work
6886: my @paths_and_file = split(m|/|, $line);
6887: my $file_part = pop(@paths_and_file);
6888: chomp($file_part);
6889: my $path_part = join('/', @paths_and_file);
6890: $path_part .= '/';
6891: my $path_and_file = $path_part.$file_part;
6892: if ($path_part ne $path) {
6893: push(@return_files, ($path_and_file));
6894: }
6895: }
6896: close(OUT);
6897: return (@return_files);
6898: }
6899:
6900: #----------------------------------------------Get portfolio file permissions
6901:
6902: sub get_portfile_permissions {
6903: my ($domain,$user) = @_;
6904: my %current_permissions = &dump('file_permissions',$domain,$user);
6905: my ($tmp)=keys(%current_permissions);
6906: if ($tmp=~/^error:/) { undef(%current_permissions); }
6907: return \%current_permissions;
6908: }
6909:
6910: #---------------------------------------------Get portfolio file access controls
6911:
6912: sub get_access_controls {
6913: my ($current_permissions,$group,$file) = @_;
6914: my %access;
6915: my $real_file = $file;
6916: $file =~ s/\.meta$//;
6917: if (defined($file)) {
6918: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
6919: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
6920: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
6921: }
6922: }
6923: } else {
6924: foreach my $key (keys(%{$current_permissions})) {
6925: if ($key =~ /\0accesscontrol$/) {
6926: if (defined($group)) {
6927: if ($key !~ m-^\Q$group\E/-) {
6928: next;
6929: }
6930: }
6931: my ($fullpath) = split(/\0/,$key);
6932: if (ref($$current_permissions{$key}) eq 'HASH') {
6933: foreach my $control (keys(%{$$current_permissions{$key}})) {
6934: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
6935: }
6936: }
6937: }
6938: }
6939: }
6940: return %access;
6941: }
6942:
6943: sub modify_access_controls {
6944: my ($file_name,$changes,$domain,$user)=@_;
6945: my ($outcome,$deloutcome);
6946: my %store_permissions;
6947: my %new_values;
6948: my %new_control;
6949: my %translation;
6950: my @deletions = ();
6951: my $now = time;
6952: if (exists($$changes{'activate'})) {
6953: if (ref($$changes{'activate'}) eq 'HASH') {
6954: my @newitems = sort(keys(%{$$changes{'activate'}}));
6955: my $numnew = scalar(@newitems);
6956: for (my $i=0; $i<$numnew; $i++) {
6957: my $newkey = $newitems[$i];
6958: my $newid = &Apache::loncommon::get_cgi_id();
6959: if ($newkey =~ /^\d+:/) {
6960: $newkey =~ s/^(\d+)/$newid/;
6961: $translation{$1} = $newid;
6962: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
6963: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
6964: $translation{$1} = $newid;
6965: }
6966: $new_values{$file_name."\0".$newkey} =
6967: $$changes{'activate'}{$newitems[$i]};
6968: $new_control{$newkey} = $now;
6969: }
6970: }
6971: }
6972: my %todelete;
6973: my %changed_items;
6974: foreach my $action ('delete','update') {
6975: if (exists($$changes{$action})) {
6976: if (ref($$changes{$action}) eq 'HASH') {
6977: foreach my $key (keys(%{$$changes{$action}})) {
6978: my ($itemnum) = ($key =~ /^([^:]+):/);
6979: if ($action eq 'delete') {
6980: $todelete{$itemnum} = 1;
6981: } else {
6982: $changed_items{$itemnum} = $key;
6983: }
6984: }
6985: }
6986: }
6987: }
6988: # get lock on access controls for file.
6989: my $lockhash = {
6990: $file_name."\0".'locked_access_records' => $env{'user.name'}.
6991: ':'.$env{'user.domain'},
6992: };
6993: my $tries = 0;
6994: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
6995:
6996: while (($gotlock ne 'ok') && $tries <3) {
6997: $tries ++;
6998: sleep 1;
6999: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7000: }
7001: if ($gotlock eq 'ok') {
7002: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7003: my ($tmp)=keys(%curr_permissions);
7004: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7005: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7006: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7007: if (ref($curr_controls) eq 'HASH') {
7008: foreach my $control_item (keys(%{$curr_controls})) {
7009: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7010: if (defined($todelete{$itemnum})) {
7011: push(@deletions,$file_name."\0".$control_item);
7012: } else {
7013: if (defined($changed_items{$itemnum})) {
7014: $new_control{$changed_items{$itemnum}} = $now;
7015: push(@deletions,$file_name."\0".$control_item);
7016: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7017: } else {
7018: $new_control{$control_item} = $$curr_controls{$control_item};
7019: }
7020: }
7021: }
7022: }
7023: }
7024: my ($group);
7025: if (&is_course($domain,$user)) {
7026: ($group,my $file) = split(/\//,$file_name,2);
7027: }
7028: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7029: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7030: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7031: # remove lock
7032: my @del_lock = ($file_name."\0".'locked_access_records');
7033: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
7034: my $sqlresult =
7035: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
7036: $group);
7037: } else {
7038: $outcome = "error: could not obtain lockfile\n";
7039: }
7040: return ($outcome,$deloutcome,\%new_values,\%translation);
7041: }
7042:
7043: sub make_public_indefinitely {
7044: my ($requrl) = @_;
7045: my $now = time;
7046: my $action = 'activate';
7047: my $aclnum = 0;
7048: if (&is_portfolio_url($requrl)) {
7049: my (undef,$udom,$unum,$file_name,$group) =
7050: &parse_portfolio_url($requrl);
7051: my $current_perms = &get_portfile_permissions($udom,$unum);
7052: my %access_controls = &get_access_controls($current_perms,
7053: $group,$file_name);
7054: foreach my $key (keys(%{$access_controls{$file_name}})) {
7055: my ($num,$scope,$end,$start) =
7056: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7057: if ($scope eq 'public') {
7058: if ($start <= $now && $end == 0) {
7059: $action = 'none';
7060: } else {
7061: $action = 'update';
7062: $aclnum = $num;
7063: }
7064: last;
7065: }
7066: }
7067: if ($action eq 'none') {
7068: return 'ok';
7069: } else {
7070: my %changes;
7071: my $newend = 0;
7072: my $newstart = $now;
7073: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7074: $changes{$action}{$newkey} = {
7075: type => 'public',
7076: time => {
7077: start => $newstart,
7078: end => $newend,
7079: },
7080: };
7081: my ($outcome,$deloutcome,$new_values,$translation) =
7082: &modify_access_controls($file_name,\%changes,$udom,$unum);
7083: return $outcome;
7084: }
7085: } else {
7086: return 'invalid';
7087: }
7088: }
7089:
7090: #------------------------------------------------------Get Marked as Read Only
7091:
7092: sub get_marked_as_readonly {
7093: my ($domain,$user,$what,$group) = @_;
7094: my $current_permissions = &get_portfile_permissions($domain,$user);
7095: my @readonly_files;
7096: my $cmp1=$what;
7097: if (ref($what)) { $cmp1=join('',@{$what}) };
7098: while (my ($file_name,$value) = each(%{$current_permissions})) {
7099: if (defined($group)) {
7100: if ($file_name !~ m-^\Q$group\E/-) {
7101: next;
7102: }
7103: }
7104: if (ref($value) eq "ARRAY"){
7105: foreach my $stored_what (@{$value}) {
7106: my $cmp2=$stored_what;
7107: if (ref($stored_what) eq 'ARRAY') {
7108: $cmp2=join('',@{$stored_what});
7109: }
7110: if ($cmp1 eq $cmp2) {
7111: push(@readonly_files, $file_name);
7112: last;
7113: } elsif (!defined($what)) {
7114: push(@readonly_files, $file_name);
7115: last;
7116: }
7117: }
7118: }
7119: }
7120: return @readonly_files;
7121: }
7122: #-----------------------------------------------------------Get Marked as Read Only Hash
7123:
7124: sub get_marked_as_readonly_hash {
7125: my ($current_permissions,$group,$what) = @_;
7126: my %readonly_files;
7127: while (my ($file_name,$value) = each(%{$current_permissions})) {
7128: if (defined($group)) {
7129: if ($file_name !~ m-^\Q$group\E/-) {
7130: next;
7131: }
7132: }
7133: if (ref($value) eq "ARRAY"){
7134: foreach my $stored_what (@{$value}) {
7135: if (ref($stored_what) eq 'ARRAY') {
7136: foreach my $lock_descriptor(@{$stored_what}) {
7137: if ($lock_descriptor eq 'graded') {
7138: $readonly_files{$file_name} = 'graded';
7139: } elsif ($lock_descriptor eq 'handback') {
7140: $readonly_files{$file_name} = 'handback';
7141: } else {
7142: if (!exists($readonly_files{$file_name})) {
7143: $readonly_files{$file_name} = 'locked';
7144: }
7145: }
7146: }
7147: }
7148: }
7149: }
7150: }
7151: return %readonly_files;
7152: }
7153: # ------------------------------------------------------------ Unmark as Read Only
7154:
7155: sub unmark_as_readonly {
7156: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7157: # for portfolio submissions, $what contains [$symb,$crsid]
7158: my ($domain,$user,$what,$file_name,$group) = @_;
7159: $file_name = &declutter_portfile($file_name);
7160: my $symb_crs = $what;
7161: if (ref($what)) { $symb_crs=join('',@$what); }
7162: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
7163: my ($tmp)=keys(%current_permissions);
7164: if ($tmp=~/^error:/) { undef(%current_permissions); }
7165: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
7166: foreach my $file (@readonly_files) {
7167: my $clean_file = &declutter_portfile($file);
7168: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
7169: my $current_locks = $current_permissions{$file};
7170: my @new_locks;
7171: my @del_keys;
7172: if (ref($current_locks) eq "ARRAY"){
7173: foreach my $locker (@{$current_locks}) {
7174: my $compare=$locker;
7175: if (ref($locker) eq 'ARRAY') {
7176: $compare=join('',@{$locker});
7177: if ($compare ne $symb_crs) {
7178: push(@new_locks, $locker);
7179: }
7180: }
7181: }
7182: if (scalar(@new_locks) > 0) {
7183: $current_permissions{$file} = \@new_locks;
7184: } else {
7185: push(@del_keys, $file);
7186: &del('file_permissions',\@del_keys, $domain, $user);
7187: delete($current_permissions{$file});
7188: }
7189: }
7190: }
7191: &put('file_permissions',\%current_permissions,$domain,$user);
7192: return;
7193: }
7194:
7195: # ------------------------------------------------------------ Directory lister
7196:
7197: sub dirlist {
7198: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
7199: $uri=~s/^\///;
7200: $uri=~s/\/$//;
7201: my ($udom, $uname);
7202: if ($getuserdir) {
7203: $udom = $userdomain;
7204: $uname = $username;
7205: } else {
7206: (undef,$udom,$uname)=split(/\//,$uri);
7207: if(defined($userdomain)) {
7208: $udom = $userdomain;
7209: }
7210: if(defined($username)) {
7211: $uname = $username;
7212: }
7213: }
7214: my ($dirRoot,$listing,@listing_results);
7215:
7216: $dirRoot = $perlvar{'lonDocRoot'};
7217: if (defined($getpropath)) {
7218: $dirRoot = &propath($udom,$uname);
7219: $dirRoot =~ s/\/$//;
7220: } elsif (defined($getuserdir)) {
7221: my $subdir=$uname.'__';
7222: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7223: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7224: ."/$udom/$subdir/$uname";
7225: } elsif (defined($alternateRoot)) {
7226: $dirRoot = $alternateRoot;
7227: }
7228:
7229: if($udom) {
7230: if($uname) {
7231: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
7232: .$getuserdir.':'.&escape($dirRoot)
7233: .':'.&escape($uname).':'.&escape($udom),
7234: &homeserver($uname,$udom));
7235: if ($listing eq 'unknown_cmd') {
7236: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7237: &homeserver($uname,$udom));
7238: } else {
7239: @listing_results = map { &unescape($_); } split(/:/,$listing);
7240: }
7241: if ($listing eq 'unknown_cmd') {
7242: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7243: &homeserver($uname,$udom));
7244: @listing_results = split(/:/,$listing);
7245: } else {
7246: @listing_results = map { &unescape($_); } split(/:/,$listing);
7247: }
7248: return @listing_results;
7249: } elsif(!$alternateRoot) {
7250: my %allusers;
7251: my %servers = &get_servers($udom,'library');
7252: foreach my $tryserver (keys(%servers)) {
7253: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7254: &escape($udom),$tryserver);
7255: if ($listing eq 'unknown_cmd') {
7256: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7257: $udom, $tryserver);
7258: } else {
7259: @listing_results = map { &unescape($_); } split(/:/,$listing);
7260: }
7261: if ($listing eq 'unknown_cmd') {
7262: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7263: $udom, $tryserver);
7264: @listing_results = split(/:/,$listing);
7265: } else {
7266: @listing_results =
7267: map { &unescape($_); } split(/:/,$listing);
7268: }
7269: if ($listing_results[0] ne 'no_such_dir' &&
7270: $listing_results[0] ne 'empty' &&
7271: $listing_results[0] ne 'con_lost') {
7272: foreach my $line (@listing_results) {
7273: my ($entry) = split(/&/,$line,2);
7274: $allusers{$entry} = 1;
7275: }
7276: }
7277: }
7278: my $alluserstr='';
7279: foreach my $user (sort(keys(%allusers))) {
7280: $alluserstr.=$user.'&user:';
7281: }
7282: $alluserstr=~s/:$//;
7283: return split(/:/,$alluserstr);
7284: } else {
7285: return ('missing user name');
7286: }
7287: } elsif(!defined($getpropath)) {
7288: my @all_domains = sort(&all_domains());
7289: foreach my $domain (@all_domains) {
7290: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7291: }
7292: return @all_domains;
7293: } else {
7294: return ('missing domain');
7295: }
7296: }
7297:
7298: # --------------------------------------------- GetFileTimestamp
7299: # This function utilizes dirlist and returns the date stamp for
7300: # when it was last modified. It will also return an error of -1
7301: # if an error occurs
7302:
7303: sub GetFileTimestamp {
7304: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
7305: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7306: $studentName = &LONCAPA::clean_username($studentName);
7307: my ($fileStat) =
7308: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7309: undef,$getuserdir);
7310: my @stats = split('&', $fileStat);
7311: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7312: # @stats contains first the filename, then the stat output
7313: return $stats[10]; # so this is 10 instead of 9.
7314: } else {
7315: return -1;
7316: }
7317: }
7318:
7319: sub stat_file {
7320: my ($uri) = @_;
7321: $uri = &clutter_with_no_wrapper($uri);
7322:
7323: my ($udom,$uname,$file);
7324: if ($uri =~ m-^/(uploaded|editupload)/-) {
7325: ($udom,$uname,$file) =
7326: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
7327: $file = 'userfiles/'.$file;
7328: }
7329: if ($uri =~ m-^/res/-) {
7330: ($udom,$uname) =
7331: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
7332: $file = $uri;
7333: }
7334:
7335: if (!$udom || !$uname || !$file) {
7336: # unable to handle the uri
7337: return ();
7338: }
7339: my $getpropath;
7340: if ($file =~ /^userfiles\//) {
7341: $getpropath = 1;
7342: }
7343: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
7344: my @stats = split('&', $result);
7345:
7346: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7347: shift(@stats); #filename is first
7348: return @stats;
7349: }
7350: return ();
7351: }
7352:
7353: # -------------------------------------------------------- Value of a Condition
7354:
7355: # gets the value of a specific preevaluated condition
7356: # stored in the string $env{user.state.<cid>}
7357: # or looks up a condition reference in the bighash and if if hasn't
7358: # already been evaluated recurses into docondval to get the value of
7359: # the condition, then memoizing it to
7360: # $env{user.state.<cid>.<condition>}
7361: sub directcondval {
7362: my $number=shift;
7363: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
7364: &Apache::lonuserstate::evalstate();
7365: }
7366: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7367: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7368: } elsif ($number =~ /^_/) {
7369: my $sub_condition;
7370: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7371: &GDBM_READER(),0640)) {
7372: $sub_condition=$bighash{'conditions'.$number};
7373: untie(%bighash);
7374: }
7375: my $value = &docondval($sub_condition);
7376: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
7377: return $value;
7378: }
7379: if ($env{'user.state.'.$env{'request.course.id'}}) {
7380: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
7381: } else {
7382: return 2;
7383: }
7384: }
7385:
7386: # get the collection of conditions for this resource
7387: sub condval {
7388: my $condidx=shift;
7389: my $allpathcond='';
7390: foreach my $cond (split(/\|/,$condidx)) {
7391: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7392: $allpathcond.=
7393: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7394: }
7395: }
7396: $allpathcond=~s/\|$//;
7397: return &docondval($allpathcond);
7398: }
7399:
7400: #evaluates an expression of conditions
7401: sub docondval {
7402: my ($allpathcond) = @_;
7403: my $result=0;
7404: if ($env{'request.course.id'}
7405: && defined($allpathcond)) {
7406: my $operand='|';
7407: my @stack;
7408: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7409: if ($chunk eq '(') {
7410: push @stack,($operand,$result);
7411: } elsif ($chunk eq ')') {
7412: my $before=pop @stack;
7413: if (pop @stack eq '&') {
7414: $result=$result>$before?$before:$result;
7415: } else {
7416: $result=$result>$before?$result:$before;
7417: }
7418: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7419: $operand=$chunk;
7420: } else {
7421: my $new=directcondval($chunk);
7422: if ($operand eq '&') {
7423: $result=$result>$new?$new:$result;
7424: } else {
7425: $result=$result>$new?$result:$new;
7426: }
7427: }
7428: }
7429: }
7430: return $result;
7431: }
7432:
7433: # ---------------------------------------------------- Devalidate courseresdata
7434:
7435: sub devalidatecourseresdata {
7436: my ($coursenum,$coursedomain)=@_;
7437: my $hashid=$coursenum.':'.$coursedomain;
7438: &devalidate_cache_new('courseres',$hashid);
7439: }
7440:
7441:
7442: # --------------------------------------------------- Course Resourcedata Query
7443: #
7444: # Parameters:
7445: # $coursenum - Number of the course.
7446: # $coursedomain - Domain at which the course was created.
7447: # Returns:
7448: # A hash of the course parameters along (I think) with timestamps
7449: # and version info.
7450:
7451: sub get_courseresdata {
7452: my ($coursenum,$coursedomain)=@_;
7453: my $coursehom=&homeserver($coursenum,$coursedomain);
7454: my $hashid=$coursenum.':'.$coursedomain;
7455: my ($result,$cached)=&is_cached_new('courseres',$hashid);
7456: my %dumpreply;
7457: unless (defined($cached)) {
7458: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
7459: $result=\%dumpreply;
7460: my ($tmp) = keys(%dumpreply);
7461: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7462: &do_cache_new('courseres',$hashid,$result,600);
7463: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7464: return $tmp;
7465: } elsif ($tmp =~ /^(error)/) {
7466: $result=undef;
7467: &do_cache_new('courseres',$hashid,$result,600);
7468: }
7469: }
7470: return $result;
7471: }
7472:
7473: sub devalidateuserresdata {
7474: my ($uname,$udom)=@_;
7475: my $hashid="$udom:$uname";
7476: &devalidate_cache_new('userres',$hashid);
7477: }
7478:
7479: sub get_userresdata {
7480: my ($uname,$udom)=@_;
7481: #most student don\'t have any data set, check if there is some data
7482: if (&EXT_cache_status($udom,$uname)) { return undef; }
7483:
7484: my $hashid="$udom:$uname";
7485: my ($result,$cached)=&is_cached_new('userres',$hashid);
7486: if (!defined($cached)) {
7487: my %resourcedata=&dump('resourcedata',$udom,$uname);
7488: $result=\%resourcedata;
7489: &do_cache_new('userres',$hashid,$result,600);
7490: }
7491: my ($tmp)=keys(%$result);
7492: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7493: return $result;
7494: }
7495: #error 2 occurs when the .db doesn't exist
7496: if ($tmp!~/error: 2 /) {
7497: &logthis("<font color=\"blue\">WARNING:".
7498: " Trying to get resource data for ".
7499: $uname." at ".$udom.": ".
7500: $tmp."</font>");
7501: } elsif ($tmp=~/error: 2 /) {
7502: #&EXT_cache_set($udom,$uname);
7503: &do_cache_new('userres',$hashid,undef,600);
7504: undef($tmp); # not really an error so don't send it back
7505: }
7506: return $tmp;
7507: }
7508: #----------------------------------------------- resdata - return resource data
7509: # Purpose:
7510: # Return resource data for either users or for a course.
7511: # Parameters:
7512: # $name - Course/user name.
7513: # $domain - Name of the domain the user/course is registered on.
7514: # $type - Type of thing $name is (must be 'course' or 'user'
7515: # @which - Array of names of resources desired.
7516: # Returns:
7517: # The value of the first reasource in @which that is found in the
7518: # resource hash.
7519: # Exceptional Conditions:
7520: # If the $type passed in is not valid (not the string 'course' or
7521: # 'user', an undefined reference is returned.
7522: # If none of the resources are found, an undef is returned
7523: sub resdata {
7524: my ($name,$domain,$type,@which)=@_;
7525: my $result;
7526: if ($type eq 'course') {
7527: $result=&get_courseresdata($name,$domain);
7528: } elsif ($type eq 'user') {
7529: $result=&get_userresdata($name,$domain);
7530: }
7531: if (!ref($result)) { return $result; }
7532: foreach my $item (@which) {
7533: if (defined($result->{$item->[0]})) {
7534: return [$result->{$item->[0]},$item->[1]];
7535: }
7536: }
7537: return undef;
7538: }
7539:
7540: #
7541: # EXT resource caching routines
7542: #
7543:
7544: sub clear_EXT_cache_status {
7545: &delenv('cache.EXT.');
7546: }
7547:
7548: sub EXT_cache_status {
7549: my ($target_domain,$target_user) = @_;
7550: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7551: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
7552: # We know already the user has no data
7553: return 1;
7554: } else {
7555: return 0;
7556: }
7557: }
7558:
7559: sub EXT_cache_set {
7560: my ($target_domain,$target_user) = @_;
7561: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
7562: #&appenv({$cachename => time});
7563: }
7564:
7565: # --------------------------------------------------------- Value of a Variable
7566: sub EXT {
7567:
7568: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
7569: unless ($varname) { return ''; }
7570: #get real user name/domain, courseid and symb
7571: my $courseid;
7572: my $publicuser;
7573: if ($symbparm) {
7574: $symbparm=&get_symb_from_alias($symbparm);
7575: }
7576: if (!($uname && $udom)) {
7577: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
7578: if (!$symbparm) { $symbparm=$cursymb; }
7579: } else {
7580: $courseid=$env{'request.course.id'};
7581: }
7582: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7583: my $rest;
7584: if (defined($therest[0])) {
7585: $rest=join('.',@therest);
7586: } else {
7587: $rest='';
7588: }
7589:
7590: my $qualifierrest=$qualifier;
7591: if ($rest) { $qualifierrest.='.'.$rest; }
7592: my $spacequalifierrest=$space;
7593: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
7594: if ($realm eq 'user') {
7595: # --------------------------------------------------------------- user.resource
7596: if ($space eq 'resource') {
7597: if ( (defined($Apache::lonhomework::parsing_a_problem)
7598: || defined($Apache::lonhomework::parsing_a_task))
7599: &&
7600: ($symbparm eq &symbread()) ) {
7601: # if we are in the middle of processing the resource the
7602: # get the value we are planning on committing
7603: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7604: return $Apache::lonhomework::results{$qualifierrest};
7605: } else {
7606: return $Apache::lonhomework::history{$qualifierrest};
7607: }
7608: } else {
7609: my %restored;
7610: if ($publicuser || $env{'request.state'} eq 'construct') {
7611: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7612: } else {
7613: %restored=&restore($symbparm,$courseid,$udom,$uname);
7614: }
7615: return $restored{$qualifierrest};
7616: }
7617: # ----------------------------------------------------------------- user.access
7618: } elsif ($space eq 'access') {
7619: # FIXME - not supporting calls for a specific user
7620: return &allowed($qualifier,$rest);
7621: # ------------------------------------------ user.preferences, user.environment
7622: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
7623: if (($uname eq $env{'user.name'}) &&
7624: ($udom eq $env{'user.domain'})) {
7625: return $env{join('.',('environment',$qualifierrest))};
7626: } else {
7627: my %returnhash;
7628: if (!$publicuser) {
7629: %returnhash=&userenvironment($udom,$uname,
7630: $qualifierrest);
7631: }
7632: return $returnhash{$qualifierrest};
7633: }
7634: # ----------------------------------------------------------------- user.course
7635: } elsif ($space eq 'course') {
7636: # FIXME - not supporting calls for a specific user
7637: return $env{join('.',('request.course',$qualifier))};
7638: # ------------------------------------------------------------------- user.role
7639: } elsif ($space eq 'role') {
7640: # FIXME - not supporting calls for a specific user
7641: my ($role,$where)=split(/\./,$env{'request.role'});
7642: if ($qualifier eq 'value') {
7643: return $role;
7644: } elsif ($qualifier eq 'extent') {
7645: return $where;
7646: }
7647: # ----------------------------------------------------------------- user.domain
7648: } elsif ($space eq 'domain') {
7649: return $udom;
7650: # ------------------------------------------------------------------- user.name
7651: } elsif ($space eq 'name') {
7652: return $uname;
7653: # ---------------------------------------------------- Any other user namespace
7654: } else {
7655: my %reply;
7656: if (!$publicuser) {
7657: %reply=&get($space,[$qualifierrest],$udom,$uname);
7658: }
7659: return $reply{$qualifierrest};
7660: }
7661: } elsif ($realm eq 'query') {
7662: # ---------------------------------------------- pull stuff out of query string
7663: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7664: [$spacequalifierrest]);
7665: return $env{'form.'.$spacequalifierrest};
7666: } elsif ($realm eq 'request') {
7667: # ------------------------------------------------------------- request.browser
7668: if ($space eq 'browser') {
7669: if ($qualifier eq 'textremote') {
7670: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
7671: return 1;
7672: } else {
7673: return 0;
7674: }
7675: } else {
7676: return $env{'browser.'.$qualifier};
7677: }
7678: # ------------------------------------------------------------ request.filename
7679: } else {
7680: return $env{'request.'.$spacequalifierrest};
7681: }
7682: } elsif ($realm eq 'course') {
7683: # ---------------------------------------------------------- course.description
7684: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
7685: } elsif ($realm eq 'resource') {
7686:
7687: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
7688: if (!$symbparm) { $symbparm=&symbread(); }
7689: }
7690:
7691: if ($space eq 'title') {
7692: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7693: return &gettitle($symbparm);
7694: }
7695:
7696: if ($space eq 'map') {
7697: my ($map) = &decode_symb($symbparm);
7698: return &symbread($map);
7699: }
7700: if ($space eq 'filename') {
7701: if ($symbparm) {
7702: return &clutter((&decode_symb($symbparm))[2]);
7703: }
7704: return &hreflocation('',$env{'request.filename'});
7705: }
7706:
7707: my ($section, $group, @groups);
7708: my ($courselevelm,$courselevel);
7709: if ($symbparm && defined($courseid) &&
7710: $courseid eq $env{'request.course.id'}) {
7711:
7712: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
7713:
7714: # ----------------------------------------------------- Cascading lookup scheme
7715: my $symbp=$symbparm;
7716: my $mapp=&deversion((&decode_symb($symbp))[0]);
7717:
7718: my $symbparm=$symbp.'.'.$spacequalifierrest;
7719: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7720:
7721: if (($env{'user.name'} eq $uname) &&
7722: ($env{'user.domain'} eq $udom)) {
7723: $section=$env{'request.course.sec'};
7724: @groups = split(/:/,$env{'request.course.groups'});
7725: @groups=&sort_course_groups($courseid,@groups);
7726: } else {
7727: if (! defined($usection)) {
7728: $section=&getsection($udom,$uname,$courseid);
7729: } else {
7730: $section = $usection;
7731: }
7732: @groups = &get_users_groups($udom,$uname,$courseid);
7733: }
7734:
7735: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7736: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7737: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7738:
7739: $courselevel=$courseid.'.'.$spacequalifierrest;
7740: my $courselevelr=$courseid.'.'.$symbparm;
7741: $courselevelm=$courseid.'.'.$mapparm;
7742:
7743: # ----------------------------------------------------------- first, check user
7744:
7745: my $userreply=&resdata($uname,$udom,'user',
7746: ([$courselevelr,'resource'],
7747: [$courselevelm,'map' ],
7748: [$courselevel, 'course' ]));
7749: if (defined($userreply)) { return &get_reply($userreply); }
7750:
7751: # ------------------------------------------------ second, check some of course
7752: my $coursereply;
7753: if (@groups > 0) {
7754: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7755: $mapparm,$spacequalifierrest);
7756: if (defined($coursereply)) { return &get_reply($coursereply); }
7757: }
7758:
7759: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7760: $env{'course.'.$courseid.'.domain'},
7761: 'course',
7762: ([$seclevelr, 'resource'],
7763: [$seclevelm, 'map' ],
7764: [$seclevel, 'course' ],
7765: [$courselevelr,'resource']));
7766: if (defined($coursereply)) { return &get_reply($coursereply); }
7767:
7768: # ------------------------------------------------------ third, check map parms
7769: my %parmhash=();
7770: my $thisparm='';
7771: if (tie(%parmhash,'GDBM_File',
7772: $env{'request.course.fn'}.'_parms.db',
7773: &GDBM_READER(),0640)) {
7774: $thisparm=$parmhash{$symbparm};
7775: untie(%parmhash);
7776: }
7777: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
7778: }
7779: # ------------------------------------------ fourth, look in resource metadata
7780:
7781: $spacequalifierrest=~s/\./\_/;
7782: my $filename;
7783: if (!$symbparm) { $symbparm=&symbread(); }
7784: if ($symbparm) {
7785: $filename=(&decode_symb($symbparm))[2];
7786: } else {
7787: $filename=$env{'request.filename'};
7788: }
7789: my $metadata=&metadata($filename,$spacequalifierrest);
7790: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7791: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
7792: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
7793:
7794: # ---------------------------------------------- fourth, look in rest of course
7795: if ($symbparm && defined($courseid) &&
7796: $courseid eq $env{'request.course.id'}) {
7797: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7798: $env{'course.'.$courseid.'.domain'},
7799: 'course',
7800: ([$courselevelm,'map' ],
7801: [$courselevel, 'course']));
7802: if (defined($coursereply)) { return &get_reply($coursereply); }
7803: }
7804: # ------------------------------------------------------------------ Cascade up
7805: unless ($space eq '0') {
7806: my @parts=split(/_/,$space);
7807: my $id=pop(@parts);
7808: my $part=join('_',@parts);
7809: if ($part eq '') { $part='0'; }
7810: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
7811: $symbparm,$udom,$uname,$section,1);
7812: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
7813: }
7814: if ($recurse) { return undef; }
7815: my $pack_def=&packages_tab_default($filename,$varname);
7816: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
7817: # ---------------------------------------------------- Any other user namespace
7818: } elsif ($realm eq 'environment') {
7819: # ----------------------------------------------------------------- environment
7820: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7821: return $env{'environment.'.$spacequalifierrest};
7822: } else {
7823: if ($uname eq 'anonymous' && $udom eq '') {
7824: return '';
7825: }
7826: my %returnhash=&userenvironment($udom,$uname,
7827: $spacequalifierrest);
7828: return $returnhash{$spacequalifierrest};
7829: }
7830: } elsif ($realm eq 'system') {
7831: # ----------------------------------------------------------------- system.time
7832: if ($space eq 'time') {
7833: return time;
7834: }
7835: } elsif ($realm eq 'server') {
7836: # ----------------------------------------------------------------- system.time
7837: if ($space eq 'name') {
7838: return $ENV{'SERVER_NAME'};
7839: }
7840: }
7841: return '';
7842: }
7843:
7844: sub get_reply {
7845: my ($reply_value) = @_;
7846: if (ref($reply_value) eq 'ARRAY') {
7847: if (wantarray) {
7848: return @$reply_value;
7849: }
7850: return $reply_value->[0];
7851: } else {
7852: return $reply_value;
7853: }
7854: }
7855:
7856: sub check_group_parms {
7857: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
7858: my @groupitems = ();
7859: my $resultitem;
7860: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
7861: foreach my $group (@{$groups}) {
7862: foreach my $level (@levels) {
7863: my $item = $courseid.'.['.$group.'].'.$level->[0];
7864: push(@groupitems,[$item,$level->[1]]);
7865: }
7866: }
7867: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
7868: $env{'course.'.$courseid.'.domain'},
7869: 'course',@groupitems);
7870: return $coursereply;
7871: }
7872:
7873: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
7874: my ($courseid,@groups) = @_;
7875: @groups = sort(@groups);
7876: return @groups;
7877: }
7878:
7879: sub packages_tab_default {
7880: my ($uri,$varname)=@_;
7881: my (undef,$part,$name)=split(/\./,$varname);
7882:
7883: my (@extension,@specifics,$do_default);
7884: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
7885: my ($pack_type,$pack_part)=split(/_/,$package,2);
7886: if ($pack_type eq 'default') {
7887: $do_default=1;
7888: } elsif ($pack_type eq 'extension') {
7889: push(@extension,[$package,$pack_type,$pack_part]);
7890: } elsif ($pack_part eq $part || $pack_type eq 'part') {
7891: # only look at packages defaults for packages that this id is
7892: push(@specifics,[$package,$pack_type,$pack_part]);
7893: }
7894: }
7895: # first look for a package that matches the requested part id
7896: foreach my $package (@specifics) {
7897: my (undef,$pack_type,$pack_part)=@{$package};
7898: next if ($pack_part ne $part);
7899: if (defined($packagetab{"$pack_type&$name&default"})) {
7900: return $packagetab{"$pack_type&$name&default"};
7901: }
7902: }
7903: # look for any possible matching non extension_ package
7904: foreach my $package (@specifics) {
7905: my (undef,$pack_type,$pack_part)=@{$package};
7906: if (defined($packagetab{"$pack_type&$name&default"})) {
7907: return $packagetab{"$pack_type&$name&default"};
7908: }
7909: if ($pack_type eq 'part') { $pack_part='0'; }
7910: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
7911: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
7912: }
7913: }
7914: # look for any posible extension_ match
7915: foreach my $package (@extension) {
7916: my ($package,$pack_type)=@{$package};
7917: if (defined($packagetab{"$pack_type&$name&default"})) {
7918: return $packagetab{"$pack_type&$name&default"};
7919: }
7920: if (defined($packagetab{$package."&$name&default"})) {
7921: return $packagetab{$package."&$name&default"};
7922: }
7923: }
7924: # look for a global default setting
7925: if ($do_default && defined($packagetab{"default&$name&default"})) {
7926: return $packagetab{"default&$name&default"};
7927: }
7928: return undef;
7929: }
7930:
7931: sub add_prefix_and_part {
7932: my ($prefix,$part)=@_;
7933: my $keyroot;
7934: if (defined($prefix) && $prefix !~ /^__/) {
7935: # prefix that has a part already
7936: $keyroot=$prefix;
7937: } elsif (defined($prefix)) {
7938: # prefix that is missing a part
7939: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
7940: } else {
7941: # no prefix at all
7942: if (defined($part)) { $keyroot='_'.$part; }
7943: }
7944: return $keyroot;
7945: }
7946:
7947: # ---------------------------------------------------------------- Get metadata
7948:
7949: my %metaentry;
7950: sub metadata {
7951: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
7952: $uri=&declutter($uri);
7953: # if it is a non metadata possible uri return quickly
7954: if (($uri eq '') ||
7955: (($uri =~ m|^/*adm/|) &&
7956: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
7957: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
7958: return undef;
7959: }
7960: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
7961: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
7962: return undef;
7963: }
7964: my $filename=$uri;
7965: $uri=~s/\.meta$//;
7966: #
7967: # Is the metadata already cached?
7968: # Look at timestamp of caching
7969: # Everything is cached by the main uri, libraries are never directly cached
7970: #
7971: if (!defined($liburi)) {
7972: my ($result,$cached)=&is_cached_new('meta',$uri);
7973: if (defined($cached)) { return $result->{':'.$what}; }
7974: }
7975: {
7976: #
7977: # Is this a recursive call for a library?
7978: #
7979: # if (! exists($metacache{$uri})) {
7980: # $metacache{$uri}={};
7981: # }
7982: my $cachetime = 60*60;
7983: if ($liburi) {
7984: $liburi=&declutter($liburi);
7985: $filename=$liburi;
7986: } else {
7987: &devalidate_cache_new('meta',$uri);
7988: undef(%metaentry);
7989: }
7990: my %metathesekeys=();
7991: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
7992: my $metastring;
7993: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
7994: my $which = &hreflocation('','/'.($liburi || $uri));
7995: $metastring =
7996: &Apache::lonnet::ssi_body($which,
7997: ('grade_target' => 'meta'));
7998: $cachetime = 1; # only want this cached in the child not long term
7999: } elsif ($uri !~ m -^(editupload)/-) {
8000: my $file=&filelocation('',&clutter($filename));
8001: #push(@{$metaentry{$uri.'.file'}},$file);
8002: $metastring=&getfile($file);
8003: }
8004: my $parser=HTML::LCParser->new(\$metastring);
8005: my $token;
8006: undef %metathesekeys;
8007: while ($token=$parser->get_token) {
8008: if ($token->[0] eq 'S') {
8009: if (defined($token->[2]->{'package'})) {
8010: #
8011: # This is a package - get package info
8012: #
8013: my $package=$token->[2]->{'package'};
8014: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8015: if (defined($token->[2]->{'id'})) {
8016: $keyroot.='_'.$token->[2]->{'id'};
8017: }
8018: if ($metaentry{':packages'}) {
8019: $metaentry{':packages'}.=','.$package.$keyroot;
8020: } else {
8021: $metaentry{':packages'}=$package.$keyroot;
8022: }
8023: foreach my $pack_entry (keys(%packagetab)) {
8024: my $part=$keyroot;
8025: $part=~s/^\_//;
8026: if ($pack_entry=~/^\Q$package\E\&/ ||
8027: $pack_entry=~/^\Q$package\E_0\&/) {
8028: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
8029: # ignore package.tab specified default values
8030: # here &package_tab_default() will fetch those
8031: if ($subp eq 'default') { next; }
8032: my $value=$packagetab{$pack_entry};
8033: my $unikey;
8034: if ($pack =~ /_0$/) {
8035: $unikey='parameter_0_'.$name;
8036: $part=0;
8037: } else {
8038: $unikey='parameter'.$keyroot.'_'.$name;
8039: }
8040: if ($subp eq 'display') {
8041: $value.=' [Part: '.$part.']';
8042: }
8043: $metaentry{':'.$unikey.'.part'}=$part;
8044: $metathesekeys{$unikey}=1;
8045: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8046: $metaentry{':'.$unikey.'.'.$subp}=$value;
8047: }
8048: if (defined($metaentry{':'.$unikey.'.default'})) {
8049: $metaentry{':'.$unikey}=
8050: $metaentry{':'.$unikey.'.default'};
8051: }
8052: }
8053: }
8054: } else {
8055: #
8056: # This is not a package - some other kind of start tag
8057: #
8058: my $entry=$token->[1];
8059: my $unikey;
8060: if ($entry eq 'import') {
8061: $unikey='';
8062: } else {
8063: $unikey=$entry;
8064: }
8065: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8066:
8067: if (defined($token->[2]->{'id'})) {
8068: $unikey.='_'.$token->[2]->{'id'};
8069: }
8070:
8071: if ($entry eq 'import') {
8072: #
8073: # Importing a library here
8074: #
8075: if ($depthcount<20) {
8076: my $location=$parser->get_text('/import');
8077: my $dir=$filename;
8078: $dir=~s|[^/]*$||;
8079: $location=&filelocation($dir,$location);
8080: my $metadata =
8081: &metadata($uri,'keys', $location,$unikey,
8082: $depthcount+1);
8083: foreach my $meta (split(',',$metadata)) {
8084: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8085: $metathesekeys{$meta}=1;
8086: }
8087: }
8088: } else {
8089:
8090: if (defined($token->[2]->{'name'})) {
8091: $unikey.='_'.$token->[2]->{'name'};
8092: }
8093: $metathesekeys{$unikey}=1;
8094: foreach my $param (@{$token->[3]}) {
8095: $metaentry{':'.$unikey.'.'.$param} =
8096: $token->[2]->{$param};
8097: }
8098: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
8099: my $default=$metaentry{':'.$unikey.'.default'};
8100: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8101: # only ws inside the tag, and not in default, so use default
8102: # as value
8103: $metaentry{':'.$unikey}=$default;
8104: } elsif ( $internaltext =~ /\S/ ) {
8105: # something interesting inside the tag
8106: $metaentry{':'.$unikey}=$internaltext;
8107: } else {
8108: # no interesting values, don't set a default
8109: }
8110: # end of not-a-package not-a-library import
8111: }
8112: # end of not-a-package start tag
8113: }
8114: # the next is the end of "start tag"
8115: }
8116: }
8117: my ($extension) = ($uri =~ /\.(\w+)$/);
8118: $extension = lc($extension);
8119: if ($extension eq 'htm') { $extension='html'; }
8120:
8121: foreach my $key (keys(%packagetab)) {
8122: #no specific packages #how's our extension
8123: if ($key!~/^extension_\Q$extension\E&/) { next; }
8124: &metadata_create_package_def($uri,$key,'extension_'.$extension,
8125: \%metathesekeys);
8126: }
8127:
8128: if (!exists($metaentry{':packages'})
8129: || $packagetab{"import_defaults&extension_$extension"}) {
8130: foreach my $key (keys(%packagetab)) {
8131: #no specific packages well let's get default then
8132: if ($key!~/^default&/) { next; }
8133: &metadata_create_package_def($uri,$key,'default',
8134: \%metathesekeys);
8135: }
8136: }
8137: # are there custom rights to evaluate
8138: if ($metaentry{':copyright'} eq 'custom') {
8139:
8140: #
8141: # Importing a rights file here
8142: #
8143: unless ($depthcount) {
8144: my $location=$metaentry{':customdistributionfile'};
8145: my $dir=$filename;
8146: $dir=~s|[^/]*$||;
8147: $location=&filelocation($dir,$location);
8148: my $rights_metadata =
8149: &metadata($uri,'keys',$location,'_rights',
8150: $depthcount+1);
8151: foreach my $rights (split(',',$rights_metadata)) {
8152: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8153: $metathesekeys{$rights}=1;
8154: }
8155: }
8156: }
8157: # uniqifiy package listing
8158: my %seen;
8159: my @uniq_packages =
8160: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8161: $metaentry{':packages'} = join(',',@uniq_packages);
8162:
8163: $metaentry{':keys'} = join(',',keys(%metathesekeys));
8164: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8165: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
8166: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
8167: # this is the end of "was not already recently cached
8168: }
8169: return $metaentry{':'.$what};
8170: }
8171:
8172: sub metadata_create_package_def {
8173: my ($uri,$key,$package,$metathesekeys)=@_;
8174: my ($pack,$name,$subp)=split(/\&/,$key);
8175: if ($subp eq 'default') { next; }
8176:
8177: if (defined($metaentry{':packages'})) {
8178: $metaentry{':packages'}.=','.$package;
8179: } else {
8180: $metaentry{':packages'}=$package;
8181: }
8182: my $value=$packagetab{$key};
8183: my $unikey;
8184: $unikey='parameter_0_'.$name;
8185: $metaentry{':'.$unikey.'.part'}=0;
8186: $$metathesekeys{$unikey}=1;
8187: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8188: $metaentry{':'.$unikey.'.'.$subp}=$value;
8189: }
8190: if (defined($metaentry{':'.$unikey.'.default'})) {
8191: $metaentry{':'.$unikey}=
8192: $metaentry{':'.$unikey.'.default'};
8193: }
8194: }
8195:
8196: sub metadata_generate_part0 {
8197: my ($metadata,$metacache,$uri) = @_;
8198: my %allnames;
8199: foreach my $metakey (keys(%$metadata)) {
8200: if ($metakey=~/^parameter\_(.*)/) {
8201: my $part=$$metacache{':'.$metakey.'.part'};
8202: my $name=$$metacache{':'.$metakey.'.name'};
8203: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
8204: $allnames{$name}=$part;
8205: }
8206: }
8207: }
8208: foreach my $name (keys(%allnames)) {
8209: $$metadata{"parameter_0_$name"}=1;
8210: my $key=":parameter_0_$name";
8211: $$metacache{"$key.part"}='0';
8212: $$metacache{"$key.name"}=$name;
8213: $$metacache{"$key.type"}=$$metacache{':parameter_'.
8214: $allnames{$name}.'_'.$name.
8215: '.type'};
8216: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
8217: '.display'};
8218: my $expr='[Part: '.$allnames{$name}.']';
8219: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
8220: $$metacache{"$key.display"}=$olddis;
8221: }
8222: }
8223:
8224: # ------------------------------------------------------ Devalidate title cache
8225:
8226: sub devalidate_title_cache {
8227: my ($url)=@_;
8228: if (!$env{'request.course.id'}) { return; }
8229: my $symb=&symbread($url);
8230: if (!$symb) { return; }
8231: my $key=$env{'request.course.id'}."\0".$symb;
8232: &devalidate_cache_new('title',$key);
8233: }
8234:
8235: # ------------------------------------------------- Get the title of a course
8236:
8237: sub current_course_title {
8238: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8239: }
8240: # ------------------------------------------------- Get the title of a resource
8241:
8242: sub gettitle {
8243: my $urlsymb=shift;
8244: my $symb=&symbread($urlsymb);
8245: if ($symb) {
8246: my $key=$env{'request.course.id'}."\0".$symb;
8247: my ($result,$cached)=&is_cached_new('title',$key);
8248: if (defined($cached)) {
8249: return $result;
8250: }
8251: my ($map,$resid,$url)=&decode_symb($symb);
8252: my $title='';
8253: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8254: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8255: } else {
8256: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8257: &GDBM_READER(),0640)) {
8258: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8259: $title=$bighash{'title_'.$mapid.'.'.$resid};
8260: untie(%bighash);
8261: }
8262: }
8263: $title=~s/\&colon\;/\:/gs;
8264: if ($title) {
8265: return &do_cache_new('title',$key,$title,600);
8266: }
8267: $urlsymb=$url;
8268: }
8269: my $title=&metadata($urlsymb,'title');
8270: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8271: return $title;
8272: }
8273:
8274: sub get_slot {
8275: my ($which,$cnum,$cdom)=@_;
8276: if (!$cnum || !$cdom) {
8277: (undef,my $courseid)=&whichuser();
8278: $cdom=$env{'course.'.$courseid.'.domain'};
8279: $cnum=$env{'course.'.$courseid.'.num'};
8280: }
8281: my $key=join("\0",'slots',$cdom,$cnum,$which);
8282: my %slotinfo;
8283: if (exists($remembered{$key})) {
8284: $slotinfo{$which} = $remembered{$key};
8285: } else {
8286: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8287: &Apache::lonhomework::showhash(%slotinfo);
8288: my ($tmp)=keys(%slotinfo);
8289: if ($tmp=~/^error:/) { return (); }
8290: $remembered{$key} = $slotinfo{$which};
8291: }
8292: if (ref($slotinfo{$which}) eq 'HASH') {
8293: return %{$slotinfo{$which}};
8294: }
8295: return $slotinfo{$which};
8296: }
8297: # ------------------------------------------------- Update symbolic store links
8298:
8299: sub symblist {
8300: my ($mapname,%newhash)=@_;
8301: $mapname=&deversion(&declutter($mapname));
8302: my %hash;
8303: if (($env{'request.course.fn'}) && (%newhash)) {
8304: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8305: &GDBM_WRCREAT(),0640)) {
8306: foreach my $url (keys(%newhash)) {
8307: next if ($url eq 'last_known'
8308: && $env{'form.no_update_last_known'});
8309: $hash{declutter($url)}=&encode_symb($mapname,
8310: $newhash{$url}->[1],
8311: $newhash{$url}->[0]);
8312: }
8313: if (untie(%hash)) {
8314: return 'ok';
8315: }
8316: }
8317: }
8318: return 'error';
8319: }
8320:
8321: # --------------------------------------------------------------- Verify a symb
8322:
8323: sub symbverify {
8324: my ($symb,$thisurl)=@_;
8325: my $thisfn=$thisurl;
8326: $thisfn=&declutter($thisfn);
8327: # direct jump to resource in page or to a sequence - will construct own symbs
8328: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8329: # check URL part
8330: my ($map,$resid,$url)=&decode_symb($symb);
8331:
8332: unless ($url eq $thisfn) { return 0; }
8333:
8334: $symb=&symbclean($symb);
8335: $thisurl=&deversion($thisurl);
8336: $thisfn=&deversion($thisfn);
8337:
8338: my %bighash;
8339: my $okay=0;
8340:
8341: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8342: &GDBM_READER(),0640)) {
8343: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8344: $thisurl =~ s/\?.+$//;
8345: }
8346: my $ids=$bighash{'ids_'.&clutter($thisurl)};
8347: unless ($ids) {
8348: $ids=$bighash{'ids_/'.$thisurl};
8349: }
8350: if ($ids) {
8351: # ------------------------------------------------------------------- Has ID(s)
8352: foreach my $id (split(/\,/,$ids)) {
8353: my ($mapid,$resid)=split(/\./,$id);
8354: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8355: $symb =~ s/\?.+$//;
8356: }
8357: if (
8358: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8359: eq $symb) {
8360: if (($env{'request.role.adv'}) ||
8361: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
8362: $okay=1;
8363: }
8364: }
8365: }
8366: }
8367: untie(%bighash);
8368: }
8369: return $okay;
8370: }
8371:
8372: # --------------------------------------------------------------- Clean-up symb
8373:
8374: sub symbclean {
8375: my $symb=shift;
8376: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8377: # remove version from map
8378: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
8379:
8380: # remove version from URL
8381: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
8382:
8383: # remove wrapper
8384:
8385: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
8386: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
8387: return $symb;
8388: }
8389:
8390: # ---------------------------------------------- Split symb to find map and url
8391:
8392: sub encode_symb {
8393: my ($map,$resid,$url)=@_;
8394: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8395: }
8396:
8397: sub decode_symb {
8398: my $symb=shift;
8399: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8400: my ($map,$resid,$url)=split(/___/,$symb);
8401: return (&fixversion($map),$resid,&fixversion($url));
8402: }
8403:
8404: sub fixversion {
8405: my $fn=shift;
8406: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
8407: my %bighash;
8408: my $uri=&clutter($fn);
8409: my $key=$env{'request.course.id'}.'_'.$uri;
8410: # is this cached?
8411: my ($result,$cached)=&is_cached_new('courseresversion',$key);
8412: if (defined($cached)) { return $result; }
8413: # unfortunately not cached, or expired
8414: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8415: &GDBM_READER(),0640)) {
8416: if ($bighash{'version_'.$uri}) {
8417: my $version=$bighash{'version_'.$uri};
8418: unless (($version eq 'mostrecent') ||
8419: ($version==&getversion($uri))) {
8420: $uri=~s/\.(\w+)$/\.$version\.$1/;
8421: }
8422: }
8423: untie %bighash;
8424: }
8425: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
8426: }
8427:
8428: sub deversion {
8429: my $url=shift;
8430: $url=~s/\.\d+\.(\w+)$/\.$1/;
8431: return $url;
8432: }
8433:
8434: # ------------------------------------------------------ Return symb list entry
8435:
8436: sub symbread {
8437: my ($thisfn,$donotrecurse)=@_;
8438: my $cache_str='request.symbread.cached.'.$thisfn;
8439: if (defined($env{$cache_str})) { return $env{$cache_str}; }
8440: # no filename provided? try from environment
8441: unless ($thisfn) {
8442: if ($env{'request.symb'}) {
8443: return $env{$cache_str}=&symbclean($env{'request.symb'});
8444: }
8445: $thisfn=$env{'request.filename'};
8446: }
8447: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
8448: # is that filename actually a symb? Verify, clean, and return
8449: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
8450: if (&symbverify($thisfn,$1)) {
8451: return $env{$cache_str}=&symbclean($thisfn);
8452: }
8453: }
8454: $thisfn=declutter($thisfn);
8455: my %hash;
8456: my %bighash;
8457: my $syval='';
8458: if (($env{'request.course.fn'}) && ($thisfn)) {
8459: my $targetfn = $thisfn;
8460: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
8461: $targetfn = 'adm/wrapper/'.$thisfn;
8462: }
8463: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8464: $targetfn=$1;
8465: }
8466: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
8467: &GDBM_READER(),0640)) {
8468: $syval=$hash{$targetfn};
8469: untie(%hash);
8470: }
8471: # ---------------------------------------------------------- There was an entry
8472: if ($syval) {
8473: #unless ($syval=~/\_\d+$/) {
8474: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
8475: #&appenv({'request.ambiguous' => $thisfn});
8476: #return $env{$cache_str}='';
8477: #}
8478: #$syval.=$1;
8479: #}
8480: } else {
8481: # ------------------------------------------------------- Was not in symb table
8482: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8483: &GDBM_READER(),0640)) {
8484: # ---------------------------------------------- Get ID(s) for current resource
8485: my $ids=$bighash{'ids_'.&clutter($thisfn)};
8486: unless ($ids) {
8487: $ids=$bighash{'ids_/'.$thisfn};
8488: }
8489: unless ($ids) {
8490: # alias?
8491: $ids=$bighash{'mapalias_'.$thisfn};
8492: }
8493: if ($ids) {
8494: # ------------------------------------------------------------------- Has ID(s)
8495: my @possibilities=split(/\,/,$ids);
8496: if ($#possibilities==0) {
8497: # ----------------------------------------------- There is only one possibility
8498: my ($mapid,$resid)=split(/\./,$ids);
8499: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8500: $resid,$thisfn);
8501: } elsif (!$donotrecurse) {
8502: # ------------------------------------------ There is more than one possibility
8503: my $realpossible=0;
8504: foreach my $id (@possibilities) {
8505: my $file=$bighash{'src_'.$id};
8506: if (&allowed('bre',$file)) {
8507: my ($mapid,$resid)=split(/\./,$id);
8508: if ($bighash{'map_type_'.$mapid} ne 'page') {
8509: $realpossible++;
8510: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8511: $resid,$thisfn);
8512: }
8513: }
8514: }
8515: if ($realpossible!=1) { $syval=''; }
8516: } else {
8517: $syval='';
8518: }
8519: }
8520: untie(%bighash)
8521: }
8522: }
8523: if ($syval) {
8524: return $env{$cache_str}=$syval;
8525: }
8526: }
8527: &appenv({'request.ambiguous' => $thisfn});
8528: return $env{$cache_str}='';
8529: }
8530:
8531: # ---------------------------------------------------------- Return random seed
8532:
8533: sub numval {
8534: my $txt=shift;
8535: $txt=~tr/A-J/0-9/;
8536: $txt=~tr/a-j/0-9/;
8537: $txt=~tr/K-T/0-9/;
8538: $txt=~tr/k-t/0-9/;
8539: $txt=~tr/U-Z/0-5/;
8540: $txt=~tr/u-z/0-5/;
8541: $txt=~s/\D//g;
8542: if ($_64bit) { if ($txt > 2**32) { return -1; } }
8543: return int($txt);
8544: }
8545:
8546: sub numval2 {
8547: my $txt=shift;
8548: $txt=~tr/A-J/0-9/;
8549: $txt=~tr/a-j/0-9/;
8550: $txt=~tr/K-T/0-9/;
8551: $txt=~tr/k-t/0-9/;
8552: $txt=~tr/U-Z/0-5/;
8553: $txt=~tr/u-z/0-5/;
8554: $txt=~s/\D//g;
8555: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8556: my $total;
8557: foreach my $val (@txts) { $total+=$val; }
8558: if ($_64bit) { if ($total > 2**32) { return -1; } }
8559: return int($total);
8560: }
8561:
8562: sub numval3 {
8563: use integer;
8564: my $txt=shift;
8565: $txt=~tr/A-J/0-9/;
8566: $txt=~tr/a-j/0-9/;
8567: $txt=~tr/K-T/0-9/;
8568: $txt=~tr/k-t/0-9/;
8569: $txt=~tr/U-Z/0-5/;
8570: $txt=~tr/u-z/0-5/;
8571: $txt=~s/\D//g;
8572: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8573: my $total;
8574: foreach my $val (@txts) { $total+=$val; }
8575: if ($_64bit) { $total=(($total<<32)>>32); }
8576: return $total;
8577: }
8578:
8579: sub digest {
8580: my ($data)=@_;
8581: my $digest=&Digest::MD5::md5($data);
8582: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8583: my ($e,$f);
8584: {
8585: use integer;
8586: $e=($a+$b);
8587: $f=($c+$d);
8588: if ($_64bit) {
8589: $e=(($e<<32)>>32);
8590: $f=(($f<<32)>>32);
8591: }
8592: }
8593: if (wantarray) {
8594: return ($e,$f);
8595: } else {
8596: my $g;
8597: {
8598: use integer;
8599: $g=($e+$f);
8600: if ($_64bit) {
8601: $g=(($g<<32)>>32);
8602: }
8603: }
8604: return $g;
8605: }
8606: }
8607:
8608: sub latest_rnd_algorithm_id {
8609: return '64bit5';
8610: }
8611:
8612: sub get_rand_alg {
8613: my ($courseid)=@_;
8614: if (!$courseid) { $courseid=(&whichuser())[1]; }
8615: if ($courseid) {
8616: return $env{"course.$courseid.rndseed"};
8617: }
8618: return &latest_rnd_algorithm_id();
8619: }
8620:
8621: sub validCODE {
8622: my ($CODE)=@_;
8623: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8624: return 0;
8625: }
8626:
8627: sub getCODE {
8628: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
8629: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8630: defined($Apache::lonhomework::parsing_a_task) ) &&
8631: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
8632: return $Apache::lonhomework::history{'resource.CODE'};
8633: }
8634: return undef;
8635: }
8636:
8637: sub rndseed {
8638: my ($symb,$courseid,$domain,$username)=@_;
8639: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
8640: if (!defined($symb)) {
8641: unless ($symb=$wsymb) { return time; }
8642: }
8643: if (!$courseid) { $courseid=$wcourseid; }
8644: if (!$domain) { $domain=$wdomain; }
8645: if (!$username) { $username=$wusername }
8646: my $which=&get_rand_alg();
8647:
8648: if (defined(&getCODE())) {
8649: if ($which eq '64bit5') {
8650: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8651: } elsif ($which eq '64bit4') {
8652: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8653: } else {
8654: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8655: }
8656: } elsif ($which eq '64bit5') {
8657: return &rndseed_64bit5($symb,$courseid,$domain,$username);
8658: } elsif ($which eq '64bit4') {
8659: return &rndseed_64bit4($symb,$courseid,$domain,$username);
8660: } elsif ($which eq '64bit3') {
8661: return &rndseed_64bit3($symb,$courseid,$domain,$username);
8662: } elsif ($which eq '64bit2') {
8663: return &rndseed_64bit2($symb,$courseid,$domain,$username);
8664: } elsif ($which eq '64bit') {
8665: return &rndseed_64bit($symb,$courseid,$domain,$username);
8666: }
8667: return &rndseed_32bit($symb,$courseid,$domain,$username);
8668: }
8669:
8670: sub rndseed_32bit {
8671: my ($symb,$courseid,$domain,$username)=@_;
8672: {
8673: use integer;
8674: my $symbchck=unpack("%32C*",$symb) << 27;
8675: my $symbseed=numval($symb) << 22;
8676: my $namechck=unpack("%32C*",$username) << 17;
8677: my $nameseed=numval($username) << 12;
8678: my $domainseed=unpack("%32C*",$domain) << 7;
8679: my $courseseed=unpack("%32C*",$courseid);
8680: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
8681: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8682: #&logthis("rndseed :$num:$symb");
8683: if ($_64bit) { $num=(($num<<32)>>32); }
8684: return $num;
8685: }
8686: }
8687:
8688: sub rndseed_64bit {
8689: my ($symb,$courseid,$domain,$username)=@_;
8690: {
8691: use integer;
8692: my $symbchck=unpack("%32S*",$symb) << 21;
8693: my $symbseed=numval($symb) << 10;
8694: my $namechck=unpack("%32S*",$username);
8695:
8696: my $nameseed=numval($username) << 21;
8697: my $domainseed=unpack("%32S*",$domain) << 10;
8698: my $courseseed=unpack("%32S*",$courseid);
8699:
8700: my $num1=$symbchck+$symbseed+$namechck;
8701: my $num2=$nameseed+$domainseed+$courseseed;
8702: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8703: #&logthis("rndseed :$num:$symb");
8704: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8705: return "$num1,$num2";
8706: }
8707: }
8708:
8709: sub rndseed_64bit2 {
8710: my ($symb,$courseid,$domain,$username)=@_;
8711: {
8712: use integer;
8713: # strings need to be an even # of cahracters long, it it is odd the
8714: # last characters gets thrown away
8715: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8716: my $symbseed=numval($symb) << 10;
8717: my $namechck=unpack("%32S*",$username.' ');
8718:
8719: my $nameseed=numval($username) << 21;
8720: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8721: my $courseseed=unpack("%32S*",$courseid.' ');
8722:
8723: my $num1=$symbchck+$symbseed+$namechck;
8724: my $num2=$nameseed+$domainseed+$courseseed;
8725: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8726: #&logthis("rndseed :$num:$symb");
8727: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8728: return "$num1,$num2";
8729: }
8730: }
8731:
8732: sub rndseed_64bit3 {
8733: my ($symb,$courseid,$domain,$username)=@_;
8734: {
8735: use integer;
8736: # strings need to be an even # of cahracters long, it it is odd the
8737: # last characters gets thrown away
8738: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8739: my $symbseed=numval2($symb) << 10;
8740: my $namechck=unpack("%32S*",$username.' ');
8741:
8742: my $nameseed=numval2($username) << 21;
8743: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8744: my $courseseed=unpack("%32S*",$courseid.' ');
8745:
8746: my $num1=$symbchck+$symbseed+$namechck;
8747: my $num2=$nameseed+$domainseed+$courseseed;
8748: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8749: #&logthis("rndseed :$num1:$num2:$_64bit");
8750: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8751:
8752: return "$num1:$num2";
8753: }
8754: }
8755:
8756: sub rndseed_64bit4 {
8757: my ($symb,$courseid,$domain,$username)=@_;
8758: {
8759: use integer;
8760: # strings need to be an even # of cahracters long, it it is odd the
8761: # last characters gets thrown away
8762: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8763: my $symbseed=numval3($symb) << 10;
8764: my $namechck=unpack("%32S*",$username.' ');
8765:
8766: my $nameseed=numval3($username) << 21;
8767: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8768: my $courseseed=unpack("%32S*",$courseid.' ');
8769:
8770: my $num1=$symbchck+$symbseed+$namechck;
8771: my $num2=$nameseed+$domainseed+$courseseed;
8772: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8773: #&logthis("rndseed :$num1:$num2:$_64bit");
8774: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8775:
8776: return "$num1:$num2";
8777: }
8778: }
8779:
8780: sub rndseed_64bit5 {
8781: my ($symb,$courseid,$domain,$username)=@_;
8782: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8783: return "$num1:$num2";
8784: }
8785:
8786: sub rndseed_CODE_64bit {
8787: my ($symb,$courseid,$domain,$username)=@_;
8788: {
8789: use integer;
8790: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8791: my $symbseed=numval2($symb);
8792: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8793: my $CODEseed=numval(&getCODE());
8794: my $courseseed=unpack("%32S*",$courseid.' ');
8795: my $num1=$symbseed+$CODEchck;
8796: my $num2=$CODEseed+$courseseed+$symbchck;
8797: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8798: #&logthis("rndseed :$num1:$num2:$symb");
8799: if ($_64bit) { $num1=(($num1<<32)>>32); }
8800: if ($_64bit) { $num2=(($num2<<32)>>32); }
8801: return "$num1:$num2";
8802: }
8803: }
8804:
8805: sub rndseed_CODE_64bit4 {
8806: my ($symb,$courseid,$domain,$username)=@_;
8807: {
8808: use integer;
8809: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8810: my $symbseed=numval3($symb);
8811: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8812: my $CODEseed=numval3(&getCODE());
8813: my $courseseed=unpack("%32S*",$courseid.' ');
8814: my $num1=$symbseed+$CODEchck;
8815: my $num2=$CODEseed+$courseseed+$symbchck;
8816: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8817: #&logthis("rndseed :$num1:$num2:$symb");
8818: if ($_64bit) { $num1=(($num1<<32)>>32); }
8819: if ($_64bit) { $num2=(($num2<<32)>>32); }
8820: return "$num1:$num2";
8821: }
8822: }
8823:
8824: sub rndseed_CODE_64bit5 {
8825: my ($symb,$courseid,$domain,$username)=@_;
8826: my $code = &getCODE();
8827: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8828: return "$num1:$num2";
8829: }
8830:
8831: sub setup_random_from_rndseed {
8832: my ($rndseed)=@_;
8833: if ($rndseed =~/([,:])/) {
8834: my ($num1,$num2)=split(/[,:]/,$rndseed);
8835: &Math::Random::random_set_seed(abs($num1),abs($num2));
8836: } else {
8837: &Math::Random::random_set_seed_from_phrase($rndseed);
8838: }
8839: }
8840:
8841: sub latest_receipt_algorithm_id {
8842: return 'receipt3';
8843: }
8844:
8845: sub recunique {
8846: my $fucourseid=shift;
8847: my $unique;
8848: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
8849: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8850: $unique=$env{"course.$fucourseid.internal.encseed"};
8851: } else {
8852: $unique=$perlvar{'lonReceipt'};
8853: }
8854: return unpack("%32C*",$unique);
8855: }
8856:
8857: sub recprefix {
8858: my $fucourseid=shift;
8859: my $prefix;
8860: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
8861: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
8862: $prefix=$env{"course.$fucourseid.internal.encpref"};
8863: } else {
8864: $prefix=$perlvar{'lonHostID'};
8865: }
8866: return unpack("%32C*",$prefix);
8867: }
8868:
8869: sub ireceipt {
8870: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
8871:
8872: my $return =&recprefix($fucourseid).'-';
8873:
8874: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
8875: $env{'request.state'} eq 'construct') {
8876: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
8877: return $return;
8878: }
8879:
8880: my $cuname=unpack("%32C*",$funame);
8881: my $cudom=unpack("%32C*",$fudom);
8882: my $cucourseid=unpack("%32C*",$fucourseid);
8883: my $cusymb=unpack("%32C*",$fusymb);
8884: my $cunique=&recunique($fucourseid);
8885: my $cpart=unpack("%32S*",$part);
8886: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
8887:
8888: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
8889:
8890: $return.= ($cunique%$cuname+
8891: $cunique%$cudom+
8892: $cusymb%$cuname+
8893: $cusymb%$cudom+
8894: $cucourseid%$cuname+
8895: $cucourseid%$cudom+
8896: $cpart%$cuname+
8897: $cpart%$cudom);
8898: } else {
8899: $return.= ($cunique%$cuname+
8900: $cunique%$cudom+
8901: $cusymb%$cuname+
8902: $cusymb%$cudom+
8903: $cucourseid%$cuname+
8904: $cucourseid%$cudom);
8905: }
8906: return $return;
8907: }
8908:
8909: sub receipt {
8910: my ($part)=@_;
8911: my ($symb,$courseid,$domain,$name) = &whichuser();
8912: return &ireceipt($name,$domain,$courseid,$symb,$part);
8913: }
8914:
8915: sub whichuser {
8916: my ($passedsymb)=@_;
8917: my ($symb,$courseid,$domain,$name,$publicuser);
8918: if (defined($env{'form.grade_symb'})) {
8919: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
8920: my $allowed=&allowed('vgr',$tmp_courseid);
8921: if (!$allowed &&
8922: exists($env{'request.course.sec'}) &&
8923: $env{'request.course.sec'} !~ /^\s*$/) {
8924: $allowed=&allowed('vgr',$tmp_courseid.
8925: '/'.$env{'request.course.sec'});
8926: }
8927: if ($allowed) {
8928: ($symb)=&get_env_multiple('form.grade_symb');
8929: $courseid=$tmp_courseid;
8930: ($domain)=&get_env_multiple('form.grade_domain');
8931: ($name)=&get_env_multiple('form.grade_username');
8932: return ($symb,$courseid,$domain,$name,$publicuser);
8933: }
8934: }
8935: if (!$passedsymb) {
8936: $symb=&symbread();
8937: } else {
8938: $symb=$passedsymb;
8939: }
8940: $courseid=$env{'request.course.id'};
8941: $domain=$env{'user.domain'};
8942: $name=$env{'user.name'};
8943: if ($name eq 'public' && $domain eq 'public') {
8944: if (!defined($env{'form.username'})) {
8945: $env{'form.username'}.=time.rand(10000000);
8946: }
8947: $name.=$env{'form.username'};
8948: }
8949: return ($symb,$courseid,$domain,$name,$publicuser);
8950:
8951: }
8952:
8953: # ------------------------------------------------------------ Serves up a file
8954: # returns either the contents of the file or
8955: # -1 if the file doesn't exist
8956: #
8957: # if the target is a file that was uploaded via DOCS,
8958: # a check will be made to see if a current copy exists on the local server,
8959: # if it does this will be served, otherwise a copy will be retrieved from
8960: # the home server for the course and stored in /home/httpd/html/userfiles on
8961: # the local server.
8962:
8963: sub getfile {
8964: my ($file) = @_;
8965: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
8966: &repcopy($file);
8967: return &readfile($file);
8968: }
8969:
8970: sub repcopy_userfile {
8971: my ($file)=@_;
8972: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
8973: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
8974: my ($cdom,$cnum,$filename) =
8975: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
8976: my $uri="/uploaded/$cdom/$cnum/$filename";
8977: if (-e "$file") {
8978: # we already have a local copy, check it out
8979: my @fileinfo = stat($file);
8980: my $rtncode;
8981: my $info;
8982: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
8983: if ($lwpresp ne 'ok') {
8984: # there is no such file anymore, even though we had a local copy
8985: if ($rtncode eq '404') {
8986: unlink($file);
8987: }
8988: return -1;
8989: }
8990: if ($info < $fileinfo[9]) {
8991: # nice, the file we have is up-to-date, just say okay
8992: return 'ok';
8993: } else {
8994: # the file is outdated, get rid of it
8995: unlink($file);
8996: }
8997: }
8998: # one way or the other, at this point, we don't have the file
8999: # construct the correct path for the file
9000: my @parts = ($cdom,$cnum);
9001: if ($filename =~ m|^(.+)/[^/]+$|) {
9002: push @parts, split(/\//,$1);
9003: }
9004: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9005: foreach my $part (@parts) {
9006: $path .= '/'.$part;
9007: if (!-e $path) {
9008: mkdir($path,0770);
9009: }
9010: }
9011: # now the path exists for sure
9012: # get a user agent
9013: my $ua=new LWP::UserAgent;
9014: my $transferfile=$file.'.in.transfer';
9015: # FIXME: this should flock
9016: if (-e $transferfile) { return 'ok'; }
9017: my $request;
9018: $uri=~s/^\///;
9019: my $homeserver = &homeserver($cnum,$cdom);
9020: my $protocol = $protocol{$homeserver};
9021: $protocol = 'http' if ($protocol ne 'https');
9022: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
9023: my $response=$ua->request($request,$transferfile);
9024: # did it work?
9025: if ($response->is_error()) {
9026: unlink($transferfile);
9027: &logthis("Userfile repcopy failed for $uri");
9028: return -1;
9029: }
9030: # worked, rename the transfer file
9031: rename($transferfile,$file);
9032: return 'ok';
9033: }
9034:
9035: sub tokenwrapper {
9036: my $uri=shift;
9037: $uri=~s|^https?\://([^/]+)||;
9038: $uri=~s|^/||;
9039: $env{'user.environment'}=~/\/([^\/]+)\.id/;
9040: my $token=$1;
9041: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9042: if ($udom && $uname && $file) {
9043: $file=~s|(\?\.*)*$||;
9044: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
9045: my $homeserver = &homeserver($uname,$udom);
9046: my $protocol = $protocol{$homeserver};
9047: $protocol = 'http' if ($protocol ne 'https');
9048: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
9049: (($uri=~/\?/)?'&':'?').'token='.$token.
9050: '&tokenissued='.$perlvar{'lonHostID'};
9051: } else {
9052: return '/adm/notfound.html';
9053: }
9054: }
9055:
9056: # call with reqtype HEAD: get last modification time
9057: # call with reqtype GET: get the file contents
9058: # Do not call this with reqtype GET for large files! It loads everything into memory
9059: #
9060: sub getuploaded {
9061: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9062: $uri=~s/^\///;
9063: my $homeserver = &homeserver($cnum,$cdom);
9064: my $protocol = $protocol{$homeserver};
9065: $protocol = 'http' if ($protocol ne 'https');
9066: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
9067: my $ua=new LWP::UserAgent;
9068: my $request=new HTTP::Request($reqtype,$uri);
9069: my $response=$ua->request($request);
9070: $$rtncode = $response->code;
9071: if (! $response->is_success()) {
9072: return 'failed';
9073: }
9074: if ($reqtype eq 'HEAD') {
9075: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
9076: } elsif ($reqtype eq 'GET') {
9077: $$info = $response->content;
9078: }
9079: return 'ok';
9080: }
9081:
9082: sub readfile {
9083: my $file = shift;
9084: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9085: my $fh;
9086: open($fh,"<$file");
9087: my $a='';
9088: while (my $line = <$fh>) { $a .= $line; }
9089: return $a;
9090: }
9091:
9092: sub filelocation {
9093: my ($dir,$file) = @_;
9094: my $location;
9095: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
9096:
9097: if ($file =~ m-^/adm/-) {
9098: $file=~s-^/adm/wrapper/-/-;
9099: $file=~s-^/adm/coursedocs/showdoc/-/-;
9100: }
9101:
9102: if ($file=~m:^/~:) { # is a contruction space reference
9103: $location = $file;
9104: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
9105: } elsif ($file=~m{^/home/$match_username/public_html/}) {
9106: # is a correct contruction space reference
9107: $location = $file;
9108: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9109: $location = $file;
9110: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
9111: my ($udom,$uname,$filename)=
9112: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
9113: my $home=&homeserver($uname,$udom);
9114: my $is_me=0;
9115: my @ids=¤t_machine_ids();
9116: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9117: if ($is_me) {
9118: $location=&propath($udom,$uname).'/userfiles/'.$filename;
9119: } else {
9120: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9121: $udom.'/'.$uname.'/'.$filename;
9122: }
9123: } elsif ($file =~ m-^/adm/-) {
9124: $location = $perlvar{'lonDocRoot'}.'/'.$file;
9125: } else {
9126: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9127: $file=~s:^/res/:/:;
9128: if ( !( $file =~ m:^/:) ) {
9129: $location = $dir. '/'.$file;
9130: } else {
9131: $location = '/home/httpd/html/res'.$file;
9132: }
9133: }
9134: $location=~s://+:/:g; # remove duplicate /
9135: while ($location=~m{/\.\./}) {
9136: if ($location =~ m{/[^/]+/\.\./}) {
9137: $location=~ s{/[^/]+/\.\./}{/}g;
9138: } else {
9139: $location=~ s{/\.\./}{/}g;
9140: }
9141: } #remove dir/..
9142: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9143: return $location;
9144: }
9145:
9146: sub hreflocation {
9147: my ($dir,$file)=@_;
9148: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
9149: $file=filelocation($dir,$file);
9150: } elsif ($file=~m-^/adm/-) {
9151: $file=~s-^/adm/wrapper/-/-;
9152: $file=~s-^/adm/coursedocs/showdoc/-/-;
9153: }
9154: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9155: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
9156: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9157: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
9158: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
9159: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
9160: -/uploaded/$1/$2/-x;
9161: }
9162: if ($file=~ m{^/userfiles/}) {
9163: $file =~ s{^/userfiles/}{/uploaded/};
9164: }
9165: return $file;
9166: }
9167:
9168: sub current_machine_domains {
9169: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9170: }
9171:
9172: sub machine_domains {
9173: my ($hostname) = @_;
9174: my @domains;
9175: my %hostname = &all_hostnames();
9176: while( my($id, $name) = each(%hostname)) {
9177: # &logthis("-$id-$name-$hostname-");
9178: if ($hostname eq $name) {
9179: push(@domains,&host_domain($id));
9180: }
9181: }
9182: return @domains;
9183: }
9184:
9185: sub current_machine_ids {
9186: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9187: }
9188:
9189: sub machine_ids {
9190: my ($hostname) = @_;
9191: $hostname ||= &hostname($perlvar{'lonHostID'});
9192: my @ids;
9193: my %name_to_host = &all_names();
9194: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9195: return @{ $name_to_host{$hostname} };
9196: }
9197: return;
9198: }
9199:
9200: sub additional_machine_domains {
9201: my @domains;
9202: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9203: while( my $line = <$fh>) {
9204: $line =~ s/\s//g;
9205: push(@domains,$line);
9206: }
9207: return @domains;
9208: }
9209:
9210: sub default_login_domain {
9211: my $domain = $perlvar{'lonDefDomain'};
9212: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9213: foreach my $posdom (¤t_machine_domains(),
9214: &additional_machine_domains()) {
9215: if (lc($posdom) eq lc($testdomain)) {
9216: $domain=$posdom;
9217: last;
9218: }
9219: }
9220: return $domain;
9221: }
9222:
9223: # ------------------------------------------------------------- Declutters URLs
9224:
9225: sub declutter {
9226: my $thisfn=shift;
9227: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
9228: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9229: $thisfn=~s/^\///;
9230: $thisfn=~s|^adm/wrapper/||;
9231: $thisfn=~s|^adm/coursedocs/showdoc/||;
9232: $thisfn=~s/^res\///;
9233: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9234: $thisfn=~s/\?.+$//;
9235: }
9236: return $thisfn;
9237: }
9238:
9239: # ------------------------------------------------------------- Clutter up URLs
9240:
9241: sub clutter {
9242: my $thisfn='/'.&declutter(shift);
9243: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
9244: || $thisfn =~ m{^/adm/(includes|pages)} ) {
9245: $thisfn='/res'.$thisfn;
9246: }
9247: if ($thisfn !~m|^/adm|) {
9248: if ($thisfn =~ m|^/ext/|) {
9249: $thisfn='/adm/wrapper'.$thisfn;
9250: } else {
9251: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9252: my $embstyle=&Apache::loncommon::fileembstyle($ext);
9253: if ($embstyle eq 'ssi'
9254: || ($embstyle eq 'hdn')
9255: || ($embstyle eq 'rat')
9256: || ($embstyle eq 'prv')
9257: || ($embstyle eq 'ign')) {
9258: #do nothing with these
9259: } elsif (($embstyle eq 'img')
9260: || ($embstyle eq 'emb')
9261: || ($embstyle eq 'wrp')) {
9262: $thisfn='/adm/wrapper'.$thisfn;
9263: } elsif ($embstyle eq 'unk'
9264: && $thisfn!~/\.(sequence|page)$/) {
9265: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
9266: } else {
9267: # &logthis("Got a blank emb style");
9268: }
9269: }
9270: }
9271: return $thisfn;
9272: }
9273:
9274: sub clutter_with_no_wrapper {
9275: my $uri = &clutter(shift);
9276: if ($uri =~ m-^/adm/-) {
9277: $uri =~ s-^/adm/wrapper/-/-;
9278: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9279: }
9280: return $uri;
9281: }
9282:
9283: sub freeze_escape {
9284: my ($value)=@_;
9285: if (ref($value)) {
9286: $value=&nfreeze($value);
9287: return '__FROZEN__'.&escape($value);
9288: }
9289: return &escape($value);
9290: }
9291:
9292:
9293: sub thaw_unescape {
9294: my ($value)=@_;
9295: if ($value =~ /^__FROZEN__/) {
9296: substr($value,0,10,undef);
9297: $value=&unescape($value);
9298: return &thaw($value);
9299: }
9300: return &unescape($value);
9301: }
9302:
9303: sub correct_line_ends {
9304: my ($result)=@_;
9305: $$result =~s/\r\n/\n/mg;
9306: $$result =~s/\r/\n/mg;
9307: }
9308: # ================================================================ Main Program
9309:
9310: sub goodbye {
9311: &logthis("Starting Shut down");
9312: #not converted to using infrastruture and probably shouldn't be
9313: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
9314: #converted
9315: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
9316: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9317: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9318: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
9319: #1.1 only
9320: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9321: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9322: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9323: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9324: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
9325: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9326: &logthis(sprintf("%-20s is %s",'hits',$hits));
9327: &flushcourselogs();
9328: &logthis("Shutting down");
9329: }
9330:
9331: sub get_dns {
9332: my ($url,$func,$ignore_cache) = @_;
9333: if (!$ignore_cache) {
9334: my ($content,$cached)=
9335: &Apache::lonnet::is_cached_new('dns',$url);
9336: if ($cached) {
9337: &$func($content);
9338: return;
9339: }
9340: }
9341:
9342: my %alldns;
9343: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9344: foreach my $dns (<$config>) {
9345: next if ($dns !~ /^\^(\S*)/x);
9346: my $line = $1;
9347: my ($host,$protocol) = split(/:/,$line);
9348: if ($protocol ne 'https') {
9349: $protocol = 'http';
9350: }
9351: $alldns{$host} = $protocol;
9352: }
9353: while (%alldns) {
9354: my ($dns) = keys(%alldns);
9355: my $ua=new LWP::UserAgent;
9356: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
9357: my $response=$ua->request($request);
9358: delete($alldns{$dns});
9359: next if ($response->is_error());
9360: my @content = split("\n",$response->content);
9361: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
9362: &$func(\@content);
9363: return;
9364: }
9365: close($config);
9366: my $which = (split('/',$url))[3];
9367: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9368: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
9369: my @content = <$config>;
9370: &$func(\@content);
9371: return;
9372: }
9373: # ------------------------------------------------------------ Read domain file
9374: {
9375: my $loaded;
9376: my %domain;
9377:
9378: sub parse_domain_tab {
9379: my ($lines) = @_;
9380: foreach my $line (@$lines) {
9381: next if ($line =~ /^(\#|\s*$ )/x);
9382:
9383: chomp($line);
9384: my ($name,@elements) = split(/:/,$line,9);
9385: my %this_domain;
9386: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9387: 'lang_def', 'city', 'longi', 'lati',
9388: 'primary') {
9389: $this_domain{$field} = shift(@elements);
9390: }
9391: $domain{$name} = \%this_domain;
9392: }
9393: }
9394:
9395: sub reset_domain_info {
9396: undef($loaded);
9397: undef(%domain);
9398: }
9399:
9400: sub load_domain_tab {
9401: my ($ignore_cache) = @_;
9402: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
9403: my $fh;
9404: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9405: my @lines = <$fh>;
9406: &parse_domain_tab(\@lines);
9407: }
9408: close($fh);
9409: $loaded = 1;
9410: }
9411:
9412: sub domain {
9413: &load_domain_tab() if (!$loaded);
9414:
9415: my ($name,$what) = @_;
9416: return if ( !exists($domain{$name}) );
9417:
9418: if (!$what) {
9419: return $domain{$name}{'description'};
9420: }
9421: return $domain{$name}{$what};
9422: }
9423:
9424: sub domain_info {
9425: &load_domain_tab() if (!$loaded);
9426: return %domain;
9427: }
9428:
9429: }
9430:
9431:
9432: # ------------------------------------------------------------- Read hosts file
9433: {
9434: my %hostname;
9435: my %hostdom;
9436: my %libserv;
9437: my $loaded;
9438: my %name_to_host;
9439:
9440: sub parse_hosts_tab {
9441: my ($file) = @_;
9442: foreach my $configline (@$file) {
9443: next if ($configline =~ /^(\#|\s*$ )/x);
9444: next if ($configline =~ /^\^/);
9445: chomp($configline);
9446: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
9447: $name=~s/\s//g;
9448: if ($id && $domain && $role && $name) {
9449: $hostname{$id}=$name;
9450: push(@{$name_to_host{$name}}, $id);
9451: $hostdom{$id}=$domain;
9452: if ($role eq 'library') { $libserv{$id}=$name; }
9453: if (defined($protocol)) {
9454: if ($protocol eq 'https') {
9455: $protocol{$id} = $protocol;
9456: } else {
9457: $protocol{$id} = 'http';
9458: }
9459: } else {
9460: $protocol{$id} = 'http';
9461: }
9462: }
9463: }
9464: }
9465:
9466: sub reset_hosts_info {
9467: &purge_remembered();
9468: &reset_domain_info();
9469: &reset_hosts_ip_info();
9470: undef(%name_to_host);
9471: undef(%hostname);
9472: undef(%hostdom);
9473: undef(%libserv);
9474: undef($loaded);
9475: }
9476:
9477: sub load_hosts_tab {
9478: my ($ignore_cache) = @_;
9479: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
9480: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9481: my @config = <$config>;
9482: &parse_hosts_tab(\@config);
9483: close($config);
9484: $loaded=1;
9485: }
9486:
9487: sub hostname {
9488: &load_hosts_tab() if (!$loaded);
9489:
9490: my ($lonid) = @_;
9491: return $hostname{$lonid};
9492: }
9493:
9494: sub all_hostnames {
9495: &load_hosts_tab() if (!$loaded);
9496:
9497: return %hostname;
9498: }
9499:
9500: sub all_names {
9501: &load_hosts_tab() if (!$loaded);
9502:
9503: return %name_to_host;
9504: }
9505:
9506: sub all_host_domain {
9507: &load_hosts_tab() if (!$loaded);
9508: return %hostdom;
9509: }
9510:
9511: sub is_library {
9512: &load_hosts_tab() if (!$loaded);
9513:
9514: return exists($libserv{$_[0]});
9515: }
9516:
9517: sub all_library {
9518: &load_hosts_tab() if (!$loaded);
9519:
9520: return %libserv;
9521: }
9522:
9523: sub get_servers {
9524: &load_hosts_tab() if (!$loaded);
9525:
9526: my ($domain,$type) = @_;
9527: my %possible_hosts = ($type eq 'library') ? %libserv
9528: : %hostname;
9529: my %result;
9530: if (ref($domain) eq 'ARRAY') {
9531: while ( my ($host,$hostname) = each(%possible_hosts)) {
9532: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
9533: $result{$host} = $hostname;
9534: }
9535: }
9536: } else {
9537: while ( my ($host,$hostname) = each(%possible_hosts)) {
9538: if ($hostdom{$host} eq $domain) {
9539: $result{$host} = $hostname;
9540: }
9541: }
9542: }
9543: return %result;
9544: }
9545:
9546: sub host_domain {
9547: &load_hosts_tab() if (!$loaded);
9548:
9549: my ($lonid) = @_;
9550: return $hostdom{$lonid};
9551: }
9552:
9553: sub all_domains {
9554: &load_hosts_tab() if (!$loaded);
9555:
9556: my %seen;
9557: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9558: return @uniq;
9559: }
9560: }
9561:
9562: {
9563: my %iphost;
9564: my %name_to_ip;
9565: my %lonid_to_ip;
9566:
9567: sub get_hosts_from_ip {
9568: my ($ip) = @_;
9569: my %iphosts = &get_iphost();
9570: if (ref($iphosts{$ip})) {
9571: return @{$iphosts{$ip}};
9572: }
9573: return;
9574: }
9575:
9576: sub reset_hosts_ip_info {
9577: undef(%iphost);
9578: undef(%name_to_ip);
9579: undef(%lonid_to_ip);
9580: }
9581:
9582: sub get_host_ip {
9583: my ($lonid) = @_;
9584: if (exists($lonid_to_ip{$lonid})) {
9585: return $lonid_to_ip{$lonid};
9586: }
9587: my $name=&hostname($lonid);
9588: my $ip = gethostbyname($name);
9589: return if (!$ip || length($ip) ne 4);
9590: $ip=inet_ntoa($ip);
9591: $name_to_ip{$name} = $ip;
9592: $lonid_to_ip{$lonid} = $ip;
9593: return $ip;
9594: }
9595:
9596: sub get_iphost {
9597: my ($ignore_cache) = @_;
9598:
9599: if (!$ignore_cache) {
9600: if (%iphost) {
9601: return %iphost;
9602: }
9603: my ($ip_info,$cached)=
9604: &Apache::lonnet::is_cached_new('iphost','iphost');
9605: if ($cached) {
9606: %iphost = %{$ip_info->[0]};
9607: %name_to_ip = %{$ip_info->[1]};
9608: %lonid_to_ip = %{$ip_info->[2]};
9609: return %iphost;
9610: }
9611: }
9612:
9613: # get yesterday's info for fallback
9614: my %old_name_to_ip;
9615: my ($ip_info,$cached)=
9616: &Apache::lonnet::is_cached_new('iphost','iphost');
9617: if ($cached) {
9618: %old_name_to_ip = %{$ip_info->[1]};
9619: }
9620:
9621: my %name_to_host = &all_names();
9622: foreach my $name (keys(%name_to_host)) {
9623: my $ip;
9624: if (!exists($name_to_ip{$name})) {
9625: $ip = gethostbyname($name);
9626: if (!$ip || length($ip) ne 4) {
9627: if (defined($old_name_to_ip{$name})) {
9628: $ip = $old_name_to_ip{$name};
9629: &logthis("Can't find $name defaulting to old $ip");
9630: } else {
9631: &logthis("Name $name no IP found");
9632: next;
9633: }
9634: } else {
9635: $ip=inet_ntoa($ip);
9636: }
9637: $name_to_ip{$name} = $ip;
9638: } else {
9639: $ip = $name_to_ip{$name};
9640: }
9641: foreach my $id (@{ $name_to_host{$name} }) {
9642: $lonid_to_ip{$id} = $ip;
9643: }
9644: push(@{$iphost{$ip}},@{$name_to_host{$name}});
9645: }
9646: &Apache::lonnet::do_cache_new('iphost','iphost',
9647: [\%iphost,\%name_to_ip,\%lonid_to_ip],
9648: 48*60*60);
9649:
9650: return %iphost;
9651: }
9652:
9653: #
9654: # Given a DNS returns the loncapa host name for that DNS
9655: #
9656: sub host_from_dns {
9657: my ($dns) = @_;
9658: my @hosts;
9659: my $ip;
9660:
9661: if (exists($name_to_ip{$dns})) {
9662: $ip = $name_to_ip{$dns};
9663: }
9664: if (!$ip) {
9665: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9666: if (length($ip) == 4) {
9667: $ip = &IO::Socket::inet_ntoa($ip);
9668: }
9669: }
9670: if ($ip) {
9671: @hosts = get_hosts_from_ip($ip);
9672: return $hosts[0];
9673: }
9674: return undef;
9675: }
9676:
9677: }
9678:
9679: BEGIN {
9680:
9681: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9682: unless ($readit) {
9683: {
9684: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9685: %perlvar = (%perlvar,%{$configvars});
9686: }
9687:
9688:
9689: # ------------------------------------------------------ Read spare server file
9690: {
9691: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
9692:
9693: while (my $configline=<$config>) {
9694: chomp($configline);
9695: if ($configline) {
9696: my ($host,$type) = split(':',$configline,2);
9697: if (!defined($type) || $type eq '') { $type = 'default' };
9698: push(@{ $spareid{$type} }, $host);
9699: }
9700: }
9701: close($config);
9702: }
9703: # ------------------------------------------------------------ Read permissions
9704: {
9705: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
9706:
9707: while (my $configline=<$config>) {
9708: chomp($configline);
9709: if ($configline) {
9710: my ($role,$perm)=split(/ /,$configline);
9711: if ($perm ne '') { $pr{$role}=$perm; }
9712: }
9713: }
9714: close($config);
9715: }
9716:
9717: # -------------------------------------------- Read plain texts for permissions
9718: {
9719: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
9720:
9721: while (my $configline=<$config>) {
9722: chomp($configline);
9723: if ($configline) {
9724: my ($short,@plain)=split(/:/,$configline);
9725: %{$prp{$short}} = ();
9726: if (@plain > 0) {
9727: $prp{$short}{'std'} = $plain[0];
9728: for (my $i=1; $i<@plain; $i++) {
9729: $prp{$short}{'alt'.$i} = $plain[$i];
9730: }
9731: }
9732: }
9733: }
9734: close($config);
9735: }
9736:
9737: # ---------------------------------------------------------- Read package table
9738: {
9739: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
9740:
9741: while (my $configline=<$config>) {
9742: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
9743: chomp($configline);
9744: my ($short,$plain)=split(/:/,$configline);
9745: my ($pack,$name)=split(/\&/,$short);
9746: if ($plain ne '') {
9747: $packagetab{$pack.'&'.$name.'&name'}=$name;
9748: $packagetab{$short}=$plain;
9749: }
9750: }
9751: close($config);
9752: }
9753:
9754: # ------------- set up temporary directory
9755: {
9756: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9757:
9758: }
9759:
9760: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9761: 'compress_threshold'=> 20_000,
9762: });
9763:
9764: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
9765: $dumpcount=0;
9766: $locknum=0;
9767:
9768: &logtouch();
9769: &logthis('<font color="yellow">INFO: Read configuration</font>');
9770: $readit=1;
9771: {
9772: use integer;
9773: my $test=(2**32)+1;
9774: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
9775: &logthis(" Detected 64bit platform ($_64bit)");
9776: }
9777: }
9778: }
9779:
9780: 1;
9781: __END__
9782:
9783: =pod
9784:
9785: =head1 NAME
9786:
9787: Apache::lonnet - Subroutines to ask questions about things in the network.
9788:
9789: =head1 SYNOPSIS
9790:
9791: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
9792:
9793: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9794:
9795: Common parameters:
9796:
9797: =over 4
9798:
9799: =item *
9800:
9801: $uname : an internal username (if $cname expecting a course Id specifically)
9802:
9803: =item *
9804:
9805: $udom : a domain (if $cdom expecting a course's domain specifically)
9806:
9807: =item *
9808:
9809: $symb : a resource instance identifier
9810:
9811: =item *
9812:
9813: $namespace : the name of a .db file that contains the data needed or
9814: being set.
9815:
9816: =back
9817:
9818: =head1 OVERVIEW
9819:
9820: lonnet provides subroutines which interact with the
9821: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9822: about classes, users, and resources.
9823:
9824: For many of these objects you can also use this to store data about
9825: them or modify them in various ways.
9826:
9827: =head2 Symbs
9828:
9829: To identify a specific instance of a resource, LON-CAPA uses symbols
9830: or "symbs"X<symb>. These identifiers are built from the URL of the
9831: map, the resource number of the resource in the map, and the URL of
9832: the resource itself. The latter is somewhat redundant, but might help
9833: if maps change.
9834:
9835: An example is
9836:
9837: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
9838:
9839: The respective map entry is
9840:
9841: <resource id="19" src="/res/msu/korte/tests/part12.problem"
9842: title="Problem 2">
9843: </resource>
9844:
9845: Symbs are used by the random number generator, as well as to store and
9846: restore data specific to a certain instance of for example a problem.
9847:
9848: =head2 Storing And Retrieving Data
9849:
9850: X<store()>X<cstore()>X<restore()>Three of the most important functions
9851: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
9852: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
9853: is is the non-critical message twin of cstore. These functions are for
9854: handlers to store a perl hash to a user's permanent data space in an
9855: easy manner, and to retrieve it again on another call. It is expected
9856: that a handler would use this once at the beginning to retrieve data,
9857: and then again once at the end to send only the new data back.
9858:
9859: The data is stored in the user's data directory on the user's
9860: homeserver under the ID of the course.
9861:
9862: The hash that is returned by restore will have all of the previous
9863: value for all of the elements of the hash.
9864:
9865: Example:
9866:
9867: #creating a hash
9868: my %hash;
9869: $hash{'foo'}='bar';
9870:
9871: #storing it
9872: &Apache::lonnet::cstore(\%hash);
9873:
9874: #changing a value
9875: $hash{'foo'}='notbar';
9876:
9877: #adding a new value
9878: $hash{'bar'}='foo';
9879: &Apache::lonnet::cstore(\%hash);
9880:
9881: #retrieving the hash
9882: my %history=&Apache::lonnet::restore();
9883:
9884: #print the hash
9885: foreach my $key (sort(keys(%history))) {
9886: print("\%history{$key} = $history{$key}");
9887: }
9888:
9889: Will print out:
9890:
9891: %history{1:foo} = bar
9892: %history{1:keys} = foo:timestamp
9893: %history{1:timestamp} = 990455579
9894: %history{2:bar} = foo
9895: %history{2:foo} = notbar
9896: %history{2:keys} = foo:bar:timestamp
9897: %history{2:timestamp} = 990455580
9898: %history{bar} = foo
9899: %history{foo} = notbar
9900: %history{timestamp} = 990455580
9901: %history{version} = 2
9902:
9903: Note that the special hash entries C<keys>, C<version> and
9904: C<timestamp> were added to the hash. C<version> will be equal to the
9905: total number of versions of the data that have been stored. The
9906: C<timestamp> attribute will be the UNIX time the hash was
9907: stored. C<keys> is available in every historical section to list which
9908: keys were added or changed at a specific historical revision of a
9909: hash.
9910:
9911: B<Warning>: do not store the hash that restore returns directly. This
9912: will cause a mess since it will restore the historical keys as if the
9913: were new keys. I.E. 1:foo will become 1:1:foo etc.
9914:
9915: Calling convention:
9916:
9917: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
9918: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
9919:
9920: For more detailed information, see lonnet specific documentation.
9921:
9922: =head1 RETURN MESSAGES
9923:
9924: =over 4
9925:
9926: =item * B<con_lost>: unable to contact remote host
9927:
9928: =item * B<con_delayed>: unable to contact remote host, message will be delivered
9929: when the connection is brought back up
9930:
9931: =item * B<con_failed>: unable to contact remote host and unable to save message
9932: for later delivery
9933:
9934: =item * B<error:>: an error a occurred, a description of the error follows the :
9935:
9936: =item * B<no_such_host>: unable to fund a host associated with the user/domain
9937: that was requested
9938:
9939: =back
9940:
9941: =head1 PUBLIC SUBROUTINES
9942:
9943: =head2 Session Environment Functions
9944:
9945: =over 4
9946:
9947: =item *
9948: X<appenv()>
9949: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
9950: the user envirnoment file, and will be restored for each access this
9951: user makes during this session, also modifies the %env for the current
9952: process. Optional rolesarrayref - if defined contains a reference to an array
9953: of roles which are exempt from the restriction on modifying user.role entries
9954: in the user's environment.db and in %env.
9955:
9956: =item *
9957: X<delenv()>
9958: B<delenv($delthis,$regexp)>: removes all items from the session
9959: environment file that begin with $delthis. If the
9960: optional second arg - $regexp - is true, $delthis is treated as a
9961: regular expression, otherwise \Q$delthis\E is used.
9962: The values are also deleted from the current processes %env.
9963:
9964: =item * get_env_multiple($name)
9965:
9966: gets $name from the %env hash, it seemlessly handles the cases where multiple
9967: values may be defined and end up as an array ref.
9968:
9969: returns an array of values
9970:
9971: =back
9972:
9973: =head2 User Information
9974:
9975: =over 4
9976:
9977: =item *
9978: X<queryauthenticate()>
9979: B<queryauthenticate($uname,$udom)>: try to determine user's current
9980: authentication scheme
9981:
9982: =item *
9983: X<authenticate()>
9984: B<authenticate($uname,$upass,$udom)>: try to
9985: authenticate user from domain's lib servers (first use the current
9986: one). C<$upass> should be the users password.
9987:
9988: =item *
9989: X<homeserver()>
9990: B<homeserver($uname,$udom)>: find the server which has
9991: the user's directory and files (there must be only one), this caches
9992: the answer, and also caches if there is a borken connection.
9993:
9994: =item *
9995: X<idget()>
9996: B<idget($udom,@ids)>: find the usernames behind a list of IDs
9997: (IDs are a unique resource in a domain, there must be only 1 ID per
9998: username, and only 1 username per ID in a specific domain) (returns
9999: hash: id=>name,id=>name)
10000:
10001: =item *
10002: X<idrget()>
10003: B<idrget($udom,@unames)>: find the IDs behind a list of
10004: usernames (returns hash: name=>id,name=>id)
10005:
10006: =item *
10007: X<idput()>
10008: B<idput($udom,%ids)>: store away a list of names and associated IDs
10009:
10010: =item *
10011: X<rolesinit()>
10012: B<rolesinit($udom,$username,$authhost)>: get user privileges
10013:
10014: =item *
10015: X<getsection()>
10016: B<getsection($udom,$uname,$cname)>: finds the section of student in the
10017: course $cname, return section name/number or '' for "not in course"
10018: and '-1' for "no section"
10019:
10020: =item *
10021: X<userenvironment()>
10022: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
10023: passed in @what from the requested user's environment, returns a hash
10024:
10025: =item *
10026: X<userlog_query()>
10027: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10028: activity.log file. %filters defines filters applied when parsing the
10029: log file. These can be start or end timestamps, or the type of action
10030: - log to look for Login or Logout events, check for Checkin or
10031: Checkout, role for role selection. The response is in the form
10032: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10033: escaped strings of the action recorded in the activity.log file.
10034:
10035: =back
10036:
10037: =head2 User Roles
10038:
10039: =over 4
10040:
10041: =item *
10042:
10043: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
10044: F: full access
10045: U,I,K: authentication modes (cxx only)
10046: '': forbidden
10047: 1: user needs to choose course
10048: 2: browse allowed
10049: A: passphrase authentication needed
10050:
10051: =item *
10052:
10053: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10054: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10055: and course level
10056:
10057: =item *
10058:
10059: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10060: (rolesplain.tab); plain text explanation of a user role term.
10061: $type is Course (default) or Community.
10062: If $forcedefault evaluates to true, text returned will be default
10063: text for $type. Otherwise, if this is a course, the text returned
10064: will be a custom name for the role (if defined in the course's
10065: environment). If no custom name is defined the default is returned.
10066:
10067: =item *
10068:
10069: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
10070: All arguments are optional. Returns a hash of a roles, either for
10071: co-author/assistant author roles for a user's Construction Space
10072: (default), or if $context is 'userroles', roles for the user himself,
10073: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10074: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10075: For each key, value is set to colon-separated start and end times for
10076: the role. If no username and domain are specified, will default to
10077: current user/domain. Types, roles, and roledoms are references to arrays
10078: of role statuses (active, future or previous), roles
10079: (e.g., cc,in, st etc.) and domains of the roles which can be used
10080: to restrict the list of roles reported. If no array ref is
10081: provided for types, will default to return only active roles.
10082:
10083: =back
10084:
10085: =head2 User Modification
10086:
10087: =over 4
10088:
10089: =item *
10090:
10091: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
10092: user for the level given by URL. Optional start and end dates (leave empty
10093: string or zero for "no date")
10094:
10095: =item *
10096:
10097: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10098: change a users, password, possible return values are: ok,
10099: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10100: refused
10101:
10102: =item *
10103:
10104: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
10105:
10106: =item *
10107:
10108: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
10109: $forceid,$desiredhome,$email,$inststatus) :
10110: modify user
10111:
10112: =item *
10113:
10114: modifystudent
10115:
10116: modify a student's enrollment and identification information.
10117: The course id is resolved based on the current users environment.
10118: This means the envoking user must be a course coordinator or otherwise
10119: associated with a course.
10120:
10121: This call is essentially a wrapper for lonnet::modifyuser and
10122: lonnet::modify_student_enrollment
10123:
10124: Inputs:
10125:
10126: =over 4
10127:
10128: =item B<$udom> Student's loncapa domain
10129:
10130: =item B<$uname> Student's loncapa login name
10131:
10132: =item B<$uid> Student/Employee ID
10133:
10134: =item B<$umode> Student's authentication mode
10135:
10136: =item B<$upass> Student's password
10137:
10138: =item B<$first> Student's first name
10139:
10140: =item B<$middle> Student's middle name
10141:
10142: =item B<$last> Student's last name
10143:
10144: =item B<$gene> Student's generation
10145:
10146: =item B<$usec> Student's section in course
10147:
10148: =item B<$end> Unix time of the roles expiration
10149:
10150: =item B<$start> Unix time of the roles start date
10151:
10152: =item B<$forceid> If defined, allow $uid to be changed
10153:
10154: =item B<$desiredhome> server to use as home server for student
10155:
10156: =item B<$email> Student's permanent e-mail address
10157:
10158: =item B<$type> Type of enrollment (auto or manual)
10159:
10160: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10161:
10162: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
10163:
10164: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
10165:
10166: =item B<$context> role change context (shown in User Management Logs display in a course)
10167:
10168: =item B<$inststatus> institutional status of user - : separated string of escaped status types
10169:
10170: =back
10171:
10172: =item *
10173:
10174: modify_student_enrollment
10175:
10176: Change a students enrollment status in a class. The environment variable
10177: 'role.request.course' must be defined for this function to proceed.
10178:
10179: Inputs:
10180:
10181: =over 4
10182:
10183: =item $udom, students domain
10184:
10185: =item $uname, students name
10186:
10187: =item $uid, students user id
10188:
10189: =item $first, students first name
10190:
10191: =item $middle
10192:
10193: =item $last
10194:
10195: =item $gene
10196:
10197: =item $usec
10198:
10199: =item $end
10200:
10201: =item $start
10202:
10203: =item $type
10204:
10205: =item $locktype
10206:
10207: =item $cid
10208:
10209: =item $selfenroll
10210:
10211: =item $context
10212:
10213: =back
10214:
10215:
10216: =item *
10217:
10218: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10219: custom role; give a custom role to a user for the level given by URL. Specify
10220: name and domain of role author, and role name
10221:
10222: =item *
10223:
10224: revokerole($udom,$uname,$url,$role) : revoke a role for url
10225:
10226: =item *
10227:
10228: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10229:
10230: =back
10231:
10232: =head2 Course Infomation
10233:
10234: =over 4
10235:
10236: =item *
10237:
10238: coursedescription($courseid) : returns a hash of information about the
10239: specified course id, including all environment settings for the
10240: course, the description of the course will be in the hash under the
10241: key 'description'
10242:
10243: =item *
10244:
10245: resdata($name,$domain,$type,@which) : request for current parameter
10246: setting for a specific $type, where $type is either 'course' or 'user',
10247: @what should be a list of parameters to ask about. This routine caches
10248: answers for 5 minutes.
10249:
10250: =item *
10251:
10252: get_courseresdata($courseid, $domain) : dump the entire course resource
10253: data base, returning a hash that is keyed by the resource name and has
10254: values that are the resource value. I believe that the timestamps and
10255: versions are also returned.
10256:
10257:
10258: =back
10259:
10260: =head2 Course Modification
10261:
10262: =over 4
10263:
10264: =item *
10265:
10266: writecoursepref($courseid,%prefs) : write preferences (environment
10267: database) for a course
10268:
10269: =item *
10270:
10271: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10272:
10273: =item *
10274:
10275: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
10276:
10277: =back
10278:
10279: =head2 Resource Subroutines
10280:
10281: =over 4
10282:
10283: =item *
10284:
10285: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
10286:
10287: =item *
10288:
10289: repcopy($filename) : subscribes to the requested file, and attempts to
10290: replicate from the owning library server, Might return
10291: 'unavailable', 'not_found', 'forbidden', 'ok', or
10292: 'bad_request', also attempts to grab the metadata for the
10293: resource. Expects the local filesystem pathname
10294: (/home/httpd/html/res/....)
10295:
10296: =back
10297:
10298: =head2 Resource Information
10299:
10300: =over 4
10301:
10302: =item *
10303:
10304: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10305: a vairety of different possible values, $varname should be a request
10306: string, and the other parameters can be used to specify who and what
10307: one is asking about.
10308:
10309: Possible values for $varname are environment.lastname (or other item
10310: from the envirnment hash), user.name (or someother aspect about the
10311: user), resource.0.maxtries (or some other part and parameter of a
10312: resource)
10313:
10314: =item *
10315:
10316: directcondval($number) : get current value of a condition; reads from a state
10317: string
10318:
10319: =item *
10320:
10321: condval($condidx) : value of condition index based on state
10322:
10323: =item *
10324:
10325: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10326: resource's metadata, $what should be either a specific key, or either
10327: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10328: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10329:
10330: this function automatically caches all requests
10331:
10332: =item *
10333:
10334: metadata_query($query,$custom,$customshow) : make a metadata query against the
10335: network of library servers; returns file handle of where SQL and regex results
10336: will be stored for query
10337:
10338: =item *
10339:
10340: symbread($filename) : return symbolic list entry (filename argument optional);
10341: returns the data handle
10342:
10343: =item *
10344:
10345: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
10346: a possible symb for the URL in $thisfn, and if is an encryypted
10347: resource that the user accessed using /enc/ returns a 1 on success, 0
10348: on failure, user must be in a course, as it assumes the existance of
10349: the course initial hash, and uses $env('request.course.id'}
10350:
10351:
10352: =item *
10353:
10354: symbclean($symb) : removes versions numbers from a symb, returns the
10355: cleaned symb
10356:
10357: =item *
10358:
10359: is_on_map($uri) : checks if the $uri is somewhere on the current
10360: course map, user must be in a course for it to work.
10361:
10362: =item *
10363:
10364: numval($salt) : return random seed value (addend for rndseed)
10365:
10366: =item *
10367:
10368: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10369: a random seed, all arguments are optional, if they aren't sent it uses the
10370: environment to derive them. Note: if symb isn't sent and it can't get one
10371: from &symbread it will use the current time as its return value
10372:
10373: =item *
10374:
10375: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10376: unfakeable, receipt
10377:
10378: =item *
10379:
10380: receipt() : API to ireceipt working off of env values; given out to users
10381:
10382: =item *
10383:
10384: countacc($url) : count the number of accesses to a given URL
10385:
10386: =item *
10387:
10388: 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
10389:
10390: =item *
10391:
10392: 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)
10393:
10394: =item *
10395:
10396: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
10397:
10398: =item *
10399:
10400: devalidate($symb) : devalidate temporary spreadsheet calculations,
10401: forcing spreadsheet to reevaluate the resource scores next time.
10402:
10403: =back
10404:
10405: =head2 Storing/Retreiving Data
10406:
10407: =over 4
10408:
10409: =item *
10410:
10411: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10412: for this url; hashref needs to be given and should be a \%hashname; the
10413: remaining args aren't required and if they aren't passed or are '' they will
10414: be derived from the env
10415:
10416: =item *
10417:
10418: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10419: uses critical subroutine
10420:
10421: =item *
10422:
10423: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10424: all args are optional
10425:
10426: =item *
10427:
10428: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10429: dumps the complete (or key matching regexp) namespace into a hash
10430: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10431: normally &store()ed into
10432:
10433: $range should be either an integer '100' (give me the first 100
10434: matching records)
10435: or be two integers sperated by a - with no spaces
10436: '30-50' (give me the 30th through the 50th matching
10437: records)
10438:
10439:
10440: =item *
10441:
10442: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10443: replaces a &store() version of data with a replacement set of data
10444: for a particular resource in a namespace passed in the $storehash hash
10445: reference
10446:
10447: =item *
10448:
10449: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10450: works very similar to store/cstore, but all data is stored in a
10451: temporary location and can be reset using tmpreset, $storehash should
10452: be a hash reference, returns nothing on success
10453:
10454: =item *
10455:
10456: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10457: similar to restore, but all data is stored in a temporary location and
10458: can be reset using tmpreset. Returns a hash of values on success,
10459: error string otherwise.
10460:
10461: =item *
10462:
10463: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10464: deltes all keys for $symb form the temporary storage hash.
10465:
10466: =item *
10467:
10468: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10469: reference filled in from namesp ($udom and $uname are optional)
10470:
10471: =item *
10472:
10473: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10474: namesp ($udom and $uname are optional)
10475:
10476: =item *
10477:
10478: dump($namespace,$udom,$uname,$regexp,$range) :
10479: dumps the complete (or key matching regexp) namespace into a hash
10480: ($udom, $uname, $regexp, $range are optional)
10481:
10482: $range should be either an integer '100' (give me the first 100
10483: matching records)
10484: or be two integers sperated by a - with no spaces
10485: '30-50' (give me the 30th through the 50th matching
10486: records)
10487: =item *
10488:
10489: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10490: $store can be a scalar, an array reference, or if the amount to be
10491: incremented is > 1, a hash reference.
10492:
10493: ($udom and $uname are optional)
10494:
10495: =item *
10496:
10497: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10498: ($udom and $uname are optional)
10499:
10500: =item *
10501:
10502: cput($namespace,$storehash,$udom,$uname) : critical put
10503: ($udom and $uname are optional)
10504:
10505: =item *
10506:
10507: newput($namespace,$storehash,$udom,$uname) :
10508:
10509: Attempts to store the items in the $storehash, but only if they don't
10510: currently exist, if this succeeds you can be certain that you have
10511: successfully created a new key value pair in the $namespace db.
10512:
10513:
10514: Args:
10515: $namespace: name of database to store values to
10516: $storehash: hashref to store to the db
10517: $udom: (optional) domain of user containing the db
10518: $uname: (optional) name of user caontaining the db
10519:
10520: Returns:
10521: 'ok' -> succeeded in storing all keys of $storehash
10522: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10523: least <key> already existed in the db (other
10524: requested keys may also already exist)
10525: 'error: <msg>' -> unable to tie the DB or other error occurred
10526: 'con_lost' -> unable to contact request server
10527: 'refused' -> action was not allowed by remote machine
10528:
10529:
10530: =item *
10531:
10532: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10533: reference filled in from namesp (encrypts the return communication)
10534: ($udom and $uname are optional)
10535:
10536: =item *
10537:
10538: log($udom,$name,$home,$message) : write to permanent log for user; use
10539: critical subroutine
10540:
10541: =item *
10542:
10543: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10544: array reference filled in from namespace found in domain level on either
10545: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
10546:
10547: =item *
10548:
10549: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10550: domain level either on specified domain server ($uhome) or primary domain
10551: server ($udom and $uhome are optional)
10552:
10553: =item *
10554:
10555: get_domain_defaults($target_domain) : returns hash with defaults for
10556: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10557: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10558: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10559: Values are retrieved from cache (if current), or from domain's configuration.db
10560: (if available), or lastly from values in lonTabs/dns_domain,tab,
10561: or lonTabs/domain.tab.
10562:
10563: %domdefaults = &get_auth_defaults($target_domain);
10564:
10565: =back
10566:
10567: =head2 Network Status Functions
10568:
10569: =over 4
10570:
10571: =item *
10572:
10573: dirlist($uri) : return directory list based on URI
10574:
10575: =item *
10576:
10577: spareserver() : find server with least workload from spare.tab
10578:
10579:
10580: =item *
10581:
10582: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10583: if there is no corresponding loncapa host.
10584:
10585: =back
10586:
10587:
10588: =head2 Apache Request
10589:
10590: =over 4
10591:
10592: =item *
10593:
10594: ssi($url,%hash) : server side include, does a complete request cycle on url to
10595: localhost, posts hash
10596:
10597: =back
10598:
10599: =head2 Data to String to Data
10600:
10601: =over 4
10602:
10603: =item *
10604:
10605: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10606: and '&' separators, supports elements that are arrayrefs and hashrefs
10607:
10608: =item *
10609:
10610: hashref2str($hashref) : convert a hashref into a string complete with
10611: escaping and '=' and '&' separators, supports elements that are
10612: arrayrefs and hashrefs
10613:
10614: =item *
10615:
10616: arrayref2str($arrayref) : convert an arrayref into a string complete
10617: with escaping and '&' separators, supports elements that are arrayrefs
10618: and hashrefs
10619:
10620: =item *
10621:
10622: str2hash($string) : convert string to hash using unescaping and
10623: splitting on '=' and '&', supports elements that are arrayrefs and
10624: hashrefs
10625:
10626: =item *
10627:
10628: str2array($string) : convert string to hash using unescaping and
10629: splitting on '&', supports elements that are arrayrefs and hashrefs
10630:
10631: =back
10632:
10633: =head2 Logging Routines
10634:
10635: =over 4
10636:
10637: These routines allow one to make log messages in the lonnet.log and
10638: lonnet.perm logfiles.
10639:
10640: =item *
10641:
10642: logtouch() : make sure the logfile, lonnet.log, exists
10643:
10644: =item *
10645:
10646: logthis() : append message to the normal lonnet.log file, it gets
10647: preiodically rolled over and deleted.
10648:
10649: =item *
10650:
10651: logperm() : append a permanent message to lonnet.perm.log, this log
10652: file never gets deleted by any automated portion of the system, only
10653: messages of critical importance should go in here.
10654:
10655: =back
10656:
10657: =head2 General File Helper Routines
10658:
10659: =over 4
10660:
10661: =item *
10662:
10663: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10664: (a) files in /uploaded
10665: (i) If a local copy of the file exists -
10666: compares modification date of local copy with last-modified date for
10667: definitive version stored on home server for course. If local copy is
10668: stale, requests a new version from the home server and stores it.
10669: If the original has been removed from the home server, then local copy
10670: is unlinked.
10671: (ii) If local copy does not exist -
10672: requests the file from the home server and stores it.
10673:
10674: If $caller is 'uploadrep':
10675: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10676: for request for files originally uploaded via DOCS.
10677: - returns 'ok' if fresh local copy now available, -1 otherwise.
10678:
10679: Otherwise:
10680: This indicates a call from the content generation phase of the request.
10681: - returns the entire contents of the file or -1.
10682:
10683: (b) files in /res
10684: - returns the entire contents of a file or -1;
10685: it properly subscribes to and replicates the file if neccessary.
10686:
10687:
10688: =item *
10689:
10690: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10691: reference
10692:
10693: returns either a stat() list of data about the file or an empty list
10694: if the file doesn't exist or couldn't find out about it (connection
10695: problems or user unknown)
10696:
10697: =item *
10698:
10699: filelocation($dir,$file) : returns file system location of a file
10700: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10701: directory that relative $file lookups are to looked in ($dir of /a/dir
10702: and a file of ../bob will become /a/bob)
10703:
10704: =item *
10705:
10706: hreflocation($dir,$file) : returns file system location or a URL; same as
10707: filelocation except for hrefs
10708:
10709: =item *
10710:
10711: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10712:
10713: =back
10714:
10715: =head2 Usererfile file routines (/uploaded*)
10716:
10717: =over 4
10718:
10719: =item *
10720:
10721: userfileupload(): main rotine for putting a file in a user or course's
10722: filespace, arguments are,
10723:
10724: formname - required - this is the name of the element in $env where the
10725: filename, and the contents of the file to create/modifed exist
10726: the filename is in $env{'form.'.$formname.'.filename'} and the
10727: contents of the file is located in $env{'form.'.$formname}
10728: coursedoc - if true, store the file in the course of the active role
10729: of the current user
10730: subdir - required - subdirectory to put the file in under ../userfiles/
10731: if undefined, it will be placed in "unknown"
10732:
10733: (This routine calls clean_filename() to remove any dangerous
10734: characters from the filename, and then calls finuserfileupload() to
10735: complete the transaction)
10736:
10737: returns either the url of the uploaded file (/uploaded/....) if successful
10738: and /adm/notfound.html if unsuccessful
10739:
10740: =item *
10741:
10742: clean_filename(): routine for cleaing a filename up for storage in
10743: userfile space, argument is:
10744:
10745: filename - proposed filename
10746:
10747: returns: the new clean filename
10748:
10749: =item *
10750:
10751: finishuserfileupload(): routine that creaes and sends the file to
10752: userspace, probably shouldn't be called directly
10753:
10754: docuname: username or courseid of destination for the file
10755: docudom: domain of user/course of destination for the file
10756: formname: same as for userfileupload()
10757: fname: filename (inculding subdirectories) for the file
10758:
10759: returns either the url of the uploaded file (/uploaded/....) if successful
10760: and /adm/notfound.html if unsuccessful
10761:
10762: =item *
10763:
10764: renameuserfile(): renames an existing userfile to a new name
10765:
10766: Args:
10767: docuname: username or courseid of destination for the file
10768: docudom: domain of user/course of destination for the file
10769: old: current file name (including any subdirs under userfiles)
10770: new: desired file name (including any subdirs under userfiles)
10771:
10772: =item *
10773:
10774: mkdiruserfile(): creates a directory is a userfiles dir
10775:
10776: Args:
10777: docuname: username or courseid of destination for the file
10778: docudom: domain of user/course of destination for the file
10779: dir: dir to create (including any subdirs under userfiles)
10780:
10781: =item *
10782:
10783: removeuserfile(): removes a file that exists in userfiles
10784:
10785: Args:
10786: docuname: username or courseid of destination for the file
10787: docudom: domain of user/course of destination for the file
10788: fname: filname to delete (including any subdirs under userfiles)
10789:
10790: =item *
10791:
10792: removeuploadedurl(): convience function for removeuserfile()
10793:
10794: Args:
10795: url: a full /uploaded/... url to delete
10796:
10797: =item *
10798:
10799: get_portfile_permissions():
10800: Args:
10801: domain: domain of user or course contain the portfolio files
10802: user: name of user or num of course contain the portfolio files
10803: Returns:
10804: hashref of a dump of the proper file_permissions.db
10805:
10806:
10807: =item *
10808:
10809: get_access_controls():
10810:
10811: Args:
10812: current_permissions: the hash ref returned from get_portfile_permissions()
10813: group: (optional) the group you want the files associated with
10814: file: (optional) the file you want access info on
10815:
10816: Returns:
10817: a hash (keys are file names) of hashes containing
10818: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10819: values are XML containing access control settings (see below)
10820:
10821: Internal notes:
10822:
10823: access controls are stored in file_permissions.db as key=value pairs.
10824: key -> path to file/file_name\0uniqueID:scope_end_start
10825: where scope -> public,guest,course,group,domains or users.
10826: end -> UNIX time for end of access (0 -> no end date)
10827: start -> UNIX time for start of access
10828:
10829: value -> XML description of access control
10830: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
10831: <start></start>
10832: <end></end>
10833:
10834: <password></password> for scope type = guest
10835:
10836: <domain></domain> for scope type = course or group
10837: <number></number>
10838: <roles id="">
10839: <role></role>
10840: <access></access>
10841: <section></section>
10842: <group></group>
10843: </roles>
10844:
10845: <dom></dom> for scope type = domains
10846:
10847: <users> for scope type = users
10848: <user>
10849: <uname></uname>
10850: <udom></udom>
10851: </user>
10852: </users>
10853: </scope>
10854:
10855: Access data is also aggregated for each file in an additional key=value pair:
10856: key -> path to file/file_name\0accesscontrol
10857: value -> reference to hash
10858: hash contains key = value pairs
10859: where key = uniqueID:scope_end_start
10860: value = UNIX time record was last updated
10861:
10862: Used to improve speed of look-ups of access controls for each file.
10863:
10864: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
10865:
10866: modify_access_controls():
10867:
10868: Modifies access controls for a portfolio file
10869: Args
10870: 1. file name
10871: 2. reference to hash of required changes,
10872: 3. domain
10873: 4. username
10874: where domain,username are the domain of the portfolio owner
10875: (either a user or a course)
10876:
10877: Returns:
10878: 1. result of additions or updates ('ok' or 'error', with error message).
10879: 2. result of deletions ('ok' or 'error', with error message).
10880: 3. reference to hash of any new or updated access controls.
10881: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
10882: key = integer (inbound ID)
10883: value = uniqueID
10884:
10885: =back
10886:
10887: =head2 HTTP Helper Routines
10888:
10889: =over 4
10890:
10891: =item *
10892:
10893: escape() : unpack non-word characters into CGI-compatible hex codes
10894:
10895: =item *
10896:
10897: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
10898:
10899: =back
10900:
10901: =head1 PRIVATE SUBROUTINES
10902:
10903: =head2 Underlying communication routines (Shouldn't call)
10904:
10905: =over 4
10906:
10907: =item *
10908:
10909: subreply() : tries to pass a message to lonc, returns con_lost if incapable
10910:
10911: =item *
10912:
10913: reply() : uses subreply to send a message to remote machine, logs all failures
10914:
10915: =item *
10916:
10917: critical() : passes a critical message to another server; if cannot
10918: get through then place message in connection buffer directory and
10919: returns con_delayed, if incapable of saving message, returns
10920: con_failed
10921:
10922: =item *
10923:
10924: reconlonc() : tries to reconnect lonc client processes.
10925:
10926: =back
10927:
10928: =head2 Resource Access Logging
10929:
10930: =over 4
10931:
10932: =item *
10933:
10934: flushcourselogs() : flush (save) buffer logs and access logs
10935:
10936: =item *
10937:
10938: courselog($what) : save message for course in hash
10939:
10940: =item *
10941:
10942: courseacclog($what) : save message for course using &courselog(). Perform
10943: special processing for specific resource types (problems, exams, quizzes, etc).
10944:
10945: =item *
10946:
10947: goodbye() : flush course logs and log shutting down; it is called in srm.conf
10948: as a PerlChildExitHandler
10949:
10950: =back
10951:
10952: =head2 Other
10953:
10954: =over 4
10955:
10956: =item *
10957:
10958: symblist($mapname,%newhash) : update symbolic storage links
10959:
10960: =back
10961:
10962: =cut
10963:
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