aboutsummaryrefslogtreecommitdiff
path: root/internal/db/admin.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/db/admin.go')
-rw-r--r--internal/db/admin.go118
1 files changed, 118 insertions, 0 deletions
diff --git a/internal/db/admin.go b/internal/db/admin.go
new file mode 100644
index 00000000..1fe13002
--- /dev/null
+++ b/internal/db/admin.go
@@ -0,0 +1,118 @@
+// Copyright 2014 The Gogs 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 db
+
+import (
+ "fmt"
+ "os"
+ "strings"
+ "time"
+
+ "github.com/unknwon/com"
+ log "gopkg.in/clog.v1"
+ "xorm.io/xorm"
+
+ "gogs.io/gogs/internal/tool"
+)
+
+type NoticeType int
+
+const (
+ NOTICE_REPOSITORY NoticeType = iota + 1
+)
+
+// Notice represents a system notice for admin.
+type Notice struct {
+ ID int64
+ Type NoticeType
+ Description string `xorm:"TEXT"`
+ Created time.Time `xorm:"-" json:"-"`
+ CreatedUnix int64
+}
+
+func (n *Notice) BeforeInsert() {
+ n.CreatedUnix = time.Now().Unix()
+}
+
+func (n *Notice) AfterSet(colName string, _ xorm.Cell) {
+ switch colName {
+ case "created_unix":
+ n.Created = time.Unix(n.CreatedUnix, 0).Local()
+ }
+}
+
+// TrStr returns a translation format string.
+func (n *Notice) TrStr() string {
+ return "admin.notices.type_" + com.ToStr(n.Type)
+}
+
+// CreateNotice creates new system notice.
+func CreateNotice(tp NoticeType, desc string) error {
+ // Prevent panic if database connection is not available at this point
+ if x == nil {
+ return fmt.Errorf("could not save notice due database connection not being available: %d %s", tp, desc)
+ }
+
+ n := &Notice{
+ Type: tp,
+ Description: desc,
+ }
+ _, err := x.Insert(n)
+ return err
+}
+
+// CreateRepositoryNotice creates new system notice with type NOTICE_REPOSITORY.
+func CreateRepositoryNotice(desc string) error {
+ return CreateNotice(NOTICE_REPOSITORY, desc)
+}
+
+// RemoveAllWithNotice removes all directories in given path and
+// creates a system notice when error occurs.
+func RemoveAllWithNotice(title, path string) {
+ if err := os.RemoveAll(path); err != nil {
+ desc := fmt.Sprintf("%s [%s]: %v", title, path, err)
+ log.Warn(desc)
+ if err = CreateRepositoryNotice(desc); err != nil {
+ log.Error(2, "CreateRepositoryNotice: %v", err)
+ }
+ }
+}
+
+// CountNotices returns number of notices.
+func CountNotices() int64 {
+ count, _ := x.Count(new(Notice))
+ return count
+}
+
+// Notices returns number of 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)
+}
+
+// DeleteNotice deletes a system notice by given ID.
+func DeleteNotice(id int64) error {
+ _, err := x.Id(id).Delete(new(Notice))
+ return err
+}
+
+// DeleteNotices deletes all notices with ID from start to end (inclusive).
+func DeleteNotices(start, end int64) error {
+ sess := x.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 := x.Where("id IN (" + strings.Join(tool.Int64sToStrings(ids), ",") + ")").Delete(new(Notice))
+ return err
+}