You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
359 lines
12 KiB
359 lines
12 KiB
# -*- coding: utf-8 -*-
|
|
# BSD 2-Clause License
|
|
#
|
|
# Apprise - Push Notification Library.
|
|
# Copyright (c) 2024, 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.
|
|
|
|
import re
|
|
import time
|
|
import hmac
|
|
import hashlib
|
|
import base64
|
|
import requests
|
|
from json import dumps
|
|
|
|
from .NotifyBase import NotifyBase
|
|
from ..URLBase import PrivacyMode
|
|
from ..common import NotifyFormat
|
|
from ..common import NotifyType
|
|
from ..utils import parse_list
|
|
from ..utils import validate_regex
|
|
from ..AppriseLocale import gettext_lazy as _
|
|
|
|
# Register at https://dingtalk.com
|
|
# - Download their PC based software as it is the only way you can create
|
|
# a custom robot. You can create a custom robot per group. You will
|
|
# be provided an access_token that Apprise will need.
|
|
|
|
# Syntax:
|
|
# dingtalk://{access_token}/
|
|
# dingtalk://{access_token}/{optional_phone_no}
|
|
# dingtalk://{access_token}/{phone_no_1}/{phone_no_2}/{phone_no_N/
|
|
|
|
# Some Phone Number Detection
|
|
IS_PHONE_NO = re.compile(r'^\+?(?P<phone>[0-9\s)(+-]+)\s*$')
|
|
|
|
|
|
class NotifyDingTalk(NotifyBase):
|
|
"""
|
|
A wrapper for DingTalk Notifications
|
|
"""
|
|
|
|
# The default descriptive name associated with the Notification
|
|
service_name = 'DingTalk'
|
|
|
|
# The services URL
|
|
service_url = 'https://www.dingtalk.com/'
|
|
|
|
# All notification requests are secure
|
|
secure_protocol = 'dingtalk'
|
|
|
|
# A URL that takes you to the setup/help of the specific protocol
|
|
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_dingtalk'
|
|
|
|
# DingTalk API
|
|
notify_url = 'https://oapi.dingtalk.com/robot/send?access_token={token}'
|
|
|
|
# Do not set title_maxlen as it is set in a property value below
|
|
# since the length varies depending if we are doing a markdown
|
|
# based message or a text based one.
|
|
# title_maxlen = see below @propery defined
|
|
|
|
# Define object templates
|
|
templates = (
|
|
'{schema}://{token}/',
|
|
'{schema}://{token}/{targets}/',
|
|
'{schema}://{secret}@{token}/',
|
|
'{schema}://{secret}@{token}/{targets}/',
|
|
)
|
|
|
|
# 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'),
|
|
},
|
|
'secret': {
|
|
'name': _('Secret'),
|
|
'type': 'string',
|
|
'private': True,
|
|
'regex': (r'^[a-z0-9]+$', 'i'),
|
|
},
|
|
'target_phone_no': {
|
|
'name': _('Target Phone No'),
|
|
'type': 'string',
|
|
'map_to': 'targets',
|
|
},
|
|
'targets': {
|
|
'name': _('Targets'),
|
|
'type': 'list:string',
|
|
},
|
|
})
|
|
|
|
# Define our template arguments
|
|
template_args = dict(NotifyBase.template_args, **{
|
|
'to': {
|
|
'alias_of': 'targets',
|
|
},
|
|
'token': {
|
|
'alias_of': 'token',
|
|
},
|
|
'secret': {
|
|
'alias_of': 'secret',
|
|
},
|
|
})
|
|
|
|
def __init__(self, token, targets=None, secret=None, **kwargs):
|
|
"""
|
|
Initialize DingTalk Object
|
|
"""
|
|
super().__init__(**kwargs)
|
|
|
|
# Secret Key (associated with project)
|
|
self.token = validate_regex(
|
|
token, *self.template_tokens['token']['regex'])
|
|
if not self.token:
|
|
msg = 'An invalid DingTalk API Token ' \
|
|
'({}) was specified.'.format(token)
|
|
self.logger.warning(msg)
|
|
raise TypeError(msg)
|
|
|
|
self.secret = None
|
|
if secret:
|
|
self.secret = validate_regex(
|
|
secret, *self.template_tokens['secret']['regex'])
|
|
if not self.secret:
|
|
msg = 'An invalid DingTalk Secret ' \
|
|
'({}) was specified.'.format(token)
|
|
self.logger.warning(msg)
|
|
raise TypeError(msg)
|
|
|
|
# Parse our targets
|
|
self.targets = list()
|
|
|
|
for target in parse_list(targets):
|
|
# Validate targets and drop bad ones:
|
|
result = IS_PHONE_NO.match(target)
|
|
if result:
|
|
# Further check our phone # for it's digit count
|
|
result = ''.join(re.findall(r'\d+', result.group('phone')))
|
|
if len(result) < 11 or len(result) > 14:
|
|
self.logger.warning(
|
|
'Dropped invalid phone # '
|
|
'({}) specified.'.format(target),
|
|
)
|
|
continue
|
|
|
|
# store valid phone number
|
|
self.targets.append(result)
|
|
continue
|
|
|
|
self.logger.warning(
|
|
'Dropped invalid phone # '
|
|
'({}) specified.'.format(target),
|
|
)
|
|
|
|
return
|
|
|
|
def get_signature(self):
|
|
"""
|
|
Calculates time-based signature so that we can send arbitrary messages.
|
|
"""
|
|
timestamp = str(round(time.time() * 1000))
|
|
secret_enc = self.secret.encode('utf-8')
|
|
str_to_sign_enc = \
|
|
"{}\n{}".format(timestamp, self.secret).encode('utf-8')
|
|
hmac_code = hmac.new(
|
|
secret_enc, str_to_sign_enc, digestmod=hashlib.sha256).digest()
|
|
signature = NotifyDingTalk.quote(base64.b64encode(hmac_code), safe='')
|
|
return timestamp, signature
|
|
|
|
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
|
"""
|
|
Perform DingTalk Notification
|
|
"""
|
|
|
|
payload = {
|
|
'msgtype': 'text',
|
|
'at': {
|
|
'atMobiles': self.targets,
|
|
'isAtAll': False,
|
|
}
|
|
}
|
|
|
|
if self.notify_format == NotifyFormat.MARKDOWN:
|
|
payload['markdown'] = {
|
|
'title': title,
|
|
'text': body,
|
|
}
|
|
|
|
else:
|
|
payload['text'] = {
|
|
'content': body,
|
|
}
|
|
|
|
# Our Notification URL
|
|
notify_url = self.notify_url.format(token=self.token)
|
|
|
|
params = None
|
|
if self.secret:
|
|
timestamp, signature = self.get_signature()
|
|
params = {
|
|
'timestamp': timestamp,
|
|
'sign': signature,
|
|
}
|
|
|
|
# Prepare our headers
|
|
headers = {
|
|
'User-Agent': self.app_id,
|
|
'Content-Type': 'application/json'
|
|
}
|
|
|
|
# Some Debug Logging
|
|
self.logger.debug('DingTalk URL: {} (cert_verify={})'.format(
|
|
notify_url, self.verify_certificate))
|
|
self.logger.debug('DingTalk Payload: {}' .format(payload))
|
|
|
|
# Always call throttle before any remote server i/o is made
|
|
self.throttle()
|
|
|
|
try:
|
|
r = requests.post(
|
|
notify_url,
|
|
data=dumps(payload),
|
|
headers=headers,
|
|
params=params,
|
|
verify=self.verify_certificate,
|
|
)
|
|
|
|
if r.status_code != requests.codes.ok:
|
|
# We had a problem
|
|
status_str = \
|
|
NotifyDingTalk.http_response_code_lookup(
|
|
r.status_code)
|
|
|
|
self.logger.warning(
|
|
'Failed to send DingTalk 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 DingTalk notification.')
|
|
|
|
except requests.RequestException as e:
|
|
self.logger.warning(
|
|
'A Connection error occured sending DingTalk '
|
|
'notification.'
|
|
)
|
|
self.logger.debug('Socket Exception: %s' % str(e))
|
|
return False
|
|
|
|
return True
|
|
|
|
@property
|
|
def title_maxlen(self):
|
|
"""
|
|
The title isn't used when not in markdown mode.
|
|
"""
|
|
return NotifyBase.title_maxlen \
|
|
if self.notify_format == NotifyFormat.MARKDOWN else 0
|
|
|
|
def url(self, privacy=False, *args, **kwargs):
|
|
"""
|
|
Returns the URL built dynamically based on specified arguments.
|
|
"""
|
|
|
|
# Define any arguments set
|
|
args = {
|
|
'format': self.notify_format,
|
|
'overflow': self.overflow_mode,
|
|
'verify': 'yes' if self.verify_certificate else 'no',
|
|
}
|
|
|
|
return '{schema}://{secret}{token}/{targets}/?{args}'.format(
|
|
schema=self.secure_protocol,
|
|
secret='' if not self.secret else '{}@'.format(self.pprint(
|
|
self.secret, privacy, mode=PrivacyMode.Secret, safe='')),
|
|
token=self.pprint(self.token, privacy, safe=''),
|
|
targets='/'.join(
|
|
[NotifyDingTalk.quote(x, safe='') for x in self.targets]),
|
|
args=NotifyDingTalk.urlencode(args))
|
|
|
|
def __len__(self):
|
|
"""
|
|
Returns the number of targets associated with this notification
|
|
"""
|
|
targets = len(self.targets)
|
|
return targets if targets > 0 else 1
|
|
|
|
@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 load the results
|
|
return results
|
|
|
|
results['token'] = NotifyDingTalk.unquote(results['host'])
|
|
|
|
# if a user has been defined, use it's value as the secret
|
|
if results.get('user'):
|
|
results['secret'] = results.get('user')
|
|
|
|
# Get our entries; split_path() looks after unquoting content for us
|
|
# by default
|
|
results['targets'] = NotifyDingTalk.split_path(results['fullpath'])
|
|
|
|
# Support the use of the `token` keyword argument
|
|
if 'token' in results['qsd'] and len(results['qsd']['token']):
|
|
results['token'] = \
|
|
NotifyDingTalk.unquote(results['qsd']['token'])
|
|
|
|
# Support the use of the `secret` keyword argument
|
|
if 'secret' in results['qsd'] and len(results['qsd']['secret']):
|
|
results['secret'] = \
|
|
NotifyDingTalk.unquote(results['qsd']['secret'])
|
|
|
|
# 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'] += \
|
|
NotifyDingTalk.parse_list(results['qsd']['to'])
|
|
|
|
return results
|