path: root/modules/mail/e-mail-shell-backend.c

/*
 * e-mail-shell-backend.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; either
 * version 2 of the License, or (at your option) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

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

#include "e-mail-shell-backend.h"

#include <glib/gi18n.h>

#include "e-util/e-import.h"
#include "e-util/e-util.h"
#include "shell/e-shell.h"
#include "shell/e-shell-window.h"
#include "composer/e-msg-composer.h"
#include "widgets/misc/e-preferences-window.h"
#include "widgets/misc/e-web-view.h"

#include "e-mail-shell-settings.h"
#include "e-mail-shell-sidebar.h"
#include "e-mail-shell-view.h"

#include "e-mail-browser.h"
#include "e-mail-folder-utils.h"
#include "e-mail-reader.h"
#include "e-mail-session.h"
#include "em-account-editor.h"
#include "em-account-prefs.h"
#include "em-composer-prefs.h"
#include "em-composer-utils.h"
#include "em-folder-utils.h"
#include "em-format-hook.h"
#include "em-format-html-display.h"
#include "em-mailer-prefs.h"
#include "em-network-prefs.h"
#include "em-utils.h"
#include "mail-config.h"
#include "mail-ops.h"
#include "mail-send-recv.h"
#include "mail-vfolder.h"
#include "importers/mail-importer.h"

#define E_MAIL_SHELL_BACKEND_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), E_TYPE_MAIL_SHELL_BACKEND, EMailShellBackendPrivate))

#define BACKEND_NAME "mail"

struct _EMailShellBackendPrivate {
    gint mail_sync_in_progress;
    guint mail_sync_source_id;
};

static void mbox_create_preview_cb (GObject *preview, GtkWidget **preview_widget);
static void mbox_fill_preview_cb (GObject *preview, CamelMimeMessage *msg);

G_DEFINE_DYNAMIC_TYPE (
    EMailShellBackend,
    e_mail_shell_backend,
    E_TYPE_MAIL_BACKEND)

static void
mail_shell_backend_init_importers (void)
{
    EImportClass *import_class;
    EImportImporter *importer;

    import_class = g_type_class_ref (e_import_get_type ());

    importer = mbox_importer_peek ();
    e_import_class_add_importer (import_class, importer, NULL, NULL);
    mbox_importer_set_preview_funcs (
        mbox_create_preview_cb, mbox_fill_preview_cb);

    importer = elm_importer_peek ();
    e_import_class_add_importer (import_class, importer, NULL, NULL);

    importer = pine_importer_peek ();
    e_import_class_add_importer (import_class, importer, NULL, NULL);
}

static void
mail_shell_backend_mail_icon_cb (EShellWindow *shell_window,
                                 const gchar *icon_name)
{
    GtkAction *action;

    action = e_shell_window_get_shell_view_action (
        shell_window, BACKEND_NAME);
    gtk_action_set_icon_name (action, icon_name);
}

static void
action_mail_folder_new_cb (GtkAction *action,
                           EShellWindow *shell_window)
{
    EMFolderTree *folder_tree = NULL;
    EMailShellSidebar *mail_shell_sidebar;
    EMailBackend *backend;
    EShellSidebar *shell_sidebar;
    EShellView *shell_view;
    const gchar *view_name;

    /* Take care not to unnecessarily load the mail shell view. */
    view_name = e_shell_window_get_active_view (shell_window);
    if (g_strcmp0 (view_name, BACKEND_NAME) != 0) {
        EShellBackend *shell_backend;
        EShell *shell;

        shell = e_shell_window_get_shell (shell_window);

        shell_backend =
            e_shell_get_backend_by_name (shell, BACKEND_NAME);
        g_return_if_fail (E_IS_MAIL_BACKEND (shell_backend));

        backend = E_MAIL_BACKEND (shell_backend);

        goto exit;
    }

    shell_view = e_shell_window_get_shell_view (shell_window, view_name);
    shell_sidebar = e_shell_view_get_shell_sidebar (shell_view);

    mail_shell_sidebar = E_MAIL_SHELL_SIDEBAR (shell_sidebar);
    folder_tree = e_mail_shell_sidebar_get_folder_tree (mail_shell_sidebar);
    backend = em_folder_tree_get_backend (folder_tree);

exit:
    em_folder_utils_create_folder (
        GTK_WINDOW (shell_window), backend, folder_tree, NULL);
}

static void
action_mail_message_new_cb (GtkAction *action,
                            EShellWindow *shell_window)
{
    EMailShellSidebar *mail_shell_sidebar;
    EShellSidebar *shell_sidebar;
    EShellView *shell_view;
    EShell *shell;
    EMFolderTree *folder_tree;
    CamelFolder *folder = NULL;
    CamelStore *store;
    const gchar *view_name;
    gchar *folder_name;

    shell = e_shell_window_get_shell (shell_window);

    /* Take care not to unnecessarily load the mail shell view. */
    view_name = e_shell_window_get_active_view (shell_window);
    if (g_strcmp0 (view_name, BACKEND_NAME) != 0)
        goto exit;

    shell_view = e_shell_window_get_shell_view (shell_window, view_name);
    shell_sidebar = e_shell_view_get_shell_sidebar (shell_view);

    mail_shell_sidebar = E_MAIL_SHELL_SIDEBAR (shell_sidebar);
    folder_tree = e_mail_shell_sidebar_get_folder_tree (mail_shell_sidebar);

    if (em_folder_tree_get_selected (folder_tree, &store, &folder_name)) {

        /* FIXME This blocks and is not cancellable. */
        folder = camel_store_get_folder_sync (
            store, folder_name, 0, NULL, NULL);

        g_object_unref (store);
        g_free (folder_name);
    }

exit:
    em_utils_compose_new_message (shell, folder);
}

static GtkActionEntry item_entries[] = {

    { "mail-message-new",
      "mail-message-new",
      NC_("New", "_Mail Message"),
      "<Shift><Control>m",
      N_("Compose a new mail message"),
      G_CALLBACK (action_mail_message_new_cb) }
};

static GtkActionEntry source_entries[] = {

    { "mail-folder-new",
      "folder-new",
      NC_("New", "Mail _Folder"),
      NULL,
      N_("Create a new mail folder"),
      G_CALLBACK (action_mail_folder_new_cb) }
};

static void
mail_shell_backend_sync_store_done_cb (CamelStore *store,
                                       gpointer user_data)
{
    EMailShellBackend *mail_shell_backend = user_data;

    mail_shell_backend->priv->mail_sync_in_progress--;
}

static gboolean
mail_shell_backend_mail_sync (EMailShellBackend *mail_shell_backend)
{
    EShell *shell;
    EShellBackend *shell_backend;
    EMailBackend *backend;
    EMailSession *session;
    GList *list, *link;

    shell_backend = E_SHELL_BACKEND (mail_shell_backend);
    shell = e_shell_backend_get_shell (shell_backend);

    /* Obviously we can only sync in online mode. */
    if (!e_shell_get_online (shell))
        goto exit;

    /* If a sync is still in progress, skip this round. */
    if (mail_shell_backend->priv->mail_sync_in_progress)
        goto exit;

    backend = E_MAIL_BACKEND (mail_shell_backend);
    session = e_mail_backend_get_session (backend);

    list = camel_session_list_services (CAMEL_SESSION (session));

    for (link = list; link != NULL; link = g_list_next (link)) {
        CamelService *service;

        service = CAMEL_SERVICE (link->data);

        if (!CAMEL_IS_STORE (service))
            continue;

        mail_shell_backend->priv->mail_sync_in_progress++;

        mail_sync_store (
            CAMEL_STORE (service), FALSE,
            mail_shell_backend_sync_store_done_cb,
            mail_shell_backend);
    }

    g_list_free (list);

exit:
    return TRUE;
}

static gboolean
mail_shell_backend_handle_uri_cb (EShell *shell,
                                  const gchar *uri,
                                  EMailShellBackend *mail_shell_backend)
{
    gboolean handled = FALSE;

    if (g_str_has_prefix (uri, "mailto:")) {
        em_utils_compose_new_message_with_mailto (shell, uri, NULL);
        handled = TRUE;
    }

    return handled;
}

static void
mail_shell_backend_prepare_for_quit_cb (EShell *shell,
                                        EActivity *activity,
                                        EShellBackend *shell_backend)
{
    EMailShellBackendPrivate *priv;

    priv = E_MAIL_SHELL_BACKEND_GET_PRIVATE (shell_backend);

    /* Prevent a sync from starting while trying to shutdown. */
    if (priv->mail_sync_source_id > 0) {
        g_source_remove (priv->mail_sync_source_id);
        priv->mail_sync_source_id = 0;
    }
}

static void
mail_shell_backend_window_weak_notify_cb (EShell *shell,
                                          GObject *where_the_object_was)
{
    g_signal_handlers_disconnect_by_func (
        shell, mail_shell_backend_mail_icon_cb,
        where_the_object_was);
}

static void
mail_shell_backend_window_added_cb (GtkApplication *application,
                                    GtkWindow *window,
                                    EShellBackend *shell_backend)
{
    EShell *shell = E_SHELL (application);
    EMailBackend *backend;
    EMailSession *session;
    const gchar *backend_name;

    backend = E_MAIL_BACKEND (shell_backend);
    session = e_mail_backend_get_session (backend);

    /* This applies to both the composer and signature editor. */
    if (GTKHTML_IS_EDITOR (window)) {
        EShellSettings *shell_settings;
        GList *spell_languages;
        gboolean active = TRUE;

        spell_languages = e_load_spell_languages ();
        gtkhtml_editor_set_spell_languages (
            GTKHTML_EDITOR (window), spell_languages);
        g_list_free (spell_languages);

        shell_settings = e_shell_get_shell_settings (shell);

        /* Express mode does not honor this setting. */
        if (!e_shell_get_express_mode (shell))
            active = e_shell_settings_get_boolean (
                shell_settings, "composer-format-html");

        gtkhtml_editor_set_html_mode (GTKHTML_EDITOR (window), active);
    }

    if (E_IS_MSG_COMPOSER (window)) {
        /* Start the mail backend if it isn't already.  This
         * may be necessary when opening a new composer window
         * from a shell view other than mail. */
        e_shell_backend_start (shell_backend);

        /* Integrate the new composer into the mail module. */
        em_configure_new_composer (
            E_MSG_COMPOSER (window), session);
        return;
    }

    if (!E_IS_SHELL_WINDOW (window))
        return;

    backend_name = E_SHELL_BACKEND_GET_CLASS (shell_backend)->name;

    e_shell_window_register_new_item_actions (
        E_SHELL_WINDOW (window), backend_name,
        item_entries, G_N_ELEMENTS (item_entries));

    e_shell_window_register_new_source_actions (
        E_SHELL_WINDOW (window), backend_name,
        source_entries, G_N_ELEMENTS (source_entries));

    g_signal_connect_swapped (
        shell, "event::mail-icon",
        G_CALLBACK (mail_shell_backend_mail_icon_cb), window);

    g_object_weak_ref (
        G_OBJECT (window), (GWeakNotify)
        mail_shell_backend_window_weak_notify_cb, shell);
}

static void
mail_shell_backend_constructed (GObject *object)
{
    EShell *shell;
    EShellBackend *shell_backend;
    GtkWidget *preferences_window;

    shell_backend = E_SHELL_BACKEND (object);
    shell = e_shell_backend_get_shell (shell_backend);

    /* Chain up to parent's constructed() method. */
    G_OBJECT_CLASS (e_mail_shell_backend_parent_class)->constructed (object);

    /* Register format types for EMFormatHook. */
    em_format_hook_register_type (em_format_get_type ());
    em_format_hook_register_type (em_format_html_get_type ());
    em_format_hook_register_type (em_format_html_display_get_type ());

    /* Register plugin hook types. */
    em_format_hook_get_type ();

    mail_shell_backend_init_importers ();

    g_signal_connect (
        shell, "handle-uri",
        G_CALLBACK (mail_shell_backend_handle_uri_cb),
        shell_backend);

    g_signal_connect (
        shell, "prepare-for-quit",
        G_CALLBACK (mail_shell_backend_prepare_for_quit_cb),
        shell_backend);

    g_signal_connect (
        shell, "window-added",
        G_CALLBACK (mail_shell_backend_window_added_cb),
        shell_backend);

    e_mail_shell_settings_init (shell_backend);

    /* Setup preference widget factories */
    preferences_window = e_shell_get_preferences_window (shell);

    e_preferences_window_add_page (
        E_PREFERENCES_WINDOW (preferences_window),
        "mail-accounts",
        "preferences-mail-accounts",
        _("Mail Accounts"),
        em_account_prefs_new,
        100);

    e_preferences_window_add_page (
        E_PREFERENCES_WINDOW (preferences_window),
        "mail",
        "preferences-mail",
        _("Mail Preferences"),
        em_mailer_prefs_new,
        300);

    e_preferences_window_add_page (
        E_PREFERENCES_WINDOW (preferences_window),
        "composer",
        "preferences-composer",
        _("Composer Preferences"),
        em_composer_prefs_new,
        400);

    e_preferences_window_add_page (
        E_PREFERENCES_WINDOW (preferences_window),
        "system-network-proxy",
        "preferences-system-network-proxy",
        _("Network Preferences"),
        em_network_prefs_new,
        500);
}

static void
mail_shell_backend_start (EShellBackend *shell_backend)
{
    EMailShellBackendPrivate *priv;
    EShell *shell;
    EShellSettings *shell_settings;
    EMailBackend *backend;
    EMailSession *session;
    EMailAccountStore *account_store;
    gboolean enable_search_folders;
    GError *error = NULL;

    priv = E_MAIL_SHELL_BACKEND_GET_PRIVATE (shell_backend);

    shell = e_shell_backend_get_shell (shell_backend);
    shell_settings = e_shell_get_shell_settings (shell);

    backend = E_MAIL_BACKEND (shell_backend);
    session = e_mail_backend_get_session (backend);
    account_store = e_mail_session_get_account_store (session);

    enable_search_folders = e_shell_settings_get_boolean (
        shell_settings, "mail-enable-search-folders");
    if (enable_search_folders)
        vfolder_load_storage (backend);

    if (!e_mail_account_store_load_sort_order (account_store, &error)) {
        g_warning ("%s: %s", G_STRFUNC, error->message);
        g_error_free (error);
    }

    mail_autoreceive_init (backend);

    if (g_getenv ("CAMEL_FLUSH_CHANGES") != NULL)
        priv->mail_sync_source_id = g_timeout_add_seconds (
            mail_config_get_sync_timeout (),
            (GSourceFunc) mail_shell_backend_mail_sync,
            shell_backend);
}

static gboolean
mail_shell_backend_delete_junk_policy_decision (EMailBackend *backend)
{
    EShell *shell;
    EShellSettings *shell_settings;
    GSettings *settings;
    gboolean delete_junk;
    gint empty_date;
    gint empty_days;
    gint now;

    shell = e_shell_backend_get_shell (E_SHELL_BACKEND (backend));

    settings = g_settings_new ("org.gnome.evolution.mail");
    shell_settings = e_shell_get_shell_settings (shell);

    now = time (NULL) / 60 / 60 / 24;

    delete_junk = e_shell_settings_get_boolean (
        shell_settings, "mail-empty-junk-on-exit");

    /* XXX No EShellSettings properties for these keys. */

    empty_date = empty_days = 0;

    if (delete_junk) {
        empty_days = g_settings_get_int (settings, "junk-empty-on-exit-days");
        empty_date = g_settings_get_int (settings, "junk-empty-date");
    }

    delete_junk &= (empty_days == 0) || (empty_date + empty_days <= now);

    if (delete_junk) {
        g_settings_set_int (settings, "junk-empty-date", now);
    }

    g_object_unref (settings);

    return delete_junk;
}

static gboolean
mail_shell_backend_empty_trash_policy_decision (EMailBackend *backend)
{
    EShell *shell;
    EShellSettings *shell_settings;
    GSettings *settings;
    gboolean empty_trash;
    gint empty_date;
    gint empty_days;
    gint now;

    shell = e_shell_backend_get_shell (E_SHELL_BACKEND (backend));

    settings = g_settings_new ("org.gnome.evolution.mail");
    shell_settings = e_shell_get_shell_settings (shell);

    now = time (NULL) / 60 / 60 / 24;

    empty_trash = e_shell_settings_get_boolean (
        shell_settings, "mail-empty-trash-on-exit");

    /* XXX No EShellSettings properties for these keys. */

    empty_date = empty_days = 0;

    if (empty_trash) {
        empty_days = g_settings_get_int (settings, "trash-empty-on-exit-days");
        empty_date = g_settings_get_int (settings, "trash-empty-date");
    }

    empty_trash &= (empty_days == 0) || (empty_date + empty_days <= now);

    if (empty_trash) {
        g_settings_set_int (settings, "trash-empty-date", now);
    }

    g_object_unref (settings);

    return empty_trash;
}

static void
e_mail_shell_backend_class_init (EMailShellBackendClass *class)
{
    GObjectClass *object_class;
    EShellBackendClass *shell_backend_class;
    EMailBackendClass *mail_backend_class;

    g_type_class_add_private (class, sizeof (EMailShellBackendPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->constructed = mail_shell_backend_constructed;

    shell_backend_class = E_SHELL_BACKEND_CLASS (class);
    shell_backend_class->shell_view_type = E_TYPE_MAIL_SHELL_VIEW;
    shell_backend_class->name = BACKEND_NAME;
    shell_backend_class->aliases = "";
    shell_backend_class->schemes = "mailto:email";
    shell_backend_class->sort_order = 200;
    shell_backend_class->preferences_page = "mail-accounts";
    shell_backend_class->start = mail_shell_backend_start;

    mail_backend_class = E_MAIL_BACKEND_CLASS (class);
    mail_backend_class->delete_junk_policy_decision =
        mail_shell_backend_delete_junk_policy_decision;
    mail_backend_class->empty_trash_policy_decision =
        mail_shell_backend_empty_trash_policy_decision;
}

static void
e_mail_shell_backend_class_finalize (EMailShellBackendClass *class)
{
}

static void
e_mail_shell_backend_init (EMailShellBackend *mail_shell_backend)
{
    mail_shell_backend->priv =
        E_MAIL_SHELL_BACKEND_GET_PRIVATE (mail_shell_backend);
}

void
e_mail_shell_backend_type_register (GTypeModule *type_module)
{
    /* XXX G_DEFINE_DYNAMIC_TYPE declares a static type registration
     *     function, so we have to wrap it with a public function in
     *     order to register types from a separate compilation unit. */
    e_mail_shell_backend_register_type (type_module);
}

/******************* Code below here belongs elsewhere. *******************/

#include "filter/e-filter-option.h"
#include "shell/e-shell-settings.h"
#include "mail/e-mail-label-list-store.h"

GSList *
e_mail_labels_get_filter_options (void)
{
    EShell *shell;
    EShellSettings *shell_settings;
    EMailLabelListStore *list_store;
    GtkTreeModel *model;
    GtkTreeIter iter;
    GSList *list = NULL;
    gboolean valid;

    shell = e_shell_get_default ();
    shell_settings = e_shell_get_shell_settings (shell);
    list_store = e_shell_settings_get_object (
        shell_settings, "mail-label-list-store");

    model = GTK_TREE_MODEL (list_store);
    valid = gtk_tree_model_get_iter_first (model, &iter);

    while (valid) {
        struct _filter_option *option;
        gchar *name, *tag;

        name = e_mail_label_list_store_get_name (list_store, &iter);
        tag = e_mail_label_list_store_get_tag (list_store, &iter);

        if (g_str_has_prefix (tag, "$Label")) {
            gchar *tmp = tag;

            tag = g_strdup (tag + 6);

            g_free (tmp);
        }

        option = g_new0 (struct _filter_option, 1);
        option->title = e_str_without_underscores (name);
        option->value = tag;  /* takes ownership */
        list = g_slist_prepend (list, option);

        g_free (name);

        valid = gtk_tree_model_iter_next (model, &iter);
    }

    g_object_unref (list_store);

    return g_slist_reverse (list);
}

/* utility functions for mbox importer */
static void
mbox_create_preview_cb (GObject *preview,
                        GtkWidget **preview_widget)
{
    EMFormatHTMLDisplay *format;
    EWebView *web_view;

    g_return_if_fail (preview != NULL);
    g_return_if_fail (preview_widget != NULL);

    format = em_format_html_display_new ();
    g_object_set_data_full (
        preview, "mbox-imp-formatter", format, g_object_unref);
    web_view = em_format_html_get_web_view (EM_FORMAT_HTML (format));

    *preview_widget = GTK_WIDGET (web_view);
}

static void
mbox_fill_preview_cb (GObject *preview,
                      CamelMimeMessage *msg)
{
    EMFormatHTMLDisplay *format;

    g_return_if_fail (preview != NULL);
    g_return_if_fail (msg != NULL);

    format = g_object_get_data (preview, "mbox-imp-formatter");
    g_return_if_fail (format != NULL);

    /* FIXME Not passing a GCancellable here. */
    em_format_format (EM_FORMAT (format), NULL, NULL, msg, NULL);
}