1 from inspect import getargspec
3 from django.contrib.contenttypes import generic
4 from django.contrib.contenttypes.models import ContentType
5 from django.contrib.sites.models import Site, RequestSite
6 from django.core.exceptions import ValidationError
7 from django.core.servers.basehttp import FileWrapper
8 from django.core.urlresolvers import resolve, clear_url_caches, reverse, NoReverseMatch
9 from django.db import models
10 from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect, Http404
11 from django.template import add_to_builtins as register_templatetags
12 from django.utils.encoding import smart_str
14 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED, ViewCanNotProvideSubpath, ViewDoesNotProvideSubpaths
15 from philo.models.base import TreeEntity, Entity, register_value_model
16 from philo.models.fields import JSONField
17 from philo.utils import ContentTypeSubclassLimiter, LazyPassthroughAttributeMapper
18 from philo.signals import view_about_to_render, view_finished_rendering
21 _view_content_type_limiter = ContentTypeSubclassLimiter(None)
24 class Node(TreeEntity):
26 :class:`Node`\ s are the basic building blocks of a website using Philo. They define the URL hierarchy and connect each URL to a :class:`View` subclass instance which is used to generate an HttpResponse.
29 view_content_type = models.ForeignKey(ContentType, related_name='node_view_set', limit_choices_to=_view_content_type_limiter)
30 view_object_id = models.PositiveIntegerField()
31 #: :class:`GenericForeignKey` to a non-abstract subclass of :class:`View`
32 view = generic.GenericForeignKey('view_content_type', 'view_object_id')
35 def accepts_subpath(self):
36 """A property shortcut for :attr:`self.view.accepts_subpath <View.accepts_subpath>`"""
38 return self.view.accepts_subpath
41 def handles_subpath(self, subpath):
42 return self.view.handles_subpath(subpath)
44 def render_to_response(self, request, extra_context=None):
45 """This is a shortcut method for :meth:`View.render_to_response`"""
46 return self.view.render_to_response(request, extra_context)
48 def get_absolute_url(self, request=None, with_domain=False, secure=False):
50 This is essentially a shortcut for calling :meth:`construct_url` without a subpath.
52 :returns: The absolute url of the node on the current site.
55 return self.construct_url(request=request, with_domain=with_domain, secure=secure)
57 def construct_url(self, subpath="/", request=None, with_domain=False, secure=False):
59 This method will do its best to construct a URL based on the Node's location. If with_domain is True, that URL will include a domain and a protocol; if secure is True as well, the protocol will be https. The request will be used to construct a domain in cases where a call to :meth:`Site.objects.get_current` fails.
61 Node urls will not contain a trailing slash unless a subpath is provided which ends with a trailing slash. Subpaths are expected to begin with a slash, as if returned by :func:`django.core.urlresolvers.reverse`.
63 :meth:`construct_url` may raise the following exceptions:
65 - :class:`NoReverseMatch` if "philo-root" is not reversable -- for example, if :mod:`philo.urls` is not included anywhere in your urlpatterns.
66 - :class:`Site.DoesNotExist <ObjectDoesNotExist>` if with_domain is True but no :class:`Site` or :class:`RequestSite` can be built.
67 - :class:`~philo.exceptions.AncestorDoesNotExist` if the root node of the site isn't an ancestor of the node constructing the URL.
69 :param string subpath: The subpath to be constructed beyond beyond the node's URL.
70 :param request: :class:`HttpRequest` instance. Will be used to construct a :class:`RequestSite` if :meth:`Site.objects.get_current` fails.
71 :param with_domain: Whether the constructed URL should include a domain name and protocol.
72 :param secure: Whether the protocol, if included, should be http:// or https://.
73 :returns: A constructed url for accessing the given subpath of the current node instance.
76 # Try reversing philo-root first, since we can't do anything if that fails.
77 root_url = reverse('philo-root')
80 current_site = Site.objects.get_current()
81 except Site.DoesNotExist:
82 if request is not None:
83 current_site = RequestSite(request)
85 # If they want a domain and we can't figure one out,
86 # best to reraise the error to let them know.
91 root = getattr(current_site, 'root_node', None)
92 path = self.get_path(root=root)
94 if current_site and with_domain:
95 domain = "http%s://%s" % (secure and "s" or "", current_site.domain)
99 if not path or subpath == "/":
100 subpath = subpath[1:]
102 return '%s%s%s%s' % (domain, root_url, path, subpath)
108 # the following line enables the selection of a node as the root for a given django.contrib.sites Site object
109 models.ForeignKey(Node, related_name='sites', null=True, blank=True).contribute_to_class(Site, 'root_node')
114 :class:`View` is an abstract model that represents an item which can be "rendered", generally in response to an :class:`HttpRequest`.
117 #: A generic relation back to nodes.
118 nodes = generic.GenericRelation(Node, content_type_field='view_content_type', object_id_field='view_object_id')
120 #: Property or attribute which defines whether this :class:`View` can handle subpaths. Default: ``False``
121 accepts_subpath = False
123 def handles_subpath(self, subpath):
124 """Returns True if the :class:`View` handles the given subpath, and False otherwise."""
125 if not self.accepts_subpath and subpath != "/":
129 def reverse(self, view_name=None, args=None, kwargs=None, node=None, obj=None):
131 If :attr:`accepts_subpath` is True, try to reverse a URL using the given parameters using ``self`` as the urlconf.
133 If ``obj`` is provided, :meth:`get_reverse_params` will be called and the results will be combined with any ``view_name``, ``args``, and ``kwargs`` that may have been passed in.
135 :param view_name: The name of the view to be reversed.
136 :param args: Extra args for reversing the view.
137 :param kwargs: A dictionary of arguments for reversing the view.
138 :param node: The node whose subpath this is.
139 :param obj: An object to be passed to :meth:`get_reverse_params` to generate a view_name, args, and kwargs for reversal.
140 :returns: A subpath beyond the node that reverses the view, or an absolute url that reverses the view if a node was passed in.
141 :except philo.exceptions.ViewDoesNotProvideSubpaths: if :attr:`accepts_subpath` is False
142 :except philo.exceptions.ViewCanNotProvideSubpath: if a reversal is not possible.
145 if not self.accepts_subpath:
146 raise ViewDoesNotProvideSubpaths
149 # Perhaps just override instead of combining?
150 obj_view_name, obj_args, obj_kwargs = self.get_reverse_params(obj)
151 if view_name is None:
152 view_name = obj_view_name
153 args = list(obj_args) + list(args or [])
154 obj_kwargs.update(kwargs or {})
158 subpath = reverse(view_name, urlconf=self, args=args or [], kwargs=kwargs or {})
159 except NoReverseMatch, e:
160 raise ViewCanNotProvideSubpath(e.message)
163 return node.construct_url(subpath)
166 def get_reverse_params(self, obj):
168 This method is not implemented on the base class. It should return a (``view_name``, ``args``, ``kwargs``) tuple suitable for reversing a url for the given ``obj`` using ``self`` as the urlconf. If a reversal will not be possible, this method should raise :class:`~philo.exceptions.ViewCanNotProvideSubpath`.
171 raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.")
173 def attributes_with_node(self, node):
175 Returns a dictionary-like object which can be used to directly retrieve the values of :class:`Attribute`\ s related to the :class:`View`, falling back on similar object which retrieves the values of the passed-in node and its ancestors.
178 return LazyPassthroughAttributeMapper((self, node))
180 def render_to_response(self, request, extra_context=None):
182 Renders the :class:`View` as an :class:`HttpResponse`. This will raise :const:`~philo.exceptions.MIDDLEWARE_NOT_CONFIGURED` if the `request` doesn't have an attached :class:`Node`. This can happen if the :class:`~philo.middleware.RequestNodeMiddleware` is not in :setting:`settings.MIDDLEWARE_CLASSES` or if it is not functioning correctly.
184 :meth:`render_to_response` will send the :data:`~philo.signals.view_about_to_render` signal, then call :meth:`actually_render_to_response`, and finally send the :data:`~philo.signals.view_finished_rendering` signal before returning the ``response``.
187 if not hasattr(request, 'node'):
188 raise MIDDLEWARE_NOT_CONFIGURED
190 extra_context = extra_context or {}
191 view_about_to_render.send(sender=self, request=request, extra_context=extra_context)
192 response = self.actually_render_to_response(request, extra_context)
193 view_finished_rendering.send(sender=self, response=response)
196 def actually_render_to_response(self, request, extra_context=None):
197 """Concrete subclasses must override this method to provide the business logic for turning a ``request`` and ``extra_context`` into an :class:`HttpResponse`."""
198 raise NotImplementedError('View subclasses must implement actually_render_to_response.')
204 _view_content_type_limiter.cls = View
207 class MultiView(View):
209 :class:`MultiView` is an abstract model which represents a section of related pages - for example, a :class:`~philo.contrib.penfield.BlogView` might have a foreign key to :class:`Page`\ s for an index, an entry detail, an entry archive by day, and so on. :class:`!MultiView` subclasses :class:`View`, and defines the following additional methods and attributes:
212 #: Same as :attr:`View.accepts_subpath`. Default: ``True``
213 accepts_subpath = True
216 def urlpatterns(self):
217 """Returns urlpatterns that point to views (generally methods on the class). :class:`MultiView`\ s can be thought of as "managing" these subpaths."""
218 raise NotImplementedError("MultiView subclasses must implement urlpatterns.")
220 def handles_subpath(self, subpath):
221 if not super(MultiView, self).handles_subpath(subpath):
224 resolve(subpath, urlconf=self)
229 def actually_render_to_response(self, request, extra_context=None):
231 Resolves the remaining subpath left after finding this :class:`View`'s node using :attr:`self.urlpatterns <urlpatterns>` and renders the view function (or method) found with the appropriate args and kwargs.
235 subpath = request.node.subpath
236 view, args, kwargs = resolve(subpath, urlconf=self)
237 view_args = getargspec(view)
238 if extra_context is not None and ('extra_context' in view_args[0] or view_args[2] is not None):
239 if 'extra_context' in kwargs:
240 extra_context.update(kwargs['extra_context'])
241 kwargs['extra_context'] = extra_context
242 return view(request, *args, **kwargs)
244 def get_context(self):
245 """Hook for providing instance-specific context - such as the value of a Field - to any view methods on the instance."""
248 def basic_view(self, field_name):
250 Given the name of a field on the class, accesses the value of
251 that field and treats it as a ``View`` instance. Creates a
252 basic context based on self.get_context() and any extra_context
253 that was passed in, then calls the ``View`` instance's
254 render_to_response() method. This method is meant to be called
255 to return a view function appropriate for urlpatterns.
257 :param field_name: The name of a field on the instance which contains a :class:`View` subclass instance.
258 :returns: A simple view function.
262 class Foo(Multiview):
263 page = models.ForeignKey(Page)
266 def urlpatterns(self):
267 urlpatterns = patterns('',
268 url(r'^$', self.basic_view('page'))
273 field = self._meta.get_field(field_name)
274 view = getattr(self, field.name, None)
276 def inner(request, extra_context=None, **kwargs):
279 context = self.get_context()
280 context.update(extra_context or {})
281 return view.render_to_response(request, extra_context=context)
289 class TargetURLModel(models.Model):
290 """An abstract parent class for models which deal in targeting a url."""
291 #: An optional :class:`ForeignKey` to a :class:`Node`. If provided, that node will be used as the basis for the redirect.
292 target_node = models.ForeignKey(Node, blank=True, null=True, related_name="%(app_label)s_%(class)s_related")
293 #: A :class:`CharField` which may contain an absolute or relative URL, or the name of a node's subpath.
294 url_or_subpath = models.CharField(max_length=200, blank=True, help_text="Point to this url or, if a node is defined and accepts subpaths, this subpath of the node.")
295 #: A :class:`~philo.models.fields.JSONField` instance. If the value of :attr:`reversing_parameters` is not None, the :attr:`url_or_subpath` will be treated as the name of a view to be reversed. The value of :attr:`reversing_parameters` will be passed into the reversal as args if it is a list or as kwargs if it is a dictionary. Otherwise it will be ignored.
296 reversing_parameters = JSONField(blank=True, help_text="If reversing parameters are defined, url_or_subpath will instead be interpreted as the view name to be reversed.")
299 if not self.target_node and not self.url_or_subpath:
300 raise ValidationError("Either a target node or a url must be defined.")
302 if self.reversing_parameters and not (self.url_or_subpath or self.target_node):
303 raise ValidationError("Reversing parameters require either a view name or a target node.")
306 self.get_target_url()
307 except (NoReverseMatch, ViewCanNotProvideSubpath), e:
308 raise ValidationError(e.message)
310 super(TargetURLModel, self).clean()
312 def get_reverse_params(self):
313 params = self.reversing_parameters
315 if isinstance(params, list):
317 elif isinstance(params, dict):
318 # Convert unicode keys to strings for Python < 2.6.5. Compare
319 # http://stackoverflow.com/questions/4598604/how-to-pass-unicode-keywords-to-kwargs
320 kwargs = dict([(smart_str(k, 'ascii'), v) for k, v in params.items()])
321 return self.url_or_subpath, args, kwargs
323 def get_target_url(self):
324 """Calculates and returns the target url based on the :attr:`target_node`, :attr:`url_or_subpath`, and :attr:`reversing_parameters`."""
325 node = self.target_node
326 if node is not None and node.accepts_subpath and self.url_or_subpath:
327 if self.reversing_parameters is not None:
328 view_name, args, kwargs = self.get_reverse_params()
329 subpath = node.view.reverse(view_name, args=args, kwargs=kwargs)
331 subpath = self.url_or_subpath
332 if subpath[0] != '/':
333 subpath = '/' + subpath
334 return node.construct_url(subpath)
335 elif node is not None:
336 return node.get_absolute_url()
338 if self.reversing_parameters is not None:
339 view_name, args, kwargs = self.get_reverse_params()
340 return reverse(view_name, args=args, kwargs=kwargs)
341 return self.url_or_subpath
342 target_url = property(get_target_url)
348 class Redirect(TargetURLModel, View):
349 """Represents a 301 or 302 redirect to a different url on an absolute or relative path."""
350 #: A choices tuple of redirect status codes (temporary or permanent).
355 #: An :class:`IntegerField` which uses :attr:`STATUS_CODES` as its choices. Determines whether the redirect is considered temporary or permanent.
356 status_code = models.IntegerField(choices=STATUS_CODES, default=302, verbose_name='redirect type')
358 def actually_render_to_response(self, request, extra_context=None):
359 """Returns an :class:`HttpResponseRedirect` to :attr:`self.target_url`."""
360 response = HttpResponseRedirect(self.target_url)
361 response.status_code = self.status_code
369 """Stores an arbitrary file."""
370 #: Defines the mimetype of the uploaded file. This will not be validated.
371 mimetype = models.CharField(max_length=255)
372 #: Contains the uploaded file. Files are uploaded to ``philo/files/%Y/%m/%d``.
373 file = models.FileField(upload_to='philo/files/%Y/%m/%d')
375 def actually_render_to_response(self, request, extra_context=None):
376 wrapper = FileWrapper(self.file)
377 response = HttpResponse(wrapper, content_type=self.mimetype)
378 response['Content-Length'] = self.file.size
384 def __unicode__(self):
385 """Returns the path of the uploaded file."""
386 return self.file.name
389 register_templatetags('philo.templatetags.nodes')
390 register_value_model(Node)