xref: /freebsd/lib/libutil/property.c (revision a54bb702d77b01653ff82e9f000dcafd10a9ec13)
1b704025fSJordan K. Hubbard /*
2b704025fSJordan K. Hubbard  *
3b704025fSJordan K. Hubbard  * Simple property list handling code.
4b704025fSJordan K. Hubbard  *
5b704025fSJordan K. Hubbard  * Copyright (c) 1998
6b704025fSJordan K. Hubbard  *	Jordan Hubbard.  All rights reserved.
7b704025fSJordan K. Hubbard  *
8b704025fSJordan K. Hubbard  * Redistribution and use in source and binary forms, with or without
9b704025fSJordan K. Hubbard  * modification, are permitted provided that the following conditions
10b704025fSJordan K. Hubbard  * are met:
11b704025fSJordan K. Hubbard  * 1. Redistributions of source code must retain the above copyright
12b704025fSJordan K. Hubbard  *    notice, this list of conditions and the following disclaimer,
13b704025fSJordan K. Hubbard  *    verbatim and that no modifications are made prior to this
14b704025fSJordan K. Hubbard  *    point in the file.
15b704025fSJordan K. Hubbard  * 2. Redistributions in binary form must reproduce the above copyright
16b704025fSJordan K. Hubbard  *    notice, this list of conditions and the following disclaimer in the
17b704025fSJordan K. Hubbard  *    documentation and/or other materials provided with the distribution.
18b704025fSJordan K. Hubbard  *
19b704025fSJordan K. Hubbard  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20b704025fSJordan K. Hubbard  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21b704025fSJordan K. Hubbard  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22b704025fSJordan K. Hubbard  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR HIS PETS BE LIABLE
23b704025fSJordan K. Hubbard  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24b704025fSJordan K. Hubbard  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25b704025fSJordan K. Hubbard  * OR SERVICES; LOSS OF USE, DATA, LIFE OR PROFITS; OR BUSINESS INTERRUPTION)
26b704025fSJordan K. Hubbard  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27b704025fSJordan K. Hubbard  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28b704025fSJordan K. Hubbard  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29b704025fSJordan K. Hubbard  * SUCH DAMAGE.
30b704025fSJordan K. Hubbard  */
31b704025fSJordan K. Hubbard 
328719c58fSMatthew Dillon #include <sys/cdefs.h>
338719c58fSMatthew Dillon __FBSDID("$FreeBSD$");
348719c58fSMatthew Dillon 
3569761016SJordan K. Hubbard #include <sys/types.h>
360ebec5d3SMark Murray #include <ctype.h>
370ebec5d3SMark Murray #include <err.h>
38b704025fSJordan K. Hubbard #include <libutil.h>
390ebec5d3SMark Murray #include <stdio.h>
400ebec5d3SMark Murray #include <stdlib.h>
410ebec5d3SMark Murray #include <string.h>
420ebec5d3SMark Murray #include <unistd.h>
43b704025fSJordan K. Hubbard 
44b704025fSJordan K. Hubbard static properties
45b704025fSJordan K. Hubbard property_alloc(char *name, char *value)
46b704025fSJordan K. Hubbard {
47b704025fSJordan K. Hubbard     properties n;
48b704025fSJordan K. Hubbard 
49779092a4SAndrey A. Chernov     if ((n = (properties)malloc(sizeof(struct _property))) == NULL)
50779092a4SAndrey A. Chernov 	return (NULL);
51b704025fSJordan K. Hubbard     n->next = NULL;
52779092a4SAndrey A. Chernov     if (name != NULL) {
53779092a4SAndrey A. Chernov 	if ((n->name = strdup(name)) == NULL) {
54779092a4SAndrey A. Chernov 	    free(n);
55779092a4SAndrey A. Chernov 	    return (NULL);
56779092a4SAndrey A. Chernov 	}
57779092a4SAndrey A. Chernov     } else
58779092a4SAndrey A. Chernov 	n->name = NULL;
59779092a4SAndrey A. Chernov     if (value != NULL) {
60779092a4SAndrey A. Chernov 	if ((n->value = strdup(value)) == NULL) {
61779092a4SAndrey A. Chernov 	    free(n->name);
62779092a4SAndrey A. Chernov 	    free(n);
63779092a4SAndrey A. Chernov 	    return (NULL);
64779092a4SAndrey A. Chernov 	}
65779092a4SAndrey A. Chernov     } else
66779092a4SAndrey A. Chernov 	n->value = NULL;
67779092a4SAndrey A. Chernov     return (n);
68b704025fSJordan K. Hubbard }
69b704025fSJordan K. Hubbard 
70b704025fSJordan K. Hubbard properties
7150dfa596SJordan K. Hubbard properties_read(int fd)
72b704025fSJordan K. Hubbard {
73b704025fSJordan K. Hubbard     properties head, ptr;
74f9f81f78SMurray Stokely     char hold_n[PROPERTY_MAX_NAME + 1];
75f9f81f78SMurray Stokely     char hold_v[PROPERTY_MAX_VALUE + 1];
76b704025fSJordan K. Hubbard     char buf[BUFSIZ * 4];
77b704025fSJordan K. Hubbard     int bp, n, v, max;
78a54bb702SJohn Baldwin     enum { LOOK, COMMENT, NAME, VALUE, MVALUE, COMMIT, FILL, STOP } state, last_state;
79efbcb4aeSJordan K. Hubbard     int ch = 0, blevel = 0;
80b704025fSJordan K. Hubbard 
81b704025fSJordan K. Hubbard     n = v = bp = max = 0;
82b704025fSJordan K. Hubbard     head = ptr = NULL;
83a54bb702SJohn Baldwin     state = last_state = LOOK;
84b704025fSJordan K. Hubbard     while (state != STOP) {
85b704025fSJordan K. Hubbard 	if (state != COMMIT) {
86a54bb702SJohn Baldwin 	    if (bp == max) {
87a54bb702SJohn Baldwin 		last_state = state;
88b704025fSJordan K. Hubbard 		state = FILL;
89a54bb702SJohn Baldwin 	    } else
90b704025fSJordan K. Hubbard 		ch = buf[bp++];
91b704025fSJordan K. Hubbard 	}
92b704025fSJordan K. Hubbard 	switch(state) {
93b704025fSJordan K. Hubbard 	case FILL:
9433a155e4SAndrey A. Chernov 	    if ((max = read(fd, buf, sizeof buf)) < 0) {
9533a155e4SAndrey A. Chernov 		properties_free(head);
9633a155e4SAndrey A. Chernov 		return (NULL);
9733a155e4SAndrey A. Chernov 	    }
9833a155e4SAndrey A. Chernov 	    if (max == 0) {
99b704025fSJordan K. Hubbard 		state = STOP;
10033a155e4SAndrey A. Chernov 	    } else {
101a54bb702SJohn Baldwin 		/*
102a54bb702SJohn Baldwin 		 * Restore the state from before the fill (which will be
103a54bb702SJohn Baldwin 		 * initialised to LOOK for the first FILL). This ensures that
104a54bb702SJohn Baldwin 		 * if we were part-way through eg., a VALUE state, when the
105a54bb702SJohn Baldwin 		 * buffer ran out, that the previous operation will be allowed
106a54bb702SJohn Baldwin 		 * to complete.
107a54bb702SJohn Baldwin 		 */
108a54bb702SJohn Baldwin 		state = last_state;
109b704025fSJordan K. Hubbard 		ch = buf[0];
110a54bb702SJohn Baldwin 		bp = 0;
111b704025fSJordan K. Hubbard 	    }
112a54bb702SJohn Baldwin 	    continue;
113b704025fSJordan K. Hubbard 
114b704025fSJordan K. Hubbard 	case LOOK:
115779092a4SAndrey A. Chernov 	    if (isspace((unsigned char)ch))
116b704025fSJordan K. Hubbard 		continue;
117b704025fSJordan K. Hubbard 	    /* Allow shell or lisp style comments */
118b704025fSJordan K. Hubbard 	    else if (ch == '#' || ch == ';') {
119b704025fSJordan K. Hubbard 		state = COMMENT;
120b704025fSJordan K. Hubbard 		continue;
121b704025fSJordan K. Hubbard 	    }
122779092a4SAndrey A. Chernov 	    else if (isalnum((unsigned char)ch) || ch == '_') {
123f9f81f78SMurray Stokely 		if (n >= PROPERTY_MAX_NAME) {
124b704025fSJordan K. Hubbard 		    n = 0;
125b704025fSJordan K. Hubbard 		    state = COMMENT;
126b704025fSJordan K. Hubbard 		}
127b704025fSJordan K. Hubbard 		else {
128b704025fSJordan K. Hubbard 		    hold_n[n++] = ch;
129b704025fSJordan K. Hubbard 		    state = NAME;
130b704025fSJordan K. Hubbard 		}
131b704025fSJordan K. Hubbard 	    }
132b704025fSJordan K. Hubbard 	    else
133b704025fSJordan K. Hubbard 		state = COMMENT;	/* Ignore the rest of the line */
134b704025fSJordan K. Hubbard 	    break;
135b704025fSJordan K. Hubbard 
136b704025fSJordan K. Hubbard 	case COMMENT:
137b704025fSJordan K. Hubbard 	    if (ch == '\n')
138b704025fSJordan K. Hubbard 		state = LOOK;
139b704025fSJordan K. Hubbard 	    break;
140b704025fSJordan K. Hubbard 
141b704025fSJordan K. Hubbard 	case NAME:
142b704025fSJordan K. Hubbard 	    if (ch == '\n' || !ch) {
143b704025fSJordan K. Hubbard 		hold_n[n] = '\0';
144b704025fSJordan K. Hubbard 		hold_v[0] = '\0';
145b704025fSJordan K. Hubbard 		v = n = 0;
146b704025fSJordan K. Hubbard 		state = COMMIT;
147b704025fSJordan K. Hubbard 	    }
148779092a4SAndrey A. Chernov 	    else if (isspace((unsigned char)ch))
149b704025fSJordan K. Hubbard 		continue;
150b704025fSJordan K. Hubbard 	    else if (ch == '=') {
151b704025fSJordan K. Hubbard 		hold_n[n] = '\0';
152b704025fSJordan K. Hubbard 		v = n = 0;
153b704025fSJordan K. Hubbard 		state = VALUE;
154b704025fSJordan K. Hubbard 	    }
155b704025fSJordan K. Hubbard 	    else
156b704025fSJordan K. Hubbard 		hold_n[n++] = ch;
157b704025fSJordan K. Hubbard 	    break;
158b704025fSJordan K. Hubbard 
159b704025fSJordan K. Hubbard 	case VALUE:
16040863abaSMurray Stokely 	    if (v == 0 && ch == '\n') {
16140863abaSMurray Stokely 	        hold_v[v] = '\0';
16240863abaSMurray Stokely 	        v = n = 0;
16340863abaSMurray Stokely 	        state = COMMIT;
16440863abaSMurray Stokely 	    }
165779092a4SAndrey A. Chernov 	    else if (v == 0 && isspace((unsigned char)ch))
166b704025fSJordan K. Hubbard 		continue;
167efbcb4aeSJordan K. Hubbard 	    else if (ch == '{') {
168b704025fSJordan K. Hubbard 		state = MVALUE;
169efbcb4aeSJordan K. Hubbard 		++blevel;
170efbcb4aeSJordan K. Hubbard 	    }
171b704025fSJordan K. Hubbard 	    else if (ch == '\n' || !ch) {
172b704025fSJordan K. Hubbard 		hold_v[v] = '\0';
173b704025fSJordan K. Hubbard 		v = n = 0;
174b704025fSJordan K. Hubbard 		state = COMMIT;
175b704025fSJordan K. Hubbard 	    }
176b704025fSJordan K. Hubbard 	    else {
177f9f81f78SMurray Stokely 		if (v >= PROPERTY_MAX_VALUE) {
178b704025fSJordan K. Hubbard 		    state = COMMENT;
179b704025fSJordan K. Hubbard 		    v = n = 0;
180b704025fSJordan K. Hubbard 		    break;
181b704025fSJordan K. Hubbard 		}
182b704025fSJordan K. Hubbard 		else
183b704025fSJordan K. Hubbard 		    hold_v[v++] = ch;
184b704025fSJordan K. Hubbard 	    }
185b704025fSJordan K. Hubbard 	    break;
186b704025fSJordan K. Hubbard 
187b704025fSJordan K. Hubbard 	case MVALUE:
188b704025fSJordan K. Hubbard 	    /* multiline value */
189f9f81f78SMurray Stokely 	    if (v >= PROPERTY_MAX_VALUE) {
190efbcb4aeSJordan K. Hubbard 		warn("properties_read: value exceeds max length");
191b704025fSJordan K. Hubbard 		state = COMMENT;
192b704025fSJordan K. Hubbard 		n = v = 0;
193b704025fSJordan K. Hubbard 	    }
194efbcb4aeSJordan K. Hubbard 	    else if (ch == '}' && !--blevel) {
195b704025fSJordan K. Hubbard 		hold_v[v] = '\0';
196b704025fSJordan K. Hubbard 		v = n = 0;
197b704025fSJordan K. Hubbard 		state = COMMIT;
198b704025fSJordan K. Hubbard 	    }
199efbcb4aeSJordan K. Hubbard 	    else {
200b704025fSJordan K. Hubbard 		hold_v[v++] = ch;
201efbcb4aeSJordan K. Hubbard 		if (ch == '{')
202efbcb4aeSJordan K. Hubbard 		    ++blevel;
203efbcb4aeSJordan K. Hubbard 	    }
204b704025fSJordan K. Hubbard 	    break;
205b704025fSJordan K. Hubbard 
206b704025fSJordan K. Hubbard 	case COMMIT:
207779092a4SAndrey A. Chernov 	    if (head == NULL) {
208779092a4SAndrey A. Chernov 		if ((head = ptr = property_alloc(hold_n, hold_v)) == NULL)
209779092a4SAndrey A. Chernov 		    return (NULL);
210779092a4SAndrey A. Chernov 	    } else {
211779092a4SAndrey A. Chernov 		if ((ptr->next = property_alloc(hold_n, hold_v)) == NULL) {
212779092a4SAndrey A. Chernov 		    properties_free(head);
213779092a4SAndrey A. Chernov 		    return (NULL);
214779092a4SAndrey A. Chernov 		}
215b704025fSJordan K. Hubbard 		ptr = ptr->next;
216b704025fSJordan K. Hubbard 	    }
217b704025fSJordan K. Hubbard 	    state = LOOK;
218b704025fSJordan K. Hubbard 	    v = n = 0;
219b704025fSJordan K. Hubbard 	    break;
220b704025fSJordan K. Hubbard 
221b704025fSJordan K. Hubbard 	case STOP:
222b704025fSJordan K. Hubbard 	    /* we don't handle this here, but this prevents warnings */
223b704025fSJordan K. Hubbard 	    break;
224b704025fSJordan K. Hubbard 	}
225b704025fSJordan K. Hubbard     }
2265fe03abaSAndrey A. Chernov     if (head == NULL && (head = property_alloc(NULL, NULL)) == NULL)
2275fe03abaSAndrey A. Chernov 	return (NULL);
2285fe03abaSAndrey A. Chernov 
229779092a4SAndrey A. Chernov     return (head);
230b704025fSJordan K. Hubbard }
231b704025fSJordan K. Hubbard 
232b704025fSJordan K. Hubbard char *
233b704025fSJordan K. Hubbard property_find(properties list, const char *name)
234b704025fSJordan K. Hubbard {
2355fe03abaSAndrey A. Chernov     if (list == NULL || name == NULL || !name[0])
2365fe03abaSAndrey A. Chernov 	return (NULL);
2375fe03abaSAndrey A. Chernov     while (list != NULL) {
2385fe03abaSAndrey A. Chernov 	if (list->name != NULL && strcmp(list->name, name) == 0)
2395fe03abaSAndrey A. Chernov 	    return (list->value);
240b704025fSJordan K. Hubbard 	list = list->next;
241b704025fSJordan K. Hubbard     }
2425fe03abaSAndrey A. Chernov     return (NULL);
243b704025fSJordan K. Hubbard }
244b704025fSJordan K. Hubbard 
245b704025fSJordan K. Hubbard void
246b704025fSJordan K. Hubbard properties_free(properties list)
247b704025fSJordan K. Hubbard {
248b704025fSJordan K. Hubbard     properties tmp;
249b704025fSJordan K. Hubbard 
250b704025fSJordan K. Hubbard     while (list) {
251b704025fSJordan K. Hubbard 	tmp = list->next;
252b704025fSJordan K. Hubbard 	if (list->name)
253b704025fSJordan K. Hubbard 	    free(list->name);
254b704025fSJordan K. Hubbard 	if (list->value)
255b704025fSJordan K. Hubbard 	    free(list->value);
256b704025fSJordan K. Hubbard 	free(list);
257b704025fSJordan K. Hubbard 	list = tmp;
258b704025fSJordan K. Hubbard     }
259b704025fSJordan K. Hubbard }
260