1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
3 * Copyright (C) 2007-2009 Collabora Ltd.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Authors: Xavier Claessens <xclaesse@gmail.com>
20 * Sjoerd Simons <sjoerd.simons@collabora.co.uk>
27 #include <glib/gi18n-lib.h>
29 #include <telepathy-glib/util.h>
30 #include <libmissioncontrol/mc-enum-types.h>
32 #include "empathy-contact.h"
33 #include "empathy-account-manager.h"
34 #include "empathy-utils.h"
35 #include "empathy-enum-types.h"
36 #include "empathy-marshal.h"
38 #define DEBUG_FLAG EMPATHY_DEBUG_CONTACT
39 #include "empathy-debug.h"
41 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyContact)
43 TpContact *tp_contact;
47 EmpathyAvatar *avatar;
49 gchar *presence_message;
51 EmpathyCapabilities capabilities;
56 static void contact_finalize (GObject *object);
57 static void contact_get_property (GObject *object, guint param_id,
58 GValue *value, GParamSpec *pspec);
59 static void contact_set_property (GObject *object, guint param_id,
60 const GValue *value, GParamSpec *pspec);
62 G_DEFINE_TYPE (EmpathyContact, empathy_contact, G_TYPE_OBJECT);
73 PROP_PRESENCE_MESSAGE,
84 static guint signals[LAST_SIGNAL];
87 tp_contact_notify_cb (TpContact *tp_contact,
91 EmpathyContactPriv *priv = GET_PRIV (contact);
93 /* Forward property notifications */
94 if (!tp_strdiff (param->name, "alias"))
95 g_object_notify (contact, "name");
96 else if (!tp_strdiff (param->name, "presence-type")) {
99 presence = empathy_contact_get_presence (EMPATHY_CONTACT (contact));
100 g_signal_emit (contact, signals[PRESENCE_CHANGED], 0, presence, priv->presence);
101 priv->presence = presence;
102 g_object_notify (contact, "presence");
104 else if (!tp_strdiff (param->name, "presence-message"))
105 g_object_notify (contact, "presence-message");
106 else if (!tp_strdiff (param->name, "identifier"))
107 g_object_notify (contact, "id");
108 else if (!tp_strdiff (param->name, "handle"))
109 g_object_notify (contact, "handle");
113 contact_dispose (GObject *object)
115 EmpathyContactPriv *priv = GET_PRIV (object);
117 if (priv->tp_contact)
119 g_signal_handlers_disconnect_by_func (priv->tp_contact,
120 tp_contact_notify_cb, object);
121 g_object_unref (priv->tp_contact);
123 priv->tp_contact = NULL;
126 g_object_unref (priv->account);
127 priv->account = NULL;
129 G_OBJECT_CLASS (empathy_contact_parent_class)->dispose (object);
133 empathy_contact_class_init (EmpathyContactClass *class)
135 GObjectClass *object_class;
137 object_class = G_OBJECT_CLASS (class);
139 object_class->finalize = contact_finalize;
140 object_class->dispose = contact_dispose;
141 object_class->get_property = contact_get_property;
142 object_class->set_property = contact_set_property;
144 g_object_class_install_property (object_class,
146 g_param_spec_object ("tp-contact",
148 "The TpContact associated with the contact",
150 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READABLE));
152 g_object_class_install_property (object_class,
154 g_param_spec_object ("account",
156 "The account associated with the contact",
158 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READABLE));
160 g_object_class_install_property (object_class,
162 g_param_spec_string ("id",
164 "String identifying contact",
168 g_object_class_install_property (object_class,
170 g_param_spec_string ("name",
172 "The name of the contact",
176 g_object_class_install_property (object_class,
178 g_param_spec_boxed ("avatar",
184 g_object_class_install_property (object_class,
186 g_param_spec_uint ("presence",
188 "Presence of contact",
194 g_object_class_install_property (object_class,
195 PROP_PRESENCE_MESSAGE,
196 g_param_spec_string ("presence-message",
197 "Contact presence message",
198 "Presence message of contact",
202 g_object_class_install_property (object_class,
204 g_param_spec_uint ("handle",
206 "The handle of the contact",
212 g_object_class_install_property (object_class,
214 g_param_spec_flags ("capabilities",
215 "Contact Capabilities",
216 "Capabilities of the contact",
217 EMPATHY_TYPE_CAPABILITIES,
218 EMPATHY_CAPABILITIES_UNKNOWN,
219 G_PARAM_CONSTRUCT | G_PARAM_READWRITE));
221 g_object_class_install_property (object_class,
223 g_param_spec_boolean ("is-user",
225 "Is contact the user",
229 signals[PRESENCE_CHANGED] =
230 g_signal_new ("presence-changed",
231 G_TYPE_FROM_CLASS (class),
235 _empathy_marshal_VOID__ENUM_ENUM,
240 g_type_class_add_private (object_class, sizeof (EmpathyContactPriv));
244 empathy_contact_init (EmpathyContact *contact)
246 EmpathyContactPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (contact,
247 EMPATHY_TYPE_CONTACT, EmpathyContactPriv);
249 contact->priv = priv;
253 contact_finalize (GObject *object)
255 EmpathyContactPriv *priv;
257 priv = GET_PRIV (object);
259 DEBUG ("finalize: %p", object);
263 g_free (priv->presence_message);
266 empathy_avatar_unref (priv->avatar);
268 G_OBJECT_CLASS (empathy_contact_parent_class)->finalize (object);
272 set_tp_contact (EmpathyContact *contact,
273 TpContact *tp_contact)
275 EmpathyContactPriv *priv = GET_PRIV (contact);
277 g_assert (priv->tp_contact == NULL);
278 priv->tp_contact = g_object_ref (tp_contact);
279 priv->presence = empathy_contact_get_presence (contact);
281 g_signal_connect (priv->tp_contact, "notify",
282 G_CALLBACK (tp_contact_notify_cb), contact);
286 contact_get_property (GObject *object,
291 EmpathyContact *contact = EMPATHY_CONTACT (object);
295 case PROP_TP_CONTACT:
296 g_value_set_object (value, empathy_contact_get_tp_contact (contact));
299 g_value_set_object (value, empathy_contact_get_account (contact));
302 g_value_set_string (value, empathy_contact_get_id (contact));
305 g_value_set_string (value, empathy_contact_get_name (contact));
308 g_value_set_boxed (value, empathy_contact_get_avatar (contact));
311 g_value_set_uint (value, empathy_contact_get_presence (contact));
313 case PROP_PRESENCE_MESSAGE:
314 g_value_set_string (value, empathy_contact_get_presence_message (contact));
317 g_value_set_uint (value, empathy_contact_get_handle (contact));
319 case PROP_CAPABILITIES:
320 g_value_set_flags (value, empathy_contact_get_capabilities (contact));
323 g_value_set_boolean (value, empathy_contact_is_user (contact));
326 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
332 contact_set_property (GObject *object,
337 EmpathyContact *contact = EMPATHY_CONTACT (object);
338 EmpathyContactPriv *priv = GET_PRIV (object);
342 case PROP_TP_CONTACT:
343 set_tp_contact (contact, g_value_get_object (value));
346 g_assert (priv->account == NULL);
347 priv->account = g_value_dup_object (value);
350 empathy_contact_set_id (contact, g_value_get_string (value));
353 empathy_contact_set_name (contact, g_value_get_string (value));
356 empathy_contact_set_avatar (contact, g_value_get_boxed (value));
359 empathy_contact_set_presence (contact, g_value_get_uint (value));
361 case PROP_PRESENCE_MESSAGE:
362 empathy_contact_set_presence_message (contact, g_value_get_string (value));
365 empathy_contact_set_handle (contact, g_value_get_uint (value));
367 case PROP_CAPABILITIES:
368 empathy_contact_set_capabilities (contact, g_value_get_flags (value));
371 empathy_contact_set_is_user (contact, g_value_get_boolean (value));
374 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
380 empathy_contact_new (TpContact *tp_contact)
382 return g_object_new (EMPATHY_TYPE_CONTACT,
383 "tp-contact", tp_contact,
388 empathy_contact_get_tp_contact (EmpathyContact *contact)
390 EmpathyContactPriv *priv;
392 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
394 priv = GET_PRIV (contact);
396 return priv->tp_contact;
400 empathy_contact_get_id (EmpathyContact *contact)
402 EmpathyContactPriv *priv;
404 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
406 priv = GET_PRIV (contact);
408 if (priv->tp_contact != NULL)
409 return tp_contact_get_identifier (priv->tp_contact);
415 empathy_contact_set_id (EmpathyContact *contact,
418 EmpathyContactPriv *priv;
420 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
421 g_return_if_fail (id != NULL);
423 priv = GET_PRIV (contact);
425 /* We temporally ref the contact because it could be destroyed
426 * during the signal emition */
427 g_object_ref (contact);
428 if (tp_strdiff (id, priv->id))
431 priv->id = g_strdup (id);
433 g_object_notify (G_OBJECT (contact), "id");
434 if (EMP_STR_EMPTY (priv->name))
435 g_object_notify (G_OBJECT (contact), "name");
438 g_object_unref (contact);
442 empathy_contact_get_name (EmpathyContact *contact)
444 EmpathyContactPriv *priv;
446 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
448 priv = GET_PRIV (contact);
450 if (priv->tp_contact != NULL)
451 return tp_contact_get_alias (priv->tp_contact);
453 if (EMP_STR_EMPTY (priv->name))
454 return empathy_contact_get_id (contact);
460 empathy_contact_set_name (EmpathyContact *contact,
463 EmpathyContactPriv *priv;
465 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
467 priv = GET_PRIV (contact);
469 g_object_ref (contact);
470 if (tp_strdiff (name, priv->name))
473 priv->name = g_strdup (name);
474 g_object_notify (G_OBJECT (contact), "name");
476 g_object_unref (contact);
480 empathy_contact_get_avatar (EmpathyContact *contact)
482 EmpathyContactPriv *priv;
484 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
486 priv = GET_PRIV (contact);
492 empathy_contact_set_avatar (EmpathyContact *contact,
493 EmpathyAvatar *avatar)
495 EmpathyContactPriv *priv;
497 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
499 priv = GET_PRIV (contact);
501 if (priv->avatar == avatar)
506 empathy_avatar_unref (priv->avatar);
511 priv->avatar = empathy_avatar_ref (avatar);
513 g_object_notify (G_OBJECT (contact), "avatar");
517 empathy_contact_get_account (EmpathyContact *contact)
519 EmpathyContactPriv *priv;
521 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
523 priv = GET_PRIV (contact);
525 if (priv->account != NULL)
526 return priv->account;
528 if (priv->tp_contact != NULL)
530 EmpathyAccountManager *manager;
531 TpConnection *connection;
533 /* FIXME: This assume the account manager already exists */
534 manager = empathy_account_manager_dup_singleton ();
535 connection = tp_contact_get_connection (priv->tp_contact);
536 priv->account = empathy_account_manager_get_account (manager, connection);
537 g_object_unref (manager);
539 return g_object_ref (priv->account);
546 empathy_contact_get_connection (EmpathyContact *contact)
548 EmpathyContactPriv *priv;
550 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
552 priv = GET_PRIV (contact);
554 if (priv->tp_contact != NULL)
555 return tp_contact_get_connection (priv->tp_contact);
561 presence_type_to_mc_presence (TpConnectionPresenceType type)
565 case TP_CONNECTION_PRESENCE_TYPE_UNSET:
566 case TP_CONNECTION_PRESENCE_TYPE_UNKNOWN:
567 case TP_CONNECTION_PRESENCE_TYPE_ERROR:
568 return MC_PRESENCE_UNSET;
569 case TP_CONNECTION_PRESENCE_TYPE_OFFLINE:
570 return MC_PRESENCE_OFFLINE;
571 case TP_CONNECTION_PRESENCE_TYPE_AVAILABLE:
572 return MC_PRESENCE_AVAILABLE;
573 case TP_CONNECTION_PRESENCE_TYPE_AWAY:
574 return MC_PRESENCE_AWAY;
575 case TP_CONNECTION_PRESENCE_TYPE_EXTENDED_AWAY:
576 return MC_PRESENCE_EXTENDED_AWAY;
577 case TP_CONNECTION_PRESENCE_TYPE_HIDDEN:
578 return MC_PRESENCE_HIDDEN;
579 case TP_CONNECTION_PRESENCE_TYPE_BUSY:
580 return MC_PRESENCE_DO_NOT_DISTURB;
583 return MC_PRESENCE_UNSET;
587 empathy_contact_get_presence (EmpathyContact *contact)
589 EmpathyContactPriv *priv;
591 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), MC_PRESENCE_UNSET);
593 priv = GET_PRIV (contact);
595 if (priv->tp_contact != NULL)
596 return presence_type_to_mc_presence (tp_contact_get_presence_type (
599 return priv->presence;
603 empathy_contact_set_presence (EmpathyContact *contact,
606 EmpathyContactPriv *priv;
607 McPresence old_presence;
609 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
611 priv = GET_PRIV (contact);
613 if (presence == priv->presence)
616 old_presence = priv->presence;
617 priv->presence = presence;
619 g_signal_emit (contact, signals[PRESENCE_CHANGED], 0, presence, old_presence);
621 g_object_notify (G_OBJECT (contact), "presence");
625 empathy_contact_get_presence_message (EmpathyContact *contact)
627 EmpathyContactPriv *priv;
629 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
631 priv = GET_PRIV (contact);
633 if (priv->tp_contact != NULL)
634 return tp_contact_get_presence_message (priv->tp_contact);
636 return priv->presence_message;
640 empathy_contact_set_presence_message (EmpathyContact *contact,
641 const gchar *message)
643 EmpathyContactPriv *priv = GET_PRIV (contact);
645 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
647 if (!tp_strdiff (message, priv->presence_message))
650 g_free (priv->presence_message);
651 priv->presence_message = g_strdup (message);
653 g_object_notify (G_OBJECT (contact), "presence-message");
657 empathy_contact_get_handle (EmpathyContact *contact)
659 EmpathyContactPriv *priv;
661 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
663 priv = GET_PRIV (contact);
665 if (priv->tp_contact != NULL)
666 return tp_contact_get_handle (priv->tp_contact);
672 empathy_contact_set_handle (EmpathyContact *contact,
675 EmpathyContactPriv *priv;
677 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
679 priv = GET_PRIV (contact);
681 g_object_ref (contact);
682 if (handle != priv->handle)
684 priv->handle = handle;
685 g_object_notify (G_OBJECT (contact), "handle");
687 g_object_unref (contact);
691 empathy_contact_get_capabilities (EmpathyContact *contact)
693 EmpathyContactPriv *priv;
695 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
697 priv = GET_PRIV (contact);
699 return priv->capabilities;
703 empathy_contact_set_capabilities (EmpathyContact *contact,
704 EmpathyCapabilities capabilities)
706 EmpathyContactPriv *priv;
708 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
710 priv = GET_PRIV (contact);
712 if (priv->capabilities == capabilities)
715 priv->capabilities = capabilities;
717 g_object_notify (G_OBJECT (contact), "capabilities");
721 empathy_contact_is_user (EmpathyContact *contact)
723 EmpathyContactPriv *priv;
725 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
727 priv = GET_PRIV (contact);
729 return priv->is_user;
733 empathy_contact_set_is_user (EmpathyContact *contact,
736 EmpathyContactPriv *priv;
738 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
740 priv = GET_PRIV (contact);
742 if (priv->is_user == is_user)
745 priv->is_user = is_user;
747 g_object_notify (G_OBJECT (contact), "is-user");
751 empathy_contact_is_online (EmpathyContact *contact)
753 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
755 return (empathy_contact_get_presence (contact) > MC_PRESENCE_OFFLINE);
759 empathy_contact_get_status (EmpathyContact *contact)
761 const gchar *message;
763 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), "");
765 message = empathy_contact_get_presence_message (contact);
769 return empathy_presence_get_default_message (
770 empathy_contact_get_presence (contact));
774 empathy_contact_can_voip (EmpathyContact *contact)
776 EmpathyContactPriv *priv;
778 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
780 priv = GET_PRIV (contact);
782 return priv->capabilities & (EMPATHY_CAPABILITIES_AUDIO |
783 EMPATHY_CAPABILITIES_VIDEO);
787 empathy_contact_can_send_files (EmpathyContact *contact)
789 EmpathyContactPriv *priv;
791 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
793 priv = GET_PRIV (contact);
795 return priv->capabilities & EMPATHY_CAPABILITIES_FT;
799 contact_get_avatar_filename (EmpathyContact *contact,
802 EmpathyContactPriv *priv = GET_PRIV (contact);
806 gchar *token_escaped;
807 gchar *contact_escaped;
809 if (EMP_STR_EMPTY (priv->id))
812 contact_escaped = tp_escape_as_identifier (priv->id);
813 token_escaped = tp_escape_as_identifier (token);
814 account = empathy_contact_get_account (contact);
816 /* FIXME: Do not use the account, but proto/cm instead */
817 avatar_path = g_build_filename (g_get_user_cache_dir (),
820 mc_account_get_unique_name (account),
823 g_mkdir_with_parents (avatar_path, 0700);
825 avatar_file = g_build_filename (avatar_path, token_escaped, NULL);
827 g_free (contact_escaped);
828 g_free (token_escaped);
829 g_free (avatar_path);
835 empathy_contact_load_avatar_data (EmpathyContact *contact,
841 EmpathyAvatar *avatar;
843 GError *error = NULL;
845 g_return_if_fail (EMPATHY_IS_CONTACT (contact));
846 g_return_if_fail (data != NULL);
847 g_return_if_fail (len > 0);
848 g_return_if_fail (format != NULL);
849 g_return_if_fail (!EMP_STR_EMPTY (token));
851 /* Load and set the avatar */
852 avatar = empathy_avatar_new (g_memdup (data, len), len, g_strdup (format),
854 empathy_contact_set_avatar (contact, avatar);
855 empathy_avatar_unref (avatar);
857 /* Save to cache if not yet in it */
858 filename = contact_get_avatar_filename (contact, token);
859 if (filename && !g_file_test (filename, G_FILE_TEST_EXISTS))
861 if (!empathy_avatar_save_to_file (avatar, filename, &error))
863 DEBUG ("Failed to save avatar in cache: %s",
864 error ? error->message : "No error given");
865 g_clear_error (&error);
868 DEBUG ("Avatar saved to %s", filename);
874 empathy_contact_load_avatar_cache (EmpathyContact *contact,
877 EmpathyAvatar *avatar = NULL;
881 GError *error = NULL;
883 g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
884 g_return_val_if_fail (!EMP_STR_EMPTY (token), FALSE);
886 /* Load the avatar from file if it exists */
887 filename = contact_get_avatar_filename (contact, token);
888 if (filename && g_file_test (filename, G_FILE_TEST_EXISTS))
890 if (!g_file_get_contents (filename, &data, &len, &error))
892 DEBUG ("Failed to load avatar from cache: %s",
893 error ? error->message : "No error given");
894 g_clear_error (&error);
900 DEBUG ("Avatar loaded from %s", filename);
901 avatar = empathy_avatar_new (data, len, NULL, g_strdup (token));
902 empathy_contact_set_avatar (contact, avatar);
903 empathy_avatar_unref (avatar);
912 empathy_avatar_get_type (void)
914 static GType type_id = 0;
918 type_id = g_boxed_type_register_static ("EmpathyAvatar",
919 (GBoxedCopyFunc) empathy_avatar_ref,
920 (GBoxedFreeFunc) empathy_avatar_unref);
927 empathy_avatar_new (guchar *data,
932 EmpathyAvatar *avatar;
934 avatar = g_slice_new0 (EmpathyAvatar);
937 avatar->format = format;
938 avatar->token = token;
939 avatar->refcount = 1;
945 empathy_avatar_unref (EmpathyAvatar *avatar)
947 g_return_if_fail (avatar != NULL);
950 if (avatar->refcount == 0)
952 g_free (avatar->data);
953 g_free (avatar->format);
954 g_free (avatar->token);
955 g_slice_free (EmpathyAvatar, avatar);
960 empathy_avatar_ref (EmpathyAvatar *avatar)
962 g_return_val_if_fail (avatar != NULL, NULL);
970 * empathy_avatar_save_to_file:
971 * @avatar: the avatar
972 * @filename: name of a file to write avatar to
973 * @error: return location for a GError, or NULL
975 * Save the avatar to a file named filename
977 * Returns: %TRUE on success, %FALSE if an error occurred
980 empathy_avatar_save_to_file (EmpathyAvatar *self,
981 const gchar *filename,
984 return g_file_set_contents (filename, self->data, self->len, error);