1 /**
2 * collectd - src/filecount.c
3 * Copyright (C) 2008 Alessandro Iurlano
4 * Copyright (C) 2008 Florian octo Forster
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 * Authors:
20 * Alessandro Iurlano <alessandro.iurlano at gmail.com>
21 * Florian octo Forster <octo at verplant.org>
22 **/
24 #include "collectd.h"
25 #include "common.h"
26 #include "plugin.h"
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #include <fcntl.h>
31 #include <dirent.h>
32 #include <fnmatch.h>
34 #define FC_RECURSIVE 1
35 #define FC_HIDDEN 2
37 struct fc_directory_conf_s
38 {
39 char *path;
40 char *instance;
42 int options;
44 /* Data counters */
45 uint64_t files_num;
46 uint64_t files_size;
48 /* Selectors */
49 char *name;
50 int64_t mtime;
51 int64_t size;
53 /* Helper for the recursive functions */
54 time_t now;
55 };
56 typedef struct fc_directory_conf_s fc_directory_conf_t;
58 static fc_directory_conf_t **directories = NULL;
59 static size_t directories_num = 0;
61 static void fc_submit_dir (const fc_directory_conf_t *dir)
62 {
63 value_t values[1];
64 value_list_t vl = VALUE_LIST_INIT;
66 values[0].gauge = (gauge_t) dir->files_num;
68 vl.values = values;
69 vl.values_len = STATIC_ARRAY_SIZE (values);
70 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
71 sstrncpy (vl.plugin, "filecount", sizeof (vl.plugin));
72 sstrncpy (vl.plugin_instance, dir->instance, sizeof (vl.plugin_instance));
73 sstrncpy (vl.type, "files", sizeof (vl.type));
75 plugin_dispatch_values (&vl);
77 values[0].gauge = (gauge_t) dir->files_size;
78 sstrncpy (vl.type, "bytes", sizeof (vl.type));
80 plugin_dispatch_values (&vl);
81 } /* void fc_submit_dir */
83 /*
84 * Config:
85 * <Plugin filecount>
86 * <Directory /path/to/dir>
87 * Instance "foobar"
88 * Name "*.conf"
89 * MTime -3600
90 * Size "+10M"
91 * </Directory>
92 * </Plugin>
93 *
94 * Collect:
95 * - Number of files
96 * - Total size
97 */
99 static int fc_config_set_instance (fc_directory_conf_t *dir, const char *str)
100 {
101 char buffer[1024];
102 char *ptr;
103 char *copy;
105 sstrncpy (buffer, str, sizeof (buffer));
106 for (ptr = buffer; *ptr != 0; ptr++)
107 if (*ptr == '/')
108 *ptr = '_';
110 for (ptr = buffer; *ptr == '_'; ptr++)
111 /* do nothing */;
113 if (*ptr == 0)
114 return (-1);
116 copy = strdup (ptr);
117 if (copy == NULL)
118 return (-1);
120 sfree (dir->instance);
121 dir->instance = copy;
123 return (0);
124 } /* int fc_config_set_instance */
126 static int fc_config_add_dir_instance (fc_directory_conf_t *dir,
127 oconfig_item_t *ci)
128 {
129 if ((ci->values_num != 1)
130 || (ci->values[0].type != OCONFIG_TYPE_STRING))
131 {
132 WARNING ("filecount plugin: The `Instance' config option needs exactly "
133 "one string argument.");
134 return (-1);
135 }
137 return (fc_config_set_instance (dir, ci->values[0].value.string));
138 } /* int fc_config_add_dir_instance */
140 static int fc_config_add_dir_name (fc_directory_conf_t *dir,
141 oconfig_item_t *ci)
142 {
143 char *temp;
145 if ((ci->values_num != 1)
146 || (ci->values[0].type != OCONFIG_TYPE_STRING))
147 {
148 WARNING ("filecount plugin: The `Name' config option needs exactly one "
149 "string argument.");
150 return (-1);
151 }
153 temp = strdup (ci->values[0].value.string);
154 if (temp == NULL)
155 {
156 ERROR ("filecount plugin: strdup failed.");
157 return (-1);
158 }
160 sfree (dir->name);
161 dir->name = temp;
163 return (0);
164 } /* int fc_config_add_dir_name */
166 static int fc_config_add_dir_mtime (fc_directory_conf_t *dir,
167 oconfig_item_t *ci)
168 {
169 char *endptr;
170 double temp;
172 if ((ci->values_num != 1)
173 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
174 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
175 {
176 WARNING ("filecount plugin: The `MTime' config option needs exactly one "
177 "string or numeric argument.");
178 return (-1);
179 }
181 if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
182 {
183 dir->mtime = (int64_t) ci->values[0].value.number;
184 return (0);
185 }
187 errno = 0;
188 endptr = NULL;
189 temp = strtod (ci->values[0].value.string, &endptr);
190 if ((errno != 0) || (endptr == NULL)
191 || (endptr == ci->values[0].value.string))
192 {
193 WARNING ("filecount plugin: Converting `%s' to a number failed.",
194 ci->values[0].value.string);
195 return (-1);
196 }
198 switch (*endptr)
199 {
200 case 0:
201 case 's':
202 case 'S':
203 break;
205 case 'm':
206 case 'M':
207 temp *= 60;
208 break;
210 case 'h':
211 case 'H':
212 temp *= 3600;
213 break;
215 case 'd':
216 case 'D':
217 temp *= 86400;
218 break;
220 case 'w':
221 case 'W':
222 temp *= 7 * 86400;
223 break;
225 case 'y':
226 case 'Y':
227 temp *= 31557600; /* == 365.25 * 86400 */
228 break;
230 default:
231 WARNING ("filecount plugin: Invalid suffix for `MTime': `%c'", *endptr);
232 return (-1);
233 } /* switch (*endptr) */
235 dir->mtime = (int64_t) temp;
237 return (0);
238 } /* int fc_config_add_dir_mtime */
240 static int fc_config_add_dir_size (fc_directory_conf_t *dir,
241 oconfig_item_t *ci)
242 {
243 char *endptr;
244 double temp;
246 if ((ci->values_num != 1)
247 || ((ci->values[0].type != OCONFIG_TYPE_STRING)
248 && (ci->values[0].type != OCONFIG_TYPE_NUMBER)))
249 {
250 WARNING ("filecount plugin: The `Size' config option needs exactly one "
251 "string or numeric argument.");
252 return (-1);
253 }
255 if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
256 {
257 dir->size = (int64_t) ci->values[0].value.number;
258 return (0);
259 }
261 errno = 0;
262 endptr = NULL;
263 temp = strtod (ci->values[0].value.string, &endptr);
264 if ((errno != 0) || (endptr == NULL)
265 || (endptr == ci->values[0].value.string))
266 {
267 WARNING ("filecount plugin: Converting `%s' to a number failed.",
268 ci->values[0].value.string);
269 return (-1);
270 }
272 switch (*endptr)
273 {
274 case 0:
275 case 'b':
276 case 'B':
277 break;
279 case 'k':
280 case 'K':
281 temp *= 1000.0;
282 break;
284 case 'm':
285 case 'M':
286 temp *= 1000.0 * 1000.0;
287 break;
289 case 'g':
290 case 'G':
291 temp *= 1000.0 * 1000.0 * 1000.0;
292 break;
294 case 't':
295 case 'T':
296 temp *= 1000.0 * 1000.0 * 1000.0 * 1000.0;
297 break;
299 case 'p':
300 case 'P':
301 temp *= 1000.0 * 1000.0 * 1000.0 * 1000.0 * 1000.0;
302 break;
304 default:
305 WARNING ("filecount plugin: Invalid suffix for `Size': `%c'", *endptr);
306 return (-1);
307 } /* switch (*endptr) */
309 dir->size = (int64_t) temp;
311 return (0);
312 } /* int fc_config_add_dir_size */
314 static int fc_config_add_dir_option (fc_directory_conf_t *dir,
315 oconfig_item_t *ci, int bit)
316 {
317 if ((ci->values_num != 1)
318 || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
319 {
320 WARNING ("filecount plugin: The `Recursive' config options needs exactly "
321 "one boolean argument.");
322 return (-1);
323 }
325 if (ci->values[0].value.boolean)
326 dir->options |= bit;
327 else
328 dir->options &= ~bit;
330 return (0);
331 } /* int fc_config_add_dir_option */
333 static int fc_config_add_dir (oconfig_item_t *ci)
334 {
335 fc_directory_conf_t *dir;
336 int status;
337 int i;
339 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
340 {
341 WARNING ("filecount plugin: `Directory' needs exactly one string "
342 "argument.");
343 return (-1);
344 }
346 /* Initialize `dir' */
347 dir = (fc_directory_conf_t *) malloc (sizeof (*dir));
348 if (dir == NULL)
349 {
350 ERROR ("filecount plugin: malloc failed.");
351 return (-1);
352 }
353 memset (dir, 0, sizeof (*dir));
355 dir->path = strdup (ci->values[0].value.string);
356 if (dir->path == NULL)
357 {
358 ERROR ("filecount plugin: strdup failed.");
359 return (-1);
360 }
362 fc_config_set_instance (dir, dir->path);
364 dir->options = FC_RECURSIVE;
366 dir->name = NULL;
367 dir->mtime = 0;
368 dir->size = 0;
370 status = 0;
371 for (i = 0; i < ci->children_num; i++)
372 {
373 oconfig_item_t *option = ci->children + i;
375 if (strcasecmp ("Instance", option->key) == 0)
376 status = fc_config_add_dir_instance (dir, option);
377 else if (strcasecmp ("Name", option->key) == 0)
378 status = fc_config_add_dir_name (dir, option);
379 else if (strcasecmp ("MTime", option->key) == 0)
380 status = fc_config_add_dir_mtime (dir, option);
381 else if (strcasecmp ("Size", option->key) == 0)
382 status = fc_config_add_dir_size (dir, option);
383 else if (strcasecmp ("Recursive", option->key) == 0)
384 status = fc_config_add_dir_option (dir, option, FC_RECURSIVE);
385 else if (strcasecmp ("IncludeHidden", option->key) == 0)
386 status = fc_config_add_dir_option (dir, option, FC_HIDDEN);
387 else
388 {
389 WARNING ("filecount plugin: fc_config_add_dir: "
390 "Option `%s' not allowed here.", option->key);
391 status = -1;
392 }
394 if (status != 0)
395 break;
396 } /* for (ci->children) */
398 if (status == 0)
399 {
400 fc_directory_conf_t **temp;
402 temp = (fc_directory_conf_t **) realloc (directories,
403 sizeof (*directories) * (directories_num + 1));
404 if (temp == NULL)
405 {
406 ERROR ("filecount plugin: realloc failed.");
407 status = -1;
408 }
409 else
410 {
411 directories = temp;
412 directories[directories_num] = dir;
413 directories_num++;
414 }
415 }
417 if (status != 0)
418 {
419 sfree (dir->name);
420 sfree (dir->instance);
421 sfree (dir->path);
422 sfree (dir);
423 return (-1);
424 }
426 return (0);
427 } /* int fc_config_add_dir */
429 static int fc_config (oconfig_item_t *ci)
430 {
431 int i;
433 for (i = 0; i < ci->children_num; i++)
434 {
435 oconfig_item_t *child = ci->children + i;
436 if (strcasecmp ("Directory", child->key) == 0)
437 fc_config_add_dir (child);
438 else
439 {
440 WARNING ("filecount plugin: Ignoring unknown config option `%s'.",
441 child->key);
442 }
443 } /* for (ci->children) */
445 return (0);
446 } /* int fc_config */
448 static int fc_init (void)
449 {
450 if (directories_num < 1)
451 {
452 WARNING ("filecount plugin: No directories have been configured.");
453 return (-1);
454 }
456 return (0);
457 } /* int fc_init */
459 static int fc_read_dir_callback (const char *dirname, const char *filename,
460 void *user_data)
461 {
462 fc_directory_conf_t *dir = user_data;
463 char abs_path[PATH_MAX];
464 struct stat statbuf;
465 int status;
467 if (dir == NULL)
468 return (-1);
470 ssnprintf (abs_path, sizeof (abs_path), "%s/%s", dirname, filename);
472 status = lstat (abs_path, &statbuf);
473 if (status != 0)
474 {
475 ERROR ("filecount plugin: stat (%s) failed.", abs_path);
476 return (-1);
477 }
479 if (S_ISDIR (statbuf.st_mode) && (dir->options & FC_RECURSIVE))
480 {
481 status = walk_directory (abs_path, fc_read_dir_callback, dir,
482 /* include hidden = */ (dir->options & FC_HIDDEN) ? 1 : 0);
483 return (status);
484 }
485 else if (!S_ISREG (statbuf.st_mode))
486 {
487 return (0);
488 }
490 if (dir->name != NULL)
491 {
492 status = fnmatch (dir->name, filename, /* flags = */ 0);
493 if (status != 0)
494 return (0);
495 }
497 if (dir->mtime != 0)
498 {
499 time_t mtime = dir->now;
501 if (dir->mtime < 0)
502 mtime += dir->mtime;
503 else
504 mtime -= dir->mtime;
506 DEBUG ("filecount plugin: Only collecting files that were touched %s %u.",
507 (dir->mtime < 0) ? "after" : "before",
508 (unsigned int) mtime);
510 if (((dir->mtime < 0) && (statbuf.st_mtime < mtime))
511 || ((dir->mtime > 0) && (statbuf.st_mtime > mtime)))
512 return (0);
513 }
515 if (dir->size != 0)
516 {
517 off_t size;
519 if (dir->size < 0)
520 size = (off_t) ((-1) * dir->size);
521 else
522 size = (off_t) dir->size;
524 if (((dir->size < 0) && (statbuf.st_size > size))
525 || ((dir->size > 0) && (statbuf.st_size < size)))
526 return (0);
527 }
529 dir->files_num++;
530 dir->files_size += (uint64_t) statbuf.st_size;
532 return (0);
533 } /* int fc_read_dir_callback */
535 static int fc_read_dir (fc_directory_conf_t *dir)
536 {
537 int status;
539 dir->files_num = 0;
540 dir->files_size = 0;
542 if (dir->mtime != 0)
543 dir->now = time (NULL);
545 status = walk_directory (dir->path, fc_read_dir_callback, dir,
546 /* include hidden */ (dir->options & FC_HIDDEN) ? 1 : 0);
547 if (status != 0)
548 {
549 WARNING ("filecount plugin: walk_directory (%s) failed.", dir->path);
550 return (-1);
551 }
553 fc_submit_dir (dir);
555 return (0);
556 } /* int fc_read_dir */
558 static int fc_read (void)
559 {
560 size_t i;
562 for (i = 0; i < directories_num; i++)
563 fc_read_dir (directories[i]);
565 return (0);
566 } /* int fc_read */
568 void module_register (void)
569 {
570 plugin_register_complex_config ("filecount", fc_config);
571 plugin_register_init ("filecount", fc_init);
572 plugin_register_read ("filecount", fc_read);
573 } /* void module_register */
575 /*
576 * vim: set sw=2 sts=2 et :
577 */