Ce serveur Gitlab sera éteint le 30 juin 2020, pensez à migrer vos projets vers les serveurs gitlab-research.centralesupelec.fr et gitlab-student.centralesupelec.fr !

models.py 20.2 KB
Newer Older
1
# -*- mode: python; coding: utf-8 -*-
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 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.
23 24 25 26 27 28 29 30 31 32 33 34 35 36
"""
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
"""
37

38 39
from __future__ import unicode_literals

40 41
import itertools

chirac's avatar
chirac committed
42
from django.db import models
43 44
from django.db.models.signals import post_delete
from django.dispatch import receiver
45
from django.core.exceptions import ValidationError
46 47 48
from django.db import IntegrityError
from django.db import transaction
from reversion import revisions as reversion
chirac's avatar
chirac committed
49

50
from machines.models import Interface
chirac's avatar
chirac committed
51

52
class Stack(models.Model):
53 54
    """Un objet stack. Regrouppe des switchs en foreign key
    ,contient une id de stack, un switch id min et max dans
55
    le stack"""
56 57 58 59 60
    PRETTY_NAME = "Stack de switchs"

    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)
61 62
    member_id_min = models.PositiveIntegerField()
    member_id_max = models.PositiveIntegerField()
63

64 65 66 67 68
    class Meta:
        permissions = (
            ("view_stack", "Peut voir un objet stack"),
        )

69 70 71 72
    def get_instance(stack_id, *args, **kwargs):
        return Stack.objects.get(pk=stack_id)

    def can_create(user_request, *args, **kwargs):
73
        return user_request.has_perm('topologie.add_stack') , u"Vous n'avez pas le droit\
74 75 76
            de créer un stack"

    def can_edit(self, user_request, *args, **kwargs):
77
        if not user_request.has_perm('topologie.change_stack'):
78 79 80
            return False, u"Vous n'avez pas le droit d'éditer des stack"
        return True, None

81
    def can_delete(self, user_request, *args, **kwargs):
82
        if not user_request.has_perm('topologie.delete_stack'):
83 84
            return False, u"Vous n'avez pas le droit de supprimer une stack"
        return True, None
85 86

    def can_view_all(user_request, *args, **kwargs):
87
        if not user_request.has_perm('topologie.view_stack'):
88 89 90 91
            return False, u"Vous n'avez pas le droit de voir une stack"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
92
        if not user_request.has_perm('topologie.view_stack'):
93 94 95
            return False, u"Vous n'avez pas le droit de voir une stack"
        return True, None

96 97 98 99
    def __str__(self):
        return " ".join([self.name, self.stack_id])

    def save(self, *args, **kwargs):
100
        self.clean()
101 102 103 104 105
        if not self.name:
            self.name = self.stack_id
        super(Stack, self).save(*args, **kwargs)

    def clean(self):
106
        """ Verification que l'id_max < id_min"""
107
        if self.member_id_max < self.member_id_min:
chirac's avatar
chirac committed
108
            raise ValidationError({'member_id_max': "L'id maximale est\
109
                inférieure à l'id minimale"})
110

chirac's avatar
chirac committed
111

112
class AccessPoint(Interface):
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    """Define a wireless AP. Inherit from machines.interfaces
    
    Definition pour une borne wifi , hérite de machines.interfaces
    """
    PRETTY_NAME = "Borne WiFi"

    location = models.CharField(    
        max_length=255,
        help_text="Détails sur la localisation de l'AP",
        blank=True,
        null=True
    )

    class Meta:
        permissions = (
128
            ("view_ap", "Peut voir une borne"),
129 130
        )

131 132
    def get_instance(ap_id, *args, **kwargs):
        return AccessPoint.objects.get(pk=ap_id)
133 134

    def can_create(user_request, *args, **kwargs):
135
        return user_request.has_perm('topologie.add_ap') , u"Vous n'avez pas le droit\
136 137 138
            de créer une borne"

    def can_edit(self, user_request, *args, **kwargs):
139
        if not user_request.has_perm('topologie.change_ap'):
140 141 142 143
            return False, u"Vous n'avez pas le droit d'éditer des bornes"
        return True, None

    def can_delete(self, user_request, *args, **kwargs):
144
        if not user_request.has_perm('topologie.delete_ap'):
145 146 147 148
            return False, u"Vous n'avez pas le droit de supprimer une borne"
        return True, None

    def can_view_all(user_request, *args, **kwargs):
149
        if not user_request.has_perm('topologie.view_ap'):
150 151 152 153
            return False, u"Vous n'avez pas le droit de voir les bornes"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
154
        if not user_request.has_perm('topologie.view_ap'):
155 156 157 158
            return False, u"Vous n'avez pas le droit de voir les bornes"
        return True, None


159
class Switch(Interface):
160
    """ Definition d'un switch. Contient un nombre de ports (number),
161 162 163
    un emplacement (location), un stack parent (optionnel, stack)
    et un id de membre dans le stack (stack_member_id)
    relié en onetoone à une interface
164
    Pourquoi ne pas avoir fait hériter switch de interface ?
165 166
    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
167 168 169 170
    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"""
171 172
    PRETTY_NAME = "Switch / Commutateur"

173

chirac's avatar
chirac committed
174
    location = models.CharField(max_length=255)
175
    number = models.PositiveIntegerField()
176
    stack = models.ForeignKey(
177
        'topologie.Stack',
178 179 180 181
        blank=True,
        null=True,
        on_delete=models.SET_NULL
        )
182
    stack_member_id = models.PositiveIntegerField(blank=True, null=True)
183 184 185 186 187 188
    model = models.ForeignKey(
        'topologie.ModelSwitch',
        blank=True,
        null=True,
        on_delete=models.SET_NULL
    )
189 190

    class Meta:
191
        unique_together = ('stack', 'stack_member_id')
192
        permissions = (
Gabriel Detraz's avatar
Gabriel Detraz committed
193
            ("view_switch", "Peut voir un objet switch"),
194
        )
chirac's avatar
chirac committed
195

196 197 198 199
    def get_instance(switch_id, *args, **kwargs):
        return Switch.objects.get(pk=switch_id)

    def can_create(user_request, *args, **kwargs):
200
        return user_request.has_perm('topologie.add_switch') , u"Vous n'avez pas le droit\
201 202 203
            de créer un switch"

    def can_edit(self, user_request, *args, **kwargs):
204
        if not user_request.has_perm('topologie.change_switch'):
205 206 207
            return False, u"Vous n'avez pas le droit d'éditer des switch"
        return True, None

208
    def can_delete(self, user_request, *args, **kwargs):
209
        if not user_request.has_perm('topologie.delete_switch'):
210 211
            return False, u"Vous n'avez pas le droit de supprimer un switch"
        return True, None
212 213

    def can_view_all(user_request, *args, **kwargs):
214
        if not user_request.has_perm('topologie.view_switch'):
215
            return False, u"Vous n'avez pas le droit de voir les switch"
216 217 218
        return True, None

    def can_view(self, user_request, *args, **kwargs):
219
        if not user_request.has_perm('topologie.view_switch'):
220
            return False, u"Vous n'avez pas le droit de voir les switch"
221
        return True, None
222
 
223
    def clean(self):
Gabriel Detraz's avatar
Gabriel Detraz committed
224 225 226
        """ Verifie que l'id stack est dans le bon range
        Appelle également le clean de la classe parente"""
        super(Switch, self).clean()
227 228
        if self.stack is not None:
            if self.stack_member_id is not None:
229
                if (self.stack_member_id > self.stack.member_id_max) or\
chirac's avatar
chirac committed
230 231 232 233 234
                        (self.stack_member_id < self.stack.member_id_min):
                    raise ValidationError(
                        {'stack_member_id': "L'id de ce switch est en\
                            dehors des bornes permises pas la stack"}
                        )
235
            else:
236 237
                raise ValidationError({'stack_member_id': "L'id dans la stack\
                    ne peut être nul"})
238

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
    def create_ports(self, begin, end):
        """ Crée les ports de begin à end si les valeurs données sont cohérentes. """

        s_begin = s_end = 0
        nb_ports = self.ports.count()
        if nb_ports > 0:
            ports = self.ports.order_by('port').values('port')
            s_begin = ports.first().get('port')
            s_end = ports.last().get('port')

        if end < begin:
            raise ValidationError("Port de fin inférieur au port de début !")
        if end - begin > self.number:
            raise ValidationError("Ce switch ne peut avoir autant de ports.")
        begin_range = range(begin, s_begin)
        end_range = range(s_end+1, end+1)
        for i in itertools.chain(begin_range, end_range):
            port = Port()
            port.switch = self
            port.port = i
            try:
                with transaction.atomic(), reversion.create_revision():
                    port.save()
                    reversion.set_comment("Création")
            except IntegrityError:
                ValidationError("Création d'un port existant.")
265

chirac's avatar
chirac committed
266

267 268
class ModelSwitch(models.Model):
    """Un modèle (au sens constructeur) de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
269
    PRETTY_NAME = "Modèle de switch"
270 271 272 273 274 275
    reference = models.CharField(max_length=255)
    constructor = models.ForeignKey(
        'topologie.ConstructorSwitch',
        on_delete=models.PROTECT
    )

276 277 278 279 280
    class Meta:
        permissions = (
            ("view_modelswitch", "Peut voir un objet modelswitch"),
        )

281 282 283 284
    def get_instance(model_switch_id, *args, **kwargs):
        return ModelSwitch.objects.get(pk=model_switch_id)

    def can_create(user_request, *args, **kwargs):
285
        return user_request.has_perm('topologie.add_modelswitch') , u"Vous n'avez pas le droit\
286 287 288
            de créer un modèle de switch"

    def can_edit(self, user_request, *args, **kwargs):
289
        if not user_request.has_perm('topologie.change_modelswitch'):
290 291 292
            return False, u"Vous n'avez pas le droit d'éditer des modèle de switchs"
        return True, None

293
    def can_delete(self, user_request, *args, **kwargs):
294
        if not user_request.has_perm('topologie.delete_modelswitch'):
295 296
            return False, u"Vous n'avez pas le droit de supprimer un modèle switch"
        return True, None
297 298

    def can_view(self, user_request, *args, **kwargs):
299
        if not user_request.has_perm('topologie.view_modelswitch'):
300 301 302 303
            return False, u"Vous n'avez pas le droit de voir un modèle switch"
        return True, None

    def can_view_all(user_request, *args, **kwargs):
304
        if not user_request.has_perm('topologie.view_modelswitch'):
305 306
            return False, u"Vous n'avez pas le droit de voir un modèle switch"
        return True, None
307
   
308
    def __str__(self):
309
        return str(self.constructor) + ' ' + self.reference
310 311 312 313


class ConstructorSwitch(models.Model):
    """Un constructeur de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
314
    PRETTY_NAME = "Constructeur de switch"
315 316
    name = models.CharField(max_length=255)

317 318 319 320 321
    class Meta:
        permissions = (
            ("view_constructorswitch", "Peut voir un objet constructorswitch"),
        )

322 323 324 325
    def get_instance(constructor_switch_id, *args, **kwargs):
        return ConstructorSwitch.objects.get(pk=constructor_switch_id)

    def can_create(user_request, *args, **kwargs):
326
        return user_request.has_perm('topologie.add_constructorswitch') , u"Vous n'avez pas le droit\
327 328 329
            de créer un constructeur de switch"

    def can_edit(self, user_request, *args, **kwargs):
330
        if not user_request.has_perm('topologie.change_constructorswitch'):
331 332 333 334
            return False, u"Vous n'avez pas le droit d'éditer des\
                constructeurs de switchs"
        return True, None

335
    def can_delete(self, user_request, *args, **kwargs):
336
        if not user_request.has_perm('topologie.delete_constructorswitch'):
337 338
            return False, u"Vous n'avez pas le droit de supprimer un constructeur"
        return True, None
339 340

    def can_view_all(user_request, *args, **kwargs):
341
        if not user_request.has_perm('topologie.view_constructorswitch'):
342 343 344 345
            return False, u"Vous n'avez pas le droit de voir un constructeur"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
346
        if not user_request.has_perm('topologie.view_constructorswitch'):
347 348
            return False, u"Vous n'avez pas le droit de voir un constructeur"
        return True, None
349
    
350
    def __str__(self):
351
        return self.name
352 353


chirac's avatar
chirac committed
354
class Port(models.Model):
355
    """ Definition d'un port. Relié à un switch(foreign_key),
356 357 358 359
    un port peut etre relié de manière exclusive à :
    - une chambre (room)
    - une machine (serveur etc) (machine_interface)
    - un autre port (uplink) (related)
360
    Champs supplémentaires :
361
    - RADIUS (mode STRICT : connexion sur port uniquement si machine
362 363
    d'un adhérent à jour de cotisation et que la chambre est également à
    jour de cotisation
364 365 366 367
    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
368
    de forcer un port sur un vlan particulier. S'additionne à la politique
369
    RADIUS"""
370
    PRETTY_NAME = "Port de switch"
371
    STATES = (
372 373 374 375 376 377
        ('NO', 'NO'),
        ('STRICT', 'STRICT'),
        ('BLOQ', 'BLOQ'),
        ('COMMON', 'COMMON'),
        )

378 379 380 381 382
    switch = models.ForeignKey(
        'Switch',
        related_name="ports",
        on_delete=models.CASCADE
    )
383
    port = models.PositiveIntegerField()
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
    room = models.ForeignKey(
        'Room',
        on_delete=models.PROTECT,
        blank=True,
        null=True
        )
    machine_interface = models.ForeignKey(
        'machines.Interface',
        on_delete=models.SET_NULL,
        blank=True,
        null=True
        )
    related = models.OneToOneField(
        'self',
        null=True,
        blank=True,
        related_name='related_port'
        )
Gabriel Detraz's avatar
Gabriel Detraz committed
402
    radius = models.CharField(max_length=32, choices=STATES, default='NO')
403 404 405 406 407 408
    vlan_force = models.ForeignKey(
        'machines.Vlan',
        on_delete=models.SET_NULL,
        blank=True,
        null=True
        )
Dalahro's avatar
Dalahro committed
409
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
410 411

    class Meta:
412
        unique_together = ('switch', 'port')
413 414 415
        permissions = (
            ("view_port", "Peut voir un objet port"),
        )
416

417
    def get_instance(port_id, *args, **kwargs):
418
        return Port.objects\
419
            .select_related('switch__domain__extension')\
420 421 422 423 424
            .select_related('machine_interface__domain__extension')\
            .select_related('machine_interface__switch')\
            .select_related('room')\
            .select_related('related')\
            .get(pk=port_id)
425 426

    def can_create(user_request, *args, **kwargs):
427
        return user_request.has_perm('topologie.add_port') , u"Vous n'avez pas le droit\
428 429 430
            de créer un port"

    def can_edit(self, user_request, *args, **kwargs):
431
        if not user_request.has_perm('topologie.change_port'):
432 433 434
            return False, u"Vous n'avez pas le droit d'éditer des ports"
        return True, None

435
    def can_delete(self, user_request, *args, **kwargs):
436
        if not user_request.has_perm('topologie.delete_port'):
437 438
            return False, u"Vous n'avez pas le droit de supprimer un port"
        return True, None
439 440

    def can_view_all(user_request, *args, **kwargs):
441
        if not user_request.has_perm('topologie.view_port'):
442 443 444 445
            return False, u"Vous n'avez pas le droit de voir les ports"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
446
        if not user_request.has_perm('topologie.view_port'):
447 448
            return False, u"Vous n'avez pas le droit de voir les ports"
        return True, None
449
   
450 451 452 453 454
    def make_port_related(self):
        """ Synchronise le port distant sur self"""
        related_port = self.related
        related_port.related = self
        related_port.save()
455

456 457 458 459 460 461
    def clean_port_related(self):
        """ Supprime la relation related sur self"""
        related_port = self.related_port
        related_port.related = None
        related_port.save()

462
    def clean(self):
463 464 465 466
        """ 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
467
        Si un port related point vers self, on nettoie la relation
468 469 470
        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"""
lhark's avatar
lhark committed
471 472
        if hasattr(self, 'switch'):
            if self.port > self.switch.number:
chirac's avatar
chirac committed
473 474
                raise ValidationError("Ce port ne peut exister,\
                    numero trop élevé")
475
        if self.room and self.machine_interface or self.room and\
chirac's avatar
chirac committed
476
                self.related or self.machine_interface and self.related:
477 478 479
            raise ValidationError("Chambre, interface et related_port sont\
                mutuellement exclusifs")
        if self.related == self:
480 481 482
            raise ValidationError("On ne peut relier un port à lui même")
        if self.related and not self.related.related:
            if self.related.machine_interface or self.related.room:
483 484
                raise ValidationError("Le port relié est déjà occupé, veuillez\
                    le libérer avant de créer une relation")
485
            else:
486
                self.make_port_related()
487
        elif hasattr(self, 'related_port'):
488
            self.clean_port_related()
chirac's avatar
chirac committed
489 490

    def __str__(self):
chirac's avatar
chirac committed
491
        return str(self.switch) + " - " + str(self.port)
chirac's avatar
chirac committed
492

chirac's avatar
chirac committed
493

chirac's avatar
chirac committed
494
class Room(models.Model):
495
    """Une chambre/local contenant une prise murale"""
496 497
    PRETTY_NAME = "Chambre/ Prise murale"

lhark's avatar
lhark committed
498
    name = models.CharField(max_length=255, unique=True)
chirac's avatar
chirac committed
499
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
500

501 502
    class Meta:
        ordering = ['name']
503 504 505
        permissions = (
            ("view_room", "Peut voir un objet chambre"),
        )
506

507 508 509 510
    def get_instance(room_id, *args, **kwargs):
        return Room.objects.get(pk=room_id)

    def can_create(user_request, *args, **kwargs):
511
        return user_request.has_perm('topologie.add_room') , u"Vous n'avez pas le droit\
512 513 514
            de créer une chambre"

    def can_edit(self, user_request, *args, **kwargs):
515
        if not user_request.has_perm('topologie.change_room'):
516 517 518
            return False, u"Vous n'avez pas le droit d'éditer une chambre"
        return True, None

519
    def can_delete(self, user_request, *args, **kwargs):
520
        if not user_request.has_perm('topologie.delete_room'):
521 522 523
            return False, u"Vous n'avez pas le droit de supprimer une chambre"
        return True, None

524
    def can_view_all(user_request, *args, **kwargs):
525
        if not user_request.has_perm('topologie.view_room'):
526 527 528 529
            return False, u"Vous n'avez pas le droit de voir les chambres"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
530
        if not user_request.has_perm('topologie.view_room'):
531 532 533
            return False, u"Vous n'avez pas le droit de voir les chambres"
        return True, None

chirac's avatar
chirac committed
534
    def __str__(self):
535
        return self.name
chirac's avatar
chirac committed
536

chirac's avatar
chirac committed
537

538 539
@receiver(post_delete, sender=Stack)
def stack_post_delete(sender, **kwargs):
540 541
    """Vide les id des switches membres d'une stack supprimée"""
    Switch.objects.filter(stack=None).update(stack_member_id=None)