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     void AddRenderDeathRecipient(const sptr<IRemoteObject> &renderRemoteObj);
60 
61     void RerenderAllForms();
62 
63     void CleanFormHost(const sptr<IRemoteObject> &host);
64 
65     void OnRenderingBlock(const std::string &bundleName);
66 
67     ErrCode ReleaseRenderer(int64_t formId, const FormRecord &formRecord, const std::string &compId);
68 
69     void PostOnUnlockTask();
70 
71     void NotifyScreenOn();
72 
73     int32_t GetReRenderCount() const;
74 
75     sptr<IFormRender> GetRenderRemoteObj() const;
76 
77     void SetRenderRemoteObj(sptr<IFormRender> remoteObject);
78 
79     ErrCode RecycleForms(const std::vector<int64_t> &formIds, const Want &want,
80         const sptr<IRemoteObject> &remoteObjectOfHost);
81 
82     ErrCode RecoverForms(const std::vector<int64_t> &formIds, const WantParams &wantParams);
83 
84     void SetUserId(int32_t userId);
85 
86     int32_t GetUserId() const;
87 
88     void RerenderAllFormsImmediate();
89 
90     void DisconnectAllRenderConnections();
91 private:
92     ErrCode ConnectRenderService(const sptr<FormRenderConnection> &connection, int32_t level) const;
93 
94     void DisconnectRenderService(const sptr<FormRenderConnection> connection, size_t size) const;
95 
96     void AddHostToken(const sptr<IRemoteObject> &host, int64_t formId);
97 
98     void RemoveHostToken(const sptr<IRemoteObject> &host);
99 
100     void NotifyHostRenderServiceIsDead() const;
101 
102     void FillBundleInfo(Want &want, const std::string &bundleName) const;
103 
104     void CheckIfFormRecycled(FormRecord &formRecord, Want& want) const;
105 
106     ErrCode GetConnectionAndRenderForm(FormRecord &formRecord, Want &want);
107 
108     ErrCode GetRenderObject(sptr<IRemoteObject> &renderObj);
109 
110 private:
111     class RemoteObjHash {
112     public:
operator ()(const sptr<IRemoteObject> &remoteObj) const113         size_t operator() (const sptr<IRemoteObject> &remoteObj) const
114         {
115             return reinterpret_cast<size_t>(remoteObj.GetRefPtr());
116         }
117     };
118 
119     mutable std::mutex resourceMutex_;
120     mutable std::shared_mutex renderRemoteObjMutex_;
121     // <formId, connectionToRenderService>
122     std::unordered_map<int64_t, sptr<FormRenderConnection>> renderFormConnections_;
123     // <hostToken, formIds>
124     std::unordered_map<sptr<IRemoteObject>, std::unordered_set<int64_t>, RemoteObjHash> etsHosts_;
125     sptr<IFormRender> renderRemoteObj_ = nullptr;
126     sptr<IRemoteObject::DeathRecipient> renderDeathRecipient_ = nullptr;
127     std::atomic<int32_t> atomicRerenderCount_ = 0;
128     // userId_ is Active User
129     bool isActiveUser_ = true;
130     int32_t userId_ = 0;
131 };
132 
133 /**
134  * @class FormRenderRecipient
135  * FormRenderRecipient notices IRemoteBroker died.
136  */
137 class FormRenderRecipient : public IRemoteObject::DeathRecipient {
138 public:
139     using RemoteDiedHandler = std::function<void()>;
140 
141     explicit FormRenderRecipient(RemoteDiedHandler handler);
142 
143     virtual ~FormRenderRecipient();
144 
145     void OnRemoteDied(const wptr<IRemoteObject> &remote) override;
146 
147 private:
148     RemoteDiedHandler handler_;
149 };
150 } // namespace AppExecFwk
151 } // namespace OHOS
152 #endif // OHOS_FORM_FWK_FORM_RENDER_MGR_INNER_H
153