HGKeeper

#!/usr/bin/env python

# -*- coding: utf-8 -*-

# This file is part of Beremiz runtime.

# See COPYING.Runtime file for copyrights details.

# This library is free software; you can redistribute it and/or

# modify it under the terms of the GNU Lesser General Public

# License as published by the Free Software Foundation; either

# version 2.1 of the License, or (at your option) any later version.

# This library is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

# Lesser General Public License for more details.

# You should have received a copy of the GNU Lesser General Public

# License along with this library; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

from __future__ import absolute_import

from __future__ import print_function

import time

import json

import inspect

import re

from autobahn.twisted import wamp

from autobahn.twisted.websocket import WampWebSocketClientFactory, connectWS

from autobahn.wamp import types, auth

from autobahn.wamp.serializer import MsgPackSerializer

from twisted.internet.defer import inlineCallbacks

from twisted.internet.protocol import ReconnectingClientFactory

_transportFactory = None

_WampSession = None

_PySrv = None

ExposedCalls = [

"StartPLC",

"StopPLC",

"ForceReload",

"GetPLCstatus",

"NewPLC",

"MatchMD5",

"SetTraceVariablesList",

"GetTraceVariables",

"RemoteExec",

"GetLogMessage",

"ResetLogCount",

]

ExposedProgressCalls = []

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

# or User python code.

""" crossbar Events to register to """

SubscribedEvents = []

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

DoOnJoin = []

def GetCallee(name):

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

names = name.split('.')

obj = _PySrv.plcobj

while names:

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

return obj

def getValidOptins(options, arguments):

validOptions = {}

for key in options:

if key in arguments:

validOptions[key] = options[key]

if len(validOptions) > 0:

return validOptions

else:

return None

class WampSession(wamp.ApplicationSession):

def onConnect(self):

if "secret" in self.config.extra:

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

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

else:

self.join(u"Automation")

def onChallenge(self, challenge):

if challenge.method == u"wampcra":

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

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

return signature.decode("ascii")

else:

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

@inlineCallbacks

def onJoin(self, details):

global _WampSession

_WampSession = self

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

validRegisterOptions = {}

registerOptions = self.config.extra.get('registerOptions', None)

if registerOptions:

arguments = inspect.getargspec(types.RegisterOptions.__init__).args

validRegisterOptions = getValidOptins(registerOptions, arguments)

if validRegisterOptions:

registerOptions = types.RegisterOptions(**validRegisterOptions)

#print(_("Added custom register options"))

for name in ExposedCalls:

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

if ExposedProgressCalls:

validRegisterOptions["details_arg"] = 'details'

registerOptions = types.RegisterOptions(**validRegisterOptions)

# using progress, details argument must be added

for name in ExposedProgressCalls:

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

for name in SubscribedEvents:

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

for func in DoOnJoin:

yield func(self)

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

def onLeave(self, details):

global _WampSession, _transportFactory

super(WampSession, self).onLeave(details)

_WampSession = None

_transportFactory = None

print(_('WAMP session left'))

class ReconnectingWampWebSocketClientFactory(WampWebSocketClientFactory, ReconnectingClientFactory):

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

global _transportFactory

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

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

if protocolOptions:

arguments = inspect.getargspec(self.setProtocolOptions).args

validProtocolOptions = getValidOptins(protocolOptions, arguments)

if validProtocolOptions:

self.setProtocolOptions(**validProtocolOptions)

#print(_("Added custom protocol options"))

_transportFactory = self

def buildProtocol(self, addr):

self.resetDelay()

return ReconnectingClientFactory.buildProtocol(self, addr)

def clientConnectionFailed(self, connector, reason):

if self.continueTrying:

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

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

else:

del connector

def clientConnectionLost(self, connector, reason):

if self.continueTrying:

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

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

else:

del connector

def LoadWampClientConf(wampconf):

try:

WSClientConf = json.load(open(wampconf))

return WSClientConf

except ValueError, ve:

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

return None

except Exception:

return None

def LoadWampSecret(secretfname):

try:

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

return WSClientWampSecret

except ValueError, ve:

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

return None

except Exception:

return None

def IsCorrectUri(uri):

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

return True

else:

return False

def RegisterWampClient(wampconf, secretfname):

WSClientConf = LoadWampClientConf(wampconf)

if not WSClientConf:

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

return False

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

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

return False

WampSecret = LoadWampSecret(secretfname)

if WampSecret is not None:

WSClientConf["secret"] = WampSecret

# create a WAMP application session factory

component_config = types.ComponentConfig(

realm=WSClientConf["realm"],

extra=WSClientConf)

session_factory = wamp.ApplicationSessionFactory(

config=component_config)

session_factory.session = WampSession

# create a WAMP-over-WebSocket transport client factory

transport_factory = ReconnectingWampWebSocketClientFactory(

component_config,

session_factory,

url=WSClientConf["url"],

serializers=[MsgPackSerializer()])

# start the client from a Twisted endpoint

conn = connectWS(transport_factory)

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

return True # conn

def GetTransportFactory():

global _transportFactory

return _transportFactory

def GetSession():

global _WampSession

return _WampSession

def SetServer(pysrv):

global _PySrv

_PySrv = pysrv

beremiz