2 The container template tags are automatically included as builtins if :mod:`philo` is an installed app.
6 from django import template
7 from django.conf import settings
8 from django.contrib.contenttypes.models import ContentType
9 from django.core.exceptions import ObjectDoesNotExist
10 from django.db.models import Q
11 from django.utils.safestring import SafeUnicode, mark_safe
14 register = template.Library()
17 CONTAINER_CONTEXT_KEY = 'philo_container_context'
20 class ContainerContext(object):
21 def __init__(self, page):
24 def get_contentlets(self):
25 if not hasattr(self, '_contentlets'):
26 self._contentlets = dict(((c.name, c) for c in self.page.contentlets.all()))
27 return self._contentlets
29 def get_references(self):
30 if not hasattr(self, '_references'):
31 references = self.page.contentreferences.all()
32 self._references = dict((((c.name, ContentType.objects.get_for_id(c.content_type_id)), c) for c in references))
33 return self._references
36 class ContainerNode(template.Node):
37 def __init__(self, name, references=None, as_var=None):
40 self.references = references
42 def render(self, context):
43 container_content = self.get_container_content(context)
46 context[self.as_var] = container_content
49 return container_content
51 def get_container_content(self, context):
53 container_context = context.render_context[CONTAINER_CONTEXT_KEY]
56 page = context['page']
58 return settings.TEMPLATE_STRING_IF_INVALID
60 container_context = ContainerContext(page)
61 context.render_context[CONTAINER_CONTEXT_KEY] = container_context
64 # Then it's a content reference.
66 contentreference = container_context.get_references()[(self.name, self.references)]
70 content = contentreference.content
72 # Otherwise it's a contentlet.
74 contentlet = container_context.get_contentlets()[self.name]
78 content = contentlet.content
83 def container(parser, token):
85 If a template using this tag is used to render a :class:`.Page`, that :class:`.Page` will have associated content which can be set in the admin interface. If a content type is referenced, then a :class:`.ContentReference` object will be created; otherwise, a :class:`.Contentlet` object will be created.
89 {% container <name> [[references <app_label>.<model_name>] as <variable>] %}
92 params = token.split_contents()
95 name = params[1].strip('"')
99 remaining_tokens = params[2:]
100 while remaining_tokens:
101 option_token = remaining_tokens.pop(0)
102 if option_token == 'references':
104 app_label, model = remaining_tokens.pop(0).strip('"').split('.')
105 references = ContentType.objects.get_by_natural_key(app_label, model)
107 raise template.TemplateSyntaxError('"%s" template tag option "references" requires an argument specifying a content type' % tag)
109 raise template.TemplateSyntaxError('"%s" template tag option "references" requires an argument of the form app_label.model (see django.contrib.contenttypes)' % tag)
110 except ObjectDoesNotExist:
111 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)
112 elif option_token == 'as':
114 as_var = remaining_tokens.pop(0)
116 raise template.TemplateSyntaxError('"%s" template tag option "as" requires an argument specifying a variable name' % tag)
117 if references and not as_var:
118 raise template.TemplateSyntaxError('"%s" template tags using "references" option require additional use of the "as" option specifying a variable name' % tag)
119 return ContainerNode(name, references, as_var)
122 raise template.TemplateSyntaxError('"%s" template tag provided without arguments (at least one required)' % tag)