core/Logger.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Mar 22 21:50:20 2007 +0000 (2007-03-22)
changeset 653 ef60870067ff
parent 616 d5b1dcf38c07
child 661 5c0988b9bf0c
permissions -rw-r--r--
More consistency of some sort...

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