1 /*
2  * Copyright (c) 2022 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 #ifndef SINGLE_VER_DATA_SYNC_UTIL_H
16 #define SINGLE_VER_DATA_SYNC_UTIL_H
17 
18 #include "message.h"
19 #include "single_ver_data_packet.h"
20 #include "single_ver_sync_task_context.h"
21 namespace DistributedDB {
22 class SingleVerDataSyncUtils {
23 public:
24     static int QuerySyncCheck(const SingleVerSyncTaskContext *context, bool &isCheckStatus);
25 
26     static int AckMsgErrnoCheck(const SingleVerSyncTaskContext *context, const Message *message);
27 
28     static int RequestQueryCheck(const DataRequestPacket *packet, SyncGenericInterface *storage);
29 
30     static bool IsPermitLocalDeviceRecvData(const std::string &deviceId, const SecurityOption &remoteSecOption);
31 
32     static bool IsPermitRemoteDeviceRecvData(const std::string &deviceId, const SecurityOption &remoteSecOption,
33         SyncGenericInterface *storage);
34 
35     static void TransDbDataItemToSendDataItem(const std::string &localHashName,
36         std::vector<SendDataItem> &outData);
37 
38     static std::string TransferForeignOrigDevName(const std::string &deviceName, const std::string &localHashName);
39 
40     static void TransSendDataItemToLocal(const SingleVerSyncTaskContext *context,
41         const std::string &localHashName, const std::vector<SendDataItem> &data);
42 
43     static void TranslateErrCodeIfNeed(int mode, uint32_t version, int &errCode);
44 
45     static int RunPermissionCheck(SingleVerSyncTaskContext *context, const SyncGenericInterface* storage,
46         const std::string &label, const DataRequestPacket *packet);
47 
48     static int RunPermissionCheck(SingleVerSyncTaskContext *context, const SyncGenericInterface* storage,
49         const std::string &label, int mode);
50 
51     static bool CheckPermitReceiveData(const SingleVerSyncTaskContext *context, const ICommunicator *communicator,
52         const SyncGenericInterface *storage);
53 
54     static void SetPacketId(DataRequestPacket *packet, SingleVerSyncTaskContext *context, uint32_t version);
55 
56     static int GetMessageId(SyncType syncType);
57 
58     static void PushAndPullKeyRevokHandle(SingleVerSyncTaskContext *context);
59 
60     static int GetReSendMode(int mode, uint32_t sequenceId, SyncType syncType);
61 
62     static void FillControlRequestPacket(ControlRequestPacket *packet, SingleVerSyncTaskContext *context);
63 
64     static ControlCmdType GetControlCmdType(int mode);
65 
66     static int GetModeByControlCmdType(ControlCmdType controlCmd);
67 
68     static bool IsNeedTriggerQueryAutoSync(Message *inMsg, QuerySyncObject &query);
69 
70     static void ControlAckErrorHandle(const SingleVerSyncTaskContext *context,
71         const std::shared_ptr<SubscribeManager> &subManager);
72 
73     static void SetMessageHeadInfo(Message &message, uint16_t inMsgType,
74         const std::string &inTarget, uint32_t inSequenceId, uint32_t inSessionId);
75 
76     static bool IsGetDataSuccessfully(int errCode);
77 
78     static Timestamp GetMaxSendDataTime(const std::vector<SendDataItem> &inData);
79 
80     static SyncTimeRange GetFullSyncDataTimeRange(const std::vector<SendDataItem> &inData, WaterMark localMark,
81         UpdateWaterMark &isUpdate);
82 
83     static SyncTimeRange GetQuerySyncDataTimeRange(const std::vector<SendDataItem> &inData, WaterMark localMark,
84         WaterMark deleteLocalMark, UpdateWaterMark &isUpdate);
85 
86     static SyncTimeRange ReviseLocalMark(SyncType syncType, const SyncTimeRange &dataTimeRange,
87         UpdateWaterMark updateMark);
88 
89     static SyncTimeRange GetRecvDataTimeRange(SyncType syncType,
90         const std::vector<SendDataItem> &data, UpdateWaterMark &isUpdate);
91 
92     static SyncTimeRange GetSyncDataTimeRange(SyncType syncType, WaterMark localMark, WaterMark deleteMark,
93         const std::vector<SendDataItem> &inData, UpdateWaterMark &isUpdate);
94 
95     static std::pair<TimeOffset, TimeOffset> GetTimeOffsetFromRequestMsg(const Message *message);
96 
97     static void RecordClientId(const SingleVerSyncTaskContext &context, const SyncGenericInterface &storage,
98         std::shared_ptr<Metadata> &metadata);;
99 
100     static void SetDataRequestCommonInfo(const SingleVerSyncTaskContext &context,
101         const SyncGenericInterface &storage, DataRequestPacket &packet, std::shared_ptr<Metadata> &metadata);
102 
103     static int SchemaVersionMatchCheck(const SingleVerSyncTaskContext &context, const DataRequestPacket &packet,
104         std::shared_ptr<Metadata> &metadata);
105 private:
106     static int RunPermissionCheckInner(const SingleVerSyncTaskContext *context, const SyncGenericInterface* storage,
107         const std::string &label, const DataRequestPacket *packet, int mode);
108 };
109 }
110 #endif // SINGLE_VER_DATA_SYNC_UTIL_H