diff --git a/models/migrations/migrations.go b/models/migrations/migrations.go
index 0d35ac78d3..1b2a743b6d 100644
--- a/models/migrations/migrations.go
+++ b/models/migrations/migrations.go
@@ -396,6 +396,8 @@ var migrations = []Migration{
NewMigration("Alter hook_task table TEXT fields to LONGTEXT", alterHookTaskTextFieldsToLongText),
// v218 -> v219
NewMigration("Improve Action table indices v2", improveActionTableIndices),
+ // v219 -> v220
+ NewMigration("Add sync_on_commit column to push_mirror table", addSyncOnCommitColForPushMirror),
}
// GetCurrentDBVersion returns the current db version
diff --git a/models/migrations/v219.go b/models/migrations/v219.go
new file mode 100644
index 0000000000..7b2eaa3292
--- /dev/null
+++ b/models/migrations/v219.go
@@ -0,0 +1,30 @@
+// Copyright 2022 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package migrations
+
+import (
+ "time"
+
+ "code.gitea.io/gitea/models/repo"
+ "code.gitea.io/gitea/modules/timeutil"
+ "xorm.io/xorm"
+)
+
+func addSyncOnCommitColForPushMirror(x *xorm.Engine) error {
+ type PushMirror struct {
+ ID int64 `xorm:"pk autoincr"`
+ RepoID int64 `xorm:"INDEX"`
+ Repo *repo.Repository `xorm:"-"`
+ RemoteName string
+
+ SyncOnCommit bool `xorm:"NOT NULL DEFAULT true"`
+ Interval time.Duration
+ CreatedUnix timeutil.TimeStamp `xorm:"created"`
+ LastUpdateUnix timeutil.TimeStamp `xorm:"INDEX last_update"`
+ LastError string `xorm:"text"`
+ }
+
+ return x.Sync2(new(PushMirror))
+}
diff --git a/models/repo/pushmirror.go b/models/repo/pushmirror.go
index 048c0c3487..0a7dea79c9 100644
--- a/models/repo/pushmirror.go
+++ b/models/repo/pushmirror.go
@@ -23,6 +23,7 @@ type PushMirror struct {
Repo *Repository `xorm:"-"`
RemoteName string
+ SyncOnCommit bool `xorm:"NOT NULL DEFAULT true"`
Interval time.Duration
CreatedUnix timeutil.TimeStamp `xorm:"created"`
LastUpdateUnix timeutil.TimeStamp `xorm:"INDEX last_update"`
@@ -93,6 +94,14 @@ func GetPushMirrorsByRepoID(repoID int64) ([]*PushMirror, error) {
return mirrors, db.GetEngine(db.DefaultContext).Where("repo_id=?", repoID).Find(&mirrors)
}
+// GetPushMirrorsSyncedOnCommit returns push-mirrors for this repo that should be updated by new commits
+func GetPushMirrorsSyncedOnCommit(repoID int64) ([]*PushMirror, error) {
+ mirrors := make([]*PushMirror, 0, 10)
+ return mirrors, db.GetEngine(db.DefaultContext).
+ Where("repo_id=? AND sync_on_commit=?", repoID, true).
+ Find(&mirrors)
+}
+
// PushMirrorsIterate iterates all push-mirror repositories.
func PushMirrorsIterate(limit int, f func(idx int, bean interface{}) error) error {
return db.GetEngine(db.DefaultContext).
diff --git a/modules/mirror/mirror.go b/modules/mirror/mirror.go
new file mode 100644
index 0000000000..b261bd0242
--- /dev/null
+++ b/modules/mirror/mirror.go
@@ -0,0 +1,69 @@
+// Copyright 2022 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package mirror
+
+import (
+ "code.gitea.io/gitea/modules/graceful"
+ "code.gitea.io/gitea/modules/log"
+ "code.gitea.io/gitea/modules/queue"
+ "code.gitea.io/gitea/modules/setting"
+)
+
+var mirrorQueue queue.UniqueQueue
+
+// SyncType type of sync request
+type SyncType int
+
+const (
+ // PullMirrorType for pull mirrors
+ PullMirrorType SyncType = iota
+ // PushMirrorType for push mirrors
+ PushMirrorType
+)
+
+// SyncRequest for the mirror queue
+type SyncRequest struct {
+ Type SyncType
+ ReferenceID int64 // RepoID for pull mirror, MirrorID for push mirror
+}
+
+// StartSyncMirrors starts a go routine to sync the mirrors
+func StartSyncMirrors(queueHandle func(data ...queue.Data) []queue.Data) {
+ if !setting.Mirror.Enabled {
+ return
+ }
+ mirrorQueue = queue.CreateUniqueQueue("mirror", queueHandle, new(SyncRequest))
+
+ go graceful.GetManager().RunWithShutdownFns(mirrorQueue.Run)
+}
+
+// AddPullMirrorToQueue adds repoID to mirror queue
+func AddPullMirrorToQueue(repoID int64) {
+ addMirrorToQueue(PullMirrorType, repoID)
+}
+
+// AddPushMirrorToQueue adds the push mirror to the queue
+func AddPushMirrorToQueue(mirrorID int64) {
+ addMirrorToQueue(PushMirrorType, mirrorID)
+}
+
+func addMirrorToQueue(syncType SyncType, referenceID int64) {
+ if !setting.Mirror.Enabled {
+ return
+ }
+ go func() {
+ if err := PushToQueue(syncType, referenceID); err != nil {
+ log.Error("Unable to push sync request for to the queue for pull mirror repo[%d]. Error: %v", referenceID, err)
+ }
+ }()
+}
+
+// PushToQueue adds the sync request to the queue
+func PushToQueue(mirrorType SyncType, referenceID int64) error {
+ return mirrorQueue.Push(&SyncRequest{
+ Type: mirrorType,
+ ReferenceID: referenceID,
+ })
+}
diff --git a/modules/notification/mirror/mirror.go b/modules/notification/mirror/mirror.go
new file mode 100644
index 0000000000..646b09a4ab
--- /dev/null
+++ b/modules/notification/mirror/mirror.go
@@ -0,0 +1,45 @@
+// Copyright 2022 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package mirror
+
+import (
+ repo_model "code.gitea.io/gitea/models/repo"
+ user_model "code.gitea.io/gitea/models/user"
+ "code.gitea.io/gitea/modules/log"
+ mirror_module "code.gitea.io/gitea/modules/mirror"
+ "code.gitea.io/gitea/modules/notification/base"
+ "code.gitea.io/gitea/modules/repository"
+)
+
+type mirrorNotifier struct {
+ base.NullNotifier
+}
+
+var _ base.Notifier = &mirrorNotifier{}
+
+// NewNotifier create a new mirrorNotifier notifier
+func NewNotifier() base.Notifier {
+ return &mirrorNotifier{}
+}
+
+func (m *mirrorNotifier) NotifyPushCommits(_ *user_model.User, repo *repo_model.Repository, _ *repository.PushUpdateOptions, _ *repository.PushCommits) {
+ syncPushMirrorWithSyncOnCommit(repo.ID)
+}
+
+func (m *mirrorNotifier) NotifySyncPushCommits(_ *user_model.User, repo *repo_model.Repository, _ *repository.PushUpdateOptions, _ *repository.PushCommits) {
+ syncPushMirrorWithSyncOnCommit(repo.ID)
+}
+
+func syncPushMirrorWithSyncOnCommit(repoID int64) {
+ pushMirrors, err := repo_model.GetPushMirrorsSyncedOnCommit(repoID)
+ if err != nil {
+ log.Error("repo_model.GetPushMirrorsSyncedOnCommit failed: %v", err)
+ return
+ }
+
+ for _, mirror := range pushMirrors {
+ mirror_module.AddPushMirrorToQueue(mirror.ID)
+ }
+}
diff --git a/modules/notification/notification.go b/modules/notification/notification.go
index d60a880bec..bdfed90b78 100644
--- a/modules/notification/notification.go
+++ b/modules/notification/notification.go
@@ -14,6 +14,7 @@ import (
"code.gitea.io/gitea/modules/notification/base"
"code.gitea.io/gitea/modules/notification/indexer"
"code.gitea.io/gitea/modules/notification/mail"
+ "code.gitea.io/gitea/modules/notification/mirror"
"code.gitea.io/gitea/modules/notification/ui"
"code.gitea.io/gitea/modules/notification/webhook"
"code.gitea.io/gitea/modules/repository"
@@ -37,6 +38,7 @@ func NewContext() {
RegisterNotifier(indexer.NewNotifier())
RegisterNotifier(webhook.NewNotifier())
RegisterNotifier(action.NewNotifier())
+ RegisterNotifier(mirror.NewNotifier())
}
// NotifyCreateIssueComment notifies issue comment related message to notifiers
diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini
index eb7ae47743..464a7d396c 100644
--- a/options/locale/locale_en-US.ini
+++ b/options/locale/locale_en-US.ini
@@ -861,8 +861,9 @@ default_branch = Default Branch
default_branch_helper = The default branch is the base branch for pull requests and code commits.
mirror_prune = Prune
mirror_prune_desc = Remove obsolete remote-tracking references
-mirror_interval = Mirror Interval (valid time units are 'h', 'm', 's'). 0 to disable automatic sync. (Minimum interval: %s)
+mirror_interval = Mirror Interval (valid time units are 'h', 'm', 's'). 0 to disable periodic sync. (Minimum interval: %s)
mirror_interval_invalid = The mirror interval is not valid.
+mirror_sync_on_commit = Sync when commits are pushed
mirror_address = Clone From URL
mirror_address_desc = Put any required credentials in the Authorization section.
mirror_address_url_invalid = The provided url is invalid. You must escape all components of the url correctly.
diff --git a/routers/api/v1/repo/mirror.go b/routers/api/v1/repo/mirror.go
index 1af63c55be..3d29383550 100644
--- a/routers/api/v1/repo/mirror.go
+++ b/routers/api/v1/repo/mirror.go
@@ -11,8 +11,8 @@ import (
repo_model "code.gitea.io/gitea/models/repo"
"code.gitea.io/gitea/models/unit"
"code.gitea.io/gitea/modules/context"
+ mirror_module "code.gitea.io/gitea/modules/mirror"
"code.gitea.io/gitea/modules/setting"
- mirror_service "code.gitea.io/gitea/services/mirror"
)
// MirrorSync adds a mirrored repository to the sync queue
@@ -59,7 +59,7 @@ func MirrorSync(ctx *context.APIContext) {
return
}
- mirror_service.StartToMirror(repo.ID)
+ mirror_module.AddPullMirrorToQueue(repo.ID)
ctx.Status(http.StatusOK)
}
diff --git a/routers/web/repo/setting.go b/routers/web/repo/setting.go
index fae62c1020..5ded0561c6 100644
--- a/routers/web/repo/setting.go
+++ b/routers/web/repo/setting.go
@@ -29,6 +29,7 @@ import (
"code.gitea.io/gitea/modules/indexer/stats"
"code.gitea.io/gitea/modules/lfs"
"code.gitea.io/gitea/modules/log"
+ mirror_module "code.gitea.io/gitea/modules/mirror"
"code.gitea.io/gitea/modules/repository"
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/structs"
@@ -272,7 +273,7 @@ func SettingsPost(ctx *context.Context) {
return
}
- mirror_service.StartToMirror(repo.ID)
+ mirror_module.AddPullMirrorToQueue(repo.ID)
ctx.Flash.Info(ctx.Tr("repo.settings.mirror_sync_in_progress"))
ctx.Redirect(repo.Link() + "/settings")
@@ -289,7 +290,7 @@ func SettingsPost(ctx *context.Context) {
return
}
- mirror_service.AddPushMirrorToQueue(m.ID)
+ mirror_module.AddPushMirrorToQueue(m.ID)
ctx.Flash.Info(ctx.Tr("repo.settings.mirror_sync_in_progress"))
ctx.Redirect(repo.Link() + "/settings")
@@ -357,10 +358,11 @@ func SettingsPost(ctx *context.Context) {
}
m := &repo_model.PushMirror{
- RepoID: repo.ID,
- Repo: repo,
- RemoteName: fmt.Sprintf("remote_mirror_%s", remoteSuffix),
- Interval: interval,
+ RepoID: repo.ID,
+ Repo: repo,
+ RemoteName: fmt.Sprintf("remote_mirror_%s", remoteSuffix),
+ SyncOnCommit: form.PushMirrorSyncOnCommit,
+ Interval: interval,
}
if err := repo_model.InsertPushMirror(m); err != nil {
ctx.ServerError("InsertPushMirror", err)
diff --git a/services/forms/repo_form.go b/services/forms/repo_form.go
index c9327bbd9b..afecc205f3 100644
--- a/services/forms/repo_form.go
+++ b/services/forms/repo_form.go
@@ -115,23 +115,24 @@ func ParseRemoteAddr(remoteAddr, authUsername, authPassword string) (string, err
// RepoSettingForm form for changing repository settings
type RepoSettingForm struct {
- RepoName string `binding:"Required;AlphaDashDot;MaxSize(100)"`
- Description string `binding:"MaxSize(255)"`
- Website string `binding:"ValidUrl;MaxSize(255)"`
- Interval string
- MirrorAddress string
- MirrorUsername string
- MirrorPassword string
- LFS bool `form:"mirror_lfs"`
- LFSEndpoint string `form:"mirror_lfs_endpoint"`
- PushMirrorID string
- PushMirrorAddress string
- PushMirrorUsername string
- PushMirrorPassword string
- PushMirrorInterval string
- Private bool
- Template bool
- EnablePrune bool
+ RepoName string `binding:"Required;AlphaDashDot;MaxSize(100)"`
+ Description string `binding:"MaxSize(255)"`
+ Website string `binding:"ValidUrl;MaxSize(255)"`
+ Interval string
+ MirrorAddress string
+ MirrorUsername string
+ MirrorPassword string
+ LFS bool `form:"mirror_lfs"`
+ LFSEndpoint string `form:"mirror_lfs_endpoint"`
+ PushMirrorID string
+ PushMirrorAddress string
+ PushMirrorUsername string
+ PushMirrorPassword string
+ PushMirrorSyncOnCommit bool
+ PushMirrorInterval string
+ Private bool
+ Template bool
+ EnablePrune bool
// Advanced settings
EnableWiki bool
diff --git a/services/mirror/mirror.go b/services/mirror/mirror.go
index 013adac0f4..8321829ad2 100644
--- a/services/mirror/mirror.go
+++ b/services/mirror/mirror.go
@@ -11,38 +11,21 @@ import (
repo_model "code.gitea.io/gitea/models/repo"
"code.gitea.io/gitea/modules/graceful"
"code.gitea.io/gitea/modules/log"
+ mirror_module "code.gitea.io/gitea/modules/mirror"
"code.gitea.io/gitea/modules/queue"
"code.gitea.io/gitea/modules/setting"
)
-var mirrorQueue queue.UniqueQueue
-
-// SyncType type of sync request
-type SyncType int
-
-const (
- // PullMirrorType for pull mirrors
- PullMirrorType SyncType = iota
- // PushMirrorType for push mirrors
- PushMirrorType
-)
-
-// SyncRequest for the mirror queue
-type SyncRequest struct {
- Type SyncType
- ReferenceID int64 // RepoID for pull mirror, MirrorID fro push mirror
-}
-
// doMirrorSync causes this request to mirror itself
-func doMirrorSync(ctx context.Context, req *SyncRequest) {
+func doMirrorSync(ctx context.Context, req *mirror_module.SyncRequest) {
if req.ReferenceID == 0 {
log.Warn("Skipping mirror sync request, no mirror ID was specified")
return
}
switch req.Type {
- case PushMirrorType:
+ case mirror_module.PushMirrorType:
_ = SyncPushMirror(ctx, req.ReferenceID)
- case PullMirrorType:
+ case mirror_module.PullMirrorType:
_ = SyncPullMirror(ctx, req.ReferenceID)
default:
log.Error("Unknown Request type in queue: %v for MirrorID[%d]", req.Type, req.ReferenceID)
@@ -60,28 +43,26 @@ func Update(ctx context.Context, pullLimit, pushLimit int) error {
log.Trace("Doing: Update")
handler := func(idx int, bean interface{}) error {
- var item SyncRequest
var repo *repo_model.Repository
+ var mirrorType mirror_module.SyncType
+ var referenceID int64
+
if m, ok := bean.(*repo_model.Mirror); ok {
if m.GetRepository() == nil {
log.Error("Disconnected mirror found: %d", m.ID)
return nil
}
repo = m.Repo
- item = SyncRequest{
- Type: PullMirrorType,
- ReferenceID: m.RepoID,
- }
+ mirrorType = mirror_module.PullMirrorType
+ referenceID = m.RepoID
} else if m, ok := bean.(*repo_model.PushMirror); ok {
if m.GetRepository() == nil {
log.Error("Disconnected push-mirror found: %d", m.ID)
return nil
}
repo = m.Repo
- item = SyncRequest{
- Type: PushMirrorType,
- ReferenceID: m.ID,
- }
+ mirrorType = mirror_module.PushMirrorType
+ referenceID = m.ID
} else {
log.Error("Unknown bean: %v", bean)
return nil
@@ -95,9 +76,9 @@ func Update(ctx context.Context, pullLimit, pushLimit int) error {
}
// Push to the Queue
- if err := mirrorQueue.Push(&item); err != nil {
+ if err := mirror_module.PushToQueue(mirrorType, referenceID); err != nil {
if err == queue.ErrAlreadyInQueue {
- if item.Type == PushMirrorType {
+ if mirrorType == mirror_module.PushMirrorType {
log.Trace("PushMirrors for %-v already queued for sync", repo)
} else {
log.Trace("PullMirrors for %-v already queued for sync", repo)
@@ -142,7 +123,7 @@ func Update(ctx context.Context, pullLimit, pushLimit int) error {
func queueHandle(data ...queue.Data) []queue.Data {
for _, datum := range data {
- req := datum.(*SyncRequest)
+ req := datum.(*mirror_module.SyncRequest)
doMirrorSync(graceful.GetManager().ShutdownContext(), req)
}
return nil
@@ -150,43 +131,5 @@ func queueHandle(data ...queue.Data) []queue.Data {
// InitSyncMirrors initializes a go routine to sync the mirrors
func InitSyncMirrors() {
- if !setting.Mirror.Enabled {
- return
- }
- mirrorQueue = queue.CreateUniqueQueue("mirror", queueHandle, new(SyncRequest))
-
- go graceful.GetManager().RunWithShutdownFns(mirrorQueue.Run)
-}
-
-// StartToMirror adds repoID to mirror queue
-func StartToMirror(repoID int64) {
- if !setting.Mirror.Enabled {
- return
- }
- go func() {
- err := mirrorQueue.Push(&SyncRequest{
- Type: PullMirrorType,
- ReferenceID: repoID,
- })
- if err != nil {
- log.Error("Unable to push sync request for to the queue for pull mirror repo[%d]: Error: %v", repoID, err)
- return
- }
- }()
-}
-
-// AddPushMirrorToQueue adds the push mirror to the queue
-func AddPushMirrorToQueue(mirrorID int64) {
- if !setting.Mirror.Enabled {
- return
- }
- go func() {
- err := mirrorQueue.Push(&SyncRequest{
- Type: PushMirrorType,
- ReferenceID: mirrorID,
- })
- if err != nil {
- log.Error("Unable to push sync request to the queue for pull mirror repo[%d]: Error: %v", mirrorID, err)
- }
- }()
+ mirror_module.StartSyncMirrors(queueHandle)
}
diff --git a/templates/repo/settings/options.tmpl b/templates/repo/settings/options.tmpl
index e76aba761a..98cf4f88c8 100644
--- a/templates/repo/settings/options.tmpl
+++ b/templates/repo/settings/options.tmpl
@@ -219,6 +219,12 @@
+
+
+
+
+
+