aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-shell-migrate.c
blob: 6ed7bccc082568dba50e067165736ec01749790d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/*
 * e-shell-migrate.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)
 *
 */

#include "e-shell-migrate.h"

#include <string.h>
#include <unistd.h>
#include <glib/gi18n.h>
#include <glib/gstdio.h>
#include <libedataserver/e-xml-utils.h>

#include "e-util/e-bconf-map.h"
#include "e-util/e-alert-dialog.h"
#include "e-util/e-file-utils.h"
#include "e-util/e-util.h"

#include "es-event.h"

#define GCONF_VERSION_KEY   "/apps/evolution/version"
#define GCONF_LAST_VERSION_KEY  "/apps/evolution/last_version"

static const gchar *
shell_migrate_get_old_data_dir (void)
{
    static gchar *old_data_dir = NULL;

    if (G_UNLIKELY (old_data_dir == NULL))
        old_data_dir = g_build_filename (
            g_get_home_dir (), "evolution", NULL);

    return old_data_dir;
}

static gboolean
shell_migrate_attempt (EShell *shell,
                       gint major,
                       gint minor,
                       gint micro)
{
    GList *backends;
    gboolean success = TRUE;

    backends = e_shell_get_shell_backends (shell);

    while (success && backends != NULL) {
        EShellBackend *shell_backend = backends->data;
        GError *error = NULL;

        success = e_shell_backend_migrate (
            shell_backend, major, minor, micro, &error);

        if (error != NULL) {
            gint response;

            response = e_alert_run_dialog_for_args (
                e_shell_get_active_window (shell), "shell:upgrade-failed",
                error->message, NULL);

            if (response == GTK_RESPONSE_CANCEL)
                success = FALSE;

            g_error_free (error);
        }

        backends = g_list_next (backends);
    }

    return success;
}

static void
shell_migrate_get_version (EShell *shell,
                           gint *major,
                           gint *minor,
                           gint *micro)
{
    GConfClient *client;
    const gchar *key;
    const gchar *old_data_dir;
    gchar *string;

    old_data_dir = shell_migrate_get_old_data_dir ();

    key = GCONF_VERSION_KEY;
    client = e_shell_get_gconf_client (shell);
    string = gconf_client_get_string (client, key, NULL);

    if (string != NULL) {
        /* Since 1.4.0 we've kept the version key in GConf. */
        sscanf (string, "%d.%d.%d", major, minor, micro);
        g_free (string);

    } else if (!g_file_test (old_data_dir, G_FILE_TEST_IS_DIR)) {
        /* If the old data directory does not exist,
         * it must be a new installation. */
        *major = 0;
        *minor = 0;
        *micro = 0;

    } else {
        xmlDocPtr doc;
        xmlNodePtr source;
        gchar *filename;

        filename = g_build_filename (
            old_data_dir, "config.xmldb", NULL);
        doc = e_xml_parse_file (filename);
        g_free (filename);

        if (doc == NULL)
            return;

        source = e_bconf_get_path (doc, "/Shell");
        if (source != NULL) {
            key = "upgrade_from_1_0_to_1_2_performed";
            string = e_bconf_get_value (source, key);
        }

        if (string != NULL && *string == '1') {
            *major = 1;
            *minor = 2;
            *micro = 0;
        } else {
            *major = 1;
            *minor = 0;
            *micro = 0;
        }

        g_free (string);

        if (doc != NULL)
            xmlFreeDoc (doc);
    }
}

static gint
shell_migrate_remove_dir (const gchar *root,
                          const gchar *path)
{
    GDir *dir;
    const gchar *basename;
    gchar *filename = NULL;
    gint result = -1;

    /* Recursively removes a directory and its contents. */

    dir = g_dir_open (path, 0, NULL);
    if (dir == NULL)
        return -1;

    while ((basename = g_dir_read_name (dir)) != NULL) {
        filename = g_build_filename (path, basename, NULL);

        /* Make sure we haven't strayed from the evolution dir. */
        g_return_val_if_fail (strlen (path) >= strlen (root), -1);
        g_return_val_if_fail (g_str_has_prefix (path, root), -1);

        if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
            if (shell_migrate_remove_dir (root, filename) < 0)
                goto fail;
        } else {
            if (g_unlink (filename) < 0)
                goto fail;
        }

        g_free (filename);
        filename = NULL;
    }

    result = g_rmdir (path);

fail:
    g_free (filename);
    g_dir_close (dir);

    return result;
}

static void
change_dir_modes (const gchar *path)
{
    GDir *dir;
    GError *err = NULL;
    const char *file = NULL;

    dir = g_dir_open (path, 0, &err);
    if (err) {
        g_warning ("Error opening directory %s: %s \n", path, err->message);
        g_clear_error (&err);
        return;
    }

    while ((file = g_dir_read_name (dir))) {
        gchar *full_path = g_build_filename (path, file, NULL);

        if (g_file_test (full_path, G_FILE_TEST_IS_DIR))
            change_dir_modes (full_path);

        g_free (full_path);
    }

    g_chmod (path, 0700);   
    g_dir_close (dir);
}

static void
fix_folder_permissions (const char *data_dir)
{
    struct stat sb;

    if (g_stat (data_dir, &sb) == -1) {
        g_warning ("error stat: %s \n", data_dir);
        return; 
    }

    if (((guint32) sb.st_mode & 0777) != 0700)
        change_dir_modes (data_dir);
}

gboolean
e_shell_migrate_attempt (EShell *shell)
{
    ESEvent *ese;
    GConfClient *client;
    const gchar *key;
    const gchar *old_data_dir;
    gint major, minor, micro;
    gint last_major, last_minor, last_micro;
    gint curr_major, curr_minor, curr_micro;
    gboolean migrated = FALSE;
    gchar *string;

    g_return_val_if_fail (E_IS_SHELL (shell), FALSE);

    client = e_shell_get_gconf_client (shell);
    old_data_dir = shell_migrate_get_old_data_dir ();

    if (sscanf (BASE_VERSION, "%d.%d", &curr_major, &curr_minor) != 2) {
        g_warning ("Could not parse BASE_VERSION (%s)", BASE_VERSION);
        return TRUE;
    }

    curr_micro = atoi (UPGRADE_REVISION);

    shell_migrate_get_version (shell, &major, &minor, &micro);

    /* This sets the folder permissions to S_IRWXU if needed */
    if (curr_major <= 2 && curr_minor <= 30)
        fix_folder_permissions (e_get_user_data_dir ());

    if (!(curr_major > major ||
        (curr_major == major && curr_minor > minor) ||
        (curr_major == major && curr_minor == minor && curr_micro > micro)))
        goto check_old;

    /* If upgrading from < 1.5, we need to copy most data from
     * ~/evolution to ~/.evolution.  Make sure we have the disk
     * space for it before proceeding. */
    if (major == 1 && minor < 5) {
        glong avail;
        glong usage;

        usage = e_fsutils_usage (old_data_dir);
        avail = e_fsutils_avail (g_get_home_dir ());
        if (usage >= 0 && avail >= 0 && avail < usage) {
            gchar *need;
            gchar *have;

            need = g_strdup_printf (_("%ld KB"), usage);
            have = g_strdup_printf (_("%ld KB"), avail);

            e_alert_run_dialog_for_args (
                e_shell_get_active_window (shell), "shell:upgrade-nospace",
                need, have, NULL);

            g_free (need);
            g_free (have);

            _exit (EXIT_SUCCESS);
        }
    }

    if (!shell_migrate_attempt (shell, major, minor, micro))
        _exit (EXIT_SUCCESS);

    /* Record a successful migration. */
    string = g_strdup_printf ("%d.%d.%d", curr_major, curr_minor, curr_micro);
    gconf_client_set_string (client, GCONF_VERSION_KEY, string, NULL);
    g_free (string);

    migrated = TRUE;

check_old:

    key = GCONF_LAST_VERSION_KEY;

    /* Try to retrieve the last migrated version from GConf. */
    string = gconf_client_get_string (client, key, NULL);
    if (migrated || string == NULL || sscanf (string, "%d.%d.%d",
        &last_major, &last_minor, &last_micro) != 3) {
        last_major = major;
        last_minor = minor;
        last_micro = micro;
    }
    g_free (string);

    /* If the last migrated version was old, check for stuff to remove. */
    if (last_major == 1 && last_minor < 5 &&
        g_file_test (old_data_dir, G_FILE_TEST_IS_DIR)) {

        gint response;

        string = g_strdup_printf (
            "%d.%d.%d", last_major, last_minor, last_micro);
        response = e_alert_run_dialog_for_args (
            e_shell_get_active_window (shell), "shell:upgrade-remove-1-4", string, NULL);
        g_free (string);

        switch (response) {
            case GTK_RESPONSE_OK:  /* delete */
                response = e_alert_run_dialog_for_args (
                    e_shell_get_active_window (shell),
                    "shell:upgrade-remove-1-4-confirm",
                    NULL);
                if (response == GTK_RESPONSE_OK)
                    shell_migrate_remove_dir (
                        old_data_dir, old_data_dir);
                else
                    break;
                /* fall through */

            case GTK_RESPONSE_ACCEPT:  /* keep */
                last_major = curr_major;
                last_minor = curr_minor;
                last_micro = curr_micro;
                break;

            default:
                break;
        }
    } else {
        last_major = curr_major;
        last_minor = curr_minor;
        last_micro = curr_micro;
    }

    string = g_strdup_printf (
        "%d.%d.%d", last_major, last_minor, last_micro);
    gconf_client_set_string (client, key, string, NULL);
    g_free (string);

    /** @Event: Shell attempted upgrade
     * @Id: upgrade.done
     * @Target: ESMenuTargetState
     *
     * This event is emitted whenever the shell successfully attempts
     * an upgrade.
     **/
    ese = es_event_peek ();
    e_event_emit (
        (EEvent *) ese, "upgrade.done",
        (EEventTarget *) es_event_target_new_upgrade (
        ese, curr_major, curr_minor, curr_micro));

    return TRUE;
}

GQuark
e_shell_migrate_error_quark (void)
{
    static GQuark quark = 0;

    if (G_UNLIKELY (quark == 0))
        quark = g_quark_from_static_string (
            "e-shell-migrate-error-quark");

    return quark;
}