refactor: prepare to decouple the "model migration" package and "models" package (#38533)

Migrations should never use model structs directly, because the model
structs can be different in different releases. e.g. if one migration uses
"User" model, it works in the early releases, then one day, when the
User model changes, the migration breaks because it will use the
new (incorrect) User model, it should only use the old User model.

The same to "modules/structs".

---------

Signed-off-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: delvh <dev.lh@web.de>

modelmigration/v1_6/v70.go

@@ -0,0 +1,109 @@
+// Copyright 2018 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_6
+
+import (
+	"fmt"
+	"time"
+
+	"gitea.dev/modelmigration/base"
+	"gitea.dev/modules/setting"
+)
+
+func AddIssueDependencies(x base.EngineMigration) (err error) {
+	type IssueDependency struct {
+		ID           int64     `xorm:"pk autoincr"`
+		UserID       int64     `xorm:"NOT NULL"`
+		IssueID      int64     `xorm:"NOT NULL"`
+		DependencyID int64     `xorm:"NOT NULL"`
+		Created      time.Time `xorm:"-"`
+		CreatedUnix  int64     `xorm:"created"`
+		Updated      time.Time `xorm:"-"`
+		UpdatedUnix  int64     `xorm:"updated"`
+	}
+
+	const (
+		v16UnitTypeCode            = iota + 1 // 1 code
+		v16UnitTypeIssues                     // 2 issues
+		v16UnitTypePRs                        // 3 PRs
+		v16UnitTypeCommits                    // 4 Commits
+		v16UnitTypeReleases                   // 5 Releases
+		v16UnitTypeWiki                       // 6 Wiki
+		v16UnitTypeSettings                   // 7 Settings
+		v16UnitTypeExternalWiki               // 8 ExternalWiki
+		v16UnitTypeExternalTracker            // 9 ExternalTracker
+	)
+
+	if err = x.Sync(new(IssueDependency)); err != nil {
+		return fmt.Errorf("Error creating issue_dependency_table column definition: %w", err)
+	}
+
+	// Update Comment definition
+	// This (copied) struct does only contain fields used by xorm as the only use here is to update the database
+
+	// CommentType defines the comment type
+	type CommentType int
+
+	// TimeStamp defines a timestamp
+	type TimeStamp int64
+
+	type Comment struct {
+		ID               int64 `xorm:"pk autoincr"`
+		Type             CommentType
+		PosterID         int64 `xorm:"INDEX"`
+		IssueID          int64 `xorm:"INDEX"`
+		LabelID          int64
+		OldMilestoneID   int64
+		MilestoneID      int64
+		OldAssigneeID    int64
+		AssigneeID       int64
+		OldTitle         string
+		NewTitle         string
+		DependentIssueID int64
+
+		CommitID int64
+		Line     int64
+		Content  string `xorm:"TEXT"`
+
+		CreatedUnix TimeStamp `xorm:"INDEX created"`
+		UpdatedUnix TimeStamp `xorm:"INDEX updated"`
+
+		// Reference issue in commit message
+		CommitSHA string `xorm:"VARCHAR(40)"`
+	}
+
+	if err = x.Sync(new(Comment)); err != nil {
+		return fmt.Errorf("Error updating issue_comment table column definition: %w", err)
+	}
+
+	// RepoUnit describes all units of a repository
+	type RepoUnit struct {
+		ID          int64
+		RepoID      int64          `xorm:"INDEX(s)"`
+		Type        int            `xorm:"INDEX(s)"`
+		Config      map[string]any `xorm:"JSON"`
+		CreatedUnix int64          `xorm:"INDEX CREATED"`
+		Created     time.Time      `xorm:"-"`
+	}
+
+	// Updating existing issue units
+	units := make([]*RepoUnit, 0, 100)
+	err = x.Where("`type` = ?", v16UnitTypeIssues).Find(&units)
+	if err != nil {
+		return fmt.Errorf("Query repo units: %w", err)
+	}
+	for _, unit := range units {
+		if unit.Config == nil {
+			unit.Config = make(map[string]any)
+		}
+		if _, ok := unit.Config["EnableDependencies"]; !ok {
+			unit.Config["EnableDependencies"] = setting.Service.DefaultEnableDependencies
+		}
+		if _, err := x.ID(unit.ID).Cols("config").Update(unit); err != nil {
+			return err
+		}
+	}
+
+	return err
+}

modelmigration/v1_6/v71.go

@@ -0,0 +1,74 @@
+// Copyright 2018 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_6
+
+import (
+	"fmt"
+
+	"gitea.dev/modelmigration/base"
+	"gitea.dev/modules/timeutil"
+	"gitea.dev/modules/util"
+)
+
+func AddScratchHash(x base.EngineMigration) error {
+	// TwoFactor see models/twofactor.go
+	type TwoFactor struct {
+		ID               int64 `xorm:"pk autoincr"`
+		UID              int64 `xorm:"UNIQUE"`
+		Secret           string
+		ScratchToken     string
+		ScratchSalt      string
+		ScratchHash      string
+		LastUsedPasscode string             `xorm:"VARCHAR(10)"`
+		CreatedUnix      timeutil.TimeStamp `xorm:"INDEX created"`
+		UpdatedUnix      timeutil.TimeStamp `xorm:"INDEX updated"`
+	}
+
+	if err := x.Sync(new(TwoFactor)); err != nil {
+		return fmt.Errorf("Sync: %w", err)
+	}
+
+	sess := x.NewSession()
+	defer sess.Close()
+
+	if err := sess.Begin(); err != nil {
+		return err
+	}
+
+	// transform all tokens to hashes
+	const batchSize = 100
+	for start := 0; ; start += batchSize {
+		tfas := make([]*TwoFactor, 0, batchSize)
+		if err := sess.Limit(batchSize, start).Find(&tfas); err != nil {
+			return err
+		}
+		if len(tfas) == 0 {
+			break
+		}
+
+		for _, tfa := range tfas {
+			// generate salt
+			salt := util.CryptoRandomString(10)
+			tfa.ScratchSalt = salt
+			tfa.ScratchHash = base.HashToken(tfa.ScratchToken, salt)
+
+			if _, err := sess.ID(tfa.ID).Cols("scratch_salt, scratch_hash").Update(tfa); err != nil {
+				return fmt.Errorf("couldn't add in scratch_hash and scratch_salt: %w", err)
+			}
+		}
+	}
+
+	// Commit and begin new transaction for dropping columns
+	if err := sess.Commit(); err != nil {
+		return err
+	}
+	if err := sess.Begin(); err != nil {
+		return err
+	}
+
+	if err := base.DropTableColumns(sess, "two_factor", "scratch_token"); err != nil {
+		return err
+	}
+	return sess.Commit()
+}

modelmigration/v1_6/v72.go

@@ -0,0 +1,29 @@
+// Copyright 2018 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package v1_6
+
+import (
+	"fmt"
+
+	"gitea.dev/modelmigration/base"
+	"gitea.dev/modules/timeutil"
+)
+
+func AddReview(x base.EngineMigration) error {
+	// Review see models/review.go
+	type Review struct {
+		ID          int64 `xorm:"pk autoincr"`
+		Type        string
+		ReviewerID  int64 `xorm:"index"`
+		IssueID     int64 `xorm:"index"`
+		Content     string
+		CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
+		UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
+	}
+
+	if err := x.Sync(new(Review)); err != nil {
+		return fmt.Errorf("Sync: %w", err)
+	}
+	return nil
+}