loncom/lond - view - 1.489.2.34

File: [LON-CAPA] / loncom / lond
Revision 1.489.2.34: download - view: text, annotated - select for diffs
Mon Jan 13 03:46:32 2020 UTC (4 years, 3 months ago) by raeburn
Branches: version_2_11_X

- For 2.11
  Backport 1.536 (part)

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