loncom/lond - view - 1.489.2.28

File: [LON-CAPA] / loncom / lond
Revision 1.489.2.28: download - view: text, annotated - select for diffs
Tue Jun 6 20:04:14 2017 UTC (6 years, 10 months ago) by raeburn
Branches: version_2_11_X
CVS tags: version_2_11_2_uiuc, version_2_11_2_msu, version_2_11_2_educog, version_2_11_2

- For 2.11
  - Backport 1.538, 1.539, 1.540

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