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