1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 import { ofType, unionize, UnionOf } from "~/common/unionize";
6 import { GroupContentsResource, GroupContentsResourcePrefix } from '~/services/groups-service/groups-service';
7 import { Dispatch } from 'redux';
8 import { arrayPush, change, initialize } from 'redux-form';
9 import { RootState } from '~/store/store';
10 import { initUserProject, treePickerActions } from '~/store/tree-picker/tree-picker-actions';
11 import { ServiceRepository } from '~/services/services';
12 import { FilterBuilder } from "~/services/api/filter-builder";
13 import { ResourceKind } from '~/models/resource';
14 import { GroupClass } from '~/models/group';
15 import { SearchView } from '~/store/search-bar/search-bar-reducer';
16 import { navigateTo, navigateToSearchResults } from '~/store/navigation/navigation-action';
17 import { snackbarActions, SnackbarKind } from '~/store/snackbar/snackbar-actions';
18 import { PropertyValue, SearchBarAdvanceFormData } from '~/models/search-bar';
19 import { debounce } from 'debounce';
20 import * as _ from "lodash";
21 import { getModifiedKeysValues } from "~/common/objects";
22 import { activateSearchBarProject } from "~/store/search-bar/search-bar-tree-actions";
23 import { Session } from "~/models/session";
24 import { searchResultsPanelActions } from "~/store/search-results-panel/search-results-panel-actions";
25 import { ListResults } from "~/services/common-service/common-service";
27 export const searchBarActions = unionize({
28 SET_CURRENT_VIEW: ofType<string>(),
29 OPEN_SEARCH_VIEW: ofType<{}>(),
30 CLOSE_SEARCH_VIEW: ofType<{}>(),
31 SET_SEARCH_RESULTS: ofType<GroupContentsResource[]>(),
32 SET_SEARCH_VALUE: ofType<string>(),
33 SET_SAVED_QUERIES: ofType<SearchBarAdvanceFormData[]>(),
34 SET_RECENT_QUERIES: ofType<string[]>(),
35 UPDATE_SAVED_QUERY: ofType<SearchBarAdvanceFormData[]>(),
36 SET_SELECTED_ITEM: ofType<string>(),
37 MOVE_UP: ofType<{}>(),
38 MOVE_DOWN: ofType<{}>(),
39 SELECT_FIRST_ITEM: ofType<{}>()
42 export type SearchBarActions = UnionOf<typeof searchBarActions>;
44 export const SEARCH_BAR_ADVANCE_FORM_NAME = 'searchBarAdvanceFormName';
46 export const SEARCH_BAR_ADVANCE_FORM_PICKER_ID = 'searchBarAdvanceFormPickerId';
48 export const DEFAULT_SEARCH_DEBOUNCE = 1000;
50 export const goToView = (currentView: string) => searchBarActions.SET_CURRENT_VIEW(currentView);
52 export const saveRecentQuery = (query: string) =>
53 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) =>
54 services.searchService.saveRecentQuery(query);
57 export const loadRecentQueries = () =>
58 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
59 const recentQueries = services.searchService.getRecentQueries();
60 dispatch(searchBarActions.SET_RECENT_QUERIES(recentQueries));
64 export const searchData = (searchValue: string) =>
65 async (dispatch: Dispatch, getState: () => RootState) => {
66 const currentView = getState().searchBar.currentView;
67 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
68 if (searchValue.length > 0) {
69 dispatch<any>(searchGroups(searchValue, 5));
70 if (currentView === SearchView.BASIC) {
71 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
72 dispatch(navigateToSearchResults);
77 export const searchAdvanceData = (data: SearchBarAdvanceFormData) =>
78 async (dispatch: Dispatch) => {
79 dispatch<any>(saveQuery(data));
80 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
81 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
82 dispatch(navigateToSearchResults);
85 export const setSearchValueFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) =>
86 (dispatch: Dispatch, getState: () => RootState) => {
87 const searchValue = getState().searchBar.searchValue;
88 const value = getQueryFromAdvancedData({
92 dispatch(searchBarActions.SET_SEARCH_VALUE(value));
95 export const setAdvancedDataFromSearchValue = (search: string) =>
96 async (dispatch: Dispatch) => {
97 const data = getAdvancedDataFromQuery(search);
98 dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
99 if (data.projectUuid) {
100 await dispatch<any>(activateSearchBarProject(data.projectUuid));
101 dispatch(treePickerActions.ACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID, id: data.projectUuid }));
105 const saveQuery = (data: SearchBarAdvanceFormData) =>
106 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
107 const savedQueries = services.searchService.getSavedQueries();
108 if (data.saveQuery && data.queryName) {
109 const filteredQuery = savedQueries.find(query => query.queryName === data.queryName);
110 data.searchValue = getState().searchBar.searchValue;
112 services.searchService.editSavedQueries(data);
113 dispatch(searchBarActions.UPDATE_SAVED_QUERY(savedQueries));
114 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully updated', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
116 services.searchService.saveQuery(data);
117 dispatch(searchBarActions.SET_SAVED_QUERIES(savedQueries));
118 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully saved', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
123 export const deleteSavedQuery = (id: number) =>
124 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
125 services.searchService.deleteSavedQuery(id);
126 const savedSearchQueries = services.searchService.getSavedQueries();
127 dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
128 return savedSearchQueries || [];
131 export const editSavedQuery = (data: SearchBarAdvanceFormData) =>
132 (dispatch: Dispatch<any>) => {
133 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.ADVANCED));
134 dispatch(searchBarActions.SET_SEARCH_VALUE(getQueryFromAdvancedData(data)));
135 dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
138 export const openSearchView = () =>
139 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
140 const savedSearchQueries = services.searchService.getSavedQueries();
141 dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
142 dispatch(loadRecentQueries());
143 dispatch(searchBarActions.OPEN_SEARCH_VIEW());
144 dispatch(searchBarActions.SELECT_FIRST_ITEM());
147 export const closeSearchView = () =>
148 (dispatch: Dispatch<any>) => {
149 dispatch(searchBarActions.SET_SELECTED_ITEM(''));
150 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
153 export const closeAdvanceView = () =>
154 (dispatch: Dispatch<any>) => {
155 dispatch(searchBarActions.SET_SEARCH_VALUE(''));
156 dispatch(treePickerActions.DEACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID }));
157 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
160 export const navigateToItem = (uuid: string) =>
161 (dispatch: Dispatch<any>) => {
162 dispatch(searchBarActions.SET_SELECTED_ITEM(''));
163 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
164 dispatch(navigateTo(uuid));
167 export const changeData = (searchValue: string) =>
168 (dispatch: Dispatch, getState: () => RootState) => {
169 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
170 const currentView = getState().searchBar.currentView;
171 const searchValuePresent = searchValue.length > 0;
173 if (currentView === SearchView.ADVANCED) {
174 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
175 } else if (searchValuePresent) {
176 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
177 dispatch(searchBarActions.SET_SELECTED_ITEM(searchValue));
178 debounceStartSearch(dispatch);
180 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
181 dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
182 dispatch(searchBarActions.SELECT_FIRST_ITEM());
186 export const submitData = (event: React.FormEvent<HTMLFormElement>) =>
187 (dispatch: Dispatch, getState: () => RootState) => {
188 event.preventDefault();
189 const searchValue = getState().searchBar.searchValue;
190 dispatch<any>(saveRecentQuery(searchValue));
191 dispatch<any>(loadRecentQueries());
192 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
193 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
194 dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
195 dispatch(searchResultsPanelActions.CLEAR());
196 dispatch(navigateToSearchResults);
199 const debounceStartSearch = debounce((dispatch: Dispatch) => dispatch<any>(startSearch()), DEFAULT_SEARCH_DEBOUNCE);
201 const startSearch = () =>
202 (dispatch: Dispatch, getState: () => RootState) => {
203 const searchValue = getState().searchBar.searchValue;
204 dispatch<any>(searchData(searchValue));
207 const searchGroups = (searchValue: string, limit: number) =>
208 async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
209 const currentView = getState().searchBar.currentView;
211 if (searchValue || currentView === SearchView.ADVANCED) {
212 const sq = parseSearchQuery(searchValue);
213 const clusterId = getSearchQueryFirstProp(sq, 'cluster');
214 const sessions = getSearchSessions(clusterId, getState().auth.sessions);
215 const lists: ListResults<GroupContentsResource>[] = await Promise.all(sessions.map(session => {
216 const filters = getFilters('name', searchValue, sq);
217 return services.groupsService.contents('', {
224 const items = lists.reduce((items, list) => items.concat(list.items), [] as GroupContentsResource[]);
225 dispatch(searchBarActions.SET_SEARCH_RESULTS(items));
229 const buildQueryFromKeyMap = (data: any, keyMap: string[][], mode: 'rebuild' | 'reuse') => {
230 let value = data.searchValue;
232 const addRem = (field: string, key: string) => {
235 if (data.hasOwnProperty(key)) {
236 const pattern = v === false
237 ? `${field.replace(':', '\\:\\s*')}\\s*`
238 : `${field.replace(':', '\\:\\s*')}\\:\\s*[\\w|\\#|\\-|\\/]*\\s*`;
239 value = value.replace(new RegExp(pattern), '');
243 const nv = v === true
247 if (mode === 'rebuild') {
248 value = value + ' ' + nv;
250 value = nv + ' ' + value;
255 keyMap.forEach(km => addRem(km[0], km[1]));
260 export const getQueryFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) => {
263 const flatData = (data: SearchBarAdvanceFormData) => {
265 searchValue: data.searchValue,
267 cluster: data.cluster,
268 projectUuid: data.projectUuid,
269 inTrash: data.inTrash,
270 dateFrom: data.dateFrom,
273 (data.properties || []).forEach(p => fo[`prop-${p.key}`] = p.value);
279 ['cluster', 'cluster'],
280 ['project', 'projectUuid'],
281 ['is:trashed', 'inTrash'],
282 ['from', 'dateFrom'],
285 _.union(data.properties, prevData ? prevData.properties : [])
286 .forEach(p => keyMap.push([`has:${p.key}`, `prop-${p.key}`]));
289 const obj = getModifiedKeysValues(flatData(data), flatData(prevData));
290 value = buildQueryFromKeyMap({
291 searchValue: data.searchValue,
293 } as SearchBarAdvanceFormData, keyMap, "reuse");
295 value = buildQueryFromKeyMap(flatData(data), keyMap, "rebuild");
298 value = value.trim();
302 export class ParseSearchQuery {
303 hasKeywords: boolean;
306 [key: string]: string[]
310 export const parseSearchQuery: (query: string) => ParseSearchQuery = (searchValue: string) => {
321 const hasKeywords = (search: string) => keywords.reduce((acc, keyword) => acc + (search.includes(keyword) ? 1 : 0), 0);
324 const properties = {};
326 keywords.forEach(k => {
327 let p = searchValue.indexOf(k);
328 const key = k.substr(0, k.length - 1);
331 const l = searchValue.length;
335 let i = p + k.length;
336 while (i < l && searchValue[i] === ' ') {
340 while (i < l && searchValue[i] !== ' ') {
345 if (hasKeywords(v)) {
346 searchValue = searchValue.substr(0, p) + searchValue.substr(vp);
349 if (!properties[key]) {
350 properties[key] = [];
352 properties[key].push(v);
354 searchValue = searchValue.substr(0, p) + searchValue.substr(i);
356 p = searchValue.indexOf(k);
360 const values = _.uniq(searchValue.split(' ').filter(v => v.length > 0));
362 return { hasKeywords: keywordsCnt > 0, values, properties };
365 export const getSearchQueryFirstProp = (sq: ParseSearchQuery, name: string) => sq.properties[name] && sq.properties[name][0];
366 export const getSearchQueryPropValue = (sq: ParseSearchQuery, name: string, value: string) => sq.properties[name] && sq.properties[name].find((v: string) => v === value);
367 export const getSearchQueryProperties = (sq: ParseSearchQuery): PropertyValue[] => {
368 if (sq.properties.has) {
369 return sq.properties.has.map((value: string) => {
370 const v = value.split(':');
380 export const getAdvancedDataFromQuery = (query: string): SearchBarAdvanceFormData => {
381 const sq = parseSearchQuery(query);
384 searchValue: sq.values.join(' '),
385 type: getSearchQueryFirstProp(sq, 'type') as ResourceKind,
386 cluster: getSearchQueryFirstProp(sq, 'cluster'),
387 projectUuid: getSearchQueryFirstProp(sq, 'project'),
388 inTrash: getSearchQueryPropValue(sq, 'is', 'trashed') !== undefined,
389 dateFrom: getSearchQueryFirstProp(sq, 'from'),
390 dateTo: getSearchQueryFirstProp(sq, 'to'),
391 properties: getSearchQueryProperties(sq),
397 export const getSearchSessions = (clusterId: string | undefined, sessions: Session[]): Session[] => {
398 return sessions.filter(s => s.loggedIn && (!clusterId || s.clusterId === clusterId));
401 export const getFilters = (filterName: string, searchValue: string, sq: ParseSearchQuery): string => {
402 const filter = new FilterBuilder();
404 const resourceKind = getSearchQueryFirstProp(sq, 'type') as ResourceKind;
407 switch (resourceKind) {
408 case ResourceKind.COLLECTION:
409 prefix = GroupContentsResourcePrefix.COLLECTION;
411 case ResourceKind.PROCESS:
412 prefix = GroupContentsResourcePrefix.PROCESS;
415 prefix = GroupContentsResourcePrefix.PROJECT;
419 const isTrashed = getSearchQueryPropValue(sq, 'is', 'trashed');
421 if (!sq.hasKeywords) {
423 .addILike(filterName, searchValue, GroupContentsResourcePrefix.COLLECTION)
424 .addILike(filterName, searchValue, GroupContentsResourcePrefix.PROJECT);
427 filter.addILike(filterName, searchValue, GroupContentsResourcePrefix.PROCESS);
431 sq.values.forEach(v =>
432 filter.addILike(filterName, v, prefix)
435 sq.values.forEach(v => {
437 .addILike(filterName, v, GroupContentsResourcePrefix.COLLECTION)
438 .addILike(filterName, v, GroupContentsResourcePrefix.PROJECT);
441 filter.addILike(filterName, v, GroupContentsResourcePrefix.PROCESS);
447 filter.addEqual("is_trashed", true);
450 const projectUuid = getSearchQueryFirstProp(sq, 'project');
452 filter.addEqual('uuid', projectUuid, prefix);
455 const dateFrom = getSearchQueryFirstProp(sq, 'from');
457 filter.addGte('modified_at', buildDateFilter(dateFrom));
460 const dateTo = getSearchQueryFirstProp(sq, 'to');
462 filter.addLte('modified_at', buildDateFilter(dateTo));
465 const props = getSearchQueryProperties(sq);
468 filter.addILike(`properties.${p.key}`, p.value);
470 filter.addExists(p.key);
475 .addEqual('groupClass', GroupClass.PROJECT, GroupContentsResourcePrefix.PROJECT)
476 .addIsA("uuid", buildUuidFilter(resourceKind))
480 const buildUuidFilter = (type?: ResourceKind): ResourceKind[] => {
481 return type ? [type] : [ResourceKind.PROJECT, ResourceKind.COLLECTION, ResourceKind.PROCESS];
484 const buildDateFilter = (date?: string): string => {
485 return date ? date : '';
488 export const initAdvanceFormProjectsTree = () =>
489 (dispatch: Dispatch) => {
490 dispatch<any>(initUserProject(SEARCH_BAR_ADVANCE_FORM_PICKER_ID));
493 export const changeAdvanceFormProperty = (property: string, value: PropertyValue[] | string = '') =>
494 (dispatch: Dispatch) => {
495 dispatch(change(SEARCH_BAR_ADVANCE_FORM_NAME, property, value));
498 export const updateAdvanceFormProperties = (propertyValues: PropertyValue) =>
499 (dispatch: Dispatch) => {
500 dispatch(arrayPush(SEARCH_BAR_ADVANCE_FORM_NAME, 'properties', propertyValues));
503 export const moveUp = () =>
504 (dispatch: Dispatch) => {
505 dispatch(searchBarActions.MOVE_UP());
508 export const moveDown = () =>
509 (dispatch: Dispatch) => {
510 dispatch(searchBarActions.MOVE_DOWN());