1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.757 2006/06/22 15:34:16 albertel 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 lib '/home/httpd/lib/perl';
56: use LONCAPA;
57: use LONCAPA::Configuration;
58:
59: my $readit;
60: my $max_connection_retries = 10; # Or some such value.
61:
62: require Exporter;
63:
64: our @ISA = qw (Exporter);
65: our @EXPORT = qw(%env);
66:
67: =pod
68:
69: =head1 Package Variables
70:
71: These are largely undocumented, so if you decipher one please note it here.
72:
73: =over 4
74:
75: =item $processmarker
76:
77: Contains the time this process was started and this servers host id.
78:
79: =item $dumpcount
80:
81: Counts the number of times a message log flush has been attempted (regardless
82: of success) by this process. Used as part of the filename when messages are
83: delayed.
84:
85: =back
86:
87: =cut
88:
89:
90: # --------------------------------------------------------------------- Logging
91: {
92: my $logid;
93: sub instructor_log {
94: my ($hash_name,$storehash,$delflag,$uname,$udom)=@_;
95: $logid++;
96: my $id=time().'00000'.$$.'00000'.$logid;
97: return &Apache::lonnet::put('nohist_'.$hash_name,
98: { $id => {
99: 'exe_uname' => $env{'user.name'},
100: 'exe_udom' => $env{'user.domain'},
101: 'exe_time' => time(),
102: 'exe_ip' => $ENV{'REMOTE_ADDR'},
103: 'delflag' => $delflag,
104: 'logentry' => $storehash,
105: 'uname' => $uname,
106: 'udom' => $udom,
107: }
108: },
109: $env{'course.'.$env{'request.course.id'}.'.domain'},
110: $env{'course.'.$env{'request.course.id'}.'.num'}
111: );
112: }
113: }
114:
115: sub logtouch {
116: my $execdir=$perlvar{'lonDaemons'};
117: unless (-e "$execdir/logs/lonnet.log") {
118: open(my $fh,">>$execdir/logs/lonnet.log");
119: close $fh;
120: }
121: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
122: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
123: }
124:
125: sub logthis {
126: my $message=shift;
127: my $execdir=$perlvar{'lonDaemons'};
128: my $now=time;
129: my $local=localtime($now);
130: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
131: print $fh "$local ($$): $message\n";
132: close($fh);
133: }
134: return 1;
135: }
136:
137: sub logperm {
138: my $message=shift;
139: my $execdir=$perlvar{'lonDaemons'};
140: my $now=time;
141: my $local=localtime($now);
142: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
143: print $fh "$now:$message:$local\n";
144: close($fh);
145: }
146: return 1;
147: }
148:
149: # -------------------------------------------------- Non-critical communication
150: sub subreply {
151: my ($cmd,$server)=@_;
152: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
153: #
154: # With loncnew process trimming, there's a timing hole between lonc server
155: # process exit and the master server picking up the listen on the AF_UNIX
156: # socket. In that time interval, a lock file will exist:
157:
158: my $lockfile=$peerfile.".lock";
159: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
160: sleep(1);
161: }
162: # At this point, either a loncnew parent is listening or an old lonc
163: # or loncnew child is listening so we can connect or everything's dead.
164: #
165: # We'll give the connection a few tries before abandoning it. If
166: # connection is not possible, we'll con_lost back to the client.
167: #
168: my $client;
169: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
170: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
171: Type => SOCK_STREAM,
172: Timeout => 10);
173: if($client) {
174: last; # Connected!
175: }
176: sleep(1); # Try again later if failed connection.
177: }
178: my $answer;
179: if ($client) {
180: print $client "sethost:$server:$cmd\n";
181: $answer=<$client>;
182: if (!$answer) { $answer="con_lost"; }
183: chomp($answer);
184: } else {
185: $answer = 'con_lost'; # Failed connection.
186: }
187: return $answer;
188: }
189:
190: sub reply {
191: my ($cmd,$server)=@_;
192: unless (defined($hostname{$server})) { return 'no_such_host'; }
193: my $answer=subreply($cmd,$server);
194: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
195: &logthis("<font color=\"blue\">WARNING:".
196: " $cmd to $server returned $answer</font>");
197: }
198: return $answer;
199: }
200:
201: # ----------------------------------------------------------- Send USR1 to lonc
202:
203: sub reconlonc {
204: my $peerfile=shift;
205: &logthis("Trying to reconnect for $peerfile");
206: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
207: if (open(my $fh,"<$loncfile")) {
208: my $loncpid=<$fh>;
209: chomp($loncpid);
210: if (kill 0 => $loncpid) {
211: &logthis("lonc at pid $loncpid responding, sending USR1");
212: kill USR1 => $loncpid;
213: sleep 1;
214: if (-e "$peerfile") { return; }
215: &logthis("$peerfile still not there, give it another try");
216: sleep 5;
217: if (-e "$peerfile") { return; }
218: &logthis(
219: "<font color=\"blue\">WARNING: $peerfile still not there, giving up</font>");
220: } else {
221: &logthis(
222: "<font color=\"blue\">WARNING:".
223: " lonc at pid $loncpid not responding, giving up</font>");
224: }
225: } else {
226: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
227: }
228: }
229:
230: # ------------------------------------------------------ Critical communication
231:
232: sub critical {
233: my ($cmd,$server)=@_;
234: unless ($hostname{$server}) {
235: &logthis("<font color=\"blue\">WARNING:".
236: " Critical message to unknown server ($server)</font>");
237: return 'no_such_host';
238: }
239: my $answer=reply($cmd,$server);
240: if ($answer eq 'con_lost') {
241: &reconlonc("$perlvar{'lonSockDir'}/$server");
242: my $answer=reply($cmd,$server);
243: if ($answer eq 'con_lost') {
244: my $now=time;
245: my $middlename=$cmd;
246: $middlename=substr($middlename,0,16);
247: $middlename=~s/\W//g;
248: my $dfilename=
249: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
250: $dumpcount++;
251: {
252: my $dfh;
253: if (open($dfh,">$dfilename")) {
254: print $dfh "$cmd\n";
255: close($dfh);
256: }
257: }
258: sleep 2;
259: my $wcmd='';
260: {
261: my $dfh;
262: if (open($dfh,"<$dfilename")) {
263: $wcmd=<$dfh>;
264: close($dfh);
265: }
266: }
267: chomp($wcmd);
268: if ($wcmd eq $cmd) {
269: &logthis("<font color=\"blue\">WARNING: ".
270: "Connection buffer $dfilename: $cmd</font>");
271: &logperm("D:$server:$cmd");
272: return 'con_delayed';
273: } else {
274: &logthis("<font color=\"red\">CRITICAL:"
275: ." Critical connection failed: $server $cmd</font>");
276: &logperm("F:$server:$cmd");
277: return 'con_failed';
278: }
279: }
280: }
281: return $answer;
282: }
283:
284: # ------------------------------------------- check if return value is an error
285:
286: sub error {
287: my ($result) = @_;
288: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
289: if ($2 == 2) { return undef; }
290: return $1;
291: }
292: return undef;
293: }
294:
295: # ------------------------------------------- Transfer profile into environment
296:
297: sub transfer_profile_to_env {
298: my ($lonidsdir,$handle)=@_;
299: if (!defined($lonidsdir)) {
300: $lonidsdir = $perlvar{'lonIDsDir'};
301: }
302: if (!defined($handle)) {
303: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
304: }
305:
306: my @profile;
307: {
308: open(my $idf,"$lonidsdir/$handle.id");
309: flock($idf,LOCK_SH);
310: @profile=<$idf>;
311: close($idf);
312: }
313: my $envi;
314: my %Remove;
315: for ($envi=0;$envi<=$#profile;$envi++) {
316: chomp($profile[$envi]);
317: my ($envname,$envvalue)=split(/=/,$profile[$envi],2);
318: $envname=&unescape($envname);
319: $envvalue=&unescape($envvalue);
320: $env{$envname} = $envvalue;
321: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
322: if ($time < time-300) {
323: $Remove{$key}++;
324: }
325: }
326: }
327: $env{'user.environment'} = "$lonidsdir/$handle.id";
328: foreach my $expired_key (keys(%Remove)) {
329: &delenv($expired_key);
330: }
331: }
332:
333: # ---------------------------------------------------------- Append Environment
334:
335: sub appenv {
336: my %newenv=@_;
337: foreach my $key (keys(%newenv)) {
338: if (($newenv{$key}=~/^user\.role/) || ($newenv{$key}=~/^user\.priv/)) {
339: &logthis("<font color=\"blue\">WARNING: ".
340: "Attempt to modify environment ".$key." to ".$newenv{$key}
341: .'</font>');
342: delete($newenv{$key});
343: } else {
344: $env{$key}=$newenv{$key};
345: }
346: }
347:
348: my $lockfh;
349: unless (open($lockfh,"$env{'user.environment'}")) {
350: return 'error: '.$!;
351: }
352: unless (flock($lockfh,LOCK_EX)) {
353: &logthis("<font color=\"blue\">WARNING: ".
354: 'Could not obtain exclusive lock in appenv: '.$!);
355: close($lockfh);
356: return 'error: '.$!;
357: }
358:
359: my @oldenv;
360: {
361: my $fh;
362: unless (open($fh,"$env{'user.environment'}")) {
363: return 'error: '.$!;
364: }
365: @oldenv=<$fh>;
366: close($fh);
367: }
368: for (my $i=0; $i<=$#oldenv; $i++) {
369: chomp($oldenv[$i]);
370: if ($oldenv[$i] ne '') {
371: my ($name,$value)=split(/=/,$oldenv[$i],2);
372: $name=&unescape($name);
373: $value=&unescape($value);
374: unless (defined($newenv{$name})) {
375: $newenv{$name}=$value;
376: }
377: }
378: }
379: {
380: my $fh;
381: unless (open($fh,">$env{'user.environment'}")) {
382: return 'error';
383: }
384: my $newname;
385: foreach $newname (keys %newenv) {
386: print $fh &escape($newname).'='.&escape($newenv{$newname})."\n";
387: }
388: close($fh);
389: }
390:
391: close($lockfh);
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: my @oldenv;
404: {
405: my $fh;
406: unless (open($fh,"$env{'user.environment'}")) {
407: return 'error';
408: }
409: unless (flock($fh,LOCK_SH)) {
410: &logthis("<font color=\"blue\">WARNING: ".
411: 'Could not obtain shared lock in delenv: '.$!);
412: close($fh);
413: return 'error: '.$!;
414: }
415: @oldenv=<$fh>;
416: close($fh);
417: }
418: {
419: my $fh;
420: unless (open($fh,">$env{'user.environment'}")) {
421: return 'error';
422: }
423: unless (flock($fh,LOCK_EX)) {
424: &logthis("<font color=\"blue\">WARNING: ".
425: 'Could not obtain exclusive lock in delenv: '.$!);
426: close($fh);
427: return 'error: '.$!;
428: }
429: foreach my $cur_key (@oldenv) {
430: my $unescaped_cur_key = &unescape($cur_key);
431: if ($unescaped_cur_key=~/^$delthis/) {
432: my ($key) = split('=',$cur_key,2);
433: $key = &unescape($key);
434: delete($env{$key});
435: } else {
436: print $fh $cur_key;
437: }
438: }
439: close($fh);
440: }
441: return 'ok';
442: }
443:
444: # ------------------------------------------ Find out current server userload
445: # there is a copy in lond
446: sub userload {
447: my $numusers=0;
448: {
449: opendir(LONIDS,$perlvar{'lonIDsDir'});
450: my $filename;
451: my $curtime=time;
452: while ($filename=readdir(LONIDS)) {
453: if ($filename eq '.' || $filename eq '..') {next;}
454: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
455: if ($curtime-$mtime < 1800) { $numusers++; }
456: }
457: closedir(LONIDS);
458: }
459: my $userloadpercent=0;
460: my $maxuserload=$perlvar{'lonUserLoadLim'};
461: if ($maxuserload) {
462: $userloadpercent=100*$numusers/$maxuserload;
463: }
464: $userloadpercent=sprintf("%.2f",$userloadpercent);
465: return $userloadpercent;
466: }
467:
468: # ------------------------------------------ Fight off request when overloaded
469:
470: sub overloaderror {
471: my ($r,$checkserver)=@_;
472: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
473: my $loadavg;
474: if ($checkserver eq $perlvar{'lonHostID'}) {
475: open(my $loadfile,'/proc/loadavg');
476: $loadavg=<$loadfile>;
477: $loadavg =~ s/\s.*//g;
478: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
479: close($loadfile);
480: } else {
481: $loadavg=&reply('load',$checkserver);
482: }
483: my $overload=$loadavg-100;
484: if ($overload>0) {
485: $r->err_headers_out->{'Retry-After'}=$overload;
486: $r->log_error('Overload of '.$overload.' on '.$checkserver);
487: return 413;
488: }
489: return '';
490: }
491:
492: # ------------------------------ Find server with least workload from spare.tab
493:
494: sub spareserver {
495: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
496: my $tryserver;
497: my $spareserver='';
498: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
499: my $lowestserver=$loadpercent > $userloadpercent?
500: $loadpercent : $userloadpercent;
501: foreach $tryserver (keys(%spareid)) {
502: my $loadans=&reply('load',$tryserver);
503: my $userloadans=&reply('userload',$tryserver);
504: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
505: next; #didn't get a number from the server
506: }
507: my $answer;
508: if ($loadans =~ /\d/) {
509: if ($userloadans =~ /\d/) {
510: #both are numbers, pick the bigger one
511: $answer=$loadans > $userloadans?
512: $loadans : $userloadans;
513: } else {
514: $answer = $loadans;
515: }
516: } else {
517: $answer = $userloadans;
518: }
519: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
520: if ($want_server_name) {
521: $spareserver=$tryserver;
522: } else {
523: $spareserver="http://$hostname{$tryserver}";
524: }
525: $lowestserver=$answer;
526: }
527: }
528: return $spareserver;
529: }
530:
531: # --------------------------------------------- Try to change a user's password
532:
533: sub changepass {
534: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
535: $currentpass = &escape($currentpass);
536: $newpass = &escape($newpass);
537: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
538: $server);
539: if (! $answer) {
540: &logthis("No reply on password change request to $server ".
541: "by $uname in domain $udom.");
542: } elsif ($answer =~ "^ok") {
543: &logthis("$uname in $udom successfully changed their password ".
544: "on $server.");
545: } elsif ($answer =~ "^pwchange_failure") {
546: &logthis("$uname in $udom was unable to change their password ".
547: "on $server. The action was blocked by either lcpasswd ".
548: "or pwchange");
549: } elsif ($answer =~ "^non_authorized") {
550: &logthis("$uname in $udom did not get their password correct when ".
551: "attempting to change it on $server.");
552: } elsif ($answer =~ "^auth_mode_error") {
553: &logthis("$uname in $udom attempted to change their password despite ".
554: "not being locally or internally authenticated on $server.");
555: } elsif ($answer =~ "^unknown_user") {
556: &logthis("$uname in $udom attempted to change their password ".
557: "on $server but were unable to because $server is not ".
558: "their home server.");
559: } elsif ($answer =~ "^refused") {
560: &logthis("$server refused to change $uname in $udom password because ".
561: "it was sent an unencrypted request to change the password.");
562: }
563: return $answer;
564: }
565:
566: # ----------------------- Try to determine user's current authentication scheme
567:
568: sub queryauthenticate {
569: my ($uname,$udom)=@_;
570: my $uhome=&homeserver($uname,$udom);
571: if (!$uhome) {
572: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
573: return 'no_host';
574: }
575: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
576: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
577: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
578: }
579: return $answer;
580: }
581:
582: # --------- Try to authenticate user from domain's lib servers (first this one)
583:
584: sub authenticate {
585: my ($uname,$upass,$udom)=@_;
586: $upass=escape($upass);
587: $uname=~s/\W//g;
588: my $uhome=&homeserver($uname,$udom);
589: if (!$uhome) {
590: &logthis("User $uname at $udom is unknown in authenticate");
591: return 'no_host';
592: }
593: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
594: if ($answer eq 'authorized') {
595: &logthis("User $uname at $udom authorized by $uhome");
596: return $uhome;
597: }
598: if ($answer eq 'non_authorized') {
599: &logthis("User $uname at $udom rejected by $uhome");
600: return 'no_host';
601: }
602: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
603: return 'no_host';
604: }
605:
606: # ---------------------- Find the homebase for a user from domain's lib servers
607:
608: my %homecache;
609: sub homeserver {
610: my ($uname,$udom,$ignoreBadCache)=@_;
611: my $index="$uname:$udom";
612:
613: if (exists($homecache{$index})) { return $homecache{$index}; }
614: my $tryserver;
615: foreach $tryserver (keys %libserv) {
616: next if ($ignoreBadCache ne 'true' &&
617: exists($badServerCache{$tryserver}));
618: if ($hostdom{$tryserver} eq $udom) {
619: my $answer=reply("home:$udom:$uname",$tryserver);
620: if ($answer eq 'found') {
621: return $homecache{$index}=$tryserver;
622: } elsif ($answer eq 'no_host') {
623: $badServerCache{$tryserver}=1;
624: }
625: }
626: }
627: return 'no_host';
628: }
629:
630: # ------------------------------------- Find the usernames behind a list of IDs
631:
632: sub idget {
633: my ($udom,@ids)=@_;
634: my %returnhash=();
635:
636: my $tryserver;
637: foreach $tryserver (keys %libserv) {
638: if ($hostdom{$tryserver} eq $udom) {
639: my $idlist=join('&',@ids);
640: $idlist=~tr/A-Z/a-z/;
641: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
642: my @answer=();
643: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
644: @answer=split(/\&/,$reply);
645: } ;
646: my $i;
647: for ($i=0;$i<=$#ids;$i++) {
648: if ($answer[$i]) {
649: $returnhash{$ids[$i]}=$answer[$i];
650: }
651: }
652: }
653: }
654: return %returnhash;
655: }
656:
657: # ------------------------------------- Find the IDs behind a list of usernames
658:
659: sub idrget {
660: my ($udom,@unames)=@_;
661: my %returnhash=();
662: foreach (@unames) {
663: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
664: }
665: return %returnhash;
666: }
667:
668: # ------------------------------- Store away a list of names and associated IDs
669:
670: sub idput {
671: my ($udom,%ids)=@_;
672: my %servers=();
673: foreach (keys %ids) {
674: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
675: my $uhom=&homeserver($_,$udom);
676: if ($uhom ne 'no_host') {
677: my $id=&escape($ids{$_});
678: $id=~tr/A-Z/a-z/;
679: my $unam=&escape($_);
680: if ($servers{$uhom}) {
681: $servers{$uhom}.='&'.$id.'='.$unam;
682: } else {
683: $servers{$uhom}=$id.'='.$unam;
684: }
685: }
686: }
687: foreach (keys %servers) {
688: &critical('idput:'.$udom.':'.$servers{$_},$_);
689: }
690: }
691:
692: # --------------------------------------------------- Assign a key to a student
693:
694: sub assign_access_key {
695: #
696: # a valid key looks like uname:udom#comments
697: # comments are being appended
698: #
699: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
700: $kdom=
701: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
702: $knum=
703: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
704: $cdom=
705: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
706: $cnum=
707: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
708: $udom=$env{'user.name'} unless (defined($udom));
709: $uname=$env{'user.domain'} unless (defined($uname));
710: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
711: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
712: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
713: # assigned to this person
714: # - this should not happen,
715: # unless something went wrong
716: # the first time around
717: # ready to assign
718: $logentry=$1.'; '.$logentry;
719: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
720: $kdom,$knum) eq 'ok') {
721: # key now belongs to user
722: my $envkey='key.'.$cdom.'_'.$cnum;
723: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
724: &appenv('environment.'.$envkey => $ckey);
725: return 'ok';
726: } else {
727: return
728: 'error: Count not permanently assign key, will need to be re-entered later.';
729: }
730: } else {
731: return 'error: Could not assign key, try again later.';
732: }
733: } elsif (!$existing{$ckey}) {
734: # the key does not exist
735: return 'error: The key does not exist';
736: } else {
737: # the key is somebody else's
738: return 'error: The key is already in use';
739: }
740: }
741:
742: # ------------------------------------------ put an additional comment on a key
743:
744: sub comment_access_key {
745: #
746: # a valid key looks like uname:udom#comments
747: # comments are being appended
748: #
749: my ($ckey,$cdom,$cnum,$logentry)=@_;
750: $cdom=
751: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
752: $cnum=
753: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
754: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
755: if ($existing{$ckey}) {
756: $existing{$ckey}.='; '.$logentry;
757: # ready to assign
758: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
759: $cdom,$cnum) eq 'ok') {
760: return 'ok';
761: } else {
762: return 'error: Count not store comment.';
763: }
764: } else {
765: # the key does not exist
766: return 'error: The key does not exist';
767: }
768: }
769:
770: # ------------------------------------------------------ Generate a set of keys
771:
772: sub generate_access_keys {
773: my ($number,$cdom,$cnum,$logentry)=@_;
774: $cdom=
775: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
776: $cnum=
777: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
778: unless (&allowed('mky',$cdom)) { return 0; }
779: unless (($cdom) && ($cnum)) { return 0; }
780: if ($number>10000) { return 0; }
781: sleep(2); # make sure don't get same seed twice
782: srand(time()^($$+($$<<15))); # from "Programming Perl"
783: my $total=0;
784: for (my $i=1;$i<=$number;$i++) {
785: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
786: sprintf("%lx",int(100000*rand)).'-'.
787: sprintf("%lx",int(100000*rand));
788: $newkey=~s/1/g/g; # folks mix up 1 and l
789: $newkey=~s/0/h/g; # and also 0 and O
790: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
791: if ($existing{$newkey}) {
792: $i--;
793: } else {
794: if (&put('accesskeys',
795: { $newkey => '# generated '.localtime().
796: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
797: '; '.$logentry },
798: $cdom,$cnum) eq 'ok') {
799: $total++;
800: }
801: }
802: }
803: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
804: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
805: return $total;
806: }
807:
808: # ------------------------------------------------------- Validate an accesskey
809:
810: sub validate_access_key {
811: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
812: $cdom=
813: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
814: $cnum=
815: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
816: $udom=$env{'user.domain'} unless (defined($udom));
817: $uname=$env{'user.name'} unless (defined($uname));
818: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
819: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
820: }
821:
822: # ------------------------------------- Find the section of student in a course
823: sub devalidate_getsection_cache {
824: my ($udom,$unam,$courseid)=@_;
825: $courseid=~s/\_/\//g;
826: $courseid=~s/^(\w)/\/$1/;
827: my $hashid="$udom:$unam:$courseid";
828: &devalidate_cache_new('getsection',$hashid);
829: }
830:
831: sub getsection {
832: my ($udom,$unam,$courseid)=@_;
833: my $cachetime=1800;
834: $courseid=~s/\_/\//g;
835: $courseid=~s/^(\w)/\/$1/;
836:
837: my $hashid="$udom:$unam:$courseid";
838: my ($result,$cached)=&is_cached_new('getsection',$hashid);
839: if (defined($cached)) { return $result; }
840:
841: my %Pending;
842: my %Expired;
843: #
844: # Each role can either have not started yet (pending), be active,
845: # or have expired.
846: #
847: # If there is an active role, we are done.
848: #
849: # If there is more than one role which has not started yet,
850: # choose the one which will start sooner
851: # If there is one role which has not started yet, return it.
852: #
853: # If there is more than one expired role, choose the one which ended last.
854: # If there is a role which has expired, return it.
855: #
856: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
857: &homeserver($unam,$udom)))) {
858: my ($key,$value)=split(/\=/,$_);
859: $key=&unescape($key);
860: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
861: my $section=$1;
862: if ($key eq $courseid.'_st') { $section=''; }
863: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
864: my $now=time;
865: if (defined($end) && $end && ($now > $end)) {
866: $Expired{$end}=$section;
867: next;
868: }
869: if (defined($start) && $start && ($now < $start)) {
870: $Pending{$start}=$section;
871: next;
872: }
873: return &do_cache_new('getsection',$hashid,$section,$cachetime);
874: }
875: #
876: # Presumedly there will be few matching roles from the above
877: # loop and the sorting time will be negligible.
878: if (scalar(keys(%Pending))) {
879: my ($time) = sort {$a <=> $b} keys(%Pending);
880: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
881: }
882: if (scalar(keys(%Expired))) {
883: my @sorted = sort {$a <=> $b} keys(%Expired);
884: my $time = pop(@sorted);
885: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
886: }
887: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
888: }
889:
890: sub save_cache {
891: &purge_remembered();
892: #&Apache::loncommon::validate_page();
893: undef(%env);
894: }
895:
896: my $to_remember=-1;
897: my %remembered;
898: my %accessed;
899: my $kicks=0;
900: my $hits=0;
901: sub devalidate_cache_new {
902: my ($name,$id,$debug) = @_;
903: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
904: $id=&escape($name.':'.$id);
905: $memcache->delete($id);
906: delete($remembered{$id});
907: delete($accessed{$id});
908: }
909:
910: sub is_cached_new {
911: my ($name,$id,$debug) = @_;
912: $id=&escape($name.':'.$id);
913: if (exists($remembered{$id})) {
914: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
915: $accessed{$id}=[&gettimeofday()];
916: $hits++;
917: return ($remembered{$id},1);
918: }
919: my $value = $memcache->get($id);
920: if (!(defined($value))) {
921: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
922: return (undef,undef);
923: }
924: if ($value eq '__undef__') {
925: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
926: $value=undef;
927: }
928: &make_room($id,$value,$debug);
929: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
930: return ($value,1);
931: }
932:
933: sub do_cache_new {
934: my ($name,$id,$value,$time,$debug) = @_;
935: $id=&escape($name.':'.$id);
936: my $setvalue=$value;
937: if (!defined($setvalue)) {
938: $setvalue='__undef__';
939: }
940: if (!defined($time) ) {
941: $time=600;
942: }
943: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
944: $memcache->set($id,$setvalue,$time);
945: # need to make a copy of $value
946: #&make_room($id,$value,$debug);
947: return $value;
948: }
949:
950: sub make_room {
951: my ($id,$value,$debug)=@_;
952: $remembered{$id}=$value;
953: if ($to_remember<0) { return; }
954: $accessed{$id}=[&gettimeofday()];
955: if (scalar(keys(%remembered)) <= $to_remember) { return; }
956: my $to_kick;
957: my $max_time=0;
958: foreach my $other (keys(%accessed)) {
959: if (&tv_interval($accessed{$other}) > $max_time) {
960: $to_kick=$other;
961: $max_time=&tv_interval($accessed{$other});
962: }
963: }
964: delete($remembered{$to_kick});
965: delete($accessed{$to_kick});
966: $kicks++;
967: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
968: return;
969: }
970:
971: sub purge_remembered {
972: #&logthis("Tossing ".scalar(keys(%remembered)));
973: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
974: undef(%remembered);
975: undef(%accessed);
976: }
977: # ------------------------------------- Read an entry from a user's environment
978:
979: sub userenvironment {
980: my ($udom,$unam,@what)=@_;
981: my %returnhash=();
982: my @answer=split(/\&/,
983: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
984: &homeserver($unam,$udom)));
985: my $i;
986: for ($i=0;$i<=$#what;$i++) {
987: $returnhash{$what[$i]}=&unescape($answer[$i]);
988: }
989: return %returnhash;
990: }
991:
992: # ---------------------------------------------------------- Get a studentphoto
993: sub studentphoto {
994: my ($udom,$unam,$ext) = @_;
995: my $home=&Apache::lonnet::homeserver($unam,$udom);
996: if (defined($env{'request.course.id'})) {
997: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
998: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
999: return(&retrievestudentphoto($udom,$unam,$ext));
1000: } else {
1001: my ($result,$perm_reqd)=
1002: &Apache::lonnet::auto_photo_permission($unam,$udom);
1003: if ($result eq 'ok') {
1004: if (!($perm_reqd eq 'yes')) {
1005: return(&retrievestudentphoto($udom,$unam,$ext));
1006: }
1007: }
1008: }
1009: }
1010: } else {
1011: my ($result,$perm_reqd) =
1012: &Apache::lonnet::auto_photo_permission($unam,$udom);
1013: if ($result eq 'ok') {
1014: if (!($perm_reqd eq 'yes')) {
1015: return(&retrievestudentphoto($udom,$unam,$ext));
1016: }
1017: }
1018: }
1019: return '/adm/lonKaputt/lonlogo_broken.gif';
1020: }
1021:
1022: sub retrievestudentphoto {
1023: my ($udom,$unam,$ext,$type) = @_;
1024: my $home=&Apache::lonnet::homeserver($unam,$udom);
1025: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1026: if ($ret eq 'ok') {
1027: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1028: if ($type eq 'thumbnail') {
1029: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1030: }
1031: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1032: return $tokenurl;
1033: } else {
1034: if ($type eq 'thumbnail') {
1035: return '/adm/lonKaputt/genericstudent_tn.gif';
1036: } else {
1037: return '/adm/lonKaputt/lonlogo_broken.gif';
1038: }
1039: }
1040: }
1041:
1042: # -------------------------------------------------------------------- New chat
1043:
1044: sub chatsend {
1045: my ($newentry,$anon,$group)=@_;
1046: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1047: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1048: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1049: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1050: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1051: &escape($newentry)).':'.$group,$chome);
1052: }
1053:
1054: # ------------------------------------------ Find current version of a resource
1055:
1056: sub getversion {
1057: my $fname=&clutter(shift);
1058: unless ($fname=~/^\/res\//) { return -1; }
1059: return ¤tversion(&filelocation('',$fname));
1060: }
1061:
1062: sub currentversion {
1063: my $fname=shift;
1064: my ($result,$cached)=&is_cached_new('resversion',$fname);
1065: if (defined($cached)) { return $result; }
1066: my $author=$fname;
1067: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1068: my ($udom,$uname)=split(/\//,$author);
1069: my $home=homeserver($uname,$udom);
1070: if ($home eq 'no_host') {
1071: return -1;
1072: }
1073: my $answer=reply("currentversion:$fname",$home);
1074: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1075: return -1;
1076: }
1077: return &do_cache_new('resversion',$fname,$answer,600);
1078: }
1079:
1080: # ----------------------------- Subscribe to a resource, return URL if possible
1081:
1082: sub subscribe {
1083: my $fname=shift;
1084: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1085: $fname=~s/[\n\r]//g;
1086: my $author=$fname;
1087: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1088: my ($udom,$uname)=split(/\//,$author);
1089: my $home=homeserver($uname,$udom);
1090: if ($home eq 'no_host') {
1091: return 'not_found';
1092: }
1093: my $answer=reply("sub:$fname",$home);
1094: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1095: $answer.=' by '.$home;
1096: }
1097: return $answer;
1098: }
1099:
1100: # -------------------------------------------------------------- Replicate file
1101:
1102: sub repcopy {
1103: my $filename=shift;
1104: $filename=~s/\/+/\//g;
1105: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1106: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1107: if ($filename=~m|^/home/httpd/html/userfiles/| or
1108: $filename=~m -^/*(uploaded|editupload)/-) {
1109: return &repcopy_userfile($filename);
1110: }
1111: $filename=~s/[\n\r]//g;
1112: my $transname="$filename.in.transfer";
1113: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1114: my $remoteurl=subscribe($filename);
1115: if ($remoteurl =~ /^con_lost by/) {
1116: &logthis("Subscribe returned $remoteurl: $filename");
1117: return 'unavailable';
1118: } elsif ($remoteurl eq 'not_found') {
1119: #&logthis("Subscribe returned not_found: $filename");
1120: return 'not_found';
1121: } elsif ($remoteurl =~ /^rejected by/) {
1122: &logthis("Subscribe returned $remoteurl: $filename");
1123: return 'forbidden';
1124: } elsif ($remoteurl eq 'directory') {
1125: return 'ok';
1126: } else {
1127: my $author=$filename;
1128: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1129: my ($udom,$uname)=split(/\//,$author);
1130: my $home=homeserver($uname,$udom);
1131: unless ($home eq $perlvar{'lonHostID'}) {
1132: my @parts=split(/\//,$filename);
1133: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1134: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1135: &logthis("Malconfiguration for replication: $filename");
1136: return 'bad_request';
1137: }
1138: my $count;
1139: for ($count=5;$count<$#parts;$count++) {
1140: $path.="/$parts[$count]";
1141: if ((-e $path)!=1) {
1142: mkdir($path,0777);
1143: }
1144: }
1145: my $ua=new LWP::UserAgent;
1146: my $request=new HTTP::Request('GET',"$remoteurl");
1147: my $response=$ua->request($request,$transname);
1148: if ($response->is_error()) {
1149: unlink($transname);
1150: my $message=$response->status_line;
1151: &logthis("<font color=\"blue\">WARNING:"
1152: ." LWP get: $message: $filename</font>");
1153: return 'unavailable';
1154: } else {
1155: if ($remoteurl!~/\.meta$/) {
1156: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1157: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1158: if ($mresponse->is_error()) {
1159: unlink($filename.'.meta');
1160: &logthis(
1161: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1162: }
1163: }
1164: rename($transname,$filename);
1165: return 'ok';
1166: }
1167: }
1168: }
1169: }
1170:
1171: # ------------------------------------------------ Get server side include body
1172: sub ssi_body {
1173: my ($filelink,%form)=@_;
1174: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1175: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1176: }
1177: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1178: &ssi($filelink,%form));
1179: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+// END LON-CAPA Internal\s*(-->)?\s||gs;
1180: $output=~s/^.*?\<body[^\>]*\>//si;
1181: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1182: return $output;
1183: }
1184:
1185: # --------------------------------------------------------- Server Side Include
1186:
1187: sub ssi {
1188:
1189: my ($fn,%form)=@_;
1190:
1191: my $ua=new LWP::UserAgent;
1192:
1193: my $request;
1194:
1195: $form{'no_update_last_known'}=1;
1196:
1197: if (%form) {
1198: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1199: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1200: } else {
1201: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1202: }
1203:
1204: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1205: my $response=$ua->request($request);
1206:
1207: return $response->content;
1208: }
1209:
1210: sub externalssi {
1211: my ($url)=@_;
1212: my $ua=new LWP::UserAgent;
1213: my $request=new HTTP::Request('GET',$url);
1214: my $response=$ua->request($request);
1215: return $response->content;
1216: }
1217:
1218: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1219:
1220: sub allowuploaded {
1221: my ($srcurl,$url)=@_;
1222: $url=&clutter(&declutter($url));
1223: my $dir=$url;
1224: $dir=~s/\/[^\/]+$//;
1225: my %httpref=();
1226: my $httpurl=&hreflocation('',$url);
1227: $httpref{'httpref.'.$httpurl}=$srcurl;
1228: &Apache::lonnet::appenv(%httpref);
1229: }
1230:
1231: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1232: # input: action, courseID, current domain, intended
1233: # path to file, source of file, instruction to parse file for objects,
1234: # ref to hash for embedded objects,
1235: # ref to hash for codebase of java objects.
1236: #
1237: # output: url to file (if action was uploaddoc),
1238: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1239: #
1240: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1241: # course.
1242: #
1243: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1244: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1245: # course's home server.
1246: #
1247: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1248: # be copied from $source (current location) to
1249: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1250: # and will then be copied to
1251: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1252: # course's home server.
1253: #
1254: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1255: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1256: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1257: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1258: # in course's home server.
1259: #
1260:
1261: sub process_coursefile {
1262: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1263: my $fetchresult;
1264: my $home=&homeserver($docuname,$docudom);
1265: if ($action eq 'propagate') {
1266: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1267: $home);
1268: } else {
1269: my $fpath = '';
1270: my $fname = $file;
1271: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1272: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1273: my $filepath = &build_filepath($fpath);
1274: if ($action eq 'copy') {
1275: if ($source eq '') {
1276: $fetchresult = 'no source file';
1277: return $fetchresult;
1278: } else {
1279: my $destination = $filepath.'/'.$fname;
1280: rename($source,$destination);
1281: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1282: $home);
1283: }
1284: } elsif ($action eq 'uploaddoc') {
1285: open(my $fh,'>'.$filepath.'/'.$fname);
1286: print $fh $env{'form.'.$source};
1287: close($fh);
1288: if ($parser eq 'parse') {
1289: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1290: unless ($parse_result eq 'ok') {
1291: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1292: }
1293: }
1294: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1295: $home);
1296: if ($fetchresult eq 'ok') {
1297: return '/uploaded/'.$fpath.'/'.$fname;
1298: } else {
1299: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1300: ' to host '.$home.': '.$fetchresult);
1301: return '/adm/notfound.html';
1302: }
1303: }
1304: }
1305: unless ( $fetchresult eq 'ok') {
1306: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1307: ' to host '.$home.': '.$fetchresult);
1308: }
1309: return $fetchresult;
1310: }
1311:
1312: sub build_filepath {
1313: my ($fpath) = @_;
1314: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1315: unless ($fpath eq '') {
1316: my @parts=split('/',$fpath);
1317: foreach my $part (@parts) {
1318: $filepath.= '/'.$part;
1319: if ((-e $filepath)!=1) {
1320: mkdir($filepath,0777);
1321: }
1322: }
1323: }
1324: return $filepath;
1325: }
1326:
1327: sub store_edited_file {
1328: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1329: my $file = $primary_url;
1330: $file =~ s#^/uploaded/$docudom/$docuname/##;
1331: my $fpath = '';
1332: my $fname = $file;
1333: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1334: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1335: my $filepath = &build_filepath($fpath);
1336: open(my $fh,'>'.$filepath.'/'.$fname);
1337: print $fh $content;
1338: close($fh);
1339: my $home=&homeserver($docuname,$docudom);
1340: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1341: $home);
1342: if ($$fetchresult eq 'ok') {
1343: return '/uploaded/'.$fpath.'/'.$fname;
1344: } else {
1345: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1346: ' to host '.$home.': '.$$fetchresult);
1347: return '/adm/notfound.html';
1348: }
1349: }
1350:
1351: sub clean_filename {
1352: my ($fname)=@_;
1353: # Replace Windows backslashes by forward slashes
1354: $fname=~s/\\/\//g;
1355: # Get rid of everything but the actual filename
1356: $fname=~s/^.*\/([^\/]+)$/$1/;
1357: # Replace spaces by underscores
1358: $fname=~s/\s+/\_/g;
1359: # Replace all other weird characters by nothing
1360: $fname=~s/[^\w\.\-]//g;
1361: # Replace all .\d. sequences with _\d. so they no longer look like version
1362: # numbers
1363: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1364: return $fname;
1365: }
1366:
1367: # --------------- Take an uploaded file and put it into the userfiles directory
1368: # input: $formname - the contents of the file are in $env{"form.$formname"}
1369: # the desired filenam is in $env{"form.$formname.filename"}
1370: # $coursedoc - if true up to the current course
1371: # if false
1372: # $subdir - directory in userfile to store the file into
1373: # $parser, $allfiles, $codebase - unknown
1374: #
1375: # output: url of file in userspace, or error: <message>
1376: # or /adm/notfound.html if failure to upload occurse
1377:
1378:
1379: sub userfileupload {
1380: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,$destudom)=@_;
1381: if (!defined($subdir)) { $subdir='unknown'; }
1382: my $fname=$env{'form.'.$formname.'.filename'};
1383: $fname=&clean_filename($fname);
1384: # See if there is anything left
1385: unless ($fname) { return 'error: no uploaded file'; }
1386: chop($env{'form.'.$formname});
1387: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1388: my $now = time;
1389: my $filepath = 'tmp/helprequests/'.$now;
1390: my @parts=split(/\//,$filepath);
1391: my $fullpath = $perlvar{'lonDaemons'};
1392: for (my $i=0;$i<@parts;$i++) {
1393: $fullpath .= '/'.$parts[$i];
1394: if ((-e $fullpath)!=1) {
1395: mkdir($fullpath,0777);
1396: }
1397: }
1398: open(my $fh,'>'.$fullpath.'/'.$fname);
1399: print $fh $env{'form.'.$formname};
1400: close($fh);
1401: return $fullpath.'/'.$fname;
1402: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
1403: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
1404: '_'.$env{'user.domain'}.'/pending';
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: }
1418:
1419: # Create the directory if not present
1420: $fname="$subdir/$fname";
1421: if ($coursedoc) {
1422: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1423: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1424: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1425: return &finishuserfileupload($docuname,$docudom,
1426: $formname,$fname,$parser,$allfiles,
1427: $codebase);
1428: } else {
1429: $fname=$env{'form.folder'}.'/'.$fname;
1430: return &process_coursefile('uploaddoc',$docuname,$docudom,
1431: $fname,$formname,$parser,
1432: $allfiles,$codebase);
1433: }
1434: } elsif (defined($destuname)) {
1435: my $docuname=$destuname;
1436: my $docudom=$destudom;
1437: return &finishuserfileupload($docuname,$docudom,$formname,
1438: $fname,$parser,$allfiles,$codebase);
1439:
1440: } else {
1441: my $docuname=$env{'user.name'};
1442: my $docudom=$env{'user.domain'};
1443: if (exists($env{'form.group'})) {
1444: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1445: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1446: }
1447: return &finishuserfileupload($docuname,$docudom,$formname,
1448: $fname,$parser,$allfiles,$codebase);
1449: }
1450: }
1451:
1452: sub finishuserfileupload {
1453: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1454: my $path=$docudom.'/'.$docuname.'/';
1455: my $filepath=$perlvar{'lonDocRoot'};
1456: my ($fnamepath,$file);
1457: $file=$fname;
1458: if ($fname=~m|/|) {
1459: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1460: $path.=$fnamepath.'/';
1461: }
1462: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1463: my $count;
1464: for ($count=4;$count<=$#parts;$count++) {
1465: $filepath.="/$parts[$count]";
1466: if ((-e $filepath)!=1) {
1467: mkdir($filepath,0777);
1468: }
1469: }
1470: # Save the file
1471: {
1472: if (!open(FH,'>'.$filepath.'/'.$file)) {
1473: &logthis('Failed to create '.$filepath.'/'.$file);
1474: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
1475: return '/adm/notfound.html';
1476: }
1477: if (!print FH ($env{'form.'.$formname})) {
1478: &logthis('Failed to write to '.$filepath.'/'.$file);
1479: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
1480: return '/adm/notfound.html';
1481: }
1482: close(FH);
1483: }
1484: if ($parser eq 'parse') {
1485: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1486: $codebase);
1487: unless ($parse_result eq 'ok') {
1488: &logthis('Failed to parse '.$filepath.$file.
1489: ' for embedded media: '.$parse_result);
1490: }
1491: }
1492: # Notify homeserver to grep it
1493: #
1494: my $docuhome=&homeserver($docuname,$docudom);
1495: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1496: if ($fetchresult eq 'ok') {
1497: #
1498: # Return the URL to it
1499: return '/uploaded/'.$path.$file;
1500: } else {
1501: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1502: ': '.$fetchresult);
1503: return '/adm/notfound.html';
1504: }
1505: }
1506:
1507: sub extract_embedded_items {
1508: my ($filepath,$file,$allfiles,$codebase,$content) = @_;
1509: my @state = ();
1510: my %javafiles = (
1511: codebase => '',
1512: code => '',
1513: archive => ''
1514: );
1515: my %mediafiles = (
1516: src => '',
1517: movie => '',
1518: );
1519: my $p;
1520: if ($content) {
1521: $p = HTML::LCParser->new($content);
1522: } else {
1523: $p = HTML::LCParser->new($filepath.'/'.$file);
1524: }
1525: while (my $t=$p->get_token()) {
1526: if ($t->[0] eq 'S') {
1527: my ($tagname, $attr) = ($t->[1],$t->[2]);
1528: push (@state, $tagname);
1529: if (lc($tagname) eq 'allow') {
1530: &add_filetype($allfiles,$attr->{'src'},'src');
1531: }
1532: if (lc($tagname) eq 'img') {
1533: &add_filetype($allfiles,$attr->{'src'},'src');
1534: }
1535: if (lc($tagname) eq 'script') {
1536: if ($attr->{'archive'} =~ /\.jar$/i) {
1537: &add_filetype($allfiles,$attr->{'archive'},'archive');
1538: } else {
1539: &add_filetype($allfiles,$attr->{'src'},'src');
1540: }
1541: }
1542: if (lc($tagname) eq 'link') {
1543: if (lc($attr->{'rel'}) eq 'stylesheet') {
1544: &add_filetype($allfiles,$attr->{'href'},'href');
1545: }
1546: }
1547: if (lc($tagname) eq 'object' ||
1548: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1549: foreach my $item (keys(%javafiles)) {
1550: $javafiles{$item} = '';
1551: }
1552: }
1553: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1554: my $name = lc($attr->{'name'});
1555: foreach my $item (keys(%javafiles)) {
1556: if ($name eq $item) {
1557: $javafiles{$item} = $attr->{'value'};
1558: last;
1559: }
1560: }
1561: foreach my $item (keys(%mediafiles)) {
1562: if ($name eq $item) {
1563: &add_filetype($allfiles, $attr->{'value'}, 'value');
1564: last;
1565: }
1566: }
1567: }
1568: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1569: foreach my $item (keys(%javafiles)) {
1570: if ($attr->{$item}) {
1571: $javafiles{$item} = $attr->{$item};
1572: last;
1573: }
1574: }
1575: foreach my $item (keys(%mediafiles)) {
1576: if ($attr->{$item}) {
1577: &add_filetype($allfiles,$attr->{$item},$item);
1578: last;
1579: }
1580: }
1581: }
1582: } elsif ($t->[0] eq 'E') {
1583: my ($tagname) = ($t->[1]);
1584: if ($javafiles{'codebase'} ne '') {
1585: $javafiles{'codebase'} .= '/';
1586: }
1587: if (lc($tagname) eq 'applet' ||
1588: lc($tagname) eq 'object' ||
1589: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1590: ) {
1591: foreach my $item (keys(%javafiles)) {
1592: if ($item ne 'codebase' && $javafiles{$item} ne '') {
1593: my $file=$javafiles{'codebase'}.$javafiles{$item};
1594: &add_filetype($allfiles,$file,$item);
1595: }
1596: }
1597: }
1598: pop @state;
1599: }
1600: }
1601: return 'ok';
1602: }
1603:
1604: sub add_filetype {
1605: my ($allfiles,$file,$type)=@_;
1606: if (exists($allfiles->{$file})) {
1607: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1608: push(@{$allfiles->{$file}}, &escape($type));
1609: }
1610: } else {
1611: @{$allfiles->{$file}} = (&escape($type));
1612: }
1613: }
1614:
1615: sub removeuploadedurl {
1616: my ($url)=@_;
1617: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1618: return &removeuserfile($uname,$udom,$fname);
1619: }
1620:
1621: sub removeuserfile {
1622: my ($docuname,$docudom,$fname)=@_;
1623: my $home=&homeserver($docuname,$docudom);
1624: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1625: }
1626:
1627: sub mkdiruserfile {
1628: my ($docuname,$docudom,$dir)=@_;
1629: my $home=&homeserver($docuname,$docudom);
1630: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1631: }
1632:
1633: sub renameuserfile {
1634: my ($docuname,$docudom,$old,$new)=@_;
1635: my $home=&homeserver($docuname,$docudom);
1636: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1637: &escape("$new"),$home);
1638: }
1639:
1640: # ------------------------------------------------------------------------- Log
1641:
1642: sub log {
1643: my ($dom,$nam,$hom,$what)=@_;
1644: return critical("log:$dom:$nam:$what",$hom);
1645: }
1646:
1647: # ------------------------------------------------------------------ Course Log
1648: #
1649: # This routine flushes several buffers of non-mission-critical nature
1650: #
1651:
1652: sub flushcourselogs {
1653: &logthis('Flushing log buffers');
1654: #
1655: # course logs
1656: # This is a log of all transactions in a course, which can be used
1657: # for data mining purposes
1658: #
1659: # It also collects the courseid database, which lists last transaction
1660: # times and course titles for all courseids
1661: #
1662: my %courseidbuffer=();
1663: foreach (keys %courselogs) {
1664: my $crsid=$_;
1665: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1666: &escape($courselogs{$crsid}),
1667: $coursehombuf{$crsid}) eq 'ok') {
1668: delete $courselogs{$crsid};
1669: } else {
1670: &logthis('Failed to flush log buffer for '.$crsid);
1671: if (length($courselogs{$crsid})>40000) {
1672: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1673: " exceeded maximum size, deleting.</font>");
1674: delete $courselogs{$crsid};
1675: }
1676: }
1677: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1678: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1679: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1680: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1681: } else {
1682: $courseidbuffer{$coursehombuf{$crsid}}=
1683: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1684: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid}).':'.&escape($coursetypebuf{$crsid});
1685: }
1686: }
1687: #
1688: # Write course id database (reverse lookup) to homeserver of courses
1689: # Is used in pickcourse
1690: #
1691: foreach (keys %courseidbuffer) {
1692: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1693: }
1694: #
1695: # File accesses
1696: # Writes to the dynamic metadata of resources to get hit counts, etc.
1697: #
1698: foreach my $entry (keys(%accesshash)) {
1699: if ($entry =~ /___count$/) {
1700: my ($dom,$name);
1701: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1702: if (! defined($dom) || $dom eq '' ||
1703: ! defined($name) || $name eq '') {
1704: my $cid = $env{'request.course.id'};
1705: $dom = $env{'request.'.$cid.'.domain'};
1706: $name = $env{'request.'.$cid.'.num'};
1707: }
1708: my $value = $accesshash{$entry};
1709: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1710: my %temphash=($url => $value);
1711: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1712: if ($result eq 'ok') {
1713: delete $accesshash{$entry};
1714: } elsif ($result eq 'unknown_cmd') {
1715: # Target server has old code running on it.
1716: my %temphash=($entry => $value);
1717: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1718: delete $accesshash{$entry};
1719: }
1720: }
1721: } else {
1722: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1723: my %temphash=($entry => $accesshash{$entry});
1724: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1725: delete $accesshash{$entry};
1726: }
1727: }
1728: }
1729: #
1730: # Roles
1731: # Reverse lookup of user roles for course faculty/staff and co-authorship
1732: #
1733: foreach (keys %userrolehash) {
1734: my $entry=$_;
1735: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1736: split(/\:/,$entry);
1737: if (&Apache::lonnet::put('nohist_userroles',
1738: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1739: $rudom,$runame) eq 'ok') {
1740: delete $userrolehash{$entry};
1741: }
1742: }
1743: #
1744: # Reverse lookup of domain roles (dc, ad, li, sc, au)
1745: #
1746: my %domrolebuffer = ();
1747: foreach my $entry (keys %domainrolehash) {
1748: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split/:/,$entry;
1749: if ($domrolebuffer{$rudom}) {
1750: $domrolebuffer{$rudom}.='&'.&escape($entry).
1751: '='.&escape($domainrolehash{$entry});
1752: } else {
1753: $domrolebuffer{$rudom}.=&escape($entry).
1754: '='.&escape($domainrolehash{$entry});
1755: }
1756: delete $domainrolehash{$entry};
1757: }
1758: foreach my $dom (keys(%domrolebuffer)) {
1759: foreach my $tryserver (keys %libserv) {
1760: if ($hostdom{$tryserver} eq $dom) {
1761: unless (&reply('domroleput:'.$dom.':'.
1762: $domrolebuffer{$dom},$tryserver) eq 'ok') {
1763: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
1764: }
1765: }
1766: }
1767: }
1768: $dumpcount++;
1769: }
1770:
1771: sub courselog {
1772: my $what=shift;
1773: $what=time.':'.$what;
1774: unless ($env{'request.course.id'}) { return ''; }
1775: $coursedombuf{$env{'request.course.id'}}=
1776: $env{'course.'.$env{'request.course.id'}.'.domain'};
1777: $coursenumbuf{$env{'request.course.id'}}=
1778: $env{'course.'.$env{'request.course.id'}.'.num'};
1779: $coursehombuf{$env{'request.course.id'}}=
1780: $env{'course.'.$env{'request.course.id'}.'.home'};
1781: $coursedescrbuf{$env{'request.course.id'}}=
1782: $env{'course.'.$env{'request.course.id'}.'.description'};
1783: $courseinstcodebuf{$env{'request.course.id'}}=
1784: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1785: $courseownerbuf{$env{'request.course.id'}}=
1786: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1787: $coursetypebuf{$env{'request.course.id'}}=
1788: $env{'course.'.$env{'request.course.id'}.'.type'};
1789: if (defined $courselogs{$env{'request.course.id'}}) {
1790: $courselogs{$env{'request.course.id'}}.='&'.$what;
1791: } else {
1792: $courselogs{$env{'request.course.id'}}.=$what;
1793: }
1794: if (length($courselogs{$env{'request.course.id'}})>4048) {
1795: &flushcourselogs();
1796: }
1797: }
1798:
1799: sub courseacclog {
1800: my $fnsymb=shift;
1801: unless ($env{'request.course.id'}) { return ''; }
1802: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1803: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1804: $what.=':POST';
1805: # FIXME: Probably ought to escape things....
1806: foreach (keys %env) {
1807: if ($_=~/^form\.(.*)/) {
1808: $what.=':'.$1.'='.$env{$_};
1809: }
1810: }
1811: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1812: # FIXME: We should not be depending on a form parameter that someone
1813: # editing lonsearchcat.pm might change in the future.
1814: if ($env{'form.phase'} eq 'course_search') {
1815: $what.= ':POST';
1816: # FIXME: Probably ought to escape things....
1817: foreach my $element ('courseexp','crsfulltext','crsrelated',
1818: 'crsdiscuss') {
1819: $what.=':'.$element.'='.$env{'form.'.$element};
1820: }
1821: }
1822: }
1823: &courselog($what);
1824: }
1825:
1826: sub countacc {
1827: my $url=&declutter(shift);
1828: return if (! defined($url) || $url eq '');
1829: unless ($env{'request.course.id'}) { return ''; }
1830: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1831: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1832: $accesshash{$key}++;
1833: }
1834:
1835: sub linklog {
1836: my ($from,$to)=@_;
1837: $from=&declutter($from);
1838: $to=&declutter($to);
1839: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1840: $accesshash{$to.'___'.$from.'___goto'}=1;
1841: }
1842:
1843: sub userrolelog {
1844: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1845: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1846: ($trole=~/^in/) || ($trole=~/^cc/) ||
1847: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1848: ($trole=~/^ta/)) {
1849: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1850: $userrolehash
1851: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1852: =$tend.':'.$tstart;
1853: }
1854: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
1855: ($trole=~/^li/) || ($trole=~/^li/) ||
1856: ($trole=~/^au/) || ($trole=~/^dg/) ||
1857: ($trole=~/^sc/)) {
1858: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1859: $domainrolehash
1860: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1861: = $tend.':'.$tstart;
1862: }
1863: }
1864:
1865: sub get_course_adv_roles {
1866: my $cid=shift;
1867: $cid=$env{'request.course.id'} unless (defined($cid));
1868: my %coursehash=&coursedescription($cid);
1869: my %nothide=();
1870: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1871: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1872: }
1873: my %returnhash=();
1874: my %dumphash=
1875: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1876: my $now=time;
1877: foreach (keys %dumphash) {
1878: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1879: if (($tstart) && ($tstart<0)) { next; }
1880: if (($tend) && ($tend<$now)) { next; }
1881: if (($tstart) && ($now<$tstart)) { next; }
1882: my ($role,$username,$domain,$section)=split(/\:/,$_);
1883: if ($username eq '' || $domain eq '') { next; }
1884: if ((&privileged($username,$domain)) &&
1885: (!$nothide{$username.':'.$domain})) { next; }
1886: if ($role eq 'cr') { next; }
1887: my $key=&plaintext($role);
1888: if ($role =~ /^cr/) {
1889: $key=(split('/',$role))[3];
1890: }
1891: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1892: if ($returnhash{$key}) {
1893: $returnhash{$key}.=','.$username.':'.$domain;
1894: } else {
1895: $returnhash{$key}=$username.':'.$domain;
1896: }
1897: }
1898: return %returnhash;
1899: }
1900:
1901: sub get_my_roles {
1902: my ($uname,$udom)=@_;
1903: unless (defined($uname)) { $uname=$env{'user.name'}; }
1904: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1905: my %dumphash=
1906: &dump('nohist_userroles',$udom,$uname);
1907: my %returnhash=();
1908: my $now=time;
1909: foreach (keys %dumphash) {
1910: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1911: if (($tstart) && ($tstart<0)) { next; }
1912: if (($tend) && ($tend<$now)) { next; }
1913: if (($tstart) && ($now<$tstart)) { next; }
1914: my ($role,$username,$domain,$section)=split(/\:/,$_);
1915: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1916: }
1917: return %returnhash;
1918: }
1919:
1920: # ----------------------------------------------------- Frontpage Announcements
1921: #
1922: #
1923:
1924: sub postannounce {
1925: my ($server,$text)=@_;
1926: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1927: unless ($text=~/\w/) { $text=''; }
1928: return &reply('setannounce:'.&escape($text),$server);
1929: }
1930:
1931: sub getannounce {
1932:
1933: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1934: my $announcement='';
1935: while (<$fh>) { $announcement .=$_; }
1936: close($fh);
1937: if ($announcement=~/\w/) {
1938: return
1939: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1940: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1941: } else {
1942: return '';
1943: }
1944: } else {
1945: return '';
1946: }
1947: }
1948:
1949: # ---------------------------------------------------------- Course ID routines
1950: # Deal with domain's nohist_courseid.db files
1951: #
1952:
1953: sub courseidput {
1954: my ($domain,$what,$coursehome)=@_;
1955: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1956: }
1957:
1958: sub courseiddump {
1959: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref,$typefilter)=@_;
1960: my %returnhash=();
1961: unless ($domfilter) { $domfilter=''; }
1962: foreach my $tryserver (keys %libserv) {
1963: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1964: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1965: foreach (
1966: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1967: $sincefilter.':'.&escape($descfilter).':'.
1968: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter).':'.&escape($typefilter),
1969: $tryserver))) {
1970: my ($key,$value)=split(/\=/,$_);
1971: if (($key) && ($value)) {
1972: $returnhash{&unescape($key)}=$value;
1973: }
1974: }
1975: }
1976: }
1977: }
1978: return %returnhash;
1979: }
1980:
1981: # ---------------------------------------------------------- DC e-mail
1982:
1983: sub dcmailput {
1984: my ($domain,$msgid,$message,$server)=@_;
1985: my $status = &Apache::lonnet::critical(
1986: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
1987: &escape($message),$server);
1988: return $status;
1989: }
1990:
1991: sub dcmaildump {
1992: my ($dom,$startdate,$enddate,$senders) = @_;
1993: my %returnhash=();
1994: if (exists($domain_primary{$dom})) {
1995: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
1996: &escape($enddate).':';
1997: my @esc_senders=map { &escape($_)} @$senders;
1998: $cmd.=&escape(join('&',@esc_senders));
1999: foreach (split(/\&/,&reply($cmd,$domain_primary{$dom}))) {
2000: my ($key,$value) = split(/\=/,$_);
2001: if (($key) && ($value)) {
2002: $returnhash{&unescape($key)} = &unescape($value);
2003: }
2004: }
2005: }
2006: return %returnhash;
2007: }
2008: # ---------------------------------------------------------- Domain roles
2009:
2010: sub get_domain_roles {
2011: my ($dom,$roles,$startdate,$enddate)=@_;
2012: if (undef($startdate) || $startdate eq '') {
2013: $startdate = '.';
2014: }
2015: if (undef($enddate) || $enddate eq '') {
2016: $enddate = '.';
2017: }
2018: my $rolelist = join(':',@{$roles});
2019: my %personnel = ();
2020: foreach my $tryserver (keys(%libserv)) {
2021: if ($hostdom{$tryserver} eq $dom) {
2022: %{$personnel{$tryserver}}=();
2023: foreach (
2024: split(/\&/,&reply('domrolesdump:'.$dom.':'.
2025: &escape($startdate).':'.&escape($enddate).':'.
2026: &escape($rolelist), $tryserver))) {
2027: my($key,$value) = split(/\=/,$_);
2028: if (($key) && ($value)) {
2029: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
2030: }
2031: }
2032: }
2033: }
2034: return %personnel;
2035: }
2036:
2037: # ----------------------------------------------------------- Check out an item
2038:
2039: sub get_first_access {
2040: my ($type,$argsymb)=@_;
2041: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2042: if ($argsymb) { $symb=$argsymb; }
2043: my ($map,$id,$res)=&decode_symb($symb);
2044: if ($type eq 'map') {
2045: $res=&symbread($map);
2046: } else {
2047: $res=$symb;
2048: }
2049: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
2050: return $times{"$courseid\0$res"};
2051: }
2052:
2053: sub set_first_access {
2054: my ($type)=@_;
2055: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2056: my ($map,$id,$res)=&decode_symb($symb);
2057: if ($type eq 'map') {
2058: $res=&symbread($map);
2059: } else {
2060: $res=$symb;
2061: }
2062: my $firstaccess=&get_first_access($type,$symb);
2063: if (!$firstaccess) {
2064: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
2065: }
2066: return 'already_set';
2067: }
2068:
2069: sub checkout {
2070: my ($symb,$tuname,$tudom,$tcrsid)=@_;
2071: my $now=time;
2072: my $lonhost=$perlvar{'lonHostID'};
2073: my $infostr=&escape(
2074: 'CHECKOUTTOKEN&'.
2075: $tuname.'&'.
2076: $tudom.'&'.
2077: $tcrsid.'&'.
2078: $symb.'&'.
2079: $now.'&'.$ENV{'REMOTE_ADDR'});
2080: my $token=&reply('tmpput:'.$infostr,$lonhost);
2081: if ($token=~/^error\:/) {
2082: &logthis("<font color=\"blue\">WARNING: ".
2083: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
2084: "</font>");
2085: return '';
2086: }
2087:
2088: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
2089: $token=~tr/a-z/A-Z/;
2090:
2091: my %infohash=('resource.0.outtoken' => $token,
2092: 'resource.0.checkouttime' => $now,
2093: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
2094:
2095: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2096: return '';
2097: } else {
2098: &logthis("<font color=\"blue\">WARNING: ".
2099: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
2100: "</font>");
2101: }
2102:
2103: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2104: &escape('Checkout '.$infostr.' - '.
2105: $token)) ne 'ok') {
2106: return '';
2107: } else {
2108: &logthis("<font color=\"blue\">WARNING: ".
2109: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
2110: "</font>");
2111: }
2112: return $token;
2113: }
2114:
2115: # ------------------------------------------------------------ Check in an item
2116:
2117: sub checkin {
2118: my $token=shift;
2119: my $now=time;
2120: my ($ta,$tb,$lonhost)=split(/\*/,$token);
2121: $lonhost=~tr/A-Z/a-z/;
2122: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
2123: $dtoken=~s/\W/\_/g;
2124: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
2125: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
2126:
2127: unless (($tuname) && ($tudom)) {
2128: &logthis('Check in '.$token.' ('.$dtoken.') failed');
2129: return '';
2130: }
2131:
2132: unless (&allowed('mgr',$tcrsid)) {
2133: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
2134: $env{'user.name'}.' - '.$env{'user.domain'});
2135: return '';
2136: }
2137:
2138: my %infohash=('resource.0.intoken' => $token,
2139: 'resource.0.checkintime' => $now,
2140: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
2141:
2142: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
2143: return '';
2144: }
2145:
2146: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
2147: &escape('Checkin - '.$token)) ne 'ok') {
2148: return '';
2149: }
2150:
2151: return ($symb,$tuname,$tudom,$tcrsid);
2152: }
2153:
2154: # --------------------------------------------- Set Expire Date for Spreadsheet
2155:
2156: sub expirespread {
2157: my ($uname,$udom,$stype,$usymb)=@_;
2158: my $cid=$env{'request.course.id'};
2159: if ($cid) {
2160: my $now=time;
2161: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
2162: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
2163: $env{'course.'.$cid.'.num'}.
2164: ':nohist_expirationdates:'.
2165: &escape($key).'='.$now,
2166: $env{'course.'.$cid.'.home'})
2167: }
2168: return 'ok';
2169: }
2170:
2171: # ----------------------------------------------------- Devalidate Spreadsheets
2172:
2173: sub devalidate {
2174: my ($symb,$uname,$udom)=@_;
2175: my $cid=$env{'request.course.id'};
2176: if ($cid) {
2177: # delete the stored spreadsheets for
2178: # - the student level sheet of this user in course's homespace
2179: # - the assessment level sheet for this resource
2180: # for this user in user's homespace
2181: # - current conditional state info
2182: my $key=$uname.':'.$udom.':';
2183: my $status=
2184: &del('nohist_calculatedsheets',
2185: [$key.'studentcalc:'],
2186: $env{'course.'.$cid.'.domain'},
2187: $env{'course.'.$cid.'.num'})
2188: .' '.
2189: &del('nohist_calculatedsheets_'.$cid,
2190: [$key.'assesscalc:'.$symb],$udom,$uname);
2191: unless ($status eq 'ok ok') {
2192: &logthis('Could not devalidate spreadsheet '.
2193: $uname.' at '.$udom.' for '.
2194: $symb.': '.$status);
2195: }
2196: &delenv('user.state.'.$cid);
2197: }
2198: }
2199:
2200: sub get_scalar {
2201: my ($string,$end) = @_;
2202: my $value;
2203: if ($$string =~ s/^([^&]*?)($end)/$2/) {
2204: $value = $1;
2205: } elsif ($$string =~ s/^([^&]*?)&//) {
2206: $value = $1;
2207: }
2208: return &unescape($value);
2209: }
2210:
2211: sub array2str {
2212: my (@array) = @_;
2213: my $result=&arrayref2str(\@array);
2214: $result=~s/^__ARRAY_REF__//;
2215: $result=~s/__END_ARRAY_REF__$//;
2216: return $result;
2217: }
2218:
2219: sub arrayref2str {
2220: my ($arrayref) = @_;
2221: my $result='__ARRAY_REF__';
2222: foreach my $elem (@$arrayref) {
2223: if(ref($elem) eq 'ARRAY') {
2224: $result.=&arrayref2str($elem).'&';
2225: } elsif(ref($elem) eq 'HASH') {
2226: $result.=&hashref2str($elem).'&';
2227: } elsif(ref($elem)) {
2228: #print("Got a ref of ".(ref($elem))." skipping.");
2229: } else {
2230: $result.=&escape($elem).'&';
2231: }
2232: }
2233: $result=~s/\&$//;
2234: $result .= '__END_ARRAY_REF__';
2235: return $result;
2236: }
2237:
2238: sub hash2str {
2239: my (%hash) = @_;
2240: my $result=&hashref2str(\%hash);
2241: $result=~s/^__HASH_REF__//;
2242: $result=~s/__END_HASH_REF__$//;
2243: return $result;
2244: }
2245:
2246: sub hashref2str {
2247: my ($hashref)=@_;
2248: my $result='__HASH_REF__';
2249: foreach (sort(keys(%$hashref))) {
2250: if (ref($_) eq 'ARRAY') {
2251: $result.=&arrayref2str($_).'=';
2252: } elsif (ref($_) eq 'HASH') {
2253: $result.=&hashref2str($_).'=';
2254: } elsif (ref($_)) {
2255: $result.='=';
2256: #print("Got a ref of ".(ref($_))." skipping.");
2257: } else {
2258: if ($_) {$result.=&escape($_).'=';} else { last; }
2259: }
2260:
2261: if(ref($hashref->{$_}) eq 'ARRAY') {
2262: $result.=&arrayref2str($hashref->{$_}).'&';
2263: } elsif(ref($hashref->{$_}) eq 'HASH') {
2264: $result.=&hashref2str($hashref->{$_}).'&';
2265: } elsif(ref($hashref->{$_})) {
2266: $result.='&';
2267: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
2268: } else {
2269: $result.=&escape($hashref->{$_}).'&';
2270: }
2271: }
2272: $result=~s/\&$//;
2273: $result .= '__END_HASH_REF__';
2274: return $result;
2275: }
2276:
2277: sub str2hash {
2278: my ($string)=@_;
2279: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2280: return %$hash;
2281: }
2282:
2283: sub str2hashref {
2284: my ($string) = @_;
2285:
2286: my %hash;
2287:
2288: if($string !~ /^__HASH_REF__/) {
2289: if (! ($string eq '' || !defined($string))) {
2290: $hash{'error'}='Not hash reference';
2291: }
2292: return (\%hash, $string);
2293: }
2294:
2295: $string =~ s/^__HASH_REF__//;
2296:
2297: while($string !~ /^__END_HASH_REF__/) {
2298: #key
2299: my $key='';
2300: if($string =~ /^__HASH_REF__/) {
2301: ($key, $string)=&str2hashref($string);
2302: if(defined($key->{'error'})) {
2303: $hash{'error'}='Bad data';
2304: return (\%hash, $string);
2305: }
2306: } elsif($string =~ /^__ARRAY_REF__/) {
2307: ($key, $string)=&str2arrayref($string);
2308: if($key->[0] eq 'Array reference error') {
2309: $hash{'error'}='Bad data';
2310: return (\%hash, $string);
2311: }
2312: } else {
2313: $string =~ s/^(.*?)=//;
2314: $key=&unescape($1);
2315: }
2316: $string =~ s/^=//;
2317:
2318: #value
2319: my $value='';
2320: if($string =~ /^__HASH_REF__/) {
2321: ($value, $string)=&str2hashref($string);
2322: if(defined($value->{'error'})) {
2323: $hash{'error'}='Bad data';
2324: return (\%hash, $string);
2325: }
2326: } elsif($string =~ /^__ARRAY_REF__/) {
2327: ($value, $string)=&str2arrayref($string);
2328: if($value->[0] eq 'Array reference error') {
2329: $hash{'error'}='Bad data';
2330: return (\%hash, $string);
2331: }
2332: } else {
2333: $value=&get_scalar(\$string,'__END_HASH_REF__');
2334: }
2335: $string =~ s/^&//;
2336:
2337: $hash{$key}=$value;
2338: }
2339:
2340: $string =~ s/^__END_HASH_REF__//;
2341:
2342: return (\%hash, $string);
2343: }
2344:
2345: sub str2array {
2346: my ($string)=@_;
2347: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2348: return @$array;
2349: }
2350:
2351: sub str2arrayref {
2352: my ($string) = @_;
2353: my @array;
2354:
2355: if($string !~ /^__ARRAY_REF__/) {
2356: if (! ($string eq '' || !defined($string))) {
2357: $array[0]='Array reference error';
2358: }
2359: return (\@array, $string);
2360: }
2361:
2362: $string =~ s/^__ARRAY_REF__//;
2363:
2364: while($string !~ /^__END_ARRAY_REF__/) {
2365: my $value='';
2366: if($string =~ /^__HASH_REF__/) {
2367: ($value, $string)=&str2hashref($string);
2368: if(defined($value->{'error'})) {
2369: $array[0] ='Array reference error';
2370: return (\@array, $string);
2371: }
2372: } elsif($string =~ /^__ARRAY_REF__/) {
2373: ($value, $string)=&str2arrayref($string);
2374: if($value->[0] eq 'Array reference error') {
2375: $array[0] ='Array reference error';
2376: return (\@array, $string);
2377: }
2378: } else {
2379: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2380: }
2381: $string =~ s/^&//;
2382:
2383: push(@array, $value);
2384: }
2385:
2386: $string =~ s/^__END_ARRAY_REF__//;
2387:
2388: return (\@array, $string);
2389: }
2390:
2391: # -------------------------------------------------------------------Temp Store
2392:
2393: sub tmpreset {
2394: my ($symb,$namespace,$domain,$stuname) = @_;
2395: if (!$symb) {
2396: $symb=&symbread();
2397: if (!$symb) { $symb= $env{'request.url'}; }
2398: }
2399: $symb=escape($symb);
2400:
2401: if (!$namespace) { $namespace=$env{'request.state'}; }
2402: $namespace=~s/\//\_/g;
2403: $namespace=~s/\W//g;
2404:
2405: if (!$domain) { $domain=$env{'user.domain'}; }
2406: if (!$stuname) { $stuname=$env{'user.name'}; }
2407: if ($domain eq 'public' && $stuname eq 'public') {
2408: $stuname=$ENV{'REMOTE_ADDR'};
2409: }
2410: my $path=$perlvar{'lonDaemons'}.'/tmp';
2411: my %hash;
2412: if (tie(%hash,'GDBM_File',
2413: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2414: &GDBM_WRCREAT(),0640)) {
2415: foreach my $key (keys %hash) {
2416: if ($key=~ /:$symb/) {
2417: delete($hash{$key});
2418: }
2419: }
2420: }
2421: }
2422:
2423: sub tmpstore {
2424: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2425:
2426: if (!$symb) {
2427: $symb=&symbread();
2428: if (!$symb) { $symb= $env{'request.url'}; }
2429: }
2430: $symb=escape($symb);
2431:
2432: if (!$namespace) {
2433: # I don't think we would ever want to store this for a course.
2434: # it seems this will only be used if we don't have a course.
2435: #$namespace=$env{'request.course.id'};
2436: #if (!$namespace) {
2437: $namespace=$env{'request.state'};
2438: #}
2439: }
2440: $namespace=~s/\//\_/g;
2441: $namespace=~s/\W//g;
2442: if (!$domain) { $domain=$env{'user.domain'}; }
2443: if (!$stuname) { $stuname=$env{'user.name'}; }
2444: if ($domain eq 'public' && $stuname eq 'public') {
2445: $stuname=$ENV{'REMOTE_ADDR'};
2446: }
2447: my $now=time;
2448: my %hash;
2449: my $path=$perlvar{'lonDaemons'}.'/tmp';
2450: if (tie(%hash,'GDBM_File',
2451: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2452: &GDBM_WRCREAT(),0640)) {
2453: $hash{"version:$symb"}++;
2454: my $version=$hash{"version:$symb"};
2455: my $allkeys='';
2456: foreach my $key (keys(%$storehash)) {
2457: $allkeys.=$key.':';
2458: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2459: }
2460: $hash{"$version:$symb:timestamp"}=$now;
2461: $allkeys.='timestamp';
2462: $hash{"$version:keys:$symb"}=$allkeys;
2463: if (untie(%hash)) {
2464: return 'ok';
2465: } else {
2466: return "error:$!";
2467: }
2468: } else {
2469: return "error:$!";
2470: }
2471: }
2472:
2473: # -----------------------------------------------------------------Temp Restore
2474:
2475: sub tmprestore {
2476: my ($symb,$namespace,$domain,$stuname) = @_;
2477:
2478: if (!$symb) {
2479: $symb=&symbread();
2480: if (!$symb) { $symb= $env{'request.url'}; }
2481: }
2482: $symb=escape($symb);
2483:
2484: if (!$namespace) { $namespace=$env{'request.state'}; }
2485:
2486: if (!$domain) { $domain=$env{'user.domain'}; }
2487: if (!$stuname) { $stuname=$env{'user.name'}; }
2488: if ($domain eq 'public' && $stuname eq 'public') {
2489: $stuname=$ENV{'REMOTE_ADDR'};
2490: }
2491: my %returnhash;
2492: $namespace=~s/\//\_/g;
2493: $namespace=~s/\W//g;
2494: my %hash;
2495: my $path=$perlvar{'lonDaemons'}.'/tmp';
2496: if (tie(%hash,'GDBM_File',
2497: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2498: &GDBM_READER(),0640)) {
2499: my $version=$hash{"version:$symb"};
2500: $returnhash{'version'}=$version;
2501: my $scope;
2502: for ($scope=1;$scope<=$version;$scope++) {
2503: my $vkeys=$hash{"$scope:keys:$symb"};
2504: my @keys=split(/:/,$vkeys);
2505: my $key;
2506: $returnhash{"$scope:keys"}=$vkeys;
2507: foreach $key (@keys) {
2508: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2509: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2510: }
2511: }
2512: if (!(untie(%hash))) {
2513: return "error:$!";
2514: }
2515: } else {
2516: return "error:$!";
2517: }
2518: return %returnhash;
2519: }
2520:
2521: # ----------------------------------------------------------------------- Store
2522:
2523: sub store {
2524: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2525: my $home='';
2526:
2527: if ($stuname) { $home=&homeserver($stuname,$domain); }
2528:
2529: $symb=&symbclean($symb);
2530: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2531:
2532: if (!$domain) { $domain=$env{'user.domain'}; }
2533: if (!$stuname) { $stuname=$env{'user.name'}; }
2534:
2535: &devalidate($symb,$stuname,$domain);
2536:
2537: $symb=escape($symb);
2538: if (!$namespace) {
2539: unless ($namespace=$env{'request.course.id'}) {
2540: return '';
2541: }
2542: }
2543: if (!$home) { $home=$env{'user.home'}; }
2544:
2545: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2546: $$storehash{'host'}=$perlvar{'lonHostID'};
2547:
2548: my $namevalue='';
2549: foreach (keys %$storehash) {
2550: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2551: }
2552: $namevalue=~s/\&$//;
2553: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2554: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2555: }
2556:
2557: # -------------------------------------------------------------- Critical Store
2558:
2559: sub cstore {
2560: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2561: my $home='';
2562:
2563: if ($stuname) { $home=&homeserver($stuname,$domain); }
2564:
2565: $symb=&symbclean($symb);
2566: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2567:
2568: if (!$domain) { $domain=$env{'user.domain'}; }
2569: if (!$stuname) { $stuname=$env{'user.name'}; }
2570:
2571: &devalidate($symb,$stuname,$domain);
2572:
2573: $symb=escape($symb);
2574: if (!$namespace) {
2575: unless ($namespace=$env{'request.course.id'}) {
2576: return '';
2577: }
2578: }
2579: if (!$home) { $home=$env{'user.home'}; }
2580:
2581: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2582: $$storehash{'host'}=$perlvar{'lonHostID'};
2583:
2584: my $namevalue='';
2585: foreach (keys %$storehash) {
2586: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2587: }
2588: $namevalue=~s/\&$//;
2589: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2590: return critical
2591: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2592: }
2593:
2594: # --------------------------------------------------------------------- Restore
2595:
2596: sub restore {
2597: my ($symb,$namespace,$domain,$stuname) = @_;
2598: my $home='';
2599:
2600: if ($stuname) { $home=&homeserver($stuname,$domain); }
2601:
2602: if (!$symb) {
2603: unless ($symb=escape(&symbread())) { return ''; }
2604: } else {
2605: $symb=&escape(&symbclean($symb));
2606: }
2607: if (!$namespace) {
2608: unless ($namespace=$env{'request.course.id'}) {
2609: return '';
2610: }
2611: }
2612: if (!$domain) { $domain=$env{'user.domain'}; }
2613: if (!$stuname) { $stuname=$env{'user.name'}; }
2614: if (!$home) { $home=$env{'user.home'}; }
2615: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2616:
2617: my %returnhash=();
2618: foreach (split(/\&/,$answer)) {
2619: my ($name,$value)=split(/\=/,$_);
2620: $returnhash{&unescape($name)}=&thaw_unescape($value);
2621: }
2622: my $version;
2623: for ($version=1;$version<=$returnhash{'version'};$version++) {
2624: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2625: $returnhash{$_}=$returnhash{$version.':'.$_};
2626: }
2627: }
2628: return %returnhash;
2629: }
2630:
2631: # ---------------------------------------------------------- Course Description
2632:
2633: sub coursedescription {
2634: my ($courseid,$args)=@_;
2635: $courseid=~s/^\///;
2636: $courseid=~s/\_/\//g;
2637: my ($cdomain,$cnum)=split(/\//,$courseid);
2638: my $chome=&homeserver($cnum,$cdomain);
2639: my $normalid=$cdomain.'_'.$cnum;
2640: # need to always cache even if we get errors otherwise we keep
2641: # trying and trying and trying to get the course description.
2642: my %envhash=();
2643: my %returnhash=();
2644:
2645: my $expiretime=600;
2646: if ($env{'request.course.id'} eq $normalid) {
2647: $expiretime=120;
2648: }
2649:
2650: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
2651: if (!$args->{'freshen_cache'}
2652: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
2653: foreach my $key (keys(%env)) {
2654: next if ($key !~ /^\Q$prefix\E(.*)/);
2655: my ($setting) = $1;
2656: $returnhash{$setting} = $env{$key};
2657: }
2658: return %returnhash;
2659: }
2660:
2661: # get the data agin
2662: if (!$args->{'one_time'}) {
2663: $envhash{'course.'.$normalid.'.last_cache'}=time;
2664: }
2665: if ($chome ne 'no_host') {
2666: %returnhash=&dump('environment',$cdomain,$cnum);
2667: if (!exists($returnhash{'con_lost'})) {
2668: $returnhash{'home'}= $chome;
2669: $returnhash{'domain'} = $cdomain;
2670: $returnhash{'num'} = $cnum;
2671: if (!defined($returnhash{'type'})) {
2672: $returnhash{'type'} = 'Course';
2673: }
2674: while (my ($name,$value) = each %returnhash) {
2675: $envhash{'course.'.$normalid.'.'.$name}=$value;
2676: }
2677: $returnhash{'url'}=&clutter($returnhash{'url'});
2678: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2679: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2680: $envhash{'course.'.$normalid.'.home'}=$chome;
2681: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2682: $envhash{'course.'.$normalid.'.num'}=$cnum;
2683: }
2684: }
2685: if (!$args->{'one_time'}) {
2686: &appenv(%envhash);
2687: }
2688: return %returnhash;
2689: }
2690:
2691: # -------------------------------------------------See if a user is privileged
2692:
2693: sub privileged {
2694: my ($username,$domain)=@_;
2695: my $rolesdump=&reply("dump:$domain:$username:roles",
2696: &homeserver($username,$domain));
2697: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2698: my $now=time;
2699: if ($rolesdump ne '') {
2700: foreach (split(/&/,$rolesdump)) {
2701: if ($_!~/^rolesdef_/) {
2702: my ($area,$role)=split(/=/,$_);
2703: $area=~s/\_\w\w$//;
2704: my ($trole,$tend,$tstart)=split(/_/,$role);
2705: if (($trole eq 'dc') || ($trole eq 'su')) {
2706: my $active=1;
2707: if ($tend) {
2708: if ($tend<$now) { $active=0; }
2709: }
2710: if ($tstart) {
2711: if ($tstart>$now) { $active=0; }
2712: }
2713: if ($active) { return 1; }
2714: }
2715: }
2716: }
2717: }
2718: return 0;
2719: }
2720:
2721: # -------------------------------------------------------- Get user privileges
2722:
2723: sub rolesinit {
2724: my ($domain,$username,$authhost)=@_;
2725: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2726: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2727: my %allroles=();
2728: my %allgroups=();
2729: my $now=time;
2730: my %userroles = ('user.login.time' => $now);
2731: my $group_privs;
2732:
2733: if ($rolesdump ne '') {
2734: foreach (split(/&/,$rolesdump)) {
2735: if ($_!~/^rolesdef_/) {
2736: my ($area,$role)=split(/=/,$_);
2737: $area=~s/\_\w\w$//;
2738: my ($trole,$tend,$tstart,$group_privs);
2739: if ($role=~/^cr/) {
2740: if ($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|) {
2741: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2742: ($tend,$tstart)=split('_',$trest);
2743: } else {
2744: $trole=$role;
2745: }
2746: } elsif ($role =~ m|^gr/|) {
2747: ($trole,$tend,$tstart) = split(/_/,$role);
2748: ($trole,$group_privs) = split(/\//,$trole);
2749: $group_privs = &unescape($group_privs);
2750: } else {
2751: ($trole,$tend,$tstart)=split(/_/,$role);
2752: }
2753: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
2754: $username);
2755: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
2756: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2757: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2758: if (($area ne '') && ($trole ne '')) {
2759: my $spec=$trole.'.'.$area;
2760: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2761: if ($trole =~ /^cr\//) {
2762: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2763: } elsif ($trole eq 'gr') {
2764: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
2765: } else {
2766: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2767: }
2768: }
2769: }
2770: }
2771: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
2772: $userroles{'user.adv'} = $adv;
2773: $userroles{'user.author'} = $author;
2774: $env{'user.adv'}=$adv;
2775: }
2776: return \%userroles;
2777: }
2778:
2779: sub set_arearole {
2780: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2781: # log the associated role with the area
2782: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2783: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
2784: }
2785:
2786: sub custom_roleprivs {
2787: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2788: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2789: my $homsvr=homeserver($rauthor,$rdomain);
2790: if ($hostname{$homsvr} ne '') {
2791: my ($rdummy,$roledef)=
2792: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2793: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2794: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2795: if (defined($syspriv)) {
2796: $$allroles{'cm./'}.=':'.$syspriv;
2797: $$allroles{$spec.'./'}.=':'.$syspriv;
2798: }
2799: if ($tdomain ne '') {
2800: if (defined($dompriv)) {
2801: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2802: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2803: }
2804: if (($trest ne '') && (defined($coursepriv))) {
2805: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2806: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2807: }
2808: }
2809: }
2810: }
2811: }
2812:
2813: sub group_roleprivs {
2814: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
2815: my $access = 1;
2816: my $now = time;
2817: if (($tend!=0) && ($tend<$now)) { $access = 0; }
2818: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
2819: if ($access) {
2820: my ($course,$group) = ($area =~ m|(/\w+/\w+)/([^/]+)$|);
2821: $$allgroups{$course}{$group} .=':'.$group_privs;
2822: }
2823: }
2824:
2825: sub standard_roleprivs {
2826: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2827: if (defined($pr{$trole.':s'})) {
2828: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2829: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2830: }
2831: if ($tdomain ne '') {
2832: if (defined($pr{$trole.':d'})) {
2833: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2834: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2835: }
2836: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2837: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2838: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2839: }
2840: }
2841: }
2842:
2843: sub set_userprivs {
2844: my ($userroles,$allroles,$allgroups) = @_;
2845: my $author=0;
2846: my $adv=0;
2847: my %grouproles = ();
2848: if (keys(%{$allgroups}) > 0) {
2849: foreach my $role (keys %{$allroles}) {
2850: my ($trole,$area,$sec,$extendedarea);
2851: if ($role =~ m|^(\w+)\.(/\w+/\w+)(/?\w*)|) {
2852: $trole = $1;
2853: $area = $2;
2854: $sec = $3;
2855: $extendedarea = $area.$sec;
2856: if (exists($$allgroups{$area})) {
2857: foreach my $group (keys(%{$$allgroups{$area}})) {
2858: my $spec = $trole.'.'.$extendedarea;
2859: $grouproles{$spec.'.'.$area.'/'.$group} =
2860: $$allgroups{$area}{$group};
2861: }
2862: }
2863: }
2864: }
2865: }
2866: foreach (keys(%grouproles)) {
2867: $$allroles{$_} = $grouproles{$_};
2868: }
2869: foreach (keys %{$allroles}) {
2870: my %thesepriv=();
2871: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2872: foreach (split(/:/,$$allroles{$_})) {
2873: if ($_ ne '') {
2874: my ($privilege,$restrictions)=split(/&/,$_);
2875: if ($restrictions eq '') {
2876: $thesepriv{$privilege}='F';
2877: } elsif ($thesepriv{$privilege} ne 'F') {
2878: $thesepriv{$privilege}.=$restrictions;
2879: }
2880: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2881: }
2882: }
2883: my $thesestr='';
2884: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2885: $userroles->{'user.priv.'.$_} = $thesestr;
2886: }
2887: return ($author,$adv);
2888: }
2889:
2890: # --------------------------------------------------------------- get interface
2891:
2892: sub get {
2893: my ($namespace,$storearr,$udomain,$uname)=@_;
2894: my $items='';
2895: foreach (@$storearr) {
2896: $items.=escape($_).'&';
2897: }
2898: $items=~s/\&$//;
2899: if (!$udomain) { $udomain=$env{'user.domain'}; }
2900: if (!$uname) { $uname=$env{'user.name'}; }
2901: my $uhome=&homeserver($uname,$udomain);
2902:
2903: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2904: my @pairs=split(/\&/,$rep);
2905: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2906: return @pairs;
2907: }
2908: my %returnhash=();
2909: my $i=0;
2910: foreach (@$storearr) {
2911: $returnhash{$_}=&thaw_unescape($pairs[$i]);
2912: $i++;
2913: }
2914: return %returnhash;
2915: }
2916:
2917: # --------------------------------------------------------------- del interface
2918:
2919: sub del {
2920: my ($namespace,$storearr,$udomain,$uname)=@_;
2921: my $items='';
2922: foreach (@$storearr) {
2923: $items.=escape($_).'&';
2924: }
2925: $items=~s/\&$//;
2926: if (!$udomain) { $udomain=$env{'user.domain'}; }
2927: if (!$uname) { $uname=$env{'user.name'}; }
2928: my $uhome=&homeserver($uname,$udomain);
2929:
2930: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
2931: }
2932:
2933: # -------------------------------------------------------------- dump interface
2934:
2935: sub dump {
2936: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2937: if (!$udomain) { $udomain=$env{'user.domain'}; }
2938: if (!$uname) { $uname=$env{'user.name'}; }
2939: my $uhome=&homeserver($uname,$udomain);
2940: if ($regexp) {
2941: $regexp=&escape($regexp);
2942: } else {
2943: $regexp='.';
2944: }
2945: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
2946: my @pairs=split(/\&/,$rep);
2947: my %returnhash=();
2948: foreach my $item (@pairs) {
2949: my ($key,$value)=split(/=/,$item,2);
2950: $key = &unescape($key);
2951: next if ($key =~ /^error: 2 /);
2952: $returnhash{$key}=&thaw_unescape($value);
2953: }
2954: return %returnhash;
2955: }
2956:
2957: # --------------------------------------------------------- dumpstore interface
2958:
2959: sub dumpstore {
2960: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
2961: return &dump($namespace,$udomain,$uname,$regexp,$range);
2962: }
2963:
2964: # -------------------------------------------------------------- keys interface
2965:
2966: sub getkeys {
2967: my ($namespace,$udomain,$uname)=@_;
2968: if (!$udomain) { $udomain=$env{'user.domain'}; }
2969: if (!$uname) { $uname=$env{'user.name'}; }
2970: my $uhome=&homeserver($uname,$udomain);
2971: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2972: my @keyarray=();
2973: foreach (split(/\&/,$rep)) {
2974: push (@keyarray,&unescape($_));
2975: }
2976: return @keyarray;
2977: }
2978:
2979: # --------------------------------------------------------------- currentdump
2980: sub currentdump {
2981: my ($courseid,$sdom,$sname)=@_;
2982: $courseid = $env{'request.course.id'} if (! defined($courseid));
2983: $sdom = $env{'user.domain'} if (! defined($sdom));
2984: $sname = $env{'user.name'} if (! defined($sname));
2985: my $uhome = &homeserver($sname,$sdom);
2986: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
2987: return if ($rep =~ /^(error:|no_such_host)/);
2988: #
2989: my %returnhash=();
2990: #
2991: if ($rep eq "unknown_cmd") {
2992: # an old lond will not know currentdump
2993: # Do a dump and make it look like a currentdump
2994: my @tmp = &dump($courseid,$sdom,$sname,'.');
2995: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2996: my %hash = @tmp;
2997: @tmp=();
2998: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
2999: } else {
3000: my @pairs=split(/\&/,$rep);
3001: foreach (@pairs) {
3002: my ($key,$value)=split(/=/,$_);
3003: my ($symb,$param) = split(/:/,$key);
3004: $returnhash{&unescape($symb)}->{&unescape($param)} =
3005: &thaw_unescape($value);
3006: }
3007: }
3008: return %returnhash;
3009: }
3010:
3011: sub convert_dump_to_currentdump{
3012: my %hash = %{shift()};
3013: my %returnhash;
3014: # Code ripped from lond, essentially. The only difference
3015: # here is the unescaping done by lonnet::dump(). Conceivably
3016: # we might run in to problems with parameter names =~ /^v\./
3017: while (my ($key,$value) = each(%hash)) {
3018: my ($v,$symb,$param) = split(/:/,$key);
3019: next if ($v eq 'version' || $symb eq 'keys');
3020: next if (exists($returnhash{$symb}) &&
3021: exists($returnhash{$symb}->{$param}) &&
3022: $returnhash{$symb}->{'v.'.$param} > $v);
3023: $returnhash{$symb}->{$param}=$value;
3024: $returnhash{$symb}->{'v.'.$param}=$v;
3025: }
3026: #
3027: # Remove all of the keys in the hashes which keep track of
3028: # the version of the parameter.
3029: while (my ($symb,$param_hash) = each(%returnhash)) {
3030: # use a foreach because we are going to delete from the hash.
3031: foreach my $key (keys(%$param_hash)) {
3032: delete($param_hash->{$key}) if ($key =~ /^v\./);
3033: }
3034: }
3035: return \%returnhash;
3036: }
3037:
3038: # ------------------------------------------------------ critical inc interface
3039:
3040: sub cinc {
3041: return &inc(@_,'critical');
3042: }
3043:
3044: # --------------------------------------------------------------- inc interface
3045:
3046: sub inc {
3047: my ($namespace,$store,$udomain,$uname,$critical) = @_;
3048: if (!$udomain) { $udomain=$env{'user.domain'}; }
3049: if (!$uname) { $uname=$env{'user.name'}; }
3050: my $uhome=&homeserver($uname,$udomain);
3051: my $items='';
3052: if (! ref($store)) {
3053: # got a single value, so use that instead
3054: $items = &escape($store).'=&';
3055: } elsif (ref($store) eq 'SCALAR') {
3056: $items = &escape($$store).'=&';
3057: } elsif (ref($store) eq 'ARRAY') {
3058: $items = join('=&',map {&escape($_);} @{$store});
3059: } elsif (ref($store) eq 'HASH') {
3060: while (my($key,$value) = each(%{$store})) {
3061: $items.= &escape($key).'='.&escape($value).'&';
3062: }
3063: }
3064: $items=~s/\&$//;
3065: if ($critical) {
3066: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
3067: } else {
3068: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
3069: }
3070: }
3071:
3072: # --------------------------------------------------------------- put interface
3073:
3074: sub put {
3075: my ($namespace,$storehash,$udomain,$uname)=@_;
3076: if (!$udomain) { $udomain=$env{'user.domain'}; }
3077: if (!$uname) { $uname=$env{'user.name'}; }
3078: my $uhome=&homeserver($uname,$udomain);
3079: my $items='';
3080: foreach (keys %$storehash) {
3081: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3082: }
3083: $items=~s/\&$//;
3084: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3085: }
3086:
3087: # ------------------------------------------------------------ newput interface
3088:
3089: sub newput {
3090: my ($namespace,$storehash,$udomain,$uname)=@_;
3091: if (!$udomain) { $udomain=$env{'user.domain'}; }
3092: if (!$uname) { $uname=$env{'user.name'}; }
3093: my $uhome=&homeserver($uname,$udomain);
3094: my $items='';
3095: foreach my $key (keys(%$storehash)) {
3096: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
3097: }
3098: $items=~s/\&$//;
3099: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
3100: }
3101:
3102: # --------------------------------------------------------- putstore interface
3103:
3104: sub putstore {
3105: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3106: if (!$udomain) { $udomain=$env{'user.domain'}; }
3107: if (!$uname) { $uname=$env{'user.name'}; }
3108: my $uhome=&homeserver($uname,$udomain);
3109: my $items='';
3110: foreach my $key (keys(%$storehash)) {
3111: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
3112: }
3113: $items=~s/\&$//;
3114: my $esc_symb=&escape($symb);
3115: my $esc_v=&escape($version);
3116: my $reply =
3117: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
3118: $uhome);
3119: if ($reply eq 'unknown_cmd') {
3120: # gfall back to way things use to be done
3121: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
3122: $uname);
3123: }
3124: return $reply;
3125: }
3126:
3127: sub old_putstore {
3128: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
3129: if (!$udomain) { $udomain=$env{'user.domain'}; }
3130: if (!$uname) { $uname=$env{'user.name'}; }
3131: my $uhome=&homeserver($uname,$udomain);
3132: my %newstorehash;
3133: foreach (keys %$storehash) {
3134: my $key = $version.':'.&escape($symb).':'.$_;
3135: $newstorehash{$key} = $storehash->{$_};
3136: }
3137: my $items='';
3138: my %allitems = ();
3139: foreach (keys %newstorehash) {
3140: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
3141: my $key = $1.':keys:'.$2;
3142: $allitems{$key} .= $3.':';
3143: }
3144: $items.=$_.'='.&freeze_escape($newstorehash{$_}).'&';
3145: }
3146: foreach (keys %allitems) {
3147: $allitems{$_} =~ s/\:$//;
3148: $items.= $_.'='.$allitems{$_}.'&';
3149: }
3150: $items=~s/\&$//;
3151: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
3152: }
3153:
3154: # ------------------------------------------------------ critical put interface
3155:
3156: sub cput {
3157: my ($namespace,$storehash,$udomain,$uname)=@_;
3158: if (!$udomain) { $udomain=$env{'user.domain'}; }
3159: if (!$uname) { $uname=$env{'user.name'}; }
3160: my $uhome=&homeserver($uname,$udomain);
3161: my $items='';
3162: foreach (keys %$storehash) {
3163: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3164: }
3165: $items=~s/\&$//;
3166: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
3167: }
3168:
3169: # -------------------------------------------------------------- eget interface
3170:
3171: sub eget {
3172: my ($namespace,$storearr,$udomain,$uname)=@_;
3173: my $items='';
3174: foreach (@$storearr) {
3175: $items.=escape($_).'&';
3176: }
3177: $items=~s/\&$//;
3178: if (!$udomain) { $udomain=$env{'user.domain'}; }
3179: if (!$uname) { $uname=$env{'user.name'}; }
3180: my $uhome=&homeserver($uname,$udomain);
3181: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
3182: my @pairs=split(/\&/,$rep);
3183: my %returnhash=();
3184: my $i=0;
3185: foreach (@$storearr) {
3186: $returnhash{$_}=&thaw_unescape($pairs[$i]);
3187: $i++;
3188: }
3189: return %returnhash;
3190: }
3191:
3192: # ------------------------------------------------------------ tmpput interface
3193: sub tmpput {
3194: my ($storehash,$server)=@_;
3195: my $items='';
3196: foreach (keys(%$storehash)) {
3197: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
3198: }
3199: $items=~s/\&$//;
3200: return &reply("tmpput:$items",$server);
3201: }
3202:
3203: # ------------------------------------------------------------ tmpget interface
3204: sub tmpget {
3205: my ($token,$server)=@_;
3206: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3207: my $rep=&reply("tmpget:$token",$server);
3208: my %returnhash;
3209: foreach my $item (split(/\&/,$rep)) {
3210: my ($key,$value)=split(/=/,$item);
3211: $returnhash{&unescape($key)}=&thaw_unescape($value);
3212: }
3213: return %returnhash;
3214: }
3215:
3216: # ------------------------------------------------------------ tmpget interface
3217: sub tmpdel {
3218: my ($token,$server)=@_;
3219: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
3220: return &reply("tmpdel:$token",$server);
3221: }
3222:
3223: # ---------------------------------------------- Custom access rule evaluation
3224:
3225: sub customaccess {
3226: my ($priv,$uri)=@_;
3227: my ($urole,$urealm)=split(/\./,$env{'request.role'});
3228: $urealm=~s/^\W//;
3229: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
3230: my $access=0;
3231: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
3232: my ($effect,$realm,$role)=split(/\:/,$_);
3233: if ($role) {
3234: if ($role ne $urole) { next; }
3235: }
3236: foreach (split(/\s*\,\s*/,$realm)) {
3237: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
3238: if ($tdom) {
3239: if ($tdom ne $udom) { next; }
3240: }
3241: if ($tcrs) {
3242: if ($tcrs ne $ucrs) { next; }
3243: }
3244: if ($tsec) {
3245: if ($tsec ne $usec) { next; }
3246: }
3247: $access=($effect eq 'allow');
3248: last;
3249: }
3250: if ($realm eq '' && $role eq '') {
3251: $access=($effect eq 'allow');
3252: }
3253: }
3254: return $access;
3255: }
3256:
3257: # ------------------------------------------------- Check for a user privilege
3258:
3259: sub allowed {
3260: my ($priv,$uri,$symb)=@_;
3261: my $ver_orguri=$uri;
3262: $uri=&deversion($uri);
3263: my $orguri=$uri;
3264: $uri=&declutter($uri);
3265:
3266: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
3267: # Free bre access to adm and meta resources
3268: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
3269: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
3270: return 'F';
3271: }
3272:
3273: # Free bre access to user's own portfolio contents
3274: my ($space,$domain,$name,@dir)=split('/',$uri);
3275: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
3276: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
3277: return 'F';
3278: }
3279:
3280: # bre access to group if user has rgf priv for this group and course.
3281: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
3282: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
3283: if (exists($env{'request.course.id'})) {
3284: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3285: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3286: if (($domain eq $cdom) && ($name eq $cnum)) {
3287: my $courseprivid=$env{'request.course.id'};
3288: $courseprivid=~s/\_/\//;
3289: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
3290: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
3291: return $1;
3292: }
3293: }
3294: }
3295: }
3296:
3297: # Free bre to public access
3298:
3299: if ($priv eq 'bre') {
3300: my $copyright=&metadata($uri,'copyright');
3301: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
3302: return 'F';
3303: }
3304: if ($copyright eq 'priv') {
3305: $uri=~/([^\/]+)\/([^\/]+)\//;
3306: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
3307: return '';
3308: }
3309: }
3310: if ($copyright eq 'domain') {
3311: $uri=~/([^\/]+)\/([^\/]+)\//;
3312: unless (($env{'user.domain'} eq $1) ||
3313: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
3314: return '';
3315: }
3316: }
3317: if ($env{'request.role'}=~ /li\.\//) {
3318: # Library role, so allow browsing of resources in this domain.
3319: return 'F';
3320: }
3321: if ($copyright eq 'custom') {
3322: unless (&customaccess($priv,$uri)) { return ''; }
3323: }
3324: }
3325: # Domain coordinator is trying to create a course
3326: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
3327: # uri is the requested domain in this case.
3328: # comparison to 'request.role.domain' shows if the user has selected
3329: # a role of dc for the domain in question.
3330: return 'F' if ($uri eq $env{'request.role.domain'});
3331: }
3332:
3333: my $thisallowed='';
3334: my $statecond=0;
3335: my $courseprivid='';
3336:
3337: # Course
3338:
3339: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
3340: $thisallowed.=$1;
3341: }
3342:
3343: # Domain
3344:
3345: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
3346: =~/\Q$priv\E\&([^\:]*)/) {
3347: $thisallowed.=$1;
3348: }
3349:
3350: # Course: uri itself is a course
3351: my $courseuri=$uri;
3352: $courseuri=~s/\_(\d)/\/$1/;
3353: $courseuri=~s/^([^\/])/\/$1/;
3354:
3355: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
3356: =~/\Q$priv\E\&([^\:]*)/) {
3357: $thisallowed.=$1;
3358: }
3359:
3360: # Group: uri itself is a group
3361: my $groupuri=$uri;
3362: $groupuri=~s/^([^\/])/\/$1/;
3363: if ($env{'user.priv.'.$env{'request.role'}.'.'.$groupuri}
3364: =~/\Q$priv\E\&([^\:]*)/) {
3365: $thisallowed.=$1;
3366: }
3367:
3368: # URI is an uploaded document for this course, default permissions don't matter
3369: # not allowing 'edit' access (editupload) to uploaded course docs
3370: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
3371: $thisallowed='';
3372: my ($match)=&is_on_map($uri);
3373: if ($match) {
3374: if ($env{'user.priv.'.$env{'request.role'}.'./'}
3375: =~/\Q$priv\E\&([^\:]*)/) {
3376: $thisallowed.=$1;
3377: }
3378: } else {
3379: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
3380: if ($refuri) {
3381: if ($refuri =~ m|^/adm/|) {
3382: $thisallowed='F';
3383: } else {
3384: $refuri=&declutter($refuri);
3385: my ($match) = &is_on_map($refuri);
3386: if ($match) {
3387: $thisallowed='F';
3388: }
3389: }
3390: }
3391: }
3392: }
3393:
3394: # Full access at system, domain or course-wide level? Exit.
3395:
3396: if ($thisallowed=~/F/) {
3397: return 'F';
3398: }
3399:
3400: # If this is generating or modifying users, exit with special codes
3401:
3402: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
3403: if (($priv eq 'cca') || ($priv eq 'caa')) {
3404: my ($audom,$auname)=split('/',$uri);
3405: # no author name given, so this just checks on the general right to make a co-author in this domain
3406: unless ($auname) { return $thisallowed; }
3407: # an author name is given, so we are about to actually make a co-author for a certain account
3408: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
3409: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
3410: ($audom ne $env{'request.role.domain'}))) { return ''; }
3411: }
3412: return $thisallowed;
3413: }
3414: #
3415: # Gathered so far: system, domain and course wide privileges
3416: #
3417: # Course: See if uri or referer is an individual resource that is part of
3418: # the course
3419:
3420: if ($env{'request.course.id'}) {
3421:
3422: $courseprivid=$env{'request.course.id'};
3423: if ($env{'request.course.sec'}) {
3424: $courseprivid.='/'.$env{'request.course.sec'};
3425: }
3426: $courseprivid=~s/\_/\//;
3427: my $checkreferer=1;
3428: my ($match,$cond)=&is_on_map($uri);
3429: if ($match) {
3430: $statecond=$cond;
3431: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3432: =~/\Q$priv\E\&([^\:]*)/) {
3433: $thisallowed.=$1;
3434: $checkreferer=0;
3435: }
3436: }
3437:
3438: if ($checkreferer) {
3439: my $refuri=$env{'httpref.'.$orguri};
3440: unless ($refuri) {
3441: foreach (keys %env) {
3442: if ($_=~/^httpref\..*\*/) {
3443: my $pattern=$_;
3444: $pattern=~s/^httpref\.\/res\///;
3445: $pattern=~s/\*/\[\^\/\]\+/g;
3446: $pattern=~s/\//\\\//g;
3447: if ($orguri=~/$pattern/) {
3448: $refuri=$env{$_};
3449: }
3450: }
3451: }
3452: }
3453:
3454: if ($refuri) {
3455: $refuri=&declutter($refuri);
3456: my ($match,$cond)=&is_on_map($refuri);
3457: if ($match) {
3458: my $refstatecond=$cond;
3459: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3460: =~/\Q$priv\E\&([^\:]*)/) {
3461: $thisallowed.=$1;
3462: $uri=$refuri;
3463: $statecond=$refstatecond;
3464: }
3465: }
3466: }
3467: }
3468: }
3469:
3470: #
3471: # Gathered now: all privileges that could apply, and condition number
3472: #
3473: #
3474: # Full or no access?
3475: #
3476:
3477: if ($thisallowed=~/F/) {
3478: return 'F';
3479: }
3480:
3481: unless ($thisallowed) {
3482: return '';
3483: }
3484:
3485: # Restrictions exist, deal with them
3486: #
3487: # C:according to course preferences
3488: # R:according to resource settings
3489: # L:unless locked
3490: # X:according to user session state
3491: #
3492:
3493: # Possibly locked functionality, check all courses
3494: # Locks might take effect only after 10 minutes cache expiration for other
3495: # courses, and 2 minutes for current course
3496:
3497: my $envkey;
3498: if ($thisallowed=~/L/) {
3499: foreach $envkey (keys %env) {
3500: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3501: my $courseid=$2;
3502: my $roleid=$1.'.'.$2;
3503: $courseid=~s/^\///;
3504: my $expiretime=600;
3505: if ($env{'request.role'} eq $roleid) {
3506: $expiretime=120;
3507: }
3508: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3509: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3510: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3511: &coursedescription($courseid,{'freshen_cache' => 1});
3512: }
3513: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3514: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3515: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3516: &log($env{'user.domain'},$env{'user.name'},
3517: $env{'user.home'},
3518: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3519: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3520: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3521: return '';
3522: }
3523: }
3524: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3525: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3526: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3527: &log($env{'user.domain'},$env{'user.name'},
3528: $env{'user.home'},
3529: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3530: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3531: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3532: return '';
3533: }
3534: }
3535: }
3536: }
3537: }
3538:
3539: #
3540: # Rest of the restrictions depend on selected course
3541: #
3542:
3543: unless ($env{'request.course.id'}) {
3544: return '1';
3545: }
3546:
3547: #
3548: # Now user is definitely in a course
3549: #
3550:
3551:
3552: # Course preferences
3553:
3554: if ($thisallowed=~/C/) {
3555: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3556: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3557: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3558: =~/\Q$rolecode\E/) {
3559: if ($priv ne 'pch') {
3560: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3561: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3562: $env{'request.course.id'});
3563: }
3564: return '';
3565: }
3566:
3567: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3568: =~/\Q$unamedom\E/) {
3569: if ($priv ne 'pch') {
3570: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
3571: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3572: $env{'request.course.id'});
3573: }
3574: return '';
3575: }
3576: }
3577:
3578: # Resource preferences
3579:
3580: if ($thisallowed=~/R/) {
3581: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3582: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3583: if ($priv ne 'pch') {
3584: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
3585: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3586: }
3587: return '';
3588: }
3589: }
3590:
3591: # Restricted by state or randomout?
3592:
3593: if ($thisallowed=~/X/) {
3594: if ($env{'acc.randomout'}) {
3595: if (!$symb) { $symb=&symbread($uri,1); }
3596: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3597: return '';
3598: }
3599: }
3600: if (&condval($statecond)) {
3601: return '2';
3602: } else {
3603: return '';
3604: }
3605: }
3606:
3607: return 'F';
3608: }
3609:
3610: sub split_uri_for_cond {
3611: my $uri=&deversion(&declutter(shift));
3612: my @uriparts=split(/\//,$uri);
3613: my $filename=pop(@uriparts);
3614: my $pathname=join('/',@uriparts);
3615: return ($pathname,$filename);
3616: }
3617: # --------------------------------------------------- Is a resource on the map?
3618:
3619: sub is_on_map {
3620: my ($pathname,$filename) = &split_uri_for_cond(shift);
3621: #Trying to find the conditional for the file
3622: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3623: /\&\Q$filename\E\:([\d\|]+)\&/);
3624: if ($match) {
3625: return (1,$1);
3626: } else {
3627: return (0,0);
3628: }
3629: }
3630:
3631: # --------------------------------------------------------- Get symb from alias
3632:
3633: sub get_symb_from_alias {
3634: my $symb=shift;
3635: my ($map,$resid,$url)=&decode_symb($symb);
3636: # Already is a symb
3637: if ($url) { return $symb; }
3638: # Must be an alias
3639: my $aliassymb='';
3640: my %bighash;
3641: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3642: &GDBM_READER(),0640)) {
3643: my $rid=$bighash{'mapalias_'.$symb};
3644: if ($rid) {
3645: my ($mapid,$resid)=split(/\./,$rid);
3646: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3647: $resid,$bighash{'src_'.$rid});
3648: }
3649: untie %bighash;
3650: }
3651: return $aliassymb;
3652: }
3653:
3654: # ----------------------------------------------------------------- Define Role
3655:
3656: sub definerole {
3657: if (allowed('mcr','/')) {
3658: my ($rolename,$sysrole,$domrole,$courole)=@_;
3659: foreach (split(':',$sysrole)) {
3660: my ($crole,$cqual)=split(/\&/,$_);
3661: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3662: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3663: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3664: return "refused:s:$crole&$cqual";
3665: }
3666: }
3667: }
3668: foreach (split(':',$domrole)) {
3669: my ($crole,$cqual)=split(/\&/,$_);
3670: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3671: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3672: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3673: return "refused:d:$crole&$cqual";
3674: }
3675: }
3676: }
3677: foreach (split(':',$courole)) {
3678: my ($crole,$cqual)=split(/\&/,$_);
3679: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3680: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3681: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3682: return "refused:c:$crole&$cqual";
3683: }
3684: }
3685: }
3686: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3687: "$env{'user.domain'}:$env{'user.name'}:".
3688: "rolesdef_$rolename=".
3689: escape($sysrole.'_'.$domrole.'_'.$courole);
3690: return reply($command,$env{'user.home'});
3691: } else {
3692: return 'refused';
3693: }
3694: }
3695:
3696: # ---------------- Make a metadata query against the network of library servers
3697:
3698: sub metadata_query {
3699: my ($query,$custom,$customshow,$server_array)=@_;
3700: my %rhash;
3701: my @server_list = (defined($server_array) ? @$server_array
3702: : keys(%libserv) );
3703: for my $server (@server_list) {
3704: unless ($custom or $customshow) {
3705: my $reply=&reply("querysend:".&escape($query),$server);
3706: $rhash{$server}=$reply;
3707: }
3708: else {
3709: my $reply=&reply("querysend:".&escape($query).':'.
3710: &escape($custom).':'.&escape($customshow),
3711: $server);
3712: $rhash{$server}=$reply;
3713: }
3714: }
3715: return \%rhash;
3716: }
3717:
3718: # ----------------------------------------- Send log queries and wait for reply
3719:
3720: sub log_query {
3721: my ($uname,$udom,$query,%filters)=@_;
3722: my $uhome=&homeserver($uname,$udom);
3723: if ($uhome eq 'no_host') { return 'error: no_host'; }
3724: my $uhost=$hostname{$uhome};
3725: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
3726: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3727: $uhome);
3728: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
3729: return get_query_reply($queryid);
3730: }
3731:
3732: # ------- Request retrieval of institutional classlists for course(s)
3733:
3734: sub fetch_enrollment_query {
3735: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
3736: my $homeserver;
3737: my $maxtries = 1;
3738: if ($context eq 'automated') {
3739: $homeserver = $perlvar{'lonHostID'};
3740: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
3741: } else {
3742: $homeserver = &homeserver($cnum,$dom);
3743: }
3744: my $host=$hostname{$homeserver};
3745: my $cmd = '';
3746: foreach (keys %{$affiliatesref}) {
3747: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3748: }
3749: $cmd =~ s/%%$//;
3750: $cmd = &escape($cmd);
3751: my $query = 'fetchenrollment';
3752: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
3753: unless ($queryid=~/^\Q$host\E\_/) {
3754: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3755: return 'error: '.$queryid;
3756: }
3757: my $reply = &get_query_reply($queryid);
3758: my $tries = 1;
3759: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3760: $reply = &get_query_reply($queryid);
3761: $tries ++;
3762: }
3763: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3764: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3765: } else {
3766: my @responses = split/:/,$reply;
3767: if ($homeserver eq $perlvar{'lonHostID'}) {
3768: foreach (@responses) {
3769: my ($key,$value) = split/=/,$_;
3770: $$replyref{$key} = $value;
3771: }
3772: } else {
3773: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3774: foreach (@responses) {
3775: my ($key,$value) = split/=/,$_;
3776: $$replyref{$key} = $value;
3777: if ($value > 0) {
3778: foreach (@{$$affiliatesref{$key}}) {
3779: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3780: my $destname = $pathname.'/'.$filename;
3781: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
3782: if ($xml_classlist =~ /^error/) {
3783: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3784: } else {
3785: if ( open(FILE,">$destname") ) {
3786: print FILE &unescape($xml_classlist);
3787: close(FILE);
3788: } else {
3789: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
3790: }
3791: }
3792: }
3793: }
3794: }
3795: }
3796: return 'ok';
3797: }
3798: return 'error';
3799: }
3800:
3801: sub get_query_reply {
3802: my $queryid=shift;
3803: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
3804: my $reply='';
3805: for (1..100) {
3806: sleep 2;
3807: if (-e $replyfile.'.end') {
3808: if (open(my $fh,$replyfile)) {
3809: $reply.=<$fh>;
3810: close($fh);
3811: } else { return 'error: reply_file_error'; }
3812: return &unescape($reply);
3813: }
3814: }
3815: return 'timeout:'.$queryid;
3816: }
3817:
3818: sub courselog_query {
3819: #
3820: # possible filters:
3821: # url: url or symb
3822: # username
3823: # domain
3824: # action: view, submit, grade
3825: # start: timestamp
3826: # end: timestamp
3827: #
3828: my (%filters)=@_;
3829: unless ($env{'request.course.id'}) { return 'no_course'; }
3830: if ($filters{'url'}) {
3831: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
3832: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
3833: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
3834: }
3835: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
3836: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3837: return &log_query($cname,$cdom,'courselog',%filters);
3838: }
3839:
3840: sub userlog_query {
3841: my ($uname,$udom,%filters)=@_;
3842: return &log_query($uname,$udom,'userlog',%filters);
3843: }
3844:
3845: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
3846:
3847: sub auto_run {
3848: my ($cnum,$cdom) = @_;
3849: my $homeserver = &homeserver($cnum,$cdom);
3850: my $response = &reply('autorun:'.$cdom,$homeserver);
3851: return $response;
3852: }
3853:
3854: sub auto_get_sections {
3855: my ($cnum,$cdom,$inst_coursecode) = @_;
3856: my $homeserver = &homeserver($cnum,$cdom);
3857: my @secs = ();
3858: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
3859: unless ($response eq 'refused') {
3860: @secs = split/:/,$response;
3861: }
3862: return @secs;
3863: }
3864:
3865: sub auto_new_course {
3866: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
3867: my $homeserver = &homeserver($cnum,$cdom);
3868: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
3869: return $response;
3870: }
3871:
3872: sub auto_validate_courseID {
3873: my ($cnum,$cdom,$inst_course_id) = @_;
3874: my $homeserver = &homeserver($cnum,$cdom);
3875: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
3876: return $response;
3877: }
3878:
3879: sub auto_create_password {
3880: my ($cnum,$cdom,$authparam) = @_;
3881: my $homeserver = &homeserver($cnum,$cdom);
3882: my $create_passwd = 0;
3883: my $authchk = '';
3884: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
3885: if ($response eq 'refused') {
3886: $authchk = 'refused';
3887: } else {
3888: ($authparam,$create_passwd,$authchk) = split/:/,$response;
3889: }
3890: return ($authparam,$create_passwd,$authchk);
3891: }
3892:
3893: sub auto_photo_permission {
3894: my ($cnum,$cdom,$students) = @_;
3895: my $homeserver = &homeserver($cnum,$cdom);
3896: my ($outcome,$perm_reqd,$conditions) =
3897: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
3898: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3899: return (undef,undef);
3900: }
3901: return ($outcome,$perm_reqd,$conditions);
3902: }
3903:
3904: sub auto_checkphotos {
3905: my ($uname,$udom,$pid) = @_;
3906: my $homeserver = &homeserver($uname,$udom);
3907: my ($result,$resulttype);
3908: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
3909: &escape($uname).':'.&escape($pid),
3910: $homeserver));
3911: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3912: return (undef,undef);
3913: }
3914: if ($outcome) {
3915: ($result,$resulttype) = split(/:/,$outcome);
3916: }
3917: return ($result,$resulttype);
3918: }
3919:
3920: sub auto_photochoice {
3921: my ($cnum,$cdom) = @_;
3922: my $homeserver = &homeserver($cnum,$cdom);
3923: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
3924: &escape($cdom),
3925: $homeserver)));
3926: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
3927: return (undef,undef);
3928: }
3929: return ($update,$comment);
3930: }
3931:
3932: sub auto_photoupdate {
3933: my ($affiliatesref,$dom,$cnum,$photo) = @_;
3934: my $homeserver = &homeserver($cnum,$dom);
3935: my $host=$hostname{$homeserver};
3936: my $cmd = '';
3937: my $maxtries = 1;
3938: foreach (keys %{$affiliatesref}) {
3939: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3940: }
3941: $cmd =~ s/%%$//;
3942: $cmd = &escape($cmd);
3943: my $query = 'institutionalphotos';
3944: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
3945: unless ($queryid=~/^\Q$host\E\_/) {
3946: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
3947: return 'error: '.$queryid;
3948: }
3949: my $reply = &get_query_reply($queryid);
3950: my $tries = 1;
3951: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3952: $reply = &get_query_reply($queryid);
3953: $tries ++;
3954: }
3955: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3956: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3957: } else {
3958: my @responses = split(/:/,$reply);
3959: my $outcome = shift(@responses);
3960: foreach my $item (@responses) {
3961: my ($key,$value) = split(/=/,$item);
3962: $$photo{$key} = $value;
3963: }
3964: return $outcome;
3965: }
3966: return 'error';
3967: }
3968:
3969: sub auto_instcode_format {
3970: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
3971: my $courses = '';
3972: my $homeserver;
3973: if ($caller eq 'global') {
3974: foreach my $tryserver (keys %libserv) {
3975: if ($hostdom{$tryserver} eq $codedom) {
3976: $homeserver = $tryserver;
3977: last;
3978: }
3979: }
3980: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
3981: $homeserver = &homeserver($env{'user.name'},$codedom);
3982: }
3983: } else {
3984: $homeserver = &homeserver($caller,$codedom);
3985: }
3986: foreach (keys %{$instcodes}) {
3987: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
3988: }
3989: chop($courses);
3990: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
3991: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
3992: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
3993: %{$codes} = &str2hash($codes_str);
3994: @{$codetitles} = &str2array($codetitles_str);
3995: %{$cat_titles} = &str2hash($cat_titles_str);
3996: %{$cat_order} = &str2hash($cat_order_str);
3997: return 'ok';
3998: }
3999: return $response;
4000: }
4001:
4002: # ------------------------------------------------------- Course Group routines
4003:
4004: sub get_coursegroups {
4005: my ($cdom,$cnum,$group) = @_;
4006: return(&dump('coursegroups',$cdom,$cnum,$group));
4007: }
4008:
4009: sub modify_coursegroup {
4010: my ($cdom,$cnum,$groupsettings) = @_;
4011: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
4012: }
4013:
4014: sub modify_group_roles {
4015: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs) = @_;
4016: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
4017: my $role = 'gr/'.&escape($userprivs);
4018: my ($uname,$udom) = split(/:/,$user);
4019: my $result = &assignrole($udom,$uname,$url,$role,$end,$start);
4020: if ($result eq 'ok') {
4021: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
4022: }
4023: return $result;
4024: }
4025:
4026: sub modify_coursegroup_membership {
4027: my ($cdom,$cnum,$membership) = @_;
4028: my $result = &put('groupmembership',$membership,$cdom,$cnum);
4029: return $result;
4030: }
4031:
4032: sub get_active_groups {
4033: my ($udom,$uname,$cdom,$cnum) = @_;
4034: my $now = time;
4035: my %groups = ();
4036: foreach my $key (keys(%env)) {
4037: if ($key =~ m-user\.role\.gr\./([^/]+)/([^/]+)/(\w+)$-) {
4038: my ($start,$end) = split(/\./,$env{$key});
4039: if (($end!=0) && ($end<$now)) { next; }
4040: if (($start!=0) && ($start>$now)) { next; }
4041: if ($1 eq $cdom && $2 eq $cnum) {
4042: $groups{$3} = $env{$key} ;
4043: }
4044: }
4045: }
4046: return %groups;
4047: }
4048:
4049: sub get_group_membership {
4050: my ($cdom,$cnum,$group) = @_;
4051: return(&dump('groupmembership',$cdom,$cnum,$group));
4052: }
4053:
4054: sub get_users_groups {
4055: my ($udom,$uname,$courseid) = @_;
4056: my @usersgroups;
4057: my $cachetime=1800;
4058: $courseid=~s/\_/\//g;
4059: $courseid=~s/^(\w)/\/$1/;
4060:
4061: my $hashid="$udom:$uname:$courseid";
4062: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
4063: if (defined($cached)) {
4064: @usersgroups = split(/:/,$grouplist);
4065: } else {
4066: $grouplist = '';
4067: my %roleshash = &dump('roles',$udom,$uname,$courseid);
4068: my ($tmp) = keys(%roleshash);
4069: if ($tmp=~/^error:/) {
4070: &logthis('Error retrieving roles: '.$tmp.' for '.$uname.':'.$udom);
4071: } else {
4072: my $access_end = $env{'course.'.$courseid.
4073: '.default_enrollment_end_date'};
4074: my $now = time;
4075: foreach my $key (keys(%roleshash)) {
4076: if ($key =~ /^\Q$courseid\E\/(\w+)\_gr$/) {
4077: my $group = $1;
4078: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
4079: my $start = $2;
4080: my $end = $1;
4081: if ($start == -1) { next; } # deleted from group
4082: if (($start!=0) && ($start>$now)) { next; }
4083: if (($end!=0) && ($end<$now)) {
4084: if ($access_end && $access_end < $now) {
4085: if ($access_end - $end < 86400) {
4086: push(@usersgroups,$group);
4087: }
4088: }
4089: next;
4090: }
4091: push(@usersgroups,$group);
4092: }
4093: }
4094: }
4095: @usersgroups = &sort_course_groups($courseid,@usersgroups);
4096: $grouplist = join(':',@usersgroups);
4097: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
4098: }
4099: }
4100: return @usersgroups;
4101: }
4102:
4103: sub devalidate_getgroups_cache {
4104: my ($udom,$uname,$cdom,$cnum)=@_;
4105: my $courseid = $cdom.'_'.$cnum;
4106: $courseid=~s/\_/\//g;
4107: $courseid=~s/^(\w)/\/$1/;
4108: my $hashid="$udom:$uname:$courseid";
4109: &devalidate_cache_new('getgroups',$hashid);
4110: }
4111:
4112: # ------------------------------------------------------------------ Plain Text
4113:
4114: sub plaintext {
4115: my ($short,$type,$cid) = @_;
4116: if (!defined($cid)) {
4117: $cid = $env{'request.course.id'};
4118: }
4119: if (defined($cid) && defined($env{'course.'.$cid.'.'.$short.'.plaintext'})) {
4120: return &Apache::lonlocal::mt($env{'course.'.$cid.'.'.$short.
4121: '.plaintext'});
4122: }
4123: my %rolenames = (
4124: Course => 'std',
4125: Group => 'alt1',
4126: );
4127: if (defined($type) &&
4128: defined($rolenames{$type}) &&
4129: defined($prp{$short}{$rolenames{$type}})) {
4130: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
4131: } else {
4132: return &Apache::lonlocal::mt($prp{$short}{'std'});
4133: }
4134: }
4135:
4136: # ----------------------------------------------------------------- Assign Role
4137:
4138: sub assignrole {
4139: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
4140: my $mrole;
4141: if ($role =~ /^cr\//) {
4142: my $cwosec=$url;
4143: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4144: unless (&allowed('ccr',$cwosec)) {
4145: &logthis('Refused custom assignrole: '.
4146: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4147: $env{'user.name'}.' at '.$env{'user.domain'});
4148: return 'refused';
4149: }
4150: $mrole='cr';
4151: } elsif ($role =~ /^gr\//) {
4152: my $cwogrp=$url;
4153: $cwogrp=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4154: unless (&allowed('mdg',$cwogrp)) {
4155: &logthis('Refused group assignrole: '.
4156: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4157: $env{'user.name'}.' at '.$env{'user.domain'});
4158: return 'refused';
4159: }
4160: $mrole='gr';
4161: } else {
4162: my $cwosec=$url;
4163: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
4164: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
4165: &logthis('Refused assignrole: '.
4166: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
4167: $env{'user.name'}.' at '.$env{'user.domain'});
4168: return 'refused';
4169: }
4170: $mrole=$role;
4171: }
4172: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
4173: "$udom:$uname:$url".'_'."$mrole=$role";
4174: if ($end) { $command.='_'.$end; }
4175: if ($start) {
4176: if ($end) {
4177: $command.='_'.$start;
4178: } else {
4179: $command.='_0_'.$start;
4180: }
4181: }
4182: my $origstart = $start;
4183: my $origend = $end;
4184: # actually delete
4185: if ($deleteflag) {
4186: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
4187: # modify command to delete the role
4188: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
4189: "$udom:$uname:$url".'_'."$mrole";
4190: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
4191: # set start and finish to negative values for userrolelog
4192: $start=-1;
4193: $end=-1;
4194: }
4195: }
4196: # send command
4197: my $answer=&reply($command,&homeserver($uname,$udom));
4198: # log new user role if status is ok
4199: if ($answer eq 'ok') {
4200: &userrolelog($role,$uname,$udom,$url,$start,$end);
4201: # for course roles, perform group memberships changes triggered by role change.
4202: unless ($role =~ /^gr/) {
4203: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
4204: $origstart);
4205: }
4206: }
4207: return $answer;
4208: }
4209:
4210: # -------------------------------------------------- Modify user authentication
4211: # Overrides without validation
4212:
4213: sub modifyuserauth {
4214: my ($udom,$uname,$umode,$upass)=@_;
4215: my $uhome=&homeserver($uname,$udom);
4216: unless (&allowed('mau',$udom)) { return 'refused'; }
4217: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
4218: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4219: ' in domain '.$env{'request.role.domain'});
4220: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
4221: &escape($upass),$uhome);
4222: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
4223: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
4224: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4225: &log($udom,,$uname,$uhome,
4226: 'Authentication changed by '.$env{'user.domain'}.', '.
4227: $env{'user.name'}.', '.$umode.
4228: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
4229: unless ($reply eq 'ok') {
4230: &logthis('Authentication mode error: '.$reply);
4231: return 'error: '.$reply;
4232: }
4233: return 'ok';
4234: }
4235:
4236: # --------------------------------------------------------------- Modify a user
4237:
4238: sub modifyuser {
4239: my ($udom, $uname, $uid,
4240: $umode, $upass, $first,
4241: $middle, $last, $gene,
4242: $forceid, $desiredhome, $email)=@_;
4243: $udom=~s/\W//g;
4244: $uname=~s/\W//g;
4245: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
4246: $umode.', '.$first.', '.$middle.', '.
4247: $last.', '.$gene.'(forceid: '.$forceid.')'.
4248: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
4249: ' desiredhome not specified').
4250: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
4251: ' in domain '.$env{'request.role.domain'});
4252: my $uhome=&homeserver($uname,$udom,'true');
4253: # ----------------------------------------------------------------- Create User
4254: if (($uhome eq 'no_host') &&
4255: (($umode && $upass) || ($umode eq 'localauth'))) {
4256: my $unhome='';
4257: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
4258: $unhome = $desiredhome;
4259: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
4260: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
4261: } else { # load balancing routine for determining $unhome
4262: my $tryserver;
4263: my $loadm=10000000;
4264: foreach $tryserver (keys %libserv) {
4265: if ($hostdom{$tryserver} eq $udom) {
4266: my $answer=reply('load',$tryserver);
4267: if (($answer=~/\d+/) && ($answer<$loadm)) {
4268: $loadm=$answer;
4269: $unhome=$tryserver;
4270: }
4271: }
4272: }
4273: }
4274: if (($unhome eq '') || ($unhome eq 'no_host')) {
4275: return 'error: unable to find a home server for '.$uname.
4276: ' in domain '.$udom;
4277: }
4278: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
4279: &escape($upass),$unhome);
4280: unless ($reply eq 'ok') {
4281: return 'error: '.$reply;
4282: }
4283: $uhome=&homeserver($uname,$udom,'true');
4284: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
4285: return 'error: unable verify users home machine.';
4286: }
4287: } # End of creation of new user
4288: # ---------------------------------------------------------------------- Add ID
4289: if ($uid) {
4290: $uid=~tr/A-Z/a-z/;
4291: my %uidhash=&idrget($udom,$uname);
4292: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
4293: && (!$forceid)) {
4294: unless ($uid eq $uidhash{$uname}) {
4295: return 'error: user id "'.$uid.'" does not match '.
4296: 'current user id "'.$uidhash{$uname}.'".';
4297: }
4298: } else {
4299: &idput($udom,($uname => $uid));
4300: }
4301: }
4302: # -------------------------------------------------------------- Add names, etc
4303: my @tmp=&get('environment',
4304: ['firstname','middlename','lastname','generation'],
4305: $udom,$uname);
4306: my %names;
4307: if ($tmp[0] =~ m/^error:.*/) {
4308: %names=();
4309: } else {
4310: %names = @tmp;
4311: }
4312: #
4313: # Make sure to not trash student environment if instructor does not bother
4314: # to supply name and email information
4315: #
4316: if ($first) { $names{'firstname'} = $first; }
4317: if (defined($middle)) { $names{'middlename'} = $middle; }
4318: if ($last) { $names{'lastname'} = $last; }
4319: if (defined($gene)) { $names{'generation'} = $gene; }
4320: if ($email) {
4321: $email=~s/[^\w\@\.\-\,]//gs;
4322: if ($email=~/\@/) { $names{'notification'} = $email;
4323: $names{'critnotification'} = $email;
4324: $names{'permanentemail'} = $email; }
4325: }
4326: my $reply = &put('environment', \%names, $udom,$uname);
4327: if ($reply ne 'ok') { return 'error: '.$reply; }
4328: &devalidate_cache_new('namescache',$uname.':'.$udom);
4329: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
4330: $umode.', '.$first.', '.$middle.', '.
4331: $last.', '.$gene.' by '.
4332: $env{'user.name'}.' at '.$env{'user.domain'});
4333: return 'ok';
4334: }
4335:
4336: # -------------------------------------------------------------- Modify student
4337:
4338: sub modifystudent {
4339: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
4340: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
4341: if (!$cid) {
4342: unless ($cid=$env{'request.course.id'}) {
4343: return 'not_in_class';
4344: }
4345: }
4346: # --------------------------------------------------------------- Make the user
4347: my $reply=&modifyuser
4348: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
4349: $desiredhome,$email);
4350: unless ($reply eq 'ok') { return $reply; }
4351: # This will cause &modify_student_enrollment to get the uid from the
4352: # students environment
4353: $uid = undef if (!$forceid);
4354: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
4355: $gene,$usec,$end,$start,$type,$locktype,$cid);
4356: return $reply;
4357: }
4358:
4359: sub modify_student_enrollment {
4360: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
4361: my ($cdom,$cnum,$chome);
4362: if (!$cid) {
4363: unless ($cid=$env{'request.course.id'}) {
4364: return 'not_in_class';
4365: }
4366: $cdom=$env{'course.'.$cid.'.domain'};
4367: $cnum=$env{'course.'.$cid.'.num'};
4368: } else {
4369: ($cdom,$cnum)=split(/_/,$cid);
4370: }
4371: $chome=$env{'course.'.$cid.'.home'};
4372: if (!$chome) {
4373: $chome=&homeserver($cnum,$cdom);
4374: }
4375: if (!$chome) { return 'unknown_course'; }
4376: # Make sure the user exists
4377: my $uhome=&homeserver($uname,$udom);
4378: if (($uhome eq '') || ($uhome eq 'no_host')) {
4379: return 'error: no such user';
4380: }
4381: # Get student data if we were not given enough information
4382: if (!defined($first) || $first eq '' ||
4383: !defined($last) || $last eq '' ||
4384: !defined($uid) || $uid eq '' ||
4385: !defined($middle) || $middle eq '' ||
4386: !defined($gene) || $gene eq '') {
4387: # They did not supply us with enough data to enroll the student, so
4388: # we need to pick up more information.
4389: my %tmp = &get('environment',
4390: ['firstname','middlename','lastname', 'generation','id']
4391: ,$udom,$uname);
4392:
4393: #foreach (keys(%tmp)) {
4394: # &logthis("key $_ = ".$tmp{$_});
4395: #}
4396: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
4397: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
4398: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
4399: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
4400: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
4401: }
4402: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
4403: my $reply=cput('classlist',
4404: {"$uname:$udom" =>
4405: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
4406: $cdom,$cnum);
4407: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
4408: return 'error: '.$reply;
4409: } else {
4410: &devalidate_getsection_cache($udom,$uname,$cid);
4411: }
4412: # Add student role to user
4413: my $uurl='/'.$cid;
4414: $uurl=~s/\_/\//g;
4415: if ($usec) {
4416: $uurl.='/'.$usec;
4417: }
4418: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
4419: }
4420:
4421: sub format_name {
4422: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
4423: my $name;
4424: if ($first ne 'lastname') {
4425: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
4426: } else {
4427: if ($lastname=~/\S/) {
4428: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
4429: $name=~s/\s+,/,/;
4430: } else {
4431: $name.= $firstname.' '.$middlename.' '.$generation;
4432: }
4433: }
4434: $name=~s/^\s+//;
4435: $name=~s/\s+$//;
4436: $name=~s/\s+/ /g;
4437: return $name;
4438: }
4439:
4440: # ------------------------------------------------- Write to course preferences
4441:
4442: sub writecoursepref {
4443: my ($courseid,%prefs)=@_;
4444: $courseid=~s/^\///;
4445: $courseid=~s/\_/\//g;
4446: my ($cdomain,$cnum)=split(/\//,$courseid);
4447: my $chome=homeserver($cnum,$cdomain);
4448: if (($chome eq '') || ($chome eq 'no_host')) {
4449: return 'error: no such course';
4450: }
4451: my $cstring='';
4452: foreach (keys %prefs) {
4453: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
4454: }
4455: $cstring=~s/\&$//;
4456: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
4457: }
4458:
4459: # ---------------------------------------------------------- Make/modify course
4460:
4461: sub createcourse {
4462: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
4463: $course_owner,$crstype)=@_;
4464: $url=&declutter($url);
4465: my $cid='';
4466: unless (&allowed('ccc',$udom)) {
4467: return 'refused';
4468: }
4469: # ------------------------------------------------------------------- Create ID
4470: my $uname=int(1+rand(9)).
4471: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
4472: substr($$.time,0,5).unpack("H8",pack("I32",time)).
4473: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4474: # ----------------------------------------------- Make sure that does not exist
4475: my $uhome=&homeserver($uname,$udom,'true');
4476: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4477: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
4478: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
4479: $uhome=&homeserver($uname,$udom,'true');
4480: unless (($uhome eq '') || ($uhome eq 'no_host')) {
4481: return 'error: unable to generate unique course-ID';
4482: }
4483: }
4484: # ------------------------------------------------ Check supplied server name
4485: $course_server = $env{'user.homeserver'} if (! defined($course_server));
4486: if (! exists($libserv{$course_server})) {
4487: return 'error:bad server name '.$course_server;
4488: }
4489: # ------------------------------------------------------------- Make the course
4490: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
4491: $course_server);
4492: unless ($reply eq 'ok') { return 'error: '.$reply; }
4493: $uhome=&homeserver($uname,$udom,'true');
4494: if (($uhome eq '') || ($uhome eq 'no_host')) {
4495: return 'error: no such course';
4496: }
4497: # ----------------------------------------------------------------- Course made
4498: # log existence
4499: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
4500: ':'.&escape($inst_code).':'.&escape($course_owner).':'.
4501: &escape($crstype),$uhome);
4502: &flushcourselogs();
4503: # set toplevel url
4504: my $topurl=$url;
4505: unless ($nonstandard) {
4506: # ------------------------------------------ For standard courses, make top url
4507: my $mapurl=&clutter($url);
4508: if ($mapurl eq '/res/') { $mapurl=''; }
4509: $env{'form.initmap'}=(<<ENDINITMAP);
4510: <map>
4511: <resource id="1" type="start"></resource>
4512: <resource id="2" src="$mapurl"></resource>
4513: <resource id="3" type="finish"></resource>
4514: <link index="1" from="1" to="2"></link>
4515: <link index="2" from="2" to="3"></link>
4516: </map>
4517: ENDINITMAP
4518: $topurl=&declutter(
4519: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
4520: );
4521: }
4522: # ----------------------------------------------------------- Write preferences
4523: &writecoursepref($udom.'_'.$uname,
4524: ('description' => $description,
4525: 'url' => $topurl));
4526: return '/'.$udom.'/'.$uname;
4527: }
4528:
4529: # ---------------------------------------------------------- Assign Custom Role
4530:
4531: sub assigncustomrole {
4532: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
4533: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
4534: $end,$start,$deleteflag);
4535: }
4536:
4537: # ----------------------------------------------------------------- Revoke Role
4538:
4539: sub revokerole {
4540: my ($udom,$uname,$url,$role,$deleteflag)=@_;
4541: my $now=time;
4542: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
4543: }
4544:
4545: # ---------------------------------------------------------- Revoke Custom Role
4546:
4547: sub revokecustomrole {
4548: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
4549: my $now=time;
4550: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
4551: $deleteflag);
4552: }
4553:
4554: # ------------------------------------------------------------ Disk usage
4555: sub diskusage {
4556: my ($udom,$uname,$directoryRoot)=@_;
4557: $directoryRoot =~ s/\/$//;
4558: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
4559: return $listing;
4560: }
4561:
4562: sub is_locked {
4563: my ($file_name, $domain, $user) = @_;
4564: my @check;
4565: my $is_locked;
4566: push @check, $file_name;
4567: my %locked = &get('file_permissions',\@check,
4568: $env{'user.domain'},$env{'user.name'});
4569: my ($tmp)=keys(%locked);
4570: if ($tmp=~/^error:/) { undef(%locked); }
4571:
4572: if (ref($locked{$file_name}) eq 'ARRAY') {
4573: $is_locked = 'false';
4574: foreach my $entry (@{$locked{$file_name}}) {
4575: if (ref($entry) eq 'ARRAY') {
4576: $is_locked = 'true';
4577: last;
4578: }
4579: }
4580: } else {
4581: $is_locked = 'false';
4582: }
4583: }
4584:
4585: # ------------------------------------------------------------- Mark as Read Only
4586:
4587: sub mark_as_readonly {
4588: my ($domain,$user,$files,$what) = @_;
4589: my %current_permissions = &dump('file_permissions',$domain,$user);
4590: my ($tmp)=keys(%current_permissions);
4591: if ($tmp=~/^error:/) { undef(%current_permissions); }
4592: foreach my $file (@{$files}) {
4593: push(@{$current_permissions{$file}},$what);
4594: }
4595: &put('file_permissions',\%current_permissions,$domain,$user);
4596: return;
4597: }
4598:
4599: # ------------------------------------------------------------Save Selected Files
4600:
4601: sub save_selected_files {
4602: my ($user, $path, @files) = @_;
4603: my $filename = $user."savedfiles";
4604: my @other_files = &files_not_in_path($user, $path);
4605: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4606: foreach my $file (@files) {
4607: print (OUT $env{'form.currentpath'}.$file."\n");
4608: }
4609: foreach my $file (@other_files) {
4610: print (OUT $file."\n");
4611: }
4612: close (OUT);
4613: return 'ok';
4614: }
4615:
4616: sub clear_selected_files {
4617: my ($user) = @_;
4618: my $filename = $user."savedfiles";
4619: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4620: print (OUT undef);
4621: close (OUT);
4622: return ("ok");
4623: }
4624:
4625: sub files_in_path {
4626: my ($user, $path) = @_;
4627: my $filename = $user."savedfiles";
4628: my %return_files;
4629: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4630: while (my $line_in = <IN>) {
4631: chomp ($line_in);
4632: my @paths_and_file = split (m!/!, $line_in);
4633: my $file_part = pop (@paths_and_file);
4634: my $path_part = join ('/', @paths_and_file);
4635: $path_part.='/';
4636: my $path_and_file = $path_part.$file_part;
4637: if ($path_part eq $path) {
4638: $return_files{$file_part}= 'selected';
4639: }
4640: }
4641: close (IN);
4642: return (\%return_files);
4643: }
4644:
4645: # called in portfolio select mode, to show files selected NOT in current directory
4646: sub files_not_in_path {
4647: my ($user, $path) = @_;
4648: my $filename = $user."savedfiles";
4649: my @return_files;
4650: my $path_part;
4651: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
4652: while (<IN>) {
4653: #ok, I know it's clunky, but I want it to work
4654: my @paths_and_file = split m!/!, $_;
4655: my $file_part = pop (@paths_and_file);
4656: chomp ($file_part);
4657: my $path_part = join ('/', @paths_and_file);
4658: $path_part .= '/';
4659: my $path_and_file = $path_part.$file_part;
4660: if ($path_part ne $path) {
4661: push (@return_files, ($path_and_file));
4662: }
4663: }
4664: close (OUT);
4665: return (@return_files);
4666: }
4667:
4668: #----------------------------------------------Get portfolio file permissions
4669:
4670: sub get_portfile_permissions {
4671: my ($domain,$user) = @_;
4672: my %current_permissions = &dump('file_permissions',$domain,$user);
4673: my ($tmp)=keys(%current_permissions);
4674: if ($tmp=~/^error:/) { undef(%current_permissions); }
4675: return \%current_permissions;
4676: }
4677:
4678: #---------------------------------------------Get portfolio file access controls
4679:
4680: sub get_access_controls {
4681: my ($current_permissions,$group,$file) = @_;
4682: my %access;
4683: if (defined($file)) {
4684: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
4685: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
4686: $access{$file}{$control} = $$current_permissions{$file."\0".$control};
4687: }
4688: }
4689: } else {
4690: foreach my $key (keys(%{$current_permissions})) {
4691: if ($key =~ /\0accesscontrol$/) {
4692: if (defined($group)) {
4693: if ($key !~ m-^\Q$group\E/-) {
4694: next;
4695: }
4696: }
4697: my ($fullpath) = split(/\0/,$key);
4698: if (ref($$current_permissions{$key}) eq 'HASH') {
4699: foreach my $control (keys(%{$$current_permissions{$key}})) {
4700: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
4701: }
4702: }
4703: }
4704: }
4705: }
4706: return %access;
4707: }
4708:
4709: sub modify_access_controls {
4710: my ($file_name,$changes,$domain,$user)=@_;
4711: my ($outcome,$deloutcome);
4712: my %store_permissions;
4713: my %new_values;
4714: my %new_control;
4715: my %translation;
4716: my @deletions = ();
4717: my $now = time;
4718: if (exists($$changes{'activate'})) {
4719: if (ref($$changes{'activate'}) eq 'HASH') {
4720: my @newitems = sort(keys(%{$$changes{'activate'}}));
4721: my $numnew = scalar(@newitems);
4722: for (my $i=0; $i<$numnew; $i++) {
4723: my $newkey = $newitems[$i];
4724: my $newid = &Apache::loncommon::get_cgi_id();
4725: $newkey =~ s/^(\d+)/$newid/;
4726: $translation{$1} = $newid;
4727: $new_values{$file_name."\0".$newkey} =
4728: $$changes{'activate'}{$newitems[$i]};
4729: $new_control{$newkey} = $now;
4730: }
4731: }
4732: }
4733: my %todelete;
4734: my %changed_items;
4735: foreach my $action ('delete','update') {
4736: if (exists($$changes{$action})) {
4737: if (ref($$changes{$action}) eq 'HASH') {
4738: foreach my $key (keys(%{$$changes{$action}})) {
4739: my ($itemnum) = ($key =~ /^([^:]+):/);
4740: if ($action eq 'delete') {
4741: $todelete{$itemnum} = 1;
4742: } else {
4743: $changed_items{$itemnum} = $key;
4744: }
4745: }
4746: }
4747: }
4748: }
4749: # get lock on access controls for file.
4750: my $lockhash = {
4751: $file_name."\0".'locked_access_records' => $env{'user.name'}.
4752: ':'.$env{'user.domain'},
4753: };
4754: my $tries = 0;
4755: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4756:
4757: while (($gotlock ne 'ok') && $tries <3) {
4758: $tries ++;
4759: sleep 1;
4760: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
4761: }
4762: if ($gotlock eq 'ok') {
4763: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
4764: my ($tmp)=keys(%curr_permissions);
4765: if ($tmp=~/^error:/) { undef(%curr_permissions); }
4766: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
4767: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
4768: if (ref($curr_controls) eq 'HASH') {
4769: foreach my $control_item (keys(%{$curr_controls})) {
4770: my ($itemnum) = ($control_item =~ /^([^:]+):/);
4771: if (defined($todelete{$itemnum})) {
4772: push(@deletions,$file_name."\0".$control_item);
4773: } else {
4774: if (defined($changed_items{$itemnum})) {
4775: $new_control{$changed_items{$itemnum}} = $now;
4776: push(@deletions,$file_name."\0".$control_item);
4777: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
4778: } else {
4779: $new_control{$control_item} = $$curr_controls{$control_item};
4780: }
4781: }
4782: }
4783: }
4784: }
4785: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
4786: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
4787: $outcome = &put('file_permissions',\%new_values,$domain,$user);
4788: # remove lock
4789: my @del_lock = ($file_name."\0".'locked_access_records');
4790: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
4791: } else {
4792: $outcome = "error: could not obtain lockfile\n";
4793: }
4794: return ($outcome,$deloutcome,\%new_values,\%translation);
4795: }
4796:
4797: #------------------------------------------------------Get Marked as Read Only
4798:
4799: sub get_marked_as_readonly {
4800: my ($domain,$user,$what,$group) = @_;
4801: my $current_permissions = &get_portfile_permissions($domain,$user);
4802: my @readonly_files;
4803: my $cmp1=$what;
4804: if (ref($what)) { $cmp1=join('',@{$what}) };
4805: while (my ($file_name,$value) = each(%{$current_permissions})) {
4806: if (defined($group)) {
4807: if ($file_name !~ m-^\Q$group\E/-) {
4808: next;
4809: }
4810: }
4811: if (ref($value) eq "ARRAY"){
4812: foreach my $stored_what (@{$value}) {
4813: my $cmp2=$stored_what;
4814: if (ref($stored_what eq 'ARRAY')) {
4815: $cmp2=join('',@{$stored_what});
4816: }
4817: if ($cmp1 eq $cmp2) {
4818: push(@readonly_files, $file_name);
4819: last;
4820: } elsif (!defined($what)) {
4821: push(@readonly_files, $file_name);
4822: last;
4823: }
4824: }
4825: }
4826: }
4827: return @readonly_files;
4828: }
4829: #-----------------------------------------------------------Get Marked as Read Only Hash
4830:
4831: sub get_marked_as_readonly_hash {
4832: my ($current_permissions,$group,$what) = @_;
4833: my %readonly_files;
4834: while (my ($file_name,$value) = each(%{$current_permissions})) {
4835: if (defined($group)) {
4836: if ($file_name !~ m-^\Q$group\E/-) {
4837: next;
4838: }
4839: }
4840: if (ref($value) eq "ARRAY"){
4841: foreach my $stored_what (@{$value}) {
4842: if (ref($stored_what) eq 'ARRAY') {
4843: foreach my $lock_descriptor(@{$stored_what}) {
4844: if ($lock_descriptor eq 'graded') {
4845: $readonly_files{$file_name} = 'graded';
4846: } elsif ($lock_descriptor eq 'handback') {
4847: $readonly_files{$file_name} = 'handback';
4848: } else {
4849: if (!exists($readonly_files{$file_name})) {
4850: $readonly_files{$file_name} = 'locked';
4851: }
4852: }
4853: }
4854: }
4855: }
4856: }
4857: }
4858: return %readonly_files;
4859: }
4860: # ------------------------------------------------------------ Unmark as Read Only
4861:
4862: sub unmark_as_readonly {
4863: # unmarks $file_name (if $file_name is defined), or all files locked by $what
4864: # for portfolio submissions, $what contains [$symb,$crsid]
4865: my ($domain,$user,$what,$file_name,$group) = @_;
4866: my $symb_crs = $what;
4867: if (ref($what)) { $symb_crs=join('',@$what); }
4868: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
4869: my ($tmp)=keys(%current_permissions);
4870: if ($tmp=~/^error:/) { undef(%current_permissions); }
4871: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
4872: foreach my $file (@readonly_files) {
4873: if (defined($file_name) && ($file_name ne $file)) { next; }
4874: my $current_locks = $current_permissions{$file};
4875: my @new_locks;
4876: my @del_keys;
4877: if (ref($current_locks) eq "ARRAY"){
4878: foreach my $locker (@{$current_locks}) {
4879: my $compare=$locker;
4880: if (ref($locker) eq 'ARRAY') {
4881: $compare=join('',@{$locker});
4882: if ($compare ne $symb_crs) {
4883: push(@new_locks, $locker);
4884: }
4885: }
4886: }
4887: if (scalar(@new_locks) > 0) {
4888: $current_permissions{$file} = \@new_locks;
4889: } else {
4890: push(@del_keys, $file);
4891: &del('file_permissions',\@del_keys, $domain, $user);
4892: delete($current_permissions{$file});
4893: }
4894: }
4895: }
4896: &put('file_permissions',\%current_permissions,$domain,$user);
4897: return;
4898: }
4899:
4900: # ------------------------------------------------------------ Directory lister
4901:
4902: sub dirlist {
4903: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
4904:
4905: $uri=~s/^\///;
4906: $uri=~s/\/$//;
4907: my ($udom, $uname);
4908: (undef,$udom,$uname)=split(/\//,$uri);
4909: if(defined($userdomain)) {
4910: $udom = $userdomain;
4911: }
4912: if(defined($username)) {
4913: $uname = $username;
4914: }
4915:
4916: my $dirRoot = $perlvar{'lonDocRoot'};
4917: if(defined($alternateDirectoryRoot)) {
4918: $dirRoot = $alternateDirectoryRoot;
4919: $dirRoot =~ s/\/$//;
4920: }
4921:
4922: if($udom) {
4923: if($uname) {
4924: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
4925: homeserver($uname,$udom));
4926: my @listing_results;
4927: if ($listing eq 'unknown_cmd') {
4928: $listing=reply('ls:'.$dirRoot.'/'.$uri,
4929: homeserver($uname,$udom));
4930: @listing_results = split(/:/,$listing);
4931: } else {
4932: @listing_results = map { &unescape($_); } split(/:/,$listing);
4933: }
4934: return @listing_results;
4935: } elsif(!defined($alternateDirectoryRoot)) {
4936: my $tryserver;
4937: my %allusers=();
4938: foreach $tryserver (keys %libserv) {
4939: if($hostdom{$tryserver} eq $udom) {
4940: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
4941: $udom, $tryserver);
4942: my @listing_results;
4943: if ($listing eq 'unknown_cmd') {
4944: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
4945: $udom, $tryserver);
4946: @listing_results = split(/:/,$listing);
4947: } else {
4948: @listing_results =
4949: map { &unescape($_); } split(/:/,$listing);
4950: }
4951: if ($listing_results[0] ne 'no_such_dir' &&
4952: $listing_results[0] ne 'empty' &&
4953: $listing_results[0] ne 'con_lost') {
4954: foreach (@listing_results) {
4955: my ($entry,@stat)=split(/&/,$_);
4956: $allusers{$entry}=1;
4957: }
4958: }
4959: }
4960: }
4961: my $alluserstr='';
4962: foreach (sort keys %allusers) {
4963: $alluserstr.=$_.'&user:';
4964: }
4965: $alluserstr=~s/:$//;
4966: return split(/:/,$alluserstr);
4967: } else {
4968: my @emptyResults = ();
4969: push(@emptyResults, 'missing user name');
4970: return split(':',@emptyResults);
4971: }
4972: } elsif(!defined($alternateDirectoryRoot)) {
4973: my $tryserver;
4974: my %alldom=();
4975: foreach $tryserver (keys %libserv) {
4976: $alldom{$hostdom{$tryserver}}=1;
4977: }
4978: my $alldomstr='';
4979: foreach (sort keys %alldom) {
4980: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
4981: }
4982: $alldomstr=~s/:$//;
4983: return split(/:/,$alldomstr);
4984: } else {
4985: my @emptyResults = ();
4986: push(@emptyResults, 'missing domain');
4987: return split(':',@emptyResults);
4988: }
4989: }
4990:
4991: # --------------------------------------------- GetFileTimestamp
4992: # This function utilizes dirlist and returns the date stamp for
4993: # when it was last modified. It will also return an error of -1
4994: # if an error occurs
4995:
4996: ##
4997: ## FIXME: This subroutine assumes its caller knows something about the
4998: ## directory structure of the home server for the student ($root).
4999: ## Not a good assumption to make. Since this is for looking up files
5000: ## in user directories, the full path should be constructed by lond, not
5001: ## whatever machine we request data from.
5002: ##
5003: sub GetFileTimestamp {
5004: my ($studentDomain,$studentName,$filename,$root)=@_;
5005: $studentDomain=~s/\W//g;
5006: $studentName=~s/\W//g;
5007: my $subdir=$studentName.'__';
5008: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
5009: my $proname="$studentDomain/$subdir/$studentName";
5010: $proname .= '/'.$filename;
5011: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
5012: $studentName, $root);
5013: my @stats = split('&', $fileStat);
5014: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5015: # @stats contains first the filename, then the stat output
5016: return $stats[10]; # so this is 10 instead of 9.
5017: } else {
5018: return -1;
5019: }
5020: }
5021:
5022: sub stat_file {
5023: my ($uri) = @_;
5024: $uri = &clutter($uri);
5025:
5026: # we want just the url part without the unneeded accessor url bits
5027: if ($uri =~ m-^/adm/-) {
5028: $uri=~s-^/adm/wrapper/-/-;
5029: $uri=~s-^/adm/coursedocs/showdoc/-/-;
5030: }
5031: my ($udom,$uname,$file,$dir);
5032: if ($uri =~ m-^/(uploaded|editupload)/-) {
5033: ($udom,$uname,$file) =
5034: ($uri =~ m-/(?:uploaded|editupload)/?([^/]*)/?([^/]*)/?(.*)-);
5035: $file = 'userfiles/'.$file;
5036: $dir = &propath($udom,$uname);
5037: }
5038: if ($uri =~ m-^/res/-) {
5039: ($udom,$uname) =
5040: ($uri =~ m-/(?:res)/?([^/]*)/?([^/]*)/-);
5041: $file = $uri;
5042: }
5043:
5044: if (!$udom || !$uname || !$file) {
5045: # unable to handle the uri
5046: return ();
5047: }
5048:
5049: my ($result) = &dirlist($file,$udom,$uname,$dir);
5050: my @stats = split('&', $result);
5051:
5052: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
5053: shift(@stats); #filename is first
5054: return @stats;
5055: }
5056: return ();
5057: }
5058:
5059: # -------------------------------------------------------- Value of a Condition
5060:
5061: # gets the value of a specific preevaluated condition
5062: # stored in the string $env{user.state.<cid>}
5063: # or looks up a condition reference in the bighash and if if hasn't
5064: # already been evaluated recurses into docondval to get the value of
5065: # the condition, then memoizing it to
5066: # $env{user.state.<cid>.<condition>}
5067: sub directcondval {
5068: my $number=shift;
5069: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
5070: &Apache::lonuserstate::evalstate();
5071: }
5072: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
5073: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
5074: } elsif ($number =~ /^_/) {
5075: my $sub_condition;
5076: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5077: &GDBM_READER(),0640)) {
5078: $sub_condition=$bighash{'conditions'.$number};
5079: untie(%bighash);
5080: }
5081: my $value = &docondval($sub_condition);
5082: &appenv('user.state.'.$env{'request.course.id'}.".$number" => $value);
5083: return $value;
5084: }
5085: if ($env{'user.state.'.$env{'request.course.id'}}) {
5086: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
5087: } else {
5088: return 2;
5089: }
5090: }
5091:
5092: # get the collection of conditions for this resource
5093: sub condval {
5094: my $condidx=shift;
5095: my $allpathcond='';
5096: foreach my $cond (split(/\|/,$condidx)) {
5097: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
5098: $allpathcond.=
5099: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
5100: }
5101: }
5102: $allpathcond=~s/\|$//;
5103: return &docondval($allpathcond);
5104: }
5105:
5106: #evaluates an expression of conditions
5107: sub docondval {
5108: my ($allpathcond) = @_;
5109: my $result=0;
5110: if ($env{'request.course.id'}
5111: && defined($allpathcond)) {
5112: my $operand='|';
5113: my @stack;
5114: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
5115: if ($chunk eq '(') {
5116: push @stack,($operand,$result);
5117: } elsif ($chunk eq ')') {
5118: my $before=pop @stack;
5119: if (pop @stack eq '&') {
5120: $result=$result>$before?$before:$result;
5121: } else {
5122: $result=$result>$before?$result:$before;
5123: }
5124: } elsif (($chunk eq '&') || ($chunk eq '|')) {
5125: $operand=$chunk;
5126: } else {
5127: my $new=directcondval($chunk);
5128: if ($operand eq '&') {
5129: $result=$result>$new?$new:$result;
5130: } else {
5131: $result=$result>$new?$result:$new;
5132: }
5133: }
5134: }
5135: }
5136: return $result;
5137: }
5138:
5139: # ---------------------------------------------------- Devalidate courseresdata
5140:
5141: sub devalidatecourseresdata {
5142: my ($coursenum,$coursedomain)=@_;
5143: my $hashid=$coursenum.':'.$coursedomain;
5144: &devalidate_cache_new('courseres',$hashid);
5145: }
5146:
5147: # --------------------------------------------------- Course Resourcedata Query
5148:
5149: sub get_courseresdata {
5150: my ($coursenum,$coursedomain)=@_;
5151: my $coursehom=&homeserver($coursenum,$coursedomain);
5152: my $hashid=$coursenum.':'.$coursedomain;
5153: my ($result,$cached)=&is_cached_new('courseres',$hashid);
5154: my %dumpreply;
5155: unless (defined($cached)) {
5156: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
5157: $result=\%dumpreply;
5158: my ($tmp) = keys(%dumpreply);
5159: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5160: &do_cache_new('courseres',$hashid,$result,600);
5161: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
5162: return $tmp;
5163: } elsif ($tmp =~ /^(error)/) {
5164: $result=undef;
5165: &do_cache_new('courseres',$hashid,$result,600);
5166: }
5167: }
5168: return $result;
5169: }
5170:
5171: sub devalidateuserresdata {
5172: my ($uname,$udom)=@_;
5173: my $hashid="$udom:$uname";
5174: &devalidate_cache_new('userres',$hashid);
5175: }
5176:
5177: sub get_userresdata {
5178: my ($uname,$udom)=@_;
5179: #most student don\'t have any data set, check if there is some data
5180: if (&EXT_cache_status($udom,$uname)) { return undef; }
5181:
5182: my $hashid="$udom:$uname";
5183: my ($result,$cached)=&is_cached_new('userres',$hashid);
5184: if (!defined($cached)) {
5185: my %resourcedata=&dump('resourcedata',$udom,$uname);
5186: $result=\%resourcedata;
5187: &do_cache_new('userres',$hashid,$result,600);
5188: }
5189: my ($tmp)=keys(%$result);
5190: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
5191: return $result;
5192: }
5193: #error 2 occurs when the .db doesn't exist
5194: if ($tmp!~/error: 2 /) {
5195: &logthis("<font color=\"blue\">WARNING:".
5196: " Trying to get resource data for ".
5197: $uname." at ".$udom.": ".
5198: $tmp."</font>");
5199: } elsif ($tmp=~/error: 2 /) {
5200: #&EXT_cache_set($udom,$uname);
5201: &do_cache_new('userres',$hashid,undef,600);
5202: undef($tmp); # not really an error so don't send it back
5203: }
5204: return $tmp;
5205: }
5206:
5207: sub resdata {
5208: my ($name,$domain,$type,@which)=@_;
5209: my $result;
5210: if ($type eq 'course') {
5211: $result=&get_courseresdata($name,$domain);
5212: } elsif ($type eq 'user') {
5213: $result=&get_userresdata($name,$domain);
5214: }
5215: if (!ref($result)) { return $result; }
5216: foreach my $item (@which) {
5217: if (defined($result->{$item})) {
5218: return $result->{$item};
5219: }
5220: }
5221: return undef;
5222: }
5223:
5224: #
5225: # EXT resource caching routines
5226: #
5227:
5228: sub clear_EXT_cache_status {
5229: &delenv('cache.EXT.');
5230: }
5231:
5232: sub EXT_cache_status {
5233: my ($target_domain,$target_user) = @_;
5234: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5235: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
5236: # We know already the user has no data
5237: return 1;
5238: } else {
5239: return 0;
5240: }
5241: }
5242:
5243: sub EXT_cache_set {
5244: my ($target_domain,$target_user) = @_;
5245: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
5246: #&appenv($cachename => time);
5247: }
5248:
5249: # --------------------------------------------------------- Value of a Variable
5250: sub EXT {
5251:
5252: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
5253: unless ($varname) { return ''; }
5254: #get real user name/domain, courseid and symb
5255: my $courseid;
5256: my $publicuser;
5257: if ($symbparm) {
5258: $symbparm=&get_symb_from_alias($symbparm);
5259: }
5260: if (!($uname && $udom)) {
5261: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
5262: &Apache::lonxml::whichuser($symbparm);
5263: if (!$symbparm) { $symbparm=$cursymb; }
5264: } else {
5265: $courseid=$env{'request.course.id'};
5266: }
5267: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
5268: my $rest;
5269: if (defined($therest[0])) {
5270: $rest=join('.',@therest);
5271: } else {
5272: $rest='';
5273: }
5274:
5275: my $qualifierrest=$qualifier;
5276: if ($rest) { $qualifierrest.='.'.$rest; }
5277: my $spacequalifierrest=$space;
5278: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
5279: if ($realm eq 'user') {
5280: # --------------------------------------------------------------- user.resource
5281: if ($space eq 'resource') {
5282: if ( (defined($Apache::lonhomework::parsing_a_problem)
5283: || defined($Apache::lonhomework::parsing_a_task))
5284: &&
5285: ($symbparm eq &symbread()) ) {
5286: # if we are in the middle of processing the resource the
5287: # get the value we are planning on committing
5288: if (defined($Apache::lonhomework::results{$qualifierrest})) {
5289: return $Apache::lonhomework::results{$qualifierrest};
5290: } else {
5291: return $Apache::lonhomework::history{$qualifierrest};
5292: }
5293: } else {
5294: my %restored;
5295: if ($publicuser || $env{'request.state'} eq 'construct') {
5296: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
5297: } else {
5298: %restored=&restore($symbparm,$courseid,$udom,$uname);
5299: }
5300: return $restored{$qualifierrest};
5301: }
5302: # ----------------------------------------------------------------- user.access
5303: } elsif ($space eq 'access') {
5304: # FIXME - not supporting calls for a specific user
5305: return &allowed($qualifier,$rest);
5306: # ------------------------------------------ user.preferences, user.environment
5307: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
5308: if (($uname eq $env{'user.name'}) &&
5309: ($udom eq $env{'user.domain'})) {
5310: return $env{join('.',('environment',$qualifierrest))};
5311: } else {
5312: my %returnhash;
5313: if (!$publicuser) {
5314: %returnhash=&userenvironment($udom,$uname,
5315: $qualifierrest);
5316: }
5317: return $returnhash{$qualifierrest};
5318: }
5319: # ----------------------------------------------------------------- user.course
5320: } elsif ($space eq 'course') {
5321: # FIXME - not supporting calls for a specific user
5322: return $env{join('.',('request.course',$qualifier))};
5323: # ------------------------------------------------------------------- user.role
5324: } elsif ($space eq 'role') {
5325: # FIXME - not supporting calls for a specific user
5326: my ($role,$where)=split(/\./,$env{'request.role'});
5327: if ($qualifier eq 'value') {
5328: return $role;
5329: } elsif ($qualifier eq 'extent') {
5330: return $where;
5331: }
5332: # ----------------------------------------------------------------- user.domain
5333: } elsif ($space eq 'domain') {
5334: return $udom;
5335: # ------------------------------------------------------------------- user.name
5336: } elsif ($space eq 'name') {
5337: return $uname;
5338: # ---------------------------------------------------- Any other user namespace
5339: } else {
5340: my %reply;
5341: if (!$publicuser) {
5342: %reply=&get($space,[$qualifierrest],$udom,$uname);
5343: }
5344: return $reply{$qualifierrest};
5345: }
5346: } elsif ($realm eq 'query') {
5347: # ---------------------------------------------- pull stuff out of query string
5348: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
5349: [$spacequalifierrest]);
5350: return $env{'form.'.$spacequalifierrest};
5351: } elsif ($realm eq 'request') {
5352: # ------------------------------------------------------------- request.browser
5353: if ($space eq 'browser') {
5354: if ($qualifier eq 'textremote') {
5355: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
5356: return 1;
5357: } else {
5358: return 0;
5359: }
5360: } else {
5361: return $env{'browser.'.$qualifier};
5362: }
5363: # ------------------------------------------------------------ request.filename
5364: } else {
5365: return $env{'request.'.$spacequalifierrest};
5366: }
5367: } elsif ($realm eq 'course') {
5368: # ---------------------------------------------------------- course.description
5369: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
5370: } elsif ($realm eq 'resource') {
5371:
5372: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
5373: if (!$symbparm) { $symbparm=&symbread(); }
5374: }
5375:
5376: if ($space eq 'title') {
5377: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
5378: return &gettitle($symbparm);
5379: }
5380:
5381: if ($space eq 'map') {
5382: my ($map) = &decode_symb($symbparm);
5383: return &symbread($map);
5384: }
5385:
5386: my ($section, $group, @groups);
5387: my ($courselevelm,$courselevel);
5388: if ($symbparm && defined($courseid) &&
5389: $courseid eq $env{'request.course.id'}) {
5390:
5391: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
5392:
5393: # ----------------------------------------------------- Cascading lookup scheme
5394: my $symbp=$symbparm;
5395: my $mapp=&deversion((&decode_symb($symbp))[0]);
5396:
5397: my $symbparm=$symbp.'.'.$spacequalifierrest;
5398: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
5399:
5400: if (($env{'user.name'} eq $uname) &&
5401: ($env{'user.domain'} eq $udom)) {
5402: $section=$env{'request.course.sec'};
5403: @groups = split(/:/,$env{'request.course.groups'});
5404: @groups=&sort_course_groups($courseid,@groups);
5405: } else {
5406: if (! defined($usection)) {
5407: $section=&getsection($udom,$uname,$courseid);
5408: } else {
5409: $section = $usection;
5410: }
5411: @groups = &get_users_groups($udom,$uname,$courseid);
5412: }
5413:
5414: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
5415: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
5416: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
5417:
5418: $courselevel=$courseid.'.'.$spacequalifierrest;
5419: my $courselevelr=$courseid.'.'.$symbparm;
5420: $courselevelm=$courseid.'.'.$mapparm;
5421:
5422: # ----------------------------------------------------------- first, check user
5423:
5424: my $userreply=&resdata($uname,$udom,'user',
5425: ($courselevelr,$courselevelm,
5426: $courselevel));
5427: if (defined($userreply)) { return $userreply; }
5428:
5429: # ------------------------------------------------ second, check some of course
5430: my $coursereply;
5431: if (@groups > 0) {
5432: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
5433: $mapparm,$spacequalifierrest);
5434: if (defined($coursereply)) { return $coursereply; }
5435: }
5436:
5437: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5438: $env{'course.'.$courseid.'.domain'},
5439: 'course',
5440: ($seclevelr,$seclevelm,$seclevel,
5441: $courselevelr));
5442: if (defined($coursereply)) { return $coursereply; }
5443:
5444: # ------------------------------------------------------ third, check map parms
5445: my %parmhash=();
5446: my $thisparm='';
5447: if (tie(%parmhash,'GDBM_File',
5448: $env{'request.course.fn'}.'_parms.db',
5449: &GDBM_READER(),0640)) {
5450: $thisparm=$parmhash{$symbparm};
5451: untie(%parmhash);
5452: }
5453: if ($thisparm) { return $thisparm; }
5454: }
5455: # ------------------------------------------ fourth, look in resource metadata
5456:
5457: $spacequalifierrest=~s/\./\_/;
5458: my $filename;
5459: if (!$symbparm) { $symbparm=&symbread(); }
5460: if ($symbparm) {
5461: $filename=(&decode_symb($symbparm))[2];
5462: } else {
5463: $filename=$env{'request.filename'};
5464: }
5465: my $metadata=&metadata($filename,$spacequalifierrest);
5466: if (defined($metadata)) { return $metadata; }
5467: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
5468: if (defined($metadata)) { return $metadata; }
5469:
5470: # ---------------------------------------------- fourth, look in rest pf course
5471: if ($symbparm && defined($courseid) &&
5472: $courseid eq $env{'request.course.id'}) {
5473: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
5474: $env{'course.'.$courseid.'.domain'},
5475: 'course',
5476: ($courselevelm,$courselevel));
5477: if (defined($coursereply)) { return $coursereply; }
5478: }
5479: # ------------------------------------------------------------------ Cascade up
5480: unless ($space eq '0') {
5481: my @parts=split(/_/,$space);
5482: my $id=pop(@parts);
5483: my $part=join('_',@parts);
5484: if ($part eq '') { $part='0'; }
5485: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
5486: $symbparm,$udom,$uname,$section,1);
5487: if (defined($partgeneral)) { return $partgeneral; }
5488: }
5489: if ($recurse) { return undef; }
5490: my $pack_def=&packages_tab_default($filename,$varname);
5491: if (defined($pack_def)) { return $pack_def; }
5492:
5493: # ---------------------------------------------------- Any other user namespace
5494: } elsif ($realm eq 'environment') {
5495: # ----------------------------------------------------------------- environment
5496: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
5497: return $env{'environment.'.$spacequalifierrest};
5498: } else {
5499: my %returnhash=&userenvironment($udom,$uname,
5500: $spacequalifierrest);
5501: return $returnhash{$spacequalifierrest};
5502: }
5503: } elsif ($realm eq 'system') {
5504: # ----------------------------------------------------------------- system.time
5505: if ($space eq 'time') {
5506: return time;
5507: }
5508: } elsif ($realm eq 'server') {
5509: # ----------------------------------------------------------------- system.time
5510: if ($space eq 'name') {
5511: return $ENV{'SERVER_NAME'};
5512: }
5513: }
5514: return '';
5515: }
5516:
5517: sub check_group_parms {
5518: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
5519: my @groupitems = ();
5520: my $resultitem;
5521: my @levels = ($symbparm,$mapparm,$what);
5522: foreach my $group (@{$groups}) {
5523: foreach my $level (@levels) {
5524: my $item = $courseid.'.['.$group.'].'.$level;
5525: push(@groupitems,$item);
5526: }
5527: }
5528: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
5529: $env{'course.'.$courseid.'.domain'},
5530: 'course',@groupitems);
5531: return $coursereply;
5532: }
5533:
5534: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
5535: my ($courseid,@groups) = @_;
5536: @groups = sort(@groups);
5537: return @groups;
5538: }
5539:
5540: sub packages_tab_default {
5541: my ($uri,$varname)=@_;
5542: my (undef,$part,$name)=split(/\./,$varname);
5543:
5544: my (@extension,@specifics,$do_default);
5545: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
5546: my ($pack_type,$pack_part)=split(/_/,$package,2);
5547: if ($pack_type eq 'default') {
5548: $do_default=1;
5549: } elsif ($pack_type eq 'extension') {
5550: push(@extension,[$package,$pack_type,$pack_part]);
5551: } else {
5552: push(@specifics,[$package,$pack_type,$pack_part]);
5553: }
5554: }
5555: # first look for a package that matches the requested part id
5556: foreach my $package (@specifics) {
5557: my (undef,$pack_type,$pack_part)=@{$package};
5558: next if ($pack_part ne $part);
5559: if (defined($packagetab{"$pack_type&$name&default"})) {
5560: return $packagetab{"$pack_type&$name&default"};
5561: }
5562: }
5563: # look for any possible matching non extension_ package
5564: foreach my $package (@specifics) {
5565: my (undef,$pack_type,$pack_part)=@{$package};
5566: if (defined($packagetab{"$pack_type&$name&default"})) {
5567: return $packagetab{"$pack_type&$name&default"};
5568: }
5569: if ($pack_type eq 'part') { $pack_part='0'; }
5570: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
5571: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
5572: }
5573: }
5574: # look for any posible extension_ match
5575: foreach my $package (@extension) {
5576: my ($package,$pack_type)=@{$package};
5577: if (defined($packagetab{"$pack_type&$name&default"})) {
5578: return $packagetab{"$pack_type&$name&default"};
5579: }
5580: if (defined($packagetab{$package."&$name&default"})) {
5581: return $packagetab{$package."&$name&default"};
5582: }
5583: }
5584: # look for a global default setting
5585: if ($do_default && defined($packagetab{"default&$name&default"})) {
5586: return $packagetab{"default&$name&default"};
5587: }
5588: return undef;
5589: }
5590:
5591: sub add_prefix_and_part {
5592: my ($prefix,$part)=@_;
5593: my $keyroot;
5594: if (defined($prefix) && $prefix !~ /^__/) {
5595: # prefix that has a part already
5596: $keyroot=$prefix;
5597: } elsif (defined($prefix)) {
5598: # prefix that is missing a part
5599: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
5600: } else {
5601: # no prefix at all
5602: if (defined($part)) { $keyroot='_'.$part; }
5603: }
5604: return $keyroot;
5605: }
5606:
5607: # ---------------------------------------------------------------- Get metadata
5608:
5609: my %metaentry;
5610: sub metadata {
5611: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
5612: $uri=&declutter($uri);
5613: # if it is a non metadata possible uri return quickly
5614: if (($uri eq '') ||
5615: (($uri =~ m|^/*adm/|) &&
5616: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
5617: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
5618: ($uri =~ m|home/[^/]+/public_html/|)) {
5619: return undef;
5620: }
5621: my $filename=$uri;
5622: $uri=~s/\.meta$//;
5623: #
5624: # Is the metadata already cached?
5625: # Look at timestamp of caching
5626: # Everything is cached by the main uri, libraries are never directly cached
5627: #
5628: if (!defined($liburi)) {
5629: my ($result,$cached)=&is_cached_new('meta',$uri);
5630: if (defined($cached)) { return $result->{':'.$what}; }
5631: }
5632: {
5633: #
5634: # Is this a recursive call for a library?
5635: #
5636: # if (! exists($metacache{$uri})) {
5637: # $metacache{$uri}={};
5638: # }
5639: if ($liburi) {
5640: $liburi=&declutter($liburi);
5641: $filename=$liburi;
5642: } else {
5643: &devalidate_cache_new('meta',$uri);
5644: undef(%metaentry);
5645: }
5646: my %metathesekeys=();
5647: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
5648: my $metastring;
5649: if ($uri !~ m -^(uploaded|editupload)/-) {
5650: my $file=&filelocation('',&clutter($filename));
5651: #push(@{$metaentry{$uri.'.file'}},$file);
5652: $metastring=&getfile($file);
5653: }
5654: my $parser=HTML::LCParser->new(\$metastring);
5655: my $token;
5656: undef %metathesekeys;
5657: while ($token=$parser->get_token) {
5658: if ($token->[0] eq 'S') {
5659: if (defined($token->[2]->{'package'})) {
5660: #
5661: # This is a package - get package info
5662: #
5663: my $package=$token->[2]->{'package'};
5664: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5665: if (defined($token->[2]->{'id'})) {
5666: $keyroot.='_'.$token->[2]->{'id'};
5667: }
5668: if ($metaentry{':packages'}) {
5669: $metaentry{':packages'}.=','.$package.$keyroot;
5670: } else {
5671: $metaentry{':packages'}=$package.$keyroot;
5672: }
5673: foreach my $pack_entry (keys(%packagetab)) {
5674: my $part=$keyroot;
5675: $part=~s/^\_//;
5676: if ($pack_entry=~/^\Q$package\E\&/ ||
5677: $pack_entry=~/^\Q$package\E_0\&/) {
5678: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
5679: # ignore package.tab specified default values
5680: # here &package_tab_default() will fetch those
5681: if ($subp eq 'default') { next; }
5682: my $value=$packagetab{$pack_entry};
5683: my $unikey;
5684: if ($pack =~ /_0$/) {
5685: $unikey='parameter_0_'.$name;
5686: $part=0;
5687: } else {
5688: $unikey='parameter'.$keyroot.'_'.$name;
5689: }
5690: if ($subp eq 'display') {
5691: $value.=' [Part: '.$part.']';
5692: }
5693: $metaentry{':'.$unikey.'.part'}=$part;
5694: $metathesekeys{$unikey}=1;
5695: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5696: $metaentry{':'.$unikey.'.'.$subp}=$value;
5697: }
5698: if (defined($metaentry{':'.$unikey.'.default'})) {
5699: $metaentry{':'.$unikey}=
5700: $metaentry{':'.$unikey.'.default'};
5701: }
5702: }
5703: }
5704: } else {
5705: #
5706: # This is not a package - some other kind of start tag
5707: #
5708: my $entry=$token->[1];
5709: my $unikey;
5710: if ($entry eq 'import') {
5711: $unikey='';
5712: } else {
5713: $unikey=$entry;
5714: }
5715: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
5716:
5717: if (defined($token->[2]->{'id'})) {
5718: $unikey.='_'.$token->[2]->{'id'};
5719: }
5720:
5721: if ($entry eq 'import') {
5722: #
5723: # Importing a library here
5724: #
5725: if ($depthcount<20) {
5726: my $location=$parser->get_text('/import');
5727: my $dir=$filename;
5728: $dir=~s|[^/]*$||;
5729: $location=&filelocation($dir,$location);
5730: my $metadata =
5731: &metadata($uri,'keys', $location,$unikey,
5732: $depthcount+1);
5733: foreach my $meta (split(',',$metadata)) {
5734: $metaentry{':'.$meta}=$metaentry{':'.$meta};
5735: $metathesekeys{$meta}=1;
5736: }
5737: }
5738: } else {
5739:
5740: if (defined($token->[2]->{'name'})) {
5741: $unikey.='_'.$token->[2]->{'name'};
5742: }
5743: $metathesekeys{$unikey}=1;
5744: foreach my $param (@{$token->[3]}) {
5745: $metaentry{':'.$unikey.'.'.$param} =
5746: $token->[2]->{$param};
5747: }
5748: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
5749: my $default=$metaentry{':'.$unikey.'.default'};
5750: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
5751: # only ws inside the tag, and not in default, so use default
5752: # as value
5753: $metaentry{':'.$unikey}=$default;
5754: } else {
5755: # either something interesting inside the tag or default
5756: # uninteresting
5757: $metaentry{':'.$unikey}=$internaltext;
5758: }
5759: # end of not-a-package not-a-library import
5760: }
5761: # end of not-a-package start tag
5762: }
5763: # the next is the end of "start tag"
5764: }
5765: }
5766: my ($extension) = ($uri =~ /\.(\w+)$/);
5767: foreach my $key (keys(%packagetab)) {
5768: #no specific packages #how's our extension
5769: if ($key!~/^extension_\Q$extension\E&/) { next; }
5770: &metadata_create_package_def($uri,$key,'extension_'.$extension,
5771: \%metathesekeys);
5772: }
5773: if (!exists($metaentry{':packages'})) {
5774: foreach my $key (keys(%packagetab)) {
5775: #no specific packages well let's get default then
5776: if ($key!~/^default&/) { next; }
5777: &metadata_create_package_def($uri,$key,'default',
5778: \%metathesekeys);
5779: }
5780: }
5781: # are there custom rights to evaluate
5782: if ($metaentry{':copyright'} eq 'custom') {
5783:
5784: #
5785: # Importing a rights file here
5786: #
5787: unless ($depthcount) {
5788: my $location=$metaentry{':customdistributionfile'};
5789: my $dir=$filename;
5790: $dir=~s|[^/]*$||;
5791: $location=&filelocation($dir,$location);
5792: my $rights_metadata =
5793: &metadata($uri,'keys',$location,'_rights',
5794: $depthcount+1);
5795: foreach my $rights (split(',',$rights_metadata)) {
5796: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
5797: $metathesekeys{$rights}=1;
5798: }
5799: }
5800: }
5801: # uniqifiy package listing
5802: my %seen;
5803: my @uniq_packages =
5804: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
5805: $metaentry{':packages'} = join(',',@uniq_packages);
5806:
5807: $metaentry{':keys'} = join(',',keys(%metathesekeys));
5808: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
5809: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
5810: &do_cache_new('meta',$uri,\%metaentry,60*60);
5811: # this is the end of "was not already recently cached
5812: }
5813: return $metaentry{':'.$what};
5814: }
5815:
5816: sub metadata_create_package_def {
5817: my ($uri,$key,$package,$metathesekeys)=@_;
5818: my ($pack,$name,$subp)=split(/\&/,$key);
5819: if ($subp eq 'default') { next; }
5820:
5821: if (defined($metaentry{':packages'})) {
5822: $metaentry{':packages'}.=','.$package;
5823: } else {
5824: $metaentry{':packages'}=$package;
5825: }
5826: my $value=$packagetab{$key};
5827: my $unikey;
5828: $unikey='parameter_0_'.$name;
5829: $metaentry{':'.$unikey.'.part'}=0;
5830: $$metathesekeys{$unikey}=1;
5831: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
5832: $metaentry{':'.$unikey.'.'.$subp}=$value;
5833: }
5834: if (defined($metaentry{':'.$unikey.'.default'})) {
5835: $metaentry{':'.$unikey}=
5836: $metaentry{':'.$unikey.'.default'};
5837: }
5838: }
5839:
5840: sub metadata_generate_part0 {
5841: my ($metadata,$metacache,$uri) = @_;
5842: my %allnames;
5843: foreach my $metakey (keys(%$metadata)) {
5844: if ($metakey=~/^parameter\_(.*)/) {
5845: my $part=$$metacache{':'.$metakey.'.part'};
5846: my $name=$$metacache{':'.$metakey.'.name'};
5847: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
5848: $allnames{$name}=$part;
5849: }
5850: }
5851: }
5852: foreach my $name (keys(%allnames)) {
5853: $$metadata{"parameter_0_$name"}=1;
5854: my $key=":parameter_0_$name";
5855: $$metacache{"$key.part"}='0';
5856: $$metacache{"$key.name"}=$name;
5857: $$metacache{"$key.type"}=$$metacache{':parameter_'.
5858: $allnames{$name}.'_'.$name.
5859: '.type'};
5860: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
5861: '.display'};
5862: my $expr='[Part: '.$allnames{$name}.']';
5863: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
5864: $$metacache{"$key.display"}=$olddis;
5865: }
5866: }
5867:
5868: # ------------------------------------------------- Get the title of a resource
5869:
5870: sub gettitle {
5871: my $urlsymb=shift;
5872: my $symb=&symbread($urlsymb);
5873: if ($symb) {
5874: my $key=$env{'request.course.id'}."\0".$symb;
5875: my ($result,$cached)=&is_cached_new('title',$key);
5876: if (defined($cached)) {
5877: return $result;
5878: }
5879: my ($map,$resid,$url)=&decode_symb($symb);
5880: my $title='';
5881: my %bighash;
5882: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5883: &GDBM_READER(),0640)) {
5884: my $mapid=$bighash{'map_pc_'.&clutter($map)};
5885: $title=$bighash{'title_'.$mapid.'.'.$resid};
5886: untie %bighash;
5887: }
5888: $title=~s/\&colon\;/\:/gs;
5889: if ($title) {
5890: return &do_cache_new('title',$key,$title,600);
5891: }
5892: $urlsymb=$url;
5893: }
5894: my $title=&metadata($urlsymb,'title');
5895: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
5896: return $title;
5897: }
5898:
5899: sub get_slot {
5900: my ($which,$cnum,$cdom)=@_;
5901: if (!$cnum || !$cdom) {
5902: (undef,my $courseid)=&Apache::lonxml::whichuser();
5903: $cdom=$env{'course.'.$courseid.'.domain'};
5904: $cnum=$env{'course.'.$courseid.'.num'};
5905: }
5906: my $key=join("\0",'slots',$cdom,$cnum,$which);
5907: my %slotinfo;
5908: if (exists($remembered{$key})) {
5909: $slotinfo{$which} = $remembered{$key};
5910: } else {
5911: %slotinfo=&get('slots',[$which],$cdom,$cnum);
5912: &Apache::lonhomework::showhash(%slotinfo);
5913: my ($tmp)=keys(%slotinfo);
5914: if ($tmp=~/^error:/) { return (); }
5915: $remembered{$key} = $slotinfo{$which};
5916: }
5917: if (ref($slotinfo{$which}) eq 'HASH') {
5918: return %{$slotinfo{$which}};
5919: }
5920: return $slotinfo{$which};
5921: }
5922: # ------------------------------------------------- Update symbolic store links
5923:
5924: sub symblist {
5925: my ($mapname,%newhash)=@_;
5926: $mapname=&deversion(&declutter($mapname));
5927: my %hash;
5928: if (($env{'request.course.fn'}) && (%newhash)) {
5929: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
5930: &GDBM_WRCREAT(),0640)) {
5931: foreach my $url (keys %newhash) {
5932: next if ($url eq 'last_known'
5933: && $env{'form.no_update_last_known'});
5934: $hash{declutter($url)}=&encode_symb($mapname,
5935: $newhash{$url}->[1],
5936: $newhash{$url}->[0]);
5937: }
5938: if (untie(%hash)) {
5939: return 'ok';
5940: }
5941: }
5942: }
5943: return 'error';
5944: }
5945:
5946: # --------------------------------------------------------------- Verify a symb
5947:
5948: sub symbverify {
5949: my ($symb,$thisurl)=@_;
5950: my $thisfn=$thisurl;
5951: # wrapper not part of symbs
5952: $thisfn=~s/^\/adm\/wrapper//;
5953: $thisfn=~s/^\/adm\/coursedocs\/showdoc\///;
5954: $thisfn=&declutter($thisfn);
5955: # direct jump to resource in page or to a sequence - will construct own symbs
5956: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
5957: # check URL part
5958: my ($map,$resid,$url)=&decode_symb($symb);
5959:
5960: unless ($url eq $thisfn) { return 0; }
5961:
5962: $symb=&symbclean($symb);
5963: $thisurl=&deversion($thisurl);
5964: $thisfn=&deversion($thisfn);
5965:
5966: my %bighash;
5967: my $okay=0;
5968:
5969: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5970: &GDBM_READER(),0640)) {
5971: my $ids=$bighash{'ids_'.&clutter($thisurl)};
5972: unless ($ids) {
5973: $ids=$bighash{'ids_/'.$thisurl};
5974: }
5975: if ($ids) {
5976: # ------------------------------------------------------------------- Has ID(s)
5977: foreach (split(/\,/,$ids)) {
5978: my ($mapid,$resid)=split(/\./,$_);
5979: if (
5980: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
5981: eq $symb) {
5982: if (($env{'request.role.adv'}) ||
5983: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
5984: $okay=1;
5985: }
5986: }
5987: }
5988: }
5989: untie(%bighash);
5990: }
5991: return $okay;
5992: }
5993:
5994: # --------------------------------------------------------------- Clean-up symb
5995:
5996: sub symbclean {
5997: my $symb=shift;
5998: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
5999: # remove version from map
6000: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
6001:
6002: # remove version from URL
6003: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
6004:
6005: # remove wrapper
6006:
6007: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
6008: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
6009: return $symb;
6010: }
6011:
6012: # ---------------------------------------------- Split symb to find map and url
6013:
6014: sub encode_symb {
6015: my ($map,$resid,$url)=@_;
6016: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
6017: }
6018:
6019: sub decode_symb {
6020: my $symb=shift;
6021: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
6022: my ($map,$resid,$url)=split(/___/,$symb);
6023: return (&fixversion($map),$resid,&fixversion($url));
6024: }
6025:
6026: sub fixversion {
6027: my $fn=shift;
6028: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
6029: my %bighash;
6030: my $uri=&clutter($fn);
6031: my $key=$env{'request.course.id'}.'_'.$uri;
6032: # is this cached?
6033: my ($result,$cached)=&is_cached_new('courseresversion',$key);
6034: if (defined($cached)) { return $result; }
6035: # unfortunately not cached, or expired
6036: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6037: &GDBM_READER(),0640)) {
6038: if ($bighash{'version_'.$uri}) {
6039: my $version=$bighash{'version_'.$uri};
6040: unless (($version eq 'mostrecent') ||
6041: ($version==&getversion($uri))) {
6042: $uri=~s/\.(\w+)$/\.$version\.$1/;
6043: }
6044: }
6045: untie %bighash;
6046: }
6047: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
6048: }
6049:
6050: sub deversion {
6051: my $url=shift;
6052: $url=~s/\.\d+\.(\w+)$/\.$1/;
6053: return $url;
6054: }
6055:
6056: # ------------------------------------------------------ Return symb list entry
6057:
6058: sub symbread {
6059: my ($thisfn,$donotrecurse)=@_;
6060: my $cache_str='request.symbread.cached.'.$thisfn;
6061: if (defined($env{$cache_str})) { return $env{$cache_str}; }
6062: # no filename provided? try from environment
6063: unless ($thisfn) {
6064: if ($env{'request.symb'}) {
6065: return $env{$cache_str}=&symbclean($env{'request.symb'});
6066: }
6067: $thisfn=$env{'request.filename'};
6068: }
6069: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6070: # is that filename actually a symb? Verify, clean, and return
6071: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
6072: if (&symbverify($thisfn,$1)) {
6073: return $env{$cache_str}=&symbclean($thisfn);
6074: }
6075: }
6076: $thisfn=declutter($thisfn);
6077: my %hash;
6078: my %bighash;
6079: my $syval='';
6080: if (($env{'request.course.fn'}) && ($thisfn)) {
6081: my $targetfn = $thisfn;
6082: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
6083: $targetfn = 'adm/wrapper/'.$thisfn;
6084: }
6085: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
6086: $targetfn=$1;
6087: }
6088: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
6089: &GDBM_READER(),0640)) {
6090: $syval=$hash{$targetfn};
6091: untie(%hash);
6092: }
6093: # ---------------------------------------------------------- There was an entry
6094: if ($syval) {
6095: #unless ($syval=~/\_\d+$/) {
6096: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
6097: #&appenv('request.ambiguous' => $thisfn);
6098: #return $env{$cache_str}='';
6099: #}
6100: #$syval.=$1;
6101: #}
6102: } else {
6103: # ------------------------------------------------------- Was not in symb table
6104: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
6105: &GDBM_READER(),0640)) {
6106: # ---------------------------------------------- Get ID(s) for current resource
6107: my $ids=$bighash{'ids_'.&clutter($thisfn)};
6108: unless ($ids) {
6109: $ids=$bighash{'ids_/'.$thisfn};
6110: }
6111: unless ($ids) {
6112: # alias?
6113: $ids=$bighash{'mapalias_'.$thisfn};
6114: }
6115: if ($ids) {
6116: # ------------------------------------------------------------------- Has ID(s)
6117: my @possibilities=split(/\,/,$ids);
6118: if ($#possibilities==0) {
6119: # ----------------------------------------------- There is only one possibility
6120: my ($mapid,$resid)=split(/\./,$ids);
6121: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6122: $resid,$thisfn);
6123: } elsif (!$donotrecurse) {
6124: # ------------------------------------------ There is more than one possibility
6125: my $realpossible=0;
6126: foreach (@possibilities) {
6127: my $file=$bighash{'src_'.$_};
6128: if (&allowed('bre',$file)) {
6129: my ($mapid,$resid)=split(/\./,$_);
6130: if ($bighash{'map_type_'.$mapid} ne 'page') {
6131: $realpossible++;
6132: $syval=&encode_symb($bighash{'map_id_'.$mapid},
6133: $resid,$thisfn);
6134: }
6135: }
6136: }
6137: if ($realpossible!=1) { $syval=''; }
6138: } else {
6139: $syval='';
6140: }
6141: }
6142: untie(%bighash)
6143: }
6144: }
6145: if ($syval) {
6146: return $env{$cache_str}=$syval;
6147: }
6148: }
6149: &appenv('request.ambiguous' => $thisfn);
6150: return $env{$cache_str}='';
6151: }
6152:
6153: # ---------------------------------------------------------- Return random seed
6154:
6155: sub numval {
6156: my $txt=shift;
6157: $txt=~tr/A-J/0-9/;
6158: $txt=~tr/a-j/0-9/;
6159: $txt=~tr/K-T/0-9/;
6160: $txt=~tr/k-t/0-9/;
6161: $txt=~tr/U-Z/0-5/;
6162: $txt=~tr/u-z/0-5/;
6163: $txt=~s/\D//g;
6164: if ($_64bit) { if ($txt > 2**32) { return -1; } }
6165: return int($txt);
6166: }
6167:
6168: sub numval2 {
6169: my $txt=shift;
6170: $txt=~tr/A-J/0-9/;
6171: $txt=~tr/a-j/0-9/;
6172: $txt=~tr/K-T/0-9/;
6173: $txt=~tr/k-t/0-9/;
6174: $txt=~tr/U-Z/0-5/;
6175: $txt=~tr/u-z/0-5/;
6176: $txt=~s/\D//g;
6177: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6178: my $total;
6179: foreach my $val (@txts) { $total+=$val; }
6180: if ($_64bit) { if ($total > 2**32) { return -1; } }
6181: return int($total);
6182: }
6183:
6184: sub numval3 {
6185: use integer;
6186: my $txt=shift;
6187: $txt=~tr/A-J/0-9/;
6188: $txt=~tr/a-j/0-9/;
6189: $txt=~tr/K-T/0-9/;
6190: $txt=~tr/k-t/0-9/;
6191: $txt=~tr/U-Z/0-5/;
6192: $txt=~tr/u-z/0-5/;
6193: $txt=~s/\D//g;
6194: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
6195: my $total;
6196: foreach my $val (@txts) { $total+=$val; }
6197: if ($_64bit) { $total=(($total<<32)>>32); }
6198: return $total;
6199: }
6200:
6201: sub digest {
6202: my ($data)=@_;
6203: my $digest=&Digest::MD5::md5($data);
6204: my ($a,$b,$c,$d)=unpack("iiii",$digest);
6205: my ($e,$f);
6206: {
6207: use integer;
6208: $e=($a+$b);
6209: $f=($c+$d);
6210: if ($_64bit) {
6211: $e=(($e<<32)>>32);
6212: $f=(($f<<32)>>32);
6213: }
6214: }
6215: if (wantarray) {
6216: return ($e,$f);
6217: } else {
6218: my $g;
6219: {
6220: use integer;
6221: $g=($e+$f);
6222: if ($_64bit) {
6223: $g=(($g<<32)>>32);
6224: }
6225: }
6226: return $g;
6227: }
6228: }
6229:
6230: sub latest_rnd_algorithm_id {
6231: return '64bit5';
6232: }
6233:
6234: sub get_rand_alg {
6235: my ($courseid)=@_;
6236: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
6237: if ($courseid) {
6238: return $env{"course.$courseid.rndseed"};
6239: }
6240: return &latest_rnd_algorithm_id();
6241: }
6242:
6243: sub validCODE {
6244: my ($CODE)=@_;
6245: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
6246: return 0;
6247: }
6248:
6249: sub getCODE {
6250: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
6251: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
6252: defined($Apache::lonhomework::parsing_a_task) ) &&
6253: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
6254: return $Apache::lonhomework::history{'resource.CODE'};
6255: }
6256: return undef;
6257: }
6258:
6259: sub rndseed {
6260: my ($symb,$courseid,$domain,$username)=@_;
6261:
6262: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
6263: if (!$symb) {
6264: unless ($symb=$wsymb) { return time; }
6265: }
6266: if (!$courseid) { $courseid=$wcourseid; }
6267: if (!$domain) { $domain=$wdomain; }
6268: if (!$username) { $username=$wusername }
6269: my $which=&get_rand_alg();
6270: if (defined(&getCODE())) {
6271: if ($which eq '64bit5') {
6272: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
6273: } elsif ($which eq '64bit4') {
6274: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
6275: } else {
6276: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
6277: }
6278: } elsif ($which eq '64bit5') {
6279: return &rndseed_64bit5($symb,$courseid,$domain,$username);
6280: } elsif ($which eq '64bit4') {
6281: return &rndseed_64bit4($symb,$courseid,$domain,$username);
6282: } elsif ($which eq '64bit3') {
6283: return &rndseed_64bit3($symb,$courseid,$domain,$username);
6284: } elsif ($which eq '64bit2') {
6285: return &rndseed_64bit2($symb,$courseid,$domain,$username);
6286: } elsif ($which eq '64bit') {
6287: return &rndseed_64bit($symb,$courseid,$domain,$username);
6288: }
6289: return &rndseed_32bit($symb,$courseid,$domain,$username);
6290: }
6291:
6292: sub rndseed_32bit {
6293: my ($symb,$courseid,$domain,$username)=@_;
6294: {
6295: use integer;
6296: my $symbchck=unpack("%32C*",$symb) << 27;
6297: my $symbseed=numval($symb) << 22;
6298: my $namechck=unpack("%32C*",$username) << 17;
6299: my $nameseed=numval($username) << 12;
6300: my $domainseed=unpack("%32C*",$domain) << 7;
6301: my $courseseed=unpack("%32C*",$courseid);
6302: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
6303: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6304: #&Apache::lonxml::debug("rndseed :$num:$symb");
6305: if ($_64bit) { $num=(($num<<32)>>32); }
6306: return $num;
6307: }
6308: }
6309:
6310: sub rndseed_64bit {
6311: my ($symb,$courseid,$domain,$username)=@_;
6312: {
6313: use integer;
6314: my $symbchck=unpack("%32S*",$symb) << 21;
6315: my $symbseed=numval($symb) << 10;
6316: my $namechck=unpack("%32S*",$username);
6317:
6318: my $nameseed=numval($username) << 21;
6319: my $domainseed=unpack("%32S*",$domain) << 10;
6320: my $courseseed=unpack("%32S*",$courseid);
6321:
6322: my $num1=$symbchck+$symbseed+$namechck;
6323: my $num2=$nameseed+$domainseed+$courseseed;
6324: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6325: #&Apache::lonxml::debug("rndseed :$num:$symb");
6326: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6327: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6328: return "$num1,$num2";
6329: }
6330: }
6331:
6332: sub rndseed_64bit2 {
6333: my ($symb,$courseid,$domain,$username)=@_;
6334: {
6335: use integer;
6336: # strings need to be an even # of cahracters long, it it is odd the
6337: # last characters gets thrown away
6338: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6339: my $symbseed=numval($symb) << 10;
6340: my $namechck=unpack("%32S*",$username.' ');
6341:
6342: my $nameseed=numval($username) << 21;
6343: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6344: my $courseseed=unpack("%32S*",$courseid.' ');
6345:
6346: my $num1=$symbchck+$symbseed+$namechck;
6347: my $num2=$nameseed+$domainseed+$courseseed;
6348: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6349: #&Apache::lonxml::debug("rndseed :$num:$symb");
6350: return "$num1,$num2";
6351: }
6352: }
6353:
6354: sub rndseed_64bit3 {
6355: my ($symb,$courseid,$domain,$username)=@_;
6356: {
6357: use integer;
6358: # strings need to be an even # of cahracters long, it it is odd the
6359: # last characters gets thrown away
6360: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6361: my $symbseed=numval2($symb) << 10;
6362: my $namechck=unpack("%32S*",$username.' ');
6363:
6364: my $nameseed=numval2($username) << 21;
6365: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6366: my $courseseed=unpack("%32S*",$courseid.' ');
6367:
6368: my $num1=$symbchck+$symbseed+$namechck;
6369: my $num2=$nameseed+$domainseed+$courseseed;
6370: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6371: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6372: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6373:
6374: return "$num1:$num2";
6375: }
6376: }
6377:
6378: sub rndseed_64bit4 {
6379: my ($symb,$courseid,$domain,$username)=@_;
6380: {
6381: use integer;
6382: # strings need to be an even # of cahracters long, it it is odd the
6383: # last characters gets thrown away
6384: my $symbchck=unpack("%32S*",$symb.' ') << 21;
6385: my $symbseed=numval3($symb) << 10;
6386: my $namechck=unpack("%32S*",$username.' ');
6387:
6388: my $nameseed=numval3($username) << 21;
6389: my $domainseed=unpack("%32S*",$domain.' ') << 10;
6390: my $courseseed=unpack("%32S*",$courseid.' ');
6391:
6392: my $num1=$symbchck+$symbseed+$namechck;
6393: my $num2=$nameseed+$domainseed+$courseseed;
6394: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
6395: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
6396: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
6397:
6398: return "$num1:$num2";
6399: }
6400: }
6401:
6402: sub rndseed_64bit5 {
6403: my ($symb,$courseid,$domain,$username)=@_;
6404: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
6405: return "$num1:$num2";
6406: }
6407:
6408: sub rndseed_CODE_64bit {
6409: my ($symb,$courseid,$domain,$username)=@_;
6410: {
6411: use integer;
6412: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6413: my $symbseed=numval2($symb);
6414: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6415: my $CODEseed=numval(&getCODE());
6416: my $courseseed=unpack("%32S*",$courseid.' ');
6417: my $num1=$symbseed+$CODEchck;
6418: my $num2=$CODEseed+$courseseed+$symbchck;
6419: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6420: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6421: if ($_64bit) { $num1=(($num1<<32)>>32); }
6422: if ($_64bit) { $num2=(($num2<<32)>>32); }
6423: return "$num1:$num2";
6424: }
6425: }
6426:
6427: sub rndseed_CODE_64bit4 {
6428: my ($symb,$courseid,$domain,$username)=@_;
6429: {
6430: use integer;
6431: my $symbchck=unpack("%32S*",$symb.' ') << 16;
6432: my $symbseed=numval3($symb);
6433: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
6434: my $CODEseed=numval3(&getCODE());
6435: my $courseseed=unpack("%32S*",$courseid.' ');
6436: my $num1=$symbseed+$CODEchck;
6437: my $num2=$CODEseed+$courseseed+$symbchck;
6438: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
6439: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
6440: if ($_64bit) { $num1=(($num1<<32)>>32); }
6441: if ($_64bit) { $num2=(($num2<<32)>>32); }
6442: return "$num1:$num2";
6443: }
6444: }
6445:
6446: sub rndseed_CODE_64bit5 {
6447: my ($symb,$courseid,$domain,$username)=@_;
6448: my $code = &getCODE();
6449: my ($num1,$num2)=&digest("$symb,$courseid,$code");
6450: return "$num1:$num2";
6451: }
6452:
6453: sub setup_random_from_rndseed {
6454: my ($rndseed)=@_;
6455: if ($rndseed =~/([,:])/) {
6456: my ($num1,$num2)=split(/[,:]/,$rndseed);
6457: &Math::Random::random_set_seed(abs($num1),abs($num2));
6458: } else {
6459: &Math::Random::random_set_seed_from_phrase($rndseed);
6460: }
6461: }
6462:
6463: sub latest_receipt_algorithm_id {
6464: return 'receipt2';
6465: }
6466:
6467: sub recunique {
6468: my $fucourseid=shift;
6469: my $unique;
6470: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6471: $unique=$env{"course.$fucourseid.internal.encseed"};
6472: } else {
6473: $unique=$perlvar{'lonReceipt'};
6474: }
6475: return unpack("%32C*",$unique);
6476: }
6477:
6478: sub recprefix {
6479: my $fucourseid=shift;
6480: my $prefix;
6481: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
6482: $prefix=$env{"course.$fucourseid.internal.encpref"};
6483: } else {
6484: $prefix=$perlvar{'lonHostID'};
6485: }
6486: return unpack("%32C*",$prefix);
6487: }
6488:
6489: sub ireceipt {
6490: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
6491: my $cuname=unpack("%32C*",$funame);
6492: my $cudom=unpack("%32C*",$fudom);
6493: my $cucourseid=unpack("%32C*",$fucourseid);
6494: my $cusymb=unpack("%32C*",$fusymb);
6495: my $cunique=&recunique($fucourseid);
6496: my $cpart=unpack("%32S*",$part);
6497: my $return =&recprefix($fucourseid).'-';
6498: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
6499: $env{'request.state'} eq 'construct') {
6500: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
6501: " and ".($cpart%$cudom));
6502:
6503: $return.= ($cunique%$cuname+
6504: $cunique%$cudom+
6505: $cusymb%$cuname+
6506: $cusymb%$cudom+
6507: $cucourseid%$cuname+
6508: $cucourseid%$cudom+
6509: $cpart%$cuname+
6510: $cpart%$cudom);
6511: } else {
6512: $return.= ($cunique%$cuname+
6513: $cunique%$cudom+
6514: $cusymb%$cuname+
6515: $cusymb%$cudom+
6516: $cucourseid%$cuname+
6517: $cucourseid%$cudom);
6518: }
6519: return $return;
6520: }
6521:
6522: sub receipt {
6523: my ($part)=@_;
6524: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
6525: return &ireceipt($name,$domain,$courseid,$symb,$part);
6526: }
6527:
6528: # ------------------------------------------------------------ Serves up a file
6529: # returns either the contents of the file or
6530: # -1 if the file doesn't exist
6531: #
6532: # if the target is a file that was uploaded via DOCS,
6533: # a check will be made to see if a current copy exists on the local server,
6534: # if it does this will be served, otherwise a copy will be retrieved from
6535: # the home server for the course and stored in /home/httpd/html/userfiles on
6536: # the local server.
6537:
6538: sub getfile {
6539: my ($file) = @_;
6540: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6541: &repcopy($file);
6542: return &readfile($file);
6543: }
6544:
6545: sub repcopy_userfile {
6546: my ($file)=@_;
6547: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
6548: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
6549: my ($cdom,$cnum,$filename) =
6550: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
6551: my ($info,$rtncode);
6552: my $uri="/uploaded/$cdom/$cnum/$filename";
6553: if (-e "$file") {
6554: my @fileinfo = stat($file);
6555: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
6556: if ($lwpresp ne 'ok') {
6557: if ($rtncode eq '404') {
6558: unlink($file);
6559: }
6560: #my $ua=new LWP::UserAgent;
6561: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6562: #my $response=$ua->request($request);
6563: #if ($response->is_success()) {
6564: # return $response->content;
6565: # } else {
6566: # return -1;
6567: # }
6568: return -1;
6569: }
6570: if ($info < $fileinfo[9]) {
6571: return 'ok';
6572: }
6573: $info = '';
6574: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6575: if ($lwpresp ne 'ok') {
6576: return -1;
6577: }
6578: } else {
6579: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
6580: if ($lwpresp ne 'ok') {
6581: my $ua=new LWP::UserAgent;
6582: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
6583: my $response=$ua->request($request);
6584: if ($response->is_success()) {
6585: $info=$response->content;
6586: } else {
6587: return -1;
6588: }
6589: }
6590: my @parts = ($cdom,$cnum);
6591: if ($filename =~ m|^(.+)/[^/]+$|) {
6592: push @parts, split(/\//,$1);
6593: }
6594: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
6595: foreach my $part (@parts) {
6596: $path .= '/'.$part;
6597: if (!-e $path) {
6598: mkdir($path,0770);
6599: }
6600: }
6601: }
6602: open(FILE,">$file");
6603: print FILE $info;
6604: close(FILE);
6605: return 'ok';
6606: }
6607:
6608: sub tokenwrapper {
6609: my $uri=shift;
6610: $uri=~s|^http\://([^/]+)||;
6611: $uri=~s|^/||;
6612: $env{'user.environment'}=~/\/([^\/]+)\.id/;
6613: my $token=$1;
6614: my (undef,$udom,$uname,$file)=split('/',$uri,4);
6615: if ($udom && $uname && $file) {
6616: $file=~s|(\?\.*)*$||;
6617: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
6618: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
6619: (($uri=~/\?/)?'&':'?').'token='.$token.
6620: '&tokenissued='.$perlvar{'lonHostID'};
6621: } else {
6622: return '/adm/notfound.html';
6623: }
6624: }
6625:
6626: sub getuploaded {
6627: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
6628: $uri=~s/^\///;
6629: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
6630: my $ua=new LWP::UserAgent;
6631: my $request=new HTTP::Request($reqtype,$uri);
6632: my $response=$ua->request($request);
6633: $$rtncode = $response->code;
6634: if (! $response->is_success()) {
6635: return 'failed';
6636: }
6637: if ($reqtype eq 'HEAD') {
6638: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
6639: } elsif ($reqtype eq 'GET') {
6640: $$info = $response->content;
6641: }
6642: return 'ok';
6643: }
6644:
6645: sub readfile {
6646: my $file = shift;
6647: if ( (! -e $file ) || ($file eq '') ) { return -1; };
6648: my $fh;
6649: open($fh,"<$file");
6650: my $a='';
6651: while (<$fh>) { $a .=$_; }
6652: return $a;
6653: }
6654:
6655: sub filelocation {
6656: my ($dir,$file) = @_;
6657: my $location;
6658: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
6659:
6660: if ($file =~ m-^/adm/-) {
6661: $file=~s-^/adm/wrapper/-/-;
6662: $file=~s-^/adm/coursedocs/showdoc/-/-;
6663: }
6664: if ($file=~m:^/~:) { # is a contruction space reference
6665: $location = $file;
6666: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
6667: } elsif ($file=~m:^/home/[^/]*/public_html/:) {
6668: # is a correct contruction space reference
6669: $location = $file;
6670: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
6671: my ($udom,$uname,$filename)=
6672: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
6673: my $home=&homeserver($uname,$udom);
6674: my $is_me=0;
6675: my @ids=¤t_machine_ids();
6676: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
6677: if ($is_me) {
6678: $location=&propath($udom,$uname).
6679: '/userfiles/'.$filename;
6680: } else {
6681: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
6682: $udom.'/'.$uname.'/'.$filename;
6683: }
6684: } else {
6685: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6686: $file=~s:^/res/:/:;
6687: if ( !( $file =~ m:^/:) ) {
6688: $location = $dir. '/'.$file;
6689: } else {
6690: $location = '/home/httpd/html/res'.$file;
6691: }
6692: }
6693: $location=~s://+:/:g; # remove duplicate /
6694: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
6695: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
6696: return $location;
6697: }
6698:
6699: sub hreflocation {
6700: my ($dir,$file)=@_;
6701: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
6702: $file=filelocation($dir,$file);
6703: } elsif ($file=~m-^/adm/-) {
6704: $file=~s-^/adm/wrapper/-/-;
6705: $file=~s-^/adm/coursedocs/showdoc/-/-;
6706: }
6707: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
6708: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
6709: } elsif ($file=~m-/home/(\w+)/public_html/-) {
6710: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
6711: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
6712: $file=~s-^/home/httpd/lonUsers/([^/]*)/./././([^/]*)/userfiles/
6713: -/uploaded/$1/$2/-x;
6714: }
6715: return $file;
6716: }
6717:
6718: sub current_machine_domains {
6719: my $hostname=$hostname{$perlvar{'lonHostID'}};
6720: my @domains;
6721: while( my($id, $name) = each(%hostname)) {
6722: # &logthis("-$id-$name-$hostname-");
6723: if ($hostname eq $name) {
6724: push(@domains,$hostdom{$id});
6725: }
6726: }
6727: return @domains;
6728: }
6729:
6730: sub current_machine_ids {
6731: my $hostname=$hostname{$perlvar{'lonHostID'}};
6732: my @ids;
6733: while( my($id, $name) = each(%hostname)) {
6734: # &logthis("-$id-$name-$hostname-");
6735: if ($hostname eq $name) {
6736: push(@ids,$id);
6737: }
6738: }
6739: return @ids;
6740: }
6741:
6742: # ------------------------------------------------------------- Declutters URLs
6743:
6744: sub declutter {
6745: my $thisfn=shift;
6746: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
6747: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
6748: $thisfn=~s/^\///;
6749: $thisfn=~s|^adm/wrapper/||;
6750: $thisfn=~s|^adm/coursedocs/showdoc/||;
6751: $thisfn=~s/^res\///;
6752: $thisfn=~s/\?.+$//;
6753: return $thisfn;
6754: }
6755:
6756: # ------------------------------------------------------------- Clutter up URLs
6757:
6758: sub clutter {
6759: my $thisfn='/'.&declutter(shift);
6760: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
6761: $thisfn='/res'.$thisfn;
6762: }
6763: if ($thisfn !~m|/adm|) {
6764: if ($thisfn =~ m|/ext/|) {
6765: $thisfn='/adm/wrapper'.$thisfn;
6766: } else {
6767: my ($ext) = ($thisfn =~ /\.(\w+)$/);
6768: my $embstyle=&Apache::loncommon::fileembstyle($ext);
6769: if ($embstyle eq 'ssi'
6770: || ($embstyle eq 'hdn')
6771: || ($embstyle eq 'rat')
6772: || ($embstyle eq 'prv')
6773: || ($embstyle eq 'ign')) {
6774: #do nothing with these
6775: } elsif (($embstyle eq 'img')
6776: || ($embstyle eq 'emb')
6777: || ($embstyle eq 'wrp')) {
6778: $thisfn='/adm/wrapper'.$thisfn;
6779: } elsif ($embstyle eq 'unk'
6780: && $thisfn!~/\.(sequence|page)$/) {
6781: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
6782: } else {
6783: # &logthis("Got a blank emb style");
6784: }
6785: }
6786: }
6787: return $thisfn;
6788: }
6789:
6790: sub freeze_escape {
6791: my ($value)=@_;
6792: if (ref($value)) {
6793: $value=&nfreeze($value);
6794: return '__FROZEN__'.&escape($value);
6795: }
6796: return &escape($value);
6797: }
6798:
6799:
6800: sub thaw_unescape {
6801: my ($value)=@_;
6802: if ($value =~ /^__FROZEN__/) {
6803: substr($value,0,10,undef);
6804: $value=&unescape($value);
6805: return &thaw($value);
6806: }
6807: return &unescape($value);
6808: }
6809:
6810: sub correct_line_ends {
6811: my ($result)=@_;
6812: $$result =~s/\r\n/\n/mg;
6813: $$result =~s/\r/\n/mg;
6814: }
6815: # ================================================================ Main Program
6816:
6817: sub goodbye {
6818: &logthis("Starting Shut down");
6819: #not converted to using infrastruture and probably shouldn't be
6820: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
6821: #converted
6822: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
6823: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
6824: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
6825: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
6826: #1.1 only
6827: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
6828: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
6829: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
6830: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
6831: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
6832: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
6833: &logthis(sprintf("%-20s is %s",'hits',$hits));
6834: &flushcourselogs();
6835: &logthis("Shutting down");
6836: }
6837:
6838: BEGIN {
6839: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
6840: unless ($readit) {
6841: {
6842: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
6843: open(my $config,"</etc/httpd/conf/loncapa.conf");
6844:
6845: while (my $configline=<$config>) {
6846: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
6847: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6848: chomp($varvalue);
6849: $perlvar{$varname}=$varvalue;
6850: }
6851: }
6852: close($config);
6853: }
6854: {
6855: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
6856:
6857: while (my $configline=<$config>) {
6858: if ($configline =~ /^[^\#]*PerlSetVar/) {
6859: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
6860: chomp($varvalue);
6861: $perlvar{$varname}=$varvalue;
6862: }
6863: }
6864: close($config);
6865: }
6866:
6867: # ------------------------------------------------------------ Read domain file
6868: {
6869: %domaindescription = ();
6870: %domain_auth_def = ();
6871: %domain_auth_arg_def = ();
6872: my $fh;
6873: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
6874: while (<$fh>) {
6875: next if (/^(\#|\s*$)/);
6876: # next if /^\#/;
6877: chomp;
6878: my ($domain, $domain_description, $def_auth, $def_auth_arg,
6879: $def_lang, $city, $longi, $lati, $primary) = split(/:/,$_);
6880: $domain_auth_def{$domain}=$def_auth;
6881: $domain_auth_arg_def{$domain}=$def_auth_arg;
6882: $domaindescription{$domain}=$domain_description;
6883: $domain_lang_def{$domain}=$def_lang;
6884: $domain_city{$domain}=$city;
6885: $domain_longi{$domain}=$longi;
6886: $domain_lati{$domain}=$lati;
6887: $domain_primary{$domain}=$primary;
6888:
6889: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
6890: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
6891: }
6892: }
6893: close ($fh);
6894: }
6895:
6896:
6897: # ------------------------------------------------------------- Read hosts file
6898: {
6899: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
6900:
6901: while (my $configline=<$config>) {
6902: next if ($configline =~ /^(\#|\s*$)/);
6903: chomp($configline);
6904: my ($id,$domain,$role,$name)=split(/:/,$configline);
6905: $name=~s/\s//g;
6906: if ($id && $domain && $role && $name) {
6907: $hostname{$id}=$name;
6908: $hostdom{$id}=$domain;
6909: if ($role eq 'library') { $libserv{$id}=$name; }
6910: }
6911: }
6912: close($config);
6913: # FIXME: dev server don't want this, production servers _do_ want this
6914: #&get_iphost();
6915: }
6916:
6917: sub get_iphost {
6918: if (%iphost) { return %iphost; }
6919: my %name_to_ip;
6920: foreach my $id (keys(%hostname)) {
6921: my $name=$hostname{$id};
6922: my $ip;
6923: if (!exists($name_to_ip{$name})) {
6924: $ip = gethostbyname($name);
6925: if (!$ip || length($ip) ne 4) {
6926: &logthis("Skipping host $id name $name no IP found\n");
6927: next;
6928: }
6929: $ip=inet_ntoa($ip);
6930: $name_to_ip{$name} = $ip;
6931: } else {
6932: $ip = $name_to_ip{$name};
6933: }
6934: push(@{$iphost{$ip}},$id);
6935: }
6936: return %iphost;
6937: }
6938:
6939: # ------------------------------------------------------ Read spare server file
6940: {
6941: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
6942:
6943: while (my $configline=<$config>) {
6944: chomp($configline);
6945: if ($configline) {
6946: $spareid{$configline}=1;
6947: }
6948: }
6949: close($config);
6950: }
6951: # ------------------------------------------------------------ Read permissions
6952: {
6953: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
6954:
6955: while (my $configline=<$config>) {
6956: chomp($configline);
6957: if ($configline) {
6958: my ($role,$perm)=split(/ /,$configline);
6959: if ($perm ne '') { $pr{$role}=$perm; }
6960: }
6961: }
6962: close($config);
6963: }
6964:
6965: # -------------------------------------------- Read plain texts for permissions
6966: {
6967: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
6968:
6969: while (my $configline=<$config>) {
6970: chomp($configline);
6971: if ($configline) {
6972: my ($short,@plain)=split(/:/,$configline);
6973: %{$prp{$short}} = ();
6974: if (@plain > 0) {
6975: $prp{$short}{'std'} = $plain[0];
6976: for (my $i=1; $i<@plain; $i++) {
6977: $prp{$short}{'alt'.$i} = $plain[$i];
6978: }
6979: }
6980: }
6981: }
6982: close($config);
6983: }
6984:
6985: # ---------------------------------------------------------- Read package table
6986: {
6987: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
6988:
6989: while (my $configline=<$config>) {
6990: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
6991: chomp($configline);
6992: my ($short,$plain)=split(/:/,$configline);
6993: my ($pack,$name)=split(/\&/,$short);
6994: if ($plain ne '') {
6995: $packagetab{$pack.'&'.$name.'&name'}=$name;
6996: $packagetab{$short}=$plain;
6997: }
6998: }
6999: close($config);
7000: }
7001:
7002: # ------------- set up temporary directory
7003: {
7004: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
7005:
7006: }
7007:
7008: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
7009:
7010: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
7011: $dumpcount=0;
7012:
7013: &logtouch();
7014: &logthis('<font color="yellow">INFO: Read configuration</font>');
7015: $readit=1;
7016: {
7017: use integer;
7018: my $test=(2**32)+1;
7019: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
7020: &logthis(" Detected 64bit platform ($_64bit)");
7021: }
7022: }
7023: }
7024:
7025: 1;
7026: __END__
7027:
7028: =pod
7029:
7030: =head1 NAME
7031:
7032: Apache::lonnet - Subroutines to ask questions about things in the network.
7033:
7034: =head1 SYNOPSIS
7035:
7036: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
7037:
7038: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
7039:
7040: Common parameters:
7041:
7042: =over 4
7043:
7044: =item *
7045:
7046: $uname : an internal username (if $cname expecting a course Id specifically)
7047:
7048: =item *
7049:
7050: $udom : a domain (if $cdom expecting a course's domain specifically)
7051:
7052: =item *
7053:
7054: $symb : a resource instance identifier
7055:
7056: =item *
7057:
7058: $namespace : the name of a .db file that contains the data needed or
7059: being set.
7060:
7061: =back
7062:
7063: =head1 OVERVIEW
7064:
7065: lonnet provides subroutines which interact with the
7066: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
7067: about classes, users, and resources.
7068:
7069: For many of these objects you can also use this to store data about
7070: them or modify them in various ways.
7071:
7072: =head2 Symbs
7073:
7074: To identify a specific instance of a resource, LON-CAPA uses symbols
7075: or "symbs"X<symb>. These identifiers are built from the URL of the
7076: map, the resource number of the resource in the map, and the URL of
7077: the resource itself. The latter is somewhat redundant, but might help
7078: if maps change.
7079:
7080: An example is
7081:
7082: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
7083:
7084: The respective map entry is
7085:
7086: <resource id="19" src="/res/msu/korte/tests/part12.problem"
7087: title="Problem 2">
7088: </resource>
7089:
7090: Symbs are used by the random number generator, as well as to store and
7091: restore data specific to a certain instance of for example a problem.
7092:
7093: =head2 Storing And Retrieving Data
7094:
7095: X<store()>X<cstore()>X<restore()>Three of the most important functions
7096: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
7097: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
7098: is is the non-critical message twin of cstore. These functions are for
7099: handlers to store a perl hash to a user's permanent data space in an
7100: easy manner, and to retrieve it again on another call. It is expected
7101: that a handler would use this once at the beginning to retrieve data,
7102: and then again once at the end to send only the new data back.
7103:
7104: The data is stored in the user's data directory on the user's
7105: homeserver under the ID of the course.
7106:
7107: The hash that is returned by restore will have all of the previous
7108: value for all of the elements of the hash.
7109:
7110: Example:
7111:
7112: #creating a hash
7113: my %hash;
7114: $hash{'foo'}='bar';
7115:
7116: #storing it
7117: &Apache::lonnet::cstore(\%hash);
7118:
7119: #changing a value
7120: $hash{'foo'}='notbar';
7121:
7122: #adding a new value
7123: $hash{'bar'}='foo';
7124: &Apache::lonnet::cstore(\%hash);
7125:
7126: #retrieving the hash
7127: my %history=&Apache::lonnet::restore();
7128:
7129: #print the hash
7130: foreach my $key (sort(keys(%history))) {
7131: print("\%history{$key} = $history{$key}");
7132: }
7133:
7134: Will print out:
7135:
7136: %history{1:foo} = bar
7137: %history{1:keys} = foo:timestamp
7138: %history{1:timestamp} = 990455579
7139: %history{2:bar} = foo
7140: %history{2:foo} = notbar
7141: %history{2:keys} = foo:bar:timestamp
7142: %history{2:timestamp} = 990455580
7143: %history{bar} = foo
7144: %history{foo} = notbar
7145: %history{timestamp} = 990455580
7146: %history{version} = 2
7147:
7148: Note that the special hash entries C<keys>, C<version> and
7149: C<timestamp> were added to the hash. C<version> will be equal to the
7150: total number of versions of the data that have been stored. The
7151: C<timestamp> attribute will be the UNIX time the hash was
7152: stored. C<keys> is available in every historical section to list which
7153: keys were added or changed at a specific historical revision of a
7154: hash.
7155:
7156: B<Warning>: do not store the hash that restore returns directly. This
7157: will cause a mess since it will restore the historical keys as if the
7158: were new keys. I.E. 1:foo will become 1:1:foo etc.
7159:
7160: Calling convention:
7161:
7162: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
7163: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
7164:
7165: For more detailed information, see lonnet specific documentation.
7166:
7167: =head1 RETURN MESSAGES
7168:
7169: =over 4
7170:
7171: =item * B<con_lost>: unable to contact remote host
7172:
7173: =item * B<con_delayed>: unable to contact remote host, message will be delivered
7174: when the connection is brought back up
7175:
7176: =item * B<con_failed>: unable to contact remote host and unable to save message
7177: for later delivery
7178:
7179: =item * B<error:>: an error a occured, a description of the error follows the :
7180:
7181: =item * B<no_such_host>: unable to fund a host associated with the user/domain
7182: that was requested
7183:
7184: =back
7185:
7186: =head1 PUBLIC SUBROUTINES
7187:
7188: =head2 Session Environment Functions
7189:
7190: =over 4
7191:
7192: =item *
7193: X<appenv()>
7194: B<appenv(%hash)>: the value of %hash is written to
7195: the user envirnoment file, and will be restored for each access this
7196: user makes during this session, also modifies the %env for the current
7197: process
7198:
7199: =item *
7200: X<delenv()>
7201: B<delenv($regexp)>: removes all items from the session
7202: environment file that matches the regular expression in $regexp. The
7203: values are also delted from the current processes %env.
7204:
7205: =back
7206:
7207: =head2 User Information
7208:
7209: =over 4
7210:
7211: =item *
7212: X<queryauthenticate()>
7213: B<queryauthenticate($uname,$udom)>: try to determine user's current
7214: authentication scheme
7215:
7216: =item *
7217: X<authenticate()>
7218: B<authenticate($uname,$upass,$udom)>: try to
7219: authenticate user from domain's lib servers (first use the current
7220: one). C<$upass> should be the users password.
7221:
7222: =item *
7223: X<homeserver()>
7224: B<homeserver($uname,$udom)>: find the server which has
7225: the user's directory and files (there must be only one), this caches
7226: the answer, and also caches if there is a borken connection.
7227:
7228: =item *
7229: X<idget()>
7230: B<idget($udom,@ids)>: find the usernames behind a list of IDs
7231: (IDs are a unique resource in a domain, there must be only 1 ID per
7232: username, and only 1 username per ID in a specific domain) (returns
7233: hash: id=>name,id=>name)
7234:
7235: =item *
7236: X<idrget()>
7237: B<idrget($udom,@unames)>: find the IDs behind a list of
7238: usernames (returns hash: name=>id,name=>id)
7239:
7240: =item *
7241: X<idput()>
7242: B<idput($udom,%ids)>: store away a list of names and associated IDs
7243:
7244: =item *
7245: X<rolesinit()>
7246: B<rolesinit($udom,$username,$authhost)>: get user privileges
7247:
7248: =item *
7249: X<getsection()>
7250: B<getsection($udom,$uname,$cname)>: finds the section of student in the
7251: course $cname, return section name/number or '' for "not in course"
7252: and '-1' for "no section"
7253:
7254: =item *
7255: X<userenvironment()>
7256: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
7257: passed in @what from the requested user's environment, returns a hash
7258:
7259: =back
7260:
7261: =head2 User Roles
7262:
7263: =over 4
7264:
7265: =item *
7266:
7267: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
7268: actions
7269: F: full access
7270: U,I,K: authentication modes (cxx only)
7271: '': forbidden
7272: 1: user needs to choose course
7273: 2: browse allowed
7274:
7275: =item *
7276:
7277: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
7278: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
7279: and course level
7280:
7281: =item *
7282:
7283: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
7284: explanation of a user role term
7285:
7286: =back
7287:
7288: =head2 User Modification
7289:
7290: =over 4
7291:
7292: =item *
7293:
7294: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
7295: user for the level given by URL. Optional start and end dates (leave empty
7296: string or zero for "no date")
7297:
7298: =item *
7299:
7300: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
7301: change a users, password, possible return values are: ok,
7302: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
7303: refused
7304:
7305: =item *
7306:
7307: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
7308:
7309: =item *
7310:
7311: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
7312: modify user
7313:
7314: =item *
7315:
7316: modifystudent
7317:
7318: modify a students enrollment and identification information.
7319: The course id is resolved based on the current users environment.
7320: This means the envoking user must be a course coordinator or otherwise
7321: associated with a course.
7322:
7323: This call is essentially a wrapper for lonnet::modifyuser and
7324: lonnet::modify_student_enrollment
7325:
7326: Inputs:
7327:
7328: =over 4
7329:
7330: =item B<$udom> Students loncapa domain
7331:
7332: =item B<$uname> Students loncapa login name
7333:
7334: =item B<$uid> Students id/student number
7335:
7336: =item B<$umode> Students authentication mode
7337:
7338: =item B<$upass> Students password
7339:
7340: =item B<$first> Students first name
7341:
7342: =item B<$middle> Students middle name
7343:
7344: =item B<$last> Students last name
7345:
7346: =item B<$gene> Students generation
7347:
7348: =item B<$usec> Students section in course
7349:
7350: =item B<$end> Unix time of the roles expiration
7351:
7352: =item B<$start> Unix time of the roles start date
7353:
7354: =item B<$forceid> If defined, allow $uid to be changed
7355:
7356: =item B<$desiredhome> server to use as home server for student
7357:
7358: =back
7359:
7360: =item *
7361:
7362: modify_student_enrollment
7363:
7364: Change a students enrollment status in a class. The environment variable
7365: 'role.request.course' must be defined for this function to proceed.
7366:
7367: Inputs:
7368:
7369: =over 4
7370:
7371: =item $udom, students domain
7372:
7373: =item $uname, students name
7374:
7375: =item $uid, students user id
7376:
7377: =item $first, students first name
7378:
7379: =item $middle
7380:
7381: =item $last
7382:
7383: =item $gene
7384:
7385: =item $usec
7386:
7387: =item $end
7388:
7389: =item $start
7390:
7391: =back
7392:
7393:
7394: =item *
7395:
7396: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
7397: custom role; give a custom role to a user for the level given by URL. Specify
7398: name and domain of role author, and role name
7399:
7400: =item *
7401:
7402: revokerole($udom,$uname,$url,$role) : revoke a role for url
7403:
7404: =item *
7405:
7406: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
7407:
7408: =back
7409:
7410: =head2 Course Infomation
7411:
7412: =over 4
7413:
7414: =item *
7415:
7416: coursedescription($courseid) : returns a hash of information about the
7417: specified course id, including all environment settings for the
7418: course, the description of the course will be in the hash under the
7419: key 'description'
7420:
7421: =item *
7422:
7423: resdata($name,$domain,$type,@which) : request for current parameter
7424: setting for a specific $type, where $type is either 'course' or 'user',
7425: @what should be a list of parameters to ask about. This routine caches
7426: answers for 5 minutes.
7427:
7428: =back
7429:
7430: =head2 Course Modification
7431:
7432: =over 4
7433:
7434: =item *
7435:
7436: writecoursepref($courseid,%prefs) : write preferences (environment
7437: database) for a course
7438:
7439: =item *
7440:
7441: createcourse($udom,$description,$url) : make/modify course
7442:
7443: =back
7444:
7445: =head2 Resource Subroutines
7446:
7447: =over 4
7448:
7449: =item *
7450:
7451: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
7452:
7453: =item *
7454:
7455: repcopy($filename) : subscribes to the requested file, and attempts to
7456: replicate from the owning library server, Might return
7457: 'unavailable', 'not_found', 'forbidden', 'ok', or
7458: 'bad_request', also attempts to grab the metadata for the
7459: resource. Expects the local filesystem pathname
7460: (/home/httpd/html/res/....)
7461:
7462: =back
7463:
7464: =head2 Resource Information
7465:
7466: =over 4
7467:
7468: =item *
7469:
7470: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
7471: a vairety of different possible values, $varname should be a request
7472: string, and the other parameters can be used to specify who and what
7473: one is asking about.
7474:
7475: Possible values for $varname are environment.lastname (or other item
7476: from the envirnment hash), user.name (or someother aspect about the
7477: user), resource.0.maxtries (or some other part and parameter of a
7478: resource)
7479:
7480: =item *
7481:
7482: directcondval($number) : get current value of a condition; reads from a state
7483: string
7484:
7485: =item *
7486:
7487: condval($condidx) : value of condition index based on state
7488:
7489: =item *
7490:
7491: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
7492: resource's metadata, $what should be either a specific key, or either
7493: 'keys' (to get a list of possible keys) or 'packages' to get a list of
7494: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
7495:
7496: this function automatically caches all requests
7497:
7498: =item *
7499:
7500: metadata_query($query,$custom,$customshow) : make a metadata query against the
7501: network of library servers; returns file handle of where SQL and regex results
7502: will be stored for query
7503:
7504: =item *
7505:
7506: symbread($filename) : return symbolic list entry (filename argument optional);
7507: returns the data handle
7508:
7509: =item *
7510:
7511: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
7512: a possible symb for the URL in $thisfn, and if is an encryypted
7513: resource that the user accessed using /enc/ returns a 1 on success, 0
7514: on failure, user must be in a course, as it assumes the existance of
7515: the course initial hash, and uses $env('request.course.id'}
7516:
7517:
7518: =item *
7519:
7520: symbclean($symb) : removes versions numbers from a symb, returns the
7521: cleaned symb
7522:
7523: =item *
7524:
7525: is_on_map($uri) : checks if the $uri is somewhere on the current
7526: course map, user must be in a course for it to work.
7527:
7528: =item *
7529:
7530: numval($salt) : return random seed value (addend for rndseed)
7531:
7532: =item *
7533:
7534: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
7535: a random seed, all arguments are optional, if they aren't sent it uses the
7536: environment to derive them. Note: if symb isn't sent and it can't get one
7537: from &symbread it will use the current time as its return value
7538:
7539: =item *
7540:
7541: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
7542: unfakeable, receipt
7543:
7544: =item *
7545:
7546: receipt() : API to ireceipt working off of env values; given out to users
7547:
7548: =item *
7549:
7550: countacc($url) : count the number of accesses to a given URL
7551:
7552: =item *
7553:
7554: 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
7555:
7556: =item *
7557:
7558: 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)
7559:
7560: =item *
7561:
7562: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
7563:
7564: =item *
7565:
7566: devalidate($symb) : devalidate temporary spreadsheet calculations,
7567: forcing spreadsheet to reevaluate the resource scores next time.
7568:
7569: =back
7570:
7571: =head2 Storing/Retreiving Data
7572:
7573: =over 4
7574:
7575: =item *
7576:
7577: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
7578: for this url; hashref needs to be given and should be a \%hashname; the
7579: remaining args aren't required and if they aren't passed or are '' they will
7580: be derived from the env
7581:
7582: =item *
7583:
7584: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
7585: uses critical subroutine
7586:
7587: =item *
7588:
7589: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
7590: all args are optional
7591:
7592: =item *
7593:
7594: dumpstore($namespace,$udom,$uname,$regexp,$range) :
7595: dumps the complete (or key matching regexp) namespace into a hash
7596: ($udom, $uname, $regexp, $range are optional) for a namespace that is
7597: normally &store()ed into
7598:
7599: $range should be either an integer '100' (give me the first 100
7600: matching records)
7601: or be two integers sperated by a - with no spaces
7602: '30-50' (give me the 30th through the 50th matching
7603: records)
7604:
7605:
7606: =item *
7607:
7608: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
7609: replaces a &store() version of data with a replacement set of data
7610: for a particular resource in a namespace passed in the $storehash hash
7611: reference
7612:
7613: =item *
7614:
7615: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
7616: works very similar to store/cstore, but all data is stored in a
7617: temporary location and can be reset using tmpreset, $storehash should
7618: be a hash reference, returns nothing on success
7619:
7620: =item *
7621:
7622: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
7623: similar to restore, but all data is stored in a temporary location and
7624: can be reset using tmpreset. Returns a hash of values on success,
7625: error string otherwise.
7626:
7627: =item *
7628:
7629: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
7630: deltes all keys for $symb form the temporary storage hash.
7631:
7632: =item *
7633:
7634: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7635: reference filled in from namesp ($udom and $uname are optional)
7636:
7637: =item *
7638:
7639: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
7640: namesp ($udom and $uname are optional)
7641:
7642: =item *
7643:
7644: dump($namespace,$udom,$uname,$regexp,$range) :
7645: dumps the complete (or key matching regexp) namespace into a hash
7646: ($udom, $uname, $regexp, $range are optional)
7647:
7648: $range should be either an integer '100' (give me the first 100
7649: matching records)
7650: or be two integers sperated by a - with no spaces
7651: '30-50' (give me the 30th through the 50th matching
7652: records)
7653: =item *
7654:
7655: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
7656: $store can be a scalar, an array reference, or if the amount to be
7657: incremented is > 1, a hash reference.
7658:
7659: ($udom and $uname are optional)
7660:
7661: =item *
7662:
7663: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
7664: ($udom and $uname are optional)
7665:
7666: =item *
7667:
7668: cput($namespace,$storehash,$udom,$uname) : critical put
7669: ($udom and $uname are optional)
7670:
7671: =item *
7672:
7673: newput($namespace,$storehash,$udom,$uname) :
7674:
7675: Attempts to store the items in the $storehash, but only if they don't
7676: currently exist, if this succeeds you can be certain that you have
7677: successfully created a new key value pair in the $namespace db.
7678:
7679:
7680: Args:
7681: $namespace: name of database to store values to
7682: $storehash: hashref to store to the db
7683: $udom: (optional) domain of user containing the db
7684: $uname: (optional) name of user caontaining the db
7685:
7686: Returns:
7687: 'ok' -> succeeded in storing all keys of $storehash
7688: 'key_exists: <key>' -> failed to anything out of $storehash, as at
7689: least <key> already existed in the db (other
7690: requested keys may also already exist)
7691: 'error: <msg>' -> unable to tie the DB or other erorr occured
7692: 'con_lost' -> unable to contact request server
7693: 'refused' -> action was not allowed by remote machine
7694:
7695:
7696: =item *
7697:
7698: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
7699: reference filled in from namesp (encrypts the return communication)
7700: ($udom and $uname are optional)
7701:
7702: =item *
7703:
7704: log($udom,$name,$home,$message) : write to permanent log for user; use
7705: critical subroutine
7706:
7707: =back
7708:
7709: =head2 Network Status Functions
7710:
7711: =over 4
7712:
7713: =item *
7714:
7715: dirlist($uri) : return directory list based on URI
7716:
7717: =item *
7718:
7719: spareserver() : find server with least workload from spare.tab
7720:
7721: =back
7722:
7723: =head2 Apache Request
7724:
7725: =over 4
7726:
7727: =item *
7728:
7729: ssi($url,%hash) : server side include, does a complete request cycle on url to
7730: localhost, posts hash
7731:
7732: =back
7733:
7734: =head2 Data to String to Data
7735:
7736: =over 4
7737:
7738: =item *
7739:
7740: hash2str(%hash) : convert a hash into a string complete with escaping and '='
7741: and '&' separators, supports elements that are arrayrefs and hashrefs
7742:
7743: =item *
7744:
7745: hashref2str($hashref) : convert a hashref into a string complete with
7746: escaping and '=' and '&' separators, supports elements that are
7747: arrayrefs and hashrefs
7748:
7749: =item *
7750:
7751: arrayref2str($arrayref) : convert an arrayref into a string complete
7752: with escaping and '&' separators, supports elements that are arrayrefs
7753: and hashrefs
7754:
7755: =item *
7756:
7757: str2hash($string) : convert string to hash using unescaping and
7758: splitting on '=' and '&', supports elements that are arrayrefs and
7759: hashrefs
7760:
7761: =item *
7762:
7763: str2array($string) : convert string to hash using unescaping and
7764: splitting on '&', supports elements that are arrayrefs and hashrefs
7765:
7766: =back
7767:
7768: =head2 Logging Routines
7769:
7770: =over 4
7771:
7772: These routines allow one to make log messages in the lonnet.log and
7773: lonnet.perm logfiles.
7774:
7775: =item *
7776:
7777: logtouch() : make sure the logfile, lonnet.log, exists
7778:
7779: =item *
7780:
7781: logthis() : append message to the normal lonnet.log file, it gets
7782: preiodically rolled over and deleted.
7783:
7784: =item *
7785:
7786: logperm() : append a permanent message to lonnet.perm.log, this log
7787: file never gets deleted by any automated portion of the system, only
7788: messages of critical importance should go in here.
7789:
7790: =back
7791:
7792: =head2 General File Helper Routines
7793:
7794: =over 4
7795:
7796: =item *
7797:
7798: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
7799: (a) files in /uploaded
7800: (i) If a local copy of the file exists -
7801: compares modification date of local copy with last-modified date for
7802: definitive version stored on home server for course. If local copy is
7803: stale, requests a new version from the home server and stores it.
7804: If the original has been removed from the home server, then local copy
7805: is unlinked.
7806: (ii) If local copy does not exist -
7807: requests the file from the home server and stores it.
7808:
7809: If $caller is 'uploadrep':
7810: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
7811: for request for files originally uploaded via DOCS.
7812: - returns 'ok' if fresh local copy now available, -1 otherwise.
7813:
7814: Otherwise:
7815: This indicates a call from the content generation phase of the request.
7816: - returns the entire contents of the file or -1.
7817:
7818: (b) files in /res
7819: - returns the entire contents of a file or -1;
7820: it properly subscribes to and replicates the file if neccessary.
7821:
7822:
7823: =item *
7824:
7825: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
7826: reference
7827:
7828: returns either a stat() list of data about the file or an empty list
7829: if the file doesn't exist or couldn't find out about it (connection
7830: problems or user unknown)
7831:
7832: =item *
7833:
7834: filelocation($dir,$file) : returns file system location of a file
7835: based on URI; meant to be "fairly clean" absolute reference, $dir is a
7836: directory that relative $file lookups are to looked in ($dir of /a/dir
7837: and a file of ../bob will become /a/bob)
7838:
7839: =item *
7840:
7841: hreflocation($dir,$file) : returns file system location or a URL; same as
7842: filelocation except for hrefs
7843:
7844: =item *
7845:
7846: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
7847:
7848: =back
7849:
7850: =head2 Usererfile file routines (/uploaded*)
7851:
7852: =over 4
7853:
7854: =item *
7855:
7856: userfileupload(): main rotine for putting a file in a user or course's
7857: filespace, arguments are,
7858:
7859: formname - required - this is the name of the element in $env where the
7860: filename, and the contents of the file to create/modifed exist
7861: the filename is in $env{'form.'.$formname.'.filename'} and the
7862: contents of the file is located in $env{'form.'.$formname}
7863: coursedoc - if true, store the file in the course of the active role
7864: of the current user
7865: subdir - required - subdirectory to put the file in under ../userfiles/
7866: if undefined, it will be placed in "unknown"
7867:
7868: (This routine calls clean_filename() to remove any dangerous
7869: characters from the filename, and then calls finuserfileupload() to
7870: complete the transaction)
7871:
7872: returns either the url of the uploaded file (/uploaded/....) if successful
7873: and /adm/notfound.html if unsuccessful
7874:
7875: =item *
7876:
7877: clean_filename(): routine for cleaing a filename up for storage in
7878: userfile space, argument is:
7879:
7880: filename - proposed filename
7881:
7882: returns: the new clean filename
7883:
7884: =item *
7885:
7886: finishuserfileupload(): routine that creaes and sends the file to
7887: userspace, probably shouldn't be called directly
7888:
7889: docuname: username or courseid of destination for the file
7890: docudom: domain of user/course of destination for the file
7891: formname: same as for userfileupload()
7892: fname: filename (inculding subdirectories) for the file
7893:
7894: returns either the url of the uploaded file (/uploaded/....) if successful
7895: and /adm/notfound.html if unsuccessful
7896:
7897: =item *
7898:
7899: renameuserfile(): renames an existing userfile to a new name
7900:
7901: Args:
7902: docuname: username or courseid of destination for the file
7903: docudom: domain of user/course of destination for the file
7904: old: current file name (including any subdirs under userfiles)
7905: new: desired file name (including any subdirs under userfiles)
7906:
7907: =item *
7908:
7909: mkdiruserfile(): creates a directory is a userfiles dir
7910:
7911: Args:
7912: docuname: username or courseid of destination for the file
7913: docudom: domain of user/course of destination for the file
7914: dir: dir to create (including any subdirs under userfiles)
7915:
7916: =item *
7917:
7918: removeuserfile(): removes a file that exists in userfiles
7919:
7920: Args:
7921: docuname: username or courseid of destination for the file
7922: docudom: domain of user/course of destination for the file
7923: fname: filname to delete (including any subdirs under userfiles)
7924:
7925: =item *
7926:
7927: removeuploadedurl(): convience function for removeuserfile()
7928:
7929: Args:
7930: url: a full /uploaded/... url to delete
7931:
7932: =item *
7933:
7934: get_portfile_permissions():
7935: Args:
7936: domain: domain of user or course contain the portfolio files
7937: user: name of user or num of course contain the portfolio files
7938: Returns:
7939: hashref of a dump of the proper file_permissions.db
7940:
7941:
7942: =item *
7943:
7944: get_access_controls():
7945:
7946: Args:
7947: current_permissions: the hash ref returned from get_portfile_permissions()
7948: group: (optional) the group you want the files associated with
7949: file: (optional) the file you want access info on
7950:
7951: Returns:
7952: a hash (keys are file names) of hashes containing
7953: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
7954: values are XML containing access control settings (see below)
7955:
7956: Internal notes:
7957:
7958: access controls are stored in file_permissions.db as key=value pairs.
7959: key -> path to file/file_name\0uniqueID:scope_end_start
7960: where scope -> public,guest,course,group,domains or users.
7961: end -> UNIX time for end of access (0 -> no end date)
7962: start -> UNIX time for start of access
7963:
7964: value -> XML description of access control
7965: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
7966: <start></start>
7967: <end></end>
7968:
7969: <password></password> for scope type = guest
7970:
7971: <domain></domain> for scope type = course or group
7972: <number></number>
7973: <roles id="">
7974: <role></role>
7975: <access></access>
7976: <section></section>
7977: <group></group>
7978: </roles>
7979:
7980: <dom></dom> for scope type = domains
7981:
7982: <users> for scope type = users
7983: <user>
7984: <uname></uname>
7985: <udom></udom>
7986: </user>
7987: </users>
7988: </scope>
7989:
7990: Access data is also aggregated for each file in an additional key=value pair:
7991: key -> path to file/file_name\0accesscontrol
7992: value -> reference to hash
7993: hash contains key = value pairs
7994: where key = uniqueID:scope_end_start
7995: value = UNIX time record was last updated
7996:
7997: Used to improve speed of look-ups of access controls for each file.
7998:
7999: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
8000:
8001: parse_access_controls():
8002:
8003: Parses XML of an access control record
8004: Args
8005: 1. Text string (XML) of access comtrol record
8006:
8007: Returns:
8008: 1. Hash of access control settings.
8009:
8010: modify_access_controls():
8011:
8012: Modifies access controls for a portfolio file
8013: Args
8014: 1. file name
8015: 2. reference to hash of required changes,
8016: 3. domain
8017: 4. username
8018: where domain,username are the domain of the portfolio owner
8019: (either a user or a course)
8020:
8021: Returns:
8022: 1. result of additions or updates ('ok' or 'error', with error message).
8023: 2. result of deletions ('ok' or 'error', with error message).
8024: 3. reference to hash of any new or updated access controls.
8025: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
8026: key = integer (inbound ID)
8027: value = uniqueID
8028:
8029: =back
8030:
8031: =head2 HTTP Helper Routines
8032:
8033: =over 4
8034:
8035: =item *
8036:
8037: escape() : unpack non-word characters into CGI-compatible hex codes
8038:
8039: =item *
8040:
8041: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
8042:
8043: =back
8044:
8045: =head1 PRIVATE SUBROUTINES
8046:
8047: =head2 Underlying communication routines (Shouldn't call)
8048:
8049: =over 4
8050:
8051: =item *
8052:
8053: subreply() : tries to pass a message to lonc, returns con_lost if incapable
8054:
8055: =item *
8056:
8057: reply() : uses subreply to send a message to remote machine, logs all failures
8058:
8059: =item *
8060:
8061: critical() : passes a critical message to another server; if cannot
8062: get through then place message in connection buffer directory and
8063: returns con_delayed, if incapable of saving message, returns
8064: con_failed
8065:
8066: =item *
8067:
8068: reconlonc() : tries to reconnect lonc client processes.
8069:
8070: =back
8071:
8072: =head2 Resource Access Logging
8073:
8074: =over 4
8075:
8076: =item *
8077:
8078: flushcourselogs() : flush (save) buffer logs and access logs
8079:
8080: =item *
8081:
8082: courselog($what) : save message for course in hash
8083:
8084: =item *
8085:
8086: courseacclog($what) : save message for course using &courselog(). Perform
8087: special processing for specific resource types (problems, exams, quizzes, etc).
8088:
8089: =item *
8090:
8091: goodbye() : flush course logs and log shutting down; it is called in srm.conf
8092: as a PerlChildExitHandler
8093:
8094: =back
8095:
8096: =head2 Other
8097:
8098: =over 4
8099:
8100: =item *
8101:
8102: symblist($mapname,%newhash) : update symbolic storage links
8103:
8104: =back
8105:
8106: =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