# -*- coding: utf-8 -*-
# This file is part of Shuup.
#
# Copyright (c) 2012-2021, Shuup Commerce Inc. All rights reserved.
#
# This source code is licensed under the OSL-3.0 license found in the
# LICENSE file in the root directory of this source tree.
import six
from django.db.models import Q
from django.utils.translation import ugettext_lazy as _
from shuup.admin.base import AdminModule, MenuEntry, SearchResult
from shuup.admin.menu import PRODUCTS_MENU_CATEGORY
from shuup.admin.shop_provider import get_shop
from shuup.admin.utils.urls import admin_url, derive_model_url, get_edit_and_list_urls, get_model_url
from shuup.admin.views.home import HelpBlockCategory, SimpleHelpBlock
from shuup.core.models import Category
[docs]class CategoryModule(AdminModule):
name = _("Categories")
category = _("Categories")
breadcrumbs_menu_entry = MenuEntry(text=name, url="shuup_admin:category.list", category=PRODUCTS_MENU_CATEGORY)
[docs] def get_urls(self):
return [
admin_url(
r"^categories/(?P<pk>\d+)/copy-visibility/$",
"shuup.admin.modules.categories.views.CategoryCopyVisibilityView",
name="category.copy_visibility",
),
admin_url(
r"^categories/(?P<pk>\d+)/delete/$",
"shuup.admin.modules.categories.views.CategoryDeleteView",
name="category.delete",
),
] + get_edit_and_list_urls(
url_prefix="^categories",
view_template="shuup.admin.modules.categories.views.Category%sView",
name_template="category.%s",
)
[docs] def get_search_results(self, request, query):
minimum_query_length = 3
if len(query) >= minimum_query_length:
shop = get_shop(request)
categories = (
Category.objects.all_except_deleted(shop=shop)
.filter(Q(translations__name__icontains=query) | Q(identifier__icontains=query))
.distinct()
.order_by("tree_id", "lft")
)
for i, category in enumerate(categories[:10]):
relevance = 100 - i
yield SearchResult(
text=six.text_type(category),
url=get_model_url(category),
category=self.category,
relevance=relevance,
)
[docs] def get_help_blocks(self, request, kind):
from shuup.admin.utils.permissions import has_permission
if has_permission(request.user, "category.new"):
yield SimpleHelpBlock(
text=_("Add a product category to organize your products."),
actions=[{"text": _("New category"), "url": get_model_url(Category, "new")}],
icon_url="shuup_admin/img/category.png",
category=HelpBlockCategory.PRODUCTS,
priority=1,
done=Category.objects.filter(shops=request.shop).exists() if kind == "setup" else False,
)
[docs] def get_model_url(self, object, kind, shop=None):
return derive_model_url(Category, "shuup_admin:category", object, kind)