netbox-custom-field-profiles 0.1.0__tar.gz

netbox_custom_field_profiles-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maarten Wallraf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netbox_custom_field_profiles-0.1.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: netbox-custom-field-profiles
+Version: 0.1.0
+Summary: Reusable native custom field profiles for NetBox Devices
+Author: Maarten Wallraf
+License: MIT License
+        
+        Copyright (c) 2026 Maarten Wallraf
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/mwallraf/netbox-custom-params-tab
+Project-URL: Repository, https://github.com/mwallraf/netbox-custom-params-tab
+Project-URL: Documentation, https://github.com/mwallraf/netbox-custom-params-tab/blob/HEAD/docs/README.md
+Project-URL: Installation, https://github.com/mwallraf/netbox-custom-params-tab/blob/HEAD/docs/installation.md
+Project-URL: Issues, https://github.com/mwallraf/netbox-custom-params-tab/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-django; extra == "test"
+Dynamic: license-file
+
+# NetBox Custom Field Profiles
+
+Show the custom fields that matter for each Device, without cluttering its main
+page. Custom Field Profiles groups existing NetBox custom fields into reusable
+sections on a dedicated **Custom Fields** tab.
+
+For example, a CMTS can show 20–30 service fields while a CPE shows only two,
+with shared fields appearing on both.
+
+**Your fields and values stay in NetBox.** The plugin creates no field definitions
+and has no separate value storage. **Edit Custom Fields** updates native custom field
+values using NetBox’s permissions and validation, so existing scripts and APIs
+continue to work with the same data.
+
+## Features
+
+- Manage reusable profiles under **Plugins → Custom Field Profiles**.
+- Match Devices automatically by Device Type, role and tags.
+- Choose and order specific fields, or include all applicable fields dynamically.
+- Display each matching profile as a section; edit repeated fields only once.
+- Hide fields on the normal Device page using native **UI visibility → Hidden**,
+  while keeping them available in Custom Fields. Native editability still applies.
+
+## Screenshots
+
+**Device Custom Fields:** a matching profile presents existing native field values,
+with one action to edit the relevant custom fields.
+
+![Device Custom Fields tab showing Sandbox properties and Test properties sections with the Edit Custom Fields action](https://raw.githubusercontent.com/mwallraf/netbox-custom-params-tab/v0.1.0/docs/screenshots/parameters-tab.png)
+
+<details>
+<summary><strong>Profile configuration</strong> — field selection, order and matching rules</summary>
+
+Select existing Device fields, arrange their order, and choose which Devices match.
+
+![Custom Field Profile editor showing selected fields, a Device tag rule and ordering controls](https://raw.githubusercontent.com/mwallraf/netbox-custom-params-tab/v0.1.0/docs/screenshots/profile-configuration.png)
+
+</details>
+
+## Compatibility
+
+Supports **Devices**. Tested with **NetBox 4.7.4** and NetBox Docker **5.1.1**.
+The declared minimum is NetBox 4.7.0; other versions have not been verified.
+
+## Quick installation
+
+For a standard NetBox installation under `/opt/netbox`, install directly from
+GitHub using NetBox’s normal plugin installation process:
+
+1. Add this line to `/opt/netbox/local_requirements.txt`:
+
+   ```text
+   netbox-custom-field-profiles @ git+https://github.com/mwallraf/netbox-custom-params-tab.git
+   ```
+
+2. Add the plugin to the existing `PLUGINS` list in NetBox’s `configuration.py`:
+
+   ```python
+   PLUGINS = [
+       # Your other plugins...
+       'netbox_custom_field_profiles',
+   ]
+   ```
+
+3. Run NetBox’s upgrade script to install requirements, apply migrations and
+   collect static files, then restart its services:
+
+   ```sh
+   sudo /opt/netbox/upgrade.sh
+   sudo systemctl restart netbox netbox-rq
+   ```
+
+No plugin-specific settings are required. For Docker, wheel installation and
+runtime details, see the [installation guide](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/installation.md)
+and the [NetBox plugin installation documentation](https://netboxlabs.com/docs/netbox/plugins/installation/).
+
+## Get started
+
+1. Create your fields in NetBox’s built-in **Custom Fields** administration and
+   make them applicable to Devices.
+2. Open **Plugins → Custom Field Profiles**, add a profile, select its fields,
+   and optionally set Device Type, role or tag rules. Enable it and save.
+3. Open a matching Device’s **Custom Fields** tab. Users with native Device change
+   permission can choose **Edit Custom Fields** to update editable values.
+
+Different rule types combine with **AND**; values within a rule combine with
+**OR**. A tag rule matches any selected tag. Profiles without rules apply to all
+Devices. Matching never grants additional permissions.
+
+## Documentation
+
+- [Documentation index](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/README.md) — choose the right user or maintainer guide.
+- [User guide](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/user-guide.md) — profiles, native values and reducing clutter.
+- [Installation guide](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/installation.md) — supported runtime and deployment details.
+- [Profile administration](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/administration.md) — ordering, rules and field lifecycle behavior.
+- [Troubleshooting](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/troubleshooting.md) — common UI and deployment problems.
+- [Maintainer guides](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/development/README.md) — sandbox, architecture and testing.
+- [Report an issue](https://github.com/mwallraf/netbox-custom-params-tab/issues).
+
+## Development
+
+With Docker Compose, Python 3 and Make installed:
+
+```sh
+git clone https://github.com/mwallraf/netbox-custom-params-tab.git
+cd netbox-custom-params-tab
+make setup
+```
+
+Open <http://127.0.0.1:18047>. Generated administrator credentials are in the local,
+ignored `.env` file. Run `make test` for baseline checks, `make test-profiles` for
+the native plugin suite, and `make release-check` for installed-wheel verification.
+
+## License
+
+[MIT](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/LICENSE) © 2026 [Maarten Wallraf](https://github.com/mwallraf).

netbox_custom_field_profiles-0.1.0/README.md

@@ -0,0 +1,116 @@
+# NetBox Custom Field Profiles
+
+Show the custom fields that matter for each Device, without cluttering its main
+page. Custom Field Profiles groups existing NetBox custom fields into reusable
+sections on a dedicated **Custom Fields** tab.
+
+For example, a CMTS can show 20–30 service fields while a CPE shows only two,
+with shared fields appearing on both.
+
+**Your fields and values stay in NetBox.** The plugin creates no field definitions
+and has no separate value storage. **Edit Custom Fields** updates native custom field
+values using NetBox’s permissions and validation, so existing scripts and APIs
+continue to work with the same data.
+
+## Features
+
+- Manage reusable profiles under **Plugins → Custom Field Profiles**.
+- Match Devices automatically by Device Type, role and tags.
+- Choose and order specific fields, or include all applicable fields dynamically.
+- Display each matching profile as a section; edit repeated fields only once.
+- Hide fields on the normal Device page using native **UI visibility → Hidden**,
+  while keeping them available in Custom Fields. Native editability still applies.
+
+## Screenshots
+
+**Device Custom Fields:** a matching profile presents existing native field values,
+with one action to edit the relevant custom fields.
+
+![Device Custom Fields tab showing Sandbox properties and Test properties sections with the Edit Custom Fields action](https://raw.githubusercontent.com/mwallraf/netbox-custom-params-tab/v0.1.0/docs/screenshots/parameters-tab.png)
+
+<details>
+<summary><strong>Profile configuration</strong> — field selection, order and matching rules</summary>
+
+Select existing Device fields, arrange their order, and choose which Devices match.
+
+![Custom Field Profile editor showing selected fields, a Device tag rule and ordering controls](https://raw.githubusercontent.com/mwallraf/netbox-custom-params-tab/v0.1.0/docs/screenshots/profile-configuration.png)
+
+</details>
+
+## Compatibility
+
+Supports **Devices**. Tested with **NetBox 4.7.4** and NetBox Docker **5.1.1**.
+The declared minimum is NetBox 4.7.0; other versions have not been verified.
+
+## Quick installation
+
+For a standard NetBox installation under `/opt/netbox`, install directly from
+GitHub using NetBox’s normal plugin installation process:
+
+1. Add this line to `/opt/netbox/local_requirements.txt`:
+
+   ```text
+   netbox-custom-field-profiles @ git+https://github.com/mwallraf/netbox-custom-params-tab.git
+   ```
+
+2. Add the plugin to the existing `PLUGINS` list in NetBox’s `configuration.py`:
+
+   ```python
+   PLUGINS = [
+       # Your other plugins...
+       'netbox_custom_field_profiles',
+   ]
+   ```
+
+3. Run NetBox’s upgrade script to install requirements, apply migrations and
+   collect static files, then restart its services:
+
+   ```sh
+   sudo /opt/netbox/upgrade.sh
+   sudo systemctl restart netbox netbox-rq
+   ```
+
+No plugin-specific settings are required. For Docker, wheel installation and
+runtime details, see the [installation guide](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/installation.md)
+and the [NetBox plugin installation documentation](https://netboxlabs.com/docs/netbox/plugins/installation/).
+
+## Get started
+
+1. Create your fields in NetBox’s built-in **Custom Fields** administration and
+   make them applicable to Devices.
+2. Open **Plugins → Custom Field Profiles**, add a profile, select its fields,
+   and optionally set Device Type, role or tag rules. Enable it and save.
+3. Open a matching Device’s **Custom Fields** tab. Users with native Device change
+   permission can choose **Edit Custom Fields** to update editable values.
+
+Different rule types combine with **AND**; values within a rule combine with
+**OR**. A tag rule matches any selected tag. Profiles without rules apply to all
+Devices. Matching never grants additional permissions.
+
+## Documentation
+
+- [Documentation index](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/README.md) — choose the right user or maintainer guide.
+- [User guide](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/user-guide.md) — profiles, native values and reducing clutter.
+- [Installation guide](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/installation.md) — supported runtime and deployment details.
+- [Profile administration](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/administration.md) — ordering, rules and field lifecycle behavior.
+- [Troubleshooting](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/troubleshooting.md) — common UI and deployment problems.
+- [Maintainer guides](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/docs/development/README.md) — sandbox, architecture and testing.
+- [Report an issue](https://github.com/mwallraf/netbox-custom-params-tab/issues).
+
+## Development
+
+With Docker Compose, Python 3 and Make installed:
+
+```sh
+git clone https://github.com/mwallraf/netbox-custom-params-tab.git
+cd netbox-custom-params-tab
+make setup
+```
+
+Open <http://127.0.0.1:18047>. Generated administrator credentials are in the local,
+ignored `.env` file. Run `make test` for baseline checks, `make test-profiles` for
+the native plugin suite, and `make release-check` for installed-wheel verification.
+
+## License
+
+[MIT](https://github.com/mwallraf/netbox-custom-params-tab/blob/v0.1.0/LICENSE) © 2026 [Maarten Wallraf](https://github.com/mwallraf).

netbox_custom_field_profiles-0.1.0/netbox_custom_field_profiles/__init__.py

@@ -0,0 +1,24 @@
+from netbox.plugins import PluginConfig
+from .metadata import SUMMARY
+
+
+class CustomFieldProfilesConfig(PluginConfig):
+    name = 'netbox_custom_field_profiles'
+    verbose_name = 'NetBox Custom Field Profiles'
+    version = '0.1.0'
+    author = 'Maarten Wallraf'
+    description = SUMMARY
+    min_version = '4.7.0'
+    base_url = 'custom-field-profiles'
+    menu_items = 'navigation.menu_items'
+    middleware = ['netbox_custom_field_profiles.middleware.PluginMetadataMiddleware']
+
+    def ready(self):
+        super().ready()
+        from . import signals
+        signals.register()
+        # Core Device URLs are assembled before plugin URL modules are loaded.
+        from . import views  # noqa: F401
+
+
+config = CustomFieldProfilesConfig

netbox_custom_field_profiles-0.1.0/netbox_custom_field_profiles/api/serializers.py

@@ -0,0 +1,12 @@
+from netbox.api.serializers import NetBoxModelSerializer
+from ..models import CustomFieldProfile
+
+
+class CustomFieldProfileSerializer(NetBoxModelSerializer):
+    """Native event payload; profile management has no public REST endpoint."""
+
+    class Meta:
+        model = CustomFieldProfile
+        fields = ('id', 'display', 'title', 'content_type', 'display_order', 'enabled',
+                  'field_mode', 'created', 'last_updated')
+        read_only_fields = fields

netbox_custom_field_profiles-0.1.0/netbox_custom_field_profiles/api/urls.py

@@ -0,0 +1,3 @@
+"""Keep NetBox's API discovery importable without legacy configuration routes."""
+
+urlpatterns = []

netbox_custom_field_profiles-0.1.0/netbox_custom_field_profiles/api/views.py

@@ -0,0 +1 @@
+"""No public plugin API; profiles are managed through native plugin pages."""

netbox_custom_field_profiles-0.1.0/netbox_custom_field_profiles/forms.py

@@ -0,0 +1,251 @@
+import json
+from copy import deepcopy
+
+from django import forms
+from django.db import router, transaction
+from django.contrib.contenttypes.models import ContentType
+from django.db.models import Q
+from netbox.forms import NetBoxModelForm
+from extras.choices import CustomFieldStatusChoices
+from extras.models import CustomField, Tag
+from dcim.models import Device, DeviceType, DeviceRole
+from utilities.forms.fields import DynamicModelMultipleChoiceField
+from utilities.exceptions import AbortRequest
+from .models import CustomFieldProfile, ProfileField
+from .signals import lock_profile_fields
+from .matching import get_matching_profiles, get_profile_fields
+
+
+class DeviceParametersForm(NetBoxModelForm):
+    """A partial native Device form; only current editable profile fields bind."""
+
+    class Meta:
+        model = Device
+        fields = ()
+
+    def _get_custom_fields(self, content_type):
+        fields = {}
+        for profile in get_matching_profiles(self.instance):
+            for field in get_profile_fields(profile):
+                if field.ui_editable == 'yes':
+                    fields.setdefault(field.pk, field)
+        return list(fields.values())
+
+    def __init__(self, *args, user, **kwargs):
+        from django.core import signing
+        from utilities.forms.utils import restrict_form_fields
+
+        super().__init__(*args, **kwargs)
+        self.fields.pop('tags', None)
+        restrict_form_fields(self, user)
+        # Never expose an inaccessible saved reference via widget initial data,
+        # nor silently clear it when the remaining parameters are saved.
+        for name, customfield in list(self.custom_fields.items()):
+            field = self.fields[name]
+            if hasattr(field, 'queryset'):
+                raw = self.instance.custom_field_data.get(customfield.name)
+                ids = raw if isinstance(raw, list) else ([] if raw is None else [raw])
+                if set(ids) - set(field.queryset.filter(pk__in=ids).values_list('pk', flat=True)):
+                    del self.fields[name]
+                    del self.custom_fields[name]
+        self.scope = [(field.pk, field.name, field.type, str(field.last_updated))
+                      for field in self.custom_fields.values()]
+        self.fields['_parameter_scope'] = forms.CharField(
+            widget=forms.HiddenInput,
+            initial=signing.dumps(self.scope, salt='device-parameters'),
+        )
+        editable_names = {field.name for field in self.custom_fields.values()}
+        self.untouched_values = {
+            name: deepcopy(value) for name, value in self.instance.custom_field_data.items()
+            if name not in editable_names
+        }
+
+    def _post_clean(self):
+        super()._post_clean()
+        # Native model validation prunes orphaned keys. A partial editor owns
+        # only its edit set, so retain all pre-existing data outside that set.
+        self.instance.custom_field_data.update(self.untouched_values)
+
+    def clean(self):
+        from django.core import signing
+
+        super().clean()
+        if not self.custom_fields:
+            raise forms.ValidationError('No editable custom fields are available for this device.')
+        try:
+            scope = signing.loads(self.cleaned_data.get('_parameter_scope', ''), salt='device-parameters')
+            if scope != [list(item) for item in self.scope]:
+                raise signing.BadSignature()
+        except signing.BadSignature:
+            raise forms.ValidationError('The available custom fields changed. Reload this page before saving.')
+
+
+class CustomFieldProfileForm(NetBoxModelForm):
+    rule_fields = ('device_types', 'device_roles', 'applicability_tags')
+    device_types = DynamicModelMultipleChoiceField(
+        queryset=DeviceType.objects.all(), required=False,
+        help_text='Match any selected Device Type. Empty means any type.',
+    )
+    device_roles = DynamicModelMultipleChoiceField(
+        queryset=DeviceRole.objects.all(), required=False,
+        label='Device roles', help_text='Match any selected role. Empty means any role.',
+    )
+    applicability_tags = DynamicModelMultipleChoiceField(
+        queryset=Tag.objects.none(), required=False, label='Device tags',
+        help_text='Match any selected tag. Empty means no tag restriction.',
+    )
+    selected_fields = forms.ModelMultipleChoiceField(
+        queryset=CustomField.objects.none(), required=False,
+        help_text='Choose applicable fields, then arrange their display order below.',
+    )
+    field_order = forms.CharField(required=False, widget=forms.HiddenInput)
+    remembered_fields = forms.CharField(required=False, widget=forms.HiddenInput)
+    content_type = forms.ModelChoiceField(
+        queryset=ContentType.objects.filter(app_label='dcim', model='device'),
+        label='Object Type',
+    )
+
+    class Meta:
+        model = CustomFieldProfile
+        fields = ('title', 'content_type', 'display_order', 'enabled', 'field_mode',
+                  'selected_fields', 'field_order', 'remembered_fields', 'device_types', 'device_roles',
+                  'applicability_tags')
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if (self.is_bound and self.data.get('field_mode') == CustomFieldProfile.FIELD_MODE_ALL
+                and 'remembered_fields' in self.data and 'selected_fields' not in self.data):
+            try:
+                remembered = self._parse_field_ids(self.data.get('remembered_fields'))
+            except (ValueError, TypeError):
+                pass  # clean() reports malformed remembered state without saving it.
+            else:
+                # All disables the visible selector. Rebind its explicit remembered
+                # values so native field validation/permission restrictions still
+                # apply, and a failed form redisplays the pending choices.
+                self.data = self.data.copy()
+                if hasattr(self.data, 'setlist'):
+                    self.data.setlist('selected_fields', [str(pk) for pk in remembered])
+                else:
+                    self.data['selected_fields'] = remembered
+        device_ct = self.fields['content_type'].queryset.first()
+        self.fields['applicability_tags'].queryset = Tag.objects.filter(
+            Q(object_types=device_ct) | Q(object_types__isnull=True)).distinct()
+        self.fields['applicability_tags'].query_params = {'for_object_type_id': device_ct.pk}
+        self.fields['selected_fields'].queryset = CustomField.objects.filter(
+            object_types__app_label='dcim', object_types__model='device',
+        ).exclude(status=CustomFieldStatusChoices.STATUS_DELETING).distinct()
+        self.fields['selected_fields'].widget.attrs['class'] = 'form-select'
+        ordered = []
+        if not self.instance.pk:
+            self.initial.setdefault('content_type', self.fields['content_type'].queryset.first())
+            self.initial.setdefault('field_mode', CustomFieldProfile.FIELD_MODE_ALL)
+        else:
+            ordered = list(self.instance.profile_fields.values_list('field_id', flat=True))
+        self.initial.setdefault('selected_fields', ordered)
+        self.initial.setdefault('field_order', json.dumps(ordered))
+        self.initial.setdefault('remembered_fields', json.dumps(ordered))
+
+    @staticmethod
+    def _parse_field_ids(raw):
+        ids = json.loads(raw)
+        if (not isinstance(ids, list) or any(type(pk) is not int or pk <= 0 for pk in ids)
+                or len(ids) != len(set(ids))):
+            raise ValueError
+        return ids
+
+    def full_clean(self):
+        # Dynamic fields narrow their queryset to bound values when constructing
+        # BoundFields. Capture native permission restrictions before that happens.
+        self.rule_authority = {name: self.fields[name].queryset.all() for name in self.rule_fields}
+        super().full_clean()
+
+    def clean(self):
+        super().clean()
+        cleaned = self.cleaned_data
+        if self.instance.pk:
+            for name in self.rule_fields:
+                # Native views restrict these querysets by the editor's authority.
+                # A hidden/inaccessible saved reference must not become an empty rule.
+                existing = getattr(self.instance, name).values_list('pk', flat=True)
+                if set(existing) - set(self.rule_authority[name].values_list('pk', flat=True)):
+                    self.add_error(name, 'This profile has saved references you cannot access. '
+                                         'Ask an administrator to review its applicability.')
+        self.ordered_field_ids = None
+        selected_mode = cleaned.get('field_mode') == CustomFieldProfile.FIELD_MODE_SELECTED
+        if not selected_mode and 'remembered_fields' not in self.data:
+            # Clients without an explicit remembered payload preserve saved state.
+            return cleaned
+        selected = cleaned.get('selected_fields')
+        if selected is None:
+            return cleaned
+        if selected_mode and not selected:
+            self.add_error('selected_fields', 'Select at least one applicable field.')
+        selected_ids = {field.pk for field in selected}
+        if 'remembered_fields' in self.data:
+            try:
+                remembered = self._parse_field_ids(cleaned.get('remembered_fields'))
+                if set(remembered) != selected_ids:
+                    raise ValueError
+            except (ValueError, TypeError):
+                self.add_error('remembered_fields', 'Remembered fields must contain each selected field exactly once. '
+                                                  'Review the selection and try again.')
+        raw_selection = (self.data.getlist('selected_fields') if hasattr(self.data, 'getlist')
+                         else self.data.get('selected_fields', []))
+        if len(raw_selection) != len(set(raw_selection)):
+            self.add_error('selected_fields', 'Select each field only once.')
+        try:
+            ordered = self._parse_field_ids(cleaned.get('field_order') or '[]')
+            if set(ordered) != selected_ids:
+                raise ValueError
+        except (ValueError, TypeError):
+            self.add_error('field_order', 'Field order must contain each selected field exactly once.')
+        else:
+            self.ordered_field_ids = ordered
+        return cleaned
+
+    @property
+    def applies_to_all_devices(self):
+        if self.is_bound:
+            return not any(self.data.get(name) for name in self.rule_fields)
+        return not any(self.initial.get(name) for name in self.rule_fields)
+
+    def _guard_save(self, using):
+        # Split saves must keep these locks through model.save() and save_m2m().
+        # The normal native edit view already supplies that transaction.
+        if not transaction.get_connection(using).in_atomic_block:
+            raise AbortRequest('Save the profile and its field selection in one transaction.')
+        field_ids = self.ordered_field_ids
+        if field_ids is not None:
+            lock_profile_fields(field_ids, using)
+        if self.instance.pk:
+            CustomFieldProfile.objects.using(using).select_for_update().get(pk=self.instance.pk)
+        if field_ids is not None:
+            applicable_ids = set(CustomField.objects.using(using).filter(
+                pk__in=field_ids, object_types__app_label='dcim', object_types__model='device',
+            ).exclude(status=CustomFieldStatusChoices.STATUS_DELETING).values_list('pk', flat=True))
+            if set(field_ids) != applicable_ids:
+                raise AbortRequest('The selected custom fields changed while this form was open. '
+                                   'Review the field selection and try again.')
+
+    def _save_m2m(self):
+        using = router.db_for_write(type(self.instance), instance=self.instance)
+        self._guard_save(using)
+        super()._save_m2m()
+        if self.ordered_field_ids is not None:
+            self.instance.profile_fields.all().delete()
+            ProfileField.objects.bulk_create([
+                ProfileField(profile=self.instance, field_id=pk, position=position)
+                for position, pk in enumerate(self.ordered_field_ids)
+            ])
+        self.instance.__dict__.pop('_profile_form_save_guard', None)
+
+    def save(self, commit=True):
+        # Guard before the model UPDATE too: waiting until save_m2m() would
+        # acquire the profile lock before native field locks and invert cleanup.
+        self.instance._profile_form_save_guard = self._guard_save
+        if not commit:
+            return super().save(commit=False)
+        using = router.db_for_write(type(self.instance), instance=self.instance)
+        with transaction.atomic(using=using):
+            return super().save(commit=True)

netbox_custom_field_profiles-0.1.0/netbox_custom_field_profiles/matching.py

@@ -0,0 +1,56 @@
+"""Read-only native field resolution and reusable Device profile matching."""
+from dcim.models import Device
+from extras.choices import CustomFieldStatusChoices
+from extras.models import CustomField
+
+from .models import CustomFieldProfile
+
+
+def get_matching_profiles(device):
+    """AND between configured criteria, OR within each, in profile order."""
+    if not isinstance(device, Device):
+        return []
+    candidates = CustomFieldProfile.objects.filter(
+        enabled=True, content_type__app_label='dcim', content_type__model='device',
+    ).prefetch_related('device_types', 'device_roles', 'applicability_tags')
+    device_tags = set(device.tags.values_list('pk', flat=True))
+    result = []
+    for profile in candidates:
+        types = {item.pk for item in profile.device_types.all()}
+        roles = {item.pk for item in profile.device_roles.all()}
+        tags = {item.pk for item in profile.applicability_tags.all()}
+        if ((not types or device.device_type_id in types)
+                and (not roles or device.role_id in roles)
+                and (not tags or tags.intersection(device_tags))):
+            result.append(profile)
+    return result
+
+
+def get_profile_filter_summary(profile):
+    """Return plain text for native escaping by tables/templates."""
+    criteria = []
+    for label, name in (('Device Type', 'device_types'), ('Role', 'device_roles'),
+                        ('Tag', 'applicability_tags')):
+        values = [str(item) for item in getattr(profile, name).all()]
+        if values:
+            criteria.append(f'{label}: (' + ' OR '.join(values) + ')')
+    return ' AND '.join(criteria) or 'Applies to all Devices'
+
+
+def get_profile_fields(profile):
+    """Resolve current active native fields without writing native definitions."""
+    if (profile.content_type.app_label, profile.content_type.model) != ('dcim', 'device'):
+        return []
+    # Native resolution owns ordering, while a fresh applicability/status guard
+    # excludes stale cached entries even after direct through-table/status writes.
+    database = profile._state.db or 'default'
+    live_ids = set(CustomField.objects.using(database).filter(
+        object_types__app_label='dcim', object_types__model='device',
+        status=CustomFieldStatusChoices.STATUS_ACTIVE,
+    ).values_list('pk', flat=True))
+    native = [field for field in CustomField.objects.db_manager(database).get_for_model(Device)
+              if field.pk in live_ids]
+    if profile.field_mode == CustomFieldProfile.FIELD_MODE_ALL:
+        return native
+    active = {field.pk: field for field in native}
+    return [active[entry.field_id] for entry in profile.profile_fields.all() if entry.field_id in active]