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 json

    29

import os

    30

import json

    31

from autobahn.twisted import wamp

    32

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

    33

from autobahn.wamp import types, auth

    34

from autobahn.wamp.serializer import MsgPackSerializer

    35

from autobahn.wamp.exception import ApplicationError

    36

from twisted.internet.defer import inlineCallbacks

    37

from twisted.internet.protocol import ReconnectingClientFactory

    38

    39

    40

_WampSession = None

    41

_PySrv = None

    42

    43

ExposedCalls = [

    44

    "StartPLC",

    45

    "StopPLC",

    46

    "ForceReload",

    47

    "GetPLCstatus",

    48

    "NewPLC",

    49

    "MatchMD5",

    50

    "SetTraceVariablesList",

    51

    "GetTraceVariables",

    52

    "RemoteExec",

    53

    "GetLogMessage",

    54

    "ResetLogCount",

    55

]

    56

    57

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

    58

# or User python code. 

    59

    60

""" crossbar Events to register to """  

    61

SubscribedEvents = []

    62

    63

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

    64

DoOnJoin = []

    65

    66

    67

def GetCallee(name):

    68

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

    69

    names = name.split('.')

    70

    obj = _PySrv.plcobj

    71

    while names:

    72

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

    73

    return obj

    74

    75

    76

class WampSession(wamp.ApplicationSession):

    77

    def onConnect(self):

    78

        if self.config.extra.has_key("secret"):

    79

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

    80

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

    81

        else:

    82

            self.join(u"Automation")

    83

    84

    def onChallenge(self, challenge):

    85

        if challenge.method == u"wampcra":

    86

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

    87

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

    88

            return signature.decode("ascii")

    89

        else:

    90

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

    91

    92

    @inlineCallbacks

    93

    def onJoin(self, details):

    94

        global _WampSession

    95

        _WampSession = self

    96

        ID = self.config.extra["ID"] # this is unicode

    97

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

    98

        for name in ExposedCalls:

    99

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

   100

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

   101

   102

        for name in SubscribedEvents:

   103

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

   104

   105

        for func in DoOnJoin:

   106

            yield func(self)

   107

   108

    def onLeave(self, details):

   109

        global _WampSession

   110

        _WampSession = None

   111

        print(_('WAMP session left'))

   112

   113

   114

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

   115

    def clientConnectionFailed(self, connector, reason):

   117

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   118

   119

    def clientConnectionLost(self, connector, reason):

   121

        ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

   122

   123

   124

def LoadWampClientConf(wampconf):

   125

    try:

   126

        WSClientConf = json.load(open(wampconf))

   127

        return WSClientConf

   128

    except ValueError, ve:

   129

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

   130

        return None

   131

    except Exception:

   132

        return None

   133

   134

def LoadWampSecret(secretfname):

   135

    try:

   136

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

   137

        return WSClientWampSecret

   138

    except ValueError, ve:

   139

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

   140

        return None

   141

    except Exception:

   142

        return None

   143

   144

   145

def RegisterWampClient(wampconf, secretfname):

   146

   147

    WSClientConf = LoadWampClientConf(wampconf)

   148

   149

    if not WSClientConf:

   150

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

   151

        return

   152

   153

    WampSecret = LoadWampSecret(secretfname)

   154

   155

    # create a WAMP application session factory

   156

    component_config = types.ComponentConfig(

   157

        realm=WSClientConf["realm"],

   158

        extra=WSClientConf) # pass a dict containing unicode values

   159

    session_factory = wamp.ApplicationSessionFactory(

   160

        config=component_config)

   161

    session_factory.session = WampSession

   162

   163

    # create a WAMP-over-WebSocket transport client factory

   164

    transport_factory = ReconnectingWampWebSocketClientFactory(

   165

        session_factory,

   166

        url=WSClientConf["url"],

   167

        serializers=[MsgPackSerializer()])

   168

   169

    # start the client from a Twisted endpoint

   170

    conn = connectWS(transport_factory)

   171

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

   172

    return conn

   173

   174

   175

def GetSession():

   176

    return _WampSession

   177

   178

   179

def SetServer(pysrv):

   180

    global _PySrv

   181

    _PySrv = pysrv