You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
381 lines
12 KiB
381 lines
12 KiB
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
|
|
# All rights reserved.
|
|
#
|
|
# This code is licensed under the MIT License.
|
|
#
|
|
# 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 :
|
|
#
|
|
# 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.
|
|
|
|
import six
|
|
import requests
|
|
import base64
|
|
from json import dumps
|
|
|
|
from .NotifyBase import NotifyBase
|
|
from ..URLBase import PrivacyMode
|
|
from ..common import NotifyImageSize
|
|
from ..common import NotifyType
|
|
from ..AppriseLocale import gettext_lazy as _
|
|
|
|
|
|
# Defines the method to send the notification
|
|
METHODS = (
|
|
'POST',
|
|
'GET',
|
|
'DELETE',
|
|
'PUT',
|
|
'HEAD'
|
|
)
|
|
|
|
|
|
class NotifyJSON(NotifyBase):
|
|
"""
|
|
A wrapper for JSON Notifications
|
|
"""
|
|
|
|
# The default descriptive name associated with the Notification
|
|
service_name = 'JSON'
|
|
|
|
# The default protocol
|
|
protocol = 'json'
|
|
|
|
# The default secure protocol
|
|
secure_protocol = 'jsons'
|
|
|
|
# A URL that takes you to the setup/help of the specific protocol
|
|
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_Custom_JSON'
|
|
|
|
# Allows the user to specify the NotifyImageSize object
|
|
image_size = NotifyImageSize.XY_128
|
|
|
|
# Disable throttle rate for JSON requests since they are normally
|
|
# local anyway
|
|
request_rate_per_sec = 0
|
|
|
|
# Define object templates
|
|
templates = (
|
|
'{schema}://{host}',
|
|
'{schema}://{host}:{port}',
|
|
'{schema}://{user}@{host}',
|
|
'{schema}://{user}@{host}:{port}',
|
|
'{schema}://{user}:{password}@{host}',
|
|
'{schema}://{user}:{password}@{host}:{port}',
|
|
)
|
|
|
|
# Define our tokens; these are the minimum tokens required required to
|
|
# be passed into this function (as arguments). The syntax appends any
|
|
# previously defined in the base package and builds onto them
|
|
template_tokens = dict(NotifyBase.template_tokens, **{
|
|
'host': {
|
|
'name': _('Hostname'),
|
|
'type': 'string',
|
|
'required': True,
|
|
},
|
|
'port': {
|
|
'name': _('Port'),
|
|
'type': 'int',
|
|
'min': 1,
|
|
'max': 65535,
|
|
},
|
|
'user': {
|
|
'name': _('Username'),
|
|
'type': 'string',
|
|
},
|
|
'password': {
|
|
'name': _('Password'),
|
|
'type': 'string',
|
|
'private': True,
|
|
},
|
|
|
|
})
|
|
|
|
# Define our template arguments
|
|
template_args = dict(NotifyBase.template_args, **{
|
|
'method': {
|
|
'name': _('Fetch Method'),
|
|
'type': 'choice:string',
|
|
'values': METHODS,
|
|
'default': METHODS[0],
|
|
},
|
|
})
|
|
|
|
# Define any kwargs we're using
|
|
template_kwargs = {
|
|
'headers': {
|
|
'name': _('HTTP Header'),
|
|
'prefix': '+',
|
|
},
|
|
'payload': {
|
|
'name': _('Payload Extras'),
|
|
'prefix': ':',
|
|
},
|
|
}
|
|
|
|
def __init__(self, headers=None, method=None, payload=None, **kwargs):
|
|
"""
|
|
Initialize JSON Object
|
|
|
|
headers can be a dictionary of key/value pairs that you want to
|
|
additionally include as part of the server headers to post with
|
|
|
|
"""
|
|
super(NotifyJSON, self).__init__(**kwargs)
|
|
|
|
self.fullpath = kwargs.get('fullpath')
|
|
if not isinstance(self.fullpath, six.string_types):
|
|
self.fullpath = ''
|
|
|
|
self.method = self.template_args['method']['default'] \
|
|
if not isinstance(method, six.string_types) else method.upper()
|
|
|
|
if self.method not in METHODS:
|
|
msg = 'The method specified ({}) is invalid.'.format(method)
|
|
self.logger.warning(msg)
|
|
raise TypeError(msg)
|
|
|
|
self.headers = {}
|
|
if headers:
|
|
# Store our extra headers
|
|
self.headers.update(headers)
|
|
|
|
self.payload_extras = {}
|
|
if payload:
|
|
# Store our extra payload entries
|
|
self.payload_extras.update(payload)
|
|
|
|
return
|
|
|
|
def url(self, privacy=False, *args, **kwargs):
|
|
"""
|
|
Returns the URL built dynamically based on specified arguments.
|
|
"""
|
|
|
|
# Define any URL parameters
|
|
params = {
|
|
'method': self.method,
|
|
}
|
|
|
|
# Extend our parameters
|
|
params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
|
|
|
|
# Append our headers into our parameters
|
|
params.update({'+{}'.format(k): v for k, v in self.headers.items()})
|
|
|
|
# Append our payload extra's into our parameters
|
|
params.update(
|
|
{':{}'.format(k): v for k, v in self.payload_extras.items()})
|
|
|
|
# Determine Authentication
|
|
auth = ''
|
|
if self.user and self.password:
|
|
auth = '{user}:{password}@'.format(
|
|
user=NotifyJSON.quote(self.user, safe=''),
|
|
password=self.pprint(
|
|
self.password, privacy, mode=PrivacyMode.Secret, safe=''),
|
|
)
|
|
elif self.user:
|
|
auth = '{user}@'.format(
|
|
user=NotifyJSON.quote(self.user, safe=''),
|
|
)
|
|
|
|
default_port = 443 if self.secure else 80
|
|
|
|
return '{schema}://{auth}{hostname}{port}{fullpath}?{params}'.format(
|
|
schema=self.secure_protocol if self.secure else self.protocol,
|
|
auth=auth,
|
|
# never encode hostname since we're expecting it to be a valid one
|
|
hostname=self.host,
|
|
port='' if self.port is None or self.port == default_port
|
|
else ':{}'.format(self.port),
|
|
fullpath=NotifyJSON.quote(self.fullpath, safe='/')
|
|
if self.fullpath else '/',
|
|
params=NotifyJSON.urlencode(params),
|
|
)
|
|
|
|
def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
|
|
**kwargs):
|
|
"""
|
|
Perform JSON Notification
|
|
"""
|
|
|
|
headers = {
|
|
'User-Agent': self.app_id,
|
|
'Content-Type': 'application/json'
|
|
}
|
|
|
|
# Apply any/all header over-rides defined
|
|
headers.update(self.headers)
|
|
|
|
# Track our potential attachments
|
|
attachments = []
|
|
if attach:
|
|
for attachment in attach:
|
|
# Perform some simple error checking
|
|
if not attachment:
|
|
# We could not access the attachment
|
|
self.logger.error(
|
|
'Could not access attachment {}.'.format(
|
|
attachment.url(privacy=True)))
|
|
return False
|
|
|
|
try:
|
|
with open(attachment.path, 'rb') as f:
|
|
# Output must be in a DataURL format (that's what
|
|
# PushSafer calls it):
|
|
attachments.append({
|
|
'filename': attachment.name,
|
|
'base64': base64.b64encode(f.read())
|
|
.decode('utf-8'),
|
|
'mimetype': attachment.mimetype,
|
|
})
|
|
|
|
except (OSError, IOError) as e:
|
|
self.logger.warning(
|
|
'An I/O error occurred while reading {}.'.format(
|
|
attachment.name if attachment else 'attachment'))
|
|
self.logger.debug('I/O Exception: %s' % str(e))
|
|
return False
|
|
|
|
# prepare JSON Object
|
|
payload = {
|
|
# Version: Major.Minor, Major is only updated if the entire
|
|
# schema is changed. If just adding new items (or removing
|
|
# old ones, only increment the Minor!
|
|
'version': '1.0',
|
|
'title': title,
|
|
'message': body,
|
|
'attachments': attachments,
|
|
'type': notify_type,
|
|
}
|
|
|
|
# Apply any/all payload over-rides defined
|
|
payload.update(self.payload_extras)
|
|
|
|
auth = None
|
|
if self.user:
|
|
auth = (self.user, self.password)
|
|
|
|
# Set our schema
|
|
schema = 'https' if self.secure else 'http'
|
|
|
|
url = '%s://%s' % (schema, self.host)
|
|
if isinstance(self.port, int):
|
|
url += ':%d' % self.port
|
|
|
|
url += self.fullpath
|
|
|
|
self.logger.debug('JSON POST URL: %s (cert_verify=%r)' % (
|
|
url, self.verify_certificate,
|
|
))
|
|
self.logger.debug('JSON Payload: %s' % str(payload))
|
|
|
|
# Always call throttle before any remote server i/o is made
|
|
self.throttle()
|
|
|
|
if self.method == 'GET':
|
|
method = requests.get
|
|
|
|
elif self.method == 'PUT':
|
|
method = requests.put
|
|
|
|
elif self.method == 'DELETE':
|
|
method = requests.delete
|
|
|
|
elif self.method == 'HEAD':
|
|
method = requests.head
|
|
|
|
else: # POST
|
|
method = requests.post
|
|
|
|
try:
|
|
r = method(
|
|
url,
|
|
data=dumps(payload),
|
|
headers=headers,
|
|
auth=auth,
|
|
verify=self.verify_certificate,
|
|
timeout=self.request_timeout,
|
|
)
|
|
if r.status_code < 200 or r.status_code >= 300:
|
|
# We had a problem
|
|
status_str = \
|
|
NotifyJSON.http_response_code_lookup(r.status_code)
|
|
|
|
self.logger.warning(
|
|
'Failed to send JSON %s notification: %s%serror=%s.',
|
|
self.method,
|
|
status_str,
|
|
', ' if status_str else '',
|
|
str(r.status_code))
|
|
|
|
self.logger.debug('Response Details:\r\n{}'.format(r.content))
|
|
|
|
# Return; we're done
|
|
return False
|
|
|
|
else:
|
|
self.logger.info('Sent JSON %s notification.', self.method)
|
|
|
|
except requests.RequestException as e:
|
|
self.logger.warning(
|
|
'A Connection error occurred sending JSON '
|
|
'notification to %s.' % self.host)
|
|
self.logger.debug('Socket Exception: %s' % str(e))
|
|
|
|
# Return; we're done
|
|
return False
|
|
|
|
return True
|
|
|
|
@staticmethod
|
|
def parse_url(url):
|
|
"""
|
|
Parses the URL and returns enough arguments that can allow
|
|
us to re-instantiate this object.
|
|
|
|
"""
|
|
results = NotifyBase.parse_url(url)
|
|
if not results:
|
|
# We're done early as we couldn't load the results
|
|
return results
|
|
|
|
# store any additional payload extra's defined
|
|
results['payload'] = {NotifyJSON.unquote(x): NotifyJSON.unquote(y)
|
|
for x, y in results['qsd:'].items()}
|
|
|
|
# Add our headers that the user can potentially over-ride if they wish
|
|
# to to our returned result set
|
|
results['headers'] = results['qsd+']
|
|
if results['qsd-']:
|
|
results['headers'].update(results['qsd-'])
|
|
NotifyBase.logger.deprecate(
|
|
"minus (-) based JSON header tokens are being "
|
|
" removed; use the plus (+) symbol instead.")
|
|
|
|
# Tidy our header entries by unquoting them
|
|
results['headers'] = {NotifyJSON.unquote(x): NotifyJSON.unquote(y)
|
|
for x, y in results['headers'].items()}
|
|
|
|
# Set method if not otherwise set
|
|
if 'method' in results['qsd'] and len(results['qsd']['method']):
|
|
results['method'] = NotifyJSON.unquote(results['qsd']['method'])
|
|
|
|
return results
|