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.
276 lines
9.0 KiB
276 lines
9.0 KiB
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2019 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
|
|
|
|
from time import sleep
|
|
|
|
from .NotifyBase import NotifyBase
|
|
from ..common import NotifyImageSize
|
|
from ..common import NotifyType
|
|
from ..utils import parse_bool
|
|
from ..AppriseLocale import gettext_lazy as _
|
|
|
|
# Default our global support flag
|
|
NOTIFY_WINDOWS_SUPPORT_ENABLED = False
|
|
|
|
try:
|
|
# 3rd party modules (Windows Only)
|
|
import win32api
|
|
import win32con
|
|
import win32gui
|
|
|
|
# We're good to go!
|
|
NOTIFY_WINDOWS_SUPPORT_ENABLED = True
|
|
|
|
except ImportError:
|
|
# No problem; we just simply can't support this plugin because we're
|
|
# either using Linux, or simply do not have pypiwin32 installed.
|
|
pass
|
|
|
|
|
|
class NotifyWindows(NotifyBase):
|
|
"""
|
|
A wrapper for local Windows Notifications
|
|
"""
|
|
|
|
# The default descriptive name associated with the Notification
|
|
service_name = 'Windows Notification'
|
|
|
|
# The default protocol
|
|
protocol = 'windows'
|
|
|
|
# A URL that takes you to the setup/help of the specific protocol
|
|
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_windows'
|
|
|
|
# Disable throttle rate for Windows requests since they are normally
|
|
# local anyway
|
|
request_rate_per_sec = 0
|
|
|
|
# Allows the user to specify the NotifyImageSize object
|
|
image_size = NotifyImageSize.XY_128
|
|
|
|
# Limit results to just the first 2 line otherwise there is just to much
|
|
# content to display
|
|
body_max_line_count = 2
|
|
|
|
# The number of seconds to display the popup for
|
|
default_popup_duration_sec = 12
|
|
|
|
# This entry is a bit hacky, but it allows us to unit-test this library
|
|
# in an environment that simply doesn't have the windows packages
|
|
# available to us. It also allows us to handle situations where the
|
|
# packages actually are present but we need to test that they aren't.
|
|
# If anyone is seeing this had knows a better way of testing this
|
|
# outside of what is defined in test/test_windows_plugin.py, please
|
|
# let me know! :)
|
|
_enabled = NOTIFY_WINDOWS_SUPPORT_ENABLED
|
|
|
|
# Define object templates
|
|
templates = (
|
|
'{schema}://_/',
|
|
)
|
|
|
|
# Define our template arguments
|
|
template_args = dict(NotifyBase.template_args, **{
|
|
'duration': {
|
|
'name': _('Duration'),
|
|
'type': 'int',
|
|
'min': 1,
|
|
'default': 12,
|
|
},
|
|
'image': {
|
|
'name': _('Include Image'),
|
|
'type': 'bool',
|
|
'default': True,
|
|
'map_to': 'include_image',
|
|
},
|
|
})
|
|
|
|
def __init__(self, include_image=True, duration=None, **kwargs):
|
|
"""
|
|
Initialize Windows Object
|
|
"""
|
|
|
|
super(NotifyWindows, self).__init__(**kwargs)
|
|
|
|
# Number of seconds to display notification for
|
|
self.duration = self.default_popup_duration_sec \
|
|
if not (isinstance(duration, int) and duration > 0) else duration
|
|
|
|
# Define our handler
|
|
self.hwnd = None
|
|
|
|
# Track whether or not we want to send an image with our notification
|
|
# or not.
|
|
self.include_image = include_image
|
|
|
|
def _on_destroy(self, hwnd, msg, wparam, lparam):
|
|
"""
|
|
Destroy callback function
|
|
"""
|
|
|
|
nid = (self.hwnd, 0)
|
|
win32gui.Shell_NotifyIcon(win32gui.NIM_DELETE, nid)
|
|
win32api.PostQuitMessage(0)
|
|
|
|
return None
|
|
|
|
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
|
"""
|
|
Perform Windows Notification
|
|
"""
|
|
|
|
if not self._enabled:
|
|
self.logger.warning(
|
|
"Windows Notifications are not supported by this system.")
|
|
return False
|
|
|
|
# Always call throttle before any remote server i/o is made
|
|
self.throttle()
|
|
|
|
try:
|
|
# Register destruction callback
|
|
message_map = {win32con.WM_DESTROY: self._on_destroy, }
|
|
|
|
# Register the window class.
|
|
self.wc = win32gui.WNDCLASS()
|
|
self.hinst = self.wc.hInstance = win32api.GetModuleHandle(None)
|
|
self.wc.lpszClassName = str("PythonTaskbar")
|
|
self.wc.lpfnWndProc = message_map
|
|
self.classAtom = win32gui.RegisterClass(self.wc)
|
|
|
|
# Styling and window type
|
|
style = win32con.WS_OVERLAPPED | win32con.WS_SYSMENU
|
|
self.hwnd = win32gui.CreateWindow(
|
|
self.classAtom, "Taskbar", style, 0, 0,
|
|
win32con.CW_USEDEFAULT, win32con.CW_USEDEFAULT, 0, 0,
|
|
self.hinst, None)
|
|
win32gui.UpdateWindow(self.hwnd)
|
|
|
|
# image path (if configured to acquire)
|
|
icon_path = None if not self.include_image \
|
|
else self.image_path(notify_type, extension='.ico')
|
|
|
|
if icon_path:
|
|
icon_flags = win32con.LR_LOADFROMFILE | win32con.LR_DEFAULTSIZE
|
|
|
|
try:
|
|
hicon = win32gui.LoadImage(
|
|
self.hinst, icon_path, win32con.IMAGE_ICON, 0, 0,
|
|
icon_flags)
|
|
|
|
except Exception as e:
|
|
self.logger.warning(
|
|
"Could not load windows notification icon ({}): {}"
|
|
.format(icon_path, e))
|
|
|
|
# disable icon
|
|
hicon = win32gui.LoadIcon(0, win32con.IDI_APPLICATION)
|
|
else:
|
|
# disable icon
|
|
hicon = win32gui.LoadIcon(0, win32con.IDI_APPLICATION)
|
|
|
|
# Taskbar icon
|
|
flags = win32gui.NIF_ICON | win32gui.NIF_MESSAGE | win32gui.NIF_TIP
|
|
nid = (self.hwnd, 0, flags, win32con.WM_USER + 20, hicon,
|
|
"Tooltip")
|
|
win32gui.Shell_NotifyIcon(win32gui.NIM_ADD, nid)
|
|
win32gui.Shell_NotifyIcon(win32gui.NIM_MODIFY, (
|
|
self.hwnd, 0, win32gui.NIF_INFO, win32con.WM_USER + 20, hicon,
|
|
"Balloon Tooltip", body, 200, title))
|
|
|
|
# take a rest then destroy
|
|
sleep(self.duration)
|
|
win32gui.DestroyWindow(self.hwnd)
|
|
win32gui.UnregisterClass(self.wc.lpszClassName, None)
|
|
|
|
self.logger.info('Sent Windows notification.')
|
|
|
|
except Exception:
|
|
self.logger.warning('Failed to send Windows notification.')
|
|
self.logger.exception('Windows Exception')
|
|
return False
|
|
|
|
return True
|
|
|
|
def url(self):
|
|
"""
|
|
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',
|
|
'duration': str(self.duration),
|
|
'verify': 'yes' if self.verify_certificate else 'no',
|
|
}
|
|
|
|
return '{schema}://_/?{args}'.format(
|
|
schema=self.protocol,
|
|
args=NotifyWindows.urlencode(args),
|
|
)
|
|
|
|
@staticmethod
|
|
def parse_url(url):
|
|
"""
|
|
There are no parameters nessisary for this protocol; simply having
|
|
windows:// is all you need. This function just makes sure that
|
|
is in place.
|
|
|
|
"""
|
|
|
|
results = NotifyBase.parse_url(url)
|
|
if not results:
|
|
results = {
|
|
'schema': NotifyWindows.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))
|
|
|
|
# Set duration
|
|
try:
|
|
results['duration'] = int(results['qsd'].get('duration'))
|
|
|
|
except (TypeError, ValueError):
|
|
# Not a valid integer; ignore entry
|
|
pass
|
|
|
|
# return results
|
|
return results
|