forms.py 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. from netaddr import IPNetwork
  2. from django import forms
  3. from django.db.models import Count
  4. from dcim.models import Site, Device, Interface
  5. from utilities.forms import (
  6. BootstrapMixin, ConfirmationForm, APISelect, Livesearch, CSVDataField, BulkImportForm, SlugField,
  7. )
  8. from .models import (
  9. Aggregate, IPAddress, Prefix, PREFIX_STATUS_CHOICES, RIR, Role, VLAN, VLAN_STATUS_CHOICES, VRF,
  10. )
  11. #
  12. # VRFs
  13. #
  14. class VRFForm(forms.ModelForm, BootstrapMixin):
  15. class Meta:
  16. model = VRF
  17. fields = ['name', 'rd', 'description']
  18. labels = {
  19. 'rd': "RD",
  20. }
  21. help_texts = {
  22. 'rd': "Route distinguisher in any format",
  23. }
  24. class VRFFromCSVForm(forms.ModelForm):
  25. class Meta:
  26. model = VRF
  27. fields = ['name', 'rd', 'description']
  28. class VRFImportForm(BulkImportForm, BootstrapMixin):
  29. csv = CSVDataField(csv_form=VRFFromCSVForm)
  30. class VRFBulkEditForm(forms.Form, BootstrapMixin):
  31. pk = forms.ModelMultipleChoiceField(queryset=VRF.objects.all(), widget=forms.MultipleHiddenInput)
  32. description = forms.CharField(max_length=100, required=False)
  33. class VRFBulkDeleteForm(ConfirmationForm):
  34. pk = forms.ModelMultipleChoiceField(queryset=VRF.objects.all(), widget=forms.MultipleHiddenInput)
  35. #
  36. # RIRs
  37. #
  38. class RIRForm(forms.ModelForm, BootstrapMixin):
  39. slug = SlugField()
  40. class Meta:
  41. model = RIR
  42. fields = ['name', 'slug']
  43. class RIRBulkDeleteForm(ConfirmationForm):
  44. pk = forms.ModelMultipleChoiceField(queryset=RIR.objects.all(), widget=forms.MultipleHiddenInput)
  45. #
  46. # Aggregates
  47. #
  48. class AggregateForm(forms.ModelForm, BootstrapMixin):
  49. class Meta:
  50. model = Aggregate
  51. fields = ['prefix', 'rir', 'date_added', 'description']
  52. help_texts = {
  53. 'prefix': "IPv4 or IPv6 network",
  54. 'rir': "Regional Internet Registry responsible for this prefix",
  55. 'date_added': "Format: YYYY-MM-DD",
  56. }
  57. class AggregateFromCSVForm(forms.ModelForm):
  58. rir = forms.ModelChoiceField(queryset=RIR.objects.all(), to_field_name='name',
  59. error_messages={'invalid_choice': 'RIR not found.'})
  60. class Meta:
  61. model = Aggregate
  62. fields = ['prefix', 'rir', 'date_added', 'description']
  63. class AggregateImportForm(BulkImportForm, BootstrapMixin):
  64. csv = CSVDataField(csv_form=AggregateFromCSVForm)
  65. class AggregateBulkEditForm(forms.Form, BootstrapMixin):
  66. pk = forms.ModelMultipleChoiceField(queryset=Aggregate.objects.all(), widget=forms.MultipleHiddenInput)
  67. rir = forms.ModelChoiceField(queryset=RIR.objects.all(), required=False, label='RIR')
  68. date_added = forms.DateField(required=False)
  69. description = forms.CharField(max_length=50, required=False)
  70. class AggregateBulkDeleteForm(ConfirmationForm):
  71. pk = forms.ModelMultipleChoiceField(queryset=Aggregate.objects.all(), widget=forms.MultipleHiddenInput)
  72. def aggregate_rir_choices():
  73. rir_choices = RIR.objects.annotate(aggregate_count=Count('aggregates'))
  74. return [(r.slug, '{} ({})'.format(r.name, r.aggregate_count)) for r in rir_choices]
  75. class AggregateFilterForm(forms.Form, BootstrapMixin):
  76. rir = forms.MultipleChoiceField(required=False, choices=aggregate_rir_choices, label='RIR',
  77. widget=forms.SelectMultiple(attrs={'size': 8}))
  78. #
  79. # Roles
  80. #
  81. class RoleForm(forms.ModelForm, BootstrapMixin):
  82. slug = SlugField()
  83. class Meta:
  84. model = Role
  85. fields = ['name', 'slug']
  86. class RoleBulkDeleteForm(ConfirmationForm):
  87. pk = forms.ModelMultipleChoiceField(queryset=Role.objects.all(), widget=forms.MultipleHiddenInput)
  88. #
  89. # Prefixes
  90. #
  91. class PrefixForm(forms.ModelForm, BootstrapMixin):
  92. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, label='Site',
  93. widget=forms.Select(attrs={'filter-for': 'vlan'}))
  94. vlan = forms.ModelChoiceField(queryset=VLAN.objects.all(), required=False, label='VLAN',
  95. widget=APISelect(api_url='/api/ipam/vlans/?site_id={{site}}'))
  96. class Meta:
  97. model = Prefix
  98. fields = ['prefix', 'vrf', 'site', 'vlan', 'status', 'role', 'description']
  99. help_texts = {
  100. 'prefix': "IPv4 or IPv6 network",
  101. 'vrf': "VRF (if applicable)",
  102. 'site': "The site to which this prefix is assigned (if applicable)",
  103. 'vlan': "The VLAN to which this prefix is assigned (if applicable)",
  104. 'status': "Operational status of this prefix",
  105. 'role': "The primary function of this prefix",
  106. }
  107. def __init__(self, *args, **kwargs):
  108. super(PrefixForm, self).__init__(*args, **kwargs)
  109. self.fields['vrf'].empty_label = 'Global'
  110. # Initialize field without choices to avoid pulling all VLANs from the database
  111. if self.is_bound and self.data.get('site'):
  112. self.fields['vlan'].queryset = VLAN.objects.filter(site__pk=self.data['site'])
  113. elif self.initial.get('site'):
  114. self.fields['vlan'].queryset = VLAN.objects.filter(site=self.initial['site'])
  115. else:
  116. self.fields['vlan'].choices = []
  117. def clean_prefix(self):
  118. data = self.cleaned_data['prefix']
  119. try:
  120. prefix = IPNetwork(data)
  121. except:
  122. raise
  123. if prefix.version == 4 and prefix.prefixlen == 32:
  124. raise forms.ValidationError("Cannot create host addresses (/32) as prefixes. These should be IPv4 "
  125. "addresses instead.")
  126. elif prefix.version == 6 and prefix.prefixlen == 128:
  127. raise forms.ValidationError("Cannot create host addresses (/128) as prefixes. These should be IPv6 "
  128. "addresses instead.")
  129. return data
  130. class PrefixFromCSVForm(forms.ModelForm):
  131. vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, to_field_name='rd',
  132. error_messages={'invalid_choice': 'VRF not found.'})
  133. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, to_field_name='name',
  134. error_messages={'invalid_choice': 'Site not found.'})
  135. status_name = forms.ChoiceField(choices=[(s[1], s[0]) for s in PREFIX_STATUS_CHOICES])
  136. role = forms.ModelChoiceField(queryset=Role.objects.all(), required=False, to_field_name='name',
  137. error_messages={'invalid_choice': 'Invalid role.'})
  138. class Meta:
  139. model = Prefix
  140. fields = ['prefix', 'vrf', 'site', 'status_name', 'role', 'description']
  141. def save(self, *args, **kwargs):
  142. m = super(PrefixFromCSVForm, self).save(commit=False)
  143. # Assign Prefix status by name
  144. m.status = dict(self.fields['status_name'].choices)[self.cleaned_data['status_name']]
  145. if kwargs.get('commit'):
  146. m.save()
  147. return m
  148. class PrefixImportForm(BulkImportForm, BootstrapMixin):
  149. csv = CSVDataField(csv_form=PrefixFromCSVForm)
  150. class PrefixBulkEditForm(forms.Form, BootstrapMixin):
  151. pk = forms.ModelMultipleChoiceField(queryset=Prefix.objects.all(), widget=forms.MultipleHiddenInput)
  152. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False)
  153. vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, label='VRF',
  154. help_text="Select the VRF to assign, or check below to remove VRF assignment")
  155. vrf_global = forms.BooleanField(required=False, label='Set VRF to global')
  156. role = forms.ModelChoiceField(queryset=Role.objects.all(), required=False)
  157. description = forms.CharField(max_length=50, required=False)
  158. class PrefixBulkDeleteForm(ConfirmationForm):
  159. pk = forms.ModelMultipleChoiceField(queryset=Prefix.objects.all(), widget=forms.MultipleHiddenInput)
  160. def prefix_vrf_choices():
  161. vrf_choices = [('', 'All'), (0, 'Global')]
  162. vrf_choices += [(v.pk, v.name) for v in VRF.objects.all()]
  163. return vrf_choices
  164. def prefix_site_choices():
  165. site_choices = Site.objects.annotate(prefix_count=Count('prefixes'))
  166. return [(s.slug, '{} ({})'.format(s.name, s.prefix_count)) for s in site_choices]
  167. def prefix_status_choices():
  168. status_counts = {}
  169. for status in Prefix.objects.values('status').annotate(count=Count('status')).order_by('status'):
  170. status_counts[status['status']] = status['count']
  171. return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in PREFIX_STATUS_CHOICES]
  172. def prefix_role_choices():
  173. role_choices = Role.objects.annotate(prefix_count=Count('prefixes'))
  174. return [(r.slug, '{} ({})'.format(r.name, r.prefix_count)) for r in role_choices]
  175. class PrefixFilterForm(forms.Form, BootstrapMixin):
  176. parent = forms.CharField(required=False, label='Search Within')
  177. vrf = forms.ChoiceField(required=False, choices=prefix_vrf_choices, label='VRF')
  178. status = forms.MultipleChoiceField(required=False, choices=prefix_status_choices)
  179. site = forms.MultipleChoiceField(required=False, choices=prefix_site_choices,
  180. widget=forms.SelectMultiple(attrs={'size': 8}))
  181. role = forms.MultipleChoiceField(required=False, choices=prefix_role_choices,
  182. widget=forms.SelectMultiple(attrs={'size': 8}))
  183. expand = forms.BooleanField(required=False, label='Expand prefix hierarchy')
  184. #
  185. # IP addresses
  186. #
  187. class IPAddressForm(forms.ModelForm, BootstrapMixin):
  188. nat_site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, label='Site',
  189. widget=forms.Select(attrs={'filter-for': 'nat_device'}))
  190. nat_device = forms.ModelChoiceField(queryset=Device.objects.all(), required=False, label='Device',
  191. widget=APISelect(api_url='/api/dcim/devices/?site_id={{nat_site}}',
  192. attrs={'filter-for': 'nat_inside'}))
  193. livesearch = forms.CharField(required=False, label='IP Address', widget=Livesearch(
  194. query_key='q', query_url='ipam-api:ipaddress_list', field_to_update='nat_inside', obj_label='address')
  195. )
  196. nat_inside = forms.ModelChoiceField(queryset=IPAddress.objects.all(), required=False, label='NAT (Inside)',
  197. widget=APISelect(api_url='/api/ipam/ip-addresses/?device_id={{nat_device}}',
  198. display_field='address'))
  199. class Meta:
  200. model = IPAddress
  201. fields = ['address', 'vrf', 'nat_device', 'nat_inside', 'description']
  202. help_texts = {
  203. 'address': "IPv4 or IPv6 address and mask",
  204. 'vrf': "VRF (if applicable)",
  205. }
  206. def __init__(self, *args, **kwargs):
  207. super(IPAddressForm, self).__init__(*args, **kwargs)
  208. self.fields['vrf'].empty_label = 'Global'
  209. if self.instance.nat_inside:
  210. nat_inside = self.instance.nat_inside
  211. # If the IP is assigned to an interface, populate site/device fields accordingly
  212. if self.instance.nat_inside.interface:
  213. self.initial['nat_site'] = self.instance.nat_inside.interface.device.rack.site.pk
  214. self.initial['nat_device'] = self.instance.nat_inside.interface.device.pk
  215. self.fields['nat_device'].queryset = Device.objects.filter(
  216. rack__site=nat_inside.interface.device.rack.site)
  217. self.fields['nat_inside'].queryset = IPAddress.objects.filter(
  218. interface__device=nat_inside.interface.device)
  219. else:
  220. self.fields['nat_inside'].queryset = IPAddress.objects.filter(pk=nat_inside.pk)
  221. else:
  222. # Initialize nat_device choices if nat_site is set
  223. if self.is_bound and self.data.get('nat_site'):
  224. self.fields['nat_device'].queryset = Device.objects.filter(rack__site__pk=self.data['nat_site'])
  225. elif self.initial.get('nat_site'):
  226. self.fields['nat_device'].queryset = Device.objects.filter(rack__site=self.initial['nat_site'])
  227. else:
  228. self.fields['nat_device'].choices = []
  229. # Initialize nat_inside choices if nat_device is set
  230. if self.is_bound and self.data.get('nat_device'):
  231. self.fields['nat_inside'].queryset = IPAddress.objects.filter(
  232. interface__device__pk=self.data['nat_device'])
  233. elif self.initial.get('nat_device'):
  234. self.fields['nat_inside'].queryset = IPAddress.objects.filter(
  235. interface__device__pk=self.initial['nat_device'])
  236. else:
  237. self.fields['nat_inside'].choices = []
  238. class IPAddressFromCSVForm(forms.ModelForm):
  239. vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, to_field_name='rd',
  240. error_messages={'invalid_choice': 'Site not found.'})
  241. device = forms.ModelChoiceField(queryset=Device.objects.all(), required=False, to_field_name='name',
  242. error_messages={'invalid_choice': 'Device not found.'})
  243. interface_name = forms.CharField(required=False)
  244. is_primary = forms.BooleanField(required=False)
  245. class Meta:
  246. model = IPAddress
  247. fields = ['address', 'vrf', 'device', 'interface_name', 'is_primary', 'description']
  248. def clean(self):
  249. device = self.cleaned_data.get('device')
  250. interface_name = self.cleaned_data.get('interface_name')
  251. is_primary = self.cleaned_data.get('is_primary')
  252. # Validate interface
  253. if device and interface_name:
  254. try:
  255. Interface.objects.get(device=device, name=interface_name)
  256. except Interface.DoesNotExist:
  257. self.add_error('interface_name', "Invalid interface ({}) for {}".format(interface_name, device))
  258. elif device and not interface_name:
  259. self.add_error('interface_name', "Device set ({}) but interface missing".format(device))
  260. elif interface_name and not device:
  261. self.add_error('device', "Interface set ({}) but device missing or invalid".format(interface_name))
  262. # Validate is_primary
  263. if is_primary and not device:
  264. self.add_error('is_primary', "No device specified; cannot set as primary IP")
  265. def save(self, commit=True):
  266. # Set interface
  267. if self.cleaned_data['device'] and self.cleaned_data['interface_name']:
  268. self.instance.interface = Interface.objects.get(device=self.cleaned_data['device'],
  269. name=self.cleaned_data['interface_name'])
  270. # Set as primary for device
  271. if self.cleaned_data['is_primary']:
  272. self.instance.primary_for = self.cleaned_data['device']
  273. return super(IPAddressFromCSVForm, self).save(commit=commit)
  274. class IPAddressImportForm(BulkImportForm, BootstrapMixin):
  275. csv = CSVDataField(csv_form=IPAddressFromCSVForm)
  276. class IPAddressBulkEditForm(forms.Form, BootstrapMixin):
  277. pk = forms.ModelMultipleChoiceField(queryset=IPAddress.objects.all(), widget=forms.MultipleHiddenInput)
  278. vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, label='VRF',
  279. help_text="Select the VRF to assign, or check below to remove VRF assignment")
  280. vrf_global = forms.BooleanField(required=False, label='Set VRF to global')
  281. description = forms.CharField(max_length=50, required=False)
  282. class IPAddressBulkDeleteForm(ConfirmationForm):
  283. pk = forms.ModelMultipleChoiceField(queryset=IPAddress.objects.all(), widget=forms.MultipleHiddenInput)
  284. def ipaddress_family_choices():
  285. return [('', 'All'), (4, 'IPv4'), (6, 'IPv6')]
  286. def ipaddress_vrf_choices():
  287. vrf_choices = [('', 'All'), (0, 'Global')]
  288. vrf_choices += [(v.pk, v.name) for v in VRF.objects.all()]
  289. return vrf_choices
  290. class IPAddressFilterForm(forms.Form, BootstrapMixin):
  291. family = forms.ChoiceField(required=False, choices=ipaddress_family_choices, label='Address Family')
  292. vrf = forms.ChoiceField(required=False, choices=ipaddress_vrf_choices, label='VRF')
  293. #
  294. # VLANs
  295. #
  296. class VLANForm(forms.ModelForm, BootstrapMixin):
  297. class Meta:
  298. model = VLAN
  299. fields = ['site', 'vid', 'name', 'status', 'role']
  300. help_texts = {
  301. 'site': "The site at which this VLAN exists",
  302. 'vid': "Configured VLAN ID",
  303. 'name': "Configured VLAN name",
  304. 'status': "Operational status of this VLAN",
  305. 'role': "The primary function of this VLAN",
  306. }
  307. class VLANFromCSVForm(forms.ModelForm):
  308. site = forms.ModelChoiceField(queryset=Site.objects.all(), to_field_name='name',
  309. error_messages={'invalid_choice': 'Device not found.'})
  310. status_name = forms.ChoiceField(choices=[(s[1], s[0]) for s in VLAN_STATUS_CHOICES])
  311. role = forms.ModelChoiceField(queryset=Role.objects.all(), required=False, to_field_name='name',
  312. error_messages={'invalid_choice': 'Invalid role.'})
  313. class Meta:
  314. model = VLAN
  315. fields = ['site', 'vid', 'name', 'status_name', 'role']
  316. def save(self, *args, **kwargs):
  317. m = super(VLANFromCSVForm, self).save(commit=False)
  318. # Assign VLAN status by name
  319. m.status = dict(self.fields['status_name'].choices)[self.cleaned_data['status_name']]
  320. if kwargs.get('commit'):
  321. m.save()
  322. return m
  323. class VLANImportForm(BulkImportForm, BootstrapMixin):
  324. csv = CSVDataField(csv_form=VLANFromCSVForm)
  325. class VLANBulkEditForm(forms.Form, BootstrapMixin):
  326. pk = forms.ModelMultipleChoiceField(queryset=VLAN.objects.all(), widget=forms.MultipleHiddenInput)
  327. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False)
  328. role = forms.ModelChoiceField(queryset=Role.objects.all(), required=False)
  329. class VLANBulkDeleteForm(ConfirmationForm):
  330. pk = forms.ModelMultipleChoiceField(queryset=VLAN.objects.all(), widget=forms.MultipleHiddenInput)
  331. def vlan_site_choices():
  332. site_choices = Site.objects.annotate(vlan_count=Count('vlans'))
  333. return [(s.slug, '{} ({})'.format(s.name, s.vlan_count)) for s in site_choices]
  334. def vlan_status_choices():
  335. status_counts = {}
  336. for status in VLAN.objects.values('status').annotate(count=Count('status')).order_by('status'):
  337. status_counts[status['status']] = status['count']
  338. return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in VLAN_STATUS_CHOICES]
  339. def vlan_role_choices():
  340. role_choices = Role.objects.annotate(vlan_count=Count('vlans'))
  341. return [(r.slug, '{} ({})'.format(r.name, r.vlan_count)) for r in role_choices]
  342. class VLANFilterForm(forms.Form, BootstrapMixin):
  343. site = forms.MultipleChoiceField(required=False, choices=vlan_site_choices,
  344. widget=forms.SelectMultiple(attrs={'size': 8}))
  345. status = forms.MultipleChoiceField(required=False, choices=vlan_status_choices)
  346. role = forms.MultipleChoiceField(required=False, choices=vlan_role_choices,
  347. widget=forms.SelectMultiple(attrs={'size': 8}))