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