1d1e94b521cc9fdd02a19e58e828ba2c182d3795
[collectd.git] / src / nut.c
1 /**
2  * collectd - src/nut.c
3  * Copyright (C) 2007       Florian octo Forster
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  *   Florian octo Forster <octo at collectd.org>
25  *   Pavel Rochnyak <pavel2000 ngs.ru>
26  **/
27
28 #include "collectd.h"
29
30 #include "common.h"
31 #include "plugin.h"
32
33 #include <upsclient.h>
34
35 #if HAVE_UPSCONN_T
36 typedef UPSCONN_t collectd_upsconn_t;
37 #elif HAVE_UPSCONN
38 typedef UPSCONN collectd_upsconn_t;
39 #else
40 #error "Unable to determine the UPS connection type."
41 #endif
42
43 struct nut_ups_s;
44 typedef struct nut_ups_s nut_ups_t;
45 struct nut_ups_s {
46   collectd_upsconn_t *conn;
47   char *upsname;
48   char *hostname;
49   int port;
50   nut_ups_t *next;
51 };
52
53 static const char *config_keys[] = {"UPS", "FORCESSL", "VERIFYPEER", "CAPATH",
54                                     "CONNECTTIMEOUT"};
55 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
56 static int force_ssl;   // Initialized to default of 0 (false)
57 static int verify_peer; // Initialized to default of 0 (false)
58 static int ssl_flags = UPSCLI_CONN_TRYSSL;
59 static int connect_timeout = -1;
60 static char *ca_path;
61
62 static int nut_read(user_data_t *user_data);
63
64 static void free_nut_ups_t(void *arg) {
65   nut_ups_t *ups = arg;
66
67   if (ups->conn != NULL) {
68     upscli_disconnect(ups->conn);
69     sfree(ups->conn);
70   }
71   sfree(ups->hostname);
72   sfree(ups->upsname);
73   sfree(ups);
74 } /* void free_nut_ups_t */
75
76 static int nut_add_ups(const char *name) {
77   nut_ups_t *ups;
78   int status;
79   char *cb_name;
80
81   DEBUG("nut plugin: nut_add_ups (name = %s);", name);
82
83   ups = calloc(1, sizeof(*ups));
84   if (ups == NULL) {
85     ERROR("nut plugin: nut_add_ups: calloc failed.");
86     return 1;
87   }
88
89   status = upscli_splitname(name, &ups->upsname, &ups->hostname, &ups->port);
90   if (status != 0) {
91     ERROR("nut plugin: nut_add_ups: upscli_splitname (%s) failed.", name);
92     free_nut_ups_t(ups);
93     return 1;
94   }
95
96   cb_name = ssnprintf_alloc("nut/%s", name);
97
98   status = plugin_register_complex_read(
99       /* group     = */ "nut",
100       /* name      = */ cb_name,
101       /* callback  = */ nut_read,
102       /* interval  = */ 0,
103       /* user_data = */ &(user_data_t){
104           .data = ups, .free_func = free_nut_ups_t,
105       });
106
107   sfree(cb_name);
108
109   if (status == EINVAL) {
110     WARNING("nut plugin: UPS \"%s\" already added. "
111             "Please check your configuration.",
112             name);
113     return -1;
114   }
115
116   return 0;
117 } /* int nut_add_ups */
118
119 static int nut_force_ssl(const char *value) {
120   if (strcasecmp(value, "true") == 0)
121     force_ssl = 1;
122   else if (strcasecmp(value, "false") == 0)
123     force_ssl = 0; // Should already be set to 0 from initialization
124   else {
125     force_ssl = 0;
126     WARNING("nut plugin: nut_force_ssl: invalid FORCESSL value "
127             "found. Defaulting to false.");
128   }
129   return 0;
130 } /* int nut_parse_force_ssl */
131
132 static int nut_verify_peer(const char *value) {
133   if (strcasecmp(value, "true") == 0)
134     verify_peer = 1;
135   else if (strcasecmp(value, "false") == 0)
136     verify_peer = 0; // Should already be set to 0 from initialization
137   else {
138     verify_peer = 0;
139     WARNING("nut plugin: nut_verify_peer: invalid VERIFYPEER value "
140             "found. Defaulting to false.");
141   }
142   return 0;
143 } /* int nut_verify_peer */
144
145 static int nut_ca_path(const char *value) {
146   if (value != NULL && strcmp(value, "") != 0) {
147     ca_path = malloc(strlen(value) + 1);
148     strncpy(ca_path, value, (strlen(value) + 1));
149   } else {
150     ca_path = NULL; // Should alread be set to NULL from initialization
151   }
152   return 0;
153 } /* int nut_ca_path */
154
155 static int nut_set_connect_timeout(const char *value) {
156 #if HAVE_UPSCLI_TRYCONNECT
157   long ret;
158
159   errno = 0;
160   ret = strtol(value, /* endptr = */ NULL, /* base = */ 10);
161   if (errno == 0)
162     connect_timeout = ret;
163   else
164     WARNING("nut plugin: The ConnectTimeout option requires numeric argument. "
165             "Setting ignored.");
166 #else /* #if HAVE_UPSCLI_TRYCONNECT */
167   WARNING("nut plugin: Dependency libupsclient version insufficient (<2.6.2) "
168           "for ConnectTimeout option support. Setting ignored.");
169 #endif
170   return 0;
171 } /* int nut_set_connect_timeout */
172
173 static int nut_config(const char *key, const char *value) {
174   if (strcasecmp(key, "UPS") == 0)
175     return nut_add_ups(value);
176   else if (strcasecmp(key, "FORCESSL") == 0)
177     return nut_force_ssl(value);
178   else if (strcasecmp(key, "VERIFYPEER") == 0)
179     return nut_verify_peer(value);
180   else if (strcasecmp(key, "CAPATH") == 0)
181     return nut_ca_path(value);
182   else if (strcasecmp(key, "CONNECTTIMEOUT") == 0)
183     return nut_set_connect_timeout(value);
184   else
185     return -1;
186 } /* int nut_config */
187
188 static void nut_submit(nut_ups_t *ups, const char *type,
189                        const char *type_instance, gauge_t value) {
190   value_list_t vl = VALUE_LIST_INIT;
191
192   vl.values = &(value_t){.gauge = value};
193   vl.values_len = 1;
194   if (strcasecmp(ups->hostname, "localhost") != 0)
195     sstrncpy(vl.host, ups->hostname, sizeof(vl.host));
196   sstrncpy(vl.plugin, "nut", sizeof(vl.plugin));
197   sstrncpy(vl.plugin_instance, ups->upsname, sizeof(vl.plugin_instance));
198   sstrncpy(vl.type, type, sizeof(vl.type));
199   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
200
201   plugin_dispatch_values(&vl);
202 } /* void nut_submit */
203
204 static int nut_connect(nut_ups_t *ups) {
205   int status, ssl_status;
206
207 #if HAVE_UPSCLI_TRYCONNECT
208   struct timeval tv;
209   tv.tv_sec = connect_timeout / 1000;
210   tv.tv_usec = connect_timeout % 1000;
211
212   status =
213       upscli_tryconnect(ups->conn, ups->hostname, ups->port, ssl_flags, &tv);
214 #else /* #if HAVE_UPSCLI_TRYCONNECT */
215   status = upscli_connect(ups->conn, ups->hostname, ups->port, ssl_flags);
216 #endif
217
218   if (status != 0) {
219     ERROR("nut plugin: nut_connect: upscli_connect (%s, %i) failed: %s",
220           ups->hostname, ups->port, upscli_strerror(ups->conn));
221     sfree(ups->conn);
222     return -1;
223   } /* if (status != 0) */
224
225   INFO("nut plugin: Connection to (%s, %i) established.", ups->hostname,
226        ups->port);
227
228   // Output INFO or WARNING based on SSL and VERIFICATION
229   ssl_status = upscli_ssl(ups->conn); // 1 for SSL, 0 for not, -1 for error
230   if (ssl_status == 1 && verify_peer == 1) {
231     INFO("nut plugin: Connection is secured with SSL and certificate "
232          "has been verified.");
233   } else if (ssl_status == 1) {
234     INFO("nut plugin: Connection is secured with SSL with no verification "
235          "of server SSL certificate.");
236   } else if (ssl_status == 0) {
237     WARNING("nut plugin: Connection is unsecured (no SSL).");
238   } else {
239     ERROR("nut plugin: nut_connect: upscli_ssl failed: %s",
240           upscli_strerror(ups->conn));
241     sfree(ups->conn);
242     return -1;
243   } /* if (ssl_status == 1 && verify_peer == 1) */
244   return 0;
245 }
246
247 static int nut_read(user_data_t *user_data) {
248   nut_ups_t *ups = user_data->data;
249   const char *query[3] = {"VAR", ups->upsname, NULL};
250   unsigned int query_num = 2;
251   char **answer;
252   unsigned int answer_num;
253   int status;
254
255   /* (Re-)Connect if we have no connection */
256   if (ups->conn == NULL) {
257     ups->conn = malloc(sizeof(*ups->conn));
258     if (ups->conn == NULL) {
259       ERROR("nut plugin: malloc failed.");
260       return -1;
261     }
262
263     status = nut_connect(ups);
264     if (status == -1)
265       return -1;
266
267   } /* if (ups->conn == NULL) */
268
269   /* nut plugin: nut_read_one: upscli_list_start (adpos) failed: Protocol
270    * error */
271   status = upscli_list_start(ups->conn, query_num, query);
272   if (status != 0) {
273     ERROR("nut plugin: nut_read: upscli_list_start (%s) failed: %s",
274           ups->upsname, upscli_strerror(ups->conn));
275     upscli_disconnect(ups->conn);
276     sfree(ups->conn);
277     return -1;
278   }
279
280   while ((status = upscli_list_next(ups->conn, query_num, query, &answer_num,
281                                     &answer)) == 1) {
282     char *key;
283     double value;
284
285     if (answer_num < 4)
286       continue;
287
288     key = answer[2];
289     value = atof(answer[3]);
290
291     if (strncmp("ambient.", key, 8) == 0) {
292       if (strcmp("ambient.humidity", key) == 0)
293         nut_submit(ups, "humidity", "ambient", value);
294       else if (strcmp("ambient.temperature", key) == 0)
295         nut_submit(ups, "temperature", "ambient", value);
296     } else if (strncmp("battery.", key, 8) == 0) {
297       if (strcmp("battery.charge", key) == 0)
298         nut_submit(ups, "percent", "charge", value);
299       else if (strcmp("battery.current", key) == 0)
300         nut_submit(ups, "current", "battery", value);
301       else if (strcmp("battery.runtime", key) == 0)
302         nut_submit(ups, "timeleft", "battery", value);
303       else if (strcmp("battery.temperature", key) == 0)
304         nut_submit(ups, "temperature", "battery", value);
305       else if (strcmp("battery.voltage", key) == 0)
306         nut_submit(ups, "voltage", "battery", value);
307     } else if (strncmp("input.", key, 6) == 0) {
308       if (strcmp("input.frequency", key) == 0)
309         nut_submit(ups, "frequency", "input", value);
310       else if (strcmp("input.voltage", key) == 0)
311         nut_submit(ups, "voltage", "input", value);
312     } else if (strncmp("output.", key, 7) == 0) {
313       if (strcmp("output.current", key) == 0)
314         nut_submit(ups, "current", "output", value);
315       else if (strcmp("output.frequency", key) == 0)
316         nut_submit(ups, "frequency", "output", value);
317       else if (strcmp("output.voltage", key) == 0)
318         nut_submit(ups, "voltage", "output", value);
319     } else if (strncmp("ups.", key, 4) == 0) {
320       if (strcmp("ups.load", key) == 0)
321         nut_submit(ups, "percent", "load", value);
322       else if (strcmp("ups.power", key) == 0)
323         nut_submit(ups, "power", "ups", value);
324       else if (strcmp("ups.temperature", key) == 0)
325         nut_submit(ups, "temperature", "ups", value);
326     }
327   } /* while (upscli_list_next) */
328
329   return 0;
330 } /* int nut_read */
331
332 static int nut_init(void) {
333 #if HAVE_UPSCLI_INIT
334   if (verify_peer == 1 && force_ssl == 0) {
335     WARNING("nut plugin: nut_connect: VerifyPeer true but ForceSSL "
336             "false. Setting ForceSSL to true.");
337     force_ssl = 1;
338   }
339
340   if (verify_peer == 1 && ca_path == NULL) {
341     ERROR("nut plugin: nut_connect: VerifyPeer true but missing "
342           "CAPath value.");
343     plugin_unregister_read_group("nut");
344     return -1;
345   }
346
347   if (verify_peer == 1 || force_ssl == 1) {
348     int status = upscli_init(verify_peer, ca_path, NULL, NULL);
349
350     if (status != 1) {
351       ERROR("nut plugin: upscli_init (%i, %s) failed", verify_peer, ca_path);
352       upscli_cleanup();
353       plugin_unregister_read_group("nut");
354       return -1;
355     }
356   } /* if (verify_peer == 1) */
357
358   if (verify_peer == 1)
359     ssl_flags = (UPSCLI_CONN_REQSSL | UPSCLI_CONN_CERTVERIF);
360   else if (force_ssl == 1)
361     ssl_flags = UPSCLI_CONN_REQSSL;
362
363 #else /* #if HAVE_UPSCLI_INIT */
364   if (verify_peer == 1 || ca_path != NULL) {
365     WARNING("nut plugin: nut_connect: Dependency libupsclient version "
366             "insufficient (<2.7) for VerifyPeer support. Ignoring VerifyPeer "
367             "and CAPath.");
368     verify_peer = 0;
369   }
370
371   if (force_ssl == 1)
372     ssl_flags = UPSCLI_CONN_REQSSL;
373 #endif
374
375   if (connect_timeout <= 0)
376     connect_timeout = (long)CDTIME_T_TO_MS(plugin_get_interval());
377
378   return 0;
379 } /* int nut_init */
380
381 static int nut_shutdown(void) {
382 #if HAVE_UPSCLI_INIT
383   upscli_cleanup();
384 #endif
385
386   return 0;
387 } /* int nut_shutdown */
388
389 void module_register(void) {
390   plugin_register_config("nut", nut_config, config_keys, config_keys_num);
391   plugin_register_init("nut", nut_init);
392   plugin_register_shutdown("nut", nut_shutdown);
393 } /* void module_register */