Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add full text search for the exercises as well, use websearch syntax

Roland Geider8b0e3870a377
diff --git a/wger/exercises/api/views.py b/wger/exercises/api/views.py
index 322fca10b..3ed69fe64 100644
--- a/wger/exercises/api/views.py
+++ b/wger/exercises/api/views.py
@@ -19,6 +19,7 @@ from uuid import UUID
# Django
from django.conf import settings
+from django.contrib.postgres.search import SearchQuery, SearchRank, SearchVector
from django.db.models import Q
from django.utils.decorators import method_decorator
from django.utils.translation import gettext as _
@@ -87,9 +88,9 @@ from wger.utils.constants import (
HTML_STYLES_WHITELIST,
HTML_TAG_WHITELIST,
)
+from wger.utils.db import is_postgres_db
from wger.utils.language import load_language
-
logger = logging.getLogger(__name__)
@@ -101,7 +102,7 @@ class ExerciseBaseViewSet(ModelViewSet):
"""
queryset = ExerciseBase.translations.all()
serializer_class = ExerciseBaseSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = (
'category',
@@ -149,7 +150,7 @@ class ExerciseTranslationViewSet(ModelViewSet):
API endpoint for editing or adding exercise translation objects.
"""
queryset = Exercise.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
serializer_class = ExerciseTranslationSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -218,7 +219,7 @@ class ExerciseViewSet(viewsets.ReadOnlyModelViewSet):
This is only kept for backwards compatibility and will be removed in the future
"""
queryset = Exercise.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
serializer_class = ExerciseSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -307,25 +308,25 @@ class ExerciseViewSet(viewsets.ReadOnlyModelViewSet):
# yapf: disable
responses={
200:
- inline_serializer(
- name='ExerciseSearchResponse',
- fields={
- 'value':
- CharField(),
- 'data':
- inline_serializer(
- name='ExerciseSearchItemResponse',
- fields={
- 'id': IntegerField(),
- 'base_id': IntegerField(),
- 'name': CharField(),
- 'category': CharField(),
- 'image': CharField(),
- 'image_thumbnail': CharField()
- }
- )
- }
- )
+ inline_serializer(
+ name='ExerciseSearchResponse',
+ fields={
+ 'value':
+ CharField(),
+ 'data':
+ inline_serializer(
+ name='ExerciseSearchItemResponse',
+ fields={
+ 'id': IntegerField(),
+ 'base_id': IntegerField(),
+ 'name': CharField(),
+ 'category': CharField(),
+ 'image': CharField(),
+ 'image_thumbnail': CharField()
+ }
+ )
+ }
+ )
}
# yapf: enable
)
@@ -345,13 +346,21 @@ def search(request):
return Response(response)
languages = [load_language(l) for l in language_codes.split(',')]
- translations = Exercise.objects \
- .filter(Q(name__icontains=q) | Q(alias__alias__icontains=q)) \
- .filter(language__in=languages) \
- .order_by('exercise_base__category__name', 'name') \
- .distinct()
+ query = Exercise.objects.filter(language__in=languages).only('name')
+
+ # Postgres uses a full-text search
+ if is_postgres_db():
+ vector = SearchVector('search_column')
+ search_query = SearchQuery(q, search_type="websearch")
+ query = query.annotate(rank=SearchRank(vector, search_query)) \
+ .filter(search_column=search_query) \
+ .order_by('-rank', 'name')
+ else:
+ query = query.filter(Q(name__icontains=q) | Q(alias__alias__icontains=q))
+
+ print(query.query)
- for translation in translations:
+ for translation in query:
image = None
thumbnail = None
if translation.main_image:
@@ -439,7 +448,7 @@ class EquipmentViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Equipment.objects.all()
serializer_class = EquipmentSerializer
ordering_fields = '__all__'
- filterset_fields = ('name', )
+ filterset_fields = ('name',)
@method_decorator(cache_page(settings.WGER_SETTINGS['EXERCISE_CACHE_TTL']))
def dispatch(self, request, *args, **kwargs):
@@ -457,7 +466,7 @@ class DeletionLogViewSet(viewsets.ReadOnlyModelViewSet):
queryset = DeletionLog.objects.all()
serializer_class = DeletionLogSerializer
ordering_fields = '__all__'
- filterset_fields = ('model_type', )
+ filterset_fields = ('model_type',)
class ExerciseCategoryViewSet(viewsets.ReadOnlyModelViewSet):
@@ -467,7 +476,7 @@ class ExerciseCategoryViewSet(viewsets.ReadOnlyModelViewSet):
queryset = ExerciseCategory.objects.all()
serializer_class = ExerciseCategorySerializer
ordering_fields = '__all__'
- filterset_fields = ('name', )
+ filterset_fields = ('name',)
@method_decorator(cache_page(settings.WGER_SETTINGS['EXERCISE_CACHE_TTL']))
def dispatch(self, request, *args, **kwargs):
@@ -481,7 +490,7 @@ class ExerciseImageViewSet(ModelViewSet):
queryset = ExerciseImage.objects.all()
serializer_class = ExerciseImageSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = (
'is_main',
@@ -543,7 +552,7 @@ class ExerciseVideoViewSet(ModelViewSet):
"""
queryset = ExerciseVideo.objects.all()
serializer_class = ExerciseVideoSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = (
'is_main',
@@ -580,7 +589,7 @@ class ExerciseCommentViewSet(ModelViewSet):
API endpoint for exercise comment objects
"""
serializer_class = ExerciseCommentSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = ('comment', 'exercise')
@@ -622,7 +631,7 @@ class ExerciseAliasViewSet(ModelViewSet):
"""
serializer_class = ExerciseAliasSerializer
queryset = Alias.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = ('alias', 'exercise')
@@ -655,7 +664,7 @@ class ExerciseVariationViewSet(ModelViewSet):
"""
serializer_class = ExerciseVariationSerializer
queryset = Variation.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
class MuscleViewSet(viewsets.ReadOnlyModelViewSet):
diff --git a/wger/exercises/migrations/0029_full_text_search.py b/wger/exercises/migrations/0029_full_text_search.py
new file mode 100644
index 000000000..174fbf422
--- /dev/null
+++ b/wger/exercises/migrations/0029_full_text_search.py
@@ -0,0 +1,99 @@
+# Generated by Django 4.2.6 on 2024-01-18 16:55
+
+import django.contrib.postgres.search
+from django.db import migrations, models
+
+
+def forwards(apps, schema_editor):
+ if not schema_editor.connection.vendor.startswith('postgres'):
+ return
+
+ schema_editor.execute('''
+ CREATE OR REPLACE FUNCTION update_exercise_fulltext_index() RETURNS trigger AS $$
+ DECLARE
+ aliases TEXT;
+ known_langs TEXT[];
+ BEGIN
+ SELECT ARRAY(SELECT cfgname FROM pg_ts_config) INTO known_langs;
+
+ IF NEW.language_id IS NOT NULL THEN
+ SELECT lower(full_name_en)
+ INTO NEW.index_language
+ FROM core_language
+ WHERE id = NEW.language_id;
+
+ -- If the language is not known, just use English
+ IF NEW.index_language IS NULL OR NEW.index_language NOT IN (SELECT unnest(known_langs)) THEN
+ NEW.index_language = 'english';
+ END IF;
+ ELSE
+ -- If language_id is NULL, just set to English
+ NEW.index_language = 'english';
+ END IF;
+
+ SELECT COALESCE(string_agg(a.alias, ' '), '')
+ INTO aliases
+ FROM exercises_exercise AS t
+ LEFT JOIN exercises_alias AS a
+ ON t.id = a.exercise_id
+ WHERE a.exercise_id = NEW.id;
+
+ NEW.search_column :=
+ setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.name, '')), 'A') ||
+ setweight(to_tsvector(NEW.index_language::regconfig, coalesce(aliases, '')), 'A') ||
+ setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.description, '')), 'D');
+
+ RETURN NEW;
+ END
+ $$ LANGUAGE plpgsql;
+
+ -- Create the trigger
+ CREATE OR REPLACE TRIGGER exercise_search_column_trigger
+ BEFORE INSERT OR UPDATE
+ ON exercises_exercise
+ FOR EACH ROW EXECUTE FUNCTION
+ update_exercise_fulltext_index();
+
+ -- Force an update of the search index
+ UPDATE exercises_exercise SET name = name WHERE true;
+ ''')
+
+
+def backwards(apps, schema_editor):
+ if not schema_editor.connection.vendor.startswith('postgres'):
+ return
+
+ schema_editor.execute('''
+ DROP TRIGGER IF EXISTS exercise_search_column_trigger ON exercises_exercise;
+ DROP FUNCTION IF EXISTS update_exercise_fulltext_index();
+ ''')
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ('exercises', '0028_add_uuid_alias_and_comments'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='exercise',
+ name='index_language',
+ field=models.CharField(default='english', editable=False, max_length=30),
+ ),
+ migrations.AddField(
+ model_name='exercise',
+ name='search_column',
+ field=django.contrib.postgres.search.SearchVectorField(editable=False, null=True),
+ ),
+ migrations.AddField(
+ model_name='historicalexercise',
+ name='index_language',
+ field=models.CharField(default='english', editable=False, max_length=30),
+ ),
+ migrations.AddField(
+ model_name='historicalexercise',
+ name='search_column',
+ field=django.contrib.postgres.search.SearchVectorField(editable=False, null=True),
+ ),
+ migrations.RunPython(forwards, backwards)
+ ]
diff --git a/wger/exercises/models/exercise.py b/wger/exercises/models/exercise.py
index 0dbee8375..d769d9534 100644
--- a/wger/exercises/models/exercise.py
+++ b/wger/exercises/models/exercise.py
@@ -18,6 +18,7 @@
import uuid
# Django
+from django.contrib.postgres.search import SearchVectorField
from django.core.validators import MinLengthValidator
from django.db import models
from django.urls import reverse
@@ -95,6 +96,19 @@ class Exercise(AbstractLicenseModel, AbstractHistoryMixin, models.Model):
)
""" Refers to the base exercise with non translated information """
+ search_column = SearchVectorField(
+ null=True,
+ editable=False,
+ )
+ """Column used for full text search"""
+
+ index_language = models.CharField(
+ default='english',
+ editable=False,
+ max_length=30,
+ )
+ """The language used for the full text search"""
+
history = HistoricalRecords()
"""Edit history"""
diff --git a/wger/exercises/tests/test_deletion_log.py b/wger/exercises/tests/test_deletion_log.py
index 0dd555ede..98f24dfb3 100644
--- a/wger/exercises/tests/test_deletion_log.py
+++ b/wger/exercises/tests/test_deletion_log.py
@@ -40,7 +40,8 @@ class DeletionLogTestCase(WgerTestCase):
# Base is deleted
count_base_logs = DeletionLog.objects.filter(
- model_type=DeletionLog.MODEL_BASE, uuid=base.uuid
+ model_type=DeletionLog.MODEL_BASE,
+ uuid=base.uuid,
).count()
log = DeletionLog.objects.get(pk=1)
diff --git a/wger/nutrition/api/views.py b/wger/nutrition/api/views.py
index 597b0bdfe..a84471f22 100644
--- a/wger/nutrition/api/views.py
+++ b/wger/nutrition/api/views.py
@@ -20,6 +20,7 @@ import logging
# Django
from django.conf import settings
+from django.contrib.postgres.search import SearchVector, SearchQuery, SearchRank
from django.utils.decorators import method_decorator
from django.views.decorators.cache import cache_page
@@ -223,7 +224,11 @@ def search(request):
# Postgres uses a full-text search
if is_postgres_db():
- query = query.filter(search_column=term)
+ vector = SearchVector('search_column')
+ search_query = SearchQuery(term, search_type="websearch")
+ query = query.annotate(rank=SearchRank(vector, search_query)) \
+ .filter(search_column=search_query) \
+ .order_by('-rank', 'name')
else:
query = query.filter(name__icontains=term)
diff --git a/wger/nutrition/migrations/0020_full_text_search.py b/wger/nutrition/migrations/0020_full_text_search.py
index 7e95c4467..c377e3fb4 100644
--- a/wger/nutrition/migrations/0020_full_text_search.py
+++ b/wger/nutrition/migrations/0020_full_text_search.py
@@ -10,46 +10,46 @@ def forwards(apps, schema_editor):
return
schema_editor.execute('''
- CREATE OR REPLACE FUNCTION update_ingredient_index() RETURNS trigger AS $$
- DECLARE
- known_values TEXT[];
- BEGIN
- SELECT ARRAY(SELECT cfgname FROM pg_ts_config) INTO known_values;
-
- -- Map the ingredient language to the list of known languages
- IF NEW.language_id IS NOT NULL THEN
+ CREATE OR REPLACE FUNCTION update_ingredient_index() RETURNS trigger AS $$
+ DECLARE
+ known_langs TEXT[];
+ BEGIN
+ SELECT ARRAY(SELECT cfgname FROM pg_ts_config) INTO known_langs;
+
+ -- Map the ingredient language to the list of known languages
+ IF NEW.language_id IS NOT NULL THEN
SELECT lower(full_name_en) INTO NEW.index_language
- FROM core_language
- WHERE id = NEW.language_id;
-
- -- If the language is not known values, just use English
- IF NEW.index_language IS NULL OR NEW.index_language NOT IN (SELECT unnest(known_values)) THEN
- NEW.index_language = 'english';
- END IF;
- ELSE
- -- If language_id is NULL, just set to English
+ FROM core_language
+ WHERE id = NEW.language_id;
+
+ -- If the language is not known values, just use English
+ IF NEW.index_language IS NULL OR NEW.index_language NOT IN (SELECT unnest(known_langs)) THEN
NEW.index_language = 'english';
END IF;
-
- NEW.search_column :=
- setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.name,'')), 'A') ||
- setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.brand,'')), 'B')||
- setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.common_name,'')), 'C');
-
- RETURN NEW;
- END
- $$ LANGUAGE plpgsql;
-
- -- Create the trigger
- CREATE OR REPLACE TRIGGER ingredient_search_column_trigger
- BEFORE INSERT OR UPDATE
- ON nutrition_ingredient
- FOR EACH ROW EXECUTE FUNCTION
- update_ingredient_index();
-
- -- Force an update of the search index
- UPDATE nutrition_ingredient SET name = name WHERE true;
- ''')
+ ELSE
+ -- If language_id is NULL, just set to English
+ NEW.index_language = 'english';
+ END IF;
+
+ NEW.search_column :=
+ setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.name,'')), 'A') ||
+ setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.brand,'')), 'B') ||
+ setweight(to_tsvector(NEW.index_language::regconfig, coalesce(new.common_name,'')), 'C');
+
+ RETURN NEW;
+ END
+ $$ LANGUAGE plpgsql;
+
+ -- Create the trigger
+ CREATE OR REPLACE TRIGGER ingredient_search_column_trigger
+ BEFORE INSERT OR UPDATE
+ ON nutrition_ingredient
+ FOR EACH ROW EXECUTE FUNCTION
+ update_ingredient_index();
+
+ -- Force an update of the search index
+ UPDATE nutrition_ingredient SET name = name WHERE true;
+ ''')
def backwards(apps, schema_editor):