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/account-manager.h>
  29 #include <telepathy-glib/util.h>
  30
  31 #include "empathy-contact.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   TpAccount *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         TP_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 (TpAccount *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 TpAccount *
 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       TpConnection *connection;
 569
 570       /* FIXME: This assume the account manager already exists */
 571       connection = tp_contact_get_connection (priv->tp_contact);
 572       priv->account =
 573         g_object_ref (empathy_get_account_for_connection (connection));
 574     }
 575
 576   return priv->account;
 577 }
 578
 579 TpConnection *
 580 empathy_contact_get_connection (EmpathyContact *contact)
 581 {
 582   EmpathyContactPriv *priv;
 583
 584   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 585
 586   priv = GET_PRIV (contact);
 587
 588   if (priv->tp_contact != NULL)
 589     return tp_contact_get_connection (priv->tp_contact);
 590
 591   return NULL;
 592 }
 593
 594 TpConnectionPresenceType
 595 empathy_contact_get_presence (EmpathyContact *contact)
 596 {
 597   EmpathyContactPriv *priv;
 598
 599   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact),
 600     TP_CONNECTION_PRESENCE_TYPE_UNSET);
 601
 602   priv = GET_PRIV (contact);
 603
 604   if (priv->tp_contact != NULL)
 605     return tp_contact_get_presence_type (priv->tp_contact);
 606
 607   return priv->presence;
 608 }
 609
 610 void
 611 empathy_contact_set_presence (EmpathyContact *contact,
 612                               TpConnectionPresenceType presence)
 613 {
 614   EmpathyContactPriv *priv;
 615   TpConnectionPresenceType old_presence;
 616
 617   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 618
 619   priv = GET_PRIV (contact);
 620
 621   if (presence == priv->presence)
 622     return;
 623
 624   old_presence = priv->presence;
 625   priv->presence = presence;
 626
 627   g_signal_emit (contact, signals[PRESENCE_CHANGED], 0, presence, old_presence);
 628
 629   g_object_notify (G_OBJECT (contact), "presence");
 630 }
 631
 632 const gchar *
 633 empathy_contact_get_presence_message (EmpathyContact *contact)
 634 {
 635   EmpathyContactPriv *priv;
 636
 637   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL);
 638
 639   priv = GET_PRIV (contact);
 640
 641   if (priv->tp_contact != NULL)
 642     return tp_contact_get_presence_message (priv->tp_contact);
 643
 644   return priv->presence_message;
 645 }
 646
 647 void
 648 empathy_contact_set_presence_message (EmpathyContact *contact,
 649                                       const gchar *message)
 650 {
 651   EmpathyContactPriv *priv = GET_PRIV (contact);
 652
 653   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 654
 655   if (!tp_strdiff (message, priv->presence_message))
 656     return;
 657
 658   g_free (priv->presence_message);
 659   priv->presence_message = g_strdup (message);
 660
 661   g_object_notify (G_OBJECT (contact), "presence-message");
 662 }
 663
 664 guint
 665 empathy_contact_get_handle (EmpathyContact *contact)
 666 {
 667   EmpathyContactPriv *priv;
 668
 669   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
 670
 671   priv = GET_PRIV (contact);
 672
 673   if (priv->tp_contact != NULL)
 674     return tp_contact_get_handle (priv->tp_contact);
 675
 676   return priv->handle;
 677 }
 678
 679 void
 680 empathy_contact_set_handle (EmpathyContact *contact,
 681                             guint handle)
 682 {
 683   EmpathyContactPriv *priv;
 684
 685   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 686
 687   priv = GET_PRIV (contact);
 688
 689   g_object_ref (contact);
 690   if (handle != priv->handle)
 691     {
 692       priv->handle = handle;
 693       g_object_notify (G_OBJECT (contact), "handle");
 694     }
 695   g_object_unref (contact);
 696 }
 697
 698 EmpathyCapabilities
 699 empathy_contact_get_capabilities (EmpathyContact *contact)
 700 {
 701   EmpathyContactPriv *priv;
 702
 703   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), 0);
 704
 705   priv = GET_PRIV (contact);
 706
 707   return priv->capabilities;
 708 }
 709
 710 void
 711 empathy_contact_set_capabilities (EmpathyContact *contact,
 712                                   EmpathyCapabilities capabilities)
 713 {
 714   EmpathyContactPriv *priv;
 715
 716   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 717
 718   priv = GET_PRIV (contact);
 719
 720   if (priv->capabilities == capabilities)
 721     return;
 722
 723   priv->capabilities = capabilities;
 724
 725   g_object_notify (G_OBJECT (contact), "capabilities");
 726 }
 727
 728 gboolean
 729 empathy_contact_is_user (EmpathyContact *contact)
 730 {
 731   EmpathyContactPriv *priv;
 732
 733   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 734
 735   priv = GET_PRIV (contact);
 736
 737   return priv->is_user;
 738 }
 739
 740 void
 741 empathy_contact_set_is_user (EmpathyContact *contact,
 742                              gboolean is_user)
 743 {
 744   EmpathyContactPriv *priv;
 745
 746   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 747
 748   priv = GET_PRIV (contact);
 749
 750   if (priv->is_user == is_user)
 751     return;
 752
 753   priv->is_user = is_user;
 754
 755   g_object_notify (G_OBJECT (contact), "is-user");
 756 }
 757
 758 gboolean
 759 empathy_contact_is_online (EmpathyContact *contact)
 760 {
 761   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 762
 763   switch (empathy_contact_get_presence (contact))
 764     {
 765       case TP_CONNECTION_PRESENCE_TYPE_OFFLINE:
 766       case TP_CONNECTION_PRESENCE_TYPE_UNKNOWN:
 767       case TP_CONNECTION_PRESENCE_TYPE_ERROR:
 768         return FALSE;
 769       default:
 770         return TRUE;
 771     }
 772 }
 773
 774 const gchar *
 775 empathy_contact_get_status (EmpathyContact *contact)
 776 {
 777   const gchar *message;
 778
 779   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), "");
 780
 781   message = empathy_contact_get_presence_message (contact);
 782   if (!EMP_STR_EMPTY (message))
 783     return message;
 784
 785   return empathy_presence_get_default_message (
 786       empathy_contact_get_presence (contact));
 787 }
 788
 789 gboolean
 790 empathy_contact_can_voip (EmpathyContact *contact)
 791 {
 792   EmpathyContactPriv *priv;
 793
 794   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 795
 796   priv = GET_PRIV (contact);
 797
 798   return priv->capabilities & (EMPATHY_CAPABILITIES_AUDIO |
 799       EMPATHY_CAPABILITIES_VIDEO);
 800 }
 801
 802 gboolean
 803 empathy_contact_can_voip_audio (EmpathyContact *contact)
 804 {
 805   EmpathyContactPriv *priv;
 806
 807   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 808
 809   priv = GET_PRIV (contact);
 810
 811   return priv->capabilities & EMPATHY_CAPABILITIES_AUDIO;
 812 }
 813
 814 gboolean
 815 empathy_contact_can_voip_video (EmpathyContact *contact)
 816 {
 817   EmpathyContactPriv *priv;
 818
 819   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 820
 821   priv = GET_PRIV (contact);
 822
 823   return priv->capabilities & EMPATHY_CAPABILITIES_VIDEO;
 824 }
 825
 826 gboolean
 827 empathy_contact_can_send_files (EmpathyContact *contact)
 828 {
 829   EmpathyContactPriv *priv;
 830
 831   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 832
 833   priv = GET_PRIV (contact);
 834
 835   return priv->capabilities & EMPATHY_CAPABILITIES_FT;
 836 }
 837
 838 gboolean
 839 empathy_contact_can_use_stream_tube (EmpathyContact *contact)
 840 {
 841   EmpathyContactPriv *priv;
 842
 843   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 844
 845   priv = GET_PRIV (contact);
 846
 847   return priv->capabilities & EMPATHY_CAPABILITIES_STREAM_TUBE;
 848 }
 849
 850 static gchar *
 851 contact_get_avatar_filename (EmpathyContact *contact,
 852                              const gchar *token)
 853 {
 854   TpAccount *account;
 855   gchar *avatar_path;
 856   gchar *avatar_file;
 857   gchar *token_escaped;
 858
 859   if (EMP_STR_EMPTY (empathy_contact_get_id (contact)))
 860     return NULL;
 861
 862   token_escaped = tp_escape_as_identifier (token);
 863   account = empathy_contact_get_account (contact);
 864
 865   avatar_path = g_build_filename (g_get_user_cache_dir (),
 866       "telepathy",
 867       "avatars",
 868       tp_account_get_connection_manager (account),
 869       tp_account_get_protocol (account),
 870       NULL);
 871   g_mkdir_with_parents (avatar_path, 0700);
 872
 873   avatar_file = g_build_filename (avatar_path, token_escaped, NULL);
 874
 875   g_free (token_escaped);
 876   g_free (avatar_path);
 877
 878   return avatar_file;
 879 }
 880
 881 void
 882 empathy_contact_load_avatar_data (EmpathyContact *contact,
 883                                   const guchar *data,
 884                                   const gsize len,
 885                                   const gchar *format,
 886                                   const gchar *token)
 887 {
 888   EmpathyAvatar *avatar;
 889   gchar *filename;
 890   GError *error = NULL;
 891
 892   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
 893   g_return_if_fail (data != NULL);
 894   g_return_if_fail (len > 0);
 895   g_return_if_fail (format != NULL);
 896   g_return_if_fail (!EMP_STR_EMPTY (token));
 897
 898   /* Load and set the avatar */
 899   filename = contact_get_avatar_filename (contact, token);
 900   avatar = empathy_avatar_new (g_memdup (data, len), len, g_strdup (format),
 901       g_strdup (token), filename);
 902   empathy_contact_set_avatar (contact, avatar);
 903   empathy_avatar_unref (avatar);
 904
 905   /* Save to cache if not yet in it */
 906   if (filename && !g_file_test (filename, G_FILE_TEST_EXISTS))
 907     {
 908       if (!empathy_avatar_save_to_file (avatar, filename, &error))
 909         {
 910           DEBUG ("Failed to save avatar in cache: %s",
 911             error ? error->message : "No error given");
 912           g_clear_error (&error);
 913         }
 914       else
 915           DEBUG ("Avatar saved to %s", filename);
 916     }
 917 }
 918
 919 gboolean
 920 empathy_contact_load_avatar_cache (EmpathyContact *contact,
 921                                    const gchar *token)
 922 {
 923   EmpathyAvatar *avatar = NULL;
 924   gchar *filename;
 925   gchar *data = NULL;
 926   gsize len;
 927   GError *error = NULL;
 928
 929   g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), FALSE);
 930   g_return_val_if_fail (!EMP_STR_EMPTY (token), FALSE);
 931
 932   /* Load the avatar from file if it exists */
 933   filename = contact_get_avatar_filename (contact, token);
 934   if (filename && g_file_test (filename, G_FILE_TEST_EXISTS))
 935     {
 936       if (!g_file_get_contents (filename, &data, &len, &error))
 937         {
 938           DEBUG ("Failed to load avatar from cache: %s",
 939             error ? error->message : "No error given");
 940           g_clear_error (&error);
 941         }
 942     }
 943
 944   if (data)
 945     {
 946       DEBUG ("Avatar loaded from %s", filename);
 947       avatar = empathy_avatar_new ((guchar *) data, len, NULL, g_strdup (token),
 948           filename);
 949       empathy_contact_set_avatar (contact, avatar);
 950       empathy_avatar_unref (avatar);
 951     }
 952   else
 953     {
 954       g_free (filename);
 955     }
 956
 957   return data != NULL;
 958 }
 959
 960 GType
 961 empathy_avatar_get_type (void)
 962 {
 963   static GType type_id = 0;
 964
 965   if (!type_id)
 966     {
 967       type_id = g_boxed_type_register_static ("EmpathyAvatar",
 968           (GBoxedCopyFunc) empathy_avatar_ref,
 969           (GBoxedFreeFunc) empathy_avatar_unref);
 970     }
 971
 972   return type_id;
 973 }
 974
 975 /**
 976  * empathy_avatar_new:
 977  * @data: the avatar data
 978  * @len: the size of avatar data
 979  * @format: the mime type of the avatar image
 980  * @token: the token of the avatar
 981  * @filename: the filename where the avatar is stored in cache
 982  *
 983  * Create a #EmpathyAvatar from the provided data. This function takes the
 984  * ownership of @data, @format, @token and @filename.
 985  *
 986  * Returns: a new #EmpathyAvatar
 987  */
 988 EmpathyAvatar *
 989 empathy_avatar_new (guchar *data,
 990                     gsize len,
 991                     gchar *format,
 992                     gchar *token,
 993                     gchar *filename)
 994 {
 995   EmpathyAvatar *avatar;
 996
 997   avatar = g_slice_new0 (EmpathyAvatar);
 998   avatar->data = data;
 999   avatar->len = len;
1000   avatar->format = format;
1001   avatar->token = token;
1002   avatar->filename = filename;
1003   avatar->refcount = 1;
1004
1005   return avatar;
1006 }
1007
1008 void
1009 empathy_avatar_unref (EmpathyAvatar *avatar)
1010 {
1011   g_return_if_fail (avatar != NULL);
1012
1013   avatar->refcount--;
1014   if (avatar->refcount == 0)
1015     {
1016       g_free (avatar->data);
1017       g_free (avatar->format);
1018       g_free (avatar->token);
1019       g_slice_free (EmpathyAvatar, avatar);
1020     }
1021 }
1022
1023 EmpathyAvatar *
1024 empathy_avatar_ref (EmpathyAvatar *avatar)
1025 {
1026   g_return_val_if_fail (avatar != NULL, NULL);
1027
1028   avatar->refcount++;
1029
1030   return avatar;
1031 }
1032
1033 /**
1034  * empathy_avatar_save_to_file:
1035  * @avatar: the avatar
1036  * @filename: name of a file to write avatar to
1037  * @error: return location for a GError, or NULL
1038  *
1039  * Save the avatar to a file named filename
1040  *
1041  * Returns: %TRUE on success, %FALSE if an error occurred
1042  */
1043 gboolean
1044 empathy_avatar_save_to_file (EmpathyAvatar *self,
1045                              const gchar *filename,
1046                              GError **error)
1047 {
1048   return g_file_set_contents (filename, (const gchar *) self->data, self->len,
1049       error);
1050 }
1051
1052 /**
1053  * empathy_contact_get_location:
1054  * @contact: an #EmpathyContact
1055  *
1056  * Returns the user's location if available.  The keys are defined in
1057  * empathy-location.h. If the contact doesn't have location
1058  * information, the GHashTable will be empthy. Use #g_hash_table_unref when
1059  * you are done with the #GHashTable.
1060  *
1061  * It is composed of string keys and GValues.  Keys are
1062  * defined in empathy-location.h such as #EMPATHY_LOCATION_COUNTRY.
1063  * Example: a "city" key would have "Helsinki" as string GValue,
1064  *          a "latitude" would have 65.0 as double GValue.
1065  *
1066  * Returns: a #GHashTable of location values
1067  */
1068 GHashTable *
1069 empathy_contact_get_location (EmpathyContact *contact)
1070 {
1071   EmpathyContactPriv *priv;
1072
1073   g_return_val_if_fail (EMPATHY_CONTACT (contact), NULL);
1074
1075   priv = GET_PRIV (contact);
1076
1077   return priv->location;
1078 }
1079
1080 /**
1081  * empathy_contact_set_location:
1082  * @contact: an #EmpathyContact
1083  * @location: a #GHashTable of the location
1084  *
1085  * Sets the user's location based on the location #GHashTable passed.
1086  * It is composed of string keys and GValues.  Keys are
1087  * defined in empathy-location.h such as #EMPATHY_LOCATION_COUNTRY.
1088  * Example: a "city" key would have "Helsinki" as string GValue,
1089  *          a "latitude" would have 65.0 as double GValue.
1090  */
1091 void
1092 empathy_contact_set_location (EmpathyContact *contact,
1093                               GHashTable *location)
1094 {
1095   EmpathyContactPriv *priv;
1096
1097   g_return_if_fail (EMPATHY_CONTACT (contact));
1098   g_return_if_fail (location != NULL);
1099
1100   priv = GET_PRIV (contact);
1101
1102   if (priv->location != NULL)
1103     g_hash_table_unref (priv->location);
1104
1105   priv->location = g_hash_table_ref (location);
1106   g_object_notify (G_OBJECT (contact), "location");
1107 }
1108
1109 /**
1110  * empathy_contact_equal:
1111  * @contact1: an #EmpathyContact
1112  * @contact2: an #EmpathyContact
1113  *
1114  * Returns FALSE if one of the contacts is NULL but the other is not.
1115  * Otherwise returns TRUE if both pointer are equal or if they bith
1116  * refer to the same id.
1117  * It's only necessary to call this function if your contact objects
1118  * come from logs where contacts are created dynamically and comparing
1119  * pointers is not enough.
1120  */
1121 gboolean
1122 empathy_contact_equal (gconstpointer contact1,
1123                        gconstpointer contact2)
1124 {
1125   EmpathyContact *c1;
1126   EmpathyContact *c2;
1127   const gchar *id1;
1128   const gchar *id2;
1129
1130   if ((contact1 == NULL) != (contact2 == NULL)) {
1131     return FALSE;
1132   }
1133   if (contact1 == contact2) {
1134     return TRUE;
1135   }
1136   c1 = EMPATHY_CONTACT (contact1);
1137   c2 = EMPATHY_CONTACT (contact2);
1138   id1 = empathy_contact_get_id (c1);
1139   id2 = empathy_contact_get_id (c2);
1140   if (!tp_strdiff (id1, id2)) {
1141     return TRUE;
1142   }
1143   return FALSE;
1144 }