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

Diff for /loncom/lond between versions 1.178.2.18 and 1.581

version 1.178.2.18, 2004/04/19 11:32:35 version 1.581, 2024/06/22 14:29:36
Line 20 Line 20
 #  #
 # 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 31
   
 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 Socket;
 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 HTTP::Request;
   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;
   use Crypt::Eksblowfish::Bcrypt;
   use Digest::SHA;
   use Encode;
   use LONCAPA::LWPReq;
   
 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.  my $clientintdom;               # LonCAPA "internet domain" for client.
   my $clientsamedom;              # LonCAPA domain same for this host 
                                   # and client.
   my $clientsameinst;             # LonCAPA "internet domain" same for 
                                   # this host and client.
   my $clientremoteok;             # Current domain permits hosting on client
                                   # (not set if host and client share "internet domain").
                                   # Values are 0 or 1; 1 if allowed.
   my %clientprohibited;           # Commands from client prohibited for domain's
                                   # users.
   
 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 102  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 %secureconf;                 # Will have requirements for security 
                                   # of lond connections
   
   my %crlchecked;                 # Will contain clients for which the client's SSL
                                   # has been checked against the cluster's Certificate
                                   # Revocation List.
   
   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 128  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",  # The %trust hash classifies commands according to type of trust 
     "lcuseradd Could not add user.",  # required for execution of the command.
     "lcuseradd Password mismatch");  #
   # When clients from a different institution request execution of a
   # particular command, the trust settings for that institution set
   # for this domain (or default domain for a multi-domain server) will
   # be checked to see if running the command is allowed.
   #
   # Trust types which depend on the "Trust" domain configuration
   # for the machine's default domain are:
   #
   # content   ("Access to this domain's content by others")
   # shared    ("Access to other domain's content by this domain")
   # enroll    ("Enrollment in this domain's courses by others")
   # coaurem   ("Co-author roles for this domain's users elsewhere")
   # othcoau   ("Co-author roles in this domain for others")
   # domroles  ("Domain roles in this domain assignable to others")
   # catalog   ("Course Catalog for this domain displayed elsewhere")
   # reqcrs    ("Requests for creation of courses in this domain by others")
   # msg       ("Users in other domains can send messages to this domain")
   # 
   # Trust type which depends on the User Session Hosting (remote) 
   # domain configuration for machine's default domain is: "remote".
   #
   # Trust types which depend on contents of manager.tab in 
   # /home/httpd/lonTabs is: "manageronly".
   # 
   # Trust type which requires client to share the same LON-CAPA
   # "internet domain" (i.e., same institution as this server) is:
   # "institutiononly".
   #
   
   my %trust = (
                  auth => {remote => 1},
                  autocreatepassword => {remote => 1},
                  autocrsreqchecks => {remote => 1, reqcrs => 1},
                  autocrsrequpdate => {remote => 1},
                  autocrsreqvalidation => {remote => 1},
                  autogetsections => {remote => 1},
                  autoinstcodedefaults => {remote => 1, catalog => 1},
                  autoinstcodeformat => {remote => 1, catalog => 1},
                  autonewcourse => {remote => 1, reqcrs => 1},
                  autophotocheck => {remote => 1, enroll => 1},
                  autophotochoice => {remote => 1},
                  autophotopermission => {remote => 1, enroll => 1},
                  autopossibleinstcodes => {remote => 1, reqcrs => 1},
                  autoretrieve => {remote => 1, enroll => 1, catalog => 1},
                  autorun => {remote => 1, enroll => 1, reqcrs => 1},
                  autovalidateclass_sec => {catalog => 1},
                  autovalidatecourse => {remote => 1, enroll => 1},
                  autovalidateinstcode => {domroles => 1, remote => 1, enroll => 1},
                  autovalidateinstcrosslist => {remote => 1, enroll => 1},
                  autoinstsecreformat => {remote => 1, enroll => 1},
                  changeuserauth => {remote => 1, domroles => 1},
                  chatretr => {remote => 1, enroll => 1},
                  chatsend => {remote => 1, enroll => 1},
                  courseiddump => {remote => 1, domroles => 1, enroll => 1},
                  courseidput => {remote => 1, domroles => 1, enroll => 1},
                  courseidputhash => {remote => 1, domroles => 1, enroll => 1},
                  courselastaccess => {remote => 1, domroles => 1, enroll => 1},
                  coursesessions => {institutiononly => 1},
                  currentauth => {remote => 1, domroles => 1, enroll => 1},
                  currentdump => {remote => 1, enroll => 1},
                  currentversion => {remote=> 1, content => 1},
                  dcmaildump => {remote => 1, domroles => 1},
                  dcmailput => {remote => 1, domroles => 1},
                  del => {remote => 1, domroles => 1, enroll => 1, content => 1},
                  delbalcookie => {institutiononly => 1},
                  delusersession => {institutiononly => 1},
                  deldom => {remote => 1, domroles => 1}, # not currently used
                  devalidatecache => {institutiononly => 1},
                  domroleput => {remote => 1, enroll => 1},
                  domrolesdump => {remote => 1, catalog => 1},
                  du => {remote => 1, enroll => 1},
                  du2 => {remote => 1, enroll => 1},
                  dump => {remote => 1, enroll => 1, domroles => 1},
                  edit => {institutiononly => 1},  #not used currently
                  edump => {remote => 1, enroll => 1, domroles => 1},
                  eget => {remote => 1, domroles => 1, enroll => 1}, #not used currently
                  egetdom => {remote => 1, domroles => 1, enroll => 1, },
                  ekey => {anywhere => 1},
                  exit => {anywhere => 1},
                  fetchuserfile => {remote => 1, enroll => 1},
                  get => {remote => 1, domroles => 1, enroll => 1},
                  getdom => {anywhere => 1},
                  home => {anywhere => 1},
                  iddel => {remote => 1, enroll => 1},
                  idget => {remote => 1, enroll => 1},
                  idput => {remote => 1, domroles => 1, enroll => 1},
                  inc => {remote => 1, enroll => 1},
                  init => {anywhere => 1},
                  inst_usertypes => {remote => 1, domroles => 1, enroll => 1},
                  instemailrules => {remote => 1, domroles => 1},
                  instidrulecheck => {remote => 1, domroles => 1,},
                  instidrules => {remote => 1, domroles => 1,},
                  instrulecheck => {remote => 1, enroll => 1, reqcrs => 1, domroles => 1},
                  instselfcreatecheck => {institutiononly => 1},
                  instunamemapcheck => {remote => 1,},  
                  instuserrules => {remote => 1, enroll => 1, reqcrs => 1, domroles => 1},
                  keys => {remote => 1,},
                  load => {anywhere => 1},
                  log => {anywhere => 1},
                  ls => {remote => 1, enroll => 1, content => 1,},
                  ls2 => {remote => 1, enroll => 1, content => 1,},
                  ls3 => {remote => 1, enroll => 1, content => 1,},
                  lti => {institutiononly => 1},
                  makeuser => {remote => 1, enroll => 1, domroles => 1,},
                  mkdiruserfile => {remote => 1, enroll => 1,},
                  newput => {remote => 1, enroll => 1, reqcrs => 1, domroles => 1,},
                  passwd => {remote => 1},
                  ping => {anywhere => 1},
                  pong => {anywhere => 1},
                  pushfile => {manageronly => 1},
                  put => {remote => 1, enroll => 1, domroles => 1, msg => 1, content => 1, shared => 1},
                  putdom => {remote => 1, domroles => 1,},
                  putstore => {remote => 1, enroll => 1},
                  queryreply => {anywhere => 1},
                  querysend => {anywhere => 1},
                  querysend_activitylog => {remote => 1},
                  querysend_allusers => {remote => 1, domroles => 1},
                  querysend_courselog => {remote => 1},
                  querysend_fetchenrollment => {remote => 1},
                  querysend_getinstuser => {remote => 1},
                  querysend_getmultinstusers => {remote => 1},
                  querysend_instdirsearch => {remote => 1, domroles => 1, coaurem => 1},
                  querysend_institutionalphotos => {remote => 1},
                  querysend_portfolio_metadata => {remote => 1, content => 1},
                  querysend_userlog => {remote => 1, domroles => 1},
                  querysend_usersearch => {remote => 1, enroll => 1, coaurem => 1},
                  quit => {anywhere => 1},
                  readlonnetglobal => {institutiononly => 1},
                  reinit => {manageronly => 1}, #not used currently
                  removeuserfile => {remote => 1, enroll => 1},
                  renameuserfile => {remote => 1,},
                  restore => {remote => 1, enroll => 1, reqcrs => 1,},
                  rolesdel => {remote => 1, enroll => 1, domroles => 1, coaurem => 1},
                  rolesput => {remote => 1, enroll => 1, domroles => 1, coaurem => 1},
                  servercerts => {institutiononly => 1},
                  serverdistarch => {anywhere => 1},
                  serverhomeID => {anywhere => 1},
                  serverloncaparev => {anywhere => 1},
                  servertimezone => {remote => 1, enroll => 1},
                  setannounce => {remote => 1, domroles => 1},
                  sethost => {anywhere => 1},
                  signlti => {remote => 1},
                  store => {remote => 1, enroll => 1, reqcrs => 1,},
                  studentphoto => {remote => 1, enroll => 1},
                  sub => {content => 1,},
                  tmpdel => {institutiononly => 1},
                  tmpget => {institutiononly => 1},
                  tmpput => {remote => 1, othcoau => 1},
                  tokenauthuserfile => {anywhere => 1},
                  unamemaprules => {remote => 1,},
                  unsub => {content => 1,},
                  update => {shared => 1},
                  updatebalcookie => {institutiononly => 1},
                  updateclickers => {remote => 1},
                  userhassession => {anywhere => 1},
                  userload => {anywhere => 1},
                  version => {anywhere => 1}, #not used
               );
   
 #  #
 #   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 338  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 $CRLFile;
       unless ($crlchecked{$clientname}) {
           $CRLFile = lonssl::CRLFile();
           $crlchecked{$clientname} = 1;
       }
   
       my $SSLSocket = lonssl::PromoteServerSocket($Socket,
    $CACertificate,
    $Certificate,
    $KeyFile,
    $clientname,
                                                   $CRLFile,
                                                   $clientversion);
       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.
       #   return 0 if Insecure connections not allowed.
       #
       if (ref($secureconf{'connfrom'}) eq 'HASH') {
           if ($clientsamedom) {
               if ($secureconf{'connfrom'}{'dom'} eq 'req') {
                   return 0;
               } 
           } elsif ($clientsameinst) {
               if ($secureconf{'connfrom'}{'intdom'} eq 'req') {
                   return 0;
               }
           } else {
               if ($secureconf{'connfrom'}{'other'} eq 'req') {
                   return 0;
               }
           }
       } elsif (!$perlvar{londAllowInsecure}) {
    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 161  sub isManager { Line 592  sub isManager {
 sub isClient {  sub isClient {
     return (($ConnectionType eq "client") || ($ConnectionType eq "both"));      return (($ConnectionType eq "client") || ($ConnectionType eq "both"));
 }  }
   
   
 #  #
 #  Ties a domain level resource file to a hash.  #   ReadManagerTable: Reads in the current manager table. For now this is
 #  If requested a history entry is created in the associated hist file.  #                     done on each manager authentication because:
   #                     - These authentications are not frequent
   #                     - This allows dynamic changes to the manager table
   #                       without the need to signal to the lond.
 #  #
 #  Parameters:  sub ReadManagerTable {
 #     domain    - Name of the domain in which the resource file lives.  
 #     namespace - Name of the hash within that domain.      &Debug("Reading manager table");
 #     how       - How to tie the hash (e.g. GDBM_WRCREAT()).      #   Clean out the old table first..
 #     loghead   - Optional parameter, if present a log entry is created  
 #                 in the associated history file and this is the first part     foreach my $key (keys %managers) {
 #                  of that entry.        delete $managers{$key};
 #     logtail   - Goes along with loghead,  The actual logentry is of the     }
 #                 form $loghead:<timestamp>:logtail.  
 # Returns:     my $tablename = $perlvar{'lonTabDir'}."/managers.tab";
 #    Reference to a hash bound to the db file or alternatively undef     if (!open (MANAGERS, $tablename)) {
 #    if the tie failed.         my $hostname = &Apache::lonnet::hostname($perlvar{'lonHostID'});
 #         if (&Apache::lonnet::is_LC_dns($hostname)) {
 sub TieDomainHash {             &logthis('<font color="red">No manager table.  Nobody can manage!!</font>');
     my $domain    = shift;         }
     my $namespace = shift;         return;
     my $how       = shift;     }
          while(my $host = <MANAGERS>) {
     # Filter out any whitespace in the domain name:        chomp($host);
             if ($host =~ "^#") {                  # Comment line.
     $domain =~ s/\W//g;           next;
             }
     # We have enough to go on to tie the hash:        if (!defined &Apache::lonnet::get_host_ip($host)) { # This is a non cluster member
           #  The entry is of the form:
     my $UserTopDir   = $perlvar{'lonUsersDir'};      #    cluname:hostname
     my $DomainDir    = $UserTopDir."/$domain";      #  cluname - A 'cluster hostname' is needed in order to negotiate
     my $ResourceFile = $DomainDir."/$namespace.db";      #            the host key.
     my %hash;      #  hostname- The dns name of the host.
     if(tie(%hash, 'GDBM_File', $ResourceFile, $how, 0640)) {      #
  if (scalar @_) { # Need to log the operation.            my($cluname, $dnsname) = split(/:/, $host);
     my $logFh = IO::File->new(">>$DomainDir/$namespace.hist");            
     if($logFh) {            my $ip = gethostbyname($dnsname);
  my $TimeStamp = time;            if(defined($ip)) {                 # bad names don't deserve entry.
  my ($loghead, $logtail) = @_;              my $hostip = inet_ntoa($ip);
  print $logFh "$loghead:$TimeStamp:$logtail\n";              $managers{$hostip} = $cluname;
     }              logthis('<font color="green"> registering manager '.
  }                      "$dnsname as $cluname with $hostip </font>\n");
  return \%hash; # Return the tied hash.           }
     }        } else {
     else {           logthis('<font color="green"> existing host'." $host</font>\n");
  return undef; # Tie failed.           $managers{&Apache::lonnet::get_host_ip($host)} = $host;  # Use info from cluster tab if cluster memeber
     }        }
      }
 }  }
   
 #  #
 #   Ties a user's resource file to a hash.    #  ValidManager: Determines if a given certificate represents a valid manager.
 #   If necessary, an appropriate history  #                in this primitive implementation, the 'certificate' is
 #   log file entry is made as well.  #                just the connecting loncapa client name.  This is checked
 #   This sub factors out common code from the subs that manipulate  #                against a valid client list in the configuration.
 #   the various gdbm files that keep keyword value pairs.  #
 # Parameters:  #                  
 #   domain       - Name of the domain the user is in.  sub ValidManager {
 #   user         - Name of the 'current user'.      my $certificate = shift; 
 #   namespace    - Namespace representing the file to tie.  
 #   how          - What the tie is done to (e.g. GDBM_WRCREAT().      return isManager;
 #   loghead      - Optional first part of log entry if there may be a  }
 #                  history file.  #
 #   what         - Optional tail of log entry if there may be a history  #  CopyFile:  Called as part of the process of installing a 
 #                  file.  #             new configuration file.  This function copies an existing
 # Returns:  #             file to a backup file.
 #   hash to which the database is tied.  It's up to the caller to untie.  # Parameters:
 #   undef if the has could not be tied.  #     oldfile  - Name of the file to backup.
 #  #     newfile  - Name of the backup file.
 sub TieUserHash {  # Return:
     my $domain      = shift;  #     0   - Failure (errno has failure reason).
     my $user        = shift;  #     1   - Success.
     my $namespace   = shift;  #
     my $how         = shift;  sub CopyFile {
       
     $namespace=~s/\//\_/g; # / -> _      my ($oldfile, $newfile) = @_;
     $namespace=~s/\W//g; # whitespace eliminated.  
     my $proname     = propath($domain, $user);      if (! copy($oldfile,$newfile)) {
              return 0;
     # If this is a namespace for which a history is kept,      }
     # make the history log entry:      chmod(0660, $newfile);
           return 1;
       }
     unless ($namespace =~/^nohist\_/ && (scalar @_ > 0)) {  #
  my $hfh = IO::File->new(">>$proname/$namespace.hist");   #  Host files are passed out with externally visible host IPs.
  if($hfh) {  #  If, for example, we are behind a fire-wall or NAT host, our 
     my $now = time;  #  internally visible IP may be different than the externally
     my $loghead  = shift;  #  visible IP.  Therefore, we always adjust the contents of the
     my $what    = shift;  #  host file so that the entry for ME is the IP that we believe
     print $hfh "$loghead:$now:$what\n";  #  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.
  }   }
     }      }
     #  Tie the database.      return $adjusted;
       }
     my %hash;  #
     if(tie(%hash, 'GDBM_File', "$proname/$namespace.db",  #   InstallFile: Called to install an administrative file:
    $how, 0640)) {  #       - The file is created int a temp directory called <name>.tmp
  return \%hash;  #       - lcinstall file is called to install the file.
   #         since the web app has no direct write access to the table directory
   #
   #  Parameters:
   #       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;
     }      }
     else {      #  write the contents of the file:
  return undef;  
       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;
 }  }
   
   
 #  #
 #   Get a Request:  #   ConfigFileFromSelector: converts a configuration file selector
 #   Gets a Request message from the client.  The transaction  #                 into a configuration file pathname.
 #   is defined as a 'line' of text.  We remove the new line  #                 Supports the following file selectors: 
 #   from the text line.    #                 hosts, domain, dns_hosts, dns_domain  
 #     #
 sub GetRequest {  #
     my $input = <$client>;  #  Parameters:
     chomp($input);  #      selector  - Configuration file selector.
   #  Returns:
   #      Full path to the file or undef if the selector is invalid.
   #
   sub ConfigFileFromSelector {
       my $selector   = shift;
       my $tablefile;
   
       if ($selector eq 'loncapaCAcrl') {
           my $tabledir = $perlvar{'lonCertificateDirectory'};
           if (-d $tabledir) {
               $tablefile =  $tabledir.'/'.$selector.'.pem';
           }
       } else {
           my $tabledir = $perlvar{'lonTabDir'}.'/';
           if (($selector eq "hosts") || ($selector eq "domain") || 
               ($selector eq "dns_hosts") || ($selector eq "dns_domain")) {
       $tablefile =  $tabledir.$selector.'.tab';
           }
       }
       return $tablefile;
   }
   #
   #   PushFile:  Called to do an administrative push of a file.
   #              - 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 and
       #  CRL file 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).
       #   loncapaCAcrl.pem ($filename eq loncapaCAcrl).
       # 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.
       #
   
     Debug("Request = $input\n");  
   
     &status('Processing '.$clientname.':'.$input);      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);
       } elsif (($filename eq 'dns_hosts') || ($filename eq 'dns_domain') ||
                ($filename eq 'loncapaCAcrl')) {
           if ($contents eq '') {
               &logthis('<font color="red"> Pushfile: unable to install '
                       .$tablefile." - no data received from push. </font>");
               return 'error: push had no data';
           }
           if (&Apache::lonnet::get_host_ip($clientname)) {
               my $clienthost = &Apache::lonnet::hostname($clientname);
               if ($managers{$clientip} eq $clientname) {
                   my $clientprotocol = $Apache::lonnet::protocol{$clientname};
                   $clientprotocol = 'http' if ($clientprotocol ne 'https');
                   my $url;
                   if ($filename eq 'loncapaCAcrl') {
                       $url = '/adm/dns/loncapaCRL';
                   } else {
                       $url = '/adm/'.$filename;
                       $url =~ s{_}{/};
                   }
                   my $request=new HTTP::Request('GET',"$clientprotocol://$clienthost$url");
                   my $response = LONCAPA::LWPReq::makerequest($clientname,$request,'',\%perlvar,60,0);
                   if ($response->is_error()) {
                       &logthis('<font color="red"> Pushfile: unable to install '
                               .$tablefile." - error attempting to pull data. </font>");
                       return 'error: pull failed';
                   } else {
                       my $result = $response->content;
                       chomp($result);
                       unless ($result eq $contents) {
                           &logthis('<font color="red"> Pushfile: unable to install '
                                   .$tablefile." - pushed data and pulled data differ. </font>");
                           my $pushleng = length($contents);
                           my $pullleng = length($result);
                           if ($pushleng != $pullleng) {
                               return "error: $pushleng vs $pullleng bytes";
                           } else {
                               return "error: mismatch push and pull";
                           }
                       }
                   }
               }
           }
       }
   
       #  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";
   
     return $input;  
 }  }
   
   #
   #  Called to re-init either lonc or lond.
 #  #
 #   Decipher encoded traffic  
 #  Parameters:  #  Parameters:
 #     input      - Encoded data.  #    request   - The full request by the client.  This is of the form
   #                reinit:<process>  
   #                where <process> is allowed to be either of 
   #                lonc or lond
   #
 #  Returns:  #  Returns:
 #     Decoded data or undef if encryption key was not yet negotiated.  #     The string to be sent back to the client either:
 #  Implicit input:  #   ok         - Everything worked just fine.
 #     cipher  - This global holds the negotiated encryption key.  #   error:why  - There was a failure and why describes the reason.
 #  #
 sub Decipher {  #
     my $input  = shift;  sub ReinitProcess {
     my $output = '';      my $request = shift;
      
      
     if($cipher) {      # separate the request (reinit) from the process identifier and
  my($enc, $enclength, $encinput) = split(/:/, $input);      # validate it producing the name of the .pid file for the process.
  for(my $encidx = 0; $encidx < length($encinput); $encidx += 16) {      #
     $output .=       #
  $cipher->decrypt(pack("H16", substr($encinput, $encidx, 16)));      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";
  }   }
  return substr($output, 0, $enclength);   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 {      } else {
  return undef;   &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:
   #     scriptline - A line to validate (\n has been stripped for what it's worth).
   #
   #   Return:
   #      0     - Invalid scriptline.
   #      1     - Valid scriptline
   #  NOTE:
   #     Only the command syntax is checked, not the executability of the
   #     command.
   #
   sub isValidEditCommand {
       my $scriptline = shift;
   
       #   Line elements are pipe separated:
   
       my ($command, $key, $newline)  = split(/\|/, $scriptline);
       &logthis('<font color="green"> isValideditCommand checking: '.
        "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");
       
       if ($command eq "delete") {
    #
    #   key with no newline.
    #
    if( ($key eq "") || ($newline ne "")) {
       return 0; # Must have key but no newline.
    } else {
       return 1; # Valid syntax.
    }
       } elsif ($command eq "replace") {
    #
    #   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!!!
   }
 #  #
 #   Register a command processor.  This function is invoked to register a sub  #   ApplyEdit - Applies an edit command to a line in a configuration 
 #   to process a request.  Once registered, the ProcessRequest sub can automatically  #               file.  It is the caller's responsiblity to validate the
 #   dispatch requests to an appropriate sub, and do the top level validity checking  #               edit line.
 #   as well:  
 #    - Is the keyword recognized.  
 #    - Is the proper client type attempting the request.  
 #    - Is the request encrypted if it has to be.  
 #   Parameters:  #   Parameters:
 #    $RequestName         - Name of the request being registered.  #      $directive - A single edit directive to apply.  
 #                           This is the command request that will match  #                   Edit directives are of the form:
 #                           against the hash keywords to lookup the information  #                  append|newline      - Appends a new line to the file.
 #                           associated with the dispatch information.  #                  replace|key|newline - Replaces the line with key value 'key'
 #    $Procedure           - Reference to a sub to call to process the request.  #                  delete|key          - Deletes the line with key value 'key'.
 #                           All subs get called as follows:  #      $editor   - A config file editor object that contains the
 #                             Procedure($cmd, $tail, $replyfd, $key)  #                  file being edited.
 #                             $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 {  sub ApplyEdit {
     my $RequestName    = shift;  
     my $Procedure      = shift;      my ($directive, $editor) = @_;
     my $MustEncode     = shift;  
     my $ClientOk       = shift;      # Break the directive down into its command and its parameters
     my $ManagerOk      = shift;      # (at most two at this point.  The meaning of the parameters, if in fact
          #  they exist depends on the command).
     #  Don't allow duplication#  
          my ($command, $p1, $p2) = split(/\|/, $directive);
     if (defined $Dispatcher{$RequestName}) {  
  die "Attempting to define a duplicate request handler for $RequestName\n";      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"
     }      }
     #   Build the client type mask:  }
   #
   # 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 $ClientTypeMask = 0;      my ($filename, $editor) = @_;
     if($ClientOk) {  
  $ClientTypeMask  |= $CLIENT_OK;      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($ManagerOk) {      if( ($filetype ne "hosts")  &&
  $ClientTypeMask  |= $MANAGER_OK;   ($filetype ne "domain")) {
    return "error:edit requested with invalid file specifier: $filetype \n";
     }      }
      
     #  Enter the hash:      #   Split the edit script and check it's validity.
         
     my @entry = ($Procedure, $MustEncode, $ClientTypeMask);      my @scriptlines = split(/\n/, $script);  # one line per element.
          my $linecount   = scalar(@scriptlines);
     $Dispatcher{$RequestName} = \@entry;      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 382  sub RegisterHandler { Line 1283  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 407  RegisterHandler("ping", \&PingHandler, 0 Line 1310  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;  
     my $replyfd = shift;  
   
     my $reply=&reply("ping",$clientname);  
     Reply( $replyfd, "$currenthostid:$reply\n", "$cmd:$tail");   
     return 1;      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 430  RegisterHandler("pong", \&PongHandler, 0 Line 1335  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 438  RegisterHandler("pong", \&PongHandler, 0 Line 1343  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);      my $buildkey=time.$$.int(rand 100000);
     $buildkey=~tr/1-6/A-F/;      $buildkey=~tr/1-6/A-F/;
Line 454  sub EstablishKeyHandler { Line 1357  sub EstablishKeyHandler {
     $key=substr($key,0,32);      $key=substr($key,0,32);
     my $cipherkey=pack("H32",$key);      my $cipherkey=pack("H32",$key);
     $cipher=new IDEA $cipherkey;      $cipher=new IDEA $cipherkey;
     Reply($replyfd, "$buildkey\n", "$cmd:$tail");       &Reply($replyfd, \$buildkey, "$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 472  RegisterHandler("ekey", \&EstablishKeyHa Line 1374  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
Line 494  sub LoadHandler { Line 1396  sub LoadHandler {
         
     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 512  RegisterHandler("load", \&LoadHandler, 0 Line 1413  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 521  RegisterHandler("load", \&LoadHandler, 0 Line 1422  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();      my $userloadpercent=&Apache::lonnet::userload();
     Reply($replyfd, "$userloadpercent\n", "$cmd:$tail");      &Reply($replyfd, \$userloadpercent, "$cmd:$tail");
           
     return 1;      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 546  RegisterHandler("userload", \&UserLoadHa Line 1445  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 {
  #   #
  # We only want to pass the second field from GetAuthType   # We only want to pass the second field from get_auth_type
  # for ^krb.. otherwise we'll be handing out the encrypted   # for ^krb.. otherwise we'll be handing out the encrypted
  # password for internals e.g.   # password for internals e.g.
  #   #
  my ($type,$otherinfo) = split(/:/,$result);   my ($type,$otherinfo) = split(/:/,$result);
  if($type =~ /^krb/) {   if($type =~ /^krb/) {
     $type = $result;      $type = $result;
  }   } else {
  Reply( $replyfd, "$type\n", $userinput);              $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 590  RegisterHandler("currentauth", \&UserAut Line 1489  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 {
 sub PushFileHandler {      my ($cmd, $tail, $client) = @_;
     my $cmd    = shift;      &Debug("In push file handler");
     my $tail   = shift;  
     my $client = shift;  
   
     my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
   
     # At this time we only know that the IP of our partner is a valid manager      # 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      # the code below is a hook to do further authentication (e.g. to resolve
     # spoofing).      # spoofing).
   
     my $cert = GetCertificate($userinput);      my $cert = &GetCertificate($userinput);
     if(ValidManager($cert)) {       if(&ValidManager($cert)) {
    &Debug("Valid manager: $client");
   
  # Now presumably we have the bona fides of both the peer host and the   # Now presumably we have the bona fides of both the peer host and the
  # process making the request.   # process making the request.
               
  my $reply = PushFile($userinput);   my $reply = &PushFile($userinput);
  Reply($client, "$reply\n", $userinput);   &Reply($client, \$reply, $userinput);
   
     } else {      } else {
  Failure( $client, "refused\n", $userinput);   &logthis("push_file_handler $client is not valid");
    &Failure( $client, "refused\n", $userinput);
     }       } 
       return 1;
   }
   &register_handler("pushfile", \&push_file_handler, 1, 0, 1);
   
   # The du_handler routine should be considered obsolete and is retained
   # for communication with legacy servers.  Please see the du2_handler.
   #
   #   du  - list the disk usage of a directory recursively. 
   #    
   #   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";
   
       if ($ududir=~/\.\./ || $ududir!~m|^/home/httpd/|) {
    &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;
   }
   &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.
   #
   #    If the requested path contains /../ or is:
   #
   #    1. for a directory, and the path does not begin with one of:
   #        (a) /home/httpd/html/res/<domain>
   #        (b) /home/httpd/html/userfiles/
   #        (c) /home/httpd/lonUsers/<domain>/<1>/<2>/<3>/<username>/userfiles
   #    or is:
   #
   #    2. for a file, and the path (after prepending) does not begin with one of:
   #        (a) /home/httpd/lonUsers/<domain>/<1>/<2>/<3>/<username>/
   #        (b) /home/httpd/html/res/<domain>/<username>/
   #        (c) /home/httpd/html/userfiles/<domain>/<username>/
   #
   #    the response will be "refused".
   #
   # 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 ($ulsdir =~m{/\.\./}) {
           &Failure($client,"refused\n",$userinput);
           return 1;
       }
       if (-e $ulsdir) {
    if(-d $ulsdir) {
               unless (($ulsdir =~ m{^/home/httpd/html/(res/$LONCAPA::match_domain|userfiles/)}) ||
                       ($ulsdir =~ m{^/home/httpd/lonUsers/$LONCAPA::match_domain(?:/[\w\-.@]){3}/$LONCAPA::match_name/userfiles})) {
                   &Failure($client,"refused\n",$userinput);
                   return 1;
               }
       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 {
               unless (($ulsdir =~ m{^/home/httpd/lonUsers/$LONCAPA::match_domain(?:/[\w\-.@]){3}/$LONCAPA::match_name/}) ||
                       ($ulsdir =~ m{^/home/httpd/html/(?:res|userfiles)/$LONCAPA::match_domain/$LONCAPA::match_name/})) {
                   &Failure($client,"refused\n",$userinput);
                   return 1;
               }
       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;
   
 }  }
 RegisterHandler("pushfile", \&PushFileHandler, 1, 0, 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.
   #
   #    If the requested path contains /../ or is:
   #
   #    1. for a directory, and the path does not begin with one of:
   #        (a) /home/httpd/html/res/<domain>
   #        (b) /home/httpd/html/userfiles/
   #        (c) /home/httpd/lonUsers/<domain>/<1>/<2>/<3>/<username>/userfiles
   #    or is:
   #
   #    2. for a file, and the path (after prepending) does not begin with one of:
   #        (a) /home/httpd/lonUsers/<domain>/<1>/<2>/<3>/<username>/
   #        (b) /home/httpd/html/res/<domain>/<username>/
   #        (c) /home/httpd/html/userfiles/<domain>/<username>/
   #
   #    the response will be "refused".
   #
   # 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 ($ulsdir =~m{/\.\./}) {
           &Failure($client,"refused\n",$userinput);
           return 1;
       }
       if (-e $ulsdir) {
           if(-d $ulsdir) {
               unless (($ulsdir =~ m{^/home/httpd/html/(res/$LONCAPA::match_domain|userfiles/)}) ||
                       ($ulsdir =~ m{^/home/httpd/lonUsers/$LONCAPA::match_domain(?:/[\w\-.@]){3}/$LONCAPA::match_name/userfiles})) {
                   &Failure($client,"refused\n","$userinput");
                   return 1;
               }
               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 {
               unless (($ulsdir =~ m{^/home/httpd/lonUsers/$LONCAPA::match_domain(?:/[\w\-.@]){3}/$LONCAPA::match_name/}) ||
                       ($ulsdir =~ m{^/home/httpd/html/(?:res|userfiles)/$LONCAPA::match_domain/$LONCAPA::match_name/})) {
                   &Failure($client,"refused\n",$userinput);
                   return 1;
               }
               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.
   #
   #    If the requested path (after prepending) contains /../ or is:
   #
   #    1. for a directory, and the path does not begin with one of:
   #        (a) /home/httpd/html/res/<domain>
   #        (b) /home/httpd/html/userfiles/
   #        (c) /home/httpd/lonUsers/<domain>/<1>/<2>/<3>/<username>/userfiles
   #        (d) /home/httpd/html/priv/<domain> and client is the homeserver
   #
   #    or is:
   #
   #    2. for a file, and the path (after prepending) does not begin with one of:
   #        (a) /home/httpd/lonUsers/<domain>/<1>/<2>/<3>/<username>/
   #        (b) /home/httpd/html/res/<domain>/<username>/
   #        (c) /home/httpd/html/userfiles/<domain>/<username>/
   #        (d) /home/httpd/html/priv/<domain>/<username>/ and client is the homeserver
   #
   #    the response will be "refused".
   #
   # 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) || ($getuserdir)) {
           if (($uname =~ /^$LONCAPA::match_name$/) && ($udom =~ /^$LONCAPA::match_domain$/)) {
               $dir_root = &propath($udom,$uname);
               $dir_root =~ s/\/$//;
           } else {
               &Failure($client,"refused\n",$userinput);
               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;
           }
       }
       if ($ulsdir =~m{/\.\./}) {
           &Failure($client,"refused\n",$userinput);
           return 1;
       }
       my $islocal;
       my @machine_ids = &Apache::lonnet::current_machine_ids();
       if (grep(/^\Q$clientname\E$/,@machine_ids)) {
           $islocal = 1;
       }
       my $obs;
       my $rights;
       my $ulsout='';
       my $ulsfn;
   
       my ($crscheck,$toplevel,$currdom,$currnum,$skip);
       unless ($islocal) {
           my ($major,$minor) = split(/\./,$clientversion);
           if (($major < 2) || ($major == 2 && $minor < 12)) {
               $crscheck = 1;
           }
       }
       if (-e $ulsdir) {
           if(-d $ulsdir) {
               unless (($getpropath) || ($getuserdir) ||
                       ($ulsdir =~ m{^/home/httpd/html/(res/$LONCAPA::match_domain|userfiles/)}) ||
                       ($ulsdir =~ m{^/home/httpd/lonUsers/$LONCAPA::match_domain(?:/[\w\-.@]){3}/$LONCAPA::match_name/userfiles}) ||
                       (($ulsdir =~ m{^/home/httpd/html/priv/$LONCAPA::match_domain}) && ($islocal))) {
                   &Failure($client,"refused\n",$userinput);
                   return 1;
               }
               if (($crscheck) &&
                   ($ulsdir =~ m{^/home/httpd/html/res/($LONCAPA::match_domain)(/?$|/$LONCAPA::match_courseid)})) {
                   ($currdom,my $posscnum) = ($1,$2);
                   if (($posscnum eq '') || ($posscnum eq '/')) {
                       $toplevel = 1;
                   } else {
                       $posscnum =~ s{^/+}{};
                       if (&LONCAPA::Lond::is_course($currdom,$posscnum)) {
                           $skip = 1;
                       }
                   }
               }
               if ((!$skip) && (opendir(LSDIR,$ulsdir))) {
                   while ($ulsfn=readdir(LSDIR)) {
                       if (($crscheck) && ($toplevel) && ($currdom ne '') &&
                           ($ulsfn =~ /^$LONCAPA::match_courseid$/) && (-d "$ulsdir/$ulsfn")) {
                           if (&LONCAPA::Lond::is_course($currdom,$ulsfn)) {
                               next;
                           }
                       }
                       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 {
               unless (($getpropath) || ($getuserdir) ||
                       ($ulsdir =~ m{^/home/httpd/lonUsers/$LONCAPA::match_domain(?:/[\w\-.@]){3}/$LONCAPA::match_name/}) ||
                       ($ulsdir =~ m{^/home/httpd/html/(?:res|userfiles)/$LONCAPA::match_domain/$LONCAPA::match_name/}) ||
                       (($ulsdir =~ m{^/home/httpd/html/priv/$LONCAPA::match_domain/$LONCAPA::match_name/}) && ($islocal))) {
                   &Failure($client,"refused\n",$userinput);
                   return 1;
               }
               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,
                                    lonAdmEMail     => 1,
                                    lonSupportEMail => 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|oracle|rocky|alma)/) {
                               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);
   
   sub server_certs_handler {
       my ($cmd,$tail,$client) = @_;
       my $userinput = "$cmd:$tail";
       my $hostname = &Apache::lonnet::hostname($perlvar{'lonHostID'});
       my $result = &LONCAPA::Lond::server_certs(\%perlvar,$perlvar{'lonHostID'},$hostname);
       &Reply($client,\$result,$userinput);
       return;
   }
   &register_handler("servercerts", \&server_certs_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 633  RegisterHandler("pushfile", \&PushFileHa Line 2157  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 667  RegisterHandler("reinit", \&ReinitProces Line 2188  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 721  RegisterHandler("edit", \&EditTableHandl Line 2239  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       #  Regenerate the full input line 
           
Line 733  sub AuthenticateHandler { Line 2250  sub AuthenticateHandler {
     #  udom    - User's domain.      #  udom    - User's domain.
     #  uname   - Username.      #  uname   - Username.
     #  upass   - User's password.      #  upass   - User's password.
       #  checkdefauth - Pass to validate_user() to try authentication
       #                 with default auth type(s) if no user account.
       #  clientcancheckhost - Passed by clients with functionality in lonauth.pm
       #                       to check if session can be hosted.
           
     my ($udom,$uname,$upass)=split(/:/,$tail);      my ($udom, $uname, $upass, $checkdefauth, $clientcancheckhost)=split(/:/,$tail);
     Debug(" Authenticate domain = $udom, user = $uname, password = $upass");      &Debug(" Authenticate domain = $udom, user = $uname, password = $upass,  checkdefauth = $checkdefauth");
     chomp($upass);      chomp($upass);
     $upass=unescape($upass);      $upass=&unescape($upass);
   
     my $pwdcorrect = ValidateUser($udom, $uname, $upass);      my $pwdcorrect = &validate_user($udom,$uname,$upass,$checkdefauth);
     if($pwdcorrect) {      if($pwdcorrect) {
  Reply( $client, "authorized\n", $userinput);          my $canhost = 1;
           unless ($clientcancheckhost) {
               my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
               my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
               my @intdoms;
               my $internet_names = &Apache::lonnet::get_internet_names($clientname);
               if (ref($internet_names) eq 'ARRAY') {
                   @intdoms = @{$internet_names};
               }
               unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
                   my ($remote,$hosted);
                   my $remotesession = &get_usersession_config($udom,'remotesession');
                   if (ref($remotesession) eq 'HASH') {
                       $remote = $remotesession->{'remote'};
                   }
                   my $hostedsession = &get_usersession_config($clienthomedom,'hostedsession');
                   if (ref($hostedsession) eq 'HASH') {
                       $hosted = $hostedsession->{'hosted'};
                   }
                   $canhost = &Apache::lonnet::can_host_session($udom,$clientname,
                                                                $clientversion,
                                                                $remote,$hosted);
               }
           }
           if ($canhost) {               
               &Reply( $client, "authorized\n", $userinput);
           } else {
               &Reply( $client, "not_allowed_to_host\n", $userinput);
           }
  #   #
  #  Bad credentials: Failed to authorize   #  Bad credentials: Failed to authorize
  #   #
     } else {      } else {
  Failure( $client, "non_authorized\n", $userinput);   &Failure( $client, "non_authorized\n", $userinput);
     }      }
   
     return 1;      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 774  RegisterHandler("auth", \&AuthenticateHa Line 2323  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.
   
     #      #
Line 786  sub ChangePasswordHandler { Line 2333  sub ChangePasswordHandler {
     #  uname - Username.      #  uname - Username.
     #  upass - Current password.      #  upass - Current password.
     #  npass - New password.      #  npass - New password.
       #  context - Context in which this was called 
       #            (preferences or reset_by_email).
       #  lonhost - HostID of server where request originated 
         
     my ($udom,$uname,$upass,$npass)=split(/:/,$tail);      my ($udom,$uname,$upass,$npass,$context,$lonhost)=split(/:/,$tail);
     chomp($npass);  
     $upass=&unescape($upass);      $upass=&unescape($upass);
     $npass=&unescape($npass);      $npass=&unescape($npass);
     &Debug("Trying to change password for $uname");      &Debug("Trying to change password for $uname");
   
     # First require that the user can be authenticated with their      # First require that the user can be authenticated with their
     # old password:      # old password unless context was 'reset_by_email':
       
     my $validated = ValidateUser($udom, $uname, $upass);      my ($validated,$failure);
       if ($context eq 'reset_by_email') {
           if ($lonhost eq '') {
               $failure = 'invalid_client';
           } else {
               $validated = 1;
           }
       } else {
           $validated = &validate_user($udom, $uname, $upass);
       }
     if($validated) {      if($validated) {
  my $realpasswd  = GetAuthType($udom, $uname); # Defined since authd.   my $realpasswd  = &get_auth_type($udom, $uname); # Defined since authd.
   
  my ($howpwd,$contentpwd)=split(/:/,$realpasswd);   my ($howpwd,$contentpwd)=split(/:/,$realpasswd);
           my $notunique;
  if ($howpwd eq 'internal') {   if ($howpwd eq 'internal') {
     &Debug("internal auth");      &Debug("internal auth");
     my $salt=time;              my $ncpass = &hash_passwd($udom,$npass);
     $salt=substr($salt,6,2);              my (undef,$method,@rest) = split(/!/,$contentpwd);
     my $ncpass=crypt($npass,$salt);              if ($method eq 'bcrypt') {
     if(RewritePwFile($udom, $uname, "internal:$ncpass")) {                  my %passwdconf = &Apache::lonnet::get_passwdconf($udom);
  &logthis("Result of password change for "                  if (($passwdconf{'numsaved'}) && ($passwdconf{'numsaved'} =~ /^\d+$/)) {
  ."$uname: pwchange_success");                      my @oldpasswds;
  Reply($client, "ok\n", $userinput);                      my $userpath = &propath($udom,$uname);
                       my $fullpath = $userpath.'/oldpasswds';
                       if (-d $userpath) {
                           my @oldfiles;
                           if (-e $fullpath) {
                               if (opendir(my $dir,$fullpath)) {
                                   (@oldfiles) = grep(/^\d+$/,readdir($dir));
                                   closedir($dir);
                               }
                               if (@oldfiles) {
                                   @oldfiles = sort { $b <=> $a } (@oldfiles);
                                   my $numremoved = 0;
                                   for (my $i=0; $i<@oldfiles; $i++) {
                                       if ($i>=$passwdconf{'numsaved'}) {
                                           if (-f "$fullpath/$oldfiles[$i]") {
                                               if (unlink("$fullpath/$oldfiles[$i]")) {
                                                   $numremoved ++;
                                               }
                                           }
                                       } elsif (open(my $fh,'<',"$fullpath/$oldfiles[$i]")) {
                                           while (my $line = <$fh>) {
                                               push(@oldpasswds,$line);
                                           }
                                           close($fh);
                                       }
                                   }
                                   if ($numremoved) {
                                       &logthis("unlinked $numremoved old password files for $uname:$udom");
                                   }
                               }
                           }
                           push(@oldpasswds,$contentpwd);
                           foreach my $item (@oldpasswds) {
                               my (undef,$method,@rest) = split(/!/,$item);
                               if ($method eq 'bcrypt') {
                                   my $result = &hash_passwd($udom,$npass,@rest);
                                   if ($result eq $item) {
                                       $notunique = 1;
                                       last;
                                   }
                               }
                           }
                           unless ($notunique) {
                               unless (-e $fullpath) {
                                   if (&mkpath("$fullpath/")) {
                                       chmod(0700,$fullpath);
                                   }
                               }
                               if (-d $fullpath) {
                                   my $now = time;
                                   if (open(my $fh,'>',"$fullpath/$now")) {
                                       print $fh $contentpwd;
                                       close($fh);
                                       chmod(0400,"$fullpath/$now");
                                   }
                               }
                           }
                       }
                   }
               }
               if ($notunique) {
                   my $msg="Result of password change for $uname:$udom - password matches one used before";
                   if ($lonhost) {
                       $msg .= " - request originated from: $lonhost";
                   }
                   &logthis($msg);
                   &Reply($client, "prioruse\n", $userinput);
       } elsif (&rewrite_password_file($udom, $uname, "internal:$ncpass")) {
    my $msg="Result of password change for $uname: pwchange_success";
                   if ($lonhost) {
                       $msg .= " - request originated from: $lonhost";
                   }
                   &logthis($msg);
                   &update_passwd_history($uname,$udom,$howpwd,$context);
    &Reply($client, "ok\n", $userinput);
     } else {      } else {
  &logthis("Unable to open $uname passwd "                  &logthis("Unable to open $uname passwd "               
  ."to change password");   ."to change password");
  Failure( $client, "non_authorized\n",$userinput);   &Failure( $client, "non_authorized\n",$userinput);
     }      }
  } elsif ($howpwd eq 'unix') {   } elsif ($howpwd eq 'unix' && $context ne 'reset_by_email') {
     # Unix means we have to access /etc/password      my $result = &change_unix_password($uname, $npass);
     &Debug("auth is unix");              if ($result eq 'ok') {
     my $execdir=$perlvar{'lonDaemons'};                  &update_passwd_history($uname,$udom,$howpwd,$context);
     &Debug("Opening lcpasswd pipeline");              }
     my $pf = IO::File->new("|$execdir/lcpasswd > "  
    ."$perlvar{'lonDaemons'}"  
    ."/logs/lcpasswd.log");  
     print $pf "$uname\n$npass\n$npass\n";  
     close $pf;  
     my $err = $?;  
     my $result = ($err>0 ? 'pwchange_failure' : 'ok');  
     &logthis("Result of password change for $uname: ".      &logthis("Result of password change for $uname: ".
      &lcpasswdstrerror($?));       $result);
     Reply($client, "$result\n", $userinput);      &Reply($client, \$result, $userinput);
  } else {   } else {
     # this just means that the current password mode is not      # this just means that the current password mode is not
     # one we know how to change (e.g the kerberos auth modes or      # one we know how to change (e.g the kerberos auth modes or
     # locally written auth handler).      # locally written auth handler).
     #      #
     Reply( $client, "auth_mode_error\n", $userinput);      &Failure( $client, "auth_mode_error\n", $userinput);
  }     }  
       } else {
     }   if ($failure eq '') {
     else {      $failure = 'non_authorized';
  Reply( $client, "non_authorized\n", $userinput);   }
    &Failure( $client, "$failure\n", $userinput);
     }      }
   
     return 1;      return 1;
 }  }
 RegisterHandler("passwd", \&ChangePasswordHandler, 1, 1, 0);  &register_handler("passwd", \&change_password_handler, 1, 1, 0);
   
   sub hash_passwd {
       my ($domain,$plainpass,@rest) = @_;
       my ($salt,$cost);
       if (@rest) {
           $cost = $rest[0];
           # salt is first 22 characters, base-64 encoded by bcrypt
           my $plainsalt = substr($rest[1],0,22);
           $salt = Crypt::Eksblowfish::Bcrypt::de_base64($plainsalt);
       } else {
           my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
           my $defaultcost = $domdefaults{'intauth_cost'};
           if (($defaultcost eq '') || ($defaultcost =~ /D/)) {
               $cost = 10;
           } else {
               $cost = $defaultcost;
           }
           # Generate random 16-octet base64 salt
           $salt = "";
           $salt .= pack("C", int rand(256)) for 1..16;
       }
       my $hash = &Crypt::Eksblowfish::Bcrypt::bcrypt_hash({
           key_nul => 1,
           cost    => $cost,
           salt    => $salt,
       }, Digest::SHA::sha512(Encode::encode('UTF-8',$plainpass)));
   
       my $result = join("!", "", "bcrypt", sprintf("%02d",$cost),
                   &Crypt::Eksblowfish::Bcrypt::en_base64($salt).
                   &Crypt::Eksblowfish::Bcrypt::en_base64($hash));
       return $result;
   }
   
 #  #
 #   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 863  RegisterHandler("passwd", \&ChangePasswo Line 2522  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 ($udom,$uname,$umode,$npass)=split(/:/,$tail);      my ($udom,$uname,$umode,$npass)=split(/:/,$tail);
     my $userinput = $cmd.":".$tail; # Reconstruct the full request line.      my $userinput = $cmd.":".$tail; # Reconstruct the full request line.
Line 879  sub AddUserHandler { Line 2538  sub AddUserHandler {
  my $oldumask=umask(0077);   my $oldumask=umask(0077);
  chomp($npass);   chomp($npass);
  $npass=&unescape($npass);   $npass=&unescape($npass);
  my $passfilename  = PasswordPath($udom, $uname);   my $passfilename  = &password_path($udom, $uname);
  &Debug("Password file created will be:".$passfilename);   &Debug("Password file created will be:".$passfilename);
  if (-e $passfilename) {   if (-e $passfilename) {
     Failure( $client, "already_exists\n", $userinput);      &Failure( $client, "already_exists\n", $userinput);
  } else {   } else {
     my @fpparts=split(/\//,$passfilename);  
     my $fpnow=$fpparts[0].'/'.$fpparts[1].'/'.$fpparts[2];  
     my $fperror='';      my $fperror='';
     for (my $i=3;$i<= ($#fpparts-1);$i++) {      if (!&mkpath($passfilename)) {
  $fpnow.='/'.$fpparts[$i];    $fperror="error: ".($!+0)." mkdir failed while attempting "
  unless (-e $fpnow) {      ."makeuser";
     &logthis("mkdir $fpnow");  
     unless (mkdir($fpnow,0777)) {  
  $fperror="error: ".($!+0)." mkdir failed while attempting "  
     ."makeuser";  
     }  
  }  
     }      }
     unless ($fperror) {      unless ($fperror) {
  my $result=&make_passwd_file($uname, $umode,$npass, $passfilename);   my $result=&make_passwd_file($uname,$udom,$umode,$npass,
  Reply($client, $result, $userinput);     #BUGBUG - could be fail                                               $passfilename,'makeuser');
    &Reply($client,\$result, $userinput);     #BUGBUG - could be fail
     } else {      } else {
  Failure($client, "$fperror\n", $userinput);   &Failure($client, \$fperror, $userinput);
     }      }
  }   }
  umask($oldumask);   umask($oldumask);
     }  else {      }  else {
  Failure($client, "not_right_domain\n",   &Failure($client, "not_right_domain\n",
  $userinput); # Even if we are multihomed.   $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 936  RegisterHandler("makeuser", \&AddUserHan Line 2588  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);
     &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);      &Debug("cmd = ".$cmd." domain= ".$udom."uname =".$uname." umode= ".$umode);
     if ($udom ne $currentdomainid) {      if ($udom ne $currentdomainid) {
  Failure( $client, "not_right_domain\n", $client);   &Failure( $client, "not_right_domain\n", $client);
     } else {      } else {
   
  chomp($npass);   chomp($npass);
   
  $npass=&unescape($npass);   $npass=&unescape($npass);
  my $passfilename = PasswordPath($udom, $uname);   my $oldauth = &get_auth_type($udom, $uname); # Get old auth info.
    my $passfilename = &password_path($udom, $uname);
  if ($passfilename) { # Not allowed to create a new user!!   if ($passfilename) { # Not allowed to create a new user!!
     my $result=&make_passwd_file($uname, $umode,$npass,$passfilename);      # If just changing the unix passwd. need to arrange to run
     Reply($client, $result, $userinput);      # 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") {
                       &update_passwd_history($uname,$udom,$umode,'changeuserauth'); 
       &Reply($client, \$result);
    } else {
       &Failure($client, \$result);
    }
       } else {
    my $result=&make_passwd_file($uname,$udom,$umode,$npass,
                                                $passfilename,'changeuserauth');
    #
    #  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 {          } else {       
     Failure($client, "non_authorized", $userinput); # Fail the user now.      &Failure($client, "non_authorized\n", $userinput); # Fail the user now.
  }   }
     }      }
     return 1;      return 1;
 }  }
 RegisterHandler("changeuserauth", \&ChangeAuthenticationHandler, 1,1, 0);  &register_handler("changeuserauth", \&change_authentication_handler, 1,1, 0);
   
   sub update_passwd_history {
       my ($uname,$udom,$umode,$context) = @_;
       my $proname=&propath($udom,$uname);
       my $now = time;
       if (open(my $fh,">>$proname/passwd.log")) {
           print $fh "$now:$umode:$context\n";
           close($fh);
       }
       return;
   }
   
   sub inst_unamemap_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::unamemap_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("instunamemapcheck",\&inst_unamemap_check,0,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 2704  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 $passfile = PasswordFilename($udom, $uname);      my $passfile = &password_filename($udom, $uname);
     if($passfile) {      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 2737  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);      my $ownership=ishome($fname);
     if ($ownership eq 'not_owner') {      if ($ownership eq 'not_owner') {
  if (-e $fname) {   if (-e $fname) {
               # Delete preview file, if exists
               unlink("$fname.tmp");
               # Get usage stats
     my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,      my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
  $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);   $atime,$mtime,$ctime,$blksize,$blocks)=stat($fname);
     my $now=time;      my $now=time;
     my $since=$now-$atime;      my $since=$now-$atime;
               # If the file has not been used within lonExpire seconds,
               # unsubscribe from it and delete local copy
     if ($since>$perlvar{'lonExpire'}) {      if ($since>$perlvar{'lonExpire'}) {
  my $reply=&reply("unsub:$fname","$clientname");   my $reply=&Apache::lonnet::reply("unsub:$fname","$clientname");
    &devalidate_meta_cache($fname);
  unlink("$fname");   unlink("$fname");
    unlink("$fname.meta");
     } else {      } else {
               # Yes, this is in active use. Get a fresh copy. Since it might be in
               # very active use and huge (like a movie), copy it to "in.transfer" filename first.
  my $transname="$fname.in.transfer";   my $transname="$fname.in.transfer";
  my $remoteurl=&reply("sub:$fname","$clientname");   my $remoteurl=&Apache::lonnet::reply("sub:$fname","$clientname");
  my $response;   my $response;
  alarm(120);  # FIXME: cannot replicate files that take more than two minutes to transfer -- needs checking now 1200s timeout used
  {  # for LWP request.
     my $ua=new LWP::UserAgent;   my $request=new HTTP::Request('GET',"$remoteurl");
     my $request=new HTTP::Request('GET',"$remoteurl");                  $response=&LONCAPA::LWPReq::makerequest($clientname,$request,$transname,\%perlvar,1200,0,1);
     $response=$ua->request($request,$transname);  
  }  
  alarm(0);  
  if ($response->is_error()) {   if ($response->is_error()) {
     unlink($transname);                      my $reply=&Apache::lonnet::reply("unsub:$fname","$clientname");
                       &devalidate_meta_cache($fname);
                       if (-e $transname) {
                           unlink($transname);
                       }
                       unlink($fname);
     my $message=$response->status_line;      my $message=$response->status_line;
     &logthis("LWP GET: $message for $fname ($remoteurl)");      &logthis("LWP GET: $message for $fname ($remoteurl)");
  } else {   } else {
     if ($remoteurl!~/\.meta$/) {      if ($remoteurl!~/\.meta$/) {
  alarm(120);   my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
  {                          my $mresponse = &LONCAPA::LWPReq::makerequest($clientname,$mrequest,$fname.'.meta',\%perlvar,120,0,1);
     my $ua=new LWP::UserAgent;   if ($mresponse->is_error()) {
     my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');      unlink($fname.'.meta');
     my $mresponse=$ua->request($mrequest,$fname.'.meta');  
     if ($mresponse->is_error()) {  
  unlink($fname.'.meta');  
     }  
  }   }
  alarm(0);  
     }      }
                       # we successfully transfered, copy file over to real name
     rename($transname,$fname);      rename($transname,$fname);
       &devalidate_meta_cache($fname);
  }   }
     }      }
     Reply( $client, "ok\n", $userinput);      &Reply( $client, "ok\n", $userinput);
  } else {   } else {
     Failure($client, "not_found\n", $userinput);      &Failure($client, "not_found\n", $userinput);
  }   }
     } else {      } else {
  Failure($client, "rejected\n", $userinput);   &Failure($client, "rejected\n", $userinput);
     }      }
     return 1;      return 1;
 }  }
 RegisterHandler("update", \&UpdateResourceHandler, 0 ,1, 0);  &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);
   }
   
 #  #
 #   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 2827  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)=split(/\//,$fname);      my ($udom,$uname,$ufile) = ($fname =~ m|^([^/]+)/([^/]+)/(.+)$|);
     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;  
    # IF necessary, create the path right down to the file.
    # Note that any regular files in the way of this path are
    # wiped out to deal with some earlier folly of mine.
   
    if (!&mkpath($udir.'/'.$ufile)) {
       &Failure($client, "unable_to_create\n", $userinput);    
    }
   
  my $destname=$udir.'/'.$ufile;   my $destname=$udir.'/'.$ufile;
  my $transname=$udir.'/'.$ufile.'.in.transit';   my $transname=$udir.'/'.$ufile.'.in.transit';
  my $remoteurl='http://'.$clientip.'/userfiles/'.$fname;          my $clientprotocol=$Apache::lonnet::protocol{$clientname};
           $clientprotocol = 'http' if ($clientprotocol ne 'https');
    my $clienthost = &Apache::lonnet::hostname($clientname);
    my $remoteurl=$clientprotocol.'://'.$clienthost.'/userfiles/'.$fname;
  my $response;   my $response;
  alarm(120);   Debug("Remote URL : $remoteurl Transfername $transname Destname: $destname");
  {   my $request=new HTTP::Request('GET',"$remoteurl");
     my $ua=new LWP::UserAgent;          my $verifycert = 1;
     my $request=new HTTP::Request('GET',"$remoteurl");          my @machine_ids = &Apache::lonnet::current_machine_ids();
     $response=$ua->request($request,$transname);          if (grep(/^\Q$clientname\E$/,@machine_ids)) {
  }              $verifycert = 0;
  alarm(0);          }
           $response = &LONCAPA::LWPReq::makerequest($clientname,$request,$transname,\%perlvar,1200,$verifycert);
  if ($response->is_error()) {   if ($response->is_error()) {
     unlink($transname);      unlink($transname);
     my $message=$response->status_line;      my $message=$response->status_line;
     &logthis("LWP GET: $message for $fname ($remoteurl)");      &logthis("LWP GET: $message for $fname ($remoteurl)");
     Failure($client, "failed\n", $userinput);      &Failure($client, "failed\n", $userinput);
  } else {   } else {
       Debug("Renaming $transname to $destname");
     if (!rename($transname,$destname)) {      if (!rename($transname,$destname)) {
  &logthis("Unable to move $transname to $destname");   &logthis("Unable to move $transname to $destname");
  unlink($transname);   unlink($transname);
  Failure($client, "failed\n", $userinput);   &Failure($client, "failed\n", $userinput);
     } else {      } else {
  Reply($client, "ok\n", $userinput);                  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 {      } else {
  Failure($client, "not_home\n", $userinput);   &Failure($client, "not_home\n", $userinput);
     }      }
     return 1;      return 1;
 }  }
 RegisterHandler("fetchuserfile", \&FetchUserFileHandler, 0, 1, 0);  &register_handler("fetchuserfile", \&fetch_user_file_handler, 0, 1, 0);
   
   #
   #   Remove a file from 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.
 #  #
 #   Authenticate access to a user file.   # 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 appropriate.
    #   Note: rmdir will only remove an empty directory.
    #
           if (-f $file){
       unlink($file);
                       # for html files remove the associated .bak file 
                       # which may have been created by the editor.
                       if ($ufile =~ m{^((docs|supplemental)/(?:\d+|default)/\d+(?:|/.+)/)[^/]+\.x?html?$}i) {
                           my $path = $1;
                           if (-e $file.'.bak') {
                               unlink($file.'.bak');
                           }
                       }
    } 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|^([^/]+)/([^/]+)/(.+)$|);
       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 $newdir=$udir.'/userfiles/'.$ufile.'/';
       if (!&mkpath($newdir)) {
    &Failure($client, "failed\n", "$cmd:$tail");
       }
       &Reply($client, "ok\n", "$cmd:$tail");
    } else {
       &Failure($client, "not_home\n", "$cmd:$tail");
    }
       }
       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);
   
   sub del_usersession_handler {
       my ($cmd, $tail, $client) = @_;
   
       my $result;
       my ($udom, $uname) = map { &unescape($_) } (split(/:/, $tail));
       if (($udom =~ /^$LONCAPA::match_domain$/) && ($uname =~ /^$LONCAPA::match_username$/)) {
           my $lonidsdir = $perlvar{'lonIDsDir'};
           if (-d $lonidsdir) {
               if (opendir(DIR,$lonidsdir)) {
                   my $filename;
                   while ($filename=readdir(DIR)) {
                       if ($filename=~/^\Q$uname\E_\d+_\Q$udom\E_/) {
                           if (tie(my %oldenv,'GDBM_File',"$lonidsdir/$filename",
                                   &GDBM_READER(),0640)) {
                               my $linkedfile;
                               if (exists($oldenv{'user.linkedenv'})) {
                                   $linkedfile = $oldenv{'user.linkedenv'};
                               }
                               untie(%oldenv);
                               $result = unlink("$lonidsdir/$filename");
                               if ($result) {
                                   if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                                       if (-l "$lonidsdir/$linkedfile.id") {
                                           unlink("$lonidsdir/$linkedfile.id");
                                       }
                                   }
                               }
                           } else {
                               $result = unlink("$lonidsdir/$filename");
                           }
                           last;
                       }
                   }
               }
           }
           if ($result == 1) {
               &Reply($client, "$result\n", "$cmd:$tail");
           } else {
               &Reply($client, "not_found\n", "$cmd:$tail");
           }
       } else {
           &Failure($client, "invalid_user\n", "$cmd:$tail");
       }
       return 1;
   }
   
   &register_handler("delusersession", \&del_usersession_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);      my ($fname, $session) = split(/:/, $tail);
       
     chomp($session);      chomp($session);
     my $reply='non_auth';      my $reply="non_auth";
     if (open(ENVIN,$perlvar{'lonIDsDir'}.'/'.$session.'.id')) {      my $file = $perlvar{'lonIDsDir'}.'/'.$session.'.id';
  while (my $line=<ENVIN>) {      if (open(ENVIN,"$file")) {
     if ($line=~/userfile\.$fname\=/) {    flock(ENVIN,LOCK_SH);
  $reply='ok';    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);   close(ENVIN);
  Reply($client, $reply."\n", $userinput);   &Reply($client, \$reply, "$cmd:$tail");
     } else {      } else {
  Failure($client, "invalid_token\n", $userinput);   &Failure($client, "invalid_token\n", "$cmd:$tail");
     }      }
     return 1;      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 1182  RegisterHandler("tokenauthuserfile", \&A Line 3174  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 = $tail;      my ($fname) = split(/:/,$tail); # Split in case there's extrs.
   
       &Debug("Unsubscribing $fname");
     if (-e $fname) {      if (-e $fname) {
  Reply($client, &unsub($client,$fname,$clientip), $userinput);   &Debug("Exists");
    &Reply($client, &unsub($fname,$clientip), $userinput);
     } else {      } else {
  Failure($client, "not_found\n", $userinput);   &Failure($client, "not_found\n", $userinput);
     }      }
     return 1;      return 1;
 }  }
 RegisterHandler("unusb", \&UnsubscribeHandler, 0, 1, 0);  &register_handler("unsub", \&unsubscribe_handler, 0, 1, 0);
   
 #   Subscribe to a resource  #   Subscribe to a resource
 #  #
Line 1208  RegisterHandler("unusb", \&UnsubscribeHa Line 3202  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";      my $userinput  = "$cmd:$tail";
   
     Reply( $client, &subscribe($userinput,$clientip), $userinput);      &Reply( $client, &subscribe($userinput,$clientip), $userinput);
   
     return 1;      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 1257  RegisterHandler("currentversion", \&Curr Line 3248  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 $userinput= "$cmd:$tail";
   
     my ($udom,$uname,$what)=split(/:/,$tail);      my ($udom,$uname,$what)=split(/:/,$tail);
     chomp($what);      chomp($what);
     my $proname=propath($udom,$uname);      my $proname=&propath($udom,$uname);
     my $now=time;      my $now=time;
     my $hfh;      my $hfh;
     if ($hfh=IO::File->new(">>$proname/activity.log")) {       if ($hfh=IO::File->new(">>$proname/activity.log")) { 
  print $hfh "$now:$clientname:$what\n";   print $hfh "$now:$clientname:$what\n";
  Reply( $client, "ok\n", $userinput);    &Reply( $client, "ok\n", $userinput); 
     } else {      } else {
  Failure($client, "error: ".($!+0)." IO::File->new Failed "   &Failure($client, "error: ".($!+0)." IO::File->new Failed "
       ."while attempting log\n",    ."while attempting log\n", 
       $userinput);   $userinput);
     }      }
   
     return 1;      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 1294  RegisterHandler("log", \&ActivityLogEntr Line 3286  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);      my ($udom,$uname,$namespace,$what) =split(/:/,$tail,4);
     if ($namespace ne 'roles') {      if ($namespace ne 'roles') {
  chomp($what);   chomp($what);
  my $hashref = TieUserHash($udom, $uname, $namespace,   my $hashref = &tie_user_hash($udom, $uname, $namespace,
   &GDBM_WRCREAT(),"P",$what);    &GDBM_WRCREAT(),"P",$what);
  if($hashref) {   if($hashref) {
     my @pairs=split(/\&/,$what);      my @pairs=split(/\&/,$what);
Line 1311  sub PutUserProfileEntry { Line 3302  sub PutUserProfileEntry {
  my ($key,$value)=split(/=/,$pair);   my ($key,$value)=split(/=/,$pair);
  $hashref->{$key}=$value;   $hashref->{$key}=$value;
     }      }
     if (untie(%$hashref)) {      if (&untie_user_hash($hashref)) {
  Reply( $client, "ok\n", $userinput);   &Reply( $client, "ok\n", $userinput);
     } else {      } else {
  Failure($client, "error: ".($!+0)." untie(GDBM) failed ".   &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
  "while attempting put\n",    "while attempting put\n", 
  $userinput);   $userinput);
     }      }
  } else {   } else {
     Failure( $client, "error: ".($!)." tie(GDBM) Failed ".      &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
      "while attempting put\n", $userinput);       "while attempting put\n", $userinput);
  }   }
     } else {      } else {
         Failure( $client, "refused\n", $userinput);          &Failure( $client, "refused\n", $userinput);
     }      }
           
     return 1;      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})) {
               if (!&untie_user_hash($hashref)) {
                   &logthis("error: ".($!+0)." untie (GDBM) failed ".
                            "while attempting newput - early out as key exists");
               }
               &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 1345  RegisterHandler("put", \&PutUserProfileE Line 3395  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   = "$cmd:$tail";
       
     my ($udom,$uname,$namespace,$what) =split(/:/,$tail);      my ($udom,$uname,$namespace,$what) =split(/:/,$tail);
     if ($namespace ne 'roles') {      if ($namespace ne 'roles') {
         chomp($what);          chomp($what);
  my $hashref = TieUserHash($udom, $uname,   my $hashref = &tie_user_hash($udom, $uname,
   $namespace, &GDBM_WRCREAT(),       $namespace, &GDBM_WRCREAT(),
   "P",$what);       "P",$what);
  if ($hashref) {   if ($hashref) {
     my @pairs=split(/\&/,$what);      my @pairs=split(/\&/,$what);
     foreach my $pair (@pairs) {      foreach my $pair (@pairs) {
  my ($key,$value)=split(/=/,$pair);   my ($key,$value)=split(/=/,$pair);
                   $value = &unescape($value);
  # We could check that we have a number...   # We could check that we have a number...
  if (! defined($value) || $value eq '') {   if (! defined($value) || $value eq '') {
     $value = 1;      $value = 1;
  }   }
  $hashref->{$key}+=$value;   $hashref->{$key}+=$value;
                   if ($namespace eq 'nohist_resourcetracker') {
                       if ($hashref->{$key} < 0) {
                           $hashref->{$key} = 0;
                       }
                   }
     }      }
     if (untie(%$hashref)) {      if (&untie_user_hash($hashref)) {
  Reply( $client, "ok\n", $userinput);   &Reply( $client, "ok\n", $userinput);
     } else {      } else {
  Failure($client, "error: ".($!+0)." untie(GDBM) failed ".   &Failure($client, "error: ".($!+0)." untie(GDBM) failed ".
  "while attempting inc\n", $userinput);   "while attempting inc\n", $userinput);
     }      }
  } else {   } else {
     Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".      &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
     "while attempting inc\n", $userinput);       "while attempting inc\n", $userinput);
  }   }
     } else {      } else {
  Failure($client, "refused\n", $userinput);   &Failure($client, "refused\n", $userinput);
     }      }
           
     return 1;      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 1404  RegisterHandler("inc", \&IncrementUserVa Line 3460  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 = TieUserHash($udom, $uname, $namespace,      my $hashref = &tie_user_hash($udom, $uname, $namespace,
       &GDBM_WRCREAT(), "P",   &GDBM_WRCREAT(), "P",
       "$exedom:$exeuser:$what");   "$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) {      if ($hashref) {
    my $pass_entry = &get_auth_type($udom, $uname);
    my ($auth_type,$pwd)  = split(/:/, $pass_entry);
    $auth_type = $auth_type.":";
  my @pairs=split(/\&/,$what);   my @pairs=split(/\&/,$what);
  foreach my $pair (@pairs) {   foreach my $pair (@pairs) {
     my ($key,$value)=split(/=/,$pair);      my ($key,$value)=split(/=/,$pair);
     &ManagePermissions($key, $udom, $uname,      &manage_permissions($key, $udom, $uname,
        &GetAuthType( $udom, $uname));         $auth_type);
     $hashref->{$key}=$value;      $hashref->{$key}=$value;
  }   }
  if (untie($hashref)) {   if (&untie_user_hash($hashref)) {
     Reply($client, "ok\n", $userinput);      &Reply($client, "ok\n", $userinput);
  } else {   } else {
     Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
      "while attempting rolesput\n", $userinput);       "while attempting rolesput\n", $userinput);
  }   }
     } else {      } else {
  Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting rolesput\n", $userinput);   "while attempting rolesput\n", $userinput);
     }      }
     return 1;      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 1461  RegisterHandler("rolesput", \&RolesPutHa Line 3520  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 $userinput    = "$cmd:$tail";
         
     my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);      my ($exedom,$exeuser,$udom,$uname,$what)=split(/:/,$tail);
Line 1472  sub RolesDeleteHandler { Line 3530  sub RolesDeleteHandler {
    "what = ".$what);     "what = ".$what);
     my $namespace='roles';      my $namespace='roles';
     chomp($what);      chomp($what);
     my $hashref = TieUserHash($udom, $uname, $namespace,      my $hashref = &tie_user_hash($udom, $uname, $namespace,
       &GDBM_WRCREAT(), "D",   &GDBM_WRCREAT(), "D",
       "$exedom:$exeuser:$what");   "$exedom:$exeuser:$what");
           
     if ($hashref) {      if ($hashref) {
  my @rolekeys=split(/\&/,$what);   my @rolekeys=split(/\&/,$what);
Line 1482  sub RolesDeleteHandler { Line 3540  sub RolesDeleteHandler {
  foreach my $key (@rolekeys) {   foreach my $key (@rolekeys) {
     delete $hashref->{$key};      delete $hashref->{$key};
  }   }
  if (untie(%$hashref)) {   if (&untie_user_hash($hashref)) {
     Reply($client, "ok\n", $userinput);      &Reply($client, "ok\n", $userinput);
  } else {   } else {
     Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
      "while attempting rolesdel\n", $userinput);       "while attempting rolesdel\n", $userinput);
  }   }
     } else {      } else {
         Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".          &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting rolesdel\n", $userinput);   "while attempting rolesdel\n", $userinput);
     }      }
           
     return 1;      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 1516  RegisterHandler("rolesdel", \&RolesDelet Line 3574  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);
     chomp($what);      chomp($what);
     my $hashref = TieUserHash($udom, $uname, $namespace,  
       &GDBM_READER());  
     if ($hashref) {      my $replystring = read_profile($udom, $uname, $namespace, $what);
         my @queries=split(/\&/,$what);      my ($first) = split(/:/,$replystring);
         my $qresult='';      if($first ne "error") {
    &Reply($client, \$replystring, $userinput);
  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(%$hashref)) {  
     Reply($client, "$qresult\n", $userinput);  
  } else {  
     Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".  
     "while attempting get\n", $userinput);  
  }  
     } else {      } else {
  if ($!+0 == 2) {               # +0 coerces errno -> number 2 is ENOENT   &Failure($client, $replystring." while attempting get\n", $userinput);
     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;      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 1566  RegisterHandler("get", \&GetProfileEntry Line 3610  RegisterHandler("get", \&GetProfileEntry
 #  #
 #  Parameters:  #  Parameters:
 #     $cmd               - Command keyword of request (eget).  #     $cmd               - Command keyword of request (eget).
 #     $tail              - Tail of the command.  See GetProfileEntry #                          for more information about this.  #     $tail              - Tail of the command.  See GetProfileEntry
   #                          for more information about this.
 #     $client            - File open on the client.  #     $client            - File open on the client.
 #  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);
     chomp($what);      chomp($what);
     my $hashref = TieUserHash($udom, $uname, $namespace,      my $qresult = read_profile($udom, $uname, $namespace, $what);
   &GDBM_READER());      my ($first) = split(/:/, $qresult);
     if ($hashref) {      if($first ne "error") {
         my @queries=split(/\&/,$what);  
         my $qresult='';   if ($cipher) {
  for (my $i=0;$i<=$#queries;$i++) {      my $cmdlength=length($qresult);
     $qresult.="$hashref->{$queries[$i]}&";      $qresult.="         ";
  }      my $encqresult='';
  if (untie(%$hashref)) {      for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
     $qresult=~s/\&$//;   $encqresult.= unpack("H16", 
     if ($cipher) {       $cipher->encrypt(substr($qresult,
  my $cmdlength=length($qresult);       $encidx,
  $qresult.="         ";       8)));
  my $encqresult='';  
  for(my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {  
     $encqresult.= unpack("H16",   
  $cipher->encrypt(substr($qresult,  
  $encidx,  
  8)));  
  }  
  Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);  
     } else {  
  Failure( $client, "error:no_key\n", $userinput);  
     }      }
       &Reply( $client, "enc:$cmdlength:$encqresult\n", $userinput);
  } else {   } else {
     Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".   &Failure( $client, "error:no_key\n", $userinput);
     "while attempting eget\n", $userinput);      }
  }  
     } else {      } else {
  Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure($client, "$qresult while attempting eget\n", $userinput);
  "while attempting eget\n", $userinput);  
     }      }
           
     return 1;      return 1;
 }  }
 RegisterHandler("eget", \&GetProfileEntryEncrypted, 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 1634  RegisterHandler("eget", \&GetProfileEntr Line 3668  RegisterHandler("eget", \&GetProfileEntr
 #     0   - Exit server.  #     0   - Exit server.
 #  #
 #  #
   sub delete_profile_entry {
       my ($cmd, $tail, $client) = @_;
   
 sub DeleteProfileEntry {  
     my $cmd      = shift;  
     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);      chomp($what);
     my $hashref = TieUserHash($udom, $uname, $namespace,      my $hashref = &tie_user_hash($udom, $uname, $namespace,
   &GDBM_WRCREAT(),   &GDBM_WRCREAT(),
   "D",$what);   "D",$what);
     if ($hashref) {      if ($hashref) {
         my @keys=split(/\&/,$what);          my @keys=split(/\&/,$what);
  foreach my $key (@keys) {   foreach my $key (@keys) {
     delete($hashref->{$key});      delete($hashref->{$key});
  }   }
  if (untie(%$hashref)) {   if (&untie_user_hash($hashref)) {
     Reply($client, "ok\n", $userinput);      &Reply($client, "ok\n", $userinput);
  } else {   } else {
     Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
     "while attempting del\n", $userinput);      "while attempting del\n", $userinput);
  }   }
     } else {      } else {
  Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting del\n", $userinput);   "while attempting del\n", $userinput);
     }      }
     return 1;      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 1679  RegisterHandler("del", \&DeleteProfileEn Line 3712  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='';      my $qresult='';
     my $hashref = TieUserHash($udom, $uname, $namespace,      my $hashref = &tie_user_hash($udom, $uname, $namespace,
   &GDBM_READER());    &GDBM_READER());
     if ($hashref) {      if ($hashref) {
  foreach my $key (keys %$hashref) {   foreach my $key (keys %$hashref) {
     $qresult.="$key&";      $qresult.="$key&";
  }   }
  if (untie(%$hashref)) {   if (&untie_user_hash($hashref)) {
     $qresult=~s/\&$//;      $qresult=~s/\&$//;
     Reply($client, "$qresult\n", $userinput);      &Reply($client, \$qresult, $userinput);
  } else {   } else {
     Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
     "while attempting keys\n", $userinput);      "while attempting keys\n", $userinput);
  }   }
     } else {      } else {
  Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting keys\n", $userinput);   "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 1727  RegisterHandler("keys", \&GetProfileKeys Line 3760  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);
   
       if ($res =~ /^error:/) {
           Failure($client, \$res, "$cmd:$tail");
       } else {
           Reply($client, \$res, "$cmd:$tail");
       }
   
       return 1;  
   
       #TODO remove 
     my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
         
     my ($udom,$uname,$namespace) = split(/:/,$tail);      my ($udom,$uname,$namespace) = split(/:/,$tail);
     my $hashref = TieUserHash($udom, $uname, $namespace,      my $hashref = &tie_user_hash($udom, $uname, $namespace,
   &GDBM_READER());   &GDBM_READER());
     if ($hashref) {      if ($hashref) {
  # Structure of %data:   # Structure of %data:
  # $data{$symb}->{$parameter}=$value;   # $data{$symb}->{$parameter}=$value;
Line 1754  sub DumpProfileDatabase { Line 3797  sub DumpProfileDatabase {
     $data{$symb}->{$param}=$value;      $data{$symb}->{$param}=$value;
     $data{$symb}->{'v.'.$param}=$v;      $data{$symb}->{'v.'.$param}=$v;
  }   }
  if (untie(%$hashref)) {   if (&untie_user_hash($hashref)) {
     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...
Line 1765  sub DumpProfileDatabase { Line 3808  sub DumpProfileDatabase {
  }   }
     }      }
     chop($qresult);      chop($qresult);
     Reply($client , "$qresult\n", $userinput);      &Reply($client , \$qresult, $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 1796  RegisterHandler("currentdump", \&DumpPro Line 3840  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 $userinput = "$cmd:$tail";  
   
     my ($udom,$uname,$namespace,$regexp)=split(/:/,$tail);      my $res = LONCAPA::Lond::dump_with_regexp($tail, $clientversion);
     if (defined($regexp)) {      
  $regexp=&unescape($regexp);      if ($res =~ /^error:/) {
     } else {          Failure($client, \$res, "$cmd:$tail");
  $regexp='.';  
     }  
     my $hashref =TieUserHash($udom, $uname, $namespace,  
  &GDBM_READER());  
     if ($hashref) {  
         my $qresult='';  
  while (my ($key,$value) = each(%$hashref)) {  
     if ($regexp eq '.') {  
  $qresult.=$key.'='.$value.'&';  
     } else {  
  my $unescapeKey = &unescape($key);  
  if (eval('$unescapeKey=~/$regexp/')) {  
     $qresult.="$key=$value&";  
  }  
     }  
  }  
  if (untie(%$hashref)) {  
     chop($qresult);  
     Reply($client, "$qresult\n", $userinput);  
  } else {  
     Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".  
      "while attempting dump\n", $userinput);  
  }  
     } else {      } else {
  Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".          Reply($client, \$res, "$cmd:$tail");
  "while attempting dump\n", $userinput);  
     }      }
   
     return 1;      return 1;
 }  }
 RegisterHandler("dump", \&DumpWithRegexp, 0, 1, 0);  &register_handler("dump", \&dump_with_regexp, 0, 1, 0);
   
   #
   #  Process the encrypted dump request. Original call should
   #  be from lonnet::dump() with seventh arg ($encrypt) set to
   #  1, to ensure that both request and response are encrypted.
   #
   #  Parameters:
   #     $cmd               - Command keyword of request (edump).
   #     $tail              - Tail of the command.
   #                          See &dump_with_regexp for more
   #                          information about this.
   #     $client            - File open on the client.
   #  Returns:
   #     1      - Continue processing
   #     0      - server should exit.
   #
   
   sub encrypted_dump_with_regexp {
       my ($cmd, $tail, $client) = @_;
       my $res = LONCAPA::Lond::dump_with_regexp($tail, $clientversion);
   
       if ($res =~ /^error:/) {
           Failure($client, \$res, "$cmd:$tail");
       } else {
           if ($cipher) {
               my $cmdlength=length($res);
               $res.="         ";
               my $encres='';
               for (my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
                   $encres.= unpack("H16",
                                    $cipher->encrypt(substr($res,
                                                            $encidx,
                                                            8)));
               }
               &Reply( $client,"enc:$cmdlength:$encres\n","$cmd:$tail");
           } else {
               &Failure( $client, "error:no_key\n","$cmd:$tail");
           }
       }
   }
   &register_handler("edump", \&encrypted_dump_with_regexp, 0, 1, 0);
   
 #  Store an aitem in any resource meta data(?) or database with  #  Store a set of key=value pairs associated with a versioned name.
 #  versioning?  
 #  #
 #  Parameters:  #  Parameters:
 #    $cmd                - Request command keyword.  #    $cmd                - Request command keyword.
Line 1856  RegisterHandler("dump", \&DumpWithRegexp Line 3915  RegisterHandler("dump", \&DumpWithRegexp
 #                          namespace   - Name of the database being modified  #                          namespace   - Name of the database being modified
 #                          rid         - Resource keyword to modify.  #                          rid         - Resource keyword to modify.
 #                          what        - new value associated with rid.  #                          what        - new value associated with rid.
   #                          laststore   - (optional) version=timestamp
   #                                        for most recent transaction for rid
   #                                        in namespace, when cstore was called
 #  #
 #    $client             - Socket open on the client.  #    $client             - Socket open on the client.
 #  #
Line 1864  RegisterHandler("dump", \&DumpWithRegexp Line 3926  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 {  #    Successful storage will cause either 'ok', or, if $laststore was included
     my $cmd    = shift;  #    in the tail of the request, and the version number for the last transaction
     my $tail   = shift;  #    is larger than the version in $laststore, delay:$numtrans , where $numtrans
     my $client = shift;  #    is the number of store evevnts recorded for rid in namespace since
   #    lonnet::store() was called by the client.
   #
   sub store_handler {
       my ($cmd, $tail, $client) = @_;
     
     my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
       chomp($tail);
     my ($udom,$uname,$namespace,$rid,$what) =split(/:/,$tail);      my ($udom,$uname,$namespace,$rid,$what,$laststore) =split(/:/,$tail);
     if ($namespace ne 'roles') {      if ($namespace ne 'roles') {
   
  chomp($what);  
  my @pairs=split(/\&/,$what);   my @pairs=split(/\&/,$what);
  my $hashref  = TieUserHash($udom, $uname, $namespace,   my $hashref  = &tie_user_hash($udom, $uname, $namespace,
        &GDBM_WRCREAT(), "P",         &GDBM_WRCREAT(), "S",
        "$rid:$what");         "$rid:$what");
  if ($hashref) {   if ($hashref) {
     my $now = time;      my $now = time;
     my @previouskeys=split(/&/,$hashref->{"keys:$rid"});              my $numtrans;
     my $key;              if ($laststore) {
                   my ($previousversion,$previoustime) = split(/\=/,$laststore);
                   my ($lastversion,$lasttime) = (0,0);
                   $lastversion = $hashref->{"version:$rid"};
                   if ($lastversion) {
                       $lasttime = $hashref->{"$lastversion:$rid:timestamp"};
                   }
                   if (($previousversion) && ($previousversion !~ /\D/)) {
                       if (($lastversion > $previousversion) && ($lasttime >= $previoustime)) {
                           $numtrans = $lastversion - $previousversion;
                       }
                   } elsif ($lastversion) {
                       $numtrans = $lastversion;
                   }
                   if ($numtrans) {
                       $numtrans =~ s/D//g;
                   }
               }
     $hashref->{"version:$rid"}++;      $hashref->{"version:$rid"}++;
     my $version=$hashref->{"version:$rid"};      my $version=$hashref->{"version:$rid"};
     my $allkeys='';       my $allkeys=''; 
Line 1894  sub StoreHandler { Line 3976  sub StoreHandler {
     $hashref->{"$version:$rid:timestamp"}=$now;      $hashref->{"$version:$rid:timestamp"}=$now;
     $allkeys.='timestamp';      $allkeys.='timestamp';
     $hashref->{"$version:keys:$rid"}=$allkeys;      $hashref->{"$version:keys:$rid"}=$allkeys;
     if (untie($hashref)) {      if (&untie_user_hash($hashref)) {
  Reply($client, "ok\n", $userinput);                  my $msg = 'ok';
                   if ($numtrans) {
                       $msg = 'delay:'.$numtrans;
                   }
    &Reply($client, "$msg\n", $userinput);
     } else {      } else {
  Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".   &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
  "while attempting store\n", $userinput);   "while attempting store\n", $userinput);
     }      }
  } else {   } else {
     Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".      &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
      "while attempting store\n", $userinput);       "while attempting store\n", $userinput);
  }   }
     } else {      } else {
  Failure($client, "refused\n", $userinput);   &Failure($client, "refused\n", $userinput);
     }      }
   
     return 1;      return 1;
 }  }
 RegisterHandler("store", \&StoreHandler, 0, 1, 0);  &register_handler("store", \&store_handler, 0, 1, 0);
   
   #  Modify a set of key=value pairs associated with a versioned name.
 #  #
 #   Restore a prior version of a resource.  #  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.
   #                          v           - Version item 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 putstore_handler {
       my ($cmd, $tail, $client) = @_;
    
       my $userinput = "$cmd:$tail";
   
       my ($udom,$uname,$namespace,$rid,$v,$what) =split(/:/,$tail);
       if ($namespace ne 'roles') {
   
    chomp($what);
    my $hashref  = &tie_user_hash($udom, $uname, $namespace,
          &GDBM_WRCREAT(), "M",
          "$rid:$v:$what");
    if ($hashref) {
       my $now = time;
       my %data = &hash_extract($what);
       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);
       }
   
       return 1;
   }
   &register_handler("putstore", \&putstore_handler, 0, 1, 0);
   
   sub hash_extract {
       my ($str)=@_;
       my %hash;
       foreach my $pair (split(/\&/,$str)) {
    my ($key,$value)=split(/=/,$pair);
    $hash{$key}=$value;
       }
       return (%hash);
   }
   sub hash_to_str {
       my ($hash_ref)=@_;
       my $str;
       foreach my $key (keys(%$hash_ref)) {
    $str.=$key.'='.$hash_ref->{$key}.'&';
       }
       $str=~s/\&$//;
       return $str;
   }
   
   #
   #  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 1926  RegisterHandler("store", \&StoreHandler, Line 4094  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:
   #   version=current&version:keys=k1:k2...&1:k1=v1&1:k2=v2...
   #    Where the 1 above represents version 1.
   #    this continues for all pairs of keys in all versions.
   #
 #  #
 sub RestoreHandler {  #    
     my $cmd     = shift;  #
     my $tail    = shift;  sub restore_handler {
     my $client  = shift;      my ($cmd, $tail, $client) = @_;
   
     my $userinput = "$cmd:$tail"; # Only used for logging purposes.      my $userinput = "$cmd:$tail"; # Only used for logging purposes.
       my ($udom,$uname,$namespace,$rid) = split(/:/,$tail);
     my ($cmd,$udom,$uname,$namespace,$rid) = split(/:/,$userinput);  
     $namespace=~s/\//\_/g;      $namespace=~s/\//\_/g;
     $namespace=~s/\W//g;      $namespace = &LONCAPA::clean_username($namespace);
   
     chomp($rid);      chomp($rid);
     my $proname=propath($udom,$uname);  
     my $qresult='';      my $qresult='';
     my %hash;      my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER());
     if (tie(%hash,'GDBM_File',"$proname/$namespace.db",      if ($hashref) {
     &GDBM_READER(),0640)) {   my $version=$hashref->{"version:$rid"};
  my $version=$hash{"version:$rid"};  
  $qresult.="version=$version&";   $qresult.="version=$version&";
  my $scope;   my $scope;
  for ($scope=1;$scope<=$version;$scope++) {   for ($scope=1;$scope<=$version;$scope++) {
     my $vkeys=$hash{"$scope:keys:$rid"};      my $vkeys=$hashref->{"$scope:keys:$rid"};
     my @keys=split(/:/,$vkeys);      my @keys=split(/:/,$vkeys);
     my $key;      my $key;
     $qresult.="$scope:keys=$vkeys&";      $qresult.="$scope:keys=$vkeys&";
     foreach $key (@keys) {      foreach $key (@keys) {
  $qresult.="$scope:$key=".$hash{"$scope:$rid:$key"}."&";   $qresult.="$scope:$key=".$hashref->{"$scope:$rid:$key"}."&";
     }                                        }                                  
  }   }
  if (untie(%hash)) {   if (&untie_user_hash($hashref)) {
     $qresult=~s/\&$//;      $qresult=~s/\&$//;
     Reply( $client, "$qresult\n", $userinput);      &Reply( $client, \$qresult, $userinput);
  } else {   } else {
     Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
     "while attempting restore\n", $userinput);      "while attempting restore\n", $userinput);
  }   }
     } else {      } else {
  Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting restore\n", $userinput);   "while attempting restore\n", $userinput);
     }      }
       
Line 1971  sub RestoreHandler { Line 4142  sub RestoreHandler {
   
   
 }  }
 RegisterHandler("restore", \&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 1991  RegisterHandler("restore", \&RestoreHand Line 4164  RegisterHandler("restore", \&RestoreHand
 #   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 2016  RegisterHandler("chatsend", \&SendChatHa Line 4189  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 2049  RegisterHandler("chatretr", \&RetrieveCh Line 4224  RegisterHandler("chatretr", \&RetrieveCh
 #  serviced.  #  serviced.
 #  #
 #  Parameters:  #  Parameters:
 #     $cmd       - COmmand keyword that initiated the request.  #     $cmd       - Command keyword that initiated the request.
 #     $tail      - Remainder of the command after the keyword.  #     $tail      - Remainder of the command after the keyword.
 #                  For this function, this consists of a query and  #                  For this function, this consists of a query and
 #                  3 arguments that are self-documentingly labelled  #                  3 arguments that are self-documentingly labelled
Line 2060  RegisterHandler("chatretr", \&RetrieveCh Line 4235  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 $userinput = "$cmd:$tail";
   
     my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);      my ($query,$arg1,$arg2,$arg3)=split(/\:/,$tail);
     $query=~s/\n*$//g;      $query=~s/\n*$//g;
     Reply($client, "". sqlreply("$clientname\&$query".      if (($query eq 'usersearch') || ($query eq 'instdirsearch')) {
           my $usersearchconf = &get_usersearch_config($currentdomainid,'directorysrch');
           my $earlyout;
           if (ref($usersearchconf) eq 'HASH') {
               if ($currentdomainid eq $clienthomedom) {
                   if ($query eq 'usersearch') {
                       if ($usersearchconf->{'lcavailable'} eq '0') {
                           $earlyout = 1;
                       }
                   } else {
                       if ($usersearchconf->{'available'} eq '0') {
                           $earlyout = 1;
                       }
                   }
               } else {
                   if ($query eq 'usersearch') {
                       if ($usersearchconf->{'lclocalonly'}) {
                           $earlyout = 1;
                       }
                   } else {
                       if ($usersearchconf->{'localonly'}) {
                           $earlyout = 1;
                       }
                   }
               }
           }
           if ($earlyout) {
               &Reply($client, "query_not_authorized\n");
               return 1;
           }
       }
       &Reply($client, "". &sql_reply("$clientname\&$query".
  "\&$arg1"."\&$arg2"."\&$arg3")."\n",   "\&$arg1"."\&$arg2"."\&$arg3")."\n",
   $userinput);    $userinput);
           
     return 1;      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 2102  RegisterHandler("querysend", \&SendQuery Line 4306  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 ($cmd,$id,$reply)=split(/:/,$userinput);       my ($id,$reply)=split(/:/,$tail); 
     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")) {
Line 2119  sub ReplyQueryHandler { Line 4322  sub ReplyQueryHandler {
  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 {      } else {
  Failure($client, "error: ".($!+0)   &Failure($client, "error: ".($!+0)
  ." IO::File->new Failed ".   ." IO::File->new Failed ".
  "while attempting queryreply\n", $userinput);   "while attempting queryreply\n", $userinput);
     }      }
Line 2129  sub ReplyQueryHandler { Line 4332  sub ReplyQueryHandler {
   
     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 2141  RegisterHandler("queryreply", \&ReplyQue Line 4345  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 2148  RegisterHandler("queryreply", \&ReplyQue Line 4360  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);      my ($udom, $what) = split(/:/, $tail,2);
     chomp($what);      chomp($what);
     my $now=time;      my $now=time;
     my @pairs=split(/\&/,$what);      my @pairs=split(/\&/,$what);
   
     my $hashref = TieDomainHash($udom, "nohist_courseids", &GDBM_WRCREAT());      my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
     if ($hashref) {      if ($hashref) {
  foreach my $pair (@pairs) {   foreach my $pair (@pairs) {
     my ($key,$value)=split(/=/,$pair);              my ($key,$courseinfo) = split(/=/,$pair,2);
     $hashref->{$key}=$value.':'.$now;              $courseinfo =~ s/=/:/g;
               if (defined($hashref->{$key})) {
                   my $value = &Apache::lonnet::thaw_unescape($hashref->{$key});
                   if (ref($value) eq 'HASH') {
                       my @items = ('description','inst_code','owner','type');
                       my @new_items = split(/:/,$courseinfo,-1);
                       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(%$hashref)) {   if (&untie_domain_hash($hashref)) {
     Reply($client, "ok\n", $userinput);      &Reply( $client, "ok\n", $userinput);
  } else {   } else {
     Failure( $client, "error: ".($!+0)      &Failure($client, "error: ".($!+0)
      ." untie(GDBM) Failed ".       ." untie(GDBM) Failed ".
      "while attempting courseidput\n", $userinput);       "while attempting courseidput\n", $userinput);
  }   }
     } else {      } else {
  Failure( $client, "error: ".($!+0)   &Failure($client, "error: ".($!+0)
  ." tie(GDBM) Failed ".   ." tie(GDBM) Failed ".
  "while attempting courseidput\n", $userinput);   "while attempting courseidput\n", $userinput);
     }      }
   
     return 1;      return 1;
 }  }
 RegisterHandler("courseidput", \&PutCourseIdHandler, 0, 1, 0);  &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;
   }
   &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 2201  RegisterHandler("courseidput", \&PutCour Line 4488  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.
   #                 hasuniquecode - filter by courses for which a six character unique code has 
   #                                 been set.
   #
 #     $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:/) {
           Failure($client, \$res, "$cmd:$tail");
       } else {
           Reply($client, \$res, "$cmd:$tail");
       }
   
       return 1;  
   
       #TODO remove
     my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
   
     my ($udom,$since,$description) =split(/:/,$tail);      my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
           $typefilter,$regexp_ok,$rtn_as_hash,$selfenrollonly,$catfilter,$showhidden,
           $caller,$cloner,$cc_clone_list,$cloneonly,$createdbefore,$createdafter,
           $creationcontext,$domcloner,$hasuniquecode) =split(/:/,$tail);
       my $now = time;
       my ($cloneruname,$clonerudom,%cc_clone);
     if (defined($description)) {      if (defined($description)) {
  $description=&unescape($description);   $description=&unescape($description);
     } else {      } else {
  $description='.';   $description='.';
     }      }
     unless (defined($since)) { $since=0; }      if (defined($instcodefilter)) {
           $instcodefilter=&unescape($instcodefilter);
       } 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 = '.';
       }
       unless ($hasuniquecode) {
           $hasuniquecode = '.';
       }
       my $unpack = 1;
       if ($description eq '.' && $instcodefilter eq '.' && $ownerfilter eq '.' && 
           $typefilter eq '.') {
           $unpack = 0;
       }
       if (!defined($since)) { $since=0; }
     my $qresult='';      my $qresult='';
     logthis(" Looking for $description  since $since");      my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT());
     my $hashref = TieDomainHash($udom, "nohist_courseids", &GDBM_WRCREAT());  
     if ($hashref) {      if ($hashref) {
  while (my ($key,$value) = each(%$hashref)) {   while (my ($key,$value) = each(%$hashref)) {
     my ($descr,$lasttime)=split(/\:/,$value);              my ($unesc_key,$lasttime_key,$lasttime,$is_hash,%val,
     logthis("Got:  key = $key descr = $descr time: $lasttime");                  %unesc_val,$selfenroll_end,$selfenroll_types,$created,
     if ($lasttime<$since) {                   $context);
  logthis("Skipping .. too early");              $unesc_key = &unescape($key);
  next;               if ($unesc_key =~ /^lasttime:/) {
     }                  next;
     if ($description eq '.') {              } else {
  logthis("Adding wildcard match");                  $lasttime_key = &escape('lasttime:'.$unesc_key);
  $qresult.=$key.'='.$descr.'&';              }
     } else {              if ($hashref->{$lasttime_key} ne '') {
  my $unescapeVal = &unescape($descr);                  $lasttime = $hashref->{$lasttime_key};
  logthis("Matching with $unescapeVal");                  next if ($lasttime<$since);
  if (eval('$unescapeVal=~/$description/i')) {              }
     logthis("Adding on match");              my ($canclone,$valchange);
     $qresult.="$key=$descr&";              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 ($hasuniquecode ne '.') {
                       next unless ($items->{'uniquecode'});
                   }
                   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(%$hashref)) {   if (&untie_domain_hash($hashref)) {
     chop($qresult);      chop($qresult);
     Reply($client, "$qresult\n", $userinput);      &Reply($client, \$qresult, $userinput);
  } else {   } else {
     Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
     "while attempting courseiddump\n", $userinput);      "while attempting courseiddump\n", $userinput);
  }   }
     } else {      } else {
  Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting courseiddump\n", $userinput);   "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);
       }
       return 1;
   }
   &register_handler("courselastaccess",\&course_lastaccess_handler, 0, 1, 0);
   
   sub course_sessions_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($cdom,$cnum,$lastactivity) = split(':',$tail);
       my $dbsuffix = '_'.$cdom.'_'.$cnum.'.db';
       my (%sessions,$qresult);
       my $now=time;
       if (opendir(DIR,$perlvar{'lonIDsDir'})) {
           my $filename;
           while ($filename=readdir(DIR)) {
               next if ($filename=~/^\./);
               next if ($filename=~/^publicuser_/);
               next if ($filename=~/^[a-f0-9]+_(linked|lti_\d+)\.id$/);
               if ($filename =~ /^($LONCAPA::match_username)_\d+_($LONCAPA::match_domain)_/) {
                   my ($uname,$udom) = ($1,$2);
                   next unless (-e "$perlvar{'lonDaemons'}/tmp/$uname$dbsuffix");
                   my $mtime = (stat("$perlvar{'lonIDsDir'}/$filename"))[9];
                   if ($lastactivity < 0) {
                       next if ($mtime-$now > $lastactivity);
                   } else {
                       next if ($now-$mtime > $lastactivity);
                   }
                   $sessions{$uname.':'.$udom} = $mtime;
               }
           }
           closedir(DIR); 
       }
       foreach my $user (keys(%sessions)) {
           $qresult.=&escape($user).'='.$sessions{$user}.'&';
       }
       if ($qresult) {
           chop($qresult);
       }
       &Reply($client, \$qresult, $userinput);
       return 1;
   }
   &register_handler("coursesessions",\&course_sessions_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 {
           &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
                     "while attempting putdom\n", $userinput);
       }
   
       return 1;
   }
   &register_handler("putdom", \&put_domain_handler, 0, 1, 0);
   
   # Updates one or more entries in clickers.db file at the domain level
   #
   # Parameters:
   #    $cmd      - The command that got us here.
   #    $tail     - Tail of the command (remaining parameters).
   #                In this case a colon separated list containing:
   #                (a) the domain for which we are updating the entries,
   #                (b) the action required -- add or del -- and
   #                (c) a &-separated list of entries to add or delete.
   #    $client   - File descriptor connected to client.
   # Returns
   #     1        - Continue processing.
   #     0        - Requested to exit, caller should shut down.
   #  Side effects:
   #     reply is written to $client.
   #
   
   
   sub update_clickers {
       my ($cmd, $tail, $client)  = @_;
   
       my $userinput = "$cmd:$tail";
       my ($udom,$action,$what) =split(/:/,$tail,3);
       chomp($what);
   
       my $hashref = &tie_domain_hash($udom, "clickers", &GDBM_WRCREAT(),
                                    "U","$action:$what");
   
       if (!$hashref) {
           &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
                     "while attempting updateclickers\n", $userinput);
           return 1;
       }
   
       my @pairs=split(/\&/,$what);
       foreach my $pair (@pairs) {
           my ($key,$value)=split(/=/,$pair);
           if ($action eq 'add') {
               if (exists($hashref->{$key})) {
                   my @newvals = split(/,/,&unescape($value));
                   my @currvals = split(/,/,&unescape($hashref->{$key}));
                   my @merged = sort(keys(%{{map { $_ => 1 } (@newvals,@currvals)}}));
                   $hashref->{$key}=&escape(join(',',@merged));
               } else {
                   $hashref->{$key}=$value;
               }
           } elsif ($action eq 'del') {
               if (exists($hashref->{$key})) {
                   my %current;
                   map { $current{$_} = 1; } split(/,/,&unescape($hashref->{$key}));
                   map { delete($current{$_}); } split(/,/,&unescape($value));
                   if (keys(%current)) {
                       $hashref->{$key}=&escape(join(',',sort(keys(%current))));
                   } else {
                       delete($hashref->{$key});
                   }
               }
           }
       }
       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("updateclickers", \&update_clickers, 0, 1, 0);
   
   
   # Deletes one or more entries in a namespace db file at the domain level
   #
   # Parameters:
   #    $cmd      - The command that got us here.
   #    $tail     - Tail of the command (remaining parameters).
   #                In this case a colon separated list containing:
   #                (a) the domain for which we are deleting the entries,
   #                (b) &-separated list of keys to delete.  
   #    $client   - File descriptor connected to client.
   # Returns
   #     1        - Continue processing.
   #     0        - Requested to exit, caller should shut down.
   #  Side effects:
   #     reply is written to $client.
   #
   
   sub del_domain_handler {
       my ($cmd,$tail,$client) = @_;
   
       my $userinput = "$cmd:$tail";
   
       my ($udom,$namespace,$what)=split(/:/,$tail,3);
       chomp($what);
       my $hashref = &tie_domain_hash($udom,$namespace,&GDBM_WRCREAT(),
                                      "D", $what);
       if ($hashref) {
           my @keys=split(/\&/,$what);
           foreach my $key (@keys) {
               delete($hashref->{$key});
           }
           if (&untie_user_hash($hashref)) {
               &Reply($client, "ok\n", $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                       "while attempting deldom\n", $userinput);
           }
       } else {
           &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
                    "while attempting deldom\n", $userinput);
       }
       return 1;
   }
   &register_handler("deldom", \&del_domain_handler, 0, 1, 0);
   
   
   # 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 (getdom).
   #   $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 = "$cmd:$tail";
   
       my ($udom,$namespace,$what)=split(/:/,$tail,3);
       if (($namespace =~ /^enc/) || ($namespace eq 'private')) {
           &Failure( $client, "refused\n", $userinput);
       } else {
           my $res = LONCAPA::Lond::get_dom($userinput);
           if ($res =~ /^error:/) {
               &Failure($client, \$res, $userinput);
           } else {
               &Reply($client, \$res, $userinput);
           }
       }
   
       return 1;
   }
   &register_handler("getdom", \&get_domain_handler, 0, 1, 0);
   
   #
   # Encrypted 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 (egetdom).
   #   $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 encrypted before being written to $client.
   #
   sub encrypted_get_domain_handler {
       my ($cmd, $tail, $client) = @_;
   
       my $userinput = "$cmd:$tail";
   
       my ($udom,$namespace,$what) = split(/:/,$tail,3);
       if ($namespace eq 'private') {
           &Failure( $client, "refused\n", $userinput);
       } else {
           my $res = LONCAPA::Lond::get_dom($userinput);
           if ($res =~ /^error:/) {
               &Failure($client, \$res, $userinput);
           } else {
               if ($cipher) {
                   my $cmdlength=length($res);
                   $res.="         ";
                   my $encres='';
                   for (my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
                       $encres.= unpack("H16",
                                        $cipher->encrypt(substr($res,
                                                                $encidx,
                                                                8)));
                   }
                   &Reply( $client,"enc:$cmdlength:$encres\n",$userinput);
               } else {
                   &Failure( $client, "error:no_key\n",$userinput);
               }
           }
       }
       return 1;
   }
   &register_handler("egetdom", \&encrypted_get_domain_handler, 1, 1, 0);
   
   #
   # Encrypted 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 (lti).
   #   $tail            - Tail of the command.  This is a colon-separated list
   #                      consisting of the domain, coursenum, if for LTI-
   #                      enabled deep-linking to course content using
   #                      link protection configured within a course,
   #                      context (=deeplink) if for LTI-enabled deep-linking
   #                      to course content using LTI Provider settings
   #                      configured within a course's domain, the (escaped)
   #                      launch URL, the (escaped) method (typically POST),
   #                      and a frozen hash of the LTI launch parameters
   #                      from the LTI payload.
   #   $client          - File descriptor open on the client.
   # Returns:
   #   1       - Continue processing.
   #   0       - Exit.
   #  Side effects:
   #     The reply will contain an LTI itemID, if the signed LTI payload
   #     could be verified using the consumer key and the shared secret
   #     available for that key (for the itemID) for either the course or domain,
   #     depending on values for cnum and context. The reply is encrypted before
   #     being written to $client.
   #
   sub lti_handler {
       my ($cmd, $tail, $client) = @_;
   
       my $userinput = "$cmd:$tail";
   
       my ($cdom,$cnum,$context,$escurl,$escmethod,$items) = split(/:/,$tail);
       my $url = &unescape($escurl);
       my $method = &unescape($escmethod);
       my $params = &Apache::lonnet::thaw_unescape($items);
       my $res;
       if ($cnum ne '') {
           $res = &LONCAPA::Lond::crslti_itemid($cdom,$cnum,$url,$method,$params,$perlvar{'lonVersion'});
       } else {
           $res = &LONCAPA::Lond::domlti_itemid($cdom,$context,$url,$method,$params,$perlvar{'lonVersion'});
       }
       if ($res =~ /^error:/) {
           &Failure($client, \$res, $userinput);
       } else {
           if ($cipher) {
               my $cmdlength=length($res);
               $res.="         ";
               my $encres='';
               for (my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
                   $encres.= unpack("H16",
                                    $cipher->encrypt(substr($res,
                                                            $encidx,
                                                            8)));
               }
               &Reply( $client,"enc:$cmdlength:$encres\n",$userinput);
           } else {
               &Failure( $client, "error:no_key\n",$userinput);
           }
       }
       return 1;
   }
   &register_handler("lti", \&lti_handler, 1, 1, 0);
   
   #
   # Data for LTI payload (received encrypted) are unencrypted and
   # then signed with the appropriate key and secret, before re-encrypting
   # the signed payload which is sent to the client for unencryption by
   # the caller: lonnet::sign_lti()) before dispatch either to a web browser
   # (launch) or to a remote web service (roster, logout, or grade).  
   #
   # Parameters:
   #   $cmd             - Command request keyword (signlti).
   #   $tail            - Tail of the command.  This is a colon-separated list
   #                      consisting of the domain, coursenum (if for an External
   #                      Tool defined in a course), crsdef (true if defined in
   #                      a course), type (linkprot or lti)
   #                      context (launch, roster, logout, or grade),
   #                      escaped launch URL, numeric ID of external tool,
   #                      version number for encryption key (if tool's LTI secret was
   #                      encrypted before storing), a frozen hash of LTI launch 
   #                      parameters, and a frozen hash of LTI information,
   #                      (e.g., method => 'HMAC-SHA1',
   #                             respfmt => 'to_authorization_header').
   #   $client          - File descriptor open on the client.
   # Returns:
   #   1       - Continue processing.
   #   0       - Exit.
   #  Side effects:
   #     The reply will contain the LTI payload, as & separated key=value pairs,
   #     where value is itself a frozen hash, if the required key and secret
   #     for the specific tool ID are available. The payload data are retrieved from
   #     a call to Lond::sign_lti_payload(), and the reply is encrypted before being
   #     written to $client.
   #
   sub sign_lti_handler {
       my ($cmd, $tail, $client) = @_;
   
       my $userinput = "$cmd:$tail";
   
       my ($cdom,$cnum,$crsdef,$type,$context,$escurl,
           $ltinum,$keynum,$paramsref,$inforef) = split(/:/,$tail);
       my $url = &unescape($escurl);
       my $params = &Apache::lonnet::thaw_unescape($paramsref);
       my $info = &Apache::lonnet::thaw_unescape($inforef);
       my $res =
           &LONCAPA::Lond::sign_lti_payload($cdom,$cnum,$crsdef,$type,$context,$url,$ltinum,
                                            $keynum,$perlvar{'lonVersion'},$params,$info);
       my $result;
       if (ref($res) eq 'HASH') {
           foreach my $key (keys(%{$res})) {
               $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($res->{$key}).'&';
           }
           $result =~ s/\&$//;
       } else {
           $result = $res;
       }
       if ($result =~ /^error:/) {
           &Failure($client, \$result, $userinput);
       } else {
           if ($cipher) {
               my $cmdlength=length($result);
               $result.="         ";
               my $encres='';
               for (my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
                   $encres.= unpack("H16",
                                    $cipher->encrypt(substr($result,
                                                            $encidx,
                                                            8)));
               }
               &Reply( $client,"enc:$cmdlength:$encres\n",$userinput);
           } else {
               &Failure( $client, "error:no_key\n",$userinput);
           }
       }
     return 1;      return 1;
 }  }
 RegisterHandler("courseiddump", \&DumpCourseIdHandler, 0, 1, 0);  &register_handler("signlti", \&sign_lti_handler, 1, 1, 0);
   
 #  #
 #  Puts an id to a domains id database.   #  Puts an id to a domains id database. 
 #  #
Line 2275  RegisterHandler("courseiddump", \&DumpCo Line 5398  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);      my @pairs=split(/\&/,$what);
     my $hashref = TieDomainHash($udom, "ids", &GDBM_WRCREAT(),      my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
  "P", $what);     "P", $what);
     if ($hashref) {      if ($hashref) {
  foreach my $pair (@pairs) {   foreach my $pair (@pairs) {
     my ($key,$value)=split(/=/,$pair);      my ($key,$value)=split(/=/,$pair);
     $hashref->{$key}=$value;      $hashref->{$key}=$value;
  }   }
  if (untie(%$hashref)) {   if (&untie_domain_hash($hashref)) {
     Reply($client, "ok\n", $userinput);      &Reply($client, "ok\n", $userinput);
  } else {   } else {
     Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
     "while attempting idput\n", $userinput);       "while attempting idput\n", $userinput);
  }   }
     } else {      } else {
  Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting idput\n", $userinput);    "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 2326  RegisterHandler("idput", \&PutIdHandler, Line 5448  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 $userinput = "$client:$tail";
           
Line 2337  sub GetIdHandler { Line 5458  sub GetIdHandler {
     chomp($what);      chomp($what);
     my @queries=split(/\&/,$what);      my @queries=split(/\&/,$what);
     my $qresult='';      my $qresult='';
     my $hashref = TieDomainHash($udom, "ids", &GDBM_READER());      my $hashref = &tie_domain_hash($udom, "ids", &GDBM_READER());
     if ($hashref) {      if ($hashref) {
  for (my $i=0;$i<=$#queries;$i++) {   for (my $i=0;$i<=$#queries;$i++) {
     $qresult.="$hashref->{$queries[$i]}&";      $qresult.="$hashref->{$queries[$i]}&";
  }   }
  if (untie(%$hashref)) {   if (&untie_domain_hash($hashref)) {
     $qresult=~s/\&$//;      $qresult=~s/\&$//;
     Reply($client, "$qresult\n", $userinput);      &Reply($client, \$qresult, $userinput);
  } else {   } else {
     Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".      &Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".
      "while attempting idget\n",$userinput);        "while attempting idget\n",$userinput);
  }   }
     } else {      } else {
  Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".   &Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".
  "while attempting idget\n",$userinput);   "while attempting idget\n",$userinput);
     }      }
           
     return 1;      return 1;
 }  }
   &register_handler("idget", \&get_id_handler, 0, 1, 0);
   
 RegisterHandler("idget", \&GetIdHandler, 0, 1, 0);  #   Deletes one or more ids in a domain's id database.
 #  #
   #   Parameters:
   #       $cmd                  - Command keyword (iddel).
   #       $tail                 - Command tail.  In this case a colon
   #                               separated list containing:
   #                               The domain for which we are deleting the id(s).
   #                               &-separated list of id(s) to delete.
   #       $client               - File open on client socket.
   # Returns:
   #     1   - Continue processing
   #     0   - Exit server.
   #     
   #
   
   sub del_id_handler {
       my ($cmd,$tail,$client) = @_;
   
       my $userinput = "$cmd:$tail";
   
       my ($udom,$what)=split(/:/,$tail);
       chomp($what);
       my $hashref = &tie_domain_hash($udom, "ids", &GDBM_WRCREAT(),
                                      "D", $what);
       if ($hashref) {
           my @keys=split(/\&/,$what);
           foreach my $key (@keys) {
               delete($hashref->{$key});
           }
           if (&untie_user_hash($hashref)) {
               &Reply($client, "ok\n", $userinput);
           } else {
               &Failure($client, "error: ".($!+0)." untie(GDBM) Failed ".
                       "while attempting iddel\n", $userinput);
           }
       } else {
           &Failure( $client, "error: ".($!+0)." tie(GDBM) Failed ".
                    "while attempting iddel\n", $userinput);
       }
       return 1;
   }
   &register_handler("iddel", \&del_id_handler, 0, 1, 0);
   
   #
   # Puts broadcast e-mail sent by Domain Coordinator in nohist_dcmail database 
   #
   # 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 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);
   
   #
   # Puts domain roles in nohist_domainroles database
   #
   # Parameters
   #   $cmd       - Command keyword that caused us to be dispatched.
   #   $tail      - Tail of the command.  Consists of a colon separated:
   #               domain - the domain whose roles we are recording  
   #               role -   Consists of key=value pair
   #                        where key is unique role
   #                        and value is start/end date information
   #   $client    - Socket open on the client.
   #
   # Returns:
   #    1 - indicating processing should continue.
   # Side effects
   #     reply is written to $client.
   #
   
   sub put_domainroles_handler {
       my ($cmd,$tail,$client) = @_;
   
       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);
   
   #
   # Retrieves domain roles from nohist_domainroles database
   # Returns to client an & separated list of key=value pairs,
   # where key is role and value is start and end date 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 domain roles table we dump
   #   $client    - Socket open on the client.
   #
   # Returns:
   #    1 - indicating processing should continue.
   # Side effects
   #     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  #  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  #  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.  # where Id is the client's ip concatenated with a sequence number.
Line 2375  RegisterHandler("idget", \&GetIdHandler, Line 5795  RegisterHandler("idget", \&GetIdHandler,
 # Side effects:  # Side effects:
 #   A file is created in the local filesystem.  #   A file is created in the local filesystem.
 #   A reply is sent to the client.  #   A reply is sent to the client.
 sub TmpPutHandler {  sub tmp_put_handler {
     my $cmd       = shift;      my ($cmd, $what, $client) = @_;
     my $what      = shift;  
     my $client    = shift;  
   
     my $userinput = "$cmd:$what"; # Reconstruct for logging.      my $userinput = "$cmd:$what"; # Reconstruct for logging.
   
       my ($record,$context) = split(/:/,$what);
     my $store;      if ($context ne '') {
           chomp($context);
           $context = &unescape($context);
       }
       my ($id,$store);
     $tmpsnum++;      $tmpsnum++;
     my $id=$$.'_'.$clientip.'_'.$tmpsnum;      my $numtries = 0;
     $id=~s/\W/\_/g;  
     $what=~s/\n//g;  
     my $execdir=$perlvar{'lonDaemons'};      my $execdir=$perlvar{'lonDaemons'};
     if ($store=IO::File->new(">$execdir/tmp/$id.tmp")) {      if (($context eq 'resetpw') || ($context eq 'createaccount') ||
  print $store $what;          ($context eq 'sso') || ($context eq 'link') || ($context eq 'retry')) {
           $id = &md5_hex(&md5_hex(time.{}.rand().$$.$tmpsnum));
           while ((-e "$execdir/tmp/$id.tmp") && ($numtries <10)) {
               undef($id);
               $id = &md5_hex(&md5_hex(time.{}.rand().$$.$tmpsnum));
               $numtries ++;
           }
       } else {
           $id = $$.'_'.$clientip.'_'.$tmpsnum;
       }
       $id=~s/\W/\_/g;
       $record=~s/\n//g;
       if (($id ne '') &&
           ($store=IO::File->new(">$execdir/tmp/$id.tmp"))) {
    print $store $record;
  close $store;   close $store;
  Reply($client, "$id\n", $userinput);   &Reply($client, \$id, $userinput);
     } else {      } else {
  Failure( $client, "error: ".($!+0)."IO::File->new Failed ".   &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
  "while attempting tmpput\n", $userinput);    "while attempting tmpput\n", $userinput);
     }      }
     return 1;      return 1;
       
 }  }
 RegisterHandler("tmpput", \&TmpPutHandler, 0, 1, 0);  &register_handler("tmpput", \&tmp_put_handler, 0, 1, 0);
   
 #   Processes the tmpget command.  This command returns the contents  #   Processes the tmpget command.  This command returns the contents
 #  of a temporary resource file(?) created via tmpput.  #  of a temporary resource file(?) created via tmpput.
Line 2414  RegisterHandler("tmpput", \&TmpPutHandle Line 5848  RegisterHandler("tmpput", \&TmpPutHandle
 #    1         - Inidcating processing can continue.  #    1         - Inidcating processing can continue.
 # Side effects:  # Side effects:
 #   A reply is sent to the client.  #   A reply is sent to the client.
   
 #  #
 sub TmpGetHandler {  sub tmp_get_handler {
     my $cmd       = shift;      my ($cmd, $id, $client) = @_;
     my $id        = shift;  
     my $client    = shift;  
     my $userinput = "$cmd:$id";       my $userinput = "$cmd:$id"; 
           
     chomp($id);  
     $id=~s/\W/\_/g;      $id=~s/\W/\_/g;
     my $store;      my $store;
     my $execdir=$perlvar{'lonDaemons'};      my $execdir=$perlvar{'lonDaemons'};
     if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {      if ($store=IO::File->new("$execdir/tmp/$id.tmp")) {
  my $reply=<$store>;   my $reply=<$store>;
  Reply( $client, "$reply\n", $userinput);   &Reply( $client, \$reply, $userinput);
  close $store;   close $store;
     } else {      } else {
  Failure( $client, "error: ".($!+0)."IO::File->new Failed ".   &Failure( $client, "error: ".($!+0)."IO::File->new Failed ".
  "while attempting tmpget\n", $userinput);    "while attempting tmpget\n", $userinput);
     }      }
   
     return 1;      return 1;
 }  }
 RegisterHandler("tmpget", \&TmpGetHandler, 0, 1, 0);  &register_handler("tmpget", \&tmp_get_handler, 0, 1, 0);
   
 #  #
 #  Process the tmpdel command.  This command deletes a temp resource  #  Process the tmpdel command.  This command deletes a temp resource
 #  created by the tmpput command.  #  created by the tmpput command.
Line 2452  RegisterHandler("tmpget", \&TmpGetHandle Line 5885  RegisterHandler("tmpget", \&TmpGetHandle
 # Side Effects:  # Side Effects:
 #   A file is deleted  #   A file is deleted
 #   A reply is sent to the client.  #   A reply is sent to the client.
 sub TmpDelHandler {  sub tmp_del_handler {
     my $cmd      = shift;      my ($cmd, $id, $client) = @_;
     my $id       = shift;  
     my $client   = shift;  
           
     my $userinput= "$cmd:$id";      my $userinput= "$cmd:$id";
           
Line 2463  sub TmpDelHandler { Line 5894  sub TmpDelHandler {
     $id=~s/\W/\_/g;      $id=~s/\W/\_/g;
     my $execdir=$perlvar{'lonDaemons'};      my $execdir=$perlvar{'lonDaemons'};
     if (unlink("$execdir/tmp/$id.tmp")) {      if (unlink("$execdir/tmp/$id.tmp")) {
  Reply($client, "ok\n", $userinput);   &Reply($client, "ok\n", $userinput);
     } else {      } else {
  Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".   &Failure( $client, "error: ".($!+0)."Unlink tmp Failed ".
  "while attempting tmpdel\n", $userinput);    "while attempting tmpdel\n", $userinput);
     }      }
           
     return 1;      return 1;
   
 }  }
 RegisterHandler("tmpdel", \&TmpDelHandler, 0, 1, 0);  &register_handler("tmpdel", \&tmp_del_handler, 0, 1, 0);
   
   #
   #  Process the updatebalcookie command.  This command updates a
   #  cookie in the lonBalancedir directory on a load balancer node.
 #  #
 #   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:  # Parameters:
 #    $cmd        - The command that dispatched us (ls).  #   $cmd      - Command that got us here.
 #    $ulsdir     - The directory path to list... I'm not sure what this  #   $tail     - Tail of the request (escaped cookie: escaped current entry)
 #                  is relative as things like ls:. return e.g.  #
 #                  no_such_dir.  #   $client   - socket open on the client process.
 #    $client     - Socket open on the client.  #
 # Returns:  # Returns:
 #     1 - indicating that the daemon should not disconnect.  #   1     - Indicating processing should continue.
 # Side Effects:  # Side Effects:
 #   The reply is written to  $client.  #   A cookie file is updated from the lonBalancedir directory
   #   A reply is sent to the client.
 #  #
 sub LsHandler {  sub update_balcookie_handler {
     my $cmd     = shift;      my ($cmd, $tail, $client) = @_;
     my $ulsdir  = shift;  
     my $client  = shift;  
   
     my $userinput = "$cmd:$ulsdir";      my $userinput= "$cmd:$tail";
       chomp($tail);
       my ($cookie,$lastentry) = map { &unescape($_) } (split(/:/,$tail));
   
     my $ulsout='';      my $updatedone;
     my $ulsfn;      if ($cookie =~ /^$LONCAPA::match_domain\_$LONCAPA::match_username\_[a-f0-9]{32}$/) {
     if (-e $ulsdir) {          my $execdir=$perlvar{'lonBalanceDir'};
  if(-d $ulsdir) {          if (-e "$execdir/$cookie.id") {
     if (opendir(LSDIR,$ulsdir)) {              my $doupdate;
  while ($ulsfn=readdir(LSDIR)) {              if (open(my $fh,'<',"$execdir/$cookie.id")) {
     my @ulsstats=stat($ulsdir.'/'.$ulsfn);                  while (my $line = <$fh>) {
     $ulsout.=$ulsfn.'&'.                      chomp($line);
  join('&',@ulsstats).':';                      if ($line eq $lastentry) {
  }                          $doupdate = 1;
  closedir(LSDIR);                          last;
     }                      }
  } else {                  }
     my @ulsstats=stat($ulsdir);                  close($fh);
     $ulsout.=$ulsfn.'&'.join('&',@ulsstats).':';              }
  }              if ($doupdate) {
                   if (open(my $fh,'>',"$execdir/$cookie.id")) {
                       print $fh $clientname;
                       close($fh);
                       $updatedone = 1;
                   }
               }
           }
       }
       if ($updatedone) {
           &Reply($client, "ok\n", $userinput);
     } else {      } else {
  $ulsout='no_such_dir';          &Failure( $client, "error: ".($!+0)."file update failed ".
                     "while attempting updatebalcookie\n", $userinput);
     }      }
     if ($ulsout eq '') { $ulsout='empty'; }      return 1;
     Reply($client, "$ulsout\n", $userinput);  }
   &register_handler("updatebalcookie", \&update_balcookie_handler, 0, 1, 0);
   
   #
   #  Process the delbalcookie command. This command deletes a balancer
   #  cookie in the lonBalancedir directory on a load balancer node.
   #
   # Parameters:
   #   $cmd      - Command that got us here.
   #   $cookie   - Cookie to be deleted.
   #   $client   - socket open on the client process.
   #
   # Returns:
   #   1     - Indicating processing should continue.
   # Side Effects:
   #   A cookie file is deleted from the lonBalancedir directory
   #   A reply is sent to the client.
   sub del_balcookie_handler {
       my ($cmd, $cookie, $client) = @_;
   
       my $userinput= "$cmd:$cookie";
   
       chomp($cookie);
       $cookie = &unescape($cookie);
       my $deleted = '';
       if ($cookie =~ /^$LONCAPA::match_domain\_$LONCAPA::match_username\_[a-f0-9]{32}$/) {
           my $execdir=$perlvar{'lonBalanceDir'};
           if (-e "$execdir/$cookie.id") {
               if (open(my $fh,'<',"$execdir/$cookie.id")) {
                   my $dodelete;
                   while (my $line = <$fh>) {
                       chomp($line);
                       if ($line eq $clientname) {
                           $dodelete = 1;
                           last;
                       }
                   }
                   close($fh);
                   if ($dodelete) {
                       if (unlink("$execdir/$cookie.id")) {
                           $deleted = 1;
                       }
                   }
               }
           }
       }
       if ($deleted) {
           &Reply($client, "ok\n", $userinput);
       } else {
           &Failure( $client, "error: ".($!+0)."Unlinking cookie file Failed ".
                     "while attempting delbalcookie\n", $userinput);
       }
     return 1;      return 1;
 }  }
 RegisterHandler("ls", \&LsHandler, 0, 1, 0);  &register_handler("delbalcookie", \&del_balcookie_handler, 0, 1, 0);
   
   
 #  #
 #   Processes the setannounce command.  This command  #   Processes the setannounce command.  This command
Line 2543  RegisterHandler("ls", \&LsHandler, 0, 1, Line 6034  RegisterHandler("ls", \&LsHandler, 0, 1,
 #   The file {DocRoot}/announcement.txt is created.  #   The file {DocRoot}/announcement.txt is created.
 #   A reply is sent to $client.  #   A reply is sent to $client.
 #  #
 sub SetAnnounceHandler {  sub set_announce_handler {
     my $cmd          = shift;      my ($cmd, $announcement, $client) = @_;
     my $announcement = shift;  
     my $client       = shift;  
       
     my $userinput    = "$cmd:$announcement";      my $userinput    = "$cmd:$announcement";
   
Line 2556  sub SetAnnounceHandler { Line 6045  sub SetAnnounceHandler {
  '/announcement.txt')) {   '/announcement.txt')) {
  print $store $announcement;   print $store $announcement;
  close $store;   close $store;
  Reply($client, "ok\n", $userinput);   &Reply($client, "ok\n", $userinput);
     } else {      } else {
  Failure($client, "error: ".($!+0)."\n", $userinput);   &Failure($client, "error: ".($!+0)."\n", $userinput);
     }      }
   
     return 1;      return 1;
 }  }
 RegisterHandler("setannounce", \&SetAnnounceHandler, 0, 1, 0);  &register_handler("setannounce", \&set_announce_handler, 0, 1, 0);
   
 #  #
 #  Return the version of the daemon.  This can be used to determine  #  Return the version of the daemon.  This can be used to determine
Line 2578  RegisterHandler("setannounce", \&SetAnno Line 6067  RegisterHandler("setannounce", \&SetAnno
 #   1 - continue processing requests.  #   1 - continue processing requests.
 # Side Effects:  # Side Effects:
 #   Replies with version to $client.  #   Replies with version to $client.
 sub GetVersionHandler {  sub get_version_handler {
     my $client     = shift;      my ($cmd, $tail, $client) = @_;
     my $tail       = shift;  
     my $client     = shift;      my $userinput  = $cmd.$tail;
     my $userinput  = $client;  
           
     Reply($client, &version($userinput)."\n", $userinput);      &Reply($client, &version($userinput)."\n", $userinput);
   
   
     return 1;      return 1;
 }  }
 RegisterHandler("version", \&GetVersionHandler, 0, 1, 0);  &register_handler("version", \&get_version_handler, 0, 1, 0);
   
 #  Set the current host and domain.  This is used to support  #  Set the current host and domain.  This is used to support
 #  multihomed systems.  Each IP of the system, or even separate daemons  #  multihomed systems.  Each IP of the system, or even separate daemons
Line 2608  RegisterHandler("version", \&GetVersionH Line 6096  RegisterHandler("version", \&GetVersionH
 #     The default domain/system context is modified for this daemon.  #     The default domain/system context is modified for this daemon.
 #     a reply is sent to the client.  #     a reply is sent to the client.
 #  #
 sub SelectHostHandler {  sub set_virtual_host_handler {
     my $cmd        = shift;      my ($cmd, $tail, $socket) = @_;
     my $tail       = shift;  
     my $socket     = shift;  
       
     my $userinput  ="$cmd:$tail";      my $userinput  ="$cmd:$tail";
   
     Reply($client, &sethost($userinput)."\n", $userinput);      &Reply($client, &sethost($userinput)."\n", $userinput);
   
   
     return 1;      return 1;
 }  }
 RegisterHandler("sethost", \&SelectHostHandler, 0, 1, 0);  &register_handler("sethost", \&set_virtual_host_handler, 0, 1, 0);
   
 #  Process a request to exit:  #  Process a request to exit:
 #   - "bye" is sent to the client.  #   - "bye" is sent to the client.
Line 2633  RegisterHandler("sethost", \&SelectHostH Line 6119  RegisterHandler("sethost", \&SelectHostH
 # Returns:  # Returns:
 #   0      - Indicating the program should exit!!  #   0      - Indicating the program should exit!!
 #  #
 sub ExitHandler {  sub exit_handler {
     my $cmd     = shift;      my ($cmd, $tail, $client) = @_;
     my $tail    = shift;  
     my $client  = shift;  
   
     my $userinput = "$cmd:$tail";      my $userinput = "$cmd:$tail";
   
     &logthis("Client $clientip ($clientname) hanging up: $userinput");      &logthis("Client $clientip ($clientname) hanging up: $userinput");
     Reply($client, "bye\n", $userinput);      &Reply($client, "bye\n", $userinput);
     $client->shutdown(2);        # shutdown the socket forcibly.      $client->shutdown(2);        # shutdown the socket forcibly.
     $client->close();      $client->close();
   
     return 0;      return 0;
 }  }
 RegisterHandler("exit", \&ExitHandler, 0, 1,1);  &register_handler("exit", \&exit_handler, 0,1,1);
 RegisterHandler("init", \&ExitHandler, 0, 1,1); # RE-init is like exit.  &register_handler("init", \&exit_handler, 0,1,1);
 RegisterHandler("quit", \&ExitHandler, 0, 1,1); # I like this too!  &register_handler("quit", \&exit_handler, 0,1,1);
 #------------------------------------------------------------------------------------  
 #  #  Determine if auto-enrollment is enabled.
 #   Process a Request.  Takes a request from the client validates  #  Note that the original had what I believe to be a defect.
 #   it and performs the operation requested by it.  Returns  #  The original returned 0 if the requestor was not a registerd client.
 #   a response to the client.  #  It should return "refused".
 #  # Formal Parameters:
 #  Parameters:  #   $cmd       - The command that invoked us.
 #      request      - A string containing the user's request.  #   $tail      - The tail of the command (Extra command parameters.
 #  Returns:  #   $client    - The socket open on the client that issued the request.
 #      0            - Requested to exit, caller should shut down.  # Returns:
 #      1            - Accept additional requests from the client.  #    1         - Indicating processing should continue.
 #  #
 sub ProcessRequest {  sub enrollment_enabled_handler {
     my $Request      = shift;      my ($cmd, $tail, $client) = @_;
     my $KeepGoing    = 1; # Assume we're not asked to stop.      my $userinput = $cmd.":".$tail; # For logging purposes.
       
     my $wasenc=0;  
     my $userinput = $Request;   # for compatibility with oldcode <yeach>  
   
       
       my ($cdom) = split(/:/, $tail, 2);   # Domain we're asking about.
   
 # ------------------------------------------------------------ See if encrypted      my $outcome  = &localenroll::run($cdom);
          &Reply($client, \$outcome, $userinput);
     if($userinput =~ /^enc/) {  
  $wasenc = 1;  
  $userinput = Decipher($userinput);  
  if(! $userinput) {  
     Failure($client,"error:Encrypted data without negotiating key");  
     return 0;                      # Break off with this imposter.  
  }  
     }  
     # Split off the request keyword from the rest of the stuff.  
      
     my ($command, $tail) = split(/:/, $userinput, 2);  
   
     Debug("Command received: $command, encoded = $wasenc");      return 1;
   }
   &register_handler("autorun", \&enrollment_enabled_handler, 0, 1, 0);
   
      #
 # ------------------------------------------------------------- Normal commands  #   Validate an institutional code used for a LON-CAPA course.          
   #
   # 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:
   #                        $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.
   #
   #                        $owner    - The course requestor (who will be the
   #                                    course owner, in the form username:domain
   #
   #   $client       - Socket open on the client.
   # Returns:
   #    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);
   
     #       return 1;
     #   If the command is in the hash, then execute it via the hash dispatch:  }
     #  &register_handler("autovalidateinstcode", \&validate_instcode_handler, 0, 1, 0);
     if(defined $Dispatcher{$command}) {  
   
  my $DispatchInfo = $Dispatcher{$command};  #
  my $Handler      = $$DispatchInfo[0];  #  Validate co-owner for cross-listed institutional code and
  my $NeedEncode   = $$DispatchInfo[1];  #  institutional course code itself used for a LON-CAPA course.
  my $ClientTypes  = $$DispatchInfo[2];  #
  Debug("Matched dispatch hash: mustencode: $NeedEncode ClientType $ClientTypes");  # Formal Parameters:
         #   $cmd          - The command request that got us dispatched.
  #  Validate the request:  #   $tail         - The tail of the command.  In this case,
         #                   this is a colon separated string containing:
  my $ok = 1;  #      $dom            - Course's LON-CAPA domain
  my $requesterprivs = 0;  #      $instcode       - Institutional course code for the course
  if(isClient()) {  #      $inst_xlist     - Institutional course Id for the crosslisting
     $requesterprivs |= $CLIENT_OK;  #      $coowner        - Username of co-owner
  }  #      (values for all but $dom have been escaped). 
  if(isManager()) {  #
     $requesterprivs |= $MANAGER_OK;  #   $client       - Socket open on the client.
  }  # Returns:
  if($NeedEncode && (!$wasenc)) {  #    1           - Indicating processing should continue.
     Debug("Must encode but wasn't: $NeedEncode $wasenc");  #
     $ok = 0;  sub validate_instcrosslist_handler  {
  }      my ($cmd, $tail, $client) = @_;
  if(($ClientTypes & $requesterprivs) == 0) {      my $userinput = "$cmd:$tail";
     Debug("Client not privileged to do this operation");      my ($dom,$instcode,$inst_xlist,$coowner) = split(/:/,$tail);
     $ok = 0;      $instcode = &unescape($instcode);
  }      $inst_xlist = &unescape($inst_xlist);
       $coowner = &unescape($coowner);
       my $outcome = &localenroll::validate_crosslist_access($dom,$instcode,
                                                             $inst_xlist,$coowner);
       &Reply($client, \$outcome, $userinput);
   
  if($ok) {      return 1;
     Debug("Dispatching to handler $command $tail");  }
     $KeepGoing = &$Handler($command, $tail, $client);  &register_handler("autovalidateinstcrosslist", \&validate_instcrosslist_handler, 0, 1, 0);
  } else {  
     Debug("Refusing to dispatch because ok is false");  
     Failure($client, "refused", $userinput);  
  }  
   
   #   Get the official sections for which auto-enrollment is possible.
   #   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";
   
 # ------------------------------------------------------------- unknown command      my ($coursecode, $cdom) = split(/:/, $tail);
       my @secs = &localenroll::get_sections($coursecode,$cdom);
       my $seclist = &escape(join(':',@secs));
   
     } else {      &Reply($client, \$seclist, $userinput);
  # unknown command      
  Failure($client, "unknown_cmd\n", $userinput);  
     }  
   
     return $KeepGoing;      return 1;
 }  }
   &register_handler("autogetsections", \&get_sections_handler, 0, 1, 0);
   
   #   Validate the owner of a new course section.  
 #  #
 #   GetCertificate: Given a transaction that requires a certificate,  # Formal Parameters:
 #   this function will extract the certificate from the transaction  #   $cmd      - Command that got us dispatched.
 #   request.  Note that at this point, the only concept of a certificate  #   $tail     - the remainder of the command.  For us this consists of a
 #   is the hostname to which we are connected.  #               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.
 #  #
 #   Parameter:  # Returns:
 #      request   - The request sent by our client (this parameterization may  #   1        - Processing should continue.
 #                  need to change when we really use a certificate granting  
 #                  authority.  
 #  #
 sub GetCertificate {  sub validate_course_owner_handler {
     my $request = shift;      my ($cmd, $tail, $client)  = @_;
       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);
   
     return $clientip;  
 }  
   
   
       return 1;
   }
   &register_handler("autonewcourse", \&validate_course_owner_handler, 0, 1, 0);
   
 #  #
 #   ReadManagerTable: Reads in the current manager table. For now this is  #   Validate a course section in the official schedule of classes
 #                     done on each manager authentication because:  #   from the institutions point of view (part of autoenrollment).
 #                     - These authentications are not frequent  
 #                     - This allows dynamic changes to the manager table  
 #                       without the need to signal to the lond.  
 #  #
   # 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_course_id - The course/section id from the
   #                                          institutions point of view.
   #                        $cdom           - The domain from the institutions
   #                                          point of view.
   #   $client       - Socket open on the client.
   # Returns:
   #    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);
   
 sub ReadManagerTable {      my $outcome=&localenroll::validate_courseID($inst_course_id,$cdom);
       &Reply($client, \$outcome, $userinput);
     #   Clean out the old table first..  
   
     foreach my $key (keys %managers) {  
  delete $managers{$key};  
     }  
   
     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("autovalidatecourse", \&validate_course_section_handler, 0, 1, 0);
   
 #  #
 #  ValidManager: Determines if a given certificate represents a valid manager.  #   Validate course owner's access to enrollment data for specific class section. 
 #                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   # Formal Parameters:
 #             new configuration file.  This function copies an existing  #    $cmd     - The command request that got us dispatched.
 #             file to a backup file.  #    $tail    - The tail of the command.   In this case this is a colon separated
 # Parameters:  #               set of values that will be split into:
 #     oldfile  - Name of the file to backup.  #               $inst_class  - Institutional code for the specific class section   
 #     newfile  - Name of the backup file.  #               $ownerlist   - An escaped comma-separated list of username:domain 
 # Return:  #                              of the course owner, and co-owner(s).
 #     0   - Failure (errno has failure reason).  #               $cdom        - The domain of the course from the institution's
 #     1   - Success.  #                              point of view.
   #    $client  - The socket open on the client.
   # Returns:
   #    1 - continue processing.
 #  #
 sub CopyFile {  
     my $oldfile = shift;  
     my $newfile = shift;  
   
     #  The file must exist:  sub validate_class_access_handler {
       my ($cmd, $tail, $client) = @_;
     if(-e $oldfile) {      my $userinput = "$cmd:$tail";
       my ($inst_class,$ownerlist,$cdom) = split(/:/, $tail);
  # Read the old file.      my $owners = &unescape($ownerlist);
       my $outcome;
  my $oldfh = IO::File->new("< $oldfile");      eval {
  if(!$oldfh) {   local($SIG{__DIE__})='DEFAULT';
     return 0;   $outcome=&localenroll::check_section($inst_class,$owners,$cdom);
  }      };
  my @contents = <$oldfh>;  # Suck in the entire file.      &Reply($client,\$outcome, $userinput);
   
  # write the backup file:  
   
  my $newfh = IO::File->new("> $newfile");  
  if(!(defined $newfh)){  
     return 0;  
  }  
  my $lines = scalar @contents;  
  for (my $i =0; $i < $lines; $i++) {  
     print $newfh ($contents[$i]);  
  }  
   
  $oldfh->close;      return 1;
  $newfh->close;  }
   &register_handler("autovalidateclass_sec", \&validate_class_access_handler, 0, 1, 0);
   
  chmod(0660, $newfile);  #
   #    Modify institutional sections (using customized &instsec_reformat()
   #    routine in localenroll.pm), to either clutter or declutter, for  
   #    purposes of ensuring an institutional course section (string) can
   #    be unambiguously separated into institutional course and 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 values that will be split into:
   #               $cdom        - The LON-CAPA domain of the course.
   #               $action      - Either: clutter or declutter
   #                              clutter adds character(s) to eliminate ambiguity
   #                              declutter removes the added characters (e.g., for
   #                              display of the institutional course section string.
   #               $info        - A frozen hash in which keys are: 
   #                              LON-CAPA course number:Institutional course code
   #                              and values are a reference to an array of the
   #                              items to modify -- either institutional sections,
   #                              or institutional course sections (for crosslistings). 
   #    $client  - The socket open on the client.
   # Returns:
   #    1 - continue processing.
   #   
   
  return 1;  sub instsec_reformat_handler {
           my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($cdom,$action,$info) = split(/:/,$tail);
       my $instsecref = &Apache::lonnet::thaw_unescape($info);
       my ($outcome,$result);
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome=&localenroll::instsec_reformat($cdom,$action,$instsecref);
           if ($outcome eq 'ok') {
               if (ref($instsecref) eq 'HASH') {
                   foreach my $key (keys(%{$instsecref})) {
                       $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($instsecref->{$key}).'&';
                   }
                   $result =~ s/\&$//;
               }
           }
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               &Reply( $client, \$result, $userinput);
           } else {
               &Reply($client,\$outcome, $userinput);
           }
     } else {      } else {
  return 0;          &Failure($client,"unknown_cmd\n",$userinput);
     }      }
       return 1;
 }  }
   &register_handler("autoinstsecreformat",\&instsec_reformat_handler, 0, 1, 0);
   
 #  #
 #  Host files are passed out with externally visible host IPs.  #   Validate course owner or co-owners(s) access to enrollment data for all sections
 #  If, for example, we are behind a fire-wall or NAT host, our   #   and crosslistings for a particular course.
 #  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 {  # Formal Parameters:
     my $contents  = shift;  #    $cmd     - The command request that got us dispatched.
     my $adjusted;  #    $tail    - The tail of the command.   In this case this is a colon separated
     my $me        = $perlvar{'lonHostID'};  #               set of values that will be split into:
   #               $ownerlist   - An escaped comma-separated list of username:domain
   #                              of the course owner, and co-owner(s).
   #               $cdom        - The domain of the course from the institution's
   #                              point of view.
   #               $classes     - Frozen hash of institutional course sections and
   #                              crosslistings.
   #    $client  - The socket open on the client.
   # Returns:
   #    1 - continue processing.
   #
   
     foreach my $line (split(/\n/,$contents)) {  sub validate_classes_handler {
  if(!(($line eq "") || ($line =~ /^ *\#/) || ($line =~ /^ *$/))) {      my ($cmd, $tail, $client) = @_;
     chomp($line);      my $userinput = "$cmd:$tail";
     my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon)=split(/:/,$line);      my ($ownerlist,$cdom,$classes) = split(/:/, $tail);
     if ($id eq $me) {      my $classesref = &Apache::lonnet::thaw_unescape($classes);
  my $ip = gethostbyname($name);      my $owners = &unescape($ownerlist);
  my $ipnew = inet_ntoa($ip);      my $result;
  $ip = $ipnew;      eval {
  #  Reconstruct the host line and append to adjusted:          local($SIG{__DIE__})='DEFAULT';
           my %validations;
  my $newline = "$id:$domain:$role:$name:$ip";          my $response = &localenroll::check_instclasses($owners,$cdom,$classesref,
  if($maxcon ne "") { # Not all hosts have loncnew tuning params                                                         \%validations);
     $newline .= ":$maxcon:$idleto:$mincon";          if ($response eq 'ok') {
  }              foreach my $key (keys(%validations)) {
  $adjusted .= $newline."\n";                  $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($validations{$key}).'&';
               }
     } else { # Not me, pass unmodified.              $result =~ s/\&$//;
  $adjusted .= $line."\n";          } else {
     }              $result = 'error';
  } else {                  # Blank or comment never re-written.          }
     $adjusted .= $line."\n"; # Pass blanks and comments as is.      };
  }      if (!$@) {
           &Reply($client, \$result, $userinput);
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
     }      }
     return $adjusted;      return 1;
 }  }
   &register_handler("autovalidateinstclasses", \&validate_classes_handler, 0, 1, 0);
   
 #  #
 #   InstallFile: Called to install an administrative file:  #   Create a password for a new LON-CAPA user added by auto-enrollment.
 #       - The file is created with <name>.tmp  #   Only used for case where authentication method for new user is localauth
 #       - 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 this is a colon separated
 #  Return:  #               set of words that will be split into:
 #      nonzero - success.  #               $authparam - An authentication parameter (localauth parameter).
 #      0       - failure and $! has an errno.  #               $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 InstallFile {  sub create_auto_enroll_password_handler {
     my $Filename = shift;      my ($cmd, $tail, $client) = @_;
     my $Contents = shift;      my $userinput = "$cmd:$tail";
     my $TempFile = $Filename.".tmp";  
   
     #  Open the file for write:      my ($authparam, $cdom) = split(/:/, $userinput);
       
     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(0660, $TempFile);      my ($create_passwd,$authchk);
       ($authparam,
        $create_passwd,
        $authchk) = &localenroll::create_password($authparam,$cdom);
   
       &Reply($client, &escape($authparam.':'.$create_passwd.':'.$authchk)."\n",
      $userinput);
   
     # Now we can move install the file in position.  
       
     move($TempFile, $Filename);  
   
     return 1;      return 1;
 }  }
   &register_handler("autocreatepassword", \&create_auto_enroll_password_handler, 
     0, 1, 0);
   
   sub auto_export_grades_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($cdom,$cnum,$info,$data) = split(/:/,$tail);
       my $inforef = &Apache::lonnet::thaw_unescape($info);
       my $dataref = &Apache::lonnet::thaw_unescape($data);
       my ($outcome,$result);;
       eval {
           local($SIG{__DIE__})='DEFAULT';
           my %rtnhash;
           $outcome=&localenroll::export_grades($cdom,$cnum,$inforef,$dataref,\%rtnhash);
           if ($outcome eq 'ok') {
               foreach my $key (keys(%rtnhash)) {
                   $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rtnhash{$key}).'&';
               }
               $result =~ s/\&$//;
           }
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               if ($cipher) {
                   my $cmdlength=length($result);
                   $result.="         ";
                   my $encresult='';
                   for (my $encidx=0;$encidx<=$cmdlength;$encidx+=8) {
                       $encresult.= unpack("H16",
                                           $cipher->encrypt(substr($result,
                                                                   $encidx,
                                                                   8)));
                   }
                   &Reply( $client, "enc:$cmdlength:$encresult\n", $userinput);
               } else {
                   &Failure( $client, "error:no_key\n", $userinput);
               }
           } else {
               &Reply($client, "$outcome\n", $userinput);
           }
       } else {
           &Failure($client,"export_error\n",$userinput);
       }
       return 1;
   }
   &register_handler("autoexportgrades", \&auto_export_grades_handler,
                     1, 1, 0);
   
   #   Retrieve and remove temporary files created by/during autoenrollment.
 #  #
 #   ConfigFileFromSelector: converts a configuration file selector  # Formal Parameters:
 #                 (one of host or domain at this point) into a   #    $cmd      - The command that got us dispatched.
 #                 configuration file pathname.  #    $tail     - The tail of the command.  In our case this is a colon 
   #                separated list that will be split into:
   #                $filename - The name of the file to retrieve.
   #                            The filename is given as a path relative to
   #                            the LonCAPA temp file directory.
   #    $client   - Socket open on the client.
 #  #
 #  Parameters:  # Returns:
 #      selector  - Configuration file selector.  #   1     - Continue processing.
 #  Returns:  sub retrieve_auto_file_handler {
 #      Full path to the file or undef if the selector is invalid.      my ($cmd, $tail, $client)    = @_;
       my $userinput                = "cmd:$tail";
   
       my ($filename)   = split(/:/, $tail);
   
       my $source = $perlvar{'lonDaemons'}.'/tmp/'.$filename;
   
       if ($filename =~m{/\.\./}) {
           &Failure($client, "refused\n", $userinput);
       } elsif ($filename !~ /^$LONCAPA::match_domain\_$LONCAPA::match_courseid\_.+_classlist\.xml$/) {
           &Failure($client, "refused\n", $userinput);
       } elsif ( (-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 ConfigFileFromSelector {  #                                unlink($source);
     my $selector   = shift;   } else {
     my $tablefile;      &Failure($client, "error\n", $userinput);
    }
       } else {
    &Failure($client, "error\n", $userinput);
       }
       
   
       return 1;
   }
   &register_handler("autoretrieve", \&retrieve_auto_file_handler, 0,1,0);
   
     my $tabledir = $perlvar{'lonTabDir'}.'/';  sub crsreq_checks_handler {
     if ($selector eq "hosts") {      my ($cmd, $tail, $client) = @_;
  $tablefile = $tabledir."hosts.tab";      my $userinput = "$cmd:$tail";
     } elsif ($selector eq "domain") {      my $dom = $tail;
  $tablefile = $tabledir."domain.tab";      my $result;
       my @reqtypes = ('official','unofficial','community','textbook','placement');
       eval {
           local($SIG{__DIE__})='DEFAULT';
           my %validations;
           my $response = &localenroll::crsreq_checks($dom,\@reqtypes,
                                                      \%validations);
           if ($response eq 'ok') { 
               foreach my $key (keys(%validations)) {
                   $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($validations{$key}).'&';
               }
               $result =~ s/\&$//;
           } else {
               $result = 'error';
           }
       };
       if (!$@) {
           &Reply($client, \$result, $userinput);
     } else {      } else {
  return undef;          &Failure($client,"unknown_cmd\n",$userinput);
     }      }
     return $tablefile;      return 1;
   }
   &register_handler("autocrsreqchecks", \&crsreq_checks_handler, 0, 1, 0);
   
   sub validate_crsreq_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$customdata) = split(/:/, $tail);
       $instcode = &unescape($instcode);
       $owner = &unescape($owner);
       $crstype = &unescape($crstype);
       $inststatuslist = &unescape($inststatuslist);
       $instcode = &unescape($instcode);
       $instseclist = &unescape($instseclist);
       my $custominfo = &Apache::lonnet::thaw_unescape($customdata);
       my $outcome;
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::validate_crsreq($dom,$owner,$crstype,
                                                    $inststatuslist,$instcode,
                                                    $instseclist,$custominfo);
       };
       if (!$@) {
           &Reply($client, \$outcome, $userinput);
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
       return 1;
   }
   &register_handler("autocrsreqvalidation", \&validate_crsreq_handler, 0, 1, 0);
   
   sub crsreq_update_handler {
       my ($cmd, $tail, $client) = @_;
       my $userinput = "$cmd:$tail";
       my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,$code,
           $accessstart,$accessend,$infohashref) =
           split(/:/, $tail);
       $crstype = &unescape($crstype);
       $action = &unescape($action);
       $ownername = &unescape($ownername);
       $ownerdomain = &unescape($ownerdomain);
       $fullname = &unescape($fullname);
       $title = &unescape($title);
       $code = &unescape($code);
       $accessstart = &unescape($accessstart);
       $accessend = &unescape($accessend);
       my $incoming = &Apache::lonnet::thaw_unescape($infohashref);
       my ($result,$outcome);
       eval {
           local($SIG{__DIE__})='DEFAULT';
           my %rtnhash;
           $outcome = &localenroll::crsreq_updates($cdom,$cnum,$crstype,$action,
                                                   $ownername,$ownerdomain,$fullname,
                                                   $title,$code,$accessstart,$accessend,
                                                   $incoming,\%rtnhash);
           if ($outcome eq 'ok') {
               my @posskeys = qw(createdweb createdmsg createdcustomized createdactions queuedweb queuedmsg formitems reviewweb validationjs onload javascript);
               foreach my $key (keys(%rtnhash)) {
                   if (grep(/^\Q$key\E/,@posskeys)) {
                       $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($rtnhash{$key}).'&';
                   }
               }
               $result =~ s/\&$//;
           }
       };
       if (!$@) {
           if ($outcome eq 'ok') {
               &Reply($client, \$result, $userinput);
           } else {
               &Reply($client, "format_error\n", $userinput);
           }
       } else {
           &Failure($client,"unknown_cmd\n",$userinput);
       }
       return 1;
 }  }
   &register_handler("autocrsrequpdate", \&crsreq_update_handler, 0, 1, 0);
   
 #  #
 #   PushFile:  Called to do an administrative push of a file.  #   Read and retrieve institutional code format (for support form).
 #              - Ensure the file being pushed is one we support.  # Formal Parameters:
 #              - Backup the old file to <filename.saved>  #    $cmd        - Command that dispatched us.
 #              - Separate the contents of the new file out from the  #    $tail       - Tail of the command.  In this case it conatins 
 #                rest of the request.  #                  the course domain and the coursename.
 #              - Write the new file.  #    $client     - Socket open on the client.
 #  Parameter:  # Returns:
 #     Request - The entire user request.  This consists of a : separated  #    1     - Continue processing.
 #               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 {  sub get_institutional_code_format_handler {
     my $request = shift;          my ($cmd, $tail, $client)   = @_;
     my ($command, $filename, $contents) = split(":", $request, 3);      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);
       }
           
     #  At this point in time, pushes for only the following tables are      return 1;
     #  supported:  }
     #   hosts.tab  ($filename eq host).  &register_handler("autoinstcodeformat",
     #   domain.tab ($filename eq domain).    \&get_institutional_code_format_handler,0,1,0);
     # 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.  
     #  
   
   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 $tablefile = ConfigFileFromSelector($filename);  sub get_possible_instcodes_handler {
     if(! (defined $tablefile)) {      my ($cmd, $tail, $client)   = @_;
  return "refused";      my $userinput               = "$cmd:$tail";
   
       my $reply;
       my $cdom = $tail;
       my (@codetitles,%cat_titles,%cat_order,@code_order);
       my $formatreply = &localenroll::possible_instcodes($cdom,
                                                          \@codetitles,
                                                          \%cat_titles,
                                                          \%cat_order,
                                                          \@code_order);
       if ($formatreply eq 'ok') {
           my $result = join('&',map {&escape($_);} (@codetitles)).':';
           $result .= join('&',map {&escape($_);} (@code_order)).':';
           foreach my $key (keys(%cat_titles)) {
               $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_titles{$key}).'&';
           }
           $result =~ s/\&$//;
           $result .= ':';
           foreach my $key (keys(%cat_order)) {
               $result .= &escape($key).'='.&Apache::lonnet::freeze_escape($cat_order{$key}).'&';
           }
           $result =~ s/\&$//;
           &Reply($client,\$result,$userinput);
       } else {
           &Reply($client, "format_error\n", $userinput);
     }      }
     #      return 1;
     # >copy< the old table to the backup table  }
     #        don't rename in case system crashes/reboots etc. in the time  &register_handler("autopossibleinstcodes",
     #        window between a rename and write.                    \&get_possible_instcodes_handler,0,1,0);
     #  
     my $backupfile = $tablefile;  sub get_institutional_user_rules {
     $backupfile    =~ s/\.tab$/.old/;      my ($cmd, $tail, $client)   = @_;
     if(!CopyFile($tablefile, $backupfile)) {      my $userinput               = "$cmd:$tail";
  &logthis('<font color="green"> CopyFile from '.$tablefile." to ".$backupfile." failed </font>");      my $dom = &unescape($tail);
  return "error:$!";      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);
     }      }
     &logthis('<font color="green"> Pushfile: backed up '  }
      .$tablefile." to $backupfile</font>");  &register_handler("instuserrules",\&get_institutional_user_rules,0,1,0);
       
     #  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") {  sub get_institutional_id_rules {
  $contents = AdjustHostContents($contents);      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);
   
     #  Install the new file:  sub get_institutional_selfcreate_rules {
       my ($cmd, $tail, $client)   = @_;
     if(!InstallFile($tablefile, $contents)) {      my $userinput               = "$cmd:$tail";
  &logthis('<font color="red"> Pushfile: unable to install '      my $dom = &unescape($tail);
  .$tablefile." $! </font>");      my (%rules_hash,@rules_order);
  return "error:$!";      my $outcome;
       eval {
           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 {      } else {
  &logthis('<font color="green"> Installed new '.$tablefile          &Failure($client,"unknown_cmd\n",$userinput);
  ."</font>");  
   
     }      }
   }
   &register_handler("instemailrules",\&get_institutional_selfcreate_rules,0,1,0);
   
   sub get_unamemap_rules {
     #  Indicate success:      my ($cmd, $tail, $client)   = @_;
        my $userinput               = "$cmd:$tail";
     return "ok";      my $dom = &unescape($tail);
       my (%rules_hash,@rules_order);
       my $outcome;
       eval {
           local($SIG{__DIE__})='DEFAULT';
           $outcome = &localenroll::unamemap_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("unamemaprules",\&get_unamemap_rules,0,1,0);
   
 #  sub institutional_username_check {
 #  Called to re-init either lonc or lond.      my ($cmd, $tail, $client)   = @_;
 #      my $userinput               = "$cmd:$tail";
 #  Parameters:      my %rulecheck;
 #    request   - The full request by the client.  This is of the form      my $outcome;
 #                reinit:<process>        my ($udom,$uname,@rules) = split(/:/,$tail);
 #                where <process> is allowed to be either of       $udom = &unescape($udom);
 #                lonc or lond      $uname = &unescape($uname);
 #      @rules = map {&unescape($_);} (@rules);
 #  Returns:      eval {
 #     The string to be sent back to the client either:          local($SIG{__DIE__})='DEFAULT';
 #   ok         - Everything worked just fine.          $outcome = &localenroll::username_check($udom,$uname,\@rules,\%rulecheck);
 #   error:why  - There was a failure and why describes the reason.      };
 #      if (!$@) {
 #          if ($outcome eq 'ok') {
 sub ReinitProcess {              my $result='';
     my $request = shift;              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);
   
   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);
   
     # separate the request (reinit) from the process identifier and  sub institutional_selfcreate_check {
     # validate it producing the name of the .pid file for the process.      my ($cmd, $tail, $client)   = @_;
     #      my $userinput               = "$cmd:$tail";
     #      my %rulecheck;
     my ($junk, $process) = split(":", $request);      my $outcome;
     my $processpidfile = $perlvar{'lonDaemons'}.'/logs/';      my ($udom,$email,@rules) = split(/:/,$tail);
     if($process eq 'lonc') {      $udom = &unescape($udom);
  $processpidfile = $processpidfile."lonc.pid";      $email = &unescape($email);
  if (!open(PIDFILE, "< $processpidfile")) {      @rules = map {&unescape($_);} (@rules);
     return "error:Open failed for $processpidfile";      eval {
  }          local($SIG{__DIE__})='DEFAULT';
  my $loncpid = <PIDFILE>;          $outcome = &localenroll::selfcreate_check($udom,$email,\@rules,\%rulecheck);
  close(PIDFILE);      };
  logthis('<font color="red"> Reinitializing lonc pid='.$loncpid      if (!$@) {
  ."</font>");          if ($outcome eq 'ok') {
  kill("USR2", $loncpid);              my $result='';
     } elsif ($process eq 'lond') {              foreach my $key (keys(%rulecheck)) {
  logthis('<font color="red"> Reinitializing self (lond) </font>');                  $result.=&escape($key).'='.&Apache::lonnet::freeze_escape($rulecheck{$key}).'&';
  &UpdateHosts; # Lond is us!!              }
               &Reply($client,\$result,$userinput);
           } else {
               &Reply($client,"error\n", $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';  
 }  }
 #   Validate a line in a configuration file edit script:  &register_handler("instselfcreatecheck",\&institutional_selfcreate_check,0,1,0);
 #   Validation includes:  
 #     - Ensuring the command is valid.  # Get domain specific conditions for import of student photographs to a course
 #     - Ensuring the command has sufficient parameters  
 #   Parameters:  
 #     scriptline - A line to validate (\n has been stripped for what it's worth).  
 #  #
 #   Return:  # Retrieves information from photo_permission subroutine in localenroll.
 #      0     - Invalid scriptline.  # Returns outcome (ok) if no processing errors, and whether course owner is 
 #      1     - Valid scriptline  # required to accept conditions of use (yes/no).
 #  NOTE:  
 #     Only the command syntax is checked, not the executability of the  
 #     command.  
 #  #
 sub isValidEditCommand {  #    
     my $scriptline = shift;  sub photo_permission_handler {
       my ($cmd, $tail, $client)   = @_;
     #   Line elements are pipe separated:      my $userinput               = "$cmd:$tail";
       my $cdom = $tail;
     my ($command, $key, $newline)  = split(/\|/, $scriptline);      my ($perm_reqd,$conditions);
     &logthis('<font color="green"> isValideditCommand checking: '.      my $outcome;
      "Command = '$command', Key = '$key', Newline = '$newline' </font>\n");      eval {
        local($SIG{__DIE__})='DEFAULT';
     if ($command eq "delete") {   $outcome = &localenroll::photo_permission($cdom,\$perm_reqd,
  #    \$conditions);
  #   key with no newline.      };
  #      if (!$@) {
  if( ($key eq "") || ($newline ne "")) {   &Reply($client, &escape($outcome.':'.$perm_reqd.':'. $conditions)."\n",
     return 0; # Must have key but no newline.         $userinput);
  } else {  
     return 1; # Valid syntax.  
  }  
     } elsif ($command eq "replace") {  
  #  
  #   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 {      } else {
  return 0; # Invalid command.   &Failure($client,"unknown_cmd\n",$userinput);
     }      }
     return 0; # Should not get here!!!      return 1;
 }  }
   &register_handler("autophotopermission",\&photo_permission_handler,0,1,0);
   
 #  #
 #   ApplyEdit - Applies an edit command to a line in a configuration   # Checks if student photo is available for a user in the domain, in the user's
 #               file.  It is the caller's responsiblity to validate the  # directory (in /userfiles/internal/studentphoto.jpg).
 #               edit line.  # Uses localstudentphoto:fetch() to ensure there is an up to date copy of
 #   Parameters:  # the student's photo.   
 #      $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 photo_check_handler {
     # (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 ($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);
   
     my ($command, $p1, $p2) = split(/\|/, $directive);  #
   # Retrieve information from localenroll about whether to provide a button     
   # for users who have enbled import of student photos to initiate an 
   # update of photo files for registered students. Also include 
   # comment to display alongside button.  
   
     if($command eq "append") {  sub photo_choice_handler {
  $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 $cdom                  = &unescape($tail);
     } elsif ($command eq "delete") {      my ($update,$comment);
  $editor->DeleteLine($p1);         # p1 - key p2 null.      eval {
     } else {          # Should not get here!!!   local($SIG{__DIE__})='DEFAULT';
  die "Invalid command given to ApplyEdit $command";   ($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);
   
 #  #
 # AdjustOurHost:  # Gets a student's photo to exist (in the correct image type) in the user's 
 #           Adjusts a host file stored in a configuration file editor object  # directory.
 #           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:  # Formal Parameters:
 #     editor   - The configuration file editor to adjust.  This  #    $cmd     - The command request that got us dispatched.
 #                editor is assumed to contain a hosts.tab file.  #    $tail    - A colon separated set of words that will be split into:
 # Strategy:  #               $domain - student's domain
 #    - Figure out our hostname.  #               $uname  - student username
 #    - Lookup the entry for this host.  #               $type   - image type desired
 #    - Modify the line to contain our IP  #    $client  - The socket open on the client.
 #    - Do a replace for this host.  # Returns:
 sub AdjustOurHost {  #    1 - continue processing.
     my $editor        = shift;  
   
     # figure out who I am.  
   
     my $myHostName    = $perlvar{'lonHostID'}; # LonCAPA hostname.  
   
     #  Get my host file entry.  
   
     my $ConfigLine    = $editor->Find($myHostName);  sub student_photo_handler {
     if(! (defined $ConfigLine)) {      my ($cmd, $tail, $client) = @_;
  die "AdjustOurHost - no entry for me in hosts file $myHostName";      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;
     }      }
     # figure out my IP:      if (-e $path.$filename) {
     #   Use the config line to get my hostname.   &Reply($client,"ok\n","$cmd:$tail");
     #   Use gethostbyname to translate that into an IP address.   return 1;
     #  
     my ($id,$domain,$role,$name,$ip,$maxcon,$idleto,$mincon) = split(/:/,$ConfigLine);  
     my $BinaryIp = gethostbyname($name);  
     my $ip       = inet_ntoa($ip);  
     #  
     #  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, $ip, $maxcon, $idleto, $mincon) {  
  $newConfigLine .= ":".$item;  
     }      }
     #  Replace the line:      &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);
   
     $editor->ReplaceLine($id, $newConfigLine);  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);
   
   # 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;
   }
   
   #---------------------------------------------------------------
 #  #
 #   ReplaceConfigFile:  #   Getting, decoding and dispatching requests:
 #              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  = shift;  #   Get a Request:
     my $editor    = shift;  #   Gets a Request message from the client.  The transaction
   #   is defined as a 'line' of text.  We remove the new line
   #   from the text line.  
   #
   sub get_request {
       my $input = <$client>;
       chomp($input);
   
     CopyFile ($filename, $filename.".old");      &Debug("get_request: Request = $input\n");
   
     my $contents  = $editor->Get(); # Get the contents of the file.      &status('Processing '.$clientname.':'.$input);
   
     InstallFile($filename, $contents);      return $input;
 }  }
 #     #---------------------------------------------------------------
 #  #
 #   Called to edit a configuration table  file  #  Process a request.  This sub should shrink as each action
 #   Parameters:  #  gets farmed out into a separat sub that is registered 
 #      request           - The entire command/request sent by lonc or lonManage  #  with the dispatch hash.  
 #   Return:  
 #      The reply to send to the client.  
 #  #
 sub EditFile {  # Parameters:
     my $request = shift;  #    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";
    }
       }
   
     #  Split the command into it's pieces:  edit:filetype:script      if ($userinput =~ /^enc/) {
    $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 ($request, $filetype, $script) = split(/:/, $request,3); # : in script      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.
       }
   
     #  Check the pre-coditions for success:      &Debug("Command received: $command, encoded = $wasenc");
   
     if($request != "edit") { # Something is amiss afoot alack.      if(defined $Dispatcher{$command}) {
  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 $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;
    }
           if ($ok) {
               my $realcommand = $command;
               if ($command eq 'querysend') {
                   my ($query,$rest)=split(/\:/,$tail,2);
                   $query=~s/\n*$//g;
                   my @possqueries = 
                       qw(userlog courselog fetchenrollment institutionalphotos usersearch instdirsearch getinstuser getmultinstusers);
                   if (grep(/^\Q$query\E$/,@possqueries)) {
                       $command .= '_'.$query;
                   } elsif ($query eq 'prepare activity log') {
                       $command .= '_activitylog';
                   }
               }
               if (ref($trust{$command}) eq 'HASH') {
                   my $donechecks;
                   if ($trust{$command}{'anywhere'}) {
                      $donechecks = 1;
                   } elsif ($trust{$command}{'manageronly'}) {
                       unless (&isManager()) {
                           $ok = 0;
                       }
                       $donechecks = 1;
                   } elsif ($trust{$command}{'institutiononly'}) {
                       unless ($clientsameinst) {
                           $ok = 0;
                       }
                       $donechecks = 1;
                   } elsif ($clientsameinst) {
                       $donechecks = 1;
                   }
                   unless ($donechecks) {
                       foreach my $rule (keys(%{$trust{$command}})) {
                           next if ($rule eq 'remote');
                           if ($trust{$command}{$rule}) {
                               if ($clientprohibited{$rule}) {
                                   $ok = 0;
                               } else {
                                   $ok = 1;
                                   $donechecks = 1;
                                   last;
                               }
                           }
                       }
                   }
                   unless ($donechecks) {
                       if ($trust{$command}{'remote'}) {
                           if ($clientremoteok) {
                               $ok = 1;
                           } else {
                               $ok = 0;
                           } 
                       }
                   }
               }
               $command = $realcommand;
           }
   
     my @scriptlines = split(/\n/, $script);  # one line per element.   if($ok) {
     my $linecount   = scalar(@scriptlines);      Debug("Dispatching to handler $command $tail");
     for(my $i = 0; $i < $linecount; $i++) {      my $keep_going = &$handler($command, $tail, $client);
  chomp($scriptlines[$i]);      return $keep_going;
  if(!isValidEditCommand($scriptlines[$i])) {   } else {
     return "error:edit with bad script line: '$scriptlines[$i]' \n";      Debug("Refusing to dispatch because client did not match requirements");
       Failure($client, "refused\n", $userinput);
       return 1;
  }   }
     }      }
   
     #   Execute the edit operation.      print $client "unknown_cmd\n";
     #   - Create a config file editor for the appropriate file and   # -------------------------------------------------------------------- complete
     #   - execute each command in the script:      Debug("process_request - returning 1");
     #      return 1;
     my $configfile = ConfigFileFromSelector($filetype);  }
     if (!(defined $configfile)) {  #
  return "refused\n";  #   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;
     }      }
     my $editor = ConfigFileEdit->new($configfile);  }
   
     for (my $i = 0; $i < $linecount; $i++) {  #
  ApplyEdit($scriptlines[$i], $editor);  #   Register a command processor.  This function is invoked to register a sub
   #   to process a request.  Once registered, the ProcessRequest sub can automatically
   #   dispatch requests to an appropriate sub, and do the top level validity checking
   #   as well:
   #    - Is the keyword recognized.
   #    - Is the proper client type attempting the request.
   #    - Is the request encrypted if it has to be.
   #   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)   = @_;
   
       #  Don't allow duplication#
      
       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 3337  sub lcpasswdstrerror { Line 7491  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 3383  undef $perlvarref; Line 7525  undef $perlvarref;
 # ----------------------------- Make sure this process is running from user=www  # ----------------------------- Make sure this process is running from user=www
 my $wwwid=getpwnam('www');  my $wwwid=getpwnam('www');
 if ($wwwid!=$<) {  if ($wwwid!=$<) {
     my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";     my $emailto="$perlvar{'lonAdmEMail'} $perlvar{'lonSysEMail'}";
     my $subj="LON: $currenthostid User ID mismatch";     my $subj="LON: $currenthostid User ID mismatch";
     system("echo 'User ID mismatch.  lond must be run as user www.' |\     system("echo 'User ID mismatch.  lond must be run as user www.' |".
  mailto $emailto -s '$subj' > /dev/null");            " mail -s '$subj' $emailto > /dev/null");
     exit 1;     exit 1;
 }  }
   
 # --------------------------------------------- Check if other instance running  # --------------------------------------------- Check if other instance running
Line 3395  if ($wwwid!=$<) { Line 7537  if ($wwwid!=$<) {
 my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";  my $pidfile="$perlvar{'lonDaemons'}/logs/lond.pid";
   
 if (-e $pidfile) {  if (-e $pidfile) {
     my $lfh=IO::File->new("$pidfile");     my $lfh=IO::File->new("$pidfile");
     my $pide=<$lfh>;     my $pide=<$lfh>;
     chomp($pide);     chomp($pide);
     if (kill 0 => $pide) { die "already running"; }     if (kill 0 => $pide) { die "already running"; }
 }  }
   
 # ------------------------------------------------------------- Read hosts file  # ------------------------------------------------------------- Read hosts file
Line 3409  if (-e $pidfile) { Line 7551  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";
   
 # --------------------------------------------------------- Do global variables  # --------------------------------------------------------- Do global variables
   
 # 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 3441  sub HUNTSMAN {                      # si Line 7591  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 3451  sub HUPSMAN {                      # sig Line 7601  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 3459  sub HUPSMAN {                      # sig Line 7609  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 3525  sub UpdateHosts { Line 7643  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();
       my %active;
   
     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);
  } else {   } else {
               $active{$child} = $childip;
     logthis('<font color="green"> keeping child for ip '      logthis('<font color="green"> keeping child for ip '
     ." $childip (pid=$child) </font>");      ." $childip (pid=$child) </font>");
  }   }
     }      }
   
       my %oldconf = %secureconf;
       my %connchange;
       if (lonssl::Read_Connect_Config(\%secureconf,\%perlvar,\%crlchecked) eq 'ok') {
           logthis('<font color="blue"> Reloaded SSL connection rules and cleared CRL checking history </font>');
       } else {
           logthis('<font color="yellow"> Failed to reload SSL connection rules and clear CRL checking history </font>');
       }
       if ((ref($oldconf{'connfrom'}) eq 'HASH') && (ref($secureconf{'connfrom'}) eq 'HASH')) {
           foreach my $type ('dom','intdom','other') {
               if ((($oldconf{'connfrom'}{$type} eq 'no') && ($secureconf{'connfrom'}{$type} eq 'req')) ||
                   (($oldconf{'connfrom'}{$type} eq 'req') && ($secureconf{'connfrom'}{$type} eq 'no'))) {
                   $connchange{$type} = 1;
               }
           }
       }
       if (keys(%connchange)) {
           foreach my $child (keys(%active)) {
               my $childip = $active{$child};
               if ($childip ne '127.0.0.1') {
                   my $childhostname  = gethostbyaddr(Socket::inet_aton($childip),AF_INET);
                   if ($childhostname ne '') {
                       my $childlonhost = &Apache::lonnet::get_server_homeID($childhostname);
                       my ($samedom,$sameinst) = &set_client_info($childlonhost);
                       if ($samedom) {
                           if ($connchange{'dom'}) {
                               logthis('<font color="blue"> UpdateHosts killing child '
                                      ." $child for ip $childip </font>");
                               kill('INT', $child);
                           }
                       } elsif ($sameinst) {
                           if ($connchange{'intdom'}) {
                               logthis('<font color="blue"> UpdateHosts killing child '
                                      ." $child for ip $childip </font>");
                              kill('INT', $child);
                           }
                       } else {
                           if ($connchange{'other'}) {
                               logthis('<font color="blue"> UpdateHosts killing child '
                                      ." $child for ip $childip </font>");
                               kill('INT', $child);
                           }
                       }
                   }
               }
           }
       }
     ReloadApache;      ReloadApache;
     &status("Finished reloading hosts.tab");      &status("Finished reloading hosts.tab");
 }  }
   
   
 sub checkchildren {  sub checkchildren {
     &status("Checking on the children (sending signals)");      &status("Checking on the children (sending signals)");
     &initnewstatus();      &initnewstatus();
Line 3552  sub checkchildren { Line 7717  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) {
         unless (-e "$docdir/lon-status/londchld/$_.txt") {          unless (-e "$docdir/lon-status/londchld/$_.txt") {
     eval {            eval {
  alarm(300);              alarm(300);
  &logthis('Child '.$_.' did not respond');      &logthis('Child '.$_.' did not respond');
  kill 9 => $_;      kill 9 => $_;
  #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";      #$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
  #$subj="LON: $currenthostid killed lond process $_";      #$subj="LON: $currenthostid killed lond process $_";
  #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.$_`;
  alarm(0);      delete($children{$_});
     }      alarm(0);
     }
         }          }
     }      }
     $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 3610  sub Debug { Line 7779  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 3655  sub logstatus { Line 7825  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";
    flock(LOG,LOCK_UN);
    close(LOG);
     }      }
     ResetStatistics;  
     &status("Finished logging");      &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 3689  sub status { Line 7860  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";
     my $sclient=IO::Socket::UNIX->new(Peer    =>"$peerfile",      my $sclient=IO::Socket::UNIX->new(Peer    =>"$peerfile",
                                       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)=@_;  
     Debug("Propath:$udom:$uname");  
     $udom=~s/\W//g;  
     $uname=~s/\W//g;  
     Debug("Propath2:$udom:$uname");  
     my $subdir=$uname.'__';  
     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;  
     my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";  
     Debug("Propath returning $proname");  
     return $proname;  
 }   
   
 # --------------------------------------- Is this the home server of an author?  # --------------------------------------- Is this the home server of an author?
   
 sub ishome {  sub ishome {
Line 3836  my $execdir=$perlvar{'lonDaemons'}; Line 7917  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 3851  $SIG{USR1} = \&checkchildren; Line 7932  $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);
   }
   
   unless (lonssl::Read_Connect_Config(\%secureconf,\%perlvar,\%crlchecked) eq 'ok') {
       &logthis('<font color="blue">No connectionrules table. Will fallback to loncapa.conf</font>');
   }
   
 # --------------------------------------------------------------  # --------------------------------------------------------------
 #   Accept connections.  When a connection comes in, it is validated  #   Accept connections.  When a connection comes in, it is validated
Line 3870  while (1) { Line 7963  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 3880  sub make_new_child { Line 7974  sub make_new_child {
     $sigset = POSIX::SigSet->new(SIGINT);      $sigset = POSIX::SigSet->new(SIGINT);
     sigprocmask(SIG_BLOCK, $sigset)      sigprocmask(SIG_BLOCK, $sigset)
         or die "Can't block SIGINT for fork: $!\n";          or die "Can't block SIGINT for fork: $!\n";
       
     die "fork: $!" unless defined ($pid = fork);      die "fork: $!" unless defined ($pid = fork);
   
     $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of      $client->sockopt(SO_KEEPALIVE, 1); # Enable monitoring of
Line 3891  sub make_new_child { Line 7985  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 3909  sub make_new_child { Line 8014  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 3916  sub make_new_child { Line 8028  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();  
           my $no_ets;
           if ($dist =~ /^(?:centos|rhes|scientific|oracle|rocky|alma)(\d+)/) {
               if ($1 >= 7) {
                   $no_ets = 1;
               }
           } elsif ($dist =~ /^suse(\d+\.\d+)$/) {
               if (($1 eq '9.3') || ($1 >= 12.2)) {
                   $no_ets = 1; 
               }
           } elsif ($dist =~ /^sles(\d+)$/) {
               if ($1 > 11) {
                   $no_ets = 1;
               }
           } elsif ($dist =~ /^fedora(\d+)$/) {
               if ($1 < 7) {
                   $no_ets = 1;
               }
           }
           unless ($no_ets) {
       &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, '.
      $clientip.       $clientip.
      " ($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)");    #
  $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 $context;
                       if ($clientsamedom) {
                           $context = 'dom';
                           if ($secureconf{'connfrom'}{'dom'} eq 'no') {
                               $inittype = "";
                           }
                       } elsif ($clientsameinst) {
                           $context = 'intdom';
                           if ($secureconf{'connfrom'}{'intdom'} eq 'no') {
                               $inittype = "";
                           }
                       } else {
                           $context = 'other';
                           if ($secureconf{'connfrom'}{'other'} eq 'no') {
                               $inittype = "";
                           }
                       }
                       if ($inittype eq '') {
                           &logthis("<font color=\"blue\"> Domain config set "
                                   ."to no ssl for $clientname (context: $context)"
                                   ." -- trying insecure auth</font>");
                       }
                   }
   
    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,$clientname);
       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("<font color=blue>WARNING: $clientip did not reply challenge</font>");      my $ok = InsecureConnection($client);
     &status('No challenge reply '.$clientip);      if($ok) {
    $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("<font color=blue>WARNING: "   &logthis(
    "<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("<font color=blue>WARNING: Unknown client $clientip</font>");      &logthis(
        "<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);  
 # -------------------------------------------------------------------- complete  
   
  &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>");    
       
       
     # this exit is VERY important, otherwise the child will become      # this exit is VERY important, otherwise the child will become
     # a producer of more and more children, forking yourself into      # a producer of more and more children, forking yourself into
     # process death.      # process death.
Line 4020  sub make_new_child { Line 8247  sub make_new_child {
           
 }  }
   
   #
   #  Used to determine if a particular client is from the same domain
   #  as the current server, or from the same internet domain, and
   #  also if the client can host sessions for the domain's users.
   #  A hash is populated with keys set to commands sent by the client
   #  which may not be executed for this domain.
   #
   #  Optional input -- the client to check for domain and internet domain.
   #  If not specified, defaults to the package variable: $clientname
   #
   #  If called in array context will not set package variables, but will
   #  instead return an array of two values - (a) true if client is in the
   #  same domain as the server, and (b) true if client is in the same 
   #  internet domain.
   #
   #  If called in scalar context, sets package variables for current client:
   #
   #  $clienthomedom    - LonCAPA domain of homeID for client.
   #  $clientsamedom    - LonCAPA domain same for this host and client.
   #  $clientintdom     - LonCAPA "internet domain" for client.
   #  $clientsameinst   - LonCAPA "internet domain" same for this host & client.
   #  $clientremoteok   - If current domain permits hosting on this client: 1
   #  %clientprohibited - Commands prohibited for domain's users for this client.
   #
   #  if the host and client have the same "internet domain", then the value
   #  of $clientremoteok is not used, and no commands are prohibited.
   #
   #  returns 1 to indicate package variables have been set for current client.
   #
   
   sub set_client_info {
       my ($lonhost) = @_;
       $lonhost ||= $clientname;
       my $clienthost = &Apache::lonnet::hostname($lonhost);
       my $clientserverhomeID = &Apache::lonnet::get_server_homeID($clienthost);
       my $homedom = &Apache::lonnet::host_domain($clientserverhomeID);
       my $samedom = 0;
       if ($perlvar{'lonDefDomain'} eq $homedom) {
           $samedom = 1;
       }
       my $intdom = &Apache::lonnet::internet_dom($clientserverhomeID);
       my $sameinst = 0;
       if ($intdom ne '') {
           my $internet_names = &Apache::lonnet::get_internet_names($currenthostid);
           if (ref($internet_names) eq 'ARRAY') {
               if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
                   $sameinst = 1;
               }
           }
       }
       if (wantarray) {
           return ($samedom,$sameinst);
       } else {
           $clienthomedom = $homedom;
           $clientsamedom = $samedom;
           $clientintdom = $intdom;
           $clientsameinst = $sameinst;
           if ($clientsameinst) {
               undef($clientremoteok);
               undef(%clientprohibited);
           } else {
               $clientremoteok = &get_remote_hostable($currentdomainid);
               %clientprohibited = &get_prohibited($currentdomainid);
           }
           return 1;
       }
   }
   
 #  #
   #   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 4032  sub make_new_child { Line 8365  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 = shift;      my ($request, $domain, $user, $authtype) = @_;
     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.  #  Return the full path of a user password file, whether it exists or not.
 # Parameters:  # Parameters:
Line 4056  sub ManagePermissions { Line 8388  sub ManagePermissions {
 # Returns:  # Returns:
 #    Full passwd path:  #    Full passwd path:
 #  #
 sub PasswordPath {  sub password_path {
     my $domain = shift;      my ($domain, $user) = @_;
     my $user   = shift;      return &propath($domain, $user).'/passwd';
   
     my $path   = &propath($domain, $user);  
     $path  .= "/passwd";  
   
     return $path;  
 }  }
   
 #   Password Filename  #   Password Filename
Line 4076  sub PasswordPath { Line 8403  sub PasswordPath {
 #   - If the password file exists returns its path.  #   - If the password file exists returns its path.
 #   - If the password file does not exist, returns undefined.  #   - If the password file does not exist, returns undefined.
 #  #
 sub PasswordFilename {  sub password_filename {
     my $domain    = shift;      my ($domain, $user) = @_;
     my $user      = shift;  
   
     Debug ("PasswordFilename called: dom = $domain user = $user");      Debug ("PasswordFilename called: dom = $domain user = $user");
   
     my $path  = PasswordPath($domain, $user);      my $path  = &password_path($domain, $user);
     Debug("PasswordFilename got path: $path");      Debug("PasswordFilename got path: $path");
     if(-e $path) {      if(-e $path) {
  return $path;   return $path;
Line 4097  sub PasswordFilename { Line 8423  sub PasswordFilename {
 #    domain    - domain of the user.  #    domain    - domain of the user.
 #    name      - User's name.  #    name      - User's name.
 #    contents  - New contents of the file.  #    contents  - New contents of the file.
   #    saveold   - (optional). If true save old file in a passwd.bak file.
 # Returns:  # Returns:
 #   0    - Failed.  #   0    - Failed.
 #   1    - Success.  #   1    - Success.
 #  #
 sub RewritePwFile {  sub rewrite_password_file {
     my $domain   = shift;      my ($domain, $user, $contents, $saveold) = @_;
     my $user     = shift;  
     my $contents = shift;  
   
     my $file = PasswordFilename($domain, $user);      my $file = &password_filename($domain, $user);
     if (defined $file) {      if (defined $file) {
           if ($saveold) {
               my $bakfile = $file.'.bak';
               if (CopyFile($file,$bakfile)) {
                   chmod(0400,$bakfile);
                   &logthis("Old password saved in passwd.bak for internally authenticated user: $user:$domain");
               } else {
                   &logthis("Failed to save old password in passwd.bak for internally authenticated user: $user:$domain");
               }
           }
  my $pf = IO::File->new(">$file");   my $pf = IO::File->new(">$file");
  if($pf) {   if($pf) {
     print $pf "$contents\n";      print $pf "$contents\n";
Line 4120  sub RewritePwFile { Line 8454  sub RewritePwFile {
     }      }
   
 }  }
   
 #  #
 #   GetAuthType - Determines the authorization type of a user in a domain.  #   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 = shift;      my ($domain, $user)  = @_;
     my $user   = shift;  
       Debug("get_auth_type( $domain, $user ) \n");
     Debug("GetAuthType( $domain, $user ) \n");      my $proname    = &propath($domain, $user); 
     my $passwdfile = PasswordFilename($domain, $user);      my $passwdfile = "$proname/passwd";
     if( defined $passwdfile ) {      if( -e $passwdfile ) {
  my $pf = IO::File->new($passwdfile);   my $pf = IO::File->new($passwdfile);
  my $realpassword = <$pf>;   my $realpassword = <$pf>;
  chomp($realpassword);   chomp($realpassword);
  Debug("Password info = $realpassword\n");   Debug("Password info = $realpassword\n");
  return $realpassword;   my ($authtype, $contentpwd) = split(/:/, $realpassword);
    Debug("Authtype = $authtype, content = $contentpwd\n");
    return "$authtype:$contentpwd";     
     } else {      } else {
  Debug("Returning nouser");   Debug("Returning nouser");
  return "nouser";   return "nouser";
Line 4158  sub GetAuthType { Line 8495  sub GetAuthType {
 #                user.  #                user.
 #     0        - The domain,user,password triplet is not a valid user.  #     0        - The domain,user,password triplet is not a valid user.
 #  #
 sub ValidateUser {  sub validate_user {
     my $domain  = shift;      my ($domain, $user, $password, $checkdefauth) = @_;
     my $user    = shift;  
     my $password= shift;  
   
     # Why negative ~pi you may well ask?  Well this function is about      # Why negative ~pi you may well ask?  Well this function is about
     # authentication, and therefore very important to get right.      # authentication, and therefore very important to get right.
Line 4170  sub ValidateUser { Line 8505  sub ValidateUser {
     # At the end of this function. I'll ensure that it's not still that      # 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      # value so we don't just wind up returning some accidental value
     # as a result of executing an unforseen code path that      # as a result of executing an unforseen code path that
     # did not set $validated.      # 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;      my $validated = -3.14159;
   
Line 4178  sub ValidateUser { Line 8514  sub ValidateUser {
     #  the user has been assigned.  If the authentication type is      #  the user has been assigned.  If the authentication type is
     #  "nouser", the user does not exist so we will return 0.      #  "nouser", the user does not exist so we will return 0.
   
     my $contents = GetAuthType($domain, $user);      my $contents = &get_auth_type($domain, $user);
     my ($howpwd, $contentpwd) = split(/:/, $contents);      my ($howpwd, $contentpwd) = split(/:/, $contents);
   
     my $null = pack("C",0); # Used by kerberos auth types.      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 '')) {
                   #
                   # Don't attempt authentication for username and password supplied
                   # for user without an account if uername contains @ to avoid
                   # call to &Authen::Krb5::parse_name() which will result in con_lost
                   #
                   unless ($user =~ /\@/) {
                       $howpwd = $domdefaults{'auth_def'};
                       $contentpwd = $domdefaults{'auth_arg_def'};
                   }
               }
           }
       }
     if ($howpwd ne 'nouser') {      if ($howpwd ne 'nouser') {
   
  if($howpwd eq "internal") { # Encrypted is in local password file.   if($howpwd eq "internal") { # Encrypted is in local password file.
     $validated = (crypt($password, $contentpwd) eq $contentpwd);              if (length($contentpwd) == 13) {
                   $validated = (crypt($password,$contentpwd) eq $contentpwd);
                   if ($validated) {
                       my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                       if ($domdefaults{'intauth_switch'}) {
                           my $ncpass = &hash_passwd($domain,$password);
                           my $saveold;
                           if ($domdefaults{'intauth_switch'} == 2) {
                               $saveold = 1;
                           }
                           if (&rewrite_password_file($domain,$user,"$howpwd:$ncpass",$saveold)) {
                               &update_passwd_history($user,$domain,$howpwd,'conversion');
                               &logthis("Validated password hashed with bcrypt for $user:$domain");
                           }
                       }
                   }
               } else {
                   $validated = &check_internal_passwd($password,$contentpwd,$domain,$user);
               }
  }   }
  elsif ($howpwd eq "unix") { # User is a normal unix user.   elsif ($howpwd eq "unix") { # User is a normal unix user.
     $contentpwd = (getpwnam($user))[1];      $contentpwd = (getpwnam($user))[1];
Line 4206  sub ValidateUser { Line 8580  sub ValidateUser {
     } else {      } else {
  $validated = 0;   $validated = 0;
     }      }
  }   } elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.
  elsif ($howpwd eq "krb4") { # user is in kerberos 4 auth. domain.              my $checkwithkrb5 = 0;
     if(! ($password =~ /$null/) ) {              if ($dist =~/^fedora(\d+)$/) {
  my $k4error = &Authen::Krb4::get_pw_in_tkt($user,                  if ($1 > 11) {
    "",                      $checkwithkrb5 = 1;
    $contentpwd,,                  }
    'krbtgt',              } elsif ($dist =~ /^suse([\d.]+)$/) {
    $contentpwd,                  if ($1 > 11.1) {
    1,                      $checkwithkrb5 = 1; 
    $password);                  }
  if(!$k4error) {              }
     $validated = 1;              if ($checkwithkrb5) {
  }                  $validated = &krb5_authen($password,$null,$user,$contentpwd);
  else {              } else {
     $validated = 0;                  $validated = &krb4_authen($password,$null,$user,$contentpwd);
     &logthis('krb4: '.$user.', '.$contentpwd.', '.              }
      &Authen::Krb4::get_err_txt($Authen::Krb4::error));   } elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.
  }              $validated = &krb5_authen($password,$null,$user,$contentpwd);
     }   } elsif ($howpwd eq "localauth") { 
     else {  
  $validated = 0; # Password has a match with null.  
     }  
  }  
  elsif ($howpwd eq "krb5") { # User is in kerberos 5 auth. domain.  
     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($krbclient);  
  my $krbreturn  = &Authen::KRb5::get_in_tkt_with_password($krbclient,  
  $krbserver,  
  $password,  
  $credentials);  
  $validated = ($krbreturn == 1);  
     }  
     else {  
  $validated = 0;  
     }  
  }  
  elsif ($howpwd eq "localauth") {   
     #  Authenticate via installation specific authentcation method:      #  Authenticate via installation specific authentcation method:
     $validated = &localauth::localauth($user,       $validated = &localauth::localauth($user, 
        $password,          $password, 
        $contentpwd);         $contentpwd,
  }         $domain);
  else { # Unrecognized auth is also bad.      if ($validated < 0) {
    &logthis("localauth for $contentpwd $user:$domain returned a $validated");
    $validated = 0;
       }
    } else { # Unrecognized auth is also bad.
     $validated = 0;      $validated = 0;
  }   }
     } else {      } else {
Line 4264  sub ValidateUser { Line 8619  sub ValidateUser {
     #      #
   
     unless ($validated != -3.14159) {      unless ($validated != -3.14159) {
  die "ValidateUser - failed to set the value of validated";   #  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 check_internal_passwd {
       my ($plainpass,$stored,$domain,$user) = @_;
       my (undef,$method,@rest) = split(/!/,$stored);
       if ($method eq 'bcrypt') {
           my $result = &hash_passwd($domain,$plainpass,@rest);
           if ($result ne $stored) {
               return 0;
           }
           my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
           if ($domdefaults{'intauth_check'}) {
               # Upgrade to a larger number of rounds if necessary
               my $defaultcost = $domdefaults{'intauth_cost'};
               if (($defaultcost eq '') || ($defaultcost =~ /D/)) {
                   $defaultcost = 10;
               }
               if (int($rest[0])<int($defaultcost)) {
                   if ($domdefaults{'intauth_check'} == 1) { 
                       my $ncpass = &hash_passwd($domain,$plainpass);
                       if (&rewrite_password_file($domain,$user,"internal:$ncpass")) {
                           &update_passwd_history($user,$domain,'internal','update cost');
                           &logthis("Validated password hashed with bcrypt for $user:$domain");
                       }
                       return 1;
                   } elsif ($domdefaults{'intauth_check'} == 2) {
                       return 0;
                   }
               }
           } else {
               return 1;
           }
       }
       return 0;
   }
   
   sub get_last_authchg {
       my ($domain,$user) = @_;
       my $lastmod;
       my $logname = &propath($domain,$user).'/passwd.log';
       if (-e "$logname") {
           $lastmod = (stat("$logname"))[9];
       }
       return $lastmod;
   }
   
   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);
           }
       }
       return $validated;
   }
   
   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;      return $validated;
 }  }
   
 #  
 #    Add a line to the subscription list?  
 #  
 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 4291  sub addline { Line 8750  sub addline {
     $sh->close();      $sh->close();
     return $found;      return $found;
 }  }
 #  
 #    Get chat messages.  sub get_chat {
 #      my ($cdom,$cname,$udom,$uname,$group)=@_;
 sub getchat {  
     my ($cdom,$cname,$udom,$uname)=@_;  
     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);
 }  }
 #  
 #   Add a chat message  sub chat_add {
 #      my ($cdom,$cname,$newchat,$group)=@_;
 sub chatadd {  
     my ($cdom,$cname,$newchat)=@_;  
     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 4339  sub chatadd { Line 8806  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 4379  sub currentversion { Line 8866  sub currentversion {
     my $version=-1;      my $version=-1;
     my $ulsdir='';      my $ulsdir='';
     if ($fname=~/^(.+)\/[^\/]+$/) {      if ($fname=~/^(.+)\/[^\/]+$/) {
  $ulsdir=$1;         $ulsdir=$1;
     }      }
     my ($fnamere1,$fnamere2);      my ($fnamere1,$fnamere2);
     # remove version if already specified      # remove version if already specified
Line 4393  sub currentversion { Line 8880  sub currentversion {
     if (-e $ulsdir) {      if (-e $ulsdir) {
  if(-d $ulsdir) {   if(-d $ulsdir) {
     if (opendir(LSDIR,$ulsdir)) {      if (opendir(LSDIR,$ulsdir)) {
                   if (-e $fname) {
                       $version=0;
                   }
  my $ulsfn;   my $ulsfn;
  while ($ulsfn=readdir(LSDIR)) {   while ($ulsfn=readdir(LSDIR)) {
 # see if this is a regular file (ignore links produced earlier)  # see if this is a regular file (ignore links produced earlier)
Line 4423  sub thisversion { Line 8913  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 4436  sub subscribe { Line 8926  sub subscribe {
                     symlink($root.'.'.$extension,                      symlink($root.'.'.$extension,
                             $root.'.'.$currentversion.'.'.$extension);                              $root.'.'.$currentversion.'.'.$extension);
                     unless ($extension=~/\.meta$/) {                      unless ($extension=~/\.meta$/) {
  symlink($root.'.'.$extension.'.meta',                         symlink($root.'.'.$extension.'.meta',
  $root.'.'.$currentversion.'.'.$extension.'.meta');                              $root.'.'.$currentversion.'.'.$extension.'.meta');
     }      }
                 }                  }
             }              }
Line 4456  sub subscribe { Line 8946  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 4467  sub subscribe { Line 8959  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,$action)=@_;
     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";
                   &update_passwd_history($uname,$udom,$umode,$action);
       } else {
    $result = "pass_file_failed_error";
       }
  }   }
     } elsif ($umode eq 'internal') {      } elsif ($umode eq 'internal') {
  my $salt=time;          my $ncpass = &hash_passwd($udom,$npass);
  $salt=substr($salt,6,2);  
  my $ncpass=crypt($npass,$salt);  
  {   {
     &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";
                   &update_passwd_history($uname,$udom,$umode,$action); 
       } 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";
                   &update_passwd_history($uname,$udom,$umode,$action);
       } else {
    $result = "pass_file_failed_error";
       }
  }   }
     } elsif ($umode eq 'unix') {      } elsif ($umode eq 'unix') {
  #   &logthis(">>>Attempt to create unix account blocked -- unix auth not available for new users.");
  #  Don't allow the creation of privileged accounts!!! that would   $result="no_new_unix_accounts";
  #  be real bad!!!  
  #  
  my $uid = getpwnam($uname);  
  if((defined $uid) && ($uid == 0)) {  
     &logthis(">>>Attempted add of privileged account blocked<<<");  
     return "no_priv_account_error\n";  
  }  
   
  #  
  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) {  
     my $lcstring = lcuseraddstrerror($useraddok);  
     &logthis("Failed lcuseradd: $lcstring");  
     return "error: lcuseradd failed: $lcstring\n";  
  }  
  my $pf = IO::File->new(">$passfilename");  
  print $pf "unix:\n";  
    
     } 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";
       }
  }   }
       } elsif ($umode eq 'lti') {
           my $pf = IO::File->new(">$passfilename");
           if($pf) {
               print $pf "lti:\n";
               &update_passwd_history($uname,$udom,$umode,$action);
           } 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);
           &set_client_info();
   # &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 4552  sub version { Line 9083  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;          &Apache::lonnet::do_cache_new($name,$dom,$domconfig{'usersessions'},3600);
  my $curtime=time;          return $domconfig{'usersessions'};
  while ($filename=readdir(LONIDS)) {      }
     if ($filename eq '.' || $filename eq '..') {next;}      return;
     my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];  }
     if ($curtime-$mtime < 1800) { $numusers++; }  
  }  sub get_usersearch_config {
  closedir(LONIDS);      my ($dom,$name) = @_;
     }      my ($usersearchconf,$cached)=&Apache::lonnet::is_cached_new($name,$dom);
     my $userloadpercent=0;      if (defined($cached)) {
     my $maxuserload=$perlvar{'lonUserLoadLim'};          return $usersearchconf;
     if ($maxuserload) {      } else {
  $userloadpercent=100*$numusers/$maxuserload;          my %domconfig = &Apache::lonnet::get_dom('configuration',['directorysrch'],$dom);
           &Apache::lonnet::do_cache_new($name,$dom,$domconfig{'directorysrch'},600);
           return $domconfig{'directorysrch'};
       }
       return;
   }
   
   sub get_prohibited {
       my ($dom) = @_;
       my $name = 'trust';
       my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new($name,$dom);
       unless (defined($cached)) {
           my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$dom);
           &Apache::lonnet::do_cache_new($name,$dom,$domconfig{'trust'},3600);
           $trustconfig = $domconfig{'trust'};
       }
       my %prohibited;
       if (ref($trustconfig)) {
           foreach my $prefix (keys(%{$trustconfig})) {
               if (ref($trustconfig->{$prefix}) eq 'HASH') {
                   my $reject;
                   if (ref($trustconfig->{$prefix}->{'exc'}) eq 'ARRAY') {
                       if (grep(/^\Q$clientintdom\E$/,@{$trustconfig->{$prefix}->{'exc'}})) {
                           $reject = 1;
                       }
                   }
                   if (ref($trustconfig->{$prefix}->{'inc'}) eq 'ARRAY') {
                       if (grep(/^\Q$clientintdom\E$/,@{$trustconfig->{$prefix}->{'inc'}})) {
                           $reject = 0;
                       } else {
                           $reject = 1;
                       }
                   }
                   if ($reject) {
                       $prohibited{$prefix} = 1;
                   }
               }
           }
     }      }
     $userloadpercent=sprintf("%.2f",$userloadpercent);      return %prohibited;
     return $userloadpercent;  }
   
   sub get_remote_hostable {
       my ($dom) = @_;
       my $result;
       if ($clientintdom) {
           $result = 1;
           my $remsessconf = &get_usersession_config($dom,'remotesession');
           if (ref($remsessconf) eq 'HASH') {
               if (ref($remsessconf->{'remote'}) eq 'HASH') {
                   if (ref($remsessconf->{'remote'}->{'excludedomain'}) eq 'ARRAY') {
                       if (grep(/^\Q$clientintdom\E$/,@{$remsessconf->{'remote'}->{'excludedomain'}})) {
                           $result = 0;
                       }
                   }
                   if (ref($remsessconf->{'remote'}->{'includedomain'}) eq 'ARRAY') {
                       if (grep(/^\Q$clientintdom\E$/,@{$remsessconf->{'remote'}->{'includedomain'}})) {
                           $result = 1;
                       } else {
                           $result = 0;
                       }
                   }
               }
           }
       }
       return $result;
   }
   
   sub distro_and_arch {
       return $dist.':'.$arch;
 }  }
   
 # ----------------------------------- POD (plain old documentation, CPAN style)  # ----------------------------------- POD (plain old documentation, CPAN style)
Line 4757  Allow for a password to be set. Line 9354  Allow for a password to be set.
   
 Make a user.  Make a user.
   
 =item passwd  =item changeuserauth
   
 Allow for authentication mechanism and password to be changed.  Allow for authentication mechanism and password to be changed.
   
Line 4846  for each student, defined perhaps by the Line 9443  for each student, defined perhaps by the
 Returns usernames corresponding to IDs.  (These "IDs" are unique identifiers  Returns usernames corresponding to IDs.  (These "IDs" are unique identifiers
 for each student, defined perhaps by the institutional Registrar.)  for each student, defined perhaps by the institutional Registrar.)
   
   =item iddel
   
   Deletes one or more ids in a domain's id database.
   
 =item tmpput  =item tmpput
   
 Accept and store information in temporary space.  Accept and store information in temporary space.
Line 4893  to the client, and the connection is clo Line 9494  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()  
 GDBM_File  GDBM_File
 Authen::Krb4  Authen::Krb4
 Authen::Krb5  Authen::Krb5
   
 =head1 COREQUISITES  =head1 COREQUISITES
   
   none
   
 =head1 OSNAMES  =head1 OSNAMES
   
 linux  linux
Line 4912  linux Line 9513  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.18  
changed lines
  Added in v.1.581

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