loncom/lond - view - 1.489.2.43.2.6

File: [LON-CAPA] / loncom / lond
Revision 1.489.2.43.2.6: download - view: text, annotated - select for diffs
Mon Jan 23 03:43:33 2023 UTC (15 months ago) by raeburn
Branches: version_2_11_4_msu

- For 2.11.4 (modified)
  Include part of one channge from 1.549 and 1.576 (modified)

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