libpurple/chat.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 #include "internal.h"
  24 #include "chat.h"
  25 #include "util.h"
  26
  27 typedef struct _PurpleChatPrivate       PurpleChatPrivate;
  28
  29 /* Private data for a chat node */
  30 struct _PurpleChatPrivate {
  31         char *alias;              /* The display name of this chat.             */
  32         PurpleAccount *account;   /* The account this chat is attached to       */
  33         GHashTable *components;   /* the stuff the protocol needs to know to
  34                                      join the chat                              */
  35
  36         gboolean is_constructed;  /* Indicates if the chat has finished being
  37                                      constructed.                               */
  38 };
  39
  40 /* Chat property enums */
  41 enum
  42 {
  43         PROP_0,
  44         PROP_ALIAS,
  45         PROP_ACCOUNT,
  46         PROP_COMPONENTS,
  47         PROP_LAST
  48 };
  49
  50 /******************************************************************************
  51  * Globals
  52  *****************************************************************************/
  53 static GParamSpec *properties[PROP_LAST];
  54
  55 G_DEFINE_TYPE_WITH_PRIVATE(PurpleChat, purple_chat, PURPLE_TYPE_BLIST_NODE);
  56
  57 /******************************************************************************
  58  * API
  59  *****************************************************************************/
  60
  61 const char *purple_chat_get_name(PurpleChat *chat)
  62 {
  63         PurpleChatPrivate *priv = NULL;
  64
  65         g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
  66
  67         priv = purple_chat_get_instance_private(chat);
  68
  69         if ((priv->alias != NULL) && (*priv->alias != '\0'))
  70                 return priv->alias;
  71
  72         return purple_chat_get_name_only(chat);
  73 }
  74
  75 const char *purple_chat_get_name_only(PurpleChat *chat)
  76 {
  77         PurpleChatPrivate *priv = NULL;
  78         char *ret = NULL;
  79         PurpleProtocol *protocol = NULL;
  80
  81         g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
  82
  83         priv = purple_chat_get_instance_private(chat);
  84
  85         protocol = purple_protocols_find(purple_account_get_protocol_id(priv->account));
  86
  87         if (PURPLE_PROTOCOL_IMPLEMENTS(protocol, CHAT, info)) {
  88                 PurpleProtocolChatEntry *pce;
  89                 GList *parts = purple_protocol_chat_iface_info(protocol, purple_account_get_connection(priv->account));
  90                 pce = parts->data;
  91                 ret = g_hash_table_lookup(priv->components, pce->identifier);
  92                 g_list_free_full(parts, g_free);
  93         }
  94
  95         return ret;
  96 }
  97
  98 void
  99 purple_chat_set_alias(PurpleChat *chat, const char *alias)
 100 {
 101         PurpleChatPrivate *priv = NULL;
 102         char *old_alias;
 103         char *new_alias = NULL;
 104
 105         g_return_if_fail(PURPLE_IS_CHAT(chat));
 106
 107         priv = purple_chat_get_instance_private(chat);
 108
 109         if ((alias != NULL) && (*alias != '\0'))
 110                 new_alias = purple_utf8_strip_unprintables(alias);
 111
 112         if (!purple_strequal(priv->alias, new_alias)) {
 113                 g_free(new_alias);
 114                 return;
 115         }
 116
 117         old_alias = priv->alias;
 118
 119         if ((new_alias != NULL) && (*new_alias != '\0'))
 120                 priv->alias = new_alias;
 121         else {
 122                 priv->alias = NULL;
 123                 g_free(new_alias); /* could be "\0" */
 124         }
 125
 126         g_object_notify_by_pspec(G_OBJECT(chat), properties[PROP_ALIAS]);
 127
 128         purple_blist_save_node(purple_blist_get_default(),
 129                                PURPLE_BLIST_NODE(chat));
 130         purple_blist_update_node(purple_blist_get_default(),
 131                                  PURPLE_BLIST_NODE(chat));
 132
 133         purple_signal_emit(purple_blist_get_handle(), "blist-node-aliased",
 134                                          chat, old_alias);
 135         g_free(old_alias);
 136 }
 137
 138 PurpleGroup *
 139 purple_chat_get_group(PurpleChat *chat)
 140 {
 141         g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
 142
 143         return PURPLE_GROUP(PURPLE_BLIST_NODE(chat)->parent);
 144 }
 145
 146 PurpleAccount *
 147 purple_chat_get_account(PurpleChat *chat)
 148 {
 149         PurpleChatPrivate *priv = NULL;
 150
 151         g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
 152
 153         priv = purple_chat_get_instance_private(chat);
 154         return priv->account;
 155 }
 156
 157 GHashTable *
 158 purple_chat_get_components(PurpleChat *chat)
 159 {
 160         PurpleChatPrivate *priv = NULL;
 161
 162         g_return_val_if_fail(PURPLE_IS_CHAT(chat), NULL);
 163
 164         priv = purple_chat_get_instance_private(chat);
 165         return priv->components;
 166 }
 167
 168 /******************************************************************************
 169  * GObject Stuff
 170  *****************************************************************************/
 171 static void
 172 purple_chat_set_property(GObject *obj, guint param_id, const GValue *value,
 173                 GParamSpec *pspec)
 174 {
 175         PurpleChat *chat = PURPLE_CHAT(obj);
 176         PurpleChatPrivate *priv = purple_chat_get_instance_private(chat);
 177
 178         switch (param_id) {
 179                 case PROP_ALIAS:
 180                         if (priv->is_constructed)
 181                                 purple_chat_set_alias(chat, g_value_get_string(value));
 182                         else
 183                                 priv->alias =
 184                                         purple_utf8_strip_unprintables(g_value_get_string(value));
 185                         break;
 186                 case PROP_ACCOUNT:
 187                         priv->account = g_value_get_object(value);
 188                         break;
 189                 case PROP_COMPONENTS:
 190                         priv->components = g_value_get_pointer(value);
 191                         break;
 192                 default:
 193                         G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
 194                         break;
 195         }
 196 }
 197
 198 static void
 199 purple_chat_get_property(GObject *obj, guint param_id, GValue *value,
 200                 GParamSpec *pspec)
 201 {
 202         PurpleChat *chat = PURPLE_CHAT(obj);
 203         PurpleChatPrivate *priv = purple_chat_get_instance_private(chat);
 204
 205         switch (param_id) {
 206                 case PROP_ALIAS:
 207                         g_value_set_string(value, priv->alias);
 208                         break;
 209                 case PROP_ACCOUNT:
 210                         g_value_set_object(value, purple_chat_get_account(chat));
 211                         break;
 212                 case PROP_COMPONENTS:
 213                         g_value_set_pointer(value, purple_chat_get_components(chat));
 214                         break;
 215                 default:
 216                         G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
 217                         break;
 218         }
 219 }
 220
 221 /* GObject initialization function */
 222 static void
 223 purple_chat_init(PurpleChat *chat)
 224 {
 225 }
 226
 227 /* Called when done constructing */
 228 static void
 229 purple_chat_constructed(GObject *object)
 230 {
 231         PurpleChat *chat = PURPLE_CHAT(object);
 232         PurpleChatPrivate *priv = purple_chat_get_instance_private(chat);
 233
 234         G_OBJECT_CLASS(purple_chat_parent_class)->constructed(object);
 235
 236         purple_blist_new_node(purple_blist_get_default(),
 237                               PURPLE_BLIST_NODE(chat));
 238
 239         priv->is_constructed = TRUE;
 240 }
 241
 242 /* GObject finalize function */
 243 static void
 244 purple_chat_finalize(GObject *object)
 245 {
 246         PurpleChatPrivate *priv =
 247                         purple_chat_get_instance_private(PURPLE_CHAT(object));
 248
 249         g_free(priv->alias);
 250         g_hash_table_destroy(priv->components);
 251
 252         G_OBJECT_CLASS(purple_chat_parent_class)->finalize(object);
 253 }
 254
 255 /* Class initializer function */
 256 static void purple_chat_class_init(PurpleChatClass *klass)
 257 {
 258         GObjectClass *obj_class = G_OBJECT_CLASS(klass);
 259
 260         obj_class->finalize = purple_chat_finalize;
 261
 262         /* Setup properties */
 263         obj_class->get_property = purple_chat_get_property;
 264         obj_class->set_property = purple_chat_set_property;
 265         obj_class->constructed = purple_chat_constructed;
 266
 267         properties[PROP_ALIAS] = g_param_spec_string(
 268                 "alias",
 269                 "Alias",
 270                 "The alias for the chat.",
 271                 NULL,
 272                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS
 273         );
 274
 275         properties[PROP_ACCOUNT] = g_param_spec_object(
 276                 "account",
 277                 "Account",
 278                 "The account that the chat belongs to.",
 279                 PURPLE_TYPE_ACCOUNT,
 280                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS
 281         );
 282
 283         properties[PROP_COMPONENTS] = g_param_spec_pointer(
 284                 "components",
 285                 "Components",
 286                 "The protocol components of the chat.",
 287                 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS
 288         );
 289
 290         g_object_class_install_properties(obj_class, PROP_LAST, properties);
 291 }
 292
 293 PurpleChat *
 294 purple_chat_new(PurpleAccount *account, const char *alias, GHashTable *components)
 295 {
 296         g_return_val_if_fail(PURPLE_IS_ACCOUNT(account), NULL);
 297         g_return_val_if_fail(components != NULL, NULL);
 298
 299         return g_object_new(PURPLE_TYPE_CHAT,
 300                         "account",     account,
 301                         "alias",       alias,
 302                         "components",  components,
 303                         NULL);
 304 }