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
|
/*
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
*
*/
/**
@file
@internalComponent
@released
*/
#ifndef RCNTMODEL_H
#define RCNTMODEL_H
#include <cntdb.h>
#include "ccntipccodes.h"
#include <e32base.h>
#include <f32file.h>
#include <badesca.h>
class CContactTemplate;
class CViewContact;
class CCntDbNotifyMonitor;
class CCntPackager;
class MContactDbObserver;
class CContactDefaultViewDefinition;
class CContactTextDef;
class CImageRescaler;
const TInt KUidBufferSize = 400;
/**
Client-side Contacts Model session handle.
*/
class RCntModel : public RSessionBase
{
public:
RCntModel();
void ConnectL();
void Close();
TInt OpenDatabase(const TDesC& aCntFile = KNullDesC) const;
void OpenDatabaseAsyncL(TRequestStatus& aStatus ,const TDesC& aCntFile = KNullDesC);
void CancelAsyncOpen();
void OpenTablesL();
void CloseTablesL();
void CloseDatabase() const;
TInt ReplaceDatabase(const TDesC& aCntFile = KNullDesC) const;
TInt CreateDatabase(const TDesC& aCntFile = KNullDesC) const;
TInt DeleteDatabase(const TDesC& aCntFile = KNullDesC) const;
TInt DefaultDatabase(TDes& aCntFile) const;
TInt DatabaseDrive(TDriveUnit& aDriveUnit) const;
void SetDatabaseDriveL(TDriveUnit aDriveUnit, TBool aCopy = ETrue);
TBool DatabaseExistsL(const TDesC& aCntFile = KNullDesC) const;
CDesCArray* ListDatabasesL(TDriveUnit* aDriveUnit = NULL) const;
TPtrC FileUidL() const;
TBool DatabaseReadyL() const;
// Contact Item CRUD methods.
TContactItemId CreateContactL(CContactItem& aContact) const;
void DeleteContactL(const TContactItemId aCntId, TCntSendEventAction aCntEventType, TBool aDecAccessCount = EFalse) const;
TInt DeleteContact(const TContactItemId aCntId, TCntSendEventAction aCntEventType, TBool aDecAccessCount = EFalse) const;
void CommitContactL(const CContactItem& aContact, TBool aSendChangedEvent = ETrue) const;
CContactItem* ReadContactL(const CContactItemViewDef* aCntItemVDef, TContactItemId aCntId) const;
CContactItem* OpenContactLX(const CContactItemViewDef* aCntItemVDef, TContactItemId aCntId) const;
TBool CloseContact(TContactItemId aContactId);
void SetViewDefinitionL(const CContactViewDef& aView);
TInt64 MachineId() const;
void SetOperationTimeOutL(const TInt aMicroSeconds) const;
TInt OpenCrud() const;
TInt OpenIterator() const;
TInt OpenProperties() const;
TInt CloseCrud() const;
TInt CloseIterator() const;
TInt CloseProperties() const;
void CrudAsyncOp(TInt aParam,TRequestStatus& aStatus) const;
TInt CrudSyncOp(TInt aParam) const;
void IteratorAsyncOp(TInt aParam,TRequestStatus& aStatus) const;
TInt IteratorSyncOp(TInt aParam) const;
void PropertiesAsyncOp(TInt aParam,TRequestStatus& aStatus) const;
TInt PropertiesSyncOp(TInt aParam) const;
TInt FileSize() const;
TInt ReCreateTemplate() const;
TInt BeginDbTransaction() const;
TInt CommitDbTransaction() const;
void CommitDbTransaction(TRequestStatus*& aStatus) const;
TInt RollbackDbTransaction() const;
// Observer methods for database event notifications.
void AddObserverL(MContactDbObserver& aObserver);
void RemoveObserver(const MContactDbObserver& aObserver);
void AddObserverV2L(MContactDbObserverV2& aObserver);
void RemoveObserverV2(const MContactDbObserverV2& aObserver);
void SetCurrentItem(TContactItemId aContactId) const;
TContactItemId CurrentItem() const;
TInt RemoveCurrentItem();
TInt GetCurrentDatabase(TDes& aDatabase) const;
TInt SetCurrentDatabase(const TDesC& aDatabase) const;
void ResetServerSpeedDialsL();
TContactItemId GetSpeedDialFieldL(TInt aSpeedDialPosition, TDes& aPhoneNumber);
void SetFieldAsSpeedDialL(TContactItemId aContactId, TInt aFieldIndex, TInt aSpeedDialPosition);
void RemoveSpeedDialFieldL(TContactItemId aContactId, TInt aSpeedDialPosition);
void SetOwnCardL(const CContactItem& aContact);
TContactItemId OwnCard() const;
TInt ConnectionId() const;
void OverrideMachineUniqueId(TInt64 aMachineUniqueId);
void SetHeapFailure(RHeap::TAllocFail aType, TInt aRate);
TInt ResourceCount();
TContactItemId PrefTemplateId() const;
void SetPrefTemplateL(const TContactItemId aContactId);
CContactIdArray* FetchTemplateListIdsL();
CContactIdArray* FetchGroupListIdsL();
CContactIdArray* CollectionL(TInt aCollectionType, TTime aTime=0,const TDesC& aGuid = KNullDesC);
void SetSortPreferenceL(const CArrayFix<CContactDatabase::TSortPref>& aSortOrder);
CArrayFix<CContactDatabase::TSortPref>* GetSortPreferenceL() const;
CContactIdArray* MatchPhoneNumberL(const TDesC& aNumber, const TInt aMatchLengthFromRight);
TInt ContactCountL() const;
TBool SeekContactL(TContactItemId aContactId,TContactItemId& aId,TUid& aContactType, TBool& aDeleted);
void ReadContactTextDefL(TContactItemId aContactId, TDes &aResult,const CContactTextDef& aTextDef);
void TextFieldL(TInt aCntItemId,TFieldType aFieldType, TDes& aText);
TContactItemId ICCTemplateIdL(TUid aPhonebookUid = KNullUid);
TContactItemId PhonebookGroupIdL();
CContactIdArray* FindL(const TDesC& aText,const CContactItemFieldDef* aFieldDef);
TBool ContactMatchesHintFieldL(TInt aBitWiseFilter,TContactItemId aContactId);
void SetDbViewContactType(const TUid aUid);
TUid GetDbViewContactType() const;
void FilterDatabaseL(CCntFilter& aFilter);
void FindAsyncTextDefInitL(const CDesCArray& aWords,CContactTextDef* aTextDef);
void FindAsyncInitL(const TDesC& aText,CContactItemFieldDef* aFieldDef);
TBool FindAsyncL(CContactIdArray*& aIdArray);
void SetAsyncActivityL(TBool aAsyncActivity);
// Used to request a database event. See CCntDbNotifyMonitor::Start().
void StartNotificationTransfer(TRequestStatus& aStatus, TDes8& aEvent, TDes8& aIdArray);
void EndNotificationTransfer();
// See CCntDbNotifyMonitor::RunL().
void HandlePrematureServerTerminationL();
// Used to close/unlock the last locked contact items from the cleanup
// stack. Called when popping the cleanup stack.
void UnlockLastLockedContact();
// Used for test purposes (only works in _DEBUG builds).
void GetDefinitionsOfExistingViewsL(const TDesC& aDbName, RPointerArray<CContactDefaultViewDefinition>& aViewDefs);
TInt OpenViewL(const CContactTextDef& aTextDef, const TInt aViewPrefs);
void CloseView(TInt aViewId);
void ChangeSortOrderL(TInt aViewId, const CContactTextDef& aTextDef);
void BeginIterateL(TInt aViewId);
void EndIterateL(TInt aViewId);
CViewContact* NextItemL(TInt aViewId, const TInt aViewPrefs);
CViewContact* ItemAtL(TContactItemId aContactId, TInt aViewId);
private:
TVersion Version() const;
CContactItem* UnPackContactLC(TInt aBufferSize, TIpcArgs& aArgs) const;
CContactIdArray* DoGetCollectionChangedSinceL(TTime aTime);
CContactIdArray* DoGetCollectionL(TInt aCollectionType);
CContactIdArray* DoGetCollectionGuidL(const TDesC& aGuid);
void PushUnlockL() const;
// Save the filename. Used to re-open database if the server is terminated
// prematurely.
TInt SetFileName(const TDesC& aCntFile) const;
private:
CCntDbNotifyMonitor* iDbNotifyMonitor;
mutable CCntPackager* iPackager;
mutable TBuf<KUidBufferSize> iFileUid;
mutable TInt iConnectionId;
mutable TBuf<KCntMaxFilePath> iFileName;
// Number of attempts to restart the server after an unexpected process
// termination.
TInt iNoOfSvrStartAttempts;
// Image rescaling
CImageRescaler* iRescaler;
//For tracking connection status
TBool iServerRunning;
};
#endif // RCNTMODEL_H
|
