1: # The LearningOnline Network
2: # TCP networking package
3: #
4: # $Id: lonnet.pm,v 1.339 2003/03/14 15:08:20 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: # 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: # ------------------------------------------------- Check for a user privilege
1874:
1875: sub allowed {
1876: my ($priv,$uri)=@_;
1877:
1878: my $orguri=$uri;
1879: $uri=&declutter($uri);
1880:
1881: # Free bre access to adm and meta resources
1882:
1883: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1884: return 'F';
1885: }
1886:
1887: # Free bre to public access
1888:
1889: if ($priv eq 'bre') {
1890: my $copyright=&metadata($uri,'copyright');
1891: if (($copyright eq 'public') && (!$ENV{'request.course.id'})) {
1892: return 'F';
1893: }
1894: if ($copyright eq 'priv') {
1895: $uri=~/([^\/]+)\/([^\/]+)\//;
1896: unless (($ENV{'user.name'} eq $2) && ($ENV{'user.domain'} eq $1)) {
1897: return '';
1898: }
1899: }
1900: if ($copyright eq 'domain') {
1901: $uri=~/([^\/]+)\/([^\/]+)\//;
1902: unless (($ENV{'user.domain'} eq $1) ||
1903: ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $1)) {
1904: return '';
1905: }
1906: }
1907: if ($ENV{'request.role'}=~ /li\.\//) {
1908: # Library role, so allow browsing of resources in this domain.
1909: return 'F';
1910: }
1911: }
1912: # Domain coordinator is trying to create a course
1913: if (($priv eq 'ccc') && ($ENV{'request.role'} =~ /^dc\./)) {
1914: # uri is the requested domain in this case.
1915: # comparison to 'request.role.domain' shows if the user has selected
1916: # a role of dc for the domain in question.
1917: return 'F' if ($uri eq $ENV{'request.role.domain'});
1918: }
1919:
1920: my $thisallowed='';
1921: my $statecond=0;
1922: my $courseprivid='';
1923:
1924: # Course
1925:
1926: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
1927: $thisallowed.=$1;
1928: }
1929:
1930: # Domain
1931:
1932: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1933: =~/$priv\&([^\:]*)/) {
1934: $thisallowed.=$1;
1935: }
1936:
1937: # Course: uri itself is a course
1938: my $courseuri=$uri;
1939: $courseuri=~s/\_(\d)/\/$1/;
1940: $courseuri=~s/^([^\/])/\/$1/;
1941:
1942: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
1943: =~/$priv\&([^\:]*)/) {
1944: $thisallowed.=$1;
1945: }
1946:
1947: # URI is an uploaded document for this course
1948:
1949: if (($priv eq 'bre') &&
1950: ($uri=~/^uploaded\/$ENV{'course.'.$ENV{'request.course.id'}.'.domain'}\/$ENV{'course.'.$ENV{'request.course.id'}.'.num'}/)) {
1951: return 'F';
1952: }
1953: # Full access at system, domain or course-wide level? Exit.
1954:
1955: if ($thisallowed=~/F/) {
1956: return 'F';
1957: }
1958:
1959: # If this is generating or modifying users, exit with special codes
1960:
1961: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
1962: return $thisallowed;
1963: }
1964: #
1965: # Gathered so far: system, domain and course wide privileges
1966: #
1967: # Course: See if uri or referer is an individual resource that is part of
1968: # the course
1969:
1970: if ($ENV{'request.course.id'}) {
1971:
1972: $courseprivid=$ENV{'request.course.id'};
1973: if ($ENV{'request.course.sec'}) {
1974: $courseprivid.='/'.$ENV{'request.course.sec'};
1975: }
1976: $courseprivid=~s/\_/\//;
1977: my $checkreferer=1;
1978: my ($match,$cond)=&is_on_map($uri);
1979: if ($match) {
1980: $statecond=$cond;
1981: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1982: =~/$priv\&([^\:]*)/) {
1983: $thisallowed.=$1;
1984: $checkreferer=0;
1985: }
1986: }
1987:
1988: if ($checkreferer) {
1989: my $refuri=$ENV{'httpref.'.$orguri};
1990: unless ($refuri) {
1991: foreach (keys %ENV) {
1992: if ($_=~/^httpref\..*\*/) {
1993: my $pattern=$_;
1994: $pattern=~s/^httpref\.\/res\///;
1995: $pattern=~s/\*/\[\^\/\]\+/g;
1996: $pattern=~s/\//\\\//g;
1997: if ($orguri=~/$pattern/) {
1998: $refuri=$ENV{$_};
1999: }
2000: }
2001: }
2002: }
2003:
2004: if ($refuri) {
2005: $refuri=&declutter($refuri);
2006: my ($match,$cond)=&is_on_map($refuri);
2007: if ($match) {
2008: my $refstatecond=$cond;
2009: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
2010: =~/$priv\&([^\:]*)/) {
2011: $thisallowed.=$1;
2012: $uri=$refuri;
2013: $statecond=$refstatecond;
2014: }
2015: }
2016: }
2017: }
2018: }
2019:
2020: #
2021: # Gathered now: all privileges that could apply, and condition number
2022: #
2023: #
2024: # Full or no access?
2025: #
2026:
2027: if ($thisallowed=~/F/) {
2028: return 'F';
2029: }
2030:
2031: unless ($thisallowed) {
2032: return '';
2033: }
2034:
2035: # Restrictions exist, deal with them
2036: #
2037: # C:according to course preferences
2038: # R:according to resource settings
2039: # L:unless locked
2040: # X:according to user session state
2041: #
2042:
2043: # Possibly locked functionality, check all courses
2044: # Locks might take effect only after 10 minutes cache expiration for other
2045: # courses, and 2 minutes for current course
2046:
2047: my $envkey;
2048: if ($thisallowed=~/L/) {
2049: foreach $envkey (keys %ENV) {
2050: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
2051: my $courseid=$2;
2052: my $roleid=$1.'.'.$2;
2053: $courseid=~s/^\///;
2054: my $expiretime=600;
2055: if ($ENV{'request.role'} eq $roleid) {
2056: $expiretime=120;
2057: }
2058: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
2059: my $prefix='course.'.$cdom.'_'.$cnum.'.';
2060: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
2061: &coursedescription($courseid);
2062: }
2063: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
2064: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
2065: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
2066: &log($ENV{'user.domain'},$ENV{'user.name'},
2067: $ENV{'user.home'},
2068: 'Locked by res: '.$priv.' for '.$uri.' due to '.
2069: $cdom.'/'.$cnum.'/'.$csec.' expire '.
2070: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
2071: return '';
2072: }
2073: }
2074: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
2075: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
2076: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
2077: &log($ENV{'user.domain'},$ENV{'user.name'},
2078: $ENV{'user.home'},
2079: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
2080: $cdom.'/'.$cnum.'/'.$csec.' expire '.
2081: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
2082: return '';
2083: }
2084: }
2085: }
2086: }
2087: }
2088:
2089: #
2090: # Rest of the restrictions depend on selected course
2091: #
2092:
2093: unless ($ENV{'request.course.id'}) {
2094: return '1';
2095: }
2096:
2097: #
2098: # Now user is definitely in a course
2099: #
2100:
2101:
2102: # Course preferences
2103:
2104: if ($thisallowed=~/C/) {
2105: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
2106: my $unamedom=$ENV{'user.name'}.':'.$ENV{'user.domain'};
2107: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
2108: =~/$rolecode/) {
2109: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2110: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
2111: $ENV{'request.course.id'});
2112: return '';
2113: }
2114:
2115: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.users.denied'}
2116: =~/$unamedom/) {
2117: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2118: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
2119: $ENV{'request.course.id'});
2120: return '';
2121: }
2122: }
2123:
2124: # Resource preferences
2125:
2126: if ($thisallowed=~/R/) {
2127: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
2128: my $filename=$perlvar{'lonDocRoot'}.'/res/'.$uri.'.meta';
2129: if (-e $filename) {
2130: my @content;
2131: {
2132: my $fh=Apache::File->new($filename);
2133: @content=<$fh>;
2134: }
2135: if (join('',@content)=~
2136: /\<roledeny[^\>]*\>[^\<]*$rolecode[^\<]*\<\/roledeny\>/) {
2137: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
2138: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
2139: return '';
2140:
2141: }
2142: }
2143: }
2144:
2145: # Restricted by state or randomout?
2146:
2147: if ($thisallowed=~/X/) {
2148: if ($ENV{'acc.randomout'}) {
2149: my $symb=&symbread($uri,1);
2150: if (($symb) && ($ENV{'acc.randomout'}=~/\&$symb\&/)) {
2151: return '';
2152: }
2153: }
2154: if (&condval($statecond)) {
2155: return '2';
2156: } else {
2157: return '';
2158: }
2159: }
2160:
2161: return 'F';
2162: }
2163:
2164: # --------------------------------------------------- Is a resource on the map?
2165:
2166: sub is_on_map {
2167: my $uri=&declutter(shift);
2168: my @uriparts=split(/\//,$uri);
2169: my $filename=$uriparts[$#uriparts];
2170: my $pathname=$uri;
2171: $pathname=~s|/\Q$filename\E$||;
2172: $pathname=~s/^adm\/wrapper\///;
2173: #Trying to find the conditional for the file
2174: my $match=($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
2175: /\&\Q$filename\E\:([\d\|]+)\&/);
2176: if ($match) {
2177: return (1,$1);
2178: } else {
2179: return (0,0);
2180: }
2181: }
2182:
2183: # ----------------------------------------------------------------- Define Role
2184:
2185: sub definerole {
2186: if (allowed('mcr','/')) {
2187: my ($rolename,$sysrole,$domrole,$courole)=@_;
2188: foreach (split('/',$sysrole)) {
2189: my ($crole,$cqual)=split(/\&/,$_);
2190: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
2191: if ($pr{'cr:s'}=~/$crole\&/) {
2192: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
2193: return "refused:s:$crole&$cqual";
2194: }
2195: }
2196: }
2197: foreach (split('/',$domrole)) {
2198: my ($crole,$cqual)=split(/\&/,$_);
2199: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
2200: if ($pr{'cr:d'}=~/$crole\&/) {
2201: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
2202: return "refused:d:$crole&$cqual";
2203: }
2204: }
2205: }
2206: foreach (split('/',$courole)) {
2207: my ($crole,$cqual)=split(/\&/,$_);
2208: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
2209: if ($pr{'cr:c'}=~/$crole\&/) {
2210: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
2211: return "refused:c:$crole&$cqual";
2212: }
2213: }
2214: }
2215: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2216: "$ENV{'user.domain'}:$ENV{'user.name'}:".
2217: "rolesdef_$rolename=".
2218: escape($sysrole.'_'.$domrole.'_'.$courole);
2219: return reply($command,$ENV{'user.home'});
2220: } else {
2221: return 'refused';
2222: }
2223: }
2224:
2225: # ---------------- Make a metadata query against the network of library servers
2226:
2227: sub metadata_query {
2228: my ($query,$custom,$customshow,$server_array)=@_;
2229: my %rhash;
2230: my @server_list = (defined($server_array) ? @$server_array
2231: : keys(%libserv) );
2232: for my $server (@server_list) {
2233: unless ($custom or $customshow) {
2234: my $reply=&reply("querysend:".&escape($query),$server);
2235: $rhash{$server}=$reply;
2236: }
2237: else {
2238: my $reply=&reply("querysend:".&escape($query).':'.
2239: &escape($custom).':'.&escape($customshow),
2240: $server);
2241: $rhash{$server}=$reply;
2242: }
2243: }
2244: return \%rhash;
2245: }
2246:
2247: # ----------------------------------------- Send log queries and wait for reply
2248:
2249: sub log_query {
2250: my ($uname,$udom,$query,%filters)=@_;
2251: my $uhome=&homeserver($uname,$udom);
2252: if ($uhome eq 'no_host') { return 'error: no_host'; }
2253: my $uhost=$hostname{$uhome};
2254: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys %filters));
2255: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
2256: $uhome);
2257: unless ($queryid=~/^$uhost\_/) { return 'error: '.$queryid; }
2258: return get_query_reply($queryid);
2259: }
2260:
2261: sub get_query_reply {
2262: my $queryid=shift;
2263: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
2264: my $reply='';
2265: for (1..100) {
2266: sleep 2;
2267: if (-e $replyfile.'.end') {
2268: if (my $fh=Apache::File->new($replyfile)) {
2269: $reply.=<$fh>;
2270: $fh->close;
2271: } else { return 'error: reply_file_error'; }
2272: return &unescape($reply);
2273: }
2274: }
2275: return 'timeout:'.$queryid;
2276: }
2277:
2278: sub courselog_query {
2279: #
2280: # possible filters:
2281: # url: url or symb
2282: # username
2283: # domain
2284: # action: view, submit, grade
2285: # start: timestamp
2286: # end: timestamp
2287: #
2288: my (%filters)=@_;
2289: unless ($ENV{'request.course.id'}) { return 'no_course'; }
2290: if ($filters{'url'}) {
2291: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
2292: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
2293: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
2294: }
2295: my $cname=$ENV{'course.'.$ENV{'request.course.id'}.'.num'};
2296: my $cdom=$ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
2297: return &log_query($cname,$cdom,'courselog',%filters);
2298: }
2299:
2300: sub userlog_query {
2301: my ($uname,$udom,%filters)=@_;
2302: return &log_query($uname,$udom,'userlog',%filters);
2303: }
2304:
2305: # ------------------------------------------------------------------ Plain Text
2306:
2307: sub plaintext {
2308: my $short=shift;
2309: return $prp{$short};
2310: }
2311:
2312: # ----------------------------------------------------------------- Assign Role
2313:
2314: sub assignrole {
2315: my ($udom,$uname,$url,$role,$end,$start)=@_;
2316: my $mrole;
2317: if ($role =~ /^cr\//) {
2318: unless (&allowed('ccr',$url)) {
2319: &logthis('Refused custom assignrole: '.
2320: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2321: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2322: return 'refused';
2323: }
2324: $mrole='cr';
2325: } else {
2326: my $cwosec=$url;
2327: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
2328: unless (&allowed('c'.$role,$cwosec)) {
2329: &logthis('Refused assignrole: '.
2330: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
2331: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2332: return 'refused';
2333: }
2334: $mrole=$role;
2335: }
2336: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
2337: "$udom:$uname:$url".'_'."$mrole=$role";
2338: if ($end) { $command.='_'.$end; }
2339: if ($start) {
2340: if ($end) {
2341: $command.='_'.$start;
2342: } else {
2343: $command.='_0_'.$start;
2344: }
2345: }
2346: return &reply($command,&homeserver($uname,$udom));
2347: }
2348:
2349: # -------------------------------------------------- Modify user authentication
2350: # Overrides without validation
2351:
2352: sub modifyuserauth {
2353: my ($udom,$uname,$umode,$upass)=@_;
2354: my $uhome=&homeserver($uname,$udom);
2355: unless (&allowed('mau',$udom)) { return 'refused'; }
2356: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
2357: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2358: ' in domain '.$ENV{'request.role.domain'});
2359: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
2360: &escape($upass),$uhome);
2361: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.home'},
2362: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
2363: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2364: &log($udom,,$uname,$uhome,
2365: 'Authentication changed by '.$ENV{'user.domain'}.', '.
2366: $ENV{'user.name'}.', '.$umode.
2367: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
2368: unless ($reply eq 'ok') {
2369: &logthis('Authentication mode error: '.$reply);
2370: return 'error: '.$reply;
2371: }
2372: return 'ok';
2373: }
2374:
2375: # --------------------------------------------------------------- Modify a user
2376:
2377: sub modifyuser {
2378: my ($udom, $uname, $uid,
2379: $umode, $upass, $first,
2380: $middle, $last, $gene,
2381: $forceid, $desiredhome)=@_;
2382: $udom=~s/\W//g;
2383: $uname=~s/\W//g;
2384: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
2385: $umode.', '.$first.', '.$middle.', '.
2386: $last.', '.$gene.'(forceid: '.$forceid.')'.
2387: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
2388: ' desiredhome not specified').
2389: ' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'}.
2390: ' in domain '.$ENV{'request.role.domain'});
2391: my $uhome=&homeserver($uname,$udom,'true');
2392: # ----------------------------------------------------------------- Create User
2393: if (($uhome eq 'no_host') && ($umode) && ($upass)) {
2394: my $unhome='';
2395: if (defined($desiredhome) && $hostdom{$desiredhome} eq $udom) {
2396: $unhome = $desiredhome;
2397: } elsif($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
2398: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
2399: } else { # load balancing routine for determining $unhome
2400: my $tryserver;
2401: my $loadm=10000000;
2402: foreach $tryserver (keys %libserv) {
2403: if ($hostdom{$tryserver} eq $udom) {
2404: my $answer=reply('load',$tryserver);
2405: if (($answer=~/\d+/) && ($answer<$loadm)) {
2406: $loadm=$answer;
2407: $unhome=$tryserver;
2408: }
2409: }
2410: }
2411: }
2412: if (($unhome eq '') || ($unhome eq 'no_host')) {
2413: return 'error: unable to find a home server for '.$uname.
2414: ' in domain '.$udom;
2415: }
2416: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
2417: &escape($upass),$unhome);
2418: unless ($reply eq 'ok') {
2419: return 'error: '.$reply;
2420: }
2421: $uhome=&homeserver($uname,$udom,'true');
2422: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
2423: return 'error: verify home';
2424: }
2425: } # End of creation of new user
2426: # ---------------------------------------------------------------------- Add ID
2427: if ($uid) {
2428: $uid=~tr/A-Z/a-z/;
2429: my %uidhash=&idrget($udom,$uname);
2430: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
2431: && (!$forceid)) {
2432: unless ($uid eq $uidhash{$uname}) {
2433: return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
2434: }
2435: } else {
2436: &idput($udom,($uname => $uid));
2437: }
2438: }
2439: # -------------------------------------------------------------- Add names, etc
2440: my @tmp=&get('environment',
2441: ['firstname','middlename','lastname','generation'],
2442: $udom,$uname);
2443: my %names;
2444: if ($tmp[0] =~ m/^error:.*/) {
2445: %names=();
2446: } else {
2447: %names = @tmp;
2448: }
2449: if ($first) { $names{'firstname'} = $first; }
2450: if ($middle) { $names{'middlename'} = $middle; }
2451: if ($last) { $names{'lastname'} = $last; }
2452: if ($gene) { $names{'generation'} = $gene; }
2453: my $reply = &put('environment', \%names, $udom,$uname);
2454: if ($reply ne 'ok') { return 'error: '.$reply; }
2455: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
2456: $umode.', '.$first.', '.$middle.', '.
2457: $last.', '.$gene.' by '.
2458: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
2459: return 'ok';
2460: }
2461:
2462: # -------------------------------------------------------------- Modify student
2463:
2464: sub modifystudent {
2465: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
2466: $end,$start,$forceid,$desiredhome)=@_;
2467: my $cid='';
2468: unless ($cid=$ENV{'request.course.id'}) {
2469: return 'not_in_class';
2470: }
2471: # --------------------------------------------------------------- Make the user
2472: my $reply=&modifyuser
2473: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
2474: $desiredhome);
2475: unless ($reply eq 'ok') { return $reply; }
2476: # This will cause &modify_student_enrollment to get the uid from the
2477: # students environment
2478: $uid = undef if (!$forceid);
2479: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,
2480: $last,$gene,$usec,$end,$start);
2481: return $reply;
2482: }
2483:
2484: sub modify_student_enrollment {
2485: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start) = @_;
2486: # Get the course id from the environment
2487: my $cid='';
2488: unless ($cid=$ENV{'request.course.id'}) {
2489: return 'not_in_class';
2490: }
2491: # Make sure the user exists
2492: my $uhome=&homeserver($uname,$udom);
2493: if (($uhome eq '') || ($uhome eq 'no_host')) {
2494: return 'error: no such user';
2495: }
2496: #
2497: # Get student data if we were not given enough information
2498: if (!defined($first) || $first eq '' ||
2499: !defined($last) || $last eq '' ||
2500: !defined($uid) || $uid eq '' ||
2501: !defined($middle) || $middle eq '' ||
2502: !defined($gene) || $gene eq '') {
2503: # They did not supply us with enough data to enroll the student, so
2504: # we need to pick up more information.
2505: my %tmp = &get('environment',
2506: ['firstname','middlename','lastname', 'generation','id']
2507: ,$udom,$uname);
2508:
2509: foreach (keys(%tmp)) {
2510: &logthis("key $_ = ".$tmp{$_});
2511: }
2512: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
2513: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
2514: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
2515: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
2516: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
2517: }
2518: my $fullname = &Apache::loncoursedata::ProcessFullName($last,$gene,
2519: $first,$middle);
2520: my $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
2521: $ENV{'course.'.$cid.'.num'}.':classlist:'.
2522: &escape($uname.':'.$udom).'='.
2523: &escape(join(':',$end,$start,$uid,$usec,$fullname)),
2524: $ENV{'course.'.$cid.'.home'});
2525: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
2526: return 'error: '.$reply;
2527: }
2528: # Add student role to user
2529: my $uurl='/'.$cid;
2530: $uurl=~s/\_/\//g;
2531: if ($usec) {
2532: $uurl.='/'.$usec;
2533: }
2534: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
2535: }
2536:
2537: # ------------------------------------------------- Write to course preferences
2538:
2539: sub writecoursepref {
2540: my ($courseid,%prefs)=@_;
2541: $courseid=~s/^\///;
2542: $courseid=~s/\_/\//g;
2543: my ($cdomain,$cnum)=split(/\//,$courseid);
2544: my $chome=homeserver($cnum,$cdomain);
2545: if (($chome eq '') || ($chome eq 'no_host')) {
2546: return 'error: no such course';
2547: }
2548: my $cstring='';
2549: foreach (keys %prefs) {
2550: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
2551: }
2552: $cstring=~s/\&$//;
2553: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
2554: }
2555:
2556: # ---------------------------------------------------------- Make/modify course
2557:
2558: sub createcourse {
2559: my ($udom,$description,$url,$course_server,$nonstandard)=@_;
2560: $url=&declutter($url);
2561: my $cid='';
2562: unless (&allowed('ccc',$udom)) {
2563: return 'refused';
2564: }
2565: # ------------------------------------------------------------------- Create ID
2566: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2567: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2568: # ----------------------------------------------- Make sure that does not exist
2569: my $uhome=&homeserver($uname,$udom,'true');
2570: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2571: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
2572: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
2573: $uhome=&homeserver($uname,$udom,'true');
2574: unless (($uhome eq '') || ($uhome eq 'no_host')) {
2575: return 'error: unable to generate unique course-ID';
2576: }
2577: }
2578: # ------------------------------------------------ Check supplied server name
2579: $course_server = $ENV{'user.homeserver'} if (! defined($course_server));
2580: if (! exists($libserv{$course_server})) {
2581: return 'error:bad server name '.$course_server;
2582: }
2583: # ------------------------------------------------------------- Make the course
2584: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
2585: $course_server);
2586: unless ($reply eq 'ok') { return 'error: '.$reply; }
2587: $uhome=&homeserver($uname,$udom,'true');
2588: if (($uhome eq '') || ($uhome eq 'no_host')) {
2589: return 'error: no such course';
2590: }
2591: # ----------------------------------------------------------------- Course made
2592: my $topurl=$url;
2593: unless ($nonstandard) {
2594: # ------------------------------------------ For standard courses, make top url
2595: my $mapurl=&clutter($url);
2596: if ($mapurl eq '/res/') { $mapurl=''; }
2597: $ENV{'form.initmap'}=(<<ENDINITMAP);
2598: <map>
2599: <resource id="1" type="start"></resource>
2600: <resource id="2" src="$mapurl"></resource>
2601: <resource id="3" type="finish"></resource>
2602: <link index="1" from="1" to="2"></link>
2603: <link index="2" from="2" to="3"></link>
2604: </map>
2605: ENDINITMAP
2606: $topurl=&declutter(
2607: &finishuserfileupload($uname,$udom,$uhome,'initmap','default.sequence')
2608: );
2609: }
2610: # ----------------------------------------------------------- Write preferences
2611: &writecoursepref($udom.'_'.$uname,
2612: ('description' => $description,
2613: 'url' => $topurl));
2614: return '/'.$udom.'/'.$uname;
2615: }
2616:
2617: # ---------------------------------------------------------- Assign Custom Role
2618:
2619: sub assigncustomrole {
2620: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
2621: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
2622: $end,$start);
2623: }
2624:
2625: # ----------------------------------------------------------------- Revoke Role
2626:
2627: sub revokerole {
2628: my ($udom,$uname,$url,$role)=@_;
2629: my $now=time;
2630: return &assignrole($udom,$uname,$url,$role,$now);
2631: }
2632:
2633: # ---------------------------------------------------------- Revoke Custom Role
2634:
2635: sub revokecustomrole {
2636: my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
2637: my $now=time;
2638: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
2639: }
2640:
2641: # ------------------------------------------------------------ Directory lister
2642:
2643: sub dirlist {
2644: my ($uri,$userdomain,$username,$alternateDirectoryRoot)=@_;
2645:
2646: $uri=~s/^\///;
2647: $uri=~s/\/$//;
2648: my ($udom, $uname);
2649: (undef,$udom,$uname)=split(/\//,$uri);
2650: if(defined($userdomain)) {
2651: $udom = $userdomain;
2652: }
2653: if(defined($username)) {
2654: $uname = $username;
2655: }
2656:
2657: my $dirRoot = $perlvar{'lonDocRoot'};
2658: if(defined($alternateDirectoryRoot)) {
2659: $dirRoot = $alternateDirectoryRoot;
2660: $dirRoot =~ s/\/$//;
2661: }
2662:
2663: if($udom) {
2664: if($uname) {
2665: my $listing=reply('ls:'.$dirRoot.'/'.$uri,
2666: homeserver($uname,$udom));
2667: return split(/:/,$listing);
2668: } elsif(!defined($alternateDirectoryRoot)) {
2669: my $tryserver;
2670: my %allusers=();
2671: foreach $tryserver (keys %libserv) {
2672: if($hostdom{$tryserver} eq $udom) {
2673: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
2674: $udom, $tryserver);
2675: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
2676: && ($listing ne 'con_lost')) {
2677: foreach (split(/:/,$listing)) {
2678: my ($entry,@stat)=split(/&/,$_);
2679: $allusers{$entry}=1;
2680: }
2681: }
2682: }
2683: }
2684: my $alluserstr='';
2685: foreach (sort keys %allusers) {
2686: $alluserstr.=$_.'&user:';
2687: }
2688: $alluserstr=~s/:$//;
2689: return split(/:/,$alluserstr);
2690: } else {
2691: my @emptyResults = ();
2692: push(@emptyResults, 'missing user name');
2693: return split(':',@emptyResults);
2694: }
2695: } elsif(!defined($alternateDirectoryRoot)) {
2696: my $tryserver;
2697: my %alldom=();
2698: foreach $tryserver (keys %libserv) {
2699: $alldom{$hostdom{$tryserver}}=1;
2700: }
2701: my $alldomstr='';
2702: foreach (sort keys %alldom) {
2703: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
2704: }
2705: $alldomstr=~s/:$//;
2706: return split(/:/,$alldomstr);
2707: } else {
2708: my @emptyResults = ();
2709: push(@emptyResults, 'missing domain');
2710: return split(':',@emptyResults);
2711: }
2712: }
2713:
2714: # --------------------------------------------- GetFileTimestamp
2715: # This function utilizes dirlist and returns the date stamp for
2716: # when it was last modified. It will also return an error of -1
2717: # if an error occurs
2718:
2719: sub GetFileTimestamp {
2720: my ($studentDomain,$studentName,$filename,$root)=@_;
2721: $studentDomain=~s/\W//g;
2722: $studentName=~s/\W//g;
2723: my $subdir=$studentName.'__';
2724: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
2725: my $proname="$studentDomain/$subdir/$studentName";
2726: $proname .= '/'.$filename;
2727: my @dir = &Apache::lonnet::dirlist($proname, $studentDomain, $studentName,
2728: $root);
2729: my $fileStat = $dir[0];
2730: my @stats = split('&', $fileStat);
2731: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
2732: return $stats[9];
2733: } else {
2734: return -1;
2735: }
2736: }
2737:
2738: # -------------------------------------------------------- Value of a Condition
2739:
2740: sub directcondval {
2741: my $number=shift;
2742: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
2743: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
2744: } else {
2745: return 2;
2746: }
2747: }
2748:
2749: sub condval {
2750: my $condidx=shift;
2751: my $result=0;
2752: my $allpathcond='';
2753: foreach (split(/\|/,$condidx)) {
2754: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
2755: $allpathcond.=
2756: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
2757: }
2758: }
2759: $allpathcond=~s/\|$//;
2760: if ($ENV{'request.course.id'}) {
2761: if ($allpathcond) {
2762: my $operand='|';
2763: my @stack;
2764: foreach ($allpathcond=~/(\d+|\(|\)|\&|\|)/g) {
2765: if ($_ eq '(') {
2766: push @stack,($operand,$result)
2767: } elsif ($_ eq ')') {
2768: my $before=pop @stack;
2769: if (pop @stack eq '&') {
2770: $result=$result>$before?$before:$result;
2771: } else {
2772: $result=$result>$before?$result:$before;
2773: }
2774: } elsif (($_ eq '&') || ($_ eq '|')) {
2775: $operand=$_;
2776: } else {
2777: my $new=directcondval($_);
2778: if ($operand eq '&') {
2779: $result=$result>$new?$new:$result;
2780: } else {
2781: $result=$result>$new?$result:$new;
2782: }
2783: }
2784: }
2785: }
2786: }
2787: return $result;
2788: }
2789:
2790: # ---------------------------------------------------- Devalidate courseresdata
2791:
2792: sub devalidatecourseresdata {
2793: my ($coursenum,$coursedomain)=@_;
2794: my $hashid=$coursenum.':'.$coursedomain;
2795: delete $courseresdatacache{$hashid.'.time'};
2796: }
2797:
2798: # --------------------------------------------------- Course Resourcedata Query
2799:
2800: sub courseresdata {
2801: my ($coursenum,$coursedomain,@which)=@_;
2802: my $coursehom=&homeserver($coursenum,$coursedomain);
2803: my $hashid=$coursenum.':'.$coursedomain;
2804: my $dodump=0;
2805: if (!defined($courseresdatacache{$hashid.'.time'})) {
2806: $dodump=1;
2807: } else {
2808: if (time-$courseresdatacache{$hashid.'.time'}>300) { $dodump=1; }
2809: }
2810: if ($dodump) {
2811: my %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
2812: my ($tmp) = keys(%dumpreply);
2813: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
2814: $courseresdatacache{$hashid.'.time'}=time;
2815: $courseresdatacache{$hashid}=\%dumpreply;
2816: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
2817: return $tmp;
2818: }
2819: }
2820: foreach my $item (@which) {
2821: if (defined($courseresdatacache{$hashid}->{$item})) {
2822: return $courseresdatacache{$hashid}->{$item};
2823: }
2824: }
2825: return undef;
2826: }
2827:
2828: # --------------------------------------------------------- Value of a Variable
2829:
2830: sub EXT {
2831: my ($varname,$symbparm,$udom,$uname,)=@_;
2832:
2833: unless ($varname) { return ''; }
2834: #get real user name/domain, courseid and symb
2835: my $courseid;
2836: if (!($uname && $udom)) {
2837: (my $cursymb,$courseid,$udom,$uname)=&Apache::lonxml::whichuser();
2838: if (!$symbparm) { $symbparm=$cursymb; }
2839: } else {
2840: $courseid=$ENV{'request.course.id'};
2841: }
2842: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
2843: my $rest;
2844: if (defined($therest[0])) {
2845: $rest=join('.',@therest);
2846: } else {
2847: $rest='';
2848: }
2849:
2850: my $qualifierrest=$qualifier;
2851: if ($rest) { $qualifierrest.='.'.$rest; }
2852: my $spacequalifierrest=$space;
2853: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
2854: if ($realm eq 'user') {
2855: # --------------------------------------------------------------- user.resource
2856: if ($space eq 'resource') {
2857: if (defined($Apache::lonhomework::parsing_a_problem)) {
2858: return $Apache::lonhomework::history{$qualifierrest};
2859: } else {
2860: my %restored=&restore($symbparm,$courseid,$udom,$uname);
2861: return $restored{$qualifierrest};
2862: }
2863: # ----------------------------------------------------------------- user.access
2864: } elsif ($space eq 'access') {
2865: # FIXME - not supporting calls for a specific user
2866: return &allowed($qualifier,$rest);
2867: # ------------------------------------------ user.preferences, user.environment
2868: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
2869: if (($uname eq $ENV{'user.name'}) &&
2870: ($udom eq $ENV{'user.domain'})) {
2871: return $ENV{join('.',('environment',$qualifierrest))};
2872: } else {
2873: my %returnhash=&userenvironment($udom,$uname,$qualifierrest);
2874: return $returnhash{$qualifierrest};
2875: }
2876: # ----------------------------------------------------------------- user.course
2877: } elsif ($space eq 'course') {
2878: # FIXME - not supporting calls for a specific user
2879: return $ENV{join('.',('request.course',$qualifier))};
2880: # ------------------------------------------------------------------- user.role
2881: } elsif ($space eq 'role') {
2882: # FIXME - not supporting calls for a specific user
2883: my ($role,$where)=split(/\./,$ENV{'request.role'});
2884: if ($qualifier eq 'value') {
2885: return $role;
2886: } elsif ($qualifier eq 'extent') {
2887: return $where;
2888: }
2889: # ----------------------------------------------------------------- user.domain
2890: } elsif ($space eq 'domain') {
2891: return $udom;
2892: # ------------------------------------------------------------------- user.name
2893: } elsif ($space eq 'name') {
2894: return $uname;
2895: # ---------------------------------------------------- Any other user namespace
2896: } else {
2897: my %reply=&get($space,[$qualifierrest],$udom,$uname);
2898: return $reply{$qualifierrest};
2899: }
2900: } elsif ($realm eq 'query') {
2901: # ---------------------------------------------- pull stuff out of query string
2902: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},[$space]);
2903: return $ENV{'form.'.$space};
2904: } elsif ($realm eq 'request') {
2905: # ------------------------------------------------------------- request.browser
2906: if ($space eq 'browser') {
2907: return $ENV{'browser.'.$qualifier};
2908: # ------------------------------------------------------------ request.filename
2909: } else {
2910: return $ENV{'request.'.$spacequalifierrest};
2911: }
2912: } elsif ($realm eq 'course') {
2913: # ---------------------------------------------------------- course.description
2914: return $ENV{'course.'.$courseid.'.'.$spacequalifierrest};
2915: } elsif ($realm eq 'resource') {
2916:
2917: if ($courseid eq $ENV{'request.course.id'}) {
2918:
2919: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
2920:
2921: # ----------------------------------------------------- Cascading lookup scheme
2922: if (!$symbparm) { $symbparm=&symbread(); }
2923: my $symbp=$symbparm;
2924: my $mapp=(split(/\_\_\_/,$symbp))[0];
2925:
2926: my $symbparm=$symbp.'.'.$spacequalifierrest;
2927: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
2928:
2929: my $section;
2930: if (($ENV{'user.name'} eq $uname) &&
2931: ($ENV{'user.domain'} eq $udom)) {
2932: $section=$ENV{'request.course.sec'};
2933: } else {
2934: $section=&usection($udom,$uname,$courseid);
2935: }
2936:
2937: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
2938: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
2939: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
2940:
2941: my $courselevel=$courseid.'.'.$spacequalifierrest;
2942: my $courselevelr=$courseid.'.'.$symbparm;
2943: my $courselevelm=$courseid.'.'.$mapparm;
2944:
2945: # ----------------------------------------------------------- first, check user
2946: #most student don't have any data set, check if there is some data
2947: #every thirty minutes
2948: if (!
2949: (exists($ENV{'cache.studentresdata'})
2950: && (($ENV{'cache.studentresdata'}+1800) > time))) {
2951: my %resourcedata=&get('resourcedata',
2952: [$courselevelr,$courselevelm,$courselevel],
2953: $udom,$uname);
2954: my ($tmp)=keys(%resourcedata);
2955: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
2956: if ($resourcedata{$courselevelr}) {
2957: return $resourcedata{$courselevelr}; }
2958: if ($resourcedata{$courselevelm}) {
2959: return $resourcedata{$courselevelm}; }
2960: if ($resourcedata{$courselevel}) {
2961: return $resourcedata{$courselevel}; }
2962: } else {
2963: if ($tmp!~/No such file/) {
2964: &logthis("<font color=blue>WARNING:".
2965: " Trying to get resource data for ".
2966: $uname." at ".$udom.": ".
2967: $tmp."</font>");
2968: } elsif ($tmp=~/error:No such file/) {
2969: $ENV{'cache.studentresdata'}=time;
2970: &appenv(('cache.studentresdata'=>
2971: $ENV{'cache.studentresdata'}));
2972: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
2973: return $tmp;
2974: }
2975: }
2976: }
2977:
2978: # -------------------------------------------------------- second, check course
2979:
2980: my $coursereply=&courseresdata($ENV{'course.'.$courseid.'.num'},
2981: $ENV{'course.'.$courseid.'.domain'},
2982: ($seclevelr,$seclevelm,$seclevel,
2983: $courselevelr,$courselevelm,
2984: $courselevel));
2985: if (defined($coursereply)) { return $coursereply; }
2986:
2987: # ------------------------------------------------------ third, check map parms
2988: my %parmhash=();
2989: my $thisparm='';
2990: if (tie(%parmhash,'GDBM_File',
2991: $ENV{'request.course.fn'}.'_parms.db',
2992: &GDBM_READER(),0640)) {
2993: $thisparm=$parmhash{$symbparm};
2994: untie(%parmhash);
2995: }
2996: if ($thisparm) { return $thisparm; }
2997: }
2998: # --------------------------------------------- last, look in resource metadata
2999:
3000: $spacequalifierrest=~s/\./\_/;
3001: my $filename;
3002: if (!$symbparm) { $symbparm=&symbread(); }
3003: if ($symbparm) {
3004: $filename=(split(/\_\_\_/,$symbparm))[2];
3005: } else {
3006: $filename=$ENV{'request.filename'};
3007: }
3008: my $metadata=&metadata($filename,$spacequalifierrest);
3009: if (defined($metadata)) { return $metadata; }
3010: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
3011: if (defined($metadata)) { return $metadata; }
3012:
3013: # ------------------------------------------------------------------ Cascade up
3014: unless ($space eq '0') {
3015: my @parts=split(/_/,$space);
3016: my $id=pop(@parts);
3017: my $part=join('_',@parts);
3018: if ($part eq '') { $part='0'; }
3019: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
3020: $symbparm,$udom,$uname);
3021: if (defined($partgeneral)) { return $partgeneral; }
3022: }
3023:
3024: # ---------------------------------------------------- Any other user namespace
3025: } elsif ($realm eq 'environment') {
3026: # ----------------------------------------------------------------- environment
3027: if (($uname eq $ENV{'user.name'})&&($udom eq $ENV{'user.domain'})) {
3028: return $ENV{'environment.'.$spacequalifierrest};
3029: } else {
3030: my %returnhash=&userenvironment($udom,$uname,
3031: $spacequalifierrest);
3032: return $returnhash{$spacequalifierrest};
3033: }
3034: } elsif ($realm eq 'system') {
3035: # ----------------------------------------------------------------- system.time
3036: if ($space eq 'time') {
3037: return time;
3038: }
3039: }
3040: return '';
3041: }
3042:
3043: sub add_prefix_and_part {
3044: my ($prefix,$part)=@_;
3045: my $keyroot;
3046: if (defined($prefix) && $prefix !~ /^__/) {
3047: # prefix that has a part already
3048: $keyroot=$prefix;
3049: } elsif (defined($prefix)) {
3050: # prefix that is missing a part
3051: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
3052: } else {
3053: # no prefix at all
3054: if (defined($part)) { $keyroot='_'.$part; }
3055: }
3056: return $keyroot;
3057: }
3058:
3059: # ---------------------------------------------------------------- Get metadata
3060:
3061: sub metadata {
3062: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
3063:
3064: $uri=&declutter($uri);
3065: # if it is a non metadata possible uri return quickly
3066: if (($uri eq '') || (($uri =~ m|^/*adm/|) && ($uri !~ m|^adm/includes|)) ||
3067: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|)) {
3068: return '';
3069: }
3070: my $filename=$uri;
3071: $uri=~s/\.meta$//;
3072: #
3073: # Is the metadata already cached?
3074: # Look at timestamp of caching
3075: # Everything is cached by the main uri, libraries are never directly cached
3076: #
3077: unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600 && !defined($liburi)) {
3078: #
3079: # Is this a recursive call for a library?
3080: #
3081: if ($liburi) {
3082: $liburi=&declutter($liburi);
3083: $filename=$liburi;
3084: }
3085: my %metathesekeys=();
3086: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
3087: my $metastring=&getfile(&filelocation('',&clutter($filename)));
3088: my $parser=HTML::LCParser->new(\$metastring);
3089: my $token;
3090: undef %metathesekeys;
3091: while ($token=$parser->get_token) {
3092: if ($token->[0] eq 'S') {
3093: if (defined($token->[2]->{'package'})) {
3094: #
3095: # This is a package - get package info
3096: #
3097: my $package=$token->[2]->{'package'};
3098: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3099: if (defined($token->[2]->{'id'})) {
3100: $keyroot.='_'.$token->[2]->{'id'};
3101: }
3102: if ($metacache{$uri.':packages'}) {
3103: $metacache{$uri.':packages'}.=','.$package.$keyroot;
3104: } else {
3105: $metacache{$uri.':packages'}=$package.$keyroot;
3106: }
3107: foreach (keys %packagetab) {
3108: if ($_=~/^$package\&/) {
3109: my ($pack,$name,$subp)=split(/\&/,$_);
3110: my $value=$packagetab{$_};
3111: my $part=$keyroot;
3112: $part=~s/^\_//;
3113: if ($subp eq 'display') {
3114: $value.=' [Part: '.$part.']';
3115: }
3116: my $unikey='parameter'.$keyroot.'_'.$name;
3117: $metathesekeys{$unikey}=1;
3118: $metacache{$uri.':'.$unikey.'.part'}=$part;
3119: unless (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
3120: $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
3121: }
3122: if (defined($metacache{$uri.':'.$unikey.'.default'})) {
3123: $metacache{$uri.':'.$unikey}=
3124: $metacache{$uri.':'.$unikey.'.default'}
3125: }
3126: }
3127: }
3128: } else {
3129: #
3130: # This is not a package - some other kind of start tag
3131: #
3132: my $entry=$token->[1];
3133: my $unikey;
3134: if ($entry eq 'import') {
3135: $unikey='';
3136: } else {
3137: $unikey=$entry;
3138: }
3139: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
3140:
3141: if (defined($token->[2]->{'id'})) {
3142: $unikey.='_'.$token->[2]->{'id'};
3143: }
3144:
3145: if ($entry eq 'import') {
3146: #
3147: # Importing a library here
3148: #
3149: if ($depthcount<20) {
3150: my $location=$parser->get_text('/import');
3151: my $dir=$filename;
3152: $dir=~s|[^/]*$||;
3153: $location=&filelocation($dir,$location);
3154: foreach (sort(split(/\,/,&metadata($uri,'keys',
3155: $location,$unikey,
3156: $depthcount+1)))) {
3157: $metathesekeys{$_}=1;
3158: }
3159: }
3160: } else {
3161:
3162: if (defined($token->[2]->{'name'})) {
3163: $unikey.='_'.$token->[2]->{'name'};
3164: }
3165: $metathesekeys{$unikey}=1;
3166: foreach (@{$token->[3]}) {
3167: $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
3168: }
3169: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
3170: my $default=$metacache{$uri.':'.$unikey.'.default'};
3171: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
3172: # only ws inside the tag, and not in default, so use default
3173: # as value
3174: $metacache{$uri.':'.$unikey}=$default;
3175: } else {
3176: # either something interesting inside the tag or default
3177: # uninteresting
3178: $metacache{$uri.':'.$unikey}=$internaltext;
3179: }
3180: # end of not-a-package not-a-library import
3181: }
3182: # end of not-a-package start tag
3183: }
3184: # the next is the end of "start tag"
3185: }
3186: }
3187: # are there custom rights to evaluate
3188: if ($metacache{$uri.':copyright'} eq 'custom') {
3189:
3190: #
3191: # Importing a rights file here
3192: #
3193: unless ($depthcount) {
3194: my $location=$metacache{$uri.':customdistributionfile'};
3195: my $dir=$filename;
3196: $dir=~s|[^/]*$||;
3197: $location=&filelocation($dir,$location);
3198: foreach (sort(split(/\,/,&metadata($uri,'keys',
3199: $location,'_rights',
3200: $depthcount+1)))) {
3201: $metathesekeys{$_}=1;
3202: }
3203: }
3204: }
3205: $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
3206: &metadata_generate_part0(\%metathesekeys,\%metacache,$uri);
3207: $metacache{$uri.':allpossiblekeys'}=join(',',keys %metathesekeys);
3208: $metacache{$uri.':cachedtimestamp'}=time;
3209: # this is the end of "was not already recently cached
3210: }
3211: return $metacache{$uri.':'.$what};
3212: }
3213:
3214: sub metadata_generate_part0 {
3215: my ($metadata,$metacache,$uri) = @_;
3216: my %allnames;
3217: foreach my $metakey (sort keys %$metadata) {
3218: if ($metakey=~/^parameter\_(.*)/) {
3219: my $part=$$metacache{$uri.':'.$metakey.'.part'};
3220: my $name=$$metacache{$uri.':'.$metakey.'.name'};
3221: if (! exists($$metadata{'parameter_0_'.$name})) {
3222: $allnames{$name}=$part;
3223: }
3224: }
3225: }
3226: foreach my $name (keys(%allnames)) {
3227: $$metadata{"parameter_0_$name"}=1;
3228: my $key="$uri:parameter_0_$name";
3229: $$metacache{"$key.part"}='0';
3230: $$metacache{"$key.name"}=$name;
3231: $$metacache{"$key.type"}=$$metacache{$uri.':parameter_'.
3232: $allnames{$name}.'_'.$name.
3233: '.type'};
3234: my $olddis=$$metacache{$uri.':parameter_'.$allnames{$name}.'_'.$name.
3235: '.display'};
3236: my $expr='\\[Part: '.$allnames{$name}.'\\]';
3237: $olddis=~s/$expr/\[Part: 0\]/;
3238: $$metacache{"$key.display"}=$olddis;
3239: }
3240: }
3241:
3242: # ------------------------------------------------- Get the title of a resource
3243:
3244: sub gettitle {
3245: my $urlsymb=shift;
3246: my $symb=&symbread($urlsymb);
3247: unless ($symb) {
3248: unless ($urlsymb) { $urlsymb=$ENV{'request.filename'}; }
3249: return &metadata($urlsymb,'title');
3250: }
3251: if ($titlecache{$symb}) { return $titlecache{$symb}; }
3252: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
3253: my $title='';
3254: my %bighash;
3255: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3256: &GDBM_READER(),0640)) {
3257: my $mapid=$bighash{'map_pc_'.&clutter($map)};
3258: $title=$bighash{'title_'.$mapid.'.'.$resid};
3259: untie %bighash;
3260: }
3261: if ($title) {
3262: $titlecache{$symb}=$title;
3263: return $title;
3264: } else {
3265: return &metadata($urlsymb,'title');
3266: }
3267: }
3268:
3269: # ------------------------------------------------- Update symbolic store links
3270:
3271: sub symblist {
3272: my ($mapname,%newhash)=@_;
3273: $mapname=declutter($mapname);
3274: my %hash;
3275: if (($ENV{'request.course.fn'}) && (%newhash)) {
3276: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
3277: &GDBM_WRCREAT(),0640)) {
3278: foreach (keys %newhash) {
3279: $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
3280: }
3281: if (untie(%hash)) {
3282: return 'ok';
3283: }
3284: }
3285: }
3286: return 'error';
3287: }
3288:
3289: # --------------------------------------------------------------- Verify a symb
3290:
3291: sub symbverify {
3292: my ($symb,$thisfn)=@_;
3293: $thisfn=&declutter($thisfn);
3294: # direct jump to resource in page or to a sequence - will construct own symbs
3295: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
3296: # check URL part
3297: my ($map,$resid,$url)=split(/\_\_\_/,$symb);
3298: unless (&symbclean($url) eq &symbclean($thisfn)) { return 0; }
3299:
3300: $symb=&symbclean($symb);
3301:
3302: my %bighash;
3303: my $okay=0;
3304: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3305: &GDBM_READER(),0640)) {
3306: my $ids=$bighash{'ids_'.&clutter($thisfn)};
3307: unless ($ids) {
3308: $ids=$bighash{'ids_/'.$thisfn};
3309: }
3310: if ($ids) {
3311: # ------------------------------------------------------------------- Has ID(s)
3312: foreach (split(/\,/,$ids)) {
3313: my ($mapid,$resid)=split(/\./,$_);
3314: if (
3315: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
3316: eq $symb) {
3317: $okay=1;
3318: }
3319: }
3320: }
3321: untie(%bighash);
3322: }
3323: return $okay;
3324: }
3325:
3326: # --------------------------------------------------------------- Clean-up symb
3327:
3328: sub symbclean {
3329: my $symb=shift;
3330:
3331: # remove version from map
3332: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
3333:
3334: # remove version from URL
3335: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
3336:
3337: return $symb;
3338: }
3339:
3340: # ------------------------------------------------------ Return symb list entry
3341:
3342: sub symbread {
3343: my ($thisfn,$donotrecurse)=@_;
3344: # no filename provided? try from environment
3345: unless ($thisfn) {
3346: if ($ENV{'request.symb'}) { return &symbclean($ENV{'request.symb'}); }
3347: $thisfn=$ENV{'request.filename'};
3348: }
3349: # is that filename actually a symb? Verify, clean, and return
3350: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
3351: if (&symbverify($thisfn,$1)) { return &symbclean($thisfn); }
3352: }
3353: $thisfn=declutter($thisfn);
3354: my %hash;
3355: my %bighash;
3356: my $syval='';
3357: if (($ENV{'request.course.fn'}) && ($thisfn)) {
3358: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
3359: &GDBM_READER(),0640)) {
3360: $syval=$hash{$thisfn};
3361: untie(%hash);
3362: }
3363: # ---------------------------------------------------------- There was an entry
3364: if ($syval) {
3365: unless ($syval=~/\_\d+$/) {
3366: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
3367: &appenv('request.ambiguous' => $thisfn);
3368: return '';
3369: }
3370: $syval.=$1;
3371: }
3372: } else {
3373: # ------------------------------------------------------- Was not in symb table
3374: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
3375: &GDBM_READER(),0640)) {
3376: # ---------------------------------------------- Get ID(s) for current resource
3377: my $ids=$bighash{'ids_'.&clutter($thisfn)};
3378: unless ($ids) {
3379: $ids=$bighash{'ids_/'.$thisfn};
3380: }
3381: unless ($ids) {
3382: # alias?
3383: $ids=$bighash{'mapalias_'.$thisfn};
3384: }
3385: if ($ids) {
3386: # ------------------------------------------------------------------- Has ID(s)
3387: my @possibilities=split(/\,/,$ids);
3388: if ($#possibilities==0) {
3389: # ----------------------------------------------- There is only one possibility
3390: my ($mapid,$resid)=split(/\./,$ids);
3391: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
3392: } elsif (!$donotrecurse) {
3393: # ------------------------------------------ There is more than one possibility
3394: my $realpossible=0;
3395: foreach (@possibilities) {
3396: my $file=$bighash{'src_'.$_};
3397: if (&allowed('bre',$file)) {
3398: my ($mapid,$resid)=split(/\./,$_);
3399: if ($bighash{'map_type_'.$mapid} ne 'page') {
3400: $realpossible++;
3401: $syval=declutter($bighash{'map_id_'.$mapid}).
3402: '___'.$resid;
3403: }
3404: }
3405: }
3406: if ($realpossible!=1) { $syval=''; }
3407: } else {
3408: $syval='';
3409: }
3410: }
3411: untie(%bighash)
3412: }
3413: }
3414: if ($syval) {
3415: return &symbclean($syval.'___'.$thisfn);
3416: }
3417: }
3418: &appenv('request.ambiguous' => $thisfn);
3419: return '';
3420: }
3421:
3422: # ---------------------------------------------------------- Return random seed
3423:
3424: sub numval {
3425: my $txt=shift;
3426: $txt=~tr/A-J/0-9/;
3427: $txt=~tr/a-j/0-9/;
3428: $txt=~tr/K-T/0-9/;
3429: $txt=~tr/k-t/0-9/;
3430: $txt=~tr/U-Z/0-5/;
3431: $txt=~tr/u-z/0-5/;
3432: $txt=~s/\D//g;
3433: return int($txt);
3434: }
3435:
3436: sub rndseed {
3437: my ($symb,$courseid,$domain,$username)=@_;
3438: if (!$symb) {
3439: unless ($symb=&symbread()) { return time; }
3440: }
3441: if (!$courseid) { $courseid=$ENV{'request.course.id'};}
3442: if (!$domain) {$domain=$ENV{'user.domain'};}
3443: if (!$username) {$username=$ENV{'user.name'};}
3444: {
3445: use integer;
3446: my $symbchck=unpack("%32C*",$symb) << 27;
3447: my $symbseed=numval($symb) << 22;
3448: my $namechck=unpack("%32C*",$username) << 17;
3449: my $nameseed=numval($username) << 12;
3450: my $domainseed=unpack("%32C*",$domain) << 7;
3451: my $courseseed=unpack("%32C*",$courseid);
3452: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
3453: #uncommenting these lines can break things!
3454: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
3455: #&Apache::lonxml::debug("rndseed :$num:$symb");
3456: return $num;
3457: }
3458: }
3459:
3460: sub ireceipt {
3461: my ($funame,$fudom,$fucourseid,$fusymb)=@_;
3462: my $cuname=unpack("%32C*",$funame);
3463: my $cudom=unpack("%32C*",$fudom);
3464: my $cucourseid=unpack("%32C*",$fucourseid);
3465: my $cusymb=unpack("%32C*",$fusymb);
3466: my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
3467: return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
3468: ($cunique%$cuname+
3469: $cunique%$cudom+
3470: $cusymb%$cuname+
3471: $cusymb%$cudom+
3472: $cucourseid%$cuname+
3473: $cucourseid%$cudom);
3474: }
3475:
3476: sub receipt {
3477: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
3478: return &ireceipt($name,$domain,$courseid,$symb);
3479: }
3480:
3481: # ------------------------------------------------------------ Serves up a file
3482: # returns either the contents of the file or a -1
3483: sub getfile {
3484: my $file=shift;
3485: if ($file=~/^\/*uploaded\//) { # user file
3486: my $ua=new LWP::UserAgent;
3487: my $request=new HTTP::Request('GET',&tokenwrapper($file));
3488: my $response=$ua->request($request);
3489: if ($response->is_success()) {
3490: return $response->content;
3491: } else {
3492: return -1;
3493: }
3494: } else { # normal file from res space
3495: &repcopy($file);
3496: if (! -e $file ) { return -1; };
3497: my $fh=Apache::File->new($file);
3498: my $a='';
3499: while (<$fh>) { $a .=$_; }
3500: return $a;
3501: }
3502: }
3503:
3504: sub filelocation {
3505: my ($dir,$file) = @_;
3506: my $location;
3507: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
3508: if ($file=~m:^/~:) { # is a contruction space reference
3509: $location = $file;
3510: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
3511: } elsif ($file=~/^\/*uploaded/) { # is an uploaded file
3512: $location=$file;
3513: } else {
3514: $file=~s/^$perlvar{'lonDocRoot'}//;
3515: $file=~s:^/*res::;
3516: if ( !( $file =~ m:^/:) ) {
3517: $location = $dir. '/'.$file;
3518: } else {
3519: $location = '/home/httpd/html/res'.$file;
3520: }
3521: }
3522: $location=~s://+:/:g; # remove duplicate /
3523: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
3524: return $location;
3525: }
3526:
3527: sub hreflocation {
3528: my ($dir,$file)=@_;
3529: unless (($file=~/^http:\/\//i) || ($file=~/^\//)) {
3530: my $finalpath=filelocation($dir,$file);
3531: $finalpath=~s/^\/home\/httpd\/html//;
3532: $finalpath=~s-/home/(\w+)/public_html/-/~$1/-;
3533: return $finalpath;
3534: } else {
3535: return $file;
3536: }
3537: }
3538:
3539: # ------------------------------------------------------------- Declutters URLs
3540:
3541: sub declutter {
3542: my $thisfn=shift;
3543: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
3544: $thisfn=~s/^\///;
3545: $thisfn=~s/^res\///;
3546: $thisfn=~s/\?.+$//;
3547: return $thisfn;
3548: }
3549:
3550: # ------------------------------------------------------------- Clutter up URLs
3551:
3552: sub clutter {
3553: my $thisfn='/'.&declutter(shift);
3554: unless ($thisfn=~/^\/(uploaded|adm|userfiles|ext|raw|priv)\//) {
3555: $thisfn='/res'.$thisfn;
3556: }
3557: return $thisfn;
3558: }
3559:
3560: # -------------------------------------------------------- Escape Special Chars
3561:
3562: sub escape {
3563: my $str=shift;
3564: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
3565: return $str;
3566: }
3567:
3568: # ----------------------------------------------------- Un-Escape Special Chars
3569:
3570: sub unescape {
3571: my $str=shift;
3572: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3573: return $str;
3574: }
3575:
3576: # ================================================================ Main Program
3577:
3578: sub goodbye {
3579: &logthis("Starting Shut down");
3580: &flushcourselogs();
3581: &logthis("Shutting down");
3582: }
3583:
3584: BEGIN {
3585: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
3586: unless ($readit) {
3587: {
3588: my $config=Apache::File->new("/etc/httpd/conf/loncapa.conf");
3589:
3590: while (my $configline=<$config>) {
3591: if ($configline =~ /^[^\#]*PerlSetVar/) {
3592: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
3593: chomp($varvalue);
3594: $perlvar{$varname}=$varvalue;
3595: }
3596: }
3597: }
3598: {
3599: my $config=Apache::File->new("/etc/httpd/conf/loncapa_apache.conf");
3600:
3601: while (my $configline=<$config>) {
3602: if ($configline =~ /^[^\#]*PerlSetVar/) {
3603: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
3604: chomp($varvalue);
3605: $perlvar{$varname}=$varvalue;
3606: }
3607: }
3608: }
3609:
3610: # ------------------------------------------------------------ Read domain file
3611: {
3612: my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
3613: '/domain.tab');
3614: %domaindescription = ();
3615: %domain_auth_def = ();
3616: %domain_auth_arg_def = ();
3617: if ($fh) {
3618: while (<$fh>) {
3619: next if /^\#/;
3620: chomp;
3621: my ($domain, $domain_description, $def_auth, $def_auth_arg)
3622: = split(/:/,$_,4);
3623: $domain_auth_def{$domain}=$def_auth;
3624: $domain_auth_arg_def{$domain}=$def_auth_arg;
3625: $domaindescription{$domain}=$domain_description;
3626: # &logthis("Domain.tab: $domain, $domain_auth_def{$domain}, $domain_auth_arg_def{$domain},$domaindescription{$domain}");
3627: # &logthis("Domain.tab: $domain ".$domaindescription{$domain} );
3628: }
3629: }
3630: }
3631:
3632:
3633: # ------------------------------------------------------------- Read hosts file
3634: {
3635: my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
3636:
3637: while (my $configline=<$config>) {
3638: next if ($configline =~ /^(\#|\s*$)/);
3639: chomp($configline);
3640: my ($id,$domain,$role,$name,$ip,$domdescr)=split(/:/,$configline);
3641: if ($id && $domain && $role && $name && $ip) {
3642: $hostname{$id}=$name;
3643: $hostdom{$id}=$domain;
3644: $hostip{$id}=$ip;
3645: $iphost{$ip}=$id;
3646: if ($role eq 'library') { $libserv{$id}=$name; }
3647: } else {
3648: if ($configline) {
3649: &logthis("Skipping hosts.tab line -$configline-");
3650: }
3651: }
3652: }
3653: }
3654:
3655: # ------------------------------------------------------ Read spare server file
3656: {
3657: my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
3658:
3659: while (my $configline=<$config>) {
3660: chomp($configline);
3661: if ($configline) {
3662: $spareid{$configline}=1;
3663: }
3664: }
3665: }
3666: # ------------------------------------------------------------ Read permissions
3667: {
3668: my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
3669:
3670: while (my $configline=<$config>) {
3671: chomp($configline);
3672: if ($configline) {
3673: my ($role,$perm)=split(/ /,$configline);
3674: if ($perm ne '') { $pr{$role}=$perm; }
3675: }
3676: }
3677: }
3678:
3679: # -------------------------------------------- Read plain texts for permissions
3680: {
3681: my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
3682:
3683: while (my $configline=<$config>) {
3684: chomp($configline);
3685: if ($configline) {
3686: my ($short,$plain)=split(/:/,$configline);
3687: if ($plain ne '') { $prp{$short}=$plain; }
3688: }
3689: }
3690: }
3691:
3692: # ---------------------------------------------------------- Read package table
3693: {
3694: my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
3695:
3696: while (my $configline=<$config>) {
3697: chomp($configline);
3698: my ($short,$plain)=split(/:/,$configline);
3699: my ($pack,$name)=split(/\&/,$short);
3700: if ($plain ne '') {
3701: $packagetab{$pack.'&'.$name.'&name'}=$name;
3702: $packagetab{$short}=$plain;
3703: }
3704: }
3705: }
3706:
3707: # ------------- set up temporary directory
3708: {
3709: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
3710:
3711: }
3712:
3713: %metacache=();
3714:
3715: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
3716: $dumpcount=0;
3717:
3718: &logtouch();
3719: &logthis('<font color=yellow>INFO: Read configuration</font>');
3720: $readit=1;
3721: }
3722: }
3723:
3724: 1;
3725: __END__
3726:
3727: =pod
3728:
3729: =head1 NAME
3730:
3731: Apache::lonnet - Subroutines to ask questions about things in the network.
3732:
3733: =head1 SYNOPSIS
3734:
3735: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
3736:
3737: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
3738:
3739: Common parameters:
3740:
3741: =over 4
3742:
3743: =item *
3744:
3745: $uname : an internal username (if $cname expecting a course Id specifically)
3746:
3747: =item *
3748:
3749: $udom : a domain (if $cdom expecting a course's domain specifically)
3750:
3751: =item *
3752:
3753: $symb : a resource instance identifier
3754:
3755: =item *
3756:
3757: $namespace : the name of a .db file that contains the data needed or
3758: being set.
3759:
3760: =back
3761:
3762: =head1 INTRODUCTION
3763:
3764: This module provides subroutines which interact with the
3765: lonc/lond (TCP) network layer of LON-CAPA. And Can be used to ask about
3766: - classes
3767: - users
3768: - resources
3769:
3770: For many of these objects you can also use this to store data about
3771: them or modify them in various ways.
3772:
3773: This is part of the LearningOnline Network with CAPA project
3774: described at http://www.lon-capa.org.
3775:
3776: =head1 RETURN MESSAGES
3777:
3778: =over 4
3779:
3780: =item *
3781:
3782: con_lost : unable to contact remote host
3783:
3784: =item *
3785:
3786: con_delayed : unable to contact remote host, message will be delivered
3787: when the connection is brought back up
3788:
3789: =item *
3790:
3791: con_failed : unable to contact remote host and unable to save message
3792: for later delivery
3793:
3794: =item *
3795:
3796: error: : an error a occured, a description of the error follows the :
3797:
3798: =item *
3799:
3800: no_such_host : unable to fund a host associated with the user/domain
3801: that was requested
3802:
3803: =back
3804:
3805: =head1 PUBLIC SUBROUTINES
3806:
3807: =head2 Session Environment Functions
3808:
3809: =over 4
3810:
3811: =item *
3812:
3813: appenv(%hash) : the value of %hash is written to the user envirnoment
3814: file, and will be restored for each access this user makes during this
3815: session, also modifies the %ENV for the current process
3816:
3817: =item *
3818:
3819: 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.
3820:
3821: =back
3822:
3823: =head2 User Information
3824:
3825: =over 4
3826:
3827: =item *
3828:
3829: queryauthenticate($uname,$udom) : try to determine user's current
3830: authentication scheme
3831:
3832: =item *
3833:
3834: authenticate($uname,$upass,$udom) : try to authenticate user from domain's lib
3835: servers (first use the current one), $upass should be the users password
3836:
3837: =item *
3838:
3839: homeserver($uname,$udom) : find the server which has the user's
3840: directory and files (there must be only one), this caches the answer,
3841: and also caches if there is a borken connection.
3842:
3843: =item *
3844:
3845: idget($udom,@ids) : find the usernames behind a list of IDs (IDs are a
3846: unique resource in a domain, there must be only 1 ID per username, and
3847: only 1 username per ID in a specific domain) (returns hash:
3848: id=>name,id=>name)
3849:
3850: =item *
3851:
3852: idrget($udom,@unames) : find the IDs behind a list of usernames (returns hash:
3853: name=>id,name=>id)
3854:
3855: =item *
3856:
3857: idput($udom,%ids) : store away a list of names and associated IDs
3858:
3859: =item *
3860:
3861: rolesinit($udom,$username,$authhost) : get user privileges
3862:
3863: =item *
3864:
3865: usection($udom,$uname,$cname) : finds the section of student in the
3866: course $cname, return section name/number or '' for "not in course"
3867: and '-1' for "no section"
3868:
3869: =item *
3870:
3871: userenvironment($udom,$uname,@what) : gets the values of the keys
3872: passed in @what from the requested user's environment, returns a hash
3873:
3874: =back
3875:
3876: =head2 User Roles
3877:
3878: =over 4
3879:
3880: =item *
3881:
3882: allowed($priv,$uri) : check for a user privilege; returns codes for allowed
3883: actions
3884: F: full access
3885: U,I,K: authentication modes (cxx only)
3886: '': forbidden
3887: 1: user needs to choose course
3888: 2: browse allowed
3889:
3890: =item *
3891:
3892: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
3893: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
3894: and course level
3895:
3896: =item *
3897:
3898: plaintext($short) : return value in %prp hash (rolesplain.tab); plain text
3899: explanation of a user role term
3900:
3901: =back
3902:
3903: =head2 User Modification
3904:
3905: =over 4
3906:
3907: =item *
3908:
3909: assignrole($udom,$uname,$url,$role,$end,$start) : assign role; give a role to a
3910: user for the level given by URL. Optional start and end dates (leave empty
3911: string or zero for "no date")
3912:
3913: =item *
3914:
3915: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
3916: change a users, password, possible return values are: ok,
3917: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
3918: refused
3919:
3920: =item *
3921:
3922: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
3923:
3924: =item *
3925:
3926: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene) :
3927: modify user
3928:
3929: =item *
3930:
3931: modifystudent
3932:
3933: modify a students enrollment and identification information.
3934: The course id is resolved based on the current users environment.
3935: This means the envoking user must be a course coordinator or otherwise
3936: associated with a course.
3937:
3938: This call is essentially a wrapper for lonnet::modifyuser and
3939: lonnet::modify_student_enrollment
3940:
3941: Inputs:
3942:
3943: =over 4
3944:
3945: =item B<$udom> Students loncapa domain
3946:
3947: =item B<$uname> Students loncapa login name
3948:
3949: =item B<$uid> Students id/student number
3950:
3951: =item B<$umode> Students authentication mode
3952:
3953: =item B<$upass> Students password
3954:
3955: =item B<$first> Students first name
3956:
3957: =item B<$middle> Students middle name
3958:
3959: =item B<$last> Students last name
3960:
3961: =item B<$gene> Students generation
3962:
3963: =item B<$usec> Students section in course
3964:
3965: =item B<$end> Unix time of the roles expiration
3966:
3967: =item B<$start> Unix time of the roles start date
3968:
3969: =item B<$forceid> If defined, allow $uid to be changed
3970:
3971: =item B<$desiredhome> server to use as home server for student
3972:
3973: =back
3974:
3975: =item *
3976:
3977: modify_student_enrollment
3978:
3979: Change a students enrollment status in a class. The environment variable
3980: 'role.request.course' must be defined for this function to proceed.
3981:
3982: Inputs:
3983:
3984: =over 4
3985:
3986: =item $udom, students domain
3987:
3988: =item $uname, students name
3989:
3990: =item $uid, students user id
3991:
3992: =item $first, students first name
3993:
3994: =item $middle
3995:
3996: =item $last
3997:
3998: =item $gene
3999:
4000: =item $usec
4001:
4002: =item $end
4003:
4004: =item $start
4005:
4006: =back
4007:
4008:
4009: =item *
4010:
4011: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
4012: custom role; give a custom role to a user for the level given by URL. Specify
4013: name and domain of role author, and role name
4014:
4015: =item *
4016:
4017: revokerole($udom,$uname,$url,$role) : revoke a role for url
4018:
4019: =item *
4020:
4021: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
4022:
4023: =back
4024:
4025: =head2 Course Infomation
4026:
4027: =over 4
4028:
4029: =item *
4030:
4031: coursedescription($courseid) : course description
4032:
4033: =item *
4034:
4035: courseresdata($coursenum,$coursedomain,@which) : request for current
4036: parameter setting for a specific course, @what should be a list of
4037: parameters to ask about. This routine caches answers for 5 minutes.
4038:
4039: =back
4040:
4041: =head2 Course Modification
4042:
4043: =over 4
4044:
4045: =item *
4046:
4047: writecoursepref($courseid,%prefs) : write preferences (environment
4048: database) for a course
4049:
4050: =item *
4051:
4052: createcourse($udom,$description,$url) : make/modify course
4053:
4054: =back
4055:
4056: =head2 Resource Subroutines
4057:
4058: =over 4
4059:
4060: =item *
4061:
4062: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
4063:
4064: =item *
4065:
4066: repcopy($filename) : subscribes to the requested file, and attempts to
4067: replicate from the owning library server, Might return
4068: HTTP_SERVICE_UNAVAILABLE, HTTP_NOT_FOUND, FORBIDDEN, OK, or
4069: HTTP_BAD_REQUEST, also attempts to grab the metadata for the
4070: resource. Expects the local filesystem pathname
4071: (/home/httpd/html/res/....)
4072:
4073: =back
4074:
4075: =head2 Resource Information
4076:
4077: =over 4
4078:
4079: =item *
4080:
4081: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
4082: a vairety of different possible values, $varname should be a request
4083: string, and the other parameters can be used to specify who and what
4084: one is asking about.
4085:
4086: Possible values for $varname are environment.lastname (or other item
4087: from the envirnment hash), user.name (or someother aspect about the
4088: user), resource.0.maxtries (or some other part and parameter of a
4089: resource)
4090:
4091: =item *
4092:
4093: directcondval($number) : get current value of a condition; reads from a state
4094: string
4095:
4096: =item *
4097:
4098: condval($condidx) : value of condition index based on state
4099:
4100: =item *
4101:
4102: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
4103: resource's metadata, $what should be either a specific key, or either
4104: 'keys' (to get a list of possible keys) or 'packages' to get a list of
4105: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
4106:
4107: this function automatically caches all requests
4108:
4109: =item *
4110:
4111: metadata_query($query,$custom,$customshow) : make a metadata query against the
4112: network of library servers; returns file handle of where SQL and regex results
4113: will be stored for query
4114:
4115: =item *
4116:
4117: symbread($filename) : return symbolic list entry (filename argument optional);
4118: returns the data handle
4119:
4120: =item *
4121:
4122: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
4123: a possible symb for the URL in $thisfn, returns a 1 on success, 0 on
4124: failure, user must be in a course, as it assumes the existance of the
4125: course initi hash, and uses $ENV('request.course.id'}
4126:
4127:
4128: =item *
4129:
4130: symbclean($symb) : removes versions numbers from a symb, returns the
4131: cleaned symb
4132:
4133: =item *
4134:
4135: is_on_map($uri) : checks if the $uri is somewhere on the current
4136: course map, user must be in a course for it to work.
4137:
4138: =item *
4139:
4140: numval($salt) : return random seed value (addend for rndseed)
4141:
4142: =item *
4143:
4144: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
4145: a random seed, all arguments are optional, if they aren't sent it uses the
4146: environment to derive them. Note: if symb isn't sent and it can't get one
4147: from &symbread it will use the current time as its return value
4148:
4149: =item *
4150:
4151: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
4152: unfakeable, receipt
4153:
4154: =item *
4155:
4156: receipt() : API to ireceipt working off of ENV values; given out to users
4157:
4158: =item *
4159:
4160: countacc($url) : count the number of accesses to a given URL
4161:
4162: =item *
4163:
4164: 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
4165:
4166: =item *
4167:
4168: 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)
4169:
4170: =item *
4171:
4172: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
4173:
4174: =item *
4175:
4176: devalidate($symb) : devalidate temporary spreadsheet calculations,
4177: forcing spreadsheet to reevaluate the resource scores next time.
4178:
4179: =back
4180:
4181: =head2 Storing/Retreiving Data
4182:
4183: =over 4
4184:
4185: =item *
4186:
4187: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
4188: for this url; hashref needs to be given and should be a \%hashname; the
4189: remaining args aren't required and if they aren't passed or are '' they will
4190: be derived from the ENV
4191:
4192: =item *
4193:
4194: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
4195: uses critical subroutine
4196:
4197: =item *
4198:
4199: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
4200: all args are optional
4201:
4202: =item *
4203:
4204: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
4205: works very similar to store/cstore, but all data is stored in a
4206: temporary location and can be reset using tmpreset, $storehash should
4207: be a hash reference, returns nothing on success
4208:
4209: =item *
4210:
4211: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
4212: similar to restore, but all data is stored in a temporary location and
4213: can be reset using tmpreset. Returns a hash of values on success,
4214: error string otherwise.
4215:
4216: =item *
4217:
4218: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
4219: deltes all keys for $symb form the temporary storage hash.
4220:
4221: =item *
4222:
4223: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
4224: reference filled in from namesp ($udom and $uname are optional)
4225:
4226: =item *
4227:
4228: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
4229: namesp ($udom and $uname are optional)
4230:
4231: =item *
4232:
4233: dump($namespace,$udom,$uname,$regexp) :
4234: dumps the complete (or key matching regexp) namespace into a hash
4235: ($udom, $uname and $regexp are optional)
4236:
4237: =item *
4238:
4239: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
4240: ($udom and $uname are optional)
4241:
4242: =item *
4243:
4244: cput($namespace,$storehash,$udom,$uname) : critical put
4245: ($udom and $uname are optional)
4246:
4247: =item *
4248:
4249: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
4250: reference filled in from namesp (encrypts the return communication)
4251: ($udom and $uname are optional)
4252:
4253: =item *
4254:
4255: log($udom,$name,$home,$message) : write to permanent log for user; use
4256: critical subroutine
4257:
4258: =back
4259:
4260: =head2 Network Status Functions
4261:
4262: =over 4
4263:
4264: =item *
4265:
4266: dirlist($uri) : return directory list based on URI
4267:
4268: =item *
4269:
4270: spareserver() : find server with least workload from spare.tab
4271:
4272: =back
4273:
4274: =head2 Apache Request
4275:
4276: =over 4
4277:
4278: =item *
4279:
4280: ssi($url,%hash) : server side include, does a complete request cycle on url to
4281: localhost, posts hash
4282:
4283: =back
4284:
4285: =head2 Data to String to Data
4286:
4287: =over 4
4288:
4289: =item *
4290:
4291: hash2str(%hash) : convert a hash into a string complete with escaping and '='
4292: and '&' separators, supports elements that are arrayrefs and hashrefs
4293:
4294: =item *
4295:
4296: hashref2str($hashref) : convert a hashref into a string complete with
4297: escaping and '=' and '&' separators, supports elements that are
4298: arrayrefs and hashrefs
4299:
4300: =item *
4301:
4302: arrayref2str($arrayref) : convert an arrayref into a string complete
4303: with escaping and '&' separators, supports elements that are arrayrefs
4304: and hashrefs
4305:
4306: =item *
4307:
4308: str2hash($string) : convert string to hash using unescaping and
4309: splitting on '=' and '&', supports elements that are arrayrefs and
4310: hashrefs
4311:
4312: =item *
4313:
4314: str2array($string) : convert string to hash using unescaping and
4315: splitting on '&', supports elements that are arrayrefs and hashrefs
4316:
4317: =back
4318:
4319: =head2 Logging Routines
4320:
4321: =over 4
4322:
4323: These routines allow one to make log messages in the lonnet.log and
4324: lonnet.perm logfiles.
4325:
4326: =item *
4327:
4328: logtouch() : make sure the logfile, lonnet.log, exists
4329:
4330: =item *
4331:
4332: logthis() : append message to the normal lonnet.log file, it gets
4333: preiodically rolled over and deleted.
4334:
4335: =item *
4336:
4337: logperm() : append a permanent message to lonnet.perm.log, this log
4338: file never gets deleted by any automated portion of the system, only
4339: messages of critical importance should go in here.
4340:
4341: =back
4342:
4343: =head2 General File Helper Routines
4344:
4345: =over 4
4346:
4347: =item *
4348:
4349: getfile($file) : returns the entire contents of a file or -1; it
4350: properly subscribes to and replicates the file if neccessary.
4351:
4352: =item *
4353:
4354: filelocation($dir,$file) : returns file system location of a file
4355: based on URI; meant to be "fairly clean" absolute reference, $dir is a
4356: directory that relative $file lookups are to looked in ($dir of /a/dir
4357: and a file of ../bob will become /a/bob)
4358:
4359: =item *
4360:
4361: hreflocation($dir,$file) : returns file system location or a URL; same as
4362: filelocation except for hrefs
4363:
4364: =item *
4365:
4366: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
4367:
4368: =back
4369:
4370: =head2 HTTP Helper Routines
4371:
4372: =over 4
4373:
4374: =item *
4375:
4376: escape() : unpack non-word characters into CGI-compatible hex codes
4377:
4378: =item *
4379:
4380: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
4381:
4382: =back
4383:
4384: =head1 PRIVATE SUBROUTINES
4385:
4386: =head2 Underlying communication routines (Shouldn't call)
4387:
4388: =over 4
4389:
4390: =item *
4391:
4392: subreply() : tries to pass a message to lonc, returns con_lost if incapable
4393:
4394: =item *
4395:
4396: reply() : uses subreply to send a message to remote machine, logs all failures
4397:
4398: =item *
4399:
4400: critical() : passes a critical message to another server; if cannot
4401: get through then place message in connection buffer directory and
4402: returns con_delayed, if incapable of saving message, returns
4403: con_failed
4404:
4405: =item *
4406:
4407: reconlonc() : tries to reconnect lonc client processes.
4408:
4409: =back
4410:
4411: =head2 Resource Access Logging
4412:
4413: =over 4
4414:
4415: =item *
4416:
4417: flushcourselogs() : flush (save) buffer logs and access logs
4418:
4419: =item *
4420:
4421: courselog($what) : save message for course in hash
4422:
4423: =item *
4424:
4425: courseacclog($what) : save message for course using &courselog(). Perform
4426: special processing for specific resource types (problems, exams, quizzes, etc).
4427:
4428: =item *
4429:
4430: goodbye() : flush course logs and log shutting down; it is called in srm.conf
4431: as a PerlChildExitHandler
4432:
4433: =back
4434:
4435: =head2 Other
4436:
4437: =over 4
4438:
4439: =item *
4440:
4441: symblist($mapname,%newhash) : update symbolic storage links
4442:
4443: =back
4444:
4445: =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