summaryrefslogtreecommitdiff
path: root/plugins/Dbx_tree/DatabaseLink.cpp
blob: ec71cdeca1fc414e38537c385a2b6065f3098053 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*

dbx_tree: tree database driver for Miranda IM

Copyright 2007-2010 Michael "Protogenes" Kunz,

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#include "DatabaseLink.h"
#ifndef _MSC_VER
#include "savestrings_gcc.h"
#endif


/*
	profile: pointer to a string which contains full path + name
	Affect: The database plugin should create the profile, the filepath will not exist at
		the time of this call, profile will be C:\..\<name>.dat
	Note: Do not prompt the user in anyway about this operation.
	Note: Do not initialise internal data structures at this point!
	Returns: 0 on success, non zero on failure - error contains extended error information, see EMKPRF_*
*/
static int makeDatabase(const TCHAR *profile, int* error)
{
	if (gDataBase) delete gDataBase;
	gDataBase = new CDataBase(profile);

	*error = gDataBase->CreateDB();
	return *error;
}

/*
	profile: [in] a null terminated string to file path of selected profile
	error: [in/out] pointer to an int to set with error if any
	Affect: Ask the database plugin if it supports the given profile, if it does it will
		return 0, if it doesnt return 1, with the error set in error -- EGROKPRF_* can be valid error
		condition, most common error would be [EGROKPRF_UNKHEADER]
	Note: Just because 1 is returned, doesnt mean the profile is not supported, the profile might be damaged
		etc.
	Returns: 0 on success, non zero on failure
*/
static int grokHeader(const TCHAR *profile, int* error)
{
	if (gDataBase) delete gDataBase;
	gDataBase = new CDataBase(profile);

	*error = gDataBase->CheckDB();
	return *error;
}

/*
Affect: Tell the database to create all services/hooks that a 3.xx legecy database might support into link,
	which is a PLUGINLINK structure
Returns: 0 on success, nonzero on failure
*/

static MIDatabase* LoadDatabase(const TCHAR *profile)
{
	if (gDataBase) delete gDataBase;
	gDataBase = new CDataBase(profile);

	gDataBase->OpenDB();
	return gDataBase;
}

/*
Affect: The database plugin should shutdown, unloading things from the core and freeing internal structures
Returns: 0 on success, nonzero on failure
Note: Unload() might be called even if Load(void) was never called, wasLoaded is set to 1 if Load(void) was ever called.
*/
static int UnloadDatabase(MIDatabase* db)
{
	if (gDataBase)
		delete gDataBase;

	gDataBase = NULL;
	return 0;
}

DATABASELINK gDBLink = {
	sizeof(DATABASELINK),
	gInternalName,
	_T(gInternalNameLong),
	makeDatabase,
	grokHeader,
	LoadDatabase,
	UnloadDatabase,
	NULL  // does not support file checking
};