core/smn_core.cpp
author David Anderson <dvander@alliedmods.net>
Fri Sep 07 02:20:08 2007 +0000 (2007-09-07)
changeset 1399 0375333cbc07
parent 1378 115ba755bcdf
child 1419 67fdba7710ba
permissions -rw-r--r--
added amb923 - CheckCommandAccess() changes
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     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.
    11  * 
    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
    15  * details.
    16  *
    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/>.
    19  *
    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>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #include <time.h>
    33 #include <string.h>
    34 #include <stdlib.h>
    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"
    41 #include "TimerSys.h"
    42 #include "ForwardSys.h"
    43 #include "Logger.h"
    44 
    45 #if defined PLATFORM_WINDOWS
    46 #include <windows.h>
    47 #elif defined PLATFORM_LINUX
    48 #include <limits.h>
    49 #include <unistd.h>
    50 #include <sys/times.h>
    51 #endif
    52 
    53 HandleType_t g_PlIter;
    54 ConVar sm_datetime_format("sm_datetime_format", "%m/%d/%Y - %H:%M:%S", 0, "Default formatting time rules");
    55 IForward *g_OnLogAction = NULL;
    56 
    57 class CoreNativeHelpers : 
    58 	public SMGlobalClass,
    59 	public IHandleTypeDispatch
    60 {
    61 public:
    62 	void OnSourceModAllInitialized()
    63 	{
    64 		HandleAccess hacc;
    65 		g_HandleSys.InitAccessDefaults(NULL,  &hacc);
    66 		hacc.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY|HANDLE_RESTRICT_OWNER;
    67 
    68 		g_PlIter = g_HandleSys.CreateType("PluginIterator", this, 0, NULL, NULL, g_pCoreIdent, NULL);
    69 
    70 		g_OnLogAction = g_Forwards.CreateForward("OnLogAction", 
    71 			ET_Hook, 
    72 			5, 
    73 			NULL,
    74 			Param_Cell,
    75 			Param_Cell,
    76 			Param_Cell,
    77 			Param_Cell,
    78 			Param_String);
    79 	}
    80 	void OnHandleDestroy(HandleType_t type, void *object)
    81 	{
    82 		IPluginIterator *iter = (IPluginIterator *)object;
    83 		iter->Release();
    84 	}
    85 	void OnSourceModShutdown()
    86 	{
    87 		g_Forwards.ReleaseForward(g_OnLogAction);
    88 		g_HandleSys.RemoveType(g_PlIter, g_pCoreIdent);
    89 	}
    90 } g_CoreNativeHelpers;
    91 
    92 void LogAction(Handle_t hndl, int type, int client, int target, const char *message)
    93 {
    94 	if (!g_OnLogAction->GetFunctionCount())
    95 	{
    96 		return;
    97 	}
    98 
    99 	cell_t result = 0;
   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);
   106 
   107 	if (result >= (ResultType)Pl_Handled)
   108 	{
   109 		return;
   110 	}
   111 
   112 	const char *logtag = "SM";
   113 	if (type == 2)
   114 	{
   115 		HandleError err;
   116 		IPlugin *pPlugin = g_PluginSys.PluginFromHandle(hndl, &err);
   117 		if (pPlugin)
   118 		{
   119 			logtag = pPlugin->GetFilename();
   120 		}
   121 	}
   122 
   123 	g_Logger.LogMessage("[%s] %s", logtag, message);
   124 }
   125 
   126 static cell_t ThrowError(IPluginContext *pContext, const cell_t *params)
   127 {
   128 	char buffer[512];
   129 
   130 	g_SourceMod.SetGlobalTarget(LANG_SERVER);
   131 
   132 	g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 1);
   133 
   134 	if (pContext->GetContext()->n_err == SP_ERROR_NONE)
   135 	{
   136 		pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", buffer);
   137 	}
   138 
   139 	return 0;
   140 }
   141 
   142 static cell_t GetTime(IPluginContext *pContext, const cell_t *params)
   143 {
   144 	time_t t = GetAdjustedTime();
   145 	cell_t *addr;
   146 	pContext->LocalToPhysAddr(params[1], &addr);
   147 
   148 	*(time_t *)addr = t;
   149 
   150 	return static_cast<cell_t>(t);
   151 }
   152 
   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, 
   158 						unsigned int line,
   159 						uintptr_t pReserved
   160 						)
   161 {
   162 	/* Wow we don't care, thanks Microsoft. */
   163 }
   164 #endif
   165 
   166 static cell_t FormatTime(IPluginContext *pContext, const cell_t *params)
   167 {
   168 	char *format, *buffer;
   169 	pContext->LocalToString(params[1], &buffer);
   170 	pContext->LocalToStringNULL(params[3], &format);
   171 
   172 	if (format == NULL)
   173 	{
   174 		format = const_cast<char *>(sm_datetime_format.GetString());
   175 	}
   176 
   177 #if defined SUBPLATFORM_SECURECRT
   178 	_invalid_parameter_handler handler = _set_invalid_parameter_handler(_ignore_invalid_parameter);
   179 #endif
   180 
   181 	time_t t = (params[4] == -1) ? GetAdjustedTime() : (time_t)params[4];
   182 	size_t written = strftime(buffer, params[2], format, localtime(&t));
   183 
   184 #if defined SUBPLATFORM_SECURECRT
   185 	_set_invalid_parameter_handler(handler);
   186 #endif
   187 
   188 	if (params[2] && format[0] != '\0' && !written)
   189 	{
   190 		pContext->ThrowNativeError("Invalid time format or buffer too small");
   191 		return 0;
   192 	}
   193 
   194 	return 1;
   195 }
   196 
   197 static cell_t GetPluginIterator(IPluginContext *pContext, const cell_t *params)
   198 {
   199 	IPluginIterator *iter = g_PluginSys.GetPluginIterator();
   200 
   201 	Handle_t hndl = g_HandleSys.CreateHandle(g_PlIter, iter, pContext->GetIdentity(), g_pCoreIdent, NULL);
   202 
   203 	if (hndl == BAD_HANDLE)
   204 	{
   205 		iter->Release();
   206 	}
   207 
   208 	return hndl;
   209 }
   210 
   211 static cell_t MorePlugins(IPluginContext *pContext, const cell_t *params)
   212 {
   213 	Handle_t hndl = (Handle_t)params[1];
   214 	HandleError err;
   215 	IPluginIterator *pIter;
   216 
   217 	HandleSecurity sec;
   218 	sec.pIdentity = g_pCoreIdent;
   219 	sec.pOwner = pContext->GetIdentity();
   220 
   221 	if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
   222 	{
   223 		return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
   224 	}
   225 
   226 	return pIter->MorePlugins() ? 1 : 0;
   227 }
   228 
   229 static cell_t ReadPlugin(IPluginContext *pContext, const cell_t *params)
   230 {
   231 	Handle_t hndl = (Handle_t)params[1];
   232 	HandleError err;
   233 	IPluginIterator *pIter;
   234 
   235 	HandleSecurity sec;
   236 	sec.pIdentity = g_pCoreIdent;
   237 	sec.pOwner = pContext->GetIdentity();
   238 
   239 	if ((err=g_HandleSys.ReadHandle(hndl, g_PlIter, &sec, (void **)&pIter)) != HandleError_None)
   240 	{
   241 		return pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
   242 	}
   243 
   244 	CPlugin *pPlugin = (CPlugin *)pIter->GetPlugin();
   245 	if (!pPlugin)
   246 	{
   247 		return BAD_HANDLE;
   248 	}
   249 
   250 	pIter->NextPlugin();
   251 
   252 	return pPlugin->GetMyHandle();
   253 }
   254 
   255 CPlugin *GetPluginFromHandle(IPluginContext *pContext, Handle_t hndl)
   256 {
   257 	if (hndl == BAD_HANDLE)
   258 	{
   259 		return g_PluginSys.GetPluginByCtx(pContext->GetContext());
   260 	} else {
   261 		HandleError err;
   262 		CPlugin *pPlugin = (CPlugin *)g_PluginSys.PluginFromHandle(hndl, &err);
   263 		if (!pPlugin)
   264 		{
   265 			pContext->ThrowNativeError("Could not read Handle %x (error %d)", hndl, err);
   266 		}
   267 		return pPlugin;
   268 	}
   269 }
   270 
   271 static cell_t GetPluginStatus(IPluginContext *pContext, const cell_t *params)
   272 {
   273 	CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
   274 	if (!pPlugin)
   275 	{
   276 		return 0;
   277 	}
   278 
   279 	return pPlugin->GetStatus();
   280 }
   281 
   282 static cell_t GetPluginFilename(IPluginContext *pContext, const cell_t *params)
   283 {
   284 	CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
   285 	if (!pPlugin)
   286 	{
   287 		return 0;
   288 	}
   289 
   290 	pContext->StringToLocalUTF8(params[2], params[3], pPlugin->GetFilename(), NULL);
   291 
   292 	return 1;
   293 }
   294 
   295 static cell_t IsPluginDebugging(IPluginContext *pContext, const cell_t *params)
   296 {
   297 	CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
   298 	if (!pPlugin)
   299 	{
   300 		return 0;
   301 	}
   302 
   303 	return pPlugin->IsDebugging() ? 1 : 0;
   304 }
   305 
   306 /* Local to plugins only */
   307 enum PluginInfo
   308 {
   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 */
   314 };
   315 
   316 static cell_t GetPluginInfo(IPluginContext *pContext, const cell_t *params)
   317 {
   318 	CPlugin *pPlugin = GetPluginFromHandle(pContext, params[1]);
   319 	if (!pPlugin)
   320 	{
   321 		return 0;
   322 	}
   323 
   324 	const sm_plugininfo_t *info = pPlugin->GetPublicInfo();
   325 
   326 	if (!info)
   327 	{
   328 		return 0;
   329 	}
   330 
   331 	const char *str = NULL;
   332 
   333 	switch ((PluginInfo)params[2])
   334 	{
   335 	case PlInfo_Name:
   336 		{
   337 			str = info->name;
   338 			break;
   339 		}
   340 	case PlInfo_Author:
   341 		{
   342 			str = info->author;
   343 			break;
   344 		}
   345 	case PlInfo_Description:
   346 		{
   347 			str = info->description;
   348 			break;
   349 		}
   350 	case PlInfo_Version:
   351 		{
   352 			str = info->version;
   353 			break;
   354 		}
   355 	case PlInfo_URL:
   356 		{
   357 			str = info->url;
   358 			break;
   359 		}
   360 	}
   361 
   362 	if (!str || str[0] == '\0')
   363 	{
   364 		return 0;
   365 	}
   366 
   367 	pContext->StringToLocalUTF8(params[3], params[4], str, NULL);
   368 
   369 	return 1;
   370 }
   371 
   372 static cell_t SetFailState(IPluginContext *pContext, const cell_t *params)
   373 {
   374 	char *str;
   375 	pContext->LocalToString(params[1], &str);
   376 
   377 	CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
   378 	pPlugin->SetErrorState(Plugin_Error, "%s", str);
   379 
   380 	return pContext->ThrowNativeErrorEx(SP_ERROR_ABORTED, "%s", str);
   381 }
   382 
   383 static cell_t GetSysTickCount(IPluginContext *pContext, const cell_t *params)
   384 {
   385 #if defined PLATFORM_WINDOWS
   386 	return (cell_t)GetTickCount();
   387 #elif defined PLATFORM_LINUX
   388 	tms tm;
   389 	clock_t ticks = times(&tm);
   390 	long ticks_per_sec = sysconf(_SC_CLK_TCK);
   391 	double fticks = (double)ticks / (double)ticks_per_sec;
   392 	fticks *= 1000.0f;
   393 	if (fticks > INT_MAX)
   394 	{
   395 		double r = (int)(fticks / INT_MAX) * (double)INT_MAX;
   396 		fticks -= r;
   397 	}
   398 	return (cell_t)fticks;
   399 #endif
   400 }
   401 
   402 static cell_t AutoExecConfig(IPluginContext *pContext, const cell_t *params)
   403 {
   404 	CPlugin *plugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
   405 
   406 	char *cfg, *folder;
   407 	pContext->LocalToString(params[2], &cfg);
   408 	pContext->LocalToString(params[3], &folder);
   409 
   410 	if (cfg[0] == '\0')
   411 	{
   412 		static char temp_str[255];
   413 		static char temp_file[PLATFORM_MAX_PATH];
   414 		char *ptr;
   415 
   416 		g_LibSys.GetFileFromPath(temp_str, sizeof(temp_str), plugin->GetFilename());
   417 		if ((ptr = strstr(temp_str, ".smx")) != NULL)
   418 		{
   419 			*ptr = '\0';
   420 		}
   421 
   422 		/* We have the raw filename! */
   423 		UTIL_Format(temp_file, sizeof(temp_file), "plugin.%s", temp_str);
   424 		cfg = temp_file;
   425 	}
   426 
   427 	plugin->AddConfig(params[1] ? true : false, cfg, folder);
   428 
   429 	return 1;
   430 }
   431 
   432 static cell_t MarkNativeAsOptional(IPluginContext *pContext, const cell_t *params)
   433 {
   434 	char *name;
   435 	uint32_t idx;
   436 	sp_context_t *ctx = pContext->GetContext();
   437 
   438 	pContext->LocalToString(params[1], &name);
   439 	if (pContext->FindNativeByName(name, &idx) != SP_ERROR_NONE)
   440 	{
   441 		/* Oops! This HAS to silently fail! */
   442 		return 0;
   443 	}
   444 
   445 	ctx->natives[idx].flags |= SP_NTVFLAG_OPTIONAL;
   446 
   447 	return 1;
   448 }
   449 
   450 static cell_t RegPluginLibrary(IPluginContext *pContext, const cell_t *params)
   451 {
   452 	char *name;
   453 	CPlugin *pl = g_PluginSys.GetPluginByCtx(pContext->GetContext());
   454 
   455 	pContext->LocalToString(params[1], &name);
   456 
   457 	pl->AddLibrary(name);
   458 
   459 	return 1;
   460 }
   461 
   462 static cell_t LibraryExists(IPluginContext *pContext, const cell_t *params)
   463 {
   464 	char *str;
   465 	pContext->LocalToString(params[1], &str);
   466 
   467 	return g_PluginSys.LibraryExists(str) ? 1 : 0;
   468 }
   469 
   470 static cell_t sm_LogAction(IPluginContext *pContext, const cell_t *params)
   471 {
   472 	char buffer[2048];
   473 	g_SourceMod.SetGlobalTarget(LANG_SERVER);
   474 	g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 3);
   475 
   476 	if (pContext->GetContext()->n_err != SP_ERROR_NONE)
   477 	{
   478 		return 0;
   479 	}
   480 
   481 	CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
   482 
   483 	LogAction(pPlugin->GetMyHandle(), 2, params[1], params[2], buffer);
   484 
   485 	return 1;
   486 }
   487 
   488 static cell_t LogToFile(IPluginContext *pContext, const cell_t *params)
   489 {
   490 	char *file;
   491 	pContext->LocalToString(params[1], &file);
   492 
   493 	char path[PLATFORM_MAX_PATH];
   494 	g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
   495 
   496 	FILE *fp = fopen(path, "at");
   497 	if (!fp)
   498 	{
   499 		return pContext->ThrowNativeError("Could not open file \"%s\"", path);
   500 	}
   501 
   502 	char buffer[2048];
   503 	g_SourceMod.SetGlobalTarget(LANG_SERVER);
   504 	g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
   505 
   506 	if (pContext->GetContext()->n_err != SP_ERROR_NONE)
   507 	{
   508 		fclose(fp);
   509 		return 0;
   510 	}
   511 
   512 	CPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
   513 
   514 	g_Logger.LogToOpenFile(fp, "[%s] %s", pPlugin->GetFilename(), buffer);
   515 
   516 	fclose(fp);
   517 
   518 	return 1;
   519 }
   520 
   521 static cell_t LogToFileEx(IPluginContext *pContext, const cell_t *params)
   522 {
   523 	char *file;
   524 	pContext->LocalToString(params[1], &file);
   525 
   526 	char path[PLATFORM_MAX_PATH];
   527 	g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "%s", file);
   528 
   529 	FILE *fp = fopen(path, "at");
   530 	if (!fp)
   531 	{
   532 		return pContext->ThrowNativeError("Could not open file \"%s\"", path);
   533 	}
   534 
   535 	char buffer[2048];
   536 	g_SourceMod.SetGlobalTarget(LANG_SERVER);
   537 	g_SourceMod.FormatString(buffer, sizeof(buffer), pContext, params, 2);
   538 
   539 	if (pContext->GetContext()->n_err != SP_ERROR_NONE)
   540 	{
   541 		fclose(fp);
   542 		return 0;
   543 	}
   544 
   545 	g_Logger.LogToOpenFile(fp, "%s", buffer);
   546 
   547 	fclose(fp);
   548 
   549 	return 1;
   550 }
   551 
   552 REGISTER_NATIVES(coreNatives)
   553 {
   554 	{"AutoExecConfig",			AutoExecConfig},
   555 	{"GetPluginFilename",		GetPluginFilename},
   556 	{"GetPluginInfo",			GetPluginInfo},
   557 	{"GetPluginIterator",		GetPluginIterator},
   558 	{"GetPluginStatus",			GetPluginStatus},
   559 	{"GetSysTickCount",			GetSysTickCount},
   560 	{"GetTime",					GetTime},
   561 	{"IsPluginDebugging",		IsPluginDebugging},
   562 	{"MorePlugins",				MorePlugins},
   563 	{"ReadPlugin",				ReadPlugin},
   564 	{"ThrowError",				ThrowError},
   565 	{"SetFailState",			SetFailState},
   566 	{"FormatTime",				FormatTime},
   567 	{"MarkNativeAsOptional",	MarkNativeAsOptional},
   568 	{"RegPluginLibrary",		RegPluginLibrary},
   569 	{"LibraryExists",			LibraryExists},
   570 	{"LogAction",				sm_LogAction},
   571 	{"LogToFile",				LogToFile},
   572 	{"LogToFileEx",				LogToFileEx},
   573 	{NULL,						NULL},
   574 };