-
-
Notifications
You must be signed in to change notification settings - Fork 31.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support for Apple Push Notification Service #3756
Merged
Merged
Changes from 33 commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
d9e9520
added push notification implementation
sam-io f48fe52
some lint changes
sam-io 0762673
added docs
sam-io 9f9a8b6
added push notification implementation
sam-io 07e79eb
some lint changes
sam-io bc5eaa2
added docs
sam-io f4c314f
Merge branch 'dev' of github.com:sam-io/home-assistant into dev
sam-io 2e6317f
Fixed comment formatting issues
sam-io 837cfd0
Added requirments
sam-io ffd85ca
Update requirements_all.txt
sam-io ef77e1d
Update apns.py
sam-io f57366e
re-generated requirments_all.txt
sam-io 941ad84
Added link to online docs
sam-io 087c504
added push notification implementation
sam-io 4ad4852
some lint changes
sam-io cced763
added docs
sam-io 2aff3c5
added push notification implementation
sam-io 4176709
some lint changes
sam-io 7aeef2a
added docs
sam-io ad77092
Fixed comment formatting issues
sam-io 35090e1
Added requirments
sam-io 59fa36e
Update requirements_all.txt
sam-io ed29822
Update apns.py
sam-io 8539613
re-generated requirments_all.txt
sam-io 9ebaed2
Added link to online docs
sam-io a2fc44e
Merge branch 'dev' of github.com:sam-io/home-assistant into dev
sam-io 7e55ffb
changed to use http/2 library for push notifications
sam-io df34179
fixed lint issue
sam-io aab52d4
fixed test that fails on CI
sam-io 41dafdc
another go at fixing test that fails on CI
sam-io 8d87b04
another go at fixing test that fails on CI
sam-io f89e338
another go at fixing test that fails on CI
sam-io 2692154
added missing docstring
sam-io f10744f
moved service description to main services.yaml file
sam-io c2a671c
renamed apns service
sam-io File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,289 @@ | ||
""" | ||
APNS Notification platform. | ||
|
||
For more details about this platform, please refer to the documentation at | ||
https://home-assistant.io/components/notify.apns/ | ||
""" | ||
import logging | ||
import os | ||
import voluptuous as vol | ||
|
||
from homeassistant.helpers.event import track_state_change | ||
from homeassistant.config import load_yaml_config_file | ||
from homeassistant.components.notify import ( | ||
ATTR_TARGET, ATTR_DATA, BaseNotificationService) | ||
import homeassistant.helpers.config_validation as cv | ||
from homeassistant.helpers import template as template_helper | ||
|
||
DOMAIN = "apns" | ||
APNS_DEVICES = "apns.yaml" | ||
DEVICE_TRACKER_DOMAIN = "device_tracker" | ||
SERVICE_REGISTER = "register" | ||
|
||
ATTR_PUSH_ID = "push_id" | ||
ATTR_NAME = "name" | ||
|
||
REGISTER_SERVICE_SCHEMA = vol.Schema({ | ||
vol.Required(ATTR_PUSH_ID): cv.string, | ||
vol.Optional(ATTR_NAME, default=None): cv.string, | ||
}) | ||
|
||
REQUIREMENTS = ["apns2==0.1.1"] | ||
|
||
|
||
def get_service(hass, config): | ||
"""Return push service.""" | ||
descriptions = load_yaml_config_file( | ||
os.path.join(os.path.dirname(__file__), 'apns_services.yaml')) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Dont use a own service yaml. Add to service.yaml like other platform do... |
||
|
||
name = config.get("name") | ||
if name is None: | ||
logging.error("Name must be specified.") | ||
return None | ||
|
||
cert_file = config.get('cert_file') | ||
if cert_file is None: | ||
logging.error("Certificate must be specified.") | ||
return None | ||
|
||
topic = config.get('topic') | ||
if topic is None: | ||
logging.error("Topic must be specified.") | ||
return None | ||
|
||
sandbox = bool(config.get('sandbox', False)) | ||
|
||
service = ApnsNotificationService(hass, name, topic, sandbox, cert_file) | ||
hass.services.register(DOMAIN, | ||
name, | ||
service.register, | ||
descriptions.get(SERVICE_REGISTER), | ||
schema=REGISTER_SERVICE_SCHEMA) | ||
return service | ||
|
||
|
||
class ApnsDevice(object): | ||
""" | ||
Apns Device class. | ||
|
||
Stores information about a device that is | ||
registered for push notifications. | ||
""" | ||
|
||
def __init__(self, push_id, name, tracking_device_id=None, disabled=False): | ||
"""Initialize Apns Device.""" | ||
self.device_push_id = push_id | ||
self.device_name = name | ||
self.tracking_id = tracking_device_id | ||
self.device_disabled = disabled | ||
|
||
@property | ||
def push_id(self): | ||
"""The apns id for the device.""" | ||
return self.device_push_id | ||
|
||
@property | ||
def name(self): | ||
"""The friendly name for the device.""" | ||
return self.device_name | ||
|
||
@property | ||
def tracking_device_id(self): | ||
""" | ||
Device Id. | ||
|
||
The id of a device that is tracked by the device | ||
tracking component. | ||
""" | ||
return self.tracking_id | ||
|
||
@property | ||
def full_tracking_device_id(self): | ||
""" | ||
Fully qualified device id. | ||
|
||
The full id of a device that is tracked by the device | ||
tracking component. | ||
""" | ||
return DEVICE_TRACKER_DOMAIN + '.' + self.tracking_id | ||
|
||
@property | ||
def disabled(self): | ||
"""Should receive notifications.""" | ||
return self.device_disabled | ||
|
||
def disable(self): | ||
"""Disable the device from recieving notifications.""" | ||
self.device_disabled = True | ||
|
||
def __eq__(self, other): | ||
"""Return the comparision.""" | ||
if isinstance(other, self.__class__): | ||
return self.push_id == other.push_id and self.name == other.name | ||
return NotImplemented | ||
|
||
def __ne__(self, other): | ||
"""Return the comparision.""" | ||
return not self.__eq__(other) | ||
|
||
|
||
class ApnsNotificationService(BaseNotificationService): | ||
"""Implement the notification service for the APNS service.""" | ||
|
||
# pylint: disable=too-many-arguments | ||
# pylint: disable=too-many-instance-attributes | ||
def __init__(self, hass, app_name, topic, sandbox, cert_file): | ||
"""Initialize APNS application.""" | ||
self.hass = hass | ||
self.app_name = app_name | ||
self.sandbox = sandbox | ||
self.certificate = cert_file | ||
self.yaml_path = hass.config.path(app_name + '_' + APNS_DEVICES) | ||
self.devices = {} | ||
self.device_states = {} | ||
self.topic = topic | ||
if os.path.isfile(self.yaml_path): | ||
self.devices = { | ||
str(key): ApnsDevice( | ||
str(key), | ||
value.get('name'), | ||
value.get('tracking_device_id'), | ||
value.get('disabled', False) | ||
) | ||
for (key, value) in | ||
load_yaml_config_file(self.yaml_path).items() | ||
} | ||
|
||
tracking_ids = [ | ||
device.full_tracking_device_id | ||
for (key, device) in self.devices.items() | ||
if device.tracking_device_id is not None | ||
] | ||
track_state_change( | ||
hass, | ||
tracking_ids, | ||
self.device_state_changed_listener) | ||
|
||
def device_state_changed_listener(self, entity_id, from_s, to_s): | ||
""" | ||
Listener for sate change. | ||
|
||
Track device state change if a device | ||
has a tracking id specified. | ||
""" | ||
self.device_states[entity_id] = str(to_s.state) | ||
return | ||
|
||
@staticmethod | ||
def write_device(out, device): | ||
"""Write a single device to file.""" | ||
attributes = [] | ||
if device.name is not None: | ||
attributes.append( | ||
'name: {}'.format(device.name)) | ||
if device.tracking_device_id is not None: | ||
attributes.append( | ||
'tracking_device_id: {}'.format(device.tracking_device_id)) | ||
if device.disabled: | ||
attributes.append('disabled: True') | ||
|
||
out.write(device.push_id) | ||
out.write(": {") | ||
if len(attributes) > 0: | ||
separator = ", " | ||
out.write(separator.join(attributes)) | ||
|
||
out.write("}\n") | ||
|
||
def write_devices(self): | ||
"""Write all known devices to file.""" | ||
with open(self.yaml_path, 'w+') as out: | ||
for _, device in self.devices.items(): | ||
ApnsNotificationService.write_device(out, device) | ||
|
||
def register(self, call): | ||
"""Register a device to receive push messages.""" | ||
push_id = call.data.get(ATTR_PUSH_ID) | ||
if push_id is None: | ||
return False | ||
|
||
device_name = call.data.get(ATTR_NAME) | ||
current_device = self.devices.get(push_id) | ||
current_tracking_id = None if current_device is None \ | ||
else current_device.tracking_device_id | ||
|
||
device = ApnsDevice( | ||
push_id, | ||
device_name, | ||
current_tracking_id) | ||
|
||
if current_device is None: | ||
self.devices[push_id] = device | ||
with open(self.yaml_path, 'a') as out: | ||
self.write_device(out, device) | ||
return True | ||
|
||
if device != current_device: | ||
self.devices[push_id] = device | ||
self.write_devices() | ||
|
||
return True | ||
|
||
def send_message(self, message=None, **kwargs): | ||
"""Send push message to registered devices.""" | ||
from apns2.client import APNsClient | ||
from apns2.payload import Payload | ||
from apns2.errors import Unregistered | ||
|
||
apns = APNsClient( | ||
self.certificate, | ||
use_sandbox=self.sandbox, | ||
use_alternative_port=False) | ||
|
||
device_state = kwargs.get(ATTR_TARGET) | ||
message_data = kwargs.get(ATTR_DATA) | ||
|
||
if message_data is None: | ||
message_data = {} | ||
|
||
if isinstance(message, str): | ||
rendered_message = message | ||
elif isinstance(message, template_helper.Template): | ||
rendered_message = message.render() | ||
else: | ||
rendered_message = "" | ||
|
||
payload = Payload( | ||
alert=rendered_message, | ||
badge=message_data.get("badge"), | ||
sound=message_data.get("sound"), | ||
category=message_data.get("category"), | ||
custom=message_data.get("custom", {}), | ||
content_available=message_data.get("content_available", False)) | ||
|
||
device_update = False | ||
|
||
for push_id, device in self.devices.items(): | ||
if not device.disabled: | ||
state = None | ||
if device.tracking_device_id is not None: | ||
state = self.device_states.get( | ||
device.full_tracking_device_id) | ||
|
||
if device_state is None or state == str(device_state): | ||
try: | ||
apns.send_notification( | ||
push_id, | ||
payload, | ||
topic=self.topic) | ||
except Unregistered: | ||
logging.error( | ||
"Device %s has unregistered.", | ||
push_id) | ||
device_update = True | ||
device.disable() | ||
|
||
if device_update: | ||
self.write_devices() | ||
|
||
return True |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
register: | ||
description: Registers a device to recieve push notifications. | ||
|
||
fields: | ||
push_id: | ||
description: The device token, a 64 character hex string (256 bits). The device token is provided to you by your client app, which receives the token after registering itself with the remote notification service. | ||
example: '72f2a8633655c5ce574fdc9b2b34ff8abdfc3b739b6ceb7a9ff06c1cbbf99f62' | ||
|
||
name: | ||
description: A friendly name for the device (optional). | ||
example: 'Sam''s iPhone' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you rename it
apns_register
to indicate that it is part of the apns platform?