X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/05a2fc324de4cdc54a193d7b6d57c8b4de7f9480..ee5fbe5df5817578911fbf0c2e1fc2698e701b73:/models/pages.py diff --git a/models/pages.py b/models/pages.py index 2ba56d0..2221ee4 100644 --- a/models/pages.py +++ b/models/pages.py @@ -1,34 +1,79 @@ # encoding: utf-8 -from django.db import models +from django.conf import settings from django.contrib.contenttypes.models import ContentType from django.contrib.contenttypes import generic -from django.conf import settings -from django.template import add_to_builtins as register_templatetags -from django.template import Template as DjangoTemplate -from django.template import TemplateDoesNotExist -from django.template import Context, RequestContext -from django.template.loader import get_template -from django.template.loader_tags import ExtendsNode, ConstantIncludeNode, IncludeNode +from django.core.exceptions import ValidationError +from django.db import models from django.http import HttpResponse +from django.template import TemplateDoesNotExist, Context, RequestContext, Template as DjangoTemplate, add_to_builtins as register_templatetags, TextNode, VariableNode +from django.template.loader_tags import BlockNode, ExtendsNode, BlockContext +from django.utils.datastructures import SortedDict from philo.models.base import TreeModel, register_value_model -from philo.models.nodes import Node -from philo.utils import fattr +from philo.models.fields import TemplateField +from philo.models.nodes import View from philo.templatetags.containers import ContainerNode +from philo.utils import fattr +from philo.validators import LOADED_TEMPLATE_ATTR +from philo.signals import page_about_to_render_to_string, page_finished_rendering_to_string + + +class LazyContainerFinder(object): + def __init__(self, nodes, extends=False): + self.nodes = nodes + self.initialized = False + self.contentlet_specs = set() + self.contentreference_specs = SortedDict() + self.blocks = {} + self.block_super = False + self.extends = extends + + def process(self, nodelist): + for node in nodelist: + if self.extends: + if isinstance(node, BlockNode): + self.blocks[node.name] = block = LazyContainerFinder(node.nodelist) + block.initialize() + self.blocks.update(block.blocks) + continue + + if isinstance(node, ContainerNode): + if not node.references: + self.contentlet_specs.add(node.name) + else: + if node.name not in self.contentreference_specs.keys(): + self.contentreference_specs[node.name] = node.references + continue + + if isinstance(node, VariableNode): + if node.filter_expression.var.lookups == (u'block', u'super'): + self.block_super = True + + if hasattr(node, 'child_nodelists'): + for nodelist_name in node.child_nodelists: + if hasattr(node, nodelist_name): + nodelist = getattr(node, nodelist_name) + self.process(nodelist) + + # LOADED_TEMPLATE_ATTR contains the name of an attribute philo uses to declare a + # node as rendering an additional template. Philo monkeypatches the attribute onto + # the relevant default nodes and declares it on any native nodes. + if hasattr(node, LOADED_TEMPLATE_ATTR): + loaded_template = getattr(node, LOADED_TEMPLATE_ATTR) + if loaded_template: + nodelist = loaded_template.nodelist + self.process(nodelist) + + def initialize(self): + if not self.initialized: + self.process(self.nodes) + self.initialized = True class Template(TreeModel): name = models.CharField(max_length=255) documentation = models.TextField(null=True, blank=True) - mimetype = models.CharField(max_length=255, null=True, blank=True, help_text='Default: %s' % settings.DEFAULT_CONTENT_TYPE) - code = models.TextField(verbose_name='django template code') - - @property - def origin(self): - return 'philo.models.Template: ' + self.path - - @property - def django_template(self): - return DjangoTemplate(self.code) + mimetype = models.CharField(max_length=255, default=getattr(settings, 'DEFAULT_CONTENT_TYPE', 'text/html')) + code = TemplateField(secure=False, verbose_name='django template code') @property def containers(self): @@ -38,70 +83,113 @@ class Template(TreeModel): This will break if there is a recursive extends or includes in the template code. Due to the use of an empty Context, any extends or include tags with dynamic arguments probably won't work. """ - def container_nodes(template): - def nodelist_container_nodes(nodelist): - nodes = [] - for node in nodelist: - try: - for nodelist_name in ('nodelist', 'nodelist_loop', 'nodelist_empty', 'nodelist_true', 'nodelist_false', 'nodelist_main'): - if hasattr(node, nodelist_name): - nodes.extend(nodelist_container_nodes(getattr(node, nodelist_name))) - if isinstance(node, ContainerNode): - nodes.append(node) - elif isinstance(node, ExtendsNode): - extended_template = node.get_parent(Context()) - if extended_template: - nodes.extend(container_nodes(extended_template)) - elif isinstance(node, ConstantIncludeNode): - included_template = node.template - if included_template: - nodes.extend(container_nodes(included_template)) - elif isinstance(node, IncludeNode): - included_template = get_template(node.template_name.resolve(Context())) - if included_template: - nodes.extend(container_nodes(included_template)) - except: - raise # fail for this node - return nodes - return nodelist_container_nodes(template.nodelist) - all_nodes = container_nodes(self.django_template) - contentlet_node_names = set([node.name for node in all_nodes if not node.references]) - contentreference_node_names = [] - contentreference_node_specs = [] - for node in all_nodes: - if node.references and node.name not in contentreference_node_names: - contentreference_node_specs.append((node.name, node.references)) - contentreference_node_names.append(node.name) - return contentlet_node_names, contentreference_node_specs + template = DjangoTemplate(self.code) + + def build_extension_tree(nodelist): + nodelists = [] + extends = None + for node in nodelist: + if not isinstance(node, TextNode): + if isinstance(node, ExtendsNode): + extends = node + break + + if extends: + if extends.nodelist: + nodelists.append(LazyContainerFinder(extends.nodelist, extends=True)) + loaded_template = getattr(extends, LOADED_TEMPLATE_ATTR) + nodelists.extend(build_extension_tree(loaded_template.nodelist)) + else: + # Base case: root. + nodelists.append(LazyContainerFinder(nodelist)) + return nodelists + + # Build a tree of the templates we're using, placing the root template first. + levels = build_extension_tree(template.nodelist)[::-1] + + contentlet_specs = set() + contentreference_specs = SortedDict() + blocks = {} + + for level in levels: + level.initialize() + contentlet_specs |= level.contentlet_specs + contentreference_specs.update(level.contentreference_specs) + for name, block in level.blocks.items(): + if block.block_super: + blocks.setdefault(name, []).append(block) + else: + blocks[name] = [block] + + for block_list in blocks.values(): + for block in block_list: + block.initialize() + contentlet_specs |= block.contentlet_specs + contentreference_specs.update(block.contentreference_specs) + + return contentlet_specs, contentreference_specs def __unicode__(self): - return self.get_path(u' › ', 'name') - - @staticmethod - @fattr(is_usable=True) - def loader(template_name, template_dirs=None): # load_template_source - try: - template = Template.objects.get_with_path(template_name) - except Template.DoesNotExist: - raise TemplateDoesNotExist(template_name) - return (template.code, template.origin) + return self.name class Meta: app_label = 'philo' -class Page(Node): +class Page(View): """ Represents a page - something which is rendered according to a template. The page will have a number of related Contentlets depending on the template selected - but these will appear only after the page has been saved with that template. """ template = models.ForeignKey(Template, related_name='pages') title = models.CharField(max_length=255) - def render_to_response(self, request, path=None, subpath=None): - return HttpResponse(self.template.django_template.render(RequestContext(request, {'page': self})), mimetype=self.template.mimetype) + def get_containers(self): + if not hasattr(self, '_containers'): + self._containers = self.template.containers + return self._containers + containers = property(get_containers) + + def render_to_string(self, request=None, extra_context=None): + context = {} + context.update(extra_context or {}) + context.update({'page': self, 'attributes': self.attributes}) + template = DjangoTemplate(self.template.code) + if request: + context.update({'node': request.node, 'attributes': self.attributes_with_node(request.node)}) + page_about_to_render_to_string.send(sender=self, request=request, extra_context=context) + string = template.render(RequestContext(request, context)) + else: + page_about_to_render_to_string.send(sender=self, request=request, extra_context=context) + string = template.render(Context(context)) + page_finished_rendering_to_string.send(sender=self, string=string) + return string + + def actually_render_to_response(self, request, extra_context=None): + return HttpResponse(self.render_to_string(request, extra_context), mimetype=self.template.mimetype) def __unicode__(self): - return self.get_path(u' › ', 'title') + return self.title + + def clean_fields(self, exclude=None): + if exclude is None: + exclude = [] + + try: + super(Page, self).clean_fields(exclude) + except ValidationError, e: + errors = e.message_dict + else: + errors = {} + + if 'template' not in errors and 'template' not in exclude: + try: + self.template.clean_fields() + self.template.clean() + except ValidationError, e: + errors['template'] = e.messages + + if errors: + raise ValidationError(errors) class Meta: app_label = 'philo' @@ -109,9 +197,8 @@ class Page(Node): class Contentlet(models.Model): page = models.ForeignKey(Page, related_name='contentlets') - name = models.CharField(max_length=255) - content = models.TextField() - dynamic = models.BooleanField(default=False) + name = models.CharField(max_length=255, db_index=True) + content = TemplateField() def __unicode__(self): return self.name @@ -122,7 +209,7 @@ class Contentlet(models.Model): class ContentReference(models.Model): page = models.ForeignKey(Page, related_name='contentreferences') - name = models.CharField(max_length=255) + name = models.CharField(max_length=255, db_index=True) content_type = models.ForeignKey(ContentType, verbose_name='Content type') content_id = models.PositiveIntegerField(verbose_name='Content ID', blank=True, null=True) content = generic.GenericForeignKey('content_type', 'content_id')