conky/src/apcupsd.cc

/*
 *
 * apcupsd.c:  conky module for APC UPS daemon monitoring
 *
 * Copyright (C) 2009 Jaromir Smrcek <jaromir.smrcek@zoner.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA.
 *
 */

#include "apcupsd.h"
#include "conky.h"
#include "logging.h"
#include "text_object.h"

#include <netdb.h>
#include <netinet/in.h>
#include <sys/time.h>
#include <unistd.h>
#include <cerrno>

enum _apcupsd_items {
  APCUPSD_NAME,
  APCUPSD_MODEL,
  APCUPSD_UPSMODE,
  APCUPSD_CABLE,
  APCUPSD_STATUS,
  APCUPSD_LINEV,
  APCUPSD_LOAD,
  APCUPSD_CHARGE,
  APCUPSD_TIMELEFT,
  APCUPSD_TEMP,
  APCUPSD_LASTXFER,
  _APCUPSD_COUNT
};

/* type for data exchange with main thread */
#define APCUPSD_MAXSTR 32
typedef struct apcupsd_s {
  char items[_APCUPSD_COUNT]
            [APCUPSD_MAXSTR + 1]; /* e.g. items[APCUPSD_STATUS] */
  char host[64];
  int port;
} APCUPSD_S, *PAPCUPSD_S;

static APCUPSD_S apcupsd;

//
// encapsulated recv()
//
static int net_recv_ex(int sock, void *buf, int size, struct timeval *tv) {
  fd_set fds;
  int res;

  // wait for some data to be read
  do {
    errno = 0;
    FD_ZERO(&fds);
    FD_SET(sock, &fds);
    res = select(sock + 1, &fds, nullptr, nullptr, tv);
  } while (res < 0 && errno == EINTR);
  if (res < 0) { return 0; }
  if (res == 0) {
    // timeout
    errno = ETIMEDOUT;  // select was successful, errno is now 0
    return 0;
  }

  // socket ready, read the data
  do {
    errno = 0;
    res = recv(sock, static_cast<char *>(buf), size, 0);
  } while (res < 0 && errno == EINTR);
  if (res < 0) { return 0; }
  if (res == 0) {
    // orderly shutdown
    errno = ENOTCONN;
    return 0;
  }

  return res;
}

//
// read whole buffer or fail
//
static int net_recv(int sock, void *buf, int size) {
  int todo = size;
  int off = 0;
  int len;
  struct timeval tv = {0, 250000};

  while (todo != 0) {
    len = net_recv_ex(sock, static_cast<char *>(buf) + off, todo, &tv);
    if (len == 0) { return 0; }
    todo -= len;
    off += len;
  }
  return 1;
}

//
// get one response line
//
static int get_line(int sock, char line[], short linesize) {
  // get the line length
  short sz;
  if (net_recv(sock, &sz, sizeof(sz)) == 0) { return -1; }
  sz = ntohs(sz);
  if (sz == 0) { return 0; }

  // get the line
  while (sz >= linesize) {
    // this is just a hack (being lazy), this should not happen anyway
    net_recv(sock, line, linesize);
    sz -= linesize;
  }
  if (net_recv(sock, line, sz) == 0) { return 0; }
  line[sz] = 0;
  return sz;
}

#define FILL(NAME, FIELD, FIRST)                                               \
  if (!strncmp(NAME, line, sizeof(NAME) - 1)) {                                \
    strncpy(apc->items[FIELD], line + 11, APCUPSD_MAXSTR);                     \
    /* remove trailing newline and assure termination */                       \
    apc->items[FIELD][len - 11 > APCUPSD_MAXSTR ? APCUPSD_MAXSTR : len - 12] = \
        0;                                                                     \
    if (FIRST) {                                                               \
      char *c;                                                                 \
      for (c = apc->items[FIELD]; *c; ++c)                                     \
        if (*c == ' ' && c > apc->items[FIELD] + 2) {                          \
          *c = 0;                                                              \
          break;                                                               \
        }                                                                      \
    }                                                                          \
  }

//
// fills in the data received from a socket
//
static int fill_items(int sock, PAPCUPSD_S apc) {
  char line[512];
  int len;
  while ((len = get_line(sock, line, sizeof(line))) != 0) {
    // fill the right types in
    FILL("UPSNAME", APCUPSD_NAME, FALSE);
    FILL("MODEL", APCUPSD_MODEL, FALSE);
    FILL("UPSMODE", APCUPSD_UPSMODE, FALSE);
    FILL("CABLE", APCUPSD_CABLE, FALSE);
    FILL("STATUS", APCUPSD_STATUS, TRUE);
    FILL("LINEV", APCUPSD_LINEV, TRUE);
    FILL("LOADPCT", APCUPSD_LOAD, TRUE);
    FILL("BCHARGE", APCUPSD_CHARGE, TRUE);
    FILL("TIMELEFT", APCUPSD_TIMELEFT, TRUE);
    FILL("ITEMP", APCUPSD_TEMP, TRUE);
    FILL("LASTXFER", APCUPSD_LASTXFER, FALSE);
  }

  return static_cast<int>(len == 0);
}

//
// Conky update function for apcupsd data
//
int update_apcupsd() {
  int i;
  APCUPSD_S apc;
  int sock = -1;

  for (i = 0; i < _APCUPSD_COUNT; ++i) {
    memcpy(apc.items[i], "N/A", 4);  // including \0
  }

  do {
    struct addrinfo hints {};
    struct addrinfo *ai, *rp;
    int res;
    short sz = 0;
    char portbuf[8];
    //
    // connect to apcupsd daemon
    //
    memset(&hints, 0, sizeof(struct addrinfo));
    hints.ai_family = AF_UNSPEC;
    hints.ai_socktype = SOCK_STREAM;
    hints.ai_flags = 0;
    hints.ai_protocol = 0;
    snprintf(portbuf, 8, "%d", apcupsd.port);
    res = getaddrinfo(apcupsd.host, portbuf, &hints, &ai);
    if (res != 0) {
      NORM_ERR("APCUPSD getaddrinfo: %s", gai_strerror(res));
      break;
    }
    for (rp = ai; rp != nullptr; rp = rp->ai_next) {
      sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
      if (sock == -1) { continue; }
      if (connect(sock, rp->ai_addr, rp->ai_addrlen) != -1) { break; }
      close(sock);
      sock = -1;
    }
    freeaddrinfo(ai);
    if (rp == nullptr) {
      // no error reporting, the daemon is probably not running
      if (sock >= 0) { close(sock); }
      break;
    }

    //
    // send status request - "status" - 6B
    //
    sz = htons(6);
    // no waiting to become writeable is really needed
    if (send(sock, &sz, sizeof(sz), 0) != sizeof(sz) ||
        send(sock, "status", 6, 0) != 6) {
      perror("send");
      close(sock);
      break;
    }

    //
    // read the lines of output and put them into the info structure
    //
    fill_items(sock, &apc);
    close(sock);

  } while (0);

  //
  // "atomically" copy the data into working set
  //
  memcpy(apcupsd.items, apc.items, sizeof(apcupsd.items));
  return 0;
}

int apcupsd_scan_arg(const char *arg) {
  char host[64];
  int port;
  if (sscanf(arg, "%63s %d", host, &port) != 2) { return 1; }

  apcupsd.port = port;
  strncpy(apcupsd.host, host, sizeof(apcupsd.host));
  return 0;
}

double apcupsd_loadbarval(struct text_object *obj) {
  (void)obj;

  return atof(apcupsd.items[APCUPSD_LOAD]);
}

#define APCUPSD_PRINT_GENERATOR(name, idx)                       \
  void print_apcupsd_##name(struct text_object *obj, char *p,    \
                            unsigned int p_max_size) {           \
    (void)obj;                                                   \
    snprintf(p, p_max_size, "%s", apcupsd.items[APCUPSD_##idx]); \
  }

APCUPSD_PRINT_GENERATOR(name, NAME)
APCUPSD_PRINT_GENERATOR(model, MODEL)
APCUPSD_PRINT_GENERATOR(upsmode, UPSMODE)
APCUPSD_PRINT_GENERATOR(cable, CABLE)
APCUPSD_PRINT_GENERATOR(status, STATUS)
APCUPSD_PRINT_GENERATOR(linev, LINEV)
APCUPSD_PRINT_GENERATOR(load, LOAD)
APCUPSD_PRINT_GENERATOR(charge, CHARGE)
APCUPSD_PRINT_GENERATOR(timeleft, TIMELEFT)
APCUPSD_PRINT_GENERATOR(temp, TEMP)
APCUPSD_PRINT_GENERATOR(lastxfer, LASTXFER)

#undef APCUPSD_PRINT_GENERATOR