ring-mqtt/lib/state.js

const debug = require('debug')('ring-mqtt')
const colors = require('colors/safe')
const fs = require('fs')
const utils = require( '../lib/utils' )
const { createHash, randomBytes } = require('crypto')
const writeFileAtomic = require('write-file-atomic')

class State {
    constructor() {
        this.valid = false
        this.writeScheduled = false
        this.data = { 
            ring_token: '',
            systemId: '',
            devices: {}
        }
    }

    async init(config) {
        this.config = config
        this.file = (process.env.RUNMODE === 'standard') 
            ? require('path').dirname(require.main.filename)+'/ring-state.json'
            : this.file = '/data/ring-state.json'
        await this.loadStateData()
    }

    async loadStateData() {
        if (fs.existsSync(this.file)) {
            debug('Reading latest data from state file: '+this.file)
            try {
                this.data = require(this.file)
                this.valid = true
                if (!this.data.hasOwnProperty('systemId')) {
                    this.data.systemId = (createHash('sha256').update(randomBytes(32)).digest('hex'))
                }
                // Convert legacy state file with empty device array
                if (!this.data.hasOwnProperty('devices') || Array.isArray(this.data.devices)) {
                    this.data.devices = {}
                }
            } catch (err) {
                debug(err.message)
                debug(colors.red('Saved state file exist but could not be parsed!'))
                await this.initStateData()
            }
        } else {
            await this.initStateData()
        }
    }

    async initStateData() {
        this.data.systemId = (createHash('sha256').update(randomBytes(32)).digest('hex'))
        if (process.env.RUNMODE === 'standard' && this.config.data?.ring_token) {
            debug(colors.yellow('State file '+this.file+' not found, creating new state file using existing ring_token from config file.'))
            this.updateToken(this.config.data.ring_token, true)
            debug ('Removing legacy ring_token value from config file...')
            delete this.config.data.ring_token
            await this.config.updateConfigFile()
        } else {
            debug(colors.yellow('State file '+this.file+' not found. No saved state data available.'))
        }
    }

    async saveStateFile() {
        // The writeScheduled flag is a hack to keep from writing too often when there are burst
        // of state updates such as during startup. If a state file update is already scheduled
        // then calls to this function are skipped.
        if (!this.writeScheduled) {
            this.writeScheduled = true
            await utils.sleep(1)
            this.writeScheduled = false
            try {
                await writeFileAtomic(this.file, JSON.stringify(this.data))
                debug('Successfully saved updated state file: '+this.file)
            } catch (err) {
                debug(colors.red('Failed to save updated state file: '+this.file))
                debug(err.message)
            }
        }
    }

    updateToken(newRefreshToken, oldRefreshToken) {
        if (oldRefreshToken) {
            this.data.ring_token = newRefreshToken
            this.saveStateFile()
        }
    }

    setDeviceSavedState(deviceId, stateData) {
        this.data.devices[deviceId] = stateData
        this.saveStateFile()
    }

    getDeviceSavedState(deviceId) {
        return this.data.devices.hasOwnProperty(deviceId) ? this.data.devices[deviceId] : false
    }

    getAllSavedStates() {
        return this.data.devices
    }
}

module.exports = new State()