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

import sys

    27

import traceback

    28

from functools import partial

    29

from threading import Thread, Event

    30

    31

from twisted.internet import reactor, threads

    32

from autobahn.twisted import wamp

    33

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

    34

from autobahn.wamp import types

    35

from autobahn.wamp.exception import TransportLost

    36

from autobahn.wamp.serializer import MsgPackSerializer

    37

    38

from runtime import PlcStatus

    39

    40

_WampSession = None

    41

_WampConnection = None

    42

_WampSessionEvent = Event()

    43

    44

    45

class WampSession(wamp.ApplicationSession):

    46

    def onJoin(self, details):

    47

        global _WampSession

    48

        _WampSession = self

    49

        _WampSessionEvent.set()

    50

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

    51

    52

    def onLeave(self, details):

    53

        global _WampSession

    54

        _WampSessionEvent.clear()

    55

        _WampSession = None

    56

        print('WAMP session left')

    57

    58

    59

PLCObjDefaults = {

    60

    "StartPLC":          False,

    61

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

    62

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

    63

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

    64

}

    65

    66

    67

def _WAMP_connector_factory(cls, uri, confnodesroot):

    68

    """

    69

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

    70

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

    71

    """

    72

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

    73

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

    74

    urlprefix = {"WAMP":  "ws",

    75

                 "WAMPS": "wss"}[scheme]

    76

    url = urlprefix+"://"+urlpath

    77

    78

    def RegisterWampClient():

    79

    80

        # start logging to console

    81

        # log.startLogging(sys.stdout)

    82

    83

        # create a WAMP application session factory

    84

        component_config = types.ComponentConfig(

    85

            realm=str(realm),

    86

            extra={"ID": ID})

    87

        session_factory = wamp.ApplicationSessionFactory(

    88

            config=component_config)

    89

        session_factory.session = cls

    90

    91

        # create a WAMP-over-WebSocket transport client factory

    92

        transport_factory = WampWebSocketClientFactory(

    93

            session_factory,

    94

            url=url,

    95

            serializers=[MsgPackSerializer()])

    96

    97

        # start the client from a Twisted endpoint

    98

        conn = connectWS(transport_factory)

    99

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

   100

        return conn

   101

   102

    AddToDoBeforeQuit = confnodesroot.AppFrame.AddToDoBeforeQuit

   103

   104

    def ThreadProc():

   105

        global _WampConnection

   106

        _WampConnection = RegisterWampClient()

   107

        AddToDoBeforeQuit(reactor.stop)

   108

        reactor.run(installSignalHandlers=False)

   109

   110

    def WampSessionProcMapper(funcname):

   111

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

   112

   113

        def catcher_func(*args, **kwargs):

   114

            if _WampSession is not None:

   115

                try:

   116

                    return threads.blockingCallFromThread(

   117

                        reactor, _WampSession.call, wampfuncname,

   118

                        *args, **kwargs)

   119

                except TransportLost:

   120

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

   121

                    confnodesroot._SetConnector(None)

   122

                except Exception:

   123

                    errmess = traceback.format_exc()

   124

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

   125

                    print(errmess)

   126

                    # confnodesroot._SetConnector(None)

   127

            return PLCObjDefaults.get(funcname)

   128

        return catcher_func

   129

   130

    class WampPLCObjectProxy(object):

   131

        def __init__(self):

   132

            global _WampConnection

   133

            if not reactor.running:

   134

                Thread(target=ThreadProc).start()

   135

            else:

   136

                _WampConnection = threads.blockingCallFromThread(

   137

                    reactor, RegisterWampClient)

   138

            if not _WampSessionEvent.wait(5):

   139

                _WampConnection.stopConnecting()

   140

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

   141

   142

        def __del__(self):

   143

            _WampConnection.disconnect()

   144

            #

   145

            # reactor.stop()

   146

   147

        def __getattr__(self, attrName):

   148

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

   149

            if member is None:

   150

                member = WampSessionProcMapper(attrName)

   151

                self.__dict__[attrName] = member

   152

            return member

   153

   154

    # TODO : GetPLCID()

   155

    # TODO : PSK.UpdateID()

   156

   157

    return WampPLCObjectProxy

   158

   159

   160

WAMP_connector_factory = partial(_WAMP_connector_factory, WampSession)