Merge pull request #187 from buddylindsey/add-edit-history

Add ability to edit history

Author: macro1

AUTHORS.rst

@@ -3,6 +3,7 @@ Authors
 
 - Aleksey Kladov
 - bradford281
+- Buddy Lindsey, Jr.
 - Brian Dixon
 - Corey Bertram
 - Damien Nozay

CHANGES.rst

@@ -4,6 +4,7 @@ Changes
 tip (unreleased)
 ----------------
 - Add ability to list history in admin when the object instance is deleted. (gh-72)
+- Add ability to change history through the admin. (Enabled with the `SIMPLE_HISTORY_EDIT` setting.)
 
 1.6.3 (2015-07-30)
 ------------------

setup.py

@@ -1,7 +1,9 @@
 from setuptools import setup
 import simple_history
 
-tests_require = ["Django>=1.4", "webtest==2.0.6", "django-webtest==1.7"]
+tests_require = [
+    "Django>=1.4", "webtest==2.0.6", "django-webtest==1.7", "mock==1.0.1"
+]
 try:
     from unittest import skipUnless
 except ImportError:  # Python 2.6 compatibility

simple_history/admin.py

@@ -1,12 +1,11 @@
 from __future__ import unicode_literals
 
+from django import http
 from django.core.exceptions import PermissionDenied
 from django.conf.urls import patterns, url
-from django.contrib import admin
-from django.contrib.admin import helpers
+from django.contrib.admin import helpers, ModelAdmin
 from django.contrib.contenttypes.models import ContentType
 from django.core.urlresolvers import reverse
-from django.http import Http404
 from django.shortcuts import get_object_or_404, render
 from django.utils.text import capfirst
 from django.utils.html import mark_safe
@@ -25,8 +24,10 @@
 
 USER_NATURAL_KEY = tuple(key.lower() for key in USER_NATURAL_KEY.split('.', 1))
 
+SIMPLE_HISTORY_EDIT = getattr(settings, 'SIMPLE_HISTORY_EDIT', False)
 
-class SimpleHistoryAdmin(admin.ModelAdmin):
+
+class SimpleHistoryAdmin(ModelAdmin):
     object_history_template = "simple_history/object_history.html"
     object_history_form_template = "simple_history/object_history_form.html"
 
@@ -63,7 +64,7 @@ def history_view(self, request, object_id, extra_context=None):
             try:
                 obj = action_list.latest('history_date').instance
             except action_list.model.DoesNotExist:
-                raise Http404
+                raise http.Http404
         content_type = ContentType.objects.get_by_natural_key(
             *USER_NATURAL_KEY)
         admin_user_view = 'admin:%s_%s_change' % (content_type.app_label,
@@ -82,6 +83,23 @@ def history_view(self, request, object_id, extra_context=None):
         return render(request, template_name=self.object_history_template,
                       dictionary=context, current_app=self.admin_site.name)
 
+    def response_change(self, request, obj):
+        if '_change_history' in request.POST and SIMPLE_HISTORY_EDIT:
+            verbose_name = obj._meta.verbose_name
+
+            msg = _('The %(name)s "%(obj)s" was changed successfully.') % {
+                'name': force_text(verbose_name),
+                'obj': force_text(obj)
+            }
+
+            self.message_user(
+                request, "%s - %s" % (msg, _("You may edit it again below")))
+
+            return http.HttpResponseRedirect(request.path)
+        else:
+            return super(SimpleHistoryAdmin, self).response_change(
+                request, obj)
+
     def history_form_view(self, request, object_id, version_id):
         original_opts = self.model._meta
         model = getattr(
@@ -96,6 +114,14 @@ def history_form_view(self, request, object_id, version_id):
         if not self.has_change_permission(request, obj):
             raise PermissionDenied
 
+        if SIMPLE_HISTORY_EDIT:
+            change_history = True
+        else:
+            change_history = False
+
+        if '_change_history' in request.POST and SIMPLE_HISTORY_EDIT:
+            obj = obj.history.get(pk=version_id)
+
         formsets = []
         form_class = self.get_form(request, obj)
         if request.method == 'POST':
@@ -141,6 +167,8 @@ def history_form_view(self, request, object_id, version_id):
                                   args=(obj.pk,)),
             'history_url': reverse('%s:%s_%s_history' % url_triplet,
                                    args=(obj.pk,)),
+            'change_history': change_history,
+
             # Context variables copied from render_change_form
             'add': False,
             'change': True,

simple_history/templates/simple_history/object_history_form.html

@@ -13,13 +13,10 @@
   </div>
 {% endblock %}
 
-{% comment %}Hack to remove "Save as New" and "Save and Continue" buttons {% endcomment %}
-{% block content %}
-  {% with 1 as is_popup %}
-    {{block.super}}
-  {% endwith %}
+{% block submit_buttons_bottom %}
+  {% include "simple_history/submit_line.html" %}
 {% endblock %}
 
 {% block form_top %}
-  <p>{% blocktrans %}Press the save button below to revert to this version of the object.{% endblocktrans %}</p>
+<p>{% blocktrans %}Press the 'Revert' button below to revert to this version of the object.{% endblocktrans %} {% if change_history %}{% blocktrans %}Or press the 'Change History' button to edit the history.{% endblocktrans %}{% endif %}</p>
 {% endblock %}

simple_history/templates/simple_history/submit_line.html

@@ -0,0 +1,5 @@
+{% load i18n %}
+<div class="submit-row">
+<input type="submit" value="{% trans 'Revert' %}" class="default" name="_save" {{ onclick_attrib }}/>
+{% if change_history %}<input type="submit" value="{% trans 'Change History' %}" class="default" name="_change_history" {{ onclick_attrib }}/>{% endif %}
+</div>