File:
[LON-CAPA] /
loncom /
lonnet /
perl /
lonnet.pm
Revision
1.799:
download - view:
text,
annotated -
select for diffs
Mon Oct 23 21:22:44 2006 UTC (17 years, 8 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
Allow internally authenticated users who have forgotten their password access to set a new one based on a token sent to an e-mail account associated with their LON-CAPA account. Future mods: strengthen challenge by asking for student ID? Use less deterministic token ID from lond::tmpput() - MD5 hash?
1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.799 2006/10/23 21:22:44 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;
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=~s/\W//g;
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 (@unames) {
668: $returnhash{$_}=(&userenvironment($udom,$_,'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 (keys %ids) {
679: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
680: my $uhom=&homeserver($_,$udom);
681: if ($uhom ne 'no_host') {
682: my $id=&escape($ids{$_});
683: $id=~tr/A-Z/a-z/;
684: my $unam=&escape($_);
685: if ($servers{$uhom}) {
686: $servers{$uhom}.='&'.$id.'='.$unam;
687: } else {
688: $servers{$uhom}=$id.'='.$unam;
689: }
690: }
691: }
692: foreach (keys %servers) {
693: &critical('idput:'.$udom.':'.$servers{$_},$_);
694: }
695: }
696:
697: # --------------------------------------------------- Assign a key to a student
698:
699: sub assign_access_key {
700: #
701: # a valid key looks like uname:udom#comments
702: # comments are being appended
703: #
704: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
705: $kdom=
706: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
707: $knum=
708: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
709: $cdom=
710: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
711: $cnum=
712: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
713: $udom=$env{'user.name'} unless (defined($udom));
714: $uname=$env{'user.domain'} unless (defined($uname));
715: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
716: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
717: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
718: # assigned to this person
719: # - this should not happen,
720: # unless something went wrong
721: # the first time around
722: # ready to assign
723: $logentry=$1.'; '.$logentry;
724: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
725: $kdom,$knum) eq 'ok') {
726: # key now belongs to user
727: my $envkey='key.'.$cdom.'_'.$cnum;
728: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
729: &appenv('environment.'.$envkey => $ckey);
730: return 'ok';
731: } else {
732: return
733: 'error: Count not permanently assign key, will need to be re-entered later.';
734: }
735: } else {
736: return 'error: Could not assign key, try again later.';
737: }
738: } elsif (!$existing{$ckey}) {
739: # the key does not exist
740: return 'error: The key does not exist';
741: } else {
742: # the key is somebody else's
743: return 'error: The key is already in use';
744: }
745: }
746:
747: # ------------------------------------------ put an additional comment on a key
748:
749: sub comment_access_key {
750: #
751: # a valid key looks like uname:udom#comments
752: # comments are being appended
753: #
754: my ($ckey,$cdom,$cnum,$logentry)=@_;
755: $cdom=
756: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
757: $cnum=
758: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
759: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
760: if ($existing{$ckey}) {
761: $existing{$ckey}.='; '.$logentry;
762: # ready to assign
763: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
764: $cdom,$cnum) eq 'ok') {
765: return 'ok';
766: } else {
767: return 'error: Count not store comment.';
768: }
769: } else {
770: # the key does not exist
771: return 'error: The key does not exist';
772: }
773: }
774:
775: # ------------------------------------------------------ Generate a set of keys
776:
777: sub generate_access_keys {
778: my ($number,$cdom,$cnum,$logentry)=@_;
779: $cdom=
780: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
781: $cnum=
782: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
783: unless (&allowed('mky',$cdom)) { return 0; }
784: unless (($cdom) && ($cnum)) { return 0; }
785: if ($number>10000) { return 0; }
786: sleep(2); # make sure don't get same seed twice
787: srand(time()^($$+($$<<15))); # from "Programming Perl"
788: my $total=0;
789: for (my $i=1;$i<=$number;$i++) {
790: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
791: sprintf("%lx",int(100000*rand)).'-'.
792: sprintf("%lx",int(100000*rand));
793: $newkey=~s/1/g/g; # folks mix up 1 and l
794: $newkey=~s/0/h/g; # and also 0 and O
795: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
796: if ($existing{$newkey}) {
797: $i--;
798: } else {
799: if (&put('accesskeys',
800: { $newkey => '# generated '.localtime().
801: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
802: '; '.$logentry },
803: $cdom,$cnum) eq 'ok') {
804: $total++;
805: }
806: }
807: }
808: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
809: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
810: return $total;
811: }
812:
813: # ------------------------------------------------------- Validate an accesskey
814:
815: sub validate_access_key {
816: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
817: $cdom=
818: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
819: $cnum=
820: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
821: $udom=$env{'user.domain'} unless (defined($udom));
822: $uname=$env{'user.name'} unless (defined($uname));
823: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
824: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
825: }
826:
827: # ------------------------------------- Find the section of student in a course
828: sub devalidate_getsection_cache {
829: my ($udom,$unam,$courseid)=@_;
830: $courseid=~s/\_/\//g;
831: $courseid=~s/^(\w)/\/$1/;
832: my $hashid="$udom:$unam:$courseid";
833: &devalidate_cache_new('getsection',$hashid);
834: }
835:
836: sub getsection {
837: my ($udom,$unam,$courseid)=@_;
838: my $cachetime=1800;
839: $courseid=~s/\_/\//g;
840: $courseid=~s/^(\w)/\/$1/;
841:
842: my $hashid="$udom:$unam:$courseid";
843: my ($result,$cached)=&is_cached_new('getsection',$hashid);
844: if (defined($cached)) { return $result; }
845:
846: my %Pending;
847: my %Expired;
848: #
849: # Each role can either have not started yet (pending), be active,
850: # or have expired.
851: #
852: # If there is an active role, we are done.
853: #
854: # If there is more than one role which has not started yet,
855: # choose the one which will start sooner
856: # If there is one role which has not started yet, return it.
857: #
858: # If there is more than one expired role, choose the one which ended last.
859: # If there is a role which has expired, return it.
860: #
861: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
862: &homeserver($unam,$udom)))) {
863: my ($key,$value)=split(/\=/,$_);
864: $key=&unescape($key);
865: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
866: my $section=$1;
867: if ($key eq $courseid.'_st') { $section=''; }
868: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
869: my $now=time;
870: if (defined($end) && $end && ($now > $end)) {
871: $Expired{$end}=$section;
872: next;
873: }
874: if (defined($start) && $start && ($now < $start)) {
875: $Pending{$start}=$section;
876: next;
877: }
878: return &do_cache_new('getsection',$hashid,$section,$cachetime);
879: }
880: #
881: # Presumedly there will be few matching roles from the above
882: # loop and the sorting time will be negligible.
883: if (scalar(keys(%Pending))) {
884: my ($time) = sort {$a <=> $b} keys(%Pending);
885: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
886: }
887: if (scalar(keys(%Expired))) {
888: my @sorted = sort {$a <=> $b} keys(%Expired);
889: my $time = pop(@sorted);
890: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
891: }
892: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
893: }
894:
895: sub save_cache {
896: &purge_remembered();
897: #&Apache::loncommon::validate_page();
898: undef(%env);
899: undef($env_loaded);
900: }
901:
902: my $to_remember=-1;
903: my %remembered;
904: my %accessed;
905: my $kicks=0;
906: my $hits=0;
907: sub devalidate_cache_new {
908: my ($name,$id,$debug) = @_;
909: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
910: $id=&escape($name.':'.$id);
911: $memcache->delete($id);
912: delete($remembered{$id});
913: delete($accessed{$id});
914: }
915:
916: sub is_cached_new {
917: my ($name,$id,$debug) = @_;
918: $id=&escape($name.':'.$id);
919: if (exists($remembered{$id})) {
920: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
921: $accessed{$id}=[&gettimeofday()];
922: $hits++;
923: return ($remembered{$id},1);
924: }
925: my $value = $memcache->get($id);
926: if (!(defined($value))) {
927: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
928: return (undef,undef);
929: }
930: if ($value eq '__undef__') {
931: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
932: $value=undef;
933: }
934: &make_room($id,$value,$debug);
935: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
936: return ($value,1);
937: }
938:
939: sub do_cache_new {
940: my ($name,$id,$value,$time,$debug) = @_;
941: $id=&escape($name.':'.$id);
942: my $setvalue=$value;
943: if (!defined($setvalue)) {
944: $setvalue='__undef__';
945: }
946: if (!defined($time) ) {
947: $time=600;
948: }
949: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
950: $memcache->set($id,$setvalue,$time);
951: # need to make a copy of $value
952: #&make_room($id,$value,$debug);
953: return $value;
954: }
955:
956: sub make_room {
957: my ($id,$value,$debug)=@_;
958: $remembered{$id}=$value;
959: if ($to_remember<0) { return; }
960: $accessed{$id}=[&gettimeofday()];
961: if (scalar(keys(%remembered)) <= $to_remember) { return; }
962: my $to_kick;
963: my $max_time=0;
964: foreach my $other (keys(%accessed)) {
965: if (&tv_interval($accessed{$other}) > $max_time) {
966: $to_kick=$other;
967: $max_time=&tv_interval($accessed{$other});
968: }
969: }
970: delete($remembered{$to_kick});
971: delete($accessed{$to_kick});
972: $kicks++;
973: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
974: return;
975: }
976:
977: sub purge_remembered {
978: #&logthis("Tossing ".scalar(keys(%remembered)));
979: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
980: undef(%remembered);
981: undef(%accessed);
982: }
983: # ------------------------------------- Read an entry from a user's environment
984:
985: sub userenvironment {
986: my ($udom,$unam,@what)=@_;
987: my %returnhash=();
988: my @answer=split(/\&/,
989: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
990: &homeserver($unam,$udom)));
991: my $i;
992: for ($i=0;$i<=$#what;$i++) {
993: $returnhash{$what[$i]}=&unescape($answer[$i]);
994: }
995: return %returnhash;
996: }
997:
998: # ---------------------------------------------------------- Get a studentphoto
999: sub studentphoto {
1000: my ($udom,$unam,$ext) = @_;
1001: my $home=&Apache::lonnet::homeserver($unam,$udom);
1002: if (defined($env{'request.course.id'})) {
1003: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1004: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1005: return(&retrievestudentphoto($udom,$unam,$ext));
1006: } else {
1007: my ($result,$perm_reqd)=
1008: &Apache::lonnet::auto_photo_permission($unam,$udom);
1009: if ($result eq 'ok') {
1010: if (!($perm_reqd eq 'yes')) {
1011: return(&retrievestudentphoto($udom,$unam,$ext));
1012: }
1013: }
1014: }
1015: }
1016: } else {
1017: my ($result,$perm_reqd) =
1018: &Apache::lonnet::auto_photo_permission($unam,$udom);
1019: if ($result eq 'ok') {
1020: if (!($perm_reqd eq 'yes')) {
1021: return(&retrievestudentphoto($udom,$unam,$ext));
1022: }
1023: }
1024: }
1025: return '/adm/lonKaputt/lonlogo_broken.gif';
1026: }
1027:
1028: sub retrievestudentphoto {
1029: my ($udom,$unam,$ext,$type) = @_;
1030: my $home=&Apache::lonnet::homeserver($unam,$udom);
1031: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1032: if ($ret eq 'ok') {
1033: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1034: if ($type eq 'thumbnail') {
1035: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1036: }
1037: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1038: return $tokenurl;
1039: } else {
1040: if ($type eq 'thumbnail') {
1041: return '/adm/lonKaputt/genericstudent_tn.gif';
1042: } else {
1043: return '/adm/lonKaputt/lonlogo_broken.gif';
1044: }
1045: }
1046: }
1047:
1048: # -------------------------------------------------------------------- New chat
1049:
1050: sub chatsend {
1051: my ($newentry,$anon,$group)=@_;
1052: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1053: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1054: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1055: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1056: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1057: &escape($newentry)).':'.$group,$chome);
1058: }
1059:
1060: # ------------------------------------------ Find current version of a resource
1061:
1062: sub getversion {
1063: my $fname=&clutter(shift);
1064: unless ($fname=~/^\/res\//) { return -1; }
1065: return ¤tversion(&filelocation('',$fname));
1066: }
1067:
1068: sub currentversion {
1069: my $fname=shift;
1070: my ($result,$cached)=&is_cached_new('resversion',$fname);
1071: if (defined($cached)) { return $result; }
1072: my $author=$fname;
1073: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1074: my ($udom,$uname)=split(/\//,$author);
1075: my $home=homeserver($uname,$udom);
1076: if ($home eq 'no_host') {
1077: return -1;
1078: }
1079: my $answer=reply("currentversion:$fname",$home);
1080: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1081: return -1;
1082: }
1083: return &do_cache_new('resversion',$fname,$answer,600);
1084: }
1085:
1086: # ----------------------------- Subscribe to a resource, return URL if possible
1087:
1088: sub subscribe {
1089: my $fname=shift;
1090: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1091: $fname=~s/[\n\r]//g;
1092: my $author=$fname;
1093: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1094: my ($udom,$uname)=split(/\//,$author);
1095: my $home=homeserver($uname,$udom);
1096: if ($home eq 'no_host') {
1097: return 'not_found';
1098: }
1099: my $answer=reply("sub:$fname",$home);
1100: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1101: $answer.=' by '.$home;
1102: }
1103: return $answer;
1104: }
1105:
1106: # -------------------------------------------------------------- Replicate file
1107:
1108: sub repcopy {
1109: my $filename=shift;
1110: $filename=~s/\/+/\//g;
1111: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1112: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1113: if ($filename=~m|^/home/httpd/html/userfiles/| or
1114: $filename=~m -^/*(uploaded|editupload)/-) {
1115: return &repcopy_userfile($filename);
1116: }
1117: $filename=~s/[\n\r]//g;
1118: my $transname="$filename.in.transfer";
1119: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1120: my $remoteurl=subscribe($filename);
1121: if ($remoteurl =~ /^con_lost by/) {
1122: &logthis("Subscribe returned $remoteurl: $filename");
1123: return 'unavailable';
1124: } elsif ($remoteurl eq 'not_found') {
1125: #&logthis("Subscribe returned not_found: $filename");
1126: return 'not_found';
1127: } elsif ($remoteurl =~ /^rejected by/) {
1128: &logthis("Subscribe returned $remoteurl: $filename");
1129: return 'forbidden';
1130: } elsif ($remoteurl eq 'directory') {
1131: return 'ok';
1132: } else {
1133: my $author=$filename;
1134: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1135: my ($udom,$uname)=split(/\//,$author);
1136: my $home=homeserver($uname,$udom);
1137: unless ($home eq $perlvar{'lonHostID'}) {
1138: my @parts=split(/\//,$filename);
1139: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1140: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1141: &logthis("Malconfiguration for replication: $filename");
1142: return 'bad_request';
1143: }
1144: my $count;
1145: for ($count=5;$count<$#parts;$count++) {
1146: $path.="/$parts[$count]";
1147: if ((-e $path)!=1) {
1148: mkdir($path,0777);
1149: }
1150: }
1151: my $ua=new LWP::UserAgent;
1152: my $request=new HTTP::Request('GET',"$remoteurl");
1153: my $response=$ua->request($request,$transname);
1154: if ($response->is_error()) {
1155: unlink($transname);
1156: my $message=$response->status_line;
1157: &logthis("<font color=\"blue\">WARNING:"
1158: ." LWP get: $message: $filename</font>");
1159: return 'unavailable';
1160: } else {
1161: if ($remoteurl!~/\.meta$/) {
1162: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1163: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1164: if ($mresponse->is_error()) {
1165: unlink($filename.'.meta');
1166: &logthis(
1167: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1168: }
1169: }
1170: rename($transname,$filename);
1171: return 'ok';
1172: }
1173: }
1174: }
1175: }
1176:
1177: # ------------------------------------------------ Get server side include body
1178: sub ssi_body {
1179: my ($filelink,%form)=@_;
1180: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1181: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1182: }
1183: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1184: &ssi($filelink,%form));
1185: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1186: $output=~s/^.*?\<body[^\>]*\>//si;
1187: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1188: return $output;
1189: }
1190:
1191: # --------------------------------------------------------- Server Side Include
1192:
1193: sub absolute_url {
1194: my ($host_name) = @_;
1195: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1196: if ($host_name eq '') {
1197: $host_name = $ENV{'SERVER_NAME'};
1198: }
1199: return $protocol.$host_name;
1200: }
1201:
1202: sub ssi {
1203:
1204: my ($fn,%form)=@_;
1205:
1206: my $ua=new LWP::UserAgent;
1207:
1208: my $request;
1209:
1210: $form{'no_update_last_known'}=1;
1211:
1212: if (%form) {
1213: $request=new HTTP::Request('POST',&absolute_url().$fn);
1214: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1215: } else {
1216: $request=new HTTP::Request('GET',&absolute_url().$fn);
1217: }
1218:
1219: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1220: my $response=$ua->request($request);
1221:
1222: return $response->content;
1223: }
1224:
1225: sub externalssi {
1226: my ($url)=@_;
1227: my $ua=new LWP::UserAgent;
1228: my $request=new HTTP::Request('GET',$url);
1229: my $response=$ua->request($request);
1230: return $response->content;
1231: }
1232:
1233: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1234:
1235: sub allowuploaded {
1236: my ($srcurl,$url)=@_;
1237: $url=&clutter(&declutter($url));
1238: my $dir=$url;
1239: $dir=~s/\/[^\/]+$//;
1240: my %httpref=();
1241: my $httpurl=&hreflocation('',$url);
1242: $httpref{'httpref.'.$httpurl}=$srcurl;
1243: &Apache::lonnet::appenv(%httpref);
1244: }
1245:
1246: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1247: # input: action, courseID, current domain, intended
1248: # path to file, source of file, instruction to parse file for objects,
1249: # ref to hash for embedded objects,
1250: # ref to hash for codebase of java objects.
1251: #
1252: # output: url to file (if action was uploaddoc),
1253: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1254: #
1255: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1256: # course.
1257: #
1258: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1259: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1260: # course's home server.
1261: #
1262: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1263: # be copied from $source (current location) to
1264: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1265: # and will then be copied to
1266: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1267: # course's home server.
1268: #
1269: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1270: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1271: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1272: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1273: # in course's home server.
1274: #
1275:
1276: sub process_coursefile {
1277: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1278: my $fetchresult;
1279: my $home=&homeserver($docuname,$docudom);
1280: if ($action eq 'propagate') {
1281: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1282: $home);
1283: } else {
1284: my $fpath = '';
1285: my $fname = $file;
1286: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1287: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1288: my $filepath = &build_filepath($fpath);
1289: if ($action eq 'copy') {
1290: if ($source eq '') {
1291: $fetchresult = 'no source file';
1292: return $fetchresult;
1293: } else {
1294: my $destination = $filepath.'/'.$fname;
1295: rename($source,$destination);
1296: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1297: $home);
1298: }
1299: } elsif ($action eq 'uploaddoc') {
1300: open(my $fh,'>'.$filepath.'/'.$fname);
1301: print $fh $env{'form.'.$source};
1302: close($fh);
1303: if ($parser eq 'parse') {
1304: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1305: unless ($parse_result eq 'ok') {
1306: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1307: }
1308: }
1309: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1310: $home);
1311: if ($fetchresult eq 'ok') {
1312: return '/uploaded/'.$fpath.'/'.$fname;
1313: } else {
1314: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1315: ' to host '.$home.': '.$fetchresult);
1316: return '/adm/notfound.html';
1317: }
1318: }
1319: }
1320: unless ( $fetchresult eq 'ok') {
1321: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1322: ' to host '.$home.': '.$fetchresult);
1323: }
1324: return $fetchresult;
1325: }
1326:
1327: sub build_filepath {
1328: my ($fpath) = @_;
1329: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1330: unless ($fpath eq '') {
1331: my @parts=split('/',$fpath);
1332: foreach my $part (@parts) {
1333: $filepath.= '/'.$part;
1334: if ((-e $filepath)!=1) {
1335: mkdir($filepath,0777);
1336: }
1337: }
1338: }
1339: return $filepath;
1340: }
1341:
1342: sub store_edited_file {
1343: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1344: my $file = $primary_url;
1345: $file =~ s#^/uploaded/$docudom/$docuname/##;
1346: my $fpath = '';
1347: my $fname = $file;
1348: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1349: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1350: my $filepath = &build_filepath($fpath);
1351: open(my $fh,'>'.$filepath.'/'.$fname);
1352: print $fh $content;
1353: close($fh);
1354: my $home=&homeserver($docuname,$docudom);
1355: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1356: $home);
1357: if ($$fetchresult eq 'ok') {
1358: return '/uploaded/'.$fpath.'/'.$fname;
1359: } else {
1360: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1361: ' to host '.$home.': '.$$fetchresult);
1362: return '/adm/notfound.html';
1363: }
1364: }
1365:
1366: sub clean_filename {
1367: my ($fname)=@_;
1368: # Replace Windows backslashes by forward slashes
1369: $fname=~s/\\/\//g;
1370: # Get rid of everything but the actual filename
1371: $fname=~s/^.*\/([^\/]+)$/$1/;
1372: # Replace spaces by underscores
1373: $fname=~s/\s+/\_/g;
1374: # Replace all other weird characters by nothing
1375: $fname=~s/[^\w\.\-]//g;
1376: # Replace all .\d. sequences with _\d. so they no longer look like version
1377: # numbers
1378: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1379: return $fname;
1380: }
1381:
1382: # --------------- Take an uploaded file and put it into the userfiles directory
1383: # input: $formname - the contents of the file are in $env{"form.$formname"}
1384: # the desired filenam is in $env{"form.$formname.filename"}
1385: # $coursedoc - if true up to the current course
1386: # if false
1387: # $subdir - directory in userfile to store the file into
1388: # $parser, $allfiles, $codebase - unknown
1389: #
1390: # output: url of file in userspace, or error: <message>
1391: # or /adm/notfound.html if failure to upload occurse
1392:
1393:
1394: sub userfileupload {
1395: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1396: if (!defined($subdir)) { $subdir='unknown'; }
1397: my $fname=$env{'form.'.$formname.'.filename'};
1398: $fname=&clean_filename($fname);
1399: # See if there is anything left
1400: unless ($fname) { return 'error: no uploaded file'; }
1401: chop($env{'form.'.$formname});
1402: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1403: my $now = time;
1404: my $filepath = 'tmp/helprequests/'.$now;
1405: my @parts=split(/\//,$filepath);
1406: my $fullpath = $perlvar{'lonDaemons'};
1407: for (my $i=0;$i<@parts;$i++) {
1408: $fullpath .= '/'.$parts[$i];
1409: if ((-e $fullpath)!=1) {
1410: mkdir($fullpath,0777);
1411: }
1412: }
1413: open(my $fh,'>'.$fullpath.'/'.$fname);
1414: print $fh $env{'form.'.$formname};
1415: close($fh);
1416: return $fullpath.'/'.$fname;
1417: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1418: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1419: '_'.$env{'user.domain'}.'/pending';
1420: my @parts=split(/\//,$filepath);
1421: my $fullpath = $perlvar{'lonDaemons'};
1422: for (my $i=0;$i<@parts;$i++) {
1423: $fullpath .= '/'.$parts[$i];
1424: if ((-e $fullpath)!=1) {
1425: mkdir($fullpath,0777);
1426: }
1427: }
1428: open(my $fh,'>'.$fullpath.'/'.$fname);
1429: print $fh $env{'form.'.$formname};
1430: close($fh);
1431: return $fullpath.'/'.$fname;
1432: }
1433:
1434: # Create the directory if not present
1435: $fname="$subdir/$fname";
1436: if ($coursedoc) {
1437: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1438: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1439: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1440: return &finishuserfileupload($docuname,$docudom,
1441: $formname,$fname,$parser,$allfiles,
1442: $codebase);
1443: } else {
1444: $fname=$env{'form.folder'}.'/'.$fname;
1445: return &process_coursefile('uploaddoc',$docuname,$docudom,
1446: $fname,$formname,$parser,
1447: $allfiles,$codebase);
1448: }
1449: } elsif (defined($destuname)) {
1450: my $docuname=$destuname;
1451: my $docudom=$destudom;
1452: return &finishuserfileupload($docuname,$docudom,$formname,
1453: $fname,$parser,$allfiles,$codebase);
1454:
1455: } else {
1456: my $docuname=$env{'user.name'};
1457: my $docudom=$env{'user.domain'};
1458: if (exists($env{'form.group'})) {
1459: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1460: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1461: }
1462: return &finishuserfileupload($docuname,$docudom,$formname,
1463: $fname,$parser,$allfiles,$codebase);
1464: }
1465: }
1466:
1467: sub finishuserfileupload {
1468: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1469: my $path=$docudom.'/'.$docuname.'/';
1470: my $filepath=$perlvar{'lonDocRoot'};
1471: my ($fnamepath,$file);
1472: $file=$fname;
1473: if ($fname=~m|/|) {
1474: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1475: $path.=$fnamepath.'/';
1476: }
1477: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1478: my $count;
1479: for ($count=4;$count<=$#parts;$count++) {
1480: $filepath.="/$parts[$count]";
1481: if ((-e $filepath)!=1) {
1482: mkdir($filepath,0777);
1483: }
1484: }
1485: # Save the file
1486: {
1487: if (!open(FH,'>'.$filepath.'/'.$file)) {
1488: &logthis('Failed to create '.$filepath.'/'.$file);
1489: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1490: return '/adm/notfound.html';
1491: }
1492: if (!print FH ($env{'form.'.$formname})) {
1493: &logthis('Failed to write to '.$filepath.'/'.$file);
1494: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1495: return '/adm/notfound.html';
1496: }
1497: close(FH);
1498: }
1499: if ($parser eq 'parse') {
1500: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1501: $codebase);
1502: unless ($parse_result eq 'ok') {
1503: &logthis('Failed to parse '.$filepath.$file.
1504: ' for embedded media: '.$parse_result);
1505: }
1506: }
1507: # Notify homeserver to grep it
1508: #
1509: my $docuhome=&homeserver($docuname,$docudom);
1510: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1511: if ($fetchresult eq 'ok') {
1512: #
1513: # Return the URL to it
1514: return '/uploaded/'.$path.$file;
1515: } else {
1516: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1517: ': '.$fetchresult);
1518: return '/adm/notfound.html';
1519: }
1520: }
1521:
1522: sub extract_embedded_items {
1523: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1524: my @state = ();
1525: my %javafiles = (
1526: codebase => '',
1527: code => '',
1528: archive => ''
1529: );
1530: my %mediafiles = (
1531: src => '',
1532: movie => '',
1533: );
1534: my $p;
1535: if ($content) {
1536: $p = HTML::LCParser->new($content);
1537: } else {
1538: $p = HTML::LCParser->new($filepath.'/'.$file);
1539: }
1540: while (my $t=$p->get_token()) {
1541: if ($t->[0] eq 'S') {
1542: my ($tagname, $attr) = ($t->[1],$t->[2]);
1543: push (@state, $tagname);
1544: if (lc($tagname) eq 'allow') {
1545: &add_filetype($allfiles,$attr->{'src'},'src');
1546: }
1547: if (lc($tagname) eq 'img') {
1548: &add_filetype($allfiles,$attr->{'src'},'src');
1549: }
1550: if (lc($tagname) eq 'script') {
1551: if ($attr->{'archive'} =~ /\.jar$/i) {
1552: &add_filetype($allfiles,$attr->{'archive'},'archive');
1553: } else {
1554: &add_filetype($allfiles,$attr->{'src'},'src');
1555: }
1556: }
1557: if (lc($tagname) eq 'link') {
1558: if (lc($attr->{'rel'}) eq 'stylesheet') {
1559: &add_filetype($allfiles,$attr->{'href'},'href');
1560: }
1561: }
1562: if (lc($tagname) eq 'object' ||
1563: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1564: foreach my $item (keys(%javafiles)) {
1565: $javafiles{$item} = '';
1566: }
1567: }
1568: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1569: my $name = lc($attr->{'name'});
1570: foreach my $item (keys(%javafiles)) {
1571: if ($name eq $item) {
1572: $javafiles{$item} = $attr->{'value'};
1573: last;
1574: }
1575: }
1576: foreach my $item (keys(%mediafiles)) {
1577: if ($name eq $item) {
1578: &add_filetype($allfiles, $attr->{'value'}, 'value');
1579: last;
1580: }
1581: }
1582: }
1583: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1584: foreach my $item (keys(%javafiles)) {
1585: if ($attr->{$item}) {
1586: $javafiles{$item} = $attr->{$item};
1587: last;
1588: }
1589: }
1590: foreach my $item (keys(%mediafiles)) {
1591: if ($attr->{$item}) {
1592: &add_filetype($allfiles,$attr->{$item},$item);
1593: last;
1594: }
1595: }
1596: }
1597: } elsif ($t->[0] eq 'E') {
1598: my ($tagname) = ($t->[1]);
1599: if ($javafiles{'codebase'} ne '') {
1600: $javafiles{'codebase'} .= '/';
1601: }
1602: if (lc($tagname) eq 'applet' ||
1603: lc($tagname) eq 'object' ||
1604: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1605: ) {
1606: foreach my $item (keys(%javafiles)) {
1607: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1608: my $file=$javafiles{'codebase'}.$javafiles{$item};
1609: &add_filetype($allfiles,$file,$item);
1610: }
1611: }
1612: }
1613: pop @state;
1614: }
1615: }
1616: return 'ok';
1617: }
1618:
1619: sub add_filetype {
1620: my ($allfiles,$file,$type)=@_;
1621: if (exists($allfiles->{$file})) {
1622: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1623: push(@{$allfiles->{$file}}, &escape($type));
1624: }
1625: } else {
1626: @{$allfiles->{$file}} = (&escape($type));
1627: }
1628: }
1629:
1630: sub removeuploadedurl {
1631: my ($url)=@_;
1632: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1633: return &removeuserfile($uname,$udom,$fname);
1634: }
1635:
1636: sub removeuserfile {
1637: my ($docuname,$docudom,$fname)=@_;
1638: my $home=&homeserver($docuname,$docudom);
1639: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1640: if ($result eq 'ok') {
1641: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
1642: my $metafile = $fname.'.meta';
1643: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1644: }
1645: }
1646: return $result;
1647: }
1648:
1649: sub mkdiruserfile {
1650: my ($docuname,$docudom,$dir)=@_;
1651: my $home=&homeserver($docuname,$docudom);
1652: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1653: }
1654:
1655: sub renameuserfile {
1656: my ($docuname,$docudom,$old,$new)=@_;
1657: my $home=&homeserver($docuname,$docudom);
1658: my $result = &reply("renameuserfile:$docudom:$docuname:".
1659: &escape("$old").':'.&escape("$new"),$home);
1660: if ($result eq 'ok') {
1661: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
1662: my $oldmeta = $old.'.meta';
1663: my $newmeta = $new.'.meta';
1664: my $metaresult =
1665: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1666: }
1667: }
1668: return $result;
1669: }
1670:
1671: # ------------------------------------------------------------------------- Log
1672:
1673: sub log {
1674: my ($dom,$nam,$hom,$what)=@_;
1675: return critical("log:$dom:$nam:$what",$hom);
1676: }
1677:
1678: # ------------------------------------------------------------------ Course Log
1679: #
1680: # This routine flushes several buffers of non-mission-critical nature
1681: #
1682:
1683: sub flushcourselogs {
1684: &logthis('Flushing log buffers');
1685: #
1686: # course logs
1687: # This is a log of all transactions in a course, which can be used
1688: # for data mining purposes
1689: #
1690: # It also collects the courseid database, which lists last transaction
1691: # times and course titles for all courseids
1692: #
1693: my %courseidbuffer=();
1694: foreach (keys %courselogs) {
1695: my $crsid=$_;
1696: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1697: &escape($courselogs{$crsid}),
1698: $coursehombuf{$crsid}) eq 'ok') {
1699: delete $courselogs{$crsid};
1700: } else {
1701: &logthis('Failed to flush log buffer for '.$crsid);
1702: if (length($courselogs{$crsid})>40000) {
1703: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1704: " exceeded maximum size, deleting.</font>");
1705: delete $courselogs{$crsid};
1706: }
1707: }
1708: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1709: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1710: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1711: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1712: } else {
1713: $courseidbuffer{$coursehombuf{$crsid}}=
1714: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1715: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1716: }
1717: }
1718: #
1719: # Write course id database (reverse lookup) to homeserver of courses
1720: # Is used in pickcourse
1721: #
1722: foreach (keys %courseidbuffer) {
1723: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1724: }
1725: #
1726: # File accesses
1727: # Writes to the dynamic metadata of resources to get hit counts, etc.
1728: #
1729: foreach my $entry (keys(%accesshash)) {
1730: if ($entry =~ /___count$/) {
1731: my ($dom,$name);
1732: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1733: if (! defined($dom) || $dom eq '' ||
1734: ! defined($name) || $name eq '') {
1735: my $cid = $env{'request.course.id'};
1736: $dom = $env{'request.'.$cid.'.domain'};
1737: $name = $env{'request.'.$cid.'.num'};
1738: }
1739: my $value = $accesshash{$entry};
1740: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1741: my %temphash=($url => $value);
1742: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1743: if ($result eq 'ok') {
1744: delete $accesshash{$entry};
1745: } elsif ($result eq 'unknown_cmd') {
1746: # Target server has old code running on it.
1747: my %temphash=($entry => $value);
1748: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1749: delete $accesshash{$entry};
1750: }
1751: }
1752: } else {
1753: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1754: my %temphash=($entry => $accesshash{$entry});
1755: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1756: delete $accesshash{$entry};
1757: }
1758: }
1759: }
1760: #
1761: # Roles
1762: # Reverse lookup of user roles for course faculty/staff and co-authorship
1763: #
1764: foreach (keys %userrolehash) {
1765: my $entry=$_;
1766: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1767: split(/\:/,$entry);
1768: if (&Apache::lonnet::put('nohist_userroles',
1769: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1770: $rudom,$runame) eq 'ok') {
1771: delete $userrolehash{$entry};
1772: }
1773: }
1774: #
1775: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1776: #
1777: my %domrolebuffer = ();
1778: foreach my $entry (keys %domainrolehash) {
1779: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1780: if ($domrolebuffer{$rudom}) {
1781: $domrolebuffer{$rudom}.='&'.&escape($entry).
1782: '='.&escape($domainrolehash{$entry});
1783: } else {
1784: $domrolebuffer{$rudom}.=&escape($entry).
1785: '='.&escape($domainrolehash{$entry});
1786: }
1787: delete $domainrolehash{$entry};
1788: }
1789: foreach my $dom (keys(%domrolebuffer)) {
1790: foreach my $tryserver (keys %libserv) {
1791: if ($hostdom{$tryserver} eq $dom) {
1792: unless (&reply('domroleput:'.$dom.':'.
1793: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1794: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1795: }
1796: }
1797: }
1798: }
1799: $dumpcount++;
1800: }
1801:
1802: sub courselog {
1803: my $what=shift;
1804: $what=time.':'.$what;
1805: unless ($env{'request.course.id'}) { return ''; }
1806: $coursedombuf{$env{'request.course.id'}}=
1807: $env{'course.'.$env{'request.course.id'}.'.domain'};
1808: $coursenumbuf{$env{'request.course.id'}}=
1809: $env{'course.'.$env{'request.course.id'}.'.num'};
1810: $coursehombuf{$env{'request.course.id'}}=
1811: $env{'course.'.$env{'request.course.id'}.'.home'};
1812: $coursedescrbuf{$env{'request.course.id'}}=
1813: $env{'course.'.$env{'request.course.id'}.'.description'};
1814: $courseinstcodebuf{$env{'request.course.id'}}=
1815: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1816: $courseownerbuf{$env{'request.course.id'}}=
1817: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1818: $coursetypebuf{$env{'request.course.id'}}=
1819: $env{'course.'.$env{'request.course.id'}.'.type'};
1820: if (defined $courselogs{$env{'request.course.id'}}) {
1821: $courselogs{$env{'request.course.id'}}.='&'.$what;
1822: } else {
1823: $courselogs{$env{'request.course.id'}}.=$what;
1824: }
1825: if (length($courselogs{$env{'request.course.id'}})>4048) {
1826: &flushcourselogs();
1827: }
1828: }
1829:
1830: sub courseacclog {
1831: my $fnsymb=shift;
1832: unless ($env{'request.course.id'}) { return ''; }
1833: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1834: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1835: $what.=':POST';
1836: # FIXME: Probably ought to escape things....
1837: foreach (keys %env) {
1838: if ($_=~/^form\.(.*)/) {
1839: $what.=':'.$1.'='.$env{$_};
1840: }
1841: }
1842: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1843: # FIXME: We should not be depending on a form parameter that someone
1844: # editing lonsearchcat.pm might change in the future.
1845: if ($env{'form.phase'} eq 'course_search') {
1846: $what.= ':POST';
1847: # FIXME: Probably ought to escape things....
1848: foreach my $element ('courseexp','crsfulltext','crsrelated',
1849: 'crsdiscuss') {
1850: $what.=':'.$element.'='.$env{'form.'.$element};
1851: }
1852: }
1853: }
1854: &courselog($what);
1855: }
1856:
1857: sub countacc {
1858: my $url=&declutter(shift);
1859: return if (! defined($url) || $url eq '');
1860: unless ($env{'request.course.id'}) { return ''; }
1861: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1862: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1863: $accesshash{$key}++;
1864: }
1865:
1866: sub linklog {
1867: my ($from,$to)=@_;
1868: $from=&declutter($from);
1869: $to=&declutter($to);
1870: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1871: $accesshash{$to.'___'.$from.'___goto'}=1;
1872: }
1873:
1874: sub userrolelog {
1875: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1876: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1877: ($trole=~/^in/) || ($trole=~/^cc/) ||
1878: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1879: ($trole=~/^ta/)) {
1880: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1881: $userrolehash
1882: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1883: =$tend.':'.$tstart;
1884: }
1885: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1886: ($trole=~/^li/) || ($trole=~/^li/) ||
1887: ($trole=~/^au/) || ($trole=~/^dg/) ||
1888: ($trole=~/^sc/)) {
1889: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1890: $domainrolehash
1891: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1892: = $tend.':'.$tstart;
1893: }
1894: }
1895:
1896: sub get_course_adv_roles {
1897: my $cid=shift;
1898: $cid=$env{'request.course.id'} unless (defined($cid));
1899: my %coursehash=&coursedescription($cid);
1900: my %nothide=();
1901: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1902: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1903: }
1904: my %returnhash=();
1905: my %dumphash=
1906: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1907: my $now=time;
1908: foreach (keys %dumphash) {
1909: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1910: if (($tstart) && ($tstart<0)) { next; }
1911: if (($tend) && ($tend<$now)) { next; }
1912: if (($tstart) && ($now<$tstart)) { next; }
1913: my ($role,$username,$domain,$section)=split(/\:/,$_);
1914: if ($username eq '' || $domain eq '') { next; }
1915: if ((&privileged($username,$domain)) &&
1916: (!$nothide{$username.':'.$domain})) { next; }
1917: if ($role eq 'cr') { next; }
1918: my $key=&plaintext($role);
1919: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1920: if ($returnhash{$key}) {
1921: $returnhash{$key}.=','.$username.':'.$domain;
1922: } else {
1923: $returnhash{$key}=$username.':'.$domain;
1924: }
1925: }
1926: return %returnhash;
1927: }
1928:
1929: sub get_my_roles {
1930: my ($uname,$udom)=@_;
1931: unless (defined($uname)) { $uname=$env{'user.name'}; }
1932: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1933: my %dumphash=
1934: &dump('nohist_userroles',$udom,$uname);
1935: my %returnhash=();
1936: my $now=time;
1937: foreach (keys %dumphash) {
1938: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1939: if (($tstart) && ($tstart<0)) { next; }
1940: if (($tend) && ($tend<$now)) { next; }
1941: if (($tstart) && ($now<$tstart)) { next; }
1942: my ($role,$username,$domain,$section)=split(/\:/,$_);
1943: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1944: }
1945: return %returnhash;
1946: }
1947:
1948: # ----------------------------------------------------- Frontpage Announcements
1949: #
1950: #
1951:
1952: sub postannounce {
1953: my ($server,$text)=@_;
1954: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1955: unless ($text=~/\w/) { $text=''; }
1956: return &reply('setannounce:'.&escape($text),$server);
1957: }
1958:
1959: sub getannounce {
1960:
1961: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1962: my $announcement='';
1963: while (<$fh>) { $announcement .=$_; }
1964: close($fh);
1965: if ($announcement=~/\w/) {
1966: return
1967: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1968: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1969: } else {
1970: return '';
1971: }
1972: } else {
1973: return '';
1974: }
1975: }
1976:
1977: # ---------------------------------------------------------- Course ID routines
1978: # Deal with domain's nohist_courseid.db files
1979: #
1980:
1981: sub courseidput {
1982: my ($domain,$what,$coursehome)=@_;
1983: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1984: }
1985:
1986: sub courseiddump {
1987: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok)=@_;
1988: my %returnhash=();
1989: unless ($domfilter) { $domfilter=''; }
1990: foreach my $tryserver (keys %libserv) {
1991: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1992: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1993: foreach (
1994: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1995: $sincefilter.':'.&escape($descfilter).':'.
1996: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter).':'.&escape($regexp_ok),
1997: $tryserver))) {
1998: my ($key,$value)=split(/\=/,$_);
1999: if (($key) && ($value)) {
2000: $returnhash{&unescape($key)}=$value;
2001: }
2002: }
2003: }
2004: }
2005: }
2006: return %returnhash;
2007: }
2008:
2009: # ---------------------------------------------------------- DC e-mail
2010:
2011: sub dcmailput {
2012: my ($domain,$msgid,$message,$server)=@_;
2013: my $status = &Apache::lonnet::critical(
2014: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
2015: &escape($message),$server);
2016: return $status;
2017: }
2018:
2019: sub dcmaildump {
2020: my ($dom,$startdate,$enddate,$senders) = @_;
2021: my %returnhash=();
2022: if (exists($domain_primary{$dom})) {
2023: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
2024: &escape($enddate).':';
2025: my @esc_senders=map { &escape($_)} @$senders;
2026: $cmd.=&escape(join('&',@esc_senders));
2027: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
2028: my ($key,$value) = split(/\=/,$_);
2029: if (($key) && ($value)) {
2030: $returnhash{&unescape($key)} = &unescape($value);
2031: }
2032: }
2033: }
2034: return %returnhash;
2035: }
2036: # ---------------------------------------------------------- Domain roles
2037:
2038: sub get_domain_roles {
2039: my ($dom,$roles,$startdate,$enddate)=@_;
2040: if (undef($startdate) || $startdate eq '') {
2041: $startdate = '.';
2042: }
2043: if (undef($enddate) || $enddate eq '') {
2044: $enddate = '.';
2045: }
2046: my $rolelist = join(':',@{$roles});
2047: my %personnel = ();
2048: foreach my $tryserver (keys(%libserv)) {
2049: if ($hostdom{$tryserver} eq $dom) {
2050: %{$personnel{$tryserver}}=();
2051: foreach (
2052: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2053: &escape($startdate).':'.&escape($enddate).':'.
2054: &escape($rolelist), $tryserver))) {
2055: my($key,$value) = split(/\=/,$_);
2056: if (($key) && ($value)) {
2057: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2058: }
2059: }
2060: }
2061: }
2062: return %personnel;
2063: }
2064:
2065: # ----------------------------------------------------------- Check out an item
2066:
2067: sub get_first_access {
2068: my ($type,$argsymb)=@_;
2069: my ($symb,$courseid,$udom,$uname)=&whichuser();
2070: if ($argsymb) { $symb=$argsymb; }
2071: my ($map,$id,$res)=&decode_symb($symb);
2072: if ($type eq 'map') {
2073: $res=&symbread($map);
2074: } else {
2075: $res=$symb;
2076: }
2077: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2078: return $times{"$courseid\0$res"};
2079: }
2080:
2081: sub set_first_access {
2082: my ($type)=@_;
2083: my ($symb,$courseid,$udom,$uname)=&whichuser();
2084: my ($map,$id,$res)=&decode_symb($symb);
2085: if ($type eq 'map') {
2086: $res=&symbread($map);
2087: } else {
2088: $res=$symb;
2089: }
2090: my $firstaccess=&get_first_access($type,$symb);
2091: if (!$firstaccess) {
2092: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2093: }
2094: return 'already_set';
2095: }
2096:
2097: sub checkout {
2098: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2099: my $now=time;
2100: my $lonhost=$perlvar{'lonHostID'};
2101: my $infostr=&escape(
2102: 'CHECKOUTTOKEN&'.
2103: $tuname.'&'.
2104: $tudom.'&'.
2105: $tcrsid.'&'.
2106: $symb.'&'.
2107: $now.'&'.$ENV{'REMOTE_ADDR'});
2108: my $token=&reply('tmpput:'.$infostr,$lonhost);
2109: if ($token=~/^error\:/) {
2110: &logthis("<font color=\"blue\">WARNING: ".
2111: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2112: "</font>");
2113: return '';
2114: }
2115:
2116: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2117: $token=~tr/a-z/A-Z/;
2118:
2119: my %infohash=('resource.0.outtoken' => $token,
2120: 'resource.0.checkouttime' => $now,
2121: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2122:
2123: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2124: return '';
2125: } else {
2126: &logthis("<font color=\"blue\">WARNING: ".
2127: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2128: "</font>");
2129: }
2130:
2131: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2132: &escape('Checkout '.$infostr.' - '.
2133: $token)) ne 'ok') {
2134: return '';
2135: } else {
2136: &logthis("<font color=\"blue\">WARNING: ".
2137: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2138: "</font>");
2139: }
2140: return $token;
2141: }
2142:
2143: # ------------------------------------------------------------ Check in an item
2144:
2145: sub checkin {
2146: my $token=shift;
2147: my $now=time;
2148: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2149: $lonhost=~tr/A-Z/a-z/;
2150: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2151: $dtoken=~s/\W/\_/g;
2152: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2153: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2154:
2155: unless (($tuname) && ($tudom)) {
2156: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2157: return '';
2158: }
2159:
2160: unless (&allowed('mgr',$tcrsid)) {
2161: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2162: $env{'user.name'}.' - '.$env{'user.domain'});
2163: return '';
2164: }
2165:
2166: my %infohash=('resource.0.intoken' => $token,
2167: 'resource.0.checkintime' => $now,
2168: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2169:
2170: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2171: return '';
2172: }
2173:
2174: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2175: &escape('Checkin - '.$token)) ne 'ok') {
2176: return '';
2177: }
2178:
2179: return ($symb,$tuname,$tudom,$tcrsid);
2180: }
2181:
2182: # --------------------------------------------- Set Expire Date for Spreadsheet
2183:
2184: sub expirespread {
2185: my ($uname,$udom,$stype,$usymb)=@_;
2186: my $cid=$env{'request.course.id'};
2187: if ($cid) {
2188: my $now=time;
2189: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2190: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2191: $env{'course.'.$cid.'.num'}.
2192: ':nohist_expirationdates:'.
2193: &escape($key).'='.$now,
2194: $env{'course.'.$cid.'.home'})
2195: }
2196: return 'ok';
2197: }
2198:
2199: # ----------------------------------------------------- Devalidate Spreadsheets
2200:
2201: sub devalidate {
2202: my ($symb,$uname,$udom)=@_;
2203: my $cid=$env{'request.course.id'};
2204: if ($cid) {
2205: # delete the stored spreadsheets for
2206: # - the student level sheet of this user in course's homespace
2207: # - the assessment level sheet for this resource
2208: # for this user in user's homespace
2209: # - current conditional state info
2210: my $key=$uname.':'.$udom.':';
2211: my $status=
2212: &del('nohist_calculatedsheets',
2213: [$key.'studentcalc:'],
2214: $env{'course.'.$cid.'.domain'},
2215: $env{'course.'.$cid.'.num'})
2216: .' '.
2217: &del('nohist_calculatedsheets_'.$cid,
2218: [$key.'assesscalc:'.$symb],$udom,$uname);
2219: unless ($status eq 'ok ok') {
2220: &logthis('Could not devalidate spreadsheet '.
2221: $uname.' at '.$udom.' for '.
2222: $symb.': '.$status);
2223: }
2224: &delenv('user.state.'.$cid);
2225: }
2226: }
2227:
2228: sub get_scalar {
2229: my ($string,$end) = @_;
2230: my $value;
2231: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2232: $value = $1;
2233: } elsif ($$string =~ s/^([^&]*?)&//) {
2234: $value = $1;
2235: }
2236: return &unescape($value);
2237: }
2238:
2239: sub array2str {
2240: my (@array) = @_;
2241: my $result=&arrayref2str(\@array);
2242: $result=~s/^__ARRAY_REF__//;
2243: $result=~s/__END_ARRAY_REF__$//;
2244: return $result;
2245: }
2246:
2247: sub arrayref2str {
2248: my ($arrayref) = @_;
2249: my $result='__ARRAY_REF__';
2250: foreach my $elem (@$arrayref) {
2251: if(ref($elem) eq 'ARRAY') {
2252: $result.=&arrayref2str($elem).'&';
2253: } elsif(ref($elem) eq 'HASH') {
2254: $result.=&hashref2str($elem).'&';
2255: } elsif(ref($elem)) {
2256: #print("Got a ref of ".(ref($elem))." skipping.");
2257: } else {
2258: $result.=&escape($elem).'&';
2259: }
2260: }
2261: $result=~s/\&$//;
2262: $result .= '__END_ARRAY_REF__';
2263: return $result;
2264: }
2265:
2266: sub hash2str {
2267: my (%hash) = @_;
2268: my $result=&hashref2str(\%hash);
2269: $result=~s/^__HASH_REF__//;
2270: $result=~s/__END_HASH_REF__$//;
2271: return $result;
2272: }
2273:
2274: sub hashref2str {
2275: my ($hashref)=@_;
2276: my $result='__HASH_REF__';
2277: foreach (sort(keys(%$hashref))) {
2278: if (ref($_) eq 'ARRAY') {
2279: $result.=&arrayref2str($_).'=';
2280: } elsif (ref($_) eq 'HASH') {
2281: $result.=&hashref2str($_).'=';
2282: } elsif (ref($_)) {
2283: $result.='=';
2284: #print("Got a ref of ".(ref($_))." skipping.");
2285: } else {
2286: if ($_) {$result.=&escape($_).'=';} else { last; }
2287: }
2288:
2289: if(ref($hashref->{$_}) eq 'ARRAY') {
2290: $result.=&arrayref2str($hashref->{$_}).'&';
2291: } elsif(ref($hashref->{$_}) eq 'HASH') {
2292: $result.=&hashref2str($hashref->{$_}).'&';
2293: } elsif(ref($hashref->{$_})) {
2294: $result.='&';
2295: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
2296: } else {
2297: $result.=&escape($hashref->{$_}).'&';
2298: }
2299: }
2300: $result=~s/\&$//;
2301: $result .= '__END_HASH_REF__';
2302: return $result;
2303: }
2304:
2305: sub str2hash {
2306: my ($string)=@_;
2307: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2308: return %$hash;
2309: }
2310:
2311: sub str2hashref {
2312: my ($string) = @_;
2313:
2314: my %hash;
2315:
2316: if($string !~ /^__HASH_REF__/) {
2317: if (! ($string eq '' || !defined($string))) {
2318: $hash{'error'}='Not hash reference';
2319: }
2320: return (\%hash, $string);
2321: }
2322:
2323: $string =~ s/^__HASH_REF__//;
2324:
2325: while($string !~ /^__END_HASH_REF__/) {
2326: #key
2327: my $key='';
2328: if($string =~ /^__HASH_REF__/) {
2329: ($key, $string)=&str2hashref($string);
2330: if(defined($key->{'error'})) {
2331: $hash{'error'}='Bad data';
2332: return (\%hash, $string);
2333: }
2334: } elsif($string =~ /^__ARRAY_REF__/) {
2335: ($key, $string)=&str2arrayref($string);
2336: if($key->[0] eq 'Array reference error') {
2337: $hash{'error'}='Bad data';
2338: return (\%hash, $string);
2339: }
2340: } else {
2341: $string =~ s/^(.*?)=//;
2342: $key=&unescape($1);
2343: }
2344: $string =~ s/^=//;
2345:
2346: #value
2347: my $value='';
2348: if($string =~ /^__HASH_REF__/) {
2349: ($value, $string)=&str2hashref($string);
2350: if(defined($value->{'error'})) {
2351: $hash{'error'}='Bad data';
2352: return (\%hash, $string);
2353: }
2354: } elsif($string =~ /^__ARRAY_REF__/) {
2355: ($value, $string)=&str2arrayref($string);
2356: if($value->[0] eq 'Array reference error') {
2357: $hash{'error'}='Bad data';
2358: return (\%hash, $string);
2359: }
2360: } else {
2361: $value=&get_scalar(\$string,'__END_HASH_REF__');
2362: }
2363: $string =~ s/^&//;
2364:
2365: $hash{$key}=$value;
2366: }
2367:
2368: $string =~ s/^__END_HASH_REF__//;
2369:
2370: return (\%hash, $string);
2371: }
2372:
2373: sub str2array {
2374: my ($string)=@_;
2375: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2376: return @$array;
2377: }
2378:
2379: sub str2arrayref {
2380: my ($string) = @_;
2381: my @array;
2382:
2383: if($string !~ /^__ARRAY_REF__/) {
2384: if (! ($string eq '' || !defined($string))) {
2385: $array[0]='Array reference error';
2386: }
2387: return (\@array, $string);
2388: }
2389:
2390: $string =~ s/^__ARRAY_REF__//;
2391:
2392: while($string !~ /^__END_ARRAY_REF__/) {
2393: my $value='';
2394: if($string =~ /^__HASH_REF__/) {
2395: ($value, $string)=&str2hashref($string);
2396: if(defined($value->{'error'})) {
2397: $array[0] ='Array reference error';
2398: return (\@array, $string);
2399: }
2400: } elsif($string =~ /^__ARRAY_REF__/) {
2401: ($value, $string)=&str2arrayref($string);
2402: if($value->[0] eq 'Array reference error') {
2403: $array[0] ='Array reference error';
2404: return (\@array, $string);
2405: }
2406: } else {
2407: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2408: }
2409: $string =~ s/^&//;
2410:
2411: push(@array, $value);
2412: }
2413:
2414: $string =~ s/^__END_ARRAY_REF__//;
2415:
2416: return (\@array, $string);
2417: }
2418:
2419: # -------------------------------------------------------------------Temp Store
2420:
2421: sub tmpreset {
2422: my ($symb,$namespace,$domain,$stuname) = @_;
2423: if (!$symb) {
2424: $symb=&symbread();
2425: if (!$symb) { $symb= $env{'request.url'}; }
2426: }
2427: $symb=escape($symb);
2428:
2429: if (!$namespace) { $namespace=$env{'request.state'}; }
2430: $namespace=~s/\//\_/g;
2431: $namespace=~s/\W//g;
2432:
2433: if (!$domain) { $domain=$env{'user.domain'}; }
2434: if (!$stuname) { $stuname=$env{'user.name'}; }
2435: if ($domain eq 'public' && $stuname eq 'public') {
2436: $stuname=$ENV{'REMOTE_ADDR'};
2437: }
2438: my $path=$perlvar{'lonDaemons'}.'/tmp';
2439: my %hash;
2440: if (tie(%hash,'GDBM_File',
2441: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2442: &GDBM_WRCREAT(),0640)) {
2443: foreach my $key (keys %hash) {
2444: if ($key=~ /:$symb/) {
2445: delete($hash{$key});
2446: }
2447: }
2448: }
2449: }
2450:
2451: sub tmpstore {
2452: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2453:
2454: if (!$symb) {
2455: $symb=&symbread();
2456: if (!$symb) { $symb= $env{'request.url'}; }
2457: }
2458: $symb=escape($symb);
2459:
2460: if (!$namespace) {
2461: # I don't think we would ever want to store this for a course.
2462: # it seems this will only be used if we don't have a course.
2463: #$namespace=$env{'request.course.id'};
2464: #if (!$namespace) {
2465: $namespace=$env{'request.state'};
2466: #}
2467: }
2468: $namespace=~s/\//\_/g;
2469: $namespace=~s/\W//g;
2470: if (!$domain) { $domain=$env{'user.domain'}; }
2471: if (!$stuname) { $stuname=$env{'user.name'}; }
2472: if ($domain eq 'public' && $stuname eq 'public') {
2473: $stuname=$ENV{'REMOTE_ADDR'};
2474: }
2475: my $now=time;
2476: my %hash;
2477: my $path=$perlvar{'lonDaemons'}.'/tmp';
2478: if (tie(%hash,'GDBM_File',
2479: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2480: &GDBM_WRCREAT(),0640)) {
2481: $hash{"version:$symb"}++;
2482: my $version=$hash{"version:$symb"};
2483: my $allkeys='';
2484: foreach my $key (keys(%$storehash)) {
2485: $allkeys.=$key.':';
2486: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2487: }
2488: $hash{"$version:$symb:timestamp"}=$now;
2489: $allkeys.='timestamp';
2490: $hash{"$version:keys:$symb"}=$allkeys;
2491: if (untie(%hash)) {
2492: return 'ok';
2493: } else {
2494: return "error:$!";
2495: }
2496: } else {
2497: return "error:$!";
2498: }
2499: }
2500:
2501: # -----------------------------------------------------------------Temp Restore
2502:
2503: sub tmprestore {
2504: my ($symb,$namespace,$domain,$stuname) = @_;
2505:
2506: if (!$symb) {
2507: $symb=&symbread();
2508: if (!$symb) { $symb= $env{'request.url'}; }
2509: }
2510: $symb=escape($symb);
2511:
2512: if (!$namespace) { $namespace=$env{'request.state'}; }
2513:
2514: if (!$domain) { $domain=$env{'user.domain'}; }
2515: if (!$stuname) { $stuname=$env{'user.name'}; }
2516: if ($domain eq 'public' && $stuname eq 'public') {
2517: $stuname=$ENV{'REMOTE_ADDR'};
2518: }
2519: my %returnhash;
2520: $namespace=~s/\//\_/g;
2521: $namespace=~s/\W//g;
2522: my %hash;
2523: my $path=$perlvar{'lonDaemons'}.'/tmp';
2524: if (tie(%hash,'GDBM_File',
2525: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2526: &GDBM_READER(),0640)) {
2527: my $version=$hash{"version:$symb"};
2528: $returnhash{'version'}=$version;
2529: my $scope;
2530: for ($scope=1;$scope<=$version;$scope++) {
2531: my $vkeys=$hash{"$scope:keys:$symb"};
2532: my @keys=split(/:/,$vkeys);
2533: my $key;
2534: $returnhash{"$scope:keys"}=$vkeys;
2535: foreach $key (@keys) {
2536: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2537: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2538: }
2539: }
2540: if (!(untie(%hash))) {
2541: return "error:$!";
2542: }
2543: } else {
2544: return "error:$!";
2545: }
2546: return %returnhash;
2547: }
2548:
2549: # ----------------------------------------------------------------------- Store
2550:
2551: sub store {
2552: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2553: my $home='';
2554:
2555: if ($stuname) { $home=&homeserver($stuname,$domain); }
2556:
2557: $symb=&symbclean($symb);
2558: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2559:
2560: if (!$domain) { $domain=$env{'user.domain'}; }
2561: if (!$stuname) { $stuname=$env{'user.name'}; }
2562:
2563: &devalidate($symb,$stuname,$domain);
2564:
2565: $symb=escape($symb);
2566: if (!$namespace) {
2567: unless ($namespace=$env{'request.course.id'}) {
2568: return '';
2569: }
2570: }
2571: if (!$home) { $home=$env{'user.home'}; }
2572:
2573: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2574: $$storehash{'host'}=$perlvar{'lonHostID'};
2575:
2576: my $namevalue='';
2577: foreach (keys %$storehash) {
2578: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2579: }
2580: $namevalue=~s/\&$//;
2581: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2582: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2583: }
2584:
2585: # -------------------------------------------------------------- Critical Store
2586:
2587: sub cstore {
2588: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2589: my $home='';
2590:
2591: if ($stuname) { $home=&homeserver($stuname,$domain); }
2592:
2593: $symb=&symbclean($symb);
2594: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2595:
2596: if (!$domain) { $domain=$env{'user.domain'}; }
2597: if (!$stuname) { $stuname=$env{'user.name'}; }
2598:
2599: &devalidate($symb,$stuname,$domain);
2600:
2601: $symb=escape($symb);
2602: if (!$namespace) {
2603: unless ($namespace=$env{'request.course.id'}) {
2604: return '';
2605: }
2606: }
2607: if (!$home) { $home=$env{'user.home'}; }
2608:
2609: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2610: $$storehash{'host'}=$perlvar{'lonHostID'};
2611:
2612: my $namevalue='';
2613: foreach (keys %$storehash) {
2614: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2615: }
2616: $namevalue=~s/\&$//;
2617: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2618: return critical
2619: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2620: }
2621:
2622: # --------------------------------------------------------------------- Restore
2623:
2624: sub restore {
2625: my ($symb,$namespace,$domain,$stuname) = @_;
2626: my $home='';
2627:
2628: if ($stuname) { $home=&homeserver($stuname,$domain); }
2629:
2630: if (!$symb) {
2631: unless ($symb=escape(&symbread())) { return ''; }
2632: } else {
2633: $symb=&escape(&symbclean($symb));
2634: }
2635: if (!$namespace) {
2636: unless ($namespace=$env{'request.course.id'}) {
2637: return '';
2638: }
2639: }
2640: if (!$domain) { $domain=$env{'user.domain'}; }
2641: if (!$stuname) { $stuname=$env{'user.name'}; }
2642: if (!$home) { $home=$env{'user.home'}; }
2643: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2644:
2645: my %returnhash=();
2646: foreach (split(/\&/,$answer)) {
2647: my ($name,$value)=split(/\=/,$_);
2648: $returnhash{&unescape($name)}=&thaw_unescape($value);
2649: }
2650: my $version;
2651: for ($version=1;$version<=$returnhash{'version'};$version++) {
2652: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2653: $returnhash{$_}=$returnhash{$version.':'.$_};
2654: }
2655: }
2656: return %returnhash;
2657: }
2658:
2659: # ---------------------------------------------------------- Course Description
2660:
2661: sub coursedescription {
2662: my ($courseid,$args)=@_;
2663: $courseid=~s/^\///;
2664: $courseid=~s/\_/\//g;
2665: my ($cdomain,$cnum)=split(/\//,$courseid);
2666: my $chome=&homeserver($cnum,$cdomain);
2667: my $normalid=$cdomain.'_'.$cnum;
2668: # need to always cache even if we get errors otherwise we keep
2669: # trying and trying and trying to get the course description.
2670: my %envhash=();
2671: my %returnhash=();
2672:
2673: my $expiretime=600;
2674: if ($env{'request.course.id'} eq $normalid) {
2675: $expiretime=120;
2676: }
2677:
2678: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2679: if (!$args->{'freshen_cache'}
2680: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2681: foreach my $key (keys(%env)) {
2682: next if ($key !~ /^\Q$prefix\E(.*)/);
2683: my ($setting) = $1;
2684: $returnhash{$setting} = $env{$key};
2685: }
2686: return %returnhash;
2687: }
2688:
2689: # get the data agin
2690: if (!$args->{'one_time'}) {
2691: $envhash{'course.'.$normalid.'.last_cache'}=time;
2692: }
2693: if ($chome ne 'no_host') {
2694: %returnhash=&dump('environment',$cdomain,$cnum);
2695: if (!exists($returnhash{'con_lost'})) {
2696: $returnhash{'home'}= $chome;
2697: $returnhash{'domain'} = $cdomain;
2698: $returnhash{'num'} = $cnum;
2699: if (!defined($returnhash{'type'})) {
2700: $returnhash{'type'} = 'Course';
2701: }
2702: while (my ($name,$value) = each %returnhash) {
2703: $envhash{'course.'.$normalid.'.'.$name}=$value;
2704: }
2705: $returnhash{'url'}=&clutter($returnhash{'url'});
2706: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2707: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2708: $envhash{'course.'.$normalid.'.home'}=$chome;
2709: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2710: $envhash{'course.'.$normalid.'.num'}=$cnum;
2711: }
2712: }
2713: if (!$args->{'one_time'}) {
2714: &appenv(%envhash);
2715: }
2716: return %returnhash;
2717: }
2718:
2719: # -------------------------------------------------See if a user is privileged
2720:
2721: sub privileged {
2722: my ($username,$domain)=@_;
2723: my $rolesdump=&reply("dump:$domain:$username:roles",
2724: &homeserver($username,$domain));
2725: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2726: my $now=time;
2727: if ($rolesdump ne '') {
2728: foreach (split(/&/,$rolesdump)) {
2729: if ($_!~/^rolesdef_/) {
2730: my ($area,$role)=split(/=/,$_);
2731: $area=~s/\_\w\w$//;
2732: my ($trole,$tend,$tstart)=split(/_/,$role);
2733: if (($trole eq 'dc') || ($trole eq 'su')) {
2734: my $active=1;
2735: if ($tend) {
2736: if ($tend<$now) { $active=0; }
2737: }
2738: if ($tstart) {
2739: if ($tstart>$now) { $active=0; }
2740: }
2741: if ($active) { return 1; }
2742: }
2743: }
2744: }
2745: }
2746: return 0;
2747: }
2748:
2749: # -------------------------------------------------------- Get user privileges
2750:
2751: sub rolesinit {
2752: my ($domain,$username,$authhost)=@_;
2753: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2754: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2755: my %allroles=();
2756: my %allgroups=();
2757: my $now=time;
2758: my %userroles = ('user.login.time' => $now);
2759: my $group_privs;
2760:
2761: if ($rolesdump ne '') {
2762: foreach (split(/&/,$rolesdump)) {
2763: if ($_!~/^rolesdef_/) {
2764: my ($area,$role)=split(/=/,$_);
2765: $area=~s/\_\w\w$//;
2766: my ($trole,$tend,$tstart,$group_privs);
2767: if ($role=~/^cr/) {
2768: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2769: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2770: ($tend,$tstart)=split('_',$trest);
2771: } else {
2772: $trole=$role;
2773: }
2774: } elsif ($role =~ m|^gr/|) {
2775: ($trole,$tend,$tstart) = split(/_/,$role);
2776: ($trole,$group_privs) = split(/\//,$trole);
2777: $group_privs = &unescape($group_privs);
2778: } else {
2779: ($trole,$tend,$tstart)=split(/_/,$role);
2780: }
2781: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2782: $username);
2783: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
2784: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2785: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2786: if (($area ne '') && ($trole ne '')) {
2787: my $spec=$trole.'.'.$area;
2788: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2789: if ($trole =~ /^cr\//) {
2790: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2791: } elsif ($trole eq 'gr') {
2792: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2793: } else {
2794: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2795: }
2796: }
2797: }
2798: }
2799: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2800: $userroles{'user.adv'} = $adv;
2801: $userroles{'user.author'} = $author;
2802: $env{'user.adv'}=$adv;
2803: }
2804: return \%userroles;
2805: }
2806:
2807: sub set_arearole {
2808: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2809: # log the associated role with the area
2810: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2811: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
2812: }
2813:
2814: sub custom_roleprivs {
2815: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2816: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2817: my $homsvr=homeserver($rauthor,$rdomain);
2818: if ($hostname{$homsvr} ne '') {
2819: my ($rdummy,$roledef)=
2820: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2821: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2822: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2823: if (defined($syspriv)) {
2824: $$allroles{'cm./'}.=':'.$syspriv;
2825: $$allroles{$spec.'./'}.=':'.$syspriv;
2826: }
2827: if ($tdomain ne '') {
2828: if (defined($dompriv)) {
2829: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2830: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2831: }
2832: if (($trest ne '') && (defined($coursepriv))) {
2833: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2834: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2835: }
2836: }
2837: }
2838: }
2839: }
2840:
2841: sub group_roleprivs {
2842: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2843: my $access = 1;
2844: my $now = time;
2845: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2846: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2847: if ($access) {
2848: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2849: $$allgroups{$course}{$group} .=':'.$group_privs;
2850: }
2851: }
2852:
2853: sub standard_roleprivs {
2854: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2855: if (defined($pr{$trole.':s'})) {
2856: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2857: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2858: }
2859: if ($tdomain ne '') {
2860: if (defined($pr{$trole.':d'})) {
2861: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2862: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2863: }
2864: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2865: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2866: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2867: }
2868: }
2869: }
2870:
2871: sub set_userprivs {
2872: my ($userroles,$allroles,$allgroups) = @_;
2873: my $author=0;
2874: my $adv=0;
2875: my %grouproles = ();
2876: if (keys(%{$allgroups}) > 0) {
2877: foreach my $role (keys %{$allroles}) {
2878: my ($trole,$area,$sec,$extendedarea);
2879: if ($role =~ m-^(\w+|cr/\w+/\w+/\w+)\.(/\w+/\w+)(/?\w*)-) {
2880: $trole = $1;
2881: $area = $2;
2882: $sec = $3;
2883: $extendedarea = $area.$sec;
2884: if (exists($$allgroups{$area})) {
2885: foreach my $group (keys(%{$$allgroups{$area}})) {
2886: my $spec = $trole.'.'.$extendedarea;
2887: $grouproles{$spec.'.'.$area.'/'.$group} =
2888: $$allgroups{$area}{$group};
2889: }
2890: }
2891: }
2892: }
2893: }
2894: foreach (keys(%grouproles)) {
2895: $$allroles{$_} = $grouproles{$_};
2896: }
2897: foreach (keys %{$allroles}) {
2898: my %thesepriv=();
2899: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2900: foreach (split(/:/,$$allroles{$_})) {
2901: if ($_ ne '') {
2902: my ($privilege,$restrictions)=split(/&/,$_);
2903: if ($restrictions eq '') {
2904: $thesepriv{$privilege}='F';
2905: } elsif ($thesepriv{$privilege} ne 'F') {
2906: $thesepriv{$privilege}.=$restrictions;
2907: }
2908: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2909: }
2910: }
2911: my $thesestr='';
2912: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2913: $userroles->{'user.priv.'.$_} = $thesestr;
2914: }
2915: return ($author,$adv);
2916: }
2917:
2918: # --------------------------------------------------------------- get interface
2919:
2920: sub get {
2921: my ($namespace,$storearr,$udomain,$uname)=@_;
2922: my $items='';
2923: foreach (@$storearr) {
2924: $items.=escape($_).'&';
2925: }
2926: $items=~s/\&$//;
2927: if (!$udomain) { $udomain=$env{'user.domain'}; }
2928: if (!$uname) { $uname=$env{'user.name'}; }
2929: my $uhome=&homeserver($uname,$udomain);
2930:
2931: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2932: my @pairs=split(/\&/,$rep);
2933: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2934: return @pairs;
2935: }
2936: my %returnhash=();
2937: my $i=0;
2938: foreach (@$storearr) {
2939: $returnhash{$_}=&thaw_unescape($pairs[$i]);
2940: $i++;
2941: }
2942: return %returnhash;
2943: }
2944:
2945: # --------------------------------------------------------------- del interface
2946:
2947: sub del {
2948: my ($namespace,$storearr,$udomain,$uname)=@_;
2949: my $items='';
2950: foreach (@$storearr) {
2951: $items.=escape($_).'&';
2952: }
2953: $items=~s/\&$//;
2954: if (!$udomain) { $udomain=$env{'user.domain'}; }
2955: if (!$uname) { $uname=$env{'user.name'}; }
2956: my $uhome=&homeserver($uname,$udomain);
2957:
2958: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
2959: }
2960:
2961: # -------------------------------------------------------------- dump interface
2962:
2963: sub dump {
2964: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2965: if (!$udomain) { $udomain=$env{'user.domain'}; }
2966: if (!$uname) { $uname=$env{'user.name'}; }
2967: my $uhome=&homeserver($uname,$udomain);
2968: if ($regexp) {
2969: $regexp=&escape($regexp);
2970: } else {
2971: $regexp='.';
2972: }
2973: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
2974: my @pairs=split(/\&/,$rep);
2975: my %returnhash=();
2976: foreach my $item (@pairs) {
2977: my ($key,$value)=split(/=/,$item,2);
2978: $key = &unescape($key);
2979: next if ($key =~ /^error: 2 /);
2980: $returnhash{$key}=&thaw_unescape($value);
2981: }
2982: return %returnhash;
2983: }
2984:
2985: # --------------------------------------------------------- dumpstore interface
2986:
2987: sub dumpstore {
2988: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2989: return &dump($namespace,$udomain,$uname,$regexp,$range);
2990: }
2991:
2992: # -------------------------------------------------------------- keys interface
2993:
2994: sub getkeys {
2995: my ($namespace,$udomain,$uname)=@_;
2996: if (!$udomain) { $udomain=$env{'user.domain'}; }
2997: if (!$uname) { $uname=$env{'user.name'}; }
2998: my $uhome=&homeserver($uname,$udomain);
2999: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
3000: my @keyarray=();
3001: foreach (split(/\&/,$rep)) {
3002: push (@keyarray,&unescape($_));
3003: }
3004: return @keyarray;
3005: }
3006:
3007: # --------------------------------------------------------------- currentdump
3008: sub currentdump {
3009: my ($courseid,$sdom,$sname)=@_;
3010: $courseid = $env{'request.course.id'} if (! defined($courseid));
3011: $sdom = $env{'user.domain'} if (! defined($sdom));
3012: $sname = $env{'user.name'} if (! defined($sname));
3013: my $uhome = &homeserver($sname,$sdom);
3014: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
3015: return if ($rep =~ /^(error:|no_such_host)/);
3016: #
3017: my %returnhash=();
3018: #
3019: if ($rep eq "unknown_cmd") {
3020: # an old lond will not know currentdump
3021: # Do a dump and make it look like a currentdump
3022: my @tmp = &dump($courseid,$sdom,$sname,'.');
3023: return if ($tmp[0] =~ /^(error:|no_such_host)/);
3024: my %hash = @tmp;
3025: @tmp=();
3026: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
3027: } else {
3028: my @pairs=split(/\&/,$rep);
3029: foreach (@pairs) {
3030: my ($key,$value)=split(/=/,$_);
3031: my ($symb,$param) = split(/:/,$key);
3032: $returnhash{&unescape($symb)}->{&unescape($param)} =
3033: &thaw_unescape($value);
3034: }
3035: }
3036: return %returnhash;
3037: }
3038:
3039: sub convert_dump_to_currentdump{
3040: my %hash = %{shift()};
3041: my %returnhash;
3042: # Code ripped from lond, essentially. The only difference
3043: # here is the unescaping done by lonnet::dump(). Conceivably
3044: # we might run in to problems with parameter names =~ /^v\./
3045: while (my ($key,$value) = each(%hash)) {
3046: my ($v,$symb,$param) = split(/:/,$key);
3047: next if ($v eq 'version' || $symb eq 'keys');
3048: next if (exists($returnhash{$symb}) &&
3049: exists($returnhash{$symb}->{$param}) &&
3050: $returnhash{$symb}->{'v.'.$param} > $v);
3051: $returnhash{$symb}->{$param}=$value;
3052: $returnhash{$symb}->{'v.'.$param}=$v;
3053: }
3054: #
3055: # Remove all of the keys in the hashes which keep track of
3056: # the version of the parameter.
3057: while (my ($symb,$param_hash) = each(%returnhash)) {
3058: # use a foreach because we are going to delete from the hash.
3059: foreach my $key (keys(%$param_hash)) {
3060: delete($param_hash->{$key}) if ($key =~ /^v\./);
3061: }
3062: }
3063: return \%returnhash;
3064: }
3065:
3066: # ------------------------------------------------------ critical inc interface
3067:
3068: sub cinc {
3069: return &inc(@_,'critical');
3070: }
3071:
3072: # --------------------------------------------------------------- inc interface
3073:
3074: sub inc {
3075: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3076: if (!$udomain) { $udomain=$env{'user.domain'}; }
3077: if (!$uname) { $uname=$env{'user.name'}; }
3078: my $uhome=&homeserver($uname,$udomain);
3079: my $items='';
3080: if (! ref($store)) {
3081: # got a single value, so use that instead
3082: $items = &escape($store).'=&';
3083: } elsif (ref($store) eq 'SCALAR') {
3084: $items = &escape($$store).'=&';
3085: } elsif (ref($store) eq 'ARRAY') {
3086: $items = join('=&',map {&escape($_);} @{$store});
3087: } elsif (ref($store) eq 'HASH') {
3088: while (my($key,$value) = each(%{$store})) {
3089: $items.= &escape($key).'='.&escape($value).'&';
3090: }
3091: }
3092: $items=~s/\&$//;
3093: if ($critical) {
3094: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3095: } else {
3096: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3097: }
3098: }
3099:
3100: # --------------------------------------------------------------- put interface
3101:
3102: sub put {
3103: my ($namespace,$storehash,$udomain,$uname)=@_;
3104: if (!$udomain) { $udomain=$env{'user.domain'}; }
3105: if (!$uname) { $uname=$env{'user.name'}; }
3106: my $uhome=&homeserver($uname,$udomain);
3107: my $items='';
3108: foreach (keys %$storehash) {
3109: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3110: }
3111: $items=~s/\&$//;
3112: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3113: }
3114:
3115: # ------------------------------------------------------------ newput interface
3116:
3117: sub newput {
3118: my ($namespace,$storehash,$udomain,$uname)=@_;
3119: if (!$udomain) { $udomain=$env{'user.domain'}; }
3120: if (!$uname) { $uname=$env{'user.name'}; }
3121: my $uhome=&homeserver($uname,$udomain);
3122: my $items='';
3123: foreach my $key (keys(%$storehash)) {
3124: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3125: }
3126: $items=~s/\&$//;
3127: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3128: }
3129:
3130: # --------------------------------------------------------- putstore interface
3131:
3132: sub putstore {
3133: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3134: if (!$udomain) { $udomain=$env{'user.domain'}; }
3135: if (!$uname) { $uname=$env{'user.name'}; }
3136: my $uhome=&homeserver($uname,$udomain);
3137: my $items='';
3138: foreach my $key (keys(%$storehash)) {
3139: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3140: }
3141: $items=~s/\&$//;
3142: my $esc_symb=&escape($symb);
3143: my $esc_v=&escape($version);
3144: my $reply =
3145: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3146: $uhome);
3147: if ($reply eq 'unknown_cmd') {
3148: # gfall back to way things use to be done
3149: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3150: $uname);
3151: }
3152: return $reply;
3153: }
3154:
3155: sub old_putstore {
3156: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3157: if (!$udomain) { $udomain=$env{'user.domain'}; }
3158: if (!$uname) { $uname=$env{'user.name'}; }
3159: my $uhome=&homeserver($uname,$udomain);
3160: my %newstorehash;
3161: foreach (keys %$storehash) {
3162: my $key = $version.':'.&escape($symb).':'.$_;
3163: $newstorehash{$key} = $storehash->{$_};
3164: }
3165: my $items='';
3166: my %allitems = ();
3167: foreach (keys %newstorehash) {
3168: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3169: my $key = $1.':keys:'.$2;
3170: $allitems{$key} .= $3.':';
3171: }
3172: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3173: }
3174: foreach (keys %allitems) {
3175: $allitems{$_} =~ s/\:$//;
3176: $items.= $_.'='.$allitems{$_}.'&';
3177: }
3178: $items=~s/\&$//;
3179: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3180: }
3181:
3182: # ------------------------------------------------------ critical put interface
3183:
3184: sub cput {
3185: my ($namespace,$storehash,$udomain,$uname)=@_;
3186: if (!$udomain) { $udomain=$env{'user.domain'}; }
3187: if (!$uname) { $uname=$env{'user.name'}; }
3188: my $uhome=&homeserver($uname,$udomain);
3189: my $items='';
3190: foreach (keys %$storehash) {
3191: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3192: }
3193: $items=~s/\&$//;
3194: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3195: }
3196:
3197: # -------------------------------------------------------------- eget interface
3198:
3199: sub eget {
3200: my ($namespace,$storearr,$udomain,$uname)=@_;
3201: my $items='';
3202: foreach (@$storearr) {
3203: $items.=escape($_).'&';
3204: }
3205: $items=~s/\&$//;
3206: if (!$udomain) { $udomain=$env{'user.domain'}; }
3207: if (!$uname) { $uname=$env{'user.name'}; }
3208: my $uhome=&homeserver($uname,$udomain);
3209: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3210: my @pairs=split(/\&/,$rep);
3211: my %returnhash=();
3212: my $i=0;
3213: foreach (@$storearr) {
3214: $returnhash{$_}=&thaw_unescape($pairs[$i]);
3215: $i++;
3216: }
3217: return %returnhash;
3218: }
3219:
3220: # ------------------------------------------------------------ tmpput interface
3221: sub tmpput {
3222: my ($storehash,$server)=@_;
3223: my $items='';
3224: foreach (keys(%$storehash)) {
3225: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3226: }
3227: $items=~s/\&$//;
3228: return &reply("tmpput:$items",$server);
3229: }
3230:
3231: # ------------------------------------------------------------ tmpget interface
3232: sub tmpget {
3233: my ($token,$server)=@_;
3234: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3235: my $rep=&reply("tmpget:$token",$server);
3236: my %returnhash;
3237: foreach my $item (split(/\&/,$rep)) {
3238: my ($key,$value)=split(/=/,$item);
3239: $returnhash{&unescape($key)}=&thaw_unescape($value);
3240: }
3241: return %returnhash;
3242: }
3243:
3244: # ------------------------------------------------------------ tmpget interface
3245: sub tmpdel {
3246: my ($token,$server)=@_;
3247: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3248: return &reply("tmpdel:$token",$server);
3249: }
3250:
3251: # -------------------------------------------------- portfolio access checking
3252:
3253: sub portfolio_access {
3254: my ($requrl) = @_;
3255: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
3256: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
3257: if ($result eq 'ok') {
3258: return 'F';
3259: } elsif ($result =~ /^[^:]+:guest_/) {
3260: return 'A';
3261: }
3262: return '';
3263: }
3264:
3265: sub get_portfolio_access {
3266: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
3267:
3268: if (!ref($access_hash)) {
3269: my $current_perms = &get_portfile_permissions($udom,$unum);
3270: my %access_controls = &get_access_controls($current_perms,$group,
3271: $file_name);
3272: $access_hash = $access_controls{$file_name};
3273: }
3274:
3275: my ($public,$guest,@domains,@users,@courses,@groups);
3276: my $now = time;
3277: if (ref($access_hash) eq 'HASH') {
3278: foreach my $key (keys(%{$access_hash})) {
3279: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
3280: if ($start > $now) {
3281: next;
3282: }
3283: if ($end && $end<$now) {
3284: next;
3285: }
3286: if ($scope eq 'public') {
3287: $public = $key;
3288: last;
3289: } elsif ($scope eq 'guest') {
3290: $guest = $key;
3291: } elsif ($scope eq 'domains') {
3292: push(@domains,$key);
3293: } elsif ($scope eq 'users') {
3294: push(@users,$key);
3295: } elsif ($scope eq 'course') {
3296: push(@courses,$key);
3297: } elsif ($scope eq 'group') {
3298: push(@groups,$key);
3299: }
3300: }
3301: if ($public) {
3302: return 'ok';
3303: }
3304: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3305: if ($guest) {
3306: return $guest;
3307: }
3308: } else {
3309: if (@domains > 0) {
3310: foreach my $domkey (@domains) {
3311: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
3312: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
3313: return 'ok';
3314: }
3315: }
3316: }
3317: }
3318: if (@users > 0) {
3319: foreach my $userkey (@users) {
3320: if (exists($access_hash->{$userkey}{'users'}{$env{'user.name'}.':'.$env{'user.domain'}})) {
3321: return 'ok';
3322: }
3323: }
3324: }
3325: my %roleshash;
3326: my @courses_and_groups = @courses;
3327: push(@courses_and_groups,@groups);
3328: if (@courses_and_groups > 0) {
3329: my (%allgroups,%allroles);
3330: my ($start,$end,$role,$sec,$group);
3331: foreach my $envkey (%env) {
3332: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./([^/]+)/([^/]+)/?([^/]*)$-) {
3333: my $cid = $2.'_'.$3;
3334: if ($1 eq 'gr') {
3335: $group = $4;
3336: $allgroups{$cid}{$group} = $env{$envkey};
3337: } else {
3338: if ($4 eq '') {
3339: $sec = 'none';
3340: } else {
3341: $sec = $4;
3342: }
3343: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3344: }
3345: } elsif ($envkey =~ m-^user\.role\./cr/(\w+/\w+/\w*)./([^/]+)/([^/]+)/?([^/]*)$-) {
3346: my $cid = $2.'_'.$3;
3347: if ($4 eq '') {
3348: $sec = 'none';
3349: } else {
3350: $sec = $4;
3351: }
3352: $allroles{$cid}{$1}{$sec} = $env{$envkey};
3353: }
3354: }
3355: if (keys(%allroles) == 0) {
3356: return;
3357: }
3358: foreach my $key (@courses_and_groups) {
3359: my %content = %{$$access_hash{$key}};
3360: my $cnum = $content{'number'};
3361: my $cdom = $content{'domain'};
3362: my $cid = $cdom.'_'.$cnum;
3363: if (!exists($allroles{$cid})) {
3364: next;
3365: }
3366: foreach my $role_id (keys(%{$content{'roles'}})) {
3367: my @sections = @{$content{'roles'}{$role_id}{'section'}};
3368: my @groups = @{$content{'roles'}{$role_id}{'group'}};
3369: my @status = @{$content{'roles'}{$role_id}{'access'}};
3370: my @roles = @{$content{'roles'}{$role_id}{'role'}};
3371: foreach my $role (keys(%{$allroles{$cid}})) {
3372: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
3373: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
3374: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
3375: if (grep/^all$/,@sections) {
3376: return 'ok';
3377: } else {
3378: if (grep/^$sec$/,@sections) {
3379: return 'ok';
3380: }
3381: }
3382: }
3383: }
3384: if (keys(%{$allgroups{$cid}}) == 0) {
3385: if (grep/^none$/,@groups) {
3386: return 'ok';
3387: }
3388: } else {
3389: if (grep/^all$/,@groups) {
3390: return 'ok';
3391: }
3392: foreach my $group (keys(%{$allgroups{$cid}})) {
3393: if (grep/^$group$/,@groups) {
3394: return 'ok';
3395: }
3396: }
3397: }
3398: }
3399: }
3400: }
3401: }
3402: }
3403: if ($guest) {
3404: return $guest;
3405: }
3406: }
3407: }
3408: return;
3409: }
3410:
3411: sub course_group_datechecker {
3412: my ($dates,$now,$status) = @_;
3413: my ($start,$end) = split(/\./,$dates);
3414: if (!$start && !$end) {
3415: return 'ok';
3416: }
3417: if (grep/^active$/,@{$status}) {
3418: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
3419: return 'ok';
3420: }
3421: }
3422: if (grep/^previous$/,@{$status}) {
3423: if ($end > $now ) {
3424: return 'ok';
3425: }
3426: }
3427: if (grep/^future$/,@{$status}) {
3428: if ($start > $now) {
3429: return 'ok';
3430: }
3431: }
3432: return;
3433: }
3434:
3435: sub parse_portfolio_url {
3436: my ($url) = @_;
3437:
3438: my ($type,$udom,$unum,$group,$file_name);
3439:
3440: if ($url =~ m-^/*uploaded/([^/]+)/([^/]+)/portfolio(/.+)$-) {
3441: $type = 1;
3442: $udom = $1;
3443: $unum = $2;
3444: $file_name = $3;
3445: } elsif ($url =~ m-^/*uploaded/([^/]+)/([^/]+)/groups/([^/]+)/portfolio/(.+)$-) {
3446: $type = 2;
3447: $udom = $1;
3448: $unum = $2;
3449: $group = $3;
3450: $file_name = $3.'/'.$4;
3451: }
3452: if (wantarray) {
3453: return ($type,$udom,$unum,$file_name,$group);
3454: }
3455: return $type;
3456: }
3457:
3458: sub is_portfolio_url {
3459: my ($url) = @_;
3460: return scalar(&parse_portfolio_url($url));
3461: }
3462:
3463: sub is_portfolio_file {
3464: my ($file) = @_;
3465: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
3466: return 1;
3467: }
3468: return;
3469: }
3470:
3471:
3472: # ---------------------------------------------- Custom access rule evaluation
3473:
3474: sub customaccess {
3475: my ($priv,$uri)=@_;
3476: my ($urole,$urealm)=split(/\./,$env{'request.role'});
3477: $urealm=~s/^\W//;
3478: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
3479: my $access=0;
3480: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3481: my ($effect,$realm,$role)=split(/\:/,$_);
3482: if ($role) {
3483: if ($role ne $urole) { next; }
3484: }
3485: foreach (split(/\s*\,\s*/,$realm)) {
3486: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3487: if ($tdom) {
3488: if ($tdom ne $udom) { next; }
3489: }
3490: if ($tcrs) {
3491: if ($tcrs ne $ucrs) { next; }
3492: }
3493: if ($tsec) {
3494: if ($tsec ne $usec) { next; }
3495: }
3496: $access=($effect eq 'allow');
3497: last;
3498: }
3499: if ($realm eq '' && $role eq '') {
3500: $access=($effect eq 'allow');
3501: }
3502: }
3503: return $access;
3504: }
3505:
3506: # ------------------------------------------------- Check for a user privilege
3507:
3508: sub allowed {
3509: my ($priv,$uri,$symb)=@_;
3510: my $ver_orguri=$uri;
3511: $uri=&deversion($uri);
3512: my $orguri=$uri;
3513: $uri=&declutter($uri);
3514:
3515: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3516: # Free bre access to adm and meta resources
3517: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
3518: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
3519: && ($priv eq 'bre')) {
3520: return 'F';
3521: }
3522:
3523: # Free bre access to user's own portfolio contents
3524: my ($space,$domain,$name,@dir)=split('/',$uri);
3525: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3526: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3527: return 'F';
3528: }
3529:
3530: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
3531: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3532: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3533: if (exists($env{'request.course.id'})) {
3534: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3535: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3536: if (($domain eq $cdom) && ($name eq $cnum)) {
3537: my $courseprivid=$env{'request.course.id'};
3538: $courseprivid=~s/\_/\//;
3539: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3540: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3541: return $1;
3542: } else {
3543: if ($env{'request.course.sec'}) {
3544: $courseprivid.='/'.$env{'request.course.sec'};
3545: }
3546: if ($env{'user.priv.'.$env{'request.role'}.'./'.
3547: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
3548: return $2;
3549: }
3550: }
3551: }
3552: }
3553: }
3554:
3555: # Free bre to public access
3556:
3557: if ($priv eq 'bre') {
3558: my $copyright=&metadata($uri,'copyright');
3559: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3560: return 'F';
3561: }
3562: if ($copyright eq 'priv') {
3563: $uri=~/([^\/]+)\/([^\/]+)\//;
3564: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3565: return '';
3566: }
3567: }
3568: if ($copyright eq 'domain') {
3569: $uri=~/([^\/]+)\/([^\/]+)\//;
3570: unless (($env{'user.domain'} eq $1) ||
3571: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3572: return '';
3573: }
3574: }
3575: if ($env{'request.role'}=~ /li\.\//) {
3576: # Library role, so allow browsing of resources in this domain.
3577: return 'F';
3578: }
3579: if ($copyright eq 'custom') {
3580: unless (&customaccess($priv,$uri)) { return ''; }
3581: }
3582: }
3583: # Domain coordinator is trying to create a course
3584: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3585: # uri is the requested domain in this case.
3586: # comparison to 'request.role.domain' shows if the user has selected
3587: # a role of dc for the domain in question.
3588: return 'F' if ($uri eq $env{'request.role.domain'});
3589: }
3590:
3591: my $thisallowed='';
3592: my $statecond=0;
3593: my $courseprivid='';
3594:
3595: # Course
3596:
3597: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3598: $thisallowed.=$1;
3599: }
3600:
3601: # Domain
3602:
3603: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3604: =~/\Q$priv\E\&([^\:]*)/) {
3605: $thisallowed.=$1;
3606: }
3607:
3608: # Course: uri itself is a course
3609: my $courseuri=$uri;
3610: $courseuri=~s/\_(\d)/\/$1/;
3611: $courseuri=~s/^([^\/])/\/$1/;
3612:
3613: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3614: =~/\Q$priv\E\&([^\:]*)/) {
3615: $thisallowed.=$1;
3616: }
3617:
3618: # URI is an uploaded document for this course, default permissions don't matter
3619: # not allowing 'edit' access (editupload) to uploaded course docs
3620: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3621: $thisallowed='';
3622: my ($match)=&is_on_map($uri);
3623: if ($match) {
3624: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3625: =~/\Q$priv\E\&([^\:]*)/) {
3626: $thisallowed.=$1;
3627: }
3628: } else {
3629: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3630: if ($refuri) {
3631: if ($refuri =~ m|^/adm/|) {
3632: $thisallowed='F';
3633: } else {
3634: $refuri=&declutter($refuri);
3635: my ($match) = &is_on_map($refuri);
3636: if ($match) {
3637: $thisallowed='F';
3638: }
3639: }
3640: }
3641: }
3642: }
3643:
3644: if ($priv eq 'bre'
3645: && $thisallowed ne 'F'
3646: && $thisallowed ne '2'
3647: && &is_portfolio_url($uri)) {
3648: $thisallowed = &portfolio_access($uri);
3649: }
3650:
3651: # Full access at system, domain or course-wide level? Exit.
3652:
3653: if ($thisallowed=~/F/) {
3654: return 'F';
3655: }
3656:
3657: # If this is generating or modifying users, exit with special codes
3658:
3659: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3660: if (($priv eq 'cca') || ($priv eq 'caa')) {
3661: my ($audom,$auname)=split('/',$uri);
3662: # no author name given, so this just checks on the general right to make a co-author in this domain
3663: unless ($auname) { return $thisallowed; }
3664: # an author name is given, so we are about to actually make a co-author for a certain account
3665: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3666: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3667: ($audom ne $env{'request.role.domain'}))) { return ''; }
3668: }
3669: return $thisallowed;
3670: }
3671: #
3672: # Gathered so far: system, domain and course wide privileges
3673: #
3674: # Course: See if uri or referer is an individual resource that is part of
3675: # the course
3676:
3677: if ($env{'request.course.id'}) {
3678:
3679: $courseprivid=$env{'request.course.id'};
3680: if ($env{'request.course.sec'}) {
3681: $courseprivid.='/'.$env{'request.course.sec'};
3682: }
3683: $courseprivid=~s/\_/\//;
3684: my $checkreferer=1;
3685: my ($match,$cond)=&is_on_map($uri);
3686: if ($match) {
3687: $statecond=$cond;
3688: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3689: =~/\Q$priv\E\&([^\:]*)/) {
3690: $thisallowed.=$1;
3691: $checkreferer=0;
3692: }
3693: }
3694:
3695: if ($checkreferer) {
3696: my $refuri=$env{'httpref.'.$orguri};
3697: unless ($refuri) {
3698: foreach (keys %env) {
3699: if ($_=~/^httpref\..*\*/) {
3700: my $pattern=$_;
3701: $pattern=~s/^httpref\.\/res\///;
3702: $pattern=~s/\*/\[\^\/\]\+/g;
3703: $pattern=~s/\//\\\//g;
3704: if ($orguri=~/$pattern/) {
3705: $refuri=$env{$_};
3706: }
3707: }
3708: }
3709: }
3710:
3711: if ($refuri) {
3712: $refuri=&declutter($refuri);
3713: my ($match,$cond)=&is_on_map($refuri);
3714: if ($match) {
3715: my $refstatecond=$cond;
3716: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3717: =~/\Q$priv\E\&([^\:]*)/) {
3718: $thisallowed.=$1;
3719: $uri=$refuri;
3720: $statecond=$refstatecond;
3721: }
3722: }
3723: }
3724: }
3725: }
3726:
3727: #
3728: # Gathered now: all privileges that could apply, and condition number
3729: #
3730: #
3731: # Full or no access?
3732: #
3733:
3734: if ($thisallowed=~/F/) {
3735: return 'F';
3736: }
3737:
3738: unless ($thisallowed) {
3739: return '';
3740: }
3741:
3742: # Restrictions exist, deal with them
3743: #
3744: # C:according to course preferences
3745: # R:according to resource settings
3746: # L:unless locked
3747: # X:according to user session state
3748: #
3749:
3750: # Possibly locked functionality, check all courses
3751: # Locks might take effect only after 10 minutes cache expiration for other
3752: # courses, and 2 minutes for current course
3753:
3754: my $envkey;
3755: if ($thisallowed=~/L/) {
3756: foreach $envkey (keys %env) {
3757: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3758: my $courseid=$2;
3759: my $roleid=$1.'.'.$2;
3760: $courseid=~s/^\///;
3761: my $expiretime=600;
3762: if ($env{'request.role'} eq $roleid) {
3763: $expiretime=120;
3764: }
3765: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3766: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3767: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3768: &coursedescription($courseid,{'freshen_cache' => 1});
3769: }
3770: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3771: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3772: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3773: &log($env{'user.domain'},$env{'user.name'},
3774: $env{'user.home'},
3775: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3776: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3777: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3778: return '';
3779: }
3780: }
3781: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3782: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3783: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3784: &log($env{'user.domain'},$env{'user.name'},
3785: $env{'user.home'},
3786: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3787: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3788: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3789: return '';
3790: }
3791: }
3792: }
3793: }
3794: }
3795:
3796: #
3797: # Rest of the restrictions depend on selected course
3798: #
3799:
3800: unless ($env{'request.course.id'}) {
3801: if ($thisallowed eq 'A') {
3802: return 'A';
3803: } else {
3804: return '1';
3805: }
3806: }
3807:
3808: #
3809: # Now user is definitely in a course
3810: #
3811:
3812:
3813: # Course preferences
3814:
3815: if ($thisallowed=~/C/) {
3816: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3817: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3818: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3819: =~/\Q$rolecode\E/) {
3820: if ($priv ne 'pch') {
3821: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3822: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3823: $env{'request.course.id'});
3824: }
3825: return '';
3826: }
3827:
3828: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3829: =~/\Q$unamedom\E/) {
3830: if ($priv ne 'pch') {
3831: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3832: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3833: $env{'request.course.id'});
3834: }
3835: return '';
3836: }
3837: }
3838:
3839: # Resource preferences
3840:
3841: if ($thisallowed=~/R/) {
3842: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3843: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3844: if ($priv ne 'pch') {
3845: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3846: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3847: }
3848: return '';
3849: }
3850: }
3851:
3852: # Restricted by state or randomout?
3853:
3854: if ($thisallowed=~/X/) {
3855: if ($env{'acc.randomout'}) {
3856: if (!$symb) { $symb=&symbread($uri,1); }
3857: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3858: return '';
3859: }
3860: }
3861: if (&condval($statecond)) {
3862: return '2';
3863: } else {
3864: return '';
3865: }
3866: }
3867:
3868: if ($thisallowed eq 'A') {
3869: return 'A';
3870: }
3871: return 'F';
3872: }
3873:
3874: sub split_uri_for_cond {
3875: my $uri=&deversion(&declutter(shift));
3876: my @uriparts=split(/\//,$uri);
3877: my $filename=pop(@uriparts);
3878: my $pathname=join('/',@uriparts);
3879: return ($pathname,$filename);
3880: }
3881: # --------------------------------------------------- Is a resource on the map?
3882:
3883: sub is_on_map {
3884: my ($pathname,$filename) = &split_uri_for_cond(shift);
3885: #Trying to find the conditional for the file
3886: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3887: /\&\Q$filename\E\:([\d\|]+)\&/);
3888: if ($match) {
3889: return (1,$1);
3890: } else {
3891: return (0,0);
3892: }
3893: }
3894:
3895: # --------------------------------------------------------- Get symb from alias
3896:
3897: sub get_symb_from_alias {
3898: my $symb=shift;
3899: my ($map,$resid,$url)=&decode_symb($symb);
3900: # Already is a symb
3901: if ($url) { return $symb; }
3902: # Must be an alias
3903: my $aliassymb='';
3904: my %bighash;
3905: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3906: &GDBM_READER(),0640)) {
3907: my $rid=$bighash{'mapalias_'.$symb};
3908: if ($rid) {
3909: my ($mapid,$resid)=split(/\./,$rid);
3910: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3911: $resid,$bighash{'src_'.$rid});
3912: }
3913: untie %bighash;
3914: }
3915: return $aliassymb;
3916: }
3917:
3918: # ----------------------------------------------------------------- Define Role
3919:
3920: sub definerole {
3921: if (allowed('mcr','/')) {
3922: my ($rolename,$sysrole,$domrole,$courole)=@_;
3923: foreach (split(':',$sysrole)) {
3924: my ($crole,$cqual)=split(/\&/,$_);
3925: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3926: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3927: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3928: return "refused:s:$crole&$cqual";
3929: }
3930: }
3931: }
3932: foreach (split(':',$domrole)) {
3933: my ($crole,$cqual)=split(/\&/,$_);
3934: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3935: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3936: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3937: return "refused:d:$crole&$cqual";
3938: }
3939: }
3940: }
3941: foreach (split(':',$courole)) {
3942: my ($crole,$cqual)=split(/\&/,$_);
3943: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3944: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3945: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3946: return "refused:c:$crole&$cqual";
3947: }
3948: }
3949: }
3950: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3951: "$env{'user.domain'}:$env{'user.name'}:".
3952: "rolesdef_$rolename=".
3953: escape($sysrole.'_'.$domrole.'_'.$courole);
3954: return reply($command,$env{'user.home'});
3955: } else {
3956: return 'refused';
3957: }
3958: }
3959:
3960: # ---------------- Make a metadata query against the network of library servers
3961:
3962: sub metadata_query {
3963: my ($query,$custom,$customshow,$server_array)=@_;
3964: my %rhash;
3965: my @server_list = (defined($server_array) ? @$server_array
3966: : keys(%libserv) );
3967: for my $server (@server_list) {
3968: unless ($custom or $customshow) {
3969: my $reply=&reply("querysend:".&escape($query),$server);
3970: $rhash{$server}=$reply;
3971: }
3972: else {
3973: my $reply=&reply("querysend:".&escape($query).':'.
3974: &escape($custom).':'.&escape($customshow),
3975: $server);
3976: $rhash{$server}=$reply;
3977: }
3978: }
3979: return \%rhash;
3980: }
3981:
3982: # ----------------------------------------- Send log queries and wait for reply
3983:
3984: sub log_query {
3985: my ($uname,$udom,$query,%filters)=@_;
3986: my $uhome=&homeserver($uname,$udom);
3987: if ($uhome eq 'no_host') { return 'error: no_host'; }
3988: my $uhost=$hostname{$uhome};
3989: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
3990: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3991: $uhome);
3992: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
3993: return get_query_reply($queryid);
3994: }
3995:
3996: # ------- Request retrieval of institutional classlists for course(s)
3997:
3998: sub fetch_enrollment_query {
3999: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
4000: my $homeserver;
4001: my $maxtries = 1;
4002: if ($context eq 'automated') {
4003: $homeserver = $perlvar{'lonHostID'};
4004: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
4005: } else {
4006: $homeserver = &homeserver($cnum,$dom);
4007: }
4008: my $host=$hostname{$homeserver};
4009: my $cmd = '';
4010: foreach (keys %{$affiliatesref}) {
4011: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
4012: }
4013: $cmd =~ s/%%$//;
4014: $cmd = &escape($cmd);
4015: my $query = 'fetchenrollment';
4016: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
4017: unless ($queryid=~/^\Q$host\E\_/) {
4018: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
4019: return 'error: '.$queryid;
4020: }
4021: my $reply = &get_query_reply($queryid);
4022: my $tries = 1;
4023: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4024: $reply = &get_query_reply($queryid);
4025: $tries ++;
4026: }
4027: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4028: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4029: } else {
4030: my @responses = split/:/,$reply;
4031: if ($homeserver eq $perlvar{'lonHostID'}) {
4032: foreach (@responses) {
4033: my ($key,$value) = split/=/,$_;
4034: $$replyref{$key} = $value;
4035: }
4036: } else {
4037: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
4038: foreach (@responses) {
4039: my ($key,$value) = split/=/,$_;
4040: $$replyref{$key} = $value;
4041: if ($value > 0) {
4042: foreach (@{$$affiliatesref{$key}}) {
4043: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
4044: my $destname = $pathname.'/'.$filename;
4045: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
4046: if ($xml_classlist =~ /^error/) {
4047: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
4048: } else {
4049: if ( open(FILE,">$destname") ) {
4050: print FILE &unescape($xml_classlist);
4051: close(FILE);
4052: } else {
4053: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
4054: }
4055: }
4056: }
4057: }
4058: }
4059: }
4060: return 'ok';
4061: }
4062: return 'error';
4063: }
4064:
4065: sub get_query_reply {
4066: my $queryid=shift;
4067: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
4068: my $reply='';
4069: for (1..100) {
4070: sleep 2;
4071: if (-e $replyfile.'.end') {
4072: if (open(my $fh,$replyfile)) {
4073: $reply.=<$fh>;
4074: close($fh);
4075: } else { return 'error: reply_file_error'; }
4076: return &unescape($reply);
4077: }
4078: }
4079: return 'timeout:'.$queryid;
4080: }
4081:
4082: sub courselog_query {
4083: #
4084: # possible filters:
4085: # url: url or symb
4086: # username
4087: # domain
4088: # action: view, submit, grade
4089: # start: timestamp
4090: # end: timestamp
4091: #
4092: my (%filters)=@_;
4093: unless ($env{'request.course.id'}) { return 'no_course'; }
4094: if ($filters{'url'}) {
4095: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
4096: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
4097: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
4098: }
4099: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
4100: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4101: return &log_query($cname,$cdom,'courselog',%filters);
4102: }
4103:
4104: sub userlog_query {
4105: my ($uname,$udom,%filters)=@_;
4106: return &log_query($uname,$udom,'userlog',%filters);
4107: }
4108:
4109: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
4110:
4111: sub auto_run {
4112: my ($cnum,$cdom) = @_;
4113: my $homeserver = &homeserver($cnum,$cdom);
4114: my $response = &reply('autorun:'.$cdom,$homeserver);
4115: return $response;
4116: }
4117:
4118: sub auto_get_sections {
4119: my ($cnum,$cdom,$inst_coursecode) = @_;
4120: my $homeserver = &homeserver($cnum,$cdom);
4121: my @secs = ();
4122: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
4123: unless ($response eq 'refused') {
4124: @secs = split/:/,$response;
4125: }
4126: return @secs;
4127: }
4128:
4129: sub auto_new_course {
4130: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
4131: my $homeserver = &homeserver($cnum,$cdom);
4132: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
4133: return $response;
4134: }
4135:
4136: sub auto_validate_courseID {
4137: my ($cnum,$cdom,$inst_course_id) = @_;
4138: my $homeserver = &homeserver($cnum,$cdom);
4139: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
4140: return $response;
4141: }
4142:
4143: sub auto_create_password {
4144: my ($cnum,$cdom,$authparam) = @_;
4145: my $homeserver = &homeserver($cnum,$cdom);
4146: my $create_passwd = 0;
4147: my $authchk = '';
4148: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
4149: if ($response eq 'refused') {
4150: $authchk = 'refused';
4151: } else {
4152: ($authparam,$create_passwd,$authchk) = split/:/,$response;
4153: }
4154: return ($authparam,$create_passwd,$authchk);
4155: }
4156:
4157: sub auto_photo_permission {
4158: my ($cnum,$cdom,$students) = @_;
4159: my $homeserver = &homeserver($cnum,$cdom);
4160: my ($outcome,$perm_reqd,$conditions) =
4161: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
4162: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4163: return (undef,undef);
4164: }
4165: return ($outcome,$perm_reqd,$conditions);
4166: }
4167:
4168: sub auto_checkphotos {
4169: my ($uname,$udom,$pid) = @_;
4170: my $homeserver = &homeserver($uname,$udom);
4171: my ($result,$resulttype);
4172: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
4173: &escape($uname).':'.&escape($pid),
4174: $homeserver));
4175: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4176: return (undef,undef);
4177: }
4178: if ($outcome) {
4179: ($result,$resulttype) = split(/:/,$outcome);
4180: }
4181: return ($result,$resulttype);
4182: }
4183:
4184: sub auto_photochoice {
4185: my ($cnum,$cdom) = @_;
4186: my $homeserver = &homeserver($cnum,$cdom);
4187: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
4188: &escape($cdom),
4189: $homeserver)));
4190: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
4191: return (undef,undef);
4192: }
4193: return ($update,$comment);
4194: }
4195:
4196: sub auto_photoupdate {
4197: my ($affiliatesref,$dom,$cnum,$photo) = @_;
4198: my $homeserver = &homeserver($cnum,$dom);
4199: my $host=$hostname{$homeserver};
4200: my $cmd = '';
4201: my $maxtries = 1;
4202: foreach (keys %{$affiliatesref}) {
4203: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
4204: }
4205: $cmd =~ s/%%$//;
4206: $cmd = &escape($cmd);
4207: my $query = 'institutionalphotos';
4208: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
4209: unless ($queryid=~/^\Q$host\E\_/) {
4210: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
4211: return 'error: '.$queryid;
4212: }
4213: my $reply = &get_query_reply($queryid);
4214: my $tries = 1;
4215: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
4216: $reply = &get_query_reply($queryid);
4217: $tries ++;
4218: }
4219: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
4220: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
4221: } else {
4222: my @responses = split(/:/,$reply);
4223: my $outcome = shift(@responses);
4224: foreach my $item (@responses) {
4225: my ($key,$value) = split(/=/,$item);
4226: $$photo{$key} = $value;
4227: }
4228: return $outcome;
4229: }
4230: return 'error';
4231: }
4232:
4233: sub auto_instcode_format {
4234: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
4235: $cat_order) = @_;
4236: my $courses = '';
4237: my @homeservers;
4238: if ($caller eq 'global') {
4239: foreach my $tryserver (keys(%libserv)) {
4240: if ($hostdom{$tryserver} eq $codedom) {
4241: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4242: push(@homeservers,$tryserver);
4243: }
4244: }
4245: }
4246: } else {
4247: push(@homeservers,&homeserver($caller,$codedom));
4248: }
4249: foreach my $code (keys(%{$instcodes})) {
4250: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
4251: }
4252: chop($courses);
4253: my $ok_response = 0;
4254: my $response;
4255: while (@homeservers > 0 && $ok_response == 0) {
4256: my $server = shift(@homeservers);
4257: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
4258: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4259: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
4260: split/:/,$response;
4261: %{$codes} = (%{$codes},&str2hash($codes_str));
4262: push(@{$codetitles},&str2array($codetitles_str));
4263: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
4264: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
4265: $ok_response = 1;
4266: }
4267: }
4268: if ($ok_response) {
4269: return 'ok';
4270: } else {
4271: return $response;
4272: }
4273: }
4274:
4275: sub auto_instcode_defaults {
4276: my ($domain,$returnhash,$code_order) = @_;
4277: my @homeservers;
4278: foreach my $tryserver (keys(%libserv)) {
4279: if ($hostdom{$tryserver} eq $domain) {
4280: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
4281: push(@homeservers,$tryserver);
4282: }
4283: }
4284: }
4285: my $ok_response = 0;
4286: my $response;
4287: while (@homeservers > 0 && $ok_response == 0) {
4288: my $server = shift(@homeservers);
4289: $response=&reply('autoinstcodedefaults:'.$domain,$server);
4290: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
4291: foreach my $pair (split(/\&/,$response)) {
4292: my ($name,$value)=split(/\=/,$pair);
4293: if ($name eq 'code_order') {
4294: @{$code_order} = split(/\&/,&unescape($value));
4295: } else {
4296: $returnhash->{&unescape($name)}=&unescape($value);
4297: }
4298: }
4299: }
4300: $ok_response = 1;
4301: }
4302: if ($ok_response) {
4303: return 'ok';
4304: } else {
4305: return $response;
4306: }
4307: }
4308:
4309: sub auto_validate_class_sec {
4310: my ($cdom,$cnum,$owner,$inst_class) = @_;
4311: my $homeserver = &homeserver($cnum,$cdom);
4312: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
4313: &escape($owner).':'.$cdom,$homeserver);
4314: return $response;
4315: }
4316:
4317: # ------------------------------------------------------- Course Group routines
4318:
4319: sub get_coursegroups {
4320: my ($cdom,$cnum,$group) = @_;
4321: return(&dump('coursegroups',$cdom,$cnum,$group));
4322: }
4323:
4324: sub modify_coursegroup {
4325: my ($cdom,$cnum,$groupsettings) = @_;
4326: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4327: }
4328:
4329: sub modify_group_roles {
4330: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4331: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4332: my $role = 'gr/'.&escape($userprivs);
4333: my ($uname,$udom) = split(/:/,$user);
4334: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4335: if ($result eq 'ok') {
4336: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4337: }
4338: return $result;
4339: }
4340:
4341: sub modify_coursegroup_membership {
4342: my ($cdom,$cnum,$membership) = @_;
4343: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4344: return $result;
4345: }
4346:
4347: sub get_active_groups {
4348: my ($udom,$uname,$cdom,$cnum) = @_;
4349: my $now = time;
4350: my %groups = ();
4351: foreach my $key (keys(%env)) {
4352: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4353: my ($start,$end) = split(/\./,$env{$key});
4354: if (($end!=0) && ($end<$now)) { next; }
4355: if (($start!=0) && ($start>$now)) { next; }
4356: if ($1 eq $cdom && $2 eq $cnum) {
4357: $groups{$3} = $env{$key} ;
4358: }
4359: }
4360: }
4361: return %groups;
4362: }
4363:
4364: sub get_group_membership {
4365: my ($cdom,$cnum,$group) = @_;
4366: return(&dump('groupmembership',$cdom,$cnum,$group));
4367: }
4368:
4369: sub get_users_groups {
4370: my ($udom,$uname,$courseid) = @_;
4371: my @usersgroups;
4372: my $cachetime=1800;
4373: $courseid=~s/\_/\//g;
4374: $courseid=~s/^(\w)/\/$1/;
4375:
4376: my $hashid="$udom:$uname:$courseid";
4377: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4378: if (defined($cached)) {
4379: @usersgroups = split(/:/,$grouplist);
4380: } else {
4381: $grouplist = '';
4382: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4383: my ($tmp) = keys(%roleshash);
4384: if ($tmp=~/^error:/) {
4385: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4386: } else {
4387: my $access_end = $env{'course.'.$courseid.
4388: '.default_enrollment_end_date'};
4389: my $now = time;
4390: foreach my $key (keys(%roleshash)) {
4391: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4392: my $group = $1;
4393: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4394: my $start = $2;
4395: my $end = $1;
4396: if ($start == -1) { next; } # deleted from group
4397: if (($start!=0) && ($start>$now)) { next; }
4398: if (($end!=0) && ($end<$now)) {
4399: if ($access_end && $access_end < $now) {
4400: if ($access_end - $end < 86400) {
4401: push(@usersgroups,$group);
4402: }
4403: }
4404: next;
4405: }
4406: push(@usersgroups,$group);
4407: }
4408: }
4409: }
4410: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4411: $grouplist = join(':',@usersgroups);
4412: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4413: }
4414: }
4415: return @usersgroups;
4416: }
4417:
4418: sub devalidate_getgroups_cache {
4419: my ($udom,$uname,$cdom,$cnum)=@_;
4420: my $courseid = $cdom.'_'.$cnum;
4421: $courseid=~s/\_/\//g;
4422: $courseid=~s/^(\w)/\/$1/;
4423: my $hashid="$udom:$uname:$courseid";
4424: &devalidate_cache_new('getgroups',$hashid);
4425: }
4426:
4427: # ------------------------------------------------------------------ Plain Text
4428:
4429: sub plaintext {
4430: my ($short,$type,$cid) = @_;
4431: if ($short =~ /^cr/) {
4432: return (split('/',$short))[-1];
4433: }
4434: if (!defined($cid)) {
4435: $cid = $env{'request.course.id'};
4436: }
4437: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4438: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4439: '.plaintext'});
4440: }
4441: my %rolenames = (
4442: Course => 'std',
4443: Group => 'alt1',
4444: );
4445: if (defined($type) &&
4446: defined($rolenames{$type}) &&
4447: defined($prp{$short}{$rolenames{$type}})) {
4448: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4449: } else {
4450: return &Apache::lonlocal::mt($prp{$short}{'std'});
4451: }
4452: }
4453:
4454: # ----------------------------------------------------------------- Assign Role
4455:
4456: sub assignrole {
4457: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4458: my $mrole;
4459: if ($role =~ /^cr\//) {
4460: my $cwosec=$url;
4461: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4462: unless (&allowed('ccr',$cwosec)) {
4463: &logthis('Refused custom assignrole: '.
4464: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4465: $env{'user.name'}.' at '.$env{'user.domain'});
4466: return 'refused';
4467: }
4468: $mrole='cr';
4469: } elsif ($role =~ /^gr\//) {
4470: my $cwogrp=$url;
4471: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4472: unless (&allowed('mdg',$cwogrp)) {
4473: &logthis('Refused group assignrole: '.
4474: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4475: $env{'user.name'}.' at '.$env{'user.domain'});
4476: return 'refused';
4477: }
4478: $mrole='gr';
4479: } else {
4480: my $cwosec=$url;
4481: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4482: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4483: &logthis('Refused assignrole: '.
4484: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4485: $env{'user.name'}.' at '.$env{'user.domain'});
4486: return 'refused';
4487: }
4488: $mrole=$role;
4489: }
4490: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4491: "$udom:$uname:$url".'_'."$mrole=$role";
4492: if ($end) { $command.='_'.$end; }
4493: if ($start) {
4494: if ($end) {
4495: $command.='_'.$start;
4496: } else {
4497: $command.='_0_'.$start;
4498: }
4499: }
4500: my $origstart = $start;
4501: my $origend = $end;
4502: # actually delete
4503: if ($deleteflag) {
4504: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4505: # modify command to delete the role
4506: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4507: "$udom:$uname:$url".'_'."$mrole";
4508: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4509: # set start and finish to negative values for userrolelog
4510: $start=-1;
4511: $end=-1;
4512: }
4513: }
4514: # send command
4515: my $answer=&reply($command,&homeserver($uname,$udom));
4516: # log new user role if status is ok
4517: if ($answer eq 'ok') {
4518: &userrolelog($role,$uname,$udom,$url,$start,$end);
4519: # for course roles, perform group memberships changes triggered by role change.
4520: unless ($role =~ /^gr/) {
4521: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4522: $origstart);
4523: }
4524: }
4525: return $answer;
4526: }
4527:
4528: # -------------------------------------------------- Modify user authentication
4529: # Overrides without validation
4530:
4531: sub modifyuserauth {
4532: my ($udom,$uname,$umode,$upass)=@_;
4533: my $uhome=&homeserver($uname,$udom);
4534: unless (&allowed('mau',$udom)) { return 'refused'; }
4535: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4536: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4537: ' in domain '.$env{'request.role.domain'});
4538: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4539: &escape($upass),$uhome);
4540: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4541: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4542: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4543: &log($udom,,$uname,$uhome,
4544: 'Authentication changed by '.$env{'user.domain'}.', '.
4545: $env{'user.name'}.', '.$umode.
4546: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4547: unless ($reply eq 'ok') {
4548: &logthis('Authentication mode error: '.$reply);
4549: return 'error: '.$reply;
4550: }
4551: return 'ok';
4552: }
4553:
4554: # --------------------------------------------------------------- Modify a user
4555:
4556: sub modifyuser {
4557: my ($udom, $uname, $uid,
4558: $umode, $upass, $first,
4559: $middle, $last, $gene,
4560: $forceid, $desiredhome, $email)=@_;
4561: $udom=~s/\W//g;
4562: $uname=~s/\W//g;
4563: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4564: $umode.', '.$first.', '.$middle.', '.
4565: $last.', '.$gene.'(forceid: '.$forceid.')'.
4566: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4567: ' desiredhome not specified').
4568: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4569: ' in domain '.$env{'request.role.domain'});
4570: my $uhome=&homeserver($uname,$udom,'true');
4571: # ----------------------------------------------------------------- Create User
4572: if (($uhome eq 'no_host') &&
4573: (($umode && $upass) || ($umode eq 'localauth'))) {
4574: my $unhome='';
4575: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4576: $unhome = $desiredhome;
4577: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4578: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4579: } else { # load balancing routine for determining $unhome
4580: my $tryserver;
4581: my $loadm=10000000;
4582: foreach $tryserver (keys %libserv) {
4583: if ($hostdom{$tryserver} eq $udom) {
4584: my $answer=reply('load',$tryserver);
4585: if (($answer=~/\d+/) && ($answer<$loadm)) {
4586: $loadm=$answer;
4587: $unhome=$tryserver;
4588: }
4589: }
4590: }
4591: }
4592: if (($unhome eq '') || ($unhome eq 'no_host')) {
4593: return 'error: unable to find a home server for '.$uname.
4594: ' in domain '.$udom;
4595: }
4596: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4597: &escape($upass),$unhome);
4598: unless ($reply eq 'ok') {
4599: return 'error: '.$reply;
4600: }
4601: $uhome=&homeserver($uname,$udom,'true');
4602: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4603: return 'error: unable verify users home machine.';
4604: }
4605: } # End of creation of new user
4606: # ---------------------------------------------------------------------- Add ID
4607: if ($uid) {
4608: $uid=~tr/A-Z/a-z/;
4609: my %uidhash=&idrget($udom,$uname);
4610: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4611: && (!$forceid)) {
4612: unless ($uid eq $uidhash{$uname}) {
4613: return 'error: user id "'.$uid.'" does not match '.
4614: 'current user id "'.$uidhash{$uname}.'".';
4615: }
4616: } else {
4617: &idput($udom,($uname => $uid));
4618: }
4619: }
4620: # -------------------------------------------------------------- Add names, etc
4621: my @tmp=&get('environment',
4622: ['firstname','middlename','lastname','generation'],
4623: $udom,$uname);
4624: my %names;
4625: if ($tmp[0] =~ m/^error:.*/) {
4626: %names=();
4627: } else {
4628: %names = @tmp;
4629: }
4630: #
4631: # Make sure to not trash student environment if instructor does not bother
4632: # to supply name and email information
4633: #
4634: if ($first) { $names{'firstname'} = $first; }
4635: if (defined($middle)) { $names{'middlename'} = $middle; }
4636: if ($last) { $names{'lastname'} = $last; }
4637: if (defined($gene)) { $names{'generation'} = $gene; }
4638: if ($email) {
4639: $email=~s/[^\w\@\.\-\,]//gs;
4640: if ($email=~/\@/) { $names{'notification'} = $email;
4641: $names{'critnotification'} = $email;
4642: $names{'permanentemail'} = $email; }
4643: }
4644: my $reply = &put('environment', \%names, $udom,$uname);
4645: if ($reply ne 'ok') { return 'error: '.$reply; }
4646: &devalidate_cache_new('namescache',$uname.':'.$udom);
4647: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4648: $umode.', '.$first.', '.$middle.', '.
4649: $last.', '.$gene.' by '.
4650: $env{'user.name'}.' at '.$env{'user.domain'});
4651: return 'ok';
4652: }
4653:
4654: # -------------------------------------------------------------- Modify student
4655:
4656: sub modifystudent {
4657: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4658: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4659: if (!$cid) {
4660: unless ($cid=$env{'request.course.id'}) {
4661: return 'not_in_class';
4662: }
4663: }
4664: # --------------------------------------------------------------- Make the user
4665: my $reply=&modifyuser
4666: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4667: $desiredhome,$email);
4668: unless ($reply eq 'ok') { return $reply; }
4669: # This will cause &modify_student_enrollment to get the uid from the
4670: # students environment
4671: $uid = undef if (!$forceid);
4672: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4673: $gene,$usec,$end,$start,$type,$locktype,$cid);
4674: return $reply;
4675: }
4676:
4677: sub modify_student_enrollment {
4678: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4679: my ($cdom,$cnum,$chome);
4680: if (!$cid) {
4681: unless ($cid=$env{'request.course.id'}) {
4682: return 'not_in_class';
4683: }
4684: $cdom=$env{'course.'.$cid.'.domain'};
4685: $cnum=$env{'course.'.$cid.'.num'};
4686: } else {
4687: ($cdom,$cnum)=split(/_/,$cid);
4688: }
4689: $chome=$env{'course.'.$cid.'.home'};
4690: if (!$chome) {
4691: $chome=&homeserver($cnum,$cdom);
4692: }
4693: if (!$chome) { return 'unknown_course'; }
4694: # Make sure the user exists
4695: my $uhome=&homeserver($uname,$udom);
4696: if (($uhome eq '') || ($uhome eq 'no_host')) {
4697: return 'error: no such user';
4698: }
4699: # Get student data if we were not given enough information
4700: if (!defined($first) || $first eq '' ||
4701: !defined($last) || $last eq '' ||
4702: !defined($uid) || $uid eq '' ||
4703: !defined($middle) || $middle eq '' ||
4704: !defined($gene) || $gene eq '') {
4705: # They did not supply us with enough data to enroll the student, so
4706: # we need to pick up more information.
4707: my %tmp = &get('environment',
4708: ['firstname','middlename','lastname', 'generation','id']
4709: ,$udom,$uname);
4710:
4711: #foreach (keys(%tmp)) {
4712: # &logthis("key $_ = ".$tmp{$_});
4713: #}
4714: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4715: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4716: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4717: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4718: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4719: }
4720: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4721: my $reply=cput('classlist',
4722: {"$uname:$udom" =>
4723: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4724: $cdom,$cnum);
4725: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4726: return 'error: '.$reply;
4727: } else {
4728: &devalidate_getsection_cache($udom,$uname,$cid);
4729: }
4730: # Add student role to user
4731: my $uurl='/'.$cid;
4732: $uurl=~s/\_/\//g;
4733: if ($usec) {
4734: $uurl.='/'.$usec;
4735: }
4736: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4737: }
4738:
4739: sub format_name {
4740: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4741: my $name;
4742: if ($first ne 'lastname') {
4743: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4744: } else {
4745: if ($lastname=~/\S/) {
4746: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4747: $name=~s/\s+,/,/;
4748: } else {
4749: $name.= $firstname.' '.$middlename.' '.$generation;
4750: }
4751: }
4752: $name=~s/^\s+//;
4753: $name=~s/\s+$//;
4754: $name=~s/\s+/ /g;
4755: return $name;
4756: }
4757:
4758: # ------------------------------------------------- Write to course preferences
4759:
4760: sub writecoursepref {
4761: my ($courseid,%prefs)=@_;
4762: $courseid=~s/^\///;
4763: $courseid=~s/\_/\//g;
4764: my ($cdomain,$cnum)=split(/\//,$courseid);
4765: my $chome=homeserver($cnum,$cdomain);
4766: if (($chome eq '') || ($chome eq 'no_host')) {
4767: return 'error: no such course';
4768: }
4769: my $cstring='';
4770: foreach (keys %prefs) {
4771: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
4772: }
4773: $cstring=~s/\&$//;
4774: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4775: }
4776:
4777: # ---------------------------------------------------------- Make/modify course
4778:
4779: sub createcourse {
4780: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4781: $course_owner,$crstype)=@_;
4782: $url=&declutter($url);
4783: my $cid='';
4784: unless (&allowed('ccc',$udom)) {
4785: return 'refused';
4786: }
4787: # ------------------------------------------------------------------- Create ID
4788: my $uname=int(1+rand(9)).
4789: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4790: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4791: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4792: # ----------------------------------------------- Make sure that does not exist
4793: my $uhome=&homeserver($uname,$udom,'true');
4794: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4795: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4796: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4797: $uhome=&homeserver($uname,$udom,'true');
4798: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4799: return 'error: unable to generate unique course-ID';
4800: }
4801: }
4802: # ------------------------------------------------ Check supplied server name
4803: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4804: if (! exists($libserv{$course_server})) {
4805: return 'error:bad server name '.$course_server;
4806: }
4807: # ------------------------------------------------------------- Make the course
4808: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4809: $course_server);
4810: unless ($reply eq 'ok') { return 'error: '.$reply; }
4811: $uhome=&homeserver($uname,$udom,'true');
4812: if (($uhome eq '') || ($uhome eq 'no_host')) {
4813: return 'error: no such course';
4814: }
4815: # ----------------------------------------------------------------- Course made
4816: # log existence
4817: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4818: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4819: &escape($crstype),$uhome);
4820: &flushcourselogs();
4821: # set toplevel url
4822: my $topurl=$url;
4823: unless ($nonstandard) {
4824: # ------------------------------------------ For standard courses, make top url
4825: my $mapurl=&clutter($url);
4826: if ($mapurl eq '/res/') { $mapurl=''; }
4827: $env{'form.initmap'}=(<<ENDINITMAP);
4828: <map>
4829: <resource id="1" type="start"></resource>
4830: <resource id="2" src="$mapurl"></resource>
4831: <resource id="3" type="finish"></resource>
4832: <link index="1" from="1" to="2"></link>
4833: <link index="2" from="2" to="3"></link>
4834: </map>
4835: ENDINITMAP
4836: $topurl=&declutter(
4837: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
4838: );
4839: }
4840: # ----------------------------------------------------------- Write preferences
4841: &writecoursepref($udom.'_'.$uname,
4842: ('description' => $description,
4843: 'url' => $topurl));
4844: return '/'.$udom.'/'.$uname;
4845: }
4846:
4847: # ---------------------------------------------------------- Assign Custom Role
4848:
4849: sub assigncustomrole {
4850: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
4851: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
4852: $end,$start,$deleteflag);
4853: }
4854:
4855: # ----------------------------------------------------------------- Revoke Role
4856:
4857: sub revokerole {
4858: my ($udom,$uname,$url,$role,$deleteflag)=@_;
4859: my $now=time;
4860: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
4861: }
4862:
4863: # ---------------------------------------------------------- Revoke Custom Role
4864:
4865: sub revokecustomrole {
4866: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
4867: my $now=time;
4868: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4869: $deleteflag);
4870: }
4871:
4872: # ------------------------------------------------------------ Disk usage
4873: sub diskusage {
4874: my ($udom,$uname,$directoryRoot)=@_;
4875: $directoryRoot =~ s/\/$//;
4876: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
4877: return $listing;
4878: }
4879:
4880: sub is_locked {
4881: my ($file_name, $domain, $user) = @_;
4882: my @check;
4883: my $is_locked;
4884: push @check, $file_name;
4885: my %locked = &get('file_permissions',\@check,
4886: $env{'user.domain'},$env{'user.name'});
4887: my ($tmp)=keys(%locked);
4888: if ($tmp=~/^error:/) { undef(%locked); }
4889:
4890: if (ref($locked{$file_name}) eq 'ARRAY') {
4891: $is_locked = 'false';
4892: foreach my $entry (@{$locked{$file_name}}) {
4893: if (ref($entry) eq 'ARRAY') {
4894: $is_locked = 'true';
4895: last;
4896: }
4897: }
4898: } else {
4899: $is_locked = 'false';
4900: }
4901: }
4902:
4903: sub declutter_portfile {
4904: my ($file) = @_;
4905: &logthis("got $file");
4906: $file =~ s-^(/portfolio/|portfolio/)-/-;
4907: &logthis("ret $file");
4908: return $file;
4909: }
4910:
4911: # ------------------------------------------------------------- Mark as Read Only
4912:
4913: sub mark_as_readonly {
4914: my ($domain,$user,$files,$what) = @_;
4915: my %current_permissions = &dump('file_permissions',$domain,$user);
4916: my ($tmp)=keys(%current_permissions);
4917: if ($tmp=~/^error:/) { undef(%current_permissions); }
4918: foreach my $file (@{$files}) {
4919: $file = &declutter_portfile($file);
4920: push(@{$current_permissions{$file}},$what);
4921: }
4922: &put('file_permissions',\%current_permissions,$domain,$user);
4923: return;
4924: }
4925:
4926: # ------------------------------------------------------------Save Selected Files
4927:
4928: sub save_selected_files {
4929: my ($user, $path, @files) = @_;
4930: my $filename = $user."savedfiles";
4931: my @other_files = &files_not_in_path($user, $path);
4932: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4933: foreach my $file (@files) {
4934: print (OUT $env{'form.currentpath'}.$file."\n");
4935: }
4936: foreach my $file (@other_files) {
4937: print (OUT $file."\n");
4938: }
4939: close (OUT);
4940: return 'ok';
4941: }
4942:
4943: sub clear_selected_files {
4944: my ($user) = @_;
4945: my $filename = $user."savedfiles";
4946: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4947: print (OUT undef);
4948: close (OUT);
4949: return ("ok");
4950: }
4951:
4952: sub files_in_path {
4953: my ($user, $path) = @_;
4954: my $filename = $user."savedfiles";
4955: my %return_files;
4956: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4957: while (my $line_in = <IN>) {
4958: chomp ($line_in);
4959: my @paths_and_file = split (m!/!, $line_in);
4960: my $file_part = pop (@paths_and_file);
4961: my $path_part = join ('/', @paths_and_file);
4962: $path_part.='/';
4963: my $path_and_file = $path_part.$file_part;
4964: if ($path_part eq $path) {
4965: $return_files{$file_part}= 'selected';
4966: }
4967: }
4968: close (IN);
4969: return (\%return_files);
4970: }
4971:
4972: # called in portfolio select mode, to show files selected NOT in current directory
4973: sub files_not_in_path {
4974: my ($user, $path) = @_;
4975: my $filename = $user."savedfiles";
4976: my @return_files;
4977: my $path_part;
4978: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4979: while (<IN>) {
4980: #ok, I know it's clunky, but I want it to work
4981: my @paths_and_file = split m!/!, $_;
4982: my $file_part = pop (@paths_and_file);
4983: chomp ($file_part);
4984: my $path_part = join ('/', @paths_and_file);
4985: $path_part .= '/';
4986: my $path_and_file = $path_part.$file_part;
4987: if ($path_part ne $path) {
4988: push (@return_files, ($path_and_file));
4989: }
4990: }
4991: close (OUT);
4992: return (@return_files);
4993: }
4994:
4995: #----------------------------------------------Get portfolio file permissions
4996:
4997: sub get_portfile_permissions {
4998: my ($domain,$user) = @_;
4999: my %current_permissions = &dump('file_permissions',$domain,$user);
5000: my ($tmp)=keys(%current_permissions);
5001: if ($tmp=~/^error:/) { undef(%current_permissions); }
5002: return \%current_permissions;
5003: }
5004:
5005: #---------------------------------------------Get portfolio file access controls
5006:
5007: sub get_access_controls {
5008: my ($current_permissions,$group,$file) = @_;
5009: my %access;
5010: my $real_file = $file;
5011: $file =~ s/\.meta$//;
5012: if (defined($file)) {
5013: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
5014: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
5015: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
5016: }
5017: }
5018: } else {
5019: foreach my $key (keys(%{$current_permissions})) {
5020: if ($key =~ /\0accesscontrol$/) {
5021: if (defined($group)) {
5022: if ($key !~ m-^\Q$group\E/-) {
5023: next;
5024: }
5025: }
5026: my ($fullpath) = split(/\0/,$key);
5027: if (ref($$current_permissions{$key}) eq 'HASH') {
5028: foreach my $control (keys(%{$$current_permissions{$key}})) {
5029: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
5030: }
5031: }
5032: }
5033: }
5034: }
5035: return %access;
5036: }
5037:
5038: sub modify_access_controls {
5039: my ($file_name,$changes,$domain,$user)=@_;
5040: my ($outcome,$deloutcome);
5041: my %store_permissions;
5042: my %new_values;
5043: my %new_control;
5044: my %translation;
5045: my @deletions = ();
5046: my $now = time;
5047: if (exists($$changes{'activate'})) {
5048: if (ref($$changes{'activate'}) eq 'HASH') {
5049: my @newitems = sort(keys(%{$$changes{'activate'}}));
5050: my $numnew = scalar(@newitems);
5051: for (my $i=0; $i<$numnew; $i++) {
5052: my $newkey = $newitems[$i];
5053: my $newid = &Apache::loncommon::get_cgi_id();
5054: if ($newkey =~ /^\d+:/) {
5055: $newkey =~ s/^(\d+)/$newid/;
5056: $translation{$1} = $newid;
5057: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
5058: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
5059: $translation{$1} = $newid;
5060: }
5061: $new_values{$file_name."\0".$newkey} =
5062: $$changes{'activate'}{$newitems[$i]};
5063: $new_control{$newkey} = $now;
5064: }
5065: }
5066: }
5067: my %todelete;
5068: my %changed_items;
5069: foreach my $action ('delete','update') {
5070: if (exists($$changes{$action})) {
5071: if (ref($$changes{$action}) eq 'HASH') {
5072: foreach my $key (keys(%{$$changes{$action}})) {
5073: my ($itemnum) = ($key =~ /^([^:]+):/);
5074: if ($action eq 'delete') {
5075: $todelete{$itemnum} = 1;
5076: } else {
5077: $changed_items{$itemnum} = $key;
5078: }
5079: }
5080: }
5081: }
5082: }
5083: # get lock on access controls for file.
5084: my $lockhash = {
5085: $file_name."\0".'locked_access_records' => $env{'user.name'}.
5086: ':'.$env{'user.domain'},
5087: };
5088: my $tries = 0;
5089: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5090:
5091: while (($gotlock ne 'ok') && $tries <3) {
5092: $tries ++;
5093: sleep 1;
5094: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
5095: }
5096: if ($gotlock eq 'ok') {
5097: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
5098: my ($tmp)=keys(%curr_permissions);
5099: if ($tmp=~/^error:/) { undef(%curr_permissions); }
5100: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
5101: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
5102: if (ref($curr_controls) eq 'HASH') {
5103: foreach my $control_item (keys(%{$curr_controls})) {
5104: my ($itemnum) = ($control_item =~ /^([^:]+):/);
5105: if (defined($todelete{$itemnum})) {
5106: push(@deletions,$file_name."\0".$control_item);
5107: } else {
5108: if (defined($changed_items{$itemnum})) {
5109: $new_control{$changed_items{$itemnum}} = $now;
5110: push(@deletions,$file_name."\0".$control_item);
5111: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
5112: } else {
5113: $new_control{$control_item} = $$curr_controls{$control_item};
5114: }
5115: }
5116: }
5117: }
5118: }
5119: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
5120: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
5121: $outcome = &put('file_permissions',\%new_values,$domain,$user);
5122: # remove lock
5123: my @del_lock = ($file_name."\0".'locked_access_records');
5124: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
5125: } else {
5126: $outcome = "error: could not obtain lockfile\n";
5127: }
5128: return ($outcome,$deloutcome,\%new_values,\%translation);
5129: }
5130:
5131: #------------------------------------------------------Get Marked as Read Only
5132:
5133: sub get_marked_as_readonly {
5134: my ($domain,$user,$what,$group) = @_;
5135: my $current_permissions = &get_portfile_permissions($domain,$user);
5136: my @readonly_files;
5137: my $cmp1=$what;
5138: if (ref($what)) { $cmp1=join('',@{$what}) };
5139: while (my ($file_name,$value) = each(%{$current_permissions})) {
5140: if (defined($group)) {
5141: if ($file_name !~ m-^\Q$group\E/-) {
5142: next;
5143: }
5144: }
5145: if (ref($value) eq "ARRAY"){
5146: foreach my $stored_what (@{$value}) {
5147: my $cmp2=$stored_what;
5148: if (ref($stored_what) eq 'ARRAY') {
5149: $cmp2=join('',@{$stored_what});
5150: }
5151: if ($cmp1 eq $cmp2) {
5152: push(@readonly_files, $file_name);
5153: last;
5154: } elsif (!defined($what)) {
5155: push(@readonly_files, $file_name);
5156: last;
5157: }
5158: }
5159: }
5160: }
5161: return @readonly_files;
5162: }
5163: #-----------------------------------------------------------Get Marked as Read Only Hash
5164:
5165: sub get_marked_as_readonly_hash {
5166: my ($current_permissions,$group,$what) = @_;
5167: my %readonly_files;
5168: while (my ($file_name,$value) = each(%{$current_permissions})) {
5169: if (defined($group)) {
5170: if ($file_name !~ m-^\Q$group\E/-) {
5171: next;
5172: }
5173: }
5174: if (ref($value) eq "ARRAY"){
5175: foreach my $stored_what (@{$value}) {
5176: if (ref($stored_what) eq 'ARRAY') {
5177: foreach my $lock_descriptor(@{$stored_what}) {
5178: if ($lock_descriptor eq 'graded') {
5179: $readonly_files{$file_name} = 'graded';
5180: } elsif ($lock_descriptor eq 'handback') {
5181: $readonly_files{$file_name} = 'handback';
5182: } else {
5183: if (!exists($readonly_files{$file_name})) {
5184: $readonly_files{$file_name} = 'locked';
5185: }
5186: }
5187: }
5188: }
5189: }
5190: }
5191: }
5192: return %readonly_files;
5193: }
5194: # ------------------------------------------------------------ Unmark as Read Only
5195:
5196: sub unmark_as_readonly {
5197: # unmarks $file_name (if $file_name is defined), or all files locked by $what
5198: # for portfolio submissions, $what contains [$symb,$crsid]
5199: my ($domain,$user,$what,$file_name,$group) = @_;
5200: $file_name = &declutter_portfile($file_name);
5201: my $symb_crs = $what;
5202: if (ref($what)) { $symb_crs=join('',@$what); }
5203: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
5204: my ($tmp)=keys(%current_permissions);
5205: if ($tmp=~/^error:/) { undef(%current_permissions); }
5206: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
5207: foreach my $file (@readonly_files) {
5208: my $clean_file = &declutter_portfile($file);
5209: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
5210: my $current_locks = $current_permissions{$file};
5211: my @new_locks;
5212: my @del_keys;
5213: if (ref($current_locks) eq "ARRAY"){
5214: foreach my $locker (@{$current_locks}) {
5215: my $compare=$locker;
5216: if (ref($locker) eq 'ARRAY') {
5217: $compare=join('',@{$locker});
5218: if ($compare ne $symb_crs) {
5219: push(@new_locks, $locker);
5220: }
5221: }
5222: }
5223: if (scalar(@new_locks) > 0) {
5224: $current_permissions{$file} = \@new_locks;
5225: } else {
5226: push(@del_keys, $file);
5227: &del('file_permissions',\@del_keys, $domain, $user);
5228: delete($current_permissions{$file});
5229: }
5230: }
5231: }
5232: &put('file_permissions',\%current_permissions,$domain,$user);
5233: return;
5234: }
5235:
5236: # ------------------------------------------------------------ Directory lister
5237:
5238: sub dirlist {
5239: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
5240:
5241: $uri=~s/^\///;
5242: $uri=~s/\/$//;
5243: my ($udom, $uname);
5244: (undef,$udom,$uname)=split(/\//,$uri);
5245: if(defined($userdomain)) {
5246: $udom = $userdomain;
5247: }
5248: if(defined($username)) {
5249: $uname = $username;
5250: }
5251:
5252: my $dirRoot = $perlvar{'lonDocRoot'};
5253: if(defined($alternateDirectoryRoot)) {
5254: $dirRoot = $alternateDirectoryRoot;
5255: $dirRoot =~ s/\/$//;
5256: }
5257:
5258: if($udom) {
5259: if($uname) {
5260: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
5261: homeserver($uname,$udom));
5262: my @listing_results;
5263: if ($listing eq 'unknown_cmd') {
5264: $listing=reply('ls:'.$dirRoot.'/'.$uri,
5265: homeserver($uname,$udom));
5266: @listing_results = split(/:/,$listing);
5267: } else {
5268: @listing_results = map { &unescape($_); } split(/:/,$listing);
5269: }
5270: return @listing_results;
5271: } elsif(!defined($alternateDirectoryRoot)) {
5272: my $tryserver;
5273: my %allusers=();
5274: foreach $tryserver (keys %libserv) {
5275: if($hostdom{$tryserver} eq $udom) {
5276: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
5277: $udom, $tryserver);
5278: my @listing_results;
5279: if ($listing eq 'unknown_cmd') {
5280: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
5281: $udom, $tryserver);
5282: @listing_results = split(/:/,$listing);
5283: } else {
5284: @listing_results =
5285: map { &unescape($_); } split(/:/,$listing);
5286: }
5287: if ($listing_results[0] ne 'no_such_dir' &&
5288: $listing_results[0] ne 'empty' &&
5289: $listing_results[0] ne 'con_lost') {
5290: foreach (@listing_results) {
5291: my ($entry,@stat)=split(/&/,$_);
5292: $allusers{$entry}=1;
5293: }
5294: }
5295: }
5296: }
5297: my $alluserstr='';
5298: foreach (sort keys %allusers) {
5299: $alluserstr.=$_.'&user:';
5300: }
5301: $alluserstr=~s/:$//;
5302: return split(/:/,$alluserstr);
5303: } else {
5304: my @emptyResults = ();
5305: push(@emptyResults, 'missing user name');
5306: return split(':',@emptyResults);
5307: }
5308: } elsif(!defined($alternateDirectoryRoot)) {
5309: my $tryserver;
5310: my %alldom=();
5311: foreach $tryserver (keys %libserv) {
5312: $alldom{$hostdom{$tryserver}}=1;
5313: }
5314: my $alldomstr='';
5315: foreach (sort keys %alldom) {
5316: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
5317: }
5318: $alldomstr=~s/:$//;
5319: return split(/:/,$alldomstr);
5320: } else {
5321: my @emptyResults = ();
5322: push(@emptyResults, 'missing domain');
5323: return split(':',@emptyResults);
5324: }
5325: }
5326:
5327: # --------------------------------------------- GetFileTimestamp
5328: # This function utilizes dirlist and returns the date stamp for
5329: # when it was last modified. It will also return an error of -1
5330: # if an error occurs
5331:
5332: ##
5333: ## FIXME: This subroutine assumes its caller knows something about the
5334: ## directory structure of the home server for the student ($root).
5335: ## Not a good assumption to make. Since this is for looking up files
5336: ## in user directories, the full path should be constructed by lond, not
5337: ## whatever machine we request data from.
5338: ##
5339: sub GetFileTimestamp {
5340: my ($studentDomain,$studentName,$filename,$root)=@_;
5341: $studentDomain=~s/\W//g;
5342: $studentName=~s/\W//g;
5343: my $subdir=$studentName.'__';
5344: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5345: my $proname="$studentDomain/$subdir/$studentName";
5346: $proname .= '/'.$filename;
5347: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5348: $studentName, $root);
5349: my @stats = split('&', $fileStat);
5350: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5351: # @stats contains first the filename, then the stat output
5352: return $stats[10]; # so this is 10 instead of 9.
5353: } else {
5354: return -1;
5355: }
5356: }
5357:
5358: sub stat_file {
5359: my ($uri) = @_;
5360: $uri = &clutter_with_no_wrapper($uri);
5361:
5362: my ($udom,$uname,$file,$dir);
5363: if ($uri =~ m-^/(uploaded|editupload)/-) {
5364: ($udom,$uname,$file) =
5365: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
5366: $file = 'userfiles/'.$file;
5367: $dir = &propath($udom,$uname);
5368: }
5369: if ($uri =~ m-^/res/-) {
5370: ($udom,$uname) =
5371: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
5372: $file = $uri;
5373: }
5374:
5375: if (!$udom || !$uname || !$file) {
5376: # unable to handle the uri
5377: return ();
5378: }
5379:
5380: my ($result) = &dirlist($file,$udom,$uname,$dir);
5381: my @stats = split('&', $result);
5382:
5383: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5384: shift(@stats); #filename is first
5385: return @stats;
5386: }
5387: return ();
5388: }
5389:
5390: # -------------------------------------------------------- Value of a Condition
5391:
5392: # gets the value of a specific preevaluated condition
5393: # stored in the string $env{user.state.<cid>}
5394: # or looks up a condition reference in the bighash and if if hasn't
5395: # already been evaluated recurses into docondval to get the value of
5396: # the condition, then memoizing it to
5397: # $env{user.state.<cid>.<condition>}
5398: sub directcondval {
5399: my $number=shift;
5400: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5401: &Apache::lonuserstate::evalstate();
5402: }
5403: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5404: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5405: } elsif ($number =~ /^_/) {
5406: my $sub_condition;
5407: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5408: &GDBM_READER(),0640)) {
5409: $sub_condition=$bighash{'conditions'.$number};
5410: untie(%bighash);
5411: }
5412: my $value = &docondval($sub_condition);
5413: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5414: return $value;
5415: }
5416: if ($env{'user.state.'.$env{'request.course.id'}}) {
5417: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5418: } else {
5419: return 2;
5420: }
5421: }
5422:
5423: # get the collection of conditions for this resource
5424: sub condval {
5425: my $condidx=shift;
5426: my $allpathcond='';
5427: foreach my $cond (split(/\|/,$condidx)) {
5428: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5429: $allpathcond.=
5430: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5431: }
5432: }
5433: $allpathcond=~s/\|$//;
5434: return &docondval($allpathcond);
5435: }
5436:
5437: #evaluates an expression of conditions
5438: sub docondval {
5439: my ($allpathcond) = @_;
5440: my $result=0;
5441: if ($env{'request.course.id'}
5442: && defined($allpathcond)) {
5443: my $operand='|';
5444: my @stack;
5445: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5446: if ($chunk eq '(') {
5447: push @stack,($operand,$result);
5448: } elsif ($chunk eq ')') {
5449: my $before=pop @stack;
5450: if (pop @stack eq '&') {
5451: $result=$result>$before?$before:$result;
5452: } else {
5453: $result=$result>$before?$result:$before;
5454: }
5455: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5456: $operand=$chunk;
5457: } else {
5458: my $new=directcondval($chunk);
5459: if ($operand eq '&') {
5460: $result=$result>$new?$new:$result;
5461: } else {
5462: $result=$result>$new?$result:$new;
5463: }
5464: }
5465: }
5466: }
5467: return $result;
5468: }
5469:
5470: # ---------------------------------------------------- Devalidate courseresdata
5471:
5472: sub devalidatecourseresdata {
5473: my ($coursenum,$coursedomain)=@_;
5474: my $hashid=$coursenum.':'.$coursedomain;
5475: &devalidate_cache_new('courseres',$hashid);
5476: }
5477:
5478:
5479: # --------------------------------------------------- Course Resourcedata Query
5480:
5481: sub get_courseresdata {
5482: my ($coursenum,$coursedomain)=@_;
5483: my $coursehom=&homeserver($coursenum,$coursedomain);
5484: my $hashid=$coursenum.':'.$coursedomain;
5485: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5486: my %dumpreply;
5487: unless (defined($cached)) {
5488: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5489: $result=\%dumpreply;
5490: my ($tmp) = keys(%dumpreply);
5491: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5492: &do_cache_new('courseres',$hashid,$result,600);
5493: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5494: return $tmp;
5495: } elsif ($tmp =~ /^(error)/) {
5496: $result=undef;
5497: &do_cache_new('courseres',$hashid,$result,600);
5498: }
5499: }
5500: return $result;
5501: }
5502:
5503: sub devalidateuserresdata {
5504: my ($uname,$udom)=@_;
5505: my $hashid="$udom:$uname";
5506: &devalidate_cache_new('userres',$hashid);
5507: }
5508:
5509: sub get_userresdata {
5510: my ($uname,$udom)=@_;
5511: #most student don\'t have any data set, check if there is some data
5512: if (&EXT_cache_status($udom,$uname)) { return undef; }
5513:
5514: my $hashid="$udom:$uname";
5515: my ($result,$cached)=&is_cached_new('userres',$hashid);
5516: if (!defined($cached)) {
5517: my %resourcedata=&dump('resourcedata',$udom,$uname);
5518: $result=\%resourcedata;
5519: &do_cache_new('userres',$hashid,$result,600);
5520: }
5521: my ($tmp)=keys(%$result);
5522: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5523: return $result;
5524: }
5525: #error 2 occurs when the .db doesn't exist
5526: if ($tmp!~/error: 2 /) {
5527: &logthis("<font color=\"blue\">WARNING:".
5528: " Trying to get resource data for ".
5529: $uname." at ".$udom.": ".
5530: $tmp."</font>");
5531: } elsif ($tmp=~/error: 2 /) {
5532: #&EXT_cache_set($udom,$uname);
5533: &do_cache_new('userres',$hashid,undef,600);
5534: undef($tmp); # not really an error so don't send it back
5535: }
5536: return $tmp;
5537: }
5538:
5539: sub resdata {
5540: my ($name,$domain,$type,@which)=@_;
5541: my $result;
5542: if ($type eq 'course') {
5543: $result=&get_courseresdata($name,$domain);
5544: } elsif ($type eq 'user') {
5545: $result=&get_userresdata($name,$domain);
5546: }
5547: if (!ref($result)) { return $result; }
5548: foreach my $item (@which) {
5549: if (defined($result->{$item})) {
5550: return $result->{$item};
5551: }
5552: }
5553: return undef;
5554: }
5555:
5556: #
5557: # EXT resource caching routines
5558: #
5559:
5560: sub clear_EXT_cache_status {
5561: &delenv('cache.EXT.');
5562: }
5563:
5564: sub EXT_cache_status {
5565: my ($target_domain,$target_user) = @_;
5566: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5567: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
5568: # We know already the user has no data
5569: return 1;
5570: } else {
5571: return 0;
5572: }
5573: }
5574:
5575: sub EXT_cache_set {
5576: my ($target_domain,$target_user) = @_;
5577: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5578: #&appenv($cachename => time);
5579: }
5580:
5581: # --------------------------------------------------------- Value of a Variable
5582: sub EXT {
5583:
5584: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
5585: unless ($varname) { return ''; }
5586: #get real user name/domain, courseid and symb
5587: my $courseid;
5588: my $publicuser;
5589: if ($symbparm) {
5590: $symbparm=&get_symb_from_alias($symbparm);
5591: }
5592: if (!($uname && $udom)) {
5593: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
5594: if (!$symbparm) { $symbparm=$cursymb; }
5595: } else {
5596: $courseid=$env{'request.course.id'};
5597: }
5598: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5599: my $rest;
5600: if (defined($therest[0])) {
5601: $rest=join('.',@therest);
5602: } else {
5603: $rest='';
5604: }
5605:
5606: my $qualifierrest=$qualifier;
5607: if ($rest) { $qualifierrest.='.'.$rest; }
5608: my $spacequalifierrest=$space;
5609: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
5610: if ($realm eq 'user') {
5611: # --------------------------------------------------------------- user.resource
5612: if ($space eq 'resource') {
5613: if ( (defined($Apache::lonhomework::parsing_a_problem)
5614: || defined($Apache::lonhomework::parsing_a_task))
5615: &&
5616: ($symbparm eq &symbread()) ) {
5617: # if we are in the middle of processing the resource the
5618: # get the value we are planning on committing
5619: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5620: return $Apache::lonhomework::results{$qualifierrest};
5621: } else {
5622: return $Apache::lonhomework::history{$qualifierrest};
5623: }
5624: } else {
5625: my %restored;
5626: if ($publicuser || $env{'request.state'} eq 'construct') {
5627: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5628: } else {
5629: %restored=&restore($symbparm,$courseid,$udom,$uname);
5630: }
5631: return $restored{$qualifierrest};
5632: }
5633: # ----------------------------------------------------------------- user.access
5634: } elsif ($space eq 'access') {
5635: # FIXME - not supporting calls for a specific user
5636: return &allowed($qualifier,$rest);
5637: # ------------------------------------------ user.preferences, user.environment
5638: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
5639: if (($uname eq $env{'user.name'}) &&
5640: ($udom eq $env{'user.domain'})) {
5641: return $env{join('.',('environment',$qualifierrest))};
5642: } else {
5643: my %returnhash;
5644: if (!$publicuser) {
5645: %returnhash=&userenvironment($udom,$uname,
5646: $qualifierrest);
5647: }
5648: return $returnhash{$qualifierrest};
5649: }
5650: # ----------------------------------------------------------------- user.course
5651: } elsif ($space eq 'course') {
5652: # FIXME - not supporting calls for a specific user
5653: return $env{join('.',('request.course',$qualifier))};
5654: # ------------------------------------------------------------------- user.role
5655: } elsif ($space eq 'role') {
5656: # FIXME - not supporting calls for a specific user
5657: my ($role,$where)=split(/\./,$env{'request.role'});
5658: if ($qualifier eq 'value') {
5659: return $role;
5660: } elsif ($qualifier eq 'extent') {
5661: return $where;
5662: }
5663: # ----------------------------------------------------------------- user.domain
5664: } elsif ($space eq 'domain') {
5665: return $udom;
5666: # ------------------------------------------------------------------- user.name
5667: } elsif ($space eq 'name') {
5668: return $uname;
5669: # ---------------------------------------------------- Any other user namespace
5670: } else {
5671: my %reply;
5672: if (!$publicuser) {
5673: %reply=&get($space,[$qualifierrest],$udom,$uname);
5674: }
5675: return $reply{$qualifierrest};
5676: }
5677: } elsif ($realm eq 'query') {
5678: # ---------------------------------------------- pull stuff out of query string
5679: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5680: [$spacequalifierrest]);
5681: return $env{'form.'.$spacequalifierrest};
5682: } elsif ($realm eq 'request') {
5683: # ------------------------------------------------------------- request.browser
5684: if ($space eq 'browser') {
5685: if ($qualifier eq 'textremote') {
5686: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5687: return 1;
5688: } else {
5689: return 0;
5690: }
5691: } else {
5692: return $env{'browser.'.$qualifier};
5693: }
5694: # ------------------------------------------------------------ request.filename
5695: } else {
5696: return $env{'request.'.$spacequalifierrest};
5697: }
5698: } elsif ($realm eq 'course') {
5699: # ---------------------------------------------------------- course.description
5700: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5701: } elsif ($realm eq 'resource') {
5702:
5703: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5704: if (!$symbparm) { $symbparm=&symbread(); }
5705: }
5706:
5707: if ($space eq 'title') {
5708: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5709: return &gettitle($symbparm);
5710: }
5711:
5712: if ($space eq 'map') {
5713: my ($map) = &decode_symb($symbparm);
5714: return &symbread($map);
5715: }
5716:
5717: my ($section, $group, @groups);
5718: my ($courselevelm,$courselevel);
5719: if ($symbparm && defined($courseid) &&
5720: $courseid eq $env{'request.course.id'}) {
5721:
5722: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5723:
5724: # ----------------------------------------------------- Cascading lookup scheme
5725: my $symbp=$symbparm;
5726: my $mapp=&deversion((&decode_symb($symbp))[0]);
5727:
5728: my $symbparm=$symbp.'.'.$spacequalifierrest;
5729: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5730:
5731: if (($env{'user.name'} eq $uname) &&
5732: ($env{'user.domain'} eq $udom)) {
5733: $section=$env{'request.course.sec'};
5734: @groups = split(/:/,$env{'request.course.groups'});
5735: @groups=&sort_course_groups($courseid,@groups);
5736: } else {
5737: if (! defined($usection)) {
5738: $section=&getsection($udom,$uname,$courseid);
5739: } else {
5740: $section = $usection;
5741: }
5742: @groups = &get_users_groups($udom,$uname,$courseid);
5743: }
5744:
5745: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5746: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5747: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5748:
5749: $courselevel=$courseid.'.'.$spacequalifierrest;
5750: my $courselevelr=$courseid.'.'.$symbparm;
5751: $courselevelm=$courseid.'.'.$mapparm;
5752:
5753: # ----------------------------------------------------------- first, check user
5754:
5755: my $userreply=&resdata($uname,$udom,'user',
5756: ($courselevelr,$courselevelm,
5757: $courselevel));
5758: if (defined($userreply)) { return $userreply; }
5759:
5760: # ------------------------------------------------ second, check some of course
5761: my $coursereply;
5762: if (@groups > 0) {
5763: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5764: $mapparm,$spacequalifierrest);
5765: if (defined($coursereply)) { return $coursereply; }
5766: }
5767:
5768: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5769: $env{'course.'.$courseid.'.domain'},
5770: 'course',
5771: ($seclevelr,$seclevelm,$seclevel,
5772: $courselevelr));
5773: if (defined($coursereply)) { return $coursereply; }
5774:
5775: # ------------------------------------------------------ third, check map parms
5776: my %parmhash=();
5777: my $thisparm='';
5778: if (tie(%parmhash,'GDBM_File',
5779: $env{'request.course.fn'}.'_parms.db',
5780: &GDBM_READER(),0640)) {
5781: $thisparm=$parmhash{$symbparm};
5782: untie(%parmhash);
5783: }
5784: if ($thisparm) { return $thisparm; }
5785: }
5786: # ------------------------------------------ fourth, look in resource metadata
5787:
5788: $spacequalifierrest=~s/\./\_/;
5789: my $filename;
5790: if (!$symbparm) { $symbparm=&symbread(); }
5791: if ($symbparm) {
5792: $filename=(&decode_symb($symbparm))[2];
5793: } else {
5794: $filename=$env{'request.filename'};
5795: }
5796: my $metadata=&metadata($filename,$spacequalifierrest);
5797: if (defined($metadata)) { return $metadata; }
5798: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
5799: if (defined($metadata)) { return $metadata; }
5800:
5801: # ---------------------------------------------- fourth, look in rest pf course
5802: if ($symbparm && defined($courseid) &&
5803: $courseid eq $env{'request.course.id'}) {
5804: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5805: $env{'course.'.$courseid.'.domain'},
5806: 'course',
5807: ($courselevelm,$courselevel));
5808: if (defined($coursereply)) { return $coursereply; }
5809: }
5810: # ------------------------------------------------------------------ Cascade up
5811: unless ($space eq '0') {
5812: my @parts=split(/_/,$space);
5813: my $id=pop(@parts);
5814: my $part=join('_',@parts);
5815: if ($part eq '') { $part='0'; }
5816: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
5817: $symbparm,$udom,$uname,$section,1);
5818: if (defined($partgeneral)) { return $partgeneral; }
5819: }
5820: if ($recurse) { return undef; }
5821: my $pack_def=&packages_tab_default($filename,$varname);
5822: if (defined($pack_def)) { return $pack_def; }
5823:
5824: # ---------------------------------------------------- Any other user namespace
5825: } elsif ($realm eq 'environment') {
5826: # ----------------------------------------------------------------- environment
5827: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5828: return $env{'environment.'.$spacequalifierrest};
5829: } else {
5830: if ($uname eq 'anonymous' && $udom eq '') {
5831: return '';
5832: }
5833: my %returnhash=&userenvironment($udom,$uname,
5834: $spacequalifierrest);
5835: return $returnhash{$spacequalifierrest};
5836: }
5837: } elsif ($realm eq 'system') {
5838: # ----------------------------------------------------------------- system.time
5839: if ($space eq 'time') {
5840: return time;
5841: }
5842: } elsif ($realm eq 'server') {
5843: # ----------------------------------------------------------------- system.time
5844: if ($space eq 'name') {
5845: return $ENV{'SERVER_NAME'};
5846: }
5847: }
5848: return '';
5849: }
5850:
5851: sub check_group_parms {
5852: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5853: my @groupitems = ();
5854: my $resultitem;
5855: my @levels = ($symbparm,$mapparm,$what);
5856: foreach my $group (@{$groups}) {
5857: foreach my $level (@levels) {
5858: my $item = $courseid.'.['.$group.'].'.$level;
5859: push(@groupitems,$item);
5860: }
5861: }
5862: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5863: $env{'course.'.$courseid.'.domain'},
5864: 'course',@groupitems);
5865: return $coursereply;
5866: }
5867:
5868: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
5869: my ($courseid,@groups) = @_;
5870: @groups = sort(@groups);
5871: return @groups;
5872: }
5873:
5874: sub packages_tab_default {
5875: my ($uri,$varname)=@_;
5876: my (undef,$part,$name)=split(/\./,$varname);
5877:
5878: my (@extension,@specifics,$do_default);
5879: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
5880: my ($pack_type,$pack_part)=split(/_/,$package,2);
5881: if ($pack_type eq 'default') {
5882: $do_default=1;
5883: } elsif ($pack_type eq 'extension') {
5884: push(@extension,[$package,$pack_type,$pack_part]);
5885: } else {
5886: push(@specifics,[$package,$pack_type,$pack_part]);
5887: }
5888: }
5889: # first look for a package that matches the requested part id
5890: foreach my $package (@specifics) {
5891: my (undef,$pack_type,$pack_part)=@{$package};
5892: next if ($pack_part ne $part);
5893: if (defined($packagetab{"$pack_type&$name&default"})) {
5894: return $packagetab{"$pack_type&$name&default"};
5895: }
5896: }
5897: # look for any possible matching non extension_ package
5898: foreach my $package (@specifics) {
5899: my (undef,$pack_type,$pack_part)=@{$package};
5900: if (defined($packagetab{"$pack_type&$name&default"})) {
5901: return $packagetab{"$pack_type&$name&default"};
5902: }
5903: if ($pack_type eq 'part') { $pack_part='0'; }
5904: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5905: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
5906: }
5907: }
5908: # look for any posible extension_ match
5909: foreach my $package (@extension) {
5910: my ($package,$pack_type)=@{$package};
5911: if (defined($packagetab{"$pack_type&$name&default"})) {
5912: return $packagetab{"$pack_type&$name&default"};
5913: }
5914: if (defined($packagetab{$package."&$name&default"})) {
5915: return $packagetab{$package."&$name&default"};
5916: }
5917: }
5918: # look for a global default setting
5919: if ($do_default && defined($packagetab{"default&$name&default"})) {
5920: return $packagetab{"default&$name&default"};
5921: }
5922: return undef;
5923: }
5924:
5925: sub add_prefix_and_part {
5926: my ($prefix,$part)=@_;
5927: my $keyroot;
5928: if (defined($prefix) && $prefix !~ /^__/) {
5929: # prefix that has a part already
5930: $keyroot=$prefix;
5931: } elsif (defined($prefix)) {
5932: # prefix that is missing a part
5933: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5934: } else {
5935: # no prefix at all
5936: if (defined($part)) { $keyroot='_'.$part; }
5937: }
5938: return $keyroot;
5939: }
5940:
5941: # ---------------------------------------------------------------- Get metadata
5942:
5943: my %metaentry;
5944: sub metadata {
5945: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
5946: $uri=&declutter($uri);
5947: # if it is a non metadata possible uri return quickly
5948: if (($uri eq '') ||
5949: (($uri =~ m|^/*adm/|) &&
5950: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
5951: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
5952: ($uri =~ m|home/[^/]+/public_html/|)) {
5953: return undef;
5954: }
5955: my $filename=$uri;
5956: $uri=~s/\.meta$//;
5957: #
5958: # Is the metadata already cached?
5959: # Look at timestamp of caching
5960: # Everything is cached by the main uri, libraries are never directly cached
5961: #
5962: if (!defined($liburi)) {
5963: my ($result,$cached)=&is_cached_new('meta',$uri);
5964: if (defined($cached)) { return $result->{':'.$what}; }
5965: }
5966: {
5967: #
5968: # Is this a recursive call for a library?
5969: #
5970: # if (! exists($metacache{$uri})) {
5971: # $metacache{$uri}={};
5972: # }
5973: if ($liburi) {
5974: $liburi=&declutter($liburi);
5975: $filename=$liburi;
5976: } else {
5977: &devalidate_cache_new('meta',$uri);
5978: undef(%metaentry);
5979: }
5980: my %metathesekeys=();
5981: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
5982: my $metastring;
5983: if ($uri !~ m -^(editupload)/-) {
5984: my $file=&filelocation('',&clutter($filename));
5985: #push(@{$metaentry{$uri.'.file'}},$file);
5986: $metastring=&getfile($file);
5987: }
5988: my $parser=HTML::LCParser->new(\$metastring);
5989: my $token;
5990: undef %metathesekeys;
5991: while ($token=$parser->get_token) {
5992: if ($token->[0] eq 'S') {
5993: if (defined($token->[2]->{'package'})) {
5994: #
5995: # This is a package - get package info
5996: #
5997: my $package=$token->[2]->{'package'};
5998: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5999: if (defined($token->[2]->{'id'})) {
6000: $keyroot.='_'.$token->[2]->{'id'};
6001: }
6002: if ($metaentry{':packages'}) {
6003: $metaentry{':packages'}.=','.$package.$keyroot;
6004: } else {
6005: $metaentry{':packages'}=$package.$keyroot;
6006: }
6007: foreach my $pack_entry (keys(%packagetab)) {
6008: my $part=$keyroot;
6009: $part=~s/^\_//;
6010: if ($pack_entry=~/^\Q$package\E\&/ ||
6011: $pack_entry=~/^\Q$package\E_0\&/) {
6012: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
6013: # ignore package.tab specified default values
6014: # here &package_tab_default() will fetch those
6015: if ($subp eq 'default') { next; }
6016: my $value=$packagetab{$pack_entry};
6017: my $unikey;
6018: if ($pack =~ /_0$/) {
6019: $unikey='parameter_0_'.$name;
6020: $part=0;
6021: } else {
6022: $unikey='parameter'.$keyroot.'_'.$name;
6023: }
6024: if ($subp eq 'display') {
6025: $value.=' [Part: '.$part.']';
6026: }
6027: $metaentry{':'.$unikey.'.part'}=$part;
6028: $metathesekeys{$unikey}=1;
6029: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6030: $metaentry{':'.$unikey.'.'.$subp}=$value;
6031: }
6032: if (defined($metaentry{':'.$unikey.'.default'})) {
6033: $metaentry{':'.$unikey}=
6034: $metaentry{':'.$unikey.'.default'};
6035: }
6036: }
6037: }
6038: } else {
6039: #
6040: # This is not a package - some other kind of start tag
6041: #
6042: my $entry=$token->[1];
6043: my $unikey;
6044: if ($entry eq 'import') {
6045: $unikey='';
6046: } else {
6047: $unikey=$entry;
6048: }
6049: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
6050:
6051: if (defined($token->[2]->{'id'})) {
6052: $unikey.='_'.$token->[2]->{'id'};
6053: }
6054:
6055: if ($entry eq 'import') {
6056: #
6057: # Importing a library here
6058: #
6059: if ($depthcount<20) {
6060: my $location=$parser->get_text('/import');
6061: my $dir=$filename;
6062: $dir=~s|[^/]*$||;
6063: $location=&filelocation($dir,$location);
6064: my $metadata =
6065: &metadata($uri,'keys', $location,$unikey,
6066: $depthcount+1);
6067: foreach my $meta (split(',',$metadata)) {
6068: $metaentry{':'.$meta}=$metaentry{':'.$meta};
6069: $metathesekeys{$meta}=1;
6070: }
6071: }
6072: } else {
6073:
6074: if (defined($token->[2]->{'name'})) {
6075: $unikey.='_'.$token->[2]->{'name'};
6076: }
6077: $metathesekeys{$unikey}=1;
6078: foreach my $param (@{$token->[3]}) {
6079: $metaentry{':'.$unikey.'.'.$param} =
6080: $token->[2]->{$param};
6081: }
6082: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
6083: my $default=$metaentry{':'.$unikey.'.default'};
6084: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
6085: # only ws inside the tag, and not in default, so use default
6086: # as value
6087: $metaentry{':'.$unikey}=$default;
6088: } else {
6089: # either something interesting inside the tag or default
6090: # uninteresting
6091: $metaentry{':'.$unikey}=$internaltext;
6092: }
6093: # end of not-a-package not-a-library import
6094: }
6095: # end of not-a-package start tag
6096: }
6097: # the next is the end of "start tag"
6098: }
6099: }
6100: my ($extension) = ($uri =~ /\.(\w+)$/);
6101: foreach my $key (keys(%packagetab)) {
6102: #no specific packages #how's our extension
6103: if ($key!~/^extension_\Q$extension\E&/) { next; }
6104: &metadata_create_package_def($uri,$key,'extension_'.$extension,
6105: \%metathesekeys);
6106: }
6107: if (!exists($metaentry{':packages'})) {
6108: foreach my $key (keys(%packagetab)) {
6109: #no specific packages well let's get default then
6110: if ($key!~/^default&/) { next; }
6111: &metadata_create_package_def($uri,$key,'default',
6112: \%metathesekeys);
6113: }
6114: }
6115: # are there custom rights to evaluate
6116: if ($metaentry{':copyright'} eq 'custom') {
6117:
6118: #
6119: # Importing a rights file here
6120: #
6121: unless ($depthcount) {
6122: my $location=$metaentry{':customdistributionfile'};
6123: my $dir=$filename;
6124: $dir=~s|[^/]*$||;
6125: $location=&filelocation($dir,$location);
6126: my $rights_metadata =
6127: &metadata($uri,'keys',$location,'_rights',
6128: $depthcount+1);
6129: foreach my $rights (split(',',$rights_metadata)) {
6130: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
6131: $metathesekeys{$rights}=1;
6132: }
6133: }
6134: }
6135: # uniqifiy package listing
6136: my %seen;
6137: my @uniq_packages =
6138: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
6139: $metaentry{':packages'} = join(',',@uniq_packages);
6140:
6141: $metaentry{':keys'} = join(',',keys(%metathesekeys));
6142: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
6143: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
6144: &do_cache_new('meta',$uri,\%metaentry,60*60);
6145: # this is the end of "was not already recently cached
6146: }
6147: return $metaentry{':'.$what};
6148: }
6149:
6150: sub metadata_create_package_def {
6151: my ($uri,$key,$package,$metathesekeys)=@_;
6152: my ($pack,$name,$subp)=split(/\&/,$key);
6153: if ($subp eq 'default') { next; }
6154:
6155: if (defined($metaentry{':packages'})) {
6156: $metaentry{':packages'}.=','.$package;
6157: } else {
6158: $metaentry{':packages'}=$package;
6159: }
6160: my $value=$packagetab{$key};
6161: my $unikey;
6162: $unikey='parameter_0_'.$name;
6163: $metaentry{':'.$unikey.'.part'}=0;
6164: $$metathesekeys{$unikey}=1;
6165: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
6166: $metaentry{':'.$unikey.'.'.$subp}=$value;
6167: }
6168: if (defined($metaentry{':'.$unikey.'.default'})) {
6169: $metaentry{':'.$unikey}=
6170: $metaentry{':'.$unikey.'.default'};
6171: }
6172: }
6173:
6174: sub metadata_generate_part0 {
6175: my ($metadata,$metacache,$uri) = @_;
6176: my %allnames;
6177: foreach my $metakey (keys(%$metadata)) {
6178: if ($metakey=~/^parameter\_(.*)/) {
6179: my $part=$$metacache{':'.$metakey.'.part'};
6180: my $name=$$metacache{':'.$metakey.'.name'};
6181: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
6182: $allnames{$name}=$part;
6183: }
6184: }
6185: }
6186: foreach my $name (keys(%allnames)) {
6187: $$metadata{"parameter_0_$name"}=1;
6188: my $key=":parameter_0_$name";
6189: $$metacache{"$key.part"}='0';
6190: $$metacache{"$key.name"}=$name;
6191: $$metacache{"$key.type"}=$$metacache{':parameter_'.
6192: $allnames{$name}.'_'.$name.
6193: '.type'};
6194: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
6195: '.display'};
6196: my $expr='[Part: '.$allnames{$name}.']';
6197: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
6198: $$metacache{"$key.display"}=$olddis;
6199: }
6200: }
6201:
6202: # ------------------------------------------------------ Devalidate title cache
6203:
6204: sub devalidate_title_cache {
6205: my ($url)=@_;
6206: if (!$env{'request.course.id'}) { return; }
6207: my $symb=&symbread($url);
6208: if (!$symb) { return; }
6209: my $key=$env{'request.course.id'}."\0".$symb;
6210: &devalidate_cache_new('title',$key);
6211: }
6212:
6213: # ------------------------------------------------- Get the title of a resource
6214:
6215: sub gettitle {
6216: my $urlsymb=shift;
6217: my $symb=&symbread($urlsymb);
6218: if ($symb) {
6219: my $key=$env{'request.course.id'}."\0".$symb;
6220: my ($result,$cached)=&is_cached_new('title',$key);
6221: if (defined($cached)) {
6222: return $result;
6223: }
6224: my ($map,$resid,$url)=&decode_symb($symb);
6225: my $title='';
6226: my %bighash;
6227: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6228: &GDBM_READER(),0640)) {
6229: my $mapid=$bighash{'map_pc_'.&clutter($map)};
6230: $title=$bighash{'title_'.$mapid.'.'.$resid};
6231: untie %bighash;
6232: }
6233: $title=~s/\&colon\;/\:/gs;
6234: if ($title) {
6235: return &do_cache_new('title',$key,$title,600);
6236: }
6237: $urlsymb=$url;
6238: }
6239: my $title=&metadata($urlsymb,'title');
6240: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
6241: return $title;
6242: }
6243:
6244: sub get_slot {
6245: my ($which,$cnum,$cdom)=@_;
6246: if (!$cnum || !$cdom) {
6247: (undef,my $courseid)=&whichuser();
6248: $cdom=$env{'course.'.$courseid.'.domain'};
6249: $cnum=$env{'course.'.$courseid.'.num'};
6250: }
6251: my $key=join("\0",'slots',$cdom,$cnum,$which);
6252: my %slotinfo;
6253: if (exists($remembered{$key})) {
6254: $slotinfo{$which} = $remembered{$key};
6255: } else {
6256: %slotinfo=&get('slots',[$which],$cdom,$cnum);
6257: &Apache::lonhomework::showhash(%slotinfo);
6258: my ($tmp)=keys(%slotinfo);
6259: if ($tmp=~/^error:/) { return (); }
6260: $remembered{$key} = $slotinfo{$which};
6261: }
6262: if (ref($slotinfo{$which}) eq 'HASH') {
6263: return %{$slotinfo{$which}};
6264: }
6265: return $slotinfo{$which};
6266: }
6267: # ------------------------------------------------- Update symbolic store links
6268:
6269: sub symblist {
6270: my ($mapname,%newhash)=@_;
6271: $mapname=&deversion(&declutter($mapname));
6272: my %hash;
6273: if (($env{'request.course.fn'}) && (%newhash)) {
6274: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6275: &GDBM_WRCREAT(),0640)) {
6276: foreach my $url (keys %newhash) {
6277: next if ($url eq 'last_known'
6278: && $env{'form.no_update_last_known'});
6279: $hash{declutter($url)}=&encode_symb($mapname,
6280: $newhash{$url}->[1],
6281: $newhash{$url}->[0]);
6282: }
6283: if (untie(%hash)) {
6284: return 'ok';
6285: }
6286: }
6287: }
6288: return 'error';
6289: }
6290:
6291: # --------------------------------------------------------------- Verify a symb
6292:
6293: sub symbverify {
6294: my ($symb,$thisurl)=@_;
6295: my $thisfn=$thisurl;
6296: $thisfn=&declutter($thisfn);
6297: # direct jump to resource in page or to a sequence - will construct own symbs
6298: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
6299: # check URL part
6300: my ($map,$resid,$url)=&decode_symb($symb);
6301:
6302: unless ($url eq $thisfn) { return 0; }
6303:
6304: $symb=&symbclean($symb);
6305: $thisurl=&deversion($thisurl);
6306: $thisfn=&deversion($thisfn);
6307:
6308: my %bighash;
6309: my $okay=0;
6310:
6311: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6312: &GDBM_READER(),0640)) {
6313: my $ids=$bighash{'ids_'.&clutter($thisurl)};
6314: unless ($ids) {
6315: $ids=$bighash{'ids_/'.$thisurl};
6316: }
6317: if ($ids) {
6318: # ------------------------------------------------------------------- Has ID(s)
6319: foreach (split(/\,/,$ids)) {
6320: my ($mapid,$resid)=split(/\./,$_);
6321: if (
6322: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
6323: eq $symb) {
6324: if (($env{'request.role.adv'}) ||
6325: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
6326: $okay=1;
6327: }
6328: }
6329: }
6330: }
6331: untie(%bighash);
6332: }
6333: return $okay;
6334: }
6335:
6336: # --------------------------------------------------------------- Clean-up symb
6337:
6338: sub symbclean {
6339: my $symb=shift;
6340: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6341: # remove version from map
6342: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6343:
6344: # remove version from URL
6345: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6346:
6347: # remove wrapper
6348:
6349: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6350: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6351: return $symb;
6352: }
6353:
6354: # ---------------------------------------------- Split symb to find map and url
6355:
6356: sub encode_symb {
6357: my ($map,$resid,$url)=@_;
6358: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6359: }
6360:
6361: sub decode_symb {
6362: my $symb=shift;
6363: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6364: my ($map,$resid,$url)=split(/___/,$symb);
6365: return (&fixversion($map),$resid,&fixversion($url));
6366: }
6367:
6368: sub fixversion {
6369: my $fn=shift;
6370: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6371: my %bighash;
6372: my $uri=&clutter($fn);
6373: my $key=$env{'request.course.id'}.'_'.$uri;
6374: # is this cached?
6375: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6376: if (defined($cached)) { return $result; }
6377: # unfortunately not cached, or expired
6378: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6379: &GDBM_READER(),0640)) {
6380: if ($bighash{'version_'.$uri}) {
6381: my $version=$bighash{'version_'.$uri};
6382: unless (($version eq 'mostrecent') ||
6383: ($version==&getversion($uri))) {
6384: $uri=~s/\.(\w+)$/\.$version\.$1/;
6385: }
6386: }
6387: untie %bighash;
6388: }
6389: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6390: }
6391:
6392: sub deversion {
6393: my $url=shift;
6394: $url=~s/\.\d+\.(\w+)$/\.$1/;
6395: return $url;
6396: }
6397:
6398: # ------------------------------------------------------ Return symb list entry
6399:
6400: sub symbread {
6401: my ($thisfn,$donotrecurse)=@_;
6402: my $cache_str='request.symbread.cached.'.$thisfn;
6403: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6404: # no filename provided? try from environment
6405: unless ($thisfn) {
6406: if ($env{'request.symb'}) {
6407: return $env{$cache_str}=&symbclean($env{'request.symb'});
6408: }
6409: $thisfn=$env{'request.filename'};
6410: }
6411: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6412: # is that filename actually a symb? Verify, clean, and return
6413: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6414: if (&symbverify($thisfn,$1)) {
6415: return $env{$cache_str}=&symbclean($thisfn);
6416: }
6417: }
6418: $thisfn=declutter($thisfn);
6419: my %hash;
6420: my %bighash;
6421: my $syval='';
6422: if (($env{'request.course.fn'}) && ($thisfn)) {
6423: my $targetfn = $thisfn;
6424: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6425: $targetfn = 'adm/wrapper/'.$thisfn;
6426: }
6427: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6428: $targetfn=$1;
6429: }
6430: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6431: &GDBM_READER(),0640)) {
6432: $syval=$hash{$targetfn};
6433: untie(%hash);
6434: }
6435: # ---------------------------------------------------------- There was an entry
6436: if ($syval) {
6437: #unless ($syval=~/\_\d+$/) {
6438: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6439: #&appenv('request.ambiguous' => $thisfn);
6440: #return $env{$cache_str}='';
6441: #}
6442: #$syval.=$1;
6443: #}
6444: } else {
6445: # ------------------------------------------------------- Was not in symb table
6446: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6447: &GDBM_READER(),0640)) {
6448: # ---------------------------------------------- Get ID(s) for current resource
6449: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6450: unless ($ids) {
6451: $ids=$bighash{'ids_/'.$thisfn};
6452: }
6453: unless ($ids) {
6454: # alias?
6455: $ids=$bighash{'mapalias_'.$thisfn};
6456: }
6457: if ($ids) {
6458: # ------------------------------------------------------------------- Has ID(s)
6459: my @possibilities=split(/\,/,$ids);
6460: if ($#possibilities==0) {
6461: # ----------------------------------------------- There is only one possibility
6462: my ($mapid,$resid)=split(/\./,$ids);
6463: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6464: $resid,$thisfn);
6465: } elsif (!$donotrecurse) {
6466: # ------------------------------------------ There is more than one possibility
6467: my $realpossible=0;
6468: foreach (@possibilities) {
6469: my $file=$bighash{'src_'.$_};
6470: if (&allowed('bre',$file)) {
6471: my ($mapid,$resid)=split(/\./,$_);
6472: if ($bighash{'map_type_'.$mapid} ne 'page') {
6473: $realpossible++;
6474: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6475: $resid,$thisfn);
6476: }
6477: }
6478: }
6479: if ($realpossible!=1) { $syval=''; }
6480: } else {
6481: $syval='';
6482: }
6483: }
6484: untie(%bighash)
6485: }
6486: }
6487: if ($syval) {
6488: return $env{$cache_str}=$syval;
6489: }
6490: }
6491: &appenv('request.ambiguous' => $thisfn);
6492: return $env{$cache_str}='';
6493: }
6494:
6495: # ---------------------------------------------------------- Return random seed
6496:
6497: sub numval {
6498: my $txt=shift;
6499: $txt=~tr/A-J/0-9/;
6500: $txt=~tr/a-j/0-9/;
6501: $txt=~tr/K-T/0-9/;
6502: $txt=~tr/k-t/0-9/;
6503: $txt=~tr/U-Z/0-5/;
6504: $txt=~tr/u-z/0-5/;
6505: $txt=~s/\D//g;
6506: if ($_64bit) { if ($txt > 2**32) { return -1; } }
6507: return int($txt);
6508: }
6509:
6510: sub numval2 {
6511: my $txt=shift;
6512: $txt=~tr/A-J/0-9/;
6513: $txt=~tr/a-j/0-9/;
6514: $txt=~tr/K-T/0-9/;
6515: $txt=~tr/k-t/0-9/;
6516: $txt=~tr/U-Z/0-5/;
6517: $txt=~tr/u-z/0-5/;
6518: $txt=~s/\D//g;
6519: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6520: my $total;
6521: foreach my $val (@txts) { $total+=$val; }
6522: if ($_64bit) { if ($total > 2**32) { return -1; } }
6523: return int($total);
6524: }
6525:
6526: sub numval3 {
6527: use integer;
6528: my $txt=shift;
6529: $txt=~tr/A-J/0-9/;
6530: $txt=~tr/a-j/0-9/;
6531: $txt=~tr/K-T/0-9/;
6532: $txt=~tr/k-t/0-9/;
6533: $txt=~tr/U-Z/0-5/;
6534: $txt=~tr/u-z/0-5/;
6535: $txt=~s/\D//g;
6536: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6537: my $total;
6538: foreach my $val (@txts) { $total+=$val; }
6539: if ($_64bit) { $total=(($total<<32)>>32); }
6540: return $total;
6541: }
6542:
6543: sub digest {
6544: my ($data)=@_;
6545: my $digest=&Digest::MD5::md5($data);
6546: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6547: my ($e,$f);
6548: {
6549: use integer;
6550: $e=($a+$b);
6551: $f=($c+$d);
6552: if ($_64bit) {
6553: $e=(($e<<32)>>32);
6554: $f=(($f<<32)>>32);
6555: }
6556: }
6557: if (wantarray) {
6558: return ($e,$f);
6559: } else {
6560: my $g;
6561: {
6562: use integer;
6563: $g=($e+$f);
6564: if ($_64bit) {
6565: $g=(($g<<32)>>32);
6566: }
6567: }
6568: return $g;
6569: }
6570: }
6571:
6572: sub latest_rnd_algorithm_id {
6573: return '64bit5';
6574: }
6575:
6576: sub get_rand_alg {
6577: my ($courseid)=@_;
6578: if (!$courseid) { $courseid=(&whichuser())[1]; }
6579: if ($courseid) {
6580: return $env{"course.$courseid.rndseed"};
6581: }
6582: return &latest_rnd_algorithm_id();
6583: }
6584:
6585: sub validCODE {
6586: my ($CODE)=@_;
6587: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6588: return 0;
6589: }
6590:
6591: sub getCODE {
6592: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
6593: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6594: defined($Apache::lonhomework::parsing_a_task) ) &&
6595: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
6596: return $Apache::lonhomework::history{'resource.CODE'};
6597: }
6598: return undef;
6599: }
6600:
6601: sub rndseed {
6602: my ($symb,$courseid,$domain,$username)=@_;
6603:
6604: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
6605: if (!$symb) {
6606: unless ($symb=$wsymb) { return time; }
6607: }
6608: if (!$courseid) { $courseid=$wcourseid; }
6609: if (!$domain) { $domain=$wdomain; }
6610: if (!$username) { $username=$wusername }
6611: my $which=&get_rand_alg();
6612: if (defined(&getCODE())) {
6613: if ($which eq '64bit5') {
6614: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6615: } elsif ($which eq '64bit4') {
6616: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6617: } else {
6618: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6619: }
6620: } elsif ($which eq '64bit5') {
6621: return &rndseed_64bit5($symb,$courseid,$domain,$username);
6622: } elsif ($which eq '64bit4') {
6623: return &rndseed_64bit4($symb,$courseid,$domain,$username);
6624: } elsif ($which eq '64bit3') {
6625: return &rndseed_64bit3($symb,$courseid,$domain,$username);
6626: } elsif ($which eq '64bit2') {
6627: return &rndseed_64bit2($symb,$courseid,$domain,$username);
6628: } elsif ($which eq '64bit') {
6629: return &rndseed_64bit($symb,$courseid,$domain,$username);
6630: }
6631: return &rndseed_32bit($symb,$courseid,$domain,$username);
6632: }
6633:
6634: sub rndseed_32bit {
6635: my ($symb,$courseid,$domain,$username)=@_;
6636: {
6637: use integer;
6638: my $symbchck=unpack("%32C*",$symb) << 27;
6639: my $symbseed=numval($symb) << 22;
6640: my $namechck=unpack("%32C*",$username) << 17;
6641: my $nameseed=numval($username) << 12;
6642: my $domainseed=unpack("%32C*",$domain) << 7;
6643: my $courseseed=unpack("%32C*",$courseid);
6644: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6645: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6646: #&logthis("rndseed :$num:$symb");
6647: if ($_64bit) { $num=(($num<<32)>>32); }
6648: return $num;
6649: }
6650: }
6651:
6652: sub rndseed_64bit {
6653: my ($symb,$courseid,$domain,$username)=@_;
6654: {
6655: use integer;
6656: my $symbchck=unpack("%32S*",$symb) << 21;
6657: my $symbseed=numval($symb) << 10;
6658: my $namechck=unpack("%32S*",$username);
6659:
6660: my $nameseed=numval($username) << 21;
6661: my $domainseed=unpack("%32S*",$domain) << 10;
6662: my $courseseed=unpack("%32S*",$courseid);
6663:
6664: my $num1=$symbchck+$symbseed+$namechck;
6665: my $num2=$nameseed+$domainseed+$courseseed;
6666: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6667: #&logthis("rndseed :$num:$symb");
6668: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6669: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6670: return "$num1,$num2";
6671: }
6672: }
6673:
6674: sub rndseed_64bit2 {
6675: my ($symb,$courseid,$domain,$username)=@_;
6676: {
6677: use integer;
6678: # strings need to be an even # of cahracters long, it it is odd the
6679: # last characters gets thrown away
6680: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6681: my $symbseed=numval($symb) << 10;
6682: my $namechck=unpack("%32S*",$username.' ');
6683:
6684: my $nameseed=numval($username) << 21;
6685: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6686: my $courseseed=unpack("%32S*",$courseid.' ');
6687:
6688: my $num1=$symbchck+$symbseed+$namechck;
6689: my $num2=$nameseed+$domainseed+$courseseed;
6690: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6691: #&logthis("rndseed :$num:$symb");
6692: return "$num1,$num2";
6693: }
6694: }
6695:
6696: sub rndseed_64bit3 {
6697: my ($symb,$courseid,$domain,$username)=@_;
6698: {
6699: use integer;
6700: # strings need to be an even # of cahracters long, it it is odd the
6701: # last characters gets thrown away
6702: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6703: my $symbseed=numval2($symb) << 10;
6704: my $namechck=unpack("%32S*",$username.' ');
6705:
6706: my $nameseed=numval2($username) << 21;
6707: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6708: my $courseseed=unpack("%32S*",$courseid.' ');
6709:
6710: my $num1=$symbchck+$symbseed+$namechck;
6711: my $num2=$nameseed+$domainseed+$courseseed;
6712: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6713: #&logthis("rndseed :$num1:$num2:$_64bit");
6714: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6715:
6716: return "$num1:$num2";
6717: }
6718: }
6719:
6720: sub rndseed_64bit4 {
6721: my ($symb,$courseid,$domain,$username)=@_;
6722: {
6723: use integer;
6724: # strings need to be an even # of cahracters long, it it is odd the
6725: # last characters gets thrown away
6726: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6727: my $symbseed=numval3($symb) << 10;
6728: my $namechck=unpack("%32S*",$username.' ');
6729:
6730: my $nameseed=numval3($username) << 21;
6731: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6732: my $courseseed=unpack("%32S*",$courseid.' ');
6733:
6734: my $num1=$symbchck+$symbseed+$namechck;
6735: my $num2=$nameseed+$domainseed+$courseseed;
6736: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6737: #&logthis("rndseed :$num1:$num2:$_64bit");
6738: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6739:
6740: return "$num1:$num2";
6741: }
6742: }
6743:
6744: sub rndseed_64bit5 {
6745: my ($symb,$courseid,$domain,$username)=@_;
6746: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6747: return "$num1:$num2";
6748: }
6749:
6750: sub rndseed_CODE_64bit {
6751: my ($symb,$courseid,$domain,$username)=@_;
6752: {
6753: use integer;
6754: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6755: my $symbseed=numval2($symb);
6756: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6757: my $CODEseed=numval(&getCODE());
6758: my $courseseed=unpack("%32S*",$courseid.' ');
6759: my $num1=$symbseed+$CODEchck;
6760: my $num2=$CODEseed+$courseseed+$symbchck;
6761: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6762: #&logthis("rndseed :$num1:$num2:$symb");
6763: if ($_64bit) { $num1=(($num1<<32)>>32); }
6764: if ($_64bit) { $num2=(($num2<<32)>>32); }
6765: return "$num1:$num2";
6766: }
6767: }
6768:
6769: sub rndseed_CODE_64bit4 {
6770: my ($symb,$courseid,$domain,$username)=@_;
6771: {
6772: use integer;
6773: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6774: my $symbseed=numval3($symb);
6775: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6776: my $CODEseed=numval3(&getCODE());
6777: my $courseseed=unpack("%32S*",$courseid.' ');
6778: my $num1=$symbseed+$CODEchck;
6779: my $num2=$CODEseed+$courseseed+$symbchck;
6780: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6781: #&logthis("rndseed :$num1:$num2:$symb");
6782: if ($_64bit) { $num1=(($num1<<32)>>32); }
6783: if ($_64bit) { $num2=(($num2<<32)>>32); }
6784: return "$num1:$num2";
6785: }
6786: }
6787:
6788: sub rndseed_CODE_64bit5 {
6789: my ($symb,$courseid,$domain,$username)=@_;
6790: my $code = &getCODE();
6791: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6792: return "$num1:$num2";
6793: }
6794:
6795: sub setup_random_from_rndseed {
6796: my ($rndseed)=@_;
6797: if ($rndseed =~/([,:])/) {
6798: my ($num1,$num2)=split(/[,:]/,$rndseed);
6799: &Math::Random::random_set_seed(abs($num1),abs($num2));
6800: } else {
6801: &Math::Random::random_set_seed_from_phrase($rndseed);
6802: }
6803: }
6804:
6805: sub latest_receipt_algorithm_id {
6806: return 'receipt2';
6807: }
6808:
6809: sub recunique {
6810: my $fucourseid=shift;
6811: my $unique;
6812: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6813: $unique=$env{"course.$fucourseid.internal.encseed"};
6814: } else {
6815: $unique=$perlvar{'lonReceipt'};
6816: }
6817: return unpack("%32C*",$unique);
6818: }
6819:
6820: sub recprefix {
6821: my $fucourseid=shift;
6822: my $prefix;
6823: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6824: $prefix=$env{"course.$fucourseid.internal.encpref"};
6825: } else {
6826: $prefix=$perlvar{'lonHostID'};
6827: }
6828: return unpack("%32C*",$prefix);
6829: }
6830:
6831: sub ireceipt {
6832: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
6833: my $cuname=unpack("%32C*",$funame);
6834: my $cudom=unpack("%32C*",$fudom);
6835: my $cucourseid=unpack("%32C*",$fucourseid);
6836: my $cusymb=unpack("%32C*",$fusymb);
6837: my $cunique=&recunique($fucourseid);
6838: my $cpart=unpack("%32S*",$part);
6839: my $return =&recprefix($fucourseid).'-';
6840: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6841: $env{'request.state'} eq 'construct') {
6842: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
6843:
6844: $return.= ($cunique%$cuname+
6845: $cunique%$cudom+
6846: $cusymb%$cuname+
6847: $cusymb%$cudom+
6848: $cucourseid%$cuname+
6849: $cucourseid%$cudom+
6850: $cpart%$cuname+
6851: $cpart%$cudom);
6852: } else {
6853: $return.= ($cunique%$cuname+
6854: $cunique%$cudom+
6855: $cusymb%$cuname+
6856: $cusymb%$cudom+
6857: $cucourseid%$cuname+
6858: $cucourseid%$cudom);
6859: }
6860: return $return;
6861: }
6862:
6863: sub receipt {
6864: my ($part)=@_;
6865: my ($symb,$courseid,$domain,$name) = &whichuser();
6866: return &ireceipt($name,$domain,$courseid,$symb,$part);
6867: }
6868:
6869: sub whichuser {
6870: my ($passedsymb)=@_;
6871: my ($symb,$courseid,$domain,$name,$publicuser);
6872: if (defined($env{'form.grade_symb'})) {
6873: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
6874: my $allowed=&allowed('vgr',$tmp_courseid);
6875: if (!$allowed &&
6876: exists($env{'request.course.sec'}) &&
6877: $env{'request.course.sec'} !~ /^\s*$/) {
6878: $allowed=&allowed('vgr',$tmp_courseid.
6879: '/'.$env{'request.course.sec'});
6880: }
6881: if ($allowed) {
6882: ($symb)=&get_env_multiple('form.grade_symb');
6883: $courseid=$tmp_courseid;
6884: ($domain)=&get_env_multiple('form.grade_domain');
6885: ($name)=&get_env_multiple('form.grade_username');
6886: return ($symb,$courseid,$domain,$name,$publicuser);
6887: }
6888: }
6889: if (!$passedsymb) {
6890: $symb=&symbread();
6891: } else {
6892: $symb=$passedsymb;
6893: }
6894: $courseid=$env{'request.course.id'};
6895: $domain=$env{'user.domain'};
6896: $name=$env{'user.name'};
6897: if ($name eq 'public' && $domain eq 'public') {
6898: if (!defined($env{'form.username'})) {
6899: $env{'form.username'}.=time.rand(10000000);
6900: }
6901: $name.=$env{'form.username'};
6902: }
6903: return ($symb,$courseid,$domain,$name,$publicuser);
6904:
6905: }
6906:
6907: # ------------------------------------------------------------ Serves up a file
6908: # returns either the contents of the file or
6909: # -1 if the file doesn't exist
6910: #
6911: # if the target is a file that was uploaded via DOCS,
6912: # a check will be made to see if a current copy exists on the local server,
6913: # if it does this will be served, otherwise a copy will be retrieved from
6914: # the home server for the course and stored in /home/httpd/html/userfiles on
6915: # the local server.
6916:
6917: sub getfile {
6918: my ($file) = @_;
6919: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6920: &repcopy($file);
6921: return &readfile($file);
6922: }
6923:
6924: sub repcopy_userfile {
6925: my ($file)=@_;
6926: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6927: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
6928: my ($cdom,$cnum,$filename) =
6929: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6930: my ($info,$rtncode);
6931: my $uri="/uploaded/$cdom/$cnum/$filename";
6932: if (-e "$file") {
6933: my @fileinfo = stat($file);
6934: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
6935: if ($lwpresp ne 'ok') {
6936: if ($rtncode eq '404') {
6937: unlink($file);
6938: }
6939: #my $ua=new LWP::UserAgent;
6940: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6941: #my $response=$ua->request($request);
6942: #if ($response->is_success()) {
6943: # return $response->content;
6944: # } else {
6945: # return -1;
6946: # }
6947: return -1;
6948: }
6949: if ($info < $fileinfo[9]) {
6950: return 'ok';
6951: }
6952: $info = '';
6953: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6954: if ($lwpresp ne 'ok') {
6955: return -1;
6956: }
6957: } else {
6958: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6959: if ($lwpresp ne 'ok') {
6960: my $ua=new LWP::UserAgent;
6961: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6962: my $response=$ua->request($request);
6963: if ($response->is_success()) {
6964: $info=$response->content;
6965: } else {
6966: return -1;
6967: }
6968: }
6969: my @parts = ($cdom,$cnum);
6970: if ($filename =~ m|^(.+)/[^/]+$|) {
6971: push @parts, split(/\//,$1);
6972: }
6973: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
6974: foreach my $part (@parts) {
6975: $path .= '/'.$part;
6976: if (!-e $path) {
6977: mkdir($path,0770);
6978: }
6979: }
6980: }
6981: open(FILE,">$file");
6982: print FILE $info;
6983: close(FILE);
6984: return 'ok';
6985: }
6986:
6987: sub tokenwrapper {
6988: my $uri=shift;
6989: $uri=~s|^http\://([^/]+)||;
6990: $uri=~s|^/||;
6991: $env{'user.environment'}=~/\/([^\/]+)\.id/;
6992: my $token=$1;
6993: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6994: if ($udom && $uname && $file) {
6995: $file=~s|(\?\.*)*$||;
6996: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
6997: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
6998: (($uri=~/\?/)?'&':'?').'token='.$token.
6999: '&tokenissued='.$perlvar{'lonHostID'};
7000: } else {
7001: return '/adm/notfound.html';
7002: }
7003: }
7004:
7005: sub getuploaded {
7006: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
7007: $uri=~s/^\///;
7008: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
7009: my $ua=new LWP::UserAgent;
7010: my $request=new HTTP::Request($reqtype,$uri);
7011: my $response=$ua->request($request);
7012: $$rtncode = $response->code;
7013: if (! $response->is_success()) {
7014: return 'failed';
7015: }
7016: if ($reqtype eq 'HEAD') {
7017: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
7018: } elsif ($reqtype eq 'GET') {
7019: $$info = $response->content;
7020: }
7021: return 'ok';
7022: }
7023:
7024: sub readfile {
7025: my $file = shift;
7026: if ( (! -e $file ) || ($file eq '') ) { return -1; };
7027: my $fh;
7028: open($fh,"<$file");
7029: my $a='';
7030: while (<$fh>) { $a .=$_; }
7031: return $a;
7032: }
7033:
7034: sub filelocation {
7035: my ($dir,$file) = @_;
7036: my $location;
7037: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
7038:
7039: if ($file =~ m-^/adm/-) {
7040: $file=~s-^/adm/wrapper/-/-;
7041: $file=~s-^/adm/coursedocs/showdoc/-/-;
7042: }
7043: if ($file=~m:^/~:) { # is a contruction space reference
7044: $location = $file;
7045: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
7046: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
7047: # is a correct contruction space reference
7048: $location = $file;
7049: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
7050: my ($udom,$uname,$filename)=
7051: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
7052: my $home=&homeserver($uname,$udom);
7053: my $is_me=0;
7054: my @ids=¤t_machine_ids();
7055: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
7056: if ($is_me) {
7057: $location=&propath($udom,$uname).
7058: '/userfiles/'.$filename;
7059: } else {
7060: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
7061: $udom.'/'.$uname.'/'.$filename;
7062: }
7063: } else {
7064: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7065: $file=~s:^/res/:/:;
7066: if ( !( $file =~ m:^/:) ) {
7067: $location = $dir. '/'.$file;
7068: } else {
7069: $location = '/home/httpd/html/res'.$file;
7070: }
7071: }
7072: $location=~s://+:/:g; # remove duplicate /
7073: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
7074: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
7075: return $location;
7076: }
7077:
7078: sub hreflocation {
7079: my ($dir,$file)=@_;
7080: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
7081: $file=filelocation($dir,$file);
7082: } elsif ($file=~m-^/adm/-) {
7083: $file=~s-^/adm/wrapper/-/-;
7084: $file=~s-^/adm/coursedocs/showdoc/-/-;
7085: }
7086: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
7087: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
7088: } elsif ($file=~m-/home/(\w+)/public_html/-) {
7089: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
7090: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
7091: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
7092: -/uploaded/$1/$2/-x;
7093: }
7094: return $file;
7095: }
7096:
7097: sub current_machine_domains {
7098: my $hostname=$hostname{$perlvar{'lonHostID'}};
7099: my @domains;
7100: while( my($id, $name) = each(%hostname)) {
7101: # &logthis("-$id-$name-$hostname-");
7102: if ($hostname eq $name) {
7103: push(@domains,$hostdom{$id});
7104: }
7105: }
7106: return @domains;
7107: }
7108:
7109: sub current_machine_ids {
7110: my $hostname=$hostname{$perlvar{'lonHostID'}};
7111: my @ids;
7112: while( my($id, $name) = each(%hostname)) {
7113: # &logthis("-$id-$name-$hostname-");
7114: if ($hostname eq $name) {
7115: push(@ids,$id);
7116: }
7117: }
7118: return @ids;
7119: }
7120:
7121: # ------------------------------------------------------------- Declutters URLs
7122:
7123: sub declutter {
7124: my $thisfn=shift;
7125: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
7126: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
7127: $thisfn=~s/^\///;
7128: $thisfn=~s|^adm/wrapper/||;
7129: $thisfn=~s|^adm/coursedocs/showdoc/||;
7130: $thisfn=~s/^res\///;
7131: $thisfn=~s/\?.+$//;
7132: return $thisfn;
7133: }
7134:
7135: # ------------------------------------------------------------- Clutter up URLs
7136:
7137: sub clutter {
7138: my $thisfn='/'.&declutter(shift);
7139: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
7140: $thisfn='/res'.$thisfn;
7141: }
7142: if ($thisfn !~m|/adm|) {
7143: if ($thisfn =~ m|/ext/|) {
7144: $thisfn='/adm/wrapper'.$thisfn;
7145: } else {
7146: my ($ext) = ($thisfn =~ /\.(\w+)$/);
7147: my $embstyle=&Apache::loncommon::fileembstyle($ext);
7148: if ($embstyle eq 'ssi'
7149: || ($embstyle eq 'hdn')
7150: || ($embstyle eq 'rat')
7151: || ($embstyle eq 'prv')
7152: || ($embstyle eq 'ign')) {
7153: #do nothing with these
7154: } elsif (($embstyle eq 'img')
7155: || ($embstyle eq 'emb')
7156: || ($embstyle eq 'wrp')) {
7157: $thisfn='/adm/wrapper'.$thisfn;
7158: } elsif ($embstyle eq 'unk'
7159: && $thisfn!~/\.(sequence|page)$/) {
7160: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
7161: } else {
7162: # &logthis("Got a blank emb style");
7163: }
7164: }
7165: }
7166: return $thisfn;
7167: }
7168:
7169: sub clutter_with_no_wrapper {
7170: my $uri = &clutter(shift);
7171: if ($uri =~ m-^/adm/-) {
7172: $uri =~ s-^/adm/wrapper/-/-;
7173: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
7174: }
7175: return $uri;
7176: }
7177:
7178: sub freeze_escape {
7179: my ($value)=@_;
7180: if (ref($value)) {
7181: $value=&nfreeze($value);
7182: return '__FROZEN__'.&escape($value);
7183: }
7184: return &escape($value);
7185: }
7186:
7187:
7188: sub thaw_unescape {
7189: my ($value)=@_;
7190: if ($value =~ /^__FROZEN__/) {
7191: substr($value,0,10,undef);
7192: $value=&unescape($value);
7193: return &thaw($value);
7194: }
7195: return &unescape($value);
7196: }
7197:
7198: sub correct_line_ends {
7199: my ($result)=@_;
7200: $$result =~s/\r\n/\n/mg;
7201: $$result =~s/\r/\n/mg;
7202: }
7203: # ================================================================ Main Program
7204:
7205: sub goodbye {
7206: &logthis("Starting Shut down");
7207: #not converted to using infrastruture and probably shouldn't be
7208: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
7209: #converted
7210: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
7211: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
7212: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
7213: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
7214: #1.1 only
7215: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
7216: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
7217: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
7218: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
7219: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
7220: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
7221: &logthis(sprintf("%-20s is %s",'hits',$hits));
7222: &flushcourselogs();
7223: &logthis("Shutting down");
7224: }
7225:
7226: BEGIN {
7227: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
7228: unless ($readit) {
7229: {
7230: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
7231: %perlvar = (%perlvar,%{$configvars});
7232: }
7233:
7234: # ------------------------------------------------------------ Read domain file
7235: {
7236: %domaindescription = ();
7237: %domain_auth_def = ();
7238: %domain_auth_arg_def = ();
7239: my $fh;
7240: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
7241: while (<$fh>) {
7242: next if (/^(\#|\s*$)/);
7243: # next if /^\#/;
7244: chomp;
7245: my ($domain, $domain_description, $def_auth, $def_auth_arg,
7246: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
7247: $domain_auth_def{$domain}=$def_auth;
7248: $domain_auth_arg_def{$domain}=$def_auth_arg;
7249: $domaindescription{$domain}=$domain_description;
7250: $domain_lang_def{$domain}=$def_lang;
7251: $domain_city{$domain}=$city;
7252: $domain_longi{$domain}=$longi;
7253: $domain_lati{$domain}=$lati;
7254: $domain_primary{$domain}=$primary;
7255:
7256: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
7257: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
7258: }
7259: }
7260: close ($fh);
7261: }
7262:
7263:
7264: # ------------------------------------------------------------- Read hosts file
7265: {
7266: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
7267:
7268: while (my $configline=<$config>) {
7269: next if ($configline =~ /^(\#|\s*$)/);
7270: chomp($configline);
7271: my ($id,$domain,$role,$name)=split(/:/,$configline);
7272: $name=~s/\s//g;
7273: if ($id && $domain && $role && $name) {
7274: $hostname{$id}=$name;
7275: $hostdom{$id}=$domain;
7276: if ($role eq 'library') { $libserv{$id}=$name; }
7277: }
7278: }
7279: close($config);
7280: # FIXME: dev server don't want this, production servers _do_ want this
7281: #&get_iphost();
7282: }
7283:
7284: sub get_iphost {
7285: if (%iphost) { return %iphost; }
7286: my %name_to_ip;
7287: foreach my $id (keys(%hostname)) {
7288: my $name=$hostname{$id};
7289: my $ip;
7290: if (!exists($name_to_ip{$name})) {
7291: $ip = gethostbyname($name);
7292: if (!$ip || length($ip) ne 4) {
7293: &logthis("Skipping host $id name $name no IP found\n");
7294: next;
7295: }
7296: $ip=inet_ntoa($ip);
7297: $name_to_ip{$name} = $ip;
7298: } else {
7299: $ip = $name_to_ip{$name};
7300: }
7301: push(@{$iphost{$ip}},$id);
7302: }
7303: return %iphost;
7304: }
7305:
7306: # ------------------------------------------------------ Read spare server file
7307: {
7308: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
7309:
7310: while (my $configline=<$config>) {
7311: chomp($configline);
7312: if ($configline) {
7313: my ($host,$type) = split(':',$configline,2);
7314: if (!defined($type) || $type eq '') { $type = 'default' };
7315: push(@{ $spareid{$type} }, $host);
7316: }
7317: }
7318: close($config);
7319: }
7320: # ------------------------------------------------------------ Read permissions
7321: {
7322: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
7323:
7324: while (my $configline=<$config>) {
7325: chomp($configline);
7326: if ($configline) {
7327: my ($role,$perm)=split(/ /,$configline);
7328: if ($perm ne '') { $pr{$role}=$perm; }
7329: }
7330: }
7331: close($config);
7332: }
7333:
7334: # -------------------------------------------- Read plain texts for permissions
7335: {
7336: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
7337:
7338: while (my $configline=<$config>) {
7339: chomp($configline);
7340: if ($configline) {
7341: my ($short,@plain)=split(/:/,$configline);
7342: %{$prp{$short}} = ();
7343: if (@plain > 0) {
7344: $prp{$short}{'std'} = $plain[0];
7345: for (my $i=1; $i<@plain; $i++) {
7346: $prp{$short}{'alt'.$i} = $plain[$i];
7347: }
7348: }
7349: }
7350: }
7351: close($config);
7352: }
7353:
7354: # ---------------------------------------------------------- Read package table
7355: {
7356: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
7357:
7358: while (my $configline=<$config>) {
7359: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
7360: chomp($configline);
7361: my ($short,$plain)=split(/:/,$configline);
7362: my ($pack,$name)=split(/\&/,$short);
7363: if ($plain ne '') {
7364: $packagetab{$pack.'&'.$name.'&name'}=$name;
7365: $packagetab{$short}=$plain;
7366: }
7367: }
7368: close($config);
7369: }
7370:
7371: # ------------- set up temporary directory
7372: {
7373: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7374:
7375: }
7376:
7377: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
7378: 'compress_threshold'=> 20_000,
7379: });
7380:
7381: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
7382: $dumpcount=0;
7383:
7384: &logtouch();
7385: &logthis('<font color="yellow">INFO: Read configuration</font>');
7386: $readit=1;
7387: {
7388: use integer;
7389: my $test=(2**32)+1;
7390: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
7391: &logthis(" Detected 64bit platform ($_64bit)");
7392: }
7393: }
7394: }
7395:
7396: 1;
7397: __END__
7398:
7399: =pod
7400:
7401: =head1 NAME
7402:
7403: Apache::lonnet - Subroutines to ask questions about things in the network.
7404:
7405: =head1 SYNOPSIS
7406:
7407: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
7408:
7409: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7410:
7411: Common parameters:
7412:
7413: =over 4
7414:
7415: =item *
7416:
7417: $uname : an internal username (if $cname expecting a course Id specifically)
7418:
7419: =item *
7420:
7421: $udom : a domain (if $cdom expecting a course's domain specifically)
7422:
7423: =item *
7424:
7425: $symb : a resource instance identifier
7426:
7427: =item *
7428:
7429: $namespace : the name of a .db file that contains the data needed or
7430: being set.
7431:
7432: =back
7433:
7434: =head1 OVERVIEW
7435:
7436: lonnet provides subroutines which interact with the
7437: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7438: about classes, users, and resources.
7439:
7440: For many of these objects you can also use this to store data about
7441: them or modify them in various ways.
7442:
7443: =head2 Symbs
7444:
7445: To identify a specific instance of a resource, LON-CAPA uses symbols
7446: or "symbs"X<symb>. These identifiers are built from the URL of the
7447: map, the resource number of the resource in the map, and the URL of
7448: the resource itself. The latter is somewhat redundant, but might help
7449: if maps change.
7450:
7451: An example is
7452:
7453: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7454:
7455: The respective map entry is
7456:
7457: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7458: title="Problem 2">
7459: </resource>
7460:
7461: Symbs are used by the random number generator, as well as to store and
7462: restore data specific to a certain instance of for example a problem.
7463:
7464: =head2 Storing And Retrieving Data
7465:
7466: X<store()>X<cstore()>X<restore()>Three of the most important functions
7467: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7468: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7469: is is the non-critical message twin of cstore. These functions are for
7470: handlers to store a perl hash to a user's permanent data space in an
7471: easy manner, and to retrieve it again on another call. It is expected
7472: that a handler would use this once at the beginning to retrieve data,
7473: and then again once at the end to send only the new data back.
7474:
7475: The data is stored in the user's data directory on the user's
7476: homeserver under the ID of the course.
7477:
7478: The hash that is returned by restore will have all of the previous
7479: value for all of the elements of the hash.
7480:
7481: Example:
7482:
7483: #creating a hash
7484: my %hash;
7485: $hash{'foo'}='bar';
7486:
7487: #storing it
7488: &Apache::lonnet::cstore(\%hash);
7489:
7490: #changing a value
7491: $hash{'foo'}='notbar';
7492:
7493: #adding a new value
7494: $hash{'bar'}='foo';
7495: &Apache::lonnet::cstore(\%hash);
7496:
7497: #retrieving the hash
7498: my %history=&Apache::lonnet::restore();
7499:
7500: #print the hash
7501: foreach my $key (sort(keys(%history))) {
7502: print("\%history{$key} = $history{$key}");
7503: }
7504:
7505: Will print out:
7506:
7507: %history{1:foo} = bar
7508: %history{1:keys} = foo:timestamp
7509: %history{1:timestamp} = 990455579
7510: %history{2:bar} = foo
7511: %history{2:foo} = notbar
7512: %history{2:keys} = foo:bar:timestamp
7513: %history{2:timestamp} = 990455580
7514: %history{bar} = foo
7515: %history{foo} = notbar
7516: %history{timestamp} = 990455580
7517: %history{version} = 2
7518:
7519: Note that the special hash entries C<keys>, C<version> and
7520: C<timestamp> were added to the hash. C<version> will be equal to the
7521: total number of versions of the data that have been stored. The
7522: C<timestamp> attribute will be the UNIX time the hash was
7523: stored. C<keys> is available in every historical section to list which
7524: keys were added or changed at a specific historical revision of a
7525: hash.
7526:
7527: B<Warning>: do not store the hash that restore returns directly. This
7528: will cause a mess since it will restore the historical keys as if the
7529: were new keys. I.E. 1:foo will become 1:1:foo etc.
7530:
7531: Calling convention:
7532:
7533: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7534: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
7535:
7536: For more detailed information, see lonnet specific documentation.
7537:
7538: =head1 RETURN MESSAGES
7539:
7540: =over 4
7541:
7542: =item * B<con_lost>: unable to contact remote host
7543:
7544: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7545: when the connection is brought back up
7546:
7547: =item * B<con_failed>: unable to contact remote host and unable to save message
7548: for later delivery
7549:
7550: =item * B<error:>: an error a occured, a description of the error follows the :
7551:
7552: =item * B<no_such_host>: unable to fund a host associated with the user/domain
7553: that was requested
7554:
7555: =back
7556:
7557: =head1 PUBLIC SUBROUTINES
7558:
7559: =head2 Session Environment Functions
7560:
7561: =over 4
7562:
7563: =item *
7564: X<appenv()>
7565: B<appenv(%hash)>: the value of %hash is written to
7566: the user envirnoment file, and will be restored for each access this
7567: user makes during this session, also modifies the %env for the current
7568: process
7569:
7570: =item *
7571: X<delenv()>
7572: B<delenv($regexp)>: removes all items from the session
7573: environment file that matches the regular expression in $regexp. The
7574: values are also delted from the current processes %env.
7575:
7576: =item * get_env_multiple($name)
7577:
7578: gets $name from the %env hash, it seemlessly handles the cases where multiple
7579: values may be defined and end up as an array ref.
7580:
7581: returns an array of values
7582:
7583: =back
7584:
7585: =head2 User Information
7586:
7587: =over 4
7588:
7589: =item *
7590: X<queryauthenticate()>
7591: B<queryauthenticate($uname,$udom)>: try to determine user's current
7592: authentication scheme
7593:
7594: =item *
7595: X<authenticate()>
7596: B<authenticate($uname,$upass,$udom)>: try to
7597: authenticate user from domain's lib servers (first use the current
7598: one). C<$upass> should be the users password.
7599:
7600: =item *
7601: X<homeserver()>
7602: B<homeserver($uname,$udom)>: find the server which has
7603: the user's directory and files (there must be only one), this caches
7604: the answer, and also caches if there is a borken connection.
7605:
7606: =item *
7607: X<idget()>
7608: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7609: (IDs are a unique resource in a domain, there must be only 1 ID per
7610: username, and only 1 username per ID in a specific domain) (returns
7611: hash: id=>name,id=>name)
7612:
7613: =item *
7614: X<idrget()>
7615: B<idrget($udom,@unames)>: find the IDs behind a list of
7616: usernames (returns hash: name=>id,name=>id)
7617:
7618: =item *
7619: X<idput()>
7620: B<idput($udom,%ids)>: store away a list of names and associated IDs
7621:
7622: =item *
7623: X<rolesinit()>
7624: B<rolesinit($udom,$username,$authhost)>: get user privileges
7625:
7626: =item *
7627: X<getsection()>
7628: B<getsection($udom,$uname,$cname)>: finds the section of student in the
7629: course $cname, return section name/number or '' for "not in course"
7630: and '-1' for "no section"
7631:
7632: =item *
7633: X<userenvironment()>
7634: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
7635: passed in @what from the requested user's environment, returns a hash
7636:
7637: =back
7638:
7639: =head2 User Roles
7640:
7641: =over 4
7642:
7643: =item *
7644:
7645: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7646: actions
7647: F: full access
7648: U,I,K: authentication modes (cxx only)
7649: '': forbidden
7650: 1: user needs to choose course
7651: 2: browse allowed
7652: A: passphrase authentication needed
7653:
7654: =item *
7655:
7656: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7657: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7658: and course level
7659:
7660: =item *
7661:
7662: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7663: explanation of a user role term
7664:
7665: =back
7666:
7667: =head2 User Modification
7668:
7669: =over 4
7670:
7671: =item *
7672:
7673: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7674: user for the level given by URL. Optional start and end dates (leave empty
7675: string or zero for "no date")
7676:
7677: =item *
7678:
7679: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7680: change a users, password, possible return values are: ok,
7681: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7682: refused
7683:
7684: =item *
7685:
7686: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
7687:
7688: =item *
7689:
7690: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7691: modify user
7692:
7693: =item *
7694:
7695: modifystudent
7696:
7697: modify a students enrollment and identification information.
7698: The course id is resolved based on the current users environment.
7699: This means the envoking user must be a course coordinator or otherwise
7700: associated with a course.
7701:
7702: This call is essentially a wrapper for lonnet::modifyuser and
7703: lonnet::modify_student_enrollment
7704:
7705: Inputs:
7706:
7707: =over 4
7708:
7709: =item B<$udom> Students loncapa domain
7710:
7711: =item B<$uname> Students loncapa login name
7712:
7713: =item B<$uid> Students id/student number
7714:
7715: =item B<$umode> Students authentication mode
7716:
7717: =item B<$upass> Students password
7718:
7719: =item B<$first> Students first name
7720:
7721: =item B<$middle> Students middle name
7722:
7723: =item B<$last> Students last name
7724:
7725: =item B<$gene> Students generation
7726:
7727: =item B<$usec> Students section in course
7728:
7729: =item B<$end> Unix time of the roles expiration
7730:
7731: =item B<$start> Unix time of the roles start date
7732:
7733: =item B<$forceid> If defined, allow $uid to be changed
7734:
7735: =item B<$desiredhome> server to use as home server for student
7736:
7737: =back
7738:
7739: =item *
7740:
7741: modify_student_enrollment
7742:
7743: Change a students enrollment status in a class. The environment variable
7744: 'role.request.course' must be defined for this function to proceed.
7745:
7746: Inputs:
7747:
7748: =over 4
7749:
7750: =item $udom, students domain
7751:
7752: =item $uname, students name
7753:
7754: =item $uid, students user id
7755:
7756: =item $first, students first name
7757:
7758: =item $middle
7759:
7760: =item $last
7761:
7762: =item $gene
7763:
7764: =item $usec
7765:
7766: =item $end
7767:
7768: =item $start
7769:
7770: =back
7771:
7772:
7773: =item *
7774:
7775: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7776: custom role; give a custom role to a user for the level given by URL. Specify
7777: name and domain of role author, and role name
7778:
7779: =item *
7780:
7781: revokerole($udom,$uname,$url,$role) : revoke a role for url
7782:
7783: =item *
7784:
7785: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7786:
7787: =back
7788:
7789: =head2 Course Infomation
7790:
7791: =over 4
7792:
7793: =item *
7794:
7795: coursedescription($courseid) : returns a hash of information about the
7796: specified course id, including all environment settings for the
7797: course, the description of the course will be in the hash under the
7798: key 'description'
7799:
7800: =item *
7801:
7802: resdata($name,$domain,$type,@which) : request for current parameter
7803: setting for a specific $type, where $type is either 'course' or 'user',
7804: @what should be a list of parameters to ask about. This routine caches
7805: answers for 5 minutes.
7806:
7807: =back
7808:
7809: =head2 Course Modification
7810:
7811: =over 4
7812:
7813: =item *
7814:
7815: writecoursepref($courseid,%prefs) : write preferences (environment
7816: database) for a course
7817:
7818: =item *
7819:
7820: createcourse($udom,$description,$url) : make/modify course
7821:
7822: =back
7823:
7824: =head2 Resource Subroutines
7825:
7826: =over 4
7827:
7828: =item *
7829:
7830: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
7831:
7832: =item *
7833:
7834: repcopy($filename) : subscribes to the requested file, and attempts to
7835: replicate from the owning library server, Might return
7836: 'unavailable', 'not_found', 'forbidden', 'ok', or
7837: 'bad_request', also attempts to grab the metadata for the
7838: resource. Expects the local filesystem pathname
7839: (/home/httpd/html/res/....)
7840:
7841: =back
7842:
7843: =head2 Resource Information
7844:
7845: =over 4
7846:
7847: =item *
7848:
7849: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7850: a vairety of different possible values, $varname should be a request
7851: string, and the other parameters can be used to specify who and what
7852: one is asking about.
7853:
7854: Possible values for $varname are environment.lastname (or other item
7855: from the envirnment hash), user.name (or someother aspect about the
7856: user), resource.0.maxtries (or some other part and parameter of a
7857: resource)
7858:
7859: =item *
7860:
7861: directcondval($number) : get current value of a condition; reads from a state
7862: string
7863:
7864: =item *
7865:
7866: condval($condidx) : value of condition index based on state
7867:
7868: =item *
7869:
7870: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7871: resource's metadata, $what should be either a specific key, or either
7872: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7873: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7874:
7875: this function automatically caches all requests
7876:
7877: =item *
7878:
7879: metadata_query($query,$custom,$customshow) : make a metadata query against the
7880: network of library servers; returns file handle of where SQL and regex results
7881: will be stored for query
7882:
7883: =item *
7884:
7885: symbread($filename) : return symbolic list entry (filename argument optional);
7886: returns the data handle
7887:
7888: =item *
7889:
7890: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
7891: a possible symb for the URL in $thisfn, and if is an encryypted
7892: resource that the user accessed using /enc/ returns a 1 on success, 0
7893: on failure, user must be in a course, as it assumes the existance of
7894: the course initial hash, and uses $env('request.course.id'}
7895:
7896:
7897: =item *
7898:
7899: symbclean($symb) : removes versions numbers from a symb, returns the
7900: cleaned symb
7901:
7902: =item *
7903:
7904: is_on_map($uri) : checks if the $uri is somewhere on the current
7905: course map, user must be in a course for it to work.
7906:
7907: =item *
7908:
7909: numval($salt) : return random seed value (addend for rndseed)
7910:
7911: =item *
7912:
7913: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7914: a random seed, all arguments are optional, if they aren't sent it uses the
7915: environment to derive them. Note: if symb isn't sent and it can't get one
7916: from &symbread it will use the current time as its return value
7917:
7918: =item *
7919:
7920: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7921: unfakeable, receipt
7922:
7923: =item *
7924:
7925: receipt() : API to ireceipt working off of env values; given out to users
7926:
7927: =item *
7928:
7929: countacc($url) : count the number of accesses to a given URL
7930:
7931: =item *
7932:
7933: 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
7934:
7935: =item *
7936:
7937: 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)
7938:
7939: =item *
7940:
7941: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
7942:
7943: =item *
7944:
7945: devalidate($symb) : devalidate temporary spreadsheet calculations,
7946: forcing spreadsheet to reevaluate the resource scores next time.
7947:
7948: =back
7949:
7950: =head2 Storing/Retreiving Data
7951:
7952: =over 4
7953:
7954: =item *
7955:
7956: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7957: for this url; hashref needs to be given and should be a \%hashname; the
7958: remaining args aren't required and if they aren't passed or are '' they will
7959: be derived from the env
7960:
7961: =item *
7962:
7963: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7964: uses critical subroutine
7965:
7966: =item *
7967:
7968: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7969: all args are optional
7970:
7971: =item *
7972:
7973: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7974: dumps the complete (or key matching regexp) namespace into a hash
7975: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7976: normally &store()ed into
7977:
7978: $range should be either an integer '100' (give me the first 100
7979: matching records)
7980: or be two integers sperated by a - with no spaces
7981: '30-50' (give me the 30th through the 50th matching
7982: records)
7983:
7984:
7985: =item *
7986:
7987: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7988: replaces a &store() version of data with a replacement set of data
7989: for a particular resource in a namespace passed in the $storehash hash
7990: reference
7991:
7992: =item *
7993:
7994: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7995: works very similar to store/cstore, but all data is stored in a
7996: temporary location and can be reset using tmpreset, $storehash should
7997: be a hash reference, returns nothing on success
7998:
7999: =item *
8000:
8001: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
8002: similar to restore, but all data is stored in a temporary location and
8003: can be reset using tmpreset. Returns a hash of values on success,
8004: error string otherwise.
8005:
8006: =item *
8007:
8008: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
8009: deltes all keys for $symb form the temporary storage hash.
8010:
8011: =item *
8012:
8013: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8014: reference filled in from namesp ($udom and $uname are optional)
8015:
8016: =item *
8017:
8018: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
8019: namesp ($udom and $uname are optional)
8020:
8021: =item *
8022:
8023: dump($namespace,$udom,$uname,$regexp,$range) :
8024: dumps the complete (or key matching regexp) namespace into a hash
8025: ($udom, $uname, $regexp, $range are optional)
8026:
8027: $range should be either an integer '100' (give me the first 100
8028: matching records)
8029: or be two integers sperated by a - with no spaces
8030: '30-50' (give me the 30th through the 50th matching
8031: records)
8032: =item *
8033:
8034: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
8035: $store can be a scalar, an array reference, or if the amount to be
8036: incremented is > 1, a hash reference.
8037:
8038: ($udom and $uname are optional)
8039:
8040: =item *
8041:
8042: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
8043: ($udom and $uname are optional)
8044:
8045: =item *
8046:
8047: cput($namespace,$storehash,$udom,$uname) : critical put
8048: ($udom and $uname are optional)
8049:
8050: =item *
8051:
8052: newput($namespace,$storehash,$udom,$uname) :
8053:
8054: Attempts to store the items in the $storehash, but only if they don't
8055: currently exist, if this succeeds you can be certain that you have
8056: successfully created a new key value pair in the $namespace db.
8057:
8058:
8059: Args:
8060: $namespace: name of database to store values to
8061: $storehash: hashref to store to the db
8062: $udom: (optional) domain of user containing the db
8063: $uname: (optional) name of user caontaining the db
8064:
8065: Returns:
8066: 'ok' -> succeeded in storing all keys of $storehash
8067: 'key_exists: <key>' -> failed to anything out of $storehash, as at
8068: least <key> already existed in the db (other
8069: requested keys may also already exist)
8070: 'error: <msg>' -> unable to tie the DB or other erorr occured
8071: 'con_lost' -> unable to contact request server
8072: 'refused' -> action was not allowed by remote machine
8073:
8074:
8075: =item *
8076:
8077: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
8078: reference filled in from namesp (encrypts the return communication)
8079: ($udom and $uname are optional)
8080:
8081: =item *
8082:
8083: log($udom,$name,$home,$message) : write to permanent log for user; use
8084: critical subroutine
8085:
8086: =back
8087:
8088: =head2 Network Status Functions
8089:
8090: =over 4
8091:
8092: =item *
8093:
8094: dirlist($uri) : return directory list based on URI
8095:
8096: =item *
8097:
8098: spareserver() : find server with least workload from spare.tab
8099:
8100: =back
8101:
8102: =head2 Apache Request
8103:
8104: =over 4
8105:
8106: =item *
8107:
8108: ssi($url,%hash) : server side include, does a complete request cycle on url to
8109: localhost, posts hash
8110:
8111: =back
8112:
8113: =head2 Data to String to Data
8114:
8115: =over 4
8116:
8117: =item *
8118:
8119: hash2str(%hash) : convert a hash into a string complete with escaping and '='
8120: and '&' separators, supports elements that are arrayrefs and hashrefs
8121:
8122: =item *
8123:
8124: hashref2str($hashref) : convert a hashref into a string complete with
8125: escaping and '=' and '&' separators, supports elements that are
8126: arrayrefs and hashrefs
8127:
8128: =item *
8129:
8130: arrayref2str($arrayref) : convert an arrayref into a string complete
8131: with escaping and '&' separators, supports elements that are arrayrefs
8132: and hashrefs
8133:
8134: =item *
8135:
8136: str2hash($string) : convert string to hash using unescaping and
8137: splitting on '=' and '&', supports elements that are arrayrefs and
8138: hashrefs
8139:
8140: =item *
8141:
8142: str2array($string) : convert string to hash using unescaping and
8143: splitting on '&', supports elements that are arrayrefs and hashrefs
8144:
8145: =back
8146:
8147: =head2 Logging Routines
8148:
8149: =over 4
8150:
8151: These routines allow one to make log messages in the lonnet.log and
8152: lonnet.perm logfiles.
8153:
8154: =item *
8155:
8156: logtouch() : make sure the logfile, lonnet.log, exists
8157:
8158: =item *
8159:
8160: logthis() : append message to the normal lonnet.log file, it gets
8161: preiodically rolled over and deleted.
8162:
8163: =item *
8164:
8165: logperm() : append a permanent message to lonnet.perm.log, this log
8166: file never gets deleted by any automated portion of the system, only
8167: messages of critical importance should go in here.
8168:
8169: =back
8170:
8171: =head2 General File Helper Routines
8172:
8173: =over 4
8174:
8175: =item *
8176:
8177: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
8178: (a) files in /uploaded
8179: (i) If a local copy of the file exists -
8180: compares modification date of local copy with last-modified date for
8181: definitive version stored on home server for course. If local copy is
8182: stale, requests a new version from the home server and stores it.
8183: If the original has been removed from the home server, then local copy
8184: is unlinked.
8185: (ii) If local copy does not exist -
8186: requests the file from the home server and stores it.
8187:
8188: If $caller is 'uploadrep':
8189: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
8190: for request for files originally uploaded via DOCS.
8191: - returns 'ok' if fresh local copy now available, -1 otherwise.
8192:
8193: Otherwise:
8194: This indicates a call from the content generation phase of the request.
8195: - returns the entire contents of the file or -1.
8196:
8197: (b) files in /res
8198: - returns the entire contents of a file or -1;
8199: it properly subscribes to and replicates the file if neccessary.
8200:
8201:
8202: =item *
8203:
8204: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
8205: reference
8206:
8207: returns either a stat() list of data about the file or an empty list
8208: if the file doesn't exist or couldn't find out about it (connection
8209: problems or user unknown)
8210:
8211: =item *
8212:
8213: filelocation($dir,$file) : returns file system location of a file
8214: based on URI; meant to be "fairly clean" absolute reference, $dir is a
8215: directory that relative $file lookups are to looked in ($dir of /a/dir
8216: and a file of ../bob will become /a/bob)
8217:
8218: =item *
8219:
8220: hreflocation($dir,$file) : returns file system location or a URL; same as
8221: filelocation except for hrefs
8222:
8223: =item *
8224:
8225: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
8226:
8227: =back
8228:
8229: =head2 Usererfile file routines (/uploaded*)
8230:
8231: =over 4
8232:
8233: =item *
8234:
8235: userfileupload(): main rotine for putting a file in a user or course's
8236: filespace, arguments are,
8237:
8238: formname - required - this is the name of the element in $env where the
8239: filename, and the contents of the file to create/modifed exist
8240: the filename is in $env{'form.'.$formname.'.filename'} and the
8241: contents of the file is located in $env{'form.'.$formname}
8242: coursedoc - if true, store the file in the course of the active role
8243: of the current user
8244: subdir - required - subdirectory to put the file in under ../userfiles/
8245: if undefined, it will be placed in "unknown"
8246:
8247: (This routine calls clean_filename() to remove any dangerous
8248: characters from the filename, and then calls finuserfileupload() to
8249: complete the transaction)
8250:
8251: returns either the url of the uploaded file (/uploaded/....) if successful
8252: and /adm/notfound.html if unsuccessful
8253:
8254: =item *
8255:
8256: clean_filename(): routine for cleaing a filename up for storage in
8257: userfile space, argument is:
8258:
8259: filename - proposed filename
8260:
8261: returns: the new clean filename
8262:
8263: =item *
8264:
8265: finishuserfileupload(): routine that creaes and sends the file to
8266: userspace, probably shouldn't be called directly
8267:
8268: docuname: username or courseid of destination for the file
8269: docudom: domain of user/course of destination for the file
8270: formname: same as for userfileupload()
8271: fname: filename (inculding subdirectories) for the file
8272:
8273: returns either the url of the uploaded file (/uploaded/....) if successful
8274: and /adm/notfound.html if unsuccessful
8275:
8276: =item *
8277:
8278: renameuserfile(): renames an existing userfile to a new name
8279:
8280: Args:
8281: docuname: username or courseid of destination for the file
8282: docudom: domain of user/course of destination for the file
8283: old: current file name (including any subdirs under userfiles)
8284: new: desired file name (including any subdirs under userfiles)
8285:
8286: =item *
8287:
8288: mkdiruserfile(): creates a directory is a userfiles dir
8289:
8290: Args:
8291: docuname: username or courseid of destination for the file
8292: docudom: domain of user/course of destination for the file
8293: dir: dir to create (including any subdirs under userfiles)
8294:
8295: =item *
8296:
8297: removeuserfile(): removes a file that exists in userfiles
8298:
8299: Args:
8300: docuname: username or courseid of destination for the file
8301: docudom: domain of user/course of destination for the file
8302: fname: filname to delete (including any subdirs under userfiles)
8303:
8304: =item *
8305:
8306: removeuploadedurl(): convience function for removeuserfile()
8307:
8308: Args:
8309: url: a full /uploaded/... url to delete
8310:
8311: =item *
8312:
8313: get_portfile_permissions():
8314: Args:
8315: domain: domain of user or course contain the portfolio files
8316: user: name of user or num of course contain the portfolio files
8317: Returns:
8318: hashref of a dump of the proper file_permissions.db
8319:
8320:
8321: =item *
8322:
8323: get_access_controls():
8324:
8325: Args:
8326: current_permissions: the hash ref returned from get_portfile_permissions()
8327: group: (optional) the group you want the files associated with
8328: file: (optional) the file you want access info on
8329:
8330: Returns:
8331: a hash (keys are file names) of hashes containing
8332: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
8333: values are XML containing access control settings (see below)
8334:
8335: Internal notes:
8336:
8337: access controls are stored in file_permissions.db as key=value pairs.
8338: key -> path to file/file_name\0uniqueID:scope_end_start
8339: where scope -> public,guest,course,group,domains or users.
8340: end -> UNIX time for end of access (0 -> no end date)
8341: start -> UNIX time for start of access
8342:
8343: value -> XML description of access control
8344: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
8345: <start></start>
8346: <end></end>
8347:
8348: <password></password> for scope type = guest
8349:
8350: <domain></domain> for scope type = course or group
8351: <number></number>
8352: <roles id="">
8353: <role></role>
8354: <access></access>
8355: <section></section>
8356: <group></group>
8357: </roles>
8358:
8359: <dom></dom> for scope type = domains
8360:
8361: <users> for scope type = users
8362: <user>
8363: <uname></uname>
8364: <udom></udom>
8365: </user>
8366: </users>
8367: </scope>
8368:
8369: Access data is also aggregated for each file in an additional key=value pair:
8370: key -> path to file/file_name\0accesscontrol
8371: value -> reference to hash
8372: hash contains key = value pairs
8373: where key = uniqueID:scope_end_start
8374: value = UNIX time record was last updated
8375:
8376: Used to improve speed of look-ups of access controls for each file.
8377:
8378: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8379:
8380: modify_access_controls():
8381:
8382: Modifies access controls for a portfolio file
8383: Args
8384: 1. file name
8385: 2. reference to hash of required changes,
8386: 3. domain
8387: 4. username
8388: where domain,username are the domain of the portfolio owner
8389: (either a user or a course)
8390:
8391: Returns:
8392: 1. result of additions or updates ('ok' or 'error', with error message).
8393: 2. result of deletions ('ok' or 'error', with error message).
8394: 3. reference to hash of any new or updated access controls.
8395: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8396: key = integer (inbound ID)
8397: value = uniqueID
8398:
8399: =back
8400:
8401: =head2 HTTP Helper Routines
8402:
8403: =over 4
8404:
8405: =item *
8406:
8407: escape() : unpack non-word characters into CGI-compatible hex codes
8408:
8409: =item *
8410:
8411: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8412:
8413: =back
8414:
8415: =head1 PRIVATE SUBROUTINES
8416:
8417: =head2 Underlying communication routines (Shouldn't call)
8418:
8419: =over 4
8420:
8421: =item *
8422:
8423: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8424:
8425: =item *
8426:
8427: reply() : uses subreply to send a message to remote machine, logs all failures
8428:
8429: =item *
8430:
8431: critical() : passes a critical message to another server; if cannot
8432: get through then place message in connection buffer directory and
8433: returns con_delayed, if incapable of saving message, returns
8434: con_failed
8435:
8436: =item *
8437:
8438: reconlonc() : tries to reconnect lonc client processes.
8439:
8440: =back
8441:
8442: =head2 Resource Access Logging
8443:
8444: =over 4
8445:
8446: =item *
8447:
8448: flushcourselogs() : flush (save) buffer logs and access logs
8449:
8450: =item *
8451:
8452: courselog($what) : save message for course in hash
8453:
8454: =item *
8455:
8456: courseacclog($what) : save message for course using &courselog(). Perform
8457: special processing for specific resource types (problems, exams, quizzes, etc).
8458:
8459: =item *
8460:
8461: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8462: as a PerlChildExitHandler
8463:
8464: =back
8465:
8466: =head2 Other
8467:
8468: =over 4
8469:
8470: =item *
8471:
8472: symblist($mapname,%newhash) : update symbolic storage links
8473:
8474: =back
8475:
8476: =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