X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/64e4cdefe89f642d349b5908a3bbaec76333e3b2..dbb5ab771be406d90ac522e0ecd644e5ddb21e6f:/models/nodes.py diff --git a/models/nodes.py b/models/nodes.py index 5676b58..ab8adf7 100644 --- a/models/nodes.py +++ b/models/nodes.py @@ -1,25 +1,21 @@ from django.db import models 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.contrib.sites.models import Site, RequestSite +from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect, Http404 from django.core.servers.basehttp import FileWrapper 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 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): @@ -33,63 +29,53 @@ class Node(TreeEntity): return self.view.accepts_subpath return False + def handles_subpath(self, subpath): + return self.view.handles_subpath(subpath) + def render_to_response(self, request, extra_context=None): return self.view.render_to_response(request, extra_context) - def get_absolute_url(self): + def get_absolute_url(self, request=None, with_domain=False, secure=False): + return self.construct_url(request=request, with_domain=with_domain, secure=secure) + + def construct_url(self, subpath=None, request=None, with_domain=False, secure=False): + """ + This method will construct a URL based on the Node's location. + If a request is passed in, that will be used as a backup in case + the Site lookup fails. The Site lookup takes precedence because + it's what's used to find the root node. This will raise: + - NoReverseMatch if philo-root is not reverseable + - Site.DoesNotExist if a domain is requested but not buildable. + - AncestorDoesNotExist if the root node of the site isn't an + ancestor of this instance. + """ + # Try reversing philo-root first, since we can't do anything if that fails. + root_url = reverse('philo-root') + try: - root = Site.objects.get_current().root_node + current_site = Site.objects.get_current() except Site.DoesNotExist: - root = None + if request is not None: + current_site = RequestSite(request) + elif with_domain: + # If they want a domain and we can't figure one out, + # best to reraise the error to let them know. + raise + else: + current_site = 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)) + root = getattr(current_site, 'root_node', None) + path = self.get_path(root=root) - 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 + if current_site and with_domain: + domain = "http%s://%s" % (secure and "s" or "", current_site.domain) + else: + domain = "" - 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() + if not path: + subpath = subpath[1:] + return '%s%s%s%s' % (domain, root_url, path, subpath or "") class Meta: app_label = 'philo' @@ -99,61 +85,39 @@ 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): + def handles_subpath(self, subpath): + if not self.accepts_subpath and subpath != "/": + return False + return True + + def reverse(self, view_name=None, args=None, kwargs=None, node=None, obj=None): + """Shortcut method to handle the common pattern of getting the + absolute url for a view's subpaths.""" if not self.accepts_subpath: raise ViewDoesNotProvideSubpaths - view_name, args, kwargs = self.get_reverse_params(obj) + if obj is not None: + # Perhaps just override instead of combining? + obj_view_name, obj_args, obj_kwargs = self.get_reverse_params(obj) + if view_name is None: + view_name = obj_view_name + args = list(obj_args) + list(args or []) + obj_kwargs.update(kwargs or {}) + kwargs = obj_kwargs + try: - return reverse(view_name, args=args, kwargs=kwargs, urlconf=self) + subpath = reverse(view_name, urlconf=self, args=args or [], kwargs=kwargs or {}) except NoReverseMatch: raise ViewCanNotProvideSubpath + + if node is not None: + return node.construct_url(subpath) + return subpath 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.""" @@ -173,23 +137,7 @@ class View(Entity): return response 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.') + raise NotImplementedError('View subclasses must implement actually_render_to_response.') class Meta: abstract = True @@ -202,15 +150,21 @@ class MultiView(View): accepts_subpath = True @property - def urlpatterns(self, obj): + def urlpatterns(self): raise NotImplementedError("MultiView subclasses must implement urlpatterns.") + def handles_subpath(self, subpath): + if not super(MultiView, self).handles_subpath(subpath): + return False + try: + resolve(subpath, urlconf=self) + except Http404: + return False + return True + def actually_render_to_response(self, request, extra_context=None): clear_url_caches() subpath = request.node.subpath - if not subpath: - subpath = "" - subpath = "/" + subpath view, args, kwargs = resolve(subpath, urlconf=self) view_args = getargspec(view) if extra_context is not None and ('extra_context' in view_args[0] or view_args[2] is not None): @@ -219,13 +173,30 @@ class MultiView(View): kwargs['extra_context'] = extra_context return view(request, *args, **kwargs) - def reverse(self, view_name, args=None, kwargs=None, node=None): - """Shortcut method to handle the common pattern of getting the absolute url for a multiview's - subpaths.""" - subpath = reverse(view_name, urlconf=self, args=args or [], kwargs=kwargs or {}) - if node is not None: - return '/%s/%s/' % (node.get_absolute_url().strip('/'), subpath.strip('/')) - return subpath + def get_context(self): + """Hook for providing instance-specific context - such as the value of a Field - to all views.""" + return {} + + def basic_view(self, field_name): + """ + Given the name of a field on ``self``, accesses the value of + that field and treats it as a ``View`` instance. Creates a + basic context based on self.get_context() and any extra_context + that was passed in, then calls the ``View`` instance's + render_to_response() method. This method is meant to be called + to return a view function appropriate for urlpatterns. + """ + field = self._meta.get_field(field_name) + view = getattr(self, field.name, None) + + def inner(request, extra_context=None, **kwargs): + if not view: + raise Http404 + context = self.get_context() + context.update(extra_context or {}) + return view.render_to_response(request, extra_context=context) + + return inner class Meta: abstract = True @@ -248,7 +219,6 @@ class Redirect(View): app_label = 'philo' -# Why does this exist? class File(View): """ For storing arbitrary files """