/*
* Copyright (C) 2005-2012 MaNGOS
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef MANGOSSERVER_LOG_H
#define MANGOSSERVER_LOG_H
#include "Common.h"
#include "Policies/Singleton.h"
class Config;
class ByteBuffer;
enum LogLevel
{
LOG_LVL_MINIMAL = 0, // unconditional and errors
LOG_LVL_BASIC = 1,
LOG_LVL_DETAIL = 2,
LOG_LVL_DEBUG = 3
};
// bitmask (not forgot update logFilterData content)
enum LogFilters
{
LOG_FILTER_TRANSPORT_MOVES = 0x000001, // 0 any related to transport moves
LOG_FILTER_CREATURE_MOVES = 0x000002, // 1 creature move by cells
LOG_FILTER_VISIBILITY_CHANGES = 0x000004, // 2 update visibility for diff objects and players
LOG_FILTER_ACHIEVEMENT_UPDATES= 0x000008, // 3 achievement update broadcasts
LOG_FILTER_WEATHER = 0x000010, // 4 weather changes
LOG_FILTER_PLAYER_STATS = 0x000020, // 5 player save data
LOG_FILTER_SQL_TEXT = 0x000040, // 6 raw SQL text send to DB engine
LOG_FILTER_PLAYER_MOVES = 0x000080, // 7 player moves by grid/cell
LOG_FILTER_PERIODIC_AFFECTS = 0x000100, // 8 DoT/HoT apply trace
LOG_FILTER_AI_AND_MOVEGENSS = 0x000200, // 9 AI/movement generators debug output
LOG_FILTER_DAMAGE = 0x000400, // 10 Direct/Area damage trace
LOG_FILTER_COMBAT = 0x000800, // 11 attack states/roll attack results/etc
LOG_FILTER_SPELL_CAST = 0x001000, // 12 spell cast/aura apply/spell proc events
LOG_FILTER_DB_STRICTED_CHECK = 0x002000, // 13 stricted DB data checks output (with possible false reports) for DB devs
LOG_FILTER_AHBOT_SELLER = 0x004000, // 14 Auction House Bot seller part
LOG_FILTER_AHBOT_BUYER = 0x008000, // 15 Auction House Bot buyer part
LOG_FILTER_PATHFINDING = 0x010000, // 16 Pathfinding
};
#define LOG_FILTER_COUNT 17
struct LogFilterData
{
char const* name;
char const* configName;
bool defaultState;
};
extern LogFilterData logFilterData[LOG_FILTER_COUNT];
enum Color
{
BLACK,
RED,
GREEN,
BROWN,
BLUE,
MAGENTA,
CYAN,
GREY,
YELLOW,
LRED,
LGREEN,
LBLUE,
LMAGENTA,
LCYAN,
WHITE
};
const int Color_count = int(WHITE)+1;
class Log : public MaNGOS::Singleton >
{
friend class MaNGOS::OperatorNew;
Log();
~Log()
{
if( logfile != NULL )
fclose(logfile);
logfile = NULL;
if( gmLogfile != NULL )
fclose(gmLogfile);
gmLogfile = NULL;
if (charLogfile != NULL)
fclose(charLogfile);
charLogfile = NULL;
if( dberLogfile != NULL )
fclose(dberLogfile);
dberLogfile = NULL;
if (raLogfile != NULL)
fclose(raLogfile);
raLogfile = NULL;
if (worldLogfile != NULL)
fclose(worldLogfile);
worldLogfile = NULL;
}
public:
void Initialize();
void InitColors(const std::string& init_str);
void outCommand( uint32 account, const char * str, ...) ATTR_PRINTF(3,4);
void outString(); // any log level
// any log level
void outString( const char * str, ... ) ATTR_PRINTF(2,3);
// any log level
void outError( const char * err, ... ) ATTR_PRINTF(2,3);
// log level >= 1
void outBasic( const char * str, ... ) ATTR_PRINTF(2,3);
// log level >= 2
void outDetail( const char * str, ... ) ATTR_PRINTF(2,3);
// log level >= 3
void outDebug( const char * str, ... ) ATTR_PRINTF(2,3);
void outErrorDb(); // any log level
// any log level
void outErrorDb( const char * str, ... ) ATTR_PRINTF(2,3);
// any log level
void outChar( const char * str, ... ) ATTR_PRINTF(2,3);
// any log level
void outWorldPacketDump( uint32 socket, uint32 opcode, char const* opcodeName, ByteBuffer const* packet, bool incoming );
// any log level
void outCharDump( const char * str, uint32 account_id, uint32 guid, const char * name );
void outRALog( const char * str, ... ) ATTR_PRINTF(2,3);
uint32 GetLogLevel() const { return m_logLevel; }
void SetLogLevel(char * Level);
void SetLogFileLevel(char * Level);
void SetColor(bool stdout_stream, Color color);
void ResetColor(bool stdout_stream);
void outTime();
static void outTimestamp(FILE* file);
static std::string GetTimestampStr();
bool HasLogFilter(uint32 filter) const { return m_logFilter & filter; }
void SetLogFilter(LogFilters filter, bool on) { if (on) m_logFilter |= filter; else m_logFilter &= ~filter; }
bool HasLogLevelOrHigher(LogLevel loglvl) const { return m_logLevel >= loglvl || (m_logFileLevel >= loglvl && logfile); }
bool IsOutCharDump() const { return m_charLog_Dump; }
bool IsIncludeTime() const { return m_includeTime; }
static void WaitBeforeContinueIfNeed();
private:
FILE* openLogFile(char const* configFileName,char const* configTimeStampFlag, char const* mode);
FILE* openGmlogPerAccount(uint32 account);
FILE* raLogfile;
FILE* logfile;
FILE* gmLogfile;
FILE* charLogfile;
FILE* dberLogfile;
FILE* worldLogfile;
// log/console control
LogLevel m_logLevel;
LogLevel m_logFileLevel;
bool m_colored;
bool m_includeTime;
Color m_colors[4];
uint32 m_logFilter;
// cache values for after initilization use (like gm log per account case)
std::string m_logsDir;
std::string m_logsTimestamp;
// char log control
bool m_charLog_Dump;
// gm log control
bool m_gmlog_per_account;
std::string m_gmlog_filename_format;
};
#define sLog MaNGOS::Singleton::Instance()
#define BASIC_LOG(...) \
do { \
if (sLog.HasLogLevelOrHigher(LOG_LVL_BASIC)) \
sLog.outBasic(__VA_ARGS__); \
} while(0)
#define BASIC_FILTER_LOG(F,...) \
do { \
if (sLog.HasLogLevelOrHigher(LOG_LVL_BASIC) && !sLog.HasLogFilter(F)) \
sLog.outBasic(__VA_ARGS__); \
} while(0)
#define DETAIL_LOG(...) \
do { \
if (sLog.HasLogLevelOrHigher(LOG_LVL_DETAIL)) \
sLog.outDetail(__VA_ARGS__); \
} while(0)
#define DETAIL_FILTER_LOG(F,...) \
do { \
if (sLog.HasLogLevelOrHigher(LOG_LVL_DETAIL) && !sLog.HasLogFilter(F)) \
sLog.outDetail(__VA_ARGS__); \
} while(0)
#define DEBUG_LOG(...) \
do { \
if (sLog.HasLogLevelOrHigher(LOG_LVL_DEBUG)) \
sLog.outDebug(__VA_ARGS__); \
} while(0)
#define DEBUG_FILTER_LOG(F,...) \
do { \
if (sLog.HasLogLevelOrHigher(LOG_LVL_DEBUG) && !sLog.HasLogFilter(F)) \
sLog.outDebug(__VA_ARGS__); \
} while(0)
#define ERROR_DB_FILTER_LOG(F,...) \
do { \
if (!sLog.HasLogFilter(F)) \
sLog.outErrorDb(__VA_ARGS__); \
} while(0)
#define ERROR_DB_STRICT_LOG(...) \
ERROR_DB_FILTER_LOG(LOG_FILTER_DB_STRICTED_CHECK, __VA_ARGS__)
// primary for script library
void MANGOS_DLL_SPEC outstring_log(const char * str, ...) ATTR_PRINTF(1,2);
void MANGOS_DLL_SPEC detail_log(const char * str, ...) ATTR_PRINTF(1,2);
void MANGOS_DLL_SPEC debug_log(const char * str, ...) ATTR_PRINTF(1,2);
void MANGOS_DLL_SPEC error_log(const char * str, ...) ATTR_PRINTF(1,2);
void MANGOS_DLL_SPEC error_db_log(const char * str, ...) ATTR_PRINTF(1,2);
#endif