1 /* 2 * Copyright (c) 2021 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 RUNTIME_CONTEXT_H 17 #define RUNTIME_CONTEXT_H 18 19 #include <cstdint> 20 #include <functional> 21 #include <string> 22 23 #include "auto_launch.h" 24 #include "auto_launch_export.h" 25 #include "cloud/icloud_data_translate.h" 26 #include "db_info_handle.h" 27 #include "icommunicator_aggregator.h" 28 #include "iprocess_system_api_adapter.h" 29 #include "ithread_pool.h" 30 #include "kv_store_observer.h" 31 #include "kvdb_properties.h" 32 #include "macro_utils.h" 33 #include "notification_chain.h" 34 #include "query_sync_object.h" 35 #include "types_export.h" 36 37 namespace DistributedDB { 38 using TimerId = uint64_t; 39 using TimerAction = std::function<int(TimerId timerId)>; 40 using TimerFinalizer = std::function<void(void)>; 41 using TaskAction = std::function<void(void)>; 42 using TimeChangedAction = std::function<void(void *)>; 43 using TimeFinalizeAction = std::function<void(void)>; 44 using LockStatusNotifier = std::function<void(void *isLocked)>; 45 using UserChangedAction = std::function<void(void *)>; 46 47 class RuntimeContext { 48 public: 49 DISABLE_COPY_ASSIGN_MOVE(RuntimeContext); 50 51 // Global setting interfaces. 52 virtual void SetProcessLabel(const std::string &label) = 0; 53 virtual std::string GetProcessLabel() const = 0; 54 55 // If the pre adapter is not nullptr, set new adapter will release the pre adapter, 56 // must be called after SetCommunicatorAggregator 57 virtual int SetCommunicatorAdapter(IAdapter *adapter) = 0; 58 virtual int GetCommunicatorAggregator(ICommunicatorAggregator *&outAggregator) = 0; 59 virtual void SetCommunicatorAggregator(ICommunicatorAggregator *inAggregator) = 0; 60 virtual int GetLocalIdentity(std::string &outTarget) = 0; 61 62 // Timer interfaces. 63 virtual int SetTimer(int milliSeconds, const TimerAction &action, 64 const TimerFinalizer &finalizer, TimerId &timerId) = 0; 65 virtual int ModifyTimer(TimerId timerId, int milliSeconds) = 0; 66 virtual void RemoveTimer(TimerId timerId, bool wait = false) = 0; 67 68 // Task interfaces. 69 virtual int ScheduleTask(const TaskAction &task) = 0; 70 virtual int ScheduleQueuedTask(const std::string &queueTag, 71 const TaskAction &task) = 0; 72 73 // Shrink as much memory as possible. 74 virtual void ShrinkMemory(const std::string &description) = 0; 75 76 // Register a time changed lister, it will be callback when local time changed. 77 virtual NotificationChain::Listener *RegisterTimeChangedLister(const TimeChangedAction &action, 78 const TimeFinalizeAction &finalize, int &errCode) = 0; 79 80 // Get the global context object(singleton), never return nullptr. 81 static RuntimeContext *GetInstance(); 82 83 virtual int SetPermissionCheckCallback(const PermissionCheckCallback &callback) = 0; 84 85 virtual int SetPermissionCheckCallback(const PermissionCheckCallbackV2 &callback) = 0; 86 87 virtual int SetPermissionCheckCallback(const PermissionCheckCallbackV3 &callback) = 0; 88 89 virtual int RunPermissionCheck(const PermissionCheckParam ¶m, uint8_t flag) const = 0; 90 91 virtual int EnableKvStoreAutoLaunch(const KvDBProperties &properties, AutoLaunchNotifier notifier, 92 const AutoLaunchOption &option) = 0; 93 94 virtual int DisableKvStoreAutoLaunch(const std::string &normalIdentifier, const std::string &dualTupleIdentifier, 95 const std::string &userId) = 0; 96 97 virtual void GetAutoLaunchSyncDevices(const std::string &identifier, std::vector<std::string> &devices) const = 0; 98 99 virtual void SetAutoLaunchRequestCallback(const AutoLaunchRequestCallback &callback, DBTypeInner type) = 0; 100 101 virtual NotificationChain::Listener *RegisterLockStatusLister(const LockStatusNotifier &action, int &errCode) = 0; 102 103 virtual bool IsAccessControlled() const = 0; 104 105 virtual int SetSecurityOption(const std::string &filePath, const SecurityOption &option) const = 0; 106 107 virtual int GetSecurityOption(const std::string &filePath, SecurityOption &option) const = 0; 108 109 virtual bool CheckDeviceSecurityAbility(const std::string &devId, const SecurityOption &option) const = 0; 110 111 virtual int SetProcessSystemApiAdapter(const std::shared_ptr<IProcessSystemApiAdapter> &adapter) = 0; 112 113 virtual bool IsProcessSystemApiAdapterValid() const = 0; 114 115 virtual bool IsCommunicatorAggregatorValid() const = 0; 116 117 // Notify TIME_CHANGE_EVENT. 118 virtual void NotifyTimestampChanged(TimeOffset offset) const = 0; 119 120 virtual void SetStoreStatusNotifier(const StoreStatusNotifier ¬ifier) = 0; 121 122 virtual void NotifyDatabaseStatusChange(const std::string &userId, const std::string &appId, 123 const std::string &storeId, const std::string &deviceId, bool onlineStatus) = 0; 124 125 virtual int SetSyncActivationCheckCallback(const SyncActivationCheckCallback &callback) = 0; 126 127 virtual int SetSyncActivationCheckCallback(const SyncActivationCheckCallbackV2 &callback) = 0; 128 129 virtual bool IsSyncerNeedActive(const DBProperties &properties) const = 0; 130 131 virtual NotificationChain::Listener *RegisterUserChangedListener(const UserChangedAction &action, 132 EventType event) = 0; 133 134 virtual int NotifyUserChanged() const = 0; 135 136 // Generate global sessionId in current process 137 virtual uint32_t GenerateSessionId() = 0; 138 139 virtual void DumpCommonInfo(int fd) = 0; 140 141 virtual void CloseAutoLaunchConnection(DBTypeInner type, const DBProperties &properties) = 0; 142 143 virtual int SetPermissionConditionCallback(const PermissionConditionCallback &callback) = 0; 144 145 virtual std::map<std::string, std::string> GetPermissionCheckParam(const DBProperties &properties) = 0; 146 147 virtual void StopTaskPool() = 0; 148 149 virtual void StopTimeTickMonitorIfNeed() = 0; 150 151 virtual void SetDBInfoHandle(const std::shared_ptr<DBInfoHandle> &handle) = 0; 152 153 virtual void NotifyDBInfos(const DeviceInfos &devInfos, const std::vector<DBInfo> &dbInfos) = 0; 154 155 virtual void RecordRemoteSubscribe(const DBInfo &dbInfo, const DeviceID &deviceId, 156 const QuerySyncObject &query) = 0; 157 158 virtual void RemoveRemoteSubscribe(const DeviceID &deviceId) = 0; 159 160 virtual void RemoveRemoteSubscribe(const DBInfo &dbInfo) = 0; 161 162 virtual void RemoveRemoteSubscribe(const DBInfo &dbInfo, const DeviceID &deviceId) = 0; 163 164 virtual void RemoveRemoteSubscribe(const DBInfo &dbInfo, const DeviceID &deviceId, 165 const QuerySyncObject &query) = 0; 166 167 virtual void GetSubscribeQuery(const DBInfo &dbInfo, 168 std::map<std::string, std::vector<QuerySyncObject>> &subscribeQuery) = 0; 169 170 virtual bool IsNeedAutoSync(const std::string &userId, const std::string &appId, const std::string &storeId, 171 const std::string &devInfo) = 0; 172 173 virtual void SetRemoteOptimizeCommunication(const std::string &dev, bool optimize) = 0; 174 175 virtual void SetTranslateToDeviceIdCallback(const TranslateToDeviceIdCallback &callback) = 0; 176 177 virtual int TranslateDeviceId(const std::string &deviceId, 178 const StoreInfo &info, std::string &newDeviceId) = 0; 179 180 virtual bool ExistTranslateDevIdCallback() const = 0; 181 182 virtual void SetThreadPool(const std::shared_ptr<IThreadPool> &threadPool) = 0; 183 184 virtual std::shared_ptr<IThreadPool> GetThreadPool() const = 0; 185 186 virtual void SetCloudTranslate(const std::shared_ptr<ICloudDataTranslate> &dataTranslate) = 0; 187 virtual int AssetToBlob(const Asset &asset, std::vector<uint8_t> &blob) = 0; 188 virtual int AssetsToBlob(const Assets &assets, std::vector<uint8_t> &blob) = 0; 189 virtual int BlobToAsset(const std::vector<uint8_t> &blob, Asset &asset) = 0; 190 virtual int BlobToAssets(const std::vector<uint8_t> &blob, Assets &assets) = 0; 191 192 virtual std::pair<int, DeviceTimeInfo> GetDeviceTimeInfo(const std::string &device) const = 0; 193 virtual void SetDeviceTimeInfo(const std::string &device, const DeviceTimeInfo &deviceTimeInfo) = 0; 194 virtual void ClearDeviceTimeInfo(const std::string &device) = 0; 195 virtual void ClearAllDeviceTimeInfo() = 0; 196 virtual void RecordAllTimeChange() = 0; 197 virtual void ResetDBTimeChangeStatus(const std::vector<uint8_t> &dbId) = 0; 198 virtual bool CheckDBTimeChange(const std::vector<uint8_t> &dbId) = 0; 199 virtual bool IsTimeTickMonitorValid() const = 0; 200 virtual bool IsTimeChanged() const = 0; 201 virtual void SetTimeChanged(bool timeChange) = 0; 202 protected: 203 RuntimeContext() = default; ~RuntimeContext()204 virtual ~RuntimeContext() {} 205 }; 206 } // namespace DistributedDB 207 208 #endif // RUNTIME_CONTEXT_H 209