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

    73

def getValidOptins(options, arguments):

    74

    validOptions = {}

    75

    for key in options:

    76

        if key in arguments:

    77

            validOptions[key] = options[key]

    78

    if len(validOptions) > 0:

    79

        return validOptions

    80

    else:

    81

        return None

    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"]

   104

   105

        registerOptions = self.config.extra.get('registerOptions', None)

   106

        arguments = inspect.getargspec(types.RegisterOptions.__init__).args

   107

        validRegisterOptions = getValidOptins(registerOptions, arguments)

   108

        if validRegisterOptions:

   110

            #print(_("Added custom register options"))

   111

   112

        for name in ExposedCalls:

   114

   115

        for name in SubscribedEvents:

   116

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

   117

   118

        for func in DoOnJoin:

   119

            yield func(self)

   120

   121

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

   122

   123

    def onLeave(self, details):

   124

        global _WampSession

   125

        _WampSession = None

   126

        print(_('WAMP session left'))

   127

   128

   129

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

   130

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

   131

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

   132

   133

        protocolOptions = config.extra.get('protocolOptions', None)

   134

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

   135

        validProtocolOptions = getValidOptins(protocolOptions, arguments)

   136

        if validProtocolOptions:

   137

            self.setProtocolOptions(**validProtocolOptions)

   138

            #print(_("Added custom protocol options"))

   139

   140

    def buildProtocol(self, addr):

   141

        self.resetDelay()

   142

        return ReconnectingClientFactory.buildProtocol(self, addr)

   143

   144

    def clientConnectionFailed(self, connector, reason):

   145

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

   146

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   147

   148

    def clientConnectionLost(self, connector, reason):

   149

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

   150

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   151

   152

   153

def LoadWampClientConf(wampconf):

   154

    try:

   155

        WSClientConf = json.load(open(wampconf))

   156

        return WSClientConf

   157

    except ValueError, ve:

   158

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

   159

        return None

   160

    except Exception:

   161

        return None

   162

   163

   164

def LoadWampSecret(secretfname):

   165

    try:

   166

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

   167

        return WSClientWampSecret

   168

    except ValueError, ve:

   169

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

   170

        return None

   171

    except Exception:

   172

        return None

   173

   174

   175

def RegisterWampClient(wampconf, secretfname):

   176

   177

    WSClientConf = LoadWampClientConf(wampconf)

   178

   179

    if not WSClientConf:

   180

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

   181

        return

   182

   183

    WampSecret = LoadWampSecret(secretfname)

   184

   185

    if WampSecret is not None:

   186

        WSClientConf["secret"] = WampSecret

   187

   188

    # create a WAMP application session factory

   189

    component_config = types.ComponentConfig(

   190

        realm=WSClientConf["realm"],

   191

        extra=WSClientConf)

   192

    session_factory = wamp.ApplicationSessionFactory(

   193

        config=component_config)

   194

    session_factory.session = WampSession

   195

   196

    # create a WAMP-over-WebSocket transport client factory

   197

    transport_factory = ReconnectingWampWebSocketClientFactory(

   198

        component_config,

   199

        session_factory,

   200

        url=WSClientConf["url"],

   201

        serializers=[MsgPackSerializer()])

   202

   203

    # start the client from a Twisted endpoint

   204

    conn = connectWS(transport_factory)

   205

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

   206

    return conn

   207

   208

   209

def GetSession():

   210

    return _WampSession

   211

   212

   213

def SetServer(pysrv):

   214

    global _PySrv

   215

    _PySrv = pysrv