eqemu-server/common/eqemu_logsys.cpp

/*	EQEMu: Everquest Server Emulator
	Copyright (C) 2001-2015 EQEMu Development Team (http://eqemulator.net)

	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; version 2 of the License.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY except by those people which sell it, which
	are required to give you total support for your newly bought product;
	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
*/


#include "eqemu_logsys.h"
#include "platform.h"
#include "string_util.h"
#include "database.h"
#include "misc.h"

#include <iostream>
#include <fstream>
#include <string>
#include <iomanip>
#include <time.h>
#include <sys/stat.h>

std::ofstream process_log;

#ifdef _WINDOWS
	#include <direct.h>
	#include <conio.h>
	#include <iostream>
	#include <dos.h>
	#include <windows.h>
	#include <process.h>
#else
	#include <unistd.h>
	#include <sys/stat.h>
#endif

/* Linux ANSI console color defines */
#define LC_RESET   "\033[0m"
#define LC_BLACK   "\033[30m"      /* Black */
#define LC_RED     "\033[31m"      /* Red */
#define LC_GREEN   "\033[32m"      /* Green */
#define LC_YELLOW  "\033[33m"      /* Yellow */
#define LC_BLUE    "\033[34m"      /* Blue */
#define LC_MAGENTA "\033[35m"      /* Magenta */
#define LC_CYAN    "\033[36m"      /* Cyan */
#define LC_WHITE   "\033[37m"      /* White */

namespace Console {
	enum Color {
		Black = 0,
		Blue = 1,
		Green = 2,
		Cyan = 3,
		Red = 4,
		Magenta = 5,
		Brown = 6,
		LightGray = 7,
		DarkGray = 8,
		LightBlue = 9,
		LightGreen = 10,
		LightCyan = 11,
		LightRed = 12,
		LightMagenta = 13,
		Yellow = 14,
		White = 15
	};
}

EQEmuLogSys::EQEmuLogSys()
{
	on_log_gmsay_hook = [](uint16 log_type, const std::string&) {};
	bool file_logs_enabled = false;
	int log_platform = 0;
}

EQEmuLogSys::~EQEmuLogSys()
{
}

void EQEmuLogSys::LoadLogSettingsDefaults()
{
	/* Get Executable platform currently running this code (Zone/World/etc) */
	log_platform = GetExecutablePlatformInt();

	/* Zero out Array */
	memset(log_settings, 0, sizeof(LogSettings) * Logs::LogCategory::MaxCategoryID);

	/* Set Defaults */
	log_settings[Logs::World_Server].log_to_console = Logs::General;
	log_settings[Logs::Zone_Server].log_to_console = Logs::General;
	log_settings[Logs::QS_Server].log_to_console = Logs::General;
	log_settings[Logs::UCS_Server].log_to_console = Logs::General;
	log_settings[Logs::Crash].log_to_console = Logs::General;
	log_settings[Logs::MySQLError].log_to_console = Logs::General;
	log_settings[Logs::Login_Server].log_to_console = Logs::General;

	/* Set Category enabled status on defaults */
	log_settings[Logs::World_Server].is_category_enabled = 1;
	log_settings[Logs::Zone_Server].is_category_enabled = 1;
	log_settings[Logs::QS_Server].is_category_enabled = 1;
	log_settings[Logs::UCS_Server].is_category_enabled = 1;
	log_settings[Logs::Crash].is_category_enabled = 1;
	log_settings[Logs::MySQLError].is_category_enabled = 1;
	log_settings[Logs::Login_Server].is_category_enabled = 1;

	/*	Declare process file names for log writing
		If there is no process_file_name declared, no log file will be written, simply
	*/
	if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformWorld)
		platform_file_name = "world";
	else if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformQueryServ)
		platform_file_name = "query_server";
	else if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformZone)
		platform_file_name = "zone";
	else if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformUCS)
		platform_file_name = "ucs";
	else if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformLogin)
		platform_file_name = "login";
	else if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformLaunch)
		platform_file_name = "launcher";
}

std::string EQEmuLogSys::FormatOutMessageString(uint16 log_category, const std::string &in_message)
{
	std::string ret;
	ret.push_back('[');
	ret.append(Logs::LogCategoryName[log_category]);
	ret.push_back(']');
	ret.push_back(' ');
	ret.append(in_message);
	return ret;
}

void EQEmuLogSys::ProcessGMSay(uint16 debug_level, uint16 log_category, const std::string &message)
{
	/* Enabling Netcode based GMSay output creates a feedback loop that ultimately ends in a crash */
	if (log_category == Logs::LogCategory::Netcode)
		return;

	/* Check to see if the process that actually ran this is zone */
	if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformZone)
		on_log_gmsay_hook(log_category, message);
}

void EQEmuLogSys::ProcessLogWrite(uint16 debug_level, uint16 log_category, const std::string &message)
{
	if (log_category == Logs::Crash) {
		char time_stamp[80];
		EQEmuLogSys::SetCurrentTimeStamp(time_stamp);
		std::ofstream crash_log;
		EQEmuLogSys::MakeDirectory("logs/crashes");
		crash_log.open(StringFormat("logs/crashes/crash_%s_%i.log", platform_file_name.c_str(), getpid()), std::ios_base::app | std::ios_base::out);
		crash_log << time_stamp << " " << message << "\n";
		crash_log.close();
	}

	char time_stamp[80];
	EQEmuLogSys::SetCurrentTimeStamp(time_stamp);

	if (process_log)
		process_log << time_stamp << " " << message << std::endl;
}

uint16 EQEmuLogSys::GetWindowsConsoleColorFromCategory(uint16 log_category) {
	switch (log_category) {
		case Logs::Status:
		case Logs::Normal:
			return Console::Color::Yellow;
		case Logs::MySQLError:
		case Logs::Error:
			return Console::Color::LightRed;
		case Logs::MySQLQuery:
		case Logs::Debug:
			return Console::Color::LightGreen;
		case Logs::Quests:
			return Console::Color::LightCyan;
		case Logs::Commands:
		case Logs::Mercenaries:
			return Console::Color::LightMagenta;
		case Logs::Crash:
			return Console::Color::LightRed;
		default:
			return Console::Color::Yellow;
	}
}

std::string EQEmuLogSys::GetLinuxConsoleColorFromCategory(uint16 log_category) {
	switch (log_category) {
		case Logs::Status:
		case Logs::Normal:
			return LC_YELLOW;
		case Logs::MySQLError:
		case Logs::Error:
			return LC_RED;
		case Logs::MySQLQuery:
		case Logs::Debug:
			return LC_GREEN;
		case Logs::Quests:
			return LC_CYAN;
		case Logs::Commands:
		case Logs::Mercenaries:
			return LC_MAGENTA;
		case Logs::Crash:
			return LC_RED;
		default:
			return LC_YELLOW;
	}
}

uint16 EQEmuLogSys::GetGMSayColorFromCategory(uint16 log_category) {
	switch (log_category) {
		case Logs::Status:
		case Logs::Normal:
			return 15; /* Yellow */
		case Logs::MySQLError:
		case Logs::Error:
			return 13; /* Red */
		case Logs::MySQLQuery:
		case Logs::Debug:
			return 14; /* Light Green */
		case Logs::Quests:
			return 258; /* Light Cyan */
		case Logs::Commands:
		case Logs::Mercenaries:
			return 5; /* Light Purple */
		case Logs::Crash:
			return 13; /* Red */
		default:
			return 15; /* Yellow */
	}
}

void EQEmuLogSys::ProcessConsoleMessage(uint16 debug_level, uint16 log_category, const std::string &message)
{

	#ifdef _WINDOWS
		HANDLE  console_handle;
		console_handle = GetStdHandle(STD_OUTPUT_HANDLE);
		CONSOLE_FONT_INFOEX info = { 0 };
		info.cbSize = sizeof(info);
		info.dwFontSize.Y = 12; // leave X as zero
		info.FontWeight = FW_NORMAL;
		wcscpy(info.FaceName, L"Lucida Console");
		SetCurrentConsoleFontEx(console_handle, NULL, &info);
		SetConsoleTextAttribute(console_handle, EQEmuLogSys::GetWindowsConsoleColorFromCategory(log_category));
		std::cout << message << "\n";
		SetConsoleTextAttribute(console_handle, Console::Color::White);
	#else
		std::cout << EQEmuLogSys::GetLinuxConsoleColorFromCategory(log_category) << message << LC_RESET << std::endl;
	#endif
}

void EQEmuLogSys::Out(Logs::DebugLevel debug_level, uint16 log_category, std::string message, ...)
{

	bool log_to_console = true;
	if (log_settings[log_category].log_to_console < debug_level) {
		log_to_console = false;
	}

	bool log_to_file = true;
	if (log_settings[log_category].log_to_file < debug_level) {
		log_to_file = false;
	}

	bool log_to_gmsay = true;
	if (log_settings[log_category].log_to_gmsay < debug_level) {
		log_to_gmsay = false;
	}

	const bool nothing_to_log = !log_to_console && !log_to_file && !log_to_gmsay;
	if (nothing_to_log)
		return;

	va_list args;
	va_start(args, message);
	std::string output_message = vStringFormat(message.c_str(), args);
	va_end(args);

	std::string output_debug_message = EQEmuLogSys::FormatOutMessageString(log_category, output_message);

	if (log_to_console) EQEmuLogSys::ProcessConsoleMessage(debug_level, log_category, output_debug_message);
	if (log_to_gmsay) EQEmuLogSys::ProcessGMSay(debug_level, log_category, output_debug_message);
	if (log_to_file) EQEmuLogSys::ProcessLogWrite(debug_level, log_category, output_debug_message);
}

void EQEmuLogSys::SetCurrentTimeStamp(char* time_stamp)
{
	time_t raw_time;
	struct tm * time_info;
	time(&raw_time);
	time_info = localtime(&raw_time);
	strftime(time_stamp, 80, "[%m-%d-%Y :: %H:%M:%S]", time_info);
}

void EQEmuLogSys::MakeDirectory(const std::string &directory_name)
{
#ifdef _WINDOWS
	struct _stat st;
	if (_stat(directory_name.c_str(), &st) == 0) // exists
		return;
	_mkdir(directory_name.c_str());
#else
	struct stat st;
	if (stat(directory_name.c_str(), &st) == 0) // exists
		return;
	mkdir(directory_name.c_str(), 0755);
#endif
}

void EQEmuLogSys::CloseFileLogs()
{
	if (process_log.is_open()) {
		process_log.close();
	}
}

void EQEmuLogSys::StartFileLogs(const std::string &log_name)
{
	EQEmuLogSys::CloseFileLogs();

	/* When loading settings, we must have been given a reason in category based logging to output to a file in order to even create or open one... */
	if (file_logs_enabled == false)
		return;

	if (EQEmuLogSys::log_platform == EQEmuExePlatform::ExePlatformZone) {
		if (!log_name.empty())
			platform_file_name = log_name;

		if (platform_file_name.empty())
			return;

		EQEmuLogSys::Out(Logs::General, Logs::Status, "Starting File Log 'logs/%s_%i.log'", platform_file_name.c_str(), getpid());
		EQEmuLogSys::MakeDirectory("logs/zone");
		process_log.open(StringFormat("logs/zone/%s_%i.log", platform_file_name.c_str(), getpid()), std::ios_base::app | std::ios_base::out);
	} else {
		if (platform_file_name.empty())
			return;

		EQEmuLogSys::Out(Logs::General, Logs::Status, "Starting File Log 'logs/%s_%i.log'", platform_file_name.c_str(), getpid());
		process_log.open(StringFormat("logs/%s_%i.log", platform_file_name.c_str(), getpid()), std::ios_base::app | std::ios_base::out);
	}
}