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, untouch } 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, RESOURCE_UUID_REGEX, COLLECTION_PDH_REGEX } from '~/models/resource';
14 import { SearchView } from '~/store/search-bar/search-bar-reducer';
15 import { navigateTo, navigateToSearchResults } from '~/store/navigation/navigation-action';
16 import { snackbarActions, SnackbarKind } from '~/store/snackbar/snackbar-actions';
17 import { PropertyValue, SearchBarAdvanceFormData } from '~/models/search-bar';
18 import * as _ from "lodash";
19 import { getModifiedKeysValues } from "~/common/objects";
20 import { activateSearchBarProject } from "~/store/search-bar/search-bar-tree-actions";
21 import { Session } from "~/models/session";
22 import { searchResultsPanelActions } from "~/store/search-results-panel/search-results-panel-actions";
23 import { ListResults } from "~/services/common-service/common-service";
24 import * as parser from './search-query/arv-parser';
25 import { Keywords } from './search-query/arv-parser';
26 import { Vocabulary, getTagKeyLabel, getTagValueLabel } from "~/models/vocabulary";
28 export const searchBarActions = unionize({
29 SET_CURRENT_VIEW: ofType<string>(),
30 OPEN_SEARCH_VIEW: ofType<{}>(),
31 CLOSE_SEARCH_VIEW: ofType<{}>(),
32 SET_SEARCH_RESULTS: ofType<GroupContentsResource[]>(),
33 SET_SEARCH_VALUE: ofType<string>(),
34 SET_SAVED_QUERIES: ofType<SearchBarAdvanceFormData[]>(),
35 SET_RECENT_QUERIES: ofType<string[]>(),
36 UPDATE_SAVED_QUERY: ofType<SearchBarAdvanceFormData[]>(),
37 SET_SELECTED_ITEM: ofType<string>(),
38 MOVE_UP: ofType<{}>(),
39 MOVE_DOWN: ofType<{}>(),
40 SELECT_FIRST_ITEM: ofType<{}>()
43 export type SearchBarActions = UnionOf<typeof searchBarActions>;
45 export const SEARCH_BAR_ADVANCE_FORM_NAME = 'searchBarAdvanceFormName';
47 export const SEARCH_BAR_ADVANCE_FORM_PICKER_ID = 'searchBarAdvanceFormPickerId';
49 export const DEFAULT_SEARCH_DEBOUNCE = 1000;
51 export const goToView = (currentView: string) => searchBarActions.SET_CURRENT_VIEW(currentView);
53 export const saveRecentQuery = (query: string) =>
54 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) =>
55 services.searchService.saveRecentQuery(query);
58 export const loadRecentQueries = () =>
59 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
60 const recentQueries = services.searchService.getRecentQueries();
61 dispatch(searchBarActions.SET_RECENT_QUERIES(recentQueries));
65 export const searchData = (searchValue: string) =>
66 async (dispatch: Dispatch, getState: () => RootState) => {
67 const currentView = getState().searchBar.currentView;
68 dispatch(searchResultsPanelActions.CLEAR());
69 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
70 if (searchValue.length > 0) {
71 dispatch<any>(searchGroups(searchValue, 5));
72 if (currentView === SearchView.BASIC) {
73 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
74 dispatch(navigateToSearchResults(searchValue));
79 export const searchAdvanceData = (data: SearchBarAdvanceFormData) =>
80 async (dispatch: Dispatch, getState: () => RootState) => {
81 dispatch<any>(saveQuery(data));
82 const searchValue = getState().searchBar.searchValue;
83 dispatch(searchResultsPanelActions.CLEAR());
84 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
85 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
86 dispatch(navigateToSearchResults(searchValue));
89 export const setSearchValueFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) =>
90 (dispatch: Dispatch, getState: () => RootState) => {
91 const searchValue = getState().searchBar.searchValue;
92 const value = getQueryFromAdvancedData({
96 dispatch(searchBarActions.SET_SEARCH_VALUE(value));
99 export const setAdvancedDataFromSearchValue = (search: string, vocabulary: Vocabulary) =>
100 async (dispatch: Dispatch) => {
101 const data = getAdvancedDataFromQuery(search, vocabulary);
102 dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
103 if (data.projectUuid) {
104 await dispatch<any>(activateSearchBarProject(data.projectUuid));
105 dispatch(treePickerActions.ACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID, id: data.projectUuid }));
109 const saveQuery = (data: SearchBarAdvanceFormData) =>
110 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
111 const savedQueries = services.searchService.getSavedQueries();
112 if (data.saveQuery && data.queryName) {
113 const filteredQuery = savedQueries.find(query => query.queryName === data.queryName);
114 data.searchValue = getState().searchBar.searchValue;
116 services.searchService.editSavedQueries(data);
117 dispatch(searchBarActions.UPDATE_SAVED_QUERY(savedQueries));
118 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully updated', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
120 services.searchService.saveQuery(data);
121 dispatch(searchBarActions.SET_SAVED_QUERIES(savedQueries));
122 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully saved', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
127 export const deleteSavedQuery = (id: number) =>
128 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
129 services.searchService.deleteSavedQuery(id);
130 const savedSearchQueries = services.searchService.getSavedQueries();
131 dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
132 return savedSearchQueries || [];
135 export const editSavedQuery = (data: SearchBarAdvanceFormData) =>
136 (dispatch: Dispatch<any>) => {
137 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.ADVANCED));
138 dispatch(searchBarActions.SET_SEARCH_VALUE(getQueryFromAdvancedData(data)));
139 dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
142 export const openSearchView = () =>
143 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
144 const savedSearchQueries = services.searchService.getSavedQueries();
145 dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
146 dispatch(loadRecentQueries());
147 dispatch(searchBarActions.OPEN_SEARCH_VIEW());
148 dispatch(searchBarActions.SELECT_FIRST_ITEM());
151 export const closeSearchView = () =>
152 (dispatch: Dispatch<any>) => {
153 dispatch(searchBarActions.SET_SELECTED_ITEM(''));
154 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
157 export const closeAdvanceView = () =>
158 (dispatch: Dispatch<any>) => {
159 dispatch(searchBarActions.SET_SEARCH_VALUE(''));
160 dispatch(treePickerActions.DEACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID }));
161 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
164 export const navigateToItem = (uuid: string) =>
165 (dispatch: Dispatch<any>) => {
166 dispatch(searchBarActions.SET_SELECTED_ITEM(''));
167 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
168 dispatch(navigateTo(uuid));
171 export const changeData = (searchValue: string) =>
172 (dispatch: Dispatch, getState: () => RootState) => {
173 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
174 const currentView = getState().searchBar.currentView;
175 const searchValuePresent = searchValue.length > 0;
177 if (currentView === SearchView.ADVANCED) {
178 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
179 } else if (searchValuePresent) {
180 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
181 dispatch(searchBarActions.SET_SELECTED_ITEM(searchValue));
183 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
184 dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
185 dispatch(searchBarActions.SELECT_FIRST_ITEM());
189 export const submitData = (event: React.FormEvent<HTMLFormElement>) =>
190 (dispatch: Dispatch, getState: () => RootState) => {
191 event.preventDefault();
192 const searchValue = getState().searchBar.searchValue;
193 dispatch<any>(saveRecentQuery(searchValue));
194 dispatch<any>(loadRecentQueries());
195 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
196 if (RESOURCE_UUID_REGEX.exec(searchValue) || COLLECTION_PDH_REGEX.exec(searchValue)) {
197 dispatch<any>(navigateTo(searchValue));
199 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
200 dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
201 dispatch(searchResultsPanelActions.CLEAR());
202 dispatch(navigateToSearchResults(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 { cluster: clusterId } = getAdvancedDataFromQuery(searchValue);
213 const sessions = getSearchSessions(clusterId, getState().auth.sessions);
214 const lists: ListResults<GroupContentsResource>[] = await Promise.all(sessions.map(session => {
215 const filters = queryToFilters(searchValue);
216 return services.groupsService.contents('', {
223 const items = lists.reduce((items, list) => items.concat(list.items), [] as GroupContentsResource[]);
224 dispatch(searchBarActions.SET_SEARCH_RESULTS(items));
228 const buildQueryFromKeyMap = (data: any, keyMap: string[][], mode: 'rebuild' | 'reuse') => {
229 let value = data.searchValue;
231 const addRem = (field: string, key: string) => {
234 if (data.hasOwnProperty(key)) {
235 const pattern = v === false
236 ? `${field.replace(':', '\\:\\s*')}\\s*`
237 : `${field.replace(':', '\\:\\s*')}\\:\\s*"[\\w|\\#|\\-|\\/]*"\\s*`;
238 value = value.replace(new RegExp(pattern), '');
242 const nv = v === true
246 if (mode === 'rebuild') {
247 value = value + ' ' + nv;
249 value = nv + ' ' + value;
254 keyMap.forEach(km => addRem(km[0], km[1]));
259 export const getQueryFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) => {
262 const flatData = (data: SearchBarAdvanceFormData) => {
264 searchValue: data.searchValue,
266 cluster: data.cluster,
267 projectUuid: data.projectUuid,
268 inTrash: data.inTrash,
269 dateFrom: data.dateFrom,
272 (data.properties || []).forEach(p => fo[`prop-"${p.keyID || p.key}"`] = `"${p.valueID || p.value}"`);
278 ['cluster', 'cluster'],
279 ['project', 'projectUuid'],
280 [`is:${parser.States.TRASHED}`, 'inTrash'],
281 ['from', 'dateFrom'],
284 _.union(data.properties, prevData ? prevData.properties : [])
285 .forEach(p => keyMap.push([`has:"${p.keyID || p.key}"`, `prop-"${p.keyID || p.key}"`]));
288 const obj = getModifiedKeysValues(flatData(data), flatData(prevData));
289 value = buildQueryFromKeyMap({
290 searchValue: data.searchValue,
292 } as SearchBarAdvanceFormData, keyMap, "reuse");
294 value = buildQueryFromKeyMap(flatData(data), keyMap, "rebuild");
297 value = value.trim();
301 export const getAdvancedDataFromQuery = (query: string, vocabulary?: Vocabulary): SearchBarAdvanceFormData => {
302 const { tokens, searchString } = parser.parseSearchQuery(query);
303 const getValue = parser.getValue(tokens);
305 searchValue: searchString,
306 type: getValue(Keywords.TYPE) as ResourceKind,
307 cluster: getValue(Keywords.CLUSTER),
308 projectUuid: getValue(Keywords.PROJECT),
309 inTrash: parser.isTrashed(tokens),
310 dateFrom: getValue(Keywords.FROM) || '',
311 dateTo: getValue(Keywords.TO) || '',
312 properties: vocabulary
313 ? parser.getProperties(tokens).map(
317 key: getTagKeyLabel(p.key, vocabulary),
319 value: getTagValueLabel(p.key, p.value, vocabulary),
322 : parser.getProperties(tokens),
328 export const getSearchSessions = (clusterId: string | undefined, sessions: Session[]): Session[] => {
329 return sessions.filter(s => s.loggedIn && (!clusterId || s.clusterId === clusterId));
332 export const queryToFilters = (query: string) => {
333 const data = getAdvancedDataFromQuery(query);
334 const filter = new FilterBuilder();
335 const resourceKind = data.type;
337 if (data.searchValue) {
338 filter.addFullTextSearch(data.searchValue);
341 if (data.projectUuid) {
342 filter.addEqual('ownerUuid', data.projectUuid);
346 filter.addGte('modified_at', buildDateFilter(data.dateFrom));
350 filter.addLte('modified_at', buildDateFilter(data.dateTo));
353 data.properties.forEach(p => {
356 .addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.PROJECT)
357 .addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.COLLECTION);
359 filter.addExists(p.key);
363 .addIsA("uuid", buildUuidFilter(resourceKind))
367 const buildUuidFilter = (type?: ResourceKind): ResourceKind[] => {
368 return type ? [type] : [ResourceKind.PROJECT, ResourceKind.COLLECTION, ResourceKind.PROCESS];
371 const buildDateFilter = (date?: string): string => {
372 return date ? date : '';
375 export const initAdvanceFormProjectsTree = () =>
376 (dispatch: Dispatch) => {
377 dispatch<any>(initUserProject(SEARCH_BAR_ADVANCE_FORM_PICKER_ID));
380 export const changeAdvanceFormProperty = (propertyField: string, value: PropertyValue[] | string = '') =>
381 (dispatch: Dispatch) => {
382 dispatch(change(SEARCH_BAR_ADVANCE_FORM_NAME, propertyField, value));
385 export const resetAdvanceFormProperty = (propertyField: string) =>
386 (dispatch: Dispatch) => {
387 dispatch(change(SEARCH_BAR_ADVANCE_FORM_NAME, propertyField, null));
388 dispatch(untouch(SEARCH_BAR_ADVANCE_FORM_NAME, propertyField));
391 export const updateAdvanceFormProperties = (propertyValues: PropertyValue) =>
392 (dispatch: Dispatch) => {
393 dispatch(arrayPush(SEARCH_BAR_ADVANCE_FORM_NAME, 'properties', propertyValues));
396 export const moveUp = () =>
397 (dispatch: Dispatch) => {
398 dispatch(searchBarActions.MOVE_UP());
401 export const moveDown = () =>
402 (dispatch: Dispatch) => {
403 dispatch(searchBarActions.MOVE_DOWN());