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