mirror of
https://github.com/apache/superset.git
synced 2026-04-19 08:04:53 +00:00
3adf8e85cd
* feat: send data embedded in report email * Prettify table * Change post-processing to use new endpoint * Show text option only for text viz * Show TEXT option only to text-based vizs * Fix test * Add email test * Add unit test
131 lines
4.3 KiB
Python
131 lines
4.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
import json
|
|
import logging
|
|
from dataclasses import dataclass
|
|
from email.utils import make_msgid, parseaddr
|
|
from typing import Any, Dict, Optional
|
|
|
|
import bleach
|
|
from flask_babel import gettext as __
|
|
|
|
from superset import app
|
|
from superset.models.reports import ReportRecipientType
|
|
from superset.reports.notifications.base import BaseNotification
|
|
from superset.reports.notifications.exceptions import NotificationError
|
|
from superset.utils.core import send_email_smtp
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
TABLE_TAGS = ["table", "th", "tr", "td", "thead", "tbody", "tfoot"]
|
|
|
|
|
|
@dataclass
|
|
class EmailContent:
|
|
body: str
|
|
data: Optional[Dict[str, Any]] = None
|
|
images: Optional[Dict[str, bytes]] = None
|
|
|
|
|
|
class EmailNotification(BaseNotification): # pylint: disable=too-few-public-methods
|
|
"""
|
|
Sends an email notification for a report recipient
|
|
"""
|
|
|
|
type = ReportRecipientType.EMAIL
|
|
|
|
@staticmethod
|
|
def _get_smtp_domain() -> str:
|
|
return parseaddr(app.config["SMTP_MAIL_FROM"])[1].split("@")[1]
|
|
|
|
@staticmethod
|
|
def _error_template(text: str) -> str:
|
|
return __(
|
|
"""
|
|
Error: %(text)s
|
|
""",
|
|
text=text,
|
|
)
|
|
|
|
def _get_content(self) -> EmailContent:
|
|
if self._content.text:
|
|
return EmailContent(body=self._error_template(self._content.text))
|
|
# Get the domain from the 'From' address ..
|
|
# and make a message id without the < > in the end
|
|
image = None
|
|
csv_data = None
|
|
domain = self._get_smtp_domain()
|
|
msgid = make_msgid(domain)[1:-1]
|
|
|
|
# Strip any malicious HTML from the description
|
|
description = bleach.clean(self._content.description or "")
|
|
|
|
# Strip malicious HTML from embedded data, allowing table elements
|
|
embedded_data = bleach.clean(self._content.embedded_data or "", tags=TABLE_TAGS)
|
|
|
|
body = __(
|
|
"""
|
|
<p>%(description)s</p>
|
|
<b><a href="%(url)s">Explore in Superset</a></b><p></p>
|
|
%(embedded_data)s
|
|
%(img_tag)s
|
|
""",
|
|
description=description,
|
|
url=self._content.url,
|
|
embedded_data=embedded_data,
|
|
img_tag='<img width="1000px" src="cid:{}">'.format(msgid)
|
|
if self._content.screenshot
|
|
else "",
|
|
)
|
|
if self._content.screenshot:
|
|
image = {msgid: self._content.screenshot}
|
|
if self._content.csv:
|
|
csv_data = {__("%(name)s.csv", name=self._content.name): self._content.csv}
|
|
return EmailContent(body=body, images=image, data=csv_data)
|
|
|
|
def _get_subject(self) -> str:
|
|
return __(
|
|
"%(prefix)s %(title)s",
|
|
prefix=app.config["EMAIL_REPORTS_SUBJECT_PREFIX"],
|
|
title=self._content.name,
|
|
)
|
|
|
|
def _get_to(self) -> str:
|
|
return json.loads(self._recipient.recipient_config_json)["target"]
|
|
|
|
def send(self) -> None:
|
|
subject = self._get_subject()
|
|
content = self._get_content()
|
|
to = self._get_to()
|
|
try:
|
|
send_email_smtp(
|
|
to,
|
|
subject,
|
|
content.body,
|
|
app.config,
|
|
files=[],
|
|
data=content.data,
|
|
images=content.images,
|
|
bcc="",
|
|
mime_subtype="related",
|
|
dryrun=False,
|
|
)
|
|
logger.info("Report sent to email")
|
|
except Exception as ex:
|
|
raise NotificationError(ex)
|