firmware/src/modules/AdminModule.cpp

#include "AdminModule.h"
#include "Channels.h"
#include "MeshService.h"
#include "NodeDB.h"
#include "Router.h"
#include "configuration.h"
#include "main.h"

#ifdef ARCH_PORTDUINO
#include "unistd.h"
#endif

AdminModule *adminModule;

/// A special reserved string to indicate strings we can not share with external nodes.  We will use this 'reserved' word instead.
/// Also, to make setting work correctly, if someone tries to set a string to this reserved value we assume they don't really want
/// a change.
static const char *secretReserved = "sekrit";

/// If buf is the reserved secret word, replace the buffer with currentVal
static void writeSecret(char *buf, const char *currentVal)
{
    if (strcmp(buf, secretReserved) == 0) {
        strcpy(buf, currentVal);
    }
}

/**
 * @brief Handle recieved protobuf message
 *
 * @param mp Recieved MeshPacket
 * @param r Decoded AdminMessage
 * @return bool
 */
bool AdminModule::handleReceivedProtobuf(const MeshPacket &mp, AdminMessage *r)
{
    // if handled == false, then let others look at this message also if they want
    bool handled = false;
    assert(r);

    switch (r->which_variant) {

    /**
     * Getters
     */
    case AdminMessage_get_owner_request_tag:
        DEBUG_MSG("Client is getting owner\n");
        handleGetOwner(mp);
        break;

    case AdminMessage_get_config_request_tag:
        DEBUG_MSG("Client is getting config\n");
        handleGetConfig(mp, r->get_config_request);
        break;

    case AdminMessage_get_module_config_request_tag:
        DEBUG_MSG("Client is getting module config\n");
        handleGetModuleConfig(mp, r->get_module_config_request);
        break;

    case AdminMessage_get_channel_request_tag: {
        uint32_t i = r->get_channel_request - 1;
        DEBUG_MSG("Client is getting channel %u\n", i);
        if (i >= MAX_NUM_CHANNELS)
            myReply = allocErrorResponse(Routing_Error_BAD_REQUEST, &mp);
        else
            handleGetChannel(mp, i);
        break;
    }

    /**
     * Setters
     */
    case AdminMessage_set_owner_tag:
        DEBUG_MSG("Client is setting owner\n");
        handleSetOwner(r->set_owner);
        break;

    case AdminMessage_set_config_tag:
        DEBUG_MSG("Client is setting the config\n");
        handleSetConfig(r->set_config);
        break;

    case AdminMessage_set_module_config_tag:
        DEBUG_MSG("Client is setting the module config\n");
        handleSetModuleConfig(r->set_module_config);
        break;

    case AdminMessage_set_channel_tag:
        DEBUG_MSG("Client is setting channel %d\n", r->set_channel.index);
        if (r->set_channel.index < 0 || r->set_channel.index >= (int)MAX_NUM_CHANNELS)
            myReply = allocErrorResponse(Routing_Error_BAD_REQUEST, &mp);
        else
            handleSetChannel(r->set_channel);
        break;

    /**
     * Other
     */
    case AdminMessage_reboot_seconds_tag: {
        int32_t s = r->reboot_seconds;
        DEBUG_MSG("Rebooting in %d seconds\n", s);
        rebootAtMsec = (s < 0) ? 0 : (millis() + s * 1000);
        break;
    }
    case AdminMessage_shutdown_seconds_tag: {
        int32_t s = r->shutdown_seconds;
        DEBUG_MSG("Shutdown in %d seconds\n", s);
        shutdownAtMsec = (s < 0) ? 0 : (millis() + s * 1000);
        break;
    }
    case AdminMessage_get_device_metadata_request_tag: {
        DEBUG_MSG("Client is getting device metadata\n");
        handleGetDeviceMetadata(mp);
        break;
    }

#ifdef ARCH_PORTDUINO
    case AdminMessage_exit_simulator_tag:
        DEBUG_MSG("Exiting simulator\n");
        _exit(0);
        break;
#endif

    default:
        AdminMessage res = AdminMessage_init_default;
        AdminMessageHandleResult handleResult = MeshModule::handleAdminMessageForAllPlugins(mp, r, &res);

        if (handleResult == AdminMessageHandleResult::HANDLED_WITH_RESPONSE) {
            myReply = allocDataProtobuf(res);
        } else if (mp.decoded.want_response) {
            DEBUG_MSG("We did not responded to a request that wanted a respond. req.variant=%d\n", r->which_variant);
        } else if (handleResult != AdminMessageHandleResult::HANDLED) {
            // Probably a message sent by us or sent to our local node.  FIXME, we should avoid scanning these messages
            DEBUG_MSG("Ignoring nonrelevant admin %d\n", r->which_variant);
        }
        break;
    }
    return handled;
}

/**
 * Setter methods
 */

void AdminModule::handleSetOwner(const User &o)
{
    int changed = 0;

    if (*o.long_name) {
        changed |= strcmp(owner.long_name, o.long_name);
        strcpy(owner.long_name, o.long_name);
    }
    if (*o.short_name) {
        changed |= strcmp(owner.short_name, o.short_name);
        strcpy(owner.short_name, o.short_name);
    }
    if (*o.id) {
        changed |= strcmp(owner.id, o.id);
        strcpy(owner.id, o.id);
    }
    if (owner.is_licensed != o.is_licensed) {
        changed = 1;
        owner.is_licensed = o.is_licensed;
    }

    if (changed) // If nothing really changed, don't broadcast on the network or write to flash
        service.reloadOwner();
}

void AdminModule::handleSetConfig(const Config &c)
{
    bool requiresReboot = false;
    switch (c.which_payloadVariant) {
        case Config_device_tag:
            DEBUG_MSG("Setting config: Device\n");
            config.has_device = true;
            config.device = c.payloadVariant.device;
            break;
        case Config_position_tag:
            DEBUG_MSG("Setting config: Position\n");
            config.has_position = true;
            config.position = c.payloadVariant.position;
            break;
        case Config_power_tag:
            DEBUG_MSG("Setting config: Power\n");
            config.has_power = true;
            config.power = c.payloadVariant.power;
            break;
        case Config_wifi_tag:
            DEBUG_MSG("Setting config: WiFi\n");
            config.has_wifi = true;
            config.wifi = c.payloadVariant.wifi;
            requiresReboot = true;
            break;
        case Config_display_tag:
            DEBUG_MSG("Setting config: Display\n");
            config.has_display = true;
            config.display = c.payloadVariant.display;
            break;
        case Config_lora_tag:
            DEBUG_MSG("Setting config: LoRa\n");
            config.has_lora = true;
            config.lora = c.payloadVariant.lora;
            requiresReboot = true;
            break;
        case Config_bluetooth_tag:
            DEBUG_MSG("Setting config: Bluetooth\n");
            config.has_bluetooth = true;
            config.bluetooth = c.payloadVariant.bluetooth;
            requiresReboot = true;
            break;
    }

    service.reloadConfig();
    // Reboot 5 seconds after a config that requires rebooting is set
    if (requiresReboot) {
        DEBUG_MSG("Rebooting due to config changes\n");
        screen->startRebootScreen();
        rebootAtMsec = millis() + (5 * 1000);
    }
}

void AdminModule::handleSetModuleConfig(const ModuleConfig &c)
{
    switch (c.which_payloadVariant) {
        case ModuleConfig_mqtt_tag:
            DEBUG_MSG("Setting module config: MQTT\n");
            moduleConfig.has_mqtt = true;
            moduleConfig.mqtt = c.payloadVariant.mqtt;
            break;
        case ModuleConfig_serial_tag:
            DEBUG_MSG("Setting module config: Serial\n");
            moduleConfig.has_serial = true;
            moduleConfig.serial = c.payloadVariant.serial;
            break;
        case ModuleConfig_external_notification_tag:
            DEBUG_MSG("Setting module config: External Notification\n");
            moduleConfig.has_external_notification = true;
            moduleConfig.external_notification = c.payloadVariant.external_notification;
            break;
        case ModuleConfig_store_forward_tag:
            DEBUG_MSG("Setting module config: Store & Forward\n");
            moduleConfig.has_store_forward = true;
            moduleConfig.store_forward = c.payloadVariant.store_forward;
            break;
        case ModuleConfig_range_test_tag:
            DEBUG_MSG("Setting module config: Range Test\n");
            moduleConfig.has_range_test = true;
            moduleConfig.range_test = c.payloadVariant.range_test;
            break;
        case ModuleConfig_telemetry_tag:
            DEBUG_MSG("Setting module config: Telemetry\n");
            moduleConfig.has_telemetry = true;
            moduleConfig.telemetry = c.payloadVariant.telemetry;
            break;
        case ModuleConfig_canned_message_tag:
            DEBUG_MSG("Setting module config: Canned Message\n");
            moduleConfig.has_canned_message = true;
            moduleConfig.canned_message = c.payloadVariant.canned_message;
            break;
    }

    service.reloadConfig();
}

void AdminModule::handleSetChannel(const Channel &cc)
{
    channels.setChannel(cc);
    channels.onConfigChanged(); // tell the radios about this change
    nodeDB.saveChannelsToDisk();
}

/**
 * Getters
 */

void AdminModule::handleGetOwner(const MeshPacket &req)
{
    if (req.decoded.want_response) {
        // We create the reply here
        AdminMessage res = AdminMessage_init_default;
        res.get_owner_response = owner;

        res.which_variant = AdminMessage_get_owner_response_tag;
        myReply = allocDataProtobuf(res);
    }
}

void AdminModule::handleGetConfig(const MeshPacket &req, const uint32_t configType)
{
    AdminMessage res = AdminMessage_init_default;

    if (req.decoded.want_response) {
        switch (configType) {
        case AdminMessage_ConfigType_DEVICE_CONFIG:
            DEBUG_MSG("Getting config: Device\n");
            res.get_config_response.which_payloadVariant = Config_device_tag;
            res.get_config_response.payloadVariant.device = config.device;
            break;
        case AdminMessage_ConfigType_POSITION_CONFIG:
            DEBUG_MSG("Getting config: Position\n");
            res.get_config_response.which_payloadVariant = Config_position_tag;
            res.get_config_response.payloadVariant.position = config.position;
            break;
        case AdminMessage_ConfigType_POWER_CONFIG:
            DEBUG_MSG("Getting config: Power\n");
            res.get_config_response.which_payloadVariant = Config_power_tag;
            res.get_config_response.payloadVariant.power = config.power;
            break;
        case AdminMessage_ConfigType_WIFI_CONFIG:
            DEBUG_MSG("Getting config: WiFi\n");
            res.get_config_response.which_payloadVariant = Config_wifi_tag;
            res.get_config_response.payloadVariant.wifi = config.wifi;
            writeSecret(res.get_config_response.payloadVariant.wifi.psk, config.wifi.psk);
            break;
        case AdminMessage_ConfigType_DISPLAY_CONFIG:
            DEBUG_MSG("Getting config: Display\n");
            res.get_config_response.which_payloadVariant = Config_display_tag;
            res.get_config_response.payloadVariant.display = config.display;
            break;
        case AdminMessage_ConfigType_LORA_CONFIG:
            DEBUG_MSG("Getting config: LoRa\n");
            res.get_config_response.which_payloadVariant = Config_lora_tag;
            res.get_config_response.payloadVariant.lora = config.lora;
            break;
        case AdminMessage_ConfigType_BLUETOOTH_CONFIG:
            DEBUG_MSG("Getting config: Bluetooth\n");
            res.get_config_response.which_payloadVariant = Config_bluetooth_tag;
            res.get_config_response.payloadVariant.bluetooth = config.bluetooth;
            break;
        }
        // NOTE: The phone app needs to know the ls_secs value so it can properly expect sleep behavior.
        // So even if we internally use 0 to represent 'use default' we still need to send the value we are
        // using to the app (so that even old phone apps work with new device loads).
        // r.get_radio_response.preferences.ls_secs = getPref_ls_secs();
        // hideSecret(r.get_radio_response.preferences.wifi_ssid); // hmm - leave public for now, because only minimally private
        // and useful for users to know current provisioning) hideSecret(r.get_radio_response.preferences.wifi_password);
        // r.get_config_response.which_payloadVariant = Config_ModuleConfig_telemetry_tag;
        res.which_variant = AdminMessage_get_config_response_tag;
        myReply = allocDataProtobuf(res);
    }
}

void AdminModule::handleGetModuleConfig(const MeshPacket &req, const uint32_t configType)
{
    AdminMessage res = AdminMessage_init_default;

    if (req.decoded.want_response) {
        switch (configType) {
        case AdminMessage_ModuleConfigType_MQTT_CONFIG:
            DEBUG_MSG("Getting module config: MQTT\n");
            res.get_module_config_response.which_payloadVariant = ModuleConfig_mqtt_tag;
            res.get_module_config_response.payloadVariant.mqtt = moduleConfig.mqtt;
            break;
        case AdminMessage_ModuleConfigType_SERIAL_CONFIG:
            DEBUG_MSG("Getting module config: Serial\n");
            res.get_module_config_response.which_payloadVariant = ModuleConfig_serial_tag;
            res.get_module_config_response.payloadVariant.serial = moduleConfig.serial;
            break;
        case AdminMessage_ModuleConfigType_EXTNOTIF_CONFIG:
            DEBUG_MSG("Getting module config: External Notification\n");
            res.get_module_config_response.which_payloadVariant = ModuleConfig_external_notification_tag;
            res.get_module_config_response.payloadVariant.external_notification =
                moduleConfig.external_notification;
            break;
        case AdminMessage_ModuleConfigType_STOREFORWARD_CONFIG:
            DEBUG_MSG("Getting module config: Store & Forward\n");
            res.get_module_config_response.which_payloadVariant = ModuleConfig_store_forward_tag;
            res.get_module_config_response.payloadVariant.store_forward = moduleConfig.store_forward;
            break;
        case AdminMessage_ModuleConfigType_RANGETEST_CONFIG:
            DEBUG_MSG("Getting module config: Range Test\n");
            res.get_module_config_response.which_payloadVariant = ModuleConfig_range_test_tag;
            res.get_module_config_response.payloadVariant.range_test = moduleConfig.range_test;
            break;
        case AdminMessage_ModuleConfigType_TELEMETRY_CONFIG:
            DEBUG_MSG("Getting module config: Telemetry\n");
            res.get_module_config_response.which_payloadVariant = ModuleConfig_telemetry_tag;
            res.get_module_config_response.payloadVariant.telemetry = moduleConfig.telemetry;
            break;
        case AdminMessage_ModuleConfigType_CANNEDMSG_CONFIG:
            DEBUG_MSG("Getting module config: Canned Message\n");
            res.get_module_config_response.which_payloadVariant = ModuleConfig_canned_message_tag;
            res.get_module_config_response.payloadVariant.canned_message = moduleConfig.canned_message;
            break;
        }

        // NOTE: The phone app needs to know the ls_secsvalue so it can properly expect sleep behavior.
        // So even if we internally use 0 to represent 'use default' we still need to send the value we are
        // using to the app (so that even old phone apps work with new device loads).
        // r.get_radio_response.preferences.ls_secs = getPref_ls_secs();
        // hideSecret(r.get_radio_response.preferences.wifi_ssid); // hmm - leave public for now, because only minimally private
        // and useful for users to know current provisioning) hideSecret(r.get_radio_response.preferences.wifi_password);
        // r.get_config_response.which_payloadVariant = Config_ModuleConfig_telemetry_tag;
        res.which_variant = AdminMessage_get_module_config_response_tag;
        myReply = allocDataProtobuf(res);
    }
}

void AdminModule::handleGetDeviceMetadata(const MeshPacket &req) {
    AdminMessage r = AdminMessage_init_default;
    
    DeviceMetadata deviceMetadata;
    strncpy(deviceMetadata.firmware_version, myNodeInfo.firmware_version, 18);
    deviceMetadata.device_state_version = DEVICESTATE_CUR_VER;

    r.get_device_metadata_response = deviceMetadata;
    r.which_variant = AdminMessage_get_device_metadata_response_tag;
    myReply = allocDataProtobuf(r);
}

void AdminModule::handleGetChannel(const MeshPacket &req, uint32_t channelIndex)
{
    if (req.decoded.want_response) {
        // We create the reply here
        AdminMessage r = AdminMessage_init_default;
        r.get_channel_response = channels.getByIndex(channelIndex);
        r.which_variant = AdminMessage_get_channel_response_tag;
        myReply = allocDataProtobuf(r);
    }
}

AdminModule::AdminModule() : ProtobufModule("Admin", PortNum_ADMIN_APP, AdminMessage_fields)
{
    // restrict to the admin channel for rx
    boundChannel = Channels::adminChannel;
}