* Copyright (c) 2022-2025 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef OHOS_ABILITY_RUNTIME_FREE_INSTALL_MANAGER_H
#define OHOS_ABILITY_RUNTIME_FREE_INSTALL_MANAGER_H
#include <future>
#include "cpp/mutex.h"
#include <iremote_object.h>
#include <iremote_stub.h>
#include <memory>
#include "ability_info.h"
#include "free_install_observer_manager.h"
#include "start_options.h"
#include "want.h"
namespace OHOS {
namespace AAFwk {
struct FreeInstallInfo {
std::shared_ptr<std::promise<int32_t>> promise;
std::string identity;
sptr<IRemoteObject> callerToken = nullptr;
sptr<IRemoteObject> dmsCallback = nullptr;
std::shared_ptr<Want> originalWant = nullptr;
std::shared_ptr<StartOptions> startOptions = nullptr;
Want want;
int32_t userId = -1;
int32_t requestCode = -1;
uint32_t specifyTokenId = 0;
int resultCode = 0;
bool isInstalled = false;
bool isPreStartMissionCalled = false;
bool isStartUIAbilityBySCBCalled = false;
bool isFreeInstallFinished = false;
bool isOpenAtomicServiceShortUrl = false;
bool isFreeInstallFromService = false;
};
struct FreeInstallParams {
std::shared_ptr<Want> originalWant = nullptr;
std::shared_ptr<StartOptions> startOptions = nullptr;
uint32_t specifyTokenId = 0;
bool isAsync = false;
bool isOpenAtomicServiceShortUrl = false;
bool skipStartFreeInstallPermissionCheck = false;
};
* @class FreeInstallManager
* FreeInstallManager.
*/
class FreeInstallManager : public std::enable_shared_from_this<FreeInstallManager> {
public:
explicit FreeInstallManager();
virtual ~FreeInstallManager() = default;
* OnInstallFinished, StartFreeInstall is complete.
*
* @param resultCode, ERR_OK on success, others on failure.
* @param want, installed ability.
* @param userId, user`s id.
*/
void OnInstallFinished(int32_t recordId, int resultCode, const Want &want, int32_t userId, bool isAsync = false);
* OnRemoteInstallFinished, DMS has finished.
*
* @param resultCode, ERR_OK on success, others on failure.
* @param want, installed ability.
* @param userId, user`s id.
*/
void OnRemoteInstallFinished(int32_t recordId, int resultCode, const Want &want, int32_t userId);
* Start to free install.
*
* @param want, the want of the ability to free install.
* @param userId, designation User ID.
* @param requestCode, ability request code.
* @param callerToken, caller ability token.
* @param isAsync, the request is async.
* @param isOpenAtomicServiceShortUrl, the flag of open atomic service short url.
* @return Returns ERR_OK on success, others on failure.
*/
int StartFreeInstall(const Want &want, int32_t userId, int requestCode, sptr<IRemoteObject> callerToken,
std::shared_ptr<FreeInstallParams> param = nullptr);
* Start to remote free install.
*
* @param want, the want of the ability to free install.
* @param requestCode, ability request code.
* @param validUserId, designation User ID.
* @param callerToken, caller ability token.
* @return Returns ERR_OK on success, others on failure.
*/
int StartRemoteFreeInstall(Want &want, int requestCode, int32_t validUserId,
sptr<IRemoteObject> callerToken);
* Start to free install from another devices.
* The request is send from DMS.
*
* @param want, the want of the ability to free install.
* @param callback, used to notify caller the result of free install.
* @param userId, designation User ID.
* @param requestCode, ability request code.
* @return Returns ERR_OK on success, others on failure.
*/
int FreeInstallAbilityFromRemote(const Want &want, sptr<IRemoteObject> callback,
int32_t userId, int requestCode);
* Connect if the request is free install.
* @param want, the want of the ability to free install.
* @param userId, designation User ID.
* @param callerToken, caller ability token.
* @param localDeviceId, the device id of local.
* @return Returns ERR_OK on success, others on failure.
*/
int ConnectFreeInstall(const Want &want, int32_t userId, sptr<IRemoteObject> callerToken,
const std::string &localDeviceId, AppExecFwk::ExtensionAbilityType extensionType);
* Add an observer from application into freeInstallObserverManager.
* @param observer, the observer of the ability to free install.
* @return Returns ERR_OK on success, others on failure.
*/
int AddFreeInstallObserver(sptr<IRemoteObject> callerToken, sptr<AbilityRuntime::IFreeInstallObserver> observer);
* Get free install task info.
*
* @param bundleName, the bundle name of the task.
* @param abilityName, the ability name of the task.
* @param startTime, the start time of the task.
* @param taskInfo, the found task info
* @return Returns true on success, false on failure.
*/
bool GetFreeInstallTaskInfo(const std::string& bundleName, const std::string& abilityName,
const std::string& startTime, FreeInstallInfo& taskInfo);
* Get free install task info.
*
* @param sessionId, the sessionId of the task.
* @param taskInfo, the found task info
* @return Returns true on success, false on failure.
*/
bool GetFreeInstallTaskInfo(const std::string& sessionId, FreeInstallInfo& taskInfo);
* Set the isStartUIAbilityBySCBCalled flag of the given free install task.
*
* @param bundleName, the bundle name of the task.
* @param abilityName, the abilitu name of the task.
* @param startTime, the start time of the task.
* @param scbCallStatus, the status of whether StartUIAbilityBySCB is called.
*/
void SetSCBCallStatus(const std::string& bundleName, const std::string& abilityName,
const std::string& startTime, bool scbCallStatus);
* Set the isPreStartMissionCalled flag of the given free install task.
*
* @param bundleName, the bundle name of the task.
* @param abilityName, the abilitu name of the task.
* @param startTime, the start time of the task.
* @param preStartMissionCallStatus, the status of whether PreStartMission is called.
*/
void SetPreStartMissionCallStatus(const std::string& bundleName, const std::string& abilityName,
const std::string& startTime, bool preStartMissionCallStatus);
* Set the sessionId of the given free install task.
*
* @param bundleName, the bundle name of the task.
* @param abilityName, the abilitu name of the task.
* @param startTime, the start time of the task.
* @param sessionId, the sessionId of the free install task.
*/
void SetFreeInstallTaskSessionId(const std::string& bundleName, const std::string& abilityName,
const std::string& startTime, const std::string& sessionId);
private:
std::vector<FreeInstallInfo> freeInstallList_;
std::vector<FreeInstallInfo> dmsFreeInstallCbs_;
std::map<std::string, std::time_t> timestampMap_;
ffrt::mutex distributedFreeInstallLock_;
ffrt::mutex freeInstallListLock_;
ffrt::mutex timestampMapLock_;
int SetAppRunningState(Want &want);
* Start remote free install.
*
* @param want, the want of the ability to remote free install.
* @param userId, designation User ID.
* @param requestCode, ability request code.
* @param callerToken, caller ability token.
* @return Returns ERR_OK on success, others on failure.
*/
int RemoteFreeInstall(const Want &want, int32_t userId, int requestCode, sptr<IRemoteObject> callerToken);
void NotifyDmsCallback(const Want &want, int resultCode);
bool IsTopAbility(sptr<IRemoteObject> callerToken);
void NotifyFreeInstallResult(int32_t recordId, const Want &want, int resultCode, bool isAsync = false);
FreeInstallInfo BuildFreeInstallInfo(const Want &want, int32_t userId, int requestCode,
sptr<IRemoteObject> callerToken, std::shared_ptr<FreeInstallParams> param = nullptr);
void RemoveFreeInstallInfo(const std::string &bundleName, const std::string &abilityName,
const std::string &startTime);
void PostUpgradeAtomicServiceTask(int resultCode, const Want &want, int32_t userId);
void StartAbilityByFreeInstall(FreeInstallInfo &info, const std::string &bundleName,
const std::string &abilityName, const std::string &startTime);
void StartAbilityByPreInstall(int32_t recordId, FreeInstallInfo &info, const std::string &bundleName,
const std::string &abilityName, const std::string &startTime);
int32_t UpdateElementName(Want &want, int32_t userId) const;
void HandleFreeInstallResult(int32_t recordId, FreeInstallInfo &freeInstallInfo, int resultCode, bool isAsync);
void HandleOnFreeInstallSuccess(int32_t recordId, FreeInstallInfo &freeInstallInfo, bool isAsync);
void HandleOnFreeInstallFail(int32_t recordId, FreeInstallInfo &freeInstallInfo, int resultCode, bool isAsync);
void StartAbilityByConvertedWant(FreeInstallInfo &info, const std::string &startTime);
void StartAbilityByOriginalWant(FreeInstallInfo &info, const std::string &startTime);
bool VerifyStartFreeInstallPermission(sptr<IRemoteObject> callerToken);
int32_t GetRecordIdByToken(sptr<IRemoteObject> callerToken);
void NotifyInsightIntentFreeInstallResult(const Want &want, int resultCode);
void NotifyInsightIntentExecuteDone(const Want &want, int resultCode);
};
}
}
#endif
