core/CoreConfig.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Mar 27 04:54:56 2008 +0000 (2008-03-27)
changeset 1947 e73a1e51833b
parent 1656 b0b86d57530c
child 2289 44045ead61cd
permissions -rw-r--r--
Updated copyright year
ds@661
     1
/**
ds@661
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
ds@661
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
ds@661
    28
 *
ds@661
    29
 * Version: $Id$
ds@661
    30
 */
ds@661
    31
dvander@1406
    32
#include <ITextParsers.h>
ds@661
    33
#include "CoreConfig.h"
ds@661
    34
#include "sourcemod.h"
ds@661
    35
#include "sourcemm_api.h"
ds@661
    36
#include "sm_srvcmds.h"
dvander@978
    37
#include "sm_version.h"
dvander@978
    38
#include "sm_stringutil.h"
ds@661
    39
#include "LibrarySys.h"
ds@661
    40
#include "Logger.h"
dvander@978
    41
#include "PluginSys.h"
dvander@978
    42
#include "ForwardSys.h"
ds@661
    43
ds@661
    44
#ifdef PLATFORM_WINDOWS
ds@661
    45
ConVar sm_corecfgfile("sm_corecfgfile", "addons\\sourcemod\\configs\\core.cfg", 0, "SourceMod core configuration file");
dvander@663
    46
#elif defined PLATFORM_LINUX
ds@661
    47
ConVar sm_corecfgfile("sm_corecfgfile", "addons/sourcemod/configs/core.cfg", 0, "SourceMod core configuration file");
ds@661
    48
#endif
ds@661
    49
dvander@978
    50
IForward *g_pOnServerCfg = NULL;
dvander@978
    51
IForward *g_pOnConfigsExecuted = NULL;
ds@661
    52
CoreConfig g_CoreConfig;
dvander@978
    53
bool g_bConfigsExecd = false;
ds@661
    54
ds@661
    55
void CoreConfig::OnSourceModAllInitialized()
ds@661
    56
{
ds@661
    57
	g_RootMenu.AddRootConsoleCommand("config", "Set core configuration options", this);
dvander@978
    58
	g_pOnServerCfg = g_Forwards.CreateForward("OnServerCfg", ET_Ignore, 0, NULL);
dvander@978
    59
	g_pOnConfigsExecuted = g_Forwards.CreateForward("OnConfigsExecuted", ET_Ignore, 0, NULL);
ds@661
    60
}
ds@661
    61
ds@661
    62
void CoreConfig::OnSourceModShutdown()
ds@661
    63
{
ds@661
    64
	g_RootMenu.RemoveRootConsoleCommand("config", this);
dvander@978
    65
	g_Forwards.ReleaseForward(g_pOnServerCfg);
dvander@978
    66
	g_Forwards.ReleaseForward(g_pOnConfigsExecuted);
dvander@978
    67
}
dvander@978
    68
dvander@978
    69
void CoreConfig::OnSourceModLevelChange(const char *mapName)
dvander@978
    70
{
dvander@978
    71
	g_bConfigsExecd = false;
ds@661
    72
}
ds@661
    73
faluco@1541
    74
void CoreConfig::OnRootConsoleCommand(const char *cmdname, const CCommand &command)
ds@661
    75
{
faluco@1541
    76
	int argcount = command.ArgC();
ds@661
    77
	if (argcount >= 4)
ds@661
    78
	{
faluco@1541
    79
		const char *option = command.Arg(2);
faluco@1541
    80
		const char *value = command.Arg(3);
ds@661
    81
dvander@663
    82
		char error[255];
ds@661
    83
ds@669
    84
		ConfigResult res = SetConfigOption(option, value, ConfigSource_Console, error, sizeof(error));
dvander@663
    85
ds@669
    86
		if (res == ConfigResult_Reject)
ds@661
    87
		{
ds@669
    88
			g_RootMenu.ConsolePrint("[SM] Could not set config option \"%s\" to \"%s\" (%s)", option, value, error);
ds@669
    89
		} else if (res == ConfigResult_Ignore) {
ds@669
    90
			g_RootMenu.ConsolePrint("[SM] No such config option \"%s\" exists.", option);
dvander@665
    91
		} else {
dvander@665
    92
			g_RootMenu.ConsolePrint("Config option \"%s\" successfully set to \"%s.\"", option, value);
ds@661
    93
		}
ds@661
    94
ds@661
    95
		return;
ds@661
    96
	}
ds@661
    97
ds@661
    98
	g_RootMenu.ConsolePrint("[SM] Usage: sm config <option> <value>");
ds@661
    99
}
ds@661
   100
ds@661
   101
void CoreConfig::Initialize()
ds@661
   102
{
dvander@1656
   103
	SMCError err;
ds@661
   104
	char filePath[PLATFORM_MAX_PATH];
ds@661
   105
ds@661
   106
	/* Try to get command line value of core config convar */
ds@661
   107
	const char *corecfg = icvar->GetCommandLineValue("sm_corecfgfile");
ds@661
   108
ds@661
   109
	/* If sm_corecfgfile not specified on command line, use default value */
ds@661
   110
	if (!corecfg)
ds@661
   111
	{
ds@661
   112
		corecfg = sm_corecfgfile.GetDefault();
ds@661
   113
	}
ds@661
   114
ds@661
   115
	/* Format path to config file */
ds@729
   116
	g_LibSys.PathFormat(filePath, sizeof(filePath), "%s/%s", g_SourceMod.GetGamePath(), corecfg);
ds@661
   117
ds@661
   118
	/* Parse config file */
dvander@1656
   119
	if ((err=textparsers->ParseFile_SMC(filePath, this, NULL)) != SMCError_Okay)
ds@661
   120
	{
dvander@665
   121
 		/* :TODO: This won't actually log or print anything :( - So fix that somehow */
dvander@1406
   122
		const char *error = textparsers->GetSMCErrorString(err);
dvander@663
   123
		g_Logger.LogFatal("[SM] Error encountered parsing core config file: %s", error ? error : "");
ds@661
   124
	}
ds@661
   125
}
ds@661
   126
dvander@1656
   127
SMCResult CoreConfig::ReadSMC_KeyValue(const SMCStates *states, const char *key, const char *value)
ds@661
   128
{
dvander@663
   129
	char error[255];
dvander@663
   130
	ConfigResult err = SetConfigOption(key, value, ConfigSource_File, error, sizeof(error));
ds@661
   131
dvander@663
   132
	if (err == ConfigResult_Reject)
ds@661
   133
	{
dvander@663
   134
		/* This is a fatal error */
dvander@665
   135
		g_Logger.LogFatal("Config error (key: %s) (value: %s) %s", key, value, error);
ds@661
   136
	}
ds@661
   137
dvander@1656
   138
	return SMCResult_Continue;
ds@661
   139
}
ds@661
   140
dvander@663
   141
ConfigResult CoreConfig::SetConfigOption(const char *option, const char *value, ConfigSource source, char *error, size_t maxlength)
ds@661
   142
{
dvander@663
   143
	ConfigResult result;
ds@661
   144
ds@661
   145
	/* Notify! */
ds@661
   146
	SMGlobalClass *pBase = SMGlobalClass::head;
ds@661
   147
	while (pBase)
ds@661
   148
	{
dvander@663
   149
		if ((result = pBase->OnSourceModConfigChanged(option, value, source, error, maxlength)) != ConfigResult_Ignore)
ds@661
   150
		{
dvander@663
   151
			return result;
ds@661
   152
		}
ds@661
   153
		pBase = pBase->m_pGlobalClassNext;
ds@661
   154
	}
ds@661
   155
dvander@663
   156
	return ConfigResult_Ignore;
ds@661
   157
}
dvander@978
   158
dvander@978
   159
bool SM_AreConfigsExecuted()
dvander@978
   160
{
dvander@978
   161
	return g_bConfigsExecd;
dvander@978
   162
}
dvander@978
   163
dvander@978
   164
inline bool IsPathSepChar(char c)
dvander@978
   165
{
dvander@978
   166
#if defined PLATFORM_WINDOWS
dvander@978
   167
	return (c == '\\' || c == '/');
dvander@978
   168
#elif defined PLATFORM_LINUX
dvander@978
   169
	return (c == '/');
dvander@978
   170
#endif
dvander@978
   171
}
dvander@978
   172
dvander@978
   173
bool SM_ExecuteConfig(CPlugin *pl, AutoConfig *cfg, bool can_create)
dvander@978
   174
{
dvander@978
   175
	bool will_create = false;
dvander@978
   176
	
dvander@978
   177
	/* See if we should be creating */
dvander@978
   178
	if (can_create && cfg->create)
dvander@978
   179
	{
dvander@978
   180
		will_create = true;
dvander@978
   181
		
dvander@978
   182
		/* If the folder does not exist, attempt to create it.  
dvander@978
   183
		 * We're awfully nice.
dvander@978
   184
		 */
dvander@978
   185
		const char *folder = cfg->folder.c_str();
dvander@978
   186
		char path[PLATFORM_MAX_PATH];
dvander@978
   187
		char build[PLATFORM_MAX_PATH];
dvander@978
   188
dvander@978
   189
		g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "cfg/%s", folder);
dvander@978
   190
dvander@978
   191
		if (!g_LibSys.IsPathDirectory(path))
dvander@978
   192
		{
dvander@978
   193
			char *cur_ptr = path;
dvander@978
   194
			size_t len;
dvander@978
   195
			
dvander@978
   196
			g_LibSys.PathFormat(path, sizeof(path), "%s", folder);
dvander@978
   197
			len = g_SourceMod.BuildPath(Path_Game, build, sizeof(build), "cfg");
dvander@978
   198
dvander@978
   199
			do
dvander@978
   200
			{
dvander@978
   201
				/* Find next suitable path */
dvander@978
   202
				char *next_ptr = cur_ptr;
dvander@978
   203
				while (*next_ptr != '\0')
dvander@978
   204
				{
dvander@978
   205
					if (IsPathSepChar(*next_ptr))
dvander@978
   206
					{
dvander@978
   207
						*next_ptr = '\0';
dvander@978
   208
						next_ptr++;
dvander@978
   209
						break;
dvander@978
   210
					}
dvander@978
   211
					next_ptr++;
dvander@978
   212
				}
dvander@978
   213
				if (*next_ptr == '\0')
dvander@978
   214
				{
dvander@978
   215
					next_ptr = NULL;
dvander@978
   216
				}
dvander@978
   217
				len += g_LibSys.PathFormat(&build[len], 
dvander@978
   218
					sizeof(build)-len,
dvander@978
   219
					"/%s",
dvander@978
   220
					cur_ptr);
dvander@1192
   221
				if (!g_LibSys.CreateFolder(build))
dvander@978
   222
				{
dvander@978
   223
					break;
dvander@978
   224
				}
dvander@978
   225
				cur_ptr = next_ptr;
dvander@978
   226
			} while (cur_ptr);
dvander@978
   227
		}
dvander@978
   228
	}
dvander@978
   229
dvander@978
   230
	/* Check if the file exists. */
dvander@978
   231
	char file[PLATFORM_MAX_PATH];
dvander@978
   232
	char local[PLATFORM_MAX_PATH];
dvander@978
   233
dvander@978
   234
	if (cfg->folder.size())
dvander@978
   235
	{
dvander@978
   236
		g_LibSys.PathFormat(local, 
dvander@978
   237
			sizeof(local), 
dvander@978
   238
			"%s/%s.cfg",
dvander@978
   239
			cfg->folder.c_str(),
dvander@978
   240
			cfg->autocfg.c_str());
dvander@978
   241
	} else {
dvander@978
   242
		g_LibSys.PathFormat(local,
dvander@978
   243
			sizeof(local),
dvander@978
   244
			"%s.cfg",
dvander@978
   245
			cfg->autocfg.c_str());
dvander@978
   246
	}
dvander@978
   247
	
dvander@978
   248
	g_SourceMod.BuildPath(Path_Game, file, sizeof(file), "cfg/%s", local);
dvander@978
   249
dvander@978
   250
	bool file_exists = g_LibSys.IsPathFile(file);
dvander@978
   251
	if (!file_exists && will_create)
dvander@978
   252
	{
dvander@978
   253
		List<const ConVar *> *convars = NULL;
dvander@978
   254
		if (pl->GetProperty("ConVarList", (void **)&convars, false) && convars)
dvander@978
   255
		{
dvander@978
   256
			/* Attempt to create it */
dvander@978
   257
			FILE *fp = fopen(file, "wt");
dvander@978
   258
			if (fp)
dvander@978
   259
			{
dvander@978
   260
				fprintf(fp, "// This file was auto-generated by SourceMod (v%s)\n", SVN_FULL_VERSION);
dvander@978
   261
				fprintf(fp, "// ConVars for plugin \"%s\"\n", pl->GetFilename());
dvander@978
   262
				fprintf(fp, "\n\n");
dvander@978
   263
dvander@978
   264
				List<const ConVar *>::iterator iter;
dvander@978
   265
				float x;
dvander@978
   266
				for (iter = convars->begin(); iter != convars->end(); iter++)
dvander@978
   267
				{
ds@1020
   268
					const ConVar *cvar = (*iter);
dvander@1019
   269
dvander@1019
   270
					if ((cvar->GetFlags() & FCVAR_DONTRECORD) == FCVAR_DONTRECORD)
dvander@1019
   271
					{
dvander@1019
   272
						continue;
dvander@1019
   273
					}
dvander@1019
   274
dvander@978
   275
					char descr[255];
dvander@978
   276
					char *dptr = descr;
dvander@978
   277
dvander@978
   278
					/* Print comments until there is no more */
dvander@978
   279
					strncopy(descr, cvar->GetHelpText(), sizeof(descr));
dvander@978
   280
					while (*dptr != '\0')
dvander@978
   281
					{
dvander@978
   282
						/* Find the next line */
dvander@978
   283
						char *next_ptr = dptr;
dvander@978
   284
						while (*next_ptr != '\0')
dvander@978
   285
						{
dvander@978
   286
							if (*next_ptr == '\n')
dvander@978
   287
							{
dvander@978
   288
								*next_ptr = '\0';
dvander@978
   289
								next_ptr++;
dvander@978
   290
								break;
dvander@978
   291
							}
dvander@978
   292
							next_ptr++;
dvander@978
   293
						}
dvander@978
   294
						fprintf(fp, "// %s\n", dptr);
dvander@978
   295
						dptr = next_ptr;
dvander@978
   296
					}
dvander@978
   297
dvander@978
   298
					fprintf(fp, "// -\n");
dvander@978
   299
					fprintf(fp, "// Default: \"%s\"\n", cvar->GetDefault());
dvander@978
   300
					if (cvar->GetMin(x))
dvander@978
   301
					{
dvander@978
   302
						fprintf(fp, "// Minimum: \"%02f\"\n", x);
dvander@978
   303
					}
dvander@978
   304
					if (cvar->GetMax(x))
dvander@978
   305
					{
dvander@978
   306
						fprintf(fp, "// Maximum: \"%02f\"\n", x);
dvander@978
   307
					}
dvander@978
   308
					fprintf(fp, "%s \"%s\"\n", cvar->GetName(), cvar->GetDefault());
dvander@978
   309
					fprintf(fp, "\n");
dvander@978
   310
				}
dvander@978
   311
				fprintf(fp, "\n");
dvander@978
   312
dvander@978
   313
				file_exists = true;
dvander@978
   314
				can_create = false;
dvander@978
   315
				fclose(fp);
dvander@978
   316
			}
dvander@978
   317
		}
dvander@978
   318
	}
dvander@978
   319
dvander@978
   320
	if (file_exists)
dvander@978
   321
	{
dvander@978
   322
		char cmd[255];
dvander@978
   323
		UTIL_Format(cmd, sizeof(cmd), "exec %s\n", local);
dvander@978
   324
		engine->ServerCommand(cmd);
dvander@978
   325
	}
dvander@978
   326
dvander@978
   327
	return can_create;
dvander@978
   328
}
dvander@978
   329
dvander@978
   330
void SM_DoSingleExecFwds(IPluginContext *ctx)
dvander@978
   331
{
dvander@978
   332
	IPluginFunction *pf;
dvander@978
   333
dvander@978
   334
	if ((pf = ctx->GetFunctionByName("OnServerCfg")) != NULL)
dvander@978
   335
	{
dvander@978
   336
		pf->Execute(NULL);
dvander@978
   337
	}
dvander@978
   338
dvander@978
   339
	if ((pf = ctx->GetFunctionByName("OnConfigsExecuted")) != NULL)
dvander@978
   340
	{
dvander@978
   341
		pf->Execute(NULL);
dvander@978
   342
	}
dvander@978
   343
}
dvander@978
   344
dvander@978
   345
void SM_ConfigsExecuted_Plugin(unsigned int serial)
dvander@978
   346
{
dvander@978
   347
	IPluginIterator *iter = g_PluginSys.GetPluginIterator();
dvander@978
   348
	while (iter->MorePlugins())
dvander@978
   349
	{
dvander@978
   350
		CPlugin *plugin = (CPlugin *)(iter->GetPlugin());
dvander@978
   351
		if (plugin->GetSerial() == serial)
dvander@978
   352
		{
dvander@978
   353
			SM_DoSingleExecFwds(plugin->GetBaseContext());
dvander@978
   354
			break;
dvander@978
   355
		}
dvander@978
   356
		iter->NextPlugin();
dvander@978
   357
	}
dvander@978
   358
	iter->Release();
dvander@978
   359
}
dvander@978
   360
dvander@978
   361
void SM_ExecuteForPlugin(IPluginContext *ctx)
dvander@978
   362
{
dvander@978
   363
	CPlugin *plugin = (CPlugin *)g_PluginSys.GetPluginByCtx(ctx->GetContext());
dvander@978
   364
dvander@978
   365
	unsigned int num = plugin->GetConfigCount();
dvander@978
   366
	if (!num)
dvander@978
   367
	{
dvander@978
   368
		SM_DoSingleExecFwds(ctx);
dvander@1630
   369
	}
dvander@1630
   370
	else
dvander@1630
   371
	{
dvander@978
   372
		bool can_create = true;
dvander@978
   373
		for (unsigned int i=0; i<num; i++)
dvander@978
   374
		{
dvander@978
   375
			can_create = SM_ExecuteConfig(plugin, plugin->GetConfig(i), can_create);
dvander@978
   376
		}
dvander@978
   377
		char cmd[255];
dvander@978
   378
		UTIL_Format(cmd, sizeof(cmd), "sm internal 2 %d\n", plugin->GetSerial());
dvander@978
   379
		engine->ServerCommand(cmd);
dvander@978
   380
	}
dvander@978
   381
}
dvander@978
   382
dvander@978
   383
void SM_ExecuteAllConfigs()
dvander@978
   384
{
dvander@978
   385
	if (g_bConfigsExecd)
dvander@978
   386
	{
dvander@978
   387
		return;
dvander@978
   388
	}
dvander@978
   389
dvander@1021
   390
	engine->ServerCommand("exec sourcemod/sourcemod.cfg\n");
dvander@978
   391
dvander@978
   392
	IPluginIterator *iter = g_PluginSys.GetPluginIterator();
dvander@978
   393
	while (iter->MorePlugins())
dvander@978
   394
	{
dvander@978
   395
		CPlugin *plugin = (CPlugin *)(iter->GetPlugin());
dvander@978
   396
		unsigned int num = plugin->GetConfigCount();
dvander@978
   397
		bool can_create = true;
dvander@978
   398
		for (unsigned int i=0; i<num; i++)
dvander@978
   399
		{
dvander@978
   400
			can_create = SM_ExecuteConfig(plugin, plugin->GetConfig(i), can_create);
dvander@978
   401
		}
dvander@978
   402
		iter->NextPlugin();
dvander@978
   403
	}
dvander@978
   404
	iter->Release();
dvander@978
   405
dvander@978
   406
	engine->ServerCommand("sm internal 1\n");
dvander@978
   407
}
dvander@978
   408
dvander@978
   409
void SM_ConfigsExecuted_Global()
dvander@978
   410
{
dvander@978
   411
	if (g_bConfigsExecd)
dvander@978
   412
	{
dvander@978
   413
		return;
dvander@978
   414
	}
dvander@978
   415
dvander@978
   416
	g_bConfigsExecd = true;
dvander@978
   417
dvander@978
   418
	g_pOnServerCfg->Execute(NULL);
dvander@978
   419
	g_pOnConfigsExecuted->Execute(NULL);
dvander@978
   420
}