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