"list graphs" action: Pass the search term to the "show graph" action.
[collection4.git] / src / graph_instance.c
1 /**
2  * collection4 - graph_instance.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  **/
23
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <time.h>
28 #include <assert.h>
29
30 #include "graph_instance.h"
31 #include "graph.h"
32 #include "graph_def.h"
33 #include "graph_ident.h"
34 #include "graph_list.h"
35 #include "common.h"
36 #include "utils_cgi.h"
37
38 #include <fcgiapp.h>
39 #include <fcgi_stdio.h>
40
41 struct graph_instance_s /* {{{ */
42 {
43   graph_ident_t *select;
44
45   graph_ident_t **files;
46   size_t files_num;
47 }; /* }}} struct graph_instance_s */
48
49 struct def_callback_data_s
50 {
51   graph_instance_t *inst;
52   rrd_args_t *args;
53 };
54 typedef struct def_callback_data_s def_callback_data_t;
55
56 /*
57  * Private functions
58  */
59 /* Create one DEF for each data source in the file. Called by
60  * "inst_get_default_defs" for each file. */
61 static graph_def_t *ident_get_default_defs (graph_config_t *cfg, /* {{{ */
62     graph_ident_t *ident, graph_def_t *def_head)
63 {
64   graph_def_t *defs = NULL;
65   char *file;
66   char **dses = NULL;
67   size_t dses_num = 0;
68   int status;
69   size_t i;
70
71   if ((cfg == NULL) || (ident == NULL))
72     return (def_head);
73
74   file = ident_to_file (ident);
75   if (file == NULL)
76   {
77     fprintf (stderr, "ident_get_default_defs: ident_to_file failed\n");
78     return (def_head);
79   }
80
81   status = ds_list_from_rrd_file (file, &dses_num, &dses);
82   if (status != 0)
83   {
84     free (file);
85     return (def_head);
86   }
87
88   for (i = 0; i < dses_num; i++)
89   {
90     graph_def_t *def;
91
92     def = def_search (def_head, ident, dses[i]);
93     if (def != NULL)
94       continue;
95
96     def = def_create (cfg, ident, dses[i]);
97     if (def == NULL)
98       continue;
99
100     if (defs == NULL)
101       defs = def;
102     else
103       def_append (defs, def);
104
105     free (dses[i]);
106   }
107
108   free (dses);
109   free (file);
110
111   return (defs);
112 } /* }}} int ident_get_default_defs */
113
114 /* Create one or more DEFs for each file in the graph instance. The number
115  * depends on the number of data sources in each of the files. Called from
116  * "inst_get_rrdargs" if no DEFs are available from the configuration.
117  * */
118 static graph_def_t *inst_get_default_defs (graph_config_t *cfg, /* {{{ */
119     graph_instance_t *inst)
120 {
121   graph_def_t *defs = NULL;
122   size_t i;
123
124   if ((cfg == NULL) || (inst == NULL))
125     return (NULL);
126
127   for (i = 0; i < inst->files_num; i++)
128   {
129     graph_def_t *def;
130
131     def = ident_get_default_defs (cfg, inst->files[i], defs);
132     if (def == NULL)
133       continue;
134
135     if (defs == NULL)
136       defs = def;
137     else
138       def_append (defs, def);
139   }
140
141   return (defs);
142 } /* }}} graph_def_t *inst_get_default_defs */
143
144 /* Called with each DEF in turn. Calls "def_get_rrdargs" with every appropriate
145  * file / DEF pair. */
146 static int gl_instance_get_rrdargs_cb (graph_def_t *def, void *user_data) /* {{{ */
147 {
148   def_callback_data_t *data = user_data;
149   graph_instance_t *inst = data->inst;
150   rrd_args_t *args = data->args;
151
152   size_t i;
153
154   for (i = 0; i < inst->files_num; i++)
155   {
156     if (!def_matches (def, inst->files[i]))
157       continue;
158
159     def_get_rrdargs (def, inst->files[i], args);
160   }
161
162   return (0);
163 } /* }}} int gl_instance_get_rrdargs_cb */
164
165 static const char *get_part_from_param (const char *prim_key, /* {{{ */
166     const char *sec_key)
167 {
168   const char *val;
169
170   val = param (prim_key);
171   if (val != NULL)
172     return (val);
173   
174   return (param (sec_key));
175 } /* }}} const char *get_part_from_param */
176
177 static graph_ident_t *inst_get_selector_from_params (void) /* {{{ */
178 {
179   const char *host = get_part_from_param ("inst_host", "host");
180   const char *plugin = get_part_from_param ("inst_plugin", "plugin");
181   const char *plugin_instance = get_part_from_param ("inst_plugin_instance",
182       "plugin_instance");
183   const char *type = get_part_from_param ("inst_type", "type");
184   const char *type_instance = get_part_from_param ("inst_type_instance",
185       "type_instance");
186
187   graph_ident_t *ident;
188
189   if ((host == NULL)
190       || (plugin == NULL) || (plugin_instance == NULL)
191       || (type == NULL) || (type_instance == NULL))
192   {
193     fprintf (stderr, "inst_get_selected: A parameter is NULL\n");
194     return (NULL);
195   }
196
197   ident = ident_create (host, plugin, plugin_instance, type, type_instance);
198   if (ident == NULL)
199   {
200     fprintf (stderr, "inst_get_selected: ident_create failed\n");
201     return (NULL);
202   }
203
204   return (ident);
205 } /* }}} graph_ident_t *inst_get_selector_from_params */
206
207 /*
208  * Public functions
209  */
210 graph_instance_t *inst_create (graph_config_t *cfg, /* {{{ */
211     const graph_ident_t *ident)
212 {
213   graph_instance_t *i;
214   graph_ident_t *selector;
215
216   if ((cfg == NULL) || (ident == NULL))
217     return (NULL);
218
219   i = malloc (sizeof (*i));
220   if (i == NULL)
221     return (NULL);
222   memset (i, 0, sizeof (*i));
223
224   selector = graph_get_selector (cfg);
225   if (selector == NULL)
226   {
227     fprintf (stderr, "inst_create: graph_get_selector failed\n");
228     free (i);
229     return (NULL);
230   }
231
232   i->select = ident_copy_with_selector (selector, ident,
233       IDENT_FLAG_REPLACE_ANY);
234   if (i->select == NULL)
235   {
236     fprintf (stderr, "inst_create: ident_copy_with_selector failed\n");
237     ident_destroy (selector);
238     free (i);
239     return (NULL);
240   }
241
242   ident_destroy (selector);
243
244   i->files = NULL;
245   i->files_num = 0;
246
247   return (i);
248 } /* }}} graph_instance_t *inst_create */
249
250 void inst_destroy (graph_instance_t *inst) /* {{{ */
251 {
252   size_t i;
253
254   if (inst == NULL)
255     return;
256
257   ident_destroy (inst->select);
258
259   for (i = 0; i < inst->files_num; i++)
260     ident_destroy (inst->files[i]);
261   free (inst->files);
262
263   free (inst);
264 } /* }}} void inst_destroy */
265
266 int inst_add_file (graph_instance_t *inst, /* {{{ */
267     const graph_ident_t *file)
268 {
269   graph_ident_t **tmp;
270
271   tmp = realloc (inst->files, sizeof (*inst->files) * (inst->files_num + 1));
272   if (tmp == NULL)
273     return (ENOMEM);
274   inst->files = tmp;
275
276   inst->files[inst->files_num] = ident_clone (file);
277   if (inst->files[inst->files_num] == NULL)
278     return (ENOMEM);
279
280   inst->files_num++;
281
282   return (0);
283 } /* }}} int inst_add_file */
284
285 graph_instance_t *inst_get_selected (graph_config_t *cfg) /* {{{ */
286 {
287   graph_ident_t *ident;
288   graph_instance_t *inst;
289
290   if (cfg == NULL)
291     cfg = gl_graph_get_selected ();
292
293   if (cfg == NULL)
294   {
295     DEBUG ("inst_get_selected: cfg == NULL;\n");
296     return (NULL);
297   }
298
299   ident = inst_get_selector_from_params ();
300   if (ident == NULL)
301   {
302     fprintf (stderr, "inst_get_selected: ident_create failed\n");
303     return (NULL);
304   }
305
306   inst = graph_inst_find_exact (cfg, ident);
307
308   ident_destroy (ident);
309   return (inst);
310 } /* }}} graph_instance_t *inst_get_selected */
311
312 int inst_get_all_selected (graph_config_t *cfg, /* {{{ */
313     graph_inst_callback_t callback, void *user_data)
314 {
315   graph_ident_t *ident;
316   int status;
317
318   if ((cfg == NULL) || (callback == NULL))
319     return (EINVAL);
320
321   ident = inst_get_selector_from_params ();
322   if (ident == NULL)
323   {
324     fprintf (stderr, "inst_get_all_selected: "
325         "inst_get_selector_from_params failed\n");
326     return (EINVAL);
327   }
328
329   status = graph_inst_find_all_matching (cfg, ident, callback, user_data);
330
331   ident_destroy (ident);
332   return (status);
333 } /* }}} int inst_get_all_selected */
334
335 int inst_get_rrdargs (graph_config_t *cfg, /* {{{ */
336     graph_instance_t *inst,
337     rrd_args_t *args)
338 {
339   def_callback_data_t data = { inst, args };
340   graph_def_t *defs;
341   int status;
342
343   if ((cfg == NULL) || (inst == NULL) || (args == NULL))
344     return (EINVAL);
345
346   status = graph_get_rrdargs (cfg, inst, args);
347   if (status != 0)
348     return (status);
349
350   defs = graph_get_defs (cfg);
351   if (defs == NULL)
352   {
353     defs = inst_get_default_defs (cfg, inst);
354
355     if (defs == NULL)
356       return (-1);
357
358     status = def_foreach (defs, gl_instance_get_rrdargs_cb, &data);
359
360     def_destroy (defs);
361   }
362   else
363   {
364     status = def_foreach (defs, gl_instance_get_rrdargs_cb, &data);
365   }
366
367   return (status);
368 } /* }}} int inst_get_rrdargs */
369
370 graph_ident_t *inst_get_selector (graph_instance_t *inst) /* {{{ */
371 {
372   if (inst == NULL)
373     return (NULL);
374
375   return (ident_clone (inst->select));
376 } /* }}} graph_ident_t *inst_get_selector */
377
378 int inst_get_params (graph_config_t *cfg, graph_instance_t *inst, /* {{{ */
379     char *buffer, size_t buffer_size)
380 {
381   graph_ident_t *cfg_select;
382
383   if ((cfg == NULL) || (inst == NULL)
384       || (buffer == NULL) || (buffer_size < 1))
385     return (EINVAL);
386
387   cfg_select = graph_get_selector (cfg);
388   if (cfg_select == NULL)
389   {
390     fprintf (stderr, "inst_get_params: graph_get_selector failed");
391     return (-1);
392   }
393
394   buffer[0] = 0;
395
396 #define COPY_FIELD(field) do {                                  \
397   const char *cfg_f  = ident_get_##field (cfg_select);          \
398   const char *inst_f = ident_get_##field (inst->select);        \
399   if (strcmp (cfg_f, inst_f) == 0)                              \
400   {                                                             \
401     strlcat (buffer, #field, buffer_size);                      \
402     strlcat (buffer, "=", buffer_size);                         \
403     strlcat (buffer, cfg_f, buffer_size);                       \
404   }                                                             \
405   else                                                          \
406   {                                                             \
407     strlcat (buffer, "graph_", buffer_size);                    \
408     strlcat (buffer, #field, buffer_size);                      \
409     strlcat (buffer, "=", buffer_size);                         \
410     strlcat (buffer, cfg_f, buffer_size);                       \
411     strlcat (buffer, ";", buffer_size);                         \
412     strlcat (buffer, "inst_", buffer_size);                     \
413     strlcat (buffer, #field, buffer_size);                      \
414     strlcat (buffer, "=", buffer_size);                         \
415     strlcat (buffer, inst_f, buffer_size);                      \
416   }                                                             \
417 } while (0)
418
419   COPY_FIELD(host);
420   strlcat (buffer, ";", buffer_size);
421   COPY_FIELD(plugin);
422   strlcat (buffer, ";", buffer_size);
423   COPY_FIELD(plugin_instance);
424   strlcat (buffer, ";", buffer_size);
425   COPY_FIELD(type);
426   strlcat (buffer, ";", buffer_size);
427   COPY_FIELD(type_instance);
428
429 #undef COPY_FIELD
430
431   ident_destroy (cfg_select);
432
433   return (0);
434 } /* }}} int inst_get_params */
435
436 int inst_compare_ident (graph_instance_t *inst, /* {{{ */
437     const graph_ident_t *ident)
438 {
439   if ((inst == NULL) || (ident == NULL))
440     return (0);
441
442   return (ident_compare (inst->select, ident));
443 } /* }}} int inst_compare_ident */
444
445 _Bool inst_ident_matches (graph_instance_t *inst, /* {{{ */
446     const graph_ident_t *ident)
447 {
448   if ((inst == NULL) || (ident == NULL))
449     return (0);
450
451   return (ident_matches (inst->select, ident));
452 } /* }}} _Bool inst_ident_matches */
453
454 _Bool inst_matches_ident (graph_instance_t *inst, /* {{{ */
455     const graph_ident_t *ident)
456 {
457   if ((inst == NULL) || (ident == NULL))
458     return (0);
459
460   return (ident_matches (ident, inst->select));
461 } /* }}} _Bool inst_matches_ident */
462
463 _Bool inst_matches_string (graph_config_t *cfg, /* {{{ */
464     graph_instance_t *inst,
465     const char *term)
466 {
467   char buffer[1024];
468   int status;
469
470   if ((cfg == NULL) || (inst == NULL) || (term == NULL))
471     return (0);
472
473   status = inst_describe (cfg, inst, buffer, sizeof (buffer));
474   if (status != 0)
475   {
476     fprintf (stderr, "inst_matches_string: inst_describe failed\n");
477     return (status);
478   }
479
480   strtolower (buffer);
481
482   /* no match */
483   if (strstr (buffer, term) == NULL)
484     return (0);
485
486   return (1);
487 } /* }}} _Bool inst_matches_string */
488
489 _Bool inst_matches_field (graph_instance_t *inst, /* {{{ */
490     graph_ident_field_t field, const char *field_value)
491 {
492   const char *selector_field;
493   size_t i;
494
495   if ((inst == NULL) || (field_value == NULL))
496     return (0);
497
498   selector_field = ident_get_field (inst->select, field);
499   if (selector_field == NULL)
500     return (0);
501
502   assert (!IS_ANY (selector_field));
503   if (!IS_ALL (selector_field))
504   {
505     if (strcasecmp (selector_field, field_value) == 0)
506       return (1);
507     else
508       return (0);
509   }
510
511   /* The selector field is an ALL selector
512    * => we need to check the files to see if the instance matches. */
513   for (i = 0; i < inst->files_num; i++)
514   {
515     selector_field = ident_get_field (inst->files[i], field);
516     if (selector_field == NULL)
517       continue;
518
519     assert (!IS_ANY (selector_field));
520     assert (!IS_ALL (selector_field));
521
522     if (strcasecmp (selector_field, field_value) == 0)
523       return (1);
524   } /* for files */
525
526   return (0);
527 } /* }}} _Bool inst_matches_field */
528
529 int inst_describe (graph_config_t *cfg, graph_instance_t *inst, /* {{{ */
530     char *buffer, size_t buffer_size)
531 {
532   graph_ident_t *cfg_select;
533
534   if ((cfg == NULL) || (inst == NULL)
535       || (buffer == NULL) || (buffer_size < 2))
536     return (EINVAL);
537
538   cfg_select = graph_get_selector (cfg);
539   if (cfg_select == NULL)
540   {
541     fprintf (stderr, "inst_describe: graph_get_selector failed\n");
542     return (-1);
543   }
544
545   buffer[0] = 0;
546
547 #define CHECK_FIELD(field) do {                                              \
548   if (IS_ANY (ident_get_##field (cfg_select)))                               \
549   {                                                                          \
550     if (buffer[0] != 0)                                                      \
551       strlcat (buffer, "/", buffer_size);                                    \
552     strlcat (buffer, ident_get_##field (inst->select), buffer_size);         \
553   }                                                                          \
554 } while (0)
555
556   CHECK_FIELD (host);
557   CHECK_FIELD (plugin);
558   CHECK_FIELD (plugin_instance);
559   CHECK_FIELD (type);
560   CHECK_FIELD (type_instance);
561
562 #undef CHECK_FIELD
563
564   if (buffer[0] == 0)
565     strlcat (buffer, "default", buffer_size);
566
567   ident_destroy (cfg_select);
568
569   return (0);
570 } /* }}} int inst_describe */
571
572 time_t inst_get_mtime (graph_instance_t *inst) /* {{{ */
573 {
574   size_t i;
575   time_t mtime;
576
577   if (inst == NULL)
578     return (0);
579
580   mtime = 0;
581   for (i = 0; i < inst->files_num; i++)
582   {
583     time_t tmp;
584
585     tmp = ident_get_mtime (inst->files[i]);
586     if (mtime < tmp)
587       mtime = tmp;
588   }
589
590   return (mtime);
591 } /* }}} time_t inst_get_mtime */
592
593 /* vim: set sw=2 sts=2 et fdm=marker : */