/*
* This file is part of the Omni C++ framework
*
* Copyright (c) 2016, Zeriph Enterprises, LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of Zeriph, Zeriph Enterprises, LLC, nor the names
* of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* 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::name_empty_exception(),
false)
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_NO_WIN_API)
// sending an empty string to this function deletes the variable
return (::
_putenv_s(name.c_str(), name.c_str()) ==
0);
#else
const omni::char_t* n =
omni::string::util::to_string_t(name).c_str();
return (::
SetEnvironmentVariable(n, n) !=
0);
#endif
#else
return (::
setenv(name.c_str(), 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::name_empty_exception(),
false)
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_NO_WIN_API)
// sending an empty string to this function deletes the variable
return (::
_wputenv_s(name.c_str(), name.c_str()) ==
0);
#else
const omni::char_t* n =
omni::string::util::to_string_t(name).c_str();
return (::
SetEnvironmentVariable(n, n) !=
0);
#endif
#else
const char* n =
omni::string::util::to_string(name).c_str();
return (::
setenv(n, n,
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::name_empty_exception(),
false)
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_NO_WIN_API)
// sending an empty string to this function deletes the variable
return (::
_putenv_s(name.c_str(),
"") ==
0);
#else
omni::string_t n =
omni::string::util::to_string_t(name);
return (::
SetEnvironmentVariable(&n[
0],
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::name_empty_exception(),
false)
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_NO_WIN_API)
// sending an empty string to this function deletes the variable
return (::
_wputenv_s(name.c_str(), L
"") ==
0);
#else
omni::string_t n =
omni::string::util::to_string_t(name);
return (::
SetEnvironmentVariable(&n[
0],
NULL) !=
0);
#endif
#else
std::string n =
omni::string::util::to_string(name);
return (::
unsetenv(n.c_str()) ==
0);
#endif
}
omni::string_t omni::environment::expand_vars(
const std::string& vars)
{
if (vars.empty()) {
OMNI_ERR_RETV_FW(
"Error expanding environment variable: name cannot be empty",
omni::name_empty_exception(),
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 32767.
const unsigned int MAXSZ =
32767;
omni::string_t v =
omni::string::util::to_string_t(vars);
omni::char_t* cval =
new omni::char_t[MAXSZ]();
if (::
ExpandEnvironmentStrings(&v[
0], cval, MAXSZ) !=
0) {
omni::string_t 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's 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::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::util::to_string_t(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 omni::string::util::to_string_t(ret);
}
::
wordfree(&env);
#endif
#endif
OMNI_ERRV_RETV_FW(
"Error expanding environment variable: ",
OMNI_GLE_PRNT,
omni::environment_exception(
OMNI_GLE),
omni::string_t())
}
omni::string_t omni::environment::expand_vars(
const std::wstring& vars)
{
if (vars.empty()) {
OMNI_ERR_RETV_FW(
"Error expanding environment variable: name cannot be empty",
omni::name_empty_exception(),
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 32767.
const unsigned int MAXSZ =
32767;
omni::string_t v =
omni::string::util::to_string_t(vars);
omni::char_t* cval =
new omni::char_t[MAXSZ]();
if (::
ExpandEnvironmentStrings(&v[
0], cval, MAXSZ) !=
0) {
omni::string_t 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's 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::util::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::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::util::to_string_t(ret);
#else
std::string v =
omni::string::util::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::util::to_string_t(ret);
}
::
wordfree(&env);
#endif
#endif
OMNI_ERRV_RETV_FW(
"Error expanding environment variable: ",
OMNI_GLE_PRNT,
omni::environment_exception(
OMNI_GLE),
omni::string_t())
}
omni::string_t omni::environment::get_var(
const std::string& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW(
"Error getting environment variable: name cannot be empty",
omni::name_empty_exception(),
omni::string_t())
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_API)
// The size of the lpSrc and lpDst buffers is limited to 32767.
const unsigned int MAXSZ =
32767;
omni::string_t v =
omni::string::util::to_string_t(name);
omni::char_t* cval =
new omni::char_t[MAXSZ]();
if (::
GetEnvironmentVariable(&v[
0], cval, MAXSZ) !=
0) {
omni::string_t 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 omni::string::util::to_string_t(ret);
}
}
#endif
#else
char* r =
std::getenv(name.c_str());
if (r !=
NULL) {
return omni::string::util::to_string_t(r); }
#endif
OMNI_ERRV_RETV_FW(
"Error retrieving environment variable: ",
OMNI_GLE_PRNT,
omni::environment_exception(
OMNI_GLE),
omni::string_t())
}
omni::string_t omni::environment::get_var(
const std::wstring& name)
{
if (name.empty()) {
OMNI_ERR_RETV_FW(
"Error getting environment variable: name cannot be empty",
omni::name_empty_exception(),
omni::string_t())
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_API)
// The size of the lpSrc and lpDst buffers is limited to 32767.
const unsigned int MAXSZ =
32767;
omni::string_t v =
omni::string::util::to_string_t(name);
omni::char_t* cval =
new omni::char_t[MAXSZ]();
if (::
GetEnvironmentVariable(&v[
0], cval, MAXSZ) !=
0) {
omni::string_t 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 omni::string::util::to_string_t(ret);
}
}
#endif
#else
std::string v =
omni::string::util::to_string(name);
char* r =
std::getenv(v.c_str());
if (r !=
NULL) {
return omni::string::util::to_string_t(r); }
#endif
OMNI_ERRV_RETV_FW(
"Error retrieving environment variable: ",
OMNI_GLE_PRNT,
omni::environment_exception(
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::name_empty_exception(),
false)
}
if (val.empty()) {
OMNI_ERR_RETV_FW(
"Error setting environment variable: value cannot be empty",
omni::name_empty_exception(),
false)
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_NO_WIN_API)
// sending an empty string to this function deletes the variable
return (::
_putenv_s(name.c_str(), val.c_str()) ==
0);
#else
omni::string_t n =
omni::string::util::to_string_t(name);
omni::string_t v =
omni::string::util::to_string_t(val);
return (::
SetEnvironmentVariable(&n[
0], &v[
0]) !=
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::name_empty_exception(),
false)
}
if (val.empty()) {
OMNI_ERR_RETV_FW(
"Error setting environment variable: value cannot be empty",
omni::name_empty_exception(),
false)
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_NO_WIN_API)
// sending an empty string to this function deletes the variable
return (::
_wputenv_s(name.c_str(), val.c_str()) ==
0);
#else
omni::string_t n =
omni::string::util::to_string_t(name);
omni::string_t v =
omni::string::util::to_string_t(val);
return (::
SetEnvironmentVariable(&n[
0], &v[
0]) !=
0);
#endif
#else
std::string n =
omni::string::util::to_string(name);
std::string v =
omni::string::util::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::name_empty_exception(),
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 32767.
const unsigned int MAXSZ =
32767;
omni::string_t v =
omni::string::util::to_string_t(name);
omni::char_t* cval =
new omni::char_t[MAXSZ]();
if (::
GetEnvironmentVariable(&v[
0], cval, MAXSZ) !=
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::name_empty_exception(),
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 32767.
const unsigned int MAXSZ =
32767;
omni::string_t v =
omni::string::util::to_string_t(name);
omni::char_t* cval =
new omni::char_t[MAXSZ]();
if (::
GetEnvironmentVariable(&v[
0], cval, MAXSZ) !=
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::util::to_string(name);
char* r =
std::getenv(v.c_str());
if (r !=
NULL) { ret =
true; }
#endif
return ret;
}
