1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

from __future__ import absolute_import

    27

from __future__ import print_function

    28

import sys

    29

import traceback

    30

from threading import Thread, Event

    31

from builtins import str as text

    32

    33

from twisted.internet import reactor, threads

    34

from autobahn.twisted import wamp

    35

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

    36

from autobahn.wamp import types

    37

from autobahn.wamp.exception import TransportLost

    38

from autobahn.wamp.serializer import MsgPackSerializer

    39

    40

from runtime import PlcStatus

    41

    42

_WampSession = None

    43

_WampConnection = None

    44

_WampSessionEvent = Event()

    45

    46

    47

class WampSession(wamp.ApplicationSession):

    48

    def onJoin(self, details):

    49

        global _WampSession

    50

        _WampSession = self

    51

        _WampSessionEvent.set()

    52

        print('WAMP session joined for :', self.config.extra["ID"])

    53

    54

    def onLeave(self, details):

    55

        global _WampSession

    56

        _WampSessionEvent.clear()

    57

        _WampSession = None

    58

        print('WAMP session left')

    59

    60

    61

PLCObjDefaults = {

    62

    "StartPLC":          False,

    63

    "GetTraceVariables": ("Broken", None),

    64

    "GetPLCstatus":      (PlcStatus.Broken, None),

    65

    "RemoteExec":        (-1, "RemoteExec script failed!")

    66

}

    67

    68

    69

def WAMP_connector_factory(uri, confnodesroot):

    70

    """

    71

    WAMP://127.0.0.1:12345/path#realm#ID

    72

    WAMPS://127.0.0.1:12345/path#realm#ID

    73

    """

    74

    servicetype, location = uri.split("://")

    75

    urlpath, realm, ID = location.split('#')

    76

    urlprefix = {"WAMP":  "ws",

    77

                 "WAMPS": "wss"}[servicetype]

    78

    url = urlprefix+"://"+urlpath

    79

    80

    def RegisterWampClient():

    81

    82

        # start logging to console

    83

        # log.startLogging(sys.stdout)

    84

    85

        # create a WAMP application session factory

    86

        component_config = types.ComponentConfig(

    87

            realm=text(realm),

    88

            extra={"ID": ID})

    89

        session_factory = wamp.ApplicationSessionFactory(

    90

            config=component_config)

    91

        session_factory.session = WampSession

    92

    93

        # create a WAMP-over-WebSocket transport client factory

    94

        transport_factory = WampWebSocketClientFactory(

    95

            session_factory,

    96

            url=url,

    97

            serializers=[MsgPackSerializer()])

    98

    99

        # start the client from a Twisted endpoint

   100

        conn = connectWS(transport_factory)

   101

        confnodesroot.logger.write(_("WAMP connecting to URL : %s\n") % url)

   102

        return conn

   103

   104

    AddToDoBeforeQuit = confnodesroot.AppFrame.AddToDoBeforeQuit

   105

   106

    def ThreadProc():

   107

        global _WampConnection

   108

        _WampConnection = RegisterWampClient()

   109

        AddToDoBeforeQuit(reactor.stop)

   110

        reactor.run(installSignalHandlers=False)

   111

   112

    def WampSessionProcMapper(funcname):

   113

        wampfuncname = text('.'.join((ID, funcname)))

   114

   115

        def catcher_func(*args, **kwargs):

   116

            if _WampSession is not None:

   117

                try:

   118

                    return threads.blockingCallFromThread(

   119

                        reactor, _WampSession.call, wampfuncname,

   120

                        *args, **kwargs)

   121

                except TransportLost:

   122

                    confnodesroot.logger.write_error(_("Connection lost!\n"))

   123

                    confnodesroot._SetConnector(None)

   124

                except Exception:

   125

                    errmess = traceback.format_exc()

   126

                    confnodesroot.logger.write_error(errmess+"\n")

   127

                    print(errmess)

   128

                    # confnodesroot._SetConnector(None)

   129

            return PLCObjDefaults.get(funcname)

   130

        return catcher_func

   131

   132

    class WampPLCObjectProxy(object):

   133

        def __init__(self):

   134

            global _WampConnection

   135

            if not reactor.running:

   136

                Thread(target=ThreadProc).start()

   137

            else:

   138

                _WampConnection = threads.blockingCallFromThread(

   139

                    reactor, RegisterWampClient)

   140

            if not _WampSessionEvent.wait(5):

   141

                _WampConnection.stopConnecting()

   142

                raise Exception(_("WAMP connection timeout"))

   143

   144

        def __del__(self):

   145

            _WampConnection.disconnect()

   146

            #

   147

            # reactor.stop()

   148

   149

        def __getattr__(self, attrName):

   150

            member = self.__dict__.get(attrName, None)

   151

            if member is None:

   152

                member = WampSessionProcMapper(attrName)

   153

                self.__dict__[attrName] = member

   154

            return member

   155

   156

    # Try to get the proxy object

   157

    try:

   158

        return WampPLCObjectProxy()

   159

    except Exception:

   160

        confnodesroot.logger.write_error(_("WAMP connection to '%s' failed.\n") % location)

   161

        confnodesroot.logger.write_error(traceback.format_exc())

   162

        return None