mirror of
https://github.com/morpheus65535/bazarr
synced 2024-12-23 08:13:14 +00:00
234 lines
8.9 KiB
Python
234 lines
8.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# BSD 3-Clause License
|
|
#
|
|
# Apprise - Push Notification Library.
|
|
# Copyright (c) 2023, Chris Caron <lead2gold@gmail.com>
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are met:
|
|
#
|
|
# 1. Redistributions of source code must retain the above copyright notice,
|
|
# this list of conditions and the following disclaimer.
|
|
#
|
|
# 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
#
|
|
# 3. Neither the name of the copyright holder nor the names of its
|
|
# contributors may be used to endorse or promote products derived from
|
|
# this software without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
# POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
from ..plugins.NotifyBase import NotifyBase
|
|
from ..utils import URL_DETAILS_RE
|
|
from ..utils import parse_url
|
|
from ..utils import url_assembly
|
|
from ..utils import dict_full_update
|
|
from .. import common
|
|
from ..logger import logger
|
|
import inspect
|
|
|
|
|
|
class CustomNotifyPlugin(NotifyBase):
|
|
"""
|
|
Apprise Custom Plugin Hook
|
|
|
|
This gets initialized based on @notify decorator definitions
|
|
|
|
"""
|
|
# Our Custom notification
|
|
service_url = 'https://github.com/caronc/apprise/wiki/Custom_Notification'
|
|
|
|
# Over-ride our category since this inheritance of the NotifyBase class
|
|
# should be treated differently.
|
|
category = 'custom'
|
|
|
|
# Define object templates
|
|
templates = (
|
|
'{schema}://',
|
|
)
|
|
|
|
@staticmethod
|
|
def parse_url(url):
|
|
"""
|
|
Parses the URL and returns arguments retrieved
|
|
|
|
"""
|
|
return parse_url(url, verify_host=False, simple=True)
|
|
|
|
def url(self, privacy=False, *args, **kwargs):
|
|
"""
|
|
General URL assembly
|
|
"""
|
|
return '{schema}://'.format(schema=self.secure_protocol)
|
|
|
|
@staticmethod
|
|
def instantiate_plugin(url, send_func, name=None):
|
|
"""
|
|
The function used to add a new notification plugin based on the schema
|
|
parsed from the provided URL into our supported matrix structure.
|
|
"""
|
|
|
|
if not isinstance(url, str):
|
|
msg = 'An invalid custom notify url/schema ({}) provided in ' \
|
|
'function {}.'.format(url, send_func.__name__)
|
|
logger.warning(msg)
|
|
return None
|
|
|
|
# Validate that our schema is okay
|
|
re_match = URL_DETAILS_RE.match(url)
|
|
if not re_match:
|
|
msg = 'An invalid custom notify url/schema ({}) provided in ' \
|
|
'function {}.'.format(url, send_func.__name__)
|
|
logger.warning(msg)
|
|
return None
|
|
|
|
# Acquire our plugin name
|
|
plugin_name = re_match.group('schema').lower()
|
|
|
|
if not re_match.group('base'):
|
|
url = '{}://'.format(plugin_name)
|
|
|
|
# Keep a default set of arguments to apply to all called references
|
|
base_args = parse_url(
|
|
url, default_schema=plugin_name, verify_host=False, simple=True)
|
|
|
|
if plugin_name in common.NOTIFY_SCHEMA_MAP:
|
|
# we're already handling this object
|
|
msg = 'The schema ({}) is already defined and could not be ' \
|
|
'loaded from custom notify function {}.' \
|
|
.format(url, send_func.__name__)
|
|
logger.warning(msg)
|
|
return None
|
|
|
|
# We define our own custom wrapper class so that we can initialize
|
|
# some key default configuration values allowing calls to our
|
|
# `Apprise.details()` to correctly differentiate one custom plugin
|
|
# that was loaded from another
|
|
class CustomNotifyPluginWrapper(CustomNotifyPlugin):
|
|
|
|
# Our Service Name
|
|
service_name = name if isinstance(name, str) \
|
|
and name else 'Custom - {}'.format(plugin_name)
|
|
|
|
# Store our matched schema
|
|
secure_protocol = plugin_name
|
|
|
|
requirements = {
|
|
# Define our required packaging in order to work
|
|
'details': "Source: {}".format(inspect.getfile(send_func))
|
|
}
|
|
|
|
# Assign our send() function
|
|
__send = staticmethod(send_func)
|
|
|
|
# Update our default arguments
|
|
_base_args = base_args
|
|
|
|
def __init__(self, **kwargs):
|
|
"""
|
|
Our initialization
|
|
|
|
"""
|
|
# init parent
|
|
super().__init__(**kwargs)
|
|
|
|
self._default_args = {}
|
|
|
|
# Apply our updates based on what was parsed
|
|
dict_full_update(self._default_args, self._base_args)
|
|
dict_full_update(self._default_args, kwargs)
|
|
|
|
# Update our arguments (applying them to what we originally)
|
|
# initialized as
|
|
self._default_args['url'] = url_assembly(**self._default_args)
|
|
|
|
def send(self, body, title='', notify_type=common.NotifyType.INFO,
|
|
*args, **kwargs):
|
|
"""
|
|
Our send() call which triggers our hook
|
|
"""
|
|
|
|
response = False
|
|
try:
|
|
# Enforce a boolean response
|
|
result = self.__send(
|
|
body, title, notify_type, *args,
|
|
meta=self._default_args, **kwargs)
|
|
|
|
if result is None:
|
|
# The wrapper did not define a return (or returned
|
|
# None)
|
|
# this is treated as a successful return as it is
|
|
# assumed the developer did not care about the result
|
|
# of the call.
|
|
response = True
|
|
|
|
else:
|
|
# Perform boolean check (allowing obects to also be
|
|
# returned and check against the __bool__ call
|
|
response = True if result else False
|
|
|
|
except Exception as e:
|
|
# Unhandled Exception
|
|
self.logger.warning(
|
|
'An exception occured sending a %s notification.',
|
|
common.
|
|
NOTIFY_SCHEMA_MAP[self.secure_protocol].service_name)
|
|
self.logger.debug(
|
|
'%s Exception: %s',
|
|
common.NOTIFY_SCHEMA_MAP[self.secure_protocol], str(e))
|
|
return False
|
|
|
|
if response:
|
|
self.logger.info(
|
|
'Sent %s notification.',
|
|
common.
|
|
NOTIFY_SCHEMA_MAP[self.secure_protocol].service_name)
|
|
else:
|
|
self.logger.warning(
|
|
'Failed to send %s notification.',
|
|
common.
|
|
NOTIFY_SCHEMA_MAP[self.secure_protocol].service_name)
|
|
return response
|
|
|
|
# Store our plugin into our core map file
|
|
common.NOTIFY_SCHEMA_MAP[plugin_name] = CustomNotifyPluginWrapper
|
|
|
|
# Update our custom plugin map
|
|
module_pyname = str(send_func.__module__)
|
|
if module_pyname not in common.NOTIFY_CUSTOM_MODULE_MAP:
|
|
# Support non-dynamic includes as well...
|
|
common.NOTIFY_CUSTOM_MODULE_MAP[module_pyname] = {
|
|
'path': inspect.getfile(send_func),
|
|
|
|
# Initialize our template
|
|
'notify': {},
|
|
}
|
|
|
|
common.\
|
|
NOTIFY_CUSTOM_MODULE_MAP[module_pyname]['notify'][plugin_name] = {
|
|
# Our Serivice Description (for API and CLI --details view)
|
|
'name': CustomNotifyPluginWrapper.service_name,
|
|
# The name of the send function the @notify decorator wrapped
|
|
'fn_name': send_func.__name__,
|
|
# The URL that was provided in the @notify decorator call
|
|
# associated with the 'on='
|
|
'url': url,
|
|
# The Initialized Plugin that was generated based on the above
|
|
# parameters
|
|
'plugin': CustomNotifyPluginWrapper}
|
|
|
|
# return our plugin
|
|
return common.NOTIFY_SCHEMA_MAP[plugin_name]
|