gotosocial/internal/db/pg.go

252 lines
7.2 KiB
Go
Raw Normal View History

2021-03-02 17:26:30 +00:00
/*
GoToSocial
Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package db
import (
"context"
"errors"
"fmt"
2021-03-04 13:38:18 +00:00
"regexp"
2021-03-03 17:12:02 +00:00
"strings"
2021-03-02 21:52:31 +00:00
"time"
2021-03-02 17:26:30 +00:00
"github.com/go-fed/activity/pub"
2021-03-05 17:31:12 +00:00
"github.com/go-pg/pg/extra/pgdebug"
"github.com/go-pg/pg/v10"
"github.com/go-pg/pg/v10/orm"
2021-03-04 13:38:18 +00:00
"github.com/gotosocial/gotosocial/internal/config"
2021-03-15 15:15:14 +00:00
"github.com/gotosocial/gotosocial/internal/gtsmodel"
2021-03-02 21:52:31 +00:00
"github.com/sirupsen/logrus"
2021-03-02 17:26:30 +00:00
)
// postgresService satisfies the DB interface
2021-03-02 17:26:30 +00:00
type postgresService struct {
config *config.DBConfig
conn *pg.DB
log *logrus.Entry
cancel context.CancelFunc
federationDB pub.Database
2021-03-02 17:26:30 +00:00
}
// newPostgresService returns a postgresService derived from the provided config, which implements the go-fed DB interface.
// Under the hood, it uses https://github.com/go-pg/pg to create and maintain a database connection.
2021-03-04 13:38:18 +00:00
func newPostgresService(ctx context.Context, c *config.Config, log *logrus.Entry) (*postgresService, error) {
opts, err := derivePGOptions(c)
2021-03-02 17:26:30 +00:00
if err != nil {
return nil, fmt.Errorf("could not create postgres service: %s", err)
}
2021-03-05 17:31:12 +00:00
log.Debugf("using pg options: %+v", opts)
2021-03-02 21:52:31 +00:00
readyChan := make(chan interface{})
2021-03-05 17:31:12 +00:00
opts.OnConnect = func(ctx context.Context, c *pg.Conn) error {
2021-03-02 21:52:31 +00:00
close(readyChan)
return nil
}
// create a connection
pgCtx, cancel := context.WithCancel(ctx)
conn := pg.Connect(opts).WithContext(pgCtx)
2021-03-05 17:31:12 +00:00
// this will break the logfmt format we normally log in,
// since we can't choose where pg outputs to and it defaults to
// stdout. So use this option with care!
if log.Logger.GetLevel() >= logrus.TraceLevel {
conn.AddQueryHook(pgdebug.DebugHook{
// Print all queries.
Verbose: true,
})
}
2021-03-02 21:52:31 +00:00
// actually *begin* the connection so that we can tell if the db is there
// and listening, and also trigger the opts.OnConnect function passed in above
2021-03-05 17:31:12 +00:00
if err := conn.Ping(ctx); err != nil {
2021-03-02 21:52:31 +00:00
cancel()
return nil, fmt.Errorf("db connection error: %s", err)
}
2021-03-05 17:31:12 +00:00
// print out discovered postgres version
var version string
if _, err = conn.QueryOneContext(ctx, pg.Scan(&version), "SELECT version()"); err != nil {
2021-03-02 21:52:31 +00:00
cancel()
return nil, fmt.Errorf("db connection error: %s", err)
}
2021-03-05 17:31:12 +00:00
log.Infof("connected to postgres version: %s", version)
2021-03-02 21:52:31 +00:00
// make sure the opts.OnConnect function has been triggered
// and closed the ready channel
select {
case <-readyChan:
log.Infof("postgres connection ready")
case <-time.After(5 * time.Second):
cancel()
return nil, errors.New("db connection timeout")
}
// we can confidently return this useable postgres service now
2021-03-02 17:26:30 +00:00
return &postgresService{
config: c.DBConfig,
conn: conn,
log: log,
cancel: cancel,
federationDB: newPostgresFederation(conn),
2021-03-02 17:26:30 +00:00
}, nil
}
func (ps *postgresService) Federation() pub.Database {
return ps.federationDB
}
2021-03-02 17:26:30 +00:00
/*
HANDY STUFF
*/
// derivePGOptions takes an application config and returns either a ready-to-use *pg.Options
// with sensible defaults, or an error if it's not satisfied by the provided config.
2021-03-04 13:38:18 +00:00
func derivePGOptions(c *config.Config) (*pg.Options, error) {
if strings.ToUpper(c.DBConfig.Type) != dbTypePostgres {
return nil, fmt.Errorf("expected db type of %s but got %s", dbTypePostgres, c.DBConfig.Type)
2021-03-02 17:26:30 +00:00
}
2021-03-04 11:07:24 +00:00
// validate port
2021-03-04 13:38:18 +00:00
if c.DBConfig.Port == 0 {
2021-03-04 11:07:24 +00:00
return nil, errors.New("no port set")
2021-03-02 17:26:30 +00:00
}
// validate address
2021-03-04 13:38:18 +00:00
if c.DBConfig.Address == "" {
2021-03-04 11:07:24 +00:00
return nil, errors.New("no address set")
2021-03-02 21:52:31 +00:00
}
2021-03-04 13:38:18 +00:00
ipv4Regex := regexp.MustCompile(`^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$`)
hostnameRegex := regexp.MustCompile(`^(?:[a-z0-9]+(?:-[a-z0-9]+)*\.)+[a-z]{2,}$`)
if !hostnameRegex.MatchString(c.DBConfig.Address) && !ipv4Regex.MatchString(c.DBConfig.Address) && c.DBConfig.Address != "localhost" {
return nil, fmt.Errorf("address %s was neither an ipv4 address nor a valid hostname", c.DBConfig.Address)
2021-03-02 21:52:31 +00:00
}
// validate username
2021-03-04 13:38:18 +00:00
if c.DBConfig.User == "" {
2021-03-04 11:07:24 +00:00
return nil, errors.New("no user set")
2021-03-02 17:26:30 +00:00
}
2021-03-02 21:52:31 +00:00
// validate that there's a password
2021-03-04 13:38:18 +00:00
if c.DBConfig.Password == "" {
2021-03-02 21:52:31 +00:00
return nil, errors.New("no password set")
}
// validate database
2021-03-04 13:38:18 +00:00
if c.DBConfig.Database == "" {
2021-03-04 11:07:24 +00:00
return nil, errors.New("no database set")
2021-03-02 17:26:30 +00:00
}
2021-03-02 21:52:31 +00:00
// We can rely on the pg library we're using to set
// sensible defaults for everything we don't set here.
2021-03-02 17:26:30 +00:00
options := &pg.Options{
2021-03-04 13:38:18 +00:00
Addr: fmt.Sprintf("%s:%d", c.DBConfig.Address, c.DBConfig.Port),
User: c.DBConfig.User,
Password: c.DBConfig.Password,
Database: c.DBConfig.Database,
ApplicationName: c.ApplicationName,
2021-03-02 17:26:30 +00:00
}
return options, nil
}
/*
EXTRA FUNCTIONS
*/
2021-03-02 21:52:31 +00:00
func (ps *postgresService) Stop(ctx context.Context) error {
ps.log.Info("closing db connection")
if err := ps.conn.Close(); err != nil {
// only cancel if there's a problem closing the db
ps.cancel()
return err
}
return nil
2021-03-02 17:26:30 +00:00
}
2021-03-05 17:31:12 +00:00
func (ps *postgresService) CreateSchema(ctx context.Context) error {
models := []interface{}{
2021-03-15 22:05:24 +00:00
(*gtsmodel.Account)(nil),
(*gtsmodel.Status)(nil),
(*gtsmodel.User)(nil),
2021-03-05 17:31:12 +00:00
}
ps.log.Info("creating db schema")
for _, model := range models {
err := ps.conn.Model(model).CreateTable(&orm.CreateTableOptions{
IfNotExists: true,
})
if err != nil {
return err
}
}
ps.log.Info("db schema created")
return nil
}
func (ps *postgresService) IsHealthy(ctx context.Context) error {
return ps.conn.Ping(ctx)
}
2021-03-14 16:56:16 +00:00
func (ps *postgresService) CreateTable(i interface{}) error {
return ps.conn.Model(i).CreateTable(&orm.CreateTableOptions{
IfNotExists: true,
})
}
func (ps *postgresService) DropTable(i interface{}) error {
return ps.conn.Model(i).DropTable(&orm.DropTableOptions{
IfExists: true,
})
}
func (ps *postgresService) GetByID(id string, i interface{}) error {
return ps.conn.Model(i).Where("id = ?", id).Select()
}
func (ps *postgresService) GetWhere(key string, value interface{}, i interface{}) error {
return ps.conn.Model(i).Where(fmt.Sprintf("%s = ?", key), value).Select()
}
func (ps *postgresService) GetAll(i interface{}) error {
return ps.conn.Model(i).Select()
}
func (ps *postgresService) Put(i interface{}) error {
_, err := ps.conn.Model(i).Insert(i)
return err
}
func (ps *postgresService) UpdateByID(id string, i interface{}) error {
_, err := ps.conn.Model(i).OnConflict("(id) DO UPDATE").Insert()
return err
}
func (ps *postgresService) DeleteByID(id string, i interface{}) error {
_, err := ps.conn.Model(i).Where("id = ?", id).Delete()
return err
}
func (ps *postgresService) DeleteWhere(key string, value interface{}, i interface{}) error {
_, err := ps.conn.Model(i).Where(fmt.Sprintf("%s = ?", key), value).Delete()
return err
2021-03-14 16:56:16 +00:00
}