Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qohosqabilityinstancesmanager.cpp
Go to the documentation of this file.
1// Copyright (C) 2025 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
5#include <QtCore/private/qnapi_p.h>
6#include <qohosjsenv_p.h>
7#include <QtCore/private/qohoslogger_p.h>
8#include <QtCore/qcryptographichash.h>
9#include <QtGui/qwindow.h>
10#include <chrono>
11#include <cstdint>
12#include <cstring>
13#include <map>
14#include <qohosdeviceinfo_p.h>
15#include <qohosjsutils.h>
16#include <qohosplatformwindow.h>
17#include <render/qohosview.h>
18#include <typeindex>
19#include <unistd.h>
20
22
23QT_BEGIN_NAMESPACE
24
25using namespace std::chrono_literals;
26
27namespace QtOhos {
28
29namespace {
30
31const auto qtInternalRequestIdWantParamKey = "io.qt.private.internalRequestId";
32const auto qAbilityInstanceIdWantParamKey = "io.qt.private.abilityInstanceId";
33const auto callerAbilityNameWantParamKey = "ohos.aafwk.param.callerAbilityName";
34const auto callerBundleNameWantParamKey = "ohos.aafwk.param.callerBundleName";
35const auto callerPidWantParamKey = "ohos.aafwk.param.callerPid";
36
37std::string getUtf8QtInternalRequestIdForThisProcess()
38{
39 static const auto internalRequestIdCommonData =
40 QByteArray::fromHex("eba08604c86e45ae3690621757b3f4e9");
41
42 std::int32_t thisProcessPid = ::getpid();
43
44 QCryptographicHash hash{QCryptographicHash::Sha1};
45 hash.addData(internalRequestIdCommonData);
46 hash.addData(QByteArray::number(thisProcessPid));
47
48 return hash.result().toHex().toStdString();
49}
50
51QNapi::Symbol getAbilityLaunchParamPropSymbol(JsState &jsState)
52{
53 struct SymbolTag
54 {
55 };
56
57 return jsState.getJsSymbolForType<SymbolTag>();
58}
59
60void sendWantToSelfQAbility(
61 std::shared_ptr<QAbilityEngine> abilityEngine,
62 QNapi::Object baseQAbility, QNapi::Object optStartOptions, const std::string &instanceId,
63 std::function<void(JsState &)> continueFunc)
64{
65 auto qAbilityInfo = abilityEngine->readAbilityInfo(baseQAbility);
66
67 std::vector<QNapi::ValueWrapper> startAbilityArgs = {
68 QNapi::makeObject(
69 baseQAbility.Env(),
70 {
71 {"bundleName", qAbilityInfo.bundleName},
72 {"moduleName", qAbilityInfo.moduleName},
73 {"abilityName", qAbilityInfo.name},
74 {
75 "parameters",
76 QNapi::makeObject(
77 baseQAbility.Env(),
78 {
79 {qtInternalRequestIdWantParamKey, getUtf8QtInternalRequestIdForThisProcess()},
80 {qAbilityInstanceIdWantParamKey, instanceId},
81 })
82 },
83 }),
84 };
85
86 if (!optStartOptions.IsEmpty())
87 startAbilityArgs.push_back(optStartOptions);
88
89 baseQAbility.evalToPromiseOrRejectOnThrow("context.startAbility(*)", startAbilityArgs)
90 .onCatch(
91 [instanceId](const CallbackInfo &cbInfo) {
92 logJsCallbackError(cbInfo, "context.startAbility()");
93 qOhosReportFatalErrorAndAbort("Failed to start the Ability with instance id: %s", instanceId.c_str());
94 })
95 .onFinally(
96 [continueFunc = std::move(continueFunc)](const CallbackInfo &cbInfo) {
97 continueFunc(cbInfo.jsState());
98 });
99}
100
101QOhosSupplier<std::string> makeAbilityInstanceIdsGenerator()
102{
103 return [idsCounter = std::uint64_t(0)]() mutable {
104 auto instanceId = std::to_string(idsCounter);
105 ++idsCounter;
106 return instanceId;
107 };
108}
109
110class QAbilityPeerImpl : public virtual QAbilityPeer
111{
112public:
113 QAbilityPeerImpl(
114 JsState &jsState, std::shared_ptr<QAbilityEngine> abilityEngine,
115 std::string instanceId, QObjectThreadSafeRef qwindow,
116 QNapi::Object uiAbility);
117
118 ~QAbilityPeerImpl() = default;
119
120 std::string instanceId() final;
121 QNapi::Object qAbility() final;
122 QObjectThreadSafeRef qWindowRef() final;
123 std::optional<QNapi::Promise> qWindowDestroyPromise() final;
124 void forceResolveQWindowDestroyPromiseIfPresent(Napi::Env env) final;
125 std::shared_ptr<std::atomic_bool> destroyAllowedFlag() final;
126
127 void setQWindow(Napi::Env env, QObjectThreadSafeRef qwindow) final;
128
129private:
130 struct QWindowDestroyPromiseData
131 {
132 std::optional<QNapi::Promise::Deferred> deferred;
133 QNapi::Reference<QNapi::Promise> promise;
134 };
135
136 std::shared_ptr<QAbilityEngine> m_abilityEngine;
137 std::string m_instanceId;
138 QObjectThreadSafeRef m_qwindow;
139 std::shared_ptr<QWindowDestroyPromiseData> m_optQWindowDestroyPromiseData;
140 std::shared_ptr<std::atomic_bool> m_destroyAllowedFlag;
141 QNapi::Reference<QNapi::Object> m_uiAbility;
142};
143
144QAbilityPeerImpl::QAbilityPeerImpl(
145 JsState &, std::shared_ptr<QAbilityEngine> abilityEngine,
146 std::string instanceId, QObjectThreadSafeRef qwindow,
147 QNapi::Object uiAbility)
148 : m_abilityEngine(abilityEngine)
149 , m_instanceId(std::move(instanceId))
150 , m_destroyAllowedFlag(std::make_shared<std::atomic_bool>(false))
151 , m_uiAbility(Napi::Persistent(uiAbility))
152{
153 setQWindow(uiAbility.Env(), qwindow);
154}
155
156std::string QAbilityPeerImpl::instanceId()
157{
158 return m_instanceId;
159}
160
161QNapi::Object QAbilityPeerImpl::qAbility()
162{
163 return m_uiAbility.Value();
164}
165
166QObjectThreadSafeRef QAbilityPeerImpl::qWindowRef()
167{
168 return m_qwindow;
169}
170
171std::optional<QNapi::Promise> QAbilityPeerImpl::qWindowDestroyPromise()
172{
173 if (!m_optQWindowDestroyPromiseData || m_optQWindowDestroyPromiseData->promise.IsEmpty())
174 return {};
175
176 auto promiseValue = m_optQWindowDestroyPromiseData->promise.Value();
177 m_optQWindowDestroyPromiseData->promise.Reset();
178
179 return promiseValue;
180}
181
182void QAbilityPeerImpl::forceResolveQWindowDestroyPromiseIfPresent(Napi::Env env)
183{
184 if (!m_optQWindowDestroyPromiseData || !m_optQWindowDestroyPromiseData->deferred)
185 return;
186
187 qOhosPrintfInfo(
188 "%s: force-resolving QWindow destroy Promise for id='%s'",
189 Q_FUNC_INFO, m_instanceId.c_str());
190 std::exchange(m_optQWindowDestroyPromiseData->deferred, std::nullopt)->Resolve(env.Undefined());
191}
192
193std::shared_ptr<std::atomic_bool> QAbilityPeerImpl::destroyAllowedFlag()
194{
195 return m_destroyAllowedFlag;
196}
197
198void QAbilityPeerImpl::setQWindow(Napi::Env env, QObjectThreadSafeRef qwindow)
199{
200 if (qwindow == m_qwindow)
201 return;
202
203 qOhosPrintfInfo(
204 "%s: setting QAbilityPeer's QWindow: %s / %s",
205 Q_FUNC_INFO, m_instanceId.c_str(), m_qwindow.refName().c_str());
206
207 if (m_qwindow != QObjectThreadSafeRef()) {
208 qOhosReportFatalErrorAndAbort(
209 "QAbilityPeerImpl: overwriting previously set qwindow: %s => %s",
210 m_qwindow.refName().c_str(), qwindow.refName().c_str());
211 }
212
213 m_qwindow = qwindow;
214
215 auto qWindowDestroyPromiseDeferred = QNapi::Promise::Deferred::New(env);
216 m_optQWindowDestroyPromiseData = std::make_shared<QWindowDestroyPromiseData>(
217 QWindowDestroyPromiseData{
218 .deferred = qWindowDestroyPromiseDeferred,
219 .promise = QNapi::Reference<QNapi::Promise>::makePersistentFrom(
220 qWindowDestroyPromiseDeferred.Promise()),
221 });
222
223 auto resolveQWindowDestroyPromiseFunc =
224 [qWindowRef = qwindow, weakPromiseData = QtOhos::makeWeakPtr(m_optQWindowDestroyPromiseData)]() {
225 qOhosPrintfDebug(
226 "%s: sending request to resolve QWindow destroy notify Promise if needed: %s",
227 Q_FUNC_INFO, qWindowRef.refName().c_str());
229 [qWindowRef, weakPromiseData](JsState &jsState) {
230 auto promiseData = weakPromiseData.lock();
231 if (promiseData && promiseData->deferred) {
232 qOhosPrintfDebug(
233 "%s: resolving QWindow destroy notify Promise: %s",
234 Q_FUNC_INFO, qWindowRef.refName().c_str());
235 auto napiUndefined = Napi::Env(jsState.env()).Undefined();
236 std::exchange(promiseData->deferred, std::nullopt)->Resolve(napiUndefined);
237 } else {
238 qOhosPrintfDebug(
239 "%s: QAbilityPeer already removed on QWindow's destroy notification: %s",
240 Q_FUNC_INFO, qWindowRef.refName().c_str());
241 }
242 });
243 };
244
245 QtOhos::invokeInQtThread(
246 [qWindowRef = qwindow, resolveQWindowDestroyPromiseFunc]() {
247 auto *qWindow = static_cast<QWindow *>(qWindowRef.data().data());
248 auto *platformWindow = qWindow != nullptr ? QOhosPlatformWindow::fromQWindowOrNull(qWindow) : nullptr;
249 auto *view = platformWindow != nullptr ? platformWindow->ownedViewOrNull() : nullptr;
250
251 if (view != nullptr) {
252 qCDebug(
253 QtForOhos, "%s: connecting to QOhosView's 'destroyed', win: %s",
254 Q_FUNC_INFO, qWindowRef.refName().c_str());
255 QObject::connect(
256 view, &QObject::destroyed,
257 [qWindowRef, resolveQWindowDestroyPromiseFunc](QObject *) {
258 qCDebug(
259 QtForOhos, "%s: got QOhosView's 'destroyed' signal, win: %s",
260 Q_FUNC_INFO, qWindowRef.refName().c_str());
261 resolveQWindowDestroyPromiseFunc();
262 });
263 } else {
264 qCDebug(
265 QtForOhos, "%s: QOhosView already destroyed, win: %s",
266 Q_FUNC_INFO, qWindowRef.refName().c_str());
267 resolveQWindowDestroyPromiseFunc();
268 }
269 });
270}
271
272class QUiAbilityPeerImpl final : public virtual QUiAbilityPeer, public QAbilityPeerImpl, public QUiAbilityPeerBackend
273{
274public:
275 QUiAbilityPeerImpl(
276 JsState &jsState, std::shared_ptr<QAbilityEngine> abilityEngine,
277 std::string instanceId, QObjectThreadSafeRef qwindow,
278 QNapi::Object uiAbility, QNapi::Object windowStage);
279
280 QNapi::Object uiContext() override;
281 QNapi::Object launchWant() override;
282 QNapi::Object launchParam() override;
283 QNapi::Object windowStage() override;
284 QNapi::Object window() override;
285 bool isTerminating() override;
286
287 QNapi::Promise handleCloseRequestFromSystem(
288 JsState &jsState, const std::string &logContextStr, CloseAbilityRequestSource requestSource,
289 std::function<QNapi::Value(JsState &, CloseAbilityRequestResolution)> promiseValueFactory) override;
290
291 void handleOnContinueRequestFromSystem(
292 JsState &jsState, QNapi::Object wantParamsObj,
293 QOhosConsumer<JsState &, QOhosAbilityOnContinueResult> resultConsumer) override;
294
295 void setOnContinueRequestsHandler(
296 std::function<void(JsState &, QNapi::Object, QOhosConsumer<JsState &, QOhosAbilityOnContinueResult>)> requestsHandler) override;
297
298private:
299 QNapi::Reference<QNapi::Object> m_windowStage;
300 QNapi::Reference<QNapi::Object> m_window;
301 QNapi::Reference<QNapi::Object> m_launchParam;
302 std::shared_ptr<void> m_windowWillCloseCallbackHandle;
303 std::function<void(JsState &, QNapi::Object, QOhosConsumer<JsState &, QOhosAbilityOnContinueResult>)> m_onContinueRequestsHandler;
304};
305
306QUiAbilityPeerImpl::QUiAbilityPeerImpl(
307 JsState &jsState, std::shared_ptr<QAbilityEngine> abilityEngine,
308 std::string instanceId, QObjectThreadSafeRef qwindow,
309 QNapi::Object uiAbility, QNapi::Object windowStage)
310 : QAbilityPeerImpl(jsState, abilityEngine, instanceId, qwindow, uiAbility)
311 , m_windowStage(Napi::Persistent(windowStage))
312 , m_window(Napi::Persistent(windowStage.eval<QNapi::Object>("getMainWindowSync()")))
313{
314 auto optLaunchParam = QNapi::getOptionalPropOrEmpty<QNapi::Object>(
315 uiAbility, getAbilityLaunchParamPropSymbol(jsState));
316 if (optLaunchParam.IsEmpty()) {
317 qOhosReportFatalErrorAndAbort(
318 "Ability with instanceId='%s' doesn't have 'launchParam' set. It shouldn't happen!",
319 instanceId.c_str());
320 }
321 m_launchParam = QNapi::Reference<>::makePersistentFrom(optLaunchParam);
322
323 m_windowWillCloseCallbackHandle = registerQOhosOnOffMethodsBasedEventHandler(
324 window(), "windowWillClose",
325 [this](const CallbackInfo &cbInfo) {
326 JsState &jsState = cbInfo.jsState();
327 return handleCloseRequestFromSystem(
328 jsState, "Window.windowWillClose",
329 CloseAbilityRequestSource::WindowWillClose,
330 [](JsState &jsState, CloseAbilityRequestResolution ohosRequestResolution) {
331 return QNapi::Boolean::New(
332 jsState.env(),
333 ohosRequestResolution == CloseAbilityRequestResolution::DontClose);
334 });
335 },
336 {
337 .optEventSourceAliveCheckFunc =
338 [qAbilityWeakRef = moveToSharedPtr(Napi::Weak(uiAbility))](QNapi::Object window) {
339 bool isWindowClosing = evalInJsThread(
340 [&](JsState &) {
341 return JsWindowsTracker::isWindowClosing(window);
342 },
343 Q_FUNC_INFO);
344 auto qAbilityValue = qAbilityWeakRef->Value();
345 return
346 !isWindowClosing
347 && qAbilityValue.IsObject()
348 && !QNapi::checkedCast<QNapi::Object>(qAbilityValue).eval<QNapi::Boolean>("context.isTerminating()");
349 },
350 .extraOnArg = {},
351 .extraOffArg = {},
352 .optOnCallExceptionHandler = [](const Napi::Error &error) {
353 constexpr auto capabilityNotSupportedErrorCode = 801;
354 QtOhos::rethrowUnlessJsBusinessErrorIs(
355 error, capabilityNotSupportedErrorCode, "on('windowWillClose')");
356 },
357 });
358}
359
360QNapi::Object QUiAbilityPeerImpl::uiContext()
361{
362 return window().eval<QNapi::Object>("getUIContext()");
363}
364
365QNapi::Object QUiAbilityPeerImpl::launchWant()
366{
367 return qAbility().get<QNapi::Object>("launchWant");
368}
369
370QNapi::Object QUiAbilityPeerImpl::launchParam()
371{
372 return m_launchParam.Value();
373}
374
375QNapi::Object QUiAbilityPeerImpl::windowStage()
376{
377 return m_windowStage.Value();
378}
379
380QNapi::Object QUiAbilityPeerImpl::window()
381{
382 return m_window.Value();
383}
384
385bool QUiAbilityPeerImpl::isTerminating()
386{
387 return qAbility().eval<QNapi::Boolean>("context.isTerminating()");
388}
389
390QOhosCloseEventContext::CloseRootCause mapCloseAbilityRequestSourceToRootCause(
392{
393 using CloseAbilityRequestSource = QUiAbilityPeerBackend::CloseAbilityRequestSource;
394 using CloseRootCause = QOhosCloseEventContext::CloseRootCause;
395
396 switch (requestSource) {
397 case CloseAbilityRequestSource::OnPrepareToTerminate:
398 return CloseRootCause::OnPrepareToTerminate;
399 case CloseAbilityRequestSource::WindowWillClose:
400 return CloseRootCause::WindowStageClose;
401 }
402
403 qOhosReportFatalErrorAndAbort("Unsupported CloseAbilityRequestSource: %d", static_cast<int>(requestSource));
404}
405
406QNapi::Promise QUiAbilityPeerImpl::handleCloseRequestFromSystem(
407 JsState &jsState, const std::string &logContextStr, CloseAbilityRequestSource requestSource,
408 std::function<QNapi::Value(JsState &, CloseAbilityRequestResolution)> promiseValueFactory)
409{
410 auto instanceId = this->instanceId();
411
412 qOhosPrintfInfo(
413 "%s: got close request from source %d, id: '%s'",
414 logContextStr.c_str(), static_cast<int>(requestSource), instanceId.c_str());
415
416 if (destroyAllowedFlag()->load()) {
417 qOhosPrintfDebug(
418 "%s: resolving immediately with 'false', id: '%s'",
419 Q_FUNC_INFO, instanceId.c_str());
420 JsWindowsTracker::tagWindowAsClosing(
421 window(), printfToString("%s => false", logContextStr.c_str()).c_str());
422 return makeResolvedPromise(
423 promiseValueFactory(jsState, CloseAbilityRequestResolution::Close));
424 }
425
426 struct PromiseResolveFuncContext
427 {
428 std::string logContextStr;
429 std::weak_ptr<QUiAbilityPeer> weakQAbilityPeer;
430 std::shared_ptr<QNapi::Promise::Deferred> promiseDeferred;
431 std::string instanceId;
432 std::function<QNapi::Value(JsState &, CloseAbilityRequestResolution)> promiseValueFactory;
433 };
434
435 auto promiseResolveFuncContext = moveToSharedPtr(
436 PromiseResolveFuncContext{
437 .logContextStr = logContextStr,
438 .weakQAbilityPeer = makeWeakPtr(shared_from_this()),
439 .promiseDeferred = std::make_shared<QNapi::Promise::Deferred>(jsState.env()),
440 .instanceId = instanceId,
441 .promiseValueFactory = std::move(promiseValueFactory),
442 });
443
444 auto promiseResolveFunc = moveToSharedPtr(
445 makeCallOnceConsumerWrapper<JsState &, CloseAbilityRequestResolution>(
446 [context = promiseResolveFuncContext](JsState &jsState, CloseAbilityRequestResolution ohosRequestResolution) {
447 auto qAbilityPeer = context->weakQAbilityPeer.lock();
448 if (qAbilityPeer && ohosRequestResolution == CloseAbilityRequestResolution::Close) {
449 JsWindowsTracker::tagWindowAsClosing(
450 qAbilityPeer->window(), printfToString("%s => false", context->logContextStr.c_str()).c_str());
451 }
452 context->promiseDeferred->Resolve(
453 context->promiseValueFactory(jsState, ohosRequestResolution));
454 qOhosPrintfInfo(
455 "%s: promise resolved as %d, id: '%s'",
456 context->logContextStr.c_str(), static_cast<int>(ohosRequestResolution), context->instanceId.c_str());
457 }));
458
459 constexpr auto promiseAutoresolveTimeout = 9s;
460 setJsTimeout(
461 jsState,
462 [logContextStr, promiseResolveFunc, instanceId](const CallbackInfo &cbInfo) {
463 if ((*promiseResolveFunc)(cbInfo.jsState(), CloseAbilityRequestResolution::DontClose)) {
464 qOhosPrintfInfo(
465 "%s: promise resolved by timeout, id: '%s'",
466 logContextStr.c_str(), instanceId.c_str());
467 }
468 },
469 promiseAutoresolveTimeout);
470
471 qWindowRef().visitInQtThreadIfAlive(
472 [logContextStr, requestSource, promiseResolveFunc, instanceId](auto &qWindowObj) {
473 qOhosPrintfInfo(
474 "%s: calling close(), id: '%s'",
475 logContextStr.c_str(), instanceId.c_str());
476 QOhosCloseEventContext::runWithCloseRootCauseAndCloseResolutionConsumerSet(
477 mapCloseAbilityRequestSourceToRootCause(requestSource),
478 [logContextStr, promiseResolveFunc, instanceId](QOhosCloseEventContext::CloseResolution closeResolution) {
479 auto ohosRequestResolution =
480 closeResolution == QOhosCloseEventContext::CloseResolution::Close
481 ? CloseAbilityRequestResolution::Close
482 : CloseAbilityRequestResolution::DontClose;
483 qOhosPrintfInfo(
484 "%s: requesting promise resolve to %d from Qt thread, id: '%s'",
485 logContextStr.c_str(), static_cast<int>(ohosRequestResolution), instanceId.c_str());
486 QtOhos::invokeInJsThread(
487 [logContextStr, promiseResolveFunc, ohosRequestResolution, instanceId](JsState &jsState) {
488 bool resolveCalled = (*promiseResolveFunc)(jsState, ohosRequestResolution);
489 qOhosPrintfInfo(
490 "%s: promise resolve to %d, called: %s, id: '%s'",
491 logContextStr.c_str(), static_cast<int>(ohosRequestResolution),
492 mapBoolToTrueFalseStr(resolveCalled), instanceId.c_str());
493 });
494 },
495 [&]() {
496 static_cast<QWindow &>(qWindowObj).close();
497 });
498 });
499
500 qOhosPrintfInfo("%s: returning Promise, id: '%s'", logContextStr.c_str(), instanceId.c_str());
501
502 return promiseResolveFuncContext->promiseDeferred->Promise();
503}
504
505void QUiAbilityPeerImpl::handleOnContinueRequestFromSystem(
506 JsState &jsState, QNapi::Object wantParamsObj, QOhosConsumer<JsState &, QOhosAbilityOnContinueResult> resultConsumer)
507{
508 if (m_onContinueRequestsHandler) {
509 m_onContinueRequestsHandler(jsState, wantParamsObj, std::move(resultConsumer));
510 } else {
511 qOhosPrintfDebug("%s: no handler set, rejecting", Q_FUNC_INFO);
513 [resultConsumer = std::move(resultConsumer)](JsState &jsState) {
514 resultConsumer(jsState, QOhosAbilityOnContinueResult::REJECT);
515 });
516 }
517}
518
519void QUiAbilityPeerImpl::setOnContinueRequestsHandler(
520 std::function<void(JsState &, QNapi::Object, QOhosConsumer<JsState &, QOhosAbilityOnContinueResult>)> requestsHandler)
521{
522 if (m_onContinueRequestsHandler) {
523 qOhosReportFatalErrorAndAbort(
524 "%s: overwriting previously set requests handler, id='%s'",
525 Q_FUNC_INFO, instanceId().c_str());
526 }
527
528 m_onContinueRequestsHandler = std::move(requestsHandler);
529}
530
531class QAbilityInstancesManagerImpl final : public QAbilityInstancesManager
532{
533public:
534 explicit QAbilityInstancesManagerImpl(
535 std::shared_ptr<QAbilityEngine> abilityEngine,
536 std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)> autoStartedInstanceStartupNotifyFunc);
537
538 std::shared_ptr<QAbilityEngine> abilityEngine() override;
539
540 bool isWantFromThisApp(QNapi::Object appQAbility, QNapi::Object want) const override;
541
542 std::optional<std::string> tryGetQAbilityInstanceIdFromWant(QNapi::Object appQAbility, QNapi::Object want) const override;
543 std::string getQAbilityInstanceIdOrPendingAutoStartedId(QNapi::Object qAbility) const override;
544
545 std::optional<std::string> pendingAutoStartedInstanceId() const override;
546
547 void registerPendingAutoStartedInstance() override;
548
549 void startNewInstance(
550 QNapi::Object baseQAbility, QObjectThreadSafeRef qwindow,
551 QNapi::Object optStartOptions,
552 std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)> startupNotifyFunc) override;
553
554 void handleStartedUiInstance(JsState &jsState, QNapi::Object qAbility, QNapi::Object windowStage) override;
555
556 std::shared_ptr<QUiAbilityPeerBackend> getAbilityPeerBackend(std::shared_ptr<QUiAbilityPeer> uiAbilityPeer) override;
557
558private:
559 struct InstanceStartParams
560 {
561 QObjectThreadSafeRef qwindow;
562 std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)> startupNotifyFunc;
563 };
564
565 void handleStartedInstance(
566 JsState &jsState, const std::string &abilityInstanceId,
567 const std::function<std::shared_ptr<QAbilityPeer>(const std::string &, const InstanceStartParams &)> &qAbilityPeerFactory);
568
569 std::shared_ptr<QAbilityEngine> m_abilityEngine;
570 std::shared_ptr<std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)>> m_autoStartedInstanceStartupNotifyFunc;
571 std::shared_ptr<std::map<QUiAbilityPeer *, std::weak_ptr<QUiAbilityPeerImpl>>> m_ownedUiAbilityPeers;
572 QOhosSupplier<std::string> m_abilityInstanceIdsGenerator;
573 std::map<std::string, InstanceStartParams> m_pendingInstancesStartParams;
574 std::optional<std::string> m_pendingAutoStartedInstanceId;
575};
576
577QAbilityInstancesManagerImpl::QAbilityInstancesManagerImpl(
578 std::shared_ptr<QAbilityEngine> abilityEngine,
579 std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)> autoStartedInstanceStartupNotifyFunc)
580 : m_abilityEngine(abilityEngine)
581 , m_autoStartedInstanceStartupNotifyFunc(moveToSharedPtr(std::move(autoStartedInstanceStartupNotifyFunc)))
582 , m_ownedUiAbilityPeers(std::make_shared<std::map<QUiAbilityPeer *, std::weak_ptr<QUiAbilityPeerImpl>>>())
583 , m_abilityInstanceIdsGenerator(makeAbilityInstanceIdsGenerator())
584{
585 registerPendingAutoStartedInstance();
586}
587
588std::optional<std::string> QAbilityInstancesManagerImpl::tryGetQAbilityInstanceIdFromWant(
589 QNapi::Object appQAbility, QNapi::Object want) const
590{
591 auto wantParameters = QNapi::getPropOrUndefined(want, "parameters");
592 if (wantParameters.IsUndefined())
593 return {};
594
595 auto instanceIdParam = QNapi::getPropOrUndefined(wantParameters, qAbilityInstanceIdWantParamKey);
596
597 bool validInstanceId = isWantFromThisApp(appQAbility, want) && instanceIdParam.IsString();
598
599 return validInstanceId
600 ? std::optional(QNapi::checkedCast<QNapi::String>(instanceIdParam).Utf8Value())
601 : std::nullopt;
602}
603
604std::string QAbilityInstancesManagerImpl::getQAbilityInstanceIdOrPendingAutoStartedId(QNapi::Object qAbility) const
605{
606 auto optInstanceId = tryGetQAbilityInstanceIdFromWant(
607 qAbility, qAbility.get<QNapi::Object>("launchWant"));
608
609 if (!optInstanceId.has_value() && !m_pendingAutoStartedInstanceId.has_value()) {
610 qOhosReportFatalErrorAndAbort(
611 "Got Ability without '%s' param and no pending auto-started instance",
612 qAbilityInstanceIdWantParamKey);
613 }
614
615 return optInstanceId.has_value()
616 ? optInstanceId.value()
617 : m_pendingAutoStartedInstanceId.value();
618}
619
620std::shared_ptr<QAbilityEngine> QAbilityInstancesManagerImpl::abilityEngine()
621{
622 return m_abilityEngine;
623}
624
625bool QAbilityInstancesManagerImpl::isWantFromThisApp(QNapi::Object appQAbility, QNapi::Object want) const
626{
627 auto wantParameters = QNapi::getPropOrUndefined(want, "parameters");
628 if (wantParameters.IsUndefined())
629 return false;
630
631 auto callerAbilityNameParam = QNapi::getPropOrUndefined(wantParameters, callerAbilityNameWantParamKey);
632 auto callerBundleNameParam = QNapi::getPropOrUndefined(wantParameters, callerBundleNameWantParamKey);
633
634 auto appAbilityInfo = m_abilityEngine->readAbilityInfo(appQAbility);
635
636 return
637 callerAbilityNameParam.IsString()
638 && QNapi::checkedCast<QNapi::String>(callerAbilityNameParam).Utf8Value() == appAbilityInfo.name
639 && callerBundleNameParam.IsString()
640 && QNapi::checkedCast<QNapi::String>(callerBundleNameParam).Utf8Value() == appAbilityInfo.bundleName;
641}
642
643std::optional<std::string> QAbilityInstancesManagerImpl::pendingAutoStartedInstanceId() const
644{
645 return m_pendingAutoStartedInstanceId;
646}
647
648void QAbilityInstancesManagerImpl::registerPendingAutoStartedInstance()
649{
650 if (m_pendingAutoStartedInstanceId.has_value()) {
651 qOhosReportFatalErrorAndAbort(
652 "%s: pending auto-started instance already registered (id='%s')",
653 Q_FUNC_INFO, m_pendingAutoStartedInstanceId.value().c_str());
654 }
655
656 m_pendingAutoStartedInstanceId = m_abilityInstanceIdsGenerator();
657
658 qOhosPrintfInfo(
659 "Registered pending auto-started Ability instance, id='%s'",
660 m_pendingAutoStartedInstanceId.value().c_str());
661}
662
663void QAbilityInstancesManagerImpl::startNewInstance(
664 QNapi::Object baseQAbility, QObjectThreadSafeRef qwindow,
665 QNapi::Object optStartOptions,
666 std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)> startupNotifyFunc)
667{
668 struct Context
669 {
670 std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)> startupNotifyFunc;
671 bool sendWantFinished = false;
672 std::shared_ptr<QAbilityPeer> optAbilityPeer;
673
674 void callNotifyIfReady(JsState &jsState)
675 {
676 qOhosPrintfDebug(
677 "%s: sendWantFinished=%s, startedAbilityPeer=%s",
678 Q_FUNC_INFO, mapBoolToTrueFalseStr(sendWantFinished), mapBoolToTrueFalseStr(!!optAbilityPeer));
679 if (sendWantFinished && optAbilityPeer)
680 startupNotifyFunc(jsState, optAbilityPeer);
681 }
682 };
683
684 auto context = std::make_shared<Context>();
685 context->startupNotifyFunc = std::move(startupNotifyFunc);
686
687 auto instanceId = m_abilityInstanceIdsGenerator();
688
689 InstanceStartParams startParams;
690 startParams.qwindow = qwindow;
691 startParams.startupNotifyFunc = [context](JsState &jsState, std::shared_ptr<QAbilityPeer> abilityPeer) {
692 context->optAbilityPeer = abilityPeer;
693 context->callNotifyIfReady(jsState);
694 };
695 m_pendingInstancesStartParams.emplace(instanceId, std::move(startParams));
696
697 sendWantToSelfQAbility(
698 m_abilityEngine, baseQAbility, optStartOptions, instanceId,
699 [context](JsState &jsState) {
700 context->sendWantFinished = true;
701 context->callNotifyIfReady(jsState);
702 });
703}
704
705void QAbilityInstancesManagerImpl::handleStartedUiInstance(
706 JsState &jsState, QNapi::Object qAbility, QNapi::Object windowStage)
707{
708 handleStartedInstance(
709 jsState, getQAbilityInstanceIdOrPendingAutoStartedId(qAbility),
710 [&](const std::string &instanceId, const InstanceStartParams &startParams) {
711 auto uiAbilityPeer = std::make_shared<QUiAbilityPeerImpl>(
712 jsState, m_abilityEngine, instanceId, startParams.qwindow, qAbility, windowStage);
713 QUiAbilityPeer *uiAbilityPeerKey = uiAbilityPeer.get();
714 m_ownedUiAbilityPeers->emplace(uiAbilityPeerKey, uiAbilityPeer);
715 return makeSharedPtrWithAttachedExtraData(
716 uiAbilityPeer,
717 makeDestroyNotifier(
718 [ownedUiAbilityPeers = m_ownedUiAbilityPeers, uiAbilityPeerKey]() {
719 ownedUiAbilityPeers->erase(uiAbilityPeerKey);
720 }));
721 });
722}
723
724std::shared_ptr<QUiAbilityPeerBackend> QAbilityInstancesManagerImpl::getAbilityPeerBackend(
725 std::shared_ptr<QUiAbilityPeer> uiAbilityPeer)
726{
727 auto ownedPeerEntryIter = m_ownedUiAbilityPeers->find(uiAbilityPeer.get());
728 auto ownedPeerImpl =
729 ownedPeerEntryIter != m_ownedUiAbilityPeers->end()
730 ? ownedPeerEntryIter->second.lock()
731 : nullptr;
732
733 if (!ownedPeerImpl) {
734 qOhosReportFatalErrorAndAbort(
735 "%s: got unknown QUiAbilityPeer %p with id='%s'",
736 Q_FUNC_INFO, uiAbilityPeer.get(), uiAbilityPeer->instanceId().c_str());
737 }
738
739 return ownedPeerImpl;
740}
741
742void QAbilityInstancesManagerImpl::handleStartedInstance(
743 JsState &jsState, const std::string &abilityInstanceId,
744 const std::function<std::shared_ptr<QAbilityPeer>(const std::string &, const InstanceStartParams &)> &qAbilityPeerFactory)
745{
746 auto startParamsIter = m_pendingInstancesStartParams.find(abilityInstanceId);
747 if (startParamsIter != m_pendingInstancesStartParams.end()) {
748 auto startParams = std::move(startParamsIter->second);
749 m_pendingInstancesStartParams.erase(startParamsIter);
750
751 auto qAbilityPeer = qAbilityPeerFactory(abilityInstanceId, startParams);
752 QtOhos::addJsQAbilityPeer(qAbilityPeer);
753 startParams.startupNotifyFunc(jsState, qAbilityPeer);
754 } else if (abilityInstanceId == m_pendingAutoStartedInstanceId) {
755 m_pendingAutoStartedInstanceId.reset();
756
757 InstanceStartParams startParams = {
758 .qwindow = QObjectThreadSafeRef(),
759 .startupNotifyFunc = [startupNotifyFunc = m_autoStartedInstanceStartupNotifyFunc](JsState &jsState, std::shared_ptr<QAbilityPeer> qAbilityPeer) {
760 (*startupNotifyFunc)(jsState, qAbilityPeer);
761 },
762 };
763 auto qAbilityPeer = qAbilityPeerFactory(abilityInstanceId, startParams);
764 QtOhos::addJsQAbilityPeer(qAbilityPeer);
765 startParams.startupNotifyFunc(jsState, qAbilityPeer);
766 } else {
767 qOhosPrintfError(
768 "%s: got unexpected started instance notification with id='%s', ignoring",
769 Q_FUNC_INFO, abilityInstanceId.c_str());
770 }
771}
772
773}
774
776
778
780
781bool QAbilityInstancesManager::isQtInternalWantFromThisProcess(QNapi::Object want)
782{
783 auto optWantParameters = QNapi::getOptionalPropOrEmpty<QNapi::Object>(want, "parameters");
784
785 auto optCallerPid = QNapi::getOptionalPropOrEmpty<QNapi::Number>(
786 optWantParameters, callerPidWantParamKey);
787 auto optQtInternalRequestId = QNapi::getOptionalPropOrEmpty<QNapi::String>(
788 optWantParameters, qtInternalRequestIdWantParamKey);
789
790 std::int32_t thisProcessPid = ::getpid();
791
792 return
793 !optCallerPid.IsEmpty() && optCallerPid.Int32Value() == thisProcessPid
794 && !optQtInternalRequestId.IsEmpty()
795 && optQtInternalRequestId.Utf8Value() == getUtf8QtInternalRequestIdForThisProcess();
796}
797
798void QAbilityInstancesManager::setLaunchParamOnAbilityObject(
799 JsState &jsState, QNapi::Object ability, QNapi::Object launchParam)
800{
801 ability.set(getAbilityLaunchParamPropSymbol(jsState), launchParam);
802}
803
805 std::shared_ptr<QAbilityEngine> abilityEngine,
806 std::function<void(JsState &, std::shared_ptr<QAbilityPeer>)> autoStartedInstanceStartupNotifyFunc)
807{
808 return std::make_shared<QAbilityInstancesManagerImpl>(abilityEngine, std::move(autoStartedInstanceStartupNotifyFunc));
809}
810
811}
812
813QT_END_NAMESPACE
JsState & jsState() const
std::string const char * mapBoolToTrueFalseStr(bool value)
void invokeInJsThread(std::function< void(JsState &)> task)
std::shared_ptr< QAbilityInstancesManager > makeQAbilityInstancesManager(std::shared_ptr< QAbilityEngine > abilityEngine, std::function< void(JsState &, std::shared_ptr< QAbilityPeer >)> autoStartedInstanceStartupNotifyFunc)
void addJsQAbilityPeer(std::shared_ptr< QAbilityPeer > qAbilityPeer)