libempathy/empathy-contact.c

   1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
   2 /*
   3  * Copyright (C) 2007-2009 Collabora Ltd.
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  *
  19  * Authors: Xavier Claessens <xclaesse@gmail.com>
  20  */
  21
  22 #include "config.h"
  23
  24 #include <string.h>
  25
  26 #include <glib/gi18n-lib.h>
  27
  28 #include <telepathy-glib/util.h>
  29
  30 #include "empathy-contact.h"
  31 #include "empathy-account-manager.h"
  32 #include "empathy-utils.h"
  33 #include "empathy-enum-types.h"
  34 #include "empathy-marshal.h"
  35
  36 #define DEBUG_FLAG EMPATHY_DEBUG_CONTACT
  37 #include "empathy-debug.h"
  38
  39 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyContact)
  40 typedef struct {
  41   TpContact *tp_contact;
  42   EmpathyAccount *account;
  43   gchar *id;
  44   gchar *name;
  45   EmpathyAvatar *avatar;
  46   TpConnectionPresenceType presence;
  47   gchar *presence_message;
  48   guint handle;
  49   EmpathyCapabilities capabilities;
  50   gboolean is_user;
  51   guint hash;
  52   /* Location is composed of string keys and GValues.
  53    * Example: a "city" key would have "Helsinki" as string GValue,
  54    *          a "latitude" would have 65.0 as double GValue.
  55    */
  56   GHashTable *location;
  57 } EmpathyContactPriv;
  58
  59 static void contact_finalize (GObject *object);
  60 static void contact_get_property (GObject *object, guint param_id,
  61     GValue *value, GParamSpec *pspec);
  62 static void contact_set_property (GObject *object, guint param_id,
  63     const GValue *value, GParamSpec *pspec);
  64
  65 G_DEFINE_TYPE (EmpathyContact, empathy_contact, G_TYPE_OBJECT);
  66
  67 enum
  68 {
  69   PROP_0,
  70   PROP_TP_CONTACT,
  71   PROP_ACCOUNT,
  72   PROP_ID,
  73   PROP_NAME,
  74   PROP_AVATAR,
  75   PROP_PRESENCE,
  76   PROP_PRESENCE_MESSAGE,
  77   PROP_HANDLE,
  78   PROP_CAPABILITIES,
  79   PROP_IS_USER,
  80   PROP_LOCATION
  81 };
  82
  83 enum {
  84   PRESENCE_CHANGED,
  85   LAST_SIGNAL
  86 };
  87
  88 static guint signals[LAST_SIGNAL];
  89
  90 static void
  91 tp_contact_notify_cb (TpContact *tp_contact,
  92                       GParamSpec *param,
  93                       GObject *contact)
  94 {
  95   EmpathyContactPriv *priv = GET_PRIV (contact);
  96
  97   /* Forward property notifications */
  98   if (!tp_strdiff (param->name, "alias"))
  99     g_object_notify (contact, "name");
 100   else if (!tp_strdiff (param->name, "presence-type")) {
 101     TpConnectionPresenceType presence;
 102
 103     presence = empathy_contact_get_presence (EMPATHY_CONTACT (contact));
 104     g_signal_emit (contact, signals[PRESENCE_CHANGED], 0, presence,
 105       priv->presence);
 106     priv->presence = presence;
 107     g_object_notify (contact, "presence");
 108   }
 109   else if (!tp_strdiff (param->name, "presence-message"))
 110     g_object_notify (contact, "presence-message");
 111   else if (!tp_strdiff (param->name, "identifier"))
 112     g_object_notify (contact, "id");
 113   else if (!tp_strdiff (param->name, "handle"))
 114     g_object_notify (contact, "handle");
 115 }
 116
 117 static void
 118 contact_dispose (GObject *object)
 119 {
 120   EmpathyContactPriv *priv = GET_PRIV (object);
 121
 122   if (priv->tp_contact)
 123     {
 124       g_signal_handlers_disconnect_by_func (priv->tp_contact,
 125           tp_contact_notify_cb, object);
 126       g_object_unref (priv->tp_contact);
 127     }
 128   priv->tp_contact = NULL;
 129
 130   if (priv->account)
 131     g_object_unref (priv->account);
 132   priv->account = NULL;
 133
 134   G_OBJECT_CLASS (empathy_contact_parent_class)->dispose (object);
 135 }
 136
 137 static void
 138 empathy_contact_class_init (EmpathyContactClass *class)
 139 {
 140   GObjectClass *object_class;
 141
 142   object_class = G_OBJECT_CLASS (class);
 143
 144   object_class->finalize = contact_finalize;
 145   object_class->dispose = contact_dispose;
 146   object_class->get_property = contact_get_property;
 147   object_class->set_property = contact_set_property;
 148
 149   g_object_class_install_property (object_class,
 150       PROP_TP_CONTACT,
 151       g_param_spec_object ("tp-contact",
 152         "TpContact",
 153         "The TpContact associated with the contact",
 154         TP_TYPE_CONTACT,
 155         G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 156
 157   g_object_class_install_property (object_class,
 158       PROP_ACCOUNT,
 159       g_param_spec_object ("account",
 160         "The account",
 161         "The account associated with the contact",
 162         EMPATHY_TYPE_ACCOUNT,
 163         G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 164
 165   g_object_class_install_property (object_class,
 166       PROP_ID,
 167       g_param_spec_string ("id",
 168         "Contact id",
 169         "String identifying contact",
 170         NULL,
 171         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 172
 173   g_object_class_install_property (object_class,
 174       PROP_NAME,
 175       g_param_spec_string ("name",
 176         "Contact Name",
 177         "The name of the contact",
 178         NULL,
 179         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 180
 181   g_object_class_install_property (object_class,
 182       PROP_AVATAR,
 183       g_param_spec_boxed ("avatar",
 184         "Avatar image",
 185         "The avatar image",
 186         EMPATHY_TYPE_AVATAR,
 187         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 188
 189   g_object_class_install_property (object_class,
 190       PROP_PRESENCE,
 191       g_param_spec_uint ("presence",
 192         "Contact presence",
 193         "Presence of contact",
 194         TP_CONNECTION_PRESENCE_TYPE_UNSET,
 195         NUM_TP_CONNECTION_PRESENCE_TYPES,
 196         TP_CONNECTION_PRESENCE_TYPE_UNSET,
 197         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 198
 199   g_object_class_install_property (object_class,
 200       PROP_PRESENCE_MESSAGE,
 201       g_param_spec_string ("presence-message",
 202         "Contact presence message",
 203         "Presence message of contact",
 204         NULL,
 205         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 206
 207   g_object_class_install_property (object_class,
 208       PROP_HANDLE,
 209       g_param_spec_uint ("handle",
 210         "Contact Handle",
 211         "The handle of the contact",
 212         0,
 213         G_MAXUINT,
 214         0,
 215         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 216
 217   g_object_class_install_property (object_class,
 218       PROP_CAPABILITIES,
 219       g_param_spec_flags ("capabilities",
 220         "Contact Capabilities",
 221         "Capabilities of the contact",
 222         EMPATHY_TYPE_CAPABILITIES,
 223         EMPATHY_CAPABILITIES_UNKNOWN,
 224         G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 225
 226   g_object_class_install_property (object_class,
 227       PROP_IS_USER,
 228       g_param_spec_boolean ("is-user",
 229         "Contact is-user",
 230         "Is contact the user",
 231         FALSE,
 232         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 233
 234
 235   g_object_class_install_property (object_class,
 236       PROP_LOCATION,
 237       g_param_spec_boxed ("location",
 238         "Contact location",
 239         "Physical location of the contact",
 240         G_TYPE_HASH_TABLE,
 241         G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 242
 243   signals[PRESENCE_CHANGED] =
 244     g_signal_new ("presence-changed",
 245                   G_TYPE_FROM_CLASS (class),
 246                   G_SIGNAL_RUN_LAST,
 247                   0,
 248                   NULL, NULL,
 249                   _empathy_marshal_VOID__UINT_UINT,
 250                   G_TYPE_NONE,
 251                   2, G_TYPE_UINT,
 252                   G_TYPE_UINT);
 253
 254   g_type_class_add_private (object_class, sizeof (EmpathyContactPriv));
 255 }
 256
 257 static void
 258 empathy_contact_init (EmpathyContact *contact)
 259 {
 260   EmpathyContactPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (contact,
 261     EMPATHY_TYPE_CONTACT, EmpathyContactPriv);
 262
 263   contact->priv = priv;
 264
 265   priv->location = NULL;
 266 }
 267
 268 static void
 269 contact_finalize (GObject *object)
 270 {
 271   EmpathyContactPriv *priv;
 272
 273   priv = GET_PRIV (object);
 274
 275   DEBUG ("finalize: %p", object);
 276
 277   g_free (priv->name);
 278   g_free (priv->id);
 279   g_free (priv->presence_message);
 280
 281   if (priv->avatar)
 282       empathy_avatar_unref (priv->avatar);
 283
 284   if (priv->location != NULL)
 285       g_hash_table_unref (priv->location);
 286
 287   G_OBJECT_CLASS (empathy_contact_parent_class)->finalize (object);
 288 }
 289
 290 static void
 291 set_tp_contact (EmpathyContact *contact,
 292                 TpContact *tp_contact)
 293 {
 294   EmpathyContactPriv *priv = GET_PRIV (contact);
 295
 296   if (tp_contact == NULL)
 297     return;
 298
 299   g_assert (priv->tp_contact == NULL);
 300   priv->tp_contact = g_object_ref (tp_contact);
 301   priv->presence = empathy_contact_get_presence (contact);
 302
 303   g_signal_connect (priv->tp_contact, "notify",
 304     G_CALLBACK (tp_contact_notify_cb), contact);
 305 }
 306
 307 static void
 308 contact_get_property (GObject *object,
 309                       guint param_id,
 310                       GValue *value,
 311                       GParamSpec *pspec)
 312 {
 313   EmpathyContact *contact = EMPATHY_CONTACT (object);
 314
 315   switch (param_id)
 316     {
 317       case PROP_TP_CONTACT:
 318         g_value_set_object (value, empathy_contact_get_tp_contact (contact));
 319         break;
 320       case PROP_ACCOUNT:
 321         g_value_set_object (value, empathy_contact_get_account (contact));
 322         break;
 323       case PROP_ID:
 324         g_value_set_string (value, empathy_contact_get_id (contact));
 325         break;
 326       case PROP_NAME:
 327         g_value_set_string (value, empathy_contact_get_name (contact));
 328         break;
 329       case PROP_AVATAR:
 330         g_value_set_boxed (value, empathy_contact_get_avatar (contact));
 331         break;
 332       case PROP_PRESENCE:
 333         g_value_set_uint (value, empathy_contact_get_presence (contact));
 334         break;
 335       case PROP_PRESENCE_MESSAGE:
 336         g_value_set_string (value, empathy_contact_get_presence_message (contact));
 337         break;
 338       case PROP_HANDLE:
 339         g_value_set_uint (value, empathy_contact_get_handle (contact));
 340         break;
 341       case PROP_CAPABILITIES:
 342         g_value_set_flags (value, empathy_contact_get_capabilities (contact));
 343         break;
 344       case PROP_IS_USER:
 345         g_value_set_boolean (value, empathy_contact_is_user (contact));
 346         break;
 347       default:
 348         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 349         break;
 350     };
 351 }
 352
 353 static void
 354 contact_set_property (GObject *object,
 355                       guint param_id,
 356                       const GValue *value,
 357                       GParamSpec *pspec)
 358 {
 359   EmpathyContact *contact = EMPATHY_CONTACT (object);
 360   EmpathyContactPriv *priv = GET_PRIV (object);
 361
 362   switch (param_id)
 363     {
 364       case PROP_TP_CONTACT:
 365         set_tp_contact (contact, g_value_get_object (value));
 366         break;
 367       case PROP_ACCOUNT:
 368         g_assert (priv->account == NULL);
 369         priv->account = g_value_dup_object (value);
 370         break;
 371       case PROP_ID:
 372         empathy_contact_set_id (contact, g_value_get_string (value));
 373         break;
 374       case PROP_NAME:
 375         empathy_contact_set_name (contact, g_value_get_string (value));
 376         break;
 377       case PROP_AVATAR:
 378         empathy_contact_set_avatar (contact, g_value_get_boxed (value));
 379         break;
 380       case PROP_PRESENCE:
 381         empathy_contact_set_presence (contact, g_value_get_uint (value));
 382         break;
 383       case PROP_PRESENCE_MESSAGE:
 384         empathy_contact_set_presence_message (contact, g_value_get_string (value));
 385         break;
 386       case PROP_HANDLE:
 387         empathy_contact_set_handle (contact, g_value_get_uint (value));
 388         break;
 389       case PROP_CAPABILITIES:
 390         empathy_contact_set_capabilities (contact, g_value_get_flags (value));
 391         break;
 392       case PROP_IS_USER:
 393         empathy_contact_set_is_user (contact, g_value_get_boolean (value));
 394         break;
 395       default:
 396         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 397         break;
 398     };
 399 }
 400
 401 EmpathyContact *
 402 empathy_contact_new (TpContact *tp_contact)
 403 {
 404   g_return_val_if_fail (TP_IS_CONTACT (tp_contact), NULL);
 405
 406   return g_object_new (EMPATHY_TYPE_CONTACT,
 407       "tp-contact", tp_contact,
 408       NULL);
 409 }
 410
 411 EmpathyContact *
 412 empathy_contact_new_for_log (EmpathyAccount *account,
 413                              const gchar *id,
 414                              const gchar *name,
 415                              gboolean is_user)
 416 {
 417   g_return_val_if_fail (id != NULL, NULL);
 418   g_assert (account != NULL);
 419
 420   return g_object_new (EMPATHY_TYPE_CONTACT,
 421       "account", account,
 422       "id", id,
 423       "name", name,
 424       "is-user", is_user,
 425       NULL);
 426 }
 427
 428 TpContact *
 429 empathy_contact_get_tp_contact (EmpathyContact *contact)
 430 {
 431   EmpathyContactPriv *priv;
 432
 433   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 434
 435   priv = GET_PRIV (contact);
 436
 437   return priv->tp_contact;
 438 }
 439
 440 const gchar *
 441 empathy_contact_get_id (EmpathyContact *contact)
 442 {
 443   EmpathyContactPriv *priv;
 444
 445   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 446
 447   priv = GET_PRIV (contact);
 448
 449   if (priv->tp_contact != NULL)
 450     return tp_contact_get_identifier (priv->tp_contact);
 451
 452   return priv->id;
 453 }
 454
 455 void
 456 empathy_contact_set_id (EmpathyContact *contact,
 457                         const gchar *id)
 458 {
 459   EmpathyContactPriv *priv;
 460
 461   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 462   g_return_if_fail (id != NULL);
 463
 464   priv = GET_PRIV (contact);
 465
 466   /* We temporally ref the contact because it could be destroyed
 467    * during the signal emition */
 468   g_object_ref (contact);
 469   if (tp_strdiff (id, priv->id))
 470     {
 471       g_free (priv->id);
 472       priv->id = g_strdup (id);
 473
 474       g_object_notify (G_OBJECT (contact), "id");
 475       if (EMP_STR_EMPTY (priv->name))
 476           g_object_notify (G_OBJECT (contact), "name");
 477     }
 478
 479   g_object_unref (contact);
 480 }
 481
 482 const gchar *
 483 empathy_contact_get_name (EmpathyContact *contact)
 484 {
 485   EmpathyContactPriv *priv;
 486
 487   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 488
 489   priv = GET_PRIV (contact);
 490
 491   if (priv->tp_contact != NULL)
 492     return tp_contact_get_alias (priv->tp_contact);
 493
 494   if (EMP_STR_EMPTY (priv->name))
 495       return empathy_contact_get_id (contact);
 496
 497   return priv->name;
 498 }
 499
 500 void
 501 empathy_contact_set_name (EmpathyContact *contact,
 502                           const gchar *name)
 503 {
 504   EmpathyContactPriv *priv;
 505
 506   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 507
 508   priv = GET_PRIV (contact);
 509
 510   g_object_ref (contact);
 511   if (tp_strdiff (name, priv->name))
 512     {
 513       g_free (priv->name);
 514       priv->name = g_strdup (name);
 515       g_object_notify (G_OBJECT (contact), "name");
 516     }
 517   g_object_unref (contact);
 518 }
 519
 520 EmpathyAvatar *
 521 empathy_contact_get_avatar (EmpathyContact *contact)
 522 {
 523   EmpathyContactPriv *priv;
 524
 525   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 526
 527   priv = GET_PRIV (contact);
 528
 529   return priv->avatar;
 530 }
 531
 532 void
 533 empathy_contact_set_avatar (EmpathyContact *contact,
 534                             EmpathyAvatar *avatar)
 535 {
 536   EmpathyContactPriv *priv;
 537
 538   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 539
 540   priv = GET_PRIV (contact);
 541
 542   if (priv->avatar == avatar)
 543     return;
 544
 545   if (priv->avatar)
 546     {
 547       empathy_avatar_unref (priv->avatar);
 548       priv->avatar = NULL;
 549     }
 550
 551   if (avatar)
 552       priv->avatar = empathy_avatar_ref (avatar);
 553
 554   g_object_notify (G_OBJECT (contact), "avatar");
 555 }
 556
 557 EmpathyAccount *
 558 empathy_contact_get_account (EmpathyContact *contact)
 559 {
 560   EmpathyContactPriv *priv;
 561
 562   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 563
 564   priv = GET_PRIV (contact);
 565
 566   if (priv->account == NULL && priv->tp_contact != NULL)
 567     {
 568       EmpathyAccountManager *manager;
 569       TpConnection *connection;
 570
 571       /* FIXME: This assume the account manager already exists */
 572       manager = empathy_account_manager_dup_singleton ();
 573       connection = tp_contact_get_connection (priv->tp_contact);
 574       priv->account = empathy_account_manager_get_account_for_connection (
 575           manager, connection);
 576       g_object_ref (priv->account);
 577       g_object_unref (manager);
 578     }
 579
 580   return priv->account;
 581 }
 582
 583 TpConnection *
 584 empathy_contact_get_connection (EmpathyContact *contact)
 585 {
 586   EmpathyContactPriv *priv;
 587
 588   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 589
 590   priv = GET_PRIV (contact);
 591
 592   if (priv->tp_contact != NULL)
 593     return tp_contact_get_connection (priv->tp_contact);
 594
 595   return NULL;
 596 }
 597
 598 TpConnectionPresenceType
 599 empathy_contact_get_presence (EmpathyContact *contact)
 600 {
 601   EmpathyContactPriv *priv;
 602
 603   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact),
 604     TP_CONNECTION_PRESENCE_TYPE_UNSET);
 605
 606   priv = GET_PRIV (contact);
 607
 608   if (priv->tp_contact != NULL)
 609     return tp_contact_get_presence_type (priv->tp_contact);
 610
 611   return priv->presence;
 612 }
 613
 614 void
 615 empathy_contact_set_presence (EmpathyContact *contact,
 616                               TpConnectionPresenceType presence)
 617 {
 618   EmpathyContactPriv *priv;
 619   TpConnectionPresenceType old_presence;
 620
 621   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 622
 623   priv = GET_PRIV (contact);
 624
 625   if (presence == priv->presence)
 626     return;
 627
 628   old_presence = priv->presence;
 629   priv->presence = presence;
 630
 631   g_signal_emit (contact, signals[PRESENCE_CHANGED], 0, presence, old_presence);
 632
 633   g_object_notify (G_OBJECT (contact), "presence");
 634 }
 635
 636 const gchar *
 637 empathy_contact_get_presence_message (EmpathyContact *contact)
 638 {
 639   EmpathyContactPriv *priv;
 640
 641   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 642
 643   priv = GET_PRIV (contact);
 644
 645   if (priv->tp_contact != NULL)
 646     return tp_contact_get_presence_message (priv->tp_contact);
 647
 648   return priv->presence_message;
 649 }
 650
 651 void
 652 empathy_contact_set_presence_message (EmpathyContact *contact,
 653                                       const gchar *message)
 654 {
 655   EmpathyContactPriv *priv = GET_PRIV (contact);
 656
 657   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 658
 659   if (!tp_strdiff (message, priv->presence_message))
 660     return;
 661
 662   g_free (priv->presence_message);
 663   priv->presence_message = g_strdup (message);
 664
 665   g_object_notify (G_OBJECT (contact), "presence-message");
 666 }
 667
 668 guint
 669 empathy_contact_get_handle (EmpathyContact *contact)
 670 {
 671   EmpathyContactPriv *priv;
 672
 673   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
 674
 675   priv = GET_PRIV (contact);
 676
 677   if (priv->tp_contact != NULL)
 678     return tp_contact_get_handle (priv->tp_contact);
 679
 680   return priv->handle;
 681 }
 682
 683 void
 684 empathy_contact_set_handle (EmpathyContact *contact,
 685                             guint handle)
 686 {
 687   EmpathyContactPriv *priv;
 688
 689   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 690
 691   priv = GET_PRIV (contact);
 692
 693   g_object_ref (contact);
 694   if (handle != priv->handle)
 695     {
 696       priv->handle = handle;
 697       g_object_notify (G_OBJECT (contact), "handle");
 698     }
 699   g_object_unref (contact);
 700 }
 701
 702 EmpathyCapabilities
 703 empathy_contact_get_capabilities (EmpathyContact *contact)
 704 {
 705   EmpathyContactPriv *priv;
 706
 707   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
 708
 709   priv = GET_PRIV (contact);
 710
 711   return priv->capabilities;
 712 }
 713
 714 void
 715 empathy_contact_set_capabilities (EmpathyContact *contact,
 716                                   EmpathyCapabilities capabilities)
 717 {
 718   EmpathyContactPriv *priv;
 719
 720   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 721
 722   priv = GET_PRIV (contact);
 723
 724   if (priv->capabilities == capabilities)
 725     return;
 726
 727   priv->capabilities = capabilities;
 728
 729   g_object_notify (G_OBJECT (contact), "capabilities");
 730 }
 731
 732 gboolean
 733 empathy_contact_is_user (EmpathyContact *contact)
 734 {
 735   EmpathyContactPriv *priv;
 736
 737   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 738
 739   priv = GET_PRIV (contact);
 740
 741   return priv->is_user;
 742 }
 743
 744 void
 745 empathy_contact_set_is_user (EmpathyContact *contact,
 746                              gboolean is_user)
 747 {
 748   EmpathyContactPriv *priv;
 749
 750   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 751
 752   priv = GET_PRIV (contact);
 753
 754   if (priv->is_user == is_user)
 755     return;
 756
 757   priv->is_user = is_user;
 758
 759   g_object_notify (G_OBJECT (contact), "is-user");
 760 }
 761
 762 gboolean
 763 empathy_contact_is_online (EmpathyContact *contact)
 764 {
 765   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 766
 767   switch (empathy_contact_get_presence (contact))
 768     {
 769       case TP_CONNECTION_PRESENCE_TYPE_OFFLINE:
 770       case TP_CONNECTION_PRESENCE_TYPE_UNKNOWN:
 771       case TP_CONNECTION_PRESENCE_TYPE_ERROR:
 772         return FALSE;
 773       default:
 774         return TRUE;
 775     }
 776 }
 777
 778 const gchar *
 779 empathy_contact_get_status (EmpathyContact *contact)
 780 {
 781   const gchar *message;
 782
 783   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), "");
 784
 785   message = empathy_contact_get_presence_message (contact);
 786   if (!EMP_STR_EMPTY (message))
 787     return message;
 788
 789   return empathy_presence_get_default_message (
 790       empathy_contact_get_presence (contact));
 791 }
 792
 793 gboolean
 794 empathy_contact_can_voip (EmpathyContact *contact)
 795 {
 796   EmpathyContactPriv *priv;
 797
 798   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 799
 800   priv = GET_PRIV (contact);
 801
 802   return priv->capabilities & (EMPATHY_CAPABILITIES_AUDIO |
 803       EMPATHY_CAPABILITIES_VIDEO);
 804 }
 805
 806 gboolean
 807 empathy_contact_can_voip_audio (EmpathyContact *contact)
 808 {
 809   EmpathyContactPriv *priv;
 810
 811   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 812
 813   priv = GET_PRIV (contact);
 814
 815   return priv->capabilities & EMPATHY_CAPABILITIES_AUDIO;
 816 }
 817
 818 gboolean
 819 empathy_contact_can_voip_video (EmpathyContact *contact)
 820 {
 821   EmpathyContactPriv *priv;
 822
 823   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 824
 825   priv = GET_PRIV (contact);
 826
 827   return priv->capabilities & EMPATHY_CAPABILITIES_VIDEO;
 828 }
 829
 830 gboolean
 831 empathy_contact_can_send_files (EmpathyContact *contact)
 832 {
 833   EmpathyContactPriv *priv;
 834
 835   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 836
 837   priv = GET_PRIV (contact);
 838
 839   return priv->capabilities & EMPATHY_CAPABILITIES_FT;
 840 }
 841
 842 gboolean
 843 empathy_contact_can_use_stream_tube (EmpathyContact *contact)
 844 {
 845   EmpathyContactPriv *priv;
 846
 847   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 848
 849   priv = GET_PRIV (contact);
 850
 851   return priv->capabilities & EMPATHY_CAPABILITIES_STREAM_TUBE;
 852 }
 853
 854 static gchar *
 855 contact_get_avatar_filename (EmpathyContact *contact,
 856                              const gchar *token)
 857 {
 858   EmpathyAccount *account;
 859   gchar *avatar_path;
 860   gchar *avatar_file;
 861   gchar *token_escaped;
 862
 863   if (EMP_STR_EMPTY (empathy_contact_get_id (contact)))
 864     return NULL;
 865
 866   token_escaped = tp_escape_as_identifier (token);
 867   account = empathy_contact_get_account (contact);
 868
 869   avatar_path = g_build_filename (g_get_user_cache_dir (),
 870       "telepathy",
 871       "avatars",
 872       empathy_account_get_connection_manager (account),
 873       empathy_account_get_protocol (account),
 874       NULL);
 875   g_mkdir_with_parents (avatar_path, 0700);
 876
 877   avatar_file = g_build_filename (avatar_path, token_escaped, NULL);
 878
 879   g_free (token_escaped);
 880   g_free (avatar_path);
 881
 882   return avatar_file;
 883 }
 884
 885 void
 886 empathy_contact_load_avatar_data (EmpathyContact *contact,
 887                                   const guchar *data,
 888                                   const gsize len,
 889                                   const gchar *format,
 890                                   const gchar *token)
 891 {
 892   EmpathyAvatar *avatar;
 893   gchar *filename;
 894   GError *error = NULL;
 895
 896   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 897   g_return_if_fail (data != NULL);
 898   g_return_if_fail (len > 0);
 899   g_return_if_fail (format != NULL);
 900   g_return_if_fail (!EMP_STR_EMPTY (token));
 901
 902   /* Load and set the avatar */
 903   filename = contact_get_avatar_filename (contact, token);
 904   avatar = empathy_avatar_new (g_memdup (data, len), len, g_strdup (format),
 905       g_strdup (token), filename);
 906   empathy_contact_set_avatar (contact, avatar);
 907   empathy_avatar_unref (avatar);
 908
 909   /* Save to cache if not yet in it */
 910   if (filename && !g_file_test (filename, G_FILE_TEST_EXISTS))
 911     {
 912       if (!empathy_avatar_save_to_file (avatar, filename, &error))
 913         {
 914           DEBUG ("Failed to save avatar in cache: %s",
 915             error ? error->message : "No error given");
 916           g_clear_error (&error);
 917         }
 918       else
 919           DEBUG ("Avatar saved to %s", filename);
 920     }
 921 }
 922
 923 gboolean
 924 empathy_contact_load_avatar_cache (EmpathyContact *contact,
 925                                    const gchar *token)
 926 {
 927   EmpathyAvatar *avatar = NULL;
 928   gchar *filename;
 929   gchar *data = NULL;
 930   gsize len;
 931   GError *error = NULL;
 932
 933   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 934   g_return_val_if_fail (!EMP_STR_EMPTY (token), FALSE);
 935
 936   /* Load the avatar from file if it exists */
 937   filename = contact_get_avatar_filename (contact, token);
 938   if (filename && g_file_test (filename, G_FILE_TEST_EXISTS))
 939     {
 940       if (!g_file_get_contents (filename, &data, &len, &error))
 941         {
 942           DEBUG ("Failed to load avatar from cache: %s",
 943             error ? error->message : "No error given");
 944           g_clear_error (&error);
 945         }
 946     }
 947
 948   if (data)
 949     {
 950       DEBUG ("Avatar loaded from %s", filename);
 951       avatar = empathy_avatar_new (data, len, NULL, g_strdup (token), filename);
 952       empathy_contact_set_avatar (contact, avatar);
 953       empathy_avatar_unref (avatar);
 954     }
 955   else
 956     {
 957       g_free (filename);
 958     }
 959
 960   return data != NULL;
 961 }
 962
 963 GType
 964 empathy_avatar_get_type (void)
 965 {
 966   static GType type_id = 0;
 967
 968   if (!type_id)
 969     {
 970       type_id = g_boxed_type_register_static ("EmpathyAvatar",
 971           (GBoxedCopyFunc) empathy_avatar_ref,
 972           (GBoxedFreeFunc) empathy_avatar_unref);
 973     }
 974
 975   return type_id;
 976 }
 977
 978 /**
 979  * empathy_avatar_new:
 980  * @data: the avatar data
 981  * @len: the size of avatar data
 982  * @format: the mime type of the avatar image
 983  * @token: the token of the avatar
 984  * @filename: the filename where the avatar is stored in cache
 985  *
 986  * Create a #EmpathyAvatar from the provided data. This function takes the
 987  * ownership of @data, @format, @token and @filename.
 988  *
 989  * Returns: a new #EmpathyAvatar
 990  */
 991 EmpathyAvatar *
 992 empathy_avatar_new (guchar *data,
 993                     gsize len,
 994                     gchar *format,
 995                     gchar *token,
 996                     gchar *filename)
 997 {
 998   EmpathyAvatar *avatar;
 999
1000   avatar = g_slice_new0 (EmpathyAvatar);
1001   avatar->data = data;
1002   avatar->len = len;
1003   avatar->format = format;
1004   avatar->token = token;
1005   avatar->filename = filename;
1006   avatar->refcount = 1;
1007
1008   return avatar;
1009 }
1010
1011 void
1012 empathy_avatar_unref (EmpathyAvatar *avatar)
1013 {
1014   g_return_if_fail (avatar != NULL);
1015
1016   avatar->refcount--;
1017   if (avatar->refcount == 0)
1018     {
1019       g_free (avatar->data);
1020       g_free (avatar->format);
1021       g_free (avatar->token);
1022       g_slice_free (EmpathyAvatar, avatar);
1023     }
1024 }
1025
1026 EmpathyAvatar *
1027 empathy_avatar_ref (EmpathyAvatar *avatar)
1028 {
1029   g_return_val_if_fail (avatar != NULL, NULL);
1030
1031   avatar->refcount++;
1032
1033   return avatar;
1034 }
1035
1036 /**
1037  * empathy_avatar_save_to_file:
1038  * @avatar: the avatar
1039  * @filename: name of a file to write avatar to
1040  * @error: return location for a GError, or NULL
1041  *
1042  * Save the avatar to a file named filename
1043  *
1044  * Returns: %TRUE on success, %FALSE if an error occurred
1045  */
1046 gboolean
1047 empathy_avatar_save_to_file (EmpathyAvatar *self,
1048                              const gchar *filename,
1049                              GError **error)
1050 {
1051   return g_file_set_contents (filename, self->data, self->len, error);
1052 }
1053
1054 /**
1055  * empathy_contact_get_location:
1056  * @contact: an #EmpathyContact
1057  *
1058  * Returns the user's location if available.  The keys are defined in
1059  * empathy-location.h. If the contact doesn't have location
1060  * information, the GHashTable will be empthy. Use #g_hash_table_unref when
1061  * you are done with the #GHashTable.
1062  *
1063  * It is composed of string keys and GValues.  Keys are
1064  * defined in empathy-location.h such as #EMPATHY_LOCATION_COUNTRY.
1065  * Example: a "city" key would have "Helsinki" as string GValue,
1066  *          a "latitude" would have 65.0 as double GValue.
1067  *
1068  * Returns: a #GHashTable of location values
1069  */
1070 GHashTable *
1071 empathy_contact_get_location (EmpathyContact *contact)
1072 {
1073   EmpathyContactPriv *priv;
1074
1075   g_return_val_if_fail (EMPATHY_CONTACT (contact), NULL);
1076
1077   priv = GET_PRIV (contact);
1078
1079   return priv->location;
1080 }
1081
1082 /**
1083  * empathy_contact_set_location:
1084  * @contact: an #EmpathyContact
1085  * @location: a #GHashTable of the location
1086  *
1087  * Sets the user's location based on the location #GHashTable passed.
1088  * It is composed of string keys and GValues.  Keys are
1089  * defined in empathy-location.h such as #EMPATHY_LOCATION_COUNTRY.
1090  * Example: a "city" key would have "Helsinki" as string GValue,
1091  *          a "latitude" would have 65.0 as double GValue.
1092  */
1093 void
1094 empathy_contact_set_location (EmpathyContact *contact,
1095                               GHashTable *location)
1096 {
1097   EmpathyContactPriv *priv;
1098
1099   g_return_if_fail (EMPATHY_CONTACT (contact));
1100   g_return_if_fail (location != NULL);
1101
1102   priv = GET_PRIV (contact);
1103
1104   if (priv->location != NULL)
1105     g_hash_table_unref (priv->location);
1106
1107   priv->location = g_hash_table_ref (location);
1108   g_object_notify (G_OBJECT (contact), "location");
1109 }
1110
1111 /**
1112  * empathy_contact_equal:
1113  * @contact1: an #EmpathyContact
1114  * @contact2: an #EmpathyContact
1115  *
1116  * Returns FALSE if one of the contacts is NULL but the other is not.
1117  * Otherwise returns TRUE if both pointer are equal or if they bith
1118  * refer to the same id.
1119  * It's only necessary to call this function if your contact objects
1120  * come from logs where contacts are created dynamically and comparing
1121  * pointers is not enough.
1122  */
1123 gboolean
1124 empathy_contact_equal (gconstpointer contact1,
1125                        gconstpointer contact2)
1126 {
1127   EmpathyContact *c1;
1128   EmpathyContact *c2;
1129   const gchar *id1;
1130   const gchar *id2;
1131
1132   if ((contact1 == NULL) != (contact2 == NULL)) {
1133     return FALSE;
1134   }
1135   if (contact1 == contact2) {
1136     return TRUE;
1137   }
1138   c1 = EMPATHY_CONTACT (contact1);
1139   c2 = EMPATHY_CONTACT (contact2);
1140   id1 = empathy_contact_get_id (c1);
1141   id2 = empathy_contact_get_id (c2);
1142   if (!tp_strdiff (id1, id2)) {
1143     return TRUE;
1144   }
1145   return FALSE;
1146 }