key_command/src/setting_datashare.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.
 */

#include "setting_datashare.h"

#include <thread>

#include "datashare_predicates.h"
#include "datashare_result_set.h"
#include "datashare_values_bucket.h"
#include "ipc_skeleton.h"
#include "iservice_registry.h"
#include "mmi_log.h"
#include "rdb_errno.h"
#include "result_set.h"
#include "system_ability_definition.h"
#include "uri.h"

#undef MMI_LOG_DOMAIN
#define MMI_LOG_DOMAIN MMI_LOG_HANDLER
#undef MMI_LOG_TAG
#define MMI_LOG_TAG "setting_DataShare"

namespace OHOS {
namespace MMI {
std::shared_ptr<SettingDataShare> SettingDataShare::instance_ = nullptr;
std::mutex SettingDataShare::mutex_;
sptr<IRemoteObject> SettingDataShare::remoteObj_;
namespace {
const std::string SETTING_COLUMN_KEYWORD { "KEYWORD" };
const std::string SETTING_COLUMN_VALUE { "VALUE" };
const std::string SETTING_URI_PROXY { "datashare:///com.ohos.settingsdata/entry/settingsdata/SETTINGSDATA?Proxy=true" };
const std::string SETTING_URI_USER_PROXY {
    "datashare:///com.ohos.settingsdata/entry/settingsdata/USER_SETTINGSDATA_SECURE_100?Proxy=true" };
const std::string SETTINGS_DATA_EXT_URI { "datashare:///com.ohos.settingsdata.DataAbility" };
constexpr int32_t DECIMAL_BASE { 10 };
constexpr const int32_t E_OK{ 0 };
constexpr const int32_t E_DATA_SHARE_NOT_READY { 1055 };
} // namespace

SettingDataShare::~SettingDataShare() {}

SettingDataShare& SettingDataShare::GetInstance(int32_t systemAbilityId)
{
    if (instance_ == nullptr) {
        std::lock_guard<std::mutex> lock(mutex_);
        if (instance_ == nullptr) {
            instance_ = std::make_shared<SettingDataShare>();
        }
    }
    return *instance_;
}

ErrCode SettingDataShare::GetIntValue(const std::string& key, int32_t& value, const std::string &strUri)
{
    int64_t valueLong;
    ErrCode ret = GetLongValue(key, valueLong, strUri);
    if (ret != ERR_OK) {
        MMI_HILOGE("Get int value fail");
        return ret;
    }
    value = static_cast<int32_t>(valueLong);
    return ERR_OK;
}

ErrCode SettingDataShare::GetLongValue(const std::string& key, int64_t& value, const std::string &strUri)
{
    std::string valueStr;
    ErrCode ret = GetStringValue(key, valueStr, strUri);
    if (ret != ERR_OK) {
        MMI_HILOGE("Get long value fail");
        return ret;
    }
    value = static_cast<int64_t>(strtoll(valueStr.c_str(), nullptr, DECIMAL_BASE));
    return ERR_OK;
}

ErrCode SettingDataShare::GetBoolValue(const std::string& key, bool& value, const std::string &strUri)
{
    std::string valueStr;
    ErrCode ret = GetStringValue(key, valueStr, strUri);
    if (ret != ERR_OK) {
        MMI_HILOGE("Get bool value fail");
        return ret;
    }
    value = ((valueStr == "true") || (valueStr == "1"));
    return ERR_OK;
}

ErrCode SettingDataShare::PutIntValue(
    const std::string& key, int32_t value, bool needNotify, const std::string &strUri)
{
    return PutStringValue(key, std::to_string(value), needNotify, strUri);
}

ErrCode SettingDataShare::PutLongValue(
    const std::string& key, int64_t value, bool needNotify, const std::string &strUri)
{
    return PutStringValue(key, std::to_string(value), needNotify, strUri);
}

ErrCode SettingDataShare::PutBoolValue(
    const std::string& key, bool value, bool needNotify, const std::string &strUri)
{
    std::string valueStr = value ? "true" : "false";
    return PutStringValue(key, valueStr, needNotify, strUri);
}

bool SettingDataShare::IsValidKey(const std::string& key, const std::string &strUri)
{
    std::string value;
    ErrCode ret = GetStringValue(key, value, strUri);
    return (ret != ERR_NAME_NOT_FOUND) && (!value.empty());
}

sptr<SettingObserver> SettingDataShare::CreateObserver(const std::string& key, SettingObserver::UpdateFunc& func)
{
    sptr<SettingObserver> observer = new (std::nothrow) SettingObserver();
    CHKPP(observer);
    observer->SetKey(key);
    observer->SetUpdateFunc(func);
    return observer;
}

void SettingDataShare::ExecRegisterCb(const sptr<SettingObserver>& observer)
{
    CHKPV(observer);
    observer->OnChange();
}

ErrCode SettingDataShare::RegisterObserver(const sptr<SettingObserver>& observer, const std::string &strUri)
{
    CHKPR(observer, RET_ERR);
    std::string callingIdentity = IPCSkeleton::ResetCallingIdentity();
    auto uri = AssembleUri(observer->GetKey(), strUri);
    auto helper = CreateDataShareHelper(strUri);
    if (helper == nullptr) {
        IPCSkeleton::SetCallingIdentity(callingIdentity);
        return ERR_NO_INIT;
    }
    helper->RegisterObserver(uri, observer);
    helper->NotifyChange(uri);
    std::thread execCb([this, observer] { this->ExecRegisterCb(observer); });
    execCb.detach();
    ReleaseDataShareHelper(helper);
    IPCSkeleton::SetCallingIdentity(callingIdentity);
    return ERR_OK;
}

ErrCode SettingDataShare::UnregisterObserver(const sptr<SettingObserver>& observer, const std::string &strUri)
{
    CHKPR(observer, RET_ERR);
    std::string callingIdentity = IPCSkeleton::ResetCallingIdentity();
    auto uri = AssembleUri(observer->GetKey(), strUri);
    auto helper = CreateDataShareHelper(strUri);
    if (helper == nullptr) {
        IPCSkeleton::SetCallingIdentity(callingIdentity);
        return ERR_NO_INIT;
    }
    helper->UnregisterObserver(uri, observer);
    ReleaseDataShareHelper(helper);
    IPCSkeleton::SetCallingIdentity(callingIdentity);
    return ERR_OK;
}

ErrCode SettingDataShare::GetStringValue(const std::string& key, std::string& value, const std::string &strUri)
{
    std::string callingIdentity = IPCSkeleton::ResetCallingIdentity();
    auto helper = CreateDataShareHelper(strUri);
    if (helper == nullptr) {
        IPCSkeleton::SetCallingIdentity(callingIdentity);
        return ERR_NO_INIT;
    }
    std::vector<std::string> columns = {SETTING_COLUMN_VALUE};
    DataShare::DataSharePredicates predicates;
    predicates.EqualTo(SETTING_COLUMN_KEYWORD, key);
    Uri uri(AssembleUri(key, strUri));
    auto resultSet = helper->Query(uri, predicates, columns);
    ReleaseDataShareHelper(helper);
    if (resultSet == nullptr) {
        IPCSkeleton::SetCallingIdentity(callingIdentity);
        return ERR_INVALID_OPERATION;
    }
    int32_t count = 0;
    resultSet->GetRowCount(count);
    if (count == 0) {
        IPCSkeleton::SetCallingIdentity(callingIdentity);
        return ERR_NAME_NOT_FOUND;
    }
    const int32_t tmpRow = 0;
    resultSet->GoToRow(tmpRow);
    int32_t ret = resultSet->GetString(tmpRow, value);
    if (ret != RET_OK) {
        IPCSkeleton::SetCallingIdentity(callingIdentity);
        return ERR_INVALID_VALUE;
    }
    resultSet->Close();
    IPCSkeleton::SetCallingIdentity(callingIdentity);
    return ERR_OK;
}

ErrCode SettingDataShare::PutStringValue(
    const std::string& key, const std::string& value, bool needNotify, const std::string &strUri)
{
    std::string callingIdentity = IPCSkeleton::ResetCallingIdentity();
    auto helper = CreateDataShareHelper(strUri);
    if (helper == nullptr) {
        IPCSkeleton::SetCallingIdentity(callingIdentity);
        return ERR_NO_INIT;
    }
    DataShare::DataShareValueObject keyObj(key);
    DataShare::DataShareValueObject valueObj(value);
    DataShare::DataShareValuesBucket bucket;
    bucket.Put(SETTING_COLUMN_KEYWORD, keyObj);
    bucket.Put(SETTING_COLUMN_VALUE, valueObj);
    DataShare::DataSharePredicates predicates;
    predicates.EqualTo(SETTING_COLUMN_KEYWORD, key);
    Uri uri(AssembleUri(key, strUri));
    if (helper->Update(uri, predicates, bucket) <= 0) {
        helper->Insert(uri, bucket);
    }
    if (needNotify) {
        helper->NotifyChange(AssembleUri(key, strUri));
    }
    ReleaseDataShareHelper(helper);
    IPCSkeleton::SetCallingIdentity(callingIdentity);
    return ERR_OK;
}

std::shared_ptr<DataShare::DataShareHelper> SettingDataShare::CreateDataShareHelper(const std::string &strUri)
{
    auto sam = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();
    CHKPP(sam);
    auto remoteObj = sam->CheckSystemAbility(DISTRIBUTED_KV_DATA_SERVICE_ABILITY_ID);
    if (remoteObj == nullptr) {
        MMI_HILOGI("Data share not start");
        return nullptr;
    }
    if (remoteObj_ == nullptr) {
        std::lock_guard<std::mutex> lock(mutex_);
        remoteObj_ = sam->CheckSystemAbility(MULTIMODAL_INPUT_SERVICE_ID);
    }
    std::pair<int, std::shared_ptr<DataShare::DataShareHelper>> ret;
    if (strUri.empty()) {
        ret = DataShare::DataShareHelper::Create(remoteObj_, SETTING_URI_PROXY, SETTINGS_DATA_EXT_URI.c_str());
    } else {
        ret = DataShare::DataShareHelper::Create(remoteObj_, strUri, "");
    }
    return ret.second;
}

bool SettingDataShare::ReleaseDataShareHelper(std::shared_ptr<DataShare::DataShareHelper>& helper)
{
    if (!helper->Release()) {
        return false;
    }
    return true;
}

Uri SettingDataShare::AssembleUri(const std::string& key, const std::string &strUri)
{
    if (strUri.empty()) {
        if (key == "close_fingerprint_nav_event_key" || key == "close_fingerprint_event_key") {
            return Uri(SETTING_URI_USER_PROXY + "&key=" + key);
        }
        return Uri(SETTING_URI_PROXY + "&key=" + key);
    } else {
        return Uri(strUri + "&key=" + key);
    }
}

bool SettingDataShare::CheckIfSettingsDataReady()
{
    if (isDataShareReady_) {
        return true;
    }
    if (remoteObj_ == nullptr) {
        std::lock_guard<std::mutex> lock(mutex_);
        if (remoteObj_ == nullptr) {
            auto sam = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();
            CHKPF(sam);
            remoteObj_ = sam->CheckSystemAbility(MULTIMODAL_INPUT_SERVICE_ID);
        }
    }
    CHKPF(remoteObj_);
    std::pair<int, std::shared_ptr<DataShare::DataShareHelper>> ret =
            DataShare::DataShareHelper::Create(remoteObj_, SETTING_URI_PROXY, SETTINGS_DATA_EXT_URI);
    MMI_HILOGD("create data_share helper, ret=%{public}d", ret.first);
    if (ret.first == E_OK) {
        MMI_HILOGD("create data_share helper success");
        auto helper = ret.second;
        if (helper != nullptr) {
            bool releaseRet = helper->Release();
            MMI_HILOGD("release data_share helper, releaseRet=%{public}d", releaseRet);
        }
        isDataShareReady_ = true;
        return true;
    } else if (ret.first == E_DATA_SHARE_NOT_READY) {
        MMI_HILOGE("create data_share helper failed");
        isDataShareReady_ = false;
        return false;
    }
    MMI_HILOGE("data_share unknown");
    return true;
}
}
} // namespace OHOS