Debian Codegraph @

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

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