From 637f188ebec71fe4b0b80bbab4592d4c269d7d93 Mon Sep 17 00:00:00 2001
From: tobi <31960611+tsmethurst@users.noreply.github.com>
Date: Tue, 17 Oct 2023 12:46:06 +0200
Subject: [feature] Allow import/export/creation of domain allows via admin
panel (#2264)
* it's happening!
* aaa
* fix silly whoopsie
* it's working pa! it's working ma!
* model report parameters
* shuffle some more stuff around
* getting there
* oo hoo
* finish tidying up for now
* aaa
* fix use form submit errors
* peepee poo poo
* aaaaa
* ffff
* they see me typin', they hatin'
* boop
* aaa
* oooo
* typing typing tappa tappa
* almost done typing
* weee
* alright
* push it push it real good doo doo doo doo doo doo
* thingy no worky
* almost done
* mutation modifers not quite right
* hmm
* it works
* view blocks + allows nicely
* it works!
* typia install
* the old linterino
* linter plz
---
.../lib/query/admin/domain-permissions/process.ts | 163 +++++++++++++++++++++
1 file changed, 163 insertions(+)
create mode 100644 web/source/settings/lib/query/admin/domain-permissions/process.ts
(limited to 'web/source/settings/lib/query/admin/domain-permissions/process.ts')
diff --git a/web/source/settings/lib/query/admin/domain-permissions/process.ts b/web/source/settings/lib/query/admin/domain-permissions/process.ts
new file mode 100644
index 000000000..017d02bb4
--- /dev/null
+++ b/web/source/settings/lib/query/admin/domain-permissions/process.ts
@@ -0,0 +1,163 @@
+/*
+ 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 .
+*/
+
+import {
+ ParseConfig as CSVParseConfig,
+ parse as csvParse
+} from "papaparse";
+import { nanoid } from "nanoid";
+
+import { isValidDomainPermission, hasBetterScope } from "../../../util/domain-permission";
+import { gtsApi } from "../../gts-api";
+
+import {
+ isDomainPerms,
+ type DomainPerm,
+} from "../../../types/domain-permission";
+
+/**
+ * Parse the given string of domain permissions and return it as an array.
+ * Accepts input as a JSON array string, a CSV, or newline-separated domain names.
+ * Will throw an error if input is invalid.
+ * @param list
+ * @returns
+ * @throws
+ */
+function parseDomainList(list: string): DomainPerm[] {
+ if (list.startsWith("[")) {
+ // Assume JSON array.
+ const data = JSON.parse(list);
+ if (!isDomainPerms(data)) {
+ throw "parsed JSON was not array of DomainPermission";
+ }
+
+ return data;
+ } else if (list.startsWith("#domain") || list.startsWith("domain,severity")) {
+ // Assume Mastodon-style CSV.
+ const csvParseCfg: CSVParseConfig = {
+ header: true,
+ // Remove leading '#' if present.
+ transformHeader: (header) => header.startsWith("#") ? header.slice(1) : header,
+ skipEmptyLines: true,
+ dynamicTyping: true
+ };
+
+ const { data, errors } = csvParse(list, csvParseCfg);
+ if (errors.length > 0) {
+ let error = "";
+ errors.forEach((err) => {
+ error += `${err.message} (line ${err.row})`;
+ });
+ throw error;
+ }
+
+ if (!isDomainPerms(data)) {
+ throw "parsed CSV was not array of DomainPermission";
+ }
+
+ return data;
+ } else {
+ // Fallback: assume newline-separated
+ // list of simple domain strings.
+ const data: DomainPerm[] = [];
+ list.split("\n").forEach((line) => {
+ let domain = line.trim();
+ let valid = true;
+
+ if (domain.startsWith("http")) {
+ try {
+ domain = new URL(domain).hostname;
+ } catch (e) {
+ valid = false;
+ }
+ }
+
+ if (domain.length > 0) {
+ data.push({ domain, valid });
+ }
+ });
+
+ return data;
+ }
+}
+
+function deduplicateDomainList(list: DomainPerm[]): DomainPerm[] {
+ let domains = new Set();
+ return list.filter((entry) => {
+ if (domains.has(entry.domain)) {
+ return false;
+ } else {
+ domains.add(entry.domain);
+ return true;
+ }
+ });
+}
+
+function validateDomainList(list: DomainPerm[]) {
+ list.forEach((entry) => {
+ if (entry.domain.startsWith("*.")) {
+ // A domain permission always includes
+ // all subdomains, wildcard is meaningless here
+ entry.domain = entry.domain.slice(2);
+ }
+
+ entry.valid = (entry.valid !== false) && isValidDomainPermission(entry.domain);
+ if (entry.valid) {
+ entry.suggest = hasBetterScope(entry.domain);
+ }
+ entry.checked = entry.valid;
+ });
+
+ return list;
+}
+
+const extended = gtsApi.injectEndpoints({
+ endpoints: (build) => ({
+ processDomainPermissions: build.mutation({
+ async queryFn(formData, _api, _extraOpts, _fetchWithBQ) {
+ if (formData.domains == undefined || formData.domains.length == 0) {
+ throw "No domains entered";
+ }
+
+ // Parse + tidy up the form data.
+ const permissions = parseDomainList(formData.domains);
+ const deduped = deduplicateDomainList(permissions);
+ const validated = validateDomainList(deduped);
+
+ validated.forEach((entry) => {
+ // Set unique key that stays stable
+ // even if domain gets modified by user.
+ entry.key = nanoid();
+ });
+
+ return { data: validated };
+ }
+ })
+ })
+});
+
+/**
+ * useProcessDomainPermissionsMutation uses the RTK Query API without actually
+ * hitting the GtS API, it's purely an internal function for our own convenience.
+ *
+ * It returns the validated and deduplicated domain permission list.
+ */
+const useProcessDomainPermissionsMutation = extended.useProcessDomainPermissionsMutation;
+
+export { useProcessDomainPermissionsMutation };
--
cgit v1.2.3