Add type filter to System Notices view

After go-gitea#10745 was merged, the number of System Notices increased obviously.
Add the type filter is useful to help users to quickly check out the useful
message they want.

Signed-off-by: a1012112796 <[email protected]>

Author: a1012112796

models/admin.go

@@ -20,8 +20,10 @@ type NoticeType int
 const (
 	//NoticeRepository type
 	NoticeRepository NoticeType = iota + 1
-	// NoticeTask type
-	NoticeTask
+	// NoticeTaskSuccess type
+	NoticeTaskSuccess
+	// NoticeTaskFail type
+	NoticeTaskFail
 )
 
 // Notice represents a system notice for admin.
@@ -59,6 +61,17 @@ func CreateRepositoryNotice(desc string, args ...interface{}) error {
 	return createNotice(x, NoticeRepository, desc, args...)
 }
 
+// CreateTaskNotice creates new system notice with type NoticeTaskSuccess or NoticeTaskFail.
+func CreateTaskNotice(isSuccess bool, desc string, args ...interface{}) (err error) {
+	if isSuccess {
+		err = createNotice(x, NoticeTaskSuccess, desc, args...)
+	} else {
+		err = createNotice(x, NoticeTaskFail, desc, args...)
+	}
+
+	return
+}
+
 // RemoveAllWithNotice removes all directories in given path and
 // creates a system notice when error occurs.
 func RemoveAllWithNotice(title, path string) {
@@ -76,18 +89,32 @@ func removeAllWithNotice(e Engine, title, path string) {
 }
 
 // CountNotices returns number of notices.
-func CountNotices() int64 {
-	count, _ := x.Count(new(Notice))
-	return count
+func CountNotices(typ int) (count int64, err error) {
+	if typ >= 1 {
+		count, err = x.Where("type = ?", typ).Count(new(Notice))
+	} else {
+		count, err = x.Count(new(Notice))
+	}
+	return
 }
 
 // Notices returns notices in given page.
-func Notices(page, pageSize int) ([]*Notice, error) {
-	notices := make([]*Notice, 0, pageSize)
-	return notices, x.
-		Limit(pageSize, (page-1)*pageSize).
-		Desc("id").
-		Find(&notices)
+func Notices(typ, page, pageSize int) (notices []*Notice, err error) {
+	notices = make([]*Notice, 0, pageSize)
+
+	if typ >= 1 {
+		err = x.Where("type = ?", typ).
+			Limit(pageSize, (page-1)*pageSize).
+			Desc("id").
+			Find(&notices)
+	} else {
+		err = x.
+			Limit(pageSize, (page-1)*pageSize).
+			Desc("id").
+			Find(&notices)
+	}
+
+	return notices, err
 }
 
 // DeleteNotice deletes a system notice by given ID.

models/admin_test.go

@@ -46,24 +46,35 @@ func TestCreateRepositoryNotice(t *testing.T) {
 
 func TestCountNotices(t *testing.T) {
 	assert.NoError(t, PrepareTestDatabase())
-	assert.Equal(t, int64(3), CountNotices())
+	num, err := CountNotices(0)
+	assert.NoError(t, err)
+	assert.Equal(t, int64(3), num)
+	num, err = CountNotices(2)
+	assert.NoError(t, err)
+	assert.Equal(t, int64(1), num)
 }
 
 func TestNotices(t *testing.T) {
 	assert.NoError(t, PrepareTestDatabase())
 
-	notices, err := Notices(1, 2)
+	notices, err := Notices(0, 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)
+	notices, err = Notices(0, 2, 2)
 	assert.NoError(t, err)
 	if assert.Len(t, notices, 1) {
 		assert.Equal(t, int64(1), notices[0].ID)
 	}
+
+	notices, err = Notices(2, 1, 2)
+	assert.NoError(t, err)
+	if assert.Len(t, notices, 1) {
+		assert.Equal(t, int64(3), notices[0].ID)
+	}
 }
 
 func TestDeleteNotice(t *testing.T) {

models/fixtures/notice.yml

@@ -10,5 +10,5 @@
 
 -
   id: 3
-  type: 1 # NoticeRepository
+  type: 2 # NoticeTaskSuccess
   description: description3

modules/cron/tasks.go

@@ -88,17 +88,17 @@ func (t *Task) RunWithUser(doer *models.User, config Config) {
 		if err := t.fun(ctx, doer, config); err != nil {
 			if models.IsErrCancelled(err) {
 				message := err.(models.ErrCancelled).Message
-				if err := models.CreateNotice(models.NoticeTask, config.FormatMessage(t.Name, "aborted", doer, message)); err != nil {
+				if err := models.CreateTaskNotice(false, config.FormatMessage(t.Name, "aborted", doer, message)); err != nil {
 					log.Error("CreateNotice: %v", err)
 				}
 				return
 			}
-			if err := models.CreateNotice(models.NoticeTask, config.FormatMessage(t.Name, "error", doer, err)); err != nil {
+			if err := models.CreateTaskNotice(false, config.FormatMessage(t.Name, "error", doer, err)); err != nil {
 				log.Error("CreateNotice: %v", err)
 			}
 			return
 		}
-		if err := models.CreateNotice(models.NoticeTask, config.FormatMessage(t.Name, "finished", doer)); err != nil {
+		if err := models.CreateTaskNotice(true, config.FormatMessage(t.Name, "finished", doer)); err != nil {
 			log.Error("CreateNotice: %v", err)
 		}
 	})

options/locale/locale_en-US.ini

@@ -2288,7 +2288,10 @@ notices.delete_selected = Delete Selected
 notices.delete_all = Delete All Notices
 notices.type = Type
 notices.type_1 = Repository
-notices.type_2 = Task
+notices.type_2 = Success Task
+notices.type_3 = Fail Task
+notices.type_all = All Type
+notices.type_filter = Type Filter
 notices.desc = Description
 notices.op = Op.
 notices.delete_success = The system notices have been deleted.

routers/admin/notice.go

@@ -25,13 +25,19 @@ func Notices(ctx *context.Context) {
 	ctx.Data["PageIsAdmin"] = true
 	ctx.Data["PageIsAdminNotices"] = true
 
-	total := models.CountNotices()
 	page := ctx.QueryInt("page")
 	if page <= 1 {
 		page = 1
 	}
 
-	notices, err := models.Notices(page, setting.UI.Admin.NoticePagingNum)
+	typ := ctx.QueryInt("type")
+	total, err := models.CountNotices(typ)
+	if err != nil {
+		ctx.ServerError("CountNotices", err)
+		return
+	}
+
+	notices, err := models.Notices(typ, page, setting.UI.Admin.NoticePagingNum)
 	if err != nil {
 		ctx.ServerError("Notices", err)
 		return
@@ -40,7 +46,11 @@ func Notices(ctx *context.Context) {
 
 	ctx.Data["Total"] = total
 
-	ctx.Data["Page"] = context.NewPagination(int(total), setting.UI.Admin.NoticePagingNum, page, 5)
+	p := context.NewPagination(int(total), setting.UI.Admin.NoticePagingNum, page, 5)
+	ctx.Data["Page"] = p
+
+	ctx.Data["NoticesType"] = typ
+	p.AddParam(ctx, "type", "NoticesType")
 
 	ctx.HTML(200, tplNotices)
 }

templates/admin/notice.tmpl

@@ -5,6 +5,26 @@
 		{{template "base/alert" .}}
 		<h4 class="ui top attached header">
 			{{.i18n.Tr "admin.notices.system_notice_list"}} ({{.i18n.Tr "admin.total" .Total}})
+			<div class="ui floating dropdown small teal button">
+				<span class="text">
+					{{.i18n.Tr "admin.notices.type_filter"}} : 
+					{{if eq .NoticesType 1}}
+						{{.i18n.Tr "admin.notices.type_1"}}
+					{{else if eq .NoticesType 2}}
+						{{.i18n.Tr "admin.notices.type_2"}}
+					{{else if eq .NoticesType 3}}
+						{{.i18n.Tr "admin.notices.type_3"}}
+					{{else}}
+						{{.i18n.Tr "admin.notices.type_all"}}
+					{{end}}
+				</span>
+				<div class="menu">
+					<a class="item" href="{{$.Link}}?type=1">{{.i18n.Tr "admin.notices.type_1"}}</a>
+					<a class="item" href="{{$.Link}}?type=2">{{.i18n.Tr "admin.notices.type_2"}}</a>
+					<a class="item" href="{{$.Link}}?type=3">{{.i18n.Tr "admin.notices.type_3"}}</a>
+					<a class="item" href="{{$.Link}}">{{.i18n.Tr "admin.notices.type_all"}}</a>
+				</div>
+			</div>
 		</h4>
 		<div class="ui attached table segment">
 			<table id="notice-table" class="ui very basic select selectable table">