forms.py

   1 from django.core.exceptions import ValidationError, ObjectDoesNotExist
   2 from django.forms.models import model_to_dict, fields_for_model, ModelFormMetaclass, ModelForm, BaseInlineFormSet
   3 from django.forms.formsets import TOTAL_FORM_COUNT
   4 from django.template import loader, loader_tags, TemplateDoesNotExist, Context, Template as DjangoTemplate
   5 from django.utils.datastructures import SortedDict
   6 from philo.models import Entity, Template, Contentlet, ContentReference
   7 from philo.models.fields import RelationshipField
   8 from philo.utils import fattr
   9
  10
  11 __all__ = ('EntityForm', )
  12
  13
  14 def proxy_fields_for_entity_model(entity_model, fields=None, exclude=None, widgets=None, formfield_callback=lambda f, **kwargs: f.formfield(**kwargs)):
  15         field_list = []
  16         ignored = []
  17         opts = entity_model._entity_meta
  18         for f in opts.proxy_fields:
  19                 if fields and not f.name in fields:
  20                         continue
  21                 if exclude and f.name in exclude:
  22                         continue
  23                 if widgets and f.name in widgets:
  24                         kwargs = {'widget': widgets[f.name]}
  25                 else:
  26                         kwargs = {}
  27                 formfield = formfield_callback(f, **kwargs)
  28                 if formfield:
  29                         field_list.append((f.name, formfield))
  30                 else:
  31                         ignored.append(f.name)
  32         field_dict = SortedDict(field_list)
  33         if fields:
  34                 field_dict = SortedDict(
  35                         [(f, field_dict.get(f)) for f in fields
  36                                 if ((not exclude) or (exclude and f not in exclude)) and (f not in ignored) and (f in field_dict)]
  37                 )
  38         return field_dict
  39
  40
  41 # BEGIN HACK - This will not be required after http://code.djangoproject.com/ticket/14082 has been resolved
  42
  43 class EntityFormBase(ModelForm):
  44         pass
  45
  46 _old_metaclass_new = ModelFormMetaclass.__new__
  47
  48 def _new_metaclass_new(cls, name, bases, attrs):
  49         new_class = _old_metaclass_new(cls, name, bases, attrs)
  50         if issubclass(new_class, EntityFormBase) and new_class._meta.model:
  51                 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
  52         return new_class
  53
  54 ModelFormMetaclass.__new__ = staticmethod(_new_metaclass_new)
  55
  56 # END HACK
  57
  58
  59 class EntityForm(EntityFormBase): # Would inherit from ModelForm directly if it weren't for the above HACK
  60         def __init__(self, *args, **kwargs):
  61                 initial = kwargs.pop('initial', None)
  62                 instance = kwargs.get('instance', None)
  63                 if instance is not None:
  64                         new_initial = {}
  65                         for f in instance._entity_meta.proxy_fields:
  66                                 if self._meta.fields and not f.name in self._meta.fields:
  67                                         continue
  68                                 if self._meta.exclude and f.name in self._meta.exclude:
  69                                         continue
  70                                 new_initial[f.name] = f.value_from_object(instance)
  71                 else:
  72                         new_initial = {}
  73                 if initial is not None:
  74                         new_initial.update(initial)
  75                 kwargs['initial'] = new_initial
  76                 super(EntityForm, self).__init__(*args, **kwargs)
  77
  78         @fattr(alters_data=True)
  79         def save(self, commit=True):
  80                 cleaned_data = self.cleaned_data
  81                 instance = super(EntityForm, self).save(commit=False)
  82
  83                 for f in instance._entity_meta.proxy_fields:
  84                         if self._meta.fields and f.name not in self._meta.fields:
  85                                 continue
  86                         setattr(instance, f.attname, cleaned_data[f.name])
  87
  88                 if commit:
  89                         instance.save()
  90                         self.save_m2m()
  91
  92                 return instance
  93
  94
  95 def validate_template(template):
  96         """
  97         Makes sure that the template and all included or extended templates are valid.
  98         """
  99         for node in template.nodelist:
 100                 try:
 101                         if isinstance(node, loader_tags.ExtendsNode):
 102                                 extended_template = node.get_parent(Context())
 103                                 validate_template(extended_template)
 104                         elif isinstance(node, loader_tags.IncludeNode):
 105                                 included_template = loader.get_template(node.template_name.resolve(Context()))
 106                                 validate_template(extended_template)
 107                 except Exception, e:
 108                         raise ValidationError("Template code invalid. Error was: %s: %s" % (e.__class__.__name__, e))
 109
 110
 111 class TemplateForm(ModelForm):
 112         def clean_code(self):
 113                 code = self.cleaned_data['code']
 114                 try:
 115                         t = DjangoTemplate(code)
 116                 except Exception, e:
 117                         raise ValidationError("Template code invalid. Error was: %s: %s" % (e.__class__.__name__, e))
 118
 119                 validate_template(t)
 120                 return code
 121
 122         class Meta:
 123                 model = Template
 124
 125
 126 class ContainerForm(ModelForm):
 127         def __init__(self, *args, **kwargs):
 128                 super(ContainerForm, self).__init__(*args, **kwargs)
 129                 self.verbose_name = self.instance.name.replace('_', ' ')
 130
 131
 132 class ContentletForm(ContainerForm):
 133         class Meta:
 134                 model = Contentlet
 135                 fields = ['name', 'content', 'dynamic']
 136
 137
 138 class ContentReferenceForm(ContainerForm):
 139         class Meta:
 140                 model = ContentReference
 141                 fields = ['name', 'content_id']
 142
 143
 144 class ContainerInlineFormSet(BaseInlineFormSet):
 145         def __init__(self, containers, data=None, files=None, instance=None, save_as_new=False, prefix=None, queryset=None):
 146                 # Unfortunately, I need to add some things to BaseInline between its __init__ and its super call, so
 147                 # a lot of this is repetition.
 148
 149                 # Start cribbed from BaseInline
 150                 from django.db.models.fields.related import RelatedObject
 151                 self.save_as_new = save_as_new
 152                 # is there a better way to get the object descriptor?
 153                 self.rel_name = RelatedObject(self.fk.rel.to, self.model, self.fk).get_accessor_name()
 154                 if self.fk.rel.field_name == self.fk.rel.to._meta.pk.name:
 155                         backlink_value = self.instance
 156                 else:
 157                         backlink_value = getattr(self.instance, self.fk.rel.field_name)
 158                 if queryset is None:
 159                         queryset = self.model._default_manager
 160                 qs = queryset.filter(**{self.fk.name: backlink_value})
 161                 # End cribbed from BaseInline
 162
 163                 self.container_instances, qs = self.get_container_instances(containers, qs)
 164                 self.extra_containers = containers
 165                 self.extra = len(self.extra_containers)
 166                 super(BaseInlineFormSet, self).__init__(data, files, prefix=prefix, queryset=qs)
 167
 168         def get_container_instances(self, containers, qs):
 169                 raise NotImplementedError
 170
 171         def total_form_count(self):
 172                 if self.data or self.files:
 173                         return self.management_form.cleaned_data[TOTAL_FORM_COUNT]
 174                 else:
 175                         return self.initial_form_count() + self.extra
 176
 177
 178 class ContentletInlineFormSet(ContainerInlineFormSet):
 179         def __init__(self, data=None, files=None, instance=None, save_as_new=False, prefix=None, queryset=None):
 180                 if instance is None:
 181                         self.instance = self.fk.rel.to()
 182                         containers = []
 183                 else:
 184                         self.instance = instance
 185                         containers = list(self.instance.containers[0])
 186
 187                 super(ContentletInlineFormSet, self).__init__(containers, data, files, instance, save_as_new, prefix, queryset)
 188
 189         def get_container_instances(self, containers, qs):
 190                 qs = qs.filter(name__in=containers)
 191                 container_instances = []
 192                 for container in qs:
 193                         container_instances.append(container)
 194                         containers.remove(container.name)
 195                 return container_instances, qs
 196
 197         def _construct_form(self, i, **kwargs):
 198                 if i >= self.initial_form_count(): # and not kwargs.get('instance'):
 199                         kwargs['instance'] = self.model(name=self.extra_containers[i - self.initial_form_count() - 1])
 200
 201                 return super(ContentletInlineFormSet, self)._construct_form(i, **kwargs)
 202
 203
 204 class ContentReferenceInlineFormSet(ContainerInlineFormSet):
 205         def __init__(self, data=None, files=None, instance=None, save_as_new=False, prefix=None, queryset=None):
 206                 if instance is None:
 207                         self.instance = self.fk.rel.to()
 208                         containers = []
 209                 else:
 210                         self.instance = instance
 211                         containers = list(self.instance.containers[1])
 212
 213                 super(ContentReferenceInlineFormSet, self).__init__(containers, data, files, instance, save_as_new, prefix, queryset)
 214
 215         def get_container_instances(self, containers, qs):
 216                 qs = qs.filter(name__in=[c[0] for c in containers])
 217                 container_instances = []
 218                 for container in qs:
 219                         container_instances.append(container)
 220                         containers.remove((container.name, container.content_type))
 221                 return container_instances, qs
 222
 223         def _construct_form(self, i, **kwargs):
 224                 if i >= self.initial_form_count(): # and not kwargs.get('instance'):
 225                         name, content_type = self.extra_containers[i - self.initial_form_count() - 1]
 226                         kwargs['instance'] = self.model(name=name, content_type=content_type)
 227
 228                 return super(ContentReferenceInlineFormSet, self)._construct_form(i, **kwargs)