Changeset 8273

Timestamp:

08/09/08 15:52:40 (1 year ago)

Author:

brosner

Message:

Fixed #5780 -- Adjusted the ModelAdmin? API to allow the created/updated objects
to be passed to the formsets prior to validation.

This is a backward incompatible change for anyone overridding save_add or
save_change. They have been removed in favor of more granular methods
introduced in [8266] and the new response_add and response_change nethods.
save_model has been renamed to save_form due to its slightly changed behavior.

Files:

• django/trunk/django/contrib/admin/options.py (modified) (7 diffs)
• django/trunk/docs/admin.txt (modified) (1 diff)
• django/trunk/tests/regressiontests/admin_views/models.py (modified) (2 diffs)
• django/trunk/tests/regressiontests/admin_views/tests.py (modified) (2 diffs)

django/trunk/django/contrib/admin/options.py

@@ -453 +453 @@
-        request.user.message_set.create(message=message)
-
-model
-
-Save and return a model given a ModelForm. ``change`` is True if the
-
-
-Tru
+form
+
+Given a ModelForm return an unsaved instance. ``change`` is True if
+the 
+
+Fals
-
-    def save_formset(self, request, form, formset, change):
-        """
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-
-    def render_change_form(self, request, context, add=False, change=False, form_url='', obj=None):
@@ -575 +491 @@
-            "admin/change_form.html"
-        ], context, context_instance=template.RequestContext(request))
+    
+    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()
+        
+        msg = _('The %(name)s "%(obj)s" was added successfully.') % {'name': force_unicode(opts.verbose_name), 'obj': force_unicode(obj)}
+        # Here, we distinguish between different save types by checking for
+        # the presence of keys in request.POST.
+        if request.POST.has_key("_continue"):
+            self.message_user(request, msg + ' ' + _("You may edit it again below."))
+            if request.POST.has_key("_popup"):
+                post_url_continue += "?_popup=1"
+            return HttpResponseRedirect(post_url_continue % pk_value)
+        
+        if request.POST.has_key("_popup"):
+            return HttpResponse('<script type="text/javascript">opener.dismissAddAnotherPopup(window, "%s", "%s");</script>' % \
+                # escape() calls force_unicode.
+                (escape(pk_value), escape(obj)))
+        elif request.POST.has_key("_addanother"):
+            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 = '../'
+            else:
+                post_url = '../../../'
+            return HttpResponseRedirect(post_url)
+    
+    def response_change(self, request, obj):
+        """
+        Determines the HttpResponse for the change_view stage.
+        """
+        opts = obj._meta
+        pk_value = obj._get_pk_val()
+        
+        msg = _('The %(name)s "%(obj)s" was changed successfully.') % {'name': force_unicode(opts.verbose_name), 'obj': force_unicode(obj)}
+        if request.POST.has_key("_continue"):
+            self.message_user(request, msg + ' ' + _("You may edit it again below."))
+            if request.REQUEST.has_key('_popup'):
+                return HttpResponseRedirect(request.path + "?_popup=1")
+            else:
+                return HttpResponseRedirect(request.path)
+        elif request.POST.has_key("_saveasnew"):
+            msg = _('The %(name)s "%(obj)s" was added successfully. You may edit it again below.') % {'name': force_unicode(opts.verbose_name), 'obj': obj}
+            self.message_user(request, msg)
+            return HttpResponseRedirect("../%s/" % pk_value)
+        elif request.POST.has_key("_addanother"):
+            self.message_user(request, msg + ' ' + (_("You may add another %s below.") % force_unicode(opts.verbose_name)))
+            return HttpResponseRedirect("../add/")
+        else:
+            self.message_user(request, msg)
+            return HttpResponseRedirect("../")
-
-    def add_view(self, request, form_url='', extra_context=None):
@@ -593 +569 @@
-
-        ModelForm = self.get_form(request)
-
-
+
-        if request.method == 'POST':
-            form = ModelForm(request.POST, request.FILES)
+            if form.is_valid():
+                form_validated = True
+                new_object = self.save_form(request, form, change=False)
+            else:
+                form_validated = False
+                new_object = self.model()
-            for FormSet in self.get_formsets(request):
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        else:
-            form = ModelForm(initial=dict(request.GET.items()))
-            for FormSet in self.get_formsets(request):
-inline_formset = FormSet(instance=obj
-inline_formsets.append(inline_
+formset = FormSet(instance=self.model()
+formsets.append(
-
-        adminForm = AdminForm(form, list(self.get_fieldsets(request)), self.prepopulated_fields)
-        media = self.media + adminForm.media
-s in inline_
-s
+ormset in 
+ormset
-
-        inline_admin_formsets = []
-inline_
+
-            fieldsets = list(inline.get_fieldsets(request))
-            inline_admin_formset = InlineAdminFormSet(inline, formset, fieldsets)
@@ -627 +618 @@
-            'media': mark_safe(media),
-            'inline_admin_formsets': inline_admin_formsets,
-inline_
+
-            'root_path': self.admin_site.root_path,
-        }
-        context.update(extra_context or {})
-        return self.render_change_form(request, context, add=True)
+    add_view = transaction.commit_on_success(add_view)
-
-    def change_view(self, request, object_id, extra_context=None):
@@ -657 +649 @@
-
-        ModelForm = self.get_form(request, obj)
-inline_
+
-        if request.method == 'POST':
-            form = ModelForm(request.POST, request.FILES, instance=obj)
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        else:
-            form = ModelForm(instance=obj)
-            for FormSet in self.get_formsets(request, obj):
-inline_
-inline_formsets.append(inline_
+
+formsets.append(
-
-        adminForm = AdminForm(form, self.get_fieldsets(request, obj), self.prepopulated_fields)
@@ -676 +685 @@
-
-        inline_admin_formsets = []
-inline_
+
-            fieldsets = list(inline.get_fieldsets(request, obj))
-            inline_admin_formset = InlineAdminFormSet(inline, formset, fieldsets)
@@ -690 +699 @@
-            'media': mark_safe(media),
-            'inline_admin_formsets': inline_admin_formsets,
-inline_
+
-            'root_path': self.admin_site.root_path,
-        }
-        context.update(extra_context or {})
-        return self.render_change_form(request, context, change=True, obj=obj)
+    change_view = transaction.commit_on_success(change_view)
-
-    def changelist_view(self, request, extra_context=None):

django/trunk/docs/admin.txt

@@ -522 +522 @@
-    an index. Currently this is only available for MySQL.
-
+``ModelAdmin`` methods
+----------------------
+
+``save_form(self, request, form, change)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``save_form`` method is given the ``HttpRequest``, a ``ModelForm``
+instance and a boolean value based on whether it is adding or changing the
+object.
+
+This method should return an unsaved instance. For example to attach
+``request.user`` to the object prior to saving::
+
+    class ArticleAdmin(admin.ModelAdmin):
+        def save_form(self, request, form, change):
+            instance = form.save(commit=False)
+            instance.user = request.user
+            return instance
+
+``save_formset(self, request, form, formset, change)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``save_formset`` method is given the ``HttpRequest``, the parent
+``ModelForm`` instance and a boolean value baesed on whether it is adding or
+changing the parent object.
+
+This method should return unsaved instances. These instances will later be
+saved to the database. By default the formset will only return instances that
+have changed. For example to attach ``request.user`` to each changed formset
+model instance::
+
+    class ArticleAdmin(admin.ModelAdmin):
+        def save_formset(self, request, form, formset, change):
+            instances = formset.save(commit=False)
+            for instance in instances:
+                instance.user = request.user
+            return instances
+
-``ModelAdmin`` media definitions
---------------------------------

django/trunk/tests/regressiontests/admin_views/models.py

@@ -20 +20 @@
-    def __unicode__(self):
-        return self.title
+
+class ArticleInline(admin.TabularInline):
+    model = Article
-
-class ArticleAdmin(admin.ModelAdmin):
@@ -62 +65 @@
-admin.site.register(Article, ArticleAdmin)
-admin.site.register(CustomArticle, CustomArticleAdmin)
-
+, inlines=[ArticleInline]
-admin.site.register(ModelWithStringPrimaryKey)

django/trunk/tests/regressiontests/admin_views/tests.py

@@ -12 +12 @@
-from models import Article, CustomArticle, Section, ModelWithStringPrimaryKey
-
+class AdminViewBasicTest(TestCase):
+    fixtures = ['admin-views-users.xml']
+    
+    def setUp(self):
+        self.client.login(username='super', password='secret')
+    
+    def tearDown(self):
+        self.client.logout()
+    
+    def testTrailingSlashRequired(self):
+        """
+        If you leave off the trailing slash, app should redirect and add it.
+        """
+        request = self.client.get('/test_admin/admin/admin_views/article/add')
+        self.assertRedirects(request,
+            '/test_admin/admin/admin_views/article/add/'
+        )
+    
+    def testBasicAddGet(self):
+        """
+        A smoke test to ensure GET on the add_view works.
+        """
+        response = self.client.get('/test_admin/admin/admin_views/section/add/')
+        self.failUnlessEqual(response.status_code, 200)
+    
+    def testBasicEditGet(self):
+        """
+        A smoke test to ensureGET on the change_view works.
+        """
+        response = self.client.get('/test_admin/admin/admin_views/section/1/')
+        self.failUnlessEqual(response.status_code, 200)
+    
+    def testBasicAddPost(self):
+        """
+        A smoke test to ensure POST on add_view works.
+        """
+        post_data = {
+            "name": u"Another Section",
+            # inline data
+            "article_set-TOTAL_FORMS": u"3",
+            "article_set-INITIAL_FORMS": u"0",
+        }
+        response = self.client.post('/test_admin/admin/admin_views/section/add/', post_data)
+        self.failUnlessEqual(response.status_code, 302) # redirect somewhere
+    
+    def testBasicEditPost(self):
+        """
+        A smoke test to ensure POST on edit_view works.
+        """
+        post_data = {
+            "name": u"Test section",
+            # inline data
+            "article_set-TOTAL_FORMS": u"4",
+            "article_set-INITIAL_FORMS": u"1",
+            "article_set-0-id": u"1",
+            # there is no title in database, give one here or formset
+            # will fail.
+            "article_set-0-title": u"Need a title.",
+            "article_set-0-content": u"<p>test content</p>",
+            "article_set-0-date_0": u"2008-03-18",
+            "article_set-0-date_1": u"11:54:58",
+            "article_set-1-id": u"",
+            "article_set-1-title": u"",
+            "article_set-1-content": u"",
+            "article_set-1-date_0": u"",
+            "article_set-1-date_1": u"",
+            "article_set-2-id": u"",
+            "article_set-2-title": u"",
+            "article_set-2-content": u"",
+            "article_set-2-date_0": u"",
+            "article_set-2-date_1": u"",
+            "article_set-3-id": u"",
+            "article_set-3-title": u"",
+            "article_set-3-content": u"",
+            "article_set-3-date_0": u"",
+            "article_set-3-date_1": u"",
+        }
+        response = self.client.post('/test_admin/admin/admin_views/section/1/', post_data)
+        self.failUnlessEqual(response.status_code, 302) # redirect somewhere
+
-def get_perm(Model, perm):
-    """Return the permission object, for the Model"""
-    ct = ContentType.objects.get_for_model(Model)
-
+ 
-
-class AdminViewPermissionsTest(TestCase):
@@ -77 +157 @@
-                     'username': 'joepublic',
-                     'password': 'secret'}
-
-    def testTrailingSlashRequired(self):
-        """
-        If you leave off the trailing slash, app should redirect and add it.
-        """
-        self.client.post('/test_admin/admin/', self.super_login)
-
-        request = self.client.get(
-            '/test_admin/admin/admin_views/article/add'
-        )
-        self.assertRedirects(request,
-            '/test_admin/admin/admin_views/article/add/'
-        )
-
-    def testLogin(self):