scripts: Rename inline-email-css to inline_email_css.py.

This is a preparatory step for making it a module that we can import and call from other code.
2025-11-03 05:23:35 +00:00 · 2020-04-05 17:40:19 -07:00
parent d8fce9417b
commit 59937ec9fa
8 changed files with 14 additions and 14 deletions
--- a/scripts/setup/inline_email_css.py
+++ b/scripts/setup/inline_email_css.py
@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+import os
+import errno
+
+from premailer import Premailer
+from cssutils import profile
+from cssutils.profiles import Profiles, properties, macros
+
+ZULIP_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), '../../')
+
+if __name__ == "__main__":
+    escaped_jinja2_characters = [('%7B%7B%20', '{{ '), ('%20%7D%7D', ' }}'), ('&gt;', '>')]
+
+    templates_to_inline = set()
+    for f in os.listdir(os.path.join(ZULIP_PATH, 'templates', 'zerver', 'emails')):
+        if f.endswith('.source.html'):
+            templates_to_inline.add(f.split('.source.html')[0])
+
+    # These properties are not supported by cssutils by default and will
+    # result in warnings when premailer package is run.
+    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')
+
+    profile.addProfiles([(Profiles.CSS_LEVEL_2, properties[Profiles.CSS_LEVEL_2],
+                         macros[Profiles.CSS_LEVEL_2])])
+
+    os.chdir(os.path.join(ZULIP_PATH, 'templates', 'zerver', 'emails'))
+
+    try:
+        os.makedirs("compiled")
+    except OSError as e:
+        if e.errno != errno.EEXIST:
+            raise
+
+    for template in templates_to_inline:
+        template_html_source = template + ".source.html"
+        compiled_template_path = os.path.join(os.getcwd(), "compiled", template + ".html")
+
+        with open(template_html_source) as template_source_file:
+            template_str = template_source_file.read()
+        output = Premailer(template_str,
+                           external_styles=["email.css"]).transform()
+
+        for escaped, original in escaped_jinja2_characters:
+            output = output.replace(escaped, original)
+
+        # 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
+        # template, since we'll end up with 2 copipes of those tags.
+        # Thus, we strip this stuff out if the template extends
+        # another template.
+        end_block = '</body>\n</html>'
+        start = output.find('{% extends')
+        end = output.rfind(end_block)
+        if start != -1 and end != -1:
+            output = output[start:end]
+        else:
+            # Only the base-default template should not be using this system.
+            assert template == 'email_base_default'
+
+        if ('zerver/emails/compiled/email_base_default.html' in output or
+                'zerver/emails/email_base_messages.html' in output):
+            assert output.count('<html>') == 0
+            assert output.count('<body>') == 0
+            assert output.count('</html>') == 0
+            assert output.count('</body>') == 0
+
+        with open(compiled_template_path, 'w') as final_template_file:
+            final_template_file.write(output)