source: MondoRescue/branches/3.0/mondo/src/lib/mr_conf.c@ 3185

Last change on this file since 3185 was 3185, checked in by Bruno Cornec, 11 years ago

Simplify the interface of mr_getline and mr_asprintf. With 3.1 compatibility now will allow backports from this branch into 3.0
  • Property svn:eol-style set to native
File size: 12.0 KB
Line 
1/* mr_conf.c
2 *
3 * $Id$
4 *
5 * Based on the work done by Anton (c)2002-2004 Anton Kulchitsky mailto:anton@kulchitsky.org
6 * Code (c)2006 Bruno Cornec <bruno@mondorescue.org>
7 *
8 * Main file of mr_conf : a very small and simple
9 * library for configuration file reading
10 *
11 * Provided under the GPLv2
12 */
13
14
15#include <stdlib.h>
16#include <stdio.h>
17#include <string.h>
18
19#include "mr_types.h"
20#include "mr_msg.h"
21#include "mr_mem.h"
22#include "mr_gettext.h"
23
24/* error flags */
25#define MRCONF_NO_ERROR 0x0
26#define MRCONF_BAD_FILE 0x1
27#define MRCONF_READING_FAILED 0x3
28#define MRCONF_NO_GROUP_START 0x4
29#define MRCONF_NO_GROUP_END 0x5
30#define MRCONF_FIELD_NOT_FOUND 0x6
31#define MRCONF_FIELD_NO_VALUE 0x7
32#define MRCONF_TOO_LONG_STRING 0x8
33#define MRCONF_CLOSE_BUT_NOT_OPEN 0x9
34#define MRCONF_OPEN_OPENED 0xA
35#define MRCONF_CALL_BUT_NOT_OPEN 0xB
36#define MRCONF_STRING_QUOTE 0xC
37#define MRCONF_STRING_ENDQUOTE 0xD
38
39/*setting flags*/
40#define MRCONF_FLAG_VERBOSE 0x1
41
42/*All strings of the library are here*/
43#define MRCONF_STR_ERROR _("MRCONF: Error:")
44#define MRCONF_STR_WARNING _("MRCONF: Warning:")
45
46#define MRCONF_STR_BAD_FILE _("cannot open the file: ")
47#define MRCONF_STR_ALLOC_FAILED _("cannot allocate the memory")
48#define MRCONF_STR_READING_FAILED _("cannot read file into buffer")
49#define MRCONF_STR_DEFAULT_ERROR _("default")
50#define MRCONF_STR_FIELD_NOT_FOUND _("the field is not found, field:")
51#define MRCONF_STR_FIELD_NO_VALUE _("the field :")
52#define MRCONF_STR_OPEN_OPENED _("attempt to open mr_conf, but it is opened: aborted")
53#define MRCONF_STR_HALT _("MRCONF: Error occured: immidiate halt")
54
55/*warnings*/
56#define MRCONF_STR_IGNORE _("has no value, ignoring it")
57#define MRCONF_STR_CLOSE_BUT_NOT_OPEN _("attempt to close mr_conf but it has not been opened yet")
58#define MRCONF_STR_CALL_BUT_NOT_OPEN _("attempt to use mr_conf when it has not been opened yet")
59#define MRCONF_STR_STRING_QUOTE _("string should be surrounded by quotes")
60#define MRCONF_STR_STRING_ENDQUOTE _("a string is not finished by a quote")
61
62/*Flags of internal state*/
63#define MRCONF_INTFLAG_OPEN 0x1 /*set if memory allocated */
64
65/* Character for comments */
66#define MRCONF_COMM_CHAR '#'
67
68/*"private" members declarations*/
69static size_t mr_conf_filesize(const char *name);
70#define mr_conf_error_msg(x, y) {mr_conf_error_msg_int(x, y, __LINE__,__FILE__);}
71static void mr_conf_error_msg_int(int error_code, const char *add_line, int line, const char *file);
72static void mr_conf_remove_comments(void);
73static int mr_conf_check_int_flag(const int flag);
74static void mr_conf_set_int_flag(const int flag);
75static void mr_conf_drop_int_flag(const int flag);
76
77/*global "private" variables*/
78static char *buffer = NULL; /*buffer for configuration file */
79static int internal_flags = 0; /*state of the module */
80static FILE *CONF = NULL; /* Configuration file FD */
81static char *mr_conf_filename = NULL; /* Configuration filename */
82
83/*if output all error and warning messages*/
84static int mr_conf_flags = MRCONF_FLAG_VERBOSE;
85
86/*
87 * Format of the configuration file is as follows:
88 *
89 * attribute1 = int_value
90 * attribute2 = float_value
91 * attribute3 = string_value
92 */
93
94
95/*open and read file: each call must be coupled with mr_conf_close
96 function: return 0 if success*/
97int mr_conf_open(const char *filename) {
98 size_t length; /*length of the buffer/file */
99
100 /* check if mr_conf is already opened? */
101 if (mr_conf_check_int_flag(MRCONF_INTFLAG_OPEN)) {
102 mr_conf_error_msg(MRCONF_OPEN_OPENED, NULL);
103 return MRCONF_OPEN_OPENED;
104 }
105
106 length = mr_conf_filesize(filename);
107 CONF = fopen(filename, "r");
108
109 mr_asprintf(mr_conf_filename, "%s", filename);
110
111 /*if file is empty or not exist => error */
112 if (length == 0) {
113 mr_conf_error_msg(MRCONF_BAD_FILE, filename);
114 return (MRCONF_BAD_FILE);
115 }
116
117 /*creating and reading buffer for file content */
118
119 /*allocate memory for the buffers */
120 buffer = (char *) mr_malloc(sizeof(char) * (length + 1));
121
122 /*set flag that module is in "open" state */
123 mr_conf_set_int_flag(MRCONF_INTFLAG_OPEN);
124
125 /*reading file in buffer (skip all 0 characters) */
126
127 if (fread(buffer, sizeof(char), length, CONF)) {
128 // FIXME
129 }
130 buffer[length] = (char) 0; /*finalize the string */
131
132 if (ferror(CONF)) {
133 mr_conf_error_msg(MRCONF_READING_FAILED, "");
134 return (MRCONF_READING_FAILED);
135 }
136
137 /* finally we have to remove all comment lines */
138 mr_conf_remove_comments();
139
140 return MRCONF_NO_ERROR;
141}
142
143/*release all memory and prepare to the next possiable config file*/
144void mr_conf_close(void) {
145 /* if not opened => error */
146 if (!mr_conf_check_int_flag(MRCONF_INTFLAG_OPEN)) {
147 mr_conf_error_msg(MRCONF_CLOSE_BUT_NOT_OPEN, NULL);
148 }
149 mr_free(buffer);
150 fclose(CONF);
151
152 mr_free(mr_conf_filename);
153
154 /*set flag that module is in "close" state */
155 mr_conf_drop_int_flag(MRCONF_INTFLAG_OPEN);
156}
157
158/*read field value after string str in the current file*/
159static char *mr_conf_read(const char *field_name) {
160 char *p = NULL; /*pointer to the field */
161
162 /* check if mr_conf is not yet opened? */
163 if (!mr_conf_check_int_flag(MRCONF_INTFLAG_OPEN)) {
164 mr_conf_error_msg(MRCONF_CALL_BUT_NOT_OPEN, NULL);
165 return NULL;
166 }
167
168 /*read the number */
169 p = strstr(buffer, field_name);
170 if (p == NULL) {
171 mr_conf_error_msg(MRCONF_FIELD_NOT_FOUND, field_name);
172 return NULL;
173 } else {
174 p += strlen(field_name);
175 while ((*p != '\n') && (*p != '\0') && (*p != '=')) {
176 p++;
177 }
178 if (*p != '=') {
179 mr_conf_error_msg(MRCONF_FIELD_NO_VALUE, field_name);
180 return NULL;
181 } else {
182 /* points after the = sign */
183 p++;
184 }
185 }
186 /* skip initial spaces and tabs after = */
187 while ((*p == ' ') || (*p == '\t')) {
188 p++;
189 }
190
191 return p;
192}
193
194/*read integer number after string str in the current file*/
195char *mr_conf_iread(const char *field_name) {
196 char *p = NULL; /*pointer to the field */
197 char *p1 = NULL; /*return field */
198
199 p = mr_conf_read(field_name);
200 if (p != NULL) {
201 mr_asprintf(p1, "%d", p);
202 }
203 return p1;
204}
205
206/*read float/double number after string str in the current file*/
207char *mr_conf_fread(const char *field_name) {
208 char *p = NULL; /*pointer to the field */
209 char *p1 = NULL; /*return field */
210
211 p = mr_conf_read(field_name);
212 if (p != NULL) {
213 mr_asprintf(p1, "%f", p);
214 }
215 return p1;
216}
217
218
219/*
220*/
221char *mr_conf_sread(const char *field_name) {
222 char *p = NULL; /*pointer to the field */
223 char *q = NULL; /*pointer to the field */
224 char *r = NULL; /*pointer to the field */
225 char *ret = NULL; /*return value */
226 int size = 0; /*size of returned string */
227 int i = 0;
228
229 ret = NULL;
230
231 p = mr_conf_read(field_name);
232 if (p == NULL) {
233 return(p);
234 }
235 mr_asprintf(q, "%s", p);
236
237 if (*p != '"') {
238 mr_conf_error_msg(MRCONF_STRING_QUOTE, field_name);
239 return (NULL);
240 }
241 p++;
242
243 /* trunk at first \n */
244 r = index(q,'\n');
245 r--;
246 if (*r != '"') {
247 mr_conf_error_msg(MRCONF_STRING_QUOTE, field_name);
248 return (NULL);
249 }
250 r--;
251
252 size = r-q+1;
253 /*copy filtered data to the buffer */
254 ret = (char *) mr_malloc(sizeof(char) * (size));
255 while (i < size - 1) {
256 ret[i] = *p;
257 i++;
258 p++;
259 }
260
261 ret[i] = (char) 0; /* and set its length */
262 mr_free(q);
263
264 return ret;
265}
266
267/*read boolean after string str in the current file*/
268char *mr_conf_bread(const char *field_name) {
269 char *p = NULL; /*pointer to the field */
270 char *p1 = NULL; /*pointer to the field */
271
272 p = mr_conf_read(field_name);
273 if (p != NULL) {
274 /* match if yes/true/1 */
275 if ((strncasecmp(p, "y" , (size_t)1) == 0) ||
276 (strncasecmp(p, "t" , (size_t)1) == 0) ||
277 (strncasecmp(p, "1" , (size_t)1) == 0)) {
278 mr_asprintf(p1, "%d", TRUE);
279 } else {
280 mr_asprintf(p1, "%d", FALSE);
281 }
282 }
283 return p1;
284}
285
286/* Convert a string with decimal value of TRUE/FALSE in boolean */
287bool mr_atob(const char *str) {
288 bool ret = FALSE;
289 char *p = NULL;
290
291 mr_asprintf(p, "%d", FALSE);
292 if (strcmp(str,p) != 0) {
293 ret = TRUE;
294 }
295 mr_free(p);
296 return(ret);
297}
298
299/*removes all comments from the buffer*/
300static void mr_conf_remove_comments(void) {
301 char *tmp_buf; /*temporary buffer without comments */
302 size_t length /*initial length */ ;
303 size_t i; /*iterator */
304 size_t k; /*conditioned iterator for tmp_buffer */
305 bool found_quote = FALSE;
306 bool found_comment = FALSE;
307
308 length = strlen(buffer);
309
310 /*sizing the new chain */
311 k = 0;
312 i = 0;
313 while (i < length) {
314 /* Handle quotes to detect strings */
315 if ((buffer[i] == '"') && (! found_comment)) {
316 if (found_quote) {
317 found_quote = FALSE;
318 } else {
319 found_quote = TRUE;
320 }
321 }
322 /* Handle start of comment - only when not in a string */
323 if (buffer[i] == MRCONF_COMM_CHAR) {
324 if (found_quote) {
325 found_comment = FALSE;
326 } else {
327 found_comment = TRUE;
328 }
329 }
330 /* Comments end with EOL */
331 if (buffer[i] == '\n') {
332 found_comment = FALSE;
333 }
334 if (! found_comment) {
335 k++;
336 i++;
337 } else {
338 /* Skip comment */
339 while ((buffer[i] != '\n') && (buffer[i] != (char) 0)) {
340 i++;
341 }
342 if (buffer[i] == (char) 0) {
343 mr_conf_error_msg(MRCONF_STRING_ENDQUOTE, buffer);
344 }
345 }
346 }
347 /* k is new buffer length now */
348 tmp_buf = (char *) mr_malloc(sizeof(char) * (k + 1));
349
350 k = 0;
351 i = 0;
352 while (i < length) {
353 if (buffer[i] == '"') {
354 if (found_quote) {
355 found_quote = FALSE;
356 } else {
357 found_quote = TRUE;
358 }
359 }
360 if ((buffer[i] != MRCONF_COMM_CHAR) || (found_quote)) {
361 tmp_buf[k++] = buffer[i++];
362 } else {
363 /* Skip comment as it's not inside a string */
364 while ((buffer[i] != '\n') && (buffer[i] != (char) 0)) {
365 i++;
366 }
367 }
368 }
369 tmp_buf[k] = (char) 0; /*and set its length */
370
371 mr_free(buffer);
372 /*copy filtered data to the buffer */
373 buffer = tmp_buf;
374}
375
376static int mr_conf_check_int_flag(const int flag) {
377 return (flag & internal_flags);
378}
379
380static void mr_conf_set_int_flag(const int flag) {
381 internal_flags = flag | internal_flags;
382}
383
384static void mr_conf_drop_int_flag(const int flag) {
385 internal_flags = (~flag) & internal_flags;
386}
387
388
389/*local function to define size of a file. Return 0 for mistake*/
390static size_t mr_conf_filesize(const char *name) {
391 FILE *F = fopen(name, "r"); /*file to open */
392 size_t length; /*number to return */
393
394 if (F == NULL) {
395 return 0;
396 }
397
398 fseek(F, 0, SEEK_END); /*set position to the end of file */
399 length = ftell(F); /*define number of position=> this is its
400 length */
401 fclose(F);
402
403 return length;
404}
405
406/*output error message*/
407static void mr_conf_error_msg_int(int error_code, const char *add_line, int line, const char *file) {
408 if ((mr_conf_flags & MRCONF_FLAG_VERBOSE)) { /*if verbose mode */
409 switch (error_code) {
410 case MRCONF_BAD_FILE:
411 mr_msg_int(1,line,file,"%s (%s) %s %s", MRCONF_STR_ERROR, mr_conf_filename, MRCONF_STR_BAD_FILE,
412 add_line);
413 break;
414
415 case MRCONF_READING_FAILED:
416 mr_msg_int(1,line,file,"%s (%s) %s", MRCONF_STR_ERROR, mr_conf_filename, MRCONF_STR_READING_FAILED);
417 break;
418
419 case MRCONF_FIELD_NOT_FOUND:
420 mr_msg_int(1,line,file,"%s (%s) %s \"%s\"", MRCONF_STR_WARNING, mr_conf_filename, MRCONF_STR_FIELD_NOT_FOUND, add_line);
421 break;
422
423 case MRCONF_FIELD_NO_VALUE:
424 mr_msg_int(1,line,file,"%s (%s) %s \"%s\"", MRCONF_STR_ERROR, mr_conf_filename, MRCONF_STR_FIELD_NO_VALUE, add_line);
425 mr_msg_int(1,line,file,"%s (%s) %s", MRCONF_STR_WARNING, mr_conf_filename, MRCONF_STR_IGNORE);
426 break;
427
428 case MRCONF_CLOSE_BUT_NOT_OPEN:
429 mr_msg_int(1,line,file,"%s (%s) %s", MRCONF_STR_WARNING, mr_conf_filename, MRCONF_STR_CLOSE_BUT_NOT_OPEN);
430 break;
431
432 case MRCONF_CALL_BUT_NOT_OPEN:
433 mr_msg_int(1,line,file,"%s (%s) %s", MRCONF_STR_WARNING, mr_conf_filename, MRCONF_STR_CALL_BUT_NOT_OPEN);
434 break;
435
436 case MRCONF_OPEN_OPENED:
437 mr_msg_int(1,line,file,"%s (%s) %s", MRCONF_STR_ERROR, mr_conf_filename, MRCONF_STR_OPEN_OPENED);
438 break;
439
440 case MRCONF_STRING_QUOTE:
441 mr_msg_int(1,line,file,"%s: %s (%s) %s", add_line, MRCONF_STR_ERROR, mr_conf_filename, MRCONF_STR_STRING_QUOTE);
442 break;
443
444 case MRCONF_STRING_ENDQUOTE:
445 mr_msg_int(1,line,file,"%s: %s (%s) %s", add_line, MRCONF_STR_ERROR, mr_conf_filename, MRCONF_STR_STRING_ENDQUOTE);
446 break;
447
448 default:
449 mr_msg_int(1,line,file,"%s (%s) %s", MRCONF_STR_ERROR, mr_conf_filename, MRCONF_STR_DEFAULT_ERROR);
450 break;
451 }
452 }
453}
Note: See TracBrowser for help on using the repository browser.