brotherton-erpnext/erpnext/templates/pages/product_search.py

# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors
# License: GNU General Public License v3. See license.txt

import frappe
from frappe.utils import cint, cstr, nowdate

from erpnext.setup.doctype.item_group.item_group import get_item_for_list_in_html
from erpnext.e_commerce.shopping_cart.product_info import set_product_info_for_website

from redisearch import AutoCompleter, Client, Query
from erpnext.e_commerce.website_item_indexing import (
	is_search_module_loaded,
	WEBSITE_ITEM_INDEX,
	WEBSITE_ITEM_NAME_AUTOCOMPLETE,
	WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE,
	make_key
)

no_cache = 1


def get_context(context):
	context.show_search = True

@frappe.whitelist(allow_guest=True)
def get_product_list(search=None, start=0, limit=12):
	data = get_product_data(search, start, limit)

	for item in data:
		set_product_info_for_website(item)

	return [get_item_for_list_in_html(r) for r in data]

def get_product_data(search=None, start=0, limit=12):
	# limit = 12 because we show 12 items in the grid view
	# base query
	query = """
		Select
			web_item_name, item_name, item_code, brand, route,
			website_image, thumbnail, item_group,
			description, web_long_description as website_description,
			website_warehouse, ranking
		from `tabWebsite Item`
		where published = 1
		"""

	# search term condition
	if search:
		query += """ and (item_name like %(search)s
				or web_item_name like %(search)s
				or brand like %(search)s
				or web_long_description like %(search)s)"""
		search = "%" + cstr(search) + "%"

	# order by
	query += """ order by ranking asc, modified desc limit %s, %s""" % (cint(start), cint(limit))

	return frappe.db.sql(query, {
		"search": search
	}, as_dict=1)

@frappe.whitelist(allow_guest=True)
def search(query, limit=10, fuzzy_search=True):
	search_results = {"from_redisearch": True, "results": []}

	if not is_search_module_loaded():
		# Redisearch module not loaded
		search_results["from_redisearch"] = False
		search_results["results"] = get_product_data(query, 0, limit)
		return search_results

	if not query:
		return search_results

	red = frappe.cache()
	query = clean_up_query(query)

	ac = AutoCompleter(make_key(WEBSITE_ITEM_NAME_AUTOCOMPLETE), conn=red)
	client = Client(make_key(WEBSITE_ITEM_INDEX), conn=red)
	suggestions = ac.get_suggestions(
		query,
		num=limit,
		fuzzy= fuzzy_search and len(query) > 3 # Fuzzy on length < 3 can be real slow
	)

	# Build a query
	query_string = query

	for s in suggestions:
		query_string += f"|('{clean_up_query(s.string)}')"

	q = Query(query_string)

	print(f"Executing query: {q.query_string()}")

	results = client.search(q)
	search_results['results'] = list(map(convert_to_dict, results.docs))

	# FOR DEBUGGING
	print("SEARCH RESULTS ------------------\n ", search_results)

	return search_results

def clean_up_query(query):
	return ''.join(c for c in query if c.isalnum() or c.isspace())

def convert_to_dict(redis_search_doc):
	return redis_search_doc.__dict__

@frappe.whitelist(allow_guest=True)
def get_category_suggestions(query):
	search_results = {"results": []}

	if not is_search_module_loaded():
		# Redisearch module not loaded, query db
		categories = frappe.db.get_all(
			"Item Group",
			filters={
				"name": ["like", "%{0}%".format(query)],
				"show_in_website": 1
			},
			fields=["name", "route"]
		)
		search_results['results'] = categories
		return search_results

	if not query:
		return search_results

	ac = AutoCompleter(make_key(WEBSITE_ITEM_CATEGORY_AUTOCOMPLETE), conn=frappe.cache())
	suggestions = ac.get_suggestions(query, num=10)

	search_results['results'] = [s.string for s in suggestions]

	return search_results