loncom/lond - view

File: [LON-CAPA] / loncom / lond
Revision 1.340: download - view: text, annotated - select for diffs
Tue Aug 29 21:08:08 2006 UTC (17 years, 8 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

Validation of institutional class identifier (coursecode + section OR crosslisting) - does course owner have rights to access classlist information in the specified class?  Also correction to documentation for &create_auto_enroll_password_handler() in lond.

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