bazarr/libs/apprise/plugins/NotifyIFTTT.py

372 lines
13 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
#
# IFTTT (If-This-Then-That)
#
2019-06-07 11:16:07 +00:00
# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
# All rights reserved.
#
2019-06-07 11:16:07 +00:00
# This code is licensed under the MIT License.
#
2019-06-07 11:16:07 +00:00
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files(the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions :
#
2019-06-07 11:16:07 +00:00
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# For this plugin to work, you need to add the Maker applet to your profile
# Simply visit https://ifttt.com/search and search for 'Webhooks'
# Or if you're signed in, click here: https://ifttt.com/maker_webhooks
# and click 'Connect'
#
# You'll want to visit the settings of this Applet and pay attention to the
# URL. For example, it might look like this:
# https://maker.ifttt.com/use/a3nHB7gA9TfBQSqJAHklod
#
2019-06-07 11:16:07 +00:00
# In the above example a3nHB7gA9TfBQSqJAHklod becomes your {webhook_id}
# You will need this to make this notification work correctly
#
# For each event you create you will assign it a name (this will be known as
# the {event} when building your URL.
2019-06-07 11:16:07 +00:00
import re
import requests
from json import dumps
2019-06-07 11:16:07 +00:00
from .NotifyBase import NotifyBase
2019-06-07 11:16:07 +00:00
from ..common import NotifyType
from ..utils import parse_list
from ..utils import validate_regex
2019-06-07 11:16:07 +00:00
from ..AppriseLocale import gettext_lazy as _
class NotifyIFTTT(NotifyBase):
"""
A wrapper for IFTTT Notifications
"""
# The default descriptive name associated with the Notification
service_name = 'IFTTT'
# The services URL
service_url = 'https://ifttt.com/'
# The default protocol
2019-06-07 11:16:07 +00:00
secure_protocol = 'ifttt'
# A URL that takes you to the setup/help of the specific protocol
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_ifttt'
# Even though you'll add 'Ingredients' as {{ Value1 }} to your Applets,
# you must use their lowercase value in the HTTP POST.
ifttt_default_key_prefix = 'value'
# The default IFTTT Key to use when mapping the title text to the IFTTT
# event. The idea here is if someone wants to over-ride the default and
# change it to another Ingredient Name (in 2018, you were limited to have
# value1, value2, and value3).
ifttt_default_title_key = 'value1'
# The default IFTTT Key to use when mapping the body text to the IFTTT
# event. The idea here is if someone wants to over-ride the default and
# change it to another Ingredient Name (in 2018, you were limited to have
# value1, value2, and value3).
ifttt_default_body_key = 'value2'
# The default IFTTT Key to use when mapping the body text to the IFTTT
# event. The idea here is if someone wants to over-ride the default and
# change it to another Ingredient Name (in 2018, you were limited to have
# value1, value2, and value3).
ifttt_default_type_key = 'value3'
# IFTTT uses the http protocol with JSON requests
2019-06-07 11:16:07 +00:00
notify_url = 'https://maker.ifttt.com/' \
'trigger/{event}/with/key/{webhook_id}'
# Define object templates
templates = (
'{schema}://{webhook_id}/{events}',
)
# Define our template tokens
template_tokens = dict(NotifyBase.template_tokens, **{
'webhook_id': {
'name': _('Webhook ID'),
'type': 'string',
'private': True,
'required': True,
},
'events': {
'name': _('Events'),
'type': 'list:string',
'required': True,
},
})
# Define our template arguments
template_args = dict(NotifyBase.template_args, **{
'to': {
'alias_of': 'events',
},
})
# Define our token control
template_kwargs = {
'add_tokens': {
'name': _('Add Tokens'),
'prefix': '+',
},
'del_tokens': {
'name': _('Remove Tokens'),
'prefix': '-',
},
}
def __init__(self, webhook_id, events, add_tokens=None, del_tokens=None,
**kwargs):
"""
Initialize IFTTT Object
2019-06-07 11:16:07 +00:00
add_tokens can optionally be a dictionary of key/value pairs
that you want to include in the IFTTT post to the server.
del_tokens can optionally be a list/tuple/set of tokens
that you want to eliminate from the IFTTT post. There isn't
much real functionality to this one unless you want to remove
reference to Value1, Value2, and/or Value3
"""
super(NotifyIFTTT, self).__init__(**kwargs)
# Webhook ID (associated with project)
self.webhook_id = validate_regex(webhook_id)
if not self.webhook_id:
msg = 'An invalid IFTTT Webhook ID ' \
'({}) was specified.'.format(webhook_id)
2019-06-07 11:16:07 +00:00
self.logger.warning(msg)
raise TypeError(msg)
# Store our Events we wish to trigger
self.events = parse_list(events)
if not self.events:
msg = 'You must specify at least one event you wish to trigger on.'
self.logger.warning(msg)
raise TypeError(msg)
2019-06-07 11:16:07 +00:00
# Tokens to include in post
self.add_tokens = {}
if add_tokens:
self.add_tokens.update(add_tokens)
2019-06-07 11:16:07 +00:00
# Tokens to remove
self.del_tokens = []
if del_tokens is not None:
if isinstance(del_tokens, (list, tuple, set)):
self.del_tokens = del_tokens
2019-06-07 11:16:07 +00:00
elif isinstance(del_tokens, dict):
# Convert the dictionary into a list
self.del_tokens = set(del_tokens.keys())
else:
msg = 'del_token must be a list; {} was provided'.format(
str(type(del_tokens)))
self.logger.warning(msg)
raise TypeError(msg)
2019-06-07 11:16:07 +00:00
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
"""
Perform IFTTT Notification
"""
headers = {
'User-Agent': self.app_id,
'Content-Type': 'application/json',
}
# prepare JSON Object
payload = {
self.ifttt_default_title_key: title,
self.ifttt_default_body_key: body,
self.ifttt_default_type_key: notify_type,
}
2019-06-07 11:16:07 +00:00
# Add any new tokens expected (this can also potentially override
# any entries defined above)
payload.update(self.add_tokens)
2019-06-07 11:16:07 +00:00
# Eliminate fields flagged for removal otherwise ensure all tokens are
# lowercase since that is what the IFTTT server expects from us.
payload = {x.lower(): y for x, y in payload.items()
if x not in self.del_tokens}
2019-06-07 11:16:07 +00:00
# error tracking (used for function return)
has_error = False
# Create a copy of our event lit
events = list(self.events)
while len(events):
2019-06-07 11:16:07 +00:00
# Retrive an entry off of our event list
event = events.pop(0)
# URL to transmit content via
url = self.notify_url.format(
webhook_id=self.webhook_id,
event=event,
)
2019-06-07 11:16:07 +00:00
self.logger.debug('IFTTT POST URL: %s (cert_verify=%r)' % (
url, self.verify_certificate,
))
self.logger.debug('IFTTT Payload: %s' % str(payload))
# Always call throttle before any remote server i/o is made
self.throttle()
try:
r = requests.post(
url,
data=dumps(payload),
headers=headers,
verify=self.verify_certificate,
2020-09-14 12:24:26 +00:00
timeout=self.request_timeout,
2019-06-07 11:16:07 +00:00
)
self.logger.debug(
u"IFTTT HTTP response headers: %r" % r.headers)
self.logger.debug(
u"IFTTT HTTP response body: %r" % r.content)
if r.status_code != requests.codes.ok:
# We had a problem
status_str = \
NotifyIFTTT.http_response_code_lookup(r.status_code)
self.logger.warning(
2019-06-07 11:16:07 +00:00
'Failed to send IFTTT notification to {}: '
'{}{}error={}.'.format(
event,
status_str,
', ' if status_str else '',
r.status_code))
2019-06-07 11:16:07 +00:00
self.logger.debug(
'Response Details:\r\n{}'.format(r.content))
2019-06-07 11:16:07 +00:00
# Mark our failure
has_error = True
continue
2019-06-07 11:16:07 +00:00
else:
self.logger.info(
'Sent IFTTT notification to %s.' % event)
2019-06-07 11:16:07 +00:00
except requests.RequestException as e:
self.logger.warning(
2020-09-14 12:24:26 +00:00
'A Connection error occurred sending IFTTT:%s ' % (
2019-06-07 11:16:07 +00:00
event) + 'notification.'
)
self.logger.debug('Socket Exception: %s' % str(e))
# Mark our failure
has_error = True
continue
return not has_error
def url(self, privacy=False, *args, **kwargs):
2019-06-07 11:16:07 +00:00
"""
Returns the URL built dynamically based on specified arguments.
"""
2020-09-14 12:24:26 +00:00
# Our URL parameters
params = self.url_parameters(privacy=privacy, *args, **kwargs)
2019-06-07 11:16:07 +00:00
# Store any new key/value pairs added to our list
2020-09-14 12:24:26 +00:00
params.update({'+{}'.format(k): v for k, v in self.add_tokens})
params.update({'-{}'.format(k): '' for k in self.del_tokens})
2019-06-07 11:16:07 +00:00
2020-09-14 12:24:26 +00:00
return '{schema}://{webhook_id}@{events}/?{params}'.format(
2019-06-07 11:16:07 +00:00
schema=self.secure_protocol,
webhook_id=self.pprint(self.webhook_id, privacy, safe=''),
2019-06-07 11:16:07 +00:00
events='/'.join([NotifyIFTTT.quote(x, safe='')
for x in self.events]),
2020-09-14 12:24:26 +00:00
params=NotifyIFTTT.urlencode(params),
2019-06-07 11:16:07 +00:00
)
@staticmethod
def parse_url(url):
"""
Parses the URL and returns enough arguments that can allow
2020-09-14 12:24:26 +00:00
us to re-instantiate this object.
"""
2020-09-14 12:24:26 +00:00
results = NotifyBase.parse_url(url, verify_host=False)
if not results:
# We're done early as we couldn't load the results
return results
2019-06-07 11:16:07 +00:00
# Our API Key is the hostname if no user is specified
results['webhook_id'] = \
results['user'] if results['user'] else results['host']
2019-06-07 11:16:07 +00:00
# Unquote our API Key
results['webhook_id'] = NotifyIFTTT.unquote(results['webhook_id'])
# Parse our add_token and del_token arguments (if specified)
results['add_token'] = results['qsd+']
results['del_token'] = results['qsd-']
2019-06-07 11:16:07 +00:00
# Our Event
results['events'] = list()
if results['user']:
# If a user was defined, then the hostname is actually a event
# too
results['events'].append(NotifyIFTTT.unquote(results['host']))
2019-06-07 11:16:07 +00:00
# Now fetch the remaining tokens
results['events'].extend(NotifyIFTTT.split_path(results['fullpath']))
# The 'to' makes it easier to use yaml configuration
if 'to' in results['qsd'] and len(results['qsd']['to']):
results['events'] += \
NotifyIFTTT.parse_list(results['qsd']['to'])
return results
2019-06-07 11:16:07 +00:00
@staticmethod
def parse_native_url(url):
"""
Support https://maker.ifttt.com/use/WEBHOOK_ID/EVENT_ID
"""
result = re.match(
r'^https?://maker\.ifttt\.com/use/'
r'(?P<webhook_id>[A-Z0-9_-]+)'
r'((?P<events>(/[A-Z0-9_-]+)+))?'
2020-09-14 12:24:26 +00:00
r'/?(?P<params>\?.+)?$', url, re.I)
2019-06-07 11:16:07 +00:00
if result:
return NotifyIFTTT.parse_url(
2020-09-14 12:24:26 +00:00
'{schema}://{webhook_id}{events}{params}'.format(
2019-06-07 11:16:07 +00:00
schema=NotifyIFTTT.secure_protocol,
webhook_id=result.group('webhook_id'),
events='' if not result.group('events')
else '@{}'.format(result.group('events')),
2020-09-14 12:24:26 +00:00
params='' if not result.group('params')
else result.group('params')))
2019-06-07 11:16:07 +00:00
return None