src/prefs_migration.c

   1 /*
   2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2016 the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 #include "config.h"
  21 #include "claws-features.h"
  22 #endif
  23
  24 #ifdef ENABLE_NLS
  25 #include <glib/gi18n.h>
  26 #else
  27 #define _(a) (a)
  28 #define N_(a) (a)
  29 #endif
  30
  31 #include "defs.h"
  32 #include "account.h"
  33 #include "prefs_account.h"
  34 #include "prefs_common.h"
  35 #include "alertpanel.h"
  36
  37 static gint starting_config_version = 0;
  38
  39 gboolean _version_check(gint ver)
  40 {
  41         if (ver > CLAWS_CONFIG_VERSION) {
  42                 gchar *msg;
  43                 gchar *markup;
  44                 AlertValue av;
  45
  46                 markup = g_strdup_printf(
  47                         "<a href=\"%s\"><span underline=\"none\">",
  48                         CONFIG_VERSIONS_URI);
  49                 msg = g_strdup_printf(
  50                         _("Your Claws Mail configuration is from a newer "
  51                           "version than the version which you are currently "
  52                           "using.\n\n"
  53                           "This is not recommended.\n\n"
  54                           "For further information see the %sClaws Mail "
  55                           "website%s.\n\n"
  56                           "Do you want to exit now?"),
  57                           markup, "</span></a>");
  58                 g_free(markup);
  59                 av = alertpanel_full(_("Configuration warning"), msg,
  60                                         GTK_STOCK_NO, GTK_STOCK_YES, NULL,
  61                                         FALSE, NULL,
  62                                         ALERT_ERROR, G_ALERTALTERNATE);
  63                 g_free(msg);
  64
  65                 if (av != G_ALERTDEFAULT)
  66                         return FALSE; /* abort startup */
  67
  68                 return TRUE; /* hic sunt dracones */
  69         }
  70
  71         return TRUE;
  72 }
  73
  74 static void _update_config_common(gint version)
  75 {
  76         debug_print("Updating config version %d to %d.\n", version, version + 1);
  77
  78         switch (version) {
  79                 case 1:
  80
  81                         /* The autochk_interval preference is now
  82                          * interpreted as seconds instead of minutes */
  83                         prefs_common.autochk_itv *= 60;
  84
  85                         break;
  86
  87                 default:
  88
  89                         /* NOOP */
  90
  91                         break;
  92         }
  93 }
  94
  95 static void _update_config_account(PrefsAccount *ac_prefs, gint version)
  96 {
  97         debug_print("Account '%s': Updating config version from %d to %d.\n",
  98                         ac_prefs->account_name, version, version + 1);
  99
 100         switch (version) {
 101                 case 0:
 102
 103                         /* Removing A_APOP and A_RPOP from RecvProtocol enum,
 104                          * protocol numbers above A_POP3 need to be adjusted.
 105                          *
 106                          * In config_version=0:
 107                          * A_POP3 is 0,
 108                          * A_APOP is 1,
 109                          * A_RPOP is 2,
 110                          * A_IMAP and the rest are from 3 up.
 111                          * We can't use the macros, since they may change in the
 112                          * future. Numbers do not change. :) */
 113                         if (ac_prefs->protocol == 1) {
 114                                 ac_prefs->protocol = 0;
 115                         } else if (ac_prefs->protocol > 2) {
 116                                 /* A_IMAP and above gets bumped down by 2. */
 117                                 ac_prefs->protocol -= 2;
 118                         }
 119
 120                         break;
 121
 122                 default:
 123
 124                         /* NOOP */
 125
 126                         break;
 127         }
 128
 129         ac_prefs->config_version = version + 1;
 130 }
 131
 132 int prefs_update_config_version_common()
 133 {
 134         gint ver = prefs_common_get_prefs()->config_version;
 135
 136         /* Store the starting version number for other components'
 137          * migration functions. */
 138         starting_config_version = ver;
 139
 140         if (!_version_check(ver))
 141                 return -1;
 142
 143         debug_print("Starting config update at config_version %d.\n", ver);
 144         if (ver == CLAWS_CONFIG_VERSION) {
 145                 debug_print("No update necessary, already at latest config_version.\n");
 146                 return 0; /* nothing to do */
 147         }
 148
 149         while (ver < CLAWS_CONFIG_VERSION) {
 150                 _update_config_common(ver++);
 151                 prefs_common_get_prefs()->config_version = ver;
 152         }
 153
 154         debug_print("Config update done.\n");
 155         return 1; /* update done */
 156 }
 157
 158 int prefs_update_config_version_accounts()
 159 {
 160         GList *cur;
 161         PrefsAccount *ac_prefs;
 162
 163         for (cur = account_get_list(); cur != NULL; cur = cur->next) {
 164                 ac_prefs = (PrefsAccount *)cur->data;
 165
 166                 if (ac_prefs->config_version == -1) {
 167                         /* There was no config_version stored in accountrc, let's assume
 168                          * config_version same as clawsrc started at, to avoid breaking
 169                          * this account by "upgrading" it unnecessarily. */
 170                         debug_print("Account '%s': config_version not saved, using one from clawsrc: %d\n", ac_prefs->account_name, starting_config_version);
 171                         ac_prefs->config_version = starting_config_version;
 172                 }
 173
 174                 gint ver = ac_prefs->config_version;
 175
 176                 debug_print("Account '%s': Starting config update at config_version %d.\n", ac_prefs->account_name, ver);
 177
 178                 if (!_version_check(ver))
 179                         return -1;
 180
 181                 if (ver == CLAWS_CONFIG_VERSION) {
 182                         debug_print("Account '%s': No update necessary, already at latest config_version.\n", ac_prefs->account_name);
 183                         continue;
 184                 }
 185
 186                 while (ver < CLAWS_CONFIG_VERSION) {
 187                         _update_config_account(ac_prefs, ver++);
 188                 }
 189         }
 190
 191         return 1;
 192 }