core/Logger.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Apr 05 03:02:00 2007 +0000 (2007-04-05)
changeset 661 5c0988b9bf0c
parent 653 ef60870067ff
child 663 b526b82e256e
permissions -rw-r--r--
Ugh, initial import of core config file stuff
Warning: This is positively terrible code.
It works, but needs A LOT of work still :\
dvander@592
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@592
     3
 * ===============================================================
dvander@592
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@592
     5
 * ===============================================================
dvander@592
     6
 *
dvander@592
     7
 * This file is not open source and may not be copied without explicit
dvander@592
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@592
     9
 * in whole or significant part.
dvander@592
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@592
    11
 *
dvander@592
    12
 * Version: $Id$
dvander@592
    13
 */
dvander@592
    14
dvander@592
    15
#include <time.h>
dvander@592
    16
#include "sourcemod.h"
dvander@592
    17
#include "sourcemm_api.h"
dvander@592
    18
#include "Logger.h"
dvander@592
    19
#include "systems/LibrarySys.h"
dvander@592
    20
#include "sm_version.h"
dvander@592
    21
dvander@616
    22
Logger g_Logger;
dvander@592
    23
dvander@592
    24
/**
dvander@592
    25
 * :TODO: This should be creating the log folder if it doesn't exist
dvander@592
    26
 */
dvander@592
    27
ds@661
    28
CoreConfigErr Logger::OnSourceModConfigChanged(const char *option, const char *value)
ds@661
    29
{
ds@661
    30
	if (strcasecmp(option, "Logging") == 0)
ds@661
    31
	{
ds@661
    32
		bool state = true;
ds@661
    33
ds@661
    34
		if (strcasecmp(value, "on") == 0)
ds@661
    35
		{
ds@661
    36
			state = true;
ds@661
    37
		} else if (strcasecmp(value, "off") == 0) {
ds@661
    38
			state = false;
ds@661
    39
		} else {
ds@661
    40
			return CoreConfig_InvalidValue;
ds@661
    41
		}
ds@661
    42
ds@661
    43
		if (m_FirstPass)
ds@661
    44
		{
ds@661
    45
			m_InitialState = state;
ds@661
    46
			m_FirstPass = false;
ds@661
    47
		} else {
ds@661
    48
			state ? g_Logger.EnableLogging() : g_Logger.DisableLogging();
ds@661
    49
		}
ds@661
    50
ds@661
    51
		return CoreConfig_Okay;
ds@661
    52
	} else if (strcasecmp(option, "LogMode") == 0) {
ds@661
    53
		if (strcasecmp(value, "daily") == 0) 
ds@661
    54
		{
ds@661
    55
			m_Mode = LoggingMode_Daily;
ds@661
    56
		} else if (strcasecmp(value, "map") == 0) {
ds@661
    57
			m_Mode = LoggingMode_PerMap;
ds@661
    58
		} else if (strcasecmp(value, "game") == 0) {
ds@661
    59
			m_Mode = LoggingMode_Game;
ds@661
    60
		} else {
ds@661
    61
			return CoreConfig_InvalidValue;
ds@661
    62
		}
ds@661
    63
ds@661
    64
		return CoreConfig_Okay;
ds@661
    65
	}
ds@661
    66
ds@661
    67
	return CoreConfig_InvalidOption;
ds@661
    68
}
ds@661
    69
dvander@616
    70
void Logger::OnSourceModStartup(bool late)
dvander@592
    71
{
ds@661
    72
	InitLogger(m_Mode, m_InitialState);
dvander@592
    73
}
dvander@592
    74
dvander@616
    75
void Logger::OnSourceModAllShutdown()
dvander@592
    76
{
dvander@592
    77
	CloseLogger();
dvander@592
    78
}
dvander@592
    79
dvander@616
    80
void Logger::_NewMapFile()
dvander@592
    81
{
dvander@592
    82
	if (!m_Active)
dvander@592
    83
	{
dvander@592
    84
		return;
dvander@592
    85
	}
ds@661
    86
ds@661
    87
	/* Append "Log file closed" to previous log file */
ds@661
    88
	_CloseFile();
dvander@592
    89
	
dvander@592
    90
	char _filename[256];
dvander@592
    91
	int i = 0;
dvander@592
    92
dvander@592
    93
	time_t t;
dvander@592
    94
	time(&t);
dvander@592
    95
	tm *curtime = localtime(&t);
dvander@592
    96
dvander@592
    97
	while (true)
dvander@592
    98
	{
dvander@592
    99
		g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d%03d.log", curtime->tm_mon + 1, curtime->tm_mday, i);
dvander@592
   100
		FILE *fp = fopen(_filename, "r");
dvander@592
   101
		if (!fp)
dvander@592
   102
		{
dvander@592
   103
			break;
dvander@592
   104
		}
dvander@592
   105
		fclose(fp);
dvander@592
   106
		i++;
dvander@592
   107
	}
dvander@592
   108
	m_NrmFileName.assign(_filename);
dvander@592
   109
dvander@592
   110
	FILE *fp = fopen(m_NrmFileName.c_str(), "w");
dvander@592
   111
	if (!fp)
dvander@592
   112
	{
dvander@592
   113
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   114
		m_Active = false;
dvander@592
   115
		return;
dvander@592
   116
	} else {
dvander@592
   117
		char date[32];
dvander@592
   118
		strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   119
		fprintf(fp, "L %s: SourceMod log file started (file \"logs_%02d%02d%03d.log\") (Version \"%s\")\n", date, curtime->tm_mon + 1, curtime->tm_mday, i, SVN_FULL_VERSION);
dvander@592
   120
		fclose(fp);
dvander@592
   121
	}
dvander@592
   122
}
dvander@592
   123
dvander@616
   124
void Logger::_CloseFile()
dvander@592
   125
{
dvander@592
   126
	if (!m_Active)
dvander@592
   127
	{
dvander@592
   128
		return;
dvander@592
   129
	}
dvander@592
   130
dvander@592
   131
	FILE *fp = NULL;
dvander@592
   132
	if (!m_NrmFileName.empty())
dvander@592
   133
	{
dvander@592
   134
		fp = fopen(m_NrmFileName.c_str(), "r+");
dvander@592
   135
		if (fp)
dvander@592
   136
		{
dvander@592
   137
			fseek(fp, 0, SEEK_END);
dvander@592
   138
			LogMessage("Log file closed.");
dvander@592
   139
			fclose(fp);
dvander@592
   140
		}
dvander@592
   141
		m_NrmFileName.clear();
dvander@592
   142
	}
dvander@592
   143
dvander@592
   144
	if (!m_ErrMapStart)
dvander@592
   145
	{
dvander@592
   146
		return;
dvander@592
   147
	}
dvander@592
   148
	fp = fopen(m_ErrFileName.c_str(), "r+");
dvander@592
   149
	if (fp)
dvander@592
   150
	{
dvander@592
   151
		fseek(fp, 0, SEEK_END);
dvander@592
   152
		LogError("Error log file session closed.");
dvander@592
   153
		fclose(fp);
dvander@592
   154
	}
dvander@592
   155
	m_ErrFileName.clear();
dvander@592
   156
}
dvander@592
   157
dvander@616
   158
void Logger::InitLogger(LoggingMode mode, bool startlogging)
dvander@592
   159
{
ds@661
   160
	m_Mode = mode;
dvander@592
   161
	m_Active = startlogging;
dvander@592
   162
dvander@592
   163
	time_t t;
dvander@592
   164
	time(&t);
dvander@592
   165
	tm *curtime = localtime(&t);
dvander@592
   166
	m_CurDay = curtime->tm_mday;
dvander@592
   167
dvander@592
   168
	char _filename[256];
dvander@592
   169
	g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/errors_%02d%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday, curtime->tm_year - 100);
dvander@592
   170
	m_ErrFileName.assign(_filename);
dvander@592
   171
ds@661
   172
	switch (m_Mode)
dvander@592
   173
	{
dvander@592
   174
	case LoggingMode_PerMap:
dvander@592
   175
		{
dvander@592
   176
			if (!startlogging)
dvander@592
   177
			{
dvander@592
   178
				m_DelayedStart = true;
dvander@592
   179
			}
dvander@592
   180
			break;
dvander@592
   181
		}
dvander@592
   182
	case LoggingMode_Daily:
dvander@592
   183
		{
dvander@592
   184
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   185
			m_NrmFileName.assign(_filename);
dvander@592
   186
			m_DailyPrintHdr = true;
dvander@592
   187
			break;
dvander@592
   188
		}
dvander@592
   189
	default:
dvander@592
   190
		{
dvander@592
   191
			/* do nothing... */
dvander@592
   192
			break;
dvander@592
   193
		}
dvander@592
   194
	}
dvander@592
   195
}
dvander@592
   196
dvander@616
   197
void Logger::CloseLogger()
dvander@592
   198
{
dvander@592
   199
	_CloseFile();
dvander@592
   200
}
dvander@592
   201
dvander@616
   202
void Logger::LogMessage(const char *vafmt, ...)
dvander@592
   203
{
dvander@592
   204
	if (!m_Active)
dvander@592
   205
	{
dvander@592
   206
		return;
dvander@592
   207
	}
dvander@592
   208
ds@661
   209
	if (m_Mode == LoggingMode_Game)
dvander@592
   210
	{
dvander@592
   211
		va_list ap;
dvander@592
   212
		va_start(ap, vafmt);
ds@661
   213
		_PrintToGameLog(vafmt, ap);
dvander@592
   214
		va_end(ap);
dvander@592
   215
		return;
dvander@592
   216
	}
dvander@592
   217
dvander@592
   218
	if (m_DelayedStart)
dvander@592
   219
	{
dvander@592
   220
		m_DelayedStart = false;
dvander@592
   221
		_NewMapFile();
dvander@592
   222
	}
dvander@592
   223
dvander@592
   224
	char msg[3072];
dvander@592
   225
	va_list ap;
dvander@592
   226
	va_start(ap, vafmt);
dvander@592
   227
	vsnprintf(msg, sizeof(msg), vafmt, ap);
dvander@592
   228
	va_end(ap);
dvander@592
   229
dvander@592
   230
	char date[32];
dvander@592
   231
	time_t t;
dvander@592
   232
	time(&t);
dvander@592
   233
	tm *curtime = localtime(&t);
dvander@592
   234
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   235
dvander@592
   236
	FILE *fp = NULL;
ds@661
   237
	if (m_Mode == LoggingMode_PerMap)
dvander@592
   238
	{
dvander@592
   239
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   240
		if (!fp)
dvander@592
   241
		{
dvander@592
   242
			_NewMapFile();
dvander@592
   243
			fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   244
			if (!fp)
dvander@592
   245
			{
dvander@592
   246
				goto print_error;
dvander@592
   247
			}
dvander@592
   248
		}
dvander@592
   249
	} else {
dvander@592
   250
		if (m_CurDay != curtime->tm_mday)
dvander@592
   251
		{
dvander@592
   252
			char _filename[256];
dvander@592
   253
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   254
			m_NrmFileName.assign(_filename);
dvander@592
   255
			m_CurDay = curtime->tm_mday;
dvander@592
   256
			m_DailyPrintHdr = true;
dvander@592
   257
		}
dvander@592
   258
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   259
	}
dvander@592
   260
dvander@592
   261
	if (fp)
dvander@592
   262
	{
dvander@592
   263
		if (m_DailyPrintHdr)
dvander@592
   264
		{
dvander@592
   265
			m_DailyPrintHdr = false;
dvander@592
   266
			fprintf(fp, "L %s: SourceMod log file session started (file \"logs_%02d%02d.log\") (Version \"%s\")\n", date, curtime->tm_mon + 1, curtime->tm_mday, SVN_FULL_VERSION);
dvander@592
   267
	 	}
dvander@592
   268
		fprintf(fp, "L %s: %s\n", date, msg);
dvander@592
   269
		fclose(fp);
dvander@592
   270
	} else {
dvander@592
   271
		goto print_error;
dvander@592
   272
	}
dvander@592
   273
dvander@592
   274
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
dvander@592
   275
	return;
dvander@592
   276
print_error:
dvander@592
   277
	g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   278
	m_Active = false;
dvander@592
   279
}
dvander@592
   280
dvander@616
   281
void Logger::LogError(const char *vafmt, ...)
dvander@592
   282
{
dvander@592
   283
	if (!m_Active)
dvander@592
   284
	{
dvander@592
   285
		return;
dvander@592
   286
	}
dvander@592
   287
dvander@592
   288
	time_t t;
dvander@592
   289
	time(&t);
dvander@592
   290
	tm *curtime = localtime(&t);
dvander@592
   291
dvander@592
   292
	char date[32];
dvander@592
   293
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   294
dvander@592
   295
	if (curtime->tm_mday != m_CurDay)
dvander@592
   296
	{
dvander@592
   297
		char _filename[256];
dvander@592
   298
		g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/errors_%02d%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday, curtime->tm_year - 100);
dvander@592
   299
		m_ErrFileName.assign(_filename);
dvander@592
   300
		m_CurDay = curtime->tm_mday;
dvander@592
   301
		m_ErrMapStart = false;
dvander@592
   302
	}
dvander@592
   303
dvander@592
   304
	char msg[3072];
dvander@592
   305
	va_list ap;
dvander@592
   306
	va_start(ap, vafmt);
dvander@592
   307
	vsnprintf(msg, sizeof(msg), vafmt, ap);
dvander@592
   308
	va_end(ap);
dvander@592
   309
dvander@592
   310
	FILE *fp = fopen(m_ErrFileName.c_str(), "a+");
dvander@592
   311
	if (fp)
dvander@592
   312
	{
dvander@592
   313
		if (!m_ErrMapStart)
dvander@592
   314
		{
dvander@592
   315
			fprintf(fp, "L %s: SourceMod error session started\n", date);
dvander@592
   316
			fprintf(fp, "L %s: Info (map \"%s\") (log file \"errors_%02d%02d%02d.log\")\n", date, m_CurMapName.c_str(), curtime->tm_mon + 1, curtime->tm_mday, curtime->tm_year - 100);
dvander@592
   317
			m_ErrMapStart = true;
dvander@592
   318
		}
dvander@592
   319
		fprintf(fp, "L %s: %s\n", date, msg);
dvander@592
   320
		fclose(fp);
dvander@592
   321
	} else {
dvander@592
   322
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   323
		m_Active = false;
dvander@592
   324
		return;
dvander@592
   325
	}
dvander@592
   326
dvander@592
   327
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
dvander@592
   328
}
dvander@592
   329
dvander@616
   330
void Logger::MapChange(const char *mapname)
dvander@592
   331
{
dvander@592
   332
	m_CurMapName.assign(mapname);
dvander@592
   333
ds@661
   334
	switch (m_Mode)
dvander@592
   335
	{
dvander@592
   336
	case LoggingMode_Daily:
dvander@592
   337
		{
dvander@592
   338
			LogMessage("-------- Mapchange to %s --------", mapname);
dvander@592
   339
			break;
dvander@592
   340
		}
dvander@592
   341
	case LoggingMode_PerMap:
dvander@592
   342
		{
dvander@592
   343
			_NewMapFile();
dvander@592
   344
			break;
dvander@592
   345
		}
dvander@592
   346
	default:
dvander@592
   347
		{
dvander@592
   348
			/* Do nothing... */
dvander@592
   349
			break;
dvander@592
   350
		}
dvander@592
   351
	}
dvander@592
   352
dvander@592
   353
	if (m_ErrMapStart)
dvander@592
   354
	{
dvander@592
   355
		LogError("Error log file session closed.");
dvander@592
   356
	}
dvander@592
   357
	m_ErrMapStart = false;
dvander@592
   358
}
dvander@592
   359
ds@661
   360
void Logger::_PrintToGameLog(const char *fmt, va_list ap)
dvander@592
   361
{
dvander@592
   362
	char msg[3072];
dvander@592
   363
	size_t len;
dvander@592
   364
dvander@592
   365
	len = vsnprintf(msg, sizeof(msg)-2, fmt, ap);
dvander@592
   366
	len = (len >= sizeof(msg)) ? (sizeof(msg) - 2) : len;
dvander@592
   367
dvander@592
   368
	msg[len++] = '\n';
dvander@592
   369
	msg[len] = '\0';
dvander@592
   370
dvander@592
   371
	engine->LogPrint(msg);
dvander@592
   372
}
dvander@592
   373
dvander@616
   374
const char *Logger::GetLogFileName(LogType type) const
dvander@592
   375
{
dvander@592
   376
	switch (type)
dvander@592
   377
	{
dvander@592
   378
	case LogType_Normal:
dvander@592
   379
		{
dvander@592
   380
			return m_NrmFileName.c_str();
dvander@592
   381
		}
dvander@592
   382
	case LogType_Error:
dvander@592
   383
		{
dvander@592
   384
			return m_ErrFileName.c_str();
dvander@592
   385
		}
dvander@592
   386
	default:
dvander@592
   387
		{
dvander@592
   388
			return "";
dvander@592
   389
		}
dvander@592
   390
	}
dvander@592
   391
}
dvander@592
   392
dvander@616
   393
LoggingMode Logger::GetLoggingMode() const
dvander@592
   394
{
ds@661
   395
	return m_Mode;
dvander@592
   396
}
dvander@592
   397
dvander@616
   398
void Logger::EnableLogging()
dvander@592
   399
{
dvander@592
   400
	if (m_Active)
dvander@592
   401
	{
dvander@592
   402
		return;
dvander@592
   403
	}
dvander@592
   404
	m_Active = true;
dvander@592
   405
	LogMessage("Logging enabled manually by user.");
dvander@592
   406
}
dvander@592
   407
dvander@616
   408
void Logger::DisableLogging()
dvander@592
   409
{
dvander@592
   410
	if (!m_Active)
dvander@592
   411
	{
dvander@592
   412
		return;
dvander@592
   413
	}
dvander@592
   414
	LogMessage("Logging disabled manually by user.");
dvander@592
   415
	m_Active = false;
dvander@592
   416
}