mirror of https://github.com/caronc/apprise
Chris Caron
5 years ago
committed by
GitHub
5 changed files with 405 additions and 12 deletions
@ -0,0 +1,230 @@
|
||||
# -*- 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. |
||||
|
||||
from __future__ import absolute_import |
||||
from __future__ import print_function |
||||
|
||||
import platform |
||||
import subprocess |
||||
import os |
||||
|
||||
from .NotifyBase import NotifyBase |
||||
from ..common import NotifyImageSize |
||||
from ..common import NotifyType |
||||
from ..utils import parse_bool |
||||
from ..AppriseLocale import gettext_lazy as _ |
||||
|
||||
|
||||
class NotifyMacOSX(NotifyBase): |
||||
""" |
||||
A wrapper for the MacOS X terminal-notifier tool |
||||
|
||||
Source: https://github.com/julienXX/terminal-notifier |
||||
""" |
||||
|
||||
# The default descriptive name associated with the Notification |
||||
service_name = 'MacOSX Notification' |
||||
|
||||
# The default protocol |
||||
protocol = 'macosx' |
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol |
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_macosx' |
||||
|
||||
# Allows the user to specify the NotifyImageSize object |
||||
image_size = NotifyImageSize.XY_128 |
||||
|
||||
# Disable throttle rate for MacOSX requests since they are normally |
||||
# local anyway |
||||
request_rate_per_sec = 0 |
||||
|
||||
# Limit results to just the first 10 line otherwise there is just to much |
||||
# content to display |
||||
body_max_line_count = 10 |
||||
|
||||
# The path to the terminal-notifier |
||||
notify_path = '/usr/local/bin/terminal-notifier' |
||||
|
||||
# Define object templates |
||||
templates = ( |
||||
'{schema}://_/', |
||||
) |
||||
|
||||
# Define our template arguments |
||||
template_args = dict(NotifyBase.template_args, **{ |
||||
'image': { |
||||
'name': _('Include Image'), |
||||
'type': 'bool', |
||||
'default': True, |
||||
'map_to': 'include_image', |
||||
}, |
||||
# Play the NAME sound when the notification appears. |
||||
# Sound names are listed in Sound Preferences. |
||||
# Use 'default' for the default sound. |
||||
'sound': { |
||||
'name': _('Sound'), |
||||
'type': 'string', |
||||
}, |
||||
}) |
||||
|
||||
def __init__(self, sound=None, include_image=True, **kwargs): |
||||
""" |
||||
Initialize MacOSX Object |
||||
""" |
||||
|
||||
super(NotifyMacOSX, self).__init__(**kwargs) |
||||
|
||||
# Track whether or not we want to send an image with our notification |
||||
# or not. |
||||
self.include_image = include_image |
||||
|
||||
self._enabled = False |
||||
if platform.system() == 'Darwin': |
||||
# Check this is Mac OS X 10.8, or higher |
||||
major, minor = platform.mac_ver()[0].split('.')[:2] |
||||
|
||||
# Toggle our _enabled flag if verion is correct and executable |
||||
# found. This is done in such a way to provide verbosity to the |
||||
# end user so they know why it may or may not work for them. |
||||
if not (int(major) > 10 or (int(major) == 10 and int(minor) >= 8)): |
||||
self.logger.warning( |
||||
"MacOSX Notifications require your OS to be at least " |
||||
"v10.8 (detected {}.{})".format(major, minor)) |
||||
|
||||
elif not os.access(self.notify_path, os.X_OK): |
||||
self.logger.warning( |
||||
"MacOSX Notifications require '{}' to be in place." |
||||
.format(self.notify_path)) |
||||
|
||||
else: |
||||
# We're good to go |
||||
self._enabled = True |
||||
|
||||
# Set sound object (no q/a for now) |
||||
self.sound = sound |
||||
|
||||
return |
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs): |
||||
""" |
||||
Perform MacOSX Notification |
||||
""" |
||||
|
||||
if not self._enabled: |
||||
self.logger.warning( |
||||
"MacOSX Notifications are not supported by this system.") |
||||
return False |
||||
|
||||
# Start with our notification path |
||||
cmd = [ |
||||
self.notify_path, |
||||
'-message', body, |
||||
] |
||||
|
||||
# Title is an optional switch |
||||
if title: |
||||
cmd.extend(['-title', title]) |
||||
|
||||
# The sound to play |
||||
if self.sound: |
||||
cmd.extend(['-sound', self.sound]) |
||||
|
||||
# Support any defined images if set |
||||
image_path = None if not self.include_image \ |
||||
else self.image_url(notify_type) |
||||
if image_path: |
||||
cmd.extend(['-appIcon', image_path]) |
||||
|
||||
# Always call throttle before any remote server i/o is made |
||||
self.throttle() |
||||
|
||||
# Send our notification |
||||
output = subprocess.Popen( |
||||
cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) |
||||
|
||||
# Wait for process to complete |
||||
output.wait() |
||||
|
||||
if output.returncode: |
||||
self.logger.warning('Failed to send MacOSX notification.') |
||||
self.logger.exception('MacOSX Exception') |
||||
return False |
||||
|
||||
self.logger.info('Sent MacOSX notification.') |
||||
return True |
||||
|
||||
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, |
||||
'image': 'yes' if self.include_image else 'no', |
||||
} |
||||
|
||||
if self.sound: |
||||
# Store our sound |
||||
args['sound'] = self.sound |
||||
|
||||
return '{schema}://_/?{args}'.format( |
||||
schema=self.protocol, |
||||
args=NotifyMacOSX.urlencode(args), |
||||
) |
||||
|
||||
@staticmethod |
||||
def parse_url(url): |
||||
""" |
||||
There are no parameters nessisary for this protocol; simply having |
||||
gnome:// is all you need. This function just makes sure that |
||||
is in place. |
||||
|
||||
""" |
||||
|
||||
results = NotifyBase.parse_url(url) |
||||
if not results: |
||||
results = { |
||||
'schema': NotifyMacOSX.protocol, |
||||
'user': None, |
||||
'password': None, |
||||
'port': None, |
||||
'host': '_', |
||||
'fullpath': None, |
||||
'path': None, |
||||
'url': url, |
||||
'qsd': {}, |
||||
} |
||||
|
||||
# Include images with our message |
||||
results['include_image'] = \ |
||||
parse_bool(results['qsd'].get('image', True)) |
||||
|
||||
# Support 'sound' |
||||
if 'sound' in results['qsd'] and len(results['qsd']['sound']): |
||||
results['sound'] = NotifyMacOSX.unquote(results['qsd']['sound']) |
||||
|
||||
return results |
||||
@ -0,0 +1,158 @@
|
||||
# -*- 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 os |
||||
import six |
||||
import mock |
||||
|
||||
import apprise |
||||
|
||||
# Disable logging for a cleaner testing output |
||||
import logging |
||||
logging.disable(logging.CRITICAL) |
||||
|
||||
|
||||
@mock.patch('subprocess.Popen') |
||||
@mock.patch('platform.system') |
||||
@mock.patch('platform.mac_ver') |
||||
def test_macosx_plugin(mock_macver, mock_system, mock_popen, tmpdir): |
||||
""" |
||||
API: NotifyMacOSX Plugin() |
||||
|
||||
""" |
||||
|
||||
# Create a temporary binary file we can reference |
||||
script = tmpdir.join("terminal-notifier") |
||||
script.write('') |
||||
# Give execute bit |
||||
os.chmod(str(script), 0o755) |
||||
# Point our object to our new temporary existing file |
||||
apprise.plugins.NotifyMacOSX.notify_path = str(script) |
||||
mock_cmd_response = mock.Mock() |
||||
|
||||
# Set a successful response |
||||
mock_cmd_response.returncode = 0 |
||||
|
||||
# Simulate a Mac Environment |
||||
mock_system.return_value = 'Darwin' |
||||
mock_macver.return_value = ('10.8', ('', '', ''), '') |
||||
mock_popen.return_value = mock_cmd_response |
||||
|
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?image=True', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is True |
||||
|
||||
# Test url() call |
||||
assert isinstance(obj.url(), six.string_types) is True |
||||
|
||||
# test notifications |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is True |
||||
|
||||
# test notification without a title |
||||
assert obj.notify(title='', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is True |
||||
|
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?image=True', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is True |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is True |
||||
|
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?image=False', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is True |
||||
assert isinstance(obj.url(), six.string_types) is True |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is True |
||||
|
||||
# Test Sound |
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?sound=default', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is True |
||||
assert obj.sound == 'default' |
||||
assert isinstance(obj.url(), six.string_types) is True |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is True |
||||
|
||||
# Now test cases where our environment isn't set up correctly |
||||
# In this case we'll simulate a situation where our binary isn't |
||||
# executable |
||||
os.chmod(str(script), 0o644) |
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?sound=default', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is False |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is False |
||||
# Restore permission |
||||
os.chmod(str(script), 0o755) |
||||
|
||||
# Test case where we simply aren't on a mac |
||||
mock_system.return_value = 'Linux' |
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?sound=default', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is False |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is False |
||||
# Restore mac environment |
||||
mock_system.return_value = 'Darwin' |
||||
|
||||
# Now we must be Mac OS v10.8 or higher... Test cases where we aren't |
||||
mock_macver.return_value = ('10.7', ('', '', ''), '') |
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?sound=default', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is False |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is False |
||||
# Restore valid mac environment |
||||
mock_macver.return_value = ('10.8', ('', '', ''), '') |
||||
|
||||
mock_macver.return_value = ('9.12', ('', '', ''), '') |
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://_/?sound=default', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is False |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is False |
||||
# Restore valid mac environment |
||||
mock_macver.return_value = ('10.8', ('', '', ''), '') |
||||
|
||||
# Test cases where the script just flat out fails |
||||
mock_cmd_response.returncode = 1 |
||||
obj = apprise.Apprise.instantiate( |
||||
'macosx://', suppress_exceptions=False) |
||||
assert isinstance(obj, apprise.plugins.NotifyMacOSX) is True |
||||
assert obj._enabled is True |
||||
assert obj.notify(title='title', body='body', |
||||
notify_type=apprise.NotifyType.INFO) is False |
||||
# Restore script return value |
||||
mock_cmd_response.returncode = 1 |
||||
Loading…
Reference in new issue