mirror of
https://github.com/caronc/apprise-api.git
synced 2024-12-14 10:50:49 +01:00
138 lines
4.0 KiB
Python
138 lines
4.0 KiB
Python
|
# -*- 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.
|
||
|
|
||
|
import apprise
|
||
|
from django import forms
|
||
|
from django.utils.translation import ugettext_lazy as _
|
||
|
|
||
|
# Define our potential configuration types
|
||
|
CONFIG_FORMATS = (
|
||
|
(apprise.ConfigFormat.TEXT, _('TEXT')),
|
||
|
(apprise.ConfigFormat.YAML, _('YAML')),
|
||
|
)
|
||
|
|
||
|
NOTIFICATION_TYPES = (
|
||
|
(apprise.NotifyType.INFO, _('Info')),
|
||
|
(apprise.NotifyType.SUCCESS, _('Success')),
|
||
|
(apprise.NotifyType.WARNING, _('Warning')),
|
||
|
(apprise.NotifyType.FAILURE, _('Failure')),
|
||
|
)
|
||
|
|
||
|
|
||
|
class AddByUrlForm(forms.Form):
|
||
|
"""
|
||
|
Form field for adding entries simply by passing in a string
|
||
|
of one or more URLs that have been deliminted by either a
|
||
|
comma and/or a space.
|
||
|
|
||
|
This content can just be directly fed straight into Apprise
|
||
|
"""
|
||
|
urls = forms.CharField(
|
||
|
label=_('URLs'),
|
||
|
widget=forms.TextInput(
|
||
|
attrs={
|
||
|
'placeholder': 'mailto://user:pass@domain.com, '
|
||
|
'slack://tokena/tokenb/tokenc, ...'}),
|
||
|
max_length=1024,
|
||
|
)
|
||
|
|
||
|
|
||
|
class AddByConfigForm(forms.Form):
|
||
|
"""
|
||
|
This is the reading in of a configuration file which contains
|
||
|
potential asset information (if yaml file) and tag details.
|
||
|
"""
|
||
|
|
||
|
format = forms.ChoiceField(
|
||
|
label=_('Format'),
|
||
|
choices=CONFIG_FORMATS,
|
||
|
)
|
||
|
|
||
|
config = forms.CharField(
|
||
|
label=_('Configuration'),
|
||
|
widget=forms.Textarea(),
|
||
|
max_length=4096,
|
||
|
)
|
||
|
|
||
|
|
||
|
class NotifyForm(forms.Form):
|
||
|
"""
|
||
|
This is the reading in of a configuration file which contains
|
||
|
potential asset information (if yaml file) and tag details.
|
||
|
"""
|
||
|
|
||
|
type = forms.ChoiceField(
|
||
|
label=_('Type'),
|
||
|
choices=NOTIFICATION_TYPES,
|
||
|
initial=NOTIFICATION_TYPES[0][0],
|
||
|
required=False,
|
||
|
)
|
||
|
|
||
|
title = forms.CharField(
|
||
|
label=_('Title'),
|
||
|
widget=forms.TextInput(attrs={'placeholder': _('Optional Title')}),
|
||
|
max_length=apprise.NotifyBase.title_maxlen,
|
||
|
required=False,
|
||
|
)
|
||
|
|
||
|
body = forms.CharField(
|
||
|
label=_('Body'),
|
||
|
widget=forms.Textarea(),
|
||
|
max_length=apprise.NotifyBase.body_maxlen,
|
||
|
)
|
||
|
|
||
|
tag = forms.ChoiceField(
|
||
|
label=_('Tags'),
|
||
|
widget=forms.TextInput(
|
||
|
attrs={'placeholder': _('Optional_Tag1, Optional_Tag2, ...')}),
|
||
|
required=False,
|
||
|
)
|
||
|
|
||
|
def clean_type(self):
|
||
|
"""
|
||
|
We just ensure there is a type always set
|
||
|
"""
|
||
|
data = self.cleaned_data['type']
|
||
|
if not data:
|
||
|
# Always set a type
|
||
|
data = apprise.NotifyType.INFO
|
||
|
return data
|
||
|
|
||
|
|
||
|
class NotifyByUrlForm(AddByUrlForm, NotifyForm):
|
||
|
"""
|
||
|
Same as the NotifyForm but additionally processes a string of URLs to
|
||
|
notify directly.
|
||
|
"""
|
||
|
pass
|
||
|
|
||
|
|
||
|
class NotifyByConfigForm(AddByConfigForm, NotifyForm):
|
||
|
"""
|
||
|
Same as the NotifyForm but additionally process a configuration file as
|
||
|
well.
|
||
|
"""
|
||
|
pass
|