3 * =============================================================================
5 * Copyright (C) 2004-2007 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"
46 #if defined PLATFORM_WINDOWS
48 #elif defined PLATFORM_LINUX
51 #include <sys/times.h>
54 HandleType_t g_PlIter;
55 ConVar sm_datetime_format("sm_datetime_format", "%m/%d/%Y - %H:%M:%S", 0, "Default formatting time rules");
56 IForward *g_OnLogAction = NULL;
58 class CoreNativeHelpers :
60 public IHandleTypeDispatch
63 void OnSourceModAllInitialized()
66 g_HandleSys.InitAccessDefaults(NULL, &hacc);
67 hacc.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY|HANDLE_RESTRICT_OWNER;
69 g_PlIter = g_HandleSys.CreateType("PluginIterator", this, 0, NULL, NULL, g_pCoreIdent, NULL);
71 g_OnLogAction = g_Forwards.CreateForward("OnLogAction",
81 void OnHandleDestroy(HandleType_t type, void *object)
83 IPluginIterator *iter = (IPluginIterator *)object;
86 void OnSourceModShutdown()
88 g_Forwards.ReleaseForward(g_OnLogAction);
89 g_HandleSys.RemoveType(g_PlIter, g_pCoreIdent);
91 } g_CoreNativeHelpers;
93 void LogAction(Handle_t hndl, int type, int client, int target, const char *message)
95 if (g_OnLogAction->GetFunctionCount())
98 g_OnLogAction->PushCell(hndl);
99 g_OnLogAction->PushCell(type);
100 g_OnLogAction->PushCell(client);
101 g_OnLogAction->PushCell(target);
102 g_OnLogAction->PushString(message);
103 g_OnLogAction->Execute(&result);
105 if (result >= (ResultType)Pl_Handled)
111 const char *logtag = "SM";
115 IPlugin *pPlugin = g_PluginSys.PluginFromHandle(hndl, &err);
118 logtag = pPlugin->GetFilename();
122 g_Logger.LogMessage("[%s] %s", logtag, message);
125 static cell_t ThrowError(IPluginContext *pContext, const cell_t *params)
129 g_SourceMod.SetGlobalTarget(LANG_SERVER);
131 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 1);
133 if (pContext->GetContext()->n_err == SP_ERROR_NONE)
135 pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", buffer);
141 static cell_t GetTime(IPluginContext *pContext, const cell_t *params)
143 time_t t = GetAdjustedTime();
145 pContext->LocalToPhysAddr(params[1], &addr);
149 return static_cast<cell_t>(t);
152 #if defined SUBPLATFORM_SECURECRT
153 void _ignore_invalid_parameter(
154 const wchar_t * expression,
155 const wchar_t * function,
156 const wchar_t * file,
161 /* Wow we don't care, thanks Microsoft. */
165 static cell_t FormatTime(IPluginContext *pContext, const cell_t *params)
167 char *format, *buffer;
168 pContext->LocalToString(params[1], &buffer);
169 pContext->LocalToStringNULL(params[3], &format);
173 format = const_cast<char *>(sm_datetime_format.GetString());
176 #if defined SUBPLATFORM_SECURECRT
177 _invalid_parameter_handler handler = _set_invalid_parameter_handler(_ignore_invalid_parameter);
180 time_t t = (params[4] == -1) ? GetAdjustedTime() : (time_t)params[4];
181 size_t written = strftime(buffer, params[2], format, localtime(&t));
183 #if defined SUBPLATFORM_SECURECRT
184 _set_invalid_parameter_handler(handler);
187 if (params[2] && format[0] != '\0' && !written)
189 pContext->ThrowNativeError("Invalid time format or buffer too small");
196 static cell_t GetPluginIterator(IPluginContext *pContext, const cell_t *params)
198 IPluginIterator *iter = g_PluginSys.GetPluginIterator();
200 Handle_t hndl = g_HandleSys.CreateHandle(g_PlIter, iter, pContext->GetIdentity(), g_pCoreIdent, NULL);
202 if (hndl == BAD_HANDLE)
210 static cell_t MorePlugins(IPluginContext *pContext, const cell_t *params)
212 Handle_t hndl = (Handle_t)params[1];
214 IPluginIterator *pIter;
217 sec.pIdentity = g_pCoreIdent;
218 sec.pOwner = pContext->GetIdentity();
220 if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
222 return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
225 return pIter->MorePlugins() ? 1 : 0;
228 static cell_t ReadPlugin(IPluginContext *pContext, const cell_t *params)
230 Handle_t hndl = (Handle_t)params[1];
232 IPluginIterator *pIter;
235 sec.pIdentity = g_pCoreIdent;
236 sec.pOwner = pContext->GetIdentity();
238 if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
240 return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
243 CPlugin *pPlugin = (CPlugin *)pIter->GetPlugin();
251 return pPlugin->GetMyHandle();
254 CPlugin *GetPluginFromHandle(IPluginContext *pContext, Handle_t hndl)
256 if (hndl == BAD_HANDLE)
258 return g_PluginSys.GetPluginByCtx(pContext->GetContext());
261 CPlugin *pPlugin = (CPlugin *)g_PluginSys.PluginFromHandle(hndl, &err);
264 pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
270 static cell_t GetPluginStatus(IPluginContext *pContext, const cell_t *params)
272 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
278 return pPlugin->GetStatus();
281 static cell_t GetPluginFilename(IPluginContext *pContext, const cell_t *params)
283 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
289 pContext->StringToLocalUTF8(params[2], params[3], pPlugin->GetFilename(), NULL);
294 static cell_t IsPluginDebugging(IPluginContext *pContext, const cell_t *params)
296 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
302 return pPlugin->IsDebugging() ? 1 : 0;
305 /* Local to plugins only */
308 PlInfo_Name, /**< Plugin name */
309 PlInfo_Author, /**< Plugin author */
310 PlInfo_Description, /**< Plugin description */
311 PlInfo_Version, /**< Plugin verison */
312 PlInfo_URL, /**< Plugin URL */
315 static cell_t GetPluginInfo(IPluginContext *pContext, const cell_t *params)
317 CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
323 const sm_plugininfo_t *info = pPlugin->GetPublicInfo();
330 const char *str = NULL;
332 switch ((PluginInfo)params[2])
344 case PlInfo_Description:
346 str = info->description;
361 if (!str || str[0] == '\0')
366 pContext->StringToLocalUTF8(params[3], params[4], str, NULL);
371 static cell_t SetFailState(IPluginContext *pContext, const cell_t *params)
374 pContext->LocalToString(params[1], &str);
376 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
377 pPlugin->SetErrorState(Plugin_Error, "%s", str);
379 return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", str);
382 static cell_t GetSysTickCount(IPluginContext *pContext, const cell_t *params)
384 #if defined PLATFORM_WINDOWS
385 return (cell_t)GetTickCount();
386 #elif defined PLATFORM_LINUX
388 clock_t ticks = times(&tm);
389 long ticks_per_sec = sysconf(_SC_CLK_TCK);
390 double fticks = (double)ticks / (double)ticks_per_sec;
392 if (fticks > INT_MAX)
394 double r = (int)(fticks / INT_MAX) * (double)INT_MAX;
397 return (cell_t)fticks;
401 static cell_t AutoExecConfig(IPluginContext *pContext, const cell_t *params)
403 CPlugin *plugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
406 pContext->LocalToString(params[2], &cfg);
407 pContext->LocalToString(params[3], &folder);
411 static char temp_str[255];
412 static char temp_file[PLATFORM_MAX_PATH];
415 g_LibSys.GetFileFromPath(temp_str, sizeof(temp_str), plugin->GetFilename());
416 if ((ptr = strstr(temp_str, ".smx")) != NULL)
421 /* We have the raw filename! */
422 UTIL_Format(temp_file, sizeof(temp_file), "plugin.%s", temp_str);
426 plugin->AddConfig(params[1] ? true : false, cfg, folder);
431 static cell_t MarkNativeAsOptional(IPluginContext *pContext, const cell_t *params)
435 sp_context_t *ctx = pContext->GetContext();
437 pContext->LocalToString(params[1], &name);
438 if (pContext->FindNativeByName(name, &idx) != SP_ERROR_NONE)
440 /* Oops! This HAS to silently fail! */
444 ctx->natives[idx].flags |= SP_NTVFLAG_OPTIONAL;
449 static cell_t RegPluginLibrary(IPluginContext *pContext, const cell_t *params)
452 CPlugin *pl = g_PluginSys.GetPluginByCtx(pContext->GetContext());
454 pContext->LocalToString(params[1], &name);
456 pl->AddLibrary(name);
461 static cell_t LibraryExists(IPluginContext *pContext, const cell_t *params)
464 pContext->LocalToString(params[1], &str);
466 return g_PluginSys.LibraryExists(str) ? 1 : 0;
469 static cell_t sm_LogAction(IPluginContext *pContext, const cell_t *params)
472 g_SourceMod.SetGlobalTarget(LANG_SERVER);
473 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 3);
475 if (pContext->GetContext()->n_err != SP_ERROR_NONE)
480 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
482 LogAction(pPlugin->GetMyHandle(), 2, params[1], params[2], buffer);
487 static cell_t LogToFile(IPluginContext *pContext, const cell_t *params)
490 pContext->LocalToString(params[1], &file);
492 char path[PLATFORM_MAX_PATH];
493 g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
495 FILE *fp = fopen(path, "at");
498 return pContext->ThrowNativeError("Could not open file \"%s\"", path);
502 g_SourceMod.SetGlobalTarget(LANG_SERVER);
503 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
505 if (pContext->GetContext()->n_err != SP_ERROR_NONE)
511 CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
513 g_Logger.LogToOpenFile(fp, "[%s] %s", pPlugin->GetFilename(), buffer);
520 static cell_t LogToFileEx(IPluginContext *pContext, const cell_t *params)
523 pContext->LocalToString(params[1], &file);
525 char path[PLATFORM_MAX_PATH];
526 g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
528 FILE *fp = fopen(path, "at");
531 return pContext->ThrowNativeError("Could not open file \"%s\"", path);
535 g_SourceMod.SetGlobalTarget(LANG_SERVER);
536 g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
538 if (pContext->GetContext()->n_err != SP_ERROR_NONE)
544 g_Logger.LogToOpenFile(fp, "%s", buffer);
551 static cell_t GetExtensionFileStatus(IPluginContext *pContext, const cell_t *params)
554 pContext->LocalToString(params[1], &str);
556 IExtension *pExtension = g_Extensions.FindExtensionByFile(str);
563 if (!pExtension->IsLoaded())
569 pContext->LocalToString(params[2], &error);
570 if (!pExtension->IsRunning(error, params[3]))
578 REGISTER_NATIVES(coreNatives)
580 {"AutoExecConfig", AutoExecConfig},
581 {"GetPluginFilename", GetPluginFilename},
582 {"GetPluginInfo", GetPluginInfo},
583 {"GetPluginIterator", GetPluginIterator},
584 {"GetPluginStatus", GetPluginStatus},
585 {"GetSysTickCount", GetSysTickCount},
586 {"GetTime", GetTime},
587 {"IsPluginDebugging", IsPluginDebugging},
588 {"MorePlugins", MorePlugins},
589 {"ReadPlugin", ReadPlugin},
590 {"ThrowError", ThrowError},
591 {"SetFailState", SetFailState},
592 {"FormatTime", FormatTime},
593 {"MarkNativeAsOptional", MarkNativeAsOptional},
594 {"RegPluginLibrary", RegPluginLibrary},
595 {"LibraryExists", LibraryExists},
596 {"LogAction", sm_LogAction},
597 {"LogToFile", LogToFile},
598 {"LogToFileEx", LogToFileEx},
599 {"GetExtensionFileStatus", GetExtensionFileStatus},