Skip to content

Commit

Permalink
src/logging.cc: match logfile with base_filename
Browse files Browse the repository at this point in the history
  • Loading branch information
@aesophor
aesophor committed Dec 1, 2019
1 parent 3b5f280 commit 1b56ad7
Showing 1 changed file with 69 additions and 54 deletions.
123 changes: 69 additions & 54 deletions src/logging.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -465,17 +465,19 @@ class LogCleaner {

void Enable(int overdue_days);
void Disable();
void Run() const;
void Run(bool base_filename_selected, const string& base_filename) const;

inline bool enabled() const { return enabled_; }

private:
bool IsLogFromCurrentProject(const string& filename) const;
vector<string> GetOverdueLogNames(string log_directory, int days,
const string& base_filename) const;
bool IsLogFromCurrentProject(const string& filepath, const string& base_filename) const;
bool IsLogLastModifiedOver(const string& filepath, int days) const;
vector<string> GetOverdueLogNames(string log_directory, int days) const;


bool enabled_;
int overdue_days_;
char dir_delim_; // filepath delimiter ('/' or '\\')
};

LogCleaner log_cleaner;
Expand Down Expand Up @@ -1213,13 +1215,20 @@ void LogFileObject::Write(bool force_flush,
#endif
// Perform clean up for old logs
if (log_cleaner.enabled()) {
log_cleaner.Run();
if (base_filename_selected_ && base_filename_.empty()) {
return;
}
log_cleaner.Run(base_filename_selected_, base_filename_);
}
}
}


LogCleaner::LogCleaner() : enabled_(false), overdue_days_(7) {}
LogCleaner::LogCleaner() : enabled_(false), overdue_days_(7), dir_delim_('/') {
#if OS_WINDOWS
dir_delim_ = '\\';
#endif
}

void LogCleaner::Enable(int overdue_days) {
// Setting overdue_days to 0 day should not be allowed!
Expand All @@ -1234,70 +1243,38 @@ void LogCleaner::Disable() {
enabled_ = false;
}

void LogCleaner::Run() const {
void LogCleaner::Run(bool base_filename_selected, const string& base_filename) const {
assert(enabled_ && overdue_days_ > 0);

const vector<string>& dirs = GetLoggingDirectories();
vector<string> dirs;

if (base_filename_selected) {
string dir = base_filename.substr(0, base_filename.find_last_of(dir_delim_) + 1);
dirs.push_back(dir);
} else {
dirs = GetLoggingDirectories();
}

for (size_t i = 0; i < dirs.size(); i++) {
vector<string> logs = GetOverdueLogNames(dirs[i], overdue_days_);
vector<string> logs = GetOverdueLogNames(dirs[i], overdue_days_, base_filename);
for (size_t j = 0; j < logs.size(); j++) {
static_cast<void>(unlink(logs[j].c_str()));
}
}
}

bool LogCleaner::IsLogFromCurrentProject(const string& filename) const {
// Check if filename matches the pattern of a glog file:
// "<program name>.<hostname>.<user name>.log...".
const int kKeywordCount = 4;
std::string keywords[kKeywordCount] = {
glog_internal_namespace_::ProgramInvocationShortName(),
LogDestination::hostname(),
MyUserName(),
"log"
};

int start_pos = 0;
for (int i = 0; i < kKeywordCount; i++) {
if (filename.find(keywords[i], start_pos) == filename.npos) {
return false;
}
start_pos += keywords[i].size() + 1;
}
return true;
}

bool LogCleaner::IsLogLastModifiedOver(const string& filepath, int days) const {
// Try to get the last modified time of this file.
struct stat file_stat;

if (stat(filepath.c_str(), &file_stat) == 0) {
// A day is 86400 seconds, so 7 days is 86400 * 7 = 604800 seconds.
time_t last_modified_time = file_stat.st_mtime;
time_t current_time = time(NULL);
return difftime(current_time, last_modified_time) > days * 86400;
}

// If failed to get file stat, don't return true!
return false;
}

vector<string> LogCleaner::GetOverdueLogNames(string log_directory, int days) const {
vector<string> LogCleaner::GetOverdueLogNames(string log_directory, int days,
const string& base_filename) const {
// The names of overdue logs.
vector<string> overdue_log_names;

// Try to get all files within log_directory.
DIR *dir;
struct dirent *ent;

char dir_delim = '/';
#ifdef OS_WINDOWS
dir_delim = '\\';
#endif

// If log_directory doesn't end with a slash, append a slash to it.
if (log_directory.at(log_directory.size() - 1) != dir_delim) {
log_directory += dir_delim;
if (log_directory.at(log_directory.size() - 1) != dir_delim_) {
log_directory += dir_delim_;
}

if ((dir=opendir(log_directory.c_str()))) {
Expand All @@ -1306,7 +1283,8 @@ vector<string> LogCleaner::GetOverdueLogNames(string log_directory, int days) co
continue;
}
string filepath = log_directory + ent->d_name;
if (IsLogFromCurrentProject(ent->d_name) && IsLogLastModifiedOver(filepath, days)) {
if (IsLogFromCurrentProject(filepath, base_filename) &&
IsLogLastModifiedOver(filepath, days)) {
overdue_log_names.push_back(filepath);
}
}
Expand All @@ -1316,6 +1294,43 @@ vector<string> LogCleaner::GetOverdueLogNames(string log_directory, int days) co
return overdue_log_names;
}

bool LogCleaner::IsLogFromCurrentProject(const string& filepath,
const string& base_filename) const {
// We should remove duplicated delimiters from `base_filename`, e.g.,
// before: "/tmp//<program name>.<hostname>.<user name>.log.<severity level>"
// after: "/tmp/<program name>.<hostname>.<user name>.log.<severity level>"
string cleaned_base_filename;

for (size_t i = 0; i < base_filename.size(); ++i) {
const char& c = base_filename[i];
if (cleaned_base_filename.empty()) {
cleaned_base_filename += c;
} else if (c != dir_delim_ ||
c != cleaned_base_filename.at(cleaned_base_filename.size() - 1)) {
cleaned_base_filename += c;
}
}

// If the filename of the given logfile starts with `cleaned_base_filename`,
// then this logfile is from current project.
return filepath.find(cleaned_base_filename) == 0;
}

bool LogCleaner::IsLogLastModifiedOver(const string& filepath, int days) const {
// Try to get the last modified time of this file.
struct stat file_stat;

if (stat(filepath.c_str(), &file_stat) == 0) {
// A day is 86400 seconds, so 7 days is 86400 * 7 = 604800 seconds.
time_t last_modified_time = file_stat.st_mtime;
time_t current_time = time(NULL);
return difftime(current_time, last_modified_time) > days * 86400;
}

// If failed to get file stat, don't return true!
return false;
}

} // namespace

// Static log data space to avoid alloc failures in a LOG(FATAL)
Expand Down

0 comments on commit 1b56ad7

Please sign in to comment.