sourcemm/concommands.cpp
author Scott Ehlert <ds@alliedmods.net>
Sun May 22 04:33:58 2005 +0000 (2005-05-22)
changeset 66 ddefc8bfb9fa
parent 65 27c4d32394a6
child 67 1753f7a9b2f2
permissions -rw-r--r--
Added macro so that ConCommands created with the SDK's CON_COMMAND and CON_COMMAND_F macros can be properly registered and unregisterd
dvander@7
     1
/* ======== SourceMM ========
dvander@9
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
dvander@7
     3
* No warranties of any kind
dvander@7
     4
*
dvander@7
     5
* License: zlib/libpng
dvander@7
     6
*
dvander@7
     7
* Author(s): David "BAILOPAN" Anderson
dvander@7
     8
* ============================
dvander@7
     9
*/
dvander@7
    10
dvander@7
    11
#include "concommands.h"
dvander@7
    12
#include "CPlugin.h"
dvander@7
    13
dvander@7
    14
/**
dvander@7
    15
 * @brief Console Command Implementations
dvander@7
    16
 * @file concommands.cpp
dvander@7
    17
 */
dvander@7
    18
dvander@7
    19
SMConVarAccessor g_SMConVarAccessor;
dvander@7
    20
dvander@7
    21
bool SMConVarAccessor::RegisterConCommandBase(ConCommandBase *pCommand)
dvander@7
    22
{
pavolmarko@16
    23
	// Add the FCVAR_GAMEDLL flag 
pavolmarko@16
    24
	// => No crash on exit!
pavolmarko@63
    25
	// UPDATE: Do _not_ add the FCVAR_GAMEDLL flag here, as it
pavolmarko@63
    26
	// causes the command to be unusable on listenservers until you load a map
pavolmarko@63
    27
	// We will set the FCVAR_GAMEDLL flag on all commands we have registered once we are being unloaded
pavolmarko@63
    28
	//pCommand->AddFlags(FCVAR_GAMEDLL);
pavolmarko@63
    29
	m_RegisteredCommands.push_back(pCommand);
pavolmarko@63
    30
dvander@7
    31
	pCommand->SetNext( NULL );
dvander@7
    32
	g_Engine.icvar->RegisterConCommandBase(pCommand);
dvander@7
    33
dvander@7
    34
	return true;
dvander@7
    35
}
dvander@7
    36
pavolmarko@63
    37
void SMConVarAccessor::MarkCommandsAsGameDLL()
pavolmarko@63
    38
{
pavolmarko@63
    39
	for (std::list<ConCommandBase*>::iterator iter = m_RegisteredCommands.begin();
pavolmarko@63
    40
		iter != m_RegisteredCommands.end(); ++iter)
pavolmarko@63
    41
	{
pavolmarko@63
    42
		(*iter)->AddFlags(FCVAR_GAMEDLL);
pavolmarko@63
    43
	}
pavolmarko@63
    44
}
pavolmarko@63
    45
dvander@64
    46
void SMConVarAccessor::Unregister(ConCommandBase *pCvar)
dvander@64
    47
{
dvander@64
    48
	ICvar *cv = g_Engine.icvar;
dvander@64
    49
dvander@64
    50
	ConCommandBase *ptr = cv->GetCommands();
dvander@64
    51
dvander@64
    52
	if (ptr == pCvar && ptr->GetNext())
dvander@64
    53
	{
dvander@64
    54
		//we're at the beginning of the list
dvander@64
    55
		*ptr = *(ptr->GetNext());
dvander@64
    56
		return;
dvander@64
    57
	}
dvander@64
    58
dvander@64
    59
	while (ptr)
dvander@64
    60
	{
dvander@64
    61
		ConCommandBase *pNext = const_cast<ConCommandBase *>(ptr->GetNext());
dvander@64
    62
		if (pNext == pCvar)
dvander@64
    63
			break;
dvander@64
    64
		ptr = pNext;
dvander@64
    65
	}
dvander@64
    66
dvander@64
    67
	if (ptr)
dvander@64
    68
	{
dvander@64
    69
		ptr->SetNext(const_cast<ConCommandBase *>(pCvar->GetNext()));
dvander@64
    70
		pCvar->SetNext(NULL);
dvander@64
    71
	}
ds@65
    72
ds@65
    73
	m_RegisteredCommands.remove(pCvar);
dvander@64
    74
}
dvander@64
    75
dvander@7
    76
ConVar metamod_version("metamod_version", SOURCEMM_VERSION, FCVAR_REPLICATED | FCVAR_SPONLY, "Metamod:Source Version");
dvander@7
    77
dvander@7
    78
CON_COMMAND(meta, "Metamod:Source Menu")
dvander@7
    79
{
dvander@7
    80
	IVEngineServer *e = g_Engine.engine;
dvander@7
    81
dvander@7
    82
	int args = e->Cmd_Argc();
dvander@7
    83
dvander@7
    84
	if (args >= 2)
dvander@7
    85
	{
dvander@7
    86
		const char *command = e->Cmd_Argv(1);
dvander@7
    87
		if (strcmp(command, "credits") == 0)
dvander@7
    88
		{
dvander@7
    89
			Msg("Metamod:Source was developed by:\n");
dvander@7
    90
			Msg("  SourceHook: Pavol \"PM OnoTo\" Marko\n");
dvander@7
    91
			Msg("  GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
dvander@7
    92
			Msg("  GameDLL: Scott \"Damaged Soul\" Ehlert\n");
dvander@7
    93
			Msg("For more information, see the official website\n");
dvander@12
    94
			Msg("http://www.sourcemm.net/\n\n");
dvander@7
    95
			
dvander@7
    96
			return;
dvander@7
    97
		} else if (strcmp(command, "version") == 0) {
dvander@7
    98
			Msg("Metamod:Source version %s\n", SOURCEMM_VERSION);
dvander@7
    99
			Msg("Compiled on: %s\n", SOURCEMM_DATE);
dvander@27
   100
			Msg("Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
pavolmarko@63
   101
			Msg("SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
dvander@12
   102
			Msg("http://www.sourcemm.net/\n\n");
dvander@7
   103
dvander@7
   104
			return;
dvander@7
   105
		} else if (strcmp(command, "game") == 0) {
dvander@7
   106
			Msg("GameDLL Information\n");
dvander@7
   107
			Msg("  Mod path: %s\n", g_ModPath.c_str());
dvander@7
   108
			Msg("  Dll path: %s\n", g_BinPath.c_str());
dvander@7
   109
dvander@7
   110
			return;
dvander@7
   111
		} else if (strcmp(command, "refresh") == 0) {
dvander@7
   112
			char full_path[255];
dvander@7
   113
#if defined WIN32 || defined _WIN32
dvander@7
   114
			snprintf(full_path, sizeof(full_path)-1, "%s\\%s", g_ModPath.c_str(), "metaplugins.ini");
dvander@7
   115
#else
dvander@7
   116
			snprintf(full_path, sizeof(full_path)-1, "%s/%s", g_ModPath.c_str(), "metaplugins.ini");
dvander@7
   117
#endif
dvander@7
   118
			LoadPluginsFromFile(full_path);
dvander@7
   119
dvander@7
   120
			return;
dvander@7
   121
		} else if (strcmp(command, "list") == 0) {
dvander@7
   122
			SourceMM::CPluginManager::CPlugin *pl;
dvander@7
   123
			PluginIter i;
dvander@7
   124
			const char *status="";
dvander@12
   125
			const char *version=NULL;
dvander@12
   126
			const char *name=NULL;
dvander@12
   127
			const char *author=NULL;
dvander@7
   128
dvander@9
   129
			Msg("-Id- %-16.15s  %-8.7s  %-12.11s %-8.7s\n", "Name", "Version", "Author", "Status");
dvander@7
   130
			for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
dvander@7
   131
			{
dvander@7
   132
				pl = (*i);
dvander@7
   133
				if (!pl)
dvander@7
   134
					break;
dvander@7
   135
				if (pl->m_Status == Pl_Paused)
dvander@7
   136
				{
dvander@7
   137
					status = "PAUSE";
dvander@7
   138
				} else if (pl->m_Status == Pl_Running) {
dvander@7
   139
					status = "RUN";
dvander@7
   140
				} else if (pl->m_Status == Pl_Refused) {
dvander@7
   141
					status = "FAIL";
dvander@7
   142
				} else if (pl->m_Status == Pl_Error) {
dvander@7
   143
					status = "ERROR";
dvander@7
   144
				} else if (pl->m_Status == Pl_NotFound) {
dvander@7
   145
					status = "NOFILE";
dvander@7
   146
				}
dvander@12
   147
dvander@12
   148
				if (pl->m_API)
dvander@12
   149
				{
dvander@12
   150
					version = pl->m_API->GetVersion();
dvander@12
   151
					author = pl->m_API->GetAuthor();
dvander@12
   152
					name = pl->m_API->GetName();
dvander@12
   153
				} else {
dvander@12
   154
					version = "-";
dvander@12
   155
					author = "-";
dvander@12
   156
					name = "-";
dvander@12
   157
				}
dvander@12
   158
dvander@12
   159
				if (!version)
dvander@12
   160
					version = "-";
dvander@12
   161
				if (!author)
dvander@12
   162
					author = "-";
dvander@12
   163
				if (!name)
dvander@12
   164
					name = pl->m_File.c_str();
dvander@12
   165
dvander@12
   166
dvander@12
   167
				Msg("[%02d] %-16.15s  %-8.7s  %-12.11s %-8.7s\n", pl->m_Id, name, version, author, status);
dvander@7
   168
			}
dvander@7
   169
dvander@12
   170
			Msg("\n");
dvander@12
   171
dvander@7
   172
			return;
dvander@7
   173
		} else if (strcmp(command, "info") == 0) {
dvander@7
   174
			if (args >= 3)
dvander@7
   175
			{
dvander@7
   176
				int id = atoi(e->Cmd_Argv(2));
dvander@7
   177
				SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
dvander@7
   178
				if (!pl)
dvander@7
   179
				{
dvander@7
   180
					Msg("Plugin %d not found.\n", id);
dvander@7
   181
					return;
dvander@7
   182
				}
dvander@7
   183
dvander@7
   184
				if (!pl->m_API)
dvander@7
   185
				{
dvander@7
   186
					Msg("Plugin %d is not loaded.\n", id);
dvander@7
   187
				} else {
dvander@7
   188
					if (pl->m_Status == Pl_Paused)
dvander@7
   189
					{
dvander@7
   190
						Msg("Plugin %d is paused.\n", id);
dvander@7
   191
					} else if (pl->m_Status == Pl_Running) {
dvander@7
   192
						Msg("Plugin %d is running.\n", id);
dvander@7
   193
					}
dvander@27
   194
					Msg("  Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
dvander@27
   195
					Msg("  Version: %s\n", pl->m_API->GetVersion());
dvander@27
   196
					Msg("  Description: %s\n", pl->m_API->GetDescription());
dvander@27
   197
					Msg("  License: %s\n", pl->m_API->GetLicense());
dvander@27
   198
					Msg("  URL: %s\n", pl->m_API->GetURL());
dvander@27
   199
					Msg("  Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
dvander@7
   200
				}
dvander@12
   201
				Msg("File: %s\n\n", pl->m_File.c_str());
dvander@7
   202
dvander@7
   203
				return;
dvander@7
   204
			} else {
dvander@7
   205
				Msg("Usage: meta info <id>\n");
dvander@7
   206
dvander@7
   207
				return;
dvander@7
   208
			}
dvander@9
   209
		} else if (strcmp(command, "pause") == 0) {
dvander@9
   210
			if (args >= 3)
dvander@9
   211
			{
dvander@9
   212
				int id = atoi(e->Cmd_Argv(2));
dvander@12
   213
dvander@12
   214
				char error[255];
dvander@12
   215
dvander@12
   216
				if (!g_PluginMngr.Pause(id, error, sizeof(error)-1))
dvander@9
   217
				{
dvander@12
   218
					Msg("Pause failed: %s\n", error);
dvander@9
   219
					return;
dvander@9
   220
				}
dvander@9
   221
				
dvander@12
   222
				Msg("Plugin %d has been paused.\n", id);
dvander@9
   223
dvander@9
   224
				return;
dvander@9
   225
			} else {
dvander@9
   226
				Msg("Usage: meta pause <id>\n");
dvander@9
   227
dvander@9
   228
				return;
dvander@9
   229
			}
dvander@9
   230
		} else if (strcmp(command, "unpause") == 0) {
dvander@9
   231
			if (args >= 3)
dvander@9
   232
			{
dvander@9
   233
				int id = atoi(e->Cmd_Argv(2));
dvander@12
   234
				char error[255];
dvander@12
   235
dvander@12
   236
				if (!g_PluginMngr.Unpause(id, error, sizeof(error)-1))
dvander@9
   237
				{
dvander@12
   238
					Msg("Unpause failed: %s\n", error);
dvander@9
   239
					return;
dvander@9
   240
				}
dvander@9
   241
dvander@12
   242
				Msg("Plugin %d has been unpaused.\n", id);
dvander@9
   243
dvander@9
   244
				return;
dvander@9
   245
			} else {
dvander@9
   246
				Msg("Usage: meta unpause <id>\n");
dvander@9
   247
dvander@9
   248
				return;
dvander@9
   249
			}
dvander@9
   250
		} else if (strcmp(command, "load") == 0) {
dvander@9
   251
			if (args >= 3)
dvander@9
   252
			{
dvander@9
   253
				const char *file = e->Cmd_Argv(2);
dvander@9
   254
				char full_path[255];
dvander@9
   255
dvander@9
   256
				if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
dvander@9
   257
				{
dvander@9
   258
					snprintf(full_path, sizeof(full_path)-1, "%s", file);
dvander@9
   259
				} else {
dvander@9
   260
					const char *ext = UTIL_GetExtension(file);
dvander@9
   261
#if defined WIN32 || defined _WIN32
dvander@12
   262
					ext = ext ? "" : ".dll";
dvander@9
   263
					snprintf(full_path, sizeof(full_path)-1, "%s\\%s%s", g_ModPath.c_str(), file, ext);
dvander@9
   264
#else
dvander@12
   265
					ext = ext ? "" : "_i486.so";
dvander@9
   266
					snprintf(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), file, ext);
dvander@9
   267
#endif
dvander@9
   268
				}
dvander@9
   269
dvander@9
   270
				char error[255]={0};
dvander@9
   271
				bool already;
dvander@9
   272
				SourceMM::CPluginManager::CPlugin *pl;
dvander@9
   273
dvander@9
   274
				PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error)-1);
dvander@9
   275
				pl = g_PluginMngr.FindById(id);
dvander@9
   276
				if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
dvander@9
   277
				{
dvander@13
   278
					Msg("Failed to load plugin %s (%s).\n", file, error);
dvander@9
   279
					return;
dvander@9
   280
				}
dvander@9
   281
dvander@9
   282
				if (!already)
dvander@9
   283
				{
dvander@9
   284
					Msg("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
dvander@9
   285
				} else {
dvander@9
   286
					Msg("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
dvander@9
   287
				}
dvander@9
   288
				
dvander@9
   289
				return;
dvander@9
   290
			} else {
dvander@9
   291
				Msg("Usage: meta load <path>\n");
dvander@9
   292
dvander@9
   293
				return;
dvander@9
   294
			}
dvander@9
   295
		} else if (strcmp(command, "unload") == 0) {
dvander@9
   296
			if (args >= 3)
dvander@9
   297
			{
dvander@9
   298
				int id = atoi(e->Cmd_Argv(2));
dvander@9
   299
				char error[255]={0};
dvander@9
   300
dvander@9
   301
				if (!g_PluginMngr.Unload(id, false, error, sizeof(error)-1))
dvander@9
   302
				{
dvander@9
   303
					Msg("Unload failed: %s\n", error);
dvander@9
   304
					return;
dvander@9
   305
				}
dvander@9
   306
dvander@9
   307
				Msg("Plugin %d unloaded.\n", id);
dvander@9
   308
dvander@9
   309
				return;
dvander@9
   310
			} else {
dvander@9
   311
				Msg("Usage: meta unload <id>\n");
dvander@9
   312
dvander@9
   313
				return;
dvander@9
   314
			}
dvander@9
   315
		} else if (strcmp(command, "force_unload") == 0) {
dvander@9
   316
			if (args >= 3)
dvander@9
   317
			{
dvander@9
   318
				int id = atoi(e->Cmd_Argv(2));
dvander@9
   319
				char error[255]={0};
dvander@9
   320
dvander@9
   321
				if (!g_PluginMngr.Unload(id, false, error, sizeof(error)-1))
dvander@9
   322
				{
dvander@9
   323
					Msg("Force unload failed: %s\n", error);
dvander@9
   324
					return;
dvander@9
   325
				}
dvander@9
   326
dvander@9
   327
				Msg("Plugin %d force unloaded.\n", id);
dvander@9
   328
dvander@9
   329
				return;
dvander@9
   330
			} else {
dvander@9
   331
				Msg("Usage: meta force_unload <id>\n");
dvander@9
   332
dvander@9
   333
				return;
dvander@9
   334
			}
dvander@9
   335
		} else if (strcmp(command, "clear") == 0) {
dvander@9
   336
			if (!g_PluginMngr.UnloadAll())
dvander@9
   337
			{
dvander@9
   338
				Msg("One or more plugins resisted removal (cleaned anyway).\n");
dvander@9
   339
				return;
dvander@9
   340
			} 
dvander@9
   341
dvander@9
   342
			Msg("All plugins unloaded.\n");
dvander@9
   343
dvander@9
   344
			return;
dvander@13
   345
		} else if (strcmp(command, "retry") == 0) {
dvander@13
   346
			if (args >= 3)
dvander@13
   347
			{
dvander@13
   348
				int id = atoi(e->Cmd_Argv(2));
dvander@29
   349
				char error[255];
dvander@13
   350
dvander@29
   351
				if (!g_PluginMngr.Retry(id, error, sizeof(error)-1))
dvander@13
   352
				{
dvander@29
   353
					Msg("Error reloading plugin: %s\n", error);
dvander@13
   354
					return;
dvander@13
   355
				}
dvander@13
   356
dvander@29
   357
				Msg("Plugin %d successfully reloaded.\n", id);
dvander@13
   358
dvander@13
   359
				return;
dvander@13
   360
			} else {
dvander@28
   361
				Msg("Usage: meta retry <id>\n");
dvander@13
   362
dvander@13
   363
				return;
dvander@13
   364
			}
dvander@7
   365
		}
dvander@7
   366
	}
dvander@7
   367
dvander@7
   368
	Msg("Metamod:Source Menu\n");
dvander@7
   369
	Msg("usage: meta <command> [arguments]\n");
dvander@12
   370
	Msg("  clear        - Unload all plugins forcefully\n");
dvander@12
   371
	Msg("  credits      - About Metamod:Source\n");
dvander@12
   372
	Msg("  force_unload - Forcefully unload a plugin\n");
dvander@12
   373
	Msg("  game         - Information about GameDLL\n");
dvander@12
   374
	Msg("  info         - Information about a plugin\n");
dvander@12
   375
	Msg("  list         - List plugins\n");
dvander@12
   376
	Msg("  load         - Load a plugin\n");
dvander@12
   377
	Msg("  pause        - Pause a running plugin\n");
dvander@12
   378
	Msg("  refresh      - Reparse plugins file\n");
dvander@29
   379
	Msg("  retry        - Attempt to reload a plugin\n");
dvander@12
   380
	Msg("  unload       - Unload a loaded plugin\n");
dvander@12
   381
	Msg("  unpause      - Unpause a paused plugin\n");
dvander@12
   382
	Msg("  version      - Version information\n");
dvander@12
   383
	Msg("\n");
dvander@7
   384
}