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

from autobahn.twisted import wamp

    30

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

    31

from autobahn.wamp import types, auth

    32

from autobahn.wamp.serializer import MsgPackSerializer

    33

from twisted.internet.defer import inlineCallbacks

    34

from twisted.internet.protocol import ReconnectingClientFactory

    35

    36

    37

_WampSession = None

    38

_PySrv = None

    39

    40

ExposedCalls = [

    41

    "StartPLC",

    42

    "StopPLC",

    43

    "ForceReload",

    44

    "GetPLCstatus",

    45

    "NewPLC",

    46

    "MatchMD5",

    47

    "SetTraceVariablesList",

    48

    "GetTraceVariables",

    49

    "RemoteExec",

    50

    "GetLogMessage",

    51

    "ResetLogCount",

    52

]

    53

    54

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

    55

# or User python code.

    56

    57

""" crossbar Events to register to """

    58

SubscribedEvents = []

    59

    60

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

    61

DoOnJoin = []

    62

    63

    64

def GetCallee(name):

    65

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

    66

    names = name.split('.')

    67

    obj = _PySrv.plcobj

    68

    while names:

    69

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

    70

    return obj

    71

    72

    73

class WampSession(wamp.ApplicationSession):

    74

    def onConnect(self):

    75

        if "secret" in self.config.extra:

    76

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

    77

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

    78

        else:

    79

            self.join(u"Automation")

    80

    81

    def onChallenge(self, challenge):

    82

        if challenge.method == u"wampcra":

    83

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

    84

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

    85

            return signature.decode("ascii")

    86

        else:

    87

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

    88

    89

    @inlineCallbacks

    90

    def onJoin(self, details):

    91

        global _WampSession

    92

        _WampSession = self

    93

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

    94

        print('WAMP session joined by :', ID)

    95

        for name in ExposedCalls:

    96

            regoption = types.RegisterOptions(u'exact', u'last', None, None)

    97

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

    98

    99

        for name in SubscribedEvents:

   100

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

   101

   102

        for func in DoOnJoin:

   103

            yield func(self)

   104

   105

    def onLeave(self, details):

   106

        global _WampSession

   107

        _WampSession = None

   108

        print(_('WAMP session left'))

   109

   110

   111

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

   112

    def clientConnectionFailed(self, connector, reason):

   113

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

   114

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   115

   116

    def clientConnectionLost(self, connector, reason):

   117

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

   118

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   119

   120

   121

def LoadWampClientConf(wampconf):

   122

    try:

   123

        WSClientConf = json.load(open(wampconf))

   124

        return WSClientConf

   125

    except ValueError, ve:

   126

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

   127

        return None

   128

    except Exception:

   129

        return None

   130

   131

   132

def LoadWampSecret(secretfname):

   133

    try:

   134

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

   135

        return WSClientWampSecret

   136

    except ValueError, ve:

   137

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

   138

        return None

   139

    except Exception:

   140

        return None

   141

   142

   143

def RegisterWampClient(wampconf, secretfname):

   144

   145

    WSClientConf = LoadWampClientConf(wampconf)

   146

   147

    if not WSClientConf:

   148

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

   149

        return

   150

   151

    WampSecret = LoadWampSecret(secretfname)

   152

   153

    if WampSecret is not None:

   154

        WSClientConf["secret"] = WampSecret

   155

   156

    # create a WAMP application session factory

   157

    component_config = types.ComponentConfig(

   158

        realm=WSClientConf["realm"],

   159

        extra=WSClientConf)

   160

    session_factory = wamp.ApplicationSessionFactory(

   161

        config=component_config)

   162

    session_factory.session = WampSession

   163

   164

    # create a WAMP-over-WebSocket transport client factory

   165

    transport_factory = ReconnectingWampWebSocketClientFactory(

   166

        session_factory,

   167

        url=WSClientConf["url"],

   168

        serializers=[MsgPackSerializer()])

   169

   170

    # start the client from a Twisted endpoint

   171

    conn = connectWS(transport_factory)

   172

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

   173

    return conn

   174

   175

   176

def GetSession():

   177

    return _WampSession

   178

   179

   180

def SetServer(pysrv):

   181

    global _PySrv

   182

    _PySrv = pysrv