Annotation of loncom/lond, revision 1.430

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

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