3 * =============================================================================
4 * SourceMod Client Preferences Extension
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>.
32 #include <sourcemod_version.h>
33 #include "extension.h"
37 * @brief Implement extension code here.
40 ClientPrefs g_ClientPrefs; /**< Global singleton for extension's main interface */
42 SMEXT_LINK(&g_ClientPrefs);
44 HandleType_t g_CookieType = 0;
45 CookieTypeHandler g_CookieTypeHandler;
47 HandleType_t g_CookieIterator = 0;
48 CookieIteratorHandler g_CookieIteratorHandler;
49 DbDriver g_DriverType;
50 static const DatabaseInfo *storage_local = NULL;
52 bool ClientPrefs::SDK_OnLoad(char *error, size_t maxlength, bool late)
54 queryMutex = threader->MakeMutex();
55 cookieMutex = threader->MakeMutex();
57 DBInfo = dbi->FindDatabaseConf("clientprefs");
61 DBInfo = dbi->FindDatabaseConf("default");
64 (strcmp(DBInfo->host, "localhost") == 0 &&
65 strcmp(DBInfo->database, "sourcemod") == 0 &&
66 strcmp(DBInfo->user, "root") == 0 &&
67 strcmp(DBInfo->pass, "") == 0 &&
68 strcmp(DBInfo->driver, "") == 0))
70 storage_local = dbi->FindDatabaseConf("storage-local");
73 DBInfo = storage_local;
79 snprintf(error, maxlength, "Could not find \"clientprefs\" or \"default\" database configs");
84 if (DBInfo->driver[0] != '\0')
86 Driver = dbi->FindOrLoadDriver(DBInfo->driver);
90 Driver = dbi->GetDefaultDriver();
95 snprintf(error, maxlength, "Could not load DB Driver \"%s\"", DBInfo->driver);
100 databaseLoading = true;
101 TQueryOp *op = new TQueryOp(Query_Connect, 0);
102 dbi->AddToThreadQueue(op, PrioQueue_High);
104 dbi->AddDependency(myself, Driver);
106 sharesys->AddNatives(myself, g_ClientPrefNatives);
107 sharesys->RegisterLibrary(myself, "clientprefs");
108 identity = sharesys->CreateIdentity(sharesys->CreateIdentType("ClientPrefs"), this);
109 g_CookieManager.cookieDataLoadedForward = forwards->CreateForward("OnClientCookiesCached", ET_Ignore, 1, NULL, Param_Cell);
111 g_CookieType = handlesys->CreateType("Cookie",
112 &g_CookieTypeHandler,
116 myself->GetIdentity(),
119 g_CookieIterator = handlesys->CreateType("CookieIterator",
120 &g_CookieIteratorHandler,
124 myself->GetIdentity(),
127 IMenuStyle *style = menus->GetDefaultStyle();
128 g_CookieManager.clientMenu = style->CreateMenu(&g_Handler, identity);
129 g_CookieManager.clientMenu->SetDefaultTitle("Client Settings:");
131 plsys->AddPluginsListener(&g_CookieManager);
133 phrases = translator->CreatePhraseCollection();
134 phrases->AddPhraseFile("clientprefs.phrases");
135 phrases->AddPhraseFile("common.phrases");
139 int maxclients = playerhelpers->GetMaxClients();
141 for (int i = 1; i <= maxclients; i++)
143 IGamePlayer *pPlayer = playerhelpers->GetGamePlayer(i);
145 if (!pPlayer || !pPlayer->IsAuthorized())
150 g_CookieManager.OnClientAuthorized(i, pPlayer->GetAuthString());
157 void ClientPrefs::SDK_OnAllLoaded()
159 playerhelpers->AddClientListener(&g_CookieManager);
162 bool ClientPrefs::QueryInterfaceDrop(SMInterface *pInterface)
164 if ((void *)pInterface == (void *)(Database->GetDriver()))
172 void ClientPrefs::NotifyInterfaceDrop(SMInterface *pInterface)
174 if (Database != NULL && (void *)pInterface == (void *)(Database->GetDriver()))
181 void ClientPrefs::SDK_OnUnload()
183 handlesys->RemoveType(g_CookieType, myself->GetIdentity());
184 handlesys->RemoveType(g_CookieIterator, myself->GetIdentity());
186 g_CookieManager.Unload();
188 if (Database != NULL)
193 forwards->ReleaseForward(g_CookieManager.cookieDataLoadedForward);
195 HandleSecurity sec = HandleSecurity(identity, identity);
196 HandleError err = handlesys->FreeHandle(g_CookieManager.clientMenu->GetHandle(), &sec);
197 if (HandleError_None != err)
199 g_pSM->LogError(myself, "Error %d when attempting to free client menu handle", err);
204 sharesys->DestroyIdentity( identity );
206 plsys->RemovePluginsListener(&g_CookieManager);
207 playerhelpers->RemoveClientListener(&g_CookieManager);
209 queryMutex->DestroyThis();
210 cookieMutex->DestroyThis();
213 void ClientPrefs::OnCoreMapStart(edict_t *pEdictList, int edictCount, int clientMax)
215 if (Database == NULL && !databaseLoading)
217 g_pSM->LogMessage(myself, "Attempting to reconnect to database...");
219 databaseLoading = true;
221 TQueryOp *op = new TQueryOp(Query_Connect, 0);
222 dbi->AddToThreadQueue(op, PrioQueue_High);
226 void ClientPrefs::DatabaseConnect()
231 Database = Driver->Connect(DBInfo, true, error, sizeof(error));
233 if (Database == NULL &&
234 DBInfo != storage_local &&
235 storage_local != NULL)
237 DBInfo = storage_local;
238 Database = Driver->Connect(DBInfo, true, error, sizeof(error));
241 if (Database == NULL)
243 g_pSM->LogError(myself, error);
244 databaseLoading = false;
249 const char *identifier = Driver->GetIdentifier();
251 if (strcmp(identifier, "sqlite") == 0)
253 g_DriverType = Driver_SQLite;
255 if (!Database->DoSimpleQuery(
256 "CREATE TABLE IF NOT EXISTS sm_cookies \
258 id INTEGER PRIMARY KEY AUTOINCREMENT, \
259 name varchar(30) NOT NULL UNIQUE, \
260 description varchar(255), \
264 g_pSM->LogMessage(myself, "Failed to CreateTable sm_cookies: %s", Database->GetError());
268 if (!Database->DoSimpleQuery(
269 "CREATE TABLE IF NOT EXISTS sm_cookie_cache \
271 player varchar(65) NOT NULL, \
272 cookie_id int(10) NOT NULL, \
273 value varchar(100), \
275 PRIMARY KEY (player, cookie_id) \
278 g_pSM->LogMessage(myself, "Failed to CreateTable sm_cookie_cache: %s", Database->GetError());
282 else if (strcmp(identifier, "mysql") == 0)
284 g_DriverType = Driver_MySQL;
286 if (!Database->DoSimpleQuery(
287 "CREATE TABLE IF NOT EXISTS sm_cookies \
289 id INTEGER unsigned NOT NULL auto_increment, \
290 name varchar(30) NOT NULL UNIQUE, \
291 description varchar(255), \
296 g_pSM->LogMessage(myself, "Failed to CreateTable sm_cookies: %s", Database->GetError());
300 if (!Database->DoSimpleQuery(
301 "CREATE TABLE IF NOT EXISTS sm_cookie_cache \
303 player varchar(65) NOT NULL, \
304 cookie_id int(10) NOT NULL, \
305 value varchar(100), \
306 timestamp int NOT NULL, \
307 PRIMARY KEY (player, cookie_id) \
310 g_pSM->LogMessage(myself, "Failed to CreateTable sm_cookie_cache: %s", Database->GetError());
316 g_pSM->LogError(myself, "Unsupported driver \"%s\"", identifier);
320 databaseLoading = false;
329 databaseLoading = false;
333 bool ClientPrefs::AddQueryToQueue( TQueryOp *query )
337 if (Database == NULL && databaseLoading)
339 cachedQueries.push_back(query);
340 queryMutex->Unlock();
344 queryMutex->Unlock();
348 query->SetDatabase(Database);
349 dbi->AddToThreadQueue(query, PrioQueue_Normal);
355 /* If Database is NULL and we're not in the loading phase it must have failed - Can't do much */
359 void ClientPrefs::ProcessQueryCache()
361 SourceHook::List<TQueryOp *>::iterator iter;
365 iter = cachedQueries.begin();
367 while (iter != cachedQueries.end())
369 TQueryOp *op = *iter;
371 if (Database != NULL)
373 op->SetDatabase(Database);
374 dbi->AddToThreadQueue(op, PrioQueue_Normal);
384 cachedQueries.clear();
386 queryMutex->Unlock();
389 size_t IsAuthIdConnected(char *authID)
392 int maxPlayers = playerhelpers->GetMaxClients();
394 for (int playerIndex = 1; playerIndex <= maxPlayers; playerIndex++)
396 player = playerhelpers->GetGamePlayer(playerIndex);
397 if (!player || !player->IsConnected())
401 const char *authString = player->GetAuthString();
402 if (!authString || authString[0] == '\0')
407 if (strcmp(authString, authID) == 0)
415 size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...)
419 size_t len = vsnprintf(buffer, maxlength, fmt, ap);
422 if (len >= maxlength)
424 buffer[maxlength - 1] = '\0';
425 return (maxlength - 1);
433 bool Translate(char *buffer,
436 unsigned int numparams,
442 const char *fail_phrase;
443 void *params[MAX_TRANSLATE_PARAMS];
445 if (numparams > MAX_TRANSLATE_PARAMS)
451 va_start(ap, pOutLength);
452 for (i = 0; i < numparams; i++)
454 params[i] = va_arg(ap, void *);
458 if (!g_ClientPrefs.phrases->FormatString(buffer,
466 if (fail_phrase != NULL)
468 g_pSM->LogError(myself, "[SM] Could not find core phrase: %s", fail_phrase);
472 g_pSM->LogError(myself, "[SM] Unknown fatal error while translating a core phrase.");
481 IdentityToken_t *ClientPrefs::GetIdentity() const
486 const char *ClientPrefs::GetExtensionVerString()
488 return SM_FULL_VERSION;
491 const char *ClientPrefs::GetExtensionDateString()
493 return SM_BUILD_TIMESTAMP;