Updated apprise module to improve notification system. #2163
morpheus65535
12 months ago
parent
0956d401bc
commit
07f601f407
@ -0,0 +1,990 @@
|
||||
# -*- 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 copy import deepcopy
|
||||
from json import dumps, loads
|
||||
from datetime import datetime
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..URLBase import PrivacyMode
|
||||
from ..common import NotifyImageSize
|
||||
from ..common import NotifyFormat
|
||||
from ..common import NotifyType
|
||||
from ..utils import parse_list
|
||||
from ..utils import parse_bool
|
||||
from ..utils import validate_regex
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
from ..attachment.AttachBase import AttachBase
|
||||
|
||||
# Accept:
|
||||
# - @username
|
||||
# - username
|
||||
# - username@host.com
|
||||
# - @username@host.com
|
||||
IS_USER = re.compile(
|
||||
r'^\s*@?(?P<user>[A-Z0-9_]+(?:@(?P<host>[A-Z0-9_.-]+))?)$', re.I)
|
||||
|
||||
USER_DETECTION_RE = re.compile(
|
||||
r'(@[A-Z0-9_]+(?:@[A-Z0-9_.-]+)?)(?=$|[\s,.&()\[\]]+)', re.I)
|
||||
|
||||
|
||||
class MastodonMessageVisibility:
|
||||
"""
|
||||
The visibility of any status message made
|
||||
"""
|
||||
# post visibility defaults to the accounts default-visibilty setting
|
||||
DEFAULT = 'default'
|
||||
|
||||
# post will be visible only to mentioned users
|
||||
# similar to a Twitter DM
|
||||
DIRECT = 'direct'
|
||||
|
||||
# post will be visible only to followers
|
||||
PRIVATE = 'private'
|
||||
|
||||
# post will be public but not appear on the public timeline
|
||||
UNLISTED = 'unlisted'
|
||||
|
||||
# post will be public
|
||||
PUBLIC = 'public'
|
||||
|
||||
|
||||
# Define the types in a list for validation purposes
|
||||
MASTODON_MESSAGE_VISIBILITIES = (
|
||||
MastodonMessageVisibility.DEFAULT,
|
||||
MastodonMessageVisibility.DIRECT,
|
||||
MastodonMessageVisibility.PRIVATE,
|
||||
MastodonMessageVisibility.UNLISTED,
|
||||
MastodonMessageVisibility.PUBLIC,
|
||||
)
|
||||
|
||||
|
||||
class NotifyMastodon(NotifyBase):
|
||||
"""
|
||||
A wrapper for Notify Mastodon Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Mastodon'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://joinmastodon.org'
|
||||
|
||||
# The default protocol
|
||||
protocol = ('mastodon', 'toot')
|
||||
|
||||
# The default secure protocol
|
||||
secure_protocol = ('mastodons', 'toots')
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_mastodon'
|
||||
|
||||
# Allows the user to specify the NotifyImageSize object; this is supported
|
||||
# through the webhook
|
||||
image_size = NotifyImageSize.XY_128
|
||||
|
||||
# it is documented on the site that the maximum images per toot
|
||||
# is 4 (unless it's a GIF, then it's only 1)
|
||||
__toot_non_gif_images_batch = 4
|
||||
|
||||
# Mastodon API Reference To Acquire Current Users Information
|
||||
# See: https://docs.joinmastodon.org/methods/accounts/
|
||||
# Requires Scope Element: read:accounts
|
||||
mastodon_whoami = '/api/v1/accounts/verify_credentials'
|
||||
|
||||
# URL for posting media files
|
||||
mastodon_media = '/api/v1/media'
|
||||
|
||||
# URL for posting status messages
|
||||
mastodon_toot = '/api/v1/statuses'
|
||||
|
||||
# URL for posting direct messages
|
||||
mastodon_dm = '/api/v1/dm'
|
||||
|
||||
# The title is not used
|
||||
title_maxlen = 0
|
||||
|
||||
# The maximum size of the message
|
||||
body_maxlen = 500
|
||||
|
||||
# Default to text
|
||||
notify_format = NotifyFormat.TEXT
|
||||
|
||||
# Mastodon is kind enough to return how many more requests we're allowed to
|
||||
# continue to make within it's header response as:
|
||||
# X-Rate-Limit-Reset: The epoc time (in seconds) we can expect our
|
||||
# rate-limit to be reset.
|
||||
# X-Rate-Limit-Remaining: an integer identifying how many requests we're
|
||||
# still allow to make.
|
||||
request_rate_per_sec = 0
|
||||
|
||||
# For Tracking Purposes
|
||||
ratelimit_reset = datetime.utcnow()
|
||||
|
||||
# Default to 1000; users can send up to 1000 DM's and 2400 toot a day
|
||||
# This value only get's adjusted if the server sets it that way
|
||||
ratelimit_remaining = 1
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{token}@{host}',
|
||||
'{schema}://{token}@{host}:{port}',
|
||||
'{schema}://{token}@{host}/{targets}',
|
||||
'{schema}://{token}@{host}:{port}/{targets}',
|
||||
)
|
||||
|
||||
# Define our template arguments
|
||||
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||
'host': {
|
||||
'name': _('Hostname'),
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
},
|
||||
'token': {
|
||||
'name': _('Access Token'),
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
},
|
||||
'port': {
|
||||
'name': _('Port'),
|
||||
'type': 'int',
|
||||
'min': 1,
|
||||
'max': 65535,
|
||||
},
|
||||
'target_user': {
|
||||
'name': _('Target User'),
|
||||
'type': 'string',
|
||||
'prefix': '@',
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'targets': {
|
||||
'name': _('Targets'),
|
||||
'type': 'list:string',
|
||||
},
|
||||
})
|
||||
|
||||
# Define our template arguments
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'token': {
|
||||
'alias_of': 'token',
|
||||
},
|
||||
'visibility': {
|
||||
'name': _('Visibility'),
|
||||
'type': 'choice:string',
|
||||
'values': MASTODON_MESSAGE_VISIBILITIES,
|
||||
'default': MastodonMessageVisibility.DEFAULT,
|
||||
},
|
||||
'cache': {
|
||||
'name': _('Cache Results'),
|
||||
'type': 'bool',
|
||||
'default': True,
|
||||
},
|
||||
'batch': {
|
||||
'name': _('Batch Mode'),
|
||||
'type': 'bool',
|
||||
'default': True,
|
||||
},
|
||||
'sensitive': {
|
||||
'name': _('Sensitive Attachments'),
|
||||
'type': 'bool',
|
||||
'default': False,
|
||||
},
|
||||
'spoiler': {
|
||||
'name': _('Spoiler Text'),
|
||||
'type': 'string',
|
||||
},
|
||||
'key': {
|
||||
'name': _('Idempotency-Key'),
|
||||
'type': 'string',
|
||||
},
|
||||
'language': {
|
||||
'name': _('Language Code'),
|
||||
'type': 'string',
|
||||
},
|
||||
'to': {
|
||||
'alias_of': 'targets',
|
||||
},
|
||||
})
|
||||
|
||||
def __init__(self, token=None, targets=None, batch=True,
|
||||
sensitive=None, spoiler=None, visibility=None, cache=True,
|
||||
key=None, language=None, **kwargs):
|
||||
"""
|
||||
Initialize Notify Mastodon Object
|
||||
"""
|
||||
super().__init__(**kwargs)
|
||||
|
||||
# Set our schema
|
||||
self.schema = 'https' if self.secure else 'http'
|
||||
|
||||
# Initialize our cache value
|
||||
self._whoami_cache = None
|
||||
|
||||
self.token = validate_regex(token)
|
||||
if not self.token:
|
||||
msg = 'An invalid Mastodon Access Token was specified.'
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
if visibility:
|
||||
# Input is a string; attempt to get the lookup from our
|
||||
# sound mapping
|
||||
vis = 'invalid' if not isinstance(visibility, str) \
|
||||
else visibility.lower().strip()
|
||||
|
||||
# This little bit of black magic allows us to match against
|
||||
# against multiple versions of the same string
|
||||
# ... etc
|
||||
self.visibility = \
|
||||
next((v for v in MASTODON_MESSAGE_VISIBILITIES
|
||||
if v.startswith(vis)), None)
|
||||
|
||||
if self.visibility not in MASTODON_MESSAGE_VISIBILITIES:
|
||||
msg = 'The Mastodon visibility specified ({}) is invalid.' \
|
||||
.format(visibility)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
else:
|
||||
self.visibility = \
|
||||
self.template_args['visibility']['default']
|
||||
|
||||
# Prepare our URL
|
||||
self.api_url = '%s://%s' % (self.schema, self.host)
|
||||
|
||||
if isinstance(self.port, int):
|
||||
self.api_url += ':%d' % self.port
|
||||
|
||||
# Set Cache Flag
|
||||
self.cache = cache
|
||||
|
||||
# Prepare Image Batch Mode Flag
|
||||
self.batch = self.template_args['batch']['default'] \
|
||||
if batch is None else batch
|
||||
|
||||
# Images to be marked sensitive
|
||||
self.sensitive = self.template_args['sensitive']['default'] \
|
||||
if sensitive is None else sensitive
|
||||
|
||||
# Text marked as being a spoiler
|
||||
self.spoiler = spoiler if isinstance(spoiler, str) else None
|
||||
|
||||
# Idempotency Key
|
||||
self.idempotency_key = key if isinstance(key, str) else None
|
||||
|
||||
# Over-ride default language (ISO 639) (e.g: en, fr, es, etc)
|
||||
self.language = language if isinstance(language, str) else None
|
||||
|
||||
# Our target users
|
||||
self.targets = []
|
||||
|
||||
# Track any errors
|
||||
has_error = False
|
||||
|
||||
# Identify our targets
|
||||
for target in parse_list(targets):
|
||||
match = IS_USER.match(target)
|
||||
if match and match.group('user'):
|
||||
self.targets.append('@' + match.group('user'))
|
||||
continue
|
||||
|
||||
has_error = True
|
||||
self.logger.warning(
|
||||
'Dropped invalid Mastodon user ({}) specified.'.format(target),
|
||||
)
|
||||
|
||||
if has_error and not self.targets:
|
||||
# We have specified that we want to notify one or more individual
|
||||
# and we failed to load any of them. Since it's also valid to
|
||||
# notify no one at all (which means we notify ourselves), it's
|
||||
# important we don't switch from the users original intentions
|
||||
msg = 'No Mastodon targets to notify.'
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
return
|
||||
|
||||
def url(self, privacy=False, *args, **kwargs):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
# Define any URL parameters
|
||||
params = {
|
||||
'visibility': self.visibility,
|
||||
'batch': 'yes' if self.batch else 'no',
|
||||
'sensitive': 'yes' if self.sensitive else 'no',
|
||||
}
|
||||
|
||||
# Extend our parameters
|
||||
params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
|
||||
|
||||
if self.spoiler:
|
||||
# Our Spoiler if one was specified
|
||||
params['spoiler'] = self.spoiler
|
||||
|
||||
if self.idempotency_key:
|
||||
# Our Idempotency Key
|
||||
params['key'] = self.idempotency_key
|
||||
|
||||
if self.language:
|
||||
# Override Language
|
||||
params['language'] = self.language
|
||||
|
||||
default_port = 443 if self.secure else 80
|
||||
|
||||
return '{schema}://{token}@{host}{port}/{targets}?{params}'.format(
|
||||
schema=self.secure_protocol[0]
|
||||
if self.secure else self.protocol[0],
|
||||
token=self.pprint(
|
||||
self.token, privacy, mode=PrivacyMode.Secret, safe=''),
|
||||
# never encode hostname since we're expecting it to be a valid one
|
||||
host=self.host,
|
||||
port='' if self.port is None or self.port == default_port
|
||||
else ':{}'.format(self.port),
|
||||
targets='/'.join(
|
||||
[NotifyMastodon.quote(x, safe='@') for x in self.targets]),
|
||||
params=NotifyMastodon.urlencode(params),
|
||||
)
|
||||
|
||||
def __len__(self):
|
||||
"""
|
||||
Returns the number of targets associated with this notification
|
||||
"""
|
||||
targets = len(self.targets)
|
||||
return targets if targets > 0 else 1
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
|
||||
**kwargs):
|
||||
"""
|
||||
wrapper to _send since we can alert more then one channel
|
||||
"""
|
||||
|
||||
# Build a list of our attachments
|
||||
attachments = []
|
||||
|
||||
# Smart Target Detection for Direct Messages; this prevents us from
|
||||
# adding @user entries that were already placed in the message body
|
||||
users = set(USER_DETECTION_RE.findall(body))
|
||||
targets = users - set(self.targets.copy())
|
||||
if not self.targets and self.visibility == \
|
||||
MastodonMessageVisibility.DIRECT:
|
||||
|
||||
result = self._whoami()
|
||||
if not result:
|
||||
# Could not access our status
|
||||
return False
|
||||
|
||||
myself = '@' + next(iter(result.keys()))
|
||||
if myself in users:
|
||||
targets.remove(myself)
|
||||
|
||||
else:
|
||||
targets.add(myself)
|
||||
|
||||
if attach:
|
||||
# We need to upload our payload first so that we can source it
|
||||
# in remaining messages
|
||||
for attachment in attach:
|
||||
|
||||
# Perform some simple error checking
|
||||
if not attachment:
|
||||
# We could not access the attachment
|
||||
self.logger.error(
|
||||
'Could not access attachment {}.'.format(
|
||||
attachment.url(privacy=True)))
|
||||
return False
|
||||
|
||||
#
|
||||
# Images (PNG, JPG, GIF) up to 8MB.
|
||||
# - Images will be downscaled to 1.6 megapixels (enough for a
|
||||
# 1280x1280 image).
|
||||
# - Up to 4 images can be attached.
|
||||
# - Animated GIFs are converted to soundless MP4s like on
|
||||
# Imgur/Gfycat (GIFV).
|
||||
# - You can also upload soundless MP4 and WebM, which will
|
||||
# be handled the same way.
|
||||
# Videos (MP4, M4V, MOV, WebM) up to 40MB.
|
||||
# - Video will be transcoded to H.264 MP4 with a maximum
|
||||
# bitrate of 1300kbps and framerate of 60fps.
|
||||
# Audio (MP3, OGG, WAV, FLAC, OPUS, AAC, M4A, 3GP) up to 40MB.
|
||||
# - Audio will be transcoded to MP3 using V2 VBR (roughly
|
||||
# 192kbps).
|
||||
if not re.match(r'^(image|video|audio)/.*',
|
||||
attachment.mimetype, re.I):
|
||||
# Only support images at this time
|
||||
self.logger.warning(
|
||||
'Ignoring unsupported Mastodon attachment {}.'.format(
|
||||
attachment.url(privacy=True)))
|
||||
continue
|
||||
|
||||
self.logger.debug(
|
||||
'Preparing Mastodon attachment {}'.format(
|
||||
attachment.url(privacy=True)))
|
||||
|
||||
# Upload our image and get our id associated with it
|
||||
postokay, response = self._request(
|
||||
self.mastodon_media,
|
||||
payload=attachment,
|
||||
)
|
||||
|
||||
if not postokay:
|
||||
# We can't post our attachment
|
||||
if response and 'authorized scopes' \
|
||||
in response.get('error', ''):
|
||||
self.logger.warning(
|
||||
'Failed to Send Attachment to Mastodon: '
|
||||
'missing scope: write:media')
|
||||
|
||||
# All other failures should cause us to abort
|
||||
return False
|
||||
|
||||
if not (isinstance(response, dict)
|
||||
and response.get('id')):
|
||||
self.logger.debug(
|
||||
'Could not attach the file to Mastodon: %s (mime=%s)',
|
||||
attachment.name, attachment.mimetype)
|
||||
continue
|
||||
|
||||
# If we get here, our output will look something like this:
|
||||
# {
|
||||
# 'id': '12345',
|
||||
# 'type': 'image',
|
||||
# 'url': 'https://.../6dad4663a.jpeg',
|
||||
# 'preview_url': 'https://.../adde6dad4663a.jpeg',
|
||||
# 'remote_url': None,
|
||||
# 'preview_remote_url': None,
|
||||
# 'text_url': None,
|
||||
# 'meta': {
|
||||
# 'original': {
|
||||
# 'width': 640,
|
||||
# 'height': 640,
|
||||
# 'size': '640x640',
|
||||
# 'aspect': 1.0
|
||||
# },
|
||||
# 'small': {
|
||||
# 'width': 400,
|
||||
# 'height': 400,
|
||||
# 'size': '400x400',
|
||||
# 'aspect': 1.0
|
||||
# }
|
||||
# },
|
||||
# 'description': None,
|
||||
# 'blurhash': 'UmIsdJnT^mX4V@XQofnQ~Ebq%4o3ofnQjZbt'
|
||||
# }
|
||||
response.update({
|
||||
# Update our response to additionally include the
|
||||
# attachment details
|
||||
'file_name': attachment.name,
|
||||
'file_mime': attachment.mimetype,
|
||||
'file_path': attachment.path,
|
||||
})
|
||||
|
||||
# Save our pre-prepared payload for attachment posting
|
||||
attachments.append(response)
|
||||
|
||||
payload = {
|
||||
'status': '{} {}'.format(' '.join(targets), body)
|
||||
if targets else body,
|
||||
'sensitive': self.sensitive,
|
||||
}
|
||||
|
||||
# Handle Visibility Flag
|
||||
if self.visibility != MastodonMessageVisibility.DEFAULT:
|
||||
payload['visibility'] = self.visibility
|
||||
|
||||
# Set Spoiler text (if set)
|
||||
if self.spoiler:
|
||||
payload['spoiler_text'] = self.spoiler
|
||||
|
||||
# Set Idempotency-Key (if set)
|
||||
if self.idempotency_key:
|
||||
payload['Idempotency-Key'] = self.idempotency_key
|
||||
|
||||
# Set Language
|
||||
if self.language:
|
||||
payload['language'] = self.language
|
||||
|
||||
payloads = []
|
||||
if not attachments:
|
||||
payloads.append(payload)
|
||||
|
||||
else:
|
||||
# Group our images if batch is set to do so
|
||||
batch_size = 1 if not self.batch \
|
||||
else self.__toot_non_gif_images_batch
|
||||
|
||||
# Track our batch control in our message generation
|
||||
batches = []
|
||||
batch = []
|
||||
for attachment in attachments:
|
||||
batch.append(attachment['id'])
|
||||
# Mastodon supports batching images together. This allows
|
||||
# the batching of multiple images together. Mastodon also
|
||||
# makes it clear that you can't batch `gif` files; they need
|
||||
# to be separate. So the below preserves the ordering that
|
||||
# a user passed their attachments in. if 4-non-gif images
|
||||
# are passed, they are all part of a single message.
|
||||
#
|
||||
# however, if they pass in image, gif, image, gif. The
|
||||
# gif's inbetween break apart the batches so this would
|
||||
# produce 4 separate toots.
|
||||
#
|
||||
# If you passed in, image, image, gif, image. <- This would
|
||||
# produce 3 images (as the first 2 images could be lumped
|
||||
# together as a batch)
|
||||
if not re.match(
|
||||
r'^image/(png|jpe?g)', attachment['file_mime'], re.I) \
|
||||
or len(batch) >= batch_size:
|
||||
batches.append(batch)
|
||||
batch = []
|
||||
|
||||
if batch:
|
||||
batches.append(batch)
|
||||
|
||||
for no, media_ids in enumerate(batches):
|
||||
_payload = deepcopy(payload)
|
||||
_payload['media_ids'] = media_ids
|
||||
|
||||
if no:
|
||||
# strip text and replace it with the image representation
|
||||
_payload['status'] = \
|
||||
'{:02d}/{:02d}'.format(no + 1, len(batches))
|
||||
# No longer sensitive information
|
||||
_payload['sensitive'] = False
|
||||
if self.idempotency_key:
|
||||
# Support multiposts while a Idempotency Key has been
|
||||
# defined
|
||||
_payload['Idempotency-Key'] = '{}-part{:02d}'.format(
|
||||
self.idempotency_key, no)
|
||||
payloads.append(_payload)
|
||||
|
||||
# Error Tracking
|
||||
has_error = False
|
||||
|
||||
for no, payload in enumerate(payloads, start=1):
|
||||
postokay, response = self._request(self.mastodon_toot, payload)
|
||||
if not postokay:
|
||||
# Track our error
|
||||
has_error = True
|
||||
|
||||
# We can't post our attachment
|
||||
if response and 'authorized scopes' \
|
||||
in response.get('error', ''):
|
||||
self.logger.warning(
|
||||
'Failed to Send Status to Mastodon: '
|
||||
'missing scope: write:statuses')
|
||||
|
||||
continue
|
||||
|
||||
# Example Attachment Output:
|
||||
# {
|
||||
# "id":"109315796435904505",
|
||||
# "created_at":"2022-11-09T20:44:39.017Z",
|
||||
# "in_reply_to_id":null,
|
||||
# "in_reply_to_account_id":null,
|
||||
# "sensitive":false,
|
||||
# "spoiler_text":"",
|
||||
# "visibility":"public",
|
||||
# "language":"en",
|
||||
# "uri":"https://host/users/caronc/statuses/109315796435904505",
|
||||
# "url":"https://host/@caronc/109315796435904505",
|
||||
# "replies_count":0,
|
||||
# "reblogs_count":0,
|
||||
# "favourites_count":0,
|
||||
# "edited_at":null,
|
||||
# "favourited":false,
|
||||
# "reblogged":false,
|
||||
# "muted":false,
|
||||
# "bookmarked":false,
|
||||
# "pinned":false,
|
||||
# "content":"<p>test</p>",
|
||||
# "reblog":null,
|
||||
# "application":{
|
||||
# "name":"Apprise Notifications",
|
||||
# "website":"https://github.com/caronc/apprise"
|
||||
# },
|
||||
# "account":{
|
||||
# "id":"109310334138718878",
|
||||
# "username":"caronc",
|
||||
# "acct":"caronc",
|
||||
# "display_name":"Chris",
|
||||
# "locked":false,
|
||||
# "bot":false,
|
||||
# "discoverable":false,
|
||||
# "group":false,
|
||||
# "created_at":"2022-11-08T00:00:00.000Z",
|
||||
# "note":"content",
|
||||
# "url":"https://host/@caronc",
|
||||
# "avatar":"https://host/path/file.png",
|
||||
# "avatar_static":"https://host/path/file.png",
|
||||
# "header":"https://host/headers/original/missing.png",
|
||||
# "header_static":"https://host/path/missing.png",
|
||||
# "followers_count":0,
|
||||
# "following_count":0,
|
||||
# "statuses_count":15,
|
||||
# "last_status_at":"2022-11-09",
|
||||
# "emojis":[
|
||||
#
|
||||
# ],
|
||||
# "fields":[
|
||||
#
|
||||
# ]
|
||||
# },
|
||||
# "media_attachments":[
|
||||
# {
|
||||
# "id":"109315796405707501",
|
||||
# "type":"image",
|
||||
# "url":"https://host/path/file.jpeg",
|
||||
# "preview_url":"https://host/path/file.jpeg",
|
||||
# "remote_url":null,
|
||||
# "preview_remote_url":null,
|
||||
# "text_url":null,
|
||||
# "meta":{
|
||||
# "original":{
|
||||
# "width":640,
|
||||
# "height":640,
|
||||
# "size":"640x640",
|
||||
# "aspect":1.0
|
||||
# },
|
||||
# "small":{
|
||||
# "width":400,
|
||||
# "height":400,
|
||||
# "size":"400x400",
|
||||
# "aspect":1.0
|
||||
# }
|
||||
# },
|
||||
# "description":null,
|
||||
# "blurhash":"UmIsdJnT^mX4V@XQofnQ~Ebq%4o3ofnQjZbt"
|
||||
# }
|
||||
# ],
|
||||
# "mentions":[
|
||||
#
|
||||
# ],
|
||||
# "tags":[
|
||||
#
|
||||
# ],
|
||||
# "emojis":[
|
||||
#
|
||||
# ],
|
||||
# "card":null,
|
||||
# "poll":null
|
||||
# }
|
||||
|
||||
try:
|
||||
url = '{}/web/@{}'.format(
|
||||
self.api_url,
|
||||
response['account']['username'])
|
||||
|
||||
except (KeyError, TypeError):
|
||||
url = 'unknown'
|
||||
|
||||
self.logger.debug(
|
||||
'Mastodon [%.2d/%.2d] (%d attached) delivered to %s',
|
||||
no, len(payloads), len(payload.get('media_ids', [])), url)
|
||||
|
||||
self.logger.info(
|
||||
'Sent [%.2d/%.2d] Mastodon notification as public toot.',
|
||||
no, len(payloads))
|
||||
|
||||
return not has_error
|
||||
|
||||
def _whoami(self, lazy=True):
|
||||
"""
|
||||
Looks details of current authenticated user
|
||||
|
||||
"""
|
||||
|
||||
if lazy and self._whoami_cache is not None:
|
||||
# Use cached response
|
||||
return self._whoami_cache
|
||||
|
||||
# Send Mastodon Whoami request
|
||||
postokay, response = self._request(
|
||||
self.mastodon_whoami,
|
||||
method='GET',
|
||||
)
|
||||
|
||||
if postokay:
|
||||
# Sample Response:
|
||||
# {
|
||||
# 'id': '12345',
|
||||
# 'username': 'caronc',
|
||||
# 'acct': 'caronc',
|
||||
# 'display_name': 'Chris',
|
||||
# 'locked': False,
|
||||
# 'bot': False,
|
||||
# 'discoverable': False,
|
||||
# 'group': False,
|
||||
# 'created_at': '2022-11-08T00:00:00.000Z',
|
||||
# 'note': 'details',
|
||||
# 'url': 'https://noc.social/@caronc',
|
||||
# 'avatar': 'https://host/path/image.png',
|
||||
# 'avatar_static': 'https://host/path/image.png',
|
||||
# 'header': 'https://host/path/missing.png',
|
||||
# 'header_static': 'https://host/path/missing.png',
|
||||
# 'followers_count': 0,
|
||||
# 'following_count': 0,
|
||||
# 'statuses_count': 2,
|
||||
# 'last_status_at': '2022-11-09',
|
||||
# 'source': {
|
||||
# 'privacy': 'public',
|
||||
# 'sensitive': False,
|
||||
# 'language': None,
|
||||
# 'note': 'details',
|
||||
# 'fields': [],
|
||||
# 'follow_requests_count': 0
|
||||
# },
|
||||
# 'emojis': [],
|
||||
# 'fields': []
|
||||
# }
|
||||
try:
|
||||
# Cache our response for future references
|
||||
self._whoami_cache = {
|
||||
response['username']: response['id']}
|
||||
|
||||
except (TypeError, KeyError):
|
||||
pass
|
||||
|
||||
elif response and 'authorized scopes' in response.get('error', ''):
|
||||
self.logger.warning(
|
||||
'Failed to lookup Mastodon Auth details; '
|
||||
'missing scope: read:accounts')
|
||||
|
||||
return self._whoami_cache if postokay else {}
|
||||
|
||||
def _request(self, path, payload=None, method='POST'):
|
||||
"""
|
||||
Wrapper to Mastodon API requests object
|
||||
"""
|
||||
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
'Authorization': f'Bearer {self.token}',
|
||||
}
|
||||
|
||||
data = None
|
||||
files = None
|
||||
|
||||
# Prepare our message
|
||||
url = '{}{}'.format(self.api_url, path)
|
||||
|
||||
# Some Debug Logging
|
||||
self.logger.debug('Mastodon {} URL: {} (cert_verify={})'.format(
|
||||
method, url, self.verify_certificate))
|
||||
|
||||
# Open our attachment path if required:
|
||||
if isinstance(payload, AttachBase):
|
||||
# prepare payload
|
||||
files = {
|
||||
'file': (payload.name, open(payload.path, 'rb'),
|
||||
'application/octet-stream')}
|
||||
|
||||
# Provide a description
|
||||
data = {
|
||||
'description': payload.name,
|
||||
}
|
||||
|
||||
else:
|
||||
headers['Content-Type'] = 'application/json'
|
||||
data = dumps(payload)
|
||||
self.logger.debug('Mastodon Payload: %s' % str(payload))
|
||||
|
||||
# Default content response object
|
||||
content = {}
|
||||
|
||||
# By default set wait to None
|
||||
wait = None
|
||||
|
||||
if self.ratelimit_remaining == 0:
|
||||
# Determine how long we should wait for or if we should wait at
|
||||
# all. This isn't fool-proof because we can't be sure the client
|
||||
# time (calling this script) is completely synced up with the
|
||||
# Mastodon server. One would hope we're on NTP and our clocks are
|
||||
# the same allowing this to role smoothly:
|
||||
|
||||
now = datetime.utcnow()
|
||||
if now < self.ratelimit_reset:
|
||||
# We need to throttle for the difference in seconds
|
||||
# We add 0.5 seconds to the end just to allow a grace
|
||||
# period.
|
||||
wait = (self.ratelimit_reset - now).total_seconds() + 0.5
|
||||
|
||||
# Always call throttle before any remote server i/o is made;
|
||||
self.throttle(wait=wait)
|
||||
|
||||
# acquire our request mode
|
||||
fn = requests.post if method == 'POST' else requests.get
|
||||
|
||||
try:
|
||||
r = fn(
|
||||
url,
|
||||
data=data,
|
||||
files=files,
|
||||
headers=headers,
|
||||
verify=self.verify_certificate,
|
||||
timeout=self.request_timeout,
|
||||
)
|
||||
|
||||
try:
|
||||
content = loads(r.content)
|
||||
|
||||
except (AttributeError, TypeError, ValueError):
|
||||
# ValueError = r.content is Unparsable
|
||||
# TypeError = r.content is None
|
||||
# AttributeError = r is None
|
||||
content = {}
|
||||
|
||||
if r.status_code not in (
|
||||
requests.codes.ok, requests.codes.created,
|
||||
requests.codes.accepted):
|
||||
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyMastodon.http_response_code_lookup(r.status_code)
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send Mastodon {} to {}: '
|
||||
'{}error={}.'.format(
|
||||
method,
|
||||
url,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
# Mark our failure
|
||||
return (False, content)
|
||||
|
||||
try:
|
||||
# Capture rate limiting if possible
|
||||
self.ratelimit_remaining = \
|
||||
int(r.headers.get('X-RateLimit-Remaining'))
|
||||
self.ratelimit_reset = datetime.utcfromtimestamp(
|
||||
int(r.headers.get('X-RateLimit-Limit')))
|
||||
|
||||
except (TypeError, ValueError):
|
||||
# This is returned if we could not retrieve this information
|
||||
# gracefully accept this state and move on
|
||||
pass
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'Exception received when sending Mastodon {} to {}: '.
|
||||
format(method, url))
|
||||
self.logger.debug('Socket Exception: %s' % str(e))
|
||||
|
||||
# Mark our failure
|
||||
return (False, content)
|
||||
|
||||
except (OSError, IOError) as e:
|
||||
self.logger.warning(
|
||||
'An I/O error occurred while handling {}.'.format(
|
||||
payload.name if isinstance(payload, AttachBase)
|
||||
else payload))
|
||||
self.logger.debug('I/O Exception: %s' % str(e))
|
||||
return (False, content)
|
||||
|
||||
finally:
|
||||
# Close our file (if it's open) stored in the second element
|
||||
# of our files tuple (index 1)
|
||||
if files:
|
||||
files['file'][1].close()
|
||||
|
||||
return (True, content)
|
||||
|
||||
@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)
|
||||
if not results:
|
||||
# We're done early as we couldn't load the results
|
||||
return results
|
||||
|
||||
if 'token' in results['qsd'] and len(results['qsd']['token']):
|
||||
results['token'] = NotifyMastodon.unquote(results['qsd']['token'])
|
||||
|
||||
elif not results['password'] and results['user']:
|
||||
results['token'] = NotifyMastodon.unquote(results['user'])
|
||||
|
||||
# Apply our targets
|
||||
results['targets'] = NotifyMastodon.split_path(results['fullpath'])
|
||||
|
||||
# The defined Mastodon visibility
|
||||
if 'visibility' in results['qsd'] and \
|
||||
len(results['qsd']['visibility']):
|
||||
# Simplified version
|
||||
results['visibility'] = \
|
||||
NotifyMastodon.unquote(results['qsd']['visibility'])
|
||||
|
||||
elif results['schema'].startswith('toot'):
|
||||
results['visibility'] = MastodonMessageVisibility.PUBLIC
|
||||
|
||||
# Get Idempotency Key (if specified)
|
||||
if 'key' in results['qsd'] and len(results['qsd']['key']):
|
||||
results['key'] = \
|
||||
NotifyMastodon.unquote(results['qsd']['key'])
|
||||
|
||||
# Get Spoiler Text
|
||||
if 'spoiler' in results['qsd'] and len(results['qsd']['spoiler']):
|
||||
results['spoiler'] = \
|
||||
NotifyMastodon.unquote(results['qsd']['spoiler'])
|
||||
|
||||
# Get Language (if specified)
|
||||
if 'language' in results['qsd'] and len(results['qsd']['language']):
|
||||
results['language'] = \
|
||||
NotifyMastodon.unquote(results['qsd']['language'])
|
||||
|
||||
# Get Sensitive Flag (for Attachments)
|
||||
results['sensitive'] = \
|
||||
parse_bool(results['qsd'].get(
|
||||
'sensitive',
|
||||
NotifyMastodon.template_args['sensitive']['default']))
|
||||
|
||||
# Get Batch Mode Flag
|
||||
results['batch'] = \
|
||||
parse_bool(results['qsd'].get(
|
||||
'batch', NotifyMastodon.template_args['batch']['default']))
|
||||
|
||||
# The 'to' makes it easier to use yaml configuration
|
||||
if 'to' in results['qsd'] and len(results['qsd']['to']):
|
||||
results['targets'] += \
|
||||
NotifyMastodon.parse_list(results['qsd']['to'])
|
||||
|
||||
return results
|
||||
@ -0,0 +1,310 @@
|
||||
# -*- 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.
|
||||
# 1. visit https://misskey-hub.net/ and see what it's all about if you want.
|
||||
# Choose a service you want to create an account on from here:
|
||||
# https://misskey-hub.net/en/instances.html
|
||||
#
|
||||
# - For this plugin, I tested using https://misskey.sda1.net and created an
|
||||
# account.
|
||||
#
|
||||
# 2. Generate an API Key:
|
||||
# - Settings > API > Generate Key
|
||||
# - Name it whatever you want
|
||||
# - Assign it 'AT LEAST':
|
||||
# a. Compose or delete chat messages
|
||||
# b. Compose or delete notes
|
||||
#
|
||||
#
|
||||
# This plugin also supports taking the URL (as identified above) directly
|
||||
# as well.
|
||||
|
||||
import requests
|
||||
from json import dumps
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..common import NotifyType
|
||||
from ..utils import validate_regex
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
class MisskeyVisibility:
|
||||
"""
|
||||
The visibility of any note created
|
||||
"""
|
||||
# post will be public
|
||||
PUBLIC = 'public'
|
||||
|
||||
HOME = 'home'
|
||||
|
||||
FOLLOWERS = 'followers'
|
||||
|
||||
PRIVATE = 'private'
|
||||
|
||||
SPECIFIED = 'specified'
|
||||
|
||||
|
||||
# Define the types in a list for validation purposes
|
||||
MISSKEY_VISIBILITIES = (
|
||||
MisskeyVisibility.PUBLIC,
|
||||
MisskeyVisibility.HOME,
|
||||
MisskeyVisibility.FOLLOWERS,
|
||||
MisskeyVisibility.PRIVATE,
|
||||
MisskeyVisibility.SPECIFIED,
|
||||
)
|
||||
|
||||
|
||||
class NotifyMisskey(NotifyBase):
|
||||
"""
|
||||
A wrapper for Misskey Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Misskey'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://misskey-hub.net/'
|
||||
|
||||
# The default protocol
|
||||
protocol = 'misskey'
|
||||
|
||||
# The default secure protocol
|
||||
secure_protocol = 'misskeys'
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_misskey'
|
||||
|
||||
# The title is not used
|
||||
title_maxlen = 0
|
||||
|
||||
# The maximum allowable characters allowed in the body per message
|
||||
body_maxlen = 512
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{project_id}/{msghook}',
|
||||
)
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{token}@{host}',
|
||||
'{schema}://{token}@{host}:{port}',
|
||||
)
|
||||
|
||||
# Define our template arguments
|
||||
# Define our template arguments
|
||||
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||
'host': {
|
||||
'name': _('Hostname'),
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
},
|
||||
'token': {
|
||||
'name': _('Access Token'),
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
},
|
||||
'port': {
|
||||
'name': _('Port'),
|
||||
'type': 'int',
|
||||
'min': 1,
|
||||
'max': 65535,
|
||||
},
|
||||
})
|
||||
|
||||
# Define our template arguments
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'token': {
|
||||
'alias_of': 'token',
|
||||
},
|
||||
'visibility': {
|
||||
'name': _('Visibility'),
|
||||
'type': 'choice:string',
|
||||
'values': MISSKEY_VISIBILITIES,
|
||||
'default': MisskeyVisibility.PUBLIC,
|
||||
},
|
||||
})
|
||||
|
||||
def __init__(self, token=None, visibility=None, **kwargs):
|
||||
"""
|
||||
Initialize Misskey Object
|
||||
"""
|
||||
super().__init__(**kwargs)
|
||||
|
||||
self.token = validate_regex(token)
|
||||
if not self.token:
|
||||
msg = 'An invalid Misskey Access Token was specified.'
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
if visibility:
|
||||
# Input is a string; attempt to get the lookup from our
|
||||
# sound mapping
|
||||
vis = 'invalid' if not isinstance(visibility, str) \
|
||||
else visibility.lower().strip()
|
||||
|
||||
# This little bit of black magic allows us to match against
|
||||
# against multiple versions of the same string ... etc
|
||||
self.visibility = \
|
||||
next((v for v in MISSKEY_VISIBILITIES
|
||||
if v.startswith(vis)), None)
|
||||
|
||||
if self.visibility not in MISSKEY_VISIBILITIES:
|
||||
msg = 'The Misskey visibility specified ({}) is invalid.' \
|
||||
.format(visibility)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
else:
|
||||
self.visibility = self.template_args['visibility']['default']
|
||||
|
||||
# Prepare our URL
|
||||
self.schema = 'https' if self.secure else 'http'
|
||||
self.api_url = '%s://%s' % (self.schema, self.host)
|
||||
|
||||
if isinstance(self.port, int):
|
||||
self.api_url += ':%d' % self.port
|
||||
|
||||
return
|
||||
|
||||
def url(self, privacy=False, *args, **kwargs):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
params = {
|
||||
'visibility': self.visibility,
|
||||
}
|
||||
|
||||
# Extend our parameters
|
||||
params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
|
||||
|
||||
host = self.host
|
||||
if isinstance(self.port, int):
|
||||
host += ':%d' % self.port
|
||||
|
||||
return '{schema}://{token}@{host}/?{params}'.format(
|
||||
schema=self.secure_protocol if self.secure else self.protocol,
|
||||
host=host,
|
||||
token=self.pprint(self.token, privacy, safe=''),
|
||||
params=NotifyMisskey.urlencode(params),
|
||||
)
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||||
"""
|
||||
wrapper to _send since we can alert more then one channel
|
||||
"""
|
||||
|
||||
# prepare our headers
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
'Content-Type': 'application/json',
|
||||
}
|
||||
|
||||
# Prepare our payload
|
||||
payload = {
|
||||
'i': self.token,
|
||||
'text': body,
|
||||
'visibility': self.visibility,
|
||||
}
|
||||
|
||||
api_url = f'{self.api_url}/api/notes/create'
|
||||
self.logger.debug('Misskey GET URL: %s (cert_verify=%r)' % (
|
||||
api_url, self.verify_certificate))
|
||||
self.logger.debug('Misskey Payload: %s' % str(payload))
|
||||
|
||||
# Always call throttle before any remote server i/o is made
|
||||
self.throttle()
|
||||
|
||||
try:
|
||||
r = requests.post(
|
||||
api_url,
|
||||
headers=headers,
|
||||
data=dumps(payload),
|
||||
verify=self.verify_certificate,
|
||||
timeout=self.request_timeout,
|
||||
)
|
||||
if r.status_code != requests.codes.ok:
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyMisskey.http_response_code_lookup(r.status_code)
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send Misskey notification: '
|
||||
'{}{}error={}.'.format(
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug('Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
# Return; we're done
|
||||
return False
|
||||
|
||||
else:
|
||||
self.logger.info('Sent Misskey notification.')
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occurred sending Misskey '
|
||||
'notification.')
|
||||
self.logger.debug('Socket Exception: %s' % str(e))
|
||||
|
||||
# Return; we're done
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
@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)
|
||||
if not results:
|
||||
# We're done early as we couldn't load the results
|
||||
return results
|
||||
|
||||
if 'token' in results['qsd'] and len(results['qsd']['token']):
|
||||
results['token'] = NotifyMisskey.unquote(results['qsd']['token'])
|
||||
|
||||
elif not results['password'] and results['user']:
|
||||
results['token'] = NotifyMisskey.unquote(results['user'])
|
||||
|
||||
# Capture visibility if specified
|
||||
if 'visibility' in results['qsd'] and \
|
||||
len(results['qsd']['visibility']):
|
||||
results['visibility'] = \
|
||||
NotifyMisskey.unquote(results['qsd']['visibility'])
|
||||
|
||||
return results
|
||||
@ -0,0 +1,424 @@
|
||||
# -*- 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 requests
|
||||
from json import dumps
|
||||
|
||||
from uuid import uuid4
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..common import NotifyType
|
||||
from ..utils import parse_list
|
||||
from ..utils import validate_regex
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
# Actions
|
||||
class PagerTreeAction:
|
||||
CREATE = 'create'
|
||||
ACKNOWLEDGE = 'acknowledge'
|
||||
RESOLVE = 'resolve'
|
||||
|
||||
|
||||
# Urgencies
|
||||
class PagerTreeUrgency:
|
||||
SILENT = "silent"
|
||||
LOW = "low"
|
||||
MEDIUM = "medium"
|
||||
HIGH = "high"
|
||||
CRITICAL = "critical"
|
||||
|
||||
|
||||
PAGERTREE_ACTIONS = {
|
||||
PagerTreeAction.CREATE: 'create',
|
||||
PagerTreeAction.ACKNOWLEDGE: 'acknowledge',
|
||||
PagerTreeAction.RESOLVE: 'resolve',
|
||||
}
|
||||
|
||||
PAGERTREE_URGENCIES = {
|
||||
# Note: This also acts as a reverse lookup mapping
|
||||
PagerTreeUrgency.SILENT: 'silent',
|
||||
PagerTreeUrgency.LOW: 'low',
|
||||
PagerTreeUrgency.MEDIUM: 'medium',
|
||||
PagerTreeUrgency.HIGH: 'high',
|
||||
PagerTreeUrgency.CRITICAL: 'critical',
|
||||
}
|
||||
# Extend HTTP Error Messages
|
||||
PAGERTREE_HTTP_ERROR_MAP = {
|
||||
402: 'Payment Required - Please subscribe or upgrade',
|
||||
403: 'Forbidden - Blocked',
|
||||
404: 'Not Found - Invalid Integration ID',
|
||||
405: 'Method Not Allowed - Integration Disabled',
|
||||
429: 'Too Many Requests - Rate Limit Exceeded',
|
||||
}
|
||||
|
||||
|
||||
class NotifyPagerTree(NotifyBase):
|
||||
"""
|
||||
A wrapper for PagerTree Notifications
|
||||
"""
|
||||
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'PagerTree'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://pagertree.com/'
|
||||
|
||||
# All PagerTree requests are secure
|
||||
secure_protocol = 'pagertree'
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_pagertree'
|
||||
|
||||
# PagerTree uses the http protocol with JSON requests
|
||||
notify_url = 'https://api.pagertree.com/integration/{}'
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{integration}',
|
||||
)
|
||||
|
||||
# Define our template tokens
|
||||
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||
'integration': {
|
||||
'name': _('Integration ID'),
|
||||
'type': 'string',
|
||||
'private': True,
|
||||
'required': True,
|
||||
}
|
||||
})
|
||||
|
||||
# Define our template arguments
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'action': {
|
||||
'name': _('Action'),
|
||||
'type': 'choice:string',
|
||||
'values': PAGERTREE_ACTIONS,
|
||||
'default': PagerTreeAction.CREATE,
|
||||
},
|
||||
'thirdparty': {
|
||||
'name': _('Third Party ID'),
|
||||
'type': 'string',
|
||||
},
|
||||
'urgency': {
|
||||
'name': _('Urgency'),
|
||||
'type': 'choice:string',
|
||||
'values': PAGERTREE_URGENCIES,
|
||||
},
|
||||
'tags': {
|
||||
'name': _('Tags'),
|
||||
'type': 'string',
|
||||
},
|
||||
})
|
||||
|
||||
# Define any kwargs we're using
|
||||
template_kwargs = {
|
||||
'headers': {
|
||||
'name': _('HTTP Header'),
|
||||
'prefix': '+',
|
||||
},
|
||||
'payload_extras': {
|
||||
'name': _('Payload Extras'),
|
||||
'prefix': ':',
|
||||
},
|
||||
'meta_extras': {
|
||||
'name': _('Meta Extras'),
|
||||
'prefix': '-',
|
||||
},
|
||||
}
|
||||
|
||||
def __init__(self, integration, action=None, thirdparty=None,
|
||||
urgency=None, tags=None, headers=None,
|
||||
payload_extras=None, meta_extras=None, **kwargs):
|
||||
"""
|
||||
Initialize PagerTree Object
|
||||
"""
|
||||
super().__init__(**kwargs)
|
||||
|
||||
# Integration ID (associated with account)
|
||||
self.integration = \
|
||||
validate_regex(integration, r'^int_[a-zA-Z0-9\-_]{7,14}$')
|
||||
if not self.integration:
|
||||
msg = 'An invalid PagerTree Integration ID ' \
|
||||
'({}) was specified.'.format(integration)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# thirdparty (optional, in case they want to pass the
|
||||
# acknowledge or resolve action)
|
||||
self.thirdparty = None
|
||||
if thirdparty:
|
||||
# An id was specified, we want to validate it
|
||||
self.thirdparty = validate_regex(thirdparty)
|
||||
if not self.thirdparty:
|
||||
msg = 'An invalid PagerTree third party ID ' \
|
||||
'({}) was specified.'.format(thirdparty)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
self.headers = {}
|
||||
if headers:
|
||||
# Store our extra headers
|
||||
self.headers.update(headers)
|
||||
|
||||
self.payload_extras = {}
|
||||
if payload_extras:
|
||||
# Store our extra payload entries
|
||||
self.payload_extras.update(payload_extras)
|
||||
|
||||
self.meta_extras = {}
|
||||
if meta_extras:
|
||||
# Store our extra payload entries
|
||||
self.meta_extras.update(meta_extras)
|
||||
|
||||
# Setup our action
|
||||
self.action = NotifyPagerTree.template_args['action']['default'] \
|
||||
if action not in PAGERTREE_ACTIONS else \
|
||||
PAGERTREE_ACTIONS[action]
|
||||
|
||||
# Setup our urgency
|
||||
self.urgency = \
|
||||
None if urgency not in PAGERTREE_URGENCIES else \
|
||||
PAGERTREE_URGENCIES[urgency]
|
||||
|
||||
# Any optional tags to attach to the notification
|
||||
self.__tags = parse_list(tags)
|
||||
|
||||
return
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||||
"""
|
||||
Perform PagerTree Notification
|
||||
"""
|
||||
|
||||
# Prepare our headers
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
'Content-Type': 'application/json',
|
||||
}
|
||||
|
||||
# Apply any/all header over-rides defined
|
||||
# For things like PagerTree Token
|
||||
headers.update(self.headers)
|
||||
|
||||
# prepare JSON Object
|
||||
payload = {
|
||||
# Generate an ID (unless one was explicitly forced to be used)
|
||||
'id': self.thirdparty if self.thirdparty else str(uuid4()),
|
||||
'event_type': self.action,
|
||||
}
|
||||
|
||||
if self.action == PagerTreeAction.CREATE:
|
||||
payload['title'] = title if title else self.app_desc
|
||||
payload['description'] = body
|
||||
|
||||
payload['meta'] = self.meta_extras
|
||||
payload['tags'] = self.__tags
|
||||
|
||||
if self.urgency is not None:
|
||||
payload['urgency'] = self.urgency
|
||||
|
||||
# Apply any/all payload over-rides defined
|
||||
payload.update(self.payload_extras)
|
||||
|
||||
# Prepare our URL based on integration
|
||||
notify_url = self.notify_url.format(self.integration)
|
||||
|
||||
self.logger.debug('PagerTree POST URL: %s (cert_verify=%r)' % (
|
||||
notify_url, self.verify_certificate,
|
||||
))
|
||||
self.logger.debug('PagerTree Payload: %s' % str(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,
|
||||
verify=self.verify_certificate,
|
||||
timeout=self.request_timeout,
|
||||
)
|
||||
if r.status_code not in (
|
||||
requests.codes.ok, requests.codes.created,
|
||||
requests.codes.accepted):
|
||||
# We had a problem
|
||||
status_str = \
|
||||
NotifyPagerTree.http_response_code_lookup(
|
||||
r.status_code)
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send PagerTree notification: '
|
||||
'{}{}error={}.'.format(
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug('Response Details:\r\n{}'.format(r.content))
|
||||
|
||||
# Return; we're done
|
||||
return False
|
||||
|
||||
else:
|
||||
self.logger.info('Sent PagerTree notification.')
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occurred sending PagerTree '
|
||||
'notification to %s.' % self.host)
|
||||
self.logger.debug('Socket Exception: %s' % str(e))
|
||||
|
||||
# Return; we're done
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
def url(self, privacy=False, *args, **kwargs):
|
||||
"""
|
||||
Returns the URL built dynamically based on specified arguments.
|
||||
"""
|
||||
|
||||
# Define any URL parameters
|
||||
params = {
|
||||
'action': self.action,
|
||||
}
|
||||
|
||||
if self.thirdparty:
|
||||
params['tid'] = self.thirdparty
|
||||
|
||||
if self.urgency:
|
||||
params['urgency'] = self.urgency
|
||||
|
||||
if self.__tags:
|
||||
params['tags'] = ','.join([x for x in self.__tags])
|
||||
|
||||
# Extend our parameters
|
||||
params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
|
||||
|
||||
# Headers prefixed with a '+' sign
|
||||
# Append our headers into our parameters
|
||||
params.update({'+{}'.format(k): v for k, v in self.headers.items()})
|
||||
|
||||
# Meta: {} prefixed with a '-' sign
|
||||
# Append our meta extras into our parameters
|
||||
params.update(
|
||||
{'-{}'.format(k): v for k, v in self.meta_extras.items()})
|
||||
|
||||
# Payload body extras prefixed with a ':' sign
|
||||
# Append our payload extras into our parameters
|
||||
params.update(
|
||||
{':{}'.format(k): v for k, v in self.payload_extras.items()})
|
||||
|
||||
return '{schema}://{integration}?{params}'.format(
|
||||
schema=self.secure_protocol,
|
||||
# never encode hostname since we're expecting it to be a valid one
|
||||
integration=self.pprint(self.integration, privacy, safe=''),
|
||||
params=NotifyPagerTree.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
|
||||
|
||||
# Add our headers that the user can potentially over-ride if they wish
|
||||
# to to our returned result set and tidy entries by unquoting them
|
||||
results['headers'] = {
|
||||
NotifyPagerTree.unquote(x): NotifyPagerTree.unquote(y)
|
||||
for x, y in results['qsd+'].items()
|
||||
}
|
||||
|
||||
# store any additional payload extra's defined
|
||||
results['payload_extras'] = {
|
||||
NotifyPagerTree.unquote(x): NotifyPagerTree.unquote(y)
|
||||
for x, y in results['qsd:'].items()
|
||||
}
|
||||
|
||||
# store any additional meta extra's defined
|
||||
results['meta_extras'] = {
|
||||
NotifyPagerTree.unquote(x): NotifyPagerTree.unquote(y)
|
||||
for x, y in results['qsd-'].items()
|
||||
}
|
||||
|
||||
# Integration ID
|
||||
if 'id' in results['qsd'] and len(results['qsd']['id']):
|
||||
# Shortened version of integration id
|
||||
results['integration'] = \
|
||||
NotifyPagerTree.unquote(results['qsd']['id'])
|
||||
|
||||
elif 'integration' in results['qsd'] and \
|
||||
len(results['qsd']['integration']):
|
||||
results['integration'] = \
|
||||
NotifyPagerTree.unquote(results['qsd']['integration'])
|
||||
|
||||
else:
|
||||
results['integration'] = \
|
||||
NotifyPagerTree.unquote(results['host'])
|
||||
|
||||
# Set our thirdparty
|
||||
|
||||
if 'tid' in results['qsd'] and len(results['qsd']['tid']):
|
||||
# Shortened version of thirdparty
|
||||
results['thirdparty'] = \
|
||||
NotifyPagerTree.unquote(results['qsd']['tid'])
|
||||
|
||||
elif 'thirdparty' in results['qsd'] and \
|
||||
len(results['qsd']['thirdparty']):
|
||||
results['thirdparty'] = \
|
||||
NotifyPagerTree.unquote(results['qsd']['thirdparty'])
|
||||
|
||||
# Set our urgency
|
||||
if 'action' in results['qsd'] and \
|
||||
len(results['qsd']['action']):
|
||||
results['action'] = \
|
||||
NotifyPagerTree.unquote(results['qsd']['action'])
|
||||
|
||||
# Set our urgency
|
||||
if 'urgency' in results['qsd'] and len(results['qsd']['urgency']):
|
||||
results['urgency'] = \
|
||||
NotifyPagerTree.unquote(results['qsd']['urgency'])
|
||||
|
||||
# Set our tags
|
||||
if 'tags' in results['qsd'] and len(results['qsd']['tags']):
|
||||
results['tags'] = \
|
||||
parse_list(NotifyPagerTree.unquote(results['qsd']['tags']))
|
||||
|
||||
return results
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue