2 * collectd - src/utils_cmds.c
3 * Copyright (C) 2008 Florian 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>
29 #include "utils_cmds.h"
30 #include "daemon/common.h"
31 #include "utils_cmd_flush.h"
32 #include "utils_cmd_getval.h"
33 #include "utils_cmd_listval.h"
34 #include "utils_cmd_putval.h"
35 #include "utils_parse_option.h"
40 static cmd_options_t default_options = {
41 /* identifier_default_host = */ NULL,
45 * private helper functions
48 static cmd_status_t cmd_split(char *buffer, size_t *ret_len, char ***ret_fields,
49 cmd_error_handler_t *err) {
51 bool in_field, in_quotes;
58 for (char *string = buffer; *string != '\0'; ++string) {
59 /* Make a quick worst-case estimate of the number of fields by
60 * counting spaces and ignoring quotation marks. */
61 if (!isspace((int)*string)) {
71 /* fields will be NULL-terminated */
72 fields = malloc((estimate + 1) * sizeof(*fields));
74 cmd_error(CMD_ERROR, err, "malloc failed.");
88 assert(len < estimate); \
89 fields[len] = field; \
98 for (char *string = buffer; *string != '\0'; string++) {
99 if (isspace((int)string[0])) {
107 } else if (string[0] == '"') {
108 /* Note: Two consecutive quoted fields not separated by space are
109 * treated as different fields. This is the collectd 5.x behavior
110 * around splitting fields. */
113 /* end of quoted field */
114 if (!in_field) /* empty quoted string */
122 /* if (! in_field): add new field on next iteration
123 * else: quoted string following an unquoted string (one field)
124 * in either case: skip quotation mark */
126 } else if ((string[0] == '\\') && in_quotes) {
127 /* Outside of quotes, a backslash is a regular character (mostly
128 * for backward compatibility). */
130 if (string[1] == '\0') {
132 cmd_error(CMD_PARSE_ERROR, err, "Backslash at end of string.");
133 return CMD_PARSE_ERROR;
136 /* un-escape the next character; skip backslash */
150 cmd_error(CMD_PARSE_ERROR, err, "Unterminated quoted string.");
151 return CMD_PARSE_ERROR;
160 if (ret_fields != NULL)
161 *ret_fields = fields;
165 } /* int cmd_split */
171 void cmd_error(cmd_status_t status, cmd_error_handler_t *err,
172 const char *format, ...) {
175 if ((err == NULL) || (err->cb == NULL))
178 va_start(ap, format);
179 err->cb(err->ud, status, format, ap);
181 } /* void cmd_error */
183 cmd_status_t cmd_parsev(size_t argc, char **argv, cmd_t *ret_cmd,
184 const cmd_options_t *opts, cmd_error_handler_t *err) {
185 char *command = NULL;
188 if ((argc < 1) || (argv == NULL) || (ret_cmd == NULL)) {
190 cmd_error(CMD_ERROR, err, "Missing command.");
195 opts = &default_options;
197 memset(ret_cmd, 0, sizeof(*ret_cmd));
199 if (strcasecmp("FLUSH", command) == 0) {
200 ret_cmd->type = CMD_FLUSH;
202 cmd_parse_flush(argc - 1, argv + 1, &ret_cmd->cmd.flush, opts, err);
203 } else if (strcasecmp("GETVAL", command) == 0) {
204 ret_cmd->type = CMD_GETVAL;
206 cmd_parse_getval(argc - 1, argv + 1, &ret_cmd->cmd.getval, opts, err);
207 } else if (strcasecmp("LISTVAL", command) == 0) {
208 ret_cmd->type = CMD_LISTVAL;
210 cmd_parse_listval(argc - 1, argv + 1, &ret_cmd->cmd.listval, opts, err);
211 } else if (strcasecmp("PUTVAL", command) == 0) {
212 ret_cmd->type = CMD_PUTVAL;
214 cmd_parse_putval(argc - 1, argv + 1, &ret_cmd->cmd.putval, opts, err);
216 ret_cmd->type = CMD_UNKNOWN;
217 cmd_error(CMD_UNKNOWN_COMMAND, err, "Unknown command `%s'.", command);
218 return CMD_UNKNOWN_COMMAND;
221 if (status != CMD_OK)
222 ret_cmd->type = CMD_UNKNOWN;
224 } /* cmd_status_t cmd_parsev */
226 cmd_status_t cmd_parse(char *buffer, cmd_t *ret_cmd, const cmd_options_t *opts,
227 cmd_error_handler_t *err) {
228 char **fields = NULL;
229 size_t fields_num = 0;
232 if ((status = cmd_split(buffer, &fields_num, &fields, err)) != CMD_OK)
235 status = cmd_parsev(fields_num, fields, ret_cmd, opts, err);
238 } /* cmd_status_t cmd_parse */
240 void cmd_destroy(cmd_t *cmd) {
249 cmd_destroy_flush(&cmd->cmd.flush);
252 cmd_destroy_getval(&cmd->cmd.getval);
255 cmd_destroy_listval(&cmd->cmd.listval);
258 cmd_destroy_putval(&cmd->cmd.putval);
261 } /* void cmd_destroy */
263 cmd_status_t cmd_parse_option(char *field, char **ret_key, char **ret_value,
264 cmd_error_handler_t *err) {
269 cmd_error(CMD_ERROR, err, "Invalid argument to cmd_parse_option.");
274 /* Look for the equal sign. */
275 while (isalnum((int)value[0]) || (value[0] == '_') || (value[0] == ':'))
277 if ((value[0] != '=') || (value == key)) {
278 /* Whether this is a fatal error is up to the caller. */
279 return CMD_NO_OPTION;
286 if (ret_value != NULL)
290 } /* cmd_status_t cmd_parse_option */
292 void cmd_error_fh(void *ud, cmd_status_t status, const char *format,
298 if (status == CMD_OK)
301 vsnprintf(buf, sizeof(buf), format, ap);
302 buf[sizeof(buf) - 1] = '\0';
303 if (fprintf(fh, "%i %s\n", code, buf) < 0) {
305 WARNING("utils_cmds: failed to write to file-handle #%i: %s", fileno(fh),
306 sstrerror(errno, errbuf, sizeof(errbuf)));
311 } /* void cmd_error_fh */