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