Fix for #883
Louis Vézina
5 years ago
parent
c982e37024
commit
bb59b9019f
@ -0,0 +1,82 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (C) 2020 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.
|
||||
|
||||
from .ConfigBase import ConfigBase
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
class ConfigMemory(ConfigBase):
|
||||
"""
|
||||
For information that was loaded from memory and does not
|
||||
persist anywhere.
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the service
|
||||
service_name = _('Memory')
|
||||
|
||||
# The default protocol
|
||||
protocol = 'memory'
|
||||
|
||||
def __init__(self, content, **kwargs):
|
||||
"""
|
||||
Initialize Memory Object
|
||||
|
||||
Memory objects just store the raw configuration in memory. There is
|
||||
no external reference point. It's always considered cached.
|
||||
"""
|
||||
super(ConfigMemory, self).__init__(**kwargs)
|
||||
|
||||
# Store our raw config into memory
|
||||
self.content = content
|
||||
|
||||
if self.config_format is None:
|
||||
# Detect our format if possible
|
||||
self.config_format = \
|
||||
ConfigMemory.detect_config_format(self.content)
|
||||
|
||||
return
|
||||
|
||||
def url(self, privacy=False, *args, **kwargs):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
return 'memory://'
|
||||
|
||||
def read(self, **kwargs):
|
||||
"""
|
||||
Simply return content stored into memory
|
||||
"""
|
||||
|
||||
return self.content
|
||||
|
||||
@staticmethod
|
||||
def parse_url(url):
|
||||
"""
|
||||
Memory objects have no parseable URL
|
||||
|
||||
"""
|
||||
# These URLs can not be parsed
|
||||
return None
|
||||
@ -0,0 +1,352 @@
|
||||
# -*- 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.
|
||||
|
||||
# Sources
|
||||
# - https://dreambox.de/en/
|
||||
# - https://dream.reichholf.net/wiki/Hauptseite
|
||||
# - https://dream.reichholf.net/wiki/Enigma2:WebInterface#Message
|
||||
# - https://github.com/E2OpenPlugins/e2openplugin-OpenWebif
|
||||
# - https://github.com/E2OpenPlugins/e2openplugin-OpenWebif/wiki/\
|
||||
# OpenWebif-API-documentation#message
|
||||
|
||||
import six
|
||||
import requests
|
||||
from json import loads
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..URLBase import PrivacyMode
|
||||
from ..common import NotifyType
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
class Enigma2MessageType(object):
|
||||
# Defines the Enigma2 notification types Apprise can map to
|
||||
INFO = 1
|
||||
WARNING = 2
|
||||
ERROR = 3
|
||||
|
||||
|
||||
# If a mapping fails, the default of Enigma2MessageType.INFO is used
|
||||
MESSAGE_MAPPING = {
|
||||
NotifyType.INFO: Enigma2MessageType.INFO,
|
||||
NotifyType.SUCCESS: Enigma2MessageType.INFO,
|
||||
NotifyType.WARNING: Enigma2MessageType.WARNING,
|
||||
NotifyType.FAILURE: Enigma2MessageType.ERROR,
|
||||
}
|
||||
|
||||
|
||||
class NotifyEnigma2(NotifyBase):
|
||||
"""
|
||||
A wrapper for Enigma2 Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Enigma2'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://dreambox.de/'
|
||||
|
||||
# The default protocol
|
||||
protocol = 'enigma2'
|
||||
|
||||
# The default secure protocol
|
||||
secure_protocol = 'enigma2s'
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_enigma2'
|
||||
|
||||
# Enigma2 does not support a title
|
||||
title_maxlen = 0
|
||||
|
||||
# The maximum allowable characters allowed in the body per message
|
||||
body_maxlen = 1000
|
||||
|
||||
# Throttle a wee-bit to avoid thrashing
|
||||
request_rate_per_sec = 0.5
|
||||
|
||||
# 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}',
|
||||
'{schema}://{host}/{fullpath}',
|
||||
'{schema}://{host}:{port}/{fullpath}',
|
||||
'{schema}://{user}@{host}/{fullpath}',
|
||||
'{schema}://{user}@{host}:{port}/{fullpath}',
|
||||
'{schema}://{user}:{password}@{host}/{fullpath}',
|
||||
'{schema}://{user}:{password}@{host}:{port}/{fullpath}',
|
||||
)
|
||||
|
||||
# Define our template tokens
|
||||
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,
|
||||
},
|
||||
'fullpath': {
|
||||
'name': _('Path'),
|
||||
'type': 'string',
|
||||
},
|
||||
})
|
||||
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'timeout': {
|
||||
'name': _('Server Timeout'),
|
||||
'type': 'int',
|
||||
# The number of seconds to display the message for
|
||||
'default': 13,
|
||||
# -1 means infinit
|
||||
'min': -1,
|
||||
},
|
||||
})
|
||||
|
||||
# Define any kwargs we're using
|
||||
template_kwargs = {
|
||||
'headers': {
|
||||
'name': _('HTTP Header'),
|
||||
'prefix': '+',
|
||||
},
|
||||
}
|
||||
|
||||
def __init__(self, timeout=None, headers=None, **kwargs):
|
||||
"""
|
||||
Initialize Enigma2 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(NotifyEnigma2, self).__init__(**kwargs)
|
||||
|
||||
try:
|
||||
self.timeout = int(timeout)
|
||||
if self.timeout < self.template_args['timeout']['min']:
|
||||
# Bulletproof; can't go lower then min value
|
||||
self.timeout = self.template_args['timeout']['min']
|
||||
|
||||
except (ValueError, TypeError):
|
||||
# Use default timeout
|
||||
self.timeout = self.template_args['timeout']['default']
|
||||
|
||||
self.fullpath = kwargs.get('fullpath')
|
||||
if not isinstance(self.fullpath, six.string_types):
|
||||
self.fullpath = '/'
|
||||
|
||||
self.headers = {}
|
||||
if headers:
|
||||
# Store our extra headers
|
||||
self.headers.update(headers)
|
||||
|
||||
return
|
||||
|
||||
def url(self, privacy=False, *args, **kwargs):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
# Define any arguments set
|
||||
args = {
|
||||
'format': self.notify_format,
|
||||
'overflow': self.overflow_mode,
|
||||
'verify': 'yes' if self.verify_certificate else 'no',
|
||||
'timeout': str(self.timeout),
|
||||
}
|
||||
|
||||
# Append our headers into our args
|
||||
args.update({'+{}'.format(k): v for k, v in self.headers.items()})
|
||||
|
||||
# Determine Authentication
|
||||
auth = ''
|
||||
if self.user and self.password:
|
||||
auth = '{user}:{password}@'.format(
|
||||
user=NotifyEnigma2.quote(self.user, safe=''),
|
||||
password=self.pprint(
|
||||
self.password, privacy, mode=PrivacyMode.Secret, safe=''),
|
||||
)
|
||||
elif self.user:
|
||||
auth = '{user}@'.format(
|
||||
user=NotifyEnigma2.quote(self.user, safe=''),
|
||||
)
|
||||
|
||||
default_port = 443 if self.secure else 80
|
||||
|
||||
return '{schema}://{auth}{hostname}{port}{fullpath}?{args}'.format(
|
||||
schema=self.secure_protocol if self.secure else self.protocol,
|
||||
auth=auth,
|
||||
hostname=NotifyEnigma2.quote(self.host, safe=''),
|
||||
port='' if self.port is None or self.port == default_port
|
||||
else ':{}'.format(self.port),
|
||||
fullpath=NotifyEnigma2.quote(self.fullpath, safe='/'),
|
||||
args=NotifyEnigma2.urlencode(args),
|
||||
)
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||||
"""
|
||||
Perform Enigma2 Notification
|
||||
"""
|
||||
|
||||
# prepare Enigma2 Object
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
}
|
||||
|
||||
params = {
|
||||
'text': body,
|
||||
'type': MESSAGE_MAPPING.get(
|
||||
notify_type, Enigma2MessageType.INFO),
|
||||
'timeout': self.timeout,
|
||||
}
|
||||
|
||||
# Apply any/all header over-rides defined
|
||||
headers.update(self.headers)
|
||||
|
||||
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
|
||||
|
||||
# Prepare our message URL
|
||||
url += self.fullpath.rstrip('/') + '/api/message'
|
||||
|
||||
self.logger.debug('Enigma2 POST URL: %s (cert_verify=%r)' % (
|
||||
url, self.verify_certificate,
|
||||
))
|
||||
self.logger.debug('Enigma2 Parameters: %s' % str(params))
|
||||
|
||||
# Always call throttle before any remote server i/o is made
|
||||
self.throttle()
|
||||
|
||||
try:
|
||||
r = requests.get(
|
||||
url,
|
||||
params=params,
|
||||
headers=headers,
|
||||
auth=auth,
|
||||
verify=self.verify_certificate,
|
||||
)
|
||||
|
||||
if r.status_code != requests.codes.ok:
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyEnigma2.http_response_code_lookup(r.status_code)
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send Enigma2 notification: '
|
||||
'{}{}error={}.'.format(
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug('Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
# Return; we're done
|
||||
return False
|
||||
|
||||
# We were able to post our message; now lets evaluate the response
|
||||
try:
|
||||
# Acquire our result
|
||||
result = loads(r.content).get('result', False)
|
||||
|
||||
except (AttributeError, TypeError, ValueError):
|
||||
# ValueError = r.content is Unparsable
|
||||
# TypeError = r.content is None
|
||||
# AttributeError = r is None
|
||||
|
||||
# We could not parse JSON response.
|
||||
result = False
|
||||
|
||||
if not result:
|
||||
self.logger.warning(
|
||||
'Failed to send Enigma2 notification: '
|
||||
'There was no server acknowledgement.')
|
||||
self.logger.debug('Response Details:\r\n{}'.format(r.content))
|
||||
# Return; we're done
|
||||
return False
|
||||
|
||||
self.logger.info('Sent Enigma2 notification.')
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occured sending Enigma2 '
|
||||
'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 substantiate this object.
|
||||
|
||||
"""
|
||||
results = NotifyBase.parse_url(url)
|
||||
|
||||
if not results:
|
||||
# We're done early as we couldn't load the results
|
||||
return results
|
||||
|
||||
# Add our headers that the user can potentially over-ride if they wish
|
||||
# to to our returned result set
|
||||
results['headers'] = results['qsd-']
|
||||
results['headers'].update(results['qsd+'])
|
||||
|
||||
# Tidy our header entries by unquoting them
|
||||
results['headers'] = {
|
||||
NotifyEnigma2.unquote(x): NotifyEnigma2.unquote(y)
|
||||
for x, y in results['headers'].items()}
|
||||
|
||||
# Save timeout value (if specified)
|
||||
if 'timeout' in results['qsd'] and len(results['qsd']['timeout']):
|
||||
results['timeout'] = results['qsd']['timeout']
|
||||
|
||||
return results
|
||||
@ -0,0 +1,377 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (C) 2020 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.
|
||||
|
||||
# To use this service you will need a Kavenegar account from their website
|
||||
# at https://kavenegar.com/
|
||||
#
|
||||
# After you've established your account you can get your API Key from your
|
||||
# account profile: https://panel.kavenegar.com/client/setting/account
|
||||
#
|
||||
# This provider does not accept +1 (for example) as a country code. You need
|
||||
# to specify 001 instead.
|
||||
#
|
||||
import re
|
||||
import requests
|
||||
from json import loads
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..common import NotifyType
|
||||
from ..utils import parse_list
|
||||
from ..utils import validate_regex
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
# Extend HTTP Error Messages
|
||||
# Based on https://kavenegar.com/rest.html
|
||||
KAVENEGAR_HTTP_ERROR_MAP = {
|
||||
200: 'The request was approved',
|
||||
400: 'Parameters are incomplete',
|
||||
401: 'Account has been disabled',
|
||||
402: 'The operation failed',
|
||||
403: 'The API Key is invalid',
|
||||
404: 'The method is unknown',
|
||||
405: 'The GET/POST request is wrong',
|
||||
406: 'Invalid mandatory parameters sent',
|
||||
407: 'You canot access the information you want',
|
||||
409: 'The server is unable to response',
|
||||
411: 'The recipient is invalid',
|
||||
412: 'The sender is invalid',
|
||||
413: 'Message empty or message length exceeded',
|
||||
414: 'The number of recipients is more than 200',
|
||||
415: 'The start index is larger then the total',
|
||||
416: 'The source IP of the service does not match the settings',
|
||||
417: 'The submission date is incorrect, '
|
||||
'either expired or not in the correct format',
|
||||
418: 'Your account credit is insufficient',
|
||||
422: 'Data cannot be processed due to invalid characters',
|
||||
501: 'SMS can only be sent to the account holder number',
|
||||
}
|
||||
|
||||
# Some Phone Number Detection
|
||||
IS_PHONE_NO = re.compile(r'^\+?(?P<phone>[0-9\s)(+-]+)\s*$')
|
||||
|
||||
|
||||
class NotifyKavenegar(NotifyBase):
|
||||
"""
|
||||
A wrapper for Kavenegar Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Kavenegar'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://kavenegar.com/'
|
||||
|
||||
# All notification requests are secure
|
||||
secure_protocol = 'kavenegar'
|
||||
|
||||
# Allow 300 requests per minute.
|
||||
# 60/300 = 0.2
|
||||
request_rate_per_sec = 0.20
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_kavenegar'
|
||||
|
||||
# Kavenegar single notification URL
|
||||
notify_url = 'http://api.kavenegar.com/v1/{apikey}/sms/send.json'
|
||||
|
||||
# The maximum length of the body
|
||||
body_maxlen = 160
|
||||
|
||||
# A title can not be used for SMS Messages. Setting this to zero will
|
||||
# cause any title (if defined) to get placed into the message body.
|
||||
title_maxlen = 0
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{apikey}/{targets}',
|
||||
'{schema}://{source}@{apikey}/{targets}',
|
||||
)
|
||||
|
||||
# Define our template tokens
|
||||
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||
'apikey': {
|
||||
'name': _('API Key'),
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
'private': True,
|
||||
'regex': (r'^[a-z0-9]+$', 'i'),
|
||||
},
|
||||
'source': {
|
||||
'name': _('Source Phone No'),
|
||||
'type': 'string',
|
||||
'prefix': '+',
|
||||
'regex': (r'^[0-9\s)(+-]+$', 'i'),
|
||||
},
|
||||
'target_phone': {
|
||||
'name': _('Target Phone No'),
|
||||
'type': 'string',
|
||||
'prefix': '+',
|
||||
'regex': (r'^[0-9\s)(+-]+$', 'i'),
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'targets': {
|
||||
'name': _('Targets'),
|
||||
'type': 'list:string',
|
||||
'required': True,
|
||||
},
|
||||
})
|
||||
|
||||
# Define our template arguments
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'to': {
|
||||
'alias_of': 'targets',
|
||||
},
|
||||
'from': {
|
||||
'alias_of': 'source',
|
||||
},
|
||||
})
|
||||
|
||||
def __init__(self, apikey, source=None, targets=None, **kwargs):
|
||||
"""
|
||||
Initialize Kavenegar Object
|
||||
"""
|
||||
super(NotifyKavenegar, self).__init__(**kwargs)
|
||||
|
||||
# API Key (associated with project)
|
||||
self.apikey = validate_regex(
|
||||
apikey, *self.template_tokens['apikey']['regex'])
|
||||
if not self.apikey:
|
||||
msg = 'An invalid Kavenegar API Key ' \
|
||||
'({}) was specified.'.format(apikey)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
self.source = None
|
||||
if source is not None:
|
||||
result = IS_PHONE_NO.match(source)
|
||||
if not result:
|
||||
msg = 'The Kavenegar source specified ({}) is invalid.'\
|
||||
.format(source)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# Further check our phone # for it's digit count
|
||||
result = ''.join(re.findall(r'\d+', result.group('phone')))
|
||||
if len(result) < 11 or len(result) > 14:
|
||||
msg = 'The MessageBird source # specified ({}) is invalid.'\
|
||||
.format(source)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# Store our source
|
||||
self.source = result
|
||||
|
||||
# Parse our targets
|
||||
self.targets = list()
|
||||
|
||||
for target in parse_list(targets):
|
||||
# Validate targets and drop bad ones:
|
||||
result = IS_PHONE_NO.match(target)
|
||||
if result:
|
||||
# Further check our phone # for it's digit count
|
||||
# if it's less than 10, then we can assume it's
|
||||
# a poorly specified phone no and spit a warning
|
||||
result = ''.join(re.findall(r'\d+', result.group('phone')))
|
||||
if len(result) < 11 or len(result) > 14:
|
||||
self.logger.warning(
|
||||
'Dropped invalid phone # '
|
||||
'({}) specified.'.format(target),
|
||||
)
|
||||
continue
|
||||
|
||||
# store valid phone number
|
||||
self.targets.append(result)
|
||||
continue
|
||||
|
||||
self.logger.warning(
|
||||
'Dropped invalid phone # ({}) specified.'.format(target))
|
||||
|
||||
if len(self.targets) == 0:
|
||||
msg = 'There are no valid targets identified to notify.'
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
return
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||||
"""
|
||||
Sends SMS Message
|
||||
"""
|
||||
|
||||
# error tracking (used for function return)
|
||||
has_error = False
|
||||
|
||||
# Prepare our headers
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
'Accept': 'application/json',
|
||||
}
|
||||
|
||||
# Our URL
|
||||
url = self.notify_url.format(apikey=self.apikey)
|
||||
|
||||
# use the list directly
|
||||
targets = list(self.targets)
|
||||
|
||||
while len(targets):
|
||||
# Get our target(s) to notify
|
||||
target = targets.pop(0)
|
||||
|
||||
# Prepare our payload
|
||||
payload = {
|
||||
'receptor': target,
|
||||
'message': body,
|
||||
}
|
||||
|
||||
if self.source:
|
||||
# Only set source if specified
|
||||
payload['sender'] = self.source
|
||||
|
||||
# Some Debug Logging
|
||||
self.logger.debug(
|
||||
'Kavenegar POST URL: {} (cert_verify={})'.format(
|
||||
url, self.verify_certificate))
|
||||
self.logger.debug('Kavenegar Payload: {}' .format(payload))
|
||||
|
||||
# Always call throttle before any remote server i/o is made
|
||||
self.throttle()
|
||||
try:
|
||||
r = requests.post(
|
||||
url,
|
||||
params=payload,
|
||||
headers=headers,
|
||||
verify=self.verify_certificate,
|
||||
)
|
||||
|
||||
if r.status_code not in (
|
||||
requests.codes.created, requests.codes.ok):
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyBase.http_response_code_lookup(
|
||||
r.status_code, KAVENEGAR_HTTP_ERROR_MAP)
|
||||
|
||||
try:
|
||||
# Update our status response if we can
|
||||
json_response = loads(r.content)
|
||||
status_str = json_response.get('message', status_str)
|
||||
|
||||
except (AttributeError, TypeError, ValueError):
|
||||
# ValueError = r.content is Unparsable
|
||||
# TypeError = r.content is None
|
||||
# AttributeError = r is None
|
||||
|
||||
# We could not parse JSON response.
|
||||
# We will just use the status we already have.
|
||||
pass
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send Kavenegar SMS notification to {}: '
|
||||
'{}{}error={}.'.format(
|
||||
target,
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
# Mark our failure
|
||||
has_error = True
|
||||
continue
|
||||
|
||||
# If we reach here; the message was sent
|
||||
self.logger.info(
|
||||
'Sent Kavenegar SMS notification to {}.'.format(target))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occured sending Kavenegar:%s ' % (
|
||||
', '.join(self.targets)) + '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):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
# Define any arguments set
|
||||
args = {
|
||||
'format': self.notify_format,
|
||||
'overflow': self.overflow_mode,
|
||||
'verify': 'yes' if self.verify_certificate else 'no',
|
||||
}
|
||||
|
||||
return '{schema}://{source}{apikey}/{targets}?{args}'.format(
|
||||
schema=self.secure_protocol,
|
||||
source='' if not self.source else '{}@'.format(self.source),
|
||||
apikey=self.pprint(self.apikey, privacy, safe=''),
|
||||
targets='/'.join(
|
||||
[NotifyKavenegar.quote(x, safe='') for x in self.targets]),
|
||||
args=NotifyKavenegar.urlencode(args))
|
||||
|
||||
@staticmethod
|
||||
def parse_url(url):
|
||||
"""
|
||||
Parses the URL and returns enough arguments that can allow
|
||||
us to substantiate this object.
|
||||
|
||||
"""
|
||||
results = NotifyBase.parse_url(url, verify_host=False)
|
||||
|
||||
if not results:
|
||||
# We're done early as we couldn't load the results
|
||||
return results
|
||||
|
||||
# Store the source if specified
|
||||
if results.get('user', None):
|
||||
results['source'] = results['user']
|
||||
|
||||
# Get our entries; split_path() looks after unquoting content for us
|
||||
# by default
|
||||
results['targets'] = NotifyKavenegar.split_path(results['fullpath'])
|
||||
|
||||
# The hostname is our authentication key
|
||||
results['apikey'] = NotifyKavenegar.unquote(results['host'])
|
||||
|
||||
# Support the 'to' variable so that we can support targets this way too
|
||||
# The 'to' makes it easier to use yaml configuration
|
||||
if 'to' in results['qsd'] and len(results['qsd']['to']):
|
||||
results['targets'] += \
|
||||
NotifyKavenegar.parse_list(results['qsd']['to'])
|
||||
|
||||
if 'from' in results['qsd'] and len(results['qsd']['from']):
|
||||
results['source'] = \
|
||||
NotifyKavenegar.unquote(results['qsd']['from'])
|
||||
|
||||
return results
|
||||
@ -0,0 +1,294 @@
|
||||
# -*- 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 CON
|
||||
|
||||
import requests
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..URLBase import PrivacyMode
|
||||
from ..common import NotifyType
|
||||
from ..utils import parse_list
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
class NotifyNextcloud(NotifyBase):
|
||||
"""
|
||||
A wrapper for Nextcloud Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Nextcloud'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://nextcloud.com/'
|
||||
|
||||
# Insecure protocol (for those self hosted requests)
|
||||
protocol = 'ncloud'
|
||||
|
||||
# The default protocol (this is secure for notica)
|
||||
secure_protocol = 'nclouds'
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_nextcloud'
|
||||
|
||||
# Nextcloud URL
|
||||
notify_url = '{schema}://{host}/ocs/v2.php/apps/admin_notifications/' \
|
||||
'api/v1/notifications/{target}'
|
||||
|
||||
# Nextcloud does not support a title
|
||||
title_maxlen = 255
|
||||
|
||||
# Defines the maximum allowable characters per message.
|
||||
body_maxlen = 4000
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{user}:{password}@{host}/{targets}',
|
||||
'{schema}://{user}:{password}@{host}:{port}/{targets}',
|
||||
)
|
||||
|
||||
# Define our template tokens
|
||||
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,
|
||||
},
|
||||
'target_user': {
|
||||
'name': _('Target User'),
|
||||
'type': 'string',
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'targets': {
|
||||
'name': _('Targets'),
|
||||
'type': 'list:string',
|
||||
'required': True,
|
||||
},
|
||||
})
|
||||
|
||||
# Define any kwargs we're using
|
||||
template_kwargs = {
|
||||
'headers': {
|
||||
'name': _('HTTP Header'),
|
||||
'prefix': '+',
|
||||
},
|
||||
}
|
||||
|
||||
def __init__(self, targets=None, headers=None, **kwargs):
|
||||
"""
|
||||
Initialize Nextcloud Object
|
||||
"""
|
||||
super(NotifyNextcloud, self).__init__(**kwargs)
|
||||
|
||||
self.targets = parse_list(targets)
|
||||
if len(self.targets) == 0:
|
||||
msg = 'At least one Nextcloud target user must be specified.'
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
self.headers = {}
|
||||
if headers:
|
||||
# Store our extra headers
|
||||
self.headers.update(headers)
|
||||
|
||||
return
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||||
"""
|
||||
Perform Nextcloud Notification
|
||||
"""
|
||||
|
||||
# Prepare our Header
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
'OCS-APIREQUEST': 'true',
|
||||
}
|
||||
|
||||
# Apply any/all header over-rides defined
|
||||
headers.update(self.headers)
|
||||
|
||||
# error tracking (used for function return)
|
||||
has_error = False
|
||||
|
||||
# Create a copy of the targets list
|
||||
targets = list(self.targets)
|
||||
while len(targets):
|
||||
target = targets.pop(0)
|
||||
|
||||
# Prepare our Payload
|
||||
payload = {
|
||||
'shortMessage': title if title else self.app_desc,
|
||||
}
|
||||
if body:
|
||||
# Only store the longMessage if a body was defined; nextcloud
|
||||
# doesn't take kindly to empty longMessage entries.
|
||||
payload['longMessage'] = body
|
||||
|
||||
auth = None
|
||||
if self.user:
|
||||
auth = (self.user, self.password)
|
||||
|
||||
notify_url = self.notify_url.format(
|
||||
schema='https' if self.secure else 'http',
|
||||
host=self.host if not isinstance(self.port, int)
|
||||
else '{}:{}'.format(self.host, self.port),
|
||||
target=target,
|
||||
)
|
||||
|
||||
self.logger.debug('Nextcloud POST URL: %s (cert_verify=%r)' % (
|
||||
notify_url, self.verify_certificate,
|
||||
))
|
||||
self.logger.debug('Nextcloud Payload: %s' % str(payload))
|
||||
|
||||
# Always call throttle before any remote server i/o is made
|
||||
self.throttle()
|
||||
|
||||
try:
|
||||
r = requests.post(
|
||||
notify_url,
|
||||
data=payload,
|
||||
headers=headers,
|
||||
auth=auth,
|
||||
verify=self.verify_certificate,
|
||||
)
|
||||
if r.status_code != requests.codes.ok:
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyNextcloud.http_response_code_lookup(
|
||||
r.status_code)
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send Nextcloud notification:'
|
||||
'{}{}error={}.'.format(
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n{}'.format(r.content))
|
||||
# track our failure
|
||||
has_error = True
|
||||
continue
|
||||
|
||||
else:
|
||||
self.logger.info('Sent Nextcloud notification.')
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occured sending Nextcloud '
|
||||
'notification.',
|
||||
)
|
||||
self.logger.debug('Socket Exception: %s' % str(e))
|
||||
|
||||
# track our failure
|
||||
has_error = True
|
||||
continue
|
||||
|
||||
return not has_error
|
||||
|
||||
def url(self, privacy=False, *args, **kwargs):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
# Define any arguments set
|
||||
args = {
|
||||
'format': self.notify_format,
|
||||
'overflow': self.overflow_mode,
|
||||
'verify': 'yes' if self.verify_certificate else 'no',
|
||||
}
|
||||
|
||||
# Append our headers into our args
|
||||
args.update({'+{}'.format(k): v for k, v in self.headers.items()})
|
||||
|
||||
# Determine Authentication
|
||||
auth = ''
|
||||
if self.user and self.password:
|
||||
auth = '{user}:{password}@'.format(
|
||||
user=NotifyNextcloud.quote(self.user, safe=''),
|
||||
password=self.pprint(
|
||||
self.password, privacy, mode=PrivacyMode.Secret, safe=''),
|
||||
)
|
||||
elif self.user:
|
||||
auth = '{user}@'.format(
|
||||
user=NotifyNextcloud.quote(self.user, safe=''),
|
||||
)
|
||||
|
||||
default_port = 443 if self.secure else 80
|
||||
|
||||
return '{schema}://{auth}{hostname}{port}/{targets}?{args}' \
|
||||
.format(
|
||||
schema=self.secure_protocol
|
||||
if self.secure else self.protocol,
|
||||
auth=auth,
|
||||
hostname=NotifyNextcloud.quote(self.host, safe=''),
|
||||
port='' if self.port is None or self.port == default_port
|
||||
else ':{}'.format(self.port),
|
||||
targets='/'.join([NotifyNextcloud.quote(x)
|
||||
for x in self.targets]),
|
||||
args=NotifyNextcloud.urlencode(args),
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def parse_url(url):
|
||||
"""
|
||||
Parses the URL and returns enough arguments that can allow
|
||||
us to substantiate this object.
|
||||
|
||||
"""
|
||||
|
||||
results = NotifyBase.parse_url(url)
|
||||
if not results:
|
||||
# We're done early as we couldn't load the results
|
||||
return results
|
||||
|
||||
# Fetch our targets
|
||||
results['targets'] = \
|
||||
NotifyNextcloud.split_path(results['fullpath'])
|
||||
|
||||
# The 'to' makes it easier to use yaml configuration
|
||||
if 'to' in results['qsd'] and len(results['qsd']['to']):
|
||||
results['targets'] += \
|
||||
NotifyNextcloud.parse_list(results['qsd']['to'])
|
||||
|
||||
# Add our headers that the user can potentially over-ride if they
|
||||
# wish to to our returned result set
|
||||
results['headers'] = results['qsd-']
|
||||
results['headers'].update(results['qsd+'])
|
||||
|
||||
return results
|
||||
@ -0,0 +1,832 @@
|
||||
# -*- 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.
|
||||
|
||||
# We use io because it allows us to test the open() call
|
||||
import io
|
||||
import base64
|
||||
import requests
|
||||
from json import loads
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..common import NotifyType
|
||||
from ..utils import parse_list
|
||||
from ..utils import validate_regex
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
class PushSaferSound(object):
|
||||
"""
|
||||
Defines all of the supported PushSafe sounds
|
||||
"""
|
||||
# Silent
|
||||
SILENT = 0
|
||||
# Ahem (IM)
|
||||
AHEM = 1
|
||||
# Applause (Mail)
|
||||
APPLAUSE = 2
|
||||
# Arrow (Reminder)
|
||||
ARROW = 3
|
||||
# Baby (SMS)
|
||||
BABY = 4
|
||||
# Bell (Alarm)
|
||||
BELL = 5
|
||||
# Bicycle (Alarm2)
|
||||
BICYCLE = 6
|
||||
# Boing (Alarm3)
|
||||
BOING = 7
|
||||
# Buzzer (Alarm4)
|
||||
BUZZER = 8
|
||||
# Camera (Alarm5)
|
||||
CAMERA = 9
|
||||
# Car Horn (Alarm6)
|
||||
CAR_HORN = 10
|
||||
# Cash Register (Alarm7)
|
||||
CASH_REGISTER = 11
|
||||
# Chime (Alarm8)
|
||||
CHIME = 12
|
||||
# Creaky Door (Alarm9)
|
||||
CREAKY_DOOR = 13
|
||||
# Cuckoo Clock (Alarm10)
|
||||
CUCKOO_CLOCK = 14
|
||||
# Disconnect (Call)
|
||||
DISCONNECT = 15
|
||||
# Dog (Call2)
|
||||
DOG = 16
|
||||
# Doorbell (Call3)
|
||||
DOORBELL = 17
|
||||
# Fanfare (Call4)
|
||||
FANFARE = 18
|
||||
# Gun Shot (Call5)
|
||||
GUN_SHOT = 19
|
||||
# Honk (Call6)
|
||||
HONK = 20
|
||||
# Jaw Harp (Call7)
|
||||
JAW_HARP = 21
|
||||
# Morse (Call8)
|
||||
MORSE = 22
|
||||
# Electricity (Call9)
|
||||
ELECTRICITY = 23
|
||||
# Radio Tuner (Call10)
|
||||
RADIO_TURNER = 24
|
||||
# Sirens
|
||||
SIRENS = 25
|
||||
# Military Trumpets
|
||||
MILITARY_TRUMPETS = 26
|
||||
# Ufo
|
||||
UFO = 27
|
||||
# Whah Whah Whah
|
||||
LONG_WHAH = 28
|
||||
# Man Saying Goodbye
|
||||
GOODBYE = 29
|
||||
# Man Saying Hello
|
||||
HELLO = 30
|
||||
# Man Saying No
|
||||
NO = 31
|
||||
# Man Saying Ok
|
||||
OKAY = 32
|
||||
# Man Saying Ooohhhweee
|
||||
OOOHHHWEEE = 33
|
||||
# Man Saying Warning
|
||||
WARNING = 34
|
||||
# Man Saying Welcome
|
||||
WELCOME = 35
|
||||
# Man Saying Yeah
|
||||
YEAH = 36
|
||||
# Man Saying Yes
|
||||
YES = 37
|
||||
# Beep short
|
||||
BEEP1 = 38
|
||||
# Weeeee short
|
||||
WEEE = 39
|
||||
# Cut in and out short
|
||||
CUTINOUT = 40
|
||||
# Finger flicking glas short
|
||||
FLICK_GLASS = 41
|
||||
# Wa Wa Waaaa short
|
||||
SHORT_WHAH = 42
|
||||
# Laser short
|
||||
LASER = 43
|
||||
# Wind Chime short
|
||||
WIND_CHIME = 44
|
||||
# Echo short
|
||||
ECHO = 45
|
||||
# Zipper short
|
||||
ZIPPER = 46
|
||||
# HiHat short
|
||||
HIHAT = 47
|
||||
# Beep 2 short
|
||||
BEEP2 = 48
|
||||
# Beep 3 short
|
||||
BEEP3 = 49
|
||||
# Beep 4 short
|
||||
BEEP4 = 50
|
||||
# The Alarm is armed
|
||||
ALARM_ARMED = 51
|
||||
# The Alarm is disarmed
|
||||
ALARM_DISARMED = 52
|
||||
# The Backup is ready
|
||||
BACKUP_READY = 53
|
||||
# The Door is closed
|
||||
DOOR_CLOSED = 54
|
||||
# The Door is opend
|
||||
DOOR_OPENED = 55
|
||||
# The Window is closed
|
||||
WINDOW_CLOSED = 56
|
||||
# The Window is open
|
||||
WINDOW_OPEN = 57
|
||||
# The Light is off
|
||||
LIGHT_ON = 58
|
||||
# The Light is on
|
||||
LIGHT_OFF = 59
|
||||
# The Doorbell rings
|
||||
DOORBELL_RANG = 60
|
||||
|
||||
|
||||
PUSHSAFER_SOUND_MAP = {
|
||||
# Device Default,
|
||||
'silent': PushSaferSound.SILENT,
|
||||
'ahem': PushSaferSound.AHEM,
|
||||
'applause': PushSaferSound.APPLAUSE,
|
||||
'arrow': PushSaferSound.ARROW,
|
||||
'baby': PushSaferSound.BABY,
|
||||
'bell': PushSaferSound.BELL,
|
||||
'bicycle': PushSaferSound.BICYCLE,
|
||||
'bike': PushSaferSound.BICYCLE,
|
||||
'boing': PushSaferSound.BOING,
|
||||
'buzzer': PushSaferSound.BUZZER,
|
||||
'camera': PushSaferSound.CAMERA,
|
||||
'carhorn': PushSaferSound.CAR_HORN,
|
||||
'horn': PushSaferSound.CAR_HORN,
|
||||
'cashregister': PushSaferSound.CASH_REGISTER,
|
||||
'chime': PushSaferSound.CHIME,
|
||||
'creakydoor': PushSaferSound.CREAKY_DOOR,
|
||||
'cuckooclock': PushSaferSound.CUCKOO_CLOCK,
|
||||
'cuckoo': PushSaferSound.CUCKOO_CLOCK,
|
||||
'disconnect': PushSaferSound.DISCONNECT,
|
||||
'dog': PushSaferSound.DOG,
|
||||
'doorbell': PushSaferSound.DOORBELL,
|
||||
'fanfare': PushSaferSound.FANFARE,
|
||||
'gunshot': PushSaferSound.GUN_SHOT,
|
||||
'honk': PushSaferSound.HONK,
|
||||
'jawharp': PushSaferSound.JAW_HARP,
|
||||
'morse': PushSaferSound.MORSE,
|
||||
'electric': PushSaferSound.ELECTRICITY,
|
||||
'radiotuner': PushSaferSound.RADIO_TURNER,
|
||||
'sirens': PushSaferSound.SIRENS,
|
||||
'militarytrumpets': PushSaferSound.MILITARY_TRUMPETS,
|
||||
'military': PushSaferSound.MILITARY_TRUMPETS,
|
||||
'trumpets': PushSaferSound.MILITARY_TRUMPETS,
|
||||
'ufo': PushSaferSound.UFO,
|
||||
'whahwhah': PushSaferSound.LONG_WHAH,
|
||||
'whah': PushSaferSound.SHORT_WHAH,
|
||||
'goodye': PushSaferSound.GOODBYE,
|
||||
'hello': PushSaferSound.HELLO,
|
||||
'no': PushSaferSound.NO,
|
||||
'okay': PushSaferSound.OKAY,
|
||||
'ok': PushSaferSound.OKAY,
|
||||
'ooohhhweee': PushSaferSound.OOOHHHWEEE,
|
||||
'warn': PushSaferSound.WARNING,
|
||||
'warning': PushSaferSound.WARNING,
|
||||
'welcome': PushSaferSound.WELCOME,
|
||||
'yeah': PushSaferSound.YEAH,
|
||||
'yes': PushSaferSound.YES,
|
||||
'beep': PushSaferSound.BEEP1,
|
||||
'beep1': PushSaferSound.BEEP1,
|
||||
'weee': PushSaferSound.WEEE,
|
||||
'wee': PushSaferSound.WEEE,
|
||||
'cutinout': PushSaferSound.CUTINOUT,
|
||||
'flickglass': PushSaferSound.FLICK_GLASS,
|
||||
'laser': PushSaferSound.LASER,
|
||||
'windchime': PushSaferSound.WIND_CHIME,
|
||||
'echo': PushSaferSound.ECHO,
|
||||
'zipper': PushSaferSound.ZIPPER,
|
||||
'hihat': PushSaferSound.HIHAT,
|
||||
'beep2': PushSaferSound.BEEP2,
|
||||
'beep3': PushSaferSound.BEEP3,
|
||||
'beep4': PushSaferSound.BEEP4,
|
||||
'alarmarmed': PushSaferSound.ALARM_ARMED,
|
||||
'armed': PushSaferSound.ALARM_ARMED,
|
||||
'alarmdisarmed': PushSaferSound.ALARM_DISARMED,
|
||||
'disarmed': PushSaferSound.ALARM_DISARMED,
|
||||
'backupready': PushSaferSound.BACKUP_READY,
|
||||
'dooropen': PushSaferSound.DOOR_OPENED,
|
||||
'dopen': PushSaferSound.DOOR_OPENED,
|
||||
'doorclosed': PushSaferSound.DOOR_CLOSED,
|
||||
'dclosed': PushSaferSound.DOOR_CLOSED,
|
||||
'windowopen': PushSaferSound.WINDOW_OPEN,
|
||||
'wopen': PushSaferSound.WINDOW_OPEN,
|
||||
'windowclosed': PushSaferSound.WINDOW_CLOSED,
|
||||
'wclosed': PushSaferSound.WINDOW_CLOSED,
|
||||
'lighton': PushSaferSound.LIGHT_ON,
|
||||
'lon': PushSaferSound.LIGHT_ON,
|
||||
'lightoff': PushSaferSound.LIGHT_OFF,
|
||||
'loff': PushSaferSound.LIGHT_OFF,
|
||||
'doorbellrang': PushSaferSound.DOORBELL_RANG,
|
||||
}
|
||||
|
||||
|
||||
# Priorities
|
||||
class PushSaferPriority(object):
|
||||
LOW = -2
|
||||
MODERATE = -1
|
||||
NORMAL = 0
|
||||
HIGH = 1
|
||||
EMERGENCY = 2
|
||||
|
||||
|
||||
PUSHSAFER_PRIORITIES = (
|
||||
PushSaferPriority.LOW,
|
||||
PushSaferPriority.MODERATE,
|
||||
PushSaferPriority.NORMAL,
|
||||
PushSaferPriority.HIGH,
|
||||
PushSaferPriority.EMERGENCY,
|
||||
)
|
||||
|
||||
PUSHSAFER_PRIORITY_MAP = {
|
||||
# short for 'low'
|
||||
'low': PushSaferPriority.LOW,
|
||||
# short for 'medium'
|
||||
'medium': PushSaferPriority.MODERATE,
|
||||
# short for 'normal'
|
||||
'normal': PushSaferPriority.NORMAL,
|
||||
# short for 'high'
|
||||
'high': PushSaferPriority.HIGH,
|
||||
# short for 'emergency'
|
||||
'emergency': PushSaferPriority.EMERGENCY,
|
||||
}
|
||||
|
||||
# Identify the priority ou want to designate as the fall back
|
||||
DEFAULT_PRIORITY = "normal"
|
||||
|
||||
|
||||
# Vibrations
|
||||
class PushSaferVibration(object):
|
||||
"""
|
||||
Defines the acceptable vibration settings for notification
|
||||
"""
|
||||
# x1
|
||||
LOW = 1
|
||||
# x2
|
||||
NORMAL = 2
|
||||
# x3
|
||||
HIGH = 3
|
||||
|
||||
|
||||
# Identify all of the vibrations in one place
|
||||
PUSHSAFER_VIBRATIONS = (
|
||||
PushSaferVibration.LOW,
|
||||
PushSaferVibration.NORMAL,
|
||||
PushSaferVibration.HIGH,
|
||||
)
|
||||
|
||||
# At this time, the following pictures can be attached to each notification
|
||||
# at one time. When more are supported, just add their argument below
|
||||
PICTURE_PARAMETER = (
|
||||
'p',
|
||||
'p2',
|
||||
'p3',
|
||||
)
|
||||
|
||||
|
||||
# Flag used as a placeholder to sending to all devices
|
||||
PUSHSAFER_SEND_TO_ALL = 'a'
|
||||
|
||||
|
||||
class NotifyPushSafer(NotifyBase):
|
||||
"""
|
||||
A wrapper for PushSafer Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Pushsafer'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://www.pushsafer.com/'
|
||||
|
||||
# The default insecure protocol
|
||||
protocol = 'psafer'
|
||||
|
||||
# The default secure protocol
|
||||
secure_protocol = 'psafers'
|
||||
|
||||
# Number of requests to a allow per second
|
||||
request_rate_per_sec = 1.2
|
||||
|
||||
# The icon ID of 25 looks like a megaphone
|
||||
default_pushsafer_icon = 25
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_pushsafer'
|
||||
|
||||
# Defines the hostname to post content to; since this service supports
|
||||
# both insecure and secure methods, we set the {schema} just before we
|
||||
# post the message upstream.
|
||||
notify_url = '{schema}://www.pushsafer.com/api'
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{privatekey}',
|
||||
'{schema}://{privatekey}/{targets}',
|
||||
)
|
||||
|
||||
# Define our template tokens
|
||||
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||
'privatekey': {
|
||||
'name': _('Private Key'),
|
||||
'type': 'string',
|
||||
'private': True,
|
||||
'required': True,
|
||||
},
|
||||
'target_device': {
|
||||
'name': _('Target Device'),
|
||||
'type': 'string',
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'target_email': {
|
||||
'name': _('Target Email'),
|
||||
'type': 'string',
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'targets': {
|
||||
'name': _('Targets'),
|
||||
'type': 'list:string',
|
||||
},
|
||||
})
|
||||
|
||||
# Define our template arguments
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'priority': {
|
||||
'name': _('Priority'),
|
||||
'type': 'choice:int',
|
||||
'values': PUSHSAFER_PRIORITIES,
|
||||
},
|
||||
'sound': {
|
||||
'name': _('Sound'),
|
||||
'type': 'choice:string',
|
||||
'values': PUSHSAFER_SOUND_MAP,
|
||||
},
|
||||
'vibration': {
|
||||
'name': _('Vibration'),
|
||||
'type': 'choice:int',
|
||||
'values': PUSHSAFER_VIBRATIONS,
|
||||
},
|
||||
'to': {
|
||||
'alias_of': 'targets',
|
||||
},
|
||||
})
|
||||
|
||||
def __init__(self, privatekey, targets=None, priority=None, sound=None,
|
||||
vibration=None, **kwargs):
|
||||
"""
|
||||
Initialize PushSafer Object
|
||||
"""
|
||||
super(NotifyPushSafer, self).__init__(**kwargs)
|
||||
|
||||
#
|
||||
# Priority
|
||||
#
|
||||
try:
|
||||
# Acquire our priority if we can:
|
||||
# - We accept both the integer form as well as a string
|
||||
# representation
|
||||
self.priority = int(priority)
|
||||
|
||||
except TypeError:
|
||||
# NoneType means use Default; this is an okay exception
|
||||
self.priority = None
|
||||
|
||||
except ValueError:
|
||||
# Input is a string; attempt to get the lookup from our
|
||||
# priority mapping
|
||||
priority = priority.lower().strip()
|
||||
|
||||
# This little bit of black magic allows us to match against
|
||||
# low, lo, l (for low);
|
||||
# normal, norma, norm, nor, no, n (for normal)
|
||||
# ... etc
|
||||
match = next((key for key in PUSHSAFER_PRIORITY_MAP.keys()
|
||||
if key.startswith(priority)), None) \
|
||||
if priority else None
|
||||
|
||||
# Now test to see if we got a match
|
||||
if not match:
|
||||
msg = 'An invalid PushSafer priority ' \
|
||||
'({}) was specified.'.format(priority)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# store our successfully looked up priority
|
||||
self.priority = PUSHSAFER_PRIORITY_MAP[match]
|
||||
|
||||
if self.priority is not None and \
|
||||
self.priority not in PUSHSAFER_PRIORITY_MAP.values():
|
||||
msg = 'An invalid PushSafer priority ' \
|
||||
'({}) was specified.'.format(priority)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
#
|
||||
# Sound
|
||||
#
|
||||
try:
|
||||
# Acquire our sound if we can:
|
||||
# - We accept both the integer form as well as a string
|
||||
# representation
|
||||
self.sound = int(sound)
|
||||
|
||||
except TypeError:
|
||||
# NoneType means use Default; this is an okay exception
|
||||
self.sound = None
|
||||
|
||||
except ValueError:
|
||||
# Input is a string; attempt to get the lookup from our
|
||||
# sound mapping
|
||||
sound = sound.lower().strip()
|
||||
|
||||
# This little bit of black magic allows us to match against
|
||||
# against multiple versions of the same string
|
||||
# ... etc
|
||||
match = next((key for key in PUSHSAFER_SOUND_MAP.keys()
|
||||
if key.startswith(sound)), None) \
|
||||
if sound else None
|
||||
|
||||
# Now test to see if we got a match
|
||||
if not match:
|
||||
msg = 'An invalid PushSafer sound ' \
|
||||
'({}) was specified.'.format(sound)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# store our successfully looked up sound
|
||||
self.sound = PUSHSAFER_SOUND_MAP[match]
|
||||
|
||||
if self.sound is not None and \
|
||||
self.sound not in PUSHSAFER_SOUND_MAP.values():
|
||||
msg = 'An invalid PushSafer sound ' \
|
||||
'({}) was specified.'.format(sound)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
#
|
||||
# Vibration
|
||||
#
|
||||
try:
|
||||
# Use defined integer as is if defined, no further error checking
|
||||
# is performed
|
||||
self.vibration = int(vibration)
|
||||
|
||||
except TypeError:
|
||||
# NoneType means use Default; this is an okay exception
|
||||
self.vibration = None
|
||||
|
||||
except ValueError:
|
||||
msg = 'An invalid PushSafer vibration ' \
|
||||
'({}) was specified.'.format(vibration)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
if self.vibration and self.vibration not in PUSHSAFER_VIBRATIONS:
|
||||
msg = 'An invalid PushSafer vibration ' \
|
||||
'({}) was specified.'.format(vibration)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
#
|
||||
# Private Key (associated with project)
|
||||
#
|
||||
self.privatekey = validate_regex(privatekey)
|
||||
if not self.privatekey:
|
||||
msg = 'An invalid PushSafer Private Key ' \
|
||||
'({}) was specified.'.format(privatekey)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
self.targets = parse_list(targets)
|
||||
if len(self.targets) == 0:
|
||||
self.targets = (PUSHSAFER_SEND_TO_ALL, )
|
||||
|
||||
return
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
|
||||
**kwargs):
|
||||
"""
|
||||
Perform PushSafer Notification
|
||||
"""
|
||||
|
||||
# error tracking (used for function return)
|
||||
has_error = False
|
||||
|
||||
# Initialize our list of attachments
|
||||
attachments = []
|
||||
|
||||
if attach:
|
||||
# We need to upload our payload first so that we can source it
|
||||
# in remaining messages
|
||||
for attachment in attach:
|
||||
# prepare payload
|
||||
if not attachment:
|
||||
# We could not access the attachment
|
||||
self.logger.error(
|
||||
'Could not access attachment {}.'.format(
|
||||
attachment.url(privacy=True)))
|
||||
return False
|
||||
|
||||
if not attachment.mimetype.startswith('image/'):
|
||||
# Attachment not supported; continue peacefully
|
||||
self.logger.debug(
|
||||
'Ignoring unsupported PushSafer attachment {}.'.format(
|
||||
attachment.url(privacy=True)))
|
||||
continue
|
||||
|
||||
self.logger.debug(
|
||||
'Posting PushSafer attachment {}'.format(
|
||||
attachment.url(privacy=True)))
|
||||
|
||||
try:
|
||||
with io.open(attachment.path, 'rb') as f:
|
||||
# Output must be in a DataURL format (that's what
|
||||
# PushSafer calls it):
|
||||
attachment = (
|
||||
attachment.name,
|
||||
'data:{};base64,{}'.format(
|
||||
attachment.mimetype,
|
||||
base64.b64encode(f.read())))
|
||||
|
||||
except (OSError, IOError) as e:
|
||||
self.logger.warning(
|
||||
'An I/O error occured while reading {}.'.format(
|
||||
attachment.name if attachment else 'attachment'))
|
||||
self.logger.debug('I/O Exception: %s' % str(e))
|
||||
return False
|
||||
|
||||
# Save our pre-prepared payload for attachment posting
|
||||
attachments.append(attachment)
|
||||
|
||||
# Create a copy of the targets list
|
||||
targets = list(self.targets)
|
||||
while len(targets):
|
||||
recipient = targets.pop(0)
|
||||
|
||||
# prepare payload
|
||||
payload = {
|
||||
't': title,
|
||||
'm': body,
|
||||
# Our default icon to use
|
||||
'i': self.default_pushsafer_icon,
|
||||
# Notification Color
|
||||
'c': self.color(notify_type),
|
||||
# Target Recipient
|
||||
'd': recipient,
|
||||
}
|
||||
|
||||
if self.sound is not None:
|
||||
# Only apply sound setting if it was specified
|
||||
payload['s'] = str(self.sound)
|
||||
|
||||
if self.vibration is not None:
|
||||
# Only apply vibration setting
|
||||
payload['v'] = str(self.vibration)
|
||||
|
||||
if not attachments:
|
||||
okay, response = self._send(payload)
|
||||
if not okay:
|
||||
has_error = True
|
||||
continue
|
||||
|
||||
self.logger.info(
|
||||
'Sent PushSafer notification to "%s".' % (recipient))
|
||||
|
||||
else:
|
||||
# Create a copy of our payload object
|
||||
_payload = payload.copy()
|
||||
|
||||
for idx in range(
|
||||
0, len(attachments), len(PICTURE_PARAMETER)):
|
||||
# Send our attachments to our same user (already prepared
|
||||
# as our payload object)
|
||||
for c, attachment in enumerate(
|
||||
attachments[idx:idx + len(PICTURE_PARAMETER)]):
|
||||
|
||||
# Get our attachment information
|
||||
filename, dataurl = attachment
|
||||
_payload.update({PICTURE_PARAMETER[c]: dataurl})
|
||||
|
||||
self.logger.debug(
|
||||
'Added attachment (%s) to "%s".' % (
|
||||
filename, recipient))
|
||||
|
||||
okay, response = self._send(_payload)
|
||||
if not okay:
|
||||
has_error = True
|
||||
continue
|
||||
|
||||
self.logger.info(
|
||||
'Sent PushSafer attachment (%s) to "%s".' % (
|
||||
filename, recipient))
|
||||
|
||||
# More then the maximum messages shouldn't cause all of
|
||||
# the text to loop on future iterations
|
||||
_payload = payload.copy()
|
||||
_payload['t'] = ''
|
||||
_payload['m'] = '...'
|
||||
|
||||
return not has_error
|
||||
|
||||
def _send(self, payload, **kwargs):
|
||||
"""
|
||||
Wrapper to the requests (post) object
|
||||
"""
|
||||
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
}
|
||||
|
||||
# Prepare the notification URL to post to
|
||||
notify_url = self.notify_url.format(
|
||||
schema='https' if self.secure else 'http'
|
||||
)
|
||||
|
||||
# Store the payload key
|
||||
payload['k'] = self.privatekey
|
||||
|
||||
self.logger.debug('PushSafer POST URL: %s (cert_verify=%r)' % (
|
||||
notify_url, self.verify_certificate,
|
||||
))
|
||||
self.logger.debug('PushSafer Payload: %s' % str(payload))
|
||||
|
||||
# Always call throttle before any remote server i/o is made
|
||||
self.throttle()
|
||||
|
||||
# Default response type
|
||||
response = None
|
||||
|
||||
# Initialize our Pushsafer expected responses
|
||||
_code = None
|
||||
_str = 'Unknown'
|
||||
|
||||
try:
|
||||
# Open our attachment path if required:
|
||||
r = requests.post(
|
||||
notify_url,
|
||||
data=payload,
|
||||
headers=headers,
|
||||
verify=self.verify_certificate,
|
||||
)
|
||||
|
||||
try:
|
||||
response = loads(r.content)
|
||||
_code = response.get('status')
|
||||
_str = response.get('success', _str) \
|
||||
if _code == 1 else response.get('error', _str)
|
||||
|
||||
except (AttributeError, TypeError, ValueError):
|
||||
# ValueError = r.content is Unparsable
|
||||
# TypeError = r.content is None
|
||||
# AttributeError = r is None
|
||||
|
||||
# Fall back to the existing unparsed value
|
||||
response = r.content
|
||||
|
||||
if r.status_code not in (
|
||||
requests.codes.ok, requests.codes.no_content):
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyPushSafer.http_response_code_lookup(
|
||||
r.status_code)
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to deliver payload to PushSafer:'
|
||||
'{}{}error={}.'.format(
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
return False, response
|
||||
|
||||
elif _code != 1:
|
||||
# It's a bit backwards, but:
|
||||
# 1 is returned if we succeed
|
||||
# 0 is returned if we fail
|
||||
self.logger.warning(
|
||||
'Failed to deliver payload to PushSafer;'
|
||||
' error={}.'.format(_str))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
return False, response
|
||||
|
||||
# otherwise we were successful
|
||||
return True, response
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occured communicating with PushSafer.')
|
||||
self.logger.debug('Socket Exception: %s' % str(e))
|
||||
|
||||
return False, response
|
||||
|
||||
def url(self, privacy=False, *args, **kwargs):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
# Define any arguments set
|
||||
args = {
|
||||
'format': self.notify_format,
|
||||
'overflow': self.overflow_mode,
|
||||
'verify': 'yes' if self.verify_certificate else 'no',
|
||||
}
|
||||
|
||||
if self.priority is not None:
|
||||
# Store our priority; but only if it was specified
|
||||
args['priority'] = \
|
||||
next((key for key, value in PUSHSAFER_PRIORITY_MAP.items()
|
||||
if value == self.priority),
|
||||
DEFAULT_PRIORITY) # pragma: no cover
|
||||
|
||||
if self.sound is not None:
|
||||
# Store our sound; but only if it was specified
|
||||
args['sound'] = \
|
||||
next((key for key, value in PUSHSAFER_SOUND_MAP.items()
|
||||
if value == self.sound), '') # pragma: no cover
|
||||
|
||||
if self.vibration is not None:
|
||||
# Store our vibration; but only if it was specified
|
||||
args['vibration'] = str(self.vibration)
|
||||
|
||||
targets = '/'.join([NotifyPushSafer.quote(x) for x in self.targets])
|
||||
if targets == PUSHSAFER_SEND_TO_ALL:
|
||||
# keyword is reserved for internal usage only; it's safe to remove
|
||||
# it from the recipients list
|
||||
targets = ''
|
||||
|
||||
return '{schema}://{privatekey}/{targets}?{args}'.format(
|
||||
schema=self.secure_protocol if self.secure else self.protocol,
|
||||
privatekey=self.pprint(self.privatekey, privacy, safe=''),
|
||||
targets=targets,
|
||||
args=NotifyPushSafer.urlencode(args))
|
||||
|
||||
@staticmethod
|
||||
def parse_url(url):
|
||||
"""
|
||||
Parses the URL and returns enough arguments that can allow
|
||||
us to substantiate this object.
|
||||
|
||||
"""
|
||||
results = NotifyBase.parse_url(url)
|
||||
if not results:
|
||||
# We're done early as we couldn't load the results
|
||||
return results
|
||||
|
||||
# Fetch our targets
|
||||
results['targets'] = \
|
||||
NotifyPushSafer.split_path(results['fullpath'])
|
||||
|
||||
# The 'to' makes it easier to use yaml configuration
|
||||
if 'to' in results['qsd'] and len(results['qsd']['to']):
|
||||
results['targets'] += \
|
||||
NotifyPushSafer.parse_list(results['qsd']['to'])
|
||||
|
||||
# Setup the token; we store it in Private Key for global
|
||||
# plugin consistency with naming conventions
|
||||
results['privatekey'] = NotifyPushSafer.unquote(results['host'])
|
||||
|
||||
if 'priority' in results['qsd'] and len(results['qsd']['priority']):
|
||||
results['priority'] = \
|
||||
NotifyPushSafer.unquote(results['qsd']['priority'])
|
||||
|
||||
if 'sound' in results['qsd'] and len(results['qsd']['sound']):
|
||||
results['sound'] = \
|
||||
NotifyPushSafer.unquote(results['qsd']['sound'])
|
||||
|
||||
if 'vibration' in results['qsd'] and len(results['qsd']['vibration']):
|
||||
results['vibration'] = \
|
||||
NotifyPushSafer.unquote(results['qsd']['vibration'])
|
||||
|
||||
return results
|
||||
@ -0,0 +1,476 @@
|
||||
# -*- 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.
|
||||
|
||||
# To use this service you will need a Sinch account to which you can get your
|
||||
# API_TOKEN and SERVICE_PLAN_ID right from your console/dashboard at:
|
||||
# https://dashboard.sinch.com/sms/overview
|
||||
#
|
||||
# You will also need to send the SMS From a phone number or account id name.
|
||||
|
||||
# This is identified as the source (or where the SMS message will originate
|
||||
# from). Activated phone numbers can be found on your dashboard here:
|
||||
# - https://dashboard.sinch.com/numbers/your-numbers/numbers
|
||||
#
|
||||
import re
|
||||
import six
|
||||
import requests
|
||||
import json
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..URLBase import PrivacyMode
|
||||
from ..common import NotifyType
|
||||
from ..utils import parse_list
|
||||
from ..utils import validate_regex
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
# Some Phone Number Detection
|
||||
IS_PHONE_NO = re.compile(r'^\+?(?P<phone>[0-9\s)(+-]+)\s*$')
|
||||
|
||||
|
||||
class SinchRegion(object):
|
||||
"""
|
||||
Defines the Sinch Server Regions
|
||||
"""
|
||||
USA = 'us'
|
||||
EUROPE = 'eu'
|
||||
|
||||
|
||||
# Used for verification purposes
|
||||
SINCH_REGIONS = (SinchRegion.USA, SinchRegion.EUROPE)
|
||||
|
||||
|
||||
class NotifySinch(NotifyBase):
|
||||
"""
|
||||
A wrapper for Sinch Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Sinch'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://sinch.com/'
|
||||
|
||||
# All notification requests are secure
|
||||
secure_protocol = 'sinch'
|
||||
|
||||
# Allow 300 requests per minute.
|
||||
# 60/300 = 0.2
|
||||
request_rate_per_sec = 0.20
|
||||
|
||||
# the number of seconds undelivered messages should linger for
|
||||
# in the Sinch queue
|
||||
validity_period = 14400
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_sinch'
|
||||
|
||||
# Sinch uses the http protocol with JSON requests
|
||||
# - the 'spi' gets substituted with the Service Provider ID
|
||||
# provided as part of the Apprise URL.
|
||||
notify_url = 'https://{region}.sms.api.sinch.com/xms/v1/{spi}/batches'
|
||||
|
||||
# The maximum length of the body
|
||||
body_maxlen = 160
|
||||
|
||||
# A title can not be used for SMS Messages. Setting this to zero will
|
||||
# cause any title (if defined) to get placed into the message body.
|
||||
title_maxlen = 0
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{service_plan_id}:{api_token}@{from_phone}',
|
||||
'{schema}://{service_plan_id}:{api_token}@{from_phone}/{targets}',
|
||||
)
|
||||
|
||||
# Define our template tokens
|
||||
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||
'service_plan_id': {
|
||||
'name': _('Account SID'),
|
||||
'type': 'string',
|
||||
'private': True,
|
||||
'required': True,
|
||||
'regex': (r'^[a-f0-9]+$', 'i'),
|
||||
},
|
||||
'api_token': {
|
||||
'name': _('Auth Token'),
|
||||
'type': 'string',
|
||||
'private': True,
|
||||
'required': True,
|
||||
'regex': (r'^[a-f0-9]+$', 'i'),
|
||||
},
|
||||
'from_phone': {
|
||||
'name': _('From Phone No'),
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
'regex': (r'^\+?[0-9\s)(+-]+$', 'i'),
|
||||
'map_to': 'source',
|
||||
},
|
||||
'target_phone': {
|
||||
'name': _('Target Phone No'),
|
||||
'type': 'string',
|
||||
'prefix': '+',
|
||||
'regex': (r'^[0-9\s)(+-]+$', 'i'),
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'short_code': {
|
||||
'name': _('Target Short Code'),
|
||||
'type': 'string',
|
||||
'regex': (r'^[0-9]{5,6}$', 'i'),
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'targets': {
|
||||
'name': _('Targets'),
|
||||
'type': 'list:string',
|
||||
},
|
||||
})
|
||||
|
||||
# Define our template arguments
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'to': {
|
||||
'alias_of': 'targets',
|
||||
},
|
||||
'from': {
|
||||
'alias_of': 'from_phone',
|
||||
},
|
||||
'spi': {
|
||||
'alias_of': 'service_plan_id',
|
||||
},
|
||||
'region': {
|
||||
'name': _('Region'),
|
||||
'type': 'string',
|
||||
'regex': (r'^[a-z]{2}$', 'i'),
|
||||
'default': SinchRegion.USA,
|
||||
},
|
||||
'token': {
|
||||
'alias_of': 'api_token',
|
||||
},
|
||||
})
|
||||
|
||||
def __init__(self, service_plan_id, api_token, source, targets=None,
|
||||
region=None, **kwargs):
|
||||
"""
|
||||
Initialize Sinch Object
|
||||
"""
|
||||
super(NotifySinch, self).__init__(**kwargs)
|
||||
|
||||
# The Account SID associated with the account
|
||||
self.service_plan_id = validate_regex(
|
||||
service_plan_id, *self.template_tokens['service_plan_id']['regex'])
|
||||
if not self.service_plan_id:
|
||||
msg = 'An invalid Sinch Account SID ' \
|
||||
'({}) was specified.'.format(service_plan_id)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# The Authentication Token associated with the account
|
||||
self.api_token = validate_regex(
|
||||
api_token, *self.template_tokens['api_token']['regex'])
|
||||
if not self.api_token:
|
||||
msg = 'An invalid Sinch Authentication Token ' \
|
||||
'({}) was specified.'.format(api_token)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# The Source Phone # and/or short-code
|
||||
self.source = source
|
||||
|
||||
if not IS_PHONE_NO.match(self.source):
|
||||
msg = 'The Account (From) Phone # or Short-code specified ' \
|
||||
'({}) is invalid.'.format(source)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# Setup our region
|
||||
self.region = self.template_args['region']['default'] \
|
||||
if not isinstance(region, six.string_types) else region.lower()
|
||||
if self.region and self.region not in SINCH_REGIONS:
|
||||
msg = 'The region specified ({}) is invalid.'.format(region)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# Tidy source
|
||||
self.source = re.sub(r'[^\d]+', '', self.source)
|
||||
|
||||
if len(self.source) < 11 or len(self.source) > 14:
|
||||
# A short code is a special 5 or 6 digit telephone number
|
||||
# that's shorter than a full phone number.
|
||||
if len(self.source) not in (5, 6):
|
||||
msg = 'The Account (From) Phone # specified ' \
|
||||
'({}) is invalid.'.format(source)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# else... it as a short code so we're okay
|
||||
|
||||
else:
|
||||
# We're dealing with a phone number; so we need to just
|
||||
# place a plus symbol at the end of it
|
||||
self.source = '+{}'.format(self.source)
|
||||
|
||||
# Parse our targets
|
||||
self.targets = list()
|
||||
|
||||
for target in parse_list(targets):
|
||||
# Validate targets and drop bad ones:
|
||||
result = IS_PHONE_NO.match(target)
|
||||
if result:
|
||||
# Further check our phone # for it's digit count
|
||||
# if it's less than 10, then we can assume it's
|
||||
# a poorly specified phone no and spit a warning
|
||||
result = ''.join(re.findall(r'\d+', result.group('phone')))
|
||||
if len(result) < 11 or len(result) > 14:
|
||||
self.logger.warning(
|
||||
'Dropped invalid phone # '
|
||||
'({}) specified.'.format(target),
|
||||
)
|
||||
continue
|
||||
|
||||
# store valid phone number
|
||||
self.targets.append('+{}'.format(result))
|
||||
continue
|
||||
|
||||
self.logger.warning(
|
||||
'Dropped invalid phone # '
|
||||
'({}) specified.'.format(target),
|
||||
)
|
||||
|
||||
if not self.targets:
|
||||
if len(self.source) in (5, 6):
|
||||
# raise a warning since we're a short-code. We need
|
||||
# a number to message
|
||||
msg = 'There are no valid Sinch targets to notify.'
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
return
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||||
"""
|
||||
Perform Sinch Notification
|
||||
"""
|
||||
|
||||
# error tracking (used for function return)
|
||||
has_error = False
|
||||
|
||||
# Prepare our headers
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
'Authorization': 'Bearer {}'.format(self.api_token),
|
||||
'Content-Type': 'application/json',
|
||||
}
|
||||
|
||||
# Prepare our payload
|
||||
payload = {
|
||||
'body': body,
|
||||
'from': self.source,
|
||||
|
||||
# The To gets populated in the loop below
|
||||
'to': None,
|
||||
}
|
||||
|
||||
# Prepare our Sinch URL (spi = Service Provider ID)
|
||||
url = self.notify_url.format(
|
||||
region=self.region, spi=self.service_plan_id)
|
||||
|
||||
# Create a copy of the targets list
|
||||
targets = list(self.targets)
|
||||
|
||||
if len(targets) == 0:
|
||||
# No sources specified, use our own phone no
|
||||
targets.append(self.source)
|
||||
|
||||
while len(targets):
|
||||
# Get our target to notify
|
||||
target = targets.pop(0)
|
||||
|
||||
# Prepare our user
|
||||
payload['to'] = [target]
|
||||
|
||||
# Some Debug Logging
|
||||
self.logger.debug('Sinch POST URL: {} (cert_verify={})'.format(
|
||||
url, self.verify_certificate))
|
||||
self.logger.debug('Sinch Payload: {}' .format(payload))
|
||||
|
||||
# Always call throttle before any remote server i/o is made
|
||||
self.throttle()
|
||||
try:
|
||||
r = requests.post(
|
||||
url,
|
||||
data=json.dumps(payload),
|
||||
headers=headers,
|
||||
verify=self.verify_certificate,
|
||||
)
|
||||
|
||||
# The responsne might look like:
|
||||
# {
|
||||
# "id": "CJloRJOe3MtDITqx",
|
||||
# "to": ["15551112222"],
|
||||
# "from": "15553334444",
|
||||
# "canceled": false,
|
||||
# "body": "This is a test message from your Sinch account",
|
||||
# "type": "mt_text",
|
||||
# "created_at": "2020-01-14T01:05:20.694Z",
|
||||
# "modified_at": "2020-01-14T01:05:20.694Z",
|
||||
# "delivery_report": "none",
|
||||
# "expire_at": "2020-01-17T01:05:20.694Z",
|
||||
# "flash_message": false
|
||||
# }
|
||||
if r.status_code not in (
|
||||
requests.codes.created, requests.codes.ok):
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyBase.http_response_code_lookup(r.status_code)
|
||||
|
||||
# set up our status code to use
|
||||
status_code = r.status_code
|
||||
|
||||
try:
|
||||
# Update our status response if we can
|
||||
json_response = json.loads(r.content)
|
||||
status_code = json_response.get('code', status_code)
|
||||
status_str = json_response.get('message', status_str)
|
||||
|
||||
except (AttributeError, TypeError, ValueError):
|
||||
# ValueError = r.content is Unparsable
|
||||
# TypeError = r.content is None
|
||||
# AttributeError = r is None
|
||||
|
||||
# We could not parse JSON response.
|
||||
# We will just use the status we already have.
|
||||
pass
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send Sinch notification to {}: '
|
||||
'{}{}error={}.'.format(
|
||||
target,
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
status_code))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
# Mark our failure
|
||||
has_error = True
|
||||
continue
|
||||
|
||||
else:
|
||||
self.logger.info(
|
||||
'Sent Sinch notification to {}.'.format(target))
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occured sending Sinch:%s ' % (
|
||||
target) + '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):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
# Define any arguments set
|
||||
args = {
|
||||
'format': self.notify_format,
|
||||
'overflow': self.overflow_mode,
|
||||
'verify': 'yes' if self.verify_certificate else 'no',
|
||||
'region': self.region,
|
||||
}
|
||||
|
||||
return '{schema}://{spi}:{token}@{source}/{targets}/?{args}'.format(
|
||||
schema=self.secure_protocol,
|
||||
spi=self.pprint(
|
||||
self.service_plan_id, privacy, mode=PrivacyMode.Tail, safe=''),
|
||||
token=self.pprint(self.api_token, privacy, safe=''),
|
||||
source=NotifySinch.quote(self.source, safe=''),
|
||||
targets='/'.join(
|
||||
[NotifySinch.quote(x, safe='') for x in self.targets]),
|
||||
args=NotifySinch.urlencode(args))
|
||||
|
||||
@staticmethod
|
||||
def parse_url(url):
|
||||
"""
|
||||
Parses the URL and returns enough arguments that can allow
|
||||
us to substantiate this object.
|
||||
|
||||
"""
|
||||
results = NotifyBase.parse_url(url, verify_host=False)
|
||||
if not results:
|
||||
# We're done early as we couldn't load the results
|
||||
return results
|
||||
|
||||
# Get our entries; split_path() looks after unquoting content for us
|
||||
# by default
|
||||
results['targets'] = NotifySinch.split_path(results['fullpath'])
|
||||
|
||||
# The hostname is our source number
|
||||
results['source'] = NotifySinch.unquote(results['host'])
|
||||
|
||||
# Get our service_plan_ide and api_token from the user/pass config
|
||||
results['service_plan_id'] = NotifySinch.unquote(results['user'])
|
||||
results['api_token'] = NotifySinch.unquote(results['password'])
|
||||
|
||||
# Auth Token
|
||||
if 'token' in results['qsd'] and len(results['qsd']['token']):
|
||||
# Extract the account spi from an argument
|
||||
results['api_token'] = \
|
||||
NotifySinch.unquote(results['qsd']['token'])
|
||||
|
||||
# Account SID
|
||||
if 'spi' in results['qsd'] and len(results['qsd']['spi']):
|
||||
# Extract the account spi from an argument
|
||||
results['service_plan_id'] = \
|
||||
NotifySinch.unquote(results['qsd']['spi'])
|
||||
|
||||
# Support the 'from' and 'source' variable so that we can support
|
||||
# targets this way too.
|
||||
# The 'from' makes it easier to use yaml configuration
|
||||
if 'from' in results['qsd'] and len(results['qsd']['from']):
|
||||
results['source'] = \
|
||||
NotifySinch.unquote(results['qsd']['from'])
|
||||
if 'source' in results['qsd'] and len(results['qsd']['source']):
|
||||
results['source'] = \
|
||||
NotifySinch.unquote(results['qsd']['source'])
|
||||
|
||||
# Allow one to define a region
|
||||
if 'region' in results['qsd'] and len(results['qsd']['region']):
|
||||
results['region'] = \
|
||||
NotifySinch.unquote(results['qsd']['region'])
|
||||
|
||||
# Support the 'to' variable so that we can support targets this way too
|
||||
# The 'to' makes it easier to use yaml configuration
|
||||
if 'to' in results['qsd'] and len(results['qsd']['to']):
|
||||
results['targets'] += \
|
||||
NotifySinch.parse_list(results['qsd']['to'])
|
||||
|
||||
return results
|
||||
Loading…
Reference in new issue