loncom/lond - view

File: [LON-CAPA] / loncom / lond
Revision 1.404: download - view: text, annotated - select for diffs
Thu Jun 26 19:54:15 2008 UTC (15 years, 10 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

- Update documentation in lond for &dump_course_id_handler().
   - Add the ability to filter on course category, and to exclude a course from
     results returned for course catalog display.
- lonnet::courseiddump() accepts two additional arguments
  - $showhidden (DC only, if 1, exclusions based on $caller (below) will not apply).

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