1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.639 2005/06/17 16:48:13 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 $processmarker $dumpcount
41: %coursedombuf %coursenumbuf %coursehombuf %coursedescrbuf %courseinstcodebuf %courseownerbuf
42: %domaindescription %domain_auth_def %domain_auth_arg_def
43: %domain_lang_def %domain_city %domain_longi %domain_lati $tmpdir $_64bit
44: %env);
45:
46: use IO::Socket;
47: use GDBM_File;
48: use Apache::Constants qw(:common :http);
49: use HTML::LCParser;
50: use HTML::Parser;
51: use Fcntl qw(:flock);
52: use Apache::lonlocal;
53: use Storable qw(lock_store lock_nstore lock_retrieve freeze thaw nfreeze);
54: use Time::HiRes qw( gettimeofday tv_interval );
55: use Cache::Memcached;
56: my $readit;
57: my $max_connection_retries = 10; # Or some such value.
58:
59: require Exporter;
60:
61: our @ISA = qw (Exporter);
62: our @EXPORT = qw(%env);
63:
64: =pod
65:
66: =head1 Package Variables
67:
68: These are largely undocumented, so if you decipher one please note it here.
69:
70: =over 4
71:
72: =item $processmarker
73:
74: Contains the time this process was started and this servers host id.
75:
76: =item $dumpcount
77:
78: Counts the number of times a message log flush has been attempted (regardless
79: of success) by this process. Used as part of the filename when messages are
80: delayed.
81:
82: =back
83:
84: =cut
85:
86:
87: # --------------------------------------------------------------------- Logging
88:
89: sub logtouch {
90: my $execdir=$perlvar{'lonDaemons'};
91: unless (-e "$execdir/logs/lonnet.log") {
92: open(my $fh,">>$execdir/logs/lonnet.log");
93: close $fh;
94: }
95: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
96: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
97: }
98:
99: sub logthis {
100: my $message=shift;
101: my $execdir=$perlvar{'lonDaemons'};
102: my $now=time;
103: my $local=localtime($now);
104: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
105: print $fh "$local ($$): $message\n";
106: close($fh);
107: }
108: return 1;
109: }
110:
111: sub logperm {
112: my $message=shift;
113: my $execdir=$perlvar{'lonDaemons'};
114: my $now=time;
115: my $local=localtime($now);
116: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
117: print $fh "$now:$message:$local\n";
118: close($fh);
119: }
120: return 1;
121: }
122:
123: # -------------------------------------------------- Non-critical communication
124: sub subreply {
125: my ($cmd,$server)=@_;
126: my $peerfile="$perlvar{'lonSockDir'}/$server";
127: #
128: # With loncnew process trimming, there's a timing hole between lonc server
129: # process exit and the master server picking up the listen on the AF_UNIX
130: # socket. In that time interval, a lock file will exist:
131:
132: my $lockfile=$peerfile.".lock";
133: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
134: sleep(1);
135: }
136: # At this point, either a loncnew parent is listening or an old lonc
137: # or loncnew child is listening so we can connect or everything's dead.
138: #
139: # We'll give the connection a few tries before abandoning it. If
140: # connection is not possible, we'll con_lost back to the client.
141: #
142: my $client;
143: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
144: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
145: Type => SOCK_STREAM,
146: Timeout => 10);
147: if($client) {
148: last; # Connected!
149: }
150: sleep(1); # Try again later if failed connection.
151: }
152: my $answer;
153: if ($client) {
154: print $client "$cmd\n";
155: $answer=<$client>;
156: if (!$answer) { $answer="con_lost"; }
157: chomp($answer);
158: } else {
159: $answer = 'con_lost'; # Failed connection.
160: }
161: return $answer;
162: }
163:
164: sub reply {
165: my ($cmd,$server)=@_;
166: unless (defined($hostname{$server})) { return 'no_such_host'; }
167: my $answer=subreply($cmd,$server);
168: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
169: &logthis("<font color=blue>WARNING:".
170: " $cmd to $server returned $answer</font>");
171: }
172: return $answer;
173: }
174:
175: # ----------------------------------------------------------- Send USR1 to lonc
176:
177: sub reconlonc {
178: my $peerfile=shift;
179: &logthis("Trying to reconnect for $peerfile");
180: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
181: if (open(my $fh,"<$loncfile")) {
182: my $loncpid=<$fh>;
183: chomp($loncpid);
184: if (kill 0 => $loncpid) {
185: &logthis("lonc at pid $loncpid responding, sending USR1");
186: kill USR1 => $loncpid;
187: sleep 1;
188: if (-e "$peerfile") { return; }
189: &logthis("$peerfile still not there, give it another try");
190: sleep 5;
191: if (-e "$peerfile") { return; }
192: &logthis(
193: "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
194: } else {
195: &logthis(
196: "<font color=blue>WARNING:".
197: " lonc at pid $loncpid not responding, giving up</font>");
198: }
199: } else {
200: &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
201: }
202: }
203:
204: # ------------------------------------------------------ Critical communication
205:
206: sub critical {
207: my ($cmd,$server)=@_;
208: unless ($hostname{$server}) {
209: &logthis("<font color=blue>WARNING:".
210: " Critical message to unknown server ($server)</font>");
211: return 'no_such_host';
212: }
213: my $answer=reply($cmd,$server);
214: if ($answer eq 'con_lost') {
215: &reconlonc("$perlvar{'lonSockDir'}/$server");
216: my $answer=reply($cmd,$server);
217: if ($answer eq 'con_lost') {
218: my $now=time;
219: my $middlename=$cmd;
220: $middlename=substr($middlename,0,16);
221: $middlename=~s/\W//g;
222: my $dfilename=
223: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
224: $dumpcount++;
225: {
226: my $dfh;
227: if (open($dfh,">$dfilename")) {
228: print $dfh "$cmd\n";
229: close($dfh);
230: }
231: }
232: sleep 2;
233: my $wcmd='';
234: {
235: my $dfh;
236: if (open($dfh,"<$dfilename")) {
237: $wcmd=<$dfh>;
238: close($dfh);
239: }
240: }
241: chomp($wcmd);
242: if ($wcmd eq $cmd) {
243: &logthis("<font color=blue>WARNING: ".
244: "Connection buffer $dfilename: $cmd</font>");
245: &logperm("D:$server:$cmd");
246: return 'con_delayed';
247: } else {
248: &logthis("<font color=red>CRITICAL:"
249: ." Critical connection failed: $server $cmd</font>");
250: &logperm("F:$server:$cmd");
251: return 'con_failed';
252: }
253: }
254: }
255: return $answer;
256: }
257:
258: # ------------------------------------------- Transfer profile into environment
259:
260: sub transfer_profile_to_env {
261: my ($lonidsdir,$handle)=@_;
262: my @profile;
263: {
264: open(my $idf,"$lonidsdir/$handle.id");
265: flock($idf,LOCK_SH);
266: @profile=<$idf>;
267: close($idf);
268: }
269: my $envi;
270: my %Remove;
271: for ($envi=0;$envi<=$#profile;$envi++) {
272: chomp($profile[$envi]);
273: my ($envname,$envvalue)=split(/=/,$profile[$envi]);
274: $env{$envname} = $envvalue;
275: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
276: if ($time < time-300) {
277: $Remove{$key}++;
278: }
279: }
280: }
281: $env{'user.environment'} = "$lonidsdir/$handle.id";
282: foreach my $expired_key (keys(%Remove)) {
283: &delenv($expired_key);
284: }
285: }
286:
287: # ---------------------------------------------------------- Append Environment
288:
289: sub appenv {
290: my %newenv=@_;
291: foreach (keys %newenv) {
292: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
293: &logthis("<font color=blue>WARNING: ".
294: "Attempt to modify environment ".$_." to ".$newenv{$_}
295: .'</font>');
296: delete($newenv{$_});
297: } else {
298: $env{$_}=$newenv{$_};
299: }
300: }
301:
302: my $lockfh;
303: unless (open($lockfh,"$env{'user.environment'}")) {
304: return 'error: '.$!;
305: }
306: unless (flock($lockfh,LOCK_EX)) {
307: &logthis("<font color=blue>WARNING: ".
308: 'Could not obtain exclusive lock in appenv: '.$!);
309: close($lockfh);
310: return 'error: '.$!;
311: }
312:
313: my @oldenv;
314: {
315: my $fh;
316: unless (open($fh,"$env{'user.environment'}")) {
317: return 'error: '.$!;
318: }
319: @oldenv=<$fh>;
320: close($fh);
321: }
322: for (my $i=0; $i<=$#oldenv; $i++) {
323: chomp($oldenv[$i]);
324: if ($oldenv[$i] ne '') {
325: my ($name,$value)=split(/=/,$oldenv[$i]);
326: unless (defined($newenv{$name})) {
327: $newenv{$name}=$value;
328: }
329: }
330: }
331: {
332: my $fh;
333: unless (open($fh,">$env{'user.environment'}")) {
334: return 'error';
335: }
336: my $newname;
337: foreach $newname (keys %newenv) {
338: print $fh "$newname=$newenv{$newname}\n";
339: }
340: close($fh);
341: }
342:
343: close($lockfh);
344: return 'ok';
345: }
346: # ----------------------------------------------------- Delete from Environment
347:
348: sub delenv {
349: my $delthis=shift;
350: my %newenv=();
351: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
352: &logthis("<font color=blue>WARNING: ".
353: "Attempt to delete from environment ".$delthis);
354: return 'error';
355: }
356: my @oldenv;
357: {
358: my $fh;
359: unless (open($fh,"$env{'user.environment'}")) {
360: return 'error';
361: }
362: unless (flock($fh,LOCK_SH)) {
363: &logthis("<font color=blue>WARNING: ".
364: 'Could not obtain shared lock in delenv: '.$!);
365: close($fh);
366: return 'error: '.$!;
367: }
368: @oldenv=<$fh>;
369: close($fh);
370: }
371: {
372: my $fh;
373: unless (open($fh,">$env{'user.environment'}")) {
374: return 'error';
375: }
376: unless (flock($fh,LOCK_EX)) {
377: &logthis("<font color=blue>WARNING: ".
378: 'Could not obtain exclusive lock in delenv: '.$!);
379: close($fh);
380: return 'error: '.$!;
381: }
382: foreach (@oldenv) {
383: if ($_=~/^$delthis/) {
384: my ($key,undef) = split('=',$_);
385: delete($env{$key});
386: } else {
387: print $fh $_;
388: }
389: }
390: close($fh);
391: }
392: return 'ok';
393: }
394:
395: # ------------------------------------------ Find out current server userload
396: # there is a copy in lond
397: sub userload {
398: my $numusers=0;
399: {
400: opendir(LONIDS,$perlvar{'lonIDsDir'});
401: my $filename;
402: my $curtime=time;
403: while ($filename=readdir(LONIDS)) {
404: if ($filename eq '.' || $filename eq '..') {next;}
405: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
406: if ($curtime-$mtime < 1800) { $numusers++; }
407: }
408: closedir(LONIDS);
409: }
410: my $userloadpercent=0;
411: my $maxuserload=$perlvar{'lonUserLoadLim'};
412: if ($maxuserload) {
413: $userloadpercent=100*$numusers/$maxuserload;
414: }
415: $userloadpercent=sprintf("%.2f",$userloadpercent);
416: return $userloadpercent;
417: }
418:
419: # ------------------------------------------ Fight off request when overloaded
420:
421: sub overloaderror {
422: my ($r,$checkserver)=@_;
423: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
424: my $loadavg;
425: if ($checkserver eq $perlvar{'lonHostID'}) {
426: open(my $loadfile,'/proc/loadavg');
427: $loadavg=<$loadfile>;
428: $loadavg =~ s/\s.*//g;
429: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
430: close($loadfile);
431: } else {
432: $loadavg=&reply('load',$checkserver);
433: }
434: my $overload=$loadavg-100;
435: if ($overload>0) {
436: $r->err_headers_out->{'Retry-After'}=$overload;
437: $r->log_error('Overload of '.$overload.' on '.$checkserver);
438: return 413;
439: }
440: return '';
441: }
442:
443: # ------------------------------ Find server with least workload from spare.tab
444:
445: sub spareserver {
446: my ($loadpercent,$userloadpercent) = @_;
447: my $tryserver;
448: my $spareserver='';
449: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
450: my $lowestserver=$loadpercent > $userloadpercent?
451: $loadpercent : $userloadpercent;
452: foreach $tryserver (keys %spareid) {
453: my $loadans=reply('load',$tryserver);
454: my $userloadans=reply('userload',$tryserver);
455: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
456: next; #didn't get a number from the server
457: }
458: my $answer;
459: if ($loadans =~ /\d/) {
460: if ($userloadans =~ /\d/) {
461: #both are numbers, pick the bigger one
462: $answer=$loadans > $userloadans?
463: $loadans : $userloadans;
464: } else {
465: $answer = $loadans;
466: }
467: } else {
468: $answer = $userloadans;
469: }
470: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
471: $spareserver="http://$hostname{$tryserver}";
472: $lowestserver=$answer;
473: }
474: }
475: return $spareserver;
476: }
477:
478: # --------------------------------------------- Try to change a user's password
479:
480: sub changepass {
481: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
482: $currentpass = &escape($currentpass);
483: $newpass = &escape($newpass);
484: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
485: $server);
486: if (! $answer) {
487: &logthis("No reply on password change request to $server ".
488: "by $uname in domain $udom.");
489: } elsif ($answer =~ "^ok") {
490: &logthis("$uname in $udom successfully changed their password ".
491: "on $server.");
492: } elsif ($answer =~ "^pwchange_failure") {
493: &logthis("$uname in $udom was unable to change their password ".
494: "on $server. The action was blocked by either lcpasswd ".
495: "or pwchange");
496: } elsif ($answer =~ "^non_authorized") {
497: &logthis("$uname in $udom did not get their password correct when ".
498: "attempting to change it on $server.");
499: } elsif ($answer =~ "^auth_mode_error") {
500: &logthis("$uname in $udom attempted to change their password despite ".
501: "not being locally or internally authenticated on $server.");
502: } elsif ($answer =~ "^unknown_user") {
503: &logthis("$uname in $udom attempted to change their password ".
504: "on $server but were unable to because $server is not ".
505: "their home server.");
506: } elsif ($answer =~ "^refused") {
507: &logthis("$server refused to change $uname in $udom password because ".
508: "it was sent an unencrypted request to change the password.");
509: }
510: return $answer;
511: }
512:
513: # ----------------------- Try to determine user's current authentication scheme
514:
515: sub queryauthenticate {
516: my ($uname,$udom)=@_;
517: my $uhome=&homeserver($uname,$udom);
518: if (!$uhome) {
519: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
520: return 'no_host';
521: }
522: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
523: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
524: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
525: }
526: return $answer;
527: }
528:
529: # --------- Try to authenticate user from domain's lib servers (first this one)
530:
531: sub authenticate {
532: my ($uname,$upass,$udom)=@_;
533: $upass=escape($upass);
534: $uname=~s/\W//g;
535: my $uhome=&homeserver($uname,$udom);
536: if (!$uhome) {
537: &logthis("User $uname at $udom is unknown in authenticate");
538: return 'no_host';
539: }
540: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$uhome);
541: if ($answer eq 'authorized') {
542: &logthis("User $uname at $udom authorized by $uhome");
543: return $uhome;
544: }
545: if ($answer eq 'non_authorized') {
546: &logthis("User $uname at $udom rejected by $uhome");
547: return 'no_host';
548: }
549: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
550: return 'no_host';
551: }
552:
553: # ---------------------- Find the homebase for a user from domain's lib servers
554:
555: my %homecache;
556: sub homeserver {
557: my ($uname,$udom,$ignoreBadCache)=@_;
558: my $index="$uname:$udom";
559:
560: if (exists($homecache{$index})) { return $homecache{$index}; }
561: my $tryserver;
562: foreach $tryserver (keys %libserv) {
563: next if ($ignoreBadCache ne 'true' &&
564: exists($badServerCache{$tryserver}));
565: if ($hostdom{$tryserver} eq $udom) {
566: my $answer=reply("home:$udom:$uname",$tryserver);
567: if ($answer eq 'found') {
568: return $homecache{$index}=$tryserver;
569: } elsif ($answer eq 'no_host') {
570: $badServerCache{$tryserver}=1;
571: }
572: }
573: }
574: return 'no_host';
575: }
576:
577: # ------------------------------------- Find the usernames behind a list of IDs
578:
579: sub idget {
580: my ($udom,@ids)=@_;
581: my %returnhash=();
582:
583: my $tryserver;
584: foreach $tryserver (keys %libserv) {
585: if ($hostdom{$tryserver} eq $udom) {
586: my $idlist=join('&',@ids);
587: $idlist=~tr/A-Z/a-z/;
588: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
589: my @answer=();
590: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
591: @answer=split(/\&/,$reply);
592: } ;
593: my $i;
594: for ($i=0;$i<=$#ids;$i++) {
595: if ($answer[$i]) {
596: $returnhash{$ids[$i]}=$answer[$i];
597: }
598: }
599: }
600: }
601: return %returnhash;
602: }
603:
604: # ------------------------------------- Find the IDs behind a list of usernames
605:
606: sub idrget {
607: my ($udom,@unames)=@_;
608: my %returnhash=();
609: foreach (@unames) {
610: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
611: }
612: return %returnhash;
613: }
614:
615: # ------------------------------- Store away a list of names and associated IDs
616:
617: sub idput {
618: my ($udom,%ids)=@_;
619: my %servers=();
620: foreach (keys %ids) {
621: &cput('environment',{'id'=>$ids{$_}},$udom,$_);
622: my $uhom=&homeserver($_,$udom);
623: if ($uhom ne 'no_host') {
624: my $id=&escape($ids{$_});
625: $id=~tr/A-Z/a-z/;
626: my $unam=&escape($_);
627: if ($servers{$uhom}) {
628: $servers{$uhom}.='&'.$id.'='.$unam;
629: } else {
630: $servers{$uhom}=$id.'='.$unam;
631: }
632: }
633: }
634: foreach (keys %servers) {
635: &critical('idput:'.$udom.':'.$servers{$_},$_);
636: }
637: }
638:
639: # --------------------------------------------------- Assign a key to a student
640:
641: sub assign_access_key {
642: #
643: # a valid key looks like uname:udom#comments
644: # comments are being appended
645: #
646: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
647: $kdom=
648: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
649: $knum=
650: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
651: $cdom=
652: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
653: $cnum=
654: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
655: $udom=$env{'user.name'} unless (defined($udom));
656: $uname=$env{'user.domain'} unless (defined($uname));
657: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
658: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
659: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
660: # assigned to this person
661: # - this should not happen,
662: # unless something went wrong
663: # the first time around
664: # ready to assign
665: $logentry=$1.'; '.$logentry;
666: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
667: $kdom,$knum) eq 'ok') {
668: # key now belongs to user
669: my $envkey='key.'.$cdom.'_'.$cnum;
670: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
671: &appenv('environment.'.$envkey => $ckey);
672: return 'ok';
673: } else {
674: return
675: 'error: Count not permanently assign key, will need to be re-entered later.';
676: }
677: } else {
678: return 'error: Could not assign key, try again later.';
679: }
680: } elsif (!$existing{$ckey}) {
681: # the key does not exist
682: return 'error: The key does not exist';
683: } else {
684: # the key is somebody else's
685: return 'error: The key is already in use';
686: }
687: }
688:
689: # ------------------------------------------ put an additional comment on a key
690:
691: sub comment_access_key {
692: #
693: # a valid key looks like uname:udom#comments
694: # comments are being appended
695: #
696: my ($ckey,$cdom,$cnum,$logentry)=@_;
697: $cdom=
698: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
699: $cnum=
700: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
701: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
702: if ($existing{$ckey}) {
703: $existing{$ckey}.='; '.$logentry;
704: # ready to assign
705: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
706: $cdom,$cnum) eq 'ok') {
707: return 'ok';
708: } else {
709: return 'error: Count not store comment.';
710: }
711: } else {
712: # the key does not exist
713: return 'error: The key does not exist';
714: }
715: }
716:
717: # ------------------------------------------------------ Generate a set of keys
718:
719: sub generate_access_keys {
720: my ($number,$cdom,$cnum,$logentry)=@_;
721: $cdom=
722: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
723: $cnum=
724: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
725: unless (&allowed('mky',$cdom)) { return 0; }
726: unless (($cdom) && ($cnum)) { return 0; }
727: if ($number>10000) { return 0; }
728: sleep(2); # make sure don't get same seed twice
729: srand(time()^($$+($$<<15))); # from "Programming Perl"
730: my $total=0;
731: for (my $i=1;$i<=$number;$i++) {
732: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
733: sprintf("%lx",int(100000*rand)).'-'.
734: sprintf("%lx",int(100000*rand));
735: $newkey=~s/1/g/g; # folks mix up 1 and l
736: $newkey=~s/0/h/g; # and also 0 and O
737: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
738: if ($existing{$newkey}) {
739: $i--;
740: } else {
741: if (&put('accesskeys',
742: { $newkey => '# generated '.localtime().
743: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
744: '; '.$logentry },
745: $cdom,$cnum) eq 'ok') {
746: $total++;
747: }
748: }
749: }
750: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
751: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
752: return $total;
753: }
754:
755: # ------------------------------------------------------- Validate an accesskey
756:
757: sub validate_access_key {
758: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
759: $cdom=
760: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
761: $cnum=
762: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
763: $udom=$env{'user.domain'} unless (defined($udom));
764: $uname=$env{'user.name'} unless (defined($uname));
765: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
766: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
767: }
768:
769: # ------------------------------------- Find the section of student in a course
770:
771: sub getsection {
772: my ($udom,$unam,$courseid)=@_;
773: my $cachetime=1800;
774: $courseid=~s/\_/\//g;
775: $courseid=~s/^(\w)/\/$1/;
776:
777: my $hashid="$udom:$unam:$courseid";
778: my ($result,$cached)=&is_cached_new('getsection',$hashid);
779: if (defined($cached)) { return $result; }
780:
781: my %Pending;
782: my %Expired;
783: #
784: # Each role can either have not started yet (pending), be active,
785: # or have expired.
786: #
787: # If there is an active role, we are done.
788: #
789: # If there is more than one role which has not started yet,
790: # choose the one which will start sooner
791: # If there is one role which has not started yet, return it.
792: #
793: # If there is more than one expired role, choose the one which ended last.
794: # If there is a role which has expired, return it.
795: #
796: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
797: &homeserver($unam,$udom)))) {
798: my ($key,$value)=split(/\=/,$_);
799: $key=&unescape($key);
800: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
801: my $section=$1;
802: if ($key eq $courseid.'_st') { $section=''; }
803: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
804: my $now=time;
805: if (defined($end) && $end && ($now > $end)) {
806: $Expired{$end}=$section;
807: next;
808: }
809: if (defined($start) && $start && ($now < $start)) {
810: $Pending{$start}=$section;
811: next;
812: }
813: return &do_cache_new('getsection',$hashid,$section,$cachetime);
814: }
815: #
816: # Presumedly there will be few matching roles from the above
817: # loop and the sorting time will be negligible.
818: if (scalar(keys(%Pending))) {
819: my ($time) = sort {$a <=> $b} keys(%Pending);
820: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
821: }
822: if (scalar(keys(%Expired))) {
823: my @sorted = sort {$a <=> $b} keys(%Expired);
824: my $time = pop(@sorted);
825: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
826: }
827: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
828: }
829:
830: sub save_cache {
831: my ($r)=@_;
832: if (! $r->is_initial_req()) { return DECLINED; }
833: &purge_remembered();
834: undef(%env);
835: return OK;
836: }
837:
838: my $to_remember=-1;
839: my %remembered;
840: my %accessed;
841: my $kicks=0;
842: my $hits=0;
843: sub devalidate_cache_new {
844: my ($name,$id,$debug) = @_;
845: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
846: $id=&escape($name.':'.$id);
847: $memcache->delete($id);
848: delete($remembered{$id});
849: delete($accessed{$id});
850: }
851:
852: sub is_cached_new {
853: my ($name,$id,$debug) = @_;
854: $id=&escape($name.':'.$id);
855: if (exists($remembered{$id})) {
856: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
857: $accessed{$id}=[&gettimeofday()];
858: $hits++;
859: return ($remembered{$id},1);
860: }
861: my $value = $memcache->get($id);
862: if (!(defined($value))) {
863: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
864: return (undef,undef);
865: }
866: if ($value eq '__undef__') {
867: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
868: $value=undef;
869: }
870: &make_room($id,$value,$debug);
871: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
872: return ($value,1);
873: }
874:
875: sub do_cache_new {
876: my ($name,$id,$value,$time,$debug) = @_;
877: $id=&escape($name.':'.$id);
878: my $setvalue=$value;
879: if (!defined($setvalue)) {
880: $setvalue='__undef__';
881: }
882: if (!defined($time) ) {
883: $time=600;
884: }
885: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
886: $memcache->set($id,$setvalue,$time);
887: # need to make a copy of $value
888: #&make_room($id,$value,$debug);
889: return $value;
890: }
891:
892: sub make_room {
893: my ($id,$value,$debug)=@_;
894: $remembered{$id}=$value;
895: if ($to_remember<0) { return; }
896: $accessed{$id}=[&gettimeofday()];
897: if (scalar(keys(%remembered)) <= $to_remember) { return; }
898: my $to_kick;
899: my $max_time=0;
900: foreach my $other (keys(%accessed)) {
901: if (&tv_interval($accessed{$other}) > $max_time) {
902: $to_kick=$other;
903: $max_time=&tv_interval($accessed{$other});
904: }
905: }
906: delete($remembered{$to_kick});
907: delete($accessed{$to_kick});
908: $kicks++;
909: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
910: return;
911: }
912:
913: sub purge_remembered {
914: #&logthis("Tossing ".scalar(keys(%remembered)));
915: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
916: undef(%remembered);
917: undef(%accessed);
918: }
919: # ------------------------------------- Read an entry from a user's environment
920:
921: sub userenvironment {
922: my ($udom,$unam,@what)=@_;
923: my %returnhash=();
924: my @answer=split(/\&/,
925: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
926: &homeserver($unam,$udom)));
927: my $i;
928: for ($i=0;$i<=$#what;$i++) {
929: $returnhash{$what[$i]}=&unescape($answer[$i]);
930: }
931: return %returnhash;
932: }
933:
934: # ---------------------------------------------------------- Get a studentphoto
935: sub studentphoto {
936: my ($udom,$unam,$ext) = @_;
937: my $home=&Apache::lonnet::homeserver($unam,$udom);
938: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext",$home);
939: my $url="/uploaded/$udom/$unam/internal/studentphoto.".$ext;
940: if ($ret ne 'ok') {
941: return '/adm/lonKaputt/lonlogo_broken.gif';
942: }
943: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
944: return $tokenurl;
945: }
946:
947: # -------------------------------------------------------------------- New chat
948:
949: sub chatsend {
950: my ($newentry,$anon)=@_;
951: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
952: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
953: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
954: &reply('chatsend:'.$cdom.':'.$cnum.':'.
955: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
956: &escape($newentry)),$chome);
957: }
958:
959: # ------------------------------------------ Find current version of a resource
960:
961: sub getversion {
962: my $fname=&clutter(shift);
963: unless ($fname=~/^\/res\//) { return -1; }
964: return ¤tversion(&filelocation('',$fname));
965: }
966:
967: sub currentversion {
968: my $fname=shift;
969: my ($result,$cached)=&is_cached_new('resversion',$fname);
970: if (defined($cached)) { return $result; }
971: my $author=$fname;
972: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
973: my ($udom,$uname)=split(/\//,$author);
974: my $home=homeserver($uname,$udom);
975: if ($home eq 'no_host') {
976: return -1;
977: }
978: my $answer=reply("currentversion:$fname",$home);
979: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
980: return -1;
981: }
982: return &do_cache_new('resversion',$fname,$answer,600);
983: }
984:
985: # ----------------------------- Subscribe to a resource, return URL if possible
986:
987: sub subscribe {
988: my $fname=shift;
989: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
990: $fname=~s/[\n\r]//g;
991: my $author=$fname;
992: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
993: my ($udom,$uname)=split(/\//,$author);
994: my $home=homeserver($uname,$udom);
995: if ($home eq 'no_host') {
996: return 'not_found';
997: }
998: my $answer=reply("sub:$fname",$home);
999: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1000: $answer.=' by '.$home;
1001: }
1002: return $answer;
1003: }
1004:
1005: # -------------------------------------------------------------- Replicate file
1006:
1007: sub repcopy {
1008: my $filename=shift;
1009: $filename=~s/\/+/\//g;
1010: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1011: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1012: if ($filename=~m|^/home/httpd/html/userfiles/| or
1013: $filename=~m -^/*(uploaded|editupload)/-) {
1014: return &repcopy_userfile($filename);
1015: }
1016: $filename=~s/[\n\r]//g;
1017: my $transname="$filename.in.transfer";
1018: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1019: my $remoteurl=subscribe($filename);
1020: if ($remoteurl =~ /^con_lost by/) {
1021: &logthis("Subscribe returned $remoteurl: $filename");
1022: return 'unavailable';
1023: } elsif ($remoteurl eq 'not_found') {
1024: #&logthis("Subscribe returned not_found: $filename");
1025: return 'not_found';
1026: } elsif ($remoteurl =~ /^rejected by/) {
1027: &logthis("Subscribe returned $remoteurl: $filename");
1028: return 'forbidden';
1029: } elsif ($remoteurl eq 'directory') {
1030: return 'ok';
1031: } else {
1032: my $author=$filename;
1033: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1034: my ($udom,$uname)=split(/\//,$author);
1035: my $home=homeserver($uname,$udom);
1036: unless ($home eq $perlvar{'lonHostID'}) {
1037: my @parts=split(/\//,$filename);
1038: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1039: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1040: &logthis("Malconfiguration for replication: $filename");
1041: return 'bad_request';
1042: }
1043: my $count;
1044: for ($count=5;$count<$#parts;$count++) {
1045: $path.="/$parts[$count]";
1046: if ((-e $path)!=1) {
1047: mkdir($path,0777);
1048: }
1049: }
1050: my $ua=new LWP::UserAgent;
1051: my $request=new HTTP::Request('GET',"$remoteurl");
1052: my $response=$ua->request($request,$transname);
1053: if ($response->is_error()) {
1054: unlink($transname);
1055: my $message=$response->status_line;
1056: &logthis("<font color=blue>WARNING:"
1057: ." LWP get: $message: $filename</font>");
1058: return 'unavailable';
1059: } else {
1060: if ($remoteurl!~/\.meta$/) {
1061: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1062: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1063: if ($mresponse->is_error()) {
1064: unlink($filename.'.meta');
1065: &logthis(
1066: "<font color=yellow>INFO: No metadata: $filename</font>");
1067: }
1068: }
1069: rename($transname,$filename);
1070: return 'ok';
1071: }
1072: }
1073: }
1074: }
1075:
1076: # ------------------------------------------------ Get server side include body
1077: sub ssi_body {
1078: my ($filelink,%form)=@_;
1079: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1080: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1081: }
1082: my $output=($filelink=~/^http\:/?&externalssi($filelink):
1083: &ssi($filelink,%form));
1084: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+// END LON-CAPA Internal\s*(-->)?\s||gs;
1085: $output=~s/^.*?\<body[^\>]*\>//si;
1086: $output=~s/(.*)\<\/body\s*\>.*?$/$1/si;
1087: return $output;
1088: }
1089:
1090: # --------------------------------------------------------- Server Side Include
1091:
1092: sub ssi {
1093:
1094: my ($fn,%form)=@_;
1095:
1096: my $ua=new LWP::UserAgent;
1097:
1098: my $request;
1099:
1100: if (%form) {
1101: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
1102: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
1103: } else {
1104: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
1105: }
1106:
1107: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1108: my $response=$ua->request($request);
1109:
1110: return $response->content;
1111: }
1112:
1113: sub externalssi {
1114: my ($url)=@_;
1115: my $ua=new LWP::UserAgent;
1116: my $request=new HTTP::Request('GET',$url);
1117: my $response=$ua->request($request);
1118: return $response->content;
1119: }
1120:
1121: # -------------------------------- Allow a /uploaded/ URI to be vouched for
1122:
1123: sub allowuploaded {
1124: my ($srcurl,$url)=@_;
1125: $url=&clutter(&declutter($url));
1126: my $dir=$url;
1127: $dir=~s/\/[^\/]+$//;
1128: my %httpref=();
1129: my $httpurl=&hreflocation('',$url);
1130: $httpref{'httpref.'.$httpurl}=$srcurl;
1131: &Apache::lonnet::appenv(%httpref);
1132: }
1133:
1134: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1135: # input: action, courseID, current domain, intended
1136: # path to file, source of file, instruction to parse file for objects,
1137: # ref to hash for embedded objects,
1138: # ref to hash for codebase of java objects.
1139: #
1140: # output: url to file (if action was uploaddoc),
1141: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1142: #
1143: # Allows directory structure to be used within lonUsers/../userfiles/ for a
1144: # course.
1145: #
1146: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1147: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
1148: # course's home server.
1149: #
1150: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
1151: # be copied from $source (current location) to
1152: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1153: # and will then be copied to
1154: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
1155: # course's home server.
1156: #
1157: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1158: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1159: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1160: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
1161: # in course's home server.
1162: #
1163:
1164: sub process_coursefile {
1165: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1166: my $fetchresult;
1167: my $home=&homeserver($docuname,$docudom);
1168: if ($action eq 'propagate') {
1169: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1170: $home);
1171: } else {
1172: my $fetchresult = '';
1173: my $fpath = '';
1174: my $fname = $file;
1175: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1176: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1177: my $filepath = &build_filepath($fpath);
1178: if ($action eq 'copy') {
1179: if ($source eq '') {
1180: $fetchresult = 'no source file';
1181: return $fetchresult;
1182: } else {
1183: my $destination = $filepath.'/'.$fname;
1184: rename($source,$destination);
1185: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1186: $home);
1187: }
1188: } elsif ($action eq 'uploaddoc') {
1189: open(my $fh,'>'.$filepath.'/'.$fname);
1190: print $fh $env{'form.'.$source};
1191: close($fh);
1192: if ($parser eq 'parse') {
1193: my $parse_result = &extract_embedded_items($filepath,$fname,$allfiles,$codebase);
1194: unless ($parse_result eq 'ok') {
1195: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
1196: }
1197: }
1198: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1199: $home);
1200: if ($fetchresult eq 'ok') {
1201: return '/uploaded/'.$fpath.'/'.$fname;
1202: } else {
1203: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1204: ' to host '.$home.': '.$fetchresult);
1205: return '/adm/notfound.html';
1206: }
1207: }
1208: }
1209: unless ( $fetchresult eq 'ok') {
1210: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1211: ' to host '.$home.': '.$fetchresult);
1212: }
1213: return $fetchresult;
1214: }
1215:
1216: sub build_filepath {
1217: my ($fpath) = @_;
1218: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
1219: unless ($fpath eq '') {
1220: my @parts=split('/',$fpath);
1221: foreach my $part (@parts) {
1222: $filepath.= '/'.$part;
1223: if ((-e $filepath)!=1) {
1224: mkdir($filepath,0777);
1225: }
1226: }
1227: }
1228: return $filepath;
1229: }
1230:
1231: sub store_edited_file {
1232: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1233: my $file = $primary_url;
1234: $file =~ s#^/uploaded/$docudom/$docuname/##;
1235: my $fpath = '';
1236: my $fname = $file;
1237: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1238: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1239: my $filepath = &build_filepath($fpath);
1240: open(my $fh,'>'.$filepath.'/'.$fname);
1241: print $fh $content;
1242: close($fh);
1243: my $home=&homeserver($docuname,$docudom);
1244: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1245: $home);
1246: if ($$fetchresult eq 'ok') {
1247: return '/uploaded/'.$fpath.'/'.$fname;
1248: } else {
1249: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1250: ' to host '.$home.': '.$$fetchresult);
1251: return '/adm/notfound.html';
1252: }
1253: }
1254:
1255: sub clean_filename {
1256: my ($fname)=@_;
1257: # Replace Windows backslashes by forward slashes
1258: $fname=~s/\\/\//g;
1259: # Get rid of everything but the actual filename
1260: $fname=~s/^.*\/([^\/]+)$/$1/;
1261: # Replace spaces by underscores
1262: $fname=~s/\s+/\_/g;
1263: # Replace all other weird characters by nothing
1264: $fname=~s/[^\w\.\-]//g;
1265: # Replace all .\d. sequences with _\d. so they no longer look like version
1266: # numbers
1267: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1268: return $fname;
1269: }
1270:
1271: # --------------- Take an uploaded file and put it into the userfiles directory
1272: # input: name of form element, coursedoc=1 means this is for the course
1273: # output: url of file in userspace
1274:
1275:
1276: sub userfileupload {
1277: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase)=@_;
1278: if (!defined($subdir)) { $subdir='unknown'; }
1279: my $fname=$env{'form.'.$formname.'.filename'};
1280: $fname=&clean_filename($fname);
1281: # See if there is anything left
1282: unless ($fname) { return 'error: no uploaded file'; }
1283: chop($env{'form.'.$formname});
1284: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
1285: my $now = time;
1286: my $filepath = 'tmp/helprequests/'.$now;
1287: my @parts=split(/\//,$filepath);
1288: my $fullpath = $perlvar{'lonDaemons'};
1289: for (my $i=0;$i<@parts;$i++) {
1290: $fullpath .= '/'.$parts[$i];
1291: if ((-e $fullpath)!=1) {
1292: mkdir($fullpath,0777);
1293: }
1294: }
1295: open(my $fh,'>'.$fullpath.'/'.$fname);
1296: print $fh $env{'form.'.$formname};
1297: close($fh);
1298: return $fullpath.'/'.$fname;
1299: }
1300: # Create the directory if not present
1301: $fname="$subdir/$fname";
1302: if ($coursedoc) {
1303: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
1304: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1305: if ($env{'form.folder'} =~ m/^default/) {
1306: return &finishuserfileupload($docuname,$docudom,
1307: $formname,$fname,$parser,$allfiles,
1308: $codebase);
1309: } else {
1310: $fname=$env{'form.folder'}.'/'.$fname;
1311: return &process_coursefile('uploaddoc',$docuname,$docudom,
1312: $fname,$formname,$parser,
1313: $allfiles,$codebase);
1314: }
1315: } else {
1316: my $docuname=$env{'user.name'};
1317: my $docudom=$env{'user.domain'};
1318: return &finishuserfileupload($docuname,$docudom,$formname,
1319: $fname,$parser,$allfiles,$codebase);
1320: }
1321: }
1322:
1323: sub finishuserfileupload {
1324: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase) = @_;
1325: my $path=$docudom.'/'.$docuname.'/';
1326: my $filepath=$perlvar{'lonDocRoot'};
1327: my ($fnamepath,$file);
1328: $file=$fname;
1329: if ($fname=~m|/|) {
1330: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
1331: $path.=$fnamepath.'/';
1332: }
1333: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1334: my $count;
1335: for ($count=4;$count<=$#parts;$count++) {
1336: $filepath.="/$parts[$count]";
1337: if ((-e $filepath)!=1) {
1338: mkdir($filepath,0777);
1339: }
1340: }
1341: # Save the file
1342: {
1343: open(FH,'>'.$filepath.'/'.$file);
1344: print FH $env{'form.'.$formname};
1345: close(FH);
1346: }
1347: if ($parser eq 'parse') {
1348: my $parse_result = &extract_embedded_items($filepath,$file,$allfiles,
1349: $codebase);
1350: unless ($parse_result eq 'ok') {
1351: &logthis('Failed to parse '.$filepath.$file.
1352: ' for embedded media: '.$parse_result);
1353: }
1354: }
1355: # Notify homeserver to grep it
1356: #
1357: my $docuhome=&homeserver($docuname,$docudom);
1358: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1359: if ($fetchresult eq 'ok') {
1360: #
1361: # Return the URL to it
1362: return '/uploaded/'.$path.$file;
1363: } else {
1364: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
1365: ': '.$fetchresult);
1366: return '/adm/notfound.html';
1367: }
1368: }
1369:
1370: sub extract_embedded_items {
1371: my ($filepath,$file,$allfiles,$codebase) = @_;
1372: my @state = ();
1373: my %javafiles = (
1374: codebase => '',
1375: code => '',
1376: archive => ''
1377: );
1378: my %mediafiles = (
1379: src => '',
1380: movie => '',
1381: );
1382: my $p = HTML::Parser->new
1383: (
1384: start_h =>
1385: [sub {
1386: my ($tagname, $attr) = @_;
1387: push (@state, $tagname);
1388: if (lc($tagname) eq 'img') {
1389: &add_filetype($allfiles,$attr->{'src'},'src');
1390: }
1391: if (lc($tagname) eq 'object' ||
1392: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
1393: foreach my $item (keys(%javafiles)) {
1394: $javafiles{$item} = '';
1395: }
1396: }
1397: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
1398: my $name = lc($attr->{'name'});
1399: foreach my $item (keys(%javafiles)) {
1400: if ($name eq $item) {
1401: $javafiles{$item} = $attr->{'value'};
1402: last;
1403: }
1404: }
1405: foreach my $item (keys(%mediafiles)) {
1406: if ($name eq $item) {
1407: &add_filetype($allfiles, $attr->{'value'}, 'value');
1408: last;
1409: }
1410: }
1411: }
1412: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
1413: foreach my $item (keys(%javafiles)) {
1414: if ($attr->{$item}) {
1415: $javafiles{$item} = $attr->{$item};
1416: last;
1417: }
1418: }
1419: foreach my $item (keys(%mediafiles)) {
1420: if ($attr->{$item}) {
1421: &add_filetype($allfiles,$attr->{$item},$item);
1422: last;
1423: }
1424: }
1425: }
1426: }, "tagname, attr"],
1427: end_h =>
1428: [sub {
1429: my ($tagname) = @_;
1430: if ($javafiles{'codebase'} ne '') {
1431: $javafiles{'codebase'} .= '/';
1432: }
1433: if (lc($tagname) eq 'applet' ||
1434: lc($tagname) eq 'object' ||
1435: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
1436: ) {
1437: foreach my $item (keys(%javafiles)) {
1438: if ($item ne 'codebase' &&
1439: $javafiles{$item} ne '') {
1440: my $file=$javafiles{'codebase'}.
1441: $javafiles{$item};
1442: &add_filetype($allfiles,$file,$item);
1443: }
1444: }
1445: }
1446: pop @state;
1447: }, "tagname"],
1448: );
1449: $p->parse_file($filepath.'/'.$file);
1450: $p->eof;
1451: return 'ok';
1452: }
1453:
1454: sub add_filetype {
1455: my ($allfiles,$file,$type)=@_;
1456: if (exists($allfiles->{$file})) {
1457: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
1458: push(@{$allfiles->{$file}}, &escape($type));
1459: }
1460: } else {
1461: @{$allfiles->{$file}} = (&escape($type));
1462: }
1463: }
1464:
1465: sub removeuploadedurl {
1466: my ($url)=@_;
1467: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1468: return &removeuserfile($uname,$udom,$fname);
1469: }
1470:
1471: sub removeuserfile {
1472: my ($docuname,$docudom,$fname)=@_;
1473: my $home=&homeserver($docuname,$docudom);
1474: return &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1475: }
1476:
1477: sub mkdiruserfile {
1478: my ($docuname,$docudom,$dir)=@_;
1479: my $home=&homeserver($docuname,$docudom);
1480: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
1481: }
1482:
1483: sub renameuserfile {
1484: my ($docuname,$docudom,$old,$new)=@_;
1485: my $home=&homeserver($docuname,$docudom);
1486: return &reply("renameuserfile:$docudom:$docuname:".&escape("$old").':'.
1487: &escape("$new"),$home);
1488: }
1489:
1490: # ------------------------------------------------------------------------- Log
1491:
1492: sub log {
1493: my ($dom,$nam,$hom,$what)=@_;
1494: return critical("log:$dom:$nam:$what",$hom);
1495: }
1496:
1497: # ------------------------------------------------------------------ Course Log
1498: #
1499: # This routine flushes several buffers of non-mission-critical nature
1500: #
1501:
1502: sub flushcourselogs {
1503: &logthis('Flushing log buffers');
1504: #
1505: # course logs
1506: # This is a log of all transactions in a course, which can be used
1507: # for data mining purposes
1508: #
1509: # It also collects the courseid database, which lists last transaction
1510: # times and course titles for all courseids
1511: #
1512: my %courseidbuffer=();
1513: foreach (keys %courselogs) {
1514: my $crsid=$_;
1515: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1516: &escape($courselogs{$crsid}),
1517: $coursehombuf{$crsid}) eq 'ok') {
1518: delete $courselogs{$crsid};
1519: } else {
1520: &logthis('Failed to flush log buffer for '.$crsid);
1521: if (length($courselogs{$crsid})>40000) {
1522: &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
1523: " exceeded maximum size, deleting.</font>");
1524: delete $courselogs{$crsid};
1525: }
1526: }
1527: if ($courseidbuffer{$coursehombuf{$crsid}}) {
1528: $courseidbuffer{$coursehombuf{$crsid}}.='&'.
1529: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1530: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid});
1531: } else {
1532: $courseidbuffer{$coursehombuf{$crsid}}=
1533: &escape($crsid).'='.&escape($coursedescrbuf{$crsid}).
1534: ':'.&escape($courseinstcodebuf{$crsid}).':'.&escape($courseownerbuf{$crsid});
1535: }
1536: }
1537: #
1538: # Write course id database (reverse lookup) to homeserver of courses
1539: # Is used in pickcourse
1540: #
1541: foreach (keys %courseidbuffer) {
1542: &courseidput($hostdom{$_},$courseidbuffer{$_},$_);
1543: }
1544: #
1545: # File accesses
1546: # Writes to the dynamic metadata of resources to get hit counts, etc.
1547: #
1548: foreach my $entry (keys(%accesshash)) {
1549: if ($entry =~ /___count$/) {
1550: my ($dom,$name);
1551: ($dom,$name,undef)=($entry=~m:___(\w+)/(\w+)/(.*)___count$:);
1552: if (! defined($dom) || $dom eq '' ||
1553: ! defined($name) || $name eq '') {
1554: my $cid = $env{'request.course.id'};
1555: $dom = $env{'request.'.$cid.'.domain'};
1556: $name = $env{'request.'.$cid.'.num'};
1557: }
1558: my $value = $accesshash{$entry};
1559: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
1560: my %temphash=($url => $value);
1561: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
1562: if ($result eq 'ok') {
1563: delete $accesshash{$entry};
1564: } elsif ($result eq 'unknown_cmd') {
1565: # Target server has old code running on it.
1566: my %temphash=($entry => $value);
1567: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1568: delete $accesshash{$entry};
1569: }
1570: }
1571: } else {
1572: my ($dom,$name) = ($entry=~m:___(\w+)/(\w+)/(.*)___(\w+)$:);
1573: my %temphash=($entry => $accesshash{$entry});
1574: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
1575: delete $accesshash{$entry};
1576: }
1577: }
1578: }
1579: #
1580: # Roles
1581: # Reverse lookup of user roles for course faculty/staff and co-authorship
1582: #
1583: foreach (keys %userrolehash) {
1584: my $entry=$_;
1585: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1586: split(/\:/,$entry);
1587: if (&Apache::lonnet::put('nohist_userroles',
1588: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1589: $rudom,$runame) eq 'ok') {
1590: delete $userrolehash{$entry};
1591: }
1592: }
1593: $dumpcount++;
1594: }
1595:
1596: sub courselog {
1597: my $what=shift;
1598: $what=time.':'.$what;
1599: unless ($env{'request.course.id'}) { return ''; }
1600: $coursedombuf{$env{'request.course.id'}}=
1601: $env{'course.'.$env{'request.course.id'}.'.domain'};
1602: $coursenumbuf{$env{'request.course.id'}}=
1603: $env{'course.'.$env{'request.course.id'}.'.num'};
1604: $coursehombuf{$env{'request.course.id'}}=
1605: $env{'course.'.$env{'request.course.id'}.'.home'};
1606: $coursedescrbuf{$env{'request.course.id'}}=
1607: $env{'course.'.$env{'request.course.id'}.'.description'};
1608: $courseinstcodebuf{$env{'request.course.id'}}=
1609: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1610: $courseownerbuf{$env{'request.course.id'}}=
1611: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1612: if (defined $courselogs{$env{'request.course.id'}}) {
1613: $courselogs{$env{'request.course.id'}}.='&'.$what;
1614: } else {
1615: $courselogs{$env{'request.course.id'}}.=$what;
1616: }
1617: if (length($courselogs{$env{'request.course.id'}})>4048) {
1618: &flushcourselogs();
1619: }
1620: }
1621:
1622: sub courseacclog {
1623: my $fnsymb=shift;
1624: unless ($env{'request.course.id'}) { return ''; }
1625: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1626: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|page)$/) {
1627: $what.=':POST';
1628: # FIXME: Probably ought to escape things....
1629: foreach (keys %env) {
1630: if ($_=~/^form\.(.*)/) {
1631: $what.=':'.$1.'='.$env{$_};
1632: }
1633: }
1634: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
1635: # FIXME: We should not be depending on a form parameter that someone
1636: # editing lonsearchcat.pm might change in the future.
1637: if ($env{'form.phase'} eq 'course_search') {
1638: $what.= ':POST';
1639: # FIXME: Probably ought to escape things....
1640: foreach my $element ('courseexp','crsfulltext','crsrelated',
1641: 'crsdiscuss') {
1642: $what.=':'.$element.'='.$env{'form.'.$element};
1643: }
1644: }
1645: }
1646: &courselog($what);
1647: }
1648:
1649: sub countacc {
1650: my $url=&declutter(shift);
1651: return if (! defined($url) || $url eq '');
1652: unless ($env{'request.course.id'}) { return ''; }
1653: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1654: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1655: $accesshash{$key}++;
1656: }
1657:
1658: sub linklog {
1659: my ($from,$to)=@_;
1660: $from=&declutter($from);
1661: $to=&declutter($to);
1662: $accesshash{$from.'___'.$to.'___comefrom'}=1;
1663: $accesshash{$to.'___'.$from.'___goto'}=1;
1664: }
1665:
1666: sub userrolelog {
1667: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1668: if (($trole=~/^ca/) || ($trole=~/^in/) ||
1669: ($trole=~/^cc/) || ($trole=~/^ep/) ||
1670: ($trole=~/^cr/) || ($trole=~/^ta/)) {
1671: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
1672: $userrolehash
1673: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1674: =$tend.':'.$tstart;
1675: }
1676: }
1677:
1678: sub get_course_adv_roles {
1679: my $cid=shift;
1680: $cid=$env{'request.course.id'} unless (defined($cid));
1681: my %coursehash=&coursedescription($cid);
1682: my %nothide=();
1683: foreach (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1684: $nothide{join(':',split(/[\@\:]/,$_))}=1;
1685: }
1686: my %returnhash=();
1687: my %dumphash=
1688: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
1689: my $now=time;
1690: foreach (keys %dumphash) {
1691: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1692: if (($tstart) && ($tstart<0)) { next; }
1693: if (($tend) && ($tend<$now)) { next; }
1694: if (($tstart) && ($now<$tstart)) { next; }
1695: my ($role,$username,$domain,$section)=split(/\:/,$_);
1696: if ($username eq '' || $domain eq '') { next; }
1697: if ((&privileged($username,$domain)) &&
1698: (!$nothide{$username.':'.$domain})) { next; }
1699: my $key=&plaintext($role);
1700: if ($section) { $key.=' (Sec/Grp '.$section.')'; }
1701: if ($returnhash{$key}) {
1702: $returnhash{$key}.=','.$username.':'.$domain;
1703: } else {
1704: $returnhash{$key}=$username.':'.$domain;
1705: }
1706: }
1707: return %returnhash;
1708: }
1709:
1710: sub get_my_roles {
1711: my ($uname,$udom)=@_;
1712: unless (defined($uname)) { $uname=$env{'user.name'}; }
1713: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1714: my %dumphash=
1715: &dump('nohist_userroles',$udom,$uname);
1716: my %returnhash=();
1717: my $now=time;
1718: foreach (keys %dumphash) {
1719: my ($tend,$tstart)=split(/\:/,$dumphash{$_});
1720: if (($tstart) && ($tstart<0)) { next; }
1721: if (($tend) && ($tend<$now)) { next; }
1722: if (($tstart) && ($now<$tstart)) { next; }
1723: my ($role,$username,$domain,$section)=split(/\:/,$_);
1724: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
1725: }
1726: return %returnhash;
1727: }
1728:
1729: # ----------------------------------------------------- Frontpage Announcements
1730: #
1731: #
1732:
1733: sub postannounce {
1734: my ($server,$text)=@_;
1735: unless (&allowed('psa',$hostdom{$server})) { return 'refused'; }
1736: unless ($text=~/\w/) { $text=''; }
1737: return &reply('setannounce:'.&escape($text),$server);
1738: }
1739:
1740: sub getannounce {
1741:
1742: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1743: my $announcement='';
1744: while (<$fh>) { $announcement .=$_; }
1745: close($fh);
1746: if ($announcement=~/\w/) {
1747: return
1748: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1749: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1750: } else {
1751: return '';
1752: }
1753: } else {
1754: return '';
1755: }
1756: }
1757:
1758: # ---------------------------------------------------------- Course ID routines
1759: # Deal with domain's nohist_courseid.db files
1760: #
1761:
1762: sub courseidput {
1763: my ($domain,$what,$coursehome)=@_;
1764: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
1765: }
1766:
1767: sub courseiddump {
1768: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,$coursefilter,$hostidflag,$hostidref)=@_;
1769: my %returnhash=();
1770: unless ($domfilter) { $domfilter=''; }
1771: foreach my $tryserver (keys %libserv) {
1772: if ( ($hostidflag == 1 && grep/^$tryserver$/,@{$hostidref}) || (!defined($hostidflag)) ) {
1773: if ((!$domfilter) || ($hostdom{$tryserver} eq $domfilter)) {
1774: foreach (
1775: split(/\&/,&reply('courseiddump:'.$hostdom{$tryserver}.':'.
1776: $sincefilter.':'.&escape($descfilter).':'.
1777: &escape($instcodefilter).':'.&escape($ownerfilter).':'.&escape($coursefilter),
1778: $tryserver))) {
1779: my ($key,$value)=split(/\=/,$_);
1780: if (($key) && ($value)) {
1781: $returnhash{&unescape($key)}=$value;
1782: }
1783: }
1784: }
1785: }
1786: }
1787: return %returnhash;
1788: }
1789:
1790: #
1791: # ----------------------------------------------------------- Check out an item
1792:
1793: sub get_first_access {
1794: my ($type,$argsymb)=@_;
1795: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
1796: if ($argsymb) { $symb=$argsymb; }
1797: my ($map,$id,$res)=&decode_symb($symb);
1798: if ($type eq 'map') {
1799: $res=&symbread($map);
1800: } else {
1801: $res=$symb;
1802: }
1803: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
1804: return $times{"$courseid\0$res"};
1805: }
1806:
1807: sub set_first_access {
1808: my ($type)=@_;
1809: my ($symb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
1810: my ($map,$id,$res)=&decode_symb($symb);
1811: if ($type eq 'map') {
1812: $res=&symbread($map);
1813: } else {
1814: $res=$symb;
1815: }
1816: my $firstaccess=&get_first_access($type,$symb);
1817: if (!$firstaccess) {
1818: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1819: }
1820: return 'already_set';
1821: }
1822:
1823: sub checkout {
1824: my ($symb,$tuname,$tudom,$tcrsid)=@_;
1825: my $now=time;
1826: my $lonhost=$perlvar{'lonHostID'};
1827: my $infostr=&escape(
1828: 'CHECKOUTTOKEN&'.
1829: $tuname.'&'.
1830: $tudom.'&'.
1831: $tcrsid.'&'.
1832: $symb.'&'.
1833: $now.'&'.$ENV{'REMOTE_ADDR'});
1834: my $token=&reply('tmpput:'.$infostr,$lonhost);
1835: if ($token=~/^error\:/) {
1836: &logthis("<font color=blue>WARNING: ".
1837: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
1838: "</font>");
1839: return '';
1840: }
1841:
1842: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
1843: $token=~tr/a-z/A-Z/;
1844:
1845: my %infohash=('resource.0.outtoken' => $token,
1846: 'resource.0.checkouttime' => $now,
1847: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1848:
1849: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1850: return '';
1851: } else {
1852: &logthis("<font color=blue>WARNING: ".
1853: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
1854: "</font>");
1855: }
1856:
1857: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1858: &escape('Checkout '.$infostr.' - '.
1859: $token)) ne 'ok') {
1860: return '';
1861: } else {
1862: &logthis("<font color=blue>WARNING: ".
1863: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
1864: "</font>");
1865: }
1866: return $token;
1867: }
1868:
1869: # ------------------------------------------------------------ Check in an item
1870:
1871: sub checkin {
1872: my $token=shift;
1873: my $now=time;
1874: my ($ta,$tb,$lonhost)=split(/\*/,$token);
1875: $lonhost=~tr/A-Z/a-z/;
1876: my $dtoken=$ta.'_'.$hostname{$lonhost}.'_'.$tb;
1877: $dtoken=~s/\W/\_/g;
1878: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1879: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
1880:
1881: unless (($tuname) && ($tudom)) {
1882: &logthis('Check in '.$token.' ('.$dtoken.') failed');
1883: return '';
1884: }
1885:
1886: unless (&allowed('mgr',$tcrsid)) {
1887: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1888: $env{'user.name'}.' - '.$env{'user.domain'});
1889: return '';
1890: }
1891:
1892: my %infohash=('resource.0.intoken' => $token,
1893: 'resource.0.checkintime' => $now,
1894: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1895:
1896: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1897: return '';
1898: }
1899:
1900: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1901: &escape('Checkin - '.$token)) ne 'ok') {
1902: return '';
1903: }
1904:
1905: return ($symb,$tuname,$tudom,$tcrsid);
1906: }
1907:
1908: # --------------------------------------------- Set Expire Date for Spreadsheet
1909:
1910: sub expirespread {
1911: my ($uname,$udom,$stype,$usymb)=@_;
1912: my $cid=$env{'request.course.id'};
1913: if ($cid) {
1914: my $now=time;
1915: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1916: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
1917: $env{'course.'.$cid.'.num'}.
1918: ':nohist_expirationdates:'.
1919: &escape($key).'='.$now,
1920: $env{'course.'.$cid.'.home'})
1921: }
1922: return 'ok';
1923: }
1924:
1925: # ----------------------------------------------------- Devalidate Spreadsheets
1926:
1927: sub devalidate {
1928: my ($symb,$uname,$udom)=@_;
1929: my $cid=$env{'request.course.id'};
1930: if ($cid) {
1931: # delete the stored spreadsheets for
1932: # - the student level sheet of this user in course's homespace
1933: # - the assessment level sheet for this resource
1934: # for this user in user's homespace
1935: # - current conditional state info
1936: my $key=$uname.':'.$udom.':';
1937: my $status=
1938: &del('nohist_calculatedsheets',
1939: [$key.'studentcalc:'],
1940: $env{'course.'.$cid.'.domain'},
1941: $env{'course.'.$cid.'.num'})
1942: .' '.
1943: &del('nohist_calculatedsheets_'.$cid,
1944: [$key.'assesscalc:'.$symb],$udom,$uname);
1945: unless ($status eq 'ok ok') {
1946: &logthis('Could not devalidate spreadsheet '.
1947: $uname.' at '.$udom.' for '.
1948: $symb.': '.$status);
1949: }
1950: &delenv('user.state.'.$cid);
1951: }
1952: }
1953:
1954: sub get_scalar {
1955: my ($string,$end) = @_;
1956: my $value;
1957: if ($$string =~ s/^([^&]*?)($end)/$2/) {
1958: $value = $1;
1959: } elsif ($$string =~ s/^([^&]*?)&//) {
1960: $value = $1;
1961: }
1962: return &unescape($value);
1963: }
1964:
1965: sub array2str {
1966: my (@array) = @_;
1967: my $result=&arrayref2str(\@array);
1968: $result=~s/^__ARRAY_REF__//;
1969: $result=~s/__END_ARRAY_REF__$//;
1970: return $result;
1971: }
1972:
1973: sub arrayref2str {
1974: my ($arrayref) = @_;
1975: my $result='__ARRAY_REF__';
1976: foreach my $elem (@$arrayref) {
1977: if(ref($elem) eq 'ARRAY') {
1978: $result.=&arrayref2str($elem).'&';
1979: } elsif(ref($elem) eq 'HASH') {
1980: $result.=&hashref2str($elem).'&';
1981: } elsif(ref($elem)) {
1982: #print("Got a ref of ".(ref($elem))." skipping.");
1983: } else {
1984: $result.=&escape($elem).'&';
1985: }
1986: }
1987: $result=~s/\&$//;
1988: $result .= '__END_ARRAY_REF__';
1989: return $result;
1990: }
1991:
1992: sub hash2str {
1993: my (%hash) = @_;
1994: my $result=&hashref2str(\%hash);
1995: $result=~s/^__HASH_REF__//;
1996: $result=~s/__END_HASH_REF__$//;
1997: return $result;
1998: }
1999:
2000: sub hashref2str {
2001: my ($hashref)=@_;
2002: my $result='__HASH_REF__';
2003: foreach (sort(keys(%$hashref))) {
2004: if (ref($_) eq 'ARRAY') {
2005: $result.=&arrayref2str($_).'=';
2006: } elsif (ref($_) eq 'HASH') {
2007: $result.=&hashref2str($_).'=';
2008: } elsif (ref($_)) {
2009: $result.='=';
2010: #print("Got a ref of ".(ref($_))." skipping.");
2011: } else {
2012: if ($_) {$result.=&escape($_).'=';} else { last; }
2013: }
2014:
2015: if(ref($hashref->{$_}) eq 'ARRAY') {
2016: $result.=&arrayref2str($hashref->{$_}).'&';
2017: } elsif(ref($hashref->{$_}) eq 'HASH') {
2018: $result.=&hashref2str($hashref->{$_}).'&';
2019: } elsif(ref($hashref->{$_})) {
2020: $result.='&';
2021: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
2022: } else {
2023: $result.=&escape($hashref->{$_}).'&';
2024: }
2025: }
2026: $result=~s/\&$//;
2027: $result .= '__END_HASH_REF__';
2028: return $result;
2029: }
2030:
2031: sub str2hash {
2032: my ($string)=@_;
2033: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
2034: return %$hash;
2035: }
2036:
2037: sub str2hashref {
2038: my ($string) = @_;
2039:
2040: my %hash;
2041:
2042: if($string !~ /^__HASH_REF__/) {
2043: if (! ($string eq '' || !defined($string))) {
2044: $hash{'error'}='Not hash reference';
2045: }
2046: return (\%hash, $string);
2047: }
2048:
2049: $string =~ s/^__HASH_REF__//;
2050:
2051: while($string !~ /^__END_HASH_REF__/) {
2052: #key
2053: my $key='';
2054: if($string =~ /^__HASH_REF__/) {
2055: ($key, $string)=&str2hashref($string);
2056: if(defined($key->{'error'})) {
2057: $hash{'error'}='Bad data';
2058: return (\%hash, $string);
2059: }
2060: } elsif($string =~ /^__ARRAY_REF__/) {
2061: ($key, $string)=&str2arrayref($string);
2062: if($key->[0] eq 'Array reference error') {
2063: $hash{'error'}='Bad data';
2064: return (\%hash, $string);
2065: }
2066: } else {
2067: $string =~ s/^(.*?)=//;
2068: $key=&unescape($1);
2069: }
2070: $string =~ s/^=//;
2071:
2072: #value
2073: my $value='';
2074: if($string =~ /^__HASH_REF__/) {
2075: ($value, $string)=&str2hashref($string);
2076: if(defined($value->{'error'})) {
2077: $hash{'error'}='Bad data';
2078: return (\%hash, $string);
2079: }
2080: } elsif($string =~ /^__ARRAY_REF__/) {
2081: ($value, $string)=&str2arrayref($string);
2082: if($value->[0] eq 'Array reference error') {
2083: $hash{'error'}='Bad data';
2084: return (\%hash, $string);
2085: }
2086: } else {
2087: $value=&get_scalar(\$string,'__END_HASH_REF__');
2088: }
2089: $string =~ s/^&//;
2090:
2091: $hash{$key}=$value;
2092: }
2093:
2094: $string =~ s/^__END_HASH_REF__//;
2095:
2096: return (\%hash, $string);
2097: }
2098:
2099: sub str2array {
2100: my ($string)=@_;
2101: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
2102: return @$array;
2103: }
2104:
2105: sub str2arrayref {
2106: my ($string) = @_;
2107: my @array;
2108:
2109: if($string !~ /^__ARRAY_REF__/) {
2110: if (! ($string eq '' || !defined($string))) {
2111: $array[0]='Array reference error';
2112: }
2113: return (\@array, $string);
2114: }
2115:
2116: $string =~ s/^__ARRAY_REF__//;
2117:
2118: while($string !~ /^__END_ARRAY_REF__/) {
2119: my $value='';
2120: if($string =~ /^__HASH_REF__/) {
2121: ($value, $string)=&str2hashref($string);
2122: if(defined($value->{'error'})) {
2123: $array[0] ='Array reference error';
2124: return (\@array, $string);
2125: }
2126: } elsif($string =~ /^__ARRAY_REF__/) {
2127: ($value, $string)=&str2arrayref($string);
2128: if($value->[0] eq 'Array reference error') {
2129: $array[0] ='Array reference error';
2130: return (\@array, $string);
2131: }
2132: } else {
2133: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
2134: }
2135: $string =~ s/^&//;
2136:
2137: push(@array, $value);
2138: }
2139:
2140: $string =~ s/^__END_ARRAY_REF__//;
2141:
2142: return (\@array, $string);
2143: }
2144:
2145: # -------------------------------------------------------------------Temp Store
2146:
2147: sub tmpreset {
2148: my ($symb,$namespace,$domain,$stuname) = @_;
2149: if (!$symb) {
2150: $symb=&symbread();
2151: if (!$symb) { $symb= $env{'request.url'}; }
2152: }
2153: $symb=escape($symb);
2154:
2155: if (!$namespace) { $namespace=$env{'request.state'}; }
2156: $namespace=~s/\//\_/g;
2157: $namespace=~s/\W//g;
2158:
2159: if (!$domain) { $domain=$env{'user.domain'}; }
2160: if (!$stuname) { $stuname=$env{'user.name'}; }
2161: if ($domain eq 'public' && $stuname eq 'public') {
2162: $stuname=$ENV{'REMOTE_ADDR'};
2163: }
2164: my $path=$perlvar{'lonDaemons'}.'/tmp';
2165: my %hash;
2166: if (tie(%hash,'GDBM_File',
2167: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2168: &GDBM_WRCREAT(),0640)) {
2169: foreach my $key (keys %hash) {
2170: if ($key=~ /:$symb/) {
2171: delete($hash{$key});
2172: }
2173: }
2174: }
2175: }
2176:
2177: sub tmpstore {
2178: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2179:
2180: if (!$symb) {
2181: $symb=&symbread();
2182: if (!$symb) { $symb= $env{'request.url'}; }
2183: }
2184: $symb=escape($symb);
2185:
2186: if (!$namespace) {
2187: # I don't think we would ever want to store this for a course.
2188: # it seems this will only be used if we don't have a course.
2189: #$namespace=$env{'request.course.id'};
2190: #if (!$namespace) {
2191: $namespace=$env{'request.state'};
2192: #}
2193: }
2194: $namespace=~s/\//\_/g;
2195: $namespace=~s/\W//g;
2196: if (!$domain) { $domain=$env{'user.domain'}; }
2197: if (!$stuname) { $stuname=$env{'user.name'}; }
2198: if ($domain eq 'public' && $stuname eq 'public') {
2199: $stuname=$ENV{'REMOTE_ADDR'};
2200: }
2201: my $now=time;
2202: my %hash;
2203: my $path=$perlvar{'lonDaemons'}.'/tmp';
2204: if (tie(%hash,'GDBM_File',
2205: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2206: &GDBM_WRCREAT(),0640)) {
2207: $hash{"version:$symb"}++;
2208: my $version=$hash{"version:$symb"};
2209: my $allkeys='';
2210: foreach my $key (keys(%$storehash)) {
2211: $allkeys.=$key.':';
2212: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
2213: }
2214: $hash{"$version:$symb:timestamp"}=$now;
2215: $allkeys.='timestamp';
2216: $hash{"$version:keys:$symb"}=$allkeys;
2217: if (untie(%hash)) {
2218: return 'ok';
2219: } else {
2220: return "error:$!";
2221: }
2222: } else {
2223: return "error:$!";
2224: }
2225: }
2226:
2227: # -----------------------------------------------------------------Temp Restore
2228:
2229: sub tmprestore {
2230: my ($symb,$namespace,$domain,$stuname) = @_;
2231:
2232: if (!$symb) {
2233: $symb=&symbread();
2234: if (!$symb) { $symb= $env{'request.url'}; }
2235: }
2236: $symb=escape($symb);
2237:
2238: if (!$namespace) { $namespace=$env{'request.state'}; }
2239:
2240: if (!$domain) { $domain=$env{'user.domain'}; }
2241: if (!$stuname) { $stuname=$env{'user.name'}; }
2242: if ($domain eq 'public' && $stuname eq 'public') {
2243: $stuname=$ENV{'REMOTE_ADDR'};
2244: }
2245: my %returnhash;
2246: $namespace=~s/\//\_/g;
2247: $namespace=~s/\W//g;
2248: my %hash;
2249: my $path=$perlvar{'lonDaemons'}.'/tmp';
2250: if (tie(%hash,'GDBM_File',
2251: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
2252: &GDBM_READER(),0640)) {
2253: my $version=$hash{"version:$symb"};
2254: $returnhash{'version'}=$version;
2255: my $scope;
2256: for ($scope=1;$scope<=$version;$scope++) {
2257: my $vkeys=$hash{"$scope:keys:$symb"};
2258: my @keys=split(/:/,$vkeys);
2259: my $key;
2260: $returnhash{"$scope:keys"}=$vkeys;
2261: foreach $key (@keys) {
2262: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2263: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
2264: }
2265: }
2266: if (!(untie(%hash))) {
2267: return "error:$!";
2268: }
2269: } else {
2270: return "error:$!";
2271: }
2272: return %returnhash;
2273: }
2274:
2275: # ----------------------------------------------------------------------- Store
2276:
2277: sub store {
2278: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2279: my $home='';
2280:
2281: if ($stuname) { $home=&homeserver($stuname,$domain); }
2282:
2283: $symb=&symbclean($symb);
2284: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2285:
2286: if (!$domain) { $domain=$env{'user.domain'}; }
2287: if (!$stuname) { $stuname=$env{'user.name'}; }
2288:
2289: &devalidate($symb,$stuname,$domain);
2290:
2291: $symb=escape($symb);
2292: if (!$namespace) {
2293: unless ($namespace=$env{'request.course.id'}) {
2294: return '';
2295: }
2296: }
2297: if (!$home) { $home=$env{'user.home'}; }
2298:
2299: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2300: $$storehash{'host'}=$perlvar{'lonHostID'};
2301:
2302: my $namevalue='';
2303: foreach (keys %$storehash) {
2304: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2305: }
2306: $namevalue=~s/\&$//;
2307: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
2308: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2309: }
2310:
2311: # -------------------------------------------------------------- Critical Store
2312:
2313: sub cstore {
2314: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
2315: my $home='';
2316:
2317: if ($stuname) { $home=&homeserver($stuname,$domain); }
2318:
2319: $symb=&symbclean($symb);
2320: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
2321:
2322: if (!$domain) { $domain=$env{'user.domain'}; }
2323: if (!$stuname) { $stuname=$env{'user.name'}; }
2324:
2325: &devalidate($symb,$stuname,$domain);
2326:
2327: $symb=escape($symb);
2328: if (!$namespace) {
2329: unless ($namespace=$env{'request.course.id'}) {
2330: return '';
2331: }
2332: }
2333: if (!$home) { $home=$env{'user.home'}; }
2334:
2335: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
2336: $$storehash{'host'}=$perlvar{'lonHostID'};
2337:
2338: my $namevalue='';
2339: foreach (keys %$storehash) {
2340: $namevalue.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2341: }
2342: $namevalue=~s/\&$//;
2343: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
2344: return critical
2345: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
2346: }
2347:
2348: # --------------------------------------------------------------------- Restore
2349:
2350: sub restore {
2351: my ($symb,$namespace,$domain,$stuname) = @_;
2352: my $home='';
2353:
2354: if ($stuname) { $home=&homeserver($stuname,$domain); }
2355:
2356: if (!$symb) {
2357: unless ($symb=escape(&symbread())) { return ''; }
2358: } else {
2359: $symb=&escape(&symbclean($symb));
2360: }
2361: if (!$namespace) {
2362: unless ($namespace=$env{'request.course.id'}) {
2363: return '';
2364: }
2365: }
2366: if (!$domain) { $domain=$env{'user.domain'}; }
2367: if (!$stuname) { $stuname=$env{'user.name'}; }
2368: if (!$home) { $home=$env{'user.home'}; }
2369: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
2370:
2371: my %returnhash=();
2372: foreach (split(/\&/,$answer)) {
2373: my ($name,$value)=split(/\=/,$_);
2374: $returnhash{&unescape($name)}=&thaw_unescape($value);
2375: }
2376: my $version;
2377: for ($version=1;$version<=$returnhash{'version'};$version++) {
2378: foreach (split(/\:/,$returnhash{$version.':keys'})) {
2379: $returnhash{$_}=$returnhash{$version.':'.$_};
2380: }
2381: }
2382: return %returnhash;
2383: }
2384:
2385: # ---------------------------------------------------------- Course Description
2386:
2387: sub coursedescription {
2388: my $courseid=shift;
2389: $courseid=~s/^\///;
2390: $courseid=~s/\_/\//g;
2391: my ($cdomain,$cnum)=split(/\//,$courseid);
2392: my $chome=&homeserver($cnum,$cdomain);
2393: my $normalid=$cdomain.'_'.$cnum;
2394: # need to always cache even if we get errors otherwise we keep
2395: # trying and trying and trying to get the course description.
2396: my %envhash=();
2397: my %returnhash=();
2398: $envhash{'course.'.$normalid.'.last_cache'}=time;
2399: if ($chome ne 'no_host') {
2400: %returnhash=&dump('environment',$cdomain,$cnum);
2401: if (!exists($returnhash{'con_lost'})) {
2402: $returnhash{'home'}= $chome;
2403: $returnhash{'domain'} = $cdomain;
2404: $returnhash{'num'} = $cnum;
2405: while (my ($name,$value) = each %returnhash) {
2406: $envhash{'course.'.$normalid.'.'.$name}=$value;
2407: }
2408: $returnhash{'url'}=&clutter($returnhash{'url'});
2409: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
2410: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
2411: $envhash{'course.'.$normalid.'.home'}=$chome;
2412: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
2413: $envhash{'course.'.$normalid.'.num'}=$cnum;
2414: }
2415: }
2416: &appenv(%envhash);
2417: return %returnhash;
2418: }
2419:
2420: # -------------------------------------------------See if a user is privileged
2421:
2422: sub privileged {
2423: my ($username,$domain)=@_;
2424: my $rolesdump=&reply("dump:$domain:$username:roles",
2425: &homeserver($username,$domain));
2426: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return 0; }
2427: my $now=time;
2428: if ($rolesdump ne '') {
2429: foreach (split(/&/,$rolesdump)) {
2430: if ($_!~/^rolesdef_/) {
2431: my ($area,$role)=split(/=/,$_);
2432: $area=~s/\_\w\w$//;
2433: my ($trole,$tend,$tstart)=split(/_/,$role);
2434: if (($trole eq 'dc') || ($trole eq 'su')) {
2435: my $active=1;
2436: if ($tend) {
2437: if ($tend<$now) { $active=0; }
2438: }
2439: if ($tstart) {
2440: if ($tstart>$now) { $active=0; }
2441: }
2442: if ($active) { return 1; }
2443: }
2444: }
2445: }
2446: }
2447: return 0;
2448: }
2449:
2450: # -------------------------------------------------------- Get user privileges
2451:
2452: sub rolesinit {
2453: my ($domain,$username,$authhost)=@_;
2454: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
2455: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
2456: my %allroles=();
2457: my $now=time;
2458: my $userroles="user.login.time=$now\n";
2459:
2460: if ($rolesdump ne '') {
2461: foreach (split(/&/,$rolesdump)) {
2462: if ($_!~/^rolesdef_/) {
2463: my ($area,$role)=split(/=/,$_);
2464: $area=~s/\_\w\w$//;
2465:
2466: my ($trole,$tend,$tstart);
2467: if ($role=~/^cr/) {
2468: ($trole,my $trest)=($role=~m|^(cr/\w+/\w+/[a-zA-Z0-9]+)_(.*)$|);
2469: ($tend,$tstart)=split('_',$trest);
2470: } else {
2471: ($trole,$tend,$tstart)=split(/_/,$role);
2472: }
2473: $userroles.=&set_arearole($trole,$area,$tstart,$tend,$domain,$username);
2474: if (($tend!=0) && ($tend<$now)) { $trole=''; }
2475: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
2476: if (($area ne '') && ($trole ne '')) {
2477: my $spec=$trole.'.'.$area;
2478: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
2479: if ($trole =~ /^cr\//) {
2480: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
2481: } else {
2482: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
2483: }
2484: }
2485: }
2486: }
2487: my ($author,$adv) = &set_userprivs(\$userroles,\%allroles);
2488: $userroles.='user.adv='.$adv."\n".
2489: 'user.author='.$author."\n";
2490: $env{'user.adv'}=$adv;
2491: }
2492: return $userroles;
2493: }
2494:
2495: sub set_arearole {
2496: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
2497: # log the associated role with the area
2498: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
2499: return 'user.role.'.$trole.'.'.$area.'='.$tstart.'.'.$tend."\n";
2500: }
2501:
2502: sub custom_roleprivs {
2503: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
2504: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
2505: my $homsvr=homeserver($rauthor,$rdomain);
2506: if ($hostname{$homsvr} ne '') {
2507: my ($rdummy,$roledef)=
2508: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
2509: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
2510: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
2511: if (defined($syspriv)) {
2512: $$allroles{'cm./'}.=':'.$syspriv;
2513: $$allroles{$spec.'./'}.=':'.$syspriv;
2514: }
2515: if ($tdomain ne '') {
2516: if (defined($dompriv)) {
2517: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
2518: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
2519: }
2520: if (($trest ne '') && (defined($coursepriv))) {
2521: $$allroles{'cm.'.$area}.=':'.$coursepriv;
2522: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
2523: }
2524: }
2525: }
2526: }
2527: }
2528:
2529:
2530: sub standard_roleprivs {
2531: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
2532: if (defined($pr{$trole.':s'})) {
2533: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
2534: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
2535: }
2536: if ($tdomain ne '') {
2537: if (defined($pr{$trole.':d'})) {
2538: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2539: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
2540: }
2541: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
2542: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
2543: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
2544: }
2545: }
2546: }
2547:
2548: sub set_userprivs {
2549: my ($userroles,$allroles) = @_;
2550: my $author=0;
2551: my $adv=0;
2552: foreach (keys %{$allroles}) {
2553: my %thesepriv=();
2554: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
2555: foreach (split(/:/,$$allroles{$_})) {
2556: if ($_ ne '') {
2557: my ($privilege,$restrictions)=split(/&/,$_);
2558: if ($restrictions eq '') {
2559: $thesepriv{$privilege}='F';
2560: } elsif ($thesepriv{$privilege} ne 'F') {
2561: $thesepriv{$privilege}.=$restrictions;
2562: }
2563: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
2564: }
2565: }
2566: my $thesestr='';
2567: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
2568: $$userroles.='user.priv.'.$_.'='.$thesestr."\n";
2569: }
2570: return ($author,$adv);
2571: }
2572:
2573: # --------------------------------------------------------------- get interface
2574:
2575: sub get {
2576: my ($namespace,$storearr,$udomain,$uname)=@_;
2577: my $items='';
2578: foreach (@$storearr) {
2579: $items.=escape($_).'&';
2580: }
2581: $items=~s/\&$//;
2582: if (!$udomain) { $udomain=$env{'user.domain'}; }
2583: if (!$uname) { $uname=$env{'user.name'}; }
2584: my $uhome=&homeserver($uname,$udomain);
2585:
2586: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
2587: my @pairs=split(/\&/,$rep);
2588: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2589: return @pairs;
2590: }
2591: my %returnhash=();
2592: my $i=0;
2593: foreach (@$storearr) {
2594: $returnhash{$_}=&thaw_unescape($pairs[$i]);
2595: $i++;
2596: }
2597: return %returnhash;
2598: }
2599:
2600: # --------------------------------------------------------------- del interface
2601:
2602: sub del {
2603: my ($namespace,$storearr,$udomain,$uname)=@_;
2604: my $items='';
2605: foreach (@$storearr) {
2606: $items.=escape($_).'&';
2607: }
2608: $items=~s/\&$//;
2609: if (!$udomain) { $udomain=$env{'user.domain'}; }
2610: if (!$uname) { $uname=$env{'user.name'}; }
2611: my $uhome=&homeserver($uname,$udomain);
2612:
2613: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
2614: }
2615:
2616: # -------------------------------------------------------------- dump interface
2617:
2618: sub dump {
2619: my ($namespace,$udomain,$uname,$regexp)=@_;
2620: if (!$udomain) { $udomain=$env{'user.domain'}; }
2621: if (!$uname) { $uname=$env{'user.name'}; }
2622: my $uhome=&homeserver($uname,$udomain);
2623: if ($regexp) {
2624: $regexp=&escape($regexp);
2625: } else {
2626: $regexp='.';
2627: }
2628: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
2629: my @pairs=split(/\&/,$rep);
2630: my %returnhash=();
2631: foreach (@pairs) {
2632: my ($key,$value)=split(/=/,$_);
2633: $returnhash{unescape($key)}=&thaw_unescape($value);
2634: }
2635: return %returnhash;
2636: }
2637:
2638: # -------------------------------------------------------------- keys interface
2639:
2640: sub getkeys {
2641: my ($namespace,$udomain,$uname)=@_;
2642: if (!$udomain) { $udomain=$env{'user.domain'}; }
2643: if (!$uname) { $uname=$env{'user.name'}; }
2644: my $uhome=&homeserver($uname,$udomain);
2645: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
2646: my @keyarray=();
2647: foreach (split(/\&/,$rep)) {
2648: push (@keyarray,&unescape($_));
2649: }
2650: return @keyarray;
2651: }
2652:
2653: # --------------------------------------------------------------- currentdump
2654: sub currentdump {
2655: my ($courseid,$sdom,$sname)=@_;
2656: $courseid = $env{'request.course.id'} if (! defined($courseid));
2657: $sdom = $env{'user.domain'} if (! defined($sdom));
2658: $sname = $env{'user.name'} if (! defined($sname));
2659: my $uhome = &homeserver($sname,$sdom);
2660: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
2661: return if ($rep =~ /^(error:|no_such_host)/);
2662: #
2663: my %returnhash=();
2664: #
2665: if ($rep eq "unknown_cmd") {
2666: # an old lond will not know currentdump
2667: # Do a dump and make it look like a currentdump
2668: my @tmp = &dump($courseid,$sdom,$sname,'.');
2669: return if ($tmp[0] =~ /^(error:|no_such_host)/);
2670: my %hash = @tmp;
2671: @tmp=();
2672: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
2673: } else {
2674: my @pairs=split(/\&/,$rep);
2675: foreach (@pairs) {
2676: my ($key,$value)=split(/=/,$_);
2677: my ($symb,$param) = split(/:/,$key);
2678: $returnhash{&unescape($symb)}->{&unescape($param)} =
2679: &thaw_unescape($value);
2680: }
2681: }
2682: return %returnhash;
2683: }
2684:
2685: sub convert_dump_to_currentdump{
2686: my %hash = %{shift()};
2687: my %returnhash;
2688: # Code ripped from lond, essentially. The only difference
2689: # here is the unescaping done by lonnet::dump(). Conceivably
2690: # we might run in to problems with parameter names =~ /^v\./
2691: while (my ($key,$value) = each(%hash)) {
2692: my ($v,$symb,$param) = split(/:/,$key);
2693: next if ($v eq 'version' || $symb eq 'keys');
2694: next if (exists($returnhash{$symb}) &&
2695: exists($returnhash{$symb}->{$param}) &&
2696: $returnhash{$symb}->{'v.'.$param} > $v);
2697: $returnhash{$symb}->{$param}=$value;
2698: $returnhash{$symb}->{'v.'.$param}=$v;
2699: }
2700: #
2701: # Remove all of the keys in the hashes which keep track of
2702: # the version of the parameter.
2703: while (my ($symb,$param_hash) = each(%returnhash)) {
2704: # use a foreach because we are going to delete from the hash.
2705: foreach my $key (keys(%$param_hash)) {
2706: delete($param_hash->{$key}) if ($key =~ /^v\./);
2707: }
2708: }
2709: return \%returnhash;
2710: }
2711:
2712: # ------------------------------------------------------ critical inc interface
2713:
2714: sub cinc {
2715: return &inc(@_,'critical');
2716: }
2717:
2718: # --------------------------------------------------------------- inc interface
2719:
2720: sub inc {
2721: my ($namespace,$store,$udomain,$uname,$critical) = @_;
2722: if (!$udomain) { $udomain=$env{'user.domain'}; }
2723: if (!$uname) { $uname=$env{'user.name'}; }
2724: my $uhome=&homeserver($uname,$udomain);
2725: my $items='';
2726: if (! ref($store)) {
2727: # got a single value, so use that instead
2728: $items = &escape($store).'=&';
2729: } elsif (ref($store) eq 'SCALAR') {
2730: $items = &escape($$store).'=&';
2731: } elsif (ref($store) eq 'ARRAY') {
2732: $items = join('=&',map {&escape($_);} @{$store});
2733: } elsif (ref($store) eq 'HASH') {
2734: while (my($key,$value) = each(%{$store})) {
2735: $items.= &escape($key).'='.&escape($value).'&';
2736: }
2737: }
2738: $items=~s/\&$//;
2739: if ($critical) {
2740: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
2741: } else {
2742: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
2743: }
2744: }
2745:
2746: # --------------------------------------------------------------- put interface
2747:
2748: sub put {
2749: my ($namespace,$storehash,$udomain,$uname)=@_;
2750: if (!$udomain) { $udomain=$env{'user.domain'}; }
2751: if (!$uname) { $uname=$env{'user.name'}; }
2752: my $uhome=&homeserver($uname,$udomain);
2753: my $items='';
2754: foreach (keys %$storehash) {
2755: $items.=&escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2756: }
2757: $items=~s/\&$//;
2758: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
2759: }
2760:
2761: # ------------------------------------------------------------ newput interface
2762:
2763: sub newput {
2764: my ($namespace,$storehash,$udomain,$uname)=@_;
2765: if (!$udomain) { $udomain=$env{'user.domain'}; }
2766: if (!$uname) { $uname=$env{'user.name'}; }
2767: my $uhome=&homeserver($uname,$udomain);
2768: my $items='';
2769: foreach my $key (keys(%$storehash)) {
2770: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2771: }
2772: $items=~s/\&$//;
2773: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
2774: }
2775:
2776: # --------------------------------------------------------- putstore interface
2777:
2778: sub putstore {
2779: my ($namespace,$storehash,$udomain,$uname)=@_;
2780: if (!$udomain) { $udomain=$env{'user.domain'}; }
2781: if (!$uname) { $uname=$env{'user.name'}; }
2782: my $uhome=&homeserver($uname,$udomain);
2783: my $items='';
2784: my %allitems = ();
2785: foreach (keys %$storehash) {
2786: if ($_ =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
2787: my $key = $1.':keys:'.$2;
2788: $allitems{$key} .= $3.':';
2789: }
2790: $items.=$_.'='.&freeze_escape($$storehash{$_}).'&';
2791: }
2792: foreach (keys %allitems) {
2793: $allitems{$_} =~ s/\:$//;
2794: $items.= $_.'='.$allitems{$_}.'&';
2795: }
2796: $items=~s/\&$//;
2797: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
2798: }
2799:
2800: # ------------------------------------------------------ critical put interface
2801:
2802: sub cput {
2803: my ($namespace,$storehash,$udomain,$uname)=@_;
2804: if (!$udomain) { $udomain=$env{'user.domain'}; }
2805: if (!$uname) { $uname=$env{'user.name'}; }
2806: my $uhome=&homeserver($uname,$udomain);
2807: my $items='';
2808: foreach (keys %$storehash) {
2809: $items.=escape($_).'='.&freeze_escape($$storehash{$_}).'&';
2810: }
2811: $items=~s/\&$//;
2812: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
2813: }
2814:
2815: # -------------------------------------------------------------- eget interface
2816:
2817: sub eget {
2818: my ($namespace,$storearr,$udomain,$uname)=@_;
2819: my $items='';
2820: foreach (@$storearr) {
2821: $items.=escape($_).'&';
2822: }
2823: $items=~s/\&$//;
2824: if (!$udomain) { $udomain=$env{'user.domain'}; }
2825: if (!$uname) { $uname=$env{'user.name'}; }
2826: my $uhome=&homeserver($uname,$udomain);
2827: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
2828: my @pairs=split(/\&/,$rep);
2829: my %returnhash=();
2830: my $i=0;
2831: foreach (@$storearr) {
2832: $returnhash{$_}=&thaw_unescape($pairs[$i]);
2833: $i++;
2834: }
2835: return %returnhash;
2836: }
2837:
2838: # ---------------------------------------------- Custom access rule evaluation
2839:
2840: sub customaccess {
2841: my ($priv,$uri)=@_;
2842: my ($urole,$urealm)=split(/\./,$env{'request.role'});
2843: $urealm=~s/^\W//;
2844: my ($udom,$ucrs,$usec)=split(/\//,$urealm);
2845: my $access=0;
2846: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
2847: my ($effect,$realm,$role)=split(/\:/,$_);
2848: if ($role) {
2849: if ($role ne $urole) { next; }
2850: }
2851: foreach (split(/\s*\,\s*/,$realm)) {
2852: my ($tdom,$tcrs,$tsec)=split(/\_/,$_);
2853: if ($tdom) {
2854: if ($tdom ne $udom) { next; }
2855: }
2856: if ($tcrs) {
2857: if ($tcrs ne $ucrs) { next; }
2858: }
2859: if ($tsec) {
2860: if ($tsec ne $usec) { next; }
2861: }
2862: $access=($effect eq 'allow');
2863: last;
2864: }
2865: if ($realm eq '' && $role eq '') {
2866: $access=($effect eq 'allow');
2867: }
2868: }
2869: return $access;
2870: }
2871:
2872: # ------------------------------------------------- Check for a user privilege
2873:
2874: sub allowed {
2875: my ($priv,$uri,$symb)=@_;
2876: $uri=&deversion($uri);
2877: my $orguri=$uri;
2878: $uri=&declutter($uri);
2879:
2880:
2881:
2882: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
2883: # Free bre access to adm and meta resources
2884: if (((($uri=~/^adm\//) && ($uri !~ m|/bulletinboard$|))
2885: || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
2886: return 'F';
2887: }
2888:
2889: # Free bre access to user's own portfolio contents
2890: my ($space,$domain,$name,$dir)=split('/',$uri);
2891: if (($space=~/^(uploaded|ediupload)$/) && ($env{'user.name'} eq $name) &&
2892: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir)) {
2893: return 'F';
2894: }
2895:
2896: # Free bre to public access
2897:
2898: if ($priv eq 'bre') {
2899: my $copyright=&metadata($uri,'copyright');
2900: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
2901: return 'F';
2902: }
2903: if ($copyright eq 'priv') {
2904: $uri=~/([^\/]+)\/([^\/]+)\//;
2905: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
2906: return '';
2907: }
2908: }
2909: if ($copyright eq 'domain') {
2910: $uri=~/([^\/]+)\/([^\/]+)\//;
2911: unless (($env{'user.domain'} eq $1) ||
2912: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
2913: return '';
2914: }
2915: }
2916: if ($env{'request.role'}=~ /li\.\//) {
2917: # Library role, so allow browsing of resources in this domain.
2918: return 'F';
2919: }
2920: if ($copyright eq 'custom') {
2921: unless (&customaccess($priv,$uri)) { return ''; }
2922: }
2923: }
2924: # Domain coordinator is trying to create a course
2925: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
2926: # uri is the requested domain in this case.
2927: # comparison to 'request.role.domain' shows if the user has selected
2928: # a role of dc for the domain in question.
2929: return 'F' if ($uri eq $env{'request.role.domain'});
2930: }
2931:
2932: my $thisallowed='';
2933: my $statecond=0;
2934: my $courseprivid='';
2935:
2936: # Course
2937:
2938: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
2939: $thisallowed.=$1;
2940: }
2941:
2942: # Domain
2943:
2944: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
2945: =~/\Q$priv\E\&([^\:]*)/) {
2946: $thisallowed.=$1;
2947: }
2948:
2949: # Course: uri itself is a course
2950: my $courseuri=$uri;
2951: $courseuri=~s/\_(\d)/\/$1/;
2952: $courseuri=~s/^([^\/])/\/$1/;
2953:
2954: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
2955: =~/\Q$priv\E\&([^\:]*)/) {
2956: $thisallowed.=$1;
2957: }
2958:
2959: # URI is an uploaded document for this course
2960: # not allowing 'edit' access (editupload) to uploaded course docs
2961: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
2962: my $refuri=$env{'httpref.'.$orguri};
2963: if ($refuri) {
2964: if ($refuri =~ m|^/adm/|) {
2965: $thisallowed='F';
2966: }
2967: }
2968: }
2969:
2970: # Full access at system, domain or course-wide level? Exit.
2971:
2972: if ($thisallowed=~/F/) {
2973: return 'F';
2974: }
2975:
2976: # If this is generating or modifying users, exit with special codes
2977:
2978: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:\Q$priv\E\:/) {
2979: return $thisallowed;
2980: }
2981: #
2982: # Gathered so far: system, domain and course wide privileges
2983: #
2984: # Course: See if uri or referer is an individual resource that is part of
2985: # the course
2986:
2987: if ($env{'request.course.id'}) {
2988:
2989: $courseprivid=$env{'request.course.id'};
2990: if ($env{'request.course.sec'}) {
2991: $courseprivid.='/'.$env{'request.course.sec'};
2992: }
2993: $courseprivid=~s/\_/\//;
2994: my $checkreferer=1;
2995: my ($match,$cond)=&is_on_map($uri);
2996: if ($match) {
2997: $statecond=$cond;
2998: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
2999: =~/\Q$priv\E\&([^\:]*)/) {
3000: $thisallowed.=$1;
3001: $checkreferer=0;
3002: }
3003: }
3004:
3005: if ($checkreferer) {
3006: my $refuri=$env{'httpref.'.$orguri};
3007: unless ($refuri) {
3008: foreach (keys %env) {
3009: if ($_=~/^httpref\..*\*/) {
3010: my $pattern=$_;
3011: $pattern=~s/^httpref\.\/res\///;
3012: $pattern=~s/\*/\[\^\/\]\+/g;
3013: $pattern=~s/\//\\\//g;
3014: if ($orguri=~/$pattern/) {
3015: $refuri=$env{$_};
3016: }
3017: }
3018: }
3019: }
3020:
3021: if ($refuri) {
3022: $refuri=&declutter($refuri);
3023: my ($match,$cond)=&is_on_map($refuri);
3024: if ($match) {
3025: my $refstatecond=$cond;
3026: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
3027: =~/\Q$priv\E\&([^\:]*)/) {
3028: $thisallowed.=$1;
3029: $uri=$refuri;
3030: $statecond=$refstatecond;
3031: }
3032: }
3033: }
3034: }
3035: }
3036:
3037: #
3038: # Gathered now: all privileges that could apply, and condition number
3039: #
3040: #
3041: # Full or no access?
3042: #
3043:
3044: if ($thisallowed=~/F/) {
3045: return 'F';
3046: }
3047:
3048: unless ($thisallowed) {
3049: return '';
3050: }
3051:
3052: # Restrictions exist, deal with them
3053: #
3054: # C:according to course preferences
3055: # R:according to resource settings
3056: # L:unless locked
3057: # X:according to user session state
3058: #
3059:
3060: # Possibly locked functionality, check all courses
3061: # Locks might take effect only after 10 minutes cache expiration for other
3062: # courses, and 2 minutes for current course
3063:
3064: my $envkey;
3065: if ($thisallowed=~/L/) {
3066: foreach $envkey (keys %env) {
3067: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
3068: my $courseid=$2;
3069: my $roleid=$1.'.'.$2;
3070: $courseid=~s/^\///;
3071: my $expiretime=600;
3072: if ($env{'request.role'} eq $roleid) {
3073: $expiretime=120;
3074: }
3075: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
3076: my $prefix='course.'.$cdom.'_'.$cnum.'.';
3077: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
3078: &coursedescription($courseid);
3079: }
3080: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
3081: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
3082: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
3083: &log($env{'user.domain'},$env{'user.name'},
3084: $env{'user.home'},
3085: 'Locked by res: '.$priv.' for '.$uri.' due to '.
3086: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3087: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3088: return '';
3089: }
3090: }
3091: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
3092: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
3093: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
3094: &log($env{'user.domain'},$env{'user.name'},
3095: $env{'user.home'},
3096: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
3097: $cdom.'/'.$cnum.'/'.$csec.' expire '.
3098: $env{$prefix.'priv.'.$priv.'.lock.expire'});
3099: return '';
3100: }
3101: }
3102: }
3103: }
3104: }
3105:
3106: #
3107: # Rest of the restrictions depend on selected course
3108: #
3109:
3110: unless ($env{'request.course.id'}) {
3111: return '1';
3112: }
3113:
3114: #
3115: # Now user is definitely in a course
3116: #
3117:
3118:
3119: # Course preferences
3120:
3121: if ($thisallowed=~/C/) {
3122: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3123: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
3124: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
3125: =~/\Q$rolecode\E/) {
3126: &log($env{'user.domain'},$env{'user.name'},$env{'user.host'},
3127: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
3128: $env{'request.course.id'});
3129: return '';
3130: }
3131:
3132: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
3133: =~/\Q$unamedom\E/) {
3134: &log($env{'user.domain'},$env{'user.name'},$env{'user.host'},
3135: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
3136: $env{'request.course.id'});
3137: return '';
3138: }
3139: }
3140:
3141: # Resource preferences
3142:
3143: if ($thisallowed=~/R/) {
3144: my $rolecode=(split(/\./,$env{'request.role'}))[0];
3145: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
3146: &log($env{'user.domain'},$env{'user.name'},$env{'user.host'},
3147: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
3148: return '';
3149: }
3150: }
3151:
3152: # Restricted by state or randomout?
3153:
3154: if ($thisallowed=~/X/) {
3155: if ($env{'acc.randomout'}) {
3156: if (!$symb) { $symb=&symbread($uri,1); }
3157: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
3158: return '';
3159: }
3160: }
3161: if (&condval($statecond)) {
3162: return '2';
3163: } else {
3164: return '';
3165: }
3166: }
3167:
3168: return 'F';
3169: }
3170:
3171: # --------------------------------------------------- Is a resource on the map?
3172:
3173: sub is_on_map {
3174: my $uri=&declutter(shift);
3175: $uri=~s/\.\d+\.(\w+)$/\.$1/;
3176: my @uriparts=split(/\//,$uri);
3177: my $filename=$uriparts[$#uriparts];
3178: my $pathname=$uri;
3179: $pathname=~s|/\Q$filename\E$||;
3180: $pathname=~s/^adm\/wrapper\///;
3181: #Trying to find the conditional for the file
3182: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3183: /\&\Q$filename\E\:([\d\|]+)\&/);
3184: if ($match) {
3185: return (1,$1);
3186: } else {
3187: return (0,0);
3188: }
3189: }
3190:
3191: # --------------------------------------------------------- Get symb from alias
3192:
3193: sub get_symb_from_alias {
3194: my $symb=shift;
3195: my ($map,$resid,$url)=&decode_symb($symb);
3196: # Already is a symb
3197: if ($url) { return $symb; }
3198: # Must be an alias
3199: my $aliassymb='';
3200: my %bighash;
3201: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
3202: &GDBM_READER(),0640)) {
3203: my $rid=$bighash{'mapalias_'.$symb};
3204: if ($rid) {
3205: my ($mapid,$resid)=split(/\./,$rid);
3206: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
3207: $resid,$bighash{'src_'.$rid});
3208: }
3209: untie %bighash;
3210: }
3211: return $aliassymb;
3212: }
3213:
3214: # ----------------------------------------------------------------- Define Role
3215:
3216: sub definerole {
3217: if (allowed('mcr','/')) {
3218: my ($rolename,$sysrole,$domrole,$courole)=@_;
3219: foreach (split(':',$sysrole)) {
3220: my ($crole,$cqual)=split(/\&/,$_);
3221: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
3222: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
3223: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3224: return "refused:s:$crole&$cqual";
3225: }
3226: }
3227: }
3228: foreach (split(':',$domrole)) {
3229: my ($crole,$cqual)=split(/\&/,$_);
3230: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
3231: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
3232: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
3233: return "refused:d:$crole&$cqual";
3234: }
3235: }
3236: }
3237: foreach (split(':',$courole)) {
3238: my ($crole,$cqual)=split(/\&/,$_);
3239: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
3240: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
3241: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
3242: return "refused:c:$crole&$cqual";
3243: }
3244: }
3245: }
3246: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3247: "$env{'user.domain'}:$env{'user.name'}:".
3248: "rolesdef_$rolename=".
3249: escape($sysrole.'_'.$domrole.'_'.$courole);
3250: return reply($command,$env{'user.home'});
3251: } else {
3252: return 'refused';
3253: }
3254: }
3255:
3256: # ---------------- Make a metadata query against the network of library servers
3257:
3258: sub metadata_query {
3259: my ($query,$custom,$customshow,$server_array)=@_;
3260: my %rhash;
3261: my @server_list = (defined($server_array) ? @$server_array
3262: : keys(%libserv) );
3263: for my $server (@server_list) {
3264: unless ($custom or $customshow) {
3265: my $reply=&reply("querysend:".&escape($query),$server);
3266: $rhash{$server}=$reply;
3267: }
3268: else {
3269: my $reply=&reply("querysend:".&escape($query).':'.
3270: &escape($custom).':'.&escape($customshow),
3271: $server);
3272: $rhash{$server}=$reply;
3273: }
3274: }
3275: return \%rhash;
3276: }
3277:
3278: # ----------------------------------------- Send log queries and wait for reply
3279:
3280: sub log_query {
3281: my ($uname,$udom,$query,%filters)=@_;
3282: my $uhome=&homeserver($uname,$udom);
3283: if ($uhome eq 'no_host') { return 'error: no_host'; }
3284: my $uhost=$hostname{$uhome};
3285: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
3286: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
3287: $uhome);
3288: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
3289: return get_query_reply($queryid);
3290: }
3291:
3292: # ------- Request retrieval of institutional classlists for course(s)
3293:
3294: sub fetch_enrollment_query {
3295: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
3296: my $homeserver;
3297: my $maxtries = 1;
3298: if ($context eq 'automated') {
3299: $homeserver = $perlvar{'lonHostID'};
3300: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
3301: } else {
3302: $homeserver = &homeserver($cnum,$dom);
3303: }
3304: my $host=$hostname{$homeserver};
3305: my $cmd = '';
3306: foreach (keys %{$affiliatesref}) {
3307: $cmd .= $_.'='.join(",",@{$$affiliatesref{$_}}).'%%';
3308: }
3309: $cmd =~ s/%%$//;
3310: $cmd = &escape($cmd);
3311: my $query = 'fetchenrollment';
3312: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
3313: unless ($queryid=~/^\Q$host\E\_/) {
3314: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
3315: return 'error: '.$queryid;
3316: }
3317: my $reply = &get_query_reply($queryid);
3318: my $tries = 1;
3319: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
3320: $reply = &get_query_reply($queryid);
3321: $tries ++;
3322: }
3323: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
3324: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
3325: } else {
3326: my @responses = split/:/,$reply;
3327: if ($homeserver eq $perlvar{'lonHostID'}) {
3328: foreach (@responses) {
3329: my ($key,$value) = split/=/,$_;
3330: $$replyref{$key} = $value;
3331: }
3332: } else {
3333: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
3334: foreach (@responses) {
3335: my ($key,$value) = split/=/,$_;
3336: $$replyref{$key} = $value;
3337: if ($value > 0) {
3338: foreach (@{$$affiliatesref{$key}}) {
3339: my $filename = $dom.'_'.$key.'_'.$_.'_classlist.xml';
3340: my $destname = $pathname.'/'.$filename;
3341: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
3342: if ($xml_classlist =~ /^error/) {
3343: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
3344: } else {
3345: if ( open(FILE,">$destname") ) {
3346: print FILE &unescape($xml_classlist);
3347: close(FILE);
3348: } else {
3349: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
3350: }
3351: }
3352: }
3353: }
3354: }
3355: }
3356: return 'ok';
3357: }
3358: return 'error';
3359: }
3360:
3361: sub get_query_reply {
3362: my $queryid=shift;
3363: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
3364: my $reply='';
3365: for (1..100) {
3366: sleep 2;
3367: if (-e $replyfile.'.end') {
3368: if (open(my $fh,$replyfile)) {
3369: $reply.=<$fh>;
3370: close($fh);
3371: } else { return 'error: reply_file_error'; }
3372: return &unescape($reply);
3373: }
3374: }
3375: return 'timeout:'.$queryid;
3376: }
3377:
3378: sub courselog_query {
3379: #
3380: # possible filters:
3381: # url: url or symb
3382: # username
3383: # domain
3384: # action: view, submit, grade
3385: # start: timestamp
3386: # end: timestamp
3387: #
3388: my (%filters)=@_;
3389: unless ($env{'request.course.id'}) { return 'no_course'; }
3390: if ($filters{'url'}) {
3391: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
3392: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
3393: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
3394: }
3395: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
3396: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3397: return &log_query($cname,$cdom,'courselog',%filters);
3398: }
3399:
3400: sub userlog_query {
3401: my ($uname,$udom,%filters)=@_;
3402: return &log_query($uname,$udom,'userlog',%filters);
3403: }
3404:
3405: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
3406:
3407: sub auto_run {
3408: my ($cnum,$cdom) = @_;
3409: my $homeserver = &homeserver($cnum,$cdom);
3410: my $response = &reply('autorun:'.$cdom,$homeserver);
3411: return $response;
3412: }
3413:
3414: sub auto_get_sections {
3415: my ($cnum,$cdom,$inst_coursecode) = @_;
3416: my $homeserver = &homeserver($cnum,$cdom);
3417: my @secs = ();
3418: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
3419: unless ($response eq 'refused') {
3420: @secs = split/:/,$response;
3421: }
3422: return @secs;
3423: }
3424:
3425: sub auto_new_course {
3426: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
3427: my $homeserver = &homeserver($cnum,$cdom);
3428: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
3429: return $response;
3430: }
3431:
3432: sub auto_validate_courseID {
3433: my ($cnum,$cdom,$inst_course_id) = @_;
3434: my $homeserver = &homeserver($cnum,$cdom);
3435: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
3436: return $response;
3437: }
3438:
3439: sub auto_create_password {
3440: my ($cnum,$cdom,$authparam) = @_;
3441: my $homeserver = &homeserver($cnum,$cdom);
3442: my $create_passwd = 0;
3443: my $authchk = '';
3444: my $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
3445: if ($response eq 'refused') {
3446: $authchk = 'refused';
3447: } else {
3448: ($authparam,$create_passwd,$authchk) = split/:/,$response;
3449: }
3450: return ($authparam,$create_passwd,$authchk);
3451: }
3452:
3453: sub auto_instcode_format {
3454: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,$cat_order) = @_;
3455: my $courses = '';
3456: my $homeserver;
3457: if ($caller eq 'global') {
3458: foreach my $tryserver (keys %libserv) {
3459: if ($hostdom{$tryserver} eq $codedom) {
3460: $homeserver = $tryserver;
3461: last;
3462: }
3463: }
3464: if (($env{'user.name'}) && ($env{'user.domain'} eq $codedom)) {
3465: $homeserver = &homeserver($env{'user.name'},$codedom);
3466: }
3467: } else {
3468: $homeserver = &homeserver($caller,$codedom);
3469: }
3470: foreach (keys %{$instcodes}) {
3471: $courses .= &escape($_).'='.&escape($$instcodes{$_}).'&';
3472: }
3473: chop($courses);
3474: my $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$homeserver);
3475: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
3476: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) = split/:/,$response;
3477: %{$codes} = &str2hash($codes_str);
3478: @{$codetitles} = &str2array($codetitles_str);
3479: %{$cat_titles} = &str2hash($cat_titles_str);
3480: %{$cat_order} = &str2hash($cat_order_str);
3481: return 'ok';
3482: }
3483: return $response;
3484: }
3485:
3486: # ------------------------------------------------------------------ Plain Text
3487:
3488: sub plaintext {
3489: my $short=shift;
3490: return &mt($prp{$short});
3491: }
3492:
3493: # ----------------------------------------------------------------- Assign Role
3494:
3495: sub assignrole {
3496: my ($udom,$uname,$url,$role,$end,$start,$deleteflag)=@_;
3497: my $mrole;
3498: if ($role =~ /^cr\//) {
3499: my $cwosec=$url;
3500: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
3501: unless (&allowed('ccr',$cwosec)) {
3502: &logthis('Refused custom assignrole: '.
3503: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
3504: $env{'user.name'}.' at '.$env{'user.domain'});
3505: return 'refused';
3506: }
3507: $mrole='cr';
3508: } else {
3509: my $cwosec=$url;
3510: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
3511: unless ((&allowed('c'.$role,$cwosec)) || &allowed('c'.$role,$udom)) {
3512: &logthis('Refused assignrole: '.
3513: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
3514: $env{'user.name'}.' at '.$env{'user.domain'});
3515: return 'refused';
3516: }
3517: $mrole=$role;
3518: }
3519: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
3520: "$udom:$uname:$url".'_'."$mrole=$role";
3521: if ($end) { $command.='_'.$end; }
3522: if ($start) {
3523: if ($end) {
3524: $command.='_'.$start;
3525: } else {
3526: $command.='_0_'.$start;
3527: }
3528: }
3529: # actually delete
3530: if ($deleteflag) {
3531: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
3532: # modify command to delete the role
3533: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
3534: "$udom:$uname:$url".'_'."$mrole";
3535: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
3536: # set start and finish to negative values for userrolelog
3537: $start=-1;
3538: $end=-1;
3539: }
3540: }
3541: # send command
3542: my $answer=&reply($command,&homeserver($uname,$udom));
3543: # log new user role if status is ok
3544: if ($answer eq 'ok') {
3545: &userrolelog($mrole,$uname,$udom,$url,$start,$end);
3546: }
3547: return $answer;
3548: }
3549:
3550: # -------------------------------------------------- Modify user authentication
3551: # Overrides without validation
3552:
3553: sub modifyuserauth {
3554: my ($udom,$uname,$umode,$upass)=@_;
3555: my $uhome=&homeserver($uname,$udom);
3556: unless (&allowed('mau',$udom)) { return 'refused'; }
3557: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
3558: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
3559: ' in domain '.$env{'request.role.domain'});
3560: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
3561: &escape($upass),$uhome);
3562: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
3563: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
3564: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
3565: &log($udom,,$uname,$uhome,
3566: 'Authentication changed by '.$env{'user.domain'}.', '.
3567: $env{'user.name'}.', '.$umode.
3568: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
3569: unless ($reply eq 'ok') {
3570: &logthis('Authentication mode error: '.$reply);
3571: return 'error: '.$reply;
3572: }
3573: return 'ok';
3574: }
3575:
3576: # --------------------------------------------------------------- Modify a user
3577:
3578: sub modifyuser {
3579: my ($udom, $uname, $uid,
3580: $umode, $upass, $first,
3581: $middle, $last, $gene,
3582: $forceid, $desiredhome, $email)=@_;
3583: $udom=~s/\W//g;
3584: $uname=~s/\W//g;
3585: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
3586: $umode.', '.$first.', '.$middle.', '.
3587: $last.', '.$gene.'(forceid: '.$forceid.')'.
3588: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
3589: ' desiredhome not specified').
3590: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
3591: ' in domain '.$env{'request.role.domain'});
3592: my $uhome=&homeserver($uname,$udom,'true');
3593: # ----------------------------------------------------------------- Create User
3594: if (($uhome eq 'no_host') &&
3595: (($umode && $upass) || ($umode eq 'localauth'))) {
3596: my $unhome='';
3597: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
3598: $unhome = $desiredhome;
3599: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
3600: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
3601: } else { # load balancing routine for determining $unhome
3602: my $tryserver;
3603: my $loadm=10000000;
3604: foreach $tryserver (keys %libserv) {
3605: if ($hostdom{$tryserver} eq $udom) {
3606: my $answer=reply('load',$tryserver);
3607: if (($answer=~/\d+/) && ($answer<$loadm)) {
3608: $loadm=$answer;
3609: $unhome=$tryserver;
3610: }
3611: }
3612: }
3613: }
3614: if (($unhome eq '') || ($unhome eq 'no_host')) {
3615: return 'error: unable to find a home server for '.$uname.
3616: ' in domain '.$udom;
3617: }
3618: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
3619: &escape($upass),$unhome);
3620: unless ($reply eq 'ok') {
3621: return 'error: '.$reply;
3622: }
3623: $uhome=&homeserver($uname,$udom,'true');
3624: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
3625: return 'error: unable verify users home machine.';
3626: }
3627: } # End of creation of new user
3628: # ---------------------------------------------------------------------- Add ID
3629: if ($uid) {
3630: $uid=~tr/A-Z/a-z/;
3631: my %uidhash=&idrget($udom,$uname);
3632: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
3633: && (!$forceid)) {
3634: unless ($uid eq $uidhash{$uname}) {
3635: return 'error: user id "'.$uid.'" does not match '.
3636: 'current user id "'.$uidhash{$uname}.'".';
3637: }
3638: } else {
3639: &idput($udom,($uname => $uid));
3640: }
3641: }
3642: # -------------------------------------------------------------- Add names, etc
3643: my @tmp=&get('environment',
3644: ['firstname','middlename','lastname','generation'],
3645: $udom,$uname);
3646: my %names;
3647: if ($tmp[0] =~ m/^error:.*/) {
3648: %names=();
3649: } else {
3650: %names = @tmp;
3651: }
3652: #
3653: # Make sure to not trash student environment if instructor does not bother
3654: # to supply name and email information
3655: #
3656: if ($first) { $names{'firstname'} = $first; }
3657: if (defined($middle)) { $names{'middlename'} = $middle; }
3658: if ($last) { $names{'lastname'} = $last; }
3659: if (defined($gene)) { $names{'generation'} = $gene; }
3660: if ($email) {
3661: $email=~s/[^\w\@\.\-\,]//gs;
3662: if ($email=~/\@/) { $names{'notification'} = $email;
3663: $names{'critnotification'} = $email;
3664: $names{'permanentemail'} = $email; }
3665: }
3666: my $reply = &put('environment', \%names, $udom,$uname);
3667: if ($reply ne 'ok') { return 'error: '.$reply; }
3668: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
3669: $umode.', '.$first.', '.$middle.', '.
3670: $last.', '.$gene.' by '.
3671: $env{'user.name'}.' at '.$env{'user.domain'});
3672: return 'ok';
3673: }
3674:
3675: # -------------------------------------------------------------- Modify student
3676:
3677: sub modifystudent {
3678: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
3679: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid)=@_;
3680: if (!$cid) {
3681: unless ($cid=$env{'request.course.id'}) {
3682: return 'not_in_class';
3683: }
3684: }
3685: # --------------------------------------------------------------- Make the user
3686: my $reply=&modifyuser
3687: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
3688: $desiredhome,$email);
3689: unless ($reply eq 'ok') { return $reply; }
3690: # This will cause &modify_student_enrollment to get the uid from the
3691: # students environment
3692: $uid = undef if (!$forceid);
3693: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
3694: $gene,$usec,$end,$start,$type,$locktype,$cid);
3695: return $reply;
3696: }
3697:
3698: sub modify_student_enrollment {
3699: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid) = @_;
3700: my ($cdom,$cnum,$chome);
3701: if (!$cid) {
3702: unless ($cid=$env{'request.course.id'}) {
3703: return 'not_in_class';
3704: }
3705: $cdom=$env{'course.'.$cid.'.domain'};
3706: $cnum=$env{'course.'.$cid.'.num'};
3707: } else {
3708: ($cdom,$cnum)=split(/_/,$cid);
3709: }
3710: $chome=$env{'course.'.$cid.'.home'};
3711: if (!$chome) {
3712: $chome=&homeserver($cnum,$cdom);
3713: }
3714: if (!$chome) { return 'unknown_course'; }
3715: # Make sure the user exists
3716: my $uhome=&homeserver($uname,$udom);
3717: if (($uhome eq '') || ($uhome eq 'no_host')) {
3718: return 'error: no such user';
3719: }
3720: # Get student data if we were not given enough information
3721: if (!defined($first) || $first eq '' ||
3722: !defined($last) || $last eq '' ||
3723: !defined($uid) || $uid eq '' ||
3724: !defined($middle) || $middle eq '' ||
3725: !defined($gene) || $gene eq '') {
3726: # They did not supply us with enough data to enroll the student, so
3727: # we need to pick up more information.
3728: my %tmp = &get('environment',
3729: ['firstname','middlename','lastname', 'generation','id']
3730: ,$udom,$uname);
3731:
3732: #foreach (keys(%tmp)) {
3733: # &logthis("key $_ = ".$tmp{$_});
3734: #}
3735: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
3736: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
3737: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
3738: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
3739: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
3740: }
3741: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
3742: my $reply=cput('classlist',
3743: {"$uname:$udom" =>
3744: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
3745: $cdom,$cnum);
3746: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
3747: return 'error: '.$reply;
3748: }
3749: # Add student role to user
3750: my $uurl='/'.$cid;
3751: $uurl=~s/\_/\//g;
3752: if ($usec) {
3753: $uurl.='/'.$usec;
3754: }
3755: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
3756: }
3757:
3758: sub format_name {
3759: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
3760: my $name;
3761: if ($first ne 'lastname') {
3762: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
3763: } else {
3764: if ($lastname=~/\S/) {
3765: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
3766: $name=~s/\s+,/,/;
3767: } else {
3768: $name.= $firstname.' '.$middlename.' '.$generation;
3769: }
3770: }
3771: $name=~s/^\s+//;
3772: $name=~s/\s+$//;
3773: $name=~s/\s+/ /g;
3774: return $name;
3775: }
3776:
3777: # ------------------------------------------------- Write to course preferences
3778:
3779: sub writecoursepref {
3780: my ($courseid,%prefs)=@_;
3781: $courseid=~s/^\///;
3782: $courseid=~s/\_/\//g;
3783: my ($cdomain,$cnum)=split(/\//,$courseid);
3784: my $chome=homeserver($cnum,$cdomain);
3785: if (($chome eq '') || ($chome eq 'no_host')) {
3786: return 'error: no such course';
3787: }
3788: my $cstring='';
3789: foreach (keys %prefs) {
3790: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
3791: }
3792: $cstring=~s/\&$//;
3793: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
3794: }
3795:
3796: # ---------------------------------------------------------- Make/modify course
3797:
3798: sub createcourse {
3799: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner)=@_;
3800: $url=&declutter($url);
3801: my $cid='';
3802: unless (&allowed('ccc',$udom)) {
3803: return 'refused';
3804: }
3805: # ------------------------------------------------------------------- Create ID
3806: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
3807: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
3808: # ----------------------------------------------- Make sure that does not exist
3809: my $uhome=&homeserver($uname,$udom,'true');
3810: unless (($uhome eq '') || ($uhome eq 'no_host')) {
3811: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
3812: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
3813: $uhome=&homeserver($uname,$udom,'true');
3814: unless (($uhome eq '') || ($uhome eq 'no_host')) {
3815: return 'error: unable to generate unique course-ID';
3816: }
3817: }
3818: # ------------------------------------------------ Check supplied server name
3819: $course_server = $env{'user.homeserver'} if (! defined($course_server));
3820: if (! exists($libserv{$course_server})) {
3821: return 'error:bad server name '.$course_server;
3822: }
3823: # ------------------------------------------------------------- Make the course
3824: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
3825: $course_server);
3826: unless ($reply eq 'ok') { return 'error: '.$reply; }
3827: $uhome=&homeserver($uname,$udom,'true');
3828: if (($uhome eq '') || ($uhome eq 'no_host')) {
3829: return 'error: no such course';
3830: }
3831: # ----------------------------------------------------------------- Course made
3832: # log existence
3833: &courseidput($udom,&escape($udom.'_'.$uname).'='.&escape($description).
3834: ':'.&escape($inst_code).':'.&escape($course_owner),$uhome);
3835: &flushcourselogs();
3836: # set toplevel url
3837: my $topurl=$url;
3838: unless ($nonstandard) {
3839: # ------------------------------------------ For standard courses, make top url
3840: my $mapurl=&clutter($url);
3841: if ($mapurl eq '/res/') { $mapurl=''; }
3842: $env{'form.initmap'}=(<<ENDINITMAP);
3843: <map>
3844: <resource id="1" type="start"></resource>
3845: <resource id="2" src="$mapurl"></resource>
3846: <resource id="3" type="finish"></resource>
3847: <link index="1" from="1" to="2"></link>
3848: <link index="2" from="2" to="3"></link>
3849: </map>
3850: ENDINITMAP
3851: $topurl=&declutter(
3852: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
3853: );
3854: }
3855: # ----------------------------------------------------------- Write preferences
3856: &writecoursepref($udom.'_'.$uname,
3857: ('description' => $description,
3858: 'url' => $topurl));
3859: return '/'.$udom.'/'.$uname;
3860: }
3861:
3862: # ---------------------------------------------------------- Assign Custom Role
3863:
3864: sub assigncustomrole {
3865: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag)=@_;
3866: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
3867: $end,$start,$deleteflag);
3868: }
3869:
3870: # ----------------------------------------------------------------- Revoke Role
3871:
3872: sub revokerole {
3873: my ($udom,$uname,$url,$role,$deleteflag)=@_;
3874: my $now=time;
3875: return &assignrole($udom,$uname,$url,$role,$now,$deleteflag);
3876: }
3877:
3878: # ---------------------------------------------------------- Revoke Custom Role
3879:
3880: sub revokecustomrole {
3881: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag)=@_;
3882: my $now=time;
3883: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
3884: $deleteflag);
3885: }
3886:
3887: # ------------------------------------------------------------ Disk usage
3888: sub diskusage {
3889: my ($udom,$uname,$directoryRoot)=@_;
3890: $directoryRoot =~ s/\/$//;
3891: my $listing=&reply('du:'.$directoryRoot,homeserver($uname,$udom));
3892: return $listing;
3893: }
3894:
3895: sub is_locked {
3896: my ($file_name, $domain, $user) = @_;
3897: my @check;
3898: my $is_locked;
3899: push @check, $file_name;
3900: my %locked = &get('file_permissions',\@check,
3901: $env{'user.domain'},$env{'user.name'});
3902: my ($tmp)=keys(%locked);
3903: if ($tmp=~/^error:/) { undef(%locked); }
3904:
3905: if (ref($locked{$file_name}) eq 'ARRAY') {
3906: $is_locked = 'true';
3907: } else {
3908: $is_locked = 'false';
3909: }
3910: }
3911:
3912: # ------------------------------------------------------------- Mark as Read Only
3913:
3914: sub mark_as_readonly {
3915: my ($domain,$user,$files,$what) = @_;
3916: my %current_permissions = &dump('file_permissions',$domain,$user);
3917: my ($tmp)=keys(%current_permissions);
3918: if ($tmp=~/^error:/) { undef(%current_permissions); }
3919: foreach my $file (@{$files}) {
3920: push(@{$current_permissions{$file}},$what);
3921: }
3922: &put('file_permissions',\%current_permissions,$domain,$user);
3923: return;
3924: }
3925:
3926: # ------------------------------------------------------------Save Selected Files
3927:
3928: sub save_selected_files {
3929: my ($user, $path, @files) = @_;
3930: my $filename = $user."savedfiles";
3931: my @other_files = &files_not_in_path($user, $path);
3932: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
3933: foreach my $file (@files) {
3934: print (OUT $env{'form.currentpath'}.$file."\n");
3935: }
3936: foreach my $file (@other_files) {
3937: print (OUT $file."\n");
3938: }
3939: close (OUT);
3940: return 'ok';
3941: }
3942:
3943: sub clear_selected_files {
3944: my ($user) = @_;
3945: my $filename = $user."savedfiles";
3946: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
3947: print (OUT undef);
3948: close (OUT);
3949: return ("ok");
3950: }
3951:
3952: sub files_in_path {
3953: my ($user, $path) = @_;
3954: my $filename = $user."savedfiles";
3955: my %return_files;
3956: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
3957: while (my $line_in = <IN>) {
3958: chomp ($line_in);
3959: my @paths_and_file = split (m!/!, $line_in);
3960: my $file_part = pop (@paths_and_file);
3961: my $path_part = join ('/', @paths_and_file);
3962: $path_part.='/';
3963: my $path_and_file = $path_part.$file_part;
3964: if ($path_part eq $path) {
3965: $return_files{$file_part}= 'selected';
3966: }
3967: }
3968: close (IN);
3969: return (\%return_files);
3970: }
3971:
3972: # called in portfolio select mode, to show files selected NOT in current directory
3973: sub files_not_in_path {
3974: my ($user, $path) = @_;
3975: my $filename = $user."savedfiles";
3976: my @return_files;
3977: my $path_part;
3978: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
3979: while (<IN>) {
3980: #ok, I know it's clunky, but I want it to work
3981: my @paths_and_file = split m!/!, $_;
3982: my $file_part = pop (@paths_and_file);
3983: chomp ($file_part);
3984: my $path_part = join ('/', @paths_and_file);
3985: $path_part .= '/';
3986: my $path_and_file = $path_part.$file_part;
3987: if ($path_part ne $path) {
3988: push (@return_files, ($path_and_file));
3989: }
3990: }
3991: close (OUT);
3992: return (@return_files);
3993: }
3994:
3995: #--------------------------------------------------------------Get Marked as Read Only
3996:
3997:
3998: sub get_marked_as_readonly {
3999: my ($domain,$user,$what) = @_;
4000: my %current_permissions = &dump('file_permissions',$domain,$user);
4001: my ($tmp)=keys(%current_permissions);
4002: if ($tmp=~/^error:/) { undef(%current_permissions); }
4003: my @readonly_files;
4004: my $cmp1=$what;
4005: if (ref($what)) { $cmp1=join('',@{$what}) };
4006: while (my ($file_name,$value) = each(%current_permissions)) {
4007: if (ref($value) eq "ARRAY"){
4008: foreach my $stored_what (@{$value}) {
4009: my $cmp2=$stored_what;
4010: if (ref($stored_what)) { $cmp2=join('',@{$stored_what}) };
4011: if ($cmp1 eq $cmp2) {
4012: push(@readonly_files, $file_name);
4013: } elsif (!defined($what)) {
4014: push(@readonly_files, $file_name);
4015: }
4016: }
4017: }
4018: }
4019: return @readonly_files;
4020: }
4021: #-----------------------------------------------------------Get Marked as Read Only Hash
4022:
4023: sub get_marked_as_readonly_hash {
4024: my ($domain,$user,$what) = @_;
4025: my %current_permissions = &dump('file_permissions',$domain,$user);
4026: my ($tmp)=keys(%current_permissions);
4027: if ($tmp=~/^error:/) { undef(%current_permissions); }
4028:
4029: my %readonly_files;
4030: while (my ($file_name,$value) = each(%current_permissions)) {
4031: if (ref($value) eq "ARRAY"){
4032: foreach my $stored_what (@{$value}) {
4033: if ($stored_what eq $what) {
4034: $readonly_files{$file_name} = 'locked';
4035: } elsif (!defined($what)) {
4036: $readonly_files{$file_name} = 'locked';
4037: }
4038: }
4039: }
4040: }
4041: return %readonly_files;
4042: }
4043: # ------------------------------------------------------------ Unmark as Read Only
4044:
4045: sub unmark_as_readonly {
4046: # unmarks $file_name (if $file_name is defined), or all files locked by $what
4047: # for portfolio submissions, $what contains [$symb,$crsid]
4048: my ($domain,$user,$what,$file_name) = @_;
4049: my $symb_crs = $what;
4050: if (ref($what)) { $symb_crs=join('',@$what); }
4051: my %current_permissions = &dump('file_permissions',$domain,$user);
4052: my ($tmp)=keys(%current_permissions);
4053: if ($tmp=~/^error:/) { undef(%current_permissions); }
4054: my @readonly_files = &get_marked_as_readonly($domain,$user,$what);
4055: foreach my $file(@readonly_files){
4056: my $current_locks = $current_permissions{$file};
4057: my @new_locks;
4058: my @del_keys;
4059: if (ref($current_locks) eq "ARRAY"){
4060: foreach my $locker (@{$current_locks}) {
4061: my $compare=$locker;
4062: if (ref($locker)) { $compare=join('',@{$locker}) };
4063: if ($compare eq $symb_crs) {
4064: if (defined($file_name) && ($file_name ne $file)) {
4065: push(@new_locks, $what);
4066: }
4067: } else {
4068: push(@new_locks, $what);
4069: }
4070: }
4071: if (@new_locks > 0) {
4072: $current_permissions{$file} = \@new_locks;
4073: } else {
4074: push(@del_keys, $file);
4075: &del('file_permissions',\@del_keys, $domain, $user);
4076: delete $current_permissions{$file};
4077: }
4078: }
4079: }
4080: &put('file_permissions',\%current_permissions,$domain,$user);
4081: return;
4082: }
4083:
4084: # ------------------------------------------------------------ Directory lister
4085:
4086: sub dirlist {
4087: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
4088:
4089: $uri=~s/^\///;
4090: $uri=~s/\/$//;
4091: my ($udom, $uname);
4092: (undef,$udom,$uname)=split(/\//,$uri);
4093: if(defined($userdomain)) {
4094: $udom = $userdomain;
4095: }
4096: if(defined($username)) {
4097: $uname = $username;
4098: }
4099:
4100: my $dirRoot = $perlvar{'lonDocRoot'};
4101: if(defined($alternateDirectoryRoot)) {
4102: $dirRoot = $alternateDirectoryRoot;
4103: $dirRoot =~ s/\/$//;
4104: }
4105:
4106: if($udom) {
4107: if($uname) {
4108: my $listing=reply('ls2:'.$dirRoot.'/'.$uri,
4109: homeserver($uname,$udom));
4110: my @listing_results;
4111: if ($listing eq 'unknown_cmd') {
4112: $listing=reply('ls:'.$dirRoot.'/'.$uri,
4113: homeserver($uname,$udom));
4114: @listing_results = split(/:/,$listing);
4115: } else {
4116: @listing_results = map { &unescape($_); } split(/:/,$listing);
4117: }
4118: return @listing_results;
4119: } elsif(!defined($alternateDirectoryRoot)) {
4120: my $tryserver;
4121: my %allusers=();
4122: foreach $tryserver (keys %libserv) {
4123: if($hostdom{$tryserver} eq $udom) {
4124: my $listing=reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
4125: $udom, $tryserver);
4126: my @listing_results;
4127: if ($listing eq 'unknown_cmd') {
4128: $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
4129: $udom, $tryserver);
4130: @listing_results = split(/:/,$listing);
4131: } else {
4132: @listing_results =
4133: map { &unescape($_); } split(/:/,$listing);
4134: }
4135: if ($listing_results[0] ne 'no_such_dir' &&
4136: $listing_results[0] ne 'empty' &&
4137: $listing_results[0] ne 'con_lost') {
4138: foreach (@listing_results) {
4139: my ($entry,@stat)=split(/&/,$_);
4140: $allusers{$entry}=1;
4141: }
4142: }
4143: }
4144: }
4145: my $alluserstr='';
4146: foreach (sort keys %allusers) {
4147: $alluserstr.=$_.'&user:';
4148: }
4149: $alluserstr=~s/:$//;
4150: return split(/:/,$alluserstr);
4151: } else {
4152: my @emptyResults = ();
4153: push(@emptyResults, 'missing user name');
4154: return split(':',@emptyResults);
4155: }
4156: } elsif(!defined($alternateDirectoryRoot)) {
4157: my $tryserver;
4158: my %alldom=();
4159: foreach $tryserver (keys %libserv) {
4160: $alldom{$hostdom{$tryserver}}=1;
4161: }
4162: my $alldomstr='';
4163: foreach (sort keys %alldom) {
4164: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'/&domain:';
4165: }
4166: $alldomstr=~s/:$//;
4167: return split(/:/,$alldomstr);
4168: } else {
4169: my @emptyResults = ();
4170: push(@emptyResults, 'missing domain');
4171: return split(':',@emptyResults);
4172: }
4173: }
4174:
4175: # --------------------------------------------- GetFileTimestamp
4176: # This function utilizes dirlist and returns the date stamp for
4177: # when it was last modified. It will also return an error of -1
4178: # if an error occurs
4179:
4180: ##
4181: ## FIXME: This subroutine assumes its caller knows something about the
4182: ## directory structure of the home server for the student ($root).
4183: ## Not a good assumption to make. Since this is for looking up files
4184: ## in user directories, the full path should be constructed by lond, not
4185: ## whatever machine we request data from.
4186: ##
4187: sub GetFileTimestamp {
4188: my ($studentDomain,$studentName,$filename,$root)=@_;
4189: $studentDomain=~s/\W//g;
4190: $studentName=~s/\W//g;
4191: my $subdir=$studentName.'__';
4192: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
4193: my $proname="$studentDomain/$subdir/$studentName";
4194: $proname .= '/'.$filename;
4195: my ($fileStat) = &Apache::lonnet::dirlist($proname, $studentDomain,
4196: $studentName, $root);
4197: my @stats = split('&', $fileStat);
4198: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
4199: # @stats contains first the filename, then the stat output
4200: return $stats[10]; # so this is 10 instead of 9.
4201: } else {
4202: return -1;
4203: }
4204: }
4205:
4206: # -------------------------------------------------------- Value of a Condition
4207:
4208: sub directcondval {
4209: my $number=shift;
4210: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
4211: &Apache::lonuserstate::evalstate();
4212: }
4213: if ($env{'user.state.'.$env{'request.course.id'}}) {
4214: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
4215: } else {
4216: return 2;
4217: }
4218: }
4219:
4220: sub condval {
4221: my $condidx=shift;
4222: my $result=0;
4223: my $allpathcond='';
4224: foreach (split(/\|/,$condidx)) {
4225: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$_})) {
4226: $allpathcond.=
4227: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$_}.')|';
4228: }
4229: }
4230: $allpathcond=~s/\|$//;
4231: if ($env{'request.course.id'}) {
4232: if ($allpathcond) {
4233: my $operand='|';
4234: my @stack;
4235: foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
4236: if ($_ eq '(') {
4237: push @stack,($operand,$result)
4238: } elsif ($_ eq ')') {
4239: my $before=pop @stack;
4240: if (pop @stack eq '&') {
4241: $result=$result>$before?$before:$result;
4242: } else {
4243: $result=$result>$before?$result:$before;
4244: }
4245: } elsif (($_ eq '&') || ($_ eq '|')) {
4246: $operand=$_;
4247: } else {
4248: my $new=directcondval($_);
4249: if ($operand eq '&') {
4250: $result=$result>$new?$new:$result;
4251: } else {
4252: $result=$result>$new?$result:$new;
4253: }
4254: }
4255: }
4256: }
4257: }
4258: return $result;
4259: }
4260:
4261: # ---------------------------------------------------- Devalidate courseresdata
4262:
4263: sub devalidatecourseresdata {
4264: my ($coursenum,$coursedomain)=@_;
4265: my $hashid=$coursenum.':'.$coursedomain;
4266: &devalidate_cache_new('courseres',$hashid);
4267: }
4268:
4269: # --------------------------------------------------- Course Resourcedata Query
4270:
4271: sub get_courseresdata {
4272: my ($coursenum,$coursedomain)=@_;
4273: my $coursehom=&homeserver($coursenum,$coursedomain);
4274: my $hashid=$coursenum.':'.$coursedomain;
4275: my ($result,$cached)=&is_cached_new('courseres',$hashid);
4276: my %dumpreply;
4277: unless (defined($cached)) {
4278: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
4279: $result=\%dumpreply;
4280: my ($tmp) = keys(%dumpreply);
4281: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
4282: &do_cache_new('courseres',$hashid,$result,600);
4283: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
4284: return $tmp;
4285: } elsif ($tmp =~ /^(error)/) {
4286: $result=undef;
4287: &do_cache_new('courseres',$hashid,$result,600);
4288: }
4289: }
4290: return $result;
4291: }
4292:
4293: sub devalidateuserresdata {
4294: my ($uname,$udom)=@_;
4295: my $hashid="$udom:$uname";
4296: &devalidate_cache_new('userres',$hashid);
4297: }
4298:
4299: sub get_userresdata {
4300: my ($uname,$udom)=@_;
4301: #most student don\'t have any data set, check if there is some data
4302: if (&EXT_cache_status($udom,$uname)) { return undef; }
4303:
4304: my $hashid="$udom:$uname";
4305: my ($result,$cached)=&is_cached_new('userres',$hashid);
4306: if (!defined($cached)) {
4307: my %resourcedata=&dump('resourcedata',$udom,$uname);
4308: $result=\%resourcedata;
4309: &do_cache_new('userres',$hashid,$result,600);
4310: }
4311: my ($tmp)=keys(%$result);
4312: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
4313: return $result;
4314: }
4315: #error 2 occurs when the .db doesn't exist
4316: if ($tmp!~/error: 2 /) {
4317: &logthis("<font color=blue>WARNING:".
4318: " Trying to get resource data for ".
4319: $uname." at ".$udom.": ".
4320: $tmp."</font>");
4321: } elsif ($tmp=~/error: 2 /) {
4322: #&EXT_cache_set($udom,$uname);
4323: &do_cache_new('userres',$hashid,undef,600);
4324: undef($tmp); # not really an error so don't send it back
4325: }
4326: return $tmp;
4327: }
4328:
4329: sub resdata {
4330: my ($name,$domain,$type,@which)=@_;
4331: my $result;
4332: if ($type eq 'course') {
4333: $result=&get_courseresdata($name,$domain);
4334: } elsif ($type eq 'user') {
4335: $result=&get_userresdata($name,$domain);
4336: }
4337: if (!ref($result)) { return $result; }
4338: foreach my $item (@which) {
4339: if (defined($result->{$item})) {
4340: return $result->{$item};
4341: }
4342: }
4343: return undef;
4344: }
4345:
4346: #
4347: # EXT resource caching routines
4348: #
4349:
4350: sub clear_EXT_cache_status {
4351: &delenv('cache.EXT.');
4352: }
4353:
4354: sub EXT_cache_status {
4355: my ($target_domain,$target_user) = @_;
4356: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
4357: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
4358: # We know already the user has no data
4359: return 1;
4360: } else {
4361: return 0;
4362: }
4363: }
4364:
4365: sub EXT_cache_set {
4366: my ($target_domain,$target_user) = @_;
4367: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
4368: #&appenv($cachename => time);
4369: }
4370:
4371: # --------------------------------------------------------- Value of a Variable
4372: sub EXT {
4373: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
4374:
4375: unless ($varname) { return ''; }
4376: #get real user name/domain, courseid and symb
4377: my $courseid;
4378: my $publicuser;
4379: if ($symbparm) {
4380: $symbparm=&get_symb_from_alias($symbparm);
4381: }
4382: if (!($uname && $udom)) {
4383: (my $cursymb,$courseid,$udom,$uname,$publicuser)=
4384: &Apache::lonxml::whichuser($symbparm);
4385: if (!$symbparm) { $symbparm=$cursymb; }
4386: } else {
4387: $courseid=$env{'request.course.id'};
4388: }
4389: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
4390: my $rest;
4391: if (defined($therest[0])) {
4392: $rest=join('.',@therest);
4393: } else {
4394: $rest='';
4395: }
4396:
4397: my $qualifierrest=$qualifier;
4398: if ($rest) { $qualifierrest.='.'.$rest; }
4399: my $spacequalifierrest=$space;
4400: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
4401: if ($realm eq 'user') {
4402: # --------------------------------------------------------------- user.resource
4403: if ($space eq 'resource') {
4404: if (defined($Apache::lonhomework::parsing_a_problem) ||
4405: defined($Apache::lonhomework::parsing_a_task)) {
4406: return $Apache::lonhomework::history{$qualifierrest};
4407: } else {
4408: my %restored;
4409: if ($publicuser || $env{'request.state'} eq 'construct') {
4410: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
4411: } else {
4412: %restored=&restore($symbparm,$courseid,$udom,$uname);
4413: }
4414: return $restored{$qualifierrest};
4415: }
4416: # ----------------------------------------------------------------- user.access
4417: } elsif ($space eq 'access') {
4418: # FIXME - not supporting calls for a specific user
4419: return &allowed($qualifier,$rest);
4420: # ------------------------------------------ user.preferences, user.environment
4421: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
4422: if (($uname eq $env{'user.name'}) &&
4423: ($udom eq $env{'user.domain'})) {
4424: return $env{join('.',('environment',$qualifierrest))};
4425: } else {
4426: my %returnhash;
4427: if (!$publicuser) {
4428: %returnhash=&userenvironment($udom,$uname,
4429: $qualifierrest);
4430: }
4431: return $returnhash{$qualifierrest};
4432: }
4433: # ----------------------------------------------------------------- user.course
4434: } elsif ($space eq 'course') {
4435: # FIXME - not supporting calls for a specific user
4436: return $env{join('.',('request.course',$qualifier))};
4437: # ------------------------------------------------------------------- user.role
4438: } elsif ($space eq 'role') {
4439: # FIXME - not supporting calls for a specific user
4440: my ($role,$where)=split(/\./,$env{'request.role'});
4441: if ($qualifier eq 'value') {
4442: return $role;
4443: } elsif ($qualifier eq 'extent') {
4444: return $where;
4445: }
4446: # ----------------------------------------------------------------- user.domain
4447: } elsif ($space eq 'domain') {
4448: return $udom;
4449: # ------------------------------------------------------------------- user.name
4450: } elsif ($space eq 'name') {
4451: return $uname;
4452: # ---------------------------------------------------- Any other user namespace
4453: } else {
4454: my %reply;
4455: if (!$publicuser) {
4456: %reply=&get($space,[$qualifierrest],$udom,$uname);
4457: }
4458: return $reply{$qualifierrest};
4459: }
4460: } elsif ($realm eq 'query') {
4461: # ---------------------------------------------- pull stuff out of query string
4462: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
4463: [$spacequalifierrest]);
4464: return $env{'form.'.$spacequalifierrest};
4465: } elsif ($realm eq 'request') {
4466: # ------------------------------------------------------------- request.browser
4467: if ($space eq 'browser') {
4468: if ($qualifier eq 'textremote') {
4469: if (&mt('textual_remote_display') eq 'on') {
4470: return 1;
4471: } else {
4472: return 0;
4473: }
4474: } else {
4475: return $env{'browser.'.$qualifier};
4476: }
4477: # ------------------------------------------------------------ request.filename
4478: } else {
4479: return $env{'request.'.$spacequalifierrest};
4480: }
4481: } elsif ($realm eq 'course') {
4482: # ---------------------------------------------------------- course.description
4483: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
4484: } elsif ($realm eq 'resource') {
4485:
4486: my $section;
4487: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
4488: if (!$symbparm) { $symbparm=&symbread(); }
4489: }
4490: my ($courselevelm,$courselevel);
4491: if ($symbparm && defined($courseid) &&
4492: $courseid eq $env{'request.course.id'}) {
4493:
4494: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
4495:
4496: # ----------------------------------------------------- Cascading lookup scheme
4497: my $symbp=$symbparm;
4498: my $mapp=(&decode_symb($symbp))[0];
4499:
4500: my $symbparm=$symbp.'.'.$spacequalifierrest;
4501: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
4502:
4503: if (($env{'user.name'} eq $uname) &&
4504: ($env{'user.domain'} eq $udom)) {
4505: $section=$env{'request.course.sec'};
4506: } else {
4507: if (! defined($usection)) {
4508: $section=&getsection($udom,$uname,$courseid);
4509: } else {
4510: $section = $usection;
4511: }
4512: }
4513:
4514: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
4515: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
4516: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
4517:
4518: $courselevel=$courseid.'.'.$spacequalifierrest;
4519: my $courselevelr=$courseid.'.'.$symbparm;
4520: $courselevelm=$courseid.'.'.$mapparm;
4521:
4522: # ----------------------------------------------------------- first, check user
4523:
4524: my $userreply=&resdata($uname,$udom,'user',
4525: ($courselevelr,$courselevelm,
4526: $courselevel));
4527:
4528: if (defined($userreply)) { return $userreply; }
4529:
4530: # ------------------------------------------------ second, check some of course
4531:
4532: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
4533: $env{'course.'.$courseid.'.domain'},
4534: 'course',
4535: ($seclevelr,$seclevelm,$seclevel,
4536: $courselevelr));
4537: if (defined($coursereply)) { return $coursereply; }
4538:
4539: # ------------------------------------------------------ third, check map parms
4540: my %parmhash=();
4541: my $thisparm='';
4542: if (tie(%parmhash,'GDBM_File',
4543: $env{'request.course.fn'}.'_parms.db',
4544: &GDBM_READER(),0640)) {
4545: $thisparm=$parmhash{$symbparm};
4546: untie(%parmhash);
4547: }
4548: if ($thisparm) { return $thisparm; }
4549: }
4550: # ------------------------------------------ fourth, look in resource metadata
4551:
4552: $spacequalifierrest=~s/\./\_/;
4553: my $filename;
4554: if (!$symbparm) { $symbparm=&symbread(); }
4555: if ($symbparm) {
4556: $filename=(&decode_symb($symbparm))[2];
4557: } else {
4558: $filename=$env{'request.filename'};
4559: }
4560: my $metadata=&metadata($filename,$spacequalifierrest);
4561: if (defined($metadata)) { return $metadata; }
4562: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
4563: if (defined($metadata)) { return $metadata; }
4564:
4565: # ---------------------------------------------- fourth, look in rest pf course
4566: if ($symbparm && defined($courseid) &&
4567: $courseid eq $env{'request.course.id'}) {
4568: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
4569: $env{'course.'.$courseid.'.domain'},
4570: 'course',
4571: ($courselevelm,$courselevel));
4572: if (defined($coursereply)) { return $coursereply; }
4573: }
4574: # ------------------------------------------------------------------ Cascade up
4575: unless ($space eq '0') {
4576: my @parts=split(/_/,$space);
4577: my $id=pop(@parts);
4578: my $part=join('_',@parts);
4579: if ($part eq '') { $part='0'; }
4580: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
4581: $symbparm,$udom,$uname,$section,1);
4582: if (defined($partgeneral)) { return $partgeneral; }
4583: }
4584: if ($recurse) { return undef; }
4585: my $pack_def=&packages_tab_default($filename,$varname);
4586: if (defined($pack_def)) { return $pack_def; }
4587:
4588: # ---------------------------------------------------- Any other user namespace
4589: } elsif ($realm eq 'environment') {
4590: # ----------------------------------------------------------------- environment
4591: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
4592: return $env{'environment.'.$spacequalifierrest};
4593: } else {
4594: my %returnhash=&userenvironment($udom,$uname,
4595: $spacequalifierrest);
4596: return $returnhash{$spacequalifierrest};
4597: }
4598: } elsif ($realm eq 'system') {
4599: # ----------------------------------------------------------------- system.time
4600: if ($space eq 'time') {
4601: return time;
4602: }
4603: }
4604: return '';
4605: }
4606:
4607: sub packages_tab_default {
4608: my ($uri,$varname)=@_;
4609: my (undef,$part,$name)=split(/\./,$varname);
4610: my $packages=&metadata($uri,'packages');
4611: foreach my $package (split(/,/,$packages)) {
4612: my ($pack_type,$pack_part)=split(/_/,$package,2);
4613: if (defined($packagetab{"$pack_type&$name&default"})) {
4614: return $packagetab{"$pack_type&$name&default"};
4615: }
4616: if ($pack_type eq 'part') { $pack_part='0'; }
4617: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
4618: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
4619: }
4620: }
4621: return undef;
4622: }
4623:
4624: sub add_prefix_and_part {
4625: my ($prefix,$part)=@_;
4626: my $keyroot;
4627: if (defined($prefix) && $prefix !~ /^__/) {
4628: # prefix that has a part already
4629: $keyroot=$prefix;
4630: } elsif (defined($prefix)) {
4631: # prefix that is missing a part
4632: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
4633: } else {
4634: # no prefix at all
4635: if (defined($part)) { $keyroot='_'.$part; }
4636: }
4637: return $keyroot;
4638: }
4639:
4640: # ---------------------------------------------------------------- Get metadata
4641:
4642: my %metaentry;
4643: sub metadata {
4644: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
4645: $uri=&declutter($uri);
4646: # if it is a non metadata possible uri return quickly
4647: if (($uri eq '') ||
4648: (($uri =~ m|^/*adm/|) &&
4649: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
4650: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ /^~/) ||
4651: ($uri =~ m|home/[^/]+/public_html/|)) {
4652: return undef;
4653: }
4654: my $filename=$uri;
4655: $uri=~s/\.meta$//;
4656: #
4657: # Is the metadata already cached?
4658: # Look at timestamp of caching
4659: # Everything is cached by the main uri, libraries are never directly cached
4660: #
4661: if (!defined($liburi)) {
4662: my ($result,$cached)=&is_cached_new('meta',$uri);
4663: if (defined($cached)) { return $result->{':'.$what}; }
4664: }
4665: {
4666: #
4667: # Is this a recursive call for a library?
4668: #
4669: # if (! exists($metacache{$uri})) {
4670: # $metacache{$uri}={};
4671: # }
4672: if ($liburi) {
4673: $liburi=&declutter($liburi);
4674: $filename=$liburi;
4675: } else {
4676: &devalidate_cache_new('meta',$uri);
4677: undef(%metaentry);
4678: }
4679: my %metathesekeys=();
4680: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
4681: my $metastring;
4682: if ($uri !~ m -^(uploaded|editupload)/-) {
4683: my $file=&filelocation('',&clutter($filename));
4684: #push(@{$metaentry{$uri.'.file'}},$file);
4685: $metastring=&getfile($file);
4686: }
4687: my $parser=HTML::LCParser->new(\$metastring);
4688: my $token;
4689: undef %metathesekeys;
4690: while ($token=$parser->get_token) {
4691: if ($token->[0] eq 'S') {
4692: if (defined($token->[2]->{'package'})) {
4693: #
4694: # This is a package - get package info
4695: #
4696: my $package=$token->[2]->{'package'};
4697: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
4698: if (defined($token->[2]->{'id'})) {
4699: $keyroot.='_'.$token->[2]->{'id'};
4700: }
4701: if ($metaentry{':packages'}) {
4702: $metaentry{':packages'}.=','.$package.$keyroot;
4703: } else {
4704: $metaentry{':packages'}=$package.$keyroot;
4705: }
4706: foreach (sort keys %packagetab) {
4707: my $part=$keyroot;
4708: $part=~s/^\_//;
4709: if ($_=~/^\Q$package\E\&/ ||
4710: $_=~/^\Q$package\E_0\&/) {
4711: my ($pack,$name,$subp)=split(/\&/,$_);
4712: # ignore package.tab specified default values
4713: # here &package_tab_default() will fetch those
4714: if ($subp eq 'default') { next; }
4715: my $value=$packagetab{$_};
4716: my $unikey;
4717: if ($pack =~ /_0$/) {
4718: $unikey='parameter_0_'.$name;
4719: $part=0;
4720: } else {
4721: $unikey='parameter'.$keyroot.'_'.$name;
4722: }
4723: if ($subp eq 'display') {
4724: $value.=' [Part: '.$part.']';
4725: }
4726: $metaentry{':'.$unikey.'.part'}=$part;
4727: $metathesekeys{$unikey}=1;
4728: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
4729: $metaentry{':'.$unikey.'.'.$subp}=$value;
4730: }
4731: if (defined($metaentry{':'.$unikey.'.default'})) {
4732: $metaentry{':'.$unikey}=
4733: $metaentry{':'.$unikey.'.default'};
4734: }
4735: }
4736: }
4737: } else {
4738: #
4739: # This is not a package - some other kind of start tag
4740: #
4741: my $entry=$token->[1];
4742: my $unikey;
4743: if ($entry eq 'import') {
4744: $unikey='';
4745: } else {
4746: $unikey=$entry;
4747: }
4748: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
4749:
4750: if (defined($token->[2]->{'id'})) {
4751: $unikey.='_'.$token->[2]->{'id'};
4752: }
4753:
4754: if ($entry eq 'import') {
4755: #
4756: # Importing a library here
4757: #
4758: if ($depthcount<20) {
4759: my $location=$parser->get_text('/import');
4760: my $dir=$filename;
4761: $dir=~s|[^/]*$||;
4762: $location=&filelocation($dir,$location);
4763: foreach (sort(split(/\,/,&metadata($uri,'keys',
4764: $location,$unikey,
4765: $depthcount+1)))) {
4766: $metaentry{':'.$_}=$metaentry{':'.$_};
4767: $metathesekeys{$_}=1;
4768: }
4769: }
4770: } else {
4771:
4772: if (defined($token->[2]->{'name'})) {
4773: $unikey.='_'.$token->[2]->{'name'};
4774: }
4775: $metathesekeys{$unikey}=1;
4776: foreach (@{$token->[3]}) {
4777: $metaentry{':'.$unikey.'.'.$_}=$token->[2]->{$_};
4778: }
4779: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
4780: my $default=$metaentry{':'.$unikey.'.default'};
4781: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
4782: # only ws inside the tag, and not in default, so use default
4783: # as value
4784: $metaentry{':'.$unikey}=$default;
4785: } else {
4786: # either something interesting inside the tag or default
4787: # uninteresting
4788: $metaentry{':'.$unikey}=$internaltext;
4789: }
4790: # end of not-a-package not-a-library import
4791: }
4792: # end of not-a-package start tag
4793: }
4794: # the next is the end of "start tag"
4795: }
4796: }
4797: my ($extension) = ($uri =~ /\.(\w+)$/);
4798: foreach my $key (sort(keys(%packagetab))) {
4799: #no specific packages #how's our extension
4800: if ($key!~/^extension_\Q$extension\E&/) { next; }
4801: &metadata_create_package_def($uri,$key,'extension_'.$extension,
4802: \%metathesekeys);
4803: }
4804: if (!exists($metaentry{':packages'})) {
4805: foreach my $key (sort(keys(%packagetab))) {
4806: #no specific packages well let's get default then
4807: if ($key!~/^default&/) { next; }
4808: &metadata_create_package_def($uri,$key,'default',
4809: \%metathesekeys);
4810: }
4811: }
4812: # are there custom rights to evaluate
4813: if ($metaentry{':copyright'} eq 'custom') {
4814:
4815: #
4816: # Importing a rights file here
4817: #
4818: unless ($depthcount) {
4819: my $location=$metaentry{':customdistributionfile'};
4820: my $dir=$filename;
4821: $dir=~s|[^/]*$||;
4822: $location=&filelocation($dir,$location);
4823: foreach (sort(split(/\,/,&metadata($uri,'keys',
4824: $location,'_rights',
4825: $depthcount+1)))) {
4826: #$metaentry{':'.$_}=$metacache{$uri}->{':'.$_};
4827: $metathesekeys{$_}=1;
4828: }
4829: }
4830: }
4831: $metaentry{':keys'}=join(',',keys %metathesekeys);
4832: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
4833: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
4834: &do_cache_new('meta',$uri,\%metaentry,60*60*24);
4835: # this is the end of "was not already recently cached
4836: }
4837: return $metaentry{':'.$what};
4838: }
4839:
4840: sub metadata_create_package_def {
4841: my ($uri,$key,$package,$metathesekeys)=@_;
4842: my ($pack,$name,$subp)=split(/\&/,$key);
4843: if ($subp eq 'default') { next; }
4844:
4845: if (defined($metaentry{':packages'})) {
4846: $metaentry{':packages'}.=','.$package;
4847: } else {
4848: $metaentry{':packages'}=$package;
4849: }
4850: my $value=$packagetab{$key};
4851: my $unikey;
4852: $unikey='parameter_0_'.$name;
4853: $metaentry{':'.$unikey.'.part'}=0;
4854: $$metathesekeys{$unikey}=1;
4855: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
4856: $metaentry{':'.$unikey.'.'.$subp}=$value;
4857: }
4858: if (defined($metaentry{':'.$unikey.'.default'})) {
4859: $metaentry{':'.$unikey}=
4860: $metaentry{':'.$unikey.'.default'};
4861: }
4862: }
4863:
4864: sub metadata_generate_part0 {
4865: my ($metadata,$metacache,$uri) = @_;
4866: my %allnames;
4867: foreach my $metakey (sort keys %$metadata) {
4868: if ($metakey=~/^parameter\_(.*)/) {
4869: my $part=$$metacache{':'.$metakey.'.part'};
4870: my $name=$$metacache{':'.$metakey.'.name'};
4871: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
4872: $allnames{$name}=$part;
4873: }
4874: }
4875: }
4876: foreach my $name (keys(%allnames)) {
4877: $$metadata{"parameter_0_$name"}=1;
4878: my $key=":parameter_0_$name";
4879: $$metacache{"$key.part"}='0';
4880: $$metacache{"$key.name"}=$name;
4881: $$metacache{"$key.type"}=$$metacache{':parameter_'.
4882: $allnames{$name}.'_'.$name.
4883: '.type'};
4884: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
4885: '.display'};
4886: my $expr='\\[Part: '.$allnames{$name}.'\\]';
4887: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
4888: $$metacache{"$key.display"}=$olddis;
4889: }
4890: }
4891:
4892: # ------------------------------------------------- Get the title of a resource
4893:
4894: sub gettitle {
4895: my $urlsymb=shift;
4896: my $symb=&symbread($urlsymb);
4897: if ($symb) {
4898: my $key=$env{'request.course.id'}."\0".$symb;
4899: my ($result,$cached)=&is_cached_new('title',$key);
4900: if (defined($cached)) {
4901: return $result;
4902: }
4903: my ($map,$resid,$url)=&decode_symb($symb);
4904: my $title='';
4905: my %bighash;
4906: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4907: &GDBM_READER(),0640)) {
4908: my $mapid=$bighash{'map_pc_'.&clutter($map)};
4909: $title=$bighash{'title_'.$mapid.'.'.$resid};
4910: untie %bighash;
4911: }
4912: $title=~s/\&colon\;/\:/gs;
4913: if ($title) {
4914: return &do_cache_new('title',$key,$title,600);
4915: }
4916: $urlsymb=$url;
4917: }
4918: my $title=&metadata($urlsymb,'title');
4919: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
4920: return $title;
4921: }
4922:
4923: sub get_slot {
4924: my ($which,$cnum,$cdom)=@_;
4925: if (!$cnum || !$cdom) {
4926: (undef,my $courseid)=&Apache::lonxml::whichuser();
4927: $cdom=$env{'course.'.$courseid.'.domain'};
4928: $cnum=$env{'course.'.$courseid.'.num'};
4929: }
4930: my %slotinfo=&get('slots',[$which],$cdom,$cnum);
4931: &Apache::lonhomework::showhash(%slotinfo);
4932: my ($tmp)=keys(%slotinfo);
4933: if ($tmp=~/^error:/) { return (); }
4934: if (ref($slotinfo{$which}) eq 'HASH') {
4935: return %{$slotinfo{$which}};
4936: }
4937: return $slotinfo{$which};
4938: }
4939: # ------------------------------------------------- Update symbolic store links
4940:
4941: sub symblist {
4942: my ($mapname,%newhash)=@_;
4943: $mapname=&deversion(&declutter($mapname));
4944: my %hash;
4945: if (($env{'request.course.fn'}) && (%newhash)) {
4946: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
4947: &GDBM_WRCREAT(),0640)) {
4948: foreach (keys %newhash) {
4949: $hash{declutter($_)}=&encode_symb($mapname,$newhash{$_}->[1],
4950: $newhash{$_}->[0]);
4951: }
4952: if (untie(%hash)) {
4953: return 'ok';
4954: }
4955: }
4956: }
4957: return 'error';
4958: }
4959:
4960: # --------------------------------------------------------------- Verify a symb
4961:
4962: sub symbverify {
4963: my ($symb,$thisurl)=@_;
4964: my $thisfn=$thisurl;
4965: # wrapper not part of symbs
4966: $thisfn=~s/^\/adm\/wrapper//;
4967: $thisfn=&declutter($thisfn);
4968: # direct jump to resource in page or to a sequence - will construct own symbs
4969: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
4970: # check URL part
4971: my ($map,$resid,$url)=&decode_symb($symb);
4972:
4973: unless ($url eq $thisfn) { return 0; }
4974:
4975: $symb=&symbclean($symb);
4976: $thisurl=&deversion($thisurl);
4977: $thisfn=&deversion($thisfn);
4978:
4979: my %bighash;
4980: my $okay=0;
4981:
4982: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
4983: &GDBM_READER(),0640)) {
4984: my $ids=$bighash{'ids_'.&clutter($thisurl)};
4985: unless ($ids) {
4986: $ids=$bighash{'ids_/'.$thisurl};
4987: }
4988: if ($ids) {
4989: # ------------------------------------------------------------------- Has ID(s)
4990: foreach (split(/\,/,$ids)) {
4991: my ($mapid,$resid)=split(/\./,$_);
4992: if (
4993: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
4994: eq $symb) {
4995: if (($env{'request.role.adv'}) ||
4996: $bighash{'encrypted_'.$_} eq $env{'request.enc'}) {
4997: $okay=1;
4998: }
4999: }
5000: }
5001: }
5002: untie(%bighash);
5003: }
5004: return $okay;
5005: }
5006:
5007: # --------------------------------------------------------------- Clean-up symb
5008:
5009: sub symbclean {
5010: my $symb=shift;
5011: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
5012: # remove version from map
5013: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
5014:
5015: # remove version from URL
5016: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
5017:
5018: # remove wrapper
5019:
5020: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
5021: return $symb;
5022: }
5023:
5024: # ---------------------------------------------- Split symb to find map and url
5025:
5026: sub encode_symb {
5027: my ($map,$resid,$url)=@_;
5028: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
5029: }
5030:
5031: sub decode_symb {
5032: my $symb=shift;
5033: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
5034: my ($map,$resid,$url)=split(/___/,$symb);
5035: return (&fixversion($map),$resid,&fixversion($url));
5036: }
5037:
5038: sub fixversion {
5039: my $fn=shift;
5040: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
5041: my %bighash;
5042: my $uri=&clutter($fn);
5043: my $key=$env{'request.course.id'}.'_'.$uri;
5044: # is this cached?
5045: my ($result,$cached)=&is_cached_new('courseresversion',$key);
5046: if (defined($cached)) { return $result; }
5047: # unfortunately not cached, or expired
5048: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5049: &GDBM_READER(),0640)) {
5050: if ($bighash{'version_'.$uri}) {
5051: my $version=$bighash{'version_'.$uri};
5052: unless (($version eq 'mostrecent') ||
5053: ($version==&getversion($uri))) {
5054: $uri=~s/\.(\w+)$/\.$version\.$1/;
5055: }
5056: }
5057: untie %bighash;
5058: }
5059: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
5060: }
5061:
5062: sub deversion {
5063: my $url=shift;
5064: $url=~s/\.\d+\.(\w+)$/\.$1/;
5065: return $url;
5066: }
5067:
5068: # ------------------------------------------------------ Return symb list entry
5069:
5070: sub symbread {
5071: my ($thisfn,$donotrecurse)=@_;
5072: my $cache_str='request.symbread.cached.'.$thisfn;
5073: if (defined($env{$cache_str})) { return $env{$cache_str}; }
5074: # no filename provided? try from environment
5075: unless ($thisfn) {
5076: if ($env{'request.symb'}) {
5077: return $env{$cache_str}=&symbclean($env{'request.symb'});
5078: }
5079: $thisfn=$env{'request.filename'};
5080: }
5081: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
5082: # is that filename actually a symb? Verify, clean, and return
5083: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
5084: if (&symbverify($thisfn,$1)) {
5085: return $env{$cache_str}=&symbclean($thisfn);
5086: }
5087: }
5088: $thisfn=declutter($thisfn);
5089: my %hash;
5090: my %bighash;
5091: my $syval='';
5092: if (($env{'request.course.fn'}) && ($thisfn)) {
5093: my $targetfn = $thisfn;
5094: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
5095: $targetfn = 'adm/wrapper/'.$thisfn;
5096: }
5097: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
5098: &GDBM_READER(),0640)) {
5099: $syval=$hash{$targetfn};
5100: untie(%hash);
5101: }
5102: # ---------------------------------------------------------- There was an entry
5103: if ($syval) {
5104: #unless ($syval=~/\_\d+$/) {
5105: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
5106: #&appenv('request.ambiguous' => $thisfn);
5107: #return $env{$cache_str}='';
5108: #}
5109: #$syval.=$1;
5110: #}
5111: } else {
5112: # ------------------------------------------------------- Was not in symb table
5113: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
5114: &GDBM_READER(),0640)) {
5115: # ---------------------------------------------- Get ID(s) for current resource
5116: my $ids=$bighash{'ids_'.&clutter($thisfn)};
5117: unless ($ids) {
5118: $ids=$bighash{'ids_/'.$thisfn};
5119: }
5120: unless ($ids) {
5121: # alias?
5122: $ids=$bighash{'mapalias_'.$thisfn};
5123: }
5124: if ($ids) {
5125: # ------------------------------------------------------------------- Has ID(s)
5126: my @possibilities=split(/\,/,$ids);
5127: if ($#possibilities==0) {
5128: # ----------------------------------------------- There is only one possibility
5129: my ($mapid,$resid)=split(/\./,$ids);
5130: $syval=&encode_symb($bighash{'map_id_'.$mapid},
5131: $resid,$thisfn);
5132: } elsif (!$donotrecurse) {
5133: # ------------------------------------------ There is more than one possibility
5134: my $realpossible=0;
5135: foreach (@possibilities) {
5136: my $file=$bighash{'src_'.$_};
5137: if (&allowed('bre',$file)) {
5138: my ($mapid,$resid)=split(/\./,$_);
5139: if ($bighash{'map_type_'.$mapid} ne 'page') {
5140: $realpossible++;
5141: $syval=&encode_symb($bighash{'map_id_'.$mapid},
5142: $resid,$thisfn);
5143: }
5144: }
5145: }
5146: if ($realpossible!=1) { $syval=''; }
5147: } else {
5148: $syval='';
5149: }
5150: }
5151: untie(%bighash)
5152: }
5153: }
5154: if ($syval) {
5155: return $env{$cache_str}=$syval;
5156: }
5157: }
5158: &appenv('request.ambiguous' => $thisfn);
5159: return $env{$cache_str}='';
5160: }
5161:
5162: # ---------------------------------------------------------- Return random seed
5163:
5164: sub numval {
5165: my $txt=shift;
5166: $txt=~tr/A-J/0-9/;
5167: $txt=~tr/a-j/0-9/;
5168: $txt=~tr/K-T/0-9/;
5169: $txt=~tr/k-t/0-9/;
5170: $txt=~tr/U-Z/0-5/;
5171: $txt=~tr/u-z/0-5/;
5172: $txt=~s/\D//g;
5173: if ($_64bit) { if ($txt > 2**32) { return -1; } }
5174: return int($txt);
5175: }
5176:
5177: sub numval2 {
5178: my $txt=shift;
5179: $txt=~tr/A-J/0-9/;
5180: $txt=~tr/a-j/0-9/;
5181: $txt=~tr/K-T/0-9/;
5182: $txt=~tr/k-t/0-9/;
5183: $txt=~tr/U-Z/0-5/;
5184: $txt=~tr/u-z/0-5/;
5185: $txt=~s/\D//g;
5186: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
5187: my $total;
5188: foreach my $val (@txts) { $total+=$val; }
5189: if ($_64bit) { if ($total > 2**32) { return -1; } }
5190: return int($total);
5191: }
5192:
5193: sub numval3 {
5194: use integer;
5195: my $txt=shift;
5196: $txt=~tr/A-J/0-9/;
5197: $txt=~tr/a-j/0-9/;
5198: $txt=~tr/K-T/0-9/;
5199: $txt=~tr/k-t/0-9/;
5200: $txt=~tr/U-Z/0-5/;
5201: $txt=~tr/u-z/0-5/;
5202: $txt=~s/\D//g;
5203: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
5204: my $total;
5205: foreach my $val (@txts) { $total+=$val; }
5206: if ($_64bit) { $total=(($total<<32)>>32); }
5207: return $total;
5208: }
5209:
5210: sub latest_rnd_algorithm_id {
5211: return '64bit4';
5212: }
5213:
5214: sub get_rand_alg {
5215: my ($courseid)=@_;
5216: if (!$courseid) { $courseid=(&Apache::lonxml::whichuser())[1]; }
5217: if ($courseid) {
5218: return $env{"course.$courseid.rndseed"};
5219: }
5220: return &latest_rnd_algorithm_id();
5221: }
5222:
5223: sub validCODE {
5224: my ($CODE)=@_;
5225: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
5226: return 0;
5227: }
5228:
5229: sub getCODE {
5230: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
5231: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
5232: defined($Apache::lonhomework::parsing_a_task) ) &&
5233: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
5234: return $Apache::lonhomework::history{'resource.CODE'};
5235: }
5236: return undef;
5237: }
5238:
5239: sub rndseed {
5240: my ($symb,$courseid,$domain,$username)=@_;
5241:
5242: my ($wsymb,$wcourseid,$wdomain,$wusername)=&Apache::lonxml::whichuser();
5243: if (!$symb) {
5244: unless ($symb=$wsymb) { return time; }
5245: }
5246: if (!$courseid) { $courseid=$wcourseid; }
5247: if (!$domain) { $domain=$wdomain; }
5248: if (!$username) { $username=$wusername }
5249: my $which=&get_rand_alg();
5250: if (defined(&getCODE())) {
5251: if ($which eq '64bit4') {
5252: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
5253: } else {
5254: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
5255: }
5256: } elsif ($which eq '64bit4') {
5257: return &rndseed_64bit4($symb,$courseid,$domain,$username);
5258: } elsif ($which eq '64bit3') {
5259: return &rndseed_64bit3($symb,$courseid,$domain,$username);
5260: } elsif ($which eq '64bit2') {
5261: return &rndseed_64bit2($symb,$courseid,$domain,$username);
5262: } elsif ($which eq '64bit') {
5263: return &rndseed_64bit($symb,$courseid,$domain,$username);
5264: }
5265: return &rndseed_32bit($symb,$courseid,$domain,$username);
5266: }
5267:
5268: sub rndseed_32bit {
5269: my ($symb,$courseid,$domain,$username)=@_;
5270: {
5271: use integer;
5272: my $symbchck=unpack("%32C*",$symb) << 27;
5273: my $symbseed=numval($symb) << 22;
5274: my $namechck=unpack("%32C*",$username) << 17;
5275: my $nameseed=numval($username) << 12;
5276: my $domainseed=unpack("%32C*",$domain) << 7;
5277: my $courseseed=unpack("%32C*",$courseid);
5278: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
5279: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5280: #&Apache::lonxml::debug("rndseed :$num:$symb");
5281: if ($_64bit) { $num=(($num<<32)>>32); }
5282: return $num;
5283: }
5284: }
5285:
5286: sub rndseed_64bit {
5287: my ($symb,$courseid,$domain,$username)=@_;
5288: {
5289: use integer;
5290: my $symbchck=unpack("%32S*",$symb) << 21;
5291: my $symbseed=numval($symb) << 10;
5292: my $namechck=unpack("%32S*",$username);
5293:
5294: my $nameseed=numval($username) << 21;
5295: my $domainseed=unpack("%32S*",$domain) << 10;
5296: my $courseseed=unpack("%32S*",$courseid);
5297:
5298: my $num1=$symbchck+$symbseed+$namechck;
5299: my $num2=$nameseed+$domainseed+$courseseed;
5300: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5301: #&Apache::lonxml::debug("rndseed :$num:$symb");
5302: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
5303: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
5304: return "$num1,$num2";
5305: }
5306: }
5307:
5308: sub rndseed_64bit2 {
5309: my ($symb,$courseid,$domain,$username)=@_;
5310: {
5311: use integer;
5312: # strings need to be an even # of cahracters long, it it is odd the
5313: # last characters gets thrown away
5314: my $symbchck=unpack("%32S*",$symb.' ') << 21;
5315: my $symbseed=numval($symb) << 10;
5316: my $namechck=unpack("%32S*",$username.' ');
5317:
5318: my $nameseed=numval($username) << 21;
5319: my $domainseed=unpack("%32S*",$domain.' ') << 10;
5320: my $courseseed=unpack("%32S*",$courseid.' ');
5321:
5322: my $num1=$symbchck+$symbseed+$namechck;
5323: my $num2=$nameseed+$domainseed+$courseseed;
5324: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5325: #&Apache::lonxml::debug("rndseed :$num:$symb");
5326: return "$num1,$num2";
5327: }
5328: }
5329:
5330: sub rndseed_64bit3 {
5331: my ($symb,$courseid,$domain,$username)=@_;
5332: {
5333: use integer;
5334: # strings need to be an even # of cahracters long, it it is odd the
5335: # last characters gets thrown away
5336: my $symbchck=unpack("%32S*",$symb.' ') << 21;
5337: my $symbseed=numval2($symb) << 10;
5338: my $namechck=unpack("%32S*",$username.' ');
5339:
5340: my $nameseed=numval2($username) << 21;
5341: my $domainseed=unpack("%32S*",$domain.' ') << 10;
5342: my $courseseed=unpack("%32S*",$courseid.' ');
5343:
5344: my $num1=$symbchck+$symbseed+$namechck;
5345: my $num2=$nameseed+$domainseed+$courseseed;
5346: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5347: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
5348: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
5349:
5350: return "$num1:$num2";
5351: }
5352: }
5353:
5354: sub rndseed_64bit4 {
5355: my ($symb,$courseid,$domain,$username)=@_;
5356: {
5357: use integer;
5358: # strings need to be an even # of cahracters long, it it is odd the
5359: # last characters gets thrown away
5360: my $symbchck=unpack("%32S*",$symb.' ') << 21;
5361: my $symbseed=numval3($symb) << 10;
5362: my $namechck=unpack("%32S*",$username.' ');
5363:
5364: my $nameseed=numval3($username) << 21;
5365: my $domainseed=unpack("%32S*",$domain.' ') << 10;
5366: my $courseseed=unpack("%32S*",$courseid.' ');
5367:
5368: my $num1=$symbchck+$symbseed+$namechck;
5369: my $num2=$nameseed+$domainseed+$courseseed;
5370: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
5371: #&Apache::lonxml::debug("rndseed :$num1:$num2:$_64bit");
5372: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
5373:
5374: return "$num1:$num2";
5375: }
5376: }
5377:
5378: sub rndseed_CODE_64bit {
5379: my ($symb,$courseid,$domain,$username)=@_;
5380: {
5381: use integer;
5382: my $symbchck=unpack("%32S*",$symb.' ') << 16;
5383: my $symbseed=numval2($symb);
5384: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
5385: my $CODEseed=numval(&getCODE());
5386: my $courseseed=unpack("%32S*",$courseid.' ');
5387: my $num1=$symbseed+$CODEchck;
5388: my $num2=$CODEseed+$courseseed+$symbchck;
5389: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
5390: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
5391: if ($_64bit) { $num1=(($num1<<32)>>32); }
5392: if ($_64bit) { $num2=(($num2<<32)>>32); }
5393: return "$num1:$num2";
5394: }
5395: }
5396:
5397: sub rndseed_CODE_64bit4 {
5398: my ($symb,$courseid,$domain,$username)=@_;
5399: {
5400: use integer;
5401: my $symbchck=unpack("%32S*",$symb.' ') << 16;
5402: my $symbseed=numval3($symb);
5403: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
5404: my $CODEseed=numval3(&getCODE());
5405: my $courseseed=unpack("%32S*",$courseid.' ');
5406: my $num1=$symbseed+$CODEchck;
5407: my $num2=$CODEseed+$courseseed+$symbchck;
5408: #&Apache::lonxml::debug("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
5409: #&Apache::lonxml::debug("rndseed :$num1:$num2:$symb");
5410: if ($_64bit) { $num1=(($num1<<32)>>32); }
5411: if ($_64bit) { $num2=(($num2<<32)>>32); }
5412: return "$num1:$num2";
5413: }
5414: }
5415:
5416: sub setup_random_from_rndseed {
5417: my ($rndseed)=@_;
5418: if ($rndseed =~/([,:])/) {
5419: my ($num1,$num2)=split(/[,:]/,$rndseed);
5420: &Math::Random::random_set_seed(abs($num1),abs($num2));
5421: } else {
5422: &Math::Random::random_set_seed_from_phrase($rndseed);
5423: }
5424: }
5425:
5426: sub latest_receipt_algorithm_id {
5427: return 'receipt2';
5428: }
5429:
5430: sub recunique {
5431: my $fucourseid=shift;
5432: my $unique;
5433: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
5434: $unique=$env{"course.$fucourseid.internal.encseed"};
5435: } else {
5436: $unique=$perlvar{'lonReceipt'};
5437: }
5438: return unpack("%32C*",$unique);
5439: }
5440:
5441: sub recprefix {
5442: my $fucourseid=shift;
5443: my $prefix;
5444: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
5445: $prefix=$env{"course.$fucourseid.internal.encpref"};
5446: } else {
5447: $prefix=$perlvar{'lonHostID'};
5448: }
5449: return unpack("%32C*",$prefix);
5450: }
5451:
5452: sub ireceipt {
5453: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
5454: my $cuname=unpack("%32C*",$funame);
5455: my $cudom=unpack("%32C*",$fudom);
5456: my $cucourseid=unpack("%32C*",$fucourseid);
5457: my $cusymb=unpack("%32C*",$fusymb);
5458: my $cunique=&recunique($fucourseid);
5459: my $cpart=unpack("%32S*",$part);
5460: my $return =&recprefix($fucourseid).'-';
5461: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
5462: $env{'request.state'} eq 'construct') {
5463: &Apache::lonxml::debug("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname).
5464: " and ".($cpart%$cudom));
5465:
5466: $return.= ($cunique%$cuname+
5467: $cunique%$cudom+
5468: $cusymb%$cuname+
5469: $cusymb%$cudom+
5470: $cucourseid%$cuname+
5471: $cucourseid%$cudom+
5472: $cpart%$cuname+
5473: $cpart%$cudom);
5474: } else {
5475: $return.= ($cunique%$cuname+
5476: $cunique%$cudom+
5477: $cusymb%$cuname+
5478: $cusymb%$cudom+
5479: $cucourseid%$cuname+
5480: $cucourseid%$cudom);
5481: }
5482: return $return;
5483: }
5484:
5485: sub receipt {
5486: my ($part)=@_;
5487: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
5488: return &ireceipt($name,$domain,$courseid,$symb,$part);
5489: }
5490:
5491: # ------------------------------------------------------------ Serves up a file
5492: # returns either the contents of the file or
5493: # -1 if the file doesn't exist
5494: #
5495: # if the target is a file that was uploaded via DOCS,
5496: # a check will be made to see if a current copy exists on the local server,
5497: # if it does this will be served, otherwise a copy will be retrieved from
5498: # the home server for the course and stored in /home/httpd/html/userfiles on
5499: # the local server.
5500:
5501: sub getfile {
5502: my ($file) = @_;
5503: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
5504: &repcopy($file);
5505: return &readfile($file);
5506: }
5507:
5508: sub repcopy_userfile {
5509: my ($file)=@_;
5510: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
5511: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
5512: my ($cdom,$cnum,$filename) =
5513: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+([^/]+)/+([^/]+)/+(.*)|);
5514: my ($info,$rtncode);
5515: my $uri="/uploaded/$cdom/$cnum/$filename";
5516: if (-e "$file") {
5517: my @fileinfo = stat($file);
5518: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
5519: if ($lwpresp ne 'ok') {
5520: if ($rtncode eq '404') {
5521: unlink($file);
5522: }
5523: #my $ua=new LWP::UserAgent;
5524: #my $request=new HTTP::Request('GET',&tokenwrapper($uri));
5525: #my $response=$ua->request($request);
5526: #if ($response->is_success()) {
5527: # return $response->content;
5528: # } else {
5529: # return -1;
5530: # }
5531: return -1;
5532: }
5533: if ($info < $fileinfo[9]) {
5534: return 'ok';
5535: }
5536: $info = '';
5537: $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
5538: if ($lwpresp ne 'ok') {
5539: return -1;
5540: }
5541: } else {
5542: my $lwpresp = &getuploaded('GET',$uri,$cdom,$cnum,\$info,\$rtncode);
5543: if ($lwpresp ne 'ok') {
5544: my $ua=new LWP::UserAgent;
5545: my $request=new HTTP::Request('GET',&tokenwrapper($uri));
5546: my $response=$ua->request($request);
5547: if ($response->is_success()) {
5548: $info=$response->content;
5549: } else {
5550: return -1;
5551: }
5552: }
5553: my @parts = ($cdom,$cnum);
5554: if ($filename =~ m|^(.+)/[^/]+$|) {
5555: push @parts, split(/\//,$1);
5556: }
5557: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
5558: foreach my $part (@parts) {
5559: $path .= '/'.$part;
5560: if (!-e $path) {
5561: mkdir($path,0770);
5562: }
5563: }
5564: }
5565: open(FILE,">$file");
5566: print FILE $info;
5567: close(FILE);
5568: return 'ok';
5569: }
5570:
5571: sub tokenwrapper {
5572: my $uri=shift;
5573: $uri=~s|^http\://([^/]+)||;
5574: $uri=~s|^/||;
5575: $env{'user.environment'}=~/\/([^\/]+)\.id/;
5576: my $token=$1;
5577: my (undef,$udom,$uname,$file)=split('/',$uri,4);
5578: if ($udom && $uname && $file) {
5579: $file=~s|(\?\.*)*$||;
5580: &appenv("userfile.$udom/$uname/$file" => $env{'request.course.id'});
5581: return 'http://'.$hostname{ &homeserver($uname,$udom)}.'/'.$uri.
5582: (($uri=~/\?/)?'&':'?').'token='.$token.
5583: '&tokenissued='.$perlvar{'lonHostID'};
5584: } else {
5585: return '/adm/notfound.html';
5586: }
5587: }
5588:
5589: sub getuploaded {
5590: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
5591: $uri=~s/^\///;
5592: $uri = 'http://'.$hostname{ &homeserver($cnum,$cdom)}.'/raw/'.$uri;
5593: my $ua=new LWP::UserAgent;
5594: my $request=new HTTP::Request($reqtype,$uri);
5595: my $response=$ua->request($request);
5596: $$rtncode = $response->code;
5597: if (! $response->is_success()) {
5598: return 'failed';
5599: }
5600: if ($reqtype eq 'HEAD') {
5601: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
5602: } elsif ($reqtype eq 'GET') {
5603: $$info = $response->content;
5604: }
5605: return 'ok';
5606: }
5607:
5608: sub readfile {
5609: my $file = shift;
5610: if ( (! -e $file ) || ($file eq '') ) { return -1; };
5611: my $fh;
5612: open($fh,"<$file");
5613: my $a='';
5614: while (<$fh>) { $a .=$_; }
5615: return $a;
5616: }
5617:
5618: sub filelocation {
5619: my ($dir,$file) = @_;
5620: my $location;
5621: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
5622: if ($file=~m:^/~:) { # is a contruction space reference
5623: $location = $file;
5624: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
5625: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
5626: my ($udom,$uname,$filename)=
5627: ($file=~m -^/+(?:uploaded|editupload)/+([^/]+)/+([^/]+)/+(.*)$-);
5628: my $home=&homeserver($uname,$udom);
5629: my $is_me=0;
5630: my @ids=¤t_machine_ids();
5631: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
5632: if ($is_me) {
5633: $location=&Apache::loncommon::propath($udom,$uname).
5634: '/userfiles/'.$filename;
5635: } else {
5636: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
5637: $udom.'/'.$uname.'/'.$filename;
5638: }
5639: } else {
5640: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
5641: $file=~s:^/res/:/:;
5642: if ( !( $file =~ m:^/:) ) {
5643: $location = $dir. '/'.$file;
5644: } else {
5645: $location = '/home/httpd/html/res'.$file;
5646: }
5647: }
5648: $location=~s://+:/:g; # remove duplicate /
5649: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
5650: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
5651: return $location;
5652: }
5653:
5654: sub hreflocation {
5655: my ($dir,$file)=@_;
5656: unless (($file=~m-^http://-i) || ($file=~m-^/-)) {
5657: my $finalpath=filelocation($dir,$file);
5658: $finalpath=~s-^/home/httpd/html--;
5659: $finalpath=~s-^/home/(\w+)/public_html/-/~$1/-;
5660: return $finalpath;
5661: } elsif ($file=~m-^/home-) {
5662: $file=~s-^/home/httpd/html--;
5663: $file=~s-^/home/(\w+)/public_html/-/~$1/-;
5664: return $file;
5665: }
5666: return $file;
5667: }
5668:
5669: sub current_machine_domains {
5670: my $hostname=$hostname{$perlvar{'lonHostID'}};
5671: my @domains;
5672: while( my($id, $name) = each(%hostname)) {
5673: # &logthis("-$id-$name-$hostname-");
5674: if ($hostname eq $name) {
5675: push(@domains,$hostdom{$id});
5676: }
5677: }
5678: return @domains;
5679: }
5680:
5681: sub current_machine_ids {
5682: my $hostname=$hostname{$perlvar{'lonHostID'}};
5683: my @ids;
5684: while( my($id, $name) = each(%hostname)) {
5685: # &logthis("-$id-$name-$hostname-");
5686: if ($hostname eq $name) {
5687: push(@ids,$id);
5688: }
5689: }
5690: return @ids;
5691: }
5692:
5693: # ------------------------------------------------------------- Declutters URLs
5694:
5695: sub declutter {
5696: my $thisfn=shift;
5697: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
5698: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
5699: $thisfn=~s/^\///;
5700: $thisfn=~s/^res\///;
5701: $thisfn=~s/\?.+$//;
5702: return $thisfn;
5703: }
5704:
5705: # ------------------------------------------------------------- Clutter up URLs
5706:
5707: sub clutter {
5708: my $thisfn='/'.&declutter(shift);
5709: unless ($thisfn=~/^\/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)\//) {
5710: $thisfn='/res'.$thisfn;
5711: }
5712: return $thisfn;
5713: }
5714:
5715: sub freeze_escape {
5716: my ($value)=@_;
5717: if (ref($value)) {
5718: $value=&nfreeze($value);
5719: return '__FROZEN__'.&escape($value);
5720: }
5721: return &escape($value);
5722: }
5723:
5724: # -------------------------------------------------------- Escape Special Chars
5725:
5726: sub escape {
5727: my $str=shift;
5728: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
5729: return $str;
5730: }
5731:
5732: # ----------------------------------------------------- Un-Escape Special Chars
5733:
5734: sub unescape {
5735: my $str=shift;
5736: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
5737: return $str;
5738: }
5739:
5740: sub thaw_unescape {
5741: my ($value)=@_;
5742: if ($value =~ /^__FROZEN__/) {
5743: substr($value,0,10,undef);
5744: $value=&unescape($value);
5745: return &thaw($value);
5746: }
5747: return &unescape($value);
5748: }
5749:
5750: sub mod_perl_version {
5751: return 1;
5752: if (defined($perlvar{'MODPERL2'})) {
5753: return 2;
5754: }
5755: }
5756:
5757: sub correct_line_ends {
5758: my ($result)=@_;
5759: $$result =~s/\r\n/\n/mg;
5760: $$result =~s/\r/\n/mg;
5761: }
5762: # ================================================================ Main Program
5763:
5764: sub goodbye {
5765: &logthis("Starting Shut down");
5766: #not converted to using infrastruture and probably shouldn't be
5767: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&freeze(\%badServerCache))));
5768: #converted
5769: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
5770: &logthis(sprintf("%-20s is %s",'%homecache',length(&freeze(\%homecache))));
5771: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&freeze(\%titlecache))));
5772: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&freeze(\%courseresdatacache))));
5773: #1.1 only
5774: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&freeze(\%userresdatacache))));
5775: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&freeze(\%getsectioncache))));
5776: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&freeze(\%courseresversioncache))));
5777: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&freeze(\%resversioncache))));
5778: &logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
5779: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
5780: &logthis(sprintf("%-20s is %s",'hits',$hits));
5781: &flushcourselogs();
5782: &logthis("Shutting down");
5783: return DONE;
5784: }
5785:
5786: BEGIN {
5787: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
5788: unless ($readit) {
5789: {
5790: # FIXME: Use LONCAPA::Configuration::read_conf here and omit next block
5791: open(my $config,"</etc/httpd/conf/loncapa.conf");
5792:
5793: while (my $configline=<$config>) {
5794: if ($configline=~/\S/ && $configline =~ /^[^\#]*PerlSetVar/) {
5795: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
5796: chomp($varvalue);
5797: $perlvar{$varname}=$varvalue;
5798: }
5799: }
5800: close($config);
5801: }
5802: {
5803: open(my $config,"</etc/httpd/conf/loncapa_apache.conf");
5804:
5805: while (my $configline=<$config>) {
5806: if ($configline =~ /^[^\#]*PerlSetVar/) {
5807: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
5808: chomp($varvalue);
5809: $perlvar{$varname}=$varvalue;
5810: }
5811: }
5812: close($config);
5813: }
5814:
5815: # ------------------------------------------------------------ Read domain file
5816: {
5817: %domaindescription = ();
5818: %domain_auth_def = ();
5819: %domain_auth_arg_def = ();
5820: my $fh;
5821: if (open($fh,"<".$Apache::lonnet::perlvar{'lonTabDir'}.'/domain.tab')) {
5822: while (<$fh>) {
5823: next if (/^(\#|\s*$)/);
5824: # next if /^\#/;
5825: chomp;
5826: my ($domain, $domain_description, $def_auth, $def_auth_arg,
5827: $def_lang, $city, $longi, $lati) = split(/:/,$_);
5828: $domain_auth_def{$domain}=$def_auth;
5829: $domain_auth_arg_def{$domain}=$def_auth_arg;
5830: $domaindescription{$domain}=$domain_description;
5831: $domain_lang_def{$domain}=$def_lang;
5832: $domain_city{$domain}=$city;
5833: $domain_longi{$domain}=$longi;
5834: $domain_lati{$domain}=$lati;
5835:
5836: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
5837: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
5838: }
5839: }
5840: close ($fh);
5841: }
5842:
5843:
5844: # ------------------------------------------------------------- Read hosts file
5845: {
5846: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
5847:
5848: while (my $configline=<$config>) {
5849: next if ($configline =~ /^(\#|\s*$)/);
5850: chomp($configline);
5851: my ($id,$domain,$role,$name)=split(/:/,$configline);
5852: $name=~s/\s//g;
5853: if ($id && $domain && $role && $name) {
5854: $hostname{$id}=$name;
5855: $hostdom{$id}=$domain;
5856: if ($role eq 'library') { $libserv{$id}=$name; }
5857: }
5858: }
5859: close($config);
5860: # FIXME: dev server don't want this, production servers _do_ want this
5861: #&get_iphost();
5862: }
5863:
5864: sub get_iphost {
5865: if (%iphost) { return %iphost; }
5866: foreach my $id (keys(%hostname)) {
5867: my $name=$hostname{$id};
5868: my $ip = gethostbyname($name);
5869: if (!$ip || length($ip) ne 4) {
5870: &logthis("Skipping host $id name $name no IP found\n");
5871: next;
5872: }
5873: $ip=inet_ntoa($ip);
5874: push(@{$iphost{$ip}},$id);
5875: }
5876: return %iphost;
5877: }
5878:
5879: # ------------------------------------------------------ Read spare server file
5880: {
5881: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
5882:
5883: while (my $configline=<$config>) {
5884: chomp($configline);
5885: if ($configline) {
5886: $spareid{$configline}=1;
5887: }
5888: }
5889: close($config);
5890: }
5891: # ------------------------------------------------------------ Read permissions
5892: {
5893: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
5894:
5895: while (my $configline=<$config>) {
5896: chomp($configline);
5897: if ($configline) {
5898: my ($role,$perm)=split(/ /,$configline);
5899: if ($perm ne '') { $pr{$role}=$perm; }
5900: }
5901: }
5902: close($config);
5903: }
5904:
5905: # -------------------------------------------- Read plain texts for permissions
5906: {
5907: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
5908:
5909: while (my $configline=<$config>) {
5910: chomp($configline);
5911: if ($configline) {
5912: my ($short,$plain)=split(/:/,$configline);
5913: if ($plain ne '') { $prp{$short}=$plain; }
5914: }
5915: }
5916: close($config);
5917: }
5918:
5919: # ---------------------------------------------------------- Read package table
5920: {
5921: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
5922:
5923: while (my $configline=<$config>) {
5924: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
5925: chomp($configline);
5926: my ($short,$plain)=split(/:/,$configline);
5927: my ($pack,$name)=split(/\&/,$short);
5928: if ($plain ne '') {
5929: $packagetab{$pack.'&'.$name.'&name'}=$name;
5930: $packagetab{$short}=$plain;
5931: }
5932: }
5933: close($config);
5934: }
5935:
5936: # ------------- set up temporary directory
5937: {
5938: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
5939:
5940: }
5941:
5942: $memcache=new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
5943:
5944: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
5945: $dumpcount=0;
5946:
5947: &logtouch();
5948: &logthis('<font color=yellow>INFO: Read configuration</font>');
5949: $readit=1;
5950: {
5951: use integer;
5952: my $test=(2**32)+1;
5953: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
5954: &logthis(" Detected 64bit platform ($_64bit)");
5955: }
5956: }
5957: }
5958:
5959: 1;
5960: __END__
5961:
5962: =pod
5963:
5964: =head1 NAME
5965:
5966: Apache::lonnet - Subroutines to ask questions about things in the network.
5967:
5968: =head1 SYNOPSIS
5969:
5970: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
5971:
5972: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
5973:
5974: Common parameters:
5975:
5976: =over 4
5977:
5978: =item *
5979:
5980: $uname : an internal username (if $cname expecting a course Id specifically)
5981:
5982: =item *
5983:
5984: $udom : a domain (if $cdom expecting a course's domain specifically)
5985:
5986: =item *
5987:
5988: $symb : a resource instance identifier
5989:
5990: =item *
5991:
5992: $namespace : the name of a .db file that contains the data needed or
5993: being set.
5994:
5995: =back
5996:
5997: =head1 OVERVIEW
5998:
5999: lonnet provides subroutines which interact with the
6000: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
6001: about classes, users, and resources.
6002:
6003: For many of these objects you can also use this to store data about
6004: them or modify them in various ways.
6005:
6006: =head2 Symbs
6007:
6008: To identify a specific instance of a resource, LON-CAPA uses symbols
6009: or "symbs"X<symb>. These identifiers are built from the URL of the
6010: map, the resource number of the resource in the map, and the URL of
6011: the resource itself. The latter is somewhat redundant, but might help
6012: if maps change.
6013:
6014: An example is
6015:
6016: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
6017:
6018: The respective map entry is
6019:
6020: <resource id="19" src="/res/msu/korte/tests/part12.problem"
6021: title="Problem 2">
6022: </resource>
6023:
6024: Symbs are used by the random number generator, as well as to store and
6025: restore data specific to a certain instance of for example a problem.
6026:
6027: =head2 Storing And Retrieving Data
6028:
6029: X<store()>X<cstore()>X<restore()>Three of the most important functions
6030: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
6031: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
6032: is is the non-critical message twin of cstore. These functions are for
6033: handlers to store a perl hash to a user's permanent data space in an
6034: easy manner, and to retrieve it again on another call. It is expected
6035: that a handler would use this once at the beginning to retrieve data,
6036: and then again once at the end to send only the new data back.
6037:
6038: The data is stored in the user's data directory on the user's
6039: homeserver under the ID of the course.
6040:
6041: The hash that is returned by restore will have all of the previous
6042: value for all of the elements of the hash.
6043:
6044: Example:
6045:
6046: #creating a hash
6047: my %hash;
6048: $hash{'foo'}='bar';
6049:
6050: #storing it
6051: &Apache::lonnet::cstore(\%hash);
6052:
6053: #changing a value
6054: $hash{'foo'}='notbar';
6055:
6056: #adding a new value
6057: $hash{'bar'}='foo';
6058: &Apache::lonnet::cstore(\%hash);
6059:
6060: #retrieving the hash
6061: my %history=&Apache::lonnet::restore();
6062:
6063: #print the hash
6064: foreach my $key (sort(keys(%history))) {
6065: print("\%history{$key} = $history{$key}");
6066: }
6067:
6068: Will print out:
6069:
6070: %history{1:foo} = bar
6071: %history{1:keys} = foo:timestamp
6072: %history{1:timestamp} = 990455579
6073: %history{2:bar} = foo
6074: %history{2:foo} = notbar
6075: %history{2:keys} = foo:bar:timestamp
6076: %history{2:timestamp} = 990455580
6077: %history{bar} = foo
6078: %history{foo} = notbar
6079: %history{timestamp} = 990455580
6080: %history{version} = 2
6081:
6082: Note that the special hash entries C<keys>, C<version> and
6083: C<timestamp> were added to the hash. C<version> will be equal to the
6084: total number of versions of the data that have been stored. The
6085: C<timestamp> attribute will be the UNIX time the hash was
6086: stored. C<keys> is available in every historical section to list which
6087: keys were added or changed at a specific historical revision of a
6088: hash.
6089:
6090: B<Warning>: do not store the hash that restore returns directly. This
6091: will cause a mess since it will restore the historical keys as if the
6092: were new keys. I.E. 1:foo will become 1:1:foo etc.
6093:
6094: Calling convention:
6095:
6096: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
6097: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
6098:
6099: For more detailed information, see lonnet specific documentation.
6100:
6101: =head1 RETURN MESSAGES
6102:
6103: =over 4
6104:
6105: =item * B<con_lost>: unable to contact remote host
6106:
6107: =item * B<con_delayed>: unable to contact remote host, message will be delivered
6108: when the connection is brought back up
6109:
6110: =item * B<con_failed>: unable to contact remote host and unable to save message
6111: for later delivery
6112:
6113: =item * B<error:>: an error a occured, a description of the error follows the :
6114:
6115: =item * B<no_such_host>: unable to fund a host associated with the user/domain
6116: that was requested
6117:
6118: =back
6119:
6120: =head1 PUBLIC SUBROUTINES
6121:
6122: =head2 Session Environment Functions
6123:
6124: =over 4
6125:
6126: =item *
6127: X<appenv()>
6128: B<appenv(%hash)>: the value of %hash is written to
6129: the user envirnoment file, and will be restored for each access this
6130: user makes during this session, also modifies the %env for the current
6131: process
6132:
6133: =item *
6134: X<delenv()>
6135: B<delenv($regexp)>: removes all items from the session
6136: environment file that matches the regular expression in $regexp. The
6137: values are also delted from the current processes %env.
6138:
6139: =back
6140:
6141: =head2 User Information
6142:
6143: =over 4
6144:
6145: =item *
6146: X<queryauthenticate()>
6147: B<queryauthenticate($uname,$udom)>: try to determine user's current
6148: authentication scheme
6149:
6150: =item *
6151: X<authenticate()>
6152: B<authenticate($uname,$upass,$udom)>: try to
6153: authenticate user from domain's lib servers (first use the current
6154: one). C<$upass> should be the users password.
6155:
6156: =item *
6157: X<homeserver()>
6158: B<homeserver($uname,$udom)>: find the server which has
6159: the user's directory and files (there must be only one), this caches
6160: the answer, and also caches if there is a borken connection.
6161:
6162: =item *
6163: X<idget()>
6164: B<idget($udom,@ids)>: find the usernames behind a list of IDs
6165: (IDs are a unique resource in a domain, there must be only 1 ID per
6166: username, and only 1 username per ID in a specific domain) (returns
6167: hash: id=>name,id=>name)
6168:
6169: =item *
6170: X<idrget()>
6171: B<idrget($udom,@unames)>: find the IDs behind a list of
6172: usernames (returns hash: name=>id,name=>id)
6173:
6174: =item *
6175: X<idput()>
6176: B<idput($udom,%ids)>: store away a list of names and associated IDs
6177:
6178: =item *
6179: X<rolesinit()>
6180: B<rolesinit($udom,$username,$authhost)>: get user privileges
6181:
6182: =item *
6183: X<getsection()>
6184: B<getsection($udom,$uname,$cname)>: finds the section of student in the
6185: course $cname, return section name/number or '' for "not in course"
6186: and '-1' for "no section"
6187:
6188: =item *
6189: X<userenvironment()>
6190: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
6191: passed in @what from the requested user's environment, returns a hash
6192:
6193: =back
6194:
6195: =head2 User Roles
6196:
6197: =over 4
6198:
6199: =item *
6200:
6201: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
6202: actions
6203: F: full access
6204: U,I,K: authentication modes (cxx only)
6205: '': forbidden
6206: 1: user needs to choose course
6207: 2: browse allowed
6208:
6209: =item *
6210:
6211: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
6212: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
6213: and course level
6214:
6215: =item *
6216:
6217: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
6218: explanation of a user role term
6219:
6220: =back
6221:
6222: =head2 User Modification
6223:
6224: =over 4
6225:
6226: =item *
6227:
6228: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
6229: user for the level given by URL. Optional start and end dates (leave empty
6230: string or zero for "no date")
6231:
6232: =item *
6233:
6234: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
6235: change a users, password, possible return values are: ok,
6236: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
6237: refused
6238:
6239: =item *
6240:
6241: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
6242:
6243: =item *
6244:
6245: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
6246: modify user
6247:
6248: =item *
6249:
6250: modifystudent
6251:
6252: modify a students enrollment and identification information.
6253: The course id is resolved based on the current users environment.
6254: This means the envoking user must be a course coordinator or otherwise
6255: associated with a course.
6256:
6257: This call is essentially a wrapper for lonnet::modifyuser and
6258: lonnet::modify_student_enrollment
6259:
6260: Inputs:
6261:
6262: =over 4
6263:
6264: =item B<$udom> Students loncapa domain
6265:
6266: =item B<$uname> Students loncapa login name
6267:
6268: =item B<$uid> Students id/student number
6269:
6270: =item B<$umode> Students authentication mode
6271:
6272: =item B<$upass> Students password
6273:
6274: =item B<$first> Students first name
6275:
6276: =item B<$middle> Students middle name
6277:
6278: =item B<$last> Students last name
6279:
6280: =item B<$gene> Students generation
6281:
6282: =item B<$usec> Students section in course
6283:
6284: =item B<$end> Unix time of the roles expiration
6285:
6286: =item B<$start> Unix time of the roles start date
6287:
6288: =item B<$forceid> If defined, allow $uid to be changed
6289:
6290: =item B<$desiredhome> server to use as home server for student
6291:
6292: =back
6293:
6294: =item *
6295:
6296: modify_student_enrollment
6297:
6298: Change a students enrollment status in a class. The environment variable
6299: 'role.request.course' must be defined for this function to proceed.
6300:
6301: Inputs:
6302:
6303: =over 4
6304:
6305: =item $udom, students domain
6306:
6307: =item $uname, students name
6308:
6309: =item $uid, students user id
6310:
6311: =item $first, students first name
6312:
6313: =item $middle
6314:
6315: =item $last
6316:
6317: =item $gene
6318:
6319: =item $usec
6320:
6321: =item $end
6322:
6323: =item $start
6324:
6325: =back
6326:
6327:
6328: =item *
6329:
6330: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
6331: custom role; give a custom role to a user for the level given by URL. Specify
6332: name and domain of role author, and role name
6333:
6334: =item *
6335:
6336: revokerole($udom,$uname,$url,$role) : revoke a role for url
6337:
6338: =item *
6339:
6340: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
6341:
6342: =back
6343:
6344: =head2 Course Infomation
6345:
6346: =over 4
6347:
6348: =item *
6349:
6350: coursedescription($courseid) : returns a hash of information about the
6351: specified course id, including all environment settings for the
6352: course, the description of the course will be in the hash under the
6353: key 'description'
6354:
6355: =item *
6356:
6357: resdata($name,$domain,$type,@which) : request for current parameter
6358: setting for a specific $type, where $type is either 'course' or 'user',
6359: @what should be a list of parameters to ask about. This routine caches
6360: answers for 5 minutes.
6361:
6362: =back
6363:
6364: =head2 Course Modification
6365:
6366: =over 4
6367:
6368: =item *
6369:
6370: writecoursepref($courseid,%prefs) : write preferences (environment
6371: database) for a course
6372:
6373: =item *
6374:
6375: createcourse($udom,$description,$url) : make/modify course
6376:
6377: =back
6378:
6379: =head2 Resource Subroutines
6380:
6381: =over 4
6382:
6383: =item *
6384:
6385: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
6386:
6387: =item *
6388:
6389: repcopy($filename) : subscribes to the requested file, and attempts to
6390: replicate from the owning library server, Might return
6391: 'unavailable', 'not_found', 'forbidden', 'ok', or
6392: 'bad_request', also attempts to grab the metadata for the
6393: resource. Expects the local filesystem pathname
6394: (/home/httpd/html/res/....)
6395:
6396: =back
6397:
6398: =head2 Resource Information
6399:
6400: =over 4
6401:
6402: =item *
6403:
6404: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
6405: a vairety of different possible values, $varname should be a request
6406: string, and the other parameters can be used to specify who and what
6407: one is asking about.
6408:
6409: Possible values for $varname are environment.lastname (or other item
6410: from the envirnment hash), user.name (or someother aspect about the
6411: user), resource.0.maxtries (or some other part and parameter of a
6412: resource)
6413:
6414: =item *
6415:
6416: directcondval($number) : get current value of a condition; reads from a state
6417: string
6418:
6419: =item *
6420:
6421: condval($condidx) : value of condition index based on state
6422:
6423: =item *
6424:
6425: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
6426: resource's metadata, $what should be either a specific key, or either
6427: 'keys' (to get a list of possible keys) or 'packages' to get a list of
6428: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
6429:
6430: this function automatically caches all requests
6431:
6432: =item *
6433:
6434: metadata_query($query,$custom,$customshow) : make a metadata query against the
6435: network of library servers; returns file handle of where SQL and regex results
6436: will be stored for query
6437:
6438: =item *
6439:
6440: symbread($filename) : return symbolic list entry (filename argument optional);
6441: returns the data handle
6442:
6443: =item *
6444:
6445: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
6446: a possible symb for the URL in $thisfn, and if is an encryypted
6447: resource that the user accessed using /enc/ returns a 1 on success, 0
6448: on failure, user must be in a course, as it assumes the existance of
6449: the course initial hash, and uses $env('request.course.id'}
6450:
6451:
6452: =item *
6453:
6454: symbclean($symb) : removes versions numbers from a symb, returns the
6455: cleaned symb
6456:
6457: =item *
6458:
6459: is_on_map($uri) : checks if the $uri is somewhere on the current
6460: course map, user must be in a course for it to work.
6461:
6462: =item *
6463:
6464: numval($salt) : return random seed value (addend for rndseed)
6465:
6466: =item *
6467:
6468: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
6469: a random seed, all arguments are optional, if they aren't sent it uses the
6470: environment to derive them. Note: if symb isn't sent and it can't get one
6471: from &symbread it will use the current time as its return value
6472:
6473: =item *
6474:
6475: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
6476: unfakeable, receipt
6477:
6478: =item *
6479:
6480: receipt() : API to ireceipt working off of env values; given out to users
6481:
6482: =item *
6483:
6484: countacc($url) : count the number of accesses to a given URL
6485:
6486: =item *
6487:
6488: 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
6489:
6490: =item *
6491:
6492: 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)
6493:
6494: =item *
6495:
6496: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
6497:
6498: =item *
6499:
6500: devalidate($symb) : devalidate temporary spreadsheet calculations,
6501: forcing spreadsheet to reevaluate the resource scores next time.
6502:
6503: =back
6504:
6505: =head2 Storing/Retreiving Data
6506:
6507: =over 4
6508:
6509: =item *
6510:
6511: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
6512: for this url; hashref needs to be given and should be a \%hashname; the
6513: remaining args aren't required and if they aren't passed or are '' they will
6514: be derived from the env
6515:
6516: =item *
6517:
6518: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
6519: uses critical subroutine
6520:
6521: =item *
6522:
6523: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
6524: all args are optional
6525:
6526: =item *
6527:
6528: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
6529: works very similar to store/cstore, but all data is stored in a
6530: temporary location and can be reset using tmpreset, $storehash should
6531: be a hash reference, returns nothing on success
6532:
6533: =item *
6534:
6535: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
6536: similar to restore, but all data is stored in a temporary location and
6537: can be reset using tmpreset. Returns a hash of values on success,
6538: error string otherwise.
6539:
6540: =item *
6541:
6542: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
6543: deltes all keys for $symb form the temporary storage hash.
6544:
6545: =item *
6546:
6547: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
6548: reference filled in from namesp ($udom and $uname are optional)
6549:
6550: =item *
6551:
6552: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
6553: namesp ($udom and $uname are optional)
6554:
6555: =item *
6556:
6557: dump($namespace,$udom,$uname,$regexp) :
6558: dumps the complete (or key matching regexp) namespace into a hash
6559: ($udom, $uname and $regexp are optional)
6560:
6561: =item *
6562:
6563: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
6564: $store can be a scalar, an array reference, or if the amount to be
6565: incremented is > 1, a hash reference.
6566:
6567: ($udom and $uname are optional)
6568:
6569: =item *
6570:
6571: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
6572: ($udom and $uname are optional)
6573:
6574: =item *
6575:
6576: putstore($namespace,$storehash,$udomain,$uname) : stores hash in namesp
6577: keys used in storehash include version information (e.g., 1:$symb:message etc.) as
6578: used in records written by &store and retrieved by &restore. This function
6579: was created for use in editing discussion posts, without incrementing the
6580: version number included in the key for a particular post. The colon
6581: separated list of attribute names (e.g., the value associated with the key
6582: 1:keys:$symb) is also generated and passed in the ampersand separated
6583: items sent to lonnet::reply().
6584:
6585: =item *
6586:
6587: cput($namespace,$storehash,$udom,$uname) : critical put
6588: ($udom and $uname are optional)
6589:
6590: =item *
6591:
6592: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
6593: reference filled in from namesp (encrypts the return communication)
6594: ($udom and $uname are optional)
6595:
6596: =item *
6597:
6598: log($udom,$name,$home,$message) : write to permanent log for user; use
6599: critical subroutine
6600:
6601: =back
6602:
6603: =head2 Network Status Functions
6604:
6605: =over 4
6606:
6607: =item *
6608:
6609: dirlist($uri) : return directory list based on URI
6610:
6611: =item *
6612:
6613: spareserver() : find server with least workload from spare.tab
6614:
6615: =back
6616:
6617: =head2 Apache Request
6618:
6619: =over 4
6620:
6621: =item *
6622:
6623: ssi($url,%hash) : server side include, does a complete request cycle on url to
6624: localhost, posts hash
6625:
6626: =back
6627:
6628: =head2 Data to String to Data
6629:
6630: =over 4
6631:
6632: =item *
6633:
6634: hash2str(%hash) : convert a hash into a string complete with escaping and '='
6635: and '&' separators, supports elements that are arrayrefs and hashrefs
6636:
6637: =item *
6638:
6639: hashref2str($hashref) : convert a hashref into a string complete with
6640: escaping and '=' and '&' separators, supports elements that are
6641: arrayrefs and hashrefs
6642:
6643: =item *
6644:
6645: arrayref2str($arrayref) : convert an arrayref into a string complete
6646: with escaping and '&' separators, supports elements that are arrayrefs
6647: and hashrefs
6648:
6649: =item *
6650:
6651: str2hash($string) : convert string to hash using unescaping and
6652: splitting on '=' and '&', supports elements that are arrayrefs and
6653: hashrefs
6654:
6655: =item *
6656:
6657: str2array($string) : convert string to hash using unescaping and
6658: splitting on '&', supports elements that are arrayrefs and hashrefs
6659:
6660: =back
6661:
6662: =head2 Logging Routines
6663:
6664: =over 4
6665:
6666: These routines allow one to make log messages in the lonnet.log and
6667: lonnet.perm logfiles.
6668:
6669: =item *
6670:
6671: logtouch() : make sure the logfile, lonnet.log, exists
6672:
6673: =item *
6674:
6675: logthis() : append message to the normal lonnet.log file, it gets
6676: preiodically rolled over and deleted.
6677:
6678: =item *
6679:
6680: logperm() : append a permanent message to lonnet.perm.log, this log
6681: file never gets deleted by any automated portion of the system, only
6682: messages of critical importance should go in here.
6683:
6684: =back
6685:
6686: =head2 General File Helper Routines
6687:
6688: =over 4
6689:
6690: =item *
6691:
6692: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
6693: (a) files in /uploaded
6694: (i) If a local copy of the file exists -
6695: compares modification date of local copy with last-modified date for
6696: definitive version stored on home server for course. If local copy is
6697: stale, requests a new version from the home server and stores it.
6698: If the original has been removed from the home server, then local copy
6699: is unlinked.
6700: (ii) If local copy does not exist -
6701: requests the file from the home server and stores it.
6702:
6703: If $caller is 'uploadrep':
6704: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
6705: for request for files originally uploaded via DOCS.
6706: - returns 'ok' if fresh local copy now available, -1 otherwise.
6707:
6708: Otherwise:
6709: This indicates a call from the content generation phase of the request.
6710: - returns the entire contents of the file or -1.
6711:
6712: (b) files in /res
6713: - returns the entire contents of a file or -1;
6714: it properly subscribes to and replicates the file if neccessary.
6715:
6716: =item *
6717:
6718: filelocation($dir,$file) : returns file system location of a file
6719: based on URI; meant to be "fairly clean" absolute reference, $dir is a
6720: directory that relative $file lookups are to looked in ($dir of /a/dir
6721: and a file of ../bob will become /a/bob)
6722:
6723: =item *
6724:
6725: hreflocation($dir,$file) : returns file system location or a URL; same as
6726: filelocation except for hrefs
6727:
6728: =item *
6729:
6730: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
6731:
6732: =back
6733:
6734: =head2 Usererfile file routines (/uploaded*)
6735:
6736: =over 4
6737:
6738: =item *
6739:
6740: userfileupload(): main rotine for putting a file in a user or course's
6741: filespace, arguments are,
6742:
6743: formname - required - this is the name of the element in $env where the
6744: filename, and the contents of the file to create/modifed exist
6745: the filename is in $env{'form.'.$formname.'.filename'} and the
6746: contents of the file is located in $env{'form.'.$formname}
6747: coursedoc - if true, store the file in the course of the active role
6748: of the current user
6749: subdir - required - subdirectory to put the file in under ../userfiles/
6750: if undefined, it will be placed in "unknown"
6751:
6752: (This routine calls clean_filename() to remove any dangerous
6753: characters from the filename, and then calls finuserfileupload() to
6754: complete the transaction)
6755:
6756: returns either the url of the uploaded file (/uploaded/....) if successful
6757: and /adm/notfound.html if unsuccessful
6758:
6759: =item *
6760:
6761: clean_filename(): routine for cleaing a filename up for storage in
6762: userfile space, argument is:
6763:
6764: filename - proposed filename
6765:
6766: returns: the new clean filename
6767:
6768: =item *
6769:
6770: finishuserfileupload(): routine that creaes and sends the file to
6771: userspace, probably shouldn't be called directly
6772:
6773: docuname: username or courseid of destination for the file
6774: docudom: domain of user/course of destination for the file
6775: formname: same as for userfileupload()
6776: fname: filename (inculding subdirectories) for the file
6777:
6778: returns either the url of the uploaded file (/uploaded/....) if successful
6779: and /adm/notfound.html if unsuccessful
6780:
6781: =item *
6782:
6783: renameuserfile(): renames an existing userfile to a new name
6784:
6785: Args:
6786: docuname: username or courseid of destination for the file
6787: docudom: domain of user/course of destination for the file
6788: old: current file name (including any subdirs under userfiles)
6789: new: desired file name (including any subdirs under userfiles)
6790:
6791: =item *
6792:
6793: mkdiruserfile(): creates a directory is a userfiles dir
6794:
6795: Args:
6796: docuname: username or courseid of destination for the file
6797: docudom: domain of user/course of destination for the file
6798: dir: dir to create (including any subdirs under userfiles)
6799:
6800: =item *
6801:
6802: removeuserfile(): removes a file that exists in userfiles
6803:
6804: Args:
6805: docuname: username or courseid of destination for the file
6806: docudom: domain of user/course of destination for the file
6807: fname: filname to delete (including any subdirs under userfiles)
6808:
6809: =item *
6810:
6811: removeuploadedurl(): convience function for removeuserfile()
6812:
6813: Args:
6814: url: a full /uploaded/... url to delete
6815:
6816: =back
6817:
6818: =head2 HTTP Helper Routines
6819:
6820: =over 4
6821:
6822: =item *
6823:
6824: escape() : unpack non-word characters into CGI-compatible hex codes
6825:
6826: =item *
6827:
6828: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
6829:
6830: =back
6831:
6832: =head1 PRIVATE SUBROUTINES
6833:
6834: =head2 Underlying communication routines (Shouldn't call)
6835:
6836: =over 4
6837:
6838: =item *
6839:
6840: subreply() : tries to pass a message to lonc, returns con_lost if incapable
6841:
6842: =item *
6843:
6844: reply() : uses subreply to send a message to remote machine, logs all failures
6845:
6846: =item *
6847:
6848: critical() : passes a critical message to another server; if cannot
6849: get through then place message in connection buffer directory and
6850: returns con_delayed, if incapable of saving message, returns
6851: con_failed
6852:
6853: =item *
6854:
6855: reconlonc() : tries to reconnect lonc client processes.
6856:
6857: =back
6858:
6859: =head2 Resource Access Logging
6860:
6861: =over 4
6862:
6863: =item *
6864:
6865: flushcourselogs() : flush (save) buffer logs and access logs
6866:
6867: =item *
6868:
6869: courselog($what) : save message for course in hash
6870:
6871: =item *
6872:
6873: courseacclog($what) : save message for course using &courselog(). Perform
6874: special processing for specific resource types (problems, exams, quizzes, etc).
6875:
6876: =item *
6877:
6878: goodbye() : flush course logs and log shutting down; it is called in srm.conf
6879: as a PerlChildExitHandler
6880:
6881: =back
6882:
6883: =head2 Other
6884:
6885: =over 4
6886:
6887: =item *
6888:
6889: symblist($mapname,%newhash) : update symbolic storage links
6890:
6891: =back
6892:
6893: =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