Black
This commit is contained in:
1 parent
da05dfe708
commit
4de97abc3a
2676 files changed
+163166
-140084
No files matched your search
@@ -16,27 +16,37 @@ from homeassistant.components import websocket_api
|
||||
from homeassistant.components.frontend import add_manifest_json_key
|
||||
from homeassistant.components.http import HomeAssistantView
|
||||
from homeassistant.const import (
|
||||
HTTP_BAD_REQUEST, HTTP_INTERNAL_SERVER_ERROR, HTTP_UNAUTHORIZED, URL_ROOT)
|
||||
HTTP_BAD_REQUEST,
|
||||
HTTP_INTERNAL_SERVER_ERROR,
|
||||
HTTP_UNAUTHORIZED,
|
||||
URL_ROOT,
|
||||
)
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.helpers import config_validation as cv
|
||||
from homeassistant.util import ensure_unique_string
|
||||
from homeassistant.util.json import load_json, save_json
|
||||
|
||||
from homeassistant.components.notify import (
|
||||
ATTR_DATA, ATTR_TARGET, ATTR_TITLE, ATTR_TITLE_DEFAULT, DOMAIN,
|
||||
PLATFORM_SCHEMA, BaseNotificationService)
|
||||
ATTR_DATA,
|
||||
ATTR_TARGET,
|
||||
ATTR_TITLE,
|
||||
ATTR_TITLE_DEFAULT,
|
||||
DOMAIN,
|
||||
PLATFORM_SCHEMA,
|
||||
BaseNotificationService,
|
||||
)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
REGISTRATIONS_FILE = 'html5_push_registrations.conf'
|
||||
REGISTRATIONS_FILE = "html5_push_registrations.conf"
|
||||
|
||||
SERVICE_DISMISS = 'html5_dismiss'
|
||||
SERVICE_DISMISS = "html5_dismiss"
|
||||
|
||||
ATTR_GCM_SENDER_ID = 'gcm_sender_id'
|
||||
ATTR_GCM_API_KEY = 'gcm_api_key'
|
||||
ATTR_VAPID_PUB_KEY = 'vapid_pub_key'
|
||||
ATTR_VAPID_PRV_KEY = 'vapid_prv_key'
|
||||
ATTR_VAPID_EMAIL = 'vapid_email'
|
||||
ATTR_GCM_SENDER_ID = "gcm_sender_id"
|
||||
ATTR_GCM_API_KEY = "gcm_api_key"
|
||||
ATTR_VAPID_PUB_KEY = "vapid_pub_key"
|
||||
ATTR_VAPID_PRV_KEY = "vapid_prv_key"
|
||||
ATTR_VAPID_EMAIL = "vapid_email"
|
||||
|
||||
|
||||
def gcm_api_deprecated(value):
|
||||
@@ -46,92 +56,114 @@ def gcm_api_deprecated(value):
|
||||
"Configuring html5_push_notifications via the GCM api"
|
||||
" has been deprecated and will stop working after April 11,"
|
||||
" 2019. Use the VAPID configuration instead. For instructions,"
|
||||
" see https://www.home-assistant.io/components/notify.html5/")
|
||||
" see https://www.home-assistant.io/components/notify.html5/"
|
||||
)
|
||||
return value
|
||||
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(ATTR_GCM_SENDER_ID):
|
||||
vol.All(cv.string, gcm_api_deprecated),
|
||||
vol.Optional(ATTR_GCM_API_KEY): cv.string,
|
||||
vol.Optional(ATTR_VAPID_PUB_KEY): cv.string,
|
||||
vol.Optional(ATTR_VAPID_PRV_KEY): cv.string,
|
||||
vol.Optional(ATTR_VAPID_EMAIL): cv.string,
|
||||
})
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
||||
{
|
||||
vol.Optional(ATTR_GCM_SENDER_ID): vol.All(cv.string, gcm_api_deprecated),
|
||||
vol.Optional(ATTR_GCM_API_KEY): cv.string,
|
||||
vol.Optional(ATTR_VAPID_PUB_KEY): cv.string,
|
||||
vol.Optional(ATTR_VAPID_PRV_KEY): cv.string,
|
||||
vol.Optional(ATTR_VAPID_EMAIL): cv.string,
|
||||
}
|
||||
)
|
||||
|
||||
ATTR_SUBSCRIPTION = 'subscription'
|
||||
ATTR_BROWSER = 'browser'
|
||||
ATTR_NAME = 'name'
|
||||
ATTR_SUBSCRIPTION = "subscription"
|
||||
ATTR_BROWSER = "browser"
|
||||
ATTR_NAME = "name"
|
||||
|
||||
ATTR_ENDPOINT = 'endpoint'
|
||||
ATTR_KEYS = 'keys'
|
||||
ATTR_AUTH = 'auth'
|
||||
ATTR_P256DH = 'p256dh'
|
||||
ATTR_EXPIRATIONTIME = 'expirationTime'
|
||||
ATTR_ENDPOINT = "endpoint"
|
||||
ATTR_KEYS = "keys"
|
||||
ATTR_AUTH = "auth"
|
||||
ATTR_P256DH = "p256dh"
|
||||
ATTR_EXPIRATIONTIME = "expirationTime"
|
||||
|
||||
ATTR_TAG = 'tag'
|
||||
ATTR_ACTION = 'action'
|
||||
ATTR_ACTIONS = 'actions'
|
||||
ATTR_TYPE = 'type'
|
||||
ATTR_URL = 'url'
|
||||
ATTR_DISMISS = 'dismiss'
|
||||
ATTR_PRIORITY = 'priority'
|
||||
DEFAULT_PRIORITY = 'normal'
|
||||
ATTR_TTL = 'ttl'
|
||||
ATTR_TAG = "tag"
|
||||
ATTR_ACTION = "action"
|
||||
ATTR_ACTIONS = "actions"
|
||||
ATTR_TYPE = "type"
|
||||
ATTR_URL = "url"
|
||||
ATTR_DISMISS = "dismiss"
|
||||
ATTR_PRIORITY = "priority"
|
||||
DEFAULT_PRIORITY = "normal"
|
||||
ATTR_TTL = "ttl"
|
||||
DEFAULT_TTL = 86400
|
||||
|
||||
ATTR_JWT = 'jwt'
|
||||
ATTR_JWT = "jwt"
|
||||
|
||||
WS_TYPE_APPKEY = 'notify/html5/appkey'
|
||||
SCHEMA_WS_APPKEY = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend({
|
||||
vol.Required('type'): WS_TYPE_APPKEY
|
||||
})
|
||||
WS_TYPE_APPKEY = "notify/html5/appkey"
|
||||
SCHEMA_WS_APPKEY = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
||||
{vol.Required("type"): WS_TYPE_APPKEY}
|
||||
)
|
||||
|
||||
# The number of days after the moment a notification is sent that a JWT
|
||||
# is valid.
|
||||
JWT_VALID_DAYS = 7
|
||||
|
||||
KEYS_SCHEMA = vol.All(
|
||||
dict, vol.Schema({
|
||||
vol.Required(ATTR_AUTH): cv.string,
|
||||
vol.Required(ATTR_P256DH): cv.string,
|
||||
})
|
||||
dict,
|
||||
vol.Schema(
|
||||
{vol.Required(ATTR_AUTH): cv.string, vol.Required(ATTR_P256DH): cv.string}
|
||||
),
|
||||
)
|
||||
|
||||
SUBSCRIPTION_SCHEMA = vol.All(
|
||||
dict, vol.Schema({
|
||||
# pylint: disable=no-value-for-parameter
|
||||
vol.Required(ATTR_ENDPOINT): vol.Url(),
|
||||
vol.Required(ATTR_KEYS): KEYS_SCHEMA,
|
||||
vol.Optional(ATTR_EXPIRATIONTIME): vol.Any(None, cv.positive_int),
|
||||
})
|
||||
dict,
|
||||
vol.Schema(
|
||||
{
|
||||
# pylint: disable=no-value-for-parameter
|
||||
vol.Required(ATTR_ENDPOINT): vol.Url(),
|
||||
vol.Required(ATTR_KEYS): KEYS_SCHEMA,
|
||||
vol.Optional(ATTR_EXPIRATIONTIME): vol.Any(None, cv.positive_int),
|
||||
}
|
||||
),
|
||||
)
|
||||
|
||||
DISMISS_SERVICE_SCHEMA = vol.Schema({
|
||||
vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [cv.string]),
|
||||
vol.Optional(ATTR_DATA): dict,
|
||||
})
|
||||
DISMISS_SERVICE_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [cv.string]),
|
||||
vol.Optional(ATTR_DATA): dict,
|
||||
}
|
||||
)
|
||||
|
||||
REGISTER_SCHEMA = vol.Schema({
|
||||
vol.Required(ATTR_SUBSCRIPTION): SUBSCRIPTION_SCHEMA,
|
||||
vol.Required(ATTR_BROWSER): vol.In(['chrome', 'firefox']),
|
||||
vol.Optional(ATTR_NAME): cv.string
|
||||
})
|
||||
REGISTER_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Required(ATTR_SUBSCRIPTION): SUBSCRIPTION_SCHEMA,
|
||||
vol.Required(ATTR_BROWSER): vol.In(["chrome", "firefox"]),
|
||||
vol.Optional(ATTR_NAME): cv.string,
|
||||
}
|
||||
)
|
||||
|
||||
CALLBACK_EVENT_PAYLOAD_SCHEMA = vol.Schema({
|
||||
vol.Required(ATTR_TAG): cv.string,
|
||||
vol.Required(ATTR_TYPE): vol.In(['received', 'clicked', 'closed']),
|
||||
vol.Required(ATTR_TARGET): cv.string,
|
||||
vol.Optional(ATTR_ACTION): cv.string,
|
||||
vol.Optional(ATTR_DATA): dict,
|
||||
})
|
||||
CALLBACK_EVENT_PAYLOAD_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Required(ATTR_TAG): cv.string,
|
||||
vol.Required(ATTR_TYPE): vol.In(["received", "clicked", "closed"]),
|
||||
vol.Required(ATTR_TARGET): cv.string,
|
||||
vol.Optional(ATTR_ACTION): cv.string,
|
||||
vol.Optional(ATTR_DATA): dict,
|
||||
}
|
||||
)
|
||||
|
||||
NOTIFY_CALLBACK_EVENT = 'html5_notification'
|
||||
NOTIFY_CALLBACK_EVENT = "html5_notification"
|
||||
|
||||
# Badge and timestamp are Chrome specific (not in official spec)
|
||||
HTML5_SHOWNOTIFICATION_PARAMETERS = (
|
||||
'actions', 'badge', 'body', 'dir', 'icon', 'image', 'lang',
|
||||
'renotify', 'requireInteraction', 'tag', 'timestamp', 'vibrate')
|
||||
"actions",
|
||||
"badge",
|
||||
"body",
|
||||
"dir",
|
||||
"icon",
|
||||
"image",
|
||||
"lang",
|
||||
"renotify",
|
||||
"requireInteraction",
|
||||
"tag",
|
||||
"timestamp",
|
||||
"vibrate",
|
||||
)
|
||||
|
||||
|
||||
def get_service(hass, config, discovery_info=None):
|
||||
@@ -148,27 +180,24 @@ def get_service(hass, config, discovery_info=None):
|
||||
vapid_email = config.get(ATTR_VAPID_EMAIL)
|
||||
|
||||
def websocket_appkey(hass, connection, msg):
|
||||
connection.send_message(
|
||||
websocket_api.result_message(msg['id'], vapid_pub_key))
|
||||
connection.send_message(websocket_api.result_message(msg["id"], vapid_pub_key))
|
||||
|
||||
hass.components.websocket_api.async_register_command(
|
||||
WS_TYPE_APPKEY, websocket_appkey, SCHEMA_WS_APPKEY
|
||||
)
|
||||
|
||||
hass.http.register_view(
|
||||
HTML5PushRegistrationView(registrations, json_path))
|
||||
hass.http.register_view(HTML5PushRegistrationView(registrations, json_path))
|
||||
hass.http.register_view(HTML5PushCallbackView(registrations))
|
||||
|
||||
gcm_api_key = config.get(ATTR_GCM_API_KEY)
|
||||
gcm_sender_id = config.get(ATTR_GCM_SENDER_ID)
|
||||
|
||||
if gcm_sender_id is not None:
|
||||
add_manifest_json_key(
|
||||
ATTR_GCM_SENDER_ID, config.get(ATTR_GCM_SENDER_ID))
|
||||
add_manifest_json_key(ATTR_GCM_SENDER_ID, config.get(ATTR_GCM_SENDER_ID))
|
||||
|
||||
return HTML5NotificationService(
|
||||
hass, gcm_api_key, vapid_prv_key, vapid_email, registrations,
|
||||
json_path)
|
||||
hass, gcm_api_key, vapid_prv_key, vapid_email, registrations, json_path
|
||||
)
|
||||
|
||||
|
||||
def _load_config(filename):
|
||||
@@ -183,8 +212,8 @@ def _load_config(filename):
|
||||
class HTML5PushRegistrationView(HomeAssistantView):
|
||||
"""Accepts push registrations from a browser."""
|
||||
|
||||
url = '/api/notify.html5'
|
||||
name = 'api:notify.html5'
|
||||
url = "/api/notify.html5"
|
||||
name = "api:notify.html5"
|
||||
|
||||
def __init__(self, registrations, json_path):
|
||||
"""Init HTML5PushRegistrationView."""
|
||||
@@ -196,12 +225,11 @@ class HTML5PushRegistrationView(HomeAssistantView):
|
||||
try:
|
||||
data = await request.json()
|
||||
except ValueError:
|
||||
return self.json_message('Invalid JSON', HTTP_BAD_REQUEST)
|
||||
return self.json_message("Invalid JSON", HTTP_BAD_REQUEST)
|
||||
try:
|
||||
data = REGISTER_SCHEMA(data)
|
||||
except vol.Invalid as ex:
|
||||
return self.json_message(
|
||||
humanize_error(data, ex), HTTP_BAD_REQUEST)
|
||||
return self.json_message(humanize_error(data, ex), HTTP_BAD_REQUEST)
|
||||
|
||||
devname = data.get(ATTR_NAME)
|
||||
data.pop(ATTR_NAME, None)
|
||||
@@ -212,12 +240,10 @@ class HTML5PushRegistrationView(HomeAssistantView):
|
||||
self.registrations[name] = data
|
||||
|
||||
try:
|
||||
hass = request.app['hass']
|
||||
hass = request.app["hass"]
|
||||
|
||||
await hass.async_add_job(save_json, self.json_path,
|
||||
self.registrations)
|
||||
return self.json_message(
|
||||
'Push notification subscriber registered.')
|
||||
await hass.async_add_job(save_json, self.json_path, self.registrations)
|
||||
return self.json_message("Push notification subscriber registered.")
|
||||
except HomeAssistantError:
|
||||
if previous_registration is not None:
|
||||
self.registrations[name] = previous_registration
|
||||
@@ -225,7 +251,8 @@ class HTML5PushRegistrationView(HomeAssistantView):
|
||||
self.registrations.pop(name)
|
||||
|
||||
return self.json_message(
|
||||
'Error saving registration.', HTTP_INTERNAL_SERVER_ERROR)
|
||||
"Error saving registration.", HTTP_INTERNAL_SERVER_ERROR
|
||||
)
|
||||
|
||||
def find_registration_name(self, data, suggested=None):
|
||||
"""Find a registration name matching data or generate a unique one."""
|
||||
@@ -234,15 +261,14 @@ class HTML5PushRegistrationView(HomeAssistantView):
|
||||
subscription = registration.get(ATTR_SUBSCRIPTION)
|
||||
if subscription.get(ATTR_ENDPOINT) == endpoint:
|
||||
return key
|
||||
return ensure_unique_string(suggested or 'unnamed device',
|
||||
self.registrations)
|
||||
return ensure_unique_string(suggested or "unnamed device", self.registrations)
|
||||
|
||||
async def delete(self, request):
|
||||
"""Delete a registration."""
|
||||
try:
|
||||
data = await request.json()
|
||||
except ValueError:
|
||||
return self.json_message('Invalid JSON', HTTP_BAD_REQUEST)
|
||||
return self.json_message("Invalid JSON", HTTP_BAD_REQUEST)
|
||||
|
||||
subscription = data.get(ATTR_SUBSCRIPTION)
|
||||
|
||||
@@ -255,29 +281,29 @@ class HTML5PushRegistrationView(HomeAssistantView):
|
||||
|
||||
if not found:
|
||||
# If not found, unregistering was already done. Return 200
|
||||
return self.json_message('Registration not found.')
|
||||
return self.json_message("Registration not found.")
|
||||
|
||||
reg = self.registrations.pop(found)
|
||||
|
||||
try:
|
||||
hass = request.app['hass']
|
||||
hass = request.app["hass"]
|
||||
|
||||
await hass.async_add_job(save_json, self.json_path,
|
||||
self.registrations)
|
||||
await hass.async_add_job(save_json, self.json_path, self.registrations)
|
||||
except HomeAssistantError:
|
||||
self.registrations[found] = reg
|
||||
return self.json_message(
|
||||
'Error saving registration.', HTTP_INTERNAL_SERVER_ERROR)
|
||||
"Error saving registration.", HTTP_INTERNAL_SERVER_ERROR
|
||||
)
|
||||
|
||||
return self.json_message('Push notification subscriber unregistered.')
|
||||
return self.json_message("Push notification subscriber unregistered.")
|
||||
|
||||
|
||||
class HTML5PushCallbackView(HomeAssistantView):
|
||||
"""Accepts push registrations from a browser."""
|
||||
|
||||
requires_auth = False
|
||||
url = '/api/notify.html5/callback'
|
||||
name = 'api:notify.html5/callback'
|
||||
url = "/api/notify.html5/callback"
|
||||
name = "api:notify.html5/callback"
|
||||
|
||||
def __init__(self, registrations):
|
||||
"""Init HTML5PushCallbackView."""
|
||||
@@ -301,36 +327,40 @@ class HTML5PushCallbackView(HomeAssistantView):
|
||||
except jwt.exceptions.DecodeError:
|
||||
pass
|
||||
|
||||
return self.json_message('No target found in JWT',
|
||||
status_code=HTTP_UNAUTHORIZED)
|
||||
return self.json_message(
|
||||
"No target found in JWT", status_code=HTTP_UNAUTHORIZED
|
||||
)
|
||||
|
||||
# The following is based on code from Auth0
|
||||
# https://auth0.com/docs/quickstart/backend/python
|
||||
def check_authorization_header(self, request):
|
||||
"""Check the authorization header."""
|
||||
import jwt
|
||||
|
||||
auth = request.headers.get(AUTHORIZATION, None)
|
||||
if not auth:
|
||||
return self.json_message('Authorization header is expected',
|
||||
status_code=HTTP_UNAUTHORIZED)
|
||||
return self.json_message(
|
||||
"Authorization header is expected", status_code=HTTP_UNAUTHORIZED
|
||||
)
|
||||
|
||||
parts = auth.split()
|
||||
|
||||
if parts[0].lower() != 'bearer':
|
||||
return self.json_message('Authorization header must '
|
||||
'start with Bearer',
|
||||
status_code=HTTP_UNAUTHORIZED)
|
||||
if parts[0].lower() != "bearer":
|
||||
return self.json_message(
|
||||
"Authorization header must " "start with Bearer",
|
||||
status_code=HTTP_UNAUTHORIZED,
|
||||
)
|
||||
if len(parts) != 2:
|
||||
return self.json_message('Authorization header must '
|
||||
'be Bearer token',
|
||||
status_code=HTTP_UNAUTHORIZED)
|
||||
return self.json_message(
|
||||
"Authorization header must " "be Bearer token",
|
||||
status_code=HTTP_UNAUTHORIZED,
|
||||
)
|
||||
|
||||
token = parts[1]
|
||||
try:
|
||||
payload = self.decode_jwt(token)
|
||||
except jwt.exceptions.InvalidTokenError:
|
||||
return self.json_message('token is invalid',
|
||||
status_code=HTTP_UNAUTHORIZED)
|
||||
return self.json_message("token is invalid", status_code=HTTP_UNAUTHORIZED)
|
||||
return payload
|
||||
|
||||
async def post(self, request):
|
||||
@@ -342,7 +372,7 @@ class HTML5PushCallbackView(HomeAssistantView):
|
||||
try:
|
||||
data = await request.json()
|
||||
except ValueError:
|
||||
return self.json_message('Invalid JSON', HTTP_BAD_REQUEST)
|
||||
return self.json_message("Invalid JSON", HTTP_BAD_REQUEST)
|
||||
|
||||
event_payload = {
|
||||
ATTR_TAG: data.get(ATTR_TAG),
|
||||
@@ -359,20 +389,20 @@ class HTML5PushCallbackView(HomeAssistantView):
|
||||
try:
|
||||
event_payload = CALLBACK_EVENT_PAYLOAD_SCHEMA(event_payload)
|
||||
except vol.Invalid as ex:
|
||||
_LOGGER.warning("Callback event payload is not valid: %s",
|
||||
humanize_error(event_payload, ex))
|
||||
_LOGGER.warning(
|
||||
"Callback event payload is not valid: %s",
|
||||
humanize_error(event_payload, ex),
|
||||
)
|
||||
|
||||
event_name = '{}.{}'.format(NOTIFY_CALLBACK_EVENT,
|
||||
event_payload[ATTR_TYPE])
|
||||
request.app['hass'].bus.fire(event_name, event_payload)
|
||||
return self.json({'status': 'ok', 'event': event_payload[ATTR_TYPE]})
|
||||
event_name = "{}.{}".format(NOTIFY_CALLBACK_EVENT, event_payload[ATTR_TYPE])
|
||||
request.app["hass"].bus.fire(event_name, event_payload)
|
||||
return self.json({"status": "ok", "event": event_payload[ATTR_TYPE]})
|
||||
|
||||
|
||||
class HTML5NotificationService(BaseNotificationService):
|
||||
"""Implement the notification service for HTML5."""
|
||||
|
||||
def __init__(self, hass, gcm_key, vapid_prv, vapid_email, registrations,
|
||||
json_path):
|
||||
def __init__(self, hass, gcm_key, vapid_prv, vapid_email, registrations, json_path):
|
||||
"""Initialize the service."""
|
||||
self._gcm_key = gcm_key
|
||||
self._vapid_prv = vapid_prv
|
||||
@@ -394,8 +424,11 @@ class HTML5NotificationService(BaseNotificationService):
|
||||
await self.async_dismiss(**kwargs)
|
||||
|
||||
hass.services.async_register(
|
||||
DOMAIN, SERVICE_DISMISS, async_dismiss_message,
|
||||
schema=DISMISS_SERVICE_SCHEMA)
|
||||
DOMAIN,
|
||||
SERVICE_DISMISS,
|
||||
async_dismiss_message,
|
||||
schema=DISMISS_SERVICE_SCHEMA,
|
||||
)
|
||||
|
||||
@property
|
||||
def targets(self):
|
||||
@@ -409,11 +442,7 @@ class HTML5NotificationService(BaseNotificationService):
|
||||
"""Dismisses a notification."""
|
||||
data = kwargs.get(ATTR_DATA)
|
||||
tag = data.get(ATTR_TAG) if data else ""
|
||||
payload = {
|
||||
ATTR_TAG: tag,
|
||||
ATTR_DISMISS: True,
|
||||
ATTR_DATA: {}
|
||||
}
|
||||
payload = {ATTR_TAG: tag, ATTR_DISMISS: True, ATTR_DATA: {}}
|
||||
|
||||
self._push_message(payload, **kwargs)
|
||||
|
||||
@@ -422,19 +451,18 @@ class HTML5NotificationService(BaseNotificationService):
|
||||
|
||||
This method must be run in the event loop.
|
||||
"""
|
||||
await self.hass.async_add_executor_job(
|
||||
partial(self.dismiss, **kwargs))
|
||||
await self.hass.async_add_executor_job(partial(self.dismiss, **kwargs))
|
||||
|
||||
def send_message(self, message="", **kwargs):
|
||||
"""Send a message to a user."""
|
||||
tag = str(uuid.uuid4())
|
||||
payload = {
|
||||
'badge': '/static/images/notification-badge.png',
|
||||
'body': message,
|
||||
"badge": "/static/images/notification-badge.png",
|
||||
"body": message,
|
||||
ATTR_DATA: {},
|
||||
'icon': '/static/icons/favicon-192x192.png',
|
||||
"icon": "/static/icons/favicon-192x192.png",
|
||||
ATTR_TAG: tag,
|
||||
ATTR_TITLE: kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT)
|
||||
ATTR_TITLE: kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT),
|
||||
}
|
||||
|
||||
data = kwargs.get(ATTR_DATA)
|
||||
@@ -453,8 +481,10 @@ class HTML5NotificationService(BaseNotificationService):
|
||||
|
||||
payload[ATTR_DATA] = data_tmp
|
||||
|
||||
if (payload[ATTR_DATA].get(ATTR_URL) is None and
|
||||
payload.get(ATTR_ACTIONS) is None):
|
||||
if (
|
||||
payload[ATTR_DATA].get(ATTR_URL) is None
|
||||
and payload.get(ATTR_ACTIONS) is None
|
||||
):
|
||||
payload[ATTR_DATA][ATTR_URL] = URL_ROOT
|
||||
|
||||
self._push_message(payload, **kwargs)
|
||||
@@ -466,9 +496,9 @@ class HTML5NotificationService(BaseNotificationService):
|
||||
timestamp = int(time.time())
|
||||
ttl = int(kwargs.get(ATTR_TTL, DEFAULT_TTL))
|
||||
priority = kwargs.get(ATTR_PRIORITY, DEFAULT_PRIORITY)
|
||||
if priority not in ['normal', 'high']:
|
||||
if priority not in ["normal", "high"]:
|
||||
priority = DEFAULT_PRIORITY
|
||||
payload['timestamp'] = (timestamp*1000) # Javascript ms since epoch
|
||||
payload["timestamp"] = timestamp * 1000 # Javascript ms since epoch
|
||||
targets = kwargs.get(ATTR_TARGET)
|
||||
|
||||
if not targets:
|
||||
@@ -479,42 +509,39 @@ class HTML5NotificationService(BaseNotificationService):
|
||||
try:
|
||||
info = REGISTER_SCHEMA(info)
|
||||
except vol.Invalid:
|
||||
_LOGGER.error("%s is not a valid HTML5 push notification"
|
||||
" target", target)
|
||||
_LOGGER.error(
|
||||
"%s is not a valid HTML5 push notification" " target", target
|
||||
)
|
||||
continue
|
||||
payload[ATTR_DATA][ATTR_JWT] = add_jwt(
|
||||
timestamp, target, payload[ATTR_TAG],
|
||||
info[ATTR_SUBSCRIPTION][ATTR_KEYS][ATTR_AUTH])
|
||||
timestamp,
|
||||
target,
|
||||
payload[ATTR_TAG],
|
||||
info[ATTR_SUBSCRIPTION][ATTR_KEYS][ATTR_AUTH],
|
||||
)
|
||||
webpusher = WebPusher(info[ATTR_SUBSCRIPTION])
|
||||
if self._vapid_prv and self._vapid_email:
|
||||
vapid_headers = create_vapid_headers(
|
||||
self._vapid_email, info[ATTR_SUBSCRIPTION],
|
||||
self._vapid_prv)
|
||||
vapid_headers.update({
|
||||
'urgency': priority,
|
||||
'priority': priority
|
||||
})
|
||||
self._vapid_email, info[ATTR_SUBSCRIPTION], self._vapid_prv
|
||||
)
|
||||
vapid_headers.update({"urgency": priority, "priority": priority})
|
||||
response = webpusher.send(
|
||||
data=json.dumps(payload),
|
||||
headers=vapid_headers,
|
||||
ttl=ttl
|
||||
data=json.dumps(payload), headers=vapid_headers, ttl=ttl
|
||||
)
|
||||
else:
|
||||
# Only pass the gcm key if we're actually using GCM
|
||||
# If we don't, notifications break on FireFox
|
||||
gcm_key = self._gcm_key \
|
||||
if 'googleapis.com' \
|
||||
in info[ATTR_SUBSCRIPTION][ATTR_ENDPOINT] \
|
||||
gcm_key = (
|
||||
self._gcm_key
|
||||
if "googleapis.com" in info[ATTR_SUBSCRIPTION][ATTR_ENDPOINT]
|
||||
else None
|
||||
response = webpusher.send(
|
||||
json.dumps(payload), gcm_key=gcm_key, ttl=ttl
|
||||
)
|
||||
response = webpusher.send(json.dumps(payload), gcm_key=gcm_key, ttl=ttl)
|
||||
|
||||
if response.status_code == 410:
|
||||
_LOGGER.info("Notification channel has expired")
|
||||
reg = self.registrations.pop(target)
|
||||
if not save_json(self.registrations_json_path,
|
||||
self.registrations):
|
||||
if not save_json(self.registrations_json_path, self.registrations):
|
||||
self.registrations[target] = reg
|
||||
_LOGGER.error("Error saving registration")
|
||||
else:
|
||||
@@ -524,23 +551,27 @@ class HTML5NotificationService(BaseNotificationService):
|
||||
def add_jwt(timestamp, target, tag, jwt_secret):
|
||||
"""Create JWT json to put into payload."""
|
||||
import jwt
|
||||
jwt_exp = (datetime.fromtimestamp(timestamp) +
|
||||
timedelta(days=JWT_VALID_DAYS))
|
||||
jwt_claims = {'exp': jwt_exp, 'nbf': timestamp,
|
||||
'iat': timestamp, ATTR_TARGET: target,
|
||||
ATTR_TAG: tag}
|
||||
return jwt.encode(jwt_claims, jwt_secret).decode('utf-8')
|
||||
|
||||
jwt_exp = datetime.fromtimestamp(timestamp) + timedelta(days=JWT_VALID_DAYS)
|
||||
jwt_claims = {
|
||||
"exp": jwt_exp,
|
||||
"nbf": timestamp,
|
||||
"iat": timestamp,
|
||||
ATTR_TARGET: target,
|
||||
ATTR_TAG: tag,
|
||||
}
|
||||
return jwt.encode(jwt_claims, jwt_secret).decode("utf-8")
|
||||
|
||||
|
||||
def create_vapid_headers(vapid_email, subscription_info, vapid_private_key):
|
||||
"""Create encrypted headers to send to WebPusher."""
|
||||
from py_vapid import Vapid
|
||||
if (vapid_email and vapid_private_key and
|
||||
ATTR_ENDPOINT in subscription_info):
|
||||
|
||||
if vapid_email and vapid_private_key and ATTR_ENDPOINT in subscription_info:
|
||||
url = urlparse(subscription_info.get(ATTR_ENDPOINT))
|
||||
vapid_claims = {
|
||||
'sub': 'mailto:{}'.format(vapid_email),
|
||||
'aud': "{}://{}".format(url.scheme, url.netloc)
|
||||
"sub": "mailto:{}".format(vapid_email),
|
||||
"aud": "{}://{}".format(url.scheme, url.netloc),
|
||||
}
|
||||
vapid = Vapid.from_string(private_key=vapid_private_key)
|
||||
return vapid.sign(vapid_claims)
|
||||
|
||||
Reference in new issue
Block a user