core/Logger.cpp
author David Anderson <dvander@alliedmods.net>
Wed Aug 01 02:12:47 2007 +0000 (2007-08-01)
changeset 1231 17badaf66ce4
parent 738 af89f69ac3a0
child 1330 ab94316bb52b
permissions -rw-r--r--
updated more header files (mostly internal now)
dvander@592
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@1231
     3
 * ================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1231
     6
 * ================================================================
dvander@592
     7
 *
dvander@1231
     8
 * This program is free software; you can redistribute it and/or 
dvander@1231
     9
 * modify it under the terms of the GNU General Public License, 
dvander@1231
    10
 * version 3.0, as published by the Free Software Foundation.
dvander@1231
    11
 * 
dvander@1231
    12
 * This program is distributed in the hope that it will be useful,
dvander@1231
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1231
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1231
    15
 * GNU General Public License for more details.
dvander@1231
    16
 *
dvander@1231
    17
 * You should have received a copy of the GNU General Public License
dvander@1231
    18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
dvander@1231
    20
 * As a special exception, AlliedModders LLC gives you permission to 
dvander@1231
    21
 * link the code of this program (as well as its derivative works) to 
dvander@1231
    22
 * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1231
    23
 * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1231
    24
 * obey the GNU General Public License in all respects for all other 
dvander@1231
    25
 * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1231
    26
 * to all derivative works. AlliedModders LLC defines further 
dvander@1231
    27
 * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1231
    28
 * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
dvander@592
    29
 *
dvander@592
    30
 * Version: $Id$
dvander@592
    31
 */
dvander@592
    32
dvander@592
    33
#include <time.h>
dvander@592
    34
#include "sourcemod.h"
dvander@592
    35
#include "sourcemm_api.h"
dvander@663
    36
#include "sm_stringutil.h"
dvander@592
    37
#include "Logger.h"
dvander@592
    38
#include "systems/LibrarySys.h"
dvander@592
    39
#include "sm_version.h"
dvander@592
    40
dvander@616
    41
Logger g_Logger;
dvander@592
    42
dvander@592
    43
/**
dvander@592
    44
 * :TODO: This should be creating the log folder if it doesn't exist
dvander@592
    45
 */
dvander@592
    46
dvander@663
    47
ConfigResult Logger::OnSourceModConfigChanged(const char *key, 
dvander@663
    48
									  const char *value, 
dvander@663
    49
									  ConfigSource source,
dvander@663
    50
									  char *error, 
dvander@663
    51
									  size_t maxlength)
ds@661
    52
{
dvander@663
    53
	if (strcasecmp(key, "Logging") == 0)
ds@661
    54
	{
ds@669
    55
		bool state;
ds@661
    56
ds@661
    57
		if (strcasecmp(value, "on") == 0)
ds@661
    58
		{
ds@669
    59
			state = true;
ds@661
    60
		} else if (strcasecmp(value, "off") == 0) {
ds@661
    61
			state = false;
ds@661
    62
		} else {
dvander@663
    63
			UTIL_Format(error, maxlength, "Invalid value: must be \"on\" or \"off\"");
dvander@663
    64
			return ConfigResult_Reject;
ds@661
    65
		}
ds@661
    66
dvander@663
    67
		if (source == ConfigSource_Console)
ds@661
    68
		{
ds@669
    69
			state ? EnableLogging() : DisableLogging();
dvander@663
    70
		} else {
ds@661
    71
			m_InitialState = state;
ds@661
    72
		}
ds@661
    73
dvander@663
    74
		return ConfigResult_Accept;
dvander@663
    75
	} else if (strcasecmp(key, "LogMode") == 0) {
ds@661
    76
		if (strcasecmp(value, "daily") == 0) 
ds@661
    77
		{
ds@661
    78
			m_Mode = LoggingMode_Daily;
ds@661
    79
		} else if (strcasecmp(value, "map") == 0) {
ds@661
    80
			m_Mode = LoggingMode_PerMap;
ds@661
    81
		} else if (strcasecmp(value, "game") == 0) {
ds@661
    82
			m_Mode = LoggingMode_Game;
ds@661
    83
		} else {
dvander@663
    84
			UTIL_Format(error, maxlength, "Invalid value: must be [daily|map|game]");
dvander@663
    85
			return ConfigResult_Reject;
ds@661
    86
		}
ds@661
    87
dvander@663
    88
		return ConfigResult_Accept;
ds@661
    89
	}
ds@661
    90
dvander@663
    91
	return ConfigResult_Ignore;
ds@661
    92
}
ds@661
    93
dvander@616
    94
void Logger::OnSourceModStartup(bool late)
dvander@592
    95
{
dvander@663
    96
	InitLogger(m_Mode);
dvander@592
    97
}
dvander@592
    98
dvander@616
    99
void Logger::OnSourceModAllShutdown()
dvander@592
   100
{
dvander@592
   101
	CloseLogger();
dvander@592
   102
}
dvander@592
   103
dvander@673
   104
void Logger::OnSourceModLevelChange(const char *mapName)
dvander@673
   105
{
dvander@673
   106
	MapChange(mapName);
dvander@673
   107
}
dvander@673
   108
dvander@616
   109
void Logger::_NewMapFile()
dvander@592
   110
{
dvander@592
   111
	if (!m_Active)
dvander@592
   112
	{
dvander@592
   113
		return;
dvander@592
   114
	}
ds@661
   115
ds@661
   116
	/* Append "Log file closed" to previous log file */
ds@661
   117
	_CloseFile();
dvander@592
   118
	
dvander@592
   119
	char _filename[256];
dvander@592
   120
	int i = 0;
dvander@592
   121
dvander@592
   122
	time_t t;
dvander@592
   123
	time(&t);
dvander@592
   124
	tm *curtime = localtime(&t);
dvander@592
   125
dvander@592
   126
	while (true)
dvander@592
   127
	{
ds@738
   128
		g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/L%02d%02d%03d.log", curtime->tm_mon + 1, curtime->tm_mday, i);
dvander@592
   129
		FILE *fp = fopen(_filename, "r");
dvander@592
   130
		if (!fp)
dvander@592
   131
		{
dvander@592
   132
			break;
dvander@592
   133
		}
dvander@592
   134
		fclose(fp);
dvander@592
   135
		i++;
dvander@592
   136
	}
dvander@592
   137
	m_NrmFileName.assign(_filename);
dvander@592
   138
dvander@592
   139
	FILE *fp = fopen(m_NrmFileName.c_str(), "w");
dvander@592
   140
	if (!fp)
dvander@592
   141
	{
dvander@592
   142
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   143
		m_Active = false;
dvander@592
   144
		return;
dvander@592
   145
	} else {
dvander@592
   146
		char date[32];
dvander@592
   147
		strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
ds@738
   148
		fprintf(fp, "L %s: SourceMod log file started (file \"L%02d%02d%03d.log\") (Version \"%s\")\n", date, curtime->tm_mon + 1, curtime->tm_mday, i, SVN_FULL_VERSION);
dvander@592
   149
		fclose(fp);
dvander@592
   150
	}
dvander@592
   151
}
dvander@592
   152
dvander@616
   153
void Logger::_CloseFile()
dvander@592
   154
{
dvander@592
   155
	if (!m_Active)
dvander@592
   156
	{
dvander@592
   157
		return;
dvander@592
   158
	}
dvander@592
   159
dvander@592
   160
	FILE *fp = NULL;
dvander@592
   161
	if (!m_NrmFileName.empty())
dvander@592
   162
	{
dvander@592
   163
		fp = fopen(m_NrmFileName.c_str(), "r+");
dvander@592
   164
		if (fp)
dvander@592
   165
		{
dvander@592
   166
			fseek(fp, 0, SEEK_END);
dvander@592
   167
			LogMessage("Log file closed.");
dvander@592
   168
			fclose(fp);
dvander@592
   169
		}
dvander@592
   170
		m_NrmFileName.clear();
dvander@592
   171
	}
dvander@592
   172
dvander@592
   173
	if (!m_ErrMapStart)
dvander@592
   174
	{
dvander@592
   175
		return;
dvander@592
   176
	}
dvander@592
   177
	fp = fopen(m_ErrFileName.c_str(), "r+");
dvander@592
   178
	if (fp)
dvander@592
   179
	{
dvander@592
   180
		fseek(fp, 0, SEEK_END);
dvander@592
   181
		LogError("Error log file session closed.");
dvander@592
   182
		fclose(fp);
dvander@592
   183
	}
dvander@592
   184
	m_ErrFileName.clear();
dvander@592
   185
}
dvander@592
   186
dvander@663
   187
void Logger::InitLogger(LoggingMode mode)
dvander@592
   188
{
ds@661
   189
	m_Mode = mode;
dvander@663
   190
	m_Active = m_InitialState;
dvander@592
   191
dvander@592
   192
	time_t t;
dvander@592
   193
	time(&t);
dvander@592
   194
	tm *curtime = localtime(&t);
dvander@592
   195
	m_CurDay = curtime->tm_mday;
dvander@592
   196
dvander@592
   197
	char _filename[256];
ds@738
   198
	g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/errors_%04d%02d%02d.log", curtime->tm_year + 1900, curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   199
	m_ErrFileName.assign(_filename);
dvander@592
   200
ds@661
   201
	switch (m_Mode)
dvander@592
   202
	{
dvander@592
   203
	case LoggingMode_PerMap:
dvander@592
   204
		{
dvander@663
   205
			if (!m_Active)
dvander@592
   206
			{
dvander@592
   207
				m_DelayedStart = true;
dvander@592
   208
			}
dvander@592
   209
			break;
dvander@592
   210
		}
dvander@592
   211
	case LoggingMode_Daily:
dvander@592
   212
		{
ds@738
   213
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/L%04d%02d%02d.log", curtime->tm_year + 1900, curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   214
			m_NrmFileName.assign(_filename);
dvander@592
   215
			m_DailyPrintHdr = true;
dvander@592
   216
			break;
dvander@592
   217
		}
dvander@592
   218
	default:
dvander@592
   219
		{
dvander@592
   220
			/* do nothing... */
dvander@592
   221
			break;
dvander@592
   222
		}
dvander@592
   223
	}
dvander@592
   224
}
dvander@592
   225
dvander@616
   226
void Logger::CloseLogger()
dvander@592
   227
{
dvander@592
   228
	_CloseFile();
dvander@592
   229
}
dvander@592
   230
dvander@616
   231
void Logger::LogMessage(const char *vafmt, ...)
dvander@592
   232
{
dvander@592
   233
	if (!m_Active)
dvander@592
   234
	{
dvander@592
   235
		return;
dvander@592
   236
	}
dvander@592
   237
ds@661
   238
	if (m_Mode == LoggingMode_Game)
dvander@592
   239
	{
dvander@592
   240
		va_list ap;
dvander@592
   241
		va_start(ap, vafmt);
ds@661
   242
		_PrintToGameLog(vafmt, ap);
dvander@592
   243
		va_end(ap);
dvander@592
   244
		return;
dvander@592
   245
	}
dvander@592
   246
dvander@592
   247
	if (m_DelayedStart)
dvander@592
   248
	{
dvander@592
   249
		m_DelayedStart = false;
dvander@592
   250
		_NewMapFile();
dvander@592
   251
	}
dvander@592
   252
dvander@592
   253
	char msg[3072];
dvander@592
   254
	va_list ap;
dvander@592
   255
	va_start(ap, vafmt);
dvander@592
   256
	vsnprintf(msg, sizeof(msg), vafmt, ap);
dvander@592
   257
	va_end(ap);
dvander@592
   258
dvander@592
   259
	char date[32];
dvander@592
   260
	time_t t;
dvander@592
   261
	time(&t);
dvander@592
   262
	tm *curtime = localtime(&t);
dvander@592
   263
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   264
dvander@592
   265
	FILE *fp = NULL;
ds@661
   266
	if (m_Mode == LoggingMode_PerMap)
dvander@592
   267
	{
dvander@592
   268
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   269
		if (!fp)
dvander@592
   270
		{
dvander@592
   271
			_NewMapFile();
dvander@592
   272
			fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   273
			if (!fp)
dvander@592
   274
			{
dvander@592
   275
				goto print_error;
dvander@592
   276
			}
dvander@592
   277
		}
dvander@592
   278
	} else {
dvander@592
   279
		if (m_CurDay != curtime->tm_mday)
dvander@592
   280
		{
dvander@592
   281
			char _filename[256];
ds@738
   282
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/L%04d%02d%02d.log", curtime->tm_year + 1900, curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   283
			m_NrmFileName.assign(_filename);
dvander@592
   284
			m_CurDay = curtime->tm_mday;
dvander@592
   285
			m_DailyPrintHdr = true;
dvander@592
   286
		}
dvander@592
   287
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   288
	}
dvander@592
   289
dvander@592
   290
	if (fp)
dvander@592
   291
	{
dvander@592
   292
		if (m_DailyPrintHdr)
dvander@592
   293
		{
dvander@592
   294
			m_DailyPrintHdr = false;
ds@738
   295
			fprintf(fp, "L %s: SourceMod log file session started (file \"L%04d%02d%02d.log\") (Version \"%s\")\n", date, curtime->tm_year + 1900, curtime->tm_mon + 1, curtime->tm_mday, SVN_FULL_VERSION);
dvander@592
   296
	 	}
dvander@592
   297
		fprintf(fp, "L %s: %s\n", date, msg);
dvander@592
   298
		fclose(fp);
dvander@592
   299
	} else {
dvander@592
   300
		goto print_error;
dvander@592
   301
	}
dvander@592
   302
dvander@592
   303
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
dvander@592
   304
	return;
dvander@592
   305
print_error:
dvander@592
   306
	g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   307
	m_Active = false;
dvander@592
   308
}
dvander@592
   309
dvander@616
   310
void Logger::LogError(const char *vafmt, ...)
dvander@592
   311
{
dvander@592
   312
	if (!m_Active)
dvander@592
   313
	{
dvander@592
   314
		return;
dvander@592
   315
	}
dvander@592
   316
dvander@592
   317
	time_t t;
dvander@592
   318
	time(&t);
dvander@592
   319
	tm *curtime = localtime(&t);
dvander@592
   320
dvander@592
   321
	char date[32];
dvander@592
   322
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   323
dvander@592
   324
	if (curtime->tm_mday != m_CurDay)
dvander@592
   325
	{
dvander@592
   326
		char _filename[256];
ds@738
   327
		g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/errors_%04d%02d%02d.log", curtime->tm_year + 1900, curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   328
		m_ErrFileName.assign(_filename);
dvander@592
   329
		m_CurDay = curtime->tm_mday;
dvander@592
   330
		m_ErrMapStart = false;
dvander@592
   331
	}
dvander@592
   332
dvander@592
   333
	char msg[3072];
dvander@592
   334
	va_list ap;
dvander@592
   335
	va_start(ap, vafmt);
dvander@592
   336
	vsnprintf(msg, sizeof(msg), vafmt, ap);
dvander@592
   337
	va_end(ap);
dvander@592
   338
dvander@592
   339
	FILE *fp = fopen(m_ErrFileName.c_str(), "a+");
dvander@592
   340
	if (fp)
dvander@592
   341
	{
dvander@592
   342
		if (!m_ErrMapStart)
dvander@592
   343
		{
dvander@592
   344
			fprintf(fp, "L %s: SourceMod error session started\n", date);
ds@738
   345
			fprintf(fp, "L %s: Info (map \"%s\") (file \"errors_%04d%02d%02d.log\")\n", date, m_CurMapName.c_str(), curtime->tm_year + 1900, curtime->tm_mon + 1, curtime->tm_mday);
dvander@592
   346
			m_ErrMapStart = true;
dvander@592
   347
		}
dvander@592
   348
		fprintf(fp, "L %s: %s\n", date, msg);
dvander@592
   349
		fclose(fp);
dvander@592
   350
	} else {
dvander@592
   351
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   352
		m_Active = false;
dvander@592
   353
		return;
dvander@592
   354
	}
dvander@592
   355
dvander@592
   356
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
dvander@592
   357
}
dvander@592
   358
dvander@616
   359
void Logger::MapChange(const char *mapname)
dvander@592
   360
{
dvander@592
   361
	m_CurMapName.assign(mapname);
dvander@592
   362
ds@661
   363
	switch (m_Mode)
dvander@592
   364
	{
dvander@592
   365
	case LoggingMode_Daily:
dvander@592
   366
		{
dvander@592
   367
			LogMessage("-------- Mapchange to %s --------", mapname);
dvander@592
   368
			break;
dvander@592
   369
		}
dvander@592
   370
	case LoggingMode_PerMap:
dvander@592
   371
		{
dvander@592
   372
			_NewMapFile();
dvander@592
   373
			break;
dvander@592
   374
		}
dvander@592
   375
	default:
dvander@592
   376
		{
dvander@592
   377
			/* Do nothing... */
dvander@592
   378
			break;
dvander@592
   379
		}
dvander@592
   380
	}
dvander@592
   381
dvander@592
   382
	if (m_ErrMapStart)
dvander@592
   383
	{
dvander@592
   384
		LogError("Error log file session closed.");
dvander@592
   385
	}
dvander@592
   386
	m_ErrMapStart = false;
dvander@592
   387
}
dvander@592
   388
ds@661
   389
void Logger::_PrintToGameLog(const char *fmt, va_list ap)
dvander@592
   390
{
dvander@592
   391
	char msg[3072];
dvander@592
   392
	size_t len;
dvander@592
   393
dvander@592
   394
	len = vsnprintf(msg, sizeof(msg)-2, fmt, ap);
dvander@592
   395
	len = (len >= sizeof(msg)) ? (sizeof(msg) - 2) : len;
dvander@592
   396
dvander@592
   397
	msg[len++] = '\n';
dvander@592
   398
	msg[len] = '\0';
dvander@592
   399
dvander@592
   400
	engine->LogPrint(msg);
dvander@592
   401
}
dvander@592
   402
dvander@616
   403
const char *Logger::GetLogFileName(LogType type) const
dvander@592
   404
{
dvander@592
   405
	switch (type)
dvander@592
   406
	{
dvander@592
   407
	case LogType_Normal:
dvander@592
   408
		{
dvander@592
   409
			return m_NrmFileName.c_str();
dvander@592
   410
		}
dvander@592
   411
	case LogType_Error:
dvander@592
   412
		{
dvander@592
   413
			return m_ErrFileName.c_str();
dvander@592
   414
		}
dvander@592
   415
	default:
dvander@592
   416
		{
dvander@592
   417
			return "";
dvander@592
   418
		}
dvander@592
   419
	}
dvander@592
   420
}
dvander@592
   421
dvander@616
   422
LoggingMode Logger::GetLoggingMode() const
dvander@592
   423
{
ds@661
   424
	return m_Mode;
dvander@592
   425
}
dvander@592
   426
dvander@616
   427
void Logger::EnableLogging()
dvander@592
   428
{
dvander@592
   429
	if (m_Active)
dvander@592
   430
	{
dvander@592
   431
		return;
dvander@592
   432
	}
dvander@592
   433
	m_Active = true;
ds@669
   434
	LogMessage("[SM] Logging enabled manually by user.");
dvander@592
   435
}
dvander@592
   436
dvander@616
   437
void Logger::DisableLogging()
dvander@592
   438
{
dvander@592
   439
	if (!m_Active)
dvander@592
   440
	{
dvander@592
   441
		return;
dvander@592
   442
	}
ds@669
   443
	LogMessage("[SM] Logging disabled manually by user.");
dvander@592
   444
	m_Active = false;
dvander@592
   445
}
dvander@663
   446
dvander@663
   447
void Logger::LogFatal(const char *msg, ...)
dvander@663
   448
{
dvander@665
   449
	/* :TODO: make this print all pretty-like
dvander@665
   450
	 * In fact, the pretty log printing function should be abstracted. 
dvander@665
   451
	 * It's already implemented twice which is bad.
dvander@665
   452
	 */
dvander@665
   453
dvander@663
   454
	char path[PLATFORM_MAX_PATH];
dvander@663
   455
	g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "sourcemod_fatal.log");
dvander@663
   456
	FILE *fp = fopen(path, "at");
dvander@663
   457
	if (!fp)
dvander@663
   458
	{
dvander@663
   459
		/* We're just doomed, aren't we... */
dvander@663
   460
		return;
dvander@663
   461
	}
dvander@663
   462
dvander@663
   463
	va_list ap;
dvander@663
   464
	va_start(ap, msg);
dvander@663
   465
	vfprintf(fp, msg, ap);
dvander@663
   466
	va_end(ap);
dvander@663
   467
dvander@663
   468
	fputs("\n", fp);
dvander@663
   469
	
dvander@663
   470
	fclose(fp);
dvander@663
   471
}