mirror of
https://github.com/caronc/apprise.git
synced 2024-11-08 09:14:53 +01:00
Enigma2 Device Support (#182)
This commit is contained in:
Chris Caron
GitHub
parent
4bddcadfb8
commit
9b8fd4d2d5
@ -35,6 +35,7 @@ The table below identifies the services this tool supports and some example serv
|
||||
| [Discord](https://github.com/caronc/apprise/wiki/Notify_discord) | discord:// | (TCP) 443 | discord://webhook_id/webhook_token<br />discord://avatar@webhook_id/webhook_token
|
||||
| [Dbus](https://github.com/caronc/apprise/wiki/Notify_dbus) | dbus://<br />qt://<br />glib://<br />kde:// | n/a | dbus://<br />qt://<br />glib://<br />kde://
|
||||
| [Emby](https://github.com/caronc/apprise/wiki/Notify_emby) | emby:// or embys:// | (TCP) 8096 | emby://user@hostname/<br />emby://user:password@hostname
|
||||
| [Enigma2](https://github.com/caronc/apprise/wiki/Notify_enigma2) | enigma2:// or enigma2s:// | (TCP) 80 or 443 | enigma2://hostname
|
||||
| [Faast](https://github.com/caronc/apprise/wiki/Notify_faast) | faast:// | (TCP) 443 | faast://authorizationtoken
|
||||
| [Flock](https://github.com/caronc/apprise/wiki/Notify_flock) | flock:// | (TCP) 443 | flock://token<br/>flock://botname@token<br/>flock://app_token/u:userid<br/>flock://app_token/g:channel_id<br/>flock://app_token/u:userid/g:channel_id
|
||||
| [Gitter](https://github.com/caronc/apprise/wiki/Notify_gitter) | gitter:// | (TCP) 443 | gitter://token/room<br/>gitter://token/room1/room2/roomN
|
||||
|
||||
352
apprise/plugins/NotifyEnigma2.py
Normal file
352
apprise/plugins/NotifyEnigma2.py
Normal file
@ -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
|
||||
@ -404,6 +404,155 @@ TEST_URLS = (
|
||||
}),
|
||||
# The rest of the emby tests are in test_notify_emby_plugin()
|
||||
|
||||
##################################
|
||||
# NotifyEnigma2
|
||||
##################################
|
||||
('enigma2://:@/', {
|
||||
'instance': None,
|
||||
}),
|
||||
('enigma2://', {
|
||||
'instance': None,
|
||||
}),
|
||||
('enigma2s://', {
|
||||
'instance': None,
|
||||
}),
|
||||
('enigma2://localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
# This will fail because we're also expecting a server acknowledgement
|
||||
'notify_response': False,
|
||||
}),
|
||||
('enigma2://localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
# invalid JSON response
|
||||
'requests_response_text': '{',
|
||||
'notify_response': False,
|
||||
}),
|
||||
('enigma2://localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
# False is returned
|
||||
'requests_response_text': {
|
||||
'result': False
|
||||
},
|
||||
'notify_response': False,
|
||||
}),
|
||||
('enigma2://localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
# With the right content, this will succeed
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
}
|
||||
}),
|
||||
('enigma2://user@localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
}
|
||||
}),
|
||||
# Set timeout
|
||||
('enigma2://user@localhost?timeout=-1', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
}
|
||||
}),
|
||||
# Set timeout
|
||||
('enigma2://user@localhost?timeout=-1000', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
}
|
||||
}),
|
||||
# Set invalid timeout (defaults to a set value)
|
||||
('enigma2://user@localhost?timeout=invalid', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
}
|
||||
}),
|
||||
('enigma2://user:pass@localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
|
||||
# Our expected url(privacy=True) startswith() response:
|
||||
'privacy_url': 'enigma2://user:****@localhost',
|
||||
}),
|
||||
('enigma2://localhost:8080', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
}),
|
||||
('enigma2://user:pass@localhost:8080', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
}),
|
||||
('enigma2s://localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
}),
|
||||
('enigma2s://user:pass@localhost', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
|
||||
# Our expected url(privacy=True) startswith() response:
|
||||
'privacy_url': 'enigma2s://user:****@localhost',
|
||||
}),
|
||||
('enigma2s://localhost:8080/path/', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
# Our expected url(privacy=True) startswith() response:
|
||||
'privacy_url': 'enigma2s://localhost:8080/path/',
|
||||
}),
|
||||
('enigma2s://user:pass@localhost:8080', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
}),
|
||||
('enigma2://localhost:8080/path?-HeaderKey=HeaderValue', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
}),
|
||||
('enigma2://user:pass@localhost:8081', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
# force a failure
|
||||
'response': False,
|
||||
'requests_response_code': requests.codes.internal_server_error,
|
||||
}),
|
||||
('enigma2://user:pass@localhost:8082', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
# throw a bizzare code forcing us to fail to look it up
|
||||
'response': False,
|
||||
'requests_response_code': 999,
|
||||
}),
|
||||
('enigma2://user:pass@localhost:8083', {
|
||||
'instance': plugins.NotifyEnigma2,
|
||||
'requests_response_text': {
|
||||
'result': True
|
||||
},
|
||||
# Throws a series of connection and transfer exceptions when this flag
|
||||
# is set and tests that we gracfully handle them
|
||||
'test_requests_exceptions': True,
|
||||
}),
|
||||
|
||||
##################################
|
||||
# NotifyFaast
|
||||
##################################
|
||||
|
||||
Loading…
Reference in New Issue
Block a user