Debian Codegraph @

install/freeipa-webui/src/pages/Netgroups/NetgroupsMemberTable.tsx

raw
1 import React, { useEffect, useState } from "react";
2 // PatternFly
3 import {
4 Button,
5 Form,
6 FormGroup,
7 Modal,
8 ModalBody,
9 ModalFooter,
10 ModalHeader,
11 } from "@patternfly/react-core";
12 import { Td, Th, Tr } from "@patternfly/react-table";
13 // Layout
14 import SettingsTableLayout from "src/components/layouts/SettingsTableLayout";
15 // Modals
16 import DualListLayout from "src/components/layouts/DualListLayout";
17 import RemoveNetgroupMembersModal from "src/components/modals/RemoveNetgroupMembers";
18 // Redux
19 import { useAppDispatch } from "src/store/hooks";
20 // Hooks
21 import { addAlert } from "src/store/Global/alerts-slice";
22 // React Router DOM
23 import { Link } from "react-router";
24 import { Netgroup } from "../../utils/datatypes/globalDataTypes";
25 // RPC
26 import { ErrorResult } from "../../services/rpc";
27 import {
28 useSaveNetgroupMutation,
29 useAddMemberToNetgroupsMutation,
30 useRemoveMemberFromNetgroupsMutation,
31 } from "../../services/rpcNetgroups";
32 import InputWithValidation from "src/components/layouts/InputWithValidation";
33
34 // These name spaces can be reused as the params to RPC (do not change them)
35 interface PropsToTable {
36 from: "user" | "group" | "host" | "hostgroup" | "netgroup" | "externalHost";
37 id: string;
38 members: string[];
39 fromLabel?: string;
40 onRefresh: () => void;
41 unsetCategory: boolean;
42 }
43
44 const NetgroupsMemberTable = (props: PropsToTable) => {
45 const dispatch = useAppDispatch();
46
47 const [saveNetgroup] = useSaveNetgroupMutation();
48 const [addMemberToNetgroups] = useAddMemberToNetgroupsMutation();
49 const [removeMembersFromNetgroups] = useRemoveMemberFromNetgroupsMutation();
50
51 const [members, setMembers] = useState(props.members);
52 const [tableMembers, setTableMembers] = useState<string[]>([]);
53 const [selectedMembers, setSelectedMembers] = useState<string[]>([]);
54 const [searchValue, setSearchValue] = useState<string>("");
55 const [deleteSpinning, setDeleteSpinning] = useState<boolean>(false);
56
57 // URL handling
58 let entryURL = "";
59 if (props.from === "user") {
60 entryURL = "/active-users/";
61 } else if (props.from === "group") {
62 entryURL = "/user-groups/";
63 } else if (props.from === "host") {
64 entryURL = "/hosts/";
65 } else if (props.from === "hostgroup") {
66 entryURL = "/host-groups/";
67 } else {
68 // external, handled differently
69 }
70
71 // PaginationPrep
72 const [page, setPage] = useState<number>(1);
73 const [perPage, setPerPage] = useState<number>(5);
74 const [totalCount, setMemberTotalCount] = useState<number>(
75 props.members.length
76 );
77 const updateSelectedPerPage = () => {
78 // Nothing to do since we are not using bulk selector comp
79 return;
80 };
81 const updatePage = (newPage: number) => {
82 setPage(newPage);
83 };
84 const updatePerPage = (newSetPerPage: number) => {
85 setPerPage(newSetPerPage);
86 };
87
88 // External host modal
89 const [externalHostName, setExternalHost] = useState<string>("");
90 const [addSpinning, setAddSpinning] = useState<boolean>(false);
91 const [modalOpen, setModalOpen] = useState<boolean>(false);
92 const openExternalModal = () => {
93 setExternalHost("");
94 setModalOpen(true);
95 };
96 const closeExternalModal = () => {
97 setModalOpen(false);
98 };
99
100 const resetEntries = () => {
101 const firstIdx = (page - 1) * perPage;
102 const lastIdx = page * perPage;
103 const memberList: string[] = [];
104 for (
105 let i = firstIdx;
106 i < props.members.length && memberList.length < lastIdx;
107 i++
108 ) {
109 memberList.push(props.members[i]);
110 }
111 memberList.sort();
112 setMemberTotalCount(props.members.length);
113 setSelectedMembers([]);
114 setTableMembers(memberList);
115 };
116
117 // Page indexes
118 useEffect(() => {
119 resetEntries();
120 }, [page, perPage, props.members]);
121
122 const onSearchChange = (value: string) => {
123 if (value === "") {
124 // Reset page will reset member list
125 setPage(1);
126 return;
127 }
128
129 // Filter our current list
130 const firstIdx = (page - 1) * perPage;
131 const lastIdx = page * perPage;
132 const memberList: string[] = [];
133 let count = 0;
134 for (let i = firstIdx; i < props.members.length && count < lastIdx; i++) {
135 if (props.members[i].toLowerCase().includes(value.toLowerCase())) {
136 memberList.push(props.members[i]);
137 count += 1;
138 }
139 }
140 memberList.sort();
141 setSelectedMembers([]);
142 setTableMembers(memberList);
143 };
144
145 const addMembers = (newMembers: string[]) => {
146 let type = props.from;
147 if (props.from === "externalHost") {
148 type = "host";
149 }
150 setAddSpinning(true);
151 addMemberToNetgroups([props.id, type, newMembers]).then((response) => {
152 if ("data" in response) {
153 if (response.data?.result) {
154 // Update displayed netgroups before they are updated via refresh
155 const newNetgroups = members.concat(newMembers);
156 setMembers(newNetgroups);
157 setSearchValue("");
158
159 if (props.unsetCategory) {
160 // Ok need to unset the category attribute via a nested update
161 const group: Partial<Netgroup> = {};
162 group.cn = props.id;
163 if (props.from === "user" || props.from === "group") {
164 group.usercategory = "";
165 } else {
166 group.hostcategory = "";
167 }
168 saveNetgroup(group).then((modResponse) => {
169 if ("data" in modResponse) {
170 if (modResponse.data?.error) {
171 const errorMessage = modResponse.data
172 .error as unknown as ErrorResult;
173 dispatch(
174 addAlert({
175 name: "update-netgroup-error",
176 title: errorMessage.message,
177 variant: "danger",
178 })
179 );
180 setAddSpinning(false);
181 return;
182 } else {
183 // Set alert: success
184 dispatch(
185 addAlert({
186 name: "update-success",
187 title: "Added " + props.from + " to netgroup",
188 variant: "success",
189 })
190 );
191 props.onRefresh();
192 setAddSpinning(false);
193 setShowAddModal(false);
194 closeExternalModal();
195 setPage(1);
196 }
197 }
198 });
199 } else {
200 // Set alert: success
201 dispatch(
202 addAlert({
203 name: "add-member-success",
204 title: "Added " + props.from + " to netgroup",
205 variant: "success",
206 })
207 );
208 props.onRefresh();
209 setAddSpinning(false);
210 setShowAddModal(false);
211 closeExternalModal();
212 setPage(1);
213 }
214 } else if (response.data?.error) {
215 // Set alert: error
216 const errorMessage = response.data.error as unknown as ErrorResult;
217 dispatch(
218 addAlert({
219 name: "add-member-error",
220 title: errorMessage.message,
221 variant: "danger",
222 })
223 );
224 setAddSpinning(false);
225 }
226 }
227 });
228 };
229
230 const removeMembers = (selectedMembers: string[]) => {
231 let type = props.from;
232 if (props.from === "externalHost") {
233 type = "host";
234 }
235 setDeleteSpinning(true);
236 removeMembersFromNetgroups([props.id, type, selectedMembers]).then(
237 (response) => {
238 if ("data" in response) {
239 if (response.data?.result) {
240 // Set alert: success
241 dispatch(
242 addAlert({
243 name: "remove-netgroups-success",
244 title: "Removed " + props.from + " from netgroup " + props.id,
245 variant: "success",
246 })
247 );
248 // Update displayed netgroups
249 const newNembers = members.filter(
250 (entry) => !selectedMembers.includes(entry)
251 );
252 setMembers(newNembers);
253 // Close modal
254 setShowDeleteModal(false);
255 setSearchValue("");
256 // Refresh
257 props.onRefresh();
258 // Go back to page 1
259 setPage(1);
260 } else if (response.data?.error) {
261 // Set alert: error
262 const errorMessage = response.data.error as unknown as ErrorResult;
263 dispatch(
264 addAlert({
265 name: "remove-netgroups-error",
266 title: errorMessage.message,
267 variant: "danger",
268 })
269 );
270 }
271 }
272 setDeleteSpinning(false);
273 }
274 );
275 };
276
277 // 'Delete' button is disabled if no row is selected
278 const [isDeleteDisabled, setIsDeleteDisabled] = useState(true);
279
280 // Column names (String)
281 let columnNamesArray: string[] = [];
282 if (props.fromLabel) {
283 columnNamesArray = [props.fromLabel];
284 } else {
285 const columnName = props.from.charAt(0).toUpperCase() + props.from.slice(1);
286 columnNamesArray = [columnName];
287 }
288
289 // To allow shift+click to select/deselect multiple rows
290 const [recentSelectedRowIndex, setRecentSelectedRowIndex] = useState<
291 number | null
292 >(null);
293 const [shifting, setShifting] = useState(false);
294
295 // Keyboard event to select rows
296 useEffect(() => {
297 const onKeyDown = (e: KeyboardEvent) => {
298 if (e.key === "Shift") {
299 setShifting(true);
300 }
301 };
302 const onKeyUp = (e: KeyboardEvent) => {
303 if (e.key === "Shift") {
304 setShifting(false);
305 }
306 };
307
308 document.addEventListener("keydown", onKeyDown);
309 document.addEventListener("keyup", onKeyUp);
310
311 return () => {
312 document.removeEventListener("keydown", onKeyDown);
313 document.removeEventListener("keyup", onKeyUp);
314 };
315 }, []);
316
317 // - Returns 'True' if a specific table entry has been selected
318 const isEntrySelected = (user: string) => selectedMembers.includes(user);
319
320 const areAllEntriesSelected =
321 selectedMembers.length === tableMembers.length && tableMembers.length !== 0;
322
323 // - Select all entries
324 const selectAllUsers = (isSelecting = true) => {
325 setSelectedMembers(isSelecting ? tableMembers : []);
326 setIsDeleteDisabled(isSelecting ? false : true);
327 };
328
329 // - Helper method to set the selected entry from the table
330 const setMemberSelected = (member: string, isSelecting = true) =>
331 setSelectedMembers((prevSelected) => {
332 const otherSelectedMembers = prevSelected.filter((r) => r !== member);
333 return isSelecting
334 ? [...otherSelectedMembers, member]
335 : otherSelectedMembers;
336 });
337
338 // - On selecting one single row
339 const onSelectMember = (
340 member: string,
341 rowIndex: number,
342 isSelecting: boolean
343 ) => {
344 // If the element is shift + selecting the checkboxes, then all intermediate checkboxes should be selected
345 if (shifting && recentSelectedRowIndex !== null) {
346 const numberSelected = rowIndex - recentSelectedRowIndex;
347 const intermediateIndexes =
348 numberSelected > 0
349 ? Array.from(
350 new Array(numberSelected + 1),
351 (_x, i) => i + recentSelectedRowIndex
352 )
353 : Array.from(
354 new Array(Math.abs(numberSelected) + 1),
355 (_x, i) => i + rowIndex
356 );
357 intermediateIndexes.forEach((index) =>
358 setMemberSelected(member[index], isSelecting)
359 );
360 } else {
361 setMemberSelected(member, isSelecting);
362 }
363 setRecentSelectedRowIndex(rowIndex);
364 // Enable 'Delete' button
365 setIsDeleteDisabled(false);
366 };
367
368 // Disable 'Delete' button when no elements selected
369 useEffect(() => {
370 if (selectedMembers.length === 0) {
371 setIsDeleteDisabled(true);
372 }
373 }, [selectedMembers]);
374
375 // Entries displayed on the first page
376 const updateShownEntriesList = (newShownEntriesList: string[]) => {
377 setTableMembers(newShownEntriesList);
378 };
379
380 const paginationData = {
381 page,
382 perPage,
383 updatePage,
384 updatePerPage,
385 updateSelectedPerPage,
386 updateShownElementsList: updateShownEntriesList,
387 totalCount,
388 };
389
390 // Header
391 const header = (
392 <Tr>
393 <Th
394 select={{
395 onSelect: (_event, isSelecting) => selectAllUsers(isSelecting),
396 isSelected: areAllEntriesSelected,
397 isDisabled: tableMembers.length === 0 ? true : false,
398 }}
399 />
400 <Th width={10}>{columnNamesArray[0]}</Th>
401 </Tr>
402 );
403
404 // Body
405 const body = tableMembers.map((entry, rowIndex) => (
406 <Tr key={entry} id={entry}>
407 <Td
408 dataLabel="checkbox"
409 select={{
410 rowIndex,
411 onSelect: (_event, isSelecting) =>
412 onSelectMember(entry, rowIndex, isSelecting),
413 isSelected: isEntrySelected(entry),
414 isDisabled: false,
415 }}
416 />
417 <Td dataLabel={columnNamesArray[0]}>
418 {props.from !== "externalHost" ? (
419 <Link to={entryURL + entry} state={tableMembers[rowIndex]}>
420 {entry}
421 </Link>
422 ) : (
423 entry
424 )}
425 </Td>
426 </Tr>
427 ));
428
429 // Modal functionality
430 // - Show modals
431 const [showAddModal, setShowAddModal] = useState(false);
432 const [showDeleteModal, setShowDeleteModal] = useState(false);
433
434 // - Close 'Add' modal
435 const onCloseAddHandler = () => {
436 setShowAddModal(false);
437 };
438
439 // - close 'Delete' button
440 const onCloseDeleteHandler = () => {
441 setShowDeleteModal(false);
442 };
443
444 // - 'Add' button -> Open modal
445 const onClickAddHandler = () => {
446 setShowAddModal(true);
447 };
448
449 // - 'Delete' button -> Remove table entry
450 const onClickDeleteHandler = () => {
451 setShowDeleteModal(true);
452 };
453
454 const target = props.from === "externalHost" ? "host" : props.from;
455
456 return (
457 <div className="pf-v6-u-mr-md pf-v6-u-ml-xl">
458 <SettingsTableLayout
459 ariaLabel={props.from + " table in netgroups"}
460 variant="compact"
461 hasBorders={true}
462 name={props.from}
463 tableId={props.from + "-table"}
464 isStickyHeader={false}
465 tableHeader={header}
466 tableBody={body}
467 onDeleteModal={onClickDeleteHandler}
468 isDeleteDisabled={isDeleteDisabled}
469 onAddModal={
470 props.from === "externalHost" ? openExternalModal : onClickAddHandler
471 }
472 onSearchChange={onSearchChange}
473 searchValue={searchValue}
474 paginationData={paginationData}
475 list={props.members}
476 entryType={props.fromLabel ? props.fromLabel : props.from}
477 />
478 {showAddModal && (
479 <DualListLayout
480 entry={props.id}
481 target={target}
482 title={
483 "Add " +
484 (props.fromLabel ? props.fromLabel : props.from) +
485 "s to netgroup"
486 }
487 showModal={showAddModal}
488 onCloseModal={onCloseAddHandler}
489 onOpenModal={onClickAddHandler}
490 action={addMembers}
491 tableElementsList={props.members}
492 spinning={addSpinning}
493 addBtnName="Add"
494 addSpinningBtnName="Adding"
495 />
496 )}
497 {showDeleteModal && (
498 <RemoveNetgroupMembersModal
499 elementType={props.from}
500 label={props.fromLabel}
501 showModal={showDeleteModal}
502 closeModal={onCloseDeleteHandler}
503 elementsToDelete={selectedMembers}
504 removeMembers={removeMembers}
505 spinning={deleteSpinning}
506 />
507 )}
508 <Modal
509 data-cy="add-external-host-modal"
510 variant="small"
511 isOpen={modalOpen}
512 onClose={closeExternalModal}
513 >
514 <ModalHeader
515 title={"Add external host"}
516 labelId="add-external-host-modal-title"
517 />
518 <ModalBody id="add-external-host-modal-body">
519 <Form id={"external-modal"}>
520 <FormGroup
521 key={"externalHostName"}
522 label={"External hostname"}
523 fieldId={"externalHostName"}
524 isRequired
525 >
526 <InputWithValidation
527 dataCy="modal-textbox-external-host-name"
528 id="externalHostName"
529 name="externalHostName"
530 value={externalHostName}
531 isRequired
532 rules={[
533 {
534 id: "external-host-name",
535 message: "Must contain a period",
536 validate: (value: string) => value.includes("."),
537 },
538 ]}
539 onChange={setExternalHost}
540 />
541 </FormGroup>
542 </Form>
543 </ModalBody>
544 <ModalFooter>
545 <Button
546 data-cy="modal-button-add"
547 key="add-new-host"
548 isDisabled={
549 externalHostName === "" ||
550 !externalHostName.includes(".") ||
551 addSpinning
552 }
553 onClick={() => addMembers([externalHostName])}
554 spinnerAriaValueText="Adding"
555 spinnerAriaLabel="Adding"
556 isLoading={addSpinning}
557 >
558 {addSpinning ? "Adding" : "Add"}
559 </Button>
560 <Button
561 data-cy="modal-button-cancel"
562 key="cancel-new-host"
563 variant="link"
564 onClick={closeExternalModal}
565 >
566 Cancel
567 </Button>
568 </ModalFooter>
569 </Modal>
570 </div>
571 );
572 };
573
574 export default NetgroupsMemberTable;