|
|
@@ -0,0 +1,954 @@
|
|
|
1
|
+from django.conf.urls import url
|
|
|
2
|
+from django.contrib.auth.decorators import login_required
|
|
|
3
|
+from django.core.exceptions import ImproperlyConfigured, ValidationError
|
|
|
4
|
+from django.db.models.query import QuerySet
|
|
|
5
|
+from django.http import Http404
|
|
|
6
|
+from django.urls import reverse
|
|
|
7
|
+from django.shortcuts import get_object_or_404
|
|
|
8
|
+from django.views import generic
|
|
|
9
|
+import django_tables2
|
|
|
10
|
+
|
|
|
11
|
+import copy
|
|
|
12
|
+import threading
|
|
|
13
|
+
|
|
|
14
|
+#import logging
|
|
|
15
|
+#logger = logging.getLogger("console")
|
|
|
16
|
+
|
|
|
17
|
+LIST_VIEW_TYPE = 'list'
|
|
|
18
|
+CREATE_VIEW_TYPE = 'create'
|
|
|
19
|
+DETAIL_VIEW_TYPE = 'detail'
|
|
|
20
|
+UPDATE_VIEW_TYPE = 'update'
|
|
|
21
|
+DELETE_VIEW_TYPE = 'delete'
|
|
|
22
|
+
|
|
|
23
|
+# Used in the case where a viewset functions only as a nested list view, and
|
|
|
24
|
+# therefore doesn't require any URLs of its own.
|
|
|
25
|
+NOT_FOUND_VIEW_TYPE = 'not_found'
|
|
|
26
|
+
|
|
|
27
|
+INSTANCE_VIEW_TYPES = [DETAIL_VIEW_TYPE, UPDATE_VIEW_TYPE, DELETE_VIEW_TYPE]
|
|
|
28
|
+
|
|
|
29
|
+class SaveErrorHandlerMixin(object):
|
|
|
30
|
+ def form_valid(self, form):
|
|
|
31
|
+ try:
|
|
|
32
|
+ return super(SaveErrorHandlerMixin, self).form_valid(form)
|
|
|
33
|
+ except ValidationError as e:
|
|
|
34
|
+ for field, errors in e:
|
|
|
35
|
+ form.add_error(field, errors)
|
|
|
36
|
+ return self.form_invalid(form)
|
|
|
37
|
+
|
|
|
38
|
+class CrudViewset(object):
|
|
|
39
|
+ model = None
|
|
|
40
|
+ queryset = None
|
|
|
41
|
+
|
|
|
42
|
+ root_breadcrumbs = []
|
|
|
43
|
+
|
|
|
44
|
+ master_viewset_class = None
|
|
|
45
|
+ nested_list_view_index = None
|
|
|
46
|
+
|
|
|
47
|
+ # Setting this to any of the instance view types will cause the master
|
|
|
48
|
+ # viewset to use its instance_breadcrumb_view_type setting, so the only
|
|
|
49
|
+ # other value that makes sense is LIST_VIEW_TYPE.
|
|
|
50
|
+ master_viewset_breadcrumb_view_type = DETAIL_VIEW_TYPE
|
|
|
51
|
+
|
|
|
52
|
+ # instance_breadcrumb_text.format(instance)
|
|
|
53
|
+ instance_breadcrumb_text = u"{0}"
|
|
|
54
|
+ instance_breadcrumb_view_type = DETAIL_VIEW_TYPE
|
|
|
55
|
+
|
|
|
56
|
+ lookup_field = 'pk'
|
|
|
57
|
+ lookup_url_kwarg = 'pk'
|
|
|
58
|
+ lookup_url_kwarg_pattern = r'\d+'
|
|
|
59
|
+
|
|
|
60
|
+ lookup_regex = None
|
|
|
61
|
+
|
|
|
62
|
+ view_url_kwarg_names = []
|
|
|
63
|
+
|
|
|
64
|
+ active_nested_list_view_query_param = 't'
|
|
|
65
|
+
|
|
|
66
|
+ view_decorator = staticmethod(login_required)
|
|
|
67
|
+
|
|
|
68
|
+ exclude_views = []
|
|
|
69
|
+
|
|
|
70
|
+ create_button_text = 'Create'
|
|
|
71
|
+ create_button_class = 'btn-primary'
|
|
|
72
|
+
|
|
|
73
|
+ edit_button_text = 'Edit'
|
|
|
74
|
+ edit_button_class = 'btn-primary'
|
|
|
75
|
+
|
|
|
76
|
+ delete_button_text = 'Delete'
|
|
|
77
|
+ delete_button_class = 'btn-danger'
|
|
|
78
|
+
|
|
|
79
|
+ back_button_text = 'Back'
|
|
|
80
|
+ back_button_class = 'btn-default'
|
|
|
81
|
+
|
|
|
82
|
+ base_template_shim = None
|
|
|
83
|
+
|
|
|
84
|
+ list_view_template_name = None
|
|
|
85
|
+ create_view_template_name = 'crud/create_view.html'
|
|
|
86
|
+ detail_view_template_name = 'crud/detail_view.html'
|
|
|
87
|
+ update_view_template_name = 'crud/update_view.html'
|
|
|
88
|
+ delete_view_template_name = 'crud/delete_view.html'
|
|
|
89
|
+
|
|
|
90
|
+ # list_view_title.format(model.verbose_name_plural) if model can be
|
|
|
91
|
+ # determined. The value is set to None here in case model cannot be
|
|
|
92
|
+ # determined, in which case a specific value must be provided.
|
|
|
93
|
+ list_view_title = None
|
|
|
94
|
+
|
|
|
95
|
+ # create_view_title.format(model.verbose_name) if model can be determined.
|
|
|
96
|
+ # The value is set to None here in case model cannot be determined, in
|
|
|
97
|
+ # which case a specific value must be provided.
|
|
|
98
|
+ create_view_title = None
|
|
|
99
|
+
|
|
|
100
|
+ # *_view_title.format(view.object)
|
|
|
101
|
+ detail_view_title = u"{0}"
|
|
|
102
|
+ update_view_title = u"Edit {0}"
|
|
|
103
|
+ delete_view_title = u"Delete {0}"
|
|
|
104
|
+
|
|
|
105
|
+ success_url = None
|
|
|
106
|
+ create_view_success_url = None
|
|
|
107
|
+ update_view_success_url = None
|
|
|
108
|
+ delete_view_success_url = None
|
|
|
109
|
+
|
|
|
110
|
+ filter_class = None
|
|
|
111
|
+
|
|
|
112
|
+ form_class = None
|
|
|
113
|
+ create_view_form_class = None
|
|
|
114
|
+ update_view_form_class = None
|
|
|
115
|
+
|
|
|
116
|
+ form_exclude = []
|
|
|
117
|
+ create_view_form_exclude = None
|
|
|
118
|
+ update_view_form_exclude = None
|
|
|
119
|
+
|
|
|
120
|
+ list_view_base_class = generic.ListView
|
|
|
121
|
+ create_view_base_class = generic.CreateView
|
|
|
122
|
+
|
|
|
123
|
+ def __init__(self):
|
|
|
124
|
+ self.master_viewset = None
|
|
|
125
|
+ self.nested_list_views = []
|
|
|
126
|
+ self.is_list_view_nested = (self.master_viewset_class is not None) and (self.nested_list_view_index is not None)
|
|
|
127
|
+ self.list_view_query_param_prefix = self.get_list_view_query_param_prefix()
|
|
|
128
|
+
|
|
|
129
|
+ # This will be set to an empty string later if no nested list views are
|
|
|
130
|
+ # linked to this view. We need the value in the detail view before then,
|
|
|
131
|
+ # however.
|
|
|
132
|
+ self.nested_list_view_query_param_prefix = self.get_nested_list_view_query_param_prefix()
|
|
|
133
|
+
|
|
|
134
|
+ # Remove the trailing '-' as django_filter adds it in again.
|
|
|
135
|
+ self.filter_query_param_prefix = self.list_view_query_param_prefix[:-1]
|
|
|
136
|
+
|
|
|
137
|
+ # Cache the get_filter_class result in an instance attribute, which will
|
|
|
138
|
+ # hide the class attribute of the same name.
|
|
|
139
|
+ self.filter_class = self.get_filter_class()
|
|
|
140
|
+
|
|
|
141
|
+ self.base_view_mixin = None
|
|
|
142
|
+ self.views = {}
|
|
|
143
|
+
|
|
|
144
|
+ self.exclude_views = set(self.exclude_views)
|
|
|
145
|
+ if self.is_list_view_nested:
|
|
|
146
|
+ self.exclude_views.add(LIST_VIEW_TYPE)
|
|
|
147
|
+
|
|
|
148
|
+ if self.model is None:
|
|
|
149
|
+ queryset = self.get_queryset(None)
|
|
|
150
|
+ if isinstance(queryset, QuerySet):
|
|
|
151
|
+ self.model = queryset.model
|
|
|
152
|
+ elif self.queryset is None:
|
|
|
153
|
+ # It's the user's problem if they define 'model' and override
|
|
|
154
|
+ # 'get_queryset' at the same time.
|
|
|
155
|
+ self.queryset = self.model._default_manager.all()
|
|
|
156
|
+ else:
|
|
|
157
|
+ raise ImproperlyConfigured("%s contains definitions for both 'model' and 'queryset', but only one or the other is allowed" % self.__class__.__name__)
|
|
|
158
|
+
|
|
|
159
|
+ # If model is None then list_view_title and create_view_title will be
|
|
|
160
|
+ # left with their default values (which are None by default and will
|
|
|
161
|
+ # cause the corresponding getters to raise an error).
|
|
|
162
|
+ if self.model is not None:
|
|
|
163
|
+ if self.list_view_title is None:
|
|
|
164
|
+ self.list_view_title = u"{0}"
|
|
|
165
|
+ self.list_view_title = self.list_view_title.format(self.model._meta.verbose_name_plural.title())
|
|
|
166
|
+
|
|
|
167
|
+ if self.create_view_title is None:
|
|
|
168
|
+ self.create_view_title = u"Create {0}"
|
|
|
169
|
+ self.create_view_title = self.create_view_title.format(self.model._meta.verbose_name.title())
|
|
|
170
|
+
|
|
|
171
|
+ self.generate_list_view()
|
|
|
172
|
+ self.generate_create_view()
|
|
|
173
|
+ self.generate_detail_view()
|
|
|
174
|
+ self.generate_update_view()
|
|
|
175
|
+ self.generate_delete_view()
|
|
|
176
|
+
|
|
|
177
|
+ self.is_view_enabled = {view_type: view is not None for view_type, view in self.views.items()}
|
|
|
178
|
+
|
|
|
179
|
+ # For convenience.
|
|
|
180
|
+ if not self.is_view_enabled[DETAIL_VIEW_TYPE] and (self.instance_breadcrumb_view_type == DETAIL_VIEW_TYPE):
|
|
|
181
|
+ self.instance_breadcrumb_view_type = UPDATE_VIEW_TYPE
|
|
|
182
|
+
|
|
|
183
|
+ @staticmethod
|
|
|
184
|
+ def reverse_with_query_params(viewname, *args, **kwargs):
|
|
|
185
|
+ query_params = kwargs.pop('query_params', None)
|
|
|
186
|
+ url = reverse(viewname, *args, **kwargs)
|
|
|
187
|
+ if query_params:
|
|
|
188
|
+ url += '?' + query_params.urlencode()
|
|
|
189
|
+ return url
|
|
|
190
|
+
|
|
|
191
|
+ @staticmethod
|
|
|
192
|
+ def get_parent_url_name(url_name, remove_count=1):
|
|
|
193
|
+ return ':'.join(url_name.split(':')[:-remove_count])
|
|
|
194
|
+
|
|
|
195
|
+ @staticmethod
|
|
|
196
|
+ def derive_view_url_kwarg_names(master_viewset_class):
|
|
|
197
|
+ return master_viewset_class.view_url_kwarg_names + [master_viewset_class.lookup_url_kwarg]
|
|
|
198
|
+
|
|
|
199
|
+ @classmethod
|
|
|
200
|
+ def depth(cls):
|
|
|
201
|
+ return 0 if cls.master_viewset_class is None else cls.master_viewset_class.depth() + 1
|
|
|
202
|
+
|
|
|
203
|
+ def get_master_object(self, view, instance):
|
|
|
204
|
+ raise ImproperlyConfigured("%s requires an implementation of 'get_master_object'" % self.__class__.__name__)
|
|
|
205
|
+
|
|
|
206
|
+ def get_list_view_query_param_prefix_core(self, relative_depth):
|
|
|
207
|
+ # The prefix must include a trailing '-' to match the way django_filter
|
|
|
208
|
+ # handles prefixes.
|
|
|
209
|
+ prefix = 'd%d-' % (self.depth() + relative_depth)
|
|
|
210
|
+ if self.is_list_view_nested and (relative_depth == 0):
|
|
|
211
|
+ return '%s%d-' % (prefix, self.nested_list_view_index)
|
|
|
212
|
+ else:
|
|
|
213
|
+ return prefix
|
|
|
214
|
+
|
|
|
215
|
+ def get_list_view_query_param_prefix(self):
|
|
|
216
|
+ return self.get_list_view_query_param_prefix_core(0)
|
|
|
217
|
+
|
|
|
218
|
+ def get_nested_list_view_query_param_prefix(self):
|
|
|
219
|
+ return self.get_list_view_query_param_prefix_core(1)
|
|
|
220
|
+
|
|
|
221
|
+ def remove_list_view_query_params_core(self, GET, prefix):
|
|
|
222
|
+ if prefix != '':
|
|
|
223
|
+ filtered = GET.copy()
|
|
|
224
|
+ for key in filtered.keys():
|
|
|
225
|
+ if key.startswith(prefix):
|
|
|
226
|
+ filtered.pop(key, None)
|
|
|
227
|
+ return filtered
|
|
|
228
|
+ return GET
|
|
|
229
|
+
|
|
|
230
|
+ def remove_list_view_query_params(self, GET):
|
|
|
231
|
+ return self.remove_list_view_query_params_core(GET, self.list_view_query_param_prefix)
|
|
|
232
|
+
|
|
|
233
|
+ def remove_nested_list_view_query_params(self, GET):
|
|
|
234
|
+ return self.remove_list_view_query_params_core(GET, self.nested_list_view_query_param_prefix)
|
|
|
235
|
+
|
|
|
236
|
+ def get_view_url_kwargs(self, view_type, view, instance=None):
|
|
|
237
|
+ kwargs = {name: view.kwargs[name] for name in self.view_url_kwarg_names}
|
|
|
238
|
+ if view_type in INSTANCE_VIEW_TYPES:
|
|
|
239
|
+ if isinstance(instance, dict):
|
|
|
240
|
+ kwargs[self.lookup_url_kwarg] = instance.get(self.lookup_field)
|
|
|
241
|
+ else:
|
|
|
242
|
+ kwargs[self.lookup_url_kwarg] = getattr(instance, self.lookup_field)
|
|
|
243
|
+ return kwargs
|
|
|
244
|
+
|
|
|
245
|
+ def get_view_url(self, view_type, view, GET, instance=None):
|
|
|
246
|
+ if self.is_list_view_nested and (view_type == LIST_VIEW_TYPE):
|
|
|
247
|
+ return self.master_viewset.get_view_url(self.master_viewset.instance_breadcrumb_view_type, view, GET, view.cached_objects[self.master_viewset])
|
|
|
248
|
+ else:
|
|
|
249
|
+ return self.reverse_with_query_params(self.url_name_prefix + view_type, kwargs=self.get_view_url_kwargs(view_type, view, instance), query_params=self.remove_nested_list_view_query_params(GET) if view_type == LIST_VIEW_TYPE else GET)
|
|
|
250
|
+
|
|
|
251
|
+ def get_root_breadcrumbs(self, view):
|
|
|
252
|
+ return self.root_breadcrumbs
|
|
|
253
|
+
|
|
|
254
|
+ def get_list_view_breadcrumb(self, view, GET, instance=None):
|
|
|
255
|
+ return {
|
|
|
256
|
+ 'text': self.get_list_view_title(view),
|
|
|
257
|
+ 'url': self.get_view_url(LIST_VIEW_TYPE, view, GET)
|
|
|
258
|
+ }
|
|
|
259
|
+
|
|
|
260
|
+ def get_instance_breadcrumb_text(self, view, instance):
|
|
|
261
|
+ return self.instance_breadcrumb_text.format(instance)
|
|
|
262
|
+
|
|
|
263
|
+ def get_breadcrumbs(self, view_type, view, GET):
|
|
|
264
|
+ breadcrumbs = []
|
|
|
265
|
+
|
|
|
266
|
+ if self.master_viewset is None:
|
|
|
267
|
+ breadcrumbs += self.get_root_breadcrumbs(view)
|
|
|
268
|
+ else:
|
|
|
269
|
+ breadcrumbs += self.master_viewset.get_breadcrumbs(self.master_viewset_breadcrumb_view_type, view, GET if self.is_list_view_nested else self.remove_list_view_query_params(GET))
|
|
|
270
|
+
|
|
|
271
|
+ instance = view.cached_objects[self]
|
|
|
272
|
+
|
|
|
273
|
+ # The list view of nested viewsets is part of the detail view of the
|
|
|
274
|
+ # master viewset, and the breadcrumb will already have been added above.
|
|
|
275
|
+ if not self.is_list_view_nested and self.is_view_enabled[LIST_VIEW_TYPE]:
|
|
|
276
|
+ breadcrumbs.append(self.get_list_view_breadcrumb(view, GET, instance))
|
|
|
277
|
+
|
|
|
278
|
+ if view_type in INSTANCE_VIEW_TYPES:
|
|
|
279
|
+ breadcrumbs += [{
|
|
|
280
|
+ 'text': self.get_instance_breadcrumb_text(view, instance),
|
|
|
281
|
+ 'url': self.get_view_url(self.instance_breadcrumb_view_type, view, GET, instance)
|
|
|
282
|
+ }]
|
|
|
283
|
+
|
|
|
284
|
+ return breadcrumbs
|
|
|
285
|
+
|
|
|
286
|
+ def get_list_view_title(self, view):
|
|
|
287
|
+ if self.list_view_title is None:
|
|
|
288
|
+ raise ImproperlyConfigured("%s requires either a definition of 'list_view_title' or an implementation of 'get_list_view_title'" % self.__class__.__name__)
|
|
|
289
|
+ return self.list_view_title
|
|
|
290
|
+
|
|
|
291
|
+ def get_create_view_title(self, view):
|
|
|
292
|
+ if self.create_view_title is None:
|
|
|
293
|
+ raise ImproperlyConfigured("%s requires either a definition of 'create_view_title' or an implementation of 'get_create_view_title'" % self.__class__.__name__)
|
|
|
294
|
+ return self.create_view_title
|
|
|
295
|
+
|
|
|
296
|
+ def get_detail_view_title(self, view):
|
|
|
297
|
+ return self.detail_view_title.format(view.object)
|
|
|
298
|
+
|
|
|
299
|
+ def get_update_view_title(self, view):
|
|
|
300
|
+ return self.update_view_title.format(view.object)
|
|
|
301
|
+
|
|
|
302
|
+ def get_delete_view_title(self, view):
|
|
|
303
|
+ return self.delete_view_title.format(view.object)
|
|
|
304
|
+
|
|
|
305
|
+ """
|
|
|
306
|
+ If get_queryset is overridden to return an iterable rather than a QuerySet
|
|
|
307
|
+ you must provide an implementation of:
|
|
|
308
|
+
|
|
|
309
|
+ get_object(self, view, queryset=None)
|
|
|
310
|
+
|
|
|
311
|
+ in order for instance views to work correctly. You can also provide an
|
|
|
312
|
+ implementation of:
|
|
|
313
|
+
|
|
|
314
|
+ delete_object(self, view, request, *args, **kwargs)
|
|
|
315
|
+
|
|
|
316
|
+ to implement custom deletion logic.
|
|
|
317
|
+ """
|
|
|
318
|
+ def get_queryset(self, view):
|
|
|
319
|
+ if self.queryset is None:
|
|
|
320
|
+ raise ImproperlyConfigured("%s requires either a definition of 'model' or 'queryset', or an implementation of 'get_queryset'" % self.__class__.__name__)
|
|
|
321
|
+ return self.queryset
|
|
|
322
|
+
|
|
|
323
|
+ def get_object(self, view, queryset=None):
|
|
|
324
|
+ if queryset is None:
|
|
|
325
|
+ queryset = self.get_queryset(view)
|
|
|
326
|
+ queryset = queryset.filter(**{self.lookup_field: view.kwargs[self.lookup_url_kwarg]})
|
|
|
327
|
+ return get_object_or_404(queryset)
|
|
|
328
|
+
|
|
|
329
|
+ def get_create_view_object(self, view):
|
|
|
330
|
+ return None
|
|
|
331
|
+
|
|
|
332
|
+ def add_context_data(self, view, context):
|
|
|
333
|
+ pass
|
|
|
334
|
+
|
|
|
335
|
+ def add_list_view_context_data(self, view, GET, context):
|
|
|
336
|
+ pass
|
|
|
337
|
+
|
|
|
338
|
+ def create_view_form_valid(self, view, form):
|
|
|
339
|
+ pass
|
|
|
340
|
+
|
|
|
341
|
+ def update_view_form_valid(self, view, form):
|
|
|
342
|
+ pass
|
|
|
343
|
+
|
|
|
344
|
+ def get_filter_class(self):
|
|
|
345
|
+ return self.filter_class
|
|
|
346
|
+
|
|
|
347
|
+ def get_form_class(self):
|
|
|
348
|
+ if self.form_class is None:
|
|
|
349
|
+ raise ImproperlyConfigured("%s requires a definition of either 'form_class' or the appropriate combination of 'create_view_form_class' and 'update_view_form_class'" % self.__class__.__name__)
|
|
|
350
|
+ return self.form_class
|
|
|
351
|
+
|
|
|
352
|
+ def get_create_view_form_class(self):
|
|
|
353
|
+ if self.create_view_form_class is None:
|
|
|
354
|
+ return self.get_form_class()
|
|
|
355
|
+ return self.create_view_form_class
|
|
|
356
|
+
|
|
|
357
|
+ def get_update_view_form_class(self):
|
|
|
358
|
+ if self.update_view_form_class is None:
|
|
|
359
|
+ return self.get_form_class()
|
|
|
360
|
+ return self.update_view_form_class
|
|
|
361
|
+
|
|
|
362
|
+ def get_form_exclude(self, view):
|
|
|
363
|
+ return self.form_exclude
|
|
|
364
|
+
|
|
|
365
|
+ def get_create_view_form_exclude(self, view):
|
|
|
366
|
+ if self.create_view_form_exclude is None:
|
|
|
367
|
+ return self.get_form_exclude(view)
|
|
|
368
|
+ return self.create_view_form_exclude
|
|
|
369
|
+
|
|
|
370
|
+ def get_update_view_form_exclude(self, view):
|
|
|
371
|
+ if self.update_view_form_exclude is None:
|
|
|
372
|
+ return self.get_form_exclude(view)
|
|
|
373
|
+ return self.update_view_form_exclude
|
|
|
374
|
+
|
|
|
375
|
+ def get_create_view_form_initial(self, view):
|
|
|
376
|
+ return {}
|
|
|
377
|
+
|
|
|
378
|
+ def get_update_view_form_initial(self, view):
|
|
|
379
|
+ return {}
|
|
|
380
|
+
|
|
|
381
|
+ def get_create_button_text(self):
|
|
|
382
|
+ return self.create_button_text
|
|
|
383
|
+
|
|
|
384
|
+ def get_create_button_class(self):
|
|
|
385
|
+ return self.create_button_class
|
|
|
386
|
+
|
|
|
387
|
+ def get_edit_button_text(self):
|
|
|
388
|
+ return self.edit_button_text
|
|
|
389
|
+
|
|
|
390
|
+ def get_edit_button_class(self):
|
|
|
391
|
+ return self.edit_button_class
|
|
|
392
|
+
|
|
|
393
|
+ def get_delete_button_text(self):
|
|
|
394
|
+ return self.delete_button_text
|
|
|
395
|
+
|
|
|
396
|
+ def get_delete_button_class(self):
|
|
|
397
|
+ return self.delete_button_class
|
|
|
398
|
+
|
|
|
399
|
+ def get_back_button_text(self):
|
|
|
400
|
+ return self.back_button_text
|
|
|
401
|
+
|
|
|
402
|
+ def get_back_button_class(self):
|
|
|
403
|
+ return self.back_button_class
|
|
|
404
|
+
|
|
|
405
|
+ def get_relative_view_url(self, url_name_suffix, remove_url_name_components=0, kwargs=None, query_params=None):
|
|
|
406
|
+ if remove_url_name_components > 0:
|
|
|
407
|
+ # url_name_prefix has a trailing colon so we always need to remove
|
|
|
408
|
+ # an extra component.
|
|
|
409
|
+ url_name_prefix = self.get_parent_url_name(self.url_name_prefix, remove_url_name_components + 1) + ':'
|
|
|
410
|
+ else:
|
|
|
411
|
+ url_name_prefix = self.url_name_prefix
|
|
|
412
|
+
|
|
|
413
|
+ return self.reverse_with_query_params(url_name_prefix + url_name_suffix, kwargs=kwargs, query_params=query_params)
|
|
|
414
|
+
|
|
|
415
|
+ def get_success_url(self, view):
|
|
|
416
|
+ if self.success_url is None:
|
|
|
417
|
+ return self.get_view_url(LIST_VIEW_TYPE, view, view.request.GET)
|
|
|
418
|
+ return self.success_url
|
|
|
419
|
+
|
|
|
420
|
+ def get_create_view_success_url(self, view):
|
|
|
421
|
+ if self.create_view_success_url is None:
|
|
|
422
|
+ return self.get_success_url(view)
|
|
|
423
|
+ return self.create_view_success_url
|
|
|
424
|
+
|
|
|
425
|
+ def get_update_view_success_url(self, view):
|
|
|
426
|
+ if self.update_view_success_url is None:
|
|
|
427
|
+ return self.get_success_url(view)
|
|
|
428
|
+ return self.update_view_success_url
|
|
|
429
|
+
|
|
|
430
|
+ def get_delete_view_success_url(self, view):
|
|
|
431
|
+ if self.delete_view_success_url is None:
|
|
|
432
|
+ return self.get_success_url(view)
|
|
|
433
|
+ return self.delete_view_success_url
|
|
|
434
|
+
|
|
|
435
|
+ def get_base_view_mixin(self):
|
|
|
436
|
+ if self.base_view_mixin is None:
|
|
|
437
|
+ class BaseViewMixin(object):
|
|
|
438
|
+ viewset = self
|
|
|
439
|
+ view_type = None
|
|
|
440
|
+ final_breadcrumb = None
|
|
|
441
|
+ pk_url_kwarg = viewset.lookup_url_kwarg
|
|
|
442
|
+
|
|
|
443
|
+ def get_queryset(self):
|
|
|
444
|
+ return self.viewset.get_queryset(self)
|
|
|
445
|
+
|
|
|
446
|
+ def get_view_title(self):
|
|
|
447
|
+ raise NotImplementedError
|
|
|
448
|
+
|
|
|
449
|
+ def get_cached_object(self, viewset=None):
|
|
|
450
|
+ return self.cached_objects[self.viewset if viewset is None else viewset]
|
|
|
451
|
+
|
|
|
452
|
+ def get_object(self, *args, **kwargs):
|
|
|
453
|
+ return self.cached_objects[self.viewset]
|
|
|
454
|
+
|
|
|
455
|
+ def populate_object_cache(self, instance):
|
|
|
456
|
+ # Populate a cache of objects for all viewsets in the
|
|
|
457
|
+ # master-detail chain so all lookup logic is in one place
|
|
|
458
|
+ # and we don't have to worry about accidentally doing
|
|
|
459
|
+ # the same lookup twice in other functions.
|
|
|
460
|
+ viewset = self.viewset
|
|
|
461
|
+ viewset_object = instance
|
|
|
462
|
+ self.cached_objects = {viewset: viewset_object}
|
|
|
463
|
+ while viewset.master_viewset is not None:
|
|
|
464
|
+ if viewset_object is None:
|
|
|
465
|
+ viewset_object = viewset.master_viewset.get_object(self)
|
|
|
466
|
+ else:
|
|
|
467
|
+ viewset_object = viewset.get_master_object(self, viewset_object)
|
|
|
468
|
+ viewset = viewset.master_viewset
|
|
|
469
|
+ self.cached_objects[viewset] = viewset_object
|
|
|
470
|
+
|
|
|
471
|
+ def get_context_data(self, *args, **kwargs):
|
|
|
472
|
+ context = super(BaseViewMixin, self).get_context_data(*args, **kwargs)
|
|
|
473
|
+ viewset = self.viewset
|
|
|
474
|
+
|
|
|
475
|
+ breadcrumbs = viewset.get_breadcrumbs(self.view_type, self, self.request.GET)
|
|
|
476
|
+ if self.final_breadcrumb is not None:
|
|
|
477
|
+ breadcrumbs.append(
|
|
|
478
|
+ {
|
|
|
479
|
+ 'text': self.final_breadcrumb,
|
|
|
480
|
+ # Includes the query string.
|
|
|
481
|
+ 'url': self.request.get_full_path()
|
|
|
482
|
+ }
|
|
|
483
|
+ )
|
|
|
484
|
+
|
|
|
485
|
+ context['base_template_shim'] = viewset.base_template_shim
|
|
|
486
|
+ context['breadcrumbs'] = breadcrumbs
|
|
|
487
|
+ context['query_string'] = self.request.GET.urlencode()
|
|
|
488
|
+ context['view_title'] = self.get_view_title()
|
|
|
489
|
+ context['is_view_enabled'] = viewset.is_view_enabled
|
|
|
490
|
+ context['actions'] = []
|
|
|
491
|
+
|
|
|
492
|
+ if (self.view_type != LIST_VIEW_TYPE) and (viewset.is_list_view_nested or viewset.is_view_enabled[LIST_VIEW_TYPE]):
|
|
|
493
|
+ context['actions'].append(
|
|
|
494
|
+ [
|
|
|
495
|
+ {
|
|
|
496
|
+ 'type': 'button',
|
|
|
497
|
+ 'text': viewset.get_back_button_text(),
|
|
|
498
|
+ 'url': viewset.get_view_url(LIST_VIEW_TYPE, self, self.request.GET),
|
|
|
499
|
+ 'button_class': viewset.get_back_button_class()
|
|
|
500
|
+ }
|
|
|
501
|
+ ]
|
|
|
502
|
+ )
|
|
|
503
|
+
|
|
|
504
|
+ viewset.add_context_data(self, context)
|
|
|
505
|
+
|
|
|
506
|
+ return context
|
|
|
507
|
+
|
|
|
508
|
+ self.base_view_mixin = BaseViewMixin
|
|
|
509
|
+
|
|
|
510
|
+ return self.base_view_mixin
|
|
|
511
|
+
|
|
|
512
|
+ def get_decorated_view(self, view_class):
|
|
|
513
|
+ view = view_class.as_view()
|
|
|
514
|
+ if self.view_decorator is not None:
|
|
|
515
|
+ view = self.view_decorator(view)
|
|
|
516
|
+ view.viewset = self
|
|
|
517
|
+ return view
|
|
|
518
|
+
|
|
|
519
|
+ def is_view_generated(self, view_type):
|
|
|
520
|
+ if view_type in self.views:
|
|
|
521
|
+ return True
|
|
|
522
|
+ if view_type in self.exclude_views:
|
|
|
523
|
+ self.views[view_type] = None
|
|
|
524
|
+ return True
|
|
|
525
|
+ return False
|
|
|
526
|
+
|
|
|
527
|
+ def generate_list_view(self):
|
|
|
528
|
+ if self.is_view_generated(LIST_VIEW_TYPE):
|
|
|
529
|
+ return
|
|
|
530
|
+
|
|
|
531
|
+ class ListView(self.get_base_view_mixin(), self.list_view_base_class):
|
|
|
532
|
+ viewset = self
|
|
|
533
|
+ view_type = LIST_VIEW_TYPE
|
|
|
534
|
+ template_name = self.list_view_template_name
|
|
|
535
|
+ filter = None
|
|
|
536
|
+
|
|
|
537
|
+ def dispatch(self, request, *args, **kwargs):
|
|
|
538
|
+ self.populate_object_cache(None)
|
|
|
539
|
+ return super(ListView, self).dispatch(request, *args, **kwargs)
|
|
|
540
|
+
|
|
|
541
|
+ def get_view_title(self):
|
|
|
542
|
+ return self.viewset.get_list_view_title(self)
|
|
|
543
|
+
|
|
|
544
|
+ def get_context_data(self, *args, **kwargs):
|
|
|
545
|
+ context = super(ListView, self).get_context_data(*args, **kwargs)
|
|
|
546
|
+ if self.filter is not None:
|
|
|
547
|
+ context['filter'] = self.filter
|
|
|
548
|
+ self.viewset.add_list_view_context_data(self, self.request.GET, context)
|
|
|
549
|
+ return context
|
|
|
550
|
+
|
|
|
551
|
+ if self.filter_class is not None:
|
|
|
552
|
+ filter_class = self.filter_class
|
|
|
553
|
+ prefix = self.filter_query_param_prefix
|
|
|
554
|
+
|
|
|
555
|
+ # NOTE: This will only be called if base_list_view_class is a
|
|
|
556
|
+ # ListView, not a TemplateView.
|
|
|
557
|
+ def get_queryset(self):
|
|
|
558
|
+ # Sanity check: verify that get_queryset() is called only once
|
|
|
559
|
+ # per request.
|
|
|
560
|
+ if self.filter is not None:
|
|
|
561
|
+ raise RuntimeError("ListView.get_queryset() was called more than once")
|
|
|
562
|
+ self.filter = filter_class(self.request.GET, super(ListView, self).get_queryset(), prefix=prefix)
|
|
|
563
|
+ return self.filter.qs
|
|
|
564
|
+
|
|
|
565
|
+ ListView.get_queryset = get_queryset
|
|
|
566
|
+
|
|
|
567
|
+ self.views[LIST_VIEW_TYPE] = self.get_decorated_view(ListView)
|
|
|
568
|
+
|
|
|
569
|
+ def generate_create_view(self):
|
|
|
570
|
+ if self.is_view_generated(CREATE_VIEW_TYPE):
|
|
|
571
|
+ return
|
|
|
572
|
+
|
|
|
573
|
+ class CreateView(SaveErrorHandlerMixin, self.get_base_view_mixin(), self.create_view_base_class):
|
|
|
574
|
+ viewset = self
|
|
|
575
|
+ view_type = CREATE_VIEW_TYPE
|
|
|
576
|
+ form_class = self.get_create_view_form_class()
|
|
|
577
|
+ template_name = self.create_view_template_name
|
|
|
578
|
+ final_breadcrumb = 'Create'
|
|
|
579
|
+
|
|
|
580
|
+ def dispatch(self, request, *args, **kwargs):
|
|
|
581
|
+ self.populate_object_cache(self.viewset.get_create_view_object(self))
|
|
|
582
|
+ return super(CreateView, self).dispatch(request, *args, **kwargs)
|
|
|
583
|
+
|
|
|
584
|
+ def get_view_title(self):
|
|
|
585
|
+ return self.viewset.get_create_view_title(self)
|
|
|
586
|
+
|
|
|
587
|
+ def get_context_data(self, *args, **kwargs):
|
|
|
588
|
+ context = super(CreateView, self).get_context_data(*args, **kwargs)
|
|
|
589
|
+ context['form_exclude'] = self.viewset.get_create_view_form_exclude(self)
|
|
|
590
|
+ return context
|
|
|
591
|
+
|
|
|
592
|
+ def form_valid(self, form):
|
|
|
593
|
+ self.viewset.create_view_form_valid(self, form)
|
|
|
594
|
+ return super(CreateView, self).form_valid(form)
|
|
|
595
|
+
|
|
|
596
|
+ def get_initial(self):
|
|
|
597
|
+ return self.viewset.get_create_view_form_initial(self)
|
|
|
598
|
+
|
|
|
599
|
+ def get_form(self, form_class=None):
|
|
|
600
|
+ form = super(CreateView, self).get_form(form_class)
|
|
|
601
|
+ form.view = self
|
|
|
602
|
+ customise = getattr(form, 'customise_for_view', None)
|
|
|
603
|
+ if customise is not None:
|
|
|
604
|
+ customise(self)
|
|
|
605
|
+ return form
|
|
|
606
|
+
|
|
|
607
|
+ def get_success_url(self):
|
|
|
608
|
+ return self.viewset.get_create_view_success_url(self)
|
|
|
609
|
+
|
|
|
610
|
+ self.views[CREATE_VIEW_TYPE] = self.get_decorated_view(CreateView)
|
|
|
611
|
+
|
|
|
612
|
+ def generate_detail_view(self):
|
|
|
613
|
+ if self.is_view_generated(DETAIL_VIEW_TYPE):
|
|
|
614
|
+ return
|
|
|
615
|
+
|
|
|
616
|
+ active_nested_list_view_query_param = self.nested_list_view_query_param_prefix + self.active_nested_list_view_query_param
|
|
|
617
|
+
|
|
|
618
|
+ class DetailView(self.get_base_view_mixin(), generic.DetailView):
|
|
|
619
|
+ viewset = self
|
|
|
620
|
+ view_type = DETAIL_VIEW_TYPE
|
|
|
621
|
+ template_name = self.detail_view_template_name
|
|
|
622
|
+
|
|
|
623
|
+ def dispatch(self, request, *args, **kwargs):
|
|
|
624
|
+ self.populate_object_cache(self.viewset.get_object(self))
|
|
|
625
|
+ return super(DetailView, self).dispatch(request, *args, **kwargs)
|
|
|
626
|
+
|
|
|
627
|
+ def get_view_title(self):
|
|
|
628
|
+ return self.viewset.get_detail_view_title(self)
|
|
|
629
|
+
|
|
|
630
|
+ def get_context_data(self, *args, **kwargs):
|
|
|
631
|
+ context = super(DetailView, self).get_context_data(*args, **kwargs)
|
|
|
632
|
+
|
|
|
633
|
+ viewset = self.viewset
|
|
|
634
|
+
|
|
|
635
|
+ action_group = []
|
|
|
636
|
+ if viewset.is_view_enabled[UPDATE_VIEW_TYPE]:
|
|
|
637
|
+ edit_button_text = viewset.get_edit_button_text()
|
|
|
638
|
+ if edit_button_text is not None:
|
|
|
639
|
+ action_group.append(
|
|
|
640
|
+ {
|
|
|
641
|
+ 'type': 'button',
|
|
|
642
|
+ 'url': viewset.get_view_url(UPDATE_VIEW_TYPE, self, self.request.GET, self.get_cached_object()),
|
|
|
643
|
+ 'text': edit_button_text,
|
|
|
644
|
+ 'button_class': viewset.get_edit_button_class()
|
|
|
645
|
+ }
|
|
|
646
|
+ )
|
|
|
647
|
+
|
|
|
648
|
+ if viewset.is_view_enabled[DELETE_VIEW_TYPE]:
|
|
|
649
|
+ delete_button_text = viewset.get_delete_button_text()
|
|
|
650
|
+ if delete_button_text is not None:
|
|
|
651
|
+ action_group.append(
|
|
|
652
|
+ {
|
|
|
653
|
+ 'type': 'button',
|
|
|
654
|
+ 'url': viewset.get_view_url(DELETE_VIEW_TYPE, self, self.request.GET, self.get_cached_object()),
|
|
|
655
|
+ 'text': delete_button_text,
|
|
|
656
|
+ 'button_class': viewset.get_delete_button_class()
|
|
|
657
|
+ }
|
|
|
658
|
+ )
|
|
|
659
|
+
|
|
|
660
|
+ if action_group:
|
|
|
661
|
+ context['actions'].append(action_group)
|
|
|
662
|
+
|
|
|
663
|
+ context['nested_list_views'] = []
|
|
|
664
|
+ if self.viewset.nested_list_views:
|
|
|
665
|
+ active_index = self.request.GET.get(active_nested_list_view_query_param, '')
|
|
|
666
|
+ have_active = False
|
|
|
667
|
+ for nested_viewset in self.viewset.nested_list_views:
|
|
|
668
|
+ index = str(nested_viewset.nested_list_view_index)
|
|
|
669
|
+ active = index == active_index
|
|
|
670
|
+ have_active = have_active or active
|
|
|
671
|
+ GET = self.request.GET.copy()
|
|
|
672
|
+ GET[active_nested_list_view_query_param] = index
|
|
|
673
|
+ nested_context = {
|
|
|
674
|
+ 'active': active,
|
|
|
675
|
+ 'id': 't' + index,
|
|
|
676
|
+ 'caption': nested_viewset.get_list_view_title(self),
|
|
|
677
|
+ 'actions': []
|
|
|
678
|
+ }
|
|
|
679
|
+ nested_viewset.add_list_view_context_data(self, GET, nested_context)
|
|
|
680
|
+ context['nested_list_views'].append(nested_context)
|
|
|
681
|
+ if not have_active:
|
|
|
682
|
+ context['nested_list_views'][0]['active'] = True
|
|
|
683
|
+
|
|
|
684
|
+ return context
|
|
|
685
|
+
|
|
|
686
|
+ self.views[DETAIL_VIEW_TYPE] = self.get_decorated_view(DetailView)
|
|
|
687
|
+
|
|
|
688
|
+ def generate_update_view(self):
|
|
|
689
|
+ if self.is_view_generated(UPDATE_VIEW_TYPE):
|
|
|
690
|
+ return
|
|
|
691
|
+
|
|
|
692
|
+ class UpdateView(SaveErrorHandlerMixin, self.get_base_view_mixin(), generic.UpdateView):
|
|
|
693
|
+ viewset = self
|
|
|
694
|
+ view_type = UPDATE_VIEW_TYPE
|
|
|
695
|
+ form_class = self.get_update_view_form_class()
|
|
|
696
|
+ template_name = self.update_view_template_name
|
|
|
697
|
+ final_breadcrumb = None if self.instance_breadcrumb_view_type == UPDATE_VIEW_TYPE else 'Update'
|
|
|
698
|
+
|
|
|
699
|
+ def dispatch(self, request, *args, **kwargs):
|
|
|
700
|
+ self.populate_object_cache(self.viewset.get_object(self))
|
|
|
701
|
+ return super(UpdateView, self).dispatch(request, *args, **kwargs)
|
|
|
702
|
+
|
|
|
703
|
+ def get_view_title(self):
|
|
|
704
|
+ return self.viewset.get_update_view_title(self)
|
|
|
705
|
+
|
|
|
706
|
+ def get_context_data(self, *args, **kwargs):
|
|
|
707
|
+ context = super(UpdateView, self).get_context_data(*args, **kwargs)
|
|
|
708
|
+
|
|
|
709
|
+ viewset = self.viewset
|
|
|
710
|
+
|
|
|
711
|
+ if viewset.is_view_enabled[DELETE_VIEW_TYPE]:
|
|
|
712
|
+ delete_button_text = viewset.get_delete_button_text()
|
|
|
713
|
+ if delete_button_text is not None:
|
|
|
714
|
+ context['actions'].append(
|
|
|
715
|
+ [
|
|
|
716
|
+ {
|
|
|
717
|
+ 'type': 'button',
|
|
|
718
|
+ 'url': viewset.get_view_url(DELETE_VIEW_TYPE, self, self.request.GET, self.get_cached_object()),
|
|
|
719
|
+ 'text': delete_button_text,
|
|
|
720
|
+ 'button_class': viewset.get_delete_button_class()
|
|
|
721
|
+ }
|
|
|
722
|
+ ]
|
|
|
723
|
+ )
|
|
|
724
|
+
|
|
|
725
|
+ context['form_exclude'] = self.viewset.get_update_view_form_exclude(self)
|
|
|
726
|
+ return context
|
|
|
727
|
+
|
|
|
728
|
+ def form_valid(self, form):
|
|
|
729
|
+ self.viewset.update_view_form_valid(self, form)
|
|
|
730
|
+ return super(UpdateView, self).form_valid(form)
|
|
|
731
|
+
|
|
|
732
|
+ def get_initial(self):
|
|
|
733
|
+ return self.viewset.get_update_view_form_initial(self)
|
|
|
734
|
+
|
|
|
735
|
+ def get_form(self, form_class=None):
|
|
|
736
|
+ form = super(UpdateView, self).get_form(form_class)
|
|
|
737
|
+ form.view = self
|
|
|
738
|
+ customise = getattr(form, 'customise_for_view', None)
|
|
|
739
|
+ if customise is not None:
|
|
|
740
|
+ customise(self)
|
|
|
741
|
+ return form
|
|
|
742
|
+
|
|
|
743
|
+ def get_success_url(self):
|
|
|
744
|
+ return self.viewset.get_update_view_success_url(self)
|
|
|
745
|
+
|
|
|
746
|
+ self.views[UPDATE_VIEW_TYPE] = self.get_decorated_view(UpdateView)
|
|
|
747
|
+
|
|
|
748
|
+ def generate_delete_view(self):
|
|
|
749
|
+ if self.is_view_generated(DELETE_VIEW_TYPE):
|
|
|
750
|
+ return
|
|
|
751
|
+
|
|
|
752
|
+ class DeleteView(self.get_base_view_mixin(), generic.DeleteView):
|
|
|
753
|
+ viewset = self
|
|
|
754
|
+ view_type = DELETE_VIEW_TYPE
|
|
|
755
|
+ template_name = self.delete_view_template_name
|
|
|
756
|
+ final_breadcrumb = 'Delete'
|
|
|
757
|
+
|
|
|
758
|
+ def dispatch(self, request, *args, **kwargs):
|
|
|
759
|
+ self.populate_object_cache(self.viewset.get_object(self))
|
|
|
760
|
+ return super(DeleteView, self).dispatch(request, *args, **kwargs)
|
|
|
761
|
+
|
|
|
762
|
+ def get_view_title(self):
|
|
|
763
|
+ return self.viewset.get_delete_view_title(self)
|
|
|
764
|
+
|
|
|
765
|
+ def get_success_url(self):
|
|
|
766
|
+ return self.viewset.get_delete_view_success_url(self)
|
|
|
767
|
+
|
|
|
768
|
+ if getattr(self, 'delete_object', None) is not None:
|
|
|
769
|
+ def delete(self, request, *args, **kwargs):
|
|
|
770
|
+ return self.viewset.delete_object(self, request, *args, **kwargs)
|
|
|
771
|
+
|
|
|
772
|
+ DeleteView.delete = delete
|
|
|
773
|
+
|
|
|
774
|
+ self.views[DELETE_VIEW_TYPE] = self.get_decorated_view(DeleteView)
|
|
|
775
|
+
|
|
|
776
|
+ @classmethod
|
|
|
777
|
+ def urls(cls):
|
|
|
778
|
+ viewset = cls()
|
|
|
779
|
+
|
|
|
780
|
+ lookup_regex = r'(?P<' + viewset.lookup_url_kwarg + '>' + viewset.lookup_url_kwarg_pattern + ')/' if viewset.lookup_regex is None else viewset.lookup_regex
|
|
|
781
|
+
|
|
|
782
|
+ patterns = []
|
|
|
783
|
+
|
|
|
784
|
+ def append_pattern(pattern, view_type):
|
|
|
785
|
+ view = viewset.views[view_type]
|
|
|
786
|
+ if view is not None:
|
|
|
787
|
+ patterns.append(url(pattern, view, name=view_type))
|
|
|
788
|
+
|
|
|
789
|
+ append_pattern(r'^$', LIST_VIEW_TYPE)
|
|
|
790
|
+ append_pattern(r'^create/$', CREATE_VIEW_TYPE)
|
|
|
791
|
+ append_pattern(lookup_regex + '$', DETAIL_VIEW_TYPE)
|
|
|
792
|
+ append_pattern(lookup_regex + 'update/$', UPDATE_VIEW_TYPE)
|
|
|
793
|
+ append_pattern(lookup_regex + 'delete/$', DELETE_VIEW_TYPE)
|
|
|
794
|
+
|
|
|
795
|
+ if not patterns:
|
|
|
796
|
+ # If a viewset functions only as a nested list view then it will
|
|
|
797
|
+ # not define any views of its own. We need at least one view URL
|
|
|
798
|
+ # to be defined in order to discover the viewset via link_viewsets,
|
|
|
799
|
+ # however, so we simply define a dummy one.
|
|
|
800
|
+ def not_found(request, *args, **kwargs):
|
|
|
801
|
+ raise Http404('Not found')
|
|
|
802
|
+ not_found.viewset = viewset
|
|
|
803
|
+ patterns.append(url(r'^$', not_found, name=NOT_FOUND_VIEW_TYPE))
|
|
|
804
|
+
|
|
|
805
|
+ return patterns
|
|
|
806
|
+
|
|
|
807
|
+ @staticmethod
|
|
|
808
|
+ def link_viewsets(views):
|
|
|
809
|
+ viewsets = {}
|
|
|
810
|
+
|
|
|
811
|
+ for view_function, url_pattern, view_name in views:
|
|
|
812
|
+ viewset = getattr(view_function, 'viewset', None)
|
|
|
813
|
+ if viewset is not None:
|
|
|
814
|
+ viewset_class = viewset.__class__
|
|
|
815
|
+ if viewset_class in viewsets:
|
|
|
816
|
+ # TODO: we can remove this restriction by passing a name/ID
|
|
|
817
|
+ # to the CrudViewset.urls() function to use in the viewset
|
|
|
818
|
+ # constructor, and then specifying that name/ID instead of
|
|
|
819
|
+ # the class for master or nested viewsets.
|
|
|
820
|
+ # OR we could just create derived viewset classes for each
|
|
|
821
|
+ # case.
|
|
|
822
|
+ if viewset != viewsets[viewset_class]:
|
|
|
823
|
+ raise ImproperlyConfigured("%s.urls() is called multiple times (see TODO in code)" % viewset_class.__name__)
|
|
|
824
|
+ else:
|
|
|
825
|
+ viewset.url_name_prefix = CrudViewset.get_parent_url_name(view_name) + ':'
|
|
|
826
|
+ viewsets[viewset_class] = viewset
|
|
|
827
|
+
|
|
|
828
|
+ for viewset_class, viewset in viewsets.items():
|
|
|
829
|
+ if viewset.master_viewset_class is not None:
|
|
|
830
|
+ # Sanity check.
|
|
|
831
|
+ if viewset.master_viewset is not None:
|
|
|
832
|
+ raise RuntimeError("%s already has a master viewset" % viewset_class.__name__)
|
|
|
833
|
+
|
|
|
834
|
+ viewset.master_viewset = viewsets.get(viewset.master_viewset_class, None)
|
|
|
835
|
+ if viewset.master_viewset is None:
|
|
|
836
|
+ raise ImproperlyConfigured("%s does not have an associated URL" % viewset.master_viewset_class.__name__)
|
|
|
837
|
+
|
|
|
838
|
+ if viewset.nested_list_view_index is not None:
|
|
|
839
|
+ for i, nested_viewset in enumerate(viewset.master_viewset.nested_list_views):
|
|
|
840
|
+ if viewset.nested_list_view_index < nested_viewset.nested_list_view_index:
|
|
|
841
|
+ viewset.master_viewset.nested_list_views.insert(i, viewset)
|
|
|
842
|
+ break
|
|
|
843
|
+ elif viewset.nested_list_view_index == nested_viewset.nested_list_view_index:
|
|
|
844
|
+ raise ImproperlyConfigured("%s and %s have the same value for nested_list_view_index", viewset.__class__.__name__, nested_viewset.__class__.__name__)
|
|
|
845
|
+ else:
|
|
|
846
|
+ viewset.master_viewset.nested_list_views.append(viewset)
|
|
|
847
|
+
|
|
|
848
|
+ for viewset in viewsets.values():
|
|
|
849
|
+ # Prevents unnecessary processing in
|
|
|
850
|
+ # remove_nested_list_view_query_params() if there are no nested list
|
|
|
851
|
+ # views.
|
|
|
852
|
+ if not viewset.nested_list_views:
|
|
|
853
|
+ viewset.nested_list_view_query_param_prefix = ''
|
|
|
854
|
+
|
|
|
855
|
+
|
|
|
856
|
+class Tables2ListViewMixin(object):
|
|
|
857
|
+ list_view_base_class = generic.TemplateView
|
|
|
858
|
+ list_view_template_name = 'crud/tables2_list_view.html'
|
|
|
859
|
+ detail_view_template_name = 'crud/tables2_detail_view.html'
|
|
|
860
|
+
|
|
|
861
|
+ tables2_class = None
|
|
|
862
|
+ tables2_context_variable_name = 'table'
|
|
|
863
|
+ tables2_paginator_query_string_variable_name = 'paginator_query_string'
|
|
|
864
|
+ tables2_template = 'django_tables2/bootstrap.html'
|
|
|
865
|
+ tables2_attributes = {}
|
|
|
866
|
+ tables2_meta_attributes = {}
|
|
|
867
|
+ tables2_page_field = 'p'
|
|
|
868
|
+ tables2_per_page_field = 'c'
|
|
|
869
|
+ tables2_order_by_field = 's'
|
|
|
870
|
+ tables2_clickable_rows = False
|
|
|
871
|
+ tables2_clickable_row_class = 'clickable-row'
|
|
|
872
|
+ tables2_clickable_row_view_type = DETAIL_VIEW_TYPE
|
|
|
873
|
+
|
|
|
874
|
+ def __init__(self, *args, **kwargs):
|
|
|
875
|
+ super(Tables2ListViewMixin, self).__init__(*args, **kwargs)
|
|
|
876
|
+
|
|
|
877
|
+ # For convenience.
|
|
|
878
|
+ if not self.is_view_enabled[DETAIL_VIEW_TYPE] and (self.tables2_clickable_row_view_type == DETAIL_VIEW_TYPE):
|
|
|
879
|
+ self.tables2_clickable_row_view_type = UPDATE_VIEW_TYPE
|
|
|
880
|
+
|
|
|
881
|
+ if self.tables2_class is None:
|
|
|
882
|
+ meta = type('Meta', (object,), self.tables2_meta_attributes)
|
|
|
883
|
+
|
|
|
884
|
+ attrs = copy.copy(self.tables2_attributes)
|
|
|
885
|
+ attrs['Meta'] = meta
|
|
|
886
|
+
|
|
|
887
|
+ self.tables2_class = type('Table', (django_tables2.Table,), attrs)
|
|
|
888
|
+
|
|
|
889
|
+ try:
|
|
|
890
|
+ my_attrs = copy.copy(self.tables2_class.Meta.attrs)
|
|
|
891
|
+ except AttributeError:
|
|
|
892
|
+ my_attrs = {}
|
|
|
893
|
+
|
|
|
894
|
+ my_attrs['class'] = my_attrs.get('class', 'table table-bordered table-striped table-hover')
|
|
|
895
|
+
|
|
|
896
|
+ class DerivedTable(self.tables2_class):
|
|
|
897
|
+ class Meta(self.tables2_class.Meta):
|
|
|
898
|
+ model = self.model
|
|
|
899
|
+ template = self.tables2_template
|
|
|
900
|
+ page_field = self.list_view_query_param_prefix + self.tables2_page_field
|
|
|
901
|
+ per_page_field = self.list_view_query_param_prefix + self.tables2_per_page_field
|
|
|
902
|
+ order_by_field = self.list_view_query_param_prefix + self.tables2_order_by_field
|
|
|
903
|
+ attrs = my_attrs
|
|
|
904
|
+
|
|
|
905
|
+ # This will create an instance variable containing the class and
|
|
|
906
|
+ # leave the original class variable unchanged.
|
|
|
907
|
+ self.tables2_class = DerivedTable
|
|
|
908
|
+
|
|
|
909
|
+ def add_list_view_context_data(self, view, GET, context):
|
|
|
910
|
+ super(Tables2ListViewMixin, self).add_list_view_context_data(view, GET, context)
|
|
|
911
|
+
|
|
|
912
|
+ # Sanity check: get_queryset() will not have been called yet as we
|
|
|
913
|
+ # are using a TemplateView instead of a ListView.
|
|
|
914
|
+ if 'object_list' in context:
|
|
|
915
|
+ raise RuntimeError("Context contains an 'object_list' key")
|
|
|
916
|
+
|
|
|
917
|
+ if self.filter_class is None:
|
|
|
918
|
+ queryset = self.get_queryset(view)
|
|
|
919
|
+ else:
|
|
|
920
|
+ context['filter'] = self.filter_class(GET, self.get_queryset(view), prefix=self.filter_query_param_prefix)
|
|
|
921
|
+ queryset = context['filter'].qs
|
|
|
922
|
+
|
|
|
923
|
+ table_kwargs = {}
|
|
|
924
|
+ if self.tables2_clickable_rows:
|
|
|
925
|
+ table_kwargs['row_attrs'] = {
|
|
|
926
|
+ 'class': self.tables2_clickable_row_class,
|
|
|
927
|
+ 'data-href': lambda record: self.get_view_url(self.tables2_clickable_row_view_type, view, GET, record)
|
|
|
928
|
+ }
|
|
|
929
|
+
|
|
|
930
|
+ table = self.tables2_class(queryset, **table_kwargs)
|
|
|
931
|
+ django_tables2.RequestConfig(view.request).configure(table)
|
|
|
932
|
+ table.viewset = self
|
|
|
933
|
+ table.view = view
|
|
|
934
|
+ table.GET = GET
|
|
|
935
|
+
|
|
|
936
|
+ paginator_query_params = GET.copy()
|
|
|
937
|
+ paginator_query_params.pop(table.page_field, None)
|
|
|
938
|
+
|
|
|
939
|
+ context[self.tables2_context_variable_name] = table
|
|
|
940
|
+ context[self.tables2_paginator_query_string_variable_name] = paginator_query_params.urlencode()
|
|
|
941
|
+
|
|
|
942
|
+ if self.is_view_enabled[CREATE_VIEW_TYPE]:
|
|
|
943
|
+ create_button_text = self.get_create_button_text()
|
|
|
944
|
+ if create_button_text is not None:
|
|
|
945
|
+ context['actions'].append(
|
|
|
946
|
+ [
|
|
|
947
|
+ {
|
|
|
948
|
+ 'type': 'button',
|
|
|
949
|
+ 'url': self.get_view_url(CREATE_VIEW_TYPE, view, GET),
|
|
|
950
|
+ 'text': create_button_text,
|
|
|
951
|
+ 'button_class': self.get_create_button_class()
|
|
|
952
|
+ }
|
|
|
953
|
+ ]
|
|
|
954
|
+ )
|