Annotation of loncom/lond, revision 1.449

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>