001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
100:
101:
102:
103:
104:
105:
106:
107:
108:
109:
110:
111:
112:
113:
114:
115:
116:
117:
118:
119:
120:
121:
122:
123:
124:
125:
126:
127:
128:
129:
130:
131:
132:
133:
134:
135:
136:
137:
138:
139:
140:
141:
142:
143:
144:
145:
146:
147:
148:
149:
150:
151:
152:
153:
154:
155:
156:
157:
158:
159:
160:
161:
162:
163:
164:
165:
166:
167:
168:
169:
170:
171:
172:
173:
174:
175:
176:
177:
178:
179:
180:
181:
182:
183:
184:
185:
186:
187:
188:
189:
190:
191:
192:
193:
194:
195:
196:
197:
198:
199:
200:
201:
202:
203:
204:
205:
206:
207:
208:
209:
210:
211:
212:
213:
214:
215:
216:
217:
218:
219:
220:
221:
222:
223:
224:
225:
226:
227:
228:
229:
230:
231:
232:
233:
234:
235:
236:
237:
238:
239:
240:
241:
242:
243:
244:
245:
246:
247:
248:
249:
250:
251:
252:
253:
254:
255:
256:
257:
258:
259:
260:
261:
262:
263:
264:
265:
266:
267:
268:
269:
270:
271:
272:
273:
274:
275:
276:
277:
278:
279:
280:
281:
282:
283:
284:
285:
286:
287:
288:
289:
290:
291:
292:
293:
294:
295:
296:
297:
298:
299:
300:
301:
302:
303:
304:
305:
306:
307:
308:
309:
310:
311:
312:
313:
314:
315:
316:
317:
318:
319:
320:
321:
322:
323:
324:
325:
326:
327:
328:
329:
330:
331:
332:
333:
334:
335:
336:
337:
338:
339:
340:
341:
342:
343:
344:
345:
346:
347:
348:
349:
350:
351:
352:
353:
354:
355:
356:
/*
* Copyright (c), Zeriph Enterprises
* All rights reserved.
*
* Contributor(s):
* Zechariah Perez, omni (at) zeriph (dot) com
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <omni/environment.hpp>
bool omni::environment::create_var(const std::string& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error creating environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
#if defined(OMNI_OS_WIN)
#if !defined(OMNI_WIN_API)
// sending an empty string to this function deletes the variable
return (::_putenv_s(name.c_str(), "") == 0);
#else
return (::SetEnvironmentVariableA(name.c_str(), "") != 0);
#endif
#else
return (::setenv(name.c_str(), "", 1) == 0);
#endif
}
bool omni::environment::create_var(const std::wstring& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error creating environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
#if defined(OMNI_OS_WIN)
#if !defined(OMNI_WIN_API)
// sending an empty string to this function deletes the variable
return (::_wputenv_s(name.c_str(), L"") == 0);
#else
return (::SetEnvironmentVariableW(name.c_str(), L"") != 0);
#endif
#else
return (::setenv(omni::string::to_string(name).c_str(), "", 1) == 0);
#endif
}
bool omni::environment::delete_var(const std::string& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error deleting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
#if defined(OMNI_OS_WIN)
#if !defined(OMNI_WIN_API)
// sending an empty string to this function deletes the variable
return (::_putenv_s(name.c_str(), "") == 0);
#else
return (::SetEnvironmentVariableA(name.c_str(), NULL) != 0);
#endif
#else
return (::unsetenv(name.c_str()) == 0);
#endif
}
bool omni::environment::delete_var(const std::wstring& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error deleting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
#if defined(OMNI_OS_WIN)
#if !defined(OMNI_WIN_API)
// sending an empty string to this function deletes the variable
return (::_wputenv_s(name.c_str(), L"") == 0);
#else
return (::SetEnvironmentVariableW(name.c_str(), NULL) != 0);
#endif
#else
std::string n = omni::string::to_string(name);
return (::unsetenv(n.c_str()) == 0);
#endif
}
std::string omni::environment::expand_vars(const std::string& vars)
{
if (vars.empty()) {
OMNI_ERR_RETV_FW("Error expanding environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
#if defined(OMNI_OS_WIN)
// #if defined(OMNI_WIN_API) // not applicable here
// The size of the lpSrc and lpDst buffers is limited to 32k.
char* cval = new char[OMNI_MAX_PATH_FW+1]();
if (::ExpandEnvironmentStringsA(vars.c_str(), cval, OMNI_MAX_PATH_FW) != 0) {
std::string ret(cval);
delete[] cval;
return ret;
}
delete[] cval;
#else
#if !defined(OMNI_ENV_WORDEXP) // default
/* DEV_NOTE: some platforms do not implement the GLIBC wordexp (like OpenBSD)
for many security reasons. As such it is not really a good idea to call this function
without validating the user input; this is here for a convenience function. */
std::string cmd = "echo \"" + vars + "\"";
FILE* fp = ::popen(cmd.c_str(), "r");
if (fp == NULL) {
OMNI_ERR_RETV_FW("Error expanding environment variable: failed to open pipe", omni::exceptions::pipe_exception(), omni::string_t())
}
char* cval = new char[FILENAME_MAX]();
std::string ret;
while (std::fgets(cval, FILENAME_MAX-1, fp) != NULL) { ret.append(cval); }
::pclose(fp);
delete[] cval;
return ret;
#else
wordexp_t env;
if (::wordexp(vars.c_str(), &env, 0) == 0) {
std::string ret;
char **w = env.we_wordv;
for (unsigned int i = 0; i < env.we_wordc; ++i) { ret.append(w[i]); }
::wordfree(&env);
return ret;
}
::wordfree(&env);
#endif
#endif
OMNI_ERRV_RETV_FW("Error expanding environment variable: ", OMNI_GLE_PRNT, omni::exceptions::environment_exception(static_cast<std::size_t>(OMNI_GLE)), omni::string_t())
}
std::wstring omni::environment::expand_vars(const std::wstring& vars)
{
if (vars.empty()) {
OMNI_ERR_RETV_FW("Error expanding environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), omni::string_t())
}
#if defined(OMNI_OS_WIN)
// #if defined(OMNI_WIN_API) // not applicable here
// The size of the lpSrc and lpDst buffers is limited to 32k.
wchar_t* cval = new wchar_t[OMNI_MAX_PATH_FW+1]();
if (::ExpandEnvironmentStringsW(vars.c_str(), cval, OMNI_MAX_PATH_FW) != 0) {
std::wstring ret(cval);
delete[] cval;
return ret;
}
delete[] cval;
#else
#if !defined(OMNI_ENV_WORDEXP) // default
/* DEV_NOTE: some platforms do not implement the GLIBC wordexp (like OpenBSD)
for many security reasons. As such it is not really a good idea to call this function
without validating the user input; this is here for a convenience function. */
std::string cmd = "echo \"" + omni::string::to_string(vars) + "\"";
FILE *fp = ::popen(cmd.c_str(), "r");
if (fp == NULL) {
OMNI_ERR_RETV_FW("Error expanding environment variable: failed to open pipe", omni::exceptions::pipe_exception(), omni::string_t())
}
char* cval = new char[FILENAME_MAX]();
std::string ret;
while (std::fgets(cval, FILENAME_MAX-1, fp) != NULL) { ret.append(cval); }
::pclose(fp);
delete[] cval;
return omni::string::to_wstring(ret);
#else
std::string v = omni::string::to_string(vars);
::wordexp_t env;
if (::wordexp(v.c_str(), &env, 0) == 0) {
std::string ret;
char **w = env.we_wordv;
for (unsigned int i = 0; i < env.we_wordc; ++i) { ret.append(w[i]); }
::wordfree(&env);
return omni::string::to_wstring(ret);
}
::wordfree(&env);
#endif
#endif
OMNI_ERRV_RETV_FW("Error expanding environment variable: ", OMNI_GLE_PRNT, omni::exceptions::environment_exception(static_cast<std::size_t>(OMNI_GLE)), omni::string_t())
}
std::string omni::environment::get_var(const std::string& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error getting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), omni::string_t())
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_API)
// The size of the lpSrc and lpDst buffers is limited to 32k.
char* cval = new char[OMNI_MAX_PATH_FW+1]();
if (::GetEnvironmentVariableA(name.c_str(), cval, OMNI_MAX_PATH_FW) != 0) {
std::string ret(cval);
delete[] cval;
return ret;
}
delete[] cval;
#else
std::size_t sz;
if (::getenv_s(&sz, NULL, 0, name.c_str()) == 0) {
if (sz != 0) {
char* rval = new char[sz]();
std::string ret;
if (::getenv_s(&sz, rval, sz, name.c_str()) == 0) {
ret = std::string(rval);
}
delete[] rval;
return ret;
}
}
#endif
#else
char* r = std::getenv(name.c_str());
if (r != NULL) { return std::string(r); }
#endif
OMNI_ERRV_RETV_FW("Error retrieving environment variable: ", OMNI_GLE_PRNT, omni::exceptions::environment_exception(static_cast<std::size_t>(OMNI_GLE)), omni::string_t())
}
std::wstring omni::environment::get_var(const std::wstring& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error getting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), omni::string_t())
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_API)
// The size of the lpSrc and lpDst buffers is limited to 32k.
wchar_t* cval = new wchar_t[OMNI_MAX_PATH_FW+1]();
if (::GetEnvironmentVariableW(name.c_str(), cval, OMNI_MAX_PATH_FW) != 0) {
std::wstring ret(cval);
delete[] cval;
return ret;
}
delete[] cval;
#else
std::size_t sz;
if (::_wgetenv_s(&sz, NULL, 0, name.c_str()) == 0) {
if (sz != 0) {
wchar_t* rval = new wchar_t[sz]();
std::wstring ret;
if (::_wgetenv_s(&sz, rval, sz, name.c_str()) == 0) {
ret = std::wstring(rval);
}
delete[] rval;
return ret;
}
}
#endif
#else
std::string v = omni::string::to_string(name);
char* r = std::getenv(v.c_str());
if (r != NULL) { return omni::string::to_wstring(r); }
#endif
OMNI_ERRV_RETV_FW("Error retrieving environment variable: ", OMNI_GLE_PRNT, omni::exceptions::environment_exception(static_cast<std::size_t>(OMNI_GLE)), omni::string_t())
}
bool omni::environment::set_var(const std::string& name, const std::string& val)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error setting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
if (val.empty()) {
OMNI_ERR_RETV_FW("Error setting environment variable: value cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
if (val.size() > OMNI_MAX_PATH_FW) {
OMNI_ERR_RETV_FW("Error setting environment variable: value cannot be greater than 32,767 characters", omni::exceptions::invalid_environment_variable(), false)
}
#if defined(OMNI_OS_WIN)
#if !defined(OMNI_WIN_API)
// sending an empty string to this function deletes the variable
return (::_putenv_s(name.c_str(), val.c_str()) == 0);
#else
return (::SetEnvironmentVariableA(name.c_str(), val.c_str()) != 0);
#endif
#else
// always overwrite
return (::setenv(name.c_str(), val.c_str(), 1) == 0);
#endif
}
bool omni::environment::set_var(const std::wstring& name, const std::wstring& val)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error setting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
if (val.empty()) {
OMNI_ERR_RETV_FW("Error setting environment variable: value cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
if (val.size() > OMNI_MAX_PATH_FW) {
OMNI_ERR_RETV_FW("Error setting environment variable: value cannot be greater than 32,767 characters", omni::exceptions::invalid_environment_variable(), false)
}
#if defined(OMNI_OS_WIN)
#if !defined(OMNI_WIN_API)
// sending an empty string to this function deletes the variable
return (::_wputenv_s(name.c_str(), val.c_str()) == 0);
#else
return (::SetEnvironmentVariableW(name.c_str(), val.c_str()) != 0);
#endif
#else
std::string n = omni::string::to_string(name);
std::string v = omni::string::to_string(val);
// always overwrite
return (::setenv(n.c_str(), v.c_str(), 1) == 0);
#endif
}
bool omni::environment::var_exists(const std::string& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error getting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
bool ret = false;
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_API)
// The size of the lpSrc and lpDst buffers is limited to 32k.
char* cval = new char[OMNI_MAX_PATH_FW+1]();
if (::GetEnvironmentVariableA(name.c_str(), cval, OMNI_MAX_PATH_FW) != 0) { ret = true; }
delete[] cval;
#else
std::size_t sz;
if (::getenv_s(&sz, NULL, 0, name.c_str()) == 0) {
ret = (sz != 0);
}
#endif
#else
char* r = std::getenv(name.c_str());
if (r != NULL) { ret = true; }
#endif
return ret;
}
bool omni::environment::var_exists(const std::wstring& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW("Error getting environment variable: name cannot be empty", omni::exceptions::invalid_environment_variable(), false)
}
bool ret = false;
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_API)
// The size of the lpSrc and lpDst buffers is limited to 32k.
wchar_t* cval = new wchar_t[OMNI_MAX_PATH_FW+1]();
if (::GetEnvironmentVariableW(name.c_str(), cval, OMNI_MAX_PATH_FW) != 0) { ret = true; }
delete[] cval;
#else
std::size_t sz;
if (::_wgetenv_s(&sz, NULL, 0, name.c_str()) == 0) {
ret = (sz != 0);
}
#endif
#else
std::string v = omni::string::to_string(name);
char* r = std::getenv(v.c_str());
if (r != NULL) { ret = true; }
#endif
return ret;
}