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

    32

import traceback

    33

from threading import Thread, Event

    34

    35

from twisted.internet import reactor, threads

    36

from autobahn.twisted import wamp

    37

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

    38

from autobahn.wamp import types

    39

from autobahn.wamp.exception import TransportLost

    40

from autobahn.wamp.serializer import MsgPackSerializer

    41

    42

    43

_WampSession = None

    44

_WampConnection = None

    45

_WampSessionEvent = Event()

    47

    48

    49

class WampSession(wamp.ApplicationSession):

    50

    def onJoin(self, details):

    51

        global _WampSession

    52

        _WampSession = self

    53

        _WampSessionEvent.set()

    54

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

    55

    56

    def onLeave(self, details):

    57

        global _WampSession

    58

        _WampSessionEvent.clear()

    59

        _WampSession = None

    60

        print('WAMP session left')

    61

    62

    63

PLCObjDefaults = {

    64

    "StartPLC":          False,

    65

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

    66

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

    67

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

    68

}

    69

    70

    71

def WAMP_connector_factory(uri, confnodesroot):

    72

    """

    73

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

    74

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

    75

    """

    76

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

    77

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

    78

    urlprefix = {"WAMP":  "ws",

    79

                 "WAMPS": "wss"}[servicetype]

    80

    url = urlprefix+"://"+urlpath

    81

    82

    def RegisterWampClient():

    83

    84

        # start logging to console

    85

        # log.startLogging(sys.stdout)

    86

    87

        # create a WAMP application session factory

    88

        component_config = types.ComponentConfig(

    89

            realm=unicode(realm),

    90

            extra={"ID": ID})

    91

        session_factory = wamp.ApplicationSessionFactory(

    92

            config=component_config)

    93

        session_factory.session = WampSession

    94

    95

        # create a WAMP-over-WebSocket transport client factory

    96

        transport_factory = WampWebSocketClientFactory(

    97

            session_factory,

    98

            url=url,

    99

            serializers=[MsgPackSerializer()])

   100

   101

        # start the client from a Twisted endpoint

   102

        conn = connectWS(transport_factory)

   103

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

   104

        return conn

   105

   106

    AddToDoBeforeQuit = confnodesroot.AppFrame.AddToDoBeforeQuit

   107

   108

    def ThreadProc():

   109

        global _WampConnection

   110

        _WampConnection = RegisterWampClient()

   111

        AddToDoBeforeQuit(reactor.stop)

   112

        reactor.run(installSignalHandlers=False)

   113

   114

    def WampSessionProcMapper(funcname):

   115

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

   116

   117

        def catcher_func(*args, **kwargs):

   118

            if _WampSession is not None:

   119

                try:

   120

                    return threads.blockingCallFromThread(

   121

                        reactor, _WampSession.call, wampfuncname,

   122

                        *args, **kwargs)

   123

                except TransportLost:

   124

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

   125

                    confnodesroot._SetConnector(None)

   126

                except Exception:

   127

                    errmess = traceback.format_exc()

   128

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

   129

                    print(errmess)

   130

                    # confnodesroot._SetConnector(None)

   131

            return PLCObjDefaults.get(funcname)

   132

        return catcher_func

   133

   134

    class WampPLCObjectProxy(object):

   135

        def __init__(self):

   136

            global _WampConnection

   137

            if not reactor.running:

   138

                Thread(target=ThreadProc).start()

   139

            else:

   140

                _WampConnection = threads.blockingCallFromThread(

   141

                    reactor, RegisterWampClient)

   142

            if not _WampSessionEvent.wait(5):

   143

                _WampConnection.stopConnecting()

   144

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

   145

   146

        def __del__(self):

   147

            _WampConnection.disconnect()

   148

            #

   149

            # reactor.stop()

   150

   151

        def __getattr__(self, attrName):

   152

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

   153

            if member is None:

   154

                member = WampSessionProcMapper(attrName)

   155

                self.__dict__[attrName] = member

   156

            return member

   157

   158

    # Try to get the proxy object

   159

    try:

   160

        return WampPLCObjectProxy()

   161

    except Exception:

   162

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

   163

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

   164

        return None