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 os

    30

import re

    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 twisted.internet.defer import inlineCallbacks

    36

from twisted.internet.protocol import ReconnectingClientFactory

    37

    41

    42

mandatoryConfigItems = ["ID", "active", "realm", "url"]

    43

    44

_transportFactory = None

    45

_WampSession = None

    46

_PySrv = None

    47

_WampConf = None

    48

_WampSecret = None

    49

    50

ExposedCalls = [

    51

    ("StartPLC", {}),

    52

    ("StopPLC", {}),

    53

    ("ForceReload", {}),

    54

    ("GetPLCstatus", {}),

    55

    ("NewPLC", {}),

    56

    ("MatchMD5", {}),

    57

    ("SetTraceVariablesList", {}),

    58

    ("GetTraceVariables", {}),

    59

    ("RemoteExec", {}),

    60

    ("GetLogMessage", {}),

    61

    ("ResetLogCount", {})

    62

]

    63

    64

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

    65

# or User python code.

    66

    67

""" crossbar Events to register to """

    68

SubscribedEvents = []

    69

    70

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

    71

DoOnJoin = []

    72

    74

    75

def GetCallee(name):

    76

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

    77

    names = name.split('.')

    78

    obj = _PySrv.plcobj

    79

    while names:

    80

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

    81

    return obj

    82

    83

    84

class WampSession(wamp.ApplicationSession):

    85

    def onConnect(self):

    86

        if "secret" in self.config.extra:

    87

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

    88

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

    89

        else:

    90

            self.join(u"Automation")

    91

    92

    def onChallenge(self, challenge):

    93

        if challenge.method == u"wampcra":

   100

        else:

   101

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

   102

   103

    @inlineCallbacks

   104

    def onJoin(self, details):

   105

        global _WampSession

   106

        _WampSession = self

   107

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

   108

   109

        for name, kwargs in ExposedCalls:

   110

            try:

   111

                registerOptions = types.RegisterOptions(**kwargs)

   112

            except TypeError as e:

   113

                registerOptions = None

   114

                print(_("TypeError register option: {}".format(e)))

   115

   116

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

   117

   118

        for name in SubscribedEvents:

   119

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

   120

   121

        for func in DoOnJoin:

   122

            yield func(self)

   123

   124

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

   125

   126

    def onLeave(self, details):

   127

        global _WampSession, _transportFactory

   128

        super(WampSession, self).onLeave(details)

   129

        _WampSession = None

   130

        _transportFactory = None

   131

        print(_('WAMP session left'))

   132

   133

   134

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

   135

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

   136

        global _transportFactory

   137

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

   138

   139

        try:

   140

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

   141

            if protocolOptions:

   142

                self.setProtocolOptions(**protocolOptions)

   143

            _transportFactory = self

   144

        except Exception, e:

   145

            print(_("Custom protocol options failed :"), e)

   146

            _transportFactory = None

   147

   148

    def buildProtocol(self, addr):

   149

        self.resetDelay()

   150

        return ReconnectingClientFactory.buildProtocol(self, addr)

   151

   152

    def clientConnectionFailed(self, connector, reason):

   153

        if self.continueTrying:

   154

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

   155

            super(ReconnectingWampWebSocketClientFactory, self).clientConnectionFailed(connector, reason)

   156

        else:

   157

            del connector

   158

   159

    def clientConnectionLost(self, connector, reason):

   160

        if self.continueTrying:

   161

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

   162

            super(ReconnectingWampWebSocketClientFactory, self).clientConnectionFailed(connector, reason)

   163

        else:

   164

            del connector

   165

   166

   174

def GetConfiguration():

   177

    WSClientConf = json.load(open(_WampConf))

   178

    for itemName in mandatoryConfigItems:

   179

        if WSClientConf.get(itemName, None) is None :

   180

            raise Exception(_("WAMP configuration error : missing '{}' parameter.").format(itemName))

   181

   185

    return WSClientConf

   186

   187

   188

def SetConfiguration(WSClientConf):

   199

            StopReconnectWampClient()

   205

   206

   207

def LoadWampSecret(secretfname):

   212

   213

   214

def IsCorrectUri(uri):

   216

   217

   218

def RegisterWampClient(wampconf=None, wampsecret=None):

   219

    global _WampConf, _WampSecret

   220

    if wampsecret:

   221

        _WampSecret = wampsecret

   222

    if wampconf:

   223

        _WampConf = wampconf

   224

   225

    WSClientConf = GetConfiguration()

   226

   227

    if not WSClientConf["active"]:

   228

        print(_("WAMP deactivated in configuration"))

   229

        return

   230

   233

   234

    # create a WAMP application session factory

   235

    component_config = types.ComponentConfig(

   236

        realm=WSClientConf["realm"],

   237

        extra=WSClientConf)

   238

    session_factory = wamp.ApplicationSessionFactory(

   239

        config=component_config)

   240

    session_factory.session = WampSession

   241

   242

    # create a WAMP-over-WebSocket transport client factory

   243

    ReconnectingWampWebSocketClientFactory(

   244

        component_config,

   245

        session_factory,

   246

        url=WSClientConf["url"],

   247

        serializers=[MsgPackSerializer()])

   248

   249

    # start the client from a Twisted endpoint

   250

    if _transportFactory:

   251

        conn = connectWS(_transportFactory)

   252

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

   253

        return True

   254

    else:

   255

        print(_("WAMP client can not connect to :"), WSClientConf["url"])

   256

        return False

   257

   258

   259

def StopReconnectWampClient():

   264

   265

   266

def StartReconnectWampClient():

   267

    if _WampSession:

   268

        # do reconnect

   269

        _WampSession.disconnect()

   270

        return True

   271

    else:

   272

        # do connect

   273

        RegisterWampClient()

   274

        return True

   275

   276

   277

def GetSession():

   278

    return _WampSession

   279

   288

   289

   290

def SetServer(pysrv):

   291

    _PySrv = pysrv