Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.74
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
4: # Functions for use by content handlers:
5: #
6: # plaintext(short) : plain text explanation of short term
1.25 www 7: # fileembstyle(ext) : embed style in page for file extension
8: # filedescription(ext) : descriptor text for file extension
1.29 www 9: # allowed(short,url) : returns codes for allowed actions
10: # F: full access
11: # U,I,K: authentication modes (cxx only)
12: # '': forbidden
13: # 1: user needs to choose course
14: # 2: browse allowed
1.21 www 15: # definerole(rolename,sys,dom,cou) : define a custom role rolename
16: # set priviledges in format of lonTabs/roles.tab for
17: # system, domain and course level,
18: # assignrole(udom,uname,url,role,end,start) : give a role to a user for the
19: # level given by url. Optional start and end dates
20: # (leave empty string or zero for "no date")
21: # assigncustomrole (udom,uname,url,rdom,rnam,rolename,end,start) : give a
22: # custom role to a user for the level given by url.
23: # Specify name and domain of role author, and role name
24: # revokerole (udom,uname,url,role) : Revoke a role for url
25: # revokecustomrole (udom,uname,url,rdom,rnam,rolename) : Revoke a custom role
1.24 www 26: # appenv(hash) : adds hash to session environment
1.56 www 27: # delenv(varname) : deletes all environment entries starting with varname
1.12 www 28: # store(hash) : stores hash permanently for this url
1.47 www 29: # cstore(hash) : critical store
1.12 www 30: # restore : returns hash for this url
31: # eget(namesp,array) : returns hash with keys from array filled in from namesp
32: # get(namesp,array) : returns hash with keys from array filled in from namesp
1.38 www 33: # del(namesp,array) : deletes keys out of array from namesp
1.12 www 34: # put(namesp,hash) : stores hash in namesp
1.47 www 35: # cput(namesp,hash) : critical put
1.15 www 36: # dump(namesp) : dumps the complete namespace into a hash
1.23 www 37: # ssi(url,hash) : does a complete request cycle on url to localhost, posts
38: # hash
1.34 www 39: # coursedescription(id) : returns and caches course description for id
1.17 www 40: # repcopy(filename) : replicate file
41: # dirlist(url) : gets a directory listing
1.40 www 42: # directcondval(index) : reading condition value of single condition from
43: # state string
1.28 www 44: # condval(index) : value of condition index based on state
1.58 www 45: # EXT(name) : value of a variable
1.31 www 46: # symblist(map,hash) : Updates symbolic storage links
1.44 www 47: # symbread([filename]) : returns the data handle (filename optional)
1.31 www 48: # rndseed() : returns a random seed
1.36 albertel 49: # getfile(filename) : returns the contents of filename, or a -1 if it can't
50: # be found, replicates and subscribes to the file
51: # filelocation(dir,file) : returns a farily clean absolute reference to file
52: # from the directory dir
1.46 www 53: # hreflocation(dir,file) : same as filelocation, but for hrefs
1.47 www 54: # log(domain,user,home,msg) : write to permanent log for user
1.70 www 55: # usection(domain,user,courseid) : output of section name/number or '' for
56: # "not in course" and '-1' for "no section"
57: # userenvironment(domain,user,what) : puts out any environment parameter
58: # for a user
59: # idput(domain,hash) : writes IDs for users from hash (name=>id,name=>id)
60: # idget(domain,array): returns hash with usernames (id=>name,id=>name) for
61: # an array of IDs
62: # idrget(domain,array): returns hash with IDs for usernames (name=>id,...) for
63: # an array of names
1.73 www 64: # metadata(file,entry): returns the metadata entry for a file. entry='keys'
65: # returns a comma separated list of keys
1.12 www 66: #
1.1 albertel 67: # 6/1/99,6/2,6/10,6/11,6/12,6/14,6/26,6/28,6/29,6/30,
1.5 www 68: # 7/1,7/2,7/9,7/10,7/12,7/14,7/15,7/19,
1.8 www 69: # 11/8,11/16,11/18,11/22,11/23,12/22,
1.12 www 70: # 01/06,01/13,02/24,02/28,02/29,
71: # 03/01,03/02,03/06,03/07,03/13,
1.15 www 72: # 04/05,05/29,05/31,06/01,
73: # 06/05,06/26 Gerd Kortemeyer
74: # 06/26 Ben Tyszka
1.22 www 75: # 06/30,07/15,07/17,07/18,07/20,07/21,07/22,07/25 Gerd Kortemeyer
1.23 www 76: # 08/14 Ben Tyszka
1.36 albertel 77: # 08/22,08/28,08/31,09/01,09/02,09/04,09/05,09/25,09/28,09/30 Gerd Kortemeyer
1.35 www 78: # 10/04 Gerd Kortemeyer
1.36 albertel 79: # 10/04 Guy Albertelli
1.54 www 80: # 10/06,10/09,10/10,10/11,10/14,10/20,10/23,10/25,10/26,10/27,10/28,10/29,
1.71 www 81: # 10/30,10/31,
82: # 11/2,11/14,11/15,11/16,11/20,11/21,11/22,11/25,11/27 Gerd Kortemeyer
1.1 albertel 83:
84: package Apache::lonnet;
85:
86: use strict;
87: use Apache::File;
1.8 www 88: use LWP::UserAgent();
1.15 www 89: use HTTP::Headers;
1.11 www 90: use vars
1.71 www 91: qw(%perlvar %hostname %homecache %spareid %hostdom %libserv %pr %prp %fe %fd $readit %metacache);
1.1 albertel 92: use IO::Socket;
1.31 www 93: use GDBM_File;
1.8 www 94: use Apache::Constants qw(:common :http);
1.71 www 95: use HTML::TokeParser;
1.1 albertel 96:
97: # --------------------------------------------------------------------- Logging
98:
99: sub logthis {
100: my $message=shift;
101: my $execdir=$perlvar{'lonDaemons'};
102: my $now=time;
103: my $local=localtime($now);
104: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
105: print $fh "$local ($$): $message\n";
106: return 1;
107: }
108:
109: sub logperm {
110: my $message=shift;
111: my $execdir=$perlvar{'lonDaemons'};
112: my $now=time;
113: my $local=localtime($now);
114: my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
115: print $fh "$now:$message:$local\n";
116: return 1;
117: }
118:
119: # -------------------------------------------------- Non-critical communication
120: sub subreply {
121: my ($cmd,$server)=@_;
122: my $peerfile="$perlvar{'lonSockDir'}/$server";
123: my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
124: Type => SOCK_STREAM,
125: Timeout => 10)
126: or return "con_lost";
127: print $client "$cmd\n";
128: my $answer=<$client>;
1.9 www 129: if (!$answer) { $answer="con_lost"; }
1.1 albertel 130: chomp($answer);
131: return $answer;
132: }
133:
134: sub reply {
135: my ($cmd,$server)=@_;
136: my $answer=subreply($cmd,$server);
137: if ($answer eq 'con_lost') { $answer=subreply($cmd,$server); }
1.65 www 138: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.12 www 139: &logthis("<font color=blue>WARNING:".
140: " $cmd to $server returned $answer</font>");
141: }
1.1 albertel 142: return $answer;
143: }
144:
145: # ----------------------------------------------------------- Send USR1 to lonc
146:
147: sub reconlonc {
148: my $peerfile=shift;
149: &logthis("Trying to reconnect for $peerfile");
150: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
151: if (my $fh=Apache::File->new("$loncfile")) {
152: my $loncpid=<$fh>;
153: chomp($loncpid);
154: if (kill 0 => $loncpid) {
155: &logthis("lonc at pid $loncpid responding, sending USR1");
156: kill USR1 => $loncpid;
157: sleep 1;
158: if (-e "$peerfile") { return; }
159: &logthis("$peerfile still not there, give it another try");
160: sleep 5;
161: if (-e "$peerfile") { return; }
1.12 www 162: &logthis(
163: "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
1.1 albertel 164: } else {
1.12 www 165: &logthis(
166: "<font color=blue>WARNING:".
167: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 168: }
169: } else {
1.12 www 170: &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
1.1 albertel 171: }
172: }
173:
174: # ------------------------------------------------------ Critical communication
1.12 www 175:
1.1 albertel 176: sub critical {
177: my ($cmd,$server)=@_;
178: my $answer=reply($cmd,$server);
179: if ($answer eq 'con_lost') {
180: my $pingreply=reply('ping',$server);
181: &reconlonc("$perlvar{'lonSockDir'}/$server");
182: my $pongreply=reply('pong',$server);
183: &logthis("Ping/Pong for $server: $pingreply/$pongreply");
184: $answer=reply($cmd,$server);
185: if ($answer eq 'con_lost') {
186: my $now=time;
187: my $middlename=$cmd;
1.5 www 188: $middlename=substr($middlename,0,16);
1.1 albertel 189: $middlename=~s/\W//g;
190: my $dfilename=
191: "$perlvar{'lonSockDir'}/delayed/$now.$middlename.$server";
192: {
193: my $dfh;
194: if ($dfh=Apache::File->new(">$dfilename")) {
1.7 www 195: print $dfh "$cmd\n";
1.1 albertel 196: }
197: }
198: sleep 2;
199: my $wcmd='';
200: {
201: my $dfh;
202: if ($dfh=Apache::File->new("$dfilename")) {
203: $wcmd=<$dfh>;
204: }
205: }
206: chomp($wcmd);
1.7 www 207: if ($wcmd eq $cmd) {
1.12 www 208: &logthis("<font color=blue>WARNING: ".
209: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 210: &logperm("D:$server:$cmd");
211: return 'con_delayed';
212: } else {
1.12 www 213: &logthis("<font color=red>CRITICAL:"
214: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 215: &logperm("F:$server:$cmd");
216: return 'con_failed';
217: }
218: }
219: }
220: return $answer;
221: }
222:
1.5 www 223: # ---------------------------------------------------------- Append Environment
224:
225: sub appenv {
1.6 www 226: my %newenv=@_;
1.35 www 227: map {
228: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
229: &logthis("<font color=blue>WARNING: ".
230: "Attempt to modify environment ".$_." to ".$newenv{$_});
231: delete($newenv{$_});
232: } else {
233: $ENV{$_}=$newenv{$_};
234: }
235: } keys %newenv;
1.6 www 236: my @oldenv;
237: {
238: my $fh;
239: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
1.5 www 240: return 'error';
1.6 www 241: }
242: @oldenv=<$fh>;
243: }
244: for (my $i=0; $i<=$#oldenv; $i++) {
245: chomp($oldenv[$i]);
1.9 www 246: if ($oldenv[$i] ne '') {
247: my ($name,$value)=split(/=/,$oldenv[$i]);
1.24 www 248: unless (defined($newenv{$name})) {
249: $newenv{$name}=$value;
250: }
1.9 www 251: }
1.6 www 252: }
253: {
254: my $fh;
255: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
256: return 'error';
257: }
258: my $newname;
259: foreach $newname (keys %newenv) {
260: print $fh "$newname=$newenv{$newname}\n";
261: }
1.56 www 262: }
263: return 'ok';
264: }
265: # ----------------------------------------------------- Delete from Environment
266:
267: sub delenv {
268: my $delthis=shift;
269: my %newenv=();
270: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
271: &logthis("<font color=blue>WARNING: ".
272: "Attempt to delete from environment ".$delthis);
273: return 'error';
274: }
275: my @oldenv;
276: {
277: my $fh;
278: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
279: return 'error';
280: }
281: @oldenv=<$fh>;
282: }
283: {
284: my $fh;
285: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
286: return 'error';
287: }
288: map {
289: unless ($_=~/^$delthis/) { print $fh $_; }
290: } @oldenv;
1.5 www 291: }
292: return 'ok';
293: }
1.1 albertel 294:
295: # ------------------------------ Find server with least workload from spare.tab
1.11 www 296:
1.1 albertel 297: sub spareserver {
298: my $tryserver;
299: my $spareserver='';
300: my $lowestserver=100;
301: foreach $tryserver (keys %spareid) {
302: my $answer=reply('load',$tryserver);
303: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
304: $spareserver="http://$hostname{$tryserver}";
305: $lowestserver=$answer;
306: }
307: }
308: return $spareserver;
309: }
310:
311: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 312:
1.1 albertel 313: sub authenticate {
314: my ($uname,$upass,$udom)=@_;
1.12 www 315: $upass=escape($upass);
1.1 albertel 316: if (($perlvar{'lonRole'} eq 'library') &&
317: ($udom eq $perlvar{'lonDefDomain'})) {
1.3 www 318: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
1.2 www 319: if ($answer =~ /authorized/) {
1.9 www 320: if ($answer eq 'authorized') {
321: &logthis("User $uname at $udom authorized by local server");
322: return $perlvar{'lonHostID'};
323: }
324: if ($answer eq 'non_authorized') {
325: &logthis("User $uname at $udom rejected by local server");
326: return 'no_host';
327: }
1.2 www 328: }
1.1 albertel 329: }
330:
331: my $tryserver;
332: foreach $tryserver (keys %libserv) {
333: if ($hostdom{$tryserver} eq $udom) {
1.10 www 334: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
1.1 albertel 335: if ($answer =~ /authorized/) {
1.9 www 336: if ($answer eq 'authorized') {
337: &logthis("User $uname at $udom authorized by $tryserver");
338: return $tryserver;
339: }
340: if ($answer eq 'non_authorized') {
341: &logthis("User $uname at $udom rejected by $tryserver");
342: return 'no_host';
343: }
1.1 albertel 344: }
345: }
1.9 www 346: }
347: &logthis("User $uname at $udom could not be authenticated");
1.1 albertel 348: return 'no_host';
349: }
350:
351: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 352:
1.1 albertel 353: sub homeserver {
354: my ($uname,$udom)=@_;
355:
356: my $index="$uname:$udom";
357: if ($homecache{$index}) { return "$homecache{$index}"; }
358:
359: my $tryserver;
360: foreach $tryserver (keys %libserv) {
361: if ($hostdom{$tryserver} eq $udom) {
362: my $answer=reply("home:$udom:$uname",$tryserver);
363: if ($answer eq 'found') {
364: $homecache{$index}=$tryserver;
365: return $tryserver;
366: }
367: }
368: }
369: return 'no_host';
1.70 www 370: }
371:
372: # ------------------------------------- Find the usernames behind a list of IDs
373:
374: sub idget {
375: my ($udom,@ids)=@_;
376: my %returnhash=();
377:
378: my $tryserver;
379: foreach $tryserver (keys %libserv) {
380: if ($hostdom{$tryserver} eq $udom) {
381: my $idlist=join('&',@ids);
382: $idlist=~tr/A-Z/a-z/;
383: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
384: my @answer=();
385: if ($reply ne 'con_lost') {
386: @answer=split(/\&/,$reply);
387: } ;
388: my $i;
389: for ($i=0;$i<=$#ids;$i++) {
390: if ($answer[$i]) {
391: $returnhash{$ids[$i]}=$answer[$i];
392: }
393: }
394: }
395: }
396: return %returnhash;
397: }
398:
399: # ------------------------------------- Find the IDs behind a list of usernames
400:
401: sub idrget {
402: my ($udom,@unames)=@_;
403: my %returnhash=();
404: map {
405: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
406: } @unames;
407: return %returnhash;
408: }
409:
410: # ------------------------------- Store away a list of names and associated IDs
411:
412: sub idput {
413: my ($udom,%ids)=@_;
414: my %servers=();
415: map {
416: my $uhom=&homeserver($_,$udom);
417: if ($uhom ne 'no_host') {
418: my $id=&escape($ids{$_});
419: $id=~tr/A-Z/a-z/;
420: my $unam=&escape($_);
421: if ($servers{$uhom}) {
422: $servers{$uhom}.='&'.$id.'='.$unam;
423: } else {
424: $servers{$uhom}=$id.'='.$unam;
425: }
426: &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
427: }
428: } keys %ids;
429: map {
430: &critical('idput:'.$udom.':'.$servers{$_},$_);
431: } keys %servers;
432: }
433:
434: # ------------------------------------- Find the section of student in a course
435:
436: sub usection {
437: my ($udom,$unam,$courseid)=@_;
438: $courseid=~s/\_/\//g;
439: $courseid=~s/^(\w)/\/$1/;
440: map {
441: my ($key,$value)=split(/\=/,$_);
442: $key=&unescape($key);
443: if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
444: my $section=$1;
445: if ($key eq $courseid.'_st') { $section=''; }
446: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
447: my $now=time;
448: my $notactive=0;
449: if ($start) {
450: if ($now<$start) { $notactive=1; }
451: }
452: if ($end) {
453: if ($now>$end) { $notactive=1; }
454: }
455: unless ($notactive) { return $section; }
456: }
457: } split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
458: &homeserver($unam,$udom)));
459: return '-1';
460: }
461:
462: # ------------------------------------- Read an entry from a user's environment
463:
464: sub userenvironment {
465: my ($udom,$unam,@what)=@_;
466: my %returnhash=();
467: my @answer=split(/\&/,
468: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
469: &homeserver($unam,$udom)));
470: my $i;
471: for ($i=0;$i<=$#what;$i++) {
472: $returnhash{$what[$i]}=&unescape($answer[$i]);
473: }
474: return %returnhash;
1.1 albertel 475: }
476:
477: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 478:
1.1 albertel 479: sub subscribe {
480: my $fname=shift;
481: my $author=$fname;
482: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
483: my ($udom,$uname)=split(/\//,$author);
484: my $home=homeserver($uname,$udom);
485: if (($home eq 'no_host') || ($home eq $perlvar{'lonHostID'})) {
486: return 'not_found';
487: }
488: my $answer=reply("sub:$fname",$home);
1.64 www 489: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
490: $answer.=' by '.$home;
491: }
1.1 albertel 492: return $answer;
493: }
494:
1.8 www 495: # -------------------------------------------------------------- Replicate file
496:
497: sub repcopy {
498: my $filename=shift;
1.23 www 499: $filename=~s/\/+/\//g;
1.8 www 500: my $transname="$filename.in.transfer";
1.17 www 501: if ((-e $filename) || (-e $transname)) { return OK; }
1.8 www 502: my $remoteurl=subscribe($filename);
1.64 www 503: if ($remoteurl =~ /^con_lost by/) {
504: &logthis("Subscribe returned $remoteurl: $filename");
1.8 www 505: return HTTP_SERVICE_UNAVAILABLE;
506: } elsif ($remoteurl eq 'not_found') {
507: &logthis("Subscribe returned not_found: $filename");
508: return HTTP_NOT_FOUND;
1.64 www 509: } elsif ($remoteurl =~ /^rejected by/) {
510: &logthis("Subscribe returned $remoteurl: $filename");
1.8 www 511: return FORBIDDEN;
1.20 www 512: } elsif ($remoteurl eq 'directory') {
513: return OK;
1.8 www 514: } else {
515: my @parts=split(/\//,$filename);
516: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
517: if ($path ne "$perlvar{'lonDocRoot'}/res") {
518: &logthis("Malconfiguration for replication: $filename");
519: return HTTP_BAD_REQUEST;
520: }
521: my $count;
522: for ($count=5;$count<$#parts;$count++) {
523: $path.="/$parts[$count]";
524: if ((-e $path)!=1) {
525: mkdir($path,0777);
526: }
527: }
528: my $ua=new LWP::UserAgent;
529: my $request=new HTTP::Request('GET',"$remoteurl");
530: my $response=$ua->request($request,$transname);
531: if ($response->is_error()) {
532: unlink($transname);
533: my $message=$response->status_line;
1.12 www 534: &logthis("<font color=blue>WARNING:"
535: ." LWP get: $message: $filename</font>");
1.8 www 536: return HTTP_SERVICE_UNAVAILABLE;
537: } else {
1.16 www 538: if ($remoteurl!~/\.meta$/) {
539: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
540: my $mresponse=$ua->request($mrequest,$filename.'.meta');
541: if ($mresponse->is_error()) {
542: unlink($filename.'.meta');
543: &logthis(
544: "<font color=yellow>INFO: No metadata: $filename</font>");
545: }
546: }
1.8 www 547: rename($transname,$filename);
548: return OK;
549: }
550: }
551: }
552:
1.15 www 553: # --------------------------------------------------------- Server Side Include
554:
555: sub ssi {
556:
1.23 www 557: my ($fn,%form)=@_;
1.15 www 558:
559: my $ua=new LWP::UserAgent;
1.23 www 560:
561: my $request;
562:
563: if (%form) {
564: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
565: $request->content(join '&', map { "$_=$form{$_}" } keys %form);
566: } else {
567: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
568: }
569:
1.15 www 570: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
571: my $response=$ua->request($request);
572:
573: return $response->content;
574: }
575:
1.14 www 576: # ------------------------------------------------------------------------- Log
577:
578: sub log {
579: my ($dom,$nam,$hom,$what)=@_;
1.47 www 580: return critical("log:$dom:$nam:$what",$hom);
1.14 www 581: }
582:
1.9 www 583: # ----------------------------------------------------------------------- Store
584:
585: sub store {
1.31 www 586: my %storehash=@_;
587: my $symb;
1.44 www 588: unless ($symb=escape(&symbread())) { return ''; }
1.31 www 589: my $namespace;
1.33 www 590: unless ($namespace=$ENV{'request.course.id'}) { return ''; }
1.12 www 591: my $namevalue='';
592: map {
593: $namevalue.=escape($_).'='.escape($storehash{$_}).'&';
594: } keys %storehash;
595: $namevalue=~s/\&$//;
1.31 www 596: return reply(
597: "store:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$symb:$namevalue",
1.12 www 598: "$ENV{'user.home'}");
1.9 www 599: }
600:
1.47 www 601: # -------------------------------------------------------------- Critical Store
602:
603: sub cstore {
604: my %storehash=@_;
605: my $symb;
606: unless ($symb=escape(&symbread())) { return ''; }
607: my $namespace;
608: unless ($namespace=$ENV{'request.course.id'}) { return ''; }
609: my $namevalue='';
610: map {
611: $namevalue.=escape($_).'='.escape($storehash{$_}).'&';
612: } keys %storehash;
613: $namevalue=~s/\&$//;
614: return critical(
615: "store:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$symb:$namevalue",
616: "$ENV{'user.home'}");
617: }
618:
1.9 www 619: # --------------------------------------------------------------------- Restore
620:
621: sub restore {
1.31 www 622: my $symb;
1.44 www 623: unless ($symb=escape(&symbread())) { return ''; }
1.31 www 624: my $namespace;
1.33 www 625: unless ($namespace=$ENV{'request.course.id'}) { return ''; }
1.31 www 626: my $answer=reply(
627: "restore:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$symb",
628: "$ENV{'user.home'}");
1.12 www 629: my %returnhash=();
630: map {
631: my ($name,$value)=split(/\=/,$_);
632: $returnhash{&unescape($name)}=&unescape($value);
633: } split(/\&/,$answer);
1.31 www 634: map {
635: $returnhash{$_}=$returnhash{$returnhash{'version'}.':'.$_};
636: } split(/\:/,$returnhash{$returnhash{'version'}.':keys'});
1.13 www 637: return %returnhash;
1.34 www 638: }
639:
640: # ---------------------------------------------------------- Course Description
641:
642: sub coursedescription {
643: my $courseid=shift;
644: $courseid=~s/^\///;
1.49 www 645: $courseid=~s/\_/\//g;
1.34 www 646: my ($cdomain,$cnum)=split(/\//,$courseid);
647: my $chome=homeserver($cnum,$cdomain);
648: if ($chome ne 'no_host') {
649: my $rep=reply("dump:$cdomain:$cnum:environment",$chome);
650: if ($rep ne 'con_lost') {
1.54 www 651: my $normalid=$courseid;
652: $normalid=~s/\//\_/g;
1.53 www 653: my %envhash=();
1.34 www 654: my %returnhash=('home' => $chome,
655: 'domain' => $cdomain,
656: 'num' => $cnum);
657: map {
658: my ($name,$value)=split(/\=/,$_);
659: $name=&unescape($name);
660: $value=&unescape($value);
661: $returnhash{$name}=$value;
1.53 www 662: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.34 www 663: } split(/\&/,$rep);
664: $returnhash{'url'}='/res/'.declutter($returnhash{'url'});
665: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.38 www 666: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.54 www 667: $envhash{'course.'.$normalid.'.last_cache'}=time;
1.60 www 668: $envhash{'course.'.$normalid.'.home'}=$chome;
669: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
670: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.53 www 671: &appenv(%envhash);
1.34 www 672: return %returnhash;
673: }
674: }
675: return ();
1.9 www 676: }
1.1 albertel 677:
1.11 www 678: # -------------------------------------------------------- Get user priviledges
679:
680: sub rolesinit {
681: my ($domain,$username,$authhost)=@_;
682: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 683: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 684: my %allroles=();
685: my %thesepriv=();
686: my $now=time;
1.21 www 687: my $userroles="user.login.time=$now\n";
1.11 www 688: my $thesestr;
689:
690: if ($rolesdump ne '') {
691: map {
1.21 www 692: if ($_!~/^rolesdef\&/) {
1.11 www 693: my ($area,$role)=split(/=/,$_);
1.21 www 694: $area=~s/\_\w\w$//;
1.11 www 695: my ($trole,$tend,$tstart)=split(/_/,$role);
1.21 www 696: $userroles.='user.role.'.$trole.'.'.$area.'='.
697: $tstart.'.'.$tend."\n";
1.11 www 698: if ($tend!=0) {
699: if ($tend<$now) {
700: $trole='';
701: }
702: }
703: if ($tstart!=0) {
704: if ($tstart>$now) {
705: $trole='';
706: }
707: }
708: if (($area ne '') && ($trole ne '')) {
1.50 www 709: my $spec=$trole.'.'.$area;
1.12 www 710: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
711: if ($trole =~ /^cr\//) {
712: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
713: my $homsvr=homeserver($rauthor,$rdomain);
714: if ($hostname{$homsvr} ne '') {
715: my $roledef=
1.21 www 716: reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
1.12 www 717: $homsvr);
718: if (($roledef ne 'con_lost') && ($roledef ne '')) {
719: my ($syspriv,$dompriv,$coursepriv)=
1.21 www 720: split(/\_/,unescape($roledef));
1.50 www 721: $allroles{'cm./'}.=':'.$syspriv;
722: $allroles{$spec.'./'}.=':'.$syspriv;
1.12 www 723: if ($tdomain ne '') {
1.50 www 724: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
725: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
1.12 www 726: if ($trest ne '') {
1.50 www 727: $allroles{'cm.'.$area}.=':'.$coursepriv;
728: $allroles{$spec.'.'.$area}.=':'.$coursepriv;
1.12 www 729: }
730: }
731: }
1.11 www 732: }
1.12 www 733: } else {
1.50 www 734: $allroles{'cm./'}.=':'.$pr{$trole.':s'};
735: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
1.12 www 736: if ($tdomain ne '') {
1.50 www 737: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
738: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1.12 www 739: if ($trest ne '') {
1.50 www 740: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
741: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
1.12 www 742: }
743: }
1.11 www 744: }
1.12 www 745: }
746: }
1.11 www 747: } split(/&/,$rolesdump);
748: map {
749: %thesepriv=();
750: map {
751: if ($_ ne '') {
752: my ($priviledge,$restrictions)=split(/&/,$_);
753: if ($restrictions eq '') {
754: $thesepriv{$priviledge}='F';
755: } else {
756: if ($thesepriv{$priviledge} ne 'F') {
757: $thesepriv{$priviledge}.=$restrictions;
758: }
759: }
760: }
761: } split(/:/,$allroles{$_});
762: $thesestr='';
763: map { $thesestr.=':'.$_.'&'.$thesepriv{$_}; } keys %thesepriv;
764: $userroles.='user.priv.'.$_.'='.$thesestr."\n";
765: } keys %allroles;
766: }
767: return $userroles;
768: }
769:
1.12 www 770: # --------------------------------------------------------------- get interface
771:
772: sub get {
773: my ($namespace,@storearr)=@_;
774: my $items='';
775: map {
776: $items.=escape($_).'&';
777: } @storearr;
778: $items=~s/\&$//;
779: my $rep=reply("get:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
780: $ENV{'user.home'});
1.15 www 781: my @pairs=split(/\&/,$rep);
782: my %returnhash=();
1.42 www 783: my $i=0;
1.15 www 784: map {
1.42 www 785: $returnhash{$_}=unescape($pairs[$i]);
786: $i++;
787: } @storearr;
1.15 www 788: return %returnhash;
1.27 www 789: }
790:
791: # --------------------------------------------------------------- del interface
792:
793: sub del {
794: my ($namespace,@storearr)=@_;
795: my $items='';
796: map {
797: $items.=escape($_).'&';
798: } @storearr;
799: $items=~s/\&$//;
800: return reply("del:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
801: $ENV{'user.home'});
1.15 www 802: }
803:
804: # -------------------------------------------------------------- dump interface
805:
806: sub dump {
807: my $namespace=shift;
808: my $rep=reply("dump:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace",
809: $ENV{'user.home'});
1.12 www 810: my @pairs=split(/\&/,$rep);
811: my %returnhash=();
812: map {
813: my ($key,$value)=split(/=/,$_);
1.29 www 814: $returnhash{unescape($key)}=unescape($value);
1.12 www 815: } @pairs;
816: return %returnhash;
817: }
818:
819: # --------------------------------------------------------------- put interface
820:
821: sub put {
822: my ($namespace,%storehash)=@_;
823: my $items='';
824: map {
825: $items.=escape($_).'='.escape($storehash{$_}).'&';
826: } keys %storehash;
827: $items=~s/\&$//;
828: return reply("put:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
1.47 www 829: $ENV{'user.home'});
830: }
831:
832: # ------------------------------------------------------ critical put interface
833:
834: sub cput {
835: my ($namespace,%storehash)=@_;
836: my $items='';
837: map {
838: $items.=escape($_).'='.escape($storehash{$_}).'&';
839: } keys %storehash;
840: $items=~s/\&$//;
841: return critical
842: ("put:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
1.12 www 843: $ENV{'user.home'});
844: }
845:
846: # -------------------------------------------------------------- eget interface
847:
848: sub eget {
849: my ($namespace,@storearr)=@_;
850: my $items='';
851: map {
852: $items.=escape($_).'&';
853: } @storearr;
854: $items=~s/\&$//;
855: my $rep=reply("eget:$ENV{'user.domain'}:$ENV{'user.name'}:$namespace:$items",
856: $ENV{'user.home'});
857: my @pairs=split(/\&/,$rep);
858: my %returnhash=();
1.42 www 859: my $i=0;
1.12 www 860: map {
1.42 www 861: $returnhash{$_}=unescape($pairs[$i]);
862: $i++;
863: } @storearr;
1.12 www 864: return %returnhash;
865: }
866:
867: # ------------------------------------------------- Check for a user priviledge
868:
869: sub allowed {
870: my ($priv,$uri)=@_;
1.52 www 871: $uri=&declutter($uri);
1.29 www 872:
1.54 www 873: # Free bre access to adm and meta resources
1.29 www 874:
1.54 www 875: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14 www 876: return 'F';
877: }
1.29 www 878:
1.52 www 879: my $thisallowed='';
880: my $statecond=0;
881: my $courseprivid='';
882:
883: # Course
884:
885: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
886: $thisallowed.=$1;
887: }
1.29 www 888:
1.52 www 889: # Domain
890:
891: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
892: =~/$priv\&([^\:]*)/) {
1.12 www 893: $thisallowed.=$1;
894: }
1.52 www 895:
896: # Course: uri itself is a course
1.66 www 897: my $courseuri=$uri;
898: $courseuri=~s/\_(\d)/\/$1/;
899: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseuri}
1.52 www 900: =~/$priv\&([^\:]*)/) {
1.12 www 901: $thisallowed.=$1;
902: }
1.29 www 903:
1.52 www 904: # Full access at system, domain or course-wide level? Exit.
1.29 www 905:
906: if ($thisallowed=~/F/) {
907: return 'F';
908: }
909:
1.52 www 910: # If this is generating or modifying users, exit with special codes
1.29 www 911:
1.52 www 912: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:'=~/\:$priv\:/) {
913: return $thisallowed;
914: }
915: #
916: # Gathered so far: system, domain and course wide priviledges
917: #
918: # Course: See if uri or referer is an individual resource that is part of
919: # the course
920:
921: if ($ENV{'request.course.id'}) {
922: $courseprivid=$ENV{'request.course.id'};
923: if ($ENV{'request.course.sec'}) {
924: $courseprivid.='/'.$ENV{'request.course.sec'};
925: }
926: $courseprivid=~s/\_/\//;
927: my $checkreferer=1;
928: my @uriparts=split(/\//,$uri);
929: my $filename=$uriparts[$#uriparts];
930: my $pathname=$uri;
931: $pathname=~s/\/$filename$//;
932: if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1.54 www 933: /\&$filename\:([\d\|]+)\&/) {
1.52 www 934: $statecond=$1;
935: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
936: =~/$priv\&([^\:]*)/) {
937: $thisallowed.=$1;
938: $checkreferer=0;
939: }
1.29 www 940: }
1.55 www 941:
1.52 www 942: if (($ENV{'HTTP_REFERER'}) && ($checkreferer)) {
1.55 www 943: my $refuri=$ENV{'HTTP_REFERER'};
944: $refuri=~s/^http\:\/\/$ENV{'request.host'}//i;
945: $refuri=&declutter($refuri);
1.53 www 946: my @uriparts=split(/\//,$refuri);
1.52 www 947: my $filename=$uriparts[$#uriparts];
1.53 www 948: my $pathname=$refuri;
1.52 www 949: $pathname=~s/\/$filename$//;
1.55 www 950: my @filenameparts=split(/\./,$uri);
1.53 www 951: if (&fileembstyle($filenameparts[$#filenameparts]) ne 'ssi') {
952: if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1.54 www 953: /\&$filename\:([\d\|]+)\&/) {
1.53 www 954: my $refstatecond=$1;
1.52 www 955: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
956: =~/$priv\&([^\:]*)/) {
957: $thisallowed.=$1;
1.53 www 958: $uri=$refuri;
959: $statecond=$refstatecond;
1.52 www 960: }
1.53 www 961: }
1.52 www 962: }
1.29 www 963: }
1.52 www 964: }
1.29 www 965:
1.52 www 966: #
967: # Gathered now: all priviledges that could apply, and condition number
968: #
969: #
970: # Full or no access?
971: #
1.29 www 972:
1.52 www 973: if ($thisallowed=~/F/) {
974: return 'F';
975: }
1.29 www 976:
1.52 www 977: unless ($thisallowed) {
978: return '';
979: }
1.29 www 980:
1.52 www 981: # Restrictions exist, deal with them
982: #
983: # C:according to course preferences
984: # R:according to resource settings
985: # L:unless locked
986: # X:according to user session state
987: #
988:
989: # Possibly locked functionality, check all courses
1.54 www 990: # Locks might take effect only after 10 minutes cache expiration for other
991: # courses, and 2 minutes for current course
1.52 www 992:
993: my $envkey;
994: if ($thisallowed=~/L/) {
995: foreach $envkey (keys %ENV) {
1.54 www 996: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
997: my $courseid=$2;
998: my $roleid=$1.'.'.$2;
999: my $expiretime=600;
1000: if ($ENV{'request.role'} eq $roleid) {
1001: $expiretime=120;
1002: }
1003: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
1004: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1005: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
1006: &coursedescription($courseid);
1007: }
1008: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
1009: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
1010: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
1.57 www 1011: &log($ENV{'user.domain'},$ENV{'user.name'},
1012: $ENV{'user.host'},
1013: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 1014: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54 www 1015: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 1016: return '';
1017: }
1018: }
1.54 www 1019: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
1020: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1021: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
1.57 www 1022: &log($ENV{'user.domain'},$ENV{'user.name'},
1023: $ENV{'user.host'},
1024: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 1025: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54 www 1026: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 1027: return '';
1028: }
1029: }
1030: }
1.29 www 1031: }
1.52 www 1032: }
1033:
1034: #
1035: # Rest of the restrictions depend on selected course
1036: #
1037:
1038: unless ($ENV{'request.course.id'}) {
1039: return '1';
1040: }
1.29 www 1041:
1.52 www 1042: #
1043: # Now user is definitely in a course
1044: #
1.53 www 1045:
1046:
1047: # Course preferences
1048:
1049: if ($thisallowed=~/C/) {
1.54 www 1050: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1051: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
1052: =~/\,$rolecode\,/) {
1.57 www 1053: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1054: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
1.54 www 1055: $ENV{'request.course.id'});
1056: return '';
1057: }
1.53 www 1058: }
1059:
1060: # Resource preferences
1061:
1062: if ($thisallowed=~/R/) {
1.54 www 1063: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1064: my $filename=$perlvar{'lonDocRoot'}.'/res/'.$uri.'.meta';
1065: if (-e $filename) {
1066: my @content;
1067: {
1068: my $fh=Apache::File->new($filename);
1069: @content=<$fh>;
1070: }
1071: if (join('',@content)=~
1072: /\<roledeny[^\>]*\>[^\<]*$rolecode[^\<]*\<\/roledeny\>/) {
1.57 www 1073: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1074: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
1.54 www 1075: return '';
1076:
1077: }
1078: }
1.53 www 1079: }
1.30 www 1080:
1.52 www 1081: # Restricted by state?
1.30 www 1082:
1.52 www 1083: if ($thisallowed=~/X/) {
1084: if (&condval($statecond)) {
1085: return '2';
1086: } else {
1087: return '';
1088: }
1089: }
1.30 www 1090:
1.52 www 1091: return 'F';
1.12 www 1092: }
1093:
1094: # ----------------------------------------------------------------- Define Role
1095:
1096: sub definerole {
1097: if (allowed('mcr','/')) {
1098: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.21 www 1099: map {
1100: my ($crole,$cqual)=split(/\&/,$_);
1101: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
1102: if ($pr{'cr:s'}=~/$crole\&/) {
1103: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
1104: return "refused:s:$crole&$cqual";
1105: }
1106: }
1107: } split('/',$sysrole);
1108: map {
1109: my ($crole,$cqual)=split(/\&/,$_);
1110: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
1111: if ($pr{'cr:d'}=~/$crole\&/) {
1112: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
1113: return "refused:d:$crole&$cqual";
1114: }
1115: }
1116: } split('/',$domrole);
1117: map {
1118: my ($crole,$cqual)=split(/\&/,$_);
1119: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
1120: if ($pr{'cr:c'}=~/$crole\&/) {
1121: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
1122: return "refused:c:$crole&$cqual";
1123: }
1124: }
1125: } split('/',$courole);
1.12 www 1126: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
1127: "$ENV{'user.domain'}:$ENV{'user.name'}:".
1.21 www 1128: "rolesdef_$rolename=".
1129: escape($sysrole.'_'.$domrole.'_'.$courole);
1.12 www 1130: return reply($command,$ENV{'user.home'});
1131: } else {
1132: return 'refused';
1133: }
1134: }
1135:
1136: # ------------------------------------------------------------------ Plain Text
1137:
1138: sub plaintext {
1.22 www 1139: my $short=shift;
1140: return $prp{$short};
1.12 www 1141: }
1142:
1.25 www 1143: # ------------------------------------------------------------------ Plain Text
1144:
1145: sub fileembstyle {
1146: my $ending=shift;
1147: return $fe{$ending};
1148: }
1149:
1150: # ------------------------------------------------------------ Description Text
1151:
1.74 ! www 1152: sub filedescription {
1.25 www 1153: my $ending=shift;
1154: return $fd{$ending};
1155: }
1156:
1.12 www 1157: # ----------------------------------------------------------------- Assign Role
1158:
1159: sub assignrole {
1.21 www 1160: my ($udom,$uname,$url,$role,$end,$start)=@_;
1161: my $mrole;
1.31 www 1162: $url=declutter($url);
1.21 www 1163: if ($role =~ /^cr\//) {
1164: unless ($url=~/\.course$/) { return 'invalid'; }
1165: unless (allowed('ccr',$url)) { return 'refused'; }
1166: $mrole='cr';
1167: } else {
1168: unless (($url=~/\.course$/) || ($url=~/\/$/)) { return 'invalid'; }
1169: unless (allowed('c'+$role)) { return 'refused'; }
1170: $mrole=$role;
1171: }
1172: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
1173: "$udom:$uname:$url".'_'."$mrole=$role";
1174: if ($end) { $command.='_$end'; }
1175: if ($start) {
1176: if ($end) {
1177: $command.='_$start';
1178: } else {
1179: $command.='_0_$start';
1180: }
1181: }
1182: return &reply($command,&homeserver($uname,$udom));
1183: }
1184:
1185: # ---------------------------------------------------------- Assign Custom Role
1186:
1187: sub assigncustomrole {
1188: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
1189: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1190: $end,$start);
1191: }
1192:
1193: # ----------------------------------------------------------------- Revoke Role
1194:
1195: sub revokerole {
1196: my ($udom,$uname,$url,$role)=@_;
1197: my $now=time;
1198: return &assignrole($udom,$uname,$url,$role,$now);
1199: }
1200:
1201: # ---------------------------------------------------------- Revoke Custom Role
1202:
1203: sub revokecustomrole {
1204: my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
1205: my $now=time;
1206: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
1.17 www 1207: }
1208:
1209: # ------------------------------------------------------------ Directory lister
1210:
1211: sub dirlist {
1212: my $uri=shift;
1.18 www 1213: $uri=~s/^\///;
1214: $uri=~s/\/$//;
1.19 www 1215: my ($res,$udom,$uname,@rest)=split(/\//,$uri);
1216: if ($udom) {
1217: if ($uname) {
1218: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/'.$uri,
1219: homeserver($uname,$udom));
1220: return split(/:/,$listing);
1221: } else {
1222: my $tryserver;
1223: my %allusers=();
1224: foreach $tryserver (keys %libserv) {
1225: if ($hostdom{$tryserver} eq $udom) {
1226: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.$udom,
1227: $tryserver);
1228: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
1229: && ($listing ne 'con_lost')) {
1230: map {
1231: my ($entry,@stat)=split(/&/,$_);
1232: $allusers{$entry}=1;
1233: } split(/:/,$listing);
1234: }
1235: }
1236: }
1237: my $alluserstr='';
1238: map {
1239: $alluserstr.=$_.'&user:';
1240: } sort keys %allusers;
1241: $alluserstr=~s/:$//;
1242: return split(/:/,$alluserstr);
1243: }
1244: } else {
1245: my $tryserver;
1246: my %alldom=();
1247: foreach $tryserver (keys %libserv) {
1248: $alldom{$hostdom{$tryserver}}=1;
1249: }
1250: my $alldomstr='';
1251: map {
1252: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
1253: } sort keys %alldom;
1254: $alldomstr=~s/:$//;
1255: return split(/:/,$alldomstr);
1256: }
1.26 www 1257: }
1258:
1259: # -------------------------------------------------------- Value of a Condition
1260:
1.40 www 1261: sub directcondval {
1262: my $number=shift;
1263: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
1264: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
1265: } else {
1266: return 2;
1267: }
1268: }
1269:
1.26 www 1270: sub condval {
1271: my $condidx=shift;
1272: my $result=0;
1.54 www 1273: my $allpathcond='';
1274: map {
1275: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
1276: $allpathcond.=
1277: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
1278: }
1279: } split(/\|/,$condidx);
1280: $allpathcond=~s/\|$//;
1.33 www 1281: if ($ENV{'request.course.id'}) {
1.54 www 1282: if ($allpathcond) {
1.26 www 1283: my $operand='|';
1284: my @stack;
1285: map {
1286: if ($_ eq '(') {
1287: push @stack,($operand,$result)
1288: } elsif ($_ eq ')') {
1289: my $before=pop @stack;
1290: if (pop @stack eq '&') {
1291: $result=$result>$before?$before:$result;
1292: } else {
1293: $result=$result>$before?$result:$before;
1294: }
1295: } elsif (($_ eq '&') || ($_ eq '|')) {
1296: $operand=$_;
1297: } else {
1.40 www 1298: my $new=directcondval($_);
1.26 www 1299: if ($operand eq '&') {
1300: $result=$result>$new?$new:$result;
1301: } else {
1302: $result=$result>$new?$result:$new;
1303: }
1304: }
1.54 www 1305: } ($allpathcond=~/(\d+|\(|\)|\&|\|)/g);
1.26 www 1306: }
1307: }
1308: return $result;
1.28 www 1309: }
1310:
1311: # --------------------------------------------------------- Value of a Variable
1312:
1.58 www 1313: sub EXT {
1.48 www 1314: my $varname=shift;
1.68 www 1315: unless ($varname) { return ''; }
1.48 www 1316: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
1317: my $rest;
1318: if ($therest[0]) {
1319: $rest=join('.',@therest);
1320: } else {
1321: $rest='';
1322: }
1.57 www 1323: my $qualifierrest=$qualifier;
1324: if ($rest) { $qualifierrest.='.'.$rest; }
1325: my $spacequalifierrest=$space;
1326: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 1327: if ($realm eq 'user') {
1.48 www 1328: # --------------------------------------------------------------- user.resource
1329: if ($space eq 'resource') {
1.57 www 1330: my %restored=&restore;
1331: return $restored{$qualifierrest};
1.48 www 1332: # ----------------------------------------------------------------- user.access
1333: } elsif ($space eq 'access') {
1334: return &allowed($qualifier,$rest);
1335: # ------------------------------------------ user.preferences, user.environment
1336: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.57 www 1337: return $ENV{join('.',('environment',$qualifierrest))};
1.48 www 1338: # ----------------------------------------------------------------- user.course
1339: } elsif ($space eq 'course') {
1340: return $ENV{join('.',('request.course',$qualifier))};
1341: # ------------------------------------------------------------------- user.role
1342: } elsif ($space eq 'role') {
1343: my ($role,$where)=split(/\./,$ENV{'request.role'});
1344: if ($qualifier eq 'value') {
1345: return $role;
1346: } elsif ($qualifier eq 'extent') {
1347: return $where;
1348: }
1349: # ----------------------------------------------------------------- user.domain
1350: } elsif ($space eq 'domain') {
1351: return $ENV{'user.domain'};
1352: # ------------------------------------------------------------------- user.name
1353: } elsif ($space eq 'name') {
1354: return $ENV{'user.name'};
1355: # ---------------------------------------------------- Any other user namespace
1.29 www 1356: } else {
1.48 www 1357: my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
1358: my %reply=&get($space,$item);
1359: return $reply{$item};
1360: }
1361: } elsif ($realm eq 'request') {
1362: # ------------------------------------------------------------- request.browser
1363: if ($space eq 'browser') {
1364: return $ENV{'browser.'.$qualifier};
1.57 www 1365: # ------------------------------------------------------------ request.filename
1366: } else {
1367: return $ENV{'request.'.$spacequalifierrest};
1.29 www 1368: }
1.28 www 1369: } elsif ($realm eq 'course') {
1.48 www 1370: # ---------------------------------------------------------- course.description
1.57 www 1371: my $section='';
1372: if ($ENV{'request.course.sec'}) {
1373: $section='_'.$ENV{'request.course.sec'};
1.48 www 1374: }
1.57 www 1375: return $ENV{'course.'.$ENV{'request.course.id'}.$section.'.'.
1376: $spacequalifierrest};
1377: } elsif ($realm eq 'resource') {
1.60 www 1378: if ($ENV{'request.course.id'}) {
1379: # ----------------------------------------------------- Cascading lookup scheme
1.69 www 1380: my $symbp=&symbread();
1381: my $mapp=(split(/\_\_\_/,$symbp))[0];
1382:
1383: my $symbparm=$symbp.'.'.$spacequalifierrest;
1384: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1385:
1.60 www 1386: my $seclevel=
1.69 www 1387: $ENV{'request.course.id'}.'.['.
1388: $ENV{'request.course.sec'}.'].'.$spacequalifierrest;
1389: my $seclevelr=
1390: $ENV{'request.course.id'}.'.['.
1391: $ENV{'request.course.sec'}.'].'.$symbparm;
1392: my $seclevelm=
1393: $ENV{'request.course.id'}.'.['.
1394: $ENV{'request.course.sec'}.'].'.$mapparm;
1395:
1.60 www 1396: my $courselevel=
1397: $ENV{'request.course.id'}.'.'.$spacequalifierrest;
1.69 www 1398: my $courselevelr=
1399: $ENV{'request.course.id'}.'.'.$symbparm;
1400: my $courselevelm=
1401: $ENV{'request.course.id'}.'.'.$mapparm;
1402:
1.60 www 1403:
1404: # ----------------------------------------------------------- first, check user
1.69 www 1405: my %resourcedata=get('resourcedata',
1406: ($courselevelr,$courselevelm,$courselevel));
1407: if ($resourcedata{$courselevelr}!~/^error\:/) {
1408:
1409: if ($resourcedata{$courselevelr}) {
1410: return $resourcedata{$courselevelr}; }
1411: if ($resourcedata{$courselevelm}) {
1412: return $resourcedata{$courselevelm}; }
1.60 www 1413: if ($resourcedata{$courselevel}) { return $resourcedata{$courselevel}; }
1.69 www 1414:
1.63 www 1415: }
1.60 www 1416: # -------------------------------------------------------- second, check course
1417: my $section='';
1418: if ($ENV{'request.course.sec'}) {
1419: $section='_'.$ENV{'request.course.sec'};
1420: }
1421: my $reply=&reply('get:'.
1422: $ENV{'course.'.$ENV{'request.course.id'}.$section.'.domain'}.':'.
1423: $ENV{'course.'.$ENV{'request.course.id'}.$section.'.num'}.
1424: ':resourcedata:'.
1.69 www 1425: escape($seclevelr).':'.escape($seclevelm).':'.escape($seclevel).':'.
1426: escape($courselevelr).':'.escape($courselevelm).':'.escape($courselevel),
1.60 www 1427: $ENV{'course.'.$ENV{'request.course.id'}.$section.'.home'});
1.63 www 1428: if ($reply!~/^error\:/) {
1.60 www 1429: map {
1430: my ($name,$value)=split(/\=/,$_);
1431: $resourcedata{unescape($name)}=unescape($value);
1432: } split(/\&/,$reply);
1.69 www 1433:
1434: if ($resourcedata{$seclevelr}) { return $resourcedata{$seclevelr}; }
1435: if ($resourcedata{$seclevelm}) { return $resourcedata{$seclevelm}; }
1436: if ($resourcedata{$seclevel}) { return $resourcedata{$seclevel}; }
1437:
1438: if ($resourcedata{$courselevelr}) {
1439: return $resourcedata{$courselevelr}; }
1440: if ($resourcedata{$courselevelm}) {
1441: return $resourcedata{$courselevelm}; }
1.60 www 1442: if ($resourcedata{$courselevel}) { return $resourcedata{$courselevel}; }
1.69 www 1443:
1.63 www 1444: }
1.60 www 1445:
1446: # ------------------------------------------------------ third, check map parms
1.65 www 1447: my %parmhash=();
1448: my $thisparm='';
1449: if (tie(%parmhash,'GDBM_File',
1450: $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640)) {
1451: $thisparm=$parmhash{$symbparm};
1452: untie(%parmhash);
1.60 www 1453: }
1.65 www 1454: if ($thisparm) { return $thisparm; }
1.60 www 1455: }
1456:
1457: # --------------------------------------------- last, look in resource metadata
1.71 www 1458:
1459: my $metadata=&metadata($ENV{'request.filename'},$spacequalifierrest);
1460: if ($metadata) { return $metadata; }
1461:
1.48 www 1462: # ---------------------------------------------------- Any other user namespace
1463: } elsif ($realm eq 'environment') {
1464: # ----------------------------------------------------------------- environment
1.57 www 1465: return $ENV{$spacequalifierrest};
1.28 www 1466: } elsif ($realm eq 'system') {
1.48 www 1467: # ----------------------------------------------------------------- system.time
1468: if ($space eq 'time') {
1469: return time;
1470: }
1.28 www 1471: }
1.48 www 1472: return '';
1.61 www 1473: }
1474:
1.71 www 1475: # ---------------------------------------------------------------- Get metadata
1476:
1477: sub metadata {
1478: my ($uri,$what)=@_;
1479: $uri=&declutter($uri);
1.73 www 1480: my $filename=$uri;
1481: $uri=~s/\.meta$//;
1.71 www 1482: unless ($metacache{$uri.':keys'}) {
1.73 www 1483: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1484: my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);
1.71 www 1485: my $parser=HTML::TokeParser->new(\$metastring);
1486: my $token;
1487: while ($token=$parser->get_token) {
1488: if ($token->[0] eq 'S') {
1489: my $entry=$token->[1];
1490: my $unikey=$entry;
1.72 www 1491: if (defined($token->[2]->{'part'})) {
1.71 www 1492: $unikey.='_'.$token->[2]->{'part'};
1493: }
1.72 www 1494: if (defined($token->[2]->{'name'})) {
1.71 www 1495: $unikey.='_'.$token->[2]->{'name'};
1496: }
1497: if ($metacache{$uri.':keys'}) {
1498: $metacache{$uri.':keys'}.=','.$unikey;
1499: } else {
1500: $metacache{$uri.':keys'}=$unikey;
1501: }
1502: map {
1503: $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
1.72 www 1504: } @{$token->[3]};
1.71 www 1505: $metacache{$uri.':'.$unikey}=$parser->get_text('/'.$entry);
1506: }
1507: }
1508: }
1509: return $metacache{$uri.':'.$what};
1510: }
1511:
1.31 www 1512: # ------------------------------------------------- Update symbolic store links
1513:
1514: sub symblist {
1515: my ($mapname,%newhash)=@_;
1516: $mapname=declutter($mapname);
1517: my %hash;
1518: if (($ENV{'request.course.fn'}) && (%newhash)) {
1519: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1520: &GDBM_WRCREAT,0640)) {
1521: map {
1522: $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
1523: } keys %newhash;
1524: if (untie(%hash)) {
1525: return 'ok';
1526: }
1527: }
1528: }
1529: return 'error';
1530: }
1531:
1532: # ------------------------------------------------------ Return symb list entry
1533:
1534: sub symbread {
1.44 www 1535: my $thisfn=shift;
1536: unless ($thisfn) {
1537: $thisfn=$ENV{'request.filename'};
1538: }
1539: $thisfn=declutter($thisfn);
1.31 www 1540: my %hash;
1.37 www 1541: my %bighash;
1542: my $syval='';
1.45 www 1543: if (($ENV{'request.course.fn'}) && ($thisfn)) {
1.31 www 1544: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
1545: &GDBM_READER,0640)) {
1546: $syval=$hash{$thisfn};
1.37 www 1547: untie(%hash);
1548: }
1549: # ---------------------------------------------------------- There was an entry
1550: if ($syval) {
1551: unless ($syval=~/\_\d+$/) {
1552: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.44 www 1553: &appenv('request.ambiguous' => $thisfn);
1.37 www 1554: return '';
1555: }
1556: $syval.=$1;
1557: }
1558: } else {
1559: # ------------------------------------------------------- Was not in symb table
1560: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
1561: &GDBM_READER,0640)) {
1562: # ---------------------------------------------- Get ID(s) for current resource
1563: my $ids=$bighash{'ids_/res/'.$thisfn};
1.65 www 1564: unless ($ids) {
1565: $ids=$bighash{'ids_/'.$thisfn};
1566: }
1.37 www 1567: if ($ids) {
1568: # ------------------------------------------------------------------- Has ID(s)
1569: my @possibilities=split(/\,/,$ids);
1.39 www 1570: if ($#possibilities==0) {
1571: # ----------------------------------------------- There is only one possibility
1.37 www 1572: my ($mapid,$resid)=split(/\./,$ids);
1573: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
1574: } else {
1.39 www 1575: # ------------------------------------------ There is more than one possibility
1576: my $realpossible=0;
1577: map {
1578: my $file=$bighash{'src_'.$_};
1579: if (&allowed('bre',$file)) {
1580: my ($mapid,$resid)=split(/\./,$_);
1581: if ($bighash{'map_type_'.$mapid} ne 'page') {
1582: $realpossible++;
1583: $syval=declutter($bighash{'map_id_'.$mapid}).
1584: '___'.$resid;
1585: }
1586: }
1587: } @possibilities;
1588: if ($realpossible!=1) { $syval=''; }
1.37 www 1589: }
1590: }
1591: untie(%bighash)
1592: }
1.31 www 1593: }
1.62 www 1594: if ($syval) {
1595: return $syval.'___'.$thisfn;
1596: }
1.31 www 1597: }
1.44 www 1598: &appenv('request.ambiguous' => $thisfn);
1.31 www 1599: return '';
1600: }
1601:
1602: # ---------------------------------------------------------- Return random seed
1603:
1.32 www 1604: sub numval {
1605: my $txt=shift;
1606: $txt=~tr/A-J/0-9/;
1607: $txt=~tr/a-j/0-9/;
1608: $txt=~tr/K-T/0-9/;
1609: $txt=~tr/k-t/0-9/;
1610: $txt=~tr/U-Z/0-5/;
1611: $txt=~tr/u-z/0-5/;
1612: $txt=~s/\D//g;
1613: return int($txt);
1614: }
1615:
1.31 www 1616: sub rndseed {
1617: my $symb;
1.44 www 1618: unless ($symb=&symbread()) { return time; }
1.32 www 1619: my $symbchck=unpack("%32C*",$symb);
1620: my $symbseed=numval($symb)%$symbchck;
1621: my $namechck=unpack("%32C*",$ENV{'user.name'});
1622: my $nameseed=numval($ENV{'user.name'})%$namechck;
1623: return int( $symbseed
1624: .$nameseed
1625: .unpack("%32C*",$ENV{'user.domain'})
1.33 www 1626: .unpack("%32C*",$ENV{'request.course.id'})
1.32 www 1627: .$namechck
1628: .$symbchck);
1.36 albertel 1629: }
1630:
1631: # ------------------------------------------------------------ Serves up a file
1632: # returns either the contents of the file or a -1
1633: sub getfile {
1634: my $file=shift;
1.37 www 1635: &repcopy($file);
1.36 albertel 1636: if (! -e $file ) { return -1; };
1637: my $fh=Apache::File->new($file);
1638: my $a='';
1639: while (<$fh>) { $a .=$_; }
1640: return $a
1641: }
1642:
1643: sub filelocation {
1644: my ($dir,$file) = @_;
1645: my $location;
1646: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.59 albertel 1647: if ($file=~m:^/~:) { # is a contruction space reference
1648: $location = $file;
1649: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.36 albertel 1650: } else {
1.59 albertel 1651: $file=~s/^$perlvar{'lonDocRoot'}//;
1652: $file=~s:^/*res::;
1653: if ( !( $file =~ m:^/:) ) {
1654: $location = $dir. '/'.$file;
1655: } else {
1656: $location = '/home/httpd/html/res'.$file;
1657: }
1.36 albertel 1658: }
1659: $location=~s://+:/:g; # remove duplicate /
1.46 www 1660: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
1661: return $location;
1662: }
1.36 albertel 1663:
1.46 www 1664: sub hreflocation {
1665: my ($dir,$file)=@_;
1666: unless (($_=~/^http:\/\//i) || ($_=~/^\//)) {
1667: my $finalpath=filelocation($dir,$file);
1668: $finalpath=~s/^\/home\/httpd\/html//;
1669: return $finalpath;
1670: } else {
1671: return $file;
1672: }
1.31 www 1673: }
1674:
1675: # ------------------------------------------------------------- Declutters URLs
1676:
1677: sub declutter {
1678: my $thisfn=shift;
1679: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
1680: $thisfn=~s/^\///;
1681: $thisfn=~s/^res\///;
1682: return $thisfn;
1.12 www 1683: }
1684:
1685: # -------------------------------------------------------- Escape Special Chars
1686:
1687: sub escape {
1688: my $str=shift;
1689: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
1690: return $str;
1691: }
1692:
1693: # ----------------------------------------------------- Un-Escape Special Chars
1694:
1695: sub unescape {
1696: my $str=shift;
1697: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1698: return $str;
1699: }
1.11 www 1700:
1.1 albertel 1701: # ================================================================ Main Program
1702:
1703: sub BEGIN {
1704: if ($readit ne 'done') {
1705: # ------------------------------------------------------------ Read access.conf
1706: {
1707: my $config=Apache::File->new("/etc/httpd/conf/access.conf");
1708:
1709: while (my $configline=<$config>) {
1710: if ($configline =~ /PerlSetVar/) {
1711: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8 www 1712: chomp($varvalue);
1.1 albertel 1713: $perlvar{$varname}=$varvalue;
1714: }
1715: }
1716: }
1717:
1718: # ------------------------------------------------------------- Read hosts file
1719: {
1720: my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
1721:
1722: while (my $configline=<$config>) {
1723: my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
1724: $hostname{$id}=$name;
1725: $hostdom{$id}=$domain;
1726: if ($role eq 'library') { $libserv{$id}=$name; }
1727: }
1728: }
1729:
1730: # ------------------------------------------------------ Read spare server file
1731: {
1732: my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
1733:
1734: while (my $configline=<$config>) {
1735: chomp($configline);
1736: if (($configline) && ($configline ne $perlvar{'lonHostID'})) {
1737: $spareid{$configline}=1;
1738: }
1739: }
1740: }
1.11 www 1741: # ------------------------------------------------------------ Read permissions
1742: {
1743: my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
1744:
1745: while (my $configline=<$config>) {
1746: chomp($configline);
1747: my ($role,$perm)=split(/ /,$configline);
1748: if ($perm ne '') { $pr{$role}=$perm; }
1749: }
1750: }
1751:
1752: # -------------------------------------------- Read plain texts for permissions
1753: {
1754: my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
1755:
1756: while (my $configline=<$config>) {
1757: chomp($configline);
1758: my ($short,$plain)=split(/:/,$configline);
1759: if ($plain ne '') { $prp{$short}=$plain; }
1.25 www 1760: }
1761: }
1762:
1763: # ------------------------------------------------------------- Read file types
1764: {
1765: my $config=Apache::File->new("$perlvar{'lonTabDir'}/filetypes.tab");
1766:
1767: while (my $configline=<$config>) {
1768: chomp($configline);
1769: my ($ending,$emb,@descr)=split(/\s+/,$configline);
1770: if ($descr[0] ne '') {
1771: $fe{$ending}=$emb;
1772: $fd{$ending}=join(' ',@descr);
1773: }
1.11 www 1774: }
1775: }
1776:
1.71 www 1777: %metacache=();
1.22 www 1778:
1.1 albertel 1779: $readit='done';
1.12 www 1780: &logthis('<font color=yellow>INFO: Read configuration</font>');
1.1 albertel 1781: }
1782: }
1783: 1;
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