loncom/lond - view

File: [LON-CAPA] / loncom / lond
Revision 1.318.2.4: download - view: text, annotated - select for diffs
Thu Feb 9 23:41:22 2006 UTC (18 years, 8 months ago) by albertel
Branches: store_expirement

- get rid of the copy/paste code

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