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