models.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. from collections import OrderedDict
  2. from datetime import date
  3. from django.contrib.auth.models import User
  4. from django.contrib.contenttypes.fields import GenericForeignKey
  5. from django.contrib.contenttypes.models import ContentType
  6. from django.core.validators import ValidationError
  7. from django.db import models
  8. from django.http import HttpResponse
  9. from django.template import Template, Context
  10. from django.utils.safestring import mark_safe
  11. CUSTOMFIELD_MODELS = (
  12. 'site', 'rack', 'device', # DCIM
  13. 'aggregate', 'prefix', 'ipaddress', 'vlan', 'vrf', # IPAM
  14. 'provider', 'circuit', # Circuits
  15. 'tenant', # Tenants
  16. )
  17. CF_TYPE_TEXT = 100
  18. CF_TYPE_INTEGER = 200
  19. CF_TYPE_BOOLEAN = 300
  20. CF_TYPE_DATE = 400
  21. CF_TYPE_URL = 500
  22. CF_TYPE_SELECT = 600
  23. CUSTOMFIELD_TYPE_CHOICES = (
  24. (CF_TYPE_TEXT, 'Text'),
  25. (CF_TYPE_INTEGER, 'Integer'),
  26. (CF_TYPE_BOOLEAN, 'Boolean (true/false)'),
  27. (CF_TYPE_DATE, 'Date'),
  28. (CF_TYPE_URL, 'URL'),
  29. (CF_TYPE_SELECT, 'Selection'),
  30. )
  31. GRAPH_TYPE_INTERFACE = 100
  32. GRAPH_TYPE_PROVIDER = 200
  33. GRAPH_TYPE_SITE = 300
  34. GRAPH_TYPE_CHOICES = (
  35. (GRAPH_TYPE_INTERFACE, 'Interface'),
  36. (GRAPH_TYPE_PROVIDER, 'Provider'),
  37. (GRAPH_TYPE_SITE, 'Site'),
  38. )
  39. EXPORTTEMPLATE_MODELS = [
  40. 'site', 'rack', 'device', 'consoleport', 'powerport', 'interfaceconnection', # DCIM
  41. 'aggregate', 'prefix', 'ipaddress', 'vlan', # IPAM
  42. 'provider', 'circuit', # Circuits
  43. 'tenant', # Tenants
  44. ]
  45. ACTION_CREATE = 1
  46. ACTION_IMPORT = 2
  47. ACTION_EDIT = 3
  48. ACTION_BULK_EDIT = 4
  49. ACTION_DELETE = 5
  50. ACTION_BULK_DELETE = 6
  51. ACTION_CHOICES = (
  52. (ACTION_CREATE, 'created'),
  53. (ACTION_IMPORT, 'imported'),
  54. (ACTION_EDIT, 'modified'),
  55. (ACTION_BULK_EDIT, 'bulk edited'),
  56. (ACTION_DELETE, 'deleted'),
  57. (ACTION_BULK_DELETE, 'bulk deleted')
  58. )
  59. class CustomFieldModel(object):
  60. def custom_fields(self):
  61. # Find all custom fields applicable to this type of object
  62. content_type = ContentType.objects.get_for_model(self)
  63. fields = CustomField.objects.filter(obj_type=content_type)
  64. # If the object exists, populate its custom fields with values
  65. if hasattr(self, 'pk'):
  66. values = CustomFieldValue.objects.filter(obj_type=content_type, obj_id=self.pk).select_related('field')
  67. values_dict = {cfv.field_id: cfv.value for cfv in values}
  68. return OrderedDict([(field, values_dict.get(field.pk)) for field in fields])
  69. else:
  70. return OrderedDict([(field, None) for field in fields])
  71. class CustomField(models.Model):
  72. obj_type = models.ManyToManyField(ContentType, related_name='custom_fields', verbose_name='Object(s)',
  73. limit_choices_to={'model__in': CUSTOMFIELD_MODELS},
  74. help_text="The object(s) to which this field applies.")
  75. type = models.PositiveSmallIntegerField(choices=CUSTOMFIELD_TYPE_CHOICES, default=CF_TYPE_TEXT)
  76. name = models.CharField(max_length=50, unique=True)
  77. label = models.CharField(max_length=50, blank=True, help_text="Name of the field as displayed to users (if not "
  78. "provided, the field's name will be used)")
  79. description = models.CharField(max_length=100, blank=True)
  80. required = models.BooleanField(default=False, help_text="Determines whether this field is required when creating "
  81. "new objects or editing an existing object.")
  82. is_filterable = models.BooleanField(default=True, help_text="This field can be used to filter objects.")
  83. default = models.CharField(max_length=100, blank=True, help_text="Default value for the field. Use \"true\" or "
  84. "\"false\" for booleans. N/A for selection "
  85. "fields.")
  86. weight = models.PositiveSmallIntegerField(default=100, help_text="Fields with higher weights appear lower in a "
  87. "form")
  88. class Meta:
  89. ordering = ['weight', 'name']
  90. def __unicode__(self):
  91. return self.label or self.name.replace('_', ' ').capitalize()
  92. def serialize_value(self, value):
  93. """
  94. Serialize the given value to a string suitable for storage as a CustomFieldValue
  95. """
  96. if value is None:
  97. return ''
  98. if self.type == CF_TYPE_BOOLEAN:
  99. return str(int(bool(value)))
  100. if self.type == CF_TYPE_DATE:
  101. return value.strftime('%Y-%m-%d')
  102. if self.type == CF_TYPE_SELECT:
  103. # Could be ModelChoiceField or TypedChoiceField
  104. return str(value.id) if hasattr(value, 'id') else str(value)
  105. return str(value)
  106. def deserialize_value(self, serialized_value):
  107. """
  108. Convert a string into the object it represents depending on the type of field
  109. """
  110. if serialized_value is '':
  111. return None
  112. if self.type == CF_TYPE_INTEGER:
  113. return int(serialized_value)
  114. if self.type == CF_TYPE_BOOLEAN:
  115. return bool(int(serialized_value))
  116. if self.type == CF_TYPE_DATE:
  117. # Read date as YYYY-MM-DD
  118. return date(*[int(n) for n in serialized_value.split('-')])
  119. if self.type == CF_TYPE_SELECT:
  120. # return CustomFieldChoice.objects.get(pk=int(serialized_value))
  121. return self.choices.get(pk=int(serialized_value))
  122. return serialized_value
  123. class CustomFieldValue(models.Model):
  124. field = models.ForeignKey('CustomField', related_name='values')
  125. obj_type = models.ForeignKey(ContentType, related_name='+', on_delete=models.PROTECT)
  126. obj_id = models.PositiveIntegerField()
  127. obj = GenericForeignKey('obj_type', 'obj_id')
  128. serialized_value = models.CharField(max_length=255)
  129. class Meta:
  130. ordering = ['obj_type', 'obj_id']
  131. unique_together = ['field', 'obj_type', 'obj_id']
  132. def __unicode__(self):
  133. return '{} {}'.format(self.obj, self.field)
  134. @property
  135. def value(self):
  136. return self.field.deserialize_value(self.serialized_value)
  137. @value.setter
  138. def value(self, value):
  139. self.serialized_value = self.field.serialize_value(value)
  140. def save(self, *args, **kwargs):
  141. # Delete this object if it no longer has a value to store
  142. if self.pk and self.value is None:
  143. self.delete()
  144. else:
  145. super(CustomFieldValue, self).save(*args, **kwargs)
  146. class CustomFieldChoice(models.Model):
  147. field = models.ForeignKey('CustomField', related_name='choices', limit_choices_to={'type': CF_TYPE_SELECT},
  148. on_delete=models.CASCADE)
  149. value = models.CharField(max_length=100)
  150. weight = models.PositiveSmallIntegerField(default=100, help_text="Higher weights appear lower in the list")
  151. class Meta:
  152. ordering = ['field', 'weight', 'value']
  153. unique_together = ['field', 'value']
  154. def __unicode__(self):
  155. return self.value
  156. def clean(self):
  157. if self.field.type != CF_TYPE_SELECT:
  158. raise ValidationError("Custom field choices can only be assigned to selection fields.")
  159. class Graph(models.Model):
  160. type = models.PositiveSmallIntegerField(choices=GRAPH_TYPE_CHOICES)
  161. weight = models.PositiveSmallIntegerField(default=1000)
  162. name = models.CharField(max_length=100, verbose_name='Name')
  163. source = models.CharField(max_length=500, verbose_name='Source URL')
  164. link = models.URLField(verbose_name='Link URL', blank=True)
  165. class Meta:
  166. ordering = ['type', 'weight', 'name']
  167. def __unicode__(self):
  168. return self.name
  169. def embed_url(self, obj):
  170. template = Template(self.source)
  171. return template.render(Context({'obj': obj}))
  172. def embed_link(self, obj):
  173. if self.link is None:
  174. return ''
  175. template = Template(self.link)
  176. return template.render(Context({'obj': obj}))
  177. class ExportTemplate(models.Model):
  178. content_type = models.ForeignKey(ContentType, limit_choices_to={'model__in': EXPORTTEMPLATE_MODELS})
  179. name = models.CharField(max_length=200)
  180. template_code = models.TextField()
  181. mime_type = models.CharField(max_length=15, blank=True)
  182. file_extension = models.CharField(max_length=15, blank=True)
  183. class Meta:
  184. ordering = ['content_type', 'name']
  185. unique_together = [
  186. ['content_type', 'name']
  187. ]
  188. def __unicode__(self):
  189. return u'{}: {}'.format(self.content_type, self.name)
  190. def to_response(self, context_dict, filename):
  191. """
  192. Render the template to an HTTP response, delivered as a named file attachment
  193. """
  194. template = Template(self.template_code)
  195. mime_type = 'text/plain' if not self.mime_type else self.mime_type
  196. output = template.render(Context(context_dict))
  197. # Replace CRLF-style line terminators
  198. output = output.replace('\r\n', '\n')
  199. response = HttpResponse(output, content_type=mime_type)
  200. if self.file_extension:
  201. filename += '.{}'.format(self.file_extension)
  202. response['Content-Disposition'] = 'attachment; filename="{}"'.format(filename)
  203. return response
  204. class TopologyMap(models.Model):
  205. name = models.CharField(max_length=50, unique=True)
  206. slug = models.SlugField(unique=True)
  207. site = models.ForeignKey('dcim.Site', related_name='topology_maps', blank=True, null=True)
  208. device_patterns = models.TextField(help_text="Identify devices to include in the diagram using regular expressions,"
  209. "one per line. Each line will result in a new tier of the drawing. "
  210. "Separate multiple regexes on a line using commas. Devices will be "
  211. "rendered in the order they are defined.")
  212. description = models.CharField(max_length=100, blank=True)
  213. class Meta:
  214. ordering = ['name']
  215. def __unicode__(self):
  216. return self.name
  217. @property
  218. def device_sets(self):
  219. if not self.device_patterns:
  220. return None
  221. return [line.strip() for line in self.device_patterns.split('\n')]
  222. class UserActionManager(models.Manager):
  223. # Actions affecting a single object
  224. def log_action(self, user, obj, action, message):
  225. self.model.objects.create(
  226. content_type=ContentType.objects.get_for_model(obj),
  227. object_id=obj.pk,
  228. user=user,
  229. action=action,
  230. message=message,
  231. )
  232. def log_create(self, user, obj, message=''):
  233. self.log_action(user, obj, ACTION_CREATE, message)
  234. def log_edit(self, user, obj, message=''):
  235. self.log_action(user, obj, ACTION_EDIT, message)
  236. def log_delete(self, user, obj, message=''):
  237. self.log_action(user, obj, ACTION_DELETE, message)
  238. # Actions affecting multiple objects
  239. def log_bulk_action(self, user, content_type, action, message):
  240. self.model.objects.create(
  241. content_type=content_type,
  242. user=user,
  243. action=action,
  244. message=message,
  245. )
  246. def log_import(self, user, content_type, message=''):
  247. self.log_bulk_action(user, content_type, ACTION_IMPORT, message)
  248. def log_bulk_edit(self, user, content_type, message=''):
  249. self.log_bulk_action(user, content_type, ACTION_BULK_EDIT, message)
  250. def log_bulk_delete(self, user, content_type, message=''):
  251. self.log_bulk_action(user, content_type, ACTION_BULK_DELETE, message)
  252. class UserAction(models.Model):
  253. """
  254. A record of an action (add, edit, or delete) performed on an object by a User.
  255. """
  256. time = models.DateTimeField(auto_now_add=True, editable=False)
  257. user = models.ForeignKey(User, related_name='actions', on_delete=models.CASCADE)
  258. content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
  259. object_id = models.PositiveIntegerField(blank=True, null=True)
  260. action = models.PositiveSmallIntegerField(choices=ACTION_CHOICES)
  261. message = models.TextField(blank=True)
  262. objects = UserActionManager()
  263. class Meta:
  264. ordering = ['-time']
  265. def __unicode__(self):
  266. if self.message:
  267. return u'{} {}'.format(self.user, self.message)
  268. return u'{} {} {}'.format(self.user, self.get_action_display(), self.content_type)
  269. def icon(self):
  270. if self.action in [ACTION_CREATE, ACTION_IMPORT]:
  271. return mark_safe('<i class="glyphicon glyphicon-plus text-success"></i>')
  272. elif self.action in [ACTION_EDIT, ACTION_BULK_EDIT]:
  273. return mark_safe('<i class="glyphicon glyphicon-pencil text-warning"></i>')
  274. elif self.action in [ACTION_DELETE, ACTION_BULK_DELETE]:
  275. return mark_safe('<i class="glyphicon glyphicon-remove text-danger"></i>')
  276. else:
  277. return ''