VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/win/env-win.cpp@ 95084

Last change on this file since 95084 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 8.2 KB
Line 
1/* $Id: env-win.cpp 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * IPRT - Environment, Posix.
4 */
5
6/*
7 * Copyright (C) 2006-2022 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#include <iprt/env.h>
32
33#include <iprt/alloca.h>
34#include <iprt/assert.h>
35#include <iprt/err.h>
36#include <iprt/string.h>
37#include <iprt/mem.h>
38#include <iprt/utf16.h>
39
40#include <stdlib.h>
41#include <errno.h>
42
43
44RTDECL(bool) RTEnvExistsBad(const char *pszVar)
45{
46 return RTEnvGetBad(pszVar) != NULL;
47}
48
49
50RTDECL(bool) RTEnvExist(const char *pszVar)
51{
52 return RTEnvExistsBad(pszVar);
53}
54
55
56RTDECL(bool) RTEnvExistsUtf8(const char *pszVar)
57{
58 AssertReturn(strchr(pszVar, '=') == NULL, false);
59
60 PRTUTF16 pwszVar;
61 int rc = RTStrToUtf16(pszVar, &pwszVar);
62 AssertRCReturn(rc, false);
63 bool fRet = _wgetenv(pwszVar) != NULL;
64 RTUtf16Free(pwszVar);
65 return fRet;
66}
67
68
69RTDECL(const char *) RTEnvGetBad(const char *pszVar)
70{
71 AssertReturn(strchr(pszVar, '=') == NULL, NULL);
72 return getenv(pszVar);
73}
74
75
76RTDECL(const char *) RTEnvGet(const char *pszVar)
77{
78 return RTEnvGetBad(pszVar);
79}
80
81RTDECL(int) RTEnvGetUtf8(const char *pszVar, char *pszValue, size_t cbValue, size_t *pcchActual)
82{
83 AssertPtrReturn(pszVar, VERR_INVALID_POINTER);
84 AssertPtrNullReturn(pszValue, VERR_INVALID_POINTER);
85 AssertReturn(pszValue || !cbValue, VERR_INVALID_PARAMETER);
86 AssertPtrNullReturn(pcchActual, VERR_INVALID_POINTER);
87 AssertReturn(pcchActual || (pszValue && cbValue), VERR_INVALID_PARAMETER);
88 AssertReturn(strchr(pszVar, '=') == NULL, VERR_ENV_INVALID_VAR_NAME);
89
90 if (pcchActual)
91 *pcchActual = 0;
92
93 PRTUTF16 pwszVar;
94 int rc = RTStrToUtf16(pszVar, &pwszVar);
95 AssertRCReturn(rc, rc);
96
97 /** @todo Consider _wgetenv_s or GetEnvironmentVariableW here to avoid the
98 * potential race with a concurrent _wputenv/_putenv. */
99 PCRTUTF16 pwszValue = _wgetenv(pwszVar);
100 RTUtf16Free(pwszVar);
101 if (pwszValue)
102 {
103 if (cbValue)
104 rc = RTUtf16ToUtf8Ex(pwszValue, RTSTR_MAX, &pszValue, cbValue, pcchActual);
105 else
106 rc = RTUtf16CalcUtf8LenEx(pwszValue, RTSTR_MAX, pcchActual);
107 }
108 else
109 rc = VERR_ENV_VAR_NOT_FOUND;
110 return rc;
111}
112
113
114RTDECL(int) RTEnvPutBad(const char *pszVarEqualValue)
115{
116 /** @todo putenv is a source memory leaks. deal with this on a per system basis. */
117 if (!putenv((char *)pszVarEqualValue))
118 return 0;
119 return RTErrConvertFromErrno(errno);
120}
121
122
123RTDECL(int) RTEnvPut(const char *pszVarEqualValue)
124{
125 return RTEnvPutBad(pszVarEqualValue);
126}
127
128
129RTDECL(int) RTEnvPutUtf8(const char *pszVarEqualValue)
130{
131 PRTUTF16 pwszVarEqualValue;
132 int rc = RTStrToUtf16(pszVarEqualValue, &pwszVarEqualValue);
133 if (RT_SUCCESS(rc))
134 {
135 if (!_wputenv(pwszVarEqualValue))
136 rc = VINF_SUCCESS;
137 else
138 rc = RTErrConvertFromErrno(errno);
139 RTUtf16Free(pwszVarEqualValue);
140 }
141 return rc;
142}
143
144
145
146RTDECL(int) RTEnvSetBad(const char *pszVar, const char *pszValue)
147{
148 AssertMsgReturn(strchr(pszVar, '=') == NULL, ("'%s'\n", pszVar), VERR_ENV_INVALID_VAR_NAME);
149
150 /* make a local copy and feed it to putenv. */
151 const size_t cchVar = strlen(pszVar);
152 const size_t cchValue = strlen(pszValue);
153 char *pszTmp = (char *)alloca(cchVar + cchValue + 2 + !*pszValue);
154 memcpy(pszTmp, pszVar, cchVar);
155 pszTmp[cchVar] = '=';
156 if (*pszValue)
157 memcpy(pszTmp + cchVar + 1, pszValue, cchValue + 1);
158 else
159 {
160 pszTmp[cchVar + 1] = ' '; /* wrong, but putenv will remove it otherwise. */
161 pszTmp[cchVar + 2] = '\0';
162 }
163
164 if (!putenv(pszTmp))
165 return 0;
166 return RTErrConvertFromErrno(errno);
167}
168
169
170RTDECL(int) RTEnvSet(const char *pszVar, const char *pszValue)
171{
172 return RTEnvSetBad(pszVar, pszValue);
173}
174
175
176/**
177 * Worker common to RTEnvSetUtf8() and rtEnvSetExWorker().
178 */
179int rtEnvSetUtf8Worker(const char *pchVar, size_t cchVar, const char *pszValue)
180{
181 size_t cwcVar;
182 int rc = RTStrCalcUtf16LenEx(pchVar, cchVar, &cwcVar);
183 if (RT_SUCCESS(rc))
184 {
185 size_t cwcValue;
186 rc = RTStrCalcUtf16LenEx(pszValue, RTSTR_MAX, &cwcValue);
187 if (RT_SUCCESS(rc))
188 {
189 PRTUTF16 pwszTmp = (PRTUTF16)RTMemTmpAlloc((cwcVar + 1 + cwcValue + 1) * sizeof(RTUTF16));
190 if (pwszTmp)
191 {
192 rc = RTStrToUtf16Ex(pchVar, cchVar, &pwszTmp, cwcVar + 1, NULL);
193 if (RT_SUCCESS(rc))
194 {
195 PRTUTF16 pwszTmpValue = &pwszTmp[cwcVar];
196 *pwszTmpValue++ = '=';
197 rc = RTStrToUtf16Ex(pszValue, RTSTR_MAX, &pwszTmpValue, cwcValue + 1, NULL);
198 if (RT_SUCCESS(rc))
199 {
200 if (!_wputenv(pwszTmp))
201 rc = VINF_SUCCESS;
202 else
203 rc = RTErrConvertFromErrno(errno);
204 }
205 }
206 RTMemTmpFree(pwszTmp);
207 }
208 else
209 rc = VERR_NO_TMP_MEMORY;
210 }
211 }
212 return rc;
213}
214
215
216RTDECL(int) RTEnvSetUtf8(const char *pszVar, const char *pszValue)
217{
218 size_t cchVar = strlen(pszVar);
219 AssertReturn(memchr(pszVar, '=', cchVar) == NULL, VERR_ENV_INVALID_VAR_NAME);
220 return rtEnvSetUtf8Worker(pszVar, cchVar, pszValue);
221}
222
223
224RTDECL(int) RTEnvUnsetBad(const char *pszVar)
225{
226 AssertReturn(strchr(pszVar, '=') == NULL, VERR_ENV_INVALID_VAR_NAME);
227
228 /*
229 * Check that it exists first.
230 */
231 if (!RTEnvExist(pszVar))
232 return VINF_ENV_VAR_NOT_FOUND;
233
234 /*
235 * Ok, try remove it.
236 */
237#ifdef RT_OS_WINDOWS
238 /* Use putenv(var=) since Windows does not have unsetenv(). */
239 size_t cchVar = strlen(pszVar);
240 char *pszBuf = (char *)alloca(cchVar + 2);
241 memcpy(pszBuf, pszVar, cchVar);
242 pszBuf[cchVar] = '=';
243 pszBuf[cchVar + 1] = '\0';
244
245 if (!putenv(pszBuf))
246 return VINF_SUCCESS;
247
248#else
249 /* This is the preferred function as putenv() like used above does neither work on Solaris nor on Darwin. */
250 if (!unsetenv((char*)pszVar))
251 return VINF_SUCCESS;
252#endif
253
254 return RTErrConvertFromErrno(errno);
255}
256
257
258RTDECL(int) RTEnvUnset(const char *pszVar)
259{
260 return RTEnvUnsetBad(pszVar);
261}
262
263
264RTDECL(int) RTEnvUnsetUtf8(const char *pszVar)
265{
266 AssertReturn(strchr(pszVar, '=') == NULL, VERR_ENV_INVALID_VAR_NAME);
267
268 size_t cwcVar;
269 int rc = RTStrCalcUtf16LenEx(pszVar, RTSTR_MAX, &cwcVar);
270 if (RT_SUCCESS(rc))
271 {
272 PRTUTF16 pwszTmp = (PRTUTF16)RTMemTmpAlloc((cwcVar + 1 + 1) * sizeof(RTUTF16));
273 if (pwszTmp)
274 {
275 rc = RTStrToUtf16Ex(pszVar, RTSTR_MAX, &pwszTmp, cwcVar + 1, NULL);
276 if (RT_SUCCESS(rc))
277 {
278 pwszTmp[cwcVar] = '=';
279 pwszTmp[cwcVar + 1] = '\0';
280 if (!_wputenv(pwszTmp))
281 rc = VINF_SUCCESS;
282 else
283 rc = RTErrConvertFromErrno(errno);
284 }
285 RTMemTmpFree(pwszTmp);
286 }
287 }
288 return rc;
289}
290
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette