snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/public/shared/driver/conn.go

@@ -0,0 +1,117 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package driver
+
+import (
+	"context"
+	"database/sql/driver"
+
+	"github.com/mattermost/mattermost/server/public/plugin"
+)
+
+// Conn is a DB driver conn implementation
+// which executes queries using the Plugin DB API.
+type Conn struct {
+	id  string
+	api plugin.Driver
+}
+
+// driverConn is a super-interface combining the basic
+// driver.Conn interface with some new additions later.
+type driverConn interface {
+	driver.Conn
+	driver.ConnBeginTx
+	driver.ConnPrepareContext
+	driver.ExecerContext
+	driver.QueryerContext
+	driver.Pinger
+}
+
+var (
+	// Compile-time check to ensure Conn implements the interface.
+	_ driverConn = &Conn{}
+)
+
+func (c *Conn) Begin() (tx driver.Tx, err error) {
+	txID, err := c.api.Tx(c.id, driver.TxOptions{})
+	if err != nil {
+		return nil, err
+	}
+
+	t := &wrapperTx{
+		id:  txID,
+		api: c.api,
+	}
+	return t, nil
+}
+
+func (c *Conn) BeginTx(_ context.Context, opts driver.TxOptions) (driver.Tx, error) {
+	txID, err := c.api.Tx(c.id, opts)
+	if err != nil {
+		return nil, err
+	}
+
+	t := &wrapperTx{
+		id:  txID,
+		api: c.api,
+	}
+	return t, nil
+}
+
+func (c *Conn) Prepare(q string) (driver.Stmt, error) {
+	stID, err := c.api.Stmt(c.id, q)
+	if err != nil {
+		return nil, err
+	}
+
+	st := &wrapperStmt{
+		id:  stID,
+		api: c.api,
+	}
+	return st, nil
+}
+
+func (c *Conn) PrepareContext(_ context.Context, q string) (driver.Stmt, error) {
+	stID, err := c.api.Stmt(c.id, q)
+	if err != nil {
+		return nil, err
+	}
+	st := &wrapperStmt{
+		id:  stID,
+		api: c.api,
+	}
+	return st, nil
+}
+
+func (c *Conn) ExecContext(_ context.Context, q string, args []driver.NamedValue) (driver.Result, error) {
+	resultContainer, err := c.api.ConnExec(c.id, q, args)
+	if err != nil {
+		return nil, err
+	}
+	res := &wrapperResult{
+		res: resultContainer,
+	}
+	return res, nil
+}
+
+func (c *Conn) QueryContext(_ context.Context, q string, args []driver.NamedValue) (driver.Rows, error) {
+	rowsID, err := c.api.ConnQuery(c.id, q, args)
+	if err != nil {
+		return nil, err
+	}
+
+	rows := &wrapperRows{
+		id:  rowsID,
+		api: c.api,
+	}
+	return rows, nil
+}
+
+func (c *Conn) Ping(_ context.Context) error {
+	return c.api.ConnPing(c.id)
+}
+
+func (c *Conn) Close() error {
+	return c.api.ConnClose(c.id)
+}

server/public/shared/driver/driver.go

@@ -0,0 +1,57 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+// package driver implements a DB driver that can be used by plugins
+// to make SQL queries using RPC. This helps to avoid opening new connections
+// for every plugin, and lets everyone use the central connection
+// pool in the server.
+// The tests for this package are at app/plugin_api_tests/test_db_driver/main.go.
+package driver
+
+import (
+	"context"
+	"database/sql/driver"
+
+	"github.com/mattermost/mattermost/server/public/plugin"
+)
+
+var (
+	// Compile-time check to ensure Connector implements the interface.
+	_ driver.Connector = &Connector{}
+)
+
+// Connector is the DB connector which is used to
+// communicate with the DB API.
+type Connector struct {
+	api      plugin.Driver
+	isMaster bool
+}
+
+// NewConnector returns a DB connector that can be used to return a sql.DB object.
+// It takes a plugin.Driver implementation and a boolean flag to indicate whether
+// to connect to a master or replica DB instance.
+func NewConnector(api plugin.Driver, isMaster bool) *Connector {
+	return &Connector{api: api, isMaster: isMaster}
+}
+
+func (c *Connector) Connect(_ context.Context) (driver.Conn, error) {
+	connID, err := c.api.Conn(c.isMaster)
+	if err != nil {
+		return nil, err
+	}
+
+	return &Conn{id: connID, api: c.api}, nil
+}
+
+func (c *Connector) Driver() driver.Driver {
+	return &Driver{c: c}
+}
+
+// Driver is a DB driver implementation.
+type Driver struct {
+	c *Connector
+}
+
+func (d Driver) Open(name string) (driver.Conn, error) {
+	return d.c.Connect(context.Background())
+}

server/public/shared/driver/objects.go

@@ -0,0 +1,114 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package driver
+
+import (
+	"context"
+	"database/sql/driver"
+
+	"github.com/mattermost/mattermost/server/public/plugin"
+)
+
+type wrapperTx struct {
+	driver.Tx
+	id  string
+	api plugin.Driver
+}
+
+func (t *wrapperTx) Commit() error {
+	return t.api.TxCommit(t.id)
+}
+
+func (t *wrapperTx) Rollback() error {
+	return t.api.TxRollback(t.id)
+}
+
+type wrapperStmt struct {
+	driver.Stmt
+	id  string
+	api plugin.Driver
+}
+
+func (s *wrapperStmt) Close() error {
+	return s.api.StmtClose(s.id)
+}
+
+func (s *wrapperStmt) NumInput() int {
+	return s.api.StmtNumInput(s.id)
+}
+
+func (s *wrapperStmt) ExecContext(_ context.Context, args []driver.NamedValue) (driver.Result, error) {
+	resultContainer, err := s.api.StmtExec(s.id, args)
+	if err != nil {
+		return nil, err
+	}
+	res := &wrapperResult{
+		res: resultContainer,
+	}
+	return res, nil
+}
+
+func (s *wrapperStmt) QueryContext(_ context.Context, args []driver.NamedValue) (driver.Rows, error) {
+	rowsID, err := s.api.StmtQuery(s.id, args)
+	if err != nil {
+		return nil, err
+	}
+	rows := &wrapperRows{
+		id:  rowsID,
+		api: s.api,
+	}
+	return rows, nil
+}
+
+// wrapperResult implements the driver.Result interface.
+// This differs from other objects because it already contains the
+// information for its methods. This does two things:
+//
+// 1. Simplifies server-side code by avoiding to track result ids
+// in a map.
+// 2. Avoids round-trip to compute result methods.
+type wrapperResult struct {
+	res plugin.ResultContainer
+}
+
+func (r *wrapperResult) LastInsertId() (int64, error) {
+	return r.res.LastID, r.res.LastIDError
+}
+
+func (r *wrapperResult) RowsAffected() (int64, error) {
+	return r.res.RowsAffected, r.res.RowsAffectedError
+}
+
+type wrapperRows struct {
+	id  string
+	api plugin.Driver
+}
+
+func (r *wrapperRows) Columns() []string {
+	return r.api.RowsColumns(r.id)
+}
+
+func (r *wrapperRows) Close() error {
+	return r.api.RowsClose(r.id)
+}
+
+func (r *wrapperRows) Next(dest []driver.Value) error {
+	return r.api.RowsNext(r.id, dest)
+}
+
+func (r *wrapperRows) HasNextResultSet() bool {
+	return r.api.RowsHasNextResultSet(r.id)
+}
+
+func (r *wrapperRows) NextResultSet() error {
+	return r.api.RowsNextResultSet(r.id)
+}
+
+func (r *wrapperRows) ColumnTypeDatabaseTypeName(index int) string {
+	return r.api.RowsColumnTypeDatabaseTypeName(r.id, index)
+}
+
+func (r *wrapperRows) ColumnTypePrecisionScale(index int) (precision, scale int64, ok bool) {
+	return r.api.RowsColumnTypePrecisionScale(r.id, index)
+}