Meshtastic-Android/app/src/main/java/com/geeksville/mesh/service/SoftwareUpdateService.kt

package com.geeksville.mesh.service

import android.bluetooth.BluetoothAdapter
import android.bluetooth.BluetoothGattCharacteristic
import android.bluetooth.BluetoothManager
import android.content.Context
import android.content.Intent
import androidx.core.app.JobIntentService
import com.geeksville.android.Logging
import com.geeksville.mesh.MainActivity
import com.geeksville.mesh.R
import com.geeksville.util.exceptionReporter
import java.util.*
import java.util.zip.CRC32

/**
 * typical flow
 *
 * startScan
 * startUpdate
 *
 * stopScan
 *
 * FIXME - if we don't find a device stop our scan
 * FIXME - broadcast when we found devices, made progress sending blocks or when the update is complete
 * FIXME - make the user decide to start an update on a particular device
 */
class SoftwareUpdateService : JobIntentService(), Logging {

    private val bluetoothAdapter: BluetoothAdapter by lazy(LazyThreadSafetyMode.NONE) {
        val bluetoothManager = getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager
        bluetoothManager.adapter!!
    }


    fun startUpdate(macaddr: String) {
        info("starting update to $macaddr")

        val device = bluetoothAdapter.getRemoteDevice(macaddr)

        val sync =
            SafeBluetooth(
                this@SoftwareUpdateService,
                device
            )

        sync.connect()
        sync.use { _ ->
            sync.discoverServices() // Get our services

            // we begin by setting our MTU size as high as it can go
            sync.requestMtu(512)

            val service = sync.gatt!!.services.find { it.uuid == SW_UPDATE_UUID }!!

            fun doFirmwareUpdate(assetName: String) {

                info("Starting firmware update for $assetName")

                val totalSizeDesc = service.getCharacteristic(SW_UPDATE_TOTALSIZE_CHARACTER)
                val dataDesc = service.getCharacteristic(SW_UPDATE_DATA_CHARACTER)
                val crc32Desc = service.getCharacteristic(SW_UPDATE_CRC32_CHARACTER)
                val updateResultDesc = service.getCharacteristic(SW_UPDATE_RESULT_CHARACTER)

                assets.open(assetName).use { firmwareStream ->
                    val firmwareCrc = CRC32()
                    var firmwareNumSent = 0
                    val firmwareSize = firmwareStream.available()

                    // Start the update by writing the # of bytes in the image
                    logAssert(
                        totalSizeDesc.setValue(
                            firmwareSize,
                            BluetoothGattCharacteristic.FORMAT_UINT32,
                            0
                        )
                    )
                    sync.writeCharacteristic(totalSizeDesc)

// Our write completed, queue up a readback
                    val totalSizeReadback = sync.readCharacteristic(totalSizeDesc)
                        .getIntValue(BluetoothGattCharacteristic.FORMAT_UINT32, 0)
                    if (totalSizeReadback == 0) // FIXME - handle this case
                        throw Exception("Device rejected file size")

                    // Send all the blocks
                    while (firmwareNumSent < firmwareSize) {
                        debug("sending block ${firmwareNumSent * 100 / firmwareSize}%")
                        var blockSize = 512 - 3 // Max size MTU excluding framing

                        if (blockSize > firmwareStream.available())
                            blockSize = firmwareStream.available()
                        val buffer = ByteArray(blockSize)

                        // slightly expensive to keep reallocing this buffer, but whatever
                        logAssert(firmwareStream.read(buffer) == blockSize)
                        firmwareCrc.update(buffer)

                        // updateGatt.beginReliableWrite()
                        dataDesc.value = buffer
                        sync.writeCharacteristic(dataDesc)
                        firmwareNumSent += blockSize
                    }

                    // We have finished sending all our blocks, so post the CRC so our state machine can advance
                    val c = firmwareCrc.value
                    info("Sent all blocks, crc is $c")
                    logAssert(
                        crc32Desc.setValue(
                            c.toInt(),
                            BluetoothGattCharacteristic.FORMAT_UINT32,
                            0
                        )
                    )
                    sync.writeCharacteristic(crc32Desc)

                    // we just read the update result if !0 we have an error
                    val updateResult =
                        sync.readCharacteristic(updateResultDesc)
                            .getIntValue(BluetoothGattCharacteristic.FORMAT_UINT8, 0)
                    if (updateResult != 0) // FIXME - handle this case
                        throw Exception("Device update failed, reason=$updateResult")

                    // FIXME perhaps ask device to reboot
                }
            }

            /// Return the filename this device needs to use as an update (or null if no update needed)
            fun getUpdateFilename(): String? {
                val hwVerDesc = service.getCharacteristic(HW_VERSION_CHARACTER)
                val mfgDesc = service.getCharacteristic(MANUFACTURE_CHARACTER)
                val swVerDesc = service.getCharacteristic(SW_VERSION_CHARACTER)

                // looks like 1.0-US
                val hwVer = sync.readCharacteristic(hwVerDesc).getStringValue(0)

                // looks like HELTEC
                val mfg = sync.readCharacteristic(mfgDesc).getStringValue(0)

                // looks like 0.0.12
                val swVer = sync.readCharacteristic(swVerDesc).getStringValue(0)

                val curver = getString(R.string.cur_firmware_version)

                // FIXME, instead compare version strings carefully to see if less than
                val needsUpdate = (curver != swVer)

                return if (!needsUpdate)
                    null
                else {
                    val regionRegex = Regex(".+-(.+)")
                    val (region) = regionRegex.find(hwVer)?.destructured
                        ?: throw Exception("Malformed hw version")

                    "firmware/firmware-$mfg-$region-$curver.bin"
                }
            }

            val updateFilename = getUpdateFilename()
            if (updateFilename != null) {
                doFirmwareUpdate(updateFilename)
            } else
                warn("Device is already up-to-date no update needed.")
        }
    }


    override fun onHandleWork(intent: Intent) { // We have received work to do.  The system or framework is already
// holding a wake lock for us at this point, so we can just go.

        // Report failures but do not crash the app
        exceptionReporter {
            debug("Executing work: $intent")
            when (intent.action) {
                ACTION_START_UPDATE -> {
                    val addr = intent.getStringExtra(EXTRA_MACADDR)
                        ?: throw Exception("EXTRA_MACADDR not specified")
                    startUpdate(addr) // FIXME, pass in as an intent arg instead
                }
                else -> TODO("Unhandled case")
            }
        }
    }

    companion object {
        /**
         * Unique job ID for this service.  Must be the same for all work.
         */
        private const val JOB_ID = 1000

        fun startUpdateIntent(macAddress: String): Intent {
            val i = Intent(ACTION_START_UPDATE)
            i.putExtra(EXTRA_MACADDR, macAddress)

            return i
        }

        const val ACTION_START_UPDATE = "$prefix.START_UPDATE"

        const val EXTRA_MACADDR = "macaddr"

        private const val SCAN_PERIOD: Long = 10000

        private val TAG =
            MainActivity::class.java.simpleName // FIXME - use my logging class instead

        private val SW_UPDATE_UUID = UUID.fromString("cb0b9a0b-a84c-4c0d-bdbb-442e3144ee30")
        private val SW_UPDATE_TOTALSIZE_CHARACTER =
            UUID.fromString("e74dd9c0-a301-4a6f-95a1-f0e1dbea8e1e") // write|read          total image size, 32 bit, write this first, then read read back to see if it was acceptable (0 mean not accepted)
        private val SW_UPDATE_DATA_CHARACTER =
            UUID.fromString("e272ebac-d463-4b98-bc84-5cc1a39ee517") //  write               data, variable sized, recommended 512 bytes, write one for each block of file
        private val SW_UPDATE_CRC32_CHARACTER =
            UUID.fromString("4826129c-c22a-43a3-b066-ce8f0d5bacc6") //  write               crc32, write last - writing this will complete the OTA operation, now you can read result
        private val SW_UPDATE_RESULT_CHARACTER =
            UUID.fromString("5e134862-7411-4424-ac4a-210937432c77") // read|notify         result code, readable but will notify when the OTA operation completes

        private val SW_VERSION_CHARACTER = longBLEUUID("2a28")
        private val MANUFACTURE_CHARACTER = longBLEUUID("2a29")
        private val HW_VERSION_CHARACTER = longBLEUUID("2a27")

        /**
         * Convenience method for enqueuing work in to this service.
         */
        fun enqueueWork(context: Context, work: Intent) {
            enqueueWork(
                context,
                SoftwareUpdateService::class.java,
                JOB_ID, work
            )
        }
    }
}