mirror of
https://github.com/go-vikunja/vikunja.git
synced 2026-08-31 03:46:56 -05:00
kolaente
691e5c9e61
Credentials migrators are verified synchronously before the async migration is queued (CredentialsChecker). Routes live on v2 only; the listener learns the migrator via a route-free RegisterMigratorForEvents, which the oauth v2 registrar uses as well. Shared status/migrate registration moved to migration_shared.go.
57 lines
2.2 KiB
Go
57 lines
2.2 KiB
Go
// Vikunja is a to-do list application to facilitate your life.
|
|
// Copyright 2018-present Vikunja and contributors. All rights reserved.
|
|
//
|
|
// 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 <https://www.gnu.org/licenses/>.
|
|
|
|
package migration
|
|
|
|
import (
|
|
"io"
|
|
|
|
"code.vikunja.io/api/pkg/user"
|
|
)
|
|
|
|
type MigratorName interface {
|
|
// Name holds the name of the migration.
|
|
// This is used to show the name to users and to keep track of users who already migrated.
|
|
Name() string
|
|
}
|
|
|
|
// Migrator is the basic migrator interface which is shared among all migrators
|
|
type Migrator interface {
|
|
MigratorName
|
|
// Migrate is the interface used to migrate a user's tasks from another platform to vikunja.
|
|
// The user object is the user who's tasks will be migrated.
|
|
Migrate(user *user.User) error
|
|
// AuthURL returns a url for clients to authenticate against.
|
|
// The use case for this are Oauth flows, where the server token should remain hidden and not
|
|
// known to the frontend.
|
|
AuthURL() string
|
|
}
|
|
|
|
// CredentialsChecker is implemented by migrators that authenticate with credentials passed in the
|
|
// migrate request (instead of an OAuth code). The handlers call it before queueing the migration
|
|
// so bad credentials fail the request instead of a background job.
|
|
type CredentialsChecker interface {
|
|
CheckCredentials() error
|
|
}
|
|
|
|
// FileMigrator handles importing Vikunja data from a file. The implementation of it determines the format.
|
|
type FileMigrator interface {
|
|
MigratorName
|
|
// Migrate is the interface used to migrate a user's tasks, project and other things from a file to vikunja.
|
|
// The user object is the user who's tasks will be migrated.
|
|
Migrate(user *user.User, file io.ReaderAt, size int64) error
|
|
}
|