declarative_frontend/jsview/js_refresh.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 "frameworks/bridge/declarative_frontend/jsview/js_refresh.h"

#include <cstdint>

#include "interfaces/inner_api/ui_session/ui_session_manager.h"

#include "base/log/ace_scoring_log.h"
#include "bridge/declarative_frontend/engine/jsi/js_ui_index.h"
#include "bridge/declarative_frontend/jsview/js_refresh.h"
#include "bridge/declarative_frontend/jsview/js_view_common_def.h"
#include "bridge/declarative_frontend/jsview/models/refresh_model_impl.h"
#include "core/components_ng/base/view_stack_processor.h"
#include "core/components_ng/pattern/refresh/refresh_model.h"
#include "core/components_ng/pattern/refresh/refresh_model_ng.h"

namespace OHOS::Ace {
namespace {
constexpr int32_t DEFAULT_FRICTION = 62;
constexpr int32_t MAX_FRICTION = 100;
} // namespace
std::unique_ptr<RefreshModel> RefreshModel::instance_ = nullptr;
std::mutex RefreshModel::mutex_;

RefreshModel* RefreshModel::GetInstance()
{
    if (!instance_) {
        std::lock_guard<std::mutex> lock(mutex_);
        if (!instance_) {
#ifdef NG_BUILD
            instance_.reset(new NG::RefreshModelNG());
#else
            if (Container::IsCurrentUseNewPipeline()) {
                instance_.reset(new NG::RefreshModelNG());
            } else {
                instance_.reset(new Framework::RefreshModelImpl());
            }
#endif
        }
    }
    return instance_.get();
}

} // namespace OHOS::Ace

namespace OHOS::Ace::Framework {

void ParseRefreshingObject(const JSCallbackInfo& info, const JSRef<JSVal>& changeEventVal)
{
    CHECK_NULL_VOID(changeEventVal->IsFunction());

    auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(changeEventVal));
    WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
    auto changeEvent = [execCtx = info.GetExecutionContext(), func = std::move(jsFunc), node = targetNode](
                           const std::string& param) {
        JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
        if (param != "true" && param != "false") {
            return;
        }
        bool newValue = StringToBool(param);
        ACE_SCORING_EVENT("Refresh.ChangeEvent");
        PipelineContext::SetCallBackNode(node);
        auto newJSVal = JSRef<JSVal>::Make(ToJSValue(newValue));
        func->ExecuteJS(1, &newJSVal);
    };
    RefreshModel::GetInstance()->SetChangeEvent(std::move(changeEvent));
}

void JSRefresh::SetPullToRefresh(const JSCallbackInfo& info)
{
    bool pullToRefresh = true;
    if (info[0]->IsBoolean()) {
        pullToRefresh = info[0]->ToBoolean();
    }
    RefreshModel::GetInstance()->SetPullToRefresh(pullToRefresh);
}

void JSRefresh::JSBind(BindingTarget globalObj)
{
    JSClass<JSRefresh>::Declare("Refresh");
    MethodOptions opt = MethodOptions::NONE;
    JSClass<JSRefresh>::StaticMethod("create", &JSRefresh::Create, opt);
    JSClass<JSRefresh>::StaticMethod("refreshOffset", &JSRefresh::JsRefreshOffset);
    JSClass<JSRefresh>::StaticMethod("pullToRefresh", &JSRefresh::SetPullToRefresh, opt);
    JSClass<JSRefresh>::StaticMethod("onStateChange", &JSRefresh::OnStateChange);
    JSClass<JSRefresh>::StaticMethod("onRefreshing", &JSRefresh::OnRefreshing);
    JSClass<JSRefresh>::StaticMethod("onOffsetChange", &JSRefresh::OnOffsetChange);
    JSClass<JSRefresh>::StaticMethod("pullDownRatio", &JSRefresh::SetPullDownRatio);
    JSClass<JSRefresh>::StaticMethod("maxPullDownDistance", &JSRefresh::SetMaxPullDownDistance);
    JSClass<JSRefresh>::StaticMethod("onAttach", &JSInteractableView::JsOnAttach);
    JSClass<JSRefresh>::StaticMethod("onAppear", &JSInteractableView::JsOnAppear);
    JSClass<JSRefresh>::StaticMethod("onDetach", &JSInteractableView::JsOnDetach);
    JSClass<JSRefresh>::StaticMethod("onDisAppear", &JSInteractableView::JsOnDisAppear);
    JSClass<JSRefresh>::StaticMethod("onTouch", &JSInteractableView::JsOnTouch);
    JSClass<JSRefresh>::InheritAndBind<JSContainerBase>(globalObj);
}

void JSRefresh::SetPullDownRatio(const JSCallbackInfo& info)
{
    if (info.Length() < 1) {
        return;
    }

    auto args = info[0];
    std::optional<float> pulldownRatio = std::nullopt;
    if (!args->IsNumber() || std::isnan(args->ToNumber<float>())) {
        RefreshModel::GetInstance()->SetPullDownRatio(pulldownRatio);
        return;
    }
    pulldownRatio = std::clamp(args->ToNumber<float>(), 0.f, 1.f);
    RefreshModel::GetInstance()->SetPullDownRatio(pulldownRatio);
}

void JSRefresh::SetMaxPullDownDistance(const JSCallbackInfo& info)
{
    if (info.Length() < 1) {
        return;
    }

    auto args = info[0];
    if (!args->IsNumber()) {
        RefreshModel::GetInstance()->SetMaxPullDownDistance(std::nullopt);
        return;
    }
    float maxPullDownDistance = args->ToNumber<float>();
    if (std::isnan(maxPullDownDistance)) {
        RefreshModel::GetInstance()->SetMaxPullDownDistance(std::nullopt);
        return;
    }
    maxPullDownDistance = std::max(maxPullDownDistance, 0.0f);
    RefreshModel::GetInstance()->SetMaxPullDownDistance(maxPullDownDistance);
}

void JSRefresh::JsRefreshOffset(const JSCallbackInfo& info)
{
    if (info.Length() < 1) {
        return;
    }
    JsRefreshOffset(info[0]);
}

void JSRefresh::JsRefreshOffset(const JSRef<JSVal>& jsVal)
{
    CalcDimension value(0.0f);
    if (!ParseJsDimensionVpNG(jsVal, value)) {
        value.SetValue(0.0f);
    }
    RefreshModel::GetInstance()->SetRefreshOffset(value);
}

void JSRefresh::Create(const JSCallbackInfo& info)
{
    auto info0 = info[0];
    if (!info0->IsObject()) {
        return;
    }

    auto paramObject = JSRef<JSObject>::Cast(info0);
    auto refreshing = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::REFRESHING));
    auto jsOffset = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::OFFSET));
    auto friction = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::FRICTION));
    auto promptText = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::PROMPT_TEXT));
    JSRef<JSVal> changeEventVal;
    RefreshModel::GetInstance()->Create();

    if (refreshing->IsBoolean()) {
        RefreshModel::GetInstance()->SetRefreshing(refreshing->ToBoolean());
        changeEventVal = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::$REFRESHING));
        ParseRefreshingObject(info, changeEventVal);
    } else if (refreshing->IsObject()) {
        JSRef<JSObject> refreshingObj = JSRef<JSObject>::Cast(refreshing);
        changeEventVal = refreshingObj->GetProperty(static_cast<int32_t>(ArkUIIndex::CHANGE_EVENT));
        ParseRefreshingObject(info, changeEventVal);
        RefreshModel::GetInstance()->SetRefreshing(
            refreshingObj->GetProperty(static_cast<int32_t>(ArkUIIndex::VALUE))->ToBoolean());
    } else {
        RefreshModel::GetInstance()->SetRefreshing(false);
    }
    CalcDimension offset;
    if (ParseJsDimensionVp(jsOffset, offset)) {
        if (GreatOrEqual(offset.Value(), 0.0) && offset.Unit() != DimensionUnit::PERCENT) {
            RefreshModel::GetInstance()->SetIndicatorOffset(offset);
        }
    }
    ParsFrictionData(friction);
    if (!ParseRefreshingContent(paramObject)) {
        bool isCustomBuilderExist = ParseCustomBuilder(info);
        RefreshModel::GetInstance()->SetIsCustomBuilderExist(isCustomBuilderExist);
    }

    std::string loadingStr = "";
    if (SystemProperties::ConfigChangePerform()) {
        RefPtr<ResourceObject> resObj;
        if (ParseJsString(promptText, loadingStr, resObj)) {
            RefreshModel::GetInstance()->CreateWithResourceObj(resObj);
            RefreshModel::GetInstance()->SetLoadingText(loadingStr);
        } else {
            RefreshModel::GetInstance()->ResetLoadingText();
        }
    } else if (ParseJsString(promptText, loadingStr)) {
        RefreshModel::GetInstance()->SetLoadingText(loadingStr);
    } else {
        RefreshModel::GetInstance()->ResetLoadingText();
    }
}

bool JSRefresh::ParseRefreshingContent(const JSRef<JSObject>& paramObject)
{
    JSRef<JSVal> contentParam = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::REFRESHING_CONTENT));
    if (!contentParam->IsObject()) {
        return false;
    }
    JSRef<JSObject> contentObject = JSRef<JSObject>::Cast(contentParam);
    JSRef<JSVal> builderNodeParam = contentObject->GetProperty(static_cast<int32_t>(ArkUIIndex::BUILDER_NODE));
    if (!builderNodeParam->IsObject()) {
        return false;
    }
    JSRef<JSObject> builderNodeObject = JSRef<JSObject>::Cast(builderNodeParam);
    JSRef<JSVal> nodeptr = builderNodeObject->GetProperty(static_cast<int32_t>(ArkUIIndex::NODEPTR));
    if (nodeptr.IsEmpty()) {
        return false;
    }
    const auto* vm = nodeptr->GetEcmaVM();
    CHECK_NULL_RETURN(nodeptr->GetLocalHandle()->IsNativePointer(vm), false);
    auto* node = nodeptr->GetLocalHandle()->ToNativePointer(vm)->Value();
    auto* frameNode = reinterpret_cast<NG::FrameNode*>(node);
    CHECK_NULL_RETURN(frameNode, false);
    RefPtr<NG::FrameNode> refPtrFrameNode = AceType::Claim(frameNode);
    RefreshModel::GetInstance()->SetCustomBuilder(refPtrFrameNode);
    RefreshModel::GetInstance()->SetIsCustomBuilderExist(false);
    return true;
}

bool JSRefresh::ParseCustomBuilder(const JSCallbackInfo& info)
{
    if (!info[0]->IsObject()) {
        return false;
    }
    auto paramObject = JSRef<JSObject>::Cast(info[0]);
    auto builder = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::BUILDER));
    RefPtr<NG::UINode> customNode;
    if (builder->IsFunction()) {
        {
            NG::ScopedViewStackProcessor builderViewStackProcessor;
            JsFunction Jsfunc(info.This(), JSRef<JSFunc>::Cast(builder));
            Jsfunc.Execute();
            customNode = NG::ViewStackProcessor::GetInstance()->Finish();
        }
        RefreshModel::GetInstance()->SetCustomBuilder(customNode);
        return true;
    } else {
        RefreshModel::GetInstance()->SetCustomBuilder(customNode);
        return false;
    }
}

void JSRefresh::OnStateChange(const JSCallbackInfo& args)
{
    if (!args[0]->IsFunction()) {
        return;
    }
    auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(args[0]));
    WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
    auto onStateChange = [execCtx = args.GetExecutionContext(), func = std::move(jsFunc), node = targetNode](
                             const int32_t& value) {
        JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
        ACE_SCORING_EVENT("Refresh.OnStateChange");
        PipelineContext::SetCallBackNode(node);
        auto newJSVal = JSRef<JSVal>::Make(ToJSValue(value));
        func->ExecuteJS(1, &newJSVal);
        UiSessionManager::GetInstance()->ReportComponentChangeEvent("event", "Refresh.OnStateChange");
    };
    RefreshModel::GetInstance()->SetOnStateChange(std::move(onStateChange));
}

void JSRefresh::OnRefreshing(const JSCallbackInfo& args)
{
    if (!args[0]->IsFunction()) {
        return;
    }
    auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(args[0]));
    WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
    auto onRefreshing = [execCtx = args.GetExecutionContext(), func = std::move(jsFunc), node = targetNode]() {
        JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
        ACE_SCORING_EVENT("Refresh.OnRefreshing");
        PipelineContext::SetCallBackNode(node);
        auto newJSVal = JSRef<JSVal>::Make();
        func->ExecuteJS(1, &newJSVal);
    };
    RefreshModel::GetInstance()->SetOnRefreshing(std::move(onRefreshing));
}

void JSRefresh::OnOffsetChange(const JSCallbackInfo& args)
{
    if (!args[0]->IsFunction()) {
        RefreshModel::GetInstance()->ResetOnOffsetChange();
        return;
    }
    auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(args[0]));
    WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
    auto offsetChange = [execCtx = args.GetExecutionContext(), func = std::move(jsFunc), node = targetNode](
                            const float& value) {
        JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
        ACE_SCORING_EVENT("Refresh.OnOffsetChange");
        PipelineContext::SetCallBackNode(node);
        auto newJSVal = JSRef<JSVal>::Make(ToJSValue(value));
        func->ExecuteJS(1, &newJSVal);
    };
    RefreshModel::GetInstance()->SetOnOffsetChange(std::move(offsetChange));
}

void JSRefresh::ParsFrictionData(const JsiRef<JsiValue>& friction)
{
    int32_t frictionNumber = DEFAULT_FRICTION;
    if (friction->IsString()) {
        frictionNumber = StringUtils::StringToInt(friction->ToString());
        if ((frictionNumber == 0 && friction->ToString() != "0") || frictionNumber < 0 ||
            frictionNumber > MAX_FRICTION) {
            frictionNumber = DEFAULT_FRICTION;
        }
    } else if (friction->IsNumber()) {
        frictionNumber = friction->ToNumber<int32_t>();
        if (frictionNumber < 0 || frictionNumber > MAX_FRICTION) {
            frictionNumber = DEFAULT_FRICTION;
        }
    }
    RefreshModel::GetInstance()->SetFriction(frictionNumber);
}
} // namespace OHOS::Ace::Framework