2 * collectd - src/utils_cmd_putval.c
3 * Copyright (C) 2007-2009 Florian octo Forster
4 * Copyright (C) 2016 Sebastian tokkee Harl
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
25 * Florian octo Forster <octo at collectd.org>
26 * Sebastian tokkee Harl <sh at tokkee.org>
34 #include "utils_cmds.h"
35 #include "utils_cmd_putval.h"
36 #include "utils_parse_option.h"
37 #include "utils_cmd_putval.h"
40 * private helper functions
43 static int set_option (value_list_t *vl, const char *key, const char *value)
45 if ((vl == NULL) || (key == NULL) || (value == NULL))
48 if (strcasecmp ("interval", key) == 0)
55 tmp = strtod (value, &endptr);
57 if ((errno == 0) && (endptr != NULL)
58 && (endptr != value) && (tmp > 0.0))
59 vl->interval = DOUBLE_TO_CDTIME_T (tmp);
65 } /* int set_option */
71 cmd_status_t cmd_parse_putval (size_t argc, char **argv,
72 cmd_putval_t *ret_putval, const cmd_options_t *opts,
73 cmd_error_handler_t *err)
80 char *plugin_instance;
85 char *identifier_copy;
88 value_list_t vl = VALUE_LIST_INIT;
91 if ((ret_putval == NULL) || (opts == NULL))
94 cmd_error (CMD_ERROR, err, "Invalid arguments to cmd_parse_putval.");
100 cmd_error (CMD_PARSE_ERROR, err,
101 "Missing identifier and/or value-list.");
102 return (CMD_PARSE_ERROR);
105 identifier = argv[0];
107 /* parse_identifier() modifies its first argument, returning pointers into
108 * it; retain the old value for later. */
109 identifier_copy = sstrdup (identifier);
111 status = parse_identifier (identifier, &hostname,
112 &plugin, &plugin_instance,
113 &type, &type_instance,
114 opts->identifier_default_host);
117 DEBUG ("cmd_handle_putval: Cannot parse identifier `%s'.",
119 cmd_error (CMD_PARSE_ERROR, err, "Cannot parse identifier `%s'.",
121 sfree (identifier_copy);
122 return (CMD_PARSE_ERROR);
125 if ((strlen (hostname) >= sizeof (vl.host))
126 || (strlen (plugin) >= sizeof (vl.plugin))
127 || ((plugin_instance != NULL)
128 && (strlen (plugin_instance) >= sizeof (vl.plugin_instance)))
129 || ((type_instance != NULL)
130 && (strlen (type_instance) >= sizeof (vl.type_instance))))
132 cmd_error (CMD_PARSE_ERROR, err, "Identifier too long.");
133 sfree (identifier_copy);
134 return (CMD_PARSE_ERROR);
137 sstrncpy (vl.host, hostname, sizeof (vl.host));
138 sstrncpy (vl.plugin, plugin, sizeof (vl.plugin));
139 sstrncpy (vl.type, type, sizeof (vl.type));
140 if (plugin_instance != NULL)
141 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
142 if (type_instance != NULL)
143 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
145 ds = plugin_get_ds (type);
148 cmd_error (CMD_PARSE_ERROR, err, "1 Type `%s' isn't defined.", type);
149 sfree (identifier_copy);
150 return (CMD_PARSE_ERROR);
154 plugin = NULL; plugin_instance = NULL;
155 type = NULL; type_instance = NULL;
157 vl.values_len = ds->ds_num;
158 vl.values = malloc (vl.values_len * sizeof (*vl.values));
159 if (vl.values == NULL)
161 cmd_error (CMD_ERROR, err, "malloc failed.");
162 sfree (identifier_copy);
166 ret_putval->raw_identifier = identifier_copy;
167 if (ret_putval->raw_identifier == NULL)
169 cmd_error (CMD_ERROR, err, "malloc failed.");
170 cmd_destroy_putval (ret_putval);
175 /* All the remaining fields are part of the option list. */
177 for (i = 1; i < argc; ++i)
184 status = cmd_parse_option (argv[i], &key, &value, err);
185 if (status == CMD_OK)
187 assert (key != NULL);
188 assert (value != NULL);
189 set_option (&vl, key, value);
192 else if (status != CMD_NO_OPTION)
194 /* parse_option failed, buffer has been modified.
195 * => we need to abort */
199 /* else: cmd_parse_option did not find an option; treat this as a
202 status = parse_values (argv[i], &vl, ds);
205 cmd_error (CMD_PARSE_ERROR, err, "Parsing the values string failed.");
206 result = CMD_PARSE_ERROR;
210 tmp = (value_list_t *) realloc (ret_putval->vl,
211 (ret_putval->vl_num + 1) * sizeof(*ret_putval->vl));
214 cmd_error (CMD_ERROR, err, "realloc failed.");
215 cmd_destroy_putval (ret_putval);
220 ret_putval->vl = tmp;
221 ret_putval->vl_num++;
222 memcpy (&ret_putval->vl[ret_putval->vl_num - 1], &vl, sizeof (vl));
223 } /* while (*buffer != 0) */
224 /* Done parsing the options. */
226 if (result != CMD_OK)
228 if (ret_putval->vl_num == 0)
230 cmd_destroy_putval (ret_putval);
234 } /* cmd_status_t cmd_parse_putval */
236 void cmd_destroy_putval (cmd_putval_t *putval)
243 sfree (putval->raw_identifier);
245 for (i = 0; i < putval->vl_num; ++i)
247 if (i == 0) /* values is shared between all entries */
248 sfree (putval->vl[i].values);
249 meta_data_destroy (putval->vl[i].meta);
250 putval->vl[i].meta = NULL;
255 } /* void cmd_destroy_putval */
257 cmd_status_t cmd_handle_putval (FILE *fh, char *buffer)
259 cmd_error_handler_t err = { cmd_error_fh, fh };
265 DEBUG ("utils_cmd_putval: cmd_handle_putval (fh = %p, buffer = %s);",
266 (void *) fh, buffer);
268 if ((status = cmd_parse (buffer, &cmd, NULL, &err)) != CMD_OK)
270 if (cmd.type != CMD_PUTVAL)
272 cmd_error (CMD_UNKNOWN_COMMAND, &err, "Unexpected command: `%s'.",
273 CMD_TO_STRING (cmd.type));
275 return (CMD_UNKNOWN_COMMAND);
278 for (i = 0; i < cmd.cmd.putval.vl_num; ++i)
279 plugin_dispatch_values (&cmd.cmd.putval.vl[i]);
282 cmd_error (CMD_OK, &err, "Success: %i %s been dispatched.",
283 (int)cmd.cmd.putval.vl_num,
284 (cmd.cmd.putval.vl_num == 1) ? "value has" : "values have");
288 } /* int cmd_handle_putval */
290 int cmd_create_putval (char *ret, size_t ret_len, /* {{{ */
291 const data_set_t *ds, const value_list_t *vl)
293 char buffer_ident[6 * DATA_MAX_NAME_LEN];
294 char buffer_values[1024];
297 status = FORMAT_VL (buffer_ident, sizeof (buffer_ident), vl);
300 escape_string (buffer_ident, sizeof (buffer_ident));
302 status = format_values (buffer_values, sizeof (buffer_values),
303 ds, vl, /* store rates = */ 0);
306 escape_string (buffer_values, sizeof (buffer_values));
308 ssnprintf (ret, ret_len,
309 "PUTVAL %s interval=%.3f %s",
312 ? CDTIME_T_TO_DOUBLE (vl->interval)
313 : CDTIME_T_TO_DOUBLE (plugin_get_interval ()),
317 } /* }}} int cmd_create_putval */