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

    38

    39

_transportFactory = None

    40

_WampSession = None

    41

_PySrv = None

    42

_WampConf = None

    43

_WampSecret = None

    44

    45

ExposedCalls = [

    46

    ("StartPLC", {}),

    47

    ("StopPLC", {}),

    48

    ("ForceReload", {}),

    49

    ("GetPLCstatus", {}),

    50

    ("NewPLC", {}),

    51

    ("MatchMD5", {}),

    52

    ("SetTraceVariablesList", {}),

    53

    ("GetTraceVariables", {}),

    54

    ("RemoteExec", {}),

    55

    ("GetLogMessage", {}),

    56

    ("ResetLogCount", {})

    57

]

    58

    59

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

    60

# or User python code.

    61

    62

""" crossbar Events to register to """

    63

SubscribedEvents = []

    64

    65

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

    66

DoOnJoin = []

    67

    68

    69

def GetCallee(name):

    70

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

    71

    names = name.split('.')

    72

    obj = _PySrv.plcobj

    73

    while names:

    74

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

    75

    return obj

    76

    77

def getValidOptins(options, arguments):

    78

    validOptions = {}

    79

    for key in options:

    80

        if key in arguments:

    81

            validOptions[key] = options[key]

    82

    if len(validOptions) > 0:

    83

        return validOptions

    84

    else:

    85

        return None

    86

    87

class WampSession(wamp.ApplicationSession):

    88

    def onConnect(self):

    89

        if "secret" in self.config.extra:

    90

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

    91

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

    92

        else:

    93

            self.join(u"Automation")

    94

    95

    def onChallenge(self, challenge):

    96

        if challenge.method == u"wampcra":

    97

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

    98

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

    99

            return signature.decode("ascii")

   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

   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

   167

def GetConfiguration(items=None):

   168

    try:

   169

        WSClientConf = json.load(open(_WampConf))

   170

        if items and isinstance(items, list):

   171

            WSClientConfItems = {}

   172

            for item in items:

   173

                wampconf_value = WSClientConf.get(item, None)

   174

                if wampconf_value is not None:

   175

                    WSClientConfItems[item] = wampconf_value

   176

            if WSClientConfItems:

   177

                return WSClientConfItems

   178

        return WSClientConf

   179

    except ValueError, ve:

   180

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

   181

        return None

   182

    except Exception, e:

   183

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

   184

        return None

   185

   186

def SetConfiguration(items):

   187

    try:

   188

        WSClientConf = json.load(open(_WampConf))

   189

        saveChanges = False

   190

        if items:

   191

            for itemKey in items.keys():

   192

                wampconf_value = WSClientConf.get(itemKey, None)

   193

                if (wampconf_value is not None) and (items[itemKey] is not None) and (wampconf_value != items[itemKey]):

   194

                    WSClientConf[itemKey] = items[itemKey]

   195

                    saveChanges = True

   196

   197

        if saveChanges:

   198

            with open(os.path.realpath(_WampConf), 'w') as f:

   199

                json.dump(WSClientConf, f, sort_keys=True, indent=4)

   200

            if 'active' in WSClientConf and WSClientConf['active']:

   203

                StartReconnectWampClient()

   204

            else:

   205

                StopReconnectWampClient()

   206

   207

        return WSClientConf

   208

    except ValueError, ve:

   209

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

   210

        return None

   211

    except Exception, e:

   212

        print(_("WAMP save error: "), e)

   213

        return None

   214

   215

def LoadWampSecret(secretfname):

   216

    try:

   217

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

   218

        return WSClientWampSecret

   219

    except ValueError, ve:

   220

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

   221

        return None

   222

    except Exception:

   223

        return None

   224

   225

   226

def IsCorrectUri(uri):

   227

    if re.match(r'w{1}s{1,2}:{1}/{2}.+:{1}[0-9]+/{1}.+', uri):

   228

        return True

   229

    else:

   230

        return False

   231

   232

   233

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

   234

    global _WampConf

   235

    if wampconf:

   236

        _WampConf = wampconf

   237

        WSClientConf = GetConfiguration()

   238

    else:

   239

        WSClientConf = GetConfiguration()

   240

   241

    if not WSClientConf:

   242

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

   243

        return False

   244

   245

    if not IsCorrectUri(WSClientConf["url"]):

   246

        print(_("WAMP url {} is not correct!".format(WSClientConf["url"])))

   247

        return False

   248

   249

    if secretfname:

   250

        WampSecret = LoadWampSecret(secretfname)

   251

    else:

   252

        WampSecret = LoadWampSecret(_WampSecret)

   253

   254

    if WampSecret is not None:

   255

        WSClientConf["secret"] = WampSecret

   256

   257

    # create a WAMP application session factory

   258

    component_config = types.ComponentConfig(

   259

        realm=WSClientConf["realm"],

   260

        extra=WSClientConf)

   261

    session_factory = wamp.ApplicationSessionFactory(

   262

        config=component_config)

   263

    session_factory.session = WampSession

   264

   265

    # create a WAMP-over-WebSocket transport client factory

   267

        component_config,

   268

        session_factory,

   269

        url=WSClientConf["url"],

   270

        serializers=[MsgPackSerializer()])

   271

   272

    # start the client from a Twisted endpoint

   280

   281

   282

def StopReconnectWampClient():

   283

    _transportFactory.stopTrying()

   284

    return _WampSession.leave()

   285

   286

   287

def StartReconnectWampClient():

   288

    if _WampSession:

   289

        # do reconnect

   290

        _WampSession.disconnect()

   291

        return True

   292

    else:

   293

        # do connect

   294

        RegisterWampClient()

   295

        return True

   296

   297

   298

def GetSession():

   299

    return _WampSession

   300

   301

   302

def StatusWampClient():

   303

    return _WampSession and _WampSession.is_attached()

   304

   305

   306

def SetServer(pysrv, wampconf=None, wampsecret=None):

   307

    global _PySrv, _WampConf, _WampSecret

   308

    _PySrv = pysrv

   309

    _WampConf = wampconf

   310

    _WampSecret = wampsecret