Removed referential integrity code. Moved embed templatetag into core. Differentiated...
[philo.git] / templatetags / embed.py
diff --git a/templatetags/embed.py b/templatetags/embed.py
new file mode 100644 (file)
index 0000000..c0fcff0
--- /dev/null
@@ -0,0 +1,174 @@
+from django import template
+from django.contrib.contenttypes.models import ContentType
+from django.conf import settings
+from philo.utils import LOADED_TEMPLATE_ATTR
+
+
+register = template.Library()
+
+
+class ConstantEmbedNode(template.Node):
+       """Analogous to the ConstantIncludeNode, this node precompiles several variables necessary for correct rendering - namely the referenced instance or the included template."""
+       def __init__(self, content_type, varname, object_pk=None, template_name=None, kwargs=None):
+               assert template_name is not None or object_pk is not None
+               self.content_type = content_type
+               self.varname = varname
+               
+               kwargs = kwargs or {}
+               for k, v in kwargs.items():
+                       kwargs[k] = template.Variable(v)
+               self.kwargs = kwargs
+               
+               if object_pk is not None:
+                       self.compile_instance(object_pk)
+                       if self.instance is False and settings.TEMPLATE_DEBUG:
+                               raise
+               else:
+                       self.instance = None
+               
+               if template_name is not None:
+                       self.compile_template(template_name[1:-1])
+                       if self.template is False and settings.TEMPLATE_DEBUG:
+                               raise
+               else:
+                       self.template = None
+       
+       def compile_instance(self, object_pk):
+               self.object_pk = object_pk
+               model = self.content_type.model_class()
+               try:
+                       self.instance = model.objects.get(pk=object_pk)
+               except model.DoesNotExist:
+                       self.instance = False
+       
+       def compile_template(self, template_name):
+               try:
+                       self.template = template.loader.get_template(template_name)
+               except template.TemplateDoesNotExist:
+                       self.template = False
+       
+       def render(self, context):
+               if self.template is not None:
+                       if self.template is False:
+                               return settings.TEMPLATE_STRING_IF_INVALID
+                       
+                       if self.varname not in context:
+                               context[self.varname] = {}
+                       context[self.varname][self.content_type] = self.template
+                       
+                       return ''
+               
+               # Otherwise self.instance should be set. Render the instance with the appropriate template!
+               if self.instance is None or self.instance is False:
+                       return settings.TEMPLATE_STRING_IF_INVALID
+               
+               return self.render_template(context, self.instance)
+       
+       def render_template(self, context, instance):
+               try:
+                       t = context[self.varname][self.content_type]
+               except KeyError:
+                       return settings.TEMPLATE_STRING_IF_INVALID
+               
+               context.push()
+               context['embedded'] = instance
+               kwargs = {}
+               for k, v in self.kwargs.items():
+                       kwargs[k] = v.resolve(context)
+               context.update(kwargs)
+               t_rendered = t.render(context)
+               context.pop()
+               return t_rendered
+
+
+class EmbedNode(ConstantEmbedNode):
+       def __init__(self, content_type, varname, object_pk=None, template_name=None, kwargs=None):
+               assert template_name is not None or object_pk is not None
+               self.content_type = content_type
+               self.varname = varname
+               
+               kwargs = kwargs or {}
+               for k, v in kwargs.items():
+                       kwargs[k] = template.Variable(v)
+               self.kwargs = kwargs
+               
+               if object_pk is not None:
+                       self.object_pk = template.Variable(object_pk)
+               else:
+                       self.object_pk = None
+                       self.instance = None
+               
+               if template_name is not None:
+                       self.template_name = template.Variable(template_name)
+               else:
+                       self.template_name = None
+                       self.template = None
+       
+       def render(self, context):
+               if self.template_name is not None:
+                       template_name = self.template_name.resolve(context)
+                       self.compile_template(template_name)
+               
+               if self.object_pk is not None:
+                       object_pk = self.object_pk.resolve(context)
+                       self.compile_instance(object_pk)
+               
+               return super(EmbedNode, self).render(context)
+
+
+def get_embedded(self):
+       return self.template
+
+
+setattr(ConstantEmbedNode, LOADED_TEMPLATE_ATTR, property(get_embedded))
+
+
+def do_embed(parser, token):
+       """
+       The {% embed %} tag can be used in three ways:
+       {% embed as <varname> %} :: This sets which variable will be used to track embedding template names for the current context. Default: "embed"
+       {% embed <app_label>.<model_name> with <template> %} :: Sets which template will be used to render a particular model.
+       {% embed <app_label>.<model_name> <object_pk> [<argname>=<value> ...]%} :: Embeds the instance specified by the given parameters in the document with the previously-specified template. Any kwargs provided will be passed into the context of the template.
+       """
+       args = token.split_contents()
+       tag = args[0]
+       
+       if len(args) < 2:
+               raise template.TemplateSyntaxError('"%s" template tag must have at least three arguments.' % tag)
+       elif len(args) == 3 and args[1] == "as":
+               parser._embedNodeVarName = args[2]
+               return template.defaulttags.CommentNode()
+       else:
+               if '.' not in args[1]:
+                       raise template.TemplateSyntaxError('"%s" template tag expects the first argument to be of the form app_label.model' % tag)
+               
+               app_label, model = args[1].split('.')
+               try:
+                       ct = ContentType.objects.get(app_label=app_label, model=model)
+               except ContentType.DoesNotExist:
+                       raise template.TemplateSyntaxError('"%s" template tag option "references" requires an argument of the form app_label.model which refers to an installed content type (see django.contrib.contenttypes)' % tag)
+               
+               varname = getattr(parser, '_embedNodeVarName', 'embed')
+               
+               if args[2] == "with":
+                       if len(args) > 4:
+                               raise template.TemplateSyntaxError('"%s" template tag may have no more than four arguments.' % tag)
+                       
+                       if args[3][0] in ['"', "'"] and args[3][0] == args[3][-1]:
+                               return ConstantEmbedNode(ct, template_name=args[3], varname=varname)
+                       
+                       return EmbedNode(ct, template_name=args[3], varname=varname)
+               
+               object_pk = args[2]
+               remaining_args = args[3:]
+               kwargs = {}
+               for arg in remaining_args:
+                       if '=' not in arg:
+                               raise template.TemplateSyntaxError("Invalid keyword argument for '%s' template tag: %s" % (tag, arg))
+                       k, v = arg.split('=')
+                       kwargs[k] = v
+               
+               return EmbedNode(ct, object_pk=object_pk, varname=varname, kwargs=kwargs)
+
+
+register.tag('embed', do_embed)
\ No newline at end of file