From 89e0cfd8741b6763ca04e90558bccf4c3c380cfa Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Sat, 13 Apr 2024 13:25:10 +0200 Subject: [feature] Admin accounts endpoints; approve/reject sign-ups (#2826) * update settings panels, add pending overview + approve/deny functions * add admin accounts get, approve, reject * send approved/rejected emails * use signup URL * docs! * email * swagger * web linting * fix email tests * wee lil fixerinos * use new paging logic for GetAccounts() series of admin endpoints, small changes to query building * shuffle useAccountIDIn check *before* adding to query * fix parse from toot react error * use `netip.Addr` * put valid slices in globals * optimistic updates for account state --------- Co-authored-by: kim --- web/source/settings/lib/navigation/util.js | 49 ------------ web/source/settings/lib/navigation/util.ts | 54 +++++++++++++ web/source/settings/lib/query/admin/index.ts | 65 ++++++++++++---- .../settings/lib/query/admin/reports/index.ts | 2 +- web/source/settings/lib/types/account.ts | 88 ++++++++++++++++++++++ 5 files changed, 195 insertions(+), 63 deletions(-) delete mode 100644 web/source/settings/lib/navigation/util.js create mode 100644 web/source/settings/lib/navigation/util.ts create mode 100644 web/source/settings/lib/types/account.ts (limited to 'web/source/settings/lib') diff --git a/web/source/settings/lib/navigation/util.js b/web/source/settings/lib/navigation/util.js deleted file mode 100644 index 2c6c4968f..000000000 --- a/web/source/settings/lib/navigation/util.js +++ /dev/null @@ -1,49 +0,0 @@ -/* - 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 . -*/ - -const React = require("react"); -const RoleContext = React.createContext([]); -const BaseUrlContext = React.createContext(null); - -function urlSafe(str) { - return str.toLowerCase().replace(/[\s/]+/g, "-"); -} - -function useHasPermission(permissions) { - const roles = React.useContext(RoleContext); - return checkPermission(permissions, roles); -} - -function checkPermission(requiredPermissisons, user) { - // requiredPermissions can be 'false', in which case there are no restrictions - if (requiredPermissisons === false) { - return true; - } - - // or an array of roles, check if one of the user's roles is sufficient - return user.some((role) => requiredPermissisons.includes(role)); -} - -function useBaseUrl() { - return React.useContext(BaseUrlContext); -} - -module.exports = { - urlSafe, RoleContext, useHasPermission, checkPermission, BaseUrlContext, useBaseUrl -}; \ No newline at end of file diff --git a/web/source/settings/lib/navigation/util.ts b/web/source/settings/lib/navigation/util.ts new file mode 100644 index 000000000..e6f8ee697 --- /dev/null +++ b/web/source/settings/lib/navigation/util.ts @@ -0,0 +1,54 @@ +/* + 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 { createContext, useContext } from "react"; +const RoleContext = createContext([]); +const BaseUrlContext = createContext(""); + +function urlSafe(str) { + return str.toLowerCase().replace(/[\s/]+/g, "-"); +} + +function useHasPermission(permissions) { + const roles = useContext(RoleContext); + return checkPermission(permissions, roles); +} + +function checkPermission(requiredPermissisons, user) { + // requiredPermissions can be 'false', in which case there are no restrictions + if (requiredPermissisons === false) { + return true; + } + + // or an array of roles, check if one of the user's roles is sufficient + return user.some((role) => requiredPermissisons.includes(role)); +} + +function useBaseUrl() { + return useContext(BaseUrlContext); +} + +export { + urlSafe, + RoleContext, + useHasPermission, + checkPermission, + BaseUrlContext, + useBaseUrl +}; diff --git a/web/source/settings/lib/query/admin/index.ts b/web/source/settings/lib/query/admin/index.ts index e61179216..74f410e05 100644 --- a/web/source/settings/lib/query/admin/index.ts +++ b/web/source/settings/lib/query/admin/index.ts @@ -20,6 +20,7 @@ import { replaceCacheOnMutation, removeFromCacheOnMutation } from "../query-modifiers"; import { gtsApi } from "../gts-api"; import { listToKeyedObject } from "../transforms"; +import { AdminAccount, HandleSignupParams, SearchAccountParams } from "../../types/account"; const extended = gtsApi.injectEndpoints({ endpoints: (build) => ({ @@ -54,14 +55,43 @@ const extended = gtsApi.injectEndpoints({ }) }), - getAccount: build.query({ + getAccount: build.query({ query: (id) => ({ - url: `/api/v1/accounts/${id}` + url: `/api/v1/admin/accounts/${id}` }), - providesTags: (_, __, id) => [{ type: "Account", id }] + providesTags: (_result, _error, id) => [ + { type: 'Account', id } + ], }), - actionAccount: build.mutation({ + searchAccounts: build.query({ + query: (form) => { + const params = new(URLSearchParams); + Object.entries(form).forEach(([k, v]) => { + if (v !== undefined) { + params.append(k, v); + } + }); + + let query = ""; + if (params.size !== 0) { + query = `?${params.toString()}`; + } + + return { + url: `/api/v2/admin/accounts${query}` + }; + }, + providesTags: (res) => + res + ? [ + ...res.map(({ id }) => ({ type: 'Account' as const, id })), + { type: 'Account', id: 'LIST' }, + ] + : [{ type: 'Account', id: 'LIST' }], + }), + + actionAccount: build.mutation({ query: ({ id, action, reason }) => ({ method: "POST", url: `/api/v1/admin/accounts/${id}/action`, @@ -71,16 +101,23 @@ const extended = gtsApi.injectEndpoints({ text: reason } }), - invalidatesTags: (_, __, { id }) => [{ type: "Account", id }] + invalidatesTags: (_result, _error, { id }) => [ + { type: 'Account', id }, + ], }), - searchAccount: build.mutation({ - query: (username) => ({ - url: `/api/v2/search?q=${encodeURIComponent(username)}&resolve=true` - }), - transformResponse: (res) => { - return res.accounts ?? []; - } + handleSignup: build.mutation({ + query: ({id, approve_or_reject, ...formData}) => { + return { + method: "POST", + url: `/api/v1/admin/accounts/${id}/${approve_or_reject}`, + asForm: true, + body: approve_or_reject === "reject" ?? formData, + }; + }, + invalidatesTags: (_result, _error, { id }) => [ + { type: 'Account', id }, + ], }), instanceRules: build.query({ @@ -140,7 +177,9 @@ export const { useInstanceKeysExpireMutation, useGetAccountQuery, useActionAccountMutation, - useSearchAccountMutation, + useSearchAccountsQuery, + useLazySearchAccountsQuery, + useHandleSignupMutation, useInstanceRulesQuery, useAddInstanceRuleMutation, useUpdateInstanceRuleMutation, diff --git a/web/source/settings/lib/query/admin/reports/index.ts b/web/source/settings/lib/query/admin/reports/index.ts index 253e8238c..600e78ac3 100644 --- a/web/source/settings/lib/query/admin/reports/index.ts +++ b/web/source/settings/lib/query/admin/reports/index.ts @@ -36,7 +36,7 @@ const extended = gtsApi.injectEndpoints({ ...params } }), - providesTags: ["Reports"] + providesTags: [{ type: "Reports", id: "LIST" }] }), getReport: build.query({ diff --git a/web/source/settings/lib/types/account.ts b/web/source/settings/lib/types/account.ts new file mode 100644 index 000000000..3e7e9640d --- /dev/null +++ b/web/source/settings/lib/types/account.ts @@ -0,0 +1,88 @@ +/* + 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 { CustomEmoji } from "./custom-emoji"; + +export interface AdminAccount { + id: string, + username: string, + domain: string | null, + created_at: string, + email: string, + ip: string | null, + ips: [], + locale: string, + invite_request: string | null, + role: any, + confirmed: boolean, + approved: boolean, + disabled: boolean, + silenced: boolean, + suspended: boolean, + created_by_application_id: string, + account: Account, +} + +export interface Account { + id: string, + username: string, + acct: string, + display_name: string, + locked: boolean, + discoverable: boolean, + bot: boolean, + created_at: string, + note: string, + url: string, + avatar: string, + avatar_static: string, + header: string, + header_static: string, + followers_count: number, + following_count: number, + statuses_count: number, + last_status_at: string, + emojis: CustomEmoji[], + fields: [], + enable_rss: boolean, + role: any, +} + +export interface SearchAccountParams { + origin?: "local" | "remote", + status?: "active" | "pending" | "disabled" | "silenced" | "suspended", + permissions?: "staff", + username?: string, + display_name?: string, + by_domain?: string, + email?: string, + ip?: string, + max_id?: string, + since_id?: string, + min_id?: string, + limit?: number, +} + +export interface HandleSignupParams { + id: string, + approve_or_reject: "approve" | "reject", + private_comment?: string, + message?: string, + send_email?: boolean, +} -- cgit v1.2.3