diff options
author | 2024-07-31 16:03:34 +0200 | |
---|---|---|
committer | 2024-07-31 15:03:34 +0100 | |
commit | 38f041cea1ba0cd3492f351353a29aa5b73e2731 (patch) | |
tree | bdd055d5cf7d9c06523c694cb4abe86d220960d0 /web/source/settings/lib/query | |
parent | [feature] Object store custom URL (S3) (#3046) (diff) | |
download | gotosocial-38f041cea1ba0cd3492f351353a29aa5b73e2731.tar.xz |
[feature] Allow users to export data via the settings panel (#3140)
* [feature] Allow users to export data via the settings panel
* rename/move some stuff
Diffstat (limited to 'web/source/settings/lib/query')
-rw-r--r-- | web/source/settings/lib/query/gts-api.ts | 28 | ||||
-rw-r--r-- | web/source/settings/lib/query/user/export-import.ts | 138 |
2 files changed, 165 insertions, 1 deletions
diff --git a/web/source/settings/lib/query/gts-api.ts b/web/source/settings/lib/query/gts-api.ts index d6741df3a..1c715e284 100644 --- a/web/source/settings/lib/query/gts-api.ts +++ b/web/source/settings/lib/query/gts-api.ts @@ -48,6 +48,11 @@ export interface GTSFetchArgs extends FetchArgs { * as FormData before submission. */ asForm?: boolean; + /** + * If set, then Accept header will + * be set to the provided contentType. + */ + acceptContentType?: string; } /** @@ -77,6 +82,10 @@ const gtsBaseQuery: BaseQueryFn< // Derive baseUrl dynamically. let baseUrl: string | undefined; + // Assume Accept value of + // "application/json" by default. + let accept = "application/json"; + // Check if simple string baseUrl provided // as args, or if more complex args provided. if (typeof args === "string") { @@ -101,11 +110,16 @@ const gtsBaseQuery: BaseQueryFn< }); } + if (args.acceptContentType !== undefined) { + accept = args.acceptContentType; + } + // Delete any of our extended arguments // to avoid confusing fetchBaseQuery. delete args.baseUrl; delete args.discardEmpty; delete args.asForm; + delete args.acceptContentType; } if (!baseUrl) { @@ -124,9 +138,21 @@ const gtsBaseQuery: BaseQueryFn< if (token != undefined) { headers.set('Authorization', token); } - headers.set("Accept", "application/json"); + + headers.set("Accept", accept); return headers; }, + responseHandler: (response) => { + // Return just text if caller has + // set a custom accept content-type. + if (accept !== "application/json") { + return response.text(); + } + + // Else return good old + // fashioned JSON baby! + return response.json(); + }, })(args, api, extraOptions); }; diff --git a/web/source/settings/lib/query/user/export-import.ts b/web/source/settings/lib/query/user/export-import.ts new file mode 100644 index 000000000..56c48e364 --- /dev/null +++ b/web/source/settings/lib/query/user/export-import.ts @@ -0,0 +1,138 @@ +/* + 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 fileDownload from "js-file-download"; + +import { gtsApi } from "../gts-api"; +import { FetchBaseQueryError } from "@reduxjs/toolkit/query"; +import { AccountExportStats } from "../../types/account"; + +const extended = gtsApi.injectEndpoints({ + endpoints: (build) => ({ + exportStats: build.query<AccountExportStats, void>({ + query: () => ({ + url: `/api/v1/exports/stats` + }) + }), + + exportFollowing: build.mutation<string | null, void>({ + async queryFn(_arg, _api, _extraOpts, fetchWithBQ) { + const csvRes = await fetchWithBQ({ + url: `/api/v1/exports/following.csv`, + acceptContentType: "text/csv", + }); + if (csvRes.error) { + return { error: csvRes.error as FetchBaseQueryError }; + } + + if (csvRes.meta?.response?.status !== 200) { + return { error: csvRes.data }; + } + + fileDownload(csvRes.data, "following.csv", "text/csv"); + return { data: null }; + } + }), + + exportFollowers: build.mutation<string | null, void>({ + async queryFn(_arg, _api, _extraOpts, fetchWithBQ) { + const csvRes = await fetchWithBQ({ + url: `/api/v1/exports/followers.csv`, + acceptContentType: "text/csv", + }); + if (csvRes.error) { + return { error: csvRes.error as FetchBaseQueryError }; + } + + if (csvRes.meta?.response?.status !== 200) { + return { error: csvRes.data }; + } + + fileDownload(csvRes.data, "followers.csv", "text/csv"); + return { data: null }; + } + }), + + exportLists: build.mutation<string | null, void>({ + async queryFn(_arg, _api, _extraOpts, fetchWithBQ) { + const csvRes = await fetchWithBQ({ + url: `/api/v1/exports/lists.csv`, + acceptContentType: "text/csv", + }); + if (csvRes.error) { + return { error: csvRes.error as FetchBaseQueryError }; + } + + if (csvRes.meta?.response?.status !== 200) { + return { error: csvRes.data }; + } + + fileDownload(csvRes.data, "lists.csv", "text/csv"); + return { data: null }; + } + }), + + exportBlocks: build.mutation<string | null, void>({ + async queryFn(_arg, _api, _extraOpts, fetchWithBQ) { + const csvRes = await fetchWithBQ({ + url: `/api/v1/exports/blocks.csv`, + acceptContentType: "text/csv", + }); + if (csvRes.error) { + return { error: csvRes.error as FetchBaseQueryError }; + } + + if (csvRes.meta?.response?.status !== 200) { + return { error: csvRes.data }; + } + + fileDownload(csvRes.data, "blocks.csv", "text/csv"); + return { data: null }; + } + }), + + exportMutes: build.mutation<string | null, void>({ + async queryFn(_arg, _api, _extraOpts, fetchWithBQ) { + const csvRes = await fetchWithBQ({ + url: `/api/v1/exports/mutes.csv`, + acceptContentType: "text/csv", + }); + if (csvRes.error) { + return { error: csvRes.error as FetchBaseQueryError }; + } + + if (csvRes.meta?.response?.status !== 200) { + return { error: csvRes.data }; + } + + fileDownload(csvRes.data, "mutes.csv", "text/csv"); + return { data: null }; + } + }), + }) +}); + +export const { + useExportStatsQuery, + useExportFollowingMutation, + useExportFollowersMutation, + useExportListsMutation, + useExportBlocksMutation, + useExportMutesMutation, +} = extended; |