forgejo/models/models.go

356 lines
10 KiB
Go
Raw Normal View History

2014-02-12 17:49:46 +00:00
// 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 models
2014-02-18 22:48:02 +00:00
import (
2014-10-19 05:35:24 +00:00
"database/sql"
"errors"
2014-02-18 22:48:02 +00:00
"fmt"
"net/url"
2014-02-18 22:48:02 +00:00
"os"
2014-03-21 05:09:22 +00:00
"path"
"path/filepath"
2014-04-14 06:49:50 +00:00
"strings"
2014-02-18 22:48:02 +00:00
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
2016-11-26 00:20:18 +00:00
// Needed for the MySQL driver
2014-02-18 22:48:02 +00:00
_ "github.com/go-sql-driver/mysql"
2015-01-23 07:54:16 +00:00
"github.com/go-xorm/core"
2014-04-18 13:35:09 +00:00
"github.com/go-xorm/xorm"
2016-11-26 00:20:18 +00:00
// Needed for the Postgresql driver
_ "github.com/lib/pq"
2014-02-18 22:48:02 +00:00
// Needed for the MSSSQL driver
_ "github.com/denisenkom/go-mssqldb"
2014-02-18 22:48:02 +00:00
)
2014-10-19 05:35:24 +00:00
// Engine represents a xorm engine or session.
type Engine interface {
Table(tableNameOrBean interface{}) *xorm.Session
Count(...interface{}) (int64, error)
2017-02-04 16:00:07 +00:00
Decr(column string, arg ...interface{}) *xorm.Session
2014-10-19 05:35:24 +00:00
Delete(interface{}) (int64, error)
Exec(string, ...interface{}) (sql.Result, error)
2015-02-13 05:58:46 +00:00
Find(interface{}, ...interface{}) error
Get(interface{}) (bool, error)
ID(interface{}) *xorm.Session
In(string, ...interface{}) *xorm.Session
2017-02-04 16:00:07 +00:00
Incr(column string, arg ...interface{}) *xorm.Session
2014-10-19 05:35:24 +00:00
Insert(...interface{}) (int64, error)
2015-02-13 05:58:46 +00:00
InsertOne(interface{}) (int64, error)
Iterate(interface{}, xorm.IterFunc) error
Join(joinOperator string, tablename interface{}, condition string, args ...interface{}) *xorm.Session
2016-11-10 07:20:48 +00:00
SQL(interface{}, ...interface{}) *xorm.Session
2016-09-22 23:38:12 +00:00
Where(interface{}, ...interface{}) *xorm.Session
2014-10-19 05:35:24 +00:00
}
2014-03-21 05:48:10 +00:00
var (
2016-11-26 00:20:18 +00:00
x *xorm.Engine
tables []interface{}
// HasEngine specifies if we have a xorm.Engine
2014-03-30 14:47:08 +00:00
HasEngine bool
2014-03-21 05:48:10 +00:00
2016-11-26 00:20:18 +00:00
// DbCfg holds the database settings
2014-03-21 07:27:59 +00:00
DbCfg struct {
Type, Host, Name, User, Passwd, Path, SSLMode string
Timeout int
2014-03-21 05:48:10 +00:00
}
2014-03-30 20:01:50 +00:00
2016-11-26 00:20:18 +00:00
// EnableSQLite3 use SQLite3
2014-04-12 20:24:09 +00:00
EnableSQLite3 bool
2016-11-26 00:20:18 +00:00
// EnableTiDB enable TiDB
EnableTiDB bool
2014-03-21 05:48:10 +00:00
)
2014-04-05 14:46:32 +00:00
func init() {
2014-11-12 11:48:50 +00:00
tables = append(tables,
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),
new(TwoFactor),
new(GPGKey),
new(RepoUnit),
new(RepoRedirect),
2017-02-23 07:05:37 +00:00
new(ExternalLoginUser),
new(ProtectedBranch),
2017-03-17 14:16:08 +00:00
new(UserOpenID),
2017-03-19 19:54:12 +00:00
new(IssueWatch),
2017-04-21 11:32:31 +00:00
new(CommitStatus),
Feature: Timetracking (#2211) * Added comment's hashtag to url for mail notifications. * Added explanation to return statement + documentation. * Replacing in-line link generation with HTMLURL. (+gofmt) * Replaced action-based model with nil-based model. (+gofmt) * Replaced mailIssueActionToParticipants with mailIssueCommentToParticipants. * Updating comment for mailIssueCommentToParticipants * Added link to comment in "Dashboard" * Deleting feed entry if a comment is going to be deleted * Added migration * Added improved migration to add a CommentID column to action. * Added improved links to comments in feed entries. * Fixes #1956 by filtering for deleted comments that are referenced in actions. * Introducing "IsDeleted" column to action. * Adding design draft (not functional) * Adding database models for stopwatches and trackedtimes * See go-gitea/gitea#967 * Adding design draft (not functional) * Adding translations and improving design * Implementing stopwatch (for timetracking) * Make UI functional * Add hints in timeline for time tracking events * Implementing timetracking feature * Adding "Add time manual" option * Improved stopwatch * Created report of total spent time by user * Only showing total time spent if theire is something to show. * Adding license headers. * Improved error handling for "Add Time Manual" * Adding @sapks 's changes, refactoring * Adding API for feature tracking * Adding unit test * Adding DISABLE/ENABLE option to Repository settings page * Improving translations * Applying @sapk 's changes * Removing repo_unit and using IssuesSetting for disabling/enabling timetracker * Adding DEFAULT_ENABLE_TIMETRACKER to config, installation and admin menu * Improving documentation * Fixing vendor/ folder * Changing timtracking routes by adding subgroups /times and /times/stopwatch (Proposed by @lafriks ) * Restricting write access to timetracking based on the repo settings (Proposed by @lafriks ) * Fixed minor permissions bug. * Adding CanUseTimetracker and IsTimetrackerEnabled in ctx.Repo * Allow assignees and authors to track there time too. * Fixed some build-time-errors + logical errors. * Removing unused Get...ByID functions * Moving IsTimetrackerEnabled from context.Repository to models.Repository * Adding a seperate file for issue related repo functions * Adding license headers * Fixed GetUserByParams return 404 * Moving /users/:username/times to /repos/:username/:reponame/times/:username for security reasons * Adding /repos/:username/times to get all tracked times of the repo * Updating sdk-dependency * Updating swagger.v1.json * Adding warning if user has already a running stopwatch (auto-timetracker) * Replacing GetTrackedTimesBy... with GetTrackedTimes(options FindTrackedTimesOptions) * Changing code.gitea.io/sdk back to code.gitea.io/sdk * Correcting spelling mistake * Updating vendor.json * Changing GET stopwatch/toggle to POST stopwatch/toggle * Changing GET stopwatch/cancel to POST stopwatch/cancel * Added migration for stopwatches/timetracking * Fixed some access bugs for read-only users * Added default allow only contributors to track time value to config * Fixed migration by chaging x.Iterate to x.Find * Resorted imports * Moved Add Time Manually form to repo_form.go * Removed "Seconds" field from Add Time Manually * Resorted imports * Improved permission checking * Fixed some bugs * Added integration test * gofmt * Adding integration test by @lafriks * Added created_unix to comment fixtures * Using last event instead of a fixed event * Adding another integration test by @lafriks * Fixing bug Timetracker enabled causing error 500 at sidebar.tpl * Fixed a refactoring bug that resulted in hiding "HasUserStopwatch" warning. * Returning TrackedTime instead of AddTimeOption at AddTime. * Updating SDK from go-gitea/go-sdk#69 * Resetting Go-SDK back to default repository * Fixing test-vendor by changing ini back to original repository * Adding "tags" to swagger spec * govendor sync * Removed duplicate * Formatting templates * Adding IsTimetrackingEnabled checks to API * Improving translations / english texts * Improving documentation * Updating swagger spec * Fixing integration test caused be translation-changes * Removed encoding issues in local_en-US.ini. * "Added" copyright line * Moved unit.IssuesConfig().EnableTimetracker into a != nil check * Removed some other encoding issues in local_en-US.ini * Improved javascript by checking if data-context exists * Replaced manual comment creation with CreateComment * Removed unnecessary code * Improved error checking * Small cosmetic changes * Replaced int>string>duration parsing with int>duration parsing * Fixed encoding issues * Removed unused imports Signed-off-by: Jonas Franz <info@jonasfranz.software>
2017-09-12 06:48:13 +00:00
new(Stopwatch),
new(TrackedTime),
new(DeletedBranch),
new(RepoIndexerStatus),
new(LFSLock),
new(Reaction),
2018-05-09 16:29:04 +00:00
new(IssueAssignees),
)
2015-08-27 15:06:14 +00:00
2016-11-26 00:20:18 +00:00
gonicNames := []string{"SSL", "UID"}
2015-08-27 15:06:14 +00:00
for _, name := range gonicNames {
core.LintGonicMapper[name] = true
}
2014-04-05 14:46:32 +00:00
}
2016-11-26 00:20:18 +00:00
// LoadConfigs loads the database settings
2015-09-17 03:08:46 +00:00
func LoadConfigs() {
2014-12-31 10:37:29 +00:00
sec := setting.Cfg.Section("database")
DbCfg.Type = sec.Key("DB_TYPE").String()
2015-02-12 02:58:37 +00:00
switch DbCfg.Type {
case "sqlite3":
setting.UseSQLite3 = true
case "mysql":
setting.UseMySQL = true
case "postgres":
setting.UsePostgreSQL = true
2015-09-12 19:31:36 +00:00
case "tidb":
setting.UseTiDB = true
case "mssql":
setting.UseMSSQL = true
2014-03-30 20:01:50 +00:00
}
2014-12-31 10:37:29 +00:00
DbCfg.Host = sec.Key("HOST").String()
DbCfg.Name = sec.Key("NAME").String()
DbCfg.User = sec.Key("USER").String()
if len(DbCfg.Passwd) == 0 {
DbCfg.Passwd = sec.Key("PASSWD").String()
2014-06-10 23:11:53 +00:00
}
DbCfg.SSLMode = sec.Key("SSL_MODE").String()
DbCfg.Path = sec.Key("PATH").MustString("data/gitea.db")
DbCfg.Timeout = sec.Key("SQLITE_TIMEOUT").MustInt(500)
2017-01-25 02:43:02 +00:00
sec = setting.Cfg.Section("indexer")
setting.Indexer.IssuePath = sec.Key("ISSUE_INDEXER_PATH").MustString(path.Join(setting.AppDataPath, "indexers/issues.bleve"))
if !filepath.IsAbs(setting.Indexer.IssuePath) {
setting.Indexer.IssuePath = path.Join(setting.AppWorkPath, setting.Indexer.IssuePath)
}
setting.Indexer.RepoIndexerEnabled = sec.Key("REPO_INDEXER_ENABLED").MustBool(false)
setting.Indexer.RepoPath = sec.Key("REPO_INDEXER_PATH").MustString(path.Join(setting.AppDataPath, "indexers/repos.bleve"))
if !filepath.IsAbs(setting.Indexer.RepoPath) {
setting.Indexer.RepoPath = path.Join(setting.AppWorkPath, setting.Indexer.RepoPath)
}
2017-01-25 02:43:02 +00:00
setting.Indexer.UpdateQueueLength = sec.Key("UPDATE_BUFFER_LEN").MustInt(20)
setting.Indexer.MaxIndexerFileSize = sec.Key("MAX_FILE_SIZE").MustInt64(1024 * 1024)
2014-03-21 05:48:10 +00:00
}
2014-02-18 22:48:02 +00:00
2016-08-12 09:56:50 +00: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
}
func parseMSSQLHostPort(info string) (string, string) {
host, port := "127.0.0.1", "1433"
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
}
return host, port
}
func getEngine() (*xorm.Engine, error) {
connStr := ""
2016-11-26 00:20:18 +00:00
var Param = "?"
2016-07-24 06:32:46 +00:00
if strings.Contains(DbCfg.Name, Param) {
Param = "&"
}
2014-03-30 14:47:08 +00:00
switch DbCfg.Type {
case "mysql":
if DbCfg.Host[0] == '/' { // looks like a unix socket
connStr = fmt.Sprintf("%s:%s@unix(%s)/%s%scharset=utf8&parseTime=true",
DbCfg.User, DbCfg.Passwd, DbCfg.Host, DbCfg.Name, Param)
} else {
connStr = fmt.Sprintf("%s:%s@tcp(%s)/%s%scharset=utf8&parseTime=true",
DbCfg.User, DbCfg.Passwd, DbCfg.Host, DbCfg.Name, Param)
}
2014-03-30 14:47:08 +00:00
case "postgres":
2016-08-12 10:04:50 +00:00
host, port := parsePostgreSQLHostPort(DbCfg.Host)
if host[0] == '/' { // looks like a unix socket
connStr = fmt.Sprintf("postgres://%s:%s@:%s/%s%ssslmode=%s&host=%s",
url.QueryEscape(DbCfg.User), url.QueryEscape(DbCfg.Passwd), port, DbCfg.Name, Param, DbCfg.SSLMode, host)
} else {
connStr = fmt.Sprintf("postgres://%s:%s@%s:%s/%s%ssslmode=%s",
url.QueryEscape(DbCfg.User), url.QueryEscape(DbCfg.Passwd), host, port, DbCfg.Name, Param, DbCfg.SSLMode)
}
case "mssql":
host, port := parseMSSQLHostPort(DbCfg.Host)
connStr = fmt.Sprintf("server=%s; port=%s; database=%s; user id=%s; password=%s;", host, port, DbCfg.Name, DbCfg.User, DbCfg.Passwd)
case "sqlite3":
2014-04-12 20:24:09 +00:00
if !EnableSQLite3 {
return nil, errors.New("this binary version does not build support for SQLite3")
2014-04-12 20:24:09 +00:00
}
2015-08-24 13:01:23 +00:00
if err := os.MkdirAll(path.Dir(DbCfg.Path), os.ModePerm); err != nil {
return nil, fmt.Errorf("Failed to create directories: %v", err)
2015-08-24 13:01:23 +00:00
}
connStr = fmt.Sprintf("file:%s?cache=shared&mode=rwc&_busy_timeout=%d", DbCfg.Path, DbCfg.Timeout)
case "tidb":
if !EnableTiDB {
return nil, errors.New("this binary version does not build support for TiDB")
}
if err := os.MkdirAll(path.Dir(DbCfg.Path), os.ModePerm); err != nil {
return nil, fmt.Errorf("Failed to create directories: %v", err)
}
connStr = "goleveldb://" + DbCfg.Path
2014-03-30 14:47:08 +00:00
default:
return nil, fmt.Errorf("Unknown database type: %s", DbCfg.Type)
2014-03-30 14:47:08 +00:00
}
return xorm.NewEngine(DbCfg.Type, connStr)
}
2016-11-26 00:20:18 +00:00
// NewTestEngine sets a new test xorm.Engine
func NewTestEngine(x *xorm.Engine) (err error) {
x, err = getEngine()
2014-03-30 14:47:08 +00:00
if err != nil {
2015-08-02 04:36:35 +00:00
return fmt.Errorf("Connect to database: %v", err)
2014-03-30 14:47:08 +00:00
}
2015-01-23 07:54:16 +00:00
x.SetMapper(core.GonicMapper{})
x.SetLogger(log.XORMLogger)
x.ShowSQL(!setting.ProdMode)
2015-09-03 09:05:58 +00:00
return x.StoreEngine("InnoDB").Sync2(tables...)
2014-03-30 14:47:08 +00:00
}
2016-11-26 00:20:18 +00:00
// SetEngine sets the xorm.Engine
func SetEngine() (err error) {
x, err = getEngine()
2014-02-18 22:48:02 +00:00
if err != nil {
return fmt.Errorf("Failed to connect to database: %v", err)
2014-02-18 22:48:02 +00:00
}
2015-01-23 07:54:16 +00:00
x.SetMapper(core.GonicMapper{})
2014-12-07 01:22:48 +00:00
// WARNING: for serv command, MUST remove the output to os.stdout,
2014-03-20 20:04:56 +00:00
// so use log file to instead print to stdout.
x.SetLogger(log.XORMLogger)
x.ShowSQL(setting.LogSQL)
return nil
2014-02-18 22:48:02 +00:00
}
2016-11-26 00:20:18 +00:00
// NewEngine initializes a new xorm.Engine
func NewEngine(migrateFunc func(*xorm.Engine) error) (err error) {
if err = SetEngine(); err != nil {
return err
2014-04-05 14:46:32 +00:00
}
2015-01-22 12:49:52 +00:00
if err = x.Ping(); err != nil {
return err
}
if err = migrateFunc(x); err != nil {
2015-02-12 02:58:37 +00:00
return fmt.Errorf("migrate: %v", err)
2015-01-22 12:49:52 +00:00
}
if err = x.StoreEngine("InnoDB").Sync2(tables...); err != nil {
return fmt.Errorf("sync database struct error: %v", err)
2014-02-19 09:50:53 +00:00
}
2015-01-23 07:54:16 +00:00
return nil
2014-02-18 22:48:02 +00:00
}
2014-03-20 20:04:56 +00:00
2016-11-26 00:20:18 +00:00
// Statistic contains the database statistics
2014-03-20 20:04:56 +00:00
type Statistic struct {
Counter struct {
2014-08-28 14:29:00 +00: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 20:04:56 +00:00
}
}
2016-11-26 00:20:18 +00:00
// GetStatistic returns the database statistics
2014-03-20 20:04:56 +00:00
func GetStatistic() (stats Statistic) {
stats.Counter.User = CountUsers()
2014-08-28 14:29:00 +00:00
stats.Counter.Org = CountOrganizations()
2014-06-21 04:51:41 +00:00
stats.Counter.PublicKey, _ = x.Count(new(PublicKey))
2016-07-24 06:32:46 +00:00
stats.Counter.Repo = CountRepositories(true)
2014-06-21 04:51:41 +00:00
stats.Counter.Watch, _ = x.Count(new(Watch))
2014-08-28 14:29:00 +00:00
stats.Counter.Star, _ = x.Count(new(Star))
2014-06-21 04:51:41 +00: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 20:11:44 +00:00
stats.Counter.Oauth = 0
2014-08-28 14:29:00 +00:00
stats.Counter.Follow, _ = x.Count(new(Follow))
stats.Counter.Mirror, _ = x.Count(new(Mirror))
2014-06-21 04:51:41 +00:00
stats.Counter.Release, _ = x.Count(new(Release))
2015-09-10 19:45:03 +00:00
stats.Counter.LoginSource = CountLoginSources()
2014-06-21 04:51:41 +00:00
stats.Counter.Webhook, _ = x.Count(new(Webhook))
stats.Counter.Milestone, _ = x.Count(new(Milestone))
2014-08-28 14:29:00 +00: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 08:31:13 +00:00
return
2014-03-20 20:04:56 +00:00
}
2014-05-05 04:55:17 +00:00
2016-11-26 00:20:18 +00:00
// Ping tests if database is alive
2014-08-06 21:21:24 +00:00
func Ping() error {
if x != nil {
return x.Ping()
}
return errors.New("database not configured")
2014-08-06 21:21:24 +00: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 {
tbs = append(tbs, x.TableInfo(t).Table)
}
if len(dbType) > 0 {
return x.DumpTablesToFile(tbs, filePath, core.DbType(dbType))
}
return x.DumpTablesToFile(tbs, filePath)
2014-05-05 04:55:17 +00:00
}