core/sm_srvcmds.cpp
author Kyle Sanderson <kyle.leet@gmail.com>
Mon Aug 12 00:45:29 2013 +0100 (2013-08-12)
changeset 3996 4a0daf289347
parent 3872 4c93f74cae51
child 4074 84b49d686a77
permissions -rw-r--r--
Dump handle information when a plugin is forcefully unloaded. (bug 5666, r=asherkin)
dvander@370
     1
/**
dvander@2728
     2
 * vim: set ts=4 sw=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
dvander@2728
     5
 * Copyright (C) 2004-2009 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@370
     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@370
    28
 *
dvander@370
    29
 * Version: $Id$
dvander@370
    30
 */
dvander@370
    31
faluco@216
    32
#include "sm_srvcmds.h"
dvander@2784
    33
#include <sourcemod_version.h>
faluco@274
    34
#include "sm_stringutil.h"
dvander@978
    35
#include "CoreConfig.h"
dvander@1770
    36
#include "ConVarManager.h"
dvander@3872
    37
#include "logic_bridge.h"
faluco@216
    38
dvander@308
    39
RootConsoleMenu g_RootMenu;
faluco@216
    40
asherkin@3630
    41
ConVar sourcemod_version("sourcemod_version", SM_VERSION_STRING, FCVAR_SPONLY|FCVAR_REPLICATED|FCVAR_NOTIFY, "SourceMod Version");
dvander@524
    42
dvander@308
    43
RootConsoleMenu::RootConsoleMenu()
faluco@216
    44
{
dvander@308
    45
	m_pCommands = sm_trie_create();
dvander@978
    46
	m_CfgExecDone = false;
faluco@216
    47
}
faluco@216
    48
dvander@308
    49
RootConsoleMenu::~RootConsoleMenu()
dvander@308
    50
{
dvander@308
    51
	sm_trie_destroy(m_pCommands);
dvander@308
    52
dvander@308
    53
	List<ConsoleEntry *>::iterator iter;
dvander@308
    54
	for (iter=m_Menu.begin(); iter!=m_Menu.end(); iter++)
dvander@308
    55
	{
dvander@308
    56
		delete (*iter);
dvander@308
    57
	}
dvander@308
    58
	m_Menu.clear();
dvander@308
    59
}
dvander@308
    60
dvander@308
    61
void RootConsoleMenu::OnSourceModStartup(bool late)
dvander@308
    62
{
ds@2400
    63
#if SOURCE_ENGINE >= SE_ORANGEBOX
dvander@1542
    64
	g_pCVar = icvar;
faluco@1541
    65
#endif
faluco@1541
    66
	CONVAR_REGISTER(this);
dvander@308
    67
	AddRootConsoleCommand("version", "Display version information", this);
dvander@308
    68
	AddRootConsoleCommand("credits", "Display credits listing", this);
dvander@1770
    69
}
ds@627
    70
dvander@1770
    71
void RootConsoleMenu::OnSourceModAllInitialized()
dvander@1770
    72
{
dvander@3872
    73
	sharesys->AddInterface(NULL, this);
dvander@308
    74
}
dvander@308
    75
dvander@308
    76
void RootConsoleMenu::OnSourceModShutdown()
dvander@308
    77
{
dvander@308
    78
	RemoveRootConsoleCommand("credits", this);
dvander@308
    79
	RemoveRootConsoleCommand("version", this);
dvander@308
    80
}
dvander@308
    81
dvander@308
    82
bool RootConsoleMenu::RegisterConCommandBase(ConCommandBase *pCommand)
faluco@216
    83
{
faluco@216
    84
	META_REGCVAR(pCommand);
faluco@216
    85
ds@657
    86
	/* Override values of convars created by SourceMod convar manager if specified on command line */
ds@657
    87
	const char *cmdLineValue = icvar->GetCommandLineValue(pCommand->GetName());
ds@657
    88
	if (cmdLineValue && !pCommand->IsCommand())
ds@657
    89
	{
ds@657
    90
		static_cast<ConVar *>(pCommand)->SetValue(cmdLineValue);
ds@657
    91
	}
ds@657
    92
faluco@216
    93
	return true;
faluco@216
    94
}
faluco@216
    95
dvander@308
    96
void RootConsoleMenu::ConsolePrint(const char *fmt, ...)
dvander@308
    97
{
dvander@308
    98
	char buffer[512];
dvander@308
    99
dvander@308
   100
	va_list ap;
dvander@308
   101
	va_start(ap, fmt);
dvander@308
   102
	size_t len = vsnprintf(buffer, sizeof(buffer), fmt, ap);
dvander@308
   103
	va_end(ap);
dvander@308
   104
dvander@324
   105
	if (len >= sizeof(buffer) - 1)
dvander@308
   106
	{
dvander@308
   107
		buffer[510] = '\n';
dvander@308
   108
		buffer[511] = '\0';
dvander@308
   109
	} else {
dvander@308
   110
		buffer[len++] = '\n';
dvander@308
   111
		buffer[len] = '\0';
dvander@308
   112
	}
dvander@308
   113
	
dvander@308
   114
	META_CONPRINT(buffer);
dvander@308
   115
}
dvander@308
   116
dvander@308
   117
bool RootConsoleMenu::AddRootConsoleCommand(const char *cmd, const char *text, IRootConsoleCommand *pHandler)
faluco@216
   118
{
dvander@2728
   119
	return _AddRootConsoleCommand(cmd, text, pHandler, false);
dvander@2728
   120
}
dvander@2728
   121
dvander@2728
   122
bool RootConsoleMenu::AddRootConsoleCommand2(const char *cmd, const char *text, IRootConsoleCommand *pHandler)
dvander@2728
   123
{
dvander@2728
   124
	return _AddRootConsoleCommand(cmd, text, pHandler, true);
dvander@2728
   125
}
dvander@2728
   126
dvander@2728
   127
bool RootConsoleMenu::_AddRootConsoleCommand(const char *cmd,
dvander@2728
   128
											 const char *text,
dvander@2728
   129
											 IRootConsoleCommand *pHandler,
dvander@2728
   130
											 bool version2)
dvander@2728
   131
{
dvander@308
   132
	if (sm_trie_retrieve(m_pCommands, cmd, NULL))
dvander@308
   133
	{
dvander@308
   134
		return false;
dvander@308
   135
	}
dvander@308
   136
dvander@308
   137
	/* Sort this into the menu */
dvander@308
   138
	List<ConsoleEntry *>::iterator iter = m_Menu.begin();
dvander@308
   139
	ConsoleEntry *pEntry;
dvander@308
   140
	bool inserted = false;
dvander@308
   141
	while (iter != m_Menu.end())
dvander@308
   142
	{
dvander@308
   143
		pEntry = (*iter);
dvander@308
   144
		if (strcmp(cmd, pEntry->command.c_str()) < 0)
dvander@308
   145
		{
dvander@308
   146
			ConsoleEntry *pNew = new ConsoleEntry;
dvander@308
   147
			pNew->command.assign(cmd);
dvander@308
   148
			pNew->description.assign(text);
dvander@2728
   149
			pNew->version2 = version2;
dvander@2728
   150
			pNew->cmd = pHandler;
dvander@2728
   151
			sm_trie_insert(m_pCommands, cmd, pNew);
dvander@308
   152
			m_Menu.insert(iter, pNew);
dvander@308
   153
			inserted = true;
dvander@308
   154
			break;
dvander@308
   155
		}
dvander@308
   156
		iter++;
dvander@308
   157
	}
dvander@308
   158
dvander@308
   159
	if (!inserted)
dvander@308
   160
	{
dvander@308
   161
		ConsoleEntry *pNew = new ConsoleEntry;
dvander@308
   162
		pNew->command.assign(cmd);
dvander@308
   163
		pNew->description.assign(text);
dvander@2728
   164
		pNew->version2 = version2;
dvander@2728
   165
		pNew->cmd = pHandler;
dvander@2728
   166
		sm_trie_insert(m_pCommands, cmd, pNew);
dvander@308
   167
		m_Menu.push_back(pNew);
dvander@308
   168
	}
dvander@308
   169
dvander@308
   170
	return true;
dvander@308
   171
}
dvander@308
   172
dvander@308
   173
bool RootConsoleMenu::RemoveRootConsoleCommand(const char *cmd, IRootConsoleCommand *pHandler)
dvander@308
   174
{
dvander@308
   175
	sm_trie_delete(m_pCommands, cmd);
dvander@308
   176
dvander@308
   177
	List<ConsoleEntry *>::iterator iter;
dvander@308
   178
	ConsoleEntry *pEntry;
dvander@308
   179
	for (iter=m_Menu.begin(); iter!=m_Menu.end(); iter++)
dvander@308
   180
	{
dvander@308
   181
		pEntry = (*iter);
dvander@308
   182
		if (pEntry->command.compare(cmd) == 0)
dvander@308
   183
		{
dvander@308
   184
			delete pEntry;
dvander@308
   185
			m_Menu.erase(iter);
dvander@308
   186
			break;
dvander@308
   187
		}
dvander@308
   188
	}
dvander@308
   189
dvander@308
   190
	return true;
dvander@308
   191
}
dvander@308
   192
dvander@309
   193
void RootConsoleMenu::DrawGenericOption(const char *cmd, const char *text)
dvander@309
   194
{
dvander@309
   195
	char buffer[255];
dvander@309
   196
	size_t len, cmdlen = strlen(cmd);
dvander@309
   197
faluco@651
   198
	len = UTIL_Format(buffer, sizeof(buffer), "    %s", cmd);
dvander@309
   199
	if (cmdlen < 16)
dvander@309
   200
	{
dvander@309
   201
		size_t num = 16 - cmdlen;
dvander@309
   202
		for (size_t i = 0; i < num; i++)
dvander@309
   203
		{
dvander@309
   204
			buffer[len++] = ' ';
dvander@309
   205
		}
dvander@309
   206
		len += snprintf(&buffer[len], sizeof(buffer) - len, " - %s", text);
dvander@309
   207
		ConsolePrint("%s", buffer);
dvander@309
   208
	}
dvander@309
   209
}
dvander@309
   210
dvander@1883
   211
const char *RootConsoleMenu::GetInterfaceName()
dvander@1883
   212
{
dvander@1883
   213
	return SMINTERFACE_ROOTCONSOLE_NAME;
dvander@1883
   214
}
dvander@1883
   215
dvander@1883
   216
unsigned int RootConsoleMenu::GetInterfaceVersion()
dvander@1883
   217
{
dvander@1883
   218
	return SMINTERFACE_ROOTCONSOLE_VERSION;
dvander@1883
   219
}
dvander@1883
   220
dvander@2728
   221
#if SOURCE_ENGINE==SE_EPISODEONE || SOURCE_ENGINE==SE_DARKMESSIAH
dvander@2728
   222
class CCommandArgs : public ICommandArgs
dvander@2728
   223
{
dvander@2728
   224
public:
dvander@2728
   225
	CCommandArgs(const CCommand& _cmd)
dvander@2728
   226
	{
dvander@2728
   227
	}
dvander@2728
   228
	const char *Arg(int n) const
dvander@2728
   229
	{
dvander@2728
   230
		return engine->Cmd_Argv(n);
dvander@2728
   231
	}
dvander@2728
   232
	int ArgC() const
dvander@2728
   233
	{
dvander@2728
   234
		return engine->Cmd_Argc();
dvander@2728
   235
	}
dvander@2728
   236
	const char *ArgS() const
dvander@2728
   237
	{
dvander@2728
   238
		return engine->Cmd_Args();
dvander@2728
   239
	}
dvander@2728
   240
};
dvander@2728
   241
#else
dvander@2728
   242
class CCommandArgs : public ICommandArgs
dvander@2728
   243
{
dvander@2728
   244
	const CCommand *cmd;
dvander@2728
   245
public:
dvander@2728
   246
	CCommandArgs(const CCommand& _cmd) : cmd(&_cmd)
dvander@2728
   247
	{
dvander@2728
   248
	}
dvander@2728
   249
	const char *Arg(int n) const
dvander@2728
   250
	{
dvander@2728
   251
		return cmd->Arg(n);
dvander@2728
   252
	}
dvander@2728
   253
	int ArgC() const
dvander@2728
   254
	{
dvander@2728
   255
		return cmd->ArgC();
dvander@2728
   256
	}
dvander@2728
   257
	const char *ArgS() const
dvander@2728
   258
	{
dvander@2728
   259
		return cmd->ArgS();
dvander@2728
   260
	}
dvander@2728
   261
};
dvander@2728
   262
#endif
dvander@2728
   263
faluco@1541
   264
void RootConsoleMenu::GotRootCmd(const CCommand &cmd)
dvander@308
   265
{
faluco@1541
   266
	unsigned int argnum = cmd.ArgC();
faluco@216
   267
faluco@216
   268
	if (argnum >= 2)
faluco@216
   269
	{
faluco@1541
   270
		const char *cmdname = cmd.Arg(1);
dvander@1902
   271
		if (strcmp(cmdname, "internal") == 0)
dvander@1630
   272
		{
dvander@978
   273
			if (argnum >= 3)
dvander@978
   274
			{
faluco@1541
   275
				const char *arg = cmd.Arg(2);
dvander@978
   276
				if (strcmp(arg, "1") == 0)
dvander@978
   277
				{
dvander@978
   278
					SM_ConfigsExecuted_Global();
dvander@1630
   279
				}
dvander@1630
   280
				else if (strcmp(arg, "2") == 0)
dvander@1630
   281
				{
dvander@978
   282
					if (argnum >= 4)
dvander@978
   283
					{
faluco@1541
   284
						SM_ConfigsExecuted_Plugin(atoi(cmd.Arg(3)));
dvander@978
   285
					}
dvander@978
   286
				}
dvander@978
   287
			}
dvander@978
   288
			return;
dvander@614
   289
		}
dvander@978
   290
dvander@2728
   291
		CCommandArgs ocmd(cmd);
dvander@2728
   292
dvander@2728
   293
		ConsoleEntry *entry;
dvander@2728
   294
		if (sm_trie_retrieve(m_pCommands, cmdname, (void **)&entry))
faluco@216
   295
		{
dvander@2728
   296
			if (entry->version2)
dvander@2728
   297
			{
dvander@2728
   298
				entry->cmd->OnRootConsoleCommand2(cmdname, &ocmd);
dvander@2728
   299
			}
dvander@2728
   300
			else
dvander@2728
   301
			{
dvander@2728
   302
				entry->cmd->OnRootConsoleCommand(cmdname, cmd);
dvander@2728
   303
			}
faluco@270
   304
			return;
faluco@216
   305
		}
faluco@216
   306
	}
dvander@308
   307
dvander@308
   308
	ConsolePrint("SourceMod Menu:");
dvander@308
   309
	ConsolePrint("Usage: sm <command> [arguments]");
dvander@308
   310
dvander@308
   311
	List<ConsoleEntry *>::iterator iter;
dvander@308
   312
	ConsoleEntry *pEntry;
dvander@308
   313
	for (iter=m_Menu.begin(); iter!=m_Menu.end(); iter++)
dvander@308
   314
	{
dvander@308
   315
		pEntry = (*iter);
dvander@309
   316
		DrawGenericOption(pEntry->command.c_str(), pEntry->description.c_str());
dvander@308
   317
	}
dvander@308
   318
}
dvander@308
   319
faluco@1541
   320
void RootConsoleMenu::OnRootConsoleCommand(const char *cmdname, const CCommand &command)
dvander@308
   321
{
faluco@1541
   322
	if (strcmp(cmdname, "credits") == 0)
dvander@308
   323
	{
dvander@308
   324
		ConsolePrint(" SourceMod was developed by AlliedModders, LLC.");
dvander@308
   325
		ConsolePrint(" Development would not have been possible without the following people:");
dvander@2905
   326
		ConsolePrint("  David \"BAILOPAN\" Anderson");
dvander@2905
   327
		ConsolePrint("  Matt \"pRED\" Woodrow");
dvander@2905
   328
		ConsolePrint("  Scott \"DS\" Ehlert");
dvander@2905
   329
		ConsolePrint("  Fyren");
dvander@3311
   330
		ConsolePrint("  Nicholas \"psychonic\" Hastings");
asherkin@3621
   331
		ConsolePrint("  Asher \"asherkin\" Baker");
dvander@2905
   332
		ConsolePrint("  Borja \"faluco\" Ferrer");
dvander@2905
   333
		ConsolePrint("  Pavol \"PM OnoTo\" Marko");
asherkin@3621
   334
		ConsolePrint(" Special thanks to Liam, ferret, and Mani");
dvander@2905
   335
		ConsolePrint(" Special thanks to Viper and SteamFriends");
dvander@308
   336
		ConsolePrint(" http://www.sourcemod.net/");
dvander@2105
   337
	}
dvander@2105
   338
	else if (strcmp(cmdname, "version") == 0)
dvander@2105
   339
	{
dvander@308
   340
		ConsolePrint(" SourceMod Version Information:");
asherkin@3630
   341
		ConsolePrint("    SourceMod Version: %s", SM_VERSION_STRING);
dvander@2193
   342
		ConsolePrint("    SourcePawn Engine: %s (build %s)", g_pSourcePawn2->GetEngineName(), g_pSourcePawn2->GetVersionString());
dvander@2193
   343
		ConsolePrint("    SourcePawn API: v1 = %d, v2 = %d", g_pSourcePawn->GetEngineAPIVersion(), g_pSourcePawn2->GetAPIVersion());
dvander@2105
   344
		ConsolePrint("    Compiled on: %s %s", __DATE__, __TIME__);
dvander@2281
   345
		ConsolePrint("    Build ID: %s", SM_BUILD_UNIQUEID);
dvander@308
   346
		ConsolePrint("    http://www.sourcemod.net/");
dvander@308
   347
	}
dvander@308
   348
}
dvander@308
   349
dvander@308
   350
CON_COMMAND(sm, "SourceMod Menu")
dvander@308
   351
{
ds@2583
   352
#if SOURCE_ENGINE <= SE_DARKMESSIAH
faluco@1541
   353
	CCommand args;
faluco@1541
   354
#endif
faluco@1541
   355
	g_RootMenu.GotRootCmd(args);
dvander@308
   356
}
dvander@900
   357
dvander@1687
   358
FILE *g_pHndlLog = NULL;
dvander@1687
   359
dvander@1687
   360
void write_handles_to_log(const char *fmt, ...)
dvander@1687
   361
{
dvander@1687
   362
	va_list ap;
dvander@1687
   363
	
dvander@1687
   364
	va_start(ap, fmt);
dvander@1687
   365
	vfprintf(g_pHndlLog, fmt, ap);
dvander@1687
   366
	fprintf(g_pHndlLog, "\n");
dvander@1687
   367
	va_end(ap);
dvander@1687
   368
}
dvander@1687
   369
dvander@1687
   370
void write_handles_to_game(const char *fmt, ...)
dvander@1687
   371
{
dvander@1687
   372
	size_t len;
dvander@1687
   373
	va_list ap;
dvander@1687
   374
	char buffer[1024];
dvander@1687
   375
	
dvander@1687
   376
	va_start(ap, fmt);
dvander@1687
   377
	len = UTIL_FormatArgs(buffer, sizeof(buffer)-2, fmt, ap);
dvander@1687
   378
	va_end(ap);
dvander@1687
   379
dvander@1687
   380
	buffer[len] = '\n';
dvander@1687
   381
	buffer[len+1] = '\0';
dvander@1687
   382
dvander@1687
   383
	engine->LogPrint(buffer);
dvander@1687
   384
}
dvander@1687
   385
dvander@900
   386
CON_COMMAND(sm_dump_handles, "Dumps Handle usage to a file for finding Handle leaks")
dvander@900
   387
{
ds@2583
   388
#if SOURCE_ENGINE <= SE_DARKMESSIAH
faluco@1541
   389
	CCommand args;
faluco@1541
   390
#endif
faluco@1541
   391
	if (args.ArgC() < 2)
dvander@900
   392
	{
dvander@1687
   393
		g_RootMenu.ConsolePrint("Usage: sm_dump_handles <file> or <log> for game logs");
dvander@900
   394
		return;
dvander@900
   395
	}
dvander@900
   396
dvander@1687
   397
	if (strcmp(args.Arg(1), "log") != 0)
dvander@900
   398
	{
dvander@1687
   399
		const char *arg = args.Arg(1);
dvander@1687
   400
		FILE *fp = fopen(arg, "wt");
dvander@1687
   401
		if (!fp)
dvander@1687
   402
		{
dvander@1687
   403
			g_RootMenu.ConsolePrint("Could not find file \"%s\"", arg);
dvander@1687
   404
			return;
dvander@1687
   405
		}
dvander@900
   406
dvander@1687
   407
		g_pHndlLog = fp;
dvander@3872
   408
		logicore.DumpHandles(write_handles_to_log);
dvander@1687
   409
		g_pHndlLog = NULL;
dvander@900
   410
dvander@1687
   411
		fclose(fp);
dvander@1687
   412
	}
dvander@1687
   413
	else
dvander@1687
   414
	{
dvander@3872
   415
		logicore.DumpHandles(write_handles_to_game);
dvander@1687
   416
	}
dvander@900
   417
}
dvander@2728
   418