#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
**tcpClientUi.py**
**Platform:**
Windows, Linux, Mac Os X.
**Description:**
This module defines the :class:`TCPClientUi` Component Interface class.
**Others:**
"""
#**********************************************************************************************************************
#*** External imports.
#**********************************************************************************************************************
import os
import socket
from PyQt4.QtCore import QChar
from PyQt4.QtCore import QString
from PyQt4.QtCore import Qt
from PyQt4.QtGui import QGridLayout
#**********************************************************************************************************************
#*** Internal imports.
#**********************************************************************************************************************
import foundations.common
import foundations.exceptions
import foundations.strings
import foundations.verbose
from manager.qwidgetComponent import QWidgetComponentFactory
#**********************************************************************************************************************
#*** Module attributes.
#**********************************************************************************************************************
__author__ = "Thomas Mansencal"
__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal"
__license__ = "GPL V3.0 - http://www.gnu.org/licenses/"
__maintainer__ = "Thomas Mansencal"
__email__ = "thomas.mansencal@gmail.com"
__status__ = "Production"
__all__ = ["LOGGER", "COMPONENT_UI_FILE", "TCPClientUi"]
LOGGER = foundations.verbose.installLogger()
COMPONENT_UI_FILE = os.path.join(os.path.dirname(__file__), "ui", "TCP_Client_Ui.ui")
#**********************************************************************************************************************
#*** Module classes and definitions.
#**********************************************************************************************************************
[docs]class TCPClientUi(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)):
"""
This class is the :mod:`umbra.components.factory.tcpClientUi.tcpClientUi` Component Interface class.
"""
def __init__(self, parent=None, name=None, *args, **kwargs):
"""
.. Sphinx: Statements updated for auto-documentation purpose.
:param parent: Object parent. ( QObject )
:param name: Component name. ( String )
:param \*args: Arguments. ( \* )
:param \*\*kwargs: Keywords arguments. ( \*\* )
"""
LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__))
super(TCPClientUi, self).__init__(parent, name, *args, **kwargs)
# --- Setting class attributes. ---
self.deactivatable = True
self.__engine = None
self.__settings = None
self.__settingsSection = None
self.__preferencesManager = None
self.__scriptEditor = None
self.__address = foundations.common.getHostAddress()
self.__port = 16384
self.__fileCommand = "execfile(\"{0}\")"
self.__connectionEnd = "<!RE>"
#******************************************************************************************************************
#*** Attributes properties.
#******************************************************************************************************************
@property
def engine(self):
"""
This method is the property for **self.__engine** attribute.
:return: self.__engine. ( QObject )
"""
return self.__engine
@engine.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def engine(self, value):
"""
This method is the setter method for **self.__engine** attribute.
:param value: Attribute value. ( QObject )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "engine"))
@engine.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def engine(self):
"""
This method is the deleter method for **self.__engine** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "engine"))
@property
def settings(self):
"""
This method is the property for **self.__settings** attribute.
:return: self.__settings. ( QSettings )
"""
return self.__settings
@settings.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def settings(self, value):
"""
This method is the setter method for **self.__settings** attribute.
:param value: Attribute value. ( QSettings )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "settings"))
@settings.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def settings(self):
"""
This method is the deleter method for **self.__settings** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "settings"))
@property
def settingsSection(self):
"""
This method is the property for **self.__settingsSection** attribute.
:return: self.__settingsSection. ( String )
"""
return self.__settingsSection
@settingsSection.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def settingsSection(self, value):
"""
This method is the setter method for **self.__settingsSection** attribute.
:param value: Attribute value. ( String )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "settingsSection"))
@settingsSection.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def settingsSection(self):
"""
This method is the deleter method for **self.__settingsSection** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "settingsSection"))
@property
def preferencesManager(self):
"""
This method is the property for **self.__preferencesManager** attribute.
:return: self.__preferencesManager. ( QWidget )
"""
return self.__preferencesManager
@preferencesManager.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def preferencesManager(self, value):
"""
This method is the setter method for **self.__preferencesManager** attribute.
:param value: Attribute value. ( QWidget )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "preferencesManager"))
@preferencesManager.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def preferencesManager(self):
"""
This method is the deleter method for **self.__preferencesManager** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "preferencesManager"))
@property
def scriptEditor(self):
"""
This method is the property for **self.__scriptEditor** attribute.
:return: self.__scriptEditor. ( QWidget )
"""
return self.__scriptEditor
@scriptEditor.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def scriptEditor(self, value):
"""
This method is the setter method for **self.__scriptEditor** attribute.
:param value: Attribute value. ( QWidget )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "scriptEditor"))
@scriptEditor.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def scriptEditor(self):
"""
This method is the deleter method for **self.__scriptEditor** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "scriptEditor"))
@property
def address(self):
"""
This method is the property for **self.__address** attribute.
:return: self.__address. ( String )
"""
return self.__address
@address.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def address(self, value):
"""
This method is the setter method for **self.__address** attribute.
:param value: Attribute value. ( String )
"""
if value is not None:
assert type(value) in (str, unicode), "'{0}' attribute: '{1}' type is not 'str' or 'unicode'!".format(
"address", value)
self.Address_lineEdit.setText(value)
self.__address = value
@address.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def address(self):
"""
This method is the deleter method for **self.__address** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "address"))
@property
def port(self):
"""
This method is the property for **self.__port** attribute.
:return: self.__port. ( Integer )
"""
return self.__port
@port.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def port(self, value):
"""
This method is the setter method for **self.__port** attribute.
:param value: Attribute value. ( Integer )
"""
if value is not None:
assert type(value) is int, "'{0}' attribute: '{1}' type is not 'int'!".format(
"port", value)
assert type(value) >= 0 and type(value) >= 65535, \
"'{0}' attribute: '{1}' value must be in 0-65535 range!".format("port", value)
self.Port_spinBox.setValue(value)
self.__port = value
@port.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def port(self):
"""
This method is the deleter method for **self.__port** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "port"))
@property
def fileCommand(self):
"""
This method is the property for **self.__fileCommand** attribute.
:return: self.__fileCommand. ( String )
"""
return self.__fileCommand
@fileCommand.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def fileCommand(self, value):
"""
This method is the setter method for **self.__fileCommand** attribute.
:param value: Attribute value. ( String )
"""
if value is not None:
assert type(value) in (str, unicode), "'{0}' attribute: '{1}' type is not 'str' or 'unicode'!".format(
"fileCommand", value)
self.__fileCommand = value
@fileCommand.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def fileCommand(self):
"""
This method is the deleter method for **self.__fileCommand** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "fileCommand"))
@property
def connectionEnd(self):
"""
This method is the property for **self.__connectionEnd** attribute.
:return: self.__connectionEnd. ( String )
"""
return self.__connectionEnd
@connectionEnd.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def connectionEnd(self, value):
"""
This method is the setter method for **self.__connectionEnd** attribute.
:param value: Attribute value. ( String )
"""
if value is not None:
assert type(value) in (str, unicode), "'{0}' attribute: '{1}' type is not 'str' or 'unicode'!".format(
"connectionEnd", value)
self.__connectionEnd = value
@connectionEnd.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def connectionEnd(self):
"""
This method is the deleter method for **self.__connectionEnd** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "connectionEnd"))
#******************************************************************************************************************
#*** Class methods.
#******************************************************************************************************************
[docs] def activate(self, engine):
"""
This method activates the Component.
:param engine: Engine to attach the Component to. ( QObject )
:return: Method success. ( Boolean )
"""
LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__))
self.__engine = engine
self.__settings = self.__engine.settings
self.__settingsSection = self.name
self.__preferencesManager = self.__engine.componentsManager["factory.preferencesManager"]
self.__scriptEditor = self.__engine.componentsManager["factory.scriptEditor"]
self.activated = True
return True
[docs] def deactivate(self):
"""
This method deactivates the Component.
:return: Method success. ( Boolean )
"""
LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__))
self.__engine = None
self.__settings = None
self.__settingsSection = None
self.__preferencesManager = None
self.activated = False
return True
[docs] def initializeUi(self):
"""
This method initializes the Component ui.
:return: Method success. ( Boolean )
"""
LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__))
self.__Port_spinBox_setUi()
self.__Address_lineEdit_setUi()
self.__File_Command_lineEdit_setUi()
self.__Connection_End_lineEdit_setUi()
self.__addActions()
# Signals / Slots.
self.Port_spinBox.valueChanged.connect(self.__Port_spinBox__valueChanged)
self.Address_lineEdit.editingFinished.connect(self.__Address_lineEdit__editFinished)
self.File_Command_lineEdit.editingFinished.connect(self.__File_Command_lineEdit__editFinished)
self.Connection_End_lineEdit.editingFinished.connect(self.__Connection_End_lineEdit__editFinished)
self.initializedUi = True
return True
[docs] def uninitializeUi(self):
"""
This method uninitializes the Component ui.
:return: Method success. ( Boolean )
"""
LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__))
self.__removeActions()
# Signals / Slots.
self.Port_spinBox.valueChanged.disconnect(self.__Port_spinBox__valueChanged)
self.Address_lineEdit.editingFinished.disconnect(self.__Address_lineEdit__editFinished)
self.File_Command_lineEdit.editingFinished.disconnect(self.__File_Command_lineEdit__editFinished)
self.Connection_End_lineEdit.editingFinished.disconnect(self.__Connection_End_lineEdit__editFinished)
self.initializedUi = False
return True
def __addActions(self):
"""
This method sets Component actions.
"""
LOGGER.debug("> Adding '{0}' Component actions.".format(self.__class__.__name__))
self.__scriptEditor.commandMenu.addSeparator()
self.__scriptEditor.commandMenu.addAction(self.__engine.actionsManager.registerAction(
"Actions|Umbra|Components|addons.tcpServerUi|&Command|Send Selection To Server",
shortcut=Qt.ControlModifier + Qt.AltModifier + Qt.Key_Return,
slot=self.__sendSelectionToServerAction__triggered))
self.__scriptEditor.commandMenu.addAction(self.__engine.actionsManager.registerAction(
"Actions|Umbra|Components|addons.tcpServerUi|&Command|&Send Current File To Server",
shortcut=Qt.SHIFT + Qt.AltModifier + Qt.CTRL + Qt.Key_Return,
slot=self.__sendFileToServerAction__triggered))
def __removeActions(self):
"""
This method removes actions.
"""
LOGGER.debug("> Removing '{0}' Component actions.".format(self.__class__.__name__))
sendSelectionToServerAction = "Actions|Umbra|Components|addons.tcpServerUi|&Command|Send Selection To Server"
sendFileToServerAction = "Actions|Umbra|Components|addons.tcpServerUi|&Command|&Send Current File To Server"
for action in (sendSelectionToServerAction, sendFileToServerAction):
self.__scriptEditor.commandMenu.removeAction(self.__engine.actionsManager.getAction(action))
self.__engine.actionsManager.unregisterAction(action)
def __Address_lineEdit_setUi(self):
"""
This method fills **Address_lineEdit** Widget.
"""
# Adding settings key if it doesn't exists.
self.__settings.getKey(self.__settingsSection, "address").isNull() and \
self.__settings.setKey(self.__settingsSection, "address", self.__address)
address = self.__settings.getKey(self.__settingsSection, "address").toString()
LOGGER.debug("> Setting '{0}' with value '{1}'.".format("Address_lineEdit",
address))
self.__address = address
self.Address_lineEdit.setText(address)
def __Address_lineEdit__editFinished(self):
"""
This method is triggered when **Address_lineEdit** Widget is edited.
"""
address = self.Address_lineEdit.text()
self.__settings.setKey(self.__settingsSection, "address", address)
self.__address = address
def __Port_spinBox_setUi(self):
"""
This method sets the **Port_spinBox** Widget.
"""
# Adding settings key if it doesn't exists.
self.__settings.getKey(self.__settingsSection, "port").isNull() and \
self.__settings.setKey(self.__settingsSection, "port", self.__port)
port = foundations.common.getFirstItem(self.__settings.getKey(self.__settingsSection, "port").toInt())
LOGGER.debug("> Setting '{0}' with value '{1}'.".format("Port_spinBox",
port))
self.__port = port
self.Port_spinBox.setValue(port)
def __Port_spinBox__valueChanged (self, value):
"""
This method is triggered when the **Port_spinBox** Widget value is changed.
:param value: Port value. ( Integer )
"""
LOGGER.debug("> 'Port' value: '{0}'.".format(value))
self.__port = int(value)
self.__settings.setKey(self.__settingsSection, "port", value)
def __File_Command_lineEdit_setUi(self):
"""
This method fills **File_Command_lineEdit** Widget.
"""
# Adding settings key if it doesn't exists.
self.__settings.getKey(self.__settingsSection, "fileCommand").isNull() and \
self.__settings.setKey(self.__settingsSection, "fileCommand", self.__fileCommand)
fileCommand = self.__settings.getKey(self.__settingsSection, "fileCommand").toString()
LOGGER.debug("> Setting '{0}' with value '{1}'.".format("File_Command_lineEdit",
fileCommand))
self.__fileCommand = fileCommand
self.File_Command_lineEdit.setText(fileCommand)
def __File_Command_lineEdit__editFinished(self):
"""
This method is triggered when **File_Command_lineEdit** Widget is edited.
"""
fileCommand = self.File_Command_lineEdit.text()
self.__settings.setKey(self.__settingsSection, "fileCommand", fileCommand)
self.__fileCommand = fileCommand
def __Connection_End_lineEdit_setUi(self):
"""
This method fills **Connection_End_lineEdit** Widget.
"""
# Adding settings key if it doesn't exists.
self.__settings.getKey(self.__settingsSection, "connectionEnd").isNull() and \
self.__settings.setKey(self.__settingsSection, "connectionEnd", self.__connectionEnd)
connectionEnd = self.__settings.getKey(self.__settingsSection, "connectionEnd").toString()
LOGGER.debug("> Setting '{0}' with value '{1}'.".format("Connection_End_lineEdit",
connectionEnd))
self.__connectionEnd = connectionEnd
self.Connection_End_lineEdit.setText(connectionEnd)
def __Connection_End_lineEdit__editFinished(self):
"""
This method is triggered when **Connection_End_lineEdit** Widget is edited.
"""
connectionEnd = self.Connection_End_lineEdit.text()
self.__settings.setKey(self.__settingsSection, "connectionEnd", connectionEnd)
self.__connectionEnd = connectionEnd
def __sendSelectionToServerAction__triggered(self, checked):
"""
This method is triggered by **'Actions|Umbra|Components|addons.tcpServerUi|&Command|Send Selection To Server'** action.
:param checked: Checked state. ( Boolean )
:return: Method success. ( Boolean )
"""
editor = self.__scriptEditor.getCurrentEditor()
if not editor:
return False
selectedText = foundations.strings.encode(editor.getSelectedText().replace(QChar(QChar.ParagraphSeparator),
QString("\n")))
if not selectedText:
return False
return self.sendDataToServer(selectedText)
def __sendFileToServerAction__triggered(self, checked):
"""
This method is triggered by **'Actions|Umbra|Components|addons.tcpServerUi|&Command|&Send Current File To Server'** action.
:param checked: Checked state. ( Boolean )
:return: Method success. ( Boolean )
"""
editor = self.__scriptEditor.getCurrentEditor()
if not editor:
return False
if self.__scriptEditor.saveFile():
return self.sendDataToServer(foundations.strings.encode(self.__fileCommand).format(editor.file))
[docs] def sendDataToServer(self, data, timeOut=5):
"""
This method sends given data to the Server.
:param data: Data to send. ( String )
:param timeOut: Connection timeout in seconds. ( Float )
:return: Method success. ( Boolean )
"""
if not data.endswith(self.__connectionEnd):
data = "{0}{1}".format(data, foundations.strings.encode(self.__connectionEnd).decode("string_escape"))
connection = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
connection.settimeout(timeOut)
connection.connect((foundations.strings.encode(self.__address), int(self.__port)))
connection.send(data)
self.__engine.notificationsManager.notify(
"{0} | Socket connection command dispatched!".format(self.__class__.__name__))
connection.close()
return True