core/Logger.cpp
author David Anderson <dvander@alliedmods.net>
Mon Aug 27 02:00:37 2007 +0000 (2007-08-27)
changeset 1378 115ba755bcdf
parent 1371 d207f0e17532
child 1444 be6848920a62
permissions -rw-r--r--
- implemented amb855 - LogAction()
- changed base plugins to use LogAction() where appropriate
dvander@592
     1
/**
ds@653
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@592
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@592
    28
 *
dvander@592
    29
 * Version: $Id$
dvander@592
    30
 */
dvander@592
    31
dvander@592
    32
#include <time.h>
dvander@592
    33
#include "sourcemod.h"
dvander@592
    34
#include "sourcemm_api.h"
dvander@663
    35
#include "sm_stringutil.h"
dvander@592
    36
#include "Logger.h"
dvander@592
    37
#include "systems/LibrarySys.h"
dvander@1371
    38
#include "TimerSys.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@1371
   123
	GetAdjustedTime(&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@1371
   193
	GetAdjustedTime(&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@1378
   231
void Logger::LogToOpenFile(FILE *fp, const char *msg, ...)
dvander@1378
   232
{
dvander@1378
   233
	if (!m_Active)
dvander@1378
   234
	{
dvander@1378
   235
		return;
dvander@1378
   236
	}
dvander@1378
   237
dvander@1378
   238
	va_list ap;
dvander@1378
   239
	va_start(ap, msg);
dvander@1378
   240
	LogToOpenFileEx(fp, msg, ap);
dvander@1378
   241
	va_end(ap);
dvander@1378
   242
}
dvander@1378
   243
dvander@1378
   244
void Logger::LogToOpenFileEx(FILE *fp, const char *msg, va_list ap)
dvander@1378
   245
{
dvander@1378
   246
	if (!m_Active)
dvander@1378
   247
	{
dvander@1378
   248
		return;
dvander@1378
   249
	}
dvander@1378
   250
dvander@1378
   251
	char buffer[3072];
dvander@1378
   252
	UTIL_FormatArgs(buffer, sizeof(buffer), msg, ap);
dvander@1378
   253
dvander@1378
   254
	char date[32];
dvander@1378
   255
	time_t t;
dvander@1378
   256
	GetAdjustedTime(&t);
dvander@1378
   257
	tm *curtime = localtime(&t);
dvander@1378
   258
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@1378
   259
dvander@1378
   260
	fprintf(fp, "L %s: %s\n", date, buffer);
dvander@1378
   261
	g_SMAPI->ConPrintf("L %s: %s\n", date, buffer);
dvander@1378
   262
}
dvander@1378
   263
dvander@616
   264
void Logger::LogMessage(const char *vafmt, ...)
dvander@592
   265
{
dvander@592
   266
	if (!m_Active)
dvander@592
   267
	{
dvander@592
   268
		return;
dvander@592
   269
	}
dvander@592
   270
ds@661
   271
	if (m_Mode == LoggingMode_Game)
dvander@592
   272
	{
dvander@592
   273
		va_list ap;
dvander@592
   274
		va_start(ap, vafmt);
ds@661
   275
		_PrintToGameLog(vafmt, ap);
dvander@592
   276
		va_end(ap);
dvander@592
   277
		return;
dvander@592
   278
	}
dvander@592
   279
dvander@592
   280
	if (m_DelayedStart)
dvander@592
   281
	{
dvander@592
   282
		m_DelayedStart = false;
dvander@592
   283
		_NewMapFile();
dvander@592
   284
	}
dvander@592
   285
dvander@592
   286
	time_t t;
dvander@1371
   287
	GetAdjustedTime(&t);
dvander@592
   288
	tm *curtime = localtime(&t);
dvander@592
   289
dvander@592
   290
	FILE *fp = NULL;
ds@661
   291
	if (m_Mode == LoggingMode_PerMap)
dvander@592
   292
	{
dvander@592
   293
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   294
		if (!fp)
dvander@592
   295
		{
dvander@592
   296
			_NewMapFile();
dvander@592
   297
			fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   298
			if (!fp)
dvander@592
   299
			{
dvander@592
   300
				goto print_error;
dvander@592
   301
			}
dvander@592
   302
		}
dvander@592
   303
	} else {
dvander@592
   304
		if (m_CurDay != curtime->tm_mday)
dvander@592
   305
		{
dvander@592
   306
			char _filename[256];
ds@738
   307
			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
   308
			m_NrmFileName.assign(_filename);
dvander@592
   309
			m_CurDay = curtime->tm_mday;
dvander@592
   310
			m_DailyPrintHdr = true;
dvander@592
   311
		}
dvander@592
   312
		fp = fopen(m_NrmFileName.c_str(), "a+");
dvander@592
   313
	}
dvander@592
   314
dvander@592
   315
	if (fp)
dvander@592
   316
	{
dvander@592
   317
		if (m_DailyPrintHdr)
dvander@592
   318
		{
dvander@1378
   319
			char date[32];
dvander@592
   320
			m_DailyPrintHdr = false;
dvander@1378
   321
			strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
ds@738
   322
			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
   323
	 	}
dvander@1378
   324
		va_list ap;
dvander@1378
   325
		va_start(ap, vafmt);
dvander@1378
   326
		LogToOpenFileEx(fp, vafmt, ap);
dvander@1378
   327
		va_end(ap);
dvander@592
   328
		fclose(fp);
dvander@592
   329
	} else {
dvander@592
   330
		goto print_error;
dvander@592
   331
	}
dvander@592
   332
dvander@592
   333
	return;
dvander@592
   334
print_error:
dvander@592
   335
	g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   336
	m_Active = false;
dvander@592
   337
}
dvander@592
   338
dvander@616
   339
void Logger::LogError(const char *vafmt, ...)
dvander@592
   340
{
dvander@592
   341
	if (!m_Active)
dvander@592
   342
	{
dvander@592
   343
		return;
dvander@592
   344
	}
dvander@592
   345
dvander@592
   346
	time_t t;
dvander@1371
   347
	GetAdjustedTime(&t);
dvander@592
   348
	tm *curtime = localtime(&t);
dvander@592
   349
dvander@592
   350
	if (curtime->tm_mday != m_CurDay)
dvander@592
   351
	{
dvander@592
   352
		char _filename[256];
ds@738
   353
		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
   354
		m_ErrFileName.assign(_filename);
dvander@592
   355
		m_CurDay = curtime->tm_mday;
dvander@592
   356
		m_ErrMapStart = false;
dvander@592
   357
	}
dvander@592
   358
dvander@592
   359
	FILE *fp = fopen(m_ErrFileName.c_str(), "a+");
dvander@592
   360
	if (fp)
dvander@592
   361
	{
dvander@592
   362
		if (!m_ErrMapStart)
dvander@592
   363
		{
dvander@1378
   364
			char date[32];
dvander@1378
   365
			strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@592
   366
			fprintf(fp, "L %s: SourceMod error session started\n", date);
ds@738
   367
			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
   368
			m_ErrMapStart = true;
dvander@592
   369
		}
dvander@1378
   370
		va_list ap;
dvander@1378
   371
		va_start(ap, vafmt);
dvander@1378
   372
		LogToOpenFileEx(fp, vafmt, ap);
dvander@1378
   373
		va_end(ap);
dvander@592
   374
		fclose(fp);
dvander@592
   375
	} else {
dvander@592
   376
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
dvander@592
   377
		m_Active = false;
dvander@592
   378
		return;
dvander@592
   379
	}
dvander@592
   380
}
dvander@592
   381
dvander@616
   382
void Logger::MapChange(const char *mapname)
dvander@592
   383
{
dvander@592
   384
	m_CurMapName.assign(mapname);
dvander@592
   385
ds@661
   386
	switch (m_Mode)
dvander@592
   387
	{
dvander@592
   388
	case LoggingMode_Daily:
dvander@592
   389
		{
dvander@592
   390
			LogMessage("-------- Mapchange to %s --------", mapname);
dvander@592
   391
			break;
dvander@592
   392
		}
dvander@592
   393
	case LoggingMode_PerMap:
dvander@592
   394
		{
dvander@592
   395
			_NewMapFile();
dvander@592
   396
			break;
dvander@592
   397
		}
dvander@592
   398
	default:
dvander@592
   399
		{
dvander@592
   400
			/* Do nothing... */
dvander@592
   401
			break;
dvander@592
   402
		}
dvander@592
   403
	}
dvander@592
   404
dvander@592
   405
	if (m_ErrMapStart)
dvander@592
   406
	{
dvander@592
   407
		LogError("Error log file session closed.");
dvander@592
   408
	}
dvander@592
   409
	m_ErrMapStart = false;
dvander@592
   410
}
dvander@592
   411
ds@661
   412
void Logger::_PrintToGameLog(const char *fmt, va_list ap)
dvander@592
   413
{
dvander@592
   414
	char msg[3072];
dvander@592
   415
	size_t len;
dvander@592
   416
dvander@592
   417
	len = vsnprintf(msg, sizeof(msg)-2, fmt, ap);
dvander@592
   418
	len = (len >= sizeof(msg)) ? (sizeof(msg) - 2) : len;
dvander@592
   419
dvander@592
   420
	msg[len++] = '\n';
dvander@592
   421
	msg[len] = '\0';
dvander@592
   422
dvander@592
   423
	engine->LogPrint(msg);
dvander@592
   424
}
dvander@592
   425
dvander@616
   426
const char *Logger::GetLogFileName(LogType type) const
dvander@592
   427
{
dvander@592
   428
	switch (type)
dvander@592
   429
	{
dvander@592
   430
	case LogType_Normal:
dvander@592
   431
		{
dvander@592
   432
			return m_NrmFileName.c_str();
dvander@592
   433
		}
dvander@592
   434
	case LogType_Error:
dvander@592
   435
		{
dvander@592
   436
			return m_ErrFileName.c_str();
dvander@592
   437
		}
dvander@592
   438
	default:
dvander@592
   439
		{
dvander@592
   440
			return "";
dvander@592
   441
		}
dvander@592
   442
	}
dvander@592
   443
}
dvander@592
   444
dvander@616
   445
LoggingMode Logger::GetLoggingMode() const
dvander@592
   446
{
ds@661
   447
	return m_Mode;
dvander@592
   448
}
dvander@592
   449
dvander@616
   450
void Logger::EnableLogging()
dvander@592
   451
{
dvander@592
   452
	if (m_Active)
dvander@592
   453
	{
dvander@592
   454
		return;
dvander@592
   455
	}
dvander@592
   456
	m_Active = true;
ds@669
   457
	LogMessage("[SM] Logging enabled manually by user.");
dvander@592
   458
}
dvander@592
   459
dvander@616
   460
void Logger::DisableLogging()
dvander@592
   461
{
dvander@592
   462
	if (!m_Active)
dvander@592
   463
	{
dvander@592
   464
		return;
dvander@592
   465
	}
ds@669
   466
	LogMessage("[SM] Logging disabled manually by user.");
dvander@592
   467
	m_Active = false;
dvander@592
   468
}
dvander@663
   469
dvander@663
   470
void Logger::LogFatal(const char *msg, ...)
dvander@663
   471
{
dvander@665
   472
	/* :TODO: make this print all pretty-like
dvander@665
   473
	 * In fact, the pretty log printing function should be abstracted. 
dvander@665
   474
	 * It's already implemented twice which is bad.
dvander@665
   475
	 */
dvander@665
   476
dvander@663
   477
	char path[PLATFORM_MAX_PATH];
dvander@663
   478
	g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "sourcemod_fatal.log");
dvander@663
   479
	FILE *fp = fopen(path, "at");
dvander@663
   480
	if (!fp)
dvander@663
   481
	{
dvander@663
   482
		/* We're just doomed, aren't we... */
dvander@663
   483
		return;
dvander@663
   484
	}
dvander@663
   485
dvander@663
   486
	va_list ap;
dvander@663
   487
	va_start(ap, msg);
dvander@663
   488
	vfprintf(fp, msg, ap);
dvander@663
   489
	va_end(ap);
dvander@663
   490
dvander@663
   491
	fputs("\n", fp);
dvander@663
   492
	
dvander@663
   493
	fclose(fp);
dvander@663
   494
}