Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

snmp-ups: Add a generic function to convert date #1078

Merged
merged 3 commits into from
Sep 1, 2021
Merged

snmp-ups: Add a generic function to convert date #1078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27ed068
snmp-ups: Add a generic function to convert date
arnaudquette-eaton Aug 23, 2021
02b2f76
Merge branch 'master' into iso-dates-impl
jimklimov Aug 26, 2021
c5ed439
Merge branch 'master' into iso-dates-impl
aquette Sep 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion drivers/eaton-pdu-marlin-mib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,9 @@ static char marlin_scratch_buf[20];
* WRT the number of phase(s) and the outlet group number.
* Note that the group type (marlin_outlet_group_type_info) is
* not considered since this applies to any kind of group */
static const char *marlin_outlet_group_phase_fun(int outlet_group_nb)
static const char *marlin_outlet_group_phase_fun(void *raw_outlet_group_nb)
{
int outlet_group_nb = *((int *)raw_outlet_group_nb);
const char* str_phases_nb = dstate_getinfo("input.phases");
int phases_nb = 1;
if (str_phases_nb && (outlet_group_nb >= 0) ) {
Expand Down
6 changes: 3 additions & 3 deletions drivers/powerware-mib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Copyright (C)
* 2005-2006 Olli Savia <ops@iki.fi>
* 2005-2006 Niels Baggesen <niels@baggesen.net>
* 2015-2016 Arnaud Quette <ArnaudQuette@Eaton.com>
* 2015-2021 Eaton (author: Arnaud Quette <ArnaudQuette@Eaton.com>)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
Expand All @@ -25,7 +25,7 @@

#include "powerware-mib.h"

#define PW_MIB_VERSION "0.92"
#define PW_MIB_VERSION "0.93"

/* TODO: more sysOID and MIBs support:
*
Expand Down Expand Up @@ -254,7 +254,7 @@ static snmp_info_t pw_mib[] = {
0, NULL },
{ "battery.runtime.low", 0, 60.0, IETF_OID_CONF_RUNTIME_LOW, "",
0, NULL },
{ "battery.date", ST_FLAG_RW | ST_FLAG_STRING, SU_INFOSIZE, ".1.3.6.1.4.1.534.1.2.6.0", NULL, SU_FLAG_OK, NULL },
{ "battery.date", ST_FLAG_RW | ST_FLAG_STRING, SU_INFOSIZE, ".1.3.6.1.4.1.534.1.2.6.0", NULL, SU_FLAG_OK, &su_convert_to_iso_date_info[0] },

/* Output page */
{ "output.phases", 0, 1.0, PW_OID_OUT_LINES, "", 0, NULL },
Expand Down
64 changes: 57 additions & 7 deletions drivers/snmp-ups.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ static const char *mibname;
static const char *mibvers;

#define DRIVER_NAME "Generic SNMP UPS driver"
#define DRIVER_VERSION "1.15"
#define DRIVER_VERSION "1.16"

/* driver description structure */
upsdrv_info_t upsdrv_info = {
Expand Down Expand Up @@ -187,6 +187,36 @@ bool_t get_and_process_data(int mode, snmp_info_t *su_info_p);
int extract_template_number(int template_type, const char* varname);
int get_template_type(const char* varname);

/* common value post-processing functions */

static char su_scratch_buf[255];

/* Convert a US formated date (mm/dd/yyyy) to an ISO 8601 Calendar date (yyyy-mm-dd) */
const char *su_usdate_to_isodate_info_fun(void *raw_date)
{
const char *usdate = (char *)raw_date;
struct tm tm;
memset(&tm, 0, sizeof(struct tm));
memset(&su_scratch_buf, 0, sizeof(su_scratch_buf));

upsdebugx(3, "%s: US date = %s", __func__, usdate);

/* Try to convert from US date string to time */
/* Note strptime returns NULL upon failure, and a ptr to the last
null char of the string upon success. Just try blindly the conversion! */
strptime(usdate, "%m/%d/%Y", &tm);
if (strftime(su_scratch_buf, 254, "%F", &tm) != 0) {
upsdebugx(3, "%s: successfully reformated: %s", __func__, su_scratch_buf);
return su_scratch_buf;
}

return NULL;
}
info_lkp_t su_convert_to_iso_date_info[] = {
{ 1, "dummy", su_usdate_to_isodate_info_fun, NULL },
{ 0, NULL, NULL, NULL }
};

/* ---------------------------------------------
* driver functions implementations
* --------------------------------------------- */
Expand Down Expand Up @@ -840,7 +870,7 @@ static bool_t decode_str(struct snmp_pdu *pdu, char *buf, size_t buf_len, info_l
case ASN_GAUGE:
if(oid2info) {
const char *str;
if((str=su_find_infoval(oid2info, *pdu->variables->val.integer))) {
if((str=su_find_infoval(oid2info, pdu->variables->val.integer))) {
strncpy(buf, str, buf_len-1);
}
/* when oid2info returns NULL, don't publish the variable! */
Expand Down Expand Up @@ -1215,7 +1245,7 @@ void su_status_set(snmp_info_t *su_info_p, long value)

upsdebugx(2, "SNMP UPS driver: entering %s()", __func__);

if ((info_value = su_find_infoval(su_info_p->oid2info, value)) != NULL)
if ((info_value = su_find_infoval(su_info_p->oid2info, &value)) != NULL)
{
if (strcmp(info_value, "")) {
status_set(info_value);
Expand Down Expand Up @@ -1246,7 +1276,7 @@ void su_alarm_set(snmp_info_t *su_info_p, long value)

upsdebugx(2, "%s: using definition %s", __func__, info_type);

if ((info_value = su_find_infoval(su_info_p->oid2info, value)) != NULL
if ((info_value = su_find_infoval(su_info_p->oid2info, &value)) != NULL
&& info_value[0] != 0)
{
/* Special handling for outlet & outlet groups alarms */
Expand Down Expand Up @@ -1529,15 +1559,30 @@ long su_find_valinfo(info_lkp_t *oid2info, const char* value)
return -1;
}

/* String reformating function */
const char *su_find_strval(info_lkp_t *oid2info, void *value)
{
/* First test if we have a generic lookup function */
if ( (oid2info != NULL) && (oid2info->fun != NULL) ) {
upsdebugx(2, "%s: using generic lookup function (string reformating)", __func__);
const char * retvalue = oid2info->fun(value);
upsdebugx(2, "%s: got value '%s'", __func__, retvalue);
return retvalue;
}
upsdebugx(1, "%s: no result value for this OID string value (%s)", __func__, (char*)value);
return NULL;
}

/* find the INFO_* value matching that OID value */
const char *su_find_infoval(info_lkp_t *oid2info, long value)
const char *su_find_infoval(info_lkp_t *oid2info, void *raw_value)
{
info_lkp_t *info_lkp;
long value = *((long *)raw_value);

/* First test if we have a generic lookup function */
if ( (oid2info != NULL) && (oid2info->fun != NULL) ) {
upsdebugx(2, "%s: using generic lookup function", __func__);
const char * retvalue = oid2info->fun(value);
const char * retvalue = oid2info->fun(raw_value);
upsdebugx(2, "%s: got value '%s'", __func__, retvalue);
return retvalue;
}
Expand Down Expand Up @@ -2712,6 +2757,11 @@ bool_t su_ups_get(snmp_info_t *su_info_p)
snprintf(buf, sizeof(buf), "%.2f", tmp_dvalue);
}
}
/* Check if there is a string reformating function */
const char *fmt_buf = NULL;
if ((fmt_buf = su_find_strval(su_info_p->oid2info, buf)) != NULL) {
snprintf(buf, sizeof(buf), "%s", fmt_buf);
}
}
} else {
status = nut_snmp_get_int(su_info_p->OID, &value);
Expand All @@ -2727,7 +2777,7 @@ bool_t su_ups_get(snmp_info_t *su_info_p)
return FALSE;
}
/* Check if there is a value to be looked up */
if ((strValue = su_find_infoval(su_info_p->oid2info, value)) != NULL)
if ((strValue = su_find_infoval(su_info_p->oid2info, &value)) != NULL)
snprintf(buf, sizeof(buf), "%s", strValue);
else {
/* Check if there is a need to publish decimal too,
Expand Down
9 changes: 7 additions & 2 deletions drivers/snmp-ups.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ typedef int bool_t;
typedef struct {
int oid_value; /* SNMP OID value */
const char *info_value; /* NUT INFO_* value */
const char *(*fun)(int snmp_value); /* optional SNMP to NUT mapping function */
const char *(*fun)(void *snmp_value); /* optional SNMP to NUT mapping function */
int (*nuf)(const char *nut_value); /* optional NUT to SNMP mapping function */
} info_lkp_t;

Expand Down Expand Up @@ -271,8 +271,13 @@ bool_t su_ups_get(snmp_info_t *su_info_p);

bool_t load_mib2nut(const char *mib);

const char *su_find_infoval(info_lkp_t *oid2info, long value);
const char *su_find_infoval(info_lkp_t *oid2info, void *value);
long su_find_valinfo(info_lkp_t *oid2info, const char* value);
const char *su_find_strval(info_lkp_t *oid2info, void *value);

/* Common conversion structs (functions) */
const char *su_usdate_to_isodate_info_fun(void *raw_date);
extern info_lkp_t su_convert_to_iso_date_info[];

int su_setvar(const char *varname, const char *val);
int su_instcmd(const char *cmdname, const char *extradata);
Expand Down