Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor!: Automigration of (very) old config files (version 4 or lower) not supported anymore #1857

Merged
merged 5 commits into from
Sep 9, 2024
Merged

refactor!: Automigration of (very) old config files (version 4 or lower) not supported anymore #1857

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ff65254
x
buhtz Sep 1, 2024
dca3935
changelog
buhtz Sep 1, 2024
f0827ad
minor [skip ci]
buhtz Sep 1, 2024
a199055
[skip ci]
buhtz Sep 2, 2024
7e3b614
Merge branch 'dev' into refactor/configV5
buhtz Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Back In Time

Version 1.5.3-dev (development of upcoming release)
* Breaking Change: Minimal Python version 3.9 required (#1731)
* Breaking Change: Auto migration of config version 4 or lower not longer supported
* Fix: Prevent duplicates in Exclude/Include list of Manage Profiles dialog
* Fix: Fix Qt segmentation fault when canceling out of unconfigured BiT (#1095) (Derek Veit @DerekVeit)
* Fix: Correct global flock fallbacks (#1834) (Timothy Southwick @NickNackGus)
Expand Down
80 changes: 10 additions & 70 deletions common/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@
InvalidChar, \
InvalidCmd, \
LimitExceeded
import version


class Config(configfile.ConfigFileWithProfiles):
APP_NAME = 'Back In Time'
COPYRIGHT = 'Copyright (C) 2008-2024 Oprea Dan, Bart de Koning, ' \
'Richard Bailey, Germar Reitze, Christian Buhtz, Michael Büker, Jürgen Altfeld et al.'
'Richard Bailey, Germar Reitze, Christian Buhtz, ' \
'Michael Büker, Jürgen Altfeld et al.'

CONFIG_VERSION = 6
"""Latest or highest possible version of Back in Time's config file."""
Expand Down Expand Up @@ -177,16 +177,6 @@ def __init__(self, config_path=None, data_path=None):
self._LOCAL_CONFIG_PATH = os.path.abspath(config_path)
self._LOCAL_CONFIG_FOLDER = os.path.dirname(self._LOCAL_CONFIG_PATH)

# (buhtz) Introduced in 2009 via commit 5b26575be4.
# Ready to remove after 15 years.
# old_path = os.path.join(self._LOCAL_CONFIG_FOLDER, 'config2')

# if os.path.exists(old_path):
# if os.path.exists(self._LOCAL_CONFIG_PATH):
# os.remove(old_path)
# else:
# os.rename(old_path, self._LOCAL_CONFIG_PATH)

# Load global config file
self.load(self._GLOBAL_CONFIG_PATH)

Expand All @@ -199,38 +189,14 @@ def __init__(self, config_path=None, data_path=None):
= self.intValue('config.version', self.CONFIG_VERSION)

if currentConfigVersion < self.CONFIG_VERSION:
# config.version value wasn't stored since BiT version 0.9.99.22
# until version 1.2.0 because of a bug. So we can't really tell
# which version the config is. But most likely it is version > 4
if currentConfigVersion < 4:
#update from BackInTime version < 1.0 is deprecated
logger.error("config.version is < 4. This config was made with "\
"BackInTime version < 1.0. This version ({}) " \
"doesn't support upgrading config from version " \
"< 1.0 anymore. Please use BackInTime version " \
"<= 1.1.12 to upgrade the config to a more recent "\
"version.".format(version.__version__))
#TODO: add popup warning
sys.exit(2)

if currentConfigVersion < 5:
logger.info("Update to config version 5: other snapshot locations", self)
profiles = self.profiles()
for profile_id in profiles:
#change include
old_values = self.includeV4(profile_id)
values = []
for value in old_values:
values.append((value, 0))
self.setInclude(values, profile_id)

#change exclude
old_values = self.excludeV4(profile_id)
self.setExclude(old_values, profile_id)

#remove keys
self.removeProfileKey('snapshots.include_folders', profile_id)
self.removeProfileKey('snapshots.exclude_patterns', profile_id)
logger.error(
'The config file version is 4 or lower. This config was '
'made with a version of Back In Time that is out dated. '
'Because of that upgrading config to the current version '
'is not possible.',
buhtz marked this conversation as resolved.
Show resolved Hide resolved
self)
sys.exit(2)

if currentConfigVersion < 6:
logger.info('Update to config version 6', self)
Expand Down Expand Up @@ -268,6 +234,7 @@ def __init__(self, config_path=None, data_path=None):
# remove old gnome and kde keys
self.removeKeysStartsWith('gnome')
self.removeKeysStartsWith('kde')

self.save()

self.current_hash_id = 'local'
Expand Down Expand Up @@ -933,23 +900,6 @@ def setHostUserProfile(self, host, user, profile, profile_id = None):
self.setProfileStrValue('snapshots.path.user', user, profile_id)
self.setProfileStrValue('snapshots.path.profile', profile, profile_id)

def includeV4(self, profile_id = None):
#?!ignore this in manpage
value = self.profileStrValue('snapshots.include_folders', '', profile_id)
if not value:
return []

paths = []

for item in value.split(':'):
fields = item.split('|')

path = os.path.expanduser(fields[0])
path = os.path.abspath(path)
paths.append(path)

return paths

def include(self, profile_id=None):
#?Include this file or folder. <I> must be a counter starting with 1;absolute path::
#?Specify if \fIprofile<N>.snapshots.include.<I>.value\fR is a folder (0) or a file (1).;0|1;0
Expand All @@ -958,16 +908,6 @@ def include(self, profile_id=None):
def setInclude(self, values, profile_id = None):
self.setProfileListValue('snapshots.include', ('str:value', 'int:type'), values, profile_id)

def excludeV4(self, profile_id = None):
"""
Gets the exclude patterns: conf version 4
"""
#?!ignore this in manpage
value = self.profileStrValue('snapshots.exclude_patterns', '.gvfs:.cache*:[Cc]ache*:.thumbnails*:[Tt]rash*:*.backup*:*~', profile_id)
if not value:
return []
return value.split(':')

def exclude(self, profile_id = None):
"""
Gets the exclude patterns
Expand Down