From: Mike Brady <4265913+mikebrady@users.noreply.github.com>
Date: Mon, 14 Apr 2025 09:40:26 +0000 (+0100)
Subject: Check for configuration strings that are given but turn out to be empty, issue a... 
X-Git-Tag: 5.0-post-dev~100
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e05448aecc024733c7dc5ee2f2e047ff6199b91e;p=thirdparty%2Fshairport-sync.git

Check for configuration strings that are given but turn out to be empty, issue a warning and ignore them.
---

diff --git a/audio_alsa.c b/audio_alsa.c
index 0b1757ce..5081ad96 100644
--- a/audio_alsa.c
+++ b/audio_alsa.c
@@ -1224,25 +1224,25 @@ static int init(int argc, char **argv) {
     double dvalue;
 
     /* Get the Output Device Name. */
-    if (config_lookup_string(config.cfg, "alsa.output_device", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "alsa.output_device", &str)) {
       alsa_out_dev = (char *)str;
     }
 
     /* Get the Mixer Type setting. */
 
-    if (config_lookup_string(config.cfg, "alsa.mixer_type", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "alsa.mixer_type", &str)) {
       inform("The alsa mixer_type setting is deprecated and has been ignored. "
              "FYI, using the \"mixer_control_name\" setting automatically "
              "chooses a hardware mixer.");
     }
 
     /* Get the Mixer Device Name. */
-    if (config_lookup_string(config.cfg, "alsa.mixer_device", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "alsa.mixer_device", &str)) {
       alsa_mix_dev = (char *)str;
     }
 
     /* Get the Mixer Control Name. */
-    if (config_lookup_string(config.cfg, "alsa.mixer_control_name", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "alsa.mixer_control_name", &str)) {
       alsa_mix_ctrl = (char *)str;
     }
 
diff --git a/audio_jack.c b/audio_jack.c
index 6a8bf349..40f0c966 100644
--- a/audio_jack.c
+++ b/audio_jack.c
@@ -196,14 +196,14 @@ static int jack_init(__attribute__((unused)) int argc, __attribute__((unused)) c
   // Now the options specific to the backend, from the "jack" stanza:
   if (config.cfg != NULL) {
     const char *str;
-    if (config_lookup_string(config.cfg, "jack.client_name", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "jack.client_name", &str)) {
       config.jack_client_name = (char *)str;
     }
-    if (config_lookup_string(config.cfg, "jack.autoconnect_pattern", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "jack.autoconnect_pattern", &str)) {
       config.jack_autoconnect_pattern = (char *)str;
     }
 #ifdef CONFIG_SOXR
-    if (config_lookup_string(config.cfg, "jack.soxr_resample_quality", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "jack.soxr_resample_quality", &str)) {
       debug(1, "SOXR quality %s", str);
       config.jack_soxr_resample_quality = parse_soxr_quality_name(str);
     }
diff --git a/audio_pa.c b/audio_pa.c
index 6c29868b..98186a9c 100644
--- a/audio_pa.c
+++ b/audio_pa.c
@@ -500,13 +500,13 @@ static int init(__attribute__((unused)) int argc, __attribute__((unused)) char *
     const char *str;
 
     /* Get the PulseAudio server name. */
-    if (config_lookup_string(config.cfg, "pulseaudio.server", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "pulseaudio.server", &str)) {
       config.pa_server = (char *)str;
     }
 
     // get the default channel mapping setting basis -- native ("no") or pa ("yes").
 
-    if (config_lookup_string(config.cfg, "pulseaudio", &default_channel_layouts)) {
+    if (config_lookup_non_empty_string(config.cfg, "pulseaudio", &default_channel_layouts)) {
       if ((strcasecmp(default_channel_layouts, "alsa") == 0) ||
           (strcasecmp(default_channel_layouts, "pulseaudio") == 0)) {
         debug(1, "pulseaudio default_channel_layouts setting: \"%s\".", default_channel_layouts);
@@ -518,12 +518,12 @@ static int init(__attribute__((unused)) int argc, __attribute__((unused)) char *
     };
 
     /* Get the Application Name. */
-    if (config_lookup_string(config.cfg, "pulseaudio.application_name", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "pulseaudio.application_name", &str)) {
       config.pa_application_name = (char *)str;
     }
 
     /* Get the PulseAudio sink name. */
-    if (config_lookup_string(config.cfg, "pulseaudio.sink", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "pulseaudio.sink", &str)) {
       config.pa_sink = (char *)str;
     }
   }
diff --git a/audio_pipe.c b/audio_pipe.c
index 459a4fa0..cc86b380 100644
--- a/audio_pipe.c
+++ b/audio_pipe.c
@@ -116,8 +116,10 @@ static int init(int argc, char **argv) {
   if (config.cfg != NULL) {
     /* Get the Output Pipename. */
     const char *str;
-    if (config_lookup_string(config.cfg, "pipe.name", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "pipe.name", &str)) {
       pipename = (char *)str;
+    } else {
+      die("pipename needed");
     }
   }
 
diff --git a/audio_pw.c b/audio_pw.c
index c090ac75..b82cf3f7 100644
--- a/audio_pw.c
+++ b/audio_pw.c
@@ -209,17 +209,17 @@ static int init(__attribute__((unused)) int argc, __attribute__((unused)) char *
     const char *str;
 
     // Get the optional Application Name, if provided.
-    if (config_lookup_string(config.cfg, "pipewire.application_name", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "pipewire.application_name", &str)) {
       config.pw_application_name = (char *)str;
     }
 
     // Get the optional PipeWire node name, if provided.
-    if (config_lookup_string(config.cfg, "pipewire.node_name", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "pipewire.node_name", &str)) {
       config.pw_node_name = (char *)str;
     }
 
     // Get the optional PipeWire sink target name, if provided.
-    if (config_lookup_string(config.cfg, "pipewire.sink_target", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "pipewire.sink_target", &str)) {
       config.pw_sink_target = (char *)str;
     }
   }
diff --git a/audio_sndio.c b/audio_sndio.c
index 2972c842..e83f3cb8 100644
--- a/audio_sndio.c
+++ b/audio_sndio.c
@@ -397,7 +397,7 @@ static int init(int argc, char **argv) {
   // get specific settings
   int value;
   if (config.cfg != NULL) {
-    if (!config_lookup_string(config.cfg, "sndio.device", &output_device_name))
+    if (!config_lookup_non_empty_string(config.cfg, "sndio.device", &output_device_name))
       output_device_name = SIO_DEVANY;
 
     if (config_lookup_int(config.cfg, "sndio.bufsz", &value)) {
diff --git a/common.c b/common.c
index 2da97a3d..7a6a9efa 100644
--- a/common.c
+++ b/common.c
@@ -1216,6 +1216,18 @@ uint8_t *rsa_apply(uint8_t *input, int inlen, int *outlen, int mode) {
 }
 #endif
 
+
+int config_lookup_non_empty_string(const config_t * the_config, const char * path, const char ** value) {
+  int response = config_lookup_string(the_config, path, value);
+  if (response == CONFIG_TRUE) {
+    if ((value != NULL) && ((*value == NULL) || (*value[0] == 0))) {
+      warn("The \"%s\" parameter is an empty string and has been ignored.", path);
+      response = CONFIG_FALSE;
+    }
+  }
+  return response;
+}
+
 int config_set_lookup_bool(config_t *cfg, char *where, int *dst) {
   const char *str = 0;
   if (config_lookup_string(cfg, where, &str)) {
diff --git a/common.h b/common.h
index 149f7b56..772b9fab 100644
--- a/common.h
+++ b/common.h
@@ -535,6 +535,7 @@ extern int type_of_exit_cleanup; // normal, emergency, dbus requested...
 
 extern uint64_t minimum_dac_queue_size;
 
+int config_lookup_non_empty_string(const config_t * the_config, const char * path, const char ** value);
 int config_set_lookup_bool(config_t *cfg, char *where, int *dst);
 int check_string_or_list_setting(config_setting_t *setting, const char *item);
 int check_int_or_list_setting(config_setting_t *setting, const int item);
diff --git a/shairport.c b/shairport.c
index 001000cf..359ab194 100644
--- a/shairport.c
+++ b/shairport.c
@@ -650,7 +650,7 @@ int parse_options(int argc, char **argv) {
       config.cfg = &config_file_stuff;
 
       /* Get the Service Name. */
-      if (config_lookup_string(config.cfg, "general.name", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "general.name", &str)) {
         raw_service_name = (char *)str;
       }
 #ifdef CONFIG_LIBDAEMON
@@ -662,16 +662,16 @@ int parse_options(int argc, char **argv) {
                              &daemonisewithout);
 
       /* Get the directory path for the pid file created when the program is daemonised. */
-      if (config_lookup_string(config.cfg, "sessioncontrol.daemon_pid_dir", &str))
+      if (config_lookup_non_empty_string(config.cfg, "sessioncontrol.daemon_pid_dir", &str))
         config.piddir = (char *)str;
 #endif
 
       /* Get the mdns_backend setting. */
-      if (config_lookup_string(config.cfg, "general.mdns_backend", &str))
+      if (config_lookup_non_empty_string(config.cfg, "general.mdns_backend", &str))
         config.mdns_name = (char *)str;
 
       /* Get the output_backend setting. */
-      if (config_lookup_string(config.cfg, "general.output_backend", &str))
+      if (config_lookup_non_empty_string(config.cfg, "general.output_backend", &str))
         config.output_name = (char *)str;
 
       /* Get the port setting. */
@@ -708,7 +708,7 @@ int parse_options(int argc, char **argv) {
       }
 
       /* Get the password setting. */
-      if (config_lookup_string(config.cfg, "general.password", &str))
+      if (config_lookup_non_empty_string(config.cfg, "general.password", &str))
         config.password = (char *)str;
 
       if (config_lookup_string(config.cfg, "general.interpolation", &str)) {
@@ -918,7 +918,7 @@ int parse_options(int argc, char **argv) {
         }
       }
 
-      if (config_lookup_string(config.cfg, "general.run_this_when_volume_is_set", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "general.run_this_when_volume_is_set", &str)) {
         config.cmd_set_volume = (char *)str;
       }
 
@@ -960,11 +960,9 @@ int parse_options(int argc, char **argv) {
       /* Get the interface to listen on, if specified Default is all interfaces */
       /* we keep the interface name and the index */
 
-      if (config_lookup_string(config.cfg, "general.interface", &str))
-        config.interface = strdup(str);
-
       if (config_lookup_string(config.cfg, "general.interface", &str)) {
 
+        config.interface = strdup(str);
         config.interface_index = if_nametoindex(config.interface);
 
         if (config.interface_index == 0) {
@@ -978,7 +976,7 @@ int parse_options(int argc, char **argv) {
 
       /* Get the regtype -- the service type and protocol, separated by a dot. Default is
        * "_raop._tcp" */
-      if (config_lookup_string(config.cfg, "general.regtype", &str))
+      if (config_lookup_non_empty_string(config.cfg, "general.regtype", &str))
         config.regtype = strdup(str);
 
       /* Get the volume range, in dB, that should be used If not set, it means you just use the
@@ -1091,7 +1089,7 @@ int parse_options(int argc, char **argv) {
               str);
       }
 
-      if (config_lookup_string(config.cfg, "metadata.pipe_name", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "metadata.pipe_name", &str)) {
         config.metadata_pipename = (char *)str;
       }
 
@@ -1099,7 +1097,7 @@ int parse_options(int argc, char **argv) {
         config.metadata_progress_interval = dvalue;
       }
 
-      if (config_lookup_string(config.cfg, "metadata.socket_address", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "metadata.socket_address", &str)) {
         config.metadata_sockaddr = (char *)str;
       }
       if (config_lookup_int(config.cfg, "metadata.socket_port", &value)) {
@@ -1113,7 +1111,7 @@ int parse_options(int argc, char **argv) {
 #endif
 
 #ifdef CONFIG_METADATA_HUB
-      if (config_lookup_string(config.cfg, "metadata.cover_art_cache_directory", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "metadata.cover_art_cache_directory", &str)) {
         config.cover_art_cache_dir = (char *)str;
       }
 
@@ -1129,20 +1127,20 @@ int parse_options(int argc, char **argv) {
       }
 #endif
 
-      if (config_lookup_string(config.cfg, "sessioncontrol.run_this_before_play_begins", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "sessioncontrol.run_this_before_play_begins", &str)) {
         config.cmd_start = (char *)str;
       }
 
-      if (config_lookup_string(config.cfg, "sessioncontrol.run_this_after_play_ends", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "sessioncontrol.run_this_after_play_ends", &str)) {
         config.cmd_stop = (char *)str;
       }
 
-      if (config_lookup_string(config.cfg, "sessioncontrol.run_this_before_entering_active_state",
+      if (config_lookup_non_empty_string(config.cfg, "sessioncontrol.run_this_before_entering_active_state",
                                &str)) {
         config.cmd_active_start = (char *)str;
       }
 
-      if (config_lookup_string(config.cfg, "sessioncontrol.run_this_after_exiting_active_state",
+      if (config_lookup_non_empty_string(config.cfg, "sessioncontrol.run_this_after_exiting_active_state",
                                &str)) {
         config.cmd_active_stop = (char *)str;
       }
@@ -1156,7 +1154,7 @@ int parse_options(int argc, char **argv) {
           config.active_state_timeout = dvalue;
       }
 
-      if (config_lookup_string(config.cfg,
+      if (config_lookup_non_empty_string(config.cfg,
                                "sessioncontrol.run_this_if_an_unfixable_error_is_detected", &str)) {
         config.cmd_unfixable = (char *)str;
       }
@@ -1241,7 +1239,7 @@ int parse_options(int argc, char **argv) {
           die("dsp.convolution_max_length must be within 1 and 200000");
       }
 
-      if (config_lookup_string(config.cfg, "dsp.convolution_ir_file", &str)) {
+      if (config_lookup_non_empty_string(config.cfg, "dsp.convolution_ir_file", &str)) {
         config.convolution_ir_file = strdup(str);
         config.convolver_valid =
             convolver_init(config.convolution_ir_file, config.convolution_max_length);
@@ -1272,7 +1270,7 @@ int parse_options(int argc, char **argv) {
               dvalue);
       }
 
-      if (config.loudness == 1 && config_lookup_string(config.cfg, "alsa.mixer_control_name", &str))
+      if (config.loudness == 1 && config_lookup_non_empty_string(config.cfg, "alsa.mixer_control_name", &str))
         die("Loudness activated but hardware volume is active. You must remove "
             "\"alsa.mixer_control_name\" to use the loudness filter.");
 
@@ -1318,7 +1316,7 @@ int parse_options(int argc, char **argv) {
     if (config.mqtt_enabled && !config.metadata_enabled) {
       die("You need to have metadata enabled in order to use mqtt");
     }
-    if (config_lookup_string(config.cfg, "mqtt.hostname", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.hostname", &str)) {
       config.mqtt_hostname = (char *)str;
       // TODO: Document that, if this is false, whole mqtt func is disabled
     }
@@ -1331,28 +1329,28 @@ int parse_options(int argc, char **argv) {
         config.mqtt_port = value;
     }
 
-    if (config_lookup_string(config.cfg, "mqtt.username", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.username", &str)) {
       config.mqtt_username = (char *)str;
     }
-    if (config_lookup_string(config.cfg, "mqtt.password", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.password", &str)) {
       config.mqtt_password = (char *)str;
     }
     int capath = 0;
-    if (config_lookup_string(config.cfg, "mqtt.capath", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.capath", &str)) {
       config.mqtt_capath = (char *)str;
       capath = 1;
     }
-    if (config_lookup_string(config.cfg, "mqtt.cafile", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.cafile", &str)) {
       if (capath)
         die("Supply either mqtt cafile or mqtt capath -- you have supplied both!");
       config.mqtt_cafile = (char *)str;
     }
     int certkeynum = 0;
-    if (config_lookup_string(config.cfg, "mqtt.certfile", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.certfile", &str)) {
       config.mqtt_certfile = (char *)str;
       certkeynum++;
     }
-    if (config_lookup_string(config.cfg, "mqtt.keyfile", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.keyfile", &str)) {
       config.mqtt_keyfile = (char *)str;
       certkeynum++;
     }
@@ -1362,7 +1360,7 @@ int parse_options(int argc, char **argv) {
           "If you do not want to use TLS Client Authentication, leave both empty.");
     }
 
-    if (config_lookup_string(config.cfg, "mqtt.topic", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.topic", &str)) {
       config.mqtt_topic = (char *)str;
     }
     config_set_lookup_bool(config.cfg, "mqtt.publish_raw", &config.mqtt_publish_raw);
@@ -1373,11 +1371,11 @@ int parse_options(int argc, char **argv) {
     }
     config_set_lookup_bool(config.cfg, "mqtt.enable_autodiscovery",
                            &config.mqtt_enable_autodiscovery);
-    if (config_lookup_string(config.cfg, "mqtt.autodiscovery_prefix", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.autodiscovery_prefix", &str)) {
       config.mqtt_autodiscovery_prefix = (char *)str;
     }
     config_set_lookup_bool(config.cfg, "mqtt.enable_remote", &config.mqtt_enable_remote);
-    if (config_lookup_string(config.cfg, "mqtt.empty_payload_substitute", &str)) {
+    if (config_lookup_non_empty_string(config.cfg, "mqtt.empty_payload_substitute", &str)) {
       if (strlen(str) == 0)
         config.mqtt_empty_payload_substitute = NULL;
       else
@@ -2696,7 +2694,7 @@ int main(int argc, char **argv) {
     }
   }
 
-  if ((config.cfg != NULL) && (config_lookup_string(config.cfg, "general.mixdown", &str))) {
+  if ((config.cfg != NULL) && (config_lookup_non_empty_string(config.cfg, "general.mixdown", &str))) {
     if ((strcasecmp(str, "off") == 0) || (strcasecmp(str, "no") == 0)) {
       config.mixdown_enable = 0; // 0 on initialisation
       debug(1, "mixdown disabled.", str);
@@ -2730,7 +2728,7 @@ int main(int argc, char **argv) {
   const char *str;
 
   if ((config.cfg != NULL) &&
-      (config_lookup_string(config.cfg, "general.eight_channel_mode", &str))) {
+      (config_lookup_non_empty_string(config.cfg, "general.eight_channel_mode", &str))) {
     if ((strcasecmp(str, "off") == 0) || (strcasecmp(str, "no") == 0)) {
       config.eight_channel_layout = 0; // 0 on initialisation
     } else if ((strcasecmp(str, "on") == 0) || (strcasecmp(str, "yes") == 0)) {
@@ -2752,7 +2750,7 @@ int main(int argc, char **argv) {
   }
 
   if ((config.cfg != NULL) &&
-      (config_lookup_string(config.cfg, "general.six_channel_mode", &str))) {
+      (config_lookup_non_empty_string(config.cfg, "general.six_channel_mode", &str))) {
     if ((strcasecmp(str, "off") == 0) || (strcasecmp(str, "no") == 0)) {
       config.six_channel_layout = 0; // 0 on initialisation
     } else if ((strcasecmp(str, "on") == 0) || (strcasecmp(str, "yes") == 0)) {
@@ -2773,7 +2771,7 @@ int main(int argc, char **argv) {
     }
   }
 
-  if ((config.cfg != NULL) && (config_lookup_string(config.cfg, "general.mixdown", &str))) {
+  if ((config.cfg != NULL) && (config_lookup_non_empty_string(config.cfg, "general.mixdown", &str))) {
     if ((strcasecmp(str, "off") == 0) || (strcasecmp(str, "no") == 0)) {
       config.mixdown_enable = 0; // 0 on initialisation
     } else if (strcasecmp(str, "auto") == 0) {