Annotation of loncom/lond, revision 1.347
1.1 albertel 1: #!/usr/bin/perl
2: # The LearningOnline Network
3: # lond "LON Daemon" Server (port "LOND" 5663)
1.60 www 4: #
1.347 ! raeburn 5: # $Id: lond,v 1.346 2006/10/23 21:22:38 raeburn Exp $
1.60 www 6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
1.167 foxr 13: # the Free Software Foundation; either version 2 of the License, or
1.60 www 14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
1.178 foxr 23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1.60 www 24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
1.161 foxr 27:
28:
1.60 www 29: # http://www.lon-capa.org/
30: #
1.54 harris41 31:
1.134 albertel 32: use strict;
1.80 harris41 33: use lib '/home/httpd/lib/perl/';
1.325 albertel 34: use LONCAPA;
1.80 harris41 35: use LONCAPA::Configuration;
36:
1.1 albertel 37: use IO::Socket;
38: use IO::File;
1.126 albertel 39: #use Apache::File;
1.1 albertel 40: use POSIX;
41: use Crypt::IDEA;
42: use LWP::UserAgent();
1.347 ! raeburn 43: use Digest::MD5 qw(md5_hex);
1.3 www 44: use GDBM_File;
45: use Authen::Krb4;
1.91 albertel 46: use Authen::Krb5;
1.49 albertel 47: use lib '/home/httpd/lib/perl/';
48: use localauth;
1.193 raeburn 49: use localenroll;
1.265 albertel 50: use localstudentphoto;
1.143 foxr 51: use File::Copy;
1.292 albertel 52: use File::Find;
1.169 foxr 53: use LONCAPA::ConfigFileEdit;
1.200 matthew 54: use LONCAPA::lonlocal;
55: use LONCAPA::lonssl;
1.221 albertel 56: use Fcntl qw(:flock);
1.1 albertel 57:
1.239 foxr 58: my $DEBUG = 0; # Non zero to enable debug log entries.
1.77 foxr 59:
1.57 www 60: my $status='';
61: my $lastlog='';
62:
1.347 ! raeburn 63: my $VERSION='$Revision: 1.346 $'; #' stupid emacs
1.121 albertel 64: my $remoteVERSION;
1.214 foxr 65: my $currenthostid="default";
1.115 albertel 66: my $currentdomainid;
1.134 albertel 67:
68: my $client;
1.200 matthew 69: my $clientip; # IP address of client.
70: my $clientname; # LonCAPA name of client.
1.140 foxr 71:
1.134 albertel 72: my $server;
1.200 matthew 73: my $thisserver; # DNS of us.
74:
75: my $keymode;
1.198 foxr 76:
1.207 foxr 77: my $cipher; # Cipher key negotiated with client
78: my $tmpsnum = 0; # Id of tmpputs.
79:
1.178 foxr 80: #
81: # Connection type is:
82: # client - All client actions are allowed
83: # manager - only management functions allowed.
84: # both - Both management and client actions are allowed
85: #
1.161 foxr 86:
1.178 foxr 87: my $ConnectionType;
1.161 foxr 88:
1.200 matthew 89: my %hostid; # ID's for hosts in cluster by ip.
90: my %hostdom; # LonCAPA domain for hosts in cluster.
1.307 albertel 91: my %hostname; # DNSname -> ID's mapping.
1.200 matthew 92: my %hostip; # IPs for hosts in cluster.
93: my %hostdns; # ID's of hosts looked up by DNS name.
1.161 foxr 94:
1.178 foxr 95: my %managers; # Ip -> manager names
1.161 foxr 96:
1.178 foxr 97: my %perlvar; # Will have the apache conf defined perl vars.
1.134 albertel 98:
1.178 foxr 99: #
1.207 foxr 100: # The hash below is used for command dispatching, and is therefore keyed on the request keyword.
101: # Each element of the hash contains a reference to an array that contains:
102: # A reference to a sub that executes the request corresponding to the keyword.
103: # A flag that is true if the request must be encoded to be acceptable.
104: # A mask with bits as follows:
105: # CLIENT_OK - Set when the function is allowed by ordinary clients
106: # MANAGER_OK - Set when the function is allowed to manager clients.
107: #
108: my $CLIENT_OK = 1;
109: my $MANAGER_OK = 2;
110: my %Dispatcher;
111:
112:
113: #
1.178 foxr 114: # The array below are password error strings."
115: #
116: my $lastpwderror = 13; # Largest error number from lcpasswd.
117: my @passwderrors = ("ok",
1.287 foxr 118: "pwchange_failure - lcpasswd must be run as user 'www'",
119: "pwchange_failure - lcpasswd got incorrect number of arguments",
120: "pwchange_failure - lcpasswd did not get the right nubmer of input text lines",
121: "pwchange_failure - lcpasswd too many simultaneous pwd changes in progress",
122: "pwchange_failure - lcpasswd User does not exist.",
123: "pwchange_failure - lcpasswd Incorrect current passwd",
124: "pwchange_failure - lcpasswd Unable to su to root.",
125: "pwchange_failure - lcpasswd Cannot set new passwd.",
126: "pwchange_failure - lcpasswd Username has invalid characters",
127: "pwchange_failure - lcpasswd Invalid characters in password",
128: "pwchange_failure - lcpasswd User already exists",
129: "pwchange_failure - lcpasswd Something went wrong with user addition.",
130: "pwchange_failure - lcpasswd Password mismatch",
131: "pwchange_failure - lcpasswd Error filename is invalid");
1.97 foxr 132:
133:
1.178 foxr 134: # The array below are lcuseradd error strings.:
1.97 foxr 135:
1.178 foxr 136: my $lastadderror = 13;
137: my @adderrors = ("ok",
138: "User ID mismatch, lcuseradd must run as user www",
139: "lcuseradd Incorrect number of command line parameters must be 3",
140: "lcuseradd Incorrect number of stdinput lines, must be 3",
141: "lcuseradd Too many other simultaneous pwd changes in progress",
142: "lcuseradd User does not exist",
143: "lcuseradd Unable to make www member of users's group",
144: "lcuseradd Unable to su to root",
145: "lcuseradd Unable to set password",
146: "lcuseradd Usrname has invalid characters",
147: "lcuseradd Password has an invalid character",
148: "lcuseradd User already exists",
149: "lcuseradd Could not add user.",
150: "lcuseradd Password mismatch");
1.97 foxr 151:
1.96 foxr 152:
1.207 foxr 153:
154: #
155: # Statistics that are maintained and dislayed in the status line.
156: #
1.212 foxr 157: my $Transactions = 0; # Number of attempted transactions.
158: my $Failures = 0; # Number of transcations failed.
1.207 foxr 159:
160: # ResetStatistics:
161: # Resets the statistics counters:
162: #
163: sub ResetStatistics {
164: $Transactions = 0;
165: $Failures = 0;
166: }
167:
1.200 matthew 168: #------------------------------------------------------------------------
169: #
170: # LocalConnection
171: # Completes the formation of a locally authenticated connection.
172: # This function will ensure that the 'remote' client is really the
173: # local host. If not, the connection is closed, and the function fails.
174: # If so, initcmd is parsed for the name of a file containing the
175: # IDEA session key. The fie is opened, read, deleted and the session
176: # key returned to the caller.
177: #
178: # Parameters:
179: # $Socket - Socket open on client.
180: # $initcmd - The full text of the init command.
181: #
182: # Implicit inputs:
183: # $thisserver - Our DNS name.
184: #
185: # Returns:
186: # IDEA session key on success.
187: # undef on failure.
188: #
189: sub LocalConnection {
190: my ($Socket, $initcmd) = @_;
1.277 albertel 191: Debug("Attempting local connection: $initcmd client: $clientip me: $thisserver");
192: if($clientip ne "127.0.0.1") {
1.200 matthew 193: &logthis('<font color="red"> LocalConnection rejecting non local: '
1.277 albertel 194: ."$clientip ne $thisserver </font>");
1.200 matthew 195: close $Socket;
196: return undef;
1.224 foxr 197: } else {
1.200 matthew 198: chomp($initcmd); # Get rid of \n in filename.
199: my ($init, $type, $name) = split(/:/, $initcmd);
200: Debug(" Init command: $init $type $name ");
201:
202: # Require that $init = init, and $type = local: Otherwise
203: # the caller is insane:
204:
205: if(($init ne "init") && ($type ne "local")) {
206: &logthis('<font color = "red"> LocalConnection: caller is insane! '
207: ."init = $init, and type = $type </font>");
208: close($Socket);;
209: return undef;
210:
211: }
212: # Now get the key filename:
213:
214: my $IDEAKey = lonlocal::ReadKeyFile($name);
215: return $IDEAKey;
216: }
217: }
218: #------------------------------------------------------------------------------
219: #
220: # SSLConnection
221: # Completes the formation of an ssh authenticated connection. The
222: # socket is promoted to an ssl socket. If this promotion and the associated
223: # certificate exchange are successful, the IDEA key is generated and sent
224: # to the remote peer via the SSL tunnel. The IDEA key is also returned to
225: # the caller after the SSL tunnel is torn down.
226: #
227: # Parameters:
228: # Name Type Purpose
229: # $Socket IO::Socket::INET Plaintext socket.
230: #
231: # Returns:
232: # IDEA key on success.
233: # undef on failure.
234: #
235: sub SSLConnection {
236: my $Socket = shift;
237:
238: Debug("SSLConnection: ");
239: my $KeyFile = lonssl::KeyFile();
240: if(!$KeyFile) {
241: my $err = lonssl::LastError();
242: &logthis("<font color=\"red\"> CRITICAL"
243: ."Can't get key file $err </font>");
244: return undef;
245: }
246: my ($CACertificate,
247: $Certificate) = lonssl::CertificateFile();
248:
249:
250: # If any of the key, certificate or certificate authority
251: # certificate filenames are not defined, this can't work.
252:
253: if((!$Certificate) || (!$CACertificate)) {
254: my $err = lonssl::LastError();
255: &logthis("<font color=\"red\"> CRITICAL"
256: ."Can't get certificates: $err </font>");
257:
258: return undef;
259: }
260: Debug("Key: $KeyFile CA: $CACertificate Cert: $Certificate");
261:
262: # Indicate to our peer that we can procede with
263: # a transition to ssl authentication:
264:
265: print $Socket "ok:ssl\n";
266:
267: Debug("Approving promotion -> ssl");
268: # And do so:
269:
270: my $SSLSocket = lonssl::PromoteServerSocket($Socket,
271: $CACertificate,
272: $Certificate,
273: $KeyFile);
274: if(! ($SSLSocket) ) { # SSL socket promotion failed.
275: my $err = lonssl::LastError();
276: &logthis("<font color=\"red\"> CRITICAL "
277: ."SSL Socket promotion failed: $err </font>");
278: return undef;
279: }
280: Debug("SSL Promotion successful");
281:
282: #
283: # The only thing we'll use the socket for is to send the IDEA key
284: # to the peer:
285:
286: my $Key = lonlocal::CreateCipherKey();
287: print $SSLSocket "$Key\n";
288:
289: lonssl::Close($SSLSocket);
290:
291: Debug("Key exchange complete: $Key");
292:
293: return $Key;
294: }
295: #
296: # InsecureConnection:
297: # If insecure connections are allowd,
298: # exchange a challenge with the client to 'validate' the
299: # client (not really, but that's the protocol):
300: # We produce a challenge string that's sent to the client.
301: # The client must then echo the challenge verbatim to us.
302: #
303: # Parameter:
304: # Socket - Socket open on the client.
305: # Returns:
306: # 1 - success.
307: # 0 - failure (e.g.mismatch or insecure not allowed).
308: #
309: sub InsecureConnection {
310: my $Socket = shift;
311:
312: # Don't even start if insecure connections are not allowed.
313:
314: if(! $perlvar{londAllowInsecure}) { # Insecure connections not allowed.
315: return 0;
316: }
317:
318: # Fabricate a challenge string and send it..
319:
320: my $challenge = "$$".time; # pid + time.
321: print $Socket "$challenge\n";
322: &status("Waiting for challenge reply");
323:
324: my $answer = <$Socket>;
325: $answer =~s/\W//g;
326: if($challenge eq $answer) {
327: return 1;
1.224 foxr 328: } else {
1.200 matthew 329: logthis("<font color='blue'>WARNING client did not respond to challenge</font>");
330: &status("No challenge reqply");
331: return 0;
332: }
333:
334:
335: }
1.251 foxr 336: #
337: # Safely execute a command (as long as it's not a shel command and doesn
338: # not require/rely on shell escapes. The function operates by doing a
339: # a pipe based fork and capturing stdout and stderr from the pipe.
340: #
341: # Formal Parameters:
342: # $line - A line of text to be executed as a command.
343: # Returns:
344: # The output from that command. If the output is multiline the caller
345: # must know how to split up the output.
346: #
347: #
348: sub execute_command {
349: my ($line) = @_;
350: my @words = split(/\s/, $line); # Bust the command up into words.
351: my $output = "";
352:
353: my $pid = open(CHILD, "-|");
354:
355: if($pid) { # Parent process
356: Debug("In parent process for execute_command");
357: my @data = <CHILD>; # Read the child's outupt...
358: close CHILD;
359: foreach my $output_line (@data) {
360: Debug("Adding $output_line");
361: $output .= $output_line; # Presumably has a \n on it.
362: }
363:
364: } else { # Child process
365: close (STDERR);
366: open (STDERR, ">&STDOUT");# Combine stderr, and stdout...
367: exec(@words); # won't return.
368: }
369: return $output;
370: }
371:
1.200 matthew 372:
1.140 foxr 373: # GetCertificate: Given a transaction that requires a certificate,
374: # this function will extract the certificate from the transaction
375: # request. Note that at this point, the only concept of a certificate
376: # is the hostname to which we are connected.
377: #
378: # Parameter:
379: # request - The request sent by our client (this parameterization may
380: # need to change when we really use a certificate granting
381: # authority.
382: #
383: sub GetCertificate {
384: my $request = shift;
385:
386: return $clientip;
387: }
1.161 foxr 388:
1.178 foxr 389: #
390: # Return true if client is a manager.
391: #
392: sub isManager {
393: return (($ConnectionType eq "manager") || ($ConnectionType eq "both"));
394: }
395: #
396: # Return tru if client can do client functions
397: #
398: sub isClient {
399: return (($ConnectionType eq "client") || ($ConnectionType eq "both"));
400: }
1.161 foxr 401:
402:
1.156 foxr 403: #
404: # ReadManagerTable: Reads in the current manager table. For now this is
405: # done on each manager authentication because:
406: # - These authentications are not frequent
407: # - This allows dynamic changes to the manager table
408: # without the need to signal to the lond.
409: #
410: sub ReadManagerTable {
411:
412: # Clean out the old table first..
413:
1.166 foxr 414: foreach my $key (keys %managers) {
415: delete $managers{$key};
416: }
417:
418: my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
419: if (!open (MANAGERS, $tablename)) {
420: logthis('<font color="red">No manager table. Nobody can manage!!</font>');
421: return;
422: }
423: while(my $host = <MANAGERS>) {
424: chomp($host);
425: if ($host =~ "^#") { # Comment line.
426: next;
427: }
428: if (!defined $hostip{$host}) { # This is a non cluster member
1.161 foxr 429: # The entry is of the form:
430: # cluname:hostname
431: # cluname - A 'cluster hostname' is needed in order to negotiate
432: # the host key.
433: # hostname- The dns name of the host.
434: #
1.166 foxr 435: my($cluname, $dnsname) = split(/:/, $host);
436:
437: my $ip = gethostbyname($dnsname);
438: if(defined($ip)) { # bad names don't deserve entry.
439: my $hostip = inet_ntoa($ip);
440: $managers{$hostip} = $cluname;
441: logthis('<font color="green"> registering manager '.
442: "$dnsname as $cluname with $hostip </font>\n");
443: }
444: } else {
445: logthis('<font color="green"> existing host'." $host</font>\n");
446: $managers{$hostip{$host}} = $host; # Use info from cluster tab if clumemeber
447: }
448: }
1.156 foxr 449: }
1.140 foxr 450:
451: #
452: # ValidManager: Determines if a given certificate represents a valid manager.
453: # in this primitive implementation, the 'certificate' is
454: # just the connecting loncapa client name. This is checked
455: # against a valid client list in the configuration.
456: #
457: #
458: sub ValidManager {
459: my $certificate = shift;
460:
1.163 foxr 461: return isManager;
1.140 foxr 462: }
463: #
1.143 foxr 464: # CopyFile: Called as part of the process of installing a
465: # new configuration file. This function copies an existing
466: # file to a backup file.
467: # Parameters:
468: # oldfile - Name of the file to backup.
469: # newfile - Name of the backup file.
470: # Return:
471: # 0 - Failure (errno has failure reason).
472: # 1 - Success.
473: #
474: sub CopyFile {
1.192 foxr 475:
476: my ($oldfile, $newfile) = @_;
1.143 foxr 477:
1.281 matthew 478: if (! copy($oldfile,$newfile)) {
479: return 0;
1.143 foxr 480: }
1.281 matthew 481: chmod(0660, $newfile);
482: return 1;
1.143 foxr 483: }
1.157 foxr 484: #
485: # Host files are passed out with externally visible host IPs.
486: # If, for example, we are behind a fire-wall or NAT host, our
487: # internally visible IP may be different than the externally
488: # visible IP. Therefore, we always adjust the contents of the
489: # host file so that the entry for ME is the IP that we believe
490: # we have. At present, this is defined as the entry that
491: # DNS has for us. If by some chance we are not able to get a
492: # DNS translation for us, then we assume that the host.tab file
493: # is correct.
494: # BUGBUGBUG - in the future, we really should see if we can
495: # easily query the interface(s) instead.
496: # Parameter(s):
497: # contents - The contents of the host.tab to check.
498: # Returns:
499: # newcontents - The adjusted contents.
500: #
501: #
502: sub AdjustHostContents {
503: my $contents = shift;
504: my $adjusted;
505: my $me = $perlvar{'lonHostID'};
506:
1.166 foxr 507: foreach my $line (split(/\n/,$contents)) {
1.157 foxr 508: if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {
509: chomp($line);
510: my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
511: if ($id eq $me) {
1.166 foxr 512: my $ip = gethostbyname($name);
513: my $ipnew = inet_ntoa($ip);
514: $ip = $ipnew;
1.157 foxr 515: # Reconstruct the host line and append to adjusted:
516:
1.166 foxr 517: my $newline = "$id:$domain:$role:$name:$ip";
518: if($maxcon ne "") { # Not all hosts have loncnew tuning params
519: $newline .= ":$maxcon:$idleto:$mincon";
520: }
521: $adjusted .= $newline."\n";
1.157 foxr 522:
1.166 foxr 523: } else { # Not me, pass unmodified.
524: $adjusted .= $line."\n";
525: }
1.157 foxr 526: } else { # Blank or comment never re-written.
527: $adjusted .= $line."\n"; # Pass blanks and comments as is.
528: }
1.166 foxr 529: }
530: return $adjusted;
1.157 foxr 531: }
1.143 foxr 532: #
533: # InstallFile: Called to install an administrative file:
534: # - The file is created with <name>.tmp
535: # - The <name>.tmp file is then mv'd to <name>
536: # This lugubrious procedure is done to ensure that we are never without
537: # a valid, even if dated, version of the file regardless of who crashes
538: # and when the crash occurs.
539: #
540: # Parameters:
541: # Name of the file
542: # File Contents.
543: # Return:
544: # nonzero - success.
545: # 0 - failure and $! has an errno.
546: #
547: sub InstallFile {
1.192 foxr 548:
549: my ($Filename, $Contents) = @_;
1.143 foxr 550: my $TempFile = $Filename.".tmp";
551:
552: # Open the file for write:
553:
554: my $fh = IO::File->new("> $TempFile"); # Write to temp.
555: if(!(defined $fh)) {
556: &logthis('<font color="red"> Unable to create '.$TempFile."</font>");
557: return 0;
558: }
559: # write the contents of the file:
560:
561: print $fh ($Contents);
562: $fh->close; # In case we ever have a filesystem w. locking
563:
564: chmod(0660, $TempFile);
565:
566: # Now we can move install the file in position.
567:
568: move($TempFile, $Filename);
569:
570: return 1;
571: }
1.200 matthew 572:
573:
1.169 foxr 574: #
575: # ConfigFileFromSelector: converts a configuration file selector
576: # (one of host or domain at this point) into a
577: # configuration file pathname.
578: #
579: # Parameters:
580: # selector - Configuration file selector.
581: # Returns:
582: # Full path to the file or undef if the selector is invalid.
583: #
584: sub ConfigFileFromSelector {
585: my $selector = shift;
586: my $tablefile;
587:
588: my $tabledir = $perlvar{'lonTabDir'}.'/';
589: if ($selector eq "hosts") {
590: $tablefile = $tabledir."hosts.tab";
591: } elsif ($selector eq "domain") {
592: $tablefile = $tabledir."domain.tab";
593: } else {
594: return undef;
595: }
596: return $tablefile;
1.143 foxr 597:
1.169 foxr 598: }
1.143 foxr 599: #
1.141 foxr 600: # PushFile: Called to do an administrative push of a file.
601: # - Ensure the file being pushed is one we support.
602: # - Backup the old file to <filename.saved>
603: # - Separate the contents of the new file out from the
604: # rest of the request.
605: # - Write the new file.
606: # Parameter:
607: # Request - The entire user request. This consists of a : separated
608: # string pushfile:tablename:contents.
609: # NOTE: The contents may have :'s in it as well making things a bit
610: # more interesting... but not much.
611: # Returns:
612: # String to send to client ("ok" or "refused" if bad file).
613: #
614: sub PushFile {
615: my $request = shift;
616: my ($command, $filename, $contents) = split(":", $request, 3);
617:
618: # At this point in time, pushes for only the following tables are
619: # supported:
620: # hosts.tab ($filename eq host).
621: # domain.tab ($filename eq domain).
622: # Construct the destination filename or reject the request.
623: #
624: # lonManage is supposed to ensure this, however this session could be
625: # part of some elaborate spoof that managed somehow to authenticate.
626: #
627:
1.169 foxr 628:
629: my $tablefile = ConfigFileFromSelector($filename);
630: if(! (defined $tablefile)) {
1.141 foxr 631: return "refused";
632: }
633: #
634: # >copy< the old table to the backup table
635: # don't rename in case system crashes/reboots etc. in the time
636: # window between a rename and write.
637: #
638: my $backupfile = $tablefile;
639: $backupfile =~ s/\.tab$/.old/;
1.143 foxr 640: if(!CopyFile($tablefile, $backupfile)) {
641: &logthis('<font color="green"> CopyFile from '.$tablefile." to ".$backupfile." failed </font>");
642: return "error:$!";
643: }
1.141 foxr 644: &logthis('<font color="green"> Pushfile: backed up '
645: .$tablefile." to $backupfile</font>");
646:
1.157 foxr 647: # If the file being pushed is the host file, we adjust the entry for ourself so that the
648: # IP will be our current IP as looked up in dns. Note this is only 99% good as it's possible
649: # to conceive of conditions where we don't have a DNS entry locally. This is possible in a
650: # network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
651: # that possibilty.
652:
653: if($filename eq "host") {
654: $contents = AdjustHostContents($contents);
655: }
656:
1.141 foxr 657: # Install the new file:
658:
1.143 foxr 659: if(!InstallFile($tablefile, $contents)) {
660: &logthis('<font color="red"> Pushfile: unable to install '
1.145 foxr 661: .$tablefile." $! </font>");
1.143 foxr 662: return "error:$!";
1.224 foxr 663: } else {
1.143 foxr 664: &logthis('<font color="green"> Installed new '.$tablefile
665: ."</font>");
666:
667: }
668:
1.141 foxr 669:
670: # Indicate success:
671:
672: return "ok";
673:
674: }
1.145 foxr 675:
676: #
677: # Called to re-init either lonc or lond.
678: #
679: # Parameters:
680: # request - The full request by the client. This is of the form
681: # reinit:<process>
682: # where <process> is allowed to be either of
683: # lonc or lond
684: #
685: # Returns:
686: # The string to be sent back to the client either:
687: # ok - Everything worked just fine.
688: # error:why - There was a failure and why describes the reason.
689: #
690: #
691: sub ReinitProcess {
692: my $request = shift;
693:
1.146 foxr 694:
695: # separate the request (reinit) from the process identifier and
696: # validate it producing the name of the .pid file for the process.
697: #
698: #
699: my ($junk, $process) = split(":", $request);
1.147 foxr 700: my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
1.146 foxr 701: if($process eq 'lonc') {
702: $processpidfile = $processpidfile."lonc.pid";
1.147 foxr 703: if (!open(PIDFILE, "< $processpidfile")) {
704: return "error:Open failed for $processpidfile";
705: }
706: my $loncpid = <PIDFILE>;
707: close(PIDFILE);
708: logthis('<font color="red"> Reinitializing lonc pid='.$loncpid
709: ."</font>");
710: kill("USR2", $loncpid);
1.146 foxr 711: } elsif ($process eq 'lond') {
1.147 foxr 712: logthis('<font color="red"> Reinitializing self (lond) </font>');
713: &UpdateHosts; # Lond is us!!
1.146 foxr 714: } else {
715: &logthis('<font color="yellow" Invalid reinit request for '.$process
716: ."</font>");
717: return "error:Invalid process identifier $process";
718: }
1.145 foxr 719: return 'ok';
720: }
1.168 foxr 721: # Validate a line in a configuration file edit script:
722: # Validation includes:
723: # - Ensuring the command is valid.
724: # - Ensuring the command has sufficient parameters
725: # Parameters:
726: # scriptline - A line to validate (\n has been stripped for what it's worth).
1.167 foxr 727: #
1.168 foxr 728: # Return:
729: # 0 - Invalid scriptline.
730: # 1 - Valid scriptline
731: # NOTE:
732: # Only the command syntax is checked, not the executability of the
733: # command.
734: #
735: sub isValidEditCommand {
736: my $scriptline = shift;
737:
738: # Line elements are pipe separated:
739:
740: my ($command, $key, $newline) = split(/\|/, $scriptline);
741: &logthis('<font color="green"> isValideditCommand checking: '.
742: "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
743:
744: if ($command eq "delete") {
745: #
746: # key with no newline.
747: #
748: if( ($key eq "") || ($newline ne "")) {
749: return 0; # Must have key but no newline.
750: } else {
751: return 1; # Valid syntax.
752: }
1.169 foxr 753: } elsif ($command eq "replace") {
1.168 foxr 754: #
755: # key and newline:
756: #
757: if (($key eq "") || ($newline eq "")) {
758: return 0;
759: } else {
760: return 1;
761: }
1.169 foxr 762: } elsif ($command eq "append") {
763: if (($key ne "") && ($newline eq "")) {
764: return 1;
765: } else {
766: return 0;
767: }
1.168 foxr 768: } else {
769: return 0; # Invalid command.
770: }
771: return 0; # Should not get here!!!
772: }
1.169 foxr 773: #
774: # ApplyEdit - Applies an edit command to a line in a configuration
775: # file. It is the caller's responsiblity to validate the
776: # edit line.
777: # Parameters:
778: # $directive - A single edit directive to apply.
779: # Edit directives are of the form:
780: # append|newline - Appends a new line to the file.
781: # replace|key|newline - Replaces the line with key value 'key'
782: # delete|key - Deletes the line with key value 'key'.
783: # $editor - A config file editor object that contains the
784: # file being edited.
785: #
786: sub ApplyEdit {
1.192 foxr 787:
788: my ($directive, $editor) = @_;
1.169 foxr 789:
790: # Break the directive down into its command and its parameters
791: # (at most two at this point. The meaning of the parameters, if in fact
792: # they exist depends on the command).
793:
794: my ($command, $p1, $p2) = split(/\|/, $directive);
795:
796: if($command eq "append") {
797: $editor->Append($p1); # p1 - key p2 null.
798: } elsif ($command eq "replace") {
799: $editor->ReplaceLine($p1, $p2); # p1 - key p2 = newline.
800: } elsif ($command eq "delete") {
801: $editor->DeleteLine($p1); # p1 - key p2 null.
802: } else { # Should not get here!!!
803: die "Invalid command given to ApplyEdit $command"
804: }
805: }
806: #
807: # AdjustOurHost:
808: # Adjusts a host file stored in a configuration file editor object
809: # for the true IP address of this host. This is necessary for hosts
810: # that live behind a firewall.
811: # Those hosts have a publicly distributed IP of the firewall, but
812: # internally must use their actual IP. We assume that a given
813: # host only has a single IP interface for now.
814: # Formal Parameters:
815: # editor - The configuration file editor to adjust. This
816: # editor is assumed to contain a hosts.tab file.
817: # Strategy:
818: # - Figure out our hostname.
819: # - Lookup the entry for this host.
820: # - Modify the line to contain our IP
821: # - Do a replace for this host.
822: sub AdjustOurHost {
823: my $editor = shift;
824:
825: # figure out who I am.
826:
827: my $myHostName = $perlvar{'lonHostID'}; # LonCAPA hostname.
828:
829: # Get my host file entry.
830:
831: my $ConfigLine = $editor->Find($myHostName);
832: if(! (defined $ConfigLine)) {
833: die "AdjustOurHost - no entry for me in hosts file $myHostName";
834: }
835: # figure out my IP:
836: # Use the config line to get my hostname.
837: # Use gethostbyname to translate that into an IP address.
838: #
1.338 albertel 839: my ($id,$domain,$role,$name,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
1.169 foxr 840: #
841: # Reassemble the config line from the elements in the list.
842: # Note that if the loncnew items were not present before, they will
843: # be now even if they would be empty
844: #
845: my $newConfigLine = $id;
1.338 albertel 846: foreach my $item ($domain, $role, $name, $maxcon, $idleto, $mincon) {
1.169 foxr 847: $newConfigLine .= ":".$item;
848: }
849: # Replace the line:
850:
851: $editor->ReplaceLine($id, $newConfigLine);
852:
853: }
854: #
855: # ReplaceConfigFile:
856: # Replaces a configuration file with the contents of a
857: # configuration file editor object.
858: # This is done by:
859: # - Copying the target file to <filename>.old
860: # - Writing the new file to <filename>.tmp
861: # - Moving <filename.tmp> -> <filename>
862: # This laborious process ensures that the system is never without
863: # a configuration file that's at least valid (even if the contents
864: # may be dated).
865: # Parameters:
866: # filename - Name of the file to modify... this is a full path.
867: # editor - Editor containing the file.
868: #
869: sub ReplaceConfigFile {
1.192 foxr 870:
871: my ($filename, $editor) = @_;
1.168 foxr 872:
1.169 foxr 873: CopyFile ($filename, $filename.".old");
874:
875: my $contents = $editor->Get(); # Get the contents of the file.
876:
877: InstallFile($filename, $contents);
878: }
1.168 foxr 879: #
880: #
881: # Called to edit a configuration table file
1.167 foxr 882: # Parameters:
883: # request - The entire command/request sent by lonc or lonManage
884: # Return:
885: # The reply to send to the client.
1.168 foxr 886: #
1.167 foxr 887: sub EditFile {
888: my $request = shift;
889:
890: # Split the command into it's pieces: edit:filetype:script
891:
1.339 albertel 892: my ($cmd, $filetype, $script) = split(/:/, $request,3); # : in script
1.167 foxr 893:
894: # Check the pre-coditions for success:
895:
1.339 albertel 896: if($cmd != "edit") { # Something is amiss afoot alack.
1.167 foxr 897: return "error:edit request detected, but request != 'edit'\n";
898: }
899: if( ($filetype ne "hosts") &&
900: ($filetype ne "domain")) {
901: return "error:edit requested with invalid file specifier: $filetype \n";
902: }
903:
904: # Split the edit script and check it's validity.
1.168 foxr 905:
906: my @scriptlines = split(/\n/, $script); # one line per element.
907: my $linecount = scalar(@scriptlines);
908: for(my $i = 0; $i < $linecount; $i++) {
909: chomp($scriptlines[$i]);
910: if(!isValidEditCommand($scriptlines[$i])) {
911: return "error:edit with bad script line: '$scriptlines[$i]' \n";
912: }
913: }
1.145 foxr 914:
1.167 foxr 915: # Execute the edit operation.
1.169 foxr 916: # - Create a config file editor for the appropriate file and
917: # - execute each command in the script:
918: #
919: my $configfile = ConfigFileFromSelector($filetype);
920: if (!(defined $configfile)) {
921: return "refused\n";
922: }
923: my $editor = ConfigFileEdit->new($configfile);
1.167 foxr 924:
1.169 foxr 925: for (my $i = 0; $i < $linecount; $i++) {
926: ApplyEdit($scriptlines[$i], $editor);
927: }
928: # If the file is the host file, ensure that our host is
929: # adjusted to have our ip:
930: #
931: if($filetype eq "host") {
932: AdjustOurHost($editor);
933: }
934: # Finally replace the current file with our file.
935: #
936: ReplaceConfigFile($configfile, $editor);
1.167 foxr 937:
938: return "ok\n";
939: }
1.207 foxr 940:
1.255 foxr 941: # read_profile
942: #
943: # Returns a set of specific entries from a user's profile file.
944: # this is a utility function that is used by both get_profile_entry and
945: # get_profile_entry_encrypted.
946: #
947: # Parameters:
948: # udom - Domain in which the user exists.
949: # uname - User's account name (loncapa account)
950: # namespace - The profile namespace to open.
951: # what - A set of & separated queries.
952: # Returns:
953: # If all ok: - The string that needs to be shipped back to the user.
954: # If failure - A string that starts with error: followed by the failure
955: # reason.. note that this probabyl gets shipped back to the
956: # user as well.
957: #
958: sub read_profile {
959: my ($udom, $uname, $namespace, $what) = @_;
960:
961: my $hashref = &tie_user_hash($udom, $uname, $namespace,
962: &GDBM_READER());
963: if ($hashref) {
964: my @queries=split(/\&/,$what);
965: my $qresult='';
966:
967: for (my $i=0;$i<=$#queries;$i++) {
968: $qresult.="$hashref->{$queries[$i]}&"; # Presumably failure gives empty string.
969: }
970: $qresult=~s/\&$//; # Remove trailing & from last lookup.
1.311 albertel 971: if (&untie_user_hash($hashref)) {
1.255 foxr 972: return $qresult;
973: } else {
974: return "error: ".($!+0)." untie (GDBM) Failed";
975: }
976: } else {
977: if ($!+0 == 2) {
978: return "error:No such file or GDBM reported bad block error";
979: } else {
980: return "error: ".($!+0)." tie (GDBM) Failed";
981: }
982: }
983:
984: }
1.214 foxr 985: #--------------------- Request Handlers --------------------------------------------
986: #
1.215 foxr 987: # By convention each request handler registers itself prior to the sub
988: # declaration:
1.214 foxr 989: #
990:
1.216 foxr 991: #++
992: #
1.214 foxr 993: # Handles ping requests.
994: # Parameters:
995: # $cmd - the actual keyword that invoked us.
996: # $tail - the tail of the request that invoked us.
997: # $replyfd- File descriptor connected to the client
998: # Implicit Inputs:
999: # $currenthostid - Global variable that carries the name of the host we are
1000: # known as.
1001: # Returns:
1002: # 1 - Ok to continue processing.
1003: # 0 - Program should exit.
1004: # Side effects:
1005: # Reply information is sent to the client.
1006: sub ping_handler {
1007: my ($cmd, $tail, $client) = @_;
1008: Debug("$cmd $tail $client .. $currenthostid:");
1009:
1010: Reply( $client,"$currenthostid\n","$cmd:$tail");
1011:
1012: return 1;
1013: }
1014: ®ister_handler("ping", \&ping_handler, 0, 1, 1); # Ping unencoded, client or manager.
1015:
1.216 foxr 1016: #++
1.215 foxr 1017: #
1018: # Handles pong requests. Pong replies with our current host id, and
1019: # the results of a ping sent to us via our lonc.
1020: #
1021: # Parameters:
1022: # $cmd - the actual keyword that invoked us.
1023: # $tail - the tail of the request that invoked us.
1024: # $replyfd- File descriptor connected to the client
1025: # Implicit Inputs:
1026: # $currenthostid - Global variable that carries the name of the host we are
1027: # connected to.
1028: # Returns:
1029: # 1 - Ok to continue processing.
1030: # 0 - Program should exit.
1031: # Side effects:
1032: # Reply information is sent to the client.
1033: sub pong_handler {
1034: my ($cmd, $tail, $replyfd) = @_;
1035:
1036: my $reply=&reply("ping",$clientname);
1037: &Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");
1038: return 1;
1039: }
1040: ®ister_handler("pong", \&pong_handler, 0, 1, 1); # Pong unencoded, client or manager
1041:
1.216 foxr 1042: #++
1043: # Called to establish an encrypted session key with the remote client.
1044: # Note that with secure lond, in most cases this function is never
1045: # invoked. Instead, the secure session key is established either
1046: # via a local file that's locked down tight and only lives for a short
1047: # time, or via an ssl tunnel...and is generated from a bunch-o-random
1048: # bits from /dev/urandom, rather than the predictable pattern used by
1049: # by this sub. This sub is only used in the old-style insecure
1050: # key negotiation.
1051: # Parameters:
1052: # $cmd - the actual keyword that invoked us.
1053: # $tail - the tail of the request that invoked us.
1054: # $replyfd- File descriptor connected to the client
1055: # Implicit Inputs:
1056: # $currenthostid - Global variable that carries the name of the host
1057: # known as.
1058: # $clientname - Global variable that carries the name of the hsot we're connected to.
1059: # Returns:
1060: # 1 - Ok to continue processing.
1061: # 0 - Program should exit.
1062: # Implicit Outputs:
1063: # Reply information is sent to the client.
1064: # $cipher is set with a reference to a new IDEA encryption object.
1065: #
1066: sub establish_key_handler {
1067: my ($cmd, $tail, $replyfd) = @_;
1068:
1069: my $buildkey=time.$$.int(rand 100000);
1070: $buildkey=~tr/1-6/A-F/;
1071: $buildkey=int(rand 100000).$buildkey.int(rand 100000);
1072: my $key=$currenthostid.$clientname;
1073: $key=~tr/a-z/A-Z/;
1074: $key=~tr/G-P/0-9/;
1075: $key=~tr/Q-Z/0-9/;
1076: $key=$key.$buildkey.$key.$buildkey.$key.$buildkey;
1077: $key=substr($key,0,32);
1078: my $cipherkey=pack("H32",$key);
1079: $cipher=new IDEA $cipherkey;
1080: &Reply($replyfd, "$buildkey\n", "$cmd:$tail");
1081:
1082: return 1;
1083:
1084: }
1085: ®ister_handler("ekey", \&establish_key_handler, 0, 1,1);
1086:
1.217 foxr 1087: # Handler for the load command. Returns the current system load average
1088: # to the requestor.
1089: #
1090: # Parameters:
1091: # $cmd - the actual keyword that invoked us.
1092: # $tail - the tail of the request that invoked us.
1093: # $replyfd- File descriptor connected to the client
1094: # Implicit Inputs:
1095: # $currenthostid - Global variable that carries the name of the host
1096: # known as.
1097: # $clientname - Global variable that carries the name of the hsot we're connected to.
1098: # Returns:
1099: # 1 - Ok to continue processing.
1100: # 0 - Program should exit.
1101: # Side effects:
1102: # Reply information is sent to the client.
1103: sub load_handler {
1104: my ($cmd, $tail, $replyfd) = @_;
1105:
1106: # Get the load average from /proc/loadavg and calculate it as a percentage of
1107: # the allowed load limit as set by the perl global variable lonLoadLim
1108:
1109: my $loadavg;
1110: my $loadfile=IO::File->new('/proc/loadavg');
1111:
1112: $loadavg=<$loadfile>;
1113: $loadavg =~ s/\s.*//g; # Extract the first field only.
1114:
1115: my $loadpercent=100*$loadavg/$perlvar{'lonLoadLim'};
1116:
1117: &Reply( $replyfd, "$loadpercent\n", "$cmd:$tail");
1118:
1119: return 1;
1120: }
1.263 albertel 1121: ®ister_handler("load", \&load_handler, 0, 1, 0);
1.217 foxr 1122:
1123: #
1124: # Process the userload request. This sub returns to the client the current
1125: # user load average. It can be invoked either by clients or managers.
1126: #
1127: # Parameters:
1128: # $cmd - the actual keyword that invoked us.
1129: # $tail - the tail of the request that invoked us.
1130: # $replyfd- File descriptor connected to the client
1131: # Implicit Inputs:
1132: # $currenthostid - Global variable that carries the name of the host
1133: # known as.
1134: # $clientname - Global variable that carries the name of the hsot we're connected to.
1135: # Returns:
1136: # 1 - Ok to continue processing.
1137: # 0 - Program should exit
1138: # Implicit inputs:
1139: # whatever the userload() function requires.
1140: # Implicit outputs:
1141: # the reply is written to the client.
1142: #
1143: sub user_load_handler {
1144: my ($cmd, $tail, $replyfd) = @_;
1145:
1146: my $userloadpercent=&userload();
1147: &Reply($replyfd, "$userloadpercent\n", "$cmd:$tail");
1148:
1149: return 1;
1150: }
1.263 albertel 1151: ®ister_handler("userload", \&user_load_handler, 0, 1, 0);
1.217 foxr 1152:
1.218 foxr 1153: # Process a request for the authorization type of a user:
1154: # (userauth).
1155: #
1156: # Parameters:
1157: # $cmd - the actual keyword that invoked us.
1158: # $tail - the tail of the request that invoked us.
1159: # $replyfd- File descriptor connected to the client
1160: # Returns:
1161: # 1 - Ok to continue processing.
1162: # 0 - Program should exit
1163: # Implicit outputs:
1164: # The user authorization type is written to the client.
1165: #
1166: sub user_authorization_type {
1167: my ($cmd, $tail, $replyfd) = @_;
1168:
1169: my $userinput = "$cmd:$tail";
1170:
1171: # Pull the domain and username out of the command tail.
1.222 foxr 1172: # and call get_auth_type to determine the authentication type.
1.218 foxr 1173:
1174: my ($udom,$uname)=split(/:/,$tail);
1.222 foxr 1175: my $result = &get_auth_type($udom, $uname);
1.218 foxr 1176: if($result eq "nouser") {
1177: &Failure( $replyfd, "unknown_user\n", $userinput);
1178: } else {
1179: #
1.222 foxr 1180: # We only want to pass the second field from get_auth_type
1.218 foxr 1181: # for ^krb.. otherwise we'll be handing out the encrypted
1182: # password for internals e.g.
1183: #
1184: my ($type,$otherinfo) = split(/:/,$result);
1185: if($type =~ /^krb/) {
1186: $type = $result;
1.269 raeburn 1187: } else {
1188: $type .= ':';
1189: }
1190: &Reply( $replyfd, "$type\n", $userinput);
1.218 foxr 1191: }
1192:
1193: return 1;
1194: }
1195: ®ister_handler("currentauth", \&user_authorization_type, 1, 1, 0);
1196:
1197: # Process a request by a manager to push a hosts or domain table
1198: # to us. We pick apart the command and pass it on to the subs
1199: # that already exist to do this.
1200: #
1201: # Parameters:
1202: # $cmd - the actual keyword that invoked us.
1203: # $tail - the tail of the request that invoked us.
1204: # $client - File descriptor connected to the client
1205: # Returns:
1206: # 1 - Ok to continue processing.
1207: # 0 - Program should exit
1208: # Implicit Output:
1209: # a reply is written to the client.
1210: sub push_file_handler {
1211: my ($cmd, $tail, $client) = @_;
1212:
1213: my $userinput = "$cmd:$tail";
1214:
1215: # At this time we only know that the IP of our partner is a valid manager
1216: # the code below is a hook to do further authentication (e.g. to resolve
1217: # spoofing).
1218:
1219: my $cert = &GetCertificate($userinput);
1220: if(&ValidManager($cert)) {
1221:
1222: # Now presumably we have the bona fides of both the peer host and the
1223: # process making the request.
1224:
1225: my $reply = &PushFile($userinput);
1226: &Reply($client, "$reply\n", $userinput);
1227:
1228: } else {
1229: &Failure( $client, "refused\n", $userinput);
1230: }
1.219 foxr 1231: return 1;
1.218 foxr 1232: }
1233: ®ister_handler("pushfile", \&push_file_handler, 1, 0, 1);
1234:
1.243 banghart 1235: #
1236: # du - list the disk usuage of a directory recursively.
1237: #
1238: # note: stolen code from the ls file handler
1239: # under construction by Rick Banghart
1240: # .
1241: # Parameters:
1242: # $cmd - The command that dispatched us (du).
1243: # $ududir - The directory path to list... I'm not sure what this
1244: # is relative as things like ls:. return e.g.
1245: # no_such_dir.
1246: # $client - Socket open on the client.
1247: # Returns:
1248: # 1 - indicating that the daemon should not disconnect.
1249: # Side Effects:
1250: # The reply is written to $client.
1251: #
1252: sub du_handler {
1253: my ($cmd, $ududir, $client) = @_;
1.339 albertel 1254: ($ududir) = split(/:/,$ududir); # Make 'telnet' testing easier.
1.251 foxr 1255: my $userinput = "$cmd:$ududir";
1256:
1.245 albertel 1257: if ($ududir=~/\.\./ || $ududir!~m|^/home/httpd/|) {
1258: &Failure($client,"refused\n","$cmd:$ududir");
1259: return 1;
1260: }
1.249 foxr 1261: # Since $ududir could have some nasties in it,
1262: # we will require that ududir is a valid
1263: # directory. Just in case someone tries to
1264: # slip us a line like .;(cd /home/httpd rm -rf*)
1265: # etc.
1266: #
1267: if (-d $ududir) {
1.292 albertel 1268: my $total_size=0;
1269: my $code=sub {
1270: if ($_=~/\.\d+\./) { return;}
1271: if ($_=~/\.meta$/) { return;}
1272: $total_size+=(stat($_))[7];
1273: };
1.295 raeburn 1274: chdir($ududir);
1.292 albertel 1275: find($code,$ududir);
1276: $total_size=int($total_size/1024);
1277: &Reply($client,"$total_size\n","$cmd:$ududir");
1.249 foxr 1278: } else {
1.251 foxr 1279: &Failure($client, "bad_directory:$ududir\n","$cmd:$ududir");
1.249 foxr 1280: }
1.243 banghart 1281: return 1;
1282: }
1283: ®ister_handler("du", \&du_handler, 0, 1, 0);
1.218 foxr 1284:
1.239 foxr 1285: #
1.280 matthew 1286: # The ls_handler routine should be considered obosolete and is retained
1287: # for communication with legacy servers. Please see the ls2_handler.
1288: #
1.239 foxr 1289: # ls - list the contents of a directory. For each file in the
1290: # selected directory the filename followed by the full output of
1291: # the stat function is returned. The returned info for each
1292: # file are separated by ':'. The stat fields are separated by &'s.
1293: # Parameters:
1294: # $cmd - The command that dispatched us (ls).
1295: # $ulsdir - The directory path to list... I'm not sure what this
1296: # is relative as things like ls:. return e.g.
1297: # no_such_dir.
1298: # $client - Socket open on the client.
1299: # Returns:
1300: # 1 - indicating that the daemon should not disconnect.
1301: # Side Effects:
1302: # The reply is written to $client.
1303: #
1304: sub ls_handler {
1.280 matthew 1305: # obsoleted by ls2_handler
1.239 foxr 1306: my ($cmd, $ulsdir, $client) = @_;
1307:
1308: my $userinput = "$cmd:$ulsdir";
1309:
1310: my $obs;
1311: my $rights;
1312: my $ulsout='';
1313: my $ulsfn;
1314: if (-e $ulsdir) {
1315: if(-d $ulsdir) {
1316: if (opendir(LSDIR,$ulsdir)) {
1317: while ($ulsfn=readdir(LSDIR)) {
1.291 albertel 1318: undef($obs);
1319: undef($rights);
1.239 foxr 1320: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
1321: #We do some obsolete checking here
1322: if(-e $ulsdir.'/'.$ulsfn.".meta") {
1323: open(FILE, $ulsdir.'/'.$ulsfn.".meta");
1324: my @obsolete=<FILE>;
1325: foreach my $obsolete (@obsolete) {
1.301 www 1326: if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
1.239 foxr 1327: if($obsolete =~ m|(<copyright>)(default)|) { $rights = 1; }
1328: }
1329: }
1330: $ulsout.=$ulsfn.'&'.join('&',@ulsstats);
1331: if($obs eq '1') { $ulsout.="&1"; }
1332: else { $ulsout.="&0"; }
1333: if($rights eq '1') { $ulsout.="&1:"; }
1334: else { $ulsout.="&0:"; }
1335: }
1336: closedir(LSDIR);
1337: }
1338: } else {
1339: my @ulsstats=stat($ulsdir);
1340: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
1341: }
1342: } else {
1343: $ulsout='no_such_dir';
1344: }
1345: if ($ulsout eq '') { $ulsout='empty'; }
1.249 foxr 1346: &Reply($client, "$ulsout\n", $userinput); # This supports debug logging.
1.239 foxr 1347:
1348: return 1;
1349:
1350: }
1351: ®ister_handler("ls", \&ls_handler, 0, 1, 0);
1352:
1.280 matthew 1353: #
1354: # Please also see the ls_handler, which this routine obosolets.
1355: # ls2_handler differs from ls_handler in that it escapes its return
1356: # values before concatenating them together with ':'s.
1357: #
1358: # ls2 - list the contents of a directory. For each file in the
1359: # selected directory the filename followed by the full output of
1360: # the stat function is returned. The returned info for each
1361: # file are separated by ':'. The stat fields are separated by &'s.
1362: # Parameters:
1363: # $cmd - The command that dispatched us (ls).
1364: # $ulsdir - The directory path to list... I'm not sure what this
1365: # is relative as things like ls:. return e.g.
1366: # no_such_dir.
1367: # $client - Socket open on the client.
1368: # Returns:
1369: # 1 - indicating that the daemon should not disconnect.
1370: # Side Effects:
1371: # The reply is written to $client.
1372: #
1373: sub ls2_handler {
1374: my ($cmd, $ulsdir, $client) = @_;
1375:
1376: my $userinput = "$cmd:$ulsdir";
1377:
1378: my $obs;
1379: my $rights;
1380: my $ulsout='';
1381: my $ulsfn;
1382: if (-e $ulsdir) {
1383: if(-d $ulsdir) {
1384: if (opendir(LSDIR,$ulsdir)) {
1385: while ($ulsfn=readdir(LSDIR)) {
1.291 albertel 1386: undef($obs);
1387: undef($rights);
1.280 matthew 1388: my @ulsstats=stat($ulsdir.'/'.$ulsfn);
1389: #We do some obsolete checking here
1390: if(-e $ulsdir.'/'.$ulsfn.".meta") {
1391: open(FILE, $ulsdir.'/'.$ulsfn.".meta");
1392: my @obsolete=<FILE>;
1393: foreach my $obsolete (@obsolete) {
1.301 www 1394: if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
1.280 matthew 1395: if($obsolete =~ m|(<copyright>)(default)|) {
1396: $rights = 1;
1397: }
1398: }
1399: }
1400: my $tmp = $ulsfn.'&'.join('&',@ulsstats);
1401: if ($obs eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
1402: if ($rights eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
1403: $ulsout.= &escape($tmp).':';
1404: }
1405: closedir(LSDIR);
1406: }
1407: } else {
1408: my @ulsstats=stat($ulsdir);
1409: $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
1410: }
1411: } else {
1412: $ulsout='no_such_dir';
1413: }
1414: if ($ulsout eq '') { $ulsout='empty'; }
1415: &Reply($client, "$ulsout\n", $userinput); # This supports debug logging.
1416: return 1;
1417: }
1418: ®ister_handler("ls2", \&ls2_handler, 0, 1, 0);
1419:
1.218 foxr 1420: # Process a reinit request. Reinit requests that either
1421: # lonc or lond be reinitialized so that an updated
1422: # host.tab or domain.tab can be processed.
1423: #
1424: # Parameters:
1425: # $cmd - the actual keyword that invoked us.
1426: # $tail - the tail of the request that invoked us.
1427: # $client - File descriptor connected to the client
1428: # Returns:
1429: # 1 - Ok to continue processing.
1430: # 0 - Program should exit
1431: # Implicit output:
1432: # a reply is sent to the client.
1433: #
1434: sub reinit_process_handler {
1435: my ($cmd, $tail, $client) = @_;
1436:
1437: my $userinput = "$cmd:$tail";
1438:
1439: my $cert = &GetCertificate($userinput);
1440: if(&ValidManager($cert)) {
1441: chomp($userinput);
1442: my $reply = &ReinitProcess($userinput);
1443: &Reply( $client, "$reply\n", $userinput);
1444: } else {
1445: &Failure( $client, "refused\n", $userinput);
1446: }
1447: return 1;
1448: }
1449: ®ister_handler("reinit", \&reinit_process_handler, 1, 0, 1);
1450:
1451: # Process the editing script for a table edit operation.
1452: # the editing operation must be encrypted and requested by
1453: # a manager host.
1454: #
1455: # Parameters:
1456: # $cmd - the actual keyword that invoked us.
1457: # $tail - the tail of the request that invoked us.
1458: # $client - File descriptor connected to the client
1459: # Returns:
1460: # 1 - Ok to continue processing.
1461: # 0 - Program should exit
1462: # Implicit output:
1463: # a reply is sent to the client.
1464: #
1465: sub edit_table_handler {
1466: my ($command, $tail, $client) = @_;
1467:
1468: my $userinput = "$command:$tail";
1469:
1470: my $cert = &GetCertificate($userinput);
1471: if(&ValidManager($cert)) {
1472: my($filetype, $script) = split(/:/, $tail);
1473: if (($filetype eq "hosts") ||
1474: ($filetype eq "domain")) {
1475: if($script ne "") {
1476: &Reply($client, # BUGBUG - EditFile
1477: &EditFile($userinput), # could fail.
1478: $userinput);
1479: } else {
1480: &Failure($client,"refused\n",$userinput);
1481: }
1482: } else {
1483: &Failure($client,"refused\n",$userinput);
1484: }
1485: } else {
1486: &Failure($client,"refused\n",$userinput);
1487: }
1488: return 1;
1489: }
1.263 albertel 1490: ®ister_handler("edit", \&edit_table_handler, 1, 0, 1);
1.218 foxr 1491:
1.220 foxr 1492: #
1493: # Authenticate a user against the LonCAPA authentication
1494: # database. Note that there are several authentication
1495: # possibilities:
1496: # - unix - The user can be authenticated against the unix
1497: # password file.
1498: # - internal - The user can be authenticated against a purely
1499: # internal per user password file.
1500: # - kerberos - The user can be authenticated against either a kerb4 or kerb5
1501: # ticket granting authority.
1502: # - user - The person tailoring LonCAPA can supply a user authentication
1503: # mechanism that is per system.
1504: #
1505: # Parameters:
1506: # $cmd - The command that got us here.
1507: # $tail - Tail of the command (remaining parameters).
1508: # $client - File descriptor connected to client.
1509: # Returns
1510: # 0 - Requested to exit, caller should shut down.
1511: # 1 - Continue processing.
1512: # Implicit inputs:
1513: # The authentication systems describe above have their own forms of implicit
1514: # input into the authentication process that are described above.
1515: #
1516: sub authenticate_handler {
1517: my ($cmd, $tail, $client) = @_;
1518:
1519:
1520: # Regenerate the full input line
1521:
1522: my $userinput = $cmd.":".$tail;
1523:
1524: # udom - User's domain.
1525: # uname - Username.
1526: # upass - User's password.
1527:
1528: my ($udom,$uname,$upass)=split(/:/,$tail);
1529: &Debug(" Authenticate domain = $udom, user = $uname, password = $upass");
1530: chomp($upass);
1531: $upass=&unescape($upass);
1532:
1533: my $pwdcorrect = &validate_user($udom, $uname, $upass);
1534: if($pwdcorrect) {
1535: &Reply( $client, "authorized\n", $userinput);
1536: #
1537: # Bad credentials: Failed to authorize
1538: #
1539: } else {
1540: &Failure( $client, "non_authorized\n", $userinput);
1541: }
1542:
1543: return 1;
1544: }
1.263 albertel 1545: ®ister_handler("auth", \&authenticate_handler, 1, 1, 0);
1.214 foxr 1546:
1.222 foxr 1547: #
1548: # Change a user's password. Note that this function is complicated by
1549: # the fact that a user may be authenticated in more than one way:
1550: # At present, we are not able to change the password for all types of
1551: # authentication methods. Only for:
1552: # unix - unix password or shadow passoword style authentication.
1553: # local - Locally written authentication mechanism.
1554: # For now, kerb4 and kerb5 password changes are not supported and result
1555: # in an error.
1556: # FUTURE WORK:
1557: # Support kerberos passwd changes?
1558: # Parameters:
1559: # $cmd - The command that got us here.
1560: # $tail - Tail of the command (remaining parameters).
1561: # $client - File descriptor connected to client.
1562: # Returns
1563: # 0 - Requested to exit, caller should shut down.
1564: # 1 - Continue processing.
1565: # Implicit inputs:
1566: # The authentication systems describe above have their own forms of implicit
1567: # input into the authentication process that are described above.
1568: sub change_password_handler {
1569: my ($cmd, $tail, $client) = @_;
1570:
1571: my $userinput = $cmd.":".$tail; # Reconstruct client's string.
1572:
1573: #
1574: # udom - user's domain.
1575: # uname - Username.
1576: # upass - Current password.
1577: # npass - New password.
1.346 raeburn 1578: # context - Context in which this was called
1579: # (preferences or reset_by_email).
1.222 foxr 1580:
1.346 raeburn 1581: my ($udom,$uname,$upass,$npass,$context)=split(/:/,$tail);
1.222 foxr 1582:
1583: $upass=&unescape($upass);
1584: $npass=&unescape($npass);
1585: &Debug("Trying to change password for $uname");
1586:
1587: # First require that the user can be authenticated with their
1.346 raeburn 1588: # old password unless context was 'reset_by_email':
1589:
1590: my $validated;
1591: if ($context eq 'reset_by_email') {
1592: $validated = 1;
1593: } else {
1594: $validated = &validate_user($udom, $uname, $upass);
1595: }
1.222 foxr 1596: if($validated) {
1597: my $realpasswd = &get_auth_type($udom, $uname); # Defined since authd.
1598:
1599: my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
1600: if ($howpwd eq 'internal') {
1601: &Debug("internal auth");
1602: my $salt=time;
1603: $salt=substr($salt,6,2);
1604: my $ncpass=crypt($npass,$salt);
1605: if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
1606: &logthis("Result of password change for "
1607: ."$uname: pwchange_success");
1608: &Reply($client, "ok\n", $userinput);
1609: } else {
1610: &logthis("Unable to open $uname passwd "
1611: ."to change password");
1612: &Failure( $client, "non_authorized\n",$userinput);
1613: }
1.346 raeburn 1614: } elsif ($howpwd eq 'unix' && $context ne 'reset_by_email') {
1.287 foxr 1615: my $result = &change_unix_password($uname, $npass);
1.222 foxr 1616: &logthis("Result of password change for $uname: ".
1.287 foxr 1617: $result);
1.222 foxr 1618: &Reply($client, "$result\n", $userinput);
1619: } else {
1620: # this just means that the current password mode is not
1621: # one we know how to change (e.g the kerberos auth modes or
1622: # locally written auth handler).
1623: #
1624: &Failure( $client, "auth_mode_error\n", $userinput);
1625: }
1626:
1.224 foxr 1627: } else {
1.222 foxr 1628: &Failure( $client, "non_authorized\n", $userinput);
1629: }
1630:
1631: return 1;
1632: }
1.263 albertel 1633: ®ister_handler("passwd", \&change_password_handler, 1, 1, 0);
1.222 foxr 1634:
1.225 foxr 1635: #
1636: # Create a new user. User in this case means a lon-capa user.
1637: # The user must either already exist in some authentication realm
1638: # like kerberos or the /etc/passwd. If not, a user completely local to
1639: # this loncapa system is created.
1640: #
1641: # Parameters:
1642: # $cmd - The command that got us here.
1643: # $tail - Tail of the command (remaining parameters).
1644: # $client - File descriptor connected to client.
1645: # Returns
1646: # 0 - Requested to exit, caller should shut down.
1647: # 1 - Continue processing.
1648: # Implicit inputs:
1649: # The authentication systems describe above have their own forms of implicit
1650: # input into the authentication process that are described above.
1651: sub add_user_handler {
1652:
1653: my ($cmd, $tail, $client) = @_;
1654:
1655:
1656: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1657: my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
1658:
1659: &Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);
1660:
1661:
1662: if($udom eq $currentdomainid) { # Reject new users for other domains...
1663:
1664: my $oldumask=umask(0077);
1665: chomp($npass);
1666: $npass=&unescape($npass);
1667: my $passfilename = &password_path($udom, $uname);
1668: &Debug("Password file created will be:".$passfilename);
1669: if (-e $passfilename) {
1670: &Failure( $client, "already_exists\n", $userinput);
1671: } else {
1672: my $fperror='';
1.264 albertel 1673: if (!&mkpath($passfilename)) {
1674: $fperror="error: ".($!+0)." mkdir failed while attempting "
1675: ."makeuser";
1.225 foxr 1676: }
1677: unless ($fperror) {
1678: my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);
1679: &Reply($client, $result, $userinput); #BUGBUG - could be fail
1680: } else {
1681: &Failure($client, "$fperror\n", $userinput);
1682: }
1683: }
1684: umask($oldumask);
1685: } else {
1686: &Failure($client, "not_right_domain\n",
1687: $userinput); # Even if we are multihomed.
1688:
1689: }
1690: return 1;
1691:
1692: }
1693: ®ister_handler("makeuser", \&add_user_handler, 1, 1, 0);
1694:
1695: #
1696: # Change the authentication method of a user. Note that this may
1697: # also implicitly change the user's password if, for example, the user is
1698: # joining an existing authentication realm. Known authentication realms at
1699: # this time are:
1700: # internal - Purely internal password file (only loncapa knows this user)
1701: # local - Institutionally written authentication module.
1702: # unix - Unix user (/etc/passwd with or without /etc/shadow).
1703: # kerb4 - kerberos version 4
1704: # kerb5 - kerberos version 5
1705: #
1706: # Parameters:
1707: # $cmd - The command that got us here.
1708: # $tail - Tail of the command (remaining parameters).
1709: # $client - File descriptor connected to client.
1710: # Returns
1711: # 0 - Requested to exit, caller should shut down.
1712: # 1 - Continue processing.
1713: # Implicit inputs:
1714: # The authentication systems describe above have their own forms of implicit
1715: # input into the authentication process that are described above.
1.287 foxr 1716: # NOTE:
1717: # This is also used to change the authentication credential values (e.g. passwd).
1718: #
1.225 foxr 1719: #
1720: sub change_authentication_handler {
1721:
1722: my ($cmd, $tail, $client) = @_;
1723:
1724: my $userinput = "$cmd:$tail"; # Reconstruct user input.
1725:
1726: my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
1727: &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
1728: if ($udom ne $currentdomainid) {
1729: &Failure( $client, "not_right_domain\n", $client);
1730: } else {
1731:
1732: chomp($npass);
1733:
1734: $npass=&unescape($npass);
1.261 foxr 1735: my $oldauth = &get_auth_type($udom, $uname); # Get old auth info.
1.225 foxr 1736: my $passfilename = &password_path($udom, $uname);
1737: if ($passfilename) { # Not allowed to create a new user!!
1.287 foxr 1738: # If just changing the unix passwd. need to arrange to run
1739: # passwd since otherwise make_passwd_file will run
1740: # lcuseradd which fails if an account already exists
1741: # (to prevent an unscrupulous LONCAPA admin from stealing
1742: # an existing account by overwriting it as a LonCAPA account).
1743:
1744: if(($oldauth =~/^unix/) && ($umode eq "unix")) {
1745: my $result = &change_unix_password($uname, $npass);
1746: &logthis("Result of password change for $uname: ".$result);
1747: if ($result eq "ok") {
1748: &Reply($client, "$result\n")
1.288 albertel 1749: } else {
1.287 foxr 1750: &Failure($client, "$result\n");
1751: }
1.288 albertel 1752: } else {
1.287 foxr 1753: my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);
1754: #
1755: # If the current auth mode is internal, and the old auth mode was
1756: # unix, or krb*, and the user is an author for this domain,
1757: # re-run manage_permissions for that role in order to be able
1758: # to take ownership of the construction space back to www:www
1759: #
1760:
1761:
1762: if( (($oldauth =~ /^unix/) && ($umode eq "internal")) ||
1763: (($oldauth =~ /^internal/) && ($umode eq "unix")) ) {
1764: if(&is_author($udom, $uname)) {
1765: &Debug(" Need to manage author permissions...");
1766: &manage_permissions("/$udom/_au", $udom, $uname, "$umode:");
1767: }
1.261 foxr 1768: }
1.287 foxr 1769: &Reply($client, $result, $userinput);
1.261 foxr 1770: }
1771:
1772:
1.225 foxr 1773: } else {
1.251 foxr 1774: &Failure($client, "non_authorized\n", $userinput); # Fail the user now.
1.225 foxr 1775: }
1776: }
1777: return 1;
1778: }
1779: ®ister_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
1780:
1781: #
1782: # Determines if this is the home server for a user. The home server
1783: # for a user will have his/her lon-capa passwd file. Therefore all we need
1784: # to do is determine if this file exists.
1785: #
1786: # Parameters:
1787: # $cmd - The command that got us here.
1788: # $tail - Tail of the command (remaining parameters).
1789: # $client - File descriptor connected to client.
1790: # Returns
1791: # 0 - Requested to exit, caller should shut down.
1792: # 1 - Continue processing.
1793: # Implicit inputs:
1794: # The authentication systems describe above have their own forms of implicit
1795: # input into the authentication process that are described above.
1796: #
1797: sub is_home_handler {
1798: my ($cmd, $tail, $client) = @_;
1799:
1800: my $userinput = "$cmd:$tail";
1801:
1802: my ($udom,$uname)=split(/:/,$tail);
1803: chomp($uname);
1804: my $passfile = &password_filename($udom, $uname);
1805: if($passfile) {
1806: &Reply( $client, "found\n", $userinput);
1807: } else {
1808: &Failure($client, "not_found\n", $userinput);
1809: }
1810: return 1;
1811: }
1812: ®ister_handler("home", \&is_home_handler, 0,1,0);
1813:
1814: #
1815: # Process an update request for a resource?? I think what's going on here is
1816: # that a resource has been modified that we hold a subscription to.
1817: # If the resource is not local, then we must update, or at least invalidate our
1818: # cached copy of the resource.
1819: # FUTURE WORK:
1820: # I need to look at this logic carefully. My druthers would be to follow
1821: # typical caching logic, and simple invalidate the cache, drop any subscription
1822: # an let the next fetch start the ball rolling again... however that may
1823: # actually be more difficult than it looks given the complex web of
1824: # proxy servers.
1825: # Parameters:
1826: # $cmd - The command that got us here.
1827: # $tail - Tail of the command (remaining parameters).
1828: # $client - File descriptor connected to client.
1829: # Returns
1830: # 0 - Requested to exit, caller should shut down.
1831: # 1 - Continue processing.
1832: # Implicit inputs:
1833: # The authentication systems describe above have their own forms of implicit
1834: # input into the authentication process that are described above.
1835: #
1836: sub update_resource_handler {
1837:
1838: my ($cmd, $tail, $client) = @_;
1839:
1840: my $userinput = "$cmd:$tail";
1841:
1842: my $fname= $tail; # This allows interactive testing
1843:
1844:
1845: my $ownership=ishome($fname);
1846: if ($ownership eq 'not_owner') {
1847: if (-e $fname) {
1848: my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
1849: $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
1850: my $now=time;
1851: my $since=$now-$atime;
1852: if ($since>$perlvar{'lonExpire'}) {
1853: my $reply=&reply("unsub:$fname","$clientname");
1.308 albertel 1854: &devalidate_meta_cache($fname);
1.225 foxr 1855: unlink("$fname");
1.334 albertel 1856: unlink("$fname.meta");
1.225 foxr 1857: } else {
1858: my $transname="$fname.in.transfer";
1859: my $remoteurl=&reply("sub:$fname","$clientname");
1860: my $response;
1861: alarm(120);
1862: {
1863: my $ua=new LWP::UserAgent;
1864: my $request=new HTTP::Request('GET',"$remoteurl");
1865: $response=$ua->request($request,$transname);
1866: }
1867: alarm(0);
1868: if ($response->is_error()) {
1869: unlink($transname);
1870: my $message=$response->status_line;
1871: &logthis("LWP GET: $message for $fname ($remoteurl)");
1872: } else {
1873: if ($remoteurl!~/\.meta$/) {
1874: alarm(120);
1875: {
1876: my $ua=new LWP::UserAgent;
1877: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1878: my $mresponse=$ua->request($mrequest,$fname.'.meta');
1879: if ($mresponse->is_error()) {
1880: unlink($fname.'.meta');
1881: }
1882: }
1883: alarm(0);
1884: }
1885: rename($transname,$fname);
1.308 albertel 1886: &devalidate_meta_cache($fname);
1.225 foxr 1887: }
1888: }
1889: &Reply( $client, "ok\n", $userinput);
1890: } else {
1891: &Failure($client, "not_found\n", $userinput);
1892: }
1893: } else {
1894: &Failure($client, "rejected\n", $userinput);
1895: }
1896: return 1;
1897: }
1898: ®ister_handler("update", \&update_resource_handler, 0 ,1, 0);
1899:
1.308 albertel 1900: sub devalidate_meta_cache {
1901: my ($url) = @_;
1902: use Cache::Memcached;
1903: my $memcache = new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
1904: $url = &declutter($url);
1905: $url =~ s-\.meta$--;
1906: my $id = &escape('meta:'.$url);
1907: $memcache->delete($id);
1908: }
1909:
1910: sub declutter {
1911: my $thisfn=shift;
1912: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1913: $thisfn=~s/^\///;
1914: $thisfn=~s|^adm/wrapper/||;
1915: $thisfn=~s|^adm/coursedocs/showdoc/||;
1916: $thisfn=~s/^res\///;
1917: $thisfn=~s/\?.+$//;
1918: return $thisfn;
1919: }
1.225 foxr 1920: #
1.226 foxr 1921: # Fetch a user file from a remote server to the user's home directory
1922: # userfiles subdir.
1.225 foxr 1923: # Parameters:
1924: # $cmd - The command that got us here.
1925: # $tail - Tail of the command (remaining parameters).
1926: # $client - File descriptor connected to client.
1927: # Returns
1928: # 0 - Requested to exit, caller should shut down.
1929: # 1 - Continue processing.
1930: #
1931: sub fetch_user_file_handler {
1932:
1933: my ($cmd, $tail, $client) = @_;
1934:
1935: my $userinput = "$cmd:$tail";
1936: my $fname = $tail;
1.232 foxr 1937: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
1.225 foxr 1938: my $udir=&propath($udom,$uname).'/userfiles';
1939: unless (-e $udir) {
1940: mkdir($udir,0770);
1941: }
1.232 foxr 1942: Debug("fetch user file for $fname");
1.225 foxr 1943: if (-e $udir) {
1944: $ufile=~s/^[\.\~]+//;
1.232 foxr 1945:
1946: # IF necessary, create the path right down to the file.
1947: # Note that any regular files in the way of this path are
1948: # wiped out to deal with some earlier folly of mine.
1949:
1.267 raeburn 1950: if (!&mkpath($udir.'/'.$ufile)) {
1.264 albertel 1951: &Failure($client, "unable_to_create\n", $userinput);
1.232 foxr 1952: }
1953:
1.225 foxr 1954: my $destname=$udir.'/'.$ufile;
1955: my $transname=$udir.'/'.$ufile.'.in.transit';
1956: my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;
1957: my $response;
1.232 foxr 1958: Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
1.225 foxr 1959: alarm(120);
1960: {
1961: my $ua=new LWP::UserAgent;
1962: my $request=new HTTP::Request('GET',"$remoteurl");
1963: $response=$ua->request($request,$transname);
1964: }
1965: alarm(0);
1966: if ($response->is_error()) {
1967: unlink($transname);
1968: my $message=$response->status_line;
1969: &logthis("LWP GET: $message for $fname ($remoteurl)");
1970: &Failure($client, "failed\n", $userinput);
1971: } else {
1.232 foxr 1972: Debug("Renaming $transname to $destname");
1.225 foxr 1973: if (!rename($transname,$destname)) {
1974: &logthis("Unable to move $transname to $destname");
1975: unlink($transname);
1976: &Failure($client, "failed\n", $userinput);
1977: } else {
1978: &Reply($client, "ok\n", $userinput);
1979: }
1980: }
1981: } else {
1982: &Failure($client, "not_home\n", $userinput);
1983: }
1984: return 1;
1985: }
1986: ®ister_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
1987:
1.226 foxr 1988: #
1989: # Remove a file from a user's home directory userfiles subdirectory.
1990: # Parameters:
1991: # cmd - the Lond request keyword that got us here.
1992: # tail - the part of the command past the keyword.
1993: # client- File descriptor connected with the client.
1994: #
1995: # Returns:
1996: # 1 - Continue processing.
1997: sub remove_user_file_handler {
1998: my ($cmd, $tail, $client) = @_;
1999:
2000: my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
2001:
2002: my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
2003: if ($ufile =~m|/\.\./|) {
2004: # any files paths with /../ in them refuse
2005: # to deal with
2006: &Failure($client, "refused\n", "$cmd:$tail");
2007: } else {
2008: my $udir = &propath($udom,$uname);
2009: if (-e $udir) {
2010: my $file=$udir.'/userfiles/'.$ufile;
2011: if (-e $file) {
1.253 foxr 2012: #
2013: # If the file is a regular file unlink is fine...
2014: # However it's possible the client wants a dir.
2015: # removed, in which case rmdir is more approprate:
2016: #
1.240 banghart 2017: if (-f $file){
1.241 albertel 2018: unlink($file);
2019: } elsif(-d $file) {
2020: rmdir($file);
1.240 banghart 2021: }
1.226 foxr 2022: if (-e $file) {
1.253 foxr 2023: # File is still there after we deleted it ?!?
2024:
1.226 foxr 2025: &Failure($client, "failed\n", "$cmd:$tail");
2026: } else {
2027: &Reply($client, "ok\n", "$cmd:$tail");
2028: }
2029: } else {
2030: &Failure($client, "not_found\n", "$cmd:$tail");
2031: }
2032: } else {
2033: &Failure($client, "not_home\n", "$cmd:$tail");
2034: }
2035: }
2036: return 1;
2037: }
2038: ®ister_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
2039:
1.236 albertel 2040: #
2041: # make a directory in a user's home directory userfiles subdirectory.
2042: # Parameters:
2043: # cmd - the Lond request keyword that got us here.
2044: # tail - the part of the command past the keyword.
2045: # client- File descriptor connected with the client.
2046: #
2047: # Returns:
2048: # 1 - Continue processing.
2049: sub mkdir_user_file_handler {
2050: my ($cmd, $tail, $client) = @_;
2051:
2052: my ($dir) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
2053: $dir=&unescape($dir);
2054: my ($udom,$uname,$ufile) = ($dir =~ m|^([^/]+)/([^/]+)/(.+)$|);
2055: if ($ufile =~m|/\.\./|) {
2056: # any files paths with /../ in them refuse
2057: # to deal with
2058: &Failure($client, "refused\n", "$cmd:$tail");
2059: } else {
2060: my $udir = &propath($udom,$uname);
2061: if (-e $udir) {
1.264 albertel 2062: my $newdir=$udir.'/userfiles/'.$ufile.'/';
2063: if (!&mkpath($newdir)) {
2064: &Failure($client, "failed\n", "$cmd:$tail");
1.236 albertel 2065: }
1.264 albertel 2066: &Reply($client, "ok\n", "$cmd:$tail");
1.236 albertel 2067: } else {
2068: &Failure($client, "not_home\n", "$cmd:$tail");
2069: }
2070: }
2071: return 1;
2072: }
2073: ®ister_handler("mkdiruserfile", \&mkdir_user_file_handler, 0,1,0);
2074:
1.237 albertel 2075: #
2076: # rename a file in a user's home directory userfiles subdirectory.
2077: # Parameters:
2078: # cmd - the Lond request keyword that got us here.
2079: # tail - the part of the command past the keyword.
2080: # client- File descriptor connected with the client.
2081: #
2082: # Returns:
2083: # 1 - Continue processing.
2084: sub rename_user_file_handler {
2085: my ($cmd, $tail, $client) = @_;
2086:
2087: my ($udom,$uname,$old,$new) = split(/:/, $tail);
2088: $old=&unescape($old);
2089: $new=&unescape($new);
2090: if ($new =~m|/\.\./| || $old =~m|/\.\./|) {
2091: # any files paths with /../ in them refuse to deal with
2092: &Failure($client, "refused\n", "$cmd:$tail");
2093: } else {
2094: my $udir = &propath($udom,$uname);
2095: if (-e $udir) {
2096: my $oldfile=$udir.'/userfiles/'.$old;
2097: my $newfile=$udir.'/userfiles/'.$new;
2098: if (-e $newfile) {
2099: &Failure($client, "exists\n", "$cmd:$tail");
2100: } elsif (! -e $oldfile) {
2101: &Failure($client, "not_found\n", "$cmd:$tail");
2102: } else {
2103: if (!rename($oldfile,$newfile)) {
2104: &Failure($client, "failed\n", "$cmd:$tail");
2105: } else {
2106: &Reply($client, "ok\n", "$cmd:$tail");
2107: }
2108: }
2109: } else {
2110: &Failure($client, "not_home\n", "$cmd:$tail");
2111: }
2112: }
2113: return 1;
2114: }
2115: ®ister_handler("renameuserfile", \&rename_user_file_handler, 0,1,0);
2116:
1.227 foxr 2117: #
1.263 albertel 2118: # Authenticate access to a user file by checking that the token the user's
2119: # passed also exists in their session file
1.227 foxr 2120: #
2121: # Parameters:
2122: # cmd - The request keyword that dispatched to tus.
2123: # tail - The tail of the request (colon separated parameters).
2124: # client - Filehandle open on the client.
2125: # Return:
2126: # 1.
2127: sub token_auth_user_file_handler {
2128: my ($cmd, $tail, $client) = @_;
2129:
2130: my ($fname, $session) = split(/:/, $tail);
2131:
2132: chomp($session);
1.251 foxr 2133: my $reply="non_auth\n";
1.343 albertel 2134: my $file = $perlvar{'lonIDsDir'}.'/'.$session.'.id';
2135: if (open(ENVIN,"$file")) {
1.332 albertel 2136: flock(ENVIN,LOCK_SH);
1.343 albertel 2137: tie(my %disk_env,'GDBM_File',"$file",&GDBM_READER(),0640);
2138: if (exists($disk_env{"userfile.$fname"})) {
2139: $reply="ok\n";
2140: } else {
2141: foreach my $envname (keys(%disk_env)) {
2142: if ($envname=~ m|^userfile\.\Q$fname\E|) {
2143: $reply="ok\n";
2144: last;
2145: }
2146: }
1.227 foxr 2147: }
1.343 albertel 2148: untie(%disk_env);
1.227 foxr 2149: close(ENVIN);
1.251 foxr 2150: &Reply($client, $reply, "$cmd:$tail");
1.227 foxr 2151: } else {
2152: &Failure($client, "invalid_token\n", "$cmd:$tail");
2153: }
2154: return 1;
2155:
2156: }
2157: ®ister_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
1.229 foxr 2158:
2159: #
2160: # Unsubscribe from a resource.
2161: #
2162: # Parameters:
2163: # $cmd - The command that got us here.
2164: # $tail - Tail of the command (remaining parameters).
2165: # $client - File descriptor connected to client.
2166: # Returns
2167: # 0 - Requested to exit, caller should shut down.
2168: # 1 - Continue processing.
2169: #
2170: sub unsubscribe_handler {
2171: my ($cmd, $tail, $client) = @_;
2172:
2173: my $userinput= "$cmd:$tail";
2174:
2175: my ($fname) = split(/:/,$tail); # Split in case there's extrs.
2176:
2177: &Debug("Unsubscribing $fname");
2178: if (-e $fname) {
2179: &Debug("Exists");
2180: &Reply($client, &unsub($fname,$clientip), $userinput);
2181: } else {
2182: &Failure($client, "not_found\n", $userinput);
2183: }
2184: return 1;
2185: }
2186: ®ister_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
1.263 albertel 2187:
1.230 foxr 2188: # Subscribe to a resource
2189: #
2190: # Parameters:
2191: # $cmd - The command that got us here.
2192: # $tail - Tail of the command (remaining parameters).
2193: # $client - File descriptor connected to client.
2194: # Returns
2195: # 0 - Requested to exit, caller should shut down.
2196: # 1 - Continue processing.
2197: #
2198: sub subscribe_handler {
2199: my ($cmd, $tail, $client)= @_;
2200:
2201: my $userinput = "$cmd:$tail";
2202:
2203: &Reply( $client, &subscribe($userinput,$clientip), $userinput);
2204:
2205: return 1;
2206: }
2207: ®ister_handler("sub", \&subscribe_handler, 0, 1, 0);
2208:
2209: #
2210: # Determine the version of a resource (?) Or is it return
2211: # the top version of the resource? Not yet clear from the
2212: # code in currentversion.
2213: #
2214: # Parameters:
2215: # $cmd - The command that got us here.
2216: # $tail - Tail of the command (remaining parameters).
2217: # $client - File descriptor connected to client.
2218: # Returns
2219: # 0 - Requested to exit, caller should shut down.
2220: # 1 - Continue processing.
2221: #
2222: sub current_version_handler {
2223: my ($cmd, $tail, $client) = @_;
2224:
2225: my $userinput= "$cmd:$tail";
2226:
2227: my $fname = $tail;
2228: &Reply( $client, ¤tversion($fname)."\n", $userinput);
2229: return 1;
2230:
2231: }
2232: ®ister_handler("currentversion", \¤t_version_handler, 0, 1, 0);
2233:
2234: # Make an entry in a user's activity log.
2235: #
2236: # Parameters:
2237: # $cmd - The command that got us here.
2238: # $tail - Tail of the command (remaining parameters).
2239: # $client - File descriptor connected to client.
2240: # Returns
2241: # 0 - Requested to exit, caller should shut down.
2242: # 1 - Continue processing.
2243: #
2244: sub activity_log_handler {
2245: my ($cmd, $tail, $client) = @_;
2246:
2247:
2248: my $userinput= "$cmd:$tail";
2249:
2250: my ($udom,$uname,$what)=split(/:/,$tail);
2251: chomp($what);
2252: my $proname=&propath($udom,$uname);
2253: my $now=time;
2254: my $hfh;
2255: if ($hfh=IO::File->new(">>$proname/activity.log")) {
2256: print $hfh "$now:$clientname:$what\n";
2257: &Reply( $client, "ok\n", $userinput);
2258: } else {
2259: &Failure($client, "error: ".($!+0)." IO::File->new Failed "
2260: ."while attempting log\n",
2261: $userinput);
2262: }
2263:
2264: return 1;
2265: }
1.263 albertel 2266: ®ister_handler("log", \&activity_log_handler, 0, 1, 0);
1.230 foxr 2267:
2268: #
2269: # Put a namespace entry in a user profile hash.
2270: # My druthers would be for this to be an encrypted interaction too.
2271: # anything that might be an inadvertent covert channel about either
2272: # user authentication or user personal information....
2273: #
2274: # Parameters:
2275: # $cmd - The command that got us here.
2276: # $tail - Tail of the command (remaining parameters).
2277: # $client - File descriptor connected to client.
2278: # Returns
2279: # 0 - Requested to exit, caller should shut down.
2280: # 1 - Continue processing.
2281: #
2282: sub put_user_profile_entry {
2283: my ($cmd, $tail, $client) = @_;
1.229 foxr 2284:
1.230 foxr 2285: my $userinput = "$cmd:$tail";
2286:
1.242 raeburn 2287: my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
1.230 foxr 2288: if ($namespace ne 'roles') {
2289: chomp($what);
2290: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2291: &GDBM_WRCREAT(),"P",$what);
2292: if($hashref) {
2293: my @pairs=split(/\&/,$what);
2294: foreach my $pair (@pairs) {
2295: my ($key,$value)=split(/=/,$pair);
2296: $hashref->{$key}=$value;
2297: }
1.311 albertel 2298: if (&untie_user_hash($hashref)) {
1.230 foxr 2299: &Reply( $client, "ok\n", $userinput);
2300: } else {
2301: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2302: "while attempting put\n",
2303: $userinput);
2304: }
2305: } else {
1.316 albertel 2306: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
1.230 foxr 2307: "while attempting put\n", $userinput);
2308: }
2309: } else {
2310: &Failure( $client, "refused\n", $userinput);
2311: }
2312:
2313: return 1;
2314: }
2315: ®ister_handler("put", \&put_user_profile_entry, 0, 1, 0);
2316:
1.283 albertel 2317: # Put a piece of new data in hash, returns error if entry already exists
2318: # Parameters:
2319: # $cmd - The command that got us here.
2320: # $tail - Tail of the command (remaining parameters).
2321: # $client - File descriptor connected to client.
2322: # Returns
2323: # 0 - Requested to exit, caller should shut down.
2324: # 1 - Continue processing.
2325: #
2326: sub newput_user_profile_entry {
2327: my ($cmd, $tail, $client) = @_;
2328:
2329: my $userinput = "$cmd:$tail";
2330:
2331: my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
2332: if ($namespace eq 'roles') {
2333: &Failure( $client, "refused\n", $userinput);
2334: return 1;
2335: }
2336:
2337: chomp($what);
2338:
2339: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2340: &GDBM_WRCREAT(),"N",$what);
2341: if(!$hashref) {
1.316 albertel 2342: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
1.283 albertel 2343: "while attempting put\n", $userinput);
2344: return 1;
2345: }
2346:
2347: my @pairs=split(/\&/,$what);
2348: foreach my $pair (@pairs) {
2349: my ($key,$value)=split(/=/,$pair);
2350: if (exists($hashref->{$key})) {
2351: &Failure($client, "key_exists: ".$key."\n",$userinput);
2352: return 1;
2353: }
2354: }
2355:
2356: foreach my $pair (@pairs) {
2357: my ($key,$value)=split(/=/,$pair);
2358: $hashref->{$key}=$value;
2359: }
2360:
1.311 albertel 2361: if (&untie_user_hash($hashref)) {
1.283 albertel 2362: &Reply( $client, "ok\n", $userinput);
2363: } else {
2364: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2365: "while attempting put\n",
2366: $userinput);
2367: }
2368: return 1;
2369: }
2370: ®ister_handler("newput", \&newput_user_profile_entry, 0, 1, 0);
2371:
1.230 foxr 2372: #
2373: # Increment a profile entry in the user history file.
2374: # The history contains keyword value pairs. In this case,
2375: # The value itself is a pair of numbers. The first, the current value
2376: # the second an increment that this function applies to the current
2377: # value.
2378: #
2379: # Parameters:
2380: # $cmd - The command that got us here.
2381: # $tail - Tail of the command (remaining parameters).
2382: # $client - File descriptor connected to client.
2383: # Returns
2384: # 0 - Requested to exit, caller should shut down.
2385: # 1 - Continue processing.
2386: #
2387: sub increment_user_value_handler {
2388: my ($cmd, $tail, $client) = @_;
2389:
2390: my $userinput = "$cmd:$tail";
2391:
2392: my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
2393: if ($namespace ne 'roles') {
2394: chomp($what);
2395: my $hashref = &tie_user_hash($udom, $uname,
2396: $namespace, &GDBM_WRCREAT(),
2397: "P",$what);
2398: if ($hashref) {
2399: my @pairs=split(/\&/,$what);
2400: foreach my $pair (@pairs) {
2401: my ($key,$value)=split(/=/,$pair);
1.284 raeburn 2402: $value = &unescape($value);
1.230 foxr 2403: # We could check that we have a number...
2404: if (! defined($value) || $value eq '') {
2405: $value = 1;
2406: }
2407: $hashref->{$key}+=$value;
1.284 raeburn 2408: if ($namespace eq 'nohist_resourcetracker') {
2409: if ($hashref->{$key} < 0) {
2410: $hashref->{$key} = 0;
2411: }
2412: }
1.230 foxr 2413: }
1.311 albertel 2414: if (&untie_user_hash($hashref)) {
1.230 foxr 2415: &Reply( $client, "ok\n", $userinput);
2416: } else {
2417: &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
2418: "while attempting inc\n", $userinput);
2419: }
2420: } else {
2421: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2422: "while attempting inc\n", $userinput);
2423: }
2424: } else {
2425: &Failure($client, "refused\n", $userinput);
2426: }
2427:
2428: return 1;
2429: }
2430: ®ister_handler("inc", \&increment_user_value_handler, 0, 1, 0);
2431:
2432: #
2433: # Put a new role for a user. Roles are LonCAPA's packaging of permissions.
2434: # Each 'role' a user has implies a set of permissions. Adding a new role
2435: # for a person grants the permissions packaged with that role
2436: # to that user when the role is selected.
2437: #
2438: # Parameters:
2439: # $cmd - The command string (rolesput).
2440: # $tail - The remainder of the request line. For rolesput this
2441: # consists of a colon separated list that contains:
2442: # The domain and user that is granting the role (logged).
2443: # The domain and user that is getting the role.
2444: # The roles being granted as a set of & separated pairs.
2445: # each pair a key value pair.
2446: # $client - File descriptor connected to the client.
2447: # Returns:
2448: # 0 - If the daemon should exit
2449: # 1 - To continue processing.
2450: #
2451: #
2452: sub roles_put_handler {
2453: my ($cmd, $tail, $client) = @_;
2454:
2455: my $userinput = "$cmd:$tail";
2456:
2457: my ( $exedom, $exeuser, $udom, $uname, $what) = split(/:/,$tail);
2458:
2459:
2460: my $namespace='roles';
2461: chomp($what);
2462: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2463: &GDBM_WRCREAT(), "P",
2464: "$exedom:$exeuser:$what");
2465: #
2466: # Log the attempt to set a role. The {}'s here ensure that the file
2467: # handle is open for the minimal amount of time. Since the flush
2468: # is done on close this improves the chances the log will be an un-
2469: # corrupted ordered thing.
2470: if ($hashref) {
1.261 foxr 2471: my $pass_entry = &get_auth_type($udom, $uname);
2472: my ($auth_type,$pwd) = split(/:/, $pass_entry);
2473: $auth_type = $auth_type.":";
1.230 foxr 2474: my @pairs=split(/\&/,$what);
2475: foreach my $pair (@pairs) {
2476: my ($key,$value)=split(/=/,$pair);
2477: &manage_permissions($key, $udom, $uname,
1.260 foxr 2478: $auth_type);
1.230 foxr 2479: $hashref->{$key}=$value;
2480: }
1.311 albertel 2481: if (&untie_user_hash($hashref)) {
1.230 foxr 2482: &Reply($client, "ok\n", $userinput);
2483: } else {
2484: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2485: "while attempting rolesput\n", $userinput);
2486: }
2487: } else {
2488: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2489: "while attempting rolesput\n", $userinput);
2490: }
2491: return 1;
2492: }
2493: ®ister_handler("rolesput", \&roles_put_handler, 1,1,0); # Encoded client only.
2494:
2495: #
1.231 foxr 2496: # Deletes (removes) a role for a user. This is equivalent to removing
2497: # a permissions package associated with the role from the user's profile.
2498: #
2499: # Parameters:
2500: # $cmd - The command (rolesdel)
2501: # $tail - The remainder of the request line. This consists
2502: # of:
2503: # The domain and user requesting the change (logged)
2504: # The domain and user being changed.
2505: # The roles being revoked. These are shipped to us
2506: # as a bunch of & separated role name keywords.
2507: # $client - The file handle open on the client.
2508: # Returns:
2509: # 1 - Continue processing
2510: # 0 - Exit.
2511: #
2512: sub roles_delete_handler {
2513: my ($cmd, $tail, $client) = @_;
2514:
2515: my $userinput = "$cmd:$tail";
2516:
2517: my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
2518: &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
2519: "what = ".$what);
2520: my $namespace='roles';
2521: chomp($what);
2522: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2523: &GDBM_WRCREAT(), "D",
2524: "$exedom:$exeuser:$what");
2525:
2526: if ($hashref) {
2527: my @rolekeys=split(/\&/,$what);
2528:
2529: foreach my $key (@rolekeys) {
2530: delete $hashref->{$key};
2531: }
1.315 albertel 2532: if (&untie_user_hash($hashref)) {
1.231 foxr 2533: &Reply($client, "ok\n", $userinput);
2534: } else {
2535: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2536: "while attempting rolesdel\n", $userinput);
2537: }
2538: } else {
2539: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2540: "while attempting rolesdel\n", $userinput);
2541: }
2542:
2543: return 1;
2544: }
2545: ®ister_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
2546:
2547: # Unencrypted get from a user's profile database. See
2548: # GetProfileEntryEncrypted for a version that does end-to-end encryption.
2549: # This function retrieves a keyed item from a specific named database in the
2550: # user's directory.
2551: #
2552: # Parameters:
2553: # $cmd - Command request keyword (get).
2554: # $tail - Tail of the command. This is a colon separated list
2555: # consisting of the domain and username that uniquely
2556: # identifies the profile,
2557: # The 'namespace' which selects the gdbm file to
2558: # do the lookup in,
2559: # & separated list of keys to lookup. Note that
2560: # the values are returned as an & separated list too.
2561: # $client - File descriptor open on the client.
2562: # Returns:
2563: # 1 - Continue processing.
2564: # 0 - Exit.
2565: #
2566: sub get_profile_entry {
2567: my ($cmd, $tail, $client) = @_;
2568:
2569: my $userinput= "$cmd:$tail";
2570:
2571: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2572: chomp($what);
1.255 foxr 2573:
2574: my $replystring = read_profile($udom, $uname, $namespace, $what);
2575: my ($first) = split(/:/,$replystring);
2576: if($first ne "error") {
2577: &Reply($client, "$replystring\n", $userinput);
1.231 foxr 2578: } else {
1.255 foxr 2579: &Failure($client, $replystring." while attempting get\n", $userinput);
1.231 foxr 2580: }
2581: return 1;
1.255 foxr 2582:
2583:
1.231 foxr 2584: }
2585: ®ister_handler("get", \&get_profile_entry, 0,1,0);
2586:
2587: #
2588: # Process the encrypted get request. Note that the request is sent
2589: # in clear, but the reply is encrypted. This is a small covert channel:
2590: # information about the sensitive keys is given to the snooper. Just not
2591: # information about the values of the sensitive key. Hmm if I wanted to
2592: # know these I'd snoop for the egets. Get the profile item names from them
2593: # and then issue a get for them since there's no enforcement of the
2594: # requirement of an encrypted get for particular profile items. If I
2595: # were re-doing this, I'd force the request to be encrypted as well as the
2596: # reply. I'd also just enforce encrypted transactions for all gets since
2597: # that would prevent any covert channel snooping.
2598: #
2599: # Parameters:
2600: # $cmd - Command keyword of request (eget).
2601: # $tail - Tail of the command. See GetProfileEntry
# for more information about this.
2602: # $client - File open on the client.
2603: # Returns:
2604: # 1 - Continue processing
2605: # 0 - server should exit.
2606: sub get_profile_entry_encrypted {
2607: my ($cmd, $tail, $client) = @_;
2608:
2609: my $userinput = "$cmd:$tail";
2610:
1.339 albertel 2611: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
1.231 foxr 2612: chomp($what);
1.255 foxr 2613: my $qresult = read_profile($udom, $uname, $namespace, $what);
2614: my ($first) = split(/:/, $qresult);
2615: if($first ne "error") {
2616:
2617: if ($cipher) {
2618: my $cmdlength=length($qresult);
2619: $qresult.=" ";
2620: my $encqresult='';
2621: for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
2622: $encqresult.= unpack("H16",
2623: $cipher->encrypt(substr($qresult,
2624: $encidx,
2625: 8)));
2626: }
2627: &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
2628: } else {
1.231 foxr 2629: &Failure( $client, "error:no_key\n", $userinput);
2630: }
2631: } else {
1.255 foxr 2632: &Failure($client, "$qresult while attempting eget\n", $userinput);
2633:
1.231 foxr 2634: }
2635:
2636: return 1;
2637: }
1.255 foxr 2638: ®ister_handler("eget", \&get_profile_entry_encrypted, 0, 1, 0);
1.263 albertel 2639:
1.231 foxr 2640: #
2641: # Deletes a key in a user profile database.
2642: #
2643: # Parameters:
2644: # $cmd - Command keyword (del).
2645: # $tail - Command tail. IN this case a colon
2646: # separated list containing:
2647: # The domain and user that identifies uniquely
2648: # the identity of the user.
2649: # The profile namespace (name of the profile
2650: # database file).
2651: # & separated list of keywords to delete.
2652: # $client - File open on client socket.
2653: # Returns:
2654: # 1 - Continue processing
2655: # 0 - Exit server.
2656: #
2657: #
2658: sub delete_profile_entry {
2659: my ($cmd, $tail, $client) = @_;
2660:
2661: my $userinput = "cmd:$tail";
2662:
2663: my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
2664: chomp($what);
2665: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2666: &GDBM_WRCREAT(),
2667: "D",$what);
2668: if ($hashref) {
2669: my @keys=split(/\&/,$what);
2670: foreach my $key (@keys) {
2671: delete($hashref->{$key});
2672: }
1.315 albertel 2673: if (&untie_user_hash($hashref)) {
1.231 foxr 2674: &Reply($client, "ok\n", $userinput);
2675: } else {
2676: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2677: "while attempting del\n", $userinput);
2678: }
2679: } else {
2680: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2681: "while attempting del\n", $userinput);
2682: }
2683: return 1;
2684: }
2685: ®ister_handler("del", \&delete_profile_entry, 0, 1, 0);
1.263 albertel 2686:
1.231 foxr 2687: #
2688: # List the set of keys that are defined in a profile database file.
2689: # A successful reply from this will contain an & separated list of
2690: # the keys.
2691: # Parameters:
2692: # $cmd - Command request (keys).
2693: # $tail - Remainder of the request, a colon separated
2694: # list containing domain/user that identifies the
2695: # user being queried, and the database namespace
2696: # (database filename essentially).
2697: # $client - File open on the client.
2698: # Returns:
2699: # 1 - Continue processing.
2700: # 0 - Exit the server.
2701: #
2702: sub get_profile_keys {
2703: my ($cmd, $tail, $client) = @_;
2704:
2705: my $userinput = "$cmd:$tail";
2706:
2707: my ($udom,$uname,$namespace)=split(/:/,$tail);
2708: my $qresult='';
2709: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2710: &GDBM_READER());
2711: if ($hashref) {
2712: foreach my $key (keys %$hashref) {
2713: $qresult.="$key&";
2714: }
1.315 albertel 2715: if (&untie_user_hash($hashref)) {
1.231 foxr 2716: $qresult=~s/\&$//;
2717: &Reply($client, "$qresult\n", $userinput);
2718: } else {
2719: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2720: "while attempting keys\n", $userinput);
2721: }
2722: } else {
2723: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2724: "while attempting keys\n", $userinput);
2725: }
2726:
2727: return 1;
2728: }
2729: ®ister_handler("keys", \&get_profile_keys, 0, 1, 0);
2730:
2731: #
2732: # Dump the contents of a user profile database.
2733: # Note that this constitutes a very large covert channel too since
2734: # the dump will return sensitive information that is not encrypted.
2735: # The naive security assumption is that the session negotiation ensures
2736: # our client is trusted and I don't believe that's assured at present.
2737: # Sure want badly to go to ssl or tls. Of course if my peer isn't really
2738: # a LonCAPA node they could have negotiated an encryption key too so >sigh<.
2739: #
2740: # Parameters:
2741: # $cmd - The command request keyword (currentdump).
2742: # $tail - Remainder of the request, consisting of a colon
2743: # separated list that has the domain/username and
2744: # the namespace to dump (database file).
2745: # $client - file open on the remote client.
2746: # Returns:
2747: # 1 - Continue processing.
2748: # 0 - Exit the server.
2749: #
2750: sub dump_profile_database {
2751: my ($cmd, $tail, $client) = @_;
2752:
2753: my $userinput = "$cmd:$tail";
2754:
2755: my ($udom,$uname,$namespace) = split(/:/,$tail);
2756: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2757: &GDBM_READER());
2758: if ($hashref) {
2759: # Structure of %data:
2760: # $data{$symb}->{$parameter}=$value;
2761: # $data{$symb}->{'v.'.$parameter}=$version;
2762: # since $parameter will be unescaped, we do not
2763: # have to worry about silly parameter names...
2764:
2765: my $qresult='';
2766: my %data = (); # A hash of anonymous hashes..
2767: while (my ($key,$value) = each(%$hashref)) {
2768: my ($v,$symb,$param) = split(/:/,$key);
2769: next if ($v eq 'version' || $symb eq 'keys');
2770: next if (exists($data{$symb}) &&
2771: exists($data{$symb}->{$param}) &&
2772: $data{$symb}->{'v.'.$param} > $v);
2773: $data{$symb}->{$param}=$value;
2774: $data{$symb}->{'v.'.$param}=$v;
2775: }
1.311 albertel 2776: if (&untie_user_hash($hashref)) {
1.231 foxr 2777: while (my ($symb,$param_hash) = each(%data)) {
2778: while(my ($param,$value) = each (%$param_hash)){
2779: next if ($param =~ /^v\./); # Ignore versions...
2780: #
2781: # Just dump the symb=value pairs separated by &
2782: #
2783: $qresult.=$symb.':'.$param.'='.$value.'&';
2784: }
2785: }
2786: chop($qresult);
2787: &Reply($client , "$qresult\n", $userinput);
2788: } else {
2789: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2790: "while attempting currentdump\n", $userinput);
2791: }
2792: } else {
2793: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2794: "while attempting currentdump\n", $userinput);
2795: }
2796:
2797: return 1;
2798: }
2799: ®ister_handler("currentdump", \&dump_profile_database, 0, 1, 0);
2800:
2801: #
2802: # Dump a profile database with an optional regular expression
2803: # to match against the keys. In this dump, no effort is made
2804: # to separate symb from version information. Presumably the
2805: # databases that are dumped by this command are of a different
2806: # structure. Need to look at this and improve the documentation of
2807: # both this and the currentdump handler.
2808: # Parameters:
2809: # $cmd - The command keyword.
2810: # $tail - All of the characters after the $cmd:
2811: # These are expected to be a colon
2812: # separated list containing:
2813: # domain/user - identifying the user.
2814: # namespace - identifying the database.
2815: # regexp - optional regular expression
2816: # that is matched against
2817: # database keywords to do
2818: # selective dumps.
2819: # $client - Channel open on the client.
2820: # Returns:
2821: # 1 - Continue processing.
2822: # Side effects:
2823: # response is written to $client.
2824: #
2825: sub dump_with_regexp {
2826: my ($cmd, $tail, $client) = @_;
2827:
2828:
2829: my $userinput = "$cmd:$tail";
2830:
1.306 albertel 2831: my ($udom,$uname,$namespace,$regexp,$range)=split(/:/,$tail);
1.231 foxr 2832: if (defined($regexp)) {
2833: $regexp=&unescape($regexp);
2834: } else {
2835: $regexp='.';
2836: }
1.306 albertel 2837: my ($start,$end);
2838: if (defined($range)) {
2839: if ($range =~/^(\d+)\-(\d+)$/) {
2840: ($start,$end) = ($1,$2);
2841: } elsif ($range =~/^(\d+)$/) {
2842: ($start,$end) = (0,$1);
2843: } else {
2844: undef($range);
2845: }
2846: }
1.231 foxr 2847: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2848: &GDBM_READER());
2849: if ($hashref) {
2850: my $qresult='';
1.306 albertel 2851: my $count=0;
1.231 foxr 2852: while (my ($key,$value) = each(%$hashref)) {
2853: if ($regexp eq '.') {
1.306 albertel 2854: $count++;
2855: if (defined($range) && $count >= $end) { last; }
2856: if (defined($range) && $count < $start) { next; }
1.231 foxr 2857: $qresult.=$key.'='.$value.'&';
2858: } else {
2859: my $unescapeKey = &unescape($key);
2860: if (eval('$unescapeKey=~/$regexp/')) {
1.306 albertel 2861: $count++;
2862: if (defined($range) && $count >= $end) { last; }
2863: if (defined($range) && $count < $start) { next; }
1.231 foxr 2864: $qresult.="$key=$value&";
2865: }
2866: }
2867: }
1.311 albertel 2868: if (&untie_user_hash($hashref)) {
1.231 foxr 2869: chop($qresult);
2870: &Reply($client, "$qresult\n", $userinput);
2871: } else {
2872: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
2873: "while attempting dump\n", $userinput);
2874: }
2875: } else {
2876: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
2877: "while attempting dump\n", $userinput);
2878: }
2879:
2880: return 1;
2881: }
2882: ®ister_handler("dump", \&dump_with_regexp, 0, 1, 0);
2883:
2884: # Store a set of key=value pairs associated with a versioned name.
2885: #
2886: # Parameters:
2887: # $cmd - Request command keyword.
2888: # $tail - Tail of the request. This is a colon
2889: # separated list containing:
2890: # domain/user - User and authentication domain.
2891: # namespace - Name of the database being modified
2892: # rid - Resource keyword to modify.
2893: # what - new value associated with rid.
2894: #
2895: # $client - Socket open on the client.
2896: #
2897: #
2898: # Returns:
2899: # 1 (keep on processing).
2900: # Side-Effects:
2901: # Writes to the client
2902: sub store_handler {
2903: my ($cmd, $tail, $client) = @_;
2904:
2905: my $userinput = "$cmd:$tail";
2906:
2907: my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
2908: if ($namespace ne 'roles') {
2909:
2910: chomp($what);
2911: my @pairs=split(/\&/,$what);
2912: my $hashref = &tie_user_hash($udom, $uname, $namespace,
1.268 albertel 2913: &GDBM_WRCREAT(), "S",
1.231 foxr 2914: "$rid:$what");
2915: if ($hashref) {
2916: my $now = time;
2917: my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
2918: my $key;
2919: $hashref->{"version:$rid"}++;
2920: my $version=$hashref->{"version:$rid"};
2921: my $allkeys='';
2922: foreach my $pair (@pairs) {
2923: my ($key,$value)=split(/=/,$pair);
2924: $allkeys.=$key.':';
2925: $hashref->{"$version:$rid:$key"}=$value;
2926: }
2927: $hashref->{"$version:$rid:timestamp"}=$now;
2928: $allkeys.='timestamp';
2929: $hashref->{"$version:keys:$rid"}=$allkeys;
1.311 albertel 2930: if (&untie_user_hash($hashref)) {
1.231 foxr 2931: &Reply($client, "ok\n", $userinput);
2932: } else {
2933: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2934: "while attempting store\n", $userinput);
2935: }
2936: } else {
2937: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2938: "while attempting store\n", $userinput);
2939: }
2940: } else {
2941: &Failure($client, "refused\n", $userinput);
2942: }
2943:
2944: return 1;
2945: }
2946: ®ister_handler("store", \&store_handler, 0, 1, 0);
1.263 albertel 2947:
1.323 albertel 2948: # Modify a set of key=value pairs associated with a versioned name.
2949: #
2950: # Parameters:
2951: # $cmd - Request command keyword.
2952: # $tail - Tail of the request. This is a colon
2953: # separated list containing:
2954: # domain/user - User and authentication domain.
2955: # namespace - Name of the database being modified
2956: # rid - Resource keyword to modify.
2957: # v - Version item to modify
2958: # what - new value associated with rid.
2959: #
2960: # $client - Socket open on the client.
2961: #
2962: #
2963: # Returns:
2964: # 1 (keep on processing).
2965: # Side-Effects:
2966: # Writes to the client
2967: sub putstore_handler {
2968: my ($cmd, $tail, $client) = @_;
2969:
2970: my $userinput = "$cmd:$tail";
2971:
2972: my ($udom,$uname,$namespace,$rid,$v,$what) =split(/:/,$tail);
2973: if ($namespace ne 'roles') {
2974:
2975: chomp($what);
2976: my $hashref = &tie_user_hash($udom, $uname, $namespace,
2977: &GDBM_WRCREAT(), "M",
2978: "$rid:$v:$what");
2979: if ($hashref) {
2980: my $now = time;
2981: my %data = &hash_extract($what);
2982: my @allkeys;
2983: while (my($key,$value) = each(%data)) {
2984: push(@allkeys,$key);
2985: $hashref->{"$v:$rid:$key"} = $value;
2986: }
2987: my $allkeys = join(':',@allkeys);
2988: $hashref->{"$v:keys:$rid"}=$allkeys;
2989:
2990: if (&untie_user_hash($hashref)) {
2991: &Reply($client, "ok\n", $userinput);
2992: } else {
2993: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
2994: "while attempting store\n", $userinput);
2995: }
2996: } else {
2997: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
2998: "while attempting store\n", $userinput);
2999: }
3000: } else {
3001: &Failure($client, "refused\n", $userinput);
3002: }
3003:
3004: return 1;
3005: }
3006: ®ister_handler("putstore", \&putstore_handler, 0, 1, 0);
3007:
3008: sub hash_extract {
3009: my ($str)=@_;
3010: my %hash;
3011: foreach my $pair (split(/\&/,$str)) {
3012: my ($key,$value)=split(/=/,$pair);
3013: $hash{$key}=$value;
3014: }
3015: return (%hash);
3016: }
3017: sub hash_to_str {
3018: my ($hash_ref)=@_;
3019: my $str;
3020: foreach my $key (keys(%$hash_ref)) {
3021: $str.=$key.'='.$hash_ref->{$key}.'&';
3022: }
3023: $str=~s/\&$//;
3024: return $str;
3025: }
3026:
1.231 foxr 3027: #
3028: # Dump out all versions of a resource that has key=value pairs associated
3029: # with it for each version. These resources are built up via the store
3030: # command.
3031: #
3032: # Parameters:
3033: # $cmd - Command keyword.
3034: # $tail - Remainder of the request which consists of:
3035: # domain/user - User and auth. domain.
3036: # namespace - name of resource database.
3037: # rid - Resource id.
3038: # $client - socket open on the client.
3039: #
3040: # Returns:
3041: # 1 indicating the caller should not yet exit.
3042: # Side-effects:
3043: # Writes a reply to the client.
3044: # The reply is a string of the following shape:
3045: # version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
3046: # Where the 1 above represents version 1.
3047: # this continues for all pairs of keys in all versions.
3048: #
3049: #
3050: #
3051: #
3052: sub restore_handler {
3053: my ($cmd, $tail, $client) = @_;
3054:
3055: my $userinput = "$cmd:$tail"; # Only used for logging purposes.
3056:
1.339 albertel 3057: my ($udom,$uname,$namespace,$rid) = split(/:/,$tail);
1.231 foxr 3058: $namespace=~s/\//\_/g;
3059: $namespace=~s/\W//g;
3060: chomp($rid);
3061: my $qresult='';
1.309 albertel 3062: my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER());
3063: if ($hashref) {
3064: my $version=$hashref->{"version:$rid"};
1.231 foxr 3065: $qresult.="version=$version&";
3066: my $scope;
3067: for ($scope=1;$scope<=$version;$scope++) {
1.309 albertel 3068: my $vkeys=$hashref->{"$scope:keys:$rid"};
1.231 foxr 3069: my @keys=split(/:/,$vkeys);
3070: my $key;
3071: $qresult.="$scope:keys=$vkeys&";
3072: foreach $key (@keys) {
1.309 albertel 3073: $qresult.="$scope:$key=".$hashref->{"$scope:$rid:$key"}."&";
1.231 foxr 3074: }
3075: }
1.311 albertel 3076: if (&untie_user_hash($hashref)) {
1.231 foxr 3077: $qresult=~s/\&$//;
3078: &Reply( $client, "$qresult\n", $userinput);
3079: } else {
3080: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3081: "while attempting restore\n", $userinput);
3082: }
3083: } else {
3084: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3085: "while attempting restore\n", $userinput);
3086: }
3087:
3088: return 1;
3089:
3090:
3091: }
3092: ®ister_handler("restore", \&restore_handler, 0,1,0);
1.234 foxr 3093:
3094: #
1.324 raeburn 3095: # Add a chat message to a synchronous discussion board.
1.234 foxr 3096: #
3097: # Parameters:
3098: # $cmd - Request keyword.
3099: # $tail - Tail of the command. A colon separated list
3100: # containing:
3101: # cdom - Domain on which the chat board lives
1.324 raeburn 3102: # cnum - Course containing the chat board.
3103: # newpost - Body of the posting.
3104: # group - Optional group, if chat board is only
3105: # accessible in a group within the course
1.234 foxr 3106: # $client - Socket open on the client.
3107: # Returns:
3108: # 1 - Indicating caller should keep on processing.
3109: #
3110: # Side-effects:
3111: # writes a reply to the client.
3112: #
3113: #
3114: sub send_chat_handler {
3115: my ($cmd, $tail, $client) = @_;
3116:
3117:
3118: my $userinput = "$cmd:$tail";
3119:
1.324 raeburn 3120: my ($cdom,$cnum,$newpost,$group)=split(/\:/,$tail);
3121: &chat_add($cdom,$cnum,$newpost,$group);
1.234 foxr 3122: &Reply($client, "ok\n", $userinput);
3123:
3124: return 1;
3125: }
3126: ®ister_handler("chatsend", \&send_chat_handler, 0, 1, 0);
1.263 albertel 3127:
1.234 foxr 3128: #
1.324 raeburn 3129: # Retrieve the set of chat messages from a discussion board.
1.234 foxr 3130: #
3131: # Parameters:
3132: # $cmd - Command keyword that initiated the request.
3133: # $tail - Remainder of the request after the command
3134: # keyword. In this case a colon separated list of
3135: # chat domain - Which discussion board.
3136: # chat id - Discussion thread(?)
3137: # domain/user - Authentication domain and username
3138: # of the requesting person.
1.324 raeburn 3139: # group - Optional course group containing
3140: # the board.
1.234 foxr 3141: # $client - Socket open on the client program.
3142: # Returns:
3143: # 1 - continue processing
3144: # Side effects:
3145: # Response is written to the client.
3146: #
3147: sub retrieve_chat_handler {
3148: my ($cmd, $tail, $client) = @_;
3149:
3150:
3151: my $userinput = "$cmd:$tail";
3152:
1.324 raeburn 3153: my ($cdom,$cnum,$udom,$uname,$group)=split(/\:/,$tail);
1.234 foxr 3154: my $reply='';
1.324 raeburn 3155: foreach (&get_chat($cdom,$cnum,$udom,$uname,$group)) {
1.234 foxr 3156: $reply.=&escape($_).':';
3157: }
3158: $reply=~s/\:$//;
3159: &Reply($client, $reply."\n", $userinput);
3160:
3161:
3162: return 1;
3163: }
3164: ®ister_handler("chatretr", \&retrieve_chat_handler, 0, 1, 0);
3165:
3166: #
3167: # Initiate a query of an sql database. SQL query repsonses get put in
3168: # a file for later retrieval. This prevents sql query results from
3169: # bottlenecking the system. Note that with loncnew, perhaps this is
3170: # less of an issue since multiple outstanding requests can be concurrently
3171: # serviced.
3172: #
3173: # Parameters:
3174: # $cmd - COmmand keyword that initiated the request.
3175: # $tail - Remainder of the command after the keyword.
3176: # For this function, this consists of a query and
3177: # 3 arguments that are self-documentingly labelled
3178: # in the original arg1, arg2, arg3.
3179: # $client - Socket open on the client.
3180: # Return:
3181: # 1 - Indicating processing should continue.
3182: # Side-effects:
3183: # a reply is written to $client.
3184: #
3185: sub send_query_handler {
3186: my ($cmd, $tail, $client) = @_;
3187:
3188:
3189: my $userinput = "$cmd:$tail";
3190:
3191: my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
3192: $query=~s/\n*$//g;
3193: &Reply($client, "". &sql_reply("$clientname\&$query".
3194: "\&$arg1"."\&$arg2"."\&$arg3")."\n",
3195: $userinput);
3196:
3197: return 1;
3198: }
3199: ®ister_handler("querysend", \&send_query_handler, 0, 1, 0);
3200:
3201: #
3202: # Add a reply to an sql query. SQL queries are done asyncrhonously.
3203: # The query is submitted via a "querysend" transaction.
3204: # There it is passed on to the lonsql daemon, queued and issued to
3205: # mysql.
3206: # This transaction is invoked when the sql transaction is complete
3207: # it stores the query results in flie and indicates query completion.
3208: # presumably local software then fetches this response... I'm guessing
3209: # the sequence is: lonc does a querysend, we ask lonsql to do it.
3210: # lonsql on completion of the query interacts with the lond of our
3211: # client to do a query reply storing two files:
3212: # - id - The results of the query.
3213: # - id.end - Indicating the transaction completed.
3214: # NOTE: id is a unique id assigned to the query and querysend time.
3215: # Parameters:
3216: # $cmd - Command keyword that initiated this request.
3217: # $tail - Remainder of the tail. In this case that's a colon
3218: # separated list containing the query Id and the
3219: # results of the query.
3220: # $client - Socket open on the client.
3221: # Return:
3222: # 1 - Indicating that we should continue processing.
3223: # Side effects:
3224: # ok written to the client.
3225: #
3226: sub reply_query_handler {
3227: my ($cmd, $tail, $client) = @_;
3228:
3229:
3230: my $userinput = "$cmd:$tail";
3231:
1.339 albertel 3232: my ($id,$reply)=split(/:/,$tail);
1.234 foxr 3233: my $store;
3234: my $execdir=$perlvar{'lonDaemons'};
3235: if ($store=IO::File->new(">$execdir/tmp/$id")) {
3236: $reply=~s/\&/\n/g;
3237: print $store $reply;
3238: close $store;
3239: my $store2=IO::File->new(">$execdir/tmp/$id.end");
3240: print $store2 "done\n";
3241: close $store2;
3242: &Reply($client, "ok\n", $userinput);
3243: } else {
3244: &Failure($client, "error: ".($!+0)
3245: ." IO::File->new Failed ".
3246: "while attempting queryreply\n", $userinput);
3247: }
3248:
3249:
3250: return 1;
3251: }
3252: ®ister_handler("queryreply", \&reply_query_handler, 0, 1, 0);
3253:
3254: #
3255: # Process the courseidput request. Not quite sure what this means
3256: # at the system level sense. It appears a gdbm file in the
3257: # /home/httpd/lonUsers/$domain/nohist_courseids is tied and
3258: # a set of entries made in that database.
3259: #
3260: # Parameters:
3261: # $cmd - The command keyword that initiated this request.
3262: # $tail - Tail of the command. In this case consists of a colon
3263: # separated list contaning the domain to apply this to and
3264: # an ampersand separated list of keyword=value pairs.
1.272 raeburn 3265: # Each value is a colon separated list that includes:
3266: # description, institutional code and course owner.
3267: # For backward compatibility with versions included
3268: # in LON-CAPA 1.1.X (and earlier) and 1.2.X, institutional
3269: # code and/or course owner are preserved from the existing
3270: # record when writing a new record in response to 1.1 or
3271: # 1.2 implementations of lonnet::flushcourselogs().
3272: #
1.234 foxr 3273: # $client - Socket open on the client.
3274: # Returns:
3275: # 1 - indicating that processing should continue
3276: #
3277: # Side effects:
3278: # reply is written to the client.
3279: #
3280: sub put_course_id_handler {
3281: my ($cmd, $tail, $client) = @_;
3282:
3283:
3284: my $userinput = "$cmd:$tail";
3285:
1.266 raeburn 3286: my ($udom, $what) = split(/:/, $tail,2);
1.234 foxr 3287: chomp($what);
3288: my $now=time;
3289: my @pairs=split(/\&/,$what);
3290:
3291: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3292: if ($hashref) {
3293: foreach my $pair (@pairs) {
1.271 raeburn 3294: my ($key,$courseinfo) = split(/=/,$pair,2);
3295: $courseinfo =~ s/=/:/g;
1.272 raeburn 3296:
1.273 albertel 3297: my @current_items = split(/:/,$hashref->{$key});
3298: shift(@current_items); # remove description
3299: pop(@current_items); # remove last access
1.272 raeburn 3300: my $numcurrent = scalar(@current_items);
3301:
1.273 albertel 3302: my @new_items = split(/:/,$courseinfo);
1.272 raeburn 3303: my $numnew = scalar(@new_items);
3304: if ($numcurrent > 0) {
1.333 raeburn 3305: if ($numnew <= $numcurrent) { # flushcourselogs() from pre 2.2
3306: for (my $j=$numcurrent-$numnew; $j>=0; $j--) {
3307: $courseinfo .= ':'.$current_items[$numcurrent-$j-1];
3308: }
1.272 raeburn 3309: }
3310: }
1.266 raeburn 3311: $hashref->{$key}=$courseinfo.':'.$now;
1.234 foxr 3312: }
1.311 albertel 3313: if (&untie_domain_hash($hashref)) {
1.253 foxr 3314: &Reply( $client, "ok\n", $userinput);
1.234 foxr 3315: } else {
1.253 foxr 3316: &Failure($client, "error: ".($!+0)
1.234 foxr 3317: ." untie(GDBM) Failed ".
3318: "while attempting courseidput\n", $userinput);
3319: }
3320: } else {
1.253 foxr 3321: &Failure($client, "error: ".($!+0)
1.234 foxr 3322: ." tie(GDBM) Failed ".
3323: "while attempting courseidput\n", $userinput);
3324: }
1.253 foxr 3325:
1.234 foxr 3326:
3327: return 1;
3328: }
3329: ®ister_handler("courseidput", \&put_course_id_handler, 0, 1, 0);
3330:
3331: # Retrieves the value of a course id resource keyword pattern
3332: # defined since a starting date. Both the starting date and the
3333: # keyword pattern are optional. If the starting date is not supplied it
3334: # is treated as the beginning of time. If the pattern is not found,
3335: # it is treatred as "." matching everything.
3336: #
3337: # Parameters:
3338: # $cmd - Command keyword that resulted in us being dispatched.
3339: # $tail - The remainder of the command that, in this case, consists
3340: # of a colon separated list of:
3341: # domain - The domain in which the course database is
3342: # defined.
3343: # since - Optional parameter describing the minimum
3344: # time of definition(?) of the resources that
3345: # will match the dump.
3346: # description - regular expression that is used to filter
3347: # the dump. Only keywords matching this regexp
3348: # will be used.
1.272 raeburn 3349: # institutional code - optional supplied code to filter
3350: # the dump. Only courses with an institutional code
3351: # that match the supplied code will be returned.
1.336 raeburn 3352: # owner - optional supplied username and domain of owner to
3353: # filter the dump. Only courses for which the course
3354: # owner matches the supplied username and/or domain
3355: # will be returned. Pre-2.2.0 legacy entries from
3356: # nohist_courseiddump will only contain usernames.
1.234 foxr 3357: # $client - The socket open on the client.
3358: # Returns:
3359: # 1 - Continue processing.
3360: # Side Effects:
3361: # a reply is written to $client.
3362: sub dump_course_id_handler {
3363: my ($cmd, $tail, $client) = @_;
3364:
3365: my $userinput = "$cmd:$tail";
3366:
1.333 raeburn 3367: my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
1.344 raeburn 3368: $typefilter,$regexp_ok) =split(/:/,$tail);
1.234 foxr 3369: if (defined($description)) {
3370: $description=&unescape($description);
3371: } else {
3372: $description='.';
3373: }
1.266 raeburn 3374: if (defined($instcodefilter)) {
3375: $instcodefilter=&unescape($instcodefilter);
3376: } else {
3377: $instcodefilter='.';
3378: }
1.336 raeburn 3379: my ($ownerunamefilter,$ownerdomfilter);
1.266 raeburn 3380: if (defined($ownerfilter)) {
3381: $ownerfilter=&unescape($ownerfilter);
1.336 raeburn 3382: if ($ownerfilter ne '.' && defined($ownerfilter)) {
3383: if ($ownerfilter =~ /^([^:]*):([^:]*)$/) {
3384: $ownerunamefilter = $1;
3385: $ownerdomfilter = $2;
3386: } else {
3387: $ownerunamefilter = $ownerfilter;
3388: $ownerdomfilter = '';
3389: }
3390: }
1.266 raeburn 3391: } else {
3392: $ownerfilter='.';
3393: }
1.336 raeburn 3394:
1.282 raeburn 3395: if (defined($coursefilter)) {
3396: $coursefilter=&unescape($coursefilter);
3397: } else {
3398: $coursefilter='.';
3399: }
1.333 raeburn 3400: if (defined($typefilter)) {
3401: $typefilter=&unescape($typefilter);
3402: } else {
3403: $typefilter='.';
3404: }
1.344 raeburn 3405: if (defined($regexp_ok)) {
3406: $regexp_ok=&unescape($regexp_ok);
3407: }
1.266 raeburn 3408:
1.234 foxr 3409: unless (defined($since)) { $since=0; }
3410: my $qresult='';
3411: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
3412: if ($hashref) {
3413: while (my ($key,$value) = each(%$hashref)) {
1.333 raeburn 3414: my ($descr,$lasttime,$inst_code,$owner,$type);
1.274 albertel 3415: my @courseitems = split(/:/,$value);
3416: $lasttime = pop(@courseitems);
1.333 raeburn 3417: ($descr,$inst_code,$owner,$type)=@courseitems;
1.234 foxr 3418: if ($lasttime<$since) { next; }
1.266 raeburn 3419: my $match = 1;
3420: unless ($description eq '.') {
3421: my $unescapeDescr = &unescape($descr);
3422: unless (eval('$unescapeDescr=~/\Q$description\E/i')) {
3423: $match = 0;
1.234 foxr 3424: }
1.266 raeburn 3425: }
3426: unless ($instcodefilter eq '.' || !defined($instcodefilter)) {
3427: my $unescapeInstcode = &unescape($inst_code);
1.344 raeburn 3428: if ($regexp_ok) {
3429: unless (eval('$unescapeInstcode=~/$instcodefilter/')) {
3430: $match = 0;
3431: }
3432: } else {
3433: unless (eval('$unescapeInstcode=~/\Q$instcodefilter\E/i')) {
3434: $match = 0;
3435: }
1.266 raeburn 3436: }
1.234 foxr 3437: }
1.266 raeburn 3438: unless ($ownerfilter eq '.' || !defined($ownerfilter)) {
3439: my $unescapeOwner = &unescape($owner);
1.336 raeburn 3440: if (($ownerunamefilter ne '') && ($ownerdomfilter ne '')) {
3441: if ($unescapeOwner =~ /:/) {
3442: if (eval('$unescapeOwner !~
3443: /\Q$ownerunamefilter\E:\Q$ownerdomfilter\E$/i')) {
3444: $match = 0;
3445: }
3446: } else {
3447: if (eval('$unescapeOwner!~/\Q$ownerunamefilter\E/i')) {
3448: $match = 0;
3449: }
3450: }
3451: } elsif ($ownerunamefilter ne '') {
3452: if ($unescapeOwner =~ /:/) {
3453: if (eval('$unescapeOwner!~/\Q$ownerunamefilter\E:[^:]+$/i')) {
3454: $match = 0;
3455: }
3456: } else {
3457: if (eval('$unescapeOwner!~/\Q$ownerunamefilter\E/i')) {
3458: $match = 0;
3459: }
3460: }
3461: } elsif ($ownerdomfilter ne '') {
3462: if ($unescapeOwner =~ /:/) {
3463: if (eval('$unescapeOwner!~/^[^:]+:\Q$ownerdomfilter\E/')) {
3464: $match = 0;
3465: }
3466: } else {
3467: if ($ownerdomfilter ne $udom) {
3468: $match = 0;
3469: }
3470: }
1.266 raeburn 3471: }
3472: }
1.282 raeburn 3473: unless ($coursefilter eq '.' || !defined($coursefilter)) {
3474: my $unescapeCourse = &unescape($key);
3475: unless (eval('$unescapeCourse=~/^$udom(_)\Q$coursefilter\E$/')) {
3476: $match = 0;
3477: }
3478: }
1.333 raeburn 3479: unless ($typefilter eq '.' || !defined($typefilter)) {
3480: my $unescapeType = &unescape($type);
1.342 albertel 3481: if ($type eq '') {
1.333 raeburn 3482: if ($typefilter ne 'Course') {
3483: $match = 0;
3484: }
3485: } else {
3486: unless (eval('$unescapeType=~/^\Q$typefilter\E$/')) {
3487: $match = 0;
3488: }
3489: }
3490: }
1.266 raeburn 3491: if ($match == 1) {
3492: $qresult.=$key.'='.$descr.':'.$inst_code.':'.$owner.'&';
3493: }
1.234 foxr 3494: }
1.311 albertel 3495: if (&untie_domain_hash($hashref)) {
1.234 foxr 3496: chop($qresult);
3497: &Reply($client, "$qresult\n", $userinput);
3498: } else {
3499: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3500: "while attempting courseiddump\n", $userinput);
3501: }
3502: } else {
3503: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3504: "while attempting courseiddump\n", $userinput);
3505: }
3506:
3507:
3508: return 1;
3509: }
3510: ®ister_handler("courseiddump", \&dump_course_id_handler, 0, 1, 0);
1.238 foxr 3511:
3512: #
3513: # Puts an id to a domains id database.
3514: #
3515: # Parameters:
3516: # $cmd - The command that triggered us.
3517: # $tail - Remainder of the request other than the command. This is a
3518: # colon separated list containing:
3519: # $domain - The domain for which we are writing the id.
3520: # $pairs - The id info to write... this is and & separated list
3521: # of keyword=value.
3522: # $client - Socket open on the client.
3523: # Returns:
3524: # 1 - Continue processing.
3525: # Side effects:
3526: # reply is written to $client.
3527: #
3528: sub put_id_handler {
3529: my ($cmd,$tail,$client) = @_;
3530:
3531:
3532: my $userinput = "$cmd:$tail";
3533:
3534: my ($udom,$what)=split(/:/,$tail);
3535: chomp($what);
3536: my @pairs=split(/\&/,$what);
3537: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
3538: "P", $what);
3539: if ($hashref) {
3540: foreach my $pair (@pairs) {
3541: my ($key,$value)=split(/=/,$pair);
3542: $hashref->{$key}=$value;
3543: }
1.311 albertel 3544: if (&untie_domain_hash($hashref)) {
1.238 foxr 3545: &Reply($client, "ok\n", $userinput);
3546: } else {
3547: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3548: "while attempting idput\n", $userinput);
3549: }
3550: } else {
3551: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3552: "while attempting idput\n", $userinput);
3553: }
3554:
3555: return 1;
3556: }
1.263 albertel 3557: ®ister_handler("idput", \&put_id_handler, 0, 1, 0);
1.238 foxr 3558:
3559: #
3560: # Retrieves a set of id values from the id database.
3561: # Returns an & separated list of results, one for each requested id to the
3562: # client.
3563: #
3564: # Parameters:
3565: # $cmd - Command keyword that caused us to be dispatched.
3566: # $tail - Tail of the command. Consists of a colon separated:
3567: # domain - the domain whose id table we dump
3568: # ids Consists of an & separated list of
3569: # id keywords whose values will be fetched.
3570: # nonexisting keywords will have an empty value.
3571: # $client - Socket open on the client.
3572: #
3573: # Returns:
3574: # 1 - indicating processing should continue.
3575: # Side effects:
3576: # An & separated list of results is written to $client.
3577: #
3578: sub get_id_handler {
3579: my ($cmd, $tail, $client) = @_;
3580:
3581:
3582: my $userinput = "$client:$tail";
3583:
3584: my ($udom,$what)=split(/:/,$tail);
3585: chomp($what);
3586: my @queries=split(/\&/,$what);
3587: my $qresult='';
3588: my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
3589: if ($hashref) {
3590: for (my $i=0;$i<=$#queries;$i++) {
3591: $qresult.="$hashref->{$queries[$i]}&";
3592: }
1.311 albertel 3593: if (&untie_domain_hash($hashref)) {
1.238 foxr 3594: $qresult=~s/\&$//;
3595: &Reply($client, "$qresult\n", $userinput);
3596: } else {
3597: &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
3598: "while attempting idget\n",$userinput);
3599: }
3600: } else {
3601: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3602: "while attempting idget\n",$userinput);
3603: }
3604:
3605: return 1;
3606: }
1.263 albertel 3607: ®ister_handler("idget", \&get_id_handler, 0, 1, 0);
1.238 foxr 3608:
3609: #
1.299 raeburn 3610: # Puts broadcast e-mail sent by Domain Coordinator in nohist_dcmail database
3611: #
3612: # Parameters
3613: # $cmd - Command keyword that caused us to be dispatched.
3614: # $tail - Tail of the command. Consists of a colon separated:
3615: # domain - the domain whose dcmail we are recording
3616: # email Consists of key=value pair
3617: # where key is unique msgid
3618: # and value is message (in XML)
3619: # $client - Socket open on the client.
3620: #
3621: # Returns:
3622: # 1 - indicating processing should continue.
3623: # Side effects
3624: # reply is written to $client.
3625: #
3626: sub put_dcmail_handler {
3627: my ($cmd,$tail,$client) = @_;
3628: my $userinput = "$cmd:$tail";
3629:
3630: my ($udom,$what)=split(/:/,$tail);
3631: chomp($what);
3632: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
3633: if ($hashref) {
3634: my ($key,$value)=split(/=/,$what);
3635: $hashref->{$key}=$value;
3636: }
1.311 albertel 3637: if (&untie_domain_hash($hashref)) {
1.299 raeburn 3638: &Reply($client, "ok\n", $userinput);
3639: } else {
3640: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3641: "while attempting dcmailput\n", $userinput);
3642: }
3643: return 1;
3644: }
3645: ®ister_handler("dcmailput", \&put_dcmail_handler, 0, 1, 0);
3646:
3647: #
3648: # Retrieves broadcast e-mail from nohist_dcmail database
3649: # Returns to client an & separated list of key=value pairs,
3650: # where key is msgid and value is message information.
3651: #
3652: # Parameters
3653: # $cmd - Command keyword that caused us to be dispatched.
3654: # $tail - Tail of the command. Consists of a colon separated:
3655: # domain - the domain whose dcmail table we dump
3656: # startfilter - beginning of time window
3657: # endfilter - end of time window
3658: # sendersfilter - & separated list of username:domain
3659: # for senders to search for.
3660: # $client - Socket open on the client.
3661: #
3662: # Returns:
3663: # 1 - indicating processing should continue.
3664: # Side effects
3665: # reply (& separated list of msgid=messageinfo pairs) is
3666: # written to $client.
3667: #
3668: sub dump_dcmail_handler {
3669: my ($cmd, $tail, $client) = @_;
3670:
3671: my $userinput = "$cmd:$tail";
3672: my ($udom,$startfilter,$endfilter,$sendersfilter) = split(/:/,$tail);
3673: chomp($sendersfilter);
3674: my @senders = ();
3675: if (defined($startfilter)) {
3676: $startfilter=&unescape($startfilter);
3677: } else {
3678: $startfilter='.';
3679: }
3680: if (defined($endfilter)) {
3681: $endfilter=&unescape($endfilter);
3682: } else {
3683: $endfilter='.';
3684: }
3685: if (defined($sendersfilter)) {
3686: $sendersfilter=&unescape($sendersfilter);
1.300 albertel 3687: @senders = map { &unescape($_) } split(/\&/,$sendersfilter);
1.299 raeburn 3688: }
3689:
3690: my $qresult='';
3691: my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
3692: if ($hashref) {
3693: while (my ($key,$value) = each(%$hashref)) {
3694: my $match = 1;
1.303 albertel 3695: my ($timestamp,$subj,$uname,$udom) =
3696: split(/:/,&unescape(&unescape($key)),5); # yes, twice really
1.299 raeburn 3697: $subj = &unescape($subj);
3698: unless ($startfilter eq '.' || !defined($startfilter)) {
3699: if ($timestamp < $startfilter) {
3700: $match = 0;
3701: }
3702: }
3703: unless ($endfilter eq '.' || !defined($endfilter)) {
3704: if ($timestamp > $endfilter) {
3705: $match = 0;
3706: }
3707: }
3708: unless (@senders < 1) {
3709: unless (grep/^$uname:$udom$/,@senders) {
3710: $match = 0;
3711: }
3712: }
3713: if ($match == 1) {
3714: $qresult.=$key.'='.$value.'&';
3715: }
3716: }
1.311 albertel 3717: if (&untie_domain_hash($hashref)) {
1.299 raeburn 3718: chop($qresult);
3719: &Reply($client, "$qresult\n", $userinput);
3720: } else {
3721: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3722: "while attempting dcmaildump\n", $userinput);
3723: }
3724: } else {
3725: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3726: "while attempting dcmaildump\n", $userinput);
3727: }
3728: return 1;
3729: }
3730:
3731: ®ister_handler("dcmaildump", \&dump_dcmail_handler, 0, 1, 0);
3732:
3733: #
3734: # Puts domain roles in nohist_domainroles database
3735: #
3736: # Parameters
3737: # $cmd - Command keyword that caused us to be dispatched.
3738: # $tail - Tail of the command. Consists of a colon separated:
3739: # domain - the domain whose roles we are recording
3740: # role - Consists of key=value pair
3741: # where key is unique role
3742: # and value is start/end date information
3743: # $client - Socket open on the client.
3744: #
3745: # Returns:
3746: # 1 - indicating processing should continue.
3747: # Side effects
3748: # reply is written to $client.
3749: #
3750:
3751: sub put_domainroles_handler {
3752: my ($cmd,$tail,$client) = @_;
3753:
3754: my $userinput = "$cmd:$tail";
3755: my ($udom,$what)=split(/:/,$tail);
3756: chomp($what);
3757: my @pairs=split(/\&/,$what);
3758: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
3759: if ($hashref) {
3760: foreach my $pair (@pairs) {
3761: my ($key,$value)=split(/=/,$pair);
3762: $hashref->{$key}=$value;
3763: }
1.311 albertel 3764: if (&untie_domain_hash($hashref)) {
1.299 raeburn 3765: &Reply($client, "ok\n", $userinput);
3766: } else {
3767: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3768: "while attempting domroleput\n", $userinput);
3769: }
3770: } else {
3771: &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
3772: "while attempting domroleput\n", $userinput);
3773: }
3774:
3775: return 1;
3776: }
3777:
3778: ®ister_handler("domroleput", \&put_domainroles_handler, 0, 1, 0);
3779:
3780: #
3781: # Retrieves domain roles from nohist_domainroles database
3782: # Returns to client an & separated list of key=value pairs,
3783: # where key is role and value is start and end date information.
3784: #
3785: # Parameters
3786: # $cmd - Command keyword that caused us to be dispatched.
3787: # $tail - Tail of the command. Consists of a colon separated:
3788: # domain - the domain whose domain roles table we dump
3789: # $client - Socket open on the client.
3790: #
3791: # Returns:
3792: # 1 - indicating processing should continue.
3793: # Side effects
3794: # reply (& separated list of role=start/end info pairs) is
3795: # written to $client.
3796: #
3797: sub dump_domainroles_handler {
3798: my ($cmd, $tail, $client) = @_;
3799:
3800: my $userinput = "$cmd:$tail";
3801: my ($udom,$startfilter,$endfilter,$rolesfilter) = split(/:/,$tail);
3802: chomp($rolesfilter);
3803: my @roles = ();
3804: if (defined($startfilter)) {
3805: $startfilter=&unescape($startfilter);
3806: } else {
3807: $startfilter='.';
3808: }
3809: if (defined($endfilter)) {
3810: $endfilter=&unescape($endfilter);
3811: } else {
3812: $endfilter='.';
3813: }
3814: if (defined($rolesfilter)) {
3815: $rolesfilter=&unescape($rolesfilter);
1.300 albertel 3816: @roles = split(/\&/,$rolesfilter);
1.299 raeburn 3817: }
3818:
3819: my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
3820: if ($hashref) {
3821: my $qresult = '';
3822: while (my ($key,$value) = each(%$hashref)) {
3823: my $match = 1;
3824: my ($start,$end) = split(/:/,&unescape($value));
3825: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,&unescape($key));
3826: unless ($startfilter eq '.' || !defined($startfilter)) {
3827: if ($start >= $startfilter) {
3828: $match = 0;
3829: }
3830: }
3831: unless ($endfilter eq '.' || !defined($endfilter)) {
3832: if ($end <= $endfilter) {
3833: $match = 0;
3834: }
3835: }
3836: unless (@roles < 1) {
3837: unless (grep/^$trole$/,@roles) {
3838: $match = 0;
3839: }
3840: }
3841: if ($match == 1) {
3842: $qresult.=$key.'='.$value.'&';
3843: }
3844: }
1.311 albertel 3845: if (&untie_domain_hash($hashref)) {
1.299 raeburn 3846: chop($qresult);
3847: &Reply($client, "$qresult\n", $userinput);
3848: } else {
3849: &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
3850: "while attempting domrolesdump\n", $userinput);
3851: }
3852: } else {
3853: &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
3854: "while attempting domrolesdump\n", $userinput);
3855: }
3856: return 1;
3857: }
3858:
3859: ®ister_handler("domrolesdump", \&dump_domainroles_handler, 0, 1, 0);
3860:
3861:
1.238 foxr 3862: # Process the tmpput command I'm not sure what this does.. Seems to
3863: # create a file in the lonDaemons/tmp directory of the form $id.tmp
3864: # where Id is the client's ip concatenated with a sequence number.
3865: # The file will contain some value that is passed in. Is this e.g.
3866: # a login token?
3867: #
3868: # Parameters:
3869: # $cmd - The command that got us dispatched.
3870: # $tail - The remainder of the request following $cmd:
3871: # In this case this will be the contents of the file.
3872: # $client - Socket connected to the client.
3873: # Returns:
3874: # 1 indicating processing can continue.
3875: # Side effects:
3876: # A file is created in the local filesystem.
3877: # A reply is sent to the client.
3878: sub tmp_put_handler {
3879: my ($cmd, $what, $client) = @_;
3880:
3881: my $userinput = "$cmd:$what"; # Reconstruct for logging.
3882:
1.347 ! raeburn 3883: my ($record,$context) = split(/:/,$what);
! 3884: if ($context ne '') {
! 3885: chomp($context);
! 3886: $context = &unescape($context);
! 3887: }
! 3888: my ($id,$store);
1.238 foxr 3889: $tmpsnum++;
1.347 ! raeburn 3890: if ($context eq 'resetpw') {
! 3891: $id = &md5_hex(&md5_hex(time.{}.rand().$$));
! 3892: } else {
! 3893: $id = $$.'_'.$clientip.'_'.$tmpsnum;
! 3894: }
1.238 foxr 3895: $id=~s/\W/\_/g;
1.347 ! raeburn 3896: $record=~s/\n//g;
1.238 foxr 3897: my $execdir=$perlvar{'lonDaemons'};
3898: if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
1.347 ! raeburn 3899: print $store $record;
1.238 foxr 3900: close $store;
3901: &Reply($client, "$id\n", $userinput);
3902: } else {
3903: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
3904: "while attempting tmpput\n", $userinput);
3905: }
3906: return 1;
3907:
3908: }
3909: ®ister_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
1.263 albertel 3910:
1.238 foxr 3911: # Processes the tmpget command. This command returns the contents
3912: # of a temporary resource file(?) created via tmpput.
3913: #
3914: # Paramters:
3915: # $cmd - Command that got us dispatched.
3916: # $id - Tail of the command, contain the id of the resource
3917: # we want to fetch.
3918: # $client - socket open on the client.
3919: # Return:
3920: # 1 - Inidcating processing can continue.
3921: # Side effects:
3922: # A reply is sent to the client.
3923: #
3924: sub tmp_get_handler {
3925: my ($cmd, $id, $client) = @_;
3926:
3927: my $userinput = "$cmd:$id";
3928:
3929:
3930: $id=~s/\W/\_/g;
3931: my $store;
3932: my $execdir=$perlvar{'lonDaemons'};
3933: if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
3934: my $reply=<$store>;
3935: &Reply( $client, "$reply\n", $userinput);
3936: close $store;
3937: } else {
3938: &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
3939: "while attempting tmpget\n", $userinput);
3940: }
3941:
3942: return 1;
3943: }
3944: ®ister_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
1.263 albertel 3945:
1.238 foxr 3946: #
3947: # Process the tmpdel command. This command deletes a temp resource
3948: # created by the tmpput command.
3949: #
3950: # Parameters:
3951: # $cmd - Command that got us here.
3952: # $id - Id of the temporary resource created.
3953: # $client - socket open on the client process.
3954: #
3955: # Returns:
3956: # 1 - Indicating processing should continue.
3957: # Side Effects:
3958: # A file is deleted
3959: # A reply is sent to the client.
3960: sub tmp_del_handler {
3961: my ($cmd, $id, $client) = @_;
3962:
3963: my $userinput= "$cmd:$id";
3964:
3965: chomp($id);
3966: $id=~s/\W/\_/g;
3967: my $execdir=$perlvar{'lonDaemons'};
3968: if (unlink("$execdir/tmp/$id.tmp")) {
3969: &Reply($client, "ok\n", $userinput);
3970: } else {
3971: &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
3972: "while attempting tmpdel\n", $userinput);
3973: }
3974:
3975: return 1;
3976:
3977: }
3978: ®ister_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
1.263 albertel 3979:
1.238 foxr 3980: #
1.246 foxr 3981: # Processes the setannounce command. This command
3982: # creates a file named announce.txt in the top directory of
3983: # the documentn root and sets its contents. The announce.txt file is
3984: # printed in its entirety at the LonCAPA login page. Note:
3985: # once the announcement.txt fileis created it cannot be deleted.
3986: # However, setting the contents of the file to empty removes the
3987: # announcement from the login page of loncapa so who cares.
3988: #
3989: # Parameters:
3990: # $cmd - The command that got us dispatched.
3991: # $announcement - The text of the announcement.
3992: # $client - Socket open on the client process.
3993: # Retunrns:
3994: # 1 - Indicating request processing should continue
3995: # Side Effects:
3996: # The file {DocRoot}/announcement.txt is created.
3997: # A reply is sent to $client.
3998: #
3999: sub set_announce_handler {
4000: my ($cmd, $announcement, $client) = @_;
4001:
4002: my $userinput = "$cmd:$announcement";
4003:
4004: chomp($announcement);
4005: $announcement=&unescape($announcement);
4006: if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
4007: '/announcement.txt')) {
4008: print $store $announcement;
4009: close $store;
4010: &Reply($client, "ok\n", $userinput);
4011: } else {
4012: &Failure($client, "error: ".($!+0)."\n", $userinput);
4013: }
4014:
4015: return 1;
4016: }
4017: ®ister_handler("setannounce", \&set_announce_handler, 0, 1, 0);
1.263 albertel 4018:
1.246 foxr 4019: #
4020: # Return the version of the daemon. This can be used to determine
4021: # the compatibility of cross version installations or, alternatively to
4022: # simply know who's out of date and who isn't. Note that the version
4023: # is returned concatenated with the tail.
4024: # Parameters:
4025: # $cmd - the request that dispatched to us.
4026: # $tail - Tail of the request (client's version?).
4027: # $client - Socket open on the client.
4028: #Returns:
4029: # 1 - continue processing requests.
4030: # Side Effects:
4031: # Replies with version to $client.
4032: sub get_version_handler {
4033: my ($cmd, $tail, $client) = @_;
4034:
4035: my $userinput = $cmd.$tail;
4036:
4037: &Reply($client, &version($userinput)."\n", $userinput);
4038:
4039:
4040: return 1;
4041: }
4042: ®ister_handler("version", \&get_version_handler, 0, 1, 0);
1.263 albertel 4043:
1.246 foxr 4044: # Set the current host and domain. This is used to support
4045: # multihomed systems. Each IP of the system, or even separate daemons
4046: # on the same IP can be treated as handling a separate lonCAPA virtual
4047: # machine. This command selects the virtual lonCAPA. The client always
4048: # knows the right one since it is lonc and it is selecting the domain/system
4049: # from the hosts.tab file.
4050: # Parameters:
4051: # $cmd - Command that dispatched us.
4052: # $tail - Tail of the command (domain/host requested).
4053: # $socket - Socket open on the client.
4054: #
4055: # Returns:
4056: # 1 - Indicates the program should continue to process requests.
4057: # Side-effects:
4058: # The default domain/system context is modified for this daemon.
4059: # a reply is sent to the client.
4060: #
4061: sub set_virtual_host_handler {
4062: my ($cmd, $tail, $socket) = @_;
4063:
4064: my $userinput ="$cmd:$tail";
4065:
4066: &Reply($client, &sethost($userinput)."\n", $userinput);
4067:
4068:
4069: return 1;
4070: }
1.247 albertel 4071: ®ister_handler("sethost", \&set_virtual_host_handler, 0, 1, 0);
1.246 foxr 4072:
4073: # Process a request to exit:
4074: # - "bye" is sent to the client.
4075: # - The client socket is shutdown and closed.
4076: # - We indicate to the caller that we should exit.
4077: # Formal Parameters:
4078: # $cmd - The command that got us here.
4079: # $tail - Tail of the command (empty).
4080: # $client - Socket open on the tail.
4081: # Returns:
4082: # 0 - Indicating the program should exit!!
4083: #
4084: sub exit_handler {
4085: my ($cmd, $tail, $client) = @_;
4086:
4087: my $userinput = "$cmd:$tail";
4088:
4089: &logthis("Client $clientip ($clientname) hanging up: $userinput");
4090: &Reply($client, "bye\n", $userinput);
4091: $client->shutdown(2); # shutdown the socket forcibly.
4092: $client->close();
4093:
4094: return 0;
4095: }
1.248 foxr 4096: ®ister_handler("exit", \&exit_handler, 0,1,1);
4097: ®ister_handler("init", \&exit_handler, 0,1,1);
4098: ®ister_handler("quit", \&exit_handler, 0,1,1);
4099:
4100: # Determine if auto-enrollment is enabled.
4101: # Note that the original had what I believe to be a defect.
4102: # The original returned 0 if the requestor was not a registerd client.
4103: # It should return "refused".
4104: # Formal Parameters:
4105: # $cmd - The command that invoked us.
4106: # $tail - The tail of the command (Extra command parameters.
4107: # $client - The socket open on the client that issued the request.
4108: # Returns:
4109: # 1 - Indicating processing should continue.
4110: #
4111: sub enrollment_enabled_handler {
4112: my ($cmd, $tail, $client) = @_;
4113: my $userinput = $cmd.":".$tail; # For logging purposes.
4114:
4115:
1.337 albertel 4116: my ($cdom) = split(/:/, $tail, 2); # Domain we're asking about.
4117:
1.248 foxr 4118: my $outcome = &localenroll::run($cdom);
4119: &Reply($client, "$outcome\n", $userinput);
4120:
4121: return 1;
4122: }
4123: ®ister_handler("autorun", \&enrollment_enabled_handler, 0, 1, 0);
4124:
4125: # Get the official sections for which auto-enrollment is possible.
4126: # Since the admin people won't know about 'unofficial sections'
4127: # we cannot auto-enroll on them.
4128: # Formal Parameters:
4129: # $cmd - The command request that got us dispatched here.
4130: # $tail - The remainder of the request. In our case this
4131: # will be split into:
4132: # $coursecode - The course name from the admin point of view.
4133: # $cdom - The course's domain(?).
4134: # $client - Socket open on the client.
4135: # Returns:
4136: # 1 - Indiciting processing should continue.
4137: #
4138: sub get_sections_handler {
4139: my ($cmd, $tail, $client) = @_;
4140: my $userinput = "$cmd:$tail";
4141:
4142: my ($coursecode, $cdom) = split(/:/, $tail);
4143: my @secs = &localenroll::get_sections($coursecode,$cdom);
4144: my $seclist = &escape(join(':',@secs));
4145:
4146: &Reply($client, "$seclist\n", $userinput);
4147:
4148:
4149: return 1;
4150: }
4151: ®ister_handler("autogetsections", \&get_sections_handler, 0, 1, 0);
4152:
4153: # Validate the owner of a new course section.
4154: #
4155: # Formal Parameters:
4156: # $cmd - Command that got us dispatched.
4157: # $tail - the remainder of the command. For us this consists of a
4158: # colon separated string containing:
4159: # $inst - Course Id from the institutions point of view.
4160: # $owner - Proposed owner of the course.
4161: # $cdom - Domain of the course (from the institutions
4162: # point of view?)..
4163: # $client - Socket open on the client.
4164: #
4165: # Returns:
4166: # 1 - Processing should continue.
4167: #
4168: sub validate_course_owner_handler {
4169: my ($cmd, $tail, $client) = @_;
4170: my $userinput = "$cmd:$tail";
4171: my ($inst_course_id, $owner, $cdom) = split(/:/, $tail);
4172:
1.336 raeburn 4173: $owner = &unescape($owner);
1.248 foxr 4174: my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom);
4175: &Reply($client, "$outcome\n", $userinput);
4176:
4177:
4178:
4179: return 1;
4180: }
4181: ®ister_handler("autonewcourse", \&validate_course_owner_handler, 0, 1, 0);
1.263 albertel 4182:
1.248 foxr 4183: #
4184: # Validate a course section in the official schedule of classes
4185: # from the institutions point of view (part of autoenrollment).
4186: #
4187: # Formal Parameters:
4188: # $cmd - The command request that got us dispatched.
4189: # $tail - The tail of the command. In this case,
4190: # this is a colon separated set of words that will be split
4191: # into:
4192: # $inst_course_id - The course/section id from the
4193: # institutions point of view.
4194: # $cdom - The domain from the institutions
4195: # point of view.
4196: # $client - Socket open on the client.
4197: # Returns:
4198: # 1 - Indicating processing should continue.
4199: #
4200: sub validate_course_section_handler {
4201: my ($cmd, $tail, $client) = @_;
4202: my $userinput = "$cmd:$tail";
4203: my ($inst_course_id, $cdom) = split(/:/, $tail);
4204:
4205: my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
4206: &Reply($client, "$outcome\n", $userinput);
4207:
4208:
4209: return 1;
4210: }
4211: ®ister_handler("autovalidatecourse", \&validate_course_section_handler, 0, 1, 0);
4212:
4213: #
1.340 raeburn 4214: # Validate course owner's access to enrollment data for specific class section.
4215: #
4216: #
4217: # Formal Parameters:
4218: # $cmd - The command request that got us dispatched.
4219: # $tail - The tail of the command. In this case this is a colon separated
4220: # set of words that will be split into:
4221: # $inst_class - Institutional code for the specific class section
4222: # $courseowner - The escaped username:domain of the course owner
4223: # $cdom - The domain of the course from the institution's
4224: # point of view.
4225: # $client - The socket open on the client.
4226: # Returns:
4227: # 1 - continue processing.
4228: #
4229:
4230: sub validate_class_access_handler {
4231: my ($cmd, $tail, $client) = @_;
4232: my $userinput = "$cmd:$tail";
4233: my ($inst_class,$courseowner,$cdom) = split(/:/, $tail);
4234: $courseowner = &unescape($courseowner);
1.341 albertel 4235: my $outcome;
4236: eval {
4237: local($SIG{__DIE__})='DEFAULT';
4238: $outcome=&localenroll::check_section($inst_class,$courseowner,$cdom);
4239: };
1.340 raeburn 4240: &Reply($client,"$outcome\n", $userinput);
4241:
4242: return 1;
4243: }
4244: ®ister_handler("autovalidateclass_sec", \&validate_class_access_handler, 0, 1, 0);
4245:
4246: #
4247: # Create a password for a new LON-CAPA user added by auto-enrollment.
4248: # Only used for case where authentication method for new user is localauth
1.248 foxr 4249: #
4250: # Formal Parameters:
4251: # $cmd - The command request that got us dispatched.
4252: # $tail - The tail of the command. In this case this is a colon separated
4253: # set of words that will be split into:
1.340 raeburn 4254: # $authparam - An authentication parameter (localauth parameter).
1.248 foxr 4255: # $cdom - The domain of the course from the institution's
4256: # point of view.
4257: # $client - The socket open on the client.
4258: # Returns:
4259: # 1 - continue processing.
4260: #
4261: sub create_auto_enroll_password_handler {
4262: my ($cmd, $tail, $client) = @_;
4263: my $userinput = "$cmd:$tail";
4264:
4265: my ($authparam, $cdom) = split(/:/, $userinput);
4266:
4267: my ($create_passwd,$authchk);
4268: ($authparam,
4269: $create_passwd,
4270: $authchk) = &localenroll::create_password($authparam,$cdom);
4271:
4272: &Reply($client, &escape($authparam.':'.$create_passwd.':'.$authchk)."\n",
4273: $userinput);
4274:
4275:
4276: return 1;
4277: }
4278: ®ister_handler("autocreatepassword", \&create_auto_enroll_password_handler,
4279: 0, 1, 0);
4280:
4281: # Retrieve and remove temporary files created by/during autoenrollment.
4282: #
4283: # Formal Parameters:
4284: # $cmd - The command that got us dispatched.
4285: # $tail - The tail of the command. In our case this is a colon
4286: # separated list that will be split into:
4287: # $filename - The name of the file to remove.
4288: # The filename is given as a path relative to
4289: # the LonCAPA temp file directory.
4290: # $client - Socket open on the client.
4291: #
4292: # Returns:
4293: # 1 - Continue processing.
4294: sub retrieve_auto_file_handler {
4295: my ($cmd, $tail, $client) = @_;
4296: my $userinput = "cmd:$tail";
4297:
4298: my ($filename) = split(/:/, $tail);
4299:
4300: my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
4301: if ( (-e $source) && ($filename ne '') ) {
4302: my $reply = '';
4303: if (open(my $fh,$source)) {
4304: while (<$fh>) {
4305: chomp($_);
4306: $_ =~ s/^\s+//g;
4307: $_ =~ s/\s+$//g;
4308: $reply .= $_;
4309: }
4310: close($fh);
4311: &Reply($client, &escape($reply)."\n", $userinput);
4312:
4313: # Does this have to be uncommented??!? (RF).
4314: #
4315: # unlink($source);
4316: } else {
4317: &Failure($client, "error\n", $userinput);
4318: }
4319: } else {
4320: &Failure($client, "error\n", $userinput);
4321: }
4322:
4323:
4324: return 1;
4325: }
4326: ®ister_handler("autoretrieve", \&retrieve_auto_file_handler, 0,1,0);
4327:
4328: #
4329: # Read and retrieve institutional code format (for support form).
4330: # Formal Parameters:
4331: # $cmd - Command that dispatched us.
4332: # $tail - Tail of the command. In this case it conatins
4333: # the course domain and the coursename.
4334: # $client - Socket open on the client.
4335: # Returns:
4336: # 1 - Continue processing.
4337: #
4338: sub get_institutional_code_format_handler {
4339: my ($cmd, $tail, $client) = @_;
4340: my $userinput = "$cmd:$tail";
4341:
4342: my $reply;
4343: my($cdom,$course) = split(/:/,$tail);
4344: my @pairs = split/\&/,$course;
4345: my %instcodes = ();
4346: my %codes = ();
4347: my @codetitles = ();
4348: my %cat_titles = ();
4349: my %cat_order = ();
4350: foreach (@pairs) {
4351: my ($key,$value) = split/=/,$_;
4352: $instcodes{&unescape($key)} = &unescape($value);
4353: }
4354: my $formatreply = &localenroll::instcode_format($cdom,
4355: \%instcodes,
4356: \%codes,
4357: \@codetitles,
4358: \%cat_titles,
4359: \%cat_order);
4360: if ($formatreply eq 'ok') {
4361: my $codes_str = &hash2str(%codes);
4362: my $codetitles_str = &array2str(@codetitles);
4363: my $cat_titles_str = &hash2str(%cat_titles);
4364: my $cat_order_str = &hash2str(%cat_order);
4365: &Reply($client,
4366: $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'
4367: .$cat_order_str."\n",
4368: $userinput);
4369: } else {
4370: # this else branch added by RF since if not ok, lonc will
4371: # hang waiting on reply until timeout.
4372: #
4373: &Reply($client, "format_error\n", $userinput);
4374: }
4375:
4376: return 1;
4377: }
1.265 albertel 4378: ®ister_handler("autoinstcodeformat",
4379: \&get_institutional_code_format_handler,0,1,0);
1.246 foxr 4380:
1.345 raeburn 4381: sub get_institutional_defaults_handler {
4382: my ($cmd, $tail, $client) = @_;
4383: my $userinput = "$cmd:$tail";
4384:
4385: my $dom = $tail;
4386: my %defaults_hash;
4387: my @code_order;
4388: my $outcome;
4389: eval {
4390: local($SIG{__DIE__})='DEFAULT';
4391: $outcome = &localenroll::instcode_defaults($dom,\%defaults_hash,
4392: \@code_order);
4393: };
4394: if (!$@) {
4395: if ($outcome eq 'ok') {
4396: my $result='';
4397: while (my ($key,$value) = each(%defaults_hash)) {
4398: $result.=&escape($key).'='.&escape($value).'&';
4399: }
4400: $result .= 'code_order='.&escape(join('&',@code_order));
4401: &Reply($client,$result."\n",$userinput);
4402: } else {
4403: &Reply($client,"error\n", $userinput);
4404: }
4405: } else {
4406: &Failure($client,"unknown_cmd\n",$userinput);
4407: }
4408: }
4409: ®ister_handler("autoinstcodedefaults",
4410: \&get_institutional_defaults_handler,0,1,0);
4411:
4412:
1.317 raeburn 4413: # Get domain specific conditions for import of student photographs to a course
4414: #
4415: # Retrieves information from photo_permission subroutine in localenroll.
4416: # Returns outcome (ok) if no processing errors, and whether course owner is
4417: # required to accept conditions of use (yes/no).
4418: #
4419: #
4420: sub photo_permission_handler {
4421: my ($cmd, $tail, $client) = @_;
4422: my $userinput = "$cmd:$tail";
4423: my $cdom = $tail;
4424: my ($perm_reqd,$conditions);
1.320 albertel 4425: my $outcome;
4426: eval {
4427: local($SIG{__DIE__})='DEFAULT';
4428: $outcome = &localenroll::photo_permission($cdom,\$perm_reqd,
4429: \$conditions);
4430: };
4431: if (!$@) {
4432: &Reply($client, &escape($outcome.':'.$perm_reqd.':'. $conditions)."\n",
4433: $userinput);
4434: } else {
4435: &Failure($client,"unknown_cmd\n",$userinput);
4436: }
4437: return 1;
1.317 raeburn 4438: }
4439: ®ister_handler("autophotopermission",\&photo_permission_handler,0,1,0);
4440:
4441: #
4442: # Checks if student photo is available for a user in the domain, in the user's
4443: # directory (in /userfiles/internal/studentphoto.jpg).
4444: # Uses localstudentphoto:fetch() to ensure there is an up to date copy of
4445: # the student's photo.
4446:
4447: sub photo_check_handler {
4448: my ($cmd, $tail, $client) = @_;
4449: my $userinput = "$cmd:$tail";
4450: my ($udom,$uname,$pid) = split(/:/,$tail);
4451: $udom = &unescape($udom);
4452: $uname = &unescape($uname);
4453: $pid = &unescape($pid);
4454: my $path=&propath($udom,$uname).'/userfiles/internal/';
4455: if (!-e $path) {
4456: &mkpath($path);
4457: }
4458: my $response;
4459: my $result = &localstudentphoto::fetch($udom,$uname,$pid,\$response);
4460: $result .= ':'.$response;
4461: &Reply($client, &escape($result)."\n",$userinput);
1.320 albertel 4462: return 1;
1.317 raeburn 4463: }
4464: ®ister_handler("autophotocheck",\&photo_check_handler,0,1,0);
4465:
4466: #
4467: # Retrieve information from localenroll about whether to provide a button
4468: # for users who have enbled import of student photos to initiate an
4469: # update of photo files for registered students. Also include
4470: # comment to display alongside button.
4471:
4472: sub photo_choice_handler {
4473: my ($cmd, $tail, $client) = @_;
4474: my $userinput = "$cmd:$tail";
4475: my $cdom = &unescape($tail);
1.320 albertel 4476: my ($update,$comment);
4477: eval {
4478: local($SIG{__DIE__})='DEFAULT';
4479: ($update,$comment) = &localenroll::manager_photo_update($cdom);
4480: };
4481: if (!$@) {
4482: &Reply($client,&escape($update).':'.&escape($comment)."\n",$userinput);
4483: } else {
4484: &Failure($client,"unknown_cmd\n",$userinput);
4485: }
4486: return 1;
1.317 raeburn 4487: }
4488: ®ister_handler("autophotochoice",\&photo_choice_handler,0,1,0);
4489:
1.265 albertel 4490: #
4491: # Gets a student's photo to exist (in the correct image type) in the user's
4492: # directory.
4493: # Formal Parameters:
4494: # $cmd - The command request that got us dispatched.
4495: # $tail - A colon separated set of words that will be split into:
4496: # $domain - student's domain
4497: # $uname - student username
4498: # $type - image type desired
4499: # $client - The socket open on the client.
4500: # Returns:
4501: # 1 - continue processing.
1.317 raeburn 4502:
1.265 albertel 4503: sub student_photo_handler {
4504: my ($cmd, $tail, $client) = @_;
1.317 raeburn 4505: my ($domain,$uname,$ext,$type) = split(/:/, $tail);
1.265 albertel 4506:
1.317 raeburn 4507: my $path=&propath($domain,$uname). '/userfiles/internal/';
4508: my $filename = 'studentphoto.'.$ext;
4509: if ($type eq 'thumbnail') {
4510: $filename = 'studentphoto_tn.'.$ext;
4511: }
4512: if (-e $path.$filename) {
1.265 albertel 4513: &Reply($client,"ok\n","$cmd:$tail");
4514: return 1;
4515: }
4516: &mkpath($path);
1.317 raeburn 4517: my $file;
4518: if ($type eq 'thumbnail') {
1.320 albertel 4519: eval {
4520: local($SIG{__DIE__})='DEFAULT';
4521: $file=&localstudentphoto::fetch_thumbnail($domain,$uname);
4522: };
1.317 raeburn 4523: } else {
4524: $file=&localstudentphoto::fetch($domain,$uname);
4525: }
1.265 albertel 4526: if (!$file) {
4527: &Failure($client,"unavailable\n","$cmd:$tail");
4528: return 1;
4529: }
1.317 raeburn 4530: if (!-e $path.$filename) { &convert_photo($file,$path.$filename); }
4531: if (-e $path.$filename) {
1.265 albertel 4532: &Reply($client,"ok\n","$cmd:$tail");
4533: return 1;
4534: }
4535: &Failure($client,"unable_to_convert\n","$cmd:$tail");
4536: return 1;
4537: }
4538: ®ister_handler("studentphoto", \&student_photo_handler, 0, 1, 0);
1.246 foxr 4539:
1.264 albertel 4540: # mkpath makes all directories for a file, expects an absolute path with a
4541: # file or a trailing / if just a dir is passed
4542: # returns 1 on success 0 on failure
4543: sub mkpath {
4544: my ($file)=@_;
4545: my @parts=split(/\//,$file,-1);
4546: my $now=$parts[0].'/'.$parts[1].'/'.$parts[2];
4547: for (my $i=3;$i<= ($#parts-1);$i++) {
1.265 albertel 4548: $now.='/'.$parts[$i];
1.264 albertel 4549: if (!-e $now) {
4550: if (!mkdir($now,0770)) { return 0; }
4551: }
4552: }
4553: return 1;
4554: }
4555:
1.207 foxr 4556: #---------------------------------------------------------------
4557: #
4558: # Getting, decoding and dispatching requests:
4559: #
4560: #
4561: # Get a Request:
4562: # Gets a Request message from the client. The transaction
4563: # is defined as a 'line' of text. We remove the new line
4564: # from the text line.
1.226 foxr 4565: #
1.211 albertel 4566: sub get_request {
1.207 foxr 4567: my $input = <$client>;
4568: chomp($input);
1.226 foxr 4569:
1.234 foxr 4570: &Debug("get_request: Request = $input\n");
1.207 foxr 4571:
4572: &status('Processing '.$clientname.':'.$input);
4573:
4574: return $input;
4575: }
1.212 foxr 4576: #---------------------------------------------------------------
4577: #
4578: # Process a request. This sub should shrink as each action
4579: # gets farmed out into a separat sub that is registered
4580: # with the dispatch hash.
4581: #
4582: # Parameters:
4583: # user_input - The request received from the client (lonc).
4584: # Returns:
4585: # true to keep processing, false if caller should exit.
4586: #
4587: sub process_request {
4588: my ($userinput) = @_; # Easier for now to break style than to
4589: # fix all the userinput -> user_input.
4590: my $wasenc = 0; # True if request was encrypted.
4591: # ------------------------------------------------------------ See if encrypted
1.322 albertel 4592: # for command
4593: # sethost:<server>
4594: # <command>:<args>
4595: # we just send it to the processor
4596: # for
4597: # sethost:<server>:<command>:<args>
4598: # we do the implict set host and then do the command
4599: if ($userinput =~ /^sethost:/) {
4600: (my $cmd,my $newid,$userinput) = split(':',$userinput,3);
4601: if (defined($userinput)) {
4602: &sethost("$cmd:$newid");
4603: } else {
4604: $userinput = "$cmd:$newid";
4605: }
4606: }
4607:
1.212 foxr 4608: if ($userinput =~ /^enc/) {
4609: $userinput = decipher($userinput);
4610: $wasenc=1;
4611: if(!$userinput) { # Cipher not defined.
1.251 foxr 4612: &Failure($client, "error: Encrypted data without negotated key\n");
1.212 foxr 4613: return 0;
4614: }
4615: }
4616: Debug("process_request: $userinput\n");
4617:
1.213 foxr 4618: #
4619: # The 'correct way' to add a command to lond is now to
4620: # write a sub to execute it and Add it to the command dispatch
4621: # hash via a call to register_handler.. The comments to that
4622: # sub should give you enough to go on to show how to do this
4623: # along with the examples that are building up as this code
4624: # is getting refactored. Until all branches of the
4625: # if/elseif monster below have been factored out into
4626: # separate procesor subs, if the dispatch hash is missing
4627: # the command keyword, we will fall through to the remainder
4628: # of the if/else chain below in order to keep this thing in
4629: # working order throughout the transmogrification.
4630:
4631: my ($command, $tail) = split(/:/, $userinput, 2);
4632: chomp($command);
4633: chomp($tail);
4634: $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
1.214 foxr 4635: $command =~ s/(\r)//; # And this too for parameterless commands.
4636: if(!$tail) {
4637: $tail =""; # defined but blank.
4638: }
1.213 foxr 4639:
4640: &Debug("Command received: $command, encoded = $wasenc");
4641:
4642: if(defined $Dispatcher{$command}) {
4643:
4644: my $dispatch_info = $Dispatcher{$command};
4645: my $handler = $$dispatch_info[0];
4646: my $need_encode = $$dispatch_info[1];
4647: my $client_types = $$dispatch_info[2];
4648: Debug("Matched dispatch hash: mustencode: $need_encode "
4649: ."ClientType $client_types");
4650:
4651: # Validate the request:
4652:
4653: my $ok = 1;
4654: my $requesterprivs = 0;
4655: if(&isClient()) {
4656: $requesterprivs |= $CLIENT_OK;
4657: }
4658: if(&isManager()) {
4659: $requesterprivs |= $MANAGER_OK;
4660: }
4661: if($need_encode && (!$wasenc)) {
4662: Debug("Must encode but wasn't: $need_encode $wasenc");
4663: $ok = 0;
4664: }
4665: if(($client_types & $requesterprivs) == 0) {
4666: Debug("Client not privileged to do this operation");
4667: $ok = 0;
4668: }
4669:
4670: if($ok) {
4671: Debug("Dispatching to handler $command $tail");
4672: my $keep_going = &$handler($command, $tail, $client);
4673: return $keep_going;
4674: } else {
4675: Debug("Refusing to dispatch because client did not match requirements");
4676: Failure($client, "refused\n", $userinput);
4677: return 1;
4678: }
4679:
4680: }
4681:
1.262 foxr 4682: print $client "unknown_cmd\n";
1.212 foxr 4683: # -------------------------------------------------------------------- complete
4684: Debug("process_request - returning 1");
4685: return 1;
4686: }
1.207 foxr 4687: #
4688: # Decipher encoded traffic
4689: # Parameters:
4690: # input - Encoded data.
4691: # Returns:
4692: # Decoded data or undef if encryption key was not yet negotiated.
4693: # Implicit input:
4694: # cipher - This global holds the negotiated encryption key.
4695: #
1.211 albertel 4696: sub decipher {
1.207 foxr 4697: my ($input) = @_;
4698: my $output = '';
1.212 foxr 4699:
4700:
1.207 foxr 4701: if($cipher) {
4702: my($enc, $enclength, $encinput) = split(/:/, $input);
4703: for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
4704: $output .=
4705: $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
4706: }
4707: return substr($output, 0, $enclength);
4708: } else {
4709: return undef;
4710: }
4711: }
4712:
4713: #
4714: # Register a command processor. This function is invoked to register a sub
4715: # to process a request. Once registered, the ProcessRequest sub can automatically
4716: # dispatch requests to an appropriate sub, and do the top level validity checking
4717: # as well:
4718: # - Is the keyword recognized.
4719: # - Is the proper client type attempting the request.
4720: # - Is the request encrypted if it has to be.
4721: # Parameters:
4722: # $request_name - Name of the request being registered.
4723: # This is the command request that will match
4724: # against the hash keywords to lookup the information
4725: # associated with the dispatch information.
4726: # $procedure - Reference to a sub to call to process the request.
4727: # All subs get called as follows:
4728: # Procedure($cmd, $tail, $replyfd, $key)
4729: # $cmd - the actual keyword that invoked us.
4730: # $tail - the tail of the request that invoked us.
4731: # $replyfd- File descriptor connected to the client
4732: # $must_encode - True if the request must be encoded to be good.
4733: # $client_ok - True if it's ok for a client to request this.
4734: # $manager_ok - True if it's ok for a manager to request this.
4735: # Side effects:
4736: # - On success, the Dispatcher hash has an entry added for the key $RequestName
4737: # - On failure, the program will die as it's a bad internal bug to try to
4738: # register a duplicate command handler.
4739: #
1.211 albertel 4740: sub register_handler {
1.212 foxr 4741: my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok) = @_;
1.207 foxr 4742:
4743: # Don't allow duplication#
4744:
4745: if (defined $Dispatcher{$request_name}) {
4746: die "Attempting to define a duplicate request handler for $request_name\n";
4747: }
4748: # Build the client type mask:
4749:
4750: my $client_type_mask = 0;
4751: if($client_ok) {
4752: $client_type_mask |= $CLIENT_OK;
4753: }
4754: if($manager_ok) {
4755: $client_type_mask |= $MANAGER_OK;
4756: }
4757:
4758: # Enter the hash:
4759:
4760: my @entry = ($procedure, $must_encode, $client_type_mask);
4761:
4762: $Dispatcher{$request_name} = \@entry;
4763:
4764: }
4765:
4766:
4767: #------------------------------------------------------------------
4768:
4769:
4770:
4771:
1.141 foxr 4772: #
1.96 foxr 4773: # Convert an error return code from lcpasswd to a string value.
4774: #
4775: sub lcpasswdstrerror {
4776: my $ErrorCode = shift;
1.97 foxr 4777: if(($ErrorCode < 0) || ($ErrorCode > $lastpwderror)) {
1.96 foxr 4778: return "lcpasswd Unrecognized error return value ".$ErrorCode;
4779: } else {
1.98 foxr 4780: return $passwderrors[$ErrorCode];
1.96 foxr 4781: }
4782: }
4783:
1.97 foxr 4784: #
4785: # Convert an error return code from lcuseradd to a string value:
4786: #
4787: sub lcuseraddstrerror {
4788: my $ErrorCode = shift;
4789: if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {
4790: return "lcuseradd - Unrecognized error code: ".$ErrorCode;
4791: } else {
1.98 foxr 4792: return $adderrors[$ErrorCode];
1.97 foxr 4793: }
4794: }
4795:
1.23 harris41 4796: # grabs exception and records it to log before exiting
4797: sub catchexception {
1.27 albertel 4798: my ($error)=@_;
1.25 www 4799: $SIG{'QUIT'}='DEFAULT';
4800: $SIG{__DIE__}='DEFAULT';
1.165 albertel 4801: &status("Catching exception");
1.190 albertel 4802: &logthis("<font color='red'>CRITICAL: "
1.134 albertel 4803: ."ABNORMAL EXIT. Child $$ for server $thisserver died through "
1.27 albertel 4804: ."a crash with this error msg->[$error]</font>");
1.57 www 4805: &logthis('Famous last words: '.$status.' - '.$lastlog);
1.27 albertel 4806: if ($client) { print $client "error: $error\n"; }
1.59 www 4807: $server->close();
1.27 albertel 4808: die($error);
1.23 harris41 4809: }
1.63 www 4810: sub timeout {
1.165 albertel 4811: &status("Handling Timeout");
1.190 albertel 4812: &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
1.63 www 4813: &catchexception('Timeout');
4814: }
1.22 harris41 4815: # -------------------------------- Set signal handlers to record abnormal exits
4816:
1.226 foxr 4817:
1.22 harris41 4818: $SIG{'QUIT'}=\&catchexception;
4819: $SIG{__DIE__}=\&catchexception;
4820:
1.81 matthew 4821: # ---------------------------------- Read loncapa_apache.conf and loncapa.conf
1.95 harris41 4822: &status("Read loncapa.conf and loncapa_apache.conf");
4823: my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');
1.141 foxr 4824: %perlvar=%{$perlvarref};
1.80 harris41 4825: undef $perlvarref;
1.19 www 4826:
1.35 harris41 4827: # ----------------------------- Make sure this process is running from user=www
4828: my $wwwid=getpwnam('www');
4829: if ($wwwid!=$<) {
1.134 albertel 4830: my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
4831: my $subj="LON: $currenthostid User ID mismatch";
1.37 harris41 4832: system("echo 'User ID mismatch. lond must be run as user www.' |\
1.35 harris41 4833: mailto $emailto -s '$subj' > /dev/null");
4834: exit 1;
4835: }
4836:
1.19 www 4837: # --------------------------------------------- Check if other instance running
4838:
4839: my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
4840:
4841: if (-e $pidfile) {
4842: my $lfh=IO::File->new("$pidfile");
4843: my $pide=<$lfh>;
4844: chomp($pide);
1.29 harris41 4845: if (kill 0 => $pide) { die "already running"; }
1.19 www 4846: }
1.1 albertel 4847:
4848: # ------------------------------------------------------------- Read hosts file
4849:
4850:
4851:
4852: # establish SERVER socket, bind and listen.
4853: $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
4854: Type => SOCK_STREAM,
4855: Proto => 'tcp',
4856: Reuse => 1,
4857: Listen => 10 )
1.29 harris41 4858: or die "making socket: $@\n";
1.1 albertel 4859:
4860: # --------------------------------------------------------- Do global variables
4861:
4862: # global variables
4863:
1.134 albertel 4864: my %children = (); # keys are current child process IDs
1.1 albertel 4865:
4866: sub REAPER { # takes care of dead children
4867: $SIG{CHLD} = \&REAPER;
1.165 albertel 4868: &status("Handling child death");
1.178 foxr 4869: my $pid;
4870: do {
4871: $pid = waitpid(-1,&WNOHANG());
4872: if (defined($children{$pid})) {
4873: &logthis("Child $pid died");
4874: delete($children{$pid});
1.183 albertel 4875: } elsif ($pid > 0) {
1.178 foxr 4876: &logthis("Unknown Child $pid died");
4877: }
4878: } while ( $pid > 0 );
4879: foreach my $child (keys(%children)) {
4880: $pid = waitpid($child,&WNOHANG());
4881: if ($pid > 0) {
4882: &logthis("Child $child - $pid looks like we missed it's death");
4883: delete($children{$pid});
4884: }
1.176 albertel 4885: }
1.165 albertel 4886: &status("Finished Handling child death");
1.1 albertel 4887: }
4888:
4889: sub HUNTSMAN { # signal handler for SIGINT
1.165 albertel 4890: &status("Killing children (INT)");
1.1 albertel 4891: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
4892: kill 'INT' => keys %children;
1.59 www 4893: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.1 albertel 4894: my $execdir=$perlvar{'lonDaemons'};
4895: unlink("$execdir/logs/lond.pid");
1.190 albertel 4896: &logthis("<font color='red'>CRITICAL: Shutting down</font>");
1.165 albertel 4897: &status("Done killing children");
1.1 albertel 4898: exit; # clean up with dignity
4899: }
4900:
4901: sub HUPSMAN { # signal handler for SIGHUP
4902: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
1.165 albertel 4903: &status("Killing children for restart (HUP)");
1.1 albertel 4904: kill 'INT' => keys %children;
1.59 www 4905: &logthis("Free socket: ".shutdown($server,2)); # free up socket
1.190 albertel 4906: &logthis("<font color='red'>CRITICAL: Restarting</font>");
1.134 albertel 4907: my $execdir=$perlvar{'lonDaemons'};
1.30 harris41 4908: unlink("$execdir/logs/lond.pid");
1.165 albertel 4909: &status("Restarting self (HUP)");
1.1 albertel 4910: exec("$execdir/lond"); # here we go again
4911: }
4912:
1.144 foxr 4913: #
1.148 foxr 4914: # Kill off hashes that describe the host table prior to re-reading it.
4915: # Hashes affected are:
1.200 matthew 4916: # %hostid, %hostdom %hostip %hostdns.
1.148 foxr 4917: #
4918: sub KillHostHashes {
4919: foreach my $key (keys %hostid) {
4920: delete $hostid{$key};
4921: }
4922: foreach my $key (keys %hostdom) {
4923: delete $hostdom{$key};
4924: }
4925: foreach my $key (keys %hostip) {
4926: delete $hostip{$key};
4927: }
1.200 matthew 4928: foreach my $key (keys %hostdns) {
4929: delete $hostdns{$key};
4930: }
1.148 foxr 4931: }
4932: #
4933: # Read in the host table from file and distribute it into the various hashes:
4934: #
4935: # - %hostid - Indexed by IP, the loncapa hostname.
4936: # - %hostdom - Indexed by loncapa hostname, the domain.
4937: # - %hostip - Indexed by hostid, the Ip address of the host.
4938: sub ReadHostTable {
4939:
4940: open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";
1.200 matthew 4941: my $myloncapaname = $perlvar{'lonHostID'};
4942: Debug("My loncapa name is : $myloncapaname");
1.296 albertel 4943: my %name_to_ip;
1.148 foxr 4944: while (my $configline=<CONFIG>) {
1.277 albertel 4945: if ($configline !~ /^\s*\#/ && $configline !~ /^\s*$/ ) {
4946: my ($id,$domain,$role,$name)=split(/:/,$configline);
4947: $name=~s/\s//g;
1.296 albertel 4948: my $ip;
4949: if (!exists($name_to_ip{$name})) {
4950: $ip = gethostbyname($name);
4951: if (!$ip || length($ip) ne 4) {
4952: &logthis("Skipping host $id name $name no IP found\n");
4953: next;
4954: }
4955: $ip=inet_ntoa($ip);
4956: $name_to_ip{$name} = $ip;
4957: } else {
4958: $ip = $name_to_ip{$name};
1.277 albertel 4959: }
1.200 matthew 4960: $hostid{$ip}=$id; # LonCAPA name of host by IP.
4961: $hostdom{$id}=$domain; # LonCAPA domain name of host.
1.307 albertel 4962: $hostname{$id}=$name; # LonCAPA name -> DNS name
1.277 albertel 4963: $hostip{$id}=$ip; # IP address of host.
1.200 matthew 4964: $hostdns{$name} = $id; # LonCAPA name of host by DNS.
4965:
4966: if ($id eq $perlvar{'lonHostID'}) {
4967: Debug("Found me in the host table: $name");
4968: $thisserver=$name;
4969: }
1.178 foxr 4970: }
1.148 foxr 4971: }
4972: close(CONFIG);
4973: }
4974: #
4975: # Reload the Apache daemon's state.
1.150 foxr 4976: # This is done by invoking /home/httpd/perl/apachereload
4977: # a setuid perl script that can be root for us to do this job.
1.148 foxr 4978: #
4979: sub ReloadApache {
1.150 foxr 4980: my $execdir = $perlvar{'lonDaemons'};
4981: my $script = $execdir."/apachereload";
4982: system($script);
1.148 foxr 4983: }
4984:
4985: #
1.144 foxr 4986: # Called in response to a USR2 signal.
4987: # - Reread hosts.tab
4988: # - All children connected to hosts that were removed from hosts.tab
4989: # are killed via SIGINT
4990: # - All children connected to previously existing hosts are sent SIGUSR1
4991: # - Our internal hosts hash is updated to reflect the new contents of
4992: # hosts.tab causing connections from hosts added to hosts.tab to
4993: # now be honored.
4994: #
4995: sub UpdateHosts {
1.165 albertel 4996: &status("Reload hosts.tab");
1.147 foxr 4997: logthis('<font color="blue"> Updating connections </font>');
1.148 foxr 4998: #
4999: # The %children hash has the set of IP's we currently have children
5000: # on. These need to be matched against records in the hosts.tab
5001: # Any ip's no longer in the table get killed off they correspond to
5002: # either dropped or changed hosts. Note that the re-read of the table
5003: # will take care of new and changed hosts as connections come into being.
5004:
5005:
5006: KillHostHashes;
5007: ReadHostTable;
5008:
5009: foreach my $child (keys %children) {
5010: my $childip = $children{$child};
5011: if(!$hostid{$childip}) {
1.149 foxr 5012: logthis('<font color="blue"> UpdateHosts killing child '
5013: ." $child for ip $childip </font>");
1.148 foxr 5014: kill('INT', $child);
1.149 foxr 5015: } else {
5016: logthis('<font color="green"> keeping child for ip '
5017: ." $childip (pid=$child) </font>");
1.148 foxr 5018: }
5019: }
5020: ReloadApache;
1.165 albertel 5021: &status("Finished reloading hosts.tab");
1.144 foxr 5022: }
5023:
1.148 foxr 5024:
1.57 www 5025: sub checkchildren {
1.165 albertel 5026: &status("Checking on the children (sending signals)");
1.57 www 5027: &initnewstatus();
5028: &logstatus();
5029: &logthis('Going to check on the children');
1.134 albertel 5030: my $docdir=$perlvar{'lonDocRoot'};
1.61 harris41 5031: foreach (sort keys %children) {
1.221 albertel 5032: #sleep 1;
1.57 www 5033: unless (kill 'USR1' => $_) {
5034: &logthis ('Child '.$_.' is dead');
5035: &logstatus($$.' is dead');
1.221 albertel 5036: delete($children{$_});
1.57 www 5037: }
1.61 harris41 5038: }
1.63 www 5039: sleep 5;
1.212 foxr 5040: $SIG{ALRM} = sub { Debug("timeout");
5041: die "timeout"; };
1.113 albertel 5042: $SIG{__DIE__} = 'DEFAULT';
1.165 albertel 5043: &status("Checking on the children (waiting for reports)");
1.63 www 5044: foreach (sort keys %children) {
5045: unless (-e "$docdir/lon-status/londchld/$_.txt") {
1.113 albertel 5046: eval {
5047: alarm(300);
1.63 www 5048: &logthis('Child '.$_.' did not respond');
1.67 albertel 5049: kill 9 => $_;
1.131 albertel 5050: #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
5051: #$subj="LON: $currenthostid killed lond process $_";
5052: #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
5053: #$execdir=$perlvar{'lonDaemons'};
5054: #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
1.221 albertel 5055: delete($children{$_});
1.113 albertel 5056: alarm(0);
5057: }
1.63 www 5058: }
5059: }
1.113 albertel 5060: $SIG{ALRM} = 'DEFAULT';
1.155 albertel 5061: $SIG{__DIE__} = \&catchexception;
1.165 albertel 5062: &status("Finished checking children");
1.221 albertel 5063: &logthis('Finished Checking children');
1.57 www 5064: }
5065:
1.1 albertel 5066: # --------------------------------------------------------------------- Logging
5067:
5068: sub logthis {
5069: my $message=shift;
5070: my $execdir=$perlvar{'lonDaemons'};
5071: my $fh=IO::File->new(">>$execdir/logs/lond.log");
5072: my $now=time;
5073: my $local=localtime($now);
1.58 www 5074: $lastlog=$local.': '.$message;
1.1 albertel 5075: print $fh "$local ($$): $message\n";
5076: }
5077:
1.77 foxr 5078: # ------------------------- Conditional log if $DEBUG true.
5079: sub Debug {
5080: my $message = shift;
5081: if($DEBUG) {
5082: &logthis($message);
5083: }
5084: }
1.161 foxr 5085:
5086: #
5087: # Sub to do replies to client.. this gives a hook for some
5088: # debug tracing too:
5089: # Parameters:
5090: # fd - File open on client.
5091: # reply - Text to send to client.
5092: # request - Original request from client.
5093: #
5094: sub Reply {
1.192 foxr 5095: my ($fd, $reply, $request) = @_;
1.161 foxr 5096: print $fd $reply;
5097: Debug("Request was $request Reply was $reply");
5098:
1.212 foxr 5099: $Transactions++;
5100: }
5101:
5102:
5103: #
5104: # Sub to report a failure.
5105: # This function:
5106: # - Increments the failure statistic counters.
5107: # - Invokes Reply to send the error message to the client.
5108: # Parameters:
5109: # fd - File descriptor open on the client
5110: # reply - Reply text to emit.
5111: # request - The original request message (used by Reply
5112: # to debug if that's enabled.
5113: # Implicit outputs:
5114: # $Failures- The number of failures is incremented.
5115: # Reply (invoked here) sends a message to the
5116: # client:
5117: #
5118: sub Failure {
5119: my $fd = shift;
5120: my $reply = shift;
5121: my $request = shift;
5122:
5123: $Failures++;
5124: Reply($fd, $reply, $request); # That's simple eh?
1.161 foxr 5125: }
1.57 www 5126: # ------------------------------------------------------------------ Log status
5127:
5128: sub logstatus {
1.178 foxr 5129: &status("Doing logging");
5130: my $docdir=$perlvar{'lonDocRoot'};
5131: {
5132: my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
1.200 matthew 5133: print $fh $status."\n".$lastlog."\n".time."\n$keymode";
1.178 foxr 5134: $fh->close();
5135: }
1.221 albertel 5136: &status("Finished $$.txt");
5137: {
5138: open(LOG,">>$docdir/lon-status/londstatus.txt");
5139: flock(LOG,LOCK_EX);
5140: print LOG $$."\t".$clientname."\t".$currenthostid."\t"
5141: .$status."\t".$lastlog."\t $keymode\n";
1.275 albertel 5142: flock(LOG,LOCK_UN);
1.221 albertel 5143: close(LOG);
5144: }
1.178 foxr 5145: &status("Finished logging");
1.57 www 5146: }
5147:
5148: sub initnewstatus {
5149: my $docdir=$perlvar{'lonDocRoot'};
5150: my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
5151: my $now=time;
5152: my $local=localtime($now);
5153: print $fh "LOND status $local - parent $$\n\n";
1.64 www 5154: opendir(DIR,"$docdir/lon-status/londchld");
1.134 albertel 5155: while (my $filename=readdir(DIR)) {
1.64 www 5156: unlink("$docdir/lon-status/londchld/$filename");
5157: }
5158: closedir(DIR);
1.57 www 5159: }
5160:
5161: # -------------------------------------------------------------- Status setting
5162:
5163: sub status {
5164: my $what=shift;
5165: my $now=time;
5166: my $local=localtime($now);
1.178 foxr 5167: $status=$local.': '.$what;
5168: $0='lond: '.$what.' '.$local;
1.57 www 5169: }
1.11 www 5170:
1.1 albertel 5171: # ----------------------------------------------------------- Send USR1 to lonc
5172:
5173: sub reconlonc {
5174: my $peerfile=shift;
5175: &logthis("Trying to reconnect for $peerfile");
5176: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
5177: if (my $fh=IO::File->new("$loncfile")) {
5178: my $loncpid=<$fh>;
5179: chomp($loncpid);
5180: if (kill 0 => $loncpid) {
5181: &logthis("lonc at pid $loncpid responding, sending USR1");
5182: kill USR1 => $loncpid;
5183: } else {
1.9 www 5184: &logthis(
1.190 albertel 5185: "<font color='red'>CRITICAL: "
1.9 www 5186: ."lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 5187: }
5188: } else {
1.190 albertel 5189: &logthis('<font color="red">CRITICAL: lonc not running, giving up</font>');
1.1 albertel 5190: }
5191: }
5192:
5193: # -------------------------------------------------- Non-critical communication
1.11 www 5194:
1.1 albertel 5195: sub subreply {
5196: my ($cmd,$server)=@_;
1.307 albertel 5197: my $peerfile="$perlvar{'lonSockDir'}/".$hostname{$server};
1.1 albertel 5198: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
5199: Type => SOCK_STREAM,
5200: Timeout => 10)
5201: or return "con_lost";
1.307 albertel 5202: print $sclient "sethost:$server:$cmd\n";
1.1 albertel 5203: my $answer=<$sclient>;
5204: chomp($answer);
5205: if (!$answer) { $answer="con_lost"; }
5206: return $answer;
5207: }
5208:
5209: sub reply {
5210: my ($cmd,$server)=@_;
5211: my $answer;
1.115 albertel 5212: if ($server ne $currenthostid) {
1.1 albertel 5213: $answer=subreply($cmd,$server);
5214: if ($answer eq 'con_lost') {
5215: $answer=subreply("ping",$server);
5216: if ($answer ne $server) {
1.115 albertel 5217: &logthis("sub reply: answer != server answer is $answer, server is $server");
1.307 albertel 5218: &reconlonc("$perlvar{'lonSockDir'}/".$hostname{$server});
1.1 albertel 5219: }
5220: $answer=subreply($cmd,$server);
5221: }
5222: } else {
5223: $answer='self_reply';
5224: }
5225: return $answer;
5226: }
5227:
1.13 www 5228: # -------------------------------------------------------------- Talk to lonsql
5229:
1.234 foxr 5230: sub sql_reply {
1.12 harris41 5231: my ($cmd)=@_;
1.234 foxr 5232: my $answer=&sub_sql_reply($cmd);
5233: if ($answer eq 'con_lost') { $answer=&sub_sql_reply($cmd); }
1.12 harris41 5234: return $answer;
5235: }
5236:
1.234 foxr 5237: sub sub_sql_reply {
1.12 harris41 5238: my ($cmd)=@_;
5239: my $unixsock="mysqlsock";
5240: my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
5241: my $sclient=IO::Socket::UNIX->new(Peer =>"$peerfile",
5242: Type => SOCK_STREAM,
5243: Timeout => 10)
5244: or return "con_lost";
1.319 www 5245: print $sclient "$cmd:$currentdomainid\n";
1.12 harris41 5246: my $answer=<$sclient>;
5247: chomp($answer);
5248: if (!$answer) { $answer="con_lost"; }
5249: return $answer;
5250: }
5251:
1.1 albertel 5252: # --------------------------------------- Is this the home server of an author?
1.11 www 5253:
1.1 albertel 5254: sub ishome {
5255: my $author=shift;
5256: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
5257: my ($udom,$uname)=split(/\//,$author);
5258: my $proname=propath($udom,$uname);
5259: if (-e $proname) {
5260: return 'owner';
5261: } else {
5262: return 'not_owner';
5263: }
5264: }
5265:
5266: # ======================================================= Continue main program
5267: # ---------------------------------------------------- Fork once and dissociate
5268:
1.134 albertel 5269: my $fpid=fork;
1.1 albertel 5270: exit if $fpid;
1.29 harris41 5271: die "Couldn't fork: $!" unless defined ($fpid);
1.1 albertel 5272:
1.29 harris41 5273: POSIX::setsid() or die "Can't start new session: $!";
1.1 albertel 5274:
5275: # ------------------------------------------------------- Write our PID on disk
5276:
1.134 albertel 5277: my $execdir=$perlvar{'lonDaemons'};
1.1 albertel 5278: open (PIDSAVE,">$execdir/logs/lond.pid");
5279: print PIDSAVE "$$\n";
5280: close(PIDSAVE);
1.190 albertel 5281: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
1.57 www 5282: &status('Starting');
1.1 albertel 5283:
1.106 foxr 5284:
1.1 albertel 5285:
5286: # ----------------------------------------------------- Install signal handlers
5287:
1.57 www 5288:
1.1 albertel 5289: $SIG{CHLD} = \&REAPER;
5290: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
5291: $SIG{HUP} = \&HUPSMAN;
1.57 www 5292: $SIG{USR1} = \&checkchildren;
1.144 foxr 5293: $SIG{USR2} = \&UpdateHosts;
1.106 foxr 5294:
1.148 foxr 5295: # Read the host hashes:
5296:
5297: ReadHostTable;
1.106 foxr 5298:
1.286 albertel 5299: my $dist=`$perlvar{'lonDaemons'}/distprobe`;
5300:
1.106 foxr 5301: # --------------------------------------------------------------
5302: # Accept connections. When a connection comes in, it is validated
5303: # and if good, a child process is created to process transactions
5304: # along the connection.
5305:
1.1 albertel 5306: while (1) {
1.165 albertel 5307: &status('Starting accept');
1.106 foxr 5308: $client = $server->accept() or next;
1.165 albertel 5309: &status('Accepted '.$client.' off to spawn');
1.106 foxr 5310: make_new_child($client);
1.165 albertel 5311: &status('Finished spawning');
1.1 albertel 5312: }
5313:
1.212 foxr 5314: sub make_new_child {
5315: my $pid;
5316: # my $cipher; # Now global
5317: my $sigset;
1.178 foxr 5318:
1.212 foxr 5319: $client = shift;
5320: &status('Starting new child '.$client);
5321: &logthis('<font color="green"> Attempting to start child ('.$client.
5322: ")</font>");
5323: # block signal for fork
5324: $sigset = POSIX::SigSet->new(SIGINT);
5325: sigprocmask(SIG_BLOCK, $sigset)
5326: or die "Can't block SIGINT for fork: $!\n";
1.178 foxr 5327:
1.212 foxr 5328: die "fork: $!" unless defined ($pid = fork);
1.178 foxr 5329:
1.212 foxr 5330: $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
5331: # connection liveness.
1.178 foxr 5332:
1.212 foxr 5333: #
5334: # Figure out who we're talking to so we can record the peer in
5335: # the pid hash.
5336: #
5337: my $caller = getpeername($client);
5338: my ($port,$iaddr);
5339: if (defined($caller) && length($caller) > 0) {
5340: ($port,$iaddr)=unpack_sockaddr_in($caller);
5341: } else {
5342: &logthis("Unable to determine who caller was, getpeername returned nothing");
5343: }
5344: if (defined($iaddr)) {
5345: $clientip = inet_ntoa($iaddr);
5346: Debug("Connected with $clientip");
5347: } else {
5348: &logthis("Unable to determine clientip");
5349: $clientip='Unavailable';
5350: }
5351:
5352: if ($pid) {
5353: # Parent records the child's birth and returns.
5354: sigprocmask(SIG_UNBLOCK, $sigset)
5355: or die "Can't unblock SIGINT for fork: $!\n";
5356: $children{$pid} = $clientip;
5357: &status('Started child '.$pid);
5358: return;
5359: } else {
5360: # Child can *not* return from this subroutine.
5361: $SIG{INT} = 'DEFAULT'; # make SIGINT kill us as it did before
5362: $SIG{CHLD} = 'DEFAULT'; #make this default so that pwauth returns
5363: #don't get intercepted
5364: $SIG{USR1}= \&logstatus;
5365: $SIG{ALRM}= \&timeout;
5366: $lastlog='Forked ';
5367: $status='Forked';
1.178 foxr 5368:
1.212 foxr 5369: # unblock signals
5370: sigprocmask(SIG_UNBLOCK, $sigset)
5371: or die "Can't unblock SIGINT for fork: $!\n";
1.178 foxr 5372:
1.212 foxr 5373: # my $tmpsnum=0; # Now global
5374: #---------------------------------------------------- kerberos 5 initialization
5375: &Authen::Krb5::init_context();
1.297 raeburn 5376: unless (($dist eq 'fedora4') || ($dist eq 'suse9.3')) {
1.286 albertel 5377: &Authen::Krb5::init_ets();
5378: }
1.209 albertel 5379:
1.212 foxr 5380: &status('Accepted connection');
5381: # =============================================================================
5382: # do something with the connection
5383: # -----------------------------------------------------------------------------
5384: # see if we know client and 'check' for spoof IP by ineffective challenge
1.178 foxr 5385:
1.212 foxr 5386: ReadManagerTable; # May also be a manager!!
5387:
1.278 albertel 5388: my $outsideip=$clientip;
5389: if ($clientip eq '127.0.0.1') {
5390: $outsideip=$hostip{$perlvar{'lonHostID'}};
5391: }
5392:
5393: my $clientrec=($hostid{$outsideip} ne undef);
5394: my $ismanager=($managers{$outsideip} ne undef);
1.212 foxr 5395: $clientname = "[unknonwn]";
5396: if($clientrec) { # Establish client type.
5397: $ConnectionType = "client";
1.278 albertel 5398: $clientname = $hostid{$outsideip};
1.212 foxr 5399: if($ismanager) {
5400: $ConnectionType = "both";
5401: }
5402: } else {
5403: $ConnectionType = "manager";
1.278 albertel 5404: $clientname = $managers{$outsideip};
1.212 foxr 5405: }
5406: my $clientok;
1.178 foxr 5407:
1.212 foxr 5408: if ($clientrec || $ismanager) {
5409: &status("Waiting for init from $clientip $clientname");
5410: &logthis('<font color="yellow">INFO: Connection, '.
5411: $clientip.
5412: " ($clientname) connection type = $ConnectionType </font>" );
5413: &status("Connecting $clientip ($clientname))");
5414: my $remotereq=<$client>;
5415: chomp($remotereq);
5416: Debug("Got init: $remotereq");
1.337 albertel 5417:
1.212 foxr 5418: if ($remotereq =~ /^init/) {
5419: &sethost("sethost:$perlvar{'lonHostID'}");
5420: #
5421: # If the remote is attempting a local init... give that a try:
5422: #
5423: my ($i, $inittype) = split(/:/, $remotereq);
1.209 albertel 5424:
1.212 foxr 5425: # If the connection type is ssl, but I didn't get my
5426: # certificate files yet, then I'll drop back to
5427: # insecure (if allowed).
5428:
5429: if($inittype eq "ssl") {
5430: my ($ca, $cert) = lonssl::CertificateFile;
5431: my $kfile = lonssl::KeyFile;
5432: if((!$ca) ||
5433: (!$cert) ||
5434: (!$kfile)) {
5435: $inittype = ""; # This forces insecure attempt.
5436: &logthis("<font color=\"blue\"> Certificates not "
5437: ."installed -- trying insecure auth</font>");
1.224 foxr 5438: } else { # SSL certificates are in place so
1.212 foxr 5439: } # Leave the inittype alone.
5440: }
5441:
5442: if($inittype eq "local") {
5443: my $key = LocalConnection($client, $remotereq);
5444: if($key) {
5445: Debug("Got local key $key");
5446: $clientok = 1;
5447: my $cipherkey = pack("H32", $key);
5448: $cipher = new IDEA($cipherkey);
5449: print $client "ok:local\n";
5450: &logthis('<font color="green"'
5451: . "Successful local authentication </font>");
5452: $keymode = "local"
1.178 foxr 5453: } else {
1.212 foxr 5454: Debug("Failed to get local key");
5455: $clientok = 0;
5456: shutdown($client, 3);
5457: close $client;
1.178 foxr 5458: }
1.212 foxr 5459: } elsif ($inittype eq "ssl") {
5460: my $key = SSLConnection($client);
5461: if ($key) {
5462: $clientok = 1;
5463: my $cipherkey = pack("H32", $key);
5464: $cipher = new IDEA($cipherkey);
5465: &logthis('<font color="green">'
5466: ."Successfull ssl authentication with $clientname </font>");
5467: $keymode = "ssl";
5468:
1.178 foxr 5469: } else {
1.212 foxr 5470: $clientok = 0;
5471: close $client;
1.178 foxr 5472: }
1.212 foxr 5473:
5474: } else {
5475: my $ok = InsecureConnection($client);
5476: if($ok) {
5477: $clientok = 1;
5478: &logthis('<font color="green">'
5479: ."Successful insecure authentication with $clientname </font>");
5480: print $client "ok\n";
5481: $keymode = "insecure";
1.178 foxr 5482: } else {
1.212 foxr 5483: &logthis('<font color="yellow">'
5484: ."Attempted insecure connection disallowed </font>");
5485: close $client;
5486: $clientok = 0;
1.178 foxr 5487:
5488: }
5489: }
1.212 foxr 5490: } else {
5491: &logthis(
5492: "<font color='blue'>WARNING: "
5493: ."$clientip failed to initialize: >$remotereq< </font>");
5494: &status('No init '.$clientip);
5495: }
5496:
5497: } else {
5498: &logthis(
5499: "<font color='blue'>WARNING: Unknown client $clientip</font>");
5500: &status('Hung up on '.$clientip);
5501: }
5502:
5503: if ($clientok) {
5504: # ---------------- New known client connecting, could mean machine online again
5505:
5506: foreach my $id (keys(%hostip)) {
5507: if ($hostip{$id} ne $clientip ||
5508: $hostip{$currenthostid} eq $clientip) {
5509: # no need to try to do recon's to myself
5510: next;
5511: }
1.307 albertel 5512: &reconlonc("$perlvar{'lonSockDir'}/".$hostname{$id});
1.212 foxr 5513: }
5514: &logthis("<font color='green'>Established connection: $clientname</font>");
5515: &status('Will listen to '.$clientname);
5516: # ------------------------------------------------------------ Process requests
5517: my $keep_going = 1;
5518: my $user_input;
5519: while(($user_input = get_request) && $keep_going) {
5520: alarm(120);
5521: Debug("Main: Got $user_input\n");
5522: $keep_going = &process_request($user_input);
1.178 foxr 5523: alarm(0);
1.212 foxr 5524: &status('Listening to '.$clientname." ($keymode)");
1.161 foxr 5525: }
1.212 foxr 5526:
1.59 www 5527: # --------------------------------------------- client unknown or fishy, refuse
1.212 foxr 5528: } else {
1.161 foxr 5529: print $client "refused\n";
5530: $client->close();
1.190 albertel 5531: &logthis("<font color='blue'>WARNING: "
1.161 foxr 5532: ."Rejected client $clientip, closing connection</font>");
5533: }
1.212 foxr 5534: }
1.161 foxr 5535:
1.1 albertel 5536: # =============================================================================
1.161 foxr 5537:
1.190 albertel 5538: &logthis("<font color='red'>CRITICAL: "
1.161 foxr 5539: ."Disconnect from $clientip ($clientname)</font>");
5540:
5541:
5542: # this exit is VERY important, otherwise the child will become
5543: # a producer of more and more children, forking yourself into
5544: # process death.
5545: exit;
1.106 foxr 5546:
1.78 foxr 5547: }
1.261 foxr 5548: #
5549: # Determine if a user is an author for the indicated domain.
5550: #
5551: # Parameters:
5552: # domain - domain to check in .
5553: # user - Name of user to check.
5554: #
5555: # Return:
5556: # 1 - User is an author for domain.
5557: # 0 - User is not an author for domain.
5558: sub is_author {
5559: my ($domain, $user) = @_;
5560:
5561: &Debug("is_author: $user @ $domain");
5562:
5563: my $hashref = &tie_user_hash($domain, $user, "roles",
5564: &GDBM_READER());
5565:
5566: # Author role should show up as a key /domain/_au
1.78 foxr 5567:
1.321 albertel 5568: my $key = "/$domain/_au";
5569: my $value;
5570: if (defined($hashref)) {
5571: $value = $hashref->{$key};
5572: }
1.78 foxr 5573:
1.261 foxr 5574: if(defined($value)) {
5575: &Debug("$user @ $domain is an author");
5576: }
5577:
5578: return defined($value);
5579: }
1.78 foxr 5580: #
5581: # Checks to see if the input roleput request was to set
5582: # an author role. If so, invokes the lchtmldir script to set
5583: # up a correct public_html
5584: # Parameters:
5585: # request - The request sent to the rolesput subchunk.
5586: # We're looking for /domain/_au
5587: # domain - The domain in which the user is having roles doctored.
5588: # user - Name of the user for which the role is being put.
5589: # authtype - The authentication type associated with the user.
5590: #
1.289 albertel 5591: sub manage_permissions {
1.192 foxr 5592: my ($request, $domain, $user, $authtype) = @_;
1.78 foxr 5593:
1.261 foxr 5594: &Debug("manage_permissions: $request $domain $user $authtype");
5595:
1.78 foxr 5596: # See if the request is of the form /$domain/_au
1.289 albertel 5597: if($request =~ /^(\/\Q$domain\E\/_au)$/) { # It's an author rolesput...
1.78 foxr 5598: my $execdir = $perlvar{'lonDaemons'};
5599: my $userhome= "/home/$user" ;
1.134 albertel 5600: &logthis("system $execdir/lchtmldir $userhome $user $authtype");
1.261 foxr 5601: &Debug("Setting homedir permissions for $userhome");
1.78 foxr 5602: system("$execdir/lchtmldir $userhome $user $authtype");
5603: }
5604: }
1.222 foxr 5605:
5606:
5607: #
5608: # Return the full path of a user password file, whether it exists or not.
5609: # Parameters:
5610: # domain - Domain in which the password file lives.
5611: # user - name of the user.
5612: # Returns:
5613: # Full passwd path:
5614: #
5615: sub password_path {
5616: my ($domain, $user) = @_;
1.264 albertel 5617: return &propath($domain, $user).'/passwd';
1.222 foxr 5618: }
5619:
5620: # Password Filename
5621: # Returns the path to a passwd file given domain and user... only if
5622: # it exists.
5623: # Parameters:
5624: # domain - Domain in which to search.
5625: # user - username.
5626: # Returns:
5627: # - If the password file exists returns its path.
5628: # - If the password file does not exist, returns undefined.
5629: #
5630: sub password_filename {
5631: my ($domain, $user) = @_;
5632:
5633: Debug ("PasswordFilename called: dom = $domain user = $user");
5634:
5635: my $path = &password_path($domain, $user);
5636: Debug("PasswordFilename got path: $path");
5637: if(-e $path) {
5638: return $path;
5639: } else {
5640: return undef;
5641: }
5642: }
5643:
5644: #
5645: # Rewrite the contents of the user's passwd file.
5646: # Parameters:
5647: # domain - domain of the user.
5648: # name - User's name.
5649: # contents - New contents of the file.
5650: # Returns:
5651: # 0 - Failed.
5652: # 1 - Success.
5653: #
5654: sub rewrite_password_file {
5655: my ($domain, $user, $contents) = @_;
5656:
5657: my $file = &password_filename($domain, $user);
5658: if (defined $file) {
5659: my $pf = IO::File->new(">$file");
5660: if($pf) {
5661: print $pf "$contents\n";
5662: return 1;
5663: } else {
5664: return 0;
5665: }
5666: } else {
5667: return 0;
5668: }
5669:
5670: }
5671:
1.78 foxr 5672: #
1.222 foxr 5673: # get_auth_type - Determines the authorization type of a user in a domain.
1.78 foxr 5674:
5675: # Returns the authorization type or nouser if there is no such user.
5676: #
1.222 foxr 5677: sub get_auth_type
1.78 foxr 5678: {
1.192 foxr 5679:
5680: my ($domain, $user) = @_;
1.78 foxr 5681:
1.222 foxr 5682: Debug("get_auth_type( $domain, $user ) \n");
1.78 foxr 5683: my $proname = &propath($domain, $user);
5684: my $passwdfile = "$proname/passwd";
5685: if( -e $passwdfile ) {
5686: my $pf = IO::File->new($passwdfile);
5687: my $realpassword = <$pf>;
5688: chomp($realpassword);
1.79 foxr 5689: Debug("Password info = $realpassword\n");
1.78 foxr 5690: my ($authtype, $contentpwd) = split(/:/, $realpassword);
1.79 foxr 5691: Debug("Authtype = $authtype, content = $contentpwd\n");
1.259 raeburn 5692: return "$authtype:$contentpwd";
1.224 foxr 5693: } else {
1.79 foxr 5694: Debug("Returning nouser");
1.78 foxr 5695: return "nouser";
5696: }
1.1 albertel 5697: }
5698:
1.220 foxr 5699: #
5700: # Validate a user given their domain, name and password. This utility
5701: # function is used by both AuthenticateHandler and ChangePasswordHandler
5702: # to validate the login credentials of a user.
5703: # Parameters:
5704: # $domain - The domain being logged into (this is required due to
5705: # the capability for multihomed systems.
5706: # $user - The name of the user being validated.
5707: # $password - The user's propoposed password.
5708: #
5709: # Returns:
5710: # 1 - The domain,user,pasword triplet corresponds to a valid
5711: # user.
5712: # 0 - The domain,user,password triplet is not a valid user.
5713: #
5714: sub validate_user {
5715: my ($domain, $user, $password) = @_;
5716:
5717:
5718: # Why negative ~pi you may well ask? Well this function is about
5719: # authentication, and therefore very important to get right.
5720: # I've initialized the flag that determines whether or not I've
5721: # validated correctly to a value it's not supposed to get.
5722: # At the end of this function. I'll ensure that it's not still that
5723: # value so we don't just wind up returning some accidental value
5724: # as a result of executing an unforseen code path that
1.249 foxr 5725: # did not set $validated. At the end of valid execution paths,
5726: # validated shoule be 1 for success or 0 for failuer.
1.220 foxr 5727:
5728: my $validated = -3.14159;
5729:
5730: # How we authenticate is determined by the type of authentication
5731: # the user has been assigned. If the authentication type is
5732: # "nouser", the user does not exist so we will return 0.
5733:
1.222 foxr 5734: my $contents = &get_auth_type($domain, $user);
1.220 foxr 5735: my ($howpwd, $contentpwd) = split(/:/, $contents);
5736:
5737: my $null = pack("C",0); # Used by kerberos auth types.
5738:
5739: if ($howpwd ne 'nouser') {
5740:
5741: if($howpwd eq "internal") { # Encrypted is in local password file.
5742: $validated = (crypt($password, $contentpwd) eq $contentpwd);
5743: }
5744: elsif ($howpwd eq "unix") { # User is a normal unix user.
5745: $contentpwd = (getpwnam($user))[1];
5746: if($contentpwd) {
5747: if($contentpwd eq 'x') { # Shadow password file...
5748: my $pwauth_path = "/usr/local/sbin/pwauth";
5749: open PWAUTH, "|$pwauth_path" or
5750: die "Cannot invoke authentication";
5751: print PWAUTH "$user\n$password\n";
5752: close PWAUTH;
5753: $validated = ! $?;
5754:
5755: } else { # Passwords in /etc/passwd.
5756: $validated = (crypt($password,
5757: $contentpwd) eq $contentpwd);
5758: }
5759: } else {
5760: $validated = 0;
5761: }
5762: }
5763: elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
5764: if(! ($password =~ /$null/) ) {
5765: my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
5766: "",
5767: $contentpwd,,
5768: 'krbtgt',
5769: $contentpwd,
5770: 1,
5771: $password);
5772: if(!$k4error) {
5773: $validated = 1;
1.224 foxr 5774: } else {
1.220 foxr 5775: $validated = 0;
5776: &logthis('krb4: '.$user.', '.$contentpwd.', '.
5777: &Authen::Krb4::get_err_txt($Authen::Krb4::error));
5778: }
1.224 foxr 5779: } else {
1.220 foxr 5780: $validated = 0; # Password has a match with null.
5781: }
1.224 foxr 5782: } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
1.220 foxr 5783: if(!($password =~ /$null/)) { # Null password not allowed.
5784: my $krbclient = &Authen::Krb5::parse_name($user.'@'
5785: .$contentpwd);
5786: my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
5787: my $krbserver = &Authen::Krb5::parse_name($krbservice);
5788: my $credentials= &Authen::Krb5::cc_default();
5789: $credentials->initialize($krbclient);
1.270 matthew 5790: my $krbreturn = &Authen::Krb5::get_in_tkt_with_password($krbclient,
1.220 foxr 5791: $krbserver,
5792: $password,
5793: $credentials);
5794: $validated = ($krbreturn == 1);
1.224 foxr 5795: } else {
1.220 foxr 5796: $validated = 0;
5797: }
1.224 foxr 5798: } elsif ($howpwd eq "localauth") {
1.220 foxr 5799: # Authenticate via installation specific authentcation method:
5800: $validated = &localauth::localauth($user,
5801: $password,
5802: $contentpwd);
1.224 foxr 5803: } else { # Unrecognized auth is also bad.
1.220 foxr 5804: $validated = 0;
5805: }
5806: } else {
5807: $validated = 0;
5808: }
5809: #
5810: # $validated has the correct stat of the authentication:
5811: #
5812:
5813: unless ($validated != -3.14159) {
1.249 foxr 5814: # I >really really< want to know if this happens.
5815: # since it indicates that user authentication is badly
5816: # broken in some code path.
5817: #
5818: die "ValidateUser - failed to set the value of validated $domain, $user $password";
1.220 foxr 5819: }
5820: return $validated;
5821: }
5822:
5823:
1.84 albertel 5824: sub addline {
5825: my ($fname,$hostid,$ip,$newline)=@_;
5826: my $contents;
5827: my $found=0;
5828: my $expr='^'.$hostid.':'.$ip.':';
5829: $expr =~ s/\./\\\./g;
1.134 albertel 5830: my $sh;
1.84 albertel 5831: if ($sh=IO::File->new("$fname.subscription")) {
5832: while (my $subline=<$sh>) {
5833: if ($subline !~ /$expr/) {$contents.= $subline;} else {$found=1;}
5834: }
5835: $sh->close();
5836: }
5837: $sh=IO::File->new(">$fname.subscription");
5838: if ($contents) { print $sh $contents; }
5839: if ($newline) { print $sh $newline; }
5840: $sh->close();
5841: return $found;
1.86 www 5842: }
5843:
1.234 foxr 5844: sub get_chat {
1.324 raeburn 5845: my ($cdom,$cname,$udom,$uname,$group)=@_;
1.310 albertel 5846:
1.87 www 5847: my @entries=();
1.324 raeburn 5848: my $namespace = 'nohist_chatroom';
5849: my $namespace_inroom = 'nohist_inchatroom';
1.335 albertel 5850: if ($group ne '') {
1.324 raeburn 5851: $namespace .= '_'.$group;
5852: $namespace_inroom .= '_'.$group;
5853: }
5854: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
1.310 albertel 5855: &GDBM_READER());
5856: if ($hashref) {
5857: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
1.311 albertel 5858: &untie_user_hash($hashref);
1.123 www 5859: }
1.124 www 5860: my @participants=();
1.134 albertel 5861: my $cutoff=time-60;
1.324 raeburn 5862: $hashref = &tie_user_hash($cdom, $cname, $namespace_inroom,
1.310 albertel 5863: &GDBM_WRCREAT());
5864: if ($hashref) {
5865: $hashref->{$uname.':'.$udom}=time;
5866: foreach my $user (sort(keys(%$hashref))) {
5867: if ($hashref->{$user}>$cutoff) {
5868: push(@participants, 'active_participant:'.$user);
1.123 www 5869: }
5870: }
1.311 albertel 5871: &untie_user_hash($hashref);
1.86 www 5872: }
1.124 www 5873: return (@participants,@entries);
1.86 www 5874: }
5875:
1.234 foxr 5876: sub chat_add {
1.324 raeburn 5877: my ($cdom,$cname,$newchat,$group)=@_;
1.88 albertel 5878: my @entries=();
1.142 www 5879: my $time=time;
1.324 raeburn 5880: my $namespace = 'nohist_chatroom';
5881: my $logfile = 'chatroom.log';
1.335 albertel 5882: if ($group ne '') {
1.324 raeburn 5883: $namespace .= '_'.$group;
5884: $logfile = 'chatroom_'.$group.'.log';
5885: }
5886: my $hashref = &tie_user_hash($cdom, $cname, $namespace,
1.310 albertel 5887: &GDBM_WRCREAT());
5888: if ($hashref) {
5889: @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
1.88 albertel 5890: my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
5891: my ($thentime,$idnum)=split(/\_/,$lastid);
5892: my $newid=$time.'_000000';
5893: if ($thentime==$time) {
5894: $idnum=~s/^0+//;
5895: $idnum++;
5896: $idnum=substr('000000'.$idnum,-6,6);
5897: $newid=$time.'_'.$idnum;
5898: }
1.310 albertel 5899: $hashref->{$newid}=$newchat;
1.88 albertel 5900: my $expired=$time-3600;
1.310 albertel 5901: foreach my $comment (keys(%$hashref)) {
5902: my ($thistime) = ($comment=~/(\d+)\_/);
1.88 albertel 5903: if ($thistime<$expired) {
1.310 albertel 5904: delete $hashref->{$comment};
1.88 albertel 5905: }
5906: }
1.310 albertel 5907: {
5908: my $proname=&propath($cdom,$cname);
1.324 raeburn 5909: if (open(CHATLOG,">>$proname/$logfile")) {
1.310 albertel 5910: print CHATLOG ("$time:".&unescape($newchat)."\n");
5911: }
5912: close(CHATLOG);
1.142 www 5913: }
1.311 albertel 5914: &untie_user_hash($hashref);
1.86 www 5915: }
1.84 albertel 5916: }
5917:
5918: sub unsub {
5919: my ($fname,$clientip)=@_;
5920: my $result;
1.188 foxr 5921: my $unsubs = 0; # Number of successful unsubscribes:
5922:
5923:
5924: # An old way subscriptions were handled was to have a
5925: # subscription marker file:
5926:
5927: Debug("Attempting unlink of $fname.$clientname");
1.161 foxr 5928: if (unlink("$fname.$clientname")) {
1.188 foxr 5929: $unsubs++; # Successful unsub via marker file.
5930: }
5931:
5932: # The more modern way to do it is to have a subscription list
5933: # file:
5934:
1.84 albertel 5935: if (-e "$fname.subscription") {
1.161 foxr 5936: my $found=&addline($fname,$clientname,$clientip,'');
1.188 foxr 5937: if ($found) {
5938: $unsubs++;
5939: }
5940: }
5941:
5942: # If either or both of these mechanisms succeeded in unsubscribing a
5943: # resource we can return ok:
5944:
5945: if($unsubs) {
5946: $result = "ok\n";
1.84 albertel 5947: } else {
1.188 foxr 5948: $result = "not_subscribed\n";
1.84 albertel 5949: }
1.188 foxr 5950:
1.84 albertel 5951: return $result;
5952: }
5953:
1.101 www 5954: sub currentversion {
5955: my $fname=shift;
5956: my $version=-1;
5957: my $ulsdir='';
5958: if ($fname=~/^(.+)\/[^\/]+$/) {
5959: $ulsdir=$1;
5960: }
1.114 albertel 5961: my ($fnamere1,$fnamere2);
5962: # remove version if already specified
1.101 www 5963: $fname=~s/\.\d+\.(\w+(?:\.meta)*)$/\.$1/;
1.114 albertel 5964: # get the bits that go before and after the version number
5965: if ( $fname=~/^(.*\.)(\w+(?:\.meta)*)$/ ) {
5966: $fnamere1=$1;
5967: $fnamere2='.'.$2;
5968: }
1.101 www 5969: if (-e $fname) { $version=1; }
5970: if (-e $ulsdir) {
1.134 albertel 5971: if(-d $ulsdir) {
5972: if (opendir(LSDIR,$ulsdir)) {
5973: my $ulsfn;
5974: while ($ulsfn=readdir(LSDIR)) {
1.101 www 5975: # see if this is a regular file (ignore links produced earlier)
1.134 albertel 5976: my $thisfile=$ulsdir.'/'.$ulsfn;
5977: unless (-l $thisfile) {
1.160 www 5978: if ($thisfile=~/\Q$fnamere1\E(\d+)\Q$fnamere2\E$/) {
1.134 albertel 5979: if ($1>$version) { $version=$1; }
5980: }
5981: }
5982: }
5983: closedir(LSDIR);
5984: $version++;
5985: }
5986: }
5987: }
5988: return $version;
1.101 www 5989: }
5990:
5991: sub thisversion {
5992: my $fname=shift;
5993: my $version=-1;
5994: if ($fname=~/\.(\d+)\.\w+(?:\.meta)*$/) {
5995: $version=$1;
5996: }
5997: return $version;
5998: }
5999:
1.84 albertel 6000: sub subscribe {
6001: my ($userinput,$clientip)=@_;
6002: my $result;
1.293 albertel 6003: my ($cmd,$fname)=split(/:/,$userinput,2);
1.84 albertel 6004: my $ownership=&ishome($fname);
6005: if ($ownership eq 'owner') {
1.101 www 6006: # explitly asking for the current version?
6007: unless (-e $fname) {
6008: my $currentversion=¤tversion($fname);
6009: if (&thisversion($fname)==$currentversion) {
6010: if ($fname=~/^(.+)\.\d+\.(\w+(?:\.meta)*)$/) {
6011: my $root=$1;
6012: my $extension=$2;
6013: symlink($root.'.'.$extension,
6014: $root.'.'.$currentversion.'.'.$extension);
1.102 www 6015: unless ($extension=~/\.meta$/) {
6016: symlink($root.'.'.$extension.'.meta',
6017: $root.'.'.$currentversion.'.'.$extension.'.meta');
6018: }
1.101 www 6019: }
6020: }
6021: }
1.84 albertel 6022: if (-e $fname) {
6023: if (-d $fname) {
6024: $result="directory\n";
6025: } else {
1.161 foxr 6026: if (-e "$fname.$clientname") {&unsub($fname,$clientip);}
1.134 albertel 6027: my $now=time;
1.161 foxr 6028: my $found=&addline($fname,$clientname,$clientip,
6029: "$clientname:$clientip:$now\n");
1.84 albertel 6030: if ($found) { $result="$fname\n"; }
6031: # if they were subscribed to only meta data, delete that
6032: # subscription, when you subscribe to a file you also get
6033: # the metadata
6034: unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
6035: $fname=~s/\/home\/httpd\/html\/res/raw/;
6036: $fname="http://$thisserver/".$fname;
6037: $result="$fname\n";
6038: }
6039: } else {
6040: $result="not_found\n";
6041: }
6042: } else {
6043: $result="rejected\n";
6044: }
6045: return $result;
6046: }
1.287 foxr 6047: # Change the passwd of a unix user. The caller must have
6048: # first verified that the user is a loncapa user.
6049: #
6050: # Parameters:
6051: # user - Unix user name to change.
6052: # pass - New password for the user.
6053: # Returns:
6054: # ok - if success
6055: # other - Some meaningfule error message string.
6056: # NOTE:
6057: # invokes a setuid script to change the passwd.
6058: sub change_unix_password {
6059: my ($user, $pass) = @_;
6060:
6061: &Debug("change_unix_password");
6062: my $execdir=$perlvar{'lonDaemons'};
6063: &Debug("Opening lcpasswd pipeline");
6064: my $pf = IO::File->new("|$execdir/lcpasswd > "
6065: ."$perlvar{'lonDaemons'}"
6066: ."/logs/lcpasswd.log");
6067: print $pf "$user\n$pass\n$pass\n";
6068: close $pf;
6069: my $err = $?;
6070: return ($err < @passwderrors) ? $passwderrors[$err] :
6071: "pwchange_falure - unknown error";
6072:
6073:
6074: }
6075:
1.91 albertel 6076:
6077: sub make_passwd_file {
1.98 foxr 6078: my ($uname, $umode,$npass,$passfilename)=@_;
1.91 albertel 6079: my $result="ok\n";
6080: if ($umode eq 'krb4' or $umode eq 'krb5') {
6081: {
6082: my $pf = IO::File->new(">$passfilename");
1.261 foxr 6083: if ($pf) {
6084: print $pf "$umode:$npass\n";
6085: } else {
6086: $result = "pass_file_failed_error";
6087: }
1.91 albertel 6088: }
6089: } elsif ($umode eq 'internal') {
6090: my $salt=time;
6091: $salt=substr($salt,6,2);
6092: my $ncpass=crypt($npass,$salt);
6093: {
6094: &Debug("Creating internal auth");
6095: my $pf = IO::File->new(">$passfilename");
1.261 foxr 6096: if($pf) {
6097: print $pf "internal:$ncpass\n";
6098: } else {
6099: $result = "pass_file_failed_error";
6100: }
1.91 albertel 6101: }
6102: } elsif ($umode eq 'localauth') {
6103: {
6104: my $pf = IO::File->new(">$passfilename");
1.261 foxr 6105: if($pf) {
6106: print $pf "localauth:$npass\n";
6107: } else {
6108: $result = "pass_file_failed_error";
6109: }
1.91 albertel 6110: }
6111: } elsif ($umode eq 'unix') {
6112: {
1.186 foxr 6113: #
6114: # Don't allow the creation of privileged accounts!!! that would
6115: # be real bad!!!
6116: #
6117: my $uid = getpwnam($uname);
6118: if((defined $uid) && ($uid == 0)) {
6119: &logthis(">>>Attempted to create privilged account blocked");
6120: return "no_priv_account_error\n";
6121: }
6122:
1.223 foxr 6123: my $execpath ="$perlvar{'lonDaemons'}/"."lcuseradd";
1.224 foxr 6124:
6125: my $lc_error_file = $execdir."/tmp/lcuseradd".$$.".status";
1.91 albertel 6126: {
6127: &Debug("Executing external: ".$execpath);
1.98 foxr 6128: &Debug("user = ".$uname.", Password =". $npass);
1.132 matthew 6129: my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");
1.91 albertel 6130: print $se "$uname\n";
6131: print $se "$npass\n";
6132: print $se "$npass\n";
1.223 foxr 6133: print $se "$lc_error_file\n"; # Status -> unique file.
1.97 foxr 6134: }
1.285 foxr 6135: if (-r $lc_error_file) {
6136: &Debug("Opening error file: $lc_error_file");
6137: my $error = IO::File->new("< $lc_error_file");
6138: my $useraddok = <$error>;
6139: $error->close;
6140: unlink($lc_error_file);
6141:
6142: chomp $useraddok;
6143:
6144: if($useraddok > 0) {
6145: my $error_text = &lcuseraddstrerror($useraddok);
6146: &logthis("Failed lcuseradd: $error_text");
6147: $result = "lcuseradd_failed:$error_text\n";
6148: } else {
6149: my $pf = IO::File->new(">$passfilename");
6150: if($pf) {
6151: print $pf "unix:\n";
6152: } else {
6153: $result = "pass_file_failed_error";
6154: }
6155: }
1.224 foxr 6156: } else {
1.285 foxr 6157: &Debug("Could not locate lcuseradd error: $lc_error_file");
6158: $result="bug_lcuseradd_no_output_file";
1.91 albertel 6159: }
6160: }
6161: } elsif ($umode eq 'none') {
6162: {
1.223 foxr 6163: my $pf = IO::File->new("> $passfilename");
1.261 foxr 6164: if($pf) {
6165: print $pf "none:\n";
6166: } else {
6167: $result = "pass_file_failed_error";
6168: }
1.91 albertel 6169: }
6170: } else {
6171: $result="auth_mode_error\n";
6172: }
6173: return $result;
1.121 albertel 6174: }
6175:
1.265 albertel 6176: sub convert_photo {
6177: my ($start,$dest)=@_;
6178: system("convert $start $dest");
6179: }
6180:
1.121 albertel 6181: sub sethost {
6182: my ($remotereq) = @_;
6183: my (undef,$hostid)=split(/:/,$remotereq);
1.322 albertel 6184: # ignore sethost if we are already correct
6185: if ($hostid eq $currenthostid) {
6186: return 'ok';
6187: }
6188:
1.121 albertel 6189: if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
6190: if ($hostip{$perlvar{'lonHostID'}} eq $hostip{$hostid}) {
1.200 matthew 6191: $currenthostid =$hostid;
1.121 albertel 6192: $currentdomainid=$hostdom{$hostid};
6193: &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
6194: } else {
6195: &logthis("Requested host id $hostid not an alias of ".
6196: $perlvar{'lonHostID'}." refusing connection");
6197: return 'unable_to_set';
6198: }
6199: return 'ok';
6200: }
6201:
6202: sub version {
6203: my ($userinput)=@_;
6204: $remoteVERSION=(split(/:/,$userinput))[1];
6205: return "version:$VERSION";
1.127 albertel 6206: }
1.178 foxr 6207:
1.128 albertel 6208: #There is a copy of this in lonnet.pm
1.127 albertel 6209: sub userload {
6210: my $numusers=0;
6211: {
6212: opendir(LONIDS,$perlvar{'lonIDsDir'});
6213: my $filename;
6214: my $curtime=time;
6215: while ($filename=readdir(LONIDS)) {
6216: if ($filename eq '.' || $filename eq '..') {next;}
1.138 albertel 6217: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.159 albertel 6218: if ($curtime-$mtime < 1800) { $numusers++; }
1.127 albertel 6219: }
6220: closedir(LONIDS);
6221: }
6222: my $userloadpercent=0;
6223: my $maxuserload=$perlvar{'lonUserLoadLim'};
6224: if ($maxuserload) {
1.129 albertel 6225: $userloadpercent=100*$numusers/$maxuserload;
1.127 albertel 6226: }
1.130 albertel 6227: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.127 albertel 6228: return $userloadpercent;
1.91 albertel 6229: }
6230:
1.205 raeburn 6231: # Routines for serializing arrays and hashes (copies from lonnet)
6232:
6233: sub array2str {
6234: my (@array) = @_;
6235: my $result=&arrayref2str(\@array);
6236: $result=~s/^__ARRAY_REF__//;
6237: $result=~s/__END_ARRAY_REF__$//;
6238: return $result;
6239: }
6240:
6241: sub arrayref2str {
6242: my ($arrayref) = @_;
6243: my $result='__ARRAY_REF__';
6244: foreach my $elem (@$arrayref) {
6245: if(ref($elem) eq 'ARRAY') {
6246: $result.=&arrayref2str($elem).'&';
6247: } elsif(ref($elem) eq 'HASH') {
6248: $result.=&hashref2str($elem).'&';
6249: } elsif(ref($elem)) {
6250: #print("Got a ref of ".(ref($elem))." skipping.");
6251: } else {
6252: $result.=&escape($elem).'&';
6253: }
6254: }
6255: $result=~s/\&$//;
6256: $result .= '__END_ARRAY_REF__';
6257: return $result;
6258: }
6259:
6260: sub hash2str {
6261: my (%hash) = @_;
6262: my $result=&hashref2str(\%hash);
6263: $result=~s/^__HASH_REF__//;
6264: $result=~s/__END_HASH_REF__$//;
6265: return $result;
6266: }
6267:
6268: sub hashref2str {
6269: my ($hashref)=@_;
6270: my $result='__HASH_REF__';
6271: foreach (sort(keys(%$hashref))) {
6272: if (ref($_) eq 'ARRAY') {
6273: $result.=&arrayref2str($_).'=';
6274: } elsif (ref($_) eq 'HASH') {
6275: $result.=&hashref2str($_).'=';
6276: } elsif (ref($_)) {
6277: $result.='=';
6278: #print("Got a ref of ".(ref($_))." skipping.");
6279: } else {
6280: if ($_) {$result.=&escape($_).'=';} else { last; }
6281: }
6282:
6283: if(ref($hashref->{$_}) eq 'ARRAY') {
6284: $result.=&arrayref2str($hashref->{$_}).'&';
6285: } elsif(ref($hashref->{$_}) eq 'HASH') {
6286: $result.=&hashref2str($hashref->{$_}).'&';
6287: } elsif(ref($hashref->{$_})) {
6288: $result.='&';
6289: #print("Got a ref of ".(ref($hashref->{$_}))." skipping.");
6290: } else {
6291: $result.=&escape($hashref->{$_}).'&';
6292: }
6293: }
6294: $result=~s/\&$//;
6295: $result .= '__END_HASH_REF__';
6296: return $result;
6297: }
1.200 matthew 6298:
1.61 harris41 6299: # ----------------------------------- POD (plain old documentation, CPAN style)
6300:
6301: =head1 NAME
6302:
6303: lond - "LON Daemon" Server (port "LOND" 5663)
6304:
6305: =head1 SYNOPSIS
6306:
1.74 harris41 6307: Usage: B<lond>
6308:
6309: Should only be run as user=www. This is a command-line script which
6310: is invoked by B<loncron>. There is no expectation that a typical user
6311: will manually start B<lond> from the command-line. (In other words,
6312: DO NOT START B<lond> YOURSELF.)
1.61 harris41 6313:
6314: =head1 DESCRIPTION
6315:
1.74 harris41 6316: There are two characteristics associated with the running of B<lond>,
6317: PROCESS MANAGEMENT (starting, stopping, handling child processes)
6318: and SERVER-SIDE ACTIVITIES (password authentication, user creation,
6319: subscriptions, etc). These are described in two large
6320: sections below.
6321:
6322: B<PROCESS MANAGEMENT>
6323:
1.61 harris41 6324: Preforker - server who forks first. Runs as a daemon. HUPs.
6325: Uses IDEA encryption
6326:
1.74 harris41 6327: B<lond> forks off children processes that correspond to the other servers
6328: in the network. Management of these processes can be done at the
6329: parent process level or the child process level.
6330:
6331: B<logs/lond.log> is the location of log messages.
6332:
6333: The process management is now explained in terms of linux shell commands,
6334: subroutines internal to this code, and signal assignments:
6335:
6336: =over 4
6337:
6338: =item *
6339:
6340: PID is stored in B<logs/lond.pid>
6341:
6342: This is the process id number of the parent B<lond> process.
6343:
6344: =item *
6345:
6346: SIGTERM and SIGINT
6347:
6348: Parent signal assignment:
6349: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
6350:
6351: Child signal assignment:
6352: $SIG{INT} = 'DEFAULT'; (and SIGTERM is DEFAULT also)
6353: (The child dies and a SIGALRM is sent to parent, awaking parent from slumber
6354: to restart a new child.)
6355:
6356: Command-line invocations:
6357: B<kill> B<-s> SIGTERM I<PID>
6358: B<kill> B<-s> SIGINT I<PID>
6359:
6360: Subroutine B<HUNTSMAN>:
6361: This is only invoked for the B<lond> parent I<PID>.
6362: This kills all the children, and then the parent.
6363: The B<lonc.pid> file is cleared.
6364:
6365: =item *
6366:
6367: SIGHUP
6368:
6369: Current bug:
6370: This signal can only be processed the first time
6371: on the parent process. Subsequent SIGHUP signals
6372: have no effect.
6373:
6374: Parent signal assignment:
6375: $SIG{HUP} = \&HUPSMAN;
6376:
6377: Child signal assignment:
6378: none (nothing happens)
6379:
6380: Command-line invocations:
6381: B<kill> B<-s> SIGHUP I<PID>
6382:
6383: Subroutine B<HUPSMAN>:
6384: This is only invoked for the B<lond> parent I<PID>,
6385: This kills all the children, and then the parent.
6386: The B<lond.pid> file is cleared.
6387:
6388: =item *
6389:
6390: SIGUSR1
6391:
6392: Parent signal assignment:
6393: $SIG{USR1} = \&USRMAN;
6394:
6395: Child signal assignment:
6396: $SIG{USR1}= \&logstatus;
6397:
6398: Command-line invocations:
6399: B<kill> B<-s> SIGUSR1 I<PID>
6400:
6401: Subroutine B<USRMAN>:
6402: When invoked for the B<lond> parent I<PID>,
6403: SIGUSR1 is sent to all the children, and the status of
6404: each connection is logged.
1.144 foxr 6405:
6406: =item *
6407:
6408: SIGUSR2
6409:
6410: Parent Signal assignment:
6411: $SIG{USR2} = \&UpdateHosts
6412:
6413: Child signal assignment:
6414: NONE
6415:
1.74 harris41 6416:
6417: =item *
6418:
6419: SIGCHLD
6420:
6421: Parent signal assignment:
6422: $SIG{CHLD} = \&REAPER;
6423:
6424: Child signal assignment:
6425: none
6426:
6427: Command-line invocations:
6428: B<kill> B<-s> SIGCHLD I<PID>
6429:
6430: Subroutine B<REAPER>:
6431: This is only invoked for the B<lond> parent I<PID>.
6432: Information pertaining to the child is removed.
6433: The socket port is cleaned up.
6434:
6435: =back
6436:
6437: B<SERVER-SIDE ACTIVITIES>
6438:
6439: Server-side information can be accepted in an encrypted or non-encrypted
6440: method.
6441:
6442: =over 4
6443:
6444: =item ping
6445:
6446: Query a client in the hosts.tab table; "Are you there?"
6447:
6448: =item pong
6449:
6450: Respond to a ping query.
6451:
6452: =item ekey
6453:
6454: Read in encrypted key, make cipher. Respond with a buildkey.
6455:
6456: =item load
6457:
6458: Respond with CPU load based on a computation upon /proc/loadavg.
6459:
6460: =item currentauth
6461:
6462: Reply with current authentication information (only over an
6463: encrypted channel).
6464:
6465: =item auth
6466:
6467: Only over an encrypted channel, reply as to whether a user's
6468: authentication information can be validated.
6469:
6470: =item passwd
6471:
6472: Allow for a password to be set.
6473:
6474: =item makeuser
6475:
6476: Make a user.
6477:
6478: =item passwd
6479:
6480: Allow for authentication mechanism and password to be changed.
6481:
6482: =item home
1.61 harris41 6483:
1.74 harris41 6484: Respond to a question "are you the home for a given user?"
6485:
6486: =item update
6487:
6488: Update contents of a subscribed resource.
6489:
6490: =item unsubscribe
6491:
6492: The server is unsubscribing from a resource.
6493:
6494: =item subscribe
6495:
6496: The server is subscribing to a resource.
6497:
6498: =item log
6499:
6500: Place in B<logs/lond.log>
6501:
6502: =item put
6503:
6504: stores hash in namespace
6505:
1.230 foxr 6506: =item rolesputy
1.74 harris41 6507:
6508: put a role into a user's environment
6509:
6510: =item get
6511:
6512: returns hash with keys from array
6513: reference filled in from namespace
6514:
6515: =item eget
6516:
6517: returns hash with keys from array
6518: reference filled in from namesp (encrypts the return communication)
6519:
6520: =item rolesget
6521:
6522: get a role from a user's environment
6523:
6524: =item del
6525:
6526: deletes keys out of array from namespace
6527:
6528: =item keys
6529:
6530: returns namespace keys
6531:
6532: =item dump
6533:
6534: dumps the complete (or key matching regexp) namespace into a hash
6535:
6536: =item store
6537:
6538: stores hash permanently
6539: for this url; hashref needs to be given and should be a \%hashname; the
6540: remaining args aren't required and if they aren't passed or are '' they will
6541: be derived from the ENV
6542:
6543: =item restore
6544:
6545: returns a hash for a given url
6546:
6547: =item querysend
6548:
6549: Tells client about the lonsql process that has been launched in response
6550: to a sent query.
6551:
6552: =item queryreply
6553:
6554: Accept information from lonsql and make appropriate storage in temporary
6555: file space.
6556:
6557: =item idput
6558:
6559: Defines usernames as corresponding to IDs. (These "IDs" are unique identifiers
6560: for each student, defined perhaps by the institutional Registrar.)
6561:
6562: =item idget
6563:
6564: Returns usernames corresponding to IDs. (These "IDs" are unique identifiers
6565: for each student, defined perhaps by the institutional Registrar.)
6566:
6567: =item tmpput
6568:
6569: Accept and store information in temporary space.
6570:
6571: =item tmpget
6572:
6573: Send along temporarily stored information.
6574:
6575: =item ls
6576:
6577: List part of a user's directory.
6578:
1.135 foxr 6579: =item pushtable
6580:
6581: Pushes a file in /home/httpd/lonTab directory. Currently limited to:
6582: hosts.tab and domain.tab. The old file is copied to *.tab.backup but
6583: must be restored manually in case of a problem with the new table file.
6584: pushtable requires that the request be encrypted and validated via
6585: ValidateManager. The form of the command is:
6586: enc:pushtable tablename <tablecontents> \n
6587: where pushtable, tablename and <tablecontents> will be encrypted, but \n is a
6588: cleartext newline.
6589:
1.74 harris41 6590: =item Hanging up (exit or init)
6591:
6592: What to do when a client tells the server that they (the client)
6593: are leaving the network.
6594:
6595: =item unknown command
6596:
6597: If B<lond> is sent an unknown command (not in the list above),
6598: it replys to the client "unknown_cmd".
1.135 foxr 6599:
1.74 harris41 6600:
6601: =item UNKNOWN CLIENT
6602:
6603: If the anti-spoofing algorithm cannot verify the client,
6604: the client is rejected (with a "refused" message sent
6605: to the client, and the connection is closed.
6606:
6607: =back
1.61 harris41 6608:
6609: =head1 PREREQUISITES
6610:
6611: IO::Socket
6612: IO::File
6613: Apache::File
6614: POSIX
6615: Crypt::IDEA
6616: LWP::UserAgent()
6617: GDBM_File
6618: Authen::Krb4
1.91 albertel 6619: Authen::Krb5
1.61 harris41 6620:
6621: =head1 COREQUISITES
6622:
6623: =head1 OSNAMES
6624:
6625: linux
6626:
6627: =head1 SCRIPT CATEGORIES
6628:
6629: Server/Process
6630:
6631: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lond CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom