ProjectPyramid/ConfigurationPage/PyramidPage.py

# -*- coding: utf-8 -*-

# Copyright (c) 2012 - 2020 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module implementing the Pyramid configuration page.
"""

from __future__ import unicode_literals

from PyQt5.QtCore import pyqtSlot

from E5Gui.E5Completers import E5DirCompleter
from E5Gui import E5FileDialog
from E5Gui.E5Application import e5App

from Preferences.ConfigurationPages.ConfigurationPageBase import \
    ConfigurationPageBase
from .Ui_PyramidPage import Ui_PyramidPage

import Utilities
import UI.PixmapCache

from Globals import isWindowsPlatform, isMacPlatform


class PyramidPage(ConfigurationPageBase, Ui_PyramidPage):
    """
    Class implementing the Pyramid configuration page.
    """
    def __init__(self, plugin):
        """
        Constructor
        
        @param plugin reference to the plugin object
        """
        super(PyramidPage, self).__init__()
        self.setupUi(self)
        self.setObjectName("PyramidPage")
        
        self.__plugin = plugin
        
        consoleList = []
        if isWindowsPlatform():
            consoleList.append("cmd.exe /c")
        elif isMacPlatform():
            consoleList.append("xterm -e")
            consoleList.append("/opt/X11/bin/xterm -e")
        else:
            consoleList.append("@konsole --workdir . -e")
            # KDE4/5 konsole spawns
            consoleList.append("gnome-terminal -e")
            consoleList.append("mate-terminal -e")
            consoleList.append("xfce4-terminal -e")
            consoleList.append("xterm -e")
        self.consoleCommandCombo.addItems(consoleList)
        
        self.virtualEnvPy3Button.setIcon(UI.PixmapCache.getIcon("open.png"))
        self.virtualEnvPy2Button.setIcon(UI.PixmapCache.getIcon("open.png"))
        self.translationsButton.setIcon(UI.PixmapCache.getIcon("open.png"))
        self.urlResetButton.setIcon(UI.PixmapCache.getIcon("editUndo.png"))
        
        self.virtualEnvPy2Completer = E5DirCompleter(self.virtualEnvPy2Edit)
        self.virtualEnvPy3Completer = E5DirCompleter(self.virtualEnvPy3Edit)
        
        self.py2ShellCombo.addItem(self.tr("Plain Python"), "python")
        self.py2ShellCombo.addItem(self.tr("IPython"), "ipython")
        self.py2ShellCombo.addItem(self.tr("bpython"), "bpython")
        
        self.py3ShellCombo.addItem(self.tr("Plain Python"), "python")
        self.py3ShellCombo.addItem(self.tr("IPython"), "ipython")
        self.py3ShellCombo.addItem(self.tr("bpython"), "bpython")
        
        try:
            venvManager = e5App().getObject("VirtualEnvManager")
            
            self.py2VenvNameComboBox.addItems(
                [""] + sorted(venvManager.getVirtualenvNamesForVariant(2)))
            self.py3VenvNameComboBox.addItems(
                [""] + sorted(venvManager.getVirtualenvNamesForVariant(3)))
            
            self.pyramidVirtualEnvPy2Group.hide()
            self.pyramidVirtualEnvPy3Group.hide()
            
            self.__hasVirtualEnvironmentManager = True
        except KeyError:
            venvManager = None
            
            self.pyramidVirtualEnvironmentPy2Group.hide()
            self.pyramidVirtualEnvironmentPy3Group.hide()
            
            self.__hasVirtualEnvironmentManager = False
        
        # set initial values
        self.consoleCommandCombo.setEditText(
            self.__plugin.getPreferences("ConsoleCommand"))
        
        self.externalBrowserCheckBox.setChecked(
            self.__plugin.getPreferences("UseExternalBrowser"))
        
        if venvManager:
            venvName = self.__plugin.getPreferences(
                "VirtualEnvironmentNamePy2")
            if venvName:
                index = self.py2VenvNameComboBox.findText(venvName)
                if index < 0:
                    index = 0
                self.py2VenvNameComboBox.setCurrentIndex(index)
        else:
            self.virtualEnvPy2Edit.setText(
                self.__plugin.getPreferences("VirtualEnvironmentPy2"))
        self.py2ShellCombo.setCurrentIndex(self.py2ShellCombo.findData(
            self.__plugin.getPreferences("Python2ConsoleType")))
        
        if venvManager:
            venvName = self.__plugin.getPreferences(
                "VirtualEnvironmentNamePy3")
            if venvName:
                index = self.py3VenvNameComboBox.findText(venvName)
                if index < 0:
                    index = 0
                self.py3VenvNameComboBox.setCurrentIndex(index)
        else:
            self.virtualEnvPy3Edit.setText(
                self.__plugin.getPreferences("VirtualEnvironmentPy3"))
        self.py3ShellCombo.setCurrentIndex(self.py3ShellCombo.findData(
            self.__plugin.getPreferences("Python3ConsoleType")))
        
        self.urlEdit.setText(
            self.__plugin.getPreferences("PyramidDocUrl"))
        
        self.translationsEdit.setText(
            self.__plugin.getPreferences("TranslationsEditor"))
    
    def save(self):
        """
        Public slot to save the Pyramid configuration.
        """
        self.__plugin.setPreferences(
            "ConsoleCommand", self.consoleCommandCombo.currentText())
        
        self.__plugin.setPreferences(
            "UseExternalBrowser", self.externalBrowserCheckBox.isChecked())
        
        if self.__hasVirtualEnvironmentManager:
            self.__plugin.setPreferences(
                "VirtualEnvironmentNamePy2",
                self.py2VenvNameComboBox.currentText())
        else:
            self.__plugin.setPreferences(
                "VirtualEnvironmentPy2", self.virtualEnvPy2Edit.text())
        self.__plugin.setPreferences(
            "Python2ConsoleType",
            self.py2ShellCombo.itemData(self.py2ShellCombo.currentIndex()))
        
        if self.__hasVirtualEnvironmentManager:
            self.__plugin.setPreferences(
                "VirtualEnvironmentNamePy3",
                self.py3VenvNameComboBox.currentText())
        else:
            self.__plugin.setPreferences(
                "VirtualEnvironmentPy3", self.virtualEnvPy3Edit.text())
        self.__plugin.setPreferences(
            "Python3ConsoleType",
            self.py3ShellCombo.itemData(self.py3ShellCombo.currentIndex()))
        
        self.__plugin.setPreferences(
            "PyramidDocUrl", self.urlEdit.text())
        
        self.__plugin.setPreferences(
            "TranslationsEditor", self.translationsEdit.text())
    
    @pyqtSlot()
    def on_virtualEnvPy3Button_clicked(self):
        """
        Private slot to select the virtual environment for Python 3 via a
        directory selection dialog.
        """
        vDir = self.virtualEnvPy3Edit.text()
        if not vDir:
            vDir = Utilities.getHomeDir()
        virtualEnv = E5FileDialog.getExistingDirectory(
            self,
            self.tr("Select Virtual Environment for Python 3"),
            vDir,
            E5FileDialog.Options(E5FileDialog.Option(0)))
        
        if virtualEnv:
            self.virtualEnvPy3Edit.setText(Utilities.toNativeSeparators(
                virtualEnv))
    
    @pyqtSlot()
    def on_virtualEnvPy2Button_clicked(self):
        """
        Private slot to select the virtual environment for Python 2 via a
        directory selection dialog.
        """
        vDir = self.virtualEnvPy2Edit.text()
        if not vDir:
            vDir = Utilities.getHomeDir()
        virtualEnv = E5FileDialog.getExistingDirectory(
            self,
            self.tr("Select Virtual Environment for Python 2"),
            vDir,
            E5FileDialog.Options(E5FileDialog.Option(0)))
        
        if virtualEnv:
            self.virtualEnvPy2Edit.setText(Utilities.toNativeSeparators(
                virtualEnv))
    
    @pyqtSlot()
    def on_translationsButton_clicked(self):
        """
        Private slot to select the translations editor via a file selection
        dialog.
        """
        editor = E5FileDialog.getOpenFileName(
            self,
            self.tr("Translations Editor"),
            self.translationsEdit.text(),
            self.tr("All Files (*)"))
        if editor:
            self.translationsEdit.setText(Utilities.toNativeSeparators(editor))
    
    @pyqtSlot()
    def on_urlResetButton_clicked(self):
        """
        Private slot to reset the Pyramid documentation URL.
        """
        self.urlEdit.setText(
            self.__plugin.getDefaultPreference("PyramidDocUrl"))