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>
47 #if defined PLATFORM_WINDOWS
49 #elif defined PLATFORM_POSIX
52 #include <sys/times.h>
55 HandleType_t g_PlIter;
56 ConVar sm_datetime_format("sm_datetime_format", "%m/%d/%Y - %H:%M:%S", 0, "Default formatting time rules");
57 IForward *g_OnLogAction = NULL;
59 class CoreNativeHelpers :
61 public IHandleTypeDispatch
64 void OnSourceModAllInitialized()
67 g_HandleSys.InitAccessDefaults(NULL, &hacc);
68 hacc.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY|HANDLE_RESTRICT_OWNER;
70 g_PlIter = g_HandleSys.CreateType("PluginIterator", this, 0, NULL, NULL, g_pCoreIdent, NULL);
72 g_OnLogAction = g_Forwards.CreateForward("OnLogAction",
82 void OnHandleDestroy(HandleType_t type, void *object)
84 IPluginIterator *iter = (IPluginIterator *)object;
87 void OnSourceModShutdown()
89 g_Forwards.ReleaseForward(g_OnLogAction);
90 g_HandleSys.RemoveType(g_PlIter, g_pCoreIdent);
92 } g_CoreNativeHelpers;
94 void LogAction(Handle_t hndl, int type, int client, int target, const char *message)
96 if (g_OnLogAction->GetFunctionCount())
99 g_OnLogAction->PushCell(hndl);
100 g_OnLogAction->PushCell(type);
101 g_OnLogAction->PushCell(client);
102 g_OnLogAction->PushCell(target);
103 g_OnLogAction->PushString(message);
104 g_OnLogAction->Execute(&result);
106 if (result >= (ResultType)Pl_Handled)
112 const char *logtag = "SM";
116 IPlugin *pPlugin = g_PluginSys.PluginFromHandle(hndl, &err);
119 logtag = pPlugin->GetFilename();
123 g_Logger.LogMessage("[%s] %s", logtag, message);
126 static cell_t ThrowError(IPluginContext *pContext, const cell_t *params)
130 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
132 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 1);
134 if (pContext->GetLastNativeError() == SP_ERROR_NONE)
136 pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", buffer);
142 static cell_t GetTime(IPluginContext *pContext, const cell_t *params)
144 time_t t = GetAdjustedTime();
146 pContext->LocalToPhysAddr(params[1], &addr);
150 return static_cast<cell_t>(t);
153 #if defined SUBPLATFORM_SECURECRT
154 void _ignore_invalid_parameter(
155 const wchar_t * expression,
156 const wchar_t * function,
157 const wchar_t * file,
162 /* Wow we don't care, thanks Microsoft. */
166 static cell_t FormatTime(IPluginContext *pContext, const cell_t *params)
168 char *format, *buffer;
169 pContext->LocalToString(params[1], &buffer);
170 pContext->LocalToStringNULL(params[3], &format);
174 format = const_cast<char *>(sm_datetime_format.GetString());
177 #if defined SUBPLATFORM_SECURECRT
178 _invalid_parameter_handler handler = _set_invalid_parameter_handler(_ignore_invalid_parameter);
181 time_t t = (params[4] == -1) ? GetAdjustedTime() : (time_t)params[4];
182 size_t written = strftime(buffer, params[2], format, localtime(&t));
184 #if defined SUBPLATFORM_SECURECRT
185 _set_invalid_parameter_handler(handler);
188 if (params[2] && format[0] != '\0' && !written)
190 pContext->ThrowNativeError("Invalid time format or buffer too small");
197 static cell_t GetPluginIterator(IPluginContext *pContext, const cell_t *params)
199 IPluginIterator *iter = g_PluginSys.GetPluginIterator();
201 Handle_t hndl = g_HandleSys.CreateHandle(g_PlIter, iter, pContext->GetIdentity(), g_pCoreIdent, NULL);
203 if (hndl == BAD_HANDLE)
211 static cell_t MorePlugins(IPluginContext *pContext, const cell_t *params)
213 Handle_t hndl = (Handle_t)params[1];
215 IPluginIterator *pIter;
218 sec.pIdentity = g_pCoreIdent;
219 sec.pOwner = pContext->GetIdentity();
221 if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
223 return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
226 return pIter->MorePlugins() ? 1 : 0;
229 static cell_t ReadPlugin(IPluginContext *pContext, const cell_t *params)
231 Handle_t hndl = (Handle_t)params[1];
233 IPluginIterator *pIter;
236 sec.pIdentity = g_pCoreIdent;
237 sec.pOwner = pContext->GetIdentity();
239 if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
241 return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
244 CPlugin *pPlugin = (CPlugin *)pIter->GetPlugin();
252 return pPlugin->GetMyHandle();
255 CPlugin *GetPluginFromHandle(IPluginContext *pContext, Handle_t hndl)
257 if (hndl == BAD_HANDLE)
259 return g_PluginSys.GetPluginByCtx(pContext->GetContext());
262 CPlugin *pPlugin = (CPlugin *)g_PluginSys.PluginFromHandle(hndl, &err);
265 pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
271 static cell_t GetPluginStatus(IPluginContext *pContext, const cell_t *params)
273 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
279 return pPlugin->GetStatus();
282 static cell_t GetPluginFilename(IPluginContext *pContext, const cell_t *params)
284 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
290 pContext->StringToLocalUTF8(params[2], params[3], pPlugin->GetFilename(), NULL);
295 static cell_t IsPluginDebugging(IPluginContext *pContext, const cell_t *params)
297 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
303 return pPlugin->IsDebugging() ? 1 : 0;
306 /* Local to plugins only */
309 PlInfo_Name, /**< Plugin name */
310 PlInfo_Author, /**< Plugin author */
311 PlInfo_Description, /**< Plugin description */
312 PlInfo_Version, /**< Plugin verison */
313 PlInfo_URL, /**< Plugin URL */
316 static cell_t GetPluginInfo(IPluginContext *pContext, const cell_t *params)
318 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
324 const sm_plugininfo_t *info = pPlugin->GetPublicInfo();
331 const char *str = NULL;
333 switch ((PluginInfo)params[2])
345 case PlInfo_Description:
347 str = info->description;
362 if (!str || str[0] == '\0')
367 pContext->StringToLocalUTF8(params[3], params[4], str, NULL);
372 static cell_t SetFailState(IPluginContext *pContext, const cell_t *params)
377 pContext->LocalToString(params[1], &str);
378 pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
382 pPlugin->SetErrorState(Plugin_Error, "%s", str);
384 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", str);
390 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 1);
391 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
393 pPlugin->SetErrorState(Plugin_Error, "%s", str);
394 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "Formatting error (%s)", str);
398 pPlugin->SetErrorState(Plugin_Error, "%s", buffer);
399 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", buffer);
406 static cell_t GetSysTickCount(IPluginContext *pContext, const cell_t *params)
408 #if defined PLATFORM_WINDOWS
409 return (cell_t)GetTickCount();
410 #elif defined PLATFORM_POSIX
412 clock_t ticks = times(&tm);
413 long ticks_per_sec = sysconf(_SC_CLK_TCK);
414 double fticks = (double)ticks / (double)ticks_per_sec;
416 if (fticks > INT_MAX)
418 double r = (int)(fticks / INT_MAX) * (double)INT_MAX;
421 return (cell_t)fticks;
425 static cell_t AutoExecConfig(IPluginContext *pContext, const cell_t *params)
427 CPlugin *plugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
430 pContext->LocalToString(params[2], &cfg);
431 pContext->LocalToString(params[3], &folder);
435 static char temp_str[255];
436 static char temp_file[PLATFORM_MAX_PATH];
439 g_LibSys.GetFileFromPath(temp_str, sizeof(temp_str), plugin->GetFilename());
440 if ((ptr = strstr(temp_str, ".smx")) != NULL)
445 /* We have the raw filename! */
446 UTIL_Format(temp_file, sizeof(temp_file), "plugin.%s", temp_str);
450 plugin->AddConfig(params[1] ? true : false, cfg, folder);
455 static cell_t MarkNativeAsOptional(IPluginContext *pContext, const cell_t *params)
461 pContext->LocalToString(params[1], &name);
462 if (pContext->FindNativeByName(name, &idx) != SP_ERROR_NONE)
464 /* Oops! This HAS to silently fail! */
468 pContext->GetNativeByIndex(idx, &native);
470 native->flags |= SP_NTVFLAG_OPTIONAL;
475 static cell_t RegPluginLibrary(IPluginContext *pContext, const cell_t *params)
478 CPlugin *pl = g_PluginSys.GetPluginByCtx(pContext->GetContext());
480 pContext->LocalToString(params[1], &name);
482 pl->AddLibrary(name);
487 static cell_t LibraryExists(IPluginContext *pContext, const cell_t *params)
490 pContext->LocalToString(params[1], &str);
492 if (strcmp(str, "__CanTestFeatures__") == 0)
497 if (g_PluginSys.LibraryExists(str))
502 if (g_Extensions.LibraryExists(str))
510 static cell_t sm_LogAction(IPluginContext *pContext, const cell_t *params)
513 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
514 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 3);
516 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
521 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
523 LogAction(pPlugin->GetMyHandle(), 2, params[1], params[2], buffer);
528 static cell_t LogToFile(IPluginContext *pContext, const cell_t *params)
531 pContext->LocalToString(params[1], &file);
533 char path[PLATFORM_MAX_PATH];
534 g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
536 FILE *fp = fopen(path, "at");
539 return pContext->ThrowNativeError("Could not open file \"%s\"", path);
543 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
544 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
546 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
552 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
554 g_Logger.LogToOpenFile(fp, "[%s] %s", pPlugin->GetFilename(), buffer);
561 static cell_t LogToFileEx(IPluginContext *pContext, const cell_t *params)
564 pContext->LocalToString(params[1], &file);
566 char path[PLATFORM_MAX_PATH];
567 g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
569 FILE *fp = fopen(path, "at");
572 return pContext->ThrowNativeError("Could not open file \"%s\"", path);
576 g_SourceMod.SetGlobalTarget(SOURCEMOD_SERVER_LANGUAGE);
577 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
579 if (pContext->GetLastNativeError() != SP_ERROR_NONE)
585 g_Logger.LogToOpenFile(fp, "%s", buffer);
592 static cell_t GetExtensionFileStatus(IPluginContext *pContext, const cell_t *params)
595 pContext->LocalToString(params[1], &str);
597 IExtension *pExtension = g_Extensions.FindExtensionByFile(str);
604 if (!pExtension->IsLoaded())
610 pContext->LocalToString(params[2], &error);
611 if (!pExtension->IsRunning(error, params[3]))
619 static cell_t FindPluginByNumber(IPluginContext *pContext, const cell_t *params)
621 CPlugin *pPlugin = g_PluginSys.GetPluginByOrder(params[1]);
628 return pPlugin->GetMyHandle();
631 static cell_t VerifyCoreVersion(IPluginContext *pContext, const cell_t *params)
636 static cell_t GetFeatureStatus(IPluginContext *pContext, const cell_t *params)
638 FeatureType type = (FeatureType)params[1];
641 pContext->LocalToString(params[2], &name);
643 return g_ShareSys.TestFeature(pContext->GetRuntime(),type, name);
646 static cell_t RequireFeature(IPluginContext *pContext, const cell_t *params)
648 FeatureType type = (FeatureType)params[1];
651 pContext->LocalToString(params[2], &name);
653 if (g_ShareSys.TestFeature(pContext->GetRuntime(),type, name) != FeatureStatus_Available)
657 char default_message[255];
658 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
660 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 3);
661 if (pContext->GetLastNativeError() != SP_ERROR_NONE || buffer[0] == '\0')
663 UTIL_Format(default_message, sizeof(default_message), "Feature \"%s\" not available", name);
664 msg = default_message;
666 pPlugin->SetErrorState(Plugin_Error, "%s", msg);
667 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", msg);
680 //memory addresses below 0x10000 are automatically considered invalid for dereferencing
681 #define VALID_MINIMUM_MEMORY_ADDRESS 0x10000
683 static cell_t LoadFromAddress(IPluginContext *pContext, const cell_t *params)
685 void *addr = reinterpret_cast<void*>(params[1]);
689 pContext->ThrowNativeError("Address cannot be null");
691 else if (reinterpret_cast<uintptr_t>(addr) < VALID_MINIMUM_MEMORY_ADDRESS)
693 pContext->ThrowNativeError("Invalid address 0x%x is pointing to reserved memory.", addr);
695 NumberType size = static_cast<NumberType>(params[2]);
699 case NumberType_Int8:
700 return *reinterpret_cast<uint8_t*>(addr);
701 case NumberType_Int16:
702 return *reinterpret_cast<uint16_t*>(addr);
703 case NumberType_Int32:
704 return *reinterpret_cast<uint32_t*>(addr);
706 pContext->ThrowNativeError("Invalid number types %d", size);
713 static cell_t StoreToAddress(IPluginContext *pContext, const cell_t *params)
715 void *addr = reinterpret_cast<void*>(params[1]);
719 pContext->ThrowNativeError("Address cannot be null");
721 else if (reinterpret_cast<uintptr_t>(addr) < VALID_MINIMUM_MEMORY_ADDRESS)
723 pContext->ThrowNativeError("Invalid address 0x%x is pointing to reserved memory.", addr);
725 cell_t data = params[2];
727 NumberType size = static_cast<NumberType>(params[3]);
731 case NumberType_Int8:
732 *reinterpret_cast<uint8_t*>(addr) = data;
733 case NumberType_Int16:
734 *reinterpret_cast<uint16_t*>(addr) = data;
735 case NumberType_Int32:
736 *reinterpret_cast<uint32_t*>(addr) = data;
738 pContext->ThrowNativeError("Invalid number types %d", size);
744 REGISTER_NATIVES(coreNatives)
746 {"AutoExecConfig", AutoExecConfig},
747 {"GetPluginFilename", GetPluginFilename},
748 {"GetPluginInfo", GetPluginInfo},
749 {"GetPluginIterator", GetPluginIterator},
750 {"GetPluginStatus", GetPluginStatus},
751 {"GetSysTickCount", GetSysTickCount},
752 {"GetTime", GetTime},
753 {"IsPluginDebugging", IsPluginDebugging},
754 {"MorePlugins", MorePlugins},
755 {"ReadPlugin", ReadPlugin},
756 {"ThrowError", ThrowError},
757 {"SetFailState", SetFailState},
758 {"FormatTime", FormatTime},
759 {"MarkNativeAsOptional", MarkNativeAsOptional},
760 {"RegPluginLibrary", RegPluginLibrary},
761 {"LibraryExists", LibraryExists},
762 {"LogAction", sm_LogAction},
763 {"LogToFile", LogToFile},
764 {"LogToFileEx", LogToFileEx},
765 {"GetExtensionFileStatus", GetExtensionFileStatus},
766 {"FindPluginByNumber", FindPluginByNumber},
767 {"VerifyCoreVersion", VerifyCoreVersion},
768 {"GetFeatureStatus", GetFeatureStatus},
769 {"RequireFeature", RequireFeature},
770 {"LoadFromAddress", LoadFromAddress},
771 {"StoreToAddress", StoreToAddress},