248 lines
6.6 KiB
C++
248 lines
6.6 KiB
C++
#include "precompiled.h"
|
|
|
|
#include "CLogger.h"
|
|
#include "CConsole.h"
|
|
#include "ConfigDB.h"
|
|
#include "lib/path_util.h"
|
|
#include "lib/file/path.h"
|
|
#include "lib/sysdep/sysdep.h"
|
|
|
|
#include <time.h>
|
|
#include <ostream>
|
|
|
|
// Set up a default logger that throws everything away, because that's
|
|
// better than crashing. (This is particularly useful for unit tests which
|
|
// don't care about any log output.)
|
|
struct BlackHoleStreamBuf : public std::streambuf
|
|
{
|
|
} blackHoleStreamBuf;
|
|
std::ostream blackHoleStream(&blackHoleStreamBuf);
|
|
CLogger nullLogger(&blackHoleStream, &blackHoleStream, false, true);
|
|
|
|
CLogger* g_Logger = &nullLogger;
|
|
|
|
const char* html_header0 =
|
|
"<!DOCTYPE HTML>\n"
|
|
"<title>Pyrogenesis Log</title>\n"
|
|
"<link rel=\"stylesheet\" href=\"style.css\" type=\"text/css\">\n"
|
|
"<p class=\"logo\"><img src=\"0adlogo.jpg\" alt=\"0 A.D.\"></p>\n"
|
|
"<h1>";
|
|
|
|
const char* html_header1 = "</h1>\n";
|
|
|
|
const char* html_footer = "";
|
|
|
|
CLogger::CLogger()
|
|
{
|
|
Path mainlogPath("../logs/mainlog.html");
|
|
m_MainLog = new std::ofstream(mainlogPath.external_file_string().c_str(), std::ofstream::out | std::ofstream::trunc);
|
|
|
|
Path interestinglogPath("../logs/interestinglog.html");
|
|
m_InterestingLog = new std::ofstream(interestinglogPath.external_file_string().c_str(), std::ofstream::out | std::ofstream::trunc);
|
|
|
|
m_OwnsStreams = true;
|
|
m_UseDebugPrintf = true;
|
|
|
|
Init();
|
|
}
|
|
|
|
CLogger::CLogger(std::ostream* mainLog, std::ostream* interestingLog, bool takeOwnership, bool useDebugPrintf)
|
|
{
|
|
m_MainLog = mainLog;
|
|
m_InterestingLog = interestingLog;
|
|
m_OwnsStreams = takeOwnership;
|
|
m_UseDebugPrintf = useDebugPrintf;
|
|
|
|
Init();
|
|
}
|
|
|
|
void CLogger::Init()
|
|
{
|
|
m_NumberOfMessages = 0;
|
|
m_NumberOfErrors = 0;
|
|
m_NumberOfWarnings = 0;
|
|
|
|
//Write Headers for the HTML documents
|
|
*m_MainLog << html_header0 << "Main log" << html_header1;
|
|
|
|
//Write Headers for the HTML documents
|
|
*m_InterestingLog << html_header0 << "Main log (interesting items only, as specified in system.cfg)" << html_header1;
|
|
|
|
}
|
|
|
|
CLogger::~CLogger ()
|
|
{
|
|
char buffer[128];
|
|
sprintf(buffer," with %d message(s), %d error(s) and %d warning(s).", \
|
|
m_NumberOfMessages,m_NumberOfErrors,m_NumberOfWarnings);
|
|
|
|
time_t t = time(NULL);
|
|
struct tm* now = localtime(&t);
|
|
//const char* months[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
|
|
//CStr currentDate = CStr(months[now->tm_mon]) + " " + CStr(now->tm_mday) + " " + CStr(1900+now->tm_year);
|
|
char currentDate[11];
|
|
sprintf(currentDate, "%02d %02d %04d", now->tm_mon, now->tm_mday, (1900+now->tm_year));
|
|
char currentTime[10];
|
|
sprintf(currentTime, "%02d:%02d:%02d", now->tm_hour, now->tm_min, now->tm_sec);
|
|
|
|
//Write closing text
|
|
|
|
*m_MainLog << "<p>Engine exited successfully on " << currentDate;
|
|
*m_MainLog << " at " << currentTime << buffer << "</p>\n";
|
|
*m_MainLog << html_footer;
|
|
|
|
*m_InterestingLog << "<p>Engine exited successfully on " << currentDate;
|
|
*m_InterestingLog << " at " << currentTime << buffer << "</p>\n";
|
|
*m_InterestingLog << html_footer;
|
|
|
|
if (m_OwnsStreams)
|
|
{
|
|
delete m_InterestingLog;
|
|
delete m_MainLog;
|
|
}
|
|
}
|
|
|
|
void CLogger::WriteMessage(const char *message, int interestedness)
|
|
{
|
|
m_NumberOfMessages++;
|
|
|
|
if (interestedness >= 2)
|
|
{
|
|
if (g_Console) g_Console->InsertMessage(L"LOG: %hs", message);
|
|
*m_InterestingLog << "<p>" << message << "</p>\n";
|
|
m_InterestingLog->flush();
|
|
}
|
|
*m_MainLog << "<p>" << message << "</p>\n";
|
|
m_MainLog->flush();
|
|
|
|
}
|
|
|
|
void CLogger::WriteError(const char *message, int interestedness)
|
|
{
|
|
m_NumberOfErrors++;
|
|
if (m_UseDebugPrintf)
|
|
debug_printf("ERROR: %s\n", message);
|
|
if (interestedness >= 1)
|
|
{
|
|
if (g_Console) g_Console->InsertMessage(L"ERROR: %hs", message);
|
|
*m_InterestingLog << "<p class=\"error\">ERROR: "<< message << "</p>\n";
|
|
m_InterestingLog->flush();
|
|
}
|
|
*m_MainLog << "<p class=\"error\">ERROR: "<< message << "</p>\n";
|
|
m_MainLog->flush();
|
|
}
|
|
|
|
void CLogger::WriteWarning(const char *message, int interestedness)
|
|
{
|
|
m_NumberOfWarnings++;
|
|
if (interestedness >= 1)
|
|
{
|
|
if (g_Console) g_Console->InsertMessage(L"WARNING: %hs", message);
|
|
*m_InterestingLog << "<p class=\"warning\">WARNING: "<< message << "</p>\n";
|
|
m_InterestingLog->flush();
|
|
}
|
|
*m_MainLog << "<p class=\"warning\">WARNING: "<< message << "</p>\n";
|
|
m_MainLog->flush();
|
|
}
|
|
|
|
// Sends the message to the appropriate piece of code
|
|
void CLogger::LogUsingMethod(ELogMethod method, const char* category, const char* message)
|
|
{
|
|
if(method == Normal)
|
|
WriteMessage(message, Interestedness(category));
|
|
else if(method == Error)
|
|
WriteError(message, Interestedness(category));
|
|
else if(method == Warning)
|
|
WriteWarning(message, Interestedness(category));
|
|
else
|
|
WriteMessage(message, Interestedness(category));
|
|
}
|
|
|
|
void CLogger::Log(ELogMethod method, const char* category, const char *fmt, ...)
|
|
{
|
|
va_list argp;
|
|
char buffer[512];
|
|
|
|
va_start(argp, fmt);
|
|
if (sys_vsnprintf(buffer, sizeof(buffer), fmt, argp) == -1)
|
|
{
|
|
// Buffer too small - ensure the string is nicely terminated
|
|
strcpy(buffer+sizeof(buffer)-4, "..."); // safe
|
|
}
|
|
va_end(argp);
|
|
|
|
LogUsingMethod(method, category, buffer);
|
|
}
|
|
|
|
|
|
void CLogger::LogOnce(ELogMethod method, const char* category, const char *fmt, ...)
|
|
{
|
|
va_list argp;
|
|
char buffer[512];
|
|
|
|
va_start(argp, fmt);
|
|
if (sys_vsnprintf(buffer, sizeof(buffer), fmt, argp) == -1)
|
|
{
|
|
// Buffer too small - ensure the string is nicely terminated
|
|
strcpy(buffer+sizeof(buffer)-4, "..."); // safe
|
|
}
|
|
va_end(argp);
|
|
|
|
std::string message (buffer);
|
|
|
|
// If this message has already been logged, ignore it
|
|
if (m_LoggedOnce.find(message) != m_LoggedOnce.end())
|
|
return;
|
|
|
|
// If not, mark it as having been logged and then log it
|
|
m_LoggedOnce.insert(message);
|
|
LogUsingMethod(method, category, buffer);
|
|
}
|
|
|
|
|
|
int CLogger::Interestedness(const char* category)
|
|
{
|
|
// This could be cached, but reading from the config DB every time allows
|
|
// easy run-time alteration of interest levels (and shouldn't be particularly
|
|
// slow)
|
|
|
|
// Category unspecified: use a high interest level to encourage
|
|
// people to categorise their errors
|
|
if (category == NULL)
|
|
return 2;
|
|
|
|
// If the config DB hasn't been loaded, assume the default
|
|
if (! CConfigDB::IsInitialised())
|
|
return 1;
|
|
|
|
CConfigValue* v = g_ConfigDB.GetValue(CFG_SYSTEM, CStr("loginterest.")+category);
|
|
// If the value is unspecified, also use the default
|
|
if (!v)
|
|
return 1;
|
|
|
|
int level;
|
|
// Try to retrieve the value as an integer
|
|
if (! v->GetInt(level))
|
|
return 1; // something failed, so the default value might be a good alternative
|
|
|
|
return level;
|
|
}
|
|
|
|
|
|
TestLogger::TestLogger()
|
|
{
|
|
m_OldLogger = g_Logger;
|
|
g_Logger = new CLogger(&m_Stream, &blackHoleStream, false, false);
|
|
}
|
|
|
|
TestLogger::~TestLogger()
|
|
{
|
|
delete g_Logger;
|
|
g_Logger = m_OldLogger;
|
|
}
|
|
|
|
std::string TestLogger::GetOutput()
|
|
{
|
|
return m_Stream.str();
|
|
}
|