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.
262 lines
8.9 KiB
262 lines
8.9 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.
|
|
|
|
# At the time I created this plugin, their website had lots of issues with the
|
|
# Firefox Browser. I fell back to Chrome and had no problems.
|
|
|
|
# To use this plugin, you need to first access https://teams.webex.com and
|
|
# make yourself an account if you don't already have one. You'll want to
|
|
# create at least one 'space' before getting the 'incoming webhook'.
|
|
#
|
|
# Next you'll need to install the 'Incoming webhook' plugin found under
|
|
# the 'other' category here: https://apphub.webex.com/integrations/
|
|
|
|
# These links may not always work as time goes by and websites always
|
|
# change, but at the time of creating this plugin this was a direct link
|
|
# to it: https://apphub.webex.com/integrations/incoming-webhooks-cisco-systems
|
|
|
|
# If you're logged in, you'll be able to click on the 'Connect' button. From
|
|
# there you'll need to accept the permissions it will ask of you. Give the
|
|
# webhook a name such as 'apprise'.
|
|
# When you're complete, you will recieve a URL that looks something like this:
|
|
# https://api.ciscospark.com/v1/webhooks/incoming/\
|
|
# Y3lzY29zcGkyazovL3VzL1dFQkhPT0sajkkzYWU4fTMtMGE4Yy00
|
|
#
|
|
# The last part of the URL is all you need to be interested in. Think of this
|
|
# url as:
|
|
# https://api.ciscospark.com/v1/webhooks/incoming/{token}
|
|
#
|
|
# You will need to assemble all of your URLs for this plugin to work as:
|
|
# wxteams://{token}
|
|
#
|
|
# Resources
|
|
# - https://developer.webex.com/docs/api/basics - markdown/post syntax
|
|
# - https://developer.cisco.com/ecosystem/webex/apps/\
|
|
# incoming-webhooks-cisco-systems/ - Simple webhook example
|
|
|
|
import re
|
|
import requests
|
|
from json import dumps
|
|
|
|
from .NotifyBase import NotifyBase
|
|
from ..common import NotifyType
|
|
from ..common import NotifyFormat
|
|
from ..utils import validate_regex
|
|
from ..AppriseLocale import gettext_lazy as _
|
|
|
|
# Extend HTTP Error Messages
|
|
# Based on: https://developer.webex.com/docs/api/basics/rate-limiting
|
|
WEBEX_HTTP_ERROR_MAP = {
|
|
401: 'Unauthorized - Invalid Token.',
|
|
415: 'Unsuported media specified',
|
|
429: 'To many consecutive requests were made.',
|
|
503: 'Service is overloaded, try again later',
|
|
}
|
|
|
|
|
|
class NotifyWebexTeams(NotifyBase):
|
|
"""
|
|
A wrapper for Webex Teams Notifications
|
|
"""
|
|
|
|
# The default descriptive name associated with the Notification
|
|
service_name = 'Cisco Webex Teams'
|
|
|
|
# The services URL
|
|
service_url = 'https://webex.teams.com/'
|
|
|
|
# The default secure protocol
|
|
secure_protocol = ('wxteams', 'webex')
|
|
|
|
# A URL that takes you to the setup/help of the specific protocol
|
|
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_wxteams'
|
|
|
|
# Webex Teams uses the http protocol with JSON requests
|
|
notify_url = 'https://api.ciscospark.com/v1/webhooks/incoming/'
|
|
|
|
# The maximum allowable characters allowed in the body per message
|
|
body_maxlen = 1000
|
|
|
|
# We don't support titles for Webex notifications
|
|
title_maxlen = 0
|
|
|
|
# Default to markdown; fall back to text
|
|
notify_format = NotifyFormat.MARKDOWN
|
|
|
|
# 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]{80,160}$', 'i'),
|
|
},
|
|
})
|
|
|
|
def __init__(self, token, **kwargs):
|
|
"""
|
|
Initialize Webex Teams Object
|
|
"""
|
|
super().__init__(**kwargs)
|
|
|
|
# The token associated with the account
|
|
self.token = validate_regex(
|
|
token, *self.template_tokens['token']['regex'])
|
|
if not self.token:
|
|
msg = 'The Webex Teams token specified ({}) is invalid.'\
|
|
.format(token)
|
|
self.logger.warning(msg)
|
|
raise TypeError(msg)
|
|
|
|
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
|
"""
|
|
Perform Webex Teams Notification
|
|
"""
|
|
|
|
# Setup our headers
|
|
headers = {
|
|
'User-Agent': self.app_id,
|
|
'Content-Type': 'application/json',
|
|
}
|
|
|
|
# Prepare our URL
|
|
url = '{}/{}'.format(self.notify_url, self.token)
|
|
|
|
payload = {
|
|
'markdown' if (self.notify_format == NotifyFormat.MARKDOWN)
|
|
else 'text': body,
|
|
}
|
|
|
|
self.logger.debug('Webex Teams POST URL: %s (cert_verify=%r)' % (
|
|
url, self.verify_certificate,
|
|
))
|
|
self.logger.debug('Webex Teams Payload: %s' % str(payload))
|
|
|
|
# Always call throttle before any remote server i/o is made
|
|
self.throttle()
|
|
try:
|
|
r = requests.post(
|
|
url,
|
|
data=dumps(payload),
|
|
headers=headers,
|
|
verify=self.verify_certificate,
|
|
timeout=self.request_timeout,
|
|
)
|
|
if r.status_code not in (
|
|
requests.codes.ok, requests.codes.no_content):
|
|
# We had a problem
|
|
status_str = \
|
|
NotifyWebexTeams.http_response_code_lookup(
|
|
r.status_code)
|
|
|
|
self.logger.warning(
|
|
'Failed to send Webex Teams 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 Webex Teams notification.')
|
|
|
|
except requests.RequestException as e:
|
|
self.logger.warning(
|
|
'A Connection error occurred sending Webex Teams '
|
|
'notification.'
|
|
)
|
|
self.logger.debug('Socket Exception: %s' % str(e))
|
|
|
|
return False
|
|
|
|
return True
|
|
|
|
def url(self, privacy=False, *args, **kwargs):
|
|
"""
|
|
Returns the URL built dynamically based on specified arguments.
|
|
"""
|
|
|
|
# Our URL parameters
|
|
params = self.url_parameters(privacy=privacy, *args, **kwargs)
|
|
|
|
return '{schema}://{token}/?{params}'.format(
|
|
schema=self.secure_protocol[0],
|
|
token=self.pprint(self.token, privacy, safe=''),
|
|
params=NotifyWebexTeams.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
|
|
|
|
# The first token is stored in the hostname
|
|
results['token'] = NotifyWebexTeams.unquote(results['host'])
|
|
|
|
return results
|
|
|
|
@staticmethod
|
|
def parse_native_url(url):
|
|
"""
|
|
Support https://api.ciscospark.com/v1/webhooks/incoming/WEBHOOK_TOKEN
|
|
"""
|
|
|
|
result = re.match(
|
|
r'^https?://(api\.ciscospark\.com|webexapis\.com)'
|
|
r'/v[1-9][0-9]*/webhooks/incoming/'
|
|
r'(?P<webhook_token>[A-Z0-9_-]+)/?'
|
|
r'(?P<params>\?.+)?$', url, re.I)
|
|
|
|
if result:
|
|
return NotifyWebexTeams.parse_url(
|
|
'{schema}://{webhook_token}/{params}'.format(
|
|
schema=NotifyWebexTeams.secure_protocol[0],
|
|
webhook_token=result.group('webhook_token'),
|
|
params='' if not result.group('params')
|
|
else result.group('params')))
|
|
|
|
return None
|