loncom/lond - view

File: [LON-CAPA] / loncom / lond
Revision 1.421: download - view: text, annotated - select for diffs
Sun Aug 16 21:49:21 2009 UTC (14 years, 8 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- Filtering domain roles search by start and/or end time now actually works.
- In lond
  - $end, $start reversed.
  -efficiency
      - Check for specific role now occurs first.
      - Move on to check next user as soon as current user fails to satisfy a filter.

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