src/adaptations/device-layer/DeviceControlServer.cpp

/*
 *
 *    Copyright (c) 2019 Google LLC.
 *    Copyright (c) 2018 Nest Labs, Inc.
 *    All rights reserved.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#include <Weave/DeviceLayer/internal/WeaveDeviceLayerInternal.h>
#include <Weave/DeviceLayer/internal/DeviceControlServer.h>
#include <Weave/DeviceLayer/internal/FabricProvisioningServer.h>
#include <Weave/Profiles/WeaveProfiles.h>
#include <Weave/Profiles/common/CommonProfile.h>

using namespace ::nl;
using namespace ::nl::Weave;
using namespace ::nl::Weave::Profiles;
using namespace ::nl::Weave::Profiles::Common;
using namespace ::nl::Weave::Profiles::DeviceControl;

namespace nl {
namespace Weave {
namespace DeviceLayer {
namespace Internal {

DeviceControlServer DeviceControlServer::sInstance;

WEAVE_ERROR DeviceControlServer::Init()
{
    WEAVE_ERROR err;

    // Call init on the server base class.
    err = ServerBaseClass::Init(&::nl::Weave::DeviceLayer::ExchangeMgr);
    SuccessOrExit(err);

    // Set the pointer to the delegate object.
    SetDelegate(this);

exit:
    return err;
}

bool DeviceControlServer::ShouldCloseConBeforeResetConfig(uint16_t resetFlags)
{
    // Force connection closed on reset to factory defaults.
    return (resetFlags & kResetConfigFlag_FactoryDefaults) != 0;
}

WEAVE_ERROR DeviceControlServer::OnResetConfig(uint16_t resetFlags)
{
    WEAVE_ERROR err = WEAVE_NO_ERROR;
    WEAVE_ERROR tmpErr;

    // If a factory reset has been requested, initiate it now.
    if ((resetFlags & kResetConfigFlag_FactoryDefaults) != 0)
    {
        ConfigurationMgr().InitiateFactoryReset();
    }

    else
    {
        // If a service config request has been requested, clear the persisted
        // service provisioning data, if present.
        if ((resetFlags & kResetConfigFlag_ServiceConfig) != 0)
        {
            WeaveLogProgress(DeviceLayer, "Reset service config");
            tmpErr = ConfigurationMgr().ClearServiceProvisioningData();
            if (tmpErr != WEAVE_NO_ERROR)
            {
                WeaveLogProgress(DeviceLayer, "ConfigurationMgr().ClearServiceProvisioningData() failed: %s", ErrorStr(tmpErr));
                err = (err == WEAVE_NO_ERROR) ? tmpErr : err;
            }
        }

        // If a fabric config reset has been requested then leave the Weave
        // fabric.
        if ((resetFlags & kResetConfigFlag_FabricConfig) != 0)
        {
            WeaveLogProgress(DeviceLayer, "Reset Weave fabric config");
            tmpErr = FabricProvisioningSvr().LeaveFabric();
            if (tmpErr != WEAVE_NO_ERROR)
            {
                WeaveLogProgress(DeviceLayer, "FabricProvisioningSvr().LeaveFabric() failed: %s", ErrorStr(tmpErr));
                err = (err == WEAVE_NO_ERROR) ? tmpErr : err;
            }
        }

        // If a network config reset has been requested, clear the
        // WiFi station provision.
        if ((resetFlags & kResetConfigFlag_NetworkConfig) != 0)
        {
            WeaveLogProgress(DeviceLayer, "Reset network config");

#if WEAVE_DEVICE_CONFIG_ENABLE_WIFI_STATION
            ConnectivityMgr().ClearWiFiStationProvision();
#endif // WEAVE_DEVICE_CONFIG_ENABLE_WIFI_STATION

#if WEAVE_DEVICE_CONFIG_ENABLE_THREAD
            ThreadStackMgr().ClearThreadProvision();
#endif // WEAVE_DEVICE_CONFIG_ENABLE_THREAD
        }

#if WEAVE_DEVICE_CONFIG_ENABLE_OPERATIONAL_DEVICE_CREDENTIALS
        // If a credentials config request has been requested, clear the credential
        // data, if present.
        if ((resetFlags & kResetConfigFlag_Credentials) != 0)
        {
            WeaveLogProgress(DeviceLayer, "Reset credentials");
            tmpErr = ConfigurationMgr().ClearDeviceCredentials();
            if (tmpErr != WEAVE_NO_ERROR)
            {
                WeaveLogProgress(DeviceLayer, "ConfigurationMgr().ClearDeviceCredentials() failed: %s", ErrorStr(tmpErr));
                err = (err == WEAVE_NO_ERROR) ? tmpErr : err;
            }
        }
#endif // WEAVE_DEVICE_CONFIG_ENABLE_OPERATIONAL_DEVICE_CREDENTIALS
    }

    return err;
}

WEAVE_ERROR DeviceControlServer::OnFailSafeArmed(void)
{
    WEAVE_ERROR err;

    err = ConfigurationMgr().SetFailSafeArmed(true);
    SuccessOrExit(err);

exit:
    return err;
}

WEAVE_ERROR DeviceControlServer::OnFailSafeDisarmed(void)
{
    WEAVE_ERROR err;

    err = ConfigurationMgr().SetFailSafeArmed(false);
    SuccessOrExit(err);

exit:
    return err;
}

void DeviceControlServer::OnConnectionMonitorTimeout(uint64_t peerNodeId, IPAddress peerAddr)
{
}

void DeviceControlServer::OnRemotePassiveRendezvousStarted(void)
{
    // Not used.
}

void DeviceControlServer::OnRemotePassiveRendezvousDone(void)
{
    // Not used.
}

WEAVE_ERROR DeviceControlServer::WillStartRemotePassiveRendezvous(void)
{
    // Not used.
    return WEAVE_ERROR_NOT_IMPLEMENTED;
}

void DeviceControlServer::WillCloseRemotePassiveRendezvous(void)
{
    // Not used.
}

bool DeviceControlServer::IsResetAllowed(uint16_t resetFlags)
{
    // If factory reset requested, defer to the Configuration Manager to determine if the
    // system is in a state where this is allowed.
    if ((resetFlags & kResetConfigFlag_FactoryDefaults) != 0)
    {
        return ConfigurationMgr().CanFactoryReset();
    }

    const uint16_t supportedResetOps =
            (kResetConfigFlag_NetworkConfig | kResetConfigFlag_FabricConfig |
             kResetConfigFlag_ServiceConfig | kResetConfigFlag_Credentials);

    // Otherwise, verify the requested reset operation is supported.
    return (resetFlags == kResetConfigFlag_All || (resetFlags & ~supportedResetOps) == 0);
}

WEAVE_ERROR DeviceControlServer::OnSystemTestStarted(uint32_t profileId, uint32_t testId)
{
    WEAVE_ERROR err;

    err = SendStatusReport(kWeaveProfile_Common, kStatus_UnsupportedMessage);
    SuccessOrExit(err);

exit:
    return err;
}

WEAVE_ERROR DeviceControlServer::OnSystemTestStopped(void)
{
    WEAVE_ERROR err;

    err = SendSuccessResponse();
    SuccessOrExit(err);

exit:
    return err;
}

bool DeviceControlServer::IsPairedToAccount() const
{
    return ConfigurationMgr().IsServiceProvisioned() && ConfigurationMgr().IsPairedToAccount();
}

void DeviceControlServer::OnPlatformEvent(const WeaveDeviceEvent * event)
{
    // Nothing to do so far.
}

} // namespace Internal
} // namespace DeviceLayer
} // namespace Weave
} // namespace nl