from __future__ import unicode_literals from collections import OrderedDict from datetime import date import graphviz from django.contrib.auth.models import User from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType from django.contrib.postgres.fields import JSONField from django.core.validators import ValidationError from django.db import models from django.db.models import Q from django.http import HttpResponse from django.template import Template, Context from django.utils.encoding import python_2_unicode_compatible from django.utils.safestring import mark_safe from dcim.constants import CONNECTION_STATUS_CONNECTED from utilities.utils import foreground_color from .constants import * # # Custom fields # class CustomFieldModel(object): def cf(self): """ Name-based CustomFieldValue accessor for use in templates """ if not hasattr(self, 'get_custom_fields'): return dict() return {field.name: value for field, value in self.get_custom_fields().items()} def get_custom_fields(self): """ Return a dictionary of custom fields for a single object in the form {: value}. """ # Find all custom fields applicable to this type of object content_type = ContentType.objects.get_for_model(self) fields = CustomField.objects.filter(obj_type=content_type) # If the object exists, populate its custom fields with values if hasattr(self, 'pk'): values = CustomFieldValue.objects.filter(obj_type=content_type, obj_id=self.pk).select_related('field') values_dict = {cfv.field_id: cfv.value for cfv in values} return OrderedDict([(field, values_dict.get(field.pk)) for field in fields]) else: return OrderedDict([(field, None) for field in fields]) @python_2_unicode_compatible class CustomField(models.Model): obj_type = models.ManyToManyField( to=ContentType, related_name='custom_fields', verbose_name='Object(s)', limit_choices_to={'model__in': CUSTOMFIELD_MODELS}, help_text='The object(s) to which this field applies.' ) type = models.PositiveSmallIntegerField( choices=CUSTOMFIELD_TYPE_CHOICES, default=CF_TYPE_TEXT ) name = models.CharField( max_length=50, unique=True ) label = models.CharField( max_length=50, blank=True, help_text='Name of the field as displayed to users (if not provided, ' 'the field\'s name will be used)' ) description = models.CharField( max_length=100, blank=True ) required = models.BooleanField( default=False, help_text='If true, this field is required when creating new objects ' 'or editing an existing object.' ) filter_logic = models.PositiveSmallIntegerField( choices=CF_FILTER_CHOICES, default=CF_FILTER_LOOSE, help_text='Loose matches any instance of a given string; exact ' 'matches the entire field.' ) default = models.CharField( max_length=100, blank=True, help_text='Default value for the field. Use "true" or "false" for ' 'booleans. N/A for selection fields.' ) weight = models.PositiveSmallIntegerField( default=100, help_text='Fields with higher weights appear lower in a form.' ) class Meta: ordering = ['weight', 'name'] def __str__(self): return self.label or self.name.replace('_', ' ').capitalize() def serialize_value(self, value): """ Serialize the given value to a string suitable for storage as a CustomFieldValue """ if value is None: return '' if self.type == CF_TYPE_BOOLEAN: return str(int(bool(value))) if self.type == CF_TYPE_DATE: # Could be date/datetime object or string try: return value.strftime('%Y-%m-%d') except AttributeError: return value if self.type == CF_TYPE_SELECT: # Could be ModelChoiceField or TypedChoiceField return str(value.id) if hasattr(value, 'id') else str(value) return value def deserialize_value(self, serialized_value): """ Convert a string into the object it represents depending on the type of field """ if serialized_value == '': return None if self.type == CF_TYPE_INTEGER: return int(serialized_value) if self.type == CF_TYPE_BOOLEAN: return bool(int(serialized_value)) if self.type == CF_TYPE_DATE: # Read date as YYYY-MM-DD return date(*[int(n) for n in serialized_value.split('-')]) if self.type == CF_TYPE_SELECT: return self.choices.get(pk=int(serialized_value)) return serialized_value @python_2_unicode_compatible class CustomFieldValue(models.Model): field = models.ForeignKey( to='extras.CustomField', on_delete=models.CASCADE, related_name='values' ) obj_type = models.ForeignKey( to=ContentType, on_delete=models.PROTECT, related_name='+' ) obj_id = models.PositiveIntegerField() obj = GenericForeignKey( ct_field='obj_type', fk_field='obj_id' ) serialized_value = models.CharField( max_length=255 ) class Meta: ordering = ['obj_type', 'obj_id'] unique_together = ['field', 'obj_type', 'obj_id'] def __str__(self): return '{} {}'.format(self.obj, self.field) @property def value(self): return self.field.deserialize_value(self.serialized_value) @value.setter def value(self, value): self.serialized_value = self.field.serialize_value(value) def save(self, *args, **kwargs): # Delete this object if it no longer has a value to store if self.pk and self.value is None: self.delete() else: super(CustomFieldValue, self).save(*args, **kwargs) @python_2_unicode_compatible class CustomFieldChoice(models.Model): field = models.ForeignKey( to='extras.CustomField', on_delete=models.CASCADE, related_name='choices', limit_choices_to={'type': CF_TYPE_SELECT} ) value = models.CharField( max_length=100 ) weight = models.PositiveSmallIntegerField( default=100, help_text='Higher weights appear lower in the list' ) class Meta: ordering = ['field', 'weight', 'value'] unique_together = ['field', 'value'] def __str__(self): return self.value def clean(self): if self.field.type != CF_TYPE_SELECT: raise ValidationError("Custom field choices can only be assigned to selection fields.") def delete(self, using=None, keep_parents=False): # When deleting a CustomFieldChoice, delete all CustomFieldValues which point to it pk = self.pk super(CustomFieldChoice, self).delete(using, keep_parents) CustomFieldValue.objects.filter(field__type=CF_TYPE_SELECT, serialized_value=str(pk)).delete() # # Graphs # @python_2_unicode_compatible class Graph(models.Model): type = models.PositiveSmallIntegerField( choices=GRAPH_TYPE_CHOICES ) weight = models.PositiveSmallIntegerField( default=1000 ) name = models.CharField( max_length=100, verbose_name='Name' ) source = models.CharField( max_length=500, verbose_name='Source URL' ) link = models.URLField( blank=True, verbose_name='Link URL' ) class Meta: ordering = ['type', 'weight', 'name'] def __str__(self): return self.name def embed_url(self, obj): template = Template(self.source) return template.render(Context({'obj': obj})) def embed_link(self, obj): if self.link is None: return '' template = Template(self.link) return template.render(Context({'obj': obj})) # # Export templates # @python_2_unicode_compatible class ExportTemplate(models.Model): content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE, limit_choices_to={'model__in': EXPORTTEMPLATE_MODELS} ) name = models.CharField( max_length=100 ) description = models.CharField( max_length=200, blank=True ) template_code = models.TextField() mime_type = models.CharField( max_length=15, blank=True ) file_extension = models.CharField( max_length=15, blank=True ) class Meta: ordering = ['content_type', 'name'] unique_together = [ ['content_type', 'name'] ] def __str__(self): return '{}: {}'.format(self.content_type, self.name) def render_to_response(self, queryset): """ Render the template to an HTTP response, delivered as a named file attachment """ template = Template(self.template_code) mime_type = 'text/plain' if not self.mime_type else self.mime_type output = template.render(Context({'queryset': queryset})) # Replace CRLF-style line terminators output = output.replace('\r\n', '\n') # Build the response response = HttpResponse(output, content_type=mime_type) filename = 'netbox_{}{}'.format( queryset.model._meta.verbose_name_plural, '.{}'.format(self.file_extension) if self.file_extension else '' ) response['Content-Disposition'] = 'attachment; filename="{}"'.format(filename) return response # # Topology maps # @python_2_unicode_compatible class TopologyMap(models.Model): name = models.CharField( max_length=50, unique=True ) slug = models.SlugField( unique=True ) type = models.PositiveSmallIntegerField( choices=TOPOLOGYMAP_TYPE_CHOICES, default=TOPOLOGYMAP_TYPE_NETWORK ) site = models.ForeignKey( to='dcim.Site', on_delete=models.CASCADE, related_name='topology_maps', blank=True, null=True ) device_patterns = models.TextField( help_text='Identify devices to include in the diagram using regular ' 'expressions, one per line. Each line will result in a new ' 'tier of the drawing. Separate multiple regexes within a ' 'line using semicolons. Devices will be rendered in the ' 'order they are defined.' ) description = models.CharField( max_length=100, blank=True ) class Meta: ordering = ['name'] def __str__(self): return self.name @property def device_sets(self): if not self.device_patterns: return None return [line.strip() for line in self.device_patterns.split('\n')] def render(self, img_format='png'): from dcim.models import Device # Construct the graph if self.type == TOPOLOGYMAP_TYPE_NETWORK: G = graphviz.Graph else: G = graphviz.Digraph self.graph = G() self.graph.graph_attr['ranksep'] = '1' seen = set() for i, device_set in enumerate(self.device_sets): subgraph = G(name='sg{}'.format(i)) subgraph.graph_attr['rank'] = 'same' subgraph.graph_attr['directed'] = 'true' # Add a pseudonode for each device_set to enforce hierarchical layout subgraph.node('set{}'.format(i), label='', shape='none', width='0') if i: self.graph.edge('set{}'.format(i - 1), 'set{}'.format(i), style='invis') # Add each device to the graph devices = [] for query in device_set.strip(';').split(';'): # Split regexes on semicolons devices += Device.objects.filter(name__regex=query).select_related('device_role') # Remove duplicate devices devices = [d for d in devices if d.id not in seen] seen.update([d.id for d in devices]) for d in devices: bg_color = '#{}'.format(d.device_role.color) fg_color = '#{}'.format(foreground_color(d.device_role.color)) subgraph.node(d.name, style='filled', fillcolor=bg_color, fontcolor=fg_color, fontname='sans') # Add an invisible connection to each successive device in a set to enforce horizontal order for j in range(0, len(devices) - 1): subgraph.edge(devices[j].name, devices[j + 1].name, style='invis') self.graph.subgraph(subgraph) # Compile list of all devices device_superset = Q() for device_set in self.device_sets: for query in device_set.split(';'): # Split regexes on semicolons device_superset = device_superset | Q(name__regex=query) devices = Device.objects.filter(*(device_superset,)) # Draw edges depending on graph type if self.type == TOPOLOGYMAP_TYPE_NETWORK: self.add_network_connections(devices) elif self.type == TOPOLOGYMAP_TYPE_CONSOLE: self.add_console_connections(devices) elif self.type == TOPOLOGYMAP_TYPE_POWER: self.add_power_connections(devices) return self.graph.pipe(format=img_format) def add_network_connections(self, devices): from circuits.models import CircuitTermination from dcim.models import InterfaceConnection # Add all interface connections to the graph connections = InterfaceConnection.objects.filter( interface_a__device__in=devices, interface_b__device__in=devices ) for c in connections: style = 'solid' if c.connection_status == CONNECTION_STATUS_CONNECTED else 'dashed' self.graph.edge(c.interface_a.device.name, c.interface_b.device.name, style=style) # Add all circuits to the graph for termination in CircuitTermination.objects.filter(term_side='A', interface__device__in=devices): peer_termination = termination.get_peer_termination() if (peer_termination is not None and peer_termination.interface is not None and peer_termination.interface.device in devices): self.graph.edge(termination.interface.device.name, peer_termination.interface.device.name, color='blue') def add_console_connections(self, devices): from dcim.models import ConsolePort # Add all console connections to the graph console_ports = ConsolePort.objects.filter(device__in=devices, cs_port__device__in=devices) for cp in console_ports: style = 'solid' if cp.connection_status == CONNECTION_STATUS_CONNECTED else 'dashed' self.graph.edge(cp.cs_port.device.name, cp.device.name, style=style) def add_power_connections(self, devices): from dcim.models import PowerPort # Add all power connections to the graph power_ports = PowerPort.objects.filter(device__in=devices, power_outlet__device__in=devices) for pp in power_ports: style = 'solid' if pp.connection_status == CONNECTION_STATUS_CONNECTED else 'dashed' self.graph.edge(pp.power_outlet.device.name, pp.device.name, style=style) # # Image attachments # def image_upload(instance, filename): path = 'image-attachments/' # Rename the file to the provided name, if any. Attempt to preserve the file extension. extension = filename.rsplit('.')[-1].lower() if instance.name and extension in ['bmp', 'gif', 'jpeg', 'jpg', 'png']: filename = '.'.join([instance.name, extension]) elif instance.name: filename = instance.name return '{}{}_{}_{}'.format(path, instance.content_type.name, instance.object_id, filename) @python_2_unicode_compatible class ImageAttachment(models.Model): """ An uploaded image which is associated with an object. """ content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE ) object_id = models.PositiveIntegerField() parent = GenericForeignKey( ct_field='content_type', fk_field='object_id' ) image = models.ImageField( upload_to=image_upload, height_field='image_height', width_field='image_width' ) image_height = models.PositiveSmallIntegerField() image_width = models.PositiveSmallIntegerField() name = models.CharField( max_length=50, blank=True ) created = models.DateTimeField( auto_now_add=True ) class Meta: ordering = ['name'] def __str__(self): if self.name: return self.name filename = self.image.name.rsplit('/', 1)[-1] return filename.split('_', 2)[2] def delete(self, *args, **kwargs): _name = self.image.name super(ImageAttachment, self).delete(*args, **kwargs) # Delete file from disk self.image.delete(save=False) # Deleting the file erases its name. We restore the image's filename here in case we still need to reference it # before the request finishes. (For example, to display a message indicating the ImageAttachment was deleted.) self.image.name = _name @property def size(self): """ Wrapper around `image.size` to suppress an OSError in case the file is inaccessible. """ try: return self.image.size except OSError: return None # # Report results # class ReportResult(models.Model): """ This model stores the results from running a user-defined report. """ report = models.CharField( max_length=255, unique=True ) created = models.DateTimeField( auto_now_add=True ) user = models.ForeignKey( to=User, on_delete=models.SET_NULL, related_name='+', blank=True, null=True ) failed = models.BooleanField() data = JSONField() class Meta: ordering = ['report'] # # User actions # class UserActionManager(models.Manager): # Actions affecting a single object def log_action(self, user, obj, action, message): self.model.objects.create( content_type=ContentType.objects.get_for_model(obj), object_id=obj.pk, user=user, action=action, message=message, ) def log_create(self, user, obj, message=''): self.log_action(user, obj, ACTION_CREATE, message) def log_edit(self, user, obj, message=''): self.log_action(user, obj, ACTION_EDIT, message) def log_delete(self, user, obj, message=''): self.log_action(user, obj, ACTION_DELETE, message) # Actions affecting multiple objects def log_bulk_action(self, user, content_type, action, message): self.model.objects.create( content_type=content_type, user=user, action=action, message=message, ) def log_import(self, user, content_type, message=''): self.log_bulk_action(user, content_type, ACTION_IMPORT, message) def log_bulk_create(self, user, content_type, message=''): self.log_bulk_action(user, content_type, ACTION_BULK_CREATE, message) def log_bulk_edit(self, user, content_type, message=''): self.log_bulk_action(user, content_type, ACTION_BULK_EDIT, message) def log_bulk_delete(self, user, content_type, message=''): self.log_bulk_action(user, content_type, ACTION_BULK_DELETE, message) @python_2_unicode_compatible class UserAction(models.Model): """ A record of an action (add, edit, or delete) performed on an object by a User. """ time = models.DateTimeField( auto_now_add=True, editable=False ) user = models.ForeignKey( to=User, on_delete=models.CASCADE, related_name='actions' ) content_type = models.ForeignKey( to=ContentType, on_delete=models.CASCADE ) object_id = models.PositiveIntegerField( blank=True, null=True ) action = models.PositiveSmallIntegerField( choices=ACTION_CHOICES ) message = models.TextField( blank=True ) objects = UserActionManager() class Meta: ordering = ['-time'] def __str__(self): if self.message: return '{} {}'.format(self.user, self.message) return '{} {} {}'.format(self.user, self.get_action_display(), self.content_type) def icon(self): if self.action in [ACTION_CREATE, ACTION_BULK_CREATE, ACTION_IMPORT]: return mark_safe('') elif self.action in [ACTION_EDIT, ACTION_BULK_EDIT]: return mark_safe('') elif self.action in [ACTION_DELETE, ACTION_BULK_DELETE]: return mark_safe('') else: return ''