> {
+ return readableDatabase.attachedDbs
+ }
+
+ override fun isDatabaseIntegrityOk(): Boolean {
+ return readableDatabase.isDatabaseIntegrityOk
+ }
+}
diff --git a/spinner/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/spinner/app/src/main/res/drawable-v24/ic_launcher_foreground.xml
new file mode 100644
index 0000000000..18c0565852
--- /dev/null
+++ b/spinner/app/src/main/res/drawable-v24/ic_launcher_foreground.xml
@@ -0,0 +1,31 @@
+
+
+
+
+ {{table}}
+ {{else}}
+ Data
+ {{/if}}
+
+ {{#if queryResult}}
+ {{queryResult.rowCount}} row(s).
+
+
+ {{#each queryResult.columns}}
+ | {{this}} |
+ {{/each}}
+
+ {{#each queryResult.rows}}
+
+ {{#each this}}
+ | {{this}} |
+ {{/each}}
+
+ {{/each}}
+
+ {{else}}
+ Select a table from above and click 'browse'.
+ {{/if}}
+
+ {{> suffix}}
+
+
diff --git a/spinner/lib/src/main/assets/error.hbs b/spinner/lib/src/main/assets/error.hbs
new file mode 100644
index 0000000000..c21e71fe48
--- /dev/null
+++ b/spinner/lib/src/main/assets/error.hbs
@@ -0,0 +1,8 @@
+
+ {{> head title="Error :(" }}
+
+ Hit an exception while trying to serve the page :(
+
+ {{{this}}}
+
+
diff --git a/spinner/lib/src/main/assets/head.hbs b/spinner/lib/src/main/assets/head.hbs
new file mode 100644
index 0000000000..991968a2b8
--- /dev/null
+++ b/spinner/lib/src/main/assets/head.hbs
@@ -0,0 +1,86 @@
+
+ Spinner - {{ title }}
+
+
+
+
diff --git a/spinner/lib/src/main/assets/overview.hbs b/spinner/lib/src/main/assets/overview.hbs
new file mode 100644
index 0000000000..c602b5bed2
--- /dev/null
+++ b/spinner/lib/src/main/assets/overview.hbs
@@ -0,0 +1,52 @@
+
+ {{> head title="Home" }}
+
+
+
+
+
+ {{> prefix isOverview=true}}
+
+
+
+ {{#if tables}}
+ {{#each tables}}
+
+
{{{sql}}}
+ {{/each}}
+ {{else}}
+ None.
+ {{/if}}
+
+ {{#if indices}}
+ {{#each indices}}
+
+
{{{sql}}}
+ {{/each}}
+ {{else}}
+ None.
+ {{/if}}
+
+ {{#if triggers}}
+ {{#each triggers}}
+
+
{{{sql}}}
+ {{/each}}
+ {{else}}
+ None.
+ {{/if}}
+
SPINNER
+
+
+
+ | Device |
+ {{deviceInfo.name}} |
+
+
+ | Package |
+ {{deviceInfo.packageName}} |
+
+
+ | App Version |
+ {{deviceInfo.appVersion}} |
+
+
+
+
+ Database:
+
+
+
+
+ - Overview
+ - Browse
+ - Query
+
\ No newline at end of file
diff --git a/spinner/lib/src/main/assets/query.hbs b/spinner/lib/src/main/assets/query.hbs
new file mode 100644
index 0000000000..dbb37de0e9
--- /dev/null
+++ b/spinner/lib/src/main/assets/query.hbs
@@ -0,0 +1,43 @@
+
+ {{> head title="Query" }}
+
+
+ {{> prefix isQuery=true}}
+
+
+
+
+
+ Data
+ {{#if queryResult}}
+ {{queryResult.rowCount}} row(s).
+ {{queryResult.timeToFirstRow}} ms to read the first row.
+ {{queryResult.timeToReadRows}} ms to read the rest of the rows.
+
+
+
+ {{#each queryResult.columns}}
+ | {{this}} |
+ {{/each}}
+
+ {{#each queryResult.rows}}
+
+ {{#each this}}
+ | {{this}} |
+ {{/each}}
+
+ {{/each}}
+
+ {{else}}
+ No data.
+ {{/if}}
+
+ {{> suffix}}
+
+
diff --git a/spinner/lib/src/main/assets/suffix.hbs b/spinner/lib/src/main/assets/suffix.hbs
new file mode 100644
index 0000000000..c9157f431f
--- /dev/null
+++ b/spinner/lib/src/main/assets/suffix.hbs
@@ -0,0 +1,17 @@
+
\ No newline at end of file
diff --git a/spinner/lib/src/main/java/org/signal/spinner/AssetTemplateLoader.kt b/spinner/lib/src/main/java/org/signal/spinner/AssetTemplateLoader.kt
new file mode 100644
index 0000000000..7cc82f0885
--- /dev/null
+++ b/spinner/lib/src/main/java/org/signal/spinner/AssetTemplateLoader.kt
@@ -0,0 +1,47 @@
+package org.signal.spinner
+
+import android.content.Context
+import com.github.jknack.handlebars.io.StringTemplateSource
+import com.github.jknack.handlebars.io.TemplateLoader
+import com.github.jknack.handlebars.io.TemplateSource
+import org.signal.core.util.StreamUtil
+import java.nio.charset.Charset
+
+/**
+ * A loader read handlebars templates from the assets directory.
+ */
+class AssetTemplateLoader(private val context: Context) : TemplateLoader {
+
+ override fun sourceAt(location: String): TemplateSource {
+ val content: String = StreamUtil.readFullyAsString(context.assets.open("$location.hbs"))
+ return StringTemplateSource(location, content)
+ }
+
+ override fun resolve(location: String): String {
+ return location
+ }
+
+ override fun getPrefix(): String {
+ return ""
+ }
+
+ override fun getSuffix(): String {
+ return ""
+ }
+
+ override fun setPrefix(prefix: String) {
+ TODO("Not yet implemented")
+ }
+
+ override fun setSuffix(suffix: String) {
+ TODO("Not yet implemented")
+ }
+
+ override fun setCharset(charset: Charset?) {
+ TODO("Not yet implemented")
+ }
+
+ override fun getCharset(): Charset {
+ return Charset.defaultCharset()
+ }
+}
diff --git a/spinner/lib/src/main/java/org/signal/spinner/DatabaseUtil.kt b/spinner/lib/src/main/java/org/signal/spinner/DatabaseUtil.kt
new file mode 100644
index 0000000000..ed49b8ad3c
--- /dev/null
+++ b/spinner/lib/src/main/java/org/signal/spinner/DatabaseUtil.kt
@@ -0,0 +1,27 @@
+package org.signal.spinner
+
+import android.database.Cursor
+import androidx.sqlite.db.SupportSQLiteDatabase
+
+fun SupportSQLiteDatabase.getTableNames(): List {
+ val out = mutableListOf()
+ this.query("SELECT name FROM sqlite_master WHERE type='table' ORDER BY name ASC").use { cursor ->
+ while (cursor.moveToNext()) {
+ out += cursor.getString(0)
+ }
+ }
+
+ return out
+}
+
+fun SupportSQLiteDatabase.getTables(): Cursor {
+ return this.query("SELECT * FROM sqlite_master WHERE type='table' ORDER BY name ASC")
+}
+
+fun SupportSQLiteDatabase.getIndexes(): Cursor {
+ return this.query("SELECT * FROM sqlite_master WHERE type='index' ORDER BY name ASC")
+}
+
+fun SupportSQLiteDatabase.getTriggers(): Cursor {
+ return this.query("SELECT * FROM sqlite_master WHERE type='trigger' ORDER BY name ASC")
+}
diff --git a/spinner/lib/src/main/java/org/signal/spinner/Spinner.kt b/spinner/lib/src/main/java/org/signal/spinner/Spinner.kt
new file mode 100644
index 0000000000..dcc420653d
--- /dev/null
+++ b/spinner/lib/src/main/java/org/signal/spinner/Spinner.kt
@@ -0,0 +1,27 @@
+package org.signal.spinner
+
+import android.content.Context
+import androidx.sqlite.db.SupportSQLiteDatabase
+import org.signal.core.util.logging.Log
+import java.io.IOException
+
+/**
+ * A class to help initialize Spinner, our database debugging interface.
+ */
+object Spinner {
+ val TAG: String = Log.tag(Spinner::class.java)
+
+ fun init(context: Context, deviceInfo: DeviceInfo, databases: Map) {
+ try {
+ SpinnerServer(context, deviceInfo, databases).start()
+ } catch (e: IOException) {
+ Log.w(TAG, "Spinner server hit IO exception! Restarting.", e)
+ }
+ }
+
+ data class DeviceInfo(
+ val name: String,
+ val packageName: String,
+ val appVersion: String
+ )
+}
diff --git a/spinner/lib/src/main/java/org/signal/spinner/SpinnerServer.kt b/spinner/lib/src/main/java/org/signal/spinner/SpinnerServer.kt
new file mode 100644
index 0000000000..fb54f9aacf
--- /dev/null
+++ b/spinner/lib/src/main/java/org/signal/spinner/SpinnerServer.kt
@@ -0,0 +1,311 @@
+package org.signal.spinner
+
+import android.content.Context
+import android.database.Cursor
+import android.util.Base64
+import androidx.sqlite.db.SupportSQLiteDatabase
+import com.github.jknack.handlebars.Handlebars
+import com.github.jknack.handlebars.Template
+import com.github.jknack.handlebars.helper.ConditionalHelpers
+import fi.iki.elonen.NanoHTTPD
+import org.signal.core.util.ExceptionUtil
+import org.signal.core.util.logging.Log
+import java.lang.IllegalArgumentException
+import kotlin.math.max
+
+/**
+ * The workhorse of this lib. Handles all of our our web routing and response generation.
+ *
+ * In general, you add routes in [serve], and then build a response by creating a handlebars template (in the assets folder) and then passing in a data class
+ * to [renderTemplate].
+ */
+internal class SpinnerServer(
+ context: Context,
+ private val deviceInfo: Spinner.DeviceInfo,
+ private val databases: Map
+) : NanoHTTPD(5000) {
+
+ companion object {
+ private val TAG = Log.tag(SpinnerServer::class.java)
+ }
+
+ private val handlebars: Handlebars = Handlebars(AssetTemplateLoader(context)).apply {
+ registerHelper("eq", ConditionalHelpers.eq)
+ }
+
+ override fun serve(session: IHTTPSession): Response {
+ if (session.method == Method.POST) {
+ // Needed to populate session.parameters
+ session.parseBody(mutableMapOf())
+ }
+
+ val dbParam: String = session.queryParam("db") ?: session.parameters["db"]?.toString() ?: databases.keys.first()
+ val db: SupportSQLiteDatabase = databases[dbParam] ?: return internalError(IllegalArgumentException("Invalid db param!"))
+
+ try {
+ return when {
+ session.method == Method.GET && session.uri == "/" -> getIndex(dbParam, db)
+ session.method == Method.GET && session.uri == "/browse" -> getBrowse(dbParam, db)
+ session.method == Method.POST && session.uri == "/browse" -> postBrowse(dbParam, db, session)
+ session.method == Method.GET && session.uri == "/query" -> getQuery(dbParam, db)
+ session.method == Method.POST && session.uri == "/query" -> postQuery(dbParam, db, session)
+ else -> newFixedLengthResponse(Response.Status.NOT_FOUND, MIME_HTML, "Not found")
+ }
+ } catch (t: Throwable) {
+ Log.e(TAG, t)
+ return internalError(t)
+ }
+ }
+
+ private fun getIndex(dbName: String, db: SupportSQLiteDatabase): Response {
+ return renderTemplate(
+ "overview",
+ OverviewPageModel(
+ deviceInfo = deviceInfo,
+ database = dbName,
+ databases = databases.keys.toList(),
+ tables = db.getTables().toTableInfo(),
+ indices = db.getIndexes().toIndexInfo(),
+ triggers = db.getTriggers().toTriggerInfo(),
+ queryResult = db.getTables().toQueryResult()
+ )
+ )
+ }
+
+ private fun getBrowse(dbName: String, db: SupportSQLiteDatabase): Response {
+ return renderTemplate(
+ "browse",
+ BrowsePageModel(
+ deviceInfo = deviceInfo,
+ database = dbName,
+ databases = databases.keys.toList(),
+ tableNames = db.getTableNames()
+ )
+ )
+ }
+
+ private fun postBrowse(dbName: String, db: SupportSQLiteDatabase, session: IHTTPSession): Response {
+ val table: String = session.parameters["table"]?.get(0).toString()
+ val query = "select * from $table"
+
+ return renderTemplate(
+ "browse",
+ BrowsePageModel(
+ deviceInfo = deviceInfo,
+ database = dbName,
+ databases = databases.keys.toList(),
+ tableNames = db.getTableNames(),
+ table = table,
+ queryResult = db.query(query).toQueryResult()
+ )
+ )
+ }
+
+ private fun getQuery(dbName: String, db: SupportSQLiteDatabase): Response {
+ return renderTemplate(
+ "query",
+ QueryPageModel(
+ deviceInfo = deviceInfo,
+ database = dbName,
+ databases = databases.keys.toList(),
+ query = ""
+ )
+ )
+ }
+
+ private fun postQuery(dbName: String, db: SupportSQLiteDatabase, session: IHTTPSession): Response {
+ val action: String = session.parameters["action"]?.get(0).toString()
+ val rawQuery: String = session.parameters["query"]?.get(0).toString()
+ val query = if (action == "analyze") "EXPLAIN QUERY PLAN $rawQuery" else rawQuery
+ val startTime = System.currentTimeMillis()
+
+ return renderTemplate(
+ "query",
+ QueryPageModel(
+ deviceInfo = deviceInfo,
+ database = dbName,
+ databases = databases.keys.toList(),
+ query = rawQuery,
+ queryResult = db.query(query).toQueryResult(startTime)
+ )
+ )
+ }
+
+ private fun internalError(throwable: Throwable): Response {
+ val stackTrace = ExceptionUtil.convertThrowableToString(throwable)
+ .split("\n")
+ .map { it.trim() }
+ .mapIndexed { index, s -> if (index == 0) s else " $s" }
+ .joinToString("
")
+
+ return renderTemplate("error", stackTrace)
+ }
+
+ private fun renderTemplate(assetName: String, model: Any): Response {
+ val template: Template = handlebars.compile(assetName)
+ val output: String = template.apply(model)
+ return newFixedLengthResponse(output)
+ }
+
+ private fun Cursor.toQueryResult(queryStartTime: Long = 0): QueryResult {
+ val numColumns = this.columnCount
+
+ val columns = mutableListOf()
+ for (i in 0 until numColumns) {
+ columns += getColumnName(i)
+ }
+
+ var timeOfFirstRow = 0L
+ val rows = mutableListOf>()
+ while (moveToNext()) {
+ if (timeOfFirstRow == 0L) {
+ timeOfFirstRow = System.currentTimeMillis()
+ }
+
+ val row = mutableListOf()
+ for (i in 0 until numColumns) {
+ val data: String? = when (getType(i)) {
+ Cursor.FIELD_TYPE_BLOB -> Base64.encodeToString(getBlob(i), 0)
+ else -> getString(i)
+ }
+ row += data ?: "null"
+ }
+ rows += row
+ }
+
+ if (timeOfFirstRow == 0L) {
+ timeOfFirstRow = System.currentTimeMillis()
+ }
+
+ return QueryResult(
+ columns = columns,
+ rows = rows,
+ timeToFirstRow = max(timeOfFirstRow - queryStartTime, 0),
+ timeToReadRows = max(System.currentTimeMillis() - timeOfFirstRow, 0)
+ )
+ }
+
+ private fun Cursor.toTableInfo(): List {
+ val tables = mutableListOf()
+
+ while (moveToNext()) {
+ val name = getString(getColumnIndexOrThrow("name"))
+ tables += TableInfo(
+ name = name ?: "null",
+ sql = getString(getColumnIndexOrThrow("sql"))?.formatAsSqlCreationStatement(name) ?: "null"
+ )
+ }
+
+ return tables
+ }
+
+ private fun Cursor.toIndexInfo(): List {
+ val indices = mutableListOf()
+
+ while (moveToNext()) {
+ indices += IndexInfo(
+ name = getString(getColumnIndexOrThrow("name")) ?: "null",
+ sql = getString(getColumnIndexOrThrow("sql")) ?: "null"
+ )
+ }
+
+ return indices
+ }
+
+ private fun Cursor.toTriggerInfo(): List {
+ val indices = mutableListOf()
+
+ while (moveToNext()) {
+ indices += TriggerInfo(
+ name = getString(getColumnIndexOrThrow("name")) ?: "null",
+ sql = getString(getColumnIndexOrThrow("sql")) ?: "null"
+ )
+ }
+
+ return indices
+ }
+
+ /** Takes a SQL table creation statement and formats it using HTML */
+ private fun String.formatAsSqlCreationStatement(name: String): String {
+ val fields = substring(indexOf("(") + 1, this.length - 1).split(",")
+ val fieldStrings = fields.map { s -> " ${s.trim()},
" }.toMutableList()
+
+ if (fieldStrings.isNotEmpty()) {
+ fieldStrings[fieldStrings.lastIndex] = " ${fields.last().trim()}
"
+ }
+
+ return "CREATE TABLE $name (
" +
+ fieldStrings.joinToString("") +
+ ")"
+ }
+
+ private fun IHTTPSession.queryParam(name: String): String? {
+ if (queryParameterString == null) {
+ return null
+ }
+
+ val params: Map = queryParameterString
+ .split("&")
+ .mapNotNull { part ->
+ val parts = part.split("=")
+ if (parts.size == 2) {
+ parts[0] to parts[1]
+ } else {
+ null
+ }
+ }
+ .toMap()
+
+ return params[name]
+ }
+
+ data class OverviewPageModel(
+ val deviceInfo: Spinner.DeviceInfo,
+ val database: String,
+ val databases: List,
+ val tables: List,
+ val indices: List,
+ val triggers: List,
+ val queryResult: QueryResult? = null
+ )
+
+ data class BrowsePageModel(
+ val deviceInfo: Spinner.DeviceInfo,
+ val database: String,
+ val databases: List,
+ val tableNames: List,
+ val table: String? = null,
+ val queryResult: QueryResult? = null
+ )
+
+ data class QueryPageModel(
+ val deviceInfo: Spinner.DeviceInfo,
+ val database: String,
+ val databases: List,
+ val query: String = "",
+ val queryResult: QueryResult? = null
+ )
+
+ data class QueryResult(
+ val columns: List,
+ val rows: List>,
+ val rowCount: Int = rows.size,
+ val timeToFirstRow: Long,
+ val timeToReadRows: Long,
+ )
+
+ data class TableInfo(
+ val name: String,
+ val sql: String
+ )
+
+ data class IndexInfo(
+ val name: String,
+ val sql: String
+ )
+
+ data class TriggerInfo(
+ val name: String,
+ val sql: String
+ )
+}