core/Logger.cpp
author David Anderson <dvander@alliedmods.net>
Thu Apr 05 05:25:11 2007 +0000 (2007-04-05)
changeset 663 b526b82e256e
parent 661 5c0988b9bf0c
child 665 74fa35a4c27c
permissions -rw-r--r--
changed the API around a bit to be more flexible
removed some ghastly unneeded stuff from the Translator
added Logger::LogFatal, experimental
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@663
    18
#include "sm_stringutil.h"
dvander@592
    19
#include "Logger.h"
dvander@592
    20
#include "systems/LibrarySys.h"
dvander@592
    21
#include "sm_version.h"
dvander@592
    22
dvander@616
    23
Logger g_Logger;
dvander@592
    24
dvander@592
    25
/**
dvander@592
    26
 * :TODO: This should be creating the log folder if it doesn't exist
dvander@592
    27
 */
dvander@592
    28
dvander@663
    29
ConfigResult Logger::OnSourceModConfigChanged(const char *key, 
dvander@663
    30
									  const char *value, 
dvander@663
    31
									  ConfigSource source,
dvander@663
    32
									  char *error, 
dvander@663
    33
									  size_t maxlength)
ds@661
    34
{
dvander@663
    35
	if (strcasecmp(key, "Logging") == 0)
ds@661
    36
	{
ds@661
    37
		bool state = true;
ds@661
    38
ds@661
    39
		if (strcasecmp(value, "on") == 0)
ds@661
    40
		{
ds@661
    41
		} else if (strcasecmp(value, "off") == 0) {
ds@661
    42
			state = false;
ds@661
    43
		} else {
dvander@663
    44
			UTIL_Format(error, maxlength, "Invalid value: must be \"on\" or \"off\"");
dvander@663
    45
			return ConfigResult_Reject;
ds@661
    46
		}
ds@661
    47
dvander@663
    48
		if (source == ConfigSource_Console)
ds@661
    49
		{
dvander@663
    50
			if (state && !m_Active)
dvander@663
    51
			{
dvander@663
    52
				EnableLogging();
dvander@663
    53
			} else if (!state && m_Active) {
dvander@663
    54
				DisableLogging();
dvander@663
    55
			}
dvander@663
    56
		} else {
ds@661
    57
			m_InitialState = state;
ds@661
    58
		}
ds@661
    59
dvander@663
    60
		return ConfigResult_Accept;
dvander@663
    61
	} else if (strcasecmp(key, "LogMode") == 0) {
ds@661
    62
		if (strcasecmp(value, "daily") == 0) 
ds@661
    63
		{
ds@661
    64
			m_Mode = LoggingMode_Daily;
ds@661
    65
		} else if (strcasecmp(value, "map") == 0) {
ds@661
    66
			m_Mode = LoggingMode_PerMap;
ds@661
    67
		} else if (strcasecmp(value, "game") == 0) {
ds@661
    68
			m_Mode = LoggingMode_Game;
ds@661
    69
		} else {
dvander@663
    70
			UTIL_Format(error, maxlength, "Invalid value: must be [daily|map|game]");
dvander@663
    71
			return ConfigResult_Reject;
ds@661
    72
		}
ds@661
    73
dvander@663
    74
		return ConfigResult_Accept;
ds@661
    75
	}
ds@661
    76
dvander@663
    77
	return ConfigResult_Ignore;
ds@661
    78
}
ds@661
    79
dvander@616
    80
void Logger::OnSourceModStartup(bool late)
dvander@592
    81
{
dvander@663
    82
	InitLogger(m_Mode);
dvander@592
    83
}
dvander@592
    84
dvander@616
    85
void Logger::OnSourceModAllShutdown()
dvander@592
    86
{
dvander@592
    87
	CloseLogger();
dvander@592
    88
}
dvander@592
    89
dvander@616
    90
void Logger::_NewMapFile()
dvander@592
    91
{
dvander@592
    92
	if (!m_Active)
dvander@592
    93
	{
dvander@592
    94
		return;
dvander@592
    95
	}
ds@661
    96
ds@661
    97
	/* Append "Log file closed" to previous log file */
ds@661
    98
	_CloseFile();
dvander@592
    99
	
dvander@592
   100
	char _filename[256];
dvander@592
   101
	int i = 0;
dvander@592
   102
dvander@592
   103
	time_t t;
dvander@592
   104
	time(&t);
dvander@592
   105
	tm *curtime = localtime(&t);
dvander@592
   106
dvander@592
   107
	while (true)
dvander@592
   108
	{
dvander@592
   109
		g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d%03d.log", curtime->tm_mon + 1, curtime->tm_mday, i);
dvander@592
   110
		FILE *fp = fopen(_filename, "r");
dvander@592
   111
		if (!fp)
dvander@592
   112
		{
dvander@592
   113
			break;
dvander@592
   114
		}
dvander@592
   115
		fclose(fp);
dvander@592
   116
		i++;
dvander@592
   117
	}
dvander@592
   118
	m_NrmFileName.assign(_filename);
dvander@592
   119
dvander@592
   120
	FILE *fp = fopen(m_NrmFileName.c_str(), "w");
dvander@592
   121
	if (!fp)
dvander@592
   122
	{
dvander@592
   123
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   124
		m_Active = false;
dvander@592
   125
		return;
dvander@592
   126
	} else {
dvander@592
   127
		char date[32];
dvander@592
   128
		strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   129
		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
   130
		fclose(fp);
dvander@592
   131
	}
dvander@592
   132
}
dvander@592
   133
dvander@616
   134
void Logger::_CloseFile()
dvander@592
   135
{
dvander@592
   136
	if (!m_Active)
dvander@592
   137
	{
dvander@592
   138
		return;
dvander@592
   139
	}
dvander@592
   140
dvander@592
   141
	FILE *fp = NULL;
dvander@592
   142
	if (!m_NrmFileName.empty())
dvander@592
   143
	{
dvander@592
   144
		fp = fopen(m_NrmFileName.c_str(), "r+");
dvander@592
   145
		if (fp)
dvander@592
   146
		{
dvander@592
   147
			fseek(fp, 0, SEEK_END);
dvander@592
   148
			LogMessage("Log file closed.");
dvander@592
   149
			fclose(fp);
dvander@592
   150
		}
dvander@592
   151
		m_NrmFileName.clear();
dvander@592
   152
	}
dvander@592
   153
dvander@592
   154
	if (!m_ErrMapStart)
dvander@592
   155
	{
dvander@592
   156
		return;
dvander@592
   157
	}
dvander@592
   158
	fp = fopen(m_ErrFileName.c_str(), "r+");
dvander@592
   159
	if (fp)
dvander@592
   160
	{
dvander@592
   161
		fseek(fp, 0, SEEK_END);
dvander@592
   162
		LogError("Error log file session closed.");
dvander@592
   163
		fclose(fp);
dvander@592
   164
	}
dvander@592
   165
	m_ErrFileName.clear();
dvander@592
   166
}
dvander@592
   167
dvander@663
   168
void Logger::InitLogger(LoggingMode mode)
dvander@592
   169
{
ds@661
   170
	m_Mode = mode;
dvander@663
   171
	m_Active = m_InitialState;
dvander@592
   172
dvander@592
   173
	time_t t;
dvander@592
   174
	time(&t);
dvander@592
   175
	tm *curtime = localtime(&t);
dvander@592
   176
	m_CurDay = curtime->tm_mday;
dvander@592
   177
dvander@592
   178
	char _filename[256];
dvander@592
   179
	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
   180
	m_ErrFileName.assign(_filename);
dvander@592
   181
ds@661
   182
	switch (m_Mode)
dvander@592
   183
	{
dvander@592
   184
	case LoggingMode_PerMap:
dvander@592
   185
		{
dvander@663
   186
			if (!m_Active)
dvander@592
   187
			{
dvander@592
   188
				m_DelayedStart = true;
dvander@592
   189
			}
dvander@592
   190
			break;
dvander@592
   191
		}
dvander@592
   192
	case LoggingMode_Daily:
dvander@592
   193
		{
dvander@592
   194
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   195
			m_NrmFileName.assign(_filename);
dvander@592
   196
			m_DailyPrintHdr = true;
dvander@592
   197
			break;
dvander@592
   198
		}
dvander@592
   199
	default:
dvander@592
   200
		{
dvander@592
   201
			/* do nothing... */
dvander@592
   202
			break;
dvander@592
   203
		}
dvander@592
   204
	}
dvander@592
   205
}
dvander@592
   206
dvander@616
   207
void Logger::CloseLogger()
dvander@592
   208
{
dvander@592
   209
	_CloseFile();
dvander@592
   210
}
dvander@592
   211
dvander@616
   212
void Logger::LogMessage(const char *vafmt, ...)
dvander@592
   213
{
dvander@592
   214
	if (!m_Active)
dvander@592
   215
	{
dvander@592
   216
		return;
dvander@592
   217
	}
dvander@592
   218
ds@661
   219
	if (m_Mode == LoggingMode_Game)
dvander@592
   220
	{
dvander@592
   221
		va_list ap;
dvander@592
   222
		va_start(ap, vafmt);
ds@661
   223
		_PrintToGameLog(vafmt, ap);
dvander@592
   224
		va_end(ap);
dvander@592
   225
		return;
dvander@592
   226
	}
dvander@592
   227
dvander@592
   228
	if (m_DelayedStart)
dvander@592
   229
	{
dvander@592
   230
		m_DelayedStart = false;
dvander@592
   231
		_NewMapFile();
dvander@592
   232
	}
dvander@592
   233
dvander@592
   234
	char msg[3072];
dvander@592
   235
	va_list ap;
dvander@592
   236
	va_start(ap, vafmt);
dvander@592
   237
	vsnprintf(msg, sizeof(msg), vafmt, ap);
dvander@592
   238
	va_end(ap);
dvander@592
   239
dvander@592
   240
	char date[32];
dvander@592
   241
	time_t t;
dvander@592
   242
	time(&t);
dvander@592
   243
	tm *curtime = localtime(&t);
dvander@592
   244
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   245
dvander@592
   246
	FILE *fp = NULL;
ds@661
   247
	if (m_Mode == LoggingMode_PerMap)
dvander@592
   248
	{
dvander@592
   249
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   250
		if (!fp)
dvander@592
   251
		{
dvander@592
   252
			_NewMapFile();
dvander@592
   253
			fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   254
			if (!fp)
dvander@592
   255
			{
dvander@592
   256
				goto print_error;
dvander@592
   257
			}
dvander@592
   258
		}
dvander@592
   259
	} else {
dvander@592
   260
		if (m_CurDay != curtime->tm_mday)
dvander@592
   261
		{
dvander@592
   262
			char _filename[256];
dvander@592
   263
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   264
			m_NrmFileName.assign(_filename);
dvander@592
   265
			m_CurDay = curtime->tm_mday;
dvander@592
   266
			m_DailyPrintHdr = true;
dvander@592
   267
		}
dvander@592
   268
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   269
	}
dvander@592
   270
dvander@592
   271
	if (fp)
dvander@592
   272
	{
dvander@592
   273
		if (m_DailyPrintHdr)
dvander@592
   274
		{
dvander@592
   275
			m_DailyPrintHdr = false;
dvander@592
   276
			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
   277
	 	}
dvander@592
   278
		fprintf(fp, "L %s: %s\n", date, msg);
dvander@592
   279
		fclose(fp);
dvander@592
   280
	} else {
dvander@592
   281
		goto print_error;
dvander@592
   282
	}
dvander@592
   283
dvander@592
   284
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
dvander@592
   285
	return;
dvander@592
   286
print_error:
dvander@592
   287
	g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   288
	m_Active = false;
dvander@592
   289
}
dvander@592
   290
dvander@616
   291
void Logger::LogError(const char *vafmt, ...)
dvander@592
   292
{
dvander@592
   293
	if (!m_Active)
dvander@592
   294
	{
dvander@592
   295
		return;
dvander@592
   296
	}
dvander@592
   297
dvander@592
   298
	time_t t;
dvander@592
   299
	time(&t);
dvander@592
   300
	tm *curtime = localtime(&t);
dvander@592
   301
dvander@592
   302
	char date[32];
dvander@592
   303
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   304
dvander@592
   305
	if (curtime->tm_mday != m_CurDay)
dvander@592
   306
	{
dvander@592
   307
		char _filename[256];
dvander@592
   308
		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
   309
		m_ErrFileName.assign(_filename);
dvander@592
   310
		m_CurDay = curtime->tm_mday;
dvander@592
   311
		m_ErrMapStart = false;
dvander@592
   312
	}
dvander@592
   313
dvander@592
   314
	char msg[3072];
dvander@592
   315
	va_list ap;
dvander@592
   316
	va_start(ap, vafmt);
dvander@592
   317
	vsnprintf(msg, sizeof(msg), vafmt, ap);
dvander@592
   318
	va_end(ap);
dvander@592
   319
dvander@592
   320
	FILE *fp = fopen(m_ErrFileName.c_str(), "a+");
dvander@592
   321
	if (fp)
dvander@592
   322
	{
dvander@592
   323
		if (!m_ErrMapStart)
dvander@592
   324
		{
dvander@592
   325
			fprintf(fp, "L %s: SourceMod error session started\n", date);
dvander@592
   326
			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
   327
			m_ErrMapStart = true;
dvander@592
   328
		}
dvander@592
   329
		fprintf(fp, "L %s: %s\n", date, msg);
dvander@592
   330
		fclose(fp);
dvander@592
   331
	} else {
dvander@592
   332
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   333
		m_Active = false;
dvander@592
   334
		return;
dvander@592
   335
	}
dvander@592
   336
dvander@592
   337
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
dvander@592
   338
}
dvander@592
   339
dvander@616
   340
void Logger::MapChange(const char *mapname)
dvander@592
   341
{
dvander@592
   342
	m_CurMapName.assign(mapname);
dvander@592
   343
ds@661
   344
	switch (m_Mode)
dvander@592
   345
	{
dvander@592
   346
	case LoggingMode_Daily:
dvander@592
   347
		{
dvander@592
   348
			LogMessage("-------- Mapchange to %s --------", mapname);
dvander@592
   349
			break;
dvander@592
   350
		}
dvander@592
   351
	case LoggingMode_PerMap:
dvander@592
   352
		{
dvander@592
   353
			_NewMapFile();
dvander@592
   354
			break;
dvander@592
   355
		}
dvander@592
   356
	default:
dvander@592
   357
		{
dvander@592
   358
			/* Do nothing... */
dvander@592
   359
			break;
dvander@592
   360
		}
dvander@592
   361
	}
dvander@592
   362
dvander@592
   363
	if (m_ErrMapStart)
dvander@592
   364
	{
dvander@592
   365
		LogError("Error log file session closed.");
dvander@592
   366
	}
dvander@592
   367
	m_ErrMapStart = false;
dvander@592
   368
}
dvander@592
   369
ds@661
   370
void Logger::_PrintToGameLog(const char *fmt, va_list ap)
dvander@592
   371
{
dvander@592
   372
	char msg[3072];
dvander@592
   373
	size_t len;
dvander@592
   374
dvander@592
   375
	len = vsnprintf(msg, sizeof(msg)-2, fmt, ap);
dvander@592
   376
	len = (len >= sizeof(msg)) ? (sizeof(msg) - 2) : len;
dvander@592
   377
dvander@592
   378
	msg[len++] = '\n';
dvander@592
   379
	msg[len] = '\0';
dvander@592
   380
dvander@592
   381
	engine->LogPrint(msg);
dvander@592
   382
}
dvander@592
   383
dvander@616
   384
const char *Logger::GetLogFileName(LogType type) const
dvander@592
   385
{
dvander@592
   386
	switch (type)
dvander@592
   387
	{
dvander@592
   388
	case LogType_Normal:
dvander@592
   389
		{
dvander@592
   390
			return m_NrmFileName.c_str();
dvander@592
   391
		}
dvander@592
   392
	case LogType_Error:
dvander@592
   393
		{
dvander@592
   394
			return m_ErrFileName.c_str();
dvander@592
   395
		}
dvander@592
   396
	default:
dvander@592
   397
		{
dvander@592
   398
			return "";
dvander@592
   399
		}
dvander@592
   400
	}
dvander@592
   401
}
dvander@592
   402
dvander@616
   403
LoggingMode Logger::GetLoggingMode() const
dvander@592
   404
{
ds@661
   405
	return m_Mode;
dvander@592
   406
}
dvander@592
   407
dvander@616
   408
void Logger::EnableLogging()
dvander@592
   409
{
dvander@592
   410
	if (m_Active)
dvander@592
   411
	{
dvander@592
   412
		return;
dvander@592
   413
	}
dvander@592
   414
	m_Active = true;
dvander@592
   415
	LogMessage("Logging enabled manually by user.");
dvander@592
   416
}
dvander@592
   417
dvander@616
   418
void Logger::DisableLogging()
dvander@592
   419
{
dvander@592
   420
	if (!m_Active)
dvander@592
   421
	{
dvander@592
   422
		return;
dvander@592
   423
	}
dvander@592
   424
	LogMessage("Logging disabled manually by user.");
dvander@592
   425
	m_Active = false;
dvander@592
   426
}
dvander@663
   427
dvander@663
   428
void Logger::LogFatal(const char *msg, ...)
dvander@663
   429
{
dvander@663
   430
	char path[PLATFORM_MAX_PATH];
dvander@663
   431
	g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "sourcemod_fatal.log");
dvander@663
   432
	FILE *fp = fopen(path, "at");
dvander@663
   433
	if (!fp)
dvander@663
   434
	{
dvander@663
   435
		/* We're just doomed, aren't we... */
dvander@663
   436
		return;
dvander@663
   437
	}
dvander@663
   438
dvander@663
   439
	va_list ap;
dvander@663
   440
	va_start(ap, msg);
dvander@663
   441
	vfprintf(fp, msg, ap);
dvander@663
   442
	va_end(ap);
dvander@663
   443
dvander@663
   444
	fputs("\n", fp);
dvander@663
   445
	
dvander@663
   446
	fclose(fp);
dvander@663
   447
}