Debian Codegraph @

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

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