QueryInterceptorDatabase.kt

/*
 * Copyright 2020 The Android Open Source Project
 *
 * 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 androidx.room

import android.database.Cursor
import android.database.sqlite.SQLiteTransactionListener
import android.os.CancellationSignal
import androidx.annotation.NonNull

import androidx.sqlite.db.SupportSQLiteDatabase
import androidx.sqlite.db.SupportSQLiteQuery
import androidx.sqlite.db.SupportSQLiteStatement
import java.util.concurrent.Executor

/**
 * Implements [SupportSQLiteDatabase] for SQLite queries.
 */
internal class QueryInterceptorDatabase(
    private val delegate: SupportSQLiteDatabase,
    private val queryCallbackExecutor: Executor,
    private val queryCallback: RoomDatabase.QueryCallback
) : SupportSQLiteDatabase by delegate {

   override fun compileStatement(sql: String): SupportSQLiteStatement {
        return QueryInterceptorStatement(
            delegate.compileStatement(sql),
            sql,
            queryCallbackExecutor,
            queryCallback,
        )
    }

    override fun beginTransaction() {
        queryCallbackExecutor.execute {
            queryCallback.onQuery("BEGIN EXCLUSIVE TRANSACTION", emptyList())
        }
        delegate.beginTransaction()
    }

    override fun beginTransactionNonExclusive() {
        queryCallbackExecutor.execute {
            queryCallback.onQuery("BEGIN DEFERRED TRANSACTION", emptyList())
        }
        delegate.beginTransactionNonExclusive()
    }

    override fun beginTransactionWithListener(transactionListener: SQLiteTransactionListener) {
        queryCallbackExecutor.execute {
            queryCallback.onQuery("BEGIN EXCLUSIVE TRANSACTION", emptyList())
        }
        delegate.beginTransactionWithListener(transactionListener)
    }

    override fun beginTransactionWithListenerNonExclusive(
        transactionListener: SQLiteTransactionListener
    ) {
        queryCallbackExecutor.execute {
            queryCallback.onQuery("BEGIN DEFERRED TRANSACTION", emptyList())
        }
        delegate.beginTransactionWithListenerNonExclusive(transactionListener)
    }

   override fun endTransaction() {
        queryCallbackExecutor.execute {
            queryCallback.onQuery("END TRANSACTION", emptyList())
        }
       delegate.endTransaction()
    }

    override fun setTransactionSuccessful() {
        queryCallbackExecutor.execute {
            queryCallback.onQuery("TRANSACTION SUCCESSFUL", emptyList())
        }
        delegate.setTransactionSuccessful()
    }

    override fun query(query: String): Cursor {
        queryCallbackExecutor.execute {
            queryCallback.onQuery(query, emptyList())
        }
        return delegate.query(query)
    }

    override fun query(query: String, vararg bindArgs: Any): Cursor {
        queryCallbackExecutor.execute { queryCallback.onQuery(query, bindArgs.toList()) }
        return delegate.query(query, bindArgs)
    }

    override fun query(query: SupportSQLiteQuery): Cursor {
        val queryInterceptorProgram = QueryInterceptorProgram()
        query.bindTo(queryInterceptorProgram)
        queryCallbackExecutor.execute {
            queryCallback.onQuery(query.getSql(), queryInterceptorProgram.bindArgsCache)
        }
        return delegate.query(query)
    }

    @NonNull
    override fun query(
        @NonNull query: SupportSQLiteQuery,
        @NonNull cancellationSignal: CancellationSignal?
    ): Cursor {
        val queryInterceptorProgram = QueryInterceptorProgram()
        query.bindTo(queryInterceptorProgram)
        queryCallbackExecutor.execute {
            queryCallback.onQuery(
                query.sql,
                queryInterceptorProgram.bindArgsCache
            )
        }
        return delegate.query(query)
    }

    // Suppress warning about `SQL` in execSQL not being camel case. This is an override function
    // and it can't be renamed.
    @Suppress("AcronymName")
    override fun execSQL(sql: String) {
        queryCallbackExecutor.execute {
            queryCallback.onQuery(sql, emptyList())
        }
        delegate.execSQL(sql)
    }

    // Suppress warning about `SQL` in execSQL not being camel case. This is an override function
    // and it can't be renamed.
    @Suppress("AcronymName")
    override fun execSQL(sql: String, vararg bindArgs: Any) {
        val inputArguments = mutableListOf<Any>()
        inputArguments.addAll(listOf(bindArgs))
        queryCallbackExecutor.execute {
            queryCallback.onQuery(sql, inputArguments)
        }
        delegate.execSQL(sql, arrayOf(inputArguments))
    }
}