Merge branch 'master' into docs
[philo.git] / models / nodes.py
1 from django.db import models
2 from django.contrib.contenttypes.models import ContentType
3 from django.contrib.contenttypes import generic
4 from django.contrib.sites.models import Site, RequestSite
5 from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect, Http404
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.template import add_to_builtins as register_templatetags
10 from inspect import getargspec
11 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED
12 from philo.models.base import TreeEntity, Entity, QuerySetMapper, register_value_model
13 from philo.models.fields import JSONField
14 from philo.utils import ContentTypeSubclassLimiter
15 from philo.validators import RedirectValidator
16 from philo.exceptions import ViewCanNotProvideSubpath, ViewDoesNotProvideSubpaths, AncestorDoesNotExist
17 from philo.signals import view_about_to_render, view_finished_rendering
18
19
20 _view_content_type_limiter = ContentTypeSubclassLimiter(None)
21
22
23 class Node(TreeEntity):
24         view_content_type = models.ForeignKey(ContentType, related_name='node_view_set', limit_choices_to=_view_content_type_limiter)
25         view_object_id = models.PositiveIntegerField()
26         view = generic.GenericForeignKey('view_content_type', 'view_object_id')
27         
28         @property
29         def accepts_subpath(self):
30                 if self.view:
31                         return self.view.accepts_subpath
32                 return False
33         
34         def handles_subpath(self, subpath):
35                 return self.view.handles_subpath(subpath)
36         
37         def render_to_response(self, request, extra_context=None):
38                 return self.view.render_to_response(request, extra_context)
39         
40         def get_absolute_url(self, request=None, with_domain=False, secure=False):
41                 return self.construct_url(request=request, with_domain=with_domain, secure=secure)
42         
43         def construct_url(self, subpath="/", request=None, with_domain=False, secure=False):
44                 """
45                 This method will construct a URL based on the Node's location.
46                 If a request is passed in, that will be used as a backup in case
47                 the Site lookup fails. The Site lookup takes precedence because
48                 it's what's used to find the root node. This will raise:
49                 - NoReverseMatch if philo-root is not reverseable
50                 - Site.DoesNotExist if a domain is requested but not buildable.
51                 - AncestorDoesNotExist if the root node of the site isn't an
52                   ancestor of this instance.
53                 """
54                 # Try reversing philo-root first, since we can't do anything if that fails.
55                 root_url = reverse('philo-root')
56                 
57                 try:
58                         current_site = Site.objects.get_current()
59                 except Site.DoesNotExist:
60                         if request is not None:
61                                 current_site = RequestSite(request)
62                         elif with_domain:
63                                 # If they want a domain and we can't figure one out,
64                                 # best to reraise the error to let them know.
65                                 raise
66                         else:
67                                 current_site = None
68                 
69                 root = getattr(current_site, 'root_node', None)
70                 path = self.get_path(root=root)
71                 
72                 if current_site and with_domain:
73                         domain = "http%s://%s" % (secure and "s" or "", current_site.domain)
74                 else:
75                         domain = ""
76                 
77                 if not path or subpath == "/":
78                         subpath = subpath[1:]
79                 
80                 return '%s%s%s%s' % (domain, root_url, path, subpath)
81         
82         class Meta:
83                 app_label = 'philo'
84
85
86 # the following line enables the selection of a node as the root for a given django.contrib.sites Site object
87 models.ForeignKey(Node, related_name='sites', null=True, blank=True).contribute_to_class(Site, 'root_node')
88
89
90 class View(Entity):
91         nodes = generic.GenericRelation(Node, content_type_field='view_content_type', object_id_field='view_object_id')
92         
93         accepts_subpath = False
94         
95         def handles_subpath(self, subpath):
96                 if not self.accepts_subpath and subpath != "/":
97                         return False
98                 return True
99         
100         def reverse(self, view_name=None, args=None, kwargs=None, node=None, obj=None):
101                 """Shortcut method to handle the common pattern of getting the
102                 absolute url for a view's subpaths."""
103                 if not self.accepts_subpath:
104                         raise ViewDoesNotProvideSubpaths
105                 
106                 if obj is not None:
107                         # Perhaps just override instead of combining?
108                         obj_view_name, obj_args, obj_kwargs = self.get_reverse_params(obj)
109                         if view_name is None:
110                                 view_name = obj_view_name
111                         args = list(obj_args) + list(args or [])
112                         obj_kwargs.update(kwargs or {})
113                         kwargs = obj_kwargs
114                 
115                 try:
116                         subpath = reverse(view_name, urlconf=self, args=args or [], kwargs=kwargs or {})
117                 except NoReverseMatch, e:
118                         raise ViewCanNotProvideSubpath(e.message)
119                 
120                 if node is not None:
121                         return node.construct_url(subpath)
122                 return subpath
123         
124         def get_reverse_params(self, obj):
125                 """This method should return a view_name, args, kwargs tuple suitable for reversing a url for the given obj using self as the urlconf."""
126                 raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.")
127         
128         def attributes_with_node(self, node):
129                 return QuerySetMapper(self.attribute_set, passthrough=node.attributes)
130         
131         def render_to_response(self, request, extra_context=None):
132                 if not hasattr(request, 'node'):
133                         raise MIDDLEWARE_NOT_CONFIGURED
134                 
135                 extra_context = extra_context or {}
136                 view_about_to_render.send(sender=self, request=request, extra_context=extra_context)
137                 response = self.actually_render_to_response(request, extra_context)
138                 view_finished_rendering.send(sender=self, response=response)
139                 return response
140         
141         def actually_render_to_response(self, request, extra_context=None):
142                 raise NotImplementedError('View subclasses must implement actually_render_to_response.')
143         
144         class Meta:
145                 abstract = True
146
147
148 _view_content_type_limiter.cls = View
149
150
151 class MultiView(View):
152         accepts_subpath = True
153         
154         @property
155         def urlpatterns(self):
156                 raise NotImplementedError("MultiView subclasses must implement urlpatterns.")
157         
158         def handles_subpath(self, subpath):
159                 if not super(MultiView, self).handles_subpath(subpath):
160                         return False
161                 try:
162                         resolve(subpath, urlconf=self)
163                 except Http404:
164                         return False
165                 return True
166         
167         def actually_render_to_response(self, request, extra_context=None):
168                 clear_url_caches()
169                 subpath = request.node.subpath
170                 view, args, kwargs = resolve(subpath, urlconf=self)
171                 view_args = getargspec(view)
172                 if extra_context is not None and ('extra_context' in view_args[0] or view_args[2] is not None):
173                         if 'extra_context' in kwargs:
174                                 extra_context.update(kwargs['extra_context'])
175                         kwargs['extra_context'] = extra_context
176                 return view(request, *args, **kwargs)
177         
178         def get_context(self):
179                 """Hook for providing instance-specific context - such as the value of a Field - to all views."""
180                 return {}
181         
182         def basic_view(self, field_name):
183                 """
184                 Given the name of a field on ``self``, accesses the value of
185                 that field and treats it as a ``View`` instance. Creates a
186                 basic context based on self.get_context() and any extra_context
187                 that was passed in, then calls the ``View`` instance's
188                 render_to_response() method. This method is meant to be called
189                 to return a view function appropriate for urlpatterns.
190                 """
191                 field = self._meta.get_field(field_name)
192                 view = getattr(self, field.name, None)
193                 
194                 def inner(request, extra_context=None, **kwargs):
195                         if not view:
196                                 raise Http404
197                         context = self.get_context()
198                         context.update(extra_context or {})
199                         return view.render_to_response(request, extra_context=context)
200                 
201                 return inner
202         
203         class Meta:
204                 abstract = True
205
206
207 class TargetURLModel(models.Model):
208         target_node = models.ForeignKey(Node, blank=True, null=True, related_name="%(app_label)s_%(class)s_related")
209         url_or_subpath = models.CharField(max_length=200, validators=[RedirectValidator()], blank=True, help_text="Point to this url or, if a node is defined and accepts subpaths, this subpath of the node.")
210         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.")
211         
212         def clean(self):
213                 # Should this be enforced? Not enforcing it would allow creation of "headers" in the navbar.
214                 if not self.target_node and not self.url_or_subpath:
215                         raise ValidationError("Either a target node or a url must be defined.")
216                 
217                 if self.reversing_parameters and not (self.url_or_subpath or self.target_node):
218                         raise ValidationError("Reversing parameters require either a view name or a target node.")
219                 
220                 try:
221                         self.get_target_url()
222                 except (NoReverseMatch, ViewCanNotProvideSubpath), e:
223                         raise ValidationError(e.message)
224                 
225                 super(TargetURLModel, self).clean()
226         
227         def get_reverse_params(self):
228                 params = self.reversing_parameters
229                 args = kwargs = None
230                 if isinstance(params, list):
231                         args = params
232                 elif isinstance(params, dict):
233                         # Convert unicode keys to strings for Python < 2.6.5. Compare
234                         # http://stackoverflow.com/questions/4598604/how-to-pass-unicode-keywords-to-kwargs
235                         kwargs = {}
236                         for key, val in params.items():
237                                 if isinstance(key, unicode):
238                                         key = str(key)
239                                 kwargs[key] = val
240                 return self.url_or_subpath, args, kwargs
241         
242         def get_target_url(self):
243                 node = self.target_node
244                 if node is not None and node.accepts_subpath and self.url_or_subpath:
245                         if self.reversing_parameters is not None:
246                                 view_name, args, kwargs = self.get_reverse_params()
247                                 subpath = node.view.reverse(view_name, args=args, kwargs=kwargs)
248                         else:
249                                 subpath = self.url_or_subpath
250                                 if subpath[0] != '/':
251                                         subpath = '/' + subpath
252                         return node.construct_url(subpath)
253                 elif node is not None:
254                         return node.get_absolute_url()
255                 else:
256                         if self.reversing_parameters is not None:
257                                 view_name, args, kwargs = self.get_reverse_params()
258                                 return reverse(view_name, args=args, kwargs=kwargs)
259                         return self.url_or_subpath
260         target_url = property(get_target_url)
261         
262         class Meta:
263                 abstract = True
264
265
266 class Redirect(View, TargetURLModel):
267         STATUS_CODES = (
268                 (302, 'Temporary'),
269                 (301, 'Permanent'),
270         )
271         status_code = models.IntegerField(choices=STATUS_CODES, default=302, verbose_name='redirect type')
272         
273         def actually_render_to_response(self, request, extra_context=None):
274                 response = HttpResponseRedirect(self.target_url)
275                 response.status_code = self.status_code
276                 return response
277         
278         class Meta:
279                 app_label = 'philo'
280
281
282 class File(View):
283         """ For storing arbitrary files """
284         
285         mimetype = models.CharField(max_length=255)
286         file = models.FileField(upload_to='philo/files/%Y/%m/%d')
287         
288         def actually_render_to_response(self, request, extra_context=None):
289                 wrapper = FileWrapper(self.file)
290                 response = HttpResponse(wrapper, content_type=self.mimetype)
291                 response['Content-Length'] = self.file.size
292                 return response
293         
294         class Meta:
295                 app_label = 'philo'
296         
297         def __unicode__(self):
298                 return self.file.name
299
300
301 register_templatetags('philo.templatetags.nodes')
302 register_value_model(Node)