From eabd00e012f2bb43acf646a5ae1b5dbcfc1f79f4 Mon Sep 17 00:00:00 2001
From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Wed, 13 Oct 2021 13:32:07 +1000
Subject: [PATCH] properties: log a warning if the property type differs

If we try to fetch a property as some specific type and the parsing
fails, log a warning. This should catch any client bugs where the
properties are set wrongly.
---
 src/pipewire/log.c        |  2 ++
 src/pipewire/properties.c | 32 ++++++++++++++++++++++++++++----
 2 files changed, 30 insertions(+), 4 deletions(-)

diff --git a/src/pipewire/log.c b/src/pipewire/log.c
index b40f2383f..22d14555b 100644
--- a/src/pipewire/log.c
+++ b/src/pipewire/log.c
@@ -66,6 +66,7 @@ PW_LOG_TOPIC(log_metadata, "pw.metadata");
 PW_LOG_TOPIC(log_module, "pw.module");
 PW_LOG_TOPIC(log_node, "pw.node");
 PW_LOG_TOPIC(log_port, "pw.port");
+PW_LOG_TOPIC(log_properties, "pw.props");
 PW_LOG_TOPIC(log_protocol, "pw.protocol");
 PW_LOG_TOPIC(log_proxy, "pw.proxy");
 PW_LOG_TOPIC(log_resource, "pw.resource");
@@ -445,6 +446,7 @@ pw_log_init(void)
 	PW_LOG_TOPIC_INIT(log_module);
 	PW_LOG_TOPIC_INIT(log_node);
 	PW_LOG_TOPIC_INIT(log_port);
+	PW_LOG_TOPIC_INIT(log_properties);
 	PW_LOG_TOPIC_INIT(log_protocol);
 	PW_LOG_TOPIC_INIT(log_proxy);
 	PW_LOG_TOPIC_INIT(log_resource);
diff --git a/src/pipewire/properties.c b/src/pipewire/properties.c
index a1df86838..e5985c009 100644
--- a/src/pipewire/properties.c
+++ b/src/pipewire/properties.c
@@ -28,9 +28,13 @@
 #include <spa/utils/string.h>
 
 #include "pipewire/array.h"
+#include "pipewire/log.h"
 #include "pipewire/utils.h"
 #include "pipewire/properties.h"
 
+PW_LOG_TOPIC_EXTERN(log_properties);
+#define PW_LOG_TOPIC_DEFAULT log_properties
+
 /** \cond */
 struct properties {
 	struct pw_properties this;
@@ -510,11 +514,16 @@ int pw_properties_fetch_uint32(const struct pw_properties *properties, const cha
 			       uint32_t *value)
 {
 	const char *str = pw_properties_get(properties, key);
+	bool success;
 
 	if (!str)
 		return -ENOENT;
 
-	return spa_atou32(str, value, 0) ? 0 : -EINVAL;
+	success = spa_atou32(str, value, 0);
+	if (SPA_UNLIKELY(!success))
+		pw_log_warn("Failed to parse \"%s\"=\"%s\" as int32", key, str);
+
+	return success ? 0 : -EINVAL;
 }
 
 /** Fetch a property as int32_t
@@ -532,11 +541,16 @@ int pw_properties_fetch_int32(const struct pw_properties *properties, const char
 			      int32_t *value)
 {
 	const char *str = pw_properties_get(properties, key);
+	bool success;
 
 	if (!str)
 		return -ENOENT;
 
-	return spa_atoi32(str, value, 0) ? 0 : -EINVAL;
+	success = spa_atoi32(str, value, 0);
+	if (SPA_UNLIKELY(!success))
+		pw_log_warn("Failed to parse \"%s\"=\"%s\" as int32", key, str);
+
+	return success ? 0 : -EINVAL;
 }
 
 /** Fetch a property as uint64_t.
@@ -554,11 +568,16 @@ int pw_properties_fetch_uint64(const struct pw_properties *properties, const cha
 			       uint64_t *value)
 {
 	const char *str = pw_properties_get(properties, key);
+	bool success;
 
 	if (!str)
 		return -ENOENT;
 
-	return spa_atou64(str, value, 0) ? 0 : -EINVAL;
+	success = spa_atou64(str, value, 0);
+	if (SPA_UNLIKELY(!success))
+		pw_log_warn("Failed to parse \"%s\"=\"%s\" as uint64", key, str);
+
+	return success ? 0 : -EINVAL;
 }
 
 /** Fetch a property as int64_t
@@ -576,11 +595,16 @@ int pw_properties_fetch_int64(const struct pw_properties *properties, const char
 			      int64_t *value)
 {
 	const char *str = pw_properties_get(properties, key);
+	bool success;
 
 	if (!str)
 		return -ENOENT;
 
-	return spa_atoi64(str, value, 0) ? 0 : -EINVAL;
+	success = spa_atoi64(str, value, 0);
+	if (SPA_UNLIKELY(!success))
+		pw_log_warn("Failed to parse \"%s\"=\"%s\" as int64", key, str);
+
+	return success ? 0 : -EINVAL;
 }
 
 /** Fetch a property as boolean value