Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/scripts/setup/inline_email_css.py

110 lines
4.1 KiB
Python
Raw Normal View History

tools: Create tool for inlining email CSS during provision.
2017-09-16 14:30:57 +02:00
#!/usr/bin/env python3
import os
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
from typing import Set
tools: Create tool for inlining email CSS during provision.
2017-09-16 14:30:57 +02:00
from cssutils import profile
python: Sort imports with isort. Fixes #2665. Regenerated by tabbott with `lint --fix` after a rebase and change in parameters. Note from tabbott: In a few cases, this converts technical debt in the form of unsorted imports into different technical debt in the form of our largest files having very long, ugly import sequences at the start. I expect this change will increase pressure for us to split those files, which isn't a bad thing. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-11 00:54:34 +02:00
from cssutils.profiles import Profiles, macros, properties
from premailer import Premailer
tools: Create tool for inlining email CSS during provision.
2017-09-16 14:30:57 +02:00
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
ZULIP_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../")
EMAIL_TEMPLATES_PATH = os.path.join(ZULIP_PATH, "templates", "zerver", "emails")
inline_email_css: Move constants to top, remove chdir.
2020-04-09 12:22:23 +02:00
CSS_SOURCE_PATH = os.path.join(EMAIL_TEMPLATES_PATH, "email.css")
tools: Create tool for inlining email CSS during provision.
2017-09-16 14:30:57 +02:00
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
inline_email_css: Extract configure_cssutils.
2020-04-06 02:48:43 +02:00
def configure_cssutils() -> None:
tools: Create tool for inlining email CSS during provision.
2017-09-16 14:30:57 +02:00
# These properties are not supported by cssutils by default and will
# result in warnings when premailer package is run.
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
properties[Profiles.CSS_LEVEL_2]["-ms-interpolation-mode"] = r"none|bicubic|nearest-neighbor"
properties[Profiles.CSS_LEVEL_2]["-ms-text-size-adjust"] = r"none|auto|{percentage}"
properties[Profiles.CSS_LEVEL_2]["mso-table-lspace"] = r"0|{num}(pt)"
properties[Profiles.CSS_LEVEL_2]["mso-table-rspace"] = r"0|{num}(pt)"
properties[Profiles.CSS_LEVEL_2]["-webkit-text-size-adjust"] = r"none|auto|{percentage}"
properties[Profiles.CSS_LEVEL_2]["mso-hide"] = "all"
properties[Profiles.CSS_LEVEL_2]["pointer-events"] = (
r"auto|none|visiblePainted|"
r"visibleFill|visibleStroke|"
r"visible|painted|fill|stroke|all|inherit"
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
)
profile.addProfiles(
[(Profiles.CSS_LEVEL_2, properties[Profiles.CSS_LEVEL_2], macros[Profiles.CSS_LEVEL_2])]
)
tools: Create tool for inlining email CSS during provision.
2017-09-16 14:30:57 +02:00
inline_email_css: Configure cssutils on import. This is necessary for when we later want to call inline_template from elsewhere.
2020-04-11 00:49:28 +02:00
configure_cssutils()
tools: Create tool for inlining email CSS during provision.
2017-09-16 14:30:57 +02:00
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
inline_email_css: Simplify parsing of template names. Removing the extensions within the Set construction object was a confusing way to do things.
2020-04-11 00:52:52 +02:00
def inline_template(template_source_name: str) -> None:
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
template_name = template_source_name.split(".source.html")[0]
inline_email_css: Simplify parsing of template names. Removing the extensions within the Set construction object was a confusing way to do things.
2020-04-11 00:52:52 +02:00
template_path = os.path.join(EMAIL_TEMPLATES_PATH, template_source_name)
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
compiled_template_path = os.path.join(
os.path.dirname(template_path), "compiled", os.path.basename(template_name) + ".html"
)
send_custom_email: Use a special .gitignored directory. Previously, the send_custom_email code path leaked files in paths that were not `.gitignored`, under templates/zerver/emails. This became problematic when we added automated tests for this code path, as it meant we leaked these files every time `test-backend` ran. Fix this by ensuring all the files we generate are in this special subdirectory.
2020-04-22 01:48:28 +02:00
os.makedirs(os.path.dirname(compiled_template_path), exist_ok=True)
inline_email_css: Extract inline_template function.
2020-04-09 12:39:01 +02:00
with open(template_path) as template_source_file:
template_str = template_source_file.read()
requirements: Upgrade Python requirements. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-06-04 20:11:00 +02:00
output = Premailer(
template_str, external_styles=[CSS_SOURCE_PATH], allow_loading_external_files=True
).transform()
inline_email_css: Extract inline_template function.
2020-04-09 12:39:01 +02:00
output = escape_jinja2_characters(output)
# Premailer.transform will try to complete the DOM tree,
# adding html, head, and body tags if they aren't there.
# While this is correct for the email_base_default template,
# it is wrong for the other templates that extend this
docs: Fix many spelling mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-08 00:13:33 +01:00
# template, since we'll end up with 2 copies of those tags.
inline_email_css: Extract inline_template function.
2020-04-09 12:39:01 +02:00
# Thus, we strip this stuff out if the template extends
# another template.
emails: Create wider marketing email base template. For our marketing emails, we want a width that's more appropriate for newsletter context, vs. the narrow emails we use for transactional content. I haven't figured out a cleaner way to do this than duplicating most of email_base_default.source.html. But it's not a big deal to duplicate, since we've been changing that base template only about once a year.
2021-08-02 06:11:36 +02:00
if template_name not in ["email_base_default", "email_base_marketing", "macros"]:
inline_email_css: Extract inline_template function.
2020-04-09 12:39:01 +02:00
output = strip_unnecesary_tags(output)
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
if (
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
"zerver/emails/compiled/email_base_default.html" in output
emails: Create wider marketing email base template. For our marketing emails, we want a width that's more appropriate for newsletter context, vs. the narrow emails we use for transactional content. I haven't figured out a cleaner way to do this than duplicating most of email_base_default.source.html. But it's not a big deal to duplicate, since we've been changing that base template only about once a year.
2021-08-02 06:11:36 +02:00
or "zerver/emails/compiled/email_base_marketing.html" in output
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
or "zerver/emails/email_base_messages.html" in output
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
):
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
assert output.count("<html>") == 0
assert output.count("<body>") == 0
assert output.count("</html>") == 0
assert output.count("</body>") == 0
inline_email_css: Extract inline_template function.
2020-04-09 12:39:01 +02:00
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
with open(compiled_template_path, "w") as final_template_file:
inline_email_css: Extract inline_template function.
2020-04-09 12:39:01 +02:00
final_template_file.write(output)
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
inline_email_css: Extract escape_jinja2_characters.
2020-04-09 12:12:09 +02:00
def escape_jinja2_characters(text: str) -> str:
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
escaped_jinja2_characters = [("%7B%7B%20", "{{ "), ("%20%7D%7D", " }}"), ("&gt;", ">")]
inline_email_css: Extract escape_jinja2_characters.
2020-04-09 12:12:09 +02:00
for escaped, original in escaped_jinja2_characters:
text = text.replace(escaped, original)
return text
inline_email_css: Extract configure_cssutils.
2020-04-06 02:48:43 +02:00
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
inline_email_css: Extract strip_unnecesary_tags.
2020-04-09 12:16:53 +02:00
def strip_unnecesary_tags(text: str) -> str:
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
end_block = "</body>\n</html>"
start_block = "{% extends"
inline_email_css: Extract strip_unnecesary_tags.
2020-04-09 12:16:53 +02:00
start = text.find(start_block)
end = text.rfind(end_block)
if start != -1 and end != -1:
text = text[start:end]
return text
else:
python: Convert percent formatting to Python 3.6 f-strings. Generated by pyupgrade --py36-plus. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:41:04 +02:00
raise ValueError(f"Template does not have {start_block} or {end_block}")
inline_email_css: Extract strip_unnecesary_tags.
2020-04-09 12:16:53 +02:00
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
inline_email_css: Extract get_all_templates_from_directory.
2020-04-09 12:27:24 +02:00
def get_all_templates_from_directory(directory: str) -> Set[str]:
result = set()
for f in os.listdir(directory):
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
if f.endswith(".source.html"):
inline_email_css: Simplify parsing of template names. Removing the extensions within the Set construction object was a confusing way to do things.
2020-04-11 00:52:52 +02:00
result.add(f)
inline_email_css: Extract get_all_templates_from_directory.
2020-04-09 12:27:24 +02:00
return result
inline_email_css: Extract configure_cssutils.
2020-04-06 02:48:43 +02:00
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
inline_email_css: Extract get_all_templates_from_directory.
2020-04-09 12:27:24 +02:00
if __name__ == "__main__":
templates_to_inline = get_all_templates_from_directory(EMAIL_TEMPLATES_PATH)
inline_email_css: Extract configure_cssutils.
2020-04-06 02:48:43 +02:00
inline_email_css: Simplify parsing of template names. Removing the extensions within the Set construction object was a confusing way to do things.
2020-04-11 00:52:52 +02:00
for template_source_name in templates_to_inline:
inline_template(template_source_name)