path: root/modules/addressbook/e-book-shell-backend.c

/*
 * e-book-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-book-shell-backend.h"

#include <string.h>
#include <glib/gi18n.h>
#include <libebook/e-book-client.h>
#include <libedataserver/e-url.h>
#include <libedataserver/e-source.h>
#include <libedataserver/e-source-group.h>
#include <libedataserverui/e-client-utils.h>

#include "e-util/e-import.h"
#include "shell/e-shell.h"
#include "shell/e-shell-window.h"
#include "widgets/misc/e-preferences-window.h"

#include "addressbook/gui/widgets/eab-gui-util.h"
#include "addressbook/gui/contact-editor/e-contact-editor.h"
#include "addressbook/gui/contact-editor/e-contact-quick-add.h"
#include "addressbook/gui/contact-list-editor/e-contact-list-editor.h"
#include "addressbook/importers/evolution-addressbook-importers.h"

#include "addressbook-config.h"
#include "autocompletion-config.h"

#include "e-book-shell-migrate.h"
#include "e-book-shell-settings.h"
#include "e-book-shell-view.h"

#ifdef ENABLE_SMIME
#include "smime/gui/component.h"
#include "smime/gui/certificate-manager.h"
#endif

#define E_BOOK_SHELL_BACKEND_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), E_TYPE_BOOK_SHELL_BACKEND, EBookShellBackendPrivate))

struct _EBookShellBackendPrivate {
    ESourceList *source_list;
};

enum {
    PROP_0,
    PROP_SOURCE_LIST
};

G_DEFINE_DYNAMIC_TYPE (
    EBookShellBackend,
    e_book_shell_backend,
    E_TYPE_SHELL_BACKEND)

static void
book_shell_backend_ensure_sources (EShellBackend *shell_backend)
{
    /* XXX This is basically the same algorithm across all backends.
     *     Maybe we could somehow integrate this into EShellBackend? */

    EBookShellBackendPrivate *priv;
    ESourceGroup *on_this_computer;
    ESource *personal;
    GSList *sources, *iter;
    const gchar *name;
    GError *error = NULL;

    on_this_computer = NULL;
    personal = NULL;

    priv = E_BOOK_SHELL_BACKEND_GET_PRIVATE (shell_backend);

    e_book_client_get_sources (&priv->source_list, &error);

    if (error != NULL) {
        g_warning (
            "Could not get addressbook sources: %s",
            error->message);
        g_error_free (error);
        return;
    }

    on_this_computer = e_source_list_ensure_group (
        priv->source_list, _("On This Computer"), "local:", TRUE);
    e_source_list_ensure_group (
        priv->source_list, _("On LDAP Servers"), "ldap://", FALSE);

    g_return_if_fail (on_this_computer != NULL);

    sources = e_source_group_peek_sources (on_this_computer);

    /* Make sure this group includes a "Personal" source. */
    for (iter = sources; iter != NULL; iter = iter->next) {
        ESource *source = iter->data;
        const gchar *relative_uri;

        relative_uri = e_source_peek_relative_uri (source);
        if (g_strcmp0 (relative_uri, "system") == 0) {
            personal = source;
            break;
        }
    }

    name = _("Personal");

    if (personal == NULL) {
        ESource *source;

        /* Create the default Personal address book. */
        source = e_source_new (name, "system");
        e_source_group_add_source (on_this_computer, source, -1);
        e_source_set_property (source, "completion", "true");
        g_object_unref (source);
        e_source_list_sync (priv->source_list, NULL);       
    } else if (!e_source_get_property (personal, "name-changed")) {
        /* Force the source name to the current locale. */
        e_source_set_name (personal, name);
        e_source_list_sync (priv->source_list, NULL);       
    }

    g_object_unref (on_this_computer);
}

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

    import_class = g_type_class_ref (e_import_get_type ());

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

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

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

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

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

static void
book_shell_backend_new_contact_cb (GObject *source_object,
                                   GAsyncResult *result,
                                   gpointer user_data)
{
    ESource *source = E_SOURCE (source_object);
    EShell *shell = user_data;
    EClient *client = NULL;
    EContact *contact;
    EABEditor *editor;
    GError *error = NULL;

    e_client_utils_open_new_finish (source, result, &client, &error);

    /* XXX Handle errors better. */
    if (error != NULL) {
        g_warn_if_fail (client == NULL);
        g_warning (
            "%s: Failed to open book: %s",
            G_STRFUNC, error->message);
        g_error_free (error);
        goto exit;
    }

    g_return_if_fail (E_IS_CLIENT (client));

    contact = e_contact_new ();

    editor = e_contact_editor_new (
        shell, E_BOOK_CLIENT (client), contact, TRUE, TRUE);

    eab_editor_show (editor);

    g_object_unref (contact);
    g_object_unref (client);

exit:
    g_object_unref (shell);
}

static void
book_shell_backend_new_contact_list_cb (GObject *source_object,
                                        GAsyncResult *result,
                                        gpointer user_data)
{
    ESource *source = E_SOURCE (source_object);
    EShell *shell = user_data;
    EClient *client = NULL;
    EContact *contact;
    EABEditor *editor;
    GError *error = NULL;

    e_client_utils_open_new_finish (source, result, &client, &error);

    /* XXX Handle errors better. */
    if (error != NULL) {
        g_warn_if_fail (client == NULL);
        g_warning (
            "%s: Failed to open book: %s",
            G_STRFUNC, error->message);
        g_error_free (error);
        goto exit;
    }

    g_return_if_fail (E_IS_CLIENT (client));

    contact = e_contact_new ();

    editor = e_contact_list_editor_new (
        shell, E_BOOK_CLIENT (client), contact, TRUE, TRUE);

    eab_editor_show (editor);

    g_object_unref (contact);
    g_object_unref (client);

exit:
    g_object_unref (shell);
}

static void
action_contact_new_cb (GtkAction *action,
                       EShellWindow *shell_window)
{
    EShell *shell;
    EShellBackend *shell_backend;
    GSettings *settings;
    ESourceList *source_list;
    ESource *source = NULL;
    const gchar *action_name;
    gchar *uid;

    /* This callback is used for both contacts and contact lists. */

    shell = e_shell_window_get_shell (shell_window);
    shell_backend = e_shell_get_backend_by_name (shell, "addressbook");

    g_object_get (shell_backend, "source-list", &source_list, NULL);
    g_return_if_fail (E_IS_SOURCE_LIST (source_list));

    settings = g_settings_new ("org.gnome.evolution.addressbook");
    uid = g_settings_get_string (settings, "primary-addressbook");
    g_object_unref (settings);

    if (uid != NULL) {
        source = e_source_list_peek_source_by_uid (source_list, uid);
        g_free (uid);
    }

    if (source == NULL)
        source = e_source_list_peek_default_source (source_list);

    g_return_if_fail (E_IS_SOURCE (source));

    /* Use a callback function appropriate for the action. */
    action_name = gtk_action_get_name (action);
    if (strcmp (action_name, "contact-new") == 0)
        e_client_utils_open_new (source, E_CLIENT_SOURCE_TYPE_CONTACTS, FALSE, NULL,
            e_client_utils_authenticate_handler, GTK_WINDOW (shell_window),
            book_shell_backend_new_contact_cb, g_object_ref (shell));
    if (strcmp (action_name, "contact-new-list") == 0)
        e_client_utils_open_new (source, E_CLIENT_SOURCE_TYPE_CONTACTS, FALSE, NULL,
            e_client_utils_authenticate_handler, GTK_WINDOW (shell_window),
            book_shell_backend_new_contact_list_cb, g_object_ref (shell));

    g_object_unref (source_list);
}

static void
action_address_book_new_cb (GtkAction *action,
                            EShellWindow *shell_window)
{
    addressbook_config_create_new_source (NULL);
}

static GtkActionEntry item_entries[] = {

    { "contact-new",
      "contact-new",
      NC_("New", "_Contact"),
      "<Shift><Control>c",
      N_("Create a new contact"),
      G_CALLBACK (action_contact_new_cb) },

    { "contact-new-list",
      "stock_contact-list",
      NC_("New", "Contact _List"),
      "<Shift><Control>l",
      N_("Create a new contact list"),
      G_CALLBACK (action_contact_new_cb) }
};

static GtkActionEntry source_entries[] = {

    { "address-book-new",
      "address-book-new",
      NC_("New", "Address _Book"),
      NULL,
      N_("Create a new address book"),
      G_CALLBACK (action_address_book_new_cb) }
};

static gboolean
book_shell_backend_init_preferences (EShell *shell)
{
    GtkWidget *preferences_window;

    /* This is a main loop idle callback. */

    preferences_window = e_shell_get_preferences_window (shell);

    e_preferences_window_add_page (
        E_PREFERENCES_WINDOW (preferences_window),
        "contacts",
        "preferences-autocompletion",
        _("Contacts"),
        autocompletion_config_new,
        200);

#ifdef ENABLE_SMIME
    preferences_window = e_shell_get_preferences_window (shell);
    e_preferences_window_add_page (
        E_PREFERENCES_WINDOW (preferences_window),
        "certificates",
        "preferences-certificates",
        _("Certificates"),
        e_cert_manager_config_new,
        700);
#endif

    return FALSE;
}

static void
book_shell_backend_quick_add_email_cb (EShell *shell,
                                       const gchar *email)
{
    /* XXX This is an ugly hack but it's the only way I could think
     *     of to integrate this feature with other shell modules. */

    e_contact_quick_add_email (email, NULL, NULL);
}

static void
book_shell_backend_quick_add_vcard_cb (EShell *shell,
                                       const gchar *vcard)
{
    /* XXX This is an ugly hack but it's the only way I could think
     *     of to integrate this feature with other shell modules. */

    e_contact_quick_add_vcard (vcard, NULL, NULL);
}

static gboolean
book_shell_backend_handle_uri_cb (EShellBackend *shell_backend,
                                  const gchar *uri)
{
    EUri *euri;
    const gchar *cp;
    gchar *source_uid = NULL;
    gchar *contact_uid = NULL;

    if (!g_str_has_prefix (uri, "contacts:"))
        return FALSE;

    euri = e_uri_new (uri);
    cp = euri->query;

    if (cp == NULL) {
        e_uri_free (euri);
        return FALSE;
    }

    while (*cp != '\0') {
        gchar *header;
        gchar *content;
        gsize length;
        gsize content_length;

        length = strcspn (cp, "=&");

        /* If it's malformed, give up. */
        if (cp[length] != '=')
            break;

        header = (gchar *) cp;
        header[length] = '\0';
        cp += length + 1;

        content_length = strcspn (cp, "&");
        content = g_strndup (cp, content_length);

        if (g_ascii_strcasecmp (header, "source-uid") == 0)
            source_uid = g_strdup (content);

        if (g_ascii_strcasecmp (header, "contact-uid") == 0)
            contact_uid = g_strdup (content);

        g_free (content);

        cp += content_length;
        if (*cp == '&') {
            cp++;
            if (strcmp (cp, "amp;"))
                cp += 4;
        }
    }

    /* FIXME */
    /*addressbook_view_edit_contact (view, source_uid, contact_uid);*/

    g_free (source_uid);
    g_free (contact_uid);

    e_uri_free (euri);

    return TRUE;
}

static void
book_shell_backend_window_added_cb (EShellBackend *shell_backend,
                                    GtkWindow *window)
{
    const gchar *backend_name;

    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));
}

static void
book_shell_backend_get_property (GObject *object,
                                 guint property_id,
                                 GValue *value,
                                 GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_SOURCE_LIST:
            g_value_set_object (
                value,
                e_book_shell_backend_get_source_list (
                E_BOOK_SHELL_BACKEND (object)));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
book_shell_backend_dispose (GObject *object)
{
    EBookShellBackendPrivate *priv;

    priv = E_BOOK_SHELL_BACKEND_GET_PRIVATE (object);

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

    /* Chain up to parent's dispose() method. */
    G_OBJECT_CLASS (e_book_shell_backend_parent_class)->dispose (object);
}

static void
book_shell_backend_constructed (GObject *object)
{
    EShell *shell;
    EShellBackend *shell_backend;

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

    /* XXX Why is this here?  Address books aren't the only
     *     things that use S/MIME.  Maybe put it in EShell? */
#ifdef ENABLE_SMIME
    smime_component_init ();
#endif

    book_shell_backend_init_importers ();
    book_shell_backend_ensure_sources (shell_backend);

    g_signal_connect (
        shell, "event::contact-quick-add-email",
        G_CALLBACK (book_shell_backend_quick_add_email_cb), NULL);

    g_signal_connect_swapped (
        shell, "event::contact-quick-add-vcard",
        G_CALLBACK (book_shell_backend_quick_add_vcard_cb), NULL);

    g_signal_connect_swapped (
        shell, "handle-uri",
        G_CALLBACK (book_shell_backend_handle_uri_cb),
        shell_backend);

    g_signal_connect_swapped (
        shell, "window-added",
        G_CALLBACK (book_shell_backend_window_added_cb),
        shell_backend);

    e_book_shell_backend_init_settings (shell);

    /* Initialize preferences after the main loop starts so
     * that all EPlugins and EPluginHooks are loaded first. */
    g_idle_add ((GSourceFunc) book_shell_backend_init_preferences, shell);

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

static void
e_book_shell_backend_class_init (EBookShellBackendClass *class)
{
    GObjectClass *object_class;
    EShellBackendClass *shell_backend_class;

    g_type_class_add_private (class, sizeof (EBookShellBackendPrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->get_property = book_shell_backend_get_property;
    object_class->dispose = book_shell_backend_dispose;
    object_class->constructed = book_shell_backend_constructed;

    shell_backend_class = E_SHELL_BACKEND_CLASS (class);
    shell_backend_class->shell_view_type = E_TYPE_BOOK_SHELL_VIEW;
    shell_backend_class->name = "addressbook";
    shell_backend_class->aliases = "contacts";
    shell_backend_class->schemes = "";
    shell_backend_class->sort_order = 300;
    shell_backend_class->preferences_page = "contacts";
    shell_backend_class->start = NULL;
    shell_backend_class->migrate = e_book_shell_backend_migrate;

    g_object_class_install_property (
        object_class,
        PROP_SOURCE_LIST,
        g_param_spec_object (
            "source-list",
            "Source List",
            "The registry of address books",
            E_TYPE_SOURCE_LIST,
            G_PARAM_READABLE));
}

static void
e_book_shell_backend_class_finalize (EBookShellBackendClass *class)
{
}

static void
e_book_shell_backend_init (EBookShellBackend *book_shell_backend)
{
    book_shell_backend->priv =
        E_BOOK_SHELL_BACKEND_GET_PRIVATE (book_shell_backend);
}

void
e_book_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_book_shell_backend_register_type (type_module);
}

ESourceList *
e_book_shell_backend_get_source_list (EBookShellBackend *book_shell_backend)
{
    g_return_val_if_fail (
        E_IS_BOOK_SHELL_BACKEND (book_shell_backend), NULL);

    return book_shell_backend->priv->source_list;
}