2014-02-12 21:49:46 +04:00
// Copyright 2014 The Gogs Authors. All rights reserved.
2018-06-20 08:06:01 +03:00
// Copyright 2018 The Gitea Authors. All rights reserved.
2014-02-12 21:49:46 +04: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 19:23:23 +04:00
2014-02-19 02:48:02 +04:00
import (
2014-10-19 09:35:24 +04:00
"database/sql"
2016-08-12 00:38:26 +03:00
"errors"
2014-02-19 02:48:02 +04:00
"fmt"
2015-08-29 07:08:37 +03:00
"net/url"
2014-02-19 02:48:02 +04:00
"os"
2014-03-21 09:09:22 +04:00
"path"
2019-02-27 19:55:08 +03:00
"path/filepath"
2014-04-14 10:49:50 +04:00
"strings"
2019-05-26 16:28:33 +03:00
"time"
2014-02-19 02:48:02 +04:00
2017-10-27 09:10:54 +03:00
"code.gitea.io/gitea/modules/setting"
2016-11-26 03:20:18 +03:00
// Needed for the MySQL driver
2014-02-19 02:48:02 +04:00
_ "github.com/go-sql-driver/mysql"
2015-01-23 10:54:16 +03:00
"github.com/go-xorm/core"
2014-04-18 17:35:09 +04:00
"github.com/go-xorm/xorm"
2016-11-26 03:20:18 +03:00
// Needed for the Postgresql driver
2014-03-17 22:03:58 +04:00
_ "github.com/lib/pq"
2014-02-19 02:48:02 +04:00
2016-12-24 04:37:35 +03:00
// Needed for the MSSSQL driver
_ "github.com/denisenkom/go-mssqldb"
2014-02-19 02:48:02 +04:00
)
2014-02-13 19:23:23 +04:00
2014-10-19 09:35:24 +04:00
// Engine represents a xorm engine or session.
type Engine interface {
2017-02-14 06:46:46 +03:00
Table ( tableNameOrBean interface { } ) * xorm . Session
2017-08-22 14:39:52 +03:00
Count ( ... interface { } ) ( int64 , error )
2017-02-04 19:00:07 +03:00
Decr ( column string , arg ... interface { } ) * xorm . Session
2014-10-19 09:35:24 +04:00
Delete ( interface { } ) ( int64 , error )
2018-12-12 04:01:41 +03:00
Exec ( ... interface { } ) ( sql . Result , error )
2015-02-13 08:58:46 +03:00
Find ( interface { } , ... interface { } ) error
2015-02-11 07:44:16 +03:00
Get ( interface { } ) ( bool , error )
2017-10-05 07:43:04 +03:00
ID ( interface { } ) * xorm . Session
2016-08-16 04:40:32 +03:00
In ( string , ... interface { } ) * xorm . Session
2017-02-04 19:00:07 +03:00
Incr ( column string , arg ... interface { } ) * xorm . Session
2014-10-19 09:35:24 +04:00
Insert ( ... interface { } ) ( int64 , error )
2015-02-13 08:58:46 +03:00
InsertOne ( interface { } ) ( int64 , error )
2016-07-26 12:26:48 +03:00
Iterate ( interface { } , xorm . IterFunc ) error
2017-02-11 15:01:33 +03:00
Join ( joinOperator string , tablename interface { } , condition string , args ... interface { } ) * xorm . Session
2016-11-10 10:20:48 +03:00
SQL ( interface { } , ... interface { } ) * xorm . Session
2016-09-23 02:38:12 +03:00
Where ( interface { } , ... interface { } ) * xorm . Session
2014-10-19 09:35:24 +04:00
}
2014-03-21 09:48:10 +04:00
var (
2019-03-21 04:38:54 +03:00
x * xorm . Engine
supportedDatabases = [ ] string { "mysql" , "postgres" , "mssql" }
tables [ ] interface { }
2016-11-26 03:20:18 +03:00
// HasEngine specifies if we have a xorm.Engine
2014-03-30 18:47:08 +04:00
HasEngine bool
2014-03-21 09:48:10 +04:00
2016-11-26 03:20:18 +03:00
// DbCfg holds the database settings
2014-03-21 11:27:59 +04:00
DbCfg struct {
2019-05-24 07:15:26 +03:00
Type , Host , Name , User , Passwd , Path , SSLMode , Charset string
Timeout int
2014-03-21 09:48:10 +04:00
}
2014-03-31 00:01:50 +04:00
2016-11-26 03:20:18 +03:00
// EnableSQLite3 use SQLite3
2014-04-13 00:24:09 +04:00
EnableSQLite3 bool
2016-11-26 03:20:18 +03:00
// EnableTiDB enable TiDB
EnableTiDB bool
2014-03-21 09:48:10 +04:00
)
2014-04-05 18:46:32 +04:00
func init ( ) {
2014-11-12 14:48:50 +03:00
tables = append ( tables ,
2016-12-30 19:44:54 +03: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-16 05:14:29 +03:00
new ( TwoFactor ) ,
2017-03-16 04:27:35 +03:00
new ( GPGKey ) ,
2019-04-14 19:43:56 +03:00
new ( GPGKeyImport ) ,
2017-02-04 18:53:46 +03:00
new ( RepoUnit ) ,
2017-02-05 17:35:03 +03:00
new ( RepoRedirect ) ,
2017-02-23 10:05:37 +03:00
new ( ExternalLoginUser ) ,
new ( ProtectedBranch ) ,
2017-03-17 17:16:08 +03:00
new ( UserOpenID ) ,
2017-03-19 22:54:12 +03:00
new ( IssueWatch ) ,
2017-04-21 14:32:31 +03:00
new ( CommitStatus ) ,
2017-09-12 09:48:13 +03:00
new ( Stopwatch ) ,
new ( TrackedTime ) ,
2017-10-26 03:49:16 +03:00
new ( DeletedBranch ) ,
2017-10-27 09:10:54 +03:00
new ( RepoIndexerStatus ) ,
2018-07-18 00:23:58 +03:00
new ( IssueDependency ) ,
2017-11-28 23:58:37 +03:00
new ( LFSLock ) ,
2017-12-04 02:14:26 +03:00
new ( Reaction ) ,
2018-05-09 19:29:04 +03:00
new ( IssueAssignees ) ,
2018-05-19 17:12:37 +03:00
new ( U2FRegistration ) ,
2018-06-21 19:00:13 +03:00
new ( TeamUnit ) ,
2018-08-06 07:43:22 +03:00
new ( Review ) ,
2019-03-08 19:42:50 +03:00
new ( OAuth2Application ) ,
new ( OAuth2AuthorizationCode ) ,
new ( OAuth2Grant ) ,
2016-12-30 19:44:54 +03:00
)
2015-08-27 18:06:14 +03:00
2016-11-26 03:20:18 +03:00
gonicNames := [ ] string { "SSL" , "UID" }
2015-08-27 18:06:14 +03:00
for _ , name := range gonicNames {
core . LintGonicMapper [ name ] = true
}
2014-04-05 18:46:32 +04:00
}
2016-11-26 03:20:18 +03:00
// LoadConfigs loads the database settings
2015-09-17 06:08:46 +03:00
func LoadConfigs ( ) {
2014-12-31 13:37:29 +03:00
sec := setting . Cfg . Section ( "database" )
DbCfg . Type = sec . Key ( "DB_TYPE" ) . String ( )
2015-02-12 05:58:37 +03:00
switch DbCfg . Type {
case "sqlite3" :
setting . UseSQLite3 = true
case "mysql" :
setting . UseMySQL = true
case "postgres" :
setting . UsePostgreSQL = true
2015-09-12 22:31:36 +03:00
case "tidb" :
setting . UseTiDB = true
2016-12-24 04:37:35 +03:00
case "mssql" :
setting . UseMSSQL = true
2014-03-31 00:01:50 +04:00
}
2014-12-31 13:37:29 +03:00
DbCfg . Host = sec . Key ( "HOST" ) . String ( )
DbCfg . Name = sec . Key ( "NAME" ) . String ( )
DbCfg . User = sec . Key ( "USER" ) . String ( )
2015-02-01 20:41:03 +03:00
if len ( DbCfg . Passwd ) == 0 {
DbCfg . Passwd = sec . Key ( "PASSWD" ) . String ( )
2014-06-11 03:11:53 +04:00
}
2018-08-24 01:42:02 +03:00
DbCfg . SSLMode = sec . Key ( "SSL_MODE" ) . MustString ( "disable" )
2019-05-24 07:15:26 +03:00
DbCfg . Charset = sec . Key ( "CHARSET" ) . In ( "utf8" , [ ] string { "utf8" , "utf8mb4" } )
2019-02-27 19:55:08 +03:00
DbCfg . Path = sec . Key ( "PATH" ) . MustString ( filepath . Join ( setting . AppDataPath , "gitea.db" ) )
2017-06-15 05:51:17 +03:00
DbCfg . Timeout = sec . Key ( "SQLITE_TIMEOUT" ) . MustInt ( 500 )
2014-03-21 09:48:10 +04:00
}
2014-02-19 02:48:02 +04:00
2016-08-12 12:56:50 +03:00
// parsePostgreSQLHostPort parses given input in various forms defined in
// https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING
// and returns proper host and port number.
func parsePostgreSQLHostPort ( info string ) ( string , string ) {
host , port := "127.0.0.1" , "5432"
if strings . Contains ( info , ":" ) && ! strings . HasSuffix ( info , "]" ) {
idx := strings . LastIndex ( info , ":" )
host = info [ : idx ]
port = info [ idx + 1 : ]
} else if len ( info ) > 0 {
host = info
}
return host , port
}
2018-06-20 08:06:01 +03:00
func getPostgreSQLConnectionString ( DBHost , DBUser , DBPasswd , DBName , DBParam , DBSSLMode string ) ( connStr string ) {
host , port := parsePostgreSQLHostPort ( DBHost )
if host [ 0 ] == '/' { // looks like a unix socket
connStr = fmt . Sprintf ( "postgres://%s:%s@:%s/%s%ssslmode=%s&host=%s" ,
url . PathEscape ( DBUser ) , url . PathEscape ( DBPasswd ) , port , DBName , DBParam , DBSSLMode , host )
} else {
connStr = fmt . Sprintf ( "postgres://%s:%s@%s:%s/%s%ssslmode=%s" ,
url . PathEscape ( DBUser ) , url . PathEscape ( DBPasswd ) , host , port , DBName , DBParam , DBSSLMode )
}
return
}
2018-12-12 04:01:41 +03:00
// ParseMSSQLHostPort splits the host into host and port
func ParseMSSQLHostPort ( info string ) ( string , string ) {
2016-12-24 04:37:35 +03:00
host , port := "127.0.0.1" , "1433"
2016-12-30 10:26:05 +03:00
if strings . Contains ( info , ":" ) {
host = strings . Split ( info , ":" ) [ 0 ]
port = strings . Split ( info , ":" ) [ 1 ]
} else if strings . Contains ( info , "," ) {
host = strings . Split ( info , "," ) [ 0 ]
port = strings . TrimSpace ( strings . Split ( info , "," ) [ 1 ] )
} else if len ( info ) > 0 {
host = info
}
2016-12-24 04:37:35 +03:00
return host , port
}
2014-09-04 19:19:26 +04:00
func getEngine ( ) ( * xorm . Engine , error ) {
2016-08-12 00:38:26 +03:00
connStr := ""
2016-11-26 03:20:18 +03:00
var Param = "?"
2016-07-24 09:32:46 +03:00
if strings . Contains ( DbCfg . Name , Param ) {
Param = "&"
2016-07-02 17:39:39 +03:00
}
2014-03-30 18:47:08 +04:00
switch DbCfg . Type {
case "mysql" :
2018-08-24 01:42:02 +03:00
connType := "tcp"
2015-03-13 21:21:47 +03:00
if DbCfg . Host [ 0 ] == '/' { // looks like a unix socket
2018-08-24 01:42:02 +03:00
connType = "unix"
2015-03-13 21:21:47 +03:00
}
2018-08-24 01:42:02 +03:00
tls := DbCfg . SSLMode
if tls == "disable" { // allow (Postgres-inspired) default value to work in MySQL
tls = "false"
}
2019-05-24 07:15:26 +03:00
connStr = fmt . Sprintf ( "%s:%s@%s(%s)/%s%scharset=%s&parseTime=true&tls=%s" ,
DbCfg . User , DbCfg . Passwd , connType , DbCfg . Host , DbCfg . Name , Param , DbCfg . Charset , tls )
2014-03-30 18:47:08 +04:00
case "postgres" :
2018-06-20 08:06:01 +03:00
connStr = getPostgreSQLConnectionString ( DbCfg . Host , DbCfg . User , DbCfg . Passwd , DbCfg . Name , Param , DbCfg . SSLMode )
2016-12-24 04:37:35 +03:00
case "mssql" :
2018-12-12 04:01:41 +03:00
host , port := ParseMSSQLHostPort ( DbCfg . Host )
2016-12-24 04:37:35 +03:00
connStr = fmt . Sprintf ( "server=%s; port=%s; database=%s; user id=%s; password=%s;" , host , port , DbCfg . Name , DbCfg . User , DbCfg . Passwd )
2014-04-12 22:48:12 +04:00
case "sqlite3" :
2014-04-13 00:24:09 +04:00
if ! EnableSQLite3 {
2016-11-28 10:25:16 +03:00
return nil , errors . New ( "this binary version does not build support for SQLite3" )
2014-04-13 00:24:09 +04:00
}
2015-08-24 16:01:23 +03:00
if err := os . MkdirAll ( path . Dir ( DbCfg . Path ) , os . ModePerm ) ; err != nil {
2017-01-29 23:13:57 +03:00
return nil , fmt . Errorf ( "Failed to create directories: %v" , err )
2015-08-24 16:01:23 +03:00
}
2017-06-15 05:51:17 +03:00
connStr = fmt . Sprintf ( "file:%s?cache=shared&mode=rwc&_busy_timeout=%d" , DbCfg . Path , DbCfg . Timeout )
2015-09-06 23:31:22 +03:00
case "tidb" :
2016-08-12 00:38:26 +03:00
if ! EnableTiDB {
2016-11-28 10:25:16 +03:00
return nil , errors . New ( "this binary version does not build support for TiDB" )
2015-09-06 23:31:22 +03:00
}
if err := os . MkdirAll ( path . Dir ( DbCfg . Path ) , os . ModePerm ) ; err != nil {
2017-01-29 23:13:57 +03:00
return nil , fmt . Errorf ( "Failed to create directories: %v" , err )
2015-09-06 23:31:22 +03:00
}
2016-08-12 00:38:26 +03:00
connStr = "goleveldb://" + DbCfg . Path
2014-03-30 18:47:08 +04:00
default :
2014-09-04 19:19:26 +04:00
return nil , fmt . Errorf ( "Unknown database type: %s" , DbCfg . Type )
2014-03-30 18:47:08 +04:00
}
2017-02-20 11:11:13 +03:00
2016-08-12 00:38:26 +03:00
return xorm . NewEngine ( DbCfg . Type , connStr )
2014-09-04 19:19:26 +04:00
}
2016-11-26 03:20:18 +03:00
// NewTestEngine sets a new test xorm.Engine
2014-09-04 19:19:26 +04:00
func NewTestEngine ( x * xorm . Engine ) ( err error ) {
x , err = getEngine ( )
2014-03-30 18:47:08 +04:00
if err != nil {
2015-08-02 07:36:35 +03:00
return fmt . Errorf ( "Connect to database: %v" , err )
2014-03-30 18:47:08 +04:00
}
2014-09-04 19:19:26 +04:00
2015-01-23 10:54:16 +03:00
x . SetMapper ( core . GonicMapper { } )
2019-05-14 10:04:07 +03:00
x . SetLogger ( NewXORMLogger ( ! setting . ProdMode ) )
2017-09-13 08:18:22 +03:00
x . ShowSQL ( ! setting . ProdMode )
2015-09-03 12:05:58 +03:00
return x . StoreEngine ( "InnoDB" ) . Sync2 ( tables ... )
2014-03-30 18:47:08 +04:00
}
2016-11-26 03:20:18 +03:00
// SetEngine sets the xorm.Engine
2014-03-30 01:50:51 +04:00
func SetEngine ( ) ( err error ) {
2014-09-04 19:19:26 +04:00
x , err = getEngine ( )
2014-02-19 02:48:02 +04:00
if err != nil {
2017-01-29 23:13:57 +03:00
return fmt . Errorf ( "Failed to connect to database: %v" , err )
2014-02-19 02:48:02 +04:00
}
2015-01-23 10:54:16 +03:00
x . SetMapper ( core . GonicMapper { } )
2014-12-07 04:22:48 +03:00
// WARNING: for serv command, MUST remove the output to os.stdout,
2014-03-21 00:04:56 +04:00
// so use log file to instead print to stdout.
2019-05-14 10:04:07 +03:00
x . SetLogger ( NewXORMLogger ( setting . LogSQL ) )
2018-03-30 17:49:46 +03:00
x . ShowSQL ( setting . LogSQL )
2019-05-26 16:28:33 +03:00
if DbCfg . Type == "mysql" {
x . SetMaxIdleConns ( 0 )
x . SetConnMaxLifetime ( 3 * time . Second )
}
2014-03-30 01:50:51 +04:00
return nil
2014-02-19 02:48:02 +04:00
}
2016-11-26 03:20:18 +03:00
// NewEngine initializes a new xorm.Engine
2017-07-02 16:50:57 +03:00
func NewEngine ( migrateFunc func ( * xorm . Engine ) error ) ( err error ) {
2014-03-30 01:50:51 +04:00
if err = SetEngine ( ) ; err != nil {
return err
2014-04-05 18:46:32 +04:00
}
2015-01-22 15:49:52 +03:00
2016-11-24 17:30:36 +03:00
if err = x . Ping ( ) ; err != nil {
return err
}
2017-07-02 16:50:57 +03:00
if err = migrateFunc ( x ) ; err != nil {
2015-02-12 05:58:37 +03:00
return fmt . Errorf ( "migrate: %v" , err )
2015-01-22 15:49:52 +03:00
}
2014-10-28 18:40:09 +03:00
if err = x . StoreEngine ( "InnoDB" ) . Sync2 ( tables ... ) ; err != nil {
2016-11-28 10:25:16 +03:00
return fmt . Errorf ( "sync database struct error: %v" , err )
2014-02-19 13:50:53 +04:00
}
2015-01-23 10:54:16 +03:00
2014-03-30 01:50:51 +04:00
return nil
2014-02-19 02:48:02 +04:00
}
2014-03-21 00:04:56 +04:00
2016-11-26 03:20:18 +03:00
// Statistic contains the database statistics
2014-03-21 00:04:56 +04:00
type Statistic struct {
Counter struct {
2014-08-28 18: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-21 00:04:56 +04:00
}
}
2016-11-26 03:20:18 +03:00
// GetStatistic returns the database statistics
2014-03-21 00:04:56 +04:00
func GetStatistic ( ) ( stats Statistic ) {
2014-07-07 12:15:08 +04:00
stats . Counter . User = CountUsers ( )
2014-08-28 18:29:00 +04:00
stats . Counter . Org = CountOrganizations ( )
2014-06-21 08:51:41 +04:00
stats . Counter . PublicKey , _ = x . Count ( new ( PublicKey ) )
2016-07-24 09:32:46 +03:00
stats . Counter . Repo = CountRepositories ( true )
2014-06-21 08:51:41 +04:00
stats . Counter . Watch , _ = x . Count ( new ( Watch ) )
2014-08-28 18:29:00 +04:00
stats . Counter . Star , _ = x . Count ( new ( Star ) )
2014-06-21 08: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 23:11:44 +03:00
stats . Counter . Oauth = 0
2014-08-28 18:29:00 +04:00
stats . Counter . Follow , _ = x . Count ( new ( Follow ) )
stats . Counter . Mirror , _ = x . Count ( new ( Mirror ) )
2014-06-21 08:51:41 +04:00
stats . Counter . Release , _ = x . Count ( new ( Release ) )
2015-09-10 22:45:03 +03:00
stats . Counter . LoginSource = CountLoginSources ( )
2014-06-21 08:51:41 +04:00
stats . Counter . Webhook , _ = x . Count ( new ( Webhook ) )
stats . Counter . Milestone , _ = x . Count ( new ( Milestone ) )
2014-08-28 18: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 12:31:13 +04:00
return
2014-03-21 00:04:56 +04:00
}
2014-05-05 08:55:17 +04:00
2016-11-26 03:20:18 +03:00
// Ping tests if database is alive
2014-08-07 01:21:24 +04:00
func Ping ( ) error {
2018-04-04 12:34:27 +03:00
if x != nil {
return x . Ping ( )
}
return errors . New ( "database not configured" )
2014-08-07 01:21:24 +04:00
}
2017-01-03 11:20:28 +03: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-21 04:38:54 +03:00
t := x . TableInfo ( t )
t . Table . Name = t . Name
tbs = append ( tbs , t . Table )
2017-01-03 11:20:28 +03:00
}
if len ( dbType ) > 0 {
return x . DumpTablesToFile ( tbs , filePath , core . DbType ( dbType ) )
}
return x . DumpTablesToFile ( tbs , filePath )
2014-05-05 08:55:17 +04:00
}