path: root/libempathy/empathy-chatroom.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2007-2008 Collabora Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Authors: Xavier Claessens <xclaesse@gmail.com>
 */

#include "config.h"
#include "empathy-chatroom.h"

#include <tp-account-widgets/tpaw-utils.h>

#include "empathy-utils.h"

#define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyChatroom)
typedef struct {
    TpAccount *account;
    gchar     *room;
    gchar     *name;
    gboolean   auto_connect;
    gboolean favorite;
    EmpathyTpChat *tp_chat;
    gchar *subject;
    guint members_count;
    gboolean invite_only;
    gboolean need_password;
    gboolean always_urgent;
} EmpathyChatroomPriv;


static void chatroom_finalize          (GObject             *object);
static void chatroom_get_property      (GObject             *object,
                    guint                param_id,
                    GValue              *value,
                    GParamSpec          *pspec);
static void chatroom_set_property      (GObject             *object,
                    guint                param_id,
                    const GValue        *value,
                    GParamSpec          *pspec);

enum {
    PROP_0,
    PROP_ACCOUNT,
    PROP_ROOM,
    PROP_NAME,
    PROP_AUTO_CONNECT,
    PROP_FAVORITE,
    PROP_TP_CHAT,
    PROP_SUBJECT,
    PROP_MEMBERS_COUNT,
    PROP_NEED_PASSWORD,
    PROP_INVITE_ONLY,
    PROP_ALWAYS_URGENT,
};

G_DEFINE_TYPE (EmpathyChatroom, empathy_chatroom, G_TYPE_OBJECT);

static void
empathy_chatroom_class_init (EmpathyChatroomClass *klass)
{
    GObjectClass *object_class = G_OBJECT_CLASS (klass);

    object_class->finalize     = chatroom_finalize;
    object_class->get_property = chatroom_get_property;
    object_class->set_property = chatroom_set_property;

    g_object_class_install_property (object_class,
                     PROP_ACCOUNT,
                     g_param_spec_object ("account",
                                  "Chatroom Account",
                                  "The account associated with an chatroom",
                                  TP_TYPE_ACCOUNT,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_ROOM,
                     g_param_spec_string ("room",
                                  "Chatroom Room",
                                  "Chatroom represented as 'room@server'",
                                  NULL,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_NAME,
                     g_param_spec_string ("name",
                                  "Chatroom Name",
                                  "Chatroom name",
                                  NULL,
                                  G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_AUTO_CONNECT,
                     g_param_spec_boolean ("auto_connect",
                                   "Chatroom Auto Connect",
                                   "Connect on startup",
                                   FALSE,
                                   G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_FAVORITE,
                     g_param_spec_boolean ("favorite",
                                   "Favorite",
                                   "TRUE if the chatroom is in user's favorite list",
                                   FALSE,
                                   G_PARAM_READWRITE |
                                   G_PARAM_CONSTRUCT));

    g_object_class_install_property (object_class,
                     PROP_ALWAYS_URGENT,
                     g_param_spec_boolean ("always_urgent",
                                   "Always Urgent",
                                   "TRUE if every message should be considered urgent",
                                   FALSE,
                                   G_PARAM_READWRITE));

    g_object_class_install_property (object_class,
                     PROP_TP_CHAT,
                     g_param_spec_object ("tp-chat",
                                  "Chatroom channel wrapper",
                                  "The wrapper for the chatroom channel if there is one",
                                  EMPATHY_TYPE_TP_CHAT,
                                  G_PARAM_READWRITE));

  g_object_class_install_property (object_class,
      PROP_SUBJECT,
      g_param_spec_string ("subject",
        "Subject",
        "The chatroom's subject",
        "",
        G_PARAM_READWRITE |
        G_PARAM_CONSTRUCT |
        G_PARAM_STATIC_NAME |
        G_PARAM_STATIC_NICK |
        G_PARAM_STATIC_BLURB));

  g_object_class_install_property (object_class,
      PROP_MEMBERS_COUNT,
      g_param_spec_uint ("members-count",
        "Members count",
        "The chatroom's members count",
        0,
        G_MAXUINT,
        0,
        G_PARAM_READWRITE |
        G_PARAM_CONSTRUCT |
        G_PARAM_STATIC_NAME |
        G_PARAM_STATIC_NICK |
        G_PARAM_STATIC_BLURB));

  g_object_class_install_property (object_class,
      PROP_INVITE_ONLY,
      g_param_spec_boolean ("invite-only",
        "Invite Only",
        "The chatroom is invite only",
        FALSE,
        G_PARAM_READWRITE |
        G_PARAM_CONSTRUCT |
        G_PARAM_STATIC_NAME |
        G_PARAM_STATIC_NICK |
        G_PARAM_STATIC_BLURB));

  g_object_class_install_property (object_class,
      PROP_NEED_PASSWORD,
      g_param_spec_boolean ("need-password",
        "Password Needed",
        "The chatroom is password protected",
        FALSE,
        G_PARAM_READWRITE |
        G_PARAM_CONSTRUCT |
        G_PARAM_STATIC_NAME |
        G_PARAM_STATIC_NICK |
        G_PARAM_STATIC_BLURB));

    g_type_class_add_private (object_class, sizeof (EmpathyChatroomPriv));
}

static void
empathy_chatroom_init (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (chatroom,
        EMPATHY_TYPE_CHATROOM, EmpathyChatroomPriv);

    chatroom->priv = priv;
}

static void
chatroom_finalize (GObject *object)
{
    EmpathyChatroomPriv *priv;

    priv = GET_PRIV (object);

    if (priv->tp_chat != NULL)
        g_object_unref (priv->tp_chat);

    g_object_unref (priv->account);
    g_free (priv->room);
    g_free (priv->name);
    g_free (priv->subject);

    (G_OBJECT_CLASS (empathy_chatroom_parent_class)->finalize) (object);
}

static void
chatroom_get_property (GObject    *object,
               guint       param_id,
               GValue     *value,
               GParamSpec *pspec)
{
    EmpathyChatroomPriv *priv;

    priv = GET_PRIV (object);

    switch (param_id) {
    case PROP_ACCOUNT:
        g_value_set_object (value, priv->account);
        break;
    case PROP_ROOM:
        g_value_set_string (value, priv->room);
        break;
    case PROP_NAME:
        g_value_set_string (value, priv->name);
        break;
    case PROP_AUTO_CONNECT:
        g_value_set_boolean (value, priv->auto_connect);
        break;
    case PROP_FAVORITE:
        g_value_set_boolean (value, priv->favorite);
        break;
    case PROP_ALWAYS_URGENT:
        g_value_set_boolean (value, priv->always_urgent);
        break;
    case PROP_TP_CHAT:
        g_value_set_object (value, priv->tp_chat);
        break;
  case PROP_SUBJECT:
    g_value_set_string (value, priv->subject);
    break;
  case PROP_MEMBERS_COUNT:
    g_value_set_uint (value, priv->members_count);
    break;
  case PROP_INVITE_ONLY:
    g_value_set_boolean (value, priv->invite_only);
    break;
  case PROP_NEED_PASSWORD:
    g_value_set_boolean (value, priv->need_password);
    break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
        break;
    };
}

static void
chatroom_set_property (GObject      *object,
               guint         param_id,
               const GValue *value,
               GParamSpec   *pspec)
{
    switch (param_id) {
    case PROP_ACCOUNT:
        empathy_chatroom_set_account (EMPATHY_CHATROOM (object),
                         g_value_get_object (value));
        break;
    case PROP_ROOM:
        empathy_chatroom_set_room (EMPATHY_CHATROOM (object),
                      g_value_get_string (value));
        break;
    case PROP_NAME:
        empathy_chatroom_set_name (EMPATHY_CHATROOM (object),
                      g_value_get_string (value));
        break;
    case PROP_AUTO_CONNECT:
        empathy_chatroom_set_auto_connect (EMPATHY_CHATROOM (object),
                          g_value_get_boolean (value));
        break;
    case PROP_FAVORITE:
        empathy_chatroom_set_favorite (EMPATHY_CHATROOM (object),
                           g_value_get_boolean (value));
        break;
    case PROP_ALWAYS_URGENT:
        empathy_chatroom_set_always_urgent (EMPATHY_CHATROOM (object),
                           g_value_get_boolean (value));
        break;
    case PROP_TP_CHAT:
        empathy_chatroom_set_tp_chat (EMPATHY_CHATROOM (object),
                          g_value_get_object (value));
        break;
  case PROP_SUBJECT:
    empathy_chatroom_set_subject (EMPATHY_CHATROOM (object),
        g_value_get_string (value));
    break;
  case PROP_MEMBERS_COUNT:
    empathy_chatroom_set_members_count (EMPATHY_CHATROOM (object),
        g_value_get_uint (value));
    break;
  case PROP_NEED_PASSWORD:
    empathy_chatroom_set_need_password (EMPATHY_CHATROOM (object),
        g_value_get_boolean (value));
    break;
  case PROP_INVITE_ONLY:
    empathy_chatroom_set_invite_only (EMPATHY_CHATROOM (object),
        g_value_get_boolean (value));
    break;
    default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
        break;
    };
}

EmpathyChatroom *
empathy_chatroom_new (TpAccount *account)
{
    return g_object_new (EMPATHY_TYPE_CHATROOM,
                 "account", account,
                 NULL);
}

EmpathyChatroom *
empathy_chatroom_new_full (TpAccount *account,
              const gchar *room,
              const gchar *name,
              gboolean     auto_connect)
{
    g_return_val_if_fail (room != NULL, NULL);

    return g_object_new (EMPATHY_TYPE_CHATROOM,
                 "account", account,
                 "room", room,
                 "name", name,
                 "auto_connect", auto_connect,
                 NULL);
}

TpAccount *
empathy_chatroom_get_account (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), NULL);

    priv = GET_PRIV (chatroom);
    return priv->account;
}

void
empathy_chatroom_set_account (EmpathyChatroom *chatroom,
                 TpAccount *account)
{
    EmpathyChatroomPriv *priv;

    g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

    priv = GET_PRIV (chatroom);

    if (account == priv->account) {
        return;
    }
    if (priv->account) {
        g_object_unref (priv->account);
    }
    priv->account = g_object_ref (account);

    g_object_notify (G_OBJECT (chatroom), "account");
}

const gchar *
empathy_chatroom_get_room (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), NULL);

    priv = GET_PRIV (chatroom);
    return priv->room;
}

void
empathy_chatroom_set_room (EmpathyChatroom *chatroom,
              const gchar    *room)
{
    EmpathyChatroomPriv *priv;

    g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
    g_return_if_fail (room != NULL);

    priv = GET_PRIV (chatroom);

    g_free (priv->room);
    priv->room = g_strdup (room);

    g_object_notify (G_OBJECT (chatroom), "room");
}

const gchar *
empathy_chatroom_get_name (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), NULL);

    priv = GET_PRIV (chatroom);

    if (TPAW_STR_EMPTY (priv->name)) {
        return priv->room;
    }

    return priv->name;
}

void
empathy_chatroom_set_name (EmpathyChatroom *chatroom,
              const gchar    *name)
{
    EmpathyChatroomPriv *priv;

    g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

    priv = GET_PRIV (chatroom);

    g_free (priv->name);
    priv->name = NULL;
    if (name) {
        priv->name = g_strdup (name);
    }

    g_object_notify (G_OBJECT (chatroom), "name");
}

gboolean
empathy_chatroom_get_auto_connect (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);

    priv = GET_PRIV (chatroom);
    return priv->auto_connect;
}

void
empathy_chatroom_set_auto_connect (EmpathyChatroom *chatroom,
                  gboolean        auto_connect)
{
    EmpathyChatroomPriv *priv;

    g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

    priv = GET_PRIV (chatroom);

    priv->auto_connect = auto_connect;

    if (priv->auto_connect) {
        /* auto_connect implies favorite */
        priv->favorite = TRUE;
        g_object_notify (G_OBJECT (chatroom), "favorite");
    }

    g_object_notify (G_OBJECT (chatroom), "auto-connect");
}

gboolean
empathy_chatroom_equal (gconstpointer v1,
               gconstpointer v2)
{
    TpAccount *account_a;
    TpAccount *account_b;
    const gchar *room_a;
    const gchar *room_b;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (v1), FALSE);
    g_return_val_if_fail (EMPATHY_IS_CHATROOM (v2), FALSE);

    account_a = empathy_chatroom_get_account (EMPATHY_CHATROOM (v1));
    account_b = empathy_chatroom_get_account (EMPATHY_CHATROOM (v2));

    room_a = empathy_chatroom_get_room (EMPATHY_CHATROOM (v1));
    room_b = empathy_chatroom_get_room (EMPATHY_CHATROOM (v2));

    return account_a == account_b && !tp_strdiff (room_a, room_b);
}

EmpathyTpChat *
empathy_chatroom_get_tp_chat (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), NULL);

    priv = GET_PRIV (chatroom);

    return priv->tp_chat;
}

const gchar *
empathy_chatroom_get_subject (EmpathyChatroom *chatroom)
{
  EmpathyChatroomPriv *priv;

  g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), NULL);

  priv = GET_PRIV (chatroom);

  return priv->subject;
}

void
empathy_chatroom_set_subject (EmpathyChatroom *chatroom,
                              const gchar *subject)
{
  EmpathyChatroomPriv *priv;

  g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

  priv = GET_PRIV (chatroom);

  g_free (priv->subject);
  priv->subject = NULL;

  if (subject)
    priv->subject = g_strdup (subject);

  g_object_notify (G_OBJECT (chatroom), "subject");
}

guint
empathy_chatroom_get_members_count (EmpathyChatroom *chatroom)
{
  EmpathyChatroomPriv *priv;

  g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), 0);

  priv = GET_PRIV (chatroom);

  return priv->members_count;
}

void
empathy_chatroom_set_members_count (EmpathyChatroom *chatroom,
                                    guint count)
{
  EmpathyChatroomPriv *priv;

  g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

  priv = GET_PRIV (chatroom);

  priv->members_count = count;

  g_object_notify (G_OBJECT (chatroom), "members-count");
}

gboolean
empathy_chatroom_get_need_password (EmpathyChatroom *chatroom)
{
  EmpathyChatroomPriv *priv;

  g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);

  priv = GET_PRIV (chatroom);

  return priv->need_password;
}

void
empathy_chatroom_set_need_password (EmpathyChatroom *chatroom,
                                    gboolean need_password)
{
  EmpathyChatroomPriv *priv;

  g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

  priv = GET_PRIV (chatroom);

  priv->need_password = need_password;

  g_object_notify (G_OBJECT (chatroom), "need-password");
}

gboolean
empathy_chatroom_get_invite_only (EmpathyChatroom *chatroom)
{
  EmpathyChatroomPriv *priv;

  g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);

  priv = GET_PRIV (chatroom);

  return priv->invite_only;
}

void
empathy_chatroom_set_invite_only (EmpathyChatroom *chatroom,
                                  gboolean invite_only)
{
  EmpathyChatroomPriv *priv;

  g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

  priv = GET_PRIV (chatroom);

  priv->invite_only = invite_only;

  g_object_notify (G_OBJECT (chatroom), "invite-only");
}

void
empathy_chatroom_set_tp_chat (EmpathyChatroom *chatroom,
                  EmpathyTpChat   *tp_chat)
{
    EmpathyChatroomPriv *priv;

    g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
    g_return_if_fail (tp_chat == NULL || EMPATHY_IS_TP_CHAT (tp_chat));

    priv = GET_PRIV (chatroom);

    if (priv->tp_chat == tp_chat) {
        return;
    }

    if (priv->tp_chat != NULL) {
        g_object_unref (priv->tp_chat);
    }

    priv->tp_chat = tp_chat ? g_object_ref (tp_chat) : NULL;
    g_object_notify (G_OBJECT (chatroom), "tp-chat");
}

gboolean
empathy_chatroom_is_favorite (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);

    priv = GET_PRIV (chatroom);

    return priv->favorite;
}

void
empathy_chatroom_set_favorite (EmpathyChatroom *chatroom,
                   gboolean         favorite)
{
    EmpathyChatroomPriv *priv;

    g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

    priv = GET_PRIV (chatroom);

    if (priv->favorite == favorite) {
        return;
    }

    priv->favorite = favorite;
    if (!priv->favorite) {
        empathy_chatroom_set_auto_connect (chatroom, FALSE);
    }
    g_object_notify (G_OBJECT (chatroom), "favorite");
}

gboolean
empathy_chatroom_is_always_urgent (EmpathyChatroom *chatroom)
{
    EmpathyChatroomPriv *priv;

    g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);

    priv = GET_PRIV (chatroom);

    return priv->always_urgent;
}

void
empathy_chatroom_set_always_urgent (EmpathyChatroom *chatroom,
                   gboolean         always_urgent)
{
    EmpathyChatroomPriv *priv;

    g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));

    priv = GET_PRIV (chatroom);

    if (priv->always_urgent == always_urgent)
        return;

    priv->always_urgent = always_urgent;
    g_object_notify (G_OBJECT (chatroom), "always_urgent");
}