1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.341 2003/03/18 07:26:49 www 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: # 6/1/99,6/2,6/10,6/11,6/12,6/14,6/26,6/28,6/29,6/30,
29: # 7/1,7/2,7/9,7/10,7/12,7/14,7/15,7/19,
30: # 11/8,11/16,11/18,11/22,11/23,12/22,
31: # 01/06,01/13,02/24,02/28,02/29,
32: # 03/01,03/02,03/06,03/07,03/13,
33: # 04/05,05/29,05/31,06/01,
34: # 06/05,06/26 Gerd Kortemeyer
35: # 06/26 Ben Tyszka
36: # 06/30,07/15,07/17,07/18,07/20,07/21,07/22,07/25 Gerd Kortemeyer
37: # 08/14 Ben Tyszka
38: # 08/22,08/28,08/31,09/01,09/02,09/04,09/05,09/25,09/28,09/30 Gerd Kortemeyer
39: # 10/04 Gerd Kortemeyer
40: # 10/04 Guy Albertelli
41: # 10/06,10/09,10/10,10/11,10/14,10/20,10/23,10/25,10/26,10/27,10/28,10/29,
42: # 10/30,10/31,
43: # 11/2,11/14,11/15,11/16,11/20,11/21,11/22,11/25,11/27,
44: # 12/02,12/12,12/13,12/14,12/28,12/29 Gerd Kortemeyer
45: # 05/01/01 Guy Albertelli
46: # 05/01,06/01,09/01 Gerd Kortemeyer
47: # 09/01 Guy Albertelli
48: # 09/01,10/01,11/01 Gerd Kortemeyer
49: # YEAR=2001
50: # 3/2 Gerd Kortemeyer
51: # 3/19,3/20 Gerd Kortemeyer
52: # 5/26,5/28 Gerd Kortemeyer
53: # 5/30 H. K. Ng
54: # 6/1 Gerd Kortemeyer
55: # July Guy Albertelli
56: # 8/4,8/7,8/8,8/9,8/11,8/16,8/17,8/18,8/20,8/23,9/20,9/21,9/26,
57: # 10/2 Gerd Kortemeyer
58: # 11/17,11/20,11/22,11/29 Gerd Kortemeyer
59: # 12/5 Matthew Hall
60: # 12/5 Guy Albertelli
61: # 12/6,12/7,12/12 Gerd Kortemeyer
62: # 12/21,12/22,12/27,12/28 Gerd Kortemeyer
63: # YEAR=2002
64: # 1/4,2/4,2/7 Gerd Kortemeyer
65: #
66: ###
67:
68: package Apache::lonnet;
69:
70: use strict;
71: use Apache::File;
72: use LWP::UserAgent();
73: use HTTP::Headers;
74: use vars
75: qw(%perlvar %hostname %homecache %badServerCache %hostip %iphost %spareid %hostdom
76: %libserv %pr %prp %metacache %packagetab %titlecache
77: %courselogs %accesshash $processmarker $dumpcount
78: %coursedombuf %coursehombuf %courseresdatacache
79: %domaindescription %domain_auth_def %domain_auth_arg_def $tmpdir);
80: use IO::Socket;
81: use GDBM_File;
82: use Apache::Constants qw(:common :http);
83: use HTML::LCParser;
84: use Fcntl qw(:flock);
85: use Apache::loncoursedata;
86:
87: my $readit;
88:
89: # --------------------------------------------------------------------- Logging
90:
91: sub logtouch {
92: my $execdir=$perlvar{'lonDaemons'};
93: unless (-e "$execdir/logs/lonnet.log") {
94: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
95: close $fh;
96: }
97: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
98: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
99: }
100:
101: sub logthis {
102: my $message=shift;
103: my $execdir=$perlvar{'lonDaemons'};
104: my $now=time;
105: my $local=localtime($now);
106: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
107: print $fh "$local ($$): $message\n";
108: return 1;
109: }
110:
111: sub logperm {
112: my $message=shift;
113: my $execdir=$perlvar{'lonDaemons'};
114: my $now=time;
115: my $local=localtime($now);
116: my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
117: print $fh "$now:$message:$local\n";
118: return 1;
119: }
120:
121: # -------------------------------------------------- Non-critical communication
122: sub subreply {
123: my ($cmd,$server)=@_;
124: my $peerfile="$perlvar{'lonSockDir'}/$server";
125: my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
126: Type => SOCK_STREAM,
127: Timeout => 10)
128: or return "con_lost";
129: print $client "$cmd\n";
130: my $answer=<$client>;
131: if (!$answer) { $answer="con_lost"; }
132: chomp($answer);
133: return $answer;
134: }
135:
136: sub reply {
137: my ($cmd,$server)=@_;
138: unless (defined($hostname{$server})) { return 'no_such_host'; }
139: my $answer=subreply($cmd,$server);
140: if ($answer eq 'con_lost') {
141: #sleep 5;
142: #$answer=subreply($cmd,$server);
143: #if ($answer eq 'con_lost') {
144: # &logthis("Second attempt con_lost on $server");
145: # my $peerfile="$perlvar{'lonSockDir'}/$server";
146: # my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
147: # Type => SOCK_STREAM,
148: # Timeout => 10)
149: # or return "con_lost";
150: # &logthis("Killing socket");
151: # print $client "close_connection_exit\n";
152: #sleep 5;
153: # $answer=subreply($cmd,$server);
154: #}
155: }
156: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
157: &logthis("<font color=blue>WARNING:".
158: " $cmd to $server returned $answer</font>");
159: }
160: return $answer;
161: }
162:
163: # ----------------------------------------------------------- Send USR1 to lonc
164:
165: sub reconlonc {
166: my $peerfile=shift;
167: &logthis("Trying to reconnect for $peerfile");
168: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
169: if (my $fh=Apache::File->new("$loncfile")) {
170: my $loncpid=<$fh>;
171: chomp($loncpid);
172: if (kill 0 => $loncpid) {
173: &logthis("lonc at pid $loncpid responding, sending USR1");
174: kill USR1 => $loncpid;
175: sleep 1;
176: if (-e "$peerfile") { return; }
177: &logthis("$peerfile still not there, give it another try");
178: sleep 5;
179: if (-e "$peerfile") { return; }
180: &logthis(
181: "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
182: } else {
183: &logthis(
184: "<font color=blue>WARNING:".
185: " lonc at pid $loncpid not responding, giving up</font>");
186: }
187: } else {
188: &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
189: }
190: }
191:
192: # ------------------------------------------------------ Critical communication
193:
194: sub critical {
195: my ($cmd,$server)=@_;
196: unless ($hostname{$server}) {
197: &logthis("<font color=blue>WARNING:".
198: " Critical message to unknown server ($server)</font>");
199: return 'no_such_host';
200: }
201: my $answer=reply($cmd,$server);
202: if ($answer eq 'con_lost') {
203: my $pingreply=reply('ping',$server);
204: &reconlonc("$perlvar{'lonSockDir'}/$server");
205: my $pongreply=reply('pong',$server);
206: &logthis("Ping/Pong for $server: $pingreply/$pongreply");
207: $answer=reply($cmd,$server);
208: if ($answer eq 'con_lost') {
209: my $now=time;
210: my $middlename=$cmd;
211: $middlename=substr($middlename,0,16);
212: $middlename=~s/\W//g;
213: my $dfilename=
214: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
215: $dumpcount++;
216: {
217: my $dfh;
218: if ($dfh=Apache::File->new(">$dfilename")) {
219: print $dfh "$cmd\n";
220: }
221: }
222: sleep 2;
223: my $wcmd='';
224: {
225: my $dfh;
226: if ($dfh=Apache::File->new("$dfilename")) {
227: $wcmd=<$dfh>;
228: }
229: }
230: chomp($wcmd);
231: if ($wcmd eq $cmd) {
232: &logthis("<font color=blue>WARNING: ".
233: "Connection buffer $dfilename: $cmd</font>");
234: &logperm("D:$server:$cmd");
235: return 'con_delayed';
236: } else {
237: &logthis("<font color=red>CRITICAL:"
238: ." Critical connection failed: $server $cmd</font>");
239: &logperm("F:$server:$cmd");
240: return 'con_failed';
241: }
242: }
243: }
244: return $answer;
245: }
246:
247: # ---------------------------------------------------------- Append Environment
248:
249: sub appenv {
250: my %newenv=@_;
251: foreach (keys %newenv) {
252: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
253: &logthis("<font color=blue>WARNING: ".
254: "Attempt to modify environment ".$_." to ".$newenv{$_}
255: .'</font>');
256: delete($newenv{$_});
257: } else {
258: $ENV{$_}=$newenv{$_};
259: }
260: }
261:
262: my $lockfh;
263: unless ($lockfh=Apache::File->new("$ENV{'user.environment'}")) {
264: return 'error: '.$!;
265: }
266: unless (flock($lockfh,LOCK_EX)) {
267: &logthis("<font color=blue>WARNING: ".
268: 'Could not obtain exclusive lock in appenv: '.$!);
269: $lockfh->close();
270: return 'error: '.$!;
271: }
272:
273: my @oldenv;
274: {
275: my $fh;
276: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
277: return 'error: '.$!;
278: }
279: @oldenv=<$fh>;
280: $fh->close();
281: }
282: for (my $i=0; $i<=$#oldenv; $i++) {
283: chomp($oldenv[$i]);
284: if ($oldenv[$i] ne '') {
285: my ($name,$value)=split(/=/,$oldenv[$i]);
286: unless (defined($newenv{$name})) {
287: $newenv{$name}=$value;
288: }
289: }
290: }
291: {
292: my $fh;
293: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
294: return 'error';
295: }
296: my $newname;
297: foreach $newname (keys %newenv) {
298: print $fh "$newname=$newenv{$newname}\n";
299: }
300: $fh->close();
301: }
302:
303: $lockfh->close();
304: return 'ok';
305: }
306: # ----------------------------------------------------- Delete from Environment
307:
308: sub delenv {
309: my $delthis=shift;
310: my %newenv=();
311: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
312: &logthis("<font color=blue>WARNING: ".
313: "Attempt to delete from environment ".$delthis);
314: return 'error';
315: }
316: my @oldenv;
317: {
318: my $fh;
319: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
320: return 'error';
321: }
322: unless (flock($fh,LOCK_SH)) {
323: &logthis("<font color=blue>WARNING: ".
324: 'Could not obtain shared lock in delenv: '.$!);
325: $fh->close();
326: return 'error: '.$!;
327: }
328: @oldenv=<$fh>;
329: $fh->close();
330: }
331: {
332: my $fh;
333: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
334: return 'error';
335: }
336: unless (flock($fh,LOCK_EX)) {
337: &logthis("<font color=blue>WARNING: ".
338: 'Could not obtain exclusive lock in delenv: '.$!);
339: $fh->close();
340: return 'error: '.$!;
341: }
342: foreach (@oldenv) {
343: unless ($_=~/^$delthis/) { print $fh $_; }
344: }
345: $fh->close();
346: }
347: return 'ok';
348: }
349:
350: # ------------------------------------------ Fight off request when overloaded
351:
352: sub overloaderror {
353: my ($r,$checkserver)=@_;
354: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
355: my $loadavg;
356: if ($checkserver eq $perlvar{'lonHostID'}) {
357: my $loadfile=Apache::File->new('/proc/loadavg');
358: $loadavg=<$loadfile>;
359: $loadavg =~ s/\s.*//g;
360: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
361: } else {
362: $loadavg=&reply('load',$checkserver);
363: }
364: my $overload=$loadavg-100;
365: if ($overload>0) {
366: $r->err_headers_out->{'Retry-After'}=$overload;
367: $r->log_error('Overload of '.$overload.' on '.$checkserver);
368: return 413;
369: }
370: return '';
371: }
372:
373: # ------------------------------ Find server with least workload from spare.tab
374:
375: sub spareserver {
376: my $loadpercent = shift;
377: my $tryserver;
378: my $spareserver='';
379: my $lowestserver=$loadpercent;
380: foreach $tryserver (keys %spareid) {
381: my $answer=reply('load',$tryserver);
382: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
383: $spareserver="http://$hostname{$tryserver}";
384: $lowestserver=$answer;
385: }
386: }
387: return $spareserver;
388: }
389:
390: # --------------------------------------------- Try to change a user's password
391:
392: sub changepass {
393: my ($uname,$udom,$currentpass,$newpass,$server)=@_;
394: $currentpass = &escape($currentpass);
395: $newpass = &escape($newpass);
396: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass",
397: $server);
398: if (! $answer) {
399: &logthis("No reply on password change request to $server ".
400: "by $uname in domain $udom.");
401: } elsif ($answer =~ "^ok") {
402: &logthis("$uname in $udom successfully changed their password ".
403: "on $server.");
404: } elsif ($answer =~ "^pwchange_failure") {
405: &logthis("$uname in $udom was unable to change their password ".
406: "on $server. The action was blocked by either lcpasswd ".
407: "or pwchange");
408: } elsif ($answer =~ "^non_authorized") {
409: &logthis("$uname in $udom did not get their password correct when ".
410: "attempting to change it on $server.");
411: } elsif ($answer =~ "^auth_mode_error") {
412: &logthis("$uname in $udom attempted to change their password despite ".
413: "not being locally or internally authenticated on $server.");
414: } elsif ($answer =~ "^unknown_user") {
415: &logthis("$uname in $udom attempted to change their password ".
416: "on $server but were unable to because $server is not ".
417: "their home server.");
418: } elsif ($answer =~ "^refused") {
419: &logthis("$server refused to change $uname in $udom password because ".
420: "it was sent an unencrypted request to change the password.");
421: }
422: return $answer;
423: }
424:
425: # ----------------------- Try to determine user's current authentication scheme
426:
427: sub queryauthenticate {
428: my ($uname,$udom)=@_;
429: if (($perlvar{'lonRole'} eq 'library') &&
430: ($udom eq $perlvar{'lonDefDomain'})) {
431: my $answer=reply("encrypt:currentauth:$udom:$uname",
432: $perlvar{'lonHostID'});
433: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
434: if (length($answer)) {
435: return $answer;
436: }
437: else {
438: &logthis("User $uname at $udom lacks an authentication mechanism");
439: return 'no_host';
440: }
441: }
442: }
443:
444: my $tryserver;
445: foreach $tryserver (keys %libserv) {
446: if ($hostdom{$tryserver} eq $udom) {
447: my $answer=reply("encrypt:currentauth:$udom:$uname",$tryserver);
448: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
449: if (length($answer)) {
450: return $answer;
451: }
452: else {
453: &logthis("User $uname at $udom lacks an authentication mechanism");
454: return 'no_host';
455: }
456: }
457: }
458: }
459: &logthis("User $uname at $udom lacks an authentication mechanism");
460: return 'no_host';
461: }
462:
463: # --------- Try to authenticate user from domain's lib servers (first this one)
464:
465: sub authenticate {
466: my ($uname,$upass,$udom)=@_;
467: $upass=escape($upass);
468: $uname=~s/\W//g;
469: if (($perlvar{'lonRole'} eq 'library') &&
470: ($udom eq $perlvar{'lonDefDomain'})) {
471: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
472: if ($answer =~ /authorized/) {
473: if ($answer eq 'authorized') {
474: &logthis("User $uname at $udom authorized by local server");
475: return $perlvar{'lonHostID'};
476: }
477: if ($answer eq 'non_authorized') {
478: &logthis("User $uname at $udom rejected by local server");
479: return 'no_host';
480: }
481: }
482: }
483:
484: my $tryserver;
485: foreach $tryserver (keys %libserv) {
486: if ($hostdom{$tryserver} eq $udom) {
487: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
488: if ($answer =~ /authorized/) {
489: if ($answer eq 'authorized') {
490: &logthis("User $uname at $udom authorized by $tryserver");
491: return $tryserver;
492: }
493: if ($answer eq 'non_authorized') {
494: &logthis("User $uname at $udom rejected by $tryserver");
495: return 'no_host';
496: }
497: }
498: }
499: }
500: &logthis("User $uname at $udom could not be authenticated");
501: return 'no_host';
502: }
503:
504: # ---------------------- Find the homebase for a user from domain's lib servers
505:
506: sub homeserver {
507: my ($uname,$udom,$ignoreBadCache)=@_;
508: my $index="$uname:$udom";
509: if ($homecache{$index}) {
510: return "$homecache{$index}";
511: }
512: my $tryserver;
513: foreach $tryserver (keys %libserv) {
514: next if ($ignoreBadCache ne 'true' &&
515: exists($badServerCache{$tryserver}));
516: if ($hostdom{$tryserver} eq $udom) {
517: my $answer=reply("home:$udom:$uname",$tryserver);
518: if ($answer eq 'found') {
519: $homecache{$index}=$tryserver;
520: return $tryserver;
521: } elsif ($answer eq 'no_host') {
522: $badServerCache{$tryserver}=1;
523: }
524: }
525: }
526: return 'no_host';
527: }
528:
529: # ------------------------------------- Find the usernames behind a list of IDs
530:
531: sub idget {
532: my ($udom,@ids)=@_;
533: my %returnhash=();
534:
535: my $tryserver;
536: foreach $tryserver (keys %libserv) {
537: if ($hostdom{$tryserver} eq $udom) {
538: my $idlist=join('&',@ids);
539: $idlist=~tr/A-Z/a-z/;
540: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
541: my @answer=();
542: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
543: @answer=split(/\&/,$reply);
544: } ;
545: my $i;
546: for ($i=0;$i<=$#ids;$i++) {
547: if ($answer[$i]) {
548: $returnhash{$ids[$i]}=$answer[$i];
549: }
550: }
551: }
552: }
553: return %returnhash;
554: }
555:
556: # ------------------------------------- Find the IDs behind a list of usernames
557:
558: sub idrget {
559: my ($udom,@unames)=@_;
560: my %returnhash=();
561: foreach (@unames) {
562: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
563: }
564: return %returnhash;
565: }
566:
567: # ------------------------------- Store away a list of names and associated IDs
568:
569: sub idput {
570: my ($udom,%ids)=@_;
571: my %servers=();
572: foreach (keys %ids) {
573: my $uhom=&homeserver($_,$udom);
574: if ($uhom ne 'no_host') {
575: my $id=&escape($ids{$_});
576: $id=~tr/A-Z/a-z/;
577: my $unam=&escape($_);
578: if ($servers{$uhom}) {
579: $servers{$uhom}.='&'.$id.'='.$unam;
580: } else {
581: $servers{$uhom}=$id.'='.$unam;
582: }
583: &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
584: }
585: }
586: foreach (keys %servers) {
587: &critical('idput:'.$udom.':'.$servers{$_},$_);
588: }
589: }
590:
591: # ------------------------------------- Find the section of student in a course
592:
593: sub getsection {
594: my ($udom,$unam,$courseid)=@_;
595: $courseid=~s/\_/\//g;
596: $courseid=~s/^(\w)/\/$1/;
597: my %Pending;
598: my %Expired;
599: #
600: # Each role can either have not started yet (pending), be active,
601: # or have expired.
602: #
603: # If there is an active role, we are done.
604: #
605: # If there is more than one role which has not started yet,
606: # choose the one which will start sooner
607: # If there is one role which has not started yet, return it.
608: #
609: # If there is more than one expired role, choose the one which ended last.
610: # If there is a role which has expired, return it.
611: #
612: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
613: &homeserver($unam,$udom)))) {
614: my ($key,$value)=split(/\=/,$_);
615: $key=&unescape($key);
616: next if ($key !~/^$courseid(?:\/)*(\w+)*\_st$/);
617: my $section=$1;
618: if ($key eq $courseid.'_st') { $section=''; }
619: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
620: my $now=time;
621: if (defined($end) && ($now > $end)) {
622: $Expired{$end}=$section;
623: next;
624: }
625: if (defined($start) && ($now < $start)) {
626: $Pending{$start}=$section;
627: next;
628: }
629: return $section;
630: }
631: #
632: # Presumedly there will be few matching roles from the above
633: # loop and the sorting time will be negligible.
634: if (scalar(keys(%Pending))) {
635: my ($time) = sort {$a <=> $b} keys(%Pending);
636: return $Pending{$time};
637: }
638: if (scalar(keys(%Expired))) {
639: my @sorted = sort {$a <=> $b} keys(%Expired);
640: my $time = pop(@sorted);
641: return $Expired{$time};
642: }
643: return '-1';
644: }
645:
646: sub usection {
647: my ($udom,$unam,$courseid)=@_;
648: $courseid=~s/\_/\//g;
649: $courseid=~s/^(\w)/\/$1/;
650: foreach (split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
651: &homeserver($unam,$udom)))) {
652: my ($key,$value)=split(/\=/,$_);
653: $key=&unescape($key);
654: if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
655: my $section=$1;
656: if ($key eq $courseid.'_st') { $section=''; }
657: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
658: my $now=time;
659: my $notactive=0;
660: if ($start) {
661: if ($now<$start) { $notactive=1; }
662: }
663: if ($end) {
664: if ($now>$end) { $notactive=1; }
665: }
666: unless ($notactive) { return $section; }
667: }
668: }
669: return '-1';
670: }
671:
672: # ------------------------------------- Read an entry from a user's environment
673:
674: sub userenvironment {
675: my ($udom,$unam,@what)=@_;
676: my %returnhash=();
677: my @answer=split(/\&/,
678: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
679: &homeserver($unam,$udom)));
680: my $i;
681: for ($i=0;$i<=$#what;$i++) {
682: $returnhash{$what[$i]}=&unescape($answer[$i]);
683: }
684: return %returnhash;
685: }
686:
687: # -------------------------------------------------------------------- New chat
688:
689: sub chatsend {
690: my ($newentry,$anon)=@_;
691: my $cnum=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
692: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
693: my $chome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
694: &reply('chatsend:'.$cdom.':'.$cnum.':'.
695: &escape($ENV{'user.domain'}.':'.$ENV{'user.name'}.':'.$anon.':'.
696: &escape($newentry)),$chome);
697: }
698:
699: # ------------------------------------------ Find current version of a resource
700:
701: sub getversion {
702: my $fname=&clutter(shift);
703: unless ($fname=~/^\/res\//) { return -1; }
704: return ¤tversion(&filelocation('',$fname));
705: }
706:
707: sub currentversion {
708: my $fname=shift;
709: my $author=$fname;
710: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
711: my ($udom,$uname)=split(/\//,$author);
712: my $home=homeserver($uname,$udom);
713: if ($home eq 'no_host') {
714: return -1;
715: }
716: my $answer=reply("currentversion:$fname",$home);
717: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
718: return -1;
719: }
720: return $answer;
721: }
722:
723: # ----------------------------- Subscribe to a resource, return URL if possible
724:
725: sub subscribe {
726: my $fname=shift;
727: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
728: my $author=$fname;
729: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
730: my ($udom,$uname)=split(/\//,$author);
731: my $home=homeserver($uname,$udom);
732: if ($home eq 'no_host') {
733: return 'not_found';
734: }
735: my $answer=reply("sub:$fname",$home);
736: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
737: $answer.=' by '.$home;
738: }
739: return $answer;
740: }
741:
742: # -------------------------------------------------------------- Replicate file
743:
744: sub repcopy {
745: my $filename=shift;
746: $filename=~s/\/+/\//g;
747: if ($filename=~/^\/home\/httpd\/html\/adm\//) { return OK; }
748: my $transname="$filename.in.transfer";
749: if ((-e $filename) || (-e $transname)) { return OK; }
750: my $remoteurl=subscribe($filename);
751: if ($remoteurl =~ /^con_lost by/) {
752: &logthis("Subscribe returned $remoteurl: $filename");
753: return HTTP_SERVICE_UNAVAILABLE;
754: } elsif ($remoteurl eq 'not_found') {
755: &logthis("Subscribe returned not_found: $filename");
756: return HTTP_NOT_FOUND;
757: } elsif ($remoteurl =~ /^rejected by/) {
758: &logthis("Subscribe returned $remoteurl: $filename");
759: return FORBIDDEN;
760: } elsif ($remoteurl eq 'directory') {
761: return OK;
762: } else {
763: my $author=$filename;
764: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
765: my ($udom,$uname)=split(/\//,$author);
766: my $home=homeserver($uname,$udom);
767: unless ($home eq $perlvar{'lonHostID'}) {
768: my @parts=split(/\//,$filename);
769: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
770: if ($path ne "$perlvar{'lonDocRoot'}/res") {
771: &logthis("Malconfiguration for replication: $filename");
772: return HTTP_BAD_REQUEST;
773: }
774: my $count;
775: for ($count=5;$count<$#parts;$count++) {
776: $path.="/$parts[$count]";
777: if ((-e $path)!=1) {
778: mkdir($path,0777);
779: }
780: }
781: my $ua=new LWP::UserAgent;
782: my $request=new HTTP::Request('GET',"$remoteurl");
783: my $response=$ua->request($request,$transname);
784: if ($response->is_error()) {
785: unlink($transname);
786: my $message=$response->status_line;
787: &logthis("<font color=blue>WARNING:"
788: ." LWP get: $message: $filename</font>");
789: return HTTP_SERVICE_UNAVAILABLE;
790: } else {
791: if ($remoteurl!~/\.meta$/) {
792: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
793: my $mresponse=$ua->request($mrequest,$filename.'.meta');
794: if ($mresponse->is_error()) {
795: unlink($filename.'.meta');
796: &logthis(
797: "<font color=yellow>INFO: No metadata: $filename</font>");
798: }
799: }
800: rename($transname,$filename);
801: return OK;
802: }
803: }
804: }
805: }
806:
807: # ------------------------------------------------ Get server side include body
808: sub ssi_body {
809: my $filelink=shift;
810: my $output=($filelink=~/^http\:/?&externalssi($filelink):
811: &ssi($filelink));
812: $output=~s/^.*\<body[^\>]*\>//si;
813: $output=~s/\<\/body\s*\>.*$//si;
814: $output=~
815: s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs;
816: return $output;
817: }
818:
819: # --------------------------------------------------------- Server Side Include
820:
821: sub ssi {
822:
823: my ($fn,%form)=@_;
824:
825: my $ua=new LWP::UserAgent;
826:
827: my $request;
828:
829: if (%form) {
830: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
831: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys %form));
832: } else {
833: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
834: }
835:
836: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
837: my $response=$ua->request($request);
838:
839: return $response->content;
840: }
841:
842: sub externalssi {
843: my ($url)=@_;
844: my $ua=new LWP::UserAgent;
845: my $request=new HTTP::Request('GET',$url);
846: my $response=$ua->request($request);
847: return $response->content;
848: }
849:
850: # ------- Add a token to a remote URI's query string to vouch for access rights
851:
852: sub tokenwrapper {
853: my $uri=shift;
854: $uri=~s/^http\:\/\/([^\/]+)//;
855: $uri=~s/^\///;
856: $ENV{'user.environment'}=~/\/([^\/]+)\.id/;
857: my $token=$1;
858: if ($uri=~/^uploaded\/([^\/]+)\/([^\/]+)\/([^\/]+)(\?\.*)*$/) {
859: &appenv('userfile.'.$1.'/'.$2.'/'.$3 => $ENV{'request.course.id'});
860: return 'http://'.$hostname{ &homeserver($2,$1)}.'/'.$uri.
861: (($uri=~/\?/)?'&':'?').'token='.$token.
862: '&tokenissued='.$perlvar{'lonHostID'};
863: } else {
864: return '/adm/notfound.html';
865: }
866: }
867:
868: # --------------- Take an uploaded file and put it into the userfiles directory
869: # input: name of form element, coursedoc=1 means this is for the course
870: # output: url of file in userspace
871:
872: sub userfileupload {
873: my ($formname,$coursedoc)=@_;
874: my $fname=$ENV{'form.'.$formname.'.filename'};
875: # Replace Windows backslashes by forward slashes
876: $fname=~s/\\/\//g;
877: # Get rid of everything but the actual filename
878: $fname=~s/^.*\/([^\/]+)$/$1/;
879: # Replace spaces by underscores
880: $fname=~s/\s+/\_/g;
881: # Replace all other weird characters by nothing
882: $fname=~s/[^\w\.\-]//g;
883: # See if there is anything left
884: unless ($fname) { return 'error: no uploaded file'; }
885: chop($ENV{'form.'.$formname});
886: # Create the directory if not present
887: my $docuname='';
888: my $docudom='';
889: my $docuhome='';
890: if ($coursedoc) {
891: $docuname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
892: $docudom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
893: $docuhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
894: } else {
895: $docuname=$ENV{'user.name'};
896: $docudom=$ENV{'user.domain'};
897: $docuhome=$ENV{'user.home'};
898: }
899: return
900: &finishuserfileupload($docuname,$docudom,$docuhome,$formname,$fname);
901: }
902:
903: sub finishuserfileupload {
904: my ($docuname,$docudom,$docuhome,$formname,$fname)=@_;
905: my $path=$docudom.'/'.$docuname.'/';
906: my $filepath=$perlvar{'lonDocRoot'};
907: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
908: my $count;
909: for ($count=4;$count<=$#parts;$count++) {
910: $filepath.="/$parts[$count]";
911: if ((-e $filepath)!=1) {
912: mkdir($filepath,0777);
913: }
914: }
915: # Save the file
916: {
917: my $fh=Apache::File->new('>'.$filepath.'/'.$fname);
918: print $fh $ENV{'form.'.$formname};
919: }
920: # Notify homeserver to grep it
921: #
922:
923: my $fetchresult=
924: &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$fname,$docuhome);
925: if ($fetchresult eq 'ok') {
926: #
927: # Return the URL to it
928: return '/uploaded/'.$path.$fname;
929: } else {
930: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$fname.
931: ' to host '.$docuhome.': '.$fetchresult);
932: return '/adm/notfound.html';
933: }
934: }
935:
936: # ------------------------------------------------------------------------- Log
937:
938: sub log {
939: my ($dom,$nam,$hom,$what)=@_;
940: return critical("log:$dom:$nam:$what",$hom);
941: }
942:
943: # ------------------------------------------------------------------ Course Log
944:
945: sub flushcourselogs {
946: &logthis('Flushing course log buffers');
947: foreach (keys %courselogs) {
948: my $crsid=$_;
949: if (&reply('log:'.$coursedombuf{$crsid}.':'.
950: &escape($courselogs{$crsid}),
951: $coursehombuf{$crsid}) eq 'ok') {
952: delete $courselogs{$crsid};
953: } else {
954: &logthis('Failed to flush log buffer for '.$crsid);
955: if (length($courselogs{$crsid})>40000) {
956: &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
957: " exceeded maximum size, deleting.</font>");
958: delete $courselogs{$crsid};
959: }
960: }
961: }
962: &logthis('Flushing access logs');
963: foreach (keys %accesshash) {
964: my $entry=$_;
965: $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
966: my %temphash=($entry => $accesshash{$entry});
967: if (&Apache::lonnet::put('nohist_resevaldata',\%temphash,$1,$2) eq 'ok') {
968: delete $accesshash{$entry};
969: }
970: }
971: $dumpcount++;
972: }
973:
974: sub courselog {
975: my $what=shift;
976: $what=time.':'.$what;
977: unless ($ENV{'request.course.id'}) { return ''; }
978: $coursedombuf{$ENV{'request.course.id'}}=
979: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'.
980: $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
981: $coursehombuf{$ENV{'request.course.id'}}=
982: $ENV{'course.'.$ENV{'request.course.id'}.'.home'};
983: if (defined $courselogs{$ENV{'request.course.id'}}) {
984: $courselogs{$ENV{'request.course.id'}}.='&'.$what;
985: } else {
986: $courselogs{$ENV{'request.course.id'}}.=$what;
987: }
988: if (length($courselogs{$ENV{'request.course.id'}})>4048) {
989: &flushcourselogs();
990: }
991: }
992:
993: sub courseacclog {
994: my $fnsymb=shift;
995: unless ($ENV{'request.course.id'}) { return ''; }
996: my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
997: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form)$/) {
998: $what.=':POST';
999: foreach (keys %ENV) {
1000: if ($_=~/^form\.(.*)/) {
1001: $what.=':'.$1.'='.$ENV{$_};
1002: }
1003: }
1004: }
1005: &courselog($what);
1006: }
1007:
1008: sub countacc {
1009: my $url=&declutter(shift);
1010: unless ($ENV{'request.course.id'}) { return ''; }
1011: $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
1012: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1013: if (defined($accesshash{$key})) {
1014: $accesshash{$key}++;
1015: } else {
1016: $accesshash{$key}=1;
1017: }
1018: }
1019:
1020: # ----------------------------------------------------------- Check out an item
1021:
1022: sub checkout {
1023: my ($symb,$tuname,$tudom,$tcrsid)=@_;
1024: my $now=time;
1025: my $lonhost=$perlvar{'lonHostID'};
1026: my $infostr=&escape(
1027: 'CHECKOUTTOKEN&'.
1028: $tuname.'&'.
1029: $tudom.'&'.
1030: $tcrsid.'&'.
1031: $symb.'&'.
1032: $now.'&'.$ENV{'REMOTE_ADDR'});
1033: my $token=&reply('tmpput:'.$infostr,$lonhost);
1034: if ($token=~/^error\:/) {
1035: &logthis("<font color=blue>WARNING: ".
1036: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
1037: "</font>");
1038: return '';
1039: }
1040:
1041: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
1042: $token=~tr/a-z/A-Z/;
1043:
1044: my %infohash=('resource.0.outtoken' => $token,
1045: 'resource.0.checkouttime' => $now,
1046: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1047:
1048: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1049: return '';
1050: } else {
1051: &logthis("<font color=blue>WARNING: ".
1052: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
1053: "</font>");
1054: }
1055:
1056: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1057: &escape('Checkout '.$infostr.' - '.
1058: $token)) ne 'ok') {
1059: return '';
1060: } else {
1061: &logthis("<font color=blue>WARNING: ".
1062: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
1063: "</font>");
1064: }
1065: return $token;
1066: }
1067:
1068: # ------------------------------------------------------------ Check in an item
1069:
1070: sub checkin {
1071: my $token=shift;
1072: my $now=time;
1073: my ($ta,$tb,$lonhost)=split(/\*/,$token);
1074: $lonhost=~tr/A-Z/a-z/;
1075: my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
1076: $dtoken=~s/\W/\_/g;
1077: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1078: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
1079:
1080: unless (($tuname) && ($tudom)) {
1081: &logthis('Check in '.$token.' ('.$dtoken.') failed');
1082: return '';
1083: }
1084:
1085: unless (&allowed('mgr',$tcrsid)) {
1086: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1087: $ENV{'user.name'}.' - '.$ENV{'user.domain'});
1088: return '';
1089: }
1090:
1091: my %infohash=('resource.0.intoken' => $token,
1092: 'resource.0.checkintime' => $now,
1093: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1094:
1095: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
1096: return '';
1097: }
1098:
1099: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
1100: &escape('Checkin - '.$token)) ne 'ok') {
1101: return '';
1102: }
1103:
1104: return ($symb,$tuname,$tudom,$tcrsid);
1105: }
1106:
1107: # --------------------------------------------- Set Expire Date for Spreadsheet
1108:
1109: sub expirespread {
1110: my ($uname,$udom,$stype,$usymb)=@_;
1111: my $cid=$ENV{'request.course.id'};
1112: if ($cid) {
1113: my $now=time;
1114: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1115: return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
1116: $ENV{'course.'.$cid.'.num'}.
1117: ':nohist_expirationdates:'.
1118: &escape($key).'='.$now,
1119: $ENV{'course.'.$cid.'.home'})
1120: }
1121: return 'ok';
1122: }
1123:
1124: # ----------------------------------------------------- Devalidate Spreadsheets
1125:
1126: sub devalidate {
1127: my ($symb,$uname,$udom)=@_;
1128: my $cid=$ENV{'request.course.id'};
1129: if ($cid) {
1130: # delete the stored spreadsheets for
1131: # - the student level sheet of this user in course's homespace
1132: # - the assessment level sheet for this resource
1133: # for this user in user's homespace
1134: my $key=$uname.':'.$udom.':';
1135: my $status=
1136: &del('nohist_calculatedsheets',
1137: [$key.'studentcalc'],
1138: $ENV{'course.'.$cid.'.domain'},
1139: $ENV{'course.'.$cid.'.num'})
1140: .' '.
1141: &del('nohist_calculatedsheets_'.$cid,
1142: [$key.'assesscalc:'.$symb]);
1143: unless ($status eq 'ok ok') {
1144: &logthis('Could not devalidate spreadsheet '.
1145: $uname.' at '.$udom.' for '.
1146: $symb.': '.$status);
1147: }
1148: }
1149: }
1150:
1151: sub get_scalar {
1152: my ($string,$end) = @_;
1153: my $value;
1154: if ($$string =~ s/^([^&]*?)($end)/$2/) {
1155: $value = $1;
1156: } elsif ($$string =~ s/^([^&]*?)&//) {
1157: $value = $1;
1158: }
1159: return &unescape($value);
1160: }
1161:
1162: sub array2str {
1163: my (@array) = @_;
1164: my $result=&arrayref2str(\@array);
1165: $result=~s/^__ARRAY_REF__//;
1166: $result=~s/__END_ARRAY_REF__$//;
1167: return $result;
1168: }
1169:
1170: sub arrayref2str {
1171: my ($arrayref) = @_;
1172: my $result='__ARRAY_REF__';
1173: foreach my $elem (@$arrayref) {
1174: if(ref($elem) eq 'ARRAY') {
1175: $result.=&arrayref2str($elem).'&';
1176: } elsif(ref($elem) eq 'HASH') {
1177: $result.=&hashref2str($elem).'&';
1178: } elsif(ref($elem)) {
1179: #print("Got a ref of ".(ref($elem))." skipping.");
1180: } else {
1181: $result.=&escape($elem).'&';
1182: }
1183: }
1184: $result=~s/\&$//;
1185: $result .= '__END_ARRAY_REF__';
1186: return $result;
1187: }
1188:
1189: sub hash2str {
1190: my (%hash) = @_;
1191: my $result=&hashref2str(\%hash);
1192: $result=~s/^__HASH_REF__//;
1193: $result=~s/__END_HASH_REF__$//;
1194: return $result;
1195: }
1196:
1197: sub hashref2str {
1198: my ($hashref)=@_;
1199: my $result='__HASH_REF__';
1200: foreach (keys(%$hashref)) {
1201: if (ref($_) eq 'ARRAY') {
1202: $result.=&arrayref2str($_).'=';
1203: } elsif (ref($_) eq 'HASH') {
1204: $result.=&hashref2str($_).'=';
1205: } elsif (ref($_)) {
1206: $result.='=';
1207: #print("Got a ref of ".(ref($_))." skipping.");
1208: } else {
1209: if ($_) {$result.=&escape($_).'=';} else { last; }
1210: }
1211:
1212: if(ref($hashref->{$_}) eq 'ARRAY') {
1213: $result.=&arrayref2str($hashref->{$_}).'&';
1214: } elsif(ref($hashref->{$_}) eq 'HASH') {
1215: $result.=&hashref2str($hashref->{$_}).'&';
1216: } elsif(ref($hashref->{$_})) {
1217: $result.='&';
1218: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
1219: } else {
1220: $result.=&escape($hashref->{$_}).'&';
1221: }
1222: }
1223: $result=~s/\&$//;
1224: $result .= '__END_HASH_REF__';
1225: return $result;
1226: }
1227:
1228: sub str2hash {
1229: my ($string)=@_;
1230: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
1231: return %$hash;
1232: }
1233:
1234: sub str2hashref {
1235: my ($string) = @_;
1236:
1237: my %hash;
1238:
1239: if($string !~ /^__HASH_REF__/) {
1240: if (! ($string eq '' || !defined($string))) {
1241: $hash{'error'}='Not hash reference';
1242: }
1243: return (\%hash, $string);
1244: }
1245:
1246: $string =~ s/^__HASH_REF__//;
1247:
1248: while($string !~ /^__END_HASH_REF__/) {
1249: #key
1250: my $key='';
1251: if($string =~ /^__HASH_REF__/) {
1252: ($key, $string)=&str2hashref($string);
1253: if(defined($key->{'error'})) {
1254: $hash{'error'}='Bad data';
1255: return (\%hash, $string);
1256: }
1257: } elsif($string =~ /^__ARRAY_REF__/) {
1258: ($key, $string)=&str2arrayref($string);
1259: if($key->[0] eq 'Array reference error') {
1260: $hash{'error'}='Bad data';
1261: return (\%hash, $string);
1262: }
1263: } else {
1264: $string =~ s/^(.*?)=//;
1265: $key=&unescape($1);
1266: }
1267: $string =~ s/^=//;
1268:
1269: #value
1270: my $value='';
1271: if($string =~ /^__HASH_REF__/) {
1272: ($value, $string)=&str2hashref($string);
1273: if(defined($value->{'error'})) {
1274: $hash{'error'}='Bad data';
1275: return (\%hash, $string);
1276: }
1277: } elsif($string =~ /^__ARRAY_REF__/) {
1278: ($value, $string)=&str2arrayref($string);
1279: if($value->[0] eq 'Array reference error') {
1280: $hash{'error'}='Bad data';
1281: return (\%hash, $string);
1282: }
1283: } else {
1284: $value=&get_scalar(\$string,'__END_HASH_REF__');
1285: }
1286: $string =~ s/^&//;
1287:
1288: $hash{$key}=$value;
1289: }
1290:
1291: $string =~ s/^__END_HASH_REF__//;
1292:
1293: return (\%hash, $string);
1294: }
1295:
1296: sub str2array {
1297: my ($string)=@_;
1298: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
1299: return @$array;
1300: }
1301:
1302: sub str2arrayref {
1303: my ($string) = @_;
1304: my @array;
1305:
1306: if($string !~ /^__ARRAY_REF__/) {
1307: if (! ($string eq '' || !defined($string))) {
1308: $array[0]='Array reference error';
1309: }
1310: return (\@array, $string);
1311: }
1312:
1313: $string =~ s/^__ARRAY_REF__//;
1314:
1315: while($string !~ /^__END_ARRAY_REF__/) {
1316: my $value='';
1317: if($string =~ /^__HASH_REF__/) {
1318: ($value, $string)=&str2hashref($string);
1319: if(defined($value->{'error'})) {
1320: $array[0] ='Array reference error';
1321: return (\@array, $string);
1322: }
1323: } elsif($string =~ /^__ARRAY_REF__/) {
1324: ($value, $string)=&str2arrayref($string);
1325: if($value->[0] eq 'Array reference error') {
1326: $array[0] ='Array reference error';
1327: return (\@array, $string);
1328: }
1329: } else {
1330: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
1331: }
1332: $string =~ s/^&//;
1333:
1334: push(@array, $value);
1335: }
1336:
1337: $string =~ s/^__END_ARRAY_REF__//;
1338:
1339: return (\@array, $string);
1340: }
1341:
1342: # -------------------------------------------------------------------Temp Store
1343:
1344: sub tmpreset {
1345: my ($symb,$namespace,$domain,$stuname) = @_;
1346: if (!$symb) {
1347: $symb=&symbread();
1348: if (!$symb) { $symb= $ENV{'REQUEST_URI'}; }
1349: }
1350: $symb=escape($symb);
1351:
1352: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1353: $namespace=~s/\//\_/g;
1354: $namespace=~s/\W//g;
1355:
1356: #FIXME needs to do something for /pub resources
1357: if (!$domain) { $domain=$ENV{'user.domain'}; }
1358: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1359: my $path=$perlvar{'lonDaemons'}.'/tmp';
1360: my %hash;
1361: if (tie(%hash,'GDBM_File',
1362: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1363: &GDBM_WRCREAT(),0640)) {
1364: foreach my $key (keys %hash) {
1365: if ($key=~ /:$symb/) {
1366: delete($hash{$key});
1367: }
1368: }
1369: }
1370: }
1371:
1372: sub tmpstore {
1373: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1374:
1375: if (!$symb) {
1376: $symb=&symbread();
1377: if (!$symb) { $symb= $ENV{'request.url'}; }
1378: }
1379: $symb=escape($symb);
1380:
1381: if (!$namespace) {
1382: # I don't think we would ever want to store this for a course.
1383: # it seems this will only be used if we don't have a course.
1384: #$namespace=$ENV{'request.course.id'};
1385: #if (!$namespace) {
1386: $namespace=$ENV{'request.state'};
1387: #}
1388: }
1389: $namespace=~s/\//\_/g;
1390: $namespace=~s/\W//g;
1391: #FIXME needs to do something for /pub resources
1392: if (!$domain) { $domain=$ENV{'user.domain'}; }
1393: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1394: my $now=time;
1395: my %hash;
1396: my $path=$perlvar{'lonDaemons'}.'/tmp';
1397: if (tie(%hash,'GDBM_File',
1398: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1399: &GDBM_WRCREAT(),0640)) {
1400: $hash{"version:$symb"}++;
1401: my $version=$hash{"version:$symb"};
1402: my $allkeys='';
1403: foreach my $key (keys(%$storehash)) {
1404: $allkeys.=$key.':';
1405: $hash{"$version:$symb:$key"}=$$storehash{$key};
1406: }
1407: $hash{"$version:$symb:timestamp"}=$now;
1408: $allkeys.='timestamp';
1409: $hash{"$version:keys:$symb"}=$allkeys;
1410: if (untie(%hash)) {
1411: return 'ok';
1412: } else {
1413: return "error:$!";
1414: }
1415: } else {
1416: return "error:$!";
1417: }
1418: }
1419:
1420: # -----------------------------------------------------------------Temp Restore
1421:
1422: sub tmprestore {
1423: my ($symb,$namespace,$domain,$stuname) = @_;
1424:
1425: if (!$symb) {
1426: $symb=&symbread();
1427: if (!$symb) { $symb= $ENV{'request.url'}; }
1428: }
1429: $symb=escape($symb);
1430:
1431: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1432: #FIXME needs to do something for /pub resources
1433: if (!$domain) { $domain=$ENV{'user.domain'}; }
1434: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1435:
1436: my %returnhash;
1437: $namespace=~s/\//\_/g;
1438: $namespace=~s/\W//g;
1439: my %hash;
1440: my $path=$perlvar{'lonDaemons'}.'/tmp';
1441: if (tie(%hash,'GDBM_File',
1442: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1443: &GDBM_READER(),0640)) {
1444: my $version=$hash{"version:$symb"};
1445: $returnhash{'version'}=$version;
1446: my $scope;
1447: for ($scope=1;$scope<=$version;$scope++) {
1448: my $vkeys=$hash{"$scope:keys:$symb"};
1449: my @keys=split(/:/,$vkeys);
1450: my $key;
1451: $returnhash{"$scope:keys"}=$vkeys;
1452: foreach $key (@keys) {
1453: $returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
1454: $returnhash{"$key"}=$hash{"$scope:$symb:$key"};
1455: }
1456: }
1457: if (!(untie(%hash))) {
1458: return "error:$!";
1459: }
1460: } else {
1461: return "error:$!";
1462: }
1463: return %returnhash;
1464: }
1465:
1466: # ----------------------------------------------------------------------- Store
1467:
1468: sub store {
1469: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1470: my $home='';
1471:
1472: if ($stuname) { $home=&homeserver($stuname,$domain); }
1473:
1474: $symb=&symbclean($symb);
1475: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1476:
1477: if (!$domain) { $domain=$ENV{'user.domain'}; }
1478: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1479:
1480: &devalidate($symb,$stuname,$domain);
1481:
1482: $symb=escape($symb);
1483: if (!$namespace) {
1484: unless ($namespace=$ENV{'request.course.id'}) {
1485: return '';
1486: }
1487: }
1488: if (!$home) { $home=$ENV{'user.home'}; }
1489: my $namevalue='';
1490: foreach (keys %$storehash) {
1491: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1492: }
1493: $namevalue=~s/\&$//;
1494: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1495: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1496: }
1497:
1498: # -------------------------------------------------------------- Critical Store
1499:
1500: sub cstore {
1501: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1502: my $home='';
1503:
1504: if ($stuname) { $home=&homeserver($stuname,$domain); }
1505:
1506: $symb=&symbclean($symb);
1507: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1508:
1509: if (!$domain) { $domain=$ENV{'user.domain'}; }
1510: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1511:
1512: &devalidate($symb,$stuname,$domain);
1513:
1514: $symb=escape($symb);
1515: if (!$namespace) {
1516: unless ($namespace=$ENV{'request.course.id'}) {
1517: return '';
1518: }
1519: }
1520: if (!$home) { $home=$ENV{'user.home'}; }
1521:
1522: my $namevalue='';
1523: foreach (keys %$storehash) {
1524: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1525: }
1526: $namevalue=~s/\&$//;
1527: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1528: return critical
1529: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1530: }
1531:
1532: # --------------------------------------------------------------------- Restore
1533:
1534: sub restore {
1535: my ($symb,$namespace,$domain,$stuname) = @_;
1536: my $home='';
1537:
1538: if ($stuname) { $home=&homeserver($stuname,$domain); }
1539:
1540: if (!$symb) {
1541: unless ($symb=escape(&symbread())) { return ''; }
1542: } else {
1543: $symb=&escape(&symbclean($symb));
1544: }
1545: if (!$namespace) {
1546: unless ($namespace=$ENV{'request.course.id'}) {
1547: return '';
1548: }
1549: }
1550: if (!$domain) { $domain=$ENV{'user.domain'}; }
1551: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1552: if (!$home) { $home=$ENV{'user.home'}; }
1553: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
1554:
1555: my %returnhash=();
1556: foreach (split(/\&/,$answer)) {
1557: my ($name,$value)=split(/\=/,$_);
1558: $returnhash{&unescape($name)}=&unescape($value);
1559: }
1560: my $version;
1561: for ($version=1;$version<=$returnhash{'version'};$version++) {
1562: foreach (split(/\:/,$returnhash{$version.':keys'})) {
1563: $returnhash{$_}=$returnhash{$version.':'.$_};
1564: }
1565: }
1566: return %returnhash;
1567: }
1568:
1569: # ---------------------------------------------------------- Course Description
1570:
1571: sub coursedescription {
1572: my $courseid=shift;
1573: $courseid=~s/^\///;
1574: $courseid=~s/\_/\//g;
1575: my ($cdomain,$cnum)=split(/\//,$courseid);
1576: my $chome=&homeserver($cnum,$cdomain);
1577: my $normalid=$cdomain.'_'.$cnum;
1578: # need to always cache even if we get errors otherwise we keep
1579: # trying and trying and trying to get the course description.
1580: my %envhash=();
1581: my %returnhash=();
1582: $envhash{'course.'.$normalid.'.last_cache'}=time;
1583: if ($chome ne 'no_host') {
1584: %returnhash=&dump('environment',$cdomain,$cnum);
1585: if (!exists($returnhash{'con_lost'})) {
1586: $returnhash{'home'}= $chome;
1587: $returnhash{'domain'} = $cdomain;
1588: $returnhash{'num'} = $cnum;
1589: while (my ($name,$value) = each %returnhash) {
1590: $envhash{'course.'.$normalid.'.'.$name}=$value;
1591: }
1592: $returnhash{'url'}=&clutter($returnhash{'url'});
1593: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1594: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1595: $envhash{'course.'.$normalid.'.home'}=$chome;
1596: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
1597: $envhash{'course.'.$normalid.'.num'}=$cnum;
1598: }
1599: }
1600: &appenv(%envhash);
1601: return %returnhash;
1602: }
1603:
1604: # -------------------------------------------------------- Get user privileges
1605:
1606: sub rolesinit {
1607: my ($domain,$username,$authhost)=@_;
1608: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1609: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1610: my %allroles=();
1611: my %thesepriv=();
1612: my $now=time;
1613: my $userroles="user.login.time=$now\n";
1614: my $thesestr;
1615:
1616: if ($rolesdump ne '') {
1617: foreach (split(/&/,$rolesdump)) {
1618: if ($_!~/^rolesdef\&/) {
1619: my ($area,$role)=split(/=/,$_);
1620: $area=~s/\_\w\w$//;
1621: my ($trole,$tend,$tstart)=split(/_/,$role);
1622: $userroles.='user.role.'.$trole.'.'.$area.'='.
1623: $tstart.'.'.$tend."\n";
1624: if ($tend!=0) {
1625: if ($tend<$now) {
1626: $trole='';
1627: }
1628: }
1629: if ($tstart!=0) {
1630: if ($tstart>$now) {
1631: $trole='';
1632: }
1633: }
1634: if (($area ne '') && ($trole ne '')) {
1635: my $spec=$trole.'.'.$area;
1636: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
1637: if ($trole =~ /^cr\//) {
1638: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1639: my $homsvr=homeserver($rauthor,$rdomain);
1640: if ($hostname{$homsvr} ne '') {
1641: my $roledef=
1642: reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
1643: $homsvr);
1644: if (($roledef ne 'con_lost') && ($roledef ne '')) {
1645: my ($syspriv,$dompriv,$coursepriv)=
1646: split(/\_/,unescape($roledef));
1647: $allroles{'cm./'}.=':'.$syspriv;
1648: $allroles{$spec.'./'}.=':'.$syspriv;
1649: if ($tdomain ne '') {
1650: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
1651: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
1652: if ($trest ne '') {
1653: $allroles{'cm.'.$area}.=':'.$coursepriv;
1654: $allroles{$spec.'.'.$area}.=':'.$coursepriv;
1655: }
1656: }
1657: }
1658: }
1659: } else {
1660: $allroles{'cm./'}.=':'.$pr{$trole.':s'};
1661: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
1662: if ($tdomain ne '') {
1663: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1664: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1665: if ($trest ne '') {
1666: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
1667: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
1668: }
1669: }
1670: }
1671: }
1672: }
1673: }
1674: my $adv=0;
1675: my $author=0;
1676: foreach (keys %allroles) {
1677: %thesepriv=();
1678: if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
1679: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
1680: foreach (split(/:/,$allroles{$_})) {
1681: if ($_ ne '') {
1682: my ($privilege,$restrictions)=split(/&/,$_);
1683: if ($restrictions eq '') {
1684: $thesepriv{$privilege}='F';
1685: } else {
1686: if ($thesepriv{$privilege} ne 'F') {
1687: $thesepriv{$privilege}.=$restrictions;
1688: }
1689: }
1690: }
1691: }
1692: $thesestr='';
1693: foreach (keys %thesepriv) { $thesestr.=':'.$_.'&'.$thesepriv{$_}; }
1694: $userroles.='user.priv.'.$_.'='.$thesestr."\n";
1695: }
1696: $userroles.='user.adv='.$adv."\n".
1697: 'user.author='.$author."\n";
1698: $ENV{'user.adv'}=$adv;
1699: }
1700: return $userroles;
1701: }
1702:
1703: # --------------------------------------------------------------- get interface
1704:
1705: sub get {
1706: my ($namespace,$storearr,$udomain,$uname)=@_;
1707: my $items='';
1708: foreach (@$storearr) {
1709: $items.=escape($_).'&';
1710: }
1711: $items=~s/\&$//;
1712: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1713: if (!$uname) { $uname=$ENV{'user.name'}; }
1714: my $uhome=&homeserver($uname,$udomain);
1715:
1716: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1717: my @pairs=split(/\&/,$rep);
1718: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1719: return @pairs;
1720: }
1721: my %returnhash=();
1722: my $i=0;
1723: foreach (@$storearr) {
1724: $returnhash{$_}=unescape($pairs[$i]);
1725: $i++;
1726: }
1727: return %returnhash;
1728: }
1729:
1730: # --------------------------------------------------------------- del interface
1731:
1732: sub del {
1733: my ($namespace,$storearr,$udomain,$uname)=@_;
1734: my $items='';
1735: foreach (@$storearr) {
1736: $items.=escape($_).'&';
1737: }
1738: $items=~s/\&$//;
1739: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1740: if (!$uname) { $uname=$ENV{'user.name'}; }
1741: my $uhome=&homeserver($uname,$udomain);
1742:
1743: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1744: }
1745:
1746: # -------------------------------------------------------------- dump interface
1747:
1748: sub dump {
1749: my ($namespace,$udomain,$uname,$regexp)=@_;
1750: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1751: if (!$uname) { $uname=$ENV{'user.name'}; }
1752: my $uhome=&homeserver($uname,$udomain);
1753: if ($regexp) {
1754: $regexp=&escape($regexp);
1755: } else {
1756: $regexp='.';
1757: }
1758: my $rep=reply("dump:$udomain:$uname:$namespace:$regexp",$uhome);
1759: my @pairs=split(/\&/,$rep);
1760: my %returnhash=();
1761: foreach (@pairs) {
1762: my ($key,$value)=split(/=/,$_);
1763: $returnhash{unescape($key)}=unescape($value);
1764: }
1765: return %returnhash;
1766: }
1767:
1768: # --------------------------------------------------------------- currentdump
1769: sub currentdump {
1770: my ($courseid,$sdom,$sname)=@_;
1771: $courseid = $ENV{'request.course.id'} if (! defined($courseid));
1772: $sdom = $ENV{'user.domain'} if (! defined($sdom));
1773: $sname = $ENV{'user.name'} if (! defined($sname));
1774: my $uhome = &homeserver($sname,$sdom);
1775: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1776: return if ($rep =~ /^(error:|no_such_host)/);
1777: #
1778: my %returnhash=();
1779: #
1780: if ($rep eq "unknown_cmd") {
1781: # an old lond will not know currentdump
1782: # Do a dump and make it look like a currentdump
1783: my @tmp = &dump($courseid,$sdom,$sname,'.');
1784: return if ($tmp[0] =~ /^(error:|no_such_host)/);
1785: my %hash = @tmp;
1786: @tmp=();
1787: # Code ripped from lond, essentially. The only difference
1788: # here is the unescaping done by lonnet::dump(). Conceivably
1789: # we might run in to problems with parameter names =~ /^v\./
1790: while (my ($key,$value) = each(%hash)) {
1791: my ($v,$symb,$param) = split(/:/,$key);
1792: next if ($v eq 'version' || $symb eq 'keys');
1793: next if (exists($returnhash{$symb}) &&
1794: exists($returnhash{$symb}->{$param}) &&
1795: $returnhash{$symb}->{'v.'.$param} > $v);
1796: $returnhash{$symb}->{$param}=$value;
1797: $returnhash{$symb}->{'v.'.$param}=$v;
1798: }
1799: #
1800: # Remove all of the keys in the hashes which keep track of
1801: # the version of the parameter.
1802: while (my ($symb,$param_hash) = each(%returnhash)) {
1803: # use a foreach because we are going to delete from the hash.
1804: foreach my $key (keys(%$param_hash)) {
1805: delete($param_hash->{$key}) if ($key =~ /^v\./);
1806: }
1807: }
1808: } else {
1809: my @pairs=split(/\&/,$rep);
1810: foreach (@pairs) {
1811: my ($key,$value)=split(/=/,$_);
1812: my ($symb,$param) = split(/:/,$key);
1813: $returnhash{&unescape($symb)}->{&unescape($param)} =
1814: &unescape($value);
1815: }
1816: }
1817: return %returnhash;
1818: }
1819:
1820: # --------------------------------------------------------------- put interface
1821:
1822: sub put {
1823: my ($namespace,$storehash,$udomain,$uname)=@_;
1824: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1825: if (!$uname) { $uname=$ENV{'user.name'}; }
1826: my $uhome=&homeserver($uname,$udomain);
1827: my $items='';
1828: foreach (keys %$storehash) {
1829: $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
1830: }
1831: $items=~s/\&$//;
1832: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1833: }
1834:
1835: # ------------------------------------------------------ critical put interface
1836:
1837: sub cput {
1838: my ($namespace,$storehash,$udomain,$uname)=@_;
1839: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1840: if (!$uname) { $uname=$ENV{'user.name'}; }
1841: my $uhome=&homeserver($uname,$udomain);
1842: my $items='';
1843: foreach (keys %$storehash) {
1844: $items.=escape($_).'='.escape($$storehash{$_}).'&';
1845: }
1846: $items=~s/\&$//;
1847: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1848: }
1849:
1850: # -------------------------------------------------------------- eget interface
1851:
1852: sub eget {
1853: my ($namespace,$storearr,$udomain,$uname)=@_;
1854: my $items='';
1855: foreach (@$storearr) {
1856: $items.=escape($_).'&';
1857: }
1858: $items=~s/\&$//;
1859: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1860: if (!$uname) { $uname=$ENV{'user.name'}; }
1861: my $uhome=&homeserver($uname,$udomain);
1862: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1863: my @pairs=split(/\&/,$rep);
1864: my %returnhash=();
1865: my $i=0;
1866: foreach (@$storearr) {
1867: $returnhash{$_}=unescape($pairs[$i]);
1868: $i++;
1869: }
1870: return %returnhash;
1871: }
1872:
1873: # ---------------------------------------------- Custom access rule evaluation
1874:
1875: sub customaccess {
1876: my ($priv,$uri)=@_;
1877: my $access=0;
1878: foreach (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1879: my ($effect,$realm,$content)=split(/\:/,$_);
1880: &logthis('testing '.$effect.' '.$realm.' '.$content);
1881: }
1882: return $access;
1883: }
1884:
1885: # ------------------------------------------------- Check for a user privilege
1886:
1887: sub allowed {
1888: my ($priv,$uri)=@_;
1889:
1890: my $orguri=$uri;
1891: $uri=&declutter($uri);
1892:
1893: # Free bre access to adm and meta resources
1894:
1895: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1896: return 'F';
1897: }
1898:
1899: # Free bre to public access
1900:
1901: if ($priv eq 'bre') {
1902: my $copyright=&metadata($uri,'copyright');
1903: if (($copyright eq 'public') && (!$ENV{'request.course.id'})) {
1904: return 'F';
1905: }
1906: if ($copyright eq 'priv') {
1907: $uri=~/([^\/]+)\/([^\/]+)\//;
1908: unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
1909: return '';
1910: }
1911: }
1912: if ($copyright eq 'domain') {
1913: $uri=~/([^\/]+)\/([^\/]+)\//;
1914: unless (($ENV{'user.domain'} eq $1) ||
1915: ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
1916: return '';
1917: }
1918: }
1919: if ($ENV{'request.role'}=~ /li\.\//) {
1920: # Library role, so allow browsing of resources in this domain.
1921: return 'F';
1922: }
1923: if ($copyright eq 'custom') {
1924: unless (&customaccess($priv,$uri)) { return ''; }
1925: }
1926: }
1927: # Domain coordinator is trying to create a course
1928: if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
1929: # uri is the requested domain in this case.
1930: # comparison to 'request.role.domain' shows if the user has selected
1931: # a role of dc for the domain in question.
1932: return 'F' if ($uri eq $ENV{'request.role.domain'});
1933: }
1934:
1935: my $thisallowed='';
1936: my $statecond=0;
1937: my $courseprivid='';
1938:
1939: # Course
1940:
1941: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
1942: $thisallowed.=$1;
1943: }
1944:
1945: # Domain
1946:
1947: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1948: =~/$priv\&([^\:]*)/) {
1949: $thisallowed.=$1;
1950: }
1951:
1952: # Course: uri itself is a course
1953: my $courseuri=$uri;
1954: $courseuri=~s/\_(\d)/\/$1/;
1955: $courseuri=~s/^([^\/])/\/$1/;
1956:
1957: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
1958: =~/$priv\&([^\:]*)/) {
1959: $thisallowed.=$1;
1960: }
1961:
1962: # URI is an uploaded document for this course
1963:
1964: if (($priv eq 'bre') &&
1965: ($uri=~/^uploaded\/$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}\/$ENV{'course.'.$ENV{'request.course.id'}.'.num'}/)) {
1966: return 'F';
1967: }
1968: # Full access at system, domain or course-wide level? Exit.
1969:
1970: if ($thisallowed=~/F/) {
1971: return 'F';
1972: }
1973:
1974: # If this is generating or modifying users, exit with special codes
1975:
1976: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
1977: return $thisallowed;
1978: }
1979: #
1980: # Gathered so far: system, domain and course wide privileges
1981: #
1982: # Course: See if uri or referer is an individual resource that is part of
1983: # the course
1984:
1985: if ($ENV{'request.course.id'}) {
1986:
1987: $courseprivid=$ENV{'request.course.id'};
1988: if ($ENV{'request.course.sec'}) {
1989: $courseprivid.='/'.$ENV{'request.course.sec'};
1990: }
1991: $courseprivid=~s/\_/\//;
1992: my $checkreferer=1;
1993: my ($match,$cond)=&is_on_map($uri);
1994: if ($match) {
1995: $statecond=$cond;
1996: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1997: =~/$priv\&([^\:]*)/) {
1998: $thisallowed.=$1;
1999: $checkreferer=0;
2000: }
2001: }
2002:
2003: if ($checkreferer) {
2004: my $refuri=$ENV{'httpref.'.$orguri};
2005: unless ($refuri) {
2006: foreach (keys %ENV) {
2007: if ($_=~/^httpref\..*\*/) {
2008: my $pattern=$_;
2009: $pattern=~s/^httpref\.\/res\///;
2010: $pattern=~s/\*/\[\^\/\]\+/g;
2011: $pattern=~s/\//\\\//g;
2012: if ($orguri=~/$pattern/) {
2013: $refuri=$ENV{$_};
2014: }
2015: }
2016: }
2017: }
2018:
2019: if ($refuri) {
2020: $refuri=&declutter($refuri);
2021: my ($match,$cond)=&is_on_map($refuri);
2022: if ($match) {
2023: my $refstatecond=$cond;
2024: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
2025: =~/$priv\&([^\:]*)/) {
2026: $thisallowed.=$1;
2027: $uri=$refuri;
2028: $statecond=$refstatecond;
2029: }
2030: }
2031: }
2032: }
2033: }
2034:
2035: #
2036: # Gathered now: all privileges that could apply, and condition number
2037: #
2038: #
2039: # Full or no access?
2040: #
2041:
2042: if ($thisallowed=~/F/) {
2043: return 'F';
2044: }
2045:
2046: unless ($thisallowed) {
2047: return '';
2048: }
2049:
2050: # Restrictions exist, deal with them
2051: #
2052: # C:according to course preferences
2053: # R:according to resource settings
2054: # L:unless locked
2055: # X:according to user session state
2056: #
2057:
2058: # Possibly locked functionality, check all courses
2059: # Locks might take effect only after 10 minutes cache expiration for other
2060: # courses, and 2 minutes for current course
2061:
2062: my $envkey;
2063: if ($thisallowed=~/L/) {
2064: foreach $envkey (keys %ENV) {
2065: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
2066: my $courseid=$2;
2067: my $roleid=$1.'.'.$2;
2068: $courseid=~s/^\///;
2069: my $expiretime=600;
2070: if ($ENV{'request.role'} eq $roleid) {
2071: $expiretime=120;
2072: }
2073: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
2074: my $prefix='course.'.$cdom.'_'.$cnum.'.';
2075: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
2076: &coursedescription($courseid);
2077: }
2078: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
2079: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
2080: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
2081: &log($ENV{'user.domain'},$ENV{'user.name'},
2082: $ENV{'user.home'},
2083: 'Locked by res: '.$priv.' for '.$uri.' due to '.
2084: $cdom.'/'.$cnum.'/'.$csec.' expire '.
2085: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
2086: return '';
2087: }
2088: }
2089: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
2090: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
2091: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
2092: &log($ENV{'user.domain'},$ENV{'user.name'},
2093: $ENV{'user.home'},
2094: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
2095: $cdom.'/'.$cnum.'/'.$csec.' expire '.
2096: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
2097: return '';
2098: }
2099: }
2100: }
2101: }
2102: }
2103:
2104: #
2105: # Rest of the restrictions depend on selected course
2106: #
2107:
2108: unless ($ENV{'request.course.id'}) {
2109: return '1';
2110: }
2111:
2112: #
2113: # Now user is definitely in a course
2114: #
2115:
2116:
2117: # Course preferences
2118:
2119: if ($thisallowed=~/C/) {
2120: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
2121: my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
2122: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
2123: =~/$rolecode/) {
2124: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2125: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
2126: $ENV{'request.course.id'});
2127: return '';
2128: }
2129:
2130: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
2131: =~/$unamedom/) {
2132: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2133: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
2134: $ENV{'request.course.id'});
2135: return '';
2136: }
2137: }
2138:
2139: # Resource preferences
2140:
2141: if ($thisallowed=~/R/) {
2142: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
2143: if (&metadata($uri,'roledeny')=~/$rolecode/) {
2144: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2145: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
2146: return '';
2147: }
2148: }
2149:
2150: # Restricted by state or randomout?
2151:
2152: if ($thisallowed=~/X/) {
2153: if ($ENV{'acc.randomout'}) {
2154: my $symb=&symbread($uri,1);
2155: if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) {
2156: return '';
2157: }
2158: }
2159: if (&condval($statecond)) {
2160: return '2';
2161: } else {
2162: return '';
2163: }
2164: }
2165:
2166: return 'F';
2167: }
2168:
2169: # --------------------------------------------------- Is a resource on the map?
2170:
2171: sub is_on_map {
2172: my $uri=&declutter(shift);
2173: my @uriparts=split(/\//,$uri);
2174: my $filename=$uriparts[$#uriparts];
2175: my $pathname=$uri;
2176: $pathname=~s|/\Q$filename\E$||;
2177: $pathname=~s/^adm\/wrapper\///;
2178: #Trying to find the conditional for the file
2179: my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
2180: /\&\Q$filename\E\:([\d\|]+)\&/);
2181: if ($match) {
2182: return (1,$1);
2183: } else {
2184: return (0,0);
2185: }
2186: }
2187:
2188: # ----------------------------------------------------------------- Define Role
2189:
2190: sub definerole {
2191: if (allowed('mcr','/')) {
2192: my ($rolename,$sysrole,$domrole,$courole)=@_;
2193: foreach (split('/',$sysrole)) {
2194: my ($crole,$cqual)=split(/\&/,$_);
2195: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
2196: if ($pr{'cr:s'}=~/$crole\&/) {
2197: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
2198: return "refused:s:$crole&$cqual";
2199: }
2200: }
2201: }
2202: foreach (split('/',$domrole)) {
2203: my ($crole,$cqual)=split(/\&/,$_);
2204: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
2205: if ($pr{'cr:d'}=~/$crole\&/) {
2206: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
2207: return "refused:d:$crole&$cqual";
2208: }
2209: }
2210: }
2211: foreach (split('/',$courole)) {
2212: my ($crole,$cqual)=split(/\&/,$_);
2213: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
2214: if ($pr{'cr:c'}=~/$crole\&/) {
2215: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
2216: return "refused:c:$crole&$cqual";
2217: }
2218: }
2219: }
2220: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2221: "$ENV{'user.domain'}:$ENV{'user.name'}:".
2222: "rolesdef_$rolename=".
2223: escape($sysrole.'_'.$domrole.'_'.$courole);
2224: return reply($command,$ENV{'user.home'});
2225: } else {
2226: return 'refused';
2227: }
2228: }
2229:
2230: # ---------------- Make a metadata query against the network of library servers
2231:
2232: sub metadata_query {
2233: my ($query,$custom,$customshow,$server_array)=@_;
2234: my %rhash;
2235: my @server_list = (defined($server_array) ? @$server_array
2236: : keys(%libserv) );
2237: for my $server (@server_list) {
2238: unless ($custom or $customshow) {
2239: my $reply=&reply("querysend:".&escape($query),$server);
2240: $rhash{$server}=$reply;
2241: }
2242: else {
2243: my $reply=&reply("querysend:".&escape($query).':'.
2244: &escape($custom).':'.&escape($customshow),
2245: $server);
2246: $rhash{$server}=$reply;
2247: }
2248: }
2249: return \%rhash;
2250: }
2251:
2252: # ----------------------------------------- Send log queries and wait for reply
2253:
2254: sub log_query {
2255: my ($uname,$udom,$query,%filters)=@_;
2256: my $uhome=&homeserver($uname,$udom);
2257: if ($uhome eq 'no_host') { return 'error: no_host'; }
2258: my $uhost=$hostname{$uhome};
2259: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
2260: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
2261: $uhome);
2262: unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
2263: return get_query_reply($queryid);
2264: }
2265:
2266: sub get_query_reply {
2267: my $queryid=shift;
2268: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
2269: my $reply='';
2270: for (1..100) {
2271: sleep 2;
2272: if (-e $replyfile.'.end') {
2273: if (my $fh=Apache::File->new($replyfile)) {
2274: $reply.=<$fh>;
2275: $fh->close;
2276: } else { return 'error: reply_file_error'; }
2277: return &unescape($reply);
2278: }
2279: }
2280: return 'timeout:'.$queryid;
2281: }
2282:
2283: sub courselog_query {
2284: #
2285: # possible filters:
2286: # url: url or symb
2287: # username
2288: # domain
2289: # action: view, submit, grade
2290: # start: timestamp
2291: # end: timestamp
2292: #
2293: my (%filters)=@_;
2294: unless ($ENV{'request.course.id'}) { return 'no_course'; }
2295: if ($filters{'url'}) {
2296: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
2297: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
2298: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
2299: }
2300: my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
2301: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
2302: return &log_query($cname,$cdom,'courselog',%filters);
2303: }
2304:
2305: sub userlog_query {
2306: my ($uname,$udom,%filters)=@_;
2307: return &log_query($uname,$udom,'userlog',%filters);
2308: }
2309:
2310: # ------------------------------------------------------------------ Plain Text
2311:
2312: sub plaintext {
2313: my $short=shift;
2314: return $prp{$short};
2315: }
2316:
2317: # ----------------------------------------------------------------- Assign Role
2318:
2319: sub assignrole {
2320: my ($udom,$uname,$url,$role,$end,$start)=@_;
2321: my $mrole;
2322: if ($role =~ /^cr\//) {
2323: unless (&allowed('ccr',$url)) {
2324: &logthis('Refused custom assignrole: '.
2325: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2326: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2327: return 'refused';
2328: }
2329: $mrole='cr';
2330: } else {
2331: my $cwosec=$url;
2332: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
2333: unless (&allowed('c'.$role,$cwosec)) {
2334: &logthis('Refused assignrole: '.
2335: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2336: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2337: return 'refused';
2338: }
2339: $mrole=$role;
2340: }
2341: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2342: "$udom:$uname:$url".'_'."$mrole=$role";
2343: if ($end) { $command.='_'.$end; }
2344: if ($start) {
2345: if ($end) {
2346: $command.='_'.$start;
2347: } else {
2348: $command.='_0_'.$start;
2349: }
2350: }
2351: return &reply($command,&homeserver($uname,$udom));
2352: }
2353:
2354: # -------------------------------------------------- Modify user authentication
2355: # Overrides without validation
2356:
2357: sub modifyuserauth {
2358: my ($udom,$uname,$umode,$upass)=@_;
2359: my $uhome=&homeserver($uname,$udom);
2360: unless (&allowed('mau',$udom)) { return 'refused'; }
2361: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
2362: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2363: ' in domain '.$ENV{'request.role.domain'});
2364: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
2365: &escape($upass),$uhome);
2366: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
2367: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
2368: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2369: &log($udom,,$uname,$uhome,
2370: 'Authentication changed by '.$ENV{'user.domain'}.', '.
2371: $ENV{'user.name'}.', '.$umode.
2372: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2373: unless ($reply eq 'ok') {
2374: &logthis('Authentication mode error: '.$reply);
2375: return 'error: '.$reply;
2376: }
2377: return 'ok';
2378: }
2379:
2380: # --------------------------------------------------------------- Modify a user
2381:
2382: sub modifyuser {
2383: my ($udom, $uname, $uid,
2384: $umode, $upass, $first,
2385: $middle, $last, $gene,
2386: $forceid, $desiredhome)=@_;
2387: $udom=~s/\W//g;
2388: $uname=~s/\W//g;
2389: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
2390: $umode.', '.$first.', '.$middle.', '.
2391: $last.', '.$gene.'(forceid: '.$forceid.')'.
2392: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
2393: ' desiredhome not specified').
2394: ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2395: ' in domain '.$ENV{'request.role.domain'});
2396: my $uhome=&homeserver($uname,$udom,'true');
2397: # ----------------------------------------------------------------- Create User
2398: if (($uhome eq 'no_host') && ($umode) && ($upass)) {
2399: my $unhome='';
2400: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
2401: $unhome = $desiredhome;
2402: } elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
2403: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
2404: } else { # load balancing routine for determining $unhome
2405: my $tryserver;
2406: my $loadm=10000000;
2407: foreach $tryserver (keys %libserv) {
2408: if ($hostdom{$tryserver} eq $udom) {
2409: my $answer=reply('load',$tryserver);
2410: if (($answer=~/\d+/) && ($answer<$loadm)) {
2411: $loadm=$answer;
2412: $unhome=$tryserver;
2413: }
2414: }
2415: }
2416: }
2417: if (($unhome eq '') || ($unhome eq 'no_host')) {
2418: return 'error: unable to find a home server for '.$uname.
2419: ' in domain '.$udom;
2420: }
2421: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
2422: &escape($upass),$unhome);
2423: unless ($reply eq 'ok') {
2424: return 'error: '.$reply;
2425: }
2426: $uhome=&homeserver($uname,$udom,'true');
2427: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
2428: return 'error: verify home';
2429: }
2430: } # End of creation of new user
2431: # ---------------------------------------------------------------------- Add ID
2432: if ($uid) {
2433: $uid=~tr/A-Z/a-z/;
2434: my %uidhash=&idrget($udom,$uname);
2435: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
2436: && (!$forceid)) {
2437: unless ($uid eq $uidhash{$uname}) {
2438: return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
2439: }
2440: } else {
2441: &idput($udom,($uname => $uid));
2442: }
2443: }
2444: # -------------------------------------------------------------- Add names, etc
2445: my @tmp=&get('environment',
2446: ['firstname','middlename','lastname','generation'],
2447: $udom,$uname);
2448: my %names;
2449: if ($tmp[0] =~ m/^error:.*/) {
2450: %names=();
2451: } else {
2452: %names = @tmp;
2453: }
2454: if ($first) { $names{'firstname'} = $first; }
2455: if ($middle) { $names{'middlename'} = $middle; }
2456: if ($last) { $names{'lastname'} = $last; }
2457: if ($gene) { $names{'generation'} = $gene; }
2458: my $reply = &put('environment', \%names, $udom,$uname);
2459: if ($reply ne 'ok') { return 'error: '.$reply; }
2460: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
2461: $umode.', '.$first.', '.$middle.', '.
2462: $last.', '.$gene.' by '.
2463: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2464: return 'ok';
2465: }
2466:
2467: # -------------------------------------------------------------- Modify student
2468:
2469: sub modifystudent {
2470: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
2471: $end,$start,$forceid,$desiredhome)=@_;
2472: my $cid='';
2473: unless ($cid=$ENV{'request.course.id'}) {
2474: return 'not_in_class';
2475: }
2476: # --------------------------------------------------------------- Make the user
2477: my $reply=&modifyuser
2478: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
2479: $desiredhome);
2480: unless ($reply eq 'ok') { return $reply; }
2481: # This will cause &modify_student_enrollment to get the uid from the
2482: # students environment
2483: $uid = undef if (!$forceid);
2484: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,
2485: $last,$gene,$usec,$end,$start);
2486: return $reply;
2487: }
2488:
2489: sub modify_student_enrollment {
2490: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start) = @_;
2491: # Get the course id from the environment
2492: my $cid='';
2493: unless ($cid=$ENV{'request.course.id'}) {
2494: return 'not_in_class';
2495: }
2496: # Make sure the user exists
2497: my $uhome=&homeserver($uname,$udom);
2498: if (($uhome eq '') || ($uhome eq 'no_host')) {
2499: return 'error: no such user';
2500: }
2501: #
2502: # Get student data if we were not given enough information
2503: if (!defined($first) || $first eq '' ||
2504: !defined($last) || $last eq '' ||
2505: !defined($uid) || $uid eq '' ||
2506: !defined($middle) || $middle eq '' ||
2507: !defined($gene) || $gene eq '') {
2508: # They did not supply us with enough data to enroll the student, so
2509: # we need to pick up more information.
2510: my %tmp = &get('environment',
2511: ['firstname','middlename','lastname', 'generation','id']
2512: ,$udom,$uname);
2513:
2514: foreach (keys(%tmp)) {
2515: &logthis("key $_ = ".$tmp{$_});
2516: }
2517: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
2518: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
2519: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
2520: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
2521: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
2522: }
2523: my $fullname = &Apache::loncoursedata::ProcessFullName($last,$gene,
2524: $first,$middle);
2525: my $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
2526: $ENV{'course.'.$cid.'.num'}.':classlist:'.
2527: &escape($uname.':'.$udom).'='.
2528: &escape(join(':',$end,$start,$uid,$usec,$fullname)),
2529: $ENV{'course.'.$cid.'.home'});
2530: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
2531: return 'error: '.$reply;
2532: }
2533: # Add student role to user
2534: my $uurl='/'.$cid;
2535: $uurl=~s/\_/\//g;
2536: if ($usec) {
2537: $uurl.='/'.$usec;
2538: }
2539: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
2540: }
2541:
2542: # ------------------------------------------------- Write to course preferences
2543:
2544: sub writecoursepref {
2545: my ($courseid,%prefs)=@_;
2546: $courseid=~s/^\///;
2547: $courseid=~s/\_/\//g;
2548: my ($cdomain,$cnum)=split(/\//,$courseid);
2549: my $chome=homeserver($cnum,$cdomain);
2550: if (($chome eq '') || ($chome eq 'no_host')) {
2551: return 'error: no such course';
2552: }
2553: my $cstring='';
2554: foreach (keys %prefs) {
2555: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
2556: }
2557: $cstring=~s/\&$//;
2558: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
2559: }
2560:
2561: # ---------------------------------------------------------- Make/modify course
2562:
2563: sub createcourse {
2564: my ($udom,$description,$url,$course_server,$nonstandard)=@_;
2565: $url=&declutter($url);
2566: my $cid='';
2567: unless (&allowed('ccc',$udom)) {
2568: return 'refused';
2569: }
2570: # ------------------------------------------------------------------- Create ID
2571: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2572: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2573: # ----------------------------------------------- Make sure that does not exist
2574: my $uhome=&homeserver($uname,$udom,'true');
2575: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2576: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2577: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2578: $uhome=&homeserver($uname,$udom,'true');
2579: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2580: return 'error: unable to generate unique course-ID';
2581: }
2582: }
2583: # ------------------------------------------------ Check supplied server name
2584: $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
2585: if (! exists($libserv{$course_server})) {
2586: return 'error:bad server name '.$course_server;
2587: }
2588: # ------------------------------------------------------------- Make the course
2589: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
2590: $course_server);
2591: unless ($reply eq 'ok') { return 'error: '.$reply; }
2592: $uhome=&homeserver($uname,$udom,'true');
2593: if (($uhome eq '') || ($uhome eq 'no_host')) {
2594: return 'error: no such course';
2595: }
2596: # ----------------------------------------------------------------- Course made
2597: my $topurl=$url;
2598: unless ($nonstandard) {
2599: # ------------------------------------------ For standard courses, make top url
2600: my $mapurl=&clutter($url);
2601: if ($mapurl eq '/res/') { $mapurl=''; }
2602: $ENV{'form.initmap'}=(<<ENDINITMAP);
2603: <map>
2604: <resource id="1" type="start"></resource>
2605: <resource id="2" src="$mapurl"></resource>
2606: <resource id="3" type="finish"></resource>
2607: <link index="1" from="1" to="2"></link>
2608: <link index="2" from="2" to="3"></link>
2609: </map>
2610: ENDINITMAP
2611: $topurl=&declutter(
2612: &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence')
2613: );
2614: }
2615: # ----------------------------------------------------------- Write preferences
2616: &writecoursepref($udom.'_'.$uname,
2617: ('description' => $description,
2618: 'url' => $topurl));
2619: return '/'.$udom.'/'.$uname;
2620: }
2621:
2622: # ---------------------------------------------------------- Assign Custom Role
2623:
2624: sub assigncustomrole {
2625: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
2626: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
2627: $end,$start);
2628: }
2629:
2630: # ----------------------------------------------------------------- Revoke Role
2631:
2632: sub revokerole {
2633: my ($udom,$uname,$url,$role)=@_;
2634: my $now=time;
2635: return &assignrole($udom,$uname,$url,$role,$now);
2636: }
2637:
2638: # ---------------------------------------------------------- Revoke Custom Role
2639:
2640: sub revokecustomrole {
2641: my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
2642: my $now=time;
2643: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
2644: }
2645:
2646: # ------------------------------------------------------------ Directory lister
2647:
2648: sub dirlist {
2649: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
2650:
2651: $uri=~s/^\///;
2652: $uri=~s/\/$//;
2653: my ($udom, $uname);
2654: (undef,$udom,$uname)=split(/\//,$uri);
2655: if(defined($userdomain)) {
2656: $udom = $userdomain;
2657: }
2658: if(defined($username)) {
2659: $uname = $username;
2660: }
2661:
2662: my $dirRoot = $perlvar{'lonDocRoot'};
2663: if(defined($alternateDirectoryRoot)) {
2664: $dirRoot = $alternateDirectoryRoot;
2665: $dirRoot =~ s/\/$//;
2666: }
2667:
2668: if($udom) {
2669: if($uname) {
2670: my $listing=reply('ls:'.$dirRoot.'/'.$uri,
2671: homeserver($uname,$udom));
2672: return split(/:/,$listing);
2673: } elsif(!defined($alternateDirectoryRoot)) {
2674: my $tryserver;
2675: my %allusers=();
2676: foreach $tryserver (keys %libserv) {
2677: if($hostdom{$tryserver} eq $udom) {
2678: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
2679: $udom, $tryserver);
2680: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
2681: && ($listing ne 'con_lost')) {
2682: foreach (split(/:/,$listing)) {
2683: my ($entry,@stat)=split(/&/,$_);
2684: $allusers{$entry}=1;
2685: }
2686: }
2687: }
2688: }
2689: my $alluserstr='';
2690: foreach (sort keys %allusers) {
2691: $alluserstr.=$_.'&user:';
2692: }
2693: $alluserstr=~s/:$//;
2694: return split(/:/,$alluserstr);
2695: } else {
2696: my @emptyResults = ();
2697: push(@emptyResults, 'missing user name');
2698: return split(':',@emptyResults);
2699: }
2700: } elsif(!defined($alternateDirectoryRoot)) {
2701: my $tryserver;
2702: my %alldom=();
2703: foreach $tryserver (keys %libserv) {
2704: $alldom{$hostdom{$tryserver}}=1;
2705: }
2706: my $alldomstr='';
2707: foreach (sort keys %alldom) {
2708: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
2709: }
2710: $alldomstr=~s/:$//;
2711: return split(/:/,$alldomstr);
2712: } else {
2713: my @emptyResults = ();
2714: push(@emptyResults, 'missing domain');
2715: return split(':',@emptyResults);
2716: }
2717: }
2718:
2719: # --------------------------------------------- GetFileTimestamp
2720: # This function utilizes dirlist and returns the date stamp for
2721: # when it was last modified. It will also return an error of -1
2722: # if an error occurs
2723:
2724: sub GetFileTimestamp {
2725: my ($studentDomain,$studentName,$filename,$root)=@_;
2726: $studentDomain=~s/\W//g;
2727: $studentName=~s/\W//g;
2728: my $subdir=$studentName.'__';
2729: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
2730: my $proname="$studentDomain/$subdir/$studentName";
2731: $proname .= '/'.$filename;
2732: my @dir = &Apache::lonnet::dirlist($proname, $studentDomain, $studentName,
2733: $root);
2734: my $fileStat = $dir[0];
2735: my @stats = split('&', $fileStat);
2736: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
2737: return $stats[9];
2738: } else {
2739: return -1;
2740: }
2741: }
2742:
2743: # -------------------------------------------------------- Value of a Condition
2744:
2745: sub directcondval {
2746: my $number=shift;
2747: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
2748: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
2749: } else {
2750: return 2;
2751: }
2752: }
2753:
2754: sub condval {
2755: my $condidx=shift;
2756: my $result=0;
2757: my $allpathcond='';
2758: foreach (split(/\|/,$condidx)) {
2759: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
2760: $allpathcond.=
2761: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
2762: }
2763: }
2764: $allpathcond=~s/\|$//;
2765: if ($ENV{'request.course.id'}) {
2766: if ($allpathcond) {
2767: my $operand='|';
2768: my @stack;
2769: foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
2770: if ($_ eq '(') {
2771: push @stack,($operand,$result)
2772: } elsif ($_ eq ')') {
2773: my $before=pop @stack;
2774: if (pop @stack eq '&') {
2775: $result=$result>$before?$before:$result;
2776: } else {
2777: $result=$result>$before?$result:$before;
2778: }
2779: } elsif (($_ eq '&') || ($_ eq '|')) {
2780: $operand=$_;
2781: } else {
2782: my $new=directcondval($_);
2783: if ($operand eq '&') {
2784: $result=$result>$new?$new:$result;
2785: } else {
2786: $result=$result>$new?$result:$new;
2787: }
2788: }
2789: }
2790: }
2791: }
2792: return $result;
2793: }
2794:
2795: # ---------------------------------------------------- Devalidate courseresdata
2796:
2797: sub devalidatecourseresdata {
2798: my ($coursenum,$coursedomain)=@_;
2799: my $hashid=$coursenum.':'.$coursedomain;
2800: delete $courseresdatacache{$hashid.'.time'};
2801: }
2802:
2803: # --------------------------------------------------- Course Resourcedata Query
2804:
2805: sub courseresdata {
2806: my ($coursenum,$coursedomain,@which)=@_;
2807: my $coursehom=&homeserver($coursenum,$coursedomain);
2808: my $hashid=$coursenum.':'.$coursedomain;
2809: my $dodump=0;
2810: if (!defined($courseresdatacache{$hashid.'.time'})) {
2811: $dodump=1;
2812: } else {
2813: if (time-$courseresdatacache{$hashid.'.time'}>300) { $dodump=1; }
2814: }
2815: if ($dodump) {
2816: my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
2817: my ($tmp) = keys(%dumpreply);
2818: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
2819: $courseresdatacache{$hashid.'.time'}=time;
2820: $courseresdatacache{$hashid}=\%dumpreply;
2821: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
2822: return $tmp;
2823: }
2824: }
2825: foreach my $item (@which) {
2826: if (defined($courseresdatacache{$hashid}->{$item})) {
2827: return $courseresdatacache{$hashid}->{$item};
2828: }
2829: }
2830: return undef;
2831: }
2832:
2833: # --------------------------------------------------------- Value of a Variable
2834:
2835: sub EXT {
2836: my ($varname,$symbparm,$udom,$uname,)=@_;
2837:
2838: unless ($varname) { return ''; }
2839: #get real user name/domain, courseid and symb
2840: my $courseid;
2841: if (!($uname && $udom)) {
2842: (my $cursymb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2843: if (!$symbparm) { $symbparm=$cursymb; }
2844: } else {
2845: $courseid=$ENV{'request.course.id'};
2846: }
2847: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
2848: my $rest;
2849: if (defined($therest[0])) {
2850: $rest=join('.',@therest);
2851: } else {
2852: $rest='';
2853: }
2854:
2855: my $qualifierrest=$qualifier;
2856: if ($rest) { $qualifierrest.='.'.$rest; }
2857: my $spacequalifierrest=$space;
2858: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
2859: if ($realm eq 'user') {
2860: # --------------------------------------------------------------- user.resource
2861: if ($space eq 'resource') {
2862: if (defined($Apache::lonhomework::parsing_a_problem)) {
2863: return $Apache::lonhomework::history{$qualifierrest};
2864: } else {
2865: my %restored=&restore($symbparm,$courseid,$udom,$uname);
2866: return $restored{$qualifierrest};
2867: }
2868: # ----------------------------------------------------------------- user.access
2869: } elsif ($space eq 'access') {
2870: # FIXME - not supporting calls for a specific user
2871: return &allowed($qualifier,$rest);
2872: # ------------------------------------------ user.preferences, user.environment
2873: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
2874: if (($uname eq $ENV{'user.name'}) &&
2875: ($udom eq $ENV{'user.domain'})) {
2876: return $ENV{join('.',('environment',$qualifierrest))};
2877: } else {
2878: my %returnhash=&userenvironment($udom,$uname,$qualifierrest);
2879: return $returnhash{$qualifierrest};
2880: }
2881: # ----------------------------------------------------------------- user.course
2882: } elsif ($space eq 'course') {
2883: # FIXME - not supporting calls for a specific user
2884: return $ENV{join('.',('request.course',$qualifier))};
2885: # ------------------------------------------------------------------- user.role
2886: } elsif ($space eq 'role') {
2887: # FIXME - not supporting calls for a specific user
2888: my ($role,$where)=split(/\./,$ENV{'request.role'});
2889: if ($qualifier eq 'value') {
2890: return $role;
2891: } elsif ($qualifier eq 'extent') {
2892: return $where;
2893: }
2894: # ----------------------------------------------------------------- user.domain
2895: } elsif ($space eq 'domain') {
2896: return $udom;
2897: # ------------------------------------------------------------------- user.name
2898: } elsif ($space eq 'name') {
2899: return $uname;
2900: # ---------------------------------------------------- Any other user namespace
2901: } else {
2902: my %reply=&get($space,[$qualifierrest],$udom,$uname);
2903: return $reply{$qualifierrest};
2904: }
2905: } elsif ($realm eq 'query') {
2906: # ---------------------------------------------- pull stuff out of query string
2907: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},[$space]);
2908: return $ENV{'form.'.$space};
2909: } elsif ($realm eq 'request') {
2910: # ------------------------------------------------------------- request.browser
2911: if ($space eq 'browser') {
2912: return $ENV{'browser.'.$qualifier};
2913: # ------------------------------------------------------------ request.filename
2914: } else {
2915: return $ENV{'request.'.$spacequalifierrest};
2916: }
2917: } elsif ($realm eq 'course') {
2918: # ---------------------------------------------------------- course.description
2919: return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
2920: } elsif ($realm eq 'resource') {
2921:
2922: if ($courseid eq $ENV{'request.course.id'}) {
2923:
2924: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
2925:
2926: # ----------------------------------------------------- Cascading lookup scheme
2927: if (!$symbparm) { $symbparm=&symbread(); }
2928: my $symbp=$symbparm;
2929: my $mapp=(split(/\_\_\_/,$symbp))[0];
2930:
2931: my $symbparm=$symbp.'.'.$spacequalifierrest;
2932: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
2933:
2934: my $section;
2935: if (($ENV{'user.name'} eq $uname) &&
2936: ($ENV{'user.domain'} eq $udom)) {
2937: $section=$ENV{'request.course.sec'};
2938: } else {
2939: $section=&usection($udom,$uname,$courseid);
2940: }
2941:
2942: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
2943: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
2944: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
2945:
2946: my $courselevel=$courseid.'.'.$spacequalifierrest;
2947: my $courselevelr=$courseid.'.'.$symbparm;
2948: my $courselevelm=$courseid.'.'.$mapparm;
2949:
2950: # ----------------------------------------------------------- first, check user
2951: #most student don't have any data set, check if there is some data
2952: #every thirty minutes
2953: if (!
2954: (exists($ENV{'cache.studentresdata'})
2955: && (($ENV{'cache.studentresdata'}+1800) > time))) {
2956: my %resourcedata=&get('resourcedata',
2957: [$courselevelr,$courselevelm,$courselevel],
2958: $udom,$uname);
2959: my ($tmp)=keys(%resourcedata);
2960: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
2961: if ($resourcedata{$courselevelr}) {
2962: return $resourcedata{$courselevelr}; }
2963: if ($resourcedata{$courselevelm}) {
2964: return $resourcedata{$courselevelm}; }
2965: if ($resourcedata{$courselevel}) {
2966: return $resourcedata{$courselevel}; }
2967: } else {
2968: if ($tmp!~/No such file/) {
2969: &logthis("<font color=blue>WARNING:".
2970: " Trying to get resource data for ".
2971: $uname." at ".$udom.": ".
2972: $tmp."</font>");
2973: } elsif ($tmp=~/error:No such file/) {
2974: $ENV{'cache.studentresdata'}=time;
2975: &appenv(('cache.studentresdata'=>
2976: $ENV{'cache.studentresdata'}));
2977: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
2978: return $tmp;
2979: }
2980: }
2981: }
2982:
2983: # -------------------------------------------------------- second, check course
2984:
2985: my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
2986: $ENV{'course.'.$courseid.'.domain'},
2987: ($seclevelr,$seclevelm,$seclevel,
2988: $courselevelr,$courselevelm,
2989: $courselevel));
2990: if (defined($coursereply)) { return $coursereply; }
2991:
2992: # ------------------------------------------------------ third, check map parms
2993: my %parmhash=();
2994: my $thisparm='';
2995: if (tie(%parmhash,'GDBM_File',
2996: $ENV{'request.course.fn'}.'_parms.db',
2997: &GDBM_READER(),0640)) {
2998: $thisparm=$parmhash{$symbparm};
2999: untie(%parmhash);
3000: }
3001: if ($thisparm) { return $thisparm; }
3002: }
3003: # --------------------------------------------- last, look in resource metadata
3004:
3005: $spacequalifierrest=~s/\./\_/;
3006: my $filename;
3007: if (!$symbparm) { $symbparm=&symbread(); }
3008: if ($symbparm) {
3009: $filename=(split(/\_\_\_/,$symbparm))[2];
3010: } else {
3011: $filename=$ENV{'request.filename'};
3012: }
3013: my $metadata=&metadata($filename,$spacequalifierrest);
3014: if (defined($metadata)) { return $metadata; }
3015: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
3016: if (defined($metadata)) { return $metadata; }
3017:
3018: # ------------------------------------------------------------------ Cascade up
3019: unless ($space eq '0') {
3020: my @parts=split(/_/,$space);
3021: my $id=pop(@parts);
3022: my $part=join('_',@parts);
3023: if ($part eq '') { $part='0'; }
3024: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
3025: $symbparm,$udom,$uname);
3026: if (defined($partgeneral)) { return $partgeneral; }
3027: }
3028:
3029: # ---------------------------------------------------- Any other user namespace
3030: } elsif ($realm eq 'environment') {
3031: # ----------------------------------------------------------------- environment
3032: if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
3033: return $ENV{'environment.'.$spacequalifierrest};
3034: } else {
3035: my %returnhash=&userenvironment($udom,$uname,
3036: $spacequalifierrest);
3037: return $returnhash{$spacequalifierrest};
3038: }
3039: } elsif ($realm eq 'system') {
3040: # ----------------------------------------------------------------- system.time
3041: if ($space eq 'time') {
3042: return time;
3043: }
3044: }
3045: return '';
3046: }
3047:
3048: sub add_prefix_and_part {
3049: my ($prefix,$part)=@_;
3050: my $keyroot;
3051: if (defined($prefix) && $prefix !~ /^__/) {
3052: # prefix that has a part already
3053: $keyroot=$prefix;
3054: } elsif (defined($prefix)) {
3055: # prefix that is missing a part
3056: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
3057: } else {
3058: # no prefix at all
3059: if (defined($part)) { $keyroot='_'.$part; }
3060: }
3061: return $keyroot;
3062: }
3063:
3064: # ---------------------------------------------------------------- Get metadata
3065:
3066: sub metadata {
3067: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
3068:
3069: $uri=&declutter($uri);
3070: # if it is a non metadata possible uri return quickly
3071: if (($uri eq '') || (($uri =~ m|^/*adm/|) && ($uri !~ m|^adm/includes|)) ||
3072: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|)) {
3073: return '';
3074: }
3075: my $filename=$uri;
3076: $uri=~s/\.meta$//;
3077: #
3078: # Is the metadata already cached?
3079: # Look at timestamp of caching
3080: # Everything is cached by the main uri, libraries are never directly cached
3081: #
3082: unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600 && !defined($liburi)) {
3083: #
3084: # Is this a recursive call for a library?
3085: #
3086: if ($liburi) {
3087: $liburi=&declutter($liburi);
3088: $filename=$liburi;
3089: }
3090: my %metathesekeys=();
3091: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
3092: my $metastring=&getfile(&filelocation('',&clutter($filename)));
3093: my $parser=HTML::LCParser->new(\$metastring);
3094: my $token;
3095: undef %metathesekeys;
3096: while ($token=$parser->get_token) {
3097: if ($token->[0] eq 'S') {
3098: if (defined($token->[2]->{'package'})) {
3099: #
3100: # This is a package - get package info
3101: #
3102: my $package=$token->[2]->{'package'};
3103: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3104: if (defined($token->[2]->{'id'})) {
3105: $keyroot.='_'.$token->[2]->{'id'};
3106: }
3107: if ($metacache{$uri.':packages'}) {
3108: $metacache{$uri.':packages'}.=','.$package.$keyroot;
3109: } else {
3110: $metacache{$uri.':packages'}=$package.$keyroot;
3111: }
3112: foreach (keys %packagetab) {
3113: if ($_=~/^$package\&/) {
3114: my ($pack,$name,$subp)=split(/\&/,$_);
3115: my $value=$packagetab{$_};
3116: my $part=$keyroot;
3117: $part=~s/^\_//;
3118: if ($subp eq 'display') {
3119: $value.=' [Part: '.$part.']';
3120: }
3121: my $unikey='parameter'.$keyroot.'_'.$name;
3122: if ($subp eq 'default') { $unikey='parameter_0_'.$name; }
3123: $metathesekeys{$unikey}=1;
3124: $metacache{$uri.':'.$unikey.'.part'}=$part;
3125: unless (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
3126: $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
3127: }
3128: if (defined($metacache{$uri.':'.$unikey.'.default'})) {
3129: $metacache{$uri.':'.$unikey}=
3130: $metacache{$uri.':'.$unikey.'.default'}
3131: }
3132: }
3133: }
3134: } else {
3135: #
3136: # This is not a package - some other kind of start tag
3137: #
3138: my $entry=$token->[1];
3139: my $unikey;
3140: if ($entry eq 'import') {
3141: $unikey='';
3142: } else {
3143: $unikey=$entry;
3144: }
3145: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3146:
3147: if (defined($token->[2]->{'id'})) {
3148: $unikey.='_'.$token->[2]->{'id'};
3149: }
3150:
3151: if ($entry eq 'import') {
3152: #
3153: # Importing a library here
3154: #
3155: if ($depthcount<20) {
3156: my $location=$parser->get_text('/import');
3157: my $dir=$filename;
3158: $dir=~s|[^/]*$||;
3159: $location=&filelocation($dir,$location);
3160: foreach (sort(split(/\,/,&metadata($uri,'keys',
3161: $location,$unikey,
3162: $depthcount+1)))) {
3163: $metathesekeys{$_}=1;
3164: }
3165: }
3166: } else {
3167:
3168: if (defined($token->[2]->{'name'})) {
3169: $unikey.='_'.$token->[2]->{'name'};
3170: }
3171: $metathesekeys{$unikey}=1;
3172: foreach (@{$token->[3]}) {
3173: $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
3174: }
3175: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
3176: my $default=$metacache{$uri.':'.$unikey.'.default'};
3177: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
3178: # only ws inside the tag, and not in default, so use default
3179: # as value
3180: $metacache{$uri.':'.$unikey}=$default;
3181: } else {
3182: # either something interesting inside the tag or default
3183: # uninteresting
3184: $metacache{$uri.':'.$unikey}=$internaltext;
3185: }
3186: # end of not-a-package not-a-library import
3187: }
3188: # end of not-a-package start tag
3189: }
3190: # the next is the end of "start tag"
3191: }
3192: }
3193: # are there custom rights to evaluate
3194: if ($metacache{$uri.':copyright'} eq 'custom') {
3195:
3196: #
3197: # Importing a rights file here
3198: #
3199: unless ($depthcount) {
3200: my $location=$metacache{$uri.':customdistributionfile'};
3201: my $dir=$filename;
3202: $dir=~s|[^/]*$||;
3203: $location=&filelocation($dir,$location);
3204: foreach (sort(split(/\,/,&metadata($uri,'keys',
3205: $location,'_rights',
3206: $depthcount+1)))) {
3207: $metathesekeys{$_}=1;
3208: }
3209: }
3210: }
3211: $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
3212: &metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
3213: $metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
3214: $metacache{$uri.':cachedtimestamp'}=time;
3215: # this is the end of "was not already recently cached
3216: }
3217: return $metacache{$uri.':'.$what};
3218: }
3219:
3220: sub metadata_generate_part0 {
3221: my ($metadata,$metacache,$uri) = @_;
3222: my %allnames;
3223: foreach my $metakey (sort keys %$metadata) {
3224: if ($metakey=~/^parameter\_(.*)/) {
3225: my $part=$$metacache{$uri.':'.$metakey.'.part'};
3226: my $name=$$metacache{$uri.':'.$metakey.'.name'};
3227: if (! exists($$metadata{'parameter_0_'.$name})) {
3228: $allnames{$name}=$part;
3229: }
3230: }
3231: }
3232: foreach my $name (keys(%allnames)) {
3233: $$metadata{"parameter_0_$name"}=1;
3234: my $key="$uri:parameter_0_$name";
3235: $$metacache{"$key.part"}='0';
3236: $$metacache{"$key.name"}=$name;
3237: $$metacache{"$key.type"}=$$metacache{$uri.':parameter_'.
3238: $allnames{$name}.'_'.$name.
3239: '.type'};
3240: my $olddis=$$metacache{$uri.':parameter_'.$allnames{$name}.'_'.$name.
3241: '.display'};
3242: my $expr='\\[Part: '.$allnames{$name}.'\\]';
3243: $olddis=~s/$expr/\[Part: 0\]/;
3244: $$metacache{"$key.display"}=$olddis;
3245: }
3246: }
3247:
3248: # ------------------------------------------------- Get the title of a resource
3249:
3250: sub gettitle {
3251: my $urlsymb=shift;
3252: my $symb=&symbread($urlsymb);
3253: unless ($symb) {
3254: unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; }
3255: return &metadata($urlsymb,'title');
3256: }
3257: if ($titlecache{$symb}) { return $titlecache{$symb}; }
3258: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
3259: my $title='';
3260: my %bighash;
3261: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3262: &GDBM_READER(),0640)) {
3263: my $mapid=$bighash{'map_pc_'.&clutter($map)};
3264: $title=$bighash{'title_'.$mapid.'.'.$resid};
3265: untie %bighash;
3266: }
3267: if ($title) {
3268: $titlecache{$symb}=$title;
3269: return $title;
3270: } else {
3271: return &metadata($urlsymb,'title');
3272: }
3273: }
3274:
3275: # ------------------------------------------------- Update symbolic store links
3276:
3277: sub symblist {
3278: my ($mapname,%newhash)=@_;
3279: $mapname=declutter($mapname);
3280: my %hash;
3281: if (($ENV{'request.course.fn'}) && (%newhash)) {
3282: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
3283: &GDBM_WRCREAT(),0640)) {
3284: foreach (keys %newhash) {
3285: $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
3286: }
3287: if (untie(%hash)) {
3288: return 'ok';
3289: }
3290: }
3291: }
3292: return 'error';
3293: }
3294:
3295: # --------------------------------------------------------------- Verify a symb
3296:
3297: sub symbverify {
3298: my ($symb,$thisfn)=@_;
3299: $thisfn=&declutter($thisfn);
3300: # direct jump to resource in page or to a sequence - will construct own symbs
3301: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
3302: # check URL part
3303: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
3304: unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
3305:
3306: $symb=&symbclean($symb);
3307:
3308: my %bighash;
3309: my $okay=0;
3310: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3311: &GDBM_READER(),0640)) {
3312: my $ids=$bighash{'ids_'.&clutter($thisfn)};
3313: unless ($ids) {
3314: $ids=$bighash{'ids_/'.$thisfn};
3315: }
3316: if ($ids) {
3317: # ------------------------------------------------------------------- Has ID(s)
3318: foreach (split(/\,/,$ids)) {
3319: my ($mapid,$resid)=split(/\./,$_);
3320: if (
3321: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
3322: eq $symb) {
3323: $okay=1;
3324: }
3325: }
3326: }
3327: untie(%bighash);
3328: }
3329: return $okay;
3330: }
3331:
3332: # --------------------------------------------------------------- Clean-up symb
3333:
3334: sub symbclean {
3335: my $symb=shift;
3336:
3337: # remove version from map
3338: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
3339:
3340: # remove version from URL
3341: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
3342:
3343: return $symb;
3344: }
3345:
3346: # ------------------------------------------------------ Return symb list entry
3347:
3348: sub symbread {
3349: my ($thisfn,$donotrecurse)=@_;
3350: # no filename provided? try from environment
3351: unless ($thisfn) {
3352: if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
3353: $thisfn=$ENV{'request.filename'};
3354: }
3355: # is that filename actually a symb? Verify, clean, and return
3356: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
3357: if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
3358: }
3359: $thisfn=declutter($thisfn);
3360: my %hash;
3361: my %bighash;
3362: my $syval='';
3363: if (($ENV{'request.course.fn'}) && ($thisfn)) {
3364: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
3365: &GDBM_READER(),0640)) {
3366: $syval=$hash{$thisfn};
3367: untie(%hash);
3368: }
3369: # ---------------------------------------------------------- There was an entry
3370: if ($syval) {
3371: unless ($syval=~/\_\d+$/) {
3372: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
3373: &appenv('request.ambiguous' => $thisfn);
3374: return '';
3375: }
3376: $syval.=$1;
3377: }
3378: } else {
3379: # ------------------------------------------------------- Was not in symb table
3380: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3381: &GDBM_READER(),0640)) {
3382: # ---------------------------------------------- Get ID(s) for current resource
3383: my $ids=$bighash{'ids_'.&clutter($thisfn)};
3384: unless ($ids) {
3385: $ids=$bighash{'ids_/'.$thisfn};
3386: }
3387: unless ($ids) {
3388: # alias?
3389: $ids=$bighash{'mapalias_'.$thisfn};
3390: }
3391: if ($ids) {
3392: # ------------------------------------------------------------------- Has ID(s)
3393: my @possibilities=split(/\,/,$ids);
3394: if ($#possibilities==0) {
3395: # ----------------------------------------------- There is only one possibility
3396: my ($mapid,$resid)=split(/\./,$ids);
3397: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
3398: } elsif (!$donotrecurse) {
3399: # ------------------------------------------ There is more than one possibility
3400: my $realpossible=0;
3401: foreach (@possibilities) {
3402: my $file=$bighash{'src_'.$_};
3403: if (&allowed('bre',$file)) {
3404: my ($mapid,$resid)=split(/\./,$_);
3405: if ($bighash{'map_type_'.$mapid} ne 'page') {
3406: $realpossible++;
3407: $syval=declutter($bighash{'map_id_'.$mapid}).
3408: '___'.$resid;
3409: }
3410: }
3411: }
3412: if ($realpossible!=1) { $syval=''; }
3413: } else {
3414: $syval='';
3415: }
3416: }
3417: untie(%bighash)
3418: }
3419: }
3420: if ($syval) {
3421: return &symbclean($syval.'___'.$thisfn);
3422: }
3423: }
3424: &appenv('request.ambiguous' => $thisfn);
3425: return '';
3426: }
3427:
3428: # ---------------------------------------------------------- Return random seed
3429:
3430: sub numval {
3431: my $txt=shift;
3432: $txt=~tr/A-J/0-9/;
3433: $txt=~tr/a-j/0-9/;
3434: $txt=~tr/K-T/0-9/;
3435: $txt=~tr/k-t/0-9/;
3436: $txt=~tr/U-Z/0-5/;
3437: $txt=~tr/u-z/0-5/;
3438: $txt=~s/\D//g;
3439: return int($txt);
3440: }
3441:
3442: sub rndseed {
3443: my ($symb,$courseid,$domain,$username)=@_;
3444: if (!$symb) {
3445: unless ($symb=&symbread()) { return time; }
3446: }
3447: if (!$courseid) { $courseid=$ENV{'request.course.id'};}
3448: if (!$domain) {$domain=$ENV{'user.domain'};}
3449: if (!$username) {$username=$ENV{'user.name'};}
3450: {
3451: use integer;
3452: my $symbchck=unpack("%32C*",$symb) << 27;
3453: my $symbseed=numval($symb) << 22;
3454: my $namechck=unpack("%32C*",$username) << 17;
3455: my $nameseed=numval($username) << 12;
3456: my $domainseed=unpack("%32C*",$domain) << 7;
3457: my $courseseed=unpack("%32C*",$courseid);
3458: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
3459: #uncommenting these lines can break things!
3460: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
3461: #&Apache::lonxml::debug("rndseed :$num:$symb");
3462: return $num;
3463: }
3464: }
3465:
3466: sub ireceipt {
3467: my ($funame,$fudom,$fucourseid,$fusymb)=@_;
3468: my $cuname=unpack("%32C*",$funame);
3469: my $cudom=unpack("%32C*",$fudom);
3470: my $cucourseid=unpack("%32C*",$fucourseid);
3471: my $cusymb=unpack("%32C*",$fusymb);
3472: my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
3473: return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
3474: ($cunique%$cuname+
3475: $cunique%$cudom+
3476: $cusymb%$cuname+
3477: $cusymb%$cudom+
3478: $cucourseid%$cuname+
3479: $cucourseid%$cudom);
3480: }
3481:
3482: sub receipt {
3483: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
3484: return &ireceipt($name,$domain,$courseid,$symb);
3485: }
3486:
3487: # ------------------------------------------------------------ Serves up a file
3488: # returns either the contents of the file or a -1
3489: sub getfile {
3490: my $file=shift;
3491: if ($file=~/^\/*uploaded\//) { # user file
3492: my $ua=new LWP::UserAgent;
3493: my $request=new HTTP::Request('GET',&tokenwrapper($file));
3494: my $response=$ua->request($request);
3495: if ($response->is_success()) {
3496: return $response->content;
3497: } else {
3498: return -1;
3499: }
3500: } else { # normal file from res space
3501: &repcopy($file);
3502: if (! -e $file ) { return -1; };
3503: my $fh=Apache::File->new($file);
3504: my $a='';
3505: while (<$fh>) { $a .=$_; }
3506: return $a;
3507: }
3508: }
3509:
3510: sub filelocation {
3511: my ($dir,$file) = @_;
3512: my $location;
3513: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
3514: if ($file=~m:^/~:) { # is a contruction space reference
3515: $location = $file;
3516: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
3517: } elsif ($file=~/^\/*uploaded/) { # is an uploaded file
3518: $location=$file;
3519: } else {
3520: $file=~s/^$perlvar{'lonDocRoot'}//;
3521: $file=~s:^/*res::;
3522: if ( !( $file =~ m:^/:) ) {
3523: $location = $dir. '/'.$file;
3524: } else {
3525: $location = '/home/httpd/html/res'.$file;
3526: }
3527: }
3528: $location=~s://+:/:g; # remove duplicate /
3529: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
3530: return $location;
3531: }
3532:
3533: sub hreflocation {
3534: my ($dir,$file)=@_;
3535: unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
3536: my $finalpath=filelocation($dir,$file);
3537: $finalpath=~s/^\/home\/httpd\/html//;
3538: $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
3539: return $finalpath;
3540: } else {
3541: return $file;
3542: }
3543: }
3544:
3545: # ------------------------------------------------------------- Declutters URLs
3546:
3547: sub declutter {
3548: my $thisfn=shift;
3549: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
3550: $thisfn=~s/^\///;
3551: $thisfn=~s/^res\///;
3552: $thisfn=~s/\?.+$//;
3553: return $thisfn;
3554: }
3555:
3556: # ------------------------------------------------------------- Clutter up URLs
3557:
3558: sub clutter {
3559: my $thisfn='/'.&declutter(shift);
3560: unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) {
3561: $thisfn='/res'.$thisfn;
3562: }
3563: return $thisfn;
3564: }
3565:
3566: # -------------------------------------------------------- Escape Special Chars
3567:
3568: sub escape {
3569: my $str=shift;
3570: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
3571: return $str;
3572: }
3573:
3574: # ----------------------------------------------------- Un-Escape Special Chars
3575:
3576: sub unescape {
3577: my $str=shift;
3578: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3579: return $str;
3580: }
3581:
3582: # ================================================================ Main Program
3583:
3584: sub goodbye {
3585: &logthis("Starting Shut down");
3586: &flushcourselogs();
3587: &logthis("Shutting down");
3588: }
3589:
3590: BEGIN {
3591: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
3592: unless ($readit) {
3593: {
3594: my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
3595:
3596: while (my $configline=<$config>) {
3597: if ($configline =~ /^[^\#]*PerlSetVar/) {
3598: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
3599: chomp($varvalue);
3600: $perlvar{$varname}=$varvalue;
3601: }
3602: }
3603: }
3604: {
3605: my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
3606:
3607: while (my $configline=<$config>) {
3608: if ($configline =~ /^[^\#]*PerlSetVar/) {
3609: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
3610: chomp($varvalue);
3611: $perlvar{$varname}=$varvalue;
3612: }
3613: }
3614: }
3615:
3616: # ------------------------------------------------------------ Read domain file
3617: {
3618: my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
3619: '/domain.tab');
3620: %domaindescription = ();
3621: %domain_auth_def = ();
3622: %domain_auth_arg_def = ();
3623: if ($fh) {
3624: while (<$fh>) {
3625: next if /^\#/;
3626: chomp;
3627: my ($domain, $domain_description, $def_auth, $def_auth_arg)
3628: = split(/:/,$_,4);
3629: $domain_auth_def{$domain}=$def_auth;
3630: $domain_auth_arg_def{$domain}=$def_auth_arg;
3631: $domaindescription{$domain}=$domain_description;
3632: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
3633: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
3634: }
3635: }
3636: }
3637:
3638:
3639: # ------------------------------------------------------------- Read hosts file
3640: {
3641: my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
3642:
3643: while (my $configline=<$config>) {
3644: next if ($configline =~ /^(\#|\s*$)/);
3645: chomp($configline);
3646: my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
3647: if ($id && $domain && $role && $name && $ip) {
3648: $hostname{$id}=$name;
3649: $hostdom{$id}=$domain;
3650: $hostip{$id}=$ip;
3651: $iphost{$ip}=$id;
3652: if ($role eq 'library') { $libserv{$id}=$name; }
3653: } else {
3654: if ($configline) {
3655: &logthis("Skipping hosts.tab line -$configline-");
3656: }
3657: }
3658: }
3659: }
3660:
3661: # ------------------------------------------------------ Read spare server file
3662: {
3663: my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
3664:
3665: while (my $configline=<$config>) {
3666: chomp($configline);
3667: if ($configline) {
3668: $spareid{$configline}=1;
3669: }
3670: }
3671: }
3672: # ------------------------------------------------------------ Read permissions
3673: {
3674: my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
3675:
3676: while (my $configline=<$config>) {
3677: chomp($configline);
3678: if ($configline) {
3679: my ($role,$perm)=split(/ /,$configline);
3680: if ($perm ne '') { $pr{$role}=$perm; }
3681: }
3682: }
3683: }
3684:
3685: # -------------------------------------------- Read plain texts for permissions
3686: {
3687: my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
3688:
3689: while (my $configline=<$config>) {
3690: chomp($configline);
3691: if ($configline) {
3692: my ($short,$plain)=split(/:/,$configline);
3693: if ($plain ne '') { $prp{$short}=$plain; }
3694: }
3695: }
3696: }
3697:
3698: # ---------------------------------------------------------- Read package table
3699: {
3700: my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
3701:
3702: while (my $configline=<$config>) {
3703: chomp($configline);
3704: my ($short,$plain)=split(/:/,$configline);
3705: my ($pack,$name)=split(/\&/,$short);
3706: if ($plain ne '') {
3707: $packagetab{$pack.'&'.$name.'&name'}=$name;
3708: $packagetab{$short}=$plain;
3709: }
3710: }
3711: }
3712:
3713: # ------------- set up temporary directory
3714: {
3715: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
3716:
3717: }
3718:
3719: %metacache=();
3720:
3721: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
3722: $dumpcount=0;
3723:
3724: &logtouch();
3725: &logthis('<font color=yellow>INFO: Read configuration</font>');
3726: $readit=1;
3727: }
3728: }
3729:
3730: 1;
3731: __END__
3732:
3733: =pod
3734:
3735: =head1 NAME
3736:
3737: Apache::lonnet - Subroutines to ask questions about things in the network.
3738:
3739: =head1 SYNOPSIS
3740:
3741: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
3742:
3743: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
3744:
3745: Common parameters:
3746:
3747: =over 4
3748:
3749: =item *
3750:
3751: $uname : an internal username (if $cname expecting a course Id specifically)
3752:
3753: =item *
3754:
3755: $udom : a domain (if $cdom expecting a course's domain specifically)
3756:
3757: =item *
3758:
3759: $symb : a resource instance identifier
3760:
3761: =item *
3762:
3763: $namespace : the name of a .db file that contains the data needed or
3764: being set.
3765:
3766: =back
3767:
3768: =head1 INTRODUCTION
3769:
3770: This module provides subroutines which interact with the
3771: lonc/lond (TCP) network layer of LON-CAPA. And Can be used to ask about
3772: - classes
3773: - users
3774: - resources
3775:
3776: For many of these objects you can also use this to store data about
3777: them or modify them in various ways.
3778:
3779: This is part of the LearningOnline Network with CAPA project
3780: described at http://www.lon-capa.org.
3781:
3782: =head1 RETURN MESSAGES
3783:
3784: =over 4
3785:
3786: =item *
3787:
3788: con_lost : unable to contact remote host
3789:
3790: =item *
3791:
3792: con_delayed : unable to contact remote host, message will be delivered
3793: when the connection is brought back up
3794:
3795: =item *
3796:
3797: con_failed : unable to contact remote host and unable to save message
3798: for later delivery
3799:
3800: =item *
3801:
3802: error: : an error a occured, a description of the error follows the :
3803:
3804: =item *
3805:
3806: no_such_host : unable to fund a host associated with the user/domain
3807: that was requested
3808:
3809: =back
3810:
3811: =head1 PUBLIC SUBROUTINES
3812:
3813: =head2 Session Environment Functions
3814:
3815: =over 4
3816:
3817: =item *
3818:
3819: appenv(%hash) : the value of %hash is written to the user envirnoment
3820: file, and will be restored for each access this user makes during this
3821: session, also modifies the %ENV for the current process
3822:
3823: =item *
3824:
3825: delenv($regexp) : removes all items from the session environment file that matches the regular expression in $regexp. The values are also delted from the current processes %ENV.
3826:
3827: =back
3828:
3829: =head2 User Information
3830:
3831: =over 4
3832:
3833: =item *
3834:
3835: queryauthenticate($uname,$udom) : try to determine user's current
3836: authentication scheme
3837:
3838: =item *
3839:
3840: authenticate($uname,$upass,$udom) : try to authenticate user from domain's lib
3841: servers (first use the current one), $upass should be the users password
3842:
3843: =item *
3844:
3845: homeserver($uname,$udom) : find the server which has the user's
3846: directory and files (there must be only one), this caches the answer,
3847: and also caches if there is a borken connection.
3848:
3849: =item *
3850:
3851: idget($udom,@ids) : find the usernames behind a list of IDs (IDs are a
3852: unique resource in a domain, there must be only 1 ID per username, and
3853: only 1 username per ID in a specific domain) (returns hash:
3854: id=>name,id=>name)
3855:
3856: =item *
3857:
3858: idrget($udom,@unames) : find the IDs behind a list of usernames (returns hash:
3859: name=>id,name=>id)
3860:
3861: =item *
3862:
3863: idput($udom,%ids) : store away a list of names and associated IDs
3864:
3865: =item *
3866:
3867: rolesinit($udom,$username,$authhost) : get user privileges
3868:
3869: =item *
3870:
3871: usection($udom,$uname,$cname) : finds the section of student in the
3872: course $cname, return section name/number or '' for "not in course"
3873: and '-1' for "no section"
3874:
3875: =item *
3876:
3877: userenvironment($udom,$uname,@what) : gets the values of the keys
3878: passed in @what from the requested user's environment, returns a hash
3879:
3880: =back
3881:
3882: =head2 User Roles
3883:
3884: =over 4
3885:
3886: =item *
3887:
3888: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
3889: actions
3890: F: full access
3891: U,I,K: authentication modes (cxx only)
3892: '': forbidden
3893: 1: user needs to choose course
3894: 2: browse allowed
3895:
3896: =item *
3897:
3898: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
3899: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
3900: and course level
3901:
3902: =item *
3903:
3904: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
3905: explanation of a user role term
3906:
3907: =back
3908:
3909: =head2 User Modification
3910:
3911: =over 4
3912:
3913: =item *
3914:
3915: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
3916: user for the level given by URL. Optional start and end dates (leave empty
3917: string or zero for "no date")
3918:
3919: =item *
3920:
3921: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
3922: change a users, password, possible return values are: ok,
3923: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
3924: refused
3925:
3926: =item *
3927:
3928: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
3929:
3930: =item *
3931:
3932: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
3933: modify user
3934:
3935: =item *
3936:
3937: modifystudent
3938:
3939: modify a students enrollment and identification information.
3940: The course id is resolved based on the current users environment.
3941: This means the envoking user must be a course coordinator or otherwise
3942: associated with a course.
3943:
3944: This call is essentially a wrapper for lonnet::modifyuser and
3945: lonnet::modify_student_enrollment
3946:
3947: Inputs:
3948:
3949: =over 4
3950:
3951: =item B<$udom> Students loncapa domain
3952:
3953: =item B<$uname> Students loncapa login name
3954:
3955: =item B<$uid> Students id/student number
3956:
3957: =item B<$umode> Students authentication mode
3958:
3959: =item B<$upass> Students password
3960:
3961: =item B<$first> Students first name
3962:
3963: =item B<$middle> Students middle name
3964:
3965: =item B<$last> Students last name
3966:
3967: =item B<$gene> Students generation
3968:
3969: =item B<$usec> Students section in course
3970:
3971: =item B<$end> Unix time of the roles expiration
3972:
3973: =item B<$start> Unix time of the roles start date
3974:
3975: =item B<$forceid> If defined, allow $uid to be changed
3976:
3977: =item B<$desiredhome> server to use as home server for student
3978:
3979: =back
3980:
3981: =item *
3982:
3983: modify_student_enrollment
3984:
3985: Change a students enrollment status in a class. The environment variable
3986: 'role.request.course' must be defined for this function to proceed.
3987:
3988: Inputs:
3989:
3990: =over 4
3991:
3992: =item $udom, students domain
3993:
3994: =item $uname, students name
3995:
3996: =item $uid, students user id
3997:
3998: =item $first, students first name
3999:
4000: =item $middle
4001:
4002: =item $last
4003:
4004: =item $gene
4005:
4006: =item $usec
4007:
4008: =item $end
4009:
4010: =item $start
4011:
4012: =back
4013:
4014:
4015: =item *
4016:
4017: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
4018: custom role; give a custom role to a user for the level given by URL. Specify
4019: name and domain of role author, and role name
4020:
4021: =item *
4022:
4023: revokerole($udom,$uname,$url,$role) : revoke a role for url
4024:
4025: =item *
4026:
4027: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
4028:
4029: =back
4030:
4031: =head2 Course Infomation
4032:
4033: =over 4
4034:
4035: =item *
4036:
4037: coursedescription($courseid) : course description
4038:
4039: =item *
4040:
4041: courseresdata($coursenum,$coursedomain,@which) : request for current
4042: parameter setting for a specific course, @what should be a list of
4043: parameters to ask about. This routine caches answers for 5 minutes.
4044:
4045: =back
4046:
4047: =head2 Course Modification
4048:
4049: =over 4
4050:
4051: =item *
4052:
4053: writecoursepref($courseid,%prefs) : write preferences (environment
4054: database) for a course
4055:
4056: =item *
4057:
4058: createcourse($udom,$description,$url) : make/modify course
4059:
4060: =back
4061:
4062: =head2 Resource Subroutines
4063:
4064: =over 4
4065:
4066: =item *
4067:
4068: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
4069:
4070: =item *
4071:
4072: repcopy($filename) : subscribes to the requested file, and attempts to
4073: replicate from the owning library server, Might return
4074: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
4075: HTTP_BAD_REQUEST, also attempts to grab the metadata for the
4076: resource. Expects the local filesystem pathname
4077: (/home/httpd/html/res/....)
4078:
4079: =back
4080:
4081: =head2 Resource Information
4082:
4083: =over 4
4084:
4085: =item *
4086:
4087: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
4088: a vairety of different possible values, $varname should be a request
4089: string, and the other parameters can be used to specify who and what
4090: one is asking about.
4091:
4092: Possible values for $varname are environment.lastname (or other item
4093: from the envirnment hash), user.name (or someother aspect about the
4094: user), resource.0.maxtries (or some other part and parameter of a
4095: resource)
4096:
4097: =item *
4098:
4099: directcondval($number) : get current value of a condition; reads from a state
4100: string
4101:
4102: =item *
4103:
4104: condval($condidx) : value of condition index based on state
4105:
4106: =item *
4107:
4108: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
4109: resource's metadata, $what should be either a specific key, or either
4110: 'keys' (to get a list of possible keys) or 'packages' to get a list of
4111: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
4112:
4113: this function automatically caches all requests
4114:
4115: =item *
4116:
4117: metadata_query($query,$custom,$customshow) : make a metadata query against the
4118: network of library servers; returns file handle of where SQL and regex results
4119: will be stored for query
4120:
4121: =item *
4122:
4123: symbread($filename) : return symbolic list entry (filename argument optional);
4124: returns the data handle
4125:
4126: =item *
4127:
4128: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
4129: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
4130: failure, user must be in a course, as it assumes the existance of the
4131: course initi hash, and uses $ENV('request.course.id'}
4132:
4133:
4134: =item *
4135:
4136: symbclean($symb) : removes versions numbers from a symb, returns the
4137: cleaned symb
4138:
4139: =item *
4140:
4141: is_on_map($uri) : checks if the $uri is somewhere on the current
4142: course map, user must be in a course for it to work.
4143:
4144: =item *
4145:
4146: numval($salt) : return random seed value (addend for rndseed)
4147:
4148: =item *
4149:
4150: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
4151: a random seed, all arguments are optional, if they aren't sent it uses the
4152: environment to derive them. Note: if symb isn't sent and it can't get one
4153: from &symbread it will use the current time as its return value
4154:
4155: =item *
4156:
4157: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
4158: unfakeable, receipt
4159:
4160: =item *
4161:
4162: receipt() : API to ireceipt working off of ENV values; given out to users
4163:
4164: =item *
4165:
4166: countacc($url) : count the number of accesses to a given URL
4167:
4168: =item *
4169:
4170: 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
4171:
4172: =item *
4173:
4174: 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)
4175:
4176: =item *
4177:
4178: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
4179:
4180: =item *
4181:
4182: devalidate($symb) : devalidate temporary spreadsheet calculations,
4183: forcing spreadsheet to reevaluate the resource scores next time.
4184:
4185: =back
4186:
4187: =head2 Storing/Retreiving Data
4188:
4189: =over 4
4190:
4191: =item *
4192:
4193: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
4194: for this url; hashref needs to be given and should be a \%hashname; the
4195: remaining args aren't required and if they aren't passed or are '' they will
4196: be derived from the ENV
4197:
4198: =item *
4199:
4200: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
4201: uses critical subroutine
4202:
4203: =item *
4204:
4205: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
4206: all args are optional
4207:
4208: =item *
4209:
4210: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
4211: works very similar to store/cstore, but all data is stored in a
4212: temporary location and can be reset using tmpreset, $storehash should
4213: be a hash reference, returns nothing on success
4214:
4215: =item *
4216:
4217: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
4218: similar to restore, but all data is stored in a temporary location and
4219: can be reset using tmpreset. Returns a hash of values on success,
4220: error string otherwise.
4221:
4222: =item *
4223:
4224: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
4225: deltes all keys for $symb form the temporary storage hash.
4226:
4227: =item *
4228:
4229: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
4230: reference filled in from namesp ($udom and $uname are optional)
4231:
4232: =item *
4233:
4234: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
4235: namesp ($udom and $uname are optional)
4236:
4237: =item *
4238:
4239: dump($namespace,$udom,$uname,$regexp) :
4240: dumps the complete (or key matching regexp) namespace into a hash
4241: ($udom, $uname and $regexp are optional)
4242:
4243: =item *
4244:
4245: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
4246: ($udom and $uname are optional)
4247:
4248: =item *
4249:
4250: cput($namespace,$storehash,$udom,$uname) : critical put
4251: ($udom and $uname are optional)
4252:
4253: =item *
4254:
4255: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
4256: reference filled in from namesp (encrypts the return communication)
4257: ($udom and $uname are optional)
4258:
4259: =item *
4260:
4261: log($udom,$name,$home,$message) : write to permanent log for user; use
4262: critical subroutine
4263:
4264: =back
4265:
4266: =head2 Network Status Functions
4267:
4268: =over 4
4269:
4270: =item *
4271:
4272: dirlist($uri) : return directory list based on URI
4273:
4274: =item *
4275:
4276: spareserver() : find server with least workload from spare.tab
4277:
4278: =back
4279:
4280: =head2 Apache Request
4281:
4282: =over 4
4283:
4284: =item *
4285:
4286: ssi($url,%hash) : server side include, does a complete request cycle on url to
4287: localhost, posts hash
4288:
4289: =back
4290:
4291: =head2 Data to String to Data
4292:
4293: =over 4
4294:
4295: =item *
4296:
4297: hash2str(%hash) : convert a hash into a string complete with escaping and '='
4298: and '&' separators, supports elements that are arrayrefs and hashrefs
4299:
4300: =item *
4301:
4302: hashref2str($hashref) : convert a hashref into a string complete with
4303: escaping and '=' and '&' separators, supports elements that are
4304: arrayrefs and hashrefs
4305:
4306: =item *
4307:
4308: arrayref2str($arrayref) : convert an arrayref into a string complete
4309: with escaping and '&' separators, supports elements that are arrayrefs
4310: and hashrefs
4311:
4312: =item *
4313:
4314: str2hash($string) : convert string to hash using unescaping and
4315: splitting on '=' and '&', supports elements that are arrayrefs and
4316: hashrefs
4317:
4318: =item *
4319:
4320: str2array($string) : convert string to hash using unescaping and
4321: splitting on '&', supports elements that are arrayrefs and hashrefs
4322:
4323: =back
4324:
4325: =head2 Logging Routines
4326:
4327: =over 4
4328:
4329: These routines allow one to make log messages in the lonnet.log and
4330: lonnet.perm logfiles.
4331:
4332: =item *
4333:
4334: logtouch() : make sure the logfile, lonnet.log, exists
4335:
4336: =item *
4337:
4338: logthis() : append message to the normal lonnet.log file, it gets
4339: preiodically rolled over and deleted.
4340:
4341: =item *
4342:
4343: logperm() : append a permanent message to lonnet.perm.log, this log
4344: file never gets deleted by any automated portion of the system, only
4345: messages of critical importance should go in here.
4346:
4347: =back
4348:
4349: =head2 General File Helper Routines
4350:
4351: =over 4
4352:
4353: =item *
4354:
4355: getfile($file) : returns the entire contents of a file or -1; it
4356: properly subscribes to and replicates the file if neccessary.
4357:
4358: =item *
4359:
4360: filelocation($dir,$file) : returns file system location of a file
4361: based on URI; meant to be "fairly clean" absolute reference, $dir is a
4362: directory that relative $file lookups are to looked in ($dir of /a/dir
4363: and a file of ../bob will become /a/bob)
4364:
4365: =item *
4366:
4367: hreflocation($dir,$file) : returns file system location or a URL; same as
4368: filelocation except for hrefs
4369:
4370: =item *
4371:
4372: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
4373:
4374: =back
4375:
4376: =head2 HTTP Helper Routines
4377:
4378: =over 4
4379:
4380: =item *
4381:
4382: escape() : unpack non-word characters into CGI-compatible hex codes
4383:
4384: =item *
4385:
4386: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
4387:
4388: =back
4389:
4390: =head1 PRIVATE SUBROUTINES
4391:
4392: =head2 Underlying communication routines (Shouldn't call)
4393:
4394: =over 4
4395:
4396: =item *
4397:
4398: subreply() : tries to pass a message to lonc, returns con_lost if incapable
4399:
4400: =item *
4401:
4402: reply() : uses subreply to send a message to remote machine, logs all failures
4403:
4404: =item *
4405:
4406: critical() : passes a critical message to another server; if cannot
4407: get through then place message in connection buffer directory and
4408: returns con_delayed, if incapable of saving message, returns
4409: con_failed
4410:
4411: =item *
4412:
4413: reconlonc() : tries to reconnect lonc client processes.
4414:
4415: =back
4416:
4417: =head2 Resource Access Logging
4418:
4419: =over 4
4420:
4421: =item *
4422:
4423: flushcourselogs() : flush (save) buffer logs and access logs
4424:
4425: =item *
4426:
4427: courselog($what) : save message for course in hash
4428:
4429: =item *
4430:
4431: courseacclog($what) : save message for course using &courselog(). Perform
4432: special processing for specific resource types (problems, exams, quizzes, etc).
4433:
4434: =item *
4435:
4436: goodbye() : flush course logs and log shutting down; it is called in srm.conf
4437: as a PerlChildExitHandler
4438:
4439: =back
4440:
4441: =head2 Other
4442:
4443: =over 4
4444:
4445: =item *
4446:
4447: symblist($mapname,%newhash) : update symbolic storage links
4448:
4449: =back
4450:
4451: =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