Server.py

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

# ***************************************************************************
# *                                                                         *
# *   Animate workbench - FreeCAD Workbench for lightweight animation       *
# *   Copyright (c) 2019 Jiří Valášek jirka362@gmail.com                    *
# *                                                                         *
# *   This file is part of the Animate workbench.                           *
# *                                                                         *
# *   This program is free software; you can redistribute it and/or modify  *
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
# *   as published by the Free Software Foundation; either version 2 of     *
# *   the License, or (at your option) any later version.                   *
# *   for detail see the LICENCE text file.                                 *
# *                                                                         *
# *   Animate workbench is distributed in the hope that it will be useful,  *
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
# *   GNU Lesser General Public License for more details.                   *
# *                                                                         *
# *   You should have received a copy of the GNU Library General Public     *
# *   License along with Animate workbench; if not, write to the Free       *
# *   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,        *
# *   MA  02111-1307 USA                                                    *
# *                                                                         *
# ***************************************************************************/



import FreeCAD
import FreeCADGui
import communication as com

from PySide2.QtWidgets import QMessageBox
from os import path


PATH_TO_ICONS = path.join(FreeCAD.getHomePath(), "Mod", "Animate", "Resources",
                          "Icons")




class ServerProxy(object):

    

    cmd_server = None

    

    def __init__(self, fp):
        self.setProperties(fp)
        fp.Proxy = self

    

    def onDocumentRestored(self, fp):
        self.setProperties(fp)
        fp.ViewObject.Proxy.setProperties(fp.ViewObject)

    #Method called by `AnimateDocumentObserver` when document with this class
    #instance is closing.
    #
    #This method is to be called from ServersDocumentObserver so that
    #the `Port` is freed when document is closed.
    #

    def onDocumentClosed(self):
        # Check there is a cmd_server to close and close it
        if isinstance(self.cmd_server, com.CommandServer):
            FreeCAD.Console.PrintMessage("Closing server with it's document\n")
            self.cmd_server.close()

    

    def setProperties(self, fp):
        # Check properties are present and create them if not
        if not hasattr(fp, "Address"):
            fp.addProperty("App::PropertyString", "Address", "Server settings",
                           "IP address where the server will listen for "
                           + "connection.\nValid values are IPv4 and "
                           + "IPv6 addresses or 'localhost'string."
                           ).Address = "localhost"
        if not hasattr(fp, "Port"):
            fp.addProperty("App::PropertyIntegerConstraint", "Port",
                           "Server settings", "Port where the server will "
                           + "listen for connections.\n" +
                           "Valid port numbers are in range <0 | 65535>,\n"
                           + "but some may be already taken!"
                           ).Port = (54321, 0, 65535, 1)
        else:
            fp.Port = (fp.Port, 0, 65535, 1)
        if not hasattr(fp, "Running"):
            fp.addProperty("App::PropertyBool", "Running", "Server settings",
                           "If Server Running is true, then Server listens "
                           + "for new connections."
                           ).Running = False

        # hide Placement property as there is nothing to display/move
        fp.setEditorMode("Placement", 2)
        # make Running property read-only as it's set from context menu/
        # by double clicking
        fp.setEditorMode("Running", 1)

        # try to start cmd_server, if it was running before closing
        if fp.Running:
            self.cmd_server = com.startServer(fp.Address, fp.Port)
            if self.cmd_server == com.SERVER_ERROR_INVALID_ADDRESS:
                fp.ViewObject.Proxy._icon = path.join(PATH_TO_ICONS,
                                                      "Server.png")
                QMessageBox.warning(None, 'Error while starting server',
                                    "The address was not in supported format.")
                fp.Running = False
            elif self.cmd_server == com.SERVER_ERROR_PORT_OCCUPIED:
                fp.ViewObject.Proxy._icon = path.join(PATH_TO_ICONS,
                                                      "Server.png")
                QMessageBox.warning(None, 'Error while starting server',
                                    "The port requested is already occupied.")
                fp.Running = False
            else:
                fp.setEditorMode("Address", 1)
                fp.setEditorMode("Port", 1)
                fp.Running = True
                fp.ViewObject.Proxy._icon = path.join(PATH_TO_ICONS,
                                                      "ServerRunning.png")

        # Make an document observer to be notified when document will be closed
        import AnimateDocumentObserver
        AnimateDocumentObserver.addObserver()
        FreeCAD.animate_observer.addServerToNotify(self,
                                                   FreeCAD.ActiveDocument.Name)

    

    def __getstate__(self):
        return None

    

    def __setstate__(self, state):
        return None




class ViewProviderServerProxy(object):

    

    
    _icon = path.join(PATH_TO_ICONS, "Server.png")

    

    def __init__(self, vp):
        self.setProperties(vp)
        vp.Proxy = self

    

    def onDelete(self, vp, subelements):
        if vp.Object.Running:
            FreeCAD.Console.PrintMessage("Deleting server safely.\n")
            vp.Object.Proxy.cmd_server.close()
        return True

    

    def doubleClicked(self, vp):
        if not vp.Object.Running:
            vp.Object.Proxy.cmd_server = com.startServer(vp.Object.Address,
                                                         vp.Object.Port)
            if isinstance(vp.Object.Proxy.cmd_server, int):
                if vp.Object.Proxy.cmd_server == \
                        com.SERVER_ERROR_INVALID_ADDRESS:
                    QMessageBox.warning(None, 'Error while starting server',
                                        "The address was not in supported "
                                        + "format.")
                elif vp.Object.Proxy.cmd_server == \
                        com.SERVER_ERROR_PORT_OCCUPIED:
                    QMessageBox.warning(None, 'Error while starting server',
                                        "The port requested is already "
                                        + "occupied.")
            else:
                vp.Object.setEditorMode("Address", 1)
                vp.Object.setEditorMode("Port", 1)
                vp.Object.Running = True
                self._icon = path.join(PATH_TO_ICONS, "ServerRunning.png")
        elif vp.Object.Running:
            vp.Object.Proxy.cmd_server.close()
            vp.Object.setEditorMode("Address", 0)
            vp.Object.setEditorMode("Port", 0)
            vp.Object.Running = False
            self._icon = path.join(PATH_TO_ICONS, "Server.png")
        return True

    

    def setupContextMenu(self, vp, menu):
        menu.clear()
        if vp.Object.Running:
            action = menu.addAction("Disconnect Server")
            action.triggered.connect(lambda f=self.doubleClicked,
                                     arg=vp: f(arg))
        else:
            action = menu.addAction("Connect Server")
            action.triggered.connect(lambda f=self.doubleClicked,
                                     arg=vp: f(arg))

    

    def getIcon(self):
        return self._icon

    

    def setProperties(self, vp):
        vp.setEditorMode("AngularDeflection", 2)
        vp.setEditorMode("BoundingBox", 2)
        vp.setEditorMode("Deviation", 2)
        vp.setEditorMode("DisplayMode", 2)
        vp.setEditorMode("DrawStyle", 2)
        vp.setEditorMode("Lighting", 2)
        vp.setEditorMode("LineColor", 2)
        vp.setEditorMode("LineWidth", 2)
        vp.setEditorMode("PointColor", 2)
        vp.setEditorMode("PointSize", 2)
        vp.setEditorMode("Selectable", 2)
        vp.setEditorMode("SelectionStyle", 2)
        vp.setEditorMode("ShapeColor", 2)
        vp.setEditorMode("Transparency", 2)
        vp.setEditorMode("Visibility", 2)

        if vp.Object.Running:
            self._icon = path.join(PATH_TO_ICONS, "ServerRunning.png")
        else:
            self._icon = path.join(PATH_TO_ICONS, "Server.png")




class ServerCommand(object):

    

    def GetResources(self):
        return {'Pixmap': path.join(PATH_TO_ICONS, "ServerCmd.png"),
                'MenuText': "Server",
                'ToolTip': "Create Server instance."}

    

    def Activated(self):
        doc = FreeCAD.ActiveDocument
        a = doc.addObject("Part::FeaturePython", "Server")
        ServerProxy(a)
        if FreeCAD.GuiUp:
            ViewProviderServerProxy(a.ViewObject)
        doc.recompute()

    

    def IsActive(self):
        if FreeCAD.ActiveDocument is None:
            return False
        else:
            return True


if FreeCAD.GuiUp:
    # Add command to FreeCAD Gui when importing this module in InitGui
    FreeCADGui.addCommand('ServerCommand', ServerCommand())