resschedfwk/src/config_reader.cpp

/*
 * Copyright (c) 2022 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.
 */

#include "config_reader.h"
#include "res_sched_log.h"

using namespace std;

namespace OHOS {
namespace ResourceSchedule {
namespace {
constexpr auto XML_TAG_RES_SCHED = "ressched";
constexpr auto XML_TAG_PLUGIN = "plugin";
constexpr auto XML_TAG_CONFIG = "config";
constexpr auto XML_TAG_ITEM = "item";
constexpr auto XML_ATTR_NAME = "name";
}

bool ConfigReader::IsInvalidNode(const xmlNode& currNode)
{
    if (!currNode.name || currNode.type == XML_COMMENT_NODE) {
        return true;
    }
    return false;
}

void ConfigReader::ParseProperties(const xmlNode& currNode, map<string, string>& properties)
{
    auto attrs = currNode.properties;
    xmlChar *value;
    for (; attrs; attrs = attrs->next) {
        auto name = attrs->name;
        if (!name) {
            RESSCHED_LOGW("ConfigReader::ParseProperties name null!");
            continue;
        }
        value = xmlGetProp(&currNode, name);
        if (!value) {
            RESSCHED_LOGW("ConfigReader::ParseProperties name(%{public}s) value null!", name);
            continue;
        }
        properties[reinterpret_cast<const char*>(name)] = reinterpret_cast<const char*>(value);
        xmlFree(value);
    }
}

void ConfigReader::ParseSubItem(const xmlNode& parentNode, Item& item)
{
    auto currNodePtr = parentNode.xmlChildrenNode;
    xmlChar *value;
    for (; currNodePtr; currNodePtr = currNodePtr->next) {
        if (IsInvalidNode(*currNodePtr)) {
            RESSCHED_LOGW("ConfigReader::ParseSubItem skip invalid node!");
            continue;
        }
        SubItem subItem;
        ParseProperties(*currNodePtr, subItem.properties);
        subItem.name = reinterpret_cast<const char*>(currNodePtr->name);
        value = xmlNodeGetContent(currNodePtr);
        if (value) {
            string itemValue(reinterpret_cast<const char*>(value));
            subItem.value = std::move(itemValue);
            xmlFree(value);
        }
        item.subItemList.emplace_back(subItem);
    }
}

void ConfigReader::ParseItem(const xmlNode& parentNode, PluginConfig& pluginConfig)
{
    auto currNodePtr = parentNode.xmlChildrenNode;
    for (; currNodePtr; currNodePtr = currNodePtr->next) {
        if (IsInvalidNode(*currNodePtr) ||
            xmlStrcmp(currNodePtr->name, reinterpret_cast<const xmlChar*>(XML_TAG_ITEM)) != 0) {
            continue;
        }
        Item item;
        ParseProperties(*currNodePtr, item.itemProperties);
        ParseSubItem(*currNodePtr, item);
        pluginConfig.itemList.emplace_back(item);
    }
}

void ConfigReader::ParseConfig(const xmlNode& parentNode, PluginConfigMap& pluginConfigMap)
{
    auto currNodePtr = parentNode.xmlChildrenNode;
    for (; currNodePtr; currNodePtr = currNodePtr->next) {
        if (IsInvalidNode(*currNodePtr) ||
            xmlStrcmp(currNodePtr->name, reinterpret_cast<const xmlChar*>(XML_TAG_CONFIG)) != 0) {
            continue;
        }
        auto propName = xmlGetProp(currNodePtr, reinterpret_cast<const xmlChar*>(XML_ATTR_NAME));
        if (!propName) {
            RESSCHED_LOGW("ConfigReader::ParseConfig propName null!");
            continue;
        }

        string configName(reinterpret_cast<char*>(propName));
        xmlFree(propName);
        auto& pluginConfig = pluginConfigMap[configName];
        ParseItem(*currNodePtr, pluginConfig);
    }
}

bool ConfigReader::ParsePluginConfig(const xmlNode& currNode, map<string, PluginConfigMap>& pluginConfigs)
{
    auto propName = xmlGetProp(&currNode, reinterpret_cast<const xmlChar*>(XML_ATTR_NAME));
    if (!propName) {
        RESSCHED_LOGW("ConfigReader::ParsePluginConfig propName null!");
        return false;
    }
    string pluginName(reinterpret_cast<char*>(propName));
    xmlFree(propName);
    ParseConfig(currNode, pluginConfigs[pluginName]);
    return true;
}

bool ConfigReader::LoadFromCustConfigFile(const string& configFile)
{
    // skip the empty string, else you will get empty node
    xmlDocPtr xmlDocPtr = xmlReadFile(configFile.c_str(), nullptr, XML_PARSE_NOBLANKS);
    if (!xmlDocPtr) {
        RESSCHED_LOGE("ConfigReader::LoadFromCustConfigFile xmlReadFile error!");
        return false;
    }
    xmlNodePtr rootNodePtr = xmlDocGetRootElement(xmlDocPtr);
    if (!rootNodePtr || !rootNodePtr->name ||
        xmlStrcmp(rootNodePtr->name, reinterpret_cast<const xmlChar*>(XML_TAG_RES_SCHED)) != 0) {
        RESSCHED_LOGE("ConfigReader::LoadFromCustConfigFile root element tag wrong!");
        xmlFreeDoc(xmlDocPtr);
        return false;
    }
    map<string, PluginConfigMap> allPluginConfigs;
    xmlNodePtr currNodePtr = rootNodePtr->xmlChildrenNode;
    for (; currNodePtr; currNodePtr = currNodePtr->next) {
        if (IsInvalidNode(*currNodePtr)) {
            continue;
        }
        bool ret = false;
        if (xmlStrcmp(currNodePtr->name, reinterpret_cast<const xmlChar*>(XML_TAG_PLUGIN)) == 0) {
            ret = ParsePluginConfig(*currNodePtr, allPluginConfigs);
        }
        if (!ret) {
            RESSCHED_LOGW("ConfigReader::LoadFromCustConfigFile plugin (%{public}s) config wrong!", currNodePtr->name);
            xmlFreeDoc(xmlDocPtr);
            return false;
        }
    }
    xmlFreeDoc(xmlDocPtr);
    lock_guard<mutex> autoLock(configMutex_);
    allPluginConfigs_ = std::move(allPluginConfigs);
    return true;
}

PluginConfig ConfigReader::GetConfig(const std::string& pluginName, const std::string& configName)
{
    lock_guard<mutex> autoLock(configMutex_);
    PluginConfig config;
    auto itMap = allPluginConfigs_.find(pluginName);
    if (itMap == allPluginConfigs_.end()) {
        RESSCHED_LOGE("ConfigReader::GetConfig no pluginName:%{public}s config!", pluginName.c_str());
        return config;
    }
    PluginConfigMap configMap = allPluginConfigs_[pluginName];
    auto itConfig = configMap.find(configName);
    if (itConfig == configMap.end()) {
        RESSCHED_LOGE("ConfigReader::GetConfig pluginName:%{public}s config:%{public}s null!",
            pluginName.c_str(), configName.c_str());
        return config;
    }
    return configMap[configName];
}
} // namespace ResourceSchedule
} // namespace OHOS