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 OHOS_FORM_FWK_FORM_RENDER_MGR_INNER_H
17 #define OHOS_FORM_FWK_FORM_RENDER_MGR_INNER_H
18 
19 #include <atomic>
20 #include <queue>
21 #include <shared_mutex>
22 #include <unordered_map>
23 
24 #include "form_record.h"
25 #include "form_render_connection.h"
26 #include "form_render_interface.h"
27 #include "want.h"
28 
29 namespace OHOS {
30 namespace AppExecFwk {
31 using Want = OHOS::AAFwk::Want;
32 using WantParams = OHOS::AAFwk::WantParams;
33 /**
34  * @class FormRenderMgrInner
35  * FormRenderMgrInner provides a facility for managing form render life cycle.
36  */
37 class FormRenderMgrInner {
38 public:
39     FormRenderMgrInner();
40     virtual ~FormRenderMgrInner();
41 
42     virtual ErrCode RenderForm(
43         const FormRecord &formRecord, Want &want, const sptr<IRemoteObject> &hostToken = nullptr);
44 
45     ErrCode UpdateRenderingForm(FormRecord &formRecord, const FormProviderData &formProviderData,
46         const WantParams &wantParams, bool mergeData);
47 
48     ErrCode StopRenderingForm(int64_t formId, const FormRecord &formRecord,
49         const std::string &compId = "", const sptr<IRemoteObject> &hostToken = nullptr);
50 
51     ErrCode ReloadForm(const std::vector<FormRecord> &&formRecords, const std::string &bundleName, int32_t userId);
52 
53     ErrCode StopRenderingFormCallback(int64_t formId, const Want &want);
54 
55     ErrCode AddConnection(int64_t formId, sptr<FormRenderConnection> connection);
56 
57     void RemoveConnection(int64_t formId);
58 
59     ErrCode checkConnectionsFormIds(std::vector<int64_t> formIds, std::vector<int64_t> &needconFormIds);
60 
61     void AddRenderDeathRecipient(const sptr<IRemoteObject> &renderRemoteObj);
62 
63     void RerenderAllForms();
64 
65     void CleanFormHost(const sptr<IRemoteObject> &host);
66 
67     void OnRenderingBlock(const std::string &bundleName);
68 
69     ErrCode ReleaseRenderer(int64_t formId, const FormRecord &formRecord, const std::string &compId);
70 
71     void PostOnUnlockTask();
72 
73     void NotifyScreenOn();
74 
75     void PostSetVisibleChangeTask(int64_t formId, bool isVisible);
76 
77     int32_t GetReRenderCount() const;
78 
79     sptr<IFormRender> GetRenderRemoteObj() const;
80 
81     void SetRenderRemoteObj(sptr<IFormRender> remoteObject);
82 
83     ErrCode RecycleForms(const std::vector<int64_t> &formIds, const Want &want,
84         const sptr<IRemoteObject> &remoteObjectOfHost);
85 
86     ErrCode RecoverForms(const std::vector<int64_t> &formIds, const WantParams &wantParams);
87 
88     ErrCode UpdateFormSize(const int64_t &formId, float width, float height, float borderWidth);
89 
90     void SetUserId(int32_t userId);
91 
92     int32_t GetUserId() const;
93 
94     void RerenderAllFormsImmediate();
95 
96     void DisconnectAllRenderConnections();
97 private:
98     ErrCode ConnectRenderService(const sptr<FormRenderConnection> &connection, int32_t level) const;
99 
100     void DisconnectRenderService(const sptr<FormRenderConnection> connection, size_t size) const;
101 
102     void AddHostToken(const sptr<IRemoteObject> &host, int64_t formId);
103 
104     void RemoveHostToken(const sptr<IRemoteObject> &host);
105 
106     void NotifyHostRenderServiceIsDead() const;
107 
108     void FillBundleInfo(Want &want, const std::string &bundleName) const;
109 
110     void CheckIfFormRecycled(FormRecord &formRecord, Want& want) const;
111 
112     ErrCode GetConnectionAndRenderForm(FormRecord &formRecord, Want &want);
113 
114     ErrCode GetRenderObject(sptr<IRemoteObject> &renderObj);
115 
116 private:
117     class RemoteObjHash {
118     public:
operator()119         size_t operator() (const sptr<IRemoteObject> &remoteObj) const
120         {
121             return reinterpret_cast<size_t>(remoteObj.GetRefPtr());
122         }
123     };
124 
125     mutable std::mutex resourceMutex_;
126     mutable std::shared_mutex renderRemoteObjMutex_;
127     // <formId, connectionToRenderService>
128     std::unordered_map<int64_t, sptr<FormRenderConnection>> renderFormConnections_;
129     // <hostToken, formIds>
130     std::unordered_map<sptr<IRemoteObject>, std::unordered_set<int64_t>, RemoteObjHash> etsHosts_;
131     sptr<IFormRender> renderRemoteObj_ = nullptr;
132     sptr<IRemoteObject::DeathRecipient> renderDeathRecipient_ = nullptr;
133     std::atomic<int32_t> atomicRerenderCount_ = 0;
134     // userId_ is Active User
135     bool isActiveUser_ = true;
136     int32_t userId_ = 0;
137 };
138 
139 /**
140  * @class FormRenderRecipient
141  * FormRenderRecipient notices IRemoteBroker died.
142  */
143 class FormRenderRecipient : public IRemoteObject::DeathRecipient {
144 public:
145     using RemoteDiedHandler = std::function<void()>;
146 
147     explicit FormRenderRecipient(RemoteDiedHandler handler);
148 
149     virtual ~FormRenderRecipient();
150 
151     void OnRemoteDied(const wptr<IRemoteObject> &remote) override;
152 
153 private:
154     RemoteDiedHandler handler_;
155 };
156 } // namespace AppExecFwk
157 } // namespace OHOS
158 #endif // OHOS_FORM_FWK_FORM_RENDER_MGR_INNER_H
159