from typing import Any, Dict, Iterable, Union
import six
from django.contrib.auth import get_user_model
from django.db.models import Q
from django.utils.translation import gettext_lazy as _
from shuup.admin.base import AdminModule, MenuEntry, SearchResult
from shuup.admin.menu import SETTINGS_MENU_CATEGORY
from shuup.admin.utils.object_selector import get_object_selector_permission_name
from shuup.admin.utils.urls import admin_url, derive_model_url, get_model_url
from shuup.admin.views.home import HelpBlockCategory, SimpleHelpBlock
User = get_user_model()
[docs]
class UserModule(AdminModule):
name = _("Users")
breadcrumbs_menu_entry = MenuEntry(name, url="shuup_admin:user.list")
[docs]
def get_urls(self):
return [
admin_url(
r"^users/(?P<pk>\d+)/change-password/$",
"shuup.admin.modules.users.views.UserChangePasswordView",
name="user.change-password",
),
admin_url(
r"^users/(?P<pk>\d+)/reset-password/$",
"shuup.admin.modules.users.views.UserResetPasswordView",
name="user.reset-password",
),
admin_url(
r"^users/(?P<pk>\d+)/change-permissions/$",
"shuup.admin.modules.users.views.UserChangePermissionsView",
name="user.change-permissions",
),
admin_url(
r"^users/(?P<pk>\d+)/$",
"shuup.admin.modules.users.views.UserDetailView",
name="user.detail",
),
admin_url(
r"^users/new/$",
"shuup.admin.modules.users.views.UserDetailView",
kwargs={"pk": None},
name="user.new",
),
admin_url(
r"^users/$",
"shuup.admin.modules.users.views.UserListView",
name="user.list",
),
admin_url(
r"^users/(?P<pk>\d+)/login/$",
"shuup.admin.modules.users.views.LoginAsUserView",
name="user.login-as",
),
admin_url(
r"^users/(?P<pk>\d+)/login/staff/$",
"shuup.admin.modules.users.views.LoginAsStaffUserView",
name="user.login-as-staff",
),
admin_url(
r"^contacts/list-settings/",
"shuup.admin.modules.settings.views.ListSettingsView",
name="user.list_settings",
),
]
[docs]
def get_permissions_help_texts(self) -> Dict[str, Union[str, Any]]:
return {
"user.change-password": _("Allow the user to change the passwords of other users."),
"user.reset-password": _("Allow the user send the reset password email."),
"user.change-permissions": _("Allow the user to change the permission groups of other users."),
"user.detail": _("Allow the user to see a user detail."),
"user.new": _("Allow the user to create a new user."),
"user.list": _("Allow the user to list the users."),
"user.login-as": _("Allow the user to impersonate a different user."),
"user.login-as-staff": _("Allow the user to impersonate a staff user."),
"user.list_settings": _("Allow the user to change the user list columns."),
get_object_selector_permission_name(User): _("Allow the user to select users in admin."),
}
[docs]
def get_search_results(self, request, query):
minimum_query_length = 3
if len(query) >= minimum_query_length:
users = User.objects.filter(Q(username__icontains=query) | Q(email=query))
for i, user in enumerate(users[:10]):
relevance = 100 - i
yield SearchResult(
text=six.text_type(user),
url=get_model_url(user),
category=_("Contacts"),
relevance=relevance,
)
[docs]
def get_help_blocks(self, request, kind):
yield SimpleHelpBlock(
text=_("Add some users to help manage your shop"),
actions=[{"text": _("New user"), "url": self.get_model_url(User, "new")}],
priority=3,
category=HelpBlockCategory.CONTACTS,
icon_url="shuup_admin/img/users.png",
done=request.shop.staff_members.exclude(id=request.user.id).exists() if kind == "setup" else False,
required=False,
)
[docs]
def get_model_url(self, object, kind, shop=None):
return derive_model_url(User, "shuup_admin:user", object, kind)