1 /*
2 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "frameworks/bridge/declarative_frontend/jsview/js_refresh.h"
17
18 #include <cstdint>
19
20 #include "interfaces/inner_api/ui_session/ui_session_manager.h"
21
22 #include "base/log/ace_scoring_log.h"
23 #include "bridge/declarative_frontend/engine/jsi/js_ui_index.h"
24 #include "bridge/declarative_frontend/jsview/js_refresh.h"
25 #include "bridge/declarative_frontend/jsview/js_view_common_def.h"
26 #include "bridge/declarative_frontend/jsview/models/refresh_model_impl.h"
27 #include "core/components_ng/base/view_stack_processor.h"
28 #include "core/components_ng/pattern/refresh/refresh_model.h"
29 #include "core/components_ng/pattern/refresh/refresh_model_ng.h"
30
31 namespace OHOS::Ace {
32 namespace {
33 constexpr int32_t DEFAULT_FRICTION = 62;
34 constexpr int32_t MAX_FRICTION = 100;
35 } // namespace
36 std::unique_ptr<RefreshModel> RefreshModel::instance_ = nullptr;
37 std::mutex RefreshModel::mutex_;
38
GetInstance()39 RefreshModel* RefreshModel::GetInstance()
40 {
41 if (!instance_) {
42 std::lock_guard<std::mutex> lock(mutex_);
43 if (!instance_) {
44 #ifdef NG_BUILD
45 instance_.reset(new NG::RefreshModelNG());
46 #else
47 if (Container::IsCurrentUseNewPipeline()) {
48 instance_.reset(new NG::RefreshModelNG());
49 } else {
50 instance_.reset(new Framework::RefreshModelImpl());
51 }
52 #endif
53 }
54 }
55 return instance_.get();
56 }
57
58 } // namespace OHOS::Ace
59
60 namespace OHOS::Ace::Framework {
61
ParseRefreshingObject(const JSCallbackInfo & info,const JSRef<JSVal> & changeEventVal)62 void ParseRefreshingObject(const JSCallbackInfo& info, const JSRef<JSVal>& changeEventVal)
63 {
64 CHECK_NULL_VOID(changeEventVal->IsFunction());
65
66 auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(changeEventVal));
67 WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
68 auto changeEvent = [execCtx = info.GetExecutionContext(), func = std::move(jsFunc), node = targetNode](
69 const std::string& param) {
70 JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
71 if (param != "true" && param != "false") {
72 return;
73 }
74 bool newValue = StringToBool(param);
75 ACE_SCORING_EVENT("Refresh.ChangeEvent");
76 PipelineContext::SetCallBackNode(node);
77 auto newJSVal = JSRef<JSVal>::Make(ToJSValue(newValue));
78 func->ExecuteJS(1, &newJSVal);
79 };
80 RefreshModel::GetInstance()->SetChangeEvent(std::move(changeEvent));
81 }
82
SetPullToRefresh(const JSCallbackInfo & info)83 void JSRefresh::SetPullToRefresh(const JSCallbackInfo& info)
84 {
85 bool pullToRefresh = true;
86 if (info[0]->IsBoolean()) {
87 pullToRefresh = info[0]->ToBoolean();
88 }
89 RefreshModel::GetInstance()->SetPullToRefresh(pullToRefresh);
90 }
91
JSBind(BindingTarget globalObj)92 void JSRefresh::JSBind(BindingTarget globalObj)
93 {
94 JSClass<JSRefresh>::Declare("Refresh");
95 MethodOptions opt = MethodOptions::NONE;
96 JSClass<JSRefresh>::StaticMethod("create", &JSRefresh::Create, opt);
97 JSClass<JSRefresh>::StaticMethod("refreshOffset", &JSRefresh::JsRefreshOffset);
98 JSClass<JSRefresh>::StaticMethod("pullToRefresh", &JSRefresh::SetPullToRefresh, opt);
99 JSClass<JSRefresh>::StaticMethod("onStateChange", &JSRefresh::OnStateChange);
100 JSClass<JSRefresh>::StaticMethod("onRefreshing", &JSRefresh::OnRefreshing);
101 JSClass<JSRefresh>::StaticMethod("onOffsetChange", &JSRefresh::OnOffsetChange);
102 JSClass<JSRefresh>::StaticMethod("pullDownRatio", &JSRefresh::SetPullDownRatio);
103 JSClass<JSRefresh>::StaticMethod("maxPullDownDistance", &JSRefresh::SetMaxPullDownDistance);
104 JSClass<JSRefresh>::StaticMethod("onAttach", &JSInteractableView::JsOnAttach);
105 JSClass<JSRefresh>::StaticMethod("onAppear", &JSInteractableView::JsOnAppear);
106 JSClass<JSRefresh>::StaticMethod("onDetach", &JSInteractableView::JsOnDetach);
107 JSClass<JSRefresh>::StaticMethod("onDisAppear", &JSInteractableView::JsOnDisAppear);
108 JSClass<JSRefresh>::StaticMethod("onTouch", &JSInteractableView::JsOnTouch);
109 JSClass<JSRefresh>::InheritAndBind<JSContainerBase>(globalObj);
110 }
111
SetPullDownRatio(const JSCallbackInfo & info)112 void JSRefresh::SetPullDownRatio(const JSCallbackInfo& info)
113 {
114 if (info.Length() < 1) {
115 return;
116 }
117
118 auto args = info[0];
119 std::optional<float> pulldownRatio = std::nullopt;
120 if (!args->IsNumber() || std::isnan(args->ToNumber<float>())) {
121 RefreshModel::GetInstance()->SetPullDownRatio(pulldownRatio);
122 return;
123 }
124 pulldownRatio = std::clamp(args->ToNumber<float>(), 0.f, 1.f);
125 RefreshModel::GetInstance()->SetPullDownRatio(pulldownRatio);
126 }
127
SetMaxPullDownDistance(const JSCallbackInfo & info)128 void JSRefresh::SetMaxPullDownDistance(const JSCallbackInfo& info)
129 {
130 if (info.Length() < 1) {
131 return;
132 }
133
134 auto args = info[0];
135 if (!args->IsNumber()) {
136 RefreshModel::GetInstance()->SetMaxPullDownDistance(std::nullopt);
137 return;
138 }
139 float maxPullDownDistance = args->ToNumber<float>();
140 if (std::isnan(maxPullDownDistance)) {
141 RefreshModel::GetInstance()->SetMaxPullDownDistance(std::nullopt);
142 return;
143 }
144 maxPullDownDistance = std::max(maxPullDownDistance, 0.0f);
145 RefreshModel::GetInstance()->SetMaxPullDownDistance(maxPullDownDistance);
146 }
147
JsRefreshOffset(const JSCallbackInfo & info)148 void JSRefresh::JsRefreshOffset(const JSCallbackInfo& info)
149 {
150 if (info.Length() < 1) {
151 return;
152 }
153 JsRefreshOffset(info[0]);
154 }
155
JsRefreshOffset(const JSRef<JSVal> & jsVal)156 void JSRefresh::JsRefreshOffset(const JSRef<JSVal>& jsVal)
157 {
158 CalcDimension value(0.0f);
159 if (!ParseJsDimensionVpNG(jsVal, value)) {
160 value.SetValue(0.0f);
161 }
162 RefreshModel::GetInstance()->SetRefreshOffset(value);
163 }
164
Create(const JSCallbackInfo & info)165 void JSRefresh::Create(const JSCallbackInfo& info)
166 {
167 auto info0 = info[0];
168 if (!info0->IsObject()) {
169 return;
170 }
171
172 auto paramObject = JSRef<JSObject>::Cast(info0);
173 auto refreshing = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::REFRESHING));
174 auto jsOffset = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::OFFSET));
175 auto friction = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::FRICTION));
176 auto promptText = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::PROMPT_TEXT));
177 JSRef<JSVal> changeEventVal;
178 RefreshModel::GetInstance()->Create();
179
180 if (refreshing->IsBoolean()) {
181 RefreshModel::GetInstance()->SetRefreshing(refreshing->ToBoolean());
182 changeEventVal = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::$REFRESHING));
183 ParseRefreshingObject(info, changeEventVal);
184 } else if (refreshing->IsObject()) {
185 JSRef<JSObject> refreshingObj = JSRef<JSObject>::Cast(refreshing);
186 changeEventVal = refreshingObj->GetProperty(static_cast<int32_t>(ArkUIIndex::CHANGE_EVENT));
187 ParseRefreshingObject(info, changeEventVal);
188 RefreshModel::GetInstance()->SetRefreshing(
189 refreshingObj->GetProperty(static_cast<int32_t>(ArkUIIndex::VALUE))->ToBoolean());
190 } else {
191 RefreshModel::GetInstance()->SetRefreshing(false);
192 }
193 CalcDimension offset;
194 if (ParseJsDimensionVp(jsOffset, offset)) {
195 if (GreatOrEqual(offset.Value(), 0.0) && offset.Unit() != DimensionUnit::PERCENT) {
196 RefreshModel::GetInstance()->SetIndicatorOffset(offset);
197 }
198 }
199 ParsFrictionData(friction);
200 if (!ParseRefreshingContent(paramObject)) {
201 bool isCustomBuilderExist = ParseCustomBuilder(info);
202 RefreshModel::GetInstance()->SetIsCustomBuilderExist(isCustomBuilderExist);
203 }
204
205 std::string loadingStr = "";
206 if (SystemProperties::ConfigChangePerform()) {
207 RefPtr<ResourceObject> resObj;
208 if (ParseJsString(promptText, loadingStr, resObj)) {
209 RefreshModel::GetInstance()->CreateWithResourceObj(resObj);
210 RefreshModel::GetInstance()->SetLoadingText(loadingStr);
211 } else {
212 RefreshModel::GetInstance()->ResetLoadingText();
213 }
214 } else if (ParseJsString(promptText, loadingStr)) {
215 RefreshModel::GetInstance()->SetLoadingText(loadingStr);
216 } else {
217 RefreshModel::GetInstance()->ResetLoadingText();
218 }
219 }
220
ParseRefreshingContent(const JSRef<JSObject> & paramObject)221 bool JSRefresh::ParseRefreshingContent(const JSRef<JSObject>& paramObject)
222 {
223 JSRef<JSVal> contentParam = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::REFRESHING_CONTENT));
224 if (!contentParam->IsObject()) {
225 return false;
226 }
227 JSRef<JSObject> contentObject = JSRef<JSObject>::Cast(contentParam);
228 JSRef<JSVal> builderNodeParam = contentObject->GetProperty(static_cast<int32_t>(ArkUIIndex::BUILDER_NODE));
229 if (!builderNodeParam->IsObject()) {
230 return false;
231 }
232 JSRef<JSObject> builderNodeObject = JSRef<JSObject>::Cast(builderNodeParam);
233 JSRef<JSVal> nodeptr = builderNodeObject->GetProperty(static_cast<int32_t>(ArkUIIndex::NODEPTR));
234 if (nodeptr.IsEmpty()) {
235 return false;
236 }
237 const auto* vm = nodeptr->GetEcmaVM();
238 CHECK_NULL_RETURN(nodeptr->GetLocalHandle()->IsNativePointer(vm), false);
239 auto* node = nodeptr->GetLocalHandle()->ToNativePointer(vm)->Value();
240 auto* frameNode = reinterpret_cast<NG::FrameNode*>(node);
241 CHECK_NULL_RETURN(frameNode, false);
242 RefPtr<NG::FrameNode> refPtrFrameNode = AceType::Claim(frameNode);
243 RefreshModel::GetInstance()->SetCustomBuilder(refPtrFrameNode);
244 RefreshModel::GetInstance()->SetIsCustomBuilderExist(false);
245 return true;
246 }
247
ParseCustomBuilder(const JSCallbackInfo & info)248 bool JSRefresh::ParseCustomBuilder(const JSCallbackInfo& info)
249 {
250 if (!info[0]->IsObject()) {
251 return false;
252 }
253 auto paramObject = JSRef<JSObject>::Cast(info[0]);
254 auto builder = paramObject->GetProperty(static_cast<int32_t>(ArkUIIndex::BUILDER));
255 RefPtr<NG::UINode> customNode;
256 if (builder->IsFunction()) {
257 {
258 NG::ScopedViewStackProcessor builderViewStackProcessor;
259 JsFunction Jsfunc(info.This(), JSRef<JSFunc>::Cast(builder));
260 Jsfunc.Execute();
261 customNode = NG::ViewStackProcessor::GetInstance()->Finish();
262 }
263 RefreshModel::GetInstance()->SetCustomBuilder(customNode);
264 return true;
265 } else {
266 RefreshModel::GetInstance()->SetCustomBuilder(customNode);
267 return false;
268 }
269 }
270
OnStateChange(const JSCallbackInfo & args)271 void JSRefresh::OnStateChange(const JSCallbackInfo& args)
272 {
273 if (!args[0]->IsFunction()) {
274 return;
275 }
276 auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(args[0]));
277 WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
278 auto onStateChange = [execCtx = args.GetExecutionContext(), func = std::move(jsFunc), node = targetNode](
279 const int32_t& value) {
280 JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
281 ACE_SCORING_EVENT("Refresh.OnStateChange");
282 PipelineContext::SetCallBackNode(node);
283 auto newJSVal = JSRef<JSVal>::Make(ToJSValue(value));
284 func->ExecuteJS(1, &newJSVal);
285 UiSessionManager::GetInstance()->ReportComponentChangeEvent("event", "Refresh.OnStateChange");
286 };
287 RefreshModel::GetInstance()->SetOnStateChange(std::move(onStateChange));
288 }
289
OnRefreshing(const JSCallbackInfo & args)290 void JSRefresh::OnRefreshing(const JSCallbackInfo& args)
291 {
292 if (!args[0]->IsFunction()) {
293 return;
294 }
295 auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(args[0]));
296 WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
297 auto onRefreshing = [execCtx = args.GetExecutionContext(), func = std::move(jsFunc), node = targetNode]() {
298 JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
299 ACE_SCORING_EVENT("Refresh.OnRefreshing");
300 PipelineContext::SetCallBackNode(node);
301 auto newJSVal = JSRef<JSVal>::Make();
302 func->ExecuteJS(1, &newJSVal);
303 };
304 RefreshModel::GetInstance()->SetOnRefreshing(std::move(onRefreshing));
305 }
306
OnOffsetChange(const JSCallbackInfo & args)307 void JSRefresh::OnOffsetChange(const JSCallbackInfo& args)
308 {
309 if (!args[0]->IsFunction()) {
310 RefreshModel::GetInstance()->ResetOnOffsetChange();
311 return;
312 }
313 auto jsFunc = AceType::MakeRefPtr<JsFunction>(JSRef<JSObject>(), JSRef<JSFunc>::Cast(args[0]));
314 WeakPtr<NG::FrameNode> targetNode = AceType::WeakClaim(NG::ViewStackProcessor::GetInstance()->GetMainFrameNode());
315 auto offsetChange = [execCtx = args.GetExecutionContext(), func = std::move(jsFunc), node = targetNode](
316 const float& value) {
317 JAVASCRIPT_EXECUTION_SCOPE_WITH_CHECK(execCtx);
318 ACE_SCORING_EVENT("Refresh.OnOffsetChange");
319 PipelineContext::SetCallBackNode(node);
320 auto newJSVal = JSRef<JSVal>::Make(ToJSValue(value));
321 func->ExecuteJS(1, &newJSVal);
322 };
323 RefreshModel::GetInstance()->SetOnOffsetChange(std::move(offsetChange));
324 }
325
ParsFrictionData(const JsiRef<JsiValue> & friction)326 void JSRefresh::ParsFrictionData(const JsiRef<JsiValue>& friction)
327 {
328 int32_t frictionNumber = DEFAULT_FRICTION;
329 if (friction->IsString()) {
330 frictionNumber = StringUtils::StringToInt(friction->ToString());
331 if ((frictionNumber == 0 && friction->ToString() != "0") || frictionNumber < 0 ||
332 frictionNumber > MAX_FRICTION) {
333 frictionNumber = DEFAULT_FRICTION;
334 }
335 } else if (friction->IsNumber()) {
336 frictionNumber = friction->ToNumber<int32_t>();
337 if (frictionNumber < 0 || frictionNumber > MAX_FRICTION) {
338 frictionNumber = DEFAULT_FRICTION;
339 }
340 }
341 RefreshModel::GetInstance()->SetFriction(frictionNumber);
342 }
343 } // namespace OHOS::Ace::Framework
344