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