xref: /dflybsd-src/stand/lib/environment.c (revision 479ab7f0492f2a51b48e8537e4f1dc686fc6014b)
1*479ab7f0SSascha Wildner /*
2*479ab7f0SSascha Wildner  * Copyright (c) 1998 Michael Smith.
3*479ab7f0SSascha Wildner  * All rights reserved.
4*479ab7f0SSascha Wildner  *
5*479ab7f0SSascha Wildner  * Redistribution and use in source and binary forms, with or without
6*479ab7f0SSascha Wildner  * modification, are permitted provided that the following conditions
7*479ab7f0SSascha Wildner  * are met:
8*479ab7f0SSascha Wildner  * 1. Redistributions of source code must retain the above copyright
9*479ab7f0SSascha Wildner  *    notice, this list of conditions and the following disclaimer.
10*479ab7f0SSascha Wildner  * 2. Redistributions in binary form must reproduce the above copyright
11*479ab7f0SSascha Wildner  *    notice, this list of conditions and the following disclaimer in the
12*479ab7f0SSascha Wildner  *    documentation and/or other materials provided with the distribution.
13*479ab7f0SSascha Wildner  *
14*479ab7f0SSascha Wildner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*479ab7f0SSascha Wildner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*479ab7f0SSascha Wildner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*479ab7f0SSascha Wildner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*479ab7f0SSascha Wildner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*479ab7f0SSascha Wildner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*479ab7f0SSascha Wildner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*479ab7f0SSascha Wildner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*479ab7f0SSascha Wildner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*479ab7f0SSascha Wildner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*479ab7f0SSascha Wildner  * SUCH DAMAGE.
25*479ab7f0SSascha Wildner  *
26*479ab7f0SSascha Wildner  * $FreeBSD: src/lib/libstand/environment.c,v 1.3.2.1 2000/09/10 01:24:16 ps Exp $
27*479ab7f0SSascha Wildner  * $DragonFly: src/lib/libstand/environment.c,v 1.2 2003/06/17 04:26:51 dillon Exp $
28*479ab7f0SSascha Wildner  *
29*479ab7f0SSascha Wildner  */
30*479ab7f0SSascha Wildner 
31*479ab7f0SSascha Wildner /*
32*479ab7f0SSascha Wildner  * Manage an environment-like space in which string variables may be stored.
33*479ab7f0SSascha Wildner  * Provide support for some method-like operations for setting/retrieving
34*479ab7f0SSascha Wildner  * variables in order to allow some type strength.
35*479ab7f0SSascha Wildner  */
36*479ab7f0SSascha Wildner 
37*479ab7f0SSascha Wildner #include "stand.h"
38*479ab7f0SSascha Wildner 
39*479ab7f0SSascha Wildner #include <string.h>
40*479ab7f0SSascha Wildner 
41*479ab7f0SSascha Wildner static void	env_discard(struct env_var *ev);
42*479ab7f0SSascha Wildner 
43*479ab7f0SSascha Wildner struct env_var	*environ = NULL;
44*479ab7f0SSascha Wildner 
45*479ab7f0SSascha Wildner /*
46*479ab7f0SSascha Wildner  * Look up (name) and return it's env_var structure.
47*479ab7f0SSascha Wildner  */
48*479ab7f0SSascha Wildner struct env_var	*
env_getenv(const char * name)49*479ab7f0SSascha Wildner env_getenv(const char *name)
50*479ab7f0SSascha Wildner {
51*479ab7f0SSascha Wildner     struct env_var	*ev;
52*479ab7f0SSascha Wildner 
53*479ab7f0SSascha Wildner     for (ev = environ; ev != NULL; ev = ev->ev_next)
54*479ab7f0SSascha Wildner 	if (!strcmp(ev->ev_name, name))
55*479ab7f0SSascha Wildner 	    break;
56*479ab7f0SSascha Wildner     return(ev);
57*479ab7f0SSascha Wildner }
58*479ab7f0SSascha Wildner 
59*479ab7f0SSascha Wildner /*
60*479ab7f0SSascha Wildner  * Some notes:
61*479ab7f0SSascha Wildner  *
62*479ab7f0SSascha Wildner  * If the EV_VOLATILE flag is set, a copy of the variable is made.
63*479ab7f0SSascha Wildner  * If EV_DYNAMIC is set, the the variable has been allocated with
64*479ab7f0SSascha Wildner  * malloc and ownership transferred to the environment.
65*479ab7f0SSascha Wildner  * If (value) is NULL, the variable is set but has no value.
66*479ab7f0SSascha Wildner  */
67*479ab7f0SSascha Wildner int
env_setenv(const char * name,int flags,const void * value,ev_sethook_t sethook,ev_unsethook_t unsethook)68*479ab7f0SSascha Wildner env_setenv(const char *name, int flags, const void *value,
69*479ab7f0SSascha Wildner 	   ev_sethook_t sethook, ev_unsethook_t unsethook)
70*479ab7f0SSascha Wildner {
71*479ab7f0SSascha Wildner     struct env_var	*ev, *curr, *last;
72*479ab7f0SSascha Wildner 
73*479ab7f0SSascha Wildner     if ((ev = env_getenv(name)) != NULL) {
74*479ab7f0SSascha Wildner 	/*
75*479ab7f0SSascha Wildner 	 * If there's a set hook, let it do the work (unless we are working
76*479ab7f0SSascha Wildner 	 * for one already.
77*479ab7f0SSascha Wildner 	 */
78*479ab7f0SSascha Wildner 	if ((ev->ev_sethook != NULL) && !(flags & EV_NOHOOK))
79*479ab7f0SSascha Wildner 	    return(ev->ev_sethook(ev, flags, value));
80*479ab7f0SSascha Wildner     } else {
81*479ab7f0SSascha Wildner 
82*479ab7f0SSascha Wildner 	/*
83*479ab7f0SSascha Wildner 	 * New variable; create and sort into list
84*479ab7f0SSascha Wildner 	 */
85*479ab7f0SSascha Wildner 	ev = malloc(sizeof(struct env_var));
86*479ab7f0SSascha Wildner 	ev->ev_name = strdup(name);
87*479ab7f0SSascha Wildner 	ev->ev_value = NULL;
88*479ab7f0SSascha Wildner 	/* hooks can only be set when the variable is instantiated */
89*479ab7f0SSascha Wildner 	ev->ev_sethook = sethook;
90*479ab7f0SSascha Wildner 	ev->ev_unsethook = unsethook;
91*479ab7f0SSascha Wildner 
92*479ab7f0SSascha Wildner 	/* Sort into list */
93*479ab7f0SSascha Wildner 	ev->ev_prev = NULL;
94*479ab7f0SSascha Wildner 	ev->ev_next = NULL;
95*479ab7f0SSascha Wildner 	/* Search for the record to insert before */
96*479ab7f0SSascha Wildner 	for (last = NULL, curr = environ;
97*479ab7f0SSascha Wildner 	     curr != NULL;
98*479ab7f0SSascha Wildner 	     last = curr, curr = curr->ev_next) {
99*479ab7f0SSascha Wildner 
100*479ab7f0SSascha Wildner 	    if (strcmp(ev->ev_name, curr->ev_name) < 0) {
101*479ab7f0SSascha Wildner 		if (curr->ev_prev) {
102*479ab7f0SSascha Wildner 		    curr->ev_prev->ev_next = ev;
103*479ab7f0SSascha Wildner 		} else {
104*479ab7f0SSascha Wildner 		    environ = ev;
105*479ab7f0SSascha Wildner 		}
106*479ab7f0SSascha Wildner 		ev->ev_next = curr;
107*479ab7f0SSascha Wildner 		ev->ev_prev = curr->ev_prev;
108*479ab7f0SSascha Wildner 		curr->ev_prev = ev;
109*479ab7f0SSascha Wildner 		break;
110*479ab7f0SSascha Wildner 	    }
111*479ab7f0SSascha Wildner 	}
112*479ab7f0SSascha Wildner 	if (curr == NULL) {
113*479ab7f0SSascha Wildner 	    if (last == NULL) {
114*479ab7f0SSascha Wildner 		environ = ev;
115*479ab7f0SSascha Wildner 	    } else {
116*479ab7f0SSascha Wildner 		last->ev_next = ev;
117*479ab7f0SSascha Wildner 		ev->ev_prev = last;
118*479ab7f0SSascha Wildner 	    }
119*479ab7f0SSascha Wildner 	}
120*479ab7f0SSascha Wildner     }
121*479ab7f0SSascha Wildner 
122*479ab7f0SSascha Wildner     /* If there is data in the variable, discard it */
123*479ab7f0SSascha Wildner     if (ev->ev_value != NULL)
124*479ab7f0SSascha Wildner 	free(ev->ev_value);
125*479ab7f0SSascha Wildner 
126*479ab7f0SSascha Wildner     /* If we have a new value, use it */
127*479ab7f0SSascha Wildner     if (flags & EV_VOLATILE) {
128*479ab7f0SSascha Wildner 	ev->ev_value = strdup(value);
129*479ab7f0SSascha Wildner     } else {
130*479ab7f0SSascha Wildner 	ev->ev_value = (char *)value;
131*479ab7f0SSascha Wildner     }
132*479ab7f0SSascha Wildner 
133*479ab7f0SSascha Wildner     /* Keep the flag components that are relevant */
134*479ab7f0SSascha Wildner     ev->ev_flags = flags & (EV_DYNAMIC);
135*479ab7f0SSascha Wildner 
136*479ab7f0SSascha Wildner     return(0);
137*479ab7f0SSascha Wildner }
138*479ab7f0SSascha Wildner 
139*479ab7f0SSascha Wildner char *
getenv(const char * name)140*479ab7f0SSascha Wildner getenv(const char *name)
141*479ab7f0SSascha Wildner {
142*479ab7f0SSascha Wildner     struct env_var	*ev;
143*479ab7f0SSascha Wildner 
144*479ab7f0SSascha Wildner     /* Set but no value gives empty string */
145*479ab7f0SSascha Wildner     if ((ev = env_getenv(name)) != NULL) {
146*479ab7f0SSascha Wildner 	if (ev->ev_value != NULL)
147*479ab7f0SSascha Wildner 	    return(ev->ev_value);
148*479ab7f0SSascha Wildner 	return("");
149*479ab7f0SSascha Wildner     }
150*479ab7f0SSascha Wildner     return(NULL);
151*479ab7f0SSascha Wildner }
152*479ab7f0SSascha Wildner 
153*479ab7f0SSascha Wildner int
setenv(const char * name,const char * value,int overwrite)154*479ab7f0SSascha Wildner setenv(const char *name, const char *value, int overwrite)
155*479ab7f0SSascha Wildner {
156*479ab7f0SSascha Wildner     /* No guarantees about state, always assume volatile */
157*479ab7f0SSascha Wildner     if (overwrite || (env_getenv(name) == NULL))
158*479ab7f0SSascha Wildner 	return(env_setenv(name, EV_VOLATILE, value, NULL, NULL));
159*479ab7f0SSascha Wildner     return(0);
160*479ab7f0SSascha Wildner }
161*479ab7f0SSascha Wildner 
162*479ab7f0SSascha Wildner int
putenv(const char * string)163*479ab7f0SSascha Wildner putenv(const char *string)
164*479ab7f0SSascha Wildner {
165*479ab7f0SSascha Wildner     char	*value, *copy;
166*479ab7f0SSascha Wildner     int		result;
167*479ab7f0SSascha Wildner 
168*479ab7f0SSascha Wildner     copy = strdup(string);
169*479ab7f0SSascha Wildner     if ((value = strchr(copy, '=')) != NULL)
170*479ab7f0SSascha Wildner 	*(value++) = 0;
171*479ab7f0SSascha Wildner     result = setenv(copy, value, 1);
172*479ab7f0SSascha Wildner     free(copy);
173*479ab7f0SSascha Wildner     return(result);
174*479ab7f0SSascha Wildner }
175*479ab7f0SSascha Wildner 
176*479ab7f0SSascha Wildner int
unsetenv(const char * name)177*479ab7f0SSascha Wildner unsetenv(const char *name)
178*479ab7f0SSascha Wildner {
179*479ab7f0SSascha Wildner     struct env_var	*ev;
180*479ab7f0SSascha Wildner     int			err;
181*479ab7f0SSascha Wildner 
182*479ab7f0SSascha Wildner     err = 0;
183*479ab7f0SSascha Wildner     if ((ev = env_getenv(name)) == NULL) {
184*479ab7f0SSascha Wildner 	err = ENOENT;
185*479ab7f0SSascha Wildner     } else {
186*479ab7f0SSascha Wildner 	if (ev->ev_unsethook != NULL)
187*479ab7f0SSascha Wildner 	    err = ev->ev_unsethook(ev);
188*479ab7f0SSascha Wildner 	if (err == 0) {
189*479ab7f0SSascha Wildner 	    env_discard(ev);
190*479ab7f0SSascha Wildner 	}
191*479ab7f0SSascha Wildner     }
192*479ab7f0SSascha Wildner     return(err);
193*479ab7f0SSascha Wildner }
194*479ab7f0SSascha Wildner 
195*479ab7f0SSascha Wildner static void
env_discard(struct env_var * ev)196*479ab7f0SSascha Wildner env_discard(struct env_var *ev)
197*479ab7f0SSascha Wildner {
198*479ab7f0SSascha Wildner     if (ev->ev_prev)
199*479ab7f0SSascha Wildner 	ev->ev_prev->ev_next = ev->ev_next;
200*479ab7f0SSascha Wildner     if (ev->ev_next)
201*479ab7f0SSascha Wildner 	ev->ev_next->ev_prev = ev->ev_prev;
202*479ab7f0SSascha Wildner     if (environ == ev)
203*479ab7f0SSascha Wildner 	environ = ev->ev_next;
204*479ab7f0SSascha Wildner     free(ev->ev_name);
205*479ab7f0SSascha Wildner     if (ev->ev_flags & EV_DYNAMIC)
206*479ab7f0SSascha Wildner 	free(ev->ev_value);
207*479ab7f0SSascha Wildner     free(ev);
208*479ab7f0SSascha Wildner }
209*479ab7f0SSascha Wildner 
210*479ab7f0SSascha Wildner int
env_noset(struct env_var * ev,int flags,const void * value)211*479ab7f0SSascha Wildner env_noset(struct env_var *ev, int flags, const void *value)
212*479ab7f0SSascha Wildner {
213*479ab7f0SSascha Wildner     return(EPERM);
214*479ab7f0SSascha Wildner }
215*479ab7f0SSascha Wildner 
216*479ab7f0SSascha Wildner int
env_nounset(struct env_var * ev)217*479ab7f0SSascha Wildner env_nounset(struct env_var *ev)
218*479ab7f0SSascha Wildner {
219*479ab7f0SSascha Wildner     return(EPERM);
220*479ab7f0SSascha Wildner }
221