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