# -*- 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. import re import requests from ..common import NotifyType from .NotifyBase import NotifyBase from ..utils import validate_regex from ..AppriseLocale import gettext_lazy as _ # Register at https://sct.ftqq.com/ # - do as the page describe and you will get the token # Syntax: # schan://{access_token}/ class NotifyServerChan(NotifyBase): """ A wrapper for ServerChan Notifications """ # The default descriptive name associated with the Notification service_name = 'ServerChan' # The services URL service_url = 'https://sct.ftqq.com/' # All notification requests are secure secure_protocol = 'schan' # A URL that takes you to the setup/help of the specific protocol setup_url = 'https://github.com/caronc/apprise/wiki/Notify_serverchan' # ServerChan API notify_url = 'https://sctapi.ftqq.com/{token}.send' # Define object templates templates = ( '{schema}://{token}/', ) # Define our template tokens template_tokens = dict(NotifyBase.template_tokens, **{ 'token': { 'name': _('Token'), 'type': 'string', 'private': True, 'required': True, 'regex': (r'^[a-z0-9]+$', 'i'), }, }) def __init__(self, token, **kwargs): """ Initialize ServerChan Object """ super().__init__(**kwargs) # Token (associated with project) self.token = validate_regex( token, *self.template_tokens['token']['regex']) if not self.token: msg = 'An invalid ServerChan API Token ' \ '({}) was specified.'.format(token) self.logger.warning(msg) raise TypeError(msg) def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs): """ Perform ServerChan Notification """ payload = { 'title': title, 'desp': body, } # Our Notification URL notify_url = self.notify_url.format(token=self.token) # Some Debug Logging self.logger.debug('ServerChan URL: {} (cert_verify={})'.format( notify_url, self.verify_certificate)) self.logger.debug('ServerChan Payload: {}'.format(payload)) # Always call throttle before any remote server i/o is made self.throttle() try: r = requests.post( notify_url, data=payload, ) if r.status_code != requests.codes.ok: # We had a problem status_str = \ NotifyServerChan.http_response_code_lookup( r.status_code) self.logger.warning( 'Failed to send ServerChan notification: ' '{}{}error={}.'.format( status_str, ', ' if status_str else '', r.status_code)) self.logger.debug( 'Response Details:\r\n{}'.format(r.content)) return False else: self.logger.info('Sent ServerChan notification.') except requests.RequestException as e: self.logger.warning( 'A Connection error occured sending ServerChan ' 'notification.' ) self.logger.debug('Socket Exception: %s' % str(e)) return False return True def url(self, privacy=False): """ Returns the URL built dynamically based on specified arguments. """ return '{schema}://{token}'.format( schema=self.secure_protocol, token=self.pprint(self.token, privacy, safe='')) @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 parse the URL return results pattern = 'schan://([a-zA-Z0-9]+)/' + \ ('?' if not url.endswith('/') else '') result = re.match(pattern, url) results['token'] = result.group(1) if result else '' return results