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 functools import partial

    31

from threading import Thread, Event

    32

from six import text_type as text

    33

    34

from twisted.internet import reactor, threads

    35

from autobahn.twisted import wamp

    36

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

    37

from autobahn.wamp import types

    38

from autobahn.wamp.exception import TransportLost

    39

from autobahn.wamp.serializer import MsgPackSerializer

    40

    41

from runtime import PlcStatus

    42

    43

_WampSession = None

    44

_WampConnection = None

    45

_WampSessionEvent = Event()

    46

    47

    48

class WampSession(wamp.ApplicationSession):

    49

    def onJoin(self, details):

    50

        global _WampSession

    51

        _WampSession = self

    52

        _WampSessionEvent.set()

    53

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

    54

    55

    def onLeave(self, details):

    56

        global _WampSession

    57

        _WampSessionEvent.clear()

    58

        _WampSession = None

    59

        print('WAMP session left')

    60

    61

    62

PLCObjDefaults = {

    63

    "StartPLC":          False,

    64

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

    65

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

    66

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

    67

}

    68

    69

    70

def _WAMP_connector_factory(cls, uri, confnodesroot):

    71

    """

    72

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

    73

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

    74

    """

    75

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

    76

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

    77

    urlprefix = {"WAMP":  "ws",

    78

                 "WAMPS": "wss"}[scheme]

    79

    url = urlprefix+"://"+urlpath

    80

    81

    def RegisterWampClient():

    82

    83

        # start logging to console

    84

        # log.startLogging(sys.stdout)

    85

    86

        # create a WAMP application session factory

    87

        component_config = types.ComponentConfig(

    88

            realm=text(realm),

    89

            extra={"ID": ID})

    90

        session_factory = wamp.ApplicationSessionFactory(

    91

            config=component_config)

    92

        session_factory.session = cls

    93

    94

        # create a WAMP-over-WebSocket transport client factory

    95

        transport_factory = WampWebSocketClientFactory(

    96

            session_factory,

    97

            url=url,

    98

            serializers=[MsgPackSerializer()])

    99

   100

        # start the client from a Twisted endpoint

   101

        conn = connectWS(transport_factory)

   102

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

   103

        return conn

   104

   105

    AddToDoBeforeQuit = confnodesroot.AppFrame.AddToDoBeforeQuit

   106

   107

    def ThreadProc():

   108

        global _WampConnection

   109

        _WampConnection = RegisterWampClient()

   110

        AddToDoBeforeQuit(reactor.stop)

   111

        reactor.run(installSignalHandlers=False)

   112

   113

    def WampSessionProcMapper(funcname):

   114

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

   115

   116

        def catcher_func(*args, **kwargs):

   117

            if _WampSession is not None:

   118

                try:

   119

                    return threads.blockingCallFromThread(

   120

                        reactor, _WampSession.call, wampfuncname,

   121

                        *args, **kwargs)

   122

                except TransportLost:

   123

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

   124

                    confnodesroot._SetConnector(None)

   125

                except Exception:

   126

                    errmess = traceback.format_exc()

   127

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

   128

                    print(errmess)

   129

                    # confnodesroot._SetConnector(None)

   130

            return PLCObjDefaults.get(funcname)

   131

        return catcher_func

   132

   133

    class WampPLCObjectProxy(object):

   134

        def __init__(self):

   135

            global _WampConnection

   136

            if not reactor.running:

   137

                Thread(target=ThreadProc).start()

   138

            else:

   139

                _WampConnection = threads.blockingCallFromThread(

   140

                    reactor, RegisterWampClient)

   141

            if not _WampSessionEvent.wait(5):

   142

                _WampConnection.stopConnecting()

   143

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

   144

   145

        def __del__(self):

   146

            _WampConnection.disconnect()

   147

            #

   148

            # reactor.stop()

   149

   150

        def __getattr__(self, attrName):

   151

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

   152

            if member is None:

   153

                member = WampSessionProcMapper(attrName)

   154

                self.__dict__[attrName] = member

   155

            return member

   156

   157

    # TODO : GetPLCID()

   158

    # TODO : PSK.UpdateID()

   159

   160

    return WampPLCObjectProxy

   161

   162

   163

WAMP_connector_factory = partial(_WAMP_connector_factory, WampSession)