123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264 |
- // Copyright 2019 Gitea. All rights reserved.
- // Use of this source code is governed by a MIT-style
- // license that can be found in the LICENSE file.
-
- package models
-
- import (
- "context"
- "fmt"
-
- "code.gitea.io/gitea/models/db"
- repo_model "code.gitea.io/gitea/models/repo"
- user_model "code.gitea.io/gitea/models/user"
- "code.gitea.io/gitea/modules/json"
- "code.gitea.io/gitea/modules/migration"
- "code.gitea.io/gitea/modules/secret"
- "code.gitea.io/gitea/modules/setting"
- "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/modules/timeutil"
- "code.gitea.io/gitea/modules/util"
-
- "xorm.io/builder"
- )
-
- // Task represents a task
- type Task struct {
- ID int64
- DoerID int64 `xorm:"index"` // operator
- Doer *user_model.User `xorm:"-"`
- OwnerID int64 `xorm:"index"` // repo owner id, when creating, the repoID maybe zero
- Owner *user_model.User `xorm:"-"`
- RepoID int64 `xorm:"index"`
- Repo *repo_model.Repository `xorm:"-"`
- Type structs.TaskType
- Status structs.TaskStatus `xorm:"index"`
- StartTime timeutil.TimeStamp
- EndTime timeutil.TimeStamp
- PayloadContent string `xorm:"TEXT"`
- Message string `xorm:"TEXT"` // if task failed, saved the error reason
- Created timeutil.TimeStamp `xorm:"created"`
- }
-
- func init() {
- db.RegisterModel(new(Task))
- }
-
- // TranslatableMessage represents JSON struct that can be translated with a Locale
- type TranslatableMessage struct {
- Format string
- Args []interface{} `json:"omitempty"`
- }
-
- // LoadRepo loads repository of the task
- func (task *Task) LoadRepo() error {
- return task.loadRepo(db.DefaultContext)
- }
-
- func (task *Task) loadRepo(ctx context.Context) error {
- if task.Repo != nil {
- return nil
- }
- var repo repo_model.Repository
- has, err := db.GetEngine(ctx).ID(task.RepoID).Get(&repo)
- if err != nil {
- return err
- } else if !has {
- return repo_model.ErrRepoNotExist{
- ID: task.RepoID,
- }
- }
- task.Repo = &repo
- return nil
- }
-
- // LoadDoer loads do user
- func (task *Task) LoadDoer() error {
- if task.Doer != nil {
- return nil
- }
-
- var doer user_model.User
- has, err := db.GetEngine(db.DefaultContext).ID(task.DoerID).Get(&doer)
- if err != nil {
- return err
- } else if !has {
- return user_model.ErrUserNotExist{
- UID: task.DoerID,
- }
- }
- task.Doer = &doer
-
- return nil
- }
-
- // LoadOwner loads owner user
- func (task *Task) LoadOwner() error {
- if task.Owner != nil {
- return nil
- }
-
- var owner user_model.User
- has, err := db.GetEngine(db.DefaultContext).ID(task.OwnerID).Get(&owner)
- if err != nil {
- return err
- } else if !has {
- return user_model.ErrUserNotExist{
- UID: task.OwnerID,
- }
- }
- task.Owner = &owner
-
- return nil
- }
-
- // UpdateCols updates some columns
- func (task *Task) UpdateCols(cols ...string) error {
- _, err := db.GetEngine(db.DefaultContext).ID(task.ID).Cols(cols...).Update(task)
- return err
- }
-
- // MigrateConfig returns task config when migrate repository
- func (task *Task) MigrateConfig() (*migration.MigrateOptions, error) {
- if task.Type == structs.TaskTypeMigrateRepo {
- var opts migration.MigrateOptions
- err := json.Unmarshal([]byte(task.PayloadContent), &opts)
- if err != nil {
- return nil, err
- }
-
- // decrypt credentials
- if opts.CloneAddrEncrypted != "" {
- if opts.CloneAddr, err = secret.DecryptSecret(setting.SecretKey, opts.CloneAddrEncrypted); err != nil {
- return nil, err
- }
- }
- if opts.AuthPasswordEncrypted != "" {
- if opts.AuthPassword, err = secret.DecryptSecret(setting.SecretKey, opts.AuthPasswordEncrypted); err != nil {
- return nil, err
- }
- }
- if opts.AuthTokenEncrypted != "" {
- if opts.AuthToken, err = secret.DecryptSecret(setting.SecretKey, opts.AuthTokenEncrypted); err != nil {
- return nil, err
- }
- }
-
- return &opts, nil
- }
- return nil, fmt.Errorf("Task type is %s, not Migrate Repo", task.Type.Name())
- }
-
- // ErrTaskDoesNotExist represents a "TaskDoesNotExist" kind of error.
- type ErrTaskDoesNotExist struct {
- ID int64
- RepoID int64
- Type structs.TaskType
- }
-
- // IsErrTaskDoesNotExist checks if an error is a ErrTaskIsNotExist.
- func IsErrTaskDoesNotExist(err error) bool {
- _, ok := err.(ErrTaskDoesNotExist)
- return ok
- }
-
- func (err ErrTaskDoesNotExist) Error() string {
- return fmt.Sprintf("task is not exist [id: %d, repo_id: %d, type: %d]",
- err.ID, err.RepoID, err.Type)
- }
-
- // GetMigratingTask returns the migrating task by repo's id
- func GetMigratingTask(repoID int64) (*Task, error) {
- task := Task{
- RepoID: repoID,
- Type: structs.TaskTypeMigrateRepo,
- }
- has, err := db.GetEngine(db.DefaultContext).Get(&task)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrTaskDoesNotExist{0, repoID, task.Type}
- }
- return &task, nil
- }
-
- // HasFinishedMigratingTask returns if a finished migration task exists for the repo.
- func HasFinishedMigratingTask(repoID int64) (bool, error) {
- return db.GetEngine(db.DefaultContext).
- Where("repo_id=? AND type=? AND status=?", repoID, structs.TaskTypeMigrateRepo, structs.TaskStatusFinished).
- Table("task").
- Exist()
- }
-
- // GetMigratingTaskByID returns the migrating task by repo's id
- func GetMigratingTaskByID(id, doerID int64) (*Task, *migration.MigrateOptions, error) {
- task := Task{
- ID: id,
- DoerID: doerID,
- Type: structs.TaskTypeMigrateRepo,
- }
- has, err := db.GetEngine(db.DefaultContext).Get(&task)
- if err != nil {
- return nil, nil, err
- } else if !has {
- return nil, nil, ErrTaskDoesNotExist{id, 0, task.Type}
- }
-
- var opts migration.MigrateOptions
- if err := json.Unmarshal([]byte(task.PayloadContent), &opts); err != nil {
- return nil, nil, err
- }
- return &task, &opts, nil
- }
-
- // FindTaskOptions find all tasks
- type FindTaskOptions struct {
- Status int
- }
-
- // ToConds generates conditions for database operation.
- func (opts FindTaskOptions) ToConds() builder.Cond {
- cond := builder.NewCond()
- if opts.Status >= 0 {
- cond = cond.And(builder.Eq{"status": opts.Status})
- }
- return cond
- }
-
- // FindTasks find all tasks
- func FindTasks(opts FindTaskOptions) ([]*Task, error) {
- tasks := make([]*Task, 0, 10)
- err := db.GetEngine(db.DefaultContext).Where(opts.ToConds()).Find(&tasks)
- return tasks, err
- }
-
- // CreateTask creates a task on database
- func CreateTask(task *Task) error {
- return db.Insert(db.DefaultContext, task)
- }
-
- // FinishMigrateTask updates database when migrate task finished
- func FinishMigrateTask(task *Task) error {
- task.Status = structs.TaskStatusFinished
- task.EndTime = timeutil.TimeStampNow()
-
- // delete credentials when we're done, they're a liability.
- conf, err := task.MigrateConfig()
- if err != nil {
- return err
- }
- conf.AuthPassword = ""
- conf.AuthToken = ""
- conf.CloneAddr = util.SanitizeCredentialURLs(conf.CloneAddr)
- conf.AuthPasswordEncrypted = ""
- conf.AuthTokenEncrypted = ""
- conf.CloneAddrEncrypted = ""
- confBytes, err := json.Marshal(conf)
- if err != nil {
- return err
- }
- task.PayloadContent = string(confBytes)
-
- _, err = db.GetEngine(db.DefaultContext).ID(task.ID).Cols("status", "end_time", "payload_content").Update(task)
- return err
- }
|