mirror of
https://github.com/caronc/apprise.git
synced 2025-01-04 04:59:15 +01:00
Added DingTalk Support (#200)
This commit is contained in:
Chris Caron
GitHub
parent
bca44c02a5
commit
06b6ed4d2c
@ -35,6 +35,7 @@ The table below identifies the services this tool supports and some example serv
|
||||
| Notification Service | Service ID | Default Port | Example Syntax |
|
||||
| -------------------- | ---------- | ------------ | -------------- |
|
||||
| [Boxcar](https://github.com/caronc/apprise/wiki/Notify_boxcar) | boxcar:// | (TCP) 443 | boxcar://hostname<br />boxcar://hostname/@tag<br/>boxcar://hostname/device_token<br />boxcar://hostname/device_token1/device_token2/device_tokenN<br />boxcar://hostname/@tag/@tag2/device_token
|
||||
| [DingTalk](https://github.com/caronc/apprise/wiki/Notify_dingtalk) | dingtalk:// | (TCP) 443 | dingtalk://token/<br />dingtalk://token/ToPhoneNo<br />dingtalk://token/ToPhoneNo1/ToPhoneNo2/ToPhoneNo1/
|
||||
| [Discord](https://github.com/caronc/apprise/wiki/Notify_discord) | discord:// | (TCP) 443 | discord://webhook_id/webhook_token<br />discord://avatar@webhook_id/webhook_token
|
||||
| [Emby](https://github.com/caronc/apprise/wiki/Notify_emby) | emby:// or embys:// | (TCP) 8096 | emby://user@hostname/<br />emby://user:password@hostname
|
||||
| [Enigma2](https://github.com/caronc/apprise/wiki/Notify_enigma2) | enigma2:// or enigma2s:// | (TCP) 80 or 443 | enigma2://hostname
|
||||
|
||||
343
apprise/plugins/NotifyDingTalk.py
Normal file
343
apprise/plugins/NotifyDingTalk.py
Normal file
@ -0,0 +1,343 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (C) 2020 Chris Caron <lead2gold@gmail.com>
|
||||
# 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 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': _('Token'),
|
||||
'type': 'string',
|
||||
'private': True,
|
||||
'regex': (r'^[a-z0-9]+$', 'i'),
|
||||
},
|
||||
'targets': {
|
||||
'name': _('Target Phone No'),
|
||||
'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(NotifyDingTalk, self).__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))
|
||||
|
||||
@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
|
||||
@ -47,14 +47,14 @@ Apprise is a Python package for simplifying access to all of the different
|
||||
notification services that are out there. Apprise opens the door and makes
|
||||
it easy to access:
|
||||
|
||||
Boxcar, ClickSend, Discord, E-Mail, Emby, Faast, FCM, Flock, Gitter, Google
|
||||
Chat, Gotify, Growl, Home Assistant, IFTTT, Join, Kavenegar, KODI, Kumulos,
|
||||
LaMetric, MacOSX, Mailgun, Mattermost, Matrix, Microsoft Windows, Microsoft
|
||||
Teams, MessageBird, MSG91, MyAndroid, Nexmo, Nextcloud, Notica, Notifico,
|
||||
Office365, OneSignal, Opsgenie, ParsePlatform, PopcornNotify, Prowl, Pushalot,
|
||||
PushBullet, Pushjet, Pushover, PushSafer, Reddit, Rocket.Chat, SendGrid,
|
||||
SimplePush, Sinch, Slack, SMTP2Go, Spontit, SparkPost, Super Toasty, Stride,
|
||||
Syslog, Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC, XMPP,
|
||||
Boxcar, ClickSend, DingTalk, Discord, E-Mail, Emby, Faast, FCM, Flock, Gitter,
|
||||
Google Chat, Gotify, Growl, Home Assistant, IFTTT, Join, Kavenegar, KODI,
|
||||
Kumulos, LaMetric, MacOSX, Mailgun, Mattermost, Matrix, Microsoft Windows,
|
||||
Microsoft Teams, MessageBird, MSG91, MyAndroid, Nexmo, Nextcloud, Notica,
|
||||
Notifico, Office365, OneSignal, Opsgenie, ParsePlatform, PopcornNotify, Prowl,
|
||||
Pushalot, PushBullet, Pushjet, Pushover, PushSafer, Reddit, Rocket.Chat,
|
||||
SendGrid, SimplePush, Sinch, Slack, SMTP2Go, Spontit, SparkPost, Super Toasty,
|
||||
Stride, Syslog, Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC, XMPP,
|
||||
Webex Teams}
|
||||
|
||||
Name: python-%{pypi_name}
|
||||
@ -84,11 +84,9 @@ BuildRequires: python-six
|
||||
BuildRequires: python2-click >= 5.0
|
||||
BuildRequires: python-markdown
|
||||
%if 0%{?rhel} && 0%{?rhel} <= 7
|
||||
BuildRequires: python-cryptography
|
||||
BuildRequires: python-babel
|
||||
BuildRequires: python-yaml
|
||||
%else
|
||||
BuildRequires: python2-cryptography
|
||||
BuildRequires: python2-babel
|
||||
BuildRequires: python2-yaml
|
||||
%endif
|
||||
|
||||
17
setup.py
17
setup.py
@ -70,14 +70,15 @@ setup(
|
||||
cmdclass=cmdclass,
|
||||
url='https://github.com/caronc/apprise',
|
||||
keywords='Push Notifications Alerts Email AWS SNS Boxcar ClickSend '
|
||||
'Discord Dbus Emby Faast FCM Flock Gitter Gnome Google Chat Gotify '
|
||||
'Growl Home Assistant IFTTT Join Kavenegar KODI Kumulos LaMetric '
|
||||
'MacOS Mailgun Matrix Mattermost MessageBird MSG91 Nexmo Nextcloud '
|
||||
'Notica Notifico Office365 OneSignal Opsgenie ParsePlatform '
|
||||
'PopcornNotify Prowl PushBullet Pushjet Pushed Pushover PushSafer '
|
||||
'Reddit Rocket.Chat Ryver SendGrid SimplePush Sinch Slack SMTP2Go '
|
||||
'SparkPost Spontit Stride Syslog Techulus Telegram Twilio Twist '
|
||||
'Twitter XBMC MSTeams Microsoft Windows Webex CLI API',
|
||||
'Dingtalk Discord Dbus Emby Faast FCM Flock Gitter Gnome Google Chat '
|
||||
'Gotify Growl Home Assistant IFTTT Join Kavenegar KODI Kumulos '
|
||||
'LaMetric MacOS Mailgun Matrix Mattermost MessageBird MSG91 Nexmo '
|
||||
'Nextcloud Notica Notifico Office365 OneSignal Opsgenie '
|
||||
'ParsePlatform PopcornNotify Prowl PushBullet Pushjet Pushed '
|
||||
'Pushover PushSafer Reddit Rocket.Chat Ryver SendGrid SimplePush '
|
||||
'Sinch Slack SMTP2Go SparkPost Spontit Stride Syslog Techulus '
|
||||
'Telegram Twilio Twist Twitter XBMC MSTeams Microsoft Windows Webex '
|
||||
'CLI API',
|
||||
author='Chris Caron',
|
||||
author_email='lead2gold@gmail.com',
|
||||
packages=find_packages(),
|
||||
|
||||
@ -260,6 +260,71 @@ TEST_URLS = (
|
||||
'test_requests_exceptions': True,
|
||||
}),
|
||||
|
||||
##################################
|
||||
# NotifyDingTalk
|
||||
##################################
|
||||
('dingtalk://', {
|
||||
# No Access Token specified
|
||||
'instance': TypeError,
|
||||
}),
|
||||
('dingtalk://a_bd_/', {
|
||||
# invalid Access Token
|
||||
'instance': TypeError,
|
||||
}),
|
||||
('dingtalk://12345678', {
|
||||
# access token
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
|
||||
# Our expected url(privacy=True) startswith() response:
|
||||
'privacy_url': 'dingtalk://1...8',
|
||||
}),
|
||||
('dingtalk://{}/{}'.format('a' * 8, '1' * 14), {
|
||||
# access token + phone number
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
}),
|
||||
('dingtalk://{}/{}/invalid'.format('a' * 8, '1' * 3), {
|
||||
# access token + 2 invalid phone numbers
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
}),
|
||||
('dingtalk://{}/?to={}'.format('a' * 8, '1' * 14), {
|
||||
# access token + phone number using 'to'
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
}),
|
||||
# Test secret via user@
|
||||
('dingtalk://secret@{}/?to={}'.format('a' * 8, '1' * 14), {
|
||||
# access token + phone number using 'to'
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
# Our expected url(privacy=True) startswith() response:
|
||||
'privacy_url': 'dingtalk://****@a...a',
|
||||
}),
|
||||
# Test secret via secret= and token=
|
||||
('dingtalk://?token={}&to={}&secret={}'.format(
|
||||
'b' * 8, '1' * 14, 'a' * 15), {
|
||||
# access token + phone number using 'to'
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
'privacy_url': 'dingtalk://****@b...b',
|
||||
}),
|
||||
# Invalid secret
|
||||
('dingtalk://{}/?to={}&secret=_'.format('a' * 8, '1' * 14), {
|
||||
'instance': TypeError,
|
||||
}),
|
||||
('dingtalk://{}?format=markdown'.format('a' * 8), {
|
||||
# access token
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
}),
|
||||
('dingtalk://{}'.format('a' * 8), {
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
# throw a bizzare code forcing us to fail to look it up
|
||||
'response': False,
|
||||
'requests_response_code': 999,
|
||||
}),
|
||||
('dingtalk://{}'.format('a' * 8), {
|
||||
'instance': plugins.NotifyDingTalk,
|
||||
# Throws a series of connection and transfer exceptions when this flag
|
||||
# is set and tests that we gracfully handle them
|
||||
'test_requests_exceptions': True,
|
||||
}),
|
||||
|
||||
##################################
|
||||
# NotifyDiscord
|
||||
##################################
|
||||
|
||||
Loading…
Reference in New Issue
Block a user