libpurple/contact.c

   1 /*
   2  * purple
   3  *
   4  * Purple is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  *
  22  */
  23
  24 #include "contact.h"
  25 #include "internal.h" /* TODO: this needs to die */
  26 #include "util.h"
  27
  28 typedef struct _PurpleContactPrivate    PurpleContactPrivate;
  29
  30 struct _PurpleContactPrivate {
  31         char *alias;                  /* The user-set alias of the contact  */
  32         PurpleBuddy *priority_buddy;  /* The "top" buddy for this contact   */
  33         gboolean priority_valid;      /* Is priority valid?                 */
  34 };
  35
  36 enum
  37 {
  38         PROP_0,
  39         PROP_ALIAS,
  40         PROP_PRIORITY_BUDDY,
  41         PROP_LAST
  42 };
  43
  44 /******************************************************************************
  45  * Globals
  46  *****************************************************************************/
  47 static GParamSpec *properties[PROP_LAST];
  48
  49 G_DEFINE_TYPE_WITH_PRIVATE(PurpleContact, purple_contact,
  50                 PURPLE_TYPE_COUNTING_NODE);
  51
  52 /******************************************************************************
  53  * API
  54  *****************************************************************************/
  55 static void
  56 purple_contact_compute_priority_buddy(PurpleContact *contact) {
  57         PurpleBlistNode *bnode;
  58         PurpleBuddy *new_priority = NULL;
  59         PurpleContactPrivate *priv =
  60                         purple_contact_get_instance_private(contact);
  61
  62         priv->priority_buddy = NULL;
  63         for (bnode = PURPLE_BLIST_NODE(contact)->child;
  64                         bnode != NULL;
  65                         bnode = bnode->next)
  66         {
  67                 PurpleBuddy *buddy;
  68
  69                 if (!PURPLE_IS_BUDDY(bnode))
  70                         continue;
  71
  72                 buddy = PURPLE_BUDDY(bnode);
  73                 if (new_priority == NULL)
  74                 {
  75                         new_priority = buddy;
  76                         continue;
  77                 }
  78
  79                 if (purple_account_is_connected(purple_buddy_get_account(buddy)))
  80                 {
  81                         int cmp = 1;
  82                         if (purple_account_is_connected(purple_buddy_get_account(new_priority)))
  83                                 cmp = purple_buddy_presence_compare(
  84                                                 PURPLE_BUDDY_PRESENCE(purple_buddy_get_presence(new_priority)),
  85                                                 PURPLE_BUDDY_PRESENCE(purple_buddy_get_presence(buddy)));
  86
  87                         if (cmp > 0 || (cmp == 0 &&
  88                                         purple_prefs_get_bool("/purple/contact/last_match")))
  89                         {
  90                                 new_priority = buddy;
  91                         }
  92                 }
  93         }
  94
  95         priv->priority_buddy = new_priority;
  96         priv->priority_valid = TRUE;
  97
  98         g_object_notify_by_pspec(G_OBJECT(contact),
  99                         properties[PROP_PRIORITY_BUDDY]);
 100 }
 101
 102 PurpleGroup *
 103 purple_contact_get_group(const PurpleContact *contact)
 104 {
 105         g_return_val_if_fail(PURPLE_IS_CONTACT(contact), NULL);
 106
 107         return PURPLE_GROUP(PURPLE_BLIST_NODE(contact)->parent);
 108 }
 109
 110 void
 111 purple_contact_set_alias(PurpleContact *contact, const char *alias)
 112 {
 113         PurpleContactPrivate *priv = NULL;
 114         PurpleIMConversation *im;
 115         PurpleBlistNode *bnode;
 116         char *old_alias;
 117         char *new_alias = NULL;
 118
 119         g_return_if_fail(PURPLE_IS_CONTACT(contact));
 120         priv = purple_contact_get_instance_private(contact);
 121
 122         if ((alias != NULL) && (*alias != '\0'))
 123                 new_alias = purple_utf8_strip_unprintables(alias);
 124
 125         if (!purple_strequal(priv->alias, new_alias)) {
 126                 g_free(new_alias);
 127                 return;
 128         }
 129
 130         old_alias = priv->alias;
 131
 132         if ((new_alias != NULL) && (*new_alias != '\0'))
 133                 priv->alias = new_alias;
 134         else {
 135                 priv->alias = NULL;
 136                 g_free(new_alias); /* could be "\0" */
 137         }
 138
 139         g_object_notify_by_pspec(G_OBJECT(contact),
 140                         properties[PROP_ALIAS]);
 141
 142         purple_blist_save_node(purple_blist_get_default(),
 143                                PURPLE_BLIST_NODE(contact));
 144         purple_blist_update_node(purple_blist_get_default(),
 145                                  PURPLE_BLIST_NODE(contact));
 146
 147         for(bnode = PURPLE_BLIST_NODE(contact)->child; bnode != NULL; bnode = bnode->next)
 148         {
 149                 PurpleBuddy *buddy = PURPLE_BUDDY(bnode);
 150
 151                 im = purple_conversations_find_im_with_account(purple_buddy_get_name(buddy),
 152                                 purple_buddy_get_account(buddy));
 153                 if (im)
 154                         purple_conversation_autoset_title(PURPLE_CONVERSATION(im));
 155         }
 156
 157         purple_signal_emit(purple_blist_get_handle(), "blist-node-aliased",
 158                                          contact, old_alias);
 159         g_free(old_alias);
 160 }
 161
 162 const char *purple_contact_get_alias(PurpleContact* contact)
 163 {
 164         PurpleContactPrivate *priv = NULL;
 165
 166         g_return_val_if_fail(PURPLE_IS_CONTACT(contact), NULL);
 167
 168         priv = purple_contact_get_instance_private(contact);
 169         if (priv->alias)
 170                 return priv->alias;
 171
 172         return purple_buddy_get_alias(purple_contact_get_priority_buddy(contact));
 173 }
 174
 175 gboolean purple_contact_on_account(PurpleContact *c, PurpleAccount *account)
 176 {
 177         PurpleBlistNode *bnode, *cnode = (PurpleBlistNode *) c;
 178
 179         g_return_val_if_fail(PURPLE_IS_CONTACT(c), FALSE);
 180         g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), FALSE);
 181
 182         for (bnode = cnode->child; bnode; bnode = bnode->next) {
 183                 PurpleBuddy *buddy;
 184
 185                 if (! PURPLE_IS_BUDDY(bnode))
 186                         continue;
 187
 188                 buddy = (PurpleBuddy *)bnode;
 189                 if (purple_buddy_get_account(buddy) == account)
 190                         return TRUE;
 191         }
 192         return FALSE;
 193 }
 194
 195 void purple_contact_invalidate_priority_buddy(PurpleContact *contact)
 196 {
 197         PurpleContactPrivate *priv = NULL;
 198
 199         g_return_if_fail(PURPLE_IS_CONTACT(contact));
 200
 201         priv = purple_contact_get_instance_private(contact);
 202         priv->priority_valid = FALSE;
 203 }
 204
 205 PurpleBuddy *purple_contact_get_priority_buddy(PurpleContact *contact)
 206 {
 207         PurpleContactPrivate *priv = NULL;
 208
 209         g_return_val_if_fail(PURPLE_IS_CONTACT(contact), NULL);
 210
 211         priv = purple_contact_get_instance_private(contact);
 212         if (!priv->priority_valid)
 213                 purple_contact_compute_priority_buddy(contact);
 214
 215         return priv->priority_buddy;
 216 }
 217
 218 void purple_contact_merge(PurpleContact *source, PurpleBlistNode *node)
 219 {
 220         PurpleBlistNode *sourcenode = (PurpleBlistNode*)source;
 221         PurpleBlistNode *prev, *cur, *next;
 222         PurpleContact *target;
 223
 224         g_return_if_fail(PURPLE_IS_CONTACT(source));
 225         g_return_if_fail(PURPLE_IS_BLIST_NODE(node));
 226
 227         if (PURPLE_IS_CONTACT(node)) {
 228                 target = (PurpleContact *)node;
 229                 prev = _purple_blist_get_last_child(node);
 230         } else if (PURPLE_IS_BUDDY(node)) {
 231                 target = (PurpleContact *)node->parent;
 232                 prev = node;
 233         } else {
 234                 return;
 235         }
 236
 237         if (source == target || !target)
 238                 return;
 239
 240         next = sourcenode->child;
 241
 242         while (next) {
 243                 cur = next;
 244                 next = cur->next;
 245                 if (PURPLE_IS_BUDDY(cur)) {
 246                         purple_blist_add_buddy((PurpleBuddy *)cur, target, NULL, prev);
 247                         prev = cur;
 248                 }
 249         }
 250 }
 251
 252 /**************************************************************************
 253  * GObject Stuff
 254  **************************************************************************/
 255 /* Set method for GObject properties */
 256 static void
 257 purple_contact_set_property(GObject *obj, guint param_id, const GValue *value,
 258                 GParamSpec *pspec)
 259 {
 260         PurpleContact *contact = PURPLE_CONTACT(obj);
 261
 262         switch (param_id) {
 263                 case PROP_ALIAS:
 264                         purple_contact_set_alias(contact, g_value_get_string(value));
 265                         break;
 266                 default:
 267                         G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
 268                         break;
 269         }
 270 }
 271
 272 /* Get method for GObject properties */
 273 static void
 274 purple_contact_get_property(GObject *obj, guint param_id, GValue *value,
 275                 GParamSpec *pspec)
 276 {
 277         PurpleContact *contact = PURPLE_CONTACT(obj);
 278         PurpleContactPrivate *priv =
 279                         purple_contact_get_instance_private(contact);
 280
 281         switch (param_id) {
 282                 case PROP_ALIAS:
 283                         g_value_set_string(value, priv->alias);
 284                         break;
 285                 case PROP_PRIORITY_BUDDY:
 286                         g_value_set_object(value, purple_contact_get_priority_buddy(contact));
 287                         break;
 288                 default:
 289                         G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
 290                         break;
 291         }
 292 }
 293
 294 /* GObject initialization function */
 295 static void
 296 purple_contact_init(PurpleContact *contact)
 297 {
 298         purple_blist_new_node(purple_blist_get_default(),
 299                               PURPLE_BLIST_NODE(contact));
 300 }
 301
 302 /* GObject finalize function */
 303 static void
 304 purple_contact_finalize(GObject *object)
 305 {
 306         PurpleContactPrivate *priv = purple_contact_get_instance_private(
 307                         PURPLE_CONTACT(object));
 308
 309         g_free(priv->alias);
 310
 311         G_OBJECT_CLASS(purple_contact_parent_class)->finalize(object);
 312 }
 313
 314 /* Class initializer function */
 315 static void purple_contact_class_init(PurpleContactClass *klass)
 316 {
 317         GObjectClass *obj_class = G_OBJECT_CLASS(klass);
 318
 319         obj_class->finalize = purple_contact_finalize;
 320
 321         /* Setup properties */
 322         obj_class->get_property = purple_contact_get_property;
 323         obj_class->set_property = purple_contact_set_property;
 324
 325         properties[PROP_ALIAS] = g_param_spec_string(
 326                 "alias",
 327                 "Alias",
 328                 "The alias for the contact.",
 329                 NULL,
 330                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS
 331         );
 332
 333         properties[PROP_PRIORITY_BUDDY] = g_param_spec_object(
 334                 "priority-buddy",
 335                 "Priority buddy",
 336                 "The priority buddy of the contact.",
 337                 PURPLE_TYPE_BUDDY,
 338                 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS
 339         );
 340
 341         g_object_class_install_properties(obj_class, PROP_LAST, properties);
 342 }
 343
 344 PurpleContact *
 345 purple_contact_new(void)
 346 {
 347         return g_object_new(PURPLE_TYPE_CONTACT, NULL);
 348 }
 349