2014-02-12 12:49:46 -05:00
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2018-06-20 01:06:01 -04:00
|
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
2014-02-12 12:49:46 -05:00
|
|
|
// Use of this source code is governed by a MIT-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
|
|
|
package models
|
2014-02-13 10:23:23 -05:00
|
|
|
|
2014-02-18 17:48:02 -05:00
|
|
|
import (
|
2014-10-19 01:35:24 -04:00
|
|
|
"database/sql"
|
2016-08-11 17:38:26 -04:00
|
|
|
"errors"
|
2014-02-18 17:48:02 -05:00
|
|
|
"fmt"
|
|
|
|
|
2017-10-27 02:10:54 -04:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// Needed for the MySQL driver
|
2014-02-18 17:48:02 -05:00
|
|
|
_ "github.com/go-sql-driver/mysql"
|
2019-06-23 11:22:43 -04:00
|
|
|
"xorm.io/core"
|
2019-10-17 05:26:49 -04:00
|
|
|
"xorm.io/xorm"
|
2016-11-25 19:20:18 -05:00
|
|
|
|
|
|
|
// Needed for the Postgresql driver
|
2014-03-17 14:03:58 -04:00
|
|
|
_ "github.com/lib/pq"
|
2014-02-18 17:48:02 -05:00
|
|
|
|
2016-12-23 20:37:35 -05:00
|
|
|
// Needed for the MSSSQL driver
|
|
|
|
_ "github.com/denisenkom/go-mssqldb"
|
2014-02-18 17:48:02 -05:00
|
|
|
)
|
2014-02-13 10:23:23 -05:00
|
|
|
|
2014-10-19 01:35:24 -04:00
|
|
|
// Engine represents a xorm engine or session.
|
|
|
|
type Engine interface {
|
2017-02-13 22:46:46 -05:00
|
|
|
Table(tableNameOrBean interface{}) *xorm.Session
|
2017-08-22 07:39:52 -04:00
|
|
|
Count(...interface{}) (int64, error)
|
2017-02-04 11:00:07 -05:00
|
|
|
Decr(column string, arg ...interface{}) *xorm.Session
|
2014-10-19 01:35:24 -04:00
|
|
|
Delete(interface{}) (int64, error)
|
2018-12-11 20:01:41 -05:00
|
|
|
Exec(...interface{}) (sql.Result, error)
|
2015-02-13 00:58:46 -05:00
|
|
|
Find(interface{}, ...interface{}) error
|
2015-02-10 23:44:16 -05:00
|
|
|
Get(interface{}) (bool, error)
|
2017-10-05 00:43:04 -04:00
|
|
|
ID(interface{}) *xorm.Session
|
2016-08-15 21:40:32 -04:00
|
|
|
In(string, ...interface{}) *xorm.Session
|
2017-02-04 11:00:07 -05:00
|
|
|
Incr(column string, arg ...interface{}) *xorm.Session
|
2014-10-19 01:35:24 -04:00
|
|
|
Insert(...interface{}) (int64, error)
|
2015-02-13 00:58:46 -05:00
|
|
|
InsertOne(interface{}) (int64, error)
|
2016-07-26 05:26:48 -04:00
|
|
|
Iterate(interface{}, xorm.IterFunc) error
|
2017-02-11 07:01:33 -05:00
|
|
|
Join(joinOperator string, tablename interface{}, condition string, args ...interface{}) *xorm.Session
|
2016-11-10 02:20:48 -05:00
|
|
|
SQL(interface{}, ...interface{}) *xorm.Session
|
2016-09-22 19:38:12 -04:00
|
|
|
Where(interface{}, ...interface{}) *xorm.Session
|
2019-06-12 15:41:28 -04:00
|
|
|
Asc(colNames ...string) *xorm.Session
|
2014-10-19 01:35:24 -04:00
|
|
|
}
|
|
|
|
|
2014-03-21 01:48:10 -04:00
|
|
|
var (
|
2019-08-24 05:24:45 -04:00
|
|
|
x *xorm.Engine
|
|
|
|
tables []interface{}
|
2016-11-25 19:20:18 -05:00
|
|
|
|
|
|
|
// HasEngine specifies if we have a xorm.Engine
|
2014-03-30 10:47:08 -04:00
|
|
|
HasEngine bool
|
2014-03-21 01:48:10 -04:00
|
|
|
)
|
|
|
|
|
2014-04-05 10:46:32 -04:00
|
|
|
func init() {
|
2014-11-12 06:48:50 -05:00
|
|
|
tables = append(tables,
|
2016-12-30 11:44:54 -05:00
|
|
|
new(User),
|
|
|
|
new(PublicKey),
|
|
|
|
new(AccessToken),
|
|
|
|
new(Repository),
|
|
|
|
new(DeployKey),
|
|
|
|
new(Collaboration),
|
|
|
|
new(Access),
|
|
|
|
new(Upload),
|
|
|
|
new(Watch),
|
|
|
|
new(Star),
|
|
|
|
new(Follow),
|
|
|
|
new(Action),
|
|
|
|
new(Issue),
|
|
|
|
new(PullRequest),
|
|
|
|
new(Comment),
|
|
|
|
new(Attachment),
|
|
|
|
new(Label),
|
|
|
|
new(IssueLabel),
|
|
|
|
new(Milestone),
|
|
|
|
new(Mirror),
|
|
|
|
new(Release),
|
|
|
|
new(LoginSource),
|
|
|
|
new(Webhook),
|
|
|
|
new(HookTask),
|
|
|
|
new(Team),
|
|
|
|
new(OrgUser),
|
|
|
|
new(TeamUser),
|
|
|
|
new(TeamRepo),
|
|
|
|
new(Notice),
|
|
|
|
new(EmailAddress),
|
|
|
|
new(Notification),
|
|
|
|
new(IssueUser),
|
|
|
|
new(LFSMetaObject),
|
2017-01-15 21:14:29 -05:00
|
|
|
new(TwoFactor),
|
2017-03-15 21:27:35 -04:00
|
|
|
new(GPGKey),
|
2019-04-14 12:43:56 -04:00
|
|
|
new(GPGKeyImport),
|
2017-02-04 10:53:46 -05:00
|
|
|
new(RepoUnit),
|
2017-02-05 09:35:03 -05:00
|
|
|
new(RepoRedirect),
|
2017-02-23 02:05:37 -05:00
|
|
|
new(ExternalLoginUser),
|
|
|
|
new(ProtectedBranch),
|
2017-03-17 10:16:08 -04:00
|
|
|
new(UserOpenID),
|
2017-03-19 15:54:12 -04:00
|
|
|
new(IssueWatch),
|
2017-04-21 07:32:31 -04:00
|
|
|
new(CommitStatus),
|
2017-09-12 02:48:13 -04:00
|
|
|
new(Stopwatch),
|
|
|
|
new(TrackedTime),
|
2017-10-25 20:49:16 -04:00
|
|
|
new(DeletedBranch),
|
2017-10-27 02:10:54 -04:00
|
|
|
new(RepoIndexerStatus),
|
2018-07-17 17:23:58 -04:00
|
|
|
new(IssueDependency),
|
2017-11-28 15:58:37 -05:00
|
|
|
new(LFSLock),
|
2017-12-03 18:14:26 -05:00
|
|
|
new(Reaction),
|
2018-05-09 12:29:04 -04:00
|
|
|
new(IssueAssignees),
|
2018-05-19 10:12:37 -04:00
|
|
|
new(U2FRegistration),
|
2018-06-21 12:00:13 -04:00
|
|
|
new(TeamUnit),
|
2018-08-06 00:43:22 -04:00
|
|
|
new(Review),
|
2019-03-08 11:42:50 -05:00
|
|
|
new(OAuth2Application),
|
|
|
|
new(OAuth2AuthorizationCode),
|
|
|
|
new(OAuth2Grant),
|
2019-10-13 09:23:14 -04:00
|
|
|
new(Task),
|
2016-12-30 11:44:54 -05:00
|
|
|
)
|
2015-08-27 11:06:14 -04:00
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
gonicNames := []string{"SSL", "UID"}
|
2015-08-27 11:06:14 -04:00
|
|
|
for _, name := range gonicNames {
|
|
|
|
core.LintGonicMapper[name] = true
|
|
|
|
}
|
2014-04-05 10:46:32 -04:00
|
|
|
}
|
|
|
|
|
2014-09-04 11:19:26 -04:00
|
|
|
func getEngine() (*xorm.Engine, error) {
|
2019-08-24 05:24:45 -04:00
|
|
|
connStr, err := setting.DBConnStr()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2014-03-30 10:47:08 -04:00
|
|
|
}
|
2017-02-20 03:11:13 -05:00
|
|
|
|
2019-08-24 05:24:45 -04:00
|
|
|
return xorm.NewEngine(setting.Database.Type, connStr)
|
2014-09-04 11:19:26 -04:00
|
|
|
}
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// NewTestEngine sets a new test xorm.Engine
|
2014-09-04 11:19:26 -04:00
|
|
|
func NewTestEngine(x *xorm.Engine) (err error) {
|
|
|
|
x, err = getEngine()
|
2014-03-30 10:47:08 -04:00
|
|
|
if err != nil {
|
2015-08-02 00:36:35 -04:00
|
|
|
return fmt.Errorf("Connect to database: %v", err)
|
2014-03-30 10:47:08 -04:00
|
|
|
}
|
2014-09-04 11:19:26 -04:00
|
|
|
|
2019-08-05 10:29:40 -04:00
|
|
|
x.ShowExecTime(true)
|
2015-01-23 02:54:16 -05:00
|
|
|
x.SetMapper(core.GonicMapper{})
|
2019-05-14 03:04:07 -04:00
|
|
|
x.SetLogger(NewXORMLogger(!setting.ProdMode))
|
2017-09-13 01:18:22 -04:00
|
|
|
x.ShowSQL(!setting.ProdMode)
|
2015-09-03 05:05:58 -04:00
|
|
|
return x.StoreEngine("InnoDB").Sync2(tables...)
|
2014-03-30 10:47:08 -04:00
|
|
|
}
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// SetEngine sets the xorm.Engine
|
2014-03-29 17:50:51 -04:00
|
|
|
func SetEngine() (err error) {
|
2014-09-04 11:19:26 -04:00
|
|
|
x, err = getEngine()
|
2014-02-18 17:48:02 -05:00
|
|
|
if err != nil {
|
2017-01-29 15:13:57 -05:00
|
|
|
return fmt.Errorf("Failed to connect to database: %v", err)
|
2014-02-18 17:48:02 -05:00
|
|
|
}
|
|
|
|
|
2019-08-05 10:29:40 -04:00
|
|
|
x.ShowExecTime(true)
|
2015-01-23 02:54:16 -05:00
|
|
|
x.SetMapper(core.GonicMapper{})
|
2014-12-06 20:22:48 -05:00
|
|
|
// WARNING: for serv command, MUST remove the output to os.stdout,
|
2014-03-20 16:04:56 -04:00
|
|
|
// so use log file to instead print to stdout.
|
2019-08-24 05:24:45 -04:00
|
|
|
x.SetLogger(NewXORMLogger(setting.Database.LogSQL))
|
|
|
|
x.ShowSQL(setting.Database.LogSQL)
|
2019-10-21 17:20:47 -04:00
|
|
|
x.SetMaxOpenConns(setting.Database.MaxOpenConns)
|
|
|
|
x.SetMaxIdleConns(setting.Database.MaxIdleConns)
|
|
|
|
x.SetConnMaxLifetime(setting.Database.ConnMaxLifetime)
|
2014-03-29 17:50:51 -04:00
|
|
|
return nil
|
2014-02-18 17:48:02 -05:00
|
|
|
}
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// NewEngine initializes a new xorm.Engine
|
2017-07-02 09:50:57 -04:00
|
|
|
func NewEngine(migrateFunc func(*xorm.Engine) error) (err error) {
|
2014-03-29 17:50:51 -04:00
|
|
|
if err = SetEngine(); err != nil {
|
|
|
|
return err
|
2014-04-05 10:46:32 -04:00
|
|
|
}
|
2015-01-22 07:49:52 -05:00
|
|
|
|
2016-11-24 09:30:36 -05:00
|
|
|
if err = x.Ping(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2017-07-02 09:50:57 -04:00
|
|
|
if err = migrateFunc(x); err != nil {
|
2015-02-11 21:58:37 -05:00
|
|
|
return fmt.Errorf("migrate: %v", err)
|
2015-01-22 07:49:52 -05:00
|
|
|
}
|
|
|
|
|
2014-10-28 11:40:09 -04:00
|
|
|
if err = x.StoreEngine("InnoDB").Sync2(tables...); err != nil {
|
2016-11-28 02:25:16 -05:00
|
|
|
return fmt.Errorf("sync database struct error: %v", err)
|
2014-02-19 04:50:53 -05:00
|
|
|
}
|
2015-01-23 02:54:16 -05:00
|
|
|
|
2014-03-29 17:50:51 -04:00
|
|
|
return nil
|
2014-02-18 17:48:02 -05:00
|
|
|
}
|
2014-03-20 16:04:56 -04:00
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// Statistic contains the database statistics
|
2014-03-20 16:04:56 -04:00
|
|
|
type Statistic struct {
|
|
|
|
Counter struct {
|
2014-08-28 10:29:00 -04:00
|
|
|
User, Org, PublicKey,
|
|
|
|
Repo, Watch, Star, Action, Access,
|
|
|
|
Issue, Comment, Oauth, Follow,
|
|
|
|
Mirror, Release, LoginSource, Webhook,
|
|
|
|
Milestone, Label, HookTask,
|
|
|
|
Team, UpdateTask, Attachment int64
|
2014-03-20 16:04:56 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// GetStatistic returns the database statistics
|
2014-03-20 16:04:56 -04:00
|
|
|
func GetStatistic() (stats Statistic) {
|
2014-07-07 04:15:08 -04:00
|
|
|
stats.Counter.User = CountUsers()
|
2014-08-28 10:29:00 -04:00
|
|
|
stats.Counter.Org = CountOrganizations()
|
2014-06-21 00:51:41 -04:00
|
|
|
stats.Counter.PublicKey, _ = x.Count(new(PublicKey))
|
2016-07-24 02:32:46 -04:00
|
|
|
stats.Counter.Repo = CountRepositories(true)
|
2014-06-21 00:51:41 -04:00
|
|
|
stats.Counter.Watch, _ = x.Count(new(Watch))
|
2014-08-28 10:29:00 -04:00
|
|
|
stats.Counter.Star, _ = x.Count(new(Star))
|
2014-06-21 00:51:41 -04:00
|
|
|
stats.Counter.Action, _ = x.Count(new(Action))
|
|
|
|
stats.Counter.Access, _ = x.Count(new(Access))
|
|
|
|
stats.Counter.Issue, _ = x.Count(new(Issue))
|
|
|
|
stats.Counter.Comment, _ = x.Count(new(Comment))
|
2015-09-17 16:11:44 -04:00
|
|
|
stats.Counter.Oauth = 0
|
2014-08-28 10:29:00 -04:00
|
|
|
stats.Counter.Follow, _ = x.Count(new(Follow))
|
|
|
|
stats.Counter.Mirror, _ = x.Count(new(Mirror))
|
2014-06-21 00:51:41 -04:00
|
|
|
stats.Counter.Release, _ = x.Count(new(Release))
|
2015-09-10 15:45:03 -04:00
|
|
|
stats.Counter.LoginSource = CountLoginSources()
|
2014-06-21 00:51:41 -04:00
|
|
|
stats.Counter.Webhook, _ = x.Count(new(Webhook))
|
|
|
|
stats.Counter.Milestone, _ = x.Count(new(Milestone))
|
2014-08-28 10:29:00 -04:00
|
|
|
stats.Counter.Label, _ = x.Count(new(Label))
|
|
|
|
stats.Counter.HookTask, _ = x.Count(new(HookTask))
|
|
|
|
stats.Counter.Team, _ = x.Count(new(Team))
|
|
|
|
stats.Counter.Attachment, _ = x.Count(new(Attachment))
|
2014-03-23 04:31:13 -04:00
|
|
|
return
|
2014-03-20 16:04:56 -04:00
|
|
|
}
|
2014-05-05 00:55:17 -04:00
|
|
|
|
2016-11-25 19:20:18 -05:00
|
|
|
// Ping tests if database is alive
|
2014-08-06 17:21:24 -04:00
|
|
|
func Ping() error {
|
2018-04-04 05:34:27 -04:00
|
|
|
if x != nil {
|
|
|
|
return x.Ping()
|
|
|
|
}
|
|
|
|
return errors.New("database not configured")
|
2014-08-06 17:21:24 -04:00
|
|
|
}
|
|
|
|
|
2017-01-03 03:20:28 -05:00
|
|
|
// DumpDatabase dumps all data from database according the special database SQL syntax to file system.
|
|
|
|
func DumpDatabase(filePath string, dbType string) error {
|
|
|
|
var tbs []*core.Table
|
|
|
|
for _, t := range tables {
|
2019-03-20 21:38:54 -04:00
|
|
|
t := x.TableInfo(t)
|
|
|
|
t.Table.Name = t.Name
|
|
|
|
tbs = append(tbs, t.Table)
|
2017-01-03 03:20:28 -05:00
|
|
|
}
|
|
|
|
if len(dbType) > 0 {
|
|
|
|
return x.DumpTablesToFile(tbs, filePath, core.DbType(dbType))
|
|
|
|
}
|
|
|
|
return x.DumpTablesToFile(tbs, filePath)
|
2014-05-05 00:55:17 -04:00
|
|
|
}
|
2019-07-06 15:24:50 -04:00
|
|
|
|
|
|
|
// MaxBatchInsertSize returns the table's max batch insert size
|
|
|
|
func MaxBatchInsertSize(bean interface{}) int {
|
|
|
|
t := x.TableInfo(bean)
|
|
|
|
return 999 / len(t.ColumnsSeq())
|
|
|
|
}
|
2019-09-05 22:20:09 -04:00
|
|
|
|
|
|
|
// Count returns records number according struct's fields as database query conditions
|
|
|
|
func Count(bean interface{}) (int64, error) {
|
|
|
|
return x.Count(bean)
|
|
|
|
}
|
2019-12-08 14:15:35 -05:00
|
|
|
|
|
|
|
// IsTableNotEmpty returns true if table has at least one record
|
|
|
|
func IsTableNotEmpty(tableName string) (bool, error) {
|
|
|
|
return x.Table(tableName).Exist()
|
|
|
|
}
|
|
|
|
|
|
|
|
// DeleteAllRecords will delete all the records of this table
|
|
|
|
func DeleteAllRecords(tableName string) error {
|
|
|
|
_, err := x.Exec(fmt.Sprintf("DELETE FROM %s", tableName))
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetMaxID will return max id of the table
|
|
|
|
func GetMaxID(beanOrTableName interface{}) (maxID int64, err error) {
|
|
|
|
_, err = x.Select("MAX(id)").Table(beanOrTableName).Get(&maxID)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
// FindByMaxID filled results as the condition from database
|
|
|
|
func FindByMaxID(maxID int64, limit int, results interface{}) error {
|
|
|
|
return x.Where("id <= ?", maxID).
|
|
|
|
OrderBy("id DESC").
|
|
|
|
Limit(limit).
|
|
|
|
Find(results)
|
|
|
|
}
|