loncom/lond - view - 1.489.2.24

File: [LON-CAPA] / loncom / lond
Revision 1.489.2.24: download - view: text, annotated - select for diffs
Sat Sep 24 19:44:15 2016 UTC (7 years, 7 months ago) by raeburn
Branches: version_2_11_X

- For 2.11
  - Backport 1.526

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