1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2004 Imendio AB
4 * Copyright (C) 2007-2008 Collabora Ltd.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
21 * Authors: Mikael Hallendal <micke@imendio.com>
22 * Martyn Russell <martyn@imendio.com>
23 * Xavier Claessens <xclaesse@gmail.com>
30 #include <glib/gi18n.h>
32 #include <telepathy-glib/util.h>
34 #include "empathy-contact.h"
35 #include "empathy-utils.h"
36 #include "empathy-debug.h"
37 #include "empathy-enum-types.h"
39 #define DEBUG_DOMAIN "Contact"
41 #define GET_PRIV(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EMPATHY_TYPE_CONTACT, EmpathyContactPriv))
43 typedef struct _EmpathyContactPriv EmpathyContactPriv;
45 struct _EmpathyContactPriv {
48 EmpathyAvatar *avatar;
51 gchar *presence_message;
53 EmpathyCapabilities capabilities;
56 EmpathyContactReady ready;
59 static void empathy_contact_class_init (EmpathyContactClass *class);
60 static void empathy_contact_init (EmpathyContact *contact);
61 static void contact_finalize (GObject *object);
62 static void contact_get_property (GObject *object,
66 static void contact_set_property (GObject *object,
71 G_DEFINE_TYPE (EmpathyContact, empathy_contact, G_TYPE_OBJECT);
80 PROP_PRESENCE_MESSAGE,
88 empathy_contact_class_init (EmpathyContactClass *class)
90 GObjectClass *object_class;
92 object_class = G_OBJECT_CLASS (class);
94 object_class->finalize = contact_finalize;
95 object_class->get_property = contact_get_property;
96 object_class->set_property = contact_set_property;
98 g_object_class_install_property (object_class,
100 g_param_spec_string ("id",
102 "String identifying contact",
106 g_object_class_install_property (object_class,
108 g_param_spec_string ("name",
110 "The name of the contact",
114 g_object_class_install_property (object_class,
116 g_param_spec_boxed ("avatar",
122 g_object_class_install_property (object_class,
124 g_param_spec_object ("account",
126 "The account associated with the contact",
130 g_object_class_install_property (object_class,
132 g_param_spec_uint ("presence",
134 "Presence of contact",
140 g_object_class_install_property (object_class,
141 PROP_PRESENCE_MESSAGE,
142 g_param_spec_string ("presence-message",
143 "Contact presence message",
144 "Presence message of contact",
147 g_object_class_install_property (object_class,
149 g_param_spec_uint ("handle",
151 "The handle of the contact",
157 g_object_class_install_property (object_class,
159 g_param_spec_flags ("capabilities",
160 "Contact Capabilities",
161 "Capabilities of the contact",
162 EMPATHY_TYPE_CAPABILITIES,
163 EMPATHY_CAPABILITIES_UNKNOWN,
164 G_PARAM_CONSTRUCT | G_PARAM_READWRITE));
166 g_object_class_install_property (object_class,
168 g_param_spec_boolean ("is-user",
170 "Is contact the user",
174 g_object_class_install_property (object_class,
176 g_param_spec_flags ("ready",
177 "Contact ready flags",
178 "Flags for ready properties",
179 EMPATHY_TYPE_CONTACT_READY,
180 EMPATHY_CONTACT_READY_NONE,
183 g_type_class_add_private (object_class, sizeof (EmpathyContactPriv));
187 empathy_contact_init (EmpathyContact *contact)
192 contact_finalize (GObject *object)
194 EmpathyContactPriv *priv;
196 priv = GET_PRIV (object);
198 empathy_debug (DEBUG_DOMAIN, "finalize: %p", object);
202 g_free (priv->presence_message);
205 empathy_avatar_unref (priv->avatar);
209 g_object_unref (priv->account);
212 G_OBJECT_CLASS (empathy_contact_parent_class)->finalize (object);
216 contact_get_property (GObject *object,
221 EmpathyContactPriv *priv;
223 priv = GET_PRIV (object);
227 g_value_set_string (value, priv->id);
230 g_value_set_string (value,
231 empathy_contact_get_name (EMPATHY_CONTACT (object)));
234 g_value_set_boxed (value, priv->avatar);
237 g_value_set_object (value, priv->account);
240 g_value_set_uint (value, priv->presence);
242 case PROP_PRESENCE_MESSAGE:
243 g_value_set_string (value, priv->presence_message);
246 g_value_set_uint (value, priv->handle);
248 case PROP_CAPABILITIES:
249 g_value_set_flags (value, priv->capabilities);
252 g_value_set_boolean (value, priv->is_user);
255 g_value_set_flags (value, priv->ready);
258 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
264 contact_set_property (GObject *object,
269 EmpathyContactPriv *priv;
271 priv = GET_PRIV (object);
275 empathy_contact_set_id (EMPATHY_CONTACT (object),
276 g_value_get_string (value));
279 empathy_contact_set_name (EMPATHY_CONTACT (object),
280 g_value_get_string (value));
283 empathy_contact_set_avatar (EMPATHY_CONTACT (object),
284 g_value_get_boxed (value));
287 empathy_contact_set_account (EMPATHY_CONTACT (object),
288 MC_ACCOUNT (g_value_get_object (value)));
291 empathy_contact_set_presence (EMPATHY_CONTACT (object),
292 g_value_get_uint (value));
294 case PROP_PRESENCE_MESSAGE:
295 empathy_contact_set_presence_message (EMPATHY_CONTACT (object),
296 g_value_get_string (value));
299 empathy_contact_set_handle (EMPATHY_CONTACT (object),
300 g_value_get_uint (value));
302 case PROP_CAPABILITIES:
303 empathy_contact_set_capabilities (EMPATHY_CONTACT (object),
304 g_value_get_flags (value));
307 empathy_contact_set_is_user (EMPATHY_CONTACT (object),
308 g_value_get_boolean (value));
311 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
317 contact_set_ready_flag (EmpathyContact *contact,
318 EmpathyContactReady flag)
320 EmpathyContactPriv *priv = GET_PRIV (contact);
322 if (!(priv->ready & flag)) {
324 g_object_notify (G_OBJECT (contact), "ready");
329 empathy_contact_new (McAccount *account)
331 return g_object_new (EMPATHY_TYPE_CONTACT,
337 empathy_contact_new_full (McAccount *account,
341 return g_object_new (EMPATHY_TYPE_CONTACT,
349 empathy_contact_get_id (EmpathyContact *contact)
351 EmpathyContactPriv *priv;
353 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
355 priv = GET_PRIV (contact);
361 empathy_contact_set_id (EmpathyContact *contact,
364 EmpathyContactPriv *priv;
366 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
367 g_return_if_fail (id != NULL);
369 priv = GET_PRIV (contact);
371 /* We temporally ref the contact because it could be destroyed
372 * during the signal emition */
373 g_object_ref (contact);
374 contact_set_ready_flag (contact, EMPATHY_CONTACT_READY_ID);
375 if (tp_strdiff (id, priv->id)) {
377 priv->id = g_strdup (id);
379 g_object_notify (G_OBJECT (contact), "id");
380 if (G_STR_EMPTY (priv->name)) {
381 g_object_notify (G_OBJECT (contact), "name");
385 g_object_unref (contact);
389 empathy_contact_get_name (EmpathyContact *contact)
391 EmpathyContactPriv *priv;
393 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
395 priv = GET_PRIV (contact);
397 if (G_STR_EMPTY (priv->name)) {
398 return empathy_contact_get_id (contact);
405 empathy_contact_set_name (EmpathyContact *contact,
408 EmpathyContactPriv *priv;
410 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
412 priv = GET_PRIV (contact);
414 g_object_ref (contact);
415 contact_set_ready_flag (contact, EMPATHY_CONTACT_READY_NAME);
416 if (tp_strdiff (name, priv->name)) {
418 priv->name = g_strdup (name);
419 g_object_notify (G_OBJECT (contact), "name");
421 g_object_unref (contact);
425 empathy_contact_get_avatar (EmpathyContact *contact)
427 EmpathyContactPriv *priv;
429 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
431 priv = GET_PRIV (contact);
437 empathy_contact_set_avatar (EmpathyContact *contact,
438 EmpathyAvatar *avatar)
440 EmpathyContactPriv *priv;
442 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
444 priv = GET_PRIV (contact);
446 if (priv->avatar == avatar) {
451 empathy_avatar_unref (priv->avatar);
456 priv->avatar = empathy_avatar_ref (avatar);
459 g_object_notify (G_OBJECT (contact), "avatar");
463 empathy_contact_get_account (EmpathyContact *contact)
465 EmpathyContactPriv *priv;
467 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
469 priv = GET_PRIV (contact);
471 return priv->account;
475 empathy_contact_set_account (EmpathyContact *contact,
478 EmpathyContactPriv *priv;
480 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
481 g_return_if_fail (MC_IS_ACCOUNT (account));
483 priv = GET_PRIV (contact);
485 if (account == priv->account) {
490 g_object_unref (priv->account);
492 priv->account = g_object_ref (account);
494 g_object_notify (G_OBJECT (contact), "account");
498 empathy_contact_get_presence (EmpathyContact *contact)
500 EmpathyContactPriv *priv;
502 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), MC_PRESENCE_UNSET);
504 priv = GET_PRIV (contact);
506 return priv->presence;
510 empathy_contact_set_presence (EmpathyContact *contact,
513 EmpathyContactPriv *priv;
515 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
517 priv = GET_PRIV (contact);
519 if (presence == priv->presence) {
523 priv->presence = presence;
525 g_object_notify (G_OBJECT (contact), "presence");
529 empathy_contact_get_presence_message (EmpathyContact *contact)
531 EmpathyContactPriv *priv;
533 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
535 priv = GET_PRIV (contact);
537 return priv->presence_message;
541 empathy_contact_set_presence_message (EmpathyContact *contact,
542 const gchar *message)
544 EmpathyContactPriv *priv = GET_PRIV (contact);
546 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
548 if (!tp_strdiff (message, priv->presence_message)) {
552 g_free (priv->presence_message);
553 priv->presence_message = g_strdup (message);
555 g_object_notify (G_OBJECT (contact), "presence-message");
559 empathy_contact_get_handle (EmpathyContact *contact)
561 EmpathyContactPriv *priv;
563 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
565 priv = GET_PRIV (contact);
571 empathy_contact_set_handle (EmpathyContact *contact,
574 EmpathyContactPriv *priv;
576 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
578 priv = GET_PRIV (contact);
580 g_object_ref (contact);
581 contact_set_ready_flag (contact, EMPATHY_CONTACT_READY_HANDLE);
582 if (handle != priv->handle) {
583 priv->handle = handle;
584 g_object_notify (G_OBJECT (contact), "handle");
586 g_object_unref (contact);
590 empathy_contact_get_capabilities (EmpathyContact *contact)
592 EmpathyContactPriv *priv;
594 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
596 priv = GET_PRIV (contact);
598 return priv->capabilities;
602 empathy_contact_set_capabilities (EmpathyContact *contact,
603 EmpathyCapabilities capabilities)
605 EmpathyContactPriv *priv;
607 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
609 priv = GET_PRIV (contact);
611 if (priv->capabilities == capabilities) {
615 priv->capabilities = capabilities;
617 g_object_notify (G_OBJECT (contact), "capabilities");
621 empathy_contact_is_user (EmpathyContact *contact)
623 EmpathyContactPriv *priv;
625 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
627 priv = GET_PRIV (contact);
629 return priv->is_user;
633 empathy_contact_set_is_user (EmpathyContact *contact,
636 EmpathyContactPriv *priv;
638 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
640 priv = GET_PRIV (contact);
642 if (priv->is_user == is_user) {
646 priv->is_user = is_user;
648 g_object_notify (G_OBJECT (contact), "is-user");
652 empathy_contact_is_online (EmpathyContact *contact)
654 EmpathyContactPriv *priv;
656 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
658 priv = GET_PRIV (contact);
660 return (priv->presence > MC_PRESENCE_OFFLINE);
664 empathy_contact_get_status (EmpathyContact *contact)
666 EmpathyContactPriv *priv;
668 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), "");
670 priv = GET_PRIV (contact);
672 if (priv->presence_message) {
673 return priv->presence_message;
676 return empathy_presence_get_default_message (priv->presence);
680 empathy_contact_can_voip (EmpathyContact *contact)
682 EmpathyContactPriv *priv;
684 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
686 priv = GET_PRIV (contact);
688 return priv->capabilities & (EMPATHY_CAPABILITIES_AUDIO |
689 EMPATHY_CAPABILITIES_VIDEO);
693 empathy_contact_get_ready (EmpathyContact *contact)
695 EmpathyContactPriv *priv;
697 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
699 priv = GET_PRIV (contact);
705 empathy_contact_equal (gconstpointer v1,
708 McAccount *account_a;
709 McAccount *account_b;
713 g_return_val_if_fail (EMPATHY_IS_CONTACT (v1), FALSE);
714 g_return_val_if_fail (EMPATHY_IS_CONTACT (v2), FALSE);
716 account_a = empathy_contact_get_account (EMPATHY_CONTACT (v1));
717 account_b = empathy_contact_get_account (EMPATHY_CONTACT (v2));
719 id_a = empathy_contact_get_id (EMPATHY_CONTACT (v1));
720 id_b = empathy_contact_get_id (EMPATHY_CONTACT (v2));
722 return empathy_account_equal (account_a, account_b) && g_str_equal (id_a, id_b);
726 empathy_contact_hash (gconstpointer key)
728 EmpathyContactPriv *priv;
730 g_return_val_if_fail (EMPATHY_IS_CONTACT (key), +1);
732 priv = GET_PRIV (EMPATHY_CONTACT (key));
734 if (priv->hash == 0) {
735 priv->hash = empathy_account_hash (priv->account) + g_str_hash (priv->id);
742 contact_is_ready_func (GObject *contact,
745 EmpathyContactPriv *priv = GET_PRIV (contact);
746 EmpathyContactReady ready;
748 ready = GPOINTER_TO_UINT (user_data);
750 return (priv->ready & ready) == ready;
754 empathy_contact_run_until_ready (EmpathyContact *contact,
755 EmpathyContactReady ready,
758 empathy_run_until_ready_full (contact, "notify::ready",
759 contact_is_ready_func, GUINT_TO_POINTER (ready),