Minor improvements to navigationoverrides, including admin support and working naviga...

[philo.git] / models / nodes.py

diff --git a/models/nodes.py b/models/nodes.py
index 90184ab..58a5b99 100644 (file)
--- a/models/nodes.py
+++ b/models/nodes.py
@@ -15,6 +15,7 @@ from philo.utils import ContentTypeSubclassLimiter
 from philo.validators import RedirectValidator
 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)
@@ -50,38 +51,38 @@ class Node(TreeEntity):
                except AncestorDoesNotExist, ViewDoesNotExist:
                        return None
        
-       def get_navigation(self, depth=DEFAULT_NAVIGATION_DEPTH, current_depth=0, found_node_pks=None):
-               navigation = self.view.get_navigation(self, depth, current_depth)
+       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))
                
-               if depth == current_depth:
-                       return navigation
-               import pdb
-               pdb.set_trace()
-               found_node_pks = found_node_pks or [self.pk]
-               ordered_child_pks = NodeNavigationOverride.objects.filter(parent=self, child__parent=self).values_list('child__pk', flat=True)
-               
-               children = self.children.exclude(pk__in=found_node_pks)
-               ordered_children = children.filter(pk__in=ordered_child_pks)
-               unordered_children = children.exclude(pk__in=ordered_child_pks)
-               
-               children = list(ordered_children) + list(unordered_children)
-               
-               if children:
-                       child_navigation = []
-                       for child in children:
-                               found_node_pks.append(child.pk)
-                               try:
-                                       child_navigation.append(child.get_navigation(depth, current_depth + 1, found_node_pks))
-                               except NotImplementedError:
-                                       pass
+               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')])
                        
-                       if child_navigation:
-                               if 'children' in navigation:
-                                       navigation['children'] += child_navigation
+                       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['children'] = child_navigation
+                                       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
                
-               return navigation
+               return get_nav(self.parent, tree)
        
        def save(self):
                super(Node, self).save()
@@ -96,29 +97,36 @@ models.ForeignKey(Node, related_name='sites', null=True, blank=True).contribute_
 
 
 class NodeNavigationOverride(Entity):
-       parent = models.ForeignKey(Node, related_name="navigation_override_child_set")
-       child = models.OneToOneField(Node, related_name="navigation_override")
-       url = models.CharField(max_length=200, validators=[RedirectValidator()], blank=True)
+       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, depth, current_depth):
                if self.child_navigation:
                        depth = current_depth
-               default = node.get_navigation(depth, current_depth)
+               default = node.view.get_navigation(depth, current_depth)
                if self.url:
                        default['url'] = self.url
                if self.title:
                        default['title'] = self.title
-               if self.child_navigation:
+               if self.order:
+                       default['order'] = self.order
+               if isinstance(self.child_navigation, list):
                        if 'children' in default:
                                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):
@@ -156,7 +164,20 @@ class View(Entity):
        def actually_render_to_response(self, request, extra_context=None):
                raise NotImplementedError('View subclasses must implement render_to_response.')
        
-       def get_navigation(self, node, depth, current_depth):
+       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
+                                       <similar child navigation dictionaries>
+                               ]
+                       }
+               """
                raise NotImplementedError('View subclasses must implement get_navigation.')
        
        class Meta: