Eliminated unnecessary ContentType queries from AttributeMapper._fill_cache.
[philo.git] / philo / models / nodes.py
1 from inspect import getargspec
2 import mimetypes
3 from os.path import basename
4
5 from django.contrib.contenttypes import generic
6 from django.contrib.contenttypes.models import ContentType
7 from django.contrib.sites.models import Site, RequestSite
8 from django.core.exceptions import ValidationError
9 from django.core.servers.basehttp import FileWrapper
10 from django.core.urlresolvers import resolve, clear_url_caches, reverse, NoReverseMatch
11 from django.db import models
12 from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect, Http404
13 from django.utils.encoding import smart_str
14
15 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED, ViewCanNotProvideSubpath, ViewDoesNotProvideSubpaths
16 from philo.models.base import SlugTreeEntity, Entity, register_value_model
17 from philo.models.fields import JSONField
18 from philo.utils import ContentTypeSubclassLimiter
19 from philo.utils.entities import LazyPassthroughAttributeMapper
20 from philo.signals import view_about_to_render, view_finished_rendering
21
22
23 __all__ = ('Node', 'View', 'MultiView', 'Redirect', 'File')
24
25
26 _view_content_type_limiter = ContentTypeSubclassLimiter(None)
27
28
29 class Node(SlugTreeEntity):
30         """
31         :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.
32         
33         """
34         view_content_type = models.ForeignKey(ContentType, related_name='node_view_set', limit_choices_to=_view_content_type_limiter, blank=True, null=True)
35         view_object_id = models.PositiveIntegerField(blank=True, null=True)
36         #: :class:`GenericForeignKey` to a non-abstract subclass of :class:`View`
37         view = generic.GenericForeignKey('view_content_type', 'view_object_id')
38         
39         @property
40         def accepts_subpath(self):
41                 """A property shortcut for :attr:`self.view.accepts_subpath <View.accepts_subpath>`"""
42                 if self.view:
43                         return self.view.accepts_subpath
44                 return False
45         
46         def handles_subpath(self, subpath):
47                 if self.view:
48                         return self.view.handles_subpath(subpath)
49                 return False
50         
51         def render_to_response(self, request, extra_context=None):
52                 """This is a shortcut method for :meth:`View.render_to_response`"""
53                 if self.view:
54                         return self.view.render_to_response(request, extra_context)
55                 raise Http404
56         
57         def get_absolute_url(self, request=None, with_domain=False, secure=False):
58                 """
59                 This is essentially a shortcut for calling :meth:`construct_url` without a subpath.
60                 
61                 :returns: The absolute url of the node on the current site.
62                 
63                 """
64                 return self.construct_url(request=request, with_domain=with_domain, secure=secure)
65         
66         def construct_url(self, subpath="/", request=None, with_domain=False, secure=False):
67                 """
68                 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.
69                 
70                 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`.
71                 
72                 :meth:`construct_url` may raise the following exceptions:
73                 
74                 - :class:`NoReverseMatch` if "philo-root" is not reversable -- for example, if :mod:`philo.urls` is not included anywhere in your urlpatterns.
75                 - :class:`Site.DoesNotExist <ObjectDoesNotExist>` if with_domain is True but no :class:`Site` or :class:`RequestSite` can be built.
76                 - :class:`~philo.exceptions.AncestorDoesNotExist` if the root node of the site isn't an ancestor of the node constructing the URL.
77                 
78                 :param string subpath: The subpath to be constructed beyond beyond the node's URL.
79                 :param request: :class:`HttpRequest` instance. Will be used to construct a :class:`RequestSite` if :meth:`Site.objects.get_current` fails.
80                 :param with_domain: Whether the constructed URL should include a domain name and protocol.
81                 :param secure: Whether the protocol, if included, should be http:// or https://.
82                 :returns: A constructed url for accessing the given subpath of the current node instance.
83                 
84                 """
85                 # Try reversing philo-root first, since we can't do anything if that fails.
86                 root_url = reverse('philo-root')
87                 
88                 try:
89                         current_site = Site.objects.get_current()
90                 except Site.DoesNotExist:
91                         if request is not None:
92                                 current_site = RequestSite(request)
93                         elif with_domain:
94                                 # If they want a domain and we can't figure one out,
95                                 # best to reraise the error to let them know.
96                                 raise
97                         else:
98                                 current_site = None
99                 
100                 root = getattr(current_site, 'root_node', None)
101                 path = self.get_path(root=root)
102                 
103                 if current_site and with_domain:
104                         domain = "http%s://%s" % (secure and "s" or "", current_site.domain)
105                 else:
106                         domain = ""
107                 
108                 if not path or subpath == "/":
109                         subpath = subpath[1:]
110                 
111                 return '%s%s%s%s' % (domain, root_url, path, subpath)
112         
113         class Meta(SlugTreeEntity.Meta):
114                 app_label = 'philo'
115
116
117 # the following line enables the selection of a node as the root for a given django.contrib.sites Site object
118 models.ForeignKey(Node, related_name='sites', null=True, blank=True).contribute_to_class(Site, 'root_node')
119
120
121 class View(Entity):
122         """
123         :class:`View` is an abstract model that represents an item which can be "rendered", generally in response to an :class:`HttpRequest`.
124         
125         """
126         #: A generic relation back to nodes.
127         nodes = generic.GenericRelation(Node, content_type_field='view_content_type', object_id_field='view_object_id')
128         
129         #: Property or attribute which defines whether this :class:`View` can handle subpaths. Default: ``False``
130         accepts_subpath = False
131         
132         def handles_subpath(self, subpath):
133                 """Returns True if the :class:`View` handles the given subpath, and False otherwise."""
134                 if not self.accepts_subpath and subpath != "/":
135                         return False
136                 return True
137         
138         def reverse(self, view_name=None, args=None, kwargs=None, node=None, obj=None):
139                 """
140                 If :attr:`accepts_subpath` is True, try to reverse a URL using the given parameters using ``self`` as the urlconf.
141                 
142                 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.
143                 
144                 :param view_name: The name of the view to be reversed.
145                 :param args: Extra args for reversing the view.
146                 :param kwargs: A dictionary of arguments for reversing the view.
147                 :param node: The node whose subpath this is.
148                 :param obj: An object to be passed to :meth:`get_reverse_params` to generate a view_name, args, and kwargs for reversal.
149                 :returns: A subpath beyond the node that reverses the view, or an absolute url that reverses the view if a node was passed in.
150                 :except philo.exceptions.ViewDoesNotProvideSubpaths: if :attr:`accepts_subpath` is False
151                 :except philo.exceptions.ViewCanNotProvideSubpath: if a reversal is not possible.
152                 
153                 """
154                 if not self.accepts_subpath:
155                         raise ViewDoesNotProvideSubpaths
156                 
157                 if obj is not None:
158                         # Perhaps just override instead of combining?
159                         obj_view_name, obj_args, obj_kwargs = self.get_reverse_params(obj)
160                         if view_name is None:
161                                 view_name = obj_view_name
162                         args = list(obj_args) + list(args or [])
163                         obj_kwargs.update(kwargs or {})
164                         kwargs = obj_kwargs
165                 
166                 try:
167                         subpath = reverse(view_name, urlconf=self, args=args or [], kwargs=kwargs or {})
168                 except NoReverseMatch, e:
169                         raise ViewCanNotProvideSubpath(e.message)
170                 
171                 if node is not None:
172                         return node.construct_url(subpath)
173                 return subpath
174         
175         def get_reverse_params(self, obj):
176                 """
177                 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`.
178                 
179                 """
180                 raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.")
181         
182         def attributes_with_node(self, node, mapper=LazyPassthroughAttributeMapper):
183                 """
184                 Returns a :class:`LazyPassthroughAttributeMapper` which can be used to directly retrieve the values of :class:`Attribute`\ s related to the :class:`View`, falling back on the :class:`Attribute`\ s of the passed-in :class:`Node` and its ancestors.
185                 
186                 """
187                 return mapper((self, node))
188         
189         def render_to_response(self, request, extra_context=None):
190                 """
191                 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.
192                 
193                 :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``.
194
195                 """
196                 if not hasattr(request, 'node'):
197                         raise MIDDLEWARE_NOT_CONFIGURED
198                 
199                 extra_context = extra_context or {}
200                 view_about_to_render.send(sender=self, request=request, extra_context=extra_context)
201                 response = self.actually_render_to_response(request, extra_context)
202                 view_finished_rendering.send(sender=self, response=response)
203                 return response
204         
205         def actually_render_to_response(self, request, extra_context=None):
206                 """Concrete subclasses must override this method to provide the business logic for turning a ``request`` and ``extra_context`` into an :class:`HttpResponse`."""
207                 raise NotImplementedError('View subclasses must implement actually_render_to_response.')
208         
209         class Meta:
210                 abstract = True
211
212
213 _view_content_type_limiter.cls = View
214
215
216 class MultiView(View):
217         """
218         :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:
219         
220         """
221         #: Same as :attr:`View.accepts_subpath`. Default: ``True``
222         accepts_subpath = True
223         
224         @property
225         def urlpatterns(self):
226                 """Returns urlpatterns that point to views (generally methods on the class). :class:`MultiView`\ s can be thought of as "managing" these subpaths."""
227                 raise NotImplementedError("MultiView subclasses must implement urlpatterns.")
228         
229         def handles_subpath(self, subpath):
230                 if not super(MultiView, self).handles_subpath(subpath):
231                         return False
232                 try:
233                         resolve(subpath, urlconf=self)
234                 except Http404:
235                         return False
236                 return True
237         
238         def actually_render_to_response(self, request, extra_context=None):
239                 """
240                 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.
241                 
242                 """
243                 clear_url_caches()
244                 subpath = request.node._subpath
245                 view, args, kwargs = resolve(subpath, urlconf=self)
246                 view_args = getargspec(view)
247                 if extra_context is not None and ('extra_context' in view_args[0] or view_args[2] is not None):
248                         if 'extra_context' in kwargs:
249                                 extra_context.update(kwargs['extra_context'])
250                         kwargs['extra_context'] = extra_context
251                 return view(request, *args, **kwargs)
252         
253         def get_context(self):
254                 """Hook for providing instance-specific context - such as the value of a Field - to any view methods on the instance."""
255                 return {}
256         
257         def basic_view(self, field_name):
258                 """
259                 Given the name of a field on the class, accesses the value of
260                 that field and treats it as a ``View`` instance. Creates a
261                 basic context based on self.get_context() and any extra_context
262                 that was passed in, then calls the ``View`` instance's
263                 render_to_response() method. This method is meant to be called
264                 to return a view function appropriate for urlpatterns.
265                 
266                 :param field_name: The name of a field on the instance which contains a :class:`View` subclass instance.
267                 :returns: A simple view function.
268                 
269                 Example::
270                         
271                         class Foo(Multiview):
272                                 page = models.ForeignKey(Page)
273                                 
274                                 @property
275                                 def urlpatterns(self):
276                                         urlpatterns = patterns('',
277                                                 url(r'^$', self.basic_view('page'))
278                                         )
279                                         return urlpatterns
280                 
281                 """
282                 field = self._meta.get_field(field_name)
283                 view = getattr(self, field.name, None)
284                 
285                 def inner(request, extra_context=None, **kwargs):
286                         if not view:
287                                 raise Http404
288                         context = self.get_context()
289                         context.update(extra_context or {})
290                         return view.render_to_response(request, extra_context=context)
291                 
292                 return inner
293         
294         class Meta:
295                 abstract = True
296
297
298 class TargetURLModel(models.Model):
299         """An abstract parent class for models which deal in targeting a url."""
300         #: An optional :class:`ForeignKey` to a :class:`.Node`. If provided, that node will be used as the basis for the redirect.
301         target_node = models.ForeignKey(Node, blank=True, null=True, related_name="%(app_label)s_%(class)s_related")
302         #: A :class:`CharField` which may contain an absolute or relative URL, or the name of a node's subpath.
303         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.")
304         #: 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.
305         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.")
306         
307         def clean(self):
308                 if not self.target_node and not self.url_or_subpath:
309                         raise ValidationError("Either a target node or a url must be defined.")
310                 
311                 if self.reversing_parameters and not (self.url_or_subpath or self.target_node):
312                         raise ValidationError("Reversing parameters require either a view name or a target node.")
313                 
314                 try:
315                         self.get_target_url()
316                 except (NoReverseMatch, ViewCanNotProvideSubpath), e:
317                         raise ValidationError(e.message)
318                 
319                 super(TargetURLModel, self).clean()
320         
321         def get_reverse_params(self):
322                 params = self.reversing_parameters
323                 args = kwargs = None
324                 if isinstance(params, list):
325                         args = params
326                 elif isinstance(params, dict):
327                         # Convert unicode keys to strings for Python < 2.6.5. Compare
328                         # http://stackoverflow.com/questions/4598604/how-to-pass-unicode-keywords-to-kwargs
329                         kwargs = dict([(smart_str(k, 'ascii'), v) for k, v in params.items()])
330                 return self.url_or_subpath, args, kwargs
331         
332         def get_target_url(self):
333                 """Calculates and returns the target url based on the :attr:`target_node`, :attr:`url_or_subpath`, and :attr:`reversing_parameters`."""
334                 node = self.target_node
335                 if node is not None and node.accepts_subpath and self.url_or_subpath:
336                         if self.reversing_parameters is not None:
337                                 view_name, args, kwargs = self.get_reverse_params()
338                                 subpath = node.view.reverse(view_name, args=args, kwargs=kwargs)
339                         else:
340                                 subpath = self.url_or_subpath
341                                 if subpath[0] != '/':
342                                         subpath = '/' + subpath
343                         return node.construct_url(subpath)
344                 elif node is not None:
345                         return node.get_absolute_url()
346                 else:
347                         if self.reversing_parameters is not None:
348                                 view_name, args, kwargs = self.get_reverse_params()
349                                 return reverse(view_name, args=args, kwargs=kwargs)
350                         return self.url_or_subpath
351         target_url = property(get_target_url)
352         
353         class Meta:
354                 abstract = True
355
356
357 class Redirect(TargetURLModel, View):
358         """Represents a 301 or 302 redirect to a different url on an absolute or relative path."""
359         #: A choices tuple of redirect status codes (temporary or permanent).
360         STATUS_CODES = (
361                 (302, 'Temporary'),
362                 (301, 'Permanent'),
363         )
364         #: An :class:`IntegerField` which uses :attr:`STATUS_CODES` as its choices. Determines whether the redirect is considered temporary or permanent.
365         status_code = models.IntegerField(choices=STATUS_CODES, default=302, verbose_name='redirect type')
366         
367         def actually_render_to_response(self, request, extra_context=None):
368                 """Returns an :class:`HttpResponseRedirect` to :attr:`self.target_url`."""
369                 response = HttpResponseRedirect(self.target_url)
370                 response.status_code = self.status_code
371                 return response
372         
373         class Meta:
374                 app_label = 'philo'
375
376
377 class File(View):
378         """Stores an arbitrary file."""
379         #: The name of the uploaded file. This is meant for finding the file again later, not for display.
380         name = models.CharField(max_length=255)
381         #: Defines the mimetype of the uploaded file. This will not be validated. If no mimetype is provided, it will be automatically generated based on the filename.
382         mimetype = models.CharField(max_length=255, blank=True)
383         #: Contains the uploaded file. Files are uploaded to ``philo/files/%Y/%m/%d``.
384         file = models.FileField(upload_to='philo/files/%Y/%m/%d')
385         
386         def clean(self):
387                 if not self.mimetype:
388                         self.mimetype = mimetypes.guess_type(self.file.name, strict=False)[0]
389                         if self.mimetype is None:
390                                 raise ValidationError("Unknown file type.")
391         
392         def actually_render_to_response(self, request, extra_context=None):
393                 wrapper = FileWrapper(self.file)
394                 response = HttpResponse(wrapper, content_type=self.mimetype)
395                 response['Content-Length'] = self.file.size
396                 response['Content-Disposition'] = "inline; filename=%s" % basename(self.file.name)
397                 return response
398         
399         class Meta:
400                 app_label = 'philo'
401         
402         def __unicode__(self):
403                 """Returns the value of :attr:`File.name`."""
404                 return self.name
405
406
407 register_value_model(Node)