Ticket #12875: ticket_12875_for_r16341_with_docs.diff

docs/ref/contrib/admin/index.txt

@@ -696 +696 @@
     If this isn't provided, the Django admin will use the model's default
     ordering.
 
+    If you need to specify a dynamic order (for example depending on user or
+    language) you can implement a ``get_ordering`` method. This method take
+    ``request`` as parameter and returns the ordering list/tuple. For example::
+
+              class PersonAdmin(ModelAdmin):
+
+                  def get_ordering(self, request):
+                      if request.user.is_superuser:
+                          return ('rank', )
+                      else:
+                          return ('name', )
+
     .. versionchanged:: 1.4
 
     Django honors all elements in the list/tuple; before 1.4, only the first

django/contrib/admin/options.py

@@ -208 +208 @@
         """
         qs = self.model._default_manager.get_query_set()
         # TODO: this should be handled by some parameter to the ChangeList.
-        ordering = self.ordering or () # otherwise we might try to *None, which is bad ;)
+        ordering = self.get_ordering(request) or self.ordering or () # otherwise we might try to *None, which is bad ;)
         if ordering:
             qs = qs.order_by(*ordering)
         return qs
@@ -260 +260 @@
             clean_lookup = LOOKUP_SEP.join(parts)
             return clean_lookup in self.list_filter or clean_lookup == self.date_hierarchy
 
+    def get_ordering(self, request):
+        return None
+
+
 class ModelAdmin(BaseModelAdmin):
     "Encapsulates all admin options and functionality for a given model."
 

django/contrib/admin/views/main.py

@@ -27 +27 @@
 ERROR_FLAG = 'e'
 
 IGNORED_PARAMS = (
-    ALL_VAR, ORDER_VAR, ORDER_TYPE_VAR, SEARCH_VAR, IS_POPUP_VAR, TO_FIELD_VAR)
+    ALL_VAR, ORDER_VAR, ORDER_TYPE_VAR, SEARCH_VAR, IS_POPUP_VAR, TO_FIELD_VAR, )
 
 # Text to display within change-list table cells if the value is blank.
 EMPTY_CHANGELIST_VALUE = ugettext_lazy('(None)')
@@ -76 +76 @@
             self.list_editable = ()
         else:
             self.list_editable = list_editable
-        self.ordering = self.get_ordering()
+        self.ordering = self.get_ordering(request)
         self.query = request.GET.get(SEARCH_VAR, '')
         self.query_set = self.get_query_set(request)
         self.get_results(request)
@@ -172 +172 @@
             ordering = self.lookup_opts.ordering
         return ordering
 
-    def get_ordering(self):
+    def get_ordering(self, request):
         params = self.params
-        # For ordering, first check the "ordering" parameter in the admin
+        # For ordering, first check the if exists the "get_ordering" method
+        # in model admin, then check "ordering" parameter in the admin
         # options, then check the object's default ordering. Finally, a
         # manually-specified ordering from the query string overrides anything.
-        ordering = self._get_default_ordering()
+        ordering = self.model_admin.get_ordering(request) or self._get_default_ordering()
 
         if ORDER_VAR in params:
             # Clear ordering and used params

tests/regressiontests/admin_ordering/tests.py

@@ -1 +1 @@
 from django.test import TestCase
+from django.contrib.auth.models import User
 from django.contrib.admin.options import ModelAdmin
 
-from models import Band, Song, SongInlineDefaultOrdering, SongInlineNewOrdering
+from models import Band, Song, SongInlineDefaultOrdering, SongInlineNewOrdering, DynOrderingBandAdmin
 
 class TestAdminOrdering(TestCase):
     """
@@ -38 +39 @@
         names = [b.name for b in ma.queryset(None)]
         self.assertEqual([u'Radiohead', u'Van Halen', u'Aerosmith'], names)
 
+    def test_dynamic_ordering(self):
+        """
+        Let's use a custom ModelAdmin that changes the ordering dinamically.
+        """
+        super_user = User.objects.create(username='admin', is_superuser=True)
+        other_user = User.objects.create(username='other')
+        class DummyRequest(object): pass
+        request = DummyRequest()
+        request.user = super_user
+        ma = DynOrderingBandAdmin(Band, None)
+        names = [b.name for b in ma.queryset(request)]
+        self.assertEqual([u'Radiohead', u'Van Halen', u'Aerosmith'], names)
+        request.user = other_user
+        names = [b.name for b in ma.queryset(request)]
+        self.assertEqual([u'Aerosmith', u'Radiohead', u'Van Halen'], names)
+
+
 class TestInlineModelAdminOrdering(TestCase):
     """
     Let's make sure that InlineModelAdmin.queryset uses the ordering we define

tests/regressiontests/admin_ordering/models.py

@@ -18 +18 @@
     class Meta:
         ordering = ('name',)
 
+class DynOrderingBandAdmin(admin.ModelAdmin):
+
+    def get_ordering(self, request):
+        if request.user.is_superuser:
+            return ('rank',)
+        else:
+            return ('name',)
+
 class SongInlineDefaultOrdering(admin.StackedInline):
     model = Song
 
 class SongInlineNewOrdering(admin.StackedInline):
     model = Song
     ordering = ('duration', )
+
+