2 * collection4 - graph.c
3 * Copyright (C) 2010 Florian octo Forster
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301 USA
21 * Florian octo Forster <ff at octo.it>
34 #include "graph_ident.h"
35 #include "graph_instance.h"
36 #include "graph_list.h"
37 #include "graph_def.h"
38 #include "graph_config.h"
40 #include "filesystem.h"
41 #include "utils_cgi.h"
44 #include <fcgi_stdio.h>
49 struct graph_config_s /* {{{ */
51 graph_ident_t *select;
59 graph_instance_t **instances;
61 }; /* }}} struct graph_config_s */
70 static graph_ident_t *graph_config_get_selector (const oconfig_item_t *ci) /* {{{ */
74 char *plugin_instance = NULL;
76 char *type_instance = NULL;
80 for (i = 0; i < ci->children_num; i++)
82 oconfig_item_t *child;
84 child = ci->children + i;
86 if (strcasecmp ("Host", child->key) == 0)
87 graph_config_get_string (child, &host);
88 else if (strcasecmp ("Plugin", child->key) == 0)
89 graph_config_get_string (child, &plugin);
90 else if (strcasecmp ("PluginInstance", child->key) == 0)
91 graph_config_get_string (child, &plugin_instance);
92 else if (strcasecmp ("Type", child->key) == 0)
93 graph_config_get_string (child, &type);
94 else if (strcasecmp ("TypeInstance", child->key) == 0)
95 graph_config_get_string (child, &type_instance);
96 /* else: ignore all other directives here. */
99 ret = ident_create (host, plugin, plugin_instance, type, type_instance);
103 free (plugin_instance);
105 free (type_instance);
108 } /* }}} int graph_config_get_selector */
113 graph_config_t *graph_create (const graph_ident_t *selector) /* {{{ */
117 cfg = malloc (sizeof (*cfg));
120 memset (cfg, 0, sizeof (*cfg));
122 if (selector != NULL)
123 cfg->select = ident_clone (selector);
128 cfg->vertical_label = NULL;
130 cfg->instances = NULL;
133 } /* }}} int graph_create */
135 void graph_destroy (graph_config_t *cfg) /* {{{ */
142 ident_destroy (cfg->select);
145 free (cfg->vertical_label);
147 def_destroy (cfg->defs);
149 for (i = 0; i < cfg->instances_num; i++)
150 inst_destroy (cfg->instances[i]);
151 free (cfg->instances);
152 } /* }}} void graph_destroy */
154 int graph_config_add (const oconfig_item_t *ci) /* {{{ */
156 graph_ident_t *select;
157 graph_config_t *cfg = NULL;
160 select = graph_config_get_selector (ci);
164 cfg = graph_create (/* selector = */ NULL);
168 cfg->select = select;
170 for (i = 0; i < ci->children_num; i++)
172 oconfig_item_t *child;
174 child = ci->children + i;
176 if (strcasecmp ("Title", child->key) == 0)
177 graph_config_get_string (child, &cfg->title);
178 else if (strcasecmp ("VerticalLabel", child->key) == 0)
179 graph_config_get_string (child, &cfg->vertical_label);
180 else if (strcasecmp ("ShowZero", child->key) == 0)
181 graph_config_get_bool (child, &cfg->show_zero);
182 else if (strcasecmp ("DEF", child->key) == 0)
183 def_config (cfg, child);
189 } /* }}} graph_config_add */
191 int graph_add_file (graph_config_t *cfg, const graph_ident_t *file) /* {{{ */
193 graph_instance_t *inst;
195 inst = graph_inst_find_matching (cfg, file);
198 graph_instance_t **tmp;
200 tmp = realloc (cfg->instances,
201 sizeof (*cfg->instances) * (cfg->instances_num + 1));
204 cfg->instances = tmp;
206 inst = inst_create (cfg, file);
210 cfg->instances[cfg->instances_num] = inst;
211 cfg->instances_num++;
214 return (inst_add_file (inst, file));
215 } /* }}} int graph_add_file */
217 int graph_get_title (graph_config_t *cfg, /* {{{ */
218 char *buffer, size_t buffer_size)
220 if ((cfg == NULL) || (buffer == NULL) || (buffer_size < 1))
223 if (cfg->title == NULL)
224 cfg->title = ident_to_string (cfg->select);
226 if (cfg->title == NULL)
229 strncpy (buffer, cfg->title, buffer_size);
230 buffer[buffer_size - 1] = 0;
233 } /* }}} int graph_get_title */
235 int graph_get_params (graph_config_t *cfg, /* {{{ */
236 char *buffer, size_t buffer_size)
240 #define COPY_FIELD(field) do { \
241 const char *str = ident_get_##field (cfg->select); \
242 char uri_str[1024]; \
243 uri_escape_copy (uri_str, str, sizeof (uri_str)); \
244 strlcat (buffer, #field, buffer_size); \
245 strlcat (buffer, "=", buffer_size); \
246 strlcat (buffer, uri_str, buffer_size); \
250 strlcat (buffer, ";", buffer_size);
252 strlcat (buffer, ";", buffer_size);
253 COPY_FIELD(plugin_instance);
254 strlcat (buffer, ";", buffer_size);
256 strlcat (buffer, ";", buffer_size);
257 COPY_FIELD(type_instance);
262 } /* }}} int graph_get_params */
264 graph_ident_t *graph_get_selector (graph_config_t *cfg) /* {{{ */
269 return (ident_clone (cfg->select));
270 } /* }}} graph_ident_t *graph_get_selector */
272 graph_def_t *graph_get_defs (graph_config_t *cfg) /* {{{ */
278 } /* }}} graph_def_t *graph_get_defs */
280 int graph_add_def (graph_config_t *cfg, graph_def_t *def) /* {{{ */
284 if ((cfg == NULL) || (def == NULL))
287 if (cfg->defs == NULL)
293 /* Insert in reverse order. This makes the order in the config file and the
294 * order of the DEFs in the graph more natural. Really. */
297 return (def_append (cfg->defs, tmp));
298 } /* }}} int graph_add_def */
300 _Bool graph_ident_matches (graph_config_t *cfg, const graph_ident_t *ident) /* {{{ */
303 if ((cfg == NULL) || (ident == NULL))
307 return (ident_matches (cfg->select, ident));
308 } /* }}} _Bool graph_ident_matches */
310 _Bool graph_matches_ident (graph_config_t *cfg, /* {{{ */
311 const graph_ident_t *selector)
314 if ((cfg == NULL) || (selector == NULL))
318 return (ident_matches (selector, cfg->select));
319 } /* }}} _Bool graph_matches_ident */
321 _Bool graph_ident_intersect (graph_config_t *cfg, /* {{{ */
322 const graph_ident_t *selector)
325 if ((cfg == NULL) || (selector == NULL))
329 return (ident_intersect (cfg->select, selector));
330 } /* }}} _Bool graph_ident_intersect */
332 _Bool graph_matches_field (graph_config_t *cfg, /* {{{ */
333 graph_ident_field_t field, const char *field_value)
335 const char *selector_value;
337 if ((cfg == NULL) || (field_value == NULL))
340 selector_value = ident_get_field (cfg->select, field);
341 if (selector_value == NULL)
344 if (IS_ALL (selector_value) || IS_ANY (selector_value))
346 else if (strcasecmp (selector_value, field_value) == 0)
350 } /* }}} _Bool graph_matches_field */
352 int graph_inst_foreach (graph_config_t *cfg, /* {{{ */
353 inst_callback_t cb, void *user_data)
358 for (i = 0; i < cfg->instances_num; i++)
360 status = (*cb) (cfg->instances[i], user_data);
366 } /* }}} int graph_inst_foreach */
368 graph_instance_t *graph_inst_find_exact (graph_config_t *cfg, /* {{{ */
369 graph_ident_t *ident)
373 if ((cfg == NULL) || (ident == NULL))
376 for (i = 0; i < cfg->instances_num; i++)
377 if (inst_compare_ident (cfg->instances[i], ident) == 0)
378 return (cfg->instances[i]);
381 } /* }}} graph_instance_t *graph_inst_find_exact */
383 graph_instance_t *graph_inst_find_matching (graph_config_t *cfg, /* {{{ */
384 const graph_ident_t *ident)
388 if ((cfg == NULL) || (ident == NULL))
391 for (i = 0; i < cfg->instances_num; i++)
392 if (inst_ident_matches (cfg->instances[i], ident))
393 return (cfg->instances[i]);
396 } /* }}} graph_instance_t *graph_inst_find_matching */
398 int graph_inst_find_all_matching (graph_config_t *cfg, /* {{{ */
399 const graph_ident_t *ident,
400 graph_inst_callback_t callback, void *user_data)
404 if ((cfg == NULL) || (ident == NULL) || (callback == NULL))
407 for (i = 0; i < cfg->instances_num; i++)
411 if (!inst_matches_ident (cfg->instances[i], ident))
414 status = (*callback) (cfg, cfg->instances[i], user_data);
420 } /* }}} int graph_inst_find_all_matching */
422 /* Lightweight variant of the "graph_search_inst" which is used if the
423 * search_info_t doesn't select any field values explicitely. */
424 static int graph_search_inst_noselector (graph_config_t *cfg, /* {{{ */
425 search_info_t *si, graph_inst_callback_t cb, void *user_data)
431 /* parameters have already been checked in "graph_search_inst" */
433 status = graph_get_title (cfg, title, sizeof (title));
436 fprintf (stderr, "graph_search_inst_noselector: "
437 "graph_get_title failed\n");
442 for (i = 0; i < cfg->instances_num; i++)
444 if (search_graph_inst_matches (si, cfg, cfg->instances[i], title))
446 status = (*cb) (cfg, cfg->instances[i], user_data);
450 } /* for (cfg->instances_num) */
453 } /* }}} int graph_search_inst_noselector */
455 /* When this function is called from graph_list, it will already have checked
456 * that the selector of the graph does not contradict the field selections contained in
457 * the search_info_t. We still have to check if the instance contradicts the
458 * search parameters, though, since the "ANY" wildcard is filled in now -
459 * possibly with contradicting values. */
460 int graph_search_inst (graph_config_t *cfg, search_info_t *si, /* {{{ */
461 graph_inst_callback_t cb,
467 graph_ident_t *search_selector;
469 if ((cfg == NULL) || (si == NULL) || (cb == NULL))
472 if (!search_has_selector (si))
473 return (graph_search_inst_noselector (cfg, si, cb, user_data));
475 search_selector = search_to_ident (si);
476 if (search_selector == NULL)
479 status = graph_get_title (cfg, title, sizeof (title));
482 ident_destroy (search_selector);
483 fprintf (stderr, "graph_search_inst: graph_get_title failed\n");
488 for (i = 0; i < cfg->instances_num; i++)
490 graph_ident_t *inst_selector;
492 inst_selector = inst_get_selector (cfg->instances[i]);
493 if (inst_selector == NULL)
496 /* If the two selectors contradict one another, there is no point in
497 * calling the (more costly) "search_graph_inst_matches" function. */
498 if (!ident_intersect (search_selector, inst_selector))
500 ident_destroy (inst_selector);
504 if (search_graph_inst_matches (si, cfg, cfg->instances[i], title))
506 status = (*cb) (cfg, cfg->instances[i], user_data);
509 ident_destroy (search_selector);
510 ident_destroy (inst_selector);
515 ident_destroy (inst_selector);
516 } /* for (cfg->instances_num) */
518 ident_destroy (search_selector);
520 } /* }}} int graph_search_inst */
522 int graph_search_inst_string (graph_config_t *cfg, const char *term, /* {{{ */
523 graph_inst_callback_t cb,
530 status = graph_get_title (cfg, buffer, sizeof (buffer));
533 fprintf (stderr, "graph_search_inst_string: graph_get_title failed\n");
539 if (strstr (buffer, term) != NULL)
541 for (i = 0; i < cfg->instances_num; i++)
543 status = (*cb) (cfg, cfg->instances[i], user_data);
550 for (i = 0; i < cfg->instances_num; i++)
552 if (inst_matches_string (cfg, cfg->instances[i], term))
554 status = (*cb) (cfg, cfg->instances[i], user_data);
562 } /* }}} int graph_search_inst_string */
564 int graph_inst_search_field (graph_config_t *cfg, /* {{{ */
565 graph_ident_field_t field, const char *field_value,
566 graph_inst_callback_t callback, void *user_data)
569 const char *selector_field;
570 _Bool need_check_instances = 0;
572 if ((cfg == NULL) || (field_value == NULL) || (callback == NULL))
575 if (!graph_matches_field (cfg, field, field_value))
578 selector_field = ident_get_field (cfg->select, field);
579 if (selector_field == NULL)
582 if (IS_ALL (selector_field) || IS_ANY (selector_field))
583 need_check_instances = 1;
585 for (i = 0; i < cfg->instances_num; i++)
589 if (need_check_instances
590 && !inst_matches_field (cfg->instances[i], field, field_value))
593 status = (*callback) (cfg, cfg->instances[i], user_data);
599 } /* }}} int graph_inst_search_field */
601 int graph_compare (graph_config_t *cfg, const graph_ident_t *ident) /* {{{ */
603 if ((cfg == NULL) || (ident == NULL))
606 return (ident_compare (cfg->select, ident));
607 } /* }}} int graph_compare */
609 size_t graph_num_instances (graph_config_t *cfg) /* {{{ */
612 return ((size_t) -1);
614 return (cfg->instances_num);
615 } /* }}} size_t graph_num_instances */
617 int graph_to_json (const graph_config_t *cfg,
622 if ((cfg == NULL) || (handler == NULL))
625 yajl_gen_map_open (handler);
626 yajl_gen_string (handler,
627 (unsigned char *) "select",
628 (unsigned int) strlen ("select"));
629 ident_to_json (cfg->select, handler);
630 yajl_gen_string (handler,
631 (unsigned char *) "instances",
632 (unsigned int) strlen ("instances"));
633 yajl_gen_array_open (handler);
634 for (i = 0; i < cfg->instances_num; i++)
635 inst_to_json (cfg->instances[i], handler);
636 yajl_gen_array_close (handler);
637 yajl_gen_map_close (handler);
642 static int graph_sort_instances_cb (const void *v0, const void *v1) /* {{{ */
644 return (inst_compare (*(graph_instance_t * const *) v0,
645 *(graph_instance_t * const *) v1));
646 } /* }}} int graph_sort_instances_cb */
648 int graph_sort_instances (graph_config_t *cfg) /* {{{ */
653 if (cfg->instances_num < 2)
656 qsort (cfg->instances, cfg->instances_num, sizeof (*cfg->instances),
657 graph_sort_instances_cb);
660 } /* }}} int graph_sort_instances */
662 int graph_clear_instances (graph_config_t *cfg) /* {{{ */
669 for (i = 0; i < cfg->instances_num; i++)
670 inst_destroy (cfg->instances[i]);
671 free (cfg->instances);
672 cfg->instances = NULL;
673 cfg->instances_num = 0;
676 } /* }}} int graph_clear_instances */
678 int graph_get_rrdargs (graph_config_t *cfg, graph_instance_t *inst, /* {{{ */
681 if ((cfg == NULL) || (inst == NULL) || (args == NULL))
684 if (cfg->title != NULL)
686 array_append (args->options, "-t");
687 array_append (args->options, cfg->title);
690 if (cfg->vertical_label != NULL)
692 array_append (args->options, "-v");
693 array_append (args->options, cfg->vertical_label);
698 array_append (args->options, "-l");
699 array_append (args->options, "0");
703 } /* }}} int graph_get_rrdargs */
705 /* vim: set sw=2 sts=2 et fdm=marker : */