1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz runtime.

     5

#

     6

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

     7

#

     8

# See COPYING.Runtime file for copyrights details.

     9

#

    10

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

    11

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

    12

# License as published by the Free Software Foundation; either

    13

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

    14

    15

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

    16

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

    17

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    18

# Lesser General Public License for more details.

    19

    20

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

    21

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

    22

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

    23

    24

    25

from __future__ import absolute_import

    26

from __future__ import print_function

    27

import time

    28

import json

    29

import inspect

    30

from autobahn.twisted import wamp

    31

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

    32

from autobahn.wamp import types, auth

    33

from autobahn.wamp.serializer import MsgPackSerializer

    34

from twisted.internet.defer import inlineCallbacks

    35

from twisted.internet.protocol import ReconnectingClientFactory

    36

    37

    38

_WampSession = None

    39

_PySrv = None

    40

    41

ExposedCalls = [

    42

    "StartPLC",

    43

    "StopPLC",

    44

    "ForceReload",

    45

    "GetPLCstatus",

    46

    "NewPLC",

    47

    "MatchMD5",

    48

    "SetTraceVariablesList",

    49

    "GetTraceVariables",

    50

    "RemoteExec",

    51

    "GetLogMessage",

    52

    "ResetLogCount",

    53

]

    54

    55

# Those two lists are meant to be filled by customized runtime

    56

# or User python code.

    57

    58

""" crossbar Events to register to """

    59

SubscribedEvents = []

    60

    61

""" things to do on join (callables) """

    62

DoOnJoin = []

    63

    64

    65

def GetCallee(name):

    66

    """ Get Callee or Subscriber corresponding to '.' spearated object path """

    67

    names = name.split('.')

    68

    obj = _PySrv.plcobj

    69

    while names:

    70

        obj = getattr(obj, names.pop(0))

    71

    return obj

    72

    82

    83

class WampSession(wamp.ApplicationSession):

    84

    def onConnect(self):

    85

        if "secret" in self.config.extra:

    86

            user = self.config.extra["ID"]

    87

            self.join(u"Automation", [u"wampcra"], user)

    88

        else:

    89

            self.join(u"Automation")

    90

    91

    def onChallenge(self, challenge):

    92

        if challenge.method == u"wampcra":

    93

            secret = self.config.extra["secret"].encode('utf8')

    94

            signature = auth.compute_wcs(secret, challenge.extra['challenge'].encode('utf8'))

    95

            return signature.decode("ascii")

    96

        else:

    97

            raise Exception("don't know how to handle authmethod {}".format(challenge.method))

    98

    99

    @inlineCallbacks

   100

    def onJoin(self, details):

   101

        global _WampSession

   102

        _WampSession = self

   103

        ID = self.config.extra["ID"]

   113

        for name in ExposedCalls:

   114

            yield self.register(GetCallee(name), u'.'.join((ID, name)), regoption)

   115

   116

        for name in SubscribedEvents:

   117

            yield self.subscribe(GetCallee(name), unicode(name))

   118

   119

        for func in DoOnJoin:

   120

            yield func(self)

   121

   122

        print(_('WAMP session joined (%s) by:' % time.ctime()), ID)

   123

   124

    def onLeave(self, details):

   125

        global _WampSession

   126

        _WampSession = None

   127

        print(_('WAMP session left'))

   128

   129

   130

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

   131

    def __init__(self, config, *args, **kwargs):

   132

        WampWebSocketClientFactory.__init__(self, *args, **kwargs)

   133

   135

        arguments = inspect.getargspec(self.setProtocolOptions).args

   138

            self.setProtocolOptions(**validProtocolOptions)

   140

   141

    def buildProtocol(self, addr):

   142

        self.resetDelay()

   143

        return ReconnectingClientFactory.buildProtocol(self, addr)

   144

   145

    def clientConnectionFailed(self, connector, reason):

   146

        print(_("WAMP Client connection failed (%s) .. retrying .." % time.ctime()))

   147

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   148

   149

    def clientConnectionLost(self, connector, reason):

   150

        print(_("WAMP Client connection lost (%s) .. retrying .." % time.ctime()))

   151

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   152

   153

   154

def LoadWampClientConf(wampconf):

   155

    try:

   156

        WSClientConf = json.load(open(wampconf))

   157

        return WSClientConf

   158

    except ValueError, ve:

   159

        print(_("WAMP load error: "), ve)

   160

        return None

   161

    except Exception:

   162

        return None

   163

   164

   165

def LoadWampSecret(secretfname):

   166

    try:

   167

        WSClientWampSecret = open(secretfname, 'rb').read()

   168

        return WSClientWampSecret

   169

    except ValueError, ve:

   170

        print(_("Wamp secret load error:"), ve)

   171

        return None

   172

    except Exception:

   173

        return None

   174

   175

   176

def RegisterWampClient(wampconf, secretfname):

   177

   178

    WSClientConf = LoadWampClientConf(wampconf)

   179

   180

    if not WSClientConf:

   181

        print(_("WAMP client connection not established!"))

   182

        return

   183

   184

    WampSecret = LoadWampSecret(secretfname)

   185

   186

    if WampSecret is not None:

   187

        WSClientConf["secret"] = WampSecret

   188

   189

    # create a WAMP application session factory

   190

    component_config = types.ComponentConfig(

   191

        realm=WSClientConf["realm"],

   192

        extra=WSClientConf)

   193

    session_factory = wamp.ApplicationSessionFactory(

   194

        config=component_config)

   195

    session_factory.session = WampSession

   196

   197

    # create a WAMP-over-WebSocket transport client factory

   198

    transport_factory = ReconnectingWampWebSocketClientFactory(

   199

        component_config,

   200

        session_factory,

   201

        url=WSClientConf["url"],

   202

        serializers=[MsgPackSerializer()])

   203

   204

    # start the client from a Twisted endpoint

   205

    conn = connectWS(transport_factory)

   206

    print(_("WAMP client connecting to :"), WSClientConf["url"])

   207

    return conn

   208

   209

   210

def GetSession():

   211

    return _WampSession

   212

   213

   214

def SetServer(pysrv):

   215

    global _PySrv

   216

    _PySrv = pysrv