1 from django import forms
2 from django.db import models
3 from django.contrib.contenttypes.models import ContentType
4 from django.contrib.contenttypes import generic
5 from django.utils import simplejson as json
6 from django.core.exceptions import ObjectDoesNotExist
7 from philo.exceptions import AncestorDoesNotExist
8 from philo.models.fields import JSONField
9 from philo.utils import ContentTypeRegistryLimiter, ContentTypeSubclassLimiter
10 from philo.signals import entity_class_prepared
11 from philo.validators import json_validator
12 from UserDict import DictMixin
15 class Tag(models.Model):
16 name = models.CharField(max_length=255)
17 slug = models.SlugField(max_length=255, unique=True)
19 def __unicode__(self):
26 class Titled(models.Model):
27 title = models.CharField(max_length=255)
28 slug = models.SlugField(max_length=255)
30 def __unicode__(self):
37 value_content_type_limiter = ContentTypeRegistryLimiter()
40 def register_value_model(model):
41 value_content_type_limiter.register_class(model)
44 def unregister_value_model(model):
45 value_content_type_limiter.unregister_class(model)
48 class AttributeValue(models.Model):
49 attribute = generic.GenericRelation('Attribute', content_type_field='value_content_type', object_id_field='value_object_id')
50 def apply_data(self, data):
51 raise NotImplementedError
53 def value_formfield(self, **kwargs):
54 raise NotImplementedError
56 def __unicode__(self):
57 return unicode(self.value)
63 attribute_value_limiter = ContentTypeSubclassLimiter(AttributeValue)
66 class JSONValue(AttributeValue):
67 value = JSONField() #verbose_name='Value (JSON)', help_text='This value must be valid JSON.')
69 def __unicode__(self):
70 return self.value_json
72 def value_formfield(self, **kwargs):
73 kwargs['initial'] = self.value_json
74 return self._meta.get_field('value').formfield(**kwargs)
76 def apply_data(self, cleaned_data):
77 self.value = cleaned_data.get('value', None)
83 class ForeignKeyValue(AttributeValue):
84 content_type = models.ForeignKey(ContentType, related_name='foreign_key_value_set', limit_choices_to=value_content_type_limiter, verbose_name='Value type', null=True, blank=True)
85 object_id = models.PositiveIntegerField(verbose_name='Value ID', null=True, blank=True)
86 value = generic.GenericForeignKey()
88 def value_formfield(self, form_class=forms.ModelChoiceField, **kwargs):
89 if self.content_type is None:
91 kwargs.update({'initial': self.object_id, 'required': False})
92 return form_class(self.content_type.model_class()._default_manager.all(), **kwargs)
94 def apply_data(self, cleaned_data):
95 if 'value' in cleaned_data and cleaned_data['value'] is not None:
96 self.value = cleaned_data['value']
98 self.content_type = cleaned_data.get('content_type', None)
99 # If there is no value set in the cleaned data, clear the stored value.
100 self.object_id = None
106 class ManyToManyValue(AttributeValue):
107 # TODO: Change object_ids to object_pks.
108 content_type = models.ForeignKey(ContentType, related_name='many_to_many_value_set', limit_choices_to=value_content_type_limiter, verbose_name='Value type', null=True, blank=True)
109 object_ids = models.CommaSeparatedIntegerField(max_length=300, verbose_name='Value IDs', null=True, blank=True)
111 def get_object_id_list(self):
112 if not self.object_ids:
115 return self.object_ids.split(',')
118 if self.content_type is None:
121 return self.content_type.model_class()._default_manager.filter(id__in=self.get_object_id_list())
123 def set_value(self, value):
127 if not isinstance(value, models.query.QuerySet):
128 raise TypeError("Value must be a QuerySet.")
129 self.content_type = ContentType.objects.get_for_model(value.model)
130 self.object_ids = ','.join([`value` for value in value.values_list('id', flat=True)])
132 value = property(get_value, set_value)
134 def value_formfield(self, form_class=forms.ModelMultipleChoiceField, **kwargs):
135 if self.content_type is None:
137 kwargs.update({'initial': self.get_object_id_list(), 'required': False})
138 return form_class(self.content_type.model_class()._default_manager.all(), **kwargs)
140 def apply_data(self, cleaned_data):
141 if 'value' in cleaned_data and cleaned_data['value'] is not None:
142 self.value = cleaned_data['value']
144 self.content_type = cleaned_data.get('content_type', None)
145 # If there is no value set in the cleaned data, clear the stored value.
152 class Attribute(models.Model):
153 entity_content_type = models.ForeignKey(ContentType, related_name='attribute_entity_set', verbose_name='Entity type')
154 entity_object_id = models.PositiveIntegerField(verbose_name='Entity ID')
155 entity = generic.GenericForeignKey('entity_content_type', 'entity_object_id')
157 value_content_type = models.ForeignKey(ContentType, related_name='attribute_value_set', limit_choices_to=attribute_value_limiter, verbose_name='Value type', null=True, blank=True)
158 value_object_id = models.PositiveIntegerField(verbose_name='Value ID', null=True, blank=True)
159 value = generic.GenericForeignKey('value_content_type', 'value_object_id')
161 key = models.CharField(max_length=255)
163 def __unicode__(self):
164 return u'"%s": %s' % (self.key, self.value)
168 unique_together = (('key', 'entity_content_type', 'entity_object_id'), ('value_content_type', 'value_object_id'))
171 class QuerySetMapper(object, DictMixin):
172 def __init__(self, queryset, passthrough=None):
173 self.queryset = queryset
174 self.passthrough = passthrough
176 def __getitem__(self, key):
178 return self.queryset.get(key__exact=key).value
179 except ObjectDoesNotExist:
180 if self.passthrough is not None:
181 return self.passthrough.__getitem__(key)
185 keys = set(self.queryset.values_list('key', flat=True).distinct())
186 if self.passthrough is not None:
187 keys |= set(self.passthrough.keys())
191 class EntityOptions(object):
192 def __init__(self, options):
193 if options is not None:
194 for key, value in options.__dict__.items():
195 setattr(self, key, value)
196 if not hasattr(self, 'proxy_fields'):
197 self.proxy_fields = []
199 def add_proxy_field(self, proxy_field):
200 self.proxy_fields.append(proxy_field)
203 class EntityBase(models.base.ModelBase):
204 def __new__(cls, name, bases, attrs):
205 new = super(EntityBase, cls).__new__(cls, name, bases, attrs)
206 entity_options = attrs.pop('EntityMeta', None)
207 setattr(new, '_entity_meta', EntityOptions(entity_options))
208 entity_class_prepared.send(sender=new)
212 class Entity(models.Model):
213 __metaclass__ = EntityBase
215 attribute_set = generic.GenericRelation(Attribute, content_type_field='entity_content_type', object_id_field='entity_object_id')
218 def attributes(self):
219 return QuerySetMapper(self.attribute_set)
222 def _added_attribute_registry(self):
223 if not hasattr(self, '_real_added_attribute_registry'):
224 self._real_added_attribute_registry = {}
225 return self._real_added_attribute_registry
228 def _removed_attribute_registry(self):
229 if not hasattr(self, '_real_removed_attribute_registry'):
230 self._real_removed_attribute_registry = []
231 return self._real_removed_attribute_registry
233 def save(self, *args, **kwargs):
234 super(Entity, self).save(*args, **kwargs)
236 for key in self._removed_attribute_registry:
237 self.attribute_set.filter(key__exact=key).delete()
238 del self._removed_attribute_registry[:]
240 for field, value in self._added_attribute_registry.items():
242 attribute = self.attribute_set.get(key__exact=field.key)
243 except Attribute.DoesNotExist:
244 attribute = Attribute()
245 attribute.entity = self
246 attribute.key = field.key
248 field.set_attribute_value(attribute, value)
250 self._added_attribute_registry.clear()
256 class TreeManager(models.Manager):
257 use_for_related_fields = True
260 return self.filter(parent__isnull=True)
262 def get_with_path(self, path, root=None, absolute_result=True, pathsep='/'):
264 Returns the object with the path, or None if there is no object with that path,
265 unless absolute_result is set to False, in which case it returns a tuple containing
266 the deepest object found along the path, and the remainder of the path after that
267 object as a string (or None in the case that there is no remaining path).
269 slugs = path.split(pathsep)
271 remaining_slugs = list(slugs)
274 remaining_slugs.remove(slug)
275 if slug: # ignore blank slugs, handles for multiple consecutive pathseps
277 obj = self.get(slug__exact=slug, parent__exact=obj)
278 except self.model.DoesNotExist:
281 remaining_slugs.insert(0, slug)
282 remainder = pathsep.join(remaining_slugs)
288 return (obj, remainder)
289 raise self.model.DoesNotExist('%s matching query does not exist.' % self.model._meta.object_name)
292 class TreeModel(models.Model):
293 objects = TreeManager()
294 parent = models.ForeignKey('self', related_name='children', null=True, blank=True)
295 slug = models.SlugField(max_length=255)
297 def has_ancestor(self, ancestor):
300 if parent == ancestor:
302 parent = parent.parent
305 def get_path(self, root=None, pathsep='/', field='slug'):
307 if not self.has_ancestor(root):
308 raise AncestorDoesNotExist(root)
311 while parent and parent != root:
312 path = getattr(parent, field, '?') + pathsep + path
313 parent = parent.parent
316 path = getattr(self, field, '?')
318 while parent and parent != root:
319 path = getattr(parent, field, '?') + pathsep + path
320 parent = parent.parent
322 path = property(get_path)
324 def __unicode__(self):
328 unique_together = (('parent', 'slug'),)
332 class TreeEntity(Entity, TreeModel):
334 def attributes(self):
336 return QuerySetMapper(self.attribute_set, passthrough=self.parent.attributes)
337 return super(TreeEntity, self).attributes
340 def relationships(self):
342 return QuerySetMapper(self.relationship_set, passthrough=self.parent.relationships)
343 return super(TreeEntity, self).relationships