summaryrefslogtreecommitdiff
path: root/internal/api/client/import
diff options
context:
space:
mode:
Diffstat (limited to 'internal/api/client/import')
-rw-r--r--internal/api/client/import/import.go195
-rw-r--r--internal/api/client/import/import_test.go210
2 files changed, 405 insertions, 0 deletions
diff --git a/internal/api/client/import/import.go b/internal/api/client/import/import.go
new file mode 100644
index 000000000..6d85a6b23
--- /dev/null
+++ b/internal/api/client/import/import.go
@@ -0,0 +1,195 @@
+// 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/>.
+
+package importdata
+
+import (
+ "errors"
+ "fmt"
+ "net/http"
+ "slices"
+ "strings"
+
+ "github.com/gin-gonic/gin"
+ apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
+ apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util"
+ "github.com/superseriousbusiness/gotosocial/internal/gtserror"
+ "github.com/superseriousbusiness/gotosocial/internal/oauth"
+ "github.com/superseriousbusiness/gotosocial/internal/processing"
+)
+
+const (
+ BasePath = "/v1/import"
+)
+
+var types = []string{
+ "following",
+ "blocks",
+}
+
+var modes = []string{
+ "merge",
+ "overwrite",
+}
+
+type Module struct {
+ processor *processing.Processor
+}
+
+func New(processor *processing.Processor) *Module {
+ return &Module{
+ processor: processor,
+ }
+}
+
+func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) {
+ attachHandler(http.MethodPost, BasePath, m.ImportPOSTHandler)
+}
+
+// ImportPOSTHandler swagger:operation POST /api/v1/import importData
+//
+// Upload some CSV-formatted data to your account.
+//
+// This can be used to migrate data from a Mastodon-compatible CSV file to a GoToSocial account.
+//
+// Uploaded data will be processed asynchronously, and not all entries may be processed depending
+// on domain blocks, user-level blocks, network availability of referenced accounts and statuses, etc.
+//
+// ---
+// tags:
+// - import-export
+//
+// consumes:
+// - multipart/form-data
+//
+// produces:
+// - application/json
+//
+// parameters:
+// -
+// name: data
+// in: formData
+// description: The CSV data file to upload.
+// type: file
+// required: true
+// -
+// name: type
+// in: formData
+// description: >-
+// Type of entries contained in the data file:
+//
+// - `following` - accounts to follow.
+// - `blocks` - accounts to block.
+// type: string
+// required: true
+// -
+// name: mode
+// in: formData
+// description: >-
+// Mode to use when creating entries from the data file:
+//
+// - `merge` to merge entries in file with existing entries.
+// - `overwrite` to replace existing entries with entries in file.
+// type: string
+// default: merge
+//
+// security:
+// - OAuth2 Bearer:
+// - write:accounts
+//
+// responses:
+// '202':
+// description: Upload accepted.
+// '400':
+// description: bad request
+// '401':
+// description: unauthorized
+// '406':
+// description: not acceptable
+// '500':
+// description: internal server error
+func (m *Module) ImportPOSTHandler(c *gin.Context) {
+ authed, err := oauth.Authed(c, true, true, true, true)
+ if err != nil {
+ apiutil.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGetV1)
+ return
+ }
+
+ if authed.Account.IsMoving() {
+ apiutil.ForbiddenAfterMove(c)
+ return
+ }
+
+ if _, err := apiutil.NegotiateAccept(c, apiutil.JSONAcceptHeaders...); err != nil {
+ apiutil.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGetV1)
+ return
+ }
+
+ form := &apimodel.ImportRequest{}
+ if err := c.ShouldBind(form); err != nil {
+ apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGetV1)
+ return
+ }
+
+ if form.Data == nil {
+ const text = "no data file provided"
+ err := errors.New(text)
+ apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, text), m.processor.InstanceGetV1)
+ return
+ }
+
+ if form.Type == "" {
+ const text = "no type provided"
+ err := errors.New(text)
+ apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, text), m.processor.InstanceGetV1)
+ return
+ }
+
+ form.Type = strings.ToLower(form.Type)
+ if !slices.Contains(types, form.Type) {
+ text := fmt.Sprintf("type %s not recognized, valid types are: %+v", form.Type, types)
+ err := errors.New(text)
+ apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, text), m.processor.InstanceGetV1)
+ return
+ }
+
+ if form.Mode != "" {
+ form.Mode = strings.ToLower(form.Mode)
+ if !slices.Contains(modes, form.Mode) {
+ text := fmt.Sprintf("mode %s not recognized, valid modes are: %+v", form.Mode, modes)
+ err := errors.New(text)
+ apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, text), m.processor.InstanceGetV1)
+ return
+ }
+ }
+ overwrite := form.Mode == "overwrite"
+
+ // Trigger the import.
+ errWithCode := m.processor.Account().ImportData(
+ c.Request.Context(),
+ authed.Account,
+ form.Data,
+ form.Type,
+ overwrite,
+ )
+ if errWithCode != nil {
+ apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
+ return
+ }
+
+ apiutil.JSON(c, http.StatusAccepted, gin.H{"status": "accepted"})
+}
diff --git a/internal/api/client/import/import_test.go b/internal/api/client/import/import_test.go
new file mode 100644
index 000000000..5129f862e
--- /dev/null
+++ b/internal/api/client/import/import_test.go
@@ -0,0 +1,210 @@
+// 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/>.
+
+package importdata_test
+
+import (
+ "bytes"
+ "context"
+ "io"
+ "net/http"
+ "net/http/httptest"
+ "testing"
+
+ "github.com/stretchr/testify/suite"
+ importdata "github.com/superseriousbusiness/gotosocial/internal/api/client/import"
+ "github.com/superseriousbusiness/gotosocial/internal/filter/visibility"
+ "github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+ "github.com/superseriousbusiness/gotosocial/internal/oauth"
+ "github.com/superseriousbusiness/gotosocial/internal/state"
+ "github.com/superseriousbusiness/gotosocial/internal/typeutils"
+ "github.com/superseriousbusiness/gotosocial/testrig"
+)
+
+type ImportTestSuite struct {
+ // Suite interfaces
+ suite.Suite
+ state state.State
+
+ // standard suite models
+ testTokens map[string]*gtsmodel.Token
+ testClients map[string]*gtsmodel.Client
+ testApplications map[string]*gtsmodel.Application
+ testUsers map[string]*gtsmodel.User
+ testAccounts map[string]*gtsmodel.Account
+
+ // module being tested
+ importModule *importdata.Module
+}
+
+func (suite *ImportTestSuite) SetupSuite() {
+ suite.testTokens = testrig.NewTestTokens()
+ suite.testClients = testrig.NewTestClients()
+ suite.testApplications = testrig.NewTestApplications()
+ suite.testUsers = testrig.NewTestUsers()
+ suite.testAccounts = testrig.NewTestAccounts()
+}
+
+func (suite *ImportTestSuite) SetupTest() {
+ suite.state.Caches.Init()
+
+ testrig.InitTestConfig()
+ testrig.InitTestLog()
+
+ suite.state.DB = testrig.NewTestDB(&suite.state)
+ suite.state.Storage = testrig.NewInMemoryStorage()
+
+ testrig.StartTimelines(
+ &suite.state,
+ visibility.NewFilter(&suite.state),
+ typeutils.NewConverter(&suite.state),
+ )
+
+ testrig.StandardDBSetup(suite.state.DB, nil)
+ testrig.StandardStorageSetup(suite.state.Storage, "../../../../testrig/media")
+
+ mediaManager := testrig.NewTestMediaManager(&suite.state)
+
+ federator := testrig.NewTestFederator(
+ &suite.state,
+ testrig.NewTestTransportController(
+ &suite.state,
+ testrig.NewMockHTTPClient(nil, "../../../../testrig/media"),
+ ),
+ mediaManager,
+ )
+
+ processor := testrig.NewTestProcessor(
+ &suite.state,
+ federator,
+ testrig.NewEmailSender("../../../../web/template/", nil),
+ mediaManager,
+ )
+ testrig.StartWorkers(&suite.state, processor.Workers())
+
+ suite.importModule = importdata.New(processor)
+}
+
+func (suite *ImportTestSuite) TriggerHandler(
+ importData string,
+ importType string,
+ importMode string,
+) {
+ // Set up request.
+ recorder := httptest.NewRecorder()
+ ctx, _ := testrig.CreateGinTestContext(recorder, nil)
+
+ // Authorize the request ctx as though it
+ // had passed through API auth handlers.
+ ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts["local_account_1"])
+ ctx.Set(oauth.SessionAuthorizedToken, oauth.DBTokenToToken(suite.testTokens["local_account_1"]))
+ ctx.Set(oauth.SessionAuthorizedApplication, suite.testApplications["application_1"])
+ ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers["local_account_1"])
+
+ // Create test request.
+ b, w, err := testrig.CreateMultipartFormData(
+ testrig.StringToDataF("data", "data.csv", importData),
+ map[string][]string{
+ "type": {importType},
+ "mode": {importMode},
+ },
+ )
+ if err != nil {
+ suite.FailNow(err.Error())
+ }
+
+ target := "http://localhost:8080/api/v1/import"
+ ctx.Request = httptest.NewRequest(http.MethodPost, target, bytes.NewReader(b.Bytes()))
+ ctx.Request.Header.Set("Accept", "application/json")
+ ctx.Request.Header.Set("Content-Type", w.FormDataContentType())
+
+ // Trigger handler.
+ suite.importModule.ImportPOSTHandler(ctx)
+
+ if code := recorder.Code; code != http.StatusAccepted {
+ b, err := io.ReadAll(recorder.Body)
+ if err != nil {
+ panic(err)
+ }
+ suite.FailNow("", "expected 202, got %d: %s", code, string(b))
+ }
+}
+
+func (suite *ImportTestSuite) TearDownTest() {
+ testrig.StandardDBTeardown(suite.state.DB)
+ testrig.StandardStorageTeardown(suite.state.Storage)
+ testrig.StopWorkers(&suite.state)
+}
+
+func (suite *ImportTestSuite) TestImportFollows() {
+ var (
+ ctx = context.Background()
+ testAccount = suite.testAccounts["local_account_1"]
+ )
+
+ // Clear existing follows from Zork.
+ if err := suite.state.DB.DeleteAccountFollows(ctx, testAccount.ID); err != nil {
+ suite.FailNow(err.Error())
+ }
+
+ // Have zork refollow turtle and admin.
+ data := `Account address,Show boosts
+admin@localhost:8080,true
+1happyturtle@localhost:8080,true
+`
+
+ // Trigger the import handler.
+ suite.TriggerHandler(data, "following", "merge")
+
+ // Wait for zork to be
+ // following admin.
+ if !testrig.WaitFor(func() bool {
+ f, err := suite.state.DB.IsFollowing(
+ ctx,
+ testAccount.ID,
+ suite.testAccounts["admin_account"].ID,
+ )
+ if err != nil {
+ suite.FailNow(err.Error())
+ }
+
+ return f
+ }) {
+ suite.FailNow("timed out waiting for zork to follow admin")
+ }
+
+ // Wait for zork to be
+ // follow req'ing turtle.
+ if !testrig.WaitFor(func() bool {
+ f, err := suite.state.DB.IsFollowRequested(
+ ctx,
+ testAccount.ID,
+ suite.testAccounts["local_account_2"].ID,
+ )
+ if err != nil {
+ suite.FailNow(err.Error())
+ }
+
+ return f
+ }) {
+ suite.FailNow("timed out waiting for zork to follow req turtle")
+ }
+}
+
+func TestImportTestSuite(t *testing.T) {
+ suite.Run(t, new(ImportTestSuite))
+}