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