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/>.
|
|
|
|
*/
|
|
|
|
|
2021-05-15 09:58:11 +00:00
|
|
|
package pg
|
2021-03-02 17:26:30 +00:00
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
2021-07-19 16:03:07 +00:00
|
|
|
"crypto/tls"
|
|
|
|
"crypto/x509"
|
|
|
|
"encoding/pem"
|
2021-03-02 17:26:30 +00:00
|
|
|
"errors"
|
|
|
|
"fmt"
|
2021-07-19 16:03:07 +00:00
|
|
|
"os"
|
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
|
|
|
|
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-02 21:52:31 +00:00
|
|
|
"github.com/sirupsen/logrus"
|
2021-04-01 18:46:45 +00:00
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
2021-05-15 09:58:11 +00:00
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
2021-05-08 12:25:55 +00:00
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
2021-06-13 16:42:28 +00:00
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/id"
|
2021-03-02 17:26:30 +00:00
|
|
|
)
|
|
|
|
|
2021-08-20 10:26:56 +00:00
|
|
|
var registerTables []interface{} = []interface{}{
|
|
|
|
>smodel.StatusToEmoji{},
|
|
|
|
>smodel.StatusToTag{},
|
|
|
|
}
|
|
|
|
|
2021-03-22 21:26:54 +00:00
|
|
|
// postgresService satisfies the DB interface
|
2021-03-02 17:26:30 +00:00
|
|
|
type postgresService struct {
|
2021-08-20 10:26:56 +00:00
|
|
|
db.Account
|
|
|
|
db.Admin
|
|
|
|
db.Basic
|
|
|
|
db.Domain
|
|
|
|
db.Instance
|
|
|
|
db.Media
|
|
|
|
db.Mention
|
|
|
|
db.Notification
|
|
|
|
db.Relationship
|
|
|
|
db.Status
|
|
|
|
db.Timeline
|
2021-05-21 13:48:26 +00:00
|
|
|
config *config.Config
|
|
|
|
conn *pg.DB
|
|
|
|
log *logrus.Logger
|
|
|
|
cancel context.CancelFunc
|
2021-03-02 17:26:30 +00:00
|
|
|
}
|
|
|
|
|
2021-05-08 12:25:55 +00:00
|
|
|
// NewPostgresService returns a postgresService derived from the provided config, which implements the go-fed DB interface.
|
2021-03-02 17:26:30 +00:00
|
|
|
// Under the hood, it uses https://github.com/go-pg/pg to create and maintain a database connection.
|
2021-05-15 09:58:11 +00:00
|
|
|
func NewPostgresService(ctx context.Context, c *config.Config, log *logrus.Logger) (db.DB, error) {
|
2021-08-20 10:26:56 +00:00
|
|
|
for _, t := range registerTables {
|
|
|
|
// https://pg.uptrace.dev/orm/many-to-many-relation/
|
|
|
|
orm.RegisterTable(t)
|
|
|
|
}
|
|
|
|
|
2021-03-04 13:38:18 +00:00
|
|
|
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
|
|
|
|
|
|
|
// 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!
|
2021-05-08 12:25:55 +00:00
|
|
|
if log.GetLevel() >= logrus.TraceLevel {
|
2021-03-05 17:31:12 +00:00
|
|
|
conn.AddQueryHook(pgdebug.DebugHook{
|
|
|
|
// Print all queries.
|
|
|
|
Verbose: true,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2021-04-19 17:42:19 +00:00
|
|
|
// actually *begin* the connection so that we can tell if the db is there and listening
|
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
|
|
|
|
2021-04-01 18:46:45 +00:00
|
|
|
ps := &postgresService{
|
2021-08-20 10:26:56 +00:00
|
|
|
Account: &accountDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Admin: &adminDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Basic: &basicDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Domain: &domainDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Instance: &instanceDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Media: &mediaDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Mention: &mentionDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Notification: ¬ificationDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Relationship: &relationshipDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Status: &statusDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
|
|
|
Timeline: &timelineDB{
|
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
},
|
2021-04-01 18:46:45 +00:00
|
|
|
config: c,
|
|
|
|
conn: conn,
|
|
|
|
log: log,
|
|
|
|
cancel: cancel,
|
|
|
|
}
|
2021-03-02 17:26:30 +00:00
|
|
|
|
2021-04-01 18:46:45 +00:00
|
|
|
// we can confidently return this useable postgres service now
|
|
|
|
return ps, nil
|
2021-03-22 21:26:54 +00:00
|
|
|
}
|
|
|
|
|
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) {
|
2021-05-15 09:58:11 +00:00
|
|
|
if strings.ToUpper(c.DBConfig.Type) != db.DBTypePostgres {
|
|
|
|
return nil, fmt.Errorf("expected db type of %s but got %s", db.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
|
|
|
|
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-07-19 16:03:07 +00:00
|
|
|
var tlsConfig *tls.Config
|
|
|
|
switch c.DBConfig.TLSMode {
|
|
|
|
case config.DBTLSModeDisable, config.DBTLSModeUnset:
|
|
|
|
break // nothing to do
|
|
|
|
case config.DBTLSModeEnable:
|
|
|
|
tlsConfig = &tls.Config{
|
|
|
|
InsecureSkipVerify: true,
|
|
|
|
}
|
|
|
|
case config.DBTLSModeRequire:
|
|
|
|
tlsConfig = &tls.Config{
|
|
|
|
InsecureSkipVerify: false,
|
2021-07-19 17:31:47 +00:00
|
|
|
ServerName: c.DBConfig.Address,
|
2021-07-19 16:03:07 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if tlsConfig != nil && c.DBConfig.TLSCACert != "" {
|
|
|
|
// load the system cert pool first -- we'll append the given CA cert to this
|
|
|
|
certPool, err := x509.SystemCertPool()
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("error fetching system CA cert pool: %s", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// open the file itself and make sure there's something in it
|
|
|
|
caCertBytes, err := os.ReadFile(c.DBConfig.TLSCACert)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("error opening CA certificate at %s: %s", c.DBConfig.TLSCACert, err)
|
|
|
|
}
|
|
|
|
if len(caCertBytes) == 0 {
|
|
|
|
return nil, fmt.Errorf("ca cert at %s was empty", c.DBConfig.TLSCACert)
|
|
|
|
}
|
|
|
|
|
|
|
|
// make sure we have a PEM block
|
|
|
|
caPem, _ := pem.Decode(caCertBytes)
|
|
|
|
if caPem == nil {
|
|
|
|
return nil, fmt.Errorf("could not parse cert at %s into PEM", c.DBConfig.TLSCACert)
|
|
|
|
}
|
|
|
|
|
|
|
|
// parse the PEM block into the certificate
|
|
|
|
caCert, err := x509.ParseCertificate(caPem.Bytes)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("could not parse cert at %s into x509 certificate: %s", c.DBConfig.TLSCACert, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// we're happy, add it to the existing pool and then use this pool in our tls config
|
|
|
|
certPool.AddCert(caCert)
|
|
|
|
tlsConfig.RootCAs = certPool
|
|
|
|
}
|
|
|
|
|
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-07-19 16:03:07 +00:00
|
|
|
TLSConfig: tlsConfig,
|
2021-03-02 17:26:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return options, nil
|
|
|
|
}
|
|
|
|
|
2021-04-19 17:42:19 +00:00
|
|
|
/*
|
|
|
|
CONVERSION FUNCTIONS
|
|
|
|
*/
|
2021-04-01 18:46:45 +00:00
|
|
|
|
2021-06-13 16:42:28 +00:00
|
|
|
// TODO: move these to the type converter, it's bananas that they're here and not there
|
|
|
|
|
2021-04-19 17:42:19 +00:00
|
|
|
func (ps *postgresService) MentionStringsToMentions(targetAccounts []string, originAccountID string, statusID string) ([]*gtsmodel.Mention, error) {
|
2021-05-21 13:48:26 +00:00
|
|
|
ogAccount := >smodel.Account{}
|
|
|
|
if err := ps.conn.Model(ogAccount).Where("id = ?", originAccountID).Select(); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2021-04-19 17:42:19 +00:00
|
|
|
menchies := []*gtsmodel.Mention{}
|
|
|
|
for _, a := range targetAccounts {
|
|
|
|
// A mentioned account looks like "@test@example.org" or just "@test" for a local account
|
|
|
|
// -- we can guarantee this from the regex that targetAccounts should have been derived from.
|
|
|
|
// But we still need to do a bit of fiddling to get what we need here -- the username and domain (if given).
|
|
|
|
|
|
|
|
// 1. trim off the first @
|
|
|
|
t := strings.TrimPrefix(a, "@")
|
|
|
|
|
|
|
|
// 2. split the username and domain
|
|
|
|
s := strings.Split(t, "@")
|
|
|
|
|
|
|
|
// 3. if it's length 1 it's a local account, length 2 means remote, anything else means something is wrong
|
|
|
|
var local bool
|
|
|
|
switch len(s) {
|
|
|
|
case 1:
|
|
|
|
local = true
|
|
|
|
case 2:
|
|
|
|
local = false
|
|
|
|
default:
|
|
|
|
return nil, fmt.Errorf("mentioned account format '%s' was not valid", a)
|
2021-04-01 18:46:45 +00:00
|
|
|
}
|
2021-04-19 17:42:19 +00:00
|
|
|
|
|
|
|
var username, domain string
|
|
|
|
username = s[0]
|
|
|
|
if !local {
|
|
|
|
domain = s[1]
|
|
|
|
}
|
|
|
|
|
|
|
|
// 4. check we now have a proper username and domain
|
|
|
|
if username == "" || (!local && domain == "") {
|
|
|
|
return nil, fmt.Errorf("username or domain for '%s' was nil", a)
|
2021-04-01 18:46:45 +00:00
|
|
|
}
|
2021-04-19 17:42:19 +00:00
|
|
|
|
|
|
|
// okay we're good now, we can start pulling accounts out of the database
|
|
|
|
mentionedAccount := >smodel.Account{}
|
|
|
|
var err error
|
2021-06-13 16:42:28 +00:00
|
|
|
|
|
|
|
// match username + account, case insensitive
|
2021-04-19 17:42:19 +00:00
|
|
|
if local {
|
|
|
|
// local user -- should have a null domain
|
2021-06-13 16:42:28 +00:00
|
|
|
err = ps.conn.Model(mentionedAccount).Where("LOWER(?) = LOWER(?)", pg.Ident("username"), username).Where("? IS NULL", pg.Ident("domain")).Select()
|
2021-04-19 17:42:19 +00:00
|
|
|
} else {
|
|
|
|
// remote user -- should have domain defined
|
2021-06-13 16:42:28 +00:00
|
|
|
err = ps.conn.Model(mentionedAccount).Where("LOWER(?) = LOWER(?)", pg.Ident("username"), username).Where("LOWER(?) = LOWER(?)", pg.Ident("domain"), domain).Select()
|
2021-04-19 17:42:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if err != nil {
|
|
|
|
if err == pg.ErrNoRows {
|
|
|
|
// no result found for this username/domain so just don't include it as a mencho and carry on about our business
|
|
|
|
ps.log.Debugf("no account found with username '%s' and domain '%s', skipping it", username, domain)
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
// a serious error has happened so bail
|
|
|
|
return nil, fmt.Errorf("error getting account with username '%s' and domain '%s': %s", username, domain, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// id, createdAt and updatedAt will be populated by the db, so we have everything we need!
|
|
|
|
menchies = append(menchies, >smodel.Mention{
|
2021-08-20 10:26:56 +00:00
|
|
|
StatusID: statusID,
|
|
|
|
OriginAccountID: ogAccount.ID,
|
|
|
|
OriginAccountURI: ogAccount.URI,
|
|
|
|
TargetAccountID: mentionedAccount.ID,
|
|
|
|
NameString: a,
|
|
|
|
TargetAccountURI: mentionedAccount.URI,
|
|
|
|
TargetAccountURL: mentionedAccount.URL,
|
|
|
|
OriginAccount: mentionedAccount,
|
2021-04-19 17:42:19 +00:00
|
|
|
})
|
2021-04-01 18:46:45 +00:00
|
|
|
}
|
2021-04-19 17:42:19 +00:00
|
|
|
return menchies, nil
|
|
|
|
}
|
2021-04-01 18:46:45 +00:00
|
|
|
|
2021-04-19 17:42:19 +00:00
|
|
|
func (ps *postgresService) TagStringsToTags(tags []string, originAccountID string, statusID string) ([]*gtsmodel.Tag, error) {
|
|
|
|
newTags := []*gtsmodel.Tag{}
|
|
|
|
for _, t := range tags {
|
|
|
|
tag := >smodel.Tag{}
|
|
|
|
// we can use selectorinsert here to create the new tag if it doesn't exist already
|
|
|
|
// inserted will be true if this is a new tag we just created
|
2021-06-13 16:42:28 +00:00
|
|
|
if err := ps.conn.Model(tag).Where("LOWER(?) = LOWER(?)", pg.Ident("name"), t).Select(); err != nil {
|
2021-04-19 17:42:19 +00:00
|
|
|
if err == pg.ErrNoRows {
|
|
|
|
// tag doesn't exist yet so populate it
|
2021-06-13 16:42:28 +00:00
|
|
|
newID, err := id.NewRandomULID()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
tag.ID = newID
|
|
|
|
tag.URL = fmt.Sprintf("%s://%s/tags/%s", ps.config.Protocol, ps.config.Host, t)
|
2021-04-19 17:42:19 +00:00
|
|
|
tag.Name = t
|
|
|
|
tag.FirstSeenFromAccountID = originAccountID
|
|
|
|
tag.CreatedAt = time.Now()
|
|
|
|
tag.UpdatedAt = time.Now()
|
|
|
|
tag.Useable = true
|
|
|
|
tag.Listable = true
|
|
|
|
} else {
|
|
|
|
return nil, fmt.Errorf("error getting tag with name %s: %s", t, err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// bail already if the tag isn't useable
|
|
|
|
if !tag.Useable {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
tag.LastStatusAt = time.Now()
|
|
|
|
newTags = append(newTags, tag)
|
|
|
|
}
|
|
|
|
return newTags, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (ps *postgresService) EmojiStringsToEmojis(emojis []string, originAccountID string, statusID string) ([]*gtsmodel.Emoji, error) {
|
|
|
|
newEmojis := []*gtsmodel.Emoji{}
|
|
|
|
for _, e := range emojis {
|
|
|
|
emoji := >smodel.Emoji{}
|
|
|
|
err := ps.conn.Model(emoji).Where("shortcode = ?", e).Where("visible_in_picker = true").Where("disabled = false").Select()
|
|
|
|
if err != nil {
|
|
|
|
if err == pg.ErrNoRows {
|
|
|
|
// no result found for this username/domain so just don't include it as an emoji and carry on about our business
|
|
|
|
ps.log.Debugf("no emoji found with shortcode %s, skipping it", e)
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
// a serious error has happened so bail
|
|
|
|
return nil, fmt.Errorf("error getting emoji with shortcode %s: %s", e, err)
|
|
|
|
}
|
|
|
|
newEmojis = append(newEmojis, emoji)
|
|
|
|
}
|
|
|
|
return newEmojis, nil
|
2021-04-01 18:46:45 +00:00
|
|
|
}
|