forked from KristianOellegaard/django-hvad
-
Notifications
You must be signed in to change notification settings - Fork 2
/
admin.py
562 lines (475 loc) · 22.3 KB
/
admin.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
from distutils.version import LooseVersion
from django.conf import settings
from django.contrib.admin.options import ModelAdmin, csrf_protect_m, InlineModelAdmin
from django.contrib.admin.util import (flatten_fieldsets, unquote,
get_deleted_objects)
from django.core.exceptions import ValidationError, PermissionDenied
from django.core.urlresolvers import reverse
from django.db import router, transaction
from django.forms.formsets import formset_factory
from django.forms.models import ModelForm, BaseModelFormSet, BaseInlineFormSet, model_to_dict
from django.forms.util import ErrorList
from django.http import Http404, HttpResponseRedirect
from django.shortcuts import render_to_response
from django.template import TemplateDoesNotExist
from django.template.context import RequestContext
from django.template.loader import find_template
from django.utils.encoding import iri_to_uri, force_unicode
from django.utils.functional import curry
from django.utils.translation import ugettext_lazy as _, get_language
from functools import update_wrapper
from nani.forms import TranslatableModelForm, translatable_inlineformset_factory, translatable_modelform_factory
import django
import urllib
from nani.utils import get_cached_translation, get_translation
from nani.manager import FALLBACK_LANGUAGES
NEW_GET_DELETE_OBJECTS = LooseVersion(django.get_version()) >= LooseVersion('1.3')
def get_language_name(language_code):
return dict(settings.LANGUAGES).get(language_code, language_code)
class InlineModelForm(TranslatableModelForm):
def __init__(self, data=None, files=None, auto_id='id_%s', prefix=None,
initial=None, error_class=ErrorList, label_suffix=':',
empty_permitted=False, instance=None):
"""
"""
opts = self._meta
model_opts = opts.model._meta
object_data = {}
language = getattr(self, 'language', get_language())
if instance is not None:
trans = get_cached_translation(instance)
if not trans or trans.language_code != language:
try:
trans = get_translation(instance, language)
except model_opts.translations_model.DoesNotExist:
trans = None
if trans:
object_data = model_to_dict(trans, opts.fields, opts.exclude)
# Dirty hack that swaps the id from the translation id, to the master id
# This is necessary, because we in this case get the untranslated instance,
# and thereafter get the correct translation on save.
if object_data.has_key("id"):
object_data["id"] = trans.master.id
if initial is not None:
object_data.update(initial)
initial = object_data
super(TranslatableModelForm, self).__init__(data, files, auto_id,
prefix, initial,
error_class, label_suffix,
empty_permitted, instance)
class TranslatableModelAdminMixin(object):
query_language_key = 'language'
def all_translations(self, obj):
"""
use this to display all languages the object has been translated to
in the changelist view:
class MyAdmin(admin.ModelAdmin):
list_display = ('__str__', 'all_translations',)
"""
if obj and obj.pk:
languages = []
current_language = get_language()
for language in obj.get_available_languages():
if language == current_language:
languages.append(u'<strong>%s</strong>' % language)
else:
languages.append(language)
return u' '.join(languages)
else:
return ''
all_translations.allow_tags = True
all_translations.short_description = _('all translations')
def get_available_languages(self, obj):
if obj:
return obj.get_available_languages()
else:
return []
def get_language_tabs(self, request, available_languages):
tabs = []
get = dict(request.GET)
language = self._language(request)
for key, name in settings.LANGUAGES:
get.update({'language': key})
url = '%s://%s%s?%s' % (request.is_secure() and 'https' or 'http',
request.get_host(), request.path,
urllib.urlencode(get))
if language == key:
status = 'current'
elif key in available_languages:
status = 'available'
else:
status = 'empty'
tabs.append((url, name, key, status))
return tabs
def _language(self, request):
return request.GET.get(self.query_language_key, get_language())
class TranslatableAdmin(ModelAdmin, TranslatableModelAdminMixin):
form = TranslatableModelForm
change_form_template = 'admin/nani/change_form.html'
deletion_not_allowed_template = 'admin/nani/deletion_not_allowed.html'
def get_urls(self):
from django.conf.urls.defaults import patterns, url
urlpatterns = super(TranslatableAdmin, self).get_urls()
def wrap(view):
def wrapper(*args, **kwargs):
return self.admin_site.admin_view(view)(*args, **kwargs)
return update_wrapper(wrapper, view)
info = self.model._meta.app_label, self.model._meta.module_name
urlpatterns = patterns('',
url(r'^(.+)/delete-translation/(.+)/$',
wrap(self.delete_translation),
name='%s_%s_delete_translation' % info),
) + urlpatterns
return urlpatterns
def get_form(self, request, obj=None, **kwargs):
"""
Returns a Form class for use in the admin add view. This is used by
add_view and change_view.
"""
if self.declared_fieldsets:
fields = flatten_fieldsets(self.declared_fieldsets)
else:
fields = None
if self.exclude is None:
exclude = []
else:
exclude = list(self.exclude)
exclude.extend(kwargs.get("exclude", []))
exclude.extend(self.get_readonly_fields(request, obj))
# Exclude language_code, adding it again to the instance is done by
# the LanguageAwareCleanMixin (see translatable_modelform_factory)
exclude.append('language_code')
old_formfield_callback = curry(self.formfield_for_dbfield,
request=request)
defaults = {
"form": self.form,
"fields": fields,
"exclude": exclude,
"formfield_callback": old_formfield_callback,
}
defaults.update(kwargs)
language = self._language(request)
return translatable_modelform_factory(language, self.model, **defaults)
def render_change_form(self, request, context, add=False, change=False,
form_url='', obj=None):
lang_code = self._language(request)
lang = get_language_name(lang_code)
available_languages = self.get_available_languages(obj)
context['title'] = '%s (%s)' % (context['title'], lang)
context['current_is_translated'] = lang_code in available_languages
context['allow_deletion'] = len(available_languages) > 1
context['language_tabs'] = self.get_language_tabs(request, available_languages)
context['base_template'] = self.get_change_form_base_template()
return super(TranslatableAdmin, self).render_change_form(request,
context,
add, change,
form_url, obj)
def response_change(self, request, obj):
redirect = super(TranslatableAdmin, self).response_change(request, obj)
uri = iri_to_uri(request.path)
if redirect['Location'] in (uri, "../add/"):
if self.query_language_key in request.GET:
redirect['Location'] = '%s?%s=%s' % (redirect['Location'],
self.query_language_key, request.GET[self.query_language_key])
return redirect
@csrf_protect_m
@transaction.commit_on_success
def delete_translation(self, request, object_id, language_code):
"The 'delete translation' admin view for this model."
opts = self.model._meta
app_label = opts.app_label
translations_model = opts.translations_model
try:
obj = translations_model.objects.select_related('maser').get(
master__pk=unquote(object_id),
language_code=language_code)
except translations_model.DoesNotExist:
raise Http404
if not self.has_delete_permission(request, obj):
raise PermissionDenied
if len(self.get_available_languages(obj.master)) <= 1:
return self.deletion_not_allowed(request, obj, language_code)
using = router.db_for_write(translations_model)
# Populate deleted_objects, a data structure of all related objects that
# will also be deleted.
protected = False
if NEW_GET_DELETE_OBJECTS:
(deleted_objects, perms_needed, protected) = get_deleted_objects(
[obj], translations_model._meta, request.user, self.admin_site, using)
else: # pragma: no cover
(deleted_objects, perms_needed) = get_deleted_objects(
[obj], translations_model._meta, request.user, self.admin_site)
lang = get_language_name(language_code)
if request.POST: # The user has already confirmed the deletion.
if perms_needed:
raise PermissionDenied
obj_display = '%s translation of %s' % (lang, force_unicode(obj.master))
self.log_deletion(request, obj, obj_display)
self.delete_model_translation(request, obj)
self.message_user(request,
_('The %(name)s "%(obj)s" was deleted successfully.') % {
'name': force_unicode(opts.verbose_name),
'obj': force_unicode(obj_display)
}
)
if not self.has_change_permission(request, None):
return HttpResponseRedirect(reverse('admin:index'))
return HttpResponseRedirect(reverse('admin:%s_%s_changelist' % (opts.app_label, opts.module_name)))
object_name = '%s Translation' % force_unicode(opts.verbose_name)
if perms_needed or protected:
title = _("Cannot delete %(name)s") % {"name": object_name}
else:
title = _("Are you sure?")
context = {
"title": title,
"object_name": object_name,
"object": obj,
"deleted_objects": deleted_objects,
"perms_lacking": perms_needed,
"protected": protected,
"opts": opts,
"app_label": app_label,
}
# in django > 1.4 root_path is removed
if hasattr(self.admin_site, 'root_path'):
context.update({"root_path": self.admin_site.root_path})
return render_to_response(self.delete_confirmation_template or [
"admin/%s/%s/delete_confirmation.html" % (app_label, opts.object_name.lower()),
"admin/%s/delete_confirmation.html" % app_label,
"admin/delete_confirmation.html"
], context, RequestContext(request))
def deletion_not_allowed(self, request, obj, language_code):
opts = self.model._meta
app_label = opts.app_label
object_name = force_unicode(opts.verbose_name)
context = RequestContext(request)
context['object'] = obj.master
context['language_code'] = language_code
context['opts'] = opts
context['app_label'] = app_label
context['language_name'] = get_language_name(language_code)
context['object_name'] = object_name
return render_to_response(self.deletion_not_allowed_template, context)
def delete_model_translation(self, request, obj):
obj.delete()
def get_object(self, request, object_id):
obj = super(TranslatableAdmin, self).get_object(request, object_id)
if obj:
return obj
queryset = self.model.objects.untranslated()
model = self.model
try:
object_id = model._meta.pk.to_python(object_id)
obj = queryset.get(pk=object_id)
except (model.DoesNotExist, ValidationError):
return None
new_translation = model._meta.translations_model()
new_translation.language_code = self._language(request)
new_translation.master = obj
setattr(obj, model._meta.translations_cache, new_translation)
return obj
def queryset(self, request):
language = self._language(request)
languages = [language,]
for lang in FALLBACK_LANGUAGES:
if not lang in languages:
languages.append(lang)
qs = self.model._default_manager.untranslated().use_fallbacks(*languages)
# TODO: this should be handled by some parameter to the ChangeList.
ordering = self.ordering or () # otherwise we might try to *None, which is bad ;)
if ordering:
qs = qs.order_by(*ordering)
return qs
def get_change_form_base_template(self):
opts = self.model._meta
app_label = opts.app_label
search_templates = [
"admin/%s/%s/change_form.html" % (app_label, opts.object_name.lower()),
"admin/%s/change_form.html" % app_label,
"admin/change_form.html"
]
for template in search_templates:
try:
find_template(template)
return template
except TemplateDoesNotExist:
pass
else: # pragma: no cover
pass
class TranslatableInlineModelAdmin(InlineModelAdmin, TranslatableModelAdminMixin):
form = InlineModelForm
change_form_template = 'admin/nani/change_form.html'
deletion_not_allowed_template = 'admin/nani/deletion_not_allowed.html'
def get_formset(self, request, obj=None, **kwargs):
"""Returns a BaseInlineFormSet class for use in admin add/change views."""
if self.declared_fieldsets:
fields = flatten_fieldsets(self.declared_fieldsets)
else:
fields = None
if self.exclude is None:
exclude = []
else:
exclude = list(self.exclude)
exclude.extend(kwargs.get("exclude", []))
exclude.extend(self.get_readonly_fields(request, obj))
# if exclude is an empty list we use None, since that's the actual
# default
exclude = exclude or None
defaults = {
"form": self.get_form(request, obj),
#"formset": self.formset,
"fk_name": self.fk_name,
"fields": fields,
"exclude": exclude,
"formfield_callback": curry(self.formfield_for_dbfield, request=request),
"extra": self.extra,
"max_num": self.max_num,
"can_delete": self.can_delete,
}
defaults.update(kwargs)
language = self._language(request)
return translatable_inlineformset_factory(language, self.parent_model, self.model, **defaults)
def get_urls(self):
from django.conf.urls.defaults import patterns, url
urlpatterns = super(InlineModelAdmin, self).get_urls()
def wrap(view):
def wrapper(*args, **kwargs):
return self.admin_site.admin_view(view)(*args, **kwargs)
return update_wrapper(wrapper, view)
info = self.model._meta.app_label, self.model._meta.module_name
urlpatterns = patterns('',
url(r'^(.+)/delete-translation/(.+)/$',
wrap(self.delete_translation),
name='%s_%s_delete_translation' % info),
) + urlpatterns
return urlpatterns
def get_form(self, request, obj=None, **kwargs):
"""
Returns a Form class for use in the admin add view. This is used by
add_view and change_view.
"""
if self.declared_fieldsets:
fields = flatten_fieldsets(self.declared_fieldsets)
else:
fields = None
if self.exclude is None:
exclude = []
else:
exclude = list(self.exclude)
exclude.extend(kwargs.get("exclude", []))
exclude.extend(self.get_readonly_fields(request, obj))
# Exclude language_code, adding it again to the instance is done by
# the LanguageAwareCleanMixin (see translatable_modelform_factory)
exclude.append('language_code')
old_formfield_callback = curry(self.formfield_for_dbfield,
request=request)
defaults = {
"form": self.form,
"fields": fields,
"exclude": exclude,
"formfield_callback": old_formfield_callback,
}
defaults.update(kwargs)
language = self._language(request)
return translatable_modelform_factory(language, self.model, **defaults)
def response_change(self, request, obj):
redirect = super(TranslatableAdmin, self).response_change(request, obj)
uri = iri_to_uri(request.path)
if redirect['Location'] in (uri, "../add/"):
if self.query_language_key in request.GET:
redirect['Location'] = '%s?%s=%s' % (redirect['Location'],
self.query_language_key, request.GET[self.query_language_key])
return redirect
"""
# Should be added
@csrf_protect_m
@transaction.commit_on_success
def delete_translation(self, request, object_id, language_code):
"The 'delete translation' admin view for this model."
opts = self.model._meta
app_label = opts.app_label
translations_model = opts.translations_model
try:
obj = translations_model.objects.select_related('maser').get(
master__pk=unquote(object_id),
language_code=language_code)
except translations_model.DoesNotExist:
raise Http404
if not self.has_delete_permission(request, obj):
raise PermissionDenied
if len(self.get_available_languages(obj.master)) <= 1:
return self.deletion_not_allowed(request, obj, language_code)
using = router.db_for_write(translations_model)
# Populate deleted_objects, a data structure of all related objects that
# will also be deleted.
protected = False
if NEW_GET_DELETE_OBJECTS:
(deleted_objects, perms_needed, protected) = get_deleted_objects(
[obj], translations_model._meta, request.user, self.admin_site, using)
else: # pragma: no cover
(deleted_objects, perms_needed) = get_deleted_objects(
[obj], translations_model._meta, request.user, self.admin_site)
lang = get_language_name(language_code)
if request.POST: # The user has already confirmed the deletion.
if perms_needed:
raise PermissionDenied
obj_display = '%s translation of %s' % (lang, force_unicode(obj.master))
self.log_deletion(request, obj, obj_display)
self.delete_model_translation(request, obj)
self.message_user(request,
_('The %(name)s "%(obj)s" was deleted successfully.') % {
'name': force_unicode(opts.verbose_name),
'obj': force_unicode(obj_display)
}
)
if not self.has_change_permission(request, None):
return HttpResponseRedirect(reverse('admin:index'))
return HttpResponseRedirect(reverse('admin:%s_%s_changelist' % (opts.app_label, opts.module_name)))
object_name = '%s Translation' % force_unicode(opts.verbose_name)
if perms_needed or protected:
title = _("Cannot delete %(name)s") % {"name": object_name}
else:
title = _("Are you sure?")
context = {
"title": title,
"object_name": object_name,
"object": obj,
"deleted_objects": deleted_objects,
"perms_lacking": perms_needed,
"protected": protected,
"opts": opts,
"root_path": self.admin_site.root_path,
"app_label": app_label,
}
return render_to_response(self.delete_confirmation_template or [
"admin/%s/%s/delete_confirmation.html" % (app_label, opts.object_name.lower()),
"admin/%s/delete_confirmation.html" % app_label,
"admin/delete_confirmation.html"
], context, RequestContext(request))
def deletion_not_allowed(self, request, obj, language_code):
opts = self.model._meta
app_label = opts.app_label
object_name = force_unicode(opts.verbose_name)
context = RequestContext(request)
context['object'] = obj.master
context['language_code'] = language_code
context['opts'] = opts
context['app_label'] = app_label
context['language_name'] = get_language_name(language_code)
context['object_name'] = object_name
return render_to_response(self.deletion_not_allowed_template, context)
def delete_model_translation(self, request, obj):
obj.delete()
"""
def queryset(self, request):
language = self._language(request)
qs = self.model._default_manager.all()#.language(language)
# TODO: this should be handled by some parameter to the ChangeList.
ordering = self.ordering or () # otherwise we might try to *None, which is bad ;)
if ordering:
qs = qs.order_by(*ordering)
return qs
class TranslatableStackedInline(TranslatableInlineModelAdmin):
template = 'admin/nani/edit_inline/stacked.html'
class TranslatableTabularInline(TranslatableInlineModelAdmin):
template = 'admin/nani/edit_inline/tabular.html'