mirror of
https://github.com/inventree/InvenTree.git
synced 2025-07-31 09:01:35 +00:00
97 lines
3.0 KiB
Python
97 lines
3.0 KiB
Python
"""Core set of Notifications as a Plugin."""
|
|
|
|
from django.template.loader import render_to_string
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from allauth.account.models import EmailAddress
|
|
|
|
import common.models
|
|
import InvenTree.helpers
|
|
import InvenTree.tasks
|
|
from plugin import InvenTreePlugin
|
|
from plugin.mixins import BulkNotificationMethod, SettingsMixin
|
|
|
|
|
|
class PlgMixin:
|
|
"""Mixin to access plugin easier.
|
|
|
|
This needs to be spit out to reference the class. Perks of python.
|
|
"""
|
|
|
|
def get_plugin(self):
|
|
"""Return plugin reference."""
|
|
return CoreNotificationsPlugin
|
|
|
|
|
|
class CoreNotificationsPlugin(SettingsMixin, InvenTreePlugin):
|
|
"""Core notification methods for InvenTree."""
|
|
|
|
NAME = "CoreNotificationsPlugin"
|
|
TITLE = _("InvenTree Notifications")
|
|
AUTHOR = _('InvenTree contributors')
|
|
DESCRIPTION = _('Integrated outgoing notificaton methods')
|
|
VERSION = "1.0"
|
|
|
|
SETTINGS = {
|
|
'ENABLE_NOTIFICATION_EMAILS': {
|
|
'name': _('Enable email notifications'),
|
|
'description': _('Allow sending of emails for event notifications'),
|
|
'default': False,
|
|
'validator': bool,
|
|
},
|
|
}
|
|
|
|
class EmailNotification(PlgMixin, BulkNotificationMethod):
|
|
"""Notificationmethod for delivery via Email."""
|
|
|
|
METHOD_NAME = 'mail'
|
|
METHOD_ICON = 'fa-envelope'
|
|
CONTEXT_EXTRA = [
|
|
('template', ),
|
|
('template', 'html', ),
|
|
('template', 'subject', ),
|
|
]
|
|
GLOBAL_SETTING = 'ENABLE_NOTIFICATION_EMAILS'
|
|
USER_SETTING = {
|
|
'name': _('Enable email notifications'),
|
|
'description': _('Allow sending of emails for event notifications'),
|
|
'default': True,
|
|
'validator': bool,
|
|
}
|
|
|
|
def get_targets(self):
|
|
"""Return a list of target email addresses, only for users which allow email notifications."""
|
|
allowed_users = []
|
|
|
|
for user in self.targets:
|
|
|
|
if not user.is_active:
|
|
# Ignore any users who have been deactivated
|
|
continue
|
|
|
|
allows_emails = InvenTree.helpers.str2bool(self.usersetting(user))
|
|
|
|
if allows_emails:
|
|
allowed_users.append(user)
|
|
|
|
return EmailAddress.objects.filter(
|
|
user__in=allowed_users,
|
|
)
|
|
|
|
def send_bulk(self):
|
|
"""Send the notifications out via email."""
|
|
html_message = render_to_string(self.context['template']['html'], self.context)
|
|
targets = self.targets.values_list('email', flat=True)
|
|
|
|
# Prefix the 'instance title' to the email subject
|
|
instance_title = common.models.InvenTreeSetting.get_setting('INVENTREE_INSTANCE')
|
|
|
|
subject = self.context['template'].get('subject', '')
|
|
|
|
if instance_title:
|
|
subject = f'[{instance_title}] {subject}'
|
|
|
|
InvenTree.tasks.send_email(subject, '', targets, html_message=html_message)
|
|
|
|
return True
|