kopia lustrzana https://github.com/Yakifo/amqtt
389 wiersze
14 KiB
Python
389 wiersze
14 KiB
Python
# Copyright (c) 2015 Nicolas JOUANIN
|
|
#
|
|
# See the file license.txt for copying permission.
|
|
|
|
import logging
|
|
import asyncio
|
|
import ssl
|
|
from urllib.parse import urlparse
|
|
|
|
from hbmqtt.utils import not_in_dict_or_none
|
|
from hbmqtt.session import Session
|
|
from hbmqtt.mqtt.connack import *
|
|
from hbmqtt.mqtt.connect import *
|
|
from hbmqtt.mqtt.protocol.client_handler import ClientProtocolHandler
|
|
from hbmqtt.adapters import StreamReaderAdapter, StreamWriterAdapter, WebSocketsReader, WebSocketsWriter
|
|
from hbmqtt.plugins.manager import PluginManager, BaseContext
|
|
from hbmqtt.mqtt.protocol.handler import EVENT_MQTT_PACKET_SENT, EVENT_MQTT_PACKET_RECEIVED
|
|
import websockets
|
|
|
|
_defaults = {
|
|
'keep_alive': 10,
|
|
'ping_delay': 1,
|
|
'default_qos': 0,
|
|
'default_retain': False,
|
|
}
|
|
|
|
|
|
class ClientException(BaseException):
|
|
pass
|
|
|
|
|
|
class ConnectException(ClientException):
|
|
pass
|
|
|
|
|
|
class ClientContext(BaseContext):
|
|
"""
|
|
ClientContext is used as the context passed to plugins interacting with the client.
|
|
It act as an adapter to client services from plugins
|
|
"""
|
|
def __init__(self):
|
|
super().__init__()
|
|
self.config = None
|
|
|
|
|
|
class MQTTClient:
|
|
def __init__(self, client_id=None, config=None, loop=None):
|
|
"""
|
|
|
|
:param config: Example yaml config
|
|
broker:
|
|
uri: mqtt:username@password//localhost:1883/
|
|
cafile: somefile.cert #Server authority file
|
|
capath: /some/path # certficate file path
|
|
cadata: certificate as string data
|
|
keep_alive: 60
|
|
cleansession: true
|
|
will:
|
|
retain: false
|
|
topic: some/topic
|
|
message: Will message
|
|
qos: 0
|
|
default_qos: 0
|
|
default_retain: false
|
|
topics:
|
|
a/b:
|
|
qos: 2
|
|
retain: true
|
|
:param loop:
|
|
:return:
|
|
"""
|
|
self.logger = logging.getLogger(__name__)
|
|
self.config = _defaults
|
|
if config is not None:
|
|
self.config.update(config)
|
|
if client_id is not None:
|
|
self.client_id = client_id
|
|
else:
|
|
from hbmqtt.utils import gen_client_id
|
|
self.client_id = gen_client_id()
|
|
self.logger.debug("Using generated client ID : %s" % self.client_id)
|
|
|
|
if loop is not None:
|
|
self._loop = loop
|
|
else:
|
|
self._loop = asyncio.get_event_loop()
|
|
self.session = None
|
|
self._handler = None
|
|
self._disconnect_task = None
|
|
self._connection_closed_future = None
|
|
|
|
# Init plugins manager
|
|
context = ClientContext()
|
|
context.config = self.config
|
|
self.plugins_manager = PluginManager('hbmqtt.client.plugins', context)
|
|
|
|
|
|
@asyncio.coroutine
|
|
def connect(self,
|
|
uri=None,
|
|
cleansession=None,
|
|
cafile=None,
|
|
capath=None,
|
|
cadata=None):
|
|
"""
|
|
Connect to a remote broker
|
|
:param uri: Broker URI connection, conforming to `MQTT URI scheme <https://github.com/mqtt/mqtt.github.io/wiki/URI-Scheme>`_.
|
|
:param cleansession: MQTT CONNECT clean session flaf
|
|
:param cafile: server certificate authority file
|
|
:return:
|
|
"""
|
|
self.session = self._initsession(uri, cleansession, cafile, capath, cadata)
|
|
self.logger.debug("Connect to: %s" % uri)
|
|
|
|
return_code = yield from self._connect_coro()
|
|
self._connection_closed_future = asyncio.Future(loop=self._loop)
|
|
self._disconnect_task = asyncio.Task(self.handle_connection_close(), loop=self._loop)
|
|
return self._connection_closed_future
|
|
|
|
@asyncio.coroutine
|
|
def disconnect(self):
|
|
if self.session.transitions.is_connected():
|
|
if not self._disconnect_task.done():
|
|
self._disconnect_task.cancel()
|
|
yield from self._handler.mqtt_disconnect()
|
|
yield from self._handler.stop()
|
|
self._handler.detach_from_session()
|
|
self.session.transitions.disconnect()
|
|
self._connection_closed_future.set_result(None)
|
|
else:
|
|
self.logger.warn("Client session is not currently connected, ignoring call")
|
|
|
|
@asyncio.coroutine
|
|
def reconnect(self, cleansession=False):
|
|
if self.session.transitions.is_connected():
|
|
self.logger.warn("Client already connected")
|
|
return CONNECTION_ACCEPTED
|
|
|
|
self.session.clean_session = cleansession
|
|
self.logger.debug("Reconnecting with session parameters: %s" % self.session)
|
|
|
|
return_code = yield from self._connect_coro()
|
|
self._connection_closed_future = asyncio.Future(loop=self._loop)
|
|
self._disconnect_task = asyncio.Task(self.handle_connection_close(), loop=self._loop)
|
|
return self._connection_closed_future
|
|
|
|
@asyncio.coroutine
|
|
def ping(self):
|
|
"""
|
|
Send a MQTT ping request and wait for response
|
|
:return: None
|
|
"""
|
|
if self.session.transitions.is_connected():
|
|
yield from self._handler.mqtt_ping()
|
|
else:
|
|
self.logger.warn("MQTT PING request incompatible with current session state '%s'" %
|
|
self.session.transitions.state)
|
|
|
|
@asyncio.coroutine
|
|
def publish(self, topic, message, qos=None, retain=None):
|
|
def get_retain_and_qos():
|
|
if qos:
|
|
_qos = qos
|
|
else:
|
|
_qos = self.config['default_qos']
|
|
try:
|
|
_qos = self.config['topics'][topic]['qos']
|
|
except KeyError:
|
|
pass
|
|
if retain:
|
|
_retain = retain
|
|
else:
|
|
_retain = self.config['default_retain']
|
|
try:
|
|
_retain = self.config['topics'][topic]['retain']
|
|
except KeyError:
|
|
pass
|
|
return _qos, _retain
|
|
if not self.session.transitions.is_connected():
|
|
self.logger.warn("publish MQTT message while not connected to broker, message may be lost")
|
|
(app_qos, app_retain) = get_retain_and_qos()
|
|
if app_qos == 0:
|
|
yield from self._handler.mqtt_publish(topic, message, 0x00, app_retain)
|
|
if app_qos == 1:
|
|
yield from self._handler.mqtt_publish(topic, message, 0x01, app_retain)
|
|
if app_qos == 2:
|
|
yield from self._handler.mqtt_publish(topic, message, 0x02, app_retain)
|
|
|
|
@asyncio.coroutine
|
|
def subscribe(self, topics):
|
|
if not self.session.transitions.is_connected():
|
|
self.logger.warn("subscribe while not connected to broker, message may be lost")
|
|
return (yield from self._handler.mqtt_subscribe(topics, self.session.next_packet_id))
|
|
|
|
@asyncio.coroutine
|
|
def unsubscribe(self, topics):
|
|
if not self.session.transitions.is_connected():
|
|
self.logger.warn("unsubscribe while not connected to broker, message may be lost")
|
|
yield from self._handler.mqtt_unsubscribe(topics, self.session.next_packet_id)
|
|
|
|
@asyncio.coroutine
|
|
def deliver_message(self):
|
|
return (yield from self._handler.mqtt_deliver_next_message())
|
|
|
|
@asyncio.coroutine
|
|
def acknowledge_delivery(self, packet_id):
|
|
yield from self._handler.mqtt_acknowledge_delivery(packet_id)
|
|
|
|
@asyncio.coroutine
|
|
def _connect_coro(self):
|
|
sc = None
|
|
reader = None
|
|
writer = None
|
|
kwargs = dict()
|
|
|
|
# Decode URI attributes
|
|
uri_attributes = urlparse(self.session.broker_uri)
|
|
scheme = uri_attributes.scheme
|
|
self.session.username = uri_attributes.username
|
|
self.session.password = uri_attributes.password
|
|
self.session.remote_address = uri_attributes.hostname
|
|
self.session.remote_port = uri_attributes.port
|
|
if scheme in ('mqtt', 'mqtts') and not self.session.remote_port:
|
|
self.session.remote_port = 8883 if scheme == 'mqtts' else 1883
|
|
|
|
if scheme in ('mqtts', 'wss'):
|
|
if self.session.cafile is None or self.session.cafile == '':
|
|
self.logger.warn("TLS connection can't be estabilshed, no certificate file (.cert) given")
|
|
raise ClientException("TLS connection can't be estabilshed, no certificate file (.cert) given")
|
|
sc = ssl.create_default_context(
|
|
ssl.Purpose.SERVER_AUTH,
|
|
cafile=self.session.cafile,
|
|
capath=self.session.capath,
|
|
cadata=self.session.cadata)
|
|
if 'certfile' in self.config and 'keyfile' in self.config:
|
|
sc.load_cert_chain(self.config['certfile'], self.config['keyfile'])
|
|
kwargs['ssl'] = sc
|
|
|
|
# Open connection
|
|
try:
|
|
if scheme in ('mqtt', 'mqtts'):
|
|
conn_reader, conn_writer = \
|
|
yield from asyncio.open_connection(
|
|
self.session.remote_address,
|
|
self.session.remote_port, loop=self._loop, **kwargs)
|
|
reader = StreamReaderAdapter(conn_reader)
|
|
writer = StreamWriterAdapter(conn_writer)
|
|
elif scheme in ('ws', 'wss'):
|
|
websocket = yield from websockets.connect(
|
|
self.session.broker_uri,
|
|
subprotocols=['mqtt'],
|
|
loop=self._loop,
|
|
**kwargs)
|
|
reader = WebSocketsReader(websocket)
|
|
writer = WebSocketsWriter(websocket)
|
|
except Exception as e:
|
|
self.logger.warn("connection failed: %s" % e)
|
|
self.session.transitions.disconnect()
|
|
raise ConnectException("connection Failed: %s" % e)
|
|
|
|
return_code = None
|
|
try :
|
|
connect_packet = self.build_connect_packet()
|
|
yield from connect_packet.to_stream(writer)
|
|
yield from self.plugins_manager.fire_event(EVENT_MQTT_PACKET_SENT,
|
|
packet=connect_packet,
|
|
session=self.session)
|
|
|
|
connack = yield from ConnackPacket.from_stream(reader)
|
|
yield from self.plugins_manager.fire_event(EVENT_MQTT_PACKET_RECEIVED,
|
|
packet=connack,
|
|
session=self.session)
|
|
return_code = connack.variable_header.return_code
|
|
except Exception as e:
|
|
self.logger.warn("connection failed: %s" % e)
|
|
self.session.transitions.disconnect()
|
|
raise ClientException("connection Failed: %s" % e)
|
|
|
|
if return_code is not CONNECTION_ACCEPTED:
|
|
yield from self._handler.stop()
|
|
self.session.transitions.disconnect()
|
|
self.logger.warn("Connection rejected with code '%s'" % return_code)
|
|
exc = ConnectException("Connection rejected by broker")
|
|
exc.return_code = return_code
|
|
raise exc
|
|
else:
|
|
# Handle MQTT protocol
|
|
self._handler = ClientProtocolHandler(reader, writer, self.plugins_manager, loop=self._loop)
|
|
self._handler.attach_to_session(self.session)
|
|
yield from self._handler.start()
|
|
self.session.transitions.connect()
|
|
self.logger.debug("connected to %s:%s" % (self.session.remote_address, self.session.remote_port))
|
|
|
|
def build_connect_packet(self):
|
|
vh = ConnectVariableHeader()
|
|
payload = ConnectPayload()
|
|
|
|
vh.keep_alive = self.session.keep_alive
|
|
vh.clean_session_flag = self.session.clean_session
|
|
vh.will_retain_flag = self.session.will_retain
|
|
payload.client_id = self.session.client_id
|
|
|
|
if self.session.username:
|
|
vh.username_flag = True
|
|
payload.username = self.session.username
|
|
else:
|
|
vh.username_flag = False
|
|
|
|
if self.session.password:
|
|
vh.password_flag = True
|
|
payload.password = self.session.password
|
|
else:
|
|
vh.password_flag = False
|
|
if self.session.will_flag:
|
|
vh.will_flag = True
|
|
vh.will_qos = self.session.will_qos
|
|
payload.will_message = self.session.will_message
|
|
payload.will_topic = self.session.will_topic
|
|
else:
|
|
vh.will_flag = False
|
|
|
|
header = MQTTFixedHeader(CONNECT, 0x00)
|
|
packet = ConnectPacket(header, vh, payload)
|
|
return packet
|
|
|
|
@asyncio.coroutine
|
|
def handle_connection_close(self):
|
|
self.logger.debug("Watch broker disconnection")
|
|
yield from self._handler.wait_disconnect()
|
|
self.logger.debug("Handle broker disconnection")
|
|
yield from self._handler.stop()
|
|
self.session.transitions.disconnect()
|
|
self._connection_closed_future.set_result(None)
|
|
|
|
def _initsession(
|
|
self,
|
|
uri=None,
|
|
cleansession=None,
|
|
cafile=None,
|
|
capath=None,
|
|
cadata=None) -> Session:
|
|
# Load config
|
|
broker_conf = self.config.get('broker', dict()).copy()
|
|
if uri:
|
|
broker_conf['uri'] = uri
|
|
if cafile:
|
|
broker_conf['cafile'] = cafile
|
|
elif 'cafile' not in broker_conf:
|
|
broker_conf['cafile'] = None
|
|
if capath:
|
|
broker_conf['capath'] = capath
|
|
elif 'capath' not in broker_conf:
|
|
broker_conf['capath'] = None
|
|
if cadata:
|
|
broker_conf['cadata'] = cadata
|
|
elif 'cadata' not in broker_conf:
|
|
broker_conf['cadata'] = None
|
|
|
|
if cleansession is not None:
|
|
broker_conf['cleansession'] = cleansession
|
|
|
|
for key in ['uri']:
|
|
if not_in_dict_or_none(broker_conf, key):
|
|
raise ClientException("Missing connection parameter '%s'" % key)
|
|
|
|
s = Session()
|
|
s.broker_uri = uri
|
|
s.client_id = self.client_id
|
|
s.cafile = broker_conf['cafile']
|
|
s.capath = broker_conf['capath']
|
|
s.cadata = broker_conf['cadata']
|
|
if cleansession is not None:
|
|
s.clean_session = cleansession
|
|
else:
|
|
s.clean_session = self.config.get('cleansession', True)
|
|
s.keep_alive = self.config['keep_alive'] - self.config['ping_delay']
|
|
if 'will' in self.config:
|
|
s.will_flag = True
|
|
s.will_retain = self.config['will']['retain']
|
|
s.will_topic = self.config['will']['topic']
|
|
s.will_message = self.config['will']['message']
|
|
s.will_qos = self.config['will']['qos']
|
|
else:
|
|
s.will_flag = False
|
|
s.will_retain = False
|
|
s.will_topic = None
|
|
s.will_message = None
|
|
return s
|