Debian Codegraph @

install/freeipa-webui/src/pages/PreservedUsers/PreservedUsers.tsx

raw
1 import React, { useEffect, useState } from "react";
2 // PatternFly
3 import {
4 PaginationVariant,
5 PageSection,
6 ToolbarItemVariant,
7 Flex,
8 FlexItem,
9 } from "@patternfly/react-core";
10 // PatternFly table
11 import {
12 InnerScrollContainer,
13 OuterScrollContainer,
14 } from "@patternfly/react-table";
15 // Data types
16 import { User } from "src/utils/datatypes/globalDataTypes";
17 import { ToolbarItem } from "src/components/layouts/ToolbarLayout";
18 // Redux
19 import { useAppSelector, useAppDispatch } from "src/store/hooks";
20 // Layouts
21 import TitleLayout from "src/components/layouts/TitleLayout";
22 import HelpTextWithIconLayout from "src/components/layouts/HelpTextWithIconLayout";
23 import SecondaryButton from "src/components/layouts/SecondaryButton";
24 import ToolbarLayout from "src/components/layouts/ToolbarLayout";
25 import SearchInputLayout from "src/components/layouts/SearchInputLayout";
26 // Tables
27 import UsersTable from "../../components/tables/UsersTable";
28 // Components
29 import PaginationLayout from "src/components/layouts/PaginationLayout";
30 import BulkSelectorPrep from "src/components/BulkSelectorPrep";
31 import ContextualHelpPanel from "src/components/ContextualHelpPanel/ContextualHelpPanel";
32 // Modals
33 import DeleteUsers from "src/components/modals/UserModals/DeleteUsers";
34 import StagePreservedUsers from "src/components/modals/UserModals/StagePreservedUsers";
35 import RestorePreservedUsers from "src/components/modals/UserModals/RestorePreservedUsers";
36 // Hooks
37 import { addAlert } from "src/store/Global/alerts-slice";
38 import useUpdateRoute from "src/hooks/useUpdateRoute";
39 import useListPageSearchParams from "src/hooks/useListPageSearchParams";
40 // Errors
41 import { FetchBaseQueryError } from "@reduxjs/toolkit/query";
42 import { SerializedError } from "@reduxjs/toolkit";
43 // Utils
44 import { API_VERSION_BACKUP, isUserSelectable } from "src/utils/utils";
45 import { GenericPayload, useSearchEntriesMutation } from "../../services/rpc";
46 import { useGettingPreservedUserQuery } from "../../services/rpcUsers";
47 import useApiError from "src/hooks/useApiError";
48 import GlobalErrors from "src/components/errors/GlobalErrors";
49 import ModalErrors from "src/components/errors/ModalErrors";
50
51 const PreservedUsers = () => {
52 const dispatch = useAppDispatch();
53
54 // URL parameters: page number, page size, search value
55 const { page, setPage, perPage, setPerPage, searchValue, setSearchValue } =
56 useListPageSearchParams();
57
58 // Update current route data to Redux and highlight the current page in the Nav bar
59 const { browserTitle } = useUpdateRoute({ pathname: "preserved-users" });
60
61 // Set the page title to be shown in the browser tab
62 React.useEffect(() => {
63 document.title = browserTitle;
64 }, [browserTitle]);
65
66 // Retrieve API version from environment data
67 const apiVersion = useAppSelector(
68 (state) => state.global.environment.api_version
69 ) as string;
70
71 // Preservered users list
72 const [preservedUsersList, setPreservedUsersList] = useState<User[]>([]);
73
74 // Handle API calls errors
75 const globalErrors = useApiError([]);
76 const modalErrors = useApiError([]);
77
78 // Main states - what user can define / what we could use in page URL
79 const [totalCount, setUsersTotalCount] = useState<number>(0);
80 const [searchDisabled, setSearchIsDisabled] = useState<boolean>(false);
81
82 // Page indexes
83 const firstUserIdx = (page - 1) * perPage;
84 const lastUserIdx = page * perPage;
85
86 // Derived states - what we get from API
87 const userDataResponse = useGettingPreservedUserQuery({
88 searchValue: searchValue,
89 sizeLimit: 0,
90 apiVersion: apiVersion || API_VERSION_BACKUP,
91 startIdx: firstUserIdx,
92 stopIdx: lastUserIdx,
93 } as GenericPayload);
94
95 const {
96 data: batchResponse,
97 isLoading: isBatchLoading,
98 error: batchError,
99 } = userDataResponse;
100
101 // Handle data when the API call is finished
102 useEffect(() => {
103 if (userDataResponse.isFetching) {
104 setShowTableRows(false);
105 // Reset selected users on refresh
106 setUsersTotalCount(0);
107 globalErrors.clear();
108 return;
109 }
110
111 // API response: Success
112 if (
113 userDataResponse.isSuccess &&
114 userDataResponse.data &&
115 batchResponse !== undefined
116 ) {
117 const usersListResult = batchResponse.result.results;
118 const usersListSize = batchResponse.result.count;
119 const totalCount = batchResponse.result.totalCount;
120 const usersList: User[] = [];
121
122 for (let i = 0; i < usersListSize; i++) {
123 usersList.push(usersListResult[i].result);
124 }
125
126 setUsersTotalCount(totalCount);
127 // Update the list of users
128 setPreservedUsersList(usersList);
129 // Show table elements
130 setShowTableRows(true);
131 }
132
133 // API response: Error
134 if (
135 !userDataResponse.isLoading &&
136 userDataResponse.isError &&
137 userDataResponse.error !== undefined
138 ) {
139 // This normally happens when the user is not authorized to view the data
140 // So instead of adding an error, refresh page
141 window.location.reload();
142 }
143 }, [userDataResponse]);
144
145 // Refresh button handling
146 const refreshUsersData = () => {
147 // Hide table
148 setShowTableRows(false);
149
150 // Reset selected users on refresh
151 setUsersTotalCount(0);
152 clearSelectedUsers();
153
154 userDataResponse.refetch();
155 };
156
157 // Always refetch data when the component is loaded.
158 // This ensures the data is always up-to-date.
159 React.useEffect(() => {
160 userDataResponse.refetch();
161 }, []);
162
163 // 'Delete' button state
164 const [isDeleteButtonDisabled, setIsDeleteButtonDisabled] =
165 useState<boolean>(true);
166
167 const updateIsDeleteButtonDisabled = (value: boolean) => {
168 setIsDeleteButtonDisabled(value);
169 };
170
171 // If some entries have been deleted, restore the selectedUsers list
172 const [isDeletion, setIsDeletion] = useState(false);
173
174 const updateIsDeletion = (value: boolean) => {
175 setIsDeletion(value);
176 };
177
178 // Elements selected (per page)
179 // - This will help to calculate the remaining elements on a specific page (bulk selector)
180 const [selectedPerPage, setSelectedPerPage] = useState<number>(0);
181
182 const updateSelectedPerPage = (selected: number) => {
183 setSelectedPerPage(selected);
184 };
185
186 // Pagination
187 const updatePage = (newPage: number) => {
188 setPage(newPage);
189 };
190
191 const updatePerPage = (newSetPerPage: number) => {
192 setPerPage(newSetPerPage);
193 };
194
195 // Users displayed on the first page
196 const updateShownUsersList = (newShownUsersList: User[]) => {
197 setPreservedUsersList(newShownUsersList);
198 };
199
200 // Filter (Input search)
201 const updateSearchValue = (value: string) => {
202 setSearchValue(value);
203 };
204
205 // Issue search with filter
206 const [retrieveUser] = useSearchEntriesMutation({});
207
208 // Issue a search using a specific search value
209 const submitSearchValue = () => {
210 setShowTableRows(false);
211 setUsersTotalCount(0);
212 setSearchIsDisabled(true);
213
214 retrieveUser({
215 searchValue: searchValue,
216 sizeLimit: 0,
217 apiVersion: apiVersion || API_VERSION_BACKUP,
218 startIdx: firstUserIdx,
219 stopIdx: lastUserIdx,
220 entryType: "preserved",
221 } as GenericPayload).then((result) => {
222 // Manage new response here
223 if ("data" in result) {
224 const searchError = result.data?.error as
225 | FetchBaseQueryError
226 | SerializedError;
227
228 if (searchError) {
229 // Error
230 let error: string | undefined = "";
231 if ("error" in searchError) {
232 error = searchError.error;
233 } else if ("message" in searchError) {
234 error = searchError.message;
235 }
236 dispatch(
237 addAlert({
238 name: "submit-search-value-error",
239 title: error || "Error when searching for preserved users",
240 variant: "danger",
241 })
242 );
243 } else {
244 // Success
245 const usersListResult = result.data?.result.results || [];
246 const usersListSize = result.data?.result.count || 0;
247 const totalCount = result.data?.result.totalCount || 0;
248 const usersList: User[] = [];
249
250 for (let i = 0; i < usersListSize; i++) {
251 usersList.push(usersListResult[i].result);
252 }
253
254 setPreservedUsersList(usersList);
255 setUsersTotalCount(totalCount);
256 // Show table elements
257 setShowTableRows(true);
258 }
259 setSearchIsDisabled(false);
260 }
261 });
262 };
263
264 // Show table rows
265 const [showTableRows, setShowTableRows] = useState(!isBatchLoading);
266
267 // Show table rows only when data is fully retrieved
268 useEffect(() => {
269 if (showTableRows !== !isBatchLoading) {
270 setShowTableRows(!isBatchLoading);
271 }
272 }, [isBatchLoading]);
273
274 // Table-related shared functionality
275 // - Selectable checkboxes on table
276 const selectableUsersTable = preservedUsersList.filter(isUserSelectable); // elements per Table
277
278 const [selectedUsers, setSelectedUsers] = useState<User[]>([]);
279 const clearSelectedUsers = () => {
280 const emptyList: User[] = [];
281 setSelectedUsers(emptyList);
282 };
283
284 const updateSelectedUsers = (users: User[], isSelected: boolean) => {
285 let newSelectedUsers: User[] = [];
286 if (isSelected) {
287 newSelectedUsers = JSON.parse(JSON.stringify(selectedUsers));
288 for (let i = 0; i < users.length; i++) {
289 if (
290 selectedUsers.find(
291 (selectedUser) => selectedUser.uid[0] === users[i].uid[0]
292 )
293 ) {
294 // Already in the list
295 continue;
296 }
297 // Add user to list
298 newSelectedUsers.push(users[i]);
299 }
300 } else {
301 // Remove user
302 for (let i = 0; i < selectedUsers.length; i++) {
303 let found = false;
304 for (let ii = 0; ii < users.length; ii++) {
305 if (selectedUsers[i].uid[0] === users[ii].uid[0]) {
306 found = true;
307 break;
308 }
309 }
310 if (!found) {
311 // Keep this valid selected entry
312 newSelectedUsers.push(selectedUsers[i]);
313 }
314 }
315 }
316 setSelectedUsers(newSelectedUsers);
317 setIsDeleteButtonDisabled(newSelectedUsers.length === 0);
318 };
319
320 // - Helper method to set the selected users from the table
321 const setUserSelected = (user: User, isSelecting = true) => {
322 if (isUserSelectable(user)) {
323 updateSelectedUsers([user], isSelecting);
324 }
325 };
326
327 // Modals functionality
328 const [showDeleteModal, setShowDeleteModal] = useState(false);
329 const [showRestoreModal, setShowRestoreModal] = useState(false);
330 const [showStageModal, setShowStageModal] = useState(false);
331 const onDeleteHandler = () => {
332 setShowDeleteModal(true);
333 };
334 const onDeleteModalToggle = () => {
335 setShowDeleteModal(!showDeleteModal);
336 };
337 const onRestoreHandler = () => {
338 setShowRestoreModal(true);
339 };
340 const onRestoreModalToggle = () => {
341 setShowRestoreModal(!showRestoreModal);
342 };
343 const onStageHandler = () => {
344 setShowStageModal(true);
345 };
346 const onStageModalToggle = () => {
347 setShowStageModal(!showStageModal);
348 };
349
350 // Data wrappers
351 // - 'PaginationLayout'
352 const paginationData = {
353 page,
354 perPage,
355 updatePage,
356 updatePerPage,
357 updateSelectedPerPage,
358 updateShownElementsList: updateShownUsersList,
359 totalCount,
360 };
361
362 // - 'BulkSelectorPrep'
363 const usersBulkSelectorData = {
364 selected: selectedUsers,
365 updateSelected: updateSelectedUsers,
366 selectableTable: selectableUsersTable,
367 nameAttr: "uid",
368 };
369
370 const buttonsData = {
371 isDeleteButtonDisabled,
372 updateIsDeleteButtonDisabled,
373 };
374
375 const selectedPerPageData = {
376 selectedPerPage,
377 updateSelectedPerPage,
378 };
379
380 // 'DeleteUsers'
381 const deleteUsersButtonsData = {
382 updateIsDeleteButtonDisabled,
383 updateIsDeletion,
384 };
385
386 const selectedUsersData = {
387 selectedUsers,
388 clearSelectedUsers,
389 };
390
391 // 'UsersTable'
392 const usersTableData = {
393 isUserSelectable,
394 selectedUsers,
395 selectableUsersTable,
396 setUserSelected,
397 clearSelectedUsers,
398 };
399
400 const usersTableButtonsData = {
401 updateIsDeleteButtonDisabled,
402 isDeletion,
403 updateIsDeletion,
404 };
405
406 // SearchInputLayout
407 const searchValueData = {
408 searchValue,
409 updateSearchValue,
410 submitSearchValue,
411 };
412
413 // Contextual links panel
414 const [isContextualPanelExpanded, setIsContextualPanelExpanded] =
415 React.useState(false);
416
417 const onOpenContextualPanel = () => {
418 setIsContextualPanelExpanded(!isContextualPanelExpanded);
419 };
420
421 const onCloseContextualPanel = () => {
422 setIsContextualPanelExpanded(false);
423 };
424
425 // List of Toolbar items
426 const toolbarItems: ToolbarItem[] = [
427 {
428 key: 0,
429 element: (
430 <BulkSelectorPrep
431 list={preservedUsersList}
432 shownElementsList={preservedUsersList}
433 elementData={usersBulkSelectorData}
434 buttonsData={buttonsData}
435 selectedPerPageData={selectedPerPageData}
436 />
437 ),
438 },
439 {
440 key: 1,
441 element: (
442 <SearchInputLayout
443 dataCy="search"
444 name="search"
445 ariaLabel="Search user"
446 placeholder="Search"
447 searchValueData={searchValueData}
448 isDisabled={searchDisabled}
449 />
450 ),
451 toolbarItemVariant: ToolbarItemVariant.label,
452 toolbarItemGap: { default: "gapMd" },
453 },
454 {
455 key: 2,
456 toolbarItemVariant: ToolbarItemVariant.separator,
457 },
458 {
459 key: 3,
460 element: (
461 <SecondaryButton
462 onClickHandler={refreshUsersData}
463 isDisabled={!showTableRows}
464 dataCy="preserved-users-button-refresh"
465 >
466 Refresh
467 </SecondaryButton>
468 ),
469 },
470 {
471 key: 4,
472 element: (
473 <SecondaryButton
474 isDisabled={isDeleteButtonDisabled || !showTableRows}
475 onClickHandler={onDeleteHandler}
476 dataCy="preserved-users-button-delete"
477 >
478 Delete
479 </SecondaryButton>
480 ),
481 },
482 {
483 key: 5,
484 element: (
485 <SecondaryButton
486 isDisabled={!showTableRows || selectedUsers.length === 0}
487 onClickHandler={onRestoreHandler}
488 dataCy="preserved-users-button-restore"
489 >
490 Restore
491 </SecondaryButton>
492 ),
493 },
494 {
495 key: 6,
496 element: (
497 <SecondaryButton
498 isDisabled={!showTableRows || selectedUsers.length === 0}
499 onClickHandler={onStageHandler}
500 dataCy="preserved-users-button-stage"
501 >
502 Stage
503 </SecondaryButton>
504 ),
505 },
506 {
507 key: 7,
508 toolbarItemVariant: ToolbarItemVariant.separator,
509 },
510 {
511 key: 8,
512 element: (
513 <HelpTextWithIconLayout
514 textContent="Help"
515 onClick={onOpenContextualPanel}
516 />
517 ),
518 },
519 {
520 key: 9,
521 element: (
522 <PaginationLayout
523 list={preservedUsersList}
524 paginationData={paginationData}
525 widgetId="pagination-options-menu-top"
526 isCompact={true}
527 />
528 ),
529 toolbarItemAlignment: { default: "alignEnd" },
530 },
531 ];
532
533 // Render 'Preserved users'
534 return (
535 <ContextualHelpPanel
536 fromPage="preserved-users"
537 isExpanded={isContextualPanelExpanded}
538 onClose={onCloseContextualPanel}
539 >
540 <div>
541 <PageSection hasBodyWrapper={false}>
542 <TitleLayout
543 id="preserved users title"
544 headingLevel="h1"
545 text="Preserved users"
546 />
547 </PageSection>
548 <PageSection hasBodyWrapper={false} isFilled={false}>
549 <Flex direction={{ default: "column" }}>
550 <FlexItem>
551 <ToolbarLayout toolbarItems={toolbarItems} />
552 </FlexItem>
553 <FlexItem style={{ flex: "0 0 auto" }}>
554 <OuterScrollContainer>
555 <InnerScrollContainer
556 style={{ height: "60vh", overflow: "auto" }}
557 >
558 {batchError !== undefined && batchError ? (
559 <GlobalErrors errors={globalErrors.getAll()} />
560 ) : (
561 <UsersTable
562 shownElementsList={preservedUsersList}
563 from="preserved-users"
564 showTableRows={showTableRows}
565 usersData={usersTableData}
566 buttonsData={usersTableButtonsData}
567 paginationData={selectedPerPageData}
568 searchValue={searchValue}
569 />
570 )}
571 </InnerScrollContainer>
572 </OuterScrollContainer>
573 </FlexItem>
574 <FlexItem
575 style={{ flex: "0 0 auto", position: "sticky", bottom: 0 }}
576 >
577 <PaginationLayout
578 list={preservedUsersList}
579 paginationData={paginationData}
580 variant={PaginationVariant.bottom}
581 widgetId="pagination-options-menu-bottom"
582 />
583 </FlexItem>
584 </Flex>
585 </PageSection>
586 <ModalErrors
587 errors={modalErrors.getAll()}
588 dataCy="preserved-users-modal-error"
589 />
590 <DeleteUsers
591 show={showDeleteModal}
592 from="preserved-users"
593 handleModalToggle={onDeleteModalToggle}
594 selectedUsersData={selectedUsersData}
595 buttonsData={deleteUsersButtonsData}
596 onRefresh={refreshUsersData}
597 />
598 <RestorePreservedUsers
599 show={showRestoreModal}
600 handleModalToggle={onRestoreModalToggle}
601 selectedUsers={selectedUsers}
602 clearSelectedUsers={clearSelectedUsers}
603 onSuccess={refreshUsersData}
604 />
605 <StagePreservedUsers
606 show={showStageModal}
607 handleModalToggle={onStageModalToggle}
608 selectedUsers={selectedUsers}
609 clearSelectedUsers={clearSelectedUsers}
610 onSuccess={refreshUsersData}
611 />
612 </div>
613 </ContextualHelpPanel>
614 );
615 };
616
617 export default PreservedUsers;