path: root/calendar/gui/migration.c

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* calendar-component.c
 *
 * Copyright (C) 2003  Ximian, Inc
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU 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 General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Rodrigo Moya <rodrigo@ximian.com>
 */

#include <string.h>
#include <bonobo/bonobo-i18n.h>
#include <libgnomevfs/gnome-vfs-uri.h>
#include <libgnomevfs/gnome-vfs-xfer.h>
#include <gtk/gtkwidget.h>
#include <gtk/gtkvbox.h>
#include <gtk/gtkmain.h>
#include <gtk/gtklabel.h>
#include <gtk/gtkprogressbar.h>
#include <gal/util/e-util.h>
#include <libecal/e-cal.h>
#include <e-util/e-bconf-map.h>
#include <e-util/e-folder-map.h>
#include "calendar-config-keys.h"
#include "migration.h"

static e_gconf_map_t calendar_display_map[] = {
    /* /Calendar/Display */
    { "Timezone", "calendar/display/timezone", E_GCONF_MAP_STRING },
    { "Use24HourFormat", "calendar/display/use_24hour_format", E_GCONF_MAP_BOOL },
    { "WeekStartDay", "calendar/display/week_start_day", E_GCONF_MAP_INT },
    { "DayStartHour", "calendar/display/day_start_hour", E_GCONF_MAP_INT },
    { "DayStartMinute", "calendar/display/day_start_minute", E_GCONF_MAP_INT },
    { "DayEndHour", "calendar/display/day_end_hour", E_GCONF_MAP_INT },
    { "DayEndMinute", "calendar/display/day_end_minute", E_GCONF_MAP_INT },
    { "TimeDivisions", "calendar/display/time_divisions", E_GCONF_MAP_INT },
    { "View", "calendar/display/default_view", E_GCONF_MAP_INT },
    { "HPanePosition", "calendar/display/hpane_position", E_GCONF_MAP_FLOAT },
    { "VPanePosition", "calendar/display/vpane_position", E_GCONF_MAP_FLOAT },
    { "MonthHPanePosition", "calendar/display/month_hpane_position", E_GCONF_MAP_FLOAT },
    { "MonthVPanePosition", "calendar/display/month_vpane_position", E_GCONF_MAP_FLOAT },
    { "CompressWeekend", "calendar/display/compress_weekend", E_GCONF_MAP_BOOL },
    { "ShowEventEndTime", "calendar/display/show_event_end", E_GCONF_MAP_BOOL },
    { "WorkingDays", "calendar/display/working_days", E_GCONF_MAP_INT },
    { 0 },
};

static e_gconf_map_t calendar_tasks_map[] = {
    /* /Calendar/Tasks */
    { "HideCompletedTasks", "calendar/tasks/hide_completed", E_GCONF_MAP_BOOL },
    { "HideCompletedTasksUnits", "calendar/tasks/hide_completed_units", E_GCONF_MAP_STRING },
    { "HideCompletedTasksValue", "calendar/tasks/hide_completed_value", E_GCONF_MAP_INT },
    { 0 },
};

static e_gconf_map_t calendar_tasks_colours_map[] = {
    /* /Calendar/Tasks/Colors */
    { "TasksDueToday", "calendar/tasks/colors/due_today", E_GCONF_MAP_STRING },
    { "TasksOverDue", "calendar/tasks/colors/overdue", E_GCONF_MAP_STRING },
    { "TasksDueToday", "calendar/tasks/colors/due_today", E_GCONF_MAP_STRING },
    { 0 },
};

static e_gconf_map_t calendar_other_map[] = {
    /* /Calendar/Other */
    { "ConfirmDelete", "calendar/prompts/confirm_delete", E_GCONF_MAP_BOOL },
    { "ConfirmExpunge", "calendar/prompts/confirm_expunge", E_GCONF_MAP_BOOL },
    { "UseDefaultReminder", "calendar/other/use_default_reminder", E_GCONF_MAP_BOOL },
    { "DefaultReminderInterval", "calendar/other/default_reminder_interval", E_GCONF_MAP_INT },
    { "DefaultReminderUnits", "calendar/other/default_reminder_units", E_GCONF_MAP_STRING },
    { 0 },
};

static e_gconf_map_t calendar_datenavigator_map[] = {
    /* /Calendar/DateNavigator */
    { "ShowWeekNumbers", "calendar/date_navigator/show_week_numbers", E_GCONF_MAP_BOOL },
    { 0 },
};

static e_gconf_map_t calendar_alarmnotify_map[] = {
    /* /Calendar/AlarmNotify */
    { "LastNotificationTime", "calendar/notify/last_notification_time", E_GCONF_MAP_INT },
    { "CalendarToLoad%i", "calendar/notify/calendars", E_GCONF_MAP_STRING|E_GCONF_MAP_LIST },
    { "BlessedProgram%i", "calendar/notify/programs", E_GCONF_MAP_STRING|E_GCONF_MAP_LIST },
    { 0 },
};

e_gconf_map_list_t calendar_remap_list[] = {

    { "/Calendar/Display", calendar_display_map },
    { "/Calendar/Other/Map", calendar_other_map },
    { "/Calendar/DateNavigator", calendar_datenavigator_map },
    { "/Calendar/AlarmNotify", calendar_alarmnotify_map },

    { 0 },
};

e_gconf_map_list_t task_remap_list[] = {

    { "/Calendar/Tasks", calendar_tasks_map },
    { "/Calendar/Tasks/Colors", calendar_tasks_colours_map },

    { 0 },
};

static GtkWidget *window;
static GtkLabel *label;
static GtkProgressBar *progress;

static void
setup_progress_dialog (gboolean tasks)
{
    GtkWidget *vbox, *hbox, *w;
    
    window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
    gtk_window_set_title ((GtkWindow *) window, _("Migrating..."));
    gtk_window_set_modal ((GtkWindow *) window, TRUE);
    gtk_container_set_border_width ((GtkContainer *) window, 6);
    
    vbox = gtk_vbox_new (FALSE, 6);
    gtk_widget_show (vbox);
    gtk_container_add ((GtkContainer *) window, vbox);
    
    if (tasks)
        w = gtk_label_new (_("The location and hierarchy of the Evolution task "
                     "folders has changed since Evolution 1.x.\n\nPlease be "
                     "patient while Evolution migrates your folders..."));
    else
        w = gtk_label_new (_("The location and hierarchy of the Evolution calendar "
                     "folders has changed since Evolution 1.x.\n\nPlease be "
                     "patient while Evolution migrates your folders..."));

    gtk_label_set_line_wrap ((GtkLabel *) w, TRUE);
    gtk_widget_show (w);
    gtk_box_pack_start_defaults ((GtkBox *) vbox, w);
    
    hbox = gtk_hbox_new (FALSE, 6);
    gtk_widget_show (hbox);
    gtk_box_pack_start_defaults ((GtkBox *) vbox, hbox);
    
    label = (GtkLabel *) gtk_label_new ("");
    gtk_widget_show ((GtkWidget *) label);
    gtk_box_pack_start_defaults ((GtkBox *) hbox, (GtkWidget *) label);
    
    progress = (GtkProgressBar *) gtk_progress_bar_new ();
    gtk_widget_show ((GtkWidget *) progress);
    gtk_box_pack_start_defaults ((GtkBox *) hbox, (GtkWidget *) progress);
    
    gtk_widget_show (window);
}

static void
dialog_close (void)
{
    gtk_widget_destroy ((GtkWidget *) window);
}

static void
dialog_set_folder_name (const char *folder_name)
{
    char *text;
    
    text = g_strdup_printf (_("Migrating `%s':"), folder_name);
    gtk_label_set_text (label, text);
    g_free (text);
    
    gtk_progress_bar_set_fraction (progress, 0.0);
    
    while (gtk_events_pending ())
        gtk_main_iteration ();
}

static void
dialog_set_progress (double percent)
{
    char text[5];
    
    snprintf (text, sizeof (text), "%d%%", (int) (percent * 100.0f));
    
    gtk_progress_bar_set_fraction (progress, percent);
    gtk_progress_bar_set_text (progress, text);
    
    while (gtk_events_pending ())
        gtk_main_iteration ();
}

static gboolean
check_for_conflict (ESourceGroup *group, char *name)
{
    GSList *sources;
    GSList *s;

    sources = e_source_group_peek_sources (group);

    for (s = sources; s; s = s->next) {
        ESource *source = E_SOURCE (s->data);

        if (!strcmp (e_source_peek_name (source), name))
            return TRUE;
    }

    return FALSE;
}

static char *
get_source_name (ESourceGroup *group, const char *path)
{
    char **p = g_strsplit (path, "/", 0);
    int i, j, starting_index;
    int num_elements;
    gboolean conflict;
    GString *s = g_string_new ("");

    for (i = 0; p[i]; i ++) ;

    num_elements = i;
    i--;

    /* p[i] is now the last path element */

    /* check if it conflicts */
    starting_index = i;
    do {
        g_string_assign (s, "");
        for (j = starting_index; j < num_elements; j += 2) {
            if (j != starting_index)
                g_string_append_c (s, '_');
            g_string_append (s, p[j]);
        }

        conflict = check_for_conflict (group, s->str);


        /* if there was a conflict back up 2 levels (skipping the /subfolder/ element) */
        if (conflict)
            starting_index -= 2;

        /* we always break out if we can't go any further,
           regardless of whether or not we conflict. */
        if (starting_index < 0)
            break;

    } while (conflict);

    return g_string_free (s, FALSE);
}

static gboolean
migrate_ical (ECal *old_ecal, ECal *new_ecal)
{
    GList *l, *objects;
    int num_added = 0;
    int num_objects;
    gboolean retval = TRUE;
    
    /* both ecals are loaded, start the actual migration */
    if (!e_cal_get_object_list (old_ecal, "#t", &objects, NULL))
        return FALSE;

    num_objects = g_list_length (objects);
    for (l = objects; l; l = l->next) {
        icalcomponent *ical_comp = l->data;
        GError *error = NULL;

        if (!e_cal_create_object (new_ecal, ical_comp, NULL, &error)) {
            g_warning ("Migration of object failed: %s", error->message);
            retval = FALSE;
        }
        
        g_clear_error (&error);

        num_added ++;
        dialog_set_progress ((double)num_added / num_objects);
    }

    return retval;
}

static gboolean
migrate_ical_folder_to_source (char *old_path, ESource *new_source, ECalSourceType type)
{
    ECal *old_ecal = NULL, *new_ecal = NULL;
    ESource *old_source;
    ESourceGroup *group;
    char *old_uri = g_strdup_printf ("file://%s", old_path);
    GError *error = NULL;
    gboolean retval = FALSE;
    
    group = e_source_group_new ("", old_uri);
    old_source = e_source_new ("", "");
    e_source_group_add_source (group, old_source, -1);

    dialog_set_folder_name (e_source_peek_name (new_source));

    old_ecal = e_cal_new (old_source, type);
    if (!e_cal_open (old_ecal, TRUE, &error)) {
        g_warning ("failed to load source ecal for migration: '%s' (%s)", error->message,
               e_source_get_uri (old_source));
        goto finish;
    }

    new_ecal = e_cal_new (new_source, type);
    if (!e_cal_open (new_ecal, FALSE, &error)) {
        g_warning ("failed to load destination ecal for migration: '%s' (%s)", error->message,
               e_source_get_uri (new_source));
        goto finish;
    }

    retval = migrate_ical (old_ecal, new_ecal);

finish:
    g_clear_error (&error);
    g_object_unref (old_ecal);
    g_object_unref (group);
    if (new_ecal)
        g_object_unref (new_ecal);
    g_free (old_uri);

    return retval;  
}

static gboolean
migrate_ical_folder (char *old_path, ESourceGroup *dest_group, char *source_name, ECalSourceType type)
{
    ESource *new_source;
    gboolean retval;
    
    new_source = e_source_new (source_name, source_name);
    e_source_set_relative_uri (new_source, e_source_peek_uid (new_source));
    e_source_group_add_source (dest_group, new_source, -1);

    retval = migrate_ical_folder_to_source (old_path, new_source, type);

    g_object_unref (new_source);

    return retval;
}


#define WEBCAL_BASE_URI "webcal://"
#define CONTACTS_BASE_URI "contacts://"
#define PERSONAL_RELATIVE_URI "system"

static ESourceGroup *
create_calendar_contact_source (ESourceList *source_list)
{
    ESourceGroup *group;
    ESource *source;
    
    /* Create the contacts group */
    group = e_source_group_new (_("Contacts"), CONTACTS_BASE_URI);
    e_source_list_add_group (source_list, group, -1);

    source = e_source_new (_("Birthdays & Anniversaries"), "/");
    e_source_group_add_source (group, source, -1);
    g_object_unref (source);

    e_source_group_set_readonly (group, TRUE);

    return group;
}

static void
create_calendar_sources (CalendarComponent *component,
             ESourceList   *source_list,
             ESourceGroup **on_this_computer,
             ESource **personal_source,
             ESourceGroup **on_the_web,
             ESourceGroup **contacts)
{
    GSList *groups;
    ESourceGroup *group;
    ESource *source = NULL;
    char *base_uri, *base_uri_proto;
    
    base_uri = g_build_filename (calendar_component_peek_base_directory (component),
                     "/calendar/local/",
                     NULL);

    base_uri_proto = g_strconcat ("file://", base_uri, NULL);

    groups = e_source_list_peek_groups (source_list);
    if (groups) {
        /* groups are already there, we need to search for things... */
        GSList *g;

        for (g = groups; g; g = g->next) {

            group = E_SOURCE_GROUP (g->data);

            if (!*on_this_computer && !strcmp (base_uri_proto, e_source_group_peek_base_uri (group)))
                *on_this_computer = g_object_ref (group);
            else if (!*on_the_web && !strcmp (WEBCAL_BASE_URI, e_source_group_peek_base_uri (group)))
                *on_the_web = g_object_ref (group);
            else if (!*contacts && !strcmp (CONTACTS_BASE_URI, e_source_group_peek_base_uri (group)))
                *contacts = g_object_ref (group);
        }
    }

    if (*on_this_computer) {
        /* make sure "Personal" shows up as a source under
           this group */
        GSList *sources = e_source_group_peek_sources (*on_this_computer);
        GSList *s;
        for (s = sources; s; s = s->next) {
            ESource *source = E_SOURCE (s->data);
            if (!strcmp (PERSONAL_RELATIVE_URI, e_source_peek_relative_uri (source))) {
                *personal_source = g_object_ref (source);
                break;
            }
        }
    } else {
        /* create the local source group */
        group = e_source_group_new (_("On This Computer"), base_uri_proto);
        e_source_list_add_group (source_list, group, -1);

        *on_this_computer = group;
    }

    if (!source) {
        /* Create the default Person addressbook */
        source = e_source_new (_("Personal"), PERSONAL_RELATIVE_URI);
        e_source_group_add_source (*on_this_computer, source, -1);

        *personal_source = source;
    }

    if (!*on_the_web) {
        /* Create the Webcal source group */
        group = e_source_group_new (_("On The Web"), WEBCAL_BASE_URI);
        e_source_list_add_group (source_list, group, -1);

        *on_the_web = group;
    }

    if (!*contacts) {
        group = create_calendar_contact_source (source_list);

        *contacts = group;
    }
    
    g_free (base_uri_proto);
    g_free (base_uri);
}

static void
create_task_sources (TasksComponent *component,
             ESourceList   *source_list,
             ESourceGroup **on_this_computer,
             ESource **personal_source)
{
    GSList *groups;
    ESourceGroup *group;
    ESource *source = NULL;
    char *base_uri, *base_uri_proto;
    
    base_uri = g_build_filename (tasks_component_peek_base_directory (component),
                     "/tasks/local/",
                     NULL);

    base_uri_proto = g_strconcat ("file://", base_uri, NULL);

    groups = e_source_list_peek_groups (source_list);
    if (groups) {
        /* groups are already there, we need to search for things... */
        GSList *g;

        for (g = groups; g; g = g->next) {

            group = E_SOURCE_GROUP (g->data);

            if (!*on_this_computer && !strcmp (base_uri_proto, e_source_group_peek_base_uri (group)))
                *on_this_computer = g_object_ref (group);
        }
    }

    if (*on_this_computer) {
        /* make sure "Personal" shows up as a source under
           this group */
        GSList *sources = e_source_group_peek_sources (*on_this_computer);
        GSList *s;
        for (s = sources; s; s = s->next) {
            ESource *source = E_SOURCE (s->data);
            if (!strcmp (PERSONAL_RELATIVE_URI, e_source_peek_relative_uri (source))) {
                *personal_source = g_object_ref (source);
                break;
            }
        }
    } else {
        /* create the local source group */
        group = e_source_group_new (_("On This Computer"), base_uri_proto);
        e_source_list_add_group (source_list, group, -1);

        *on_this_computer = group;
    }

    if (!source) {
        /* Create the default Person addressbook */
        source = e_source_new (_("Personal"), PERSONAL_RELATIVE_URI);
        e_source_group_add_source (*on_this_computer, source, -1);

        *personal_source = source;
    }

    g_free (base_uri_proto);
    g_free (base_uri);
}

gboolean
migrate_calendars (CalendarComponent *component, int major, int minor, int revision)
{
    ESourceGroup *on_this_computer = NULL, *on_the_web = NULL, *contacts = NULL;
    ESource *personal_source = NULL;
    gboolean retval = TRUE;

    /* we call this unconditionally now - create_groups either
       creates the groups/sources or it finds the necessary
       groups/sources. */
    create_calendar_sources (component, calendar_component_peek_source_list (component), &on_this_computer, &personal_source, &on_the_web, &contacts);

    if (major == 1) {
        xmlDocPtr config_doc = NULL;
        char *conf_file;
        struct stat st;

        conf_file = g_build_filename (g_get_home_dir (), "evolution", "config.xmldb", NULL);
        if (lstat (conf_file, &st) == 0 && S_ISREG (st.st_mode)) 
            config_doc = xmlParseFile (conf_file);
        g_free (conf_file);
        
        if (config_doc && minor <= 2) {
            GConfClient *gconf; 
            int res = 0;
            
            /* move bonobo config to gconf */
            gconf = gconf_client_get_default ();
            
            res = e_bconf_import (gconf, config_doc, calendar_remap_list);
            
            g_object_unref (gconf);
            
            xmlFreeDoc(config_doc);

            if (res != 0) {
                g_warning("Could not move config from bonobo-conf to gconf");
                return FALSE;
            }
        }

        if (minor <= 4) {
            GSList *migration_dirs, *l;
            char *path, *local_cal_folder;

            setup_progress_dialog (FALSE);

            path = g_build_filename (g_get_home_dir (), "evolution", "local", NULL);
            migration_dirs = e_folder_map_local_folders (path, "calendar");
            local_cal_folder = g_build_filename (path, "Calendar", NULL);
            g_free (path);

            if (personal_source)
                migrate_ical_folder_to_source (local_cal_folder, personal_source, E_CAL_SOURCE_TYPE_EVENT);

            for (l = migration_dirs; l; l = l->next) {
                char *source_name;
            
                if (personal_source && !strcmp ((char*)l->data, local_cal_folder))
                    continue;

                source_name = get_source_name (on_this_computer, (char*)l->data);

                if (!migrate_ical_folder (l->data, on_this_computer, source_name, E_CAL_SOURCE_TYPE_EVENT))
                    retval = FALSE;
                
                g_free (source_name);
            }
            
            g_free (local_cal_folder);
            
            e_source_list_sync (calendar_component_peek_source_list (component), NULL);

            dialog_close ();
        }

        if (minor == 5 && revision < 2) {
            ESourceGroup *group;
            
            group = create_calendar_contact_source (calendar_component_peek_source_list (component));
            g_object_unref (group);
            
            e_source_list_sync (calendar_component_peek_source_list (component), NULL);
        }

        if (minor == 5 && revision < 5) {
            GConfClient *gconf; 
            GConfValue *gconf_val;
            int i;
            const char *keys[] = {
                CALENDAR_CONFIG_HPANE_POS,
                CALENDAR_CONFIG_VPANE_POS,
                CALENDAR_CONFIG_MONTH_HPANE_POS,
                CALENDAR_CONFIG_MONTH_VPANE_POS,
                NULL
            };
            
            gconf = gconf_client_get_default ();
            
            for (i = 0; keys[i]; i++) {
                gconf_val = gconf_client_get (gconf, keys[i], NULL);
                if (gconf_val->type != GCONF_VALUE_INT)
                    gconf_client_unset (gconf, keys[i], NULL);
                gconf_value_free (gconf_val);
            }
            
            g_object_unref (gconf);
        }

    }

    return retval;
}

gboolean
migrate_tasks (TasksComponent *component, int major, int minor, int revision)
{
    ESourceGroup *on_this_computer = NULL;
    ESource *personal_source = NULL;
    gboolean retval = TRUE;

    /* we call this unconditionally now - create_groups either
       creates the groups/sources or it finds the necessary
       groups/sources. */
    create_task_sources (component, tasks_component_peek_source_list (component), &on_this_computer, &personal_source);
    
    if (major == 1) {
        xmlDocPtr config_doc = NULL;
        char *conf_file;
        struct stat st;

        conf_file = g_build_filename (g_get_home_dir (), "evolution", "config.xmldb", NULL);
        if (lstat (conf_file, &st) == 0 && S_ISREG (st.st_mode)) 
            config_doc = xmlParseFile (conf_file);
        g_free (conf_file);
        
        if (config_doc && minor <= 2) {
            GConfClient *gconf; 
            int res = 0;
            
            /* move bonobo config to gconf */
            gconf = gconf_client_get_default ();
            
            res = e_bconf_import (gconf, config_doc, task_remap_list);
            
            g_object_unref (gconf);
            
            xmlFreeDoc(config_doc);

            if (res != 0) {
                g_warning("Could not move config from bonobo-conf to gconf");
                return FALSE;
            }
        }

        if (minor <= 4) {
            GSList *migration_dirs, *l;
            char *path, *local_task_folder;

            setup_progress_dialog (TRUE);
            
            path = g_build_filename (g_get_home_dir (), "evolution", "local", NULL);
            migration_dirs = e_folder_map_local_folders (path, "tasks");
            local_task_folder = g_build_filename (path, "Tasks", NULL);
            g_free (path);          

            if (personal_source)
                migrate_ical_folder_to_source (local_task_folder, personal_source, E_CAL_SOURCE_TYPE_TODO);

            for (l = migration_dirs; l; l = l->next) {
                char *source_name;
            
                if (personal_source && !strcmp ((char*)l->data, local_task_folder))
                    continue;

                source_name = get_source_name (on_this_computer, (char*)l->data);

                if (!migrate_ical_folder (l->data, on_this_computer, source_name, E_CAL_SOURCE_TYPE_TODO))
                    retval = FALSE;
                
                g_free (source_name);
            }
            
            g_free (local_task_folder);
            
            e_source_list_sync (tasks_component_peek_source_list (component), NULL);

            dialog_close ();
        }       
    }

    if (on_this_computer)
        g_object_unref (on_this_computer);
    if (personal_source)
        g_object_unref (personal_source);
    
        return retval;
}