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