Debian Codegraph @

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

raw
1 import React, { useEffect, useState } from "react";
2 import { Td, Th, Tr } from "@patternfly/react-table";
3 // Layout
4 import SettingsTableLayout from "src/components/layouts/SettingsTableLayout";
5 // Modals
6 import DualListLayout from "src/components/layouts/DualListLayout";
7 import RemoveHBACRuleMembersModal from "src/components/modals/HbacModals/RemoveHBACRuleMembers";
8 // Redux
9 import { useAppDispatch } from "src/store/hooks";
10 // Hooks
11 import { addAlert } from "src/store/Global/alerts-slice";
12 // React Router DOM
13 import { Link } from "react-router";
14 // RPC
15 import { ErrorResult } from "../../services/rpc";
16 import {
17 useRemoveMembersFromHbacRuleMutation,
18 useAddMembersToHbacRuleMutation,
19 } from "../../services/rpcHBACRules";
20
21 // These name spaces can be reused as the params to RPC (do not change them)
22 interface PropsToTable {
23 from: "user" | "group" | "host" | "hostgroup" | "hbacsvc" | "hbacsvcgroup";
24 id: string;
25 members: string[];
26 fromLabel?: string;
27 onRefresh: () => void;
28 unsetCategory: boolean;
29 }
30
31 const HBACRulesMemberTable = (props: PropsToTable) => {
32 const dispatch = useAppDispatch();
33
34 const [addMemberToHbacRule] = useAddMembersToHbacRuleMutation();
35 const [removeMembersFromHbacRule] = useRemoveMembersFromHbacRuleMutation();
36
37 const [members, setMembers] = useState(props.members);
38 const [tableMembers, setTableMembers] = useState<string[]>([]);
39 const [selectedMembers, setSelectedMembers] = useState<string[]>([]);
40 const [searchValue, setSearchValue] = useState<string>("");
41 const [deleteSpinning, setDeleteSpinning] = useState<boolean>(false);
42 const [addSpinning, setAddSpinning] = useState<boolean>(false);
43
44 // URL handling
45 let entryURL = "";
46 if (props.from === "user") {
47 entryURL = "/active-users/";
48 } else if (props.from === "group") {
49 entryURL = "/user-groups/";
50 } else if (props.from === "host") {
51 entryURL = "/hosts/";
52 } else if (props.from === "hostgroup") {
53 entryURL = "/host-groups/";
54 } else if (props.from === "hbacsvc") {
55 entryURL = "/hbac-services/";
56 } else {
57 // "servicegroup"
58 entryURL = "/hbac-service-groups/";
59 }
60
61 // PaginationPrep
62 const [page, setPage] = useState<number>(1);
63 const [perPage, setPerPage] = useState<number>(5);
64 const [totalCount, setMemberTotalCount] = useState<number>(
65 props.members.length
66 );
67 const updateSelectedPerPage = () => {
68 // Nothing to do since we are not using bulk selector comp
69 return;
70 };
71 const updatePage = (newPage: number) => {
72 setPage(newPage);
73 };
74 const updatePerPage = (newSetPerPage: number) => {
75 setPerPage(newSetPerPage);
76 };
77
78 const resetEntries = () => {
79 const firstIdx = (page - 1) * perPage;
80 const lastIdx = page * perPage;
81 const memberList: string[] = [];
82 for (
83 let i = firstIdx;
84 i < props.members.length && memberList.length < lastIdx;
85 i++
86 ) {
87 memberList.push(props.members[i]);
88 }
89 memberList.sort();
90 setMemberTotalCount(props.members.length);
91 setSelectedMembers([]);
92 setTableMembers(memberList);
93 };
94
95 // Page indexes
96 useEffect(() => {
97 resetEntries();
98 }, [page, perPage, props.members]);
99
100 const onSearchChange = (value: string) => {
101 if (value === "") {
102 // Reset page will reset member list
103 setPage(1);
104 return;
105 }
106
107 // Filter our current list
108 const firstIdx = (page - 1) * perPage;
109 const lastIdx = page * perPage;
110 const memberList: string[] = [];
111 let count = 0;
112 for (let i = firstIdx; i < props.members.length && count < lastIdx; i++) {
113 if (props.members[i].toLowerCase().includes(value.toLowerCase())) {
114 memberList.push(props.members[i]);
115 count += 1;
116 }
117 }
118 memberList.sort();
119 setSelectedMembers([]);
120 setTableMembers(memberList);
121 };
122
123 const addMembers = (newMembers: string[]) => {
124 setAddSpinning(true);
125 addMemberToHbacRule([
126 props.id,
127 props.from,
128 newMembers,
129 props.unsetCategory,
130 ]).then((response) => {
131 if ("data" in response) {
132 const results = response.data?.result.results;
133 for (const result in results) {
134 if (results[result].error) {
135 dispatch(
136 addAlert({
137 name: "add-member-error",
138 title: results[result].error,
139 variant: "danger",
140 })
141 );
142 setAddSpinning(false);
143 return;
144 }
145 }
146 // Update displayed members before they are updated via refresh
147 const newRuleMembers = members.concat(newMembers);
148 setMembers(newRuleMembers);
149 setSearchValue("");
150 // Set alert: success
151 dispatch(
152 addAlert({
153 name: "add-member-success",
154 title:
155 "Added " +
156 (props.fromLabel ? props.fromLabel : props.from) +
157 " to HBAC rule",
158 variant: "success",
159 })
160 );
161 props.onRefresh();
162 setAddSpinning(false);
163 setShowAddModal(false);
164 setPage(1);
165 }
166 });
167 };
168
169 const removeMembers = (selectedMembers: string[]) => {
170 setDeleteSpinning(true);
171
172 removeMembersFromHbacRule([props.id, props.from, selectedMembers]).then(
173 (response) => {
174 if ("data" in response) {
175 if (response.data?.result) {
176 // Set alert: success
177 dispatch(
178 addAlert({
179 name: "remove-member-success",
180 title:
181 "Removed " +
182 (props.fromLabel ? props.fromLabel : props.from) +
183 " from HBAC rule " +
184 props.id,
185 variant: "success",
186 })
187 );
188 // Update displayed members
189 const newNembers = members.filter(
190 (entry) => !selectedMembers.includes(entry)
191 );
192 setMembers(newNembers);
193 // Close modal
194 setShowDeleteModal(false);
195 setSearchValue("");
196 // Refresh
197 props.onRefresh();
198 // Go back to page 1
199 setPage(1);
200 } else if (response.data?.error) {
201 // Set alert: error
202 const errorMessage = response.data.error as unknown as ErrorResult;
203 dispatch(
204 addAlert({
205 name: "remove-member-error",
206 title: errorMessage.message,
207 variant: "danger",
208 })
209 );
210 }
211 }
212 setDeleteSpinning(false);
213 }
214 );
215 };
216
217 // 'Delete' button is disabled if no row is selected
218 const [isDeleteDisabled, setIsDeleteDisabled] = useState(true);
219
220 // Column names (String)
221 let columnNamesArray: string[] = [];
222 if (props.fromLabel) {
223 columnNamesArray = [props.fromLabel];
224 } else {
225 const columnName = props.from.charAt(0).toUpperCase() + props.from.slice(1);
226 columnNamesArray = [columnName];
227 }
228
229 // To allow shift+click to select/deselect multiple rows
230 const [recentSelectedRowIndex, setRecentSelectedRowIndex] = useState<
231 number | null
232 >(null);
233 const [shifting, setShifting] = useState(false);
234
235 // Keyboard event to select rows
236 useEffect(() => {
237 const onKeyDown = (e: KeyboardEvent) => {
238 if (e.key === "Shift") {
239 setShifting(true);
240 }
241 };
242 const onKeyUp = (e: KeyboardEvent) => {
243 if (e.key === "Shift") {
244 setShifting(false);
245 }
246 };
247
248 document.addEventListener("keydown", onKeyDown);
249 document.addEventListener("keyup", onKeyUp);
250
251 return () => {
252 document.removeEventListener("keydown", onKeyDown);
253 document.removeEventListener("keyup", onKeyUp);
254 };
255 }, []);
256
257 // - Returns 'True' if a specific table entry has been selected
258 const isEntrySelected = (user: string) => selectedMembers.includes(user);
259
260 const areAllEntriesSelected =
261 selectedMembers.length === tableMembers.length && tableMembers.length !== 0;
262
263 // - Select all entries
264 const selectAllUsers = (isSelecting = true) => {
265 setSelectedMembers(isSelecting ? tableMembers : []);
266 setIsDeleteDisabled(isSelecting ? false : true);
267 };
268
269 // - Helper method to set the selected entry from the table
270 const setMemberSelected = (member: string, isSelecting = true) =>
271 setSelectedMembers((prevSelected) => {
272 const otherSelectedMembers = prevSelected.filter((r) => r !== member);
273 return isSelecting
274 ? [...otherSelectedMembers, member]
275 : otherSelectedMembers;
276 });
277
278 // - On selecting one single row
279 const onSelectMember = (
280 member: string,
281 rowIndex: number,
282 isSelecting: boolean
283 ) => {
284 // If the element is shift + selecting the checkboxes, then all intermediate checkboxes should be selected
285 if (shifting && recentSelectedRowIndex !== null) {
286 const numberSelected = rowIndex - recentSelectedRowIndex;
287 const intermediateIndexes =
288 numberSelected > 0
289 ? Array.from(
290 new Array(numberSelected + 1),
291 (_x, i) => i + recentSelectedRowIndex
292 )
293 : Array.from(
294 new Array(Math.abs(numberSelected) + 1),
295 (_x, i) => i + rowIndex
296 );
297 intermediateIndexes.forEach((index) =>
298 setMemberSelected(member[index], isSelecting)
299 );
300 } else {
301 setMemberSelected(member, isSelecting);
302 }
303 setRecentSelectedRowIndex(rowIndex);
304 // Enable 'Delete' button
305 setIsDeleteDisabled(false);
306 };
307
308 // Disable 'Delete' button when no elements selected
309 useEffect(() => {
310 if (selectedMembers.length === 0) {
311 setIsDeleteDisabled(true);
312 }
313 }, [selectedMembers]);
314
315 // Entries displayed on the first page
316 const updateShownEntriesList = (newShownEntriesList: string[]) => {
317 setTableMembers(newShownEntriesList);
318 };
319
320 const paginationData = {
321 page,
322 perPage,
323 updatePage,
324 updatePerPage,
325 updateSelectedPerPage,
326 updateShownElementsList: updateShownEntriesList,
327 totalCount,
328 };
329
330 // Header
331 const header = (
332 <Tr>
333 <Th
334 select={{
335 onSelect: (_event, isSelecting) => selectAllUsers(isSelecting),
336 isSelected: areAllEntriesSelected,
337 isDisabled: tableMembers.length === 0 ? true : false,
338 }}
339 />
340 <Th width={10}>{columnNamesArray[0]}</Th>
341 </Tr>
342 );
343
344 // Body
345 const body = tableMembers.map((entry, rowIndex) => (
346 <Tr key={entry} id={entry}>
347 <Td
348 dataLabel="checkbox"
349 select={{
350 rowIndex,
351 onSelect: (_event, isSelecting) =>
352 onSelectMember(entry, rowIndex, isSelecting),
353 isSelected: isEntrySelected(entry),
354 isDisabled: false,
355 }}
356 />
357 <Td dataLabel={columnNamesArray[0]}>
358 <Link to={entryURL + entry} state={tableMembers[rowIndex]}>
359 {entry}
360 </Link>
361 </Td>
362 </Tr>
363 ));
364
365 // Modal functionality
366 // - Show modals
367 const [showAddModal, setShowAddModal] = useState(false);
368 const [showDeleteModal, setShowDeleteModal] = useState(false);
369
370 // - Close 'Add' modal
371 const onCloseAddHandler = () => {
372 setShowAddModal(false);
373 };
374
375 // - close 'Delete' button
376 const onCloseDeleteHandler = () => {
377 setShowDeleteModal(false);
378 };
379
380 // - 'Add' button -> Open modal
381 const onClickAddHandler = () => {
382 setShowAddModal(true);
383 };
384
385 // - 'Delete' button -> Remove table entry
386 const onClickDeleteHandler = () => {
387 setShowDeleteModal(true);
388 };
389
390 return (
391 <div className="pf-v6-u-mr-md pf-v6-u-ml-xl">
392 <SettingsTableLayout
393 ariaLabel={props.from + " table in HBAC rules"}
394 variant="compact"
395 hasBorders={true}
396 name={props.from}
397 tableId={props.from + "-table"}
398 isStickyHeader={false}
399 tableHeader={header}
400 tableBody={body}
401 onDeleteModal={onClickDeleteHandler}
402 isDeleteDisabled={isDeleteDisabled}
403 onAddModal={onClickAddHandler}
404 onSearchChange={onSearchChange}
405 searchValue={searchValue}
406 paginationData={paginationData}
407 list={props.members}
408 entryType={props.fromLabel ? props.fromLabel : props.from}
409 />
410 <DualListLayout
411 entry={props.id}
412 target={props.from}
413 title={
414 "Add " +
415 (props.fromLabel ? props.fromLabel : props.from) +
416 "s to HBAC rule"
417 }
418 showModal={showAddModal}
419 onCloseModal={onCloseAddHandler}
420 onOpenModal={onClickAddHandler}
421 action={addMembers}
422 spinning={addSpinning}
423 addBtnName="Add"
424 addSpinningBtnName="Adding"
425 tableElementsList={tableMembers}
426 />
427 {showDeleteModal && (
428 <RemoveHBACRuleMembersModal
429 elementType={props.from}
430 label={props.fromLabel}
431 showModal={showDeleteModal}
432 closeModal={onCloseDeleteHandler}
433 elementsToDelete={selectedMembers}
434 removeMembers={removeMembers}
435 spinning={deleteSpinning}
436 />
437 )}
438 </div>
439 );
440 };
441
442 export default HBACRulesMemberTable;