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
|
/*
Miranda NG: the free IM client for Microsoft* Windows*
Copyright (c) 2012-18 Miranda NG team (https://miranda-ng.org)
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 DBCachedContactBase
{
MCONTACT contactID;
char *szProto;
DBCachedContactValue *first, *last;
// metacontacts
int nSubs; // == -1 -> not a metacontact
MCONTACT *pSubs;
MCONTACT parentID; // == 0 -> not a subcontact
int nDefault; // default sub number
__forceinline bool IsMeta() const { return nSubs != -1; }
__forceinline bool IsSub() const { return parentID != 0; }
};
#ifndef OWN_CACHED_CONTACT
struct DBCachedContact : public DBCachedContactBase {};
#else
struct DBCachedContact;
#endif
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, size_t) PURE;
STDMETHOD_(char*, GetCachedSetting)(const char *szModuleName, const char *szSettingName, size_t, size_t) PURE;
STDMETHOD_(void, SetCachedVariant)(DBVARIANT *s, DBVARIANT *d) PURE;
STDMETHOD_(DBVARIANT*, GetCachedValuePtr)(MCONTACT contactID, char *szSetting, int bAllocate) PURE;
};
interface MIR_APP_EXPORT MIDatabase
{
STDMETHOD_(BOOL, IsRelational)(void) PURE;
STDMETHOD_(void, SetCacheSafetyMode)(BOOL) PURE;
STDMETHOD_(LONG, GetContactCount)(void) PURE;
STDMETHOD_(MCONTACT, FindFirstContact)(const char *szProto = nullptr) PURE;
STDMETHOD_(MCONTACT, FindNextContact)(MCONTACT contactID, const char *szProto = nullptr) PURE;
STDMETHOD_(LONG, DeleteContact)(MCONTACT contactID) PURE;
STDMETHOD_(MCONTACT, AddContact)(void) PURE;
STDMETHOD_(BOOL, IsDbContact)(MCONTACT contactID) PURE;
STDMETHOD_(LONG, GetContactSize)(void) PURE;
STDMETHOD_(LONG, GetEventCount)(MCONTACT contactID) PURE;
STDMETHOD_(MEVENT, AddEvent)(MCONTACT contactID, DBEVENTINFO *dbe) PURE;
STDMETHOD_(BOOL, DeleteEvent)(MCONTACT contactID, MEVENT hDbEvent) PURE;
STDMETHOD_(LONG, GetBlobSize)(MEVENT hDbEvent) PURE;
STDMETHOD_(BOOL, GetEvent)(MEVENT hDbEvent, DBEVENTINFO *dbe) PURE;
STDMETHOD_(BOOL, MarkEventRead)(MCONTACT contactID, MEVENT hDbEvent) PURE;
STDMETHOD_(MCONTACT, GetEventContact)(MEVENT hDbEvent) PURE;
STDMETHOD_(MEVENT, FindFirstEvent)(MCONTACT contactID) PURE;
STDMETHOD_(MEVENT, FindFirstUnreadEvent)(MCONTACT contactID) PURE;
STDMETHOD_(MEVENT, FindLastEvent)(MCONTACT contactID) PURE;
STDMETHOD_(MEVENT, FindNextEvent)(MCONTACT contactID, MEVENT hDbEvent) PURE;
STDMETHOD_(MEVENT, FindPrevEvent)(MCONTACT contactID, MEVENT hDbEvent) PURE;
STDMETHOD_(BOOL, DeleteModule)(MCONTACT contactID, LPCSTR szModule) 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, DBSETTINGENUMPROC pfnEnumProc, const char *szModule, void *param) 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;
STDMETHOD_(BOOL, MetaDetouchSub)(DBCachedContact*, int nSub) PURE;
STDMETHOD_(BOOL, MetaSetDefault)(DBCachedContact*) PURE;
STDMETHOD_(BOOL, MetaMergeHistory)(DBCachedContact *ccMeta, DBCachedContact *ccSub) PURE;
STDMETHOD_(BOOL, MetaSplitHistory)(DBCachedContact *ccMeta, DBCachedContact *ccSub) PURE;
STDMETHOD_(BOOL, Compact)(void) PURE;
};
/////////////////////////////////////////////////////////////////////////////////////////
class MIR_APP_EXPORT MDatabaseCommon : public MIDatabase
{
protected:
int m_codePage;
mir_cs m_csDbAccess;
LIST<char> m_lResidentSettings;
MIDatabaseCache* m_cache;
protected:
int CheckProto(DBCachedContact *cc, const char *proto);
STDMETHOD_(BOOL, GetContactSettingWorker)(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting, DBVARIANT *dbv, int isStatic) PURE;
public:
MDatabaseCommon();
virtual ~MDatabaseCommon();
__forceinline MIDatabaseCache* getCache() const { return m_cache; }
STDMETHODIMP_(BOOL) DeleteModule(MCONTACT contactID, LPCSTR szModule);
STDMETHODIMP_(MCONTACT) FindFirstContact(const char *szProto = nullptr);
STDMETHODIMP_(MCONTACT) FindNextContact(MCONTACT contactID, const char *szProto = nullptr);
STDMETHODIMP_(BOOL) MetaDetouchSub(DBCachedContact *cc, int nSub);
STDMETHODIMP_(BOOL) MetaSetDefault(DBCachedContact *cc);
STDMETHODIMP_(BOOL) IsSettingEncrypted(LPCSTR szModule, LPCSTR szSetting);
STDMETHODIMP_(BOOL) GetContactSetting(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting, DBVARIANT *dbv);
STDMETHODIMP_(BOOL) GetContactSettingStr(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting, DBVARIANT *dbv);
STDMETHODIMP_(BOOL) GetContactSettingStatic(MCONTACT contactID, LPCSTR szModule, LPCSTR szSetting, DBVARIANT *dbv);
STDMETHODIMP_(BOOL) FreeVariant(DBVARIANT *dbv);
STDMETHODIMP_(BOOL) EnumResidentSettings(DBMODULEENUMPROC pFunc, void *pParam);
STDMETHODIMP_(BOOL) SetSettingResident(BOOL bIsResident, const char *pszSettingName);
STDMETHODIMP_(BOOL) Compact(void);
};
///////////////////////////////////////////////////////////////////////////////
// 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.
#define EGROKPRF_OBSOLETE 5 // obsolete database version detected, requiring conversion
// makeDatabase() error codes
#define EMKPRF_CREATEFAILED 1 // for some reason CreateFile() didnt like something
#define MDB_CAPS_COMPACT 0x0001 // database can be compacted
struct DATABASELINK
{
int capabilities;
char* szShortName; // uniqie short database name
wchar_t* 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 wchar_t *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 wchar_t *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
*/
MDatabaseCommon* (*Load)(const wchar_t *profile, BOOL bReadOnly);
};
///////////////////////////////////////////////////////////////////////////////
// cache access function
EXTERN_C MIR_CORE_DLL(DBCachedContact*) db_get_contact(MCONTACT);
///////////////////////////////////////////////////////////////////////////////
// Database list's functions
EXTERN_C MIR_CORE_DLL(MDatabaseCommon*) db_get_current(void);
// registers a database plugin
EXTERN_C MIR_APP_DLL(void) RegisterDatabasePlugin(DATABASELINK *pDescr);
// looks for a database plugin by its short name
// returns DATABASELINK* of the required plugin or nullptr on error
EXTERN_C MIR_APP_DLL(DATABASELINK*) GetDatabasePlugin(const char *pszDriverName);
// looks for a database plugin suitable to open this file
// returns DATABASELINK* of the required plugin or nullptr on error
EXTERN_C MIR_APP_DLL(DATABASELINK*) FindDatabasePlugin(const wchar_t *ptszFileName);
#endif // M_DB_INT_H__
|
