1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.809 2006/11/28 19:46: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: package Apache::lonnet;
31:
32: use strict;
33: use LWP::UserAgent();
34: use HTTP::Headers;
35: use HTTP::Date;
36: # use Date::Parse;
37: use vars
38: qw(%perlvar %hostname %badServerCache %iphost %spareid %hostdom
39: %libserv %pr %prp $memcache %packagetab
40: %courselogs %accesshash %userrolehash %domainrolehash $processmarker $dumpcount
41: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseinstcodebuf %courseownerbuf %coursetypebuf
42: %domaindescription %domain_auth_def %domain_auth_arg_def
43: %domain_lang_def %domain_city %domain_longi %domain_lati %domain_primary
44: $tmpdir $_64bit %env);
45:
46: use IO::Socket;
47: use GDBM_File;
48: use HTML::LCParser;
49: use HTML::Parser;
50: use Fcntl qw(:flock);
51: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw nfreeze);
52: use Time::HiRes qw( gettimeofday tv_interval );
53: use Cache::Memcached;
54: use Digest::MD5;
55: use Math::Random;
56: use lib '/home/httpd/lib/perl';
57: use LONCAPA qw(:DEFAULT :match);
58: use LONCAPA::Configuration;
59:
60: my $readit;
61: my $max_connection_retries = 10; # Or some such value.
62:
63: require Exporter;
64:
65: our @ISA = qw (Exporter);
66: our @EXPORT = qw(%env);
67:
68: =pod
69:
70: =head1 Package Variables
71:
72: These are largely undocumented, so if you decipher one please note it here.
73:
74: =over 4
75:
76: =item $processmarker
77:
78: Contains the time this process was started and this servers host id.
79:
80: =item $dumpcount
81:
82: Counts the number of times a message log flush has been attempted (regardless
83: of success) by this process. Used as part of the filename when messages are
84: delayed.
85:
86: =back
87:
88: =cut
89:
90:
91: # --------------------------------------------------------------------- Logging
92: {
93: my $logid;
94: sub instructor_log {
95: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
96: $logid++;
97: my $id=time().'00000'.$$.'00000'.$logid;
98: return &Apache::lonnet::put('nohist_'.$hash_name,
99: { $id => {
100: 'exe_uname' => $env{'user.name'},
101: 'exe_udom' => $env{'user.domain'},
102: 'exe_time' => time(),
103: 'exe_ip' => $ENV{'REMOTE_ADDR'},
104: 'delflag' => $delflag,
105: 'logentry' => $storehash,
106: 'uname' => $uname,
107: 'udom' => $udom,
108: }
109: },
110: $env{'course.'.$env{'request.course.id'}.'.domain'},
111: $env{'course.'.$env{'request.course.id'}.'.num'}
112: );
113: }
114: }
115:
116: sub logtouch {
117: my $execdir=$perlvar{'lonDaemons'};
118: unless (-e "$execdir/logs/lonnet.log") {
119: open(my $fh,">>$execdir/logs/lonnet.log");
120: close $fh;
121: }
122: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
123: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
124: }
125:
126: sub logthis {
127: my $message=shift;
128: my $execdir=$perlvar{'lonDaemons'};
129: my $now=time;
130: my $local=localtime($now);
131: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
132: print $fh "$local ($$): $message\n";
133: close($fh);
134: }
135: return 1;
136: }
137:
138: sub logperm {
139: my $message=shift;
140: my $execdir=$perlvar{'lonDaemons'};
141: my $now=time;
142: my $local=localtime($now);
143: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
144: print $fh "$now:$message:$local\n";
145: close($fh);
146: }
147: return 1;
148: }
149:
150: # -------------------------------------------------- Non-critical communication
151: sub subreply {
152: my ($cmd,$server)=@_;
153: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
154: #
155: # With loncnew process trimming, there's a timing hole between lonc server
156: # process exit and the master server picking up the listen on the AF_UNIX
157: # socket. In that time interval, a lock file will exist:
158:
159: my $lockfile=$peerfile.".lock";
160: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
161: sleep(1);
162: }
163: # At this point, either a loncnew parent is listening or an old lonc
164: # or loncnew child is listening so we can connect or everything's dead.
165: #
166: # We'll give the connection a few tries before abandoning it. If
167: # connection is not possible, we'll con_lost back to the client.
168: #
169: my $client;
170: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
171: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
172: Type => SOCK_STREAM,
173: Timeout => 10);
174: if($client) {
175: last; # Connected!
176: }
177: sleep(1); # Try again later if failed connection.
178: }
179: my $answer;
180: if ($client) {
181: print $client "sethost:$server:$cmd\n";
182: $answer=<$client>;
183: if (!$answer) { $answer="con_lost"; }
184: chomp($answer);
185: } else {
186: $answer = 'con_lost'; # Failed connection.
187: }
188: return $answer;
189: }
190:
191: sub reply {
192: my ($cmd,$server)=@_;
193: unless (defined($hostname{$server})) { return 'no_such_host'; }
194: my $answer=subreply($cmd,$server);
195: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
196: &logthis("<font color=\"blue\">WARNING:".
197: " $cmd to $server returned $answer</font>");
198: }
199: return $answer;
200: }
201:
202: # ----------------------------------------------------------- Send USR1 to lonc
203:
204: sub reconlonc {
205: my $peerfile=shift;
206: &logthis("Trying to reconnect for $peerfile");
207: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
208: if (open(my $fh,"<$loncfile")) {
209: my $loncpid=<$fh>;
210: chomp($loncpid);
211: if (kill 0 => $loncpid) {
212: &logthis("lonc at pid $loncpid responding, sending USR1");
213: kill USR1 => $loncpid;
214: sleep 1;
215: if (-e "$peerfile") { return; }
216: &logthis("$peerfile still not there, give it another try");
217: sleep 5;
218: if (-e "$peerfile") { return; }
219: &logthis(
220: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
221: } else {
222: &logthis(
223: "<font color=\"blue\">WARNING:".
224: " lonc at pid $loncpid not responding, giving up</font>");
225: }
226: } else {
227: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
228: }
229: }
230:
231: # ------------------------------------------------------ Critical communication
232:
233: sub critical {
234: my ($cmd,$server)=@_;
235: unless ($hostname{$server}) {
236: &logthis("<font color=\"blue\">WARNING:".
237: " Critical message to unknown server ($server)</font>");
238: return 'no_such_host';
239: }
240: my $answer=reply($cmd,$server);
241: if ($answer eq 'con_lost') {
242: &reconlonc("$perlvar{'lonSockDir'}/$server");
243: my $answer=reply($cmd,$server);
244: if ($answer eq 'con_lost') {
245: my $now=time;
246: my $middlename=$cmd;
247: $middlename=substr($middlename,0,16);
248: $middlename=~s/\W//g;
249: my $dfilename=
250: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
251: $dumpcount++;
252: {
253: my $dfh;
254: if (open($dfh,">$dfilename")) {
255: print $dfh "$cmd\n";
256: close($dfh);
257: }
258: }
259: sleep 2;
260: my $wcmd='';
261: {
262: my $dfh;
263: if (open($dfh,"<$dfilename")) {
264: $wcmd=<$dfh>;
265: close($dfh);
266: }
267: }
268: chomp($wcmd);
269: if ($wcmd eq $cmd) {
270: &logthis("<font color=\"blue\">WARNING: ".
271: "Connection buffer $dfilename: $cmd</font>");
272: &logperm("D:$server:$cmd");
273: return 'con_delayed';
274: } else {
275: &logthis("<font color=\"red\">CRITICAL:"
276: ." Critical connection failed: $server $cmd</font>");
277: &logperm("F:$server:$cmd");
278: return 'con_failed';
279: }
280: }
281: }
282: return $answer;
283: }
284:
285: # ------------------------------------------- check if return value is an error
286:
287: sub error {
288: my ($result) = @_;
289: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
290: if ($2 == 2) { return undef; }
291: return $1;
292: }
293: return undef;
294: }
295:
296: sub convert_and_load_session_env {
297: my ($lonidsdir,$handle)=@_;
298: my @profile;
299: {
300: open(my $idf,"$lonidsdir/$handle.id");
301: flock($idf,LOCK_SH);
302: @profile=<$idf>;
303: close($idf);
304: }
305: my %temp_env;
306: foreach my $line (@profile) {
307: if ($line !~ m/=/) {
308: return 0;
309: }
310: chomp($line);
311: my ($envname,$envvalue)=split(/=/,$line,2);
312: $temp_env{&unescape($envname)} = &unescape($envvalue);
313: }
314: unlink("$lonidsdir/$handle.id");
315: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
316: 0640)) {
317: %disk_env = %temp_env;
318: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
319: untie(%disk_env);
320: }
321: return 1;
322: }
323:
324: # ------------------------------------------- Transfer profile into environment
325: my $env_loaded;
326: sub transfer_profile_to_env {
327: my ($lonidsdir,$handle,$force_transfer) = @_;
328: if (!$force_transfer && $env_loaded) { return; }
329:
330: if (!defined($lonidsdir)) {
331: $lonidsdir = $perlvar{'lonIDsDir'};
332: }
333: if (!defined($handle)) {
334: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
335: }
336:
337: my $convert;
338: {
339: open(my $idf,"$lonidsdir/$handle.id");
340: flock($idf,LOCK_SH);
341: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
342: &GDBM_READER(),0640)) {
343: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
344: untie(%disk_env);
345: } else {
346: $convert = 1;
347: }
348: }
349: if ($convert) {
350: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
351: &logthis("Failed to load session, or convert session.");
352: }
353: }
354:
355: my %remove;
356: while ( my $envname = each(%env) ) {
357: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
358: if ($time < time-300) {
359: $remove{$key}++;
360: }
361: }
362: }
363:
364: $env{'user.environment'} = "$lonidsdir/$handle.id";
365: $env_loaded=1;
366: foreach my $expired_key (keys(%remove)) {
367: &delenv($expired_key);
368: }
369: }
370:
371: # ---------------------------------------------------------- Append Environment
372:
373: sub appenv {
374: my %newenv=@_;
375: foreach my $key (keys(%newenv)) {
376: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
377: &logthis("<font color=\"blue\">WARNING: ".
378: "Attempt to modify environment ".$key." to ".$newenv{$key}
379: .'</font>');
380: delete($newenv{$key});
381: } else {
382: $env{$key}=$newenv{$key};
383: }
384: }
385: if (tie(my %disk_env,'GDBM_File',$env{'user.environment'},&GDBM_WRITER(),
386: 0640)) {
387: while (my ($key,$value) = each(%newenv)) {
388: $disk_env{$key} = $value;
389: }
390: untie(%disk_env);
391: }
392: return 'ok';
393: }
394: # ----------------------------------------------------- Delete from Environment
395:
396: sub delenv {
397: my $delthis=shift;
398: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
399: &logthis("<font color=\"blue\">WARNING: ".
400: "Attempt to delete from environment ".$delthis);
401: return 'error';
402: }
403: if (tie(my %disk_env,'GDBM_File',$env{'user.environment'},&GDBM_WRITER(),
404: 0640)) {
405: foreach my $key (keys(%disk_env)) {
406: if ($key=~/^$delthis/) {
407: delete($env{$key});
408: delete($disk_env{$key});
409: }
410: }
411: untie(%disk_env);
412: }
413: return 'ok';
414: }
415:
416: sub get_env_multiple {
417: my ($name) = @_;
418: my @values;
419: if (defined($env{$name})) {
420: # exists is it an array
421: if (ref($env{$name})) {
422: @values=@{ $env{$name} };
423: } else {
424: $values[0]=$env{$name};
425: }
426: }
427: return(@values);
428: }
429:
430: # ------------------------------------------ Find out current server userload
431: # there is a copy in lond
432: sub userload {
433: my $numusers=0;
434: {
435: opendir(LONIDS,$perlvar{'lonIDsDir'});
436: my $filename;
437: my $curtime=time;
438: while ($filename=readdir(LONIDS)) {
439: if ($filename eq '.' || $filename eq '..') {next;}
440: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
441: if ($curtime-$mtime < 1800) { $numusers++; }
442: }
443: closedir(LONIDS);
444: }
445: my $userloadpercent=0;
446: my $maxuserload=$perlvar{'lonUserLoadLim'};
447: if ($maxuserload) {
448: $userloadpercent=100*$numusers/$maxuserload;
449: }
450: $userloadpercent=sprintf("%.2f",$userloadpercent);
451: return $userloadpercent;
452: }
453:
454: # ------------------------------------------ Fight off request when overloaded
455:
456: sub overloaderror {
457: my ($r,$checkserver)=@_;
458: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
459: my $loadavg;
460: if ($checkserver eq $perlvar{'lonHostID'}) {
461: open(my $loadfile,'/proc/loadavg');
462: $loadavg=<$loadfile>;
463: $loadavg =~ s/\s.*//g;
464: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
465: close($loadfile);
466: } else {
467: $loadavg=&reply('load',$checkserver);
468: }
469: my $overload=$loadavg-100;
470: if ($overload>0) {
471: $r->err_headers_out->{'Retry-After'}=$overload;
472: $r->log_error('Overload of '.$overload.' on '.$checkserver);
473: return 413;
474: }
475: return '';
476: }
477:
478: # ------------------------------ Find server with least workload from spare.tab
479:
480: sub spareserver {
481: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
482: my $spare_server;
483: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
484: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
485: : $userloadpercent;
486:
487: foreach my $try_server (@{ $spareid{'primary'} }) {
488: ($spare_server, $lowest_load) =
489: &compare_server_load($try_server, $spare_server, $lowest_load);
490: }
491:
492: my $found_server = ($spare_server ne '' && $lowest_load < 100);
493:
494: if (!$found_server) {
495: foreach my $try_server (@{ $spareid{'default'} }) {
496: ($spare_server, $lowest_load) =
497: &compare_server_load($try_server, $spare_server, $lowest_load);
498: }
499: }
500:
501: if (!$want_server_name) {
502: $spare_server="http://$hostname{$spare_server}";
503: }
504: return $spare_server;
505: }
506:
507: sub compare_server_load {
508: my ($try_server, $spare_server, $lowest_load) = @_;
509:
510: my $loadans = &reply('load', $try_server);
511: my $userloadans = &reply('userload',$try_server);
512:
513: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
514: next; #didn't get a number from the server
515: }
516:
517: my $load;
518: if ($loadans =~ /\d/) {
519: if ($userloadans =~ /\d/) {
520: #both are numbers, pick the bigger one
521: $load = ($loadans > $userloadans) ? $loadans
522: : $userloadans;
523: } else {
524: $load = $loadans;
525: }
526: } else {
527: $load = $userloadans;
528: }
529:
530: if (($load =~ /\d/) && ($load < $lowest_load)) {
531: $spare_server = $try_server;
532: $lowest_load = $load;
533: }
534: return ($spare_server,$lowest_load);
535: }
536: # --------------------------------------------- Try to change a user's password
537:
538: sub changepass {
539: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
540: $currentpass = &escape($currentpass);
541: $newpass = &escape($newpass);
542: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context",
543: $server);
544: if (! $answer) {
545: &logthis("No reply on password change request to $server ".
546: "by $uname in domain $udom.");
547: } elsif ($answer =~ "^ok") {
548: &logthis("$uname in $udom successfully changed their password ".
549: "on $server.");
550: } elsif ($answer =~ "^pwchange_failure") {
551: &logthis("$uname in $udom was unable to change their password ".
552: "on $server. The action was blocked by either lcpasswd ".
553: "or pwchange");
554: } elsif ($answer =~ "^non_authorized") {
555: &logthis("$uname in $udom did not get their password correct when ".
556: "attempting to change it on $server.");
557: } elsif ($answer =~ "^auth_mode_error") {
558: &logthis("$uname in $udom attempted to change their password despite ".
559: "not being locally or internally authenticated on $server.");
560: } elsif ($answer =~ "^unknown_user") {
561: &logthis("$uname in $udom attempted to change their password ".
562: "on $server but were unable to because $server is not ".
563: "their home server.");
564: } elsif ($answer =~ "^refused") {
565: &logthis("$server refused to change $uname in $udom password because ".
566: "it was sent an unencrypted request to change the password.");
567: }
568: return $answer;
569: }
570:
571: # ----------------------- Try to determine user's current authentication scheme
572:
573: sub queryauthenticate {
574: my ($uname,$udom)=@_;
575: my $uhome=&homeserver($uname,$udom);
576: if (!$uhome) {
577: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
578: return 'no_host';
579: }
580: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
581: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
582: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
583: }
584: return $answer;
585: }
586:
587: # --------- Try to authenticate user from domain's lib servers (first this one)
588:
589: sub authenticate {
590: my ($uname,$upass,$udom)=@_;
591: $upass=&escape($upass);
592: $uname= &LONCAPA::clean_username($uname);
593: my $uhome=&homeserver($uname,$udom);
594: if (!$uhome) {
595: &logthis("User $uname at $udom is unknown in authenticate");
596: return 'no_host';
597: }
598: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
599: if ($answer eq 'authorized') {
600: &logthis("User $uname at $udom authorized by $uhome");
601: return $uhome;
602: }
603: if ($answer eq 'non_authorized') {
604: &logthis("User $uname at $udom rejected by $uhome");
605: return 'no_host';
606: }
607: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
608: return 'no_host';
609: }
610:
611: # ---------------------- Find the homebase for a user from domain's lib servers
612:
613: my %homecache;
614: sub homeserver {
615: my ($uname,$udom,$ignoreBadCache)=@_;
616: my $index="$uname:$udom";
617:
618: if (exists($homecache{$index})) { return $homecache{$index}; }
619: my $tryserver;
620: foreach $tryserver (keys %libserv) {
621: next if ($ignoreBadCache ne 'true' &&
622: exists($badServerCache{$tryserver}));
623: if ($hostdom{$tryserver} eq $udom) {
624: my $answer=reply("home:$udom:$uname",$tryserver);
625: if ($answer eq 'found') {
626: return $homecache{$index}=$tryserver;
627: } elsif ($answer eq 'no_host') {
628: $badServerCache{$tryserver}=1;
629: }
630: }
631: }
632: return 'no_host';
633: }
634:
635: # ------------------------------------- Find the usernames behind a list of IDs
636:
637: sub idget {
638: my ($udom,@ids)=@_;
639: my %returnhash=();
640:
641: my $tryserver;
642: foreach $tryserver (keys %libserv) {
643: if ($hostdom{$tryserver} eq $udom) {
644: my $idlist=join('&',@ids);
645: $idlist=~tr/A-Z/a-z/;
646: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
647: my @answer=();
648: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
649: @answer=split(/\&/,$reply);
650: } ;
651: my $i;
652: for ($i=0;$i<=$#ids;$i++) {
653: if ($answer[$i]) {
654: $returnhash{$ids[$i]}=$answer[$i];
655: }
656: }
657: }
658: }
659: return %returnhash;
660: }
661:
662: # ------------------------------------- Find the IDs behind a list of usernames
663:
664: sub idrget {
665: my ($udom,@unames)=@_;
666: my %returnhash=();
667: foreach my $uname (@unames) {
668: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
669: }
670: return %returnhash;
671: }
672:
673: # ------------------------------- Store away a list of names and associated IDs
674:
675: sub idput {
676: my ($udom,%ids)=@_;
677: my %servers=();
678: foreach my $uname (keys(%ids)) {
679: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
680: my $uhom=&homeserver($uname,$udom);
681: if ($uhom ne 'no_host') {
682: my $id=&escape($ids{$uname});
683: $id=~tr/A-Z/a-z/;
684: my $esc_unam=&escape($uname);
685: if ($servers{$uhom}) {
686: $servers{$uhom}.='&'.$id.'='.$esc_unam;
687: } else {
688: $servers{$uhom}=$id.'='.$esc_unam;
689: }
690: }
691: }
692: foreach my $server (keys(%servers)) {
693: &critical('idput:'.$udom.':'.$servers{$server},$server);
694: }
695: }
696:
697: # ------------------------------------------- get items from domain db files
698:
699: sub get_dom {
700: my ($namespace,$storearr,$udom)=@_;
701: my $items='';
702: foreach my $item (@$storearr) {
703: $items.=&escape($item).'&';
704: }
705: $items=~s/\&$//;
706: if (!$udom) { $udom=$env{'user.domain'}; }
707: if (exists($domain_primary{$udom})) {
708: my $uhome=$domain_primary{$udom};
709: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
710: my @pairs=split(/\&/,$rep);
711: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
712: return @pairs;
713: }
714: my %returnhash=();
715: my $i=0;
716: foreach my $item (@$storearr) {
717: $returnhash{$item}=&thaw_unescape($pairs[$i]);
718: $i++;
719: }
720: return %returnhash;
721: } else {
722: &logthis("get_dom failed - no primary domain server for $udom");
723: }
724: }
725:
726: # -------------------------------------------- put items in domain db files
727:
728: sub put_dom {
729: my ($namespace,$storehash,$udom)=@_;
730: if (!$udom) { $udom=$env{'user.domain'}; }
731: if (exists($domain_primary{$udom})) {
732: my $uhome=$domain_primary{$udom};
733: my $items='';
734: foreach my $item (keys(%$storehash)) {
735: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
736: }
737: $items=~s/\&$//;
738: return &reply("putdom:$udom:$namespace:$items",$uhome);
739: } else {
740: &logthis("put_dom failed - no primary domain server for $udom");
741: }
742: }
743:
744: # --------------------------------------------------- Assign a key to a student
745:
746: sub assign_access_key {
747: #
748: # a valid key looks like uname:udom#comments
749: # comments are being appended
750: #
751: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
752: $kdom=
753: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
754: $knum=
755: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
756: $cdom=
757: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
758: $cnum=
759: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
760: $udom=$env{'user.name'} unless (defined($udom));
761: $uname=$env{'user.domain'} unless (defined($uname));
762: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
763: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
764: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
765: # assigned to this person
766: # - this should not happen,
767: # unless something went wrong
768: # the first time around
769: # ready to assign
770: $logentry=$1.'; '.$logentry;
771: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
772: $kdom,$knum) eq 'ok') {
773: # key now belongs to user
774: my $envkey='key.'.$cdom.'_'.$cnum;
775: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
776: &appenv('environment.'.$envkey => $ckey);
777: return 'ok';
778: } else {
779: return
780: 'error: Count not permanently assign key, will need to be re-entered later.';
781: }
782: } else {
783: return 'error: Could not assign key, try again later.';
784: }
785: } elsif (!$existing{$ckey}) {
786: # the key does not exist
787: return 'error: The key does not exist';
788: } else {
789: # the key is somebody else's
790: return 'error: The key is already in use';
791: }
792: }
793:
794: # ------------------------------------------ put an additional comment on a key
795:
796: sub comment_access_key {
797: #
798: # a valid key looks like uname:udom#comments
799: # comments are being appended
800: #
801: my ($ckey,$cdom,$cnum,$logentry)=@_;
802: $cdom=
803: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
804: $cnum=
805: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
806: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
807: if ($existing{$ckey}) {
808: $existing{$ckey}.='; '.$logentry;
809: # ready to assign
810: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
811: $cdom,$cnum) eq 'ok') {
812: return 'ok';
813: } else {
814: return 'error: Count not store comment.';
815: }
816: } else {
817: # the key does not exist
818: return 'error: The key does not exist';
819: }
820: }
821:
822: # ------------------------------------------------------ Generate a set of keys
823:
824: sub generate_access_keys {
825: my ($number,$cdom,$cnum,$logentry)=@_;
826: $cdom=
827: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
828: $cnum=
829: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
830: unless (&allowed('mky',$cdom)) { return 0; }
831: unless (($cdom) && ($cnum)) { return 0; }
832: if ($number>10000) { return 0; }
833: sleep(2); # make sure don't get same seed twice
834: srand(time()^($$+($$<<15))); # from "Programming Perl"
835: my $total=0;
836: for (my $i=1;$i<=$number;$i++) {
837: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
838: sprintf("%lx",int(100000*rand)).'-'.
839: sprintf("%lx",int(100000*rand));
840: $newkey=~s/1/g/g; # folks mix up 1 and l
841: $newkey=~s/0/h/g; # and also 0 and O
842: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
843: if ($existing{$newkey}) {
844: $i--;
845: } else {
846: if (&put('accesskeys',
847: { $newkey => '# generated '.localtime().
848: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
849: '; '.$logentry },
850: $cdom,$cnum) eq 'ok') {
851: $total++;
852: }
853: }
854: }
855: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
856: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
857: return $total;
858: }
859:
860: # ------------------------------------------------------- Validate an accesskey
861:
862: sub validate_access_key {
863: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
864: $cdom=
865: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
866: $cnum=
867: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
868: $udom=$env{'user.domain'} unless (defined($udom));
869: $uname=$env{'user.name'} unless (defined($uname));
870: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
871: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
872: }
873:
874: # ------------------------------------- Find the section of student in a course
875: sub devalidate_getsection_cache {
876: my ($udom,$unam,$courseid)=@_;
877: my $hashid="$udom:$unam:$courseid";
878: &devalidate_cache_new('getsection',$hashid);
879: }
880:
881: sub getsection {
882: my ($udom,$unam,$courseid)=@_;
883: my $cachetime=1800;
884:
885: my $hashid="$udom:$unam:$courseid";
886: my ($result,$cached)=&is_cached_new('getsection',$hashid);
887: if (defined($cached)) { return $result; }
888:
889: my %Pending;
890: my %Expired;
891: #
892: # Each role can either have not started yet (pending), be active,
893: # or have expired.
894: #
895: # If there is an active role, we are done.
896: #
897: # If there is more than one role which has not started yet,
898: # choose the one which will start sooner
899: # If there is one role which has not started yet, return it.
900: #
901: # If there is more than one expired role, choose the one which ended last.
902: # If there is a role which has expired, return it.
903: #
904: foreach my $line (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
905: &homeserver($unam,$udom)))) {
906: my ($key,$value)=split(/\=/,$line,2);
907: $key=&unescape($key);
908: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
909: my $section=$1;
910: if ($key eq $courseid.'_st') { $section=''; }
911: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
912: my $now=time;
913: if (defined($end) && $end && ($now > $end)) {
914: $Expired{$end}=$section;
915: next;
916: }
917: if (defined($start) && $start && ($now < $start)) {
918: $Pending{$start}=$section;
919: next;
920: }
921: return &do_cache_new('getsection',$hashid,$section,$cachetime);
922: }
923: #
924: # Presumedly there will be few matching roles from the above
925: # loop and the sorting time will be negligible.
926: if (scalar(keys(%Pending))) {
927: my ($time) = sort {$a <=> $b} keys(%Pending);
928: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
929: }
930: if (scalar(keys(%Expired))) {
931: my @sorted = sort {$a <=> $b} keys(%Expired);
932: my $time = pop(@sorted);
933: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
934: }
935: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
936: }
937:
938: sub save_cache {
939: &purge_remembered();
940: #&Apache::loncommon::validate_page();
941: undef(%env);
942: undef($env_loaded);
943: }
944:
945: my $to_remember=-1;
946: my %remembered;
947: my %accessed;
948: my $kicks=0;
949: my $hits=0;
950: sub devalidate_cache_new {
951: my ($name,$id,$debug) = @_;
952: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
953: $id=&escape($name.':'.$id);
954: $memcache->delete($id);
955: delete($remembered{$id});
956: delete($accessed{$id});
957: }
958:
959: sub is_cached_new {
960: my ($name,$id,$debug) = @_;
961: $id=&escape($name.':'.$id);
962: if (exists($remembered{$id})) {
963: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
964: $accessed{$id}=[&gettimeofday()];
965: $hits++;
966: return ($remembered{$id},1);
967: }
968: my $value = $memcache->get($id);
969: if (!(defined($value))) {
970: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
971: return (undef,undef);
972: }
973: if ($value eq '__undef__') {
974: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
975: $value=undef;
976: }
977: &make_room($id,$value,$debug);
978: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
979: return ($value,1);
980: }
981:
982: sub do_cache_new {
983: my ($name,$id,$value,$time,$debug) = @_;
984: $id=&escape($name.':'.$id);
985: my $setvalue=$value;
986: if (!defined($setvalue)) {
987: $setvalue='__undef__';
988: }
989: if (!defined($time) ) {
990: $time=600;
991: }
992: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
993: $memcache->set($id,$setvalue,$time);
994: # need to make a copy of $value
995: #&make_room($id,$value,$debug);
996: return $value;
997: }
998:
999: sub make_room {
1000: my ($id,$value,$debug)=@_;
1001: $remembered{$id}=$value;
1002: if ($to_remember<0) { return; }
1003: $accessed{$id}=[&gettimeofday()];
1004: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1005: my $to_kick;
1006: my $max_time=0;
1007: foreach my $other (keys(%accessed)) {
1008: if (&tv_interval($accessed{$other}) > $max_time) {
1009: $to_kick=$other;
1010: $max_time=&tv_interval($accessed{$other});
1011: }
1012: }
1013: delete($remembered{$to_kick});
1014: delete($accessed{$to_kick});
1015: $kicks++;
1016: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1017: return;
1018: }
1019:
1020: sub purge_remembered {
1021: #&logthis("Tossing ".scalar(keys(%remembered)));
1022: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1023: undef(%remembered);
1024: undef(%accessed);
1025: }
1026: # ------------------------------------- Read an entry from a user's environment
1027:
1028: sub userenvironment {
1029: my ($udom,$unam,@what)=@_;
1030: my %returnhash=();
1031: my @answer=split(/\&/,
1032: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
1033: &homeserver($unam,$udom)));
1034: my $i;
1035: for ($i=0;$i<=$#what;$i++) {
1036: $returnhash{$what[$i]}=&unescape($answer[$i]);
1037: }
1038: return %returnhash;
1039: }
1040:
1041: # ---------------------------------------------------------- Get a studentphoto
1042: sub studentphoto {
1043: my ($udom,$unam,$ext) = @_;
1044: my $home=&Apache::lonnet::homeserver($unam,$udom);
1045: if (defined($env{'request.course.id'})) {
1046: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1047: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1048: return(&retrievestudentphoto($udom,$unam,$ext));
1049: } else {
1050: my ($result,$perm_reqd)=
1051: &Apache::lonnet::auto_photo_permission($unam,$udom);
1052: if ($result eq 'ok') {
1053: if (!($perm_reqd eq 'yes')) {
1054: return(&retrievestudentphoto($udom,$unam,$ext));
1055: }
1056: }
1057: }
1058: }
1059: } else {
1060: my ($result,$perm_reqd) =
1061: &Apache::lonnet::auto_photo_permission($unam,$udom);
1062: if ($result eq 'ok') {
1063: if (!($perm_reqd eq 'yes')) {
1064: return(&retrievestudentphoto($udom,$unam,$ext));
1065: }
1066: }
1067: }
1068: return '/adm/lonKaputt/lonlogo_broken.gif';
1069: }
1070:
1071: sub retrievestudentphoto {
1072: my ($udom,$unam,$ext,$type) = @_;
1073: my $home=&Apache::lonnet::homeserver($unam,$udom);
1074: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1075: if ($ret eq 'ok') {
1076: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1077: if ($type eq 'thumbnail') {
1078: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1079: }
1080: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1081: return $tokenurl;
1082: } else {
1083: if ($type eq 'thumbnail') {
1084: return '/adm/lonKaputt/genericstudent_tn.gif';
1085: } else {
1086: return '/adm/lonKaputt/lonlogo_broken.gif';
1087: }
1088: }
1089: }
1090:
1091: # -------------------------------------------------------------------- New chat
1092:
1093: sub chatsend {
1094: my ($newentry,$anon,$group)=@_;
1095: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1096: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1097: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1098: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1099: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1100: &escape($newentry)).':'.$group,$chome);
1101: }
1102:
1103: # ------------------------------------------ Find current version of a resource
1104:
1105: sub getversion {
1106: my $fname=&clutter(shift);
1107: unless ($fname=~/^\/res\//) { return -1; }
1108: return ¤tversion(&filelocation('',$fname));
1109: }
1110:
1111: sub currentversion {
1112: my $fname=shift;
1113: my ($result,$cached)=&is_cached_new('resversion',$fname);
1114: if (defined($cached)) { return $result; }
1115: my $author=$fname;
1116: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1117: my ($udom,$uname)=split(/\//,$author);
1118: my $home=homeserver($uname,$udom);
1119: if ($home eq 'no_host') {
1120: return -1;
1121: }
1122: my $answer=reply("currentversion:$fname",$home);
1123: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1124: return -1;
1125: }
1126: return &do_cache_new('resversion',$fname,$answer,600);
1127: }
1128:
1129: # ----------------------------- Subscribe to a resource, return URL if possible
1130:
1131: sub subscribe {
1132: my $fname=shift;
1133: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1134: $fname=~s/[\n\r]//g;
1135: my $author=$fname;
1136: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1137: my ($udom,$uname)=split(/\//,$author);
1138: my $home=homeserver($uname,$udom);
1139: if ($home eq 'no_host') {
1140: return 'not_found';
1141: }
1142: my $answer=reply("sub:$fname",$home);
1143: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1144: $answer.=' by '.$home;
1145: }
1146: return $answer;
1147: }
1148:
1149: # -------------------------------------------------------------- Replicate file
1150:
1151: sub repcopy {
1152: my $filename=shift;
1153: $filename=~s/\/+/\//g;
1154: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1155: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1156: if ($filename=~m|^/home/httpd/html/userfiles/| or
1157: $filename=~m -^/*(uploaded|editupload)/-) {
1158: return &repcopy_userfile($filename);
1159: }
1160: $filename=~s/[\n\r]//g;
1161: my $transname="$filename.in.transfer";
1162: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1163: my $remoteurl=subscribe($filename);
1164: if ($remoteurl =~ /^con_lost by/) {
1165: &logthis("Subscribe returned $remoteurl: $filename");
1166: return 'unavailable';
1167: } elsif ($remoteurl eq 'not_found') {
1168: #&logthis("Subscribe returned not_found: $filename");
1169: return 'not_found';
1170: } elsif ($remoteurl =~ /^rejected by/) {
1171: &logthis("Subscribe returned $remoteurl: $filename");
1172: return 'forbidden';
1173: } elsif ($remoteurl eq 'directory') {
1174: return 'ok';
1175: } else {
1176: my $author=$filename;
1177: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1178: my ($udom,$uname)=split(/\//,$author);
1179: my $home=homeserver($uname,$udom);
1180: unless ($home eq $perlvar{'lonHostID'}) {
1181: my @parts=split(/\//,$filename);
1182: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1183: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1184: &logthis("Malconfiguration for replication: $filename");
1185: return 'bad_request';
1186: }
1187: my $count;
1188: for ($count=5;$count<$#parts;$count++) {
1189: $path.="/$parts[$count]";
1190: if ((-e $path)!=1) {
1191: mkdir($path,0777);
1192: }
1193: }
1194: my $ua=new LWP::UserAgent;
1195: my $request=new HTTP::Request('GET',"$remoteurl");
1196: my $response=$ua->request($request,$transname);
1197: if ($response->is_error()) {
1198: unlink($transname);
1199: my $message=$response->status_line;
1200: &logthis("<font color=\"blue\">WARNING:"
1201: ." LWP get: $message: $filename</font>");
1202: return 'unavailable';
1203: } else {
1204: if ($remoteurl!~/\.meta$/) {
1205: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1206: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1207: if ($mresponse->is_error()) {
1208: unlink($filename.'.meta');
1209: &logthis(
1210: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1211: }
1212: }
1213: rename($transname,$filename);
1214: return 'ok';
1215: }
1216: }
1217: }
1218: }
1219:
1220: # ------------------------------------------------ Get server side include body
1221: sub ssi_body {
1222: my ($filelink,%form)=@_;
1223: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1224: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1225: }
1226: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1227: &ssi($filelink,%form));
1228: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1229: $output=~s/^.*?\<body[^\>]*\>//si;
1230: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1231: return $output;
1232: }
1233:
1234: # --------------------------------------------------------- Server Side Include
1235:
1236: sub absolute_url {
1237: my ($host_name) = @_;
1238: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1239: if ($host_name eq '') {
1240: $host_name = $ENV{'SERVER_NAME'};
1241: }
1242: return $protocol.$host_name;
1243: }
1244:
1245: sub ssi {
1246:
1247: my ($fn,%form)=@_;
1248:
1249: my $ua=new LWP::UserAgent;
1250:
1251: my $request;
1252:
1253: $form{'no_update_last_known'}=1;
1254:
1255: if (%form) {
1256: $request=new HTTP::Request('POST',&absolute_url().$fn);
1257: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1258: } else {
1259: $request=new HTTP::Request('GET',&absolute_url().$fn);
1260: }
1261:
1262: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1263: my $response=$ua->request($request);
1264:
1265: return $response->content;
1266: }
1267:
1268: sub externalssi {
1269: my ($url)=@_;
1270: my $ua=new LWP::UserAgent;
1271: my $request=new HTTP::Request('GET',$url);
1272: my $response=$ua->request($request);
1273: return $response->content;
1274: }
1275:
1276: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1277:
1278: sub allowuploaded {
1279: my ($srcurl,$url)=@_;
1280: $url=&clutter(&declutter($url));
1281: my $dir=$url;
1282: $dir=~s/\/[^\/]+$//;
1283: my %httpref=();
1284: my $httpurl=&hreflocation('',$url);
1285: $httpref{'httpref.'.$httpurl}=$srcurl;
1286: &Apache::lonnet::appenv(%httpref);
1287: }
1288:
1289: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1290: # input: action, courseID, current domain, intended
1291: # path to file, source of file, instruction to parse file for objects,
1292: # ref to hash for embedded objects,
1293: # ref to hash for codebase of java objects.
1294: #
1295: # output: url to file (if action was uploaddoc),
1296: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1297: #
1298: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1299: # course.
1300: #
1301: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1302: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1303: # course's home server.
1304: #
1305: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1306: # be copied from $source (current location) to
1307: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1308: # and will then be copied to
1309: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1310: # course's home server.
1311: #
1312: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1313: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1314: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1315: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1316: # in course's home server.
1317: #
1318:
1319: sub process_coursefile {
1320: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1321: my $fetchresult;
1322: my $home=&homeserver($docuname,$docudom);
1323: if ($action eq 'propagate') {
1324: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1325: $home);
1326: } else {
1327: my $fpath = '';
1328: my $fname = $file;
1329: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1330: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1331: my $filepath = &build_filepath($fpath);
1332: if ($action eq 'copy') {
1333: if ($source eq '') {
1334: $fetchresult = 'no source file';
1335: return $fetchresult;
1336: } else {
1337: my $destination = $filepath.'/'.$fname;
1338: rename($source,$destination);
1339: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1340: $home);
1341: }
1342: } elsif ($action eq 'uploaddoc') {
1343: open(my $fh,'>'.$filepath.'/'.$fname);
1344: print $fh $env{'form.'.$source};
1345: close($fh);
1346: if ($parser eq 'parse') {
1347: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1348: unless ($parse_result eq 'ok') {
1349: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1350: }
1351: }
1352: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1353: $home);
1354: if ($fetchresult eq 'ok') {
1355: return '/uploaded/'.$fpath.'/'.$fname;
1356: } else {
1357: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1358: ' to host '.$home.': '.$fetchresult);
1359: return '/adm/notfound.html';
1360: }
1361: }
1362: }
1363: unless ( $fetchresult eq 'ok') {
1364: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1365: ' to host '.$home.': '.$fetchresult);
1366: }
1367: return $fetchresult;
1368: }
1369:
1370: sub build_filepath {
1371: my ($fpath) = @_;
1372: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1373: unless ($fpath eq '') {
1374: my @parts=split('/',$fpath);
1375: foreach my $part (@parts) {
1376: $filepath.= '/'.$part;
1377: if ((-e $filepath)!=1) {
1378: mkdir($filepath,0777);
1379: }
1380: }
1381: }
1382: return $filepath;
1383: }
1384:
1385: sub store_edited_file {
1386: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1387: my $file = $primary_url;
1388: $file =~ s#^/uploaded/$docudom/$docuname/##;
1389: my $fpath = '';
1390: my $fname = $file;
1391: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1392: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1393: my $filepath = &build_filepath($fpath);
1394: open(my $fh,'>'.$filepath.'/'.$fname);
1395: print $fh $content;
1396: close($fh);
1397: my $home=&homeserver($docuname,$docudom);
1398: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1399: $home);
1400: if ($$fetchresult eq 'ok') {
1401: return '/uploaded/'.$fpath.'/'.$fname;
1402: } else {
1403: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1404: ' to host '.$home.': '.$$fetchresult);
1405: return '/adm/notfound.html';
1406: }
1407: }
1408:
1409: sub clean_filename {
1410: my ($fname)=@_;
1411: # Replace Windows backslashes by forward slashes
1412: $fname=~s/\\/\//g;
1413: # Get rid of everything but the actual filename
1414: $fname=~s/^.*\/([^\/]+)$/$1/;
1415: # Replace spaces by underscores
1416: $fname=~s/\s+/\_/g;
1417: # Replace all other weird characters by nothing
1418: $fname=~s/[^\w\.\-]//g;
1419: # Replace all .\d. sequences with _\d. so they no longer look like version
1420: # numbers
1421: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1422: return $fname;
1423: }
1424:
1425: # --------------- Take an uploaded file and put it into the userfiles directory
1426: # input: $formname - the contents of the file are in $env{"form.$formname"}
1427: # the desired filenam is in $env{"form.$formname.filename"}
1428: # $coursedoc - if true up to the current course
1429: # if false
1430: # $subdir - directory in userfile to store the file into
1431: # $parser, $allfiles, $codebase - unknown
1432: #
1433: # output: url of file in userspace, or error: <message>
1434: # or /adm/notfound.html if failure to upload occurse
1435:
1436:
1437: sub userfileupload {
1438: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1439: if (!defined($subdir)) { $subdir='unknown'; }
1440: my $fname=$env{'form.'.$formname.'.filename'};
1441: $fname=&clean_filename($fname);
1442: # See if there is anything left
1443: unless ($fname) { return 'error: no uploaded file'; }
1444: chop($env{'form.'.$formname});
1445: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1446: my $now = time;
1447: my $filepath = 'tmp/helprequests/'.$now;
1448: my @parts=split(/\//,$filepath);
1449: my $fullpath = $perlvar{'lonDaemons'};
1450: for (my $i=0;$i<@parts;$i++) {
1451: $fullpath .= '/'.$parts[$i];
1452: if ((-e $fullpath)!=1) {
1453: mkdir($fullpath,0777);
1454: }
1455: }
1456: open(my $fh,'>'.$fullpath.'/'.$fname);
1457: print $fh $env{'form.'.$formname};
1458: close($fh);
1459: return $fullpath.'/'.$fname;
1460: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1461: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1462: '_'.$env{'user.domain'}.'/pending';
1463: my @parts=split(/\//,$filepath);
1464: my $fullpath = $perlvar{'lonDaemons'};
1465: for (my $i=0;$i<@parts;$i++) {
1466: $fullpath .= '/'.$parts[$i];
1467: if ((-e $fullpath)!=1) {
1468: mkdir($fullpath,0777);
1469: }
1470: }
1471: open(my $fh,'>'.$fullpath.'/'.$fname);
1472: print $fh $env{'form.'.$formname};
1473: close($fh);
1474: return $fullpath.'/'.$fname;
1475: }
1476:
1477: # Create the directory if not present
1478: $fname="$subdir/$fname";
1479: if ($coursedoc) {
1480: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1481: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1482: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1483: return &finishuserfileupload($docuname,$docudom,
1484: $formname,$fname,$parser,$allfiles,
1485: $codebase);
1486: } else {
1487: $fname=$env{'form.folder'}.'/'.$fname;
1488: return &process_coursefile('uploaddoc',$docuname,$docudom,
1489: $fname,$formname,$parser,
1490: $allfiles,$codebase);
1491: }
1492: } elsif (defined($destuname)) {
1493: my $docuname=$destuname;
1494: my $docudom=$destudom;
1495: return &finishuserfileupload($docuname,$docudom,$formname,
1496: $fname,$parser,$allfiles,$codebase);
1497:
1498: } else {
1499: my $docuname=$env{'user.name'};
1500: my $docudom=$env{'user.domain'};
1501: if (exists($env{'form.group'})) {
1502: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1503: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1504: }
1505: return &finishuserfileupload($docuname,$docudom,$formname,
1506: $fname,$parser,$allfiles,$codebase);
1507: }
1508: }
1509:
1510: sub finishuserfileupload {
1511: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1512: my $path=$docudom.'/'.$docuname.'/';
1513: my $filepath=$perlvar{'lonDocRoot'};
1514: my ($fnamepath,$file);
1515: $file=$fname;
1516: if ($fname=~m|/|) {
1517: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1518: $path.=$fnamepath.'/';
1519: }
1520: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1521: my $count;
1522: for ($count=4;$count<=$#parts;$count++) {
1523: $filepath.="/$parts[$count]";
1524: if ((-e $filepath)!=1) {
1525: mkdir($filepath,0777);
1526: }
1527: }
1528: # Save the file
1529: {
1530: if (!open(FH,'>'.$filepath.'/'.$file)) {
1531: &logthis('Failed to create '.$filepath.'/'.$file);
1532: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1533: return '/adm/notfound.html';
1534: }
1535: if (!print FH ($env{'form.'.$formname})) {
1536: &logthis('Failed to write to '.$filepath.'/'.$file);
1537: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1538: return '/adm/notfound.html';
1539: }
1540: close(FH);
1541: }
1542: if ($parser eq 'parse') {
1543: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1544: $codebase);
1545: unless ($parse_result eq 'ok') {
1546: &logthis('Failed to parse '.$filepath.$file.
1547: ' for embedded media: '.$parse_result);
1548: }
1549: }
1550: # Notify homeserver to grep it
1551: #
1552: my $docuhome=&homeserver($docuname,$docudom);
1553: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1554: if ($fetchresult eq 'ok') {
1555: #
1556: # Return the URL to it
1557: return '/uploaded/'.$path.$file;
1558: } else {
1559: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1560: ': '.$fetchresult);
1561: return '/adm/notfound.html';
1562: }
1563: }
1564:
1565: sub extract_embedded_items {
1566: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1567: my @state = ();
1568: my %javafiles = (
1569: codebase => '',
1570: code => '',
1571: archive => ''
1572: );
1573: my %mediafiles = (
1574: src => '',
1575: movie => '',
1576: );
1577: my $p;
1578: if ($content) {
1579: $p = HTML::LCParser->new($content);
1580: } else {
1581: $p = HTML::LCParser->new($filepath.'/'.$file);
1582: }
1583: while (my $t=$p->get_token()) {
1584: if ($t->[0] eq 'S') {
1585: my ($tagname, $attr) = ($t->[1],$t->[2]);
1586: push (@state, $tagname);
1587: if (lc($tagname) eq 'allow') {
1588: &add_filetype($allfiles,$attr->{'src'},'src');
1589: }
1590: if (lc($tagname) eq 'img') {
1591: &add_filetype($allfiles,$attr->{'src'},'src');
1592: }
1593: if (lc($tagname) eq 'script') {
1594: if ($attr->{'archive'} =~ /\.jar$/i) {
1595: &add_filetype($allfiles,$attr->{'archive'},'archive');
1596: } else {
1597: &add_filetype($allfiles,$attr->{'src'},'src');
1598: }
1599: }
1600: if (lc($tagname) eq 'link') {
1601: if (lc($attr->{'rel'}) eq 'stylesheet') {
1602: &add_filetype($allfiles,$attr->{'href'},'href');
1603: }
1604: }
1605: if (lc($tagname) eq 'object' ||
1606: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1607: foreach my $item (keys(%javafiles)) {
1608: $javafiles{$item} = '';
1609: }
1610: }
1611: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1612: my $name = lc($attr->{'name'});
1613: foreach my $item (keys(%javafiles)) {
1614: if ($name eq $item) {
1615: $javafiles{$item} = $attr->{'value'};
1616: last;
1617: }
1618: }
1619: foreach my $item (keys(%mediafiles)) {
1620: if ($name eq $item) {
1621: &add_filetype($allfiles, $attr->{'value'}, 'value');
1622: last;
1623: }
1624: }
1625: }
1626: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1627: foreach my $item (keys(%javafiles)) {
1628: if ($attr->{$item}) {
1629: $javafiles{$item} = $attr->{$item};
1630: last;
1631: }
1632: }
1633: foreach my $item (keys(%mediafiles)) {
1634: if ($attr->{$item}) {
1635: &add_filetype($allfiles,$attr->{$item},$item);
1636: last;
1637: }
1638: }
1639: }
1640: } elsif ($t->[0] eq 'E') {
1641: my ($tagname) = ($t->[1]);
1642: if ($javafiles{'codebase'} ne '') {
1643: $javafiles{'codebase'} .= '/';
1644: }
1645: if (lc($tagname) eq 'applet' ||
1646: lc($tagname) eq 'object' ||
1647: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1648: ) {
1649: foreach my $item (keys(%javafiles)) {
1650: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1651: my $file=$javafiles{'codebase'}.$javafiles{$item};
1652: &add_filetype($allfiles,$file,$item);
1653: }
1654: }
1655: }
1656: pop @state;
1657: }
1658: }
1659: return 'ok';
1660: }
1661:
1662: sub add_filetype {
1663: my ($allfiles,$file,$type)=@_;
1664: if (exists($allfiles->{$file})) {
1665: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1666: push(@{$allfiles->{$file}}, &escape($type));
1667: }
1668: } else {
1669: @{$allfiles->{$file}} = (&escape($type));
1670: }
1671: }
1672:
1673: sub removeuploadedurl {
1674: my ($url)=@_;
1675: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1676: return &removeuserfile($uname,$udom,$fname);
1677: }
1678:
1679: sub removeuserfile {
1680: my ($docuname,$docudom,$fname)=@_;
1681: my $home=&homeserver($docuname,$docudom);
1682: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1683: if ($result eq 'ok') {
1684: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
1685: my $metafile = $fname.'.meta';
1686: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1687: }
1688: }
1689: return $result;
1690: }
1691:
1692: sub mkdiruserfile {
1693: my ($docuname,$docudom,$dir)=@_;
1694: my $home=&homeserver($docuname,$docudom);
1695: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1696: }
1697:
1698: sub renameuserfile {
1699: my ($docuname,$docudom,$old,$new)=@_;
1700: my $home=&homeserver($docuname,$docudom);
1701: my $result = &reply("renameuserfile:$docudom:$docuname:".
1702: &escape("$old").':'.&escape("$new"),$home);
1703: if ($result eq 'ok') {
1704: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
1705: my $oldmeta = $old.'.meta';
1706: my $newmeta = $new.'.meta';
1707: my $metaresult =
1708: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1709: }
1710: }
1711: return $result;
1712: }
1713:
1714: # ------------------------------------------------------------------------- Log
1715:
1716: sub log {
1717: my ($dom,$nam,$hom,$what)=@_;
1718: return critical("log:$dom:$nam:$what",$hom);
1719: }
1720:
1721: # ------------------------------------------------------------------ Course Log
1722: #
1723: # This routine flushes several buffers of non-mission-critical nature
1724: #
1725:
1726: sub flushcourselogs {
1727: &logthis('Flushing log buffers');
1728: #
1729: # course logs
1730: # This is a log of all transactions in a course, which can be used
1731: # for data mining purposes
1732: #
1733: # It also collects the courseid database, which lists last transaction
1734: # times and course titles for all courseids
1735: #
1736: my %courseidbuffer=();
1737: foreach my $crsid (keys %courselogs) {
1738: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1739: &escape($courselogs{$crsid}),
1740: $coursehombuf{$crsid}) eq 'ok') {
1741: delete $courselogs{$crsid};
1742: } else {
1743: &logthis('Failed to flush log buffer for '.$crsid);
1744: if (length($courselogs{$crsid})>40000) {
1745: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1746: " exceeded maximum size, deleting.</font>");
1747: delete $courselogs{$crsid};
1748: }
1749: }
1750: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1751: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1752: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1753: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1754: } else {
1755: $courseidbuffer{$coursehombuf{$crsid}}=
1756: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1757: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1758: }
1759: }
1760: #
1761: # Write course id database (reverse lookup) to homeserver of courses
1762: # Is used in pickcourse
1763: #
1764: foreach my $crsid (keys(%courseidbuffer)) {
1765: &courseidput($hostdom{$crsid},$courseidbuffer{$crsid},$crsid);
1766: }
1767: #
1768: # File accesses
1769: # Writes to the dynamic metadata of resources to get hit counts, etc.
1770: #
1771: foreach my $entry (keys(%accesshash)) {
1772: if ($entry =~ /___count$/) {
1773: my ($dom,$name);
1774: ($dom,$name,undef)=
1775: ($entry=~m{___($match_domain)/($match_username)/(.*)___count$});
1776: if (! defined($dom) || $dom eq '' ||
1777: ! defined($name) || $name eq '') {
1778: my $cid = $env{'request.course.id'};
1779: $dom = $env{'request.'.$cid.'.domain'};
1780: $name = $env{'request.'.$cid.'.num'};
1781: }
1782: my $value = $accesshash{$entry};
1783: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1784: my %temphash=($url => $value);
1785: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1786: if ($result eq 'ok') {
1787: delete $accesshash{$entry};
1788: } elsif ($result eq 'unknown_cmd') {
1789: # Target server has old code running on it.
1790: my %temphash=($entry => $value);
1791: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1792: delete $accesshash{$entry};
1793: }
1794: }
1795: } else {
1796: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_username)/(.*)___(\w+)$});
1797: my %temphash=($entry => $accesshash{$entry});
1798: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1799: delete $accesshash{$entry};
1800: }
1801: }
1802: }
1803: #
1804: # Roles
1805: # Reverse lookup of user roles for course faculty/staff and co-authorship
1806: #
1807: foreach my $entry (keys(%userrolehash)) {
1808: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1809: split(/\:/,$entry);
1810: if (&Apache::lonnet::put('nohist_userroles',
1811: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1812: $rudom,$runame) eq 'ok') {
1813: delete $userrolehash{$entry};
1814: }
1815: }
1816: #
1817: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1818: #
1819: my %domrolebuffer = ();
1820: foreach my $entry (keys %domainrolehash) {
1821: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1822: if ($domrolebuffer{$rudom}) {
1823: $domrolebuffer{$rudom}.='&'.&escape($entry).
1824: '='.&escape($domainrolehash{$entry});
1825: } else {
1826: $domrolebuffer{$rudom}.=&escape($entry).
1827: '='.&escape($domainrolehash{$entry});
1828: }
1829: delete $domainrolehash{$entry};
1830: }
1831: foreach my $dom (keys(%domrolebuffer)) {
1832: foreach my $tryserver (keys %libserv) {
1833: if ($hostdom{$tryserver} eq $dom) {
1834: unless (&reply('domroleput:'.$dom.':'.
1835: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1836: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1837: }
1838: }
1839: }
1840: }
1841: $dumpcount++;
1842: }
1843:
1844: sub courselog {
1845: my $what=shift;
1846: $what=time.':'.$what;
1847: unless ($env{'request.course.id'}) { return ''; }
1848: $coursedombuf{$env{'request.course.id'}}=
1849: $env{'course.'.$env{'request.course.id'}.'.domain'};
1850: $coursenumbuf{$env{'request.course.id'}}=
1851: $env{'course.'.$env{'request.course.id'}.'.num'};
1852: $coursehombuf{$env{'request.course.id'}}=
1853: $env{'course.'.$env{'request.course.id'}.'.home'};
1854: $coursedescrbuf{$env{'request.course.id'}}=
1855: $env{'course.'.$env{'request.course.id'}.'.description'};
1856: $courseinstcodebuf{$env{'request.course.id'}}=
1857: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1858: $courseownerbuf{$env{'request.course.id'}}=
1859: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1860: $coursetypebuf{$env{'request.course.id'}}=
1861: $env{'course.'.$env{'request.course.id'}.'.type'};
1862: if (defined $courselogs{$env{'request.course.id'}}) {
1863: $courselogs{$env{'request.course.id'}}.='&'.$what;
1864: } else {
1865: $courselogs{$env{'request.course.id'}}.=$what;
1866: }
1867: if (length($courselogs{$env{'request.course.id'}})>4048) {
1868: &flushcourselogs();
1869: }
1870: }
1871:
1872: sub courseacclog {
1873: my $fnsymb=shift;
1874: unless ($env{'request.course.id'}) { return ''; }
1875: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1876: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1877: $what.=':POST';
1878: # FIXME: Probably ought to escape things....
1879: foreach my $key (keys(%env)) {
1880: if ($key=~/^form\.(.*)/) {
1881: $what.=':'.$1.'='.$env{$key};
1882: }
1883: }
1884: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1885: # FIXME: We should not be depending on a form parameter that someone
1886: # editing lonsearchcat.pm might change in the future.
1887: if ($env{'form.phase'} eq 'course_search') {
1888: $what.= ':POST';
1889: # FIXME: Probably ought to escape things....
1890: foreach my $element ('courseexp','crsfulltext','crsrelated',
1891: 'crsdiscuss') {
1892: $what.=':'.$element.'='.$env{'form.'.$element};
1893: }
1894: }
1895: }
1896: &courselog($what);
1897: }
1898:
1899: sub countacc {
1900: my $url=&declutter(shift);
1901: return if (! defined($url) || $url eq '');
1902: unless ($env{'request.course.id'}) { return ''; }
1903: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1904: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1905: $accesshash{$key}++;
1906: }
1907:
1908: sub linklog {
1909: my ($from,$to)=@_;
1910: $from=&declutter($from);
1911: $to=&declutter($to);
1912: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1913: $accesshash{$to.'___'.$from.'___goto'}=1;
1914: }
1915:
1916: sub userrolelog {
1917: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1918: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1919: ($trole=~/^in/) || ($trole=~/^cc/) ||
1920: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1921: ($trole=~/^ta/)) {
1922: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1923: $userrolehash
1924: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1925: =$tend.':'.$tstart;
1926: }
1927: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1928: ($trole=~/^li/) || ($trole=~/^li/) ||
1929: ($trole=~/^au/) || ($trole=~/^dg/) ||
1930: ($trole=~/^sc/)) {
1931: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1932: $domainrolehash
1933: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1934: = $tend.':'.$tstart;
1935: }
1936: }
1937:
1938: sub get_course_adv_roles {
1939: my $cid=shift;
1940: $cid=$env{'request.course.id'} unless (defined($cid));
1941: my %coursehash=&coursedescription($cid);
1942: my %nothide=();
1943: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1944: $nothide{join(':',split(/[\@\:]/,$user))}=1;
1945: }
1946: my %returnhash=();
1947: my %dumphash=
1948: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1949: my $now=time;
1950: foreach my $entry (keys %dumphash) {
1951: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1952: if (($tstart) && ($tstart<0)) { next; }
1953: if (($tend) && ($tend<$now)) { next; }
1954: if (($tstart) && ($now<$tstart)) { next; }
1955: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1956: if ($username eq '' || $domain eq '') { next; }
1957: if ((&privileged($username,$domain)) &&
1958: (!$nothide{$username.':'.$domain})) { next; }
1959: if ($role eq 'cr') { next; }
1960: my $key=&plaintext($role);
1961: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1962: if ($returnhash{$key}) {
1963: $returnhash{$key}.=','.$username.':'.$domain;
1964: } else {
1965: $returnhash{$key}=$username.':'.$domain;
1966: }
1967: }
1968: return %returnhash;
1969: }
1970:
1971: sub get_my_roles {
1972: my ($uname,$udom)=@_;
1973: unless (defined($uname)) { $uname=$env{'user.name'}; }
1974: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1975: my %dumphash=
1976: &dump('nohist_userroles',$udom,$uname);
1977: my %returnhash=();
1978: my $now=time;
1979: foreach my $entry (keys(%dumphash)) {
1980: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1981: if (($tstart) && ($tstart<0)) { next; }
1982: if (($tend) && ($tend<$now)) { next; }
1983: if (($tstart) && ($now<$tstart)) { next; }
1984: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1985: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1986: }
1987: return %returnhash;
1988: }
1989:
1990: # ----------------------------------------------------- Frontpage Announcements
1991: #
1992: #
1993:
1994: sub postannounce {
1995: my ($server,$text)=@_;
1996: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1997: unless ($text=~/\w/) { $text=''; }
1998: return &reply('setannounce:'.&escape($text),$server);
1999: }
2000:
2001: sub getannounce {
2002:
2003: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
2004: my $announcement='';
2005: while (my $line = <$fh>) { $announcement .= $line; }
2006: close($fh);
2007: if ($announcement=~/\w/) {
2008: return
2009: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
2010: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
2011: } else {
2012: return '';
2013: }
2014: } else {
2015: return '';
2016: }
2017: }
2018:
2019: # ---------------------------------------------------------- Course ID routines
2020: # Deal with domain's nohist_courseid.db files
2021: #
2022:
2023: sub courseidput {
2024: my ($domain,$what,$coursehome)=@_;
2025: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
2026: }
2027:
2028: sub courseiddump {
2029: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
2030: my %returnhash=();
2031: unless ($domfilter) { $domfilter=''; }
2032: foreach my $tryserver (keys %libserv) {
2033: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
2034: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
2035: foreach my $line (
2036: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
2037: $sincefilter.':'.&escape($descfilter).':'.
2038: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter).':'.&escape($regexp_ok),
2039: $tryserver))) {
2040: my ($key,$value)=split(/\=/,$line,2);
2041: if (($key) && ($value)) {
2042: $returnhash{&unescape($key)}=$value;
2043: }
2044: }
2045: }
2046: }
2047: }
2048: return %returnhash;
2049: }
2050:
2051: # ---------------------------------------------------------- DC e-mail
2052:
2053: sub dcmailput {
2054: my ($domain,$msgid,$message,$server)=@_;
2055: my $status = &Apache::lonnet::critical(
2056: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2057: &escape($message),$server);
2058: return $status;
2059: }
2060:
2061: sub dcmaildump {
2062: my ($dom,$startdate,$enddate,$senders) = @_;
2063: my %returnhash=();
2064: if (exists($domain_primary{$dom})) {
2065: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2066: &escape($enddate).':';
2067: my @esc_senders=map { &escape($_)} @$senders;
2068: $cmd.=&escape(join('&',@esc_senders));
2069: foreach my $line (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
2070: my ($key,$value) = split(/\=/,$line,2);
2071: if (($key) && ($value)) {
2072: $returnhash{&unescape($key)} = &unescape($value);
2073: }
2074: }
2075: }
2076: return %returnhash;
2077: }
2078: # ---------------------------------------------------------- Domain roles
2079:
2080: sub get_domain_roles {
2081: my ($dom,$roles,$startdate,$enddate)=@_;
2082: if (undef($startdate) || $startdate eq '') {
2083: $startdate = '.';
2084: }
2085: if (undef($enddate) || $enddate eq '') {
2086: $enddate = '.';
2087: }
2088: my $rolelist = join(':',@{$roles});
2089: my %personnel = ();
2090: foreach my $tryserver (keys(%libserv)) {
2091: if ($hostdom{$tryserver} eq $dom) {
2092: %{$personnel{$tryserver}}=();
2093: foreach my $line (
2094: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2095: &escape($startdate).':'.&escape($enddate).':'.
2096: &escape($rolelist), $tryserver))) {
2097: my ($key,$value) = split(/\=/,$line,2);
2098: if (($key) && ($value)) {
2099: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2100: }
2101: }
2102: }
2103: }
2104: return %personnel;
2105: }
2106:
2107: # ----------------------------------------------------------- Check out an item
2108:
2109: sub get_first_access {
2110: my ($type,$argsymb)=@_;
2111: my ($symb,$courseid,$udom,$uname)=&whichuser();
2112: if ($argsymb) { $symb=$argsymb; }
2113: my ($map,$id,$res)=&decode_symb($symb);
2114: if ($type eq 'map') {
2115: $res=&symbread($map);
2116: } else {
2117: $res=$symb;
2118: }
2119: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2120: return $times{"$courseid\0$res"};
2121: }
2122:
2123: sub set_first_access {
2124: my ($type)=@_;
2125: my ($symb,$courseid,$udom,$uname)=&whichuser();
2126: my ($map,$id,$res)=&decode_symb($symb);
2127: if ($type eq 'map') {
2128: $res=&symbread($map);
2129: } else {
2130: $res=$symb;
2131: }
2132: my $firstaccess=&get_first_access($type,$symb);
2133: if (!$firstaccess) {
2134: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2135: }
2136: return 'already_set';
2137: }
2138:
2139: sub checkout {
2140: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2141: my $now=time;
2142: my $lonhost=$perlvar{'lonHostID'};
2143: my $infostr=&escape(
2144: 'CHECKOUTTOKEN&'.
2145: $tuname.'&'.
2146: $tudom.'&'.
2147: $tcrsid.'&'.
2148: $symb.'&'.
2149: $now.'&'.$ENV{'REMOTE_ADDR'});
2150: my $token=&reply('tmpput:'.$infostr,$lonhost);
2151: if ($token=~/^error\:/) {
2152: &logthis("<font color=\"blue\">WARNING: ".
2153: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2154: "</font>");
2155: return '';
2156: }
2157:
2158: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2159: $token=~tr/a-z/A-Z/;
2160:
2161: my %infohash=('resource.0.outtoken' => $token,
2162: 'resource.0.checkouttime' => $now,
2163: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2164:
2165: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2166: return '';
2167: } else {
2168: &logthis("<font color=\"blue\">WARNING: ".
2169: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2170: "</font>");
2171: }
2172:
2173: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2174: &escape('Checkout '.$infostr.' - '.
2175: $token)) ne 'ok') {
2176: return '';
2177: } else {
2178: &logthis("<font color=\"blue\">WARNING: ".
2179: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2180: "</font>");
2181: }
2182: return $token;
2183: }
2184:
2185: # ------------------------------------------------------------ Check in an item
2186:
2187: sub checkin {
2188: my $token=shift;
2189: my $now=time;
2190: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2191: $lonhost=~tr/A-Z/a-z/;
2192: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2193: $dtoken=~s/\W/\_/g;
2194: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2195: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2196:
2197: unless (($tuname) && ($tudom)) {
2198: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2199: return '';
2200: }
2201:
2202: unless (&allowed('mgr',$tcrsid)) {
2203: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2204: $env{'user.name'}.' - '.$env{'user.domain'});
2205: return '';
2206: }
2207:
2208: my %infohash=('resource.0.intoken' => $token,
2209: 'resource.0.checkintime' => $now,
2210: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2211:
2212: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2213: return '';
2214: }
2215:
2216: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2217: &escape('Checkin - '.$token)) ne 'ok') {
2218: return '';
2219: }
2220:
2221: return ($symb,$tuname,$tudom,$tcrsid);
2222: }
2223:
2224: # --------------------------------------------- Set Expire Date for Spreadsheet
2225:
2226: sub expirespread {
2227: my ($uname,$udom,$stype,$usymb)=@_;
2228: my $cid=$env{'request.course.id'};
2229: if ($cid) {
2230: my $now=time;
2231: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2232: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2233: $env{'course.'.$cid.'.num'}.
2234: ':nohist_expirationdates:'.
2235: &escape($key).'='.$now,
2236: $env{'course.'.$cid.'.home'})
2237: }
2238: return 'ok';
2239: }
2240:
2241: # ----------------------------------------------------- Devalidate Spreadsheets
2242:
2243: sub devalidate {
2244: my ($symb,$uname,$udom)=@_;
2245: my $cid=$env{'request.course.id'};
2246: if ($cid) {
2247: # delete the stored spreadsheets for
2248: # - the student level sheet of this user in course's homespace
2249: # - the assessment level sheet for this resource
2250: # for this user in user's homespace
2251: # - current conditional state info
2252: my $key=$uname.':'.$udom.':';
2253: my $status=
2254: &del('nohist_calculatedsheets',
2255: [$key.'studentcalc:'],
2256: $env{'course.'.$cid.'.domain'},
2257: $env{'course.'.$cid.'.num'})
2258: .' '.
2259: &del('nohist_calculatedsheets_'.$cid,
2260: [$key.'assesscalc:'.$symb],$udom,$uname);
2261: unless ($status eq 'ok ok') {
2262: &logthis('Could not devalidate spreadsheet '.
2263: $uname.' at '.$udom.' for '.
2264: $symb.': '.$status);
2265: }
2266: &delenv('user.state.'.$cid);
2267: }
2268: }
2269:
2270: sub get_scalar {
2271: my ($string,$end) = @_;
2272: my $value;
2273: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2274: $value = $1;
2275: } elsif ($$string =~ s/^([^&]*?)&//) {
2276: $value = $1;
2277: }
2278: return &unescape($value);
2279: }
2280:
2281: sub array2str {
2282: my (@array) = @_;
2283: my $result=&arrayref2str(\@array);
2284: $result=~s/^__ARRAY_REF__//;
2285: $result=~s/__END_ARRAY_REF__$//;
2286: return $result;
2287: }
2288:
2289: sub arrayref2str {
2290: my ($arrayref) = @_;
2291: my $result='__ARRAY_REF__';
2292: foreach my $elem (@$arrayref) {
2293: if(ref($elem) eq 'ARRAY') {
2294: $result.=&arrayref2str($elem).'&';
2295: } elsif(ref($elem) eq 'HASH') {
2296: $result.=&hashref2str($elem).'&';
2297: } elsif(ref($elem)) {
2298: #print("Got a ref of ".(ref($elem))." skipping.");
2299: } else {
2300: $result.=&escape($elem).'&';
2301: }
2302: }
2303: $result=~s/\&$//;
2304: $result .= '__END_ARRAY_REF__';
2305: return $result;
2306: }
2307:
2308: sub hash2str {
2309: my (%hash) = @_;
2310: my $result=&hashref2str(\%hash);
2311: $result=~s/^__HASH_REF__//;
2312: $result=~s/__END_HASH_REF__$//;
2313: return $result;
2314: }
2315:
2316: sub hashref2str {
2317: my ($hashref)=@_;
2318: my $result='__HASH_REF__';
2319: foreach my $key (sort(keys(%$hashref))) {
2320: if (ref($key) eq 'ARRAY') {
2321: $result.=&arrayref2str($key).'=';
2322: } elsif (ref($key) eq 'HASH') {
2323: $result.=&hashref2str($key).'=';
2324: } elsif (ref($key)) {
2325: $result.='=';
2326: #print("Got a ref of ".(ref($key))." skipping.");
2327: } else {
2328: if ($key) {$result.=&escape($key).'=';} else { last; }
2329: }
2330:
2331: if(ref($hashref->{$key}) eq 'ARRAY') {
2332: $result.=&arrayref2str($hashref->{$key}).'&';
2333: } elsif(ref($hashref->{$key}) eq 'HASH') {
2334: $result.=&hashref2str($hashref->{$key}).'&';
2335: } elsif(ref($hashref->{$key})) {
2336: $result.='&';
2337: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
2338: } else {
2339: $result.=&escape($hashref->{$key}).'&';
2340: }
2341: }
2342: $result=~s/\&$//;
2343: $result .= '__END_HASH_REF__';
2344: return $result;
2345: }
2346:
2347: sub str2hash {
2348: my ($string)=@_;
2349: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2350: return %$hash;
2351: }
2352:
2353: sub str2hashref {
2354: my ($string) = @_;
2355:
2356: my %hash;
2357:
2358: if($string !~ /^__HASH_REF__/) {
2359: if (! ($string eq '' || !defined($string))) {
2360: $hash{'error'}='Not hash reference';
2361: }
2362: return (\%hash, $string);
2363: }
2364:
2365: $string =~ s/^__HASH_REF__//;
2366:
2367: while($string !~ /^__END_HASH_REF__/) {
2368: #key
2369: my $key='';
2370: if($string =~ /^__HASH_REF__/) {
2371: ($key, $string)=&str2hashref($string);
2372: if(defined($key->{'error'})) {
2373: $hash{'error'}='Bad data';
2374: return (\%hash, $string);
2375: }
2376: } elsif($string =~ /^__ARRAY_REF__/) {
2377: ($key, $string)=&str2arrayref($string);
2378: if($key->[0] eq 'Array reference error') {
2379: $hash{'error'}='Bad data';
2380: return (\%hash, $string);
2381: }
2382: } else {
2383: $string =~ s/^(.*?)=//;
2384: $key=&unescape($1);
2385: }
2386: $string =~ s/^=//;
2387:
2388: #value
2389: my $value='';
2390: if($string =~ /^__HASH_REF__/) {
2391: ($value, $string)=&str2hashref($string);
2392: if(defined($value->{'error'})) {
2393: $hash{'error'}='Bad data';
2394: return (\%hash, $string);
2395: }
2396: } elsif($string =~ /^__ARRAY_REF__/) {
2397: ($value, $string)=&str2arrayref($string);
2398: if($value->[0] eq 'Array reference error') {
2399: $hash{'error'}='Bad data';
2400: return (\%hash, $string);
2401: }
2402: } else {
2403: $value=&get_scalar(\$string,'__END_HASH_REF__');
2404: }
2405: $string =~ s/^&//;
2406:
2407: $hash{$key}=$value;
2408: }
2409:
2410: $string =~ s/^__END_HASH_REF__//;
2411:
2412: return (\%hash, $string);
2413: }
2414:
2415: sub str2array {
2416: my ($string)=@_;
2417: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2418: return @$array;
2419: }
2420:
2421: sub str2arrayref {
2422: my ($string) = @_;
2423: my @array;
2424:
2425: if($string !~ /^__ARRAY_REF__/) {
2426: if (! ($string eq '' || !defined($string))) {
2427: $array[0]='Array reference error';
2428: }
2429: return (\@array, $string);
2430: }
2431:
2432: $string =~ s/^__ARRAY_REF__//;
2433:
2434: while($string !~ /^__END_ARRAY_REF__/) {
2435: my $value='';
2436: if($string =~ /^__HASH_REF__/) {
2437: ($value, $string)=&str2hashref($string);
2438: if(defined($value->{'error'})) {
2439: $array[0] ='Array reference error';
2440: return (\@array, $string);
2441: }
2442: } elsif($string =~ /^__ARRAY_REF__/) {
2443: ($value, $string)=&str2arrayref($string);
2444: if($value->[0] eq 'Array reference error') {
2445: $array[0] ='Array reference error';
2446: return (\@array, $string);
2447: }
2448: } else {
2449: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2450: }
2451: $string =~ s/^&//;
2452:
2453: push(@array, $value);
2454: }
2455:
2456: $string =~ s/^__END_ARRAY_REF__//;
2457:
2458: return (\@array, $string);
2459: }
2460:
2461: # -------------------------------------------------------------------Temp Store
2462:
2463: sub tmpreset {
2464: my ($symb,$namespace,$domain,$stuname) = @_;
2465: if (!$symb) {
2466: $symb=&symbread();
2467: if (!$symb) { $symb= $env{'request.url'}; }
2468: }
2469: $symb=escape($symb);
2470:
2471: if (!$namespace) { $namespace=$env{'request.state'}; }
2472: $namespace=~s/\//\_/g;
2473: $namespace=~s/\W//g;
2474:
2475: if (!$domain) { $domain=$env{'user.domain'}; }
2476: if (!$stuname) { $stuname=$env{'user.name'}; }
2477: if ($domain eq 'public' && $stuname eq 'public') {
2478: $stuname=$ENV{'REMOTE_ADDR'};
2479: }
2480: my $path=$perlvar{'lonDaemons'}.'/tmp';
2481: my %hash;
2482: if (tie(%hash,'GDBM_File',
2483: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2484: &GDBM_WRCREAT(),0640)) {
2485: foreach my $key (keys %hash) {
2486: if ($key=~ /:$symb/) {
2487: delete($hash{$key});
2488: }
2489: }
2490: }
2491: }
2492:
2493: sub tmpstore {
2494: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2495:
2496: if (!$symb) {
2497: $symb=&symbread();
2498: if (!$symb) { $symb= $env{'request.url'}; }
2499: }
2500: $symb=escape($symb);
2501:
2502: if (!$namespace) {
2503: # I don't think we would ever want to store this for a course.
2504: # it seems this will only be used if we don't have a course.
2505: #$namespace=$env{'request.course.id'};
2506: #if (!$namespace) {
2507: $namespace=$env{'request.state'};
2508: #}
2509: }
2510: $namespace=~s/\//\_/g;
2511: $namespace=~s/\W//g;
2512: if (!$domain) { $domain=$env{'user.domain'}; }
2513: if (!$stuname) { $stuname=$env{'user.name'}; }
2514: if ($domain eq 'public' && $stuname eq 'public') {
2515: $stuname=$ENV{'REMOTE_ADDR'};
2516: }
2517: my $now=time;
2518: my %hash;
2519: my $path=$perlvar{'lonDaemons'}.'/tmp';
2520: if (tie(%hash,'GDBM_File',
2521: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2522: &GDBM_WRCREAT(),0640)) {
2523: $hash{"version:$symb"}++;
2524: my $version=$hash{"version:$symb"};
2525: my $allkeys='';
2526: foreach my $key (keys(%$storehash)) {
2527: $allkeys.=$key.':';
2528: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2529: }
2530: $hash{"$version:$symb:timestamp"}=$now;
2531: $allkeys.='timestamp';
2532: $hash{"$version:keys:$symb"}=$allkeys;
2533: if (untie(%hash)) {
2534: return 'ok';
2535: } else {
2536: return "error:$!";
2537: }
2538: } else {
2539: return "error:$!";
2540: }
2541: }
2542:
2543: # -----------------------------------------------------------------Temp Restore
2544:
2545: sub tmprestore {
2546: my ($symb,$namespace,$domain,$stuname) = @_;
2547:
2548: if (!$symb) {
2549: $symb=&symbread();
2550: if (!$symb) { $symb= $env{'request.url'}; }
2551: }
2552: $symb=escape($symb);
2553:
2554: if (!$namespace) { $namespace=$env{'request.state'}; }
2555:
2556: if (!$domain) { $domain=$env{'user.domain'}; }
2557: if (!$stuname) { $stuname=$env{'user.name'}; }
2558: if ($domain eq 'public' && $stuname eq 'public') {
2559: $stuname=$ENV{'REMOTE_ADDR'};
2560: }
2561: my %returnhash;
2562: $namespace=~s/\//\_/g;
2563: $namespace=~s/\W//g;
2564: my %hash;
2565: my $path=$perlvar{'lonDaemons'}.'/tmp';
2566: if (tie(%hash,'GDBM_File',
2567: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2568: &GDBM_READER(),0640)) {
2569: my $version=$hash{"version:$symb"};
2570: $returnhash{'version'}=$version;
2571: my $scope;
2572: for ($scope=1;$scope<=$version;$scope++) {
2573: my $vkeys=$hash{"$scope:keys:$symb"};
2574: my @keys=split(/:/,$vkeys);
2575: my $key;
2576: $returnhash{"$scope:keys"}=$vkeys;
2577: foreach $key (@keys) {
2578: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2579: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2580: }
2581: }
2582: if (!(untie(%hash))) {
2583: return "error:$!";
2584: }
2585: } else {
2586: return "error:$!";
2587: }
2588: return %returnhash;
2589: }
2590:
2591: # ----------------------------------------------------------------------- Store
2592:
2593: sub store {
2594: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2595: my $home='';
2596:
2597: if ($stuname) { $home=&homeserver($stuname,$domain); }
2598:
2599: $symb=&symbclean($symb);
2600: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2601:
2602: if (!$domain) { $domain=$env{'user.domain'}; }
2603: if (!$stuname) { $stuname=$env{'user.name'}; }
2604:
2605: &devalidate($symb,$stuname,$domain);
2606:
2607: $symb=escape($symb);
2608: if (!$namespace) {
2609: unless ($namespace=$env{'request.course.id'}) {
2610: return '';
2611: }
2612: }
2613: if (!$home) { $home=$env{'user.home'}; }
2614:
2615: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2616: $$storehash{'host'}=$perlvar{'lonHostID'};
2617:
2618: my $namevalue='';
2619: foreach my $key (keys(%$storehash)) {
2620: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2621: }
2622: $namevalue=~s/\&$//;
2623: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2624: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2625: }
2626:
2627: # -------------------------------------------------------------- Critical Store
2628:
2629: sub cstore {
2630: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2631: my $home='';
2632:
2633: if ($stuname) { $home=&homeserver($stuname,$domain); }
2634:
2635: $symb=&symbclean($symb);
2636: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2637:
2638: if (!$domain) { $domain=$env{'user.domain'}; }
2639: if (!$stuname) { $stuname=$env{'user.name'}; }
2640:
2641: &devalidate($symb,$stuname,$domain);
2642:
2643: $symb=escape($symb);
2644: if (!$namespace) {
2645: unless ($namespace=$env{'request.course.id'}) {
2646: return '';
2647: }
2648: }
2649: if (!$home) { $home=$env{'user.home'}; }
2650:
2651: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2652: $$storehash{'host'}=$perlvar{'lonHostID'};
2653:
2654: my $namevalue='';
2655: foreach my $key (keys(%$storehash)) {
2656: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2657: }
2658: $namevalue=~s/\&$//;
2659: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2660: return critical
2661: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2662: }
2663:
2664: # --------------------------------------------------------------------- Restore
2665:
2666: sub restore {
2667: my ($symb,$namespace,$domain,$stuname) = @_;
2668: my $home='';
2669:
2670: if ($stuname) { $home=&homeserver($stuname,$domain); }
2671:
2672: if (!$symb) {
2673: unless ($symb=escape(&symbread())) { return ''; }
2674: } else {
2675: $symb=&escape(&symbclean($symb));
2676: }
2677: if (!$namespace) {
2678: unless ($namespace=$env{'request.course.id'}) {
2679: return '';
2680: }
2681: }
2682: if (!$domain) { $domain=$env{'user.domain'}; }
2683: if (!$stuname) { $stuname=$env{'user.name'}; }
2684: if (!$home) { $home=$env{'user.home'}; }
2685: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2686:
2687: my %returnhash=();
2688: foreach my $line (split(/\&/,$answer)) {
2689: my ($name,$value)=split(/\=/,$line);
2690: $returnhash{&unescape($name)}=&thaw_unescape($value);
2691: }
2692: my $version;
2693: for ($version=1;$version<=$returnhash{'version'};$version++) {
2694: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
2695: $returnhash{$item}=$returnhash{$version.':'.$item};
2696: }
2697: }
2698: return %returnhash;
2699: }
2700:
2701: # ---------------------------------------------------------- Course Description
2702:
2703: sub coursedescription {
2704: my ($courseid,$args)=@_;
2705: $courseid=~s/^\///;
2706: $courseid=~s/\_/\//g;
2707: my ($cdomain,$cnum)=split(/\//,$courseid);
2708: my $chome=&homeserver($cnum,$cdomain);
2709: my $normalid=$cdomain.'_'.$cnum;
2710: # need to always cache even if we get errors otherwise we keep
2711: # trying and trying and trying to get the course description.
2712: my %envhash=();
2713: my %returnhash=();
2714:
2715: my $expiretime=600;
2716: if ($env{'request.course.id'} eq $normalid) {
2717: $expiretime=120;
2718: }
2719:
2720: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2721: if (!$args->{'freshen_cache'}
2722: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2723: foreach my $key (keys(%env)) {
2724: next if ($key !~ /^\Q$prefix\E(.*)/);
2725: my ($setting) = $1;
2726: $returnhash{$setting} = $env{$key};
2727: }
2728: return %returnhash;
2729: }
2730:
2731: # get the data agin
2732: if (!$args->{'one_time'}) {
2733: $envhash{'course.'.$normalid.'.last_cache'}=time;
2734: }
2735: if ($chome ne 'no_host') {
2736: %returnhash=&dump('environment',$cdomain,$cnum);
2737: if (!exists($returnhash{'con_lost'})) {
2738: $returnhash{'home'}= $chome;
2739: $returnhash{'domain'} = $cdomain;
2740: $returnhash{'num'} = $cnum;
2741: if (!defined($returnhash{'type'})) {
2742: $returnhash{'type'} = 'Course';
2743: }
2744: while (my ($name,$value) = each %returnhash) {
2745: $envhash{'course.'.$normalid.'.'.$name}=$value;
2746: }
2747: $returnhash{'url'}=&clutter($returnhash{'url'});
2748: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2749: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2750: $envhash{'course.'.$normalid.'.home'}=$chome;
2751: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2752: $envhash{'course.'.$normalid.'.num'}=$cnum;
2753: }
2754: }
2755: if (!$args->{'one_time'}) {
2756: &appenv(%envhash);
2757: }
2758: return %returnhash;
2759: }
2760:
2761: # -------------------------------------------------See if a user is privileged
2762:
2763: sub privileged {
2764: my ($username,$domain)=@_;
2765: my $rolesdump=&reply("dump:$domain:$username:roles",
2766: &homeserver($username,$domain));
2767: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2768: my $now=time;
2769: if ($rolesdump ne '') {
2770: foreach my $entry (split(/&/,$rolesdump)) {
2771: if ($entry!~/^rolesdef_/) {
2772: my ($area,$role)=split(/=/,$entry);
2773: $area=~s/\_\w\w$//;
2774: my ($trole,$tend,$tstart)=split(/_/,$role);
2775: if (($trole eq 'dc') || ($trole eq 'su')) {
2776: my $active=1;
2777: if ($tend) {
2778: if ($tend<$now) { $active=0; }
2779: }
2780: if ($tstart) {
2781: if ($tstart>$now) { $active=0; }
2782: }
2783: if ($active) { return 1; }
2784: }
2785: }
2786: }
2787: }
2788: return 0;
2789: }
2790:
2791: # -------------------------------------------------------- Get user privileges
2792:
2793: sub rolesinit {
2794: my ($domain,$username,$authhost)=@_;
2795: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2796: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2797: my %allroles=();
2798: my %allgroups=();
2799: my $now=time;
2800: my %userroles = ('user.login.time' => $now);
2801: my $group_privs;
2802:
2803: if ($rolesdump ne '') {
2804: foreach my $entry (split(/&/,$rolesdump)) {
2805: if ($entry!~/^rolesdef_/) {
2806: my ($area,$role)=split(/=/,$entry);
2807: $area=~s/\_\w\w$//;
2808: my ($trole,$tend,$tstart,$group_privs);
2809: if ($role=~/^cr/) {
2810: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
2811: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
2812: ($tend,$tstart)=split('_',$trest);
2813: } else {
2814: $trole=$role;
2815: }
2816: } elsif ($role =~ m|^gr/|) {
2817: ($trole,$tend,$tstart) = split(/_/,$role);
2818: ($trole,$group_privs) = split(/\//,$trole);
2819: $group_privs = &unescape($group_privs);
2820: } else {
2821: ($trole,$tend,$tstart)=split(/_/,$role);
2822: }
2823: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2824: $username);
2825: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
2826: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2827: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2828: if (($area ne '') && ($trole ne '')) {
2829: my $spec=$trole.'.'.$area;
2830: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2831: if ($trole =~ /^cr\//) {
2832: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2833: } elsif ($trole eq 'gr') {
2834: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2835: } else {
2836: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2837: }
2838: }
2839: }
2840: }
2841: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2842: $userroles{'user.adv'} = $adv;
2843: $userroles{'user.author'} = $author;
2844: $env{'user.adv'}=$adv;
2845: }
2846: return \%userroles;
2847: }
2848:
2849: sub set_arearole {
2850: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2851: # log the associated role with the area
2852: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2853: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
2854: }
2855:
2856: sub custom_roleprivs {
2857: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2858: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2859: my $homsvr=homeserver($rauthor,$rdomain);
2860: if ($hostname{$homsvr} ne '') {
2861: my ($rdummy,$roledef)=
2862: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2863: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2864: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2865: if (defined($syspriv)) {
2866: $$allroles{'cm./'}.=':'.$syspriv;
2867: $$allroles{$spec.'./'}.=':'.$syspriv;
2868: }
2869: if ($tdomain ne '') {
2870: if (defined($dompriv)) {
2871: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2872: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2873: }
2874: if (($trest ne '') && (defined($coursepriv))) {
2875: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2876: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2877: }
2878: }
2879: }
2880: }
2881: }
2882:
2883: sub group_roleprivs {
2884: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2885: my $access = 1;
2886: my $now = time;
2887: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2888: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2889: if ($access) {
2890: my ($course,$group) = ($area =~ m|(/$match_domain/$match_username)/([^/]+)$|);
2891: $$allgroups{$course}{$group} .=':'.$group_privs;
2892: }
2893: }
2894:
2895: sub standard_roleprivs {
2896: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2897: if (defined($pr{$trole.':s'})) {
2898: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2899: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2900: }
2901: if ($tdomain ne '') {
2902: if (defined($pr{$trole.':d'})) {
2903: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2904: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2905: }
2906: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2907: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2908: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2909: }
2910: }
2911: }
2912:
2913: sub set_userprivs {
2914: my ($userroles,$allroles,$allgroups) = @_;
2915: my $author=0;
2916: my $adv=0;
2917: my %grouproles = ();
2918: if (keys(%{$allgroups}) > 0) {
2919: foreach my $role (keys %{$allroles}) {
2920: my ($trole,$area,$sec,$extendedarea);
2921: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_username)(/?\w*)-) {
2922: $trole = $1;
2923: $area = $2;
2924: $sec = $3;
2925: $extendedarea = $area.$sec;
2926: if (exists($$allgroups{$area})) {
2927: foreach my $group (keys(%{$$allgroups{$area}})) {
2928: my $spec = $trole.'.'.$extendedarea;
2929: $grouproles{$spec.'.'.$area.'/'.$group} =
2930: $$allgroups{$area}{$group};
2931: }
2932: }
2933: }
2934: }
2935: }
2936: foreach my $group (keys(%grouproles)) {
2937: $$allroles{$group} = $grouproles{$group};
2938: }
2939: foreach my $role (keys(%{$allroles})) {
2940: my %thesepriv;
2941: if (($role=~/^au/) || ($role=~/^ca/)) { $author=1; }
2942: foreach my $item (split(/:/,$$allroles{$role})) {
2943: if ($item ne '') {
2944: my ($privilege,$restrictions)=split(/&/,$item);
2945: if ($restrictions eq '') {
2946: $thesepriv{$privilege}='F';
2947: } elsif ($thesepriv{$privilege} ne 'F') {
2948: $thesepriv{$privilege}.=$restrictions;
2949: }
2950: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2951: }
2952: }
2953: my $thesestr='';
2954: foreach my $priv (keys(%thesepriv)) {
2955: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
2956: }
2957: $userroles->{'user.priv.'.$role} = $thesestr;
2958: }
2959: return ($author,$adv);
2960: }
2961:
2962: # --------------------------------------------------------------- get interface
2963:
2964: sub get {
2965: my ($namespace,$storearr,$udomain,$uname)=@_;
2966: my $items='';
2967: foreach my $item (@$storearr) {
2968: $items.=&escape($item).'&';
2969: }
2970: $items=~s/\&$//;
2971: if (!$udomain) { $udomain=$env{'user.domain'}; }
2972: if (!$uname) { $uname=$env{'user.name'}; }
2973: my $uhome=&homeserver($uname,$udomain);
2974:
2975: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2976: my @pairs=split(/\&/,$rep);
2977: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2978: return @pairs;
2979: }
2980: my %returnhash=();
2981: my $i=0;
2982: foreach my $item (@$storearr) {
2983: $returnhash{$item}=&thaw_unescape($pairs[$i]);
2984: $i++;
2985: }
2986: return %returnhash;
2987: }
2988:
2989: # --------------------------------------------------------------- del interface
2990:
2991: sub del {
2992: my ($namespace,$storearr,$udomain,$uname)=@_;
2993: my $items='';
2994: foreach my $item (@$storearr) {
2995: $items.=&escape($item).'&';
2996: }
2997: $items=~s/\&$//;
2998: if (!$udomain) { $udomain=$env{'user.domain'}; }
2999: if (!$uname) { $uname=$env{'user.name'}; }
3000: my $uhome=&homeserver($uname,$udomain);
3001:
3002: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
3003: }
3004:
3005: # -------------------------------------------------------------- dump interface
3006:
3007: sub dump {
3008: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3009: if (!$udomain) { $udomain=$env{'user.domain'}; }
3010: if (!$uname) { $uname=$env{'user.name'}; }
3011: my $uhome=&homeserver($uname,$udomain);
3012: if ($regexp) {
3013: $regexp=&escape($regexp);
3014: } else {
3015: $regexp='.';
3016: }
3017: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
3018: my @pairs=split(/\&/,$rep);
3019: my %returnhash=();
3020: foreach my $item (@pairs) {
3021: my ($key,$value)=split(/=/,$item,2);
3022: $key = &unescape($key);
3023: next if ($key =~ /^error: 2 /);
3024: $returnhash{$key}=&thaw_unescape($value);
3025: }
3026: return %returnhash;
3027: }
3028:
3029: # --------------------------------------------------------- dumpstore interface
3030:
3031: sub dumpstore {
3032: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
3033: return &dump($namespace,$udomain,$uname,$regexp,$range);
3034: }
3035:
3036: # -------------------------------------------------------------- keys interface
3037:
3038: sub getkeys {
3039: my ($namespace,$udomain,$uname)=@_;
3040: if (!$udomain) { $udomain=$env{'user.domain'}; }
3041: if (!$uname) { $uname=$env{'user.name'}; }
3042: my $uhome=&homeserver($uname,$udomain);
3043: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3044: my @keyarray=();
3045: foreach my $key (split(/\&/,$rep)) {
3046: push(@keyarray,&unescape($key));
3047: }
3048: return @keyarray;
3049: }
3050:
3051: # --------------------------------------------------------------- currentdump
3052: sub currentdump {
3053: my ($courseid,$sdom,$sname)=@_;
3054: $courseid = $env{'request.course.id'} if (! defined($courseid));
3055: $sdom = $env{'user.domain'} if (! defined($sdom));
3056: $sname = $env{'user.name'} if (! defined($sname));
3057: my $uhome = &homeserver($sname,$sdom);
3058: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3059: return if ($rep =~ /^(error:|no_such_host)/);
3060: #
3061: my %returnhash=();
3062: #
3063: if ($rep eq "unknown_cmd") {
3064: # an old lond will not know currentdump
3065: # Do a dump and make it look like a currentdump
3066: my @tmp = &dump($courseid,$sdom,$sname,'.');
3067: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3068: my %hash = @tmp;
3069: @tmp=();
3070: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3071: } else {
3072: my @pairs=split(/\&/,$rep);
3073: foreach my $pair (@pairs) {
3074: my ($key,$value)=split(/=/,$pair,2);
3075: my ($symb,$param) = split(/:/,$key);
3076: $returnhash{&unescape($symb)}->{&unescape($param)} =
3077: &thaw_unescape($value);
3078: }
3079: }
3080: return %returnhash;
3081: }
3082:
3083: sub convert_dump_to_currentdump{
3084: my %hash = %{shift()};
3085: my %returnhash;
3086: # Code ripped from lond, essentially. The only difference
3087: # here is the unescaping done by lonnet::dump(). Conceivably
3088: # we might run in to problems with parameter names =~ /^v\./
3089: while (my ($key,$value) = each(%hash)) {
3090: my ($v,$symb,$param) = split(/:/,$key);
3091: next if ($v eq 'version' || $symb eq 'keys');
3092: next if (exists($returnhash{$symb}) &&
3093: exists($returnhash{$symb}->{$param}) &&
3094: $returnhash{$symb}->{'v.'.$param} > $v);
3095: $returnhash{$symb}->{$param}=$value;
3096: $returnhash{$symb}->{'v.'.$param}=$v;
3097: }
3098: #
3099: # Remove all of the keys in the hashes which keep track of
3100: # the version of the parameter.
3101: while (my ($symb,$param_hash) = each(%returnhash)) {
3102: # use a foreach because we are going to delete from the hash.
3103: foreach my $key (keys(%$param_hash)) {
3104: delete($param_hash->{$key}) if ($key =~ /^v\./);
3105: }
3106: }
3107: return \%returnhash;
3108: }
3109:
3110: # ------------------------------------------------------ critical inc interface
3111:
3112: sub cinc {
3113: return &inc(@_,'critical');
3114: }
3115:
3116: # --------------------------------------------------------------- inc interface
3117:
3118: sub inc {
3119: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3120: if (!$udomain) { $udomain=$env{'user.domain'}; }
3121: if (!$uname) { $uname=$env{'user.name'}; }
3122: my $uhome=&homeserver($uname,$udomain);
3123: my $items='';
3124: if (! ref($store)) {
3125: # got a single value, so use that instead
3126: $items = &escape($store).'=&';
3127: } elsif (ref($store) eq 'SCALAR') {
3128: $items = &escape($$store).'=&';
3129: } elsif (ref($store) eq 'ARRAY') {
3130: $items = join('=&',map {&escape($_);} @{$store});
3131: } elsif (ref($store) eq 'HASH') {
3132: while (my($key,$value) = each(%{$store})) {
3133: $items.= &escape($key).'='.&escape($value).'&';
3134: }
3135: }
3136: $items=~s/\&$//;
3137: if ($critical) {
3138: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3139: } else {
3140: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3141: }
3142: }
3143:
3144: # --------------------------------------------------------------- put interface
3145:
3146: sub put {
3147: my ($namespace,$storehash,$udomain,$uname)=@_;
3148: if (!$udomain) { $udomain=$env{'user.domain'}; }
3149: if (!$uname) { $uname=$env{'user.name'}; }
3150: my $uhome=&homeserver($uname,$udomain);
3151: my $items='';
3152: foreach my $item (keys(%$storehash)) {
3153: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3154: }
3155: $items=~s/\&$//;
3156: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3157: }
3158:
3159: # ------------------------------------------------------------ newput interface
3160:
3161: sub newput {
3162: my ($namespace,$storehash,$udomain,$uname)=@_;
3163: if (!$udomain) { $udomain=$env{'user.domain'}; }
3164: if (!$uname) { $uname=$env{'user.name'}; }
3165: my $uhome=&homeserver($uname,$udomain);
3166: my $items='';
3167: foreach my $key (keys(%$storehash)) {
3168: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3169: }
3170: $items=~s/\&$//;
3171: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3172: }
3173:
3174: # --------------------------------------------------------- putstore interface
3175:
3176: sub putstore {
3177: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3178: if (!$udomain) { $udomain=$env{'user.domain'}; }
3179: if (!$uname) { $uname=$env{'user.name'}; }
3180: my $uhome=&homeserver($uname,$udomain);
3181: my $items='';
3182: foreach my $key (keys(%$storehash)) {
3183: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3184: }
3185: $items=~s/\&$//;
3186: my $esc_symb=&escape($symb);
3187: my $esc_v=&escape($version);
3188: my $reply =
3189: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3190: $uhome);
3191: if ($reply eq 'unknown_cmd') {
3192: # gfall back to way things use to be done
3193: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3194: $uname);
3195: }
3196: return $reply;
3197: }
3198:
3199: sub old_putstore {
3200: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3201: if (!$udomain) { $udomain=$env{'user.domain'}; }
3202: if (!$uname) { $uname=$env{'user.name'}; }
3203: my $uhome=&homeserver($uname,$udomain);
3204: my %newstorehash;
3205: foreach my $item (keys(%$storehash)) {
3206: my $key = $version.':'.&escape($symb).':'.$item;
3207: $newstorehash{$key} = $storehash->{$item};
3208: }
3209: my $items='';
3210: my %allitems = ();
3211: foreach my $item (keys(%newstorehash)) {
3212: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3213: my $key = $1.':keys:'.$2;
3214: $allitems{$key} .= $3.':';
3215: }
3216: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
3217: }
3218: foreach my $item (keys(%allitems)) {
3219: $allitems{$item} =~ s/\:$//;
3220: $items.= $item.'='.$allitems{$item}.'&';
3221: }
3222: $items=~s/\&$//;
3223: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3224: }
3225:
3226: # ------------------------------------------------------ critical put interface
3227:
3228: sub cput {
3229: my ($namespace,$storehash,$udomain,$uname)=@_;
3230: if (!$udomain) { $udomain=$env{'user.domain'}; }
3231: if (!$uname) { $uname=$env{'user.name'}; }
3232: my $uhome=&homeserver($uname,$udomain);
3233: my $items='';
3234: foreach my $item (keys(%$storehash)) {
3235: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3236: }
3237: $items=~s/\&$//;
3238: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3239: }
3240:
3241: # -------------------------------------------------------------- eget interface
3242:
3243: sub eget {
3244: my ($namespace,$storearr,$udomain,$uname)=@_;
3245: my $items='';
3246: foreach my $item (@$storearr) {
3247: $items.=&escape($item).'&';
3248: }
3249: $items=~s/\&$//;
3250: if (!$udomain) { $udomain=$env{'user.domain'}; }
3251: if (!$uname) { $uname=$env{'user.name'}; }
3252: my $uhome=&homeserver($uname,$udomain);
3253: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3254: my @pairs=split(/\&/,$rep);
3255: my %returnhash=();
3256: my $i=0;
3257: foreach my $item (@$storearr) {
3258: $returnhash{$item}=&thaw_unescape($pairs[$i]);
3259: $i++;
3260: }
3261: return %returnhash;
3262: }
3263:
3264: # ------------------------------------------------------------ tmpput interface
3265: sub tmpput {
3266: my ($storehash,$server,$context)=@_;
3267: my $items='';
3268: foreach my $item (keys(%$storehash)) {
3269: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
3270: }
3271: $items=~s/\&$//;
3272: if (defined($context)) {
3273: $items .= ':'.&escape($context);
3274: }
3275: return &reply("tmpput:$items",$server);
3276: }
3277:
3278: # ------------------------------------------------------------ tmpget interface
3279: sub tmpget {
3280: my ($token,$server)=@_;
3281: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3282: my $rep=&reply("tmpget:$token",$server);
3283: my %returnhash;
3284: foreach my $item (split(/\&/,$rep)) {
3285: my ($key,$value)=split(/=/,$item);
3286: $returnhash{&unescape($key)}=&thaw_unescape($value);
3287: }
3288: return %returnhash;
3289: }
3290:
3291: # ------------------------------------------------------------ tmpget interface
3292: sub tmpdel {
3293: my ($token,$server)=@_;
3294: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3295: return &reply("tmpdel:$token",$server);
3296: }
3297:
3298: # -------------------------------------------------- portfolio access checking
3299:
3300: sub portfolio_access {
3301: my ($requrl) = @_;
3302: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3303: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3304: if ($result eq 'ok') {
3305: return 'F';
3306: } elsif ($result =~ /^[^:]+:guest_/) {
3307: return 'A';
3308: }
3309: return '';
3310: }
3311:
3312: sub get_portfolio_access {
3313: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3314:
3315: if (!ref($access_hash)) {
3316: my $current_perms = &get_portfile_permissions($udom,$unum);
3317: my %access_controls = &get_access_controls($current_perms,$group,
3318: $file_name);
3319: $access_hash = $access_controls{$file_name};
3320: }
3321:
3322: my ($public,$guest,@domains,@users,@courses,@groups);
3323: my $now = time;
3324: if (ref($access_hash) eq 'HASH') {
3325: foreach my $key (keys(%{$access_hash})) {
3326: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3327: if ($start > $now) {
3328: next;
3329: }
3330: if ($end && $end<$now) {
3331: next;
3332: }
3333: if ($scope eq 'public') {
3334: $public = $key;
3335: last;
3336: } elsif ($scope eq 'guest') {
3337: $guest = $key;
3338: } elsif ($scope eq 'domains') {
3339: push(@domains,$key);
3340: } elsif ($scope eq 'users') {
3341: push(@users,$key);
3342: } elsif ($scope eq 'course') {
3343: push(@courses,$key);
3344: } elsif ($scope eq 'group') {
3345: push(@groups,$key);
3346: }
3347: }
3348: if ($public) {
3349: return 'ok';
3350: }
3351: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3352: if ($guest) {
3353: return $guest;
3354: }
3355: } else {
3356: if (@domains > 0) {
3357: foreach my $domkey (@domains) {
3358: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3359: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3360: return 'ok';
3361: }
3362: }
3363: }
3364: }
3365: if (@users > 0) {
3366: foreach my $userkey (@users) {
3367: if (exists($access_hash->{$userkey}{'users'}{$env{'user.name'}.':'.$env{'user.domain'}})) {
3368: return 'ok';
3369: }
3370: }
3371: }
3372: my %roleshash;
3373: my @courses_and_groups = @courses;
3374: push(@courses_and_groups,@groups);
3375: if (@courses_and_groups > 0) {
3376: my (%allgroups,%allroles);
3377: my ($start,$end,$role,$sec,$group);
3378: foreach my $envkey (%env) {
3379: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_username)/?([^/]*)$-) {
3380: my $cid = $2.'_'.$3;
3381: if ($1 eq 'gr') {
3382: $group = $4;
3383: $allgroups{$cid}{$group} = $env{$envkey};
3384: } else {
3385: if ($4 eq '') {
3386: $sec = 'none';
3387: } else {
3388: $sec = $4;
3389: }
3390: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3391: }
3392: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_username)/?([^/]*)$-) {
3393: my $cid = $2.'_'.$3;
3394: if ($4 eq '') {
3395: $sec = 'none';
3396: } else {
3397: $sec = $4;
3398: }
3399: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3400: }
3401: }
3402: if (keys(%allroles) == 0) {
3403: return;
3404: }
3405: foreach my $key (@courses_and_groups) {
3406: my %content = %{$$access_hash{$key}};
3407: my $cnum = $content{'number'};
3408: my $cdom = $content{'domain'};
3409: my $cid = $cdom.'_'.$cnum;
3410: if (!exists($allroles{$cid})) {
3411: next;
3412: }
3413: foreach my $role_id (keys(%{$content{'roles'}})) {
3414: my @sections = @{$content{'roles'}{$role_id}{'section'}};
3415: my @groups = @{$content{'roles'}{$role_id}{'group'}};
3416: my @status = @{$content{'roles'}{$role_id}{'access'}};
3417: my @roles = @{$content{'roles'}{$role_id}{'role'}};
3418: foreach my $role (keys(%{$allroles{$cid}})) {
3419: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
3420: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
3421: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
3422: if (grep/^all$/,@sections) {
3423: return 'ok';
3424: } else {
3425: if (grep/^$sec$/,@sections) {
3426: return 'ok';
3427: }
3428: }
3429: }
3430: }
3431: if (keys(%{$allgroups{$cid}}) == 0) {
3432: if (grep/^none$/,@groups) {
3433: return 'ok';
3434: }
3435: } else {
3436: if (grep/^all$/,@groups) {
3437: return 'ok';
3438: }
3439: foreach my $group (keys(%{$allgroups{$cid}})) {
3440: if (grep/^$group$/,@groups) {
3441: return 'ok';
3442: }
3443: }
3444: }
3445: }
3446: }
3447: }
3448: }
3449: }
3450: if ($guest) {
3451: return $guest;
3452: }
3453: }
3454: }
3455: return;
3456: }
3457:
3458: sub course_group_datechecker {
3459: my ($dates,$now,$status) = @_;
3460: my ($start,$end) = split(/\./,$dates);
3461: if (!$start && !$end) {
3462: return 'ok';
3463: }
3464: if (grep/^active$/,@{$status}) {
3465: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
3466: return 'ok';
3467: }
3468: }
3469: if (grep/^previous$/,@{$status}) {
3470: if ($end > $now ) {
3471: return 'ok';
3472: }
3473: }
3474: if (grep/^future$/,@{$status}) {
3475: if ($start > $now) {
3476: return 'ok';
3477: }
3478: }
3479: return;
3480: }
3481:
3482: sub parse_portfolio_url {
3483: my ($url) = @_;
3484:
3485: my ($type,$udom,$unum,$group,$file_name);
3486:
3487: if ($url =~ m-^/*uploaded/($match_domain)/($match_username)/portfolio(/.+)$-) {
3488: $type = 1;
3489: $udom = $1;
3490: $unum = $2;
3491: $file_name = $3;
3492: } elsif ($url =~ m-^/*uploaded/($match_domain)/($match_username)/groups/([^/]+)/portfolio/(.+)$-) {
3493: $type = 2;
3494: $udom = $1;
3495: $unum = $2;
3496: $group = $3;
3497: $file_name = $3.'/'.$4;
3498: }
3499: if (wantarray) {
3500: return ($type,$udom,$unum,$file_name,$group);
3501: }
3502: return $type;
3503: }
3504:
3505: sub is_portfolio_url {
3506: my ($url) = @_;
3507: return scalar(&parse_portfolio_url($url));
3508: }
3509:
3510: sub is_portfolio_file {
3511: my ($file) = @_;
3512: if (($file =~ /^portfolio/) || ($file =~ /^groups\/$match_username\/portfolio/)) {
3513: return 1;
3514: }
3515: return;
3516: }
3517:
3518:
3519: # ---------------------------------------------- Custom access rule evaluation
3520:
3521: sub customaccess {
3522: my ($priv,$uri)=@_;
3523: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
3524: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
3525: $udom = &LONCAPA::clean_domain($udom);
3526: $ucrs = &LONCAPA::clean_username($ucrs);
3527: my $access=0;
3528: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3529: my ($effect,$realm,$role)=split(/\:/,$right);
3530: if ($role) {
3531: if ($role ne $urole) { next; }
3532: }
3533: foreach my $scope (split(/\s*\,\s*/,$realm)) {
3534: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
3535: if ($tdom) {
3536: if ($tdom ne $udom) { next; }
3537: }
3538: if ($tcrs) {
3539: if ($tcrs ne $ucrs) { next; }
3540: }
3541: if ($tsec) {
3542: if ($tsec ne $usec) { next; }
3543: }
3544: $access=($effect eq 'allow');
3545: last;
3546: }
3547: if ($realm eq '' && $role eq '') {
3548: $access=($effect eq 'allow');
3549: }
3550: }
3551: return $access;
3552: }
3553:
3554: # ------------------------------------------------- Check for a user privilege
3555:
3556: sub allowed {
3557: my ($priv,$uri,$symb)=@_;
3558: my $ver_orguri=$uri;
3559: $uri=&deversion($uri);
3560: my $orguri=$uri;
3561: $uri=&declutter($uri);
3562:
3563: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3564: # Free bre access to adm and meta resources
3565: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
3566: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
3567: && ($priv eq 'bre')) {
3568: return 'F';
3569: }
3570:
3571: # Free bre access to user's own portfolio contents
3572: my ($space,$domain,$name,@dir)=split('/',$uri);
3573: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3574: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3575: return 'F';
3576: }
3577:
3578: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
3579: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3580: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3581: if (exists($env{'request.course.id'})) {
3582: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3583: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3584: if (($domain eq $cdom) && ($name eq $cnum)) {
3585: my $courseprivid=$env{'request.course.id'};
3586: $courseprivid=~s/\_/\//;
3587: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3588: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3589: return $1;
3590: } else {
3591: if ($env{'request.course.sec'}) {
3592: $courseprivid.='/'.$env{'request.course.sec'};
3593: }
3594: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3595: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3596: return $2;
3597: }
3598: }
3599: }
3600: }
3601: }
3602:
3603: # Free bre to public access
3604:
3605: if ($priv eq 'bre') {
3606: my $copyright=&metadata($uri,'copyright');
3607: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3608: return 'F';
3609: }
3610: if ($copyright eq 'priv') {
3611: $uri=~/([^\/]+)\/([^\/]+)\//;
3612: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3613: return '';
3614: }
3615: }
3616: if ($copyright eq 'domain') {
3617: $uri=~/([^\/]+)\/([^\/]+)\//;
3618: unless (($env{'user.domain'} eq $1) ||
3619: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3620: return '';
3621: }
3622: }
3623: if ($env{'request.role'}=~ /li\.\//) {
3624: # Library role, so allow browsing of resources in this domain.
3625: return 'F';
3626: }
3627: if ($copyright eq 'custom') {
3628: unless (&customaccess($priv,$uri)) { return ''; }
3629: }
3630: }
3631: # Domain coordinator is trying to create a course
3632: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3633: # uri is the requested domain in this case.
3634: # comparison to 'request.role.domain' shows if the user has selected
3635: # a role of dc for the domain in question.
3636: return 'F' if ($uri eq $env{'request.role.domain'});
3637: }
3638:
3639: my $thisallowed='';
3640: my $statecond=0;
3641: my $courseprivid='';
3642:
3643: # Course
3644:
3645: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3646: $thisallowed.=$1;
3647: }
3648:
3649: # Domain
3650:
3651: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3652: =~/\Q$priv\E\&([^\:]*)/) {
3653: $thisallowed.=$1;
3654: }
3655:
3656: # Course: uri itself is a course
3657: my $courseuri=$uri;
3658: $courseuri=~s/\_(\d)/\/$1/;
3659: $courseuri=~s/^([^\/])/\/$1/;
3660:
3661: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3662: =~/\Q$priv\E\&([^\:]*)/) {
3663: $thisallowed.=$1;
3664: }
3665:
3666: # URI is an uploaded document for this course, default permissions don't matter
3667: # not allowing 'edit' access (editupload) to uploaded course docs
3668: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3669: $thisallowed='';
3670: my ($match)=&is_on_map($uri);
3671: if ($match) {
3672: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3673: =~/\Q$priv\E\&([^\:]*)/) {
3674: $thisallowed.=$1;
3675: }
3676: } else {
3677: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3678: if ($refuri) {
3679: if ($refuri =~ m|^/adm/|) {
3680: $thisallowed='F';
3681: } else {
3682: $refuri=&declutter($refuri);
3683: my ($match) = &is_on_map($refuri);
3684: if ($match) {
3685: $thisallowed='F';
3686: }
3687: }
3688: }
3689: }
3690: }
3691:
3692: if ($priv eq 'bre'
3693: && $thisallowed ne 'F'
3694: && $thisallowed ne '2'
3695: && &is_portfolio_url($uri)) {
3696: $thisallowed = &portfolio_access($uri);
3697: }
3698:
3699: # Full access at system, domain or course-wide level? Exit.
3700:
3701: if ($thisallowed=~/F/) {
3702: return 'F';
3703: }
3704:
3705: # If this is generating or modifying users, exit with special codes
3706:
3707: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3708: if (($priv eq 'cca') || ($priv eq 'caa')) {
3709: my ($audom,$auname)=split('/',$uri);
3710: # no author name given, so this just checks on the general right to make a co-author in this domain
3711: unless ($auname) { return $thisallowed; }
3712: # an author name is given, so we are about to actually make a co-author for a certain account
3713: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3714: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3715: ($audom ne $env{'request.role.domain'}))) { return ''; }
3716: }
3717: return $thisallowed;
3718: }
3719: #
3720: # Gathered so far: system, domain and course wide privileges
3721: #
3722: # Course: See if uri or referer is an individual resource that is part of
3723: # the course
3724:
3725: if ($env{'request.course.id'}) {
3726:
3727: $courseprivid=$env{'request.course.id'};
3728: if ($env{'request.course.sec'}) {
3729: $courseprivid.='/'.$env{'request.course.sec'};
3730: }
3731: $courseprivid=~s/\_/\//;
3732: my $checkreferer=1;
3733: my ($match,$cond)=&is_on_map($uri);
3734: if ($match) {
3735: $statecond=$cond;
3736: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3737: =~/\Q$priv\E\&([^\:]*)/) {
3738: $thisallowed.=$1;
3739: $checkreferer=0;
3740: }
3741: }
3742:
3743: if ($checkreferer) {
3744: my $refuri=$env{'httpref.'.$orguri};
3745: unless ($refuri) {
3746: foreach my $key (keys(%env)) {
3747: if ($key=~/^httpref\..*\*/) {
3748: my $pattern=$key;
3749: $pattern=~s/^httpref\.\/res\///;
3750: $pattern=~s/\*/\[\^\/\]\+/g;
3751: $pattern=~s/\//\\\//g;
3752: if ($orguri=~/$pattern/) {
3753: $refuri=$env{$key};
3754: }
3755: }
3756: }
3757: }
3758:
3759: if ($refuri) {
3760: $refuri=&declutter($refuri);
3761: my ($match,$cond)=&is_on_map($refuri);
3762: if ($match) {
3763: my $refstatecond=$cond;
3764: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3765: =~/\Q$priv\E\&([^\:]*)/) {
3766: $thisallowed.=$1;
3767: $uri=$refuri;
3768: $statecond=$refstatecond;
3769: }
3770: }
3771: }
3772: }
3773: }
3774:
3775: #
3776: # Gathered now: all privileges that could apply, and condition number
3777: #
3778: #
3779: # Full or no access?
3780: #
3781:
3782: if ($thisallowed=~/F/) {
3783: return 'F';
3784: }
3785:
3786: unless ($thisallowed) {
3787: return '';
3788: }
3789:
3790: # Restrictions exist, deal with them
3791: #
3792: # C:according to course preferences
3793: # R:according to resource settings
3794: # L:unless locked
3795: # X:according to user session state
3796: #
3797:
3798: # Possibly locked functionality, check all courses
3799: # Locks might take effect only after 10 minutes cache expiration for other
3800: # courses, and 2 minutes for current course
3801:
3802: my $envkey;
3803: if ($thisallowed=~/L/) {
3804: foreach $envkey (keys %env) {
3805: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3806: my $courseid=$2;
3807: my $roleid=$1.'.'.$2;
3808: $courseid=~s/^\///;
3809: my $expiretime=600;
3810: if ($env{'request.role'} eq $roleid) {
3811: $expiretime=120;
3812: }
3813: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3814: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3815: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3816: &coursedescription($courseid,{'freshen_cache' => 1});
3817: }
3818: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3819: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3820: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3821: &log($env{'user.domain'},$env{'user.name'},
3822: $env{'user.home'},
3823: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3824: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3825: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3826: return '';
3827: }
3828: }
3829: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3830: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3831: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3832: &log($env{'user.domain'},$env{'user.name'},
3833: $env{'user.home'},
3834: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3835: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3836: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3837: return '';
3838: }
3839: }
3840: }
3841: }
3842: }
3843:
3844: #
3845: # Rest of the restrictions depend on selected course
3846: #
3847:
3848: unless ($env{'request.course.id'}) {
3849: if ($thisallowed eq 'A') {
3850: return 'A';
3851: } else {
3852: return '1';
3853: }
3854: }
3855:
3856: #
3857: # Now user is definitely in a course
3858: #
3859:
3860:
3861: # Course preferences
3862:
3863: if ($thisallowed=~/C/) {
3864: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3865: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3866: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3867: =~/\Q$rolecode\E/) {
3868: if ($priv ne 'pch') {
3869: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3870: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3871: $env{'request.course.id'});
3872: }
3873: return '';
3874: }
3875:
3876: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3877: =~/\Q$unamedom\E/) {
3878: if ($priv ne 'pch') {
3879: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3880: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3881: $env{'request.course.id'});
3882: }
3883: return '';
3884: }
3885: }
3886:
3887: # Resource preferences
3888:
3889: if ($thisallowed=~/R/) {
3890: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3891: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3892: if ($priv ne 'pch') {
3893: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3894: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3895: }
3896: return '';
3897: }
3898: }
3899:
3900: # Restricted by state or randomout?
3901:
3902: if ($thisallowed=~/X/) {
3903: if ($env{'acc.randomout'}) {
3904: if (!$symb) { $symb=&symbread($uri,1); }
3905: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3906: return '';
3907: }
3908: }
3909: if (&condval($statecond)) {
3910: return '2';
3911: } else {
3912: return '';
3913: }
3914: }
3915:
3916: if ($thisallowed eq 'A') {
3917: return 'A';
3918: }
3919: return 'F';
3920: }
3921:
3922: sub split_uri_for_cond {
3923: my $uri=&deversion(&declutter(shift));
3924: my @uriparts=split(/\//,$uri);
3925: my $filename=pop(@uriparts);
3926: my $pathname=join('/',@uriparts);
3927: return ($pathname,$filename);
3928: }
3929: # --------------------------------------------------- Is a resource on the map?
3930:
3931: sub is_on_map {
3932: my ($pathname,$filename) = &split_uri_for_cond(shift);
3933: #Trying to find the conditional for the file
3934: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3935: /\&\Q$filename\E\:([\d\|]+)\&/);
3936: if ($match) {
3937: return (1,$1);
3938: } else {
3939: return (0,0);
3940: }
3941: }
3942:
3943: # --------------------------------------------------------- Get symb from alias
3944:
3945: sub get_symb_from_alias {
3946: my $symb=shift;
3947: my ($map,$resid,$url)=&decode_symb($symb);
3948: # Already is a symb
3949: if ($url) { return $symb; }
3950: # Must be an alias
3951: my $aliassymb='';
3952: my %bighash;
3953: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3954: &GDBM_READER(),0640)) {
3955: my $rid=$bighash{'mapalias_'.$symb};
3956: if ($rid) {
3957: my ($mapid,$resid)=split(/\./,$rid);
3958: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3959: $resid,$bighash{'src_'.$rid});
3960: }
3961: untie %bighash;
3962: }
3963: return $aliassymb;
3964: }
3965:
3966: # ----------------------------------------------------------------- Define Role
3967:
3968: sub definerole {
3969: if (allowed('mcr','/')) {
3970: my ($rolename,$sysrole,$domrole,$courole)=@_;
3971: foreach my $role (split(':',$sysrole)) {
3972: my ($crole,$cqual)=split(/\&/,$role);
3973: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3974: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3975: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3976: return "refused:s:$crole&$cqual";
3977: }
3978: }
3979: }
3980: foreach my $role (split(':',$domrole)) {
3981: my ($crole,$cqual)=split(/\&/,$role);
3982: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3983: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3984: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3985: return "refused:d:$crole&$cqual";
3986: }
3987: }
3988: }
3989: foreach my $role (split(':',$courole)) {
3990: my ($crole,$cqual)=split(/\&/,$role);
3991: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3992: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3993: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3994: return "refused:c:$crole&$cqual";
3995: }
3996: }
3997: }
3998: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3999: "$env{'user.domain'}:$env{'user.name'}:".
4000: "rolesdef_$rolename=".
4001: escape($sysrole.'_'.$domrole.'_'.$courole);
4002: return reply($command,$env{'user.home'});
4003: } else {
4004: return 'refused';
4005: }
4006: }
4007:
4008: # ---------------- Make a metadata query against the network of library servers
4009:
4010: sub metadata_query {
4011: my ($query,$custom,$customshow,$server_array)=@_;
4012: my %rhash;
4013: my @server_list = (defined($server_array) ? @$server_array
4014: : keys(%libserv) );
4015: for my $server (@server_list) {
4016: unless ($custom or $customshow) {
4017: my $reply=&reply("querysend:".&escape($query),$server);
4018: $rhash{$server}=$reply;
4019: }
4020: else {
4021: my $reply=&reply("querysend:".&escape($query).':'.
4022: &escape($custom).':'.&escape($customshow),
4023: $server);
4024: $rhash{$server}=$reply;
4025: }
4026: }
4027: return \%rhash;
4028: }
4029:
4030: # ----------------------------------------- Send log queries and wait for reply
4031:
4032: sub log_query {
4033: my ($uname,$udom,$query,%filters)=@_;
4034: my $uhome=&homeserver($uname,$udom);
4035: if ($uhome eq 'no_host') { return 'error: no_host'; }
4036: my $uhost=$hostname{$uhome};
4037: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
4038: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
4039: $uhome);
4040: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
4041: return get_query_reply($queryid);
4042: }
4043:
4044: # ------- Request retrieval of institutional classlists for course(s)
4045:
4046: sub fetch_enrollment_query {
4047: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4048: my $homeserver;
4049: my $maxtries = 1;
4050: if ($context eq 'automated') {
4051: $homeserver = $perlvar{'lonHostID'};
4052: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4053: } else {
4054: $homeserver = &homeserver($cnum,$dom);
4055: }
4056: my $host=$hostname{$homeserver};
4057: my $cmd = '';
4058: foreach my $affiliate (keys %{$affiliatesref}) {
4059: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4060: }
4061: $cmd =~ s/%%$//;
4062: $cmd = &escape($cmd);
4063: my $query = 'fetchenrollment';
4064: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4065: unless ($queryid=~/^\Q$host\E\_/) {
4066: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4067: return 'error: '.$queryid;
4068: }
4069: my $reply = &get_query_reply($queryid);
4070: my $tries = 1;
4071: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4072: $reply = &get_query_reply($queryid);
4073: $tries ++;
4074: }
4075: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4076: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4077: } else {
4078: my @responses = split/:/,$reply;
4079: if ($homeserver eq $perlvar{'lonHostID'}) {
4080: foreach my $line (@responses) {
4081: my ($key,$value) = split(/=/,$line,2);
4082: $$replyref{$key} = $value;
4083: }
4084: } else {
4085: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4086: foreach my $line (@responses) {
4087: my ($key,$value) = split(/=/,$line);
4088: $$replyref{$key} = $value;
4089: if ($value > 0) {
4090: foreach my $item (@{$$affiliatesref{$key}}) {
4091: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
4092: my $destname = $pathname.'/'.$filename;
4093: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4094: if ($xml_classlist =~ /^error/) {
4095: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4096: } else {
4097: if ( open(FILE,">$destname") ) {
4098: print FILE &unescape($xml_classlist);
4099: close(FILE);
4100: } else {
4101: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4102: }
4103: }
4104: }
4105: }
4106: }
4107: }
4108: return 'ok';
4109: }
4110: return 'error';
4111: }
4112:
4113: sub get_query_reply {
4114: my $queryid=shift;
4115: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4116: my $reply='';
4117: for (1..100) {
4118: sleep 2;
4119: if (-e $replyfile.'.end') {
4120: if (open(my $fh,$replyfile)) {
4121: $reply.=<$fh>;
4122: close($fh);
4123: } else { return 'error: reply_file_error'; }
4124: return &unescape($reply);
4125: }
4126: }
4127: return 'timeout:'.$queryid;
4128: }
4129:
4130: sub courselog_query {
4131: #
4132: # possible filters:
4133: # url: url or symb
4134: # username
4135: # domain
4136: # action: view, submit, grade
4137: # start: timestamp
4138: # end: timestamp
4139: #
4140: my (%filters)=@_;
4141: unless ($env{'request.course.id'}) { return 'no_course'; }
4142: if ($filters{'url'}) {
4143: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4144: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4145: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4146: }
4147: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4148: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4149: return &log_query($cname,$cdom,'courselog',%filters);
4150: }
4151:
4152: sub userlog_query {
4153: my ($uname,$udom,%filters)=@_;
4154: return &log_query($uname,$udom,'userlog',%filters);
4155: }
4156:
4157: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4158:
4159: sub auto_run {
4160: my ($cnum,$cdom) = @_;
4161: my $homeserver = &homeserver($cnum,$cdom);
4162: my $response = &reply('autorun:'.$cdom,$homeserver);
4163: return $response;
4164: }
4165:
4166: sub auto_get_sections {
4167: my ($cnum,$cdom,$inst_coursecode) = @_;
4168: my $homeserver = &homeserver($cnum,$cdom);
4169: my @secs = ();
4170: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4171: unless ($response eq 'refused') {
4172: @secs = split/:/,$response;
4173: }
4174: return @secs;
4175: }
4176:
4177: sub auto_new_course {
4178: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4179: my $homeserver = &homeserver($cnum,$cdom);
4180: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4181: return $response;
4182: }
4183:
4184: sub auto_validate_courseID {
4185: my ($cnum,$cdom,$inst_course_id) = @_;
4186: my $homeserver = &homeserver($cnum,$cdom);
4187: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4188: return $response;
4189: }
4190:
4191: sub auto_create_password {
4192: my ($cnum,$cdom,$authparam) = @_;
4193: my $homeserver = &homeserver($cnum,$cdom);
4194: my $create_passwd = 0;
4195: my $authchk = '';
4196: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4197: if ($response eq 'refused') {
4198: $authchk = 'refused';
4199: } else {
4200: ($authparam,$create_passwd,$authchk) = split/:/,$response;
4201: }
4202: return ($authparam,$create_passwd,$authchk);
4203: }
4204:
4205: sub auto_photo_permission {
4206: my ($cnum,$cdom,$students) = @_;
4207: my $homeserver = &homeserver($cnum,$cdom);
4208: my ($outcome,$perm_reqd,$conditions) =
4209: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4210: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4211: return (undef,undef);
4212: }
4213: return ($outcome,$perm_reqd,$conditions);
4214: }
4215:
4216: sub auto_checkphotos {
4217: my ($uname,$udom,$pid) = @_;
4218: my $homeserver = &homeserver($uname,$udom);
4219: my ($result,$resulttype);
4220: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4221: &escape($uname).':'.&escape($pid),
4222: $homeserver));
4223: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4224: return (undef,undef);
4225: }
4226: if ($outcome) {
4227: ($result,$resulttype) = split(/:/,$outcome);
4228: }
4229: return ($result,$resulttype);
4230: }
4231:
4232: sub auto_photochoice {
4233: my ($cnum,$cdom) = @_;
4234: my $homeserver = &homeserver($cnum,$cdom);
4235: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4236: &escape($cdom),
4237: $homeserver)));
4238: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4239: return (undef,undef);
4240: }
4241: return ($update,$comment);
4242: }
4243:
4244: sub auto_photoupdate {
4245: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4246: my $homeserver = &homeserver($cnum,$dom);
4247: my $host=$hostname{$homeserver};
4248: my $cmd = '';
4249: my $maxtries = 1;
4250: foreach my $affiliate (keys(%{$affiliatesref})) {
4251: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
4252: }
4253: $cmd =~ s/%%$//;
4254: $cmd = &escape($cmd);
4255: my $query = 'institutionalphotos';
4256: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4257: unless ($queryid=~/^\Q$host\E\_/) {
4258: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4259: return 'error: '.$queryid;
4260: }
4261: my $reply = &get_query_reply($queryid);
4262: my $tries = 1;
4263: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4264: $reply = &get_query_reply($queryid);
4265: $tries ++;
4266: }
4267: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4268: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4269: } else {
4270: my @responses = split(/:/,$reply);
4271: my $outcome = shift(@responses);
4272: foreach my $item (@responses) {
4273: my ($key,$value) = split(/=/,$item);
4274: $$photo{$key} = $value;
4275: }
4276: return $outcome;
4277: }
4278: return 'error';
4279: }
4280:
4281: sub auto_instcode_format {
4282: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4283: $cat_order) = @_;
4284: my $courses = '';
4285: my @homeservers;
4286: if ($caller eq 'global') {
4287: foreach my $tryserver (keys(%libserv)) {
4288: if ($hostdom{$tryserver} eq $codedom) {
4289: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4290: push(@homeservers,$tryserver);
4291: }
4292: }
4293: }
4294: } else {
4295: push(@homeservers,&homeserver($caller,$codedom));
4296: }
4297: foreach my $code (keys(%{$instcodes})) {
4298: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
4299: }
4300: chop($courses);
4301: my $ok_response = 0;
4302: my $response;
4303: while (@homeservers > 0 && $ok_response == 0) {
4304: my $server = shift(@homeservers);
4305: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4306: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4307: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
4308: split/:/,$response;
4309: %{$codes} = (%{$codes},&str2hash($codes_str));
4310: push(@{$codetitles},&str2array($codetitles_str));
4311: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
4312: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
4313: $ok_response = 1;
4314: }
4315: }
4316: if ($ok_response) {
4317: return 'ok';
4318: } else {
4319: return $response;
4320: }
4321: }
4322:
4323: sub auto_instcode_defaults {
4324: my ($domain,$returnhash,$code_order) = @_;
4325: my @homeservers;
4326: foreach my $tryserver (keys(%libserv)) {
4327: if ($hostdom{$tryserver} eq $domain) {
4328: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4329: push(@homeservers,$tryserver);
4330: }
4331: }
4332: }
4333: my $ok_response = 0;
4334: my $response;
4335: while (@homeservers > 0 && $ok_response == 0) {
4336: my $server = shift(@homeservers);
4337: $response=&reply('autoinstcodedefaults:'.$domain,$server);
4338: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4339: foreach my $pair (split(/\&/,$response)) {
4340: my ($name,$value)=split(/\=/,$pair);
4341: if ($name eq 'code_order') {
4342: @{$code_order} = split(/\&/,&unescape($value));
4343: } else {
4344: $returnhash->{&unescape($name)}=&unescape($value);
4345: }
4346: }
4347: $ok_response = 1;
4348: }
4349: }
4350: if ($ok_response) {
4351: return 'ok';
4352: } else {
4353: return $response;
4354: }
4355: }
4356:
4357: sub auto_validate_class_sec {
4358: my ($cdom,$cnum,$owner,$inst_class) = @_;
4359: my $homeserver = &homeserver($cnum,$cdom);
4360: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
4361: &escape($owner).':'.$cdom,$homeserver);
4362: return $response;
4363: }
4364:
4365: # ------------------------------------------------------- Course Group routines
4366:
4367: sub get_coursegroups {
4368: my ($cdom,$cnum,$group,$namespace) = @_;
4369: return(&dump($namespace,$cdom,$cnum,$group));
4370: }
4371:
4372: sub modify_coursegroup {
4373: my ($cdom,$cnum,$groupsettings) = @_;
4374: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4375: }
4376:
4377: sub toggle_coursegroup_status {
4378: my ($cdom,$cnum,$group,$action) = @_;
4379: my ($from_namespace,$to_namespace);
4380: if ($action eq 'delete') {
4381: $from_namespace = 'coursegroups';
4382: $to_namespace = 'deleted_groups';
4383: } else {
4384: $from_namespace = 'deleted_groups';
4385: $to_namespace = 'coursegroups';
4386: }
4387: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
4388: if (my $tmp = &error(%curr_group)) {
4389: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
4390: return ('read error',$tmp);
4391: } else {
4392: my %savedsettings = %curr_group;
4393: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
4394: my $deloutcome;
4395: if ($result eq 'ok') {
4396: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
4397: } else {
4398: return ('write error',$result);
4399: }
4400: if ($deloutcome eq 'ok') {
4401: return 'ok';
4402: } else {
4403: return ('delete error',$deloutcome);
4404: }
4405: }
4406: }
4407:
4408: sub modify_group_roles {
4409: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4410: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4411: my $role = 'gr/'.&escape($userprivs);
4412: my ($uname,$udom) = split(/:/,$user);
4413: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4414: if ($result eq 'ok') {
4415: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4416: }
4417: return $result;
4418: }
4419:
4420: sub modify_coursegroup_membership {
4421: my ($cdom,$cnum,$membership) = @_;
4422: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4423: return $result;
4424: }
4425:
4426: sub get_active_groups {
4427: my ($udom,$uname,$cdom,$cnum) = @_;
4428: my $now = time;
4429: my %groups = ();
4430: foreach my $key (keys(%env)) {
4431: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_username)/(\w+)$-) {
4432: my ($start,$end) = split(/\./,$env{$key});
4433: if (($end!=0) && ($end<$now)) { next; }
4434: if (($start!=0) && ($start>$now)) { next; }
4435: if ($1 eq $cdom && $2 eq $cnum) {
4436: $groups{$3} = $env{$key} ;
4437: }
4438: }
4439: }
4440: return %groups;
4441: }
4442:
4443: sub get_group_membership {
4444: my ($cdom,$cnum,$group) = @_;
4445: return(&dump('groupmembership',$cdom,$cnum,$group));
4446: }
4447:
4448: sub get_users_groups {
4449: my ($udom,$uname,$courseid) = @_;
4450: my @usersgroups;
4451: my $cachetime=1800;
4452:
4453: my $hashid="$udom:$uname:$courseid";
4454: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4455: if (defined($cached)) {
4456: @usersgroups = split(/:/,$grouplist);
4457: } else {
4458: $grouplist = '';
4459: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4460: my ($tmp) = keys(%roleshash);
4461: if ($tmp=~/^error:/) {
4462: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4463: } else {
4464: my $access_end = $env{'course.'.$courseid.
4465: '.default_enrollment_end_date'};
4466: my $now = time;
4467: foreach my $key (keys(%roleshash)) {
4468: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4469: my $group = $1;
4470: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4471: my $start = $2;
4472: my $end = $1;
4473: if ($start == -1) { next; } # deleted from group
4474: if (($start!=0) && ($start>$now)) { next; }
4475: if (($end!=0) && ($end<$now)) {
4476: if ($access_end && $access_end < $now) {
4477: if ($access_end - $end < 86400) {
4478: push(@usersgroups,$group);
4479: }
4480: }
4481: next;
4482: }
4483: push(@usersgroups,$group);
4484: }
4485: }
4486: }
4487: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4488: $grouplist = join(':',@usersgroups);
4489: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4490: }
4491: }
4492: return @usersgroups;
4493: }
4494:
4495: sub devalidate_getgroups_cache {
4496: my ($udom,$uname,$cdom,$cnum)=@_;
4497: my $courseid = $cdom.'_'.$cnum;
4498:
4499: my $hashid="$udom:$uname:$courseid";
4500: &devalidate_cache_new('getgroups',$hashid);
4501: }
4502:
4503: # ------------------------------------------------------------------ Plain Text
4504:
4505: sub plaintext {
4506: my ($short,$type,$cid) = @_;
4507: if ($short =~ /^cr/) {
4508: return (split('/',$short))[-1];
4509: }
4510: if (!defined($cid)) {
4511: $cid = $env{'request.course.id'};
4512: }
4513: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4514: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4515: '.plaintext'});
4516: }
4517: my %rolenames = (
4518: Course => 'std',
4519: Group => 'alt1',
4520: );
4521: if (defined($type) &&
4522: defined($rolenames{$type}) &&
4523: defined($prp{$short}{$rolenames{$type}})) {
4524: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4525: } else {
4526: return &Apache::lonlocal::mt($prp{$short}{'std'});
4527: }
4528: }
4529:
4530: # ----------------------------------------------------------------- Assign Role
4531:
4532: sub assignrole {
4533: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4534: my $mrole;
4535: if ($role =~ /^cr\//) {
4536: my $cwosec=$url;
4537: $cwosec=~s/^\/($match_domain)\/($match_username)\/.*/$1\/$2/;
4538: unless (&allowed('ccr',$cwosec)) {
4539: &logthis('Refused custom assignrole: '.
4540: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4541: $env{'user.name'}.' at '.$env{'user.domain'});
4542: return 'refused';
4543: }
4544: $mrole='cr';
4545: } elsif ($role =~ /^gr\//) {
4546: my $cwogrp=$url;
4547: $cwogrp=~s{^/($match_domain)/($match_username)/.*}
4548: {$1/$2}x;
4549: unless (&allowed('mdg',$cwogrp)) {
4550: &logthis('Refused group assignrole: '.
4551: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4552: $env{'user.name'}.' at '.$env{'user.domain'});
4553: return 'refused';
4554: }
4555: $mrole='gr';
4556: } else {
4557: my $cwosec=$url;
4558: $cwosec=~s/^\/($match_domain)\/($match_username)\/.*/$1\/$2/;
4559: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4560: &logthis('Refused assignrole: '.
4561: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4562: $env{'user.name'}.' at '.$env{'user.domain'});
4563: return 'refused';
4564: }
4565: $mrole=$role;
4566: }
4567: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4568: "$udom:$uname:$url".'_'."$mrole=$role";
4569: if ($end) { $command.='_'.$end; }
4570: if ($start) {
4571: if ($end) {
4572: $command.='_'.$start;
4573: } else {
4574: $command.='_0_'.$start;
4575: }
4576: }
4577: my $origstart = $start;
4578: my $origend = $end;
4579: # actually delete
4580: if ($deleteflag) {
4581: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4582: # modify command to delete the role
4583: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4584: "$udom:$uname:$url".'_'."$mrole";
4585: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4586: # set start and finish to negative values for userrolelog
4587: $start=-1;
4588: $end=-1;
4589: }
4590: }
4591: # send command
4592: my $answer=&reply($command,&homeserver($uname,$udom));
4593: # log new user role if status is ok
4594: if ($answer eq 'ok') {
4595: &userrolelog($role,$uname,$udom,$url,$start,$end);
4596: # for course roles, perform group memberships changes triggered by role change.
4597: unless ($role =~ /^gr/) {
4598: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4599: $origstart);
4600: }
4601: }
4602: return $answer;
4603: }
4604:
4605: # -------------------------------------------------- Modify user authentication
4606: # Overrides without validation
4607:
4608: sub modifyuserauth {
4609: my ($udom,$uname,$umode,$upass)=@_;
4610: my $uhome=&homeserver($uname,$udom);
4611: unless (&allowed('mau',$udom)) { return 'refused'; }
4612: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4613: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4614: ' in domain '.$env{'request.role.domain'});
4615: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4616: &escape($upass),$uhome);
4617: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4618: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4619: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4620: &log($udom,,$uname,$uhome,
4621: 'Authentication changed by '.$env{'user.domain'}.', '.
4622: $env{'user.name'}.', '.$umode.
4623: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4624: unless ($reply eq 'ok') {
4625: &logthis('Authentication mode error: '.$reply);
4626: return 'error: '.$reply;
4627: }
4628: return 'ok';
4629: }
4630:
4631: # --------------------------------------------------------------- Modify a user
4632:
4633: sub modifyuser {
4634: my ($udom, $uname, $uid,
4635: $umode, $upass, $first,
4636: $middle, $last, $gene,
4637: $forceid, $desiredhome, $email)=@_;
4638: $udom= &LONCAPA::clean_domain($udom);
4639: $uname=&LONCAPA::clean_username($uname);
4640: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4641: $umode.', '.$first.', '.$middle.', '.
4642: $last.', '.$gene.'(forceid: '.$forceid.')'.
4643: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4644: ' desiredhome not specified').
4645: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4646: ' in domain '.$env{'request.role.domain'});
4647: my $uhome=&homeserver($uname,$udom,'true');
4648: # ----------------------------------------------------------------- Create User
4649: if (($uhome eq 'no_host') &&
4650: (($umode && $upass) || ($umode eq 'localauth'))) {
4651: my $unhome='';
4652: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4653: $unhome = $desiredhome;
4654: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4655: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4656: } else { # load balancing routine for determining $unhome
4657: my $tryserver;
4658: my $loadm=10000000;
4659: foreach $tryserver (keys %libserv) {
4660: if ($hostdom{$tryserver} eq $udom) {
4661: my $answer=reply('load',$tryserver);
4662: if (($answer=~/\d+/) && ($answer<$loadm)) {
4663: $loadm=$answer;
4664: $unhome=$tryserver;
4665: }
4666: }
4667: }
4668: }
4669: if (($unhome eq '') || ($unhome eq 'no_host')) {
4670: return 'error: unable to find a home server for '.$uname.
4671: ' in domain '.$udom;
4672: }
4673: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4674: &escape($upass),$unhome);
4675: unless ($reply eq 'ok') {
4676: return 'error: '.$reply;
4677: }
4678: $uhome=&homeserver($uname,$udom,'true');
4679: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4680: return 'error: unable verify users home machine.';
4681: }
4682: } # End of creation of new user
4683: # ---------------------------------------------------------------------- Add ID
4684: if ($uid) {
4685: $uid=~tr/A-Z/a-z/;
4686: my %uidhash=&idrget($udom,$uname);
4687: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4688: && (!$forceid)) {
4689: unless ($uid eq $uidhash{$uname}) {
4690: return 'error: user id "'.$uid.'" does not match '.
4691: 'current user id "'.$uidhash{$uname}.'".';
4692: }
4693: } else {
4694: &idput($udom,($uname => $uid));
4695: }
4696: }
4697: # -------------------------------------------------------------- Add names, etc
4698: my @tmp=&get('environment',
4699: ['firstname','middlename','lastname','generation'],
4700: $udom,$uname);
4701: my %names;
4702: if ($tmp[0] =~ m/^error:.*/) {
4703: %names=();
4704: } else {
4705: %names = @tmp;
4706: }
4707: #
4708: # Make sure to not trash student environment if instructor does not bother
4709: # to supply name and email information
4710: #
4711: if ($first) { $names{'firstname'} = $first; }
4712: if (defined($middle)) { $names{'middlename'} = $middle; }
4713: if ($last) { $names{'lastname'} = $last; }
4714: if (defined($gene)) { $names{'generation'} = $gene; }
4715: if ($email) {
4716: $email=~s/[^\w\@\.\-\,]//gs;
4717: if ($email=~/\@/) { $names{'notification'} = $email;
4718: $names{'critnotification'} = $email;
4719: $names{'permanentemail'} = $email; }
4720: }
4721: my $reply = &put('environment', \%names, $udom,$uname);
4722: if ($reply ne 'ok') { return 'error: '.$reply; }
4723: &devalidate_cache_new('namescache',$uname.':'.$udom);
4724: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4725: $umode.', '.$first.', '.$middle.', '.
4726: $last.', '.$gene.' by '.
4727: $env{'user.name'}.' at '.$env{'user.domain'});
4728: return 'ok';
4729: }
4730:
4731: # -------------------------------------------------------------- Modify student
4732:
4733: sub modifystudent {
4734: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4735: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4736: if (!$cid) {
4737: unless ($cid=$env{'request.course.id'}) {
4738: return 'not_in_class';
4739: }
4740: }
4741: # --------------------------------------------------------------- Make the user
4742: my $reply=&modifyuser
4743: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4744: $desiredhome,$email);
4745: unless ($reply eq 'ok') { return $reply; }
4746: # This will cause &modify_student_enrollment to get the uid from the
4747: # students environment
4748: $uid = undef if (!$forceid);
4749: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4750: $gene,$usec,$end,$start,$type,$locktype,$cid);
4751: return $reply;
4752: }
4753:
4754: sub modify_student_enrollment {
4755: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4756: my ($cdom,$cnum,$chome);
4757: if (!$cid) {
4758: unless ($cid=$env{'request.course.id'}) {
4759: return 'not_in_class';
4760: }
4761: $cdom=$env{'course.'.$cid.'.domain'};
4762: $cnum=$env{'course.'.$cid.'.num'};
4763: } else {
4764: ($cdom,$cnum)=split(/_/,$cid);
4765: }
4766: $chome=$env{'course.'.$cid.'.home'};
4767: if (!$chome) {
4768: $chome=&homeserver($cnum,$cdom);
4769: }
4770: if (!$chome) { return 'unknown_course'; }
4771: # Make sure the user exists
4772: my $uhome=&homeserver($uname,$udom);
4773: if (($uhome eq '') || ($uhome eq 'no_host')) {
4774: return 'error: no such user';
4775: }
4776: # Get student data if we were not given enough information
4777: if (!defined($first) || $first eq '' ||
4778: !defined($last) || $last eq '' ||
4779: !defined($uid) || $uid eq '' ||
4780: !defined($middle) || $middle eq '' ||
4781: !defined($gene) || $gene eq '') {
4782: # They did not supply us with enough data to enroll the student, so
4783: # we need to pick up more information.
4784: my %tmp = &get('environment',
4785: ['firstname','middlename','lastname', 'generation','id']
4786: ,$udom,$uname);
4787:
4788: #foreach my $key (keys(%tmp)) {
4789: # &logthis("key $key = ".$tmp{$key});
4790: #}
4791: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4792: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4793: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4794: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4795: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4796: }
4797: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4798: my $reply=cput('classlist',
4799: {"$uname:$udom" =>
4800: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4801: $cdom,$cnum);
4802: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4803: return 'error: '.$reply;
4804: } else {
4805: &devalidate_getsection_cache($udom,$uname,$cid);
4806: }
4807: # Add student role to user
4808: my $uurl='/'.$cid;
4809: $uurl=~s/\_/\//g;
4810: if ($usec) {
4811: $uurl.='/'.$usec;
4812: }
4813: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4814: }
4815:
4816: sub format_name {
4817: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4818: my $name;
4819: if ($first ne 'lastname') {
4820: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4821: } else {
4822: if ($lastname=~/\S/) {
4823: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4824: $name=~s/\s+,/,/;
4825: } else {
4826: $name.= $firstname.' '.$middlename.' '.$generation;
4827: }
4828: }
4829: $name=~s/^\s+//;
4830: $name=~s/\s+$//;
4831: $name=~s/\s+/ /g;
4832: return $name;
4833: }
4834:
4835: # ------------------------------------------------- Write to course preferences
4836:
4837: sub writecoursepref {
4838: my ($courseid,%prefs)=@_;
4839: $courseid=~s/^\///;
4840: $courseid=~s/\_/\//g;
4841: my ($cdomain,$cnum)=split(/\//,$courseid);
4842: my $chome=homeserver($cnum,$cdomain);
4843: if (($chome eq '') || ($chome eq 'no_host')) {
4844: return 'error: no such course';
4845: }
4846: my $cstring='';
4847: foreach my $pref (keys(%prefs)) {
4848: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
4849: }
4850: $cstring=~s/\&$//;
4851: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4852: }
4853:
4854: # ---------------------------------------------------------- Make/modify course
4855:
4856: sub createcourse {
4857: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4858: $course_owner,$crstype)=@_;
4859: $url=&declutter($url);
4860: my $cid='';
4861: unless (&allowed('ccc',$udom)) {
4862: return 'refused';
4863: }
4864: # ------------------------------------------------------------------- Create ID
4865: my $uname=int(1+rand(9)).
4866: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4867: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4868: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4869: # ----------------------------------------------- Make sure that does not exist
4870: my $uhome=&homeserver($uname,$udom,'true');
4871: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4872: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4873: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4874: $uhome=&homeserver($uname,$udom,'true');
4875: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4876: return 'error: unable to generate unique course-ID';
4877: }
4878: }
4879: # ------------------------------------------------ Check supplied server name
4880: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4881: if (! exists($libserv{$course_server})) {
4882: return 'error:bad server name '.$course_server;
4883: }
4884: # ------------------------------------------------------------- Make the course
4885: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4886: $course_server);
4887: unless ($reply eq 'ok') { return 'error: '.$reply; }
4888: $uhome=&homeserver($uname,$udom,'true');
4889: if (($uhome eq '') || ($uhome eq 'no_host')) {
4890: return 'error: no such course';
4891: }
4892: # ----------------------------------------------------------------- Course made
4893: # log existence
4894: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4895: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4896: &escape($crstype),$uhome);
4897: &flushcourselogs();
4898: # set toplevel url
4899: my $topurl=$url;
4900: unless ($nonstandard) {
4901: # ------------------------------------------ For standard courses, make top url
4902: my $mapurl=&clutter($url);
4903: if ($mapurl eq '/res/') { $mapurl=''; }
4904: $env{'form.initmap'}=(<<ENDINITMAP);
4905: <map>
4906: <resource id="1" type="start"></resource>
4907: <resource id="2" src="$mapurl"></resource>
4908: <resource id="3" type="finish"></resource>
4909: <link index="1" from="1" to="2"></link>
4910: <link index="2" from="2" to="3"></link>
4911: </map>
4912: ENDINITMAP
4913: $topurl=&declutter(
4914: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
4915: );
4916: }
4917: # ----------------------------------------------------------- Write preferences
4918: &writecoursepref($udom.'_'.$uname,
4919: ('description' => $description,
4920: 'url' => $topurl));
4921: return '/'.$udom.'/'.$uname;
4922: }
4923:
4924: # ---------------------------------------------------------- Assign Custom Role
4925:
4926: sub assigncustomrole {
4927: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
4928: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
4929: $end,$start,$deleteflag);
4930: }
4931:
4932: # ----------------------------------------------------------------- Revoke Role
4933:
4934: sub revokerole {
4935: my ($udom,$uname,$url,$role,$deleteflag)=@_;
4936: my $now=time;
4937: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
4938: }
4939:
4940: # ---------------------------------------------------------- Revoke Custom Role
4941:
4942: sub revokecustomrole {
4943: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
4944: my $now=time;
4945: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4946: $deleteflag);
4947: }
4948:
4949: # ------------------------------------------------------------ Disk usage
4950: sub diskusage {
4951: my ($udom,$uname,$directoryRoot)=@_;
4952: $directoryRoot =~ s/\/$//;
4953: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
4954: return $listing;
4955: }
4956:
4957: sub is_locked {
4958: my ($file_name, $domain, $user) = @_;
4959: my @check;
4960: my $is_locked;
4961: push @check, $file_name;
4962: my %locked = &get('file_permissions',\@check,
4963: $env{'user.domain'},$env{'user.name'});
4964: my ($tmp)=keys(%locked);
4965: if ($tmp=~/^error:/) { undef(%locked); }
4966:
4967: if (ref($locked{$file_name}) eq 'ARRAY') {
4968: $is_locked = 'false';
4969: foreach my $entry (@{$locked{$file_name}}) {
4970: if (ref($entry) eq 'ARRAY') {
4971: $is_locked = 'true';
4972: last;
4973: }
4974: }
4975: } else {
4976: $is_locked = 'false';
4977: }
4978: }
4979:
4980: sub declutter_portfile {
4981: my ($file) = @_;
4982: &logthis("got $file");
4983: $file =~ s-^(/portfolio/|portfolio/)-/-;
4984: &logthis("ret $file");
4985: return $file;
4986: }
4987:
4988: # ------------------------------------------------------------- Mark as Read Only
4989:
4990: sub mark_as_readonly {
4991: my ($domain,$user,$files,$what) = @_;
4992: my %current_permissions = &dump('file_permissions',$domain,$user);
4993: my ($tmp)=keys(%current_permissions);
4994: if ($tmp=~/^error:/) { undef(%current_permissions); }
4995: foreach my $file (@{$files}) {
4996: $file = &declutter_portfile($file);
4997: push(@{$current_permissions{$file}},$what);
4998: }
4999: &put('file_permissions',\%current_permissions,$domain,$user);
5000: return;
5001: }
5002:
5003: # ------------------------------------------------------------Save Selected Files
5004:
5005: sub save_selected_files {
5006: my ($user, $path, @files) = @_;
5007: my $filename = $user."savedfiles";
5008: my @other_files = &files_not_in_path($user, $path);
5009: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5010: foreach my $file (@files) {
5011: print (OUT $env{'form.currentpath'}.$file."\n");
5012: }
5013: foreach my $file (@other_files) {
5014: print (OUT $file."\n");
5015: }
5016: close (OUT);
5017: return 'ok';
5018: }
5019:
5020: sub clear_selected_files {
5021: my ($user) = @_;
5022: my $filename = $user."savedfiles";
5023: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5024: print (OUT undef);
5025: close (OUT);
5026: return ("ok");
5027: }
5028:
5029: sub files_in_path {
5030: my ($user, $path) = @_;
5031: my $filename = $user."savedfiles";
5032: my %return_files;
5033: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5034: while (my $line_in = <IN>) {
5035: chomp ($line_in);
5036: my @paths_and_file = split (m!/!, $line_in);
5037: my $file_part = pop (@paths_and_file);
5038: my $path_part = join ('/', @paths_and_file);
5039: $path_part.='/';
5040: my $path_and_file = $path_part.$file_part;
5041: if ($path_part eq $path) {
5042: $return_files{$file_part}= 'selected';
5043: }
5044: }
5045: close (IN);
5046: return (\%return_files);
5047: }
5048:
5049: # called in portfolio select mode, to show files selected NOT in current directory
5050: sub files_not_in_path {
5051: my ($user, $path) = @_;
5052: my $filename = $user."savedfiles";
5053: my @return_files;
5054: my $path_part;
5055: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
5056: while (my $line = <IN>) {
5057: #ok, I know it's clunky, but I want it to work
5058: my @paths_and_file = split(m|/|, $line);
5059: my $file_part = pop(@paths_and_file);
5060: chomp($file_part);
5061: my $path_part = join('/', @paths_and_file);
5062: $path_part .= '/';
5063: my $path_and_file = $path_part.$file_part;
5064: if ($path_part ne $path) {
5065: push(@return_files, ($path_and_file));
5066: }
5067: }
5068: close(OUT);
5069: return (@return_files);
5070: }
5071:
5072: #----------------------------------------------Get portfolio file permissions
5073:
5074: sub get_portfile_permissions {
5075: my ($domain,$user) = @_;
5076: my %current_permissions = &dump('file_permissions',$domain,$user);
5077: my ($tmp)=keys(%current_permissions);
5078: if ($tmp=~/^error:/) { undef(%current_permissions); }
5079: return \%current_permissions;
5080: }
5081:
5082: #---------------------------------------------Get portfolio file access controls
5083:
5084: sub get_access_controls {
5085: my ($current_permissions,$group,$file) = @_;
5086: my %access;
5087: my $real_file = $file;
5088: $file =~ s/\.meta$//;
5089: if (defined($file)) {
5090: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5091: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5092: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5093: }
5094: }
5095: } else {
5096: foreach my $key (keys(%{$current_permissions})) {
5097: if ($key =~ /\0accesscontrol$/) {
5098: if (defined($group)) {
5099: if ($key !~ m-^\Q$group\E/-) {
5100: next;
5101: }
5102: }
5103: my ($fullpath) = split(/\0/,$key);
5104: if (ref($$current_permissions{$key}) eq 'HASH') {
5105: foreach my $control (keys(%{$$current_permissions{$key}})) {
5106: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5107: }
5108: }
5109: }
5110: }
5111: }
5112: return %access;
5113: }
5114:
5115: sub modify_access_controls {
5116: my ($file_name,$changes,$domain,$user)=@_;
5117: my ($outcome,$deloutcome);
5118: my %store_permissions;
5119: my %new_values;
5120: my %new_control;
5121: my %translation;
5122: my @deletions = ();
5123: my $now = time;
5124: if (exists($$changes{'activate'})) {
5125: if (ref($$changes{'activate'}) eq 'HASH') {
5126: my @newitems = sort(keys(%{$$changes{'activate'}}));
5127: my $numnew = scalar(@newitems);
5128: for (my $i=0; $i<$numnew; $i++) {
5129: my $newkey = $newitems[$i];
5130: my $newid = &Apache::loncommon::get_cgi_id();
5131: if ($newkey =~ /^\d+:/) {
5132: $newkey =~ s/^(\d+)/$newid/;
5133: $translation{$1} = $newid;
5134: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5135: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5136: $translation{$1} = $newid;
5137: }
5138: $new_values{$file_name."\0".$newkey} =
5139: $$changes{'activate'}{$newitems[$i]};
5140: $new_control{$newkey} = $now;
5141: }
5142: }
5143: }
5144: my %todelete;
5145: my %changed_items;
5146: foreach my $action ('delete','update') {
5147: if (exists($$changes{$action})) {
5148: if (ref($$changes{$action}) eq 'HASH') {
5149: foreach my $key (keys(%{$$changes{$action}})) {
5150: my ($itemnum) = ($key =~ /^([^:]+):/);
5151: if ($action eq 'delete') {
5152: $todelete{$itemnum} = 1;
5153: } else {
5154: $changed_items{$itemnum} = $key;
5155: }
5156: }
5157: }
5158: }
5159: }
5160: # get lock on access controls for file.
5161: my $lockhash = {
5162: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5163: ':'.$env{'user.domain'},
5164: };
5165: my $tries = 0;
5166: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5167:
5168: while (($gotlock ne 'ok') && $tries <3) {
5169: $tries ++;
5170: sleep 1;
5171: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5172: }
5173: if ($gotlock eq 'ok') {
5174: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5175: my ($tmp)=keys(%curr_permissions);
5176: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5177: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5178: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5179: if (ref($curr_controls) eq 'HASH') {
5180: foreach my $control_item (keys(%{$curr_controls})) {
5181: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5182: if (defined($todelete{$itemnum})) {
5183: push(@deletions,$file_name."\0".$control_item);
5184: } else {
5185: if (defined($changed_items{$itemnum})) {
5186: $new_control{$changed_items{$itemnum}} = $now;
5187: push(@deletions,$file_name."\0".$control_item);
5188: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5189: } else {
5190: $new_control{$control_item} = $$curr_controls{$control_item};
5191: }
5192: }
5193: }
5194: }
5195: }
5196: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5197: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5198: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5199: # remove lock
5200: my @del_lock = ($file_name."\0".'locked_access_records');
5201: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5202: } else {
5203: $outcome = "error: could not obtain lockfile\n";
5204: }
5205: return ($outcome,$deloutcome,\%new_values,\%translation);
5206: }
5207:
5208: #------------------------------------------------------Get Marked as Read Only
5209:
5210: sub get_marked_as_readonly {
5211: my ($domain,$user,$what,$group) = @_;
5212: my $current_permissions = &get_portfile_permissions($domain,$user);
5213: my @readonly_files;
5214: my $cmp1=$what;
5215: if (ref($what)) { $cmp1=join('',@{$what}) };
5216: while (my ($file_name,$value) = each(%{$current_permissions})) {
5217: if (defined($group)) {
5218: if ($file_name !~ m-^\Q$group\E/-) {
5219: next;
5220: }
5221: }
5222: if (ref($value) eq "ARRAY"){
5223: foreach my $stored_what (@{$value}) {
5224: my $cmp2=$stored_what;
5225: if (ref($stored_what) eq 'ARRAY') {
5226: $cmp2=join('',@{$stored_what});
5227: }
5228: if ($cmp1 eq $cmp2) {
5229: push(@readonly_files, $file_name);
5230: last;
5231: } elsif (!defined($what)) {
5232: push(@readonly_files, $file_name);
5233: last;
5234: }
5235: }
5236: }
5237: }
5238: return @readonly_files;
5239: }
5240: #-----------------------------------------------------------Get Marked as Read Only Hash
5241:
5242: sub get_marked_as_readonly_hash {
5243: my ($current_permissions,$group,$what) = @_;
5244: my %readonly_files;
5245: while (my ($file_name,$value) = each(%{$current_permissions})) {
5246: if (defined($group)) {
5247: if ($file_name !~ m-^\Q$group\E/-) {
5248: next;
5249: }
5250: }
5251: if (ref($value) eq "ARRAY"){
5252: foreach my $stored_what (@{$value}) {
5253: if (ref($stored_what) eq 'ARRAY') {
5254: foreach my $lock_descriptor(@{$stored_what}) {
5255: if ($lock_descriptor eq 'graded') {
5256: $readonly_files{$file_name} = 'graded';
5257: } elsif ($lock_descriptor eq 'handback') {
5258: $readonly_files{$file_name} = 'handback';
5259: } else {
5260: if (!exists($readonly_files{$file_name})) {
5261: $readonly_files{$file_name} = 'locked';
5262: }
5263: }
5264: }
5265: }
5266: }
5267: }
5268: }
5269: return %readonly_files;
5270: }
5271: # ------------------------------------------------------------ Unmark as Read Only
5272:
5273: sub unmark_as_readonly {
5274: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5275: # for portfolio submissions, $what contains [$symb,$crsid]
5276: my ($domain,$user,$what,$file_name,$group) = @_;
5277: $file_name = &declutter_portfile($file_name);
5278: my $symb_crs = $what;
5279: if (ref($what)) { $symb_crs=join('',@$what); }
5280: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
5281: my ($tmp)=keys(%current_permissions);
5282: if ($tmp=~/^error:/) { undef(%current_permissions); }
5283: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
5284: foreach my $file (@readonly_files) {
5285: my $clean_file = &declutter_portfile($file);
5286: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
5287: my $current_locks = $current_permissions{$file};
5288: my @new_locks;
5289: my @del_keys;
5290: if (ref($current_locks) eq "ARRAY"){
5291: foreach my $locker (@{$current_locks}) {
5292: my $compare=$locker;
5293: if (ref($locker) eq 'ARRAY') {
5294: $compare=join('',@{$locker});
5295: if ($compare ne $symb_crs) {
5296: push(@new_locks, $locker);
5297: }
5298: }
5299: }
5300: if (scalar(@new_locks) > 0) {
5301: $current_permissions{$file} = \@new_locks;
5302: } else {
5303: push(@del_keys, $file);
5304: &del('file_permissions',\@del_keys, $domain, $user);
5305: delete($current_permissions{$file});
5306: }
5307: }
5308: }
5309: &put('file_permissions',\%current_permissions,$domain,$user);
5310: return;
5311: }
5312:
5313: # ------------------------------------------------------------ Directory lister
5314:
5315: sub dirlist {
5316: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5317:
5318: $uri=~s/^\///;
5319: $uri=~s/\/$//;
5320: my ($udom, $uname);
5321: (undef,$udom,$uname)=split(/\//,$uri);
5322: if(defined($userdomain)) {
5323: $udom = $userdomain;
5324: }
5325: if(defined($username)) {
5326: $uname = $username;
5327: }
5328:
5329: my $dirRoot = $perlvar{'lonDocRoot'};
5330: if(defined($alternateDirectoryRoot)) {
5331: $dirRoot = $alternateDirectoryRoot;
5332: $dirRoot =~ s/\/$//;
5333: }
5334:
5335: if($udom) {
5336: if($uname) {
5337: my $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
5338: &homeserver($uname,$udom));
5339: my @listing_results;
5340: if ($listing eq 'unknown_cmd') {
5341: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
5342: &homeserver($uname,$udom));
5343: @listing_results = split(/:/,$listing);
5344: } else {
5345: @listing_results = map { &unescape($_); } split(/:/,$listing);
5346: }
5347: return @listing_results;
5348: } elsif(!defined($alternateDirectoryRoot)) {
5349: my %allusers;
5350: foreach my $tryserver (keys(%libserv)) {
5351: if($hostdom{$tryserver} eq $udom) {
5352: my $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
5353: $udom, $tryserver);
5354: my @listing_results;
5355: if ($listing eq 'unknown_cmd') {
5356: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5357: $udom, $tryserver);
5358: @listing_results = split(/:/,$listing);
5359: } else {
5360: @listing_results =
5361: map { &unescape($_); } split(/:/,$listing);
5362: }
5363: if ($listing_results[0] ne 'no_such_dir' &&
5364: $listing_results[0] ne 'empty' &&
5365: $listing_results[0] ne 'con_lost') {
5366: foreach my $line (@listing_results) {
5367: my ($entry) = split(/&/,$line,2);
5368: $allusers{$entry} = 1;
5369: }
5370: }
5371: }
5372: }
5373: my $alluserstr='';
5374: foreach my $user (sort(keys(%allusers))) {
5375: $alluserstr.=$user.'&user:';
5376: }
5377: $alluserstr=~s/:$//;
5378: return split(/:/,$alluserstr);
5379: } else {
5380: return ('missing user name');
5381: }
5382: } elsif(!defined($alternateDirectoryRoot)) {
5383: my $tryserver;
5384: my %alldom=();
5385: foreach $tryserver (keys(%libserv)) {
5386: $alldom{$hostdom{$tryserver}}=1;
5387: }
5388: my $alldomstr='';
5389: foreach my $domain (sort(keys(%alldom))) {
5390: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain:';
5391: }
5392: $alldomstr=~s/:$//;
5393: return split(/:/,$alldomstr);
5394: } else {
5395: return ('missing domain');
5396: }
5397: }
5398:
5399: # --------------------------------------------- GetFileTimestamp
5400: # This function utilizes dirlist and returns the date stamp for
5401: # when it was last modified. It will also return an error of -1
5402: # if an error occurs
5403:
5404: ##
5405: ## FIXME: This subroutine assumes its caller knows something about the
5406: ## directory structure of the home server for the student ($root).
5407: ## Not a good assumption to make. Since this is for looking up files
5408: ## in user directories, the full path should be constructed by lond, not
5409: ## whatever machine we request data from.
5410: ##
5411: sub GetFileTimestamp {
5412: my ($studentDomain,$studentName,$filename,$root)=@_;
5413: $studentDomain = &LONCAPA::clean_domain($studentDomain);
5414: $studentName = &LONCAPA::clean_username($studentName);
5415: my $subdir=$studentName.'__';
5416: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5417: my $proname="$studentDomain/$subdir/$studentName";
5418: $proname .= '/'.$filename;
5419: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5420: $studentName, $root);
5421: my @stats = split('&', $fileStat);
5422: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5423: # @stats contains first the filename, then the stat output
5424: return $stats[10]; # so this is 10 instead of 9.
5425: } else {
5426: return -1;
5427: }
5428: }
5429:
5430: sub stat_file {
5431: my ($uri) = @_;
5432: $uri = &clutter_with_no_wrapper($uri);
5433:
5434: my ($udom,$uname,$file,$dir);
5435: if ($uri =~ m-^/(uploaded|editupload)/-) {
5436: ($udom,$uname,$file) =
5437: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_username)/?(.*)-);
5438: $file = 'userfiles/'.$file;
5439: $dir = &propath($udom,$uname);
5440: }
5441: if ($uri =~ m-^/res/-) {
5442: ($udom,$uname) =
5443: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
5444: $file = $uri;
5445: }
5446:
5447: if (!$udom || !$uname || !$file) {
5448: # unable to handle the uri
5449: return ();
5450: }
5451:
5452: my ($result) = &dirlist($file,$udom,$uname,$dir);
5453: my @stats = split('&', $result);
5454:
5455: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5456: shift(@stats); #filename is first
5457: return @stats;
5458: }
5459: return ();
5460: }
5461:
5462: # -------------------------------------------------------- Value of a Condition
5463:
5464: # gets the value of a specific preevaluated condition
5465: # stored in the string $env{user.state.<cid>}
5466: # or looks up a condition reference in the bighash and if if hasn't
5467: # already been evaluated recurses into docondval to get the value of
5468: # the condition, then memoizing it to
5469: # $env{user.state.<cid>.<condition>}
5470: sub directcondval {
5471: my $number=shift;
5472: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5473: &Apache::lonuserstate::evalstate();
5474: }
5475: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5476: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5477: } elsif ($number =~ /^_/) {
5478: my $sub_condition;
5479: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5480: &GDBM_READER(),0640)) {
5481: $sub_condition=$bighash{'conditions'.$number};
5482: untie(%bighash);
5483: }
5484: my $value = &docondval($sub_condition);
5485: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5486: return $value;
5487: }
5488: if ($env{'user.state.'.$env{'request.course.id'}}) {
5489: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5490: } else {
5491: return 2;
5492: }
5493: }
5494:
5495: # get the collection of conditions for this resource
5496: sub condval {
5497: my $condidx=shift;
5498: my $allpathcond='';
5499: foreach my $cond (split(/\|/,$condidx)) {
5500: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5501: $allpathcond.=
5502: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5503: }
5504: }
5505: $allpathcond=~s/\|$//;
5506: return &docondval($allpathcond);
5507: }
5508:
5509: #evaluates an expression of conditions
5510: sub docondval {
5511: my ($allpathcond) = @_;
5512: my $result=0;
5513: if ($env{'request.course.id'}
5514: && defined($allpathcond)) {
5515: my $operand='|';
5516: my @stack;
5517: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5518: if ($chunk eq '(') {
5519: push @stack,($operand,$result);
5520: } elsif ($chunk eq ')') {
5521: my $before=pop @stack;
5522: if (pop @stack eq '&') {
5523: $result=$result>$before?$before:$result;
5524: } else {
5525: $result=$result>$before?$result:$before;
5526: }
5527: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5528: $operand=$chunk;
5529: } else {
5530: my $new=directcondval($chunk);
5531: if ($operand eq '&') {
5532: $result=$result>$new?$new:$result;
5533: } else {
5534: $result=$result>$new?$result:$new;
5535: }
5536: }
5537: }
5538: }
5539: return $result;
5540: }
5541:
5542: # ---------------------------------------------------- Devalidate courseresdata
5543:
5544: sub devalidatecourseresdata {
5545: my ($coursenum,$coursedomain)=@_;
5546: my $hashid=$coursenum.':'.$coursedomain;
5547: &devalidate_cache_new('courseres',$hashid);
5548: }
5549:
5550:
5551: # --------------------------------------------------- Course Resourcedata Query
5552:
5553: sub get_courseresdata {
5554: my ($coursenum,$coursedomain)=@_;
5555: my $coursehom=&homeserver($coursenum,$coursedomain);
5556: my $hashid=$coursenum.':'.$coursedomain;
5557: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5558: my %dumpreply;
5559: unless (defined($cached)) {
5560: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5561: $result=\%dumpreply;
5562: my ($tmp) = keys(%dumpreply);
5563: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5564: &do_cache_new('courseres',$hashid,$result,600);
5565: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5566: return $tmp;
5567: } elsif ($tmp =~ /^(error)/) {
5568: $result=undef;
5569: &do_cache_new('courseres',$hashid,$result,600);
5570: }
5571: }
5572: return $result;
5573: }
5574:
5575: sub devalidateuserresdata {
5576: my ($uname,$udom)=@_;
5577: my $hashid="$udom:$uname";
5578: &devalidate_cache_new('userres',$hashid);
5579: }
5580:
5581: sub get_userresdata {
5582: my ($uname,$udom)=@_;
5583: #most student don\'t have any data set, check if there is some data
5584: if (&EXT_cache_status($udom,$uname)) { return undef; }
5585:
5586: my $hashid="$udom:$uname";
5587: my ($result,$cached)=&is_cached_new('userres',$hashid);
5588: if (!defined($cached)) {
5589: my %resourcedata=&dump('resourcedata',$udom,$uname);
5590: $result=\%resourcedata;
5591: &do_cache_new('userres',$hashid,$result,600);
5592: }
5593: my ($tmp)=keys(%$result);
5594: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5595: return $result;
5596: }
5597: #error 2 occurs when the .db doesn't exist
5598: if ($tmp!~/error: 2 /) {
5599: &logthis("<font color=\"blue\">WARNING:".
5600: " Trying to get resource data for ".
5601: $uname." at ".$udom.": ".
5602: $tmp."</font>");
5603: } elsif ($tmp=~/error: 2 /) {
5604: #&EXT_cache_set($udom,$uname);
5605: &do_cache_new('userres',$hashid,undef,600);
5606: undef($tmp); # not really an error so don't send it back
5607: }
5608: return $tmp;
5609: }
5610:
5611: sub resdata {
5612: my ($name,$domain,$type,@which)=@_;
5613: my $result;
5614: if ($type eq 'course') {
5615: $result=&get_courseresdata($name,$domain);
5616: } elsif ($type eq 'user') {
5617: $result=&get_userresdata($name,$domain);
5618: }
5619: if (!ref($result)) { return $result; }
5620: foreach my $item (@which) {
5621: if (defined($result->{$item})) {
5622: return $result->{$item};
5623: }
5624: }
5625: return undef;
5626: }
5627:
5628: #
5629: # EXT resource caching routines
5630: #
5631:
5632: sub clear_EXT_cache_status {
5633: &delenv('cache.EXT.');
5634: }
5635:
5636: sub EXT_cache_status {
5637: my ($target_domain,$target_user) = @_;
5638: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5639: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
5640: # We know already the user has no data
5641: return 1;
5642: } else {
5643: return 0;
5644: }
5645: }
5646:
5647: sub EXT_cache_set {
5648: my ($target_domain,$target_user) = @_;
5649: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5650: #&appenv($cachename => time);
5651: }
5652:
5653: # --------------------------------------------------------- Value of a Variable
5654: sub EXT {
5655:
5656: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
5657: unless ($varname) { return ''; }
5658: #get real user name/domain, courseid and symb
5659: my $courseid;
5660: my $publicuser;
5661: if ($symbparm) {
5662: $symbparm=&get_symb_from_alias($symbparm);
5663: }
5664: if (!($uname && $udom)) {
5665: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
5666: if (!$symbparm) { $symbparm=$cursymb; }
5667: } else {
5668: $courseid=$env{'request.course.id'};
5669: }
5670: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5671: my $rest;
5672: if (defined($therest[0])) {
5673: $rest=join('.',@therest);
5674: } else {
5675: $rest='';
5676: }
5677:
5678: my $qualifierrest=$qualifier;
5679: if ($rest) { $qualifierrest.='.'.$rest; }
5680: my $spacequalifierrest=$space;
5681: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
5682: if ($realm eq 'user') {
5683: # --------------------------------------------------------------- user.resource
5684: if ($space eq 'resource') {
5685: if ( (defined($Apache::lonhomework::parsing_a_problem)
5686: || defined($Apache::lonhomework::parsing_a_task))
5687: &&
5688: ($symbparm eq &symbread()) ) {
5689: # if we are in the middle of processing the resource the
5690: # get the value we are planning on committing
5691: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5692: return $Apache::lonhomework::results{$qualifierrest};
5693: } else {
5694: return $Apache::lonhomework::history{$qualifierrest};
5695: }
5696: } else {
5697: my %restored;
5698: if ($publicuser || $env{'request.state'} eq 'construct') {
5699: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5700: } else {
5701: %restored=&restore($symbparm,$courseid,$udom,$uname);
5702: }
5703: return $restored{$qualifierrest};
5704: }
5705: # ----------------------------------------------------------------- user.access
5706: } elsif ($space eq 'access') {
5707: # FIXME - not supporting calls for a specific user
5708: return &allowed($qualifier,$rest);
5709: # ------------------------------------------ user.preferences, user.environment
5710: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
5711: if (($uname eq $env{'user.name'}) &&
5712: ($udom eq $env{'user.domain'})) {
5713: return $env{join('.',('environment',$qualifierrest))};
5714: } else {
5715: my %returnhash;
5716: if (!$publicuser) {
5717: %returnhash=&userenvironment($udom,$uname,
5718: $qualifierrest);
5719: }
5720: return $returnhash{$qualifierrest};
5721: }
5722: # ----------------------------------------------------------------- user.course
5723: } elsif ($space eq 'course') {
5724: # FIXME - not supporting calls for a specific user
5725: return $env{join('.',('request.course',$qualifier))};
5726: # ------------------------------------------------------------------- user.role
5727: } elsif ($space eq 'role') {
5728: # FIXME - not supporting calls for a specific user
5729: my ($role,$where)=split(/\./,$env{'request.role'});
5730: if ($qualifier eq 'value') {
5731: return $role;
5732: } elsif ($qualifier eq 'extent') {
5733: return $where;
5734: }
5735: # ----------------------------------------------------------------- user.domain
5736: } elsif ($space eq 'domain') {
5737: return $udom;
5738: # ------------------------------------------------------------------- user.name
5739: } elsif ($space eq 'name') {
5740: return $uname;
5741: # ---------------------------------------------------- Any other user namespace
5742: } else {
5743: my %reply;
5744: if (!$publicuser) {
5745: %reply=&get($space,[$qualifierrest],$udom,$uname);
5746: }
5747: return $reply{$qualifierrest};
5748: }
5749: } elsif ($realm eq 'query') {
5750: # ---------------------------------------------- pull stuff out of query string
5751: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5752: [$spacequalifierrest]);
5753: return $env{'form.'.$spacequalifierrest};
5754: } elsif ($realm eq 'request') {
5755: # ------------------------------------------------------------- request.browser
5756: if ($space eq 'browser') {
5757: if ($qualifier eq 'textremote') {
5758: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5759: return 1;
5760: } else {
5761: return 0;
5762: }
5763: } else {
5764: return $env{'browser.'.$qualifier};
5765: }
5766: # ------------------------------------------------------------ request.filename
5767: } else {
5768: return $env{'request.'.$spacequalifierrest};
5769: }
5770: } elsif ($realm eq 'course') {
5771: # ---------------------------------------------------------- course.description
5772: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5773: } elsif ($realm eq 'resource') {
5774:
5775: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5776: if (!$symbparm) { $symbparm=&symbread(); }
5777: }
5778:
5779: if ($space eq 'title') {
5780: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5781: return &gettitle($symbparm);
5782: }
5783:
5784: if ($space eq 'map') {
5785: my ($map) = &decode_symb($symbparm);
5786: return &symbread($map);
5787: }
5788:
5789: my ($section, $group, @groups);
5790: my ($courselevelm,$courselevel);
5791: if ($symbparm && defined($courseid) &&
5792: $courseid eq $env{'request.course.id'}) {
5793:
5794: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5795:
5796: # ----------------------------------------------------- Cascading lookup scheme
5797: my $symbp=$symbparm;
5798: my $mapp=&deversion((&decode_symb($symbp))[0]);
5799:
5800: my $symbparm=$symbp.'.'.$spacequalifierrest;
5801: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5802:
5803: if (($env{'user.name'} eq $uname) &&
5804: ($env{'user.domain'} eq $udom)) {
5805: $section=$env{'request.course.sec'};
5806: @groups = split(/:/,$env{'request.course.groups'});
5807: @groups=&sort_course_groups($courseid,@groups);
5808: } else {
5809: if (! defined($usection)) {
5810: $section=&getsection($udom,$uname,$courseid);
5811: } else {
5812: $section = $usection;
5813: }
5814: @groups = &get_users_groups($udom,$uname,$courseid);
5815: }
5816:
5817: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5818: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5819: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5820:
5821: $courselevel=$courseid.'.'.$spacequalifierrest;
5822: my $courselevelr=$courseid.'.'.$symbparm;
5823: $courselevelm=$courseid.'.'.$mapparm;
5824:
5825: # ----------------------------------------------------------- first, check user
5826:
5827: my $userreply=&resdata($uname,$udom,'user',
5828: ($courselevelr,$courselevelm,
5829: $courselevel));
5830: if (defined($userreply)) { return $userreply; }
5831:
5832: # ------------------------------------------------ second, check some of course
5833: my $coursereply;
5834: if (@groups > 0) {
5835: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5836: $mapparm,$spacequalifierrest);
5837: if (defined($coursereply)) { return $coursereply; }
5838: }
5839:
5840: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5841: $env{'course.'.$courseid.'.domain'},
5842: 'course',
5843: ($seclevelr,$seclevelm,$seclevel,
5844: $courselevelr));
5845: if (defined($coursereply)) { return $coursereply; }
5846:
5847: # ------------------------------------------------------ third, check map parms
5848: my %parmhash=();
5849: my $thisparm='';
5850: if (tie(%parmhash,'GDBM_File',
5851: $env{'request.course.fn'}.'_parms.db',
5852: &GDBM_READER(),0640)) {
5853: $thisparm=$parmhash{$symbparm};
5854: untie(%parmhash);
5855: }
5856: if ($thisparm) { return $thisparm; }
5857: }
5858: # ------------------------------------------ fourth, look in resource metadata
5859:
5860: $spacequalifierrest=~s/\./\_/;
5861: my $filename;
5862: if (!$symbparm) { $symbparm=&symbread(); }
5863: if ($symbparm) {
5864: $filename=(&decode_symb($symbparm))[2];
5865: } else {
5866: $filename=$env{'request.filename'};
5867: }
5868: my $metadata=&metadata($filename,$spacequalifierrest);
5869: if (defined($metadata)) { return $metadata; }
5870: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
5871: if (defined($metadata)) { return $metadata; }
5872:
5873: # ---------------------------------------------- fourth, look in rest pf course
5874: if ($symbparm && defined($courseid) &&
5875: $courseid eq $env{'request.course.id'}) {
5876: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5877: $env{'course.'.$courseid.'.domain'},
5878: 'course',
5879: ($courselevelm,$courselevel));
5880: if (defined($coursereply)) { return $coursereply; }
5881: }
5882: # ------------------------------------------------------------------ Cascade up
5883: unless ($space eq '0') {
5884: my @parts=split(/_/,$space);
5885: my $id=pop(@parts);
5886: my $part=join('_',@parts);
5887: if ($part eq '') { $part='0'; }
5888: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
5889: $symbparm,$udom,$uname,$section,1);
5890: if (defined($partgeneral)) { return $partgeneral; }
5891: }
5892: if ($recurse) { return undef; }
5893: my $pack_def=&packages_tab_default($filename,$varname);
5894: if (defined($pack_def)) { return $pack_def; }
5895:
5896: # ---------------------------------------------------- Any other user namespace
5897: } elsif ($realm eq 'environment') {
5898: # ----------------------------------------------------------------- environment
5899: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5900: return $env{'environment.'.$spacequalifierrest};
5901: } else {
5902: if ($uname eq 'anonymous' && $udom eq '') {
5903: return '';
5904: }
5905: my %returnhash=&userenvironment($udom,$uname,
5906: $spacequalifierrest);
5907: return $returnhash{$spacequalifierrest};
5908: }
5909: } elsif ($realm eq 'system') {
5910: # ----------------------------------------------------------------- system.time
5911: if ($space eq 'time') {
5912: return time;
5913: }
5914: } elsif ($realm eq 'server') {
5915: # ----------------------------------------------------------------- system.time
5916: if ($space eq 'name') {
5917: return $ENV{'SERVER_NAME'};
5918: }
5919: }
5920: return '';
5921: }
5922:
5923: sub check_group_parms {
5924: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5925: my @groupitems = ();
5926: my $resultitem;
5927: my @levels = ($symbparm,$mapparm,$what);
5928: foreach my $group (@{$groups}) {
5929: foreach my $level (@levels) {
5930: my $item = $courseid.'.['.$group.'].'.$level;
5931: push(@groupitems,$item);
5932: }
5933: }
5934: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5935: $env{'course.'.$courseid.'.domain'},
5936: 'course',@groupitems);
5937: return $coursereply;
5938: }
5939:
5940: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
5941: my ($courseid,@groups) = @_;
5942: @groups = sort(@groups);
5943: return @groups;
5944: }
5945:
5946: sub packages_tab_default {
5947: my ($uri,$varname)=@_;
5948: my (undef,$part,$name)=split(/\./,$varname);
5949:
5950: my (@extension,@specifics,$do_default);
5951: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
5952: my ($pack_type,$pack_part)=split(/_/,$package,2);
5953: if ($pack_type eq 'default') {
5954: $do_default=1;
5955: } elsif ($pack_type eq 'extension') {
5956: push(@extension,[$package,$pack_type,$pack_part]);
5957: } else {
5958: push(@specifics,[$package,$pack_type,$pack_part]);
5959: }
5960: }
5961: # first look for a package that matches the requested part id
5962: foreach my $package (@specifics) {
5963: my (undef,$pack_type,$pack_part)=@{$package};
5964: next if ($pack_part ne $part);
5965: if (defined($packagetab{"$pack_type&$name&default"})) {
5966: return $packagetab{"$pack_type&$name&default"};
5967: }
5968: }
5969: # look for any possible matching non extension_ package
5970: foreach my $package (@specifics) {
5971: my (undef,$pack_type,$pack_part)=@{$package};
5972: if (defined($packagetab{"$pack_type&$name&default"})) {
5973: return $packagetab{"$pack_type&$name&default"};
5974: }
5975: if ($pack_type eq 'part') { $pack_part='0'; }
5976: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5977: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
5978: }
5979: }
5980: # look for any posible extension_ match
5981: foreach my $package (@extension) {
5982: my ($package,$pack_type)=@{$package};
5983: if (defined($packagetab{"$pack_type&$name&default"})) {
5984: return $packagetab{"$pack_type&$name&default"};
5985: }
5986: if (defined($packagetab{$package."&$name&default"})) {
5987: return $packagetab{$package."&$name&default"};
5988: }
5989: }
5990: # look for a global default setting
5991: if ($do_default && defined($packagetab{"default&$name&default"})) {
5992: return $packagetab{"default&$name&default"};
5993: }
5994: return undef;
5995: }
5996:
5997: sub add_prefix_and_part {
5998: my ($prefix,$part)=@_;
5999: my $keyroot;
6000: if (defined($prefix) && $prefix !~ /^__/) {
6001: # prefix that has a part already
6002: $keyroot=$prefix;
6003: } elsif (defined($prefix)) {
6004: # prefix that is missing a part
6005: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
6006: } else {
6007: # no prefix at all
6008: if (defined($part)) { $keyroot='_'.$part; }
6009: }
6010: return $keyroot;
6011: }
6012:
6013: # ---------------------------------------------------------------- Get metadata
6014:
6015: my %metaentry;
6016: sub metadata {
6017: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
6018: $uri=&declutter($uri);
6019: # if it is a non metadata possible uri return quickly
6020: if (($uri eq '') ||
6021: (($uri =~ m|^/*adm/|) &&
6022: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
6023: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
6024: ($uri =~ m|home/$match_username/public_html/|)) {
6025: return undef;
6026: }
6027: my $filename=$uri;
6028: $uri=~s/\.meta$//;
6029: #
6030: # Is the metadata already cached?
6031: # Look at timestamp of caching
6032: # Everything is cached by the main uri, libraries are never directly cached
6033: #
6034: if (!defined($liburi)) {
6035: my ($result,$cached)=&is_cached_new('meta',$uri);
6036: if (defined($cached)) { return $result->{':'.$what}; }
6037: }
6038: {
6039: #
6040: # Is this a recursive call for a library?
6041: #
6042: # if (! exists($metacache{$uri})) {
6043: # $metacache{$uri}={};
6044: # }
6045: if ($liburi) {
6046: $liburi=&declutter($liburi);
6047: $filename=$liburi;
6048: } else {
6049: &devalidate_cache_new('meta',$uri);
6050: undef(%metaentry);
6051: }
6052: my %metathesekeys=();
6053: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
6054: my $metastring;
6055: if ($uri !~ m -^(editupload)/-) {
6056: my $file=&filelocation('',&clutter($filename));
6057: #push(@{$metaentry{$uri.'.file'}},$file);
6058: $metastring=&getfile($file);
6059: }
6060: my $parser=HTML::LCParser->new(\$metastring);
6061: my $token;
6062: undef %metathesekeys;
6063: while ($token=$parser->get_token) {
6064: if ($token->[0] eq 'S') {
6065: if (defined($token->[2]->{'package'})) {
6066: #
6067: # This is a package - get package info
6068: #
6069: my $package=$token->[2]->{'package'};
6070: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6071: if (defined($token->[2]->{'id'})) {
6072: $keyroot.='_'.$token->[2]->{'id'};
6073: }
6074: if ($metaentry{':packages'}) {
6075: $metaentry{':packages'}.=','.$package.$keyroot;
6076: } else {
6077: $metaentry{':packages'}=$package.$keyroot;
6078: }
6079: foreach my $pack_entry (keys(%packagetab)) {
6080: my $part=$keyroot;
6081: $part=~s/^\_//;
6082: if ($pack_entry=~/^\Q$package\E\&/ ||
6083: $pack_entry=~/^\Q$package\E_0\&/) {
6084: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
6085: # ignore package.tab specified default values
6086: # here &package_tab_default() will fetch those
6087: if ($subp eq 'default') { next; }
6088: my $value=$packagetab{$pack_entry};
6089: my $unikey;
6090: if ($pack =~ /_0$/) {
6091: $unikey='parameter_0_'.$name;
6092: $part=0;
6093: } else {
6094: $unikey='parameter'.$keyroot.'_'.$name;
6095: }
6096: if ($subp eq 'display') {
6097: $value.=' [Part: '.$part.']';
6098: }
6099: $metaentry{':'.$unikey.'.part'}=$part;
6100: $metathesekeys{$unikey}=1;
6101: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6102: $metaentry{':'.$unikey.'.'.$subp}=$value;
6103: }
6104: if (defined($metaentry{':'.$unikey.'.default'})) {
6105: $metaentry{':'.$unikey}=
6106: $metaentry{':'.$unikey.'.default'};
6107: }
6108: }
6109: }
6110: } else {
6111: #
6112: # This is not a package - some other kind of start tag
6113: #
6114: my $entry=$token->[1];
6115: my $unikey;
6116: if ($entry eq 'import') {
6117: $unikey='';
6118: } else {
6119: $unikey=$entry;
6120: }
6121: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6122:
6123: if (defined($token->[2]->{'id'})) {
6124: $unikey.='_'.$token->[2]->{'id'};
6125: }
6126:
6127: if ($entry eq 'import') {
6128: #
6129: # Importing a library here
6130: #
6131: if ($depthcount<20) {
6132: my $location=$parser->get_text('/import');
6133: my $dir=$filename;
6134: $dir=~s|[^/]*$||;
6135: $location=&filelocation($dir,$location);
6136: my $metadata =
6137: &metadata($uri,'keys', $location,$unikey,
6138: $depthcount+1);
6139: foreach my $meta (split(',',$metadata)) {
6140: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6141: $metathesekeys{$meta}=1;
6142: }
6143: }
6144: } else {
6145:
6146: if (defined($token->[2]->{'name'})) {
6147: $unikey.='_'.$token->[2]->{'name'};
6148: }
6149: $metathesekeys{$unikey}=1;
6150: foreach my $param (@{$token->[3]}) {
6151: $metaentry{':'.$unikey.'.'.$param} =
6152: $token->[2]->{$param};
6153: }
6154: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6155: my $default=$metaentry{':'.$unikey.'.default'};
6156: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6157: # only ws inside the tag, and not in default, so use default
6158: # as value
6159: $metaentry{':'.$unikey}=$default;
6160: } else {
6161: # either something interesting inside the tag or default
6162: # uninteresting
6163: $metaentry{':'.$unikey}=$internaltext;
6164: }
6165: # end of not-a-package not-a-library import
6166: }
6167: # end of not-a-package start tag
6168: }
6169: # the next is the end of "start tag"
6170: }
6171: }
6172: my ($extension) = ($uri =~ /\.(\w+)$/);
6173: foreach my $key (keys(%packagetab)) {
6174: #no specific packages #how's our extension
6175: if ($key!~/^extension_\Q$extension\E&/) { next; }
6176: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6177: \%metathesekeys);
6178: }
6179: if (!exists($metaentry{':packages'})) {
6180: foreach my $key (keys(%packagetab)) {
6181: #no specific packages well let's get default then
6182: if ($key!~/^default&/) { next; }
6183: &metadata_create_package_def($uri,$key,'default',
6184: \%metathesekeys);
6185: }
6186: }
6187: # are there custom rights to evaluate
6188: if ($metaentry{':copyright'} eq 'custom') {
6189:
6190: #
6191: # Importing a rights file here
6192: #
6193: unless ($depthcount) {
6194: my $location=$metaentry{':customdistributionfile'};
6195: my $dir=$filename;
6196: $dir=~s|[^/]*$||;
6197: $location=&filelocation($dir,$location);
6198: my $rights_metadata =
6199: &metadata($uri,'keys',$location,'_rights',
6200: $depthcount+1);
6201: foreach my $rights (split(',',$rights_metadata)) {
6202: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6203: $metathesekeys{$rights}=1;
6204: }
6205: }
6206: }
6207: # uniqifiy package listing
6208: my %seen;
6209: my @uniq_packages =
6210: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6211: $metaentry{':packages'} = join(',',@uniq_packages);
6212:
6213: $metaentry{':keys'} = join(',',keys(%metathesekeys));
6214: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6215: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
6216: &do_cache_new('meta',$uri,\%metaentry,60*60);
6217: # this is the end of "was not already recently cached
6218: }
6219: return $metaentry{':'.$what};
6220: }
6221:
6222: sub metadata_create_package_def {
6223: my ($uri,$key,$package,$metathesekeys)=@_;
6224: my ($pack,$name,$subp)=split(/\&/,$key);
6225: if ($subp eq 'default') { next; }
6226:
6227: if (defined($metaentry{':packages'})) {
6228: $metaentry{':packages'}.=','.$package;
6229: } else {
6230: $metaentry{':packages'}=$package;
6231: }
6232: my $value=$packagetab{$key};
6233: my $unikey;
6234: $unikey='parameter_0_'.$name;
6235: $metaentry{':'.$unikey.'.part'}=0;
6236: $$metathesekeys{$unikey}=1;
6237: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6238: $metaentry{':'.$unikey.'.'.$subp}=$value;
6239: }
6240: if (defined($metaentry{':'.$unikey.'.default'})) {
6241: $metaentry{':'.$unikey}=
6242: $metaentry{':'.$unikey.'.default'};
6243: }
6244: }
6245:
6246: sub metadata_generate_part0 {
6247: my ($metadata,$metacache,$uri) = @_;
6248: my %allnames;
6249: foreach my $metakey (keys(%$metadata)) {
6250: if ($metakey=~/^parameter\_(.*)/) {
6251: my $part=$$metacache{':'.$metakey.'.part'};
6252: my $name=$$metacache{':'.$metakey.'.name'};
6253: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
6254: $allnames{$name}=$part;
6255: }
6256: }
6257: }
6258: foreach my $name (keys(%allnames)) {
6259: $$metadata{"parameter_0_$name"}=1;
6260: my $key=":parameter_0_$name";
6261: $$metacache{"$key.part"}='0';
6262: $$metacache{"$key.name"}=$name;
6263: $$metacache{"$key.type"}=$$metacache{':parameter_'.
6264: $allnames{$name}.'_'.$name.
6265: '.type'};
6266: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
6267: '.display'};
6268: my $expr='[Part: '.$allnames{$name}.']';
6269: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
6270: $$metacache{"$key.display"}=$olddis;
6271: }
6272: }
6273:
6274: # ------------------------------------------------------ Devalidate title cache
6275:
6276: sub devalidate_title_cache {
6277: my ($url)=@_;
6278: if (!$env{'request.course.id'}) { return; }
6279: my $symb=&symbread($url);
6280: if (!$symb) { return; }
6281: my $key=$env{'request.course.id'}."\0".$symb;
6282: &devalidate_cache_new('title',$key);
6283: }
6284:
6285: # ------------------------------------------------- Get the title of a resource
6286:
6287: sub gettitle {
6288: my $urlsymb=shift;
6289: my $symb=&symbread($urlsymb);
6290: if ($symb) {
6291: my $key=$env{'request.course.id'}."\0".$symb;
6292: my ($result,$cached)=&is_cached_new('title',$key);
6293: if (defined($cached)) {
6294: return $result;
6295: }
6296: my ($map,$resid,$url)=&decode_symb($symb);
6297: my $title='';
6298: my %bighash;
6299: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6300: &GDBM_READER(),0640)) {
6301: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6302: $title=$bighash{'title_'.$mapid.'.'.$resid};
6303: untie %bighash;
6304: }
6305: $title=~s/\&colon\;/\:/gs;
6306: if ($title) {
6307: return &do_cache_new('title',$key,$title,600);
6308: }
6309: $urlsymb=$url;
6310: }
6311: my $title=&metadata($urlsymb,'title');
6312: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6313: return $title;
6314: }
6315:
6316: sub get_slot {
6317: my ($which,$cnum,$cdom)=@_;
6318: if (!$cnum || !$cdom) {
6319: (undef,my $courseid)=&whichuser();
6320: $cdom=$env{'course.'.$courseid.'.domain'};
6321: $cnum=$env{'course.'.$courseid.'.num'};
6322: }
6323: my $key=join("\0",'slots',$cdom,$cnum,$which);
6324: my %slotinfo;
6325: if (exists($remembered{$key})) {
6326: $slotinfo{$which} = $remembered{$key};
6327: } else {
6328: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6329: &Apache::lonhomework::showhash(%slotinfo);
6330: my ($tmp)=keys(%slotinfo);
6331: if ($tmp=~/^error:/) { return (); }
6332: $remembered{$key} = $slotinfo{$which};
6333: }
6334: if (ref($slotinfo{$which}) eq 'HASH') {
6335: return %{$slotinfo{$which}};
6336: }
6337: return $slotinfo{$which};
6338: }
6339: # ------------------------------------------------- Update symbolic store links
6340:
6341: sub symblist {
6342: my ($mapname,%newhash)=@_;
6343: $mapname=&deversion(&declutter($mapname));
6344: my %hash;
6345: if (($env{'request.course.fn'}) && (%newhash)) {
6346: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6347: &GDBM_WRCREAT(),0640)) {
6348: foreach my $url (keys %newhash) {
6349: next if ($url eq 'last_known'
6350: && $env{'form.no_update_last_known'});
6351: $hash{declutter($url)}=&encode_symb($mapname,
6352: $newhash{$url}->[1],
6353: $newhash{$url}->[0]);
6354: }
6355: if (untie(%hash)) {
6356: return 'ok';
6357: }
6358: }
6359: }
6360: return 'error';
6361: }
6362:
6363: # --------------------------------------------------------------- Verify a symb
6364:
6365: sub symbverify {
6366: my ($symb,$thisurl)=@_;
6367: my $thisfn=$thisurl;
6368: $thisfn=&declutter($thisfn);
6369: # direct jump to resource in page or to a sequence - will construct own symbs
6370: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6371: # check URL part
6372: my ($map,$resid,$url)=&decode_symb($symb);
6373:
6374: unless ($url eq $thisfn) { return 0; }
6375:
6376: $symb=&symbclean($symb);
6377: $thisurl=&deversion($thisurl);
6378: $thisfn=&deversion($thisfn);
6379:
6380: my %bighash;
6381: my $okay=0;
6382:
6383: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6384: &GDBM_READER(),0640)) {
6385: my $ids=$bighash{'ids_'.&clutter($thisurl)};
6386: unless ($ids) {
6387: $ids=$bighash{'ids_/'.$thisurl};
6388: }
6389: if ($ids) {
6390: # ------------------------------------------------------------------- Has ID(s)
6391: foreach my $id (split(/\,/,$ids)) {
6392: my ($mapid,$resid)=split(/\./,$id);
6393: if (
6394: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6395: eq $symb) {
6396: if (($env{'request.role.adv'}) ||
6397: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
6398: $okay=1;
6399: }
6400: }
6401: }
6402: }
6403: untie(%bighash);
6404: }
6405: return $okay;
6406: }
6407:
6408: # --------------------------------------------------------------- Clean-up symb
6409:
6410: sub symbclean {
6411: my $symb=shift;
6412: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6413: # remove version from map
6414: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6415:
6416: # remove version from URL
6417: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6418:
6419: # remove wrapper
6420:
6421: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6422: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6423: return $symb;
6424: }
6425:
6426: # ---------------------------------------------- Split symb to find map and url
6427:
6428: sub encode_symb {
6429: my ($map,$resid,$url)=@_;
6430: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6431: }
6432:
6433: sub decode_symb {
6434: my $symb=shift;
6435: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6436: my ($map,$resid,$url)=split(/___/,$symb);
6437: return (&fixversion($map),$resid,&fixversion($url));
6438: }
6439:
6440: sub fixversion {
6441: my $fn=shift;
6442: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6443: my %bighash;
6444: my $uri=&clutter($fn);
6445: my $key=$env{'request.course.id'}.'_'.$uri;
6446: # is this cached?
6447: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6448: if (defined($cached)) { return $result; }
6449: # unfortunately not cached, or expired
6450: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6451: &GDBM_READER(),0640)) {
6452: if ($bighash{'version_'.$uri}) {
6453: my $version=$bighash{'version_'.$uri};
6454: unless (($version eq 'mostrecent') ||
6455: ($version==&getversion($uri))) {
6456: $uri=~s/\.(\w+)$/\.$version\.$1/;
6457: }
6458: }
6459: untie %bighash;
6460: }
6461: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6462: }
6463:
6464: sub deversion {
6465: my $url=shift;
6466: $url=~s/\.\d+\.(\w+)$/\.$1/;
6467: return $url;
6468: }
6469:
6470: # ------------------------------------------------------ Return symb list entry
6471:
6472: sub symbread {
6473: my ($thisfn,$donotrecurse)=@_;
6474: my $cache_str='request.symbread.cached.'.$thisfn;
6475: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6476: # no filename provided? try from environment
6477: unless ($thisfn) {
6478: if ($env{'request.symb'}) {
6479: return $env{$cache_str}=&symbclean($env{'request.symb'});
6480: }
6481: $thisfn=$env{'request.filename'};
6482: }
6483: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6484: # is that filename actually a symb? Verify, clean, and return
6485: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6486: if (&symbverify($thisfn,$1)) {
6487: return $env{$cache_str}=&symbclean($thisfn);
6488: }
6489: }
6490: $thisfn=declutter($thisfn);
6491: my %hash;
6492: my %bighash;
6493: my $syval='';
6494: if (($env{'request.course.fn'}) && ($thisfn)) {
6495: my $targetfn = $thisfn;
6496: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6497: $targetfn = 'adm/wrapper/'.$thisfn;
6498: }
6499: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6500: $targetfn=$1;
6501: }
6502: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6503: &GDBM_READER(),0640)) {
6504: $syval=$hash{$targetfn};
6505: untie(%hash);
6506: }
6507: # ---------------------------------------------------------- There was an entry
6508: if ($syval) {
6509: #unless ($syval=~/\_\d+$/) {
6510: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6511: #&appenv('request.ambiguous' => $thisfn);
6512: #return $env{$cache_str}='';
6513: #}
6514: #$syval.=$1;
6515: #}
6516: } else {
6517: # ------------------------------------------------------- Was not in symb table
6518: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6519: &GDBM_READER(),0640)) {
6520: # ---------------------------------------------- Get ID(s) for current resource
6521: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6522: unless ($ids) {
6523: $ids=$bighash{'ids_/'.$thisfn};
6524: }
6525: unless ($ids) {
6526: # alias?
6527: $ids=$bighash{'mapalias_'.$thisfn};
6528: }
6529: if ($ids) {
6530: # ------------------------------------------------------------------- Has ID(s)
6531: my @possibilities=split(/\,/,$ids);
6532: if ($#possibilities==0) {
6533: # ----------------------------------------------- There is only one possibility
6534: my ($mapid,$resid)=split(/\./,$ids);
6535: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6536: $resid,$thisfn);
6537: } elsif (!$donotrecurse) {
6538: # ------------------------------------------ There is more than one possibility
6539: my $realpossible=0;
6540: foreach my $id (@possibilities) {
6541: my $file=$bighash{'src_'.$id};
6542: if (&allowed('bre',$file)) {
6543: my ($mapid,$resid)=split(/\./,$id);
6544: if ($bighash{'map_type_'.$mapid} ne 'page') {
6545: $realpossible++;
6546: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6547: $resid,$thisfn);
6548: }
6549: }
6550: }
6551: if ($realpossible!=1) { $syval=''; }
6552: } else {
6553: $syval='';
6554: }
6555: }
6556: untie(%bighash)
6557: }
6558: }
6559: if ($syval) {
6560: return $env{$cache_str}=$syval;
6561: }
6562: }
6563: &appenv('request.ambiguous' => $thisfn);
6564: return $env{$cache_str}='';
6565: }
6566:
6567: # ---------------------------------------------------------- Return random seed
6568:
6569: sub numval {
6570: my $txt=shift;
6571: $txt=~tr/A-J/0-9/;
6572: $txt=~tr/a-j/0-9/;
6573: $txt=~tr/K-T/0-9/;
6574: $txt=~tr/k-t/0-9/;
6575: $txt=~tr/U-Z/0-5/;
6576: $txt=~tr/u-z/0-5/;
6577: $txt=~s/\D//g;
6578: if ($_64bit) { if ($txt > 2**32) { return -1; } }
6579: return int($txt);
6580: }
6581:
6582: sub numval2 {
6583: my $txt=shift;
6584: $txt=~tr/A-J/0-9/;
6585: $txt=~tr/a-j/0-9/;
6586: $txt=~tr/K-T/0-9/;
6587: $txt=~tr/k-t/0-9/;
6588: $txt=~tr/U-Z/0-5/;
6589: $txt=~tr/u-z/0-5/;
6590: $txt=~s/\D//g;
6591: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6592: my $total;
6593: foreach my $val (@txts) { $total+=$val; }
6594: if ($_64bit) { if ($total > 2**32) { return -1; } }
6595: return int($total);
6596: }
6597:
6598: sub numval3 {
6599: use integer;
6600: my $txt=shift;
6601: $txt=~tr/A-J/0-9/;
6602: $txt=~tr/a-j/0-9/;
6603: $txt=~tr/K-T/0-9/;
6604: $txt=~tr/k-t/0-9/;
6605: $txt=~tr/U-Z/0-5/;
6606: $txt=~tr/u-z/0-5/;
6607: $txt=~s/\D//g;
6608: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6609: my $total;
6610: foreach my $val (@txts) { $total+=$val; }
6611: if ($_64bit) { $total=(($total<<32)>>32); }
6612: return $total;
6613: }
6614:
6615: sub digest {
6616: my ($data)=@_;
6617: my $digest=&Digest::MD5::md5($data);
6618: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6619: my ($e,$f);
6620: {
6621: use integer;
6622: $e=($a+$b);
6623: $f=($c+$d);
6624: if ($_64bit) {
6625: $e=(($e<<32)>>32);
6626: $f=(($f<<32)>>32);
6627: }
6628: }
6629: if (wantarray) {
6630: return ($e,$f);
6631: } else {
6632: my $g;
6633: {
6634: use integer;
6635: $g=($e+$f);
6636: if ($_64bit) {
6637: $g=(($g<<32)>>32);
6638: }
6639: }
6640: return $g;
6641: }
6642: }
6643:
6644: sub latest_rnd_algorithm_id {
6645: return '64bit5';
6646: }
6647:
6648: sub get_rand_alg {
6649: my ($courseid)=@_;
6650: if (!$courseid) { $courseid=(&whichuser())[1]; }
6651: if ($courseid) {
6652: return $env{"course.$courseid.rndseed"};
6653: }
6654: return &latest_rnd_algorithm_id();
6655: }
6656:
6657: sub validCODE {
6658: my ($CODE)=@_;
6659: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6660: return 0;
6661: }
6662:
6663: sub getCODE {
6664: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
6665: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6666: defined($Apache::lonhomework::parsing_a_task) ) &&
6667: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
6668: return $Apache::lonhomework::history{'resource.CODE'};
6669: }
6670: return undef;
6671: }
6672:
6673: sub rndseed {
6674: my ($symb,$courseid,$domain,$username)=@_;
6675:
6676: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
6677: if (!$symb) {
6678: unless ($symb=$wsymb) { return time; }
6679: }
6680: if (!$courseid) { $courseid=$wcourseid; }
6681: if (!$domain) { $domain=$wdomain; }
6682: if (!$username) { $username=$wusername }
6683: my $which=&get_rand_alg();
6684:
6685: if (defined(&getCODE())) {
6686: if ($which eq '64bit5') {
6687: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6688: } elsif ($which eq '64bit4') {
6689: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6690: } else {
6691: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6692: }
6693: } elsif ($which eq '64bit5') {
6694: return &rndseed_64bit5($symb,$courseid,$domain,$username);
6695: } elsif ($which eq '64bit4') {
6696: return &rndseed_64bit4($symb,$courseid,$domain,$username);
6697: } elsif ($which eq '64bit3') {
6698: return &rndseed_64bit3($symb,$courseid,$domain,$username);
6699: } elsif ($which eq '64bit2') {
6700: return &rndseed_64bit2($symb,$courseid,$domain,$username);
6701: } elsif ($which eq '64bit') {
6702: return &rndseed_64bit($symb,$courseid,$domain,$username);
6703: }
6704: return &rndseed_32bit($symb,$courseid,$domain,$username);
6705: }
6706:
6707: sub rndseed_32bit {
6708: my ($symb,$courseid,$domain,$username)=@_;
6709: {
6710: use integer;
6711: my $symbchck=unpack("%32C*",$symb) << 27;
6712: my $symbseed=numval($symb) << 22;
6713: my $namechck=unpack("%32C*",$username) << 17;
6714: my $nameseed=numval($username) << 12;
6715: my $domainseed=unpack("%32C*",$domain) << 7;
6716: my $courseseed=unpack("%32C*",$courseid);
6717: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6718: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6719: #&logthis("rndseed :$num:$symb");
6720: if ($_64bit) { $num=(($num<<32)>>32); }
6721: return $num;
6722: }
6723: }
6724:
6725: sub rndseed_64bit {
6726: my ($symb,$courseid,$domain,$username)=@_;
6727: {
6728: use integer;
6729: my $symbchck=unpack("%32S*",$symb) << 21;
6730: my $symbseed=numval($symb) << 10;
6731: my $namechck=unpack("%32S*",$username);
6732:
6733: my $nameseed=numval($username) << 21;
6734: my $domainseed=unpack("%32S*",$domain) << 10;
6735: my $courseseed=unpack("%32S*",$courseid);
6736:
6737: my $num1=$symbchck+$symbseed+$namechck;
6738: my $num2=$nameseed+$domainseed+$courseseed;
6739: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6740: #&logthis("rndseed :$num:$symb");
6741: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6742: return "$num1,$num2";
6743: }
6744: }
6745:
6746: sub rndseed_64bit2 {
6747: my ($symb,$courseid,$domain,$username)=@_;
6748: {
6749: use integer;
6750: # strings need to be an even # of cahracters long, it it is odd the
6751: # last characters gets thrown away
6752: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6753: my $symbseed=numval($symb) << 10;
6754: my $namechck=unpack("%32S*",$username.' ');
6755:
6756: my $nameseed=numval($username) << 21;
6757: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6758: my $courseseed=unpack("%32S*",$courseid.' ');
6759:
6760: my $num1=$symbchck+$symbseed+$namechck;
6761: my $num2=$nameseed+$domainseed+$courseseed;
6762: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6763: #&logthis("rndseed :$num:$symb");
6764: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6765: return "$num1,$num2";
6766: }
6767: }
6768:
6769: sub rndseed_64bit3 {
6770: my ($symb,$courseid,$domain,$username)=@_;
6771: {
6772: use integer;
6773: # strings need to be an even # of cahracters long, it it is odd the
6774: # last characters gets thrown away
6775: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6776: my $symbseed=numval2($symb) << 10;
6777: my $namechck=unpack("%32S*",$username.' ');
6778:
6779: my $nameseed=numval2($username) << 21;
6780: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6781: my $courseseed=unpack("%32S*",$courseid.' ');
6782:
6783: my $num1=$symbchck+$symbseed+$namechck;
6784: my $num2=$nameseed+$domainseed+$courseseed;
6785: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6786: #&logthis("rndseed :$num1:$num2:$_64bit");
6787: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6788:
6789: return "$num1:$num2";
6790: }
6791: }
6792:
6793: sub rndseed_64bit4 {
6794: my ($symb,$courseid,$domain,$username)=@_;
6795: {
6796: use integer;
6797: # strings need to be an even # of cahracters long, it it is odd the
6798: # last characters gets thrown away
6799: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6800: my $symbseed=numval3($symb) << 10;
6801: my $namechck=unpack("%32S*",$username.' ');
6802:
6803: my $nameseed=numval3($username) << 21;
6804: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6805: my $courseseed=unpack("%32S*",$courseid.' ');
6806:
6807: my $num1=$symbchck+$symbseed+$namechck;
6808: my $num2=$nameseed+$domainseed+$courseseed;
6809: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6810: #&logthis("rndseed :$num1:$num2:$_64bit");
6811: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6812:
6813: return "$num1:$num2";
6814: }
6815: }
6816:
6817: sub rndseed_64bit5 {
6818: my ($symb,$courseid,$domain,$username)=@_;
6819: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6820: return "$num1:$num2";
6821: }
6822:
6823: sub rndseed_CODE_64bit {
6824: my ($symb,$courseid,$domain,$username)=@_;
6825: {
6826: use integer;
6827: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6828: my $symbseed=numval2($symb);
6829: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6830: my $CODEseed=numval(&getCODE());
6831: my $courseseed=unpack("%32S*",$courseid.' ');
6832: my $num1=$symbseed+$CODEchck;
6833: my $num2=$CODEseed+$courseseed+$symbchck;
6834: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6835: #&logthis("rndseed :$num1:$num2:$symb");
6836: if ($_64bit) { $num1=(($num1<<32)>>32); }
6837: if ($_64bit) { $num2=(($num2<<32)>>32); }
6838: return "$num1:$num2";
6839: }
6840: }
6841:
6842: sub rndseed_CODE_64bit4 {
6843: my ($symb,$courseid,$domain,$username)=@_;
6844: {
6845: use integer;
6846: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6847: my $symbseed=numval3($symb);
6848: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6849: my $CODEseed=numval3(&getCODE());
6850: my $courseseed=unpack("%32S*",$courseid.' ');
6851: my $num1=$symbseed+$CODEchck;
6852: my $num2=$CODEseed+$courseseed+$symbchck;
6853: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6854: #&logthis("rndseed :$num1:$num2:$symb");
6855: if ($_64bit) { $num1=(($num1<<32)>>32); }
6856: if ($_64bit) { $num2=(($num2<<32)>>32); }
6857: return "$num1:$num2";
6858: }
6859: }
6860:
6861: sub rndseed_CODE_64bit5 {
6862: my ($symb,$courseid,$domain,$username)=@_;
6863: my $code = &getCODE();
6864: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6865: return "$num1:$num2";
6866: }
6867:
6868: sub setup_random_from_rndseed {
6869: my ($rndseed)=@_;
6870: if ($rndseed =~/([,:])/) {
6871: my ($num1,$num2)=split(/[,:]/,$rndseed);
6872: &Math::Random::random_set_seed(abs($num1),abs($num2));
6873: } else {
6874: &Math::Random::random_set_seed_from_phrase($rndseed);
6875: }
6876: }
6877:
6878: sub latest_receipt_algorithm_id {
6879: return 'receipt2';
6880: }
6881:
6882: sub recunique {
6883: my $fucourseid=shift;
6884: my $unique;
6885: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6886: $unique=$env{"course.$fucourseid.internal.encseed"};
6887: } else {
6888: $unique=$perlvar{'lonReceipt'};
6889: }
6890: return unpack("%32C*",$unique);
6891: }
6892:
6893: sub recprefix {
6894: my $fucourseid=shift;
6895: my $prefix;
6896: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6897: $prefix=$env{"course.$fucourseid.internal.encpref"};
6898: } else {
6899: $prefix=$perlvar{'lonHostID'};
6900: }
6901: return unpack("%32C*",$prefix);
6902: }
6903:
6904: sub ireceipt {
6905: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
6906: my $cuname=unpack("%32C*",$funame);
6907: my $cudom=unpack("%32C*",$fudom);
6908: my $cucourseid=unpack("%32C*",$fucourseid);
6909: my $cusymb=unpack("%32C*",$fusymb);
6910: my $cunique=&recunique($fucourseid);
6911: my $cpart=unpack("%32S*",$part);
6912: my $return =&recprefix($fucourseid).'-';
6913: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6914: $env{'request.state'} eq 'construct') {
6915: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
6916:
6917: $return.= ($cunique%$cuname+
6918: $cunique%$cudom+
6919: $cusymb%$cuname+
6920: $cusymb%$cudom+
6921: $cucourseid%$cuname+
6922: $cucourseid%$cudom+
6923: $cpart%$cuname+
6924: $cpart%$cudom);
6925: } else {
6926: $return.= ($cunique%$cuname+
6927: $cunique%$cudom+
6928: $cusymb%$cuname+
6929: $cusymb%$cudom+
6930: $cucourseid%$cuname+
6931: $cucourseid%$cudom);
6932: }
6933: return $return;
6934: }
6935:
6936: sub receipt {
6937: my ($part)=@_;
6938: my ($symb,$courseid,$domain,$name) = &whichuser();
6939: return &ireceipt($name,$domain,$courseid,$symb,$part);
6940: }
6941:
6942: sub whichuser {
6943: my ($passedsymb)=@_;
6944: my ($symb,$courseid,$domain,$name,$publicuser);
6945: if (defined($env{'form.grade_symb'})) {
6946: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
6947: my $allowed=&allowed('vgr',$tmp_courseid);
6948: if (!$allowed &&
6949: exists($env{'request.course.sec'}) &&
6950: $env{'request.course.sec'} !~ /^\s*$/) {
6951: $allowed=&allowed('vgr',$tmp_courseid.
6952: '/'.$env{'request.course.sec'});
6953: }
6954: if ($allowed) {
6955: ($symb)=&get_env_multiple('form.grade_symb');
6956: $courseid=$tmp_courseid;
6957: ($domain)=&get_env_multiple('form.grade_domain');
6958: ($name)=&get_env_multiple('form.grade_username');
6959: return ($symb,$courseid,$domain,$name,$publicuser);
6960: }
6961: }
6962: if (!$passedsymb) {
6963: $symb=&symbread();
6964: } else {
6965: $symb=$passedsymb;
6966: }
6967: $courseid=$env{'request.course.id'};
6968: $domain=$env{'user.domain'};
6969: $name=$env{'user.name'};
6970: if ($name eq 'public' && $domain eq 'public') {
6971: if (!defined($env{'form.username'})) {
6972: $env{'form.username'}.=time.rand(10000000);
6973: }
6974: $name.=$env{'form.username'};
6975: }
6976: return ($symb,$courseid,$domain,$name,$publicuser);
6977:
6978: }
6979:
6980: # ------------------------------------------------------------ Serves up a file
6981: # returns either the contents of the file or
6982: # -1 if the file doesn't exist
6983: #
6984: # if the target is a file that was uploaded via DOCS,
6985: # a check will be made to see if a current copy exists on the local server,
6986: # if it does this will be served, otherwise a copy will be retrieved from
6987: # the home server for the course and stored in /home/httpd/html/userfiles on
6988: # the local server.
6989:
6990: sub getfile {
6991: my ($file) = @_;
6992: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6993: &repcopy($file);
6994: return &readfile($file);
6995: }
6996:
6997: sub repcopy_userfile {
6998: my ($file)=@_;
6999: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
7000: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
7001: my ($cdom,$cnum,$filename) =
7002: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_username)/+(.*)|);
7003: my ($info,$rtncode);
7004: my $uri="/uploaded/$cdom/$cnum/$filename";
7005: if (-e "$file") {
7006: my @fileinfo = stat($file);
7007: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
7008: if ($lwpresp ne 'ok') {
7009: if ($rtncode eq '404') {
7010: unlink($file);
7011: }
7012: #my $ua=new LWP::UserAgent;
7013: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
7014: #my $response=$ua->request($request);
7015: #if ($response->is_success()) {
7016: # return $response->content;
7017: # } else {
7018: # return -1;
7019: # }
7020: return -1;
7021: }
7022: if ($info < $fileinfo[9]) {
7023: return 'ok';
7024: }
7025: $info = '';
7026: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
7027: if ($lwpresp ne 'ok') {
7028: return -1;
7029: }
7030: } else {
7031: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
7032: if ($lwpresp ne 'ok') {
7033: my $ua=new LWP::UserAgent;
7034: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
7035: my $response=$ua->request($request);
7036: if ($response->is_success()) {
7037: $info=$response->content;
7038: } else {
7039: return -1;
7040: }
7041: }
7042: my @parts = ($cdom,$cnum);
7043: if ($filename =~ m|^(.+)/[^/]+$|) {
7044: push @parts, split(/\//,$1);
7045: }
7046: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
7047: foreach my $part (@parts) {
7048: $path .= '/'.$part;
7049: if (!-e $path) {
7050: mkdir($path,0770);
7051: }
7052: }
7053: }
7054: open(FILE,">$file");
7055: print FILE $info;
7056: close(FILE);
7057: return 'ok';
7058: }
7059:
7060: sub tokenwrapper {
7061: my $uri=shift;
7062: $uri=~s|^http\://([^/]+)||;
7063: $uri=~s|^/||;
7064: $env{'user.environment'}=~/\/([^\/]+)\.id/;
7065: my $token=$1;
7066: my (undef,$udom,$uname,$file)=split('/',$uri,4);
7067: if ($udom && $uname && $file) {
7068: $file=~s|(\?\.*)*$||;
7069: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
7070: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
7071: (($uri=~/\?/)?'&':'?').'token='.$token.
7072: '&tokenissued='.$perlvar{'lonHostID'};
7073: } else {
7074: return '/adm/notfound.html';
7075: }
7076: }
7077:
7078: sub getuploaded {
7079: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7080: $uri=~s/^\///;
7081: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
7082: my $ua=new LWP::UserAgent;
7083: my $request=new HTTP::Request($reqtype,$uri);
7084: my $response=$ua->request($request);
7085: $$rtncode = $response->code;
7086: if (! $response->is_success()) {
7087: return 'failed';
7088: }
7089: if ($reqtype eq 'HEAD') {
7090: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
7091: } elsif ($reqtype eq 'GET') {
7092: $$info = $response->content;
7093: }
7094: return 'ok';
7095: }
7096:
7097: sub readfile {
7098: my $file = shift;
7099: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7100: my $fh;
7101: open($fh,"<$file");
7102: my $a='';
7103: while (my $line = <$fh>) { $a .= $line; }
7104: return $a;
7105: }
7106:
7107: sub filelocation {
7108: my ($dir,$file) = @_;
7109: my $location;
7110: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
7111:
7112: if ($file =~ m-^/adm/-) {
7113: $file=~s-^/adm/wrapper/-/-;
7114: $file=~s-^/adm/coursedocs/showdoc/-/-;
7115: }
7116: if ($file=~m:^/~:) { # is a contruction space reference
7117: $location = $file;
7118: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
7119: } elsif ($file=~m{^/home/$match_username/public_html/}) {
7120: # is a correct contruction space reference
7121: $location = $file;
7122: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
7123: my ($udom,$uname,$filename)=
7124: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_username)/+(.*)$-);
7125: my $home=&homeserver($uname,$udom);
7126: my $is_me=0;
7127: my @ids=¤t_machine_ids();
7128: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7129: if ($is_me) {
7130: $location=&propath($udom,$uname).
7131: '/userfiles/'.$filename;
7132: } else {
7133: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7134: $udom.'/'.$uname.'/'.$filename;
7135: }
7136: } else {
7137: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7138: $file=~s:^/res/:/:;
7139: if ( !( $file =~ m:^/:) ) {
7140: $location = $dir. '/'.$file;
7141: } else {
7142: $location = '/home/httpd/html/res'.$file;
7143: }
7144: }
7145: $location=~s://+:/:g; # remove duplicate /
7146: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
7147: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7148: return $location;
7149: }
7150:
7151: sub hreflocation {
7152: my ($dir,$file)=@_;
7153: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
7154: $file=filelocation($dir,$file);
7155: } elsif ($file=~m-^/adm/-) {
7156: $file=~s-^/adm/wrapper/-/-;
7157: $file=~s-^/adm/coursedocs/showdoc/-/-;
7158: }
7159: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7160: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
7161: } elsif ($file=~m-/home/($match_username)/public_html/-) {
7162: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
7163: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
7164: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_username)/userfiles/
7165: -/uploaded/$1/$2/-x;
7166: }
7167: return $file;
7168: }
7169:
7170: sub current_machine_domains {
7171: my $hostname=$hostname{$perlvar{'lonHostID'}};
7172: my @domains;
7173: while( my($id, $name) = each(%hostname)) {
7174: # &logthis("-$id-$name-$hostname-");
7175: if ($hostname eq $name) {
7176: push(@domains,$hostdom{$id});
7177: }
7178: }
7179: return @domains;
7180: }
7181:
7182: sub current_machine_ids {
7183: my $hostname=$hostname{$perlvar{'lonHostID'}};
7184: my @ids;
7185: while( my($id, $name) = each(%hostname)) {
7186: # &logthis("-$id-$name-$hostname-");
7187: if ($hostname eq $name) {
7188: push(@ids,$id);
7189: }
7190: }
7191: return @ids;
7192: }
7193:
7194: # ------------------------------------------------------------- Declutters URLs
7195:
7196: sub declutter {
7197: my $thisfn=shift;
7198: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7199: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7200: $thisfn=~s/^\///;
7201: $thisfn=~s|^adm/wrapper/||;
7202: $thisfn=~s|^adm/coursedocs/showdoc/||;
7203: $thisfn=~s/^res\///;
7204: $thisfn=~s/\?.+$//;
7205: return $thisfn;
7206: }
7207:
7208: # ------------------------------------------------------------- Clutter up URLs
7209:
7210: sub clutter {
7211: my $thisfn='/'.&declutter(shift);
7212: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
7213: $thisfn='/res'.$thisfn;
7214: }
7215: if ($thisfn !~m|/adm|) {
7216: if ($thisfn =~ m|/ext/|) {
7217: $thisfn='/adm/wrapper'.$thisfn;
7218: } else {
7219: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7220: my $embstyle=&Apache::loncommon::fileembstyle($ext);
7221: if ($embstyle eq 'ssi'
7222: || ($embstyle eq 'hdn')
7223: || ($embstyle eq 'rat')
7224: || ($embstyle eq 'prv')
7225: || ($embstyle eq 'ign')) {
7226: #do nothing with these
7227: } elsif (($embstyle eq 'img')
7228: || ($embstyle eq 'emb')
7229: || ($embstyle eq 'wrp')) {
7230: $thisfn='/adm/wrapper'.$thisfn;
7231: } elsif ($embstyle eq 'unk'
7232: && $thisfn!~/\.(sequence|page)$/) {
7233: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
7234: } else {
7235: # &logthis("Got a blank emb style");
7236: }
7237: }
7238: }
7239: return $thisfn;
7240: }
7241:
7242: sub clutter_with_no_wrapper {
7243: my $uri = &clutter(shift);
7244: if ($uri =~ m-^/adm/-) {
7245: $uri =~ s-^/adm/wrapper/-/-;
7246: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
7247: }
7248: return $uri;
7249: }
7250:
7251: sub freeze_escape {
7252: my ($value)=@_;
7253: if (ref($value)) {
7254: $value=&nfreeze($value);
7255: return '__FROZEN__'.&escape($value);
7256: }
7257: return &escape($value);
7258: }
7259:
7260:
7261: sub thaw_unescape {
7262: my ($value)=@_;
7263: if ($value =~ /^__FROZEN__/) {
7264: substr($value,0,10,undef);
7265: $value=&unescape($value);
7266: return &thaw($value);
7267: }
7268: return &unescape($value);
7269: }
7270:
7271: sub correct_line_ends {
7272: my ($result)=@_;
7273: $$result =~s/\r\n/\n/mg;
7274: $$result =~s/\r/\n/mg;
7275: }
7276: # ================================================================ Main Program
7277:
7278: sub goodbye {
7279: &logthis("Starting Shut down");
7280: #not converted to using infrastruture and probably shouldn't be
7281: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
7282: #converted
7283: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7284: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
7285: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
7286: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
7287: #1.1 only
7288: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
7289: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
7290: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
7291: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
7292: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
7293: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7294: &logthis(sprintf("%-20s is %s",'hits',$hits));
7295: &flushcourselogs();
7296: &logthis("Shutting down");
7297: }
7298:
7299: BEGIN {
7300: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
7301: unless ($readit) {
7302: {
7303: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
7304: %perlvar = (%perlvar,%{$configvars});
7305: }
7306:
7307: # ------------------------------------------------------------ Read domain file
7308: {
7309: %domaindescription = ();
7310: %domain_auth_def = ();
7311: %domain_auth_arg_def = ();
7312: my $fh;
7313: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
7314: while (my $line = <$fh>) {
7315: next if ($line =~ /^(\#|\s*$)/);
7316: # next if /^\#/;
7317: chomp $line;
7318: my ($domain, $domain_description, $def_auth, $def_auth_arg,
7319: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$line,9);
7320: $domain_auth_def{$domain}=$def_auth;
7321: $domain_auth_arg_def{$domain}=$def_auth_arg;
7322: $domaindescription{$domain}=$domain_description;
7323: $domain_lang_def{$domain}=$def_lang;
7324: $domain_city{$domain}=$city;
7325: $domain_longi{$domain}=$longi;
7326: $domain_lati{$domain}=$lati;
7327: $domain_primary{$domain}=$primary;
7328:
7329: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
7330: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
7331: }
7332: }
7333: close ($fh);
7334: }
7335:
7336:
7337: # ------------------------------------------------------------- Read hosts file
7338: {
7339: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7340:
7341: while (my $configline=<$config>) {
7342: next if ($configline =~ /^(\#|\s*$)/);
7343: chomp($configline);
7344: my ($id,$domain,$role,$name)=split(/:/,$configline);
7345: $name=~s/\s//g;
7346: if ($id && $domain && $role && $name) {
7347: $hostname{$id}=$name;
7348: $hostdom{$id}=$domain;
7349: if ($role eq 'library') { $libserv{$id}=$name; }
7350: }
7351: }
7352: close($config);
7353: # FIXME: dev server don't want this, production servers _do_ want this
7354: #&get_iphost();
7355: }
7356:
7357: sub get_iphost {
7358: if (%iphost) { return %iphost; }
7359: my %name_to_ip;
7360: foreach my $id (keys(%hostname)) {
7361: my $name=$hostname{$id};
7362: my $ip;
7363: if (!exists($name_to_ip{$name})) {
7364: $ip = gethostbyname($name);
7365: if (!$ip || length($ip) ne 4) {
7366: &logthis("Skipping host $id name $name no IP found\n");
7367: next;
7368: }
7369: $ip=inet_ntoa($ip);
7370: $name_to_ip{$name} = $ip;
7371: } else {
7372: $ip = $name_to_ip{$name};
7373: }
7374: push(@{$iphost{$ip}},$id);
7375: }
7376: return %iphost;
7377: }
7378:
7379: # ------------------------------------------------------ Read spare server file
7380: {
7381: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
7382:
7383: while (my $configline=<$config>) {
7384: chomp($configline);
7385: if ($configline) {
7386: my ($host,$type) = split(':',$configline,2);
7387: if (!defined($type) || $type eq '') { $type = 'default' };
7388: push(@{ $spareid{$type} }, $host);
7389: }
7390: }
7391: close($config);
7392: }
7393: # ------------------------------------------------------------ Read permissions
7394: {
7395: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
7396:
7397: while (my $configline=<$config>) {
7398: chomp($configline);
7399: if ($configline) {
7400: my ($role,$perm)=split(/ /,$configline);
7401: if ($perm ne '') { $pr{$role}=$perm; }
7402: }
7403: }
7404: close($config);
7405: }
7406:
7407: # -------------------------------------------- Read plain texts for permissions
7408: {
7409: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
7410:
7411: while (my $configline=<$config>) {
7412: chomp($configline);
7413: if ($configline) {
7414: my ($short,@plain)=split(/:/,$configline);
7415: %{$prp{$short}} = ();
7416: if (@plain > 0) {
7417: $prp{$short}{'std'} = $plain[0];
7418: for (my $i=1; $i<@plain; $i++) {
7419: $prp{$short}{'alt'.$i} = $plain[$i];
7420: }
7421: }
7422: }
7423: }
7424: close($config);
7425: }
7426:
7427: # ---------------------------------------------------------- Read package table
7428: {
7429: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
7430:
7431: while (my $configline=<$config>) {
7432: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
7433: chomp($configline);
7434: my ($short,$plain)=split(/:/,$configline);
7435: my ($pack,$name)=split(/\&/,$short);
7436: if ($plain ne '') {
7437: $packagetab{$pack.'&'.$name.'&name'}=$name;
7438: $packagetab{$short}=$plain;
7439: }
7440: }
7441: close($config);
7442: }
7443:
7444: # ------------- set up temporary directory
7445: {
7446: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7447:
7448: }
7449:
7450: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
7451: 'compress_threshold'=> 20_000,
7452: });
7453:
7454: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
7455: $dumpcount=0;
7456:
7457: &logtouch();
7458: &logthis('<font color="yellow">INFO: Read configuration</font>');
7459: $readit=1;
7460: {
7461: use integer;
7462: my $test=(2**32)+1;
7463: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
7464: &logthis(" Detected 64bit platform ($_64bit)");
7465: }
7466: }
7467: }
7468:
7469: 1;
7470: __END__
7471:
7472: =pod
7473:
7474: =head1 NAME
7475:
7476: Apache::lonnet - Subroutines to ask questions about things in the network.
7477:
7478: =head1 SYNOPSIS
7479:
7480: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
7481:
7482: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7483:
7484: Common parameters:
7485:
7486: =over 4
7487:
7488: =item *
7489:
7490: $uname : an internal username (if $cname expecting a course Id specifically)
7491:
7492: =item *
7493:
7494: $udom : a domain (if $cdom expecting a course's domain specifically)
7495:
7496: =item *
7497:
7498: $symb : a resource instance identifier
7499:
7500: =item *
7501:
7502: $namespace : the name of a .db file that contains the data needed or
7503: being set.
7504:
7505: =back
7506:
7507: =head1 OVERVIEW
7508:
7509: lonnet provides subroutines which interact with the
7510: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7511: about classes, users, and resources.
7512:
7513: For many of these objects you can also use this to store data about
7514: them or modify them in various ways.
7515:
7516: =head2 Symbs
7517:
7518: To identify a specific instance of a resource, LON-CAPA uses symbols
7519: or "symbs"X<symb>. These identifiers are built from the URL of the
7520: map, the resource number of the resource in the map, and the URL of
7521: the resource itself. The latter is somewhat redundant, but might help
7522: if maps change.
7523:
7524: An example is
7525:
7526: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7527:
7528: The respective map entry is
7529:
7530: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7531: title="Problem 2">
7532: </resource>
7533:
7534: Symbs are used by the random number generator, as well as to store and
7535: restore data specific to a certain instance of for example a problem.
7536:
7537: =head2 Storing And Retrieving Data
7538:
7539: X<store()>X<cstore()>X<restore()>Three of the most important functions
7540: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7541: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7542: is is the non-critical message twin of cstore. These functions are for
7543: handlers to store a perl hash to a user's permanent data space in an
7544: easy manner, and to retrieve it again on another call. It is expected
7545: that a handler would use this once at the beginning to retrieve data,
7546: and then again once at the end to send only the new data back.
7547:
7548: The data is stored in the user's data directory on the user's
7549: homeserver under the ID of the course.
7550:
7551: The hash that is returned by restore will have all of the previous
7552: value for all of the elements of the hash.
7553:
7554: Example:
7555:
7556: #creating a hash
7557: my %hash;
7558: $hash{'foo'}='bar';
7559:
7560: #storing it
7561: &Apache::lonnet::cstore(\%hash);
7562:
7563: #changing a value
7564: $hash{'foo'}='notbar';
7565:
7566: #adding a new value
7567: $hash{'bar'}='foo';
7568: &Apache::lonnet::cstore(\%hash);
7569:
7570: #retrieving the hash
7571: my %history=&Apache::lonnet::restore();
7572:
7573: #print the hash
7574: foreach my $key (sort(keys(%history))) {
7575: print("\%history{$key} = $history{$key}");
7576: }
7577:
7578: Will print out:
7579:
7580: %history{1:foo} = bar
7581: %history{1:keys} = foo:timestamp
7582: %history{1:timestamp} = 990455579
7583: %history{2:bar} = foo
7584: %history{2:foo} = notbar
7585: %history{2:keys} = foo:bar:timestamp
7586: %history{2:timestamp} = 990455580
7587: %history{bar} = foo
7588: %history{foo} = notbar
7589: %history{timestamp} = 990455580
7590: %history{version} = 2
7591:
7592: Note that the special hash entries C<keys>, C<version> and
7593: C<timestamp> were added to the hash. C<version> will be equal to the
7594: total number of versions of the data that have been stored. The
7595: C<timestamp> attribute will be the UNIX time the hash was
7596: stored. C<keys> is available in every historical section to list which
7597: keys were added or changed at a specific historical revision of a
7598: hash.
7599:
7600: B<Warning>: do not store the hash that restore returns directly. This
7601: will cause a mess since it will restore the historical keys as if the
7602: were new keys. I.E. 1:foo will become 1:1:foo etc.
7603:
7604: Calling convention:
7605:
7606: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7607: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
7608:
7609: For more detailed information, see lonnet specific documentation.
7610:
7611: =head1 RETURN MESSAGES
7612:
7613: =over 4
7614:
7615: =item * B<con_lost>: unable to contact remote host
7616:
7617: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7618: when the connection is brought back up
7619:
7620: =item * B<con_failed>: unable to contact remote host and unable to save message
7621: for later delivery
7622:
7623: =item * B<error:>: an error a occured, a description of the error follows the :
7624:
7625: =item * B<no_such_host>: unable to fund a host associated with the user/domain
7626: that was requested
7627:
7628: =back
7629:
7630: =head1 PUBLIC SUBROUTINES
7631:
7632: =head2 Session Environment Functions
7633:
7634: =over 4
7635:
7636: =item *
7637: X<appenv()>
7638: B<appenv(%hash)>: the value of %hash is written to
7639: the user envirnoment file, and will be restored for each access this
7640: user makes during this session, also modifies the %env for the current
7641: process
7642:
7643: =item *
7644: X<delenv()>
7645: B<delenv($regexp)>: removes all items from the session
7646: environment file that matches the regular expression in $regexp. The
7647: values are also delted from the current processes %env.
7648:
7649: =item * get_env_multiple($name)
7650:
7651: gets $name from the %env hash, it seemlessly handles the cases where multiple
7652: values may be defined and end up as an array ref.
7653:
7654: returns an array of values
7655:
7656: =back
7657:
7658: =head2 User Information
7659:
7660: =over 4
7661:
7662: =item *
7663: X<queryauthenticate()>
7664: B<queryauthenticate($uname,$udom)>: try to determine user's current
7665: authentication scheme
7666:
7667: =item *
7668: X<authenticate()>
7669: B<authenticate($uname,$upass,$udom)>: try to
7670: authenticate user from domain's lib servers (first use the current
7671: one). C<$upass> should be the users password.
7672:
7673: =item *
7674: X<homeserver()>
7675: B<homeserver($uname,$udom)>: find the server which has
7676: the user's directory and files (there must be only one), this caches
7677: the answer, and also caches if there is a borken connection.
7678:
7679: =item *
7680: X<idget()>
7681: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7682: (IDs are a unique resource in a domain, there must be only 1 ID per
7683: username, and only 1 username per ID in a specific domain) (returns
7684: hash: id=>name,id=>name)
7685:
7686: =item *
7687: X<idrget()>
7688: B<idrget($udom,@unames)>: find the IDs behind a list of
7689: usernames (returns hash: name=>id,name=>id)
7690:
7691: =item *
7692: X<idput()>
7693: B<idput($udom,%ids)>: store away a list of names and associated IDs
7694:
7695: =item *
7696: X<rolesinit()>
7697: B<rolesinit($udom,$username,$authhost)>: get user privileges
7698:
7699: =item *
7700: X<getsection()>
7701: B<getsection($udom,$uname,$cname)>: finds the section of student in the
7702: course $cname, return section name/number or '' for "not in course"
7703: and '-1' for "no section"
7704:
7705: =item *
7706: X<userenvironment()>
7707: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
7708: passed in @what from the requested user's environment, returns a hash
7709:
7710: =back
7711:
7712: =head2 User Roles
7713:
7714: =over 4
7715:
7716: =item *
7717:
7718: allowed($priv,$uri,$symb) : check for a user privilege; returns codes for allowed actions
7719: F: full access
7720: U,I,K: authentication modes (cxx only)
7721: '': forbidden
7722: 1: user needs to choose course
7723: 2: browse allowed
7724: A: passphrase authentication needed
7725:
7726: =item *
7727:
7728: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7729: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7730: and course level
7731:
7732: =item *
7733:
7734: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7735: explanation of a user role term
7736:
7737: =back
7738:
7739: =head2 User Modification
7740:
7741: =over 4
7742:
7743: =item *
7744:
7745: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7746: user for the level given by URL. Optional start and end dates (leave empty
7747: string or zero for "no date")
7748:
7749: =item *
7750:
7751: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7752: change a users, password, possible return values are: ok,
7753: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7754: refused
7755:
7756: =item *
7757:
7758: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
7759:
7760: =item *
7761:
7762: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7763: modify user
7764:
7765: =item *
7766:
7767: modifystudent
7768:
7769: modify a students enrollment and identification information.
7770: The course id is resolved based on the current users environment.
7771: This means the envoking user must be a course coordinator or otherwise
7772: associated with a course.
7773:
7774: This call is essentially a wrapper for lonnet::modifyuser and
7775: lonnet::modify_student_enrollment
7776:
7777: Inputs:
7778:
7779: =over 4
7780:
7781: =item B<$udom> Students loncapa domain
7782:
7783: =item B<$uname> Students loncapa login name
7784:
7785: =item B<$uid> Students id/student number
7786:
7787: =item B<$umode> Students authentication mode
7788:
7789: =item B<$upass> Students password
7790:
7791: =item B<$first> Students first name
7792:
7793: =item B<$middle> Students middle name
7794:
7795: =item B<$last> Students last name
7796:
7797: =item B<$gene> Students generation
7798:
7799: =item B<$usec> Students section in course
7800:
7801: =item B<$end> Unix time of the roles expiration
7802:
7803: =item B<$start> Unix time of the roles start date
7804:
7805: =item B<$forceid> If defined, allow $uid to be changed
7806:
7807: =item B<$desiredhome> server to use as home server for student
7808:
7809: =back
7810:
7811: =item *
7812:
7813: modify_student_enrollment
7814:
7815: Change a students enrollment status in a class. The environment variable
7816: 'role.request.course' must be defined for this function to proceed.
7817:
7818: Inputs:
7819:
7820: =over 4
7821:
7822: =item $udom, students domain
7823:
7824: =item $uname, students name
7825:
7826: =item $uid, students user id
7827:
7828: =item $first, students first name
7829:
7830: =item $middle
7831:
7832: =item $last
7833:
7834: =item $gene
7835:
7836: =item $usec
7837:
7838: =item $end
7839:
7840: =item $start
7841:
7842: =back
7843:
7844:
7845: =item *
7846:
7847: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7848: custom role; give a custom role to a user for the level given by URL. Specify
7849: name and domain of role author, and role name
7850:
7851: =item *
7852:
7853: revokerole($udom,$uname,$url,$role) : revoke a role for url
7854:
7855: =item *
7856:
7857: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7858:
7859: =back
7860:
7861: =head2 Course Infomation
7862:
7863: =over 4
7864:
7865: =item *
7866:
7867: coursedescription($courseid) : returns a hash of information about the
7868: specified course id, including all environment settings for the
7869: course, the description of the course will be in the hash under the
7870: key 'description'
7871:
7872: =item *
7873:
7874: resdata($name,$domain,$type,@which) : request for current parameter
7875: setting for a specific $type, where $type is either 'course' or 'user',
7876: @what should be a list of parameters to ask about. This routine caches
7877: answers for 5 minutes.
7878:
7879: =back
7880:
7881: =head2 Course Modification
7882:
7883: =over 4
7884:
7885: =item *
7886:
7887: writecoursepref($courseid,%prefs) : write preferences (environment
7888: database) for a course
7889:
7890: =item *
7891:
7892: createcourse($udom,$description,$url) : make/modify course
7893:
7894: =back
7895:
7896: =head2 Resource Subroutines
7897:
7898: =over 4
7899:
7900: =item *
7901:
7902: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
7903:
7904: =item *
7905:
7906: repcopy($filename) : subscribes to the requested file, and attempts to
7907: replicate from the owning library server, Might return
7908: 'unavailable', 'not_found', 'forbidden', 'ok', or
7909: 'bad_request', also attempts to grab the metadata for the
7910: resource. Expects the local filesystem pathname
7911: (/home/httpd/html/res/....)
7912:
7913: =back
7914:
7915: =head2 Resource Information
7916:
7917: =over 4
7918:
7919: =item *
7920:
7921: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7922: a vairety of different possible values, $varname should be a request
7923: string, and the other parameters can be used to specify who and what
7924: one is asking about.
7925:
7926: Possible values for $varname are environment.lastname (or other item
7927: from the envirnment hash), user.name (or someother aspect about the
7928: user), resource.0.maxtries (or some other part and parameter of a
7929: resource)
7930:
7931: =item *
7932:
7933: directcondval($number) : get current value of a condition; reads from a state
7934: string
7935:
7936: =item *
7937:
7938: condval($condidx) : value of condition index based on state
7939:
7940: =item *
7941:
7942: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7943: resource's metadata, $what should be either a specific key, or either
7944: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7945: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7946:
7947: this function automatically caches all requests
7948:
7949: =item *
7950:
7951: metadata_query($query,$custom,$customshow) : make a metadata query against the
7952: network of library servers; returns file handle of where SQL and regex results
7953: will be stored for query
7954:
7955: =item *
7956:
7957: symbread($filename) : return symbolic list entry (filename argument optional);
7958: returns the data handle
7959:
7960: =item *
7961:
7962: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
7963: a possible symb for the URL in $thisfn, and if is an encryypted
7964: resource that the user accessed using /enc/ returns a 1 on success, 0
7965: on failure, user must be in a course, as it assumes the existance of
7966: the course initial hash, and uses $env('request.course.id'}
7967:
7968:
7969: =item *
7970:
7971: symbclean($symb) : removes versions numbers from a symb, returns the
7972: cleaned symb
7973:
7974: =item *
7975:
7976: is_on_map($uri) : checks if the $uri is somewhere on the current
7977: course map, user must be in a course for it to work.
7978:
7979: =item *
7980:
7981: numval($salt) : return random seed value (addend for rndseed)
7982:
7983: =item *
7984:
7985: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7986: a random seed, all arguments are optional, if they aren't sent it uses the
7987: environment to derive them. Note: if symb isn't sent and it can't get one
7988: from &symbread it will use the current time as its return value
7989:
7990: =item *
7991:
7992: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7993: unfakeable, receipt
7994:
7995: =item *
7996:
7997: receipt() : API to ireceipt working off of env values; given out to users
7998:
7999: =item *
8000:
8001: countacc($url) : count the number of accesses to a given URL
8002:
8003: =item *
8004:
8005: 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
8006:
8007: =item *
8008:
8009: 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)
8010:
8011: =item *
8012:
8013: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
8014:
8015: =item *
8016:
8017: devalidate($symb) : devalidate temporary spreadsheet calculations,
8018: forcing spreadsheet to reevaluate the resource scores next time.
8019:
8020: =back
8021:
8022: =head2 Storing/Retreiving Data
8023:
8024: =over 4
8025:
8026: =item *
8027:
8028: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
8029: for this url; hashref needs to be given and should be a \%hashname; the
8030: remaining args aren't required and if they aren't passed or are '' they will
8031: be derived from the env
8032:
8033: =item *
8034:
8035: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
8036: uses critical subroutine
8037:
8038: =item *
8039:
8040: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
8041: all args are optional
8042:
8043: =item *
8044:
8045: dumpstore($namespace,$udom,$uname,$regexp,$range) :
8046: dumps the complete (or key matching regexp) namespace into a hash
8047: ($udom, $uname, $regexp, $range are optional) for a namespace that is
8048: normally &store()ed into
8049:
8050: $range should be either an integer '100' (give me the first 100
8051: matching records)
8052: or be two integers sperated by a - with no spaces
8053: '30-50' (give me the 30th through the 50th matching
8054: records)
8055:
8056:
8057: =item *
8058:
8059: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
8060: replaces a &store() version of data with a replacement set of data
8061: for a particular resource in a namespace passed in the $storehash hash
8062: reference
8063:
8064: =item *
8065:
8066: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
8067: works very similar to store/cstore, but all data is stored in a
8068: temporary location and can be reset using tmpreset, $storehash should
8069: be a hash reference, returns nothing on success
8070:
8071: =item *
8072:
8073: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
8074: similar to restore, but all data is stored in a temporary location and
8075: can be reset using tmpreset. Returns a hash of values on success,
8076: error string otherwise.
8077:
8078: =item *
8079:
8080: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
8081: deltes all keys for $symb form the temporary storage hash.
8082:
8083: =item *
8084:
8085: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8086: reference filled in from namesp ($udom and $uname are optional)
8087:
8088: =item *
8089:
8090: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
8091: namesp ($udom and $uname are optional)
8092:
8093: =item *
8094:
8095: dump($namespace,$udom,$uname,$regexp,$range) :
8096: dumps the complete (or key matching regexp) namespace into a hash
8097: ($udom, $uname, $regexp, $range are optional)
8098:
8099: $range should be either an integer '100' (give me the first 100
8100: matching records)
8101: or be two integers sperated by a - with no spaces
8102: '30-50' (give me the 30th through the 50th matching
8103: records)
8104: =item *
8105:
8106: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
8107: $store can be a scalar, an array reference, or if the amount to be
8108: incremented is > 1, a hash reference.
8109:
8110: ($udom and $uname are optional)
8111:
8112: =item *
8113:
8114: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
8115: ($udom and $uname are optional)
8116:
8117: =item *
8118:
8119: cput($namespace,$storehash,$udom,$uname) : critical put
8120: ($udom and $uname are optional)
8121:
8122: =item *
8123:
8124: newput($namespace,$storehash,$udom,$uname) :
8125:
8126: Attempts to store the items in the $storehash, but only if they don't
8127: currently exist, if this succeeds you can be certain that you have
8128: successfully created a new key value pair in the $namespace db.
8129:
8130:
8131: Args:
8132: $namespace: name of database to store values to
8133: $storehash: hashref to store to the db
8134: $udom: (optional) domain of user containing the db
8135: $uname: (optional) name of user caontaining the db
8136:
8137: Returns:
8138: 'ok' -> succeeded in storing all keys of $storehash
8139: 'key_exists: <key>' -> failed to anything out of $storehash, as at
8140: least <key> already existed in the db (other
8141: requested keys may also already exist)
8142: 'error: <msg>' -> unable to tie the DB or other erorr occured
8143: 'con_lost' -> unable to contact request server
8144: 'refused' -> action was not allowed by remote machine
8145:
8146:
8147: =item *
8148:
8149: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8150: reference filled in from namesp (encrypts the return communication)
8151: ($udom and $uname are optional)
8152:
8153: =item *
8154:
8155: log($udom,$name,$home,$message) : write to permanent log for user; use
8156: critical subroutine
8157:
8158: =item *
8159:
8160: get_dom($namespace,$storearr,$udomain) : returns hash with keys from array
8161: reference filled in from namespace found in domain level on primary domain server ($udomain is optional)
8162:
8163: =item *
8164:
8165: put_dom($namespace,$storehash,$udomain) : stores hash in namespace at domain level on primary domain server ($udomain is optional)
8166:
8167: =back
8168:
8169: =head2 Network Status Functions
8170:
8171: =over 4
8172:
8173: =item *
8174:
8175: dirlist($uri) : return directory list based on URI
8176:
8177: =item *
8178:
8179: spareserver() : find server with least workload from spare.tab
8180:
8181: =back
8182:
8183: =head2 Apache Request
8184:
8185: =over 4
8186:
8187: =item *
8188:
8189: ssi($url,%hash) : server side include, does a complete request cycle on url to
8190: localhost, posts hash
8191:
8192: =back
8193:
8194: =head2 Data to String to Data
8195:
8196: =over 4
8197:
8198: =item *
8199:
8200: hash2str(%hash) : convert a hash into a string complete with escaping and '='
8201: and '&' separators, supports elements that are arrayrefs and hashrefs
8202:
8203: =item *
8204:
8205: hashref2str($hashref) : convert a hashref into a string complete with
8206: escaping and '=' and '&' separators, supports elements that are
8207: arrayrefs and hashrefs
8208:
8209: =item *
8210:
8211: arrayref2str($arrayref) : convert an arrayref into a string complete
8212: with escaping and '&' separators, supports elements that are arrayrefs
8213: and hashrefs
8214:
8215: =item *
8216:
8217: str2hash($string) : convert string to hash using unescaping and
8218: splitting on '=' and '&', supports elements that are arrayrefs and
8219: hashrefs
8220:
8221: =item *
8222:
8223: str2array($string) : convert string to hash using unescaping and
8224: splitting on '&', supports elements that are arrayrefs and hashrefs
8225:
8226: =back
8227:
8228: =head2 Logging Routines
8229:
8230: =over 4
8231:
8232: These routines allow one to make log messages in the lonnet.log and
8233: lonnet.perm logfiles.
8234:
8235: =item *
8236:
8237: logtouch() : make sure the logfile, lonnet.log, exists
8238:
8239: =item *
8240:
8241: logthis() : append message to the normal lonnet.log file, it gets
8242: preiodically rolled over and deleted.
8243:
8244: =item *
8245:
8246: logperm() : append a permanent message to lonnet.perm.log, this log
8247: file never gets deleted by any automated portion of the system, only
8248: messages of critical importance should go in here.
8249:
8250: =back
8251:
8252: =head2 General File Helper Routines
8253:
8254: =over 4
8255:
8256: =item *
8257:
8258: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
8259: (a) files in /uploaded
8260: (i) If a local copy of the file exists -
8261: compares modification date of local copy with last-modified date for
8262: definitive version stored on home server for course. If local copy is
8263: stale, requests a new version from the home server and stores it.
8264: If the original has been removed from the home server, then local copy
8265: is unlinked.
8266: (ii) If local copy does not exist -
8267: requests the file from the home server and stores it.
8268:
8269: If $caller is 'uploadrep':
8270: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
8271: for request for files originally uploaded via DOCS.
8272: - returns 'ok' if fresh local copy now available, -1 otherwise.
8273:
8274: Otherwise:
8275: This indicates a call from the content generation phase of the request.
8276: - returns the entire contents of the file or -1.
8277:
8278: (b) files in /res
8279: - returns the entire contents of a file or -1;
8280: it properly subscribes to and replicates the file if neccessary.
8281:
8282:
8283: =item *
8284:
8285: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
8286: reference
8287:
8288: returns either a stat() list of data about the file or an empty list
8289: if the file doesn't exist or couldn't find out about it (connection
8290: problems or user unknown)
8291:
8292: =item *
8293:
8294: filelocation($dir,$file) : returns file system location of a file
8295: based on URI; meant to be "fairly clean" absolute reference, $dir is a
8296: directory that relative $file lookups are to looked in ($dir of /a/dir
8297: and a file of ../bob will become /a/bob)
8298:
8299: =item *
8300:
8301: hreflocation($dir,$file) : returns file system location or a URL; same as
8302: filelocation except for hrefs
8303:
8304: =item *
8305:
8306: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
8307:
8308: =back
8309:
8310: =head2 Usererfile file routines (/uploaded*)
8311:
8312: =over 4
8313:
8314: =item *
8315:
8316: userfileupload(): main rotine for putting a file in a user or course's
8317: filespace, arguments are,
8318:
8319: formname - required - this is the name of the element in $env where the
8320: filename, and the contents of the file to create/modifed exist
8321: the filename is in $env{'form.'.$formname.'.filename'} and the
8322: contents of the file is located in $env{'form.'.$formname}
8323: coursedoc - if true, store the file in the course of the active role
8324: of the current user
8325: subdir - required - subdirectory to put the file in under ../userfiles/
8326: if undefined, it will be placed in "unknown"
8327:
8328: (This routine calls clean_filename() to remove any dangerous
8329: characters from the filename, and then calls finuserfileupload() to
8330: complete the transaction)
8331:
8332: returns either the url of the uploaded file (/uploaded/....) if successful
8333: and /adm/notfound.html if unsuccessful
8334:
8335: =item *
8336:
8337: clean_filename(): routine for cleaing a filename up for storage in
8338: userfile space, argument is:
8339:
8340: filename - proposed filename
8341:
8342: returns: the new clean filename
8343:
8344: =item *
8345:
8346: finishuserfileupload(): routine that creaes and sends the file to
8347: userspace, probably shouldn't be called directly
8348:
8349: docuname: username or courseid of destination for the file
8350: docudom: domain of user/course of destination for the file
8351: formname: same as for userfileupload()
8352: fname: filename (inculding subdirectories) for the file
8353:
8354: returns either the url of the uploaded file (/uploaded/....) if successful
8355: and /adm/notfound.html if unsuccessful
8356:
8357: =item *
8358:
8359: renameuserfile(): renames an existing userfile to a new name
8360:
8361: Args:
8362: docuname: username or courseid of destination for the file
8363: docudom: domain of user/course of destination for the file
8364: old: current file name (including any subdirs under userfiles)
8365: new: desired file name (including any subdirs under userfiles)
8366:
8367: =item *
8368:
8369: mkdiruserfile(): creates a directory is a userfiles dir
8370:
8371: Args:
8372: docuname: username or courseid of destination for the file
8373: docudom: domain of user/course of destination for the file
8374: dir: dir to create (including any subdirs under userfiles)
8375:
8376: =item *
8377:
8378: removeuserfile(): removes a file that exists in userfiles
8379:
8380: Args:
8381: docuname: username or courseid of destination for the file
8382: docudom: domain of user/course of destination for the file
8383: fname: filname to delete (including any subdirs under userfiles)
8384:
8385: =item *
8386:
8387: removeuploadedurl(): convience function for removeuserfile()
8388:
8389: Args:
8390: url: a full /uploaded/... url to delete
8391:
8392: =item *
8393:
8394: get_portfile_permissions():
8395: Args:
8396: domain: domain of user or course contain the portfolio files
8397: user: name of user or num of course contain the portfolio files
8398: Returns:
8399: hashref of a dump of the proper file_permissions.db
8400:
8401:
8402: =item *
8403:
8404: get_access_controls():
8405:
8406: Args:
8407: current_permissions: the hash ref returned from get_portfile_permissions()
8408: group: (optional) the group you want the files associated with
8409: file: (optional) the file you want access info on
8410:
8411: Returns:
8412: a hash (keys are file names) of hashes containing
8413: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8414: values are XML containing access control settings (see below)
8415:
8416: Internal notes:
8417:
8418: access controls are stored in file_permissions.db as key=value pairs.
8419: key -> path to file/file_name\0uniqueID:scope_end_start
8420: where scope -> public,guest,course,group,domains or users.
8421: end -> UNIX time for end of access (0 -> no end date)
8422: start -> UNIX time for start of access
8423:
8424: value -> XML description of access control
8425: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8426: <start></start>
8427: <end></end>
8428:
8429: <password></password> for scope type = guest
8430:
8431: <domain></domain> for scope type = course or group
8432: <number></number>
8433: <roles id="">
8434: <role></role>
8435: <access></access>
8436: <section></section>
8437: <group></group>
8438: </roles>
8439:
8440: <dom></dom> for scope type = domains
8441:
8442: <users> for scope type = users
8443: <user>
8444: <uname></uname>
8445: <udom></udom>
8446: </user>
8447: </users>
8448: </scope>
8449:
8450: Access data is also aggregated for each file in an additional key=value pair:
8451: key -> path to file/file_name\0accesscontrol
8452: value -> reference to hash
8453: hash contains key = value pairs
8454: where key = uniqueID:scope_end_start
8455: value = UNIX time record was last updated
8456:
8457: Used to improve speed of look-ups of access controls for each file.
8458:
8459: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8460:
8461: modify_access_controls():
8462:
8463: Modifies access controls for a portfolio file
8464: Args
8465: 1. file name
8466: 2. reference to hash of required changes,
8467: 3. domain
8468: 4. username
8469: where domain,username are the domain of the portfolio owner
8470: (either a user or a course)
8471:
8472: Returns:
8473: 1. result of additions or updates ('ok' or 'error', with error message).
8474: 2. result of deletions ('ok' or 'error', with error message).
8475: 3. reference to hash of any new or updated access controls.
8476: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8477: key = integer (inbound ID)
8478: value = uniqueID
8479:
8480: =back
8481:
8482: =head2 HTTP Helper Routines
8483:
8484: =over 4
8485:
8486: =item *
8487:
8488: escape() : unpack non-word characters into CGI-compatible hex codes
8489:
8490: =item *
8491:
8492: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8493:
8494: =back
8495:
8496: =head1 PRIVATE SUBROUTINES
8497:
8498: =head2 Underlying communication routines (Shouldn't call)
8499:
8500: =over 4
8501:
8502: =item *
8503:
8504: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8505:
8506: =item *
8507:
8508: reply() : uses subreply to send a message to remote machine, logs all failures
8509:
8510: =item *
8511:
8512: critical() : passes a critical message to another server; if cannot
8513: get through then place message in connection buffer directory and
8514: returns con_delayed, if incapable of saving message, returns
8515: con_failed
8516:
8517: =item *
8518:
8519: reconlonc() : tries to reconnect lonc client processes.
8520:
8521: =back
8522:
8523: =head2 Resource Access Logging
8524:
8525: =over 4
8526:
8527: =item *
8528:
8529: flushcourselogs() : flush (save) buffer logs and access logs
8530:
8531: =item *
8532:
8533: courselog($what) : save message for course in hash
8534:
8535: =item *
8536:
8537: courseacclog($what) : save message for course using &courselog(). Perform
8538: special processing for specific resource types (problems, exams, quizzes, etc).
8539:
8540: =item *
8541:
8542: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8543: as a PerlChildExitHandler
8544:
8545: =back
8546:
8547: =head2 Other
8548:
8549: =over 4
8550:
8551: =item *
8552:
8553: symblist($mapname,%newhash) : update symbolic storage links
8554:
8555: =back
8556:
8557: =cut
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