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
|
/*
* contacts-mixin.c - Source for TpContactsMixin
* Copyright (C) 2008 Collabora Ltd.
* Copyright (C) 2008 Nokia Corporation
* @author Sjoerd Simons <sjoerd.simons@collabora.co.uk>
*
* 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; either
* version 2.1 of the License, or (at your option) any later version.
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* SECTION:contacts-mixin
* @title: TpContactsMixin
* @short_description: a mixin implementation of the contacts connection
* interface
* @see_also: #TpSvcConnectionInterfaceContacts
*
* This mixin can be added to a #TpBaseConnection subclass to implement the
* Contacts interface in a generic way.
*
* To use the contacts mixin, include a #TpContactsMixinClass somewhere in
* your class structure and a #TpContactsMixin somewhere in your instance
* structure, and call tp_contacts_mixin_class_init() from your class_init
* function, tp_contacts_mixin_init() from your init function or constructor,
* and tp_contacts_mixin_finalize() from your dispose or finalize function.
*
* To use the contacts mixin as the implementation of
* #TpSvcConnectionInterfaceContacts, in the function you pass to
* G_IMPLEMENT_INTERFACE, you should call tp_contacts_mixin_iface_init.
* TpContactsMixin implements all of the D-Bus methods and properties in the
* Contacts interface.
*
* To add interfaces with contact attributes to this interface use
* tp_contacts_mixin_add_contact_attributes_iface:
*
* Since: 0.7.14
*
*/
#include <telepathy-glib/contacts-mixin.h>
#include <dbus/dbus-glib-lowlevel.h>
#include <dbus/dbus-glib.h>
#include <telepathy-glib/base-connection.h>
#include <telepathy-glib/dbus.h>
#include <telepathy-glib/enums.h>
#include <telepathy-glib/errors.h>
#include <telepathy-glib/gtypes.h>
#include <telepathy-glib/interfaces.h>
#define DEBUG_FLAG TP_DEBUG_CONNECTION
#include "debug-internal.h"
struct _TpContactsMixinPrivate
{
/* String interface name -> FillContactAttributes func */
GHashTable *interfaces;
};
enum {
MIXIN_DP_CONTACT_ATTRIBUTE_INTERFACES,
NUM_MIXIN_CONTACTS_DBUS_PROPERTIES
};
static TpDBusPropertiesMixinPropImpl known_contacts_props[] = {
{ "ContactAttributeInterfaces", NULL, NULL },
{ NULL }
};
static void
tp_presence_mixin_get_contacts_dbus_property (GObject *object,
GQuark interface,
GQuark name,
GValue *value,
gpointer unused
G_GNUC_UNUSED)
{
static GQuark q[NUM_MIXIN_CONTACTS_DBUS_PROPERTIES] = { 0, };
TpContactsMixin *self = TP_CONTACTS_MIXIN (object);
DEBUG ("called.");
if (G_UNLIKELY (q[0] == 0))
{
q[MIXIN_DP_CONTACT_ATTRIBUTE_INTERFACES] =
g_quark_from_static_string ("ContactAttributeInterfaces");
}
g_return_if_fail (object != NULL);
if (name == q[MIXIN_DP_CONTACT_ATTRIBUTE_INTERFACES])
{
gchar **interfaces;
GHashTableIter iter;
gpointer key;
int i = 0;
g_assert (G_VALUE_HOLDS(value, G_TYPE_STRV));
/* FIXME, cache this when connected ? */
interfaces = g_malloc0(
(g_hash_table_size (self->priv->interfaces) + 1) * sizeof (gchar *));
g_hash_table_iter_init (&iter, self->priv->interfaces);
while (g_hash_table_iter_next (&iter, &key, NULL))
{
interfaces[i] = g_strdup ((gchar *) key);
i++;
}
g_value_take_boxed (value, interfaces);
}
else
{
g_assert_not_reached ();
}
}
/**
* tp_contacts_mixin_class_get_offset_quark:
*
* <!--no documentation beyond Returns: needed-->
*
* Returns: the quark used for storing mixin offset on a GObjectClass
*
* Since: 0.7.14
*
*/
GQuark
tp_contacts_mixin_class_get_offset_quark ()
{
static GQuark offset_quark = 0;
if (G_UNLIKELY (offset_quark == 0))
offset_quark = g_quark_from_static_string (
"TpContactsMixinClassOffsetQuark");
return offset_quark;
}
/**
* tp_contacts_mixin_get_offset_quark:
*
* <!--no documentation beyond Returns: needed-->
*
* Returns: the quark used for storing mixin offset on a GObject
*
* Since: 0.7.14
*
*/
GQuark
tp_contacts_mixin_get_offset_quark ()
{
static GQuark offset_quark = 0;
if (G_UNLIKELY (offset_quark == 0))
offset_quark = g_quark_from_static_string ("TpContactsMixinOffsetQuark");
return offset_quark;
}
/**
* tp_contacts_mixin_class_init:
* @obj_cls: The class of the implementation that uses this mixin
* @offset: The byte offset of the TpContactsMixinClass within the class
* structure
*
* Initialize the contacts mixin. Should be called from the implementation's
* class_init function like so:
*
* <informalexample><programlisting>
* tp_contacts_mixin_class_init ((GObjectClass *) klass,
* G_STRUCT_OFFSET (SomeObjectClass, contacts_mixin));
* </programlisting></informalexample>
*
* Since: 0.7.14
*
*/
void
tp_contacts_mixin_class_init (GObjectClass *obj_cls, glong offset)
{
g_assert (G_IS_OBJECT_CLASS (obj_cls));
g_type_set_qdata (G_OBJECT_CLASS_TYPE (obj_cls),
TP_CONTACTS_MIXIN_CLASS_OFFSET_QUARK,
GINT_TO_POINTER (offset));
tp_dbus_properties_mixin_implement_interface (obj_cls,
TP_IFACE_QUARK_CONNECTION_INTERFACE_CONTACTS,
tp_presence_mixin_get_contacts_dbus_property,
NULL, known_contacts_props);
}
/**
* tp_contacts_mixin_init:
* @obj: An instance of the implementation that uses this mixin
* @offset: The byte offset of the TpContactsMixin within the object structure
*
* Initialize the contacts mixin. Should be called from the implementation's
* instance init function like so:
*
* <informalexample><programlisting>
* tp_contacts_mixin_init ((GObject *) self,
* G_STRUCT_OFFSET (SomeObject, contacts_mixin));
* </programlisting></informalexample>
*
* Since: 0.7.14
*
*/
void
tp_contacts_mixin_init (GObject *obj, gsize offset)
{
TpContactsMixin *mixin;
g_assert (G_IS_OBJECT (obj));
g_type_set_qdata (G_OBJECT_TYPE (obj),
TP_CONTACTS_MIXIN_OFFSET_QUARK,
GSIZE_TO_POINTER (offset));
mixin = TP_CONTACTS_MIXIN (obj);
mixin->priv = g_slice_new0 (TpContactsMixinPrivate);
mixin->priv->interfaces = g_hash_table_new_full (g_str_hash, g_str_equal,
g_free, NULL);
}
/**
* tp_contacts_mixin_finalize:
* @obj: An object with this mixin.
*
* Free resources held by the contacts mixin.
*
* Since: 0.7.14
*
*/
void
tp_contacts_mixin_finalize (GObject *obj)
{
TpContactsMixin *mixin = TP_CONTACTS_MIXIN (obj);
DEBUG ("%p", obj);
/* free any data held directly by the object here */
g_hash_table_destroy (mixin->priv->interfaces);
g_slice_free (TpContactsMixinPrivate, mixin->priv);
}
static void
tp_contacts_mixin_get_contact_attributes (
TpSvcConnectionInterfaceContacts *iface, const GArray *handles,
const char **interfaces, gboolean hold, DBusGMethodInvocation *context)
{
TpContactsMixin *self = TP_CONTACTS_MIXIN (iface);
GHashTable *result;
guint i;
TpBaseConnection *conn = TP_BASE_CONNECTION (iface);
TpHandleRepoIface *contact_repo = tp_base_connection_get_handles (conn,
TP_HANDLE_TYPE_CONTACT);
GArray *valid_handles;
TpContactsMixinFillContactAttributesFunc func;
TP_BASE_CONNECTION_ERROR_IF_NOT_CONNECTED (conn, context);
/* Setup handle array and hash with valid handles, optionally holding them */
valid_handles = g_array_sized_new (TRUE, TRUE, sizeof (TpHandle),
handles->len);
result = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL,
(GDestroyNotify) g_hash_table_destroy);
for (i = 0 ; i < handles->len ; i++)
{
TpHandle h;
h = g_array_index (handles, TpHandle, i);
if (tp_handle_is_valid (contact_repo, h, NULL))
{
GHashTable *attr_hash = g_hash_table_new_full (g_str_hash,
g_str_equal, g_free, (GDestroyNotify) tp_g_value_slice_free);
g_array_append_val (valid_handles, h);
g_hash_table_insert (result, GUINT_TO_POINTER(h), attr_hash);
}
}
if (hold)
{
gchar *sender = dbus_g_method_get_sender (context);
tp_handles_client_hold (contact_repo, sender, valid_handles, NULL);
g_free (sender);
}
/* ensure the handles don't disappear while calling out to various functions
*/
tp_handles_ref (contact_repo, valid_handles);
func = g_hash_table_lookup (self->priv->interfaces, TP_IFACE_CONNECTION);
if (func != NULL)
func (G_OBJECT (iface), valid_handles, result);
for (i = 0; interfaces[i] != NULL; i++)
{
func = g_hash_table_lookup (self->priv->interfaces, interfaces[i]);
if (func == NULL)
DEBUG ("non-inspectable interface %s given; ignoring", interfaces[i]);
else
func (G_OBJECT(iface), valid_handles, result);
}
tp_svc_connection_interface_contacts_return_from_get_contact_attributes (
context, result);
g_hash_table_destroy (result);
tp_handles_unref (contact_repo, valid_handles);
g_array_free (valid_handles, TRUE);
}
/**
* tp_contacts_mixin_iface_init:
* @g_iface: A pointer to the #TpSvcConnectionInterfaceContacts in an object
* class
* @iface_data: Ignored
*
* Fill in the vtable entries needed to implement the contacts interface
* using this mixin. This function should usually be called via
* G_IMPLEMENT_INTERFACE.
*
* Since: 0.7.14
*
*/
void
tp_contacts_mixin_iface_init (gpointer g_iface, gpointer iface_data)
{
TpSvcConnectionInterfaceContactsClass *klass =
(TpSvcConnectionInterfaceContactsClass *) g_iface;
#define IMPLEMENT(x) tp_svc_connection_interface_contacts_implement_##x ( \
klass, tp_contacts_mixin_##x)
IMPLEMENT(get_contact_attributes);
#undef IMPLEMENT
}
/**
* tp_contacts_mixin_add_contact_attributes_iface:
* @obj: An instance of the implementation that uses this mixin
* @interface: Name of the interface that has ContactAttributes
* @fill_contact_attributes: Contact attribute filler function
*
* Declare that the given interface has contact attributes which can be added
* to the attributes hash using the filler function. All the handles in the
* handle array passed to the filler function are guaranteed to be valid and
* referenced.
*
* Since: 0.7.14
*
*/
void
tp_contacts_mixin_add_contact_attributes_iface (GObject *obj,
const gchar *interface,
TpContactsMixinFillContactAttributesFunc fill_contact_attributes)
{
TpContactsMixin *self = TP_CONTACTS_MIXIN (obj);
g_assert (g_hash_table_lookup (self->priv->interfaces, interface) == NULL);
g_assert (fill_contact_attributes != NULL);
g_hash_table_insert (self->priv->interfaces, g_strdup (interface),
fill_contact_attributes);
}
/**
* tp_contacts_mixin_set_contact_attribute:
* @contact_attributes: contacts attribute hash as passed to
* TpContactsMixinFillContactAttributesFunc
* @handle: Handle to set the attribute on
* @attribute: attribute name
* @value: slice allocated GValue containing the value of the attribute, for
* instance with tp_g_value_slice_new. Ownership of the GValue is taken over by
* the mixin
*
* Utility function to set attribute for handle to value in the attributes hash
* as passed to a TpContactsMixinFillContactAttributesFunc.
*
* Since: 0.7.14
*
*/
void
tp_contacts_mixin_set_contact_attribute (GHashTable *contact_attributes,
TpHandle handle, const gchar *attribute, GValue *value)
{
GHashTable *attributes;
attributes = g_hash_table_lookup (contact_attributes,
GUINT_TO_POINTER (handle));
g_assert (attributes != NULL);
g_assert (G_IS_VALUE (value));
g_hash_table_insert (attributes, g_strdup (attribute), value);
}
|