path: root/modules/calendar/e-task-shell-view-private.c

/*
 * e-task-shell-view-private.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-task-shell-view-private.h"

#include "widgets/menus/gal-view-factory-etable.h"

#include "e-util/e-util-private.h"

static void
task_shell_view_model_row_appended_cb (ETaskShellView *task_shell_view,
                                       ECalModel *model)
{
    ETaskShellSidebar *task_shell_sidebar;
    ECalClient *client;
    ESource *source;

    /* This is the "Click to Add" handler. */

    client = e_cal_model_get_default_client (model);
    source = e_client_get_source (E_CLIENT (client));

    task_shell_sidebar = task_shell_view->priv->task_shell_sidebar;
    e_task_shell_sidebar_add_source (task_shell_sidebar, source);
}

static gboolean
task_shell_view_process_completed_tasks (ETaskShellView *task_shell_view)
{
    ETaskShellContent *task_shell_content;
    ETaskShellSidebar *task_shell_sidebar;
    ETaskTable *task_table;
    GList *clients;

    task_shell_view->priv->update_completed_timeout = 0;

    task_shell_content = task_shell_view->priv->task_shell_content;
    task_table = e_task_shell_content_get_task_table (task_shell_content);

    task_shell_sidebar = task_shell_view->priv->task_shell_sidebar;
    clients = e_task_shell_sidebar_get_clients (task_shell_sidebar);

    e_task_table_process_completed_tasks (task_table, clients, TRUE);

    /* Search query takes whether to show completed tasks into account,
     * so if the preference has changed we need to update the query. */
    e_shell_view_execute_search (E_SHELL_VIEW (task_shell_view));

    g_list_free (clients);

    return FALSE;
}

static void
task_shell_view_schedule_process_completed_tasks (ETaskShellView *task_shell_view)
{
    guint source_id;

    source_id = task_shell_view->priv->update_completed_timeout;

    if (source_id > 0)
        g_source_remove (source_id);

    source_id = g_timeout_add_seconds (
        1, (GSourceFunc) task_shell_view_process_completed_tasks,
        task_shell_view);

    task_shell_view->priv->update_completed_timeout = source_id;
}

static void
task_shell_view_table_popup_event_cb (EShellView *shell_view,
                                      GdkEventButton *event)
{
    const gchar *widget_path;

    widget_path = "/task-popup";
    e_shell_view_show_popup_menu (shell_view, widget_path, event);
}

static void
task_shell_view_selector_client_added_cb (ETaskShellView *task_shell_view,
                                          ECalClient *client)
{
    ETaskShellContent *task_shell_content;
    ETaskTable *task_table;
    ECalModel *model;

    task_shell_content = task_shell_view->priv->task_shell_content;
    task_table = e_task_shell_content_get_task_table (task_shell_content);
    model = e_task_table_get_model (task_table);

    e_cal_model_add_client (model, client);
    e_task_shell_view_update_timezone (task_shell_view);
}

static void
task_shell_view_selector_client_removed_cb (ETaskShellView *task_shell_view,
                                            ECalClient *client)
{
    ETaskShellContent *task_shell_content;
    ETaskTable *task_table;
    ECalModel *model;

    task_shell_content = task_shell_view->priv->task_shell_content;
    task_table = e_task_shell_content_get_task_table (task_shell_content);
    model = e_task_table_get_model (task_table);

    e_cal_model_remove_client (model, client);
}

static gboolean
task_shell_view_selector_popup_event_cb (EShellView *shell_view,
                                         ESource *primary_source,
                                         GdkEventButton *event)
{
    const gchar *widget_path;

    widget_path = "/task-list-popup";
    e_shell_view_show_popup_menu (shell_view, widget_path, event);

    return TRUE;
}

static gboolean
task_shell_view_update_timeout_cb (ETaskShellView *task_shell_view)
{
    ETaskShellContent *task_shell_content;
    ETaskShellSidebar *task_shell_sidebar;
    ETaskTable *task_table;
    ECalModel *model;
    GList *clients;

    task_shell_content = task_shell_view->priv->task_shell_content;
    task_table = e_task_shell_content_get_task_table (task_shell_content);
    model = e_task_table_get_model (task_table);

    task_shell_sidebar = task_shell_view->priv->task_shell_sidebar;
    clients = e_task_shell_sidebar_get_clients (task_shell_sidebar);

    e_task_table_process_completed_tasks (task_table, clients, FALSE);
    e_cal_model_tasks_update_due_tasks (E_CAL_MODEL_TASKS (model));

    g_list_free (clients);

    return TRUE;
}

static void
task_shell_view_load_view_collection (EShellViewClass *shell_view_class)
{
    GalViewCollection *collection;
    GalViewFactory *factory;
    ETableSpecification *spec;
    const gchar *base_dir;
    gchar *filename;

    collection = shell_view_class->view_collection;

    base_dir = EVOLUTION_ETSPECDIR;
    spec = e_table_specification_new ();
    filename = g_build_filename (base_dir, ETSPEC_FILENAME, NULL);
    if (!e_table_specification_load_from_file (spec, filename))
        g_critical ("Unable to load ETable specification file "
                "for tasks");
    g_free (filename);

    factory = gal_view_factory_etable_new (spec);
    gal_view_collection_add_factory (collection, factory);
    g_object_unref (factory);
    g_object_unref (spec);

    gal_view_collection_load (collection);
}

static void
task_shell_view_notify_view_id_cb (ETaskShellView *task_shell_view)
{
    ETaskShellContent *task_shell_content;
    GalViewInstance *view_instance;
    const gchar *view_id;

    task_shell_content = task_shell_view->priv->task_shell_content;
    view_instance =
        e_task_shell_content_get_view_instance (task_shell_content);
    view_id = e_shell_view_get_view_id (E_SHELL_VIEW (task_shell_view));

    /* A NULL view ID implies we're in a custom view.  But you can
     * only get to a custom view via the "Define Views" dialog, which
     * would have already modified the view instance appropriately.
     * Furthermore, there's no way to refer to a custom view by ID
     * anyway, since custom views have no IDs. */
    if (view_id == NULL)
        return;

    gal_view_instance_set_current_view_id (view_instance, view_id);
}

void
e_task_shell_view_private_init (ETaskShellView *task_shell_view,
                                EShellViewClass *shell_view_class)
{
    if (!gal_view_collection_loaded (shell_view_class->view_collection))
        task_shell_view_load_view_collection (shell_view_class);

    g_signal_connect (
        task_shell_view, "notify::view-id",
        G_CALLBACK (task_shell_view_notify_view_id_cb), NULL);
}

void
e_task_shell_view_private_constructed (ETaskShellView *task_shell_view)
{
    ETaskShellViewPrivate *priv = task_shell_view->priv;
    ETaskShellContent *task_shell_content;
    ETaskShellSidebar *task_shell_sidebar;
    EShell *shell;
    EShellView *shell_view;
    EShellBackend *shell_backend;
    EShellContent *shell_content;
    EShellSidebar *shell_sidebar;
    EShellSettings *shell_settings;
    EShellWindow *shell_window;
    ETaskTable *task_table;
    ECalModel *model;
    ESourceSelector *selector;

    shell_view = E_SHELL_VIEW (task_shell_view);
    shell_backend = e_shell_view_get_shell_backend (shell_view);
    shell_content = e_shell_view_get_shell_content (shell_view);
    shell_sidebar = e_shell_view_get_shell_sidebar (shell_view);
    shell_window = e_shell_view_get_shell_window (shell_view);

    shell = e_shell_window_get_shell (shell_window);
    shell_settings = e_shell_get_shell_settings (shell);

    e_shell_window_add_action_group (shell_window, "tasks");
    e_shell_window_add_action_group (shell_window, "tasks-filter");

    /* Cache these to avoid lots of awkward casting. */
    priv->task_shell_backend = g_object_ref (shell_backend);
    priv->task_shell_content = g_object_ref (shell_content);
    priv->task_shell_sidebar = g_object_ref (shell_sidebar);

    task_shell_content = E_TASK_SHELL_CONTENT (shell_content);
    task_table = e_task_shell_content_get_task_table (task_shell_content);
    model = e_task_table_get_model (task_table);

    task_shell_sidebar = E_TASK_SHELL_SIDEBAR (shell_sidebar);
    selector = e_task_shell_sidebar_get_selector (task_shell_sidebar);

    g_signal_connect_object (
        model, "notify::timezone",
        G_CALLBACK (e_task_shell_view_update_timezone),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        model, "row-appended",
        G_CALLBACK (task_shell_view_model_row_appended_cb),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_table, "open-component",
        G_CALLBACK (e_task_shell_view_open_task),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_table, "popup-event",
        G_CALLBACK (task_shell_view_table_popup_event_cb),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_table, "selection-change",
        G_CALLBACK (e_task_shell_view_update_sidebar),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_table, "selection-change",
        G_CALLBACK (e_shell_view_update_actions),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_table, "status-message",
        G_CALLBACK (e_task_shell_view_set_status_message),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        model, "model-changed",
        G_CALLBACK (e_task_shell_view_update_sidebar),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        model, "model-rows-deleted",
        G_CALLBACK (e_task_shell_view_update_sidebar),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        model, "model-rows-inserted",
        G_CALLBACK (e_task_shell_view_update_sidebar),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_shell_sidebar, "client-added",
        G_CALLBACK (task_shell_view_selector_client_added_cb),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_shell_sidebar, "client-removed",
        G_CALLBACK (task_shell_view_selector_client_removed_cb),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        task_shell_sidebar, "status-message",
        G_CALLBACK (e_task_shell_view_set_status_message),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        selector, "popup-event",
        G_CALLBACK (task_shell_view_selector_popup_event_cb),
        task_shell_view, G_CONNECT_SWAPPED);

    g_signal_connect_object (
        selector, "primary-selection-changed",
        G_CALLBACK (e_shell_view_update_actions),
        task_shell_view, G_CONNECT_SWAPPED);

    e_categories_add_change_hook (
        (GHookFunc) e_task_shell_view_update_search_filter,
        task_shell_view);

    /* Listen for configuration changes. */
    g_object_bind_property (
        shell_settings, "cal-confirm-purge",
        task_shell_view, "confirm-purge",
        G_BINDING_BIDIRECTIONAL |
        G_BINDING_SYNC_CREATE);

    /* Keep the ECalModel in sync with the sidebar. */
    g_object_bind_property (
        shell_sidebar, "default-client",
        model, "default-client",
        G_BINDING_SYNC_CREATE);

    /* Hide Completed Tasks (enable/units/value) */
    g_signal_connect_object (
        shell_settings, "notify::cal-hide-completed-tasks",
        G_CALLBACK (task_shell_view_schedule_process_completed_tasks),
        task_shell_view, G_CONNECT_SWAPPED);
    g_signal_connect_object (
        shell_settings, "notify::cal-hide-completed-tasks-units",
        G_CALLBACK (task_shell_view_schedule_process_completed_tasks),
        task_shell_view, G_CONNECT_SWAPPED);
    g_signal_connect_object (
        shell_settings, "notify::cal-hide-completed-tasks-value",
        G_CALLBACK (task_shell_view_schedule_process_completed_tasks),
        task_shell_view, G_CONNECT_SWAPPED);

    e_task_shell_view_actions_init (task_shell_view);
    e_task_shell_view_update_sidebar (task_shell_view);
    e_task_shell_view_update_search_filter (task_shell_view);
    e_task_shell_view_update_timezone (task_shell_view);

    /* Call this when everything is ready, like actions in
     * action groups and such. */
    task_shell_view_update_timeout_cb (task_shell_view);
    priv->update_timeout = g_timeout_add_full (
        G_PRIORITY_LOW, 60000, (GSourceFunc)
        task_shell_view_update_timeout_cb,
        task_shell_view, NULL);
}

void
e_task_shell_view_private_dispose (ETaskShellView *task_shell_view)
{
    ETaskShellViewPrivate *priv = task_shell_view->priv;

    DISPOSE (priv->task_shell_backend);
    DISPOSE (priv->task_shell_content);
    DISPOSE (priv->task_shell_sidebar);

    if (task_shell_view->priv->activity != NULL) {
        /* XXX Activity is not cancellable. */
        e_activity_set_state (
            task_shell_view->priv->activity,
            E_ACTIVITY_COMPLETED);
        g_object_unref (task_shell_view->priv->activity);
        task_shell_view->priv->activity = NULL;
    }

    if (priv->update_timeout > 0) {
        g_source_remove (priv->update_timeout);
        priv->update_timeout = 0;
    }

    if (priv->update_completed_timeout > 0) {
        g_source_remove (priv->update_completed_timeout);
        priv->update_completed_timeout = 0;
    }
}

void
e_task_shell_view_private_finalize (ETaskShellView *task_shell_view)
{
    /* XXX Nothing to do? */
}

void
e_task_shell_view_open_task (ETaskShellView *task_shell_view,
                             ECalModelComponent *comp_data)
{
    EShell *shell;
    EShellView *shell_view;
    EShellWindow *shell_window;
    ESourceRegistry *registry;
    CompEditor *editor;
    CompEditorFlags flags = 0;
    ECalComponent *comp;
    icalcomponent *clone;
    icalproperty *prop;
    const gchar *uid;

    g_return_if_fail (E_IS_TASK_SHELL_VIEW (task_shell_view));
    g_return_if_fail (E_IS_CAL_MODEL_COMPONENT (comp_data));

    shell_view = E_SHELL_VIEW (task_shell_view);
    shell_window = e_shell_view_get_shell_window (shell_view);
    shell = e_shell_window_get_shell (shell_window);

    registry = e_shell_get_registry (shell);

    uid = icalcomponent_get_uid (comp_data->icalcomp);
    editor = comp_editor_find_instance (uid);

    if (editor != NULL)
        goto exit;

    comp = e_cal_component_new ();
    clone = icalcomponent_new_clone (comp_data->icalcomp);
    e_cal_component_set_icalcomponent (comp, clone);

    prop = icalcomponent_get_first_property (
        comp_data->icalcomp, ICAL_ATTENDEE_PROPERTY);
    if (prop != NULL)
        flags |= COMP_EDITOR_IS_ASSIGNED;

    if (itip_organizer_is_user (registry, comp, comp_data->client))
        flags |= COMP_EDITOR_USER_ORG;

    if (!e_cal_component_has_attendees (comp))
        flags |= COMP_EDITOR_USER_ORG;

    editor = task_editor_new (comp_data->client, shell, flags);
    comp_editor_edit_comp (editor, comp);

    g_object_unref (comp);

    if (flags & COMP_EDITOR_IS_ASSIGNED)
        task_editor_show_assignment (TASK_EDITOR (editor));

exit:
    gtk_window_present (GTK_WINDOW (editor));
}

void
e_task_shell_view_delete_completed (ETaskShellView *task_shell_view)
{
    ETaskShellSidebar *task_shell_sidebar;
    GList *list, *iter;
    const gchar *sexp;

    g_return_if_fail (E_IS_TASK_SHELL_VIEW (task_shell_view));

    sexp = "(is-completed?)";

    task_shell_sidebar = task_shell_view->priv->task_shell_sidebar;
    list = e_task_shell_sidebar_get_clients (task_shell_sidebar);

    e_task_shell_view_set_status_message (
        task_shell_view, _("Expunging"), -1.0);

    for (iter = list; iter != NULL; iter = iter->next) {
        ECalClient *client = E_CAL_CLIENT (iter->data);
        GSList *objects, *obj;
        GError *error = NULL;

        if (e_client_is_readonly (E_CLIENT (client)))
            continue;

        e_cal_client_get_object_list_sync (
            client, sexp, &objects, NULL, &error);

        if (error != NULL) {
            g_warning (
                "%s: Failed to get object list: %s",
                G_STRFUNC, error->message);
            g_clear_error (&error);
            continue;
        }

        for (obj = objects; obj != NULL; obj = obj->next) {
            icalcomponent *component = obj->data;
            const gchar *uid;

            uid = icalcomponent_get_uid (component);

            e_cal_client_remove_object_sync (
                client, uid, NULL,
                CALOBJ_MOD_THIS, NULL, &error);

            if (error != NULL) {
                g_warning (
                    "%s: Failed to remove object: %s",
                    G_STRFUNC, error->message);
                g_clear_error (&error);
            }
        }

        e_cal_client_free_icalcomp_slist (objects);
    }

    e_task_shell_view_set_status_message (task_shell_view, NULL, -1.0);
}

void
e_task_shell_view_set_status_message (ETaskShellView *task_shell_view,
                                      const gchar *status_message,
                                      gdouble percent)
{
    EActivity *activity;
    EShellView *shell_view;
    EShellBackend *shell_backend;

    g_return_if_fail (E_IS_TASK_SHELL_VIEW (task_shell_view));

    activity = task_shell_view->priv->activity;
    shell_view = E_SHELL_VIEW (task_shell_view);
    shell_backend = e_shell_view_get_shell_backend (shell_view);

    if (status_message == NULL || *status_message == '\0') {
        if (activity != NULL) {
            e_activity_set_state (activity, E_ACTIVITY_COMPLETED);
            g_object_unref (activity);
            activity = NULL;
        }

    } else if (activity == NULL) {
        activity = e_activity_new ();
        e_activity_set_percent (activity, percent);
        e_activity_set_text (activity, status_message);
        e_shell_backend_add_activity (shell_backend, activity);

    } else {
        e_activity_set_percent (activity, percent);
        e_activity_set_text (activity, status_message);
    }

    task_shell_view->priv->activity = activity;
}

void
e_task_shell_view_update_sidebar (ETaskShellView *task_shell_view)
{
    ETaskShellContent *task_shell_content;
    EShellView *shell_view;
    EShellSidebar *shell_sidebar;
    ETaskTable *task_table;
    ECalModel *model;
    GString *string;
    const gchar *format;
    gint n_rows;
    gint n_selected;

    shell_view = E_SHELL_VIEW (task_shell_view);
    shell_sidebar = e_shell_view_get_shell_sidebar (shell_view);

    task_shell_content = task_shell_view->priv->task_shell_content;
    task_table = e_task_shell_content_get_task_table (task_shell_content);

    model = e_task_table_get_model (task_table);

    n_rows = e_table_model_row_count (E_TABLE_MODEL (model));
    n_selected = e_table_selected_count (E_TABLE (task_table));

    string = g_string_sized_new (64);

    format = ngettext ("%d task", "%d tasks", n_rows);
    g_string_append_printf (string, format, n_rows);

    if (n_selected > 0) {
        format = _("%d selected");
        g_string_append_len (string, ", ", 2);
        g_string_append_printf (string, format, n_selected);
    }

    e_shell_sidebar_set_secondary_text (shell_sidebar, string->str);

    g_string_free (string, TRUE);
}

void
e_task_shell_view_update_timezone (ETaskShellView *task_shell_view)
{
    ETaskShellContent *task_shell_content;
    ETaskShellSidebar *task_shell_sidebar;
    icaltimezone *timezone;
    ECalModel *model;
    GList *clients, *iter;

    task_shell_content = task_shell_view->priv->task_shell_content;
    model = e_task_shell_content_get_task_model (task_shell_content);
    timezone = e_cal_model_get_timezone (model);

    task_shell_sidebar = task_shell_view->priv->task_shell_sidebar;
    clients = e_task_shell_sidebar_get_clients (task_shell_sidebar);

    for (iter = clients; iter != NULL; iter = iter->next) {
        ECalClient *client = iter->data;

        if (e_client_is_opened (E_CLIENT (client)))
            e_cal_client_set_default_timezone (client, timezone);
    }

    g_list_free (clients);
}