jshiffer/slixmpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove all trailing semicolons.

Browse Source
This commit is contained in:
Emmanuel Gil Peyrot 2014-08-17 21:57:53 +02:00 committed by Florent Le Coz
parent 17174016ec
commit 9d8a2a1a7a
7 changed files with 410 additions and 410 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
slixmpp/plugins/xep_0009/rpc.py
View File

@ -61,7 +61,7 @@ class XEP_0009(BasePlugin):
iq.enable('rpc_query') iq.enable('rpc_query')
iq['rpc_query']['method_call']['method_name'] = pmethod iq['rpc_query']['method_call']['method_name'] = pmethod
iq['rpc_query']['method_call']['params'] = params iq['rpc_query']['method_call']['params'] = params
return iq; return iq
def make_iq_method_response(self, pid, pto, params): def make_iq_method_response(self, pid, pto, params):
iq = self.xmpp.makeIqResult(pid) iq = self.xmpp.makeIqResult(pid)
@ -93,7 +93,7 @@ class XEP_0009(BasePlugin):
def _item_not_found(self, iq): def _item_not_found(self, iq):
payload = iq.get_payload() payload = iq.get_payload()
iq.reply().error().set_payload(payload); iq.reply().error().set_payload(payload)
iq['error']['code'] = '404' iq['error']['code'] = '404'
iq['error']['type'] = 'cancel' iq['error']['type'] = 'cancel'
iq['error']['condition'] = 'item-not-found' iq['error']['condition'] = 'item-not-found'

64
slixmpp/plugins/xep_0323/device.py
View File

@ -27,7 +27,7 @@ class Device(object):
# {'type':'numeric', # {'type':'numeric',
# 'name':'myname', # 'name':'myname',
# 'value': 42, # 'value': 42,
# 'unit':'Z'}]; # 'unit':'Z'}]
self.timestamp_data = {} self.timestamp_data = {}
self.momentary_data = {} self.momentary_data = {}
self.momentary_timestamp = "" self.momentary_timestamp = ""
@ -41,8 +41,8 @@ class Device(object):
field -- The field name field -- The field name
""" """
if field in self.fields.keys(): if field in self.fields.keys():
return True; return True
return False; return False
def refresh(self, fields): def refresh(self, fields):
""" """
@ -101,10 +101,10 @@ class Device(object):
for f in fields: for f in fields:
if f not in self.fields.keys(): if f not in self.fields.keys():
self._send_reject(session, callback) self._send_reject(session, callback)
return False; return False
else: else:
# Request all fields # Request all fields
fields = self.fields.keys(); fields = self.fields.keys()
# Refresh data from device # Refresh data from device
@ -114,15 +114,15 @@ class Device(object):
if "momentary" in flags and flags['momentary'] == "true" or \ if "momentary" in flags and flags['momentary'] == "true" or \
"all" in flags and flags['all'] == "true": "all" in flags and flags['all'] == "true":
ts_block = {}; ts_block = {}
timestamp = ""; timestamp = ""
if len(self.momentary_timestamp) > 0: if len(self.momentary_timestamp) > 0:
timestamp = self.momentary_timestamp; timestamp = self.momentary_timestamp
else: else:
timestamp = self._get_timestamp(); timestamp = self._get_timestamp()
field_block = []; field_block = []
for f in self.momentary_data: for f in self.momentary_data:
if f in fields: if f in fields:
field_block.append({"name": f, field_block.append({"name": f,
@ -130,11 +130,11 @@ class Device(object):
"unit": self.fields[f]["unit"], "unit": self.fields[f]["unit"],
"dataType": self.fields[f]["dataType"], "dataType": self.fields[f]["dataType"],
"value": self.momentary_data[f]["value"], "value": self.momentary_data[f]["value"],
"flags": self.momentary_data[f]["flags"]}); "flags": self.momentary_data[f]["flags"]})
ts_block["timestamp"] = timestamp; ts_block["timestamp"] = timestamp
ts_block["fields"] = field_block; ts_block["fields"] = field_block
callback(session, result="done", nodeId=self.nodeId, timestamp_block=ts_block); callback(session, result="done", nodeId=self.nodeId, timestamp_block=ts_block)
return return
from_flag = self._datetime_flag_parser(flags, 'from') from_flag = self._datetime_flag_parser(flags, 'from')
@ -151,8 +151,8 @@ class Device(object):
#print (str(tsdt) + " > " + str(to_flag)) #print (str(tsdt) + " > " + str(to_flag))
continue continue
ts_block = {}; ts_block = {}
field_block = []; field_block = []
for f in self.timestamp_data[ts]: for f in self.timestamp_data[ts]:
if f in fields: if f in fields:
@ -161,12 +161,12 @@ class Device(object):
"unit": self.fields[f]["unit"], "unit": self.fields[f]["unit"],
"dataType": self.fields[f]["dataType"], "dataType": self.fields[f]["dataType"],
"value": self.timestamp_data[ts][f]["value"], "value": self.timestamp_data[ts][f]["value"],
"flags": self.timestamp_data[ts][f]["flags"]}); "flags": self.timestamp_data[ts][f]["flags"]})
ts_block["timestamp"] = ts; ts_block["timestamp"] = ts
ts_block["fields"] = field_block; ts_block["fields"] = field_block
callback(session, result="fields", nodeId=self.nodeId, timestamp_block=ts_block); callback(session, result="fields", nodeId=self.nodeId, timestamp_block=ts_block)
callback(session, result="done", nodeId=self.nodeId, timestamp_block=None); callback(session, result="done", nodeId=self.nodeId, timestamp_block=None)
def _datetime_flag_parser(self, flags, flagname): def _datetime_flag_parser(self, flags, flagname):
if not flagname in flags: if not flagname in flags:
@ -195,7 +195,7 @@ class Device(object):
session -- Session id, see definition in request_fields function session -- Session id, see definition in request_fields function
callback -- Callback function, see definition in request_fields function callback -- Callback function, see definition in request_fields function
""" """
callback(session, result="error", nodeId=self.nodeId, timestamp_block=None, error_msg="Reject"); callback(session, result="error", nodeId=self.nodeId, timestamp_block=None, error_msg="Reject")
def _add_field(self, name, typename, unit=None, dataType=None): def _add_field(self, name, typename, unit=None, dataType=None):
""" """
@ -207,7 +207,7 @@ class Device(object):
unit -- [optional] only applies to "numeric". Unit for the field. unit -- [optional] only applies to "numeric". Unit for the field.
dataType -- [optional] only applies to "enum". Datatype for the field. dataType -- [optional] only applies to "enum". Datatype for the field.
""" """
self.fields[name] = {"type": typename, "unit": unit, "dataType": dataType}; self.fields[name] = {"type": typename, "unit": unit, "dataType": dataType}
def _add_field_timestamp_data(self, name, timestamp, value, flags=None): def _add_field_timestamp_data(self, name, timestamp, value, flags=None):
""" """
@ -221,12 +221,12 @@ class Device(object):
Formatted as a dictionary like { "flag name": "flag value" ... } Formatted as a dictionary like { "flag name": "flag value" ... }
""" """
if not name in self.fields.keys(): if not name in self.fields.keys():
return False; return False
if not timestamp in self.timestamp_data: if not timestamp in self.timestamp_data:
self.timestamp_data[timestamp] = {}; self.timestamp_data[timestamp] = {}
self.timestamp_data[timestamp][name] = {"value": value, "flags": flags}; self.timestamp_data[timestamp][name] = {"value": value, "flags": flags}
return True; return True
def _add_field_momentary_data(self, name, value, flags=None): def _add_field_momentary_data(self, name, value, flags=None):
""" """
@ -239,17 +239,17 @@ class Device(object):
Formatted as a dictionary like { "flag name": "flag value" ... } Formatted as a dictionary like { "flag name": "flag value" ... }
""" """
if name not in self.fields: if name not in self.fields:
return False; return False
if flags is None: if flags is None:
flags = {}; flags = {}
flags["momentary"] = "true" flags["momentary"] = "true"
self.momentary_data[name] = {"value": value, "flags": flags}; self.momentary_data[name] = {"value": value, "flags": flags}
return True; return True
def _set_momentary_timestamp(self, timestamp): def _set_momentary_timestamp(self, timestamp):
""" """
This function is only for unit testing to produce predictable results. This function is only for unit testing to produce predictable results.
""" """
self.momentary_timestamp = timestamp; self.momentary_timestamp = timestamp

318
slixmpp/plugins/xep_0323/sensordata.py
View File

@ -155,11 +155,11 @@ class XEP_0323(BasePlugin):
self._handle_event_started)) self._handle_event_started))
# Server side dicts # Server side dicts
self.nodes = {}; self.nodes = {}
self.sessions = {}; self.sessions = {}
self.last_seqnr = 0; self.last_seqnr = 0
self.seqnr_lock = Lock(); self.seqnr_lock = Lock()
## For testning only ## For testning only
self.test_authenticated_from = "" self.test_authenticated_from = ""
@ -182,7 +182,7 @@ class XEP_0323(BasePlugin):
def plugin_end(self): def plugin_end(self):
""" Stop the XEP-0323 plugin """ """ Stop the XEP-0323 plugin """
self.sessions.clear(); self.sessions.clear()
self.xmpp.remove_handler('Sensordata Event:Req') self.xmpp.remove_handler('Sensordata Event:Req')
self.xmpp.remove_handler('Sensordata Event:Accepted') self.xmpp.remove_handler('Sensordata Event:Accepted')
self.xmpp.remove_handler('Sensordata Event:Rejected') self.xmpp.remove_handler('Sensordata Event:Rejected')
@ -217,11 +217,11 @@ class XEP_0323(BasePlugin):
self.nodes[nodeId] = {"device": device, self.nodes[nodeId] = {"device": device,
"commTimeout": commTimeout, "commTimeout": commTimeout,
"sourceId": sourceId, "sourceId": sourceId,
"cacheType": cacheType}; "cacheType": cacheType}
def _set_authenticated(self, auth=''): def _set_authenticated(self, auth=''):
""" Internal testing function """ """ Internal testing function """
self.test_authenticated_from = auth; self.test_authenticated_from = auth
def _handle_event_req(self, iq): def _handle_event_req(self, iq):
@ -238,42 +238,42 @@ class XEP_0323(BasePlugin):
If the verification fails, a reject message is sent. If the verification fails, a reject message is sent.
""" """
seqnr = iq['req']['seqnr']; seqnr = iq['req']['seqnr']
error_msg = ''; error_msg = ''
req_ok = True; req_ok = True
# Authentication # Authentication
if len(self.test_authenticated_from) > 0 and not iq['from'] == self.test_authenticated_from: if len(self.test_authenticated_from) > 0 and not iq['from'] == self.test_authenticated_from:
# Invalid authentication # Invalid authentication
req_ok = False; req_ok = False
error_msg = "Access denied"; error_msg = "Access denied"
# Nodes # Nodes
process_nodes = []; process_nodes = []
if len(iq['req']['nodes']) > 0: if len(iq['req']['nodes']) > 0:
for n in iq['req']['nodes']: for n in iq['req']['nodes']:
if not n['nodeId'] in self.nodes: if not n['nodeId'] in self.nodes:
req_ok = False; req_ok = False
error_msg = "Invalid nodeId " + n['nodeId']; error_msg = "Invalid nodeId " + n['nodeId']
process_nodes = [n['nodeId'] for n in iq['req']['nodes']]; process_nodes = [n['nodeId'] for n in iq['req']['nodes']]
else: else:
process_nodes = self.nodes.keys(); process_nodes = self.nodes.keys()
# Fields - if we just find one we are happy, otherwise we reject # Fields - if we just find one we are happy, otherwise we reject
process_fields = []; process_fields = []
if len(iq['req']['fields']) > 0: if len(iq['req']['fields']) > 0:
found = False found = False
for f in iq['req']['fields']: for f in iq['req']['fields']:
for node in self.nodes: for node in self.nodes:
if self.nodes[node]["device"].has_field(f['name']): if self.nodes[node]["device"].has_field(f['name']):
found = True; found = True
break; break
if not found: if not found:
req_ok = False; req_ok = False
error_msg = "Invalid field " + f['name']; error_msg = "Invalid field " + f['name']
process_fields = [f['name'] for n in iq['req']['fields']]; process_fields = [f['name'] for n in iq['req']['fields']]
req_flags = iq['req']._get_flags(); req_flags = iq['req']._get_flags()
request_delay_sec = None request_delay_sec = None
if 'when' in req_flags: if 'when' in req_flags:
@ -283,7 +283,7 @@ class XEP_0323(BasePlugin):
try: try:
dt = datetime.datetime.strptime(req_flags['when'], "%Y-%m-%dT%H:%M:%S") dt = datetime.datetime.strptime(req_flags['when'], "%Y-%m-%dT%H:%M:%S")
except ValueError: except ValueError:
req_ok = False; req_ok = False
error_msg = "Invalid datetime in 'when' flag, please use ISO format (i.e. 2013-04-05T15:00:03)." error_msg = "Invalid datetime in 'when' flag, please use ISO format (i.e. 2013-04-05T15:00:03)."
if not dt is None: if not dt is None:
@ -292,30 +292,30 @@ class XEP_0323(BasePlugin):
dtdiff = dt - dtnow dtdiff = dt - dtnow
request_delay_sec = dtdiff.seconds + dtdiff.days * 24 * 3600 request_delay_sec = dtdiff.seconds + dtdiff.days * 24 * 3600
if request_delay_sec <= 0: if request_delay_sec <= 0:
req_ok = False; req_ok = False
error_msg = "Invalid datetime in 'when' flag, cannot set a time in the past. Current time: " + dtnow.isoformat(); error_msg = "Invalid datetime in 'when' flag, cannot set a time in the past. Current time: " + dtnow.isoformat()
if req_ok: if req_ok:
session = self._new_session(); session = self._new_session()
self.sessions[session] = {"from": iq['from'], "to": iq['to'], "seqnr": seqnr}; self.sessions[session] = {"from": iq['from'], "to": iq['to'], "seqnr": seqnr}
self.sessions[session]["commTimers"] = {}; self.sessions[session]["commTimers"] = {}
self.sessions[session]["nodeDone"] = {}; self.sessions[session]["nodeDone"] = {}
#print("added session: " + str(self.sessions)) #print("added session: " + str(self.sessions))
iq.reply(); iq.reply()
iq['accepted']['seqnr'] = seqnr; iq['accepted']['seqnr'] = seqnr
if not request_delay_sec is None: if not request_delay_sec is None:
iq['accepted']['queued'] = "true" iq['accepted']['queued'] = "true"
iq.send(block=False); iq.send(block=False)
self.sessions[session]["node_list"] = process_nodes; self.sessions[session]["node_list"] = process_nodes
if not request_delay_sec is None: if not request_delay_sec is None:
# Delay request to requested time # Delay request to requested time
timer = Timer(request_delay_sec, self._event_delayed_req, args=(session, process_fields, req_flags)) timer = Timer(request_delay_sec, self._event_delayed_req, args=(session, process_fields, req_flags))
self.sessions[session]["commTimers"]["delaytimer"] = timer; self.sessions[session]["commTimers"]["delaytimer"] = timer
timer.start(); timer.start()
return return
if self.threaded: if self.threaded:
@ -324,14 +324,14 @@ class XEP_0323(BasePlugin):
tr_req.start() tr_req.start()
#print("started thread") #print("started thread")
else: else:
self._threaded_node_request(session, process_fields, req_flags); self._threaded_node_request(session, process_fields, req_flags)
else: else:
iq.reply(); iq.reply()
iq['type'] = 'error'; iq['type'] = 'error'
iq['rejected']['seqnr'] = seqnr; iq['rejected']['seqnr'] = seqnr
iq['rejected']['error'] = error_msg; iq['rejected']['error'] = error_msg
iq.send(block=False); iq.send(block=False)
def _threaded_node_request(self, session, process_fields, flags): def _threaded_node_request(self, session, process_fields, flags):
""" """
@ -344,14 +344,14 @@ class XEP_0323(BasePlugin):
Formatted as a dictionary like { "flag name": "flag value" ... } Formatted as a dictionary like { "flag name": "flag value" ... }
""" """
for node in self.sessions[session]["node_list"]: for node in self.sessions[session]["node_list"]:
self.sessions[session]["nodeDone"][node] = False; self.sessions[session]["nodeDone"][node] = False
for node in self.sessions[session]["node_list"]: for node in self.sessions[session]["node_list"]:
timer = TimerReset(self.nodes[node]['commTimeout'], self._event_comm_timeout, args=(session, node)); timer = TimerReset(self.nodes[node]['commTimeout'], self._event_comm_timeout, args=(session, node))
self.sessions[session]["commTimers"][node] = timer; self.sessions[session]["commTimers"][node] = timer
#print("Starting timer " + str(timer) + ", timeout: " + str(self.nodes[node]['commTimeout'])) #print("Starting timer " + str(timer) + ", timeout: " + str(self.nodes[node]['commTimeout']))
timer.start(); timer.start()
self.nodes[node]['device'].request_fields(process_fields, flags=flags, session=session, callback=self._device_field_request_callback); self.nodes[node]['device'].request_fields(process_fields, flags=flags, session=session, callback=self._device_field_request_callback)
def _event_comm_timeout(self, session, nodeId): def _event_comm_timeout(self, session, nodeId):
""" """
@ -363,22 +363,22 @@ class XEP_0323(BasePlugin):
session -- The request session id session -- The request session id
nodeId -- The id of the device which timed out nodeId -- The id of the device which timed out
""" """
msg = self.xmpp.Message(); msg = self.xmpp.Message()
msg['from'] = self.sessions[session]['to']; msg['from'] = self.sessions[session]['to']
msg['to'] = self.sessions[session]['from']; msg['to'] = self.sessions[session]['from']
msg['failure']['seqnr'] = self.sessions[session]['seqnr']; msg['failure']['seqnr'] = self.sessions[session]['seqnr']
msg['failure']['error']['text'] = "Timeout"; msg['failure']['error']['text'] = "Timeout"
msg['failure']['error']['nodeId'] = nodeId; msg['failure']['error']['nodeId'] = nodeId
msg['failure']['error']['timestamp'] = datetime.datetime.now().replace(microsecond=0).isoformat(); msg['failure']['error']['timestamp'] = datetime.datetime.now().replace(microsecond=0).isoformat()
# Drop communication with this device and check if we are done # Drop communication with this device and check if we are done
self.sessions[session]["nodeDone"][nodeId] = True; self.sessions[session]["nodeDone"][nodeId] = True
if (self._all_nodes_done(session)): if (self._all_nodes_done(session)):
msg['failure']['done'] = 'true'; msg['failure']['done'] = 'true'
msg.send(); msg.send()
# The session is complete, delete it # The session is complete, delete it
#print("del session " + session + " due to timeout") #print("del session " + session + " due to timeout")
del self.sessions[session]; del self.sessions[session]
def _event_delayed_req(self, session, process_fields, req_flags): def _event_delayed_req(self, session, process_fields, req_flags):
""" """
@ -390,17 +390,17 @@ class XEP_0323(BasePlugin):
flags -- [optional] flags to pass to the devices, e.g. momentary flags -- [optional] flags to pass to the devices, e.g. momentary
Formatted as a dictionary like { "flag name": "flag value" ... } Formatted as a dictionary like { "flag name": "flag value" ... }
""" """
msg = self.xmpp.Message(); msg = self.xmpp.Message()
msg['from'] = self.sessions[session]['to']; msg['from'] = self.sessions[session]['to']
msg['to'] = self.sessions[session]['from']; msg['to'] = self.sessions[session]['from']
msg['started']['seqnr'] = self.sessions[session]['seqnr']; msg['started']['seqnr'] = self.sessions[session]['seqnr']
msg.send(); msg.send()
if self.threaded: if self.threaded:
tr_req = Thread(target=self._threaded_node_request, args=(session, process_fields, req_flags)) tr_req = Thread(target=self._threaded_node_request, args=(session, process_fields, req_flags))
tr_req.start() tr_req.start()
else: else:
self._threaded_node_request(session, process_fields, req_flags); self._threaded_node_request(session, process_fields, req_flags)
def _all_nodes_done(self, session): def _all_nodes_done(self, session):
""" """
@ -411,8 +411,8 @@ class XEP_0323(BasePlugin):
""" """
for n in self.sessions[session]["nodeDone"]: for n in self.sessions[session]["nodeDone"]:
if not self.sessions[session]["nodeDone"][n]: if not self.sessions[session]["nodeDone"][n]:
return False; return False
return True; return True
def _device_field_request_callback(self, session, nodeId, result, timestamp_block, error_msg=None): def _device_field_request_callback(self, session, nodeId, result, timestamp_block, error_msg=None):
""" """
@ -452,33 +452,33 @@ class XEP_0323(BasePlugin):
return return
if result == "error": if result == "error":
self.sessions[session]["commTimers"][nodeId].cancel(); self.sessions[session]["commTimers"][nodeId].cancel()
msg = self.xmpp.Message(); msg = self.xmpp.Message()
msg['from'] = self.sessions[session]['to']; msg['from'] = self.sessions[session]['to']
msg['to'] = self.sessions[session]['from']; msg['to'] = self.sessions[session]['from']
msg['failure']['seqnr'] = self.sessions[session]['seqnr']; msg['failure']['seqnr'] = self.sessions[session]['seqnr']
msg['failure']['error']['text'] = error_msg; msg['failure']['error']['text'] = error_msg
msg['failure']['error']['nodeId'] = nodeId; msg['failure']['error']['nodeId'] = nodeId
msg['failure']['error']['timestamp'] = datetime.datetime.now().replace(microsecond=0).isoformat(); msg['failure']['error']['timestamp'] = datetime.datetime.now().replace(microsecond=0).isoformat()
# Drop communication with this device and check if we are done # Drop communication with this device and check if we are done
self.sessions[session]["nodeDone"][nodeId] = True; self.sessions[session]["nodeDone"][nodeId] = True
if (self._all_nodes_done(session)): if (self._all_nodes_done(session)):
msg['failure']['done'] = 'true'; msg['failure']['done'] = 'true'
# The session is complete, delete it # The session is complete, delete it
# print("del session " + session + " due to error") # print("del session " + session + " due to error")
del self.sessions[session]; del self.sessions[session]
msg.send(); msg.send()
else: else:
msg = self.xmpp.Message(); msg = self.xmpp.Message()
msg['from'] = self.sessions[session]['to']; msg['from'] = self.sessions[session]['to']
msg['to'] = self.sessions[session]['from']; msg['to'] = self.sessions[session]['from']
msg['fields']['seqnr'] = self.sessions[session]['seqnr']; msg['fields']['seqnr'] = self.sessions[session]['seqnr']
if timestamp_block is not None and len(timestamp_block) > 0: if timestamp_block is not None and len(timestamp_block) > 0:
node = msg['fields'].add_node(nodeId); node = msg['fields'].add_node(nodeId)
ts = node.add_timestamp(timestamp_block["timestamp"]); ts = node.add_timestamp(timestamp_block["timestamp"])
for f in timestamp_block["fields"]: for f in timestamp_block["fields"]:
data = ts.add_data( typename=f['type'], data = ts.add_data( typename=f['type'],
@ -486,50 +486,50 @@ class XEP_0323(BasePlugin):
value=f['value'], value=f['value'],
unit=f['unit'], unit=f['unit'],
dataType=f['dataType'], dataType=f['dataType'],
flags=f['flags']); flags=f['flags'])
if result == "done": if result == "done":
self.sessions[session]["commTimers"][nodeId].cancel(); self.sessions[session]["commTimers"][nodeId].cancel()
self.sessions[session]["nodeDone"][nodeId] = True; self.sessions[session]["nodeDone"][nodeId] = True
msg['fields']['done'] = 'true'; msg['fields']['done'] = 'true'
if (self._all_nodes_done(session)): if (self._all_nodes_done(session)):
# The session is complete, delete it # The session is complete, delete it
# print("del session " + session + " due to complete") # print("del session " + session + " due to complete")
del self.sessions[session]; del self.sessions[session]
else: else:
# Restart comm timer # Restart comm timer
self.sessions[session]["commTimers"][nodeId].reset(); self.sessions[session]["commTimers"][nodeId].reset()
msg.send(); msg.send()
def _handle_event_cancel(self, iq): def _handle_event_cancel(self, iq):
""" Received Iq with cancel - this is a cancel request. """ Received Iq with cancel - this is a cancel request.
Delete the session and confirm. """ Delete the session and confirm. """
seqnr = iq['cancel']['seqnr']; seqnr = iq['cancel']['seqnr']
# Find the session # Find the session
for s in self.sessions: for s in self.sessions:
if self.sessions[s]['from'] == iq['from'] and self.sessions[s]['to'] == iq['to'] and self.sessions[s]['seqnr'] == seqnr: if self.sessions[s]['from'] == iq['from'] and self.sessions[s]['to'] == iq['to'] and self.sessions[s]['seqnr'] == seqnr:
# found it. Cancel all timers # found it. Cancel all timers
for n in self.sessions[s]["commTimers"]: for n in self.sessions[s]["commTimers"]:
self.sessions[s]["commTimers"][n].cancel(); self.sessions[s]["commTimers"][n].cancel()
# Confirm # Confirm
iq.reply(); iq.reply()
iq['type'] = 'result'; iq['type'] = 'result'
iq['cancelled']['seqnr'] = seqnr; iq['cancelled']['seqnr'] = seqnr
iq.send(block=False); iq.send(block=False)
# Delete session # Delete session
del self.sessions[s] del self.sessions[s]
return return
# Could not find session, send reject # Could not find session, send reject
iq.reply(); iq.reply()
iq['type'] = 'error'; iq['type'] = 'error'
iq['rejected']['seqnr'] = seqnr; iq['rejected']['seqnr'] = seqnr
iq['rejected']['error'] = "Cancel request received, no matching request is active."; iq['rejected']['error'] = "Cancel request received, no matching request is active."
iq.send(block=False); iq.send(block=False)
# ================================================================= # =================================================================
# Client side (data retriever) API # Client side (data retriever) API
@ -593,26 +593,26 @@ class XEP_0323(BasePlugin):
session -- Session identifier. Client can use this as a reference to cancel session -- Session identifier. Client can use this as a reference to cancel
the request. the request.
""" """
iq = self.xmpp.Iq(); iq = self.xmpp.Iq()
iq['from'] = from_jid; iq['from'] = from_jid
iq['to'] = to_jid; iq['to'] = to_jid
iq['type'] = "get"; iq['type'] = "get"
seqnr = self._get_new_seqnr(); seqnr = self._get_new_seqnr()
iq['id'] = seqnr; iq['id'] = seqnr
iq['req']['seqnr'] = seqnr; iq['req']['seqnr'] = seqnr
if nodeIds is not None: if nodeIds is not None:
for nodeId in nodeIds: for nodeId in nodeIds:
iq['req'].add_node(nodeId); iq['req'].add_node(nodeId)
if fields is not None: if fields is not None:
for field in fields: for field in fields:
iq['req'].add_field(field); iq['req'].add_field(field)
iq['req']._set_flags(flags); iq['req']._set_flags(flags)
self.sessions[seqnr] = {"from": iq['from'], "to": iq['to'], "seqnr": seqnr, "callback": callback}; self.sessions[seqnr] = {"from": iq['from'], "to": iq['to'], "seqnr": seqnr, "callback": callback}
iq.send(block=False); iq.send(block=False)
return seqnr; return seqnr
def cancel_request(self, session): def cancel_request(self, session):
""" """
@ -625,39 +625,39 @@ class XEP_0323(BasePlugin):
session -- The session id of the request to cancel session -- The session id of the request to cancel
""" """
seqnr = session seqnr = session
iq = self.xmpp.Iq(); iq = self.xmpp.Iq()
iq['from'] = self.sessions[seqnr]['from'] iq['from'] = self.sessions[seqnr]['from']
iq['to'] = self.sessions[seqnr]['to']; iq['to'] = self.sessions[seqnr]['to']
iq['type'] = "get"; iq['type'] = "get"
iq['id'] = seqnr; iq['id'] = seqnr
iq['cancel']['seqnr'] = seqnr; iq['cancel']['seqnr'] = seqnr
iq.send(block=False); iq.send(block=False)
def _get_new_seqnr(self): def _get_new_seqnr(self):
""" Returns a unique sequence number (unique across threads) """ """ Returns a unique sequence number (unique across threads) """
self.seqnr_lock.acquire(); self.seqnr_lock.acquire()
self.last_seqnr = self.last_seqnr + 1; self.last_seqnr = self.last_seqnr + 1
self.seqnr_lock.release(); self.seqnr_lock.release()
return str(self.last_seqnr); return str(self.last_seqnr)
def _handle_event_accepted(self, iq): def _handle_event_accepted(self, iq):
""" Received Iq with accepted - request was accepted """ """ Received Iq with accepted - request was accepted """
seqnr = iq['accepted']['seqnr']; seqnr = iq['accepted']['seqnr']
result = "accepted" result = "accepted"
if iq['accepted']['queued'] == 'true': if iq['accepted']['queued'] == 'true':
result = "queued" result = "queued"
callback = self.sessions[seqnr]["callback"]; callback = self.sessions[seqnr]["callback"]
callback(from_jid=iq['from'], result=result); callback(from_jid=iq['from'], result=result)
def _handle_event_rejected(self, iq): def _handle_event_rejected(self, iq):
""" Received Iq with rejected - this is a reject. """ Received Iq with rejected - this is a reject.
Delete the session. """ Delete the session. """
seqnr = iq['rejected']['seqnr']; seqnr = iq['rejected']['seqnr']
callback = self.sessions[seqnr]["callback"]; callback = self.sessions[seqnr]["callback"]
callback(from_jid=iq['from'], result="rejected", error_msg=iq['rejected']['error']); callback(from_jid=iq['from'], result="rejected", error_msg=iq['rejected']['error'])
# Session terminated # Session terminated
del self.sessions[seqnr]; del self.sessions[seqnr]
def _handle_event_cancelled(self, iq): def _handle_event_cancelled(self, iq):
""" """
@ -665,59 +665,59 @@ class XEP_0323(BasePlugin):
Delete the session. Delete the session.
""" """
#print("Got cancelled") #print("Got cancelled")
seqnr = iq['cancelled']['seqnr']; seqnr = iq['cancelled']['seqnr']
callback = self.sessions[seqnr]["callback"]; callback = self.sessions[seqnr]["callback"]
callback(from_jid=iq['from'], result="cancelled"); callback(from_jid=iq['from'], result="cancelled")
# Session cancelled # Session cancelled
del self.sessions[seqnr]; del self.sessions[seqnr]
def _handle_event_fields(self, msg): def _handle_event_fields(self, msg):
""" """
Received Msg with fields - this is a data reponse to a request. Received Msg with fields - this is a data reponse to a request.
If this is the last data block, issue a "done" callback. If this is the last data block, issue a "done" callback.
""" """
seqnr = msg['fields']['seqnr']; seqnr = msg['fields']['seqnr']
callback = self.sessions[seqnr]["callback"]; callback = self.sessions[seqnr]["callback"]
for node in msg['fields']['nodes']: for node in msg['fields']['nodes']:
for ts in node['timestamps']: for ts in node['timestamps']:
fields = []; fields = []
for d in ts['datas']: for d in ts['datas']:
field_block = {}; field_block = {}
field_block["name"] = d['name']; field_block["name"] = d['name']
field_block["typename"] = d._get_typename(); field_block["typename"] = d._get_typename()
field_block["value"] = d['value']; field_block["value"] = d['value']
if not d['unit'] == "": field_block["unit"] = d['unit']; if not d['unit'] == "": field_block["unit"] = d['unit']
if not d['dataType'] == "": field_block["dataType"] = d['dataType']; if not d['dataType'] == "": field_block["dataType"] = d['dataType']
flags = d._get_flags(); flags = d._get_flags()
if not len(flags) == 0: if not len(flags) == 0:
field_block["flags"] = flags; field_block["flags"] = flags
fields.append(field_block); fields.append(field_block)
callback(from_jid=msg['from'], result="fields", nodeId=node['nodeId'], timestamp=ts['value'], fields=fields); callback(from_jid=msg['from'], result="fields", nodeId=node['nodeId'], timestamp=ts['value'], fields=fields)
if msg['fields']['done'] == "true": if msg['fields']['done'] == "true":
callback(from_jid=msg['from'], result="done"); callback(from_jid=msg['from'], result="done")
# Session done # Session done
del self.sessions[seqnr]; del self.sessions[seqnr]
def _handle_event_failure(self, msg): def _handle_event_failure(self, msg):
""" """
Received Msg with failure - our request failed Received Msg with failure - our request failed
Delete the session. Delete the session.
""" """
seqnr = msg['failure']['seqnr']; seqnr = msg['failure']['seqnr']
callback = self.sessions[seqnr]["callback"]; callback = self.sessions[seqnr]["callback"]
callback(from_jid=msg['from'], result="failure", nodeId=msg['failure']['error']['nodeId'], timestamp=msg['failure']['error']['timestamp'], error_msg=msg['failure']['error']['text']); callback(from_jid=msg['from'], result="failure", nodeId=msg['failure']['error']['nodeId'], timestamp=msg['failure']['error']['timestamp'], error_msg=msg['failure']['error']['text'])
# Session failed # Session failed
del self.sessions[seqnr]; del self.sessions[seqnr]
def _handle_event_started(self, msg): def _handle_event_started(self, msg):
""" """
Received Msg with started - our request was queued and is now started. Received Msg with started - our request was queued and is now started.
""" """
seqnr = msg['started']['seqnr']; seqnr = msg['started']['seqnr']
callback = self.sessions[seqnr]["callback"]; callback = self.sessions[seqnr]["callback"]
callback(from_jid=msg['from'], result="started"); callback(from_jid=msg['from'], result="started")

106
slixmpp/plugins/xep_0323/stanza/sensordata.py
View File

@ -38,12 +38,12 @@ class Request(ElementBase):
name = 'req' name = 'req'
plugin_attrib = name plugin_attrib = name
interfaces = set(['seqnr','nodes','fields','serviceToken','deviceToken','userToken','from','to','when','historical','all']) interfaces = set(['seqnr','nodes','fields','serviceToken','deviceToken','userToken','from','to','when','historical','all'])
interfaces.update(FieldTypes.field_types); interfaces.update(FieldTypes.field_types)
_flags = set(['serviceToken','deviceToken','userToken','from','to','when','historical','all']); _flags = set(['serviceToken','deviceToken','userToken','from','to','when','historical','all'])
_flags.update(FieldTypes.field_types); _flags.update(FieldTypes.field_types)
def __init__(self, xml=None, parent=None): def __init__(self, xml=None, parent=None):
ElementBase.__init__(self, xml, parent); ElementBase.__init__(self, xml, parent)
self._nodes = set() self._nodes = set()
self._fields = set() self._fields = set()
@ -67,11 +67,11 @@ class Request(ElementBase):
Helper function for getting of flags. Returns all flags in Helper function for getting of flags. Returns all flags in
dictionary format: { "flag name": "flag value" ... } dictionary format: { "flag name": "flag value" ... }
""" """
flags = {}; flags = {}
for f in self._flags: for f in self._flags:
if not self[f] == "": if not self[f] == "":
flags[f] = self[f]; flags[f] = self[f]
return flags; return flags
def _set_flags(self, flags): def _set_flags(self, flags):
""" """
@ -82,9 +82,9 @@ class Request(ElementBase):
""" """
for f in self._flags: for f in self._flags:
if flags is not None and f in flags: if flags is not None and f in flags:
self[f] = flags[f]; self[f] = flags[f]
else: else:
self[f] = None; self[f] = None
def add_node(self, nodeId, sourceId=None, cacheType=None): def add_node(self, nodeId, sourceId=None, cacheType=None):
""" """
@ -269,7 +269,7 @@ class Error(ElementBase):
:param value: string :param value: string
""" """
self.xml.text = value; self.xml.text = value
return self return self
def del_text(self): def del_text(self):
@ -292,7 +292,7 @@ class Fields(ElementBase):
interfaces = set(['seqnr','done','nodes']) interfaces = set(['seqnr','done','nodes'])
def __init__(self, xml=None, parent=None): def __init__(self, xml=None, parent=None):
ElementBase.__init__(self, xml, parent); ElementBase.__init__(self, xml, parent)
self._nodes = set() self._nodes = set()
def setup(self, xml=None): def setup(self, xml=None):
@ -392,7 +392,7 @@ class FieldsNode(ElementBase):
interfaces = set(['nodeId','sourceId','cacheType','timestamps']) interfaces = set(['nodeId','sourceId','cacheType','timestamps'])
def __init__(self, xml=None, parent=None): def __init__(self, xml=None, parent=None):
ElementBase.__init__(self, xml, parent); ElementBase.__init__(self, xml, parent)
self._timestamps = set() self._timestamps = set()
def setup(self, xml=None): def setup(self, xml=None):
@ -423,7 +423,7 @@ class FieldsNode(ElementBase):
ts = Timestamp(parent=self) ts = Timestamp(parent=self)
ts['value'] = timestamp ts['value'] = timestamp
if not substanzas is None: if not substanzas is None:
ts.set_datas(substanzas); ts.set_datas(substanzas)
#print("add_timestamp with substanzas: " + str(substanzas)) #print("add_timestamp with substanzas: " + str(substanzas))
self.iterables.append(ts) self.iterables.append(ts)
#print(str(id(self)) + " added_timestamp: " + str(id(ts))) #print(str(id(self)) + " added_timestamp: " + str(id(ts)))
@ -498,13 +498,13 @@ class Field(ElementBase):
namespace = 'urn:xmpp:iot:sensordata' namespace = 'urn:xmpp:iot:sensordata'
name = 'field' name = 'field'
plugin_attrib = name plugin_attrib = name
interfaces = set(['name','module','stringIds']); interfaces = set(['name','module','stringIds'])
interfaces.update(FieldTypes.field_types); interfaces.update(FieldTypes.field_types)
interfaces.update(FieldStatus.field_status); interfaces.update(FieldStatus.field_status)
_flags = set(); _flags = set()
_flags.update(FieldTypes.field_types); _flags.update(FieldTypes.field_types)
_flags.update(FieldStatus.field_status); _flags.update(FieldStatus.field_status)
def set_stringIds(self, value): def set_stringIds(self, value):
"""Verifies stringIds according to regexp from specification XMPP-0323. """Verifies stringIds according to regexp from specification XMPP-0323.
@ -514,7 +514,7 @@ class Field(ElementBase):
pattern = re.compile("^\d+([|]\w+([.]\w+)*([|][^,]*)?)?(,\d+([|]\w+([.]\w+)*([|][^,]*)?)?)*$") pattern = re.compile("^\d+([|]\w+([.]\w+)*([|][^,]*)?)?(,\d+([|]\w+([.]\w+)*([|][^,]*)?)?)*$")
if pattern.match(value) is not None: if pattern.match(value) is not None:
self.xml.stringIds = value; self.xml.stringIds = value
else: else:
# Bad content, add nothing # Bad content, add nothing
pass pass
@ -526,11 +526,11 @@ class Field(ElementBase):
Helper function for getting of flags. Returns all flags in Helper function for getting of flags. Returns all flags in
dictionary format: { "flag name": "flag value" ... } dictionary format: { "flag name": "flag value" ... }
""" """
flags = {}; flags = {}
for f in self._flags: for f in self._flags:
if not self[f] == "": if not self[f] == "":
flags[f] = self[f]; flags[f] = self[f]
return flags; return flags
def _set_flags(self, flags): def _set_flags(self, flags):
""" """
@ -541,12 +541,12 @@ class Field(ElementBase):
""" """
for f in self._flags: for f in self._flags:
if flags is not None and f in flags: if flags is not None and f in flags:
self[f] = flags[f]; self[f] = flags[f]
else: else:
self[f] = None; self[f] = None
def _get_typename(self): def _get_typename(self):
return "invalid type, use subclasses!"; return "invalid type, use subclasses!"
class Timestamp(ElementBase): class Timestamp(ElementBase):
@ -557,7 +557,7 @@ class Timestamp(ElementBase):
interfaces = set(['value','datas']) interfaces = set(['value','datas'])
def __init__(self, xml=None, parent=None): def __init__(self, xml=None, parent=None):
ElementBase.__init__(self, xml, parent); ElementBase.__init__(self, xml, parent)
self._datas = set() self._datas = set()
def setup(self, xml=None): def setup(self, xml=None):
@ -587,29 +587,29 @@ class Timestamp(ElementBase):
dataType -- [optional] The dataType. Only applicable for type enum dataType -- [optional] The dataType. Only applicable for type enum
""" """
if name not in self._datas: if name not in self._datas:
dataObj = None; dataObj = None
if typename == "numeric": if typename == "numeric":
dataObj = DataNumeric(parent=self); dataObj = DataNumeric(parent=self)
dataObj['unit'] = unit; dataObj['unit'] = unit
elif typename == "string": elif typename == "string":
dataObj = DataString(parent=self); dataObj = DataString(parent=self)
elif typename == "boolean": elif typename == "boolean":
dataObj = DataBoolean(parent=self); dataObj = DataBoolean(parent=self)
elif typename == "dateTime": elif typename == "dateTime":
dataObj = DataDateTime(parent=self); dataObj = DataDateTime(parent=self)
elif typename == "timeSpan": elif typename == "timeSpan":
dataObj = DataTimeSpan(parent=self); dataObj = DataTimeSpan(parent=self)
elif typename == "enum": elif typename == "enum":
dataObj = DataEnum(parent=self); dataObj = DataEnum(parent=self)
dataObj['dataType'] = dataType; dataObj['dataType'] = dataType
dataObj['name'] = name; dataObj['name'] = name
dataObj['value'] = value; dataObj['value'] = value
dataObj['module'] = module; dataObj['module'] = module
dataObj['stringIds'] = stringIds; dataObj['stringIds'] = stringIds
if flags is not None: if flags is not None:
dataObj._set_flags(flags); dataObj._set_flags(flags)
self._datas.add(name) self._datas.add(name)
self.iterables.append(dataObj) self.iterables.append(dataObj)
@ -668,8 +668,8 @@ class DataNumeric(Field):
namespace = 'urn:xmpp:iot:sensordata' namespace = 'urn:xmpp:iot:sensordata'
name = 'numeric' name = 'numeric'
plugin_attrib = name plugin_attrib = name
interfaces = set(['value', 'unit']); interfaces = set(['value', 'unit'])
interfaces.update(Field.interfaces); interfaces.update(Field.interfaces)
def _get_typename(self): def _get_typename(self):
return "numeric" return "numeric"
@ -681,8 +681,8 @@ class DataString(Field):
namespace = 'urn:xmpp:iot:sensordata' namespace = 'urn:xmpp:iot:sensordata'
name = 'string' name = 'string'
plugin_attrib = name plugin_attrib = name
interfaces = set(['value']); interfaces = set(['value'])
interfaces.update(Field.interfaces); interfaces.update(Field.interfaces)
def _get_typename(self): def _get_typename(self):
return "string" return "string"
@ -695,8 +695,8 @@ class DataBoolean(Field):
namespace = 'urn:xmpp:iot:sensordata' namespace = 'urn:xmpp:iot:sensordata'
name = 'boolean' name = 'boolean'
plugin_attrib = name plugin_attrib = name
interfaces = set(['value']); interfaces = set(['value'])
interfaces.update(Field.interfaces); interfaces.update(Field.interfaces)
def _get_typename(self): def _get_typename(self):
return "boolean" return "boolean"
@ -709,8 +709,8 @@ class DataDateTime(Field):
namespace = 'urn:xmpp:iot:sensordata' namespace = 'urn:xmpp:iot:sensordata'
name = 'dateTime' name = 'dateTime'
plugin_attrib = name plugin_attrib = name
interfaces = set(['value']); interfaces = set(['value'])
interfaces.update(Field.interfaces); interfaces.update(Field.interfaces)
def _get_typename(self): def _get_typename(self):
return "dateTime" return "dateTime"
@ -723,8 +723,8 @@ class DataTimeSpan(Field):
namespace = 'urn:xmpp:iot:sensordata' namespace = 'urn:xmpp:iot:sensordata'
name = 'timeSpan' name = 'timeSpan'
plugin_attrib = name plugin_attrib = name
interfaces = set(['value']); interfaces = set(['value'])
interfaces.update(Field.interfaces); interfaces.update(Field.interfaces)
def _get_typename(self): def _get_typename(self):
return "timeSpan" return "timeSpan"
@ -737,8 +737,8 @@ class DataEnum(Field):
namespace = 'urn:xmpp:iot:sensordata' namespace = 'urn:xmpp:iot:sensordata'
name = 'enum' name = 'enum'
plugin_attrib = name plugin_attrib = name
interfaces = set(['value', 'dataType']); interfaces = set(['value', 'dataType'])
interfaces.update(Field.interfaces); interfaces.update(Field.interfaces)
def _get_typename(self): def _get_typename(self):
return "enum" return "enum"

266
slixmpp/plugins/xep_0325/control.py
View File

@ -135,11 +135,11 @@ class XEP_0325(BasePlugin):
self._handle_set_response)) self._handle_set_response))
# Server side dicts # Server side dicts
self.nodes = {}; self.nodes = {}
self.sessions = {}; self.sessions = {}
self.last_seqnr = 0; self.last_seqnr = 0
self.seqnr_lock = Lock(); self.seqnr_lock = Lock()
## For testning only ## For testning only
self.test_authenticated_from = "" self.test_authenticated_from = ""
@ -156,13 +156,13 @@ class XEP_0325(BasePlugin):
def plugin_end(self): def plugin_end(self):
""" Stop the XEP-0325 plugin """ """ Stop the XEP-0325 plugin """
self.sessions.clear(); self.sessions.clear()
self.xmpp.remove_handler('Control Event:DirectSet') self.xmpp.remove_handler('Control Event:DirectSet')
self.xmpp.remove_handler('Control Event:SetReq') self.xmpp.remove_handler('Control Event:SetReq')
self.xmpp.remove_handler('Control Event:SetResponse') self.xmpp.remove_handler('Control Event:SetResponse')
self.xmpp.remove_handler('Control Event:SetResponseError') self.xmpp.remove_handler('Control Event:SetResponseError')
self.xmpp['xep_0030'].del_feature(feature=Control.namespace) self.xmpp['xep_0030'].del_feature(feature=Control.namespace)
self.xmpp['xep_0030'].set_items(node=Control.namespace, items=tuple()); self.xmpp['xep_0030'].set_items(node=Control.namespace, items=tuple())
# ================================================================= # =================================================================
@ -190,18 +190,18 @@ class XEP_0325(BasePlugin):
self.nodes[nodeId] = {"device": device, self.nodes[nodeId] = {"device": device,
"commTimeout": commTimeout, "commTimeout": commTimeout,
"sourceId": sourceId, "sourceId": sourceId,
"cacheType": cacheType}; "cacheType": cacheType}
def _set_authenticated(self, auth=''): def _set_authenticated(self, auth=''):
""" Internal testing function """ """ Internal testing function """
self.test_authenticated_from = auth; self.test_authenticated_from = auth
def _get_new_seqnr(self): def _get_new_seqnr(self):
""" Returns a unique sequence number (unique across threads) """ """ Returns a unique sequence number (unique across threads) """
self.seqnr_lock.acquire(); self.seqnr_lock.acquire()
self.last_seqnr = self.last_seqnr + 1; self.last_seqnr = self.last_seqnr + 1
self.seqnr_lock.release(); self.seqnr_lock.release()
return str(self.last_seqnr); return str(self.last_seqnr)
def _handle_set_req(self, iq): def _handle_set_req(self, iq):
""" """
@ -220,69 +220,69 @@ class XEP_0325(BasePlugin):
is sent. is sent.
""" """
error_msg = ''; error_msg = ''
req_ok = True; req_ok = True
missing_node = None; missing_node = None
missing_field = None; missing_field = None
# Authentication # Authentication
if len(self.test_authenticated_from) > 0 and not iq['from'] == self.test_authenticated_from: if len(self.test_authenticated_from) > 0 and not iq['from'] == self.test_authenticated_from:
# Invalid authentication # Invalid authentication
req_ok = False; req_ok = False
error_msg = "Access denied"; error_msg = "Access denied"
# Nodes # Nodes
process_nodes = []; process_nodes = []
if len(iq['set']['nodes']) > 0: if len(iq['set']['nodes']) > 0:
for n in iq['set']['nodes']: for n in iq['set']['nodes']:
if not n['nodeId'] in self.nodes: if not n['nodeId'] in self.nodes:
req_ok = False; req_ok = False
missing_node = n['nodeId']; missing_node = n['nodeId']
error_msg = "Invalid nodeId " + n['nodeId']; error_msg = "Invalid nodeId " + n['nodeId']
process_nodes = [n['nodeId'] for n in iq['set']['nodes']]; process_nodes = [n['nodeId'] for n in iq['set']['nodes']]
else: else:
process_nodes = self.nodes.keys(); process_nodes = self.nodes.keys()
# Fields - for control we need to find all in all devices, otherwise we reject # Fields - for control we need to find all in all devices, otherwise we reject
process_fields = []; process_fields = []
if len(iq['set']['datas']) > 0: if len(iq['set']['datas']) > 0:
for f in iq['set']['datas']: for f in iq['set']['datas']:
for node in self.nodes: for node in self.nodes:
if not self.nodes[node]["device"].has_control_field(f['name'], f._get_typename()): if not self.nodes[node]["device"].has_control_field(f['name'], f._get_typename()):
req_ok = False; req_ok = False
missing_field = f['name']; missing_field = f['name']
error_msg = "Invalid field " + f['name']; error_msg = "Invalid field " + f['name']
break; break
process_fields = [(f['name'], f._get_typename(), f['value']) for f in iq['set']['datas']]; process_fields = [(f['name'], f._get_typename(), f['value']) for f in iq['set']['datas']]
if req_ok: if req_ok:
session = self._new_session(); session = self._new_session()
self.sessions[session] = {"from": iq['from'], "to": iq['to'], "seqnr": iq['id']}; self.sessions[session] = {"from": iq['from'], "to": iq['to'], "seqnr": iq['id']}
self.sessions[session]["commTimers"] = {}; self.sessions[session]["commTimers"] = {}
self.sessions[session]["nodeDone"] = {}; self.sessions[session]["nodeDone"] = {}
# Flag that a reply is exected when we are done # Flag that a reply is exected when we are done
self.sessions[session]["reply"] = True; self.sessions[session]["reply"] = True
self.sessions[session]["node_list"] = process_nodes; self.sessions[session]["node_list"] = process_nodes
if self.threaded: if self.threaded:
#print("starting thread") #print("starting thread")
tr_req = Thread(target=self._threaded_node_request, args=(session, process_fields)) tr_req = Thread(target=self._threaded_node_request, args=(session, process_fields))
tr_req.start() tr_req.start()
#print("started thread") #print("started thread")
else: else:
self._threaded_node_request(session, process_fields); self._threaded_node_request(session, process_fields)
else: else:
iq.reply(); iq.reply()
iq['type'] = 'error'; iq['type'] = 'error'
iq['setResponse']['responseCode'] = "NotFound"; iq['setResponse']['responseCode'] = "NotFound"
if missing_node is not None: if missing_node is not None:
iq['setResponse'].add_node(missing_node); iq['setResponse'].add_node(missing_node)
if missing_field is not None: if missing_field is not None:
iq['setResponse'].add_data(missing_field); iq['setResponse'].add_data(missing_field)
iq['setResponse']['error']['var'] = "Output"; iq['setResponse']['error']['var'] = "Output"
iq['setResponse']['error']['text'] = error_msg; iq['setResponse']['error']['text'] = error_msg
iq.send(block=False); iq.send(block=False)
def _handle_direct_set(self, msg): def _handle_direct_set(self, msg):
""" """
@ -299,46 +299,46 @@ class XEP_0325(BasePlugin):
to the devices (in a separate thread). to the devices (in a separate thread).
If the verification fails, do nothing. If the verification fails, do nothing.
""" """
req_ok = True; req_ok = True
# Nodes # Nodes
process_nodes = []; process_nodes = []
if len(msg['set']['nodes']) > 0: if len(msg['set']['nodes']) > 0:
for n in msg['set']['nodes']: for n in msg['set']['nodes']:
if not n['nodeId'] in self.nodes: if not n['nodeId'] in self.nodes:
req_ok = False; req_ok = False
error_msg = "Invalid nodeId " + n['nodeId']; error_msg = "Invalid nodeId " + n['nodeId']
process_nodes = [n['nodeId'] for n in msg['set']['nodes']]; process_nodes = [n['nodeId'] for n in msg['set']['nodes']]
else: else:
process_nodes = self.nodes.keys(); process_nodes = self.nodes.keys()
# Fields - for control we need to find all in all devices, otherwise we reject # Fields - for control we need to find all in all devices, otherwise we reject
process_fields = []; process_fields = []
if len(msg['set']['datas']) > 0: if len(msg['set']['datas']) > 0:
for f in msg['set']['datas']: for f in msg['set']['datas']:
for node in self.nodes: for node in self.nodes:
if not self.nodes[node]["device"].has_control_field(f['name'], f._get_typename()): if not self.nodes[node]["device"].has_control_field(f['name'], f._get_typename()):
req_ok = False; req_ok = False
missing_field = f['name']; missing_field = f['name']
error_msg = "Invalid field " + f['name']; error_msg = "Invalid field " + f['name']
break; break
process_fields = [(f['name'], f._get_typename(), f['value']) for f in msg['set']['datas']]; process_fields = [(f['name'], f._get_typename(), f['value']) for f in msg['set']['datas']]
if req_ok: if req_ok:
session = self._new_session(); session = self._new_session()
self.sessions[session] = {"from": msg['from'], "to": msg['to']}; self.sessions[session] = {"from": msg['from'], "to": msg['to']}
self.sessions[session]["commTimers"] = {}; self.sessions[session]["commTimers"] = {}
self.sessions[session]["nodeDone"] = {}; self.sessions[session]["nodeDone"] = {}
self.sessions[session]["reply"] = False; self.sessions[session]["reply"] = False
self.sessions[session]["node_list"] = process_nodes; self.sessions[session]["node_list"] = process_nodes
if self.threaded: if self.threaded:
#print("starting thread") #print("starting thread")
tr_req = Thread(target=self._threaded_node_request, args=(session, process_fields)) tr_req = Thread(target=self._threaded_node_request, args=(session, process_fields))
tr_req.start() tr_req.start()
#print("started thread") #print("started thread")
else: else:
self._threaded_node_request(session, process_fields); self._threaded_node_request(session, process_fields)
def _threaded_node_request(self, session, process_fields): def _threaded_node_request(self, session, process_fields):
@ -351,13 +351,13 @@ class XEP_0325(BasePlugin):
(name, datatype, value) (name, datatype, value)
""" """
for node in self.sessions[session]["node_list"]: for node in self.sessions[session]["node_list"]:
self.sessions[session]["nodeDone"][node] = False; self.sessions[session]["nodeDone"][node] = False
for node in self.sessions[session]["node_list"]: for node in self.sessions[session]["node_list"]:
timer = Timer(self.nodes[node]['commTimeout'], self._event_comm_timeout, args=(session, node)); timer = Timer(self.nodes[node]['commTimeout'], self._event_comm_timeout, args=(session, node))
self.sessions[session]["commTimers"][node] = timer; self.sessions[session]["commTimers"][node] = timer
timer.start(); timer.start()
self.nodes[node]['device'].set_control_fields(process_fields, session=session, callback=self._device_set_command_callback); self.nodes[node]['device'].set_control_fields(process_fields, session=session, callback=self._device_set_command_callback)
def _event_comm_timeout(self, session, nodeId): def _event_comm_timeout(self, session, nodeId):
""" """
@ -373,24 +373,24 @@ class XEP_0325(BasePlugin):
if self.sessions[session]["reply"]: if self.sessions[session]["reply"]:
# Reply is exected when we are done # Reply is exected when we are done
iq = self.xmpp.Iq(); iq = self.xmpp.Iq()
iq['from'] = self.sessions[session]['to']; iq['from'] = self.sessions[session]['to']
iq['to'] = self.sessions[session]['from']; iq['to'] = self.sessions[session]['from']
iq['type'] = "error"; iq['type'] = "error"
iq['id'] = self.sessions[session]['seqnr']; iq['id'] = self.sessions[session]['seqnr']
iq['setResponse']['responseCode'] = "OtherError"; iq['setResponse']['responseCode'] = "OtherError"
iq['setResponse'].add_node(nodeId); iq['setResponse'].add_node(nodeId)
iq['setResponse']['error']['var'] = "Output"; iq['setResponse']['error']['var'] = "Output"
iq['setResponse']['error']['text'] = "Timeout."; iq['setResponse']['error']['text'] = "Timeout."
iq.send(block=False); iq.send(block=False)
## TODO - should we send one timeout per node?? ## TODO - should we send one timeout per node??
# Drop communication with this device and check if we are done # Drop communication with this device and check if we are done
self.sessions[session]["nodeDone"][nodeId] = True; self.sessions[session]["nodeDone"][nodeId] = True
if (self._all_nodes_done(session)): if (self._all_nodes_done(session)):
# The session is complete, delete it # The session is complete, delete it
del self.sessions[session]; del self.sessions[session]
def _all_nodes_done(self, session): def _all_nodes_done(self, session):
""" """
@ -401,8 +401,8 @@ class XEP_0325(BasePlugin):
""" """
for n in self.sessions[session]["nodeDone"]: for n in self.sessions[session]["nodeDone"]:
if not self.sessions[session]["nodeDone"][n]: if not self.sessions[session]["nodeDone"][n]:
return False; return False
return True; return True
def _device_set_command_callback(self, session, nodeId, result, error_field=None, error_msg=None): def _device_set_command_callback(self, session, nodeId, result, error_field=None, error_msg=None):
""" """
@ -428,45 +428,45 @@ class XEP_0325(BasePlugin):
return return
if result == "error": if result == "error":
self.sessions[session]["commTimers"][nodeId].cancel(); self.sessions[session]["commTimers"][nodeId].cancel()
if self.sessions[session]["reply"]: if self.sessions[session]["reply"]:
# Reply is exected when we are done # Reply is exected when we are done
iq = self.xmpp.Iq(); iq = self.xmpp.Iq()
iq['from'] = self.sessions[session]['to']; iq['from'] = self.sessions[session]['to']
iq['to'] = self.sessions[session]['from']; iq['to'] = self.sessions[session]['from']
iq['type'] = "error"; iq['type'] = "error"
iq['id'] = self.sessions[session]['seqnr']; iq['id'] = self.sessions[session]['seqnr']
iq['setResponse']['responseCode'] = "OtherError"; iq['setResponse']['responseCode'] = "OtherError"
iq['setResponse'].add_node(nodeId); iq['setResponse'].add_node(nodeId)
if error_field is not None: if error_field is not None:
iq['setResponse'].add_data(error_field); iq['setResponse'].add_data(error_field)
iq['setResponse']['error']['var'] = error_field; iq['setResponse']['error']['var'] = error_field
iq['setResponse']['error']['text'] = error_msg; iq['setResponse']['error']['text'] = error_msg
iq.send(block=False); iq.send(block=False)
# Drop communication with this device and check if we are done # Drop communication with this device and check if we are done
self.sessions[session]["nodeDone"][nodeId] = True; self.sessions[session]["nodeDone"][nodeId] = True
if (self._all_nodes_done(session)): if (self._all_nodes_done(session)):
# The session is complete, delete it # The session is complete, delete it
del self.sessions[session]; del self.sessions[session]
else: else:
self.sessions[session]["commTimers"][nodeId].cancel(); self.sessions[session]["commTimers"][nodeId].cancel()
self.sessions[session]["nodeDone"][nodeId] = True; self.sessions[session]["nodeDone"][nodeId] = True
if (self._all_nodes_done(session)): if (self._all_nodes_done(session)):
if self.sessions[session]["reply"]: if self.sessions[session]["reply"]:
# Reply is exected when we are done # Reply is exected when we are done
iq = self.xmpp.Iq(); iq = self.xmpp.Iq()
iq['from'] = self.sessions[session]['to']; iq['from'] = self.sessions[session]['to']
iq['to'] = self.sessions[session]['from']; iq['to'] = self.sessions[session]['from']
iq['type'] = "result"; iq['type'] = "result"
iq['id'] = self.sessions[session]['seqnr']; iq['id'] = self.sessions[session]['seqnr']
iq['setResponse']['responseCode'] = "OK"; iq['setResponse']['responseCode'] = "OK"
iq.send(block=False); iq.send(block=False)
# The session is complete, delete it # The session is complete, delete it
del self.sessions[session]; del self.sessions[session]
# ================================================================= # =================================================================
@ -512,21 +512,21 @@ class XEP_0325(BasePlugin):
fields -- Fields to set. List of tuple format: (name, typename, value). fields -- Fields to set. List of tuple format: (name, typename, value).
nodeIds -- [optional] Limits the request to the node Ids in this list. nodeIds -- [optional] Limits the request to the node Ids in this list.
""" """
iq = self.xmpp.Iq(); iq = self.xmpp.Iq()
iq['from'] = from_jid; iq['from'] = from_jid
iq['to'] = to_jid; iq['to'] = to_jid
seqnr = self._get_new_seqnr(); seqnr = self._get_new_seqnr()
iq['id'] = seqnr; iq['id'] = seqnr
iq['type'] = "set"; iq['type'] = "set"
if nodeIds is not None: if nodeIds is not None:
for nodeId in nodeIds: for nodeId in nodeIds:
iq['set'].add_node(nodeId); iq['set'].add_node(nodeId)
if fields is not None: if fields is not None:
for name, typename, value in fields: for name, typename, value in fields:
iq['set'].add_data(name=name, typename=typename, value=value); iq['set'].add_data(name=name, typename=typename, value=value)
self.sessions[seqnr] = {"from": iq['from'], "to": iq['to'], "callback": callback}; self.sessions[seqnr] = {"from": iq['from'], "to": iq['to'], "callback": callback}
iq.send(block=False); iq.send(block=False)
def set_command(self, from_jid, to_jid, fields, nodeIds=None): def set_command(self, from_jid, to_jid, fields, nodeIds=None):
""" """
@ -541,34 +541,34 @@ class XEP_0325(BasePlugin):
fields -- Fields to set. List of tuple format: (name, typename, value). fields -- Fields to set. List of tuple format: (name, typename, value).
nodeIds -- [optional] Limits the request to the node Ids in this list. nodeIds -- [optional] Limits the request to the node Ids in this list.
""" """
msg = self.xmpp.Message(); msg = self.xmpp.Message()
msg['from'] = from_jid; msg['from'] = from_jid
msg['to'] = to_jid; msg['to'] = to_jid
msg['type'] = "set"; msg['type'] = "set"
if nodeIds is not None: if nodeIds is not None:
for nodeId in nodeIds: for nodeId in nodeIds:
msg['set'].add_node(nodeId); msg['set'].add_node(nodeId)
if fields is not None: if fields is not None:
for name, typename, value in fields: for name, typename, value in fields:
msg['set'].add_data(name, typename, value); msg['set'].add_data(name, typename, value)
# We won't get any reply, so don't create a session # We won't get any reply, so don't create a session
msg.send(); msg.send()
def _handle_set_response(self, iq): def _handle_set_response(self, iq):
""" Received response from device(s) """ """ Received response from device(s) """
#print("ooh") #print("ooh")
seqnr = iq['id']; seqnr = iq['id']
from_jid = str(iq['from']); from_jid = str(iq['from'])
result = iq['setResponse']['responseCode']; result = iq['setResponse']['responseCode']
nodeIds = [n['name'] for n in iq['setResponse']['nodes']]; nodeIds = [n['name'] for n in iq['setResponse']['nodes']]
fields = [f['name'] for f in iq['setResponse']['datas']]; fields = [f['name'] for f in iq['setResponse']['datas']]
error_msg = None; error_msg = None
if not iq['setResponse'].find('error') is None and not iq['setResponse']['error']['text'] == "": if not iq['setResponse'].find('error') is None and not iq['setResponse']['error']['text'] == "":
error_msg = iq['setResponse']['error']['text']; error_msg = iq['setResponse']['error']['text']
callback = self.sessions[seqnr]["callback"]; callback = self.sessions[seqnr]["callback"]
callback(from_jid=from_jid, result=result, nodeIds=nodeIds, fields=fields, error_msg=error_msg); callback(from_jid=from_jid, result=result, nodeIds=nodeIds, fields=fields, error_msg=error_msg)

22
slixmpp/plugins/xep_0325/device.py
View File

@ -21,8 +21,8 @@ class Device(object):
""" """
def __init__(self, nodeId): def __init__(self, nodeId):
self.nodeId = nodeId; self.nodeId = nodeId
self.control_fields = {}; self.control_fields = {}
def has_control_field(self, field, typename): def has_control_field(self, field, typename):
""" """
@ -34,8 +34,8 @@ class Device(object):
typename -- The expected type typename -- The expected type
""" """
if field in self.control_fields and self.control_fields[field]["type"] == typename: if field in self.control_fields and self.control_fields[field]["type"] == typename:
return True; return True
return False; return False
def set_control_fields(self, fields, session, callback): def set_control_fields(self, fields, session, callback):
""" """
@ -69,12 +69,12 @@ class Device(object):
for name, typename, value in fields: for name, typename, value in fields:
if not self.has_control_field(name, typename): if not self.has_control_field(name, typename):
self._send_control_reject(session, name, "NotFound", callback) self._send_control_reject(session, name, "NotFound", callback)
return False; return False
for name, typename, value in fields: for name, typename, value in fields:
self._set_field_value(name, value) self._set_field_value(name, value)
callback(session, result="ok", nodeId=self.nodeId); callback(session, result="ok", nodeId=self.nodeId)
return True return True
def _send_control_reject(self, session, field, message, callback): def _send_control_reject(self, session, field, message, callback):
@ -87,7 +87,7 @@ class Device(object):
callback -- Callback function, see definition in callback -- Callback function, see definition in
set_control_fields function set_control_fields function
""" """
callback(session, result="error", nodeId=self.nodeId, error_field=field, error_msg=message); callback(session, result="error", nodeId=self.nodeId, error_field=field, error_msg=message)
def _add_control_field(self, name, typename, value): def _add_control_field(self, name, typename, value):
""" """
@ -100,7 +100,7 @@ class Device(object):
double, duration, int, long, time) double, duration, int, long, time)
value -- Field value value -- Field value
""" """
self.control_fields[name] = {"type": typename, "value": value}; self.control_fields[name] = {"type": typename, "value": value}
def _set_field_value(self, name, value): def _set_field_value(self, name, value):
""" """
@ -111,7 +111,7 @@ class Device(object):
value -- New value for the field value -- New value for the field
""" """
if name in self.control_fields: if name in self.control_fields:
self.control_fields[name]["value"] = value; self.control_fields[name]["value"] = value
def _get_field_value(self, name): def _get_field_value(self, name):
""" """
@ -121,5 +121,5 @@ class Device(object):
name -- Name of the field name -- Name of the field
""" """
if name in self.control_fields: if name in self.control_fields:
return self.control_fields[name]["value"]; return self.control_fields[name]["value"]
return None; return None

40
slixmpp/plugins/xep_0325/stanza/control.py
View File

@ -26,7 +26,7 @@ class ControlSet(ElementBase):
interfaces = set(['nodes','datas']) interfaces = set(['nodes','datas'])
def __init__(self, xml=None, parent=None): def __init__(self, xml=None, parent=None):
ElementBase.__init__(self, xml, parent); ElementBase.__init__(self, xml, parent)
self._nodes = set() self._nodes = set()
self._datas = set() self._datas = set()
@ -127,30 +127,30 @@ class ControlSet(ElementBase):
value -- The value of the data element value -- The value of the data element
""" """
if name not in self._datas: if name not in self._datas:
dataObj = None; dataObj = None
if typename == "boolean": if typename == "boolean":
dataObj = BooleanParameter(parent=self); dataObj = BooleanParameter(parent=self)
elif typename == "color": elif typename == "color":
dataObj = ColorParameter(parent=self); dataObj = ColorParameter(parent=self)
elif typename == "string": elif typename == "string":
dataObj = StringParameter(parent=self); dataObj = StringParameter(parent=self)
elif typename == "date": elif typename == "date":
dataObj = DateParameter(parent=self); dataObj = DateParameter(parent=self)
elif typename == "dateTime": elif typename == "dateTime":
dataObj = DateTimeParameter(parent=self); dataObj = DateTimeParameter(parent=self)
elif typename == "double": elif typename == "double":
dataObj = DoubleParameter(parent=self); dataObj = DoubleParameter(parent=self)
elif typename == "duration": elif typename == "duration":
dataObj = DurationParameter(parent=self); dataObj = DurationParameter(parent=self)
elif typename == "int": elif typename == "int":
dataObj = IntParameter(parent=self); dataObj = IntParameter(parent=self)
elif typename == "long": elif typename == "long":
dataObj = LongParameter(parent=self); dataObj = LongParameter(parent=self)
elif typename == "time": elif typename == "time":
dataObj = TimeParameter(parent=self); dataObj = TimeParameter(parent=self)
dataObj['name'] = name; dataObj['name'] = name
dataObj['value'] = value; dataObj['value'] = value
self._datas.add(name) self._datas.add(name)
self.iterables.append(dataObj) self.iterables.append(dataObj)
@ -217,7 +217,7 @@ class ControlSetResponse(ElementBase):
interfaces = set(['responseCode']) interfaces = set(['responseCode'])
def __init__(self, xml=None, parent=None): def __init__(self, xml=None, parent=None):
ElementBase.__init__(self, xml, parent); ElementBase.__init__(self, xml, parent)
self._nodes = set() self._nodes = set()
self._datas = set() self._datas = set()
@ -316,7 +316,7 @@ class ControlSetResponse(ElementBase):
if name not in self._datas: if name not in self._datas:
self._datas.add(name) self._datas.add(name)
data = ResponseParameter(parent=self) data = ResponseParameter(parent=self)
data['name'] = name; data['name'] = name
self.iterables.append(data) self.iterables.append(data)
return data return data
return None return None
@ -383,7 +383,7 @@ class Error(ElementBase):
value -- string value -- string
""" """
self.xml.text = value; self.xml.text = value
return self return self
def del_text(self): def del_text(self):
@ -398,7 +398,7 @@ class ResponseParameter(ElementBase):
namespace = 'urn:xmpp:iot:control' namespace = 'urn:xmpp:iot:control'
name = 'parameter' name = 'parameter'
plugin_attrib = name plugin_attrib = name
interfaces = set(['name']); interfaces = set(['name'])
class BaseParameter(ElementBase): class BaseParameter(ElementBase):
@ -419,10 +419,10 @@ class BaseParameter(ElementBase):
namespace = 'urn:xmpp:iot:control' namespace = 'urn:xmpp:iot:control'
name = 'baseParameter' name = 'baseParameter'
plugin_attrib = name plugin_attrib = name
interfaces = set(['name','value']); interfaces = set(['name','value'])
def _get_typename(self): def _get_typename(self):
return self.name; return self.name
class BooleanParameter(BaseParameter): class BooleanParameter(BaseParameter):
""" """