core/CoreConfig.cpp
author David Anderson <dvander@alliedmods.net>
Thu Jun 21 23:06:37 2007 +0000 (2007-06-21)
changeset 997 2fc3152c3118
parent 978 54782a83a1ef
child 1019 394131f5bbf3
permissions -rw-r--r--
bumped menu api again - added feature to get menu end reason
ds@661
     1
/**
ds@661
     2
 * vim: set ts=4 :
ds@661
     3
 * ===============================================================
ds@661
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
ds@661
     5
 * ===============================================================
ds@661
     6
 *
ds@661
     7
 * This file is not open source and may not be copied without explicit
ds@661
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
ds@661
     9
 * in whole or significant part.
ds@661
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
ds@661
    11
 *
ds@661
    12
 * Version: $Id$
ds@661
    13
 */
ds@661
    14
ds@661
    15
#include "CoreConfig.h"
ds@661
    16
#include "sourcemod.h"
ds@661
    17
#include "sourcemm_api.h"
ds@661
    18
#include "sm_srvcmds.h"
dvander@978
    19
#include "sm_version.h"
dvander@978
    20
#include "sm_stringutil.h"
ds@661
    21
#include "LibrarySys.h"
ds@661
    22
#include "TextParsers.h"
ds@661
    23
#include "Logger.h"
dvander@978
    24
#include "PluginSys.h"
dvander@978
    25
#include "ForwardSys.h"
ds@661
    26
ds@661
    27
#ifdef PLATFORM_WINDOWS
ds@661
    28
ConVar sm_corecfgfile("sm_corecfgfile", "addons\\sourcemod\\configs\\core.cfg", 0, "SourceMod core configuration file");
dvander@663
    29
#elif defined PLATFORM_LINUX
ds@661
    30
ConVar sm_corecfgfile("sm_corecfgfile", "addons/sourcemod/configs/core.cfg", 0, "SourceMod core configuration file");
ds@661
    31
#endif
ds@661
    32
dvander@978
    33
IForward *g_pOnServerCfg = NULL;
dvander@978
    34
IForward *g_pOnConfigsExecuted = NULL;
ds@661
    35
CoreConfig g_CoreConfig;
dvander@978
    36
bool g_bConfigsExecd = false;
ds@661
    37
ds@661
    38
void CoreConfig::OnSourceModAllInitialized()
ds@661
    39
{
ds@661
    40
	g_RootMenu.AddRootConsoleCommand("config", "Set core configuration options", this);
dvander@978
    41
	g_pOnServerCfg = g_Forwards.CreateForward("OnServerCfg", ET_Ignore, 0, NULL);
dvander@978
    42
	g_pOnConfigsExecuted = g_Forwards.CreateForward("OnConfigsExecuted", ET_Ignore, 0, NULL);
ds@661
    43
}
ds@661
    44
ds@661
    45
void CoreConfig::OnSourceModShutdown()
ds@661
    46
{
ds@661
    47
	g_RootMenu.RemoveRootConsoleCommand("config", this);
dvander@978
    48
	g_Forwards.ReleaseForward(g_pOnServerCfg);
dvander@978
    49
	g_Forwards.ReleaseForward(g_pOnConfigsExecuted);
dvander@978
    50
}
dvander@978
    51
dvander@978
    52
void CoreConfig::OnSourceModLevelChange(const char *mapName)
dvander@978
    53
{
dvander@978
    54
	g_bConfigsExecd = false;
ds@661
    55
}
ds@661
    56
ds@661
    57
void CoreConfig::OnRootConsoleCommand(const char *command, unsigned int argcount)
ds@661
    58
{
ds@661
    59
	if (argcount >= 4)
ds@661
    60
	{
ds@661
    61
		const char *option = engine->Cmd_Argv(2);
ds@661
    62
		const char *value = engine->Cmd_Argv(3);
ds@661
    63
dvander@663
    64
		char error[255];
ds@661
    65
ds@669
    66
		ConfigResult res = SetConfigOption(option, value, ConfigSource_Console, error, sizeof(error));
dvander@663
    67
ds@669
    68
		if (res == ConfigResult_Reject)
ds@661
    69
		{
ds@669
    70
			g_RootMenu.ConsolePrint("[SM] Could not set config option \"%s\" to \"%s\" (%s)", option, value, error);
ds@669
    71
		} else if (res == ConfigResult_Ignore) {
ds@669
    72
			g_RootMenu.ConsolePrint("[SM] No such config option \"%s\" exists.", option);
dvander@665
    73
		} else {
dvander@665
    74
			g_RootMenu.ConsolePrint("Config option \"%s\" successfully set to \"%s.\"", option, value);
ds@661
    75
		}
ds@661
    76
ds@661
    77
		return;
ds@661
    78
	}
ds@661
    79
ds@661
    80
	g_RootMenu.ConsolePrint("[SM] Usage: sm config <option> <value>");
ds@661
    81
}
ds@661
    82
ds@661
    83
void CoreConfig::Initialize()
ds@661
    84
{
ds@661
    85
	SMCParseError err;
ds@661
    86
	char filePath[PLATFORM_MAX_PATH];
ds@661
    87
ds@661
    88
	/* Try to get command line value of core config convar */
ds@661
    89
	const char *corecfg = icvar->GetCommandLineValue("sm_corecfgfile");
ds@661
    90
ds@661
    91
	/* If sm_corecfgfile not specified on command line, use default value */
ds@661
    92
	if (!corecfg)
ds@661
    93
	{
ds@661
    94
		corecfg = sm_corecfgfile.GetDefault();
ds@661
    95
	}
ds@661
    96
ds@661
    97
	/* Format path to config file */
ds@729
    98
	g_LibSys.PathFormat(filePath, sizeof(filePath), "%s/%s", g_SourceMod.GetGamePath(), corecfg);
ds@661
    99
ds@661
   100
	/* Parse config file */
ds@669
   101
	if ((err=g_TextParser.ParseFile_SMC(filePath, this, NULL, NULL)) != SMCParse_Okay)
ds@661
   102
	{
dvander@665
   103
 		/* :TODO: This won't actually log or print anything :( - So fix that somehow */
dvander@663
   104
		const char *error = g_TextParser.GetSMCErrorString(err);
dvander@663
   105
		g_Logger.LogFatal("[SM] Error encountered parsing core config file: %s", error ? error : "");
ds@661
   106
	}
ds@661
   107
}
ds@661
   108
ds@661
   109
SMCParseResult CoreConfig::ReadSMC_KeyValue(const char *key, const char *value, bool key_quotes, bool value_quotes)
ds@661
   110
{
dvander@663
   111
	char error[255];
dvander@663
   112
	ConfigResult err = SetConfigOption(key, value, ConfigSource_File, error, sizeof(error));
ds@661
   113
dvander@663
   114
	if (err == ConfigResult_Reject)
ds@661
   115
	{
dvander@663
   116
		/* This is a fatal error */
dvander@665
   117
		g_Logger.LogFatal("Config error (key: %s) (value: %s) %s", key, value, error);
ds@661
   118
	}
ds@661
   119
ds@661
   120
	return SMCParse_Continue;
ds@661
   121
}
ds@661
   122
dvander@663
   123
ConfigResult CoreConfig::SetConfigOption(const char *option, const char *value, ConfigSource source, char *error, size_t maxlength)
ds@661
   124
{
dvander@663
   125
	ConfigResult result;
ds@661
   126
ds@661
   127
	/* Notify! */
ds@661
   128
	SMGlobalClass *pBase = SMGlobalClass::head;
ds@661
   129
	while (pBase)
ds@661
   130
	{
dvander@663
   131
		if ((result = pBase->OnSourceModConfigChanged(option, value, source, error, maxlength)) != ConfigResult_Ignore)
ds@661
   132
		{
dvander@663
   133
			return result;
ds@661
   134
		}
ds@661
   135
		pBase = pBase->m_pGlobalClassNext;
ds@661
   136
	}
ds@661
   137
dvander@663
   138
	return ConfigResult_Ignore;
ds@661
   139
}
dvander@978
   140
dvander@978
   141
bool SM_AreConfigsExecuted()
dvander@978
   142
{
dvander@978
   143
	return g_bConfigsExecd;
dvander@978
   144
}
dvander@978
   145
dvander@978
   146
inline bool IsPathSepChar(char c)
dvander@978
   147
{
dvander@978
   148
#if defined PLATFORM_WINDOWS
dvander@978
   149
	return (c == '\\' || c == '/');
dvander@978
   150
#elif defined PLATFORM_LINUX
dvander@978
   151
	return (c == '/');
dvander@978
   152
#endif
dvander@978
   153
}
dvander@978
   154
dvander@978
   155
bool SM_ExecuteConfig(CPlugin *pl, AutoConfig *cfg, bool can_create)
dvander@978
   156
{
dvander@978
   157
	bool will_create = false;
dvander@978
   158
	
dvander@978
   159
	/* See if we should be creating */
dvander@978
   160
	if (can_create && cfg->create)
dvander@978
   161
	{
dvander@978
   162
		will_create = true;
dvander@978
   163
		
dvander@978
   164
		/* If the folder does not exist, attempt to create it.  
dvander@978
   165
		 * We're awfully nice.
dvander@978
   166
		 */
dvander@978
   167
		const char *folder = cfg->folder.c_str();
dvander@978
   168
		char path[PLATFORM_MAX_PATH];
dvander@978
   169
		char build[PLATFORM_MAX_PATH];
dvander@978
   170
dvander@978
   171
		g_SourceMod.BuildPath(Path_Game, path, sizeof(path), "cfg/%s", folder);
dvander@978
   172
dvander@978
   173
		if (!g_LibSys.IsPathDirectory(path))
dvander@978
   174
		{
dvander@978
   175
			char *cur_ptr = path;
dvander@978
   176
			size_t len;
dvander@978
   177
			
dvander@978
   178
			g_LibSys.PathFormat(path, sizeof(path), "%s", folder);
dvander@978
   179
			len = g_SourceMod.BuildPath(Path_Game, build, sizeof(build), "cfg");
dvander@978
   180
dvander@978
   181
			do
dvander@978
   182
			{
dvander@978
   183
				/* Find next suitable path */
dvander@978
   184
				char *next_ptr = cur_ptr;
dvander@978
   185
				while (*next_ptr != '\0')
dvander@978
   186
				{
dvander@978
   187
					if (IsPathSepChar(*next_ptr))
dvander@978
   188
					{
dvander@978
   189
						*next_ptr = '\0';
dvander@978
   190
						next_ptr++;
dvander@978
   191
						break;
dvander@978
   192
					}
dvander@978
   193
					next_ptr++;
dvander@978
   194
				}
dvander@978
   195
				if (*next_ptr == '\0')
dvander@978
   196
				{
dvander@978
   197
					next_ptr = NULL;
dvander@978
   198
				}
dvander@978
   199
				len += g_LibSys.PathFormat(&build[len], 
dvander@978
   200
					sizeof(build)-len,
dvander@978
   201
					"/%s",
dvander@978
   202
					cur_ptr);
dvander@978
   203
				if (!g_LibSys.CreateDirectory(build))
dvander@978
   204
				{
dvander@978
   205
					break;
dvander@978
   206
				}
dvander@978
   207
				cur_ptr = next_ptr;
dvander@978
   208
			} while (cur_ptr);
dvander@978
   209
		}
dvander@978
   210
	}
dvander@978
   211
dvander@978
   212
	/* Check if the file exists. */
dvander@978
   213
	char file[PLATFORM_MAX_PATH];
dvander@978
   214
	char local[PLATFORM_MAX_PATH];
dvander@978
   215
dvander@978
   216
	if (cfg->folder.size())
dvander@978
   217
	{
dvander@978
   218
		g_LibSys.PathFormat(local, 
dvander@978
   219
			sizeof(local), 
dvander@978
   220
			"%s/%s.cfg",
dvander@978
   221
			cfg->folder.c_str(),
dvander@978
   222
			cfg->autocfg.c_str());
dvander@978
   223
	} else {
dvander@978
   224
		g_LibSys.PathFormat(local,
dvander@978
   225
			sizeof(local),
dvander@978
   226
			"%s.cfg",
dvander@978
   227
			cfg->autocfg.c_str());
dvander@978
   228
	}
dvander@978
   229
	
dvander@978
   230
	g_SourceMod.BuildPath(Path_Game, file, sizeof(file), "cfg/%s", local);
dvander@978
   231
dvander@978
   232
	bool file_exists = g_LibSys.IsPathFile(file);
dvander@978
   233
	if (!file_exists && will_create)
dvander@978
   234
	{
dvander@978
   235
		List<const ConVar *> *convars = NULL;
dvander@978
   236
		if (pl->GetProperty("ConVarList", (void **)&convars, false) && convars)
dvander@978
   237
		{
dvander@978
   238
			/* Attempt to create it */
dvander@978
   239
			FILE *fp = fopen(file, "wt");
dvander@978
   240
			if (fp)
dvander@978
   241
			{
dvander@978
   242
				fprintf(fp, "// This file was auto-generated by SourceMod (v%s)\n", SVN_FULL_VERSION);
dvander@978
   243
				fprintf(fp, "// ConVars for plugin \"%s\"\n", pl->GetFilename());
dvander@978
   244
				fprintf(fp, "\n\n");
dvander@978
   245
dvander@978
   246
				List<const ConVar *>::iterator iter;
dvander@978
   247
				float x;
dvander@978
   248
				for (iter = convars->begin(); iter != convars->end(); iter++)
dvander@978
   249
				{
dvander@978
   250
					const ConVar *cvar = (*iter);
dvander@978
   251
					char descr[255];
dvander@978
   252
					char *dptr = descr;
dvander@978
   253
dvander@978
   254
					/* Print comments until there is no more */
dvander@978
   255
					strncopy(descr, cvar->GetHelpText(), sizeof(descr));
dvander@978
   256
					while (*dptr != '\0')
dvander@978
   257
					{
dvander@978
   258
						/* Find the next line */
dvander@978
   259
						char *next_ptr = dptr;
dvander@978
   260
						while (*next_ptr != '\0')
dvander@978
   261
						{
dvander@978
   262
							if (*next_ptr == '\n')
dvander@978
   263
							{
dvander@978
   264
								*next_ptr = '\0';
dvander@978
   265
								next_ptr++;
dvander@978
   266
								break;
dvander@978
   267
							}
dvander@978
   268
							next_ptr++;
dvander@978
   269
						}
dvander@978
   270
						fprintf(fp, "// %s\n", dptr);
dvander@978
   271
						dptr = next_ptr;
dvander@978
   272
					}
dvander@978
   273
dvander@978
   274
					fprintf(fp, "// -\n");
dvander@978
   275
					fprintf(fp, "// Default: \"%s\"\n", cvar->GetDefault());
dvander@978
   276
					if (cvar->GetMin(x))
dvander@978
   277
					{
dvander@978
   278
						fprintf(fp, "// Minimum: \"%02f\"\n", x);
dvander@978
   279
					}
dvander@978
   280
					if (cvar->GetMax(x))
dvander@978
   281
					{
dvander@978
   282
						fprintf(fp, "// Maximum: \"%02f\"\n", x);
dvander@978
   283
					}
dvander@978
   284
					fprintf(fp, "%s \"%s\"\n", cvar->GetName(), cvar->GetDefault());
dvander@978
   285
					fprintf(fp, "\n");
dvander@978
   286
				}
dvander@978
   287
				fprintf(fp, "\n");
dvander@978
   288
dvander@978
   289
				file_exists = true;
dvander@978
   290
				can_create = false;
dvander@978
   291
				fclose(fp);
dvander@978
   292
			}
dvander@978
   293
		}
dvander@978
   294
	}
dvander@978
   295
dvander@978
   296
	if (file_exists)
dvander@978
   297
	{
dvander@978
   298
		char cmd[255];
dvander@978
   299
		UTIL_Format(cmd, sizeof(cmd), "exec %s\n", local);
dvander@978
   300
		engine->ServerCommand(cmd);
dvander@978
   301
	}
dvander@978
   302
dvander@978
   303
	return can_create;
dvander@978
   304
}
dvander@978
   305
dvander@978
   306
void SM_DoSingleExecFwds(IPluginContext *ctx)
dvander@978
   307
{
dvander@978
   308
	IPluginFunction *pf;
dvander@978
   309
dvander@978
   310
	if ((pf = ctx->GetFunctionByName("OnServerCfg")) != NULL)
dvander@978
   311
	{
dvander@978
   312
		pf->Execute(NULL);
dvander@978
   313
	}
dvander@978
   314
dvander@978
   315
	if ((pf = ctx->GetFunctionByName("OnConfigsExecuted")) != NULL)
dvander@978
   316
	{
dvander@978
   317
		pf->Execute(NULL);
dvander@978
   318
	}
dvander@978
   319
}
dvander@978
   320
dvander@978
   321
void SM_ConfigsExecuted_Plugin(unsigned int serial)
dvander@978
   322
{
dvander@978
   323
	IPluginIterator *iter = g_PluginSys.GetPluginIterator();
dvander@978
   324
	while (iter->MorePlugins())
dvander@978
   325
	{
dvander@978
   326
		CPlugin *plugin = (CPlugin *)(iter->GetPlugin());
dvander@978
   327
		if (plugin->GetSerial() == serial)
dvander@978
   328
		{
dvander@978
   329
			SM_DoSingleExecFwds(plugin->GetBaseContext());
dvander@978
   330
			break;
dvander@978
   331
		}
dvander@978
   332
		iter->NextPlugin();
dvander@978
   333
	}
dvander@978
   334
	iter->Release();
dvander@978
   335
}
dvander@978
   336
dvander@978
   337
void SM_ExecuteForPlugin(IPluginContext *ctx)
dvander@978
   338
{
dvander@978
   339
	CPlugin *plugin = (CPlugin *)g_PluginSys.GetPluginByCtx(ctx->GetContext());
dvander@978
   340
dvander@978
   341
	unsigned int num = plugin->GetConfigCount();
dvander@978
   342
	if (!num)
dvander@978
   343
	{
dvander@978
   344
		SM_DoSingleExecFwds(ctx);
dvander@978
   345
	} else {
dvander@978
   346
		bool can_create = true;
dvander@978
   347
		for (unsigned int i=0; i<num; i++)
dvander@978
   348
		{
dvander@978
   349
			can_create = SM_ExecuteConfig(plugin, plugin->GetConfig(i), can_create);
dvander@978
   350
		}
dvander@978
   351
		char cmd[255];
dvander@978
   352
		UTIL_Format(cmd, sizeof(cmd), "sm internal 2 %d\n", plugin->GetSerial());
dvander@978
   353
		engine->ServerCommand(cmd);
dvander@978
   354
	}
dvander@978
   355
}
dvander@978
   356
dvander@978
   357
void SM_ExecuteAllConfigs()
dvander@978
   358
{
dvander@978
   359
	if (g_bConfigsExecd)
dvander@978
   360
	{
dvander@978
   361
		return;
dvander@978
   362
	}
dvander@978
   363
dvander@978
   364
	engine->ServerCommand("exec cfg/sourcemod/sourcemod.cfg\n");
dvander@978
   365
dvander@978
   366
	IPluginIterator *iter = g_PluginSys.GetPluginIterator();
dvander@978
   367
	while (iter->MorePlugins())
dvander@978
   368
	{
dvander@978
   369
		CPlugin *plugin = (CPlugin *)(iter->GetPlugin());
dvander@978
   370
		unsigned int num = plugin->GetConfigCount();
dvander@978
   371
		bool can_create = true;
dvander@978
   372
		for (unsigned int i=0; i<num; i++)
dvander@978
   373
		{
dvander@978
   374
			can_create = SM_ExecuteConfig(plugin, plugin->GetConfig(i), can_create);
dvander@978
   375
		}
dvander@978
   376
		iter->NextPlugin();
dvander@978
   377
	}
dvander@978
   378
	iter->Release();
dvander@978
   379
dvander@978
   380
	engine->ServerCommand("sm internal 1\n");
dvander@978
   381
}
dvander@978
   382
dvander@978
   383
void SM_ConfigsExecuted_Global()
dvander@978
   384
{
dvander@978
   385
	if (g_bConfigsExecd)
dvander@978
   386
	{
dvander@978
   387
		return;
dvander@978
   388
	}
dvander@978
   389
dvander@978
   390
	g_bConfigsExecd = true;
dvander@978
   391
dvander@978
   392
	g_pOnServerCfg->Execute(NULL);
dvander@978
   393
	g_pOnConfigsExecuted->Execute(NULL);
dvander@978
   394
}