sourcemm/CSmmAPI.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Feb 08 09:19:19 2007 +0000 (2007-02-08)
changeset 280 946485e00593
parent 278 614ea295cd25
child 282 7a237e9ea5a1
permissions -rw-r--r--
Renamed convar.h to convar_smm.h in order to avoid potential compiling problems with the order of include directories.
dvander@9
     1
/* ======== SourceMM ========
dvander@175
     2
* Copyright (C) 2004-2006 Metamod:Source Development Team
dvander@9
     3
* No warranties of any kind
dvander@9
     4
*
dvander@9
     5
* License: zlib/libpng
dvander@9
     6
*
dvander@9
     7
* Author(s): David "BAILOPAN" Anderson
dvander@9
     8
* ============================
dvander@9
     9
*/
dvander@9
    10
ds@280
    11
#include "convar_smm.h"
dvander@9
    12
#include "CSmmAPI.h"
dvander@7
    13
#include "sourcemm.h"
dvander@64
    14
#include "concommands.h"
dvander@124
    15
#include "CPlugin.h"
dvander@7
    16
dvander@9
    17
/**
dvander@9
    18
 * @brief Implementation of main API interface
dvander@9
    19
 * @file CSmmAPI.cpp
dvander@9
    20
 */
dvander@9
    21
dvander@26
    22
using namespace SourceMM;
dvander@26
    23
dvander@7
    24
CSmmAPI g_SmmAPI;
dvander@7
    25
dvander@76
    26
CSmmAPI::CSmmAPI()
dvander@76
    27
{
dvander@76
    28
	m_ConPrintf = NULL;
dvander@76
    29
	m_Cache = false;
dvander@76
    30
}
dvander@76
    31
dvander@7
    32
void CSmmAPI::LogMsg(ISmmPlugin *pl, const char *msg, ...)
dvander@7
    33
{
dvander@7
    34
	va_list ap;
dvander@7
    35
	static char buffer[2048];
dvander@7
    36
dvander@7
    37
	buffer[0] = '\0';
dvander@7
    38
dvander@7
    39
	va_start(ap, msg);
dvander@7
    40
	vsnprintf(buffer, sizeof(buffer)-1, msg, ap);
dvander@7
    41
	va_end(ap);
dvander@7
    42
dvander@7
    43
	LogMessage("[%s] %s", pl->GetLogTag(), buffer);
dvander@7
    44
}
dvander@7
    45
dvander@7
    46
CreateInterfaceFn CSmmAPI::engineFactory(bool syn)
dvander@7
    47
{
dvander@7
    48
	if (syn)
dvander@7
    49
		return EngineFactory;
dvander@7
    50
	return g_Engine.engineFactory;
dvander@7
    51
}
dvander@7
    52
dvander@7
    53
CreateInterfaceFn CSmmAPI::physicsFactory(bool syn)
dvander@7
    54
{
dvander@7
    55
	if (syn)
dvander@7
    56
		return PhysicsFactory;
dvander@7
    57
	return g_Engine.physicsFactory;
dvander@7
    58
}
dvander@7
    59
dvander@7
    60
CreateInterfaceFn CSmmAPI::fileSystemFactory(bool syn)
dvander@7
    61
{
dvander@7
    62
	if (syn)
dvander@7
    63
		return FileSystemFactory;
dvander@7
    64
	return g_Engine.fileSystemFactory;
dvander@7
    65
}
dvander@7
    66
dvander@7
    67
CreateInterfaceFn CSmmAPI::serverFactory(bool syn)
dvander@7
    68
{
dvander@7
    69
	if (syn)
dvander@7
    70
		return CreateInterface;
dvander@7
    71
	return g_GameDll.factory;
dvander@7
    72
}
dvander@7
    73
dvander@7
    74
CGlobalVars *CSmmAPI::pGlobals()
dvander@7
    75
{
dvander@7
    76
	return g_Engine.pGlobals;
dvander@7
    77
}
dvander@7
    78
dvander@7
    79
void CSmmAPI::SetLastMetaReturn(META_RES res)
dvander@7
    80
{
dvander@7
    81
	m_Res = res;
dvander@7
    82
}
dvander@7
    83
dvander@7
    84
META_RES CSmmAPI::GetLastMetaReturn()
dvander@7
    85
{
dvander@7
    86
	return m_Res;
dvander@7
    87
}
dvander@64
    88
dvander@64
    89
IConCommandBaseAccessor *CSmmAPI::GetCvarBaseAccessor()
dvander@64
    90
{
dvander@64
    91
	return static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor);
dvander@64
    92
}
dvander@64
    93
dvander@67
    94
bool CSmmAPI::RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand)
dvander@64
    95
{
dvander@67
    96
	if (pCommand->IsCommand())
dvander@67
    97
	{
dvander@67
    98
		g_PluginMngr.AddPluginCmd(plugin, pCommand);
dvander@67
    99
	} else {
dvander@67
   100
		g_PluginMngr.AddPluginCvar(plugin, pCommand);
dvander@67
   101
	}
dvander@67
   102
dvander@67
   103
	return g_SMConVarAccessor.Register(pCommand);
dvander@64
   104
}
dvander@64
   105
dvander@67
   106
void CSmmAPI::UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand)
ds@65
   107
{
dvander@67
   108
	if (pCommand->IsCommand())
dvander@67
   109
	{
dvander@67
   110
		g_PluginMngr.RemovePluginCmd(plugin, pCommand);
dvander@67
   111
	} else {
dvander@67
   112
		g_PluginMngr.RemovePluginCvar(plugin, pCommand);
dvander@67
   113
	}
dvander@67
   114
ds@65
   115
	g_SMConVarAccessor.Unregister(pCommand);
ds@65
   116
}
ds@65
   117
dvander@76
   118
void CSmmAPI::ConPrint(const char *fmt)
dvander@76
   119
{
dvander@76
   120
	(m_ConPrintf)("%s", fmt);
dvander@76
   121
}
dvander@76
   122
dvander@76
   123
void CSmmAPI::ConPrintf(const char *fmt, ...)
dvander@76
   124
{
dvander@76
   125
	va_list ap;
dvander@76
   126
	static char buf[4096];
dvander@76
   127
	va_start(ap, fmt);
dvander@76
   128
	vsnprintf(buf, sizeof(buf)-1, fmt, ap);
dvander@76
   129
	ConPrint(buf);
dvander@76
   130
	va_end(ap);
dvander@76
   131
}
dvander@76
   132
dvander@138
   133
void CSmmAPI::AddListener(ISmmPlugin *plugin, IMetamodListener *pListener)
dvander@138
   134
{
dvander@138
   135
	CPluginManager::CPlugin *pl = g_PluginMngr.FindByAPI(plugin);
dvander@138
   136
dvander@138
   137
	pl->m_Events.push_back(pListener);
dvander@138
   138
}
dvander@138
   139
dvander@139
   140
void *CSmmAPI::MetaFactory(const char *iface, int *_ret, PluginId *id)
dvander@138
   141
{
dvander@139
   142
	if (id)
dvander@139
   143
		*id = 0;
dvander@139
   144
dvander@138
   145
	if (!iface)
dvander@138
   146
		return NULL;
dvander@138
   147
dvander@138
   148
	//first check ours... we get first chance!
ds@225
   149
	if (strcmp(iface, MMIFACE_SOURCEHOOK) == 0)
dvander@138
   150
	{
dvander@138
   151
		if (_ret)
dvander@138
   152
			*_ret = IFACE_OK;
dvander@138
   153
		return static_cast<void *>(static_cast<SourceHook::ISourceHook *>(&g_SourceHook));
ds@225
   154
	} else if (strcmp(iface, MMIFACE_PLMANAGER) == 0) {
dvander@138
   155
		if (_ret)
dvander@138
   156
			*_ret = IFACE_OK;
ds@225
   157
		return static_cast<void *>(static_cast<ISmmPluginManager *>(&g_PluginMngr));
dvander@138
   158
	}
dvander@138
   159
dvander@138
   160
	CPluginManager::CPlugin *pl;
dvander@138
   161
	SourceHook::List<IMetamodListener *>::iterator event;
dvander@138
   162
	IMetamodListener *api;
dvander@138
   163
	int ret = 0;
dvander@138
   164
	void *val = NULL;
dvander@138
   165
dvander@138
   166
	for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++)
dvander@138
   167
	{
dvander@138
   168
		pl = (*iter);
dvander@138
   169
		for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++)
dvander@138
   170
		{
dvander@138
   171
			api = (*event);
dvander@138
   172
			ret = IFACE_FAILED;
dvander@138
   173
			if ( (val=api->OnMetamodQuery(iface, &ret)) != NULL )
dvander@138
   174
			{
dvander@138
   175
				if (_ret)
dvander@138
   176
					*_ret = ret;
dvander@139
   177
				if (id)
dvander@139
   178
					*id = pl->m_Id;
dvander@138
   179
				return val;
dvander@138
   180
			}
dvander@138
   181
		}
dvander@138
   182
	}
dvander@138
   183
dvander@138
   184
	if (_ret)
dvander@138
   185
		*_ret = IFACE_FAILED;
dvander@138
   186
dvander@138
   187
	return NULL;
dvander@138
   188
}
dvander@138
   189
dvander@76
   190
//////////////////////////////////////////////////////////////////////////
dvander@76
   191
//THERE BE HAX HERE!!!! DON'T TELL ALFRED, BUT GABE WANTED IT THAT WAY. //
dvander@77
   192
// (note: you can find the offset by looking for the text               //
dvander@76
   193
//   "Echo text to console", you'll find the callback cmd pushed on the //
dvander@76
   194
//   stack.)                                                            //
dvander@76
   195
//////////////////////////////////////////////////////////////////////////
dvander@76
   196
dvander@76
   197
#define SIGLEN			8
dvander@76
   198
#define ENGINE486_SIG	"\x55\x89\xE5\x53\x83\xEC\x14\xBB"
dvander@76
   199
#define ENGINE486_OFFS	40
dvander@76
   200
#define ENGINE686_SIG	"\x53\x83\xEC\x08\xBB\x01\x00\x00"
dvander@76
   201
#define ENGINE686_OFFS	50
dvander@94
   202
#define	ENGINEAMD_SIG	"\x53\x51\xBB\x01\x00\x00\x00\x51"
dvander@76
   203
#define	ENGINEAMD_OFFS	47
dvander@76
   204
#define ENGINEW32_SIG	"\xA1\x2A\x2A\x2A\x2A\x56\xBE\x01"
dvander@76
   205
#define ENGINEW32_OFFS	38
dvander@76
   206
#define IA32_CALL		0xE8
dvander@76
   207
dvander@231
   208
bool vcmp(const void *_addr1, const void *_addr2, size_t len)
dvander@76
   209
{
dvander@76
   210
	unsigned char *addr1 = (unsigned char *)_addr1;
dvander@76
   211
	unsigned char *addr2 = (unsigned char *)_addr2;
dvander@76
   212
dvander@76
   213
	for (size_t i=0; i<len; i++)
dvander@76
   214
	{
dvander@76
   215
		if (addr2[i] == '*')
dvander@76
   216
			continue;
dvander@76
   217
		if (addr1[i] != addr2[i])
dvander@76
   218
			return false;
dvander@76
   219
	}
dvander@76
   220
dvander@76
   221
	return true;
dvander@76
   222
}
dvander@76
   223
dvander@76
   224
//Thanks to fysh for the idea of extracting info from "echo" and for
dvander@76
   225
// having the original offsets at hand!
dvander@76
   226
bool CSmmAPI::CacheCmds()
dvander@76
   227
{
dvander@76
   228
	ICvar *pCvar = g_Engine.icvar;
dvander@76
   229
dvander@76
   230
	ConCommandBase *pBase = pCvar->GetCommands();
dvander@76
   231
	unsigned char *ptr = NULL;
dvander@76
   232
	FnCommandCallback callback = NULL;
dvander@76
   233
	int offs = 0;
dvander@76
   234
dvander@76
   235
	while (pBase)
dvander@76
   236
	{
dvander@76
   237
		if ( strcmp(pBase->GetName(), "echo") == 0 )
dvander@76
   238
		{
dvander@76
   239
			//callback = //*((FnCommandCallback *)((char *)pBase + offsetof(ConCommand, m_fnCommandCallback)));
dvander@76
   240
			callback = ((ConCommand *)pBase)->GetCallback();
dvander@76
   241
			ptr = (unsigned char *)callback;
ds@201
   242
		#ifdef OS_LINUX
dvander@76
   243
			if (vcmp(ptr, ENGINE486_SIG, SIGLEN))
dvander@76
   244
			{
dvander@76
   245
				offs = ENGINE486_OFFS;
ds@201
   246
			}
ds@201
   247
			else if (vcmp(ptr, ENGINE686_SIG, SIGLEN))
ds@201
   248
			{
dvander@76
   249
				offs = ENGINE686_OFFS;
ds@201
   250
			}
ds@201
   251
			else if (vcmp(ptr, ENGINEAMD_SIG, SIGLEN))
ds@201
   252
			{
dvander@76
   253
				offs = ENGINEAMD_OFFS;
ds@201
   254
			}
ds@201
   255
		#elif defined OS_WIN32 // Only one Windows engine binary so far...
ds@201
   256
			if (vcmp(ptr, ENGINEW32_SIG, SIGLEN))
ds@201
   257
			{
dvander@76
   258
				offs = ENGINEW32_OFFS;
dvander@76
   259
			}
ds@201
   260
		#endif
ds@201
   261
dvander@76
   262
			if (!offs || ptr[offs-1] != IA32_CALL)
dvander@76
   263
			{
dvander@76
   264
				m_ConPrintf = (CONPRINTF_FUNC)Msg;
dvander@76
   265
				return false;
dvander@76
   266
			}
dvander@76
   267
			//get the relative offset
dvander@76
   268
			m_ConPrintf = *((CONPRINTF_FUNC *)(ptr + offs));
dvander@76
   269
			//add the base offset, to the ip (which is the address+offset + 4 bytes for next instruction)
dvander@76
   270
			m_ConPrintf = (CONPRINTF_FUNC)((unsigned long)m_ConPrintf + (unsigned long)(ptr + offs) + 4);
dvander@76
   271
dvander@76
   272
			m_Cache = true;
dvander@76
   273
dvander@76
   274
			return true;
dvander@76
   275
		}
dvander@76
   276
		pBase = const_cast<ConCommandBase *>(pBase->GetNext());
dvander@76
   277
	}
dvander@76
   278
dvander@76
   279
	m_ConPrintf = (CONPRINTF_FUNC)Msg;
dvander@76
   280
dvander@76
   281
	return false;
dvander@76
   282
}
dvander@76
   283
dvander@76
   284
bool CSmmAPI::CacheSuccessful()
dvander@76
   285
{
dvander@76
   286
	return m_Cache;
dvander@76
   287
}
dvander@124
   288
dvander@124
   289
void CSmmAPI::GetApiVersions(int &major, int &minor, int &plvers, int &plmin)
dvander@124
   290
{
dvander@124
   291
	major = SM_VERS_API_MAJOR;
dvander@124
   292
	minor = SM_VERS_API_MINOR;
dvander@124
   293
	plvers = PLAPI_VERSION;
dvander@124
   294
	plmin = PLAPI_MIN_VERSION;
dvander@124
   295
}
dvander@124
   296
dvander@124
   297
void CSmmAPI::GetShVersions(int &shvers, int &shimpl)
dvander@124
   298
{
dvander@124
   299
	shvers = SH_IFACE_VERSION;
dvander@124
   300
	shimpl = SH_IMPL_VERSION;
dvander@124
   301
}
dvander@152
   302
dvander@152
   303
int CSmmAPI::FormatIface(char iface[], unsigned int maxlength)
dvander@152
   304
{
dvander@206
   305
	int length = (int)strlen(iface);
dvander@152
   306
	int i;
dvander@152
   307
	int num = 0;
dvander@152
   308
dvander@152
   309
	for (i=length-1; i>=0; i--)
dvander@152
   310
	{
dvander@152
   311
		if (!isdigit(iface[i]))
dvander@228
   312
		{
dvander@228
   313
			if (i != length-1)
dvander@228
   314
			{
dvander@228
   315
				num = 1;
dvander@228
   316
			}
dvander@152
   317
			break;
dvander@228
   318
		}
dvander@152
   319
	}
dvander@152
   320
dvander@206
   321
	if ( (num && ((int)maxlength <= length)) || (!num && ((int)maxlength <= length+3)) )
dvander@152
   322
	{
dvander@152
   323
		return -1;
dvander@152
   324
	}
dvander@152
   325
dvander@152
   326
	if (i != length-1)
dvander@152
   327
		num = atoi(&(iface[++i]));
dvander@152
   328
dvander@152
   329
	num++;
dvander@152
   330
dvander@152
   331
	snprintf(&(iface[i]), 4, "%03d", num);
dvander@152
   332
dvander@152
   333
	return num;
dvander@152
   334
}
dvander@152
   335
dvander@166
   336
void *CSmmAPI::InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret)
dvander@166
   337
{
dvander@253
   338
	char _if[256];	/* assume no interface goes beyond this */
dvander@166
   339
	size_t len = strlen(iface);
dvander@166
   340
	int num = 0;
dvander@166
   341
	void *pf = NULL;
dvander@166
   342
dvander@166
   343
	if (max > 999)
dvander@166
   344
		max = 999;
dvander@166
   345
dvander@253
   346
	if (len + 4 > sizeof(_if))
dvander@253
   347
	{
dvander@253
   348
		if (ret)
dvander@253
   349
		{
dvander@253
   350
			*ret = IFACE_FAILED;
dvander@253
   351
		}
dvander@253
   352
		return NULL;
dvander@253
   353
	}
dvander@253
   354
dvander@166
   355
	strcpy(_if, iface);
dvander@166
   356
dvander@166
   357
	do
dvander@166
   358
	{
dvander@174
   359
		if ( (pf = (fn)(_if, ret)) != NULL )
dvander@166
   360
			break;
dvander@166
   361
		if (num > max)
dvander@166
   362
			break;
ds@238
   363
	} while (( num = FormatIface(_if, len+1) ));
dvander@166
   364
dvander@166
   365
	return pf;
dvander@166
   366
}
dvander@166
   367
dvander@251
   368
void *CSmmAPI::VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min)
dvander@244
   369
{
dvander@244
   370
	char buffer[256];	/* assume no interface will go beyond this */
dvander@244
   371
	int len = static_cast<int>(strlen(iface));
dvander@251
   372
	int ret;			/* just in case something doesn't handle NULL properly */
dvander@244
   373
dvander@246
   374
	if (len > static_cast<int>(sizeof(buffer) - 4))
dvander@244
   375
	{
dvander@244
   376
		return NULL;
dvander@244
   377
	}
dvander@244
   378
dvander@244
   379
	strcpy(buffer, iface);
dvander@244
   380
dvander@251
   381
	if (min != -1)
dvander@244
   382
	{
dvander@244
   383
		char *ptr = &buffer[len-1];
dvander@244
   384
		int digits = 0;
dvander@244
   385
		while (isdigit(*ptr) && digits <=3)
dvander@244
   386
		{
dvander@244
   387
			*ptr = '\0';
dvander@244
   388
			digits++;
dvander@244
   389
			ptr--;
dvander@244
   390
		}
dvander@244
   391
		if (digits != 3)
dvander@244
   392
		{
dvander@244
   393
			/* for now, assume this is an error */
dvander@244
   394
			strcpy(buffer, iface);
dvander@251
   395
		} else {
dvander@251
   396
			char num[4];
dvander@251
   397
			min = (min == 0) ? 1 : min;
dvander@251
   398
			snprintf(num, sizeof(num), "%03d", min);
dvander@251
   399
			strcat(buffer, num);
dvander@244
   400
		}
dvander@244
   401
	}
dvander@244
   402
dvander@251
   403
	return InterfaceSearch(fn, buffer, IFACE_MAXNUM, &ret);
dvander@244
   404
}
dvander@244
   405
dvander@166
   406
const char *CSmmAPI::GetBaseDir()
dvander@166
   407
{
dvander@166
   408
	return g_ModPath.c_str();
dvander@166
   409
}
dvander@166
   410
dvander@166
   411
void CSmmAPI::PathFormat(char *buffer, size_t len, const char *fmt, ...)
dvander@166
   412
{
dvander@166
   413
	va_list ap;
dvander@166
   414
	va_start(ap,fmt);
dvander@166
   415
	size_t mylen = vsnprintf(buffer, len, fmt, ap);
dvander@166
   416
	va_end(ap);
dvander@166
   417
dvander@278
   418
	if (mylen == 0xFFFFFFFF || mylen >= len)
dvander@278
   419
	{
dvander@278
   420
		mylen = len - 1;
dvander@278
   421
	}
dvander@278
   422
dvander@166
   423
	for (size_t i=0; i<mylen; i++)
dvander@166
   424
	{
dvander@166
   425
		if (buffer[i] == ALT_SEP_CHAR)
dvander@166
   426
			buffer[i] = PATH_SEP_CHAR;
dvander@166
   427
	}
dvander@166
   428
}
dvander@166
   429
ds@192
   430
void CSmmAPI::ClientConPrintf(edict_t *client, const char *fmt, ...)
ds@192
   431
{
ds@192
   432
	va_list ap;
ds@192
   433
	static char buf[4096];
ds@192
   434
	va_start(ap, fmt);
ds@192
   435
	vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
ds@192
   436
	g_Engine.engine->ClientPrintf(client, buf);
ds@192
   437
	va_end(ap);
ds@192
   438
}