innerkitsimpl/data/unified_data_helper.cpp

/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * 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.
 */
#define LOG_TAG "UnifiedDataHelper"
#include "unified_data_helper.h"

#include "common_func.h"
#include "directory_ex.h"
#include "file_ex.h"
#include "file.h"
#include "file_uri.h"
#include "error_code.h"
#include "logger.h"
#include "tlv_util.h"
#include "udmf_conversion.h"
#include "udmf_meta.h"
#include "udmf_utils.h"
#include "utd_client.h"

namespace OHOS {
namespace UDMF {
constexpr mode_t MODE = 0700;
static constexpr int64_t MAX_IPC_RAW_DATA_SIZE = 127 * 1024 * 1024;
static constexpr int64_t MAX_SA_DRAG_RECORD_SIZE  = 15 * 1024 * 1024 + 512 * 1024;

constexpr const char *TEMP_UNIFIED_DATA_ROOT_PATH = "data/storage/el2/base/temp/udata";
constexpr const char *TEMP_UNIFIED_DATA_SUFFIX = ".ud";
constexpr const char *TEMP_UNIFIED_DATA_FLAG = "temp_udmf_file_flag";
static constexpr int WITH_SUMMARY_FORMAT_VER = 1;
std::string UnifiedDataHelper::rootPath_ = "";

void UnifiedDataHelper::SetRootPath(const std::string &rootPath)
{
    rootPath_ = rootPath;
}

bool UnifiedDataHelper::ExceedKVSizeLimit(UnifiedData &data)
{
    int64_t totalSize = 0;
    for (const auto &record : data.GetRecords()) {
        auto recordSize = record->GetSize();
        if (recordSize > MAX_SA_DRAG_RECORD_SIZE) {
            LOG_INFO(UDMF_FRAMEWORK, "Exceeded 15.5M record limit, recordSize:%{public}" PRId64 "!", recordSize);
            return true;
        }
        totalSize += recordSize;
    }
    if (totalSize > MAX_IPC_RAW_DATA_SIZE) {
        LOG_INFO(UDMF_FRAMEWORK, "Exceeded 127M data limit, totalSize:%{public}" PRId64 " !", totalSize);
        return true;
    }
    return false;
}

bool UnifiedDataHelper::IsTempUData(UnifiedData &data)
{
    auto records = data.GetRecords();
    if (records.size() != 1) {
        return false;
    }
    if (records[0] == nullptr || records[0]->GetType() != UDType::FILE) {
        return false;
    }
    auto file = static_cast<File*>(records[0].get());
    if (file == nullptr) {
        LOG_ERROR(UDMF_FRAMEWORK, "Invalid file record!");
        return false;
    }
    auto details = file->GetDetails();
    if (details.find(TEMP_UNIFIED_DATA_FLAG) == details.end()) {
        return false;
    }
    LOG_DEBUG(UDMF_FRAMEWORK, "exist temp unified data flag!");
    return true;
}

void UnifiedDataHelper::CreateDirIfNotExist(const std::string& dirPath, const mode_t& mode)
{
    if (OHOS::FileExists(dirPath)) {
        if (!OHOS::ForceRemoveDirectory(dirPath)) {
            LOG_ERROR(UDMF_FRAMEWORK, "remove dir failed, errno: %{public}d.", errno);
        }
    }
    bool success = OHOS::ForceCreateDirectory(dirPath);
    if (!success) {
        LOG_ERROR(UDMF_FRAMEWORK, "create dir failed, errno: %{public}d.", errno);
        return;
    }
    if (mode != 0) {
        chmod(dirPath.c_str(), mode);
    }
}

void UnifiedDataHelper::GetSummary(const UnifiedData &data, Summary &summary)
{
    for (const auto &record : data.GetRecords()) {
        CalRecordSummary(*record->GetEntries(), summary);
    }
    summary.version = WITH_SUMMARY_FORMAT_VER;
}

void UnifiedDataHelper::GetSummaryFromLoadInfo(const DataLoadInfo &dataLoadInfo, Summary &summary)
{
    summary.totalSize = dataLoadInfo.recordCount;
    for (const auto &type : dataLoadInfo.types) {
        summary.summary.emplace(type, 0);
    }
}

bool UnifiedDataHelper::Pack(UnifiedData &data)
{
    UdmfConversion::InitValueObject(data);

    Summary summary;
    GetSummary(data, summary);

    int64_t now = std::chrono::duration_cast<std::chrono::milliseconds>
                    (std::chrono::system_clock::now().time_since_epoch()).count();
    CreateDirIfNotExist(GetRootPath(), MODE);
    std::string filePath = GetRootPath() + std::to_string(now) + TEMP_UNIFIED_DATA_SUFFIX;
    if (!SaveUDataToFile(filePath, data)) {
        LOG_ERROR(UDMF_FRAMEWORK, "fail to save unified data to file");
        return false;
    }
    std::string uri = AppFileService::CommonFunc::GetUriFromPath(filePath);
    auto fileRecord = std::make_shared<File>(uri);
    UDDetails details;
    details.insert(std::make_pair(TEMP_UNIFIED_DATA_FLAG, true));
    for (auto &item : summary.summary) {
        details.insert(std::make_pair(item.first, item.second));
    }
    fileRecord->SetDetails(details);
    std::vector<std::shared_ptr<UnifiedRecord>> records {};
    records.emplace_back(fileRecord);
    data.SetRecords(records);
    return true;
}

bool UnifiedDataHelper::Unpack(UnifiedData &data)
{
    auto records = data.GetRecords();
    if (records.size() != 1) {
        return false;
    }

    auto file = static_cast<File*>(records[0].get());
    if (file == nullptr) {
        LOG_ERROR(UDMF_FRAMEWORK, "Invalid file record!");
        return false;
    }
    UnifiedData tempData;
    if (!LoadUDataFromFile(file->GetUri(), tempData)) {
        LOG_ERROR(UDMF_FRAMEWORK, "Fail to load udata from file!");
        return false;
    }
    data.SetRecords(tempData.GetRecords());
    return true;
}

bool UnifiedDataHelper::SaveUDataToFile(const std::string &dataFile, UnifiedData &data)
{
    std::vector<uint8_t> dataBytes;
    auto recordTlv = TLVObject(dataBytes);

    std::FILE *file = fopen(dataFile.c_str(), "w+");
    if (file == nullptr) {
        LOG_ERROR(UDMF_FRAMEWORK, "failed to open file: errno is %{public}d", errno);
        return false;
    }
    recordTlv.SetFile(file);
    UdmfConversion::InitValueObject(data);
    if (!TLVUtil::Writing(data, recordTlv, TAG::TAG_UNIFIED_DATA)) {
        LOG_ERROR(UDMF_FRAMEWORK, "TLV Writing failed!");
        return FileClose(file, false);
    }
    return FileClose(file, true);
}

bool UnifiedDataHelper::LoadUDataFromFile(const std::string &dataFile, UnifiedData &data)
{
    std::vector<uint8_t> dataBytes;
    auto recordTlv = TLVObject(dataBytes);
    AppFileService::ModuleFileUri::FileUri fileUri(dataFile);
    std::string path = fileUri.GetRealPath();
    std::FILE *file = fopen(path.c_str(), "r");
    if (file == nullptr) {
        LOG_ERROR(UDMF_FRAMEWORK, "failed to open file, error:%{public}s", std::strerror(errno));
        return false;
    }
    recordTlv.SetFile(file);

    if (!TLVUtil::ReadTlv(data, recordTlv, TAG::TAG_UNIFIED_DATA)) {
        LOG_ERROR(UDMF_FRAMEWORK, "TLV Reading failed!");
        return FileClose(file, false);
    }
    UdmfConversion::ConvertRecordToSubclass(data);
    return FileClose(file, true);
}

bool UnifiedDataHelper::FileClose(std::FILE *file, bool status)
{
    if (file == nullptr) {
        return false;
    }
    if ((fclose(file) == EOF)) {
        LOG_ERROR(UDMF_FRAMEWORK, "fclose is failed");
        return false;
    }
    return status;
}

std::string UnifiedDataHelper::GetRootPath()
{
    if (rootPath_ == "") {
        return TEMP_UNIFIED_DATA_ROOT_PATH;
    }
    return rootPath_;
}

int32_t UnifiedDataHelper::ProcessBigData(UnifiedData &data, Intention intention, bool isSaInvoke)
{
    if (!isSaInvoke) {
        return UnifiedDataHelper::Pack(data) ? E_OK : E_FS_ERROR;
    }
    if (intention != Intention::UD_INTENTION_DRAG) {
        LOG_ERROR(UDMF_SERVICE, "Non-Drag cannot be used to process big data when SA initiates a request");
        return E_INVALID_PARAMETERS;
    }
    int64_t dataSize = 0;
    for (const auto &record : data.GetRecords()) {
        auto recordSize = record->GetSize();
        if (recordSize > MAX_SA_DRAG_RECORD_SIZE) {
            LOG_ERROR(UDMF_FRAMEWORK, "Exceeded KV record limit, recordSize:%{public}" PRId64 "!", recordSize);
            return E_INVALID_PARAMETERS;
        }
        dataSize += recordSize;
    }
    if (dataSize > MAX_IPC_RAW_DATA_SIZE) {
        LOG_ERROR(UDMF_SERVICE, "Exceeded ipc-send data limit, totalSize:%{public}" PRId64 " !", dataSize);
        return E_INVALID_PARAMETERS;
    }
    LOG_DEBUG(UDMF_SERVICE, "Processing udmf data in memory");
    return E_OK;
}

void UnifiedDataHelper::ProcessTypeId(const ValueType &value, std::string &typeId)
{
    if (!std::holds_alternative<std::shared_ptr<Object>>(value)) {
        return;
    }
    auto object = std::get<std::shared_ptr<Object>>(value);
    if (object->value_.find(UNIFORM_DATA_TYPE) == object->value_.end()) {
        return;
    }
    if (object->value_.find(APPLICATION_DEFINED_RECORD_MARK) != object->value_.end()) {
        typeId = UtdUtils::GetUtdIdFromUtdEnum(APPLICATION_DEFINED_RECORD);
    } else if (std::get<std::string>(object->value_[UNIFORM_DATA_TYPE]) == GENERAL_FILE_URI &&
        object->value_.find(FILE_TYPE) != object->value_.end()) {
        std::string fileType = std::get<std::string>(object->value_[FILE_TYPE]);
        if (!fileType.empty()) {
            typeId = fileType;
        }
    }
}

void UnifiedDataHelper::CalRecordSummary(std::map<std::string, ValueType> &entry, Summary &summary)
{
    for (const auto &[utdId, value] : entry) {
        auto typeId = utdId;
        auto valueSize = ObjectUtils::GetValueSize(value, false);
        ProcessTypeId(value, typeId);
        auto specificIter = summary.specificSummary.find(typeId);
        if (specificIter == summary.specificSummary.end()) {
            summary.specificSummary[typeId] = valueSize;
        } else {
            summary.specificSummary[typeId] += valueSize;
        }
        FillSummaryFormat(typeId, utdId, summary);
        if (utdId == GENERAL_FILE_URI) {
            UpgradeToParentType(typeId);
        }
        auto it = summary.summary.find(typeId);
        if (it == summary.summary.end()) {
            summary.summary[typeId] = valueSize;
        } else {
            summary.summary[typeId] += valueSize;
        }
        summary.totalSize += valueSize;
    }
}

void UnifiedDataHelper::FillSummaryFormat(const std::string &type, const std::string &utdId, Summary &summary)
{
    Uds_Type udsType = Uds_Type::UDS_OTHER;
    auto find = UDS_UTD_TYPE_MAP.find(utdId);
    if (find != UDS_UTD_TYPE_MAP.end()) {
        udsType = find->second;
    }
    if (summary.summaryFormat.find(type) != summary.summaryFormat.end()) {
        summary.summaryFormat[type].emplace_back(udsType);
    } else {
        summary.summaryFormat[type] = { udsType };
    }
}

void UnifiedDataHelper::UpgradeToParentType(std::string &typeId)
{
    std::string fileType = UnifiedDataUtils::GetBelongsToFileType(typeId);
    if (!fileType.empty()) {
        typeId = fileType;
        return;
    }
    typeId = "general.file"; // When utdId is general.file-uri, the default parent type is general.file.
}

} // namespace UDMF
} // namespace OHOS