path: root/libempathy-gtk/empathy-status-preset-dialog.c

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * empathy-status-preset-dialog.c
 *
 * EmpathyStatusPresetDialog - a dialog for adding and removing preset status
 * messages.
 *
 * Copyright (C) 2009 Collabora Ltd.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 *
 * Authors: Davyd Madeley <davyd.madeley@collabora.co.uk>
 */
/**
 * SECTION:empathy-status-preset-dialog
 * @title: EmpathyStatusPresetDialog
 * @short_description: a dialog for editing the saved status messages
 * @include: libempathy-gtk/empathy-status-preset-dialog.h
 *
 * #EmpathyStatusPresetDialog is a dialog allowing the user to add/remove/edit
 * their saved status messages.
 */

#include "config.h"

#include <glib/gi18n-lib.h>
#include <gtk/gtk.h>

#include <libempathy/empathy-utils.h>
#include <libempathy/empathy-status-presets.h>

#define DEBUG_FLAG EMPATHY_DEBUG_OTHER
#include <libempathy/empathy-debug.h>

#include "empathy-ui-utils.h"
#include "empathy-status-preset-dialog.h"

#define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyStatusPresetDialog)

G_DEFINE_TYPE (EmpathyStatusPresetDialog, empathy_status_preset_dialog, GTK_TYPE_DIALOG);

static TpConnectionPresenceType states[] = {
    TP_CONNECTION_PRESENCE_TYPE_AVAILABLE,
    TP_CONNECTION_PRESENCE_TYPE_BUSY,
    TP_CONNECTION_PRESENCE_TYPE_AWAY,
};

typedef struct _EmpathyStatusPresetDialogPriv EmpathyStatusPresetDialogPriv;
struct _EmpathyStatusPresetDialogPriv
{
    /* block status_preset_dialog_add_combo_changed () when > 0 */
    int block_add_combo_changed;

    GtkWidget *presets_treeview;
    GtkWidget *add_combobox;
    GtkWidget *add_button;

    GtkTreeIter selected_iter;
    gboolean add_combo_changed;
    char *saved_status;
};

enum
{
    PRESETS_STORE_STATE,
    PRESETS_STORE_ICON_NAME,
    PRESETS_STORE_STATUS,
    PRESETS_STORE_N_COLS
};

enum
{
    ADD_COMBO_STATE,
    ADD_COMBO_ICON_NAME,
    ADD_COMBO_STATUS,
    ADD_COMBO_DEFAULT_TEXT,
    ADD_COMBO_N_COLS
};

static void
empathy_status_preset_dialog_finalize (GObject *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);

    g_free (priv->saved_status);

    G_OBJECT_CLASS (empathy_status_preset_dialog_parent_class)->finalize (self);
}

static void
empathy_status_preset_dialog_class_init (EmpathyStatusPresetDialogClass *class)
{
    GObjectClass *gobject_class;

    gobject_class = G_OBJECT_CLASS (class);
    gobject_class->finalize = empathy_status_preset_dialog_finalize;

    g_type_class_add_private (gobject_class,
            sizeof (EmpathyStatusPresetDialogPriv));
}

static void
status_preset_dialog_presets_update (EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkListStore *store;
    guint i;

    store = GTK_LIST_STORE (gtk_tree_view_get_model (
                GTK_TREE_VIEW (priv->presets_treeview)));

    gtk_list_store_clear (store);

    for (i = 0; i < G_N_ELEMENTS (states); i++) {
        GList *presets, *l;
        const char *icon_name;

        icon_name = empathy_icon_name_for_presence (states[i]);
        presets = empathy_status_presets_get (states[i], -1);
        presets = g_list_sort (presets, (GCompareFunc) g_utf8_collate);

        for (l = presets; l; l = l->next) {
            char *preset = (char *) l->data;

            gtk_list_store_insert_with_values (store,
                    NULL, -1,
                    PRESETS_STORE_STATE, states[i],
                    PRESETS_STORE_ICON_NAME, icon_name,
                    PRESETS_STORE_STATUS, preset,
                    -1);
        }

        g_list_free (presets);
    }
}

static void
status_preset_add_combo_reset (EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkWidget *entry;

    entry = gtk_bin_get_child (GTK_BIN (priv->add_combobox));
    gtk_entry_set_text (GTK_ENTRY (entry), "");

    gtk_combo_box_set_active_iter (GTK_COMBO_BOX (priv->add_combobox),
            &priv->selected_iter);
}

static void
status_preset_dialog_setup_add_combobox (EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkWidget *combobox = priv->add_combobox;
    GtkListStore *store;
    GtkCellRenderer *renderer;
    guint i;

    store = gtk_list_store_new (ADD_COMBO_N_COLS,
            G_TYPE_UINT,        /* ADD_COMBO_STATE */
            G_TYPE_STRING,      /* ADD_COMBO_ICON_NAME */
            G_TYPE_STRING,      /* ADD_COMBO_STATUS */
            G_TYPE_STRING);     /* ADD_COMBO_DEFAULT_TEXT */

    gtk_combo_box_set_model (GTK_COMBO_BOX (combobox),
                 GTK_TREE_MODEL (store));
    g_object_unref (store);

    gtk_combo_box_entry_set_text_column (GTK_COMBO_BOX_ENTRY (combobox),
            ADD_COMBO_DEFAULT_TEXT);

    for (i = 0; i < G_N_ELEMENTS (states); i++) {
        gtk_list_store_insert_with_values (store, NULL, -1,
                ADD_COMBO_STATE, states[i],
                ADD_COMBO_ICON_NAME, empathy_icon_name_for_presence (states[i]),
                ADD_COMBO_STATUS, empathy_presence_get_default_message (states[i]),
                ADD_COMBO_DEFAULT_TEXT, "",
                -1);
    }

    gtk_cell_layout_clear (GTK_CELL_LAYOUT (combobox));

    renderer = gtk_cell_renderer_pixbuf_new ();
    gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combobox), renderer, FALSE);
    gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (combobox), renderer,
            "icon-name", ADD_COMBO_ICON_NAME);

    renderer = gtk_cell_renderer_text_new ();
    gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combobox), renderer, TRUE);
    gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (combobox), renderer,
            "text", ADD_COMBO_STATUS);
    g_object_set (renderer,
            "style", PANGO_STYLE_ITALIC,
            "foreground", "Gray", /* FIXME - theme */
            NULL);

    gtk_combo_box_set_active (GTK_COMBO_BOX (combobox), 0);
}

static void
status_preset_dialog_status_edited (GtkCellRendererText *renderer,
                    char *path_str,
                    char *new_status,
                    EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkTreeModel *model;
    GtkTreePath *path;
    GtkTreeIter iter;
    TpConnectionPresenceType state;
    char *old_status;
    gboolean valid;

    if (strlen (new_status) == 0) {
        /* status is empty, ignore */
        return;
    }

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->presets_treeview));
    path = gtk_tree_path_new_from_string (path_str);
    valid = gtk_tree_model_get_iter (model, &iter, path);
    gtk_tree_path_free (path);

    if (!valid) return;

    gtk_tree_model_get (model, &iter,
            PRESETS_STORE_STATE, &state,
            PRESETS_STORE_STATUS, &old_status,
            -1);

    if (!strcmp (old_status, new_status)) {
        /* statuses are the same */
        g_free (old_status);
        return;
    }

    DEBUG ("EDITED STATUS (%s) -> (%s)\n", old_status, new_status);

    empathy_status_presets_remove (state, old_status);
    empathy_status_presets_set_last (state, new_status);

    g_free (old_status);

    status_preset_dialog_presets_update (self);
}

static void
status_preset_dialog_setup_presets_treeview (EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkWidget *treeview = priv->presets_treeview;
    GtkListStore *store;
    GtkTreeViewColumn *column;
    GtkCellRenderer *renderer;

    store = gtk_list_store_new (PRESETS_STORE_N_COLS,
            G_TYPE_UINT,        /* PRESETS_STORE_STATE */
            G_TYPE_STRING,      /* PRESETS_STORE_ICON_NAME */
            G_TYPE_STRING);     /* PRESETS_STORE_STATUS */

    gtk_tree_view_set_model (GTK_TREE_VIEW (treeview),
                 GTK_TREE_MODEL (store));
    g_object_unref (store);

    status_preset_dialog_presets_update (self);

    column = gtk_tree_view_column_new ();
    gtk_tree_view_append_column (GTK_TREE_VIEW (treeview), column);

    renderer = gtk_cell_renderer_pixbuf_new ();
    gtk_tree_view_column_pack_start (column, renderer, FALSE);
    gtk_tree_view_column_add_attribute (column, renderer,
            "icon-name", PRESETS_STORE_ICON_NAME);

    renderer = gtk_cell_renderer_text_new ();
    gtk_tree_view_column_pack_start (column, renderer, TRUE);
    gtk_tree_view_column_add_attribute (column, renderer,
            "text", PRESETS_STORE_STATUS);
    g_object_set (renderer,
            "editable", TRUE,
            NULL);
    g_object_set (renderer, "ellipsize", PANGO_ELLIPSIZE_END, NULL);

    g_signal_connect (renderer, "edited",
            G_CALLBACK (status_preset_dialog_status_edited), self);
}

static void
status_preset_dialog_preset_selection_changed (GtkTreeSelection *selection,
                           GtkWidget *remove_button)
{
    /* update the sensitivity of the Remove button */
    gtk_widget_set_sensitive (remove_button,
            gtk_tree_selection_get_selected (selection, NULL, NULL));
}

static void
status_preset_dialog_preset_remove (GtkButton *button,
                    EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkTreeSelection *selection;
    GtkTreeModel *model;
    GtkTreeIter iter;
    TpConnectionPresenceType state;
    char *status;

    selection = gtk_tree_view_get_selection (
            GTK_TREE_VIEW (priv->presets_treeview));

    g_return_if_fail (gtk_tree_selection_get_selected (selection,
                &model, &iter));

    gtk_tree_model_get (model, &iter,
            PRESETS_STORE_STATE, &state,
            PRESETS_STORE_STATUS, &status,
            -1);

    DEBUG ("REMOVE PRESET (%i, %s)\n", state, status);
    empathy_status_presets_remove (state, status);

    g_free (status);

    status_preset_dialog_presets_update (self);
}

static void
status_preset_dialog_set_add_combo_changed (EmpathyStatusPresetDialog *self,
                        gboolean state,
                        gboolean reset_text)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkWidget *entry;

    entry = gtk_bin_get_child (GTK_BIN (priv->add_combobox));

    priv->add_combo_changed = state;
    gtk_widget_set_sensitive (priv->add_button, state);

    if (state) {
        gtk_widget_modify_text (entry, GTK_STATE_NORMAL, NULL);
    } else {
        GdkColor colour;

        gdk_color_parse ("Gray", &colour); /* FIXME - theme */
        gtk_widget_modify_text (entry, GTK_STATE_NORMAL, &colour);

        if (reset_text) {
            priv->block_add_combo_changed++;
            gtk_entry_set_text (GTK_ENTRY (entry),
                    _("Enter Custom Message"));
            priv->block_add_combo_changed--;
        }
    }
}

static void
status_preset_dialog_add_combo_changed (GtkComboBox *combo,
                    EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkWidget *entry;
    GtkTreeModel *model;
    GtkTreeIter iter;

    if (priv->block_add_combo_changed) return;

    model = gtk_combo_box_get_model (combo);
    entry = gtk_bin_get_child (GTK_BIN (combo));

    if (gtk_combo_box_get_active_iter (combo, &iter)) {
        char *icon_name;

        priv->selected_iter = iter;
        gtk_tree_model_get (model, &iter,
                PRESETS_STORE_ICON_NAME, &icon_name,
                -1);

        gtk_entry_set_icon_from_icon_name (GTK_ENTRY (entry),
                GTK_ENTRY_ICON_PRIMARY,
                icon_name);

        g_free (icon_name);

        status_preset_dialog_set_add_combo_changed (self, FALSE, TRUE);
        if (priv->saved_status && strlen (priv->saved_status) > 0) {
            gtk_entry_set_text (GTK_ENTRY (entry),
                    priv->saved_status);
        }
    } else {
        g_free (priv->saved_status);
        priv->saved_status = g_strdup (
                gtk_entry_get_text (GTK_ENTRY (entry)));

        status_preset_dialog_set_add_combo_changed (self,
                strlen (priv->saved_status) > 0, FALSE);
    }
}

static void
status_preset_dialog_add_preset (GtkWidget *widget,
                 EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    GtkTreeModel *model;
    GtkTreeIter iter;
    GtkWidget *entry;
    TpConnectionPresenceType state, cstate;
    const char *status;
    char *cstatus;
    gboolean valid, match = FALSE;

    g_return_if_fail (priv->add_combo_changed);

    model = gtk_combo_box_get_model (GTK_COMBO_BOX (priv->add_combobox));
    entry = gtk_bin_get_child (GTK_BIN (priv->add_combobox));

    status = gtk_entry_get_text (GTK_ENTRY (entry));
    gtk_tree_model_get (model, &priv->selected_iter,
            PRESETS_STORE_STATE, &state,
            -1);

    DEBUG ("ADD PRESET (%i, %s)\n", state, status);
    empathy_status_presets_set_last (state, status);

    status_preset_dialog_presets_update (self);

    /* select the added status*/
    model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->presets_treeview));
    for (valid = gtk_tree_model_get_iter_first (model, &iter);
             valid;
             valid = gtk_tree_model_iter_next (model, &iter)) {

        gtk_tree_model_get (model, &iter,
                PRESETS_STORE_STATE, &cstate,
                PRESETS_STORE_STATUS, &cstatus,
                -1);

        match = (cstate == state) && (strcmp (cstatus, status) == 0);

        g_free (cstatus);

        if (match) {
            GtkTreePath *path;

            path = gtk_tree_model_get_path (model, &iter);

            gtk_tree_selection_select_iter (
                gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->presets_treeview)),
                &iter);
            gtk_tree_view_scroll_to_cell (
                    GTK_TREE_VIEW (priv->presets_treeview),
                    path, NULL,
                    FALSE, 0., 0.);
            break;
        }
        }

    if (!match) g_warning ("No match");

    status_preset_add_combo_reset (self);
}

static gboolean
status_preset_dialog_add_combo_press_event (GtkWidget *widget,
                        GdkEventButton *event,
                        EmpathyStatusPresetDialog *self)
{
    if (!gtk_widget_has_focus (widget)) {
        /* if the widget isn't focused, focus it and select the text */
        gtk_widget_grab_focus (widget);
        gtk_editable_select_region (GTK_EDITABLE (widget), 0, -1);

        return TRUE;
    }

    return FALSE;
}

static gboolean
status_preset_dialog_add_combo_focus_out (GtkWidget *widget,
                      GdkEventFocus *event,
                      EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = GET_PRIV (self);
    const char *status;

    gtk_editable_set_position (GTK_EDITABLE (widget), 0);

    status = gtk_entry_get_text (GTK_ENTRY (widget));
    status_preset_dialog_set_add_combo_changed (self,
            priv->add_combo_changed && strlen (status) > 0,
            TRUE);

    return FALSE;
}

static void
empathy_status_preset_dialog_init (EmpathyStatusPresetDialog *self)
{
    EmpathyStatusPresetDialogPriv *priv = self->priv =
        G_TYPE_INSTANCE_GET_PRIVATE (self,
            EMPATHY_TYPE_STATUS_PRESET_DIALOG,
            EmpathyStatusPresetDialogPriv);
    GtkBuilder *gui;
    GtkWidget *toplevel_vbox, *remove_button, *entry;
    char *filename;

    gtk_window_set_title (GTK_WINDOW (self),
            _("Edit Custom Messages"));
    empathy_dialog_remove_separator (GTK_DIALOG (self));
    gtk_dialog_add_button (GTK_DIALOG (self),
            GTK_STOCK_CLOSE, GTK_RESPONSE_CLOSE);

    filename = empathy_file_lookup ("empathy-status-preset-dialog.ui",
            "libempathy-gtk");
    gui = empathy_builder_get_file (filename,
            "toplevel-vbox", &toplevel_vbox,
            "presets-treeview", &priv->presets_treeview,
            "remove-button", &remove_button,
            "add-combobox", &priv->add_combobox,
            "add-button", &priv->add_button,
            NULL);
    g_free (filename);

    g_signal_connect (gtk_tree_view_get_selection (
                GTK_TREE_VIEW (priv->presets_treeview)),
            "changed",
            G_CALLBACK (status_preset_dialog_preset_selection_changed),
            remove_button);

    entry = gtk_bin_get_child (GTK_BIN (priv->add_combobox));
    g_signal_connect (entry, "activate",
            G_CALLBACK (status_preset_dialog_add_preset), self);
    g_signal_connect (entry, "button-press-event",
            G_CALLBACK (status_preset_dialog_add_combo_press_event),
            self);
    g_signal_connect (entry, "focus-out-event",
            G_CALLBACK (status_preset_dialog_add_combo_focus_out),
            self);

    empathy_builder_connect (gui, self,
            "remove-button", "clicked", status_preset_dialog_preset_remove,
            "add-combobox", "changed", status_preset_dialog_add_combo_changed,
            "add-button", "clicked", status_preset_dialog_add_preset,
            NULL);

    status_preset_dialog_setup_presets_treeview (self);
    status_preset_dialog_setup_add_combobox (self);

    gtk_box_pack_start (GTK_BOX (gtk_dialog_get_content_area (GTK_DIALOG (self))),
        toplevel_vbox, TRUE, TRUE, 0);

    g_object_unref (gui);
}

/**
 * empathy_status_preset_dialog_new:
 * @parent: the parent window of this dialog (or NULL)
 *
 * Creates a new #EmpathyStatusPresetDialog that allows the user to
 * add/remove/edit their saved status messages.
 *
 * Returns: the newly constructed dialog.
 */
GtkWidget *
empathy_status_preset_dialog_new (GtkWindow *parent)
{
    GtkWidget *self = g_object_new (EMPATHY_TYPE_STATUS_PRESET_DIALOG,
            NULL);

    if (parent) {
        gtk_window_set_transient_for (GTK_WINDOW (self), parent);
    }

    return self;
}