src/controller/python/ChipDeviceController-StorageDelegate.cpp

/*
 *
 *    Copyright (c) 2021-2022 Project CHIP Authors
 *    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 "controller/python/ChipDeviceController-StorageDelegate.h"

#include <cstring>
#include <map>
#include <string>

#include <lib/core/CHIPPersistentStorageDelegate.h>
#include <lib/support/CodeUtils.h>
#include <lib/support/SafeInt.h>
#include <lib/support/logging/CHIPLogging.h>

namespace chip {
namespace Controller {

CHIP_ERROR PythonPersistentStorageDelegate::SyncGetKeyValue(const char * key, void * value, uint16_t & size)
{
    VerifyOrReturnError((value != nullptr) || (size == 0), CHIP_ERROR_INVALID_ARGUMENT);

    auto val = mStorage.find(key);
    if (val == mStorage.end())
    {
        return CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND;
    }

    if (!CanCastTo<uint16_t>(val->second.size()))
    {
        size = 0;
        return CHIP_ERROR_BUFFER_TOO_SMALL;
    }

    uint16_t neededSize = static_cast<uint16_t>(val->second.size());
    VerifyOrReturnError(size != 0 || neededSize != 0, CHIP_NO_ERROR);
    VerifyOrReturnError(value != nullptr, CHIP_ERROR_BUFFER_TOO_SMALL);

    if (size < neededSize)
    {
        memcpy(value, val->second.data(), size);
        return CHIP_ERROR_BUFFER_TOO_SMALL;
    }

    memcpy(value, val->second.data(), neededSize);
    size = neededSize;
    return CHIP_NO_ERROR;
}

CHIP_ERROR PythonPersistentStorageDelegate::SyncSetKeyValue(const char * key, const void * value, uint16_t size)
{
    mStorage[key] = std::string(static_cast<const char *>(value), size);
    ChipLogDetail(Controller, "SyncSetKeyValue on %s", StringOrNullMarker(key));

    return CHIP_NO_ERROR;
}

CHIP_ERROR PythonPersistentStorageDelegate::SyncDeleteKeyValue(const char * key)
{
    auto val = mStorage.find(key);
    if (val == mStorage.end())
    {
        return CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND;
    }

    mStorage.erase(key);
    return CHIP_NO_ERROR;
}

namespace Python {

CHIP_ERROR StorageAdapter::SyncGetKeyValue(const char * key, void * value, uint16_t & size)
{
    ChipLogDetail(Controller, "StorageAdapter::GetKeyValue: Key = %s, Value = %p (%u)", StringOrNullMarker(key), value, size);
    if ((value == nullptr) && (size != 0))
    {
        return CHIP_ERROR_INVALID_ARGUMENT;
    }

    uint16_t tmpSize = size;
    bool isFound     = false;

    mGetKeyCb(mContext, key, (char *) value, &tmpSize, &isFound);

    if (!isFound)
    {
        ChipLogDetail(Controller, "Key Not Found\n");
        return CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND;
    }
    if (size < tmpSize)
    {
        ChipLogDetail(Controller, "Buf not big enough\n");
        return CHIP_ERROR_BUFFER_TOO_SMALL;
    }

    ChipLogDetail(Controller, "Key Found %d\n", tmpSize);
    size = tmpSize;
    return CHIP_NO_ERROR;
}

CHIP_ERROR StorageAdapter::SyncSetKeyValue(const char * key, const void * value, uint16_t size)
{
    VerifyOrReturnError((value != nullptr) || (size == 0), CHIP_ERROR_INVALID_ARGUMENT);
    ChipLogDetail(Controller, "StorageAdapter::SetKeyValue: Key = %s, Value = %p (%u)", StringOrNullMarker(key), value, size);
    mSetKeyCb(mContext, key, value, size);
    return CHIP_NO_ERROR;
}

CHIP_ERROR StorageAdapter::SyncDeleteKeyValue(const char * key)
{
    uint8_t val[1];
    uint16_t size  = 0;
    CHIP_ERROR err = SyncGetKeyValue(key, val, size);
    if (err == CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND)
    {
        return err;
    }

    ChipLogDetail(Controller, "StorageAdapter::DeleteKeyValue: Key = %s", StringOrNullMarker(key));
    mDeleteKeyCb(mContext, key);
    return CHIP_NO_ERROR;
}

} // namespace Python
} // namespace Controller
} // namespace chip