managesettingsdialog.py

Go to the documentation of this file.

#  Copyright 2020-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import os
import wx
 
from wx import Colour
from ..widgets import RIDEDialog, VerticalSizer
from .configobj import ConfigObj, UnreprError
from .settings import ConfigurationError, _Section, initialize_settings
 
from ..context import SETTINGS_DIRECTORY
 
ID_LOAD = 5551
ID_SAVE = 5552
ID_CANCEL = -1
 
 
class SaveLoadSettings(RIDEDialog):
 
    def __init__(self, parent, settings):
        self._parent_parent = parent
        self._settings_settings = settings
        self._section_section = self._settings_settings._name
        self._selection_listeners_selection_listeners = []
        title = "Save or Load Settings"
        RIDEDialog.__init__(self, parent=parent, title=title, size=(650, 400))
        # set Left to Right direction (while we don't have localization)
        self.SetLayoutDirection(wx.Layout_LeftToRight)
        main_sizer = wx.FlexGridSizer(rows=5, cols=1, vgap=10, hgap=10)
        buttons_sizer = wx.BoxSizer(orient=wx.HORIZONTAL)
        load = wx.Button(self, ID_LOAD, 'Load settings from file...')
        save = wx.Button(self, ID_SAVE, 'Save settings to file...')
        self.SetSizer(VerticalSizer())
        self.SetBackgroundColour(Colour(self.color_background))
        self.SetForegroundColour(Colour(self.color_foreground))
        self._default_path_default_path = os.path.join(SETTINGS_DIRECTORY, 'settings.cfg')
        directory = wx.StaticText(self, label=f"Current directory: {SETTINGS_DIRECTORY}")
        buttons_sizer.Add(load)
        buttons_sizer.AddSpacer(10)
        buttons_sizer.Add(save)
        main_sizer.Add(directory)
        main_sizer.AddSpacer(10)
        main_sizer.Add(buttons_sizer)
        self.SetSizerAndFit(main_sizer)
        self.Bind(wx.EVT_BUTTON, self.OnLoadOnLoad)
        self.Bind(wx.EVT_BUTTON, self.OnSaveOnSave)
        # print(f"DEBUG: SaveLoad init returncode {self.GetReturnCode()}")
 
    def OnLoad(self, event):
        if event.GetId() != ID_LOAD:
            event.Skip()
            self.SetReturnCode(ID_CANCEL)
            return ID_CANCEL
        load_dlg = wx.FileDialog(self, message="File with Settings to Load",
                                 defaultDir=SETTINGS_DIRECTORY, wildcard="*.cfg")
        if load_dlg.ShowModal() == wx.ID_CANCEL:
            self.SetReturnCode(ID_CANCEL)
            return ID_CANCEL
        file = load_dlg.GetPath()
        # print(f"DEBUG: SaveLoad returncode {self.GetReturnCode()}")
        if os.path.isfile(file):  # Test validity settings
            # print(f"DEBUG: Selected file is {file}.")
            # print(f"DEBUG: load_and_merge BEFORE: {self._settings['background']}")
            self.Freeze()
            self.load_and_mergeload_and_merge(file)
            self.Thaw()
            # print(f"DEBUG: load_and_merge AFTER: {self._settings['background']}")
            self._parent_parent.Refresh()
            self._parent_parent.GetParent().Refresh()
            self.SetReturnCode(ID_LOAD)
            self.Close()
            return ID_LOAD
 
    def OnClose(self):
        self.SetReturnCode(ID_CANCEL)
        return ID_CANCEL
 
    def OnSave(self, event):
        if event.GetId() != ID_SAVE:
            event.Skip()
            self.SetReturnCode(ID_CANCEL)
            return ID_CANCEL
 
        with wx.FileDialog(self, message="Save Settings to file", defaultDir=SETTINGS_DIRECTORY,
                           wildcard="*.cfg", style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT) as save_dlg:
            if save_dlg.ShowModal() == wx.ID_CANCEL:
                self.SetReturnCode(ID_CANCEL)
                return ID_CANCEL
            # print(f"DEBUG: SaveLoad returncode {self.GetReturnCode()}")
            pathname = save_dlg.GetPath()
            filename = os.path.basename(pathname)
            dirname = os.path.dirname(pathname)
            try:
                initialize_settings(self._default_path_default_path, pathname)
            except IOError:
                raise RuntimeError('Could not open settings file "%s" for writing' % pathname)
        self.SetReturnCode(ID_SAVE)
        self.Close()
        return ID_SAVE
 
    def load_and_merge(self, user_path):
        try:
            nnew_settings = ConfigObj(user_path, unrepr=True)
            mysection=nnew_settings.get(self._section_section)
            if not mysection:
                mysection = nnew_settings['Plugins'].get(self._section_section)
                if not mysection:
                    raise ConfigurationError("Error trying to get '%s' from file %s" % (f"[Plugins][{self._section}]",user_path))
 
            for key, value in mysection.items():
                if self._settings_settings.has_setting(key):
                    if isinstance(value, dict):
                        for k, v in value.items():
                            if isinstance(self._settings_settings.get_without_default(key).get_without_default(k), _Section):
                                self._settings_settings[key][k].set_defaults(None, **v)
                            else:
                                self._settings_settings[key].set(k, v)
                    else:
                        self._settings_settings.set(key,value)
            self._settings_settings.save()
        except UnreprError as err:  # DEBUG errored file
            raise ConfigurationError("Invalid config file '%s': %s" % (user_path, err))