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