Ticket #12241: preserve_query_string8.patch

django/contrib/admin/options.py

@@ -13 +13 @@
 from django.db.models.related import RelatedObject
 from django.db.models.fields import BLANK_CHOICE_DASH, FieldDoesNotExist
 from django.db.models.sql.constants import LOOKUP_SEP, QUERY_TERMS
-from django.http import Http404, HttpResponse, HttpResponseRedirect
 from django.shortcuts import get_object_or_404, render_to_response
+from django.http import Http404, HttpResponse, HttpResponseRedirect, QueryDict
 from django.utils.decorators import method_decorator
 from django.utils.datastructures import SortedDict
 from django.utils.functional import update_wrapper
@@ -707 +707 @@
             "admin/change_form.html"
         ], context, context_instance=context_instance)
 
+    def url_with_querystring(self, request, url=None):
+        """
+        Returns a URL with the query string preserved from the current request.
+        """
+        if url is None:
+            url = request.path
+        querystring = request.GET.copy()
+
+        # If the new URL has an existing query string, set (or override
+        # existing) values with the new ones explicitly provided.
+        if '?' in url:
+            url, new_qs = url.split('?', 1)
+            for key, value in QueryDict(new_qs):
+                querystring.setlist(key, value)
+
+        # Preserve the admin's "_popup" variable which may have originate in
+        # the POST QueryDict.
+        if '_popup' in request.POST or '_popup' in request.REQUEST:
+            querystring['_popup'] = 1
+
+        if querystring:
+            url = '%s?%s' % (url, querystring.urlencode())
+        return url
+
     def response_add(self, request, obj, post_url_continue='../%s/'):
         """
         Determines the HttpResponse for the add_view stage.
         """
         opts = obj._meta
         pk_value = obj._get_pk_val()
+        verbose_name = opts.verbose_name
 
-        msg = _('The %(name)s "%(obj)s" was added successfully.') % {'name': force_unicode(opts.verbose_name), 'obj': force_unicode(obj)}
+        msg = _('The %(name)s "%(obj)s" was added successfully.') % {'name': force_unicode(verbose_name), 'obj': force_unicode(obj)}
         # Here, we distinguish between different save types by checking for
         # the presence of keys in request.POST.
         if "_continue" in request.POST:
             self.message_user(request, msg + ' ' + _("You may edit it again below."))
-            if "_popup" in request.POST:
-                post_url_continue += "?_popup=1"
-            return HttpResponseRedirect(post_url_continue % pk_value)
-
-        if "_popup" in request.POST:
+            url = self.url_with_querystring(request,
+                                            post_url_continue % pk_value)
+        elif "_addanother" in request.POST:
+            self.message_user(request, msg + ' ' + (_("You may add another %s below.") % force_unicode(verbose_name)))
+            url = self.url_with_querystring(request)
+        elif "_saveasnew" in request.POST:
+            msg = _('The %(name)s "%(obj)s" was added successfully. You may edit it again below.') % {'name': force_unicode(verbose_name), 'obj': obj}
+            self.message_user(request, msg)
+            return HttpResponseRedirect(self.url_with_querystring(request, "../%s/" % pk_value))
+        elif "_popup" in request.POST:
             return HttpResponse('<script type="text/javascript">opener.dismissAddAnotherPopup(window, "%s", "%s");</script>' % \
                 # escape() calls force_unicode.
                 (escape(pk_value), escapejs(obj)))
-        elif "_addanother" in request.POST:
-            self.message_user(request, msg + ' ' + (_("You may add another %s below.") % force_unicode(opts.verbose_name)))
-            return HttpResponseRedirect(request.path)
         else:
             self.message_user(request, msg)
-
             # Figure out where to redirect. If the user has change permission,
             # redirect to the change-list page for this object. Otherwise,
             # redirect to the admin index.
             if self.has_change_permission(request, None):
-                post_url = '../'
+                url = '../'
             else:
-                post_url = '../../../'
-            return HttpResponseRedirect(post_url)
+                url = '../../../'
+        return HttpResponseRedirect(url)
 
     def response_change(self, request, obj):
         """
@@ -754 +780 @@
             opts_ = opts.proxy_for_model._meta
             verbose_name = opts_.verbose_name
 
-        pk_value = obj._get_pk_val()
-
         msg = _('The %(name)s "%(obj)s" was changed successfully.') % {'name': force_unicode(verbose_name), 'obj': force_unicode(obj)}
         if "_continue" in request.POST:
             self.message_user(request, msg + ' ' + _("You may edit it again below."))
-            if "_popup" in request.REQUEST:
-                return HttpResponseRedirect(request.path + "?_popup=1")
-            else:
-                return HttpResponseRedirect(request.path)
-        elif "_saveasnew" in request.POST:
-            msg = _('The %(name)s "%(obj)s" was added successfully. You may edit it again below.') % {'name': force_unicode(verbose_name), 'obj': obj}
-            self.message_user(request, msg)
-            return HttpResponseRedirect("../%s/" % pk_value)
+            return HttpResponseRedirect(self.url_with_querystring(request, request.path))
         elif "_addanother" in request.POST:
             self.message_user(request, msg + ' ' + (_("You may add another %s below.") % force_unicode(verbose_name)))
-            return HttpResponseRedirect("../add/")
+            return HttpResponseRedirect(self.url_with_querystring(request, "../add/"))
         else:
             self.message_user(request, msg)
             # Figure out where to redirect. If the user has change permission,

tests/regressiontests/admin_views/tests.py

@@ -28 +28 @@
 from django.utils.http import urlencode
 from django.utils.translation import activate, deactivate
 from django.utils import unittest
+from django.http import QueryDict
 
 # local test models
 from models import (Article, BarAccount, CustomArticle, EmptyModel,
@@ -2110 +2111 @@
         # Message should contain non-ugly model name. Instance representation is set by model's __unicode__()
         self.assertContains(response, '<li class="info">The cover letter &quot;John Doe II&quot; was changed successfully.</li>')
 
+
+class AdminPreserveQSTest(TestCase):
+    """
+    Neither adding nor changing a model will preserve the request query string
+    after a redirection if the standard "save" button is used within the admin.
+    """
+    action = None
+    preserves_qs = False
+    fixtures = ['admin-views-users.xml']
+
+    def setUp(self):
+        self.client.login(username='super', password='secret')
+        self.data = {'title': "I Could Go Anywhere", 'content': "Versatile"}
+        article = Article.objects.create(date=datetime.datetime.now(),
+                                         **self.data)
+        self.data.update({'date_0': u"2008-03-18", 'date_1': u"11:54:58"})
+        if self.action:
+            self.data[self.action] = True
+        self.pk = article.id
+
+    def check_redirect(self, response):
+        self.assertEqual(response.status_code, 302)
+        location = urlparse.urlparse(response['Location'])
+        return QueryDict(location.query)
+
+    def test_response_add(self):
+        url = '/test_admin/admin/admin_views/article/add/'
+
+        response = self.client.post('%s?test=1' % url, self.data)
+        parsed_query_string = self.check_redirect(response)
+        if self.preserves_qs:
+            self.assertTrue('test' in parsed_query_string)
+        else:
+            self.assertFalse('test' in parsed_query_string)
+
+        # Test the popup redirection.
+        self.data['_popup'] = 1
+        response = self.client.post(url, self.data)
+        if self.preserves_qs:
+            parsed_query_string = self.check_redirect(response)
+            self.assertTrue('_popup' in parsed_query_string)
+        else:
+            self.assertContains(response,
+                '<script type="text/javascript">opener.dismissAddAnotherPopup')
+
+        # Test the popup redirection togethre with 2 other GET parameters.
+        response = self.client.post('%s?test=1&extra=1' % url, self.data)
+        if self.preserves_qs:
+            parsed_query_string = self.check_redirect(response)
+            self.assertTrue('test' in parsed_query_string)
+            self.assertTrue('extra' in parsed_query_string)
+            self.assertTrue('_popup' in parsed_query_string)
+        else:
+            self.assertContains(response,
+                '<script type="text/javascript">opener.dismissAddAnotherPopup')
+
+    def test_response_change(self):
+        url = '/test_admin/admin/admin_views/article/%d/' % self.pk
+
+        response = self.client.post('%s?test=1' % url, self.data)
+        parsed_query_string = self.check_redirect(response)
+        if self.preserves_qs:
+            self.assertTrue('test' in parsed_query_string)
+        else:
+            self.assertFalse('test' in parsed_query_string)
+
+        response = self.client.post(url, self.data)
+        parsed_query_string = self.check_redirect(response)
+        self.assertFalse('test' in parsed_query_string)
+
+
+class AdminPreserveQSOnContinueTest(AdminPreserveQSTest):
+    """
+    Adding or changing a model should preserve the request query string after
+    the redirection if the "save and continue" button is used within the admin
+    (Ticket #12241).
+    """
+    action = '_continue'
+    preserves_qs = True
+
+
+class AdminPreserveQSOnAddAnotherTest(AdminPreserveQSTest):
+    """
+    Adding or changing a model should preserve the request query string after
+    the redirection if the "add another" button is used within the admin
+    (Ticket #12241).
+    """
+    action = '_addanother'
+    preserves_qs = True
+
+
+class AdminPreserveQSOnSaveAsNewTest(AdminPreserveQSTest):
+    """
+    Adding or changing a model should preserve the request query string after
+    the redirection if the "save as new" button is used within the admin
+    (Ticket #12241).
+
+    Only the change view has the "save as new" button, but then
+    the admin use the response_add for the answer.
+    """
+    action = '_saveasnew'
+    preserves_qs = True
+
+
 class AdminInlineFileUploadTest(TestCase):
     fixtures = ['admin-views-users.xml', 'admin-views-actions.xml']
     urlbit = 'admin'