Initial storage for Implementation of push notification

userapi/storage/pushers/interface.go

@@ -0,0 +1,25 @@
+// Copyright 2021 Dan Peleg <dan@globekeeper.com>
+//
+// 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 pushers
+
+import (
+	"context"
+
+	"github.com/matrix-org/dendrite/userapi/api"
+)
+
+type Database interface {
+	GetPushersByLocalpart(ctx context.Context, localpart string) ([]api.Pusher, error)
+}

userapi/storage/pushers/postgres/pushers_table.go

@@ -0,0 +1,128 @@
+// Copyright 2021 Dan Peleg <dan@globekeeper.com>
+//
+// 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/clientapi/userutil"
+	"github.com/matrix-org/dendrite/internal"
+	"github.com/matrix-org/dendrite/internal/sqlutil"
+	"github.com/matrix-org/dendrite/userapi/api"
+	"github.com/matrix-org/gomatrixserverlib"
+)
+
+const pushersSchema = `
+-- Stores data about pushers.
+CREATE TABLE IF NOT EXISTS pusher_pushers (
+	-- The Matrix user ID localpart for this pusher
+	localpart TEXT NOT NULL PRIMARY KEY,
+	-- The push key for this pusher
+	pushkey TEXT,
+	-- The pusher kind
+	kind TEXT,
+	-- The pusher Application ID
+	app_id TEXT,
+	-- The pusher application display name, human friendlier than app_id and updatable
+	app_display_name TEXT,
+	-- The pusher device display name,
+	device_display_name TEXT,
+	-- The pusher profile tag,
+	profile_tag TEXT,
+	-- The pusher preferred language,
+	language TEXT,
+);
+
+-- Pusher IDs must be unique for a given user.
+CREATE UNIQUE INDEX IF NOT EXISTS pusher_localpart_id_idx ON pusher_pushers(localpart, pusher_id);
+`
+
+const selectPushersByLocalpartSQL = "" +
+	"SELECT pusher_id, display_name, last_seen_ts, ip, user_agent FROM pusher_pushers WHERE localpart = $1 AND pusher_id != $2"
+
+type pushersStatements struct {
+	selectPushersByLocalpartStmt *sql.Stmt
+	serverName                   gomatrixserverlib.ServerName
+}
+
+func (s *pushersStatements) execSchema(db *sql.DB) error {
+	_, err := db.Exec(pushersSchema)
+	return err
+}
+
+func (s *pushersStatements) prepare(db *sql.DB, server gomatrixserverlib.ServerName) (err error) {
+	if s.selectPushersByLocalpartStmt, err = db.Prepare(selectPushersByLocalpartSQL); err != nil {
+		return
+	}
+	s.serverName = server
+	return
+}
+
+func (s *pushersStatements) selectPushersByLocalpart(
+	ctx context.Context, txn *sql.Tx, localpart, exceptPusherID string,
+) ([]api.Pusher, error) {
+	pushers := []api.Pusher{}
+	rows, err := sqlutil.TxStmt(txn, s.selectPushersByLocalpartStmt).QueryContext(ctx, localpart, exceptPusherID)
+
+	if err != nil {
+		return pushers, err
+	}
+	defer internal.CloseAndLogIfError(ctx, rows, "selectPushersByLocalpart: rows.close() failed")
+
+	for rows.Next() {
+		var pusher api.Pusher
+		var id, pushkey, kind, appid, appdisplayname, devicedisplayname, profiletag, language, url, format sql.NullString
+		err = rows.Scan(&id, &pushkey, &kind, &appid, &appdisplayname, &devicedisplayname, &profiletag, &language, &url, &format)
+		if err != nil {
+			return pushers, err
+		}
+		if id.Valid {
+			pusher.ID = id.String
+		}
+		if pushkey.Valid {
+			pusher.PushKey = pushkey.String
+		}
+		if kind.Valid {
+			pusher.Kind = kind.String
+		}
+		if appid.Valid {
+			pusher.AppID = appid.String
+		}
+		if appdisplayname.Valid {
+			pusher.AppDisplayName = appdisplayname.String
+		}
+		if devicedisplayname.Valid {
+			pusher.DeviceDisplayName = devicedisplayname.String
+		}
+		if profiletag.Valid {
+			pusher.ProfileTag = profiletag.String
+		}
+		if language.Valid {
+			pusher.Language = language.String
+		}
+		if url.Valid && format.Valid {
+			pusher.Data = api.PusherData{
+				URL:    url.String,
+				Format: format.String,
+			}
+		}
+
+		pusher.UserID = userutil.MakeUserID(localpart, s.serverName)
+		pushers = append(pushers, pusher)
+	}
+
+	return pushers, rows.Err()
+}

userapi/storage/pushers/postgres/storage.go

@@ -0,0 +1,63 @@
+// Copyright 2021 Dan Peleg <dan@globekeeper.com>
+//
+// 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/setup/config"
+	"github.com/matrix-org/dendrite/userapi/api"
+	"github.com/matrix-org/gomatrixserverlib"
+)
+
+// Database represents a pusher database.
+type Database struct {
+	db      *sql.DB
+	pushers pushersStatements
+}
+
+// NewDatabase creates a new puser database
+func NewDatabase(dbProperties *config.DatabaseOptions, serverName gomatrixserverlib.ServerName) (*Database, error) {
+	db, err := sqlutil.Open(dbProperties)
+	if err != nil {
+		return nil, err
+	}
+	d := pushersStatements{}
+
+	// Create tables before executing migrations so we don't fail if the table is missing,
+	// and THEN prepare statements so we don't fail due to referencing new columns
+	if err = d.execSchema(db); err != nil {
+		return nil, err
+	}
+	m := sqlutil.NewMigrations()
+	if err = m.RunDeltas(db, dbProperties); err != nil {
+		return nil, err
+	}
+
+	if err = d.prepare(db, serverName); err != nil {
+		return nil, err
+	}
+
+	return &Database{db, d}, nil
+}
+
+// GetPushersByLocalpart returns the pusers matching the given localpart.
+func (d *Database) GetPushersByLocalpart(
+	ctx context.Context, localpart string,
+) ([]api.Pusher, error) {
+	return d.pushers.selectPushersByLocalpart(ctx, nil, localpart, "")
+}

userapi/storage/pushers/sqlite3/pushers_table.go

@@ -0,0 +1,99 @@
+// Copyright 2017 Vector Creations Ltd
+//
+// 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"
+
+	"github.com/matrix-org/dendrite/internal/sqlutil"
+	"github.com/matrix-org/dendrite/userapi/api"
+
+	"github.com/matrix-org/dendrite/clientapi/userutil"
+	"github.com/matrix-org/gomatrixserverlib"
+)
+
+const pushersSchema = `
+-- This sequence is used for automatic allocation of session_id.
+-- CREATE SEQUENCE IF NOT EXISTS pusher_session_id_seq START 1;
+
+-- Stores data about pushers.
+CREATE TABLE IF NOT EXISTS pusher_pushers (
+    access_token TEXT PRIMARY KEY,
+    session_id INTEGER,
+    pusher_id TEXT ,
+    localpart TEXT ,
+    created_ts BIGINT,
+    display_name TEXT,
+    last_seen_ts BIGINT,
+    ip TEXT,
+    user_agent TEXT,
+
+		UNIQUE (localpart, pusher_id)
+);
+`
+const selectPushersByLocalpartSQL = "" +
+	"SELECT pusher_id, display_name, last_seen_ts, ip, user_agent FROM pusher_pushers WHERE localpart = $1 AND pusher_id != $2"
+
+type pushersStatements struct {
+	db                           *sql.DB
+	writer                       sqlutil.Writer
+	selectPushersByLocalpartStmt *sql.Stmt
+	serverName                   gomatrixserverlib.ServerName
+}
+
+func (s *pushersStatements) execSchema(db *sql.DB) error {
+	_, err := db.Exec(pushersSchema)
+	return err
+}
+
+func (s *pushersStatements) prepare(db *sql.DB, writer sqlutil.Writer, server gomatrixserverlib.ServerName) (err error) {
+	s.db = db
+	s.writer = writer
+	if s.selectPushersByLocalpartStmt, err = db.Prepare(selectPushersByLocalpartSQL); err != nil {
+		return
+	}
+	s.serverName = server
+	return
+}
+
+func (s *pushersStatements) selectPushersByLocalpart(
+	ctx context.Context, txn *sql.Tx, localpart, exceptPusherID string,
+) ([]api.Pusher, error) {
+	pushers := []api.Pusher{}
+	rows, err := sqlutil.TxStmt(txn, s.selectPushersByLocalpartStmt).QueryContext(ctx, localpart, exceptPusherID)
+
+	if err != nil {
+		return pushers, err
+	}
+
+	for rows.Next() {
+		var dev api.Pusher
+		var lastseents sql.NullInt64
+		var id, displayname, ip, useragent sql.NullString
+		err = rows.Scan(&id, &displayname, &lastseents, &ip, &useragent)
+		if err != nil {
+			return pushers, err
+		}
+		if id.Valid {
+			dev.ID = id.String
+		}
+
+		dev.UserID = userutil.MakeUserID(localpart, s.serverName)
+		pushers = append(pushers, dev)
+	}
+
+	return pushers, nil
+}

userapi/storage/pushers/sqlite3/storage.go

@@ -0,0 +1,65 @@
+// Copyright 2017 Vector Creations Ltd
+//
+// 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"
+
+	"github.com/matrix-org/dendrite/internal/sqlutil"
+	"github.com/matrix-org/dendrite/setup/config"
+	"github.com/matrix-org/dendrite/userapi/api"
+	"github.com/matrix-org/gomatrixserverlib"
+
+	_ "github.com/mattn/go-sqlite3"
+)
+
+// Database represents a pusher database.
+type Database struct {
+	db      *sql.DB
+	writer  sqlutil.Writer
+	pushers pushersStatements
+}
+
+// NewDatabase creates a new pusher database
+func NewDatabase(dbProperties *config.DatabaseOptions, serverName gomatrixserverlib.ServerName) (*Database, error) {
+	db, err := sqlutil.Open(dbProperties)
+	if err != nil {
+		return nil, err
+	}
+	writer := sqlutil.NewExclusiveWriter()
+	d := pushersStatements{}
+
+	// Create tables before executing migrations so we don't fail if the table is missing,
+	// and THEN prepare statements so we don't fail due to referencing new columns
+	if err = d.execSchema(db); err != nil {
+		return nil, err
+	}
+	m := sqlutil.NewMigrations()
+	if err = m.RunDeltas(db, dbProperties); err != nil {
+		return nil, err
+	}
+	if err = d.prepare(db, writer, serverName); err != nil {
+		return nil, err
+	}
+	return &Database{db, writer, d}, nil
+}
+
+// GetPushersByLocalpart returns the pushers matching the given localpart.
+func (d *Database) GetPushersByLocalpart(
+	ctx context.Context, localpart string,
+) ([]api.Pusher, error) {
+	return d.pushers.selectPushersByLocalpart(ctx, nil, localpart, "")
+}

userapi/storage/pushers/storage.go

@@ -0,0 +1,39 @@
+// Copyright 2021 Dan Peleg <dan@globekeeper.com>
+//
+// 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.
+
+// +build !wasm
+
+package pushers
+
+import (
+	"fmt"
+
+	"github.com/matrix-org/dendrite/setup/config"
+	"github.com/matrix-org/dendrite/userapi/storage/pushers/postgres"
+	"github.com/matrix-org/dendrite/userapi/storage/pushers/sqlite3"
+	"github.com/matrix-org/gomatrixserverlib"
+)
+
+// NewDatabase opens a new Postgres or Sqlite database (based on dataSourceName scheme)
+// and sets postgres connection parameters
+func NewDatabase(dbProperties *config.DatabaseOptions, serverName gomatrixserverlib.ServerName) (Database, error) {
+	switch {
+	case dbProperties.ConnectionString.IsSQLite():
+		return sqlite3.NewDatabase(dbProperties, serverName)
+	case dbProperties.ConnectionString.IsPostgres():
+		return postgres.NewDatabase(dbProperties, serverName)
+	default:
+		return nil, fmt.Errorf("unexpected database type")
+	}
+}

userapi/storage/pushers/storage_wasm.go

@@ -0,0 +1,37 @@
+// Copyright 2021 Dan Peleg <dan@globekeeper.com>
+//
+// 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 pushers
+
+import (
+	"fmt"
+
+	"github.com/matrix-org/dendrite/setup/config"
+	"github.com/matrix-org/dendrite/userapi/storage/pushers/sqlite3"
+	"github.com/matrix-org/gomatrixserverlib"
+)
+
+func NewDatabase(
+	dbProperties *config.DatabaseOptions,
+	serverName gomatrixserverlib.ServerName,
+) (Database, error) {
+	switch {
+	case dbProperties.ConnectionString.IsSQLite():
+		return sqlite3.NewDatabase(dbProperties, serverName)
+	case dbProperties.ConnectionString.IsPostgres():
+		return nil, fmt.Errorf("can't use Postgres implementation")
+	default:
+		return nil, fmt.Errorf("unexpected database type")
+	}
+}