Ticket #12566: 0001-contrib.admin-allow-overriding-of-actions.html-templ.patch

django/contrib/admin/options.py

@@ -13 +13 @@
 from django.db.models.fields import BLANK_CHOICE_DASH
 from django.http import Http404, HttpResponse, HttpResponseRedirect
 from django.shortcuts import get_object_or_404, render_to_response
+from django.template.loader import find_template
 from django.utils.decorators import method_decorator
 from django.utils.datastructures import SortedDict
 from django.utils.functional import update_wrapper
@@ -210 +211 @@
     # Actions
     actions = []
     action_form = helpers.ActionForm
+    actions_template = None
     actions_on_top = True
     actions_on_bottom = False
     actions_selection_counter = True
@@ -1060 +1062 @@
         if actions:
             action_form = self.action_form(auto_id=None)
             action_form.fields['action'].choices = self.get_action_choices(request)
+
+            if self.actions_template:
+                actions_template = self.actions_template
+            else:
+                # Search for the appropriate template path for inclusion by {% admin_actions %}
+                for t in (
+                    'admin/%s/%s/actions.html' % (app_label, opts.object_name.lower()),
+                    'admin/%s/actions.html' % app_label,
+                    'admin/actions.html',
+                ):
+                    try:
+                        find_template(t)
+                    except template.TemplateDoesNotExist:
+                        continue
+                    else:
+                        actions_template = t
+                        break
         else:
             action_form = None
+            actions_template = None
 
         selection_note_all = ungettext('%(total_count)s selected',
             'All %(total_count)s selected', cl.result_count)
@@ -1078 +1098 @@
             'root_path': self.admin_site.root_path,
             'app_label': app_label,
             'action_form': action_form,
+            'actions_template': actions_template,
             'actions_on_top': self.actions_on_top,
             'actions_on_bottom': self.actions_on_bottom,
             'actions_selection_counter': self.actions_selection_counter,

django/contrib/admin/templatetags/admin_list.py

@@ -13 +13 @@
 from django.utils.text import capfirst
 from django.utils.translation import ugettext as _
 from django.utils.encoding import smart_unicode, force_unicode
-from django.template import Library
+from django.template import Library, Node
+from django.template.loader import get_template
 
 
 register = Library()
@@ -287 +288 @@
     return {'title': spec.title(), 'choices' : list(spec.choices(cl))}
 admin_list_filter = register.inclusion_tag('admin/filter.html')(admin_list_filter)
 
-def admin_actions(context):
-    """
-    Track the number of times the action field has been rendered on the page,
-    so we know which value to use.
-    """
-    context['action_index'] = context.get('action_index', -1) + 1
-    return context
-admin_actions = register.inclusion_tag("admin/actions.html", takes_context=True)(admin_actions)
+#@register.tag
+def admin_actions(parser, token):
+    class IncludeActionsTemplateNode(Node):
+        def render(self, context):
+            # Track the number of times the action field has been rendered on
+            # the page, so we know which value to use.
+            context['action_index'] = context.get('action_index', -1) + 1
+
+            try:
+                t = get_template(context.get('actions_template', 'admin/actions.html'))
+                return t.render(context)
+            except:
+                return ''
+
+    return IncludeActionsTemplateNode()
+admin_actions = register.tag(admin_actions)

docs/ref/contrib/admin/index.txt

@@ -718 +718 @@
 the default admin templates.  Use the following options to override the default
 templates used by the :class:`ModelAdmin` views:
 
+.. attribute:: ModelAdmin.actions_template
+
+.. versionadded:: 1.2
+
+Path to a custom template that will be used to display actions in the model
+objects "change list" view.
+
+If you don't specify this attribute, a default template shipped with Django
+that provides the standard appearance is used.
+
 .. attribute:: ModelAdmin.add_form_template
 
     .. versionadded:: 1.2
@@ -1363 +1373 @@
     * ``app_index.html``
     * ``change_form.html``
     * ``change_list.html``
+    * ``actions.html``
     * ``delete_confirmation.html``
     * ``object_history.html``
 

new file tests/regressiontests/admin_actions/fixtures/admin-views-users.xml

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+<django-objects version="1.0">
+    <object pk="100" model="auth.user">
+        <field type="CharField" name="username">super</field>
+        <field type="CharField" name="first_name">Super</field>
+        <field type="CharField" name="last_name">User</field>
+        <field type="CharField" name="email">super@example.com</field>
+        <field type="CharField" name="password">sha1$995a3$6011485ea3834267d719b4c801409b8b1ddd0158</field>
+        <field type="BooleanField" name="is_staff">True</field>
+        <field type="BooleanField" name="is_active">True</field>
+        <field type="BooleanField" name="is_superuser">True</field>
+        <field type="DateTimeField" name="last_login">2007-05-30 13:20:10</field>
+        <field type="DateTimeField" name="date_joined">2007-05-30 13:20:10</field>
+        <field to="auth.group" name="groups" rel="ManyToManyRel"></field>
+        <field to="auth.permission" name="user_permissions" rel="ManyToManyRel"></field>
+    </object>
+</django-objects>

new file tests/regressiontests/admin_actions/models.py

@@ +1 @@
+from django.contrib import admin
+from django.db import models
+
+class Animal(models.Model):
+    name = models.CharField(max_length=128)
+
+    class Meta:
+        abstract = True
+
+class Cat(Animal):
+    """Used for model overrides."""
+    pass
+
+class Dog(Animal):
+    """Used for app overrides."""
+    pass
+
+admin.site.register(Cat)
+admin.site.register(Dog)

new file tests/regressiontests/admin_actions/tests.py

@@ +1 @@
+from django.test import TestCase
+
+from models import Cat, Dog
+
+class TestInline(TestCase):
+    fixtures = ['admin-views-users.xml']
+
+    def setUp(self):
+        self.base_url = '/test_admin/admin/admin_actions'
+
+        # this is needed for the actions form to show up (with the 'delete' action)
+        Dog(name='Jacky').save()
+        Cat(name='Felix').save()
+
+        self.app_element = '<p class="app-element"></p>'
+        self.model_element = '<p class="model-element"></p>'
+
+        result = self.client.login(username='super', password='secret')
+        self.failUnlessEqual(result, True)
+
+    def tearDown(self):
+        self.client.logout()
+
+    def test_app_can_override(self):
+        """
+        Test that the actions.html template can be overriden by an app.
+        """
+        changelist_url = '%s/dog/' % self.base_url
+        response = self.client.get(changelist_url)
+
+        self.assertContains(response, self.app_element)
+
+    def test_model_can_override(self):
+        """
+        Test that the actions.html template can be overriden by a model.
+        """
+        changelist_url = '%s/cat/' % self.base_url
+        response = self.client.get(changelist_url)
+
+        self.assertContains(response, self.model_element)

new file tests/templates/admin/admin_actions/actions.html

@@ +1 @@
+{% include "admin/actions.html" %}
+
+<p class="app-element"></p>

new file tests/templates/admin/admin_actions/cat/actions.html

@@ +1 @@
+{% include "admin/actions.html" %}
+
+<p class="model-element"></p>