path: root/plugins/attachment-reminder/attachment-reminder.c

/*
 * This program 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.
 *
 * 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 Lesser General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Authors:
 *      Johnny Jacob <jjohnny@novell.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <gtk/gtk.h>
#include <glib/gi18n.h>
#include <string.h>

#include <e-util/e-util.h>

#include <mail/em-config.h>
#include <mail/em-event.h>

#include <mail/em-utils.h>

#include "composer/e-msg-composer.h"
#include "composer/e-composer-actions.h"

#define CONF_KEY_ATTACH_REMINDER_CLUES "attachment-reminder-clues"

typedef struct {
    GSettings   *settings;
    GtkWidget   *treeview;
    GtkWidget   *clue_add;
    GtkWidget   *clue_edit;
    GtkWidget   *clue_remove;
    GtkListStore *store;
} UIData;

enum {
    CLUE_KEYWORD_COLUMN,
    CLUE_N_COLUMNS
};

gint        e_plugin_lib_enable (EPlugin *ep,
                     gint enable);
GtkWidget * e_plugin_lib_get_configure_widget
                    (EPlugin *plugin);
void        org_gnome_evolution_attachment_reminder
                    (EPlugin *ep,
                     EMEventTargetComposer *t);
GtkWidget * org_gnome_attachment_reminder_config_option
                    (EPlugin *plugin,
                     EConfigHookItemFactoryData *data);

static gboolean ask_for_missing_attachment (EPlugin *ep, GtkWindow *widget);
static gboolean check_for_attachment_clues (GByteArray *msg_text);
static gboolean check_for_attachment (EMsgComposer *composer);
static void commit_changes (UIData *ui);

gint
e_plugin_lib_enable (EPlugin *ep,
                     gint enable)
{
    return 0;
}

void
org_gnome_evolution_attachment_reminder (EPlugin *ep,
                                         EMEventTargetComposer *t)
{
    GByteArray *raw_msg_barray;

    /* no need to check for content, when there are attachments */
    if (check_for_attachment (t->composer))
        return;

    raw_msg_barray = e_msg_composer_get_raw_message_text (t->composer);
    if (!raw_msg_barray)
        return;

    /* Set presend_check_status for the composer*/
    if (check_for_attachment_clues (raw_msg_barray)) {
        if (!ask_for_missing_attachment (ep, (GtkWindow *) t->composer))
            g_object_set_data (
                G_OBJECT (t->composer),
                "presend_check_status",
                GINT_TO_POINTER (1));
    }

    g_byte_array_free (raw_msg_barray, TRUE);
}

static gboolean
ask_for_missing_attachment (EPlugin *ep,
                            GtkWindow *window)
{
    GtkWidget *check;
    GtkWidget *dialog;
    GtkWidget *container;
    gint response;

    dialog = e_alert_dialog_new_for_args (
        window, "org.gnome.evolution.plugins.attachment_reminder:"
        "attachment-reminder", NULL);

    container = e_alert_dialog_get_content_area (E_ALERT_DIALOG (dialog));

    /*Check buttons*/
    check = gtk_check_button_new_with_mnemonic (
        _("_Do not show this message again."));
    gtk_box_pack_start (GTK_BOX (container), check, FALSE, FALSE, 0);
    gtk_widget_show (check);

    response = gtk_dialog_run (GTK_DIALOG (dialog));

    if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (check)))
        e_plugin_enable (ep, FALSE);

    gtk_widget_destroy (dialog);

    if (response == GTK_RESPONSE_OK)
        gtk_action_activate (E_COMPOSER_ACTION_ATTACH (window));

    return response == GTK_RESPONSE_YES;
}

static gboolean
get_next_word (GByteArray *msg_text,
               guint *from,
               const gchar **word,
               guint *wlen)
{
    gboolean new_line;

    g_return_val_if_fail (msg_text != NULL, FALSE);
    g_return_val_if_fail (from != NULL, FALSE);
    g_return_val_if_fail (word != NULL, FALSE);
    g_return_val_if_fail (wlen != NULL, FALSE);

    if (*from >= msg_text->len)
        return FALSE;

    new_line = TRUE;
    while (new_line) {
        new_line = FALSE;

        while (*from < msg_text->len && g_ascii_isspace (msg_text->data[*from])) {
            new_line = msg_text->data[*from] == '\n';
            *from = (*from) + 1;
        }

        if (*from >= msg_text->len)
            return FALSE;

        if (new_line && msg_text->data[*from] == '>') {
            /* skip quotation lines */
            while (*from < msg_text->len && msg_text->data[*from] != '\n') {
                *from = (*from) + 1;
            }
        } else if (new_line && *from + 3 < msg_text->len &&
               strncmp ((const gchar *) (msg_text->data + (*from)), "-- \n", 4) == 0) {
            /* signature delimiter finishes message text */
            *from = msg_text->len;
            return FALSE;
        } else {
            new_line = FALSE;
        }
    }

    if (*from >= msg_text->len)
        return FALSE;

    *word = (const gchar *) (msg_text->data + (*from));
    *wlen = 0;

    while (*from < msg_text->len && !g_ascii_isspace (msg_text->data[*from])) {
        *from = (*from) + 1;
        *wlen = (*wlen) + 1;
    }

    return TRUE;
}

/* 's1' has s1len bytes of text, while 's2' is NULL-terminated
 * and *s2len contains how many bytes were read */
static gboolean
utf8_casencmp (const gchar *s1,
               guint s1len,
               const gchar *s2,
               guint *s2len)
{
    gunichar u1, u2;
    guint u1len, u2len;

    if (!s1 || !s2 || !s1len || !s2len)
        return FALSE;

    *s2len = 0;

    while (s1len > 0 && *s1 && *s2) {
        u1 = g_utf8_get_char_validated (s1, s1len);
        u2 = g_utf8_get_char_validated (s2, -1);

        if (u1 == -1 || u1 == -2 || u2 == -1 || u2 == -2)
            break;

        if (u1 != u2 && g_unichar_tolower (u1) != g_unichar_tolower (u2))
            break;

        u1len = g_unichar_to_utf8 (u1, NULL);
        if (s1len < u1len)
            break;

        u2len = g_unichar_to_utf8 (u2, NULL);

        s1len -= u1len;
        s1 += u1len;
        *s2len = (*s2len) + u2len;
        s2 += u2len;
    }

    return s1len == 0;
}

/* check for the clues */
static gboolean
check_for_attachment_clues (GByteArray *msg_text)
{
    GSettings *settings;
    gchar **clue_list;
    gboolean found = FALSE;

    settings = g_settings_new ("org.gnome.evolution.plugin.attachment-reminder");

    /* Get the list from GSettings */
    clue_list = g_settings_get_strv (settings, CONF_KEY_ATTACH_REMINDER_CLUES);

    g_object_unref (settings);

    if (clue_list && clue_list[0]) {
        gint ii;
        guint from = 0, wlen = 0, clen = 0;
        const gchar *word = NULL;

        while (!found && get_next_word (msg_text, &from, &word, &wlen)) {
            for (ii = 0; !found && clue_list[ii] != NULL; ii++) {
                const gchar *clue = clue_list[ii];

                if (utf8_casencmp (word, wlen, clue, &clen)) {
                    found = clue[clen] == 0;

                    if (!found && g_ascii_isspace (clue[clen])) {
                        /* clue is a multi-word, then test more words */
                        guint bfrom = from, blen = 0;
                        const gchar *bword = NULL;

                        clue = clue + clen;
                        while (*clue && g_ascii_isspace (*clue))
                            clue++;

                        found = !*clue;
                        if (!found) {
                            found = TRUE;

                            while (found && get_next_word (msg_text, &bfrom, &bword, &blen)) {
                                found = FALSE;

                                if (utf8_casencmp (bword, blen, clue, &clen)) {
                                    found = clue[clen] == 0;
                                    if (found) {
                                        clue = clue + clen;
                                        break;
                                    } else if (g_ascii_isspace (clue[clen])) {
                                        /* another word in clue */
                                        found = TRUE;

                                        clue = clue + clen;
                                        while (*clue && g_ascii_isspace (*clue))
                                            clue++;
                                    }
                                } else {
                                    found = FALSE;
                                }
                            }

                            found = found && !*clue;
                        }
                    }
                }
            }
        }
    }

    if (clue_list) {
        g_strfreev (clue_list);
    }

    return found;
}

/* check for the any attachment */
static gboolean
check_for_attachment (EMsgComposer *composer)
{
    EAttachmentView *view;
    EAttachmentStore *store;

    view = e_msg_composer_get_attachment_view (composer);
    store = e_attachment_view_get_store (view);

    return (e_attachment_store_get_num_attachments (store) > 0);
}

static void
commit_changes (UIData *ui)
{
    GtkTreeModel *model = NULL;
    GVariantBuilder b;
    GVariant *v;
    GtkTreeIter iter;
    gboolean valid;

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (ui->treeview));
    valid = gtk_tree_model_get_iter_first (model, &iter);

    g_variant_builder_init (&b, G_VARIANT_TYPE ("as"));
    while (valid) {
        gchar *keyword;

        gtk_tree_model_get (
            model, &iter, CLUE_KEYWORD_COLUMN, &keyword, -1);

        /* Check if the keyword is not empty */
        if ((keyword) && (g_utf8_strlen (g_strstrip (keyword), -1) > 0))
            g_variant_builder_add (&b, "s", keyword);
        g_free (keyword);

        valid = gtk_tree_model_iter_next (model, &iter);
    }

    /* A floating GVariant is returned, which is consumed by the g_settings_set_value() */
    v = g_variant_builder_end (&b);
    g_settings_set_value (ui->settings, CONF_KEY_ATTACH_REMINDER_CLUES, v);
}

static void
cell_edited_cb (GtkCellRendererText *cell,
                gchar *path_string,
                gchar *new_text,
                UIData *ui)
{
    GtkTreeModel *model;
    GtkTreeIter iter;

    model = gtk_tree_view_get_model (GTK_TREE_VIEW (ui->treeview));
    gtk_tree_model_get_iter_from_string (model, &iter, path_string);

    if (new_text == NULL || *g_strstrip (new_text) == '\0')
        gtk_button_clicked (GTK_BUTTON (ui->clue_remove));
    else {
        gtk_list_store_set (
            GTK_LIST_STORE (model), &iter,
            CLUE_KEYWORD_COLUMN, new_text, -1);
        commit_changes (ui);
    }
}

static void
cell_editing_canceled_cb (GtkCellRenderer *cell,
                          UIData *ui)
{
    gtk_button_clicked (GTK_BUTTON (ui->clue_remove));
}

static void
clue_add_clicked (GtkButton *button,
                  UIData *ui)
{
    GtkTreeModel *model;
    GtkTreeView *tree_view;
    GtkTreeViewColumn *column;
    GtkTreePath *path;
    GtkTreeIter iter;

    tree_view = GTK_TREE_VIEW (ui->treeview);
    model = gtk_tree_view_get_model (tree_view);

    gtk_list_store_append (GTK_LIST_STORE (model), &iter);

    path = gtk_tree_model_get_path (model, &iter);
    column = gtk_tree_view_get_column (tree_view, CLUE_KEYWORD_COLUMN);
    gtk_tree_view_set_cursor (tree_view, path, column, TRUE);
    gtk_tree_view_row_activated (tree_view, path, column);
    gtk_tree_path_free (path);
}

static void
clue_remove_clicked (GtkButton *button,
                     UIData *ui)
{
    GtkTreeSelection *selection;
    GtkTreeModel *model;
    GtkTreeIter iter;
    GtkTreePath *path;
    gboolean valid;
    gint len;

    valid = FALSE;
    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (ui->treeview));
    if (!gtk_tree_selection_get_selected (selection, &model, &iter))
        return;

    /* Get the path and move to the previous node :) */
    path = gtk_tree_model_get_path (model, &iter);
    if (path)
        valid = gtk_tree_path_prev (path);

    gtk_list_store_remove (GTK_LIST_STORE (model), &iter);

    len = gtk_tree_model_iter_n_children (model, NULL);
    if (len > 0) {
        if (gtk_list_store_iter_is_valid (GTK_LIST_STORE (model), &iter)) {
            gtk_tree_selection_select_iter (selection, &iter);
        } else {
            if (path && valid) {
                gtk_tree_model_get_iter (model, &iter, path);
                gtk_tree_selection_select_iter (selection, &iter);
            }
        }
    } else {
        gtk_widget_set_sensitive (ui->clue_edit, FALSE);
        gtk_widget_set_sensitive (ui->clue_remove, FALSE);
    }

    gtk_widget_grab_focus (ui->treeview);
    gtk_tree_path_free (path);

    commit_changes (ui);
}

static void
clue_edit_clicked (GtkButton *button,
                   UIData *ui)
{
    GtkTreeSelection *selection;
    GtkTreeModel *model;
    GtkTreePath *path;
    GtkTreeIter iter;
    GtkTreeViewColumn *focus_col;

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (ui->treeview));
    if (!gtk_tree_selection_get_selected (selection, &model, &iter))
        return;

    focus_col = gtk_tree_view_get_column (
        GTK_TREE_VIEW (ui->treeview), CLUE_KEYWORD_COLUMN);
    path = gtk_tree_model_get_path (model, &iter);

    if (path) {
        gtk_tree_view_set_cursor (
            GTK_TREE_VIEW (ui->treeview),
            path, focus_col, TRUE);
        gtk_tree_path_free (path);
    }
}

static void
selection_changed (GtkTreeSelection *selection,
                   UIData *ui)
{
    GtkTreeModel *model;
    GtkTreeIter iter;

    if (gtk_tree_selection_get_selected (selection, &model, &iter)) {
        gtk_widget_set_sensitive (ui->clue_edit, TRUE);
        gtk_widget_set_sensitive (ui->clue_remove, TRUE);
    } else {
        gtk_widget_set_sensitive (ui->clue_edit, FALSE);
        gtk_widget_set_sensitive (ui->clue_remove, FALSE);
    }
}

static void
destroy_ui_data (gpointer data)
{
    UIData *ui = (UIData *) data;

    if (!ui)
        return;

    g_object_unref (ui->settings);
    g_free (ui);
}

GtkWidget *
e_plugin_lib_get_configure_widget (EPlugin *plugin)
{
    GtkCellRenderer *renderer;
    GtkTreeSelection *selection;
    GtkTreeIter iter;
    GtkWidget *hbox;
    gchar **clue_list;
    gint i;

    GtkWidget *reminder_configuration_box;
    GtkWidget *clue_container;
    GtkWidget *scrolledwindow1;
    GtkWidget *clue_treeview;
    GtkWidget *vbuttonbox2;
    GtkWidget *clue_add;
    GtkWidget *clue_edit;
    GtkWidget *clue_remove;

    UIData *ui = g_new0 (UIData, 1);

    reminder_configuration_box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 6);
    gtk_widget_show (reminder_configuration_box);
    gtk_widget_set_size_request (reminder_configuration_box, 385, 189);

    clue_container = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 12);
    gtk_widget_show (clue_container);
    gtk_box_pack_start (
        GTK_BOX (reminder_configuration_box),
        clue_container, TRUE, TRUE, 0);

    scrolledwindow1 = gtk_scrolled_window_new (NULL, NULL);
    gtk_widget_show (scrolledwindow1);
    gtk_box_pack_start (GTK_BOX (clue_container), scrolledwindow1, TRUE, TRUE, 0);
    gtk_scrolled_window_set_policy (
        GTK_SCROLLED_WINDOW (scrolledwindow1),
        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);

    clue_treeview = gtk_tree_view_new ();
    gtk_widget_show (clue_treeview);
    gtk_container_add (GTK_CONTAINER (scrolledwindow1), clue_treeview);
    gtk_container_set_border_width (GTK_CONTAINER (clue_treeview), 1);

    vbuttonbox2 = gtk_button_box_new (GTK_ORIENTATION_VERTICAL);
    gtk_widget_show (vbuttonbox2);
    gtk_box_pack_start (GTK_BOX (clue_container), vbuttonbox2, FALSE, TRUE, 0);
    gtk_button_box_set_layout (GTK_BUTTON_BOX (vbuttonbox2), GTK_BUTTONBOX_START);
    gtk_box_set_spacing (GTK_BOX (vbuttonbox2), 6);

    clue_add = e_dialog_button_new_with_icon ("list-add", _("_Add"));
    gtk_widget_show (clue_add);
    gtk_container_add (GTK_CONTAINER (vbuttonbox2), clue_add);
    gtk_widget_set_can_default (clue_add, TRUE);

    clue_edit = gtk_button_new_with_mnemonic (_("_Edit"));
    gtk_widget_show (clue_edit);
    gtk_container_add (GTK_CONTAINER (vbuttonbox2), clue_edit);
    gtk_widget_set_can_default (clue_edit, TRUE);

    clue_remove = e_dialog_button_new_with_icon ("list-remove", _("_Remove"));
    gtk_widget_show (clue_remove);
    gtk_container_add (GTK_CONTAINER (vbuttonbox2), clue_remove);
    gtk_widget_set_can_default (clue_remove, TRUE);

    ui->settings = g_settings_new ("org.gnome.evolution.plugin.attachment-reminder");

    ui->treeview = clue_treeview;

    ui->store = gtk_list_store_new (CLUE_N_COLUMNS, G_TYPE_STRING);

    gtk_tree_view_set_model (
        GTK_TREE_VIEW (ui->treeview),
        GTK_TREE_MODEL (ui->store));

    renderer = gtk_cell_renderer_text_new ();
    gtk_tree_view_insert_column_with_attributes (
        GTK_TREE_VIEW (ui->treeview), -1, _("Keywords"),
        renderer, "text", CLUE_KEYWORD_COLUMN, NULL);
    g_object_set (renderer, "editable", TRUE, NULL);
    g_signal_connect (
        renderer, "edited",
        G_CALLBACK (cell_edited_cb), ui);
    g_signal_connect (
        renderer, "editing-canceled",
        G_CALLBACK (cell_editing_canceled_cb), ui);

    selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (ui->treeview));
    gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
    g_signal_connect (
        selection, "changed",
        G_CALLBACK (selection_changed), ui);
    gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (ui->treeview), TRUE);

    ui->clue_add = clue_add;
    g_signal_connect (
        ui->clue_add, "clicked",
        G_CALLBACK (clue_add_clicked), ui);

    ui->clue_remove = clue_remove;
    g_signal_connect (
        ui->clue_remove, "clicked",
        G_CALLBACK (clue_remove_clicked), ui);
    gtk_widget_set_sensitive (ui->clue_remove, FALSE);

    ui->clue_edit = clue_edit;
    g_signal_connect (
        ui->clue_edit, "clicked",
        G_CALLBACK (clue_edit_clicked), ui);
    gtk_widget_set_sensitive (ui->clue_edit, FALSE);

    /* Populate tree view with values from GSettings */
    clue_list = g_settings_get_strv (ui->settings, CONF_KEY_ATTACH_REMINDER_CLUES);

    for (i = 0; clue_list[i] != NULL; i++) {
        gtk_list_store_append (ui->store, &iter);
        gtk_list_store_set (ui->store, &iter, CLUE_KEYWORD_COLUMN, clue_list[i], -1);
    }

    g_strfreev (clue_list);

    /* Add the list here */

    hbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);

    gtk_box_pack_start (GTK_BOX (hbox), reminder_configuration_box, TRUE, TRUE, 0);

    /* to let free data properly on destroy of configuration widget */
    g_object_set_data_full (G_OBJECT (hbox), "myui-data", ui, destroy_ui_data);

    return hbox;
}

/* Configuration in Mail Prefs Page goes here */

GtkWidget *
org_gnome_attachment_reminder_config_option (EPlugin *plugin,
                                             struct _EConfigHookItemFactoryData *data)
{
    /* This function and the hook needs to be removed,
    once the configure code is thoroughly tested */

    return NULL;

}