NetBSD/usr.bin/usbhidaction/usbhidaction.c
dsainty 432d19fe4b By setting close-on-exec on the USB HID device descriptor, prevent passing an
extraneous descriptor to the command defined as the action to take on a
particular HID event.

This also avoids an unfortunate side-effect: killing and restarting
usbhidaction would sometimes fail because of a lingering open descriptor for
the same device on a process executed by the previous run of usbhidaction.

[OK'd by Lennart]
2005-07-02 04:05:09 +00:00

460 lines
10 KiB
C

/* $NetBSD: usbhidaction.c,v 1.19 2005/07/02 04:05:09 dsainty Exp $ */
/*
* Copyright (c) 2000, 2002 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Lennart Augustsson <lennart@augustsson.net>.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the NetBSD
* Foundation, Inc. and its contributors.
* 4. Neither the name of The NetBSD Foundation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#include <sys/cdefs.h>
#ifndef lint
__RCSID("$NetBSD: usbhidaction.c,v 1.19 2005/07/02 04:05:09 dsainty Exp $");
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <err.h>
#include <fcntl.h>
#include <limits.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/ioctl.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbhid.h>
#include <usbhid.h>
#include <util.h>
#include <syslog.h>
#include <signal.h>
int verbose = 0;
int isdemon = 0;
int reparse = 0;
struct command {
struct command *next;
int line;
struct hid_item item;
int value;
char anyvalue;
char *name;
char *action;
};
struct command *commands;
#define SIZE 4000
void usage(void);
struct command *parse_conf(const char *, report_desc_t, int, int);
void docmd(struct command *, int, const char *, int, char **);
void freecommands(struct command *);
static void
sighup(int sig)
{
reparse = 1;
}
int
main(int argc, char **argv)
{
const char *conf = NULL;
const char *dev = NULL;
int fd, ch, sz, n, val, i;
int demon, ignore;
report_desc_t repd;
char buf[100];
char devnamebuf[PATH_MAX];
struct command *cmd;
int reportid;
const char *table = NULL;
setlinebuf(stdout);
demon = 1;
ignore = 0;
while ((ch = getopt(argc, argv, "c:df:it:v")) != -1) {
switch(ch) {
case 'c':
conf = optarg;
break;
case 'd':
demon ^= 1;
break;
case 'i':
ignore++;
break;
case 'f':
dev = optarg;
break;
case 't':
table = optarg;
break;
case 'v':
demon = 0;
verbose++;
break;
case '?':
default:
usage();
}
}
argc -= optind;
argv += optind;
if (conf == NULL || dev == NULL)
usage();
hid_init(table);
if (dev[0] != '/') {
snprintf(devnamebuf, sizeof(devnamebuf), "/dev/%s%s",
isdigit((unsigned char)dev[0]) ? "uhid" : "", dev);
dev = devnamebuf;
}
if (demon && conf[0] != '/')
errx(1, "config file must have an absolute path, %s", conf);
fd = open(dev, O_RDWR);
if (fd < 0)
err(1, "%s", dev);
/* Avoid passing the device file descriptor to executed commands */
if (fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)
err(1, "fcntl(F_SETFD, FD_CLOEXEC)");
if (ioctl(fd, USB_GET_REPORT_ID, &reportid) < 0)
reportid = -1;
repd = hid_get_report_desc(fd);
if (repd == NULL)
err(1, "hid_get_report_desc() failed");
commands = parse_conf(conf, repd, reportid, ignore);
sz = hid_report_size(repd, hid_input, reportid);
if (verbose)
printf("report size %d\n", sz);
if (sz > sizeof buf)
errx(1, "report too large");
(void)signal(SIGHUP, sighup);
if (demon) {
if (daemon(0, 0) < 0)
err(1, "daemon()");
pidfile(NULL);
isdemon = 1;
}
for(;;) {
n = read(fd, buf, sz);
if (verbose > 2) {
printf("read %d bytes:", n);
for (i = 0; i < n; i++)
printf(" %02x", buf[i]);
printf("\n");
}
if (n < 0) {
if (verbose)
err(1, "read");
else
exit(1);
}
#if 0
if (n != sz) {
err(2, "read size");
}
#endif
for (cmd = commands; cmd; cmd = cmd->next) {
val = hid_get_data(buf, &cmd->item);
if (cmd->value == val || cmd->anyvalue)
docmd(cmd, val, dev, argc, argv);
}
if (reparse) {
struct command *cmds =
parse_conf(conf, repd, reportid, ignore);
if (cmds) {
freecommands(commands);
commands = cmds;
}
reparse = 0;
}
}
exit(0);
}
void
usage(void)
{
fprintf(stderr, "usage: %s -c config_file [-d] -f hid_dev "
"[-i] [-t table] [-v]\n", getprogname());
exit(1);
}
static int
peek(FILE *f)
{
int c;
c = getc(f);
if (c != EOF)
ungetc(c, f);
return c;
}
struct command *
parse_conf(const char *conf, report_desc_t repd, int reportid, int ignore)
{
FILE *f;
char *p;
int line;
char buf[SIZE], name[SIZE], value[SIZE], action[SIZE];
char usage[SIZE], coll[SIZE];
struct command *cmd, *cmds;
struct hid_data *d;
struct hid_item h;
int u, lo, hi, range;
f = fopen(conf, "r");
if (f == NULL)
err(1, "%s", conf);
cmds = NULL;
for (line = 1; ; line++) {
if (fgets(buf, sizeof buf, f) == NULL)
break;
if (buf[0] == '#' || buf[0] == '\n')
continue;
p = strchr(buf, '\n');
while (p && isspace(peek(f))) {
if (fgets(p, sizeof buf - strlen(buf), f) == NULL)
break;
p = strchr(buf, '\n');
}
if (p)
*p = 0;
/* XXX SIZE == 4000 */
if (sscanf(buf, "%3999s %3999s %[^\n]", name, value, action) != 3) {
if (isdemon) {
syslog(LOG_WARNING, "config file `%s', line %d"
", syntax error: %s", conf, line, buf);
freecommands(cmds);
return (NULL);
} else {
errx(1, "config file `%s', line %d,"
", syntax error: %s", conf, line, buf);
}
}
cmd = malloc(sizeof *cmd);
if (cmd == NULL)
err(1, "malloc failed");
cmd->next = cmds;
cmds = cmd;
cmd->line = line;
if (strcmp(value, "*") == 0) {
cmd->anyvalue = 1;
} else {
cmd->anyvalue = 0;
if (sscanf(value, "%d", &cmd->value) != 1) {
if (isdemon) {
syslog(LOG_WARNING,
"config file `%s', line %d, "
"bad value: %s\n",
conf, line, value);
freecommands(cmds);
return (NULL);
} else {
errx(1, "config file `%s', line %d, "
"bad value: %s\n",
conf, line, value);
}
}
}
coll[0] = 0;
for (d = hid_start_parse(repd, 1 << hid_input, reportid);
hid_get_item(d, &h); ) {
if (verbose > 2)
printf("kind=%d usage=%x flags=%x\n",
h.kind, h.usage, h.flags);
switch (h.kind) {
case hid_input:
if (h.flags & HIO_CONST)
continue;
if (h.usage_minimum != 0 ||
h.usage_maximum != 0) {
lo = h.usage_minimum;
hi = h.usage_maximum;
range = 1;
} else {
lo = h.usage;
hi = h.usage;
range = 0;
}
for (u = lo; u <= hi; u++) {
snprintf(usage, sizeof usage, "%s:%s",
hid_usage_page(HID_PAGE(u)),
hid_usage_in_page(u));
if (verbose > 2)
printf("usage %s\n", usage);
if (!strcasecmp(usage, name))
goto foundhid;
if (coll[0]) {
snprintf(usage, sizeof usage,
"%s.%s:%s", coll+1,
hid_usage_page(HID_PAGE(u)),
hid_usage_in_page(u));
if (verbose > 2)
printf("usage %s\n",
usage);
if (!strcasecmp(usage, name))
goto foundhid;
}
}
break;
case hid_collection:
snprintf(coll + strlen(coll),
sizeof coll - strlen(coll), ".%s:%s",
hid_usage_page(HID_PAGE(h.usage)),
hid_usage_in_page(h.usage));
if (verbose > 2)
printf("coll '%s'\n", coll);
break;
case hid_endcollection:
if (coll[0])
*strrchr(coll, '.') = 0;
break;
default:
break;
}
}
if (ignore) {
if (verbose)
warnx("ignore item '%s'", name);
continue;
}
if (isdemon) {
syslog(LOG_WARNING, "config file `%s', line %d, HID "
"item not found: `%s'", conf, line, name);
freecommands(cmds);
return (NULL);
} else {
errx(1, "config file `%s', line %d, HID item "
"not found: `%s'", conf, line, name);
}
foundhid:
hid_end_parse(d);
cmd->item = h;
cmd->name = strdup(name);
cmd->action = strdup(action);
if (range) {
if (cmd->value == 1)
cmd->value = u - lo;
else
cmd->value = -1;
}
if (verbose)
printf("PARSE:%d %s, %d, '%s'\n", cmd->line, name,
cmd->value, cmd->action);
}
fclose(f);
return (cmds);
}
void
docmd(struct command *cmd, int value, const char *hid, int argc, char **argv)
{
char cmdbuf[SIZE], *p, *q;
size_t len;
int n, r;
for (p = cmd->action, q = cmdbuf; *p && q < &cmdbuf[SIZE-1]; ) {
if (*p == '$') {
p++;
len = &cmdbuf[SIZE-1] - q;
if (isdigit((unsigned char)*p)) {
n = strtol(p, &p, 10) - 1;
if (n >= 0 && n < argc) {
strncpy(q, argv[n], len);
q += strlen(q);
}
} else if (*p == 'V') {
p++;
snprintf(q, len, "%d", value);
q += strlen(q);
} else if (*p == 'N') {
p++;
strncpy(q, cmd->name, len);
q += strlen(q);
} else if (*p == 'H') {
p++;
strncpy(q, hid, len);
q += strlen(q);
} else if (*p) {
*q++ = *p++;
}
} else {
*q++ = *p++;
}
}
*q = 0;
if (verbose)
printf("system '%s'\n", cmdbuf);
r = system(cmdbuf);
if (verbose > 1 && r)
printf("return code = 0x%x\n", r);
}
void
freecommands(struct command *cmd)
{
struct command *next;
while (cmd) {
next = cmd->next;
free(cmd);
cmd = next;
}
}