3 * =============================================================================
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
35 #include "sm_stringutil.h"
36 #include "sm_globals.h"
37 #include "sourcemod.h"
38 #include "PluginSys.h"
39 #include "HandleSys.h"
40 #include "LibrarySys.h"
42 #include "ForwardSys.h"
44 #include "ExtensionSys.h"
45 #include <sm_trie_tpl.h>
46 #include <sh_memory.h>
48 #if defined PLATFORM_WINDOWS
50 #elif defined PLATFORM_POSIX
53 #include <sys/times.h>
56 HandleType_t g_PlIter;
57 ConVar sm_datetime_format("sm_datetime_format", "%m/%d/%Y - %H:%M:%S", 0, "Default formatting time rules");
58 IForward *g_OnLogAction = NULL;
60 class CoreNativeHelpers :
62 public IHandleTypeDispatch
65 void OnSourceModAllInitialized()
68 g_HandleSys.InitAccessDefaults(NULL, &hacc);
69 hacc.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY|HANDLE_RESTRICT_OWNER;
71 g_PlIter = g_HandleSys.CreateType("PluginIterator", this, 0, NULL, NULL, g_pCoreIdent, NULL);
73 g_OnLogAction = g_Forwards.CreateForward("OnLogAction",
83 void OnHandleDestroy(HandleType_t type, void *object)
85 IPluginIterator *iter = (IPluginIterator *)object;
88 void OnSourceModShutdown()
90 g_Forwards.ReleaseForward(g_OnLogAction);
91 g_HandleSys.RemoveType(g_PlIter, g_pCoreIdent);
93 } g_CoreNativeHelpers;
95 void LogAction(Handle_t hndl, int type, int client, int target, const char *message)
97 if (g_OnLogAction->GetFunctionCount())
100 g_OnLogAction->PushCell(hndl);
101 g_OnLogAction->PushCell(type);
102 g_OnLogAction->PushCell(client);
103 g_OnLogAction->PushCell(target);
104 g_OnLogAction->PushString(message);
105 g_OnLogAction->Execute(&result);
107 if (result >= (ResultType)Pl_Handled)
113 const char *logtag = "SM";
117 IPlugin *pPlugin = g_PluginSys.PluginFromHandle(hndl, &err);
120 logtag = pPlugin->GetFilename();
124 g_Logger.LogMessage("[%s] %s", logtag, message);
127 static cell_t ThrowError(IPluginContext *pContext, const cell_t *params)
131 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
133 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 1);
135 if (pContext->GetLastNativeError() == SP_ERROR_NONE)
137 pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", buffer);
143 static cell_t GetTime(IPluginContext *pContext, const cell_t *params)
145 time_t t = GetAdjustedTime();
147 pContext->LocalToPhysAddr(params[1], &addr);
151 return static_cast<cell_t>(t);
154 #if defined SUBPLATFORM_SECURECRT
155 void _ignore_invalid_parameter(
156 const wchar_t * expression,
157 const wchar_t * function,
158 const wchar_t * file,
163 /* Wow we don't care, thanks Microsoft. */
167 static cell_t FormatTime(IPluginContext *pContext, const cell_t *params)
169 char *format, *buffer;
170 pContext->LocalToString(params[1], &buffer);
171 pContext->LocalToStringNULL(params[3], &format);
175 format = const_cast<char *>(sm_datetime_format.GetString());
178 #if defined SUBPLATFORM_SECURECRT
179 _invalid_parameter_handler handler = _set_invalid_parameter_handler(_ignore_invalid_parameter);
182 time_t t = (params[4] == -1) ? GetAdjustedTime() : (time_t)params[4];
183 size_t written = strftime(buffer, params[2], format, localtime(&t));
185 #if defined SUBPLATFORM_SECURECRT
186 _set_invalid_parameter_handler(handler);
189 if (params[2] && format[0] != '\0' && !written)
191 pContext->ThrowNativeError("Invalid time format or buffer too small");
198 static cell_t GetPluginIterator(IPluginContext *pContext, const cell_t *params)
200 IPluginIterator *iter = g_PluginSys.GetPluginIterator();
202 Handle_t hndl = g_HandleSys.CreateHandle(g_PlIter, iter, pContext->GetIdentity(), g_pCoreIdent, NULL);
204 if (hndl == BAD_HANDLE)
212 static cell_t MorePlugins(IPluginContext *pContext, const cell_t *params)
214 Handle_t hndl = (Handle_t)params[1];
216 IPluginIterator *pIter;
219 sec.pIdentity = g_pCoreIdent;
220 sec.pOwner = pContext->GetIdentity();
222 if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
224 return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
227 return pIter->MorePlugins() ? 1 : 0;
230 static cell_t ReadPlugin(IPluginContext *pContext, const cell_t *params)
232 Handle_t hndl = (Handle_t)params[1];
234 IPluginIterator *pIter;
237 sec.pIdentity = g_pCoreIdent;
238 sec.pOwner = pContext->GetIdentity();
240 if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
242 return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
245 CPlugin *pPlugin = (CPlugin *)pIter->GetPlugin();
253 return pPlugin->GetMyHandle();
256 CPlugin *GetPluginFromHandle(IPluginContext *pContext, Handle_t hndl)
258 if (hndl == BAD_HANDLE)
260 return g_PluginSys.GetPluginByCtx(pContext->GetContext());
263 CPlugin *pPlugin = (CPlugin *)g_PluginSys.PluginFromHandle(hndl, &err);
266 pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
272 static cell_t GetPluginStatus(IPluginContext *pContext, const cell_t *params)
274 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
280 return pPlugin->GetStatus();
283 static cell_t GetPluginFilename(IPluginContext *pContext, const cell_t *params)
285 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
291 pContext->StringToLocalUTF8(params[2], params[3], pPlugin->GetFilename(), NULL);
296 static cell_t IsPluginDebugging(IPluginContext *pContext, const cell_t *params)
298 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
304 return pPlugin->IsDebugging() ? 1 : 0;
307 /* Local to plugins only */
310 PlInfo_Name, /**< Plugin name */
311 PlInfo_Author, /**< Plugin author */
312 PlInfo_Description, /**< Plugin description */
313 PlInfo_Version, /**< Plugin verison */
314 PlInfo_URL, /**< Plugin URL */
317 static cell_t GetPluginInfo(IPluginContext *pContext, const cell_t *params)
319 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
325 const sm_plugininfo_t *info = pPlugin->GetPublicInfo();
332 const char *str = NULL;
334 switch ((PluginInfo)params[2])
346 case PlInfo_Description:
348 str = info->description;
363 if (!str || str[0] == '\0')
368 pContext->StringToLocalUTF8(params[3], params[4], str, NULL);
373 static cell_t SetFailState(IPluginContext *pContext, const cell_t *params)
378 pContext->LocalToString(params[1], &str);
379 pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
383 pPlugin->SetErrorState(Plugin_Error, "%s", str);
385 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", str);
391 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 1);
392 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
394 pPlugin->SetErrorState(Plugin_Error, "%s", str);
395 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "Formatting error (%s)", str);
399 pPlugin->SetErrorState(Plugin_Error, "%s", buffer);
400 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", buffer);
407 static cell_t GetSysTickCount(IPluginContext *pContext, const cell_t *params)
409 #if defined PLATFORM_WINDOWS
410 return (cell_t)GetTickCount();
411 #elif defined PLATFORM_POSIX
413 clock_t ticks = times(&tm);
414 long ticks_per_sec = sysconf(_SC_CLK_TCK);
415 double fticks = (double)ticks / (double)ticks_per_sec;
417 if (fticks > INT_MAX)
419 double r = (int)(fticks / INT_MAX) * (double)INT_MAX;
422 return (cell_t)fticks;
426 static cell_t AutoExecConfig(IPluginContext *pContext, const cell_t *params)
428 CPlugin *plugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
431 pContext->LocalToString(params[2], &cfg);
432 pContext->LocalToString(params[3], &folder);
436 static char temp_str[255];
437 static char temp_file[PLATFORM_MAX_PATH];
440 g_LibSys.GetFileFromPath(temp_str, sizeof(temp_str), plugin->GetFilename());
441 if ((ptr = strstr(temp_str, ".smx")) != NULL)
446 /* We have the raw filename! */
447 UTIL_Format(temp_file, sizeof(temp_file), "plugin.%s", temp_str);
451 plugin->AddConfig(params[1] ? true : false, cfg, folder);
456 static cell_t MarkNativeAsOptional(IPluginContext *pContext, const cell_t *params)
462 pContext->LocalToString(params[1], &name);
463 if (pContext->FindNativeByName(name, &idx) != SP_ERROR_NONE)
465 /* Oops! This HAS to silently fail! */
469 pContext->GetNativeByIndex(idx, &native);
471 native->flags |= SP_NTVFLAG_OPTIONAL;
476 static cell_t RegPluginLibrary(IPluginContext *pContext, const cell_t *params)
479 CPlugin *pl = g_PluginSys.GetPluginByCtx(pContext->GetContext());
481 pContext->LocalToString(params[1], &name);
483 pl->AddLibrary(name);
488 static cell_t LibraryExists(IPluginContext *pContext, const cell_t *params)
491 pContext->LocalToString(params[1], &str);
493 if (strcmp(str, "__CanTestFeatures__") == 0)
498 if (g_PluginSys.LibraryExists(str))
503 if (g_Extensions.LibraryExists(str))
511 static cell_t sm_LogAction(IPluginContext *pContext, const cell_t *params)
514 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
515 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 3);
517 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
522 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
524 LogAction(pPlugin->GetMyHandle(), 2, params[1], params[2], buffer);
529 static cell_t LogToFile(IPluginContext *pContext, const cell_t *params)
532 pContext->LocalToString(params[1], &file);
534 char path[PLATFORM_MAX_PATH];
535 g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
537 FILE *fp = fopen(path, "at");
540 return pContext->ThrowNativeError("Could not open file \"%s\"", path);
544 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
545 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
547 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
553 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
555 g_Logger.LogToOpenFile(fp, "[%s] %s", pPlugin->GetFilename(), buffer);
562 static cell_t LogToFileEx(IPluginContext *pContext, const cell_t *params)
565 pContext->LocalToString(params[1], &file);
567 char path[PLATFORM_MAX_PATH];
568 g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
570 FILE *fp = fopen(path, "at");
573 return pContext->ThrowNativeError("Could not open file \"%s\"", path);
577 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
578 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
580 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
586 g_Logger.LogToOpenFile(fp, "%s", buffer);
593 static cell_t GetExtensionFileStatus(IPluginContext *pContext, const cell_t *params)
596 pContext->LocalToString(params[1], &str);
598 IExtension *pExtension = g_Extensions.FindExtensionByFile(str);
605 if (!pExtension->IsLoaded())
611 pContext->LocalToString(params[2], &error);
612 if (!pExtension->IsRunning(error, params[3]))
620 static cell_t FindPluginByNumber(IPluginContext *pContext, const cell_t *params)
622 CPlugin *pPlugin = g_PluginSys.GetPluginByOrder(params[1]);
629 return pPlugin->GetMyHandle();
632 static cell_t VerifyCoreVersion(IPluginContext *pContext, const cell_t *params)
637 static cell_t GetFeatureStatus(IPluginContext *pContext, const cell_t *params)
639 FeatureType type = (FeatureType)params[1];
642 pContext->LocalToString(params[2], &name);
644 return g_ShareSys.TestFeature(pContext->GetRuntime(),type, name);
647 static cell_t RequireFeature(IPluginContext *pContext, const cell_t *params)
649 FeatureType type = (FeatureType)params[1];
652 pContext->LocalToString(params[2], &name);
654 if (g_ShareSys.TestFeature(pContext->GetRuntime(),type, name) != FeatureStatus_Available)
658 char default_message[255];
659 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
661 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 3);
662 if (pContext->GetLastNativeError() != SP_ERROR_NONE || buffer[0] == '\0')
664 UTIL_Format(default_message, sizeof(default_message), "Feature \"%s\" not available", name);
665 msg = default_message;
667 pPlugin->SetErrorState(Plugin_Error, "%s", msg);
668 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", msg);
681 //memory addresses below 0x10000 are automatically considered invalid for dereferencing
682 #define VALID_MINIMUM_MEMORY_ADDRESS 0x10000
684 static cell_t LoadFromAddress(IPluginContext *pContext, const cell_t *params)
686 void *addr = reinterpret_cast<void*>(params[1]);
690 pContext->ThrowNativeError("Address cannot be null");
692 else if (reinterpret_cast<uintptr_t>(addr) < VALID_MINIMUM_MEMORY_ADDRESS)
694 pContext->ThrowNativeError("Invalid address 0x%x is pointing to reserved memory.", addr);
696 NumberType size = static_cast<NumberType>(params[2]);
700 case NumberType_Int8:
701 return *reinterpret_cast<uint8_t*>(addr);
702 case NumberType_Int16:
703 return *reinterpret_cast<uint16_t*>(addr);
704 case NumberType_Int32:
705 return *reinterpret_cast<uint32_t*>(addr);
707 pContext->ThrowNativeError("Invalid number types %d", size);
714 static cell_t StoreToAddress(IPluginContext *pContext, const cell_t *params)
716 void *addr = reinterpret_cast<void*>(params[1]);
720 pContext->ThrowNativeError("Address cannot be null");
722 else if (reinterpret_cast<uintptr_t>(addr) < VALID_MINIMUM_MEMORY_ADDRESS)
724 pContext->ThrowNativeError("Invalid address 0x%x is pointing to reserved memory.", addr);
726 cell_t data = params[2];
728 NumberType size = static_cast<NumberType>(params[3]);
732 case NumberType_Int8:
733 SourceHook::SetMemAccess(addr, sizeof(uint8_t), SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
734 *reinterpret_cast<uint8_t*>(addr) = data;
736 case NumberType_Int16:
737 SourceHook::SetMemAccess(addr, sizeof(uint16_t), SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
738 *reinterpret_cast<uint16_t*>(addr) = data;
740 case NumberType_Int32:
741 SourceHook::SetMemAccess(addr, sizeof(uint32_t), SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
742 *reinterpret_cast<uint32_t*>(addr) = data;
745 pContext->ThrowNativeError("Invalid number types %d", size);
751 REGISTER_NATIVES(coreNatives)
753 {"AutoExecConfig", AutoExecConfig},
754 {"GetPluginFilename", GetPluginFilename},
755 {"GetPluginInfo", GetPluginInfo},
756 {"GetPluginIterator", GetPluginIterator},
757 {"GetPluginStatus", GetPluginStatus},
758 {"GetSysTickCount", GetSysTickCount},
759 {"GetTime", GetTime},
760 {"IsPluginDebugging", IsPluginDebugging},
761 {"MorePlugins", MorePlugins},
762 {"ReadPlugin", ReadPlugin},
763 {"ThrowError", ThrowError},
764 {"SetFailState", SetFailState},
765 {"FormatTime", FormatTime},
766 {"MarkNativeAsOptional", MarkNativeAsOptional},
767 {"RegPluginLibrary", RegPluginLibrary},
768 {"LibraryExists", LibraryExists},
769 {"LogAction", sm_LogAction},
770 {"LogToFile", LogToFile},
771 {"LogToFileEx", LogToFileEx},
772 {"GetExtensionFileStatus", GetExtensionFileStatus},
773 {"FindPluginByNumber", FindPluginByNumber},
774 {"VerifyCoreVersion", VerifyCoreVersion},
775 {"GetFeatureStatus", GetFeatureStatus},
776 {"RequireFeature", RequireFeature},
777 {"LoadFromAddress", LoadFromAddress},
778 {"StoreToAddress", StoreToAddress},