Merge pull request #1864 from jimklimov/issue-1858-debug

Add debug verbosity setting for upssched, add `upsdebugx` for `parse_at()`, and add help lines for `-h/-V` in many tools

Author: jimklimov

clients/upsc.c

@@ -57,6 +57,10 @@ static void usage(const char *prog)
 	printf("  -c         - lists each client connected on <ups>, one per line.\n");
 	printf("  <ups>      - upsd server, <upsname>[@<hostname>[:<port>]] form\n");
 
+	printf("\nCommon arguments:\n");
+	printf("  -V         - display the version of this software\n");
+	printf("  -h         - display this help text\n");
+
 	nut_report_config_flags();
 }
 

clients/upscmd.c

@@ -54,6 +54,7 @@ static void usage(const char *prog)
 	printf("Administration program to initiate instant commands on UPS hardware.\n");
 	printf("\n");
 	printf("  -h		display this help text\n");
+	printf("  -V		display the version of this software\n");
 	printf("  -l <ups>	show available commands on UPS <ups>\n");
 	printf("  -u <username>	set username for command authentication\n");
 	printf("  -p <password>	set password for command authentication\n");

clients/upslog.c

@@ -161,6 +161,8 @@ static void help(const char *prog)
 	printf("  -m <tuple>	- Monitor UPS <ups,logfile>\n");
 	printf("		- Example: -m myups@server,/var/log/myups.log\n");
 	printf("  -u <user>	- Switch to <user> if started as root\n");
+	printf("  -V		- Display the version of this software\n");
+	printf("  -h		- Display this help text\n");
 
 	printf("\n");
 	printf("Some valid format string escapes:\n");

clients/upsmon.c

@@ -2175,6 +2175,7 @@ static void help(const char *arg_progname)
 	printf("  -D		raise debugging level (and stay foreground by default)\n");
 	printf("  -F		stay foregrounded even if no debugging is enabled\n");
 	printf("  -B		stay backgrounded even if debugging is bumped\n");
+	printf("  -V		display the version of this software\n");
 	printf("  -h		display this help\n");
 	printf("  -K		checks POWERDOWNFLAG, sets exit code to 0 if set\n");
 	printf("  -p		always run privileged (disable privileged parent)\n");

clients/upsrw.c

@@ -53,6 +53,7 @@ static void usage(const char *prog)
 	printf("Demo program to set variables within UPS hardware.\n");
 	printf("\n");
 	printf("  -h            display this help text\n");
+	printf("  -V            display the version of this software\n");
 	printf("  -s <variable>	specify variable to be changed\n");
 	printf("		use -s VAR=VALUE to avoid prompting for value\n");
 	printf("  -l            show all possible read/write variables.\n");

clients/upssched.c

@@ -68,7 +68,6 @@ typedef struct ttype_s {
 static ttype_t	*thead = NULL;
 static conn_t	*connhead = NULL;
 static char	*cmdscript = NULL, *pipefn = NULL, *lockfn = NULL;
-static int	verbose = 0;		/* use for debugging */
 
 /* ups name and notify type (string) as received from upsmon */
 static const	char	*upsname, *notify_type;
@@ -163,7 +162,7 @@ static void checktimers(void)
 		if (emptyctr < EMPTY_WAIT)
 			return;
 
-		if (verbose)
+		if (nut_debug_level)
 			upslogx(LOG_INFO, "Timer queue empty, exiting");
 
 #ifdef UPSSCHED_RACE_TEST
@@ -185,7 +184,7 @@ static void checktimers(void)
 		tmpnext = tmp->next;
 
 		if (now >= tmp->etime) {
-			if (verbose)
+			if (nut_debug_level)
 				upslogx(LOG_INFO, "Event: %s ", tmp->name);
 
 			exec_cmd(tmp->name);
@@ -215,7 +214,7 @@ static void start_timer(const char *name, const char *ofsstr)
 		return;
 	}
 
-	if (verbose)
+	if (nut_debug_level)
 		upslogx(LOG_INFO, "New timer: %s (%ld seconds)", name, ofs);
 
 	/* now add to the queue */
@@ -243,7 +242,7 @@ static void cancel_timer(const char *name, const char *cname)
 
 	for (tmp = thead; tmp != NULL; tmp = tmp->next) {
 		if (!strcmp(tmp->name, name)) {		/* match */
-			if (verbose)
+			if (nut_debug_level)
 				upslogx(LOG_INFO, "Cancelling timer: %s", name);
 			removetimer(tmp);
 			return;
@@ -252,7 +251,7 @@ static void cancel_timer(const char *name, const char *cname)
 
 	/* this is not necessarily an error */
 	if (cname && cname[0]) {
-		if (verbose)
+		if (nut_debug_level)
 			upslogx(LOG_INFO, "Cancel %s, event: %s", name, cname);
 
 		exec_cmd(cname);
@@ -779,7 +778,7 @@ static void start_daemon(TYPE_FD lockfd)
 
 	pipefd = open_sock();
 
-	if (verbose)
+	if (nut_debug_level)
 		upslogx(LOG_INFO, "Timer daemon started");
 
 	/* release the parent */
@@ -851,7 +850,7 @@ static void start_daemon(TYPE_FD lockfd)
 	}
 	pipefd = open_sock();
 
-	if (verbose)
+	if (nut_debug_level)
 		upslogx(LOG_INFO, "Timer daemon started");
 
 	/* drop the lock now that the background is running */
@@ -1191,33 +1190,56 @@ static void parse_at(const char *ntype, const char *un, const char *cmd,
 	}
 
 	/* check upsname: does this apply to us? */
-	if (strcmp(upsname, un) != 0)
-		if (strcmp(un, "*") != 0)
+	upsdebugx(2, "%s: is '%s' in AT command the '%s' we were launched to process?",
+		__func__, un, upsname);
+	if (strcmp(upsname, un) != 0) {
+		if (strcmp(un, "*") != 0) {
+			upsdebugx(1, "%s: SKIP: '%s' in AT command "
+				"did not match the '%s' UPSNAME "
+				"we were launched to process",
+				__func__, un, upsname);
 			return;		/* not for us, and not the wildcard */
+		} else {
+			upsdebugx(1, "%s: this AT command is for a wildcard: matched", __func__);
+		}
+	} else {
+		upsdebugx(1, "%s: '%s' in AT command matched the '%s' "
+			"UPSNAME we were launched to process",
+			__func__, un, upsname);
+	}
 
 	/* see if the current notify type matches the one from the .conf */
-	if (strcasecmp(notify_type, ntype) != 0)
+	if (strcasecmp(notify_type, ntype) != 0) {
+		upsdebugx(1, "%s: SKIP: '%s' in AT command "
+			"did not match the '%s' NOTIFYTYPE "
+			"we were launched to process",
+			__func__, ntype, notify_type);
 		return;
+	}
 
 	/* if command is valid, send it to the daemon (which may start it) */
 
 	if (!strcmp(cmd, "START-TIMER")) {
+		upsdebugx(1, "%s: processing %s", __func__, cmd);
 		sendcmd("START", ca1, ca2);
 		return;
 	}
 
 	if (!strcmp(cmd, "CANCEL-TIMER")) {
+		upsdebugx(1, "%s: processing %s", __func__, cmd);
 		sendcmd("CANCEL", ca1, ca2);
 		return;
 	}
 
 	if (!strcmp(cmd, "EXECUTE")) {
+		upsdebugx(1, "%s: processing %s", __func__, cmd);
+
 		if (ca1[0] == '\0') {
 			upslogx(LOG_ERR, "Empty EXECUTE command argument");
 			return;
 		}
 
-		if (verbose)
+		if (nut_debug_level)
 			upslogx(LOG_INFO, "Executing command: %s", ca1);
 
 		exec_cmd(ca1);
@@ -1324,17 +1346,48 @@ static void checkconf(void)
 	pconf_finish(&ctx);
 }
 
+static void help(const char *arg_progname)
+	__attribute__((noreturn));
+
+static void help(const char *arg_progname)
+{
+	printf("upssched: upsmon's scheduling helper for offset timers\n");
+	printf("Practical behavior is managed by UPSNAME and NOTIFYTYPE envvars\n");
+
+	printf("\nUsage: %s [OPTIONS]\n\n", arg_progname);
+	printf("  -D		raise debugging level (and stay foreground by default)\n");
+	printf("  -V		display the version of this software\n");
+	printf("  -h		display this help\n");
+
+	nut_report_config_flags();
+
+	exit(EXIT_SUCCESS);
+}
+
+
 int main(int argc, char **argv)
 {
-	const char	*prog = NULL;
-	/* More a use for argc to avoid warnings than a real need: */
-	if (argc > 0) {
-		xbasename(argv[0]);
-	} else {
-		xbasename("upssched");
-	}
+	const char	*prog = xbasename(argv[0]);
+	int i;
+
+	while ((i = getopt(argc, argv, "+DVh")) != -1) {
+		switch (i) {
+			case 'D':
+				nut_debug_level++;
+				break;
+
+			case 'h':
+				help(argv[0]);
+#ifndef HAVE___ATTRIBUTE__NORETURN
+				break;
+#endif
 
-	verbose = 1;		/* TODO: remove when done testing, or add -D */
+			case 'V':
+				/* just show the optional CONFIG_FLAGS banner */
+				nut_report_config_flags();
+				exit(EXIT_SUCCESS);
+		}
+	}
 
 	/* normally we don't have stderr, so get this going to syslog early */
 	open_syslog(prog);

docs/developers.txt

@@ -542,6 +542,12 @@ if (condition) {
 }
 -------------------------------------------------------------------------------
 
+NOTE: Earlier revisions of coding style might suggest avoiding braces if just
+one line is added as condition/loop/etc. handling code. Current approach is to
+welcome them even for single lines: on one hand, this confirms the intention
+that only this line is the conditional code; on another, this minimizes the
+context differences for later code comparisons, relocation, refactoring, etc.
+
 Un-used variables and function arguments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

server/upsd.c

@@ -1499,11 +1499,11 @@ static void help(const char *arg_progname)
 	printf("  -F		stay foregrounded even if no debugging is enabled\n");
 	printf("  -FF		stay foregrounded and still save the PID file\n");
 	printf("  -B		stay backgrounded even if debugging is bumped\n");
-	printf("  -h		display this help\n");
+	printf("  -h		display this help text\n");
+	printf("  -V		display the version of this software\n");
 	printf("  -r <dir>	chroots to <dir>\n");
 	printf("  -q		raise log level threshold\n");
 	printf("  -u <user>	switch to <user> (if started as root)\n");
-	printf("  -V		display the version of this software\n");
 	printf("  -4		IPv4 only\n");
 	printf("  -6		IPv6 only\n");
 

tools/nut-scanner/nut-scanner.c

@@ -337,6 +337,7 @@ static void show_usage()
 	printf("  -N, --disp_nut_conf: Display result in the ups.conf format\n");
 	printf("  -P, --disp_parsable: Display result in a parsable format\n");
 	printf("\nMiscellaneous options:\n");
+	printf("  -h, --help: display this help text\n");
 	printf("  -V, --version: Display NUT version\n");
 	printf("  -a, --available: Display available bus that can be scanned\n");
 	printf("  -q, --quiet: Display only scan result. No information on currently scanned bus is displayed.\n");