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