2014-10-08 17:29:18 -05:00
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2020-08-17 23:23:45 -05:00
|
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
2014-10-08 17:29:18 -05:00
|
|
|
// Use of this source code is governed by a MIT-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
|
|
|
package models
|
|
|
|
|
|
|
|
import (
|
2016-02-05 14:11:53 -05:00
|
|
|
"fmt"
|
2014-10-08 17:29:18 -05:00
|
|
|
|
2017-03-28 21:05:23 -05:00
|
|
|
"code.gitea.io/gitea/modules/log"
|
2020-08-17 23:23:45 -05:00
|
|
|
"code.gitea.io/gitea/modules/storage"
|
2019-08-15 09:46:21 -05:00
|
|
|
"code.gitea.io/gitea/modules/timeutil"
|
2020-08-11 15:05:34 -05:00
|
|
|
"code.gitea.io/gitea/modules/util"
|
2014-10-08 17:29:18 -05:00
|
|
|
)
|
|
|
|
|
2016-11-24 15:54:00 -05:00
|
|
|
//NoticeType describes the notice type
|
2014-10-08 17:29:18 -05:00
|
|
|
type NoticeType int
|
|
|
|
|
|
|
|
const (
|
2016-11-24 15:54:00 -05:00
|
|
|
//NoticeRepository type
|
2016-11-07 11:24:59 -05:00
|
|
|
NoticeRepository NoticeType = iota + 1
|
2020-05-16 18:31:38 -05:00
|
|
|
// NoticeTask type
|
|
|
|
NoticeTask
|
2014-10-08 17:29:18 -05:00
|
|
|
)
|
|
|
|
|
|
|
|
// Notice represents a system notice for admin.
|
|
|
|
type Notice struct {
|
2015-12-05 01:09:14 -05:00
|
|
|
ID int64 `xorm:"pk autoincr"`
|
2014-10-08 17:29:18 -05:00
|
|
|
Type NoticeType
|
2019-08-15 09:46:21 -05:00
|
|
|
Description string `xorm:"TEXT"`
|
|
|
|
CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
|
2014-10-08 17:29:18 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// TrStr returns a translation format string.
|
|
|
|
func (n *Notice) TrStr() string {
|
2020-12-25 04:59:32 -05:00
|
|
|
return fmt.Sprintf("admin.notices.type_%d", n.Type)
|
2014-10-08 17:29:18 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// CreateNotice creates new system notice.
|
2020-05-16 18:31:38 -05:00
|
|
|
func CreateNotice(tp NoticeType, desc string, args ...interface{}) error {
|
|
|
|
return createNotice(x, tp, desc, args...)
|
2017-02-24 10:19:13 -05:00
|
|
|
}
|
2016-05-06 14:48:18 -05:00
|
|
|
|
2020-05-16 18:31:38 -05:00
|
|
|
func createNotice(e Engine, tp NoticeType, desc string, args ...interface{}) error {
|
|
|
|
if len(args) > 0 {
|
|
|
|
desc = fmt.Sprintf(desc, args...)
|
|
|
|
}
|
2014-10-08 17:29:18 -05:00
|
|
|
n := &Notice{
|
|
|
|
Type: tp,
|
|
|
|
Description: desc,
|
|
|
|
}
|
2017-02-24 10:19:13 -05:00
|
|
|
_, err := e.Insert(n)
|
2014-10-08 17:29:18 -05:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2016-11-07 11:24:59 -05:00
|
|
|
// CreateRepositoryNotice creates new system notice with type NoticeRepository.
|
2020-05-16 18:31:38 -05:00
|
|
|
func CreateRepositoryNotice(desc string, args ...interface{}) error {
|
|
|
|
return createNotice(x, NoticeRepository, desc, args...)
|
2014-10-08 17:29:18 -05:00
|
|
|
}
|
|
|
|
|
2016-02-05 14:11:53 -05:00
|
|
|
// RemoveAllWithNotice removes all directories in given path and
|
|
|
|
// creates a system notice when error occurs.
|
|
|
|
func RemoveAllWithNotice(title, path string) {
|
2017-02-24 10:19:13 -05:00
|
|
|
removeAllWithNotice(x, title, path)
|
|
|
|
}
|
|
|
|
|
2020-08-17 23:23:45 -05:00
|
|
|
// RemoveStorageWithNotice removes a file from the storage and
|
|
|
|
// creates a system notice when error occurs.
|
|
|
|
func RemoveStorageWithNotice(bucket storage.ObjectStorage, title, path string) {
|
2020-09-29 04:05:13 -05:00
|
|
|
removeStorageWithNotice(x, bucket, title, path)
|
|
|
|
}
|
|
|
|
|
|
|
|
func removeStorageWithNotice(e Engine, bucket storage.ObjectStorage, title, path string) {
|
2020-08-17 23:23:45 -05:00
|
|
|
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 = createNotice(x, NoticeRepository, desc); err != nil {
|
|
|
|
log.Error("CreateRepositoryNotice: %v", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-02-24 10:19:13 -05:00
|
|
|
func removeAllWithNotice(e Engine, title, path string) {
|
2020-08-11 15:05:34 -05:00
|
|
|
if err := util.RemoveAll(path); err != nil {
|
2016-02-05 14:11:53 -05:00
|
|
|
desc := fmt.Sprintf("%s [%s]: %v", title, path, err)
|
2019-06-15 17:20:29 -05:00
|
|
|
log.Warn(title+" [%s]: %v", path, err)
|
2017-02-24 10:19:13 -05:00
|
|
|
if err = createNotice(e, NoticeRepository, desc); err != nil {
|
2019-04-02 02:48:31 -05:00
|
|
|
log.Error("CreateRepositoryNotice: %v", err)
|
2016-02-05 14:11:53 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-08 17:29:18 -05:00
|
|
|
// CountNotices returns number of notices.
|
|
|
|
func CountNotices() int64 {
|
|
|
|
count, _ := x.Count(new(Notice))
|
|
|
|
return count
|
|
|
|
}
|
|
|
|
|
2017-01-09 13:26:05 -05:00
|
|
|
// Notices returns notices in given page.
|
2015-09-25 11:13:38 -05:00
|
|
|
func Notices(page, pageSize int) ([]*Notice, error) {
|
|
|
|
notices := make([]*Notice, 0, pageSize)
|
2016-11-10 10:16:32 -05:00
|
|
|
return notices, x.
|
|
|
|
Limit(pageSize, (page-1)*pageSize).
|
|
|
|
Desc("id").
|
|
|
|
Find(¬ices)
|
2014-10-08 17:29:18 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteNotice deletes a system notice by given ID.
|
|
|
|
func DeleteNotice(id int64) error {
|
2017-10-04 23:43:04 -05:00
|
|
|
_, err := x.ID(id).Delete(new(Notice))
|
2014-10-08 17:29:18 -05:00
|
|
|
return err
|
|
|
|
}
|
2015-12-01 23:33:08 -05:00
|
|
|
|
|
|
|
// 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
|
|
|
|
}
|
2015-12-05 01:09:14 -05:00
|
|
|
|
|
|
|
// DeleteNoticesByIDs deletes notices by given IDs.
|
|
|
|
func DeleteNoticesByIDs(ids []int64) error {
|
|
|
|
if len(ids) == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
2016-11-10 10:16:32 -05:00
|
|
|
_, err := x.
|
2016-11-12 03:29:18 -05:00
|
|
|
In("id", ids).
|
2016-11-10 10:16:32 -05:00
|
|
|
Delete(new(Notice))
|
2015-12-05 01:09:14 -05:00
|
|
|
return err
|
|
|
|
}
|