loncom/lond - view

File: [LON-CAPA] / loncom / lond
Revision 1.417: download - view: text, annotated - select for diffs
Sat Jul 25 15:25:10 2009 UTC (14 years, 9 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- &localenroll:possible_instcodes() takes an addition arg: $code_order which indicates the order in which components of the course code should be recombined.
  - e.g., At MSU, select boxes in the course request form are in the order:
          Year Semester Department
    but the order used to create the institutional code is:
          Semester Year Department

- &lonnet::auto_get_sections()
  - $cnum arg is undefined when checking for institutional sections during the course request process.  In the is case the homeserver used to retrieve the sections is the primary library server for the domain.

- &lonnet::auto_validate_instcode() - new routine used to validate an institutional course code during course requests.
  - Note: this differs from the institutional courseID (which in the institutional code with appended institutional section).

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