aboutsummaryrefslogtreecommitdiff
path: root/roomserver/storage/postgres
diff options
context:
space:
mode:
authorNeil <neilalexanderr@gmail.com>2023-01-19 20:02:32 +0000
committerGitHub <noreply@github.com>2023-01-19 21:02:32 +0100
commit738686ae686004c5efa9fe2096502cdc426c6dd8 (patch)
treee5c8e31aea47167be61aa326982ad9db1a00c15e /roomserver/storage/postgres
parent67f5c5bc1e837bbdee14d7d3388984ed8960528a (diff)
Add `/_dendrite/admin/purgeRoom/{roomID}` (#2662)
This adds a new admin endpoint `/_dendrite/admin/purgeRoom/{roomID}`. It completely erases all database entries for a given room ID. The roomserver will start by clearing all data for that room and then will generate an output event to notify downstream components (i.e. the sync API and federation API) to do the same. It does not currently clear media and it is currently not implemented for SQLite since it relies on SQL array operations right now. Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com> Co-authored-by: Till Faelligen <2353100+S7evinK@users.noreply.github.com>
Diffstat (limited to 'roomserver/storage/postgres')
-rw-r--r--roomserver/storage/postgres/purge_statements.go133
-rw-r--r--roomserver/storage/postgres/rooms_table.go14
-rw-r--r--roomserver/storage/postgres/storage.go5
3 files changed, 152 insertions, 0 deletions
diff --git a/roomserver/storage/postgres/purge_statements.go b/roomserver/storage/postgres/purge_statements.go
new file mode 100644
index 00000000..efba439b
--- /dev/null
+++ b/roomserver/storage/postgres/purge_statements.go
@@ -0,0 +1,133 @@
+// Copyright 2022 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"
+
+ "github.com/matrix-org/dendrite/internal/sqlutil"
+ "github.com/matrix-org/dendrite/roomserver/types"
+)
+
+const purgeEventJSONSQL = "" +
+ "DELETE FROM roomserver_event_json WHERE event_nid = ANY(" +
+ " SELECT event_nid FROM roomserver_events WHERE room_nid = $1" +
+ ")"
+
+const purgeEventsSQL = "" +
+ "DELETE FROM roomserver_events WHERE room_nid = $1"
+
+const purgeInvitesSQL = "" +
+ "DELETE FROM roomserver_invites WHERE room_nid = $1"
+
+const purgeMembershipsSQL = "" +
+ "DELETE FROM roomserver_membership WHERE room_nid = $1"
+
+const purgePreviousEventsSQL = "" +
+ "DELETE FROM roomserver_previous_events WHERE event_nids && ANY(" +
+ " SELECT ARRAY_AGG(event_nid) FROM roomserver_events WHERE room_nid = $1" +
+ ")"
+
+const purgePublishedSQL = "" +
+ "DELETE FROM roomserver_published WHERE room_id = $1"
+
+const purgeRedactionsSQL = "" +
+ "DELETE FROM roomserver_redactions WHERE redaction_event_id = ANY(" +
+ " SELECT event_id FROM roomserver_events WHERE room_nid = $1" +
+ ")"
+
+const purgeRoomAliasesSQL = "" +
+ "DELETE FROM roomserver_room_aliases WHERE room_id = $1"
+
+const purgeRoomSQL = "" +
+ "DELETE FROM roomserver_rooms WHERE room_nid = $1"
+
+const purgeStateBlockEntriesSQL = "" +
+ "DELETE FROM roomserver_state_block WHERE state_block_nid = ANY(" +
+ " SELECT DISTINCT UNNEST(state_block_nids) FROM roomserver_state_snapshots WHERE room_nid = $1" +
+ ")"
+
+const purgeStateSnapshotEntriesSQL = "" +
+ "DELETE FROM roomserver_state_snapshots WHERE room_nid = $1"
+
+type purgeStatements struct {
+ purgeEventJSONStmt *sql.Stmt
+ purgeEventsStmt *sql.Stmt
+ purgeInvitesStmt *sql.Stmt
+ purgeMembershipsStmt *sql.Stmt
+ purgePreviousEventsStmt *sql.Stmt
+ purgePublishedStmt *sql.Stmt
+ purgeRedactionStmt *sql.Stmt
+ purgeRoomAliasesStmt *sql.Stmt
+ purgeRoomStmt *sql.Stmt
+ purgeStateBlockEntriesStmt *sql.Stmt
+ purgeStateSnapshotEntriesStmt *sql.Stmt
+}
+
+func PreparePurgeStatements(db *sql.DB) (*purgeStatements, error) {
+ s := &purgeStatements{}
+
+ return s, sqlutil.StatementList{
+ {&s.purgeEventJSONStmt, purgeEventJSONSQL},
+ {&s.purgeEventsStmt, purgeEventsSQL},
+ {&s.purgeInvitesStmt, purgeInvitesSQL},
+ {&s.purgeMembershipsStmt, purgeMembershipsSQL},
+ {&s.purgePublishedStmt, purgePublishedSQL},
+ {&s.purgePreviousEventsStmt, purgePreviousEventsSQL},
+ {&s.purgeRedactionStmt, purgeRedactionsSQL},
+ {&s.purgeRoomAliasesStmt, purgeRoomAliasesSQL},
+ {&s.purgeRoomStmt, purgeRoomSQL},
+ {&s.purgeStateBlockEntriesStmt, purgeStateBlockEntriesSQL},
+ {&s.purgeStateSnapshotEntriesStmt, purgeStateSnapshotEntriesSQL},
+ }.Prepare(db)
+}
+
+func (s *purgeStatements) PurgeRoom(
+ ctx context.Context, txn *sql.Tx, roomNID types.RoomNID, roomID string,
+) error {
+
+ // purge by roomID
+ purgeByRoomID := []*sql.Stmt{
+ s.purgeRoomAliasesStmt,
+ s.purgePublishedStmt,
+ }
+ for _, stmt := range purgeByRoomID {
+ _, err := sqlutil.TxStmt(txn, stmt).ExecContext(ctx, roomID)
+ if err != nil {
+ return err
+ }
+ }
+
+ // purge by roomNID
+ purgeByRoomNID := []*sql.Stmt{
+ s.purgeStateBlockEntriesStmt,
+ s.purgeStateSnapshotEntriesStmt,
+ s.purgeInvitesStmt,
+ s.purgeMembershipsStmt,
+ s.purgePreviousEventsStmt,
+ s.purgeEventJSONStmt,
+ s.purgeRedactionStmt,
+ s.purgeEventsStmt,
+ s.purgeRoomStmt,
+ }
+ for _, stmt := range purgeByRoomNID {
+ _, err := sqlutil.TxStmt(txn, stmt).ExecContext(ctx, roomNID)
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
diff --git a/roomserver/storage/postgres/rooms_table.go b/roomserver/storage/postgres/rooms_table.go
index 99439953..c8346733 100644
--- a/roomserver/storage/postgres/rooms_table.go
+++ b/roomserver/storage/postgres/rooms_table.go
@@ -58,6 +58,9 @@ const insertRoomNIDSQL = "" +
const selectRoomNIDSQL = "" +
"SELECT room_nid FROM roomserver_rooms WHERE room_id = $1"
+const selectRoomNIDForUpdateSQL = "" +
+ "SELECT room_nid FROM roomserver_rooms WHERE room_id = $1 FOR UPDATE"
+
const selectLatestEventNIDsSQL = "" +
"SELECT latest_event_nids, state_snapshot_nid FROM roomserver_rooms WHERE room_nid = $1"
@@ -85,6 +88,7 @@ const bulkSelectRoomNIDsSQL = "" +
type roomStatements struct {
insertRoomNIDStmt *sql.Stmt
selectRoomNIDStmt *sql.Stmt
+ selectRoomNIDForUpdateStmt *sql.Stmt
selectLatestEventNIDsStmt *sql.Stmt
selectLatestEventNIDsForUpdateStmt *sql.Stmt
updateLatestEventNIDsStmt *sql.Stmt
@@ -106,6 +110,7 @@ func PrepareRoomsTable(db *sql.DB) (tables.Rooms, error) {
return s, sqlutil.StatementList{
{&s.insertRoomNIDStmt, insertRoomNIDSQL},
{&s.selectRoomNIDStmt, selectRoomNIDSQL},
+ {&s.selectRoomNIDForUpdateStmt, selectRoomNIDForUpdateSQL},
{&s.selectLatestEventNIDsStmt, selectLatestEventNIDsSQL},
{&s.selectLatestEventNIDsForUpdateStmt, selectLatestEventNIDsForUpdateSQL},
{&s.updateLatestEventNIDsStmt, updateLatestEventNIDsSQL},
@@ -169,6 +174,15 @@ func (s *roomStatements) SelectRoomNID(
return types.RoomNID(roomNID), err
}
+func (s *roomStatements) SelectRoomNIDForUpdate(
+ ctx context.Context, txn *sql.Tx, roomID string,
+) (types.RoomNID, error) {
+ var roomNID int64
+ stmt := sqlutil.TxStmt(txn, s.selectRoomNIDForUpdateStmt)
+ err := stmt.QueryRowContext(ctx, roomID).Scan(&roomNID)
+ return types.RoomNID(roomNID), err
+}
+
func (s *roomStatements) SelectLatestEventNIDs(
ctx context.Context, txn *sql.Tx, roomNID types.RoomNID,
) ([]types.EventNID, types.StateSnapshotNID, error) {
diff --git a/roomserver/storage/postgres/storage.go b/roomserver/storage/postgres/storage.go
index 23a5f79e..87208438 100644
--- a/roomserver/storage/postgres/storage.go
+++ b/roomserver/storage/postgres/storage.go
@@ -189,6 +189,10 @@ func (d *Database) prepare(db *sql.DB, writer sqlutil.Writer, cache caching.Room
if err != nil {
return err
}
+ purge, err := PreparePurgeStatements(db)
+ if err != nil {
+ return err
+ }
d.Database = shared.Database{
DB: db,
Cache: cache,
@@ -206,6 +210,7 @@ func (d *Database) prepare(db *sql.DB, writer sqlutil.Writer, cache caching.Room
MembershipTable: membership,
PublishedTable: published,
RedactionsTable: redactions,
+ Purge: purge,
}
return nil
}
generated by cgit v1.2.3 (git 2.26.2) at 2025-03-18 15:24:24 +0000