[BACK]Return to lond CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom

Diff for /loncom/lond between versions 1.178.2.2 and 1.503

version 1.178.2.2, 2004/02/23 10:25:52 version 1.503, 2013/10/06 20:33:38
Line 15 Line 15
 #  #
 # LON-CAPA is distributed in the hope that it will be useful,  # LON-CAPA is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of  # but WITHOUT ANY WARRANTY; without even the implied warranty of
   
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.  # GNU General Public License for more details.
 #  #
 # You should have received a copy of the GNU General Public License  # You should have received a copy of the GNU General Public License
 # along with LON-CAPA; if not, write to the Free Software  # along with LON-CAPA; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA      # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 #  #
 # /home/httpd/html/adm/gpl.txt  # /home/httpd/html/adm/gpl.txt
 #  #
Line 31 Line 32
   
 use strict;  use strict;
 use lib '/home/httpd/lib/perl/';  use lib '/home/httpd/lib/perl/';
   use LONCAPA;
 use LONCAPA::Configuration;  use LONCAPA::Configuration;
   use LONCAPA::Lond;
   
 use IO::Socket;  use IO::Socket;
 use IO::File;  use IO::File;
 #use Apache::File;  #use Apache::File;
 use Symbol;  
 use POSIX;  use POSIX;
 use Crypt::IDEA;  use Crypt::IDEA;
 use LWP::UserAgent();  use LWP::UserAgent();
   use Digest::MD5 qw(md5_hex);
 use GDBM_File;  use GDBM_File;
 use Authen::Krb4;  
 use Authen::Krb5;  use Authen::Krb5;
 use lib '/home/httpd/lib/perl/';  
 use localauth;  use localauth;
   use localenroll;
   use localstudentphoto;
 use File::Copy;  use File::Copy;
 use LONCAPA::ConfigFileEdit;  use File::Find;
   use LONCAPA::lonlocal;
   use LONCAPA::lonssl;
   use Fcntl qw(:flock);
   use Apache::lonnet;
   use Mail::Send;
   
 my $DEBUG = 1;       # Non zero to enable debug log entries.  my $DEBUG = 0;       # Non zero to enable debug log entries.
   
 my $status='';  my $status='';
 my $lastlog='';  my $lastlog='';
   
 my $VERSION='$Revision$'; #' stupid emacs  my $VERSION='$Revision$'; #' stupid emacs
 my $remoteVERSION;  my $remoteVERSION;
 my $currenthostid;  my $currenthostid="default";
 my $currentdomainid;  my $currentdomainid;
   
 my $client;  my $client;
 my $clientip;  my $clientip; # IP address of client.
 my $clientname;  my $clientname; # LonCAPA name of client.
   my $clientversion;              # LonCAPA version running on client.
 my $cipher; # Cipher key negotiated with client.  my $clienthomedom;              # LonCAPA domain of homeID for client. 
 my $tmpsnum = 0;; # Id of tmpputs.                                  # primary library server. 
   
 my $server;  my $server;
 my $thisserver;  
   my $keymode;
   
   my $cipher; # Cipher key negotiated with client
   my $tmpsnum = 0; # Id of tmpputs.
   
 #   # 
 #   Connection type is:  #   Connection type is:
Line 77  my $thisserver; Line 89  my $thisserver;
   
 my $ConnectionType;  my $ConnectionType;
   
 my %hostid;  
 my %hostdom;  
 my %hostip;  
   
 my %managers; # Ip -> manager names  my %managers; # Ip -> manager names
   
 my %perlvar; # Will have the apache conf defined perl vars.  my %perlvar; # Will have the apache conf defined perl vars.
   
   my $dist;
   
 #  #
 #   The hash below is used for command dispatching, and is therefore keyed on the request keyword.  #   The hash below is used for command dispatching, and is therefore keyed on the request keyword.
 #    Each element of the hash contains a reference to an array that contains:  #    Each element of the hash contains a reference to an array that contains:
Line 98  my $CLIENT_OK  = 1; Line 108  my $CLIENT_OK  = 1;
 my $MANAGER_OK = 2;  my $MANAGER_OK = 2;
 my %Dispatcher;  my %Dispatcher;
   
   
 #  #
 #  The array below are password error strings."  #  The array below are password error strings."
 #  #
 my $lastpwderror    = 13; # Largest error number from lcpasswd.  my $lastpwderror    = 13; # Largest error number from lcpasswd.
 my @passwderrors = ("ok",  my @passwderrors = ("ok",
    "lcpasswd must be run as user 'www'",     "pwchange_failure - lcpasswd must be run as user 'www'",
    "lcpasswd got incorrect number of arguments",     "pwchange_failure - lcpasswd got incorrect number of arguments",
    "lcpasswd did not get the right nubmer of input text lines",     "pwchange_failure - lcpasswd did not get the right nubmer of input text lines",
    "lcpasswd too many simultaneous pwd changes in progress",     "pwchange_failure - lcpasswd too many simultaneous pwd changes in progress",
    "lcpasswd User does not exist.",     "pwchange_failure - lcpasswd User does not exist.",
    "lcpasswd Incorrect current passwd",     "pwchange_failure - lcpasswd Incorrect current passwd",
    "lcpasswd Unable to su to root.",     "pwchange_failure - lcpasswd Unable to su to root.",
    "lcpasswd Cannot set new passwd.",     "pwchange_failure - lcpasswd Cannot set new passwd.",
    "lcpasswd Username has invalid characters",     "pwchange_failure - lcpasswd Username has invalid characters",
    "lcpasswd Invalid characters in password",     "pwchange_failure - lcpasswd Invalid characters in password",
     "11", "12",     "pwchange_failure - lcpasswd User already exists", 
     "lcpasswd Password mismatch");                     "pwchange_failure - lcpasswd Something went wrong with user addition.",
      "pwchange_failure - lcpasswd Password mismatch",
      "pwchange_failure - lcpasswd Error filename is invalid");
 #  The array below are lcuseradd error strings.:  
   
 my $lastadderror = 13;  # This array are the errors from lcinstallfile:
 my @adderrors    = ("ok",  
     "User ID mismatch, lcuseradd must run as user www",  my @installerrors = ("ok",
     "lcuseradd Incorrect number of command line parameters must be 3",       "Initial user id of client not that of www",
     "lcuseradd Incorrect number of stdinput lines, must be 3",       "Usage error, not enough command line arguments",
     "lcuseradd Too many other simultaneous pwd changes in progress",       "Source filename does not exist",
     "lcuseradd User does not exist",       "Destination filename does not exist",
     "lcuseradd Unable to make www member of users's group",       "Some file operation failed",
     "lcuseradd Unable to su to root",       "Invalid table filename."
     "lcuseradd Unable to set password",       );
     "lcuseradd Usrname has invalid characters",  
     "lcuseradd Password has an invalid character",  
     "lcuseradd User already exists",  
     "lcuseradd Could not add user.",  
     "lcuseradd Password mismatch");  
   
 #  #
 #   Statistics that are maintained and dislayed in the status line.  #   Statistics that are maintained and dislayed in the status line.
 #  #
 my $Transactions; # Number of attempted transactions.  my $Transactions = 0; # Number of attempted transactions.
 my $Failures; # Number of transcations failed.  my $Failures     = 0; # Number of transcations failed.
   
 #   ResetStatistics:   #   ResetStatistics: 
 #      Resets the statistics counters:  #      Resets the statistics counters:
Line 149  sub ResetStatistics { Line 155  sub ResetStatistics {
     $Failures     = 0;      $Failures     = 0;
 }  }
   
   #------------------------------------------------------------------------
   #
   #   LocalConnection
   #     Completes the formation of a locally authenticated connection.
   #     This function will ensure that the 'remote' client is really the
   #     local host.  If not, the connection is closed, and the function fails.
   #     If so, initcmd is parsed for the name of a file containing the
   #     IDEA session key.  The fie is opened, read, deleted and the session
   #     key returned to the caller.
   #
   # Parameters:
   #   $Socket      - Socket open on client.
   #   $initcmd     - The full text of the init command.
   #
   # Returns:
   #     IDEA session key on success.
   #     undef on failure.
   #
   sub LocalConnection {
       my ($Socket, $initcmd) = @_;
       Debug("Attempting local connection: $initcmd client: $clientip");
       if($clientip ne "127.0.0.1") {
    &logthis('<font color="red"> LocalConnection rejecting non local: '
    ."$clientip ne 127.0.0.1 </font>");
    close $Socket;
    return undef;
       }  else {
    chomp($initcmd); # Get rid of \n in filename.
    my ($init, $type, $name) = split(/:/, $initcmd);
    Debug(" Init command: $init $type $name ");
   
    # Require that $init = init, and $type = local:  Otherwise
    # the caller is insane:
   
    if(($init ne "init") && ($type ne "local")) {
       &logthis('<font color = "red"> LocalConnection: caller is insane! '
        ."init = $init, and type = $type </font>");
       close($Socket);;
       return undef;
   
    }
    #  Now get the key filename:
   
    my $IDEAKey = lonlocal::ReadKeyFile($name);
    return $IDEAKey;
       }
   }
   #------------------------------------------------------------------------------
   #
   #  SSLConnection
   #   Completes the formation of an ssh authenticated connection. The
   #   socket is promoted to an ssl socket.  If this promotion and the associated
   #   certificate exchange are successful, the IDEA key is generated and sent
   #   to the remote peer via the SSL tunnel. The IDEA key is also returned to
   #   the caller after the SSL tunnel is torn down.
   #
   # Parameters:
   #   Name              Type             Purpose
   #   $Socket          IO::Socket::INET  Plaintext socket.
   #
   # Returns:
   #    IDEA key on success.
   #    undef on failure.
   #
   sub SSLConnection {
       my $Socket   = shift;
   
       Debug("SSLConnection: ");
       my $KeyFile         = lonssl::KeyFile();
       if(!$KeyFile) {
    my $err = lonssl::LastError();
    &logthis("<font color=\"red\"> CRITICAL"
    ."Can't get key file $err </font>");
    return undef;
       }
       my ($CACertificate,
    $Certificate) = lonssl::CertificateFile();
   
   
       # If any of the key, certificate or certificate authority 
       # certificate filenames are not defined, this can't work.
   
       if((!$Certificate) || (!$CACertificate)) {
    my $err = lonssl::LastError();
    &logthis("<font color=\"red\"> CRITICAL"
    ."Can't get certificates: $err </font>");
   
    return undef;
       }
       Debug("Key: $KeyFile CA: $CACertificate Cert: $Certificate");
   
       # Indicate to our peer that we can procede with
       # a transition to ssl authentication:
   
       print $Socket "ok:ssl\n";
   
       Debug("Approving promotion -> ssl");
       #  And do so:
   
       my $SSLSocket = lonssl::PromoteServerSocket($Socket,
    $CACertificate,
    $Certificate,
    $KeyFile);
       if(! ($SSLSocket) ) { # SSL socket promotion failed.
    my $err = lonssl::LastError();
    &logthis("<font color=\"red\"> CRITICAL "
    ."SSL Socket promotion failed: $err </font>");
    return undef;
       }
       Debug("SSL Promotion successful");
   
       # 
       #  The only thing we'll use the socket for is to send the IDEA key
       #  to the peer:
   
       my $Key = lonlocal::CreateCipherKey();
       print $SSLSocket "$Key\n";
   
       lonssl::Close($SSLSocket); 
   
       Debug("Key exchange complete: $Key");
   
       return $Key;
   }
   #
   #     InsecureConnection: 
   #        If insecure connections are allowd,
   #        exchange a challenge with the client to 'validate' the
   #        client (not really, but that's the protocol):
   #        We produce a challenge string that's sent to the client.
   #        The client must then echo the challenge verbatim to us.
   #
   #  Parameter:
   #      Socket      - Socket open on the client.
   #  Returns:
   #      1           - success.
   #      0           - failure (e.g.mismatch or insecure not allowed).
   #
   sub InsecureConnection {
       my $Socket  =  shift;
   
       #   Don't even start if insecure connections are not allowed.
   
       if(! $perlvar{londAllowInsecure}) { # Insecure connections not allowed.
    return 0;
       }
   
       #   Fabricate a challenge string and send it..
   
       my $challenge = "$$".time; # pid + time.
       print $Socket "$challenge\n";
       &status("Waiting for challenge reply");
   
       my $answer = <$Socket>;
       $answer    =~s/\W//g;
       if($challenge eq $answer) {
    return 1;
       } else {
    logthis("<font color='blue'>WARNING client did not respond to challenge</font>");
    &status("No challenge reqply");
    return 0;
       }
       
   
   }
   #
   #   Safely execute a command (as long as it's not a shel command and doesn
   #   not require/rely on shell escapes.   The function operates by doing a
   #   a pipe based fork and capturing stdout and stderr  from the pipe.
   #
   # Formal Parameters:
   #     $line                    - A line of text to be executed as a command.
   # Returns:
   #     The output from that command.  If the output is multiline the caller
   #     must know how to split up the output.
   #
   #
   sub execute_command {
       my ($line)    = @_;
       my @words     = split(/\s/, $line); # Bust the command up into words.
       my $output    = "";
   
       my $pid = open(CHILD, "-|");
       
       if($pid) { # Parent process
    Debug("In parent process for execute_command");
    my @data = <CHILD>; # Read the child's outupt...
    close CHILD;
    foreach my $output_line (@data) {
       Debug("Adding $output_line");
       $output .= $output_line; # Presumably has a \n on it.
    }
   
       } else { # Child process
    close (STDERR);
    open  (STDERR, ">&STDOUT");# Combine stderr, and stdout...
    exec(@words); # won't return.
       }
       return $output;
   }
   
   
   #   GetCertificate: Given a transaction that requires a certificate,
   #   this function will extract the certificate from the transaction
   #   request.  Note that at this point, the only concept of a certificate
   #   is the hostname to which we are connected.
   #
   #   Parameter:
   #      request   - The request sent by our client (this parameterization may
   #                  need to change when we really use a certificate granting
   #                  authority.
   #
   sub GetCertificate {
       my $request = shift;
   
       return $clientip;
   }
   
 #  #
 #   Return true if client is a manager.  #   Return true if client is a manager.
 #  #
Line 164  sub isClient { Line 388  sub isClient {
   
   
 #  #
 #   Get a Request:  #   ReadManagerTable: Reads in the current manager table. For now this is
 #   Gets a Request message from the client.  The transaction  #                     done on each manager authentication because:
 #   is defined as a 'line' of text.  We remove the new line  #                     - These authentications are not frequent
 #   from the text line.    #                     - This allows dynamic changes to the manager table
 #     #                       without the need to signal to the lond.
 sub GetRequest {  #
     my $input = <$client>;  sub ReadManagerTable {
     chomp($input);  
   
     Debug("Request = $input\n");      &Debug("Reading manager table");
       #   Clean out the old table first..
   
     &status('Processing '.$clientname.':'.$input);     foreach my $key (keys %managers) {
         delete $managers{$key};
      }
   
     return $input;     my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
      if (!open (MANAGERS, $tablename)) {
          my $hostname = &Apache::lonnet::hostname($perlvar{'lonHostID'});
          if (&Apache::lonnet::is_LC_dns($hostname)) {
              &logthis('<font color="red">No manager table.  Nobody can manage!!</font>');
          }
          return;
      }
      while(my $host = <MANAGERS>) {
         chomp($host);
         if ($host =~ "^#") {                  # Comment line.
            next;
         }
         if (!defined &Apache::lonnet::get_host_ip($host)) { # This is a non cluster member
       #  The entry is of the form:
       #    cluname:hostname
       #  cluname - A 'cluster hostname' is needed in order to negotiate
       #            the host key.
       #  hostname- The dns name of the host.
       #
             my($cluname, $dnsname) = split(/:/, $host);
             
             my $ip = gethostbyname($dnsname);
             if(defined($ip)) {                 # bad names don't deserve entry.
               my $hostip = inet_ntoa($ip);
               $managers{$hostip} = $cluname;
               logthis('<font color="green"> registering manager '.
                       "$dnsname as $cluname with $hostip </font>\n");
            }
         } else {
            logthis('<font color="green"> existing host'." $host</font>\n");
            $managers{&Apache::lonnet::get_host_ip($host)} = $host;  # Use info from cluster tab if cluster memeber
         }
      }
 }  }
   
   #
   #  ValidManager: Determines if a given certificate represents a valid manager.
   #                in this primitive implementation, the 'certificate' is
   #                just the connecting loncapa client name.  This is checked
   #                against a valid client list in the configuration.
   #
   #                  
   sub ValidManager {
       my $certificate = shift; 
   
       return isManager;
   }
   #
   #  CopyFile:  Called as part of the process of installing a 
   #             new configuration file.  This function copies an existing
   #             file to a backup file.
   # Parameters:
   #     oldfile  - Name of the file to backup.
   #     newfile  - Name of the backup file.
   # Return:
   #     0   - Failure (errno has failure reason).
   #     1   - Success.
   #
   sub CopyFile {
   
       my ($oldfile, $newfile) = @_;
   
       if (! copy($oldfile,$newfile)) {
           return 0;
       }
       chmod(0660, $newfile);
       return 1;
   }
   #
   #  Host files are passed out with externally visible host IPs.
   #  If, for example, we are behind a fire-wall or NAT host, our 
   #  internally visible IP may be different than the externally
   #  visible IP.  Therefore, we always adjust the contents of the
   #  host file so that the entry for ME is the IP that we believe
   #  we have.  At present, this is defined as the entry that
   #  DNS has for us.  If by some chance we are not able to get a
   #  DNS translation for us, then we assume that the host.tab file
   #  is correct.  
   #    BUGBUGBUG - in the future, we really should see if we can
   #       easily query the interface(s) instead.
   # Parameter(s):
   #     contents    - The contents of the host.tab to check.
   # Returns:
   #     newcontents - The adjusted contents.
   #
   #
   sub AdjustHostContents {
       my $contents  = shift;
       my $adjusted;
       my $me        = $perlvar{'lonHostID'};
   
       foreach my $line (split(/\n/,$contents)) {
    if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/) ||
                ($line =~ /^\s*\^/))) {
       chomp($line);
       my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);
       if ($id eq $me) {
    my $ip = gethostbyname($name);
    my $ipnew = inet_ntoa($ip);
    $ip = $ipnew;
    #  Reconstruct the host line and append to adjusted:
   
    my $newline = "$id:$domain:$role:$name:$ip";
    if($maxcon ne "") { # Not all hosts have loncnew tuning params
       $newline .= ":$maxcon:$idleto:$mincon";
    }
    $adjusted .= $newline."\n";
   
       } else { # Not me, pass unmodified.
    $adjusted .= $line."\n";
       }
    } else {                  # Blank or comment never re-written.
       $adjusted .= $line."\n"; # Pass blanks and comments as is.
    }
       }
       return $adjusted;
   }
   #
   #   InstallFile: Called to install an administrative file:
   #       - The file is created int a temp directory called <name>.tmp
   #       - lcinstall file is called to install the file.
   #         since the web app has no direct write access to the table directory
 #  #
 #   Decipher encoded traffic  
 #  Parameters:  #  Parameters:
 #     input      - Encoded data.  #       Name of the file
   #       File Contents.
   #  Return:
   #      nonzero - success.
   #      0       - failure and $! has an errno.
   # Assumptions:
   #    File installtion is a relatively infrequent
   #
   sub InstallFile {
   
       my ($Filename, $Contents) = @_;
   #     my $TempFile = $Filename.".tmp";
       my $exedir = $perlvar{'lonDaemons'};
       my $tmpdir = $exedir.'/tmp/';
       my $TempFile = $tmpdir."TempTableFile.tmp";
   
       #  Open the file for write:
   
       my $fh = IO::File->new("> $TempFile"); # Write to temp.
       if(!(defined $fh)) {
    &logthis('<font color="red"> Unable to create '.$TempFile."</font>");
    return 0;
       }
       #  write the contents of the file:
   
       print $fh ($Contents); 
       $fh->close; # In case we ever have a filesystem w. locking
   
       chmod(0664, $TempFile); # Everyone can write it.
   
       # Use lcinstall file to put the file in the table directory...
   
       &Debug("Opening pipe to $exedir/lcinstallfile $TempFile $Filename");
       my $pf = IO::File->new("| $exedir/lcinstallfile   $TempFile $Filename > $exedir/logs/lcinstallfile.log");
       close $pf;
       my $err = $?;
       &Debug("Status is $err");
       if ($err != 0) {
    my $msg = $err;
    if ($err < @installerrors) {
       $msg = $installerrors[$err];
    }
    &logthis("Install failed for table file $Filename : $msg");
    return 0;
       }
   
       # Remove the temp file:
   
       unlink($TempFile);
   
       return 1;
   }
   
   
   #
   #   ConfigFileFromSelector: converts a configuration file selector
   #                 into a configuration file pathname.
   #                 Supports the following file selectors: 
   #                 hosts, domain, dns_hosts, dns_domain  
   #
   #
   #  Parameters:
   #      selector  - Configuration file selector.
 #  Returns:  #  Returns:
 #     Decoded data or undef if encryption key was not yet negotiated.  #      Full path to the file or undef if the selector is invalid.
 #  Implicit input:  
 #     cipher  - This global holds the negotiated encryption key.  
 #  #
 sub Decipher {  sub ConfigFileFromSelector {
    my $input  = shift;      my $selector   = shift;
    my $output = '';      my $tablefile;
      
          my $tabledir = $perlvar{'lonTabDir'}.'/';
    if($cipher) {      if (($selector eq "hosts") || ($selector eq "domain") || 
       my($enc, $enclength, $encinput) = split(/:/, $input);          ($selector eq "dns_hosts") || ($selector eq "dns_domain")) {
       for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {   $tablefile =  $tabledir.$selector.'.tab';
          $output .=       }
             $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));      return $tablefile;
       }  }
       return substr($output, 0, $enclength);  #
    } else {  #   PushFile:  Called to do an administrative push of a file.
       return undef;  #              - Ensure the file being pushed is one we support.
    }  #              - Backup the old file to <filename.saved>
      #              - Separate the contents of the new file out from the
   #                rest of the request.
   #              - Write the new file.
   #  Parameter:
   #     Request - The entire user request.  This consists of a : separated
   #               string pushfile:tablename:contents.
   #     NOTE:  The contents may have :'s in it as well making things a bit
   #            more interesting... but not much.
   #  Returns:
   #     String to send to client ("ok" or "refused" if bad file).
   #
   sub PushFile {
       my $request = shift;    
       my ($command, $filename, $contents) = split(":", $request, 3);
       &Debug("PushFile");
       
       #  At this point in time, pushes for only the following tables are
       #  supported:
       #   hosts.tab  ($filename eq host).
       #   domain.tab ($filename eq domain).
       #   dns_hosts.tab ($filename eq dns_host).
       #   dns_domain.tab ($filename eq dns_domain). 
       # Construct the destination filename or reject the request.
       #
       # lonManage is supposed to ensure this, however this session could be
       # part of some elaborate spoof that managed somehow to authenticate.
       #
   
   
       my $tablefile = ConfigFileFromSelector($filename);
       if(! (defined $tablefile)) {
    return "refused";
       }
   
       #  If the file being pushed is the host file, we adjust the entry for ourself so that the
       #  IP will be our current IP as looked up in dns.  Note this is only 99% good as it's possible
       #  to conceive of conditions where we don't have a DNS entry locally.  This is possible in a 
       #  network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)
       #  that possibilty.
   
       if($filename eq "host") {
    $contents = AdjustHostContents($contents);
       }
   
       #  Install the new file:
   
       &logthis("Installing new $tablefile contents:\n$contents");
       if(!InstallFile($tablefile, $contents)) {
    &logthis('<font color="red"> Pushfile: unable to install '
    .$tablefile." $! </font>");
    return "error:$!";
       } else {
    &logthis('<font color="green"> Installed new '.$tablefile
    ." - transaction by: $clientname ($clientip)</font>");
           my $adminmail = $perlvar{'lonAdmEMail'};
           my $admindom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
           if ($admindom ne '') {
               my %domconfig =
                   &Apache::lonnet::get_dom('configuration',['contacts'],$admindom);
               if (ref($domconfig{'contacts'}) eq 'HASH') {
                   if ($domconfig{'contacts'}{'adminemail'} ne '') {
                       $adminmail = $domconfig{'contacts'}{'adminemail'};
                   }
               }
           }
           if ($adminmail =~ /^[^\@]+\@[^\@]+$/) {
               my $msg = new Mail::Send;
               $msg->to($adminmail);
               $msg->subject('LON-CAPA DNS update on '.$perlvar{'lonHostID'});
               $msg->add('Content-type','text/plain; charset=UTF-8');
               if (my $fh = $msg->open()) {
                   print $fh 'Update to '.$tablefile.' from Cluster Manager '.
                             "$clientname ($clientip)\n";
                   $fh->close;
               }
           }
       }
   
       #  Indicate success:
    
       return "ok";
   
 }  }
   
 #  #
 #   Register a command processor.  This function is invoked to register a sub  #  Called to re-init either lonc or lond.
 #   to process a request.  Once registered, the ProcessRequest sub can automatically  #
 #   dispatch requests to an appropriate sub, and do the top level validity checking  #  Parameters:
 #   as well:  #    request   - The full request by the client.  This is of the form
 #    - Is the keyword recognized.  #                reinit:<process>  
 #    - Is the proper client type attempting the request.  #                where <process> is allowed to be either of 
 #    - Is the request encrypted if it has to be.  #                lonc or lond
   #
   #  Returns:
   #     The string to be sent back to the client either:
   #   ok         - Everything worked just fine.
   #   error:why  - There was a failure and why describes the reason.
   #
   #
   sub ReinitProcess {
       my $request = shift;
   
   
       # separate the request (reinit) from the process identifier and
       # validate it producing the name of the .pid file for the process.
       #
       #
       my ($junk, $process) = split(":", $request);
       my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';
       if($process eq 'lonc') {
    $processpidfile = $processpidfile."lonc.pid";
    if (!open(PIDFILE, "< $processpidfile")) {
       return "error:Open failed for $processpidfile";
    }
    my $loncpid = <PIDFILE>;
    close(PIDFILE);
    logthis('<font color="red"> Reinitializing lonc pid='.$loncpid
    ."</font>");
    kill("USR2", $loncpid);
       } elsif ($process eq 'lond') {
    logthis('<font color="red"> Reinitializing self (lond) </font>');
    &UpdateHosts; # Lond is us!!
       } else {
    &logthis('<font color="yellow" Invalid reinit request for '.$process
    ."</font>");
    return "error:Invalid process identifier $process";
       }
       return 'ok';
   }
   #   Validate a line in a configuration file edit script:
   #   Validation includes:
   #     - Ensuring the command is valid.
   #     - Ensuring the command has sufficient parameters
 #   Parameters:  #   Parameters:
 #    $RequestName         - Name of the request being registered.  #     scriptline - A line to validate (\n has been stripped for what it's worth).
 #                           This is the command request that will match  
 #                           against the hash keywords to lookup the information  
 #                           associated with the dispatch information.  
 #    $Procedure           - Reference to a sub to call to process the request.  
 #                           All subs get called as follows:  
 #                             Procedure($cmd, $tail, $replyfd, $key)  
 #                             $cmd    - the actual keyword that invoked us.  
 #                             $tail   - the tail of the request that invoked us.  
 #                             $replyfd- File descriptor connected to the client  
 #    $MustEncode          - True if the request must be encoded to be good.  
 #    $ClientOk            - True if it's ok for a client to request this.  
 #    $ManagerOk           - True if it's ok for a manager to request this.  
 # Side effects:  
 #      - On success, the Dispatcher hash has an entry added for the key $RequestName  
 #      - On failure, the program will die as it's a bad internal bug to try to   
 #        register a duplicate command handler.  
 #  #
 sub RegisterHandler {  #   Return:
    my $RequestName    = shift;  #      0     - Invalid scriptline.
    my $Procedure      = shift;  #      1     - Valid scriptline
    my $MustEncode     = shift;  #  NOTE:
    my $ClientOk       = shift;  #     Only the command syntax is checked, not the executability of the
    my $ManagerOk      = shift;  #     command.
      #
    #  Don't allow duplication#  sub isValidEditCommand {
          my $scriptline = shift;
    if (defined $Dispatcher{$RequestName}) {  
       die "Attempting to define a duplicate request handler for $RequestName\n";      #   Line elements are pipe separated:
    }  
    #   Build the client type mask:      my ($command, $key, $newline)  = split(/\|/, $scriptline);
          &logthis('<font color="green"> isValideditCommand checking: '.
    my $ClientTypeMask = 0;       "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
    if($ClientOk) {      
       $ClientTypeMask  |= $CLIENT_OK;      if ($command eq "delete") {
    }   #
    if($ManagerOk) {   #   key with no newline.
       $ClientTypeMask  |= $MANAGER_OK;   #
    }   if( ($key eq "") || ($newline ne "")) {
          return 0; # Must have key but no newline.
    #  Enter the hash:   } else {
             return 1; # Valid syntax.
    my @entry = ($Procedure, $MustEncode, $ClientTypeMask);   }
          } elsif ($command eq "replace") {
    $Dispatcher{$RequestName} = \@entry;   #
       #   key and newline:
       #
    if (($key eq "") || ($newline eq "")) {
       return 0;
    } else {
       return 1;
    }
       } elsif ($command eq "append") {
    if (($key ne "") && ($newline eq "")) {
       return 1;
    } else {
       return 0;
    }
       } else {
    return 0; # Invalid command.
       }
       return 0; # Should not get here!!!
 }  }
   #
   #   ApplyEdit - Applies an edit command to a line in a configuration 
   #               file.  It is the caller's responsiblity to validate the
   #               edit line.
   #   Parameters:
   #      $directive - A single edit directive to apply.  
   #                   Edit directives are of the form:
   #                  append|newline      - Appends a new line to the file.
   #                  replace|key|newline - Replaces the line with key value 'key'
   #                  delete|key          - Deletes the line with key value 'key'.
   #      $editor   - A config file editor object that contains the
   #                  file being edited.
   #
   sub ApplyEdit {
   
       my ($directive, $editor) = @_;
   
       # Break the directive down into its command and its parameters
       # (at most two at this point.  The meaning of the parameters, if in fact
       #  they exist depends on the command).
   
       my ($command, $p1, $p2) = split(/\|/, $directive);
   
       if($command eq "append") {
    $editor->Append($p1);          # p1 - key p2 null.
       } elsif ($command eq "replace") {
    $editor->ReplaceLine($p1, $p2);   # p1 - key p2 = newline.
       } elsif ($command eq "delete") {
    $editor->DeleteLine($p1);         # p1 - key p2 null.
       } else {          # Should not get here!!!
    die "Invalid command given to ApplyEdit $command"
       }
   }
   #
   # AdjustOurHost:
   #           Adjusts a host file stored in a configuration file editor object
   #           for the true IP address of this host. This is necessary for hosts
   #           that live behind a firewall.
   #           Those hosts have a publicly distributed IP of the firewall, but
   #           internally must use their actual IP.  We assume that a given
   #           host only has a single IP interface for now.
   # Formal Parameters:
   #     editor   - The configuration file editor to adjust.  This
   #                editor is assumed to contain a hosts.tab file.
   # Strategy:
   #    - Figure out our hostname.
   #    - Lookup the entry for this host.
   #    - Modify the line to contain our IP
   #    - Do a replace for this host.
   sub AdjustOurHost {
       my $editor        = shift;
   
       # figure out who I am.
   
       my $myHostName    = $perlvar{'lonHostID'}; # LonCAPA hostname.
   
       #  Get my host file entry.
   
       my $ConfigLine    = $editor->Find($myHostName);
       if(! (defined $ConfigLine)) {
    die "AdjustOurHost - no entry for me in hosts file $myHostName";
       }
       # figure out my IP:
       #   Use the config line to get my hostname.
       #   Use gethostbyname to translate that into an IP address.
       #
       my ($id,$domain,$role,$name,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);
       #
       #  Reassemble the config line from the elements in the list.
       #  Note that if the loncnew items were not present before, they will
       #  be now even if they would be empty
       #
       my $newConfigLine = $id;
       foreach my $item ($domain, $role, $name, $maxcon, $idleto, $mincon) {
    $newConfigLine .= ":".$item;
       }
       #  Replace the line:
   
       $editor->ReplaceLine($id, $newConfigLine);
       
   }
   #
   #   ReplaceConfigFile:
   #              Replaces a configuration file with the contents of a
   #              configuration file editor object.
   #              This is done by:
   #              - Copying the target file to <filename>.old
   #              - Writing the new file to <filename>.tmp
   #              - Moving <filename.tmp>  -> <filename>
   #              This laborious process ensures that the system is never without
   #              a configuration file that's at least valid (even if the contents
   #              may be dated).
   #   Parameters:
   #        filename   - Name of the file to modify... this is a full path.
   #        editor     - Editor containing the file.
   #
   sub ReplaceConfigFile {
       
       my ($filename, $editor) = @_;
   
       CopyFile ($filename, $filename.".old");
   
       my $contents  = $editor->Get(); # Get the contents of the file.
   
       InstallFile($filename, $contents);
   }
   #   
   #
   #   Called to edit a configuration table  file
   #   Parameters:
   #      request           - The entire command/request sent by lonc or lonManage
   #   Return:
   #      The reply to send to the client.
   #
   sub EditFile {
       my $request = shift;
   
       #  Split the command into it's pieces:  edit:filetype:script
   
       my ($cmd, $filetype, $script) = split(/:/, $request,3); # : in script
   
       #  Check the pre-coditions for success:
   
       if($cmd != "edit") { # Something is amiss afoot alack.
    return "error:edit request detected, but request != 'edit'\n";
       }
       if( ($filetype ne "hosts")  &&
    ($filetype ne "domain")) {
    return "error:edit requested with invalid file specifier: $filetype \n";
       }
   
       #   Split the edit script and check it's validity.
   
       my @scriptlines = split(/\n/, $script);  # one line per element.
       my $linecount   = scalar(@scriptlines);
       for(my $i = 0; $i < $linecount; $i++) {
    chomp($scriptlines[$i]);
    if(!isValidEditCommand($scriptlines[$i])) {
       return "error:edit with bad script line: '$scriptlines[$i]' \n";
    }
       }
   
       #   Execute the edit operation.
       #   - Create a config file editor for the appropriate file and 
       #   - execute each command in the script:
       #
       my $configfile = ConfigFileFromSelector($filetype);
       if (!(defined $configfile)) {
    return "refused\n";
       }
       my $editor = ConfigFileEdit->new($configfile);
   
       for (my $i = 0; $i < $linecount; $i++) {
    ApplyEdit($scriptlines[$i], $editor);
       }
       # If the file is the host file, ensure that our host is
       # adjusted to have our ip:
       #
       if($filetype eq "host") {
    AdjustOurHost($editor);
       }
       #  Finally replace the current file with our file.
       #
       ReplaceConfigFile($configfile, $editor);
   
       return "ok\n";
   }
   
   #   read_profile
   #
   #   Returns a set of specific entries from a user's profile file.
   #   this is a utility function that is used by both get_profile_entry and
   #   get_profile_entry_encrypted.
   #
   # Parameters:
   #    udom       - Domain in which the user exists.
   #    uname      - User's account name (loncapa account)
   #    namespace  - The profile namespace to open.
   #    what       - A set of & separated queries.
   # Returns:
   #    If all ok: - The string that needs to be shipped back to the user.
   #    If failure - A string that starts with error: followed by the failure
   #                 reason.. note that this probabyl gets shipped back to the
   #                 user as well.
   #
   sub read_profile {
       my ($udom, $uname, $namespace, $what) = @_;
       
       my $hashref = &tie_user_hash($udom, $uname, $namespace,
    &GDBM_READER());
       if ($hashref) {
           my @queries=split(/\&/,$what);
           if ($namespace eq 'roles') {
               @queries = map { &unescape($_); } @queries; 
           }
           my $qresult='';
   
    for (my $i=0;$i<=$#queries;$i++) {
       $qresult.="$hashref->{$queries[$i]}&";    # Presumably failure gives empty string.
    }
    $qresult=~s/\&$//;              # Remove trailing & from last lookup.
    if (&untie_user_hash($hashref)) {
       return $qresult;
    } else {
       return "error: ".($!+0)." untie (GDBM) Failed";
    }
       } else {
    if ($!+0 == 2) {
       return "error:No such file or GDBM reported bad block error";
    } else {
       return "error: ".($!+0)." tie (GDBM) Failed";
    }
       }
   
   }
 #--------------------- Request Handlers --------------------------------------------  #--------------------- Request Handlers --------------------------------------------
 #  #
 #   By convention each request handler registers itself prior to the sub declaration:  #   By convention each request handler registers itself prior to the sub 
   #   declaration:
 #  #
   
   #++
   #
 #  Handles ping requests.  #  Handles ping requests.
 #  Parameters:  #  Parameters:
 #      $cmd    - the actual keyword that invoked us.  #      $cmd    - the actual keyword that invoked us.
Line 282  sub RegisterHandler { Line 1026  sub RegisterHandler {
 #      0       - Program should exit.  #      0       - Program should exit.
 #  Side effects:  #  Side effects:
 #      Reply information is sent to the client.  #      Reply information is sent to the client.
   sub ping_handler {
 sub PingHandler {      my ($cmd, $tail, $client) = @_;
    my $cmd    = shift;      Debug("$cmd $tail $client .. $currenthostid:");
    my $tail   = shift;  
    my $client = shift;  
         
    Reply( $client,"$currenthostid\n","$cmd:$tail");      Reply( $client,\$currenthostid,"$cmd:$tail");
         
    return 1;      return 1;
 }  }
 RegisterHandler("ping", \&PingHandler, 0, 1, 1);       # Ping unencoded, client or manager.  &register_handler("ping", \&ping_handler, 0, 1, 1);       # Ping unencoded, client or manager.
   
   #++
   #
   # Handles pong requests.  Pong replies with our current host id, and
   #                         the results of a ping sent to us via our lonc.
 #  #
 # Handles pong reequests:  
 # Parameters:  # Parameters:
 #      $cmd    - the actual keyword that invoked us.  #      $cmd    - the actual keyword that invoked us.
 #      $tail   - the tail of the request that invoked us.  #      $tail   - the tail of the request that invoked us.
Line 307  RegisterHandler("ping", \&PingHandler, 0 Line 1053  RegisterHandler("ping", \&PingHandler, 0
 #      0       - Program should exit.  #      0       - Program should exit.
 #  Side effects:  #  Side effects:
 #      Reply information is sent to the client.  #      Reply information is sent to the client.
   sub pong_handler {
       my ($cmd, $tail, $replyfd) = @_;
   
 sub PongHandler {      my $reply=&Apache::lonnet::reply("ping",$clientname);
    my $cmd     = shift;      &Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail"); 
    my $tail    = shift;      return 1;
    my $replyfd = shift;  
   
    my $reply=&reply("ping",$clientname);  
    Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");   
    return 1;  
 }  }
 RegisterHandler("pong", \&PongHandler, 0, 1, 1);       # Pong unencoded, client or manager  &register_handler("pong", \&pong_handler, 0, 1, 1);       # Pong unencoded, client or manager
   
 #  #++
 #   EstablishKeyHandler:  
 #      Called to establish an encrypted session key with the remote client.  #      Called to establish an encrypted session key with the remote client.
 #  #      Note that with secure lond, in most cases this function is never
   #      invoked.  Instead, the secure session key is established either
   #      via a local file that's locked down tight and only lives for a short
   #      time, or via an ssl tunnel...and is generated from a bunch-o-random
   #      bits from /dev/urandom, rather than the predictable pattern used by
   #      by this sub.  This sub is only used in the old-style insecure
   #      key negotiation.
 # Parameters:  # Parameters:
 #      $cmd    - the actual keyword that invoked us.  #      $cmd    - the actual keyword that invoked us.
 #      $tail   - the tail of the request that invoked us.  #      $tail   - the tail of the request that invoked us.
Line 330  RegisterHandler("pong", \&PongHandler, 0 Line 1078  RegisterHandler("pong", \&PongHandler, 0
 #  Implicit Inputs:  #  Implicit Inputs:
 #      $currenthostid - Global variable that carries the name of the host  #      $currenthostid - Global variable that carries the name of the host
 #                       known as.  #                       known as.
 #      $clientname    - Global variable that carries the name of the hsot we're connected to.  #      $clientname    - Global variable that carries the name of the host we're connected to.
 #  Returns:  #  Returns:
 #      1       - Ok to continue processing.  #      1       - Ok to continue processing.
 #      0       - Program should exit.  #      0       - Program should exit.
Line 338  RegisterHandler("pong", \&PongHandler, 0 Line 1086  RegisterHandler("pong", \&PongHandler, 0
 #      Reply information is sent to the client.  #      Reply information is sent to the client.
 #      $cipher is set with a reference to a new IDEA encryption object.  #      $cipher is set with a reference to a new IDEA encryption object.
 #  #
 sub EstablishKeyHandler {  sub establish_key_handler {
    my $cmd      = shift;      my ($cmd, $tail, $replyfd) = @_;
    my $tail     = shift;  
    my $replyfd  = shift;      my $buildkey=time.$$.int(rand 100000);
       $buildkey=~tr/1-6/A-F/;
    my $buildkey=time.$$.int(rand 100000);      $buildkey=int(rand 100000).$buildkey.int(rand 100000);
    $buildkey=~tr/1-6/A-F/;      my $key=$currenthostid.$clientname;
    $buildkey=int(rand 100000).$buildkey.int(rand 100000);      $key=~tr/a-z/A-Z/;
    my $key=$currenthostid.$clientname;      $key=~tr/G-P/0-9/;
    $key=~tr/a-z/A-Z/;      $key=~tr/Q-Z/0-9/;
    $key=~tr/G-P/0-9/;      $key=$key.$buildkey.$key.$buildkey.$key.$buildkey;
    $key=~tr/Q-Z/0-9/;      $key=substr($key,0,32);
    $key=$key.$buildkey.$key.$buildkey.$key.$buildkey;      my $cipherkey=pack("H32",$key);
    $key=substr($key,0,32);      $cipher=new IDEA $cipherkey;
    my $cipherkey=pack("H32",$key);      &Reply($replyfd, \$buildkey, "$cmd:$tail"); 
    $cipher=new IDEA $cipherkey;  
    Reply($replyfd, "$buildkey\n", "$cmd:$tail");   
         
    return 1;      return 1;
   
 }  }
 RegisterHandler("ekey", \&EstablishKeyHandler, 0, 1,1);  &register_handler("ekey", \&establish_key_handler, 0, 1,1);
   
 #  LoadHandler:  
 #     Handler for the load command.  Returns the current system load average  #     Handler for the load command.  Returns the current system load average
 #     to the requestor.  #     to the requestor.
 #  #
Line 372  RegisterHandler("ekey", \&EstablishKeyHa Line 1117  RegisterHandler("ekey", \&EstablishKeyHa
 #  Implicit Inputs:  #  Implicit Inputs:
 #      $currenthostid - Global variable that carries the name of the host  #      $currenthostid - Global variable that carries the name of the host
 #                       known as.  #                       known as.
 #      $clientname    - Global variable that carries the name of the hsot we're connected to.  #      $clientname    - Global variable that carries the name of the host we're connected to.
 #  Returns:  #  Returns:
 #      1       - Ok to continue processing.  #      1       - Ok to continue processing.
 #      0       - Program should exit.  #      0       - Program should exit.
 #  Side effects:  #  Side effects:
 #      Reply information is sent to the client.  #      Reply information is sent to the client.
 sub LoadHandler {  sub load_handler {
    my $cmd     = shift;      my ($cmd, $tail, $replyfd) = @_;
    my $tail    = shift;  
    my $replyfd = shift;  
   
    # Get the load average from /proc/loadavg and calculate it as a percentage of     # Get the load average from /proc/loadavg and calculate it as a percentage of
    # the allowed load limit as set by the perl global variable lonLoadLim     # the allowed load limit as set by the perl global variable lonLoadLim
   
    my $loadavg;      my $loadavg;
    my $loadfile=IO::File->new('/proc/loadavg');      my $loadfile=IO::File->new('/proc/loadavg');
         
    $loadavg=<$loadfile>;      $loadavg=<$loadfile>;
    $loadavg =~ s/\s.*//g;                       # Extract the first field only.      $loadavg =~ s/\s.*//g;                      # Extract the first field only.
         
    my $loadpercent=100*$loadavg/$perlvar{'lonLoadLim'};      my $loadpercent=100*$loadavg/$perlvar{'lonLoadLim'};
   
    Reply( $replyfd, "$loadpercent\n", "$cmd:$tail");      &Reply( $replyfd, \$loadpercent, "$cmd:$tail");
         
    return 1;      return 1;
 }  }
 RegisterHandler("load", \&LoadHandler, 0, 1, 0);  &register_handler("load", \&load_handler, 0, 1, 0);
   
   
 #  #
 #   Process the userload request.  This sub returns to the client the current  #   Process the userload request.  This sub returns to the client the current
Line 412  RegisterHandler("load", \&LoadHandler, 0 Line 1156  RegisterHandler("load", \&LoadHandler, 0
 #  Implicit Inputs:  #  Implicit Inputs:
 #      $currenthostid - Global variable that carries the name of the host  #      $currenthostid - Global variable that carries the name of the host
 #                       known as.  #                       known as.
 #      $clientname    - Global variable that carries the name of the hsot we're connected to.  #      $clientname    - Global variable that carries the name of the host we're connected to.
 #  Returns:  #  Returns:
 #      1       - Ok to continue processing.  #      1       - Ok to continue processing.
 #      0       - Program should exit  #      0       - Program should exit
Line 421  RegisterHandler("load", \&LoadHandler, 0 Line 1165  RegisterHandler("load", \&LoadHandler, 0
 #  Implicit outputs:  #  Implicit outputs:
 #     the reply is written to the client.  #     the reply is written to the client.
 #  #
 sub UserLoadHandler {  sub user_load_handler {
    my $cmd     = shift;      my ($cmd, $tail, $replyfd) = @_;
    my $tail    = shift;  
    my $replyfd = shift;  
   
    my $userloadpercent=&userload();  
    Reply($replyfd, "$userloadpercent\n", "$cmd:$tail");  
   
    return 1;      my $userloadpercent=&Apache::lonnet::userload();
       &Reply($replyfd, \$userloadpercent, "$cmd:$tail");
       
       return 1;
 }  }
 RegisterHandler("userload", \&UserLoadHandler, 0, 1, 0);  &register_handler("userload", \&user_load_handler, 0, 1, 0);
   
 #   Process a request for the authorization type of a user:  #   Process a request for the authorization type of a user:
 #   (userauth).  #   (userauth).
Line 446  RegisterHandler("userload", \&UserLoadHa Line 1188  RegisterHandler("userload", \&UserLoadHa
 # Implicit outputs:  # Implicit outputs:
 #    The user authorization type is written to the client.  #    The user authorization type is written to the client.
 #  #
 sub UserAuthorizationType {  sub user_authorization_type {
    my $cmd     = shift;      my ($cmd, $tail, $replyfd) = @_;
    my $tail    = shift;  
    my $replyfd = shift;  
         
    my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
         
    #  Pull the domain and username out of the command tail.      #  Pull the domain and username out of the command tail.
    # and call GetAuthType to determine the authentication type.      # and call get_auth_type to determine the authentication type.
         
    my ($udom,$uname)=split(/:/,$tail);      my ($udom,$uname)=split(/:/,$tail);
    my $result = GetAuthType($udom, $uname);      my $result = &get_auth_type($udom, $uname);
    if($result eq "nouser") {      if($result eq "nouser") {
       Failure( $replyfd, "unknown_user\n", $userinput);   &Failure( $replyfd, "unknown_user\n", $userinput);
    } else {      } else {
       Reply( $replyfd, "$result\n", $userinput);   #
    }   # We only want to pass the second field from get_auth_type
    # for ^krb.. otherwise we'll be handing out the encrypted
    # password for internals e.g.
    #
    my ($type,$otherinfo) = split(/:/,$result);
    if($type =~ /^krb/) {
       $type = $result;
    } else {
               $type .= ':';
           }
    &Reply( $replyfd, \$type, $userinput);
       }
       
    return 1;      return 1;
 }  }
 RegisterHandler("currentauth", \&UserAuthorizationType, 1, 1, 0);  &register_handler("currentauth", \&user_authorization_type, 1, 1, 0);
 #  
 #   Process a request by a manager to push a hosts or domain table   #   Process a request by a manager to push a hosts or domain table 
 #   to us.  We pick apart the command and pass it on to the subs  #   to us.  We pick apart the command and pass it on to the subs
 #   that already exist to do this.  #   that already exist to do this.
Line 481  RegisterHandler("currentauth", \&UserAut Line 1232  RegisterHandler("currentauth", \&UserAut
 #      0       - Program should exit  #      0       - Program should exit
 # Implicit Output:  # Implicit Output:
 #    a reply is written to the client.  #    a reply is written to the client.
   sub push_file_handler {
       my ($cmd, $tail, $client) = @_;
       &Debug("In push file handler");
       my $userinput = "$cmd:$tail";
   
       # At this time we only know that the IP of our partner is a valid manager
       # the code below is a hook to do further authentication (e.g. to resolve
       # spoofing).
   
       my $cert = &GetCertificate($userinput);
       if(&ValidManager($cert)) {
    &Debug("Valid manager: $client");
   
 sub PushFileHandler {   # Now presumably we have the bona fides of both the peer host and the
    my $cmd    = shift;   # process making the request.
    my $tail   = shift;        
    my $client = shift;   my $reply = &PushFile($userinput);
    &Reply($client, \$reply, $userinput);
    my $userinput = "$cmd:$tail";  
   
    # At this time we only know that the IP of our partner is a valid manager  
    # the code below is a hook to do further authentication (e.g. to resolve  
    # spoofing).  
   
    my $cert = GetCertificate($userinput);      } else {
    if(ValidManager($cert)) {    &logthis("push_file_handler $client is not valid");
    &Failure( $client, "refused\n", $userinput);
       } 
       return 1;
   }
   &register_handler("pushfile", \&push_file_handler, 1, 0, 1);
   
       # Now presumably we have the bona fides of both the peer host and the  # The du_handler routine should be considered obsolete and is retained
       # process making the request.  # for communication with legacy servers.  Please see the du2_handler.
         #
       my $reply = PushFile($userinput);  #   du  - list the disk usage of a directory recursively. 
       Reply($client, "$reply\n", $userinput);  #    
   #   note: stolen code from the ls file handler
   #   under construction by Rick Banghart 
   #    .
   # Parameters:
   #    $cmd        - The command that dispatched us (du).
   #    $ududir     - The directory path to list... I'm not sure what this
   #                  is relative as things like ls:. return e.g.
   #                  no_such_dir.
   #    $client     - Socket open on the client.
   # Returns:
   #     1 - indicating that the daemon should not disconnect.
   # Side Effects:
   #   The reply is written to  $client.
   #
   sub du_handler {
       my ($cmd, $ududir, $client) = @_;
       ($ududir) = split(/:/,$ududir); # Make 'telnet' testing easier.
       my $userinput = "$cmd:$ududir";
   
    } else {      if ($ududir=~/\.\./ || $ududir!~m|^/home/httpd/|) {
       Failure( $client, "refused\n", $userinput);   &Failure($client,"refused\n","$cmd:$ududir");
    }    return 1;
       }
       #  Since $ududir could have some nasties in it,
       #  we will require that ududir is a valid
       #  directory.  Just in case someone tries to
       #  slip us a  line like .;(cd /home/httpd rm -rf*)
       #  etc.
       #
       if (-d $ududir) {
    my $total_size=0;
    my $code=sub { 
       if ($_=~/\.\d+\./) { return;} 
       if ($_=~/\.meta$/) { return;}
       if (-d $_)         { return;}
       $total_size+=(stat($_))[7];
    };
    chdir($ududir);
    find($code,$ududir);
    $total_size=int($total_size/1024);
    &Reply($client,\$total_size,"$cmd:$ududir");
       } else {
    &Failure($client, "bad_directory:$ududir\n","$cmd:$ududir"); 
       }
       return 1;
 }  }
 RegisterHandler("pushfile", \&PushFileHandler, 1, 0, 1);  &register_handler("du", \&du_handler, 0, 1, 0);
   
   # Please also see the du_handler, which is obsoleted by du2. 
   # du2_handler differs from du_handler in that required path to directory
   # provided by &propath() is prepended in the handler instead of on the 
   # client side.
   #
   #   du2  - list the disk usage of a directory recursively.
   #
   # Parameters:
   #    $cmd        - The command that dispatched us (du).
   #    $tail       - The tail of the request that invoked us.
   #                  $tail is a : separated list of the following:
   #                   - $ududir - directory path to list (before prepending)
   #                   - $getpropath = 1 if &propath() should prepend
   #                   - $uname - username to use for &propath or user dir
   #                   - $udom - domain to use for &propath or user dir
   #                   All are escaped.
   #    $client     - Socket open on the client.
   # Returns:
   #     1 - indicating that the daemon should not disconnect.
   # Side Effects:
   #   The reply is written to $client.
   #
   
   sub du2_handler {
       my ($cmd, $tail, $client) = @_;
       my ($ududir,$getpropath,$uname,$udom) = map { &unescape($_) } (split(/:/, $tail));
       my $userinput = "$cmd:$tail";
       if (($ududir=~/\.\./) || (($ududir!~m|^/home/httpd/|) && (!$getpropath))) {
           &Failure($client,"refused\n","$cmd:$tail");
           return 1;
       }
       if ($getpropath) {
           if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
               $ududir = &propath($udom,$uname).'/'.$ududir;
           } else {
               &Failure($client,"refused\n","$cmd:$tail");
               return 1;
           }
       }
       #  Since $ududir could have some nasties in it,
       #  we will require that ududir is a valid
       #  directory.  Just in case someone tries to
       #  slip us a  line like .;(cd /home/httpd rm -rf*)
       #  etc.
       #
       if (-d $ududir) {
           my $total_size=0;
           my $code=sub {
               if ($_=~/\.\d+\./) { return;}
               if ($_=~/\.meta$/) { return;}
               if (-d $_)         { return;}
               $total_size+=(stat($_))[7];
           };
           chdir($ududir);
           find($code,$ududir);
           $total_size=int($total_size/1024);
           &Reply($client,\$total_size,"$cmd:$ududir");
       } else {
           &Failure($client, "bad_directory:$ududir\n","$cmd:$tail");
       }
       return 1;
   }
   &register_handler("du2", \&du2_handler, 0, 1, 0);
   
   #
   # The ls_handler routine should be considered obsolete and is retained
   # for communication with legacy servers.  Please see the ls3_handler.
   #
   #   ls  - list the contents of a directory.  For each file in the
   #    selected directory the filename followed by the full output of
   #    the stat function is returned.  The returned info for each
   #    file are separated by ':'.  The stat fields are separated by &'s.
   # Parameters:
   #    $cmd        - The command that dispatched us (ls).
   #    $ulsdir     - The directory path to list... I'm not sure what this
   #                  is relative as things like ls:. return e.g.
   #                  no_such_dir.
   #    $client     - Socket open on the client.
   # Returns:
   #     1 - indicating that the daemon should not disconnect.
   # Side Effects:
   #   The reply is written to  $client.
   #
   sub ls_handler {
       # obsoleted by ls2_handler
       my ($cmd, $ulsdir, $client) = @_;
   
       my $userinput = "$cmd:$ulsdir";
   
       my $obs;
       my $rights;
       my $ulsout='';
       my $ulsfn;
       if (-e $ulsdir) {
    if(-d $ulsdir) {
       if (opendir(LSDIR,$ulsdir)) {
    while ($ulsfn=readdir(LSDIR)) {
       undef($obs);
       undef($rights); 
       my @ulsstats=stat($ulsdir.'/'.$ulsfn);
       #We do some obsolete checking here
       if(-e $ulsdir.'/'.$ulsfn.".meta") { 
    open(FILE, $ulsdir.'/'.$ulsfn.".meta");
    my @obsolete=<FILE>;
    foreach my $obsolete (@obsolete) {
       if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; } 
       if($obsolete =~ m|(<copyright>)(default)|) { $rights = 1; }
    }
       }
       $ulsout.=$ulsfn.'&'.join('&',@ulsstats);
       if($obs eq '1') { $ulsout.="&1"; }
       else { $ulsout.="&0"; }
       if($rights eq '1') { $ulsout.="&1:"; }
       else { $ulsout.="&0:"; }
    }
    closedir(LSDIR);
       }
    } else {
       my @ulsstats=stat($ulsdir);
       $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
    }
       } else {
    $ulsout='no_such_dir';
       }
       if ($ulsout eq '') { $ulsout='empty'; }
       &Reply($client, \$ulsout, $userinput); # This supports debug logging.
       
       return 1;
   
   }
   &register_handler("ls", \&ls_handler, 0, 1, 0);
   
   # The ls2_handler routine should be considered obsolete and is retained
   # for communication with legacy servers.  Please see the ls3_handler.
   # Please also see the ls_handler, which was itself obsoleted by ls2.
   # ls2_handler differs from ls_handler in that it escapes its return 
   # values before concatenating them together with ':'s.
   #
   #   ls2  - list the contents of a directory.  For each file in the
   #    selected directory the filename followed by the full output of
   #    the stat function is returned.  The returned info for each
   #    file are separated by ':'.  The stat fields are separated by &'s.
   # Parameters:
   #    $cmd        - The command that dispatched us (ls).
   #    $ulsdir     - The directory path to list... I'm not sure what this
   #                  is relative as things like ls:. return e.g.
   #                  no_such_dir.
   #    $client     - Socket open on the client.
   # Returns:
   #     1 - indicating that the daemon should not disconnect.
   # Side Effects:
   #   The reply is written to  $client.
   #
   sub ls2_handler {
       my ($cmd, $ulsdir, $client) = @_;
   
       my $userinput = "$cmd:$ulsdir";
   
       my $obs;
       my $rights;
       my $ulsout='';
       my $ulsfn;
       if (-e $ulsdir) {
           if(-d $ulsdir) {
               if (opendir(LSDIR,$ulsdir)) {
                   while ($ulsfn=readdir(LSDIR)) {
                       undef($obs);
       undef($rights); 
                       my @ulsstats=stat($ulsdir.'/'.$ulsfn);
                       #We do some obsolete checking here
                       if(-e $ulsdir.'/'.$ulsfn.".meta") { 
                           open(FILE, $ulsdir.'/'.$ulsfn.".meta");
                           my @obsolete=<FILE>;
                           foreach my $obsolete (@obsolete) {
                               if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; } 
                               if($obsolete =~ m|(<copyright>)(default)|) {
                                   $rights = 1;
                               }
                           }
                       }
                       my $tmp = $ulsfn.'&'.join('&',@ulsstats);
                       if ($obs    eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
                       if ($rights eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
                       $ulsout.= &escape($tmp).':';
                   }
                   closedir(LSDIR);
               }
           } else {
               my @ulsstats=stat($ulsdir);
               $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
           }
       } else {
           $ulsout='no_such_dir';
      }
      if ($ulsout eq '') { $ulsout='empty'; }
      &Reply($client, \$ulsout, $userinput); # This supports debug logging.
      return 1;
   }
   &register_handler("ls2", \&ls2_handler, 0, 1, 0);
   #
   #   ls3  - list the contents of a directory.  For each file in the
   #    selected directory the filename followed by the full output of
   #    the stat function is returned.  The returned info for each
   #    file are separated by ':'.  The stat fields are separated by &'s.
   # Parameters:
   #    $cmd        - The command that dispatched us (ls).
   #    $tail       - The tail of the request that invoked us.
   #                  $tail is a : separated list of the following:
   #                   - $ulsdir - directory path to list (before prepending)
   #                   - $getpropath = 1 if &propath() should prepend
   #                   - $getuserdir = 1 if path to user dir in lonUsers should
   #                                     prepend
   #                   - $alternate_root - path to prepend
   #                   - $uname - username to use for &propath or user dir
   #                   - $udom - domain to use for &propath or user dir
   #            All of these except $getpropath and &getuserdir are escaped.    
   #                  no_such_dir.
   #    $client     - Socket open on the client.
   # Returns:
   #     1 - indicating that the daemon should not disconnect.
   # Side Effects:
   #   The reply is written to $client.
   #
   
   sub ls3_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($ulsdir,$getpropath,$getuserdir,$alternate_root,$uname,$udom) =
           split(/:/,$tail);
       if (defined($ulsdir)) {
           $ulsdir = &unescape($ulsdir);
       }
       if (defined($alternate_root)) {
           $alternate_root = &unescape($alternate_root);
       }
       if (defined($uname)) {
           $uname = &unescape($uname);
       }
       if (defined($udom)) {
           $udom = &unescape($udom);
       }
   
       my $dir_root = $perlvar{'lonDocRoot'};
       if ($getpropath) {
           if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
               $dir_root = &propath($udom,$uname);
               $dir_root =~ s/\/$//;
           } else {
               &Failure($client,"refused\n","$cmd:$tail");
               return 1;
           }
       } elsif ($getuserdir) {
           if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
               my $subdir=$uname.'__';
               $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
               $dir_root = $Apache::lonnet::perlvar{'lonUsersDir'}
                          ."/$udom/$subdir/$uname";
           } else {
               &Failure($client,"refused\n","$cmd:$tail");
               return 1;
           }
       } elsif ($alternate_root ne '') {
           $dir_root = $alternate_root;
       }
       if (($dir_root ne '') && ($dir_root ne '/')) {
           if ($ulsdir =~ /^\//) {
               $ulsdir = $dir_root.$ulsdir;
           } else {
               $ulsdir = $dir_root.'/'.$ulsdir;
           }
       }
       my $obs;
       my $rights;
       my $ulsout='';
       my $ulsfn;
       if (-e $ulsdir) {
           if(-d $ulsdir) {
               if (opendir(LSDIR,$ulsdir)) {
                   while ($ulsfn=readdir(LSDIR)) {
                       undef($obs);
                       undef($rights);
                       my @ulsstats=stat($ulsdir.'/'.$ulsfn);
                       #We do some obsolete checking here
                       if(-e $ulsdir.'/'.$ulsfn.".meta") {
                           open(FILE, $ulsdir.'/'.$ulsfn.".meta");
                           my @obsolete=<FILE>;
                           foreach my $obsolete (@obsolete) {
                               if($obsolete =~ m/(<obsolete>)(on|1)/) { $obs = 1; }
                               if($obsolete =~ m|(<copyright>)(default)|) {
                                   $rights = 1;
                               }
                           }
                       }
                       my $tmp = $ulsfn.'&'.join('&',@ulsstats);
                       if ($obs    eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
                       if ($rights eq '1') { $tmp.="&1"; } else { $tmp.="&0"; }
                       $ulsout.= &escape($tmp).':';
                   }
                   closedir(LSDIR);
               }
           } else {
               my @ulsstats=stat($ulsdir);
               $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';
           }
       } else {
           $ulsout='no_such_dir';
       }
       if ($ulsout eq '') { $ulsout='empty'; }
       &Reply($client, \$ulsout, $userinput); # This supports debug logging.
       return 1;
   }
   &register_handler("ls3", \&ls3_handler, 0, 1, 0);
   
   sub read_lonnet_global {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
       my $requested = &Apache::lonnet::thaw_unescape($tail);
       my $result;
       my %packagevars = (
                           spareid => \%Apache::lonnet::spareid,
                           perlvar => \%Apache::lonnet::perlvar,
                         );
       my %limit_to = (
                       perlvar => {
                                    lonOtherAuthen => 1,
                                    lonBalancer    => 1,
                                    lonVersion     => 1,
                                    lonSysEMail    => 1,
                                    lonHostID      => 1,
                                    lonRole        => 1,
                                    lonDefDomain   => 1,
                                    lonLoadLim     => 1,
                                    lonUserLoadLim => 1,
                                  }
                     );
       if (ref($requested) eq 'HASH') {
           foreach my $what (keys(%{$requested})) {
               my $response;
               my $items = {};
               if (exists($packagevars{$what})) {
                   if (ref($limit_to{$what}) eq 'HASH') {
                       foreach my $varname (keys(%{$packagevars{$what}})) {
                           if ($limit_to{$what}{$varname}) {
                               $items->{$varname} = $packagevars{$what}{$varname};
                           }
                       }
                   } else {
                       $items = $packagevars{$what};
                   }
                   if ($what eq 'perlvar') {
                       if (!exists($packagevars{$what}{'lonBalancer'})) {
                           if ($dist =~ /^(centos|rhes|fedora|scientific)/) {
                               my $othervarref=LONCAPA::Configuration::read_conf('httpd.conf');
                               if (ref($othervarref) eq 'HASH') {
                                   $items->{'lonBalancer'} = $othervarref->{'lonBalancer'};
                               }
                           }
                       }
                   }
                   $response = &Apache::lonnet::freeze_escape($items);
               }
               $result .= &escape($what).'='.$response.'&';
           }
       }
       $result =~ s/\&$//;
       &Reply($client,\$result,$userinput);
       return 1;
   }
   &register_handler("readlonnetglobal", \&read_lonnet_global, 0, 1, 0);
   
   sub server_devalidatecache_handler {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
       my $items = &unescape($tail);
       my @cached = split(/\&/,$items);
       foreach my $key (@cached) {
           if ($key =~ /:/) {
               my ($name,$id) = map { &unescape($_); } split(/:/,$key);
               &Apache::lonnet::devalidate_cache_new($name,$id);
           }
       }
       my $result = 'ok';
       &Reply($client,\$result,$userinput);
       return 1;
   }
   &register_handler("devalidatecache", \&server_devalidatecache_handler, 0, 1, 0);
   
   sub server_timezone_handler {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
       my $timezone;
       my $clockfile = '/etc/sysconfig/clock'; # Fedora/CentOS/SuSE
       my $tzfile = '/etc/timezone'; # Debian/Ubuntu
       if (-e $clockfile) {
           if (open(my $fh,"<$clockfile")) {
               while (<$fh>) {
                   next if (/^[\#\s]/);
                   if (/^(?:TIME)?ZONE\s*=\s*['"]?\s*([\w\/]+)/) {
                       $timezone = $1;
                       last;
                   }
               }
               close($fh);
           }
       } elsif (-e $tzfile) {
           if (open(my $fh,"<$tzfile")) {
               $timezone = <$fh>;
               close($fh);
               chomp($timezone);
               if ($timezone =~ m{^Etc/(\w+)$}) {
                   $timezone = $1;
               }
           }
       }
       &Reply($client,\$timezone,$userinput); # This supports debug logging.
       return 1;
   }
   &register_handler("servertimezone", \&server_timezone_handler, 0, 1, 0);
   
   sub server_loncaparev_handler {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
       &Reply($client,\$perlvar{'lonVersion'},$userinput);
       return 1;
   }
   &register_handler("serverloncaparev", \&server_loncaparev_handler, 0, 1, 0);
   
   sub server_homeID_handler {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
       &Reply($client,\$perlvar{'lonHostID'},$userinput);
       return 1;
   }
   &register_handler("serverhomeID", \&server_homeID_handler, 0, 1, 0);
   
   sub server_distarch_handler {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
       my $reply = &distro_and_arch();
       &Reply($client,\$reply,$userinput);
       return 1;
   }
   &register_handler("serverdistarch", \&server_distarch_handler, 0, 1, 0);
   
 #   Process a reinit request.  Reinit requests that either  #   Process a reinit request.  Reinit requests that either
 #   lonc or lond be reinitialized so that an updated   #   lonc or lond be reinitialized so that an updated 
Line 524  RegisterHandler("pushfile", \&PushFileHa Line 1770  RegisterHandler("pushfile", \&PushFileHa
 #  Implicit output:  #  Implicit output:
 #     a reply is sent to the client.  #     a reply is sent to the client.
 #  #
 sub ReinitProcessHandler {  sub reinit_process_handler {
    my $cmd    = shift;      my ($cmd, $tail, $client) = @_;
    my $tail   = shift;  
    my $client = shift;  
         
    my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
         
    my $cert = GetCertificate($userinput);      my $cert = &GetCertificate($userinput);
    if(ValidManager($cert)) {      if(&ValidManager($cert)) {
       chomp($userinput);   chomp($userinput);
       my $reply = ReinitProcess($userinput);   my $reply = &ReinitProcess($userinput);
       Reply( $client,  "$reply\n", $userinput);   &Reply( $client,  \$reply, $userinput);
    } else {      } else {
       Failure( $client, "refused\n", $userinput);   &Failure( $client, "refused\n", $userinput);
  }      }
    return 1;      return 1;
 }  }
   &register_handler("reinit", \&reinit_process_handler, 1, 0, 1);
 RegisterHandler("reinit", \&ReinitProcessHandler, 1, 0, 1);  
   
 #  Process the editing script for a table edit operation.  #  Process the editing script for a table edit operation.
 #  the editing operation must be encrypted and requested by  #  the editing operation must be encrypted and requested by
Line 558  RegisterHandler("reinit", \&ReinitProces Line 1801  RegisterHandler("reinit", \&ReinitProces
 #  Implicit output:  #  Implicit output:
 #     a reply is sent to the client.  #     a reply is sent to the client.
 #  #
 sub EditTableHandler {  sub edit_table_handler {
    my $command    = shift;      my ($command, $tail, $client) = @_;
    my $tail       = shift;  
    my $client     = shift;  
         
    my $userinput = "$command:$tail";      my $userinput = "$command:$tail";
   
    my $cert = GetCertificate($userinput);      my $cert = &GetCertificate($userinput);
    if(ValidManager($cert)) {      if(&ValidManager($cert)) {
       my($filetype, $script) = split(/:/, $tail);   my($filetype, $script) = split(/:/, $tail);
       if (($filetype eq "hosts") ||    if (($filetype eq "hosts") || 
           ($filetype eq "domain")) {      ($filetype eq "domain")) {
          if($script ne "") {      if($script ne "") {
             Reply($client,            # BUGBUG - EditFile   &Reply($client,              # BUGBUG - EditFile
                   EditFile($userinput), #   could fail.        &EditFile($userinput), #   could fail.
                   $userinput);        $userinput);
          } else {      } else {
             Failure($client,"refused\n",$userinput);   &Failure($client,"refused\n",$userinput);
          }      }
       } else {   } else {
          Failure($client,"refused\n",$userinput);      &Failure($client,"refused\n",$userinput);
       }   }
    } else {      } else {
       Failure($client,"refused\n",$userinput);   &Failure($client,"refused\n",$userinput);
    }      }
    return 1;      return 1;
 }  }
 RegisterHandler("edit", \&EditTableHandler, 1, 0, 1);  &register_handler("edit", \&edit_table_handler, 1, 0, 1);
   
   
 #  #
 #   Authenticate a user against the LonCAPA authentication  #   Authenticate a user against the LonCAPA authentication
Line 598  RegisterHandler("edit", \&EditTableHandl Line 1838  RegisterHandler("edit", \&EditTableHandl
 #                internal per user password file.  #                internal per user password file.
 #   - kerberos - The user can be authenticated against either a kerb4 or kerb5  #   - kerberos - The user can be authenticated against either a kerb4 or kerb5
 #                ticket granting authority.  #                ticket granting authority.
 #   - user     - The person tailoring LonCAPA can supply a user authentication mechanism  #   - user     - The person tailoring LonCAPA can supply a user authentication
 #                that is per system.  #                mechanism that is per system.
 #  #
 # Parameters:  # Parameters:
 #    $cmd      - The command that got us here.  #    $cmd      - The command that got us here.
Line 612  RegisterHandler("edit", \&EditTableHandl Line 1852  RegisterHandler("edit", \&EditTableHandl
 #    The authentication systems describe above have their own forms of implicit  #    The authentication systems describe above have their own forms of implicit
 #    input into the authentication process that are described above.  #    input into the authentication process that are described above.
 #  #
 sub AuthenticateHandler {  sub authenticate_handler {
    my $cmd        = shift;      my ($cmd, $tail, $client) = @_;
    my $tail       = shift;  
    my $client     = shift;  
      
    #  Regenerate the full input line   
      
    my $userinput  = $cmd.":".$tail;  
   
    #  udom    - User's domain.  
    #  uname   - Username.  
    #  upass   - User's password.  
      
    my ($udom,$uname,$upass)=split(/:/,$tail);  
    Debug(" Authenticate domain = $udom, user = $uname, password = $upass");  
    chomp($upass);  
    $upass=unescape($upass);  
    my $proname=propath($udom,$uname);  
    my $passfilename="$proname/passwd";  
      
    #   The user's 'personal' loncapa passworrd file describes how to authenticate:  
      
    if (-e $passfilename) {  
      Debug("Located password file: $passfilename");  
   
       my $pf = IO::File->new($passfilename);      
       my $realpasswd=<$pf>;      #  Regenerate the full input line 
       chomp($realpasswd);      
       my ($howpwd,$contentpwd)=split(/:/,$realpasswd);      my $userinput  = $cmd.":".$tail;
       my $pwdcorrect=0;      
       #      #  udom    - User's domain.
       #   Authenticate against password stored in the internal file.      #  uname   - Username.
       #      #  upass   - User's password.
      Debug("Authenticating via $howpwd");      #  checkdefauth - Pass to validate_user() to try authentication
       if ($howpwd eq 'internal') {      #                 with default auth type(s) if no user account.
          &Debug("Internal auth");      #  clientcancheckhost - Passed by clients with functionality in lonauth.pm
          $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);      #                       to check if session can be hosted.
       #      
       #   Authenticate against the unix password file.      my ($udom, $uname, $upass, $checkdefauth, $clientcancheckhost)=split(/:/,$tail);
       #      &Debug(" Authenticate domain = $udom, user = $uname, password = $upass,  checkdefauth = $checkdefauth");
       } elsif ($howpwd eq 'unix') {      chomp($upass);
          &Debug("Unix auth");      $upass=&unescape($upass);
          if((getpwnam($uname))[1] eq "") { #no such user!  
             $pwdcorrect = 0;      my $pwdcorrect = &validate_user($udom,$uname,$upass,$checkdefauth);
          } else {      if($pwdcorrect) {
             $contentpwd=(getpwnam($uname))[1];          my $canhost = 1;
             my $pwauth_path="/usr/local/sbin/pwauth";          unless ($clientcancheckhost) {
             unless ($contentpwd eq 'x') {              my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
                $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);              my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
             } elsif (-e $pwauth_path) {              my @intdoms;
                open PWAUTH, "|$pwauth_path" or              my $internet_names = &Apache::lonnet::get_internet_names($clientname);
                   die "Cannot invoke authentication";              if (ref($internet_names) eq 'ARRAY') {
                print PWAUTH "$uname\n$upass\n";                  @intdoms = @{$internet_names};
                close PWAUTH;  
                $pwdcorrect=!$?;  
             }              }
          }              unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
       #                  my ($remote,$hosted);
       #   Authenticate against a Kerberos 4 server:                  my $remotesession = &get_usersession_config($udom,'remotesession');
       #                  if (ref($remotesession) eq 'HASH') {
       } elsif ($howpwd eq 'krb4') {                      $remote = $remotesession->{'remote'}
          my $null=pack("C",0);                  }
          unless ($upass=~/$null/) {                  my $hostedsession = &get_usersession_config($clienthomedom,'hostedsession');
             my $krb4_error = &Authen::Krb4::get_pw_in_tkt($uname,                  if (ref($hostedsession) eq 'HASH') {
                                                           "",                      $hosted = $hostedsession->{'hosted'};
                                                           $contentpwd,                  }
                                                           'krbtgt',                  $canhost = &Apache::lonnet::can_host_session($udom,$clientname,
                                                          $contentpwd,                                                               $clientversion,
                                                          1,                                                               $remote,$hosted);
                                                          $upass);  
             if (!$krb4_error) {  
                $pwdcorrect = 1;  
             } else {   
                $pwdcorrect=0;   
                # log error if it is not a bad password  
                if ($krb4_error != 62) {  
                   &logthis('krb4:'.$uname.','.$contentpwd.','.  
                            &Authen::Krb4::get_err_txt($Authen::Krb4::error));  
                }  
             }              }
          }          }
       #          if ($canhost) {               
       #   Authenticate against a Kerberos 5 server:              &Reply( $client, "authorized\n", $userinput);
       #          } else {
       } elsif ($howpwd eq 'krb5') {              &Reply( $client, "not_allowed_to_host\n", $userinput);
          my $null=pack("C",0);          }
          unless ($upass=~/$null/) {   #
             my $krbclient=&Authen::Krb5::parse_name($uname.'@'.$contentpwd);   #  Bad credentials: Failed to authorize
             my $krbservice="krbtgt/".$contentpwd."\@".$contentpwd;   #
             my $krbserver=&Authen::Krb5::parse_name($krbservice);      } else {
             my $credentials=&Authen::Krb5::cc_default();   &Failure( $client, "non_authorized\n", $userinput);
             $credentials->initialize($krbclient);      }
             my $krbreturn = &Authen::Krb5::get_in_tkt_with_password(  
                                                                     $krbclient,      return 1;
                                                                     $krbserver,  
                                                                     $upass,  
                                                                     $credentials);  
             $pwdcorrect = ($krbreturn == 1);  
          } else {   
             $pwdcorrect=0;   
          }  
       #  
       #  Finally, the user may have written in an authentication module.  
       #  in that case, if requested, authenticate against it.  
       #  
       } elsif ($howpwd eq 'localauth') {  
          $pwdcorrect=&localauth::localauth($uname,$upass,$contentpwd);  
       }  
       #  
       #   Successfully authorized.  
       #  
       if ($pwdcorrect) {  
          Reply( $client, "authorized\n", $userinput);  
       #  
       #  Bad credentials: Failed to authorize  
       #  
       } else {  
          Failure( $client, "non_authorized\n", $userinput);  
       }  
    #  
    #  User bad... note it may be bad security practice to differntiate to the  
    #  caller a bad user from a  bad passwd... since that supplies covert channel  
    #  information (you have a good user but bad password e.g.) to guessers.  
    #  
    } else {  
       Failure( $client, "unknown_user\n", $userinput);  
    }  
    return 1;  
 }  }
 RegisterHandler("auth", \&AuthenticateHandler, 1, 1, 0);  &register_handler("auth", \&authenticate_handler, 1, 1, 0);
   
 #  #
 #   Change a user's password.  Note that this function is complicated by  #   Change a user's password.  Note that this function is complicated by
Line 764  RegisterHandler("auth", \&AuthenticateHa Line 1936  RegisterHandler("auth", \&AuthenticateHa
 # Implicit inputs:  # Implicit inputs:
 #    The authentication systems describe above have their own forms of implicit  #    The authentication systems describe above have their own forms of implicit
 #    input into the authentication process that are described above.  #    input into the authentication process that are described above.
 sub ChangePasswordHandler {  sub change_password_handler {
    my $cmd     = shift;      my ($cmd, $tail, $client) = @_;
    my $tail    = shift;  
    my $client  = shift;  
      
    my $userinput = $cmd.":".$tail;           # Reconstruct client's string.  
   
    #      my $userinput = $cmd.":".$tail;           # Reconstruct client's string.
    #  udom  - user's domain.  
    #  uname - Username.      #
    #  upass - Current password.      #  udom  - user's domain.
    #  npass - New password.      #  uname - Username.
          #  upass - Current password.
    my ($udom,$uname,$upass,$npass)=split(/:/,$tail);      #  npass - New password.
    chomp($npass);      #  context - Context in which this was called 
    $upass=&unescape($upass);      #            (preferences or reset_by_email).
    $npass=&unescape($npass);      #  lonhost - HostID of server where request originated 
    &Debug("Trying to change password for $uname");     
    my $proname=propath($udom,$uname);      my ($udom,$uname,$upass,$npass,$context,$lonhost)=split(/:/,$tail);
    my $passfilename="$proname/passwd";  
    if (-e $passfilename) {      $upass=&unescape($upass);
       my $realpasswd;      $npass=&unescape($npass);
       {       &Debug("Trying to change password for $uname");
          my $pf = IO::File->new($passfilename);  
          $realpasswd=<$pf>;       # First require that the user can be authenticated with their
       }      # old password unless context was 'reset_by_email':
       chomp($realpasswd);      
       my ($howpwd,$contentpwd)=split(/:/,$realpasswd);      my ($validated,$failure);
       if ($howpwd eq 'internal') {      if ($context eq 'reset_by_email') {
          &Debug("internal auth");          if ($lonhost eq '') {
          if (crypt($upass,$contentpwd) eq $contentpwd) {              $failure = 'invalid_client';
             my $salt=time;          } else {
             $salt=substr($salt,6,2);              $validated = 1;
             my $ncpass=crypt($npass,$salt);          }
                {      } else {
                   my $pf = IO::File->new(">$passfilename");          $validated = &validate_user($udom, $uname, $upass);
                   if ($pf) {      }
                      print $pf "internal:$ncpass\n";      if($validated) {
                      &logthis("Result of password change for "   my $realpasswd  = &get_auth_type($udom, $uname); # Defined since authd.
                               ."$uname: pwchange_success");  
                      Reply($client, "ok\n", $userinput);   my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
                   } else {   if ($howpwd eq 'internal') {
                      &logthis("Unable to open $uname passwd "                     &Debug("internal auth");
                               ."to change password");      my $salt=time;
                      Failure( $client, "non_authorized\n",$userinput);      $salt=substr($salt,6,2);
                   }      my $ncpass=crypt($npass,$salt);
                }                   if(&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
          } else {   my $msg="Result of password change for $uname: pwchange_success";
             Failure($client, "non_authorized\n", $userinput);                  if ($lonhost) {
          }                      $msg .= " - request originated from: $lonhost";
       } elsif ($howpwd eq 'unix') {                  }
          # Unix means we have to access /etc/password                  &logthis($msg);
          # one way or another.   &Reply($client, "ok\n", $userinput);
          # First: Make sure the current password is      } else {
          #        correct   &logthis("Unable to open $uname passwd "               
          &Debug("auth is unix");   ."to change password");
          $contentpwd=(getpwnam($uname))[1];   &Failure( $client, "non_authorized\n",$userinput);
          my $pwdcorrect = "0";      }
          my $pwauth_path="/usr/local/sbin/pwauth";   } elsif ($howpwd eq 'unix' && $context ne 'reset_by_email') {
          unless ($contentpwd eq 'x') {      my $result = &change_unix_password($uname, $npass);
             $pwdcorrect= (crypt($upass,$contentpwd) eq $contentpwd);      &logthis("Result of password change for $uname: ".
          } elsif (-e $pwauth_path) {       $result);
             open PWAUTH, "|$pwauth_path" or      &Reply($client, \$result, $userinput);
                die "Cannot invoke authentication";   } else {
             print PWAUTH "$uname\n$upass\n";      # this just means that the current password mode is not
             close PWAUTH;      # one we know how to change (e.g the kerberos auth modes or
             &Debug("exited pwauth with $? ($uname,$upass) ");      # locally written auth handler).
             $pwdcorrect=($? == 0);      #
          }      &Failure( $client, "auth_mode_error\n", $userinput);
          if ($pwdcorrect) {   }  
             my $execdir=$perlvar{'lonDaemons'};  
             &Debug("Opening lcpasswd pipeline");      } else {
             my $pf = IO::File->new("|$execdir/lcpasswd > "   if ($failure eq '') {
                                     ."$perlvar{'lonDaemons'}"      $failure = 'non_authorized';
                                     ."/logs/lcpasswd.log");   }
             print $pf "$uname\n$npass\n$npass\n";   &Failure( $client, "$failure\n", $userinput);
             close $pf;      }
             my $err = $?;  
             my $result = ($err>0 ? 'pwchange_failure' : 'ok');      return 1;
             &logthis("Result of password change for $uname: ".  
             &lcpasswdstrerror($?));  
             Reply($client, "$result\n", $userinput);  
          } else {  
             Reply($client, "non_authorized\n", $userinput);  
          }  
       } else {  
          Reply( $client, "auth_mode_error\n", $userinput);  
       }    
    } else {  
             Reply( $client, "unknown_user\n", $userinput);  
    }  
    return 1;  
 }  }
 RegisterHandler("passwd", \&ChangePasswordHandler, 1, 1, 0);  &register_handler("passwd", \&change_password_handler, 1, 1, 0);
   
 #  #
 #   Create a new user.  User in this case means a lon-capa user.  #   Create a new user.  User in this case means a lon-capa user.
Line 875  RegisterHandler("passwd", \&ChangePasswo Line 2030  RegisterHandler("passwd", \&ChangePasswo
 # Implicit inputs:  # Implicit inputs:
 #    The authentication systems describe above have their own forms of implicit  #    The authentication systems describe above have their own forms of implicit
 #    input into the authentication process that are described above.  #    input into the authentication process that are described above.
 sub AddUserHandler {  sub add_user_handler {
    my $cmd     = shift;  
    my $tail    = shift;      my ($cmd, $tail, $client) = @_;
    my $client  = shift;  
      
    my $userinput = $cmd.":".$tail;     
   
    my $oldumask=umask(0077);  
    my ($udom,$uname,$umode,$npass)=split(/:/,$tail);      my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
    &Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);      my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
    chomp($npass);  
    $npass=&unescape($npass);      &Debug("cmd =".$cmd." $udom =".$udom." uname=".$uname);
    my $proname=propath($udom,$uname);  
    my $passfilename="$proname/passwd";  
    &Debug("Password file created will be:".$passfilename);      if($udom eq $currentdomainid) { # Reject new users for other domains...
    if (-e $passfilename) {  
       Failure( $client, "already_exists\n", $userinput);   my $oldumask=umask(0077);
    } elsif ($udom ne $currentdomainid) {   chomp($npass);
       Failure($client, "not_right_domain\n", $userinput);   $npass=&unescape($npass);
    } else {   my $passfilename  = &password_path($udom, $uname);
       my @fpparts=split(/\//,$proname);   &Debug("Password file created will be:".$passfilename);
       my $fpnow=$fpparts[0].'/'.$fpparts[1].'/'.$fpparts[2];   if (-e $passfilename) {
       my $fperror='';      &Failure( $client, "already_exists\n", $userinput);
       for (my $i=3;$i<=$#fpparts;$i++) {   } else {
          $fpnow.='/'.$fpparts[$i];       my $fperror='';
          unless (-e $fpnow) {      if (!&mkpath($passfilename)) {
             unless (mkdir($fpnow,0777)) {   $fperror="error: ".($!+0)." mkdir failed while attempting "
                $fperror="error: ".($!+0)." mkdir failed while attempting "      ."makeuser";
                        ."makeuser";      }
             }      unless ($fperror) {
          }   my $result=&make_passwd_file($uname,$udom,$umode,$npass, $passfilename);
       }   &Reply($client,\$result, $userinput);     #BUGBUG - could be fail
       unless ($fperror) {      } else {
          my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);   &Failure($client, \$fperror, $userinput);
          Reply($client, $result, $userinput);     #BUGBUG - could be fail      }
       } else {   }
          Failure($client, "$fperror\n", $userinput);   umask($oldumask);
       }      }  else {
    }   &Failure($client, "not_right_domain\n",
    umask($oldumask);   $userinput); # Even if we are multihomed.
    return 1;      
       }
       return 1;
   
 }  }
 RegisterHandler("makeuser", \&AddUserHandler, 1, 1, 0);  &register_handler("makeuser", \&add_user_handler, 1, 1, 0);
   
 #  #
 #   Change the authentication method of a user.  Note that this may  #   Change the authentication method of a user.  Note that this may
Line 941  RegisterHandler("makeuser", \&AddUserHan Line 2095  RegisterHandler("makeuser", \&AddUserHan
 # Implicit inputs:  # Implicit inputs:
 #    The authentication systems describe above have their own forms of implicit  #    The authentication systems describe above have their own forms of implicit
 #    input into the authentication process that are described above.  #    input into the authentication process that are described above.
   # NOTE:
   #   This is also used to change the authentication credential values (e.g. passwd).
   #   
 #  #
 sub ChangeAuthenticationHandler {  sub change_authentication_handler {
    my $cmd     = shift;  
    my $tail    = shift;      my ($cmd, $tail, $client) = @_;
    my $client  = shift;  
         
    my $userinput  = "$cmd:$tail";              # Reconstruct user input.      my $userinput  = "$cmd:$tail";              # Reconstruct user input.
   
    my ($udom,$uname,$umode,$npass)=split(/:/,$tail);      my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
    chomp($npass);      &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
    &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);      if ($udom ne $currentdomainid) {
    $npass=&unescape($npass);   &Failure( $client, "not_right_domain\n", $client);
    my $proname=&propath($udom,$uname);      } else {
    my $passfilename="$proname/passwd";  
    if ($udom ne $currentdomainid) {   chomp($npass);
       Failure( $client, "not_right_domain\n", $client);  
    } else {   $npass=&unescape($npass);
       my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);   my $oldauth = &get_auth_type($udom, $uname); # Get old auth info.
       Reply($client, $result, $userinput);   my $passfilename = &password_path($udom, $uname);
    }   if ($passfilename) { # Not allowed to create a new user!!
    return 1;      # If just changing the unix passwd. need to arrange to run
       # passwd since otherwise make_passwd_file will fail as 
       # creation of unix authenticated users is no longer supported
               # except from the command line, when running make_domain_coordinator.pl
   
       if(($oldauth =~/^unix/) && ($umode eq "unix")) {
    my $result = &change_unix_password($uname, $npass);
    &logthis("Result of password change for $uname: ".$result);
    if ($result eq "ok") {
       &Reply($client, \$result);
    } else {
       &Failure($client, \$result);
    }
       } else {
    my $result=&make_passwd_file($uname,$udom,$umode,$npass,$passfilename);
    #
    #  If the current auth mode is internal, and the old auth mode was
    #  unix, or krb*,  and the user is an author for this domain,
    #  re-run manage_permissions for that role in order to be able
    #  to take ownership of the construction space back to www:www
    #
   
   
    &Reply($client, \$result, $userinput);
       }
          
   
    } else {       
       &Failure($client, "non_authorized\n", $userinput); # Fail the user now.
    }
       }
       return 1;
 }  }
 RegisterHandler("changeuserauth", \&ChangeAuthenticationHandler, 1,1, 0);  &register_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
   
 #  #
 #   Determines if this is the home server for a user.  The home server  #   Determines if this is the home server for a user.  The home server
Line 981  RegisterHandler("changeuserauth", \&Chan Line 2168  RegisterHandler("changeuserauth", \&Chan
 #    The authentication systems describe above have their own forms of implicit  #    The authentication systems describe above have their own forms of implicit
 #    input into the authentication process that are described above.  #    input into the authentication process that are described above.
 #  #
 sub IsHomeHandler {  sub is_home_handler {
    my $cmd     = shift;      my ($cmd, $tail, $client) = @_;
    my $tail    = shift;  
    my $client  = shift;  
         
    my $userinput  = "$cmd:$tail";      my $userinput  = "$cmd:$tail";
         
    my ($udom,$uname)=split(/:/,$tail);      my ($udom,$uname)=split(/:/,$tail);
    chomp($uname);      chomp($uname);
    my $proname=propath($udom,$uname);      my $passfile = &password_filename($udom, $uname);
    if (-e $proname) {      if($passfile) {
       Reply( $client, "found\n", $userinput);   &Reply( $client, "found\n", $userinput);
    } else {      } else {
       Failure($client, "not_found\n", $userinput);   &Failure($client, "not_found\n", $userinput);
    }      }
    return 1;      return 1;
 }  }
 RegisterHandler("home", \&IsHomeHandler, 0,1,0);  &register_handler("home", \&is_home_handler, 0,1,0);
   
 #  #
 #   Process an update request for a resource?? I think what's going on here is  #   Process an update request for a resource.
 #   that a resource has been modified that we hold a subscription to.  #   A resource has been modified that we hold a subscription to.
 #   If the resource is not local, then we must update, or at least invalidate our  #   If the resource is not local, then we must update, or at least invalidate our
 #   cached copy of the resource.   #   cached copy of the resource. 
 #   FUTURE WORK:  
 #      I need to look at this logic carefully.  My druthers would be to follow  
 #      typical caching logic, and simple invalidate the cache, drop any subscription  
 #      an let the next fetch start the ball rolling again... however that may  
 #      actually be more difficult than it looks given the complex web of  
 #      proxy servers.  
 # Parameters:  # Parameters:
 #    $cmd      - The command that got us here.  #    $cmd      - The command that got us here.
 #    $tail     - Tail of the command (remaining parameters).  #    $tail     - Tail of the command (remaining parameters).
Line 1021  RegisterHandler("home", \&IsHomeHandler, Line 2201  RegisterHandler("home", \&IsHomeHandler,
 #    The authentication systems describe above have their own forms of implicit  #    The authentication systems describe above have their own forms of implicit
 #    input into the authentication process that are described above.  #    input into the authentication process that are described above.
 #  #
 sub UpdateResourceHandler {  sub update_resource_handler {
    my $cmd    = shift;  
    my $tail   = shift;      my ($cmd, $tail, $client) = @_;
    my $client = shift;  
         
    my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
         
    my $fname=$tail;      my $fname= $tail; # This allows interactive testing
    my $ownership=ishome($fname);  
    if ($ownership eq 'not_owner') {  
       if (-e $fname) {      my $ownership=ishome($fname);
          my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,      if ($ownership eq 'not_owner') {
              $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);   if (-e $fname) {
          my $now=time;              # Delete preview file, if exists
          my $since=$now-$atime;              unlink("$fname.tmp");
          if ($since>$perlvar{'lonExpire'}) {              # Get usage stats
             my $reply=&reply("unsub:$fname","$clientname");      my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
             unlink("$fname");   $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
          } else {      my $now=time;
             my $transname="$fname.in.transfer";      my $since=$now-$atime;
             my $remoteurl=&reply("sub:$fname","$clientname");              # If the file has not been used within lonExpire seconds,
             my $response;              # unsubscribe from it and delete local copy
             alarm(120);      if ($since>$perlvar{'lonExpire'}) {
             {   my $reply=&Apache::lonnet::reply("unsub:$fname","$clientname");
                my $ua=new LWP::UserAgent;   &devalidate_meta_cache($fname);
                my $request=new HTTP::Request('GET',"$remoteurl");   unlink("$fname");
                $response=$ua->request($request,$transname);   unlink("$fname.meta");
             }      } else {
             alarm(0);              # Yes, this is in active use. Get a fresh copy. Since it might be in
             if ($response->is_error()) {              # very active use and huge (like a movie), copy it to "in.transfer" filename first.
                unlink($transname);   my $transname="$fname.in.transfer";
                my $message=$response->status_line;   my $remoteurl=&Apache::lonnet::reply("sub:$fname","$clientname");
                &logthis("LWP GET: $message for $fname ($remoteurl)");   my $response;
             } else {  # FIXME: cannot replicate files that take more than two minutes to transfer?
                if ($remoteurl!~/\.meta$/) {  # alarm(120);
                   alarm(120);  # FIXME: this should use the LWP mechanism, not internal alarms.
                   {                  alarm(1200);
                      my $ua=new LWP::UserAgent;   {
                      my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');      my $ua=new LWP::UserAgent;
                      my $mresponse=$ua->request($mrequest,$fname.'.meta');      my $request=new HTTP::Request('GET',"$remoteurl");
                      if ($mresponse->is_error()) {      $response=$ua->request($request,$transname);
                         unlink($fname.'.meta');   }
                      }   alarm(0);
                   }   if ($response->is_error()) {
                   alarm(0);  # FIXME: we should probably clean up here instead of just whine
                }      unlink($transname);
                rename($transname,$fname);      my $message=$response->status_line;
             }      &logthis("LWP GET: $message for $fname ($remoteurl)");
          }   } else {
                Reply( $client, "ok\n", $userinput);      if ($remoteurl!~/\.meta$/) {
       } else {  # FIXME: isn't there an internal LWP mechanism for this?
          Failure($client, "not_found\n", $userinput);   alarm(120);
       }   {
    } else {      my $ua=new LWP::UserAgent;
       Failure($client, "rejected\n", $userinput);      my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
    }      my $mresponse=$ua->request($mrequest,$fname.'.meta');
    return 1;      if ($mresponse->is_error()) {
    unlink($fname.'.meta');
       }
    }
    alarm(0);
       }
                       # we successfully transfered, copy file over to real name
       rename($transname,$fname);
       &devalidate_meta_cache($fname);
    }
       }
       &Reply( $client, "ok\n", $userinput);
    } else {
       &Failure($client, "not_found\n", $userinput);
    }
       } else {
    &Failure($client, "rejected\n", $userinput);
       }
       return 1;
   }
   &register_handler("update", \&update_resource_handler, 0 ,1, 0);
   
   sub devalidate_meta_cache {
       my ($url) = @_;
       use Cache::Memcached;
       my $memcache = new Cache::Memcached({'servers'=>['127.0.0.1:11211']});
       $url = &Apache::lonnet::declutter($url);
       $url =~ s-\.meta$--;
       my $id = &escape('meta:'.$url);
       $memcache->delete($id);
 }  }
 RegisterHandler("update", \&UpdateResourceHandler, 0 ,1, 0);  
   
 #  #
 #   Fetch a user file from a remote server:  #   Fetch a user file from a remote server to the user's home directory
   #   userfiles subdir.
 # Parameters:  # Parameters:
 #    $cmd      - The command that got us here.  #    $cmd      - The command that got us here.
 #    $tail     - Tail of the command (remaining parameters).  #    $tail     - Tail of the command (remaining parameters).
Line 1091  RegisterHandler("update", \&UpdateResour Line 2299  RegisterHandler("update", \&UpdateResour
 #     0        - Requested to exit, caller should shut down.  #     0        - Requested to exit, caller should shut down.
 #     1        - Continue processing.  #     1        - Continue processing.
 #  #
 sub FetchUserFileHandler {  sub fetch_user_file_handler {
    my $cmd     = shift;  
    my $tail    = shift;      my ($cmd, $tail, $client) = @_;
    my $client  = shift;  
          my $userinput = "$cmd:$tail";
    my $userinput = "$cmd:$tail";      my $fname           = $tail;
    my $fname           = $tail;      my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
    my ($udom,$uname,$ufile)=split(/\//,$fname);      my $udir=&propath($udom,$uname).'/userfiles';
    my $udir=propath($udom,$uname).'/userfiles';      unless (-e $udir) {
    unless (-e $udir) {   mkdir($udir,0770); 
       mkdir($udir,0770);       }
    }      Debug("fetch user file for $fname");
    if (-e $udir) {      if (-e $udir) {
       $ufile=~s/^[\.\~]+//;   $ufile=~s/^[\.\~]+//;
       $ufile=~s/\///g;  
       my $destname=$udir.'/'.$ufile;   # IF necessary, create the path right down to the file.
       my $transname=$udir.'/'.$ufile.'.in.transit';   # Note that any regular files in the way of this path are
       my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;   # wiped out to deal with some earlier folly of mine.
       my $response;  
       alarm(120);   if (!&mkpath($udir.'/'.$ufile)) {
       {      &Failure($client, "unable_to_create\n", $userinput);    
          my $ua=new LWP::UserAgent;   }
          my $request=new HTTP::Request('GET',"$remoteurl");  
          $response=$ua->request($request,$transname);   my $destname=$udir.'/'.$ufile;
       }   my $transname=$udir.'/'.$ufile.'.in.transit';
       alarm(0);          my $clientprotocol=$Apache::lonnet::protocol{$clientname};
       if ($response->is_error()) {          $clientprotocol = 'http' if ($clientprotocol ne 'https');
          unlink($transname);   my $clienthost = &Apache::lonnet::hostname($clientname);
          my $message=$response->status_line;   my $remoteurl=$clientprotocol.'://'.$clienthost.'/userfiles/'.$fname;
          &logthis("LWP GET: $message for $fname ($remoteurl)");   my $response;
          Failure($client, "failed\n", $userinput);   Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
       } else {   alarm(120);
          if (!rename($transname,$destname)) {   {
             &logthis("Unable to move $transname to $destname");      my $ua=new LWP::UserAgent;
             unlink($transname);      my $request=new HTTP::Request('GET',"$remoteurl");
             Failure($client, "failed\n", $userinput);      $response=$ua->request($request,$transname);
          } else {   }
             Reply($client, "ok\n", $userinput);   alarm(0);
          }   if ($response->is_error()) {
       }         unlink($transname);
    } else {      my $message=$response->status_line;
       Failure($client, "not_home\n", $userinput);      &logthis("LWP GET: $message for $fname ($remoteurl)");
    }      &Failure($client, "failed\n", $userinput);
    return 1;   } else {
       Debug("Renaming $transname to $destname");
       if (!rename($transname,$destname)) {
    &logthis("Unable to move $transname to $destname");
    unlink($transname);
    &Failure($client, "failed\n", $userinput);
       } else {
                   if ($fname =~ /^default.+\.(page|sequence)$/) {
                       my ($major,$minor) = split(/\./,$clientversion);
                       if (($major < 2) || ($major == 2 && $minor < 11)) {
                           my $now = time;
                           &Apache::lonnet::do_cache_new('crschange',$udom.'_'.$uname,$now,600);
                           my $key = &escape('internal.contentchange');
                           my $what = "$key=$now";
                           my $hashref = &tie_user_hash($udom,$uname,'environment',
                                                        &GDBM_WRCREAT(),"P",$what);
                           if ($hashref) {
                               $hashref->{$key}=$now;
                               if (!&untie_user_hash($hashref)) {
                                   &logthis("error: ".($!+0)." untie (GDBM) failed ".
                                            "when updating internal.contentchange");
                               }
                           }
                       }
                   }
    &Reply($client, "ok\n", $userinput);
       }
    }   
       } else {
    &Failure($client, "not_home\n", $userinput);
       }
       return 1;
 }  }
 RegisterHandler("fetchuserfile", \&FetchUserFileHandler, 0, 1, 0);  &register_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
   
 #  #
 #   Authenticate access to a user file.  Question?   The token for athentication  #   Remove a file from a user's home directory userfiles subdirectory.
 #   is allowed to be sent as cleartext is this really what we want?  This token  # Parameters:
 #   represents the user's session id.  Once it is forged does this allow too much access??  #    cmd   - the Lond request keyword that got us here.
   #    tail  - the part of the command past the keyword.
   #    client- File descriptor connected with the client.
 #  #
   # Returns:
   #    1    - Continue processing.
   sub remove_user_file_handler {
       my ($cmd, $tail, $client) = @_;
   
       my ($fname) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
   
       my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
       if ($ufile =~m|/\.\./|) {
    # any files paths with /../ in them refuse 
    # to deal with
    &Failure($client, "refused\n", "$cmd:$tail");
       } else {
    my $udir = &propath($udom,$uname);
    if (-e $udir) {
       my $file=$udir.'/userfiles/'.$ufile;
       if (-e $file) {
    #
    #   If the file is a regular file unlink is fine...
    #   However it's possible the client wants a dir.
    #   removed, in which case rmdir is more approprate:
    #
           if (-f $file){
       unlink($file);
    } elsif(-d $file) {
       rmdir($file);
    }
    if (-e $file) {
       #  File is still there after we deleted it ?!?
   
       &Failure($client, "failed\n", "$cmd:$tail");
    } else {
       &Reply($client, "ok\n", "$cmd:$tail");
    }
       } else {
    &Failure($client, "not_found\n", "$cmd:$tail");
       }
    } else {
       &Failure($client, "not_home\n", "$cmd:$tail");
    }
       }
       return 1;
   }
   &register_handler("removeuserfile", \&remove_user_file_handler, 0,1,0);
   
   #
   #   make a directory in a user's home directory userfiles subdirectory.
 # Parameters:  # Parameters:
 #    $cmd      - The command that got us here.  #    cmd   - the Lond request keyword that got us here.
 #    $tail     - Tail of the command (remaining parameters).  #    tail  - the part of the command past the keyword.
 #    $client   - File descriptor connected to client.  #    client- File descriptor connected with the client.
 # Returns  #
 #     0        - Requested to exit, caller should shut down.  # Returns:
 #     1        - Continue processing.  #    1    - Continue processing.
 sub AuthenticateUserFileAccess {  sub mkdir_user_file_handler {
    my $cmd   = shift;      my ($cmd, $tail, $client) = @_;
    my $tail    = shift;  
    my $client = shift;      my ($dir) = split(/:/, $tail); # Get rid of any tailing :'s lonc may have sent.
    my $userinput = "$cmd:$tail";      $dir=&unescape($dir);
       my ($udom,$uname,$ufile) = ($dir =~ m|^([^/]+)/([^/]+)/(.+)$|);
    my ($fname,$session)=split(/:/,$tail);      if ($ufile =~m|/\.\./|) {
    chomp($session);   # any files paths with /../ in them refuse 
    my $reply='non_auth';   # to deal with
    if (open(ENVIN,$perlvar{'lonIDsDir'}.'/'.$session.'.id')) {   &Failure($client, "refused\n", "$cmd:$tail");
       while (my $line=<ENVIN>) {      } else {
          if ($line=~/userfile\.$fname\=/) {    my $udir = &propath($udom,$uname);
             $reply='ok';    if (-e $udir) {
          }      my $newdir=$udir.'/userfiles/'.$ufile.'/';
       }      if (!&mkpath($newdir)) {
       close(ENVIN);   &Failure($client, "failed\n", "$cmd:$tail");
       Reply($client, $reply."\n", $userinput);      }
    } else {      &Reply($client, "ok\n", "$cmd:$tail");
       Failure($client, "invalid_token\n", $userinput);   } else {
    }      &Failure($client, "not_home\n", "$cmd:$tail");
    return 1;   }
          }
       return 1;
   }
   &register_handler("mkdiruserfile", \&mkdir_user_file_handler, 0,1,0);
   
   #
   #   rename a file in a user's home directory userfiles subdirectory.
   # Parameters:
   #    cmd   - the Lond request keyword that got us here.
   #    tail  - the part of the command past the keyword.
   #    client- File descriptor connected with the client.
   #
   # Returns:
   #    1    - Continue processing.
   sub rename_user_file_handler {
       my ($cmd, $tail, $client) = @_;
   
       my ($udom,$uname,$old,$new) = split(/:/, $tail);
       $old=&unescape($old);
       $new=&unescape($new);
       if ($new =~m|/\.\./| || $old =~m|/\.\./|) {
    # any files paths with /../ in them refuse to deal with
    &Failure($client, "refused\n", "$cmd:$tail");
       } else {
    my $udir = &propath($udom,$uname);
    if (-e $udir) {
       my $oldfile=$udir.'/userfiles/'.$old;
       my $newfile=$udir.'/userfiles/'.$new;
       if (-e $newfile) {
    &Failure($client, "exists\n", "$cmd:$tail");
       } elsif (! -e $oldfile) {
    &Failure($client, "not_found\n", "$cmd:$tail");
       } else {
    if (!rename($oldfile,$newfile)) {
       &Failure($client, "failed\n", "$cmd:$tail");
    } else {
       &Reply($client, "ok\n", "$cmd:$tail");
    }
       }
    } else {
       &Failure($client, "not_home\n", "$cmd:$tail");
    }
       }
       return 1;
   }
   &register_handler("renameuserfile", \&rename_user_file_handler, 0,1,0);
   
   #
   #  Checks if the specified user has an active session on the server
   #  return ok if so, not_found if not
   #
   # Parameters:
   #   cmd      - The request keyword that dispatched to tus.
   #   tail     - The tail of the request (colon separated parameters).
   #   client   - Filehandle open on the client.
   # Return:
   #    1.
   sub user_has_session_handler {
       my ($cmd, $tail, $client) = @_;
   
       my ($udom, $uname) = map { &unescape($_) } (split(/:/, $tail));
       
       opendir(DIR,$perlvar{'lonIDsDir'});
       my $filename;
       while ($filename=readdir(DIR)) {
    last if ($filename=~/^\Q$uname\E_\d+_\Q$udom\E_/);
       }
       if ($filename) {
    &Reply($client, "ok\n", "$cmd:$tail");
       } else {
    &Failure($client, "not_found\n", "$cmd:$tail");
       }
       return 1;
   
   }
   &register_handler("userhassession", \&user_has_session_handler, 0,1,0);
   
   #
   #  Authenticate access to a user file by checking that the token the user's 
   #  passed also exists in their session file
   #
   # Parameters:
   #   cmd      - The request keyword that dispatched to tus.
   #   tail     - The tail of the request (colon separated parameters).
   #   client   - Filehandle open on the client.
   # Return:
   #    1.
   sub token_auth_user_file_handler {
       my ($cmd, $tail, $client) = @_;
   
       my ($fname, $session) = split(/:/, $tail);
       
       chomp($session);
       my $reply="non_auth";
       my $file = $perlvar{'lonIDsDir'}.'/'.$session.'.id';
       if (open(ENVIN,"$file")) {
    flock(ENVIN,LOCK_SH);
    tie(my %disk_env,'GDBM_File',"$file",&GDBM_READER(),0640);
    if (exists($disk_env{"userfile.$fname"})) {
       $reply="ok";
    } else {
       foreach my $envname (keys(%disk_env)) {
    if ($envname=~ m|^userfile\.\Q$fname\E|) {
       $reply="ok";
       last;
    }
       }
    }
    untie(%disk_env);
    close(ENVIN);
    &Reply($client, \$reply, "$cmd:$tail");
       } else {
    &Failure($client, "invalid_token\n", "$cmd:$tail");
       }
       return 1;
   
 }  }
 RegisterHandler("tokenauthuserfile", \&AuthenticateUserFileAccess, 0, 1, 0);  &register_handler("tokenauthuserfile", \&token_auth_user_file_handler, 0,1,0);
   
 #  #
 #   Unsubscribe from a resource.  #   Unsubscribe from a resource.
 #  #
Line 1184  RegisterHandler("tokenauthuserfile", \&A Line 2589  RegisterHandler("tokenauthuserfile", \&A
 #     0        - Requested to exit, caller should shut down.  #     0        - Requested to exit, caller should shut down.
 #     1        - Continue processing.  #     1        - Continue processing.
 #  #
 sub UnsubscribeHandler {  sub unsubscribe_handler {
    my $cmd      = shift;      my ($cmd, $tail, $client) = @_;
    my $tail     = shift;  
    my $client   = shift;      my $userinput= "$cmd:$tail";
    my $userinput= "$cmd:$tail";      
       my ($fname) = split(/:/,$tail); # Split in case there's extrs.
    my $fname = $tail;  
    if (-e $fname) {      &Debug("Unsubscribing $fname");
       Reply($client, &unsub($client,$fname,$clientip), $userinput);      if (-e $fname) {
    } else {   &Debug("Exists");
       Failure($client, "not_found\n", $userinput);   &Reply($client, &unsub($fname,$clientip), $userinput);
    }      } else {
    return 1;   &Failure($client, "not_found\n", $userinput);
       }
       return 1;
 }  }
 RegisterHandler("unusb", \&UnsubscribeHandler, 0, 1, 0);  &register_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
   
 #   Subscribe to a resource.  #   Subscribe to a resource
 #  #
 # Parameters:  # Parameters:
 #    $cmd      - The command that got us here.  #    $cmd      - The command that got us here.
Line 1210  RegisterHandler("unusb", \&UnsubscribeHa Line 2617  RegisterHandler("unusb", \&UnsubscribeHa
 #     0        - Requested to exit, caller should shut down.  #     0        - Requested to exit, caller should shut down.
 #     1        - Continue processing.  #     1        - Continue processing.
 #  #
 sub SubscribeHandler {  sub subscribe_handler {
    my $cmd        = shift;      my ($cmd, $tail, $client)= @_;
    my $tail       = shift;  
    my $client     = shift;  
    my $userinput  = "$cmd:$tail";  
   
    Reply( $client, &subscribe($userinput,$clientip), $userinput);      my $userinput  = "$cmd:$tail";
    
    return 1;      &Reply( $client, &subscribe($userinput,$clientip), $userinput);
   
       return 1;
 }  }
 RegisterHandler("sub", \&SubscribeHandler, 0, 1, 0);  &register_handler("sub", \&subscribe_handler, 0, 1, 0);
   
 #  #
 #   Determine the version of a resource (?) Or is it return  #   Determine the latest version of a resource (it looks for the highest
 #   the top version of the resource?  Not yet clear from the  #   past version and then returns that +1)
 #   code in currentversion.  
 #  #
 # Parameters:  # Parameters:
 #    $cmd      - The command that got us here.  #    $cmd      - The command that got us here.
 #    $tail     - Tail of the command (remaining parameters).  #    $tail     - Tail of the command (remaining parameters).
   #                 (Should consist of an absolute path to a file)
 #    $client   - File descriptor connected to client.  #    $client   - File descriptor connected to client.
 # Returns  # Returns
 #     0        - Requested to exit, caller should shut down.  #     0        - Requested to exit, caller should shut down.
 #     1        - Continue processing.  #     1        - Continue processing.
 #  #
 sub CurrentVersionHandler {  sub current_version_handler {
    my $cmd      = shift;      my ($cmd, $tail, $client) = @_;
    my $tail     = shift;  
    my $client   = shift;      my $userinput= "$cmd:$tail";
    my $userinput= "$cmd:$tail";  
         
    my $fname   = $tail;      my $fname   = $tail;
    Reply( $client, &currentversion($fname)."\n", $userinput);      &Reply( $client, &currentversion($fname)."\n", $userinput);
    return 1;      return 1;
   
 }  }
 RegisterHandler("currentversion", \&CurrentVersionHandler, 0, 1, 0);  &register_handler("currentversion", \&current_version_handler, 0, 1, 0);
   
   
 #  Make an entry in a user's activity log.  #  Make an entry in a user's activity log.
 #  #
Line 1259  RegisterHandler("currentversion", \&Curr Line 2663  RegisterHandler("currentversion", \&Curr
 #     0        - Requested to exit, caller should shut down.  #     0        - Requested to exit, caller should shut down.
 #     1        - Continue processing.  #     1        - Continue processing.
 #  #
 sub ActivityLogEntryHandler {  sub activity_log_handler {
    my $cmd      = shift;      my ($cmd, $tail, $client) = @_;
    my $tail     = shift;  
    my $client   = shift;  
    my $userinput= "$cmd:$tail";  
   
    my ($udom,$uname,$what)=split(/:/,$tail);  
    chomp($what);  
    my $proname=propath($udom,$uname);  
    my $now=time;  
    my $hfh;  
    if ($hfh=IO::File->new(">>$proname/activity.log")) {   
       print $hfh "$now:$clientname:$what\n";  
       Reply( $client, "ok\n", $userinput);   
    } else {  
       Reply($client, "error: ".($!+0)." IO::File->new Failed "  
             ."while attempting log\n",   
             $userinput);  
    }  
   
    return 1;  
       my $userinput= "$cmd:$tail";
   
       my ($udom,$uname,$what)=split(/:/,$tail);
       chomp($what);
       my $proname=&propath($udom,$uname);
       my $now=time;
       my $hfh;
       if ($hfh=IO::File->new(">>$proname/activity.log")) { 
    print $hfh "$now:$clientname:$what\n";
    &Reply( $client, "ok\n", $userinput); 
       } else {
    &Failure($client, "error: ".($!+0)." IO::File->new Failed "
    ."while attempting log\n", 
    $userinput);
       }
   
       return 1;
 }  }
 RegisterHandler("log", \&ActivityLogEntryHandler, 0, 1, 0);  &register_handler("log", \&activity_log_handler, 0, 1, 0);
   
 #  #
 #   Put a namespace entry in a user profile hash.  #   Put a namespace entry in a user profile hash.
 #   My druthers would be for this to be an encrypted interaction too.  #   My druthers would be for this to be an encrypted interaction too.
Line 1296  RegisterHandler("log", \&ActivityLogEntr Line 2701  RegisterHandler("log", \&ActivityLogEntr
 #     0        - Requested to exit, caller should shut down.  #     0        - Requested to exit, caller should shut down.
 #     1        - Continue processing.  #     1        - Continue processing.
 #  #
 sub PutUserProfileEntry {  sub put_user_profile_entry {
    my $cmd       = shift;      my ($cmd, $tail, $client)  = @_;
    my $tail      = shift;  
    my $client    = shift;      my $userinput = "$cmd:$tail";
    my $userinput = "$cmd:$tail";      
       my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
    my ($udom,$uname,$namespace,$what) =split(/:/,$tail);      if ($namespace ne 'roles') {
    $namespace=~s/\//\_/g;   chomp($what);
    $namespace=~s/\W//g;   my $hashref = &tie_user_hash($udom, $uname, $namespace,
    if ($namespace ne 'roles') {    &GDBM_WRCREAT(),"P",$what);
       chomp($what);   if($hashref) {
       my $proname=propath($udom,$uname);      my @pairs=split(/\&/,$what);
       my $now=time;      foreach my $pair (@pairs) {
       unless ($namespace=~/^nohist\_/) {   my ($key,$value)=split(/=/,$pair);
          my $hfh;   $hashref->{$key}=$value;
          if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {       }
             print $hfh "P:$now:$what\n";       if (&untie_user_hash($hashref)) {
          }   &Reply( $client, "ok\n", $userinput);
       }      } else {
       my @pairs=split(/\&/,$what);   &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
       my %hash;   "while attempting put\n", 
       if (tie(%hash,'GDBM_File',"$proname/$namespace.db",   $userinput);
                   &GDBM_WRCREAT(),0640)) {      }
          foreach my $pair (@pairs) {   } else {
             my ($key,$value)=split(/=/,$pair);      &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
             $hash{$key}=$value;       "while attempting put\n", $userinput);
          }   }
          if (untie(%hash)) {      } else {
             Reply( $client, "ok\n", $userinput);          &Failure( $client, "refused\n", $userinput);
          } else {      }
             Failure($client, "error: ".($!+0)." untie(GDBM) failed ".      
                   "while attempting put\n",       return 1;
                   $userinput);  
          }  
       } else {  
          Failure( $client, "error: ".($!)." tie(GDBM) Failed ".  
          "while attempting put\n", $userinput);  
       }  
    } else {  
       Failure( $client, "refused\n", $userinput);  
    }  
      
    return 1;  
 }  }
 RegisterHandler("put", \&PutUserProfileEntry, 0, 1, 0);  &register_handler("put", \&put_user_profile_entry, 0, 1, 0);
   
   #   Put a piece of new data in hash, returns error if entry already exists
   # Parameters:
   #    $cmd      - The command that got us here.
   #    $tail     - Tail of the command (remaining parameters).
   #    $client   - File descriptor connected to client.
   # Returns
   #     0        - Requested to exit, caller should shut down.
   #     1        - Continue processing.
   #
   sub newput_user_profile_entry {
       my ($cmd, $tail, $client)  = @_;
   
       my $userinput = "$cmd:$tail";
   
       my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
       if ($namespace eq 'roles') {
           &Failure( $client, "refused\n", $userinput);
    return 1;
       }
   
       chomp($what);
   
       my $hashref = &tie_user_hash($udom, $uname, $namespace,
    &GDBM_WRCREAT(),"N",$what);
       if(!$hashref) {
    &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
     "while attempting put\n", $userinput);
    return 1;
       }
   
       my @pairs=split(/\&/,$what);
       foreach my $pair (@pairs) {
    my ($key,$value)=split(/=/,$pair);
    if (exists($hashref->{$key})) {
       &Failure($client, "key_exists: ".$key."\n",$userinput);
       return 1;
    }
       }
   
       foreach my $pair (@pairs) {
    my ($key,$value)=split(/=/,$pair);
    $hashref->{$key}=$value;
       }
   
       if (&untie_user_hash($hashref)) {
    &Reply( $client, "ok\n", $userinput);
       } else {
    &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
    "while attempting put\n", 
    $userinput);
       }
       return 1;
   }
   &register_handler("newput", \&newput_user_profile_entry, 0, 1, 0);
   
 #   # 
 #   Increment a profile entry in the user history file.  #   Increment a profile entry in the user history file.
Line 1357  RegisterHandler("put", \&PutUserProfileE Line 2806  RegisterHandler("put", \&PutUserProfileE
 #     0        - Requested to exit, caller should shut down.  #     0        - Requested to exit, caller should shut down.
 #     1        - Continue processing.  #     1        - Continue processing.
 #  #
 sub IncrementUserValueHandler {  sub increment_user_value_handler {
    my $cmd         = shift;      my ($cmd, $tail, $client) = @_;
    my $tail        = shift;      
    my $client      = shift;      my $userinput   = "$cmd:$tail";
    my $userinput   = shift;      
       my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
    my ($udom,$uname,$namespace,$what) =split(/:/,$tail);      if ($namespace ne 'roles') {
    $namespace=~s/\//\_/g;          chomp($what);
    $namespace=~s/\W//g;   my $hashref = &tie_user_hash($udom, $uname,
    if ($namespace ne 'roles') {       $namespace, &GDBM_WRCREAT(),
       chomp($what);       "P",$what);
       my $proname=propath($udom,$uname);   if ($hashref) {
       my $now=time;      my @pairs=split(/\&/,$what);
       unless ($namespace=~/^nohist\_/) {      foreach my $pair (@pairs) {
          my $hfh;   my ($key,$value)=split(/=/,$pair);
          if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {                   $value = &unescape($value);
             print $hfh "P:$now:$what\n";   # We could check that we have a number...
          }   if (! defined($value) || $value eq '') {
       }      $value = 1;
       my @pairs=split(/\&/,$what);   }
       my %hash;   $hashref->{$key}+=$value;
       if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_WRCREAT(),                  if ($namespace eq 'nohist_resourcetracker') {
                0640)) {                      if ($hashref->{$key} < 0) {
          foreach my $pair (@pairs) {                          $hashref->{$key} = 0;
             my ($key,$value)=split(/=/,$pair);                      }
             # We could check that we have a number...                  }
             if (! defined($value) || $value eq '') {      }
                $value = 1;      if (&untie_user_hash($hashref)) {
             }   &Reply( $client, "ok\n", $userinput);
             $hash{$key}+=$value;      } else {
          }   &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
          if (untie(%hash)) {   "while attempting inc\n", $userinput);
             Reply( $client, "ok\n", $userinput);      }
          } else {   } else {
             Failure($client, "error: ".($!+0)." untie(GDBM) failed ".      &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
                      "while attempting put\n", $userinput);       "while attempting inc\n", $userinput);
          }   }
       } else {      } else {
          Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure($client, "refused\n", $userinput);
                   "while attempting put\n", $userinput);      }
       }      
    } else {      return 1;
       Failure($client, "refused\n", $userinput);  
    }  
   
    return 1;  
 }  }
 RegisterHandler("inc", \&IncrementUserValueHandler, 0, 1, 0);  &register_handler("inc", \&increment_user_value_handler, 0, 1, 0);
   
 #  #
 #   Put a new role for a user.  Roles are LonCAPA's packaging of permissions.  #   Put a new role for a user.  Roles are LonCAPA's packaging of permissions.
 #   Each 'role' a user has implies a set of permissions.  Adding a new role  #   Each 'role' a user has implies a set of permissions.  Adding a new role
Line 1425  RegisterHandler("inc", \&IncrementUserVa Line 2871  RegisterHandler("inc", \&IncrementUserVa
 #     1         - To continue processing.  #     1         - To continue processing.
 #  #
 #  #
 sub RolesPutHandler {  sub roles_put_handler {
    my $cmd        = shift;      my ($cmd, $tail, $client) = @_;
    my $tail       = shift;  
    my $client     = shift;      my $userinput  = "$cmd:$tail";
    my $userinput  = "$cmd:$tail";  
          my ( $exedom, $exeuser, $udom, $uname,  $what) = split(/:/,$tail);
    my ($exedom,$exeuser,$udom,$uname,$what)   =split(/:/,$tail);      
    &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.  
           "what = ".$what);      my $namespace='roles';
    my $namespace='roles';      chomp($what);
    chomp($what);      my $hashref = &tie_user_hash($udom, $uname, $namespace,
    my $proname=propath($udom,$uname);   &GDBM_WRCREAT(), "P",
    my $now=time;   "$exedom:$exeuser:$what");
    #      #
    #  Log the attempt to set a role.  The {}'s here ensure that the file       #  Log the attempt to set a role.  The {}'s here ensure that the file 
    #  handle is open for the minimal amount of time.  Since the flush      #  handle is open for the minimal amount of time.  Since the flush
    #  is done on close this improves the chances the log will be an un-      #  is done on close this improves the chances the log will be an un-
    #  corrupted ordered thing.      #  corrupted ordered thing.
    {      if ($hashref) {
       my $hfh;   my $pass_entry = &get_auth_type($udom, $uname);
       if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {    my ($auth_type,$pwd)  = split(/:/, $pass_entry);
          print $hfh "P:$now:$exedom:$exeuser:$what\n";   $auth_type = $auth_type.":";
       }   my @pairs=split(/\&/,$what);
    }   foreach my $pair (@pairs) {
    my @pairs=split(/\&/,$what);      my ($key,$value)=split(/=/,$pair);
    my %hash;      &manage_permissions($key, $udom, $uname,
    if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_WRCREAT(),0640)) {         $auth_type);
       foreach my $pair (@pairs) {      $hashref->{$key}=$value;
          my ($key,$value)=split(/=/,$pair);   }
             &ManagePermissions($key, $udom, $uname,   if (&untie_user_hash($hashref)) {
                                &GetAuthType( $udom, $uname));      &Reply($client, "ok\n", $userinput);
             $hash{$key}=$value;   } else {
       }      &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
       if (untie(%hash)) {       "while attempting rolesput\n", $userinput);
          Reply($client, "ok\n", $userinput);   }
       } else {      } else {
          Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
                          "while attempting rolesput\n", $userinput);   "while attempting rolesput\n", $userinput);
       }      }
    } else {      return 1;
       Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".  
                         "while attempting rolesput\n", $userinput);  
    }  
    return 1;  
 }  }
 RegisterHandler("rolesput", \&RolesPutHandler, 1,1,0);  # Encoded client only.  &register_handler("rolesput", \&roles_put_handler, 1,1,0);  # Encoded client only.
   
 #  #
 #   Deletes (removes) a role for a user.   This is equivalent to removing  #   Deletes (removes) a role for a user.   This is equivalent to removing
 #  a permissions package associated with the role from the user's profile.  #  a permissions package associated with the role from the user's profile.
Line 1488  RegisterHandler("rolesput", \&RolesPutHa Line 2931  RegisterHandler("rolesput", \&RolesPutHa
 #     1                    - Continue processing  #     1                    - Continue processing
 #     0                    - Exit.  #     0                    - Exit.
 #  #
 sub RolesDeleteHandler {  sub roles_delete_handler {
    my $cmd          = shift;      my ($cmd, $tail, $client)  = @_;
    my $tail         = shift;  
    my $client       = shift;  
    my $userinput    = "$cmd:$tail";  
      
    my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);  
    &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.  
           "what = ".$what);  
    my $namespace='roles';  
    chomp($what);  
    my $proname=propath($udom,$uname);  
    my $now=time;  
    #  
    #   Log the attempt. This {}'ing is done to ensure that the  
    #   logfile is flushed and closed as quickly as possible.  Hopefully  
    #   this preserves both time ordering and reduces the probability that  
    #   messages will be interleaved.  
    #  
    {  
       my $hfh;  
       if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {   
          print $hfh "D:$now:$exedom:$exeuser:$what\n";  
       }  
    }  
    my @rolekeys=split(/\&/,$what);  
    my %hash;  
    if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_WRCREAT(),0640)) {  
       foreach my $key (@rolekeys) {  
          delete $hash{$key};  
       }  
       if (untie(%hash)) {  
          Reply($client, "ok\n", $userinput);  
       } else {  
          Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".  
                            "while attempting rolesdel\n", $userinput);  
       }  
    } else {  
       Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".  
                         "while attempting rolesdel\n", $userinput);  
    }  
   
    return 1;      my $userinput    = "$cmd:$tail";
      
       my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
       &Debug("cmd = ".$cmd." exedom= ".$exedom."user = ".$exeuser." udom=".$udom.
      "what = ".$what);
       my $namespace='roles';
       chomp($what);
       my $hashref = &tie_user_hash($udom, $uname, $namespace,
    &GDBM_WRCREAT(), "D",
    "$exedom:$exeuser:$what");
       
       if ($hashref) {
    my @rolekeys=split(/\&/,$what);
   
    foreach my $key (@rolekeys) {
       delete $hashref->{$key};
    }
    if (&untie_user_hash($hashref)) {
       &Reply($client, "ok\n", $userinput);
    } else {
       &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
        "while attempting rolesdel\n", $userinput);
    }
       } else {
           &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
    "while attempting rolesdel\n", $userinput);
       }
       
       return 1;
 }  }
 RegisterHandler("rolesdel", \&RolesDeleteHandler, 1,1, 0); # Encoded client only  &register_handler("rolesdel", \&roles_delete_handler, 1,1, 0); # Encoded client only
   
 # Unencrypted get from a user's profile database.  See   # Unencrypted get from a user's profile database.  See 
 # GetProfileEntryEncrypted for a version that does end-to-end encryption.  # GetProfileEntryEncrypted for a version that does end-to-end encryption.
Line 1553  RegisterHandler("rolesdel", \&RolesDelet Line 2985  RegisterHandler("rolesdel", \&RolesDelet
 #   1       - Continue processing.  #   1       - Continue processing.
 #   0       - Exit.  #   0       - Exit.
 #  #
 sub GetProfileEntry {  sub get_profile_entry {
    my $cmd      = shift;      my ($cmd, $tail, $client) = @_;
    my $tail     = shift;  
    my $client   = shift;      my $userinput= "$cmd:$tail";
    my $userinput= "$cmd:$tail";  
         
    my ($udom,$uname,$namespace,$what) = split(/:/,$tail);      my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
    $namespace=~s/\//\_/g;      chomp($what);
    $namespace=~s/\W//g;  
    chomp($what);  
    my @queries=split(/\&/,$what);      my $replystring = read_profile($udom, $uname, $namespace, $what);
    my $proname=propath($udom,$uname);      my ($first) = split(/:/,$replystring);
    my $qresult='';      if($first ne "error") {
    my %hash;   &Reply($client, \$replystring, $userinput);
    if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_READER(),0640)) {      } else {
       for (my $i=0;$i<=$#queries;$i++) {   &Failure($client, $replystring." while attempting get\n", $userinput);
          $qresult.="$hash{$queries[$i]}&";    # Presumably failure gives empty string.      }
       }      return 1;
       if (untie(%hash)) {  
          $qresult=~s/\&$//;              # Remove trailing & from last lookup.  
          Reply($client, "$qresult\n", $userinput);  
       } else {  
          Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".  
                           "while attempting get\n", $userinput);  
       }  
    } else {  
       if ($!+0 == 2) {                # +0 coerces errno -> number 2 is ENOENT  
          Failure($client, "error:No such file or ".  
                           "GDBM reported bad block error\n", $userinput);  
       } else {                        # Some other undifferentiated err.  
          Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".  
                            "while attempting get\n", $userinput);  
       }  
    }  
    return 1;  
 }  }
 RegisterHandler("get", \&GetProfileEntry, 0,1,0);  &register_handler("get", \&get_profile_entry, 0,1,0);
   
 #  #
 #  Process the encrypted get request.  Note that the request is sent  #  Process the encrypted get request.  Note that the request is sent
 #  in clear, but the reply is encrypted.  This is a small covert channel:  #  in clear, but the reply is encrypted.  This is a small covert channel:
Line 1609  RegisterHandler("get", \&GetProfileEntry Line 3026  RegisterHandler("get", \&GetProfileEntry
 #  Returns:  #  Returns:
 #     1      - Continue processing  #     1      - Continue processing
 #     0      - server should exit.  #     0      - server should exit.
 sub GetProfileEntryEncrypted {  sub get_profile_entry_encrypted {
    my $cmd       = shift;      my ($cmd, $tail, $client) = @_;
    my $tail      = shift;  
    my $client    = shift;      my $userinput = "$cmd:$tail";
    my $userinput = "$cmd:$tail";  
         
    my ($cmd,$udom,$uname,$namespace,$what) = split(/:/,$userinput);      my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
    $namespace=~s/\//\_/g;      chomp($what);
    $namespace=~s/\W//g;      my $qresult = read_profile($udom, $uname, $namespace, $what);
    chomp($what);      my ($first) = split(/:/, $qresult);
    my @queries=split(/\&/,$what);      if($first ne "error") {
    my $proname=propath($udom,$uname);  
    my $qresult='';   if ($cipher) {
    my %hash;      my $cmdlength=length($qresult);
    if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_READER(),0640)) {      $qresult.="         ";
       for (my $i=0;$i<=$#queries;$i++) {      my $encqresult='';
          $qresult.="$hash{$queries[$i]}&";      for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
       }   $encqresult.= unpack("H16", 
       if (untie(%hash)) {       $cipher->encrypt(substr($qresult,
          $qresult=~s/\&$//;       $encidx,
          if ($cipher) {       8)));
             my $cmdlength=length($qresult);      }
             $qresult.="         ";      &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
             my $encqresult='';   } else {
             for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {   &Failure( $client, "error:no_key\n", $userinput);
                $encqresult.= unpack("H16", $cipher->encrypt(substr($qresult,      }
                                                                    $encidx,      } else {
                                                                    8)));   &Failure($client, "$qresult while attempting eget\n", $userinput);
             }  
             Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);      }
          } else {      
             Failure( $client, "error:no_key\n", $userinput);      return 1;
          }  
       } else {  
          Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".  
                               "while attempting eget\n", $userinput);  
       }  
    } else {  
       Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".  
                        "while attempting eget\n", $userinput);  
    }  
            
    return 1;  
 }  }
 RegisterHandler("eget", \&GetProfileEncrypted, 0, 1, 0);  &register_handler("eget", \&get_profile_entry_encrypted, 0, 1, 0);
   
 #  #
 #   Deletes a key in a user profile database.  #   Deletes a key in a user profile database.
Line 1673  RegisterHandler("eget", \&GetProfileEncr Line 3078  RegisterHandler("eget", \&GetProfileEncr
 #     0   - Exit server.  #     0   - Exit server.
 #  #
 #  #
 sub DeletProfileEntry {  sub delete_profile_entry {
    my $cmd      = shift;      my ($cmd, $tail, $client) = @_;
    my $tail     = shift;  
    my $client   = shift;      my $userinput = "cmd:$tail";
    my $userinput = "cmd:$tail";  
       my ($udom,$uname,$namespace,$what) = split(/:/,$tail);
    my ($udom,$uname,$namespace,$what) = split(/:/,$tail);      chomp($what);
    $namespace=~s/\//\_/g;      my $hashref = &tie_user_hash($udom, $uname, $namespace,
    $namespace=~s/\W//g;   &GDBM_WRCREAT(),
    chomp($what);   "D",$what);
    my $proname=propath($udom,$uname);      if ($hashref) {
    my $now=time;          my @keys=split(/\&/,$what);
    unless ($namespace=~/^nohist\_/) {   foreach my $key (@keys) {
       my $hfh;      delete($hashref->{$key});
       if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {    }
          print $hfh "D:$now:$what\n";    if (&untie_user_hash($hashref)) {
       }      &Reply($client, "ok\n", $userinput);
    }   } else {
    my @keys=split(/\&/,$what);      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
    my %hash;      "while attempting del\n", $userinput);
    if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_WRCREAT(),0640)) {   }
       foreach my $key (@keys) {      } else {
          delete($hash{$key});   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
       }   "while attempting del\n", $userinput);
       if (untie(%hash)) {      }
          Reply($client, "ok\n", $userinput);      return 1;
       } else {  
          Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".  
                            "while attempting del\n", $userinput);  
       }  
    } else {  
       Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".  
                         "while attempting del\n", $userinput);  
    }  
    return 1;  
 }  }
 RegisterHandler("del", \&DeleteProfileEntry, 0, 1, 0);  &register_handler("del", \&delete_profile_entry, 0, 1, 0);
   
 #  #
 #  List the set of keys that are defined in a profile database file.  #  List the set of keys that are defined in a profile database file.
 #  A successful reply from this will contain an & separated list of  #  A successful reply from this will contain an & separated list of
Line 1725  RegisterHandler("del", \&DeleteProfileEn Line 3122  RegisterHandler("del", \&DeleteProfileEn
 #    1    - Continue processing.  #    1    - Continue processing.
 #    0    - Exit the server.  #    0    - Exit the server.
 #  #
 sub GetProfileKeys {  sub get_profile_keys {
    my $cmd       = shift;      my ($cmd, $tail, $client) = @_;
    my $tail      = shift;  
    my $client    = shift;      my $userinput = "$cmd:$tail";
    my $userinput = "$cmd:$tail";  
       my ($udom,$uname,$namespace)=split(/:/,$tail);
    my ($udom,$uname,$namespace)=split(/:/,$tail);      my $qresult='';
    $namespace=~s/\//\_/g;      my $hashref = &tie_user_hash($udom, $uname, $namespace,
    $namespace=~s/\W//g;    &GDBM_READER());
    my $proname=propath($udom,$uname);      if ($hashref) {
    my $qresult='';   foreach my $key (keys %$hashref) {
    my %hash;      $qresult.="$key&";
    if (tie(%hash,'GDBM_File',"$proname/$namespace.db",&GDBM_READER(),0640)) {   }
       foreach my $key (keys %hash) {   if (&untie_user_hash($hashref)) {
           $qresult.="$key&";      $qresult=~s/\&$//;
       }      &Reply($client, \$qresult, $userinput);
       if (untie(%hash)) {   } else {
          $qresult=~s/\&$//;      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
          Reply($client, "$qresult\n", $userinput);      "while attempting keys\n", $userinput);
       } else {   }
          Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".      } else {
                           "while attempting keys\n", $userinput);   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
       }   "while attempting keys\n", $userinput);
    } else {      }
       Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".  
                         "while attempting keys\n", $userinput);  
    }  
         
    return 1;      return 1;
 }  }
 RegisterHandler("keys", \&GetProfileKeys, 0, 1, 0);  &register_handler("keys", \&get_profile_keys, 0, 1, 0);
   
 #  #
 #   Dump the contents of a user profile database.  #   Dump the contents of a user profile database.
 #   Note that this constitutes a very large covert channel too since  #   Note that this constitutes a very large covert channel too since
Line 1775  RegisterHandler("keys", \&GetProfileKeys Line 3170  RegisterHandler("keys", \&GetProfileKeys
 #     1    - Continue processing.  #     1    - Continue processing.
 #     0    - Exit the server.  #     0    - Exit the server.
 #  #
 sub DumpProfileDatabase {  sub dump_profile_database {
    my $cmd       = shift;      my ($cmd, $tail, $client) = @_;
    my $tail      = shift;  
    my $client    = shift;      my $res = LONCAPA::Lond::dump_profile_database($tail);
    my $userinput = "$cmd:$tail";  
       if ($res =~ /^error:/) {
           Failure($client, \$res, "$cmd:$tail");
       } else {
           Reply($client, \$res, "$cmd:$tail");
       }
   
       return 1;  
   
       #TODO remove 
       my $userinput = "$cmd:$tail";
         
    my ($udom,$uname,$namespace) = split(/:/,$tail);      my ($udom,$uname,$namespace) = split(/:/,$tail);
    $namespace=~s/\//\_/g;      my $hashref = &tie_user_hash($udom, $uname, $namespace,
    $namespace=~s/\W//g;   &GDBM_READER());
    my $qresult='';      if ($hashref) {
    my $proname=propath($udom,$uname);   # Structure of %data:
    my %hash;   # $data{$symb}->{$parameter}=$value;
    if (tie(%hash,'GDBM_File',"$proname/$namespace.db", &GDBM_READER(),0640)) {   # $data{$symb}->{'v.'.$parameter}=$version;
       # Structure of %data:   # since $parameter will be unescaped, we do not
       # $data{$symb}->{$parameter}=$value;    # have to worry about silly parameter names...
       # $data{$symb}->{'v.'.$parameter}=$version;  
       # since $parameter will be unescaped, we do not          my $qresult='';
       # have to worry about silly parameter names...   my %data = ();                     # A hash of anonymous hashes..
       my %data = ();                     # A hash of anonymous hashes..   while (my ($key,$value) = each(%$hashref)) {
       while (my ($key,$value) = each(%hash)) {      my ($v,$symb,$param) = split(/:/,$key);
          my ($v,$symb,$param) = split(/:/,$key);      next if ($v eq 'version' || $symb eq 'keys');
          next if ($v eq 'version' || $symb eq 'keys');      next if (exists($data{$symb}) && 
          next if (exists($data{$symb}) &&        exists($data{$symb}->{$param}) &&
                   exists($data{$symb}->{$param}) &&       $data{$symb}->{'v.'.$param} > $v);
                   $data{$symb}->{'v.'.$param} > $v);      $data{$symb}->{$param}=$value;
          $data{$symb}->{$param}=$value;      $data{$symb}->{'v.'.$param}=$v;
          $data{$symb}->{'v.'.$param}=$v;   }
       }   if (&untie_user_hash($hashref)) {
       if (untie(%hash)) {      while (my ($symb,$param_hash) = each(%data)) {
          while (my ($symb,$param_hash) = each(%data)) {   while(my ($param,$value) = each (%$param_hash)){
             while(my ($param,$value) = each (%$param_hash)){      next if ($param =~ /^v\./);       # Ignore versions...
                next if ($param =~ /^v\./);       # Ignore versions...      #
                #      #   Just dump the symb=value pairs separated by &
                #   Just dump the symb=value pairs separated by &      #
                #      $qresult.=$symb.':'.$param.'='.$value.'&';
                $qresult.=$symb.':'.$param.'='.$value.'&';   }
             }      }
          }      chop($qresult);
          chop($qresult);      &Reply($client , \$qresult, $userinput);
          Reply($client , "$qresult\n", $userinput);   } else {
       } else {      &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
          Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".       "while attempting currentdump\n", $userinput);
                            "while attempting currentdump\n", $userinput);   }
       }      } else {
    } else {   &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
       Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".   "while attempting currentdump\n", $userinput);
                         "while attempting currentdump\n", $userinput);      }
    }  
   
    return 1;      return 1;
 }  }
 RegisterHandler("currentdump", \&DumpProfileDatabase, 0, 1, 0);  &register_handler("currentdump", \&dump_profile_database, 0, 1, 0);
   
 #  #
 #   Dump a profile database with an optional regular expression  #   Dump a profile database with an optional regular expression
 #   to match against the keys.  In this dump, no effort is made  #   to match against the keys.  In this dump, no effort is made
Line 1845  RegisterHandler("currentdump", \&DumpPro Line 3250  RegisterHandler("currentdump", \&DumpPro
 #                                             that is matched against  #                                             that is matched against
 #                                             database keywords to do  #                                             database keywords to do
 #                                             selective dumps.  #                                             selective dumps.
   #                               range       - optional range of entries
   #                                             e.g., 10-20 would return the
   #                                             10th to 19th items, etc.  
 #   $client                   - Channel open on the client.  #   $client                   - Channel open on the client.
 # Returns:  # Returns:
 #    1    - Continue processing.  #    1    - Continue processing.
 # Side effects:  # Side effects:
 #    response is written to $client.  #    response is written to $client.
 #  #
 sub DumpWithRegexp {  sub dump_with_regexp {
   my $cmd    = shift;      my ($cmd, $tail, $client) = @_;
   my $tail   = shift;  
   my $client = shift;      my $res = LONCAPA::Lond::dump_with_regexp($tail, $clientversion);
       
   my $userinput = "$cmd:$tail";      if ($res =~ /^error:/) {
           Failure($client, \$res, "$cmd:$tail");
   my ($udom,$uname,$namespace,$regexp)=split(/:/,$tail);      } else {
   $namespace=~s/\//\_/g;          Reply($client, \$res, "$cmd:$tail");
   $namespace=~s/\W//g;  
   if (defined($regexp)) {  
     $regexp=&unescape($regexp);  
   } else {  
     $regexp='.';  
   }  
   my $qresult='';  
   my $proname=propath($udom,$uname);  
   my %hash;  
   if (tie(%hash,'GDBM_File',"$proname/$namespace.db",  
   &GDBM_READER(),0640)) {  
     study($regexp);  
     while (my ($key,$value) = each(%hash)) {  
       if ($regexp eq '.') {  
  $qresult.=$key.'='.$value.'&';  
       } else {  
  my $unescapeKey = &unescape($key);  
  if (eval('$unescapeKey=~/$regexp/')) {  
   $qresult.="$key=$value&";  
  }  
       }  
     }      }
     if (untie(%hash)) {  
       chop($qresult);      return 1;
       Reply($client, "$qresult\n", $userinput);  }
   &register_handler("dump", \&dump_with_regexp, 0, 1, 0);
   
   #  Store a set of key=value pairs associated with a versioned name.
   #
   #  Parameters:
   #    $cmd                - Request command keyword.
   #    $tail               - Tail of the request.  This is a colon
   #                          separated list containing:
   #                          domain/user - User and authentication domain.
   #                          namespace   - Name of the database being modified
   #                          rid         - Resource keyword to modify.
   #                          what        - new value associated with rid.
   #
   #    $client             - Socket open on the client.
   #
   #
   #  Returns:
   #      1 (keep on processing).
   #  Side-Effects:
   #    Writes to the client
   sub store_handler {
       my ($cmd, $tail, $client) = @_;
    
       my $userinput = "$cmd:$tail";
   
       my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);
       if ($namespace ne 'roles') {
   
    chomp($what);
    my @pairs=split(/\&/,$what);
    my $hashref  = &tie_user_hash($udom, $uname, $namespace,
          &GDBM_WRCREAT(), "S",
          "$rid:$what");
    if ($hashref) {
       my $now = time;
       my @previouskeys=split(/&/,$hashref->{"keys:$rid"});
       my $key;
       $hashref->{"version:$rid"}++;
       my $version=$hashref->{"version:$rid"};
       my $allkeys=''; 
       foreach my $pair (@pairs) {
    my ($key,$value)=split(/=/,$pair);
    $allkeys.=$key.':';
    $hashref->{"$version:$rid:$key"}=$value;
       }
       $hashref->{"$version:$rid:timestamp"}=$now;
       $allkeys.='timestamp';
       $hashref->{"$version:keys:$rid"}=$allkeys;
       if (&untie_user_hash($hashref)) {
    &Reply($client, "ok\n", $userinput);
       } else {
    &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
    "while attempting store\n", $userinput);
       }
    } else {
       &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
        "while attempting store\n", $userinput);
    }
     } else {      } else {
       Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".   &Failure($client, "refused\n", $userinput);
        "while attempting dump\n", $userinput);  
     }      }
   } else {  
     Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".  
     "while attempting dump\n", $userinput);  
   }  
   
     return 1;      return 1;
 }  }
 RegisterHandler("dump", \&DumpWithRegexp, 0, 1, 0);  &register_handler("store", \&store_handler, 0, 1, 0);
   
 #  Store an aitem in any database but the roles database.  #  Modify a set of key=value pairs associated with a versioned name.
 #  #
 #  Parameters:  #  Parameters:
 #    $cmd                - Request command keyword.  #    $cmd                - Request command keyword.
Line 1907  RegisterHandler("dump", \&DumpWithRegexp Line 3347  RegisterHandler("dump", \&DumpWithRegexp
 #                          domain/user - User and authentication domain.  #                          domain/user - User and authentication domain.
 #                          namespace   - Name of the database being modified  #                          namespace   - Name of the database being modified
 #                          rid         - Resource keyword to modify.  #                          rid         - Resource keyword to modify.
   #                          v           - Version item to modify
 #                          what        - new value associated with rid.  #                          what        - new value associated with rid.
 #  #
 #    $client             - Socket open on the client.  #    $client             - Socket open on the client.
Line 1916  RegisterHandler("dump", \&DumpWithRegexp Line 3357  RegisterHandler("dump", \&DumpWithRegexp
 #      1 (keep on processing).  #      1 (keep on processing).
 #  Side-Effects:  #  Side-Effects:
 #    Writes to the client  #    Writes to the client
 sub StoreHandler {  sub putstore_handler {
   my $cmd    = shift;      my ($cmd, $tail, $client) = @_;
   my $tail   = shift;  
   my $client = shift;  
     
   my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
   
   my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);      my ($udom,$uname,$namespace,$rid,$v,$what) =split(/:/,$tail);
   $namespace=~s/\//\_/g;      if ($namespace ne 'roles') {
   $namespace=~s/\W//g;  
   if ($namespace ne 'roles') {   chomp($what);
     chomp($what);   my $hashref  = &tie_user_hash($udom, $uname, $namespace,
     my $proname=propath($udom,$uname);         &GDBM_WRCREAT(), "M",
     my $now=time;         "$rid:$v:$what");
     unless ($namespace=~/^nohist\_/) {   if ($hashref) {
       my $hfh;      my $now = time;
       if ($hfh=IO::File->new(">>$proname/$namespace.hist")) {      my %data = &hash_extract($what);
  print $hfh "P:$now:$rid:$what\n";       my @allkeys;
       }      while (my($key,$value) = each(%data)) {
    push(@allkeys,$key);
    $hashref->{"$v:$rid:$key"} = $value;
       }
       my $allkeys = join(':',@allkeys);
       $hashref->{"$v:keys:$rid"}=$allkeys;
   
       if (&untie_user_hash($hashref)) {
    &Reply($client, "ok\n", $userinput);
       } else {
    &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
    "while attempting store\n", $userinput);
       }
    } else {
       &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
        "while attempting store\n", $userinput);
    }
       } else {
    &Failure($client, "refused\n", $userinput);
     }      }
     my @pairs=split(/\&/,$what);  
       return 1;
   }
   &register_handler("putstore", \&putstore_handler, 0, 1, 0);
   
   sub hash_extract {
       my ($str)=@_;
     my %hash;      my %hash;
     if (tie(%hash,'GDBM_File',"$proname/$namespace.db",      foreach my $pair (split(/\&/,$str)) {
     &GDBM_WRCREAT(),0640)) {  
       my @previouskeys=split(/&/,$hash{"keys:$rid"});  
       my $key;  
       $hash{"version:$rid"}++;  
       my $version=$hash{"version:$rid"};  
       my $allkeys='';   
       foreach my $pair (@pairs) {  
  my ($key,$value)=split(/=/,$pair);   my ($key,$value)=split(/=/,$pair);
  $allkeys.=$key.':';   $hash{$key}=$value;
  $hash{"$version:$rid:$key"}=$value;  
       }  
       $hash{"$version:$rid:timestamp"}=$now;  
       $allkeys.='timestamp';  
       $hash{"$version:keys:$rid"}=$allkeys;  
       if (untie(%hash)) {  
  Reply($client, "ok\n", $userinput);  
       } else {  
  Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".  
  "while attempting store\n", $userinput);  
       }  
     } else {  
       Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".  
        "while attempting store\n", $userinput);  
     }      }
   } else {      return (%hash);
     Failure($client, "refused\n", $userinput);  }
   }  sub hash_to_str {
       my ($hash_ref)=@_;
   return 1;      my $str;
       foreach my $key (keys(%$hash_ref)) {
    $str.=$key.'='.$hash_ref->{$key}.'&';
       }
       $str=~s/\&$//;
       return $str;
 }  }
 RegisterHandler("store", \&StoreHandler, 0, 1, 0);  
 #  #
 #   Restore a prior version of a resource.  #  Dump out all versions of a resource that has key=value pairs associated
   # with it for each version.  These resources are built up via the store
   # command.
 #  #
 #  Parameters:  #  Parameters:
 #     $cmd               - Command keyword.  #     $cmd               - Command keyword.
Line 1985  RegisterHandler("store", \&StoreHandler, Line 3434  RegisterHandler("store", \&StoreHandler,
 #      1  indicating the caller should not yet exit.  #      1  indicating the caller should not yet exit.
 # Side-effects:  # Side-effects:
 #   Writes a reply to the client.  #   Writes a reply to the client.
 #  #   The reply is a string of the following shape:
 sub RestoreHandler {  #   version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
   my $cmd     = shift;  #    Where the 1 above represents version 1.
   my $tail    = shift;  #    this continues for all pairs of keys in all versions.
   my $client  = shift;  #
   #
   my $userinput = "$cmd:$tail"; # Only used for logging purposes.  #    
   #
   my ($cmd,$udom,$uname,$namespace,$rid) = split(/:/,$userinput);  sub restore_handler {
   $namespace=~s/\//\_/g;      my ($cmd, $tail, $client) = @_;
   $namespace=~s/\W//g;  
   chomp($rid);      my $userinput = "$cmd:$tail"; # Only used for logging purposes.
   my $proname=propath($udom,$uname);      my ($udom,$uname,$namespace,$rid) = split(/:/,$tail);
   my $qresult='';      $namespace=~s/\//\_/g;
   my %hash;      $namespace = &LONCAPA::clean_username($namespace);
   if (tie(%hash,'GDBM_File',"$proname/$namespace.db",  
   &GDBM_READER(),0640)) {      chomp($rid);
     my $version=$hash{"version:$rid"};      my $qresult='';
     $qresult.="version=$version&";      my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER());
     my $scope;      if ($hashref) {
     for ($scope=1;$scope<=$version;$scope++) {   my $version=$hashref->{"version:$rid"};
       my $vkeys=$hash{"$scope:keys:$rid"};   $qresult.="version=$version&";
  my @keys=split(/:/,$vkeys);   my $scope;
       my $key;   for ($scope=1;$scope<=$version;$scope++) {
       $qresult.="$scope:keys=$vkeys&";      my $vkeys=$hashref->{"$scope:keys:$rid"};
       foreach $key (@keys) {      my @keys=split(/:/,$vkeys);
  $qresult.="$scope:$key=".$hash{"$scope:$rid:$key"}."&";      my $key;
       }                                        $qresult.="$scope:keys=$vkeys&";
     }      foreach $key (@keys) {
      if (untie(%hash)) {   $qresult.="$scope:$key=".$hashref->{"$scope:$rid:$key"}."&";
        $qresult=~s/\&$//;      }                                  
        Reply( $client, "$qresult\n", $userinput);   }
      } else {   if (&untie_user_hash($hashref)) {
        Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".      $qresult=~s/\&$//;
        "while attempting restore\n", $userinput);      &Reply( $client, \$qresult, $userinput);
      }   } else {
   } else {      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
     Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".      "while attempting restore\n", $userinput);
     "while attempting restore\n", $userinput);   }
   }      } else {
    &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
    "while attempting restore\n", $userinput);
       }
       
   return 1;      return 1;
   
   
 }  }
 RegisterHandler("restor", \&RestoreHandler, 0,1,0);  &register_handler("restore", \&restore_handler, 0,1,0);
   
 #  #
 #   Add a chat message to to a discussion board.  #   Add a chat message to a synchronous discussion board.
 #  #
 # Parameters:  # Parameters:
 #    $cmd                - Request keyword.  #    $cmd                - Request keyword.
 #    $tail               - Tail of the command. A colon separated list  #    $tail               - Tail of the command. A colon separated list
 #                          containing:  #                          containing:
 #                          cdom    - Domain on which the chat board lives  #                          cdom    - Domain on which the chat board lives
 #                          cnum    - Identifier of the discussion group.  #                          cnum    - Course containing the chat board.
 #                          post    - Body of the posting.  #                          newpost - Body of the posting.
   #                          group   - Optional group, if chat board is only 
   #                                    accessible in a group within the course 
 #   $client              - Socket open on the client.  #   $client              - Socket open on the client.
 # Returns:  # Returns:
 #   1    - Indicating caller should keep on processing.  #   1    - Indicating caller should keep on processing.
Line 2050  RegisterHandler("restor", \&RestoreHandl Line 3504  RegisterHandler("restor", \&RestoreHandl
 #   writes a reply to the client.  #   writes a reply to the client.
 #  #
 #  #
 sub SendChatHandler {  sub send_chat_handler {
   my $cmd     = shift;      my ($cmd, $tail, $client) = @_;
   my $tail    = shift;  
   my $client  = shift;  
   
   my $userinput = "$cmd:$tail";      
       my $userinput = "$cmd:$tail";
   
   my ($cdom,$cnum,$newpost)=split(/\:/,$tail);      my ($cdom,$cnum,$newpost,$group)=split(/\:/,$tail);
   &chatadd($cdom,$cnum,$newpost);      &chat_add($cdom,$cnum,$newpost,$group);
   Reply($client, "ok\n", $userinput);      &Reply($client, "ok\n", $userinput);
   
   return 1;      return 1;
 }  }
 RegisterHandler("chatsend", \&SendChatHandler, 0, 1, 0);  &register_handler("chatsend", \&send_chat_handler, 0, 1, 0);
   
 #  #
 #   Retrieve the set of chat messagss from a discussion board.  #   Retrieve the set of chat messages from a discussion board.
 #  #
 #  Parameters:  #  Parameters:
 #    $cmd             - Command keyword that initiated the request.  #    $cmd             - Command keyword that initiated the request.
Line 2075  RegisterHandler("chatsend", \&SendChatHa Line 3529  RegisterHandler("chatsend", \&SendChatHa
 #                       chat id        - Discussion thread(?)  #                       chat id        - Discussion thread(?)
 #                       domain/user    - Authentication domain and username  #                       domain/user    - Authentication domain and username
 #                                        of the requesting person.  #                                        of the requesting person.
   #                       group          - Optional course group containing
   #                                        the board.      
 #   $client           - Socket open on the client program.  #   $client           - Socket open on the client program.
 # Returns:  # Returns:
 #    1     - continue processing  #    1     - continue processing
 # Side effects:  # Side effects:
 #    Response is written to the client.  #    Response is written to the client.
 #  #
 sub RetrieveChatHandler {  sub retrieve_chat_handler {
   my $cmd      = shift;      my ($cmd, $tail, $client) = @_;
   my $tail     = shift;  
   my $client   = shift;  
   
   my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
   
   my ($cdom,$cnum,$udom,$uname)=split(/\:/,$tail);      my ($cdom,$cnum,$udom,$uname,$group)=split(/\:/,$tail);
   my $reply='';      my $reply='';
   foreach (&getchat($cdom,$cnum,$udom,$uname)) {      foreach (&get_chat($cdom,$cnum,$udom,$uname,$group)) {
     $reply.=&escape($_).':';   $reply.=&escape($_).':';
   }      }
   $reply=~s/\:$//;      $reply=~s/\:$//;
   Reply($client, $reply."\n", $userinput);      &Reply($client, \$reply, $userinput);
   
   
   return 1;      return 1;
 }  }
 RegisterHandler("chatretr", \&RetrieveChatHandler, 0, 1, 0);  &register_handler("chatretr", \&retrieve_chat_handler, 0, 1, 0);
   
 #  #
 #  Initiate a query of an sql database.  SQL query repsonses get put in  #  Initiate a query of an sql database.  SQL query repsonses get put in
 #  a file for later retrieval.  This prevents sql query results from  #  a file for later retrieval.  This prevents sql query results from
Line 2119  RegisterHandler("chatretr", \&RetrieveCh Line 3575  RegisterHandler("chatretr", \&RetrieveCh
 # Side-effects:  # Side-effects:
 #    a reply is written to $client.  #    a reply is written to $client.
 #  #
 sub SendQueryHandler {  sub send_query_handler {
   my $cmd     = shift;      my ($cmd, $tail, $client) = @_;
   my $tail    = shift;  
   my $client  = shift;  
   
   my $userinput = "$cmd:$tail";  
   
   my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);  
   $query=~s/\n*$//g;  
   Reply($client, "". sqlreply("$clientname\&$query".  
       "\&$arg1"."\&$arg2"."\&$arg3")."\n",  
  $userinput);  
   
   return 1;  
       my $userinput = "$cmd:$tail";
   
       my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
       $query=~s/\n*$//g;
       &Reply($client, "". &sql_reply("$clientname\&$query".
    "\&$arg1"."\&$arg2"."\&$arg3")."\n",
     $userinput);
       
       return 1;
 }  }
 RegisterHandler("querysend", \&SendQueryHandler, 0, 1, 0);  &register_handler("querysend", \&send_query_handler, 0, 1, 0);
   
 #  #
 #   Add a reply to an sql query.  SQL queries are done asyncrhonously.  #   Add a reply to an sql query.  SQL queries are done asyncrhonously.
Line 2161  RegisterHandler("querysend", \&SendQuery Line 3616  RegisterHandler("querysend", \&SendQuery
 # Side effects:  # Side effects:
 #    ok written to the client.  #    ok written to the client.
 #  #
 sub ReplyQueryHandler {  sub reply_query_handler {
   my $cmd    = shift;      my ($cmd, $tail, $client) = @_;
   my $tail   = shift;  
   my $client = shift;  
       my $userinput = "$cmd:$tail";
   my $userinput = "$cmd:$tail";  
       my ($id,$reply)=split(/:/,$tail); 
   my ($cmd,$id,$reply)=split(/:/,$userinput);       my $store;
   my $store;      my $execdir=$perlvar{'lonDaemons'};
   my $execdir=$perlvar{'lonDaemons'};      if ($store=IO::File->new(">$execdir/tmp/$id")) {
   if ($store=IO::File->new(">$execdir/tmp/$id")) {   $reply=~s/\&/\n/g;
     $reply=~s/\&/\n/g;   print $store $reply;
          print $store $reply;   close $store;
     close $store;   my $store2=IO::File->new(">$execdir/tmp/$id.end");
     my $store2=IO::File->new(">$execdir/tmp/$id.end");   print $store2 "done\n";
     print $store2 "done\n";   close $store2;
     close $store2;   &Reply($client, "ok\n", $userinput);
     Reply($client, "ok\n", $userinput);      } else {
   }   &Failure($client, "error: ".($!+0)
   else {   ." IO::File->new Failed ".
     Failure($client, "error: ".($!+0)   "while attempting queryreply\n", $userinput);
     ." IO::File->new Failed ".      }
     "while attempting queryreply\n", $userinput);  
   }  
     
   
   return 1;      return 1;
 }  }
 RegisterHandler("queryreply", \&ReplyQueryHandler, 0, 1, 0);  &register_handler("queryreply", \&reply_query_handler, 0, 1, 0);
   
 #  #
 #  Process the courseidput query.  Not quite sure what this means  #  Process the courseidput request.  Not quite sure what this means
 #  at the system level sense.  It appears a gdbm file in the   #  at the system level sense.  It appears a gdbm file in the 
 #  /home/httpd/lonUsers/$domain/nohist_courseids is tied and  #  /home/httpd/lonUsers/$domain/nohist_courseids is tied and
 #  a set of entries made in that database.  #  a set of entries made in that database.
Line 2201  RegisterHandler("queryreply", \&ReplyQue Line 3655  RegisterHandler("queryreply", \&ReplyQue
 #   $tail     - Tail of the command.  In this case consists of a colon  #   $tail     - Tail of the command.  In this case consists of a colon
 #               separated list contaning the domain to apply this to and  #               separated list contaning the domain to apply this to and
 #               an ampersand separated list of keyword=value pairs.  #               an ampersand separated list of keyword=value pairs.
   #               Each value is a colon separated list that includes:  
   #               description, institutional code and course owner.
   #               For backward compatibility with versions included
   #               in LON-CAPA 1.1.X (and earlier) and 1.2.X, institutional
   #               code and/or course owner are preserved from the existing 
   #               record when writing a new record in response to 1.1 or 
   #               1.2 implementations of lonnet::flushcourselogs().   
   #                      
 #   $client   - Socket open on the client.  #   $client   - Socket open on the client.
 # Returns:  # Returns:
 #   1    - indicating that processing should continue  #   1    - indicating that processing should continue
Line 2208  RegisterHandler("queryreply", \&ReplyQue Line 3670  RegisterHandler("queryreply", \&ReplyQue
 # Side effects:  # Side effects:
 #   reply is written to the client.  #   reply is written to the client.
 #  #
 sub PutCourseIdHandler {  sub put_course_id_handler {
   my $cmd    = shift;      my ($cmd, $tail, $client) = @_;
   my $tail   = shift;  
   my $client = shift;  
       my $userinput = "$cmd:$tail";
   my $userinput = "$cmd:$tail";  
       my ($udom, $what) = split(/:/, $tail,2);
   my ($udom,$what)=split(/:/,$tail);      chomp($what);
   chomp($what);      my $now=time;
   $udom=~s/\W//g;      my @pairs=split(/\&/,$what);
   my $proname=  
     "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";      my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
   my $now=time;      if ($hashref) {
   my @pairs=split(/\&/,$what);   foreach my $pair (@pairs) {
   my %hash;              my ($key,$courseinfo) = split(/=/,$pair,2);
   if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {              $courseinfo =~ s/=/:/g;
     foreach my $pair (@pairs) {              if (defined($hashref->{$key})) {
       my ($key,$value)=split(/=/,$pair);                  my $value = &Apache::lonnet::thaw_unescape($hashref->{$key});
       $hash{$key}=$value.':'.$now;                  if (ref($value) eq 'HASH') {
     }                      my @items = ('description','inst_code','owner','type');
     if (untie(%hash)) {                      my @new_items = split(/:/,$courseinfo,-1);
       Reply($client, "ok\n", $userinput);                      my %storehash; 
                       for (my $i=0; $i<@new_items; $i++) {
                           $storehash{$items[$i]} = &unescape($new_items[$i]);
                       }
                       $hashref->{$key} = 
                           &Apache::lonnet::freeze_escape(\%storehash);
                       my $unesc_key = &unescape($key);
                       $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
                       next;
                   }
               }
               my @current_items = split(/:/,$hashref->{$key},-1);
               shift(@current_items); # remove description
               pop(@current_items);   # remove last access
               my $numcurrent = scalar(@current_items);
               if ($numcurrent > 3) {
                   $numcurrent = 3;
               }
               my @new_items = split(/:/,$courseinfo,-1);
               my $numnew = scalar(@new_items);
               if ($numcurrent > 0) {
                   if ($numnew <= $numcurrent) { # flushcourselogs() from pre 2.2 
                       for (my $j=$numcurrent-$numnew; $j>=0; $j--) {
                           $courseinfo .= ':'.$current_items[$numcurrent-$j-1];
                       }
                   }
               }
               $hashref->{$key}=$courseinfo.':'.$now;
    }
    if (&untie_domain_hash($hashref)) {
       &Reply( $client, "ok\n", $userinput);
    } else {
       &Failure($client, "error: ".($!+0)
        ." untie(GDBM) Failed ".
        "while attempting courseidput\n", $userinput);
    }
     } else {      } else {
       Failure( $client, "error: ".($!+0)   &Failure($client, "error: ".($!+0)
        ." untie(GDBM) Failed ".   ." tie(GDBM) Failed ".
        "while attempting courseidput\n", $userinput);   "while attempting courseidput\n", $userinput);
     }      }
   } else {  
     Failure( $client, "error: ".($!+0)  
      ." tie(GDBM) Failed ".  
      "while attempting courseidput\n", $userinput);  
   }  
   
   return 1;      return 1;
   }
   &register_handler("courseidput", \&put_course_id_handler, 0, 1, 0);
   
   sub put_course_id_hash_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($udom,$mode,$what) = split(/:/, $tail,3);
       chomp($what);
       my $now=time;
       my @pairs=split(/\&/,$what);
       my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
       if ($hashref) {
           foreach my $pair (@pairs) {
               my ($key,$value)=split(/=/,$pair);
               my $unesc_key = &unescape($key);
               if ($mode ne 'timeonly') {
                   if (!defined($hashref->{&escape('lasttime:'.$unesc_key)})) {
                       my $curritems = &Apache::lonnet::thaw_unescape($key); 
                       if (ref($curritems) ne 'HASH') {
                           my @current_items = split(/:/,$hashref->{$key},-1);
                           my $lasttime = pop(@current_items);
                           $hashref->{&escape('lasttime:'.$unesc_key)} = $lasttime;
                       } else {
                           $hashref->{&escape('lasttime:'.$unesc_key)} = '';
                       }
                   } 
                   $hashref->{$key} = $value;
               }
               if ($mode ne 'notime') {
                   $hashref->{&escape('lasttime:'.$unesc_key)} = $now;
               }
           }
           if (&untie_domain_hash($hashref)) {
               &Reply($client, "ok\n", $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                        "while attempting courseidputhash\n", $userinput);
           }
       } else {
           &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
                     "while attempting courseidputhash\n", $userinput);
       }
       return 1;
 }  }
 RegisterHandler("courseidput", \&PutCourseIdHandler, 0, 1, 0);  &register_handler("courseidputhash", \&put_course_id_hash_handler, 0, 1, 0);
   
 #  Retrieves the value of a course id resource keyword pattern  #  Retrieves the value of a course id resource keyword pattern
 #  defined since a starting date.  Both the starting date and the  #  defined since a starting date.  Both the starting date and the
Line 2263  RegisterHandler("courseidput", \&PutCour Line 3798  RegisterHandler("courseidput", \&PutCour
 #                 description - regular expression that is used to filter  #                 description - regular expression that is used to filter
 #                            the dump.  Only keywords matching this regexp  #                            the dump.  Only keywords matching this regexp
 #                            will be used.  #                            will be used.
   #                 institutional code - optional supplied code to filter 
   #                            the dump. Only courses with an institutional code 
   #                            that match the supplied code will be returned.
   #                 owner    - optional supplied username and domain of owner to
   #                            filter the dump.  Only courses for which the course
   #                            owner matches the supplied username and/or domain
   #                            will be returned. Pre-2.2.0 legacy entries from 
   #                            nohist_courseiddump will only contain usernames.
   #                 type     - optional parameter for selection 
   #                 regexp_ok - if 1 or -1 allow the supplied institutional code
   #                            filter to behave as a regular expression:
   #                      1 will not exclude the course if the instcode matches the RE 
   #                            -1 will exclude the course if the instcode matches the RE
   #                 rtn_as_hash - whether to return the information available for
   #                            each matched item as a frozen hash of all 
   #                            key, value pairs in the item's hash, or as a 
   #                            colon-separated list of (in order) description,
   #                            institutional code, and course owner.
   #                 selfenrollonly - filter by courses allowing self-enrollment  
   #                                  now or in the future (selfenrollonly = 1).
   #                 catfilter - filter by course category, assigned to a course 
   #                             using manually defined categories (i.e., not
   #                             self-cataloging based on on institutional code).   
   #                 showhidden - include course in results even if course  
   #                              was set to be excluded from course catalog (DC only).
   #                 caller -  if set to 'coursecatalog', courses set to be hidden
   #                           from course catalog will be excluded from results (unless
   #                           overridden by "showhidden".
   #                 cloner - escaped username:domain of course cloner (if picking course to
   #                          clone).
   #                 cc_clone_list - escaped comma separated list of courses for which 
   #                                 course cloner has active CC role (and so can clone
   #                                 automatically).
   #                 cloneonly - filter by courses for which cloner has rights to clone.
   #                 createdbefore - include courses for which creation date preceeded this date.
   #                 createdafter - include courses for which creation date followed this date.
   #                 creationcontext - include courses created in specified context 
   #
   #                 domcloner - flag to indicate if user can create CCs in course's domain.
   #                             If so, ability to clone course is automatic. 
   #
 #     $client  - The socket open on the client.  #     $client  - The socket open on the client.
 # Returns:  # Returns:
 #    1     - Continue processing.  #    1     - Continue processing.
 # Side Effects:  # Side Effects:
 #   a reply is written to $client.  #   a reply is written to $client.
 sub DumpCourseIdHandler {  sub dump_course_id_handler {
   my $cmd    = shift;      my ($cmd, $tail, $client) = @_;
   my $tail   = shift;  
   my $client = shift;      my $res = LONCAPA::Lond::dump_course_id_handler($tail);
       if ($res =~ /^error:/) {
   my $userinput = "$cmd:$tail";          Failure($client, \$res, "$cmd:$tail");
       } else {
   my ($udom,$since,$description) =split(/:/,$tail);          Reply($client, \$res, "$cmd:$tail");
   if (defined($description)) {      }
     $description=&unescape($description);  
   } else {      return 1;  
     $description='.';  
   }      #TODO remove
   unless (defined($since)) { $since=0; }      my $userinput = "$cmd:$tail";
   my $qresult='';  
   my $proname = "$perlvar{'lonUsersDir'}/$udom/nohist_courseids";      my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
   my %hash;          $typefilter,$regexp_ok,$rtn_as_hash,$selfenrollonly,$catfilter,$showhidden,
   if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {          $caller,$cloner,$cc_clone_list,$cloneonly,$createdbefore,$createdafter,
     while (my ($key,$value) = each(%hash)) {          $creationcontext,$domcloner) =split(/:/,$tail);
       my ($descr,$lasttime)=split(/\:/,$value);      my $now = time;
       if ($lasttime<$since) {       my ($cloneruname,$clonerudom,%cc_clone);
  next;       if (defined($description)) {
       }   $description=&unescape($description);
       if ($description eq '.') {      } else {
  $qresult.=$key.'='.$descr.'&';   $description='.';
       } else {      }
  my $unescapeVal = &unescape($descr);      if (defined($instcodefilter)) {
  if (eval('$unescapeVal=~/$description/i')) {          $instcodefilter=&unescape($instcodefilter);
   $qresult.="$key=$descr&";      } else {
           $instcodefilter='.';
       }
       my ($ownerunamefilter,$ownerdomfilter);
       if (defined($ownerfilter)) {
           $ownerfilter=&unescape($ownerfilter);
           if ($ownerfilter ne '.' && defined($ownerfilter)) {
               if ($ownerfilter =~ /^([^:]*):([^:]*)$/) {
                    $ownerunamefilter = $1;
                    $ownerdomfilter = $2;
               } else {
                   $ownerunamefilter = $ownerfilter;
                   $ownerdomfilter = '';
               }
           }
       } else {
           $ownerfilter='.';
       }
   
       if (defined($coursefilter)) {
           $coursefilter=&unescape($coursefilter);
       } else {
           $coursefilter='.';
       }
       if (defined($typefilter)) {
           $typefilter=&unescape($typefilter);
       } else {
           $typefilter='.';
       }
       if (defined($regexp_ok)) {
           $regexp_ok=&unescape($regexp_ok);
       }
       if (defined($catfilter)) {
           $catfilter=&unescape($catfilter);
       }
       if (defined($cloner)) {
           $cloner = &unescape($cloner);
           ($cloneruname,$clonerudom) = ($cloner =~ /^($LONCAPA::match_username):($LONCAPA::match_domain)$/); 
       }
       if (defined($cc_clone_list)) {
           $cc_clone_list = &unescape($cc_clone_list);
           my @cc_cloners = split('&',$cc_clone_list);
           foreach my $cid (@cc_cloners) {
               my ($clonedom,$clonenum) = split(':',$cid);
               next if ($clonedom ne $udom); 
               $cc_clone{$clonedom.'_'.$clonenum} = 1;
           } 
       }
       if ($createdbefore ne '') {
           $createdbefore = &unescape($createdbefore);
       } else {
          $createdbefore = 0;
       }
       if ($createdafter ne '') {
           $createdafter = &unescape($createdafter);
       } else {
           $createdafter = 0;
       }
       if ($creationcontext ne '') {
           $creationcontext = &unescape($creationcontext);
       } else {
           $creationcontext = '.';
       }
       my $unpack = 1;
       if ($description eq '.' && $instcodefilter eq '.' && $ownerfilter eq '.' && 
           $typefilter eq '.') {
           $unpack = 0;
       }
       if (!defined($since)) { $since=0; }
       my $qresult='';
       my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
       if ($hashref) {
    while (my ($key,$value) = each(%$hashref)) {
               my ($unesc_key,$lasttime_key,$lasttime,$is_hash,%val,
                   %unesc_val,$selfenroll_end,$selfenroll_types,$created,
                   $context);
               $unesc_key = &unescape($key);
               if ($unesc_key =~ /^lasttime:/) {
                   next;
               } else {
                   $lasttime_key = &escape('lasttime:'.$unesc_key);
               }
               if ($hashref->{$lasttime_key} ne '') {
                   $lasttime = $hashref->{$lasttime_key};
                   next if ($lasttime<$since);
               }
               my ($canclone,$valchange);
               my $items = &Apache::lonnet::thaw_unescape($value);
               if (ref($items) eq 'HASH') {
                   if ($hashref->{$lasttime_key} eq '') {
                       next if ($since > 1);
                   }
                   $is_hash =  1;
                   if ($domcloner) {
                       $canclone = 1;
                   } elsif (defined($clonerudom)) {
                       if ($items->{'cloners'}) {
                           my @cloneable = split(',',$items->{'cloners'});
                           if (@cloneable) {
                               if (grep(/^\*$/,@cloneable))  {
                                   $canclone = 1;
                               } elsif (grep(/^\*:\Q$clonerudom\E$/,@cloneable)) {
                                   $canclone = 1;
                               } elsif (grep(/^\Q$cloneruname\E:\Q$clonerudom\E$/,@cloneable)) {
                                   $canclone = 1;
                               }
                           }
                           unless ($canclone) {
                               if ($cloneruname ne '' && $clonerudom ne '') {
                                   if ($cc_clone{$unesc_key}) {
                                       $canclone = 1;
                                       $items->{'cloners'} .= ','.$cloneruname.':'.
                                                              $clonerudom;
                                       $valchange = 1;
                                   }
                               }
                           }
                       } elsif (defined($cloneruname)) {
                           if ($cc_clone{$unesc_key}) {
                               $canclone = 1;
                               $items->{'cloners'} = $cloneruname.':'.$clonerudom;
                               $valchange = 1;
                           }
                           unless ($canclone) {
                               if ($items->{'owner'} =~ /:/) {
                                   if ($items->{'owner'} eq $cloner) {
                                       $canclone = 1;
                                   }
                               } elsif ($cloner eq $items->{'owner'}.':'.$udom) {
                                   $canclone = 1;
                               }
                               if ($canclone) {
                                   $items->{'cloners'} = $cloneruname.':'.$clonerudom;
                                   $valchange = 1;
                               }
                           }
                       }
                   }
                   if ($unpack || !$rtn_as_hash) {
                       $unesc_val{'descr'} = $items->{'description'};
                       $unesc_val{'inst_code'} = $items->{'inst_code'};
                       $unesc_val{'owner'} = $items->{'owner'};
                       $unesc_val{'type'} = $items->{'type'};
                       $unesc_val{'cloners'} = $items->{'cloners'};
                       $unesc_val{'created'} = $items->{'created'};
                       $unesc_val{'context'} = $items->{'context'};
                   }
                   $selfenroll_types = $items->{'selfenroll_types'};
                   $selfenroll_end = $items->{'selfenroll_end_date'};
                   $created = $items->{'created'};
                   $context = $items->{'context'};
                   if ($selfenrollonly) {
                       next if (!$selfenroll_types);
                       if (($selfenroll_end > 0) && ($selfenroll_end <= $now)) {
                           next;
                       }
                   }
                   if ($creationcontext ne '.') {
                       next if (($context ne '') && ($context ne $creationcontext));  
                   }
                   if ($createdbefore > 0) {
                       next if (($created eq '') || ($created > $createdbefore));   
                   }
                   if ($createdafter > 0) {
                       next if (($created eq '') || ($created <= $createdafter)); 
                   }
                   if ($catfilter ne '') {
                       next if ($items->{'categories'} eq '');
                       my @categories = split('&',$items->{'categories'}); 
                       next if (@categories == 0);
                       my @subcats = split('&',$catfilter);
                       my $matchcat = 0;
                       foreach my $cat (@categories) {
                           if (grep(/^\Q$cat\E$/,@subcats)) {
                               $matchcat = 1;
                               last;
                           }
                       }
                       next if (!$matchcat);
                   }
                   if ($caller eq 'coursecatalog') {
                       if ($items->{'hidefromcat'} eq 'yes') {
                           next if !$showhidden;
                       }
                   }
               } else {
                   next if ($catfilter ne '');
                   next if ($selfenrollonly);
                   next if ($createdbefore || $createdafter);
                   next if ($creationcontext ne '.');
                   if ((defined($clonerudom)) && (defined($cloneruname)))  {
                       if ($cc_clone{$unesc_key}) {
                           $canclone = 1;
                           $val{'cloners'} = &escape($cloneruname.':'.$clonerudom);
                       }
                   }
                   $is_hash =  0;
                   my @courseitems = split(/:/,$value);
                   $lasttime = pop(@courseitems);
                   if ($hashref->{$lasttime_key} eq '') {
                       next if ($lasttime<$since);
                   }
           ($val{'descr'},$val{'inst_code'},$val{'owner'},$val{'type'}) = @courseitems;
               }
               if ($cloneonly) {
                  next unless ($canclone);
               }
               my $match = 1;
       if ($description ne '.') {
                   if (!$is_hash) {
                       $unesc_val{'descr'} = &unescape($val{'descr'});
                   }
                   if (eval{$unesc_val{'descr'} !~ /\Q$description\E/i}) {
                       $match = 0;
                   }
               }
               if ($instcodefilter ne '.') {
                   if (!$is_hash) {
                       $unesc_val{'inst_code'} = &unescape($val{'inst_code'});
                   }
                   if ($regexp_ok == 1) {
                       if (eval{$unesc_val{'inst_code'} !~ /$instcodefilter/}) {
                           $match = 0;
                       }
                   } elsif ($regexp_ok == -1) {
                       if (eval{$unesc_val{'inst_code'} =~ /$instcodefilter/}) {
                           $match = 0;
                       }
                   } else {
                       if (eval{$unesc_val{'inst_code'} !~ /\Q$instcodefilter\E/i}) {
                           $match = 0;
                       }
                   }
       }
               if ($ownerfilter ne '.') {
                   if (!$is_hash) {
                       $unesc_val{'owner'} = &unescape($val{'owner'});
                   }
                   if (($ownerunamefilter ne '') && ($ownerdomfilter ne '')) {
                       if ($unesc_val{'owner'} =~ /:/) {
                           if (eval{$unesc_val{'owner'} !~ 
                                /\Q$ownerunamefilter\E:\Q$ownerdomfilter\E$/i}) {
                               $match = 0;
                           } 
                       } else {
                           if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
                               $match = 0;
                           }
                       }
                   } elsif ($ownerunamefilter ne '') {
                       if ($unesc_val{'owner'} =~ /:/) {
                           if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E:[^:]+$/i}) {
                                $match = 0;
                           }
                       } else {
                           if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
                               $match = 0;
                           }
                       }
                   } elsif ($ownerdomfilter ne '') {
                       if ($unesc_val{'owner'} =~ /:/) {
                           if (eval{$unesc_val{'owner'} !~ /^[^:]+:\Q$ownerdomfilter\E/}) {
                                $match = 0;
                           }
                       } else {
                           if ($ownerdomfilter ne $udom) {
                               $match = 0;
                           }
                       }
                   }
               }
               if ($coursefilter ne '.') {
                   if (eval{$unesc_key !~ /^$udom(_)\Q$coursefilter\E$/}) {
                       $match = 0;
                   }
               }
               if ($typefilter ne '.') {
                   if (!$is_hash) {
                       $unesc_val{'type'} = &unescape($val{'type'});
                   }
                   if ($unesc_val{'type'} eq '') {
                       if ($typefilter ne 'Course') {
                           $match = 0;
                       }
                   } else {
                       if (eval{$unesc_val{'type'} !~ /^\Q$typefilter\E$/}) {
                           $match = 0;
                       }
                   }
               }
               if ($match == 1) {
                   if ($rtn_as_hash) {
                       if ($is_hash) {
                           if ($valchange) {
                               my $newvalue = &Apache::lonnet::freeze_escape($items);
                               $qresult.=$key.'='.$newvalue.'&';
                           } else {
                               $qresult.=$key.'='.$value.'&';
                           }
                       } else {
                           my %rtnhash = ( 'description' => &unescape($val{'descr'}),
                                           'inst_code' => &unescape($val{'inst_code'}),
                                           'owner'     => &unescape($val{'owner'}),
                                           'type'      => &unescape($val{'type'}),
                                           'cloners'   => &unescape($val{'cloners'}),
                                         );
                           my $items = &Apache::lonnet::freeze_escape(\%rtnhash);
                           $qresult.=$key.'='.$items.'&';
                       }
                   } else {
                       if ($is_hash) {
                           $qresult .= $key.'='.&escape($unesc_val{'descr'}).':'.
                                       &escape($unesc_val{'inst_code'}).':'.
                                       &escape($unesc_val{'owner'}).'&';
                       } else {
                           $qresult .= $key.'='.$val{'descr'}.':'.$val{'inst_code'}.
                                       ':'.$val{'owner'}.'&';
                       }
                   }
               }
  }   }
       }   if (&untie_domain_hash($hashref)) {
       chop($qresult);
       &Reply($client, \$qresult, $userinput);
    } else {
       &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
       "while attempting courseiddump\n", $userinput);
    }
       } else {
    &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
    "while attempting courseiddump\n", $userinput);
       }
       return 1;
   }
   &register_handler("courseiddump", \&dump_course_id_handler, 0, 1, 0);
   
   sub course_lastaccess_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($cdom,$cnum) = split(':',$tail); 
       my (%lastaccess,$qresult);
       my $hashref = &tie_domain_hash($cdom, "nohist_courseids", &GDBM_WRCREAT());
       if ($hashref) {
           while (my ($key,$value) = each(%$hashref)) {
               my ($unesc_key,$lasttime);
               $unesc_key = &unescape($key);
               if ($cnum) {
                   next unless ($unesc_key =~ /\Q$cdom\E_\Q$cnum\E$/);
               }
               if ($unesc_key =~ /^lasttime:($LONCAPA::match_domain\_$LONCAPA::match_courseid)/) {
                   $lastaccess{$1} = $value;
               } else {
                   my $items = &Apache::lonnet::thaw_unescape($value);
                   if (ref($items) eq 'HASH') {
                       unless ($lastaccess{$unesc_key}) {
                           $lastaccess{$unesc_key} = '';
                       }
                   } else {
                       my @courseitems = split(':',$value);
                       $lastaccess{$unesc_key} = pop(@courseitems);
                   }
               }
           }
           foreach my $cid (sort(keys(%lastaccess))) {
               $qresult.=&escape($cid).'='.$lastaccess{$cid}.'&'; 
           }
           if (&untie_domain_hash($hashref)) {
               if ($qresult) {
                   chop($qresult);
               }
               &Reply($client, \$qresult, $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                       "while attempting lastacourseaccess\n", $userinput);
           }
       } else {
           &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
                   "while attempting lastcourseaccess\n", $userinput);
     }      }
     if (untie(%hash)) {      return 1;
       chop($qresult);  }
       Reply($client, "$qresult\n", $userinput);  &register_handler("courselastaccess",\&course_lastaccess_handler, 0, 1, 0);
   
   #
   # Puts an unencrypted entry in a namespace db file at the domain level 
   #
   # Parameters:
   #    $cmd      - The command that got us here.
   #    $tail     - Tail of the command (remaining parameters).
   #    $client   - File descriptor connected to client.
   # Returns
   #     0        - Requested to exit, caller should shut down.
   #     1        - Continue processing.
   #  Side effects:
   #     reply is written to $client.
   #
   sub put_domain_handler {
       my ($cmd,$tail,$client) = @_;
   
       my $userinput = "$cmd:$tail";
   
       my ($udom,$namespace,$what) =split(/:/,$tail,3);
       chomp($what);
       my @pairs=split(/\&/,$what);
       my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_WRCREAT(),
                                      "P", $what);
       if ($hashref) {
           foreach my $pair (@pairs) {
               my ($key,$value)=split(/=/,$pair);
               $hashref->{$key}=$value;
           }
           if (&untie_domain_hash($hashref)) {
               &Reply($client, "ok\n", $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                        "while attempting putdom\n", $userinput);
           }
     } else {      } else {
       Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".          &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
       "while attempting courseiddump\n", $userinput);                    "while attempting putdom\n", $userinput);
     }      }
   } else {  
     Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".  
     "while attempting courseiddump\n", $userinput);  
   }  
   
       return 1;
   }
   &register_handler("putdom", \&put_domain_handler, 0, 1, 0);
   
   return 1;  # Unencrypted get from the namespace database file at the domain level.
   # This function retrieves a keyed item from a specific named database in the
   # domain directory.
   #
   # Parameters:
   #   $cmd             - Command request keyword (get).
   #   $tail            - Tail of the command.  This is a colon separated list
   #                      consisting of the domain and the 'namespace' 
   #                      which selects the gdbm file to do the lookup in,
   #                      & separated list of keys to lookup.  Note that
   #                      the values are returned as an & separated list too.
   #   $client          - File descriptor open on the client.
   # Returns:
   #   1       - Continue processing.
   #   0       - Exit.
   #  Side effects:
   #     reply is written to $client.
   #
   
   sub get_domain_handler {
       my ($cmd, $tail, $client) = @_;
   
   
       my $userinput = "$client:$tail";
   
       my ($udom,$namespace,$what)=split(/:/,$tail,3);
       chomp($what);
       my @queries=split(/\&/,$what);
       my $qresult='';
       my $hashref = &tie_domain_hash($udom, "$namespace", &GDBM_READER());
       if ($hashref) {
           for (my $i=0;$i<=$#queries;$i++) {
               $qresult.="$hashref->{$queries[$i]}&";
           }
           if (&untie_domain_hash($hashref)) {
               $qresult=~s/\&$//;
               &Reply($client, \$qresult, $userinput);
           } else {
               &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
                         "while attempting getdom\n",$userinput);
           }
       } else {
           &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
                    "while attempting getdom\n",$userinput);
       }
   
       return 1;
 }  }
 RegisterHandler("courseiddump", \&DumpCourseIdHandler, 0, 1, 0);  &register_handler("getdom", \&get_domain_handler, 0, 1, 0);
   
 #  #
 #  Puts an id to a domains id database.   #  Puts an id to a domains id database. 
 #  #
Line 2332  RegisterHandler("courseiddump", \&DumpCo Line 4364  RegisterHandler("courseiddump", \&DumpCo
 #  Side effects:  #  Side effects:
 #     reply is written to $client.  #     reply is written to $client.
 #  #
 sub PutIdHandler {  sub put_id_handler {
   my $cmd    = shift;      my ($cmd,$tail,$client) = @_;
   my $tail   = shift;  
   my $client = shift;  
       my $userinput = "$cmd:$tail";
   my $userinput = "$cmd:$tail";  
       my ($udom,$what)=split(/:/,$tail);
   my ($udom,$what)=split(/:/,$tail);      chomp($what);
   chomp($what);      my @pairs=split(/\&/,$what);
   $udom=~s/\W//g;      my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
   my $proname="$perlvar{'lonUsersDir'}/$udom/ids";     "P", $what);
   my $now=time;      if ($hashref) {
   {   foreach my $pair (@pairs) {
     my $hfh;      my ($key,$value)=split(/=/,$pair);
     if ($hfh=IO::File->new(">>$proname.hist")) {       $hashref->{$key}=$value;
       print $hfh "P:$now:$what\n";    }
     }   if (&untie_domain_hash($hashref)) {
   }      &Reply($client, "ok\n", $userinput);
   my @pairs=split(/\&/,$what);   } else {
   my %hash;      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
   if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_WRCREAT(),0640)) {       "while attempting idput\n", $userinput);
     foreach my $pair (@pairs) {   }
       my ($key,$value)=split(/=/,$pair);  
       $hash{$key}=$value;  
     }  
     if (untie(%hash)) {  
       Reply($client, "ok\n", $userinput);  
     } else {      } else {
       Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
       "while attempting idput\n", $userinput);    "while attempting idput\n", $userinput);
     }      }
   } else {  
     Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".  
      "while attempting idput\n", $userinput);  
   }  
   
   return 1;      return 1;
 }  }
   &register_handler("idput", \&put_id_handler, 0, 1, 0);
   
 RegisterHandler("idput", \&PutIdHandler, 0, 1, 0);  
 #  #
 #  Retrieves a set of id values from the id database.  #  Retrieves a set of id values from the id database.
 #  Returns an & separated list of results, one for each requested id to the  #  Returns an & separated list of results, one for each requested id to the
Line 2391  RegisterHandler("idput", \&PutIdHandler, Line 4414  RegisterHandler("idput", \&PutIdHandler,
 # Side effects:  # Side effects:
 #   An & separated list of results is written to $client.  #   An & separated list of results is written to $client.
 #  #
 sub GetIdHandler {  sub get_id_handler {
   my $cmd    = shift;      my ($cmd, $tail, $client) = @_;
   my $tail   = shift;  
   my $client = shift;  
   
   my $userinput = "$client:$tail";  
   
   my ($udom,$what)=split(/:/,$tail);  
   chomp($what);  
   $udom=~s/\W//g;  
   my $proname="$perlvar{'lonUsersDir'}/$udom/ids";  
   my @queries=split(/\&/,$what);  
   my $qresult='';  
   my %hash;  
   if (tie(%hash,'GDBM_File',"$proname.db",&GDBM_READER(),0640)) {  
     for (my $i=0;$i<=$#queries;$i++) {  
       $qresult.="$hash{$queries[$i]}&";  
     }  
     if (untie(%hash)) {  
       $qresult=~s/\&$//;  
       Reply($client, "$qresult\n", $userinput);  
     } else {  
       Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".  
        "while attempting idget\n",$userinput);  
     }  
   } else {  
     Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".  
                         "while attempting idget\n",$userinput);  
   }  
   
   return 1;  
 }  
 RegisterHandler("idget", \&GetIdHandler, 0, 1, 0);  
 #------------------------------------------------------------------------------------  
 #  
 #   Process a Request.  Takes a request from the client validates  
 #   it and performs the operation requested by it.  Returns  
 #   a response to the client.  
 #  
 #  Parameters:  
 #      request      - A string containing the user's request.  
 #  Returns:  
 #      0            - Requested to exit, caller should shut down.  
 #      1            - Accept additional requests from the client.  
 #  
 sub ProcessRequest {  
    my $Request      = shift;  
    my $KeepGoing    = 1; # Assume we're not asked to stop.  
       
    my $wasenc=0;  
    my $userinput = $Request;   # for compatibility with oldcode <yeach>  
   
       
       my $userinput = "$client:$tail";
       
       my ($udom,$what)=split(/:/,$tail);
       chomp($what);
       my @queries=split(/\&/,$what);
       my $qresult='';
       my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
       if ($hashref) {
    for (my $i=0;$i<=$#queries;$i++) {
       $qresult.="$hashref->{$queries[$i]}&";
    }
    if (&untie_domain_hash($hashref)) {
       $qresult=~s/\&$//;
       &Reply($client, \$qresult, $userinput);
    } else {
       &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
         "while attempting idget\n",$userinput);
    }
       } else {
    &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
    "while attempting idget\n",$userinput);
       }
       
       return 1;
   }
   &register_handler("idget", \&get_id_handler, 0, 1, 0);
   
 # ------------------------------------------------------------ See if encrypted  #   Deletes one or more ids in a domain's id database.
      #
    if($userinput =~ /^enc/) {  #   Parameters:
       $wasenc = 1;  #       $cmd                  - Command keyword (iddel).
       $userinput = Decipher($userinput);  #       $tail                 - Command tail.  In this case a colon
       if(! $userinput) {  #                               separated list containing:
          Failure($client,"error:Encrypted data without negotiating key");  #                               The domain for which we are deleting the id(s).
          return 0;                      # Break off with this imposter.  #                               &-separated list of id(s) to delete.
       }  #       $client               - File open on client socket.
    }  # Returns:
    # Split off the request keyword from the rest of the stuff.  #     1   - Continue processing
      #     0   - Exit server.
    my ($command, $tail) = split(/:/, $userinput, 2);  #     
   #
   
    Debug("Command received: $command, encoded = $wasenc");  sub del_id_handler {
       my ($cmd,$tail,$client) = @_;
   
          my $userinput = "$cmd:$tail";
 # ------------------------------------------------------------- Normal commands  
   
    #       my ($udom,$what)=split(/:/,$tail);
    #   If the command is in the hash, then execute it via the hash dispatch:      chomp($what);
    #      my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
    if(defined $Dispatcher{$command}) {                                     "D", $what);
       if ($hashref) {
       my $DispatchInfo = $Dispatcher{$command};          my @keys=split(/\&/,$what);
       my $Handler      = $$DispatchInfo[0];          foreach my $key (@keys) {
       my $NeedEncode   = $$DispatchInfo[1];              delete($hashref->{$key});
       my $ClientTypes  = $$DispatchInfo[2];          }
       Debug("Matched dispatch hash: mustencode: $NeedEncode ClientType $ClientTypes");          if (&untie_user_hash($hashref)) {
                     &Reply($client, "ok\n", $userinput);
       #  Validate the request:          } else {
                     &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
       my $ok = 1;                      "while attempting iddel\n", $userinput);
       my $requesterprivs = 0;          }
       if(isClient()) {      } else {
  $requesterprivs |= $CLIENT_OK;          &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
       }                   "while attempting iddel\n", $userinput);
       if(isManager()) {      }
  $requesterprivs |= $MANAGER_OK;      return 1;
       }  }
       if($NeedEncode && (!$wasenc)) {  &register_handler("iddel", \&del_id_handler, 0, 1, 0);
  Debug("Must encode but wasn't: $NeedEncode $wasenc");  
          $ok = 0;  
       }  
       if(($ClientTypes & $requesterprivs) == 0) {  
  Debug("Client not privileged to do this operation");  
  $ok = 0;  
       }  
   
       if($ok) {  #
  Debug("Dispatching to handler $command $tail");  # Puts broadcast e-mail sent by Domain Coordinator in nohist_dcmail database 
          $KeepGoing = &$Handler($command, $tail, $client);  #
       } else {  # Parameters
  Debug("Refusing to dispatch because ok is false");  #   $cmd       - Command keyword that caused us to be dispatched.
  Failure($client, "refused", $userinput);  #   $tail      - Tail of the command.  Consists of a colon separated:
       }  #               domain - the domain whose dcmail we are recording
   #               email    Consists of key=value pair 
   #                        where key is unique msgid
   #                        and value is message (in XML)
   #   $client    - Socket open on the client.
   #
   # Returns:
   #    1 - indicating processing should continue.
   # Side effects
   #     reply is written to $client.
   #
   sub put_dcmail_handler {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
   
   
       my ($udom,$what)=split(/:/,$tail);
       chomp($what);
       my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
       if ($hashref) {
           my ($key,$value)=split(/=/,$what);
           $hashref->{$key}=$value;
       }
       if (&untie_domain_hash($hashref)) {
           &Reply($client, "ok\n", $userinput);
       } else {
           &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                    "while attempting dcmailput\n", $userinput);
       }
       return 1;
   }
   &register_handler("dcmailput", \&put_dcmail_handler, 0, 1, 0);
   
   #
   # Retrieves broadcast e-mail from nohist_dcmail database
   # Returns to client an & separated list of key=value pairs,
   # where key is msgid and value is message information.
   #
   # Parameters
   #   $cmd       - Command keyword that caused us to be dispatched.
   #   $tail      - Tail of the command.  Consists of a colon separated:
   #               domain - the domain whose dcmail table we dump
   #               startfilter - beginning of time window 
   #               endfilter - end of time window
   #               sendersfilter - & separated list of username:domain 
   #                 for senders to search for.
   #   $client    - Socket open on the client.
   #
   # Returns:
   #    1 - indicating processing should continue.
   # Side effects
   #     reply (& separated list of msgid=messageinfo pairs) is 
   #     written to $client.
   #
   sub dump_dcmail_handler {
       my ($cmd, $tail, $client) = @_;
                                                                                   
       my $userinput = "$cmd:$tail";
       my ($udom,$startfilter,$endfilter,$sendersfilter) = split(/:/,$tail);
       chomp($sendersfilter);
       my @senders = ();
       if (defined($startfilter)) {
           $startfilter=&unescape($startfilter);
       } else {
           $startfilter='.';
       }
       if (defined($endfilter)) {
           $endfilter=&unescape($endfilter);
       } else {
           $endfilter='.';
       }
       if (defined($sendersfilter)) {
           $sendersfilter=&unescape($sendersfilter);
    @senders = map { &unescape($_) } split(/\&/,$sendersfilter);
       }
   
       my $qresult='';
       my $hashref = &tie_domain_hash($udom, "nohist_dcmail", &GDBM_WRCREAT());
       if ($hashref) {
           while (my ($key,$value) = each(%$hashref)) {
               my $match = 1;
               my ($timestamp,$subj,$uname,$udom) = 
    split(/:/,&unescape(&unescape($key)),5); # yes, twice really
               $subj = &unescape($subj);
               unless ($startfilter eq '.' || !defined($startfilter)) {
                   if ($timestamp < $startfilter) {
                       $match = 0;
                   }
               }
               unless ($endfilter eq '.' || !defined($endfilter)) {
                   if ($timestamp > $endfilter) {
                       $match = 0;
                   }
               }
               unless (@senders < 1) {
                   unless (grep/^$uname:$udom$/,@senders) {
                       $match = 0;
                   }
               }
               if ($match == 1) {
                   $qresult.=$key.'='.$value.'&';
               }
           }
           if (&untie_domain_hash($hashref)) {
               chop($qresult);
               &Reply($client, \$qresult, $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                       "while attempting dcmaildump\n", $userinput);
           }
       } else {
           &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
                   "while attempting dcmaildump\n", $userinput);
       }
       return 1;
   }
   
   &register_handler("dcmaildump", \&dump_dcmail_handler, 0, 1, 0);
   
 # ---------------------------------------------------------------------- tmpput  #
    } elsif ($userinput =~ /^tmpput/) {  # Puts domain roles in nohist_domainroles database
       if(isClient) {  #
          my ($cmd,$what)=split(/:/,$userinput);  # Parameters
          my $store;  #   $cmd       - Command keyword that caused us to be dispatched.
          $tmpsnum++;  #   $tail      - Tail of the command.  Consists of a colon separated:
          my $id=$$.'_'.$clientip.'_'.$tmpsnum;  #               domain - the domain whose roles we are recording  
          $id=~s/\W/\_/g;  #               role -   Consists of key=value pair
          $what=~s/\n//g;  #                        where key is unique role
          my $execdir=$perlvar{'lonDaemons'};  #                        and value is start/end date information
          if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {  #   $client    - Socket open on the client.
             print $store $what;  #
             close $store;  # Returns:
             Reply($client, "$id\n", $userinput);  #    1 - indicating processing should continue.
          }  # Side effects
          else {  #     reply is written to $client.
             Failure( $client, "error: ".($!+0)."IO::File->new Failed ".  #
                            "while attempting tmpput\n", $userinput);  
          }  
       } else {  
          Failure($client, "refused\n", $userinput);  
       
       }  
   
 # ---------------------------------------------------------------------- tmpget  
    } elsif ($userinput =~ /^tmpget/) {  
       if(isClient) {  
          my ($cmd,$id)=split(/:/,$userinput);  
          chomp($id);  
          $id=~s/\W/\_/g;  
          my $store;  
          my $execdir=$perlvar{'lonDaemons'};  
          if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {  
             my $reply=<$store>;  
             Reply( $client, "$reply\n", $userinput);  
             close $store;  
          }  
          else {  
             Failure( $client, "error: ".($!+0)."IO::File->new Failed ".  
                                "while attempting tmpget\n", $userinput);  
          }  
       } else {  
          Failure($client, "refused\n", $userinput);  
       
       }  
 # ---------------------------------------------------------------------- tmpdel  
    } elsif ($userinput =~ /^tmpdel/) {  
       if(isClient) {  
          my ($cmd,$id)=split(/:/,$userinput);  
          chomp($id);  
          $id=~s/\W/\_/g;  
          my $execdir=$perlvar{'lonDaemons'};  
          if (unlink("$execdir/tmp/$id.tmp")) {  
             Reply($client, "ok\n", $userinput);  
          } else {  
             Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".  
                                  "while attempting tmpdel\n", $userinput);  
          }  
       } else {  
          Failure($client, "refused\n", $userinput);  
       }  
 # -------------------------------------------------------------------------- ls  
    } elsif ($userinput =~ /^ls/) {  
       if(isClient) {  
          my ($cmd,$ulsdir)=split(/:/,$userinput);  
          my $ulsout='';  
          my $ulsfn;  
          if (-e $ulsdir) {  
             if(-d $ulsdir) {  
                if (opendir(LSDIR,$ulsdir)) {  
                   while ($ulsfn=readdir(LSDIR)) {  
                      my @ulsstats=stat($ulsdir.'/'.$ulsfn);  
                      $ulsout.=$ulsfn.'&'.  
                      join('&',@ulsstats).':';  
                   }  
                   closedir(LSDIR);  
                }  
             } else {  
                my @ulsstats=stat($ulsdir);  
                $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';  
             }  
          } else {  
             $ulsout='no_such_dir';  
          }  
          if ($ulsout eq '') { $ulsout='empty'; }  
          Reply($client, "$ulsout\n", $userinput);  
       } else {  
          Failure($client, "refused\n", $userinput);  
       
       }  
 # ----------------------------------------------------------------- setannounce  
    } elsif ($userinput =~ /^setannounce/) {  
       if (isClient) {  
          my ($cmd,$announcement)=split(/:/,$userinput);  
          chomp($announcement);  
          $announcement=&unescape($announcement);  
          if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.  
                                              '/announcement.txt')) {  
             print $store $announcement;  
             close $store;  
             Reply($client, "ok\n", $userinput);  
          } else {  
             Failure($client, "error: ".($!+0)."\n", $userinput);  
          }  
       } else {  
          Failure($client, "refused\n", $userinput);  
       
       }  
 # ------------------------------------------------------------------ Hanging up  
    } elsif (($userinput =~ /^exit/) ||  
          ($userinput =~ /^init/)) { # no restrictions.  
       &logthis("Client $clientip ($clientname) hanging up: $userinput");  
       Reply($client, "bye\n", $userinput);  
       $client->shutdown(2);        # shutdown the socket forcibly.  
       $client->close();  
       $KeepGoing = 0; # Flag to exit the program.  
   
 # ---------------------------------- set current host/domain  
    } elsif ($userinput =~ /^sethost:/) {  
       if (isClient) {  
          Reply($client, &sethost($userinput)."\n", $userinput);  
       } else {  
          Failure($client, "refused\n", $userinput);  
       }  
 #---------------------------------- request file (?) version.  
     } elsif ($userinput =~/^version:/) {  
  if (isClient) {  
     Reply($client, &version($userinput)."\n", $userinput);  
  } else {  
     Reply( $client, "refused\n", $userinput);  
  }  
 # ------------------------------------------------------------- unknown command  
   
    } else {  sub put_domainroles_handler {
  # unknown command      my ($cmd,$tail,$client) = @_;
       Failure($client, "unknown_cmd\n", $userinput);  
    }  
   
     return $KeepGoing;      my $userinput = "$cmd:$tail";
       my ($udom,$what)=split(/:/,$tail);
       chomp($what);
       my @pairs=split(/\&/,$what);
       my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
       if ($hashref) {
           foreach my $pair (@pairs) {
               my ($key,$value)=split(/=/,$pair);
               $hashref->{$key}=$value;
           }
           if (&untie_domain_hash($hashref)) {
               &Reply($client, "ok\n", $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                        "while attempting domroleput\n", $userinput);
           }
       } else {
           &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
                     "while attempting domroleput\n", $userinput);
       }
                                                                                     
       return 1;
 }  }
   
   &register_handler("domroleput", \&put_domainroles_handler, 0, 1, 0);
   
 #  #
 #   GetCertificate: Given a transaction that requires a certificate,  # Retrieves domain roles from nohist_domainroles database
 #   this function will extract the certificate from the transaction  # Returns to client an & separated list of key=value pairs,
 #   request.  Note that at this point, the only concept of a certificate  # where key is role and value is start and end date information.
 #   is the hostname to which we are connected.  
 #  #
 #   Parameter:  # Parameters
 #      request   - The request sent by our client (this parameterization may  #   $cmd       - Command keyword that caused us to be dispatched.
 #                  need to change when we really use a certificate granting  #   $tail      - Tail of the command.  Consists of a colon separated:
 #                  authority.  #               domain - the domain whose domain roles table we dump
   #   $client    - Socket open on the client.
 #  #
 sub GetCertificate {  # Returns:
     my $request = shift;  #    1 - indicating processing should continue.
   # Side effects
     return $clientip;  #     reply (& separated list of role=start/end info pairs) is
   #     written to $client.
   #
   sub dump_domainroles_handler {
       my ($cmd, $tail, $client) = @_;
                                                                                              
       my $userinput = "$cmd:$tail";
       my ($udom,$startfilter,$endfilter,$rolesfilter) = split(/:/,$tail);
       chomp($rolesfilter);
       my @roles = ();
       if (defined($startfilter)) {
           $startfilter=&unescape($startfilter);
       } else {
           $startfilter='.';
       }
       if (defined($endfilter)) {
           $endfilter=&unescape($endfilter);
       } else {
           $endfilter='.';
       }
       if (defined($rolesfilter)) {
           $rolesfilter=&unescape($rolesfilter);
    @roles = split(/\&/,$rolesfilter);
       }
   
       my $hashref = &tie_domain_hash($udom, "nohist_domainroles", &GDBM_WRCREAT());
       if ($hashref) {
           my $qresult = '';
           while (my ($key,$value) = each(%$hashref)) {
               my $match = 1;
               my ($end,$start) = split(/:/,&unescape($value));
               my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,&unescape($key));
               unless (@roles < 1) {
                   unless (grep/^\Q$trole\E$/,@roles) {
                       $match = 0;
                       next;
                   }
               }
               unless ($startfilter eq '.' || !defined($startfilter)) {
                   if ((defined($start)) && ($start >= $startfilter)) {
                       $match = 0;
                       next;
                   }
               }
               unless ($endfilter eq '.' || !defined($endfilter)) {
                   if ((defined($end)) && (($end > 0) && ($end <= $endfilter))) {
                       $match = 0;
                       next;
                   }
               }
               if ($match == 1) {
                   $qresult.=$key.'='.$value.'&';
               }
           }
           if (&untie_domain_hash($hashref)) {
               chop($qresult);
               &Reply($client, \$qresult, $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                       "while attempting domrolesdump\n", $userinput);
           }
       } else {
           &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
                   "while attempting domrolesdump\n", $userinput);
       }
       return 1;
 }  }
   
   &register_handler("domrolesdump", \&dump_domainroles_handler, 0, 1, 0);
   
   
   #  Process the tmpput command I'm not sure what this does.. Seems to
   #  create a file in the lonDaemons/tmp directory of the form $id.tmp
   # where Id is the client's ip concatenated with a sequence number.
   # The file will contain some value that is passed in.  Is this e.g.
   # a login token?
 #  #
 #   ReadManagerTable: Reads in the current manager table. For now this is  # Parameters:
 #                     done on each manager authentication because:  #    $cmd     - The command that got us dispatched.
 #                     - These authentications are not frequent  #    $tail    - The remainder of the request following $cmd:
 #                     - This allows dynamic changes to the manager table  #               In this case this will be the contents of the file.
 #                       without the need to signal to the lond.  #    $client  - Socket connected to the client.
 #  # Returns:
   #    1 indicating processing can continue.
   # Side effects:
   #   A file is created in the local filesystem.
   #   A reply is sent to the client.
   sub tmp_put_handler {
       my ($cmd, $what, $client) = @_;
   
       my $userinput = "$cmd:$what"; # Reconstruct for logging.
   
       my ($record,$context) = split(/:/,$what);
       if ($context ne '') {
           chomp($context);
           $context = &unescape($context);
       }
       my ($id,$store);
       $tmpsnum++;
       if (($context eq 'resetpw') || ($context eq 'createaccount')) {
           $id = &md5_hex(&md5_hex(time.{}.rand().$$));
       } else {
           $id = $$.'_'.$clientip.'_'.$tmpsnum;
       }
       $id=~s/\W/\_/g;
       $record=~s/\n//g;
       my $execdir=$perlvar{'lonDaemons'};
       if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {
    print $store $record;
    close $store;
    &Reply($client, \$id, $userinput);
       } else {
    &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
     "while attempting tmpput\n", $userinput);
       }
       return 1;
     
   }
   &register_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
   
 sub ReadManagerTable {  #   Processes the tmpget command.  This command returns the contents
   #  of a temporary resource file(?) created via tmpput.
   #
   # Paramters:
   #    $cmd      - Command that got us dispatched.
   #    $id       - Tail of the command, contain the id of the resource
   #                we want to fetch.
   #    $client   - socket open on the client.
   # Return:
   #    1         - Inidcating processing can continue.
   # Side effects:
   #   A reply is sent to the client.
   #
   sub tmp_get_handler {
       my ($cmd, $id, $client) = @_;
   
     #   Clean out the old table first..      my $userinput = "$cmd:$id"; 
       
   
    foreach my $key (keys %managers) {      $id=~s/\W/\_/g;
       delete $managers{$key};      my $store;
    }      my $execdir=$perlvar{'lonDaemons'};
       if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
    my $reply=<$store>;
    &Reply( $client, \$reply, $userinput);
    close $store;
       } else {
    &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
     "while attempting tmpget\n", $userinput);
       }
   
    my $tablename = $perlvar{'lonTabDir'}."/managers.tab";      return 1;
    if (!open (MANAGERS, $tablename)) {  
       logthis('<font color="red">No manager table.  Nobody can manage!!</font>');  
       return;  
    }  
    while(my $host = <MANAGERS>) {  
       chomp($host);  
       if ($host =~ "^#") {                  # Comment line.  
          logthis('<font color="green"> Skipping line: '. "$host</font>\n");  
          next;  
       }  
       if (!defined $hostip{$host}) { # This is a non cluster member  
     #  The entry is of the form:  
     #    cluname:hostname  
     #  cluname - A 'cluster hostname' is needed in order to negotiate  
     #            the host key.  
     #  hostname- The dns name of the host.  
     #  
           my($cluname, $dnsname) = split(/:/, $host);  
             
           my $ip = gethostbyname($dnsname);  
           if(defined($ip)) {                 # bad names don't deserve entry.  
             my $hostip = inet_ntoa($ip);  
             $managers{$hostip} = $cluname;  
             logthis('<font color="green"> registering manager '.  
                     "$dnsname as $cluname with $hostip </font>\n");  
          }  
       } else {  
          logthis('<font color="green"> existing host'." $host</font>\n");  
          $managers{$hostip{$host}} = $host;  # Use info from cluster tab if clumemeber  
       }  
    }  
 }  }
   &register_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
   
 #  #
 #  ValidManager: Determines if a given certificate represents a valid manager.  #  Process the tmpdel command.  This command deletes a temp resource
 #                in this primitive implementation, the 'certificate' is  #  created by the tmpput command.
 #                just the connecting loncapa client name.  This is checked  
 #                against a valid client list in the configuration.  
 #  #
 #                    # Parameters:
 sub ValidManager {  #   $cmd      - Command that got us here.
     my $certificate = shift;   #   $id       - Id of the temporary resource created.
   #   $client   - socket open on the client process.
   #
   # Returns:
   #   1     - Indicating processing should continue.
   # Side Effects:
   #   A file is deleted
   #   A reply is sent to the client.
   sub tmp_del_handler {
       my ($cmd, $id, $client) = @_;
       
       my $userinput= "$cmd:$id";
       
       chomp($id);
       $id=~s/\W/\_/g;
       my $execdir=$perlvar{'lonDaemons'};
       if (unlink("$execdir/tmp/$id.tmp")) {
    &Reply($client, "ok\n", $userinput);
       } else {
    &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
     "while attempting tmpdel\n", $userinput);
       }
       
       return 1;
   
     return isManager;  
 }  }
   &register_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
   
   #
   #   Processes the setannounce command.  This command
   #   creates a file named announce.txt in the top directory of
   #   the documentn root and sets its contents.  The announce.txt file is
   #   printed in its entirety at the LonCAPA login page.  Note:
   #   once the announcement.txt fileis created it cannot be deleted.
   #   However, setting the contents of the file to empty removes the
   #   announcement from the login page of loncapa so who cares.
 #  #
 #  CopyFile:  Called as part of the process of installing a   
 #             new configuration file.  This function copies an existing  
 #             file to a backup file.  
 # Parameters:  # Parameters:
 #     oldfile  - Name of the file to backup.  #    $cmd          - The command that got us dispatched.
 #     newfile  - Name of the backup file.  #    $announcement - The text of the announcement.
 # Return:  #    $client       - Socket open on the client process.
 #     0   - Failure (errno has failure reason).  # Retunrns:
 #     1   - Success.  #   1             - Indicating request processing should continue
   # Side Effects:
   #   The file {DocRoot}/announcement.txt is created.
   #   A reply is sent to $client.
 #  #
 sub CopyFile {  sub set_announce_handler {
     my $oldfile = shift;      my ($cmd, $announcement, $client) = @_;
     my $newfile = shift;    
       my $userinput    = "$cmd:$announcement";
   
     #  The file must exist:      chomp($announcement);
       $announcement=&unescape($announcement);
       if (my $store=IO::File->new('>'.$perlvar{'lonDocRoot'}.
    '/announcement.txt')) {
    print $store $announcement;
    close $store;
    &Reply($client, "ok\n", $userinput);
       } else {
    &Failure($client, "error: ".($!+0)."\n", $userinput);
       }
   
     if(-e $oldfile) {      return 1;
   }
   &register_handler("setannounce", \&set_announce_handler, 0, 1, 0);
   
   #
   #  Return the version of the daemon.  This can be used to determine
   #  the compatibility of cross version installations or, alternatively to
   #  simply know who's out of date and who isn't.  Note that the version
   #  is returned concatenated with the tail.
   # Parameters:
   #   $cmd        - the request that dispatched to us.
   #   $tail       - Tail of the request (client's version?).
   #   $client     - Socket open on the client.
   #Returns:
   #   1 - continue processing requests.
   # Side Effects:
   #   Replies with version to $client.
   sub get_version_handler {
       my ($cmd, $tail, $client) = @_;
   
  # Read the old file.      my $userinput  = $cmd.$tail;
       
       &Reply($client, &version($userinput)."\n", $userinput);
   
  my $oldfh = IO::File->new("< $oldfile");  
  if(!$oldfh) {  
     return 0;  
  }  
  my @contents = <$oldfh>;  # Suck in the entire file.  
   
  # write the backup file:      return 1;
   }
   &register_handler("version", \&get_version_handler, 0, 1, 0);
   
  my $newfh = IO::File->new("> $newfile");  #  Set the current host and domain.  This is used to support
  if(!(defined $newfh)){  #  multihomed systems.  Each IP of the system, or even separate daemons
     return 0;  #  on the same IP can be treated as handling a separate lonCAPA virtual
  }  #  machine.  This command selects the virtual lonCAPA.  The client always
  my $lines = scalar @contents;  #  knows the right one since it is lonc and it is selecting the domain/system
  for (my $i =0; $i < $lines; $i++) {  #  from the hosts.tab file.
     print $newfh ($contents[$i]);  # Parameters:
  }  #    $cmd      - Command that dispatched us.
   #    $tail     - Tail of the command (domain/host requested).
   #    $socket   - Socket open on the client.
   #
   # Returns:
   #     1   - Indicates the program should continue to process requests.
   # Side-effects:
   #     The default domain/system context is modified for this daemon.
   #     a reply is sent to the client.
   #
   sub set_virtual_host_handler {
       my ($cmd, $tail, $socket) = @_;
     
       my $userinput  ="$cmd:$tail";
   
  $oldfh->close;      &Reply($client, &sethost($userinput)."\n", $userinput);
  $newfh->close;  
   
  chmod(0660, $newfile);  
   
  return 1;      return 1;
       
     } else {  
  return 0;  
     }  
 }  }
 #  &register_handler("sethost", \&set_virtual_host_handler, 0, 1, 0);
 #  Host files are passed out with externally visible host IPs.  
 #  If, for example, we are behind a fire-wall or NAT host, our   #  Process a request to exit:
 #  internally visible IP may be different than the externally  #   - "bye" is sent to the client.
 #  visible IP.  Therefore, we always adjust the contents of the  #   - The client socket is shutdown and closed.
 #  host file so that the entry for ME is the IP that we believe  #   - We indicate to the caller that we should exit.
 #  we have.  At present, this is defined as the entry that  # Formal Parameters:
 #  DNS has for us.  If by some chance we are not able to get a  #   $cmd                - The command that got us here.
 #  DNS translation for us, then we assume that the host.tab file  #   $tail               - Tail of the command (empty).
 #  is correct.    #   $client             - Socket open on the tail.
 #    BUGBUGBUG - in the future, we really should see if we can  
 #       easily query the interface(s) instead.  
 # Parameter(s):  
 #     contents    - The contents of the host.tab to check.  
 # Returns:  # Returns:
 #     newcontents - The adjusted contents.  #   0      - Indicating the program should exit!!
 #  #
   sub exit_handler {
       my ($cmd, $tail, $client) = @_;
   
       my $userinput = "$cmd:$tail";
   
       &logthis("Client $clientip ($clientname) hanging up: $userinput");
       &Reply($client, "bye\n", $userinput);
       $client->shutdown(2);        # shutdown the socket forcibly.
       $client->close();
   
       return 0;
   }
   &register_handler("exit", \&exit_handler, 0,1,1);
   &register_handler("init", \&exit_handler, 0,1,1);
   &register_handler("quit", \&exit_handler, 0,1,1);
   
   #  Determine if auto-enrollment is enabled.
   #  Note that the original had what I believe to be a defect.
   #  The original returned 0 if the requestor was not a registerd client.
   #  It should return "refused".
   # Formal Parameters:
   #   $cmd       - The command that invoked us.
   #   $tail      - The tail of the command (Extra command parameters.
   #   $client    - The socket open on the client that issued the request.
   # Returns:
   #    1         - Indicating processing should continue.
 #  #
 sub AdjustHostContents {  sub enrollment_enabled_handler {
     my $contents  = shift;      my ($cmd, $tail, $client) = @_;
     my $adjusted;      my $userinput = $cmd.":".$tail; # For logging purposes.
     my $me        = $perlvar{'lonHostID'};  
   
  foreach my $line (split(/\n/,$contents)) {      
  if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {      my ($cdom) = split(/:/, $tail, 2);   # Domain we're asking about.
     chomp($line);  
     my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);      my $outcome  = &localenroll::run($cdom);
     if ($id eq $me) {      &Reply($client, \$outcome, $userinput);
           my $ip = gethostbyname($name);  
           my $ipnew = inet_ntoa($ip);      return 1;
          $ip = $ipnew;  
  #  Reconstruct the host line and append to adjusted:  
   
    my $newline = "$id:$domain:$role:$name:$ip";  
    if($maxcon ne "") { # Not all hosts have loncnew tuning params  
      $newline .= ":$maxcon:$idleto:$mincon";  
    }  
    $adjusted .= $newline."\n";  
   
       } else { # Not me, pass unmodified.  
    $adjusted .= $line."\n";  
       }  
  } else {                  # Blank or comment never re-written.  
     $adjusted .= $line."\n"; # Pass blanks and comments as is.  
  }  
  }  
  return $adjusted;  
 }  }
   &register_handler("autorun", \&enrollment_enabled_handler, 0, 1, 0);
   
 #  #
 #   InstallFile: Called to install an administrative file:  #   Validate an institutional code used for a LON-CAPA course.          
 #       - The file is created with <name>.tmp  
 #       - The <name>.tmp file is then mv'd to <name>  
 #   This lugubrious procedure is done to ensure that we are never without  
 #   a valid, even if dated, version of the file regardless of who crashes  
 #   and when the crash occurs.  
 #  #
 #  Parameters:  # Formal Parameters:
 #       Name of the file  #   $cmd          - The command request that got us dispatched.
 #       File Contents.  #   $tail         - The tail of the command.  In this case,
 #  Return:  #                   this is a colon separated set of words that will be split
 #      nonzero - success.  #                   into:
 #      0       - failure and $! has an errno.  #                        $dom      - The domain for which the check of 
   #                                    institutional course code will occur.
   #
   #                        $instcode - The institutional code for the course
   #                                    being requested, or validated for rights
   #                                    to request.
 #  #
 sub InstallFile {  #                        $owner    - The course requestor (who will be the
     my $Filename = shift;  #                                    course owner, in the form username:domain
     my $Contents = shift;  #
     my $TempFile = $Filename.".tmp";  #   $client       - Socket open on the client.
   # Returns:
     #  Open the file for write:  #    1           - Indicating processing should continue.
   #
   sub validate_instcode_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($dom,$instcode,$owner) = split(/:/, $tail);
       $instcode = &unescape($instcode);
       $owner = &unescape($owner);
       my ($outcome,$description,$credits) = 
           &localenroll::validate_instcode($dom,$instcode,$owner);
       my $result = &escape($outcome).'&'.&escape($description).'&'.
                    &escape($credits);
       &Reply($client, \$result, $userinput);
   
     my $fh = IO::File->new("> $TempFile"); # Write to temp.      return 1;
     if(!(defined $fh)) {  }
  &logthis('<font color="red"> Unable to create '.$TempFile."</font>");  &register_handler("autovalidateinstcode", \&validate_instcode_handler, 0, 1, 0);
  return 0;  
     }  
     #  write the contents of the file:  
   
     print $fh ($Contents);   #   Get the official sections for which auto-enrollment is possible.
     $fh->close; # In case we ever have a filesystem w. locking  #   Since the admin people won't know about 'unofficial sections' 
   #   we cannot auto-enroll on them.
   # Formal Parameters:
   #    $cmd     - The command request that got us dispatched here.
   #    $tail    - The remainder of the request.  In our case this
   #               will be split into:
   #               $coursecode   - The course name from the admin point of view.
   #               $cdom         - The course's domain(?).
   #    $client  - Socket open on the client.
   # Returns:
   #    1    - Indiciting processing should continue.
   #
   sub get_sections_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
   
     chmod(0660, $TempFile);      my ($coursecode, $cdom) = split(/:/, $tail);
       my @secs = &localenroll::get_sections($coursecode,$cdom);
       my $seclist = &escape(join(':',@secs));
   
     # Now we can move install the file in position.      &Reply($client, \$seclist, $userinput);
           
     move($TempFile, $Filename);  
   
     return 1;      return 1;
 }  }
   &register_handler("autogetsections", \&get_sections_handler, 0, 1, 0);
   
   #   Validate the owner of a new course section.  
 #  #
 #   ConfigFileFromSelector: converts a configuration file selector  # Formal Parameters:
 #                 (one of host or domain at this point) into a   #   $cmd      - Command that got us dispatched.
 #                 configuration file pathname.  #   $tail     - the remainder of the command.  For us this consists of a
   #               colon separated string containing:
   #                  $inst    - Course Id from the institutions point of view.
   #                  $owner   - Proposed owner of the course.
   #                  $cdom    - Domain of the course (from the institutions
   #                             point of view?)..
   #   $client   - Socket open on the client.
 #  #
 #  Parameters:  # Returns:
 #      selector  - Configuration file selector.  #   1        - Processing should continue.
 #  Returns:  
 #      Full path to the file or undef if the selector is invalid.  
 #  #
 sub ConfigFileFromSelector {  sub validate_course_owner_handler {
     my $selector   = shift;      my ($cmd, $tail, $client)  = @_;
     my $tablefile;      my $userinput = "$cmd:$tail";
       my ($inst_course_id, $owner, $cdom, $coowners) = split(/:/, $tail);
       
       $owner = &unescape($owner);
       $coowners = &unescape($coowners);
       my $outcome = &localenroll::new_course($inst_course_id,$owner,$cdom,$coowners);
       &Reply($client, \$outcome, $userinput);
   
   
     my $tabledir = $perlvar{'lonTabDir'}.'/';  
     if ($selector eq "hosts") {  
  $tablefile = $tabledir."hosts.tab";  
     } elsif ($selector eq "domain") {  
  $tablefile = $tabledir."domain.tab";  
     } else {  
  return undef;  
     }  
     return $tablefile;  
   
       return 1;
 }  }
   &register_handler("autonewcourse", \&validate_course_owner_handler, 0, 1, 0);
   
 #  #
 #   PushFile:  Called to do an administrative push of a file.  #   Validate a course section in the official schedule of classes
 #              - Ensure the file being pushed is one we support.  #   from the institutions point of view (part of autoenrollment).
 #              - Backup the old file to <filename.saved>  
 #              - Separate the contents of the new file out from the  
 #                rest of the request.  
 #              - Write the new file.  
 #  Parameter:  
 #     Request - The entire user request.  This consists of a : separated  
 #               string pushfile:tablename:contents.  
 #     NOTE:  The contents may have :'s in it as well making things a bit  
 #            more interesting... but not much.  
 #  Returns:  
 #     String to send to client ("ok" or "refused" if bad file).  
 #  #
 sub PushFile {  # Formal Parameters:
     my $request = shift;      #   $cmd          - The command request that got us dispatched.
     my ($command, $filename, $contents) = split(":", $request, 3);  #   $tail         - The tail of the command.  In this case,
       #                   this is a colon separated set of words that will be split
     #  At this point in time, pushes for only the following tables are  #                   into:
     #  supported:  #                        $inst_course_id - The course/section id from the
     #   hosts.tab  ($filename eq host).  #                                          institutions point of view.
     #   domain.tab ($filename eq domain).  #                        $cdom           - The domain from the institutions
     # Construct the destination filename or reject the request.  #                                          point of view.
     #  #   $client       - Socket open on the client.
     # lonManage is supposed to ensure this, however this session could be  # Returns:
     # part of some elaborate spoof that managed somehow to authenticate.  #    1           - Indicating processing should continue.
     #  #
   sub validate_course_section_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($inst_course_id, $cdom) = split(/:/, $tail);
   
       my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
       &Reply($client, \$outcome, $userinput);
   
     my $tablefile = ConfigFileFromSelector($filename);  
     if(! (defined $tablefile)) {  
  return "refused";  
     }  
     #  
     # >copy< the old table to the backup table  
     #        don't rename in case system crashes/reboots etc. in the time  
     #        window between a rename and write.  
     #  
     my $backupfile = $tablefile;  
     $backupfile    =~ s/\.tab$/.old/;  
     if(!CopyFile($tablefile, $backupfile)) {  
  &logthis('<font color="green"> CopyFile from '.$tablefile." to ".$backupfile." failed </font>");  
  return "error:$!";  
     }  
     &logthis('<font color="green"> Pushfile: backed up '  
     .$tablefile." to $backupfile</font>");  
       
     #  If the file being pushed is the host file, we adjust the entry for ourself so that the  
     #  IP will be our current IP as looked up in dns.  Note this is only 99% good as it's possible  
     #  to conceive of conditions where we don't have a DNS entry locally.  This is possible in a   
     #  network sense but it doesn't make much sense in a LonCAPA sense so we ignore (for now)  
     #  that possibilty.  
   
     if($filename eq "host") {      return 1;
  $contents = AdjustHostContents($contents);  }
     }  &register_handler("autovalidatecourse", \&validate_course_section_handler, 0, 1, 0);
   
     #  Install the new file:  #
   #   Validate course owner's access to enrollment data for specific class section. 
   #   
   #
   # Formal Parameters:
   #    $cmd     - The command request that got us dispatched.
   #    $tail    - The tail of the command.   In this case this is a colon separated
   #               set of words that will be split into:
   #               $inst_class  - Institutional code for the specific class section   
   #               $courseowner - The escaped username:domain of the course owner 
   #               $cdom        - The domain of the course from the institution's
   #                              point of view.
   #    $client  - The socket open on the client.
   # Returns:
   #    1 - continue processing.
   #
   
     if(!InstallFile($tablefile, $contents)) {  sub validate_class_access_handler {
  &logthis('<font color="red"> Pushfile: unable to install '      my ($cmd, $tail, $client) = @_;
  .$tablefile." $! </font>");      my $userinput = "$cmd:$tail";
  return "error:$!";      my ($inst_class,$ownerlist,$cdom) = split(/:/, $tail);
     }      my $owners = &unescape($ownerlist);
     else {      my $outcome;
  &logthis('<font color="green"> Installed new '.$tablefile      eval {
  ."</font>");   local($SIG{__DIE__})='DEFAULT';
    $outcome=&localenroll::check_section($inst_class,$owners,$cdom);
       };
       &Reply($client,\$outcome, $userinput);
   
     }      return 1;
   }
   &register_handler("autovalidateclass_sec", \&validate_class_access_handler, 0, 1, 0);
   
   #
   #   Create a password for a new LON-CAPA user added by auto-enrollment.
   #   Only used for case where authentication method for new user is localauth
   #
   # Formal Parameters:
   #    $cmd     - The command request that got us dispatched.
   #    $tail    - The tail of the command.   In this case this is a colon separated
   #               set of words that will be split into:
   #               $authparam - An authentication parameter (localauth parameter).
   #               $cdom      - The domain of the course from the institution's
   #                            point of view.
   #    $client  - The socket open on the client.
   # Returns:
   #    1 - continue processing.
   #
   sub create_auto_enroll_password_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
   
       my ($authparam, $cdom) = split(/:/, $userinput);
   
       my ($create_passwd,$authchk);
       ($authparam,
        $create_passwd,
        $authchk) = &localenroll::create_password($authparam,$cdom);
   
       &Reply($client, &escape($authparam.':'.$create_passwd.':'.$authchk)."\n",
      $userinput);
   
     #  Indicate success:  
    
     return "ok";  
   
       return 1;
 }  }
   &register_handler("autocreatepassword", \&create_auto_enroll_password_handler, 
     0, 1, 0);
   
   #   Retrieve and remove temporary files created by/during autoenrollment.
 #  #
 #  Called to re-init either lonc or lond.  # Formal Parameters:
 #  #    $cmd      - The command that got us dispatched.
 #  Parameters:  #    $tail     - The tail of the command.  In our case this is a colon 
 #    request   - The full request by the client.  This is of the form  #                separated list that will be split into:
 #                reinit:<process>    #                $filename - The name of the file to remove.
 #                where <process> is allowed to be either of   #                            The filename is given as a path relative to
 #                lonc or lond  #                            the LonCAPA temp file directory.
 #  #    $client   - Socket open on the client.
 #  Returns:  
 #     The string to be sent back to the client either:  
 #   ok         - Everything worked just fine.  
 #   error:why  - There was a failure and why describes the reason.  
 #  #
   # Returns:
   #   1     - Continue processing.
   sub retrieve_auto_file_handler {
       my ($cmd, $tail, $client)    = @_;
       my $userinput                = "cmd:$tail";
   
       my ($filename)   = split(/:/, $tail);
   
       my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
       if ( (-e $source) && ($filename ne '') ) {
    my $reply = '';
    if (open(my $fh,$source)) {
       while (<$fh>) {
    chomp($_);
    $_ =~ s/^\s+//g;
    $_ =~ s/\s+$//g;
    $reply .= $_;
       }
       close($fh);
       &Reply($client, &escape($reply)."\n", $userinput);
   
   #   Does this have to be uncommented??!?  (RF).
 #  #
 sub ReinitProcess {  #                                unlink($source);
     my $request = shift;   } else {
       &Failure($client, "error\n", $userinput);
    }
       } else {
    &Failure($client, "error\n", $userinput);
       }
       
   
       return 1;
   }
   &register_handler("autoretrieve", \&retrieve_auto_file_handler, 0,1,0);
   
     # separate the request (reinit) from the process identifier and  sub crsreq_checks_handler {
     # validate it producing the name of the .pid file for the process.      my ($cmd, $tail, $client) = @_;
     #      my $userinput = "$cmd:$tail";
     #      my $dom = $tail;
     my ($junk, $process) = split(":", $request);      my $result;
     my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';      my @reqtypes = ('official','unofficial','community');
     if($process eq 'lonc') {      eval {
  $processpidfile = $processpidfile."lonc.pid";          local($SIG{__DIE__})='DEFAULT';
  if (!open(PIDFILE, "< $processpidfile")) {          my %validations;
     return "error:Open failed for $processpidfile";          my $response = &localenroll::crsreq_checks($dom,\@reqtypes,
  }                                                     \%validations);
  my $loncpid = <PIDFILE>;          if ($response eq 'ok') { 
  close(PIDFILE);              foreach my $key (keys(%validations)) {
  logthis('<font color="red"> Reinitializing lonc pid='.$loncpid                  $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($validations{$key}).'&';
  ."</font>");              }
  kill("USR2", $loncpid);              $result =~ s/\&$//;
     } elsif ($process eq 'lond') {          } else {
  logthis('<font color="red"> Reinitializing self (lond) </font>');              $result = 'error';
  &UpdateHosts; # Lond is us!!          }
       };
       if (!$@) {
           &Reply($client, \$result, $userinput);
     } else {      } else {
  &logthis('<font color="yellow" Invalid reinit request for '.$process          &Failure($client,"unknown_cmd\n",$userinput);
  ."</font>");  
  return "error:Invalid process identifier $process";  
     }      }
     return 'ok';      return 1;
 }  }
 #   Validate a line in a configuration file edit script:  &register_handler("autocrsreqchecks", \&crsreq_checks_handler, 0, 1, 0);
 #   Validation includes:  
 #     - Ensuring the command is valid.  sub validate_crsreq_handler {
 #     - Ensuring the command has sufficient parameters      my ($cmd, $tail, $client) = @_;
 #   Parameters:      my $userinput = "$cmd:$tail";
 #     scriptline - A line to validate (\n has been stripped for what it's worth).      my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = split(/:/, $tail);
       $instcode = &unescape($instcode);
       $owner = &unescape($owner);
       $crstype = &unescape($crstype);
       $inststatuslist = &unescape($inststatuslist);
       $instcode = &unescape($instcode);
       $instseclist = &unescape($instseclist);
       my $outcome;
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::validate_crsreq($dom,$owner,$crstype,
                                                    $inststatuslist,$instcode,
                                                    $instseclist);
       };
       if (!$@) {
           &Reply($client, \$outcome, $userinput);
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
       return 1;
   }
   &register_handler("autocrsreqvalidation", \&validate_crsreq_handler, 0, 1, 0);
   
 #  #
 #   Return:  #   Read and retrieve institutional code format (for support form).
 #      0     - Invalid scriptline.  # Formal Parameters:
 #      1     - Valid scriptline  #    $cmd        - Command that dispatched us.
 #  NOTE:  #    $tail       - Tail of the command.  In this case it conatins 
 #     Only the command syntax is checked, not the executability of the  #                  the course domain and the coursename.
 #     command.  #    $client     - Socket open on the client.
   # Returns:
   #    1     - Continue processing.
 #  #
 sub isValidEditCommand {  sub get_institutional_code_format_handler {
     my $scriptline = shift;      my ($cmd, $tail, $client)   = @_;
       my $userinput               = "$cmd:$tail";
   
       my $reply;
       my($cdom,$course) = split(/:/,$tail);
       my @pairs = split/\&/,$course;
       my %instcodes = ();
       my %codes = ();
       my @codetitles = ();
       my %cat_titles = ();
       my %cat_order = ();
       foreach (@pairs) {
    my ($key,$value) = split/=/,$_;
    $instcodes{&unescape($key)} = &unescape($value);
       }
       my $formatreply = &localenroll::instcode_format($cdom,
       \%instcodes,
       \%codes,
       \@codetitles,
       \%cat_titles,
       \%cat_order);
       if ($formatreply eq 'ok') {
    my $codes_str = &Apache::lonnet::hash2str(%codes);
    my $codetitles_str = &Apache::lonnet::array2str(@codetitles);
    my $cat_titles_str = &Apache::lonnet::hash2str(%cat_titles);
    my $cat_order_str = &Apache::lonnet::hash2str(%cat_order);
    &Reply($client,
          $codes_str.':'.$codetitles_str.':'.$cat_titles_str.':'
          .$cat_order_str."\n",
          $userinput);
       } else {
    # this else branch added by RF since if not ok, lonc will
    # hang waiting on reply until timeout.
    #
    &Reply($client, "format_error\n", $userinput);
       }
       
       return 1;
   }
   &register_handler("autoinstcodeformat",
     \&get_institutional_code_format_handler,0,1,0);
   
     #   Line elements are pipe separated:  sub get_institutional_defaults_handler {
       my ($cmd, $tail, $client)   = @_;
       my $userinput               = "$cmd:$tail";
   
       my $dom = $tail;
       my %defaults_hash;
       my @code_order;
       my $outcome;
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::instcode_defaults($dom,\%defaults_hash,
                                                      \@code_order);
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               my $result='';
               while (my ($key,$value) = each(%defaults_hash)) {
                   $result.=&escape($key).'='.&escape($value).'&';
               }
               $result .= 'code_order='.&escape(join('&',@code_order));
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
   }
   &register_handler("autoinstcodedefaults",
                     \&get_institutional_defaults_handler,0,1,0);
   
     my ($command, $key, $newline)  = split(/\|/, $scriptline);  sub get_possible_instcodes_handler {
     &logthis('<font color="green"> isValideditCommand checking: '.      my ($cmd, $tail, $client)   = @_;
      "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");      my $userinput               = "$cmd:$tail";
       
     if ($command eq "delete") {      my $reply;
  #      my $cdom = $tail;
  #   key with no newline.      my (@codetitles,%cat_titles,%cat_order,@code_order);
  #      my $formatreply = &localenroll::possible_instcodes($cdom,
  if( ($key eq "") || ($newline ne "")) {                                                         \@codetitles,
     return 0; # Must have key but no newline.                                                         \%cat_titles,
  } else {                                                         \%cat_order,
     return 1; # Valid syntax.                                                         \@code_order);
  }      if ($formatreply eq 'ok') {
     } elsif ($command eq "replace") {          my $result = join('&',map {&escape($_);} (@codetitles)).':';
  #          $result .= join('&',map {&escape($_);} (@code_order)).':';
  #   key and newline:          foreach my $key (keys(%cat_titles)) {
  #              $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_titles{$key}).'&';
  if (($key eq "") || ($newline eq "")) {          }
     return 0;          $result =~ s/\&$//;
  } else {          $result .= ':';
     return 1;          foreach my $key (keys(%cat_order)) {
  }              $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_order{$key}).'&';
     } elsif ($command eq "append") {          }
  if (($key ne "") && ($newline eq "")) {          $result =~ s/\&$//;
     return 1;          &Reply($client,\$result,$userinput);
  } else {  
     return 0;  
  }  
     } else {      } else {
  return 0; # Invalid command.          &Reply($client, "format_error\n", $userinput);
     }      }
     return 0; # Should not get here!!!      return 1;
 }  }
 #  &register_handler("autopossibleinstcodes",
 #   ApplyEdit - Applies an edit command to a line in a configuration                     \&get_possible_instcodes_handler,0,1,0);
 #               file.  It is the caller's responsiblity to validate the  
 #               edit line.  
 #   Parameters:  
 #      $directive - A single edit directive to apply.    
 #                   Edit directives are of the form:  
 #                  append|newline      - Appends a new line to the file.  
 #                  replace|key|newline - Replaces the line with key value 'key'  
 #                  delete|key          - Deletes the line with key value 'key'.  
 #      $editor   - A config file editor object that contains the  
 #                  file being edited.  
 #  
 sub ApplyEdit {  
     my $directive   = shift;  
     my $editor      = shift;  
   
     # Break the directive down into its command and its parameters  sub get_institutional_user_rules {
     # (at most two at this point.  The meaning of the parameters, if in fact      my ($cmd, $tail, $client)   = @_;
     #  they exist depends on the command).      my $userinput               = "$cmd:$tail";
       my $dom = &unescape($tail);
       my (%rules_hash,@rules_order);
       my $outcome;
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::username_rules($dom,\%rules_hash,\@rules_order);
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               my $result;
               foreach my $key (keys(%rules_hash)) {
                   $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
               }
               $result =~ s/\&$//;
               $result .= ':';
               if (@rules_order > 0) {
                   foreach my $item (@rules_order) {
                       $result .= &escape($item).'&';
                   }
               }
               $result =~ s/\&$//;
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
   }
   &register_handler("instuserrules",\&get_institutional_user_rules,0,1,0);
   
     my ($command, $p1, $p2) = split(/\|/, $directive);  sub get_institutional_id_rules {
       my ($cmd, $tail, $client)   = @_;
       my $userinput               = "$cmd:$tail";
       my $dom = &unescape($tail);
       my (%rules_hash,@rules_order);
       my $outcome;
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::id_rules($dom,\%rules_hash,\@rules_order);
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               my $result;
               foreach my $key (keys(%rules_hash)) {
                   $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
               }
               $result =~ s/\&$//;
               $result .= ':';
               if (@rules_order > 0) {
                   foreach my $item (@rules_order) {
                       $result .= &escape($item).'&';
                   }
               }
               $result =~ s/\&$//;
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
   }
   &register_handler("instidrules",\&get_institutional_id_rules,0,1,0);
   
     if($command eq "append") {  sub get_institutional_selfcreate_rules {
  $editor->Append($p1);          # p1 - key p2 null.      my ($cmd, $tail, $client)   = @_;
     } elsif ($command eq "replace") {      my $userinput               = "$cmd:$tail";
  $editor->ReplaceLine($p1, $p2);   # p1 - key p2 = newline.      my $dom = &unescape($tail);
     } elsif ($command eq "delete") {      my (%rules_hash,@rules_order);
  $editor->DeleteLine($p1);         # p1 - key p2 null.      my $outcome;
     } else {          # Should not get here!!!      eval {
  die "Invalid command given to ApplyEdit $command"          local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::selfcreate_rules($dom,\%rules_hash,\@rules_order);
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               my $result;
               foreach my $key (keys(%rules_hash)) {
                   $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rules_hash{$key}).'&';
               }
               $result =~ s/\&$//;
               $result .= ':';
               if (@rules_order > 0) {
                   foreach my $item (@rules_order) {
                       $result .= &escape($item).'&';
                   }
               }
               $result =~ s/\&$//;
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
     }      }
 }  }
 #  &register_handler("instemailrules",\&get_institutional_selfcreate_rules,0,1,0);
 # AdjustOurHost:  
 #           Adjusts a host file stored in a configuration file editor object  
 #           for the true IP address of this host. This is necessary for hosts  
 #           that live behind a firewall.  
 #           Those hosts have a publicly distributed IP of the firewall, but  
 #           internally must use their actual IP.  We assume that a given  
 #           host only has a single IP interface for now.  
 # Formal Parameters:  
 #     editor   - The configuration file editor to adjust.  This  
 #                editor is assumed to contain a hosts.tab file.  
 # Strategy:  
 #    - Figure out our hostname.  
 #    - Lookup the entry for this host.  
 #    - Modify the line to contain our IP  
 #    - Do a replace for this host.  
 sub AdjustOurHost {  
     my $editor        = shift;  
   
     # figure out who I am.  
   
     my $myHostName    = $perlvar{'lonHostID'}; # LonCAPA hostname.  sub institutional_username_check {
       my ($cmd, $tail, $client)   = @_;
       my $userinput               = "$cmd:$tail";
       my %rulecheck;
       my $outcome;
       my ($udom,$uname,@rules) = split(/:/,$tail);
       $udom = &unescape($udom);
       $uname = &unescape($uname);
       @rules = map {&unescape($_);} (@rules);
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::username_check($udom,$uname,\@rules,\%rulecheck);
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               my $result='';
               foreach my $key (keys(%rulecheck)) {
                   $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
               }
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
   }
   &register_handler("instrulecheck",\&institutional_username_check,0,1,0);
   
     #  Get my host file entry.  sub institutional_id_check {
       my ($cmd, $tail, $client)   = @_;
       my $userinput               = "$cmd:$tail";
       my %rulecheck;
       my $outcome;
       my ($udom,$id,@rules) = split(/:/,$tail);
       $udom = &unescape($udom);
       $id = &unescape($id);
       @rules = map {&unescape($_);} (@rules);
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::id_check($udom,$id,\@rules,\%rulecheck);
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               my $result='';
               foreach my $key (keys(%rulecheck)) {
                   $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
               }
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
   }
   &register_handler("instidrulecheck",\&institutional_id_check,0,1,0);
   
     my $ConfigLine    = $editor->Find($myHostName);  sub institutional_selfcreate_check {
     if(! (defined $ConfigLine)) {      my ($cmd, $tail, $client)   = @_;
  die "AdjustOurHost - no entry for me in hosts file $myHostName";      my $userinput               = "$cmd:$tail";
       my %rulecheck;
       my $outcome;
       my ($udom,$email,@rules) = split(/:/,$tail);
       $udom = &unescape($udom);
       $email = &unescape($email);
       @rules = map {&unescape($_);} (@rules);
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::selfcreate_check($udom,$email,\@rules,\%rulecheck);
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               my $result='';
               foreach my $key (keys(%rulecheck)) {
                   $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
               }
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
     }      }
     # figure out my IP:  }
     #   Use the config line to get my hostname.  &register_handler("instselfcreatecheck",\&institutional_selfcreate_check,0,1,0);
     #   Use gethostbyname to translate that into an IP address.  
     #  # Get domain specific conditions for import of student photographs to a course
     my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);  #
     my $BinaryIp = gethostbyname($name);  # Retrieves information from photo_permission subroutine in localenroll.
     my $ip       = inet_ntoa($ip);  # Returns outcome (ok) if no processing errors, and whether course owner is 
     #  # required to accept conditions of use (yes/no).
     #  Reassemble the config line from the elements in the list.  #
     #  Note that if the loncnew items were not present before, they will  #    
     #  be now even if they would be empty  sub photo_permission_handler {
     #      my ($cmd, $tail, $client)   = @_;
     my $newConfigLine = $id;      my $userinput               = "$cmd:$tail";
     foreach my $item ($domain, $role, $name, $ip, $maxcon, $idleto, $mincon) {      my $cdom = $tail;
  $newConfigLine .= ":".$item;      my ($perm_reqd,$conditions);
       my $outcome;
       eval {
    local($SIG{__DIE__})='DEFAULT';
    $outcome = &localenroll::photo_permission($cdom,\$perm_reqd,
     \$conditions);
       };
       if (!$@) {
    &Reply($client, &escape($outcome.':'.$perm_reqd.':'. $conditions)."\n",
          $userinput);
       } else {
    &Failure($client,"unknown_cmd\n",$userinput);
     }      }
     #  Replace the line:      return 1;
   }
   &register_handler("autophotopermission",\&photo_permission_handler,0,1,0);
   
     $editor->ReplaceLine($id, $newConfigLine);  #
       # Checks if student photo is available for a user in the domain, in the user's
   # directory (in /userfiles/internal/studentphoto.jpg).
   # Uses localstudentphoto:fetch() to ensure there is an up to date copy of
   # the student's photo.   
   
   sub photo_check_handler {
       my ($cmd, $tail, $client)   = @_;
       my $userinput               = "$cmd:$tail";
       my ($udom,$uname,$pid) = split(/:/,$tail);
       $udom = &unescape($udom);
       $uname = &unescape($uname);
       $pid = &unescape($pid);
       my $path=&propath($udom,$uname).'/userfiles/internal/';
       if (!-e $path) {
           &mkpath($path);
       }
       my $response;
       my $result = &localstudentphoto::fetch($udom,$uname,$pid,\$response);
       $result .= ':'.$response;
       &Reply($client, &escape($result)."\n",$userinput);
       return 1;
 }  }
   &register_handler("autophotocheck",\&photo_check_handler,0,1,0);
   
 #  #
 #   ReplaceConfigFile:  # Retrieve information from localenroll about whether to provide a button     
 #              Replaces a configuration file with the contents of a  # for users who have enbled import of student photos to initiate an 
 #              configuration file editor object.  # update of photo files for registered students. Also include 
 #              This is done by:  # comment to display alongside button.  
 #              - Copying the target file to <filename>.old  
 #              - Writing the new file to <filename>.tmp  sub photo_choice_handler {
 #              - Moving <filename.tmp>  -> <filename>      my ($cmd, $tail, $client) = @_;
 #              This laborious process ensures that the system is never without      my $userinput             = "$cmd:$tail";
 #              a configuration file that's at least valid (even if the contents      my $cdom                  = &unescape($tail);
 #              may be dated).      my ($update,$comment);
 #   Parameters:      eval {
 #        filename   - Name of the file to modify... this is a full path.   local($SIG{__DIE__})='DEFAULT';
 #        editor     - Editor containing the file.   ($update,$comment)    = &localenroll::manager_photo_update($cdom);
       };
       if (!$@) {
    &Reply($client,&escape($update).':'.&escape($comment)."\n",$userinput);
       } else {
    &Failure($client,"unknown_cmd\n",$userinput);
       }
       return 1;
   }
   &register_handler("autophotochoice",\&photo_choice_handler,0,1,0);
   
 #  #
 sub ReplaceConfigFile {  # Gets a student's photo to exist (in the correct image type) in the user's 
     my $filename  = shift;  # directory.
     my $editor    = shift;  # Formal Parameters:
   #    $cmd     - The command request that got us dispatched.
   #    $tail    - A colon separated set of words that will be split into:
   #               $domain - student's domain
   #               $uname  - student username
   #               $type   - image type desired
   #    $client  - The socket open on the client.
   # Returns:
   #    1 - continue processing.
   
     CopyFile ($filename, $filename.".old");  sub student_photo_handler {
       my ($cmd, $tail, $client) = @_;
       my ($domain,$uname,$ext,$type) = split(/:/, $tail);
   
       my $path=&propath($domain,$uname). '/userfiles/internal/';
       my $filename = 'studentphoto.'.$ext;
       if ($type eq 'thumbnail') {
           $filename = 'studentphoto_tn.'.$ext;
       }
       if (-e $path.$filename) {
    &Reply($client,"ok\n","$cmd:$tail");
    return 1;
       }
       &mkpath($path);
       my $file;
       if ($type eq 'thumbnail') {
    eval {
       local($SIG{__DIE__})='DEFAULT';
       $file=&localstudentphoto::fetch_thumbnail($domain,$uname);
    };
       } else {
           $file=&localstudentphoto::fetch($domain,$uname);
       }
       if (!$file) {
    &Failure($client,"unavailable\n","$cmd:$tail");
    return 1;
       }
       if (!-e $path.$filename) { &convert_photo($file,$path.$filename); }
       if (-e $path.$filename) {
    &Reply($client,"ok\n","$cmd:$tail");
    return 1;
       }
       &Failure($client,"unable_to_convert\n","$cmd:$tail");
       return 1;
   }
   &register_handler("studentphoto", \&student_photo_handler, 0, 1, 0);
   
     my $contents  = $editor->Get(); # Get the contents of the file.  sub inst_usertypes_handler {
       my ($cmd, $domain, $client) = @_;
       my $res;
       my $userinput = $cmd.":".$domain; # For logging purposes.
       my (%typeshash,@order,$result);
       eval {
    local($SIG{__DIE__})='DEFAULT';
    $result=&localenroll::inst_usertypes($domain,\%typeshash,\@order);
       };
       if ($result eq 'ok') {
           if (keys(%typeshash) > 0) {
               foreach my $key (keys(%typeshash)) {
                   $res.=&escape($key).'='.&escape($typeshash{$key}).'&';
               }
           }
           $res=~s/\&$//;
           $res .= ':';
           if (@order > 0) {
               foreach my $item (@order) {
                   $res .= &escape($item).'&';
               }
           }
           $res=~s/\&$//;
       }
       &Reply($client, \$res, $userinput);
       return 1;
   }
   &register_handler("inst_usertypes", \&inst_usertypes_handler, 0, 1, 0);
   
     InstallFile($filename, $contents);  # mkpath makes all directories for a file, expects an absolute path with a
   # file or a trailing / if just a dir is passed
   # returns 1 on success 0 on failure
   sub mkpath {
       my ($file)=@_;
       my @parts=split(/\//,$file,-1);
       my $now=$parts[0].'/'.$parts[1].'/'.$parts[2];
       for (my $i=3;$i<= ($#parts-1);$i++) {
    $now.='/'.$parts[$i]; 
    if (!-e $now) {
       if  (!mkdir($now,0770)) { return 0; }
    }
       }
       return 1;
 }  }
 #     
   #---------------------------------------------------------------
 #  #
 #   Called to edit a configuration table  file  #   Getting, decoding and dispatching requests:
 #   Parameters:  
 #      request           - The entire command/request sent by lonc or lonManage  
 #   Return:  
 #      The reply to send to the client.  
 #  #
 sub EditFile {  #
     my $request = shift;  #   Get a Request:
   #   Gets a Request message from the client.  The transaction
     #  Split the command into it's pieces:  edit:filetype:script  #   is defined as a 'line' of text.  We remove the new line
   #   from the text line.  
   #
   sub get_request {
       my $input = <$client>;
       chomp($input);
   
     my ($request, $filetype, $script) = split(/:/, $request,3); # : in script      &Debug("get_request: Request = $input\n");
   
     #  Check the pre-coditions for success:      &status('Processing '.$clientname.':'.$input);
   
     if($request != "edit") { # Something is amiss afoot alack.      return $input;
  return "error:edit request detected, but request != 'edit'\n";  }
   #---------------------------------------------------------------
   #
   #  Process a request.  This sub should shrink as each action
   #  gets farmed out into a separat sub that is registered 
   #  with the dispatch hash.  
   #
   # Parameters:
   #    user_input   - The request received from the client (lonc).
   # Returns:
   #    true to keep processing, false if caller should exit.
   #
   sub process_request {
       my ($userinput) = @_;      # Easier for now to break style than to
                                   # fix all the userinput -> user_input.
       my $wasenc    = 0; # True if request was encrypted.
   # ------------------------------------------------------------ See if encrypted
       # for command
       # sethost:<server>
       # <command>:<args>
       #   we just send it to the processor
       # for
       # sethost:<server>:<command>:<args>
       #  we do the implict set host and then do the command
       if ($userinput =~ /^sethost:/) {
    (my $cmd,my $newid,$userinput) = split(':',$userinput,3);
    if (defined($userinput)) {
       &sethost("$cmd:$newid");
    } else {
       $userinput = "$cmd:$newid";
    }
     }      }
     if( ($filetype ne "hosts")  &&  
  ($filetype ne "domain")) {      if ($userinput =~ /^enc/) {
  return "error:edit requested with invalid file specifier: $filetype \n";   $userinput = decipher($userinput);
    $wasenc=1;
    if(!$userinput) { # Cipher not defined.
       &Failure($client, "error: Encrypted data without negotated key\n");
       return 0;
    }
     }      }
       Debug("process_request: $userinput\n");
       
       #  
       #   The 'correct way' to add a command to lond is now to
       #   write a sub to execute it and Add it to the command dispatch
       #   hash via a call to register_handler..  The comments to that
       #   sub should give you enough to go on to show how to do this
       #   along with the examples that are building up as this code
       #   is getting refactored.   Until all branches of the
       #   if/elseif monster below have been factored out into
       #   separate procesor subs, if the dispatch hash is missing
       #   the command keyword, we will fall through to the remainder
       #   of the if/else chain below in order to keep this thing in 
       #   working order throughout the transmogrification.
   
       my ($command, $tail) = split(/:/, $userinput, 2);
       chomp($command);
       chomp($tail);
       $tail =~ s/(\r)//; # This helps people debugging with e.g. telnet.
       $command =~ s/(\r)//; # And this too for parameterless commands.
       if(!$tail) {
    $tail =""; # defined but blank.
       }
   
       &Debug("Command received: $command, encoded = $wasenc");
   
       if(defined $Dispatcher{$command}) {
   
    my $dispatch_info = $Dispatcher{$command};
    my $handler       = $$dispatch_info[0];
    my $need_encode   = $$dispatch_info[1];
    my $client_types  = $$dispatch_info[2];
    Debug("Matched dispatch hash: mustencode: $need_encode "
         ."ClientType $client_types");
         
    #  Validate the request:
         
    my $ok = 1;
    my $requesterprivs = 0;
    if(&isClient()) {
       $requesterprivs |= $CLIENT_OK;
    }
    if(&isManager()) {
       $requesterprivs |= $MANAGER_OK;
    }
    if($need_encode && (!$wasenc)) {
       Debug("Must encode but wasn't: $need_encode $wasenc");
       $ok = 0;
    }
    if(($client_types & $requesterprivs) == 0) {
       Debug("Client not privileged to do this operation");
       $ok = 0;
    }
   
     #   Split the edit script and check it's validity.   if($ok) {
       Debug("Dispatching to handler $command $tail");
       my $keep_going = &$handler($command, $tail, $client);
       return $keep_going;
    } else {
       Debug("Refusing to dispatch because client did not match requirements");
       Failure($client, "refused\n", $userinput);
       return 1;
    }
   
     my @scriptlines = split(/\n/, $script);  # one line per element.      }    
     my $linecount   = scalar(@scriptlines);  
     for(my $i = 0; $i < $linecount; $i++) {      print $client "unknown_cmd\n";
  chomp($scriptlines[$i]);  # -------------------------------------------------------------------- complete
  if(!isValidEditCommand($scriptlines[$i])) {      Debug("process_request - returning 1");
     return "error:edit with bad script line: '$scriptlines[$i]' \n";      return 1;
   }
   #
   #   Decipher encoded traffic
   #  Parameters:
   #     input      - Encoded data.
   #  Returns:
   #     Decoded data or undef if encryption key was not yet negotiated.
   #  Implicit input:
   #     cipher  - This global holds the negotiated encryption key.
   #
   sub decipher {
       my ($input)  = @_;
       my $output = '';
       
       
       if($cipher) {
    my($enc, $enclength, $encinput) = split(/:/, $input);
    for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {
       $output .= 
    $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));
  }   }
    return substr($output, 0, $enclength);
       } else {
    return undef;
     }      }
   }
   
     #   Execute the edit operation.  #
     #   - Create a config file editor for the appropriate file and   #   Register a command processor.  This function is invoked to register a sub
     #   - execute each command in the script:  #   to process a request.  Once registered, the ProcessRequest sub can automatically
     #  #   dispatch requests to an appropriate sub, and do the top level validity checking
     my $configfile = ConfigFileFromSelector($filetype);  #   as well:
     if (!(defined $configfile)) {  #    - Is the keyword recognized.
  return "refused\n";  #    - Is the proper client type attempting the request.
     }  #    - Is the request encrypted if it has to be.
     my $editor = ConfigFileEdit->new($configfile);  #   Parameters:
   #    $request_name         - Name of the request being registered.
   #                           This is the command request that will match
   #                           against the hash keywords to lookup the information
   #                           associated with the dispatch information.
   #    $procedure           - Reference to a sub to call to process the request.
   #                           All subs get called as follows:
   #                             Procedure($cmd, $tail, $replyfd, $key)
   #                             $cmd    - the actual keyword that invoked us.
   #                             $tail   - the tail of the request that invoked us.
   #                             $replyfd- File descriptor connected to the client
   #    $must_encode          - True if the request must be encoded to be good.
   #    $client_ok            - True if it's ok for a client to request this.
   #    $manager_ok           - True if it's ok for a manager to request this.
   # Side effects:
   #      - On success, the Dispatcher hash has an entry added for the key $RequestName
   #      - On failure, the program will die as it's a bad internal bug to try to 
   #        register a duplicate command handler.
   #
   sub register_handler {
       my ($request_name,$procedure,$must_encode, $client_ok,$manager_ok)   = @_;
   
     for (my $i = 0; $i < $linecount; $i++) {      #  Don't allow duplication#
  ApplyEdit($scriptlines[$i], $editor);     
       if (defined $Dispatcher{$request_name}) {
    die "Attempting to define a duplicate request handler for $request_name\n";
     }      }
     # If the file is the host file, ensure that our host is      #   Build the client type mask:
     # adjusted to have our ip:      
     #      my $client_type_mask = 0;
     if($filetype eq "host") {      if($client_ok) {
  AdjustOurHost($editor);   $client_type_mask  |= $CLIENT_OK;
     }      }
     #  Finally replace the current file with our file.      if($manager_ok) {
     #   $client_type_mask  |= $MANAGER_OK;
     ReplaceConfigFile($configfile, $editor);      }
      
     return "ok\n";      #  Enter the hash:
         
       my @entry = ($procedure, $must_encode, $client_type_mask);
      
       $Dispatcher{$request_name} = \@entry;
      
 }  }
   
   
   #------------------------------------------------------------------
   
   
   
   
 #  #
 #  Convert an error return code from lcpasswd to a string value.  #  Convert an error return code from lcpasswd to a string value.
 #  #
Line 3246  sub lcpasswdstrerror { Line 6012  sub lcpasswdstrerror {
     }      }
 }  }
   
 #  
 # Convert an error return code from lcuseradd to a string value:  
 #  
 sub lcuseraddstrerror {  
     my $ErrorCode = shift;  
     if(($ErrorCode < 0) || ($ErrorCode > $lastadderror)) {  
  return "lcuseradd - Unrecognized error code: ".$ErrorCode;  
     } else {  
  return $adderrors[$ErrorCode];  
     }  
 }  
   
 # grabs exception and records it to log before exiting  # grabs exception and records it to log before exiting
 sub catchexception {  sub catchexception {
     my ($error)=@_;      my ($error)=@_;
     $SIG{'QUIT'}='DEFAULT';      $SIG{'QUIT'}='DEFAULT';
     $SIG{__DIE__}='DEFAULT';      $SIG{__DIE__}='DEFAULT';
     &status("Catching exception");      &status("Catching exception");
     &logthis("<font color=red>CRITICAL: "      &logthis("<font color='red'>CRITICAL: "
      ."ABNORMAL EXIT. Child $$ for server $thisserver died through "       ."ABNORMAL EXIT. Child $$ for server ".$perlvar{'lonHostID'}." died through "
      ."a crash with this error msg->[$error]</font>");       ."a crash with this error msg->[$error]</font>");
     &logthis('Famous last words: '.$status.' - '.$lastlog);      &logthis('Famous last words: '.$status.' - '.$lastlog);
     if ($client) { print $client "error: $error\n"; }      if ($client) { print $client "error: $error\n"; }
     $server->close();      $server->close();
     die($error);      die($error);
 }  }
   
 sub timeout {  sub timeout {
     &status("Handling Timeout");      &status("Handling Timeout");
     &logthis("<font color=ref>CRITICAL: TIME OUT ".$$."</font>");      &logthis("<font color='red'>CRITICAL: TIME OUT ".$$."</font>");
     &catchexception('Timeout');      &catchexception('Timeout');
 }  }
 # -------------------------------- Set signal handlers to record abnormal exits  # -------------------------------- Set signal handlers to record abnormal exits
   
   
 $SIG{'QUIT'}=\&catchexception;  $SIG{'QUIT'}=\&catchexception;
 $SIG{__DIE__}=\&catchexception;  $SIG{__DIE__}=\&catchexception;
   
Line 3318  if (-e $pidfile) { Line 6072  if (-e $pidfile) {
 $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},  $server = IO::Socket::INET->new(LocalPort => $perlvar{'londPort'},
                                 Type      => SOCK_STREAM,                                  Type      => SOCK_STREAM,
                                 Proto     => 'tcp',                                  Proto     => 'tcp',
                                 Reuse     => 1,                                  ReuseAddr     => 1,
                                 Listen    => 10 )                                  Listen    => 10 )
   or die "making socket: $@\n";    or die "making socket: $@\n";
   
Line 3327  $server = IO::Socket::INET->new(LocalPor Line 6081  $server = IO::Socket::INET->new(LocalPor
 # global variables  # global variables
   
 my %children               = ();       # keys are current child process IDs  my %children               = ();       # keys are current child process IDs
 my $children               = 0;        # current number of children  
   
 sub REAPER {                        # takes care of dead children  sub REAPER {                        # takes care of dead children
     $SIG{CHLD} = \&REAPER;      $SIG{CHLD} = \&REAPER;
     &status("Handling child death");      &status("Handling child death");
     my $pid = wait;      my $pid;
     if (defined($children{$pid})) {      do {
  &logthis("Child $pid died");   $pid = waitpid(-1,&WNOHANG());
  $children --;   if (defined($children{$pid})) {
  delete $children{$pid};      &logthis("Child $pid died");
     } else {      delete($children{$pid});
  &logthis("Unknown Child $pid died");   } elsif ($pid > 0) {
       &logthis("Unknown Child $pid died");
    }
       } while ( $pid > 0 );
       foreach my $child (keys(%children)) {
    $pid = waitpid($child,&WNOHANG());
    if ($pid > 0) {
       &logthis("Child $child - $pid looks like we missed it's death");
       delete($children{$pid});
    }
     }      }
     &status("Finished Handling child death");      &status("Finished Handling child death");
 }  }
Line 3350  sub HUNTSMAN {                      # si Line 6112  sub HUNTSMAN {                      # si
     &logthis("Free socket: ".shutdown($server,2)); # free up socket      &logthis("Free socket: ".shutdown($server,2)); # free up socket
     my $execdir=$perlvar{'lonDaemons'};      my $execdir=$perlvar{'lonDaemons'};
     unlink("$execdir/logs/lond.pid");      unlink("$execdir/logs/lond.pid");
     &logthis("<font color=red>CRITICAL: Shutting down</font>");      &logthis("<font color='red'>CRITICAL: Shutting down</font>");
     &status("Done killing children");      &status("Done killing children");
     exit;                           # clean up with dignity      exit;                           # clean up with dignity
 }  }
Line 3360  sub HUPSMAN {                      # sig Line 6122  sub HUPSMAN {                      # sig
     &status("Killing children for restart (HUP)");      &status("Killing children for restart (HUP)");
     kill 'INT' => keys %children;      kill 'INT' => keys %children;
     &logthis("Free socket: ".shutdown($server,2)); # free up socket      &logthis("Free socket: ".shutdown($server,2)); # free up socket
     &logthis("<font color=red>CRITICAL: Restarting</font>");      &logthis("<font color='red'>CRITICAL: Restarting</font>");
     my $execdir=$perlvar{'lonDaemons'};      my $execdir=$perlvar{'lonDaemons'};
     unlink("$execdir/logs/lond.pid");      unlink("$execdir/logs/lond.pid");
     &status("Restarting self (HUP)");      &status("Restarting self (HUP)");
Line 3368  sub HUPSMAN {                      # sig Line 6130  sub HUPSMAN {                      # sig
 }  }
   
 #  #
 #    Kill off hashes that describe the host table prior to re-reading it.  
 #    Hashes affected are:  
 #       %hostid, %hostdom %hostip  
 #  
 sub KillHostHashes {  
     foreach my $key (keys %hostid) {  
  delete $hostid{$key};  
     }  
     foreach my $key (keys %hostdom) {  
  delete $hostdom{$key};  
     }  
     foreach my $key (keys %hostip) {  
  delete $hostip{$key};  
     }  
 }  
 #  
 #   Read in the host table from file and distribute it into the various hashes:  
 #  
 #    - %hostid  -  Indexed by IP, the loncapa hostname.  
 #    - %hostdom -  Indexed by  loncapa hostname, the domain.  
 #    - %hostip  -  Indexed by hostid, the Ip address of the host.  
 sub ReadHostTable {  
   
     open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";  
       
     while (my $configline=<CONFIG>) {  
  my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);  
  chomp($ip); $ip=~s/\D+$//;  
  $hostid{$ip}=$id;  
  $hostdom{$id}=$domain;  
  $hostip{$id}=$ip;  
  if ($id eq $perlvar{'lonHostID'}) { $thisserver=$name; }  
     }  
     close(CONFIG);  
 }  
 #  
 #  Reload the Apache daemon's state.  #  Reload the Apache daemon's state.
 #  This is done by invoking /home/httpd/perl/apachereload  #  This is done by invoking /home/httpd/perl/apachereload
 #  a setuid perl script that can be root for us to do this job.  #  a setuid perl script that can be root for us to do this job.
 #  #
 sub ReloadApache {  sub ReloadApache {
     my $execdir = $perlvar{'lonDaemons'};  # --------------------------- Handle case of another apachereload process (locking)
     my $script  = $execdir."/apachereload";      if (&LONCAPA::try_to_lock('/tmp/lock_apachereload')) {
     system($script);          my $execdir = $perlvar{'lonDaemons'};
           my $script  = $execdir."/apachereload";
           system($script);
           unlink('/tmp/lock_apachereload'); #  Remove the lock file.
       }
 }  }
   
 #  #
Line 3434  sub UpdateHosts { Line 6164  sub UpdateHosts {
     #  either dropped or changed hosts.  Note that the re-read of the table      #  either dropped or changed hosts.  Note that the re-read of the table
     #  will take care of new and changed hosts as connections come into being.      #  will take care of new and changed hosts as connections come into being.
   
       &Apache::lonnet::reset_hosts_info();
   
     KillHostHashes;      foreach my $child (keys(%children)) {
     ReadHostTable;  
   
     foreach my $child (keys %children) {  
  my $childip = $children{$child};   my $childip = $children{$child};
  if(!$hostid{$childip}) {   if ($childip ne '127.0.0.1'
       && !defined(&Apache::lonnet::get_hosts_from_ip($childip))) {
     logthis('<font color="blue"> UpdateHosts killing child '      logthis('<font color="blue"> UpdateHosts killing child '
     ." $child for ip $childip </font>");      ." $child for ip $childip </font>");
     kill('INT', $child);      kill('INT', $child);
Line 3461  sub checkchildren { Line 6190  sub checkchildren {
     &logthis('Going to check on the children');      &logthis('Going to check on the children');
     my $docdir=$perlvar{'lonDocRoot'};      my $docdir=$perlvar{'lonDocRoot'};
     foreach (sort keys %children) {      foreach (sort keys %children) {
  sleep 1;   #sleep 1;
         unless (kill 'USR1' => $_) {          unless (kill 'USR1' => $_) {
     &logthis ('Child '.$_.' is dead');      &logthis ('Child '.$_.' is dead');
             &logstatus($$.' is dead');              &logstatus($$.' is dead');
       delete($children{$_});
         }           } 
     }      }
     sleep 5;      sleep 5;
     $SIG{ALRM} = sub { die "timeout" };      $SIG{ALRM} = sub { Debug("timeout"); 
          die "timeout";  };
     $SIG{__DIE__} = 'DEFAULT';      $SIG{__DIE__} = 'DEFAULT';
     &status("Checking on the children (waiting for reports)");      &status("Checking on the children (waiting for reports)");
     foreach (sort keys %children) {      foreach (sort keys %children) {
Line 3482  sub checkchildren { Line 6213  sub checkchildren {
     #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;      #my $result=`echo 'Killed lond process $_.' | mailto $emailto -s '$subj' > /dev/null`;
     #$execdir=$perlvar{'lonDaemons'};      #$execdir=$perlvar{'lonDaemons'};
     #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;      #$result=`/bin/cp $execdir/logs/lond.log $execdir/logs/lond.log.$_`;
       delete($children{$_});
     alarm(0);      alarm(0);
   }    }
         }          }
Line 3489  sub checkchildren { Line 6221  sub checkchildren {
     $SIG{ALRM} = 'DEFAULT';      $SIG{ALRM} = 'DEFAULT';
     $SIG{__DIE__} = \&catchexception;      $SIG{__DIE__} = \&catchexception;
     &status("Finished checking children");      &status("Finished checking children");
       &logthis('Finished Checking children');
 }  }
   
 # --------------------------------------------------------------------- Logging  # --------------------------------------------------------------------- Logging
Line 3519  sub Debug { Line 6252  sub Debug {
 #     reply   - Text to send to client.  #     reply   - Text to send to client.
 #     request - Original request from client.  #     request - Original request from client.
 #  #
 #  Note: This increments Transactions  #NOTE $reply must be terminated by exactly *one* \n. If $reply is a reference
 #  #this is done automatically ($$reply must not contain any \n in this case). 
   #If $reply is a string the caller has to ensure this.
 sub Reply {  sub Reply {
     alarm(120);      my ($fd, $reply, $request) = @_;
     my $fd      = shift;      if (ref($reply)) {
     my $reply   = shift;   print $fd $$reply;
     my $request = shift;   print $fd "\n";
    if ($DEBUG) { Debug("Request was $request  Reply was $$reply"); }
     print $fd $reply;      } else {
     Debug("Request was $request  Reply was $reply");   print $fd $reply;
    if ($DEBUG) { Debug("Request was $request  Reply was $reply"); }
       }
     $Transactions++;      $Transactions++;
     alarm(0);  }
   
   
 }  
 #  #
 #    Sub to report a failure.  #    Sub to report a failure.
 #    This function:  #    This function:
Line 3551  sub Reply { Line 6285  sub Reply {
 #    client:  #    client:
 #  #
 sub Failure {  sub Failure {
    my $fd      = shift;      my $fd      = shift;
    my $reply   = shift;      my $reply   = shift;
    my $request = shift;      my $request = shift;
         
    $Failures++;      $Failures++;
    Reply($fd, $reply, $request);      # That's simple eh?      Reply($fd, $reply, $request);      # That's simple eh?
 }  }
 # ------------------------------------------------------------------ Log status  # ------------------------------------------------------------------ Log status
   
 sub logstatus {  sub logstatus {
    &status("Doing logging");      &status("Doing logging");
    my $docdir=$perlvar{'lonDocRoot'};      my $docdir=$perlvar{'lonDocRoot'};
    {      {
       my $fh=IO::File->new(">>$docdir/lon-status/londstatus.txt");   my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");
       print $fh $$."\t".$currenthostid."\t".$status."\t".$lastlog."\n";          print $fh $status."\n".$lastlog."\n".time."\n$keymode";
       $fh->close();          $fh->close();
    }      }
    &status("Finished londstatus.txt");      &status("Finished $$.txt");
    {      {
       my $fh=IO::File->new(">$docdir/lon-status/londchld/$$.txt");   open(LOG,">>$docdir/lon-status/londstatus.txt");
       print $fh $status."\n".$lastlog."\n".time;   flock(LOG,LOCK_EX);
       $fh->close();   print LOG $$."\t".$clientname."\t".$currenthostid."\t"
    }      .$status."\t".$lastlog."\t $keymode\n";
    ResetStatistics;   flock(LOG,LOCK_UN);
    &status("Finished logging");   close(LOG);
          }
       &status("Finished logging");
 }  }
   
 sub initnewstatus {  sub initnewstatus {
     my $docdir=$perlvar{'lonDocRoot'};      my $docdir=$perlvar{'lonDocRoot'};
     my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");      my $fh=IO::File->new(">$docdir/lon-status/londstatus.txt");
     my $now=time;      my $now=time();
     my $local=localtime($now);      my $local=localtime($now);
     print $fh "LOND status $local - parent $$\n\n";      print $fh "LOND status $local - parent $$\n\n";
     opendir(DIR,"$docdir/lon-status/londchld");      opendir(DIR,"$docdir/lon-status/londchld");
Line 3598  sub status { Line 6333  sub status {
     my $what=shift;      my $what=shift;
     my $now=time;      my $now=time;
     my $local=localtime($now);      my $local=localtime($now);
     my $status = "lond: $what $local ";      $status=$local.': '.$what;
     if($Transactions) {      $0='lond: '.$what.' '.$local;
        $status .= " Transactions: $Transactions Failed; $Failures";  
     }  
     $0=$status;  
 }  
   
 # -------------------------------------------------------- Escape Special Chars  
   
 sub escape {  
     my $str=shift;  
     $str =~ s/(\W)/"%".unpack('H2',$1)/eg;  
     return $str;  
 }  
   
 # ----------------------------------------------------- Un-Escape Special Chars  
   
 sub unescape {  
     my $str=shift;  
     $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;  
     return $str;  
 }  
   
 # ----------------------------------------------------------- Send USR1 to lonc  
   
 sub reconlonc {  
     my $peerfile=shift;  
     &logthis("Trying to reconnect for $peerfile");  
     my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";  
     if (my $fh=IO::File->new("$loncfile")) {  
  my $loncpid=<$fh>;  
         chomp($loncpid);  
         if (kill 0 => $loncpid) {  
     &logthis("lonc at pid $loncpid responding, sending USR1");  
             kill USR1 => $loncpid;  
         } else {  
     &logthis(  
               "<font color=red>CRITICAL: "  
              ."lonc at pid $loncpid not responding, giving up</font>");  
         }  
     } else {  
       &logthis('<font color=red>CRITICAL: lonc not running, giving up</font>');  
     }  
 }  
   
 # -------------------------------------------------- Non-critical communication  
   
 sub subreply {  
     my ($cmd,$server)=@_;  
     my $peerfile="$perlvar{'lonSockDir'}/$server";  
     my $sclient=IO::Socket::UNIX->new(Peer    =>"$peerfile",  
                                       Type    => SOCK_STREAM,  
                                       Timeout => 10)  
        or return "con_lost";  
     print $sclient "$cmd\n";  
     my $answer=<$sclient>;  
     chomp($answer);  
     if (!$answer) { $answer="con_lost"; }  
     return $answer;  
 }  
   
 sub reply {  
   my ($cmd,$server)=@_;  
   my $answer;  
   if ($server ne $currenthostid) {   
     $answer=subreply($cmd,$server);  
     if ($answer eq 'con_lost') {  
  $answer=subreply("ping",$server);  
         if ($answer ne $server) {  
     &logthis("sub reply: answer != server answer is $answer, server is $server");  
            &reconlonc("$perlvar{'lonSockDir'}/$server");  
         }  
         $answer=subreply($cmd,$server);  
     }  
   } else {  
     $answer='self_reply';  
   }   
   return $answer;  
 }  }
   
 # -------------------------------------------------------------- Talk to lonsql  # -------------------------------------------------------------- Talk to lonsql
   
 sub sqlreply {  sub sql_reply {
     my ($cmd)=@_;      my ($cmd)=@_;
     my $answer=subsqlreply($cmd);      my $answer=&sub_sql_reply($cmd);
     if ($answer eq 'con_lost') { $answer=subsqlreply($cmd); }      if ($answer eq 'con_lost') { $answer=&sub_sql_reply($cmd); }
     return $answer;      return $answer;
 }  }
   
 sub subsqlreply {  sub sub_sql_reply {
     my ($cmd)=@_;      my ($cmd)=@_;
     my $unixsock="mysqlsock";      my $unixsock="mysqlsock";
     my $peerfile="$perlvar{'lonSockDir'}/$unixsock";      my $peerfile="$perlvar{'lonSockDir'}/$unixsock";
Line 3695  sub subsqlreply { Line 6354  sub subsqlreply {
                                       Type    => SOCK_STREAM,                                        Type    => SOCK_STREAM,
                                       Timeout => 10)                                        Timeout => 10)
        or return "con_lost";         or return "con_lost";
     print $sclient "$cmd\n";      print $sclient "$cmd:$currentdomainid\n";
     my $answer=<$sclient>;      my $answer=<$sclient>;
     chomp($answer);      chomp($answer);
     if (!$answer) { $answer="con_lost"; }      if (!$answer) { $answer="con_lost"; }
     return $answer;      return $answer;
 }  }
   
 # -------------------------------------------- Return path to profile directory  
   
 sub propath {  
     my ($udom,$uname)=@_;  
     $udom=~s/\W//g;  
     $uname=~s/\W//g;  
     my $subdir=$uname.'__';  
     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;  
     my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";  
     return $proname;  
 }   
   
 # --------------------------------------- Is this the home server of an author?  # --------------------------------------- Is this the home server of an author?
   
 sub ishome {  sub ishome {
Line 3743  my $execdir=$perlvar{'lonDaemons'}; Line 6390  my $execdir=$perlvar{'lonDaemons'};
 open (PIDSAVE,">$execdir/logs/lond.pid");  open (PIDSAVE,">$execdir/logs/lond.pid");
 print PIDSAVE "$$\n";  print PIDSAVE "$$\n";
 close(PIDSAVE);  close(PIDSAVE);
 &logthis("<font color=red>CRITICAL: ---------- Starting ----------</font>");  &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
 &status('Starting');  &status('Starting');
   
   
Line 3758  $SIG{USR1} = \&checkchildren; Line 6405  $SIG{USR1} = \&checkchildren;
 $SIG{USR2} = \&UpdateHosts;  $SIG{USR2} = \&UpdateHosts;
   
 #  Read the host hashes:  #  Read the host hashes:
   &Apache::lonnet::load_hosts_tab();
   my %iphost = &Apache::lonnet::get_iphost(1);
   
 ReadHostTable;  $dist=`$perlvar{'lonDaemons'}/distprobe`;
   
   my $arch = `uname -i`;
   chomp($arch);
   if ($arch eq 'unknown') {
       $arch = `uname -m`;
       chomp($arch);
   }
   
 # --------------------------------------------------------------  # --------------------------------------------------------------
 #   Accept connections.  When a connection comes in, it is validated  #   Accept connections.  When a connection comes in, it is validated
Line 3777  while (1) { Line 6432  while (1) {
   
 sub make_new_child {  sub make_new_child {
     my $pid;      my $pid;
   #    my $cipher;     # Now global
     my $sigset;      my $sigset;
   
     $client = shift;      $client = shift;
Line 3798  sub make_new_child { Line 6454  sub make_new_child {
     #  the pid hash.      #  the pid hash.
     #      #
     my $caller = getpeername($client);      my $caller = getpeername($client);
     my ($port,$iaddr)=unpack_sockaddr_in($caller);      my ($port,$iaddr);
     $clientip=inet_ntoa($iaddr);      if (defined($caller) && length($caller) > 0) {
    ($port,$iaddr)=unpack_sockaddr_in($caller);
       } else {
    &logthis("Unable to determine who caller was, getpeername returned nothing");
       }
       if (defined($iaddr)) {
    $clientip  = inet_ntoa($iaddr);
    Debug("Connected with $clientip");
       } else {
    &logthis("Unable to determine clientip");
    $clientip='Unavailable';
       }
           
     if ($pid) {      if ($pid) {
         # Parent records the child's birth and returns.          # Parent records the child's birth and returns.
         sigprocmask(SIG_UNBLOCK, $sigset)          sigprocmask(SIG_UNBLOCK, $sigset)
             or die "Can't unblock SIGINT for fork: $!\n";              or die "Can't unblock SIGINT for fork: $!\n";
         $children{$pid} = $clientip;          $children{$pid} = $clientip;
         $children++;  
         &status('Started child '.$pid);          &status('Started child '.$pid);
    close($client);
         return;          return;
     } else {      } else {
         # Child can *not* return from this subroutine.          # Child can *not* return from this subroutine.
Line 3816  sub make_new_child { Line 6483  sub make_new_child {
                                 #don't get intercepted                                  #don't get intercepted
         $SIG{USR1}= \&logstatus;          $SIG{USR1}= \&logstatus;
         $SIG{ALRM}= \&timeout;          $SIG{ALRM}= \&timeout;
    #
    # Block sigpipe as it gets thrownon socket disconnect and we want to 
    # deal with that as a read faiure instead.
    #
    my $blockset = POSIX::SigSet->new(SIGPIPE);
    sigprocmask(SIG_BLOCK, $blockset);
   
         $lastlog='Forked ';          $lastlog='Forked ';
         $status='Forked';          $status='Forked';
   
Line 3823  sub make_new_child { Line 6497  sub make_new_child {
         sigprocmask(SIG_UNBLOCK, $sigset)          sigprocmask(SIG_UNBLOCK, $sigset)
             or die "Can't unblock SIGINT for fork: $!\n";              or die "Can't unblock SIGINT for fork: $!\n";
   
   #        my $tmpsnum=0;            # Now global
   #---------------------------------------------------- kerberos 5 initialization
         &Authen::Krb5::init_context();          &Authen::Krb5::init_context();
         &Authen::Krb5::init_ets();   unless (($dist eq 'fedora5') || ($dist eq 'fedora4') ||  
    ($dist eq 'fedora6') || ($dist eq 'suse9.3') ||
                   ($dist eq 'suse12.2') || ($dist eq 'suse12.3')) {
       &Authen::Krb5::init_ets();
    }
   
  &status('Accepted connection');   &status('Accepted connection');
 # =============================================================================  # =============================================================================
             # do something with the connection              # do something with the connection
 # -----------------------------------------------------------------------------  # -----------------------------------------------------------------------------
  # see if we know client and check for spoof IP by challenge   # see if we know client and 'check' for spoof IP by ineffective challenge
   
  ReadManagerTable; # May also be a manager!!   my $outsideip=$clientip;
    if ($clientip eq '127.0.0.1') {
  my $clientrec=($hostid{$clientip}     ne undef);      $outsideip=&Apache::lonnet::get_host_ip($perlvar{'lonHostID'});
  my $ismanager=($managers{$clientip}    ne undef);   }
  $clientname  = "[unknonwn]";   &ReadManagerTable();
    my $clientrec=defined(&Apache::lonnet::get_hosts_from_ip($outsideip));
    my $ismanager=($managers{$outsideip}    ne undef);
    $clientname  = "[unknown]";
  if($clientrec) { # Establish client type.   if($clientrec) { # Establish client type.
     $ConnectionType = "client";      $ConnectionType = "client";
     $clientname = $hostid{$clientip};      $clientname = (&Apache::lonnet::get_hosts_from_ip($outsideip))[-1];
     if($ismanager) {      if($ismanager) {
  $ConnectionType = "both";   $ConnectionType = "both";
     }      }
  } else {   } else {
     $ConnectionType = "manager";      $ConnectionType = "manager";
     $clientname = $managers{$clientip};      $clientname = $managers{$outsideip};
  }   }
  my $clientok;   my $clientok;
   
  if ($clientrec || $ismanager) {   if ($clientrec || $ismanager) {
     &status("Waiting for init from $clientip $clientname");      &status("Waiting for init from $clientip $clientname");
     &logthis('<font color="yellow">INFO: Connection, '.      &logthis('<font color="yellow">INFO: Connection, '.
Line 3857  sub make_new_child { Line 6539  sub make_new_child {
   " ($clientname) connection type = $ConnectionType </font>" );    " ($clientname) connection type = $ConnectionType </font>" );
     &status("Connecting $clientip  ($clientname))");       &status("Connecting $clientip  ($clientname))"); 
     my $remotereq=<$client>;      my $remotereq=<$client>;
     $remotereq=~s/[^\w:]//g;      chomp($remotereq);
       Debug("Got init: $remotereq");
   
     if ($remotereq =~ /^init/) {      if ($remotereq =~ /^init/) {
  &sethost("sethost:$perlvar{'lonHostID'}");   &sethost("sethost:$perlvar{'lonHostID'}");
  my $challenge="$$".time;   #
  print $client "$challenge\n";   #  If the remote is attempting a local init... give that a try:
  &status(   #
  "Waiting for challenge reply from $clientip ($clientname)");           logthis("remotereq: $remotereq");
  $remotereq=<$client>;   (my $i, my $inittype, $clientversion) = split(/:/, $remotereq);
  $remotereq=~s/\W//g;          # For LON-CAPA 2.9, the  client session will have sent its LON-CAPA
  if ($challenge eq $remotereq) {          # version when initiating the connection. For LON-CAPA 2.8 and older,
     $clientok=1;          # the version is retrieved from the global %loncaparevs in lonnet.pm.            
     print $client "ok\n";          # $clientversion contains path to keyfile if $inittype eq 'local'
           # it's overridden below in this case
           $clientversion ||= $Apache::lonnet::loncaparevs{$clientname};
   
    # If the connection type is ssl, but I didn't get my
    # certificate files yet, then I'll drop  back to 
    # insecure (if allowed).
   
    if($inittype eq "ssl") {
       my ($ca, $cert) = lonssl::CertificateFile;
       my $kfile       = lonssl::KeyFile;
       if((!$ca)   || 
          (!$cert) || 
          (!$kfile)) {
    $inittype = ""; # This forces insecure attempt.
    &logthis("<font color=\"blue\"> Certificates not "
    ."installed -- trying insecure auth</font>");
       } else { # SSL certificates are in place so
       } # Leave the inittype alone.
    }
   
    if($inittype eq "local") {
                       $clientversion = $perlvar{'lonVersion'};
       my $key = LocalConnection($client, $remotereq);
       if($key) {
    Debug("Got local key $key");
    $clientok     = 1;
    my $cipherkey = pack("H32", $key);
    $cipher       = new IDEA($cipherkey);
    print $client "ok:local\n";
    &logthis('<font color="green">'
    . "Successful local authentication </font>");
    $keymode = "local"
       } else {
    Debug("Failed to get local key");
    $clientok = 0;
    shutdown($client, 3);
    close $client;
       }
    } elsif ($inittype eq "ssl") {
       my $key = SSLConnection($client);
       if ($key) {
    $clientok = 1;
    my $cipherkey = pack("H32", $key);
    $cipher       = new IDEA($cipherkey);
    &logthis('<font color="green">'
    ."Successfull ssl authentication with $clientname </font>");
    $keymode = "ssl";
        
       } else {
    $clientok = 0;
    close $client;
       }
      
  } else {   } else {
     &logthis(      my $ok = InsecureConnection($client);
      "<font color=blue>WARNING: $clientip did not reply challenge</font>");      if($ok) {
     &status('No challenge reply '.$clientip);   $clientok = 1;
    &logthis('<font color="green">'
    ."Successful insecure authentication with $clientname </font>");
    print $client "ok\n";
    $keymode = "insecure";
       } else {
    &logthis('<font color="yellow">'
     ."Attempted insecure connection disallowed </font>");
    close $client;
    $clientok = 0;
   
       }
  }   }
     } else {      } else {
  &logthis(   &logthis(
  "<font color=blue>WARNING: "   "<font color='blue'>WARNING: "
  ."$clientip failed to initialize: >$remotereq< </font>");   ."$clientip failed to initialize: >$remotereq< </font>");
  &status('No init '.$clientip);   &status('No init '.$clientip);
     }      }
       
  } else {   } else {
     &logthis(      &logthis(
      "<font color=blue>WARNING: Unknown client $clientip</font>");       "<font color='blue'>WARNING: Unknown client $clientip</font>");
     &status('Hung up on '.$clientip);      &status('Hung up on '.$clientip);
  }   }
    
  if ($clientok) {   if ($clientok) {
 # ---------------- New known client connecting, could mean machine online again  # ---------------- New known client connecting, could mean machine online again
           if (&Apache::lonnet::get_host_ip($currenthostid) ne $clientip 
     foreach my $id (keys(%hostip)) {   && $clientip ne '127.0.0.1') {
  if ($hostip{$id} ne $clientip ||   &Apache::lonnet::reconlonc($clientname);
     $hostip{$currenthostid} eq $clientip) {  
     # no need to try to do recon's to myself  
     next;  
  }  
  &reconlonc("$perlvar{'lonSockDir'}/$id");  
     }      }
     &logthis("<font color=green>Established connection: $clientname</font>");      &logthis("<font color='green'>Established connection: $clientname</font>");
     &status('Will listen to '.$clientname);      &status('Will listen to '.$clientname);
   
     ResetStatistics();  
   
 # ------------------------------------------------------------ Process requests  # ------------------------------------------------------------ Process requests
     my $KeepGoing = 1;      my $keep_going = 1;
     while ((my $userinput=GetRequest) && $KeepGoing) {      my $user_input;
  $KeepGoing = ProcessRequest($userinput);              my $clienthost = &Apache::lonnet::hostname($clientname);
 # -------------------------------------------------------------------- complete              my $clientserverhomeID = &Apache::lonnet::get_server_homeID($clienthost);
               $clienthomedom = &Apache::lonnet::host_domain($clientserverhomeID);
  &status('Listening to '.$clientname);      while(($user_input = get_request) && $keep_going) {
    alarm(120);
    Debug("Main: Got $user_input\n");
    $keep_going = &process_request($user_input);
    alarm(0);
    &status('Listening to '.$clientname." ($keymode)");   
     }      }
   
 # --------------------------------------------- client unknown or fishy, refuse  # --------------------------------------------- client unknown or fishy, refuse
  } else {   }  else {
     print $client "refused\n";      print $client "refused\n";
     $client->close();      $client->close();
     &logthis("<font color=blue>WARNING: "      &logthis("<font color='blue'>WARNING: "
      ."Rejected client $clientip, closing connection</font>");       ."Rejected client $clientip, closing connection</font>");
  }   }
     }                   }            
           
 # =============================================================================  # =============================================================================
           
     &logthis("<font color=red>CRITICAL: "      &logthis("<font color='red'>CRITICAL: "
      ."Disconnect from $clientip ($clientname)</font>");           ."Disconnect from $clientip ($clientname)</font>");    
           
           
Line 3930  sub make_new_child { Line 6678  sub make_new_child {
     exit;      exit;
           
 }  }
   #
   #   Determine if a user is an author for the indicated domain.
   #
   # Parameters:
   #    domain          - domain to check in .
   #    user            - Name of user to check.
   #
   # Return:
   #     1             - User is an author for domain.
   #     0             - User is not an author for domain.
   sub is_author {
       my ($domain, $user) = @_;
   
       &Debug("is_author: $user @ $domain");
   
       my $hashref = &tie_user_hash($domain, $user, "roles",
    &GDBM_READER());
   
       #  Author role should show up as a key /domain/_au
   
       my $value;
       if ($hashref) {
   
    my $key    = "/$domain/_au";
    if (defined($hashref)) {
       $value = $hashref->{$key};
       if(!untie_user_hash($hashref)) {
    return 'error: ' .  ($!+0)." untie (GDBM) Failed";
       }
    }
   
    if(defined($value)) {
       &Debug("$user @ $domain is an author");
    }
       } else {
    return 'error: '.($!+0)." tie (GDBM) Failed";
       }
   
       return defined($value);
   }
 #  #
 #   Checks to see if the input roleput request was to set  #   Checks to see if the input roleput request was to set
 # an author role.  If so, invokes the lchtmldir script to set  # an author role.  If so, creates construction space 
 # up a correct public_html   
 # Parameters:  # Parameters:
 #    request   - The request sent to the rolesput subchunk.  #    request   - The request sent to the rolesput subchunk.
 #                We're looking for  /domain/_au  #                We're looking for  /domain/_au
Line 3943  sub make_new_child { Line 6728  sub make_new_child {
 #    user      - Name of the user for which the role is being put.  #    user      - Name of the user for which the role is being put.
 #    authtype  - The authentication type associated with the user.  #    authtype  - The authentication type associated with the user.
 #  #
 sub ManagePermissions  sub manage_permissions {
 {      my ($request, $domain, $user, $authtype) = @_;
     my $request = shift;  
     my $domain  = shift;  
     my $user    = shift;  
     my $authtype= shift;  
   
     # See if the request is of the form /$domain/_au      # See if the request is of the form /$domain/_au
     &logthis("ruequest is $request");      if($request =~ /^(\/\Q$domain\E\/_au)$/) { # It's an author rolesput...
     if($request =~ /^(\/$domain\/_au)$/) { # It's an author rolesput...          my $path=$perlvar{'lonDocRoot'}."/priv/$domain";
  my $execdir = $perlvar{'lonDaemons'};          unless (-e $path) {        
  my $userhome= "/home/$user" ;             mkdir($path);
  &logthis("system $execdir/lchtmldir $userhome $user $authtype");          }
  system("$execdir/lchtmldir $userhome $user $authtype");          unless (-e $path.'/'.$user) {
              mkdir($path.'/'.$user);
           }
     }      }
 }  }
   
   
   #
   #  Return the full path of a user password file, whether it exists or not.
   # Parameters:
   #   domain     - Domain in which the password file lives.
   #   user       - name of the user.
   # Returns:
   #    Full passwd path:
   #
   sub password_path {
       my ($domain, $user) = @_;
       return &propath($domain, $user).'/passwd';
   }
   
   #   Password Filename
   #   Returns the path to a passwd file given domain and user... only if
   #  it exists.
   # Parameters:
   #   domain    - Domain in which to search.
   #   user      - username.
   # Returns:
   #   - If the password file exists returns its path.
   #   - If the password file does not exist, returns undefined.
 #  #
 #   GetAuthType - Determines the authorization type of a user in a domain.  sub password_filename {
       my ($domain, $user) = @_;
   
       Debug ("PasswordFilename called: dom = $domain user = $user");
   
       my $path  = &password_path($domain, $user);
       Debug("PasswordFilename got path: $path");
       if(-e $path) {
    return $path;
       } else {
    return undef;
       }
   }
   
   #
   #   Rewrite the contents of the user's passwd file.
   #  Parameters:
   #    domain    - domain of the user.
   #    name      - User's name.
   #    contents  - New contents of the file.
   # Returns:
   #   0    - Failed.
   #   1    - Success.
   #
   sub rewrite_password_file {
       my ($domain, $user, $contents) = @_;
   
       my $file = &password_filename($domain, $user);
       if (defined $file) {
    my $pf = IO::File->new(">$file");
    if($pf) {
       print $pf "$contents\n";
       return 1;
    } else {
       return 0;
    }
       } else {
    return 0;
       }
   
   }
   
   #
   #   get_auth_type - Determines the authorization type of a user in a domain.
   
 #     Returns the authorization type or nouser if there is no such user.  #     Returns the authorization type or nouser if there is no such user.
 #  #
 sub GetAuthType   sub get_auth_type {
 {      my ($domain, $user)  = @_;
     my $domain = shift;  
     my $user   = shift;  
   
     Debug("GetAuthType( $domain, $user ) \n");      Debug("get_auth_type( $domain, $user ) \n");
     my $proname    = &propath($domain, $user);       my $proname    = &propath($domain, $user); 
     my $passwdfile = "$proname/passwd";      my $passwdfile = "$proname/passwd";
     if( -e $passwdfile ) {      if( -e $passwdfile ) {
Line 3979  sub GetAuthType Line 6826  sub GetAuthType
  Debug("Password info = $realpassword\n");   Debug("Password info = $realpassword\n");
  my ($authtype, $contentpwd) = split(/:/, $realpassword);   my ($authtype, $contentpwd) = split(/:/, $realpassword);
  Debug("Authtype = $authtype, content = $contentpwd\n");   Debug("Authtype = $authtype, content = $contentpwd\n");
  my $availinfo = '';   return "$authtype:$contentpwd";     
  if($authtype eq 'krb4' or $authtype eq 'krb5') {      } else {
     $availinfo = $contentpwd;   Debug("Returning nouser");
    return "nouser";
       }
   }
   
   #
   #  Validate a user given their domain, name and password.  This utility
   #  function is used by both  AuthenticateHandler and ChangePasswordHandler
   #  to validate the login credentials of a user.
   # Parameters:
   #    $domain    - The domain being logged into (this is required due to
   #                 the capability for multihomed systems.
   #    $user      - The name of the user being validated.
   #    $password  - The user's propoposed password.
   #
   # Returns:
   #     1        - The domain,user,pasword triplet corresponds to a valid
   #                user.
   #     0        - The domain,user,password triplet is not a valid user.
   #
   sub validate_user {
       my ($domain, $user, $password, $checkdefauth) = @_;
   
       # Why negative ~pi you may well ask?  Well this function is about
       # authentication, and therefore very important to get right.
       # I've initialized the flag that determines whether or not I've 
       # validated correctly to a value it's not supposed to get.
       # At the end of this function. I'll ensure that it's not still that
       # value so we don't just wind up returning some accidental value
       # as a result of executing an unforseen code path that
       # did not set $validated.  At the end of valid execution paths,
       # validated shoule be 1 for success or 0 for failuer.
   
       my $validated = -3.14159;
   
       #  How we authenticate is determined by the type of authentication
       #  the user has been assigned.  If the authentication type is
       #  "nouser", the user does not exist so we will return 0.
   
       my $contents = &get_auth_type($domain, $user);
       my ($howpwd, $contentpwd) = split(/:/, $contents);
   
       my $null = pack("C",0); # Used by kerberos auth types.
   
       if ($howpwd eq 'nouser') {
           if ($checkdefauth) {
               my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
               if ($domdefaults{'auth_def'} eq 'localauth') {
                   $howpwd = $domdefaults{'auth_def'};
                   $contentpwd = $domdefaults{'auth_arg_def'};
               } elsif ((($domdefaults{'auth_def'} eq 'krb4') || 
                         ($domdefaults{'auth_def'} eq 'krb5')) &&
                        ($domdefaults{'auth_arg_def'} ne '')) {
                   $howpwd = $domdefaults{'auth_def'};
                   $contentpwd = $domdefaults{'auth_arg_def'}; 
               }
           }
       } 
       if ($howpwd ne 'nouser') {
    if($howpwd eq "internal") { # Encrypted is in local password file.
       $validated = (crypt($password, $contentpwd) eq $contentpwd);
    }
    elsif ($howpwd eq "unix") { # User is a normal unix user.
       $contentpwd = (getpwnam($user))[1];
       if($contentpwd) {
    if($contentpwd eq 'x') { # Shadow password file...
       my $pwauth_path = "/usr/local/sbin/pwauth";
       open PWAUTH,  "|$pwauth_path" or
    die "Cannot invoke authentication";
       print PWAUTH "$user\n$password\n";
       close PWAUTH;
       $validated = ! $?;
   
    } else {         # Passwords in /etc/passwd. 
       $validated = (crypt($password,
    $contentpwd) eq $contentpwd);
    }
       } else {
    $validated = 0;
       }
    } elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
               my $checkwithkrb5 = 0;
               if ($dist =~/^fedora(\d+)$/) {
                   if ($1 > 11) {
                       $checkwithkrb5 = 1;
                   }
               } elsif ($dist =~ /^suse([\d.]+)$/) {
                   if ($1 > 11.1) {
                       $checkwithkrb5 = 1; 
                   }
               }
               if ($checkwithkrb5) {
                   $validated = &krb5_authen($password,$null,$user,$contentpwd);
               } else {
                   $validated = &krb4_authen($password,$null,$user,$contentpwd);
               }
    } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
               $validated = &krb5_authen($password,$null,$user,$contentpwd);
    } elsif ($howpwd eq "localauth") { 
       #  Authenticate via installation specific authentcation method:
       $validated = &localauth::localauth($user, 
          $password, 
          $contentpwd,
          $domain);
       if ($validated < 0) {
    &logthis("localauth for $contentpwd $user:$domain returned a $validated");
    $validated = 0;
       }
    } else { # Unrecognized auth is also bad.
       $validated = 0;
  }   }
       } else {
    $validated = 0;
       }
       #
       #  $validated has the correct stat of the authentication:
       #
   
  return "$authtype:$availinfo";      unless ($validated != -3.14159) {
    #  I >really really< want to know if this happens.
    #  since it indicates that user authentication is badly
    #  broken in some code path.
           #
    die "ValidateUser - failed to set the value of validated $domain, $user $password";
       }
       return $validated;
   }
   
   sub krb4_authen {
       my ($password,$null,$user,$contentpwd) = @_;
       my $validated = 0;
       if (!($password =~ /$null/) ) {  # Null password not allowed.
           eval {
               require Authen::Krb4;
           };
           if (!$@) {
               my $k4error = &Authen::Krb4::get_pw_in_tkt($user,
                                                          "",
                                                          $contentpwd,,
                                                          'krbtgt',
                                                          $contentpwd,
                                                          1,
                                                          $password);
               if(!$k4error) {
                   $validated = 1;
               } else {
                   $validated = 0;
                   &logthis('krb4: '.$user.', '.$contentpwd.', '.
                             &Authen::Krb4::get_err_txt($Authen::Krb4::error));
               }
           } else {
               $validated = krb5_authen($password,$null,$user,$contentpwd);
           }
     }      }
     else {      return $validated;
  Debug("Returning nouser");  }
  return "nouser";  
   sub krb5_authen {
       my ($password,$null,$user,$contentpwd) = @_;
       my $validated = 0;
       if(!($password =~ /$null/)) { # Null password not allowed.
           my $krbclient = &Authen::Krb5::parse_name($user.'@'
                                                     .$contentpwd);
           my $krbservice = "krbtgt/".$contentpwd."\@".$contentpwd;
           my $krbserver  = &Authen::Krb5::parse_name($krbservice);
           my $credentials= &Authen::Krb5::cc_default();
           $credentials->initialize(&Authen::Krb5::parse_name($user.'@'
                                                               .$contentpwd));
           my $krbreturn;
           if (exists(&Authen::Krb5::get_init_creds_password)) {
               $krbreturn =
                   &Authen::Krb5::get_init_creds_password($krbclient,$password,
                                                             $krbservice);
               $validated = (ref($krbreturn) eq 'Authen::Krb5::Creds');
           } else {
               $krbreturn  =
                   &Authen::Krb5::get_in_tkt_with_password($krbclient,$krbserver,
                                                            $password,$credentials);
               $validated = ($krbreturn == 1);
           }
           if (!$validated) {
               &logthis('krb5: '.$user.', '.$contentpwd.', '.
                        &Authen::Krb5::error());
           }
     }      }
       return $validated;
 }  }
   
 sub addline {  sub addline {
     my ($fname,$hostid,$ip,$newline)=@_;      my ($fname,$hostid,$ip,$newline)=@_;
     my $contents;      my $contents;
     my $found=0;      my $found=0;
     my $expr='^'.$hostid.':'.$ip.':';      my $expr='^'.quotemeta($hostid).':'.quotemeta($ip).':';
     $expr =~ s/\./\\\./g;  
     my $sh;      my $sh;
     if ($sh=IO::File->new("$fname.subscription")) {      if ($sh=IO::File->new("$fname.subscription")) {
  while (my $subline=<$sh>) {   while (my $subline=<$sh>) {
Line 4012  sub addline { Line 7035  sub addline {
     return $found;      return $found;
 }  }
   
 sub getchat {  sub get_chat {
     my ($cdom,$cname,$udom,$uname)=@_;      my ($cdom,$cname,$udom,$uname,$group)=@_;
     my %hash;  
     my $proname=&propath($cdom,$cname);  
     my @entries=();      my @entries=();
     if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",      my $namespace = 'nohist_chatroom';
     &GDBM_READER(),0640)) {      my $namespace_inroom = 'nohist_inchatroom';
  @entries=map { $_.':'.$hash{$_} } sort keys %hash;      if ($group ne '') {
  untie %hash;          $namespace .= '_'.$group;
           $namespace_inroom .= '_'.$group;
       }
       my $hashref = &tie_user_hash($cdom, $cname, $namespace,
    &GDBM_READER());
       if ($hashref) {
    @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
    &untie_user_hash($hashref);
     }      }
     my @participants=();      my @participants=();
     my $cutoff=time-60;      my $cutoff=time-60;
     if (tie(%hash,'GDBM_File',"$proname/nohist_inchatroom.db",      $hashref = &tie_user_hash($cdom, $cname, $namespace_inroom,
     &GDBM_WRCREAT(),0640)) {        &GDBM_WRCREAT());
         $hash{$uname.':'.$udom}=time;      if ($hashref) {
         foreach (sort keys %hash) {          $hashref->{$uname.':'.$udom}=time;
     if ($hash{$_}>$cutoff) {          foreach my $user (sort(keys(%$hashref))) {
  $participants[$#participants+1]='active_participant:'.$_;      if ($hashref->{$user}>$cutoff) {
    push(@participants, 'active_participant:'.$user);
             }              }
         }          }
         untie %hash;          &untie_user_hash($hashref);
     }      }
     return (@participants,@entries);      return (@participants,@entries);
 }  }
   
 sub chatadd {  sub chat_add {
     my ($cdom,$cname,$newchat)=@_;      my ($cdom,$cname,$newchat,$group)=@_;
     my %hash;  
     my $proname=&propath($cdom,$cname);  
     my @entries=();      my @entries=();
     my $time=time;      my $time=time;
     if (tie(%hash,'GDBM_File',"$proname/nohist_chatroom.db",      my $namespace = 'nohist_chatroom';
     &GDBM_WRCREAT(),0640)) {      my $logfile = 'chatroom.log';
  @entries=map { $_.':'.$hash{$_} } sort keys %hash;      if ($group ne '') {
           $namespace .= '_'.$group;
           $logfile = 'chatroom_'.$group.'.log';
       }
       my $hashref = &tie_user_hash($cdom, $cname, $namespace,
    &GDBM_WRCREAT());
       if ($hashref) {
    @entries=map { $_.':'.$hashref->{$_} } sort(keys(%$hashref));
  my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);   my ($lastid)=($entries[$#entries]=~/^(\w+)\:/);
  my ($thentime,$idnum)=split(/\_/,$lastid);   my ($thentime,$idnum)=split(/\_/,$lastid);
  my $newid=$time.'_000000';   my $newid=$time.'_000000';
Line 4055  sub chatadd { Line 7090  sub chatadd {
     $idnum=substr('000000'.$idnum,-6,6);      $idnum=substr('000000'.$idnum,-6,6);
     $newid=$time.'_'.$idnum;      $newid=$time.'_'.$idnum;
  }   }
  $hash{$newid}=$newchat;   $hashref->{$newid}=$newchat;
  my $expired=$time-3600;   my $expired=$time-3600;
  foreach (keys %hash) {   foreach my $comment (keys(%$hashref)) {
     my ($thistime)=($_=~/(\d+)\_/);      my ($thistime) = ($comment=~/(\d+)\_/);
     if ($thistime<$expired) {      if ($thistime<$expired) {
  delete $hash{$_};   delete $hashref->{$comment};
     }      }
  }   }
  untie %hash;   {
     }      my $proname=&propath($cdom,$cname);
     {      if (open(CHATLOG,">>$proname/$logfile")) { 
  my $hfh;   print CHATLOG ("$time:".&unescape($newchat)."\n");
  if ($hfh=IO::File->new(">>$proname/chatroom.log")) {       }
     print $hfh "$time:".&unescape($newchat)."\n";      close(CHATLOG);
  }   }
    &untie_user_hash($hashref);
     }      }
 }  }
   
 sub unsub {  sub unsub {
     my ($fname,$clientip)=@_;      my ($fname,$clientip)=@_;
     my $result;      my $result;
       my $unsubs = 0; # Number of successful unsubscribes:
   
   
       # An old way subscriptions were handled was to have a 
       # subscription marker file:
   
       Debug("Attempting unlink of $fname.$clientname");
     if (unlink("$fname.$clientname")) {      if (unlink("$fname.$clientname")) {
  $result="ok\n";   $unsubs++; # Successful unsub via marker file.
     } else {      } 
  $result="not_subscribed\n";  
     }      # The more modern way to do it is to have a subscription list
       # file:
   
     if (-e "$fname.subscription") {      if (-e "$fname.subscription") {
  my $found=&addline($fname,$clientname,$clientip,'');   my $found=&addline($fname,$clientname,$clientip,'');
  if ($found) { $result="ok\n"; }   if ($found) { 
       $unsubs++;
    }
       } 
   
       #  If either or both of these mechanisms succeeded in unsubscribing a 
       #  resource we can return ok:
   
       if($unsubs) {
    $result = "ok\n";
     } else {      } else {
  if ($result != "ok\n") { $result="not_subscribed\n"; }   $result = "not_subscribed\n";
     }      }
   
     return $result;      return $result;
 }  }
   
Line 4139  sub thisversion { Line 7194  sub thisversion {
 sub subscribe {  sub subscribe {
     my ($userinput,$clientip)=@_;      my ($userinput,$clientip)=@_;
     my $result;      my $result;
     my ($cmd,$fname)=split(/:/,$userinput);      my ($cmd,$fname)=split(/:/,$userinput,2);
     my $ownership=&ishome($fname);      my $ownership=&ishome($fname);
     if ($ownership eq 'owner') {      if ($ownership eq 'owner') {
 # explitly asking for the current version?  # explitly asking for the current version?
Line 4172  sub subscribe { Line 7227  sub subscribe {
                 # the metadata                  # the metadata
  unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }   unless ($fname=~/\.meta$/) { &unsub("$fname.meta",$clientip); }
  $fname=~s/\/home\/httpd\/html\/res/raw/;   $fname=~s/\/home\/httpd\/html\/res/raw/;
  $fname="http://$thisserver/".$fname;                  my $protocol = $Apache::lonnet::protocol{$perlvar{'lonHostID'}};
                   $protocol = 'http' if ($protocol ne 'https');
    $fname=$protocol.'://'.&Apache::lonnet::hostname($perlvar{'lonHostID'})."/".$fname;
  $result="$fname\n";   $result="$fname\n";
     }      }
  } else {   } else {
Line 4183  sub subscribe { Line 7240  sub subscribe {
     }      }
     return $result;      return $result;
 }  }
   #  Change the passwd of a unix user.  The caller must have
   #  first verified that the user is a loncapa user.
   #
   # Parameters:
   #    user      - Unix user name to change.
   #    pass      - New password for the user.
   # Returns:
   #    ok    - if success
   #    other - Some meaningfule error message string.
   # NOTE:
   #    invokes a setuid script to change the passwd.
   sub change_unix_password {
       my ($user, $pass) = @_;
   
       &Debug("change_unix_password");
       my $execdir=$perlvar{'lonDaemons'};
       &Debug("Opening lcpasswd pipeline");
       my $pf = IO::File->new("|$execdir/lcpasswd > "
      ."$perlvar{'lonDaemons'}"
      ."/logs/lcpasswd.log");
       print $pf "$user\n$pass\n$pass\n";
       close $pf;
       my $err = $?;
       return ($err < @passwderrors) ? $passwderrors[$err] : 
    "pwchange_falure - unknown error";
   
       
   }
   
   
 sub make_passwd_file {  sub make_passwd_file {
     my ($uname, $umode,$npass,$passfilename)=@_;      my ($uname,$udom,$umode,$npass,$passfilename)=@_;
     my $result="ok\n";      my $result="ok";
     if ($umode eq 'krb4' or $umode eq 'krb5') {      if ($umode eq 'krb4' or $umode eq 'krb5') {
  {   {
     my $pf = IO::File->new(">$passfilename");      my $pf = IO::File->new(">$passfilename");
     print $pf "$umode:$npass\n";      if ($pf) {
    print $pf "$umode:$npass\n";
       } else {
    $result = "pass_file_failed_error";
       }
  }   }
     } elsif ($umode eq 'internal') {      } elsif ($umode eq 'internal') {
  my $salt=time;   my $salt=time;
Line 4199  sub make_passwd_file { Line 7289  sub make_passwd_file {
  {   {
     &Debug("Creating internal auth");      &Debug("Creating internal auth");
     my $pf = IO::File->new(">$passfilename");      my $pf = IO::File->new(">$passfilename");
     print $pf "internal:$ncpass\n";       if($pf) {
    print $pf "internal:$ncpass\n"; 
       } else {
    $result = "pass_file_failed_error";
       }
  }   }
     } elsif ($umode eq 'localauth') {      } elsif ($umode eq 'localauth') {
  {   {
     my $pf = IO::File->new(">$passfilename");      my $pf = IO::File->new(">$passfilename");
     print $pf "localauth:$npass\n";      if($pf) {
  }   print $pf "localauth:$npass\n";
     } elsif ($umode eq 'unix') {      } else {
  {   $result = "pass_file_failed_error";
     my $execpath="$perlvar{'lonDaemons'}/"."lcuseradd";  
     {  
  &Debug("Executing external: ".$execpath);  
  &Debug("user  = ".$uname.", Password =". $npass);  
  my $se = IO::File->new("|$execpath > $perlvar{'lonDaemons'}/logs/lcuseradd.log");  
  print $se "$uname\n";  
  print $se "$npass\n";  
  print $se "$npass\n";  
     }  
     my $useraddok = $?;  
     if($useraddok > 0) {  
  &logthis("Failed lcuseradd: ".&lcuseraddstrerror($useraddok));  
     }      }
     my $pf = IO::File->new(">$passfilename");  
     print $pf "unix:\n";  
  }   }
       } elsif ($umode eq 'unix') {
    &logthis(">>>Attempt to create unix account blocked -- unix auth not available for new users.");
    $result="no_new_unix_accounts";
     } elsif ($umode eq 'none') {      } elsif ($umode eq 'none') {
  {   {
     my $pf = IO::File->new(">$passfilename");      my $pf = IO::File->new("> $passfilename");
     print $pf "none:\n";      if($pf) {
    print $pf "none:\n";
       } else {
    $result = "pass_file_failed_error";
       }
  }   }
     } else {      } else {
  $result="auth_mode_error\n";   $result="auth_mode_error";
     }      }
     return $result;      return $result;
 }  }
   
   sub convert_photo {
       my ($start,$dest)=@_;
       system("convert $start $dest");
   }
   
 sub sethost {  sub sethost {
     my ($remotereq) = @_;      my ($remotereq) = @_;
     my (undef,$hostid)=split(/:/,$remotereq);      my (undef,$hostid)=split(/:/,$remotereq);
       # ignore sethost if we are already correct
       if ($hostid eq $currenthostid) {
    return 'ok';
       }
   
     if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }      if (!defined($hostid)) { $hostid=$perlvar{'lonHostID'}; }
     if ($hostip{$perlvar{'lonHostID'}} eq $hostip{$hostid}) {      if (&Apache::lonnet::get_host_ip($perlvar{'lonHostID'}) 
  $currenthostid=$hostid;   eq &Apache::lonnet::get_host_ip($hostid)) {
  $currentdomainid=$hostdom{$hostid};   $currenthostid  =$hostid;
  &logthis("Setting hostid to $hostid, and domain to $currentdomainid");   $currentdomainid=&Apache::lonnet::host_domain($hostid);
   # &logthis("Setting hostid to $hostid, and domain to $currentdomainid");
     } else {      } else {
  &logthis("Requested host id $hostid not an alias of ".   &logthis("Requested host id $hostid not an alias of ".
  $perlvar{'lonHostID'}." refusing connection");   $perlvar{'lonHostID'}." refusing connection");
Line 4256  sub version { Line 7354  sub version {
     $remoteVERSION=(split(/:/,$userinput))[1];      $remoteVERSION=(split(/:/,$userinput))[1];
     return "version:$VERSION";      return "version:$VERSION";
 }  }
 ############## >>>>>>>>>>>>>>>>>>>>>>>>>> FUTUREWORK <<<<<<<<<<<<<<<<<<<<<<<<<<<<  
 #There is a copy of this in lonnet.pm  sub get_usersession_config {
 #   Can we hoist these lil' things out into common places?      my ($dom,$name) = @_;
 #      my ($usersessionconf,$cached)=&Apache::lonnet::is_cached_new($name,$dom);
 sub userload {      if (defined($cached)) {
     my $numusers=0;          return $usersessionconf;
     {      } else {
  opendir(LONIDS,$perlvar{'lonIDsDir'});          my %domconfig = &Apache::lonnet::get_dom('configuration',['usersessions'],$dom);
  my $filename;          if (ref($domconfig{'usersessions'}) eq 'HASH') {
  my $curtime=time;              &Apache::lonnet::do_cache_new($name,$dom,$domconfig{'usersessions'},3600);
  while ($filename=readdir(LONIDS)) {              return $domconfig{'usersessions'};
     if ($filename eq '.' || $filename eq '..') {next;}          }
     my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];  
     if ($curtime-$mtime < 1800) { $numusers++; }  
  }  
  closedir(LONIDS);  
     }  
     my $userloadpercent=0;  
     my $maxuserload=$perlvar{'lonUserLoadLim'};  
     if ($maxuserload) {  
  $userloadpercent=100*$numusers/$maxuserload;  
     }      }
     $userloadpercent=sprintf("%.2f",$userloadpercent);      return;
     return $userloadpercent;  }
   
   
   
   
   sub distro_and_arch {
       return $dist.':'.$arch;
 }  }
   
 # ----------------------------------- POD (plain old documentation, CPAN style)  # ----------------------------------- POD (plain old documentation, CPAN style)
Line 4597  to the client, and the connection is clo Line 7692  to the client, and the connection is clo
 IO::Socket  IO::Socket
 IO::File  IO::File
 Apache::File  Apache::File
 Symbol  
 POSIX  POSIX
 Crypt::IDEA  Crypt::IDEA
 LWP::UserAgent()  LWP::UserAgent()
Line 4607  Authen::Krb5 Line 7701  Authen::Krb5
   
 =head1 COREQUISITES  =head1 COREQUISITES
   
   none
   
 =head1 OSNAMES  =head1 OSNAMES
   
 linux  linux
Line 4616  linux Line 7712  linux
 Server/Process  Server/Process
   
 =cut  =cut
   
   
   =pod
   
   =head1 LOG MESSAGES
   
   The messages below can be emitted in the lond log.  This log is located
   in ~httpd/perl/logs/lond.log  Many log messages have HTML encapsulation
   to provide coloring if examined from inside a web page. Some do not.
   Where color is used, the colors are; Red for sometihhng to get excited
   about and to follow up on. Yellow for something to keep an eye on to
   be sure it does not get worse, Green,and Blue for informational items.
   
   In the discussions below, sometimes reference is made to ~httpd
   when describing file locations.  There isn't really an httpd 
   user, however there is an httpd directory that gets installed in the
   place that user home directories go.  On linux, this is usually
   (always?) /home/httpd.
   
   
   Some messages are colorless.  These are usually (not always)
   Green/Blue color level messages.
   
   =over 2
   
   =item (Red)  LocalConnection rejecting non local: <ip> ne 127.0.0.1
   
   A local connection negotiation was attempted by
   a host whose IP address was not 127.0.0.1.
   The socket is closed and the child will exit.
   lond has three ways to establish an encyrption
   key with a client:
   
   =over 2
   
   =item local 
   
   The key is written and read from a file.
   This is only valid for connections from localhost.
   
   =item insecure 
   
   The key is generated by the server and
   transmitted to the client.
   
   =item  ssl (secure)
   
   An ssl connection is negotiated with the client,
   the key is generated by the server and sent to the 
   client across this ssl connection before the
   ssl connectionis terminated and clear text
   transmission resumes.
   
   =back
   
   =item (Red) LocalConnection: caller is insane! init = <init> and type = <type>
   
   The client is local but has not sent an initialization
   string that is the literal "init:local"  The connection
   is closed and the child exits.
   
   =item Red CRITICAL Can't get key file <error>        
   
   SSL key negotiation is being attempted but the call to
   lonssl::KeyFile  failed.  This usually means that the
   configuration file is not correctly defining or protecting
   the directories/files lonCertificateDirectory or
   lonnetPrivateKey
   <error> is a string that describes the reason that
   the key file could not be located.
   
   =item (Red) CRITICAL  Can't get certificates <error>  
   
   SSL key negotiation failed because we were not able to retrives our certificate
   or the CA's certificate in the call to lonssl::CertificateFile
   <error> is the textual reason this failed.  Usual reasons:
   
   =over 2
   
   =item Apache config file for loncapa  incorrect:
   
   one of the variables 
   lonCertificateDirectory, lonnetCertificateAuthority, or lonnetCertificate
   undefined or incorrect
   
   =item Permission error:
   
   The directory pointed to by lonCertificateDirectory is not readable by lond
   
   =item Permission error:
   
   Files in the directory pointed to by lonCertificateDirectory are not readable by lond.
   
   =item Installation error:                         
   
   Either the certificate authority file or the certificate have not
   been installed in lonCertificateDirectory.
   
   =item (Red) CRITICAL SSL Socket promotion failed:  <err> 
   
   The promotion of the connection from plaintext to SSL failed
   <err> is the reason for the failure.  There are two
   system calls involved in the promotion (one of which failed), 
   a dup to produce
   a second fd on the raw socket over which the encrypted data
   will flow and IO::SOcket::SSL->new_from_fd which creates
   the SSL connection on the duped fd.
   
   =item (Blue)   WARNING client did not respond to challenge 
   
   This occurs on an insecure (non SSL) connection negotiation request.
   lond generates some number from the time, the PID and sends it to
   the client.  The client must respond by echoing this information back.
   If the client does not do so, that's a violation of the challenge
   protocols and the connection will be failed.
   
   =item (Red) No manager table. Nobody can manage!!    
   
   lond has the concept of privileged hosts that
   can perform remote management function such
   as update the hosts.tab.   The manager hosts
   are described in the 
   ~httpd/lonTabs/managers.tab file.
   this message is logged if this file is missing.
   
   
   =item (Green) Registering manager <dnsname> as <cluster_name> with <ipaddress>
   
   Reports the successful parse and registration
   of a specific manager. 
   
   =item Green existing host <clustername:dnsname>  
   
   The manager host is already defined in the hosts.tab
   the information in that table, rather than the info in the
   manager table will be used to determine the manager's ip.
   
   =item (Red) Unable to craete <filename>                 
   
   lond has been asked to create new versions of an administrative
   file (by a manager).  When this is done, the new file is created
   in a temp file and then renamed into place so that there are always
   usable administrative files, even if the update fails.  This failure
   message means that the temp file could not be created.
   The update is abandoned, and the old file is available for use.
   
   =item (Green) CopyFile from <oldname> to <newname> failed
   
   In an update of administrative files, the copy of the existing file to a
   backup file failed.  The installation of the new file may still succeed,
   but there will not be a back up file to rever to (this should probably
   be yellow).
   
   =item (Green) Pushfile: backed up <oldname> to <newname>
   
   See above, the backup of the old administrative file succeeded.
   
   =item (Red)  Pushfile: Unable to install <filename> <reason>
   
   The new administrative file could not be installed.  In this case,
   the old administrative file is still in use.
   
   =item (Green) Installed new < filename>.                      
   
   The new administrative file was successfullly installed.                                               
   
   =item (Red) Reinitializing lond pid=<pid>                    
   
   The lonc child process <pid> will be sent a USR2 
   signal.
   
   =item (Red) Reinitializing self                                    
   
   We've been asked to re-read our administrative files,and
   are doing so.
   
   =item (Yellow) error:Invalid process identifier <ident>  
   
   A reinit command was received, but the target part of the 
   command was not valid.  It must be either
   'lond' or 'lonc' but was <ident>
   
   =item (Green) isValideditCommand checking: Command = <command> Key = <key> newline = <newline>
   
   Checking to see if lond has been handed a valid edit
   command.  It is possible the edit command is not valid
   in that case there are no log messages to indicate that.
   
   =item Result of password change for  <username> pwchange_success
   
   The password for <username> was
   successfully changed.
   
   =item Unable to open <user> passwd to change password
   
   Could not rewrite the 
   internal password file for a user
   
   =item Result of password change for <user> : <result>
   
   A unix password change for <user> was attempted 
   and the pipe returned <result>  
   
   =item LWP GET: <message> for <fname> (<remoteurl>)
   
   The lightweight process fetch for a resource failed
   with <message> the local filename that should
   have existed/been created was  <fname> the
   corresponding URI: <remoteurl>  This is emitted in several
   places.
   
   =item Unable to move <transname> to <destname>     
   
   From fetch_user_file_handler - the user file was replicated but could not
   be mv'd to its final location.
   
   =item Looking for <domain> <username>              
   
   From user_has_session_handler - This should be a Debug call instead
   it indicates lond is about to check whether the specified user has a 
   session active on the specified domain on the local host.
   
   =item Client <ip> (<name>) hanging up: <input>     
   
   lond has been asked to exit by its client.  The <ip> and <name> identify the
   client systemand <input> is the full exit command sent to the server.
   
   =item Red CRITICAL: ABNORMAL EXIT. child <pid> for server <hostname> died through a crass with this error->[<message>].
   
   A lond child terminated.  NOte that this termination can also occur when the
   child receives the QUIT or DIE signals.  <pid> is the process id of the child,
   <hostname> the host lond is working for, and <message> the reason the child died
   to the best of our ability to get it (I would guess that any numeric value
   represents and errno value).  This is immediately followed by
   
   =item  Famous last words: Catching exception - <log> 
   
   Where log is some recent information about the state of the child.
   
   =item Red CRITICAL: TIME OUT <pid>                     
   
   Some timeout occured for server <pid>.  THis is normally a timeout on an LWP
   doing an HTTP::GET.
   
   =item child <pid> died                              
   
   The reaper caught a SIGCHILD for the lond child process <pid>
   This should be modified to also display the IP of the dying child
   $children{$pid}
   
   =item Unknown child 0 died                           
   A child died but the wait for it returned a pid of zero which really should not
   ever happen. 
   
   =item Child <which> - <pid> looks like we missed it's death 
   
   When a sigchild is received, the reaper process checks all children to see if they are
   alive.  If children are dying quite quickly, the lack of signal queuing can mean
   that a signal hearalds the death of more than one child.  If so this message indicates
   which other one died. <which> is the ip of a dead child
   
   =item Free socket: <shutdownretval>                
   
   The HUNTSMAN sub was called due to a SIGINT in a child process.  The socket is being shutdown.
   for whatever reason, <shutdownretval> is printed but in fact shutdown() is not documented
   to return anything. This is followed by: 
   
   =item Red CRITICAL: Shutting down                       
   
   Just prior to exit.
   
   =item Free socket: <shutdownretval>                 
   
   The HUPSMAN sub was called due to a SIGHUP.  all children get killsed, and lond execs itself.
   This is followed by:
   
   =item (Red) CRITICAL: Restarting                         
   
   lond is about to exec itself to restart.
   
   =item (Blue) Updating connections                        
   
   (In response to a USR2).  All the children (except the one for localhost)
   are about to be killed, the hosts tab reread, and Apache reloaded via apachereload.
   
   =item (Blue) UpdateHosts killing child <pid> for ip <ip>   
   
   Due to USR2 as above.
   
   =item (Green) keeping child for ip <ip> (pid = <pid>)    
   
   In response to USR2 as above, the child indicated is not being restarted because
   it's assumed that we'll always need a child for the localhost.
   
   
   =item Going to check on the children                
   
   Parent is about to check on the health of the child processes.
   Note that this is in response to a USR1 sent to the parent lond.
   there may be one or more of the next two messages:
   
   =item <pid> is dead                                 
   
   A child that we have in our child hash as alive has evidently died.
   
   =item  Child <pid> did not respond                   
   
   In the health check the child <pid> did not update/produce a pid_.txt
   file when sent it's USR1 signal.  That process is killed with a 9 signal, as it's
   assumed to be hung in some un-fixable way.
   
   =item Finished checking children                   
   
   Master processs's USR1 processing is cojmplete.
   
   =item (Red) CRITICAL: ------- Starting ------            
   
   (There are more '-'s on either side).  Lond has forked itself off to 
   form a new session and is about to start actual initialization.
   
   =item (Green) Attempting to start child (<client>)       
   
   Started a new child process for <client>.  Client is IO::Socket object
   connected to the child.  This was as a result of a TCP/IP connection from a client.
   
   =item Unable to determine who caller was, getpeername returned nothing
   
   In child process initialization.  either getpeername returned undef or
   a zero sized object was returned.  Processing continues, but in my opinion,
   this should be cause for the child to exit.
   
   =item Unable to determine clientip                  
   
   In child process initialization.  The peer address from getpeername was not defined.
   The client address is stored as "Unavailable" and processing continues.
   
   =item (Yellow) INFO: Connection <ip> <name> connection type = <type>
   
   In child initialization.  A good connectionw as received from <ip>.
   
   =over 2
   
   =item <name> 
   
   is the name of the client from hosts.tab.
   
   =item <type> 
   
   Is the connection type which is either 
   
   =over 2
   
   =item manager 
   
   The connection is from a manager node, not in hosts.tab
   
   =item client  
   
   the connection is from a non-manager in the hosts.tab
   
   =item both
   
   The connection is from a manager in the hosts.tab.
   
   =back
   
   =back
   
   =item (Blue) Certificates not installed -- trying insecure auth
   
   One of the certificate file, key file or
   certificate authority file could not be found for a client attempting
   SSL connection intiation.  COnnection will be attemptied in in-secure mode.
   (this would be a system with an up to date lond that has not gotten a 
   certificate from us).
   
   =item (Green)  Successful local authentication            
   
   A local connection successfully negotiated the encryption key. 
   In this case the IDEA key is in a file (that is hopefully well protected).
   
   =item (Green) Successful ssl authentication with <client>  
   
   The client (<client> is the peer's name in hosts.tab), has successfully
   negotiated an SSL connection with this child process.
   
   =item (Green) Successful insecure authentication with <client>
   
   
   The client has successfully negotiated an  insecure connection withthe child process.
   
   =item (Yellow) Attempted insecure connection disallowed    
   
   The client attempted and failed to successfully negotiate a successful insecure
   connection.  This can happen either because the variable londAllowInsecure is false
   or undefined, or becuse the child did not successfully echo back the challenge
   string.
   
   
   =back
   
   =back
   
   
   =cut
Removed from v.1.178.2.2  
changed lines
  Added in v.1.503

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