zopefoundation · dataflake · May 18, 2024 · May 17, 2024 · May 18, 2024 · d-maurer
diff --git a/.meta.toml b/.meta.toml
@@ -104,6 +104,7 @@ additional-rules = [
     "recursive-include src *.svg",
     "recursive-include src *.ttf",
     "recursive-include src *.txt",
+    "recursive-include src *.types",
     "recursive-include src *.webmanifest",
     "recursive-include src *.woff",
     "recursive-include src *.woff2",

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -10,6 +10,10 @@ https://github.com/zopefoundation/Zope/blob/4.x/CHANGES.rst
 5.9.1 (unreleased)
 ------------------
 
+- Define a custom MIME type for Zope Page Templates
+  instead of relying on platform-dependent MIME type configurations.
+  (`#1212 <https://github.com/zopefoundation/Zope/issues/1212>`_)
+
 - Clean up and fix installation documentation.
 
 - Officially support Python 3.12.1.

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -43,6 +43,7 @@ recursive-include src *.rst
 recursive-include src *.svg
 recursive-include src *.ttf
 recursive-include src *.txt
+recursive-include src *.types
 recursive-include src *.webmanifest
 recursive-include src *.woff
 recursive-include src *.woff2

diff --git a/src/Products/PageTemplates/__init__.py b/src/Products/PageTemplates/__init__.py
@@ -15,6 +15,10 @@
 This wrapper allows the Page Template modules to be segregated in a
 separate package.
 """
+import os
+
+from zope.contenttype import add_files
+
 
 # Placeholder for Zope Product data
 misc_ = {}
@@ -29,3 +33,8 @@ def initialize(context):
     # Import lazily, and defer initialization to the module
     from . import ZopePageTemplate
     ZopePageTemplate.initialize(context)
+
+    # Add the custom MIME type information for Page Templates
+    # to the Python mimetypes module so they are recognized correctly
+    here = os.path.dirname(os.path.abspath(__file__))
+    add_files([os.path.join(here, 'mime.types')])
diff --git a/src/Products/PageTemplates/mime.types b/src/Products/PageTemplates/mime.types
@@ -0,0 +1 @@
+application/vnd.zopefoundation.pagetemplate     pt zpt
diff --git a/src/webdav/NullResource.py b/src/webdav/NullResource.py
@@ -114,7 +114,9 @@ def _default_PUT_factory(self, name, typ, body):
 
         if ext == '.dtml':
             ob = DTMLDocument('', __name__=name)
-        elif typ in ('text/html', 'text/xml'):
+        elif typ in ('text/html',
+                     'text/xml',
+                     'application/vnd.zopefoundation.pagetemplate'):
             ob = ZopePageTemplate(name, body, content_type=typ)
         elif typ.startswith('image/'):
             ob = Image(name, '', body, content_type=typ)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		application/vnd.zopefoundation.pagetemplate pt zpt
Copy link Contributor d-maurer May 17, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. In view of https://www.rfc-editor.org/rfc/rfc2046#section-6 we likely should start our subtype with `X-` (indicating a somewhat unofficial value). Because a page template is mostly human readable, `text` might be better than `application` as top level type. However, because we only plan to use the type internally (and not for publication), the precise value is not of great importance. We might also check that the appearance of a ".pt -> MIME type" map in public registries does not pose a problem on a different route: browsers may consult those registries to automatically provide a "Content-Type" header which might prevent our guessing. However, if this really happens, I have no idea how to prevent it (the browser's info may be authoritative and not based on guessing).