bazarr/libs/apprise/plugins/NotifyProwl.py

296 lines
9.0 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
#
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.
#
2019-06-07 11:16:07 +00:00
# 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.
import requests
from .NotifyBase import NotifyBase
2019-06-07 11:16:07 +00:00
from ..common import NotifyType
from ..utils import validate_regex
2019-06-07 11:16:07 +00:00
from ..AppriseLocale import gettext_lazy as _
# Priorities
class ProwlPriority(object):
LOW = -2
MODERATE = -1
NORMAL = 0
HIGH = 1
EMERGENCY = 2
PROWL_PRIORITIES = (
ProwlPriority.LOW,
ProwlPriority.MODERATE,
ProwlPriority.NORMAL,
ProwlPriority.HIGH,
ProwlPriority.EMERGENCY,
)
2019-06-07 11:16:07 +00:00
# Provide some known codes Prowl uses and what they translate to:
PROWL_HTTP_ERROR_MAP = {
406: 'IP address has exceeded API limit',
409: 'Request not aproved.',
2019-06-07 11:16:07 +00:00
}
class NotifyProwl(NotifyBase):
"""
A wrapper for Prowl Notifications
"""
# The default descriptive name associated with the Notification
service_name = 'Prowl'
# The services URL
service_url = 'https://www.prowlapp.com/'
# The default secure protocol
secure_protocol = 'prowl'
# A URL that takes you to the setup/help of the specific protocol
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_prowl'
# Prowl uses the http protocol with JSON requests
notify_url = 'https://api.prowlapp.com/publicapi/add'
2019-06-07 11:16:07 +00:00
# Disable throttle rate for Prowl requests since they are normally
# local anyway
request_rate_per_sec = 0
# The maximum allowable characters allowed in the body per message
body_maxlen = 10000
# Defines the maximum allowable characters in the title
title_maxlen = 1024
2019-06-07 11:16:07 +00:00
# Define object templates
templates = (
'{schema}://{apikey}',
'{schema}://{apikey}/{providerkey}',
)
# Define our template tokens
template_tokens = dict(NotifyBase.template_tokens, **{
'apikey': {
'name': _('API Key'),
'type': 'string',
'private': True,
'required': True,
'regex': (r'^[A-Za-z0-9]{40}$', 'i'),
2019-06-07 11:16:07 +00:00
},
'providerkey': {
'name': _('Provider Key'),
'type': 'string',
'private': True,
'regex': (r'^[A-Za-z0-9]{40}$', 'i'),
2019-06-07 11:16:07 +00:00
},
})
# Define our template arguments
template_args = dict(NotifyBase.template_args, **{
'priority': {
'name': _('Priority'),
'type': 'choice:int',
'values': PROWL_PRIORITIES,
'default': ProwlPriority.NORMAL,
},
})
def __init__(self, apikey, providerkey=None, priority=None, **kwargs):
"""
Initialize Prowl Object
"""
super(NotifyProwl, self).__init__(**kwargs)
if priority not in PROWL_PRIORITIES:
self.priority = self.template_args['priority']['default']
else:
self.priority = priority
# API Key (associated with project)
self.apikey = validate_regex(
apikey, *self.template_tokens['apikey']['regex'])
if not self.apikey:
msg = 'An invalid Prowl API Key ' \
'({}) was specified.'.format(apikey)
2019-06-07 11:16:07 +00:00
self.logger.warning(msg)
raise TypeError(msg)
# Store the provider key (if specified)
if providerkey:
self.providerkey = validate_regex(
providerkey, *self.template_tokens['providerkey']['regex'])
if not self.providerkey:
msg = 'An invalid Prowl Provider Key ' \
'({}) was specified.'.format(providerkey)
2019-06-07 11:16:07 +00:00
self.logger.warning(msg)
raise TypeError(msg)
else:
# No provider key was set
self.providerkey = None
return
2019-06-07 11:16:07 +00:00
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
"""
Perform Prowl Notification
"""
headers = {
'User-Agent': self.app_id,
'Content-type': "application/x-www-form-urlencoded",
}
# prepare JSON Object
payload = {
'apikey': self.apikey,
'application': self.app_id,
'event': title,
'description': body,
'priority': self.priority,
}
if self.providerkey:
payload['providerkey'] = self.providerkey
self.logger.debug('Prowl POST URL: %s (cert_verify=%r)' % (
self.notify_url, self.verify_certificate,
))
self.logger.debug('Prowl Payload: %s' % str(payload))
2019-06-07 11:16:07 +00:00
# Always call throttle before any remote server i/o is made
self.throttle()
try:
r = requests.post(
self.notify_url,
data=payload,
headers=headers,
verify=self.verify_certificate,
2020-09-14 12:24:26 +00:00
timeout=self.request_timeout,
)
if r.status_code != requests.codes.ok:
# We had a problem
2019-06-07 11:16:07 +00:00
status_str = \
NotifyBase.http_response_code_lookup(
r.status_code, PROWL_HTTP_ERROR_MAP)
2019-06-07 11:16:07 +00:00
self.logger.warning(
'Failed to send Prowl notification:'
'{}{}error={}.'.format(
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))
# Return; we're done
return False
else:
self.logger.info('Sent Prowl notification.')
except requests.RequestException as e:
self.logger.warning(
2020-09-14 12:24:26 +00:00
'A Connection error occurred sending Prowl notification.')
self.logger.debug('Socket Exception: %s' % str(e))
# Return; we're done
return False
return True
def url(self, privacy=False, *args, **kwargs):
2019-06-07 11:16:07 +00:00
"""
Returns the URL built dynamically based on specified arguments.
"""
_map = {
ProwlPriority.LOW: 'low',
ProwlPriority.MODERATE: 'moderate',
ProwlPriority.NORMAL: 'normal',
ProwlPriority.HIGH: 'high',
ProwlPriority.EMERGENCY: 'emergency',
}
2020-09-14 12:24:26 +00:00
# Define any URL parameters
params = {
2019-06-07 11:16:07 +00:00
'priority': 'normal' if self.priority not in _map
else _map[self.priority],
}
2020-09-14 12:24:26 +00:00
# Extend our parameters
params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
return '{schema}://{apikey}/{providerkey}/?{params}'.format(
2019-06-07 11:16:07 +00:00
schema=self.secure_protocol,
apikey=self.pprint(self.apikey, privacy, safe=''),
providerkey=self.pprint(self.providerkey, privacy, safe=''),
2020-09-14 12:24:26 +00:00
params=NotifyProwl.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
# Set the API Key
results['apikey'] = NotifyProwl.unquote(results['host'])
2019-06-07 11:16:07 +00:00
# Optionally try to find the provider key
try:
2019-06-07 11:16:07 +00:00
results['providerkey'] = \
NotifyProwl.split_path(results['fullpath'])[0]
2019-06-07 11:16:07 +00:00
except IndexError:
pass
if 'priority' in results['qsd'] and len(results['qsd']['priority']):
_map = {
'l': ProwlPriority.LOW,
'm': ProwlPriority.MODERATE,
'n': ProwlPriority.NORMAL,
'h': ProwlPriority.HIGH,
'e': ProwlPriority.EMERGENCY,
}
try:
results['priority'] = \
_map[results['qsd']['priority'][0].lower()]
except KeyError:
# No priority was set
pass
return results