core/CLogger.cpp
author David Anderson <dvander@alliedmods.net>
Sat Feb 17 19:03:18 2007 +0000 (2007-02-17)
changeset 520 7676d61cde2d
parent 370 d3a484f98f6d
child 566 7640076104f5
permissions -rw-r--r--
added helper a core translation helper to the translator
regadmincmd is now officially done and tested, as are overrides
printtoplayers now prints to the server on id==0 as a convenience
fixed a crash bug in the admin system
fixed up console.inc a bit
dvander@370
     1
/**
dvander@370
     2
 * ===============================================================
dvander@370
     3
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370
     4
 * ===============================================================
dvander@370
     5
 *
dvander@370
     6
 * This file is not open source and may not be copied without explicit
dvander@370
     7
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370
     8
 * in whole or significant part.
dvander@370
     9
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370
    10
 *
dvander@370
    11
 * Version: $Id$
dvander@370
    12
 */
dvander@370
    13
dvander@300
    14
#include <time.h>
dvander@300
    15
#include "sourcemod.h"
dvander@300
    16
#include "sourcemm_api.h"
faluco@266
    17
#include "CLogger.h"
dvander@351
    18
#include "systems/LibrarySys.h"
dvander@300
    19
#include "sm_version.h"
faluco@266
    20
faluco@266
    21
CLogger g_Logger;
faluco@266
    22
dvander@347
    23
/**
dvander@347
    24
 * :TODO: This should be creating the log folder if it doesn't exist
dvander@347
    25
 */
dvander@347
    26
faluco@281
    27
void CLogger::OnSourceModStartup(bool late)
faluco@281
    28
{
faluco@281
    29
	//:TODO: read these options from a file, dont hardcode them
dvander@292
    30
	InitLogger(LoggingMode_Daily, true);
faluco@281
    31
}
faluco@281
    32
faluco@281
    33
void CLogger::OnSourceModAllShutdown()
faluco@281
    34
{
faluco@281
    35
	CloseLogger();
faluco@281
    36
}
faluco@281
    37
faluco@266
    38
void CLogger::_NewMapFile()
faluco@266
    39
{
faluco@266
    40
	if (!m_Active)
faluco@266
    41
	{
faluco@266
    42
		return;
faluco@266
    43
	}
faluco@266
    44
	
faluco@266
    45
	char _filename[256];
faluco@266
    46
	int i = 0;
faluco@266
    47
faluco@266
    48
	time_t t;
faluco@266
    49
	time(&t);
faluco@266
    50
	tm *curtime = localtime(&t);
faluco@266
    51
faluco@266
    52
	while (true)
faluco@266
    53
	{
dvander@347
    54
		g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d%03d.log", curtime->tm_mon + 1, curtime->tm_mday, i);
faluco@266
    55
		FILE *fp = fopen(_filename, "r");
faluco@266
    56
		if (!fp)
faluco@266
    57
		{
faluco@266
    58
			break;
faluco@266
    59
		}
faluco@266
    60
		fclose(fp);
faluco@266
    61
		i++;
faluco@266
    62
	}
faluco@266
    63
	m_NrmFileName.assign(_filename);
faluco@266
    64
faluco@266
    65
	FILE *fp = fopen(m_NrmFileName.c_str(), "w");
faluco@266
    66
	if (!fp)
faluco@266
    67
	{
dvander@307
    68
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
faluco@266
    69
		m_Active = false;
faluco@274
    70
		return;
faluco@266
    71
	} else {
faluco@266
    72
		char date[32];
faluco@266
    73
		strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
dvander@347
    74
		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, SOURCEMOD_VERSION);
faluco@266
    75
		fclose(fp);
faluco@266
    76
	}
faluco@266
    77
}
faluco@266
    78
faluco@266
    79
void CLogger::_CloseFile()
faluco@266
    80
{
faluco@266
    81
	if (!m_Active)
faluco@266
    82
	{
faluco@266
    83
		return;
faluco@266
    84
	}
faluco@266
    85
faluco@266
    86
	FILE *fp = NULL;
faluco@266
    87
	if (!m_NrmFileName.empty())
faluco@266
    88
	{
faluco@266
    89
		fp = fopen(m_NrmFileName.c_str(), "r+");
faluco@266
    90
		if (fp)
faluco@266
    91
		{
faluco@266
    92
			fseek(fp, 0, SEEK_END);
faluco@266
    93
			LogMessage("Log file closed.");
faluco@266
    94
			fclose(fp);
faluco@266
    95
		}
faluco@266
    96
		m_NrmFileName.clear();
faluco@266
    97
	}
faluco@266
    98
faluco@266
    99
	if (!m_ErrMapStart)
faluco@266
   100
	{
faluco@266
   101
		return;
faluco@266
   102
	}
faluco@266
   103
	fp = fopen(m_ErrFileName.c_str(), "r+");
faluco@266
   104
	if (fp)
faluco@266
   105
	{
faluco@266
   106
		fseek(fp, 0, SEEK_END);
dvander@271
   107
		LogError("Error log file session closed.");
faluco@266
   108
		fclose(fp);
faluco@266
   109
	}
faluco@266
   110
	m_ErrFileName.clear();
faluco@266
   111
}
faluco@266
   112
faluco@266
   113
void CLogger::InitLogger(LoggingMode mode, bool startlogging)
faluco@266
   114
{
faluco@266
   115
	m_mode = mode;
faluco@266
   116
	m_Active = startlogging;
faluco@266
   117
faluco@266
   118
	time_t t;
faluco@266
   119
	time(&t);
faluco@266
   120
	tm *curtime = localtime(&t);
faluco@266
   121
	m_CurDay = curtime->tm_mday;
faluco@266
   122
faluco@266
   123
	char _filename[256];
dvander@317
   124
	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);
faluco@266
   125
	m_ErrFileName.assign(_filename);
faluco@266
   126
faluco@266
   127
	switch (m_mode)
faluco@266
   128
	{
faluco@266
   129
	case LoggingMode_PerMap:
faluco@266
   130
		{
faluco@266
   131
			if (!startlogging)
faluco@266
   132
			{
faluco@266
   133
				m_DelayedStart = true;
faluco@266
   134
			}
faluco@266
   135
			break;
faluco@266
   136
		}
faluco@266
   137
	case LoggingMode_Daily:
faluco@266
   138
		{
dvander@347
   139
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday);
faluco@266
   140
			m_NrmFileName.assign(_filename);
faluco@266
   141
			m_DailyPrintHdr = true;
faluco@266
   142
			break;
faluco@266
   143
		}
dvander@351
   144
	default:
dvander@351
   145
		{
dvander@351
   146
			/* do nothing... */
dvander@351
   147
			break;
dvander@351
   148
		}
faluco@266
   149
	}
faluco@266
   150
}
faluco@266
   151
faluco@266
   152
void CLogger::CloseLogger()
faluco@266
   153
{
faluco@266
   154
	_CloseFile();
faluco@266
   155
}
faluco@266
   156
faluco@266
   157
void CLogger::LogMessage(const char *vafmt, ...)
faluco@266
   158
{
faluco@266
   159
	if (!m_Active)
faluco@266
   160
	{
faluco@266
   161
		return;
faluco@266
   162
	}
faluco@266
   163
faluco@266
   164
	if (m_mode == LoggingMode_HL2)
faluco@266
   165
	{
faluco@274
   166
		va_list ap;
faluco@274
   167
		va_start(ap, vafmt);
faluco@274
   168
		_PrintToHL2Log(vafmt, ap);
faluco@274
   169
		va_end(ap);
faluco@266
   170
		return;
faluco@266
   171
	}
faluco@266
   172
faluco@266
   173
	if (m_DelayedStart)
faluco@266
   174
	{
faluco@266
   175
		m_DelayedStart = false;
faluco@266
   176
		_NewMapFile();
faluco@266
   177
	}
faluco@266
   178
faluco@274
   179
	char msg[3072];
faluco@266
   180
	va_list ap;
faluco@266
   181
	va_start(ap, vafmt);
faluco@266
   182
	vsnprintf(msg, sizeof(msg), vafmt, ap);
faluco@266
   183
	va_end(ap);
faluco@266
   184
faluco@266
   185
	char date[32];
faluco@266
   186
	time_t t;
faluco@266
   187
	time(&t);
faluco@266
   188
	tm *curtime = localtime(&t);
faluco@266
   189
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
faluco@266
   190
faluco@266
   191
	FILE *fp = NULL;
faluco@266
   192
	if (m_mode == LoggingMode_PerMap)
faluco@266
   193
	{
faluco@266
   194
		fp = fopen(m_NrmFileName.c_str(), "a+");
faluco@266
   195
		if (!fp)
faluco@266
   196
		{
faluco@266
   197
			_NewMapFile();
faluco@266
   198
			fp = fopen(m_NrmFileName.c_str(), "a+");
faluco@266
   199
			if (!fp)
faluco@266
   200
			{
faluco@266
   201
				goto print_error;
faluco@266
   202
			}
faluco@266
   203
		}
faluco@266
   204
	} else {
faluco@266
   205
		if (m_CurDay != curtime->tm_mday)
faluco@266
   206
		{
faluco@266
   207
			char _filename[256];
dvander@347
   208
			g_SourceMod.BuildPath(Path_SM, _filename, sizeof(_filename), "logs/logs_%02d%02d.log", curtime->tm_mon + 1, curtime->tm_mday);
faluco@266
   209
			m_NrmFileName.assign(_filename);
faluco@266
   210
			m_CurDay = curtime->tm_mday;
faluco@266
   211
			m_DailyPrintHdr = true;
faluco@266
   212
		}
faluco@266
   213
		fp = fopen(m_NrmFileName.c_str(), "a+");
faluco@266
   214
	}
faluco@266
   215
faluco@266
   216
	if (fp)
faluco@266
   217
	{
faluco@266
   218
		if (m_DailyPrintHdr)
faluco@266
   219
		{
faluco@266
   220
			m_DailyPrintHdr = false;
dvander@347
   221
			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, SOURCEMOD_VERSION);
faluco@266
   222
		}
faluco@266
   223
		fprintf(fp, "L %s: %s\n", date, msg);
faluco@266
   224
		fclose(fp);
faluco@266
   225
	} else {
faluco@266
   226
		goto print_error;
faluco@266
   227
	}
faluco@266
   228
faluco@266
   229
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
faluco@270
   230
	return;
faluco@266
   231
print_error:
dvander@307
   232
	g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
faluco@266
   233
	m_Active = false;
faluco@266
   234
}
faluco@266
   235
dvander@271
   236
void CLogger::LogError(const char *vafmt, ...)
faluco@266
   237
{
faluco@266
   238
	if (!m_Active)
faluco@266
   239
	{
faluco@266
   240
		return;
faluco@266
   241
	}
faluco@266
   242
faluco@266
   243
	time_t t;
faluco@266
   244
	time(&t);
faluco@266
   245
	tm *curtime = localtime(&t);
faluco@266
   246
faluco@266
   247
	char date[32];
faluco@266
   248
	strftime(date, sizeof(date), "%m/%d/%Y - %H:%M:%S", curtime);
faluco@266
   249
faluco@266
   250
	if (curtime->tm_mday != m_CurDay)
faluco@266
   251
	{
faluco@266
   252
		char _filename[256];
dvander@317
   253
		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);
faluco@266
   254
		m_ErrFileName.assign(_filename);
faluco@266
   255
		m_CurDay = curtime->tm_mday;
faluco@266
   256
		m_ErrMapStart = false;
faluco@266
   257
	}
faluco@266
   258
faluco@274
   259
	char msg[3072];
faluco@266
   260
	va_list ap;
faluco@266
   261
	va_start(ap, vafmt);
faluco@266
   262
	vsnprintf(msg, sizeof(msg), vafmt, ap);
faluco@266
   263
	va_end(ap);
faluco@266
   264
faluco@266
   265
	FILE *fp = fopen(m_ErrFileName.c_str(), "a+");
faluco@266
   266
	if (fp)
faluco@266
   267
	{
faluco@266
   268
		if (!m_ErrMapStart)
faluco@266
   269
		{
faluco@266
   270
			fprintf(fp, "L %s: SourceMod error session started\n", date);
faluco@266
   271
			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);
faluco@266
   272
			m_ErrMapStart = true;
faluco@266
   273
		}
faluco@266
   274
		fprintf(fp, "L %s: %s\n", date, msg);
faluco@266
   275
		fclose(fp);
faluco@266
   276
	} else {
dvander@307
   277
		g_SMAPI->ConPrint("[SM] Unexpected fatal logging error. SourceMod logging disabled.\n");
faluco@266
   278
		m_Active = false;
faluco@274
   279
		return;
faluco@266
   280
	}
faluco@266
   281
faluco@266
   282
	g_SMAPI->ConPrintf("L %s: %s\n", date, msg);
faluco@266
   283
}
faluco@266
   284
faluco@266
   285
void CLogger::MapChange(const char *mapname)
faluco@266
   286
{
faluco@266
   287
	m_CurMapName.assign(mapname);
faluco@266
   288
faluco@266
   289
	switch (m_mode)
faluco@266
   290
	{
faluco@266
   291
	case LoggingMode_Daily:
faluco@266
   292
		{
faluco@266
   293
			LogMessage("-------- Mapchange to %s --------", mapname);
faluco@266
   294
			break;
faluco@266
   295
		}
faluco@266
   296
	case LoggingMode_PerMap:
faluco@266
   297
		{
faluco@266
   298
			_NewMapFile();
faluco@266
   299
			break;
faluco@266
   300
		}
dvander@351
   301
	default:
dvander@351
   302
		{
dvander@351
   303
			/* Do nothing... */
dvander@351
   304
			break;
dvander@351
   305
		}
faluco@266
   306
	}
faluco@266
   307
faluco@266
   308
	if (m_ErrMapStart)
faluco@266
   309
	{
dvander@271
   310
		LogError("Error log file session closed.");
faluco@266
   311
	}
faluco@266
   312
	m_ErrMapStart = false;
faluco@266
   313
}
faluco@266
   314
faluco@274
   315
void CLogger::_PrintToHL2Log(const char *fmt, va_list ap)
faluco@266
   316
{
faluco@274
   317
	char msg[3072];
faluco@266
   318
	size_t len;
faluco@266
   319
faluco@274
   320
	len = vsnprintf(msg, sizeof(msg)-2, fmt, ap);
faluco@274
   321
	len = (len >= sizeof(msg)) ? (sizeof(msg) - 2) : len;
faluco@274
   322
faluco@266
   323
	msg[len++] = '\n';
faluco@266
   324
	msg[len] = '\0';
faluco@266
   325
faluco@266
   326
	engine->LogPrint(msg);
dvander@300
   327
}
dvander@300
   328
dvander@300
   329
const char *CLogger::GetLogFileName(LogType type) const
dvander@300
   330
{
dvander@300
   331
	switch (type)
dvander@300
   332
	{
dvander@300
   333
	case LogType_Normal:
dvander@300
   334
		{
dvander@300
   335
			return m_NrmFileName.c_str();
dvander@300
   336
		}
dvander@300
   337
	case LogType_Error:
dvander@300
   338
		{
dvander@300
   339
			return m_ErrFileName.c_str();
dvander@300
   340
		}
dvander@300
   341
	default:
dvander@300
   342
		{
dvander@300
   343
			return "";
dvander@300
   344
		}
dvander@300
   345
	}
dvander@300
   346
}
dvander@300
   347
dvander@300
   348
LoggingMode CLogger::GetLoggingMode() const
dvander@300
   349
{
dvander@300
   350
	return m_mode;
dvander@300
   351
}
dvander@300
   352
dvander@300
   353
void CLogger::EnableLogging()
dvander@300
   354
{
dvander@300
   355
	if (m_Active)
dvander@300
   356
	{
dvander@300
   357
		return;
dvander@300
   358
	}
dvander@300
   359
	m_Active = true;
dvander@300
   360
	LogMessage("Logging enabled manually by user.");
dvander@300
   361
}
dvander@300
   362
dvander@300
   363
void CLogger::DisableLogging()
dvander@300
   364
{
dvander@300
   365
	if (!m_Active)
dvander@300
   366
	{
dvander@300
   367
		return;
dvander@300
   368
	}
dvander@300
   369
	LogMessage("Logging disabled manually by user.");
dvander@300
   370
	m_Active = false;
dvander@300
   371
}