apprise/apprise/plugins/qq.py

# -*- coding: utf-8 -*-
#
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2025, 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.
#
# 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.

# Assumes QQ Push API provided by third-party bridge like message-pusher

import re
import requests

from ..utils.parse import validate_regex
from ..url import PrivacyMode
from .base import NotifyBase
from ..locale import gettext_lazy as _
from ..common import NotifyType


class NotifyQQ(NotifyBase):
    """
    A wrapper for QQ Push Notifications
    """

    # The default descriptive name associated with the Notification
    service_name = _('QQ Push')

    # The services URL
    service_url = 'https://github.com/songquanpeng/message-pusher'

    # The default secure protocol
    secure_protocol = 'qq'

    # A URL that takes you to the setup/help of the specific protocol
    setup_url = 'https://github.com/caronc/apprise/wiki/Notify_qq'

    # URL used to send notifications with
    notify_url = 'https://qmsg.zendee.cn/send/'

    templates = (
        '{schema}://{token}',
    )

    template_tokens = dict(NotifyBase.template_tokens, **{
        'token': {
            'name': _('User Token'),
            'type': 'string',
            'private': True,
            'required': True,
            'regex': (r'^[a-z0-9]{24,64}$', 'i'),
        },
    })

    def __init__(self, token, **kwargs):
        """
        Initialize QQ Push Object

        Args:
            token (str): User push token from QQ Push provider (e.g., Qmsg)
        """
        super().__init__(**kwargs)

        self.token = validate_regex(
            token, *self.template_tokens['token']['regex']
        )
        if not self.token:
            msg = 'The QQ Push token ({}) is invalid.'.format(token)
            self.logger.warning(msg)
            raise TypeError(msg)

        self.webhook_url = f'{self.notify_url}{self.token}'

    def url(self, privacy=False, *args, **kwargs):
        """
        Returns the URL built dynamically based on specified arguments.
        """
        params = self.url_parameters(privacy=privacy, *args, **kwargs)
        return '{schema}://{token}/?{params}'.format(
            schema=self.secure_protocol,
            token=self.pprint(self.token, privacy, mode=PrivacyMode.Secret),
            params=self.urlencode(params),
        )

    @property
    def url_identifier(self):
        """
        Returns a unique identifier for this plugin instance
        """
        return (self.secure_protocol, self.token)

    def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
        """
        Send a QQ Push Notification
        """
        payload = {
            'msg': f'{title}\n{body}' if title else body
        }

        headers = {
            'User-Agent': self.app_id,
            'Content-Type': 'application/x-www-form-urlencoded',
        }

        self.throttle()
        try:
            response = requests.post(
                self.webhook_url,
                headers=headers,
                data=payload,
                verify=self.verify_certificate,
                timeout=self.request_timeout,
            )

            if response.status_code != requests.codes.ok:
                self.logger.warning(
                    'QQ Push notification failed: %d - %s',
                    response.status_code, response.text)
                return False

        except requests.RequestException as e:
            self.logger.warning(f'QQ Push Exception: {e}')
            return False

        self.logger.info('QQ Push notification sent successfully.')
        return True

    @staticmethod
    def parse_url(url):
        """
        Parses the URL and returns arguments to re-instantiate the object
        """
        results = NotifyBase.parse_url(url, verify_host=False)
        if not results:
            return results

        if 'token' in results['qsd'] and results['qsd']['token']:
            results['token'] = NotifyQQ.unquote(results['qsd']['token'])
        else:
            results['token'] = NotifyQQ.unquote(results['host'])

        return results

    @staticmethod
    def parse_native_url(url):
        """
        Parse native QQ push-style URL into Apprise format
        """
        match = re.match(
            r'^https://qmsg\.zendee\.cn/send/([a-z0-9]+)$', url, re.I)
        if not match:
            return None

        return NotifyQQ.parse_url(
            '{schema}://{token}'.format(
                schema=NotifyQQ.secure_protocol,
                token=match.group(1)))