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.protocol import ReconnectingClientFactory

    36

from twisted.python.components import registerAdapter

    37

    38

from formless import annotate, webform

    39

import formless

    40

from nevow import tags, url, static

    41

from runtime import GetPLCObjectSingleton

    42

    43

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

    44

    45

_transportFactory = None

    46

_WampSession = None

    47

_PySrv = None

    48

WorkingDir = None

    49

    50

# Find pre-existing project WAMP config file

    51

_WampConf = None

    52

_WampSecret = None

    53

    54

ExposedCalls = [

    55

    ("StartPLC", {}),

    56

    ("StopPLC", {}),

    57

    ("GetPLCstatus", {}),

    58

    ("NewPLC", {}),

    59

    ("MatchMD5", {}),

    60

    ("SetTraceVariablesList", {}),

    61

    ("GetTraceVariables", {}),

    62

    ("RemoteExec", {}),

    63

    ("GetLogMessage", {}),

    64

    ("ResetLogCount", {})

    65

]

    66

    67

# de-activated dumb wamp config

    68

defaultWampConfig = {

    69

    "ID": "wamptest",

    70

    "active": False,

    71

    "realm": "Automation",

    72

    "url": "ws://127.0.0.1:8888"

    73

}

    74

    75

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

    76

# or User python code.

    77

    78

""" crossbar Events to register to """

    79

SubscribedEvents = []

    80

    81

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

    82

DoOnJoin = []

    83

    84

lastKnownConfig = None

    85

    86

    87

def GetCallee(name):

    88

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

    89

    names = name.split('.')

    90

    obj = GetPLCObjectSingleton()

    91

    while names:

    92

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

    93

    return obj

    94

    95

    96

class WampSession(wamp.ApplicationSession):

    97

    98

    def onConnect(self):

    99

        if "secret" in self.config.extra:

   100

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

   101

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

   102

        else:

   103

            self.join(u"Automation")

   104

   105

    def onChallenge(self, challenge):

   106

        if challenge.method == u"wampcra":

   107

            if "secret" in self.config.extra:

   108

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

   109

                signature = auth.compute_wcs(

   110

                    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(

   116

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

   117

   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

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

   131

   132

        for name in SubscribedEvents:

   133

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

   134

   135

        for func in DoOnJoin:

   136

            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

    def publishWithOwnID(self, eventID, value):

   148

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

   149

        self.publish(unicode(ID+'.'+eventID), value)

   150

   151

   152

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

   153

   154

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

   155

        global _transportFactory

   156

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

   157

   158

        try:

   159

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

   160

            if protocolOptions:

   161

                self.setProtocolOptions(**protocolOptions)

   162

            _transportFactory = self

   163

        except Exception, e:

   164

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

   165

            _transportFactory = None

   166

   167

    def buildProtocol(self, addr):

   168

        self.resetDelay()

   169

        return ReconnectingClientFactory.buildProtocol(self, addr)

   170

   171

    def clientConnectionFailed(self, connector, reason):

   172

        if self.continueTrying:

   173

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

   174

                  time.ctime())

   175

            super(ReconnectingWampWebSocketClientFactory,

   176

                  self).clientConnectionFailed(connector, reason)

   177

        else:

   178

            del connector

   179

   180

    def clientConnectionLost(self, connector, reason):

   181

        if self.continueTrying:

   182

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

   183

                  time.ctime())

   184

            super(ReconnectingWampWebSocketClientFactory,

   185

                  self).clientConnectionFailed(connector, reason)

   186

        else:

   187

            del connector

   188

   189

   190

def CheckConfiguration(WampClientConf):

   191

    url = WampClientConf["url"]

   192

    if not IsCorrectUri(url):

   193

        raise annotate.ValidateError(

   194

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

   195

            _("WAMP configuration error:"))

   196

   197

   198

def GetConfiguration():

   199

    global lastKnownConfig

   200

   201

    if os.path.exists(_WampConf):

   202

        WampClientConf = json.load(open(_WampConf))

   203

    else:

   204

        WampClientConf = defaultWampConfig.copy()

   205

   206

    for itemName in mandatoryConfigItems:

   207

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

   208

            raise Exception(

   209

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

   210

   211

    CheckConfiguration(WampClientConf)

   212

   213

    lastKnownConfig = WampClientConf.copy()

   214

    return WampClientConf

   215

   216

   217

def SetWampSecret(wampSecret):

   218

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

   219

        f.write(wampSecret)

   220

   221

   222

def SetConfiguration(WampClientConf):

   223

    global lastKnownConfig

   224

   225

    CheckConfiguration(WampClientConf)

   226

   227

    lastKnownConfig = WampClientConf.copy()

   228

   229

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

   230

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

   231

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

   232

        if _transportFactory and _WampSession:

   233

            StopReconnectWampClient()

   234

        StartReconnectWampClient()

   235

    else:

   236

        StopReconnectWampClient()

   237

   238

    return WampClientConf

   239

   240

   241

def LoadWampSecret(secretfname):

   242

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

   243

    if len(WSClientWampSecret) == 0:

   244

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

   245

    return WSClientWampSecret

   246

   247

   248

def IsCorrectUri(uri):

   249

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

   250

   251

   252

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

   253

    global _WampConf, _WampSecret

   254

    _WampConfDefault = os.path.join(WorkingDir, "wampconf.json")

   255

    _WampSecretDefault = os.path.join(WorkingDir, "wamp.secret")

   256

   257

    # set config file path only if not already set

   258

    if _WampConf is None:

   259

        # default project's wampconf has precedance over commandline given

   260

        if os.path.exists(_WampConfDefault) or wampconf is None:

   261

            _WampConf = _WampConfDefault

   262

        else:

   263

            _WampConf = wampconf

   264

   265

    WampClientConf = GetConfiguration()

   266

   267

    # set secret file path only if not already set

   268

    if _WampSecret is None:

   269

        # default project's wamp secret also

   270

        # has precedance over commandline given

   271

        if os.path.exists(_WampSecretDefault):

   272

            _WampSecret = _WampSecretDefault

   273

        else:

   274

            _WampSecret = wampsecret

   275

   276

    if _WampSecret is not None:

   277

        WampClientConf["secret"] = LoadWampSecret(_WampSecret)

   278

    else:

   279

        print(_("WAMP authentication has no secret configured"))

   280

        _WampSecret = _WampSecretDefault

   281

   282

    if not WampClientConf["active"]:

   283

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

   284

        return

   285

   286

    # create a WAMP application session factory

   287

    component_config = types.ComponentConfig(

   288

        realm=WampClientConf["realm"],

   289

        extra=WampClientConf)

   290

    session_factory = wamp.ApplicationSessionFactory(

   291

        config=component_config)

   292

    session_factory.session = WampSession

   293

   294

    # create a WAMP-over-WebSocket transport client factory

   295

    ReconnectingWampWebSocketClientFactory(

   296

        component_config,

   297

        session_factory,

   298

        url=WampClientConf["url"],

   299

        serializers=[MsgPackSerializer()])

   300

   301

    # start the client from a Twisted endpoint

   302

    if _transportFactory:

   303

        connectWS(_transportFactory)

   304

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

   305

        return True

   306

    else:

   307

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

   308

        return False

   309

   310

   311

def StopReconnectWampClient():

   312

    if _transportFactory is not None:

   313

        _transportFactory.stopTrying()

   314

    if _WampSession is not None:

   315

        _WampSession.leave()

   316

   317

   318

def StartReconnectWampClient():

   319

    if _WampSession:

   320

        # do reconnect

   321

        _WampSession.disconnect()

   322

        return True

   323

    else:

   324

        # do connect

   325

        RegisterWampClient()

   326

        return True

   327

   328

   329

def GetSession():

   330

    return _WampSession

   331

   332

   333

def getWampStatus():

   334

    if _transportFactory is not None:

   335

        if _WampSession is not None:

   336

            if _WampSession.is_attached():

   337

                return "Attached"

   338

            return "Established"

   339

        return "Connecting"

   340

    return "Disconnected"

   341

   342

   343

def SetServer(pysrv):

   344

    global _PySrv

   345

    _PySrv = pysrv

   346

   347

   348

def PublishEvent(eventID, value):

   349

    if getWampStatus() == "Attached":

   350

        _WampSession.publish(eventID, value)

   351

   352

   353

def PublishEventWithOwnID(eventID, value):

   354

    if getWampStatus() == "Attached":

   355

        _WampSession.publishWithOwnID(eventID, value)

   356

   357

   358

# WEB CONFIGURATION INTERFACE

   359

WAMP_SECRET_URL = "secret"

   360

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

   361

   362

   363

def wampConfigDefault(ctx, argument):

   364

    if lastKnownConfig is not None:

   365

        return lastKnownConfig.get(argument.name, None)

   366

   367

   368

def wampConfig(**kwargs):

   369

    secretfile_field = kwargs["secretfile"]

   370

    if secretfile_field is not None:

   371

        secretfile = getattr(secretfile_field, "file", None)

   372

        if secretfile is not None:

   373

            secret = secretfile_field.file.read()

   374

            SetWampSecret(secret)

   375

   376

    newConfig = lastKnownConfig.copy()

   377

    for argname in webExposedConfigItems:

   378

        arg = kwargs.get(argname, None)

   379

        if arg is not None:

   380

            newConfig[argname] = arg

   381

   382

    SetConfiguration(newConfig)

   383

   384

   385

class FileUploadDownload(annotate.FileUpload):

   386

    pass

   387

   388

   389

class FileUploadDownloadRenderer(webform.FileUploadRenderer):

   390

   391

    def input(self, context, slot, data, name, value):

   392

        # pylint: disable=expression-not-assigned

   393

        slot[_("Upload:")]

   394

        slot = webform.FileUploadRenderer.input(

   395

            self, context, slot, data, name, value)

   396

        download_url = data.typedValue.getAttribute('download_url')

   397

        return slot[tags.a(href=download_url)[_("Download")]]

   398

   399

   400

registerAdapter(FileUploadDownloadRenderer, FileUploadDownload,

   401

                formless.iformless.ITypedRenderer)

   402

   403

   404

def getDownloadUrl(ctx, argument):

   405

    if lastKnownConfig is not None:

   406

        return url.URL.fromContext(ctx).\

   407

            child(WAMP_SECRET_URL).\

   408

            child(lastKnownConfig["ID"] + ".secret")

   409

   410

   411

webFormInterface = [

   412

    ("status",

   413

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

   414

                     immutable=True,

   415

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

   416

    ("ID",

   417

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

   418

                     default=wampConfigDefault)),

   419

    ("secretfile",

   420

     FileUploadDownload(label=_("File containing secret for that ID"),

   421

                        download_url=getDownloadUrl)),

   422

    ("active",

   423

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

   424

                      default=wampConfigDefault)),

   425

    ("url",

   426

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

   427

                     default=wampConfigDefault))]

   428

   429

   430

def deliverWampSecret(ctx, segments):

   431

    # filename = segments[1].decode('utf-8')

   432

   433

    # FIXME: compare filename to ID+".secret"

   434

    # for now all url under /secret returns the secret

   435

   436

    # TODO: make beautifull message in case of exception

   437

    # while loading secret (if empty or dont exist)

   438

    secret = LoadWampSecret(_WampSecret)

   439

    return static.Data(secret, 'application/octet-stream'), ()

   440

   441

   442

def RegisterWebSettings(NS):

   443

   444

    NS.ConfigurableSettings.addSettings(

   445

        "wamp",

   446

        _("Wamp Settings"),

   447

        webFormInterface,

   448

        _("Set"),

   449

        wampConfig)

   450

   451

    NS.customSettingsURLs[WAMP_SECRET_URL] = deliverWampSecret