2020-02-13 17:27:33 +00:00
|
|
|
// Copyright 2017-2018 New Vector Ltd
|
|
|
|
// Copyright 2019-2020 The Matrix.org Foundation C.I.C.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
package sqlite3
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"database/sql"
|
|
|
|
|
2020-08-25 11:32:29 +00:00
|
|
|
"github.com/matrix-org/dendrite/internal/caching"
|
2020-04-16 09:06:55 +00:00
|
|
|
"github.com/matrix-org/dendrite/internal/sqlutil"
|
2020-05-26 14:42:42 +00:00
|
|
|
"github.com/matrix-org/dendrite/roomserver/storage/shared"
|
2020-11-05 10:19:23 +00:00
|
|
|
"github.com/matrix-org/dendrite/roomserver/storage/sqlite3/deltas"
|
2020-02-13 17:27:33 +00:00
|
|
|
"github.com/matrix-org/dendrite/roomserver/types"
|
2020-12-02 17:41:00 +00:00
|
|
|
"github.com/matrix-org/dendrite/setup/config"
|
2020-02-13 17:27:33 +00:00
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
|
|
)
|
|
|
|
|
|
|
|
// A Database is used to store room events and stream offsets.
|
|
|
|
type Database struct {
|
2020-05-26 14:42:42 +00:00
|
|
|
shared.Database
|
2020-02-13 17:27:33 +00:00
|
|
|
}
|
|
|
|
|
2020-05-01 12:34:53 +00:00
|
|
|
// Open a sqlite database.
|
2020-08-25 11:32:29 +00:00
|
|
|
func Open(dbProperties *config.DatabaseOptions, cache caching.RoomServerCaches) (*Database, error) {
|
2020-02-13 17:27:33 +00:00
|
|
|
var d Database
|
2020-11-05 10:19:23 +00:00
|
|
|
var db *sql.DB
|
2020-08-10 13:18:04 +00:00
|
|
|
var err error
|
2020-11-05 10:19:23 +00:00
|
|
|
if db, err = sqlutil.Open(dbProperties); err != nil {
|
2020-02-13 17:27:33 +00:00
|
|
|
return nil, err
|
|
|
|
}
|
2020-11-05 10:19:23 +00:00
|
|
|
|
|
|
|
//db.Exec("PRAGMA journal_mode=WAL;")
|
|
|
|
//db.Exec("PRAGMA read_uncommitted = true;")
|
2020-02-20 09:28:03 +00:00
|
|
|
|
|
|
|
// FIXME: We are leaking connections somewhere. Setting this to 2 will eventually
|
|
|
|
// cause the roomserver to be unresponsive to new events because something will
|
|
|
|
// acquire the global mutex and never unlock it because it is waiting for a connection
|
|
|
|
// which it will never obtain.
|
2020-11-05 10:19:23 +00:00
|
|
|
db.SetMaxOpenConns(20)
|
2020-05-27 10:03:47 +00:00
|
|
|
|
2021-04-26 12:25:57 +00:00
|
|
|
// Create the tables.
|
|
|
|
if err := d.create(db); err != nil {
|
2020-05-26 14:42:42 +00:00
|
|
|
return nil, err
|
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
|
|
|
|
// Then execute the migrations. By this point the tables are created with the latest
|
|
|
|
// schemas.
|
2020-11-05 10:19:23 +00:00
|
|
|
m := sqlutil.NewMigrations()
|
|
|
|
deltas.LoadAddForgottenColumn(m)
|
2021-04-26 12:25:57 +00:00
|
|
|
deltas.LoadStateBlocksRefactor(m)
|
2020-11-05 10:19:23 +00:00
|
|
|
if err := m.RunDeltas(db, dbProperties); err != nil {
|
2020-05-26 14:42:42 +00:00
|
|
|
return nil, err
|
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
|
|
|
|
// Then prepare the statements. Now that the migrations have run, any columns referred
|
|
|
|
// to in the database code should now exist.
|
2020-11-05 10:19:23 +00:00
|
|
|
if err := d.prepare(db, cache); err != nil {
|
2020-05-26 15:45:28 +00:00
|
|
|
return nil, err
|
|
|
|
}
|
2020-11-05 10:19:23 +00:00
|
|
|
|
|
|
|
return &d, nil
|
|
|
|
}
|
|
|
|
|
2021-04-26 12:25:57 +00:00
|
|
|
func (d *Database) create(db *sql.DB) error {
|
|
|
|
if err := createEventStateKeysTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createEventTypesTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createEventJSONTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createEventsTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createRoomsTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createTransactionsTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createStateBlockTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createStateSnapshotTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createPrevEventsTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createRoomAliasesTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createInvitesTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createMembershipTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createPublishedTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := createRedactionsTable(db); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2020-11-05 10:19:23 +00:00
|
|
|
func (d *Database) prepare(db *sql.DB, cache caching.RoomServerCaches) error {
|
2021-04-26 12:25:57 +00:00
|
|
|
eventStateKeys, err := prepareEventStateKeysTable(db)
|
2020-05-26 15:45:28 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-26 15:45:28 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
eventTypes, err := prepareEventTypesTable(db)
|
2020-05-26 17:23:39 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-26 17:23:39 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
eventJSON, err := prepareEventJSONTable(db)
|
2020-05-26 17:23:39 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-26 17:23:39 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
events, err := prepareEventsTable(db)
|
2020-05-27 08:36:09 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-27 08:36:09 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
rooms, err := prepareRoomsTable(db)
|
2020-05-27 08:36:09 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-27 08:36:09 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
transactions, err := prepareTransactionsTable(db)
|
2020-05-27 08:36:09 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-27 08:36:09 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
stateBlock, err := prepareStateBlockTable(db)
|
2020-05-27 08:36:09 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-27 08:36:09 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
stateSnapshot, err := prepareStateSnapshotTable(db)
|
2020-05-27 10:03:47 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-27 10:03:47 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
prevEvents, err := preparePrevEventsTable(db)
|
2020-05-27 10:03:47 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-05-27 10:03:47 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
roomAliases, err := prepareRoomAliasesTable(db)
|
2020-07-02 14:41:18 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
2020-07-02 14:41:18 +00:00
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
invites, err := prepareInvitesTable(db)
|
2020-07-06 16:49:15 +00:00
|
|
|
if err != nil {
|
2020-11-05 10:19:23 +00:00
|
|
|
return err
|
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
membership, err := prepareMembershipTable(db)
|
2020-11-05 10:19:23 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
published, err := preparePublishedTable(db)
|
2020-11-05 10:19:23 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2021-04-26 12:25:57 +00:00
|
|
|
redactions, err := prepareRedactionsTable(db)
|
2020-11-05 10:19:23 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
2020-07-06 16:49:15 +00:00
|
|
|
}
|
2020-05-26 14:42:42 +00:00
|
|
|
d.Database = shared.Database{
|
2020-11-05 10:19:23 +00:00
|
|
|
DB: db,
|
2020-10-20 18:32:33 +00:00
|
|
|
Cache: cache,
|
2020-11-05 10:19:23 +00:00
|
|
|
Writer: sqlutil.NewExclusiveWriter(),
|
|
|
|
EventsTable: events,
|
|
|
|
EventTypesTable: eventTypes,
|
|
|
|
EventStateKeysTable: eventStateKeys,
|
|
|
|
EventJSONTable: eventJSON,
|
|
|
|
RoomsTable: rooms,
|
|
|
|
TransactionsTable: transactions,
|
2020-10-20 18:32:33 +00:00
|
|
|
StateBlockTable: stateBlock,
|
|
|
|
StateSnapshotTable: stateSnapshot,
|
2020-11-05 10:19:23 +00:00
|
|
|
PrevEventsTable: prevEvents,
|
2020-10-20 18:32:33 +00:00
|
|
|
RoomAliasesTable: roomAliases,
|
2020-11-05 10:19:23 +00:00
|
|
|
InvitesTable: invites,
|
|
|
|
MembershipTable: membership,
|
2020-10-20 18:32:33 +00:00
|
|
|
PublishedTable: published,
|
|
|
|
RedactionsTable: redactions,
|
|
|
|
GetLatestEventsForUpdateFn: d.GetLatestEventsForUpdate,
|
2020-05-26 14:42:42 +00:00
|
|
|
}
|
2020-11-05 10:19:23 +00:00
|
|
|
return nil
|
2020-02-13 17:27:33 +00:00
|
|
|
}
|
|
|
|
|
2020-08-20 15:24:33 +00:00
|
|
|
func (d *Database) SupportsConcurrentRoomInputs() bool {
|
|
|
|
// This isn't supported in SQLite mode yet because of issues with
|
|
|
|
// database locks.
|
|
|
|
// TODO: Look at this again - the problem is probably to do with
|
|
|
|
// the membership updaters and latest events updaters.
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2020-02-13 17:27:33 +00:00
|
|
|
func (d *Database) GetLatestEventsForUpdate(
|
2020-09-02 09:02:48 +00:00
|
|
|
ctx context.Context, roomInfo types.RoomInfo,
|
2020-08-19 12:24:54 +00:00
|
|
|
) (*shared.LatestEventsUpdater, error) {
|
2020-05-28 10:15:21 +00:00
|
|
|
// TODO: Do not use transactions. We should be holding open this transaction but we cannot have
|
|
|
|
// multiple write transactions on sqlite. The code will perform additional
|
|
|
|
// write transactions independent of this one which will consistently cause
|
|
|
|
// 'database is locked' errors. As sqlite doesn't support multi-process on the
|
|
|
|
// same DB anyway, and we only execute updates sequentially, the only worries
|
|
|
|
// are for rolling back when things go wrong. (atomicity)
|
2020-09-02 09:02:48 +00:00
|
|
|
return shared.NewLatestEventsUpdater(ctx, &d.Database, nil, roomInfo)
|
2020-04-03 13:29:06 +00:00
|
|
|
}
|
|
|
|
|
2020-02-13 17:27:33 +00:00
|
|
|
func (d *Database) MembershipUpdater(
|
|
|
|
ctx context.Context, roomID, targetUserID string,
|
2020-05-20 17:03:06 +00:00
|
|
|
targetLocal bool, roomVersion gomatrixserverlib.RoomVersion,
|
2020-08-19 12:24:54 +00:00
|
|
|
) (*shared.MembershipUpdater, error) {
|
2020-05-28 10:15:21 +00:00
|
|
|
// TODO: Do not use transactions. We should be holding open this transaction but we cannot have
|
|
|
|
// multiple write transactions on sqlite. The code will perform additional
|
|
|
|
// write transactions independent of this one which will consistently cause
|
|
|
|
// 'database is locked' errors. As sqlite doesn't support multi-process on the
|
|
|
|
// same DB anyway, and we only execute updates sequentially, the only worries
|
|
|
|
// are for rolling back when things go wrong. (atomicity)
|
2020-08-19 12:24:54 +00:00
|
|
|
return shared.NewMembershipUpdater(ctx, &d.Database, nil, roomID, targetUserID, targetLocal, roomVersion)
|
2020-02-13 17:27:33 +00:00
|
|
|
}
|