Compare commits
9
Commits
car-2.40.3
...
car-2.42.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9de9387460 | ||
|
|
f9154c051f | ||
|
|
6563b2c4e8 | ||
|
|
8596951cef | ||
|
|
33e8fe6e05 | ||
|
|
eebe840b6a | ||
|
|
16e6f349da | ||
|
|
60ab3118a1 | ||
|
|
097467f4e0 |
@@ -0,0 +1,79 @@
|
|||||||
|
---
|
||||||
|
name: car-logs
|
||||||
|
description: Download the signal recordings the MG4 sent to the car server (fetch-logs) and read them. Use when the owner says a recording is on the server, asks to get, download or look at the car's logs or recordings, or after a test drive with the signal recorder.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Fetch and read the car's recordings
|
||||||
|
|
||||||
|
The app's signal recorder (Logs tab, `SignalRecorder`) sends each finished recording to the
|
||||||
|
car server (`LogOutbox`, `PUT /v1/logs/{name}`); the server keeps the newest 200
|
||||||
|
(`server/logs.go`). `fetch-logs` in the dev shell downloads the ones not yet in `logs/`.
|
||||||
|
|
||||||
|
## Fetch
|
||||||
|
|
||||||
|
```sh
|
||||||
|
nix develop -c fetch-logs
|
||||||
|
```
|
||||||
|
|
||||||
|
It prints each new file (`logs/signal-recording-YYYYMMDD-HHMMSS.txt`) and `fetch-logs: N new`.
|
||||||
|
The token comes from `~/.config/nilsmg4/logs-token` (the server's `LOGS_TOKEN`) and goes only in
|
||||||
|
a header.
|
||||||
|
|
||||||
|
- **Never print, cat or echo the token**, and never pass it on a command line you show. Do not
|
||||||
|
read the token file.
|
||||||
|
- `no token`: ask the owner to put the server's `LOGS_TOKEN` in `~/.config/nilsmg4/logs-token`
|
||||||
|
(and in `k8s/secrets/secrets.yaml`, then apply it). Do not create or fill it yourself.
|
||||||
|
- HTTP 401: the file and the server's Secret differ. HTTP 404: reading is off (no
|
||||||
|
`LOGS_TOKEN` on the server) or the server is older than 2.9.0. The owner applies manifests and
|
||||||
|
Secrets; never run `kubectl` against the cluster, not even read-only.
|
||||||
|
- `0 new`: nothing arrived. In the car, the Logs tab says "Sent to the server." or how many wait
|
||||||
|
and why (no server set up, server not reached, an HTTP status); the car retries every 2
|
||||||
|
minutes while the service runs.
|
||||||
|
|
||||||
|
## Read
|
||||||
|
|
||||||
|
The files are plain text but `file` may call them data; search with `rg -a`. Newest first:
|
||||||
|
`ls -t logs/`. If the owner said what they did and when (e.g. "ACC on at 08:50, set speed
|
||||||
|
100→90 at 08:51"), line those times up with the timeline.
|
||||||
|
|
||||||
|
A recording has four parts, in this order:
|
||||||
|
|
||||||
|
1. Header: captures, start time, app version.
|
||||||
|
2. **Steering-wheel keys and notes.** The first note says whether listening worked:
|
||||||
|
`listening to N assistance properties (M refused)`, or `not possible (<reason>)`.
|
||||||
|
3. **Assistance properties heard** (`EVHardware.listenToProperties` on `AssistBlock`, the
|
||||||
|
`0x21x0A1xx` block): change events, properties whose value changed first. This is where a
|
||||||
|
value shows up that the head unit fills only while someone listens.
|
||||||
|
4. **Changed values (polled)**, rarest first, then **Everything, in order**: every capture
|
||||||
|
(about every 5 s) with what changed since the last.
|
||||||
|
|
||||||
|
Useful cuts:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
rg -a 'listening to' logs/<file> # did listening work
|
||||||
|
awk '/^Assistance properties heard/,/^$/' logs/<file> # what listening heard
|
||||||
|
rg -a 'A15B|A15A' logs/<file> # one property's history
|
||||||
|
rg -a 'getLatestSpeed' logs/<file> | head # the car's speed over time
|
||||||
|
```
|
||||||
|
|
||||||
|
Known leads (SPECS.md, 2026-10-27): `0x2160A15B` is `AAD_EPTCCTRGTSPD`, by its name the cruise
|
||||||
|
control's target speed (0.0 when only polled); `0x2140A15A` moved between 3 and 7;
|
||||||
|
`0x2160A1A3`/`0x2160A1A4` counted up by 0.1. A value that tracks what the owner did at the
|
||||||
|
times they name is a lead; say how sure it is, and that it is not confirmed until a second
|
||||||
|
drive shows the same.
|
||||||
|
|
||||||
|
## Music-sources checks
|
||||||
|
|
||||||
|
`fetch-logs` also brings `media-probe-YYYYMMDD-HHMMSS.txt` (Logs tab, "Check music sources",
|
||||||
|
`MediaProbe`). Three parts: audio players (use, app, state), active media sessions with state
|
||||||
|
and song (TITLE, ARTIST, ALBUM, ALBUM_ART as a size or ALBUM_ART_URI), and the media browser
|
||||||
|
services by name (2.42.1 on; 2.42.0 also connected to them, which stopped the music). CarPlay's
|
||||||
|
session is `com.allgo.remoteui.mediabrowserservice`, Bluetooth's `com.android.bluetooth`. Ask what was playing
|
||||||
|
when the check ran.
|
||||||
|
|
||||||
|
## Rules
|
||||||
|
|
||||||
|
- Recordings and checks are the car's data: `logs/`, `/signal-recording-*.txt` and
|
||||||
|
`/media-probe-*.txt` are gitignored. Never
|
||||||
|
commit, publish or upload them anywhere.
|
||||||
|
- Findings that change what the project knows go into a `SPECS.md` done-log entry, as usual.
|
||||||
@@ -41,3 +41,8 @@ mise.local.toml
|
|||||||
|
|
||||||
# CarPlay diagnostic exports: vendor software, never committed
|
# CarPlay diagnostic exports: vendor software, never committed
|
||||||
/dump/
|
/dump/
|
||||||
|
|
||||||
|
# The car's own recordings (fetch-logs, or copied off a USB stick): its data, not the code's.
|
||||||
|
/logs/
|
||||||
|
/signal-recording-*.txt
|
||||||
|
/media-probe-*.txt
|
||||||
|
|||||||
@@ -21,7 +21,8 @@ MG4 head unit (Android 9, AAOS, MT2712)
|
|||||||
- **server/** — Go 1.27 API at `https://car.k8s.stinnesbeck.com`: stores telemetry, consumption
|
- **server/** — Go 1.27 API at `https://car.k8s.stinnesbeck.com`: stores telemetry, consumption
|
||||||
and charging in InfluxDB, pairs cars by QR code, carries settings typed on a phone, relays
|
and charging in InfluxDB, pairs cars by QR code, carries settings typed on a phone, relays
|
||||||
app releases from the private forge, and serves the roads for the Grid's map from
|
app releases from the private forge, and serves the roads for the Grid's map from
|
||||||
OpenStreetMap vector tiles (OpenFreeMap), fetched per tile on demand and cached on a volume. It does **not** talk to ABRP. See `server/README.md`.
|
OpenStreetMap vector tiles (OpenFreeMap), fetched per tile on demand and cached on a volume, and keeps the signal recordings the car sends
|
||||||
|
(read with their own token, `fetch-logs`). It does **not** talk to ABRP. See `server/README.md`.
|
||||||
- **k8s/** — plain Kubernetes manifests (InfluxDB, server, Grafana with three provisioned
|
- **k8s/** — plain Kubernetes manifests (InfluxDB, server, Grafana with three provisioned
|
||||||
dashboards, Traefik routes). See `k8s/README.md`.
|
dashboards, Traefik routes). See `k8s/README.md`.
|
||||||
- **EVHardware/** — vendored shared vehicle layer (PolyForm Noncommercial, see `LICENSE.md`).
|
- **EVHardware/** — vendored shared vehicle layer (PolyForm Noncommercial, see `LICENSE.md`).
|
||||||
@@ -81,7 +82,7 @@ Repository: `ssh://git@git.stinnesbeck.com:2222/nils/mg4.git` (remote `origin`),
|
|||||||
| Live data | on/off, ABRP API key and user token, upload frequency |
|
| Live data | on/off, ABRP API key and user token, upload frequency |
|
||||||
| Server | URL, pairing by QR, ingest token, installation ID (read-only), config import |
|
| Server | URL, pairing by QR, ingest token, installation ID (read-only), config import |
|
||||||
| Settings | drive mode (Eco, Normal, Sport, Snow, Custom; the lit one is what the car reports; changes only in P at a standstill, `DriveModeWrite`; "Set at start" sets the last confirmed choice again when the service starts with the head unit), full screen, voice key, Overview style with the accent colour beside it (offered only for styles drawn in it, `OverviewStyle.usesAccent`; Retro, Terminal, Grid (and Grid with map, sharing Grid's choice) and Visor add "Original" for their own palette, `hasOriginal`), tyre unit, battery and charging price (one card on wide screens), version, update check, install from USB, About |
|
| Settings | drive mode (Eco, Normal, Sport, Snow, Custom; the lit one is what the car reports; changes only in P at a standstill, `DriveModeWrite`; "Set at start" sets the last confirmed choice again when the service starts with the head unit), full screen, voice key, Overview style with the accent colour beside it (offered only for styles drawn in it, `OverviewStyle.usesAccent`; Retro, Terminal, Grid (and Grid with map, sharing Grid's choice) and Visor add "Original" for their own palette, `hasOriginal`), tyre unit, battery and charging price (one card on wide screens), version, update check, install from USB, About |
|
||||||
| Logs | signal recorder (`SignalRecorder`/`SignalRecording`: every property and vendor getter via `VendorSurfaceProbe.capture`, again and again for 3 minutes, plus change events of the driver-assistance block it subscribes to, `EVHardware.listenToProperties` with `AssistBlock`, and steering-wheel key broadcasts; lists what changed, rarest first; saved to the app and a USB stick; how to find where the car publishes something), update log (every install step, with the platform's words), upload log |
|
| Logs | signal recorder (`SignalRecorder`/`SignalRecording`: every property and vendor getter via `VendorSurfaceProbe.capture`, again and again for 3 minutes, plus change events of the driver-assistance block it subscribes to, `EVHardware.listenToProperties` with `AssistBlock`, and steering-wheel key broadcasts; lists what changed, rarest first; saved to the app, a USB stick and the server, through `LogOutbox`, which sends it again later when the car is offline; how to find where the car publishes something), music-sources check (`MediaProbe`: audio players and the active media sessions, CarPlay's and Bluetooth's among them, with their song, and the media browser services by name — never connected to: binding them stopped the music in 2.42.0; saved and sent like a recording), update log (every install step, with the platform's words), upload log |
|
||||||
|
|
||||||
Key classes (`app/src/main/java/com/evsuite/abrp/`): `AbrpUploadService` (foreground service,
|
Key classes (`app/src/main/java/com/evsuite/abrp/`): `AbrpUploadService` (foreground service,
|
||||||
15 s tick), `TelemetryUploader` (+ `TelemetryQueue`, persisted), `TelemetryPayload` (server
|
15 s tick), `TelemetryUploader` (+ `TelemetryQueue`, persisted), `TelemetryPayload` (server
|
||||||
@@ -110,6 +111,7 @@ nix develop # JDK 21, Android SDK, Go
|
|||||||
./gradlew testStableDebugUnitTest testUnstableDebugUnitTest lintStableDebug
|
./gradlew testStableDebugUnitTest testUnstableDebugUnitTest lintStableDebug
|
||||||
build-car # build/car/NilsMG4-unstable-<version>.apk + .sha256
|
build-car # build/car/NilsMG4-unstable-<version>.apk + .sha256
|
||||||
publish-car # pre-release car-<version> on the forge (needs a token)
|
publish-car # pre-release car-<version> on the forge (needs a token)
|
||||||
|
fetch-logs # the car's recordings from the server into logs/ (needs LOGS_TOKEN; skill car-logs)
|
||||||
cd server && go vet ./... && go test ./... && govulncheck ./...
|
cd server && go vet ./... && go test ./... && govulncheck ./...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -324,6 +324,10 @@ object EVHardware {
|
|||||||
// Listening to properties (the app's signal recorder) — read only
|
// Listening to properties (the app's signal recorder) — read only
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/** Why the last [listenToProperties] returned null, in a few words; null after a success. */
|
||||||
|
@Volatile var listenProblem: String? = null
|
||||||
|
private set
|
||||||
|
|
||||||
/** A subscription made by [listenToProperties]; [close] ends it. */
|
/** A subscription made by [listenToProperties]; [close] ends it. */
|
||||||
class PropertyListening internal constructor(
|
class PropertyListening internal constructor(
|
||||||
/** Properties subscribed to, and those the car service refused. */
|
/** Properties subscribed to, and those the car service refused. */
|
||||||
@@ -342,19 +346,44 @@ object EVHardware {
|
|||||||
* may fill a property from the car network only while someone listens, so a poll alone can
|
* may fill a property from the car network only while someone listens, so a poll alone can
|
||||||
* read its default. ON_CHANGE properties are asked for every change, CONTINUOUS ones for
|
* read its default. ON_CHANGE properties are asked for every change, CONTINUOUS ones for
|
||||||
* 1 Hz within their limits. Read only: nothing is set. Null when there is no
|
* 1 Hz within their limits. Read only: nothing is set. Null when there is no
|
||||||
* CarPropertyManager or no way to subscribe; [PropertyListening.close] unsubscribes.
|
* CarPropertyManager or no way to subscribe, with the reason in [listenProblem];
|
||||||
|
* [PropertyListening.close] unsubscribes.
|
||||||
|
*
|
||||||
|
* Android 9's car library (the MG4's) names the calls `registerListener(CarPropertyEventListener,
|
||||||
|
* int, float)` and `unregisterListener`; Android 10 renamed them `registerCallback` and
|
||||||
|
* `unregisterCallback`. Both are looked for. Unsubscribing goes property by property: the
|
||||||
|
* one-argument `unregisterListener` of Android 9 removes entries from the list it walks and so
|
||||||
|
* leaves every other property subscribed.
|
||||||
*/
|
*/
|
||||||
fun listenToProperties(admit: (Int) -> Boolean, onEvent: (Int, Int, String) -> Unit): PropertyListening? {
|
fun listenToProperties(admit: (Int) -> Boolean, onEvent: (Int, Int, String) -> Unit): PropertyListening? {
|
||||||
val cpm = sCarPropertyManager ?: return null
|
listenProblem = null
|
||||||
|
val cpm = sCarPropertyManager ?: run {
|
||||||
|
listenProblem = "no car service"
|
||||||
|
return null
|
||||||
|
}
|
||||||
return try {
|
return try {
|
||||||
val register = cpm.javaClass.methods.firstOrNull {
|
val methods = cpm.javaClass.methods
|
||||||
it.name == "registerCallback" && it.parameterCount == 3
|
val register = methods.firstOrNull {
|
||||||
} ?: return null
|
(it.name == "registerListener" || it.name == "registerCallback") && it.parameterCount == 3 &&
|
||||||
val unregister = cpm.javaClass.methods.firstOrNull {
|
it.parameterTypes[1] == Int::class.javaPrimitiveType &&
|
||||||
it.name == "unregisterCallback" && it.parameterCount == 1
|
it.parameterTypes[2] == Float::class.javaPrimitiveType
|
||||||
|
} ?: run {
|
||||||
|
listenProblem = "no way to subscribe"
|
||||||
|
return null
|
||||||
}
|
}
|
||||||
val callbackType = register.parameterTypes[0]
|
val callbackType = register.parameterTypes[0]
|
||||||
if (!callbackType.isInterface) return null
|
val unregister = methods.firstOrNull {
|
||||||
|
it.name == register.name.replaceFirst("register", "unregister") && it.parameterCount == 2 &&
|
||||||
|
it.parameterTypes[0] == callbackType && it.parameterTypes[1] == Int::class.javaPrimitiveType
|
||||||
|
}
|
||||||
|
val unregisterAll = methods.firstOrNull {
|
||||||
|
it.name == register.name.replaceFirst("register", "unregister") && it.parameterCount == 1 &&
|
||||||
|
it.parameterTypes[0] == callbackType
|
||||||
|
}
|
||||||
|
if (!callbackType.isInterface) {
|
||||||
|
listenProblem = "unexpected listener type ${callbackType.simpleName}"
|
||||||
|
return null
|
||||||
|
}
|
||||||
val proxy = Proxy.newProxyInstance(callbackType.classLoader, arrayOf(callbackType)) { self, method, args ->
|
val proxy = Proxy.newProxyInstance(callbackType.classLoader, arrayOf(callbackType)) { self, method, args ->
|
||||||
when (method.name) {
|
when (method.name) {
|
||||||
"onChangeEvent" -> {
|
"onChangeEvent" -> {
|
||||||
@@ -385,7 +414,7 @@ object EVHardware {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
val configs = cpm.javaClass.getMethod("getPropertyList").invoke(cpm) as? List<*> ?: return null
|
val configs = cpm.javaClass.getMethod("getPropertyList").invoke(cpm) as? List<*> ?: return null
|
||||||
var subscribed = 0
|
val subscribedIds = ArrayList<Int>()
|
||||||
var refused = 0
|
var refused = 0
|
||||||
for (config in configs) {
|
for (config in configs) {
|
||||||
if (config == null) continue
|
if (config == null) continue
|
||||||
@@ -399,21 +428,31 @@ object EVHardware {
|
|||||||
1f.coerceIn(min, maxOf(min, max))
|
1f.coerceIn(min, maxOf(min, max))
|
||||||
}
|
}
|
||||||
try {
|
try {
|
||||||
if (register.invoke(cpm, proxy, id, rate) == false) refused++ else subscribed++
|
if (register.invoke(cpm, proxy, id, rate) == false) refused++ else subscribedIds.add(id)
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
refused++
|
refused++
|
||||||
AppLogger.d(TAG, "listen: 0x%08X refused: %s".format(id, e.readFailureReason()))
|
AppLogger.d(TAG, "listen: 0x%08X refused: %s".format(id, e.readFailureReason()))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
AppLogger.i(TAG, "listening to $subscribed properties ($refused refused)")
|
AppLogger.i(TAG, "listening to ${subscribedIds.size} properties ($refused refused) via ${register.name}")
|
||||||
PropertyListening(subscribed, refused) {
|
PropertyListening(subscribedIds.size, refused) {
|
||||||
|
for (id in subscribedIds) {
|
||||||
try {
|
try {
|
||||||
unregister?.invoke(cpm, proxy)
|
if (unregister != null) unregister.invoke(cpm, proxy, id)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
AppLogger.d(TAG, "listen: unsubscribe 0x%08X failed: %s".format(id, e.readFailureReason()))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (unregister == null) {
|
||||||
|
try {
|
||||||
|
unregisterAll?.invoke(cpm, proxy)
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
AppLogger.d(TAG, "listen: unsubscribe failed: ${e.readFailureReason()}")
|
AppLogger.d(TAG, "listen: unsubscribe failed: ${e.readFailureReason()}")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
} catch (e: Exception) {
|
} catch (e: Exception) {
|
||||||
|
listenProblem = e.readFailureReason()
|
||||||
AppLogger.w(TAG, "listenToProperties: ${e.readFailureReason()}")
|
AppLogger.w(TAG, "listenToProperties: ${e.readFailureReason()}")
|
||||||
null
|
null
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,105 @@
|
|||||||
|
package com.evsuite.hardware
|
||||||
|
|
||||||
|
import org.junit.After
|
||||||
|
import org.junit.Assert.assertEquals
|
||||||
|
import org.junit.Assert.assertNotNull
|
||||||
|
import org.junit.Assert.assertNull
|
||||||
|
import org.junit.Assert.assertTrue
|
||||||
|
import org.junit.Test
|
||||||
|
|
||||||
|
class PropertyListeningTest {
|
||||||
|
|
||||||
|
class Config(val propertyId: Int, val changeMode: Int, val minSampleRate: Float, val maxSampleRate: Float)
|
||||||
|
class Value(val propertyId: Int, val areaId: Int, val value: Any)
|
||||||
|
|
||||||
|
/** Shaped like Android 9's CarPropertyManager, the car's: registerListener, and an
|
||||||
|
* unregisterListener(listener) that skips every other property as the car's does. */
|
||||||
|
class Android9Manager(private val configs: List<Config>) {
|
||||||
|
interface CarPropertyEventListener {
|
||||||
|
fun onChangeEvent(value: Any?)
|
||||||
|
fun onErrorEvent(propertyId: Int, areaId: Int)
|
||||||
|
}
|
||||||
|
|
||||||
|
val active = LinkedHashMap<Int, MutableList<CarPropertyEventListener>>()
|
||||||
|
val rates = HashMap<Int, Float>()
|
||||||
|
|
||||||
|
fun getPropertyList(): List<Config> = configs
|
||||||
|
|
||||||
|
fun registerListener(listener: CarPropertyEventListener, propertyId: Int, rate: Float): Boolean {
|
||||||
|
active.getOrPut(propertyId) { ArrayList() }.add(listener)
|
||||||
|
rates[propertyId] = rate
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
fun unregisterListener(listener: CarPropertyEventListener) {
|
||||||
|
val ids = active.keys.toMutableList()
|
||||||
|
var i = 0
|
||||||
|
while (i < ids.size) {
|
||||||
|
unregisterListener(listener, ids[i])
|
||||||
|
if (active[ids[i]] == null) ids.removeAt(i) // as SparseArray.remove under keyAt(i)
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun unregisterListener(listener: CarPropertyEventListener, propertyId: Int) {
|
||||||
|
val list = active[propertyId] ?: return
|
||||||
|
list.remove(listener)
|
||||||
|
if (list.isEmpty()) active.remove(propertyId)
|
||||||
|
}
|
||||||
|
|
||||||
|
fun fire(propertyId: Int, value: Any) {
|
||||||
|
active[propertyId]?.toList()?.forEach { it.onChangeEvent(Value(propertyId, 0x01000000, value)) }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class NoListeners {
|
||||||
|
fun getPropertyList(): List<Config> = emptyList()
|
||||||
|
}
|
||||||
|
|
||||||
|
private val field = EVHardware::class.java.getDeclaredField("sCarPropertyManager").apply { isAccessible = true }
|
||||||
|
|
||||||
|
@After
|
||||||
|
fun reset() = field.set(null, null)
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun `subscribes through Android 9's registerListener and unsubscribes every property`() {
|
||||||
|
val manager = Android9Manager(listOf(
|
||||||
|
Config(0x2160A15B, 1, 0f, 0f), // in the block, on change
|
||||||
|
Config(0x2140A15A, 1, 0f, 0f),
|
||||||
|
Config(0x2160A1A3, 2, 0f, 10f), // continuous
|
||||||
|
Config(0x2140A101, 1, 0f, 0f),
|
||||||
|
Config(0x11400400, 1, 0f, 0f), // outside the block
|
||||||
|
))
|
||||||
|
field.set(null, manager)
|
||||||
|
val heard = ArrayList<String>()
|
||||||
|
|
||||||
|
val listening = EVHardware.listenToProperties(AssistBlock::contains) { id, area, value ->
|
||||||
|
heard += "%08X/%d=%s".format(id, area, value)
|
||||||
|
}
|
||||||
|
|
||||||
|
assertNotNull(EVHardware.listenProblem, listening)
|
||||||
|
assertEquals(4, listening!!.subscribed)
|
||||||
|
assertEquals(0, listening.refused)
|
||||||
|
assertEquals(setOf(0x2160A15B, 0x2140A15A, 0x2160A1A3, 0x2140A101), manager.active.keys)
|
||||||
|
assertEquals(0f, manager.rates[0x2160A15B])
|
||||||
|
assertEquals(1f, manager.rates[0x2160A1A3])
|
||||||
|
|
||||||
|
manager.fire(0x2160A15B, 90f)
|
||||||
|
assertEquals(1, heard.size)
|
||||||
|
assertTrue(heard[0], heard[0].startsWith("2160A15B/16777216="))
|
||||||
|
|
||||||
|
listening.close()
|
||||||
|
assertTrue(manager.active.toString(), manager.active.isEmpty())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun `says why when there is no way to subscribe`() {
|
||||||
|
field.set(null, NoListeners())
|
||||||
|
assertNull(EVHardware.listenToProperties(AssistBlock::contains) { _, _, _ -> })
|
||||||
|
assertEquals("no way to subscribe", EVHardware.listenProblem)
|
||||||
|
|
||||||
|
field.set(null, null)
|
||||||
|
assertNull(EVHardware.listenToProperties(AssistBlock::contains) { _, _, _ -> })
|
||||||
|
assertEquals("no car service", EVHardware.listenProblem)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -95,7 +95,7 @@ with the server using a token of its own, obtained by pairing with a phone (belo
|
|||||||
| **Live data** | Live data on/off, ABRP credentials for sending directly from the car, upload frequency |
|
| **Live data** | Live data on/off, ABRP credentials for sending directly from the car, upload frequency |
|
||||||
| **Server** | Server URL, pairing by QR code, ingest token, installation ID, config import |
|
| **Server** | Server URL, pairing by QR code, ingest token, installation ID, config import |
|
||||||
| **Settings** | Full screen, voice key, Overview style and accent colour, tyre pressure unit; drive mode (Eco, Normal, Sport, Snow, Custom: changes only in P at a standstill; the highlighted one is what the car reports; with "Set at start" the last confirmed choice is set again when the car starts, while it is still in P); battery (manual SoH, usable capacity) and charging price; entry on the phone; version, update check, install from USB stick, About |
|
| **Settings** | Full screen, voice key, Overview style and accent colour, tyre pressure unit; drive mode (Eco, Normal, Sport, Snow, Custom: changes only in P at a standstill; the highlighted one is what the car reports; with "Set at start" the last confirmed choice is set again when the car starts, while it is still in P); battery (manual SoH, usable capacity) and charging price; entry on the phone; version, update check, install from USB stick, About |
|
||||||
| **Logs** | Signal recorder (records every value the head unit offers for 3 minutes, listens to the driver-assistance values for every change they report, and lists what changed, to find where the car publishes something; saved to a USB stick too), update log (every install step), upload log |
|
| **Logs** | Signal recorder (records every value the head unit offers for 3 minutes, listens to the driver-assistance values for every change they report, and lists what changed, to find where the car publishes something; sent to your server, and saved to a USB stick too), music-sources check (where the head unit tells what is playing, CarPlay included; read only), update log (every install step), upload log |
|
||||||
|
|
||||||
- **Opening the app:** the MG4 launcher does not list third-party apps. **Double-press the
|
- **Opening the app:** the MG4 launcher does not list third-party apps. **Double-press the
|
||||||
voice key** on the steering wheel and the app comes to the front (switch on the Settings
|
voice key** on the steering wheel and the app comes to the front (switch on the Settings
|
||||||
|
|||||||
@@ -140,6 +140,87 @@ tyre pressures, GPS (lat, lon, elevation, heading) and the is_* flags. It does *
|
|||||||
confirmed car facts, app structure, UI conventions, build/test/ship, documents. It replaces
|
confirmed car facts, app structure, UI conventions, build/test/ship, documents. It replaces
|
||||||
upstream's EVABRPUploader text. The test emulator is now in the flake: `nix run .#car-emulator`
|
upstream's EVABRPUploader text. The test emulator is now in the flake: `nix run .#car-emulator`
|
||||||
(Android 9 AOSP at 1920×720, 160 dpi; the car build installs as the system user — checked).
|
(Android 9 AOSP at 1920×720, 160 dpi; the car build installs as the system user — checked).
|
||||||
|
- 2026-10-28 — App 2.42.1: **the music-sources check no longer connects to other apps' media
|
||||||
|
services.** In the car, 2.42.0's check (14:26, Bluetooth music playing) made the head unit ask
|
||||||
|
whether to allow access to media (the owner agreed) and **stopped the Bluetooth music**: it
|
||||||
|
connected to every media browser service, and among them the AOSP car radio's
|
||||||
|
(`com.android.car.radio/.RadioService`, which answered "connecting", most likely taking the
|
||||||
|
audio) and the Local Media Player (`com.android.car.media.localmediaplayer`, whose permission
|
||||||
|
request is most likely the question; it may now read media files). My claim that the check only
|
||||||
|
read was wrong: binding another app's service starts it. Now the services are only listed.
|
||||||
|
Nothing lost: the active sessions alone carried everything — **Bluetooth**
|
||||||
|
(`com.android.bluetooth`: title, artist, album, duration, track, cover as a file path, playing)
|
||||||
|
and **CarPlay** (`com.allgo.remoteui.mediabrowserservice`: title, artist, duration, paused) —
|
||||||
|
readable with MEDIA_CONTENT_CONTROL, no connection needed. Services on the car: CarPlay's,
|
||||||
|
Bluetooth A2DP, Local Media Player, the AOSP car radio, SAIC's radio (DAB, "Brillux Radio"),
|
||||||
|
SAIC's USB 1/2 and online media, and SAIC's video browser. Tests and lint pass; not run on the
|
||||||
|
emulator (stopped for low memory; the change only removes code); not tried on the car.
|
||||||
|
- 2026-10-28 — App 2.42.0 published (`car-2.42.0`).
|
||||||
|
- 2026-10-28 — App 2.42.0: **music-sources check** on the Logs tab (`MediaProbe`,
|
||||||
|
`MediaProbeText`; owner: "is it possible to show playing music in our dashboard as well?", then
|
||||||
|
"yes start the probe"). Before a now-playing display, it finds where the head unit tells what is
|
||||||
|
playing, read only: the players Android's audio service reports (use, app, state), the active
|
||||||
|
media sessions (`MediaSessionManager.getActiveSessions`, MEDIA_CONTENT_CONTROL, which the system
|
||||||
|
user has) with their song, and every media browser service, each connected to, its session read
|
||||||
|
and disconnected. CarPlay's is tried even when not listed:
|
||||||
|
`com.allgo.remoteui.mediabrowserservice/.RemoteUIMediaBrowserService`, which the car's own media
|
||||||
|
library (`com.saicmotor.sdk.media…MediaPlayControlManager` in Allgo's APK) reads CarPlay's title,
|
||||||
|
artist, album and cover from through a plain `MediaBrowser`. Nothing of Allgo's is changed and
|
||||||
|
nothing is played, paused or skipped. The report (`media-probe-YYYYMMDD-HHMMSS.txt`) goes where
|
||||||
|
a recording goes, through the shared `SignalRecorder.saveCopies`: the app, a USB stick, the
|
||||||
|
server (`fetch-logs`). Unit tests for the text; tests and lint pass. Emulator (Android 9): the
|
||||||
|
players are read with their app and state (the system APIs answer the system user), the
|
||||||
|
sessions are readable (none there, no SecurityException), the AOSP music app's browser service
|
||||||
|
connects and is read, CarPlay's (not installed there) is "refused or failed", and the report
|
||||||
|
lands in the outbox. **Not tried on the car.** Unknown until then: whether CarPlay's service
|
||||||
|
lets the app connect, and whether the radio, Bluetooth and USB sources publish a session.
|
||||||
|
- 2026-10-28 — First recordings over the server (14:19 and 14:23, app 2.41.0, ACC on, the set
|
||||||
|
speed raised a few times): the server path works, and listening works in the car (249
|
||||||
|
assistance properties, 0 refused, 76 and 81 change events). `0x2160A15B` (`AAD_EPTCCTRGTSPD`)
|
||||||
|
stays 0.0 even while listened to: the car does not fill it. `0x2140A15A` (3/7, a few 0s) and
|
||||||
|
`0x2160A1A3`/`A1A4` (always equal, 1.4–5.3, now and then 0.1–0.2 down) do not move with the
|
||||||
|
key presses. New lead: steering-wheel keys **297** (2× at 14:20:09, 2× at 14:20:12) and **300**
|
||||||
|
(14:20:05, 2× at 14:20:40), the car speeding up 27 → 49 km/h after them; key 3 is Home. The
|
||||||
|
14:23 recording has no key at all. Not confirmed: which buttons these are. Also seen:
|
||||||
|
`0x21401553`–`1556` ≈ 256 are tyre pressures and `0x2140155B`–`155E` (18–24) tyre
|
||||||
|
temperatures, not the set speed.
|
||||||
|
- 2026-10-27 — Skill `car-logs` (`.claude/skills/car-logs/SKILL.md`; owner: "can we write a skill for downloading the logs?"): fetch with `fetch-logs` without ever showing the token, what its errors mean, how a recording is laid out, the cuts that find a lead, the leads so far, and that recordings are never committed. Its commands tried on the 08:52 recording.
|
||||||
|
- 2026-10-27 — Server 2.9.0 pushed (`sha256:c68837f0e53cfca150644987be535e04d5e999bd4c91064d40973db67235df48`, pinned in `k8s/server.yaml`); app 2.41.0 published (`car-2.41.0`).
|
||||||
|
- 2026-10-27 — App 2.41.0, server 2.9.0: **recordings reach the server** (owner: "can we make
|
||||||
|
it so that we can upload the logs to an endpoint in the server, and you can get the logs from
|
||||||
|
there? that way i don't have to carry a usb stick"). A finished signal recording goes to
|
||||||
|
`files/log-outbox` (`LogOutbox`, at most 10 waiting) and is sent at once, gzipped, with the car's
|
||||||
|
token: `PUT /v1/logs/{name}`. Offline, 401 (not paired yet), 404 (a server without logs), 408,
|
||||||
|
429 or 5xx keep it, and the service's tick sends it again, at most every 2 minutes; any other
|
||||||
|
refusal drops it. The Logs tab says "Sent to the server." or how many wait and why. Server
|
||||||
|
(`logs.go`): `LOGS_DIR` on a new 1Gi volume `mg4-server-logs`, the newest 200 files and none
|
||||||
|
older than 180 days, names as the app's only, up to 2 MB sent and 8 MB unpacked, UTF-8 only; the
|
||||||
|
same name replaces itself. Reading (`GET /v1/logs`, `GET /v1/logs/{name}`) takes `LOGS_TOKEN`, a
|
||||||
|
new optional Secret value that must differ from `INGEST_TOKEN`; the car's token cannot read, the
|
||||||
|
read token cannot write. `fetch-logs` in the dev shell fetches the new ones into `logs/`
|
||||||
|
(gitignored, as are the recordings copied into the checkout's top folder), token from
|
||||||
|
`~/.config/nilsmg4/logs-token`. Tested: server unit tests (both tokens, refusals, pruning,
|
||||||
|
config); the real server code in a harness on this machine took the 08:52 recording gzipped as
|
||||||
|
the app sends it (204), refused the car's token for reading (401), and `fetch-logs` brought it
|
||||||
|
back byte for byte, once. The app's own sending could not be pointed at that harness (the app
|
||||||
|
takes https only); on the emulator the recording lands in the outbox and the Logs tab says it
|
||||||
|
waits. Not tried on the car.
|
||||||
|
- 2026-10-27 — App 2.40.4 published (`car-2.40.4`).
|
||||||
|
- 2026-10-27 — App 2.40.4: **the recorder's listening works on Android 9**. Both recordings
|
||||||
|
from the car (08:49 and 08:52, 2.40.3) said "listening to the assistance properties: not
|
||||||
|
possible": `listenToProperties` looked only for `registerCallback`, Android 10's name; the car's
|
||||||
|
car library (Android 9) has `registerListener(CarPropertyEventListener, int, float)` and
|
||||||
|
`unregisterListener`, as the app's `CarPropertyAdapter` already knew. It now takes either, and
|
||||||
|
unsubscribes property by property (Android 9's one-argument `unregisterListener` removes
|
||||||
|
entries from the list it walks and would leave every other property subscribed). A failure now
|
||||||
|
says why (`EVHardware.listenProblem`: no car service, no way to subscribe, or the exception).
|
||||||
|
Tested with a stand-in manager of Android 9's shape (`PropertyListeningTest`). Correction to
|
||||||
|
2.40.3: the ignition listener it was compared with also looks only for `registerCallback`, so
|
||||||
|
it most likely never subscribes on the car either (it reads the state once at start); left as
|
||||||
|
it is. What the polled part of the two recordings shows of the block: `0x2160A15B` (by name
|
||||||
|
the target speed) 0.0 throughout; `0x2140A15A` between 3 and 7 every few captures;
|
||||||
|
`0x2160A1A3`/`0x2160A1A4` counting up by 0.1; speeds 8–33 km/h. Not tried on the car.
|
||||||
|
- 2026-10-27 — App 2.40.3 published (`car-2.40.3`; also carries 2.40.1 and 2.40.2).
|
||||||
- 2026-10-27 — App 2.40.3: **the signal recorder listens** (owner: "is there really nothing we
|
- 2026-10-27 — App 2.40.3: **the signal recorder listens** (owner: "is there really nothing we
|
||||||
can do about the readout of the cruise control set point"). The 2.32.0 recording only polled.
|
can do about the readout of the cruise control set point"). The 2.32.0 recording only polled.
|
||||||
The head unit's `CarAdvancedAssistedDrivingManager` never polls its 108 `AAD_*` properties: it
|
The head unit's `CarAdvancedAssistedDrivingManager` never polls its 108 `AAD_*` properties: it
|
||||||
|
|||||||
+2
-2
@@ -34,8 +34,8 @@ android {
|
|||||||
applicationId "com.stinnesbeck.nilsmg4"
|
applicationId "com.stinnesbeck.nilsmg4"
|
||||||
minSdk 27
|
minSdk 27
|
||||||
targetSdk 36
|
targetSdk 36
|
||||||
versionCode 148
|
versionCode 152
|
||||||
versionName "2.40.3"
|
versionName "2.42.1"
|
||||||
|
|
||||||
// Nothing about the server ships in the APK: its URL and ingest token are entered in
|
// Nothing about the server ships in the APK: its URL and ingest token are entered in
|
||||||
// the app's Server tab (ServerConfig), and the database is only reachable by the server.
|
// the app's Server tab (ServerConfig), and the database is only reachable by the server.
|
||||||
|
|||||||
@@ -223,6 +223,7 @@ public class AbrpUploadService extends Service {
|
|||||||
consumptionTracker.sample(vehicle);
|
consumptionTracker.sample(vehicle);
|
||||||
chargeSessionTracker.sample(vehicle);
|
chargeSessionTracker.sample(vehicle);
|
||||||
consumptionCloudClient.syncIfDue(consumptionTracker, chargeSessionTracker, sampleMs);
|
consumptionCloudClient.syncIfDue(consumptionTracker, chargeSessionTracker, sampleMs);
|
||||||
|
LogOutbox.sendIfDue(this); // recordings the car could not send when they ended
|
||||||
|
|
||||||
UploadSettings settings = UploadSettings.from(prefs);
|
UploadSettings settings = UploadSettings.from(prefs);
|
||||||
// Live data goes to the server, to ABRP directly, or both; with neither set up there is
|
// Live data goes to the server, to ABRP directly, or both; with neither set up there is
|
||||||
|
|||||||
@@ -0,0 +1,156 @@
|
|||||||
|
package com.evsuite.abrp;
|
||||||
|
|
||||||
|
import android.content.Context;
|
||||||
|
import android.util.Log;
|
||||||
|
|
||||||
|
import java.io.ByteArrayOutputStream;
|
||||||
|
import java.io.File;
|
||||||
|
import java.io.FileOutputStream;
|
||||||
|
import java.io.OutputStreamWriter;
|
||||||
|
import java.io.Writer;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
import java.util.zip.GZIPOutputStream;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Files from the Logs tab (signal recordings) on their way to the car server, so they reach the
|
||||||
|
* owner without a USB stick: kept in {@code files/log-outbox} until the server has them
|
||||||
|
* ({@code PUT /v1/logs/{name}}, gzip, the ingest token in the header), sent at once and, when
|
||||||
|
* that fails, again from the service's tick, at most every {@link #RETRY_MS}. At most
|
||||||
|
* {@link #MAX_FILES} wait; the oldest goes first. Names are the app's own and say nothing about
|
||||||
|
* where the car is.
|
||||||
|
*/
|
||||||
|
final class LogOutbox {
|
||||||
|
|
||||||
|
static final String DIR = "log-outbox";
|
||||||
|
static final int MAX_FILES = 10;
|
||||||
|
static final long RETRY_MS = 2 * 60_000L;
|
||||||
|
private static final String TAG = "EVABRP.LogOutbox";
|
||||||
|
/** As the server accepts them. */
|
||||||
|
private static final Pattern NAME = Pattern.compile("[a-z0-9][a-z0-9-]{0,79}\\.txt");
|
||||||
|
|
||||||
|
/** What to do with a file after the server's answer. */
|
||||||
|
enum Outcome { SENT, DROP, KEEP }
|
||||||
|
|
||||||
|
private static long lastFailureMs;
|
||||||
|
private static String lastResult;
|
||||||
|
|
||||||
|
private LogOutbox() {}
|
||||||
|
|
||||||
|
/** SENT for a 2xx; KEEP for what may pass later (no answer, 401 before pairing, 408, 429,
|
||||||
|
* 5xx, and a 404 from a server without logs yet); DROP for any other refusal. */
|
||||||
|
static Outcome outcome(int status) {
|
||||||
|
if (status >= 200 && status < 300) return Outcome.SENT;
|
||||||
|
if (status <= 0 || status == 401 || status == 404 || status == 408 || status == 429 || status >= 500) {
|
||||||
|
return Outcome.KEEP;
|
||||||
|
}
|
||||||
|
return Outcome.DROP;
|
||||||
|
}
|
||||||
|
|
||||||
|
static boolean validName(String name) {
|
||||||
|
return name != null && NAME.matcher(name).matches();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The names to remove so that at most [max] remain: the oldest (by name, which starts
|
||||||
|
* with what they are and ends in the time) beyond the newest [max]. */
|
||||||
|
static List<String> surplus(List<String> names, int max) {
|
||||||
|
List<String> sorted = new ArrayList<>(names);
|
||||||
|
Collections.sort(sorted);
|
||||||
|
return sorted.size() <= max ? Collections.emptyList() : sorted.subList(0, sorted.size() - max);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Puts [text] in the outbox as [name]; false when it could not be written. */
|
||||||
|
static synchronized boolean add(Context context, String name, List<String> text) {
|
||||||
|
if (!validName(name)) return false;
|
||||||
|
File dir = new File(context.getFilesDir(), DIR);
|
||||||
|
if (!dir.isDirectory() && !dir.mkdirs()) return false;
|
||||||
|
File tmp = new File(dir, name + ".tmp");
|
||||||
|
try (Writer out = new OutputStreamWriter(new FileOutputStream(tmp), StandardCharsets.UTF_8)) {
|
||||||
|
for (String line : text) out.write(line + "\n");
|
||||||
|
} catch (Exception e) {
|
||||||
|
tmp.delete();
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (!tmp.renameTo(new File(dir, name))) {
|
||||||
|
tmp.delete();
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
for (String old : surplus(waiting(dir), MAX_FILES)) new File(dir, old).delete();
|
||||||
|
lastFailureMs = 0; // something new: try at once
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Sends what waits, unless the last attempt failed less than {@link #RETRY_MS} ago. Blocking:
|
||||||
|
* call it off the main thread. */
|
||||||
|
static void sendIfDue(Context context) {
|
||||||
|
synchronized (LogOutbox.class) {
|
||||||
|
if (lastFailureMs != 0 && System.currentTimeMillis() - lastFailureMs < RETRY_MS) return;
|
||||||
|
}
|
||||||
|
send(context);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Sends every waiting file, oldest first, until one fails. Blocking. */
|
||||||
|
static synchronized void send(Context context) {
|
||||||
|
File dir = new File(context.getFilesDir(), DIR);
|
||||||
|
List<String> names = waiting(dir);
|
||||||
|
if (names.isEmpty()) return;
|
||||||
|
ServerConfig config = ServerConfig.get(context);
|
||||||
|
if (!config.isConfigured()) {
|
||||||
|
lastResult = "no server set up";
|
||||||
|
lastFailureMs = System.currentTimeMillis();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
Collections.sort(names);
|
||||||
|
for (String name : names) {
|
||||||
|
File file = new File(dir, name);
|
||||||
|
int status;
|
||||||
|
try {
|
||||||
|
byte[] body = gzip(Files.readAllBytes(file.toPath()));
|
||||||
|
status = ServerHttp.send("PUT", config.url + "/v1/logs/" + name, "Bearer " + config.token,
|
||||||
|
"text/plain; charset=utf-8", "gzip", body).status;
|
||||||
|
} catch (Exception e) {
|
||||||
|
Log.w(TAG, "Log not sent: " + e.getClass().getSimpleName());
|
||||||
|
status = 0;
|
||||||
|
}
|
||||||
|
Outcome outcome = outcome(status);
|
||||||
|
if (outcome == Outcome.KEEP) {
|
||||||
|
lastResult = status == 0 ? "server not reached" : "server answered " + status;
|
||||||
|
lastFailureMs = System.currentTimeMillis();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
file.delete();
|
||||||
|
lastResult = outcome == Outcome.SENT ? "sent" : "refused by the server (" + status + ")";
|
||||||
|
Log.i(TAG, "Log " + name + ": " + lastResult);
|
||||||
|
}
|
||||||
|
lastFailureMs = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** For the Logs tab: whether the last file reached the server, or why not yet. */
|
||||||
|
static synchronized String status(Context context) {
|
||||||
|
int waiting = waiting(new File(context.getFilesDir(), DIR)).size();
|
||||||
|
if (waiting == 0) return lastResult == null ? null : "sent".equals(lastResult)
|
||||||
|
? context.getString(R.string.log_outbox_sent) : lastResult;
|
||||||
|
return context.getString(R.string.log_outbox_waiting, waiting, lastResult == null ? "…" : lastResult);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static List<String> waiting(File dir) {
|
||||||
|
String[] names = dir.list();
|
||||||
|
List<String> out = new ArrayList<>();
|
||||||
|
if (names == null) return out;
|
||||||
|
for (String n : Arrays.asList(names)) if (validName(n)) out.add(n);
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static byte[] gzip(byte[] data) throws java.io.IOException {
|
||||||
|
ByteArrayOutputStream buf = new ByteArrayOutputStream(data.length / 4 + 64);
|
||||||
|
try (GZIPOutputStream z = new GZIPOutputStream(buf)) {
|
||||||
|
z.write(data);
|
||||||
|
}
|
||||||
|
return buf.toByteArray();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -408,6 +408,10 @@ public class MainActivity extends AppCompatActivity {
|
|||||||
else SignalRecorder.start(this);
|
else SignalRecorder.start(this);
|
||||||
refreshSignalRecorder();
|
refreshSignalRecorder();
|
||||||
});
|
});
|
||||||
|
logPane.findViewById(R.id.media_probe_button).setOnClickListener(v -> {
|
||||||
|
MediaProbe.start(this);
|
||||||
|
refreshMediaProbe();
|
||||||
|
});
|
||||||
|
|
||||||
setUpPager();
|
setUpPager();
|
||||||
// Back on the page that was open when the activity was recreated (accent colour change).
|
// Back on the page that was open when the activity was recreated (accent colour change).
|
||||||
@@ -2325,8 +2329,20 @@ public class MainActivity extends AppCompatActivity {
|
|||||||
if (!status.isEmpty()) text.setText(String.join("\n", status));
|
if (!status.isEmpty()) text.setText(String.join("\n", status));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** The music-sources check: its button and its last report. */
|
||||||
|
private void refreshMediaProbe() {
|
||||||
|
MaterialButton button = logPane.findViewById(R.id.media_probe_button);
|
||||||
|
button.setEnabled(!MediaProbe.running());
|
||||||
|
TextView text = logPane.findViewById(R.id.media_probe_text);
|
||||||
|
java.util.List<String> status = MediaProbe.status(this);
|
||||||
|
text.setVisibility(status.isEmpty() ? View.GONE : View.VISIBLE);
|
||||||
|
if (status.size() > 120) status = status.subList(0, 120);
|
||||||
|
if (!status.isEmpty()) text.setText(String.join("\n", status));
|
||||||
|
}
|
||||||
|
|
||||||
private void refreshCallLog() {
|
private void refreshCallLog() {
|
||||||
refreshSignalRecorder();
|
refreshSignalRecorder();
|
||||||
|
refreshMediaProbe();
|
||||||
java.util.List<UploadLog.Entry> entries = AbrpUploadService.log().recent();
|
java.util.List<UploadLog.Entry> entries = AbrpUploadService.log().recent();
|
||||||
// Update steps first: after a failed install, they are what the driver came here for.
|
// Update steps first: after a failed install, they are what the driver came here for.
|
||||||
java.util.List<String> updates = UpdateLog.lines(this);
|
java.util.List<String> updates = UpdateLog.lines(this);
|
||||||
|
|||||||
@@ -0,0 +1,283 @@
|
|||||||
|
package com.evsuite.abrp;
|
||||||
|
|
||||||
|
import android.content.ComponentName;
|
||||||
|
import android.content.Context;
|
||||||
|
import android.content.Intent;
|
||||||
|
import android.content.pm.PackageManager;
|
||||||
|
import android.content.pm.ResolveInfo;
|
||||||
|
import android.graphics.Bitmap;
|
||||||
|
import android.media.AudioManager;
|
||||||
|
import android.media.AudioPlaybackConfiguration;
|
||||||
|
import android.media.MediaMetadata;
|
||||||
|
import android.media.session.MediaController;
|
||||||
|
import android.media.session.MediaSessionManager;
|
||||||
|
import android.media.session.PlaybackState;
|
||||||
|
import android.service.media.MediaBrowserService;
|
||||||
|
|
||||||
|
import java.text.SimpleDateFormat;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Date;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Locale;
|
||||||
|
import java.util.TreeSet;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The music-sources check on the Logs tab: where the head unit tells what is playing, before
|
||||||
|
* the Overview shows it. Three places, all read only:
|
||||||
|
* <ol>
|
||||||
|
* <li>the playback Android's audio service reports (which app plays, for what use);</li>
|
||||||
|
* <li>the active media sessions ({@code MediaSessionManager.getActiveSessions}, which needs
|
||||||
|
* MEDIA_CONTENT_CONTROL: the car build has it as the system user), with their song and
|
||||||
|
* state;</li>
|
||||||
|
* <li>every media browser service on the head unit, listed but not connected to (2.42.1:
|
||||||
|
* a connection is not harmless, see {@link #browsers}).</li>
|
||||||
|
* </ol>
|
||||||
|
* No other app's service is bound; nothing is played, paused or skipped. The report goes where
|
||||||
|
* a signal recording goes ({@link SignalRecorder#saveCopies}): the app, a USB stick, the server.
|
||||||
|
*/
|
||||||
|
final class MediaProbe {
|
||||||
|
|
||||||
|
static final String FILE = "media_probe.txt";
|
||||||
|
|
||||||
|
private static volatile boolean running;
|
||||||
|
private static long startedMs;
|
||||||
|
private static List<String> report = new ArrayList<>();
|
||||||
|
private static String result;
|
||||||
|
|
||||||
|
private MediaProbe() {}
|
||||||
|
|
||||||
|
static synchronized boolean running() {
|
||||||
|
return running;
|
||||||
|
}
|
||||||
|
|
||||||
|
static synchronized void start(Context context) {
|
||||||
|
if (running) return;
|
||||||
|
Context app = context.getApplicationContext();
|
||||||
|
running = true;
|
||||||
|
startedMs = System.currentTimeMillis();
|
||||||
|
result = null;
|
||||||
|
report = new ArrayList<>();
|
||||||
|
new Thread(() -> probe(app), "media-probe").start();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void probe(Context app) {
|
||||||
|
List<String> out = new ArrayList<>();
|
||||||
|
out.add("Media probe, " + SignalRecording.time(startedMs) + ", app " + BuildConfig.VERSION_NAME);
|
||||||
|
String saved;
|
||||||
|
try {
|
||||||
|
out.add("");
|
||||||
|
audio(app, out);
|
||||||
|
out.add("");
|
||||||
|
sessions(app, out);
|
||||||
|
out.add("");
|
||||||
|
browsers(app, out);
|
||||||
|
} catch (Throwable t) {
|
||||||
|
out.add("probe stopped: " + t.getClass().getSimpleName());
|
||||||
|
} finally {
|
||||||
|
String name = "media-probe-" + new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.US)
|
||||||
|
.format(new Date(startedMs)) + ".txt";
|
||||||
|
saved = SignalRecorder.saveCopies(app, FILE, name, out);
|
||||||
|
synchronized (MediaProbe.class) {
|
||||||
|
report = out;
|
||||||
|
result = saved;
|
||||||
|
running = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Who plays audio, as Android's audio service sees it. */
|
||||||
|
private static void audio(Context app, List<String> out) {
|
||||||
|
out.add("Audio playing (AudioManager):");
|
||||||
|
AudioManager am = (AudioManager) app.getSystemService(Context.AUDIO_SERVICE);
|
||||||
|
if (am == null) {
|
||||||
|
out.add(" no audio service");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
out.add(" music active: " + am.isMusicActive() + ", mode " + am.getMode());
|
||||||
|
} catch (RuntimeException e) {
|
||||||
|
out.add(" music active: unreadable (" + e.getClass().getSimpleName() + ")");
|
||||||
|
}
|
||||||
|
List<AudioPlaybackConfiguration> players;
|
||||||
|
try {
|
||||||
|
players = am.getActivePlaybackConfigurations();
|
||||||
|
} catch (RuntimeException e) {
|
||||||
|
out.add(" players: unreadable (" + e.getClass().getSimpleName() + ")");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (players == null || players.isEmpty()) {
|
||||||
|
out.add(" players: none");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
PackageManager pm = app.getPackageManager();
|
||||||
|
for (AudioPlaybackConfiguration p : players) {
|
||||||
|
StringBuilder line = new StringBuilder(" player: ");
|
||||||
|
try {
|
||||||
|
line.append(MediaProbeText.usage(p.getAudioAttributes().getUsage()));
|
||||||
|
} catch (RuntimeException e) {
|
||||||
|
line.append("usage ?");
|
||||||
|
}
|
||||||
|
// The app and state are system APIs: read when the platform lets the system user.
|
||||||
|
Integer uid = hiddenInt(p, "getClientUid");
|
||||||
|
if (uid != null) line.append(", uid ").append(uid).append(' ').append(packages(pm, uid));
|
||||||
|
Integer state = hiddenInt(p, "getPlayerState");
|
||||||
|
if (state != null) line.append(", ").append(MediaProbeText.playerState(state));
|
||||||
|
if (uid == null && state == null) line.append(" — ").append(MediaProbeText.clean(p.toString()));
|
||||||
|
out.add(line.toString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static Integer hiddenInt(Object target, String method) {
|
||||||
|
try {
|
||||||
|
Object v = target.getClass().getMethod(method).invoke(target);
|
||||||
|
return v instanceof Integer ? (Integer) v : null;
|
||||||
|
} catch (Throwable t) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static String packages(PackageManager pm, int uid) {
|
||||||
|
try {
|
||||||
|
String[] names = pm.getPackagesForUid(uid);
|
||||||
|
return names == null ? "(no package)" : String.join(", ", names);
|
||||||
|
} catch (RuntimeException e) {
|
||||||
|
return "(package unreadable)";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The media sessions apps publish, newest first, with their song. */
|
||||||
|
private static void sessions(Context app, List<String> out) {
|
||||||
|
out.add("Active media sessions (MediaSessionManager):");
|
||||||
|
List<MediaController> controllers;
|
||||||
|
try {
|
||||||
|
MediaSessionManager msm = (MediaSessionManager) app.getSystemService(Context.MEDIA_SESSION_SERVICE);
|
||||||
|
controllers = msm == null ? null : msm.getActiveSessions(null);
|
||||||
|
} catch (Throwable t) {
|
||||||
|
out.add(" not readable: " + t.getClass().getSimpleName() + " " + MediaProbeText.clean(t.getMessage()));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (controllers == null || controllers.isEmpty()) {
|
||||||
|
out.add(" none");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for (MediaController c : controllers) {
|
||||||
|
out.add(" session of " + safe(c::getPackageName));
|
||||||
|
describe(c, out, " ");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Every media browser service, listed only. 2.42.0 connected to each, as the car's media
|
||||||
|
* library does; on the car that was not harmless: the Bluetooth music stopped (the AOSP car
|
||||||
|
* radio's service, `com.android.car.radio/.RadioService`, answered "connecting", most likely
|
||||||
|
* taking the audio) and the Local Media Player asked for access to media. The active sessions
|
||||||
|
* above already carry the song of whatever plays, CarPlay's and Bluetooth's included, so no
|
||||||
|
* service is bound any more.
|
||||||
|
*/
|
||||||
|
private static void browsers(Context app, List<String> out) {
|
||||||
|
out.add("Media browser services (" + MediaBrowserService.SERVICE_INTERFACE + "), listed, not connected to:");
|
||||||
|
try {
|
||||||
|
List<ResolveInfo> found = app.getPackageManager()
|
||||||
|
.queryIntentServices(new Intent(MediaBrowserService.SERVICE_INTERFACE), 0);
|
||||||
|
if (found == null || found.isEmpty()) {
|
||||||
|
out.add(" none");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for (ResolveInfo ri : found) {
|
||||||
|
if (ri.serviceInfo == null) continue;
|
||||||
|
out.add(" " + new ComponentName(ri.serviceInfo.packageName, ri.serviceInfo.name)
|
||||||
|
.flattenToShortString());
|
||||||
|
}
|
||||||
|
} catch (RuntimeException e) {
|
||||||
|
out.add(" list not readable: " + e.getClass().getSimpleName());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A session's state and everything its song's metadata holds. */
|
||||||
|
private static void describe(MediaController c, List<String> out, String indent) {
|
||||||
|
try {
|
||||||
|
PlaybackState s = c.getPlaybackState();
|
||||||
|
out.add(indent + "state: " + (s == null ? "(none)"
|
||||||
|
: MediaProbeText.playbackState(s.getState()) + ", at "
|
||||||
|
+ MediaProbeText.duration(s.getPosition()) + ", actions 0x"
|
||||||
|
+ Long.toHexString(s.getActions())));
|
||||||
|
} catch (Throwable t) {
|
||||||
|
out.add(indent + "state: unreadable (" + t.getClass().getSimpleName() + ")");
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
MediaController.PlaybackInfo info = c.getPlaybackInfo();
|
||||||
|
if (info != null) {
|
||||||
|
out.add(indent + "plays " + (info.getPlaybackType() == MediaController.PlaybackInfo.PLAYBACK_TYPE_REMOTE
|
||||||
|
? "remotely" : "locally") + ", for "
|
||||||
|
+ MediaProbeText.usage(info.getAudioAttributes().getUsage()));
|
||||||
|
}
|
||||||
|
} catch (Throwable ignored) {
|
||||||
|
// Not every session says.
|
||||||
|
}
|
||||||
|
MediaMetadata m;
|
||||||
|
try {
|
||||||
|
m = c.getMetadata();
|
||||||
|
} catch (Throwable t) {
|
||||||
|
out.add(indent + "song: unreadable (" + t.getClass().getSimpleName() + ")");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (m == null) {
|
||||||
|
out.add(indent + "song: (no metadata)");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for (String key : new TreeSet<>(m.keySet())) {
|
||||||
|
String shortKey = key.startsWith("android.media.metadata.")
|
||||||
|
? key.substring("android.media.metadata.".length()) : key;
|
||||||
|
out.add(indent + shortKey + ": " + value(m, key));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** One metadata value: a picture by its size, text cleaned, anything else as a number. */
|
||||||
|
private static String value(MediaMetadata m, String key) {
|
||||||
|
try {
|
||||||
|
Bitmap bitmap = m.getBitmap(key);
|
||||||
|
if (bitmap != null) return "picture " + bitmap.getWidth() + "×" + bitmap.getHeight();
|
||||||
|
} catch (Throwable ignored) {
|
||||||
|
// not a picture
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
CharSequence text = m.getText(key);
|
||||||
|
if (text != null) return MediaProbeText.clean(text);
|
||||||
|
} catch (Throwable ignored) {
|
||||||
|
// not text
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
if (key.equals(MediaMetadata.METADATA_KEY_DURATION)) {
|
||||||
|
return MediaProbeText.duration(m.getLong(key));
|
||||||
|
}
|
||||||
|
if (m.getRating(key) != null) return "rating";
|
||||||
|
return Long.toString(m.getLong(key));
|
||||||
|
} catch (Throwable t) {
|
||||||
|
return "?";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static String safe(java.util.concurrent.Callable<String> read) {
|
||||||
|
try {
|
||||||
|
return MediaProbeText.clean(read.call());
|
||||||
|
} catch (Throwable t) {
|
||||||
|
return "?";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** What the Logs tab shows: the state, then the report. */
|
||||||
|
static synchronized List<String> status(Context context) {
|
||||||
|
List<String> lines = new ArrayList<>();
|
||||||
|
if (startedMs == 0) return lines;
|
||||||
|
if (running) {
|
||||||
|
lines.add(context.getString(R.string.media_probe_running));
|
||||||
|
return lines;
|
||||||
|
}
|
||||||
|
lines.add(context.getString(R.string.media_probe_done, SignalRecording.time(startedMs),
|
||||||
|
result == null ? "…" : result));
|
||||||
|
String sent = LogOutbox.status(context);
|
||||||
|
if (sent != null) lines.add(sent);
|
||||||
|
lines.addAll(report.subList(Math.min(1, report.size()), report.size()));
|
||||||
|
return lines;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
package com.evsuite.abrp;
|
||||||
|
|
||||||
|
import java.util.Locale;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The words of {@link MediaProbe}'s report: Android's numbers for playback and audio states as
|
||||||
|
* names, and text from other apps made safe for one line. Android-free and unit-tested.
|
||||||
|
*/
|
||||||
|
final class MediaProbeText {
|
||||||
|
|
||||||
|
/** Longest text kept from another app (a title, an artist). */
|
||||||
|
static final int MAX_TEXT = 120;
|
||||||
|
|
||||||
|
private MediaProbeText() {}
|
||||||
|
|
||||||
|
/** Another app's text on one line: control characters out, at most {@link #MAX_TEXT}. */
|
||||||
|
static String clean(CharSequence text) {
|
||||||
|
if (text == null) return "(none)";
|
||||||
|
StringBuilder sb = new StringBuilder();
|
||||||
|
for (int i = 0; i < text.length() && sb.length() < MAX_TEXT; i++) {
|
||||||
|
char c = text.charAt(i);
|
||||||
|
sb.append(Character.isISOControl(c) ? ' ' : c);
|
||||||
|
}
|
||||||
|
String s = sb.toString().trim();
|
||||||
|
if (text.length() > MAX_TEXT) s += "…";
|
||||||
|
return s.isEmpty() ? "(empty)" : s;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@code android.media.session.PlaybackState} STATE_*. */
|
||||||
|
static String playbackState(int state) {
|
||||||
|
switch (state) {
|
||||||
|
case 0: return "none";
|
||||||
|
case 1: return "stopped";
|
||||||
|
case 2: return "paused";
|
||||||
|
case 3: return "playing";
|
||||||
|
case 4: return "fast forwarding";
|
||||||
|
case 5: return "rewinding";
|
||||||
|
case 6: return "buffering";
|
||||||
|
case 7: return "error";
|
||||||
|
case 8: return "connecting";
|
||||||
|
case 9: return "skipping to previous";
|
||||||
|
case 10: return "skipping to next";
|
||||||
|
case 11: return "skipping to queue item";
|
||||||
|
default: return "state " + state;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@code android.media.AudioAttributes} USAGE_*. */
|
||||||
|
static String usage(int usage) {
|
||||||
|
switch (usage) {
|
||||||
|
case 0: return "unknown";
|
||||||
|
case 1: return "media";
|
||||||
|
case 2: return "voice call";
|
||||||
|
case 3: return "call signalling";
|
||||||
|
case 4: return "alarm";
|
||||||
|
case 5: return "notification";
|
||||||
|
case 6: return "ringtone";
|
||||||
|
case 7: case 8: case 9: case 10: return "notification (" + usage + ")";
|
||||||
|
case 11: return "accessibility";
|
||||||
|
case 12: return "navigation guidance";
|
||||||
|
case 13: return "sonification";
|
||||||
|
case 14: return "game";
|
||||||
|
case 15: return "virtual source";
|
||||||
|
case 16: return "assistant";
|
||||||
|
default: return "usage " + usage;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@code android.media.AudioPlaybackConfiguration} PLAYER_STATE_*. */
|
||||||
|
static String playerState(int state) {
|
||||||
|
switch (state) {
|
||||||
|
case -1: return "unknown";
|
||||||
|
case 0: return "released";
|
||||||
|
case 1: return "idle";
|
||||||
|
case 2: return "started";
|
||||||
|
case 3: return "paused";
|
||||||
|
case 4: return "stopped";
|
||||||
|
default: return "state " + state;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A position or duration in milliseconds as m:ss; negative (unknown) as "?". */
|
||||||
|
static String duration(long ms) {
|
||||||
|
if (ms < 0) return "?";
|
||||||
|
long s = ms / 1000;
|
||||||
|
return String.format(Locale.US, "%d:%02d", s / 60, s % 60);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -59,6 +59,12 @@ final class ServerHttp {
|
|||||||
*/
|
*/
|
||||||
static Response send(String method, String url, String authorization, String contentType, byte[] body)
|
static Response send(String method, String url, String authorization, String contentType, byte[] body)
|
||||||
throws Exception {
|
throws Exception {
|
||||||
|
return send(method, url, authorization, contentType, null, body);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** As above, with a {@code Content-Encoding} ({@code "gzip"}) for the body, or null. */
|
||||||
|
static Response send(String method, String url, String authorization, String contentType,
|
||||||
|
String contentEncoding, byte[] body) throws Exception {
|
||||||
HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
|
HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
|
||||||
try {
|
try {
|
||||||
connection.setRequestMethod(method);
|
connection.setRequestMethod(method);
|
||||||
@@ -69,6 +75,7 @@ final class ServerHttp {
|
|||||||
connection.setDoOutput(true);
|
connection.setDoOutput(true);
|
||||||
connection.setFixedLengthStreamingMode(body.length);
|
connection.setFixedLengthStreamingMode(body.length);
|
||||||
connection.setRequestProperty("Content-Type", contentType);
|
connection.setRequestProperty("Content-Type", contentType);
|
||||||
|
if (contentEncoding != null) connection.setRequestProperty("Content-Encoding", contentEncoding);
|
||||||
try (OutputStream out = connection.getOutputStream()) { out.write(body); }
|
try (OutputStream out = connection.getOutputStream()) { out.write(body); }
|
||||||
}
|
}
|
||||||
int status = connection.getResponseCode();
|
int status = connection.getResponseCode();
|
||||||
|
|||||||
@@ -39,8 +39,8 @@ import java.util.Map;
|
|||||||
* A full capture is far heavier than the Overview's reading, so the next one waits at least
|
* A full capture is far heavier than the Overview's reading, so the next one waits at least
|
||||||
* {@link #MIN_INTERVAL_MS} and at least as long as the last one took: the recorder uses at most
|
* {@link #MIN_INTERVAL_MS} and at least as long as the last one took: the recorder uses at most
|
||||||
* half the time. It runs on its own thread, on after the app leaves the screen (the service
|
* half the time. It runs on its own thread, on after the app leaves the screen (the service
|
||||||
* keeps the process), and stops by itself. At the end the recording goes to the app's storage
|
* keeps the process), and stops by itself. At the end the recording goes to the app's storage,
|
||||||
* and to the app's folder on every USB stick plugged in.
|
* to the app's folder on every USB stick plugged in, and to the car server ({@link LogOutbox}).
|
||||||
*/
|
*/
|
||||||
final class SignalRecorder {
|
final class SignalRecorder {
|
||||||
|
|
||||||
@@ -103,7 +103,8 @@ final class SignalRecorder {
|
|||||||
rec.note(System.currentTimeMillis(), "listening failed: " + t.getClass().getSimpleName());
|
rec.note(System.currentTimeMillis(), "listening failed: " + t.getClass().getSimpleName());
|
||||||
}
|
}
|
||||||
rec.note(System.currentTimeMillis(), listening == null
|
rec.note(System.currentTimeMillis(), listening == null
|
||||||
? "listening to the assistance properties: not possible (no car service)"
|
? "listening to the assistance properties: not possible ("
|
||||||
|
+ EVHardware.INSTANCE.getListenProblem() + ")"
|
||||||
: "listening to " + listening.getSubscribed() + " assistance properties ("
|
: "listening to " + listening.getSubscribed() + " assistance properties ("
|
||||||
+ listening.getRefused() + " refused)");
|
+ listening.getRefused() + " refused)");
|
||||||
try {
|
try {
|
||||||
@@ -166,10 +167,19 @@ final class SignalRecorder {
|
|||||||
text.add("");
|
text.add("");
|
||||||
text.add("Everything, in order:");
|
text.add("Everything, in order:");
|
||||||
text.addAll(rec.lines());
|
text.addAll(rec.lines());
|
||||||
List<String> places = new ArrayList<>();
|
|
||||||
if (write(new File(app.getFilesDir(), FILE), text)) places.add("app");
|
|
||||||
String name = "signal-recording-" + new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.US)
|
String name = "signal-recording-" + new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.US)
|
||||||
.format(new Date(startedMs)) + ".txt";
|
.format(new Date(startedMs)) + ".txt";
|
||||||
|
return saveCopies(app, FILE, name, text);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Writes a report to the app's storage ({@code appFile}), to the app's folder on every USB
|
||||||
|
* stick plugged in ({@code name}) and to the car server; says where it went. Shared with
|
||||||
|
* {@link MediaProbe}.
|
||||||
|
*/
|
||||||
|
static String saveCopies(Context app, String appFile, String name, List<String> text) {
|
||||||
|
List<String> places = new ArrayList<>();
|
||||||
|
if (write(new File(app.getFilesDir(), appFile), text)) places.add("app");
|
||||||
File[] dirs = app.getExternalFilesDirs(null);
|
File[] dirs = app.getExternalFilesDirs(null);
|
||||||
for (File dir : dirs == null ? new File[0] : dirs) {
|
for (File dir : dirs == null ? new File[0] : dirs) {
|
||||||
try {
|
try {
|
||||||
@@ -180,6 +190,12 @@ final class SignalRecorder {
|
|||||||
// A volume that cannot say what it is gets nothing.
|
// A volume that cannot say what it is gets nothing.
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// And to the server, so it reaches the owner without a stick; the service sends it again
|
||||||
|
// later when the car is offline now.
|
||||||
|
if (LogOutbox.add(app, name, text)) {
|
||||||
|
LogOutbox.send(app);
|
||||||
|
places.add("for the server");
|
||||||
|
}
|
||||||
return places.isEmpty() ? "not saved" : "saved: " + String.join(", ", places);
|
return places.isEmpty() ? "not saved" : "saved: " + String.join(", ", places);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -203,6 +219,8 @@ final class SignalRecorder {
|
|||||||
} else {
|
} else {
|
||||||
out.add(context.getString(R.string.signal_recorder_done, SignalRecording.time(startedMs),
|
out.add(context.getString(R.string.signal_recorder_done, SignalRecording.time(startedMs),
|
||||||
recording.captures(), recording.events(), result == null ? "…" : result));
|
recording.captures(), recording.events(), result == null ? "…" : result));
|
||||||
|
String sent = LogOutbox.status(context);
|
||||||
|
if (sent != null) out.add(sent);
|
||||||
}
|
}
|
||||||
// Steering-wheel keys and the like first: few, and each one a lead.
|
// Steering-wheel keys and the like first: few, and each one a lead.
|
||||||
List<String> notes = recording.notes();
|
List<String> notes = recording.notes();
|
||||||
|
|||||||
@@ -8,6 +8,13 @@
|
|||||||
<com.google.android.material.button.MaterialButton android:id="@+id/signal_record_button" android:layout_width="match_parent" android:layout_height="72dp" android:layout_marginTop="16dp" android:text="@string/btn_signal_record" style="@style/Widget.EV.Button.Outlined" />
|
<com.google.android.material.button.MaterialButton android:id="@+id/signal_record_button" android:layout_width="match_parent" android:layout_height="72dp" android:layout_marginTop="16dp" android:text="@string/btn_signal_record" style="@style/Widget.EV.Button.Outlined" />
|
||||||
<TextView android:id="@+id/signal_record_text" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="16dp" android:textAppearance="@style/Text.EV.Body" android:fontFamily="monospace" android:textSize="17sp" android:lineSpacingExtra="8dp" android:textIsSelectable="true" android:visibility="gone" />
|
<TextView android:id="@+id/signal_record_text" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="16dp" android:textAppearance="@style/Text.EV.Body" android:fontFamily="monospace" android:textSize="17sp" android:lineSpacingExtra="8dp" android:textIsSelectable="true" android:visibility="gone" />
|
||||||
</LinearLayout>
|
</LinearLayout>
|
||||||
|
<!-- The music-sources check (MediaProbe): where the head unit tells what is playing. -->
|
||||||
|
<LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:orientation="vertical" android:paddingStart="24dp" android:paddingEnd="24dp" android:paddingTop="16dp" android:paddingBottom="16dp" android:layout_marginBottom="16dp" android:background="@drawable/bg_glass">
|
||||||
|
<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@string/label_media_probe" android:textAppearance="@style/Text.EV.Eyebrow" />
|
||||||
|
<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="12dp" android:text="@string/media_probe_hint" android:textAppearance="@style/Text.EV.Secondary" />
|
||||||
|
<com.google.android.material.button.MaterialButton android:id="@+id/media_probe_button" android:layout_width="match_parent" android:layout_height="72dp" android:layout_marginTop="16dp" android:text="@string/btn_media_probe" style="@style/Widget.EV.Button.Outlined" />
|
||||||
|
<TextView android:id="@+id/media_probe_text" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="16dp" android:textAppearance="@style/Text.EV.Body" android:fontFamily="monospace" android:textSize="17sp" android:lineSpacingExtra="8dp" android:textIsSelectable="true" android:visibility="gone" />
|
||||||
|
</LinearLayout>
|
||||||
<LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:orientation="vertical" android:paddingStart="24dp" android:paddingEnd="24dp" android:paddingTop="16dp" android:paddingBottom="16dp" android:background="@drawable/bg_glass">
|
<LinearLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:orientation="vertical" android:paddingStart="24dp" android:paddingEnd="24dp" android:paddingTop="16dp" android:paddingBottom="16dp" android:background="@drawable/bg_glass">
|
||||||
<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@string/label_call_log" android:textAppearance="@style/Text.EV.Eyebrow" />
|
<TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:text="@string/label_call_log" android:textAppearance="@style/Text.EV.Eyebrow" />
|
||||||
<com.google.android.material.button.MaterialButton android:id="@+id/flush_now_button" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="16dp" android:text="@string/btn_flush_now" app:icon="@drawable/ic_refresh" app:iconGravity="textStart" style="@style/Widget.EV.Button.Outlined" />
|
<com.google.android.material.button.MaterialButton android:id="@+id/flush_now_button" android:layout_width="match_parent" android:layout_height="wrap_content" android:layout_marginTop="16dp" android:text="@string/btn_flush_now" app:icon="@drawable/ic_refresh" app:iconGravity="textStart" style="@style/Widget.EV.Button.Outlined" />
|
||||||
|
|||||||
@@ -223,11 +223,18 @@
|
|||||||
<string name="drive_mode_unreadable">Not changed: speed or gear unreadable.</string>
|
<string name="drive_mode_unreadable">Not changed: speed or gear unreadable.</string>
|
||||||
<string name="drive_mode_unknown">an unknown mode (%1$s)</string>
|
<string name="drive_mode_unknown">an unknown mode (%1$s)</string>
|
||||||
<string name="label_signal_recorder">Signal recorder</string>
|
<string name="label_signal_recorder">Signal recorder</string>
|
||||||
<string name="signal_recorder_hint">Records every value the head unit offers for 3 minutes, listens to the driver-assistance properties for every change they report, and notes the steering-wheel keys; then lists what changed, the rarest first. To find a signal: start it, note the times you switch the feature on and off or change it, and look for the values that changed then. With a USB stick plugged in, the whole recording is saved on it too (Android/data/…/files).</string>
|
<string name="signal_recorder_hint">Records every value the head unit offers for 3 minutes, listens to the driver-assistance properties for every change they report, and notes the steering-wheel keys; then lists what changed, the rarest first. To find a signal: start it, note the times you switch the feature on and off or change it, and look for the values that changed then. The whole recording goes to your server (later, if the car is offline), and with a USB stick plugged in it is saved on it too (Android/data/…/files).</string>
|
||||||
<string name="btn_signal_record">Record 3 minutes</string>
|
<string name="btn_signal_record">Record 3 minutes</string>
|
||||||
<string name="btn_signal_stop">Stop recording</string>
|
<string name="btn_signal_stop">Stop recording</string>
|
||||||
<string name="signal_recorder_running">Recording: %1$d:%2$02d of 3:00, %3$d captures, %4$d change events heard. Keys reported, then assistance properties heard, then values changed so far, the rarest first:</string>
|
<string name="signal_recorder_running">Recording: %1$d:%2$02d of 3:00, %3$d captures, %4$d change events heard. Keys reported, then assistance properties heard, then values changed so far, the rarest first:</string>
|
||||||
<string name="signal_recorder_done">Recording from %1$s: %2$d captures, %3$d change events heard, %4$s. Keys reported, then assistance properties heard, then values changed, the rarest first:</string>
|
<string name="signal_recorder_done">Recording from %1$s: %2$d captures, %3$d change events heard, %4$s. Keys reported, then assistance properties heard, then values changed, the rarest first:</string>
|
||||||
|
<string name="label_media_probe">Music sources</string>
|
||||||
|
<string name="media_probe_hint">Finds where the head unit tells what is playing: the playback Android reports and the media sessions apps publish (CarPlay, Bluetooth, radio, USB), each with its song, and the head unit\'s media services by name. Play something first and check once for each source. Like a recording, the result goes to your server and to a USB stick. It only reads and connects to no other app: nothing is played, paused or skipped.</string>
|
||||||
|
<string name="btn_media_probe">Check music sources</string>
|
||||||
|
<string name="media_probe_running">Checking… (up to a minute)</string>
|
||||||
|
<string name="media_probe_done">Check from %1$s, %2$s:</string>
|
||||||
|
<string name="log_outbox_sent">Sent to the server.</string>
|
||||||
|
<string name="log_outbox_waiting">Not on the server yet (%1$d waiting: %2$s); it is sent again every 2 minutes.</string>
|
||||||
<string name="call_log_empty">No upload attempted yet.</string>
|
<string name="call_log_empty">No upload attempted yet.</string>
|
||||||
<string name="update_log_title">Updates, newest first:</string>
|
<string name="update_log_title">Updates, newest first:</string>
|
||||||
<string name="btn_flush_now">Upload now</string>
|
<string name="btn_flush_now">Upload now</string>
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
package com.evsuite.abrp;
|
||||||
|
|
||||||
|
import static org.junit.Assert.assertEquals;
|
||||||
|
import static org.junit.Assert.assertFalse;
|
||||||
|
import static org.junit.Assert.assertTrue;
|
||||||
|
|
||||||
|
import org.junit.Test;
|
||||||
|
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.Collections;
|
||||||
|
|
||||||
|
public class LogOutboxTest {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void whatTheServerSaysDecidesTheFile() {
|
||||||
|
assertEquals(LogOutbox.Outcome.SENT, LogOutbox.outcome(204));
|
||||||
|
assertEquals(LogOutbox.Outcome.SENT, LogOutbox.outcome(200));
|
||||||
|
// Worth another try: no answer, not paired yet, a server without logs yet, busy, broken.
|
||||||
|
for (int status : new int[] {0, 401, 404, 408, 429, 500, 502, 503}) {
|
||||||
|
assertEquals(String.valueOf(status), LogOutbox.Outcome.KEEP, LogOutbox.outcome(status));
|
||||||
|
}
|
||||||
|
// Refused for good: it would never pass.
|
||||||
|
for (int status : new int[] {400, 403, 413, 415}) {
|
||||||
|
assertEquals(String.valueOf(status), LogOutbox.Outcome.DROP, LogOutbox.outcome(status));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void namesAreTheServersKind() {
|
||||||
|
assertTrue(LogOutbox.validName("signal-recording-20261027-085240.txt"));
|
||||||
|
assertFalse(LogOutbox.validName("signal-recording-20261027-085240.txt.tmp"));
|
||||||
|
assertFalse(LogOutbox.validName("../escape.txt"));
|
||||||
|
assertFalse(LogOutbox.validName("Upper.txt"));
|
||||||
|
assertFalse(LogOutbox.validName(null));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void theOldestGoBeyondTheLimit() {
|
||||||
|
assertEquals(Arrays.asList("signal-recording-20261027-084921.txt"),
|
||||||
|
LogOutbox.surplus(Arrays.asList("signal-recording-20261027-085240.txt",
|
||||||
|
"signal-recording-20261027-084921.txt", "signal-recording-20261027-090000.txt"), 2));
|
||||||
|
assertEquals(Collections.emptyList(),
|
||||||
|
LogOutbox.surplus(Collections.singletonList("signal-recording-20261027-085240.txt"), 2));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
package com.evsuite.abrp;
|
||||||
|
|
||||||
|
import static org.junit.Assert.assertEquals;
|
||||||
|
import static org.junit.Assert.assertTrue;
|
||||||
|
|
||||||
|
import org.junit.Test;
|
||||||
|
|
||||||
|
public class MediaProbeTextTest {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void anotherAppsTextStaysOnOneLine() {
|
||||||
|
assertEquals("Song Title", MediaProbeText.clean("Song\nTitle"));
|
||||||
|
assertEquals("(none)", MediaProbeText.clean(null));
|
||||||
|
assertEquals("(empty)", MediaProbeText.clean(" \t"));
|
||||||
|
String longText = new String(new char[500]).replace('\0', 'a');
|
||||||
|
String cleaned = MediaProbeText.clean(longText);
|
||||||
|
assertEquals(MediaProbeText.MAX_TEXT + 1, cleaned.length());
|
||||||
|
assertTrue(cleaned.endsWith("…"));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void androidsNumbersHaveNames() {
|
||||||
|
assertEquals("playing", MediaProbeText.playbackState(3));
|
||||||
|
assertEquals("paused", MediaProbeText.playbackState(2));
|
||||||
|
assertEquals("state 99", MediaProbeText.playbackState(99));
|
||||||
|
assertEquals("media", MediaProbeText.usage(1));
|
||||||
|
assertEquals("navigation guidance", MediaProbeText.usage(12));
|
||||||
|
assertEquals("assistant", MediaProbeText.usage(16));
|
||||||
|
assertEquals("started", MediaProbeText.playerState(2));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void durationsAsMinutes() {
|
||||||
|
assertEquals("3:25", MediaProbeText.duration(205_400));
|
||||||
|
assertEquals("0:00", MediaProbeText.duration(0));
|
||||||
|
assertEquals("?", MediaProbeText.duration(-1));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,6 +2,7 @@
|
|||||||
<!-- Unstable channel only. The stable build has no self-update path, so neither the install
|
<!-- Unstable channel only. The stable build has no self-update path, so neither the install
|
||||||
permission nor the session result receiver belongs in the main manifest. -->
|
permission nor the session result receiver belongs in the main manifest. -->
|
||||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
xmlns:tools="http://schemas.android.com/tools"
|
||||||
android:sharedUserId="android.uid.system">
|
android:sharedUserId="android.uid.system">
|
||||||
|
|
||||||
<!-- Needed for the PackageInstaller session that replaced `pm install -r`. On this
|
<!-- Needed for the PackageInstaller session that replaced `pm install -r`. On this
|
||||||
@@ -11,6 +12,11 @@
|
|||||||
<uses-permission
|
<uses-permission
|
||||||
android:name="android.permission.WRITE_EXTERNAL_STORAGE"
|
android:name="android.permission.WRITE_EXTERNAL_STORAGE"
|
||||||
android:maxSdkVersion="28" />
|
android:maxSdkVersion="28" />
|
||||||
|
<!-- Lists other apps' media sessions (MediaProbe, the Logs tab's music-sources check).
|
||||||
|
A platform permission: the system user has it; elsewhere the check says it cannot. -->
|
||||||
|
<uses-permission
|
||||||
|
android:name="android.permission.MEDIA_CONTENT_CONTROL"
|
||||||
|
tools:ignore="ProtectedPermissions" />
|
||||||
|
|
||||||
<application>
|
<application>
|
||||||
<provider
|
<provider
|
||||||
|
|||||||
@@ -161,10 +161,46 @@
|
|||||||
echo "Published $tag ($(basename "$apk") and .sha256) at $forge/$repo/releases/tag/$tag"
|
echo "Published $tag ($(basename "$apk") and .sha256) at $forge/$repo/releases/tag/$tag"
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
|
# Fetches the files the car sent from its Logs tab (signal recordings) from the car
|
||||||
|
# server into logs/ (gitignored), those not there yet. Needs the server's LOGS_TOKEN,
|
||||||
|
# from $LOGS_TOKEN or ~/.config/nilsmg4/logs-token; sent in a header, never printed.
|
||||||
|
fetchLogs = pkgs.writeShellApplication {
|
||||||
|
name = "fetch-logs";
|
||||||
|
runtimeInputs = [ pkgs.curl pkgs.jq pkgs.coreutils pkgs.git ];
|
||||||
|
text = ''
|
||||||
|
server=''${SERVER_URL:-https://car.k8s.stinnesbeck.com}
|
||||||
|
token=''${LOGS_TOKEN:-}
|
||||||
|
if [ -z "$token" ] && [ -f "$HOME/.config/nilsmg4/logs-token" ]; then
|
||||||
|
token=$(tr -d '[:space:]' < "$HOME/.config/nilsmg4/logs-token")
|
||||||
|
fi
|
||||||
|
if [ -z "$token" ]; then
|
||||||
|
echo "fetch-logs: no token. Put the server's LOGS_TOKEN in ~/.config/nilsmg4/logs-token (or \$LOGS_TOKEN)." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
root=$(git rev-parse --show-toplevel)
|
||||||
|
mkdir -p "$root/logs"
|
||||||
|
auth=(-H "Authorization: Bearer $token")
|
||||||
|
fetched=0
|
||||||
|
while IFS= read -r name; do
|
||||||
|
# The server only stores such names; anything else is not a path to write to.
|
||||||
|
if ! [[ "$name" =~ ^[a-z0-9][a-z0-9-]{0,79}\.txt$ ]]; then
|
||||||
|
echo "fetch-logs: skipping an unexpected name" >&2
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
[ -f "$root/logs/$name" ] && continue
|
||||||
|
curl -sSf "''${auth[@]}" -o "$root/logs/$name.part" "$server/v1/logs/$name"
|
||||||
|
mv "$root/logs/$name.part" "$root/logs/$name"
|
||||||
|
echo "logs/$name"
|
||||||
|
fetched=$((fetched + 1))
|
||||||
|
done < <(curl -sSf "''${auth[@]}" "$server/v1/logs" | jq -r '.logs[].name')
|
||||||
|
echo "fetch-logs: $fetched new"
|
||||||
|
'';
|
||||||
|
};
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
default = pkgs.mkShell {
|
default = pkgs.mkShell {
|
||||||
packages = [ jdk android.androidsdk buildCar publishCar pkgs.go pkgs.gopls pkgs.govulncheck pkgs.influxdb2-server pkgs.influxdb2-cli ];
|
packages = [ jdk android.androidsdk buildCar publishCar fetchLogs pkgs.go pkgs.gopls pkgs.govulncheck pkgs.influxdb2-server pkgs.influxdb2-cli ];
|
||||||
|
|
||||||
ANDROID_HOME = sdk;
|
ANDROID_HOME = sdk;
|
||||||
ANDROID_SDK_ROOT = sdk;
|
ANDROID_SDK_ROOT = sdk;
|
||||||
@@ -179,6 +215,7 @@
|
|||||||
echo " ./gradlew assembleUnstableDebug # build that can update itself (OTA)"
|
echo " ./gradlew assembleUnstableDebug # build that can update itself (OTA)"
|
||||||
echo " build-car # unstable build signed for the car"
|
echo " build-car # unstable build signed for the car"
|
||||||
echo " publish-car # publish it for the in-app updater"
|
echo " publish-car # publish it for the in-app updater"
|
||||||
|
echo " fetch-logs # the car's recordings from the server, into logs/"
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
});
|
});
|
||||||
|
|||||||
+11
-2
@@ -7,7 +7,7 @@ is applied automatically. Apply them yourself.
|
|||||||
|---|---|
|
|---|---|
|
||||||
| `namespace.yaml` | Namespace `mg4` |
|
| `namespace.yaml` | Namespace `mg4` |
|
||||||
| `influxdb.yaml` | InfluxDB 2.7.12 StatefulSet (10Gi PVC, default storage class), cluster-internal Service, NetworkPolicy admitting only the server and Grafana |
|
| `influxdb.yaml` | InfluxDB 2.7.12 StatefulSet (10Gi PVC, default storage class), cluster-internal Service, NetworkPolicy admitting only the server and Grafana |
|
||||||
| `server.yaml` | Go server Deployment (1 replica, non-root, read-only root filesystem) and Service |
|
| `server.yaml` | Go server Deployment (1 replica, non-root, read-only root filesystem), Service, and two 1Gi PVCs: the map tile cache and the logs the car sends |
|
||||||
| `grafana.yaml` | Grafana 13.2.3 Deployment (1Gi PVC), Service; datasource and dashboards provisioned |
|
| `grafana.yaml` | Grafana 13.2.3 Deployment (1Gi PVC), Service; datasource and dashboards provisioned |
|
||||||
| `grafana/` | The provisioned InfluxDB datasource and the MG4 dashboards (Live, Consumption, Charging) |
|
| `grafana/` | The provisioned InfluxDB datasource and the MG4 dashboards (Live, Consumption, Charging) |
|
||||||
| `ingress.yaml` | Traefik `IngressRoute`s for car.k8s.stinnesbeck.com and Grafana, TLS from Traefik's default certificate |
|
| `ingress.yaml` | Traefik `IngressRoute`s for car.k8s.stinnesbeck.com and Grafana, TLS from Traefik's default certificate |
|
||||||
@@ -22,7 +22,8 @@ is applied automatically. Apply them yourself.
|
|||||||
covered by Traefik's default certificate.
|
covered by Traefik's default certificate.
|
||||||
2. **Create the Secrets.** `cp k8s/secrets/secrets.example.yaml k8s/secrets/secrets.yaml` (gitignored), replace
|
2. **Create the Secrets.** `cp k8s/secrets/secrets.example.yaml k8s/secrets/secrets.yaml` (gitignored), replace
|
||||||
every `CHANGE-ME` there (`openssl rand -hex 32`): `influxdb-auth`, `mg4-server` (ingest token,
|
every `CHANGE-ME` there (`openssl rand -hex 32`): `influxdb-auth`, `mg4-server` (ingest token,
|
||||||
approval password for pairing, the forge token for app updates) and `grafana-admin`.
|
approval password for pairing, the forge token for app updates, the token that reads the
|
||||||
|
car's logs) and `grafana-admin`.
|
||||||
Keep the template itself on placeholders only.
|
Keep the template itself on placeholders only.
|
||||||
3. **Registry access.** The `mg4-server` package on git.stinnesbeck.com is public, so no pull
|
3. **Registry access.** The `mg4-server` package on git.stinnesbeck.com is public, so no pull
|
||||||
secret is needed. If you make it private, add an `imagePullSecrets` entry to `server.yaml`.
|
secret is needed. If you make it private, add an `imagePullSecrets` entry to `server.yaml`.
|
||||||
@@ -54,6 +55,14 @@ the forge that can only **read** the `nils/mg4` repository, put it there, apply
|
|||||||
restart the server. Without it, updates are off (the car's updater gets a 404). `FORGE_URL`
|
restart the server. Without it, updates are off (the car's updater gets a 404). `FORGE_URL`
|
||||||
and `FORGE_REPO` are set in `server.yaml`.
|
and `FORGE_REPO` are set in `server.yaml`.
|
||||||
|
|
||||||
|
## Logs from the car
|
||||||
|
|
||||||
|
The car sends its signal recordings to the server (`server/README.md`, "Logs from the car"),
|
||||||
|
which keeps them on the `mg4-server-logs` volume at `LOGS_DIR`. Reading them needs `LOGS_TOKEN`
|
||||||
|
from the `mg4-server` Secret: `openssl rand -hex 32`, put it there (it must differ from
|
||||||
|
`INGEST_TOKEN`), apply the Secret and restart the server. For `fetch-logs` on your machine, put
|
||||||
|
the same value in `~/.config/nilsmg4/logs-token`. Without it the car still sends; nobody can read.
|
||||||
|
|
||||||
## Agent access
|
## Agent access
|
||||||
|
|
||||||
[`agent-access/`](agent-access/README.md) creates a service account limited to the `mg4`
|
[`agent-access/`](agent-access/README.md) creates a service account limited to the `mg4`
|
||||||
|
|||||||
@@ -30,6 +30,9 @@ stringData:
|
|||||||
# relays the releases to the car; k8s/README.md, "App updates"). Leave it empty to switch
|
# relays the releases to the car; k8s/README.md, "App updates"). Leave it empty to switch
|
||||||
# updates off.
|
# updates off.
|
||||||
FORGE_TOKEN: CHANGE-ME-read-only-forge-token
|
FORGE_TOKEN: CHANGE-ME-read-only-forge-token
|
||||||
|
# Reads the files the car sends from its Logs tab (GET /v1/logs). At least 24 characters and
|
||||||
|
# not the INGEST_TOKEN. Leave it empty to switch reading off; the car can still send.
|
||||||
|
LOGS_TOKEN: CHANGE-ME-openssl-rand-hex-32
|
||||||
---
|
---
|
||||||
apiVersion: v1
|
apiVersion: v1
|
||||||
kind: Secret
|
kind: Secret
|
||||||
|
|||||||
+27
-2
@@ -16,6 +16,22 @@ spec:
|
|||||||
requests:
|
requests:
|
||||||
storage: 1Gi
|
storage: 1Gi
|
||||||
---
|
---
|
||||||
|
# The files the car sends from its Logs tab (signal recordings), read with LOGS_TOKEN. Unlike
|
||||||
|
# the map cache these are not fetched again, so they get a volume of their own.
|
||||||
|
apiVersion: v1
|
||||||
|
kind: PersistentVolumeClaim
|
||||||
|
metadata:
|
||||||
|
name: mg4-server-logs
|
||||||
|
namespace: mg4
|
||||||
|
labels:
|
||||||
|
app.kubernetes.io/name: mg4-server
|
||||||
|
app.kubernetes.io/part-of: mg4
|
||||||
|
spec:
|
||||||
|
accessModes: ["ReadWriteOnce"]
|
||||||
|
resources:
|
||||||
|
requests:
|
||||||
|
storage: 1Gi
|
||||||
|
---
|
||||||
apiVersion: apps/v1
|
apiVersion: apps/v1
|
||||||
kind: Deployment
|
kind: Deployment
|
||||||
metadata:
|
metadata:
|
||||||
@@ -47,7 +63,7 @@ spec:
|
|||||||
containers:
|
containers:
|
||||||
- name: server
|
- name: server
|
||||||
# Pinned by digest so a re-pushed tag cannot change what runs (version in SPECS.md).
|
# Pinned by digest so a re-pushed tag cannot change what runs (version in SPECS.md).
|
||||||
image: git.stinnesbeck.com/nils/mg4-server@sha256:8b8d94e0562833d196162866b7fdc6910d5dd219f6eb84572d4d5c91b74f7ff1
|
image: git.stinnesbeck.com/nils/mg4-server@sha256:c68837f0e53cfca150644987be535e04d5e999bd4c91064d40973db67235df48
|
||||||
ports:
|
ports:
|
||||||
- name: http
|
- name: http
|
||||||
containerPort: 8080
|
containerPort: 8080
|
||||||
@@ -73,12 +89,16 @@ spec:
|
|||||||
value: https://tiles.openfreemap.org/planet
|
value: https://tiles.openfreemap.org/planet
|
||||||
- name: MAP_CACHE_DIR
|
- name: MAP_CACHE_DIR
|
||||||
value: /var/cache/mg4-maps
|
value: /var/cache/mg4-maps
|
||||||
|
# Files from the car's Logs tab, kept on the volume below (the newest 200, at most
|
||||||
|
# 180 days). Reading them needs LOGS_TOKEN from the Secret; empty switches reading off.
|
||||||
|
- name: LOGS_DIR
|
||||||
|
value: /var/lib/mg4-logs
|
||||||
- name: INFLUX_TOKEN
|
- name: INFLUX_TOKEN
|
||||||
valueFrom:
|
valueFrom:
|
||||||
secretKeyRef:
|
secretKeyRef:
|
||||||
name: influxdb-auth
|
name: influxdb-auth
|
||||||
key: admin-token
|
key: admin-token
|
||||||
# INGEST_TOKEN, APPROVAL_PASSWORD, FORGE_TOKEN.
|
# INGEST_TOKEN, APPROVAL_PASSWORD, FORGE_TOKEN, LOGS_TOKEN.
|
||||||
envFrom:
|
envFrom:
|
||||||
- secretRef:
|
- secretRef:
|
||||||
name: mg4-server
|
name: mg4-server
|
||||||
@@ -107,10 +127,15 @@ spec:
|
|||||||
volumeMounts:
|
volumeMounts:
|
||||||
- name: maps
|
- name: maps
|
||||||
mountPath: /var/cache/mg4-maps
|
mountPath: /var/cache/mg4-maps
|
||||||
|
- name: logs
|
||||||
|
mountPath: /var/lib/mg4-logs
|
||||||
volumes:
|
volumes:
|
||||||
- name: maps
|
- name: maps
|
||||||
persistentVolumeClaim:
|
persistentVolumeClaim:
|
||||||
claimName: mg4-server-maps
|
claimName: mg4-server-maps
|
||||||
|
- name: logs
|
||||||
|
persistentVolumeClaim:
|
||||||
|
claimName: mg4-server-logs
|
||||||
---
|
---
|
||||||
apiVersion: v1
|
apiVersion: v1
|
||||||
kind: Service
|
kind: Service
|
||||||
|
|||||||
@@ -25,6 +25,8 @@ Environment only; the server refuses to start when a required value is missing.
|
|||||||
| `FORGE_URL`, `FORGE_REPO`, `FORGE_TOKEN` | optional; app updates (below). The token only needs to read the repository |
|
| `FORGE_URL`, `FORGE_REPO`, `FORGE_TOKEN` | optional; app updates (below). The token only needs to read the repository |
|
||||||
| `MAP_TILES_URL` | a TileJSON naming the vector tiles the map's roads come from; default OpenFreeMap's `https://tiles.openfreemap.org/planet`, `off` switches maps off, otherwise https only |
|
| `MAP_TILES_URL` | a TileJSON naming the vector tiles the map's roads come from; default OpenFreeMap's `https://tiles.openfreemap.org/planet`, `off` switches maps off, otherwise https only |
|
||||||
| `MAP_CACHE_DIR` | where fetched map tiles are kept across restarts (the manifest mounts a volume there); empty keeps them in memory only |
|
| `MAP_CACHE_DIR` | where fetched map tiles are kept across restarts (the manifest mounts a volume there); empty keeps them in memory only |
|
||||||
|
| `LOGS_DIR` | where the files the car sends from its Logs tab are kept (the manifest mounts a volume there); empty switches logs off |
|
||||||
|
| `LOGS_TOKEN` | optional, at least 24 characters and not the `INGEST_TOKEN`; reads those files (below). Empty: the car can send, nobody can read |
|
||||||
| `LISTEN_ADDR` | default `:8080` |
|
| `LISTEN_ADDR` | default `:8080` |
|
||||||
|
|
||||||
## Endpoints
|
## Endpoints
|
||||||
@@ -43,6 +45,7 @@ with (403 otherwise); the shared token works for any.
|
|||||||
- `PUT /v1/charging-sessions/{sessionId}` — a finished charging session (AC or DC, as far as the car was awake) with its curve.
|
- `PUT /v1/charging-sessions/{sessionId}` — a finished charging session (AC or DC, as far as the car was awake) with its curve.
|
||||||
- `GET /v1/consumption/history/{installationId}` — the car reads its own totals back.
|
- `GET /v1/consumption/history/{installationId}` — the car reads its own totals back.
|
||||||
- `GET /v1/health` — `{"status":"ok"}`.
|
- `GET /v1/health` — `{"status":"ok"}`.
|
||||||
|
- `PUT /v1/logs/{name}` — a file from the car's Logs tab (below).
|
||||||
|
|
||||||
A malformed request is a 400 naming the field; a database failure is a 500 without detail.
|
A malformed request is a 400 naming the field; a database failure is a 500 without detail.
|
||||||
|
|
||||||
@@ -79,6 +82,26 @@ and is kept, and the car hears 503 with `Retry-After: 10` and gets the tile on i
|
|||||||
404 when maps are off. The log says `map tile fetched` with the size, never the tile.
|
404 when maps are off. The log says `map tile fetched` with the size, never the tile.
|
||||||
Map data © OpenStreetMap contributors (ODbL), tiles © OpenMapTiles, served by OpenFreeMap.
|
Map data © OpenStreetMap contributors (ODbL), tiles © OpenMapTiles, served by OpenFreeMap.
|
||||||
|
|
||||||
|
## Logs from the car
|
||||||
|
|
||||||
|
So a signal recording reaches the owner without a USB stick. The car sends each one when it ends
|
||||||
|
(again later when it is offline) with its own token: `PUT /v1/logs/{name}`, plain UTF-8 text,
|
||||||
|
gzipped (`Content-Encoding: gzip`) or not; at most 2 MB as sent and 8 MB unpacked. The name is
|
||||||
|
the app's (`signal-recording-20261027-085240.txt`: lower-case letters, digits and dashes,
|
||||||
|
`.txt`); the same name again replaces the file, so a retry is harmless. 204 when stored. The
|
||||||
|
newest 200 files are kept, none older than 180 days.
|
||||||
|
|
||||||
|
Reading takes `LOGS_TOKEN`, which can do nothing else, and the car's token cannot read:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -H "Authorization: Bearer $LOGS_TOKEN" https://car.k8s.stinnesbeck.com/v1/logs # {logs: [{name, bytes, received}]}, newest first
|
||||||
|
curl -H "Authorization: Bearer $LOGS_TOKEN" https://car.k8s.stinnesbeck.com/v1/logs/<name> # the text
|
||||||
|
```
|
||||||
|
|
||||||
|
`fetch-logs` in the dev shell fetches the new ones into `logs/` (token from
|
||||||
|
`~/.config/nilsmg4/logs-token`). 404 when reading is off. The log says `log received` with the
|
||||||
|
name and size, never the contents.
|
||||||
|
|
||||||
## Settings from a phone
|
## Settings from a phone
|
||||||
|
|
||||||
The ABRP credentials are long to type on the car. With pairing on, the car (with its own token)
|
The ABRP credentials are long to type on the car. With pairing on, the car (with its own token)
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ import (
|
|||||||
// /v1/settings/…, /settings settings typed on a phone (handoff_http.go)
|
// /v1/settings/…, /settings settings typed on a phone (handoff_http.go)
|
||||||
// GET /v1/app/… app updates from the forge (releases.go)
|
// GET /v1/app/… app updates from the forge (releases.go)
|
||||||
// POST /v1/map/roads the roads of one map tile (maps.go)
|
// POST /v1/map/roads the roads of one map tile (maps.go)
|
||||||
|
// /v1/logs/… files from the Logs tab, read with LOGS_TOKEN (logs.go)
|
||||||
//
|
//
|
||||||
// A car authenticates with the shared INGEST_TOKEN or with its own token from pairing
|
// A car authenticates with the shared INGEST_TOKEN or with its own token from pairing
|
||||||
// (pairing_http.go).
|
// (pairing_http.go).
|
||||||
@@ -34,6 +35,8 @@ type API struct {
|
|||||||
Releases *Releases
|
Releases *Releases
|
||||||
// Maps serves the roads for the Overview's map from OpenStreetMap vector tiles (maps.go); nil is off.
|
// Maps serves the roads for the Overview's map from OpenStreetMap vector tiles (maps.go); nil is off.
|
||||||
Maps *Maps
|
Maps *Maps
|
||||||
|
// Logs keeps the files the car sends from its Logs tab (logs.go); nil is off.
|
||||||
|
Logs *Logs
|
||||||
// PublicURL is the server's address as a phone reaches it, for the pairing QR code;
|
// PublicURL is the server's address as a phone reaches it, for the pairing QR code;
|
||||||
// derived from the request when empty.
|
// derived from the request when empty.
|
||||||
PublicURL string
|
PublicURL string
|
||||||
@@ -54,6 +57,7 @@ func (a *API) Routes() http.Handler {
|
|||||||
a.handoffRoutes(mux)
|
a.handoffRoutes(mux)
|
||||||
a.releaseRoutes(mux)
|
a.releaseRoutes(mux)
|
||||||
a.mapRoutes(mux)
|
a.mapRoutes(mux)
|
||||||
|
a.logRoutes(mux)
|
||||||
return mux
|
return mux
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+248
@@ -0,0 +1,248 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"compress/gzip"
|
||||||
|
"crypto/subtle"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Logs keeps the text files the car sends from its Logs tab (signal recordings) on a volume,
|
||||||
|
// so they reach the owner without a USB stick. The car sends with its ingest token; reading
|
||||||
|
// needs LOGS_TOKEN, a token of its own, so neither the car's token can read them nor this one
|
||||||
|
// write anything.
|
||||||
|
//
|
||||||
|
// PUT /v1/logs/{name} one file from the car (ingest token); the same name again replaces it
|
||||||
|
// GET /v1/logs the files, newest first (LOGS_TOKEN)
|
||||||
|
// GET /v1/logs/{name} one file (LOGS_TOKEN)
|
||||||
|
//
|
||||||
|
// The newest maxLogFiles files younger than maxLogAge are kept. A file's contents never go to
|
||||||
|
// the server log, only its name and size.
|
||||||
|
type Logs struct {
|
||||||
|
Dir string
|
||||||
|
// ReadToken is LOGS_TOKEN; empty switches reading off (the car can still send).
|
||||||
|
ReadToken string
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
now func() time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
const (
|
||||||
|
maxLogWireBytes = 2 << 20 // as sent, gzip or not
|
||||||
|
maxLogBytes = 8 << 20 // as stored
|
||||||
|
maxLogFiles = 200
|
||||||
|
maxLogAge = 180 * 24 * time.Hour
|
||||||
|
)
|
||||||
|
|
||||||
|
// logName is what a file may be called: the app's own names, e.g. signal-recording-20261027-085240.txt.
|
||||||
|
var logName = regexp.MustCompile(`^[a-z0-9][a-z0-9-]{0,79}\.txt$`)
|
||||||
|
|
||||||
|
// NewLogs keeps the files in dir, which must exist.
|
||||||
|
func NewLogs(dir, readToken string) *Logs {
|
||||||
|
return &Logs{Dir: dir, ReadToken: readToken, now: time.Now}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *API) logRoutes(mux *http.ServeMux) {
|
||||||
|
if a.Logs == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
mux.HandleFunc("PUT /v1/logs/{name}", a.putLog)
|
||||||
|
mux.HandleFunc("GET /v1/logs", a.Logs.list)
|
||||||
|
mux.HandleFunc("GET /v1/logs/{name}", a.Logs.get)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *API) putLog(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if _, ok := a.authenticate(r); !ok {
|
||||||
|
writeJSON(w, http.StatusUnauthorized, map[string]string{"error": "unauthorized"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
name := r.PathValue("name")
|
||||||
|
if !logName.MatchString(name) {
|
||||||
|
writeJSON(w, http.StatusBadRequest, map[string]string{"error": "name must be lower-case letters, digits and dashes, ending in .txt"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
text, status, msg := readLogBody(r)
|
||||||
|
if status != 0 {
|
||||||
|
writeJSON(w, status, map[string]string{"error": msg})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := a.Logs.save(name, text); err != nil {
|
||||||
|
slog.Error("log not stored", "name", name, "error", err)
|
||||||
|
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": "internal server error"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
slog.Info("log received", "name", name, "bytes", len(text))
|
||||||
|
w.WriteHeader(http.StatusNoContent)
|
||||||
|
}
|
||||||
|
|
||||||
|
// readLogBody is the request's text, un-gzipped when it says so; a status and message when it
|
||||||
|
// is too large, not gzip after all, or not UTF-8 text.
|
||||||
|
func readLogBody(r *http.Request) ([]byte, int, string) {
|
||||||
|
wire, err := io.ReadAll(io.LimitReader(r.Body, maxLogWireBytes+1))
|
||||||
|
if err != nil {
|
||||||
|
return nil, http.StatusBadRequest, "body could not be read"
|
||||||
|
}
|
||||||
|
if len(wire) > maxLogWireBytes {
|
||||||
|
return nil, http.StatusRequestEntityTooLarge, "body is too large"
|
||||||
|
}
|
||||||
|
text := wire
|
||||||
|
switch strings.ToLower(r.Header.Get("Content-Encoding")) {
|
||||||
|
case "", "identity":
|
||||||
|
case "gzip":
|
||||||
|
zr, err := gzip.NewReader(bytes.NewReader(wire))
|
||||||
|
if err != nil {
|
||||||
|
return nil, http.StatusBadRequest, "body is not gzip"
|
||||||
|
}
|
||||||
|
text, err = io.ReadAll(io.LimitReader(zr, maxLogBytes+1))
|
||||||
|
if err != nil {
|
||||||
|
return nil, http.StatusBadRequest, "body is not gzip"
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return nil, http.StatusUnsupportedMediaType, "only gzip or no encoding"
|
||||||
|
}
|
||||||
|
if len(text) > maxLogBytes {
|
||||||
|
return nil, http.StatusRequestEntityTooLarge, "body is too large"
|
||||||
|
}
|
||||||
|
if !utf8.Valid(text) {
|
||||||
|
return nil, http.StatusBadRequest, "body is not UTF-8 text"
|
||||||
|
}
|
||||||
|
return text, 0, ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// save writes the file whole (a temporary file renamed into place), then prunes.
|
||||||
|
func (l *Logs) save(name string, text []byte) error {
|
||||||
|
l.mu.Lock()
|
||||||
|
defer l.mu.Unlock()
|
||||||
|
tmp, err := os.CreateTemp(l.Dir, ".incoming-*")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer os.Remove(tmp.Name()) // gone after the rename; cleans up after a failure
|
||||||
|
if _, err := tmp.Write(text); err != nil {
|
||||||
|
tmp.Close()
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := tmp.Close(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := os.Rename(tmp.Name(), filepath.Join(l.Dir, name)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
l.prune()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type logEntry struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Bytes int64 `json:"bytes"`
|
||||||
|
Received time.Time `json:"received"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// entries are the stored files, newest first.
|
||||||
|
func (l *Logs) entries() ([]logEntry, error) {
|
||||||
|
dir, err := os.ReadDir(l.Dir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var out []logEntry
|
||||||
|
for _, e := range dir {
|
||||||
|
if !e.Type().IsRegular() || !logName.MatchString(e.Name()) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
info, err := e.Info()
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out = append(out, logEntry{Name: e.Name(), Bytes: info.Size(), Received: info.ModTime().UTC()})
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool {
|
||||||
|
if !out[i].Received.Equal(out[j].Received) {
|
||||||
|
return out[i].Received.After(out[j].Received)
|
||||||
|
}
|
||||||
|
return out[i].Name > out[j].Name
|
||||||
|
})
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// prune removes all but the newest maxLogFiles and anything older than maxLogAge.
|
||||||
|
func (l *Logs) prune() {
|
||||||
|
entries, err := l.entries()
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
cutoff := l.now().Add(-maxLogAge)
|
||||||
|
for i, e := range entries {
|
||||||
|
if i >= maxLogFiles || e.Received.Before(cutoff) {
|
||||||
|
if err := os.Remove(filepath.Join(l.Dir, e.Name)); err != nil && !errors.Is(err, os.ErrNotExist) {
|
||||||
|
slog.Warn("old log not removed", "name", e.Name, "error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// mayRead accepts LOGS_TOKEN only, compared in constant time; main refuses a short one.
|
||||||
|
func (l *Logs) mayRead(w http.ResponseWriter, r *http.Request) bool {
|
||||||
|
if l.ReadToken == "" {
|
||||||
|
writeJSON(w, http.StatusNotFound, map[string]string{"error": "reading logs is off (no LOGS_TOKEN)"})
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
supplied, ok := strings.CutPrefix(r.Header.Get("Authorization"), "Bearer ")
|
||||||
|
if !ok || subtle.ConstantTimeCompare([]byte(supplied), []byte(l.ReadToken)) != 1 {
|
||||||
|
writeJSON(w, http.StatusUnauthorized, map[string]string{"error": "unauthorized"})
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *Logs) list(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if !l.mayRead(w, r) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
l.mu.Lock()
|
||||||
|
entries, err := l.entries()
|
||||||
|
l.mu.Unlock()
|
||||||
|
if err != nil {
|
||||||
|
slog.Error("logs not listed", "error", err)
|
||||||
|
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": "internal server error"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"logs": append([]logEntry{}, entries...)})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *Logs) get(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if !l.mayRead(w, r) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
name := r.PathValue("name")
|
||||||
|
if !logName.MatchString(name) {
|
||||||
|
writeJSON(w, http.StatusNotFound, map[string]string{"error": "no such log"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
l.mu.Lock()
|
||||||
|
text, err := os.ReadFile(filepath.Join(l.Dir, name))
|
||||||
|
l.mu.Unlock()
|
||||||
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
writeJSON(w, http.StatusNotFound, map[string]string{"error": "no such log"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
slog.Error("log not read", "name", name, "error", err)
|
||||||
|
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": "internal server error"})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "text/plain; charset=utf-8")
|
||||||
|
w.Header().Set("X-Content-Type-Options", "nosniff")
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write(text)
|
||||||
|
}
|
||||||
@@ -0,0 +1,212 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"compress/gzip"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
const testLogsToken = "logs-read-token-0123456789abcdef"
|
||||||
|
|
||||||
|
func newLogsAPI(t *testing.T) (*API, string) {
|
||||||
|
t.Helper()
|
||||||
|
api, _ := newTestAPI()
|
||||||
|
dir := t.TempDir()
|
||||||
|
api.Logs = NewLogs(dir, testLogsToken)
|
||||||
|
return api, dir
|
||||||
|
}
|
||||||
|
|
||||||
|
func gzipped(t *testing.T, text string) []byte {
|
||||||
|
t.Helper()
|
||||||
|
var b bytes.Buffer
|
||||||
|
zw := gzip.NewWriter(&b)
|
||||||
|
if _, err := zw.Write([]byte(text)); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := zw.Close(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return b.Bytes()
|
||||||
|
}
|
||||||
|
|
||||||
|
func putLog(t *testing.T, h http.Handler, name, token string, body []byte, encoding string) *httptest.ResponseRecorder {
|
||||||
|
t.Helper()
|
||||||
|
req := httptest.NewRequest("PUT", "/v1/logs/"+name, bytes.NewReader(body))
|
||||||
|
req.Header.Set("Authorization", "Bearer "+token)
|
||||||
|
req.Header.Set("Content-Type", "text/plain; charset=utf-8")
|
||||||
|
if encoding != "" {
|
||||||
|
req.Header.Set("Content-Encoding", encoding)
|
||||||
|
}
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
h.ServeHTTP(rec, req)
|
||||||
|
return rec
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTheCarSendsALogAndTheOwnerReadsIt(t *testing.T) {
|
||||||
|
api, _ := newLogsAPI(t)
|
||||||
|
h := api.Routes()
|
||||||
|
const name = "signal-recording-20261027-085240.txt"
|
||||||
|
text := "Signal recording, 37 captures\nlistening to 108 assistance properties\n"
|
||||||
|
|
||||||
|
if rec := putLog(t, h, name, testToken, gzipped(t, text), "gzip"); rec.Code != http.StatusNoContent {
|
||||||
|
t.Fatalf("put: %d %s", rec.Code, rec.Body)
|
||||||
|
}
|
||||||
|
|
||||||
|
rec := do(t, h, "GET", "/v1/logs", testLogsToken, "")
|
||||||
|
if rec.Code != 200 {
|
||||||
|
t.Fatalf("list: %d %s", rec.Code, rec.Body)
|
||||||
|
}
|
||||||
|
var list struct {
|
||||||
|
Logs []logEntry `json:"logs"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(rec.Body.Bytes(), &list); err != nil || len(list.Logs) != 1 || list.Logs[0].Name != name ||
|
||||||
|
list.Logs[0].Bytes != int64(len(text)) {
|
||||||
|
t.Fatalf("list: %v %s", err, rec.Body)
|
||||||
|
}
|
||||||
|
|
||||||
|
rec = do(t, h, "GET", "/v1/logs/"+name, testLogsToken, "")
|
||||||
|
if rec.Code != 200 || rec.Body.String() != text || !strings.HasPrefix(rec.Header().Get("Content-Type"), "text/plain") {
|
||||||
|
t.Fatalf("get: %d %q", rec.Code, rec.Body)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sent again (a retry), it replaces itself.
|
||||||
|
if rec := putLog(t, h, name, testToken, []byte("again\n"), ""); rec.Code != http.StatusNoContent {
|
||||||
|
t.Fatalf("put again: %d", rec.Code)
|
||||||
|
}
|
||||||
|
if rec := do(t, h, "GET", "/v1/logs/"+name, testLogsToken, ""); rec.Body.String() != "again\n" {
|
||||||
|
t.Fatalf("replaced: %q", rec.Body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLogTokensDoNotCross(t *testing.T) {
|
||||||
|
api, _ := newLogsAPI(t)
|
||||||
|
h := api.Routes()
|
||||||
|
name := "signal-recording-1.txt"
|
||||||
|
if rec := putLog(t, h, name, testLogsToken, []byte("x"), ""); rec.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("the read token wrote: %d", rec.Code)
|
||||||
|
}
|
||||||
|
if rec := putLog(t, h, name, testToken, []byte("x"), ""); rec.Code != http.StatusNoContent {
|
||||||
|
t.Fatalf("put: %d", rec.Code)
|
||||||
|
}
|
||||||
|
for _, path := range []string{"/v1/logs", "/v1/logs/" + name} {
|
||||||
|
for _, token := range []string{"", testToken, testLogsToken + "x"} {
|
||||||
|
if rec := do(t, h, "GET", path, token, ""); rec.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("GET %s with %q: %d", path, token, rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadingIsOffWithoutALogsToken(t *testing.T) {
|
||||||
|
api, _ := newLogsAPI(t)
|
||||||
|
api.Logs.ReadToken = ""
|
||||||
|
h := api.Routes()
|
||||||
|
if rec := putLog(t, h, "a.txt", testToken, []byte("x"), ""); rec.Code != http.StatusNoContent {
|
||||||
|
t.Fatalf("put: %d", rec.Code)
|
||||||
|
}
|
||||||
|
if rec := do(t, h, "GET", "/v1/logs", "", ""); rec.Code != http.StatusNotFound {
|
||||||
|
t.Fatalf("list: %d", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBadLogsAreRefused(t *testing.T) {
|
||||||
|
api, dir := newLogsAPI(t)
|
||||||
|
h := api.Routes()
|
||||||
|
for _, c := range []struct {
|
||||||
|
name, encoding string
|
||||||
|
body []byte
|
||||||
|
want int
|
||||||
|
}{
|
||||||
|
{"..%2Fescape.txt", "", []byte("x"), http.StatusBadRequest},
|
||||||
|
{"Upper.txt", "", []byte("x"), http.StatusBadRequest},
|
||||||
|
{"no-suffix", "", []byte("x"), http.StatusBadRequest},
|
||||||
|
{".hidden.txt", "", []byte("x"), http.StatusBadRequest},
|
||||||
|
{"a.txt", "gzip", []byte("not gzip"), http.StatusBadRequest},
|
||||||
|
{"a.txt", "br", []byte("x"), http.StatusUnsupportedMediaType},
|
||||||
|
{"a.txt", "", []byte{0xff, 0xfe, 0x00}, http.StatusBadRequest},
|
||||||
|
{"a.txt", "", make([]byte, maxLogWireBytes+1), http.StatusRequestEntityTooLarge},
|
||||||
|
{"a.txt", "gzip", gzipped(t, strings.Repeat("a", maxLogBytes+1)), http.StatusRequestEntityTooLarge},
|
||||||
|
} {
|
||||||
|
if rec := putLog(t, h, c.name, testToken, c.body, c.encoding); rec.Code != c.want {
|
||||||
|
t.Errorf("%s %s: %d, want %d (%s)", c.name, c.encoding, rec.Code, c.want, rec.Body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if files, _ := os.ReadDir(dir); len(files) != 0 {
|
||||||
|
t.Fatalf("stored: %v", files)
|
||||||
|
}
|
||||||
|
if rec := do(t, h, "GET", "/v1/logs/missing.txt", testLogsToken, ""); rec.Code != http.StatusNotFound {
|
||||||
|
t.Fatalf("missing: %d", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOldAndSurplusLogsArePruned(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
l := NewLogs(dir, testLogsToken)
|
||||||
|
// The new file gets the real time as its own, so the others are placed before it.
|
||||||
|
now := time.Now()
|
||||||
|
old := filepath.Join(dir, "old.txt")
|
||||||
|
if err := os.WriteFile(old, []byte("x"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Chtimes(old, now.Add(-maxLogAge-time.Hour), now.Add(-maxLogAge-time.Hour)); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for i := 0; i < maxLogFiles+5; i++ {
|
||||||
|
p := filepath.Join(dir, fmt.Sprintf("f-%03d.txt", i))
|
||||||
|
if err := os.WriteFile(p, []byte("x"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
at := now.Add(-time.Duration(maxLogFiles+5-i) * time.Minute)
|
||||||
|
if err := os.Chtimes(p, at, at); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := l.save("new.txt", []byte("y")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
entries, _ := l.entries()
|
||||||
|
if len(entries) != maxLogFiles || entries[0].Name != "new.txt" {
|
||||||
|
t.Fatalf("%d kept, first %s", len(entries), entries[0].Name)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(old); !os.IsNotExist(err) {
|
||||||
|
t.Fatal("the old one is still there")
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, "f-000.txt")); !os.IsNotExist(err) {
|
||||||
|
t.Fatal("the oldest surplus one is still there")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLogsConfig(t *testing.T) {
|
||||||
|
base := map[string]string{"INFLUX_URL": "http://i", "INFLUX_TOKEN": "t", "INFLUX_ORG": "o", "INGEST_TOKEN": testToken}
|
||||||
|
env := func(extra map[string]string) func(string) string {
|
||||||
|
return func(k string) string {
|
||||||
|
if v, ok := extra[k]; ok {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return base[k]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, c := range []struct {
|
||||||
|
extra map[string]string
|
||||||
|
ok bool
|
||||||
|
}{
|
||||||
|
{map[string]string{}, true},
|
||||||
|
{map[string]string{"LOGS_DIR": "/l"}, true},
|
||||||
|
{map[string]string{"LOGS_DIR": "/l", "LOGS_TOKEN": testLogsToken}, true},
|
||||||
|
{map[string]string{"LOGS_TOKEN": testLogsToken}, false},
|
||||||
|
{map[string]string{"LOGS_DIR": "/l", "LOGS_TOKEN": "short"}, false},
|
||||||
|
{map[string]string{"LOGS_DIR": "/l", "LOGS_TOKEN": testToken}, false},
|
||||||
|
} {
|
||||||
|
if _, err := loadConfig(env(c.extra)); (err == nil) != c.ok {
|
||||||
|
t.Errorf("%v: %v", c.extra, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+23
-1
@@ -36,6 +36,8 @@ type config struct {
|
|||||||
forgeToken string
|
forgeToken string
|
||||||
mapTilesURL string
|
mapTilesURL string
|
||||||
mapCacheDir string
|
mapCacheDir string
|
||||||
|
logsDir string
|
||||||
|
logsToken string
|
||||||
}
|
}
|
||||||
|
|
||||||
// loadConfig reads the environment and fails closed: a missing InfluxDB setting or a
|
// loadConfig reads the environment and fails closed: a missing InfluxDB setting or a
|
||||||
@@ -55,6 +57,8 @@ func loadConfig(getenv func(string) string) (config, error) {
|
|||||||
forgeToken: getenv("FORGE_TOKEN"),
|
forgeToken: getenv("FORGE_TOKEN"),
|
||||||
mapTilesURL: getenv("MAP_TILES_URL"),
|
mapTilesURL: getenv("MAP_TILES_URL"),
|
||||||
mapCacheDir: getenv("MAP_CACHE_DIR"),
|
mapCacheDir: getenv("MAP_CACHE_DIR"),
|
||||||
|
logsDir: getenv("LOGS_DIR"),
|
||||||
|
logsToken: getenv("LOGS_TOKEN"),
|
||||||
}
|
}
|
||||||
if c.listenAddr == "" {
|
if c.listenAddr == "" {
|
||||||
c.listenAddr = ":8080"
|
c.listenAddr = ":8080"
|
||||||
@@ -89,6 +93,17 @@ func loadConfig(getenv func(string) string) (config, error) {
|
|||||||
return config{}, errors.New("MAP_TILES_URL must be an https URL or \"off\"")
|
return config{}, errors.New("MAP_TILES_URL must be an https URL or \"off\"")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// Logs from the car are optional (LOGS_DIR); reading them needs a token of their own, as
|
||||||
|
// long as the ingest token, and never the ingest token itself.
|
||||||
|
if c.logsToken != "" && c.logsDir == "" {
|
||||||
|
return config{}, errors.New("LOGS_TOKEN is set but LOGS_DIR is not")
|
||||||
|
}
|
||||||
|
if c.logsToken != "" && len(c.logsToken) < minIngestTokenLength {
|
||||||
|
return config{}, fmt.Errorf("LOGS_TOKEN must be at least %d characters", minIngestTokenLength)
|
||||||
|
}
|
||||||
|
if c.logsToken != "" && c.logsToken == c.ingestToken {
|
||||||
|
return config{}, errors.New("LOGS_TOKEN must differ from INGEST_TOKEN")
|
||||||
|
}
|
||||||
if c.approvalPass != "" && len(c.approvalPass) < minApprovalPasswordLength {
|
if c.approvalPass != "" && len(c.approvalPass) < minApprovalPasswordLength {
|
||||||
return config{}, fmt.Errorf("APPROVAL_PASSWORD must be at least %d characters", minApprovalPasswordLength)
|
return config{}, fmt.Errorf("APPROVAL_PASSWORD must be at least %d characters", minApprovalPasswordLength)
|
||||||
}
|
}
|
||||||
@@ -127,6 +142,13 @@ func main() {
|
|||||||
}
|
}
|
||||||
api.Maps = NewMaps(cfg.mapTilesURL, cfg.mapCacheDir, mapUserAgent)
|
api.Maps = NewMaps(cfg.mapTilesURL, cfg.mapCacheDir, mapUserAgent)
|
||||||
}
|
}
|
||||||
|
if cfg.logsDir != "" {
|
||||||
|
if err := os.MkdirAll(cfg.logsDir, 0o700); err != nil {
|
||||||
|
slog.Error("logs directory not usable", "error", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
api.Logs = NewLogs(cfg.logsDir, cfg.logsToken)
|
||||||
|
}
|
||||||
|
|
||||||
srv := &http.Server{
|
srv := &http.Server{
|
||||||
Addr: cfg.listenAddr,
|
Addr: cfg.listenAddr,
|
||||||
@@ -142,7 +164,7 @@ func main() {
|
|||||||
go func() {
|
go func() {
|
||||||
slog.Info("listening", "addr", cfg.listenAddr, "bucket", cfg.influxBucket,
|
slog.Info("listening", "addr", cfg.listenAddr, "bucket", cfg.influxBucket,
|
||||||
"pairing", pairing.Enabled(), "pairedDevices", len(devices), "appUpdates", releases.enabled(),
|
"pairing", pairing.Enabled(), "pairedDevices", len(devices), "appUpdates", releases.enabled(),
|
||||||
"maps", api.Maps != nil)
|
"maps", api.Maps != nil, "logs", api.Logs != nil, "logsReadable", api.Logs != nil && cfg.logsToken != "")
|
||||||
if err := srv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
|
if err := srv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
slog.Error("server failed", "error", err)
|
slog.Error("server failed", "error", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
|
|||||||
Reference in New Issue
Block a user