Merge pull request #2796 from elfiesmelfie/feat_ipmi_SEL_ignore_list
[collectd.git] / src / utils_tail.c
1 /**
2  * collectd - src/utils_tail.c
3  * Copyright (C) 2007-2008  C-Ware, Inc.
4  * Copyright (C) 2008       Florian Forster
5  *
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:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
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.
23  *
24  * Author:
25  *   Luke Heberling <lukeh at c-ware.com>
26  *   Florian Forster <octo at collectd.org>
27  *
28  * Description:
29  *   Encapsulates useful code for plugins which must watch for appends to
30  *   the end of a file.
31  **/
32
33 #include "collectd.h"
34
35 #include "common.h"
36 #include "utils_tail.h"
37
38 struct cu_tail_s {
39   char *file;
40   FILE *fh;
41   struct stat stat;
42 };
43
44 static int cu_tail_reopen(cu_tail_t *obj) {
45   int seek_end = 0;
46   FILE *fh;
47   struct stat stat_buf = {0};
48   int status;
49
50   status = stat(obj->file, &stat_buf);
51   if (status != 0) {
52     ERROR("utils_tail: stat (%s) failed: %s", obj->file, STRERRNO);
53     return -1;
54   }
55
56   /* The file is already open.. */
57   if ((obj->fh != NULL) && (stat_buf.st_ino == obj->stat.st_ino)) {
58     /* Seek to the beginning if file was truncated */
59     if (stat_buf.st_size < obj->stat.st_size) {
60       INFO("utils_tail: File `%s' was truncated.", obj->file);
61       status = fseek(obj->fh, 0, SEEK_SET);
62       if (status != 0) {
63         ERROR("utils_tail: fseek (%s) failed: %s", obj->file, STRERRNO);
64         fclose(obj->fh);
65         obj->fh = NULL;
66         return -1;
67       }
68     }
69     memcpy(&obj->stat, &stat_buf, sizeof(struct stat));
70     return 1;
71   }
72
73   /* Seek to the end if we re-open the same file again or the file opened
74    * is the first at all or the first after an error */
75   if ((obj->stat.st_ino == 0) || (obj->stat.st_ino == stat_buf.st_ino))
76     seek_end = 1;
77
78   fh = fopen(obj->file, "r");
79   if (fh == NULL) {
80     ERROR("utils_tail: fopen (%s) failed: %s", obj->file, STRERRNO);
81     return -1;
82   }
83
84   if (seek_end != 0) {
85     status = fseek(fh, 0, SEEK_END);
86     if (status != 0) {
87       ERROR("utils_tail: fseek (%s) failed: %s", obj->file, STRERRNO);
88       fclose(fh);
89       return -1;
90     }
91   }
92
93   if (obj->fh != NULL)
94     fclose(obj->fh);
95   obj->fh = fh;
96   memcpy(&obj->stat, &stat_buf, sizeof(struct stat));
97
98   return 0;
99 } /* int cu_tail_reopen */
100
101 cu_tail_t *cu_tail_create(const char *file) {
102   cu_tail_t *obj;
103
104   obj = calloc(1, sizeof(*obj));
105   if (obj == NULL)
106     return NULL;
107
108   obj->file = strdup(file);
109   if (obj->file == NULL) {
110     free(obj);
111     return NULL;
112   }
113
114   obj->fh = NULL;
115
116   return obj;
117 } /* cu_tail_t *cu_tail_create */
118
119 int cu_tail_destroy(cu_tail_t *obj) {
120   if (obj->fh != NULL)
121     fclose(obj->fh);
122   free(obj->file);
123   free(obj);
124
125   return 0;
126 } /* int cu_tail_destroy */
127
128 int cu_tail_readline(cu_tail_t *obj, char *buf, int buflen) {
129   int status;
130
131   if (buflen < 1) {
132     ERROR("utils_tail: cu_tail_readline: buflen too small: %i bytes.", buflen);
133     return -1;
134   }
135
136   if (obj->fh == NULL) {
137     status = cu_tail_reopen(obj);
138     if (status < 0)
139       return status;
140   }
141   assert(obj->fh != NULL);
142
143   /* Try to read from the filehandle. If that succeeds, everything appears to
144    * be fine and we can return. */
145   clearerr(obj->fh);
146   if (fgets(buf, buflen, obj->fh) != NULL) {
147     buf[buflen - 1] = 0;
148     return 0;
149   }
150
151   /* Check if we encountered an error */
152   if (ferror(obj->fh) != 0) {
153     /* Jupp, error. Force `cu_tail_reopen' to reopen the file.. */
154     fclose(obj->fh);
155     obj->fh = NULL;
156   }
157   /* else: eof -> check if the file was moved away and reopen the new file if
158    * so.. */
159
160   status = cu_tail_reopen(obj);
161   /* error -> return with error */
162   if (status < 0)
163     return status;
164   /* file end reached and file not reopened -> nothing more to read */
165   else if (status > 0) {
166     buf[0] = 0;
167     return 0;
168   }
169
170   /* If we get here: file was re-opened and there may be more to read.. Let's
171    * try again. */
172   if (fgets(buf, buflen, obj->fh) != NULL) {
173     buf[buflen - 1] = 0;
174     return 0;
175   }
176
177   if (ferror(obj->fh) != 0) {
178     WARNING("utils_tail: fgets (%s) returned an error: %s", obj->file,
179             STRERRNO);
180     fclose(obj->fh);
181     obj->fh = NULL;
182     return -1;
183   }
184
185   /* EOf, well, apparently the new file is empty.. */
186   buf[0] = 0;
187   return 0;
188 } /* int cu_tail_readline */
189
190 int cu_tail_read(cu_tail_t *obj, char *buf, int buflen, tailfunc_t *callback,
191                  void *data) {
192   int status;
193
194   while (42) {
195     size_t len;
196
197     status = cu_tail_readline(obj, buf, buflen);
198     if (status != 0) {
199       ERROR("utils_tail: cu_tail_read: cu_tail_readline "
200             "failed.");
201       break;
202     }
203
204     /* check for EOF */
205     if (buf[0] == 0)
206       break;
207
208     len = strlen(buf);
209     while (len > 0) {
210       if (buf[len - 1] != '\n')
211         break;
212       buf[len - 1] = '\0';
213       len--;
214     }
215
216     status = callback(data, buf, buflen);
217     if (status != 0) {
218       ERROR("utils_tail: cu_tail_read: callback returned "
219             "status %i.",
220             status);
221       break;
222     }
223   }
224
225   return status;
226 } /* int cu_tail_read */