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