Updated apprise to the latest version. #1834v1.0.5-beta.6

1 files changed, 400 insertions, 0 deletions

diff --git a/libs/apprise/plugins/NotifySignalAPI.py b/libs/apprise/plugins/NotifySignalAPI.py
new file mode 100644
index 000000000..a753215b4
--- /dev/null
+++ b/libs/apprise/plugins/NotifySignalAPI.py
@@ -0,0 +1,400 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020 Chris Caron <[email protected]>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+import requests
+from json import dumps
+
+from .NotifyBase import NotifyBase
+from ..common import NotifyType
+from ..utils import is_phone_no
+from ..utils import parse_phone_no
+from ..utils import parse_bool
+from ..URLBase import PrivacyMode
+from ..AppriseLocale import gettext_lazy as _
+
+
+class NotifySignalAPI(NotifyBase):
+    """
+    A wrapper for SignalAPI Notifications
+    """
+
+    # The default descriptive name associated with the Notification
+    service_name = 'Signal API'
+
+    # The services URL
+    service_url = 'https://bbernhard.github.io/signal-cli-rest-api/'
+
+    # The default protocol
+    protocol = 'signal'
+
+    # The default protocol
+    secure_protocol = 'signals'
+
+    # A URL that takes you to the setup/help of the specific protocol
+    setup_url = 'https://github.com/caronc/apprise/wiki/Notify_signal'
+
+    # The maximum targets to include when doing batch transfers
+    default_batch_size = 10
+
+    # We don't support titles for Signal notifications
+    title_maxlen = 0
+
+    # Define object templates
+    templates = (
+        '{schema}://{host}/{from_phone}',
+        '{schema}://{host}:{port}/{from_phone}',
+        '{schema}://{user}@{host}/{from_phone}',
+        '{schema}://{user}@{host}:{port}/{from_phone}',
+        '{schema}://{user}:{password}@{host}/{from_phone}',
+        '{schema}://{user}:{password}@{host}:{port}/{from_phone}',
+        '{schema}://{host}/{from_phone}/{targets}',
+        '{schema}://{host}:{port}/{from_phone}/{targets}',
+        '{schema}://{user}@{host}/{from_phone}/{targets}',
+        '{schema}://{user}@{host}:{port}/{from_phone}/{targets}',
+        '{schema}://{user}:{password}@{host}/{from_phone}/{targets}',
+        '{schema}://{user}:{password}@{host}:{port}/{from_phone}/{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,
+        },
+        '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',
+        },
+        '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',
+        },
+        'batch': {
+            'name': _('Batch Mode'),
+            'type': 'bool',
+            'default': False,
+        },
+        'status': {
+            'name': _('Show Status'),
+            'type': 'bool',
+            'default': False,
+        },
+    })
+
+    def __init__(self, source=None, targets=None, batch=False, status=False,
+                 **kwargs):
+        """
+        Initialize SignalAPI Object
+        """
+        super(NotifySignalAPI, self).__init__(**kwargs)
+
+        # Prepare Batch Mode Flag
+        self.batch = batch
+
+        # Set Status type
+        self.status = status
+
+        # Parse our targets
+        self.targets = list()
+
+        # Used for URL generation afterwards only
+        self.invalid_targets = list()
+
+        # Manage our Source Phone
+        result = is_phone_no(source)
+        if not result:
+            msg = 'An invalid Signal API Source Phone No ' \
+                  '({}) was provided.'.format(source)
+            self.logger.warning(msg)
+            raise TypeError(msg)
+
+        self.source = '+{}'.format(result['full'])
+
+        if targets:
+            # Validate our targerts
+            for target in parse_phone_no(targets):
+                # Validate targets and drop bad ones:
+                result = is_phone_no(target)
+                if not result:
+                    self.logger.warning(
+                        'Dropped invalid phone # '
+                        '({}) specified.'.format(target),
+                    )
+                    self.invalid_targets.append(target)
+                    continue
+
+                # store valid phone number
+                self.targets.append('+{}'.format(result['full']))
+        else:
+            # Send a message to ourselves
+            self.targets.append(self.source)
+
+        return
+
+    def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
+        """
+        Perform Signal API Notification
+        """
+
+        if len(self.targets) == 0:
+            # There were no services to notify
+            self.logger.warning(
+                'There were no Signal API targets to notify.')
+            return False
+
+        # error tracking (used for function return)
+        has_error = False
+
+        # Prepare our headers
+        headers = {
+            'User-Agent': self.app_id,
+            'Content-Type': 'application/json',
+        }
+
+        # Prepare our payload
+        payload = {
+            'message': "{}{}".format(
+                '' if not self.status else '{} '.format(
+                    self.asset.ascii(notify_type)), body),
+            "number": self.source,
+            "recipients": []
+        }
+
+        # Determine Authentication
+        auth = None
+        if self.user:
+            auth = (self.user, self.password)
+
+        # Set our schema
+        schema = 'https' if self.secure else 'http'
+
+        # Construct our URL
+        notify_url = '%s://%s' % (schema, self.host)
+        if isinstance(self.port, int):
+            notify_url += ':%d' % self.port
+        notify_url += '/v2/send'
+
+        # Send in batches if identified to do so
+        batch_size = 1 if not self.batch else self.default_batch_size
+
+        for index in range(0, len(self.targets), batch_size):
+            # Prepare our recipients
+            payload['recipients'] = self.targets[index:index + batch_size]
+
+            self.logger.debug('Signal API POST URL: %s (cert_verify=%r)' % (
+                notify_url, self.verify_certificate,
+            ))
+            self.logger.debug('Signal API Payload: %s' % str(payload))
+
+            # Always call throttle before any remote server i/o is made
+            self.throttle()
+            try:
+                r = requests.post(
+                    notify_url,
+                    auth=auth,
+                    data=dumps(payload),
+                    headers=headers,
+                    verify=self.verify_certificate,
+                    timeout=self.request_timeout,
+                )
+                if r.status_code != requests.codes.ok:
+                    # We had a problem
+                    status_str = \
+                        NotifySignalAPI.http_response_code_lookup(
+                            r.status_code)
+
+                    self.logger.warning(
+                        'Failed to send {} Signal API notification{}: '
+                        '{}{}error={}.'.format(
+                            len(self.targets[index:index + batch_size]),
+                            ' to {}'.format(self.targets[index])
+                            if batch_size == 1 else '(s)',
+                            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
+
+                else:
+                    self.logger.info(
+                        'Sent {} Signal API notification{}.'
+                        .format(
+                            len(self.targets[index:index + batch_size]),
+                            ' to {}'.format(self.targets[index])
+                            if batch_size == 1 else '(s)',
+                        ))
+
+            except requests.RequestException as e:
+                self.logger.warning(
+                    'A Connection error occured sending {} Signal API '
+                    'notification(s).'.format(
+                        len(self.targets[index:index + batch_size])))
+                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 URL parameters
+        params = {
+            'batch': 'yes' if self.batch else 'no',
+            'status': 'yes' if self.status else 'no',
+        }
+
+        # Extend our parameters
+        params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
+
+        # Determine Authentication
+        auth = ''
+        if self.user and self.password:
+            auth = '{user}:{password}@'.format(
+                user=NotifySignalAPI.quote(self.user, safe=''),
+                password=self.pprint(
+                    self.password, privacy, mode=PrivacyMode.Secret, safe=''),
+            )
+        elif self.user:
+            auth = '{user}@'.format(
+                user=NotifySignalAPI.quote(self.user, safe=''),
+            )
+
+        default_port = 443 if self.secure else 80
+
+        # So we can strip out our own phone (if present); create a copy of our
+        # targets
+        if len(self.targets) == 1 and self.source in self.targets:
+            targets = []
+
+        elif len(self.targets) == 0:
+            # invalid phone-no were specified
+            targets = self.invalid_targets
+
+        else:
+            targets = list(self.targets)
+
+        return '{schema}://{auth}{hostname}{port}/{src}/{dst}?{params}'.format(
+            schema=self.secure_protocol if self.secure else self.protocol,
+            auth=auth,
+            # never encode hostname since we're expecting it to be a valid one
+            hostname=self.host,
+            port='' if self.port is None or self.port == default_port
+                 else ':{}'.format(self.port),
+            src=self.source,
+            dst='/'.join(
+                [NotifySignalAPI.quote(x, safe='') for x in targets]),
+            params=NotifySignalAPI.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
+
+        # Get our entries; split_path() looks after unquoting content for us
+        # by default
+        results['targets'] = \
+            NotifySignalAPI.split_path(results['fullpath'])
+
+        # The hostname is our authentication key
+        results['apikey'] = NotifySignalAPI.unquote(results['host'])
+
+        if 'from' in results['qsd'] and len(results['qsd']['from']):
+            results['source'] = \
+                NotifySignalAPI.unquote(results['qsd']['from'])
+
+        elif results['targets']:
+            # The from phone no is the first entry in the list otherwise
+            results['source'] = results['targets'].pop(0)
+
+        # 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'] += \
+                NotifySignalAPI.parse_phone_no(results['qsd']['to'])
+
+        # Get Batch Mode Flag
+        results['batch'] = \
+            parse_bool(results['qsd'].get('batch', False))
+
+        # Get status switch
+        results['status'] = \
+            parse_bool(results['qsd'].get('status', False))
+
+        return results