diff options
author | Lunny Xiao <xiaolunwen@gmail.com> | 2021-11-18 13:58:42 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-18 13:58:42 +0800 |
commit | 3c3855a05c79ccc7a8495cdbf4a361e7bef74248 (patch) | |
tree | 43f8616bca25a09c0e284e9407819ba43a6a0d79 /models/admin | |
parent | 6874fe90e591fa1bfb4b0575b27d876ab544e6e0 (diff) | |
download | gitea-3c3855a05c79ccc7a8495cdbf4a361e7bef74248.tar.gz gitea-3c3855a05c79ccc7a8495cdbf4a361e7bef74248.zip |
Move user functions into user.go (#17659)
* Move user functions into user.go
* Fix test
Diffstat (limited to 'models/admin')
-rw-r--r-- | models/admin/main_test.go | 18 | ||||
-rw-r--r-- | models/admin/notice.go | 146 | ||||
-rw-r--r-- | models/admin/notice_test.go | 115 |
3 files changed, 279 insertions, 0 deletions
diff --git a/models/admin/main_test.go b/models/admin/main_test.go new file mode 100644 index 0000000000..f6c9dce57a --- /dev/null +++ b/models/admin/main_test.go @@ -0,0 +1,18 @@ +// Copyright 2020 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 admin + +import ( + "path/filepath" + "testing" + + "code.gitea.io/gitea/models/unittest" +) + +func TestMain(m *testing.M) { + unittest.MainTest(m, filepath.Join("..", ".."), + "notice.yml", + ) +} diff --git a/models/admin/notice.go b/models/admin/notice.go new file mode 100644 index 0000000000..c41e49ed8c --- /dev/null +++ b/models/admin/notice.go @@ -0,0 +1,146 @@ +// Copyright 2021 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 admin + +import ( + "context" + "fmt" + + "code.gitea.io/gitea/models/db" + "code.gitea.io/gitea/modules/log" + "code.gitea.io/gitea/modules/storage" + "code.gitea.io/gitea/modules/timeutil" + "code.gitea.io/gitea/modules/util" +) + +// NoticeType describes the notice type +type NoticeType int + +const ( + // NoticeRepository type + NoticeRepository NoticeType = iota + 1 + // NoticeTask type + NoticeTask +) + +// Notice represents a system notice for admin. +type Notice struct { + ID int64 `xorm:"pk autoincr"` + Type NoticeType + Description string `xorm:"TEXT"` + CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"` +} + +func init() { + db.RegisterModel(new(Notice)) +} + +// TrStr returns a translation format string. +func (n *Notice) TrStr() string { + return fmt.Sprintf("admin.notices.type_%d", n.Type) +} + +// CreateNotice creates new system notice. +func CreateNotice(tp NoticeType, desc string, args ...interface{}) error { + return CreateNoticeCtx(db.DefaultContext, tp, desc, args...) +} + +// CreateNoticeCtx creates new system notice. +func CreateNoticeCtx(ctx context.Context, tp NoticeType, desc string, args ...interface{}) error { + if len(args) > 0 { + desc = fmt.Sprintf(desc, args...) + } + n := &Notice{ + Type: tp, + Description: desc, + } + return db.Insert(ctx, n) +} + +// CreateRepositoryNotice creates new system notice with type NoticeRepository. +func CreateRepositoryNotice(desc string, args ...interface{}) error { + return CreateNoticeCtx(db.DefaultContext, NoticeRepository, desc, args...) +} + +// RemoveAllWithNotice removes all directories in given path and +// creates a system notice when error occurs. +func RemoveAllWithNotice(title, path string) { + RemoveAllWithNoticeCtx(db.DefaultContext, title, path) +} + +// RemoveStorageWithNotice removes a file from the storage and +// creates a system notice when error occurs. +func RemoveStorageWithNotice(bucket storage.ObjectStorage, title, path string) { + removeStorageWithNotice(db.DefaultContext, bucket, title, path) +} + +func removeStorageWithNotice(ctx context.Context, bucket storage.ObjectStorage, title, path string) { + if err := bucket.Delete(path); err != nil { + desc := fmt.Sprintf("%s [%s]: %v", title, path, err) + log.Warn(title+" [%s]: %v", path, err) + if err = CreateNoticeCtx(ctx, NoticeRepository, desc); err != nil { + log.Error("CreateRepositoryNotice: %v", err) + } + } +} + +// RemoveAllWithNoticeCtx removes all directories in given path and +// creates a system notice when error occurs. +func RemoveAllWithNoticeCtx(ctx context.Context, title, path string) { + if err := util.RemoveAll(path); err != nil { + desc := fmt.Sprintf("%s [%s]: %v", title, path, err) + log.Warn(title+" [%s]: %v", path, err) + if err = CreateNoticeCtx(ctx, NoticeRepository, desc); err != nil { + log.Error("CreateRepositoryNotice: %v", err) + } + } +} + +// CountNotices returns number of notices. +func CountNotices() int64 { + count, _ := db.GetEngine(db.DefaultContext).Count(new(Notice)) + return count +} + +// Notices returns notices in given page. +func Notices(page, pageSize int) ([]*Notice, error) { + notices := make([]*Notice, 0, pageSize) + return notices, db.GetEngine(db.DefaultContext). + Limit(pageSize, (page-1)*pageSize). + Desc("created_unix"). + Find(¬ices) +} + +// DeleteNotice deletes a system notice by given ID. +func DeleteNotice(id int64) error { + _, err := db.GetEngine(db.DefaultContext).ID(id).Delete(new(Notice)) + return err +} + +// DeleteNotices deletes all notices with ID from start to end (inclusive). +func DeleteNotices(start, end int64) error { + if start == 0 && end == 0 { + _, err := db.GetEngine(db.DefaultContext).Exec("DELETE FROM notice") + return err + } + + sess := db.GetEngine(db.DefaultContext).Where("id >= ?", start) + if end > 0 { + sess.And("id <= ?", end) + } + _, err := sess.Delete(new(Notice)) + return err +} + +// DeleteNoticesByIDs deletes notices by given IDs. +func DeleteNoticesByIDs(ids []int64) error { + if len(ids) == 0 { + return nil + } + _, err := db.GetEngine(db.DefaultContext). + In("id", ids). + Delete(new(Notice)) + return err +} diff --git a/models/admin/notice_test.go b/models/admin/notice_test.go new file mode 100644 index 0000000000..7272df4368 --- /dev/null +++ b/models/admin/notice_test.go @@ -0,0 +1,115 @@ +// Copyright 2017 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 admin + +import ( + "testing" + + "code.gitea.io/gitea/models/unittest" + + "github.com/stretchr/testify/assert" +) + +func TestNotice_TrStr(t *testing.T) { + notice := &Notice{ + Type: NoticeRepository, + Description: "test description", + } + assert.Equal(t, "admin.notices.type_1", notice.TrStr()) +} + +func TestCreateNotice(t *testing.T) { + assert.NoError(t, unittest.PrepareTestDatabase()) + + noticeBean := &Notice{ + Type: NoticeRepository, + Description: "test description", + } + unittest.AssertNotExistsBean(t, noticeBean) + assert.NoError(t, CreateNotice(noticeBean.Type, noticeBean.Description)) + unittest.AssertExistsAndLoadBean(t, noticeBean) +} + +func TestCreateRepositoryNotice(t *testing.T) { + assert.NoError(t, unittest.PrepareTestDatabase()) + + noticeBean := &Notice{ + Type: NoticeRepository, + Description: "test description", + } + unittest.AssertNotExistsBean(t, noticeBean) + assert.NoError(t, CreateRepositoryNotice(noticeBean.Description)) + unittest.AssertExistsAndLoadBean(t, noticeBean) +} + +// TODO TestRemoveAllWithNotice + +func TestCountNotices(t *testing.T) { + assert.NoError(t, unittest.PrepareTestDatabase()) + assert.Equal(t, int64(3), CountNotices()) +} + +func TestNotices(t *testing.T) { + assert.NoError(t, unittest.PrepareTestDatabase()) + + notices, err := Notices(1, 2) + assert.NoError(t, err) + if assert.Len(t, notices, 2) { + assert.Equal(t, int64(3), notices[0].ID) + assert.Equal(t, int64(2), notices[1].ID) + } + + notices, err = Notices(2, 2) + assert.NoError(t, err) + if assert.Len(t, notices, 1) { + assert.Equal(t, int64(1), notices[0].ID) + } +} + +func TestDeleteNotice(t *testing.T) { + assert.NoError(t, unittest.PrepareTestDatabase()) + + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 3}) + assert.NoError(t, DeleteNotice(3)) + unittest.AssertNotExistsBean(t, &Notice{ID: 3}) +} + +func TestDeleteNotices(t *testing.T) { + // delete a non-empty range + assert.NoError(t, unittest.PrepareTestDatabase()) + + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 1}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 2}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 3}) + assert.NoError(t, DeleteNotices(1, 2)) + unittest.AssertNotExistsBean(t, &Notice{ID: 1}) + unittest.AssertNotExistsBean(t, &Notice{ID: 2}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 3}) +} + +func TestDeleteNotices2(t *testing.T) { + // delete an empty range + assert.NoError(t, unittest.PrepareTestDatabase()) + + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 1}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 2}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 3}) + assert.NoError(t, DeleteNotices(3, 2)) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 1}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 2}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 3}) +} + +func TestDeleteNoticesByIDs(t *testing.T) { + assert.NoError(t, unittest.PrepareTestDatabase()) + + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 1}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 2}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 3}) + assert.NoError(t, DeleteNoticesByIDs([]int64{1, 3})) + unittest.AssertNotExistsBean(t, &Notice{ID: 1}) + unittest.AssertExistsAndLoadBean(t, &Notice{ID: 2}) + unittest.AssertNotExistsBean(t, &Notice{ID: 3}) +} |