mirror of
https://github.com/caronc/apprise.git
synced 2024-11-22 08:04:02 +01:00
Added Google Firebase Cloud Messaging (FCM) Support (#329)
This commit is contained in:
Chris Caron
GitHub
parent
f68c414801
commit
83e3fdc048
@ -39,6 +39,7 @@ The table below identifies the services this tool supports and some example serv
|
||||
| [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
|
||||
| [Faast](https://github.com/caronc/apprise/wiki/Notify_faast) | faast:// | (TCP) 443 | faast://authorizationtoken
|
||||
| [FCM](https://github.com/caronc/apprise/wiki/Notify_fcm) | fcm:// | (TCP) 443 | fcm://project@apikey/DEVICE_ID<br />fcm://project@apikey/#TOPIC<br/>fcm://project@apikey/DEVICE_ID1/#topic1/#topic2/DEVICE_ID2/
|
||||
| [Flock](https://github.com/caronc/apprise/wiki/Notify_flock) | flock:// | (TCP) 443 | flock://token<br/>flock://botname@token<br/>flock://app_token/u:userid<br/>flock://app_token/g:channel_id<br/>flock://app_token/u:userid/g:channel_id
|
||||
| [Gitter](https://github.com/caronc/apprise/wiki/Notify_gitter) | gitter:// | (TCP) 443 | gitter://token/room<br/>gitter://token/room1/room2/roomN
|
||||
| [Gotify](https://github.com/caronc/apprise/wiki/Notify_gotify) | gotify:// or gotifys:// | (TCP) 80 or 443 | gotify://hostname/token<br />gotifys://hostname/token?priority=high
|
||||
|
||||
270
apprise/plugins/NotifyFCM.py
Normal file
270
apprise/plugins/NotifyFCM.py
Normal file
@ -0,0 +1,270 @@
|
||||
# -*- 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.
|
||||
|
||||
# For this plugin to work correct, the FCM server must be set up to allow
|
||||
# for remote connections.
|
||||
|
||||
# Firebase Cloud Messaging
|
||||
# Docs: https://firebase.google.com/docs/cloud-messaging/send-message
|
||||
|
||||
import requests
|
||||
from json import dumps
|
||||
|
||||
from .NotifyBase import NotifyBase
|
||||
from ..common import NotifyType
|
||||
from ..utils import validate_regex
|
||||
from ..utils import parse_list
|
||||
from ..AppriseLocale import gettext_lazy as _
|
||||
|
||||
|
||||
class NotifyFCM(NotifyBase):
|
||||
"""
|
||||
A wrapper for Google's Firebase Cloud Messaging Notifications
|
||||
"""
|
||||
# The default descriptive name associated with the Notification
|
||||
service_name = 'Firebase Cloud Messaging'
|
||||
|
||||
# The services URL
|
||||
service_url = 'https://firebase.google.com'
|
||||
|
||||
# The default protocol
|
||||
secure_protocol = 'fcm'
|
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol
|
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_fcm'
|
||||
|
||||
# Project Notification
|
||||
# https://firebase.google.com/docs/cloud-messaging/send-message
|
||||
notify_url = \
|
||||
"https://fcm.googleapis.com/v1/projects/{project}/messages:send"
|
||||
|
||||
# You can only send up to 1000 reg ids per bulk message when using
|
||||
# the Firebase Cloud Messaging Service
|
||||
default_batch_size = 1000
|
||||
|
||||
# Define object templates
|
||||
templates = (
|
||||
'{schema}://{project}@{apikey}/{targets}',
|
||||
)
|
||||
|
||||
# Define our template
|
||||
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||
'apikey': {
|
||||
'name': _('API Key'),
|
||||
'type': 'string',
|
||||
'private': True,
|
||||
'required': True,
|
||||
},
|
||||
'project': {
|
||||
'name': _('Project ID'),
|
||||
'type': 'string',
|
||||
'required': True,
|
||||
},
|
||||
'target_device': {
|
||||
'name': _('Target Device'),
|
||||
'type': 'string',
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'target_topic': {
|
||||
'name': _('Target Topic'),
|
||||
'type': 'string',
|
||||
'prefix': '#',
|
||||
'map_to': 'targets',
|
||||
},
|
||||
'targets': {
|
||||
'name': _('Targets'),
|
||||
'type': 'list:string',
|
||||
},
|
||||
})
|
||||
|
||||
template_args = dict(NotifyBase.template_args, **{
|
||||
'to': {
|
||||
'alias_of': 'targets',
|
||||
},
|
||||
})
|
||||
|
||||
def __init__(self, project, apikey, targets=None, **kwargs):
|
||||
"""
|
||||
Initialize Firebase Cloud Messaging
|
||||
|
||||
"""
|
||||
super(NotifyFCM, self).__init__(**kwargs)
|
||||
|
||||
# The apikey associated with the account
|
||||
self.apikey = validate_regex(apikey)
|
||||
if not self.apikey:
|
||||
msg = 'An invalid FCM API key ' \
|
||||
'({}) was specified.'.format(apikey)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# The project ID associated with the account
|
||||
self.project = validate_regex(project)
|
||||
if not self.project:
|
||||
msg = 'An invalid FCM Project ID ' \
|
||||
'({}) was specified.'.format(project)
|
||||
self.logger.warning(msg)
|
||||
raise TypeError(msg)
|
||||
|
||||
# Acquire Device IDs to notify
|
||||
self.targets = parse_list(targets)
|
||||
return
|
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||||
"""
|
||||
Perform FCM Notification
|
||||
"""
|
||||
|
||||
if not self.targets:
|
||||
# There is no one to email; we're done
|
||||
self.logger.warning('There are no devices or topics to notify')
|
||||
return False
|
||||
|
||||
headers = {
|
||||
'User-Agent': self.app_id,
|
||||
'Content-Type': 'application/json',
|
||||
"Authorization": "Bearer {}".format(self.apikey),
|
||||
}
|
||||
|
||||
has_error = False
|
||||
# Create a copy of the targets list
|
||||
targets = list(self.targets)
|
||||
while len(targets):
|
||||
recipient = targets.pop(0)
|
||||
|
||||
payload = {
|
||||
'message': {
|
||||
'token': None,
|
||||
'notification': {
|
||||
'title': title,
|
||||
'body': body,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if recipient[0] == '#':
|
||||
payload['message']['topic'] = recipient[1:]
|
||||
self.logger.debug(
|
||||
"FCM recipient %s parsed as a topic",
|
||||
recipient[1:])
|
||||
|
||||
else:
|
||||
payload['message']['token'] = recipient
|
||||
self.logger.debug(
|
||||
"FCM recipient %s parsed as a device token",
|
||||
recipient)
|
||||
|
||||
self.logger.debug('FCM POST URL: %s (cert_verify=%r)' % (
|
||||
self.notify_url, self.verify_certificate,
|
||||
))
|
||||
self.logger.debug('FCM Payload: %s' % str(payload))
|
||||
|
||||
# Always call throttle before any remote server i/o is made
|
||||
self.throttle()
|
||||
try:
|
||||
r = requests.post(
|
||||
self.notify_url.format(project=self.project),
|
||||
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 = \
|
||||
NotifyFCM.http_response_code_lookup(
|
||||
r.status_code)
|
||||
|
||||
self.logger.warning(
|
||||
'Failed to send FCM notification: '
|
||||
'{}{}error={}.'.format(
|
||||
status_str,
|
||||
', ' if status_str else '',
|
||||
r.status_code))
|
||||
|
||||
self.logger.debug(
|
||||
'Response Details:\r\n%s', r.content)
|
||||
|
||||
has_error = True
|
||||
|
||||
else:
|
||||
self.logger.info('Sent FCM notification.')
|
||||
|
||||
except requests.RequestException as e:
|
||||
self.logger.warning(
|
||||
'A Connection error occurred sending Techulus Push '
|
||||
'notification.'
|
||||
)
|
||||
self.logger.debug('Socket Exception: %s', str(e))
|
||||
|
||||
has_error = True
|
||||
|
||||
return not has_error
|
||||
|
||||
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}://{project}@{apikey}/{targets}?{params}'.format(
|
||||
schema=self.secure_protocol,
|
||||
project=NotifyFCM.quote(self.project),
|
||||
apikey=self.pprint(self.apikey, privacy, safe=''),
|
||||
targets='/'.join(
|
||||
[NotifyFCM.quote(x) for x in self.targets]),
|
||||
params=NotifyFCM.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 project identifier associated with the account
|
||||
results['project'] = NotifyFCM.unquote(results['user'])
|
||||
|
||||
# The apikey is stored in the hostname
|
||||
results['apikey'] = NotifyFCM.unquote(results['host'])
|
||||
|
||||
# Get our Device IDs
|
||||
results['targets'] = NotifyFCM.split_path(results['fullpath'])
|
||||
|
||||
# The 'to' makes it easier to use yaml configuration
|
||||
if 'to' in results['qsd'] and len(results['qsd']['to']):
|
||||
results['targets'] += \
|
||||
NotifyFCM.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, Flock, Gitter, Gotify, Growl,
|
||||
IFTTT, Join, Kavenegar, KODI, Kumulos, LaMetric, MacOSX, Mailgun, MatterMost,
|
||||
Matrix, Microsoft Windows, Microsoft Teams, MessageBird, MSG91, MyAndroid,
|
||||
Nexmo, Nextcloud, Notica, Notifico, Office365, ParsePlatform, PopcornNotify,
|
||||
Prowl, Pushalot, PushBullet, Pushjet, Pushover, PushSafer, Rocket.Chat,
|
||||
SendGrid, SimplePush, Sinch, Slack, Spontit, SparkPost, Super Toasty, Stride,
|
||||
Syslog, Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC, XMPP,
|
||||
Webex Teams}
|
||||
Boxcar, ClickSend, Discord, E-Mail, Emby, Faast, FCM, Flock, Gitter, Gotify,
|
||||
Growl, IFTTT, Join, Kavenegar, KODI, Kumulos, LaMetric, MacOSX, Mailgun,
|
||||
MatterMost, Matrix, Microsoft Windows, Microsoft Teams, MessageBird, MSG91,
|
||||
MyAndroid, Nexmo, Nextcloud, Notica, Notifico, Office365, ParsePlatform,
|
||||
PopcornNotify, Prowl, Pushalot, PushBullet, Pushjet, Pushover, PushSafer,
|
||||
Rocket.Chat, SendGrid, SimplePush, Sinch, Slack, Spontit, SparkPost, Super
|
||||
Toasty, Stride, Syslog, Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC,
|
||||
XMPP, Webex Teams}
|
||||
|
||||
Name: python-%{pypi_name}
|
||||
Version: 0.8.9
|
||||
|
||||
4
setup.py
4
setup.py
@ -70,8 +70,8 @@ setup(
|
||||
cmdclass=cmdclass,
|
||||
url='https://github.com/caronc/apprise',
|
||||
keywords='Push Notifications Alerts Email AWS SNS Boxcar ClickSend '
|
||||
'Discord Dbus Emby Faast Flock Gitter Gnome Gotify Growl IFTTT Join '
|
||||
'Kavenegar KODI Kumulos LaMetric MacOS Mailgun Matrix Mattermost '
|
||||
'Discord Dbus Emby Faast FCM Flock Gitter Gnome Gotify Growl IFTTT '
|
||||
'Join Kavenegar KODI Kumulos LaMetric MacOS Mailgun Matrix Mattermost '
|
||||
'MessageBird MSG91 Nexmo Nextcloud Notica Notifico Office365 '
|
||||
'ParsePlatform PopcornNotify Prowl PushBullet Pushjet Pushed Pushover '
|
||||
'PushSafer Rocket.Chat Ryver SendGrid SimplePush Sinch Slack '
|
||||
|
||||
@ -593,6 +593,61 @@ TEST_URLS = (
|
||||
'test_requests_exceptions': True,
|
||||
}),
|
||||
|
||||
##################################
|
||||
# NotifyFCM
|
||||
##################################
|
||||
('fcm://', {
|
||||
# We failed to identify any valid authentication
|
||||
'instance': TypeError,
|
||||
}),
|
||||
('fcm://:@/', {
|
||||
# We failed to identify any valid authentication
|
||||
'instance': TypeError,
|
||||
}),
|
||||
('fcm://apikey/', {
|
||||
# no project id specified
|
||||
'instance': TypeError,
|
||||
}),
|
||||
('fcm://project@%20%20/', {
|
||||
# invalid apikey
|
||||
'instance': TypeError,
|
||||
}),
|
||||
('fcm://project@apikey/', {
|
||||
# No targets specified; we will initialize but not notify anything
|
||||
'instance': plugins.NotifyFCM,
|
||||
'notify_response': False,
|
||||
}),
|
||||
('fcm://project@apikey/device', {
|
||||
# Valid device
|
||||
'instance': plugins.NotifyFCM,
|
||||
'privacy_url': 'fcm://project@a...y/device',
|
||||
}),
|
||||
('fcm://project@apikey/#topic', {
|
||||
# Valid topic
|
||||
'instance': plugins.NotifyFCM,
|
||||
'privacy_url': 'fcm://project@a...y/%23topic',
|
||||
}),
|
||||
('fcm://project@apikey/#topic1/device/%20/', {
|
||||
# Valid topic, valid device, and invalid entry
|
||||
'instance': plugins.NotifyFCM,
|
||||
}),
|
||||
('fcm://project@apikey?to=#topic1,device', {
|
||||
# Test to=
|
||||
'instance': plugins.NotifyFCM,
|
||||
}),
|
||||
('fcm://project@apikey/#topic1/device/', {
|
||||
'instance': plugins.NotifyFCM,
|
||||
# throw a bizzare code forcing us to fail to look it up
|
||||
'response': False,
|
||||
'requests_response_code': 999,
|
||||
}),
|
||||
('fcm://project@apikey/#topic1/device/', {
|
||||
'instance': plugins.NotifyFCM,
|
||||
# Throws a series of connection and transfer exceptions when this flag
|
||||
# is set and tests that we gracfully handle them
|
||||
'test_requests_exceptions': True,
|
||||
}),
|
||||
|
||||
##################################
|
||||
# NotifyFlock
|
||||
##################################
|
||||
|
||||
Loading…
Reference in New Issue
Block a user