Add advanced search options to user settings (#4012)

Author: flodolo

pontoon/base/migrations/0107_add_search_settings_to_userprofile.py

@@ -0,0 +1,37 @@
+# Generated by Django 4.2.28 on 2026-03-04 07:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("base", "0106_create_project_managers_group"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="userprofile",
+            name="search_exclude_source_strings",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="search_identifiers",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="search_match_case",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="search_match_whole_word",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="userprofile",
+            name="search_rejected_translations",
+            field=models.BooleanField(default=False),
+        ),
+    ]

pontoon/base/models/user_profile.py

@@ -111,6 +111,13 @@ class EmailFrequencies(models.TextChoices):
     quality_checks = models.BooleanField(default=True)
     force_suggestions = models.BooleanField(default=False)
 
+    # Search settings
+    search_exclude_source_strings = models.BooleanField(default=False)
+    search_identifiers = models.BooleanField(default=False)
+    search_match_case = models.BooleanField(default=False)
+    search_match_whole_word = models.BooleanField(default=False)
+    search_rejected_translations = models.BooleanField(default=False)
+
     # Used to redirect a user to a custom team page.
     custom_homepage = models.CharField(max_length=20, blank=True, null=True)
 

pontoon/base/views.py

@@ -44,6 +44,7 @@
     TranslatedResource,
     Translation,
     TranslationMemoryEntry,
+    UserProfile,
 )
 from pontoon.base.templatetags.helpers import provider_login_url
 from pontoon.checks.libraries import run_checks
@@ -290,6 +291,18 @@ def entities(request):
         k: form.cleaned_data[k] for k in restrict_to_keys if k in form.cleaned_data
     }
 
+    # If search option params are not specified in the URL, read the default
+    # value from the model field (avoid specifying the default in two places).
+    for name in (
+        "search_identifiers",
+        "search_exclude_source_strings",
+        "search_rejected_translations",
+        "search_match_case",
+        "search_match_whole_word",
+    ):
+        if name not in request.POST:
+            form_data[name] = UserProfile._meta.get_field(name).get_default()
+
     try:
         entities = Entity.for_project_locale(request.user, project, locale, **form_data)
     except ValueError as error:
@@ -979,6 +992,11 @@ def user_data(request):
             "settings": {
                 "quality_checks": user.profile.quality_checks,
                 "force_suggestions": user.profile.force_suggestions,
+                "search_exclude_source_strings": user.profile.search_exclude_source_strings,
+                "search_identifiers": user.profile.search_identifiers,
+                "search_match_case": user.profile.search_match_case,
+                "search_match_whole_word": user.profile.search_match_whole_word,
+                "search_rejected_translations": user.profile.search_rejected_translations,
             },
             "tour_status": user.profile.tour_status,
             "has_dismissed_addon_promotion": user.profile.has_dismissed_addon_promotion,

pontoon/contributors/templates/contributors/settings.html

@@ -358,6 +358,56 @@ <h3>Editor</h3>
         </div>
       </section>
 
+      <section id="default-search-options">
+        <h3>Default search options</h3>
+        <div class="check-list">
+          {{
+            Checkbox.checkbox(
+            'Match case',
+            class='search-match-case',
+            attribute='search_match_case',
+            is_enabled=user.profile.search_match_case,
+            title='Match case when searching')
+          }}
+
+          {{
+            Checkbox.checkbox(
+            'Match whole word',
+            class='search-match-whole-word',
+            attribute='search_match_whole_word',
+            is_enabled=user.profile.search_match_whole_word,
+            title='Match whole word when searching')
+          }}
+
+          {{
+            Checkbox.checkbox(
+            'Search in string identifiers',
+            class='search-identifiers',
+            attribute='search_identifiers',
+            is_enabled=user.profile.search_identifiers,
+            title='Include string identifiers when searching')
+          }}
+
+          {{
+            Checkbox.checkbox(
+            'Include rejected translations',
+            class='search-rejected-translations',
+            attribute='search_rejected_translations',
+            is_enabled=user.profile.search_rejected_translations,
+            title='Include rejected translations when searching')
+          }}
+
+          {{
+            Checkbox.checkbox(
+            'Exclude source strings',
+            class='search-exclude-source-strings',
+            attribute='search_exclude_source_strings',
+            is_enabled=user.profile.search_exclude_source_strings,
+            title='Exclude source strings when searching')
+          }}
+        </div>
+      </section>
+
       <section>
         <h3>Default locales</h3>
         <div id="locale-settings" class="clearfix">

pontoon/contributors/views.py

@@ -263,6 +263,12 @@ def toggle_user_profile_attribute(request):
         # Editor settings
         "quality_checks",
         "force_suggestions",
+        # Search settings
+        "search_exclude_source_strings",
+        "search_identifiers",
+        "search_match_case",
+        "search_match_whole_word",
+        "search_rejected_translations",
         # In-app notifications
         "new_string_notifications",
         "project_deadline_notifications",

pontoon/search/views.py

@@ -54,13 +54,20 @@ def create_api_url(
     return f"{SITE_URL}/api/v2/search/translations/?{urlencode(query_params)}"
 
 
+def get_search_option(request, name):
+    """Return a search option from the URL, falling back to the user's profile setting."""
+    if name in request.GET:
+        return parse_bool(request.GET.get(name))
+    return request.user.is_authenticated and getattr(request.user.profile, name)
+
+
 def search(request):
     """Render the search page with filters for searching entities."""
     locale_code = request.GET.get("locale")
     project_slug = request.GET.get("project")
-    search_identifiers = parse_bool(request.GET.get("search_identifiers"))
-    search_match_case = parse_bool(request.GET.get("search_match_case"))
-    search_match_whole_word = parse_bool(request.GET.get("search_match_whole_word"))
+    search_identifiers = get_search_option(request, "search_identifiers")
+    search_match_case = get_search_option(request, "search_match_case")
+    search_match_whole_word = get_search_option(request, "search_match_whole_word")
 
     projects = list(
         Project.objects.visible()

translate/public/locale/en-US/translate.ftl

@@ -687,6 +687,9 @@ search-SearchPanel--heading = SEARCH OPTIONS
 search-SearchPanel--apply-search-options = APPLY SEARCH OPTIONS
     .title = Apply Selected Search Options
 
+search-SearchPanel--restore-default-options = Restore default options
+search-SearchPanel--change-default-search-settings = Change default search settings
+
 ## Time Range Filter
 ## Time Range filter title, input fields and chart.
 

translate/src/api/entity.ts

@@ -1,4 +1,5 @@
 import { Location } from '~/context/Location';
+import { SEARCH_OPTION_KEYS } from '~/modules/search/constants';
 
 import { GET, POST } from './utils/base';
 import { getCSRFToken } from './utils/csrfToken';
@@ -124,14 +125,17 @@ function buildFetchPayload(
   if (entity) {
     payload.append('entity', String(entity));
   }
+  // Explicit values (true or false) are sent as-is; undefined (not provided in
+  // the URL) are not sent so the backend can apply the default.
+  for (const key of SEARCH_OPTION_KEYS) {
+    const value = location[key];
+    if (value !== undefined) {
+      payload.append(key, String(value));
+    }
+  }
   for (const key of [
     'search',
     'status',
-    'search_identifiers',
-    'search_exclude_source_strings',
-    'search_rejected_translations',
-    'search_match_case',
-    'search_match_whole_word',
     'extra',
     'tag',
     'author',

translate/src/api/user.ts

@@ -39,7 +39,15 @@ export type ApiUserData = {
   contributor_for_locales?: string[];
   translator_for_projects?: Record<string, boolean>;
   pm_for_projects?: string[];
-  settings?: { quality_checks: boolean; force_suggestions: boolean };
+  settings?: {
+    quality_checks: boolean;
+    force_suggestions: boolean;
+    search_exclude_source_strings: boolean;
+    search_identifiers: boolean;
+    search_match_case: boolean;
+    search_match_whole_word: boolean;
+    search_rejected_translations: boolean;
+  };
   tour_status?: number;
   has_dismissed_addon_promotion?: boolean;
   login_url?: string;

translate/src/context/Location.tsx

@@ -6,6 +6,8 @@ import React, {
   useState,
 } from 'react';
 
+import { SEARCH_OPTION_KEYS } from '~/modules/search/constants';
+
 export type Location = {
   push(location: string | Partial<Location>): void;
   replace(location: string | Partial<Location>): void;
@@ -20,11 +22,12 @@ export type Location = {
   search: string | null;
   status: string | null;
   extra: string | null;
-  search_identifiers: boolean;
-  search_exclude_source_strings: boolean;
-  search_rejected_translations: boolean;
-  search_match_case: boolean;
-  search_match_whole_word: boolean;
+  /** undefined = not provided in the URL, use default or profile setting instead */
+  search_identifiers: boolean | undefined;
+  search_exclude_source_strings: boolean | undefined;
+  search_rejected_translations: boolean | undefined;
+  search_match_case: boolean | undefined;
+  search_match_whole_word: boolean | undefined;
   tag: string | null;
   author: string | null;
   time: string | null;
@@ -38,11 +41,11 @@ const emptyParams = {
   search: null,
   status: null,
   extra: null,
-  search_identifiers: false,
-  search_exclude_source_strings: false,
-  search_rejected_translations: false,
-  search_match_case: false,
-  search_match_whole_word: false,
+  search_identifiers: undefined,
+  search_exclude_source_strings: undefined,
+  search_rejected_translations: undefined,
+  search_match_case: undefined,
+  search_match_whole_word: undefined,
   tag: null,
   author: null,
   time: null,
@@ -78,6 +81,14 @@ export function LocationProvider({
   return <Location.Provider value={state}>{children}</Location.Provider>;
 }
 
+function getSearchParam(
+  params: URLSearchParams,
+  key: string,
+): boolean | undefined {
+  const val = params.get(key);
+  return val !== null ? val !== 'false' : undefined;
+}
+
 function parse(
   history: History.History,
   { pathname, search }: History.Location,
@@ -107,15 +118,20 @@ function parse(
         search: params.get('search'),
         status: params.get('status'),
         extra: params.get('extra'),
-        search_identifiers: params.has('search_identifiers'),
-        search_exclude_source_strings: params.has(
+        search_identifiers: getSearchParam(params, 'search_identifiers'),
+        search_exclude_source_strings: getSearchParam(
+          params,
           'search_exclude_source_strings',
         ),
-        search_rejected_translations: params.has(
+        search_rejected_translations: getSearchParam(
+          params,
           'search_rejected_translations',
         ),
-        search_match_case: params.has('search_match_case'),
-        search_match_whole_word: params.has('search_match_whole_word'),
+        search_match_case: getSearchParam(params, 'search_match_case'),
+        search_match_whole_word: getSearchParam(
+          params,
+          'search_match_whole_word',
+        ),
         tag: params.get('tag'),
         author: params.get('author'),
         time: params.get('time'),
@@ -143,15 +159,17 @@ function stringify(prev: Location, next: string | Partial<Location>) {
   } else if (prev.list && !('list' in next)) {
     params.set('list', prev.list.join(','));
   }
+  // Encode explicit search option values (omit undefined).
+  for (const key of SEARCH_OPTION_KEYS) {
+    const value = key in next ? next[key] : prev[key];
+    if (value !== undefined) {
+      params.set(key, String(value));
+    }
+  }
   for (const key of [
     'search',
     'status',
     'extra',
-    'search_identifiers',
-    'search_exclude_source_strings',
-    'search_rejected_translations',
-    'search_match_case',
-    'search_match_whole_word',
     'tag',
     'author',
     'time',