This repository has been archived by the owner on Feb 1, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
admin.py
285 lines (259 loc) · 12.1 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
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
from cms.admin.placeholderadmin import PlaceholderAdminMixin
from django.core.exceptions import PermissionDenied
from django.core.urlresolvers import reverse, NoReverseMatch
from django.contrib import messages
try:
from django.contrib.admin.utils import unquote
except ImportError:
# Django<=1.6
import warnings
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
from django.contrib.admin.util import unquote
from django.contrib.admin.templatetags.admin_urls import add_preserved_filters
from django.db import transaction
from django.http import HttpResponseRedirect
from django.shortcuts import get_object_or_404, render
from django.utils.encoding import force_text
from django.utils.translation import ugettext as _
from reversion import VERSION as REVERSION_VERSION
from reversion.admin import VersionAdmin
from reversion.models import Version
from .forms import RecoverObjectWithTranslationForm
from .utils import (
build_obj_repr,
object_is_translation,
get_translation_info_message,
get_conflict_fks_versions,
RecursiveRevisionConflictResolver
)
REVERSION_1_9_OR_HIGHER = REVERSION_VERSION >= (1, 9)
class VersionedPlaceholderAdminMixin(PlaceholderAdminMixin, VersionAdmin):
revision_confirmation_template = 'aldryn_reversion/confirm_reversion.html'
recover_confirmation_template = 'aldryn_reversion/confirm_recover.html'
def log_addition(self, request, obj, change_message=None):
"""
Override reversion.VersionAdmin log addition to provide useful message.
"""
comment = _(
"Initial version of %(object_repr)s.%(translation_info)s") % {
'object_repr': build_obj_repr(obj),
'translation_info': get_translation_info_message(obj)}
# starting from django-reversion 1.9 revision is created in add view
# so there is no need to do that manually, but we want to have
# our meaningful comment instead of the standard one.
if REVERSION_1_9_OR_HIGHER:
class_super = VersionedPlaceholderAdminMixin
else:
# Prior to django-reversion 1.9.0 there were no way to change
# initial comment, but we still need call super to invoke django's
# log_addition and avoid django-reversion log_addition.
class_super = VersionAdmin
try:
super(class_super, self).log_addition(request, obj, comment)
except TypeError: # Django < 1.9 pragma: no cover
super(class_super, self).log_addition(request, obj)
# For older reversions we still need to do revision manually.
if REVERSION_1_9_OR_HIGHER:
return
# previous implementation was to use self.get_revision_data
# but that was also removed in 1.9.0 since it was a duplicate of logic
# that is already present in save_revision or its related calls.
self.revision_manager.save_revision(
[obj],
user=request.user,
comment=comment,
ignore_duplicates=self.ignore_duplicate_revisions,
db=self.revision_context_manager.get_db(),
)
def log_change(self, request, obj, message, deletion=False):
# prepare correct change message so that we can distinguish which
# revision would be restored. if object has language code - apppend
# it to the message, but if previous operation was translation deletion
# do not modify the message, it is already prepared.
if not deletion:
message = "{0} {1}{2}".format(message, build_obj_repr(obj), get_translation_info_message(obj))
super(VersionedPlaceholderAdminMixin, self).log_change(request, obj, message)
# TODO: extract to separate translation admin mixin
def log_deletion(self, request, obj, object_repr):
# skip not translation objects, we don't need to do anything on regular
# objects
if not object_is_translation(obj):
super(VersionedPlaceholderAdminMixin, self).log_deletion(
request, obj, object_repr)
return
# django-reversion does not provides you with log deletion,
# for recover view it just uses diff between real objects
# and the last revision objects for given model.
# Instead wev will use log_change for translation master object
message = _(
"Translation deletion for %(object_repr)s "
"('%(lang_code)s' language).") % {
'object_repr': build_obj_repr(obj.master),
'lang_code': obj.language_code.upper()}
self.log_change(request, obj.master, message, deletion=True)
@transaction.atomic
def revision_view(self, request, object_id, version_id,
extra_context=None):
if not self.has_change_permission(request):
raise PermissionDenied()
obj = get_object_or_404(self.model, pk=unquote(object_id))
version = get_object_or_404(Version, pk=unquote(version_id),
object_id=force_text(obj.pk))
revision = version.revision
if request.method == "POST":
revision.revert()
opts = self.model._meta
pk_value = obj._get_pk_val()
preserved_filters = self.get_preserved_filters(request)
msg_dict = {
'name': force_text(opts.verbose_name),
'obj': force_text(obj)
}
msg = _('The %(name)s "%(obj)s" was successfully reverted. '
'You may edit it again below.') % msg_dict
self.message_user(request, msg, messages.SUCCESS)
redirect_url = reverse(
'admin:%s_%s_change' % (opts.app_label, opts.model_name),
args=(pk_value,),
current_app=self.admin_site.name
)
redirect_url = add_preserved_filters({
'preserved_filters': preserved_filters,
'opts': opts,
}, redirect_url)
return HttpResponseRedirect(redirect_url)
else:
context = {
'object': obj,
'version': version,
'revision': revision,
'revision_date': revision.date_created,
'versions': revision.version_set.order_by(
'content_type__model', 'object_id_int').all,
'object_name': force_text(self.model._meta.verbose_name),
'app_label': self.model._meta.app_label,
'opts': self.model._meta,
'add': False,
'change': True,
'save_as': False,
'has_add_permission': self.has_add_permission(request),
'has_change_permission': self.has_change_permission(
request, obj),
'has_delete_permission': self.has_delete_permission(
request, obj),
'has_file_field': True,
'has_absolute_url': False,
'original': obj,
}
return render(request, self.revision_confirmation_template, context)
@transaction.atomic
def recover_view(self, request, version_id, extra_context=None):
if not self.has_change_permission(request):
raise PermissionDenied()
version = get_object_or_404(Version, pk=unquote(version_id))
obj = version.object_version.object
revision = version.revision
# check for conflicts, it is better that user would solve them
conflict_fks_versions = get_conflict_fks_versions(
obj, version, revision)
# build urls to point user onto restore links for conflicts
opts = self.model._meta
non_reversible_by_user = []
conflicts_links_to_restore = []
for fk_version in conflict_fks_versions:
# try to point user to conflict recover views
try:
link = reverse(
'admin:{0}_{1}_recover'.format(
opts.app_label,
fk_version.object_version.object._meta.model_name),
args=[fk_version.pk])
link_dict = {
'version': fk_version,
'link': link
}
except NoReverseMatch:
# if there is exception either model is not registered
# with VersionedPlaceholderAdminMixin or there is no admin
# for that model. In both cases we need to revert this object
# to avoid conflicts / integrity errors
non_reversible_by_user.append(fk_version)
else:
conflicts_links_to_restore.append(link_dict)
# if there are conflicts that cannot be resolved manually by the user
# rely on resolver.
if len(non_reversible_by_user) > 0:
non_reversible_by_user = RecursiveRevisionConflictResolver(
non_reversible_by_user[0], non_reversible_by_user[1:]).resolve()
# prepare form kwargs
restore_form_kwargs = {
'revision': revision,
'obj': obj,
'version': version,
'resolve_conflicts': non_reversible_by_user,
}
if request.method == "POST":
form = RecoverObjectWithTranslationForm(request.POST,
**restore_form_kwargs)
# form.is_valid would perform validation against foreign keys
if form.is_valid():
# form save will restore desired versions for object and its
# translations
form.save()
# FIXME: optimize response
opts = self.model._meta
pk_value = obj._get_pk_val()
preserved_filters = self.get_preserved_filters(request)
msg_dict = {
'name': force_text(opts.verbose_name),
'obj': force_text(obj)
}
msg = _('The %(name)s "%(obj)s" was successfully recovered. '
'You may edit it again below.') % msg_dict
self.message_user(request, msg, messages.SUCCESS)
redirect_url = reverse(
'admin:%s_%s_change' % (opts.app_label, opts.model_name),
args=(pk_value,),
current_app=self.admin_site.name
)
# TODO: Check if there is next parameter and redirect to
# next, for cases of conflict solving.
redirect_url = add_preserved_filters({
'preserved_filters': preserved_filters,
'opts': opts,
}, redirect_url)
return HttpResponseRedirect(redirect_url)
else:
# populate form with regular data
form = RecoverObjectWithTranslationForm(**restore_form_kwargs)
context = {
'object': obj,
'version': version,
'revision': revision,
'revision_date': revision.date_created,
'conflict_links': conflicts_links_to_restore,
'non_resolvable_conflicts': non_reversible_by_user,
'versions': revision.version_set.order_by(
'content_type__name', 'object_id_int').all,
'object_name': force_text(self.model._meta.verbose_name),
'app_label': self.model._meta.app_label,
'opts': self.model._meta,
'add': False,
'change': True,
'save_as': False,
'has_add_permission': self.has_add_permission(request),
'has_change_permission': self.has_change_permission(
request, obj),
'has_delete_permission': self.has_delete_permission(
request, obj),
'has_file_field': True,
'has_absolute_url': False,
'original': obj,
}
# if there is no conflicts - add form to context.
if not conflicts_links_to_restore:
context['restore_form'] = form
return render(request, self.recover_confirmation_template, context)