Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.187
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.184 www 4: # $Id: lonnet.pm,v 1.183 2001/12/05 21:00:23 albertel Exp $
1.178 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.169 harris41 28: # 6/1/99,6/2,6/10,6/11,6/12,6/14,6/26,6/28,6/29,6/30,
29: # 7/1,7/2,7/9,7/10,7/12,7/14,7/15,7/19,
30: # 11/8,11/16,11/18,11/22,11/23,12/22,
31: # 01/06,01/13,02/24,02/28,02/29,
32: # 03/01,03/02,03/06,03/07,03/13,
33: # 04/05,05/29,05/31,06/01,
34: # 06/05,06/26 Gerd Kortemeyer
35: # 06/26 Ben Tyszka
36: # 06/30,07/15,07/17,07/18,07/20,07/21,07/22,07/25 Gerd Kortemeyer
37: # 08/14 Ben Tyszka
38: # 08/22,08/28,08/31,09/01,09/02,09/04,09/05,09/25,09/28,09/30 Gerd Kortemeyer
39: # 10/04 Gerd Kortemeyer
40: # 10/04 Guy Albertelli
41: # 10/06,10/09,10/10,10/11,10/14,10/20,10/23,10/25,10/26,10/27,10/28,10/29,
42: # 10/30,10/31,
43: # 11/2,11/14,11/15,11/16,11/20,11/21,11/22,11/25,11/27,
44: # 12/02,12/12,12/13,12/14,12/28,12/29 Gerd Kortemeyer
45: # 05/01/01 Guy Albertelli
46: # 05/01,06/01,09/01 Gerd Kortemeyer
47: # 09/01 Guy Albertelli
48: # 09/01,10/01,11/01 Gerd Kortemeyer
49: # YEAR=2001
50: # 02/27/01 Scott Harrison
51: # 3/2 Gerd Kortemeyer
52: # 3/15,3/19 Scott Harrison
53: # 3/19,3/20 Gerd Kortemeyer
54: # 3/22,3/27,4/2,4/16,4/17 Scott Harrison
55: # 5/26,5/28 Gerd Kortemeyer
56: # 5/30 H. K. Ng
57: # 6/1 Gerd Kortemeyer
58: # July Guy Albertelli
59: # 8/4,8/7,8/8,8/9,8/11,8/16,8/17,8/18,8/20,8/23,9/20,9/21,9/26,
60: # 10/2 Gerd Kortemeyer
61: # 10/5,10/10,11/13,11/15 Scott Harrison
1.179 www 62: # 11/17,11/20,11/22,11/29 Gerd Kortemeyer
1.182 matthew 63: # 12/5 Matthew Hall
1.184 www 64: # 12/5 Guy Albertelli
1.187 ! www 65: # 12/6,12/7 Gerd Kortemeyer
1.169 harris41 66: #
1.184 www 67: # $Id: lonnet.pm,v 1.183 2001/12/05 21:00:23 albertel Exp $
1.171 www 68: #
1.169 harris41 69: ###
70:
1.12 www 71: # Functions for use by content handlers:
72: #
1.112 harris41 73: # metadata_query(sql-query-string,custom-metadata-regex) :
74: # returns file handle of where sql and
75: # regex results will be stored for query
1.12 www 76: # plaintext(short) : plain text explanation of short term
1.25 www 77: # fileembstyle(ext) : embed style in page for file extension
78: # filedescription(ext) : descriptor text for file extension
1.29 www 79: # allowed(short,url) : returns codes for allowed actions
80: # F: full access
81: # U,I,K: authentication modes (cxx only)
82: # '': forbidden
83: # 1: user needs to choose course
84: # 2: browse allowed
1.21 www 85: # definerole(rolename,sys,dom,cou) : define a custom role rolename
1.103 harris41 86: # set privileges in format of lonTabs/roles.tab for
1.21 www 87: # system, domain and course level,
88: # assignrole(udom,uname,url,role,end,start) : give a role to a user for the
89: # level given by url. Optional start and end dates
90: # (leave empty string or zero for "no date")
91: # assigncustomrole (udom,uname,url,rdom,rnam,rolename,end,start) : give a
92: # custom role to a user for the level given by url.
93: # Specify name and domain of role author, and role name
94: # revokerole (udom,uname,url,role) : Revoke a role for url
95: # revokecustomrole (udom,uname,url,rdom,rnam,rolename) : Revoke a custom role
1.24 www 96: # appenv(hash) : adds hash to session environment
1.56 www 97: # delenv(varname) : deletes all environment entries starting with varname
1.124 www 98: # store(hashref,symb,courseid,udom,uname)
1.122 albertel 99: # : stores hash permanently for this url
100: # hashref needs to be given, and should be a \%hashname
101: # the remaining args aren't required and if they aren't
102: # passed or are '' they will be derived from the ENV
1.124 www 103: # cstore(hashref,symb,courseid,udom,uname)
1.122 albertel 104: # : same as store but uses the critical interface to
105: # guarentee a store
1.124 www 106: # restore(symb,courseid,udom,uname)
1.122 albertel 107: # : returns hash for this symb, all args are optional
1.124 www 108: # if they aren't given they will be derived from the
109: # current enviroment
1.133 albertel 110: #
111: #
1.134 albertel 112: # for the next 6 functions udom and uname are optional
1.133 albertel 113: # if supplied they use udom as the domain and uname
114: # as the username for the function (supply a courseid
115: # for the uname if you want a course database)
116: # if not supplied it uses %ENV and looks at
117: # user. attribute for the values
118: #
119: # eget(namesp,arrayref,udom,uname)
120: # : returns hash with keys from array reference filled
121: # in from namesp (encrypts the return communication)
1.131 albertel 122: # get(namesp,arrayref,udom,uname)
123: # : returns hash with keys from array reference filled
124: # in from namesp
1.133 albertel 125: # dump(namesp,udom,uname) : dumps the complete namespace into a hash
126: # del(namesp,array,udom,uname) : deletes keys out of array from namesp
1.134 albertel 127: # put(namesp,hash,udom,uname) : stores hash in namesp
128: # cput(namesp,hash,udom,uname) : critical put
1.133 albertel 129: #
130: #
1.23 www 131: # ssi(url,hash) : does a complete request cycle on url to localhost, posts
132: # hash
1.34 www 133: # coursedescription(id) : returns and caches course description for id
1.17 www 134: # repcopy(filename) : replicate file
135: # dirlist(url) : gets a directory listing
1.40 www 136: # directcondval(index) : reading condition value of single condition from
137: # state string
1.28 www 138: # condval(index) : value of condition index based on state
1.58 www 139: # EXT(name) : value of a variable
1.31 www 140: # symblist(map,hash) : Updates symbolic storage links
1.44 www 141: # symbread([filename]) : returns the data handle (filename optional)
1.155 albertel 142: # rndseed([symb,courseid,domain,uname])
143: # : returns a random seed, all arguments are optional,
144: # if they aren't sent it use the environment to derive
145: # them
146: # Note: if symb isn't sent and it can't get one from
147: # &symbread it will use the current time as it's return
1.76 www 148: # receipt() : returns a receipt to be given out to users
1.36 albertel 149: # getfile(filename) : returns the contents of filename, or a -1 if it can't
150: # be found, replicates and subscribes to the file
1.121 harris41 151: # filelocation(dir,file) : returns a fairly clean absolute reference to file
1.36 albertel 152: # from the directory dir
1.46 www 153: # hreflocation(dir,file) : same as filelocation, but for hrefs
1.47 www 154: # log(domain,user,home,msg) : write to permanent log for user
1.70 www 155: # usection(domain,user,courseid) : output of section name/number or '' for
156: # "not in course" and '-1' for "no section"
157: # userenvironment(domain,user,what) : puts out any environment parameter
158: # for a user
159: # idput(domain,hash) : writes IDs for users from hash (name=>id,name=>id)
160: # idget(domain,array): returns hash with usernames (id=>name,id=>name) for
161: # an array of IDs
162: # idrget(domain,array): returns hash with IDs for usernames (name=>id,...) for
163: # an array of names
1.73 www 164: # metadata(file,entry): returns the metadata entry for a file. entry='keys'
165: # returns a comma separated list of keys
1.12 www 166: #
1.128 www 167:
1.1 albertel 168: package Apache::lonnet;
169:
170: use strict;
171: use Apache::File;
1.8 www 172: use LWP::UserAgent();
1.15 www 173: use HTTP::Headers;
1.11 www 174: use vars
1.186 www 175: qw(%perlvar %hostname %homecache %hostip %spareid %hostdom %libserv %pr %prp %fe %fd %metacache %packagetab %courselogs %accesshash $processmarker $dumpcount);
1.1 albertel 176: use IO::Socket;
1.31 www 177: use GDBM_File;
1.8 www 178: use Apache::Constants qw(:common :http);
1.71 www 179: use HTML::TokeParser;
1.88 www 180: use Fcntl qw(:flock);
1.1 albertel 181:
182: # --------------------------------------------------------------------- Logging
183:
1.163 harris41 184: sub logtouch {
185: my $execdir=$perlvar{'lonDaemons'};
186: unless (-e "$execdir/logs/lonnet.log") {
187: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
188: close $fh;
189: }
190: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
191: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
192: }
193:
1.1 albertel 194: sub logthis {
195: my $message=shift;
196: my $execdir=$perlvar{'lonDaemons'};
197: my $now=time;
198: my $local=localtime($now);
1.162 harris41 199: my $fh=Apache::File->new(">>$execdir/logs/lonnet.log");
200: print $fh "$local ($$): $message\n";
1.1 albertel 201: return 1;
202: }
203:
204: sub logperm {
205: my $message=shift;
206: my $execdir=$perlvar{'lonDaemons'};
207: my $now=time;
208: my $local=localtime($now);
1.162 harris41 209: my $fh=Apache::File->new(">>$execdir/logs/lonnet.perm.log");
210: print $fh "$now:$message:$local\n";
1.1 albertel 211: return 1;
212: }
213:
214: # -------------------------------------------------- Non-critical communication
215: sub subreply {
216: my ($cmd,$server)=@_;
217: my $peerfile="$perlvar{'lonSockDir'}/$server";
218: my $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
219: Type => SOCK_STREAM,
220: Timeout => 10)
221: or return "con_lost";
222: print $client "$cmd\n";
223: my $answer=<$client>;
1.9 www 224: if (!$answer) { $answer="con_lost"; }
1.1 albertel 225: chomp($answer);
226: return $answer;
227: }
228:
229: sub reply {
230: my ($cmd,$server)=@_;
231: my $answer=subreply($cmd,$server);
232: if ($answer eq 'con_lost') { $answer=subreply($cmd,$server); }
1.65 www 233: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.12 www 234: &logthis("<font color=blue>WARNING:".
235: " $cmd to $server returned $answer</font>");
236: }
1.1 albertel 237: return $answer;
238: }
239:
240: # ----------------------------------------------------------- Send USR1 to lonc
241:
242: sub reconlonc {
243: my $peerfile=shift;
244: &logthis("Trying to reconnect for $peerfile");
245: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
246: if (my $fh=Apache::File->new("$loncfile")) {
247: my $loncpid=<$fh>;
248: chomp($loncpid);
249: if (kill 0 => $loncpid) {
250: &logthis("lonc at pid $loncpid responding, sending USR1");
251: kill USR1 => $loncpid;
252: sleep 1;
253: if (-e "$peerfile") { return; }
254: &logthis("$peerfile still not there, give it another try");
255: sleep 5;
256: if (-e "$peerfile") { return; }
1.12 www 257: &logthis(
258: "<font color=blue>WARNING: $peerfile still not there, giving up</font>");
1.1 albertel 259: } else {
1.12 www 260: &logthis(
261: "<font color=blue>WARNING:".
262: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 263: }
264: } else {
1.12 www 265: &logthis('<font color=blue>WARNING: lonc not running, giving up</font>');
1.1 albertel 266: }
267: }
268:
269: # ------------------------------------------------------ Critical communication
1.12 www 270:
1.1 albertel 271: sub critical {
272: my ($cmd,$server)=@_;
1.89 www 273: unless ($hostname{$server}) {
274: &logthis("<font color=blue>WARNING:".
275: " Critical message to unknown server ($server)</font>");
276: return 'no_such_host';
277: }
1.1 albertel 278: my $answer=reply($cmd,$server);
279: if ($answer eq 'con_lost') {
280: my $pingreply=reply('ping',$server);
281: &reconlonc("$perlvar{'lonSockDir'}/$server");
282: my $pongreply=reply('pong',$server);
283: &logthis("Ping/Pong for $server: $pingreply/$pongreply");
284: $answer=reply($cmd,$server);
285: if ($answer eq 'con_lost') {
286: my $now=time;
287: my $middlename=$cmd;
1.5 www 288: $middlename=substr($middlename,0,16);
1.1 albertel 289: $middlename=~s/\W//g;
290: my $dfilename=
291: "$perlvar{'lonSockDir'}/delayed/$now.$middlename.$server";
292: {
293: my $dfh;
294: if ($dfh=Apache::File->new(">$dfilename")) {
1.7 www 295: print $dfh "$cmd\n";
1.1 albertel 296: }
297: }
298: sleep 2;
299: my $wcmd='';
300: {
301: my $dfh;
302: if ($dfh=Apache::File->new("$dfilename")) {
303: $wcmd=<$dfh>;
304: }
305: }
306: chomp($wcmd);
1.7 www 307: if ($wcmd eq $cmd) {
1.12 www 308: &logthis("<font color=blue>WARNING: ".
309: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 310: &logperm("D:$server:$cmd");
311: return 'con_delayed';
312: } else {
1.12 www 313: &logthis("<font color=red>CRITICAL:"
314: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 315: &logperm("F:$server:$cmd");
316: return 'con_failed';
317: }
318: }
319: }
320: return $answer;
321: }
322:
1.5 www 323: # ---------------------------------------------------------- Append Environment
324:
325: sub appenv {
1.6 www 326: my %newenv=@_;
1.35 www 327: map {
328: if (($newenv{$_}=~/^user\.role/) || ($newenv{$_}=~/^user\.priv/)) {
329: &logthis("<font color=blue>WARNING: ".
1.151 www 330: "Attempt to modify environment ".$_." to ".$newenv{$_}
331: .'</font>');
1.35 www 332: delete($newenv{$_});
333: } else {
334: $ENV{$_}=$newenv{$_};
335: }
336: } keys %newenv;
1.95 www 337:
338: my $lockfh;
339: unless ($lockfh=Apache::File->new("$ENV{'user.environment'}")) {
1.97 www 340: return 'error: '.$!;
1.95 www 341: }
342: unless (flock($lockfh,LOCK_EX)) {
343: &logthis("<font color=blue>WARNING: ".
344: 'Could not obtain exclusive lock in appenv: '.$!);
345: $lockfh->close();
346: return 'error: '.$!;
347: }
348:
1.6 www 349: my @oldenv;
350: {
351: my $fh;
352: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
1.97 www 353: return 'error: '.$!;
1.6 www 354: }
355: @oldenv=<$fh>;
1.89 www 356: $fh->close();
1.6 www 357: }
358: for (my $i=0; $i<=$#oldenv; $i++) {
359: chomp($oldenv[$i]);
1.9 www 360: if ($oldenv[$i] ne '') {
361: my ($name,$value)=split(/=/,$oldenv[$i]);
1.24 www 362: unless (defined($newenv{$name})) {
363: $newenv{$name}=$value;
364: }
1.9 www 365: }
1.6 www 366: }
367: {
368: my $fh;
369: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
370: return 'error';
371: }
372: my $newname;
1.93 www 373: foreach $newname (keys %newenv) {
1.6 www 374: print $fh "$newname=$newenv{$newname}\n";
375: }
1.86 albertel 376: $fh->close();
1.56 www 377: }
1.95 www 378:
379: $lockfh->close();
1.56 www 380: return 'ok';
381: }
382: # ----------------------------------------------------- Delete from Environment
383:
384: sub delenv {
385: my $delthis=shift;
386: my %newenv=();
387: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
388: &logthis("<font color=blue>WARNING: ".
389: "Attempt to delete from environment ".$delthis);
390: return 'error';
391: }
392: my @oldenv;
393: {
394: my $fh;
395: unless ($fh=Apache::File->new("$ENV{'user.environment'}")) {
396: return 'error';
397: }
1.89 www 398: unless (flock($fh,LOCK_SH)) {
399: &logthis("<font color=blue>WARNING: ".
400: 'Could not obtain shared lock in delenv: '.$!);
401: $fh->close();
402: return 'error: '.$!;
403: }
1.56 www 404: @oldenv=<$fh>;
1.89 www 405: $fh->close();
1.56 www 406: }
407: {
408: my $fh;
409: unless ($fh=Apache::File->new(">$ENV{'user.environment'}")) {
410: return 'error';
411: }
1.89 www 412: unless (flock($fh,LOCK_EX)) {
413: &logthis("<font color=blue>WARNING: ".
414: 'Could not obtain exclusive lock in delenv: '.$!);
415: $fh->close();
416: return 'error: '.$!;
417: }
1.56 www 418: map {
419: unless ($_=~/^$delthis/) { print $fh $_; }
420: } @oldenv;
1.87 www 421: $fh->close();
1.5 www 422: }
423: return 'ok';
424: }
1.1 albertel 425:
426: # ------------------------------ Find server with least workload from spare.tab
1.11 www 427:
1.1 albertel 428: sub spareserver {
429: my $tryserver;
430: my $spareserver='';
431: my $lowestserver=100;
432: foreach $tryserver (keys %spareid) {
433: my $answer=reply('load',$tryserver);
434: if (($answer =~ /\d/) && ($answer<$lowestserver)) {
435: $spareserver="http://$hostname{$tryserver}";
436: $lowestserver=$answer;
437: }
438: }
439: return $spareserver;
440: }
441:
1.169 harris41 442: # ----------------------- Try to determine user's current authentication scheme
443:
444: sub queryauthenticate {
445: my ($uname,$udom)=@_;
446: if (($perlvar{'lonRole'} eq 'library') &&
447: ($udom eq $perlvar{'lonDefDomain'})) {
448: my $answer=reply("encrypt:currentauth:$udom:$uname",
449: $perlvar{'lonHostID'});
450: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
451: if (length($answer)) {
452: return $answer;
453: }
454: else {
455: &logthis("User $uname at $udom lacks an authentication mechanism");
456: return 'no_host';
457: }
458: }
459: }
460:
461: my $tryserver;
462: foreach $tryserver (keys %libserv) {
463: if ($hostdom{$tryserver} eq $udom) {
464: my $answer=reply("encrypt:currentauth:$udom:$uname",$tryserver);
465: unless ($answer eq 'unknown_user' or $answer eq 'refused') {
466: if (length($answer)) {
467: return $answer;
468: }
469: else {
470: &logthis("User $uname at $udom lacks an authentication mechanism");
471: return 'no_host';
472: }
473: }
474: }
475: }
476: &logthis("User $uname at $udom lacks an authentication mechanism");
477: return 'no_host';
478: }
479:
1.1 albertel 480: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 481:
1.1 albertel 482: sub authenticate {
483: my ($uname,$upass,$udom)=@_;
1.12 www 484: $upass=escape($upass);
1.1 albertel 485: if (($perlvar{'lonRole'} eq 'library') &&
486: ($udom eq $perlvar{'lonDefDomain'})) {
1.3 www 487: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$perlvar{'lonHostID'});
1.2 www 488: if ($answer =~ /authorized/) {
1.9 www 489: if ($answer eq 'authorized') {
490: &logthis("User $uname at $udom authorized by local server");
491: return $perlvar{'lonHostID'};
492: }
493: if ($answer eq 'non_authorized') {
494: &logthis("User $uname at $udom rejected by local server");
495: return 'no_host';
496: }
1.2 www 497: }
1.1 albertel 498: }
499:
500: my $tryserver;
501: foreach $tryserver (keys %libserv) {
502: if ($hostdom{$tryserver} eq $udom) {
1.10 www 503: my $answer=reply("encrypt:auth:$udom:$uname:$upass",$tryserver);
1.1 albertel 504: if ($answer =~ /authorized/) {
1.9 www 505: if ($answer eq 'authorized') {
506: &logthis("User $uname at $udom authorized by $tryserver");
507: return $tryserver;
508: }
509: if ($answer eq 'non_authorized') {
510: &logthis("User $uname at $udom rejected by $tryserver");
511: return 'no_host';
512: }
1.1 albertel 513: }
514: }
1.9 www 515: }
516: &logthis("User $uname at $udom could not be authenticated");
1.1 albertel 517: return 'no_host';
518: }
519:
520: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 521:
1.1 albertel 522: sub homeserver {
523: my ($uname,$udom)=@_;
524:
525: my $index="$uname:$udom";
526: if ($homecache{$index}) { return "$homecache{$index}"; }
527:
528: my $tryserver;
529: foreach $tryserver (keys %libserv) {
530: if ($hostdom{$tryserver} eq $udom) {
531: my $answer=reply("home:$udom:$uname",$tryserver);
532: if ($answer eq 'found') {
533: $homecache{$index}=$tryserver;
534: return $tryserver;
535: }
536: }
537: }
538: return 'no_host';
1.70 www 539: }
540:
541: # ------------------------------------- Find the usernames behind a list of IDs
542:
543: sub idget {
544: my ($udom,@ids)=@_;
545: my %returnhash=();
546:
547: my $tryserver;
548: foreach $tryserver (keys %libserv) {
549: if ($hostdom{$tryserver} eq $udom) {
550: my $idlist=join('&',@ids);
551: $idlist=~tr/A-Z/a-z/;
552: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
553: my @answer=();
1.76 www 554: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1.70 www 555: @answer=split(/\&/,$reply);
556: } ;
557: my $i;
558: for ($i=0;$i<=$#ids;$i++) {
559: if ($answer[$i]) {
560: $returnhash{$ids[$i]}=$answer[$i];
561: }
562: }
563: }
564: }
565: return %returnhash;
566: }
567:
568: # ------------------------------------- Find the IDs behind a list of usernames
569:
570: sub idrget {
571: my ($udom,@unames)=@_;
572: my %returnhash=();
573: map {
574: $returnhash{$_}=(&userenvironment($udom,$_,'id'))[1];
575: } @unames;
576: return %returnhash;
577: }
578:
579: # ------------------------------- Store away a list of names and associated IDs
580:
581: sub idput {
582: my ($udom,%ids)=@_;
583: my %servers=();
584: map {
585: my $uhom=&homeserver($_,$udom);
586: if ($uhom ne 'no_host') {
587: my $id=&escape($ids{$_});
588: $id=~tr/A-Z/a-z/;
589: my $unam=&escape($_);
590: if ($servers{$uhom}) {
591: $servers{$uhom}.='&'.$id.'='.$unam;
592: } else {
593: $servers{$uhom}=$id.'='.$unam;
594: }
595: &critical('put:'.$udom.':'.$unam.':environment:id='.$id,$uhom);
596: }
597: } keys %ids;
598: map {
599: &critical('idput:'.$udom.':'.$servers{$_},$_);
600: } keys %servers;
601: }
602:
603: # ------------------------------------- Find the section of student in a course
604:
605: sub usection {
606: my ($udom,$unam,$courseid)=@_;
607: $courseid=~s/\_/\//g;
608: $courseid=~s/^(\w)/\/$1/;
609: map {
610: my ($key,$value)=split(/\=/,$_);
611: $key=&unescape($key);
612: if ($key=~/^$courseid(?:\/)*(\w+)*\_st$/) {
613: my $section=$1;
614: if ($key eq $courseid.'_st') { $section=''; }
615: my ($dummy,$end,$start)=split(/\_/,&unescape($value));
616: my $now=time;
617: my $notactive=0;
618: if ($start) {
619: if ($now<$start) { $notactive=1; }
620: }
621: if ($end) {
622: if ($now>$end) { $notactive=1; }
623: }
624: unless ($notactive) { return $section; }
625: }
626: } split(/\&/,&reply('dump:'.$udom.':'.$unam.':roles',
627: &homeserver($unam,$udom)));
628: return '-1';
629: }
630:
631: # ------------------------------------- Read an entry from a user's environment
632:
633: sub userenvironment {
634: my ($udom,$unam,@what)=@_;
635: my %returnhash=();
636: my @answer=split(/\&/,
637: &reply('get:'.$udom.':'.$unam.':environment:'.join('&',@what),
638: &homeserver($unam,$udom)));
639: my $i;
640: for ($i=0;$i<=$#what;$i++) {
641: $returnhash{$what[$i]}=&unescape($answer[$i]);
642: }
643: return %returnhash;
1.1 albertel 644: }
645:
646: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 647:
1.1 albertel 648: sub subscribe {
649: my $fname=shift;
650: my $author=$fname;
651: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
652: my ($udom,$uname)=split(/\//,$author);
653: my $home=homeserver($uname,$udom);
654: if (($home eq 'no_host') || ($home eq $perlvar{'lonHostID'})) {
655: return 'not_found';
656: }
657: my $answer=reply("sub:$fname",$home);
1.64 www 658: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
659: $answer.=' by '.$home;
660: }
1.1 albertel 661: return $answer;
662: }
663:
1.8 www 664: # -------------------------------------------------------------- Replicate file
665:
666: sub repcopy {
667: my $filename=shift;
1.23 www 668: $filename=~s/\/+/\//g;
1.8 www 669: my $transname="$filename.in.transfer";
1.17 www 670: if ((-e $filename) || (-e $transname)) { return OK; }
1.8 www 671: my $remoteurl=subscribe($filename);
1.64 www 672: if ($remoteurl =~ /^con_lost by/) {
673: &logthis("Subscribe returned $remoteurl: $filename");
1.8 www 674: return HTTP_SERVICE_UNAVAILABLE;
675: } elsif ($remoteurl eq 'not_found') {
676: &logthis("Subscribe returned not_found: $filename");
677: return HTTP_NOT_FOUND;
1.64 www 678: } elsif ($remoteurl =~ /^rejected by/) {
679: &logthis("Subscribe returned $remoteurl: $filename");
1.8 www 680: return FORBIDDEN;
1.20 www 681: } elsif ($remoteurl eq 'directory') {
682: return OK;
1.8 www 683: } else {
684: my @parts=split(/\//,$filename);
685: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
686: if ($path ne "$perlvar{'lonDocRoot'}/res") {
687: &logthis("Malconfiguration for replication: $filename");
688: return HTTP_BAD_REQUEST;
689: }
690: my $count;
691: for ($count=5;$count<$#parts;$count++) {
692: $path.="/$parts[$count]";
693: if ((-e $path)!=1) {
694: mkdir($path,0777);
695: }
696: }
697: my $ua=new LWP::UserAgent;
698: my $request=new HTTP::Request('GET',"$remoteurl");
699: my $response=$ua->request($request,$transname);
700: if ($response->is_error()) {
701: unlink($transname);
702: my $message=$response->status_line;
1.12 www 703: &logthis("<font color=blue>WARNING:"
704: ." LWP get: $message: $filename</font>");
1.8 www 705: return HTTP_SERVICE_UNAVAILABLE;
706: } else {
1.16 www 707: if ($remoteurl!~/\.meta$/) {
708: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
709: my $mresponse=$ua->request($mrequest,$filename.'.meta');
710: if ($mresponse->is_error()) {
711: unlink($filename.'.meta');
712: &logthis(
713: "<font color=yellow>INFO: No metadata: $filename</font>");
714: }
715: }
1.8 www 716: rename($transname,$filename);
717: return OK;
718: }
719: }
720: }
721:
1.15 www 722: # --------------------------------------------------------- Server Side Include
723:
724: sub ssi {
725:
1.23 www 726: my ($fn,%form)=@_;
1.15 www 727:
728: my $ua=new LWP::UserAgent;
1.23 www 729:
730: my $request;
731:
732: if (%form) {
733: $request=new HTTP::Request('POST',"http://".$ENV{'HTTP_HOST'}.$fn);
734: $request->content(join '&', map { "$_=$form{$_}" } keys %form);
735: } else {
736: $request=new HTTP::Request('GET',"http://".$ENV{'HTTP_HOST'}.$fn);
737: }
738:
1.15 www 739: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
740: my $response=$ua->request($request);
741:
742: return $response->content;
743: }
744:
1.14 www 745: # ------------------------------------------------------------------------- Log
746:
747: sub log {
748: my ($dom,$nam,$hom,$what)=@_;
1.47 www 749: return critical("log:$dom:$nam:$what",$hom);
1.157 www 750: }
751:
752: # ------------------------------------------------------------------ Course Log
753:
754: sub flushcourselogs {
755: &logthis('Flushing course log buffers');
756: map {
757: my $crsid=$_;
758: if (&reply('log:'.$ENV{'course.'.$crsid.'.domain'}.':'.
759: $ENV{'course.'.$crsid.'.num'}.':'.
760: &escape($courselogs{$crsid}),
761: $ENV{'course.'.$crsid.'.home'}) eq 'ok') {
762: delete $courselogs{$crsid};
763: } else {
764: &logthis('Failed to flush log buffer for '.$crsid);
765: if (length($courselogs{$crsid})>40000) {
766: &logthis("<font color=blue>WARNING: Buffer for ".$crsid.
767: " exceeded maximum size, deleting.</font>");
768: delete $courselogs{$crsid};
769: }
770: }
771: } keys %courselogs;
1.185 www 772: &logthis('Flushing access logs');
773: map {
774: my $entry=$_;
775: $entry=~/\_\_\_(\w+)\/(\w+)\/(.*)\_\_\_(\w+)$/;
776: my %temphash=($entry => $accesshash{$entry});
777: if (&Apache::lonnet::put('resevaldata',\%temphash,$1,$2) eq 'ok') {
778: delete $accesshash{$entry};
779: }
780: } keys %accesshash;
1.186 www 781: $dumpcount++;
1.157 www 782: }
783:
784: sub courselog {
785: my $what=shift;
1.158 www 786: $what=time.':'.$what;
1.157 www 787: unless ($ENV{'request.course.id'}) { return ''; }
788: if (defined $courselogs{$ENV{'request.course.id'}}) {
789: $courselogs{$ENV{'request.course.id'}}.='&'.$what;
790: } else {
791: $courselogs{$ENV{'request.course.id'}}.=$what;
792: }
793: if (length($courselogs{$ENV{'request.course.id'}})>4048) {
794: &flushcourselogs();
795: }
1.158 www 796: }
797:
798: sub courseacclog {
799: my $fnsymb=shift;
800: unless ($ENV{'request.course.id'}) { return ''; }
801: my $what=$fnsymb.':'.$ENV{'user.name'}.':'.$ENV{'user.domain'};
802: if ($what=~/(problem|exam|quiz|assess|survey|form)$/) {
1.187 ! www 803: $what.=':POST';
1.158 www 804: map {
805: if ($_=~/^form\.(.*)/) {
806: $what.=':'.$1.'='.$ENV{$_};
807: }
808: } keys %ENV;
809: }
810: &courselog($what);
1.149 www 811: }
812:
1.185 www 813: sub countacc {
814: my $url=&declutter(shift);
815: unless ($ENV{'request.course.id'}) { return ''; }
816: $accesshash{$ENV{'request.course.id'}.'___'.$url.'___course'}=1;
1.186 www 817: my $key=$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.185 www 818: if (defined($accesshash{$key})) {
819: $accesshash{$key}++;
820: } else {
821: $accesshash{$key}=1;
822: }
823: }
824:
1.149 www 825: # ----------------------------------------------------------- Check out an item
826:
827: sub checkout {
828: my ($symb,$tuname,$tudom,$tcrsid)=@_;
829: my $now=time;
830: my $lonhost=$perlvar{'lonHostID'};
831: my $infostr=&escape(
832: $tuname.'&'.
833: $tudom.'&'.
834: $tcrsid.'&'.
835: $symb.'&'.
836: $now.'&'.$ENV{'REMOTE_ADDR'});
837: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 838: if ($token=~/^error\:/) {
839: &logthis("<font color=blue>WARNING: ".
840: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
841: "</font>");
842: return '';
843: }
844:
1.149 www 845: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
846: $token=~tr/a-z/A-Z/;
847:
1.153 www 848: my %infohash=('resource.0.outtoken' => $token,
849: 'resource.0.checkouttime' => $now,
850: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 851:
852: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
853: return '';
1.151 www 854: } else {
855: &logthis("<font color=blue>WARNING: ".
856: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
857: "</font>");
1.149 www 858: }
859:
860: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
861: &escape('Checkout '.$infostr.' - '.
862: $token)) ne 'ok') {
863: return '';
1.151 www 864: } else {
865: &logthis("<font color=blue>WARNING: ".
866: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
867: "</font>");
1.149 www 868: }
1.151 www 869: return $token;
1.149 www 870: }
871:
872: # ------------------------------------------------------------ Check in an item
873:
874: sub checkin {
875: my $token=shift;
1.150 www 876: my $now=time;
877: my ($ta,$tb,$lonhost)=split(/\*/,$token);
878: $lonhost=~tr/A-Z/a-z/;
879: my $dtoken=$ta.'_'.$hostip{$lonhost}.'_'.$tb;
880: $dtoken=~s/\W/\_/g;
881: my ($tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
882: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
883:
1.154 www 884: unless (($tuname) && ($tudom)) {
885: &logthis('Check in '.$token.' ('.$dtoken.') failed');
886: return '';
887: }
888:
889: unless (&allowed('mgr',$tcrsid)) {
890: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
891: $ENV{'user.name'}.' - '.$ENV{'user.domain'});
892: return '';
893: }
894:
1.153 www 895: my %infohash=('resource.0.intoken' => $token,
896: 'resource.0.checkintime' => $now,
897: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 898:
899: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
900: return '';
901: }
902:
903: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
904: &escape('Checkin - '.$token)) ne 'ok') {
905: return '';
906: }
907:
908: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 909: }
910:
911: # --------------------------------------------- Set Expire Date for Spreadsheet
912:
913: sub expirespread {
914: my ($uname,$udom,$stype,$usymb)=@_;
915: my $cid=$ENV{'request.course.id'};
916: if ($cid) {
917: my $now=time;
918: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
919: return &reply('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
920: $ENV{'course.'.$cid.'.num'}.
921: ':nohist_expirationdates:'.
922: &escape($key).'='.$now,
923: $ENV{'course.'.$cid.'.home'})
924: }
925: return 'ok';
1.14 www 926: }
927:
1.109 www 928: # ----------------------------------------------------- Devalidate Spreadsheets
929:
930: sub devalidate {
931: my $symb=shift;
932: my $cid=$ENV{'request.course.id'};
933: if ($cid) {
934: my $key=$ENV{'user.name'}.':'.$ENV{'user.domain'}.':';
935: my $status=
1.133 albertel 936: &del('nohist_calculatedsheet',
937: [$key.'studentcalc'],
938: $ENV{'course.'.$cid.'.domain'},
939: $ENV{'course.'.$cid.'.num'})
940: .' '.
941: &del('nohist_calculatedsheets_'.$cid,
942: [$key.'assesscalc:'.$symb]);
1.109 www 943: unless ($status eq 'ok ok') {
944: &logthis('Could not devalidate spreadsheet '.
945: $ENV{'user.name'}.' at '.$ENV{'user.domain'}.' for '.
946: $symb.': '.$status);
1.133 albertel 947: }
1.109 www 948: }
949: }
950:
1.168 albertel 951: sub hash2str {
952: my (%hash)=@_;
953: my $result='';
954: map { $result.=escape($_).'='.escape($hash{$_}).'&'; } keys %hash;
955: $result=~s/\&$//;
956: return $result;
957: }
958:
959: sub str2hash {
960: my ($string) = @_;
961: my %returnhash;
962: map {
963: my ($name,$value)=split(/\=/,$_);
964: $returnhash{&unescape($name)}=&unescape($value);
965: } split(/\&/,$string);
966: return %returnhash;
967: }
968:
1.167 albertel 969: # -------------------------------------------------------------------Temp Store
970:
1.168 albertel 971: sub tmpreset {
972: my ($symb,$namespace,$domain,$stuname) = @_;
973: if (!$symb) {
974: $symb=&symbread();
975: if (!$symb) { $symb= $ENV{'REQUEST_URI'}; }
976: }
977: $symb=escape($symb);
978:
979: if (!$namespace) { $namespace=$ENV{'request.state'}; }
980: $namespace=~s/\//\_/g;
981: $namespace=~s/\W//g;
982:
983: #FIXME needs to do something for /pub resources
984: if (!$domain) { $domain=$ENV{'user.domain'}; }
985: if (!$stuname) { $stuname=$ENV{'user.name'}; }
986: my $path=$perlvar{'lonDaemons'}.'/tmp';
987: my %hash;
988: if (tie(%hash,'GDBM_File',
989: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
990: &GDBM_WRCREAT,0640)) {
991: foreach my $key (keys %hash) {
1.180 albertel 992: if ($key=~ /:$symb/) {
1.168 albertel 993: delete($hash{$key});
994: }
995: }
996: }
997: }
998:
1.167 albertel 999: sub tmpstore {
1.168 albertel 1000: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1001:
1002: if (!$symb) {
1003: $symb=&symbread();
1004: if (!$symb) { $symb= $ENV{'request.url'}; }
1005: }
1006: $symb=escape($symb);
1007:
1008: if (!$namespace) {
1009: # I don't think we would ever want to store this for a course.
1010: # it seems this will only be used if we don't have a course.
1011: #$namespace=$ENV{'request.course.id'};
1012: #if (!$namespace) {
1013: $namespace=$ENV{'request.state'};
1014: #}
1015: }
1016: $namespace=~s/\//\_/g;
1017: $namespace=~s/\W//g;
1018: #FIXME needs to do something for /pub resources
1019: if (!$domain) { $domain=$ENV{'user.domain'}; }
1020: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1021: my $now=time;
1022: my %hash;
1023: my $path=$perlvar{'lonDaemons'}.'/tmp';
1024: if (tie(%hash,'GDBM_File',
1025: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1026: &GDBM_WRCREAT,0640)) {
1027: $hash{"version:$symb"}++;
1028: my $version=$hash{"version:$symb"};
1029: my $allkeys='';
1030: foreach my $key (keys(%$storehash)) {
1031: $allkeys.=$key.':';
1032: $hash{"$version:$symb:$key"}=$$storehash{$key};
1033: }
1034: $hash{"$version:$symb:timestamp"}=$now;
1035: $allkeys.='timestamp';
1036: $hash{"$version:keys:$symb"}=$allkeys;
1037: if (untie(%hash)) {
1038: return 'ok';
1039: } else {
1040: return "error:$!";
1041: }
1042: } else {
1043: return "error:$!";
1044: }
1045: }
1.167 albertel 1046:
1.168 albertel 1047: # -----------------------------------------------------------------Temp Restore
1.167 albertel 1048:
1.168 albertel 1049: sub tmprestore {
1050: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 1051:
1.168 albertel 1052: if (!$symb) {
1053: $symb=&symbread();
1054: if (!$symb) { $symb= $ENV{'request.url'}; }
1055: }
1056: $symb=escape($symb);
1057:
1058: if (!$namespace) { $namespace=$ENV{'request.state'}; }
1059: #FIXME needs to do something for /pub resources
1060: if (!$domain) { $domain=$ENV{'user.domain'}; }
1061: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1062:
1063: my %returnhash;
1064: $namespace=~s/\//\_/g;
1065: $namespace=~s/\W//g;
1066: my %hash;
1067: my $path=$perlvar{'lonDaemons'}.'/tmp';
1068: if (tie(%hash,'GDBM_File',
1069: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1070: &GDBM_READER,0640)) {
1071: my $version=$hash{"version:$symb"};
1072: $returnhash{'version'}=$version;
1073: my $scope;
1074: for ($scope=1;$scope<=$version;$scope++) {
1075: my $vkeys=$hash{"$scope:keys:$symb"};
1076: my @keys=split(/:/,$vkeys);
1077: my $key;
1078: $returnhash{"$scope:keys"}=$vkeys;
1079: foreach $key (@keys) {
1080: $returnhash{"$scope:$key"}=$hash{"$scope:$symb:$key"};
1081: $returnhash{"$key"}=$hash{"$scope:$symb:$key"};
1.167 albertel 1082: }
1083: }
1.168 albertel 1084: if (!(untie(%hash))) {
1085: return "error:$!";
1086: }
1087: } else {
1088: return "error:$!";
1089: }
1090: return %returnhash;
1.167 albertel 1091: }
1092:
1.9 www 1093: # ----------------------------------------------------------------------- Store
1094:
1095: sub store {
1.124 www 1096: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1097: my $home='';
1098:
1.168 albertel 1099: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 1100:
1.122 albertel 1101: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 1102:
1103: &devalidate($symb);
1104:
1105: $symb=escape($symb);
1.187 ! www 1106: if (!$namespace) {
! 1107: unless ($namespace=$ENV{'request.course.id'}) {
! 1108: return '';
! 1109: }
! 1110: }
1.122 albertel 1111: if (!$domain) { $domain=$ENV{'user.domain'}; }
1112: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1113: if (!$home) { $home=$ENV{'user.home'}; }
1.12 www 1114: my $namevalue='';
1115: map {
1.122 albertel 1116: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1117: } keys %$storehash;
1.12 www 1118: $namevalue=~s/\&$//;
1.187 ! www 1119: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 1120: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 1121: }
1122:
1.47 www 1123: # -------------------------------------------------------------- Critical Store
1124:
1125: sub cstore {
1.124 www 1126: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
1127: my $home='';
1128:
1.168 albertel 1129: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 1130:
1.122 albertel 1131: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 1132:
1133: &devalidate($symb);
1134:
1135: $symb=escape($symb);
1.187 ! www 1136: if (!$namespace) {
! 1137: unless ($namespace=$ENV{'request.course.id'}) {
! 1138: return '';
! 1139: }
! 1140: }
1.122 albertel 1141: if (!$domain) { $domain=$ENV{'user.domain'}; }
1142: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1143: if (!$home) { $home=$ENV{'user.home'}; }
1144:
1.47 www 1145: my $namevalue='';
1146: map {
1.122 albertel 1147: $namevalue.=escape($_).'='.escape($$storehash{$_}).'&';
1148: } keys %$storehash;
1.47 www 1149: $namevalue=~s/\&$//;
1.187 ! www 1150: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.122 albertel 1151: return critical("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 1152: }
1153:
1.9 www 1154: # --------------------------------------------------------------------- Restore
1155:
1156: sub restore {
1.124 www 1157: my ($symb,$namespace,$domain,$stuname) = @_;
1158: my $home='';
1159:
1.168 albertel 1160: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 1161:
1.122 albertel 1162: if (!$symb) {
1163: unless ($symb=escape(&symbread())) { return ''; }
1164: } else {
1165: $symb=&escape($symb);
1166: }
1167: if (!$namespace) { unless ($namespace=$ENV{'request.course.id'}) { return ''; } }
1168: if (!$domain) { $domain=$ENV{'user.domain'}; }
1169: if (!$stuname) { $stuname=$ENV{'user.name'}; }
1170: if (!$home) { $home=$ENV{'user.home'}; }
1171: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
1172:
1.12 www 1173: my %returnhash=();
1174: map {
1175: my ($name,$value)=split(/\=/,$_);
1176: $returnhash{&unescape($name)}=&unescape($value);
1177: } split(/\&/,$answer);
1.75 www 1178: my $version;
1179: for ($version=1;$version<=$returnhash{'version'};$version++) {
1180: map {
1181: $returnhash{$_}=$returnhash{$version.':'.$_};
1182: } split(/\:/,$returnhash{$version.':keys'});
1183: }
1.13 www 1184: return %returnhash;
1.34 www 1185: }
1186:
1187: # ---------------------------------------------------------- Course Description
1188:
1189: sub coursedescription {
1190: my $courseid=shift;
1191: $courseid=~s/^\///;
1.49 www 1192: $courseid=~s/\_/\//g;
1.34 www 1193: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 1194: my $chome=&homeserver($cnum,$cdomain);
1.34 www 1195: if ($chome ne 'no_host') {
1.129 albertel 1196: my %returnhash=&dump('environment',$cdomain,$cnum);
1197: if (!exists($returnhash{'con_lost'})) {
1.96 www 1198: my $normalid=$cdomain.'_'.$cnum;
1.53 www 1199: my %envhash=();
1.129 albertel 1200: $returnhash{'home'}= $chome;
1201: $returnhash{'domain'} = $cdomain;
1202: $returnhash{'num'} = $cnum;
1.130 albertel 1203: while (my ($name,$value) = each %returnhash) {
1.53 www 1204: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 1205: }
1.34 www 1206: $returnhash{'url'}='/res/'.declutter($returnhash{'url'});
1207: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.38 www 1208: $ENV{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.54 www 1209: $envhash{'course.'.$normalid.'.last_cache'}=time;
1.60 www 1210: $envhash{'course.'.$normalid.'.home'}=$chome;
1211: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
1212: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.53 www 1213: &appenv(%envhash);
1.34 www 1214: return %returnhash;
1215: }
1216: }
1217: return ();
1.9 www 1218: }
1.1 albertel 1219:
1.103 harris41 1220: # -------------------------------------------------------- Get user privileges
1.11 www 1221:
1222: sub rolesinit {
1223: my ($domain,$username,$authhost)=@_;
1224: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.12 www 1225: if (($rolesdump eq 'con_lost') || ($rolesdump eq '')) { return ''; }
1.11 www 1226: my %allroles=();
1227: my %thesepriv=();
1228: my $now=time;
1.21 www 1229: my $userroles="user.login.time=$now\n";
1.11 www 1230: my $thesestr;
1231:
1232: if ($rolesdump ne '') {
1233: map {
1.21 www 1234: if ($_!~/^rolesdef\&/) {
1.11 www 1235: my ($area,$role)=split(/=/,$_);
1.21 www 1236: $area=~s/\_\w\w$//;
1.11 www 1237: my ($trole,$tend,$tstart)=split(/_/,$role);
1.21 www 1238: $userroles.='user.role.'.$trole.'.'.$area.'='.
1239: $tstart.'.'.$tend."\n";
1.11 www 1240: if ($tend!=0) {
1241: if ($tend<$now) {
1242: $trole='';
1243: }
1244: }
1245: if ($tstart!=0) {
1246: if ($tstart>$now) {
1247: $trole='';
1248: }
1249: }
1250: if (($area ne '') && ($trole ne '')) {
1.50 www 1251: my $spec=$trole.'.'.$area;
1.12 www 1252: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
1253: if ($trole =~ /^cr\//) {
1254: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1255: my $homsvr=homeserver($rauthor,$rdomain);
1256: if ($hostname{$homsvr} ne '') {
1257: my $roledef=
1.21 www 1258: reply("get:$rdomain:$rauthor:roles:rolesdef_$rrole",
1.12 www 1259: $homsvr);
1260: if (($roledef ne 'con_lost') && ($roledef ne '')) {
1261: my ($syspriv,$dompriv,$coursepriv)=
1.21 www 1262: split(/\_/,unescape($roledef));
1.50 www 1263: $allroles{'cm./'}.=':'.$syspriv;
1264: $allroles{$spec.'./'}.=':'.$syspriv;
1.12 www 1265: if ($tdomain ne '') {
1.50 www 1266: $allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
1267: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
1.12 www 1268: if ($trest ne '') {
1.50 www 1269: $allroles{'cm.'.$area}.=':'.$coursepriv;
1270: $allroles{$spec.'.'.$area}.=':'.$coursepriv;
1.12 www 1271: }
1272: }
1273: }
1.11 www 1274: }
1.12 www 1275: } else {
1.50 www 1276: $allroles{'cm./'}.=':'.$pr{$trole.':s'};
1277: $allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
1.12 www 1278: if ($tdomain ne '') {
1.50 www 1279: $allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1280: $allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
1.12 www 1281: if ($trest ne '') {
1.50 www 1282: $allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
1283: $allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
1.12 www 1284: }
1285: }
1.11 www 1286: }
1.12 www 1287: }
1288: }
1.11 www 1289: } split(/&/,$rolesdump);
1.125 www 1290: my $adv=0;
1.128 www 1291: my $author=0;
1.11 www 1292: map {
1293: %thesepriv=();
1.146 www 1294: if (($_!~/^st/) && ($_!~/^ta/) && ($_!~/^cm/)) { $adv=1; }
1.128 www 1295: if (($_=~/^au/) || ($_=~/^ca/)) { $author=1; }
1.11 www 1296: map {
1297: if ($_ ne '') {
1.103 harris41 1298: my ($privilege,$restrictions)=split(/&/,$_);
1.11 www 1299: if ($restrictions eq '') {
1.103 harris41 1300: $thesepriv{$privilege}='F';
1.11 www 1301: } else {
1.103 harris41 1302: if ($thesepriv{$privilege} ne 'F') {
1303: $thesepriv{$privilege}.=$restrictions;
1.11 www 1304: }
1305: }
1306: }
1307: } split(/:/,$allroles{$_});
1308: $thesestr='';
1309: map { $thesestr.=':'.$_.'&'.$thesepriv{$_}; } keys %thesepriv;
1310: $userroles.='user.priv.'.$_.'='.$thesestr."\n";
1311: } keys %allroles;
1.128 www 1312: $userroles.='user.adv='.$adv."\n".
1313: 'user.author='.$author."\n";
1.126 www 1314: $ENV{'user.adv'}=$adv;
1.11 www 1315: }
1316: return $userroles;
1317: }
1318:
1.12 www 1319: # --------------------------------------------------------------- get interface
1320:
1321: sub get {
1.131 albertel 1322: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 1323: my $items='';
1324: map {
1325: $items.=escape($_).'&';
1.131 albertel 1326: } @$storearr;
1.12 www 1327: $items=~s/\&$//;
1.131 albertel 1328: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1329: if (!$uname) { $uname=$ENV{'user.name'}; }
1330: my $uhome=&homeserver($uname,$udomain);
1331:
1.133 albertel 1332: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 1333: my @pairs=split(/\&/,$rep);
1334: my %returnhash=();
1.42 www 1335: my $i=0;
1.15 www 1336: map {
1.42 www 1337: $returnhash{$_}=unescape($pairs[$i]);
1338: $i++;
1.131 albertel 1339: } @$storearr;
1.15 www 1340: return %returnhash;
1.27 www 1341: }
1342:
1343: # --------------------------------------------------------------- del interface
1344:
1345: sub del {
1.133 albertel 1346: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 1347: my $items='';
1348: map {
1349: $items.=escape($_).'&';
1.133 albertel 1350: } @$storearr;
1.27 www 1351: $items=~s/\&$//;
1.133 albertel 1352: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1353: if (!$uname) { $uname=$ENV{'user.name'}; }
1354: my $uhome=&homeserver($uname,$udomain);
1355:
1356: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 1357: }
1358:
1359: # -------------------------------------------------------------- dump interface
1360:
1361: sub dump {
1.129 albertel 1362: my ($namespace,$udomain,$uname)=@_;
1363: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1364: if (!$uname) { $uname=$ENV{'user.name'}; }
1365: my $uhome=&homeserver($uname,$udomain);
1366: my $rep=reply("dump:$udomain:$uname:$namespace",$uhome);
1.12 www 1367: my @pairs=split(/\&/,$rep);
1368: my %returnhash=();
1369: map {
1370: my ($key,$value)=split(/=/,$_);
1.29 www 1371: $returnhash{unescape($key)}=unescape($value);
1.12 www 1372: } @pairs;
1373: return %returnhash;
1374: }
1375:
1376: # --------------------------------------------------------------- put interface
1377:
1378: sub put {
1.134 albertel 1379: my ($namespace,$storehash,$udomain,$uname)=@_;
1380: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1381: if (!$uname) { $uname=$ENV{'user.name'}; }
1382: my $uhome=&homeserver($uname,$udomain);
1.12 www 1383: my $items='';
1384: map {
1.134 albertel 1385: $items.=&escape($_).'='.&escape($$storehash{$_}).'&';
1386: } keys %$storehash;
1.12 www 1387: $items=~s/\&$//;
1.134 albertel 1388: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 1389: }
1390:
1391: # ------------------------------------------------------ critical put interface
1392:
1393: sub cput {
1.134 albertel 1394: my ($namespace,$storehash,$udomain,$uname)=@_;
1395: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1396: if (!$uname) { $uname=$ENV{'user.name'}; }
1397: my $uhome=&homeserver($uname,$udomain);
1.47 www 1398: my $items='';
1399: map {
1.134 albertel 1400: $items.=escape($_).'='.escape($$storehash{$_}).'&';
1401: } keys %$storehash;
1.47 www 1402: $items=~s/\&$//;
1.134 albertel 1403: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 1404: }
1405:
1406: # -------------------------------------------------------------- eget interface
1407:
1408: sub eget {
1.133 albertel 1409: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 1410: my $items='';
1411: map {
1412: $items.=escape($_).'&';
1.133 albertel 1413: } @$storearr;
1.12 www 1414: $items=~s/\&$//;
1.133 albertel 1415: if (!$udomain) { $udomain=$ENV{'user.domain'}; }
1416: if (!$uname) { $uname=$ENV{'user.name'}; }
1417: my $uhome=&homeserver($uname,$udomain);
1418: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 1419: my @pairs=split(/\&/,$rep);
1420: my %returnhash=();
1.42 www 1421: my $i=0;
1.12 www 1422: map {
1.42 www 1423: $returnhash{$_}=unescape($pairs[$i]);
1424: $i++;
1.133 albertel 1425: } @$storearr;
1.12 www 1426: return %returnhash;
1427: }
1428:
1.103 harris41 1429: # ------------------------------------------------- Check for a user privilege
1.12 www 1430:
1431: sub allowed {
1432: my ($priv,$uri)=@_;
1.152 www 1433:
1434: my $orguri=$uri;
1.52 www 1435: $uri=&declutter($uri);
1.29 www 1436:
1.54 www 1437: # Free bre access to adm and meta resources
1.29 www 1438:
1.54 www 1439: if ((($uri=~/^adm\//) || ($uri=~/\.meta$/)) && ($priv eq 'bre')) {
1.14 www 1440: return 'F';
1.159 www 1441: }
1442:
1443: # Free bre to public access
1444:
1445: if ($priv eq 'bre') {
1446: if (&metadata($uri,'copyright') eq 'public') { return 'F'; }
1.14 www 1447: }
1.29 www 1448:
1.52 www 1449: my $thisallowed='';
1450: my $statecond=0;
1451: my $courseprivid='';
1452:
1453: # Course
1454:
1455: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'}=~/$priv\&([^\:]*)/) {
1456: $thisallowed.=$1;
1457: }
1.29 www 1458:
1.52 www 1459: # Domain
1460:
1461: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1462: =~/$priv\&([^\:]*)/) {
1.12 www 1463: $thisallowed.=$1;
1464: }
1.52 www 1465:
1466: # Course: uri itself is a course
1.66 www 1467: my $courseuri=$uri;
1468: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 1469: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 1470:
1.83 www 1471: if ($ENV{'user.priv.'.$ENV{'request.role'}.'.'.$courseuri}
1.52 www 1472: =~/$priv\&([^\:]*)/) {
1.12 www 1473: $thisallowed.=$1;
1474: }
1.29 www 1475:
1.52 www 1476: # Full access at system, domain or course-wide level? Exit.
1.29 www 1477:
1478: if ($thisallowed=~/F/) {
1479: return 'F';
1480: }
1481:
1.52 www 1482: # If this is generating or modifying users, exit with special codes
1.29 www 1483:
1.166 www 1484: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:'=~/\:$priv\:/) {
1.52 www 1485: return $thisallowed;
1486: }
1487: #
1.103 harris41 1488: # Gathered so far: system, domain and course wide privileges
1.52 www 1489: #
1490: # Course: See if uri or referer is an individual resource that is part of
1491: # the course
1492:
1493: if ($ENV{'request.course.id'}) {
1494: $courseprivid=$ENV{'request.course.id'};
1495: if ($ENV{'request.course.sec'}) {
1496: $courseprivid.='/'.$ENV{'request.course.sec'};
1497: }
1498: $courseprivid=~s/\_/\//;
1499: my $checkreferer=1;
1500: my @uriparts=split(/\//,$uri);
1501: my $filename=$uriparts[$#uriparts];
1502: my $pathname=$uri;
1503: $pathname=~s/\/$filename$//;
1504: if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1.54 www 1505: /\&$filename\:([\d\|]+)\&/) {
1.52 www 1506: $statecond=$1;
1507: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1508: =~/$priv\&([^\:]*)/) {
1509: $thisallowed.=$1;
1510: $checkreferer=0;
1511: }
1.29 www 1512: }
1.83 www 1513:
1.148 www 1514: if ($checkreferer) {
1.152 www 1515: my $refuri=$ENV{'httpref.'.$orguri};
1.148 www 1516:
1517: unless ($refuri) {
1518: map {
1519: if ($_=~/^httpref\..*\*/) {
1520: my $pattern=$_;
1.156 www 1521: $pattern=~s/^httpref\.\/res\///;
1.148 www 1522: $pattern=~s/\*/\[\^\/\]\+/g;
1523: $pattern=~s/\//\\\//g;
1.152 www 1524: if ($orguri=~/$pattern/) {
1.148 www 1525: $refuri=$ENV{$_};
1526: }
1527: }
1528: } keys %ENV;
1529: }
1530: if ($refuri) {
1.152 www 1531: $refuri=&declutter($refuri);
1.53 www 1532: my @uriparts=split(/\//,$refuri);
1.52 www 1533: my $filename=$uriparts[$#uriparts];
1.53 www 1534: my $pathname=$refuri;
1.52 www 1535: $pathname=~s/\/$filename$//;
1.53 www 1536: if ($ENV{'acc.res.'.$ENV{'request.course.id'}.'.'.$pathname}=~
1.54 www 1537: /\&$filename\:([\d\|]+)\&/) {
1.53 www 1538: my $refstatecond=$1;
1.52 www 1539: if ($ENV{'user.priv.'.$ENV{'request.role'}.'./'.$courseprivid}
1540: =~/$priv\&([^\:]*)/) {
1541: $thisallowed.=$1;
1.53 www 1542: $uri=$refuri;
1543: $statecond=$refstatecond;
1.52 www 1544: }
1545: }
1.148 www 1546: }
1.29 www 1547: }
1.52 www 1548: }
1.29 www 1549:
1.52 www 1550: #
1.103 harris41 1551: # Gathered now: all privileges that could apply, and condition number
1.52 www 1552: #
1553: #
1554: # Full or no access?
1555: #
1.29 www 1556:
1.52 www 1557: if ($thisallowed=~/F/) {
1558: return 'F';
1559: }
1.29 www 1560:
1.52 www 1561: unless ($thisallowed) {
1562: return '';
1563: }
1.29 www 1564:
1.52 www 1565: # Restrictions exist, deal with them
1566: #
1567: # C:according to course preferences
1568: # R:according to resource settings
1569: # L:unless locked
1570: # X:according to user session state
1571: #
1572:
1573: # Possibly locked functionality, check all courses
1.54 www 1574: # Locks might take effect only after 10 minutes cache expiration for other
1575: # courses, and 2 minutes for current course
1.52 www 1576:
1577: my $envkey;
1578: if ($thisallowed=~/L/) {
1579: foreach $envkey (keys %ENV) {
1.54 www 1580: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
1581: my $courseid=$2;
1582: my $roleid=$1.'.'.$2;
1.92 www 1583: $courseid=~s/^\///;
1.54 www 1584: my $expiretime=600;
1585: if ($ENV{'request.role'} eq $roleid) {
1586: $expiretime=120;
1587: }
1588: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
1589: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1590: if ((time-$ENV{$prefix.'last_cache'})>$expiretime) {
1591: &coursedescription($courseid);
1592: }
1593: if (($ENV{$prefix.'res.'.$uri.'.lock.sections'}=~/\,$csec\,/)
1594: || ($ENV{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
1595: if ($ENV{$prefix.'res.'.$uri.'.lock.expire'}>time) {
1.57 www 1596: &log($ENV{'user.domain'},$ENV{'user.name'},
1597: $ENV{'user.host'},
1598: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 1599: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54 www 1600: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 1601: return '';
1602: }
1603: }
1.54 www 1604: if (($ENV{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,$csec\,/)
1605: || ($ENV{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1606: if ($ENV{'priv.'.$priv.'.lock.expire'}>time) {
1.57 www 1607: &log($ENV{'user.domain'},$ENV{'user.name'},
1608: $ENV{'user.host'},
1609: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 1610: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.54 www 1611: $ENV{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 1612: return '';
1613: }
1614: }
1615: }
1.29 www 1616: }
1.52 www 1617: }
1618:
1619: #
1620: # Rest of the restrictions depend on selected course
1621: #
1622:
1623: unless ($ENV{'request.course.id'}) {
1624: return '1';
1625: }
1.29 www 1626:
1.52 www 1627: #
1628: # Now user is definitely in a course
1629: #
1.53 www 1630:
1631:
1632: # Course preferences
1633:
1634: if ($thisallowed=~/C/) {
1.54 www 1635: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1636: if ($ENV{'course.'.$ENV{'request.course.id'}.'.'.$priv.'.roles.denied'}
1637: =~/\,$rolecode\,/) {
1.57 www 1638: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1639: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
1.54 www 1640: $ENV{'request.course.id'});
1641: return '';
1642: }
1.53 www 1643: }
1644:
1645: # Resource preferences
1646:
1647: if ($thisallowed=~/R/) {
1.54 www 1648: my $rolecode=(split(/\./,$ENV{'request.role'}))[0];
1649: my $filename=$perlvar{'lonDocRoot'}.'/res/'.$uri.'.meta';
1650: if (-e $filename) {
1651: my @content;
1652: {
1653: my $fh=Apache::File->new($filename);
1654: @content=<$fh>;
1655: }
1656: if (join('',@content)=~
1657: /\<roledeny[^\>]*\>[^\<]*$rolecode[^\<]*\<\/roledeny\>/) {
1.57 www 1658: &log($ENV{'user.domain'},$ENV{'user.name'},$ENV{'user.host'},
1659: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
1.54 www 1660: return '';
1661:
1662: }
1663: }
1.53 www 1664: }
1.30 www 1665:
1.52 www 1666: # Restricted by state?
1.30 www 1667:
1.52 www 1668: if ($thisallowed=~/X/) {
1669: if (&condval($statecond)) {
1670: return '2';
1671: } else {
1672: return '';
1673: }
1674: }
1.30 www 1675:
1.52 www 1676: return 'F';
1.12 www 1677: }
1678:
1679: # ----------------------------------------------------------------- Define Role
1680:
1681: sub definerole {
1682: if (allowed('mcr','/')) {
1683: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.21 www 1684: map {
1685: my ($crole,$cqual)=split(/\&/,$_);
1686: if ($pr{'cr:s'}!~/$crole/) { return "refused:s:$crole"; }
1687: if ($pr{'cr:s'}=~/$crole\&/) {
1688: if ($pr{'cr:s'}!~/$crole\&\w*$cqual/) {
1689: return "refused:s:$crole&$cqual";
1690: }
1691: }
1692: } split('/',$sysrole);
1693: map {
1694: my ($crole,$cqual)=split(/\&/,$_);
1695: if ($pr{'cr:d'}!~/$crole/) { return "refused:d:$crole"; }
1696: if ($pr{'cr:d'}=~/$crole\&/) {
1697: if ($pr{'cr:d'}!~/$crole\&\w*$cqual/) {
1698: return "refused:d:$crole&$cqual";
1699: }
1700: }
1701: } split('/',$domrole);
1702: map {
1703: my ($crole,$cqual)=split(/\&/,$_);
1704: if ($pr{'cr:c'}!~/$crole/) { return "refused:c:$crole"; }
1705: if ($pr{'cr:c'}=~/$crole\&/) {
1706: if ($pr{'cr:c'}!~/$crole\&\w*$cqual/) {
1707: return "refused:c:$crole&$cqual";
1708: }
1709: }
1710: } split('/',$courole);
1.12 www 1711: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
1712: "$ENV{'user.domain'}:$ENV{'user.name'}:".
1.21 www 1713: "rolesdef_$rolename=".
1714: escape($sysrole.'_'.$domrole.'_'.$courole);
1.12 www 1715: return reply($command,$ENV{'user.home'});
1716: } else {
1717: return 'refused';
1718: }
1.105 harris41 1719: }
1720:
1721: # ---------------- Make a metadata query against the network of library servers
1722:
1723: sub metadata_query {
1.116 harris41 1724: my ($query,$custom,$customshow)=@_;
1.120 harris41 1725: my %rhash;
1.123 harris41 1726: for my $server (keys %libserv) {
1.118 harris41 1727: unless ($custom or $customshow) {
1728: my $reply=&reply("querysend:".&escape($query),$server);
1729: $rhash{$server}=$reply;
1730: }
1731: else {
1732: my $reply=&reply("querysend:".&escape($query).':'.
1733: &escape($custom).':'.&escape($customshow),
1734: $server);
1735: $rhash{$server}=$reply;
1736: }
1.112 harris41 1737: }
1.118 harris41 1738: return \%rhash;
1.12 www 1739: }
1740:
1741: # ------------------------------------------------------------------ Plain Text
1742:
1743: sub plaintext {
1.22 www 1744: my $short=shift;
1745: return $prp{$short};
1.12 www 1746: }
1747:
1.25 www 1748: # ------------------------------------------------------------------ Plain Text
1749:
1750: sub fileembstyle {
1.181 matthew 1751: my $ending=lc(shift);
1.25 www 1752: return $fe{$ending};
1753: }
1754:
1755: # ------------------------------------------------------------ Description Text
1756:
1.74 www 1757: sub filedescription {
1.181 matthew 1758: my $ending=lc(shift);
1.25 www 1759: return $fd{$ending};
1760: }
1761:
1.12 www 1762: # ----------------------------------------------------------------- Assign Role
1763:
1764: sub assignrole {
1.21 www 1765: my ($udom,$uname,$url,$role,$end,$start)=@_;
1766: my $mrole;
1767: if ($role =~ /^cr\//) {
1.104 www 1768: unless (&allowed('ccr',$url)) {
1769: &logthis('Refused custom assignrole: '.
1770: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1771: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1772: return 'refused';
1773: }
1.21 www 1774: $mrole='cr';
1775: } else {
1.82 www 1776: my $cwosec=$url;
1.83 www 1777: $cwosec=~s/^\/(\w+)\/(\w+)\/.*/$1\/$2/;
1.104 www 1778: unless (&allowed('c'.$role,$cwosec)) {
1779: &logthis('Refused assignrole: '.
1780: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
1781: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1782: return 'refused';
1783: }
1.21 www 1784: $mrole=$role;
1785: }
1786: my $command="encrypt:rolesput:$ENV{'user.domain'}:$ENV{'user.name'}:".
1787: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 1788: if ($end) { $command.='_'.$end; }
1.21 www 1789: if ($start) {
1790: if ($end) {
1.81 www 1791: $command.='_'.$start;
1.21 www 1792: } else {
1.81 www 1793: $command.='_0_'.$start;
1.21 www 1794: }
1795: }
1796: return &reply($command,&homeserver($uname,$udom));
1.169 harris41 1797: }
1798:
1799: # -------------------------------------------------- Modify user authentication
1800: sub modifyuserauth {
1801: my ($udom,$uname,$umode,$upass)=@_;
1802: my $uhome=&homeserver($uname,$udom);
1803: &logthis('Call to modify user authentication'.$udom.', '.$uname.', '.
1804: $umode.' by '.$ENV{'user.name'}.' at '.$ENV{'user.domain'});
1805: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
1806: &escape($upass),$uhome);
1807: unless ($reply eq 'ok') {
1808: return 'error: '.$reply;
1809: }
1.170 harris41 1810: return 'ok';
1.80 www 1811: }
1812:
1.81 www 1813: # --------------------------------------------------------------- Modify a user
1.80 www 1814:
1815:
1.81 www 1816: sub modifyuser {
1.80 www 1817: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene)=@_;
1.81 www 1818: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 1819: $umode.', '.$first.', '.$middle.', '.
1820: $last.', '.$gene.' by '.
1821: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1822: my $uhome=&homeserver($uname,$udom);
1823: # ----------------------------------------------------------------- Create User
1.81 www 1824: if (($uhome eq 'no_host') && ($umode) && ($upass)) {
1.80 www 1825: my $unhome='';
1826: if ($ENV{'course.'.$ENV{'request.course.id'}.'.domain'} eq $udom) {
1827: $unhome=$ENV{'course.'.$ENV{'request.course.id'}.'.home'};
1828: } else {
1829: my $tryserver;
1.81 www 1830: my $loadm=10000000;
1.80 www 1831: foreach $tryserver (keys %libserv) {
1832: if ($hostdom{$tryserver} eq $udom) {
1833: my $answer=reply('load',$tryserver);
1834: if (($answer=~/\d+/) && ($answer<$loadm)) {
1835: $loadm=$answer;
1836: $unhome=$tryserver;
1837: }
1838: }
1839: }
1840: }
1841: if (($unhome eq '') || ($unhome eq 'no_host')) {
1842: return 'error: find home';
1843: }
1844: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
1845: &escape($upass),$unhome);
1846: unless ($reply eq 'ok') {
1847: return 'error: '.$reply;
1848: }
1849: $uhome=&homeserver($uname,$udom);
1850: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1851: return 'error: verify home';
1852: }
1853: }
1854: # ---------------------------------------------------------------------- Add ID
1855: if ($uid) {
1856: $uid=~tr/A-Z/a-z/;
1857: my %uidhash=&idrget($udom,$uname);
1858: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)) {
1859: unless ($uid eq $uidhash{$uname}) {
1860: return 'error: mismatch '.$uidhash{$uname}.' versus '.$uid;
1861: }
1862: } else {
1863: &idput($udom,($uname => $uid));
1864: }
1865: }
1866: # -------------------------------------------------------------- Add names, etc
1.134 albertel 1867: my %names=&get('environment',
1868: ['firstname','middlename','lastname','generation'],
1869: $udom,$uname);
1870: if ($first) { $names{'firstname'} = $first; }
1871: if ($middle) { $names{'middlename'} = $middle; }
1872: if ($last) { $names{'lastname'} = $last; }
1873: if ($gene) { $names{'generation'} = $gene; }
1874: my $reply = &put('environment', \%names, $udom,$uname);
1875: if ($reply ne 'ok') { return 'error: '.$reply; }
1.81 www 1876: &logthis('Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 1877: $umode.', '.$first.', '.$middle.', '.
1878: $last.', '.$gene.' by '.
1879: $ENV{'user.name'}.' at '.$ENV{'user.domain'});
1.134 albertel 1880: return 'ok';
1.80 www 1881: }
1882:
1.81 www 1883: # -------------------------------------------------------------- Modify student
1.80 www 1884:
1.81 www 1885: sub modifystudent {
1886: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1887: $end,$start)=@_;
1888: my $cid='';
1889: unless ($cid=$ENV{'request.course.id'}) {
1.80 www 1890: return 'not_in_class';
1891: }
1892: # --------------------------------------------------------------- Make the user
1.81 www 1893: my $reply=&modifyuser
1.80 www 1894: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene);
1895: unless ($reply eq 'ok') { return $reply; }
1.81 www 1896: my $uhome=&homeserver($uname,$udom);
1897: if (($uhome eq '') || ($uhome eq 'no_host')) {
1898: return 'error: no such user';
1899: }
1.80 www 1900: # -------------------------------------------------- Add student to course list
1.160 www 1901: $reply=critical('put:'.$ENV{'course.'.$cid.'.domain'}.':'.
1.81 www 1902: $ENV{'course.'.$cid.'.num'}.':classlist:'.
1903: &escape($uname.':'.$udom).'='.
1904: &escape($end.':'.$start),
1905: $ENV{'course.'.$cid.'.home'});
1906: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
1907: return 'error: '.$reply;
1908: }
1.80 www 1909: # ---------------------------------------------------- Add student role to user
1.83 www 1910: my $uurl='/'.$cid;
1.81 www 1911: $uurl=~s/\_/\//g;
1912: if ($usec) {
1913: $uurl.='/'.$usec;
1914: }
1915: return &assignrole($udom,$uname,$uurl,'st',$end,$start);
1.21 www 1916: }
1917:
1.84 www 1918: # ------------------------------------------------- Write to course preferences
1919:
1920: sub writecoursepref {
1921: my ($courseid,%prefs)=@_;
1922: $courseid=~s/^\///;
1923: $courseid=~s/\_/\//g;
1924: my ($cdomain,$cnum)=split(/\//,$courseid);
1925: my $chome=homeserver($cnum,$cdomain);
1926: if (($chome eq '') || ($chome eq 'no_host')) {
1927: return 'error: no such course';
1928: }
1929: my $cstring='';
1930: map {
1931: $cstring.=escape($_).'='.escape($prefs{$_}).'&';
1932: } keys %prefs;
1933: $cstring=~s/\&$//;
1934: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
1935: }
1936:
1937: # ---------------------------------------------------------- Make/modify course
1938:
1939: sub createcourse {
1940: my ($udom,$description,$url)=@_;
1941: $url=&declutter($url);
1942: my $cid='';
1943: unless (&allowed('ccc',$ENV{'user.domain'})) {
1944: return 'refused';
1945: }
1946: unless ($udom eq $ENV{'user.domain'}) {
1947: return 'refused';
1948: }
1949: # ------------------------------------------------------------------- Create ID
1950: my $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
1951: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1952: # ----------------------------------------------- Make sure that does not exist
1953: my $uhome=&homeserver($uname,$udom);
1954: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1955: $uname=substr($$.time,0,5).unpack("H8",pack("I32",time)).
1956: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
1957: $uhome=&homeserver($uname,$udom);
1958: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1959: return 'error: unable to generate unique course-ID';
1960: }
1961: }
1962: # ------------------------------------------------------------- Make the course
1963: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1964: $ENV{'user.home'});
1965: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.160 www 1966: $uhome=&homeserver($uname,$udom);
1.84 www 1967: if (($uhome eq '') || ($uhome eq 'no_host')) {
1968: return 'error: no such course';
1969: }
1970: &writecoursepref($udom.'_'.$uname,
1971: ('description' => $description,
1972: 'url' => $url));
1973: return '/'.$udom.'/'.$uname;
1974: }
1975:
1.21 www 1976: # ---------------------------------------------------------- Assign Custom Role
1977:
1978: sub assigncustomrole {
1979: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start)=@_;
1980: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1981: $end,$start);
1982: }
1983:
1984: # ----------------------------------------------------------------- Revoke Role
1985:
1986: sub revokerole {
1987: my ($udom,$uname,$url,$role)=@_;
1988: my $now=time;
1989: return &assignrole($udom,$uname,$url,$role,$now);
1990: }
1991:
1992: # ---------------------------------------------------------- Revoke Custom Role
1993:
1994: sub revokecustomrole {
1995: my ($udom,$uname,$url,$rdom,$rnam,$rolename)=@_;
1996: my $now=time;
1997: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now);
1.17 www 1998: }
1999:
2000: # ------------------------------------------------------------ Directory lister
2001:
2002: sub dirlist {
2003: my $uri=shift;
1.18 www 2004: $uri=~s/^\///;
2005: $uri=~s/\/$//;
1.19 www 2006: my ($res,$udom,$uname,@rest)=split(/\//,$uri);
2007: if ($udom) {
2008: if ($uname) {
2009: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/'.$uri,
2010: homeserver($uname,$udom));
2011: return split(/:/,$listing);
2012: } else {
2013: my $tryserver;
2014: my %allusers=();
2015: foreach $tryserver (keys %libserv) {
2016: if ($hostdom{$tryserver} eq $udom) {
2017: my $listing=reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.$udom,
2018: $tryserver);
2019: if (($listing ne 'no_such_dir') && ($listing ne 'empty')
2020: && ($listing ne 'con_lost')) {
2021: map {
2022: my ($entry,@stat)=split(/&/,$_);
2023: $allusers{$entry}=1;
2024: } split(/:/,$listing);
2025: }
2026: }
2027: }
2028: my $alluserstr='';
2029: map {
2030: $alluserstr.=$_.'&user:';
2031: } sort keys %allusers;
2032: $alluserstr=~s/:$//;
2033: return split(/:/,$alluserstr);
2034: }
2035: } else {
2036: my $tryserver;
2037: my %alldom=();
2038: foreach $tryserver (keys %libserv) {
2039: $alldom{$hostdom{$tryserver}}=1;
2040: }
2041: my $alldomstr='';
2042: map {
2043: $alldomstr.=$perlvar{'lonDocRoot'}.'/res/'.$_.'&domain:';
2044: } sort keys %alldom;
2045: $alldomstr=~s/:$//;
2046: return split(/:/,$alldomstr);
2047: }
1.26 www 2048: }
2049:
2050: # -------------------------------------------------------- Value of a Condition
2051:
1.40 www 2052: sub directcondval {
2053: my $number=shift;
2054: if ($ENV{'user.state.'.$ENV{'request.course.id'}}) {
2055: return substr($ENV{'user.state.'.$ENV{'request.course.id'}},$number,1);
2056: } else {
2057: return 2;
2058: }
2059: }
2060:
1.26 www 2061: sub condval {
2062: my $condidx=shift;
2063: my $result=0;
1.54 www 2064: my $allpathcond='';
2065: map {
2066: if (defined($ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_})) {
2067: $allpathcond.=
2068: '('.$ENV{'acc.cond.'.$ENV{'request.course.id'}.'.'.$_}.')|';
2069: }
2070: } split(/\|/,$condidx);
2071: $allpathcond=~s/\|$//;
1.33 www 2072: if ($ENV{'request.course.id'}) {
1.54 www 2073: if ($allpathcond) {
1.26 www 2074: my $operand='|';
2075: my @stack;
2076: map {
2077: if ($_ eq '(') {
2078: push @stack,($operand,$result)
2079: } elsif ($_ eq ')') {
2080: my $before=pop @stack;
2081: if (pop @stack eq '&') {
2082: $result=$result>$before?$before:$result;
2083: } else {
2084: $result=$result>$before?$result:$before;
2085: }
2086: } elsif (($_ eq '&') || ($_ eq '|')) {
2087: $operand=$_;
2088: } else {
1.40 www 2089: my $new=directcondval($_);
1.26 www 2090: if ($operand eq '&') {
2091: $result=$result>$new?$new:$result;
2092: } else {
2093: $result=$result>$new?$result:$new;
2094: }
2095: }
1.54 www 2096: } ($allpathcond=~/(\d+|\(|\)|\&|\|)/g);
1.26 www 2097: }
2098: }
2099: return $result;
1.28 www 2100: }
2101:
2102: # --------------------------------------------------------- Value of a Variable
2103:
1.58 www 2104: sub EXT {
1.147 www 2105: my ($varname,$symbparm)=@_;
1.68 www 2106: unless ($varname) { return ''; }
1.48 www 2107: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
2108: my $rest;
2109: if ($therest[0]) {
2110: $rest=join('.',@therest);
2111: } else {
2112: $rest='';
2113: }
1.57 www 2114: my $qualifierrest=$qualifier;
2115: if ($rest) { $qualifierrest.='.'.$rest; }
2116: my $spacequalifierrest=$space;
2117: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 2118: if ($realm eq 'user') {
1.48 www 2119: # --------------------------------------------------------------- user.resource
2120: if ($space eq 'resource') {
1.122 albertel 2121: my %restored=&restore();
1.57 www 2122: return $restored{$qualifierrest};
1.48 www 2123: # ----------------------------------------------------------------- user.access
2124: } elsif ($space eq 'access') {
2125: return &allowed($qualifier,$rest);
2126: # ------------------------------------------ user.preferences, user.environment
2127: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.57 www 2128: return $ENV{join('.',('environment',$qualifierrest))};
1.48 www 2129: # ----------------------------------------------------------------- user.course
2130: } elsif ($space eq 'course') {
2131: return $ENV{join('.',('request.course',$qualifier))};
2132: # ------------------------------------------------------------------- user.role
2133: } elsif ($space eq 'role') {
2134: my ($role,$where)=split(/\./,$ENV{'request.role'});
2135: if ($qualifier eq 'value') {
2136: return $role;
2137: } elsif ($qualifier eq 'extent') {
2138: return $where;
2139: }
2140: # ----------------------------------------------------------------- user.domain
2141: } elsif ($space eq 'domain') {
2142: return $ENV{'user.domain'};
2143: # ------------------------------------------------------------------- user.name
2144: } elsif ($space eq 'name') {
2145: return $ENV{'user.name'};
2146: # ---------------------------------------------------- Any other user namespace
1.29 www 2147: } else {
1.48 www 2148: my $item=($rest)?$qualifier.'.'.$rest:$qualifier;
1.131 albertel 2149: my %reply=&get($space,[$item]);
1.48 www 2150: return $reply{$item};
2151: }
2152: } elsif ($realm eq 'request') {
2153: # ------------------------------------------------------------- request.browser
2154: if ($space eq 'browser') {
2155: return $ENV{'browser.'.$qualifier};
1.57 www 2156: # ------------------------------------------------------------ request.filename
2157: } else {
2158: return $ENV{'request.'.$spacequalifierrest};
1.29 www 2159: }
1.28 www 2160: } elsif ($realm eq 'course') {
1.48 www 2161: # ---------------------------------------------------------- course.description
1.127 ng 2162: return $ENV{'course.'.$ENV{'request.course.id'}.'.'.
1.57 www 2163: $spacequalifierrest};
2164: } elsif ($realm eq 'resource') {
1.127 ng 2165: if ($ENV{'request.course.id'}) {
1.165 www 2166:
2167: # print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
2168:
2169:
1.60 www 2170: # ----------------------------------------------------- Cascading lookup scheme
1.147 www 2171: my $symbp;
2172: if ($symbparm) {
2173: $symbp=$symbparm;
2174: } else {
2175: $symbp=&symbread();
2176: }
1.127 ng 2177: my $mapp=(split(/\_\_\_/,$symbp))[0];
1.69 www 2178:
1.127 ng 2179: my $symbparm=$symbp.'.'.$spacequalifierrest;
2180: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.69 www 2181:
1.127 ng 2182: my $seclevel=
1.69 www 2183: $ENV{'request.course.id'}.'.['.
2184: $ENV{'request.course.sec'}.'].'.$spacequalifierrest;
1.127 ng 2185: my $seclevelr=
1.69 www 2186: $ENV{'request.course.id'}.'.['.
2187: $ENV{'request.course.sec'}.'].'.$symbparm;
1.127 ng 2188: my $seclevelm=
1.69 www 2189: $ENV{'request.course.id'}.'.['.
2190: $ENV{'request.course.sec'}.'].'.$mapparm;
2191:
1.127 ng 2192: my $courselevel=
1.60 www 2193: $ENV{'request.course.id'}.'.'.$spacequalifierrest;
1.127 ng 2194: my $courselevelr=
1.69 www 2195: $ENV{'request.course.id'}.'.'.$symbparm;
1.127 ng 2196: my $courselevelm=
1.69 www 2197: $ENV{'request.course.id'}.'.'.$mapparm;
2198:
1.60 www 2199: # ----------------------------------------------------------- first, check user
1.127 ng 2200: my %resourcedata=get('resourcedata',
1.131 albertel 2201: [$courselevelr,$courselevelm,$courselevel]);
1.127 ng 2202: if (($resourcedata{$courselevelr}!~/^error\:/) &&
2203: ($resourcedata{$courselevelr}!~/^con_lost/)) {
1.69 www 2204:
1.127 ng 2205: if ($resourcedata{$courselevelr}) {
2206: return $resourcedata{$courselevelr}; }
2207: if ($resourcedata{$courselevelm}) {
2208: return $resourcedata{$courselevelm}; }
2209: if ($resourcedata{$courselevel}) { return $resourcedata{$courselevel}; }
1.69 www 2210:
1.94 www 2211: } else {
2212: if ($resourcedata{$courselevelr}!~/No such file/) {
2213: &logthis("<font color=blue>WARNING:".
2214: " Trying to get resource data for ".$ENV{'user.name'}." at "
2215: .$ENV{'user.domain'}.": ".$resourcedata{$courselevelr}.
2216: "</font>");
2217: }
1.63 www 2218: }
1.95 www 2219:
1.60 www 2220: # -------------------------------------------------------- second, check course
1.96 www 2221:
1.60 www 2222: my $reply=&reply('get:'.
1.96 www 2223: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.':'.
2224: $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.
1.79 www 2225: ':resourcedata:'.
2226: &escape($seclevelr).'&'.&escape($seclevelm).'&'.&escape($seclevel).'&'.
2227: &escape($courselevelr).'&'.&escape($courselevelm).'&'.&escape($courselevel),
1.96 www 2228: $ENV{'course.'.$ENV{'request.course.id'}.'.home'});
1.63 www 2229: if ($reply!~/^error\:/) {
1.79 www 2230: map {
2231: if ($_) { return &unescape($_); }
2232: } split(/\&/,$reply);
1.63 www 2233: }
1.94 www 2234: if (($reply=~/^con_lost/) || ($reply=~/^error\:/)) {
2235: &logthis("<font color=blue>WARNING:".
1.95 www 2236: " Getting ".$reply." asking for ".$varname." for ".
1.96 www 2237: $ENV{'course.'.$ENV{'request.course.id'}.'.num'}.
1.95 www 2238: ' at '.
1.96 www 2239: $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}.
1.95 www 2240: ' from '.
1.96 www 2241: $ENV{'course.'.$ENV{'request.course.id'}.'.home'}.
1.94 www 2242: "</font>");
2243: }
1.60 www 2244: # ------------------------------------------------------ third, check map parms
1.65 www 2245: my %parmhash=();
2246: my $thisparm='';
2247: if (tie(%parmhash,'GDBM_File',
2248: $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640)) {
2249: $thisparm=$parmhash{$symbparm};
2250: untie(%parmhash);
1.60 www 2251: }
1.65 www 2252: if ($thisparm) { return $thisparm; }
1.60 www 2253: }
2254:
2255: # --------------------------------------------- last, look in resource metadata
1.71 www 2256:
1.78 www 2257: $spacequalifierrest=~s/\./\_/;
1.71 www 2258: my $metadata=&metadata($ENV{'request.filename'},$spacequalifierrest);
2259: if ($metadata) { return $metadata; }
1.78 www 2260: $metadata=&metadata($ENV{'request.filename'},
2261: 'parameter_'.$spacequalifierrest);
2262: if ($metadata) { return $metadata; }
1.142 www 2263:
1.145 www 2264: # ------------------------------------------------------------------ Cascade up
2265:
2266: unless ($space eq '0') {
1.165 www 2267: my ($part,$id)=split(/\_/,$space);
1.145 www 2268: if ($id) {
1.147 www 2269: my $partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
2270: $symbparm);
1.145 www 2271: if ($partgeneral) { return $partgeneral; }
2272: } else {
1.147 www 2273: my $resourcegeneral=&EXT('resource.0.'.$qualifierrest,
2274: $symbparm);
1.145 www 2275: if ($resourcegeneral) { return $resourcegeneral; }
2276: }
2277: }
1.71 www 2278:
1.48 www 2279: # ---------------------------------------------------- Any other user namespace
2280: } elsif ($realm eq 'environment') {
2281: # ----------------------------------------------------------------- environment
1.127 ng 2282: return $ENV{'environment.'.$spacequalifierrest};
1.28 www 2283: } elsif ($realm eq 'system') {
1.48 www 2284: # ----------------------------------------------------------------- system.time
2285: if ($space eq 'time') {
2286: return time;
2287: }
1.28 www 2288: }
1.48 www 2289: return '';
1.61 www 2290: }
2291:
1.71 www 2292: # ---------------------------------------------------------------- Get metadata
2293:
2294: sub metadata {
1.176 www 2295: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.78 www 2296:
1.71 www 2297: $uri=&declutter($uri);
1.73 www 2298: my $filename=$uri;
2299: $uri=~s/\.meta$//;
1.172 www 2300: #
2301: # Is the metadata already cached?
1.177 www 2302: # Look at timestamp of caching
1.172 www 2303: # Everything is cached by the main uri, libraries are never directly cached
2304: #
1.174 www 2305: unless (abs($metacache{$uri.':cachedtimestamp'}-time)<600) {
1.172 www 2306: #
2307: # Is this a recursive call for a library?
2308: #
1.171 www 2309: if ($liburi) {
2310: $liburi=&declutter($liburi);
2311: $filename=$liburi;
2312: }
1.140 www 2313: my %metathesekeys=();
1.73 www 2314: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
2315: my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);
1.71 www 2316: my $parser=HTML::TokeParser->new(\$metastring);
2317: my $token;
1.140 www 2318: undef %metathesekeys;
1.71 www 2319: while ($token=$parser->get_token) {
2320: if ($token->[0] eq 'S') {
1.135 www 2321: if (defined($token->[2]->{'package'})) {
1.172 www 2322: #
2323: # This is a package - get package info
2324: #
1.136 www 2325: my $package=$token->[2]->{'package'};
2326: my $keyroot='';
1.172 www 2327: if ($prefix) {
2328: $keyroot.='_'.$prefix;
2329: } else {
2330: if (defined($token->[2]->{'part'})) {
2331: $keyroot.='_'.$token->[2]->{'part'};
2332: }
1.136 www 2333: }
2334: if (defined($token->[2]->{'id'})) {
1.165 www 2335: $keyroot.='_'.$token->[2]->{'id'};
1.136 www 2336: }
2337: if ($metacache{$uri.':packages'}) {
2338: $metacache{$uri.':packages'}.=','.$package.$keyroot;
2339: } else {
2340: $metacache{$uri.':packages'}=$package.$keyroot;
2341: }
1.137 www 2342: map {
2343: if ($_=~/^$package\&/) {
2344: my ($pack,$name,$subp)=split(/\&/,$_);
1.139 www 2345: my $value=$packagetab{$_};
1.144 www 2346: my $part=$keyroot;
2347: $part=~s/^\_//;
1.139 www 2348: if ($subp eq 'display') {
2349: $value.=' [Part: '.$part.']';
2350: }
2351: my $unikey='parameter'.$keyroot.'_'.$name;
1.140 www 2352: $metathesekeys{$unikey}=1;
1.144 www 2353: $metacache{$uri.':'.$unikey.'.part'}=$part;
1.141 www 2354: unless
2355: (defined($metacache{$uri.':'.$unikey.'.'.$subp})) {
2356: $metacache{$uri.':'.$unikey.'.'.$subp}=$value;
2357: }
1.137 www 2358: }
2359: } keys %packagetab;
1.135 www 2360: } else {
1.172 www 2361: #
2362: # This is not a package - some other kind of start tag
2363: #
1.175 www 2364: my $entry=$token->[1];
1.176 www 2365: my $unikey;
2366: if ($entry eq 'import') {
2367: $unikey='';
2368: } else {
2369: $unikey=$entry;
2370: }
1.172 www 2371: if ($prefix) {
1.176 www 2372: $unikey.=$prefix;
1.172 www 2373: } else {
2374: if (defined($token->[2]->{'part'})) {
2375: $unikey.='_'.$token->[2]->{'part'};
2376: }
1.136 www 2377: }
2378: if (defined($token->[2]->{'id'})) {
1.165 www 2379: $unikey.='_'.$token->[2]->{'id'};
1.71 www 2380: }
1.175 www 2381:
2382: if ($entry eq 'import') {
2383: #
2384: # Importing a library here
1.176 www 2385: #
2386: if (defined($depthcount)) { $depthcount++; } else
2387: { $depthcount=0; }
2388: if ($depthcount<20) {
1.177 www 2389: map {
2390: $metathesekeys{$_}=1;
2391: } split(/\,/,&metadata($uri,'keys',
2392: $parser->get_text('/import'),$unikey,
2393: $depthcount));
1.176 www 2394: }
1.175 www 2395: } else {
2396:
1.72 www 2397: if (defined($token->[2]->{'name'})) {
1.71 www 2398: $unikey.='_'.$token->[2]->{'name'};
2399: }
1.140 www 2400: $metathesekeys{$unikey}=1;
1.71 www 2401: map {
2402: $metacache{$uri.':'.$unikey.'.'.$_}=$token->[2]->{$_};
1.72 www 2403: } @{$token->[3]};
1.78 www 2404: unless (
2405: $metacache{$uri.':'.$unikey}=$parser->get_text('/'.$entry)
2406: ) { $metacache{$uri.':'.$unikey}=
2407: $metacache{$uri.':'.$unikey.'.default'};
2408: }
1.172 www 2409: # end of not-a-package not-a-library import
1.175 www 2410: }
1.172 www 2411: # end of not-a-package start tag
2412: }
2413: # the next is the end of "start tag"
1.140 www 2414: }
1.71 www 2415: }
1.140 www 2416: $metacache{$uri.':keys'}=join(',',keys %metathesekeys);
1.174 www 2417: $metacache{$uri.':cachedtimestamp'}=time;
1.177 www 2418: # this is the end of "was not already recently cached
1.71 www 2419: }
2420: return $metacache{$uri.':'.$what};
2421: }
2422:
1.31 www 2423: # ------------------------------------------------- Update symbolic store links
2424:
2425: sub symblist {
2426: my ($mapname,%newhash)=@_;
2427: $mapname=declutter($mapname);
2428: my %hash;
2429: if (($ENV{'request.course.fn'}) && (%newhash)) {
2430: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
2431: &GDBM_WRCREAT,0640)) {
2432: map {
2433: $hash{declutter($_)}=$mapname.'___'.$newhash{$_};
2434: } keys %newhash;
2435: if (untie(%hash)) {
2436: return 'ok';
2437: }
2438: }
2439: }
2440: return 'error';
2441: }
2442:
2443: # ------------------------------------------------------ Return symb list entry
2444:
2445: sub symbread {
1.44 www 2446: my $thisfn=shift;
2447: unless ($thisfn) {
1.179 www 2448: if ($ENV{'request.symb'}) { return $ENV{'request.symb'}; }
1.44 www 2449: $thisfn=$ENV{'request.filename'};
2450: }
2451: $thisfn=declutter($thisfn);
1.31 www 2452: my %hash;
1.37 www 2453: my %bighash;
2454: my $syval='';
1.45 www 2455: if (($ENV{'request.course.fn'}) && ($thisfn)) {
1.31 www 2456: if (tie(%hash,'GDBM_File',$ENV{'request.course.fn'}.'_symb.db',
2457: &GDBM_READER,0640)) {
2458: $syval=$hash{$thisfn};
1.37 www 2459: untie(%hash);
2460: }
2461: # ---------------------------------------------------------- There was an entry
2462: if ($syval) {
2463: unless ($syval=~/\_\d+$/) {
2464: unless ($ENV{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.44 www 2465: &appenv('request.ambiguous' => $thisfn);
1.37 www 2466: return '';
2467: }
2468: $syval.=$1;
2469: }
2470: } else {
2471: # ------------------------------------------------------- Was not in symb table
2472: if (tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
2473: &GDBM_READER,0640)) {
2474: # ---------------------------------------------- Get ID(s) for current resource
2475: my $ids=$bighash{'ids_/res/'.$thisfn};
1.65 www 2476: unless ($ids) {
2477: $ids=$bighash{'ids_/'.$thisfn};
2478: }
1.37 www 2479: if ($ids) {
2480: # ------------------------------------------------------------------- Has ID(s)
2481: my @possibilities=split(/\,/,$ids);
1.39 www 2482: if ($#possibilities==0) {
2483: # ----------------------------------------------- There is only one possibility
1.37 www 2484: my ($mapid,$resid)=split(/\./,$ids);
2485: $syval=declutter($bighash{'map_id_'.$mapid}).'___'.$resid;
2486: } else {
1.39 www 2487: # ------------------------------------------ There is more than one possibility
2488: my $realpossible=0;
2489: map {
2490: my $file=$bighash{'src_'.$_};
2491: if (&allowed('bre',$file)) {
2492: my ($mapid,$resid)=split(/\./,$_);
2493: if ($bighash{'map_type_'.$mapid} ne 'page') {
2494: $realpossible++;
2495: $syval=declutter($bighash{'map_id_'.$mapid}).
2496: '___'.$resid;
2497: }
2498: }
2499: } @possibilities;
2500: if ($realpossible!=1) { $syval=''; }
1.37 www 2501: }
2502: }
2503: untie(%bighash)
2504: }
1.31 www 2505: }
1.62 www 2506: if ($syval) {
2507: return $syval.'___'.$thisfn;
2508: }
1.31 www 2509: }
1.44 www 2510: &appenv('request.ambiguous' => $thisfn);
1.31 www 2511: return '';
2512: }
2513:
2514: # ---------------------------------------------------------- Return random seed
2515:
1.32 www 2516: sub numval {
2517: my $txt=shift;
2518: $txt=~tr/A-J/0-9/;
2519: $txt=~tr/a-j/0-9/;
2520: $txt=~tr/K-T/0-9/;
2521: $txt=~tr/k-t/0-9/;
2522: $txt=~tr/U-Z/0-5/;
2523: $txt=~tr/u-z/0-5/;
2524: $txt=~s/\D//g;
2525: return int($txt);
2526: }
2527:
1.31 www 2528: sub rndseed {
1.155 albertel 2529: my ($symb,$courseid,$domain,$username)=@_;
2530: if (!$symb) {
2531: unless ($symb=&symbread()) { return time; }
2532: }
2533: if (!$courseid) { $courseid=$ENV{'request.course.id'};}
2534: if (!$domain) {$domain=$ENV{'user.domain'};}
2535: if (!$username) {$username=$ENV{'user.name'};}
2536: {
1.98 albertel 2537: use integer;
2538: my $symbchck=unpack("%32C*",$symb) << 27;
1.100 albertel 2539: my $symbseed=numval($symb) << 22;
1.155 albertel 2540: my $namechck=unpack("%32C*",$username) << 17;
2541: my $nameseed=numval($username) << 12;
2542: my $domainseed=unpack("%32C*",$domain) << 7;
2543: my $courseseed=unpack("%32C*",$courseid);
1.98 albertel 2544: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.99 albertel 2545: #uncommenting these lines can break things!
2546: #&Apache::lonxml::debug("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
2547: #&Apache::lonxml::debug("rndseed :$num:$symb");
1.98 albertel 2548: return $num;
2549: }
1.36 albertel 2550: }
2551:
1.76 www 2552: sub ireceipt {
2553: my ($funame,$fudom,$fucourseid,$fusymb)=@_;
2554: my $cuname=unpack("%32C*",$funame);
2555: my $cudom=unpack("%32C*",$fudom);
2556: my $cucourseid=unpack("%32C*",$fucourseid);
2557: my $cusymb=unpack("%32C*",$fusymb);
1.77 www 2558: my $cunique=unpack("%32C*",$perlvar{'lonReceipt'});
1.76 www 2559: return unpack("%32C*",$perlvar{'lonHostID'}).'-'.
2560: ($cunique%$cuname+
2561: $cunique%$cudom+
2562: $cusymb%$cuname+
2563: $cusymb%$cudom+
2564: $cucourseid%$cuname+
2565: $cucourseid%$cudom);
2566: }
2567:
2568: sub receipt {
2569: return &ireceipt($ENV{'user.name'},$ENV{'user.domain'},
2570: $ENV{'request.course.id'},&symbread());
2571: }
2572:
1.36 albertel 2573: # ------------------------------------------------------------ Serves up a file
2574: # returns either the contents of the file or a -1
2575: sub getfile {
2576: my $file=shift;
1.37 www 2577: &repcopy($file);
1.36 albertel 2578: if (! -e $file ) { return -1; };
2579: my $fh=Apache::File->new($file);
2580: my $a='';
2581: while (<$fh>) { $a .=$_; }
2582: return $a
2583: }
2584:
2585: sub filelocation {
2586: my ($dir,$file) = @_;
2587: my $location;
2588: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.59 albertel 2589: if ($file=~m:^/~:) { # is a contruction space reference
2590: $location = $file;
2591: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.36 albertel 2592: } else {
1.59 albertel 2593: $file=~s/^$perlvar{'lonDocRoot'}//;
2594: $file=~s:^/*res::;
2595: if ( !( $file =~ m:^/:) ) {
2596: $location = $dir. '/'.$file;
2597: } else {
2598: $location = '/home/httpd/html/res'.$file;
2599: }
1.36 albertel 2600: }
2601: $location=~s://+:/:g; # remove duplicate /
1.46 www 2602: while ($location=~m:/\.\./:) {$location=~ s:/[^/]+/\.\./:/:g;} #remove dir/..
2603: return $location;
2604: }
1.36 albertel 2605:
1.46 www 2606: sub hreflocation {
2607: my ($dir,$file)=@_;
2608: unless (($_=~/^http:\/\//i) || ($_=~/^\//)) {
2609: my $finalpath=filelocation($dir,$file);
2610: $finalpath=~s/^\/home\/httpd\/html//;
2611: return $finalpath;
2612: } else {
2613: return $file;
2614: }
1.31 www 2615: }
2616:
2617: # ------------------------------------------------------------- Declutters URLs
2618:
2619: sub declutter {
2620: my $thisfn=shift;
2621: $thisfn=~s/^$perlvar{'lonDocRoot'}//;
2622: $thisfn=~s/^\///;
2623: $thisfn=~s/^res\///;
2624: return $thisfn;
1.12 www 2625: }
2626:
2627: # -------------------------------------------------------- Escape Special Chars
2628:
2629: sub escape {
2630: my $str=shift;
2631: $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
2632: return $str;
2633: }
2634:
2635: # ----------------------------------------------------- Un-Escape Special Chars
2636:
2637: sub unescape {
2638: my $str=shift;
2639: $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
2640: return $str;
2641: }
1.11 www 2642:
1.1 albertel 2643: # ================================================================ Main Program
2644:
1.184 www 2645: sub goodbye {
2646: &flushcourselogs();
2647: &logthis("Shutting down");
2648: }
2649:
1.179 www 2650: BEGIN {
1.1 albertel 2651: # ------------------------------------------------------------ Read access.conf
2652: {
2653: my $config=Apache::File->new("/etc/httpd/conf/access.conf");
2654:
2655: while (my $configline=<$config>) {
2656: if ($configline =~ /PerlSetVar/) {
2657: my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
1.8 www 2658: chomp($varvalue);
1.1 albertel 2659: $perlvar{$varname}=$varvalue;
2660: }
2661: }
2662: }
2663:
2664: # ------------------------------------------------------------- Read hosts file
2665: {
2666: my $config=Apache::File->new("$perlvar{'lonTabDir'}/hosts.tab");
2667:
2668: while (my $configline=<$config>) {
1.154 www 2669: chomp($configline);
1.1 albertel 2670: my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
2671: $hostname{$id}=$name;
2672: $hostdom{$id}=$domain;
1.150 www 2673: $hostip{$id}=$ip;
1.1 albertel 2674: if ($role eq 'library') { $libserv{$id}=$name; }
2675: }
2676: }
2677:
2678: # ------------------------------------------------------ Read spare server file
2679: {
2680: my $config=Apache::File->new("$perlvar{'lonTabDir'}/spare.tab");
2681:
2682: while (my $configline=<$config>) {
2683: chomp($configline);
2684: if (($configline) && ($configline ne $perlvar{'lonHostID'})) {
2685: $spareid{$configline}=1;
2686: }
2687: }
2688: }
1.11 www 2689: # ------------------------------------------------------------ Read permissions
2690: {
2691: my $config=Apache::File->new("$perlvar{'lonTabDir'}/roles.tab");
2692:
2693: while (my $configline=<$config>) {
2694: chomp($configline);
1.160 www 2695: if ($configline) {
1.11 www 2696: my ($role,$perm)=split(/ /,$configline);
2697: if ($perm ne '') { $pr{$role}=$perm; }
1.160 www 2698: }
1.11 www 2699: }
2700: }
2701:
2702: # -------------------------------------------- Read plain texts for permissions
2703: {
2704: my $config=Apache::File->new("$perlvar{'lonTabDir'}/rolesplain.tab");
2705:
2706: while (my $configline=<$config>) {
2707: chomp($configline);
1.160 www 2708: if ($configline) {
1.11 www 2709: my ($short,$plain)=split(/:/,$configline);
2710: if ($plain ne '') { $prp{$short}=$plain; }
1.160 www 2711: }
1.135 www 2712: }
2713: }
2714:
2715: # ---------------------------------------------------------- Read package table
2716: {
2717: my $config=Apache::File->new("$perlvar{'lonTabDir'}/packages.tab");
2718:
2719: while (my $configline=<$config>) {
2720: chomp($configline);
2721: my ($short,$plain)=split(/:/,$configline);
1.143 www 2722: my ($pack,$name)=split(/\&/,$short);
2723: if ($plain ne '') {
2724: $packagetab{$pack.'&'.$name.'&name'}=$name;
2725: $packagetab{$short}=$plain;
2726: }
1.25 www 2727: }
2728: }
2729:
2730: # ------------------------------------------------------------- Read file types
2731: {
2732: my $config=Apache::File->new("$perlvar{'lonTabDir'}/filetypes.tab");
2733:
2734: while (my $configline=<$config>) {
1.183 albertel 2735: next if ($configline =~ /^\#/);
1.25 www 2736: chomp($configline);
2737: my ($ending,$emb,@descr)=split(/\s+/,$configline);
2738: if ($descr[0] ne '') {
1.181 matthew 2739: $fe{$ending}=lc($emb);
1.25 www 2740: $fd{$ending}=join(' ',@descr);
2741: }
1.11 www 2742: }
2743: }
2744:
1.71 www 2745: %metacache=();
1.185 www 2746:
2747: $processmarker=$$.'_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 2748: $dumpcount=0;
1.22 www 2749:
1.163 harris41 2750: &logtouch();
1.12 www 2751: &logthis('<font color=yellow>INFO: Read configuration</font>');
1.1 albertel 2752: }
1.179 www 2753:
1.1 albertel 2754: 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