extensions/sqlite/driver/SqDriver.cpp
author David Anderson <dvander@alliedmods.net>
Wed Aug 01 01:54:53 2007 +0000 (2007-08-01)
changeset 1226 478550a4d5ec
parent 1203 633c25ce6405
child 1330 ab94316bb52b
permissions -rw-r--r--
updated license headers for most extensions
updated sdk bases for most extensions
dvander@1203
     1
/**
dvander@1203
     2
 * vim: set ts=4 :
dvander@1226
     3
 * ================================================================
dvander@1226
     4
 * SourceMod SQLite Extension
dvander@1226
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1226
     6
 * ================================================================
dvander@1203
     7
 *
dvander@1226
     8
 * This program is free software; you can redistribute it and/or 
dvander@1226
     9
 * modify it under the terms of the GNU General Public License, 
dvander@1226
    10
 * version 3.0, as published by the Free Software Foundation.
dvander@1226
    11
 * 
dvander@1203
    12
 * This program is distributed in the hope that it will be useful,
dvander@1203
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1203
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1203
    15
 * GNU General Public License for more details.
dvander@1226
    16
 *
dvander@1203
    17
 * You should have received a copy of the GNU General Public License
dvander@1226
    18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1226
    19
 *
dvander@1226
    20
 * As a special exception, AlliedModders LLC gives you permission to 
dvander@1226
    21
 * link the code of this program (as well as its derivative works) to 
dvander@1226
    22
 * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1226
    23
 * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1226
    24
 * obey the GNU General Public License in all respects for all other 
dvander@1226
    25
 * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1226
    26
 * to all derivative works. AlliedModders LLC defines further 
dvander@1226
    27
 * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1226
    28
 * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
dvander@1203
    29
 *
dvander@1203
    30
 * Version: $Id$
dvander@1203
    31
 */
dvander@1203
    32
dvander@1203
    33
#include <sm_platform.h>
dvander@1203
    34
#include "extension.h"
dvander@1203
    35
#include "SqDriver.h"
dvander@1203
    36
#include "SqDatabase.h"
dvander@1203
    37
dvander@1203
    38
SqDriver g_SqDriver;
dvander@1203
    39
dvander@1203
    40
unsigned int strncopy(char *dest, const char *src, size_t count)
dvander@1203
    41
{
dvander@1203
    42
	if (!count)
dvander@1203
    43
	{
dvander@1203
    44
		return 0;
dvander@1203
    45
	}
dvander@1203
    46
dvander@1203
    47
	char *start = dest;
dvander@1203
    48
	while ((*src) && (--count))
dvander@1203
    49
	{
dvander@1203
    50
		*dest++ = *src++;
dvander@1203
    51
	}
dvander@1203
    52
	*dest = '\0';
dvander@1203
    53
dvander@1203
    54
	return (dest - start);
dvander@1203
    55
}
dvander@1203
    56
dvander@1203
    57
SqDriver::SqDriver()
dvander@1203
    58
{
dvander@1203
    59
	m_Handle = BAD_HANDLE;
dvander@1203
    60
	m_pOpenLock = NULL;
dvander@1203
    61
}
dvander@1203
    62
dvander@1203
    63
void SqDriver::Initialize()
dvander@1203
    64
{
dvander@1203
    65
	m_pOpenLock = threader->MakeMutex();
dvander@1203
    66
}
dvander@1203
    67
dvander@1203
    68
void SqDriver::Shutdown()
dvander@1203
    69
{
dvander@1203
    70
	if (m_pOpenLock)
dvander@1203
    71
	{
dvander@1203
    72
		m_pOpenLock->DestroyThis();
dvander@1203
    73
	}
dvander@1203
    74
}
dvander@1203
    75
dvander@1203
    76
bool SqDriver::IsThreadSafe()
dvander@1203
    77
{
dvander@1203
    78
	return true;
dvander@1203
    79
}
dvander@1203
    80
dvander@1203
    81
bool SqDriver::InitializeThreadSafety()
dvander@1203
    82
{
dvander@1203
    83
	/* sqlite should be thread safe if the locks are done right.
dvander@1203
    84
	 * we don't enable the "shared cache" because it can corrupt
dvander@1203
    85
	 * open databases!
dvander@1203
    86
	 */
dvander@1203
    87
	return true;
dvander@1203
    88
}
dvander@1203
    89
dvander@1203
    90
void SqDriver::ShutdownThreadSafety()
dvander@1203
    91
{
dvander@1203
    92
	return;
dvander@1203
    93
}
dvander@1203
    94
dvander@1203
    95
IdentityToken_t *SqDriver::GetIdentity()
dvander@1203
    96
{
dvander@1203
    97
	return myself->GetIdentity();
dvander@1203
    98
}
dvander@1203
    99
dvander@1203
   100
const char *SqDriver::GetProductName()
dvander@1203
   101
{
dvander@1203
   102
	return "SQLite";
dvander@1203
   103
}
dvander@1203
   104
dvander@1203
   105
const char *SqDriver::GetIdentifier()
dvander@1203
   106
{
dvander@1203
   107
	return "sqlite";
dvander@1203
   108
}
dvander@1203
   109
dvander@1203
   110
Handle_t SqDriver::GetHandle()
dvander@1203
   111
{
dvander@1203
   112
	if (m_Handle == BAD_HANDLE)
dvander@1203
   113
	{
dvander@1203
   114
		m_Handle = dbi->CreateHandle(DBHandle_Driver, this, myself->GetIdentity());
dvander@1203
   115
	}
dvander@1203
   116
dvander@1203
   117
	return m_Handle;
dvander@1203
   118
}
dvander@1203
   119
dvander@1203
   120
inline bool IsPathSepChar(char c)
dvander@1203
   121
{
dvander@1203
   122
#if defined PLATFORM_WINDOWS
dvander@1203
   123
	return (c == '\\' || c == '/');
dvander@1203
   124
#elif defined PLATFORM_LINUX
dvander@1203
   125
	return (c == '/');
dvander@1203
   126
#endif
dvander@1203
   127
}
dvander@1203
   128
dvander@1203
   129
IDatabase *SqDriver::Connect(const DatabaseInfo *info, bool persistent, char *error, size_t maxlength)
dvander@1203
   130
{
dvander@1203
   131
	/* We wrap most of the open process in a mutex just to be safe */
dvander@1203
   132
	m_pOpenLock->Lock();
dvander@1203
   133
dvander@1203
   134
	/* Format our path */
dvander@1203
   135
	char path[PLATFORM_MAX_PATH];
dvander@1203
   136
	size_t len = libsys->PathFormat(path, sizeof(path), "sqlite/%s", info->database);
dvander@1203
   137
dvander@1203
   138
	/* Chop any filename off */
dvander@1203
   139
	for (size_t i = len-1;
dvander@1203
   140
		 i >= 0 && i <= len-1;
dvander@1203
   141
		 i--)
dvander@1203
   142
	{
dvander@1203
   143
		if (IsPathSepChar(path[i]))
dvander@1203
   144
		{
dvander@1203
   145
			path[i] = '\0';
dvander@1203
   146
			break;
dvander@1203
   147
		}
dvander@1203
   148
	}
dvander@1203
   149
dvander@1203
   150
	/* Test the full path */
dvander@1203
   151
	char fullpath[PLATFORM_MAX_PATH];
dvander@1203
   152
	g_pSM->BuildPath(Path_SM, fullpath, sizeof(fullpath), "data/%s", path);
dvander@1203
   153
	if (!libsys->IsPathDirectory(fullpath))
dvander@1203
   154
	{
dvander@1203
   155
		/* Make sure the data folder exists */
dvander@1203
   156
		len = g_pSM->BuildPath(Path_SM, fullpath, sizeof(fullpath), "data");
dvander@1203
   157
		if (!libsys->IsPathDirectory(fullpath))
dvander@1203
   158
		{
dvander@1203
   159
			if (!libsys->CreateFolder(fullpath))
dvander@1203
   160
			{
dvander@1203
   161
				strncopy(error, "Could not create or open \"data\" folder\"", maxlength);
dvander@1203
   162
				m_pOpenLock->Unlock();
dvander@1203
   163
				return NULL;
dvander@1203
   164
			}
dvander@1203
   165
		}
dvander@1203
   166
dvander@1203
   167
		/* The data folder exists - create each subdir as needed! */
dvander@1203
   168
		char *cur_ptr = path;
dvander@1203
   169
dvander@1203
   170
		do
dvander@1203
   171
		{
dvander@1203
   172
			/* Find the next suitable path */
dvander@1203
   173
			char *next_ptr = cur_ptr;
dvander@1203
   174
			while (*next_ptr != '\0')
dvander@1203
   175
			{
dvander@1203
   176
				if (IsPathSepChar(*next_ptr))
dvander@1203
   177
				{
dvander@1203
   178
					*next_ptr = '\0';
dvander@1203
   179
					next_ptr++;
dvander@1203
   180
					break;
dvander@1203
   181
				}
dvander@1203
   182
				next_ptr++;
dvander@1203
   183
			}
dvander@1203
   184
			if (*next_ptr == '\0')
dvander@1203
   185
			{
dvander@1203
   186
				next_ptr = NULL;
dvander@1203
   187
			}
dvander@1203
   188
			len += libsys->PathFormat(&fullpath[len], sizeof(fullpath)-len, "/%s", cur_ptr);
dvander@1203
   189
			if (!libsys->IsPathDirectory(fullpath) && !libsys->CreateFolder(fullpath))
dvander@1203
   190
			{
dvander@1203
   191
				break;
dvander@1203
   192
			}
dvander@1203
   193
			cur_ptr = next_ptr;
dvander@1203
   194
		} while (cur_ptr);
dvander@1203
   195
	}
dvander@1203
   196
dvander@1203
   197
	/* Build the FINAL path. */
dvander@1203
   198
	g_pSM->BuildPath(Path_SM, fullpath, sizeof(fullpath), "data/sqlite/%s.sq3", info->database);
dvander@1203
   199
dvander@1203
   200
	/* If we're requesting a persistent connection, see if something is already open */
dvander@1203
   201
	if (persistent)
dvander@1203
   202
	{
dvander@1203
   203
		/* See if anything in the cache matches */
dvander@1203
   204
		List<SqDbInfo>::iterator iter;
dvander@1203
   205
		for (iter = m_Cache.begin(); iter != m_Cache.end(); iter++)
dvander@1203
   206
		{
dvander@1203
   207
			if ((*iter).path.compare(fullpath) == 0)
dvander@1203
   208
			{
dvander@1203
   209
				(*iter).db->IncReferenceCount();
dvander@1203
   210
				m_pOpenLock->Unlock();
dvander@1203
   211
				return (*iter).db;
dvander@1203
   212
			}
dvander@1203
   213
		}
dvander@1203
   214
	}
dvander@1203
   215
dvander@1203
   216
	/* Try to open a new connection */
dvander@1203
   217
	sqlite3 *sql;
dvander@1203
   218
	int err = sqlite3_open(fullpath, &sql);
dvander@1203
   219
	if (err != SQLITE_OK)
dvander@1203
   220
	{
dvander@1203
   221
		strncopy(error, sqlite3_errmsg(sql), maxlength);
dvander@1203
   222
		sqlite3_close(sql);
dvander@1203
   223
		m_pOpenLock->Unlock();
dvander@1203
   224
		return NULL;
dvander@1203
   225
	}
dvander@1203
   226
dvander@1203
   227
	SqDatabase *pdb = new SqDatabase(sql, persistent);
dvander@1203
   228
dvander@1203
   229
	if (persistent)
dvander@1203
   230
	{
dvander@1203
   231
		SqDbInfo pinfo;
dvander@1203
   232
		pinfo.path = fullpath;
dvander@1203
   233
		pinfo.db = pdb;
dvander@1203
   234
		m_Cache.push_back(pinfo);
dvander@1203
   235
	}
dvander@1203
   236
dvander@1203
   237
	m_pOpenLock->Unlock();
dvander@1203
   238
dvander@1203
   239
	return pdb;
dvander@1203
   240
}
dvander@1203
   241
dvander@1203
   242
void SqDriver::RemovePersistent(IDatabase *pdb)
dvander@1203
   243
{
dvander@1203
   244
	List<SqDbInfo>::iterator iter;
dvander@1203
   245
	for (iter = m_Cache.begin(); iter != m_Cache.end(); iter++)
dvander@1203
   246
	{
dvander@1203
   247
		if ((*iter).db == pdb)
dvander@1203
   248
		{
dvander@1203
   249
			iter = m_Cache.erase(iter);
dvander@1203
   250
			return;
dvander@1203
   251
		}
dvander@1203
   252
	}
dvander@1203
   253
}