/* Copyright (C) 2013 Birunthan Mohanathas This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #include "StdAfx.h" #include "Logger.h" #include "DialogAbout.h" #include "Litestep.h" #include "Rainmeter.h" #include "System.h" #include "resource.h" namespace { const size_t MAX_LOG_ENTIRES = 20; } // namespace Logger::Logger() : m_LogToFile(false) { System::InitializeCriticalSection(&m_CsLog); System::InitializeCriticalSection(&m_CsLogDelay); } Logger::~Logger() { DeleteCriticalSection(&m_CsLog); DeleteCriticalSection(&m_CsLogDelay); } Logger& Logger::GetInstance() { static Logger s_Logger; return s_Logger; } void Logger::StartLogFile() { const WCHAR* filePath = m_LogFilePath.c_str(); if (_waccess(filePath, 0) == -1) { // Create empty log file. HANDLE file = CreateFile(filePath, GENERIC_WRITE, 0, nullptr, CREATE_NEW, FILE_ATTRIBUTE_NORMAL, nullptr); if (file != INVALID_HANDLE_VALUE) { CloseHandle(file); } else { const std::wstring text = GetFormattedString(ID_STR_LOGFILECREATEFAIL, filePath); GetRainmeter().ShowMessage(nullptr, text.c_str(), MB_OK | MB_ICONERROR); SetLogToFile(false); return; } } SetLogToFile(true); } void Logger::StopLogFile() { SetLogToFile(false); } void Logger::DeleteLogFile() { const WCHAR* filePath = m_LogFilePath.c_str(); if (_waccess(filePath, 0) != -1) { const std::wstring text = GetFormattedString(ID_STR_LOGFILEDELETE, filePath); const int res = GetRainmeter().ShowMessage(nullptr, text.c_str(), MB_YESNO | MB_ICONQUESTION); if (res == IDYES) { SetLogToFile(false); System::RemoveFile(m_LogFilePath); } } } void Logger::SetLogToFile(bool logToFile) { m_LogToFile = logToFile; WritePrivateProfileString( L"Rainmeter", L"Logging", logToFile ? L"1" : L"0", GetRainmeter().GetIniFile().c_str()); } void Logger::LogInternal(Level level, ULONGLONG timestamp, const WCHAR* source, const WCHAR* msg) { WCHAR timestampSz[128]; size_t len = _snwprintf_s( timestampSz, _TRUNCATE, L"%02llu:%02llu:%02llu.%03llu", timestamp / (1000 * 60 * 60), (timestamp / (1000 * 60)) % 60, (timestamp / 1000) % 60, timestamp % 1000); // Store up to MAX_LOG_ENTIRES entries. Entry entry = {level, std::wstring(timestampSz, len), source, msg}; m_Entries.push_back(entry); if (m_Entries.size() > MAX_LOG_ENTIRES) { m_Entries.pop_front(); } DialogAbout::AddLogItem(level, timestampSz, source, msg); WriteToLogFile(entry); } void Logger::WriteToLogFile(Entry& entry) { #ifndef _DEBUG if (!m_LogToFile) return; #endif const WCHAR* levelSz = (entry.level == Level::Error) ? L"ERRO" : (entry.level == Level::Warning) ? L"WARN" : (entry.level == Level::Notice) ? L"NOTE" : L"DBUG"; std::wstring message = levelSz; message += L" ("; message.append(entry.timestamp); message += L") "; message += entry.source; message += L": "; message += entry.message; message += L'\n'; #ifdef _DEBUG _RPT0(_CRT_WARN, StringUtil::Narrow(message).c_str()); if (!m_LogToFile) return; #endif const WCHAR* filePath = m_LogFilePath.c_str(); if (_waccess(filePath, 0) == -1) { // The file has been deleted manually. StopLogFile(); } else { FILE* file = _wfopen(filePath, L"a+, ccs=UTF-8"); if (file) { fputws(message.c_str(), file); fclose(file); } } } void Logger::Log(Level level, const WCHAR* source, const WCHAR* msg) { struct DelayedEntry { Level level; ULONGLONG elapsed; std::wstring message; }; static std::list s_DelayedEntries; static ULONGLONG s_StartTime = System::GetTickCount64(); ULONGLONG elapsed = System::GetTickCount64() - s_StartTime; if (TryEnterCriticalSection(&m_CsLog)) { // Log queued messages first. EnterCriticalSection(&m_CsLogDelay); while (!s_DelayedEntries.empty()) { DelayedEntry& entry = s_DelayedEntries.front(); LogInternal(entry.level, entry.elapsed, source, entry.message.c_str()); s_DelayedEntries.erase(s_DelayedEntries.begin()); } LeaveCriticalSection(&m_CsLogDelay); // Log the actual message. LogInternal(level, elapsed, source, msg); LeaveCriticalSection(&m_CsLog); } else { // Queue message. EnterCriticalSection(&m_CsLogDelay); DelayedEntry entry = {level, elapsed, msg}; s_DelayedEntries.push_back(entry); LeaveCriticalSection(&m_CsLogDelay); } } void Logger::LogF(Level level, const WCHAR* source, const WCHAR* format, va_list args) { WCHAR* buffer = new WCHAR[1024]; _invalid_parameter_handler oldHandler = _set_invalid_parameter_handler(RmNullCRTInvalidParameterHandler); _CrtSetReportMode(_CRT_ASSERT, 0); errno = 0; _vsnwprintf_s(buffer, 1024, _TRUNCATE, format, args); if (errno != 0) { level = Level::Error; _snwprintf_s(buffer, 1024, _TRUNCATE, L"Internal error: %s", format); } _set_invalid_parameter_handler(oldHandler); Log(level, source, buffer); delete [] buffer; } void LogSection(Logger::Level level, Section* section, const WCHAR* format, va_list args) { std::wstring source; if (section) { MeterWindow* meterWindow = section->GetMeterWindow(); if (meterWindow) { source = meterWindow->GetSkinPath(); source += L" - "; } source += L"["; source += section->GetOriginalName(); source += L"]"; } GetLogger().LogF(level, source.c_str(), format, args); } void LogMeterWindow(Logger::Level level, MeterWindow* meterWindow, const WCHAR* format, va_list args) { std::wstring source; if (meterWindow) { source = meterWindow->GetSkinPath(); } GetLogger().LogF(level, source.c_str(), format, args); } void LogErrorF(const WCHAR* format, ...) { va_list args; va_start(args, format); GetLogger().LogF(Logger::Level::Error, L"", format, args); va_end(args); } void LogErrorF(Section* section, const WCHAR* format, ...) { va_list args; va_start(args, format); LogSection(Logger::Level::Error, section, format, args); va_end(args); } void LogErrorF(MeterWindow* meterWindow, const WCHAR* format, ...) { va_list args; va_start(args, format); LogMeterWindow(Logger::Level::Error, meterWindow, format, args); va_end(args); } void LogWarningF(const WCHAR* format, ...) { va_list args; va_start(args, format); GetLogger().LogF(Logger::Level::Warning, L"", format, args); va_end(args); } void LogWarningF(Section* section, const WCHAR* format, ...) { va_list args; va_start(args, format); LogSection(Logger::Level::Warning, section, format, args); va_end(args); } void LogWarningF(MeterWindow* meterWindow, const WCHAR* format, ...) { va_list args; va_start(args, format); LogMeterWindow(Logger::Level::Warning, meterWindow, format, args); va_end(args); } void LogNoticeF(const WCHAR* format, ...) { va_list args; va_start(args, format); GetLogger().LogF(Logger::Level::Notice, L"", format, args); va_end(args); } void LogNoticeF(Section* section, const WCHAR* format, ...) { va_list args; va_start(args, format); LogSection(Logger::Level::Notice, section, format, args); va_end(args); } void LogNoticeF(MeterWindow* meterWindow, const WCHAR* format, ...) { va_list args; va_start(args, format); LogMeterWindow(Logger::Level::Notice, meterWindow, format, args); va_end(args); } void LogDebugF(const WCHAR* format, ...) { va_list args; va_start(args, format); GetLogger().LogF(Logger::Level::Debug, L"", format, args); va_end(args); } void LogDebugF(Section* section, const WCHAR* format, ...) { va_list args; va_start(args, format); LogSection(Logger::Level::Debug, section, format, args); va_end(args); } void LogDebugF(MeterWindow* meterWindow, const WCHAR* format, ...) { va_list args; va_start(args, format); LogMeterWindow(Logger::Level::Debug, meterWindow, format, args); va_end(args); }