refactor: filters to gambits

extensions/lock/js/src/common/query/discussions/LockedGambit.ts

@@ -12,4 +12,12 @@ export default class LockedGambit implements IGambit {
       [key]: true,
     };
   }
+
+  filterKey(): string {
+    return 'locked';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:locked`;
+  }
 }

extensions/sticky/js/src/common/query/discussions/StickyGambit.ts

@@ -12,4 +12,12 @@ export default class StickyGambit implements IGambit {
       [key]: true,
     };
   }
+
+  filterKey(): string {
+    return 'sticky';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:sticky`;
+  }
 }

extensions/subscriptions/js/src/common/query/discussions/SubscriptionGambit.ts

@@ -12,4 +12,12 @@ export default class SubscriptionGambit implements IGambit {
       subscription: type,
     };
   }
+
+  filterKey(): string {
+    return 'subscription';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:${value}`;
+  }
 }

extensions/suspend/js/src/common/query/users/SuspendedGambit.ts

@@ -12,4 +12,12 @@ export default class SuspendedGambit implements IGambit {
       [key]: true,
     };
   }
+
+  filterKey(): string {
+    return 'suspended';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:suspended`;
+  }
 }

extensions/tags/js/src/common/query/discussions/TagGambit.ts

@@ -12,4 +12,12 @@ export default class TagGambit implements IGambit {
       [key]: matches[1].split(','),
     };
   }
+
+  filterKey(): string {
+    return 'tag';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}tag:${value}`;
+  }
 }

framework/core/js/src/common/GambitManager.ts

@@ -48,4 +48,25 @@ export default class GambitManager {
 
     return filter;
   }
+
+  public from(type: string, q: string, filter: Record<string, any>): string {
+    const gambits = this.gambits[type] || [];
+
+    if (gambits.length === 0) return q;
+
+    Object.keys(filter).forEach((key) => {
+      for (const gambitClass of gambits) {
+        const gambit = new gambitClass();
+        const negate = key[0] === '-';
+
+        if (negate) key = key.substring(1);
+
+        if (gambit.filterKey() !== key) continue;
+
+        q += ` ${gambit.fromFilter(filter[key], negate)}`;
+      }
+    });
+
+    return q;
+  }
 }

framework/core/js/src/common/query/IGambit.ts

@@ -1,4 +1,6 @@
 export default interface IGambit {
   pattern(): string;
   toFilter(matches: string[], negate: boolean): Record<string, any>;
+  filterKey(): string;
+  fromFilter(value: string, negate: boolean): string;
 }

framework/core/js/src/common/query/discussions/AuthorGambit.ts

@@ -12,4 +12,12 @@ export default class AuthorGambit implements IGambit {
       [key]: matches[1].split(','),
     };
   }
+
+  filterKey(): string {
+    return 'author';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}author:${value}`;
+  }
 }

framework/core/js/src/common/query/discussions/CreatedGambit.ts

@@ -12,4 +12,12 @@ export default class CreatedGambit implements IGambit {
       [key]: matches[1],
     };
   }
+
+  filterKey(): string {
+    return 'created';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}created:${value}`;
+  }
 }

framework/core/js/src/common/query/discussions/HiddenGambit.ts

@@ -12,4 +12,12 @@ export default class HiddenGambit implements IGambit {
       [key]: true,
     };
   }
+
+  filterKey(): string {
+    return 'hidden';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:hidden`;
+  }
 }

framework/core/js/src/common/query/discussions/UnreadGambit.ts

@@ -12,4 +12,12 @@ export default class UnreadGambit implements IGambit {
       [key]: true,
     };
   }
+
+  filterKey(): string {
+    return 'unread';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:unread`;
+  }
 }

framework/core/js/src/common/query/users/EmailGambit.ts

@@ -12,4 +12,12 @@ export default class EmailGambit implements IGambit {
       [key]: matches[1],
     };
   }
+
+  filterKey(): string {
+    return 'email';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}email:${value}`;
+  }
 }

framework/core/js/src/common/query/users/GroupGambit.ts

@@ -12,4 +12,12 @@ export default class GroupGambit implements IGambit {
       [key]: matches[1].split(','),
     };
   }
+
+  filterKey(): string {
+    return 'group';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}group:${value}`;
+  }
 }

framework/core/js/src/forum/components/DiscussionsSearchSource.tsx

@@ -48,10 +48,15 @@ export default class DiscussionsSearchSource implements SearchSource {
       );
     }) as Array<Mithril.Vnode>;
 
+    const filter = app.store.gambits.apply('discussions', { q: query });
+    const q = filter.q || null;
+
+    delete filter.q;
+
     return [
       <li className="Dropdown-header">{app.translator.trans('core.forum.search.discussions_heading')}</li>,
       <li>
-        <LinkButton icon="fas fa-search" href={app.route('index', { q: query })}>
+        <LinkButton icon="fas fa-search" href={app.route('index', { q, filter })}>
           {app.translator.trans('core.forum.search.all_discussions_button', { query })}
         </LinkButton>
       </li>,

framework/core/js/src/forum/states/GlobalSearchState.ts

@@ -36,7 +36,14 @@ export default class GlobalSearchState extends SearchState {
    * @inheritdoc
    */
   getInitialSearch(): string {
-    return this.currPageProvidesSearch() ? this.params().q : '';
+    return this.currPageProvidesSearch() ? this.searchToQuery() : '';
+  }
+
+  private searchToQuery(): string {
+    const q = this.params().q || '';
+    const filter = this.params().filter || {};
+
+    return app.store.gambits.from('users', app.store.gambits.from('discussions', q, filter), filter).trim();
   }
 
   /**
@@ -57,7 +64,7 @@ export default class GlobalSearchState extends SearchState {
    * 'x' is clicked in the search box in the header.
    */
   protected clearInitialSearch() {
-    const { q, ...params } = this.params();
+    const { q, filter, ...params } = this.params();
 
     setRouteWithForcedRefresh(app.route(app.current.get('routeName'), params));
   }
@@ -71,6 +78,9 @@ export default class GlobalSearchState extends SearchState {
     return {
       sort: m.route.param('sort'),
       q: m.route.param('q'),
+      // Objects must be copied, otherwise they are passed by reference.
+      // Which could end up undesirably modifying the mithril route params.
+      filter: Object.assign({}, m.route.param('filter')),
     };
   }
 
@@ -80,8 +90,6 @@ export default class GlobalSearchState extends SearchState {
   params(): SearchParams {
     const params = this.stickyParams();
 
-    params.filter = m.route.param('filter');
-
     return params;
   }