pingu_98/MrDraw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix: Software Update config could contain circular reference

Browse source 
Caused by a wrong variable usage. Fixed the usage and added a migration
step that fixes the circular reference if it exists. Bumping configuration
version to 2.

Fixes #946
This commit is contained in:
Gina Häußge 2015-06-21 12:09:38 +02:00
parent e722c2f8ad
commit 33ea9c3459
1 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/octoprint/plugins/softwareupdate/__init__.py
View file

@ -92,7 +92,7 @@ class SoftwareUpdatePlugin(octoprint.plugin.BlueprintPlugin,
self._version_cache_ttl = self._settings.get_int(["cache_ttl"]) * 60 self._version_cache_ttl = self._settings.get_int(["cache_ttl"]) * 60
def get_settings_version(self): def get_settings_version(self):
return 1 return 2
def on_settings_migrate(self, target, current=None): def on_settings_migrate(self, target, current=None):
if current is None: if current is None:
@ -111,7 +111,7 @@ class SoftwareUpdatePlugin(octoprint.plugin.BlueprintPlugin,
deletables=["current"] deletables=["current"]
else: else:
deletables=[] deletables=[]
octoprint_check = self._clean_settings_check("octoprint", configured_checks, self.get_settings_defaults()["checks"]["octoprint"], delete=deletables, save=False) octoprint_check = self._clean_settings_check("octoprint", octoprint_check, self.get_settings_defaults()["checks"]["octoprint"], delete=deletables, save=False)
# and the hooks # and the hooks
update_check_hooks = self._plugin_manager.get_hooks("octoprint.plugin.softwareupdate.check_config") update_check_hooks = self._plugin_manager.get_hooks("octoprint.plugin.softwareupdate.check_config")
@ -132,6 +132,19 @@ class SoftwareUpdatePlugin(octoprint.plugin.BlueprintPlugin,
self._clean_settings_check(key, settings_check, data, delete=deletables, save=False) self._clean_settings_check(key, settings_check, data, delete=deletables, save=False)
elif current == 1:
configured_checks = self._settings.get(["checks"], incl_defaults=False)
if configured_checks is None:
return
if "octoprint" in configured_checks and "octoprint" in configured_checks["octoprint"]:
# that's a circular reference, back to defaults
dummy_defaults = dict(plugins=dict())
dummy_defaults["plugins"][self._identifier] = dict(checks=dict())
dummy_defaults["plugins"][self._identifier]["checks"]["octoprint"] = None
self._settings.set(["checks", "octoprint"], None, defaults=dummy_defaults)
self._settings.save()
def _clean_settings_check(self, key, data, defaults, delete=None, save=True): def _clean_settings_check(self, key, data, defaults, delete=None, save=True):
if delete is None: if delete is None:
delete = [] delete = []