8
0
Fork 0
mirror of https://gitlab2.federez.net/re2o/re2o synced 2024-11-27 15:12:25 +00:00
re2o/topologie/models.py

1032 lines
33 KiB
Python
Raw Normal View History

# -*- mode: python; coding: utf-8 -*-
2017-01-15 23:01:18 +00:00
# Re2o est un logiciel d'administration développé initiallement au rezometz. Il
# se veut agnostique au réseau considéré, de manière à être installable en
# quelques clics.
#
# Copyright © 2017 Gabriel Détraz
# Copyright © 2017 Goulven Kermarec
# Copyright © 2017 Augustin Lemesle
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
Definition des modèles de l'application topologie.
On défini les models suivants :
- stack (id, id_min, id_max et nom) regrouppant les switches
- switch : nom, nombre de port, et interface
machine correspondante (mac, ip, etc) (voir machines.models.interface)
- Port: relié à un switch parent par foreign_key, numero du port,
relié de façon exclusive à un autre port, une machine
(serveur ou borne) ou une prise murale
- room : liste des prises murales, nom et commentaire de l'état de
la prise
"""
2017-01-15 23:01:18 +00:00
from __future__ import unicode_literals
2017-10-26 21:29:26 +00:00
import itertools
2016-07-03 01:12:41 +00:00
from django.db import models
2018-07-11 17:37:22 +00:00
from django.db.models.signals import post_save, post_delete
2018-05-21 19:13:44 +00:00
from django.utils.functional import cached_property
2019-08-07 00:09:57 +00:00
from django.core.cache import cache
2017-08-18 12:20:51 +00:00
from django.dispatch import receiver
from django.core.exceptions import ValidationError
2017-10-26 21:29:26 +00:00
from django.db import IntegrityError
from django.db import transaction
2018-05-26 22:36:25 +00:00
from django.utils.translation import ugettext_lazy as _
2017-10-26 21:29:26 +00:00
from reversion import revisions as reversion
2016-07-03 01:12:41 +00:00
from preferences.models import (
OptionalTopologie,
RadiusKey,
SwitchManagementCred
)
2018-04-14 22:06:29 +00:00
from machines.models import Machine, regen
2018-04-25 16:38:40 +00:00
from re2o.mixins import AclMixin, RevMixin
2018-04-14 00:20:44 +00:00
class Stack(AclMixin, RevMixin, models.Model):
"""Un objet stack. Regrouppe des switchs en foreign key
,contient une id de stack, un switch id min et max dans
2017-10-06 02:17:45 +00:00
le stack"""
name = models.CharField(max_length=32, blank=True, null=True)
stack_id = models.CharField(max_length=32, unique=True)
details = models.CharField(max_length=255, blank=True, null=True)
member_id_min = models.PositiveIntegerField()
member_id_max = models.PositiveIntegerField()
class Meta:
permissions = (
2018-08-05 16:48:56 +00:00
("view_stack", _("Can view a stack object")),
)
2018-08-05 16:48:56 +00:00
verbose_name = _("switches stack")
verbose_name_plural = _("switches stacks")
def __str__(self):
return " ".join([self.name, self.stack_id])
def save(self, *args, **kwargs):
2017-10-06 02:17:45 +00:00
self.clean()
if not self.name:
self.name = self.stack_id
super(Stack, self).save(*args, **kwargs)
def clean(self):
2017-10-06 02:17:45 +00:00
""" Verification que l'id_max < id_min"""
if self.member_id_max < self.member_id_min:
2018-08-05 16:48:56 +00:00
raise ValidationError(
{'member_id_max': _("The maximum ID is less than the"
" minimum ID.")}
)
2017-10-13 23:43:01 +00:00
2018-04-25 16:38:40 +00:00
class AccessPoint(AclMixin, Machine):
2018-03-23 23:50:11 +00:00
"""Define a wireless AP. Inherit from machines.interfaces
2018-04-14 00:20:44 +00:00
2018-03-23 23:50:11 +00:00
Definition pour une borne wifi , hérite de machines.interfaces
"""
2018-04-14 00:20:44 +00:00
location = models.CharField(
2018-03-23 23:50:11 +00:00
max_length=255,
2018-08-05 16:48:56 +00:00
help_text=_("Details about the AP's location"),
2018-03-23 23:50:11 +00:00
blank=True,
null=True
)
class Meta:
permissions = (
2018-08-05 16:48:56 +00:00
("view_accesspoint", _("Can view an access point object")),
2018-03-23 23:50:11 +00:00
)
2018-08-05 16:48:56 +00:00
verbose_name = _("access point")
verbose_name_plural = _("access points")
2018-03-23 23:50:11 +00:00
2018-05-21 19:13:44 +00:00
def port(self):
"""Return the queryset of ports for this device"""
return Port.objects.filter(
machine_interface__machine=self
)
def switch(self):
"""Return the switch where this is plugged"""
return Switch.objects.filter(
ports__machine_interface__machine=self
)
def building(self):
2018-07-11 17:37:22 +00:00
"""
Return the building of the AP/Server (building of the switchs
connected to...)
"""
2018-05-21 19:13:44 +00:00
return Building.objects.filter(
switchbay__switch=self.switch()
)
@cached_property
def short_name(self):
return str(self.interface_set.first().domain.name)
@classmethod
def all_ap_in(cls, building_instance):
"""Get a building as argument, returns all ap of a building"""
2018-07-11 17:37:22 +00:00
return cls.objects.filter(
interface__port__switch__switchbay__building=building_instance
)
2018-05-21 19:13:44 +00:00
def __str__(self):
return str(self.interface_set.first())
class Server(Machine):
2018-07-11 17:37:22 +00:00
"""
Dummy class, to retrieve servers of a building, or get switch of a server
"""
2018-05-21 19:13:44 +00:00
class Meta:
proxy = True
def port(self):
"""Return the queryset of ports for this device"""
return Port.objects.filter(
machine_interface__machine=self
)
def switch(self):
"""Return the switch where this is plugged"""
return Switch.objects.filter(
ports__machine_interface__machine=self
)
def building(self):
2018-07-11 17:37:22 +00:00
"""
Return the building of the AP/Server
(building of the switchs connected to...)
"""
2018-05-21 19:13:44 +00:00
return Building.objects.filter(
switchbay__switch=self.switch()
)
@cached_property
def short_name(self):
return str(self.interface_set.first().domain.name)
@classmethod
def all_server_in(cls, building_instance):
"""Get a building as argument, returns all server of a building"""
2018-07-11 17:37:22 +00:00
return cls.objects.filter(
interface__port__switch__switchbay__building=building_instance
).exclude(accesspoint__isnull=False)
2018-05-21 19:13:44 +00:00
def __str__(self):
return str(self.interface_set.first())
2018-03-23 23:50:11 +00:00
class Switch(AclMixin, Machine):
""" Definition d'un switch. Contient un nombre de ports (number),
2017-10-06 02:17:45 +00:00
un emplacement (location), un stack parent (optionnel, stack)
et un id de membre dans le stack (stack_member_id)
relié en onetoone à une interface
Pourquoi ne pas avoir fait hériter switch de interface ?
2017-10-06 02:17:45 +00:00
Principalement par méconnaissance de la puissance de cette façon de faire.
Ceci étant entendu, django crée en interne un onetoone, ce qui a un
effet identique avec ce que l'on fait ici
Validation au save que l'id du stack est bien dans le range id_min
id_max de la stack parente"""
2018-04-16 03:51:25 +00:00
number = models.PositiveIntegerField(
2018-08-05 16:48:56 +00:00
help_text=_("Number of ports")
2018-04-16 03:51:25 +00:00
)
stack = models.ForeignKey(
2017-10-26 03:07:11 +00:00
'topologie.Stack',
blank=True,
null=True,
on_delete=models.SET_NULL
2018-07-11 17:37:22 +00:00
)
2018-04-16 03:51:25 +00:00
stack_member_id = models.PositiveIntegerField(
blank=True,
2018-08-05 16:48:56 +00:00
null=True
2018-04-16 03:51:25 +00:00
)
2017-10-26 03:07:11 +00:00
model = models.ForeignKey(
'topologie.ModelSwitch',
blank=True,
null=True,
2018-04-16 03:51:25 +00:00
on_delete=models.SET_NULL,
2018-08-05 16:48:56 +00:00
help_text=_("Switch model")
2017-10-26 03:07:11 +00:00
)
switchbay = models.ForeignKey(
'topologie.SwitchBay',
blank=True,
null=True,
2018-04-16 03:51:25 +00:00
on_delete=models.SET_NULL,
)
radius_key = models.ForeignKey(
'preferences.RadiusKey',
blank=True,
null=True,
on_delete=models.PROTECT,
2019-01-08 23:40:48 +00:00
help_text=_("RADIUS key of the switch")
)
management_creds = models.ForeignKey(
'preferences.SwitchManagementCred',
blank=True,
null=True,
on_delete=models.PROTECT,
2019-01-08 23:40:48 +00:00
help_text=_("Management credentials for the switch")
)
automatic_provision = models.BooleanField(
default=False,
2019-01-08 23:40:48 +00:00
help_text=_("Automatic provision for the switch")
)
2019-01-03 00:02:02 +00:00
class Meta:
unique_together = ('stack', 'stack_member_id')
permissions = (
2018-08-05 16:48:56 +00:00
("view_switch", _("Can view a switch object")),
)
2018-08-05 16:48:56 +00:00
verbose_name = _("switch")
verbose_name_plural = _("switches")
2016-07-03 01:12:41 +00:00
def clean(self):
2018-03-25 02:51:48 +00:00
""" Verifie que l'id stack est dans le bon range
Appelle également le clean de la classe parente"""
super(Switch, self).clean()
if self.stack is not None:
if self.stack_member_id is not None:
if (self.stack_member_id > self.stack.member_id_max) or\
2017-10-13 23:43:01 +00:00
(self.stack_member_id < self.stack.member_id_min):
raise ValidationError(
2018-08-05 16:48:56 +00:00
{'stack_member_id': _("The switch ID exceeds the"
" limits allowed by the stack.")}
)
else:
2018-08-05 16:48:56 +00:00
raise ValidationError(
{'stack_member_id': _("The stack member ID can't be"
" void.")}
)
2018-03-23 23:50:11 +00:00
2017-10-26 21:29:26 +00:00
def create_ports(self, begin, end):
2018-04-14 00:20:44 +00:00
""" Crée les ports de begin à end si les valeurs données
sont cohérentes. """
2017-10-26 21:29:26 +00:00
if end < begin:
2018-08-05 16:48:56 +00:00
raise ValidationError(_("The end port is less than the start"
" port."))
ports_to_create = range(begin, end + 1)
2018-12-29 23:18:35 +00:00
existing_ports = Port.objects.filter(switch=self.switch).values_list('port', flat=True)
non_existing_ports = list(set(ports_to_create) - set(existing_ports))
if len(non_existing_ports) + existing_ports.count() > self.number:
2018-08-05 16:48:56 +00:00
raise ValidationError(_("This switch can't have that many ports."))
2018-12-29 23:18:35 +00:00
with transaction.atomic(), reversion.create_revision():
reversion.set_comment(_("Creation"))
Port.objects.bulk_create([Port(switch=self.switch, port=port_id) for port_id in non_existing_ports])
2018-04-07 18:45:29 +00:00
def main_interface(self):
""" Returns the 'main' interface of the switch
It must the the management interface for that device"""
switch_iptype = OptionalTopologie.get_cached_value('switchs_ip_type')
if switch_iptype:
return self.interface_set.filter(machine_type__ip_type=switch_iptype).first()
2018-04-07 18:45:29 +00:00
return self.interface_set.first()
2018-07-20 17:20:01 +00:00
@cached_property
def get_name(self):
2019-01-01 19:17:27 +00:00
return self.name or getattr(self.main_interface(), 'domain', 'Unknown')
@cached_property
def get_radius_key(self):
"""Retourne l'objet de la clef radius de ce switch"""
return self.radius_key or RadiusKey.objects.filter(default_switch=True).first()
@cached_property
def get_radius_key_value(self):
"""Retourne la valeur en str de la clef radius, none si il n'y en a pas"""
if self.get_radius_key:
return self.get_radius_key.radius_key
else:
return None
@cached_property
def get_management_cred(self):
"""Retourne l'objet des creds de managament de ce switch"""
return self.management_creds or SwitchManagementCred.objects.filter(default_switch=True).first()
@cached_property
def get_management_cred_value(self):
"""Retourne un dict des creds de management du switch"""
if self.get_management_cred:
return {'id': self.get_management_cred.management_id, 'pass': self.get_management_cred.management_pass}
else:
return None
@cached_property
def rest_enabled(self):
return OptionalTopologie.get_cached_value('switchs_rest_management') or self.automatic_provision
@cached_property
def web_management_enabled(self):
sw_management = OptionalTopologie.get_cached_value('switchs_web_management')
sw_management_ssl = OptionalTopologie.get_cached_value('switchs_web_management_ssl')
if sw_management_ssl:
return "ssl"
elif sw_management:
return "plain"
else:
return self.automatic_provision
@cached_property
def ipv4(self):
"""Return the switch's management ipv4"""
return str(self.main_interface().ipv4)
@cached_property
def ipv6(self):
"""Returne the switch's management ipv6"""
return str(self.main_interface().ipv6().first())
2018-07-20 17:20:01 +00:00
2018-07-02 09:00:32 +00:00
@cached_property
2018-07-11 23:12:46 +00:00
def interfaces_subnet(self):
"""Return dict ip:subnet for all ip of the switch"""
2019-03-17 13:53:11 +00:00
return dict((str(interface.ipv4), interface.machine_type.ip_type.ip_set_full_info) for interface in self.interface_set.all())
2018-07-02 09:00:32 +00:00
@cached_property
2018-07-11 23:12:46 +00:00
def interfaces6_subnet(self):
"""Return dict ip6:subnet for all ipv6 of the switch"""
2019-03-17 13:53:11 +00:00
return dict((str(interface.ipv6().first()), interface.machine_type.ip_type.ip6_set_full_info) for interface in self.interface_set.all())
2018-07-02 09:00:32 +00:00
2018-12-30 16:16:30 +00:00
@cached_property
def list_modules(self):
"""Return modules of that switch, list of dict (rank, reference)"""
modules = []
if getattr(self.model, 'is_modular', None):
2018-12-30 16:16:30 +00:00
if self.model.is_itself_module:
modules.append((1, self.model.reference))
for module_of_self in self.moduleonswitch_set.all():
modules.append((module_of_self.slot, module_of_self.module.reference))
return modules
2019-07-20 23:25:04 +00:00
@cached_property
def get_dormitory(self):
"""Returns the dormitory of that switch"""
if self.switchbay:
return self.switchbay.building.dormitory
else:
return None
@classmethod
def nothing_profile(cls):
"""Return default nothing port profile"""
nothing_profile, _created = PortProfile.objects.get_or_create(
profil_default='nothing',
name='nothing',
radius_type='NO'
)
return nothing_profile
def profile_type_or_nothing(self, profile_type):
"""Return the profile for a profile_type of this switch
If exists, returns the defined default profile for a profile type on the dormitory which
the switch belongs
Otherwise, returns the nothing profile"""
profile_queryset = PortProfile.objects.filter(profil_default=profile_type)
if self.get_dormitory:
port_profile = profile_queryset.filter(on_dormitory=self.get_dormitory).first() or profile_queryset.first()
else:
port_profile = profile_queryset.first()
return port_profile or Switch.nothing_profile
@cached_property
def default_uplink_profile(self):
"""Default uplink profile for that switch -- in cache"""
return self.profile_type_or_nothing('uplink')
@cached_property
def default_access_point_profile(self):
"""Default ap profile for that switch -- in cache"""
return self.profile_type_or_nothing('access_point')
@cached_property
def default_room_profile(self):
"""Default room profile for that switch -- in cache"""
return self.profile_type_or_nothing('room')
@cached_property
def default_asso_machine_profile(self):
"""Default asso machine profile for that switch -- in cache"""
return self.profile_type_or_nothing('asso_machine')
2018-03-26 20:11:03 +00:00
def __str__(self):
2018-07-20 17:20:01 +00:00
return str(self.get_name)
2018-03-26 20:11:03 +00:00
2017-10-13 23:43:01 +00:00
class ModelSwitch(AclMixin, RevMixin, models.Model):
2017-10-26 03:07:11 +00:00
"""Un modèle (au sens constructeur) de switch"""
2018-08-05 16:48:56 +00:00
2017-10-26 03:07:11 +00:00
reference = models.CharField(max_length=255)
2018-10-11 17:52:07 +00:00
commercial_name = models.CharField(
max_length=255,
null=True,
blank=True
)
2017-10-26 03:07:11 +00:00
constructor = models.ForeignKey(
'topologie.ConstructorSwitch',
on_delete=models.PROTECT
)
2018-07-08 20:28:10 +00:00
firmware = models.CharField(
max_length=255,
null=True,
blank=True
)
is_modular = models.BooleanField(
default=False,
2019-01-08 23:40:48 +00:00
help_text=_("The switch model is modular."),
2019-01-03 00:02:02 +00:00
)
is_itself_module = models.BooleanField(
default=False,
2019-01-08 23:40:48 +00:00
help_text=_("The switch is considered as a module."),
2019-01-03 00:02:02 +00:00
)
2017-10-26 03:07:11 +00:00
class Meta:
permissions = (
2018-08-05 16:48:56 +00:00
("view_modelswitch", _("Can view a switch model object")),
)
2018-08-05 16:48:56 +00:00
verbose_name = _("switch model")
verbose_name_plural = _("switch models")
2017-10-26 03:07:11 +00:00
def __str__(self):
if self.commercial_name:
return str(self.constructor) + ' ' + str(self.commercial_name)
else:
return str(self.constructor) + ' ' + self.reference
2017-10-26 03:07:11 +00:00
class ModuleSwitch(AclMixin, RevMixin, models.Model):
"""A module of a switch"""
reference = models.CharField(
max_length=255,
help_text=_("Reference of a module"),
2019-01-03 00:02:02 +00:00
verbose_name=_("Module reference")
)
comment = models.CharField(
max_length=255,
null=True,
blank=True,
help_text=_("Comment"),
2019-01-03 00:02:02 +00:00
verbose_name=_("Comment")
)
class Meta:
permissions = (
2019-01-08 23:40:48 +00:00
("view_moduleswitch", _("Can view a switch module object")),
)
2019-01-08 23:40:48 +00:00
verbose_name = _("switch module")
verbose_name_plural = _("switch modules")
def __str__(self):
return str(self.reference)
class ModuleOnSwitch(AclMixin, RevMixin, models.Model):
"""Link beetween module and switch"""
module = models.ForeignKey('ModuleSwitch', on_delete=models.CASCADE)
switch = models.ForeignKey('Switch', on_delete=models.CASCADE)
slot = models.CharField(
max_length=15,
help_text=_("Slot on switch"),
2019-01-03 00:02:02 +00:00
verbose_name=_("Slot")
)
class Meta:
permissions = (
2019-01-08 23:40:48 +00:00
("view_moduleonswitch", _("Can view a link between switch and"
" module object")),
)
2019-01-08 23:40:48 +00:00
verbose_name = _("link between switch and module")
verbose_name_plural = _("links between switch and module")
unique_together = ['slot', 'switch']
def __str__(self):
2019-01-08 23:40:48 +00:00
return _("On slot ") + str(self.slot) + _(" of ") + str(self.switch)
class ConstructorSwitch(AclMixin, RevMixin, models.Model):
2017-10-26 03:07:11 +00:00
"""Un constructeur de switch"""
2018-08-05 16:48:56 +00:00
2017-10-26 03:07:11 +00:00
name = models.CharField(max_length=255)
class Meta:
permissions = (
2018-08-05 16:48:56 +00:00
("view_constructorswitch", _("Can view a switch constructor"
" object")),
)
2018-08-05 16:48:56 +00:00
verbose_name = _("switch constructor")
verbose_name_plural = ("switch constructors")
2017-10-26 03:07:11 +00:00
def __str__(self):
return self.name
2017-10-26 03:07:11 +00:00
2018-04-07 18:45:29 +00:00
class SwitchBay(AclMixin, RevMixin, models.Model):
"""Une baie de brassage"""
2018-08-05 16:48:56 +00:00
2018-04-07 18:45:29 +00:00
name = models.CharField(max_length=255)
building = models.ForeignKey(
'Building',
on_delete=models.PROTECT
)
info = models.CharField(
max_length=255,
blank=True,
2018-08-05 16:48:56 +00:00
null=True
2018-04-07 18:45:29 +00:00
)
class Meta:
permissions = (
2018-08-05 16:48:56 +00:00
("view_switchbay", _("Can view a switch bay object")),
2018-04-07 18:45:29 +00:00
)
2018-08-05 16:48:56 +00:00
verbose_name = _("switch bay")
verbose_name_plural = _("switch bays")
2018-04-07 18:45:29 +00:00
def __str__(self):
return self.name
2019-02-18 20:11:51 +00:00
class Dormitory(AclMixin, RevMixin, models.Model):
2019-02-20 19:49:34 +00:00
"""A student accomodation/dormitory
Une résidence universitaire"""
2019-02-18 20:11:51 +00:00
name = models.CharField(max_length=255)
class Meta:
permissions = (
("view_dormitory", _("Can view a dormitory object")),
)
verbose_name = _("dormitory")
verbose_name_plural = _("dormitories")
def all_ap_in(self):
"""Returns all ap of the dorms"""
return AccessPoint.all_ap_in(self.building_set.all())
2019-08-07 00:09:57 +00:00
@classmethod
def is_multiple_dorms(cls):
multiple_dorms = cache.get('multiple_dorms')
if multiple_dorms:
return multiple_dorms
else:
return cache.get_or_set('multiple_dorms', cls.objects.count() > 1)
2019-02-18 20:11:51 +00:00
def __str__(self):
return self.name
2018-04-07 18:45:29 +00:00
class Building(AclMixin, RevMixin, models.Model):
2019-02-20 19:49:34 +00:00
"""A building of a dormitory
Un batiment"""
2018-08-05 16:48:56 +00:00
2018-04-07 18:45:29 +00:00
name = models.CharField(max_length=255)
2019-02-18 20:11:51 +00:00
dormitory = models.ForeignKey(
'Dormitory',
on_delete=models.PROTECT,
)
2018-04-07 18:45:29 +00:00
class Meta:
permissions = (
2018-08-05 16:48:56 +00:00
("view_building", _("Can view a building object")),
2018-04-07 18:45:29 +00:00
)
2018-08-05 16:48:56 +00:00
verbose_name = _("building")
verbose_name_plural = _("buildings")
2018-04-07 18:45:29 +00:00
2018-10-14 18:17:51 +00:00
def all_ap_in(self):
"""Returns all ap of the building"""
return AccessPoint.all_ap_in(self)
2019-08-06 15:46:13 +00:00
def get_name(self):
2019-08-07 00:09:57 +00:00
if Dormitory.is_multiple_dorms():
2019-02-18 20:11:51 +00:00
return self.dormitory.name + " : " + self.name
else:
return self.name
2018-04-07 18:45:29 +00:00
2019-08-06 15:46:13 +00:00
@cached_property
def cached_name(self):
return self.get_name()
def __str__(self):
return self.cached_name
2018-04-07 18:45:29 +00:00
class Port(AclMixin, RevMixin, models.Model):
""" Definition d'un port. Relié à un switch(foreign_key),
2017-10-06 02:17:45 +00:00
un port peut etre relié de manière exclusive à :
- une chambre (room)
- une machine (serveur etc) (machine_interface)
- un autre port (uplink) (related)
Champs supplémentaires :
2017-10-06 02:17:45 +00:00
- RADIUS (mode STRICT : connexion sur port uniquement si machine
d'un adhérent à jour de cotisation et que la chambre est également à
jour de cotisation
2017-10-06 02:17:45 +00:00
mode COMMON : vérification uniquement du statut de la machine
mode NO : accepte toute demande venant du port et place sur le vlan normal
mode BLOQ : rejet de toute authentification
- vlan_force : override la politique générale de placement vlan, permet
de forcer un port sur un vlan particulier. S'additionne à la politique
2017-10-06 02:17:45 +00:00
RADIUS"""
2017-10-18 00:27:42 +00:00
switch = models.ForeignKey(
'Switch',
related_name="ports",
on_delete=models.CASCADE
)
port = models.PositiveIntegerField()
room = models.ForeignKey(
'Room',
on_delete=models.PROTECT,
blank=True,
null=True
2018-07-11 17:37:22 +00:00
)
machine_interface = models.ForeignKey(
'machines.Interface',
on_delete=models.SET_NULL,
blank=True,
null=True
2018-07-11 17:37:22 +00:00
)
related = models.OneToOneField(
'self',
null=True,
blank=True,
related_name='related_port'
2018-07-11 17:37:22 +00:00
)
2018-06-30 22:17:24 +00:00
custom_profile = models.ForeignKey(
'PortProfile',
on_delete=models.PROTECT,
blank=True,
null=True
2018-07-11 17:37:22 +00:00
)
state = models.BooleanField(
default=True,
2019-01-08 23:40:48 +00:00
help_text=_("Port state Active"),
2018-08-05 16:48:56 +00:00
verbose_name=_("Port state Active")
)
details = models.CharField(max_length=255, blank=True)
2016-07-03 12:02:46 +00:00
class Meta:
unique_together = ('switch', 'port')
permissions = (
2018-08-05 16:48:56 +00:00
("view_port", _("Can view a port object")),
)
2018-08-05 16:48:56 +00:00
verbose_name = _("port")
verbose_name_plural = _("ports")
@cached_property
def pretty_name(self):
"""More elaborated name for label on switch conf"""
if self.related:
2019-01-08 23:40:48 +00:00
return _("Uplink: ") + self.related.switch.short_name
elif self.machine_interface:
2019-01-08 23:40:48 +00:00
return _("Machine: ") + str(self.machine_interface.domain)
elif self.room:
2019-01-08 23:40:48 +00:00
return _("Room: ") + str(self.room)
else:
2019-01-08 23:40:48 +00:00
return _("Unknown")
@cached_property
def get_port_profile(self):
"""Return the config profil for this port
2019-07-20 23:25:04 +00:00
:returns: the profile of self (port)
If is defined a custom profile, returns it
elIf a default profile is defined for its dormitory, returns it
Else, returns the global default profil
If not exists, create a nothing profile"""
2018-06-30 22:17:24 +00:00
if self.custom_profile:
return self.custom_profile
elif self.related:
return self.switch.default_uplink_profile
elif self.machine_interface:
if hasattr(self.machine_interface.machine, 'accesspoint'):
return self.switch.default_access_point_profile
else:
return self.switch.default_asso_machine_profile
elif self.room:
return self.switch.default_room_profile
else:
return Switch.nothing_profile
2018-04-14 22:06:29 +00:00
@classmethod
def get_instance(cls, portid, *_args, **kwargs):
return (cls.objects
.select_related('machine_interface__domain__extension')
.select_related('machine_interface__machine__switch')
.select_related('room')
.select_related('related')
.prefetch_related('switch__interface_set__domain__extension')
.get(pk=portid))
2017-10-06 02:17:45 +00:00
def make_port_related(self):
""" Synchronise le port distant sur self"""
related_port = self.related
related_port.related = self
related_port.save()
2017-10-06 02:17:45 +00:00
def clean_port_related(self):
""" Supprime la relation related sur self"""
related_port = self.related_port
related_port.related = None
related_port.save()
def clean(self):
""" Verifie que un seul de chambre, interface_parent et related_port
est rempli. Verifie que le related n'est pas le port lui-même....
Verifie que le related n'est pas déjà occupé par une machine ou une
chambre. Si ce n'est pas le cas, applique la relation related
2017-10-06 02:17:45 +00:00
Si un port related point vers self, on nettoie la relation
A priori pas d'autre solution que de faire ça à la main. A priori
tout cela est dans un bloc transaction, donc pas de problème de
cohérence"""
2016-11-19 02:10:05 +00:00
if hasattr(self, 'switch'):
if self.port > self.switch.number:
2018-04-14 22:06:29 +00:00
raise ValidationError(
2018-08-05 16:48:56 +00:00
_("The port can't exist, its number is too great.")
2018-04-14 22:06:29 +00:00
)
if (self.room and self.machine_interface or
self.room and self.related or
self.machine_interface and self.related):
raise ValidationError(
2018-08-05 16:48:56 +00:00
_("Room, interface and related port are mutually exclusive.")
2018-04-14 22:06:29 +00:00
)
if self.related == self:
2018-08-05 16:48:56 +00:00
raise ValidationError(_("A port can't be related to itself."))
if self.related and not self.related.related:
if self.related.machine_interface or self.related.room:
2018-04-14 22:06:29 +00:00
raise ValidationError(
2018-08-05 16:48:56 +00:00
_("The related port is already used, please clear it"
" before creating the relation.")
2018-04-14 22:06:29 +00:00
)
else:
2017-10-06 02:17:45 +00:00
self.make_port_related()
elif hasattr(self, 'related_port'):
2017-10-06 02:17:45 +00:00
self.clean_port_related()
2016-07-03 01:12:41 +00:00
def __str__(self):
2016-07-03 12:02:46 +00:00
return str(self.switch) + " - " + str(self.port)
2016-07-03 01:12:41 +00:00
2017-10-13 23:43:01 +00:00
class Room(AclMixin, RevMixin, models.Model):
"""Une chambre/local contenant une prise murale"""
2019-02-18 20:11:51 +00:00
name = models.CharField(max_length=255)
2016-07-19 00:30:52 +00:00
details = models.CharField(max_length=255, blank=True)
2019-02-18 20:11:51 +00:00
building = models.ForeignKey(
'Building',
on_delete=models.PROTECT,
)
2016-07-03 01:12:41 +00:00
class Meta:
2019-02-18 20:11:51 +00:00
ordering = ['building__name']
permissions = (
2018-08-05 16:48:56 +00:00
("view_room", _("Can view a room object")),
)
2018-08-05 16:48:56 +00:00
verbose_name = _("room")
verbose_name_plural = _("rooms")
2019-02-18 20:11:51 +00:00
unique_together = ('name', 'building')
2016-07-03 01:12:41 +00:00
def __str__(self):
return self.building.cached_name + ' ' + self.name
2016-07-03 12:02:46 +00:00
2017-10-13 23:43:01 +00:00
2018-06-26 16:49:19 +00:00
class PortProfile(AclMixin, RevMixin, models.Model):
2018-05-26 22:36:25 +00:00
"""Contains the information of the ports' configuration for a switch"""
TYPES = (
('NO', 'NO'),
('802.1X', '802.1X'),
2019-01-08 23:40:48 +00:00
('MAC-radius', _("MAC-RADIUS")),
2018-07-11 17:37:22 +00:00
)
2018-05-26 22:36:25 +00:00
MODES = (
('STRICT', 'STRICT'),
('COMMON', 'COMMON'),
2018-07-11 17:37:22 +00:00
)
2018-06-26 16:49:19 +00:00
SPEED = (
('10-half', '10-half'),
('100-half', '100-half'),
('10-full', '10-full'),
('100-full', '100-full'),
('1000-full', '1000-full'),
('auto', 'auto'),
('auto-10', 'auto-10'),
('auto-100', 'auto-100'),
2018-07-11 17:37:22 +00:00
)
PROFIL_DEFAULT = (
2019-01-08 23:40:48 +00:00
('room', _("Room")),
('access_point', _("Access point")),
('uplink', _("Uplink")),
('asso_machine', _("Organisation machine")),
('nothing', _("Nothing")),
2018-07-11 17:37:22 +00:00
)
2018-05-26 22:36:25 +00:00
name = models.CharField(max_length=255, verbose_name=_("Name"))
2018-06-26 16:49:19 +00:00
profil_default = models.CharField(
max_length=32,
choices=PROFIL_DEFAULT,
blank=True,
null=True,
2018-08-05 16:48:56 +00:00
verbose_name=_("Default profile")
2018-06-26 16:49:19 +00:00
)
on_dormitory = models.ForeignKey(
'topologie.Dormitory',
related_name='dormitory_ofprofil',
on_delete=models.SET_NULL,
blank=True,
null=True,
verbose_name=_("Profil on dormitory")
)
2018-05-26 22:36:25 +00:00
vlan_untagged = models.ForeignKey(
2018-06-26 16:49:19 +00:00
'machines.Vlan',
related_name='vlan_untagged',
on_delete=models.SET_NULL,
blank=True,
null=True,
verbose_name=_("VLAN untagged")
2018-05-26 22:36:25 +00:00
)
vlan_tagged = models.ManyToManyField(
2018-06-26 16:49:19 +00:00
'machines.Vlan',
related_name='vlan_tagged',
blank=True,
verbose_name=_("VLAN(s) tagged")
)
2018-05-26 22:36:25 +00:00
radius_type = models.CharField(
2018-06-26 16:49:19 +00:00
max_length=32,
choices=TYPES,
2018-08-05 16:48:56 +00:00
help_text=_("Type of RADIUS authentication : inactive, MAC-address or"
" 802.1X"),
2018-06-26 16:49:19 +00:00
verbose_name=_("RADIUS type")
2018-05-26 22:36:25 +00:00
)
radius_mode = models.CharField(
2018-06-26 16:49:19 +00:00
max_length=32,
choices=MODES,
default='COMMON',
2018-08-05 16:48:56 +00:00
help_text=_("In case of MAC-authentication : mode COMMON or STRICT on"
" this port"),
2018-06-26 16:49:19 +00:00
verbose_name=_("RADIUS mode")
)
speed = models.CharField(
max_length=32,
choices=SPEED,
default='auto',
2018-08-05 16:48:56 +00:00
help_text=_("Port speed limit"),
2018-06-26 16:49:19 +00:00
)
mac_limit = models.IntegerField(
null=True,
blank=True,
2018-08-05 16:48:56 +00:00
help_text=_("Limit of MAC-address on this port"),
verbose_name=_("MAC limit")
2018-06-26 16:49:19 +00:00
)
flow_control = models.BooleanField(
default=False,
2018-08-05 16:48:56 +00:00
help_text=_("Flow control"),
2018-06-26 16:49:19 +00:00
)
dhcp_snooping = models.BooleanField(
default=False,
2018-08-05 16:48:56 +00:00
help_text=_("Protect against rogue DHCP"),
verbose_name=_("DHCP snooping")
2018-06-26 16:49:19 +00:00
)
dhcpv6_snooping = models.BooleanField(
default=False,
2018-08-05 16:48:56 +00:00
help_text=_("Protect against rogue DHCPv6"),
verbose_name=_("DHCPv6 snooping")
2018-06-26 16:49:19 +00:00
)
arp_protect = models.BooleanField(
default=False,
2018-08-05 16:48:56 +00:00
help_text=_("Check if IP adress is DHCP assigned"),
verbose_name=_("ARP protection")
2018-05-26 22:36:25 +00:00
)
2018-06-26 16:49:19 +00:00
ra_guard = models.BooleanField(
default=False,
2018-08-05 16:48:56 +00:00
help_text=_("Protect against rogue RA"),
verbose_name=_("RA guard")
2018-07-11 17:37:22 +00:00
)
2018-06-26 16:49:19 +00:00
loop_protect = models.BooleanField(
default=False,
2018-08-05 16:48:56 +00:00
help_text=_("Protect against loop"),
verbose_name=_("Loop protection")
2018-07-11 17:37:22 +00:00
)
2018-05-26 22:36:25 +00:00
class Meta:
permissions = (
2018-07-11 17:37:22 +00:00
("view_port_profile", _("Can view a port profile object")),
2018-05-26 22:36:25 +00:00
)
2018-08-05 16:48:56 +00:00
verbose_name = _("port profile")
verbose_name_plural = _("port profiles")
unique_together = ['on_dormitory', 'profil_default']
2018-05-26 22:36:25 +00:00
2018-07-11 17:37:22 +00:00
security_parameters_fields = [
'loop_protect',
'ra_guard',
'arp_protect',
'dhcpv6_snooping',
'dhcp_snooping',
'flow_control'
]
2018-06-26 23:29:40 +00:00
@cached_property
def security_parameters_enabled(self):
2018-07-11 17:37:22 +00:00
return [
parameter
for parameter in self.security_parameters_fields
if getattr(self, parameter)
]
2018-06-26 23:29:40 +00:00
2018-06-30 22:17:24 +00:00
@cached_property
def security_parameters_as_str(self):
return ','.join(self.security_parameters_enabled)
def clean(self):
""" Check that there is only one generic profil default"""
super(PortProfile, self).clean()
if self.profil_default and not self.on_dormitory and PortProfile.objects.exclude(id=self.id).filter(profil_default=self.profil_default).exclude(on_dormitory__isnull=False).exists():
raise ValidationError(
{'profil_default': _("A default profile for all dormitory of that type already exists.")}
)
2018-05-26 22:36:25 +00:00
def __str__(self):
return self.name
2018-03-27 00:54:29 +00:00
@receiver(post_save, sender=AccessPoint)
2018-04-15 01:00:05 +00:00
def ap_post_save(**_kwargs):
2018-03-27 00:54:29 +00:00
"""Regeneration des noms des bornes vers le controleur"""
regen('unifi-ap-names')
2018-05-21 19:13:44 +00:00
regen("graph_topo")
2018-03-27 00:54:29 +00:00
2018-07-11 17:37:22 +00:00
2018-03-27 00:54:29 +00:00
@receiver(post_delete, sender=AccessPoint)
2018-04-15 01:00:05 +00:00
def ap_post_delete(**_kwargs):
2018-03-27 00:54:29 +00:00
"""Regeneration des noms des bornes vers le controleur"""
regen('unifi-ap-names')
2018-05-21 19:13:44 +00:00
regen("graph_topo")
2018-03-27 00:54:29 +00:00
2018-07-11 17:37:22 +00:00
2017-08-18 12:20:51 +00:00
@receiver(post_delete, sender=Stack)
2018-04-15 01:00:05 +00:00
def stack_post_delete(**_kwargs):
"""Vide les id des switches membres d'une stack supprimée"""
Switch.objects.filter(stack=None).update(stack_member_id=None)
2018-05-21 19:13:44 +00:00
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_save, sender=Port)
def port_post_save(**_kwargs):
regen("graph_topo")
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_delete, sender=Port)
def port_post_delete(**_kwargs):
regen("graph_topo")
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_save, sender=ModelSwitch)
def modelswitch_post_save(**_kwargs):
regen("graph_topo")
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_delete, sender=ModelSwitch)
def modelswitch_post_delete(**_kwargs):
regen("graph_topo")
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_save, sender=Building)
def building_post_save(**_kwargs):
regen("graph_topo")
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_delete, sender=Building)
def building_post_delete(**_kwargs):
regen("graph_topo")
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_save, sender=Switch)
def switch_post_save(**_kwargs):
regen("graph_topo")
2018-07-11 17:37:22 +00:00
2018-05-21 19:13:44 +00:00
@receiver(post_delete, sender=Switch)
def switch_post_delete(**_kwargs):
regen("graph_topo")
2018-08-05 16:48:56 +00:00