patches to go with bug report #1497 (esound)

[Richard Boulton <rjb37 cam ac uk>]

Patches to fix autospawning with remote host specification bugs in esound
attached...

--Richard
--- esdlib.c.orig	Mon Jun 14 19:03:05 1999
+++ esdlib.c	Wed Jun 16 14:18:29 1999
@@ -19,11 +19,15 @@
 #include <errno.h>
 #include <sys/wait.h>
 
+#define ESD_UNIX_SOCKET "/tmp/.esd/socket"
+
 /*******************************************************************/
 /* prototypes */
 int esd_set_socket_buffers( int sock, int src_format, 
 			    int src_rate, int base_rate );
 static void dummy_signal(int signum);
+static int host_is_localhost(const char* host);
+static const char* host_getfromenv(const char *host);
 
 /* dummy handler */
 static void dummy_signal(int signum) {
@@ -64,6 +68,23 @@
 #endif
 
 /*******************************************************************/
+/* Determine whether a hostname corresponds to localhost or not */
+static int host_is_localhost(const char *host)
+{
+    /* FIXME - there must be a better way than this... */
+    if(host == NULL) return 1;
+    if(!strcmp(host, "localhost")) return 1;
+    return 0;
+}
+
+/*******************************************************************/
+/* Read hostname from environment vars if appropriate */
+static const char* host_getfromenv(const char *host)
+{
+    return host ? host : getenv("ESPEAKER");
+}
+
+/*******************************************************************/
 /* set socket buffer lengths to optimal length for audio data transfer */
 int esd_set_socket_buffers( int sock, int src_format, 
 			    int src_rate, int base_rate )
@@ -351,7 +372,10 @@
   unsigned int host_div = 0;
   
   /* see if we have a remote speaker to play to */
-  espeaker = host ? host : getenv( "ESPEAKER" );
+  /* FIXME - tidy all this code up - for starters the espeaker env
+   * variable has already been checked now. */
+  /* espeaker = host ? host : getenv( "ESPEAKER" );*/
+  espeaker = host;
   if ( espeaker != NULL ) {
     /* split the espeaker host into host:port */
     host_div = strcspn( espeaker, ":" );
@@ -447,7 +471,7 @@
   
   /* set the connect information */
   socket_unix.sun_family = AF_UNIX;
-  strncpy(socket_unix.sun_path, "/tmp/.esd/socket", sizeof(socket_unix.sun_path));
+  strncpy(socket_unix.sun_path, ESD_UNIX_SOCKET, sizeof(socket_unix.sun_path));
   
   if ( connect( socket_out,
 	       (struct sockaddr *) &socket_unix,
@@ -459,85 +483,95 @@
 }
 
 /*******************************************************************/
-/* initialize the socket to send data to the sound daemon */
-int esd_open_sound( const char *host )
-{
-  int connect_count = 0;
-  int socket_out = -1;
-  char use_unix = 0;
-  
-  if (access("/tmp/.esd/socket", R_OK | W_OK) == -1)
+/* try spawning a new esd (but only if config file allows us)
+ * This function returns 1 if spawning happened, 0 if not. */
+static int esd_try_spawning() {
+    int childpid;
+
+    esd_config_read();
+    if (esd_no_spawn) return 0;
+
+    childpid = fork();
+    if (!childpid)
     {
-      if (errno == EACCES) 
-	{
-	  /* not allowed access - can't init unix socket comms - esd already */
-	  /* there */
-          socket_out = esd_connect_tcpip(host);
-	}
-      else if (errno == ENOENT)
+	if (!fork())
 	{
-	  use_unix = 1;
-	  /* does not exist - try tcp/ip */
-	  socket_out = esd_connect_tcpip(host);	  
+	    char *cmd;
+
+	    setsid();
+
+	    cmd = malloc(sizeof("esd ") + strlen(esd_spawn_options));
+	    sprintf(cmd, "esd %s", esd_spawn_options);
+
+	    execl("/bin/sh", "/bin/sh", "-c", cmd, NULL);
+	    perror("execl");
+	    _exit(1);
 	}
+	else
+	    _exit(0);
     }
-  else
-    use_unix = 1;
-
-  /* tcp/ip fialed or we havent tried unix sockets yet */
-  if (socket_out < 0)
+    else
     {
-      if (use_unix)
-	socket_out = esd_connect_unix(host);
-      else
-	socket_out = esd_connect_tcpip(host);
+	int estat;
+	waitpid(childpid, &estat, 0); /* reap zombie */
     }
+    return 1;
+}
 
-  /* try tcp/ip, if we tried via usock and it didn't work */
-  if ((socket_out < 0) && use_unix)
-    socket_out = esd_connect_tcpip(host);
-
-  /* esd basically is uncontactable - lets run it and try again */
-  if (socket_out < 0)
-    {
-      esd_config_read();
+/*******************************************************************/
+/* initialize the socket to send data to the sound daemon */
+int esd_open_sound( const char *host )
+{
+  int connect_count = 0;
+  int socket_out = -1;
+  char try_unix = 1;   /* Whether it's worth trying UNIX sockets */
+  char try_spawn = 1;  /* Whether it's worth trying to spawn a new esd */
+  int spawned = 0;
+
+  /* Read hostname from environment vars if appropriate */
+  host = host_getfromenv(host);
+
+  if (!host_is_localhost(host))
+    {
+      /* Host is not local - so we MUST use TCP sockets, and there's
+       * no point in trying to spawn. */
+	try_unix = 0;
+	try_spawn = 0;
+    }
+
+  if (try_unix)
+    if (access(ESD_UNIX_SOCKET, R_OK | W_OK) == -1)
+      {
+	if (errno == EACCES) 
+	  {
+	    /* not allowed access - can't init unix socket comms
+	     * This means that something is already there, so we're
+	     * not going to be able to make unix sockets work */
+	    try_unix = 0;
+	  }
+	else if (errno == ENOENT)
+	  {
+	    /* does not exist - try tcp/ip, but if this fails we
+	     * can still try to set things up using unix sockets */
+	    socket_out = esd_connect_tcpip(host);
+	  }
+      }
 
-      if (!esd_no_spawn && !getenv("ESPEAKER"))
-	{
-	  int childpid;
+  /* Try making a UNIX connection */
+  if ((socket_out < 0) && try_unix)
+    socket_out = esd_connect_unix(host);
 
-	  childpid = fork();
-	  if (!childpid)
-	    {
-	      if (!fork())
-		{
-		  char *cmd;
-
-		  setsid();
-		  
-		  cmd = malloc(sizeof("esd ") + strlen(esd_spawn_options));
-		  sprintf(cmd, "esd %s", esd_spawn_options);
-
-		  execl("/bin/sh", "/bin/sh", "-c", cmd, NULL);
-		  perror("execl");
-		  _exit(1);
-		}
-	      else
-		_exit(0);
-	    }
-	  else
-	    {
-	      int estat;
-	      waitpid(childpid, &estat, 0); /* reap zombie */
-	    }
-	}
-      else
-	return socket_out;
-    }
+  /* If no connection yet, try TCP */
+  if (socket_out < 0)
+    socket_out = esd_connect_tcpip(host);
 
-  /* sit and spin for a bit to wait for esd to start - try 5 times over */
-  /* 5 seconds - if esd still hasnt started - give up */
-  while ((socket_out < 0) && (connect_count < 60))
+  /* ESD is uncontactable - try running it and try again */
+  if ((socket_out < 0) && try_spawn)
+    spawned = esd_try_spawning();
+
+  /* sit and spin for a bit to wait for esd to start - try 50 times */
+  /* in 5 seconds - if esd still hasnt started - give up */
+  while (spawned && (socket_out < 0) && (connect_count < 50))
     {
 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_USLEEP)
       struct timespec timewait;
@@ -546,15 +580,19 @@
       socket_out = esd_connect_unix(host);
       if (socket_out < 0)
 	socket_out = esd_connect_tcpip(host);
-      connect_count++;
 
+      if (socket_out < 0)
+	{
+	  connect_count++;
+	  /* Wait 100ms */
 #if defined(HAVE_USLEEP)
-      usleep(1000);
+	  usleep(100000);
 #elif defined(HAVE_NANOSLEEP)
-      timewait.tv_sec = 0;
-      timewait.tv_nsec = 10000000;
-      nanosleep(&timewait, NULL);
+	  timewait.tv_sec = 0;
+	  timewait.tv_nsec = 100000000;
+	  nanosleep(&timewait, NULL);
 #endif
+	}
     }
 
   if (socket_out >= 0)
@@ -640,8 +678,9 @@
     if ( socket_out >= 0 ) 
 	return socket_out;
 
-    /* if ESPEAKER is set, this is an error, bail out */
-    if ( getenv( "ESPEAKER" ) )
+    /* if we're not trying to connect to localhost, this is an error
+     * so bail out. */
+    if (!host_is_localhost(host_getfromenv(host)));
 	return -1;
 
     /* go for /dev/dsp */
@@ -848,8 +887,9 @@
     if ( socket_out >= 0 ) 
 	return socket_out;
 
-    /* if ESPEAKER is set, this is an error, bail out */
-    if ( getenv( "ESPEAKER" ) )
+    /* if we're not trying to connect to localhost, this is an error
+     * so bail out. */
+    if (!host_is_localhost(host_getfromenv(host)));
 	return -1;
 
     /* go for /dev/dsp */