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