Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-3.0-or-later
2 : : // SPDX-FileCopyrightText: Andy Holmes <andrew.g.r.holmes@gmail.com>
3 : :
4 : : #define G_LOG_DOMAIN "valent-contacts-adapter"
5 : :
6 : : #include "config.h"
7 : :
8 : : #include <gio/gio.h>
9 : : #include <libvalent-core.h>
10 : : #include <libtracker-sparql/tracker-sparql.h>
11 : :
12 : : #include "valent-contacts.h"
13 : : #include "valent-contact-list.h"
14 : :
15 : : #include "valent-contacts-adapter.h"
16 : :
17 : : #define GET_CONTACT_RQ "/ca/andyholmes/Valent/sparql/get-contact.rq"
18 : : #define GET_CONTACT_LIST_RQ "/ca/andyholmes/Valent/sparql/get-contact-list.rq"
19 : : #define GET_CONTACT_LISTS_RQ "/ca/andyholmes/Valent/sparql/get-contact-lists.rq"
20 : :
21 : :
22 : : /**
23 : : * ValentContactsAdapter:
24 : : *
25 : : * An abstract base class for address book providers.
26 : : *
27 : : * `ValentContactsAdapter` is a base class for plugins that provide an
28 : : * interface to address books and contacts. This usually means managing entries
29 : : * in the %VALENT_CONTACTS_GRAPH.
30 : : *
31 : : * ## `.plugin` File
32 : : *
33 : : * Implementations may define the following extra fields in the `.plugin` file:
34 : : *
35 : : * - `X-ContactsAdapterPriority`
36 : : *
37 : : * An integer indicating the adapter priority. The implementation with the
38 : : * lowest value will be used as the primary adapter.
39 : : *
40 : : * Since: 1.0
41 : : */
42 : :
43 : : typedef struct
44 : : {
45 : : TrackerSparqlConnection *connection;
46 : : TrackerNotifier *notifier;
47 : : TrackerSparqlStatement *get_contact_list_stmt;
48 : : TrackerSparqlStatement *get_contact_lists_stmt;
49 : : GRegex *iri_pattern;
50 : : char *iri;
51 : : GCancellable *cancellable;
52 : :
53 : : /* list model */
54 : : GPtrArray *items;
55 : : } ValentContactsAdapterPrivate;
56 : :
57 : : static void g_list_model_iface_init (GListModelInterface *iface);
58 : :
59 : : static void valent_contacts_adapter_add_contact_list (ValentContactsAdapter *self,
60 : : const char *iri);
61 : : static void valent_contacts_adapter_remove_contact_list (ValentContactsAdapter *self,
62 : : const char *iri);
63 : :
64 [ + + + - ]: 536928 : G_DEFINE_ABSTRACT_TYPE_WITH_CODE (ValentContactsAdapter, valent_contacts_adapter, VALENT_TYPE_EXTENSION,
65 : : G_ADD_PRIVATE (ValentContactsAdapter)
66 : : G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL, g_list_model_iface_init))
67 : :
68 : : typedef enum
69 : : {
70 : : PROP_CONNECTION = 1,
71 : : } ValentContactsAdapterProperty;
72 : :
73 : : static GParamSpec *properties[PROP_CONNECTION + 1] = { NULL, };
74 : :
75 : : gboolean
76 : 19 : valent_contacts_adapter_event_is_contact_list (ValentContactsAdapter *self,
77 : : const char *iri)
78 : : {
79 : 19 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
80 : :
81 : 19 : return g_regex_match (priv->iri_pattern, iri, G_REGEX_MATCH_DEFAULT, NULL);
82 : : }
83 : :
84 : : static void
85 : 15 : on_notifier_event (TrackerNotifier *notifier,
86 : : const char *service,
87 : : const char *graph,
88 : : GPtrArray *events,
89 : : ValentContactsAdapter *self)
90 : : {
91 [ - + ]: 15 : g_assert (VALENT_IS_CONTACTS_ADAPTER (self));
92 : :
93 [ + - ]: 15 : if (g_strcmp0 (VALENT_CONTACTS_GRAPH, graph) != 0)
94 : : return;
95 : :
96 [ + + ]: 34 : for (unsigned int i = 0; i < events->len; i++)
97 : : {
98 : 19 : TrackerNotifierEvent *event = g_ptr_array_index (events, i);
99 : 19 : const char *urn = tracker_notifier_event_get_urn (event);
100 : :
101 [ + + ]: 19 : if (!valent_contacts_adapter_event_is_contact_list (self, urn))
102 : 5 : continue;
103 : :
104 [ + + - + ]: 14 : switch (tracker_notifier_event_get_event_type (event))
105 : : {
106 : 12 : case TRACKER_NOTIFIER_EVENT_CREATE:
107 : 12 : VALENT_NOTE ("CREATE: %s", urn);
108 : 12 : valent_contacts_adapter_add_contact_list (self, urn);
109 : 12 : break;
110 : :
111 : 1 : case TRACKER_NOTIFIER_EVENT_DELETE:
112 : 1 : VALENT_NOTE ("DELETE: %s", urn);
113 : 1 : valent_contacts_adapter_remove_contact_list (self, urn);
114 : 1 : break;
115 : :
116 : : case TRACKER_NOTIFIER_EVENT_UPDATE:
117 : : VALENT_NOTE ("UPDATE: %s", urn);
118 : : // valent_contacts_adapter_update_contact_list (self, urn);
119 : : break;
120 : :
121 : 0 : default:
122 : 19 : g_warn_if_reached ();
123 : : }
124 : : }
125 : : }
126 : :
127 : : static ValentContactList *
128 : 1 : valent_contact_list_from_sparql_cursor (ValentContactsAdapter *self,
129 : : TrackerSparqlCursor *cursor)
130 : : {
131 : 1 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
132 : 1 : const char *iri = NULL;
133 : :
134 [ + - ]: 1 : if (!tracker_sparql_cursor_is_bound (cursor, 0))
135 : : return NULL;
136 : :
137 : 1 : iri = tracker_sparql_cursor_get_string (cursor, 0, NULL);
138 : 1 : return g_object_new (VALENT_TYPE_CONTACT_LIST,
139 : : "connection", tracker_sparql_cursor_get_connection (cursor),
140 : : "notifier", priv->notifier,
141 : : "iri", iri,
142 : : NULL);
143 : : }
144 : :
145 : : static void
146 : 16 : cursor_get_contact_lists_cb (TrackerSparqlCursor *cursor,
147 : : GAsyncResult *result,
148 : : gpointer user_data)
149 : : {
150 : 16 : g_autoptr (ValentContactsAdapter) self = VALENT_CONTACTS_ADAPTER (g_steal_pointer (&user_data));
151 : 16 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
152 [ + - ]: 16 : g_autoptr (GError) error = NULL;
153 : :
154 [ + + ]: 16 : if (tracker_sparql_cursor_next_finish (cursor, result, &error))
155 : : {
156 : 1 : ValentContactList *contacts = NULL;
157 : :
158 : 1 : contacts = valent_contact_list_from_sparql_cursor (self, cursor);
159 [ + - ]: 1 : if (contacts != NULL)
160 : : {
161 : 1 : unsigned int position;
162 : :
163 : 1 : position = priv->items->len;
164 : 1 : g_ptr_array_add (priv->items, g_object_ref (contacts));
165 : 1 : g_list_model_items_changed (G_LIST_MODEL (self), position, 0, 1);
166 : : }
167 : :
168 : 1 : tracker_sparql_cursor_next_async (cursor,
169 : : g_task_get_cancellable (G_TASK (result)),
170 : : (GAsyncReadyCallback) cursor_get_contact_lists_cb,
171 : : g_object_ref (self));
172 : : }
173 : : else
174 : : {
175 [ - + - - ]: 15 : if (error != NULL && !g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
176 : 0 : g_warning ("%s(): %s", G_STRFUNC, error->message);
177 : :
178 : 15 : tracker_sparql_cursor_close (cursor);
179 : : }
180 : 16 : }
181 : :
182 : : static void
183 : 15 : execute_get_contact_lists_cb (TrackerSparqlStatement *stmt,
184 : : GAsyncResult *result,
185 : : gpointer user_data)
186 : : {
187 : 30 : g_autoptr (ValentContactsAdapter) self = VALENT_CONTACTS_ADAPTER (g_steal_pointer (&user_data));
188 [ - - + - ]: 15 : g_autoptr (TrackerSparqlCursor) cursor = NULL;
189 [ - - ]: 15 : g_autoptr (GError) error = NULL;
190 : :
191 : 15 : cursor = tracker_sparql_statement_execute_finish (stmt, result, &error);
192 [ - + ]: 15 : if (cursor == NULL)
193 : : {
194 [ # # ]: 0 : if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
195 : 0 : g_warning ("%s(): %s", G_STRFUNC, error->message);
196 : :
197 [ # # ]: 0 : return;
198 : : }
199 : :
200 [ - + ]: 15 : tracker_sparql_cursor_next_async (cursor,
201 : : g_task_get_cancellable (G_TASK (result)),
202 : : (GAsyncReadyCallback) cursor_get_contact_lists_cb,
203 : : g_object_ref (self));
204 : : }
205 : :
206 : : static void
207 : 15 : valent_contacts_adapter_load_contact_lists (ValentContactsAdapter *self)
208 : : {
209 : 15 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
210 : 15 : g_autoptr (GError) error = NULL;
211 : :
212 [ - + ]: 15 : g_assert (VALENT_IS_CONTACTS_ADAPTER (self));
213 [ + - ]: 15 : g_return_if_fail (TRACKER_IS_SPARQL_CONNECTION (priv->connection));
214 : :
215 [ + - ]: 15 : if (priv->cancellable != NULL)
216 : : return;
217 : :
218 : 15 : priv->cancellable = valent_object_ref_cancellable (VALENT_OBJECT (self));
219 [ + - ]: 15 : if (priv->get_contact_lists_stmt == NULL)
220 : : {
221 : 15 : priv->get_contact_lists_stmt =
222 : 15 : tracker_sparql_connection_load_statement_from_gresource (priv->connection,
223 : : GET_CONTACT_LISTS_RQ,
224 : : priv->cancellable,
225 : : &error);
226 : : }
227 : :
228 [ - + ]: 15 : if (priv->get_contact_lists_stmt == NULL)
229 : : {
230 [ # # # # ]: 0 : if (error != NULL && !g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
231 : 0 : g_warning ("%s(): %s", G_STRFUNC, error->message);
232 : :
233 : 0 : return;
234 : : }
235 : :
236 [ - + ]: 15 : tracker_sparql_statement_execute_async (priv->get_contact_lists_stmt,
237 : : priv->cancellable,
238 : : (GAsyncReadyCallback) execute_get_contact_lists_cb,
239 : : g_object_ref (self));
240 : : }
241 : :
242 : : static void
243 : 12 : valent_contacts_adapter_add_contact_list (ValentContactsAdapter *self,
244 : : const char *iri)
245 : : {
246 : 12 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
247 : 24 : g_autoptr (GListModel) list = NULL;
248 : 12 : unsigned int position = 0;
249 : :
250 [ - + ]: 12 : g_assert (VALENT_IS_CONTACTS_ADAPTER (self));
251 [ + - ]: 12 : g_assert (TRACKER_IS_SPARQL_CONNECTION (priv->connection));
252 : :
253 : 12 : list = g_object_new (VALENT_TYPE_CONTACT_LIST,
254 : : "connection", priv->connection,
255 : : "notifier", priv->notifier,
256 : : "iri", iri,
257 : : NULL);
258 : :
259 : 12 : position = priv->items->len;
260 : 12 : g_ptr_array_add (priv->items, g_steal_pointer (&list));
261 : 12 : g_list_model_items_changed (G_LIST_MODEL (self), position, 0, 1);
262 : 12 : }
263 : :
264 : : static inline gboolean
265 : 2 : find_item (gconstpointer a,
266 : : gconstpointer b)
267 : : {
268 : 2 : const char *iri = valent_resource_get_iri ((ValentResource *)a);
269 : :
270 : 2 : return g_strcmp0 (iri, (const char *)b) == 0;
271 : : }
272 : :
273 : : static void
274 : 1 : valent_contacts_adapter_remove_contact_list (ValentContactsAdapter *self,
275 : : const char *iri)
276 : : {
277 : 1 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
278 : 1 : g_autoptr (GListModel) item = NULL;
279 : 1 : unsigned int position = 0;
280 : :
281 [ - + ]: 1 : g_assert (VALENT_IS_CONTACTS_ADAPTER (self));
282 : :
283 [ - + ]: 1 : if (!g_ptr_array_find_with_equal_func (priv->items, iri, find_item, &position))
284 : : {
285 : 0 : g_warning ("No such store \"%s\" found in \"%s\"",
286 : : iri,
287 : : G_OBJECT_TYPE_NAME (self));
288 : 0 : return;
289 : : }
290 : :
291 : 1 : item = g_ptr_array_steal_index (priv->items, position);
292 [ + - ]: 1 : g_list_model_items_changed (G_LIST_MODEL (self), position, 1, 0);
293 : : }
294 : :
295 : : static gboolean
296 : 15 : valent_contacts_adapter_open (ValentContactsAdapter *self,
297 : : GError **error)
298 : : {
299 : 15 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
300 : 15 : ValentContext *context = NULL;
301 : 30 : g_autoptr (GFile) file = NULL;
302 [ + - ]: 15 : g_autoptr (GFile) ontology = NULL;
303 : 15 : const char *iri = NULL;
304 [ + - ]: 15 : g_autofree char *iri_pattern = NULL;
305 : :
306 : 15 : context = valent_extension_get_context (VALENT_EXTENSION (self));
307 : 15 : file = valent_context_get_cache_file (context, "metadata");
308 : 15 : ontology = g_file_new_for_uri ("resource:///ca/andyholmes/Valent/ontologies/");
309 : :
310 : 30 : priv->connection =
311 : 15 : tracker_sparql_connection_new (TRACKER_SPARQL_CONNECTION_FLAGS_NONE,
312 : : file,
313 : : ontology,
314 : : NULL,
315 : : error);
316 : :
317 [ + - ]: 15 : if (priv->connection == NULL)
318 : : return FALSE;
319 : :
320 : 15 : iri = valent_resource_get_iri (VALENT_RESOURCE (self));
321 : 15 : iri_pattern = g_strdup_printf ("^%s:([^:]+)$", iri);
322 : 15 : priv->iri_pattern = g_regex_new (iri_pattern,
323 : : G_REGEX_OPTIMIZE,
324 : : G_REGEX_MATCH_DEFAULT,
325 : : NULL);
326 : :
327 : 15 : priv->notifier = tracker_sparql_connection_create_notifier (priv->connection);
328 : 15 : g_signal_connect_object (priv->notifier,
329 : : "events",
330 : : G_CALLBACK (on_notifier_event),
331 : : self,
332 : : G_CONNECT_DEFAULT);
333 : :
334 : 15 : return TRUE;
335 : : }
336 : :
337 : : /*
338 : : * GListModel
339 : : */
340 : : static gpointer
341 : 18 : valent_contacts_adapter_get_item (GListModel *list,
342 : : unsigned int position)
343 : : {
344 : 18 : ValentContactsAdapter *self = VALENT_CONTACTS_ADAPTER (list);
345 : 18 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
346 : :
347 [ - + ]: 18 : g_assert (VALENT_IS_CONTACTS_ADAPTER (self));
348 : :
349 [ + + ]: 18 : if G_UNLIKELY (position >= priv->items->len)
350 : : return NULL;
351 : :
352 : 17 : return g_object_ref (g_ptr_array_index (priv->items, position));
353 : : }
354 : :
355 : : static GType
356 : 1 : valent_contacts_adapter_get_item_type (GListModel *list)
357 : : {
358 : 1 : return G_TYPE_LIST_MODEL;
359 : : }
360 : :
361 : : static unsigned int
362 : 268180 : valent_contacts_adapter_get_n_items (GListModel *list)
363 : : {
364 : 268180 : ValentContactsAdapter *self = VALENT_CONTACTS_ADAPTER (list);
365 : 268180 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
366 : :
367 [ - + ]: 268180 : g_assert (VALENT_IS_CONTACTS_ADAPTER (self));
368 : :
369 : 268180 : return priv->items->len;
370 : : }
371 : :
372 : : static void
373 : 51 : g_list_model_iface_init (GListModelInterface *iface)
374 : : {
375 : 51 : iface->get_item = valent_contacts_adapter_get_item;
376 : 51 : iface->get_item_type = valent_contacts_adapter_get_item_type;
377 : 51 : iface->get_n_items = valent_contacts_adapter_get_n_items;
378 : 51 : }
379 : :
380 : : /*
381 : : * ValentObject
382 : : */
383 : : static void
384 : 24 : valent_contacts_adapter_destroy (ValentObject *object)
385 : : {
386 : 24 : ValentContactsAdapter *self = VALENT_CONTACTS_ADAPTER (object);
387 : 24 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
388 : :
389 [ + + ]: 24 : g_clear_object (&priv->notifier);
390 [ - + ]: 24 : g_clear_object (&priv->get_contact_list_stmt);
391 [ + + ]: 24 : g_clear_object (&priv->get_contact_lists_stmt);
392 [ + + ]: 24 : g_clear_pointer (&priv->iri_pattern, g_regex_unref);
393 [ + + ]: 24 : g_clear_object (&priv->cancellable);
394 : :
395 [ + + ]: 24 : if (priv->connection != NULL)
396 : : {
397 : 13 : tracker_sparql_connection_close (priv->connection);
398 [ + - ]: 13 : g_clear_object (&priv->connection);
399 : : }
400 : :
401 : 24 : VALENT_OBJECT_CLASS (valent_contacts_adapter_parent_class)->destroy (object);
402 : 24 : }
403 : :
404 : : /*
405 : : * GObject
406 : : */
407 : : static void
408 : 15 : valent_contacts_adapter_constructed (GObject *object)
409 : : {
410 : 15 : ValentContactsAdapter *self = VALENT_CONTACTS_ADAPTER (object);
411 : 30 : g_autoptr (GError) error = NULL;
412 : :
413 : 15 : G_OBJECT_CLASS (valent_contacts_adapter_parent_class)->constructed (object);
414 : :
415 [ + - ]: 15 : if (valent_contacts_adapter_open (self, &error))
416 : 15 : valent_contacts_adapter_load_contact_lists (self);
417 : : else
418 : 0 : g_critical ("%s(): %s", G_STRFUNC, error->message);
419 : 15 : }
420 : :
421 : : static void
422 : 13 : valent_contacts_adapter_finalize (GObject *object)
423 : : {
424 : 13 : ValentContactsAdapter *self = VALENT_CONTACTS_ADAPTER (object);
425 : 13 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
426 : :
427 [ + - ]: 13 : g_clear_pointer (&priv->items, g_ptr_array_unref);
428 [ - + ]: 13 : g_clear_object (&priv->cancellable);
429 : :
430 : 13 : G_OBJECT_CLASS (valent_contacts_adapter_parent_class)->finalize (object);
431 : 13 : }
432 : :
433 : : static void
434 : 17 : valent_contacts_adapter_get_property (GObject *object,
435 : : guint prop_id,
436 : : GValue *value,
437 : : GParamSpec *pspec)
438 : : {
439 : 17 : ValentContactsAdapter *self = VALENT_CONTACTS_ADAPTER (object);
440 : 17 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
441 : :
442 [ + - ]: 17 : switch ((ValentContactsAdapterProperty)prop_id)
443 : : {
444 : 17 : case PROP_CONNECTION:
445 : 17 : g_value_set_object (value, priv->connection);
446 : 17 : break;
447 : :
448 : 0 : default:
449 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
450 : : }
451 : 17 : }
452 : :
453 : : static void
454 : 15 : valent_contacts_adapter_set_property (GObject *object,
455 : : guint prop_id,
456 : : const GValue *value,
457 : : GParamSpec *pspec)
458 : : {
459 : 15 : ValentContactsAdapter *self = VALENT_CONTACTS_ADAPTER (object);
460 : 15 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (self);
461 : :
462 [ + - ]: 15 : switch ((ValentContactsAdapterProperty)prop_id)
463 : : {
464 : 15 : case PROP_CONNECTION:
465 : 15 : g_set_object (&priv->connection, g_value_get_object (value));
466 : 15 : break;
467 : :
468 : 0 : default:
469 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
470 : : }
471 : 15 : }
472 : :
473 : : static void
474 : 51 : valent_contacts_adapter_class_init (ValentContactsAdapterClass *klass)
475 : : {
476 : 51 : GObjectClass *object_class = G_OBJECT_CLASS (klass);
477 : 51 : ValentObjectClass *vobject_class = VALENT_OBJECT_CLASS (klass);
478 : :
479 : 51 : object_class->constructed = valent_contacts_adapter_constructed;
480 : 51 : object_class->finalize = valent_contacts_adapter_finalize;
481 : 51 : object_class->get_property = valent_contacts_adapter_get_property;
482 : 51 : object_class->set_property = valent_contacts_adapter_set_property;
483 : :
484 : 51 : vobject_class->destroy = valent_contacts_adapter_destroy;
485 : :
486 : : /**
487 : : * ValentContactsAdapter:connection:
488 : : *
489 : : * The database connection.
490 : : */
491 : 102 : properties [PROP_CONNECTION] =
492 : 51 : g_param_spec_object ("connection", NULL, NULL,
493 : : TRACKER_TYPE_SPARQL_CONNECTION,
494 : : (G_PARAM_READWRITE |
495 : : G_PARAM_CONSTRUCT_ONLY |
496 : : G_PARAM_STATIC_STRINGS));
497 : :
498 : 51 : g_object_class_install_properties (object_class, G_N_ELEMENTS (properties), properties);
499 : 51 : }
500 : :
501 : : static void
502 : 15 : valent_contacts_adapter_init (ValentContactsAdapter *adapter)
503 : : {
504 : 15 : ValentContactsAdapterPrivate *priv = valent_contacts_adapter_get_instance_private (adapter);
505 : :
506 : 15 : priv->items = g_ptr_array_new_with_free_func (g_object_unref);
507 : 15 : }
508 : :
|
