* Copyright (c) 2024-2025 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 "UtdClient"
#include <fstream>
#include <regex>
#include <thread>
#include "utd_client.h"
#include "logger.h"
#include "utd_graph.h"
#include "custom_utd_store.h"
namespace OHOS {
namespace UDMF {
constexpr const int MAX_UTD_LENGTH = 256;
constexpr const char *CUSTOM_UTD_HAP_DIR = "/data/utd/utd-adt.json";
UtdClient::UtdClient()
{
Init();
}
UtdClient::~UtdClient()
{
}
UtdClient &UtdClient::GetInstance()
{
static auto instance = new UtdClient();
return *instance;
}
std::vector<TypeDescriptorCfg> GetHapTypeCfgs()
{
LOG_DEBUG(UDMF_CLIENT, "get utdcustom from cfg, Path:%{public}s.", CUSTOM_UTD_HAP_DIR);
std::string jsonStr;
std::ifstream fin(CUSTOM_UTD_HAP_DIR);
while (fin.good()) {
std::string line;
std::getline(fin, line);
jsonStr += line;
}
std::vector<TypeDescriptorCfg> customUtdTypes;
CustomUtdJsonParser utdJsonParser;
utdJsonParser.ParseStoredCustomUtdJson(jsonStr, customUtdTypes);
LOG_DEBUG(UDMF_CLIENT, "GetTypeCfgs, customUtdTypes total:%{public}zu.", customUtdTypes.size());
return customUtdTypes;
}
void UtdClient::Init()
{
std::unique_lock<std::shared_mutex> lock(utdMutex_);
descriptorCfgs_ = PresetTypeDescriptors::GetInstance().GetPresetTypes();
std::vector<TypeDescriptorCfg> customTypes;
customTypes = GetHapTypeCfgs();
LOG_INFO(UDMF_CLIENT, "get customUtd, size:%{public}zu", customTypes.size());
if (!customTypes.empty()) {
descriptorCfgs_.insert(descriptorCfgs_.end(), customTypes.begin(), customTypes.end());
}
UtdGraph::GetInstance().InitUtdGraph(descriptorCfgs_);
}
bool UtdClient::IsHapTokenType()
{
return true;
}
Status UtdClient::GetCurrentActiveUserId(int32_t &userId)
{
return Status::E_OK;
}
Status UtdClient::GetTypeDescriptor(const std::string &typeId, std::shared_ptr<TypeDescriptor> &descriptor)
{
{
std::shared_lock<std::shared_mutex> guard(utdMutex_);
for (const auto &utdTypeCfg : descriptorCfgs_) {
if (utdTypeCfg.typeId == typeId) {
descriptor = std::make_shared<TypeDescriptor>(utdTypeCfg);
return Status::E_OK;
}
}
}
if (typeId.find(FLEXIBLE_TYPE_FLAG) != typeId.npos) {
return GetFlexibleTypeDescriptor(typeId, descriptor);
}
return Status::E_OK;
}
bool UtdClient::IsValidFileExtension(const std::string &fileExtension)
{
if (fileExtension.empty()) {
return false;
}
if (fileExtension[0] != '.' || fileExtension.find("?") != fileExtension.npos ||
fileExtension.find(":") != fileExtension.npos || fileExtension.find("=") != fileExtension.npos ||
fileExtension.find("\\") != fileExtension.npos) {
return false;
}
return true;
}
bool UtdClient::IsValidMimeType(const std::string &mimeType)
{
if (mimeType.empty()) {
return false;
}
if (mimeType.find("?") != mimeType.npos || mimeType.find(":") != mimeType.npos ||
mimeType.find("=") != mimeType.npos || mimeType.find("\\") != mimeType.npos) {
return false;
}
return true;
}
Status UtdClient::GetFlexibleTypeDescriptor(const std::string &typeId, std::shared_ptr<TypeDescriptor> &descriptor)
{
TypeDescriptorCfg flexibleTypeDescriptorCfg;
if (!FlexibleType::ParseFlexibleUtd(typeId, flexibleTypeDescriptorCfg)) {
LOG_ERROR(UDMF_CLIENT, "ParseFlexibleUtd failed, invalid typeId");
return Status::E_ERROR;
}
descriptor = std::make_shared<TypeDescriptor>(flexibleTypeDescriptorCfg);
return Status::E_OK;
}
Status UtdClient::GetUniformDataTypeByFilenameExtension(const std::string &fileExtension, std::string &typeId,
std::string belongsTo)
{
std::string lowerFileExtension = fileExtension;
std::transform(lowerFileExtension.begin(), lowerFileExtension.end(), lowerFileExtension.begin(), ::tolower);
if (belongsTo != DEFAULT_TYPE_ID && !UtdGraph::GetInstance().IsValidType(belongsTo)) {
LOG_ERROR(UDMF_CLIENT, "invalid belongsTo.");
return Status::E_INVALID_PARAMETERS;
}
{
std::shared_lock<std::shared_mutex> guard(utdMutex_);
bool found = false;
for (const auto &utdTypeCfg : descriptorCfgs_) {
for (auto fileEx : utdTypeCfg.filenameExtensions) {
std::transform(fileEx.begin(), fileEx.end(), fileEx.begin(), ::tolower);
if (fileEx == lowerFileExtension) {
typeId = utdTypeCfg.typeId;
found = true;
break;
}
}
if (found) {
break;
}
}
}
if (!typeId.empty() && belongsTo != DEFAULT_TYPE_ID && belongsTo != typeId &&
!UtdGraph::GetInstance().IsLowerLevelType(belongsTo, typeId)) {
typeId = "";
}
if (typeId.empty()) {
if (!IsValidFileExtension(lowerFileExtension)) {
LOG_ERROR(UDMF_CLIENT, "invalid fileExtension.");
return Status::E_INVALID_PARAMETERS;
}
typeId = FlexibleType::GenFlexibleUtd("", lowerFileExtension, belongsTo);
}
return Status::E_OK;
}
Status UtdClient::GetUniformDataTypeByMIMEType(const std::string &mimeType, std::string &typeId,
std::string belongsTo)
{
std::string lowerMimeType = mimeType;
std::transform(lowerMimeType.begin(), lowerMimeType.end(), lowerMimeType.begin(), ::tolower);
if (belongsTo != DEFAULT_TYPE_ID && !UtdGraph::GetInstance().IsValidType(belongsTo)) {
LOG_ERROR(UDMF_CLIENT, "invalid belongsTo.");
return Status::E_INVALID_PARAMETERS;
}
typeId = GetTypeIdFromCfg(lowerMimeType);
if (!typeId.empty() && belongsTo != DEFAULT_TYPE_ID && belongsTo != typeId &&
!UtdGraph::GetInstance().IsLowerLevelType(belongsTo, typeId)) {
typeId = "";
}
if (typeId.empty()) {
if (!IsValidMimeType(mimeType)) {
LOG_ERROR(UDMF_CLIENT, "invalid mimeType.");
return Status::E_INVALID_PARAMETERS;
}
typeId = FlexibleType::GenFlexibleUtd(lowerMimeType, "", belongsTo);
}
return Status::E_OK;
}
Status UtdClient::IsUtd(std::string typeId, bool &result)
{
if (typeId.empty() || typeId.size() > MAX_UTD_LENGTH) {
result = false;
return Status::E_INVALID_PARAMETERS;
}
if (typeId[0] == '.' || find(typeId.begin(), typeId.end(), '/') != typeId.end()) {
result = false;
return Status::E_OK;
}
constexpr const char *preSetTypeIdRegexRule =
R"(^(general\.|openharmony\.|org\.|com\.|macos\.|debian\.|redhat\.|io\.|de\.|net\.)[a-z0-9-\.]+(\-[a-z0-9-]+)*$)";
if (std::regex_match(typeId, std::regex(preSetTypeIdRegexRule))) {
result = true;
return Status::E_OK;
}
constexpr const char *customUtdRegexRule =
R"(^([A-Za-z]\w*)(\.\w+)+(\.[A-Za-z\d-]+)+)";
if (std::regex_match(typeId, std::regex(customUtdRegexRule))) {
result = true;
return Status::E_OK;
}
result = false;
LOG_ERROR(UDMF_CLIENT, "is not utd");
return Status::E_OK;
}
Status UtdClient::GetUniformDataTypesByFilenameExtension(const std::string &fileExtension,
std::vector<std::string> &typeIds, const std::string &belongsTo)
{
if (belongsTo != DEFAULT_TYPE_ID && !UtdGraph::GetInstance().IsValidType(belongsTo)) {
LOG_ERROR(UDMF_CLIENT, "invalid belongsTo.");
return Status::E_INVALID_PARAMETERS;
}
if (!IsValidFileExtension(fileExtension)) {
LOG_ERROR(UDMF_CLIENT, "invalid fileExtension.");
return Status::E_INVALID_PARAMETERS;
}
std::string lowerFileExtension = fileExtension;
std::transform(lowerFileExtension.begin(), lowerFileExtension.end(), lowerFileExtension.begin(), ::tolower);
std::vector<std::string> typeIdsInCfg;
{
std::shared_lock<std::shared_mutex> guard(utdMutex_);
for (const auto &utdTypeCfg : descriptorCfgs_) {
for (auto fileEx : utdTypeCfg.filenameExtensions) {
std::transform(fileEx.begin(), fileEx.end(), fileEx.begin(), ::tolower);
if (fileEx == lowerFileExtension) {
typeIdsInCfg.push_back(utdTypeCfg.typeId);
break;
}
}
}
}
typeIds.clear();
for (const auto &typeId : typeIdsInCfg) {
if (belongsTo != DEFAULT_TYPE_ID && belongsTo != typeId &&
!UtdGraph::GetInstance().IsLowerLevelType(belongsTo, typeId)) {
continue;
}
typeIds.emplace_back(typeId);
}
if (typeIds.empty()) {
typeIds.emplace_back(FlexibleType::GenFlexibleUtd("", lowerFileExtension, belongsTo));
}
return Status::E_OK;
}
std::string UtdClient::GetTypeIdFromCfg(const std::string &mimeType)
{
std::shared_lock<std::shared_mutex> guard(utdMutex_);
for (const auto &utdTypeCfg : descriptorCfgs_) {
for (auto mime : utdTypeCfg.mimeTypes) {
std::transform(mime.begin(), mime.end(), mime.begin(), ::tolower);
if (mime == mimeType) {
return utdTypeCfg.typeId;
}
}
}
if (mimeType.empty() || mimeType.back() != '*') {
return "";
}
std::string prefixType = mimeType.substr(0, mimeType.length() - 1);
for (const auto &utdTypeCfg : descriptorCfgs_) {
for (auto mime : utdTypeCfg.mimeTypes) {
std::transform(mime.begin(), mime.end(), mime.begin(), ::tolower);
if (mime.rfind(prefixType, 0) == 0 && utdTypeCfg.belongingToTypes.size() > 0) {
return utdTypeCfg.belongingToTypes[0];
}
}
}
return "";
}
std::vector<std::string> UtdClient::GetTypeIdsFromCfg(const std::string &mimeType)
{
bool prefixMatch = false;
std::string prefixType;
if (!mimeType.empty() && mimeType.back() == '*') {
prefixType = mimeType.substr(0, mimeType.length() - 1);
prefixMatch = true;
}
std::vector<std::string> typeIdsInCfg;
std::shared_lock<std::shared_mutex> guard(utdMutex_);
for (const auto &utdTypeCfg : descriptorCfgs_) {
for (auto mime : utdTypeCfg.mimeTypes) {
std::transform(mime.begin(), mime.end(), mime.begin(), ::tolower);
if ((mime == mimeType) || (prefixMatch && mime.rfind(prefixType, 0) == 0)) {
typeIdsInCfg.push_back(utdTypeCfg.typeId);
break;
}
}
}
return typeIdsInCfg;
}
void UtdClient::SubscribeUtdChange()
{
}
Status UtdClient::GetUniformDataTypesByMIMEType(const std::string &mimeType, std::vector<std::string> &typeIds,
const std::string &belongsTo)
{
if (belongsTo != DEFAULT_TYPE_ID && !UtdGraph::GetInstance().IsValidType(belongsTo)) {
LOG_ERROR(UDMF_CLIENT, "invalid belongsTo.");
return Status::E_INVALID_PARAMETERS;
}
if (!IsValidMimeType(mimeType)) {
LOG_ERROR(UDMF_CLIENT, "invalid mimeType.");
return Status::E_INVALID_PARAMETERS;
}
std::string lowerMimeType = mimeType;
std::transform(lowerMimeType.begin(), lowerMimeType.end(), lowerMimeType.begin(), ::tolower);
std::vector<std::string> typeIdsInCfg = GetTypeIdsFromCfg(lowerMimeType);
typeIds.clear();
for (const auto &typeId : typeIdsInCfg) {
if (belongsTo != DEFAULT_TYPE_ID && belongsTo != typeId &&
!UtdGraph::GetInstance().IsLowerLevelType(belongsTo, typeId)) {
continue;
}
typeIds.emplace_back(typeId);
}
if (typeIds.empty()) {
typeIds.emplace_back(FlexibleType::GenFlexibleUtd(lowerMimeType, "", belongsTo));
}
return Status::E_OK;
}
Status UtdClient::RegisterTypeDescriptors(const std::vector<TypeDescriptorCfg> &descriptors)
{
return E_OK;
}
Status UtdClient::UnregisterTypeDescriptors(const std::vector<std::string> &typeIds)
{
return E_OK;
}
}
}