1 /*
2 * Copyright (c) 2022-2024 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 "want_agent_client.h"
17
18 #include "ability_runtime_error_util.h"
19 #include "ability_manager_errors.h"
20 #include "ability_manager_interface.h"
21 #include "ability_util.h"
22 #include "hilog_tag_wrapper.h"
23 #include "hitrace_meter.h"
24 #include "if_system_ability_manager.h"
25 #include "iservice_registry.h"
26 #include "system_ability_definition.h"
27
28 using namespace OHOS::AbilityRuntime;
29 namespace OHOS {
30 namespace AAFwk {
GetInstance()31 WantAgentClient &WantAgentClient::GetInstance()
32 {
33 static WantAgentClient client;
34 return client;
35 }
36
WantAgentClient()37 WantAgentClient::WantAgentClient() {}
38
~WantAgentClient()39 WantAgentClient::~WantAgentClient() {}
40
GetWantSender(const WantSenderInfo & wantSenderInfo,const sptr<IRemoteObject> & callerToken,sptr<IWantSender> & wantSender,int32_t uid)41 ErrCode WantAgentClient::GetWantSender(
42 const WantSenderInfo &wantSenderInfo, const sptr<IRemoteObject> &callerToken, sptr<IWantSender> &wantSender,
43 int32_t uid)
44 {
45 auto abms = GetAbilityManager();
46 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
47 MessageParcel data;
48 MessageParcel reply;
49 MessageOption option;
50 if (!WriteInterfaceToken(data)) {
51 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
52 }
53 if (!data.WriteParcelable(&wantSenderInfo)) {
54 TAG_LOGE(AAFwkTag::WANTAGENT, "write failed");
55 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
56 }
57 if (callerToken) {
58 if (!data.WriteBool(true) || !data.WriteRemoteObject(callerToken)) {
59 TAG_LOGE(AAFwkTag::WANTAGENT, "flag and callerToken write failed");
60 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
61 }
62 } else {
63 if (!data.WriteBool(false)) {
64 TAG_LOGE(AAFwkTag::WANTAGENT, "flag write failed");
65 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
66 }
67 }
68
69 if (!data.WriteInt32(uid)) {
70 TAG_LOGE(AAFwkTag::ABILITYMGR, "uid write fail");
71 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
72 }
73
74 auto error = abms->SendRequest(static_cast<uint32_t>(AbilityManagerInterfaceCode::GET_PENDING_WANT_SENDER),
75 data, reply, option);
76 if (error != NO_ERROR) {
77 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT;
78 }
79 wantSender = iface_cast<IWantSender>(reply.ReadRemoteObject());
80 return ERR_OK;
81 }
82
SendWantSender(sptr<IWantSender> target,const SenderInfo & senderInfo)83 ErrCode WantAgentClient::SendWantSender(sptr<IWantSender> target, const SenderInfo &senderInfo)
84 {
85 CHECK_POINTER_AND_RETURN(target, ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT);
86 auto abms = GetAbilityManager();
87 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
88 MessageParcel data;
89 MessageParcel reply;
90 MessageOption option;
91 if (!WriteInterfaceToken(data)) {
92 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
93 }
94 if (target == nullptr || !data.WriteRemoteObject(target->AsObject())) {
95 TAG_LOGE(AAFwkTag::WANTAGENT, "target write failed");
96 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT;
97 }
98 if (!data.WriteParcelable(&senderInfo)) {
99 TAG_LOGE(AAFwkTag::WANTAGENT, "senderInfo write failed");
100 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
101 }
102
103 auto error = abms->SendRequest(static_cast<uint32_t>(AbilityManagerInterfaceCode::SEND_PENDING_WANT_SENDER),
104 data, reply, option);
105 if (error != NO_ERROR) {
106 return ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_TIMEOUT;
107 }
108 return reply.ReadInt32();
109 }
110
CancelWantSender(const sptr<IWantSender> & sender)111 ErrCode WantAgentClient::CancelWantSender(const sptr<IWantSender> &sender)
112 {
113 CHECK_POINTER_AND_RETURN(sender, ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER);
114 auto abms = GetAbilityManager();
115 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
116 ErrCode error;
117 MessageParcel reply;
118 if (!SendRequest(static_cast<int32_t>(AbilityManagerInterfaceCode::CANCEL_PENDING_WANT_SENDER),
119 abms, sender->AsObject(), reply, error)) {
120 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT;
121 }
122 return ERR_OK;
123 }
124
GetPendingWantUid(const sptr<IWantSender> & target,int32_t & uid)125 ErrCode WantAgentClient::GetPendingWantUid(const sptr<IWantSender> &target, int32_t &uid)
126 {
127 CHECK_POINTER_AND_RETURN(target, ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT);
128 auto abms = GetAbilityManager();
129 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
130 ErrCode error;
131 MessageParcel reply;
132 if (!SendRequest(static_cast<int32_t>(AbilityManagerInterfaceCode::GET_PENDING_WANT_UID),
133 abms, target->AsObject(), reply, error)) {
134 return error;
135 }
136 uid = reply.ReadInt32();
137 return ERR_OK;
138 }
139
GetPendingWantUserId(const sptr<IWantSender> & target,int32_t & userId)140 ErrCode WantAgentClient::GetPendingWantUserId(const sptr<IWantSender> &target, int32_t &userId)
141 {
142 CHECK_POINTER_AND_RETURN(target, INVALID_PARAMETERS_ERR);
143 auto abms = GetAbilityManager();
144 CHECK_POINTER_AND_RETURN(abms, ABILITY_SERVICE_NOT_CONNECTED);
145 ErrCode error;
146 MessageParcel reply;
147 if (!SendRequest(static_cast<int32_t>(AbilityManagerInterfaceCode::GET_PENDING_WANT_USERID),
148 abms, target->AsObject(), reply, error)) {
149 return error;
150 }
151 userId = reply.ReadInt32();
152 return ERR_OK;
153 }
154
GetPendingWantBundleName(const sptr<IWantSender> & target,std::string & bundleName)155 ErrCode WantAgentClient::GetPendingWantBundleName(const sptr<IWantSender> &target, std::string &bundleName)
156 {
157 CHECK_POINTER_AND_RETURN(target, ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT);
158 auto abms = GetAbilityManager();
159 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
160 ErrCode error;
161 MessageParcel reply;
162 if (!SendRequest(static_cast<int32_t>(AbilityManagerInterfaceCode::GET_PENDING_WANT_BUNDLENAME),
163 abms, target->AsObject(), reply, error)) {
164 return error;
165 }
166 bundleName = Str16ToStr8(reply.ReadString16());
167 return ERR_OK;
168 }
169
GetPendingWantCode(const sptr<IWantSender> & target,int32_t & code)170 ErrCode WantAgentClient::GetPendingWantCode(const sptr<IWantSender> &target, int32_t &code)
171 {
172 CHECK_POINTER_AND_RETURN(target, ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT);
173 auto abms = GetAbilityManager();
174 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
175 ErrCode error;
176 MessageParcel reply;
177 if (!SendRequest(static_cast<int32_t>(AbilityManagerInterfaceCode::GET_PENDING_WANT_CODE),
178 abms, target->AsObject(), reply, error)) {
179 return ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_TIMEOUT;
180 }
181 code = reply.ReadInt32();
182 return ERR_OK;
183 }
184
GetPendingWantType(sptr<IWantSender> target,int32_t & type)185 ErrCode WantAgentClient::GetPendingWantType(sptr<IWantSender> target, int32_t &type)
186 {
187 CHECK_POINTER_AND_RETURN(target, ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT);
188 auto abms = GetAbilityManager();
189 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
190 ErrCode error;
191 MessageParcel reply;
192 if (!SendRequest(static_cast<int32_t>(AbilityManagerInterfaceCode::GET_PENDING_WANT_TYPE),
193 abms, target->AsObject(), reply, error)) {
194 return ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_TIMEOUT;
195 }
196 type = reply.ReadInt32();
197 type < 0 ? type = 0 : type;
198 return ERR_OK;
199 }
200
RegisterCancelListener(const sptr<IWantSender> & sender,const sptr<IWantReceiver> & receiver)201 void WantAgentClient::RegisterCancelListener(const sptr<IWantSender> &sender, const sptr<IWantReceiver> &receiver)
202 {
203 if (!CheckSenderAndRecevier(sender, receiver)) {
204 return;
205 }
206 auto abms = GetAbilityManager();
207 if (!abms) {
208 TAG_LOGE(AAFwkTag::WANTAGENT, "ability proxy is nullptr");
209 return;
210 }
211 MessageParcel data;
212 MessageParcel reply;
213 MessageOption option;
214 if (!WriteInterfaceToken(data)) {
215 return;
216 }
217 if (!data.WriteRemoteObject(sender->AsObject())) {
218 TAG_LOGE(AAFwkTag::WANTAGENT, "sender write failed");
219 return;
220 }
221 if (!data.WriteRemoteObject(receiver->AsObject())) {
222 TAG_LOGE(AAFwkTag::WANTAGENT, "receiver write failed");
223 return;
224 }
225 auto error = abms->SendRequest(static_cast<uint32_t>(AbilityManagerInterfaceCode::REGISTER_CANCEL_LISTENER),
226 data, reply, option);
227 if (error != NO_ERROR) {
228 return;
229 }
230 }
231
UnregisterCancelListener(const sptr<IWantSender> & sender,const sptr<IWantReceiver> & receiver)232 void WantAgentClient::UnregisterCancelListener(
233 const sptr<IWantSender> &sender, const sptr<IWantReceiver> &receiver)
234 {
235 if (!CheckSenderAndRecevier(sender, receiver)) {
236 return;
237 }
238 auto abms = GetAbilityManager();
239 if (!abms) {
240 TAG_LOGE(AAFwkTag::WANTAGENT, "ability proxy is nullptr");
241 return;
242 }
243 MessageParcel data;
244 MessageParcel reply;
245 MessageOption option;
246 if (!WriteInterfaceToken(data)) {
247 return;
248 }
249 if (!data.WriteRemoteObject(sender->AsObject())) {
250 TAG_LOGE(AAFwkTag::WANTAGENT, "sender write failed");
251 return;
252 }
253 if (!data.WriteRemoteObject(receiver->AsObject())) {
254 TAG_LOGE(AAFwkTag::WANTAGENT, "receiver write failed");
255 return;
256 }
257 auto error = abms->SendRequest(static_cast<uint32_t>(AbilityManagerInterfaceCode::UNREGISTER_CANCEL_LISTENER),
258 data, reply, option);
259 if (error != NO_ERROR) {
260 return;
261 }
262 }
263
GetPendingRequestWant(const sptr<IWantSender> & target,std::shared_ptr<Want> & want)264 ErrCode WantAgentClient::GetPendingRequestWant(const sptr<IWantSender> &target, std::shared_ptr<Want> &want)
265 {
266 HITRACE_METER_NAME(HITRACE_TAG_ABILITY_MANAGER, __PRETTY_FUNCTION__);
267 CHECK_POINTER_AND_RETURN(target, ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_WANTAGENT);
268 CHECK_POINTER_AND_RETURN(want, INVALID_PARAMETERS_ERR);
269 auto abms = GetAbilityManager();
270 CHECK_POINTER_AND_RETURN(abms, ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY);
271 MessageParcel data;
272 MessageParcel reply;
273 MessageOption option;
274 if (!WriteInterfaceToken(data)) {
275 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
276 }
277
278 sptr<IRemoteObject> obj = target->AsObject();
279 if (obj == nullptr) {
280 TAG_LOGE(AAFwkTag::WANTAGENT, "Input Param target is invalid");
281 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
282 }
283
284 if (!data.WriteRemoteObject(obj)) {
285 TAG_LOGE(AAFwkTag::WANTAGENT, "target write failed");
286 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
287 }
288 if (!data.WriteParcelable(want.get())) {
289 TAG_LOGE(AAFwkTag::WANTAGENT, "want write failed");
290 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
291 }
292 auto error = abms->SendRequest(static_cast<int32_t>(AbilityManagerInterfaceCode::GET_PENDING_REQUEST_WANT),
293 data, reply, option);
294 if (error != NO_ERROR) {
295 TAG_LOGE(AAFwkTag::WANTAGENT, "Send request error: %{public}d", error);
296 return ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_TIMEOUT;
297 }
298 std::unique_ptr<Want> wantInfo(reply.ReadParcelable<Want>());
299 if (!wantInfo) {
300 TAG_LOGE(AAFwkTag::WANTAGENT, "ReadParcelable failed");
301 return ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
302 }
303 want = std::move(wantInfo);
304
305 return NO_ERROR;
306 }
307
GetWantSenderInfo(const sptr<IWantSender> & target,std::shared_ptr<WantSenderInfo> & info)308 ErrCode WantAgentClient::GetWantSenderInfo(const sptr<IWantSender> &target, std::shared_ptr<WantSenderInfo> &info)
309 {
310 CHECK_POINTER_AND_RETURN(target, INVALID_PARAMETERS_ERR);
311 CHECK_POINTER_AND_RETURN(info, INVALID_PARAMETERS_ERR);
312 auto abms = GetAbilityManager();
313 CHECK_POINTER_AND_RETURN(abms, ABILITY_SERVICE_NOT_CONNECTED);
314 MessageParcel data;
315 MessageParcel reply;
316 MessageOption option;
317 if (!WriteInterfaceToken(data)) {
318 return INNER_ERR;
319 }
320 if (!data.WriteRemoteObject(target->AsObject())) {
321 TAG_LOGE(AAFwkTag::WANTAGENT, "target write failed");
322 return INNER_ERR;
323 }
324 if (!data.WriteParcelable(info.get())) {
325 TAG_LOGE(AAFwkTag::WANTAGENT, "info write failed");
326 return INNER_ERR;
327 }
328 auto error = abms->SendRequest(static_cast<uint32_t>(AbilityManagerInterfaceCode::GET_PENDING_WANT_SENDER_INFO),
329 data, reply, option);
330 if (error != NO_ERROR) {
331 TAG_LOGE(AAFwkTag::WANTAGENT, "Send request error: %{public}d", error);
332 return error;
333 }
334 std::unique_ptr<WantSenderInfo> wantSenderInfo(reply.ReadParcelable<WantSenderInfo>());
335 if (!wantSenderInfo) {
336 TAG_LOGE(AAFwkTag::WANTAGENT, "readParcelable Info failed");
337 return INNER_ERR;
338 }
339 info = std::move(wantSenderInfo);
340
341 return NO_ERROR;
342 }
343
GetAbilityManager()344 sptr<IRemoteObject> WantAgentClient::GetAbilityManager()
345 {
346 HITRACE_METER_NAME(HITRACE_TAG_ABILITY_MANAGER, __PRETTY_FUNCTION__);
347 std::lock_guard<std::mutex> lock(mutex_);
348 if (proxy_ == nullptr) {
349 auto systemManager = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();
350 if (systemManager == nullptr) {
351 TAG_LOGE(AAFwkTag::WANTAGENT, "Fail to get registry");
352 return nullptr;
353 }
354 auto remoteObj = systemManager->GetSystemAbility(ABILITY_MGR_SERVICE_ID);
355 if (remoteObj == nullptr) {
356 TAG_LOGE(AAFwkTag::WANTAGENT, "Fail to connect ability manager service");
357 return nullptr;
358 }
359
360 deathRecipient_ = sptr<IRemoteObject::DeathRecipient>(new (std::nothrow) WantAgentDeathRecipient());
361 if (deathRecipient_ == nullptr) {
362 TAG_LOGE(AAFwkTag::WANTAGENT, "Failed to create DeathRecipient");
363 return nullptr;
364 }
365 if (!remoteObj->AddDeathRecipient(deathRecipient_)) {
366 TAG_LOGE(AAFwkTag::WANTAGENT, "Add death recipient to failed");
367 }
368 proxy_ = remoteObj;
369 }
370
371 return proxy_;
372 }
373
OnRemoteDied(const wptr<IRemoteObject> & remote)374 void WantAgentClient::WantAgentDeathRecipient::OnRemoteDied(const wptr<IRemoteObject>& remote)
375 {
376 TAG_LOGI(AAFwkTag::WANTAGENT, "call");
377 WantAgentClient::GetInstance().ResetProxy(remote);
378 }
379
ResetProxy(const wptr<IRemoteObject> & remote)380 void WantAgentClient::ResetProxy(const wptr<IRemoteObject>& remote)
381 {
382 std::lock_guard<std::mutex> lock(mutex_);
383 if (!proxy_) {
384 return;
385 }
386 if (proxy_ == remote.promote()) {
387 proxy_->RemoveDeathRecipient(deathRecipient_);
388 }
389 proxy_ = nullptr;
390 }
391
WriteInterfaceToken(MessageParcel & data)392 bool WantAgentClient::WriteInterfaceToken(MessageParcel &data)
393 {
394 if (!data.WriteInterfaceToken(IAbilityManager::GetDescriptor())) {
395 TAG_LOGE(AAFwkTag::WANTAGENT, "write interface token failed");
396 return false;
397 }
398 return true;
399 }
400
CheckSenderAndRecevier(const sptr<IWantSender> & sender,const sptr<IWantReceiver> & receiver)401 bool WantAgentClient::CheckSenderAndRecevier(const sptr<IWantSender> &sender, const sptr<IWantReceiver> &receiver)
402 {
403 if (sender == nullptr) {
404 TAG_LOGE(AAFwkTag::WANTAGENT, "sender is nullptr");
405 return false;
406 }
407 if (receiver == nullptr) {
408 TAG_LOGE(AAFwkTag::WANTAGENT, "receiver is nullptr");
409 return false;
410 }
411
412 return true;
413 }
414
SendRequest(int32_t operation,const sptr<IRemoteObject> & abms,const sptr<IRemoteObject> & remoteObject,MessageParcel & reply,ErrCode & error)415 bool WantAgentClient::SendRequest(int32_t operation, const sptr<IRemoteObject> &abms,
416 const sptr<IRemoteObject> &remoteObject, MessageParcel &reply, ErrCode &error)
417 {
418 MessageParcel data;
419 MessageOption option;
420 if (!WriteInterfaceToken(data)) {
421 error = ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
422 return false;
423 }
424 if (!data.WriteRemoteObject(remoteObject)) {
425 TAG_LOGE(AAFwkTag::WANTAGENT, "write failed");
426 error = ERR_ABILITY_RUNTIME_EXTERNAL_INVALID_PARAMETER;
427 return false;
428 }
429 error = abms->SendRequest(operation, data, reply, option);
430 if (error != NO_ERROR) {
431 error = ERR_ABILITY_RUNTIME_EXTERNAL_SERVICE_BUSY;
432 return false;
433 }
434
435 return true;
436 }
437 } // namespace AAFwk
438 } // namespace OHOS
439