services/src/form_supply_callback.cpp

/*
 * Copyright (c) 2021-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 "form_supply_callback.h"

#include <cinttypes>

#include "fms_log_wrapper.h"
#include "form_ams_helper.h"
#include "form_constants.h"
#include "form_data_proxy_mgr.h"
#include "form_mgr_errors.h"
#include "form_provider_mgr.h"
#include "form_render_mgr.h"
#include "form_share_mgr.h"
#include "form_task_mgr.h"
#include "form_util.h"
#include "hitrace_meter.h"
#include "form_info_rdb_storage_mgr.h"
#include "form_data_mgr.h"
#include "form_host_interface.h"

namespace OHOS {
namespace AppExecFwk {
sptr<FormSupplyCallback> FormSupplyCallback::instance_ = nullptr;
std::mutex FormSupplyCallback::mutex_;

sptr<FormSupplyCallback> FormSupplyCallback::GetInstance()
{
    if (instance_ == nullptr) {
        std::lock_guard<std::mutex> lock(mutex_);
        if (instance_ == nullptr) {
            instance_ = new (std::nothrow) FormSupplyCallback();
            if (instance_ == nullptr) {
                HILOG_ERROR("%{public}s error, failed to create FormSupplyCallback.", __func__);
            }
        }
    }
    return instance_;
}

/**
 * @brief Accept form binding data from form provider.
 * @param providerFormInfo Form binding data.
 * @param want input data.
 * @return Returns ERR_OK on success, others on failure.
 */
int FormSupplyCallback::OnAcquire(const FormProviderInfo &formProviderInfo, const Want &want)
{
    HITRACE_METER_NAME(HITRACE_TAG_ABILITY_MANAGER, __PRETTY_FUNCTION__);
    HILOG_INFO("%{public}s called.", __func__);
    auto connectId = want.GetIntParam(Constants::FORM_CONNECT_ID, 0);
    int errCode = want.GetIntParam(Constants::PROVIDER_FLAG, ERR_OK);
    if (errCode != ERR_OK) {
        RemoveConnection(connectId);
        HILOG_ERROR("%{public}s error, errCode: %{public}d", __func__, errCode);
        return errCode;
    }

    std::string strFormId = want.GetStringParam(Constants::PARAM_FORM_IDENTITY_KEY);
    if (strFormId.empty()) {
        HILOG_ERROR("%{public}s error, formId is empty.", __func__);
        return ERR_APPEXECFWK_FORM_INVALID_PARAM;
    }
    int64_t formId = std::stoll(strFormId);
    if (IsRemoveConnection(formId, want.GetRemoteObject(Constants::PARAM_FORM_HOST_TOKEN))) {
        RemoveConnection(connectId);
    }

    if (FormRenderMgr::GetInstance().IsNeedRender(formId)) {
        errCode = FormRenderMgr::GetInstance().UpdateRenderingForm(formId, formProviderInfo.GetFormData(),
            want.GetParams(), false);
        FormDataProxyMgr::GetInstance().SubscribeFormData(formId, formProviderInfo.GetFormProxies());
        return errCode;
    }

    int32_t ret = ERR_APPEXECFWK_FORM_INVALID_PARAM;
    int type = want.GetIntParam(Constants::ACQUIRE_TYPE, 0);
    HILOG_DEBUG("%{public}s come: %{public}" PRId64 ", %{public}d, %{public}d",
        __func__, formId, connectId, type);
    switch (type) {
        case Constants::ACQUIRE_TYPE_CREATE_FORM:
            ret = FormProviderMgr::GetInstance().AcquireForm(formId, formProviderInfo);
            break;
        case Constants::ACQUIRE_TYPE_RECREATE_FORM:
            ret = FormProviderMgr::GetInstance().UpdateForm(formId, formProviderInfo);
            break;
        default:
            HILOG_WARN("%{public}s warning, onAcquired type: %{public}d", __func__, type);
    }

    FormDataProxyMgr::GetInstance().SubscribeFormData(formId, formProviderInfo.GetFormProxies());
    HILOG_INFO("%{public}s end.", __func__);
    return ret;
}

/**
 * @brief Accept other event.
 * @param want input data.
 * @return Returns ERR_OK on success, others on failure.
 */
int FormSupplyCallback::OnEventHandle(const Want &want)
{
    HITRACE_METER_NAME(HITRACE_TAG_ABILITY_MANAGER, __PRETTY_FUNCTION__);
    HILOG_INFO("%{public}s called.", __func__);
    auto connectId = want.GetIntParam(Constants::FORM_CONNECT_ID, 0);
    std::string supplyInfo = want.GetStringParam(Constants::FORM_SUPPLY_INFO);
    HILOG_DEBUG("%{public}s come: %{public}d, %{public}s", __func__, connectId, supplyInfo.c_str());
    RemoveConnection(connectId);
    HILOG_INFO("%{public}s end.", __func__);
    return ERR_OK;
}

/**
 * @brief Accept form state from form provider.
 * @param state Form state.
 * @param provider provider info.
 * @param wantArg The want of onAcquireFormState.
 * @param want input data.
 * @return Returns ERR_OK on success, others on failure.
 */
int FormSupplyCallback::OnAcquireStateResult(FormState state,
    const std::string &provider, const Want &wantArg, const Want &want)
{
    HILOG_INFO("%{public}s called.", __func__);
    auto connectId = want.GetIntParam(Constants::FORM_CONNECT_ID, 0);
    RemoveConnection(connectId);

    ErrCode errCode = FormProviderMgr::GetInstance().AcquireFormStateBack(state, provider, wantArg);
    HILOG_INFO("%{public}s end, errCode:%{public}d.", __func__, errCode);
    return errCode;
}

int FormSupplyCallback::OnAcquireDataResult(const AAFwk::WantParams &wantParams, int64_t requestCode)
{
    HILOG_DEBUG("called.");
    ErrCode errCode = FormProviderMgr::GetInstance().AcquireFormDataBack(wantParams, requestCode);
    HILOG_INFO("end, errCode:%{public}d.", errCode);
    return errCode;
}

/**
 * @brief Save ability Connection for the callback.
 * @param connection ability connection.
 */
void FormSupplyCallback::AddConnection(sptr<FormAbilityConnection> connection)
{
    HILOG_DEBUG("%{public}s called.", __func__);
    if (connection == nullptr) {
        return;
    }
    int32_t connectKey = static_cast<int32_t>(FormUtil::GetCurrentMillisecond());
    std::lock_guard<std::mutex> lock(conMutex_);
    while (connections_.find(connectKey) != connections_.end()) {
        connectKey++;
    }
    connection->SetConnectId(connectKey);
    connections_.emplace(connectKey, connection);
    HILOG_DEBUG("%{public}s end.", __func__);
}

/**
 * @brief Delete ability connection after the callback come.
 * @param connectId The ability connection id generated when save.
 */
void FormSupplyCallback::RemoveConnection(int32_t connectId)
{
    HILOG_DEBUG("%{public}s called.", __func__);
    sptr<FormAbilityConnection> connection = nullptr;
    {
        std::lock_guard<std::mutex> lock(conMutex_);
        auto conIterator = connections_.find(connectId);
        if (conIterator != connections_.end()) {
            connection = conIterator->second;
            connections_.erase(connectId);
        }
    }

    if (connection != nullptr) {
        if (CanDisconnect(connection)) {
            FormAmsHelper::GetInstance().DisconnectServiceAbility(connection);
            HILOG_INFO("%{public}s end, disconnect service ability", __func__);
        } else {
            FormAmsHelper::GetInstance().DisconnectServiceAbilityDelay(connection);
            HILOG_INFO("%{public}s end, disconnect service ability delay", __func__);
        }
    }
    HILOG_DEBUG("%{public}s end.", __func__);
}
/**
 * @brief check if disconnect ability or not.
 * @param connection The ability connection.
 */
bool FormSupplyCallback::CanDisconnect(sptr<FormAbilityConnection> &connection)
{
    if (connection == nullptr) {
        HILOG_ERROR("connection is nullptr");
        return false;
    }
    HILOG_INFO("%{public}s called.", __func__);
    int count = 0;
    std::lock_guard<std::mutex> lock(conMutex_);
    for (auto &conn : connections_) {
        if (connection->GetProviderKey() == conn.second->GetProviderKey()) {
            HILOG_INFO("%{public}s, key: %{public}s", __func__, conn.second->GetProviderKey().c_str());
            count++;
            if (count > 1) {
                HILOG_INFO("%{public}s end, true.", __func__);
                return true;
            }
        }
    }
    HILOG_INFO("%{public}s end, false count:%{public}d.", __func__, count);
    return false;
}

void FormSupplyCallback::OnShareAcquire(int64_t formId, const std::string &remoteDeviceId,
    const AAFwk::WantParams &wantParams, int64_t requestCode, const bool &result)
{
    HILOG_DEBUG("%{public}s formId %{public}" PRId64 " called.", __func__, formId);
    DelayedSingleton<FormShareMgr>::GetInstance()->HandleProviderShareData(
        formId, remoteDeviceId, wantParams, requestCode, result);
}

bool FormSupplyCallback::IsRemoveConnection(int64_t formId, const sptr<IRemoteObject> &hostToken)
{
    HILOG_DEBUG("%{public}s called. formId is %{public}" PRId64, __func__, formId);
    if (hostToken == nullptr) {
        return true;
    }

    std::lock_guard<std::mutex> lock(conMutex_);
    // keep one connection for each in application form in the same host
    int32_t count = 0;
    for (const auto &conn : connections_) {
        if (hostToken == conn.second->GetHostToken() && formId == conn.second->GetFormId()) {
            count++;
            if (count > 1) {
                break;
            }
        }
    }
    HILOG_DEBUG("%{public}s called. count is %{public}d", __func__, count);
    if (count == 1) {
        HILOG_DEBUG("keep the connection");
        return false;
    }
    return true;
}

void FormSupplyCallback::RemoveConnection(int64_t formId, const sptr<IRemoteObject> &hostToken)
{
    HILOG_DEBUG("%{public}s called. formId is %{public}" PRId64, __func__, formId);
    if (hostToken == nullptr) {
        return;
    }

    std::lock_guard<std::mutex> lock(conMutex_);
    for (const auto &conn : connections_) {
        if (hostToken == conn.second->GetHostToken() && formId == conn.second->GetFormId()) {
            Want want;
            want.SetParam(Constants::FORM_CONNECT_ID, conn.first);
            want.SetParam(Constants::PARAM_FORM_HOST_TOKEN, hostToken);
            FormTaskMgr::GetInstance().PostDeleteTask(formId, want, conn.second->GetProviderToken());
            HILOG_DEBUG("remove the connection, connect id is %{public}d", conn.first);
        }
    }
}

void FormSupplyCallback::HandleHostDied(const sptr<IRemoteObject> &hostToken)
{
    HILOG_DEBUG("%{public}s called.", __func__);
    if (hostToken == nullptr) {
        HILOG_ERROR("host token is nullptr.");
        return;
    }

    std::vector<int32_t> connectIds;
    {
        std::lock_guard<std::mutex> lock(conMutex_);
        for (const auto &conn : connections_) {
            if (hostToken == conn.second->GetHostToken()) {
                connectIds.push_back(conn.first);
                HILOG_DEBUG("remove the connection, connect id is %{public}d", conn.first);
            }
        }
    }

    for (const auto &connectId : connectIds) {
        RemoveConnection(connectId);
    }
}

int32_t FormSupplyCallback::OnRenderTaskDone(int64_t formId, const Want &want)
{
    HILOG_DEBUG("%{public}s called.", __func__);
    FormRenderMgr::GetInstance().RenderFormCallback(formId, want);
    return ERR_OK;
}

int32_t FormSupplyCallback::OnStopRenderingTaskDone(int64_t formId, const Want &want)
{
    HILOG_INFO("%{public}s called.", __func__);
    FormRenderMgr::GetInstance().StopRenderingFormCallback(formId, want);
    return ERR_OK;
}

int32_t FormSupplyCallback::OnRenderingBlock(const std::string &bundleName)
{
    HILOG_INFO("OnRenderingBlock called, bundleName: %{public}s.", bundleName.c_str());
    FormRenderMgr::GetInstance().OnRenderingBlock(bundleName);
    return ERR_OK;
}

int32_t FormSupplyCallback::OnRecycleForm(const int64_t &formId, const Want &want)
{
    HILOG_INFO("formId: %{public}" PRId64, formId);
    std::string statusData = want.GetStringParam(Constants::FORM_STATUS_DATA);
    if (statusData.empty()) {
        HILOG_WARN("status data of %{public}" PRId64 " is empty", formId);
        return ERR_OK;
    }
    if (FormInfoRdbStorageMgr::GetInstance().UpdateStatusData(std::to_string(formId), statusData) != ERR_OK) {
        HILOG_ERROR("update status data of %{public}" PRId64 " failed", formId);
        return ERR_APPEXECFWK_FORM_COMMON_CODE;
    }

    FormRecord formRecord;
    if (!FormDataMgr::GetInstance().GetFormRecord(formId, formRecord)) {
        HILOG_WARN("form %{public}" PRId64 " not exist", formId);
        return ERR_APPEXECFWK_FORM_COMMON_CODE;
    }
    if (formRecord.recycleStatus != RecycleStatus::RECYCLABLE) {
        HILOG_WARN("form %{public}" PRId64 " is not RECYCLABLE", formId);
        return ERR_APPEXECFWK_FORM_COMMON_CODE;
    }
    formRecord.recycleStatus = RecycleStatus::RECYCLED;
    FormDataMgr::GetInstance().UpdateFormRecord(formId, formRecord);

    sptr<IRemoteObject> remoteObjectOfHost = want.GetRemoteObject(Constants::PARAM_FORM_HOST_TOKEN);
    if (remoteObjectOfHost == nullptr) {
        HILOG_ERROR("remoteObjectOfHost is null.");
        return ERR_APPEXECFWK_FORM_COMMON_CODE;
    }
    sptr<IFormHost> remoteFormHost = iface_cast<IFormHost>(remoteObjectOfHost);
    if (remoteFormHost == nullptr) {
        HILOG_ERROR("remoteFormHost is null.");
        return ERR_APPEXECFWK_FORM_COMMON_CODE;
    }
    remoteFormHost->OnRecycleForm(formId);
    return ERR_OK;
}
} // namespace AppExecFwk
} // namespace OHOS