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.
295 lines
9.4 KiB
295 lines
9.4 KiB
5 years ago
|
# -*- 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 CON
|
||
|
|
|
||
|
|
import requests
|
||
|
|
|
||
|
|
from .NotifyBase import NotifyBase
|
||
|
|
from ..URLBase import PrivacyMode
|
||
|
|
from ..common import NotifyType
|
||
|
|
from ..utils import parse_list
|
||
|
|
from ..AppriseLocale import gettext_lazy as _
|
||
|
|
|
||
|
|
|
||
|
|
class NotifyNextcloud(NotifyBase):
|
||
|
|
"""
|
||
|
|
A wrapper for Nextcloud Notifications
|
||
|
|
"""
|
||
|
|
|
||
|
|
# The default descriptive name associated with the Notification
|
||
|
|
service_name = 'Nextcloud'
|
||
|
|
|
||
|
|
# The services URL
|
||
|
|
service_url = 'https://nextcloud.com/'
|
||
|
|
|
||
|
|
# Insecure protocol (for those self hosted requests)
|
||
|
|
protocol = 'ncloud'
|
||
|
|
|
||
|
|
# The default protocol (this is secure for notica)
|
||
|
|
secure_protocol = 'nclouds'
|
||
|
|
|
||
|
|
# A URL that takes you to the setup/help of the specific protocol
|
||
|
|
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_nextcloud'
|
||
|
|
|
||
|
|
# Nextcloud URL
|
||
|
|
notify_url = '{schema}://{host}/ocs/v2.php/apps/admin_notifications/' \
|
||
|
|
'api/v1/notifications/{target}'
|
||
|
|
|
||
|
|
# Nextcloud does not support a title
|
||
|
|
title_maxlen = 255
|
||
|
|
|
||
|
|
# Defines the maximum allowable characters per message.
|
||
|
|
body_maxlen = 4000
|
||
|
|
|
||
|
|
# Define object templates
|
||
|
|
templates = (
|
||
|
|
'{schema}://{user}:{password}@{host}/{targets}',
|
||
|
|
'{schema}://{user}:{password}@{host}:{port}/{targets}',
|
||
|
|
)
|
||
|
|
|
||
|
|
# Define our template tokens
|
||
|
|
template_tokens = dict(NotifyBase.template_tokens, **{
|
||
|
|
'host': {
|
||
|
|
'name': _('Hostname'),
|
||
|
|
'type': 'string',
|
||
|
|
'required': True,
|
||
|
|
},
|
||
|
|
'port': {
|
||
|
|
'name': _('Port'),
|
||
|
|
'type': 'int',
|
||
|
|
'min': 1,
|
||
|
|
'max': 65535,
|
||
|
|
},
|
||
|
|
'user': {
|
||
|
|
'name': _('Username'),
|
||
|
|
'type': 'string',
|
||
|
|
},
|
||
|
|
'password': {
|
||
|
|
'name': _('Password'),
|
||
|
|
'type': 'string',
|
||
|
|
'private': True,
|
||
|
|
},
|
||
|
|
'target_user': {
|
||
|
|
'name': _('Target User'),
|
||
|
|
'type': 'string',
|
||
|
|
'map_to': 'targets',
|
||
|
|
},
|
||
|
|
'targets': {
|
||
|
|
'name': _('Targets'),
|
||
|
|
'type': 'list:string',
|
||
|
|
'required': True,
|
||
|
|
},
|
||
|
|
})
|
||
|
|
|
||
|
|
# Define any kwargs we're using
|
||
|
|
template_kwargs = {
|
||
|
|
'headers': {
|
||
|
|
'name': _('HTTP Header'),
|
||
|
|
'prefix': '+',
|
||
|
|
},
|
||
|
|
}
|
||
|
|
|
||
|
|
def __init__(self, targets=None, headers=None, **kwargs):
|
||
|
|
"""
|
||
|
|
Initialize Nextcloud Object
|
||
|
|
"""
|
||
|
|
super(NotifyNextcloud, self).__init__(**kwargs)
|
||
|
|
|
||
|
|
self.targets = parse_list(targets)
|
||
|
|
if len(self.targets) == 0:
|
||
|
|
msg = 'At least one Nextcloud target user must be specified.'
|
||
|
|
self.logger.warning(msg)
|
||
|
|
raise TypeError(msg)
|
||
|
|
|
||
|
|
self.headers = {}
|
||
|
|
if headers:
|
||
|
|
# Store our extra headers
|
||
|
|
self.headers.update(headers)
|
||
|
|
|
||
|
|
return
|
||
|
|
|
||
|
|
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
|
||
|
|
"""
|
||
|
|
Perform Nextcloud Notification
|
||
|
|
"""
|
||
|
|
|
||
|
|
# Prepare our Header
|
||
|
|
headers = {
|
||
|
|
'User-Agent': self.app_id,
|
||
|
|
'OCS-APIREQUEST': 'true',
|
||
|
|
}
|
||
|
|
|
||
|
|
# Apply any/all header over-rides defined
|
||
|
|
headers.update(self.headers)
|
||
|
|
|
||
|
|
# error tracking (used for function return)
|
||
|
|
has_error = False
|
||
|
|
|
||
|
|
# Create a copy of the targets list
|
||
|
|
targets = list(self.targets)
|
||
|
|
while len(targets):
|
||
|
|
target = targets.pop(0)
|
||
|
|
|
||
|
|
# Prepare our Payload
|
||
|
|
payload = {
|
||
|
|
'shortMessage': title if title else self.app_desc,
|
||
|
|
}
|
||
|
|
if body:
|
||
|
|
# Only store the longMessage if a body was defined; nextcloud
|
||
|
|
# doesn't take kindly to empty longMessage entries.
|
||
|
|
payload['longMessage'] = body
|
||
|
|
|
||
|
|
auth = None
|
||
|
|
if self.user:
|
||
|
|
auth = (self.user, self.password)
|
||
|
|
|
||
|
|
notify_url = self.notify_url.format(
|
||
|
|
schema='https' if self.secure else 'http',
|
||
|
|
host=self.host if not isinstance(self.port, int)
|
||
|
|
else '{}:{}'.format(self.host, self.port),
|
||
|
|
target=target,
|
||
|
|
)
|
||
|
|
|
||
|
|
self.logger.debug('Nextcloud POST URL: %s (cert_verify=%r)' % (
|
||
|
|
notify_url, self.verify_certificate,
|
||
|
|
))
|
||
|
|
self.logger.debug('Nextcloud Payload: %s' % str(payload))
|
||
|
|
|
||
|
|
# Always call throttle before any remote server i/o is made
|
||
|
|
self.throttle()
|
||
|
|
|
||
|
|
try:
|
||
|
|
r = requests.post(
|
||
|
|
notify_url,
|
||
|
|
data=payload,
|
||
|
|
headers=headers,
|
||
|
|
auth=auth,
|
||
|
|
verify=self.verify_certificate,
|
||
|
|
)
|
||
|
|
if r.status_code != requests.codes.ok:
|
||
|
|
# We had a problem
|
||
|
|
status_str = \
|
||
|
|
NotifyNextcloud.http_response_code_lookup(
|
||
|
|
r.status_code)
|
||
|
|
|
||
|
|
self.logger.warning(
|
||
|
|
'Failed to send Nextcloud notification:'
|
||
|
|
'{}{}error={}.'.format(
|
||
|
|
status_str,
|
||
|
|
', ' if status_str else '',
|
||
|
|
r.status_code))
|
||
|
|
|
||
|
|
self.logger.debug(
|
||
|
|
'Response Details:\r\n{}'.format(r.content))
|
||
|
|
# track our failure
|
||
|
|
has_error = True
|
||
|
|
continue
|
||
|
|
|
||
|
|
else:
|
||
|
|
self.logger.info('Sent Nextcloud notification.')
|
||
|
|
|
||
|
|
except requests.RequestException as e:
|
||
|
|
self.logger.warning(
|
||
|
|
'A Connection error occured sending Nextcloud '
|
||
|
|
'notification.',
|
||
|
|
)
|
||
|
|
self.logger.debug('Socket Exception: %s' % str(e))
|
||
|
|
|
||
|
|
# track our failure
|
||
|
|
has_error = True
|
||
|
|
continue
|
||
|
|
|
||
|
|
return not has_error
|
||
|
|
|
||
|
|
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,
|
||
|
|
'verify': 'yes' if self.verify_certificate else 'no',
|
||
|
|
}
|
||
|
|
|
||
|
|
# Append our headers into our args
|
||
|
|
args.update({'+{}'.format(k): v for k, v in self.headers.items()})
|
||
|
|
|
||
|
|
# Determine Authentication
|
||
|
|
auth = ''
|
||
|
|
if self.user and self.password:
|
||
|
|
auth = '{user}:{password}@'.format(
|
||
|
|
user=NotifyNextcloud.quote(self.user, safe=''),
|
||
|
|
password=self.pprint(
|
||
|
|
self.password, privacy, mode=PrivacyMode.Secret, safe=''),
|
||
|
|
)
|
||
|
|
elif self.user:
|
||
|
|
auth = '{user}@'.format(
|
||
|
|
user=NotifyNextcloud.quote(self.user, safe=''),
|
||
|
|
)
|
||
|
|
|
||
|
|
default_port = 443 if self.secure else 80
|
||
|
|
|
||
|
|
return '{schema}://{auth}{hostname}{port}/{targets}?{args}' \
|
||
|
|
.format(
|
||
|
|
schema=self.secure_protocol
|
||
|
|
if self.secure else self.protocol,
|
||
|
|
auth=auth,
|
||
|
|
hostname=NotifyNextcloud.quote(self.host, safe=''),
|
||
|
|
port='' if self.port is None or self.port == default_port
|
||
|
|
else ':{}'.format(self.port),
|
||
|
|
targets='/'.join([NotifyNextcloud.quote(x)
|
||
|
|
for x in self.targets]),
|
||
|
|
args=NotifyNextcloud.urlencode(args),
|
||
|
|
)
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def parse_url(url):
|
||
|
|
"""
|
||
|
|
Parses the URL and returns enough arguments that can allow
|
||
|
|
us to substantiate this object.
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
results = NotifyBase.parse_url(url)
|
||
|
|
if not results:
|
||
|
|
# We're done early as we couldn't load the results
|
||
|
|
return results
|
||
|
|
|
||
|
|
# Fetch our targets
|
||
|
|
results['targets'] = \
|
||
|
|
NotifyNextcloud.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'] += \
|
||
|
|
NotifyNextcloud.parse_list(results['qsd']['to'])
|
||
|
|
|
||
|
|
# Add our headers that the user can potentially over-ride if they
|
||
|
|
# wish to to our returned result set
|
||
|
|
results['headers'] = results['qsd-']
|
||
|
|
results['headers'].update(results['qsd+'])
|
||
|
|
|
||
|
|
return results
|