netbox-map 0.1.0__py3-none-any.whl

netbox_map/forms.py

@@ -0,0 +1,449 @@
+from django import forms
+from django.contrib.contenttypes.models import ContentType
+from django.utils.translation import gettext_lazy as _
+
+from dcim.models import Site, Location, Rack, Device, PowerPanel, PowerFeed
+from netbox.forms import NetBoxModelForm, NetBoxModelFilterSetForm, NetBoxModelBulkEditForm
+from utilities.forms.fields import (
+    ContentTypeChoiceField,
+    DynamicModelChoiceField,
+    CommentField,
+)
+from utilities.forms.rendering import FieldSet
+from .models import FloorPlan, FloorPlanTile, MapMarker, MapSettings, ASSIGNABLE_MODELS
+from .choices import FloorPlanTileTypeChoices, FloorPlanTileStatusChoices
+
+
+def get_assignable_content_types():
+    """Return a queryset of ContentTypes for assignable models."""
+    return ContentType.objects.filter(
+        app_label='dcim',
+        model__in=['device', 'rack', 'powerpanel', 'powerfeed'],
+    ).order_by('model')
+
+
+#
+# FloorPlan forms
+#
+
+class FloorPlanForm(NetBoxModelForm):
+    site = DynamicModelChoiceField(
+        label=_('Site'),
+        queryset=Site.objects.all(),
+    )
+    location = DynamicModelChoiceField(
+        label=_('Location'),
+        queryset=Location.objects.all(),
+        required=False,
+        query_params={
+            'site_id': '$site'
+        }
+    )
+    comments = CommentField()
+
+    fieldsets = (
+        FieldSet(
+            'site', 'location', 'name', 'description', 'tags',
+            name=_('Floor Plan')
+        ),
+        FieldSet(
+            'grid_width', 'grid_height', 'tile_size',
+            name=_('Grid Configuration')
+        ),
+        FieldSet(
+            'background_image',
+            name=_('Background')
+        ),
+    )
+
+    class Meta:
+        model = FloorPlan
+        fields = [
+            'site', 'location', 'name', 'grid_width', 'grid_height',
+            'tile_size', 'background_image', 'description', 'comments', 'tags',
+        ]
+
+
+class FloorPlanFilterForm(NetBoxModelFilterSetForm):
+    model = FloorPlan
+    site_id = DynamicModelChoiceField(
+        queryset=Site.objects.all(),
+        required=False,
+        label=_('Site')
+    )
+    location_id = DynamicModelChoiceField(
+        queryset=Location.objects.all(),
+        required=False,
+        label=_('Location'),
+        query_params={
+            'site_id': '$site_id'
+        }
+    )
+
+    fieldsets = (
+        FieldSet('site_id', 'location_id'),
+    )
+
+
+class FloorPlanBulkEditForm(NetBoxModelBulkEditForm):
+    grid_width = forms.IntegerField(required=False)
+    grid_height = forms.IntegerField(required=False)
+    tile_size = forms.IntegerField(required=False)
+    description = forms.CharField(max_length=200, required=False)
+
+    model = FloorPlan
+    nullable_fields = ('location', 'description', 'background_image')
+
+
+#
+# FloorPlanTile forms
+#
+
+class FloorPlanTileForm(NetBoxModelForm):
+    floorplan = DynamicModelChoiceField(
+        label=_('Floor Plan'),
+        queryset=FloorPlan.objects.all()
+    )
+    assigned_object_type = ContentTypeChoiceField(
+        label=_('Object Type'),
+        queryset=get_assignable_content_types(),
+        required=False,
+        help_text=_('Select the type of object to assign (Rack, Device, etc.)')
+    )
+    rack = DynamicModelChoiceField(
+        label=_('Rack'),
+        queryset=Rack.objects.all(),
+        required=False,
+        query_params={
+            'site_id': '$floorplan',
+        }
+    )
+    device = DynamicModelChoiceField(
+        label=_('Device'),
+        queryset=Device.objects.all(),
+        required=False,
+        query_params={
+            'site_id': '$floorplan',
+        }
+    )
+    powerpanel = DynamicModelChoiceField(
+        label=_('Power Panel'),
+        queryset=PowerPanel.objects.all(),
+        required=False,
+        query_params={
+            'site_id': '$floorplan',
+        }
+    )
+    powerfeed = DynamicModelChoiceField(
+        label=_('Power Feed'),
+        queryset=PowerFeed.objects.all(),
+        required=False,
+    )
+
+    fieldsets = (
+        FieldSet(
+            'floorplan', 'x_position', 'y_position', 'width', 'height',
+            'orientation', 'tags',
+            name=_('Position')
+        ),
+        FieldSet(
+            'tile_type', 'status', 'label',
+            name=_('Tile')
+        ),
+        FieldSet(
+            'fov_direction', 'fov_angle', 'fov_distance',
+            name=_('Camera FOV Settings')
+        ),
+        FieldSet(
+            'assigned_object_type', 'rack', 'device', 'powerpanel', 'powerfeed',
+            name=_('Assigned Object')
+        ),
+    )
+
+    class Meta:
+        model = FloorPlanTile
+        fields = [
+            'floorplan', 'x_position', 'y_position', 'width', 'height',
+            'label', 'tile_type', 'status', 'orientation',
+            'fov_direction', 'fov_angle', 'fov_distance',
+            'assigned_object_type', 'tags',
+        ]
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # Pre-populate the object selector if editing an existing tile
+        if self.instance.pk and self.instance.assigned_object_type:
+            model_name = self.instance.assigned_object_type.model
+            if model_name in ('rack', 'device', 'powerpanel', 'powerfeed'):
+                field = self.fields.get(model_name)
+                if field and self.instance.assigned_object_id:
+                    field.initial = self.instance.assigned_object_id
+
+    def clean(self):
+        super().clean()
+
+        assigned_object_type = self.cleaned_data.get('assigned_object_type')
+
+        if assigned_object_type:
+            model_name = assigned_object_type.model
+            obj = self.cleaned_data.get(model_name)
+            if obj:
+                self.cleaned_data['assigned_object_id'] = obj.pk
+            else:
+                self.cleaned_data['assigned_object_id'] = None
+                self.cleaned_data['assigned_object_type'] = None
+        else:
+            self.cleaned_data['assigned_object_type'] = None
+            self.cleaned_data['assigned_object_id'] = None
+
+        return self.cleaned_data
+
+    def save(self, *args, **kwargs):
+        # Set the assigned_object_id from the cleaned data
+        self.instance.assigned_object_type = self.cleaned_data.get('assigned_object_type')
+        self.instance.assigned_object_id = self.cleaned_data.get('assigned_object_id')
+        return super().save(*args, **kwargs)
+
+
+class FloorPlanTileFilterForm(NetBoxModelFilterSetForm):
+    model = FloorPlanTile
+    floorplan_id = DynamicModelChoiceField(
+        queryset=FloorPlan.objects.all(),
+        required=False,
+        label=_('Floor Plan')
+    )
+    assigned_object_type = ContentTypeChoiceField(
+        queryset=get_assignable_content_types(),
+        required=False,
+        label=_('Object Type')
+    )
+    tile_type = forms.MultipleChoiceField(
+        choices=FloorPlanTileTypeChoices,
+        required=False,
+        label=_('Tile Type')
+    )
+    status = forms.MultipleChoiceField(
+        choices=FloorPlanTileStatusChoices,
+        required=False,
+        label=_('Status')
+    )
+
+    fieldsets = (
+        FieldSet('floorplan_id', 'assigned_object_type', 'tile_type', 'status'),
+    )
+
+
+#
+# MapMarker forms
+#
+
+class MapMarkerForm(NetBoxModelForm):
+    site = DynamicModelChoiceField(
+        label=_('Site'),
+        queryset=Site.objects.all(),
+        required=False,
+    )
+    assigned_object_type = ContentTypeChoiceField(
+        label=_('Object Type'),
+        queryset=get_assignable_content_types(),
+        required=False,
+        help_text=_('Select the type of object to assign')
+    )
+    rack = DynamicModelChoiceField(
+        label=_('Rack'),
+        queryset=Rack.objects.all(),
+        required=False,
+        query_params={'site_id': '$site'},
+    )
+    device = DynamicModelChoiceField(
+        label=_('Device'),
+        queryset=Device.objects.all(),
+        required=False,
+        query_params={'site_id': '$site'},
+    )
+    powerpanel = DynamicModelChoiceField(
+        label=_('Power Panel'),
+        queryset=PowerPanel.objects.all(),
+        required=False,
+        query_params={'site_id': '$site'},
+    )
+    powerfeed = DynamicModelChoiceField(
+        label=_('Power Feed'),
+        queryset=PowerFeed.objects.all(),
+        required=False,
+    )
+
+    fieldsets = (
+        FieldSet(
+            'latitude', 'longitude', 'label', 'marker_type', 'status', 'site', 'description', 'tags',
+            name=_('Map Marker')
+        ),
+        FieldSet(
+            'fov_direction', 'fov_angle', 'fov_distance',
+            name=_('Camera FOV Settings')
+        ),
+        FieldSet(
+            'assigned_object_type', 'rack', 'device', 'powerpanel', 'powerfeed',
+            name=_('Assigned Object')
+        ),
+    )
+
+    class Meta:
+        model = MapMarker
+        fields = [
+            'latitude', 'longitude', 'label', 'marker_type', 'status', 'site',
+            'fov_direction', 'fov_angle', 'fov_distance',
+            'assigned_object_type', 'description', 'tags',
+        ]
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.instance.pk and self.instance.assigned_object_type:
+            model_name = self.instance.assigned_object_type.model
+            if model_name in ('rack', 'device', 'powerpanel', 'powerfeed'):
+                field = self.fields.get(model_name)
+                if field and self.instance.assigned_object_id:
+                    field.initial = self.instance.assigned_object_id
+
+    def clean(self):
+        super().clean()
+        assigned_object_type = self.cleaned_data.get('assigned_object_type')
+        if assigned_object_type:
+            model_name = assigned_object_type.model
+            obj = self.cleaned_data.get(model_name)
+            if obj:
+                self.instance.assigned_object_id = obj.pk
+            else:
+                self.instance.assigned_object_id = None
+                self.cleaned_data['assigned_object_type'] = None
+        else:
+            self.cleaned_data['assigned_object_type'] = None
+            self.instance.assigned_object_id = None
+        return self.cleaned_data
+
+    def save(self, *args, **kwargs):
+        self.instance.assigned_object_type = self.cleaned_data.get('assigned_object_type')
+        return super().save(*args, **kwargs)
+
+
+#
+# MapSettings form
+#
+
+DEVICE_FIELD_CHOICES = [
+    ('status', _('Status')),
+    ('role', _('Role')),
+    ('device_type', _('Device Type')),
+    ('platform', _('Platform')),
+    ('serial', _('Serial')),
+    ('asset_tag', _('Asset Tag')),
+    ('tenant', _('Tenant')),
+    ('site', _('Site')),
+    ('location', _('Location')),
+    ('rack', _('Rack')),
+    ('position', _('Position')),
+    ('face', _('Face')),
+    ('airflow', _('Airflow')),
+    ('primary_ip4', _('Primary IPv4')),
+    ('primary_ip6', _('Primary IPv6')),
+    ('oob_ip', _('OOB IP')),
+    ('cluster', _('Cluster')),
+    ('virtual_chassis', _('Virtual Chassis')),
+    ('vc_position', _('VC Position')),
+    ('description', _('Description')),
+]
+
+RACK_FIELD_CHOICES = [
+    ('status', _('Status')),
+    ('role', _('Role')),
+    ('facility_id', _('Facility ID')),
+    ('serial', _('Serial')),
+    ('asset_tag', _('Asset Tag')),
+    ('u_height', _('U Height')),
+    ('width', _('Width')),
+    ('type', _('Type')),
+    ('weight', _('Weight')),
+    ('max_weight', _('Max Weight')),
+    ('tenant', _('Tenant')),
+    ('site', _('Site')),
+    ('location', _('Location')),
+    ('description', _('Description')),
+]
+
+POWERPANEL_FIELD_CHOICES = [
+    ('site', _('Site')),
+    ('location', _('Location')),
+    ('description', _('Description')),
+]
+
+POWERFEED_FIELD_CHOICES = [
+    ('status', _('Status')),
+    ('type', _('Type')),
+    ('supply', _('Supply')),
+    ('voltage', _('Voltage')),
+    ('amperage', _('Amperage')),
+    ('max_utilization', _('Max Utilization')),
+    ('power_panel', _('Power Panel')),
+    ('rack', _('Rack')),
+    ('description', _('Description')),
+]
+
+
+class MapSettingsForm(forms.ModelForm):
+    """Form for editing map detail panel settings."""
+
+    device_fields = forms.MultipleChoiceField(
+        choices=DEVICE_FIELD_CHOICES,
+        widget=forms.CheckboxSelectMultiple,
+        required=False,
+        label=_('Device Fields'),
+    )
+    rack_fields = forms.MultipleChoiceField(
+        choices=RACK_FIELD_CHOICES,
+        widget=forms.CheckboxSelectMultiple,
+        required=False,
+        label=_('Rack Fields'),
+    )
+    powerpanel_fields = forms.MultipleChoiceField(
+        choices=POWERPANEL_FIELD_CHOICES,
+        widget=forms.CheckboxSelectMultiple,
+        required=False,
+        label=_('Power Panel Fields'),
+    )
+    powerfeed_fields = forms.MultipleChoiceField(
+        choices=POWERFEED_FIELD_CHOICES,
+        widget=forms.CheckboxSelectMultiple,
+        required=False,
+        label=_('Power Feed Fields'),
+    )
+
+    class Meta:
+        model = MapSettings
+        fields = (
+            'show_mac', 'show_custom_fields', 'sync_device_gps',
+            'device_fields', 'rack_fields', 'powerpanel_fields', 'powerfeed_fields',
+        )
+
+
+class MapMarkerFilterForm(NetBoxModelFilterSetForm):
+    model = MapMarker
+    site_id = DynamicModelChoiceField(
+        queryset=Site.objects.all(),
+        required=False,
+        label=_('Site')
+    )
+    marker_type = forms.MultipleChoiceField(
+        choices=FloorPlanTileTypeChoices,
+        required=False,
+        label=_('Marker Type')
+    )
+    status = forms.MultipleChoiceField(
+        choices=FloorPlanTileStatusChoices,
+        required=False,
+        label=_('Status')
+    )
+
+    fieldsets = (
+        FieldSet('site_id', 'marker_type', 'status'),
+    )

netbox_map/migrations/0001_initial.py

@@ -0,0 +1,133 @@
+import django.core.validators
+import django.db.models.deletion
+import netbox.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+        ('dcim', '0225_gfk_indexes'),
+        ('extras', '0134_owner'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='FloorPlan',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('name', models.CharField(max_length=200, verbose_name='name')),
+                ('grid_width', models.PositiveIntegerField(
+                    default=20,
+                    help_text='Width of the grid in tiles',
+                    validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(1000)],
+                    verbose_name='grid width',
+                )),
+                ('grid_height', models.PositiveIntegerField(
+                    default=20,
+                    help_text='Height of the grid in tiles',
+                    validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(1000)],
+                    verbose_name='grid height',
+                )),
+                ('tile_size', models.PositiveIntegerField(
+                    default=60,
+                    help_text='Size of each tile in pixels for rendering',
+                    validators=[django.core.validators.MinValueValidator(5), django.core.validators.MaxValueValidator(200)],
+                    verbose_name='tile size',
+                )),
+                ('background_image', models.ImageField(blank=True, null=True, upload_to='floorplan-backgrounds/', verbose_name='background image')),
+                ('description', models.CharField(blank=True, max_length=200, verbose_name='description')),
+                ('comments', models.TextField(blank=True, verbose_name='comments')),
+                ('location', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='floorplans', to='dcim.location')),
+                ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='floorplans', to='dcim.site')),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'verbose_name': 'floor plan',
+                'verbose_name_plural': 'floor plans',
+                'ordering': ('site', 'name'),
+            },
+            bases=(netbox.models.deletion.DeleteMixin, models.Model),
+        ),
+        migrations.CreateModel(
+            name='FloorPlanTile',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('x_position', models.PositiveIntegerField(help_text='X coordinate on the grid (0-indexed)', verbose_name='X position')),
+                ('y_position', models.PositiveIntegerField(help_text='Y coordinate on the grid (0-indexed)', verbose_name='Y position')),
+                ('width', models.PositiveIntegerField(
+                    default=1,
+                    help_text='Width in grid cells',
+                    validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(10)],
+                    verbose_name='width',
+                )),
+                ('height', models.PositiveIntegerField(
+                    default=1,
+                    help_text='Height in grid cells',
+                    validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(10)],
+                    verbose_name='height',
+                )),
+                ('assigned_object_type', models.ForeignKey(
+                    blank=True, null=True,
+                    on_delete=django.db.models.deletion.SET_NULL,
+                    related_name='+',
+                    to='contenttypes.contenttype',
+                    help_text='Type of assigned object',
+                )),
+                ('assigned_object_id', models.PositiveBigIntegerField(blank=True, null=True, help_text='ID of assigned object')),
+                ('label', models.CharField(blank=True, max_length=100, help_text='Custom label (overrides assigned object name)', verbose_name='label')),
+                ('tile_type', models.CharField(default='rack', max_length=50, verbose_name='tile type')),
+                ('status', models.CharField(default='active', max_length=50, verbose_name='status')),
+                ('orientation', models.PositiveSmallIntegerField(default=0, help_text='Rotation in degrees (0, 90, 180, 270)', verbose_name='orientation')),
+                ('fov_direction', models.PositiveSmallIntegerField(
+                    default=0,
+                    help_text='Camera viewing direction in degrees (0=north, 90=east, 180=south, 270=west)',
+                    validators=[django.core.validators.MinValueValidator(0), django.core.validators.MaxValueValidator(360)],
+                    verbose_name='FOV direction',
+                )),
+                ('fov_angle', models.PositiveSmallIntegerField(
+                    default=90,
+                    help_text='Camera field of view width in degrees',
+                    validators=[django.core.validators.MinValueValidator(10), django.core.validators.MaxValueValidator(360)],
+                    verbose_name='FOV angle',
+                )),
+                ('fov_distance', models.PositiveSmallIntegerField(
+                    default=5,
+                    help_text='Camera view distance in grid cells',
+                    validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(50)],
+                    verbose_name='FOV distance',
+                )),
+                ('floorplan', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='tiles', to='netbox_map.floorplan')),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'verbose_name': 'floor plan tile',
+                'verbose_name_plural': 'floor plan tiles',
+                'ordering': ('floorplan', 'y_position', 'x_position'),
+            },
+            bases=(netbox.models.deletion.DeleteMixin, models.Model),
+        ),
+        migrations.AddConstraint(
+            model_name='floorplan',
+            constraint=models.UniqueConstraint(fields=('site', 'name'), name='netbox_map_floorplan_unique_site_name'),
+        ),
+        migrations.AddConstraint(
+            model_name='floorplantile',
+            constraint=models.UniqueConstraint(fields=('floorplan', 'x_position', 'y_position'), name='netbox_map_floorplantile_unique_position'),
+        ),
+        migrations.AddIndex(
+            model_name='floorplantile',
+            index=models.Index(fields=['assigned_object_type', 'assigned_object_id'], name='netbox_map_assigne_idx'),
+        ),
+    ]

netbox_map/migrations/0002_rename_netbox_map_assigne_idx_netbox_map__assigne_eb5b30_idx.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.11 on 2026-02-21 16:38
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('netbox_map', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RenameIndex(
+            model_name='floorplantile',
+            new_name='netbox_map__assigne_eb5b30_idx',
+            old_name='netbox_map_assigne_idx',
+        ),
+    ]

netbox_map/migrations/0003_floorplantile_latitude_longitude_locationcoordinates.py

@@ -0,0 +1,76 @@
+import django.db.models.deletion
+import netbox.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('dcim', '0225_gfk_indexes'),
+        ('extras', '0134_owner'),
+        ('netbox_map', '0002_rename_netbox_map_assigne_idx_netbox_map__assigne_eb5b30_idx'),
+    ]
+
+    operations = [
+        # Add optional lat/lng to FloorPlanTile for global map placement
+        migrations.AddField(
+            model_name='floorplantile',
+            name='latitude',
+            field=models.DecimalField(
+                blank=True,
+                decimal_places=6,
+                help_text='Latitude for global map placement (-90 to 90)',
+                max_digits=8,
+                null=True,
+                verbose_name='latitude',
+            ),
+        ),
+        migrations.AddField(
+            model_name='floorplantile',
+            name='longitude',
+            field=models.DecimalField(
+                blank=True,
+                decimal_places=6,
+                help_text='Longitude for global map placement (-180 to 180)',
+                max_digits=9,
+                null=True,
+                verbose_name='longitude',
+            ),
+        ),
+        # New LocationCoordinates model
+        migrations.CreateModel(
+            name='LocationCoordinates',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+                ('created', models.DateTimeField(auto_now_add=True, null=True)),
+                ('last_updated', models.DateTimeField(auto_now=True, null=True)),
+                ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=utilities.json.CustomFieldJSONEncoder)),
+                ('latitude', models.DecimalField(
+                    decimal_places=6,
+                    help_text='Latitude (-90 to 90)',
+                    max_digits=8,
+                    verbose_name='latitude',
+                )),
+                ('longitude', models.DecimalField(
+                    decimal_places=6,
+                    help_text='Longitude (-180 to 180)',
+                    max_digits=9,
+                    verbose_name='longitude',
+                )),
+                ('location', models.OneToOneField(
+                    on_delete=django.db.models.deletion.CASCADE,
+                    related_name='coordinates',
+                    to='dcim.location',
+                )),
+                ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')),
+            ],
+            options={
+                'verbose_name': 'location coordinates',
+                'verbose_name_plural': 'location coordinates',
+                'ordering': ('location',),
+            },
+            bases=(netbox.models.deletion.DeleteMixin, models.Model),
+        ),
+    ]