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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/*
Miranda NG: the free IM client for Microsoft* Windows*
Copyright 2012-14 Miranda NG project,
all portions of this codebase are copyrighted to the people
listed in contributors.txt.
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.
*/
#ifndef M_DB_INT_H__
#define M_DB_INT_H__ 1
#ifndef M_CORE_H__
#include <m_core.h>
#endif
///////////////////////////////////////////////////////////////////////////////
// basic database interface
struct DBCachedGlobalValue
{
char *name;
DBVARIANT value;
};
struct DBCachedContactValue
{
char *name;
DBVARIANT value;
DBCachedContactValue *next;
};
struct DBCachedContact
{
MCONTACT contactID;
DWORD dwDriverData;
char *szProto;
DBCachedContactValue *first, *last;
};
interface MIDatabaseCache : public MZeroedObject
{
STDMETHOD_(DBCachedContact*,AddContactToCache)(MCONTACT contactID) PURE;
STDMETHOD_(DBCachedContact*, GetCachedContact)(MCONTACT contactID) PURE;
STDMETHOD_(DBCachedContact*, GetFirstContact)(void) PURE;
STDMETHOD_(DBCachedContact*, GetNextContact)(MCONTACT contactID) PURE;
STDMETHOD_(void, FreeCachedContact)(MCONTACT contactID) PURE;
STDMETHOD_(char*,InsertCachedSetting)(const char *szName, int) PURE;
STDMETHOD_(char*,GetCachedSetting)(const char *szModuleName, const char *szSettingName, int, int) PURE;
STDMETHOD_(void,SetCachedVariant)(DBVARIANT *s, DBVARIANT *d) PURE;
STDMETHOD_(DBVARIANT*,GetCachedValuePtr)(MCONTACT contactID, char *szSetting, int bAllocate) PURE;
};
interface MIDatabase
{
MIDatabaseCache* m_cache;
STDMETHOD_(void,SetCacheSafetyMode)(BOOL) PURE;
STDMETHOD_(LONG,GetContactCount)(void) PURE;
STDMETHOD_(MCONTACT,FindFirstContact)(const char *szProto = NULL) PURE;
STDMETHOD_(MCONTACT, FindNextContact)(MCONTACT contactID, const char *szProto = NULL) PURE;
STDMETHOD_(LONG,DeleteContact)(MCONTACT contactID) PURE;
STDMETHOD_(HANDLE,AddContact)(void) PURE;
STDMETHOD_(BOOL,IsDbContact)(MCONTACT contactID) PURE;
STDMETHOD_(LONG,GetEventCount)(MCONTACT contactID) PURE;
STDMETHOD_(HANDLE,AddEvent)(MCONTACT contactID, DBEVENTINFO *dbe) PURE;
STDMETHOD_(BOOL,DeleteEvent)(MCONTACT contactID, HANDLE hDbEvent) PURE;
STDMETHOD_(LONG,GetBlobSize)(HANDLE hDbEvent) PURE;
STDMETHOD_(BOOL,GetEvent)(HANDLE hDbEvent, DBEVENTINFO *dbe) PURE;
STDMETHOD_(BOOL,MarkEventRead)(MCONTACT contactID, HANDLE hDbEvent) PURE;
STDMETHOD_(HANDLE,GetEventContact)(HANDLE hDbEvent) PURE;
STDMETHOD_(HANDLE,FindFirstEvent)(MCONTACT contactID) PURE;
STDMETHOD_(HANDLE,FindFirstUnreadEvent)(MCONTACT contactID) PURE;
STDMETHOD_(HANDLE,FindLastEvent)(MCONTACT contactID) PURE;
STDMETHOD_(HANDLE,FindNextEvent)(HANDLE hDbEvent) PURE;
STDMETHOD_(HANDLE,FindPrevEvent)(HANDLE hDbEvent) PURE;
STDMETHOD_(BOOL,EnumModuleNames)(DBMODULEENUMPROC pFunc, void *pParam) PURE;
STDMETHOD_(BOOL,GetContactSetting)(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting, DBVARIANT *dbv) PURE;
STDMETHOD_(BOOL,GetContactSettingStr)(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting, DBVARIANT *dbv) PURE;
STDMETHOD_(BOOL,GetContactSettingStatic)(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting, DBVARIANT *dbv) PURE;
STDMETHOD_(BOOL,FreeVariant)(DBVARIANT *dbv) PURE;
STDMETHOD_(BOOL,WriteContactSetting)(MCONTACT contactID, DBCONTACTWRITESETTING *dbcws) PURE;
STDMETHOD_(BOOL,DeleteContactSetting)(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting) PURE;
STDMETHOD_(BOOL,EnumContactSettings)(MCONTACT contactID, DBCONTACTENUMSETTINGS* dbces) PURE;
STDMETHOD_(BOOL,SetSettingResident)(BOOL bIsResident, const char *pszSettingName) PURE;
STDMETHOD_(BOOL,EnumResidentSettings)(DBMODULEENUMPROC pFunc, void *pParam) PURE;
STDMETHOD_(BOOL,IsSettingEncrypted)(LPCSTR szModule, LPCSTR szSetting) PURE;
};
///////////////////////////////////////////////////////////////////////////////
// basic database checker interface
#define STATUS_MESSAGE 0
#define STATUS_WARNING 1
#define STATUS_ERROR 2
#define STATUS_FATAL 3
#define STATUS_SUCCESS 4
struct DBCHeckCallback
{
int cbSize;
DWORD spaceProcessed, spaceUsed;
HANDLE hOutFile;
int bCheckOnly, bBackup, bAggressive, bEraseHistory, bMarkRead, bConvertUtf;
void (*pfnAddLogMessage)(int type, const TCHAR* ptszFormat, ...);
};
interface MIDatabaseChecker
{
STDMETHOD_(BOOL,Start)(DBCHeckCallback *callback) PURE;
STDMETHOD_(BOOL,CheckDb)(int phase, int firstTime) PURE;
STDMETHOD_(VOID,Destroy)() PURE;
};
///////////////////////////////////////////////////////////////////////////////
// Each database plugin should register itself using this structure
/*
Codes for DATABASELINK functions
*/
// grokHeader() error codes
#define EGROKPRF_NOERROR 0
#define EGROKPRF_CANTREAD 1 // can't open the profile for reading
#define EGROKPRF_UNKHEADER 2 // header not supported, not a supported profile
#define EGROKPRF_VERNEWER 3 // header correct, version in profile newer than reader/writer
#define EGROKPRF_DAMAGED 4 // header/version fine, other internal data missing, damaged.
// makeDatabase() error codes
#define EMKPRF_CREATEFAILED 1 // for some reason CreateFile() didnt like something
struct DATABASELINK
{
int cbSize;
char* szShortName; // uniqie short database name
TCHAR* szFullName; // in English, auto-translated by the core
/*
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
Returns: 0 on success, non zero on failure - error contains extended error information, see EMKPRF_*
*/
int (*makeDatabase)(const TCHAR *profile);
/*
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
*/
int (*grokHeader)(const TCHAR *profile);
/*
Affect: Tell the database to create all services/hooks that a 3.xx legacy database might support into link,
which is a PLUGINLINK structure
Returns: 0 on success, nonzero on failure
*/
MIDatabase* (*Load) (const TCHAR *profile);
/*
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.
*/
int (*Unload)(MIDatabase*);
/*
Returns a pointer to the database checker or NULL if a database doesn't support checking
When you don't need this object aanymore, call its Destroy() method
*/
MIDatabaseChecker* (*CheckDB) (const TCHAR *profile, int *error);
};
///////////////////////////////////////////////////////////////////////////////
// Database list's services
// MS_DB_REGISTER_PLUGIN : registers a database plugin
// wParam : 0 (unused)
// lParam : DATABASELINK* = database link description
#define MS_DB_REGISTER_PLUGIN "DB/RegisterPlugin"
__forceinline void RegisterDatabasePlugin(DATABASELINK* pDescr)
{ CallService(MS_DB_REGISTER_PLUGIN, 0, (LPARAM)pDescr);
}
// MS_DB_FIND_PLUGIN : looks for a database plugin suitable to open this file
// wParam : 0 (unused)
// lParam : const TCHAR* = name of the database file
// returns DATABASELINK* of the required plugin or NULL on error
#define MS_DB_FIND_PLUGIN "DB/FindPlugin"
__forceinline DATABASELINK* FindDatabasePlugin(const TCHAR* ptszFileName)
{ return (DATABASELINK*)CallService(MS_DB_FIND_PLUGIN, 0, (LPARAM)ptszFileName);
}
// MS_DB_GET_CURRENT : returns the database pointer for the current profile
// wParam : 0 (unused)
// lParam : 0 (unused)
// returns MIDatabase* of the current profile or NULL on error
#define MS_DB_GET_CURRENT "DB/GetCurrentDb"
__forceinline MIDatabase* GetCurrentDatabase(void)
{ return (MIDatabase*)CallService(MS_DB_GET_CURRENT, 0, 0);
}
// MS_DB_INIT_INSTANCE : initializes a database instance
// wParam : 0 (unused)
// lParam : MIDatabase* = pointer to a database instance
// returns 0
#define MS_DB_INIT_INSTANCE "DB/InitDbInstance"
__forceinline void InitDbInstance(MIDatabase* pDatabase)
{ CallService(MS_DB_INIT_INSTANCE, 0, (LPARAM)pDatabase);
}
// MS_DB_DESTROY_INSTANCE : destroys a database instance
// wParam : 0 (unused)
// lParam : MIDatabase* = pointer to a database instance
// returns 0
#define MS_DB_DESTROY_INSTANCE "DB/DestroyDbInstance"
__forceinline void DestroyDbInstance(MIDatabase* pDatabase)
{ CallService(MS_DB_DESTROY_INSTANCE, 0, (LPARAM)pDatabase);
}
#endif // M_DB_INT_H__
|
