Ticket #9749: patch_django_9749.20090318.diff

django/contrib/admin/validation.py

@@ -5 +5 @@
 
 from django.core.exceptions import ImproperlyConfigured
 from django.db import models
 from django.forms.models import BaseModelForm, BaseModelFormSet, fields_for_model
 from django.contrib.admin.options import flatten_fieldsets, BaseModelAdmin
 from django.contrib.admin.options import HORIZONTAL, VERTICAL
+from django.contrib.admin.views.main import ChangeList
 
 __all__ = ['validate']
 
@@ -149 +150 @@
                 raise ImproperlyConfigured("'%s.inlines[%d].model' does not "
                         "inherit from models.Model." % (cls.__name__, idx))
             validate_base(inline, inline.model)
-            validate_inline(inline)
+            validate_inline(inline, cls, model)
 
-def validate_inline(cls):
+    # changelist_class = ChangeList
+    if hasattr(cls, 'changelist_class') and not issubclass(cls.changelist_class, ChangeList):
+        raise ImproperlyConfigured("'%s.changelist_class' does not inherit "
+                        "from admin.views.main.ChangeList." % cls.__name__)
+
+def validate_inline(cls, parent, parent_model):
     # model is already verified to exist and be a Model
     if cls.fk_name: # default value is None
         f = get_field(cls, cls.model, cls.model._meta, 'fk_name', cls.fk_name)

django/contrib/admin/options.py

@@ -171 +171 @@
 
 class ModelAdmin(BaseModelAdmin):
     "Encapsulates all admin options and functionality for a given model."
+    # Avoid circular import of ChangeList
+    from django.contrib.admin.views.main import ChangeList
+    
     __metaclass__ = forms.MediaDefiningClass
 
     list_display = ('__str__',)
@@ -185 +188 @@
     save_on_top = False
     ordering = None
     inlines = []
-
+    changelist_class = ChangeList
+    
     # Custom templates (designed to be over-ridden in subclasses)
     change_form_template = None
     change_list_template = None
@@ -703 +707 @@
 
     def changelist_view(self, request, extra_context=None):
         "The 'change list' admin view for this model."
-        from django.contrib.admin.views.main import ChangeList, ERROR_FLAG
         opts = self.model._meta
         app_label = opts.app_label
         if not self.has_change_permission(request, None):
             raise PermissionDenied
         try:
-            cl = ChangeList(request, self.model, self.list_display, self.list_display_links, self.list_filter,
+            cl = self.changelist_class(request, self.model, self.list_display, self.list_display_links, self.list_filter,
                 self.date_hierarchy, self.search_fields, self.list_select_related, self.list_per_page, self.list_editable, self)
         except IncorrectLookupParameters:
             # Wacky lookup parameters were given, so redirect to the main
@@ -717 +720 @@
             # parameter via the query string. If wacky parameters were given and
             # the 'invalid=1' parameter was already in the query string, something
             # is screwed up with the database, so display an error page.
+            from django.contrib.admin.views.main import ERROR_FLAG
             if ERROR_FLAG in request.GET.keys():
                 return render_to_response('admin/invalid_setup.html', {'title': _('Database error')})
             return HttpResponseRedirect(request.path + '?' + ERROR_FLAG + '=1')

tests/regressiontests/admin_views/tests.py

@@ -875 +875 @@
         self.failUnlessEqual(FooAccount.objects.all()[0].username, "%s-1" % foo_user)
         self.failUnlessEqual(BarAccount.objects.all()[0].username, "%s-1" % bar_user)
         self.failUnlessEqual(Persona.objects.all()[0].accounts.count(), 2)
+
+
+class AdminCustomChangeListTest(TestCase):
+    fixtures = ['admin-views-users.xml']
+
+    def setUp(self):
+        self.client.login(username='super', password='secret')
+
+    def tearDown(self):
+        self.client.logout()
+
+    def testCustomLinkPresence(self):
+        """
+        A test to ensure that custom ChangeList class works as expected.
+        """
+        post_data = {
+            "title": u"Lion",
+        }
+        response = self.client.post('/test_admin/admin/admin_views/animal/add/', post_data)
+        self.failUnlessEqual(response.status_code, 302) # redirect somewhere
+        response = self.client.get('/test_admin/admin/admin_views/animal/')
+        self.failUnlessEqual(response.status_code, 200)
+        should_contain = """<a href="custom/1/">Lion</a>"""
+        self.assertContains(response, should_contain)
+
+

tests/regressiontests/admin_views/models.py

@@ -165 +166 @@
     def __unicode__(self):
         return self.name
 
+class Animal(models.Model):
+    title = models.CharField(max_length=20)
+    def __unicode__(self):
+        return self.title
+
+class AnimalChangeList(admin.views.main.ChangeList):
+    def url_for_result(self, result):
+        return "custom/%s/" % admin.util.quote(getattr(result, self.pk_attname))
+
 class Account(models.Model):
     """
     A simple, generic account encapsulating the information shared by all
@@ -199 +209 @@
         BarAccountAdmin
     )
 
+class AnimalAdmin(admin.ModelAdmin):
+    changelist_class = AnimalChangeList
 
+
 admin.site.register(Article, ArticleAdmin)
 admin.site.register(CustomArticle, CustomArticleAdmin)
 admin.site.register(Section, inlines=[ArticleInline])
@@ -208 +221 @@
 admin.site.register(Thing, ThingAdmin)
 admin.site.register(Person, PersonAdmin)
 admin.site.register(Persona, PersonaAdmin)
+admin.site.register(Animal, AnimalAdmin)
 
 # We intentionally register Promo and ChapterXtra1 but not Chapter nor ChapterXtra2.
 # That way we cover all four cases:

tests/regressiontests/modeladmin/models.py

@@ -912 +912 @@
 ...     inlines = [ValidationTestInline]
 >>> validate(ValidationTestModelAdmin, ValidationTestModel)
 
+# changelist_class
+
+>>> class ValidationTestModelAdmin(ModelAdmin):
+...     changelist_class = object
+>>> validate(ValidationTestModelAdmin, ValidationTestModel)
+Traceback (most recent call last):
+...
+ImproperlyConfigured: 'ValidationTestModelAdmin.changelist_class' does not inherit from admin.views.main.ChangeList.
+
+>>> from django.contrib.admin.views.main import ChangeList
+>>> class ValidationTestChangeList(ChangeList):
+...     def url_for_result(self, result):
+...         return "custom/%s/" % quote(getattr(result, self.pk_attname))
+>>> class ValidationTestModelAdmin(ModelAdmin):
+...     changelist_class = ValidationTestChangeList
+>>> validate(ValidationTestModelAdmin, ValidationTestModel)
+
 """
 }

docs/ref/contrib/admin.txt

@@ -77 +77 @@
     class AuthorAdmin(admin.ModelAdmin):
         date_hierarchy = 'pub_date'
 
+``changelist_class``
+~~~~~~~~~~~~~~~~~~
+
+Set ``changelist_class`` to a class which inherits from 
+``admin.views.main.ChangeList``, and the change list page will use this class
+to render the list.
+
+Example::
+
+    from django.contrib import admin
+    
+    class CustomChangeList(admin.views.main.ChangeList):
+        def url_for_result(self, result):
+            return "custom/%s/" % admin.util.quote(getattr(result, self.pk_attname))
+    
+    class AuthorAdmin(admin.ModelAdmin):
+        date_hierarchy = 'pub_date'
+        changelist_class = CustomChangeList
+    
+
 ``date_hierarchy``
 ~~~~~~~~~~~~~~~~~~