From 0fc9c4792fa78690c037dd2671710f664f384bdf Mon Sep 17 00:00:00 2001
From: Andreas Preikschat <googol@lavabit.com>
Date: Wed, 16 Jan 2013 19:59:34 +0100
Subject: [PATCH] tweaked 'settings migrator'

---
 openlp/core/lib/settings.py  | 46 ++++++++++++++++++++++++++----------
 openlp/core/ui/mainwindow.py |  9 -------
 2 files changed, 34 insertions(+), 21 deletions(-)

diff --git a/openlp/core/lib/settings.py b/openlp/core/lib/settings.py
index 4cbddd75f..8f30ef373 100644
--- a/openlp/core/lib/settings.py
+++ b/openlp/core/lib/settings.py
@@ -68,9 +68,22 @@ class Settings(QtCore.QSettings):
         This dict contains all core settings with their default values.
 
     ``__obsolete_settings__``
-        Put any settings whose key changes or is removed here. In the case that the key is completely removed just leave
-        the dict value for this key empty (empty string). If you renamed a key, but the old name first and the new name
-        as value for this key.
+        Each tuple is structured in the following way::
+
+            (u'general/enable slide loop',  u'advanced/slide limits', [(SlideLimits.Wrap, True), (SlideLimits.End, False)])
+
+        The first entry is the *old key*; it will be removed.
+
+        The second entry is the *new key*; we will add it to the config.
+
+        The last entry is a list containing two-pair tuples. If the list is empty, no conversion is made. Otherwise each
+        pair describes how to convert the old setting's value::
+
+            (SlideLimits.Wrap, True)
+
+        This means, that if the value of ``general/enable slide loop`` is ``True`` then we set ``advanced/slide limits``
+        to ``SlideLimits.Wrap``. **NOTE**, this means that the rules have to cover all cases! So, if the type of the old
+        value is bool, then there must be two rules.
     """
     __default_settings__ = {
         u'advanced/x11 bypass wm': X11_BYPASS_DEFAULT,
@@ -215,9 +228,10 @@ class Settings(QtCore.QSettings):
         u'images 1': u' '
     }
     __file_path__ = u''
-    __obsolete_settings__ = {
-        u'bibles/bookname language': u'bibles/book name language'
-    }
+    __obsolete_settings__ = [
+        (u'bibles/bookname language', u'bibles/book name language', []),
+        (u'general/enable slide loop',  u'advanced/slide limits', [(SlideLimits.Wrap, True), (SlideLimits.End, False)])
+    ]
 
     @staticmethod
     def extend_default_settings(default_values):
@@ -255,15 +269,23 @@ class Settings(QtCore.QSettings):
 
     def remove_obsolete_settings(self):
         """
-        This method is only called to clean up the config. It does two things: First it completely remove old settings
-        (to do this, just leave the new_key empty). And it copies the value from old_key to new_key and then removes the
-        old_key.
+        This method is only called to clean up the config. It removes old settings and it renames settings. See
+        ``__obsolete_settings__`` for more details.
         """
-        for old_key, new_key in Settings.__obsolete_settings__.items():
+        for old_key, new_key, rules in Settings.__obsolete_settings__:
+            # Once removed we don't have to do this again.
             if self.contains(old_key):
                 if new_key:
-                    # Copy the value from the old_key to the new_key.
-                    self.setValue(new_key, super(Settings, self).value(old_key))
+                    # Get the value of the old_key.
+                    old_value = super(Settings, self).value(old_key)
+                    # Iterate over our rules and check what the old_value should be "converted" to.
+                    for new, old in rules:
+                        # If the value matches with the condition (rule), then use the provided value. This is used to
+                        # convert values. E. g. an old value 1 results in True, and 0 in False.
+                        if old == old_value:
+                            old_value = new
+                            break
+                    self.setValue(new_key, old_value)
                 self.remove(old_key)
 
     def value(self, key, default_value=None):
diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py
index 0fc97ea5d..ee51a626d 100644
--- a/openlp/core/ui/mainwindow.py
+++ b/openlp/core/ui/mainwindow.py
@@ -1180,15 +1180,6 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow):
         Load the main window settings.
         """
         log.debug(u'Loading QSettings')
-        # FIXME
-        # Migrate Wrap Settings to Slide Limits Settings
-        if Settings().contains(self.generalSettingsSection + u'/enable slide loop'):
-            if Settings().value(self.generalSettingsSection + u'/enable slide loop'):
-                Settings().setValue(self.advancedSettingsSection + u'/slide limits', SlideLimits.Wrap)
-            else:
-                Settings().setValue(self.advancedSettingsSection + u'/slide limits', SlideLimits.End)
-            Settings().remove(self.generalSettingsSection + u'/enable slide loop')
-            Receiver.send_message(u'slidecontroller_update_slide_limits')
         settings = Settings()
         # Remove obsolete entries.
         settings.remove(u'custom slide')