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