Made a bunch of improvements to admin actions. Be warned: this includes one... (bb15cee5) · Commits · Dom Sekotill / django

django/contrib/admin/actions.py

0 → 100644

+81 −0

Original line number	Diff line number	Diff line
		"""
		Built-in, globally-available admin actions.
		"""

		from django import template
		from django.core.exceptions import PermissionDenied
		from django.contrib.admin import helpers
		from django.contrib.admin.util import get_deleted_objects, model_ngettext
		from django.shortcuts import render_to_response
		from django.utils.encoding import force_unicode
		from django.utils.html import escape
		from django.utils.safestring import mark_safe
		from django.utils.text import capfirst
		from django.utils.translation import ugettext_lazy, ugettext as _

		def delete_selected(modeladmin, request, queryset):
		"""
		Default action which deletes the selected objects.

		This action first displays a confirmation page whichs shows all the
		deleteable objects, or, if the user has no permission one of the related
		childs (foreignkeys), a "permission denied" message.

		Next, it delets all selected objects and redirects back to the change list.
		"""
		opts = modeladmin.model._meta
		app_label = opts.app_label

		# Check that the user has delete permission for the actual model
		if not modeladmin.has_delete_permission(request):
		raise PermissionDenied

		# Populate deletable_objects, a data structure of all related objects that
		# will also be deleted.

		# deletable_objects must be a list if we want to use '\|unordered_list' in the template
		deletable_objects = []
		perms_needed = set()
		i = 0
		for obj in queryset:
		deletable_objects.append([mark_safe(u'%s: <a href="%s/">%s</a>' % (escape(force_unicode(capfirst(opts.verbose_name))), obj.pk, escape(obj))), []])
		get_deleted_objects(deletable_objects[i], perms_needed, request.user, obj, opts, 1, modeladmin.admin_site, levels_to_root=2)
		i=i+1

		# The user has already confirmed the deletion.
		# Do the deletion and return a None to display the change list view again.
		if request.POST.get('post'):
		if perms_needed:
		raise PermissionDenied
		n = queryset.count()
		if n:
		for obj in queryset:
		obj_display = force_unicode(obj)
		modeladmin.log_deletion(request, obj, obj_display)
		queryset.delete()
		modeladmin.message_user(request, _("Successfully deleted %(count)d %(items)s.") % {
		"count": n, "items": model_ngettext(modeladmin.opts, n)
		})
		# Return None to display the change list page again.
		return None

		context = {
		"title": _("Are you sure?"),
		"object_name": force_unicode(opts.verbose_name),
		"deletable_objects": deletable_objects,
		'queryset': queryset,
		"perms_lacking": perms_needed,
		"opts": opts,
		"root_path": modeladmin.admin_site.root_path,
		"app_label": app_label,
		'action_checkbox_name': helpers.ACTION_CHECKBOX_NAME,
		}

		# Display the confirmation page
		return render_to_response(modeladmin.delete_confirmation_template or [
		"admin/%s/%s/delete_selected_confirmation.html" % (app_label, opts.object_name.lower()),
		"admin/%s/delete_selected_confirmation.html" % app_label,
		"admin/delete_selected_confirmation.html"
		], context, context_instance=template.RequestContext(request))

		delete_selected.short_description = ugettext_lazy("Delete selected %(verbose_name_plural)s")

django/contrib/admin/options.py

+84 −86

Original line number	Diff line number	Diff line
		@@ -11,6 +11,7 @@ from django.db import models, transaction
		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.utils.datastructures import SortedDict
		from django.utils.functional import update_wrapper
		from django.utils.html import escape
		from django.utils.safestring import mark_safe
		@@ -194,7 +195,7 @@ class ModelAdmin(BaseModelAdmin):
		object_history_template = None

		# Actions
		actions = ['delete_selected']
		actions = []
		action_form = helpers.ActionForm
		actions_on_top = True
		actions_on_bottom = False
		@@ -207,7 +208,7 @@ class ModelAdmin(BaseModelAdmin):
		for inline_class in self.inlines:
		inline_instance = inline_class(self.model, self.admin_site)
		self.inline_instances.append(inline_instance)
		if 'action_checkbox' not in self.list_display:
		if 'action_checkbox' not in self.list_display and self.actions is not None:
		self.list_display = ['action_checkbox'] + list(self.list_display)
		if not self.list_display_links:
		for name in self.list_display:
		@@ -253,7 +254,7 @@ class ModelAdmin(BaseModelAdmin):
		from django.conf import settings

		js = ['js/core.js', 'js/admin/RelatedObjectLookups.js']
		if self.actions:
		if self.actions is not None:
		js.extend(['js/getElementsBySelector.js', 'js/actions.js'])
		if self.prepopulated_fields:
		js.append('js/urlify.js')
		@@ -414,19 +415,46 @@ class ModelAdmin(BaseModelAdmin):
		action_checkbox.short_description = mark_safe('<input type="checkbox" id="action-toggle" />')
		action_checkbox.allow_tags = True

		def get_actions(self, request=None):
		def get_actions(self, request):
		"""
		Return a dictionary mapping the names of all actions for this
		ModelAdmin to a tuple of (callable, name, description) for each action.
		"""
		actions = {}
		for klass in [self.admin_site] + self.__class__.mro()[::-1]:
		for action in getattr(klass, 'actions', []):
		func, name, description = self.get_action(action)
		actions[name] = (func, name, description)
		# If self.actions is explicitally set to None that means that we don't
		# want any actions enabled on this page.
		if self.actions is None:
		return []

		actions = []

		# Gather actions from the admin site first
		for (name, func) in self.admin_site.actions:
		description = getattr(func, 'short_description', name.replace('_', ' '))
		actions.append((func, name, description))

		# Then gather them from the model admin and all parent classes,
		# starting with self and working back up.
		for klass in self.__class__.mro()[::-1]:
		class_actions = getattr(klass, 'actions', [])
		# Avoid trying to iterate over None
		if not class_actions:
		continue
		actions.extend([self.get_action(action) for action in class_actions])

		# get_action might have returned None, so filter any of those out.
		actions = filter(None, actions)

		# Convert the actions into a SortedDict keyed by name
		# and sorted by description.
		actions.sort(lambda a,b: cmp(a[2].lower(), b[2].lower()))
		actions = SortedDict([
		(name, (func, name, desc))
		for func, name, desc in actions
		])

		return actions

		def get_action_choices(self, request=None, default_choices=BLANK_CHOICE_DASH):
		def get_action_choices(self, request, default_choices=BLANK_CHOICE_DASH):
		"""
		Return a list of choices for use in a form object. Each choice is a
		tuple (name, description).
		@@ -443,85 +471,30 @@ class ModelAdmin(BaseModelAdmin):
		or the name of a method on the ModelAdmin. Return is a tuple of
		(callable, name, description).
		"""
		# If the action is a callable, just use it.
		if callable(action):
		func = action
		action = action.__name__
		elif hasattr(self, action):
		func = getattr(self, action)

		# Next, look for a method. Grab it off self.__class__ to get an unbound
		# method instead of a bound one; this ensures that the calling
		# conventions are the same for functions and methods.
		elif hasattr(self.__class__, action):
		func = getattr(self.__class__, action)

		# Finally, look for a named method on the admin site
		else:
		try:
		func = self.admin_site.get_action(action)
		except KeyError:
		return None

		if hasattr(func, 'short_description'):
		description = func.short_description
		else:
		description = capfirst(action.replace('_', ' '))
		return func, action, description

		def delete_selected(self, request, queryset):
		"""
		Default action which deletes the selected objects.

		In the first step, it displays a confirmation page whichs shows all
		the deleteable objects or, if the user has no permission one of the
		related childs (foreignkeys) it displays a "permission denied" message.

		In the second step delete all selected objects and display the change
		list again.
		"""
		opts = self.model._meta
		app_label = opts.app_label

		# Check that the user has delete permission for the actual model
		if not self.has_delete_permission(request):
		raise PermissionDenied

		# Populate deletable_objects, a data structure of all related objects that
		# will also be deleted.

		# deletable_objects must be a list if we want to use '\|unordered_list' in the template
		deletable_objects = []
		perms_needed = set()
		i = 0
		for obj in queryset:
		deletable_objects.append([mark_safe(u'%s: <a href="%s/">%s</a>' % (escape(force_unicode(capfirst(opts.verbose_name))), obj.pk, escape(obj))), []])
		get_deleted_objects(deletable_objects[i], perms_needed, request.user, obj, opts, 1, self.admin_site, levels_to_root=2)
		i=i+1

		# The user has already confirmed the deletion.
		# Do the deletion and return a None to display the change list view again.
		if request.POST.get('post'):
		if perms_needed:
		raise PermissionDenied
		n = queryset.count()
		if n:
		for obj in queryset:
		obj_display = force_unicode(obj)
		self.log_deletion(request, obj, obj_display)
		queryset.delete()
		self.message_user(request, _("Successfully deleted %(count)d %(items)s.") % {
		"count": n, "items": model_ngettext(self.opts, n)
		})
		# Return None to display the change list page again.
		return None

		context = {
		"title": _("Are you sure?"),
		"object_name": force_unicode(opts.verbose_name),
		"deletable_objects": deletable_objects,
		'queryset': queryset,
		"perms_lacking": perms_needed,
		"opts": opts,
		"root_path": self.admin_site.root_path,
		"app_label": app_label,
		'action_checkbox_name': helpers.ACTION_CHECKBOX_NAME,
		}

		# Display the confirmation page
		return render_to_response(self.delete_confirmation_template or [
		"admin/%s/%s/delete_selected_confirmation.html" % (app_label, opts.object_name.lower()),
		"admin/%s/delete_selected_confirmation.html" % app_label,
		"admin/delete_selected_confirmation.html"
		], context, context_instance=template.RequestContext(request))

		delete_selected.short_description = ugettext_lazy("Delete selected %(verbose_name_plural)s")

		def construct_change_message(self, request, form, formsets):
		"""
		Construct a change message from a changed object.
		@@ -678,6 +651,16 @@ class ModelAdmin(BaseModelAdmin):
		data = request.POST.copy()
		data.pop(helpers.ACTION_CHECKBOX_NAME, None)
		data.pop("index", None)

		# Use the action whose button was pushed
		try:
		data.update({'action': data.getlist('action')[action_index]})
		except IndexError:
		# If we didn't get an action from the chosen form that's invalid
		# POST data, so by deleting action it'll fail the validation check
		# below. So no need to do anything here
		pass

		action_form = self.action_form(data, auto_id=None)
		action_form.fields['action'].choices = self.get_action_choices(request)

		@@ -692,7 +675,7 @@ class ModelAdmin(BaseModelAdmin):
		if not selected:
		return None

		response = func(request, queryset.filter(pk__in=selected))
		response = func(self, request, queryset.filter(pk__in=selected))

		# Actions may return an HttpResponse, which will be used as the
		# response from the POST. If not, we'll be a good little HTTP
		@@ -881,8 +864,20 @@ class ModelAdmin(BaseModelAdmin):
		app_label = opts.app_label
		if not self.has_change_permission(request, None):
		raise PermissionDenied

		# Check actions to see if any are available on this changelist
		actions = self.get_actions(request)

		# Remove action checkboxes if there aren't any actions available.
		list_display = list(self.list_display)
		if not actions:
		try:
		cl = ChangeList(request, self.model, self.list_display, self.list_display_links, self.list_filter,
		list_display.remove('action_checkbox')
		except ValueError:
		pass

		try:
		cl = ChangeList(request, self.model, 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
		@@ -897,7 +892,7 @@ class ModelAdmin(BaseModelAdmin):
		# If the request was POSTed, this might be a bulk action or a bulk edit.
		# Try to look up an action first, but if this isn't an action the POST
		# will fall through to the bulk edit check, below.
		if request.method == 'POST':
		if actions and request.method == 'POST':
		response = self.response_action(request, queryset=cl.get_query_set())
		if response:
		return response
		@@ -948,8 +943,11 @@ class ModelAdmin(BaseModelAdmin):
		media = self.media

		# Build the action form and populate it with available actions.
		if actions:
		action_form = self.action_form(auto_id=None)
		action_form.fields['action'].choices = self.get_action_choices(request)
		else:
		action_form = None

		context = {
		'title': cl.title,

django/contrib/admin/sites.py

+34 −6

Original line number	Diff line number	Diff line
		import re
		from django import http, template
		from django.contrib.admin import ModelAdmin
		from django.contrib.admin import actions
		from django.contrib.auth import authenticate, login
		from django.db.models.base import ModelBase
		from django.core.exceptions import ImproperlyConfigured
		@@ -11,6 +12,10 @@ from django.utils.text import capfirst
		from django.utils.translation import ugettext_lazy, ugettext as _
		from django.views.decorators.cache import never_cache
		from django.conf import settings
		try:
		set
		except NameError:
		from sets import Set as set # Python 2.3 fallback

		ERROR_MESSAGE = ugettext_lazy("Please enter a correct username and password. Note that both fields are case-sensitive.")
		LOGIN_FORM_KEY = 'this_is_the_login_form'
		@@ -44,8 +49,8 @@ class AdminSite(object):
		else:
		name += '_'
		self.name = name

		self.actions = []
		self._actions = {'delete_selected': actions.delete_selected}
		self._global_actions = self._actions.copy()

		def register(self, model_or_iterable, admin_class=None, **options):
		"""
		@@ -102,10 +107,33 @@ class AdminSite(object):
		raise NotRegistered('The model %s is not registered' % model.__name__)
		del self._registry[model]

		def add_action(self, action):
		if not callable(action):
		raise TypeError("You can only register callable actions through an admin site")
		self.actions.append(action)
		def add_action(self, action, name=None):
		"""
		Register an action to be available globally.
		"""
		name = name or action.__name__
		self._actions[name] = action
		self._global_actions[name] = action

		def disable_action(self, name):
		"""
		Disable a globally-registered action. Raises KeyError for invalid names.
		"""
		del self._actions[name]

		def get_action(self, name):
		"""
		Explicitally get a registered global action wheather it's enabled or
		not. Raises KeyError for invalid names.
		"""
		return self._global_actions[name]

		def actions(self):
		"""
		Get all the enabled actions as an iterable of (name, func).
		"""
		return self._actions.iteritems()
		actions = property(actions)

		def has_permission(self, request):
		"""

django/contrib/admin/templates/admin/change_list.html

+7 −2

Original line number	Diff line number	Diff line
		@@ -9,6 +9,11 @@
		<script type="text/javascript" src="../../jsi18n/"></script>
		{% endif %}
		{{ media }}
		{% if not actions_on_top and not actions_on_bottom %}
		<style>
		#changelist table thead th:first-child {width: inherit}
		</style>
		{% endif %}
		{% endblock %}

		{% block bodyclass %}change-list{% endblock %}
		@@ -69,9 +74,9 @@
		{% endif %}

		{% block result_list %}
		{% if actions_on_top and cl.full_result_count %}{% admin_actions %}{% endif %}
		{% if action_form and actions_on_top and cl.full_result_count %}{% admin_actions %}{% endif %}
		{% result_list cl %}
		{% if actions_on_bottom and cl.full_result_count %}{% admin_actions %}{% endif %}
		{% if action_form and actions_on_bottom and cl.full_result_count %}{% admin_actions %}{% endif %}
		{% endblock %}
		{% block pagination %}{% pagination cl %}{% endblock %}
		</form>

django/contrib/admin/templates/admin/pagination.html

+1 −1

Original line number	Diff line number	Diff line
		@@ -8,5 +8,5 @@
		{% endif %}
		{{ cl.result_count }} {% ifequal cl.result_count 1 %}{{ cl.opts.verbose_name }}{% else %}{{ cl.opts.verbose_name_plural }}{% endifequal %}
		{% if show_all_url %}  <a href="{{ show_all_url }}" class="showall">{% trans 'Show all' %}</a>{% endif %}
		{% if cl.formset %}<input type="submit" name="_save" class="default" value="Save"/>{% endif %}
		{% if cl.formset and cl.result_count %}<input type="submit" name="_save" class="default" value="Save"/>{% endif %}
		</p>