templatetags/embed.py

   1 from django import template
   2 from django.contrib.contenttypes.models import ContentType
   3 from django.conf import settings
   4 from django.template.loader_tags import ExtendsNode, BlockContext, BLOCK_CONTEXT_KEY, TextNode, BlockNode
   5 from philo.utils import LOADED_TEMPLATE_ATTR
   6
   7
   8 register = template.Library()
   9 EMBED_CONTEXT_KEY = 'embed_context'
  10
  11
  12 class EmbedContext(object):
  13         "Inspired by django.template.loader_tags.BlockContext."
  14         def __init__(self):
  15                 self.embeds = {}
  16                 self.rendered = []
  17
  18         def add_embeds(self, embeds):
  19                 for content_type, embed_list in embeds.iteritems():
  20                         if content_type in self.embeds:
  21                                 self.embeds[content_type] = embed_list + self.embeds[content_type]
  22                         else:
  23                                 self.embeds[content_type] = embed_list
  24
  25         def get_embed_template(self, embed, context):
  26                 """To return a template for an embed node, find the node's position in the stack
  27                 and then progress up the stack until a template-defining node is found
  28                 """
  29                 ct = embed.get_content_type(context)
  30                 embeds = self.embeds[ct]
  31                 embeds = embeds[:embeds.index(embed)][::-1]
  32                 for e in embeds:
  33                         template = e.get_template(context)
  34                         if template:
  35                                 return template
  36
  37                 # No template was found in the current render_context - but perhaps one level up? Or more?
  38                 # We may be in an inclusion tag.
  39                 self_found = False
  40                 for context_dict in context.render_context.dicts[::-1]:
  41                         if not self_found:
  42                                 if self in context_dict.values():
  43                                         self_found = True
  44                                         continue
  45                         elif EMBED_CONTEXT_KEY not in context_dict:
  46                                 continue
  47                         else:
  48                                 embed_context = context_dict[EMBED_CONTEXT_KEY]
  49                                 # We can tell where we are in the list of embeds by which have already been rendered.
  50                                 embeds = embed_context.embeds[ct][:len(embed_context.rendered)][::-1]
  51                                 for e in embeds:
  52                                         template = e.get_template(context)
  53                                         if template:
  54                                                 return template
  55
  56                 raise IndexError
  57
  58
  59 # Override ExtendsNode render method to have it handle EmbedNodes
  60 # similarly to BlockNodes.
  61 old_extends_node_init = ExtendsNode.__init__
  62
  63
  64 def get_embed_dict(embed_list, context):
  65         embeds = {}
  66         for e in embed_list:
  67                 ct = e.get_content_type(context)
  68                 if ct is None:
  69                         # Then the embed doesn't exist for this context.
  70                         continue
  71                 if ct not in embeds:
  72                         embeds[ct] = [e]
  73                 else:
  74                         embeds[ct].append(e)
  75         return embeds
  76
  77
  78 def extends_node_init(self, nodelist, *args, **kwargs):
  79         self.embed_list = nodelist.get_nodes_by_type(ConstantEmbedNode)
  80         old_extends_node_init(self, nodelist, *args, **kwargs)
  81
  82
  83 def render_extends_node(self, context):
  84         compiled_parent = self.get_parent(context)
  85         embeds = get_embed_dict(self.embed_list, context)
  86
  87         if BLOCK_CONTEXT_KEY not in context.render_context:
  88                 context.render_context[BLOCK_CONTEXT_KEY] = BlockContext()
  89         block_context = context.render_context[BLOCK_CONTEXT_KEY]
  90
  91         if EMBED_CONTEXT_KEY not in context.render_context:
  92                 context.render_context[EMBED_CONTEXT_KEY] = EmbedContext()
  93         embed_context = context.render_context[EMBED_CONTEXT_KEY]
  94
  95         # Add the block nodes from this node to the block context
  96         # Do the equivalent for embed nodes
  97         block_context.add_blocks(self.blocks)
  98         embed_context.add_embeds(embeds)
  99
 100         # If this block's parent doesn't have an extends node it is the root,
 101         # and its block nodes also need to be added to the block context.
 102         for node in compiled_parent.nodelist:
 103                 # The ExtendsNode has to be the first non-text node.
 104                 if not isinstance(node, TextNode):
 105                         if not isinstance(node, ExtendsNode):
 106                                 blocks = dict([(n.name, n) for n in compiled_parent.nodelist.get_nodes_by_type(BlockNode)])
 107                                 block_context.add_blocks(blocks)
 108                                 embeds = get_embed_dict(compiled_parent.nodelist.get_nodes_by_type(ConstantEmbedNode), context)
 109                                 embed_context.add_embeds(embeds)
 110                         break
 111
 112         # Explicitly render all direct embed children of this node.
 113         if self.embed_list:
 114                 for node in self.nodelist:
 115                         if isinstance(node, ConstantEmbedNode):
 116                                 node.render(context)
 117
 118         # Call Template._render explicitly so the parser context stays
 119         # the same.
 120         return compiled_parent._render(context)
 121
 122
 123 ExtendsNode.__init__ = extends_node_init
 124 ExtendsNode.render = render_extends_node
 125
 126
 127 class ConstantEmbedNode(template.Node):
 128         """Analogous to the ConstantIncludeNode, this node precompiles several variables necessary for correct rendering - namely the referenced instance or the included template."""
 129         def __init__(self, content_type, object_pk=None, template_name=None, kwargs=None):
 130                 assert template_name is not None or object_pk is not None
 131                 self.content_type = content_type
 132
 133                 kwargs = kwargs or {}
 134                 for k, v in kwargs.items():
 135                         kwargs[k] = v
 136                 self.kwargs = kwargs
 137
 138                 if object_pk is not None:
 139                         self.instance = self.compile_instance(object_pk)
 140                 else:
 141                         self.instance = None
 142
 143                 if template_name is not None:
 144                         self.template = self.compile_template(template_name[1:-1])
 145                 else:
 146                         self.template = None
 147
 148         def compile_instance(self, object_pk):
 149                 self.object_pk = object_pk
 150                 model = self.content_type.model_class()
 151                 try:
 152                         return model.objects.get(pk=object_pk)
 153                 except model.DoesNotExist:
 154                         if not hasattr(self, 'object_pk') and settings.TEMPLATE_DEBUG:
 155                                 # Then it's a constant node.
 156                                 raise
 157                         return False
 158
 159         def get_instance(self, context):
 160                 return self.instance
 161
 162         def compile_template(self, template_name):
 163                 try:
 164                         return template.loader.get_template(template_name)
 165                 except template.TemplateDoesNotExist:
 166                         if hasattr(self, 'template') and settings.TEMPLATE_DEBUG:
 167                                 # Then it's a constant node.
 168                                 raise
 169                         return False
 170
 171         def get_template(self, context):
 172                 return self.template
 173
 174         def get_content_type(self, context):
 175                 return self.content_type
 176
 177         def check_context(self, context):
 178                 if EMBED_CONTEXT_KEY not in context.render_context:
 179                         context.render_context[EMBED_CONTEXT_KEY] = EmbedContext()
 180                 embed_context = context.render_context[EMBED_CONTEXT_KEY]
 181
 182                 ct = self.get_content_type(context)
 183                 if ct not in embed_context.embeds:
 184                         embed_context.embeds[ct] = [self]
 185                 elif self not in embed_context.embeds[ct]:
 186                         embed_context.embeds[ct].append(self)
 187
 188         def mark_rendered_for(self, context):
 189                 context.render_context[EMBED_CONTEXT_KEY].rendered.append(self)
 190
 191         def render(self, context):
 192                 self.check_context(context)
 193
 194                 template = self.get_template(context)
 195                 if template is not None:
 196                         self.mark_rendered_for(context)
 197                         if template is False:
 198                                 return settings.TEMPLATE_STRING_IF_INVALID
 199                         return ''
 200
 201                 # Otherwise an instance should be available. Render the instance with the appropriate template!
 202                 instance = self.get_instance(context)
 203                 if instance is None or instance is False:
 204                         self.mark_rendered_for(context)
 205                         return settings.TEMPLATE_STRING_IF_INVALID
 206
 207                 return self.render_instance(context, instance)
 208
 209         def render_instance(self, context, instance):
 210                 try:
 211                         t = context.render_context[EMBED_CONTEXT_KEY].get_embed_template(self, context)
 212                 except (KeyError, IndexError):
 213                         self.mark_rendered_for(context)
 214                         return settings.TEMPLATE_STRING_IF_INVALID
 215
 216                 context.push()
 217                 context['embedded'] = instance
 218                 for k, v in self.kwargs.items():
 219                         context[k] = v.resolve(context)
 220                 t_rendered = t.render(context)
 221                 context.pop()
 222                 self.mark_rendered_for(context)
 223                 return t_rendered
 224
 225
 226 class EmbedNode(ConstantEmbedNode):
 227         def __init__(self, content_type, object_pk=None, template_name=None, kwargs=None):
 228                 assert template_name is not None or object_pk is not None
 229                 self.content_type = content_type
 230                 self.kwargs = kwargs or {}
 231
 232                 if object_pk is not None:
 233                         self.object_pk = object_pk
 234                 else:
 235                         self.object_pk = None
 236
 237                 if template_name is not None:
 238                         self.template_name = template_name
 239                 else:
 240                         self.template_name = None
 241
 242         def get_instance(self, context):
 243                 if self.object_pk is None:
 244                         return None
 245                 return self.compile_instance(self.object_pk.resolve(context))
 246
 247         def get_template(self, context):
 248                 if self.template_name is None:
 249                         return None
 250                 return self.compile_template(self.template_name.resolve(context))
 251
 252
 253 class InstanceEmbedNode(EmbedNode):
 254         def __init__(self, instance, kwargs=None):
 255                 self.instance = instance
 256                 self.kwargs = kwargs or {}
 257
 258         def get_template(self, context):
 259                 return None
 260
 261         def get_instance(self, context):
 262                 return self.instance.resolve(context)
 263
 264         def get_content_type(self, context):
 265                 instance = self.get_instance(context)
 266                 if not instance:
 267                         return None
 268                 return ContentType.objects.get_for_model(instance)
 269
 270
 271 def get_embedded(self):
 272         return self.template
 273
 274
 275 setattr(ConstantEmbedNode, LOADED_TEMPLATE_ATTR, property(get_embedded))
 276
 277
 278 def get_content_type(bit):
 279         try:
 280                 app_label, model = bit.split('.')
 281         except ValueError:
 282                 raise template.TemplateSyntaxError('"%s" template tag expects the first argument to be of the form app_label.model' % tag)
 283         try:
 284                 ct = ContentType.objects.get(app_label=app_label, model=model)
 285         except ContentType.DoesNotExist:
 286                 raise template.TemplateSyntaxError('"%s" template tag requires an argument of the form app_label.model which refers to an installed content type (see django.contrib.contenttypes)' % tag)
 287         return ct
 288
 289
 290 def do_embed(parser, token):
 291         """
 292         The {% embed %} tag can be used in two ways:
 293         {% embed <app_label>.<model_name> with <template> %} :: Sets which template will be used to render a particular model.
 294         {% embed (<app_label>.<model_name> <object_pk> || <instance>) [<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.
 295         """
 296         bits = token.split_contents()
 297         tag = bits.pop(0)
 298
 299         if len(bits) < 1:
 300                 raise template.TemplateSyntaxError('"%s" template tag must have at least two arguments.' % tag)
 301
 302         if len(bits) == 3 and bits[-2] == 'with':
 303                 ct = get_content_type(bits[0])
 304
 305                 if bits[2][0] in ['"', "'"] and bits[2][0] == bits[2][-1]:
 306                         return ConstantEmbedNode(ct, template_name=bits[2])
 307                 return EmbedNode(ct, template_name=bits[2])
 308
 309         # Otherwise they're trying to embed a certain instance.
 310         kwargs = {}
 311         try:
 312                 bit = bits.pop()
 313                 while '=' in bit:
 314                         k, v = bit.split('=')
 315                         kwargs[k] = parser.compile_filter(v)
 316                         bit = bits.pop()
 317                 bits.append(bit)
 318         except IndexError:
 319                 raise template.TemplateSyntaxError('"%s" template tag expects at least one non-keyword argument when embedding instances.')
 320
 321         if len(bits) == 1:
 322                 instance = parser.compile_filter(bits[0])
 323                 return InstanceEmbedNode(instance, kwargs)
 324         elif len(bits) > 2:
 325                 raise template.TemplateSyntaxError('"%s" template tag expects at most 2 non-keyword arguments when embedding instances.')
 326         ct = get_content_type(bits[0])
 327         pk = bits[1]
 328
 329         try:
 330                 int(pk)
 331         except ValueError:
 332                 return EmbedNode(ct, object_pk=parser.compile_filter(pk), kwargs=kwargs)
 333         else:
 334                 return ConstantEmbedNode(ct, object_pk=pk, kwargs=kwargs)
 335
 336
 337 register.tag('embed', do_embed)