From f2772b5920967f5dacc3de27dee2bc1b464533e2 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Mon, 13 Feb 2023 13:11:41 +0800 Subject: Move delete user to service (#22478) Move delete user to service Co-authored-by: delvh Co-authored-by: Jason Song --- models/db/context.go | 26 +++++++ models/user.go | 189 ----------------------------------------------- services/user/delete.go | 191 ++++++++++++++++++++++++++++++++++++++++++++++++ services/user/user.go | 2 +- 4 files changed, 218 insertions(+), 190 deletions(-) delete mode 100644 models/user.go create mode 100644 services/user/delete.go diff --git a/models/db/context.go b/models/db/context.go index 911dbd1c6f..4b3f7f0ee7 100644 --- a/models/db/context.go +++ b/models/db/context.go @@ -7,6 +7,7 @@ import ( "context" "database/sql" + "xorm.io/builder" "xorm.io/xorm" "xorm.io/xorm/schemas" ) @@ -183,6 +184,31 @@ func DeleteByBean(ctx context.Context, bean interface{}) (int64, error) { return GetEngine(ctx).Delete(bean) } +// DeleteByID deletes the given bean with the given ID +func DeleteByID(ctx context.Context, id int64, bean interface{}) (int64, error) { + return GetEngine(ctx).ID(id).NoAutoTime().Delete(bean) +} + +// FindIDs finds the IDs for the given table name satisfying the given condition +// By passing a different value than "id" for "idCol", you can query for foreign IDs, i.e. the repo IDs which satisfy the condition +func FindIDs(ctx context.Context, tableName, idCol string, cond builder.Cond) ([]int64, error) { + ids := make([]int64, 0, 10) + if err := GetEngine(ctx).Table(tableName). + Cols(idCol). + Where(cond). + Find(&ids); err != nil { + return nil, err + } + return ids, nil +} + +// DecrByIDs decreases the given column for entities of the "bean" type with one of the given ids by one +// Timestamps of the entities won't be updated +func DecrByIDs(ctx context.Context, ids []int64, decrCol string, bean interface{}) error { + _, err := GetEngine(ctx).Decr(decrCol).In("id", ids).NoAutoCondition().NoAutoTime().Update(bean) + return err +} + // DeleteBeans deletes all given beans, beans should contain delete conditions. func DeleteBeans(ctx context.Context, beans ...interface{}) (err error) { e := GetEngine(ctx) diff --git a/models/user.go b/models/user.go deleted file mode 100644 index 746553c35b..0000000000 --- a/models/user.go +++ /dev/null @@ -1,189 +0,0 @@ -// Copyright 2014 The Gogs Authors. All rights reserved. -// Copyright 2019 The Gitea Authors. All rights reserved. -// SPDX-License-Identifier: MIT - -package models - -import ( - "context" - "fmt" - "time" - - _ "image/jpeg" // Needed for jpeg support - - activities_model "code.gitea.io/gitea/models/activities" - asymkey_model "code.gitea.io/gitea/models/asymkey" - auth_model "code.gitea.io/gitea/models/auth" - "code.gitea.io/gitea/models/db" - git_model "code.gitea.io/gitea/models/git" - issues_model "code.gitea.io/gitea/models/issues" - "code.gitea.io/gitea/models/organization" - access_model "code.gitea.io/gitea/models/perm/access" - pull_model "code.gitea.io/gitea/models/pull" - repo_model "code.gitea.io/gitea/models/repo" - user_model "code.gitea.io/gitea/models/user" - "code.gitea.io/gitea/modules/setting" -) - -// DeleteUser deletes models associated to an user. -func DeleteUser(ctx context.Context, u *user_model.User, purge bool) (err error) { - e := db.GetEngine(ctx) - - // ***** START: Watch ***** - watchedRepoIDs := make([]int64, 0, 10) - if err = e.Table("watch").Cols("watch.repo_id"). - Where("watch.user_id = ?", u.ID).And("watch.mode <>?", repo_model.WatchModeDont).Find(&watchedRepoIDs); err != nil { - return fmt.Errorf("get all watches: %w", err) - } - if _, err = e.Decr("num_watches").In("id", watchedRepoIDs).NoAutoTime().Update(new(repo_model.Repository)); err != nil { - return fmt.Errorf("decrease repository num_watches: %w", err) - } - // ***** END: Watch ***** - - // ***** START: Star ***** - starredRepoIDs := make([]int64, 0, 10) - if err = e.Table("star").Cols("star.repo_id"). - Where("star.uid = ?", u.ID).Find(&starredRepoIDs); err != nil { - return fmt.Errorf("get all stars: %w", err) - } else if _, err = e.Decr("num_stars").In("id", starredRepoIDs).NoAutoTime().Update(new(repo_model.Repository)); err != nil { - return fmt.Errorf("decrease repository num_stars: %w", err) - } - // ***** END: Star ***** - - // ***** START: Follow ***** - followeeIDs := make([]int64, 0, 10) - if err = e.Table("follow").Cols("follow.follow_id"). - Where("follow.user_id = ?", u.ID).Find(&followeeIDs); err != nil { - return fmt.Errorf("get all followees: %w", err) - } else if _, err = e.Decr("num_followers").In("id", followeeIDs).Update(new(user_model.User)); err != nil { - return fmt.Errorf("decrease user num_followers: %w", err) - } - - followerIDs := make([]int64, 0, 10) - if err = e.Table("follow").Cols("follow.user_id"). - Where("follow.follow_id = ?", u.ID).Find(&followerIDs); err != nil { - return fmt.Errorf("get all followers: %w", err) - } else if _, err = e.Decr("num_following").In("id", followerIDs).Update(new(user_model.User)); err != nil { - return fmt.Errorf("decrease user num_following: %w", err) - } - // ***** END: Follow ***** - - if err = db.DeleteBeans(ctx, - &auth_model.AccessToken{UID: u.ID}, - &repo_model.Collaboration{UserID: u.ID}, - &access_model.Access{UserID: u.ID}, - &repo_model.Watch{UserID: u.ID}, - &repo_model.Star{UID: u.ID}, - &user_model.Follow{UserID: u.ID}, - &user_model.Follow{FollowID: u.ID}, - &activities_model.Action{UserID: u.ID}, - &issues_model.IssueUser{UID: u.ID}, - &user_model.EmailAddress{UID: u.ID}, - &user_model.UserOpenID{UID: u.ID}, - &issues_model.Reaction{UserID: u.ID}, - &organization.TeamUser{UID: u.ID}, - &issues_model.Stopwatch{UserID: u.ID}, - &user_model.Setting{UserID: u.ID}, - &user_model.UserBadge{UserID: u.ID}, - &pull_model.AutoMerge{DoerID: u.ID}, - &pull_model.ReviewState{UserID: u.ID}, - &user_model.Redirect{RedirectUserID: u.ID}, - ); err != nil { - return fmt.Errorf("deleteBeans: %w", err) - } - - if err := auth_model.DeleteOAuth2RelictsByUserID(ctx, u.ID); err != nil { - return err - } - - if purge || (setting.Service.UserDeleteWithCommentsMaxTime != 0 && - u.CreatedUnix.AsTime().Add(setting.Service.UserDeleteWithCommentsMaxTime).After(time.Now())) { - - // Delete Comments - const batchSize = 50 - for { - comments := make([]*issues_model.Comment, 0, batchSize) - if err = e.Where("type=? AND poster_id=?", issues_model.CommentTypeComment, u.ID).Limit(batchSize, 0).Find(&comments); err != nil { - return err - } - if len(comments) == 0 { - break - } - - for _, comment := range comments { - if err = issues_model.DeleteComment(ctx, comment); err != nil { - return err - } - } - } - - // Delete Reactions - if err = issues_model.DeleteReaction(ctx, &issues_model.ReactionOptions{DoerID: u.ID}); err != nil { - return err - } - } - - // ***** START: Branch Protections ***** - { - const batchSize = 50 - for start := 0; ; start += batchSize { - protections := make([]*git_model.ProtectedBranch, 0, batchSize) - // @perf: We can't filter on DB side by u.ID, as those IDs are serialized as JSON strings. - // We could filter down with `WHERE repo_id IN (reposWithPushPermission(u))`, - // though that query will be quite complex and tricky to maintain (compare `getRepoAssignees()`). - // Also, as we didn't update branch protections when removing entries from `access` table, - // it's safer to iterate all protected branches. - if err = e.Limit(batchSize, start).Find(&protections); err != nil { - return fmt.Errorf("findProtectedBranches: %w", err) - } - if len(protections) == 0 { - break - } - for _, p := range protections { - if err := git_model.RemoveUserIDFromProtectedBranch(ctx, p, u.ID); err != nil { - return err - } - } - } - } - // ***** END: Branch Protections ***** - - // ***** START: PublicKey ***** - if _, err = db.DeleteByBean(ctx, &asymkey_model.PublicKey{OwnerID: u.ID}); err != nil { - return fmt.Errorf("deletePublicKeys: %w", err) - } - // ***** END: PublicKey ***** - - // ***** START: GPGPublicKey ***** - keys, err := asymkey_model.ListGPGKeys(ctx, u.ID, db.ListOptions{}) - if err != nil { - return fmt.Errorf("ListGPGKeys: %w", err) - } - // Delete GPGKeyImport(s). - for _, key := range keys { - if _, err = db.DeleteByBean(ctx, &asymkey_model.GPGKeyImport{KeyID: key.KeyID}); err != nil { - return fmt.Errorf("deleteGPGKeyImports: %w", err) - } - } - if _, err = db.DeleteByBean(ctx, &asymkey_model.GPGKey{OwnerID: u.ID}); err != nil { - return fmt.Errorf("deleteGPGKeys: %w", err) - } - // ***** END: GPGPublicKey ***** - - // Clear assignee. - if _, err = db.DeleteByBean(ctx, &issues_model.IssueAssignees{AssigneeID: u.ID}); err != nil { - return fmt.Errorf("clear assignee: %w", err) - } - - // ***** START: ExternalLoginUser ***** - if err = user_model.RemoveAllAccountLinks(ctx, u); err != nil { - return fmt.Errorf("ExternalLoginUser: %w", err) - } - // ***** END: ExternalLoginUser ***** - - if _, err = e.ID(u.ID).Delete(new(user_model.User)); err != nil { - return fmt.Errorf("delete: %w", err) - } - - return nil -} diff --git a/services/user/delete.go b/services/user/delete.go new file mode 100644 index 0000000000..01e3c37b39 --- /dev/null +++ b/services/user/delete.go @@ -0,0 +1,191 @@ +// Copyright 2023 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package user + +import ( + "context" + "fmt" + "time" + + _ "image/jpeg" // Needed for jpeg support + + activities_model "code.gitea.io/gitea/models/activities" + asymkey_model "code.gitea.io/gitea/models/asymkey" + auth_model "code.gitea.io/gitea/models/auth" + "code.gitea.io/gitea/models/db" + git_model "code.gitea.io/gitea/models/git" + issues_model "code.gitea.io/gitea/models/issues" + "code.gitea.io/gitea/models/organization" + access_model "code.gitea.io/gitea/models/perm/access" + pull_model "code.gitea.io/gitea/models/pull" + repo_model "code.gitea.io/gitea/models/repo" + user_model "code.gitea.io/gitea/models/user" + "code.gitea.io/gitea/modules/setting" + + "xorm.io/builder" +) + +// deleteUser deletes models associated to an user. +func deleteUser(ctx context.Context, u *user_model.User, purge bool) (err error) { + e := db.GetEngine(ctx) + + // ***** START: Watch ***** + watchedRepoIDs, err := db.FindIDs(ctx, "watch", "watch.repo_id", + builder.Eq{"watch.user_id": u.ID}. + And(builder.Neq{"watch.mode": repo_model.WatchModeDont})) + if err != nil { + return fmt.Errorf("get all watches: %w", err) + } + if err = db.DecrByIDs(ctx, watchedRepoIDs, "num_watches", new(repo_model.Repository)); err != nil { + return fmt.Errorf("decrease repository num_watches: %w", err) + } + // ***** END: Watch ***** + + // ***** START: Star ***** + starredRepoIDs, err := db.FindIDs(ctx, "star", "star.repo_id", + builder.Eq{"star.uid": u.ID}) + if err != nil { + return fmt.Errorf("get all stars: %w", err) + } else if err = db.DecrByIDs(ctx, starredRepoIDs, "num_stars", new(repo_model.Repository)); err != nil { + return fmt.Errorf("decrease repository num_stars: %w", err) + } + // ***** END: Star ***** + + // ***** START: Follow ***** + followeeIDs, err := db.FindIDs(ctx, "follow", "follow.follow_id", + builder.Eq{"follow.user_id": u.ID}) + if err != nil { + return fmt.Errorf("get all followees: %w", err) + } else if err = db.DecrByIDs(ctx, followeeIDs, "num_followers", new(user_model.User)); err != nil { + return fmt.Errorf("decrease user num_followers: %w", err) + } + + followerIDs, err := db.FindIDs(ctx, "follow", "follow.user_id", + builder.Eq{"follow.follow_id": u.ID}) + if err != nil { + return fmt.Errorf("get all followers: %w", err) + } else if err = db.DecrByIDs(ctx, followerIDs, "num_following", new(user_model.User)); err != nil { + return fmt.Errorf("decrease user num_following: %w", err) + } + // ***** END: Follow ***** + + if err = db.DeleteBeans(ctx, + &auth_model.AccessToken{UID: u.ID}, + &repo_model.Collaboration{UserID: u.ID}, + &access_model.Access{UserID: u.ID}, + &repo_model.Watch{UserID: u.ID}, + &repo_model.Star{UID: u.ID}, + &user_model.Follow{UserID: u.ID}, + &user_model.Follow{FollowID: u.ID}, + &activities_model.Action{UserID: u.ID}, + &issues_model.IssueUser{UID: u.ID}, + &user_model.EmailAddress{UID: u.ID}, + &user_model.UserOpenID{UID: u.ID}, + &issues_model.Reaction{UserID: u.ID}, + &organization.TeamUser{UID: u.ID}, + &issues_model.Stopwatch{UserID: u.ID}, + &user_model.Setting{UserID: u.ID}, + &user_model.UserBadge{UserID: u.ID}, + &pull_model.AutoMerge{DoerID: u.ID}, + &pull_model.ReviewState{UserID: u.ID}, + &user_model.Redirect{RedirectUserID: u.ID}, + ); err != nil { + return fmt.Errorf("deleteBeans: %w", err) + } + + if err := auth_model.DeleteOAuth2RelictsByUserID(ctx, u.ID); err != nil { + return err + } + + if purge || (setting.Service.UserDeleteWithCommentsMaxTime != 0 && + u.CreatedUnix.AsTime().Add(setting.Service.UserDeleteWithCommentsMaxTime).After(time.Now())) { + + // Delete Comments + const batchSize = 50 + for { + comments := make([]*issues_model.Comment, 0, batchSize) + if err = e.Where("type=? AND poster_id=?", issues_model.CommentTypeComment, u.ID).Limit(batchSize, 0).Find(&comments); err != nil { + return err + } + if len(comments) == 0 { + break + } + + for _, comment := range comments { + if err = issues_model.DeleteComment(ctx, comment); err != nil { + return err + } + } + } + + // Delete Reactions + if err = issues_model.DeleteReaction(ctx, &issues_model.ReactionOptions{DoerID: u.ID}); err != nil { + return err + } + } + + // ***** START: Branch Protections ***** + { + const batchSize = 50 + for start := 0; ; start += batchSize { + protections := make([]*git_model.ProtectedBranch, 0, batchSize) + // @perf: We can't filter on DB side by u.ID, as those IDs are serialized as JSON strings. + // We could filter down with `WHERE repo_id IN (reposWithPushPermission(u))`, + // though that query will be quite complex and tricky to maintain (compare `getRepoAssignees()`). + // Also, as we didn't update branch protections when removing entries from `access` table, + // it's safer to iterate all protected branches. + if err = e.Limit(batchSize, start).Find(&protections); err != nil { + return fmt.Errorf("findProtectedBranches: %w", err) + } + if len(protections) == 0 { + break + } + for _, p := range protections { + if err := git_model.RemoveUserIDFromProtectedBranch(ctx, p, u.ID); err != nil { + return err + } + } + } + } + // ***** END: Branch Protections ***** + + // ***** START: PublicKey ***** + if _, err = db.DeleteByBean(ctx, &asymkey_model.PublicKey{OwnerID: u.ID}); err != nil { + return fmt.Errorf("deletePublicKeys: %w", err) + } + // ***** END: PublicKey ***** + + // ***** START: GPGPublicKey ***** + keys, err := asymkey_model.ListGPGKeys(ctx, u.ID, db.ListOptions{}) + if err != nil { + return fmt.Errorf("ListGPGKeys: %w", err) + } + // Delete GPGKeyImport(s). + for _, key := range keys { + if _, err = db.DeleteByBean(ctx, &asymkey_model.GPGKeyImport{KeyID: key.KeyID}); err != nil { + return fmt.Errorf("deleteGPGKeyImports: %w", err) + } + } + if _, err = db.DeleteByBean(ctx, &asymkey_model.GPGKey{OwnerID: u.ID}); err != nil { + return fmt.Errorf("deleteGPGKeys: %w", err) + } + // ***** END: GPGPublicKey ***** + + // Clear assignee. + if _, err = db.DeleteByBean(ctx, &issues_model.IssueAssignees{AssigneeID: u.ID}); err != nil { + return fmt.Errorf("clear assignee: %w", err) + } + + // ***** START: ExternalLoginUser ***** + if err = user_model.RemoveAllAccountLinks(ctx, u); err != nil { + return fmt.Errorf("ExternalLoginUser: %w", err) + } + // ***** END: ExternalLoginUser ***** + + if _, err = db.DeleteByID(ctx, u.ID, new(user_model.User)); err != nil { + return fmt.Errorf("delete: %w", err) + } + + return nil +} diff --git a/services/user/user.go b/services/user/user.go index c95eb67a85..f0b8fe1c31 100644 --- a/services/user/user.go +++ b/services/user/user.go @@ -163,7 +163,7 @@ func DeleteUser(ctx context.Context, u *user_model.User, purge bool) error { return models.ErrUserOwnPackages{UID: u.ID} } - if err := models.DeleteUser(ctx, u, purge); err != nil { + if err := deleteUser(ctx, u, purge); err != nil { return fmt.Errorf("DeleteUser: %w", err) } -- cgit v1.2.3