1 from django import forms
2 from django.contrib.admin.widgets import AdminTextareaWidget
3 from django.core.exceptions import ValidationError, ObjectDoesNotExist
4 from django.db.models import Q
5 from django.forms.models import model_to_dict, fields_for_model, ModelFormMetaclass, ModelForm, BaseInlineFormSet
6 from django.forms.formsets import TOTAL_FORM_COUNT
7 from django.template import loader, loader_tags, TemplateDoesNotExist, Context, Template as DjangoTemplate
8 from django.utils.datastructures import SortedDict
9 from philo.admin.widgets import ModelLookupWidget
10 from philo.models import Entity, Template, Contentlet, ContentReference
11 from philo.models.fields import RelationshipField
12 from philo.utils import fattr
15 __all__ = ('EntityForm', )
18 def proxy_fields_for_entity_model(entity_model, fields=None, exclude=None, widgets=None, formfield_callback=lambda f, **kwargs: f.formfield(**kwargs)):
21 opts = entity_model._entity_meta
22 for f in opts.proxy_fields:
23 if fields and not f.name in fields:
25 if exclude and f.name in exclude:
27 if widgets and f.name in widgets:
28 kwargs = {'widget': widgets[f.name]}
31 formfield = formfield_callback(f, **kwargs)
33 field_list.append((f.name, formfield))
35 ignored.append(f.name)
36 field_dict = SortedDict(field_list)
38 field_dict = SortedDict(
39 [(f, field_dict.get(f)) for f in fields
40 if ((not exclude) or (exclude and f not in exclude)) and (f not in ignored) and (f in field_dict)]
45 # BEGIN HACK - This will not be required after http://code.djangoproject.com/ticket/14082 has been resolved
47 class EntityFormBase(ModelForm):
50 _old_metaclass_new = ModelFormMetaclass.__new__
52 def _new_metaclass_new(cls, name, bases, attrs):
53 new_class = _old_metaclass_new(cls, name, bases, attrs)
54 if issubclass(new_class, EntityFormBase) and new_class._meta.model:
55 new_class.base_fields.update(proxy_fields_for_entity_model(new_class._meta.model, new_class._meta.fields, new_class._meta.exclude, new_class._meta.widgets)) # don't pass in formfield_callback
58 ModelFormMetaclass.__new__ = staticmethod(_new_metaclass_new)
63 class EntityForm(EntityFormBase): # Would inherit from ModelForm directly if it weren't for the above HACK
64 def __init__(self, *args, **kwargs):
65 initial = kwargs.pop('initial', None)
66 instance = kwargs.get('instance', None)
67 if instance is not None:
69 for f in instance._entity_meta.proxy_fields:
70 if self._meta.fields and not f.name in self._meta.fields:
72 if self._meta.exclude and f.name in self._meta.exclude:
74 new_initial[f.name] = f.value_from_object(instance)
77 if initial is not None:
78 new_initial.update(initial)
79 kwargs['initial'] = new_initial
80 super(EntityForm, self).__init__(*args, **kwargs)
82 @fattr(alters_data=True)
83 def save(self, commit=True):
84 cleaned_data = self.cleaned_data
85 instance = super(EntityForm, self).save(commit=False)
87 for f in instance._entity_meta.proxy_fields:
88 if self._meta.fields and f.name not in self._meta.fields:
90 setattr(instance, f.attname, cleaned_data[f.name])
99 class ContainerForm(ModelForm):
100 def __init__(self, *args, **kwargs):
101 super(ContainerForm, self).__init__(*args, **kwargs)
102 self.verbose_name = self.instance.name.replace('_', ' ')
105 class ContentletForm(ContainerForm):
106 content = forms.CharField(required=False, widget=AdminTextareaWidget, label='Content')
108 def should_delete(self):
109 return not bool(self.cleaned_data['content'])
113 fields = ['name', 'content']
116 class ContentReferenceForm(ContainerForm):
117 def __init__(self, *args, **kwargs):
118 super(ContentReferenceForm, self).__init__(*args, **kwargs)
120 self.fields['content_id'].widget = ModelLookupWidget(self.instance.content_type)
121 except ObjectDoesNotExist:
122 # This will happen when an empty form (which we will never use) gets instantiated.
125 def should_delete(self):
126 return (self.cleaned_data['content_id'] is None)
129 model = ContentReference
130 fields = ['name', 'content_id']
133 class ContainerInlineFormSet(BaseInlineFormSet):
134 def __init__(self, containers, data=None, files=None, instance=None, save_as_new=False, prefix=None, queryset=None):
135 # Unfortunately, I need to add some things to BaseInline between its __init__ and its
136 # super call, so a lot of this is repetition.
138 # Start cribbed from BaseInline
139 from django.db.models.fields.related import RelatedObject
140 self.save_as_new = save_as_new
141 # is there a better way to get the object descriptor?
142 self.rel_name = RelatedObject(self.fk.rel.to, self.model, self.fk).get_accessor_name()
143 if self.fk.rel.field_name == self.fk.rel.to._meta.pk.name:
144 backlink_value = self.instance
146 backlink_value = getattr(self.instance, self.fk.rel.field_name)
148 queryset = self.model._default_manager
149 qs = queryset.filter(**{self.fk.name: backlink_value})
150 # End cribbed from BaseInline
152 self.container_instances, qs = self.get_container_instances(containers, qs)
153 self.extra_containers = containers
154 self.extra = len(self.extra_containers)
155 super(BaseInlineFormSet, self).__init__(data, files, prefix=prefix, queryset=qs)
157 def get_container_instances(self, containers, qs):
158 raise NotImplementedError
160 def total_form_count(self):
161 if self.data or self.files:
162 return self.management_form.cleaned_data[TOTAL_FORM_COUNT]
164 return self.initial_form_count() + self.extra
166 def save_existing_objects(self, commit=True):
167 self.changed_objects = []
168 self.deleted_objects = []
169 if not self.get_queryset():
173 for form in self.initial_forms:
174 pk_name = self._pk_field.name
175 raw_pk_value = form._raw_value(pk_name)
177 # clean() for different types of PK fields can sometimes return
178 # the model instance, and sometimes the PK. Handle either.
179 pk_value = form.fields[pk_name].clean(raw_pk_value)
180 pk_value = getattr(pk_value, 'pk', pk_value)
182 obj = self._existing_object(pk_value)
183 if form.should_delete():
184 self.deleted_objects.append(obj)
187 if form.has_changed():
188 self.changed_objects.append((obj, form.changed_data))
189 saved_instances.append(self.save_existing(form, obj, commit=commit))
191 self.saved_forms.append(form)
192 return saved_instances
194 def save_new_objects(self, commit=True):
195 self.new_objects = []
196 for form in self.extra_forms:
197 if not form.has_changed():
199 # If someone has marked an add form for deletion, don't save the
201 if form.should_delete():
203 self.new_objects.append(self.save_new(form, commit=commit))
205 self.saved_forms.append(form)
206 return self.new_objects
209 class ContentletInlineFormSet(ContainerInlineFormSet):
210 def __init__(self, data=None, files=None, instance=None, save_as_new=False, prefix=None, queryset=None):
212 self.instance = self.fk.rel.to()
214 self.instance = instance
217 containers = list(self.instance.containers[0])
218 except ObjectDoesNotExist:
221 super(ContentletInlineFormSet, self).__init__(containers, data, files, instance, save_as_new, prefix, queryset)
223 def get_container_instances(self, containers, qs):
224 qs = qs.filter(name__in=containers)
225 container_instances = []
227 container_instances.append(container)
228 containers.remove(container.name)
229 return container_instances, qs
231 def _construct_form(self, i, **kwargs):
232 if i >= self.initial_form_count(): # and not kwargs.get('instance'):
233 kwargs['instance'] = self.model(name=self.extra_containers[i - self.initial_form_count() - 1])
235 return super(ContentletInlineFormSet, self)._construct_form(i, **kwargs)
238 class ContentReferenceInlineFormSet(ContainerInlineFormSet):
239 def __init__(self, data=None, files=None, instance=None, save_as_new=False, prefix=None, queryset=None):
241 self.instance = self.fk.rel.to()
243 self.instance = instance
246 containers = list(self.instance.containers[1])
247 except ObjectDoesNotExist:
250 super(ContentReferenceInlineFormSet, self).__init__(containers, data, files, instance, save_as_new, prefix, queryset)
252 def get_container_instances(self, containers, qs):
255 for name, ct in containers:
256 filter |= Q(name=name, content_type=ct)
258 qs = qs.filter(filter)
259 container_instances = []
261 container_instances.append(container)
262 containers.remove((container.name, container.content_type))
263 return container_instances, qs
265 def _construct_form(self, i, **kwargs):
266 if i >= self.initial_form_count(): # and not kwargs.get('instance'):
267 name, content_type = self.extra_containers[i - self.initial_form_count() - 1]
268 kwargs['instance'] = self.model(name=name, content_type=content_type)
270 return super(ContentReferenceInlineFormSet, self)._construct_form(i, **kwargs)