Merge branch 'master' of git://github.com/melinath/philo
[philo.git] / models / nodes.py
index 1e7622a..de10ed1 100644 (file)
@@ -3,12 +3,17 @@ 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
+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.models.base import TreeEntity, Entity, QuerySetMapper
+from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED
+from philo.models.base import TreeEntity, Entity, QuerySetMapper, register_value_model
 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
 
 
 _view_content_type_limiter = ContentTypeSubclassLimiter(None)
@@ -21,10 +26,27 @@ class Node(TreeEntity):
        
        @property
        def accepts_subpath(self):
-               return self.view.accepts_subpath
-       
-       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)
+               if self.view:
+                       return self.view.accepts_subpath
+               return False
+       
+       def render_to_response(self, request, extra_context=None):
+               return self.view.render_to_response(request, extra_context)
+       
+       def get_absolute_url(self):
+               try:
+                       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
        
        class Meta:
                app_label = 'philo'
@@ -39,13 +61,34 @@ class View(Entity):
        
        accepts_subpath = False
        
+       def get_subpath(self, obj):
+               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, 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, 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.')
        
        class Meta:
@@ -58,22 +101,32 @@ _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
                view, args, kwargs = resolve(subpath, urlconf=self)
-               view_args = getargspec(view)[0]
-               if extra_context is not None and 'extra_context' in view_args:
+               view_args = getargspec(view)
+               if extra_context is not None and ('extra_context' in view_args[0] or view_args[2] is not None):
                        if 'extra_context' in kwargs:
                                extra_context.update(kwargs['extra_context'])
                        kwargs['extra_context'] = extra_context
-               if 'node' in view_args:
-                       kwargs['node'] = node
                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
+       
        class Meta:
                abstract = True
 
@@ -86,7 +139,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
@@ -95,13 +148,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
@@ -111,4 +165,8 @@ class File(View):
                app_label = 'philo'
        
        def __unicode__(self):
-               return self.file.name
\ No newline at end of file
+               return self.file.name
+
+
+register_templatetags('philo.templatetags.nodes')
+register_value_model(Node)
\ No newline at end of file