Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for environment variables resolution in log file names #570

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 44 additions & 1 deletion src/easylogging++.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1658,8 +1658,51 @@ unsigned long TypedConfigurations::getULong(std::string confVal) {
return atol(confVal.c_str());
}

std::string TypedConfigurations::substituteEnvironmentVariables(const std::string& filename) {
std::string resultingFilename;
std::string varSpecifierBeginStr(base::consts::kEnvVariableBegin);
std::string varSpecifierEndStr(base::consts::kEnvVariableEnd);

const size_t prefixLen = varSpecifierBeginStr.size();
const size_t suffixLen = varSpecifierEndStr.size();

if (filename.size() < prefixLen) return filename;
size_t envVarStart = 0;
size_t limit = filename.size() - prefixLen;
for (; envVarStart < limit; ++envVarStart) {
if (strncmp(filename.data() + envVarStart, varSpecifierBeginStr.data(), prefixLen)) {
resultingFilename.push_back(filename[envVarStart]);
continue;
}

size_t envVarEnd = envVarStart + prefixLen;
size_t endLimit = filename.size() + 1 - suffixLen;
for (; envVarEnd < endLimit && strncmp(filename.data() + envVarEnd,
varSpecifierEndStr.data(), suffixLen); envVarEnd++);
if (envVarEnd == filename.size()) {
resultingFilename.append(filename.data() + envVarStart, filename.data() + envVarEnd);
break;
}

std::vector<char> buf(envVarEnd - envVarStart - prefixLen + 1, 0);
memcpy(buf.data(), filename.data() + envVarStart + prefixLen, envVarEnd - envVarStart - prefixLen);
std::string varValue = utils::OS::getEnvironmentVariable(buf.data(), "", nullptr);
resultingFilename.append(varValue);
envVarStart = envVarEnd + suffixLen - 1;
}
if (envVarStart < filename.size()) {
resultingFilename.append(filename.data() + envVarStart, filename.data() + filename.size());
}

ELPP_ASSERT((!resultingFilename.empty()), "Empty filename value: [" << filename << "]");
if (resultingFilename.empty()) {
resultingFilename = "\"\""; // same behaviour as if empty string was passed
}
return resultingFilename;
}

std::string TypedConfigurations::resolveFilename(const std::string& filename) {
std::string resultingFilename = filename;
std::string resultingFilename = substituteEnvironmentVariables(filename);
std::size_t dateIndex = std::string::npos;
std::string dateTimeFormatSpecifierStr = std::string(base::consts::kDateTimeFormatSpecifierForFilename);
if ((dateIndex = resultingFilename.find(dateTimeFormatSpecifierStr.c_str())) != std::string::npos) {
Expand Down
6 changes: 5 additions & 1 deletion src/easylogging++.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
#else
# define ELPP_OS_MAC 0
#endif
#if (defined(__FreeBSD__) || defined(__FreeBSD_kernel__))
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is some typo, definitely unintended.

#if (defined(__FreeBSD__))
# define ELPP_OS_FREEBSD 1
#else
# define ELPP_OS_FREEBSD 0
Expand Down Expand Up @@ -814,6 +814,9 @@ static const char* kConfigurationLoggerId = "--";
static const std::size_t kSourceFilenameMaxLength = 100;
static const std::size_t kSourceLineMaxLength = 10;
static const Level kPerformanceTrackerDefaultLevel = Level::Info;
static const char* kEnvVariableBegin = "${";
static const char* kEnvVariableEnd = "}";

const struct {
double value;
const base::type::char_t* unit;
Expand Down Expand Up @@ -2073,6 +2076,7 @@ class TypedConfigurations : public base::threading::ThreadSafe {

void build(Configurations* configurations);
unsigned long getULong(std::string confVal);
std::string substituteEnvironmentVariables(const std::string& filename);
std::string resolveFilename(const std::string& filename);
void insertFile(Level level, const std::string& fullFilename);
bool unsafeValidateFileRolling(Level level, const PreRollOutCallback& preRollOutCallback);
Expand Down