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 (char *buffer,
72 cmd_putval_t *ret_putval, cmd_error_handler_t *err)
77 char *plugin_instance;
82 char *identifier_copy;
85 value_list_t vl = VALUE_LIST_INIT;
89 status = parse_string (&buffer, &identifier);
92 cmd_error (CMD_PARSE_ERROR, err, "Cannot parse identifier.");
93 return (CMD_PARSE_ERROR);
95 assert (identifier != NULL);
97 /* parse_identifier() modifies its first argument,
98 * returning pointers into it */
99 identifier_copy = sstrdup (identifier);
101 status = parse_identifier (identifier_copy, &hostname,
102 &plugin, &plugin_instance,
103 &type, &type_instance);
106 DEBUG ("cmd_handle_putval: Cannot parse identifier `%s'.",
108 cmd_error (CMD_PARSE_ERROR, err, "Cannot parse identifier `%s'.",
110 sfree (identifier_copy);
111 return (CMD_PARSE_ERROR);
114 if ((strlen (hostname) >= sizeof (vl.host))
115 || (strlen (plugin) >= sizeof (vl.plugin))
116 || ((plugin_instance != NULL)
117 && (strlen (plugin_instance) >= sizeof (vl.plugin_instance)))
118 || ((type_instance != NULL)
119 && (strlen (type_instance) >= sizeof (vl.type_instance))))
121 cmd_error (CMD_PARSE_ERROR, err, "Identifier too long.");
122 sfree (identifier_copy);
123 return (CMD_PARSE_ERROR);
126 sstrncpy (vl.host, hostname, sizeof (vl.host));
127 sstrncpy (vl.plugin, plugin, sizeof (vl.plugin));
128 sstrncpy (vl.type, type, sizeof (vl.type));
129 if (plugin_instance != NULL)
130 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
131 if (type_instance != NULL)
132 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
134 ds = plugin_get_ds (type);
137 cmd_error (CMD_PARSE_ERROR, err, "1 Type `%s' isn't defined.", type);
138 sfree (identifier_copy);
139 return (CMD_PARSE_ERROR);
142 /* Free identifier_copy */
144 plugin = NULL; plugin_instance = NULL;
145 type = NULL; type_instance = NULL;
146 sfree (identifier_copy);
148 vl.values_len = ds->ds_num;
149 vl.values = malloc (vl.values_len * sizeof (*vl.values));
150 if (vl.values == NULL)
152 cmd_error (CMD_ERROR, err, "malloc failed.");
156 ret_putval->identifier = strdup (identifier);
157 if (ret_putval->identifier == NULL)
159 cmd_error (CMD_ERROR, err, "malloc failed.");
160 cmd_destroy_putval (ret_putval);
164 /* All the remaining fields are part of the optionlist. */
172 status = parse_option (&buffer, &string, &value);
175 /* parse_option failed, buffer has been modified.
176 * => we need to abort */
177 cmd_error (CMD_PARSE_ERROR, err, "Misformatted option.");
178 cmd_destroy_putval (ret_putval);
179 return (CMD_PARSE_ERROR);
181 else if (status == 0)
183 assert (string != NULL);
184 assert (value != NULL);
185 set_option (&vl, string, value);
188 /* else: parse_option but buffer has not been modified. This is
189 * the default if no `=' is found.. */
191 status = parse_string (&buffer, &string);
194 cmd_error (CMD_PARSE_ERROR, err, "Misformatted value.");
195 cmd_destroy_putval (ret_putval);
196 return (CMD_PARSE_ERROR);
198 assert (string != NULL);
200 status = parse_values (string, &vl, ds);
203 cmd_error (CMD_PARSE_ERROR, err, "Parsing the values string failed.");
204 cmd_destroy_putval (ret_putval);
205 return (CMD_PARSE_ERROR);
208 tmp = (value_list_t *) realloc (ret_putval->vl,
209 (ret_putval->vl_num + 1) * sizeof(*ret_putval->vl));
212 cmd_error (CMD_ERROR, err, "realloc failed.");
213 cmd_destroy_putval (ret_putval);
217 ret_putval->vl = tmp;
218 ret_putval->vl_num++;
219 memcpy (&ret_putval->vl[ret_putval->vl_num - 1], &vl, sizeof (vl));
220 } /* while (*buffer != 0) */
221 /* Done parsing the options. */
224 } /* cmd_status_t cmd_parse_putval */
226 void cmd_destroy_putval (cmd_putval_t *putval)
233 sfree (putval->identifier);
235 for (i = 0; i < putval->vl_num; ++i)
237 sfree (putval->vl[i].values);
238 meta_data_destroy (putval->vl[i].meta);
239 putval->vl[i].meta = NULL;
244 } /* void cmd_destroy_putval */
246 cmd_status_t cmd_handle_putval (FILE *fh, char *buffer)
248 cmd_error_handler_t err = { cmd_error_fh, fh };
254 DEBUG ("utils_cmd_putval: cmd_handle_putval (fh = %p, buffer = %s);",
255 (void *) fh, buffer);
257 if ((status = cmd_parse (buffer, &cmd, &err)) != CMD_OK)
259 if (cmd.type != CMD_PUTVAL)
261 cmd_error (CMD_UNKNOWN_COMMAND, &err, "Unexpected command: `%s'.",
262 CMD_TO_STRING (cmd.type));
264 return (CMD_UNKNOWN_COMMAND);
267 for (i = 0; i < cmd.cmd.putval.vl_num; ++i)
268 plugin_dispatch_values (&cmd.cmd.putval.vl[i]);
271 cmd_error (CMD_OK, &err, "Success: %i %s been dispatched.",
272 (int)cmd.cmd.putval.vl_num,
273 (cmd.cmd.putval.vl_num == 1) ? "value has" : "values have");
277 } /* int cmd_handle_putval */
279 int cmd_create_putval (char *ret, size_t ret_len, /* {{{ */
280 const data_set_t *ds, const value_list_t *vl)
282 char buffer_ident[6 * DATA_MAX_NAME_LEN];
283 char buffer_values[1024];
286 status = FORMAT_VL (buffer_ident, sizeof (buffer_ident), vl);
289 escape_string (buffer_ident, sizeof (buffer_ident));
291 status = format_values (buffer_values, sizeof (buffer_values),
292 ds, vl, /* store rates = */ 0);
295 escape_string (buffer_values, sizeof (buffer_values));
297 ssnprintf (ret, ret_len,
298 "PUTVAL %s interval=%.3f %s",
301 ? CDTIME_T_TO_DOUBLE (vl->interval)
302 : CDTIME_T_TO_DOUBLE (plugin_get_interval ()),
306 } /* }}} int cmd_create_putval */