1 /**
2 * collection4 - graph.c
3 * Copyright (C) 2010 Florian octo Forster
4 *
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.
9 *
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.
14 *
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
19 *
20 * Authors:
21 * Florian octo Forster <ff at octo.it>
22 **/
24 #include <stdlib.h>
25 #include <stdio.h>
26 #include <stdint.h>
27 #include <inttypes.h>
28 #include <string.h>
29 #include <time.h>
30 #include <errno.h>
31 #include <assert.h>
33 #include "graph.h"
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"
39 #include "common.h"
40 #include "filesystem.h"
41 #include "utils_cgi.h"
43 #include <fcgiapp.h>
44 #include <fcgi_stdio.h>
46 /*
47 * Data types
48 */
49 struct graph_config_s /* {{{ */
50 {
51 graph_ident_t *select;
53 char *title;
54 char *vertical_label;
55 _Bool show_zero;
57 graph_def_t *defs;
59 graph_instance_t **instances;
60 size_t instances_num;
61 }; /* }}} struct graph_config_s */
63 /*
64 * Private functions
65 */
67 /*
68 * Config functions
69 */
70 static graph_ident_t *graph_config_get_selector (const oconfig_item_t *ci) /* {{{ */
71 {
72 char *host = NULL;
73 char *plugin = NULL;
74 char *plugin_instance = NULL;
75 char *type = NULL;
76 char *type_instance = NULL;
77 graph_ident_t *ret;
78 int i;
80 for (i = 0; i < ci->children_num; i++)
81 {
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. */
97 } /* for */
99 ret = ident_create (host, plugin, plugin_instance, type, type_instance);
101 free (host);
102 free (plugin);
103 free (plugin_instance);
104 free (type);
105 free (type_instance);
107 return (ret);
108 } /* }}} int graph_config_get_selector */
110 /*
111 * Global functions
112 */
113 graph_config_t *graph_create (const graph_ident_t *selector) /* {{{ */
114 {
115 graph_config_t *cfg;
117 cfg = malloc (sizeof (*cfg));
118 if (cfg == NULL)
119 return (NULL);
120 memset (cfg, 0, sizeof (*cfg));
122 if (selector != NULL)
123 cfg->select = ident_clone (selector);
124 else
125 cfg->select = NULL;
127 cfg->title = NULL;
128 cfg->vertical_label = NULL;
129 cfg->defs = NULL;
130 cfg->instances = NULL;
132 return (cfg);
133 } /* }}} int graph_create */
135 void graph_destroy (graph_config_t *cfg) /* {{{ */
136 {
137 size_t i;
139 if (cfg == NULL)
140 return;
142 ident_destroy (cfg->select);
144 free (cfg->title);
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) /* {{{ */
155 {
156 graph_ident_t *select;
157 graph_config_t *cfg = NULL;
158 int i;
160 select = graph_config_get_selector (ci);
161 if (select == NULL)
162 return (EINVAL);
164 cfg = graph_create (/* selector = */ NULL);
165 if (cfg == NULL)
166 return (ENOMEM);
168 cfg->select = select;
170 for (i = 0; i < ci->children_num; i++)
171 {
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);
184 } /* for */
186 gl_add_graph (cfg);
188 return (0);
189 } /* }}} graph_config_add */
191 int graph_add_file (graph_config_t *cfg, const graph_ident_t *file) /* {{{ */
192 {
193 graph_instance_t *inst;
195 inst = graph_inst_find_matching (cfg, file);
196 if (inst == NULL)
197 {
198 graph_instance_t **tmp;
200 tmp = realloc (cfg->instances,
201 sizeof (*cfg->instances) * (cfg->instances_num + 1));
202 if (tmp == NULL)
203 return (ENOMEM);
204 cfg->instances = tmp;
206 inst = inst_create (cfg, file);
207 if (inst == NULL)
208 return (ENOMEM);
210 cfg->instances[cfg->instances_num] = inst;
211 cfg->instances_num++;
212 }
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)
219 {
220 if ((cfg == NULL) || (buffer == NULL) || (buffer_size < 1))
221 return (EINVAL);
223 if (cfg->title == NULL)
224 cfg->title = ident_to_string (cfg->select);
226 if (cfg->title == NULL)
227 return (ENOMEM);
229 strncpy (buffer, cfg->title, buffer_size);
230 buffer[buffer_size - 1] = 0;
232 return (0);
233 } /* }}} int graph_get_title */
235 int graph_get_params (graph_config_t *cfg, /* {{{ */
236 char *buffer, size_t buffer_size)
237 {
238 buffer[0] = 0;
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); \
247 } while (0)
249 COPY_FIELD(host);
250 strlcat (buffer, ";", buffer_size);
251 COPY_FIELD(plugin);
252 strlcat (buffer, ";", buffer_size);
253 COPY_FIELD(plugin_instance);
254 strlcat (buffer, ";", buffer_size);
255 COPY_FIELD(type);
256 strlcat (buffer, ";", buffer_size);
257 COPY_FIELD(type_instance);
259 #undef COPY_FIELD
261 return (0);
262 } /* }}} int graph_get_params */
264 graph_ident_t *graph_get_selector (graph_config_t *cfg) /* {{{ */
265 {
266 if (cfg == NULL)
267 return (NULL);
269 return (ident_clone (cfg->select));
270 } /* }}} graph_ident_t *graph_get_selector */
272 graph_def_t *graph_get_defs (graph_config_t *cfg) /* {{{ */
273 {
274 if (cfg == NULL)
275 return (NULL);
277 return (cfg->defs);
278 } /* }}} graph_def_t *graph_get_defs */
280 int graph_add_def (graph_config_t *cfg, graph_def_t *def) /* {{{ */
281 {
282 graph_def_t *tmp;
284 if ((cfg == NULL) || (def == NULL))
285 return (EINVAL);
287 if (cfg->defs == NULL)
288 {
289 cfg->defs = def;
290 return (0);
291 }
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. */
295 tmp = cfg->defs;
296 cfg->defs = def;
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) /* {{{ */
301 {
302 #if C4_DEBUG
303 if ((cfg == NULL) || (ident == NULL))
304 return (0);
305 #endif
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)
312 {
313 #if C4_DEBUG
314 if ((cfg == NULL) || (selector == NULL))
315 return (0);
316 #endif
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)
323 {
324 #if C4_DEBUG
325 if ((cfg == NULL) || (selector == NULL))
326 return (0);
327 #endif
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)
334 {
335 const char *selector_value;
337 if ((cfg == NULL) || (field_value == NULL))
338 return (0);
340 selector_value = ident_get_field (cfg->select, field);
341 if (selector_value == NULL)
342 return (0);
344 if (IS_ALL (selector_value) || IS_ANY (selector_value))
345 return (1);
346 else if (strcasecmp (selector_value, field_value) == 0)
347 return (1);
349 return (0);
350 } /* }}} _Bool graph_matches_field */
352 int graph_inst_foreach (graph_config_t *cfg, /* {{{ */
353 inst_callback_t cb, void *user_data)
354 {
355 size_t i;
356 int status;
358 for (i = 0; i < cfg->instances_num; i++)
359 {
360 status = (*cb) (cfg->instances[i], user_data);
361 if (status != 0)
362 return (status);
363 }
365 return (0);
366 } /* }}} int graph_inst_foreach */
368 graph_instance_t *graph_inst_find_exact (graph_config_t *cfg, /* {{{ */
369 graph_ident_t *ident)
370 {
371 size_t i;
373 if ((cfg == NULL) || (ident == NULL))
374 return (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]);
380 return (NULL);
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)
385 {
386 size_t i;
388 if ((cfg == NULL) || (ident == NULL))
389 return (NULL);
391 for (i = 0; i < cfg->instances_num; i++)
392 if (inst_ident_matches (cfg->instances[i], ident))
393 return (cfg->instances[i]);
395 return (NULL);
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)
401 {
402 size_t i;
404 if ((cfg == NULL) || (ident == NULL) || (callback == NULL))
405 return (EINVAL);
407 for (i = 0; i < cfg->instances_num; i++)
408 {
409 int status;
411 if (!inst_matches_ident (cfg->instances[i], ident))
412 continue;
414 status = (*callback) (cfg, cfg->instances[i], user_data);
415 if (status != 0)
416 return (status);
417 }
419 return (0);
420 } /* }}} int graph_inst_find_all_matching */
422 /* When this function is called from graph_list, it will already have checked
423 * that the selector of the graph matches the field selections contained in
424 * the search_info_t. So if the graphs title matches, this means that the
425 * field selections and the search term(s) apply to the graph in general; thus
426 * we return all instances. Otherwise, use the somewhat expensive
427 * "search_graph_inst_matches" function to look for matching instances. */
428 int graph_search_inst (graph_config_t *cfg, search_info_t *si, /* {{{ */
429 graph_inst_callback_t cb,
430 void *user_data)
431 {
432 char title[1024];
433 int status;
434 size_t i;
436 if ((cfg == NULL) || (si == NULL) || (cb == NULL))
437 return (EINVAL);
439 status = graph_get_title (cfg, title, sizeof (title));
440 if (status != 0)
441 {
442 fprintf (stderr, "graph_search_inst: graph_get_title failed\n");
443 return (status);
444 }
445 strtolower (title);
447 if (search_graph_title_matches (si, title))
448 {
449 /* The title of the graph matches, so return all instances. */
450 for (i = 0; i < cfg->instances_num; i++)
451 {
452 status = (*cb) (cfg, cfg->instances[i], user_data);
453 if (status != 0)
454 return (status);
455 }
456 }
457 else
458 {
459 /* The title doesn't match, so use the more expensive
460 * "search_graph_inst_matches" to look for matching instances. Since part
461 * of the terms may match the title and other terms may match the
462 * instance, the title must be passed along to that function again. */
463 for (i = 0; i < cfg->instances_num; i++)
464 {
465 if (search_graph_inst_matches (si, cfg, cfg->instances[i], title))
466 {
467 status = (*cb) (cfg, cfg->instances[i], user_data);
468 if (status != 0)
469 return (status);
470 }
471 }
472 }
474 return (0);
475 } /* }}} int graph_search_inst */
477 int graph_search_inst_string (graph_config_t *cfg, const char *term, /* {{{ */
478 graph_inst_callback_t cb,
479 void *user_data)
480 {
481 char buffer[1024];
482 int status;
483 size_t i;
485 status = graph_get_title (cfg, buffer, sizeof (buffer));
486 if (status != 0)
487 {
488 fprintf (stderr, "graph_search_inst_string: graph_get_title failed\n");
489 return (status);
490 }
492 strtolower (buffer);
494 if (strstr (buffer, term) != NULL)
495 {
496 for (i = 0; i < cfg->instances_num; i++)
497 {
498 status = (*cb) (cfg, cfg->instances[i], user_data);
499 if (status != 0)
500 return (status);
501 }
502 }
503 else
504 {
505 for (i = 0; i < cfg->instances_num; i++)
506 {
507 if (inst_matches_string (cfg, cfg->instances[i], term))
508 {
509 status = (*cb) (cfg, cfg->instances[i], user_data);
510 if (status != 0)
511 return (status);
512 }
513 }
514 }
516 return (0);
517 } /* }}} int graph_search_inst_string */
519 int graph_inst_search_field (graph_config_t *cfg, /* {{{ */
520 graph_ident_field_t field, const char *field_value,
521 graph_inst_callback_t callback, void *user_data)
522 {
523 size_t i;
524 const char *selector_field;
525 _Bool need_check_instances = 0;
527 if ((cfg == NULL) || (field_value == NULL) || (callback == NULL))
528 return (EINVAL);
530 if (!graph_matches_field (cfg, field, field_value))
531 return (0);
533 selector_field = ident_get_field (cfg->select, field);
534 if (selector_field == NULL)
535 return (-1);
537 if (IS_ALL (selector_field) || IS_ANY (selector_field))
538 need_check_instances = 1;
540 for (i = 0; i < cfg->instances_num; i++)
541 {
542 int status;
544 if (need_check_instances
545 && !inst_matches_field (cfg->instances[i], field, field_value))
546 continue;
548 status = (*callback) (cfg, cfg->instances[i], user_data);
549 if (status != 0)
550 return (status);
551 }
553 return (0);
554 } /* }}} int graph_inst_search_field */
556 int graph_compare (graph_config_t *cfg, const graph_ident_t *ident) /* {{{ */
557 {
558 if ((cfg == NULL) || (ident == NULL))
559 return (0);
561 return (ident_compare (cfg->select, ident));
562 } /* }}} int graph_compare */
564 static int graph_sort_instances_cb (const void *v0, const void *v1) /* {{{ */
565 {
566 return (inst_compare (*(graph_instance_t * const *) v0,
567 *(graph_instance_t * const *) v1));
568 } /* }}} int graph_sort_instances_cb */
570 size_t graph_num_instances (graph_config_t *cfg) /* {{{ */
571 {
572 if (cfg == NULL)
573 return ((size_t) -1);
575 return (cfg->instances_num);
576 } /* }}} size_t graph_num_instances */
578 int graph_sort_instances (graph_config_t *cfg) /* {{{ */
579 {
580 if (cfg == NULL)
581 return (EINVAL);
583 if (cfg->instances_num < 2)
584 return (0);
586 qsort (cfg->instances, cfg->instances_num, sizeof (*cfg->instances),
587 graph_sort_instances_cb);
589 return (0);
590 } /* }}} int graph_sort_instances */
592 int graph_clear_instances (graph_config_t *cfg) /* {{{ */
593 {
594 size_t i;
596 if (cfg == NULL)
597 return (EINVAL);
599 for (i = 0; i < cfg->instances_num; i++)
600 inst_destroy (cfg->instances[i]);
601 free (cfg->instances);
602 cfg->instances = NULL;
603 cfg->instances_num = 0;
605 return (0);
606 } /* }}} int graph_clear_instances */
608 int graph_get_rrdargs (graph_config_t *cfg, graph_instance_t *inst, /* {{{ */
609 rrd_args_t *args)
610 {
611 if ((cfg == NULL) || (inst == NULL) || (args == NULL))
612 return (EINVAL);
614 if (cfg->title != NULL)
615 {
616 array_append (args->options, "-t");
617 array_append (args->options, cfg->title);
618 }
620 if (cfg->vertical_label != NULL)
621 {
622 array_append (args->options, "-v");
623 array_append (args->options, cfg->vertical_label);
624 }
626 if (cfg->show_zero)
627 {
628 array_append (args->options, "-l");
629 array_append (args->options, "0");
630 }
632 return (0);
633 } /* }}} int graph_get_rrdargs */
635 /* vim: set sw=2 sts=2 et fdm=marker : */