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