gotosocial/web/source/settings/views/moderation/domain-permissions/excludes/index.tsx

/*
	GoToSocial
	Copyright (C) GoToSocial Authors admin@gotosocial.org
	SPDX-License-Identifier: AGPL-3.0-or-later

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import React, { ReactNode, useEffect, useMemo } from "react";

import { useTextInput } from "../../../../lib/form";
import { PageableList } from "../../../../components/pageable-list";
import MutationButton from "../../../../components/form/mutation-button";
import { useLocation, useSearch } from "wouter";
import { useDeleteDomainPermissionExcludeMutation, useLazySearchDomainPermissionExcludesQuery } from "../../../../lib/query/admin/domain-permissions/excludes";
import { DomainPerm } from "../../../../lib/types/domain-permission";
import { Error as ErrorC } from "../../../../components/error";
import { Select, TextInput } from "../../../../components/form/inputs";
import { formDomainValidator } from "../../../../lib/util/formvalidators";
import { DomainPermissionExcludeDocsLink, DomainPermissionExcludeHelpText } from "./common";

export default function DomainPermissionExcludesSearch() {
	return (
		<div className="domain-permission-excludes-view">
			<div className="form-section-docs">
				<h1>Domain Permission Excludes</h1>
				<p>
					You can use the form below to search through domain permission excludes.
					<br/>
					<DomainPermissionExcludeHelpText />
				</p>
				<DomainPermissionExcludeDocsLink />
			</div>
			<DomainPermissionExcludesSearchForm />
		</div>
	);
}

function DomainPermissionExcludesSearchForm() {
	const [ location, setLocation ] = useLocation();
	const search = useSearch();
	const urlQueryParams = useMemo(() => new URLSearchParams(search), [search]);
	const hasParams = urlQueryParams.size != 0;
	const [ searchExcludes, searchRes ] = useLazySearchDomainPermissionExcludesQuery();

	const form = {
		domain: useTextInput("domain", {
			defaultValue: urlQueryParams.get("domain") ?? "",
			validator: formDomainValidator,
		}),
		limit: useTextInput("limit", { defaultValue: urlQueryParams.get("limit") ?? "20" })
	};

	// On mount, if urlQueryParams were provided,
	// trigger the search. For example, if page
	// was accessed at /search?origin=local&limit=20,
	// then run a search with origin=local and
	// limit=20 and immediately render the results.
	//
	// If no urlQueryParams set, trigger default
	// search (first page, no filtering).
	useEffect(() => {
		if (hasParams) {
			searchExcludes(Object.fromEntries(urlQueryParams));
		} else {
			setLocation(location + "?limit=20");
		}
	}, [
		urlQueryParams,
		hasParams,
		searchExcludes,
		location,
		setLocation,
	]);

	// Rather than triggering the search directly,
	// the "submit" button changes the location
	// based on form field params, and lets the
	// useEffect hook above actually do the search.
	function submitQuery(e) {
		e.preventDefault();
		
		// Parse query parameters.
		const entries = Object.entries(form).map(([k, v]) => {
			// Take only defined form fields.
			if (v.value === undefined || v.value.length === 0 || v.value === "any") {
				return null;
			}
			return [[k, v.value]];
		}).flatMap(kv => {
			// Remove any nulls.
			return kv || [];
		});

		const searchParams = new URLSearchParams(entries);
		setLocation(location + "?" + searchParams.toString());
	}

	// Location to return to when user clicks "back" on the detail view.
	const backLocation = location + (hasParams ? `?${urlQueryParams}` : "");
	
	// Function to map an item to a list entry.
	function itemToEntry(exclude: DomainPerm): ReactNode {
		return (
			<ExcludeListEntry
				key={exclude.id}	
				permExclude={exclude}
				linkTo={`/excludes/${exclude.id}`}
				backLocation={backLocation}
			/>
		);
	}

	return (
		<>
			<form
				onSubmit={submitQuery}
				// Prevent password managers
				// trying to fill in fields.
				autoComplete="off"
			>
				<TextInput
					field={form.domain}
					label={`Domain (without "https://" prefix)`}
					placeholder="example.org"
					autoCapitalize="none"
					spellCheck="false"
				/>
				<Select
					field={form.limit}
					label="Items per page"
					options={
						<>
							<option value="20">20</option>
							<option value="50">50</option>
							<option value="100">100</option>
						</>
					}
				></Select>
				<MutationButton
					disabled={false}
					label={"Search"}
					result={searchRes}
				/>
			</form>
			<PageableList
				isLoading={searchRes.isLoading}
				isFetching={searchRes.isFetching}
				isSuccess={searchRes.isSuccess}
				items={searchRes.data?.excludes}
				itemToEntry={itemToEntry}
				isError={searchRes.isError}
				error={searchRes.error}
				emptyMessage={<b>No excludes found that match your query.</b>}
				prevNextLinks={searchRes.data?.links}
			/>
		</>
	);
}

interface ExcludeEntryProps {
	permExclude: DomainPerm;
	linkTo: string;
	backLocation: string;
}

function ExcludeListEntry({ permExclude, linkTo, backLocation }: ExcludeEntryProps) {
	const [ _location, setLocation ] = useLocation();
	const [ deleteExclude, deleteResult ] = useDeleteDomainPermissionExcludeMutation();

	const domain = permExclude.domain;
	const privateComment = permExclude.private_comment ?? "[none]";
	const id = permExclude.id;
	if (!id) {
		return <ErrorC error={new Error("id was undefined")} />;
	}

	return (
		<span
			className={`pseudolink domain-permission-exclude entry`}
			aria-label={`Exclude ${domain}`}
			title={`Exclude ${domain}`}
			onClick={() => {
				// When clicking on a exclude, direct
				// to the detail view for that exclude.
				setLocation(linkTo, {
					// Store the back location in history so
					// the detail view can use it to return to
					// this page (including query parameters).
					state: { backLocation: backLocation }
				});
			}}
			role="link"
			tabIndex={0}
		>
			<dl className="info-list">
				<div className="info-list-entry">
					<dt>Domain:</dt>
					<dd className="text-cutoff">{domain}</dd>
				</div>
				<div className="info-list-entry">
					<dt>Private comment:</dt>
					<dd className="text-cutoff">{privateComment}</dd>
				</div>
			</dl>
			<div className="action-buttons">
				<MutationButton
					label={`Delete exclude`}
					title={`Delete exclude`}
					type="button"
					className="button danger"
					onClick={(e) => {
						e.preventDefault();
						e.stopPropagation();
						deleteExclude(id);
					}}
					disabled={false}
					showError={true}
					result={deleteResult}
				/>
			</div>
		</span>
	);
}