core/Database.h
author David Anderson <dvander@alliedmods.net>
Thu Aug 08 22:02:42 2013 -0700 (2013-08-08)
changeset 3980 dc7dfcd855dc
parent 3872 4c93f74cae51
child 4027 d2c15108b468
permissions -rw-r--r--
More Windows build fix.
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2008 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 #ifndef _INCLUDE_DATABASE_MANAGER_H_
    33 #define _INCLUDE_DATABASE_MANAGER_H_
    34 
    35 #include <IDBDriver.h>
    36 #include "sm_globals.h"
    37 #include <sh_vector.h>
    38 #include <sh_string.h>
    39 #include <sh_list.h>
    40 #include <ITextParsers.h>
    41 #include "sm_memtable.h"
    42 #include <IThreader.h>
    43 #include <IPluginSys.h>
    44 #include "sm_simple_prioqueue.h"
    45 
    46 using namespace SourceHook;
    47 
    48 struct ConfDbInfo
    49 {
    50 	ConfDbInfo() : realDriver(NULL)
    51 	{
    52 	}
    53 	String name;
    54 	String driver;
    55 	String host;
    56 	String user;
    57 	String pass;
    58 	String database;
    59 	IDBDriver *realDriver;
    60 	DatabaseInfo info;
    61 };
    62 
    63 class DBManager : 
    64 	public IDBManager,
    65 	public SMGlobalClass,
    66 	public IHandleTypeDispatch,
    67 	public ITextListener_SMC,
    68 	public IThread,
    69 	public IThreadWorkerCallbacks,
    70 	public IPluginsListener
    71 {
    72 public:
    73 	DBManager();
    74 public:
    75 	const char *GetInterfaceName();
    76 	unsigned int GetInterfaceVersion();
    77 public: //SMGlobalClass
    78 	void OnSourceModAllInitialized();
    79 	void OnSourceModLevelChange(const char *mapName);
    80 	void OnSourceModIdentityDropped(IdentityToken_t *pToken);
    81 	void OnSourceModShutdown();
    82 public: //IHandleTypeDispatch
    83 	void OnHandleDestroy(HandleType_t type, void *object);
    84 public: //IDBManager
    85 	void AddDriver(IDBDriver *pDrivera);
    86 	void RemoveDriver(IDBDriver *pDriver);
    87 	const DatabaseInfo *FindDatabaseConf(const char *name);
    88 	bool Connect(const char *name, IDBDriver **pdr, IDatabase **pdb, bool persistent, char *error, size_t maxlength);
    89 	unsigned int GetDriverCount();
    90 	IDBDriver *GetDriver(unsigned int index);
    91 	Handle_t CreateHandle(DBHandleType type, void *ptr, IdentityToken_t *pToken);
    92 	HandleError ReadHandle(Handle_t hndl, DBHandleType type, void **ptr);
    93 	HandleError ReleaseHandle(Handle_t hndl, DBHandleType type, IdentityToken_t *token);
    94 	void AddDependency(IExtension *myself, IDBDriver *driver);
    95 public: //ITextListener_SMC
    96 	void ReadSMC_ParseStart();
    97 	SMCResult ReadSMC_NewSection(const SMCStates *states, const char *name);
    98 	SMCResult ReadSMC_KeyValue(const SMCStates *states, const char *key, const char *value);
    99 	SMCResult ReadSMC_LeavingSection(const SMCStates *states);
   100 	void ReadSMC_ParseEnd(bool halted, bool failed);
   101 public: //IThread
   102 	void RunThread(IThreadHandle *pThread);
   103 	void OnTerminate(IThreadHandle *pThread, bool cancel);
   104 public: //IThreadWorkerCallbacks
   105 	void OnWorkerStart(IThreadWorker *pWorker);
   106 	void OnWorkerStop(IThreadWorker *pWorker);
   107 public: //IPluginsListener
   108 	void OnPluginUnloaded(IPlugin *plugin);
   109 public:
   110 	ConfDbInfo *GetDatabaseConf(const char *name);
   111 	IDBDriver *FindOrLoadDriver(const char *name);
   112 	IDBDriver *GetDefaultDriver();
   113 	const char *GetDefaultDriverName();
   114 	bool AddToThreadQueue(IDBThreadOperation *op, PrioQueueLevel prio);
   115 	void LockConfig();
   116 	void UnlockConfig();
   117 	void RunFrame();
   118 	inline HandleType_t GetDatabaseType()
   119 	{
   120 		return m_DatabaseType;
   121 	}
   122 private:
   123 	void ClearConfigs();
   124 	void KillWorkerThread();
   125 private:
   126 	CVector<IDBDriver *> m_drivers;
   127 
   128 	/* Threading stuff */
   129 	PrioQueue<IDBThreadOperation *> m_OpQueue;
   130 	Queue<IDBThreadOperation *> m_ThinkQueue;
   131 	CVector<bool> m_drSafety;			/* which drivers are safe? */
   132 	IThreadWorker *m_pWorker;			/* Worker thread object */
   133 	IMutex *m_pConfigLock;				/* Configuration lock */
   134 	IMutex *m_pQueueLock;				/* Queue safety lock */
   135 	IMutex *m_pThinkLock;				/* Think-queue lock */
   136 
   137 	List<ConfDbInfo *> m_confs;
   138 	HandleType_t m_DriverType;
   139 	HandleType_t m_DatabaseType;
   140 	String m_DefDriver;
   141 	char m_Filename[PLATFORM_MAX_PATH];
   142 	unsigned int m_ParseLevel;
   143 	unsigned int m_ParseState;
   144 	IDBDriver *m_pDefault;
   145 };
   146 
   147 extern DBManager g_DBMan;
   148 
   149 #endif //_INCLUDE_DATABASE_MANAGER_H_