-
Notifications
You must be signed in to change notification settings - Fork 21
/
generics.py
executable file
·843 lines (722 loc) · 32 KB
/
generics.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
from __future__ import (division, unicode_literals)
from collections import OrderedDict
import calendar
import json
import extra_views
from django.conf import settings
from django.contrib import messages
from django.contrib.auth import (authenticate, login, logout)
from django.contrib.auth.forms import AuthenticationForm
from django.core.exceptions import (FieldDoesNotExist, ImproperlyConfigured,
ValidationError)
from django.core.paginator import InvalidPage
from django.urls import (NoReverseMatch, reverse)
from django.utils.html import mark_safe
from django.db.models.deletion import (Collector, ProtectedError)
from django.forms.widgets import Media
from django.http import Http404
from django.shortcuts import (redirect, render, resolve_url)
from django.utils.formats import get_format
from django.utils.http import (is_safe_url, quote)
from django.utils.text import capfirst
from django.utils.translation import ugettext as _
from django.utils.translation import get_language
from django.views import generic as base
from .mixins import (FormMediaMixin, FormMixin, ListMixin,
RoleAuthentication, SuccessMessageMixin)
from .paginator import IndefinitePaginator
from .utils import (append_query_parameter, arctic_setting, find_attribute,
get_field_class, find_field_meta, menu, reverse_url,
view_from_url)
def collapsible(fiedset_name, collapsed=False):
""" Utility method for Form layouts """
return '{}{}'.format('-' if collapsed else '+', fiedset_name)
def collapsible_gettext(fiedset_name, collapsed=False):
return collapsible(_(fiedset_name), collapsed)
class View(RoleAuthentication, base.View):
"""
This view needs to be used for all Arctic views, except the LoginView.
It includes integration with the Arctic user interface elements, such as
the menu, site logo, site title, page title and breadcrumbs.
"""
page_title = ''
page_description = ''
breadcrumbs = None
tabs = None
requires_login = True
urls = {}
form_display = None
in_modal = False
def dispatch(self, request, *args, **kwargs):
"""
Most views in a CMS require a login, so this is the default setup.
If a login is not required then the requires_login property
can be set to False to disable this.
"""
if self.requires_login:
if settings.LOGIN_URL is None or settings.LOGOUT_URL is None:
raise ImproperlyConfigured(
'LOGIN_URL and LOGOUT_URL '
'has to be defined if requires_login is True'
)
if not request.user.is_authenticated:
return redirect('%s?next=%s' % (
resolve_url(settings.LOGIN_URL),
quote(request.get_full_path())))
return super(View, self).dispatch(request, *args, **kwargs)
def get_context_data(self, **kwargs):
context = super(View, self).get_context_data(**kwargs)
context['page_title'] = self.get_page_title()
context['page_description'] = self.get_page_description()
context['menu'] = menu(user=self.request.user, request=self.request)
context['breadcrumbs'] = self.get_breadcrumbs()
context['tabs'] = self.get_tabs()
context['index_url'] = self.get_index_url()
context['SITE_NAME'] = self.get_site_name()
context['SITE_TITLE'] = self.get_site_title()
context['SITE_LOGO'] = self.get_site_logo()
context['SIDEBAR_BACKGROUND'] = self.get_sidebar_background()
context['SIDEBAR_COLOR'] = self.get_sidebar_color()
context['SIDEBAR_ALT_COLOR'] = self.get_sidebar_alt_color()
context['HIGHLIGHT_BACKGROUND'] = self.get_highlight_background()
context['HIGHLIGHT_COLOR'] = self.get_highlight_color()
context['DATETIME_FORMATS'] = self.get_datetime_formats()
context['LOGIN_URL'] = self.get_login_url()
context['LOGOUT_URL'] = self.get_logout_url()
context['media'] = self.media
context['form_display'] = self.get_form_display()
context['in_modal'] = self.request.GET.get('inmodal', False)
return context
def get_breadcrumbs(self):
"""
Breadcrumb format: (('name', 'url'), ...) or None if not used.
"""
if not self.breadcrumbs:
return None
else:
allowed_breadcrumbs = []
for breadcrumb in self.breadcrumbs:
# check permission based on named_url
if breadcrumb[1] is not None \
and not view_from_url(
breadcrumb[1]).has_permission(self.request.user):
continue
url = None if not breadcrumb[1] else reverse(breadcrumb[1])
allowed_breadcrumbs.append({'name': breadcrumb[0], 'url': url})
return allowed_breadcrumbs
def get_tabs(self):
"""
Tabs format: (('name', 'url'), ...) or None if tabs are not used.
"""
if not self.tabs:
return None
else:
allowed_tabs = []
for tab in self.tabs:
# check permission based on named_url
if not view_from_url(tab[1]).has_permission(self.request.user):
continue
obj = self if not hasattr(self, 'object') else self.object
url = reverse_url(tab[1], obj)
allowed_tabs.append({'name': tab[0],
'active': self.request.path == url,
'url': self.in_modal(url)})
return allowed_tabs
def get_page_title(self):
return self.page_title
def get_page_description(self):
return self.page_description
def get_site_logo(self):
return arctic_setting('ARCTIC_SITE_LOGO')
def get_site_name(self):
return arctic_setting('ARCTIC_SITE_NAME')
def get_site_title(self):
return getattr(settings, 'ARCTIC_SITE_TITLE',
self.get_site_name())
def get_sidebar_color(self):
return getattr(settings, 'ARCTIC_SIDEBAR_COLOR', None)
def get_sidebar_alt_color(self):
return getattr(settings, 'ARCTIC_SIDEBAR_ALT_COLOR', None)
def get_sidebar_background(self):
return getattr(settings, 'ARCTIC_SIDEBAR_BACKGROUND', None)
def get_highlight_color(self):
return getattr(settings, 'ARCTIC_HIGHLIGHT_COLOR', None)
def get_highlight_background(self):
return getattr(settings, 'ARCTIC_HIGHLIGHT_BACKGROUND', None)
def get_index_url(self):
try:
return reverse(getattr(settings, 'ARCTIC_INDEX_URL', 'index'))
except NoReverseMatch:
return '/'
def get_datetime_formats(self):
dtformats = {}
dtformats['SHORT_DATE'] = get_format('DATE_INPUT_FORMATS',
get_language())[0]
dtformats['TIME'] = get_format('TIME_INPUT_FORMATS',
get_language())[0]
dtformats['SHORT_DATETIME'] = get_format('DATETIME_INPUT_FORMATS',
get_language())[0]
firstweekday = calendar.firstweekday() + 1
if firstweekday == 7:
firstweekday = 0
day_names = calendar.day_name[-1:] + calendar.day_name[:-1]
day_abbr = calendar.day_abbr[-1:] + calendar.day_abbr[:-1]
dtformats['DAYS'] = mark_safe(json.dumps(
[_(day) for day in day_names]))
dtformats['DAYS_SHORT'] = mark_safe(json.dumps(
[_(day) for day in day_abbr]))
dtformats['DAYS_MIN'] = mark_safe(json.dumps(
[_(day)[:2] for day in day_abbr]))
dtformats['MONTHS'] = mark_safe(json.dumps(
[_(day).capitalize() for day in calendar.month_name[1:]]))
dtformats['MONTHS_SHORT'] = mark_safe(json.dumps(
[_(day) for day in calendar.month_abbr[1:]]))
dtformats['TODAY'] = _('Today')
dtformats['CLEAR'] = _('Clear')
dtformats['FIRST_DAY'] = firstweekday
return dtformats
def get_login_url(self):
login_url = getattr(settings, 'LOGIN_URL', 'login')
return reverse(login_url) if login_url else None
def get_logout_url(self):
logout_url = getattr(settings, 'LOGOUT_URL', 'logout')
return reverse(logout_url) if logout_url else None
@property
def media(self):
"""
Return all media required to render this view, including forms.
"""
media = self._get_common_media()
media += self._get_view_media()
media += self.get_media_assets()
return media
def _get_common_media(self):
config = getattr(settings, 'ARCTIC_COMMON_MEDIA_ASSETS', {})
css = config['css'] if 'css' in config else {}
js = config['js'] if 'js' in config else []
media = Media(css=css, js=js)
return media
def get_media_assets(self):
"""
Allows to define additional media for view
"""
return Media()
def _get_view_media(self):
"""
Gather view-level media assets
"""
try:
css = self.Media.css
except AttributeError:
css = {}
try:
js = self.Media.js
except AttributeError:
js = []
return Media(css=css, js=js)
def get_form_display(self):
valid_options = ['stacked', 'tabular', 'float-label']
if self.form_display:
if self.form_display in valid_options:
return self.form_display
raise ImproperlyConfigured(
'form_display property needs to be one of {}'.format(
valid_options))
return arctic_setting('ARCTIC_FORM_DISPLAY', valid_options)
def in_modal(self, url):
if self.request.GET.get('inmodal'):
return append_query_parameter(url, {'inmodal': 'True'})
return url
class TemplateView(View, base.TemplateView):
pass
class DetailView(View, base.DetailView):
"""
Custom detail view.
"""
fields = None # Which fields should be shown in the details
links = None # Optional links such as list of linked items
def get_fields(self, obj):
result = OrderedDict()
if self.fields:
for field_name in self.fields:
if isinstance(field_name, tuple):
# custom property that is not a field of the model
result[field_name[1]] = getattr(obj, field_name[0])
else:
field = self.model._meta.get_field(field_name)
result[field.verbose_name.title()] = getattr(obj,
field_name)
return result
def get_context_data(self, **kwargs):
context = super(DetailView, self).get_context_data(**kwargs)
context['fields'] = self.get_fields(context['object'])
context['links'] = self.get_links()
return context
class ListView(View, ListMixin, base.ListView):
"""
Custom listview. Adding filter, sorting and display logic.
"""
prefix = '' # Prefix for embedding multiple list views in detail view
def __init__(self, **kwargs):
super(ListView, self).__init__(**kwargs)
if self.sorting_field:
resource = '{0}.{1}'.format(self.__class__.__module__,
self.__class__.__name__)
try:
self.sorting_url = reverse('arctic:order', args=(resource,))
except NoReverseMatch:
raise ImproperlyConfigured(
'This project needs to include Arctic URLs in order to use'
' sorting.')
sorting_field_excludes = (
self.ordering_fields, self.search_fields,
self.default_ordering, self.advanced_search_form,
self.paginate_by,
)
if any(sorting_field_excludes):
raise ImproperlyConfigured(
'sorting_field cannot be used in combination with any of '
'the following properties: ordering_fields, search_fields,'
' default_ordering, advanced_search_form, paginate_by')
def get(self, request, *args, **kwargs):
objects = self.get_object_list()
context = self.get_context_data(object_list=objects)
return self.render_to_response(context)
def get_object_list(self):
qs = self.get_queryset()
if self.advanced_search_form_class:
form = self.get_advanced_search_form(data=self.request.GET)
if form.is_valid():
if not hasattr(form, 'get_search_filter'):
raise AttributeError(
'advanced_search_form '
'must implement get_search_filter()')
qs = qs.filter(form.get_search_filter())
if self.get_simple_search_form_class():
form = self.get_simple_search_form(self.request.GET)
if form.is_valid():
if not hasattr(form, 'get_search_filter'):
raise AttributeError(
'simple_search_form '
'must implement get_search_filter()')
qs = qs.filter(form.get_search_filter())
self.object_list = qs
return self.object_list
def get_list_header(self):
"""
Creates a list of dictionaries with the field names, labels,
field links, field css classes, order_url and order_direction,
this simplifies the creation of a table in a template.
"""
model = self.object_list.model
result = []
if not self.get_fields():
result.append({
'name': '',
'verbose': str(model._meta.verbose_name),
})
else:
prefix = self.get_prefix()
ordering_fields = self.get_ordering_fields()
for field_name in self.get_fields():
item = {}
if isinstance(field_name, tuple):
# custom property that is not a field of the model
name = field_name[0]
item['label'] = field_name[1]
else:
name = field_name
try:
field_meta = find_field_meta(
model,
field_name
)
if field_meta._verbose_name: # noqa
# explicitly set on the model, so don't change
item['label'] = field_meta._verbose_name # noqa
else:
# title-case the field name (issue #80)
item['label'] = field_meta.verbose_name.title()
except FieldDoesNotExist:
item['label'] = field_name
except AttributeError:
item['label'] = field_name
item['name'] = prefix + name
if name in ordering_fields:
item['order_url'], item['order_direction'] = \
self.ordering_url(name)
result.append(item)
return result
def get_list_items(self, objects): # noqa: C901
items = []
if not self.get_fields():
for obj in objects:
items.append([obj.pk, str(obj)])
return items
# remove all tuples in the field list, no need for the verbose
# field name here
fields = self.get_fields(strip_labels=True)
field_links = self.get_field_links()
for obj in objects:
field_classes = self.get_field_classes(obj)
row = {
'id': self.get_primary_value(obj), # for row data id attr
'fields': [],
'actions': [],
'sorting_field': None
}
for field_name in fields:
field = {'type': 'field', 'field': field_name}
base_field_name = field_name.split('__')[0]
field_class = get_field_class(objects, base_field_name)
field['value'] = self.get_field_value(field_name, obj)
if field_class == 'ManyToManyField':
# ManyToManyField will be display as an embedded list
# capped to max_embeded_list_items, an ellipsis is
# added if there are more items than the max.
m2mfield = getattr(obj, base_field_name)
embeded_list = list(str(l) for l in
m2mfield.all()
[:self.max_embeded_list_items + 1])
if len(embeded_list) > self.max_embeded_list_items:
embeded_list = embeded_list[:-1] + ['...']
field['value'] = embeded_list
# don't try to find url for value that
# is None for related objects.
if (field_name in field_links.keys() and
field['value'] is not None):
field['url'] = self.in_modal(reverse_url(
field_links[field_name], obj, self.primary_key))
field['modal'] = self.get_modal_link(
field_links[field_name], obj)
if field_name in field_classes:
field['class'] = field_classes[field_name]
row['fields'].append(field)
actions = self._get_field_actions(obj)
if actions:
row['actions'].extend(actions)
if self.sorting_field:
row['sorting_field'] = {
'type': 'sorting',
'id': self.get_primary_value(obj),
'value': getattr(obj, self.sorting_field)
}
items.append(row)
return items
def get_field_value(self, field_name, obj):
# first try to find a virtual field
virtual_field_name = "get_{}_field".format(field_name)
if hasattr(self, virtual_field_name):
return getattr(self, virtual_field_name)(obj)
try:
# Get the choice display value
parent_objs = '__'.join(
field_name.split('__')[:-1])
method_name = '{}__get_{}_display'.format(
parent_objs,
field_name.split('__')[-1]).strip('__')
return find_attribute(obj, method_name)()
except (AttributeError, TypeError):
# finally get field's value
return find_attribute(obj, field_name)
def get_primary_value(self, obj):
# while using annotate (group by) the object is a dict
if type(obj) == dict:
return obj.get(self.primary_key)
return getattr(obj, self.primary_key)
def get_prefix(self):
return self.prefix + '-' if self.prefix else ''
def get_default_ordering(self):
prefix = self.get_prefix()
return [prefix + f for f in self.default_ordering]
def get_ordering_with_prefix(self):
return self.request.GET.getlist('order', self.get_default_ordering())
def get_ordering(self):
"""Ordering used for queryset filtering (should not contain prefix)."""
if self.sorting_field:
return [self.sorting_field]
prefix = self.get_prefix()
fields = self.get_ordering_with_prefix()
if self.prefix:
fields = [f.replace(prefix, '', 1) for f in fields]
return [f for f in fields if f.lstrip('-')
in self.get_ordering_fields_lookups()]
def get_page_title(self):
if not self.page_title:
return capfirst(self.object_list.model._meta.verbose_name_plural)
return self.page_title
def get_context_data(self, **kwargs):
context = super(ListView, self).get_context_data(**kwargs)
context['prefix'] = self.prefix
context['list_header'] = self.get_list_header()
context['list_items'] = self.get_list_items(context['object_list'])
context['tool_links'] = self.get_tool_links()
context['sorting_url'] = self.sorting_url
context['tool_links_icon'] = self.get_tool_links_icon()
context['tool_links_collapse'] = self.tool_links_collapse - \
int(len(context['tool_links']) == self.tool_links_collapse + 1)
context['simple_search_form'] = self.simple_search_form
context['advanced_search_form'] = self.advanced_search_form
return context
@classmethod
def reorder(cls, rows):
for key, value in rows.items():
kv = {cls.primary_key: key,
cls.sorting_field: value}
cls.model(**kv).save(update_fields=[cls.sorting_field])
class DataListView(TemplateView, ListMixin):
dataset = None
template_name = 'arctic/base_list.html'
page_kwarg = 'page'
def get_ordering(self):
return self.request.GET.get('order', '').split(',')
def get_context_data(self, **kwargs):
context = super(DataListView, self).get_context_data(**kwargs)
page_size = self.get_paginate_by()
self.dataset.page_size = page_size
object_list = self.get_objects()
page_context = {
'paginator': None,
'page_obj': None,
'is_paginated': False,
'object_list': object_list
}
if page_size:
paginator, page, object_list, is_paginated = self.paginate_dataset(
object_list, page_size)
page_context = {
'paginator': paginator,
'page_obj': page,
'is_paginated': is_paginated,
'object_list': object_list
}
context.update(page_context)
context['list_header'] = self.get_list_header()
context['list_items'] = self.get_list_items(object_list)
context['tool_links'] = self.get_tool_links()
context['tool_links_icon'] = self.get_tool_links_icon()
context['tool_links_collapse'] = self.tool_links_collapse - \
int(len(context['tool_links']) == self.tool_links_collapse + 1)
context['simple_search_form'] = self.simple_search_form
context['advanced_search_form'] = self.advanced_search_form
return context
def get_paginate_by(self):
return self.paginate_by
def get_list_header(self):
"""
Creates a list of dictionaries with the field names, labels,
field links, field css classes, order_url and order_direction,
this simplifies the creation of a table in a template.
"""
result = []
for field_name in self.get_fields():
item = {}
if isinstance(field_name, tuple):
# custom property that is not a field of the model
item['name'] = field_name[0]
item['label'] = field_name[1]
else:
item['name'] = field_name
item['label'] = field_name.title()
if item['name'] in self.get_ordering_fields():
item['order_url'], item['order_direction'] = \
self.ordering_url(item['name'])
result.append(item)
return result
def get_objects(self):
objects = (self.dataset
.fields(self.get_fields(strip_labels=False))
.order_by(self.get_ordering()))
search_fields = self.get_search_fields()
if search_fields:
if len(search_fields) > 1:
raise ValidationError('search_fields in DataListView currently'
' only accepts one field')
search = {}
for search_field in search_fields:
value = self.request.GET.get('search', '')
search[search_field] = value
if search:
objects = objects.filter(**search)
return objects
def get_list_items(self, objects):
items = []
fields = []
field_links = self.get_field_links()
for field in self.get_fields():
fields.append(field[0] if type(field) in (list, tuple)
else field)
for obj in objects:
field_classes = self.get_field_classes(obj)
row = {
'id': getattr(obj, 'id', ''),
'fields': [],
'actions': []
}
for field_name in fields:
field = {'field': field_name, 'type': 'field'}
field['value'] = self.get_field_value(field_name, obj)
if field_name in field_links.keys():
field['url'] = reverse_url(field_links[field_name], obj,
self.primary_key)
if field_name in field_classes:
field['class'] = field_classes[field_name]
row['fields'].append(field)
items.append(row)
actions = self._get_field_actions(obj)
if actions:
row['actions'].append(actions)
return items
def get_field_value(self, field_name, obj):
try: # first try to find a virtual field
virtual_field_name = "get_{}_field".format(field_name)
return getattr(self, virtual_field_name)(obj)
except AttributeError:
try:
return obj[field_name]
except KeyError:
raise FieldDoesNotExist(
'Field "{}" is not available'.format(field_name))
def get_paginator(self, dataset, per_page, orphans=0,
allow_empty_first_page=True, **kwargs):
"""Return an instance of the paginator for this view."""
return IndefinitePaginator(
dataset, per_page, orphans=orphans,
allow_empty_first_page=allow_empty_first_page, **kwargs)
def paginate_dataset(self, dataset, page_size):
paginator = self.get_paginator(
dataset, page_size, orphans=0,
allow_empty_first_page=True)
page_kwarg = self.page_kwarg
page = self.kwargs.get(page_kwarg) or self.request.GET.get(page_kwarg)\
or 1
try:
page_number = int(page)
except ValueError:
raise Http404(_('Page cannot be converted to an int.'))
try:
page = paginator.page(page_number)
return (paginator, page, page.object_list, page.has_other_pages())
except InvalidPage as e:
raise Http404(_('Invalid page (%(page_number)s): %(message)s') % {
'page_number': page_number,
'message': str(e)
})
class CreateView(FormMediaMixin, View, SuccessMessageMixin,
FormMixin, extra_views.CreateWithInlinesView):
template_name = 'arctic/base_create_update.html'
success_message = _('"%(object)s" was successfully created')
def get_page_title(self):
if not self.page_title:
return _("Create %s") % self.model._meta.verbose_name
return self.page_title
def get_context_data(self, **kwargs):
context = super(CreateView, self).get_context_data(**kwargs)
context['actions'] = self.get_actions()
context['layout'] = self.get_layout()
context['cancel_url'] = self.get_cancel_url()
return context
class UpdateView(FormMediaMixin, SuccessMessageMixin, FormMixin, View,
extra_views.UpdateWithInlinesView):
template_name = 'arctic/base_create_update.html'
success_message = _('"%(object)s" was successfully updated')
links = None # Optional links such as list of linked items
readonly_fields = None # Optional list of readonly fields
def get_page_title(self):
if not self.page_title:
return _("Edit %s") % self.model._meta.verbose_name
return self.page_title
def get_context_data(self, **kwargs):
context = super(UpdateView, self).get_context_data(**kwargs)
context['actions'] = self.get_actions()
context['layout'] = self.get_layout()
context['cancel_url'] = self.get_cancel_url()
return context
class FormView(FormMediaMixin, View, SuccessMessageMixin, FormMixin,
base.FormView):
template_name = 'arctic/base_create_update.html'
def get_context_data(self, **kwargs):
context = super(FormView, self).get_context_data(**kwargs)
context['actions'] = self.get_actions()
context['layout'] = self.get_layout()
context['cancel_url'] = self.get_cancel_url()
return context
class DeleteView(View, base.DeleteView):
template_name = 'arctic/base_confirm_delete.html'
redirect = True
@staticmethod
def confirm_dialog():
return {
'title': _('Delete "{obj}"'),
'message': _('Are you sure you want to delete this?'),
'ok': _('Delete'),
'cancel': _('Cancel'),
}
def get_success_url(self):
if self.success_url:
return self.success_url
if self.request.GET.get('inmodal'):
return reverse('arctic:redirect_to_parent')
return self.request.META.get('HTTP_REFERER')
def get_success_message(self, obj):
return _('"{}" was successfully deleted.').format(str(obj))
def get(self, request, *args, **kwargs):
"""
Catch protected relations and show to user.
"""
self.object = self.get_object()
can_delete = True
protected_objects = []
collector_message = None
collector = Collector(using='default')
try:
collector.collect([self.object])
except ProtectedError as e:
collector_message = "Cannot delete %s because it has relations " \
"that depends on it." % self.object
protected_objects = e.protected_objects
can_delete = False
if can_delete and self.redirect:
messages.success(request, self.get_success_message(self.object))
self.delete(request, *args, **kwargs)
return redirect(self.get_success_url())
context = self.get_context_data(object=self.object,
can_delete=can_delete,
collector_message=collector_message,
protected_objects=protected_objects)
return self.render_to_response(context)
def post(self, request, *args, **kwargs):
response = super(DeleteView, self).post(request, *args, **kwargs)
messages.success(request, self.get_success_message(self.object))
return response
class LoginView(FormView):
template_name = 'arctic/login.html'
page_title = _('Login')
requires_login = False
form_class = AuthenticationForm
def __init__(self, *args, **kwargs):
super(LoginView, self).__init__(*args, **kwargs)
# thread-safe definition of messages.
self.messages = []
def get_context_data(self, **kwargs):
# Call the base implementation first to get a context
context = super(LoginView, self).get_context_data(**kwargs)
context['next'] = self.request.GET.get('next', '/')
context['username'] = self.request.POST.get('username', '')
context['messages'] = set(self.messages)
return context
def get(self, request, *args, **kwargs):
logout(request)
return super(LoginView, self).get(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
user = authenticate(username=request.POST['username'],
password=request.POST['password'])
if user and user.is_active:
login(request, user)
next_url = request.GET.get('next')
if is_safe_url(next_url, request.get_host()):
return redirect(next_url)
return redirect('/')
self.messages.append(_('Invalid username/password combination'))
return render(request, self.template_name,
self.get_context_data(**kwargs))