loncom/lond - view

File: [LON-CAPA] / loncom / lond
Revision 1.355: download - view: text, annotated - select for diffs
Wed Jan 10 20:22:30 2007 UTC (17 years, 9 months ago) by albertel
Branches: MAIN
CVS tags: HEAD

- lonid can have . and - now

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