X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/12949bcd8bca1a6c9b0171774e447b63ead6edf0..ee56a2ca0d6c5d08ee42a9452de4353e8f2643ba:/models/nodes.py diff --git a/models/nodes.py b/models/nodes.py index b633542..6035148 100644 --- a/models/nodes.py +++ b/models/nodes.py @@ -3,18 +3,23 @@ from django.contrib.contenttypes.models import ContentType from django.contrib.contenttypes import generic from django.contrib.sites.models import Site from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect +from django.core.exceptions import ViewDoesNotExist from django.core.servers.basehttp import FileWrapper -from django.core.urlresolvers import resolve, clear_url_caches +from django.core.urlresolvers import resolve, clear_url_caches, reverse, NoReverseMatch from django.template import add_to_builtins as register_templatetags from inspect import getargspec +from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED from philo.models.base import TreeEntity, Entity, QuerySetMapper, register_value_model +from philo.models.fields import JSONField from philo.utils import ContentTypeSubclassLimiter from philo.validators import RedirectValidator -from philo.exceptions import ViewDoesNotProvideSubpaths, AncestorDoesNotExist +from philo.exceptions import ViewCanNotProvideSubpath, ViewDoesNotProvideSubpaths, AncestorDoesNotExist from philo.signals import view_about_to_render, view_finished_rendering +from mptt.templatetags.mptt_tags import cache_tree_children _view_content_type_limiter = ContentTypeSubclassLimiter(None) +DEFAULT_NAVIGATION_DEPTH = 3 class Node(TreeEntity): @@ -28,16 +33,64 @@ class Node(TreeEntity): return self.view.accepts_subpath return False - def render_to_response(self, request, path=None, subpath=None, extra_context=None): - return self.view._render_to_response(self, request, path, subpath, extra_context) + def render_to_response(self, request, extra_context=None): + return self.view.render_to_response(request, extra_context) def get_absolute_url(self): - root = Site.objects.get_current().root_node try: - return '/%s' % self.get_path(root=root) - except AncestorDoesNotExist: + root = Site.objects.get_current().root_node + except Site.DoesNotExist: + root = None + + try: + path = self.get_path(root=root) + if path: + path += '/' + root_url = reverse('philo-root') + return '%s%s' % (root_url, path) + except AncestorDoesNotExist, ViewDoesNotExist: return None + def get_navigation(self, depth=DEFAULT_NAVIGATION_DEPTH): + max_depth = depth + self.get_level() + tree = cache_tree_children(self.get_descendants(include_self=True).filter(level__lte=max_depth)) + + def get_nav(parent, nodes): + node_overrides = dict([(override.child.pk, override) for override in NodeNavigationOverride.objects.filter(parent=parent, child__in=nodes).select_related('child')]) + + navigation_list = [] + for node in nodes: + node._override = node_overrides.get(node.pk, None) + + if node._override: + if node._override.hide: + continue + navigation = node._override.get_navigation(node, max_depth) + else: + navigation = node.view.get_navigation(node, max_depth) + + if not node.is_leaf_node() and node.get_level() < max_depth: + children = navigation.get('children', []) + children += get_nav(node, node.get_children()) + navigation['children'] = children + + if 'children' in navigation: + navigation['children'].sort(cmp=lambda x,y: cmp(x['order'], y['order'])) + + navigation_list.append(navigation) + + return navigation_list + + navigation = get_nav(self.parent, tree) + root = navigation[0] + navigation = [root] + root['children'] + del(root['children']) + return navigation + + def save(self): + super(Node, self).save() + + class Meta: app_label = 'philo' @@ -46,30 +99,98 @@ class Node(TreeEntity): models.ForeignKey(Node, related_name='sites', null=True, blank=True).contribute_to_class(Site, 'root_node') +class NodeNavigationOverride(Entity): + parent = models.ForeignKey(Node, related_name="child_navigation_overrides", blank=True, null=True) + child = models.ForeignKey(Node, related_name="navigation_overrides") + + title = models.CharField(max_length=100, blank=True) + url = models.CharField(max_length=200, validators=[RedirectValidator()], blank=True) + order = models.PositiveSmallIntegerField(blank=True, null=True) + child_navigation = JSONField() + hide = models.BooleanField() + + def get_navigation(self, node, max_depth): + default = node.view.get_navigation(node, max_depth) + if self.url: + default['url'] = self.url + if self.title: + default['title'] = self.title + if self.order: + default['order'] = self.order + if isinstance(self.child_navigation, list) and node.get_level() < max_depth: + child_navigation = self.child_navigation[:] + + for child in child_navigation: + child['url'] = default['url'] + child['url'] + + if 'children' in default: + overridden = set([child['url'] for child in default['children']]) & set([child['url'] for child in self.child_navigation]) + if overridden: + for child in default[:]: + if child['url'] in overridden: + default.remove(child) + default['children'] += self.child_navigation + else: + default['children'] = self.child_navigation + return default + + class Meta: + ordering = ['order'] + unique_together = ('parent', 'child',) + app_label = 'philo' + + class View(Entity): nodes = generic.GenericRelation(Node, content_type_field='view_content_type', object_id_field='view_object_id') accepts_subpath = False def get_subpath(self, obj): - raise ViewDoesNotProvideSubpaths + if not self.accepts_subpath: + raise ViewDoesNotProvideSubpaths + + view_name, args, kwargs = self.get_reverse_params(obj) + try: + return reverse(view_name, args=args, kwargs=kwargs, urlconf=self) + except NoReverseMatch: + raise ViewCanNotProvideSubpath + + def get_reverse_params(self, obj): + """This method should return a view_name, args, kwargs tuple suitable for reversing a url for the given obj using self as the urlconf.""" + raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.") def attributes_with_node(self, node): return QuerySetMapper(self.attribute_set, passthrough=node.attributes) - def relationships_with_node(self, node): - return QuerySetMapper(self.relationship_set, passthrough=node.relationships) - - def _render_to_response(self, node, request, path=None, subpath=None, extra_context=None): + def render_to_response(self, request, extra_context=None): + if not hasattr(request, 'node'): + raise MIDDLEWARE_NOT_CONFIGURED + extra_context = extra_context or {} - view_about_to_render.send(sender=self, node=node, request=request, path=path, subpath=subpath, extra_context=extra_context) - response = self.render_to_response(node, request, path, subpath, extra_context) + view_about_to_render.send(sender=self, request=request, extra_context=extra_context) + response = self.actually_render_to_response(request, extra_context) view_finished_rendering.send(sender=self, response=response) return response - def render_to_response(self, node, request, path=None, subpath=None, extra_context=None): + def actually_render_to_response(self, request, extra_context=None): raise NotImplementedError('View subclasses must implement render_to_response.') + def get_navigation(self, node, max_depth): + """ + Subclasses should implement get_navigation to support auto-generated navigation. + max_depth is the deepest `level` that should be generated; node is the node that + is asking for the navigation. This method should return a dictionary of the form: + { + 'url': url, + 'title': title, + 'order': order, # None for no ordering. + 'children': [ # Optional + + ] + } + """ + raise NotImplementedError('View subclasses must implement get_navigation.') + class Meta: abstract = True @@ -80,10 +201,13 @@ _view_content_type_limiter.cls = View class MultiView(View): accepts_subpath = True - urlpatterns = [] + @property + def urlpatterns(self, obj): + raise NotImplementedError("MultiView subclasses must implement urlpatterns.") - def render_to_response(self, node, request, path=None, subpath=None, extra_context=None): + def actually_render_to_response(self, request, extra_context=None): clear_url_caches() + subpath = request.node.subpath if not subpath: subpath = "" subpath = "/" + subpath @@ -93,8 +217,6 @@ class MultiView(View): if 'extra_context' in kwargs: extra_context.update(kwargs['extra_context']) kwargs['extra_context'] = extra_context - if 'node' in view_args[0] or view_args[2] is not None: - kwargs['node'] = node return view(request, *args, **kwargs) class Meta: @@ -109,7 +231,7 @@ class Redirect(View): target = models.CharField(max_length=200, validators=[RedirectValidator()]) status_code = models.IntegerField(choices=STATUS_CODES, default=302, verbose_name='redirect type') - def render_to_response(self, node, request, path=None, subpath=None, extra_context=None): + def actually_render_to_response(self, request, extra_context=None): response = HttpResponseRedirect(self.target) response.status_code = self.status_code return response @@ -118,13 +240,14 @@ class Redirect(View): app_label = 'philo' +# Why does this exist? class File(View): """ For storing arbitrary files """ mimetype = models.CharField(max_length=255) file = models.FileField(upload_to='philo/files/%Y/%m/%d') - def render_to_response(self, node, request, path=None, subpath=None, extra_context=None): + def actually_render_to_response(self, request, extra_context=None): wrapper = FileWrapper(self.file) response = HttpResponse(wrapper, content_type=self.mimetype) response['Content-Length'] = self.file.size