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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
|
/*
* e-book-backend.h
*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
* Copyright (C) 2012 Intel Corporation
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation.
*
* This library 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 Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Authors: Nat Friedman (nat@ximian.com)
* Tristan Van Berkom <tristanvb@openismus.com>
*/
#if !defined (__LIBEDATA_BOOK_H_INSIDE__) && !defined (LIBEDATA_BOOK_COMPILATION)
#error "Only <libedata-book/libedata-book.h> should be included directly."
#endif
#ifndef E_BOOK_BACKEND_H
#define E_BOOK_BACKEND_H
#include <libebook-contacts/libebook-contacts.h>
#include <libebackend/libebackend.h>
#include <libedata-book/e-data-book.h>
#include <libedata-book/e-data-book-cursor.h>
#include <libedata-book/e-data-book-direct.h>
#include <libedata-book/e-data-book-view.h>
/* Standard GObject macros */
#define E_TYPE_BOOK_BACKEND \
(e_book_backend_get_type ())
#define E_BOOK_BACKEND(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_BOOK_BACKEND, EBookBackend))
#define E_BOOK_BACKEND_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_BOOK_BACKEND, EBookBackendClass))
#define E_IS_BOOK_BACKEND(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_BOOK_BACKEND))
#define E_IS_BOOK_BACKEND_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_BOOK_BACKEND))
#define E_BOOK_BACKEND_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_BOOK_BACKEND, EBookBackendClass))
/**
* CLIENT_BACKEND_PROPERTY_CAPABILITIES:
*
* FIXME: Document me.
*
* Since: 3.2
**/
#define CLIENT_BACKEND_PROPERTY_CAPABILITIES "capabilities"
/**
* BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS:
*
* FIXME: Document me.
*
* Since: 3.2
**/
#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS "required-fields"
/**
* BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS:
*
* FIXME: Document me.
*
* Since: 3.2
**/
#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS "supported-fields"
/**
* BOOK_BACKEND_PROPERTY_REVISION:
*
* The current overall revision string, this can be used as
* a quick check to see if data has changed at all since the
* last time the addressbook revision was observed.
*
* Since: 3.4
**/
#define BOOK_BACKEND_PROPERTY_REVISION "revision"
G_BEGIN_DECLS
typedef struct _EBookBackend EBookBackend;
typedef struct _EBookBackendClass EBookBackendClass;
typedef struct _EBookBackendPrivate EBookBackendPrivate;
/**
* EBookBackend:
*
* Contains only private data that should be read and manipulated using the
* functions below.
*/
struct _EBookBackend {
/*< private >*/
EBackend parent;
EBookBackendPrivate *priv;
};
/**
* EBookBackendClass:
* @use_serial_dispatch_queue: Whether a serial dispatch queue should
* be used for this backend or not. The default is %TRUE.
* @get_backend_property: Fetch a property value by name from the backend
* @open_sync: Open the backend
* @refresh_sync: Refresh the backend
* @create_contacts_sync: Add and store the passed vcards
* @modify_contacts_sync: Modify the existing contacts using the passed vcards
* @remove_contacts_sync: Remove the contacts specified by the passed UIDs
* @get_contact_sync: Fetch a contact by UID
* @get_contact_list_sync: Fetch a list of contacts based on a search expression
* @get_contact_list_uids_sync: Fetch a list of contact UIDs based on a search expression (optional)
* @start_view: Start up the specified view
* @stop_view: Stop the specified view
* @notify_update: Notify changes which might have occured for a given contact
* @get_direct_book: For addressbook backends which support Direct Read Access,
* report some information on how to access the addressbook persistance directly
* @configure_direct: For addressbook backends which support Direct Read Access, configure a
* backend instantiated on the client side for Direct Read Access, using data
* reported from the server via the @get_direct_book method.
* @sync: Sync the backend's persistance
* @set_locale: Store & remember the passed locale setting
* @dup_locale: Return the currently set locale setting (must be a string duplicate, for thread safety).
* @create_cursor: Create an #EDataBookCursor
* @delete_cursor: Delete an #EDataBookCursor previously created by this backend
* @closed: A signal notifying that the backend was closed
* @shutdown: A signal notifying that the backend is being shut down
* @open: Deprecated method
* @refresh: Deprecated method
* @create_contacts: Deprecated method
* @remove_contacts: Deprecated method
* @modify_contacts: Deprecated method
* @get_contact: Deprecated method
* @get_contact_list: Deprecated method
* @get_contact_list_uids: Deprecated method
*
* Class structure for the #EBookBackend class.
*
* These virtual methods must be implemented when writing
* an addressbook backend.
*/
struct _EBookBackendClass {
/*< private >*/
EBackendClass parent_class;
/*< public >*/
/* Set this to TRUE to use a serial dispatch queue, instead
* of a concurrent dispatch queue. A serial dispatch queue
* executes one method at a time in the order in which they
* were called. This is generally slower than a concurrent
* dispatch queue, but helps avoid thread-safety issues. */
gboolean use_serial_dispatch_queue;
gchar * (*get_backend_property) (EBookBackend *backend,
const gchar *prop_name);
gboolean (*open_sync) (EBookBackend *backend,
GCancellable *cancellable,
GError **error);
gboolean (*refresh_sync) (EBookBackend *backend,
GCancellable *cancellable,
GError **error);
gboolean (*create_contacts_sync) (EBookBackend *backend,
const gchar * const *vcards,
GQueue *out_contacts,
GCancellable *cancellable,
GError **error);
gboolean (*modify_contacts_sync) (EBookBackend *backend,
const gchar * const *vcards,
GQueue *out_contacts,
GCancellable *cancellable,
GError **error);
gboolean (*remove_contacts_sync) (EBookBackend *backend,
const gchar * const *uids,
GCancellable *cancellable,
GError **error);
EContact * (*get_contact_sync) (EBookBackend *backend,
const gchar *uid,
GCancellable *cancellable,
GError **error);
gboolean (*get_contact_list_sync)
(EBookBackend *backend,
const gchar *query,
GQueue *out_contacts,
GCancellable *cancellable,
GError **error);
/* This method is optional. By default, it simply calls
* get_contact_list_sync() and extracts UID strings from
* the matched EContacts. Backends may override this if
* they can implement it more efficiently. */
gboolean (*get_contact_list_uids_sync)
(EBookBackend *backend,
const gchar *query,
GQueue *out_uids,
GCancellable *cancellable,
GError **error);
/* These methods are deprecated and will be removed once all
* known subclasses are converted to the new methods above. */
void (*open) (EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable,
gboolean only_if_exists);
void (*refresh) (EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable);
void (*create_contacts) (EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable,
const GSList *vcards);
void (*remove_contacts) (EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable,
const GSList *id_list);
void (*modify_contacts) (EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable,
const GSList *vcards);
void (*get_contact) (EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable,
const gchar *id);
void (*get_contact_list) (EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable,
const gchar *query);
void (*get_contact_list_uids)
(EBookBackend *backend,
EDataBook *book,
guint32 opid,
GCancellable *cancellable,
const gchar *query);
void (*start_view) (EBookBackend *backend,
EDataBookView *book_view);
void (*stop_view) (EBookBackend *backend,
EDataBookView *book_view);
void (*notify_update) (EBookBackend *backend,
const EContact *contact);
EDataBookDirect *
(*get_direct_book) (EBookBackend *backend);
void (*configure_direct) (EBookBackend *backend,
const gchar *config);
void (*sync) (EBookBackend *backend);
gboolean (*set_locale) (EBookBackend *backend,
const gchar *locale,
GCancellable *cancellable,
GError **error);
gchar * (*dup_locale) (EBookBackend *backend);
EDataBookCursor *
(*create_cursor) (EBookBackend *backend,
EContactField *sort_fields,
EBookCursorSortType *sort_types,
guint n_fields,
GError **error);
gboolean (*delete_cursor) (EBookBackend *backend,
EDataBookCursor *cursor,
GError **error);
/* Signals */
void (*closed) (EBookBackend *backend,
const gchar *sender);
void (*shutdown) (EBookBackend *backend);
};
GType e_book_backend_get_type (void) G_GNUC_CONST;
const gchar * e_book_backend_get_cache_dir (EBookBackend *backend);
gchar * e_book_backend_dup_cache_dir (EBookBackend *backend);
void e_book_backend_set_cache_dir (EBookBackend *backend,
const gchar *cache_dir);
EDataBook * e_book_backend_ref_data_book (EBookBackend *backend);
void e_book_backend_set_data_book (EBookBackend *backend,
EDataBook *data_book);
GProxyResolver *
e_book_backend_ref_proxy_resolver
(EBookBackend *backend);
ESourceRegistry *
e_book_backend_get_registry (EBookBackend *backend);
gboolean e_book_backend_get_writable (EBookBackend *backend);
void e_book_backend_set_writable (EBookBackend *backend,
gboolean writable);
gboolean e_book_backend_is_opened (EBookBackend *backend);
gboolean e_book_backend_is_readonly (EBookBackend *backend);
gchar * e_book_backend_get_backend_property
(EBookBackend *backend,
const gchar *prop_name);
gboolean e_book_backend_open_sync (EBookBackend *backend,
GCancellable *cancellable,
GError **error);
void e_book_backend_open (EBookBackend *backend,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_book_backend_open_finish (EBookBackend *backend,
GAsyncResult *result,
GError **error);
gboolean e_book_backend_refresh_sync (EBookBackend *backend,
GCancellable *cancellable,
GError **error);
void e_book_backend_refresh (EBookBackend *backend,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_book_backend_refresh_finish (EBookBackend *backend,
GAsyncResult *result,
GError **error);
gboolean e_book_backend_create_contacts_sync
(EBookBackend *backend,
const gchar * const *vcards,
GQueue *out_contacts,
GCancellable *cancellable,
GError **error);
void e_book_backend_create_contacts (EBookBackend *backend,
const gchar * const *vcards,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_book_backend_create_contacts_finish
(EBookBackend *backend,
GAsyncResult *result,
GQueue *out_contacts,
GError **error);
gboolean e_book_backend_modify_contacts_sync
(EBookBackend *backend,
const gchar * const *vcards,
GCancellable *cancellable,
GError **error);
void e_book_backend_modify_contacts (EBookBackend *backend,
const gchar * const *vcards,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_book_backend_modify_contacts_finish
(EBookBackend *backend,
GAsyncResult *result,
GError **error);
gboolean e_book_backend_remove_contacts_sync
(EBookBackend *backend,
const gchar * const *uids,
GCancellable *cancellable,
GError **error);
void e_book_backend_remove_contacts (EBookBackend *backend,
const gchar * const *uids,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_book_backend_remove_contacts_finish
(EBookBackend *backend,
GAsyncResult *result,
GError **error);
EContact * e_book_backend_get_contact_sync (EBookBackend *backend,
const gchar *uid,
GCancellable *cancellable,
GError **error);
void e_book_backend_get_contact (EBookBackend *backend,
const gchar *uid,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
EContact * e_book_backend_get_contact_finish
(EBookBackend *backend,
GAsyncResult *result,
GError **error);
gboolean e_book_backend_get_contact_list_sync
(EBookBackend *backend,
const gchar *query,
GQueue *out_contacts,
GCancellable *cancellable,
GError **error);
void e_book_backend_get_contact_list (EBookBackend *backend,
const gchar *query,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_book_backend_get_contact_list_finish
(EBookBackend *backend,
GAsyncResult *result,
GQueue *out_contacts,
GError **error);
gboolean e_book_backend_get_contact_list_uids_sync
(EBookBackend *backend,
const gchar *query,
GQueue *out_uids,
GCancellable *cancellable,
GError **error);
void e_book_backend_get_contact_list_uids
(EBookBackend *backend,
const gchar *query,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean e_book_backend_get_contact_list_uids_finish
(EBookBackend *backend,
GAsyncResult *result,
GQueue *out_uids,
GError **error);
void e_book_backend_start_view (EBookBackend *backend,
EDataBookView *view);
void e_book_backend_stop_view (EBookBackend *backend,
EDataBookView *view);
void e_book_backend_add_view (EBookBackend *backend,
EDataBookView *view);
void e_book_backend_remove_view (EBookBackend *backend,
EDataBookView *view);
GList * e_book_backend_list_views (EBookBackend *backend);
void e_book_backend_notify_update (EBookBackend *backend,
const EContact *contact);
void e_book_backend_notify_remove (EBookBackend *backend,
const gchar *id);
void e_book_backend_notify_complete (EBookBackend *backend);
void e_book_backend_notify_error (EBookBackend *backend,
const gchar *message);
void e_book_backend_notify_property_changed
(EBookBackend *backend,
const gchar *prop_name,
const gchar *prop_value);
EDataBookDirect *
e_book_backend_get_direct_book (EBookBackend *backend);
void e_book_backend_configure_direct (EBookBackend *backend,
const gchar *config);
void e_book_backend_sync (EBookBackend *backend);
gboolean e_book_backend_set_locale (EBookBackend *backend,
const gchar *locale,
GCancellable *cancellable,
GError **error);
gchar * e_book_backend_dup_locale (EBookBackend *backend);
EDataBookCursor *
e_book_backend_create_cursor (EBookBackend *backend,
EContactField *sort_fields,
EBookCursorSortType *sort_types,
guint n_fields,
GError **error);
gboolean e_book_backend_delete_cursor (EBookBackend *backend,
EDataBookCursor *cursor,
GError **error);
GSimpleAsyncResult *
e_book_backend_prepare_for_completion
(EBookBackend *backend,
guint32 opid,
GQueue **result_queue);
/**
* EBookBackendCustomOpFunc:
* @book_backend: an #EBookBackend
* @user_data: a function user data, as provided to e_book_backend_schedule_custom_operation()
* @cancellable: an optional #GCancellable, as provided to e_book_backend_schedule_custom_operation()
* @error: return location for a #GError, or %NULL
*
* A callback prototype being called in a dedicated thread, scheduled
* by e_book_backend_schedule_custom_operation().
*
* Since: 3.26
**/
typedef void (* EBookBackendCustomOpFunc) (EBookBackend *book_backend,
gpointer user_data,
GCancellable *cancellable,
GError **error);
void e_book_backend_schedule_custom_operation
(EBookBackend *book_backend,
GCancellable *use_cancellable,
EBookBackendCustomOpFunc func,
gpointer user_data,
GDestroyNotify user_data_free);
G_END_DECLS
#endif /* E_BOOK_BACKEND_H */
|