clients/ups{cmd,rw}.c: make the "OK" without "TRACKING" warning visible; introduce NUT_QUIET_OK_NOTRACKING to hide it though [#3383]

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>

Author: jimklimov

NEWS.adoc

@@ -401,6 +401,11 @@ several `FSD` notifications into one executed action. [PR #3097]
 
  - `upsc` has now optional JSON output [issue #3172, PR #3178]
 
+ - `upscmd` and `upsrw` clients would now report that the "OK" response only
+   means that the server accepted the query, if wait mode ("TRACKING") was
+   not specified, and what users could do about it (e.g. use the `-w` option
+   or `export NUT_QUIET_OK_NOTRACKING=true` to hide the warning). [issue #3383]
+
  - `upsset` CGI tool should now recognize `RANGE NUMBER` and `NUMBER` types.
    [#3164]
 

clients/upscmd.c

@@ -211,11 +211,19 @@ static void do_cmd(char **argv, const int argc)
 		/* sanity check on the size: "OK TRACKING " + UUID4_LEN */
 		strlen(buf) != (UUID4_LEN - 1 + strlen("OK TRACKING "))
 	) {
+		char	*e = getenv("NUT_QUIET_OK_NOTRACKING");
+		int	lvl = 0;	/* Visible by default */
+
+		if (e && !strcmp(e, "true"))
+			lvl = 1;	/* Hide into debuging if asked to */
+
 		/* reply as usual */
 		fprintf(stderr, "%s\n", buf);
-		upsdebugx(1, "%s: 'OK' only means the NUT data server accepted the request as valid, "
-			"but as we did not wait for result, we do not know if it was handled in fact.",
-			__func__);
+		upsdebugx(lvl, "%s: 'OK' only means the NUT data server accepted the request as valid, "
+			"but as we did not wait for result, we do not know if it was handled in fact.%s",
+			lvl ? __func__ : "WARNING",
+			lvl ? "" : " You can export NUT_QUIET_OK_NOTRACKING=true to hide this message, or use -w (-t SEC) option(s) to track the actual outcome."
+			);
 		return;
 	}
 

clients/upsrw.c

@@ -141,11 +141,19 @@ static void do_set(const char *varname, const char *newval)
 		/* sanity check on the size: "OK TRACKING " + UUID4_LEN */
 		strlen(buf) != (UUID4_LEN - 1 + strlen("OK TRACKING "))
 	) {
+		char	*e = getenv("NUT_QUIET_OK_NOTRACKING");
+		int	lvl = 0;	/* Visible by default */
+
+		if (e && !strcmp(e, "true"))
+			lvl = 1;	/* Hide into debuging if asked to */
+
 		/* reply as usual */
 		fprintf(stderr, "%s\n", buf);
-		upsdebugx(1, "%s: 'OK' only means the NUT data server accepted the request as valid, "
-			"but as we did not wait for result, we do not know if it was handled in fact.",
-			__func__);
+		upsdebugx(lvl, "%s: 'OK' only means the NUT data server accepted the request as valid, "
+			"but as we did not wait for result, we do not know if it was handled in fact.%s",
+			lvl ? __func__ : "WARNING",
+			lvl ? "" : " You can export NUT_QUIET_OK_NOTRACKING=true to hide this message, or use -w (-t SEC) option(s) to track the actual outcome."
+			);
 		return;
 	}
 

docs/nut.dict

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 3727 utf-8
+personal_ws-1.1 en 3728 utf-8
 AAC
 AAS
 ABI
@@ -835,6 +835,7 @@ NOTIFYMSG
 NOTOFF
 NOTOTHER
 NOTOVER
+NOTRACKING
 NOTTRIM
 NQA
 NTFS