Allow customization of the domains attribute in pkg installers

CONSTRUCT.md

@@ -540,6 +540,17 @@ to `/Library` in a "Just me" installation will give you `~/Library/<PKG_NAME>`.
 Internally, this is passed to `pkgbuild --install-location`.
 macOS only.
 
+### `pkg_domains`
+
+_required:_ no<br/>
+_type:_ dictionary<br/>
+
+The domains the package can be installed into. For a detailed explanation, see:
+https://developer.apple.com/library/archive/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html
+constructor defaults to `enable_anywhere=true` and `enable_currentUserHome=true`.
+`enable_localSystem` should not be set to true unless `default_location_pkg` is set as well.
+macOS only.
+
 ### `pkg_name`
 
 _required:_ no<br/>

constructor/construct.py

@@ -396,6 +396,14 @@
 to `/Library` in a "Just me" installation will give you `~/Library/<PKG_NAME>`.
 Internally, this is passed to `pkgbuild --install-location`.
 macOS only.
+'''),
+
+    ('pkg_domains', False, dict, '''
+The domains the package can be installed into. For a detailed explanation, see:
+https://developer.apple.com/library/archive/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html
+constructor defaults to `enable_anywhere=true` and `enable_currentUserHome=true`.
+`enable_localSystem` should not be set to true unless `default_location_pkg` is set as well.
+macOS only.
 '''),
 
     ('pkg_name', False, str, '''

constructor/main.py

@@ -172,6 +172,33 @@ def main_build(dir_path, output_dir='.', platform=cc_platform,
             )
         )
 
+    if 'pkg' in itypes:
+        if (domains := info.get('pkg_domains')) is not None:
+            domains = {key: str(val).lower() for key, val in domains.items()}
+            allowed_fields = ['enable_anywhere', 'enable_currentUserHome', 'enable_localSystem']
+            if any(key not in allowed_fields for key in domains.keys()):
+                sys.exit(
+                    'Error: unrecognized field name(s) for pkg_domains.'
+                    f' Allowed fields are {", ".join(allowed_fields)}'
+                )
+            if any(val != 'true' and val != 'false' for val in domains.values()):
+                sys.exit('Error: values for pkg_domains must be boolean.')
+            if (
+                str(domains.get('enable_localSystem', '')).lower() == 'true'
+                and not info.get('default_location_pkg')
+            ):
+                logger.warning(
+                    'enable_localSystem should not be enabled without setting'
+                    ' `default_location_pkg` to avoid installing directly '
+                    ' into the root directory.'
+                )
+            info['pkg_domains'] = domains
+        else:
+            info['pkg_domains'] = {
+                'enable_anywhere': 'true',
+                'enable_currentUserHome': 'true',
+            }
+
     info['installer_type'] = itypes[0]
     fcp_main(info, verbose=verbose, dry_run=dry_run, conda_exe=conda_exe)
     if dry_run:

constructor/osxpkg.py

@@ -276,16 +276,17 @@ def modify_xml(xml_path, info):
     # - Install on a specific disk: /<custom_root>/<name>
     # On modern Mac systems, installing in root is not allowed. So
     # we remove this option by not supplying enable_localSystem
-    # below. Alternatively, we could have chosen not to set the
+    # in the default value for pkg_domains. enable_localSystem
+    # should only be set to true if default_location_pkg is supplied
+    # in the construct.yaml file.
+    # Alternatively, we could have chosen not to set the
     # value of customLocation and we would have obtained this:
     # - Install for all users: /Applications/<name>
     # - Install for this user: /Users/<username>/Applications/<name>
     # - Install on a specific disk: /<custom_root>/<name>
     # We have chosen not to do this so that this installer
-    # produces the same results as a shell install.
-    domains = ET.Element('domains',
-                         enable_anywhere='true',
-                         enable_currentUserHome='true')
+    # can produce the same results as a shell install.
+    domains = ET.Element('domains', **info['pkg_domains'])
     root.append(domains)
     tree.write(xml_path)
 

docs/source/construct-yaml.md

@@ -540,6 +540,17 @@ to `/Library` in a "Just me" installation will give you `~/Library/<PKG_NAME>`.
 Internally, this is passed to `pkgbuild --install-location`.
 macOS only.
 
+### `pkg_domains`
+
+_required:_ no<br/>
+_type:_ dictionary<br/>
+
+The domains the package can be installed into. For a detailed explanation, see:
+https://developer.apple.com/library/archive/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html
+constructor defaults to `enable_anywhere=true` and `enable_currentUserHome=true`.
+`enable_localSystem` should not be set to true unless `default_location_pkg` is set as well.
+macOS only.
+
 ### `pkg_name`
 
 _required:_ no<br/>

news/745-customize-pkg-domains

@@ -0,0 +1,19 @@
+### Enhancements
+
+* Add `pkg_domains` setting to allow customization of the `domains` attribute in `PKG` installers. (#731 via #744)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>

tests/test_examples.py

@@ -4,6 +4,7 @@
 import sys
 import time
 import warnings
+import xml.etree.ElementTree as ET
 from datetime import timedelta
 from functools import lru_cache
 from pathlib import Path
@@ -524,6 +525,32 @@ def test_register_envs(tmp_path, request):
         assert str(install_dir) not in environments_txt
 
 
+@pytest.mark.skipif(sys.platform != 'darwin', reason='MacOS only')
+@pytest.mark.parametrize('domains', ({}, {'enable_anywhere': 'false', 'enable_localSystem': True}))
+def test_pkg_distribution_domains(tmp_path, domains):
+    recipe_path = _example_path('osxpkg')
+    input_path = tmp_path / 'input'
+    output_path = tmp_path / 'output'
+    shutil.copytree(str(recipe_path), str(input_path))
+    if domains:
+        with open(input_path / "construct.yaml", "a") as cyml:
+            cyml.write('pkg_domains:\n')
+            for key, val in domains.items():
+                cyml.write(f"  {key}: {val}\n")
+
+    installer, install_dir = next(create_installer(input_path, output_path))
+    cmd = ['pkgutil', '--expand', installer, output_path / "expanded"]
+    _execute(cmd)
+    domains_file = output_path / "expanded" / 'Distribution'
+    assert domains_file.exists()
+
+    tree = ET.parse(domains_file)
+    found = {key: val for key, val in tree.find('domains').items()}
+    defaults = {'enable_anywhere': 'true', 'enable_currentUserHome': 'true'}
+    expected = {key: str(val).lower() for key, val in domains.items()} if domains else defaults
+    assert expected == found
+
+
 @pytest.mark.skipif(sys.platform != "darwin", reason="macOS only")
 def test_cross_osx_building(tmp_path):
     input_path = _example_path("noconda")