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, isResourceUuid, extractUuidKind } 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 { debounce } from 'debounce';
19 import * as _ from "lodash";
20 import { getModifiedKeysValues } from "~/common/objects";
21 import { activateSearchBarProject } from "~/store/search-bar/search-bar-tree-actions";
22 import { Session } from "~/models/session";
23 import { searchResultsPanelActions } from "~/store/search-results-panel/search-results-panel-actions";
24 import { ListResults } from "~/services/common-service/common-service";
26 export const searchBarActions = unionize({
27 SET_CURRENT_VIEW: ofType<string>(),
28 OPEN_SEARCH_VIEW: ofType<{}>(),
29 CLOSE_SEARCH_VIEW: ofType<{}>(),
30 SET_SEARCH_RESULTS: ofType<GroupContentsResource[]>(),
31 SET_SEARCH_VALUE: ofType<string>(),
32 SET_SAVED_QUERIES: ofType<SearchBarAdvanceFormData[]>(),
33 SET_RECENT_QUERIES: ofType<string[]>(),
34 UPDATE_SAVED_QUERY: ofType<SearchBarAdvanceFormData[]>(),
35 SET_SELECTED_ITEM: ofType<string>(),
36 MOVE_UP: ofType<{}>(),
37 MOVE_DOWN: ofType<{}>(),
38 SELECT_FIRST_ITEM: ofType<{}>()
41 export type SearchBarActions = UnionOf<typeof searchBarActions>;
43 export const SEARCH_BAR_ADVANCE_FORM_NAME = 'searchBarAdvanceFormName';
45 export const SEARCH_BAR_ADVANCE_FORM_PICKER_ID = 'searchBarAdvanceFormPickerId';
47 export const DEFAULT_SEARCH_DEBOUNCE = 1000;
49 export const goToView = (currentView: string) => searchBarActions.SET_CURRENT_VIEW(currentView);
51 export const saveRecentQuery = (query: string) =>
52 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) =>
53 services.searchService.saveRecentQuery(query);
56 export const loadRecentQueries = () =>
57 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
58 const recentQueries = services.searchService.getRecentQueries();
59 dispatch(searchBarActions.SET_RECENT_QUERIES(recentQueries));
63 export const searchData = (searchValue: string) =>
64 async (dispatch: Dispatch, getState: () => RootState) => {
65 const currentView = getState().searchBar.currentView;
66 dispatch(searchResultsPanelActions.CLEAR());
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(searchResultsPanelActions.CLEAR());
81 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
82 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
83 dispatch(navigateToSearchResults);
86 export const setSearchValueFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) =>
87 (dispatch: Dispatch, getState: () => RootState) => {
88 const searchValue = getState().searchBar.searchValue;
89 const value = getQueryFromAdvancedData({
93 dispatch(searchBarActions.SET_SEARCH_VALUE(value));
96 export const setAdvancedDataFromSearchValue = (search: string) =>
97 async (dispatch: Dispatch) => {
98 const data = getAdvancedDataFromQuery(search);
99 dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
100 if (data.projectUuid) {
101 await dispatch<any>(activateSearchBarProject(data.projectUuid));
102 dispatch(treePickerActions.ACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID, id: data.projectUuid }));
106 const saveQuery = (data: SearchBarAdvanceFormData) =>
107 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
108 const savedQueries = services.searchService.getSavedQueries();
109 if (data.saveQuery && data.queryName) {
110 const filteredQuery = savedQueries.find(query => query.queryName === data.queryName);
111 data.searchValue = getState().searchBar.searchValue;
113 services.searchService.editSavedQueries(data);
114 dispatch(searchBarActions.UPDATE_SAVED_QUERY(savedQueries));
115 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully updated', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
117 services.searchService.saveQuery(data);
118 dispatch(searchBarActions.SET_SAVED_QUERIES(savedQueries));
119 dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'Query has been successfully saved', hideDuration: 2000, kind: SnackbarKind.SUCCESS }));
124 export const deleteSavedQuery = (id: number) =>
125 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
126 services.searchService.deleteSavedQuery(id);
127 const savedSearchQueries = services.searchService.getSavedQueries();
128 dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
129 return savedSearchQueries || [];
132 export const editSavedQuery = (data: SearchBarAdvanceFormData) =>
133 (dispatch: Dispatch<any>) => {
134 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.ADVANCED));
135 dispatch(searchBarActions.SET_SEARCH_VALUE(getQueryFromAdvancedData(data)));
136 dispatch<any>(initialize(SEARCH_BAR_ADVANCE_FORM_NAME, data));
139 export const openSearchView = () =>
140 (dispatch: Dispatch<any>, getState: () => RootState, services: ServiceRepository) => {
141 const savedSearchQueries = services.searchService.getSavedQueries();
142 dispatch(searchBarActions.SET_SAVED_QUERIES(savedSearchQueries));
143 dispatch(loadRecentQueries());
144 dispatch(searchBarActions.OPEN_SEARCH_VIEW());
145 dispatch(searchBarActions.SELECT_FIRST_ITEM());
148 export const closeSearchView = () =>
149 (dispatch: Dispatch<any>) => {
150 dispatch(searchBarActions.SET_SELECTED_ITEM(''));
151 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
154 export const closeAdvanceView = () =>
155 (dispatch: Dispatch<any>) => {
156 dispatch(searchBarActions.SET_SEARCH_VALUE(''));
157 dispatch(treePickerActions.DEACTIVATE_TREE_PICKER_NODE({ pickerId: SEARCH_BAR_ADVANCE_FORM_PICKER_ID }));
158 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
161 export const navigateToItem = (uuid: string) =>
162 (dispatch: Dispatch<any>) => {
163 dispatch(searchBarActions.SET_SELECTED_ITEM(''));
164 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
165 dispatch(navigateTo(uuid));
168 export const changeData = (searchValue: string) =>
169 (dispatch: Dispatch, getState: () => RootState) => {
170 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
171 const currentView = getState().searchBar.currentView;
172 const searchValuePresent = searchValue.length > 0;
174 if (currentView === SearchView.ADVANCED) {
175 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
176 } else if (searchValuePresent) {
177 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.AUTOCOMPLETE));
178 dispatch(searchBarActions.SET_SELECTED_ITEM(searchValue));
179 debounceStartSearch(dispatch);
181 dispatch(searchBarActions.SET_CURRENT_VIEW(SearchView.BASIC));
182 dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
183 dispatch(searchBarActions.SELECT_FIRST_ITEM());
187 export const submitData = (event: React.FormEvent<HTMLFormElement>) =>
188 (dispatch: Dispatch, getState: () => RootState) => {
189 event.preventDefault();
190 const searchValue = getState().searchBar.searchValue;
191 dispatch<any>(saveRecentQuery(searchValue));
192 dispatch<any>(loadRecentQueries());
193 dispatch(searchBarActions.CLOSE_SEARCH_VIEW());
194 dispatch(searchBarActions.SET_SEARCH_VALUE(searchValue));
195 dispatch(searchBarActions.SET_SEARCH_RESULTS([]));
196 dispatch(searchResultsPanelActions.CLEAR());
197 dispatch(navigateToSearchResults);
200 const debounceStartSearch = debounce((dispatch: Dispatch) => dispatch<any>(startSearch()), DEFAULT_SEARCH_DEBOUNCE);
202 const startSearch = () =>
203 (dispatch: Dispatch, getState: () => RootState) => {
204 const searchValue = getState().searchBar.searchValue;
205 dispatch<any>(searchData(searchValue));
208 const searchGroups = (searchValue: string, limit: number) =>
209 async (dispatch: Dispatch, getState: () => RootState, services: ServiceRepository) => {
210 const currentView = getState().searchBar.currentView;
212 if (searchValue || currentView === SearchView.ADVANCED) {
213 const sq = parseSearchQuery(searchValue);
214 const clusterId = getSearchQueryFirstProp(sq, 'cluster');
215 const sessions = getSearchSessions(clusterId, getState().auth.sessions);
216 const lists: ListResults<GroupContentsResource>[] = await Promise.all(sessions.map(session => {
217 const filters = getFilters('name', searchValue, sq);
218 return services.groupsService.contents('', {
225 const items = lists.reduce((items, list) => items.concat(list.items), [] as GroupContentsResource[]);
226 dispatch(searchBarActions.SET_SEARCH_RESULTS(items));
230 const buildQueryFromKeyMap = (data: any, keyMap: string[][], mode: 'rebuild' | 'reuse') => {
231 let value = data.searchValue;
233 const addRem = (field: string, key: string) => {
236 if (data.hasOwnProperty(key)) {
237 const pattern = v === false
238 ? `${field.replace(':', '\\:\\s*')}\\s*`
239 : `${field.replace(':', '\\:\\s*')}\\:\\s*[\\w|\\#|\\-|\\/]*\\s*`;
240 value = value.replace(new RegExp(pattern), '');
244 const nv = v === true
248 if (mode === 'rebuild') {
249 value = value + ' ' + nv;
251 value = nv + ' ' + value;
256 keyMap.forEach(km => addRem(km[0], km[1]));
261 export const getQueryFromAdvancedData = (data: SearchBarAdvanceFormData, prevData?: SearchBarAdvanceFormData) => {
264 const flatData = (data: SearchBarAdvanceFormData) => {
266 searchValue: data.searchValue,
268 cluster: data.cluster,
269 projectUuid: data.projectUuid,
270 inTrash: data.inTrash,
271 dateFrom: data.dateFrom,
274 (data.properties || []).forEach(p => fo[`prop-${p.key}`] = p.value);
280 ['cluster', 'cluster'],
281 ['project', 'projectUuid'],
282 ['is:trashed', 'inTrash'],
283 ['from', 'dateFrom'],
286 _.union(data.properties, prevData ? prevData.properties : [])
287 .forEach(p => keyMap.push([`has:${p.key}`, `prop-${p.key}`]));
290 const obj = getModifiedKeysValues(flatData(data), flatData(prevData));
291 value = buildQueryFromKeyMap({
292 searchValue: data.searchValue,
294 } as SearchBarAdvanceFormData, keyMap, "reuse");
296 value = buildQueryFromKeyMap(flatData(data), keyMap, "rebuild");
299 value = value.trim();
303 export class ParseSearchQuery {
304 hasKeywords: boolean;
307 [key: string]: string[]
311 export const parseSearchQuery: (query: string) => ParseSearchQuery = (searchValue: string) => {
322 const hasKeywords = (search: string) => keywords.reduce((acc, keyword) => acc + (search.includes(keyword) ? 1 : 0), 0);
325 const properties = {};
327 keywords.forEach(k => {
329 let p = searchValue.indexOf(k);
330 const key = k.substr(0, k.length - 1);
333 const l = searchValue.length;
337 let i = p + k.length;
338 while (i < l && searchValue[i] === ' ') {
342 while (i < l && searchValue[i] !== ' ') {
347 if (hasKeywords(v)) {
348 searchValue = searchValue.substr(0, p) + searchValue.substr(vp);
351 if (!properties[key]) {
352 properties[key] = [];
354 properties[key].push(v);
356 searchValue = searchValue.substr(0, p) + searchValue.substr(i);
358 p = searchValue.indexOf(k);
363 const values = _.uniq(searchValue.split(' ').filter(v => v.length > 0));
365 return { hasKeywords: keywordsCnt > 0, values, properties };
368 export const getSearchQueryFirstProp = (sq: ParseSearchQuery, name: string) => sq.properties[name] && sq.properties[name][0];
369 export const getSearchQueryPropValue = (sq: ParseSearchQuery, name: string, value: string) => sq.properties[name] && sq.properties[name].find((v: string) => v === value);
370 export const getSearchQueryProperties = (sq: ParseSearchQuery): PropertyValue[] => {
371 if (sq.properties.has) {
372 return sq.properties.has.map((value: string) => {
373 const v = value.split(':');
383 export const getAdvancedDataFromQuery = (query: string): SearchBarAdvanceFormData => {
384 const sq = parseSearchQuery(query);
387 searchValue: sq.values.join(' '),
388 type: getSearchQueryFirstProp(sq, 'type') as ResourceKind,
389 cluster: getSearchQueryFirstProp(sq, 'cluster'),
390 projectUuid: getSearchQueryFirstProp(sq, 'project'),
391 inTrash: getSearchQueryPropValue(sq, 'is', 'trashed') !== undefined,
392 dateFrom: getSearchQueryFirstProp(sq, 'from'),
393 dateTo: getSearchQueryFirstProp(sq, 'to'),
394 properties: getSearchQueryProperties(sq),
400 export const getSearchSessions = (clusterId: string | undefined, sessions: Session[]): Session[] => {
401 return sessions.filter(s => s.loggedIn && (!clusterId || s.clusterId === clusterId));
404 export const getFilters = (filterName: string, searchValue: string, sq: ParseSearchQuery): string => {
405 const filter = new FilterBuilder();
406 const isSearchQueryUuid = isResourceUuid(sq.values[0]);
407 const resourceKind = getSearchQueryFirstProp(sq, 'type') as ResourceKind;
410 switch (resourceKind) {
411 case ResourceKind.COLLECTION:
412 prefix = GroupContentsResourcePrefix.COLLECTION;
414 case ResourceKind.PROCESS:
415 prefix = GroupContentsResourcePrefix.PROCESS;
418 prefix = GroupContentsResourcePrefix.PROJECT;
422 const isTrashed = getSearchQueryPropValue(sq, 'is', 'trashed');
424 if (!sq.hasKeywords && !isSearchQueryUuid) {
426 .addILike(filterName, searchValue, GroupContentsResourcePrefix.COLLECTION)
427 .addILike(filterName, searchValue, GroupContentsResourcePrefix.PROJECT)
428 .addILike(filterName, searchValue, GroupContentsResourcePrefix.PROCESS)
429 .addEqual('is_trashed', false, GroupContentsResourcePrefix.COLLECTION)
430 .addEqual('is_trashed', false, GroupContentsResourcePrefix.PROJECT);
433 filter.addILike(filterName, searchValue, GroupContentsResourcePrefix.PROCESS);
435 } else if (!sq.hasKeywords && isSearchQueryUuid) {
437 .addILike('uuid', searchValue, GroupContentsResourcePrefix.COLLECTION)
438 .addILike('uuid', searchValue, GroupContentsResourcePrefix.PROJECT)
439 .addILike('uuid', searchValue, GroupContentsResourcePrefix.PROCESS)
440 .addEqual('is_trashed', false, GroupContentsResourcePrefix.COLLECTION)
441 .addEqual('is_trashed', false, GroupContentsResourcePrefix.PROJECT);
445 sq.values.forEach(v =>
446 filter.addILike(filterName, v, prefix)
449 sq.values.forEach(v => {
451 .addILike(filterName, v, GroupContentsResourcePrefix.COLLECTION)
452 .addILike(filterName, v, GroupContentsResourcePrefix.PROJECT)
453 .addILike(filterName, v, GroupContentsResourcePrefix.PROCESS)
454 .addEqual('is_trashed', false, GroupContentsResourcePrefix.COLLECTION)
455 .addEqual('is_trashed', false, GroupContentsResourcePrefix.PROJECT);
458 filter.addILike(filterName, v, GroupContentsResourcePrefix.PROCESS);
462 if (prefix && !isTrashed) {
463 sq.values.forEach(v =>
464 filter.addILike(filterName, v, prefix)
465 .addEqual('is_trashed', false, GroupContentsResourcePrefix.COLLECTION)
466 .addEqual('is_trashed', false, GroupContentsResourcePrefix.PROJECT)
471 sq.values.forEach(v => {
472 filter.addEqual('is_trashed', true, GroupContentsResourcePrefix.COLLECTION)
473 .addEqual('is_trashed', true, GroupContentsResourcePrefix.PROJECT)
474 .addILike(filterName, v, GroupContentsResourcePrefix.COLLECTION)
475 .addILike(filterName, searchValue, GroupContentsResourcePrefix.PROCESS);
479 const projectUuid = getSearchQueryFirstProp(sq, 'project');
481 filter.addEqual('uuid', projectUuid, prefix);
484 const dateFrom = getSearchQueryFirstProp(sq, 'from');
486 filter.addGte('modified_at', buildDateFilter(dateFrom));
489 const dateTo = getSearchQueryFirstProp(sq, 'to');
491 filter.addLte('modified_at', buildDateFilter(dateTo));
494 const props = getSearchQueryProperties(sq);
497 filter.addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.PROJECT)
498 .addILike(`properties.${p.key}`, p.value, GroupContentsResourcePrefix.COLLECTION);
500 filter.addExists(p.key);
505 .addIsA("uuid", buildUuidFilter(resourceKind))
509 const buildUuidFilter = (type?: ResourceKind): ResourceKind[] => {
510 return type ? [type] : [ResourceKind.PROJECT, ResourceKind.COLLECTION, ResourceKind.PROCESS];
513 const buildDateFilter = (date?: string): string => {
514 return date ? date : '';
517 export const initAdvanceFormProjectsTree = () =>
518 (dispatch: Dispatch) => {
519 dispatch<any>(initUserProject(SEARCH_BAR_ADVANCE_FORM_PICKER_ID));
522 export const changeAdvanceFormProperty = (property: string, value: PropertyValue[] | string = '') =>
523 (dispatch: Dispatch) => {
524 dispatch(change(SEARCH_BAR_ADVANCE_FORM_NAME, property, value));
527 export const updateAdvanceFormProperties = (propertyValues: PropertyValue) =>
528 (dispatch: Dispatch) => {
529 dispatch(arrayPush(SEARCH_BAR_ADVANCE_FORM_NAME, 'properties', propertyValues));
532 export const moveUp = () =>
533 (dispatch: Dispatch) => {
534 dispatch(searchBarActions.MOVE_UP());
537 export const moveDown = () =>
538 (dispatch: Dispatch) => {
539 dispatch(searchBarActions.MOVE_DOWN());