/* * This file is part of the AzerothCore Project. See AUTHORS file for Copyright information * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Affero General Public License as published by the * Free Software Foundation; either version 3 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 Affero General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with this program. If not, see . */ #ifndef _LOG_H__ #define _LOG_H__ #include "Define.h" #include "LogCommon.h" #include "StringFormat.h" #include #include #include class Appender; class Logger; struct LogMessage; #define LOGGER_ROOT "root" typedef Appender*(*AppenderCreatorFn)(uint8 id, std::string const& name, LogLevel level, AppenderFlags flags, std::vector const& extraArgs); template Appender* CreateAppender(uint8 id, std::string const& name, LogLevel level, AppenderFlags flags, std::vector const& extraArgs) { return new AppenderImpl(id, name, level, flags, extraArgs); } class Log { typedef std::unordered_map LoggerMap; private: Log(); ~Log(); Log(Log const&) = delete; Log(Log&&) = delete; Log& operator=(Log const&) = delete; Log& operator=(Log&&) = delete; public: static Log* instance(); void Initialize(); void LoadFromConfig(); void Close(); bool ShouldLog(std::string const& type, LogLevel level) const; bool SetLogLevel(std::string const& name, int32 level, bool isLogger = true); template inline void outMessage(std::string const& filter, LogLevel const level, Format&& fmt, Args&&... args) { outMessage(filter, level, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template inline void outMessageFmt(std::string const& filter, LogLevel const level, std::string_view fmt, Args&&... args) { _outMessageFmt(filter, level, fmt::format(fmt, std::forward(args)...)); } template void outCommand(uint32 account, Format&& fmt, Args&&... args) { if (!ShouldLog("commands.gm", LOG_LEVEL_INFO)) { return; } outCommand(Acore::StringFormat(std::forward(fmt), std::forward(args)...), std::to_string(account)); } void outCharDump(char const* str, uint32 account_id, uint64 guid, char const* name); void SetRealmId(uint32 id); template void RegisterAppender() { RegisterAppender(AppenderImpl::type, &CreateAppender); } std::string const& GetLogsDir() const { return m_logsDir; } std::string const& GetLogsTimestamp() const { return m_logsTimestamp; } // Deprecated functions template inline void outString(Format&& fmt, Args&& ... args) { outMessage("server", LOG_LEVEL_INFO, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } inline void outString() { outMessage("server", LOG_LEVEL_INFO, " "); } template inline void outError(Format&& fmt, Args&& ... args) { outMessage("server", LOG_LEVEL_ERROR, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template void outErrorDb(Format&& fmt, Args&& ... args) { if (!ShouldLog("sql.sql", LOG_LEVEL_ERROR)) { return; } outMessage("sql.sql", LOG_LEVEL_ERROR, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template inline void outBasic(Format&& fmt, Args&& ... args) { outMessage("server", LOG_LEVEL_INFO, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template inline void outDetail(Format&& fmt, Args&& ... args) { outMessage("server", LOG_LEVEL_INFO, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template void outSQLDev(Format&& fmt, Args&& ... args) { if (!ShouldLog("sql.dev", LOG_LEVEL_INFO)) { return; } outMessage("sql.dev", LOG_LEVEL_INFO, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template void outSQLDriver(Format&& fmt, Args&& ... args) { if (!ShouldLog("sql.driver", LOG_LEVEL_INFO)) { return; } outMessage("sql.driver", LOG_LEVEL_INFO, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template inline void outMisc(Format&& fmt, Args&& ... args) { outMessage("server", LOG_LEVEL_INFO, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } template void outDebug(DebugLogFilters filter, Format&& fmt, Args&& ... args) { if (!(_debugLogMask & filter)) { return; } if (!ShouldLog("server", LOG_LEVEL_DEBUG)) { return; } outMessage("server", LOG_LEVEL_DEBUG, Acore::StringFormat(std::forward(fmt), std::forward(args)...)); } private: static std::string GetTimestampStr(); void write(std::unique_ptr&& msg) const; Logger const* GetLoggerByType(std::string const& type) const; Appender* GetAppenderByName(std::string_view name); uint8 NextAppenderId(); void CreateAppenderFromConfig(std::string const& name); void CreateLoggerFromConfig(std::string const& name); void ReadAppendersFromConfig(); void ReadLoggersFromConfig(); void RegisterAppender(uint8 index, AppenderCreatorFn appenderCreateFn); void outMessage(std::string const& filter, LogLevel level, std::string&& message); void _outMessageFmt(std::string const& filter, LogLevel level, std::string&& message); void outCommand(std::string&& message, std::string&& param1); std::unordered_map appenderFactory; std::unordered_map> appenders; std::unordered_map> loggers; uint8 AppenderId; LogLevel highestLogLevel; std::string m_logsDir; std::string m_logsTimestamp; // Deprecated debug filter logs DebugLogFilters _debugLogMask; }; #define sLog Log::instance() #define LOG_EXCEPTION_FREE(filterType__, level__, ...) \ { \ try \ { \ sLog->outMessage(filterType__, level__, __VA_ARGS__); \ } \ catch (std::exception const& e) \ { \ sLog->outMessage("server", LOG_LEVEL_ERROR, "Wrong format occurred (%s) at %s:%u.", \ e.what(), __FILE__, __LINE__); \ } \ } #ifdef PERFORMANCE_PROFILING #define LOG_MESSAGE_BODY(filterType__, level__, ...) ((void)0) #elif AC_PLATFORM != AC_PLATFORM_WINDOWS void check_args(char const*, ...) ATTR_PRINTF(1, 2); void check_args(std::string const&, ...); // This will catch format errors on build time #define LOG_MESSAGE_BODY(filterType__, level__, ...) \ do { \ if (sLog->ShouldLog(filterType__, level__)) \ { \ if (false) \ check_args(__VA_ARGS__); \ \ LOG_EXCEPTION_FREE(filterType__, level__, __VA_ARGS__); \ } \ } while (0) #else #define LOG_MESSAGE_BODY(filterType__, level__, ...) \ __pragma(warning(push)) \ __pragma(warning(disable:4127)) \ do { \ if (sLog->ShouldLog(filterType__, level__)) \ LOG_EXCEPTION_FREE(filterType__, level__, __VA_ARGS__); \ } while (0) \ __pragma(warning(pop)) #endif // Fatal - 1 #define LOG_FATAL(filterType__, ...) \ LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_FATAL, __VA_ARGS__) // Error - 2 #define LOG_ERROR(filterType__, ...) \ LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_ERROR, __VA_ARGS__) // Warning - 3 #define LOG_WARN(filterType__, ...) \ LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_WARN, __VA_ARGS__) // Info - 4 #define LOG_INFO(filterType__, ...) \ LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_INFO, __VA_ARGS__) // Debug - 5 #define LOG_DEBUG(filterType__, ...) \ LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_DEBUG, __VA_ARGS__) // Trace - 6 #define LOG_TRACE(filterType__, ...) \ LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_TRACE, __VA_ARGS__) #define LOG_CHAR_DUMP(message__, accountId__, guid__, name__) \ sLog->outCharDump(message__, accountId__, guid__, name__) #define LOG_GM(accountId__, ...) \ sLog->outCommand(accountId__, __VA_ARGS__) // New format logging #define FMT_LOG_EXCEPTION_FREE(filterType__, level__, ...) \ { \ try \ { \ sLog->outMessageFmt(filterType__, level__, fmt::format(__VA_ARGS__)); \ } \ catch (const std::exception& e) \ { \ sLog->outMessageFmt("server", LogLevel::LOG_LEVEL_ERROR, "Wrong format occurred ({}) at '{}:{}'", \ e.what(), __FILE__, __LINE__); \ } \ } #define FMT_LOG_MESSAGE_BODY(filterType__, level__, ...) \ do \ { \ if (sLog->ShouldLog(filterType__, level__)) \ FMT_LOG_EXCEPTION_FREE(filterType__, level__, __VA_ARGS__); \ } while (0) // Fatal - 1 #define FMT_LOG_FATAL(filterType__, ...) \ FMT_LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_FATAL, __VA_ARGS__) // Error - 2 #define FMT_LOG_ERROR(filterType__, ...) \ FMT_LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_ERROR, __VA_ARGS__) // Warning - 3 #define FMT_LOG_WARN(filterType__, ...) \ FMT_LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_WARN, __VA_ARGS__) // Info - 4 #define FMT_LOG_INFO(filterType__, ...) \ FMT_LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_INFO, __VA_ARGS__) // Debug - 5 #define FMT_LOG_DEBUG(filterType__, ...) \ FMT_LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_DEBUG, __VA_ARGS__) // Trace - 6 #define FMT_LOG_TRACE(filterType__, ...) \ FMT_LOG_MESSAGE_BODY(filterType__, LogLevel::LOG_LEVEL_TRACE, __VA_ARGS__) #endif // _LOG_H__