1 /* 2 * Copyright (c) 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 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_UI_EXTENSION_UI_EXTENSION_MANAGER_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_UI_EXTENSION_UI_EXTENSION_MANAGER_H 18 19 #include <bitset> 20 #include <memory> 21 #include <mutex> 22 23 #include "base/memory/ace_type.h" 24 #include "base/memory/referenced.h" 25 #include "base/want/want_wrap.h" 26 #include "core/common/container.h" 27 #include "core/components_ng/pattern/ui_extension/session_wrapper.h" 28 #include "interfaces/inner_api/ace/viewport_config.h" 29 30 namespace OHOS { 31 template<typename T> 32 class sptr; 33 namespace Rosen { 34 class AvoidArea; 35 enum class WSError; 36 class OccupiedAreaChangeInfo; 37 enum class WindowMode : uint32_t; 38 } // namespace Rosen 39 } // namespace OHOS 40 41 namespace OHOS::Ace::NG { 42 class UIExtensionPattern; 43 namespace { 44 constexpr int32_t UI_EXTENSION_UNKNOW_ID = 0; 45 constexpr int32_t UI_EXTENSION_ID_FIRST_MAX = 10; 46 constexpr int32_t UI_EXTENSION_ID_OTHER_MAX = 9; 47 constexpr int64_t UI_EXTENSION_OFFSET_MAX = 100000000000; 48 constexpr int64_t UI_EXTENSION_OFFSET_MIN = 10000000000; 49 constexpr int32_t UI_EXTENSION_ID_FACTOR = 10; 50 constexpr int32_t UI_EXTENSION_LEVEL_MAX = 3; 51 constexpr int32_t UI_EXTENSION_ROOT_ID = -1; 52 using UIExtBusinessDataSendCallback = std::function<std::optional<AAFwk::Want>(WeakPtr<FrameNode>)>; 53 using UIExtBusinessDataConsumeCallback = std::function<int32_t(const AAFwk::Want&)>; 54 using UIExtBusinessDataConsumeReplyCallback = std::function<int32_t(const AAFwk::Want&, std::optional<AAFwk::Want>&)>; 55 using SingleHandTransformChangedCallbackMap = std::unordered_map<int32_t, std::function<void()>>; 56 57 using UIExtBusinessSendToHostReplyFunc = std::function<bool(uint32_t, const AAFwk::Want&, AAFwk::Want&)>; 58 using UIExtBusinessSendToHostFunc = std::function<bool(uint32_t, const AAFwk::Want&, BusinessDataSendType)>; 59 60 }; // namespace 61 62 class SecurityUIExtensionPattern; 63 class ACE_FORCE_EXPORT UIExtensionIdUtility : public Singleton<UIExtensionIdUtility> { 64 DECLARE_SINGLETON(UIExtensionIdUtility); 65 public: 66 int32_t ApplyExtensionId(); 67 void RecycleExtensionId(int32_t id); 68 69 private: 70 std::bitset<UI_EXTENSION_ID_FIRST_MAX> idPool_; 71 std::mutex poolMutex_; 72 }; 73 74 class UIExtensionManager : public AceType { 75 DECLARE_ACE_TYPE(UIExtensionManager, AceType); 76 77 public: 78 UIExtensionManager() = default; 79 ~UIExtensionManager() override = default; 80 81 void RegisterUIExtensionInFocus( 82 const WeakPtr<UIExtensionPattern>& uiExtensionFocused, const WeakPtr<SessionWrapper>& sessionWrapper); 83 bool OnBackPressed(); 84 const RefPtr<FrameNode> GetFocusUiExtensionNode(); 85 bool IsWrapExtensionAbilityId(int64_t elementId); 86 bool SendAccessibilityEventInfo(const Accessibility::AccessibilityEventInfo& eventInfo, int64_t uiExtensionOffset, 87 const RefPtr<PipelineBase>& pipeline); 88 std::pair<int64_t, int64_t> UnWrapExtensionAbilityId(int64_t extensionOffset, int64_t elementId); 89 int32_t ApplyExtensionId(); 90 void RecycleExtensionId(int32_t id); 91 void RegisterSecurityUIExtensionInFocus( 92 const WeakPtr<SecurityUIExtensionPattern>& uiExtensionFocused, 93 const WeakPtr<SessionWrapper>& sessionWrapper); 94 95 /** 96 * @brief Create a UIExtensionComponent object on the page and save it in the UIExtension management object 97 * 98 * @param uiExtension The UIExtensionComponent pattern object 99 */ 100 void AddAliveUIExtension(int32_t nodeId, const WeakPtr<UIExtensionPattern>& uiExtension); 101 102 /** 103 * @brief Clear the UIExtensionComponent to be destroyed 104 * 105 * @param nodeId The UIExtensionComponent Id 106 */ 107 void RemoveDestroyedUIExtension(int32_t nodeId); 108 109 /** 110 * @brief Check whether UIExtensionComponent Node is showing placeholder 111 * 112 * @param nodeId The UIExtensionComponent Id 113 */ 114 bool IsShowPlaceholder(int32_t nodeId); 115 116 /** 117 * @brief Transfer the original avoid area and avoid area type to the UIExtensionAbility 118 * 119 * @param avoidArea The original avoid area 120 * @param type The original aovid areatype 121 */ 122 void TransferOriginAvoidArea(const Rosen::AvoidArea& avoidArea, uint32_t type); 123 124 bool NotifyOccupiedAreaChangeInfo(const sptr<Rosen::OccupiedAreaChangeInfo>& info); 125 126 bool HandleUnfocusedModalUecBackPressed(); 127 128 bool IsLastModalUec(const RefPtr<FrameNode>& frameNode); 129 130 void NotifySizeChangeReason( 131 WindowSizeChangeReason type, const std::shared_ptr<Rosen::RSTransaction>& rsTransaction); 132 133 void AddAliveUIExtension(int32_t nodeId, const WeakPtr<SecurityUIExtensionPattern>& uiExtension); 134 135 void UpdateSessionViewportConfig(const ViewportConfig& config); 136 137 void DumpUIExt(); 138 139 void RegisterSingleHandTransformChangedCallback(int32_t nodeId, std::function<void()>&& callback); 140 void UnregisterSingleHandTransformChangedCallback(int32_t nodeId); 141 void HandleSingleHandTransformChangedCallback(); 142 143 // host send data to provider 144 void RegisterBusinessDataSendCallback( 145 UIContentBusinessCode code, BusinessDataSendType type, const UIExtBusinessDataSendCallback& callback, 146 RSSubsystemId subSystemId = RSSubsystemId::ARKUI_UIEXT); 147 void UnRegisterBusinessDataSendCallback(UIContentBusinessCode code); 148 bool TriggerBusinessDataSend(UIContentBusinessCode code); 149 150 // provider consume data 151 void RegisterBusinessDataConsumeReplyCallback( 152 UIContentBusinessCode code, const UIExtBusinessDataConsumeReplyCallback& callback); 153 void UnRegisterBusinessDataConsumeReplyCallback(UIContentBusinessCode code); 154 void DispatchBusinessDataConsumeReply( 155 UIContentBusinessCode code, const AAFwk::Want& data, std::optional<AAFwk::Want>& reply); 156 157 // provider send data to host, called by framework 158 void RegisterBusinessDataConsumeCallback( 159 UIContentBusinessCode code, const UIExtBusinessDataConsumeCallback& callback); 160 void UnRegisterBusinessDataConsumeCallback(UIContentBusinessCode code); 161 void DispatchBusinessDataConsume(UIContentBusinessCode code, const AAFwk::Want& data); 162 163 // register provider send data to host, called by framework 164 void RegisterBusinessSendToHostReply(const UIExtBusinessSendToHostReplyFunc& func); 165 // register provider send data to host, called by framework 166 void RegisterBusinessSendToHost(const UIExtBusinessSendToHostFunc& func); 167 168 // provider send to host, consumer is in ui_extension_pattern 169 bool SendBusinessToHost(UIContentBusinessCode code, const AAFwk::Want& data, BusinessDataSendType type); 170 // provider send to host sync reply, only used in uiextension init, not allowd used by other 171 bool SendBusinessToHostSyncReply(UIContentBusinessCode code, const AAFwk::Want& data, AAFwk::Want& reply); 172 173 void NotifyWindowMode(Rosen::WindowMode mode); 174 175 void SendPageModeToProvider(const int32_t nodeId, const std::string& pageMode); 176 void SendPageModeRequestToHost(const RefPtr<PipelineContext>& pipeline); 177 void TransferAccessibilityRectInfo(); 178 void UpdateWMSUIExtProperty(UIContentBusinessCode code, const AAFwk::Want& data, RSSubsystemId subSystemId); 179 void UpdateWMSUIExtPropertyByPersistentId(UIContentBusinessCode code, const AAFwk::Want& data, 180 const std::unordered_set<int32_t>& persistentIds, RSSubsystemId subSystemId); SetInstanceId(int32_t id)181 void SetInstanceId(int32_t id) 182 { 183 instanceId_ = id; 184 } SetPipelineContext(const WeakPtr<PipelineContext> & pipeline)185 void SetPipelineContext(const WeakPtr<PipelineContext>& pipeline) 186 { 187 pipeline_ = pipeline; 188 } 189 void NotifyUECProviderIfNeedded(); 190 191 private: 192 void RegisterListenerIfNeeded(); 193 void UnregisterListenerIfNeeded(); 194 bool UIExtBusinessDataSendValid(); 195 WeakPtr<UIExtensionPattern> uiExtensionFocused_; 196 WeakPtr<SecurityUIExtensionPattern> securityUiExtensionFocused_; 197 WeakPtr<SessionWrapper> sessionWrapper_; 198 std::mutex aliveUIExtensionMutex_; 199 std::map<int32_t, OHOS::Ace::WeakPtr<UIExtensionPattern>> aliveUIExtensions_; 200 std::map<int32_t, OHOS::Ace::WeakPtr<SecurityUIExtensionPattern>> aliveSecurityUIExtensions_; 201 std::map<UIContentBusinessCode, 202 std::tuple<BusinessDataSendType, UIExtBusinessDataSendCallback, RSSubsystemId>> businessDataSendCallbacks_; 203 std::map<UIContentBusinessCode, UIExtBusinessDataConsumeCallback> businessDataConsumeCallbacks_; 204 std::map<UIContentBusinessCode, UIExtBusinessDataConsumeReplyCallback> businessDataConsumeReplyCallbacks_; 205 UIExtBusinessSendToHostReplyFunc businessSendToHostReplyFunc_; 206 UIExtBusinessSendToHostFunc businessSendToHostFunc_; 207 SingleHandTransformChangedCallbackMap singleHandTransformChangedCallbackMap_; 208 209 int32_t instanceId_ = -1; 210 WeakPtr<PipelineContext> pipeline_; 211 bool hasRegisterListener_ = false; 212 int32_t containerModalListenerId_ = -1; 213 }; 214 } // namespace OHOS::Ace::NG 215 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERN_UI_EXTENSION_UI_EXTENSION_MANAGER_H 216