Debian Codegraph @

install/freeipa-webui/src/pages/IDViews/IDViewsOverrideGroups.tsx

raw
1 import React, { useEffect, useState } from "react";
2 // PatternFly
3 import {
4 Button,
5 PageSection,
6 PaginationVariant,
7 ToolbarItemVariant,
8 Tooltip,
9 } from "@patternfly/react-core";
10 import {
11 InnerScrollContainer,
12 OuterScrollContainer,
13 } from "@patternfly/react-table";
14 // Redux
15 import { useAppDispatch } from "src/store/hooks";
16 // Hooks
17 import useApiError from "src/hooks/useApiError";
18 import useListPageSearchParams from "src/hooks/useListPageSearchParams";
19 import { addAlert } from "src/store/Global/alerts-slice";
20 // Layouts
21 import { ToolbarItem } from "src/components/layouts/ToolbarLayout";
22 import SecondaryButton from "src/components/layouts/SecondaryButton";
23 import ToolbarLayout from "src/components/layouts/ToolbarLayout";
24 import SearchInputLayout from "src/components/layouts/SearchInputLayout";
25 import PaginationLayout from "src/components/layouts/PaginationLayout";
26 // Errors
27 import GlobalErrors from "src/components/errors/GlobalErrors";
28 import { FetchBaseQueryError } from "@reduxjs/toolkit/query";
29 import { SerializedError } from "@reduxjs/toolkit";
30 // Utils
31 import { isGroupOverrideSelectable } from "src/utils/utils";
32 import IDViewsOverrideGroupsTable from "src/pages/IDViews/IDViewsOverrideGroupsTable";
33 // Modals
34 import AddIdOverrideGroupModal from "src/components/modals/IdOverrideModals/AddIdOverrideGroup";
35 import DeleteIdOverrideGroupsModal from "src/components/modals/IdOverrideModals/DeleteIdOverrideGroups";
36 // Data types
37 import { IDViewOverrideGroup } from "src/utils/datatypes/globalDataTypes";
38 // Icons
39 import { OutlinedQuestionCircleIcon } from "@patternfly/react-icons";
40 // RPC
41 import {
42 IDOverridePayload,
43 useGettingIDOverrideGroupsQuery,
44 useSearchOverrideEntriesMutation,
45 } from "src/services/rpcIdOverrides";
46
47 interface PropsToOverrides {
48 idview: string;
49 groups: string[];
50 onRefresh: () => void;
51 }
52
53 const IDViewsOverrideGroups = (props: PropsToOverrides) => {
54 const dispatch = useAppDispatch();
55 const globalErrors = useApiError([]);
56
57 const { page, setPage, perPage, setPerPage, searchValue, setSearchValue } =
58 useListPageSearchParams();
59 const [totalCount, setTotalCount] = useState<number>(0);
60 const [groupsList, setGroupsList] = useState<IDViewOverrideGroup[]>([]);
61 const [selectedGroups, setSelectedGroupsList] = useState<string[]>([]);
62 const [searchDisabled, setSearchIsDisabled] = useState<boolean>(false);
63
64 const clearSelectedGroups = () => {
65 const emptyList: string[] = [];
66 setSelectedGroupsList(emptyList);
67 };
68
69 const selectedData = {
70 selectedGroups,
71 clearSelectedGroups,
72 };
73
74 // Page indexes
75 const firstIdx = (page - 1) * perPage;
76 const lastIdx = page * perPage;
77
78 // 'Delete' button state
79 const [isDeleteButtonDisabled, setIsDeleteButtonDisabled] =
80 useState<boolean>(true);
81
82 const updateIsDeleteButtonDisabled = (value: boolean) => {
83 setIsDeleteButtonDisabled(value);
84 };
85
86 // If some entries have been deleted, restore the selected list
87 const [isDeletion, setIsDeletion] = useState(false);
88
89 const updateIsDeletion = (value: boolean) => {
90 setIsDeletion(value);
91 };
92
93 // Elements selected (per page)
94 // - This will help to calculate the remaining elements on a specific page (bulk selector)
95 const [selectedPerPage, setSelectedPerPage] = useState<number>(0);
96
97 const updateSelectedPerPage = (selected: number) => {
98 setSelectedPerPage(selected);
99 };
100 const selectedPerPageData = {
101 selectedPerPage,
102 updateSelectedPerPage,
103 };
104
105 const selectableTable = groupsList.filter(isGroupOverrideSelectable);
106
107 const groupsTableData = {
108 isSelectable: isGroupOverrideSelectable,
109 selected: selectedGroups,
110 selectableTable,
111 setSelectedGroups: setSelectedGroupsList,
112 clearSelected: clearSelectedGroups,
113 };
114
115 const viewsTableButtonsData = {
116 updateIsDeleteButtonDisabled,
117 isDeletion,
118 updateIsDeletion,
119 };
120
121 // Pagination
122 const updatePage = (newPage: number) => {
123 setPage(newPage);
124 };
125
126 const updatePerPage = (newSetPerPage: number) => {
127 setPerPage(newSetPerPage);
128 };
129
130 const updateShownGroupsList = (newShownGroupsList: IDViewOverrideGroup[]) => {
131 setGroupsList(newShownGroupsList);
132 };
133
134 // Update search input valie
135 const updateSearchValue = (value: string) => {
136 setSearchValue(value);
137 };
138
139 const [retrieveEntries] = useSearchOverrideEntriesMutation({});
140
141 const submitSearchValue = () => {
142 setShowTableRows(false);
143 setTotalCount(0);
144 setSearchIsDisabled(true);
145 retrieveEntries({
146 idView: props.idview,
147 searchValue: searchValue,
148 sizeLimit: 0,
149 startIdx: firstIdx,
150 stopIdx: lastIdx,
151 entryType: "idoverridegroup",
152 } as IDOverridePayload).then((result) => {
153 // Manage new response here
154 if ("data" in result) {
155 const searchError = result.data?.error as
156 | FetchBaseQueryError
157 | SerializedError;
158
159 if (searchError) {
160 // Error
161 let error: string | undefined = "";
162 if ("error" in searchError) {
163 error = searchError.error;
164 } else if ("message" in searchError) {
165 error = searchError.message;
166 }
167 dispatch(
168 addAlert({
169 name: "submit-search-value-error",
170 title: error || "Error when searching for override groups",
171 variant: "danger",
172 })
173 );
174 } else {
175 // Success
176 const groupsListResult = result.data?.result.results || [];
177 const groupsListSize = result.data?.result.count || 0;
178 const totalCount = result.data?.result.totalCount || 0;
179 const groupList: IDViewOverrideGroup[] = [];
180
181 for (let i = 0; i < groupsListSize; i++) {
182 groupList.push(groupsListResult[i].result);
183 }
184 setGroupsList(groupList);
185 setTotalCount(totalCount);
186 // Show table elements
187 setShowTableRows(true);
188 }
189 setSearchIsDisabled(false);
190 }
191 });
192 };
193
194 // SearchInputLayout
195 const searchValueData = {
196 searchValue,
197 updateSearchValue,
198 submitSearchValue,
199 };
200
201 const dataResponse = useGettingIDOverrideGroupsQuery(props.idview);
202
203 const {
204 data: batchResponse,
205 isLoading: isBatchLoading,
206 error: batchError,
207 } = dataResponse;
208
209 // Handle data when the API call is finished
210 useEffect(() => {
211 if (dataResponse.isFetching) {
212 setShowTableRows(false);
213 // Reset selected on refresh
214 setTotalCount(0);
215 globalErrors.clear();
216 return;
217 }
218
219 // API response: Success
220 if (
221 dataResponse.isSuccess &&
222 dataResponse.data &&
223 batchResponse !== undefined
224 ) {
225 setGroupsList(batchResponse);
226 setTotalCount(batchResponse.length);
227 setShowTableRows(true);
228 }
229 // API response: Error
230 if (
231 !dataResponse.isLoading &&
232 dataResponse.isError &&
233 dataResponse.error !== undefined
234 ) {
235 dispatch(
236 addAlert({
237 name: "add-group-error",
238 title: "Failed to query override groups: " + dataResponse.error,
239 variant: "danger",
240 })
241 );
242 }
243 }, [dataResponse]);
244
245 const onRefresh = () => {
246 props.onRefresh();
247 dataResponse.refetch();
248 };
249
250 // Show table rows
251 const [showTableRows, setShowTableRows] = useState(!isBatchLoading);
252
253 // Always refetch data when the component is loaded.
254 // This ensures the data is always up-to-date.
255 useEffect(() => {
256 dataResponse.refetch();
257 }, [page, perPage]);
258
259 // Show table rows only when data is fully retrieved
260 useEffect(() => {
261 if (showTableRows !== !isBatchLoading) {
262 setShowTableRows(!isBatchLoading);
263 }
264 }, [isBatchLoading]);
265
266 // Modals functionality
267 const [showAddModal, setShowAddModal] = useState(false);
268 const [showDeleteModal, setShowDeleteModal] = useState(false);
269 const onAddClickHandler = () => {
270 setShowAddModal(true);
271 };
272 const onCloseAddModal = () => {
273 setShowAddModal(false);
274 };
275 const onAddModalToggle = () => {
276 setShowAddModal(!showAddModal);
277 };
278 const onDeleteHandler = () => {
279 setShowDeleteModal(true);
280 };
281 const onDeleteModalToggle = () => {
282 setShowDeleteModal(!showDeleteModal);
283 };
284
285 // - 'PaginationLayout'
286 const paginationData = {
287 page,
288 perPage,
289 updatePage,
290 updatePerPage,
291 updateSelectedPerPage,
292 updateShownElementsList: updateShownGroupsList,
293 totalCount,
294 };
295
296 // - 'Delete modal'
297 const deleteGroupsButtonsData = {
298 updateIsDeleteButtonDisabled,
299 updateIsDeletion,
300 };
301
302 const tooltipMsg = (
303 <p>
304 Searching only uses the <i>Group name</i>, <i>GID</i>, and{" "}
305 <i>Description</i> to find override groups. <b>WARNING</b> searching by
306 the <i>Group to override</i> value will not work
307 </p>
308 );
309
310 // List of Toolbar items
311 const toolbarItems: ToolbarItem[] = [
312 {
313 key: 0,
314 element: (
315 <Tooltip aria="none" aria-live="polite" content={tooltipMsg}>
316 <Button
317 icon={<OutlinedQuestionCircleIcon />}
318 data-cy="search"
319 aria-label="Search tips"
320 variant="plain"
321 id="search_tip"
322 />
323 </Tooltip>
324 ),
325 toolbarItemGap: { default: "gapNone" },
326 },
327 {
328 key: 1,
329 element: (
330 <SearchInputLayout
331 dataCy="search"
332 name="search"
333 ariaLabel="Search groups"
334 placeholder="Search"
335 searchValueData={searchValueData}
336 isDisabled={searchDisabled}
337 />
338 ),
339 toolbarItemVariant: ToolbarItemVariant.label,
340 toolbarItemGap: { default: "gapMd" },
341 },
342 {
343 key: 2,
344 toolbarItemVariant: ToolbarItemVariant.separator,
345 },
346 {
347 key: 3,
348 element: (
349 <SecondaryButton
350 dataCy="id-views-tab-override-groups-button-refresh"
351 onClickHandler={props.onRefresh}
352 >
353 Refresh
354 </SecondaryButton>
355 ),
356 },
357 {
358 key: 4,
359 element: (
360 <SecondaryButton
361 dataCy="id-views-tab-override-groups-button-delete"
362 isDisabled={isDeleteButtonDisabled || !showTableRows}
363 onClickHandler={onDeleteHandler}
364 >
365 Delete
366 </SecondaryButton>
367 ),
368 },
369 {
370 key: 5,
371 element: (
372 <SecondaryButton
373 dataCy="id-views-tab-override-groups-button-add"
374 onClickHandler={onAddClickHandler}
375 isDisabled={!showTableRows}
376 >
377 Add
378 </SecondaryButton>
379 ),
380 },
381 {
382 key: 8,
383 element: (
384 <PaginationLayout
385 list={props.groups}
386 paginationData={paginationData}
387 widgetId="pagination-options-menu-top"
388 isCompact={true}
389 />
390 ),
391 toolbarItemAlignment: { default: "alignEnd" },
392 },
393 ];
394
395 // Render component
396 return (
397 <PageSection hasBodyWrapper={false} isFilled={false}>
398 <ToolbarLayout
399 className="pf-v6-u-pt-0 pf-v6-u-pr-md"
400 contentClassName="pf-v6-u-p-0"
401 toolbarItems={toolbarItems}
402 />
403 <div className="pf-v6-u-ml-md pf-v6-u-mr-md">
404 <OuterScrollContainer>
405 <InnerScrollContainer>
406 {batchError !== undefined && batchError ? (
407 <GlobalErrors errors={globalErrors.getAll()} />
408 ) : (
409 <IDViewsOverrideGroupsTable
410 elementsList={groupsList}
411 shownElementsList={groupsList}
412 showTableRows={showTableRows}
413 overrideEntryData={groupsTableData}
414 buttonsData={viewsTableButtonsData}
415 paginationData={selectedPerPageData}
416 />
417 )}
418 </InnerScrollContainer>
419 </OuterScrollContainer>
420 </div>
421 <PaginationLayout
422 list={groupsList}
423 paginationData={paginationData}
424 variant={PaginationVariant.bottom}
425 widgetId="pagination-options-menu-bottom"
426 className="pf-v6-u-pb-0 pf-v6-u-pr-md"
427 />
428 <AddIdOverrideGroupModal
429 show={showAddModal}
430 idview={props.idview}
431 groups={groupsList}
432 handleModalToggle={onAddModalToggle}
433 onOpenAddModal={onAddClickHandler}
434 onCloseAddModal={onCloseAddModal}
435 onRefresh={onRefresh}
436 />
437 <DeleteIdOverrideGroupsModal
438 show={showDeleteModal}
439 idview={props.idview}
440 handleModalToggle={onDeleteModalToggle}
441 selectedData={selectedData}
442 buttonsData={deleteGroupsButtonsData}
443 onRefresh={onRefresh}
444 />
445 </PageSection>
446 );
447 };
448
449 export default IDViewsOverrideGroups;