307 lines
12 KiB
Go
307 lines
12 KiB
Go
// 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 postgres
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
|
|
"github.com/lib/pq"
|
|
"github.com/matrix-org/dendrite/internal"
|
|
"github.com/matrix-org/dendrite/internal/sqlutil"
|
|
"github.com/matrix-org/dendrite/roomserver/storage/shared"
|
|
"github.com/matrix-org/dendrite/roomserver/storage/tables"
|
|
"github.com/matrix-org/dendrite/roomserver/types"
|
|
)
|
|
|
|
const membershipSchema = `
|
|
-- The membership table is used to coordinate updates between the invite table
|
|
-- and the room state tables.
|
|
-- This table is updated in one of 3 ways:
|
|
-- 1) The membership of a user changes within the current state of the room.
|
|
-- 2) An invite is received outside of a room over federation.
|
|
-- 3) An invite is rejected outside of a room over federation.
|
|
CREATE TABLE IF NOT EXISTS roomserver_membership (
|
|
room_nid BIGINT NOT NULL,
|
|
-- Numeric state key ID for the user ID this state is for.
|
|
target_nid BIGINT NOT NULL,
|
|
-- Numeric state key ID for the user ID who changed the state.
|
|
-- This may be 0 since it is not always possible to identify the user that
|
|
-- changed the state.
|
|
sender_nid BIGINT NOT NULL DEFAULT 0,
|
|
-- The state the user is in within this room.
|
|
-- Default value is "membershipStateLeaveOrBan"
|
|
membership_nid BIGINT NOT NULL DEFAULT 1,
|
|
-- The numeric ID of the membership event.
|
|
-- It refers to the join membership event if the membership_nid is join (3),
|
|
-- and to the leave/ban membership event if the membership_nid is leave or
|
|
-- ban (1).
|
|
-- If the membership_nid is invite (2) and the user has been in the room
|
|
-- before, it will refer to the previous leave/ban membership event, and will
|
|
-- be equals to 0 (its default) if the user never joined the room before.
|
|
-- This NID is updated if the join event gets updated (e.g. profile update),
|
|
-- or if the user leaves/joins the room.
|
|
event_nid BIGINT NOT NULL DEFAULT 0,
|
|
-- Local target is true if the target_nid refers to a local user rather than
|
|
-- a federated one. This is an optimisation for resetting state on federated
|
|
-- room joins.
|
|
target_local BOOLEAN NOT NULL DEFAULT false,
|
|
UNIQUE (room_nid, target_nid)
|
|
);
|
|
`
|
|
|
|
var selectJoinedUsersSetForRoomsSQL = "" +
|
|
"SELECT target_nid, COUNT(room_nid) FROM roomserver_membership WHERE room_nid = ANY($1) AND" +
|
|
" membership_nid = " + fmt.Sprintf("%d", tables.MembershipStateJoin) + " GROUP BY target_nid"
|
|
|
|
// Insert a row in to membership table so that it can be locked by the
|
|
// SELECT FOR UPDATE
|
|
const insertMembershipSQL = "" +
|
|
"INSERT INTO roomserver_membership (room_nid, target_nid, target_local)" +
|
|
" VALUES ($1, $2, $3)" +
|
|
" ON CONFLICT DO NOTHING"
|
|
|
|
const selectMembershipFromRoomAndTargetSQL = "" +
|
|
"SELECT membership_nid, event_nid FROM roomserver_membership" +
|
|
" WHERE room_nid = $1 AND target_nid = $2"
|
|
|
|
const selectMembershipsFromRoomAndMembershipSQL = "" +
|
|
"SELECT event_nid FROM roomserver_membership" +
|
|
" WHERE room_nid = $1 AND membership_nid = $2"
|
|
|
|
const selectLocalMembershipsFromRoomAndMembershipSQL = "" +
|
|
"SELECT event_nid FROM roomserver_membership" +
|
|
" WHERE room_nid = $1 AND membership_nid = $2" +
|
|
" AND target_local = true"
|
|
|
|
const selectMembershipsFromRoomSQL = "" +
|
|
"SELECT event_nid FROM roomserver_membership" +
|
|
" WHERE room_nid = $1"
|
|
|
|
const selectLocalMembershipsFromRoomSQL = "" +
|
|
"SELECT event_nid FROM roomserver_membership" +
|
|
" WHERE room_nid = $1" +
|
|
" AND target_local = true"
|
|
|
|
const selectMembershipForUpdateSQL = "" +
|
|
"SELECT membership_nid FROM roomserver_membership" +
|
|
" WHERE room_nid = $1 AND target_nid = $2 FOR UPDATE"
|
|
|
|
const updateMembershipSQL = "" +
|
|
"UPDATE roomserver_membership SET sender_nid = $3, membership_nid = $4, event_nid = $5" +
|
|
" WHERE room_nid = $1 AND target_nid = $2"
|
|
|
|
const selectRoomsWithMembershipSQL = "" +
|
|
"SELECT room_nid FROM roomserver_membership WHERE membership_nid = $1 AND target_nid = $2"
|
|
|
|
// selectKnownUsersSQL uses a sub-select statement here to find rooms that the user is
|
|
// joined to. Since this information is used to populate the user directory, we will
|
|
// only return users that the user would ordinarily be able to see anyway.
|
|
var selectKnownUsersSQL = "" +
|
|
"SELECT DISTINCT event_state_key FROM roomserver_membership INNER JOIN roomserver_event_state_keys ON " +
|
|
"roomserver_membership.target_nid = roomserver_event_state_keys.event_state_key_nid" +
|
|
" WHERE room_nid = ANY(" +
|
|
" SELECT DISTINCT room_nid FROM roomserver_membership WHERE target_nid=$1 AND membership_nid = " + fmt.Sprintf("%d", tables.MembershipStateJoin) +
|
|
") AND membership_nid = " + fmt.Sprintf("%d", tables.MembershipStateJoin) + " AND event_state_key LIKE $2 LIMIT $3"
|
|
|
|
type membershipStatements struct {
|
|
insertMembershipStmt *sql.Stmt
|
|
selectMembershipForUpdateStmt *sql.Stmt
|
|
selectMembershipFromRoomAndTargetStmt *sql.Stmt
|
|
selectMembershipsFromRoomAndMembershipStmt *sql.Stmt
|
|
selectLocalMembershipsFromRoomAndMembershipStmt *sql.Stmt
|
|
selectMembershipsFromRoomStmt *sql.Stmt
|
|
selectLocalMembershipsFromRoomStmt *sql.Stmt
|
|
updateMembershipStmt *sql.Stmt
|
|
selectRoomsWithMembershipStmt *sql.Stmt
|
|
selectJoinedUsersSetForRoomsStmt *sql.Stmt
|
|
selectKnownUsersStmt *sql.Stmt
|
|
}
|
|
|
|
func NewPostgresMembershipTable(db *sql.DB) (tables.Membership, error) {
|
|
s := &membershipStatements{}
|
|
_, err := db.Exec(membershipSchema)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return s, shared.StatementList{
|
|
{&s.insertMembershipStmt, insertMembershipSQL},
|
|
{&s.selectMembershipForUpdateStmt, selectMembershipForUpdateSQL},
|
|
{&s.selectMembershipFromRoomAndTargetStmt, selectMembershipFromRoomAndTargetSQL},
|
|
{&s.selectMembershipsFromRoomAndMembershipStmt, selectMembershipsFromRoomAndMembershipSQL},
|
|
{&s.selectLocalMembershipsFromRoomAndMembershipStmt, selectLocalMembershipsFromRoomAndMembershipSQL},
|
|
{&s.selectMembershipsFromRoomStmt, selectMembershipsFromRoomSQL},
|
|
{&s.selectLocalMembershipsFromRoomStmt, selectLocalMembershipsFromRoomSQL},
|
|
{&s.updateMembershipStmt, updateMembershipSQL},
|
|
{&s.selectRoomsWithMembershipStmt, selectRoomsWithMembershipSQL},
|
|
{&s.selectJoinedUsersSetForRoomsStmt, selectJoinedUsersSetForRoomsSQL},
|
|
{&s.selectKnownUsersStmt, selectKnownUsersSQL},
|
|
}.Prepare(db)
|
|
}
|
|
|
|
func (s *membershipStatements) InsertMembership(
|
|
ctx context.Context,
|
|
txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID,
|
|
localTarget bool,
|
|
) error {
|
|
stmt := sqlutil.TxStmt(txn, s.insertMembershipStmt)
|
|
_, err := stmt.ExecContext(ctx, roomNID, targetUserNID, localTarget)
|
|
return err
|
|
}
|
|
|
|
func (s *membershipStatements) SelectMembershipForUpdate(
|
|
ctx context.Context,
|
|
txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID,
|
|
) (membership tables.MembershipState, err error) {
|
|
err = sqlutil.TxStmt(txn, s.selectMembershipForUpdateStmt).QueryRowContext(
|
|
ctx, roomNID, targetUserNID,
|
|
).Scan(&membership)
|
|
return
|
|
}
|
|
|
|
func (s *membershipStatements) SelectMembershipFromRoomAndTarget(
|
|
ctx context.Context,
|
|
roomNID types.RoomNID, targetUserNID types.EventStateKeyNID,
|
|
) (eventNID types.EventNID, membership tables.MembershipState, err error) {
|
|
err = s.selectMembershipFromRoomAndTargetStmt.QueryRowContext(
|
|
ctx, roomNID, targetUserNID,
|
|
).Scan(&membership, &eventNID)
|
|
return
|
|
}
|
|
|
|
func (s *membershipStatements) SelectMembershipsFromRoom(
|
|
ctx context.Context, roomNID types.RoomNID, localOnly bool,
|
|
) (eventNIDs []types.EventNID, err error) {
|
|
var stmt *sql.Stmt
|
|
if localOnly {
|
|
stmt = s.selectLocalMembershipsFromRoomStmt
|
|
} else {
|
|
stmt = s.selectMembershipsFromRoomStmt
|
|
}
|
|
rows, err := stmt.QueryContext(ctx, roomNID)
|
|
if err != nil {
|
|
return
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "selectMembershipsFromRoom: rows.close() failed")
|
|
|
|
for rows.Next() {
|
|
var eNID types.EventNID
|
|
if err = rows.Scan(&eNID); err != nil {
|
|
return
|
|
}
|
|
eventNIDs = append(eventNIDs, eNID)
|
|
}
|
|
return eventNIDs, rows.Err()
|
|
}
|
|
|
|
func (s *membershipStatements) SelectMembershipsFromRoomAndMembership(
|
|
ctx context.Context,
|
|
roomNID types.RoomNID, membership tables.MembershipState, localOnly bool,
|
|
) (eventNIDs []types.EventNID, err error) {
|
|
var rows *sql.Rows
|
|
var stmt *sql.Stmt
|
|
if localOnly {
|
|
stmt = s.selectLocalMembershipsFromRoomAndMembershipStmt
|
|
} else {
|
|
stmt = s.selectMembershipsFromRoomAndMembershipStmt
|
|
}
|
|
rows, err = stmt.QueryContext(ctx, roomNID, membership)
|
|
if err != nil {
|
|
return
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "selectMembershipsFromRoomAndMembership: rows.close() failed")
|
|
|
|
for rows.Next() {
|
|
var eNID types.EventNID
|
|
if err = rows.Scan(&eNID); err != nil {
|
|
return
|
|
}
|
|
eventNIDs = append(eventNIDs, eNID)
|
|
}
|
|
return eventNIDs, rows.Err()
|
|
}
|
|
|
|
func (s *membershipStatements) UpdateMembership(
|
|
ctx context.Context,
|
|
txn *sql.Tx, roomNID types.RoomNID, targetUserNID types.EventStateKeyNID,
|
|
senderUserNID types.EventStateKeyNID, membership tables.MembershipState,
|
|
eventNID types.EventNID,
|
|
) error {
|
|
_, err := sqlutil.TxStmt(txn, s.updateMembershipStmt).ExecContext(
|
|
ctx, roomNID, targetUserNID, senderUserNID, membership, eventNID,
|
|
)
|
|
return err
|
|
}
|
|
|
|
func (s *membershipStatements) SelectRoomsWithMembership(
|
|
ctx context.Context, userID types.EventStateKeyNID, membershipState tables.MembershipState,
|
|
) ([]types.RoomNID, error) {
|
|
rows, err := s.selectRoomsWithMembershipStmt.QueryContext(ctx, membershipState, userID)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "SelectRoomsWithMembership: rows.close() failed")
|
|
var roomNIDs []types.RoomNID
|
|
for rows.Next() {
|
|
var roomNID types.RoomNID
|
|
if err := rows.Scan(&roomNID); err != nil {
|
|
return nil, err
|
|
}
|
|
roomNIDs = append(roomNIDs, roomNID)
|
|
}
|
|
return roomNIDs, nil
|
|
}
|
|
|
|
func (s *membershipStatements) SelectJoinedUsersSetForRooms(ctx context.Context, roomNIDs []types.RoomNID) (map[types.EventStateKeyNID]int, error) {
|
|
roomIDarray := make([]int64, len(roomNIDs))
|
|
for i := range roomNIDs {
|
|
roomIDarray[i] = int64(roomNIDs[i])
|
|
}
|
|
rows, err := s.selectJoinedUsersSetForRoomsStmt.QueryContext(ctx, pq.Int64Array(roomIDarray))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "selectJoinedUsersSetForRooms: rows.close() failed")
|
|
result := make(map[types.EventStateKeyNID]int)
|
|
for rows.Next() {
|
|
var userID types.EventStateKeyNID
|
|
var count int
|
|
if err := rows.Scan(&userID, &count); err != nil {
|
|
return nil, err
|
|
}
|
|
result[userID] = count
|
|
}
|
|
return result, rows.Err()
|
|
}
|
|
|
|
func (s *membershipStatements) SelectKnownUsers(ctx context.Context, userID types.EventStateKeyNID, searchString string, limit int) ([]string, error) {
|
|
rows, err := s.selectKnownUsersStmt.QueryContext(ctx, userID, fmt.Sprintf("%%%s%%", searchString), limit)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
result := []string{}
|
|
defer internal.CloseAndLogIfError(ctx, rows, "SelectKnownUsers: rows.close() failed")
|
|
for rows.Next() {
|
|
var userID string
|
|
if err := rows.Scan(&userID); err != nil {
|
|
return nil, err
|
|
}
|
|
result = append(result, userID)
|
|
}
|
|
return result, rows.Err()
|
|
}
|