summaryrefslogtreecommitdiffhomepage
path: root/libs/apprise/plugins/NotifyNtfy.py
diff options
context:
space:
mode:
Diffstat (limited to 'libs/apprise/plugins/NotifyNtfy.py')
-rw-r--r--libs/apprise/plugins/NotifyNtfy.py678
1 files changed, 678 insertions, 0 deletions
diff --git a/libs/apprise/plugins/NotifyNtfy.py b/libs/apprise/plugins/NotifyNtfy.py
new file mode 100644
index 000000000..b19cf7a9f
--- /dev/null
+++ b/libs/apprise/plugins/NotifyNtfy.py
@@ -0,0 +1,678 @@
+# MIT License
+
+# Copyright (c) 2022 Joey Espinosa <@particledecay>
+
+# 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.
+#
+# Examples:
+# ntfys://my-topic
+# ntfy://ntfy.local.domain/my-topic
+# ntfys://ntfy.local.domain:8080/my-topic
+# ntfy://ntfy.local.domain/?priority=max
+import re
+import requests
+import six
+from json import loads
+from json import dumps
+from os.path import basename
+
+from .NotifyBase import NotifyBase
+from ..common import NotifyType
+from ..AppriseLocale import gettext_lazy as _
+from ..utils import parse_list
+from ..utils import is_hostname
+from ..utils import is_ipaddr
+from ..utils import validate_regex
+from ..URLBase import PrivacyMode
+from ..attachment.AttachBase import AttachBase
+
+
+class NtfyMode(object):
+ """
+ Define ntfy Notification Modes
+ """
+ # App posts upstream to the developer API on ntfy's website
+ CLOUD = "cloud"
+
+ # Running a dedicated private ntfy Server
+ PRIVATE = "private"
+
+
+NTFY_MODES = (
+ NtfyMode.CLOUD,
+ NtfyMode.PRIVATE,
+)
+
+
+class NtfyPriority(object):
+ """
+ Ntfy Priority Definitions
+ """
+ MAX = 'max'
+ HIGH = 'high'
+ NORMAL = 'default'
+ LOW = 'low'
+ MIN = 'min'
+
+
+NTFY_PRIORITIES = (
+ NtfyPriority.MAX,
+ NtfyPriority.HIGH,
+ NtfyPriority.NORMAL,
+ NtfyPriority.LOW,
+ NtfyPriority.MIN,
+)
+
+
+class NotifyNtfy(NotifyBase):
+ """
+ A wrapper for ntfy Notifications
+ """
+
+ # The default descriptive name associated with the Notification
+ service_name = 'ntfy'
+
+ # The services URL
+ service_url = 'https://ntfy.sh/'
+
+ # Insecure protocol (for those self hosted requests)
+ protocol = 'ntfy'
+
+ # The default protocol
+ secure_protocol = 'ntfys'
+
+ # A URL that takes you to the setup/help of the specific protocol
+ setup_url = 'https://github.com/caronc/apprise/wiki/Notify_ntfy'
+
+ # Default upstream/cloud host if none is defined
+ cloud_notify_url = 'https://ntfy.sh'
+
+ # Message time to live (if remote client isn't around to receive it)
+ time_to_live = 2419200
+
+ # if our hostname matches the following we automatically enforce
+ # cloud mode
+ __auto_cloud_host = re.compile(r'ntfy\.sh', re.IGNORECASE)
+
+ # Define object templates
+ templates = (
+ '{schema}://{topic}',
+ '{schema}://{host}/{targets}',
+ '{schema}://{host}:{port}/{targets}',
+ '{schema}://{user}@{host}/{targets}',
+ '{schema}://{user}@{host}:{port}/{targets}',
+ '{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',
+ },
+ 'port': {
+ 'name': _('Port'),
+ 'type': 'int',
+ 'min': 1,
+ 'max': 65535,
+ },
+ 'user': {
+ 'name': _('Username'),
+ 'type': 'string',
+ },
+ 'password': {
+ 'name': _('Password'),
+ 'type': 'string',
+ 'private': True,
+ },
+ 'topic': {
+ 'name': _('Topic'),
+ 'type': 'string',
+ 'map_to': 'targets',
+ 'regex': (r'^[a-z0-9_-]{1,64}$', 'i')
+ },
+ 'targets': {
+ 'name': _('Targets'),
+ 'type': 'list:string',
+ },
+ })
+
+ # Define our template arguments
+ template_args = dict(NotifyBase.template_args, **{
+ 'attach': {
+ 'name': _('Attach'),
+ 'type': 'string',
+ },
+ 'filename': {
+ 'name': _('Attach Filename'),
+ 'type': 'string',
+ },
+ 'click': {
+ 'name': _('Click'),
+ 'type': 'string',
+ },
+ 'delay': {
+ 'name': _('Delay'),
+ 'type': 'string',
+ },
+ 'email': {
+ 'name': _('Email'),
+ 'type': 'string',
+ },
+ 'priority': {
+ 'name': _('Priority'),
+ 'type': 'choice:string',
+ 'values': NTFY_PRIORITIES,
+ 'default': NtfyPriority.NORMAL,
+ },
+ 'tags': {
+ 'name': _('Tags'),
+ 'type': 'string',
+ },
+ 'mode': {
+ 'name': _('Mode'),
+ 'type': 'choice:string',
+ 'values': NTFY_MODES,
+ 'default': NtfyMode.PRIVATE,
+ },
+ 'to': {
+ 'alias_of': 'targets',
+ },
+ })
+
+ def __init__(self, targets=None, attach=None, filename=None, click=None,
+ delay=None, email=None, priority=None, tags=None, mode=None,
+ **kwargs):
+ """
+ Initialize ntfy Object
+ """
+ super(NotifyNtfy, self).__init__(**kwargs)
+
+ # Prepare our mode
+ self.mode = mode.strip().lower() \
+ if isinstance(mode, six.string_types) \
+ else self.template_args['mode']['default']
+
+ if self.mode not in NTFY_MODES:
+ msg = 'An invalid ntfy Mode ({}) was specified.'.format(mode)
+ self.logger.warning(msg)
+ raise TypeError(msg)
+
+ # Attach a file (URL supported)
+ self.attach = attach
+
+ # Our filename (if defined)
+ self.filename = filename
+
+ # A clickthrough option for notifications
+ self.click = click
+
+ # Time delay for notifications (various string formats)
+ self.delay = delay
+
+ # An email to forward notifications to
+ self.email = email
+
+ # The priority of the message
+
+ if priority is None:
+ self.priority = self.template_args['priority']['default']
+ else:
+ self.priority = priority
+
+ if self.priority not in NTFY_PRIORITIES:
+ msg = 'An invalid ntfy Priority ({}) was specified.'.format(
+ priority)
+ self.logger.warning(msg)
+ raise TypeError(msg)
+
+ # Any optional tags to attach to the notification
+ self.__tags = parse_list(tags)
+
+ # Build list of topics
+ topics = parse_list(targets)
+ self.topics = []
+ for _topic in topics:
+ topic = validate_regex(
+ _topic, *self.template_tokens['topic']['regex'])
+ if not topic:
+ self.logger.warning(
+ 'A specified ntfy topic ({}) is invalid and will be '
+ 'ignored'.format(_topic))
+ continue
+ self.topics.append(topic)
+ return
+
+ def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
+ **kwargs):
+ """
+ Perform ntfy Notification
+ """
+
+ # error tracking (used for function return)
+ has_error = False
+
+ if not len(self.topics):
+ # We have nothing to notify; we're done
+ self.logger.warning('There are no ntfy topics to notify')
+ return False
+
+ # Create a copy of the subreddits list
+ topics = list(self.topics)
+ while len(topics) > 0:
+ # Retrieve our topic
+ topic = topics.pop()
+
+ if attach:
+ # We need to upload our payload first so that we can source it
+ # in remaining messages
+ for no, attachment in enumerate(attach):
+
+ # First message only includes the text
+ _body = body if not no else None
+ _title = title if not no else None
+
+ # Perform some simple error checking
+ if not attachment:
+ # We could not access the attachment
+ self.logger.error(
+ 'Could not access attachment {}.'.format(
+ attachment.url(privacy=True)))
+ return False
+
+ self.logger.debug(
+ 'Preparing ntfy attachment {}'.format(
+ attachment.url(privacy=True)))
+
+ okay, response = self._send(
+ topic, body=_body, title=_title, attach=attachment)
+ if not okay:
+ # We can't post our attachment; abort immediately
+ return False
+ else:
+ # Send our Notification Message
+ okay, response = self._send(topic, body=body, title=title)
+ if not okay:
+ # Mark our failure, but contiue to move on
+ has_error = True
+
+ return not has_error
+
+ def _send(self, topic, body=None, title=None, attach=None, **kwargs):
+ """
+ Wrapper to the requests (post) object
+ """
+
+ # Prepare our headers
+ headers = {
+ 'User-Agent': self.app_id,
+ }
+
+ # Some default values for our request object to which we'll update
+ # depending on what our payload is
+ files = None
+
+ # See https://ntfy.sh/docs/publish/#publish-as-json
+ data = {}
+
+ # Posting Parameters
+ params = {}
+
+ auth = None
+ if self.mode == NtfyMode.CLOUD:
+ # Cloud Service
+ notify_url = self.cloud_notify_url
+
+ else: # NotifyNtfy.PRVATE
+ # Allow more settings to be applied now
+ if self.user:
+ auth = (self.user, self.password)
+
+ # Prepare our ntfy Template URL
+ schema = 'https' if self.secure else 'http'
+
+ notify_url = '%s://%s' % (schema, self.host)
+ if isinstance(self.port, int):
+ notify_url += ':%d' % self.port
+
+ if not attach:
+ headers['Content-Type'] = 'application/json'
+
+ data['topic'] = topic
+ virt_payload = data
+
+ else:
+ # Point our payload to our parameters
+ virt_payload = params
+ notify_url += '/{topic}'.format(topic=topic)
+
+ if title:
+ virt_payload['title'] = title
+
+ if body:
+ virt_payload['message'] = body
+
+ if self.priority != NtfyPriority.NORMAL:
+ headers['X-Priority'] = self.priority
+
+ if self.delay is not None:
+ headers['X-Delay'] = self.delay
+
+ if self.click is not None:
+ headers['X-Click'] = self.click
+
+ if self.email is not None:
+ headers['X-Email'] = self.email
+
+ if self.__tags:
+ headers['X-Tags'] = ",".join(self.__tags)
+
+ if isinstance(attach, AttachBase):
+ # Prepare our Header
+ params['filename'] = attach.name
+
+ # prepare our files object
+ files = {'file': (attach.name, open(attach.path, 'rb'))}
+
+ elif self.attach is not None:
+ data['attach'] = self.attach
+ if self.filename is not None:
+ data['filename'] = self.filename
+
+ self.logger.debug('ntfy POST URL: %s (cert_verify=%r)' % (
+ notify_url, self.verify_certificate,
+ ))
+ self.logger.debug('ntfy Payload: %s' % str(virt_payload))
+ self.logger.debug('ntfy Headers: %s' % str(headers))
+
+ # Always call throttle before any remote server i/o is made
+ self.throttle()
+
+ # Default response type
+ response = None
+
+ try:
+ r = requests.post(
+ notify_url,
+ params=params if params else None,
+ data=dumps(data) if data else None,
+ headers=headers,
+ files=files,
+ auth=auth,
+ verify=self.verify_certificate,
+ timeout=self.request_timeout,
+ )
+
+ if r.status_code != 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
+ response = loads(r.content)
+ status_str = response.get('error', status_str)
+ status_code = \
+ int(response.get('code', status_code))
+
+ 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 ntfy notification to topic '{}': "
+ '{}{}error={}.'.format(
+ topic,
+ status_str,
+ ', ' if status_str else '',
+ status_code))
+
+ self.logger.debug(
+ 'Response Details:\r\n{}'.format(r.content))
+
+ return False, response
+
+ # otherwise we were successful
+ self.logger.info(
+ "Sent ntfy notification to '{}'.".format(notify_url))
+
+ return True, response
+
+ except requests.RequestException as e:
+ self.logger.warning(
+ 'A Connection error occurred sending ntfy:%s ' % (
+ notify_url) + 'notification.'
+ )
+ self.logger.debug('Socket Exception: %s' % str(e))
+ return False, response
+
+ except (OSError, IOError) as e:
+ self.logger.warning(
+ 'An I/O error occurred while handling {}.'.format(
+ attach.name if isinstance(attach, AttachBase)
+ else virt_payload))
+ self.logger.debug('I/O Exception: %s' % str(e))
+ return False, response
+
+ finally:
+ # Close our file (if it's open) stored in the second element
+ # of our files tuple (index 1)
+ if files:
+ files['file'][1].close()
+
+ def url(self, privacy=False, *args, **kwargs):
+ """
+ Returns the URL built dynamically based on specified arguments.
+ """
+
+ default_port = 443 if self.secure else 80
+
+ params = {
+ 'priority': self.priority,
+ 'mode': self.mode,
+ }
+
+ if self.attach is not None:
+ params['attach'] = self.attach
+
+ if self.click is not None:
+ params['click'] = self.click
+
+ if self.delay is not None:
+ params['delay'] = self.delay
+
+ if self.email is not None:
+ params['email'] = self.email
+
+ if self.__tags:
+ params['tags'] = ','.join(self.__tags)
+
+ params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
+
+ # Determine Authentication
+ auth = ''
+ if self.user and self.password:
+ auth = '{user}:{password}@'.format(
+ user=NotifyNtfy.quote(self.user, safe=''),
+ password=self.pprint(
+ self.password, privacy, mode=PrivacyMode.Secret, safe=''),
+ )
+ elif self.user:
+ auth = '{user}@'.format(
+ user=NotifyNtfy.quote(self.user, safe=''),
+ )
+
+ if self.mode == NtfyMode.PRIVATE:
+ return '{schema}://{auth}{host}{port}/{targets}?{params}'.format(
+ schema=self.secure_protocol if self.secure else self.protocol,
+ auth=auth,
+ host=self.host,
+ port='' if self.port is None or self.port == default_port
+ else ':{}'.format(self.port),
+ targets='/'.join(
+ [NotifyNtfy.quote(x, safe='') for x in self.topics]),
+ params=NotifyNtfy.urlencode(params)
+ )
+
+ else: # Cloud mode
+ return '{schema}://{targets}?{params}'.format(
+ schema=self.secure_protocol,
+ targets='/'.join(
+ [NotifyNtfy.quote(x, safe='') for x in self.topics]),
+ params=NotifyNtfy.urlencode(params)
+ )
+
+ @staticmethod
+ def parse_url(url):
+ """
+ Parses the URL and returns enough arguments that can allow
+ us to re-instantiate this object.
+ """
+ results = NotifyBase.parse_url(url, verify_host=False)
+ if not results:
+ # We're done early as we couldn't load the results
+ return results
+
+ if 'priority' in results['qsd'] and len(results['qsd']['priority']):
+ _map = {
+ # Supported lookups
+ 'mi': NtfyPriority.MIN,
+ '1': NtfyPriority.MIN,
+ 'l': NtfyPriority.LOW,
+ '2': NtfyPriority.LOW,
+ 'n': NtfyPriority.NORMAL, # support normal keyword
+ 'd': NtfyPriority.NORMAL, # default keyword
+ '3': NtfyPriority.NORMAL,
+ 'h': NtfyPriority.HIGH,
+ '4': NtfyPriority.HIGH,
+ 'ma': NtfyPriority.MAX,
+ '5': NtfyPriority.MAX,
+ }
+ try:
+ # pretty-format (and update short-format)
+ results['priority'] = \
+ _map[results['qsd']['priority'][0:2].lower()]
+
+ except KeyError:
+ # Pass along what was set so it can be handed during
+ # initialization
+ results['priority'] = str(results['qsd']['priority'])
+ pass
+
+ if 'attach' in results['qsd'] and len(results['qsd']['attach']):
+ results['attach'] = NotifyNtfy.unquote(results['qsd']['attach'])
+ _results = NotifyBase.parse_url(results['attach'])
+ if _results:
+ results['filename'] = \
+ None if _results['fullpath'] \
+ else basename(_results['fullpath'])
+
+ if 'filename' in results['qsd'] and \
+ len(results['qsd']['filename']):
+ results['filename'] = \
+ basename(NotifyNtfy.unquote(results['qsd']['filename']))
+
+ if 'click' in results['qsd'] and len(results['qsd']['click']):
+ results['click'] = NotifyNtfy.unquote(results['qsd']['click'])
+
+ if 'delay' in results['qsd'] and len(results['qsd']['delay']):
+ results['delay'] = NotifyNtfy.unquote(results['qsd']['delay'])
+
+ if 'email' in results['qsd'] and len(results['qsd']['email']):
+ results['email'] = NotifyNtfy.unquote(results['qsd']['email'])
+
+ if 'tags' in results['qsd'] and len(results['qsd']['tags']):
+ results['tags'] = \
+ parse_list(NotifyNtfy.unquote(results['qsd']['tags']))
+
+ # Acquire our targets/topics
+ results['targets'] = NotifyNtfy.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'] += \
+ NotifyNtfy.parse_list(results['qsd']['to'])
+
+ # Mode override
+ if 'mode' in results['qsd'] and results['qsd']['mode']:
+ results['mode'] = NotifyNtfy.unquote(
+ results['qsd']['mode'].strip().lower())
+
+ else:
+ # We can try to detect the mode based on the validity of the
+ # hostname.
+ #
+ # This isn't a surfire way to do things though; it's best to
+ # specify the mode= flag
+ results['mode'] = NtfyMode.PRIVATE \
+ if ((is_hostname(results['host'])
+ or is_ipaddr(results['host'])) and results['targets']) \
+ else NtfyMode.CLOUD
+
+ if results['mode'] == NtfyMode.CLOUD:
+ # Store first entry as it can be a topic too in this case
+ # But only if we also rule it out not being the words
+ # ntfy.sh itself, something that starts wiht an non-alpha numeric
+ # character:
+ if not NotifyNtfy.__auto_cloud_host.search(results['host']):
+ # Add it to the front of the list for consistency
+ results['targets'].insert(0, results['host'])
+
+ elif results['mode'] == NtfyMode.PRIVATE and \
+ not (is_hostname(results['host'] or
+ is_ipaddr(results['host']))):
+ # Invalid Host for NtfyMode.PRIVATE
+ return None
+
+ return results
+
+ @staticmethod
+ def parse_native_url(url):
+ """
+ Support https://ntfy.sh/topic
+ """
+
+ # Quick lookup for users who want to just paste
+ # the ntfy.sh url directly into Apprise
+ result = re.match(
+ r'^(http|ntfy)s?://ntfy\.sh'
+ r'(?P<topics>/[^?]+)?'
+ r'(?P<params>\?.+)?$', url, re.I)
+
+ if result:
+ mode = 'mode=%s' % NtfyMode.CLOUD
+ return NotifyNtfy.parse_url(
+ '{schema}://{topics}{params}'.format(
+ schema=NotifyNtfy.secure_protocol,
+ topics=result.group('topics')
+ if result.group('topics') else '',
+ params='?%s' % mode
+ if not result.group('params')
+ else result.group('params') + '&%s' % mode))
+
+ return None
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-25 13:08:35 +0000