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

    38

    39

import runtime.NevowServer as NS

    40

    44

    45

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

    46

    47

_transportFactory = None

    48

_WampSession = None

    49

_PySrv = None

    53

_WampConf = None

    54

_WampSecret = None

    55

    56

ExposedCalls = [

    57

    ("StartPLC", {}),

    58

    ("StopPLC", {}),

    59

    ("ForceReload", {}),

    60

    ("GetPLCstatus", {}),

    61

    ("NewPLC", {}),

    62

    ("MatchMD5", {}),

    63

    ("SetTraceVariablesList", {}),

    64

    ("GetTraceVariables", {}),

    65

    ("RemoteExec", {}),

    66

    ("GetLogMessage", {}),

    67

    ("ResetLogCount", {})

    68

]

    69

    78

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

    79

# or User python code.

    80

    81

""" crossbar Events to register to """

    82

SubscribedEvents = []

    83

    84

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

    85

DoOnJoin = []

    86

    87

lastKnownConfig = None

    88

    89

def GetCallee(name):

    90

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

    91

    names = name.split('.')

    92

    obj = _PySrv.plcobj

    93

    while names:

    94

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

    95

    return obj

    96

    97

    98

class WampSession(wamp.ApplicationSession):

    99

    def onConnect(self):

   100

        if "secret" in self.config.extra:

   101

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

   102

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

   103

        else:

   104

            self.join(u"Automation")

   105

   106

    def onChallenge(self, challenge):

   107

        if challenge.method == u"wampcra":

   108

            if "secret" in self.config.extra:

   109

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

   110

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

   111

                return signature.decode("ascii")

   112

            else:

   113

                raise Exception("no secret given for authentication")

   114

        else:

   115

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

   116

   117

    @inlineCallbacks

   118

    def onJoin(self, details):

   119

        global _WampSession

   120

        _WampSession = self

   121

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

   122

   123

        for name, kwargs in ExposedCalls:

   124

            try:

   125

                registerOptions = types.RegisterOptions(**kwargs)

   126

            except TypeError as e:

   127

                registerOptions = None

   128

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

   129

   130

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

   131

   132

        for name in SubscribedEvents:

   133

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

   134

   135

        for func in DoOnJoin:

   136

            yield func(self)

   137

   138

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

   139

   140

    def onLeave(self, details):

   141

        global _WampSession, _transportFactory

   142

        super(WampSession, self).onLeave(details)

   143

        _WampSession = None

   144

        _transportFactory = None

   145

        print(_('WAMP session left'))

   146

   147

   148

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

   149

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

   150

        global _transportFactory

   151

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

   152

   153

        try:

   154

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

   155

            if protocolOptions:

   156

                self.setProtocolOptions(**protocolOptions)

   157

            _transportFactory = self

   158

        except Exception, e:

   159

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

   160

            _transportFactory = None

   161

   162

    def buildProtocol(self, addr):

   163

        self.resetDelay()

   164

        return ReconnectingClientFactory.buildProtocol(self, addr)

   165

   166

    def clientConnectionFailed(self, connector, reason):

   167

        if self.continueTrying:

   168

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

   169

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

   170

        else:

   171

            del connector

   172

   173

    def clientConnectionLost(self, connector, reason):

   174

        if self.continueTrying:

   175

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

   176

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

   177

        else:

   178

            del connector

   179

   180

   183

    if not IsCorrectUri(url):

   184

        raise annotate.ValidateError(

   185

            {"url":"Invalid URL: {}".format(url)},

   186

            _("WAMP confiuration error:"))

   187

   188

def GetConfiguration():

   189

    global lastKnownConfig

   190

   196

    for itemName in mandatoryConfigItems:

   198

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

   199

   211

    global lastKnownConfig

   212

   216

   217

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

   220

        if _transportFactory and _WampSession:

   221

            StopReconnectWampClient()

   222

        StartReconnectWampClient()

   223

    else:

   224

        StopReconnectWampClient()

   225

   227

   228

   229

def LoadWampSecret(secretfname):

   230

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

   231

    if len(WSClientWampSecret) == 0 :

   232

        raise Exception(_("WAMP secret empty"))

   233

    return WSClientWampSecret

   234

   235

   236

def IsCorrectUri(uri):

   237

    return re.match(r'wss?://[^\s?:#-]+(:[0-9]+)?(/[^\s]*)?$', uri) is not None

   238

   239

   240

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

   241

    global _WampConf, _WampSecret

   255

        _WampSecret = wampsecret

   264

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

   265

        return

   266

   267

    # create a WAMP application session factory

   268

    component_config = types.ComponentConfig(

   271

    session_factory = wamp.ApplicationSessionFactory(

   272

        config=component_config)

   273

    session_factory.session = WampSession

   274

   275

    # create a WAMP-over-WebSocket transport client factory

   276

    ReconnectingWampWebSocketClientFactory(

   277

        component_config,

   278

        session_factory,

   280

        serializers=[MsgPackSerializer()])

   281

   282

    # start the client from a Twisted endpoint

   283

    if _transportFactory:

   284

        conn = connectWS(_transportFactory)

   286

        return True

   287

    else:

   289

        return False

   290

   291

   292

def StopReconnectWampClient():

   293

    if _transportFactory is not None :

   294

        _transportFactory.stopTrying()

   295

    if _WampSession is not None :

   296

        _WampSession.leave()

   297

   298

   299

def StartReconnectWampClient():

   300

    if _WampSession:

   301

        # do reconnect

   302

        _WampSession.disconnect()

   303

        return True

   304

    else:

   305

        # do connect

   306

        RegisterWampClient()

   307

        return True

   308

   309

   310

def GetSession():

   311

    return _WampSession

   312

   313

def getWampStatus():

   314

    if _transportFactory is not None :

   315

        if _WampSession is not None :

   316

            if _WampSession.is_attached() :

   317

                return "Attached"

   318

            return "Established"

   319

        return "Connecting"

   320

    return "Disconnected"

   321

   322

   323

def SetServer(pysrv):

   324

    _PySrv = pysrv

   325

   326

   327

#### WEB CONFIGURATION INTERFACE ####

   329

webExposedConfigItems = ['active', 'url', 'ID']

   330

   331

def wampConfigDefault(ctx,argument):

   332

    if lastKnownConfig is not None :

   333

        return lastKnownConfig.get(argument.name, None)

   334

   335

def wampConfig(**kwargs):

   341

    newConfig = lastKnownConfig.copy()

   342

    for argname in webExposedConfigItems:

   343

        newConfig[argname] = kwargs[argname]

   344

   345

    SetConfiguration(newConfig)

   346

   367

webFormInterface = [

   368

    ("status",

   369

       annotate.String(label=_("Current status"),

   370

                       immutable = True,

   371

                       default = lambda *k:getWampStatus())),

   372

    ("ID",

   373

       annotate.String(label=_("ID"),

   374

                       default = wampConfigDefault)),

   380

    ("active",

   381

       annotate.Boolean(label=_("Enable WAMP connection"),

   382

                        default=wampConfigDefault)),

   383

    ("url",

   384

       annotate.String(label=_("WAMP Server URL"),

   385

                       default=wampConfigDefault))]

   386

   387

   388

NS.ConfigurableSettings.addExtension(

   389

    "wamp", 

   390

    _("Wamp Settings"),

   391

    webFormInterface,

   392

    _("Set"),

   393

    wampConfig)