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 #include "metadata/store_meta_data.h"
17
18 #include "metadata/secret_key_meta_data.h"
19 #include "metadata/store_meta_data_local.h"
20 #include "metadata/strategy_meta_data.h"
21 #include "utils/anonymous.h"
22 #include "utils/constant.h"
23 namespace OHOS {
24 namespace DistributedData {
25 constexpr uint32_t StoreMetaData::CURRENT_VERSION;
26 constexpr uint32_t StoreMetaData::FIELD_CHANGED_TAG;
27 constexpr const char *StoreMetaData::KEY_PREFIX;
Marshal(json & node) const28 bool StoreMetaData::Marshal(json &node) const
29 {
30 SetValue(node[GET_NAME(version)], version);
31 SetValue(node[GET_NAME(isAutoSync)], isAutoSync);
32 SetValue(node[GET_NAME(isBackup)], isBackup);
33 SetValue(node[GET_NAME(isEncrypt)], isEncrypt);
34 SetValue(node[GET_NAME(isManualClean)], isManualClean);
35 SetValue(node[GET_NAME(isDirty)], isDirty);
36 SetValue(node[GET_NAME(isSearchable)], isSearchable);
37 SetValue(node[GET_NAME(isNeedCompress)], isNeedCompress);
38 SetValue(node[GET_NAME(storeType)], storeType);
39 SetValue(node[GET_NAME(securityLevel)], securityLevel);
40 SetValue(node[GET_NAME(area)], area);
41 SetValue(node[GET_NAME(uid)], uid);
42 SetValue(node[GET_NAME(tokenId)], tokenId);
43 SetValue(node[GET_NAME(instanceId)], instanceId);
44 SetValue(node[GET_NAME(appId)], appId);
45 SetValue(node[GET_NAME(appType)], appType);
46 SetValue(node[GET_NAME(bundleName)], bundleName);
47 SetValue(node[GET_NAME(hapName)], hapName);
48 SetValue(node[GET_NAME(dataDir)], dataDir);
49 SetValue(node[GET_NAME(deviceId)], deviceId);
50 SetValue(node[GET_NAME(schema)], schema);
51 SetValue(node[GET_NAME(storeId)], storeId);
52 SetValue(node[GET_NAME(user)], user);
53 SetValue(node[GET_NAME(account)], account);
54
55 // compatible with the versions which lower than VERSION_TAG_0000
56 SetValue(node[GET_NAME(kvStoreType)], storeType);
57 SetValue(node[GET_NAME(deviceAccountID)], user);
58 SetValue(node[GET_NAME(userId)], account);
59 SetValue(node[GET_NAME(UID)], uid);
60 SetValue(node[GET_NAME(customDir)], customDir);
61
62 return true;
63 }
64
Unmarshal(const json & node)65 bool StoreMetaData::Unmarshal(const json &node)
66 {
67 GetValue(node, GET_NAME(version), version);
68 GetValue(node, GET_NAME(isAutoSync), isAutoSync);
69 GetValue(node, GET_NAME(isBackup), isBackup);
70 GetValue(node, GET_NAME(isDirty), isDirty);
71 GetValue(node, GET_NAME(isEncrypt), isEncrypt);
72 GetValue(node, GET_NAME(isManualClean), isManualClean);
73 GetValue(node, GET_NAME(isSearchable), isSearchable);
74 GetValue(node, GET_NAME(isNeedCompress), isNeedCompress);
75 GetValue(node, GET_NAME(storeType), storeType);
76 GetValue(node, GET_NAME(securityLevel), securityLevel);
77 GetValue(node, GET_NAME(area), area);
78 GetValue(node, GET_NAME(uid), uid);
79 GetValue(node, GET_NAME(tokenId), tokenId);
80 GetValue(node, GET_NAME(instanceId), instanceId);
81 GetValue(node, GET_NAME(appId), appId);
82 GetValue(node, GET_NAME(appType), appType);
83 GetValue(node, GET_NAME(bundleName), bundleName);
84 GetValue(node, GET_NAME(hapName), hapName);
85 GetValue(node, GET_NAME(dataDir), dataDir);
86 GetValue(node, GET_NAME(deviceId), deviceId);
87 GetValue(node, GET_NAME(schema), schema);
88 GetValue(node, GET_NAME(storeId), storeId);
89 GetValue(node, GET_NAME(user), user);
90 GetValue(node, GET_NAME(account), account);
91
92 // compatible with the older versions
93 if (version < FIELD_CHANGED_TAG) {
94 GetValue(node, GET_NAME(kvStoreType), storeType);
95 GetValue(node, GET_NAME(UID), uid);
96 GetValue(node, GET_NAME(deviceAccountID), user);
97 GetValue(node, GET_NAME(userId), account);
98 }
99 GetValue(node, GET_NAME(customDir), customDir);
100 return true;
101 }
102
StoreMetaData()103 StoreMetaData::StoreMetaData()
104 {
105 }
106
~StoreMetaData()107 StoreMetaData::~StoreMetaData()
108 {
109 }
110
StoreMetaData(const std::string & userId,const std::string & appId,const std::string & storeId)111 StoreMetaData::StoreMetaData(const std::string &userId, const std::string &appId, const std::string &storeId)
112 : appId(appId), storeId(storeId), user(userId)
113 {
114 }
115
operator ==(const StoreMetaData & metaData) const116 bool StoreMetaData::operator==(const StoreMetaData &metaData) const
117 {
118 if (Constant::NotEqual(isAutoSync, metaData.isAutoSync) || Constant::NotEqual(isBackup, metaData.isBackup) ||
119 Constant::NotEqual(isDirty, metaData.isDirty) || Constant::NotEqual(isEncrypt, metaData.isEncrypt) ||
120 Constant::NotEqual(isSearchable, metaData.isSearchable) ||
121 Constant::NotEqual(isNeedCompress, metaData.isNeedCompress)) {
122 return false;
123 }
124 return (version == metaData.version && storeType == metaData.storeType &&
125 securityLevel == metaData.securityLevel && area == metaData.area && uid == metaData.uid &&
126 tokenId == metaData.tokenId && instanceId == metaData.instanceId && appId == metaData.appId &&
127 appType == metaData.appType && bundleName == metaData.bundleName && dataDir == metaData.dataDir
128 );
129 }
130
operator !=(const StoreMetaData & metaData) const131 bool StoreMetaData::operator!=(const StoreMetaData &metaData) const
132 {
133 return !(*this == metaData);
134 }
135
GetKey() const136 std::string StoreMetaData::GetKey() const
137 {
138 if (instanceId == 0) {
139 return GetKey({ deviceId, user, "default", bundleName, storeId });
140 }
141 return GetKey({ deviceId, user, "default", bundleName, storeId, std::to_string(instanceId) });
142 }
143
GetKeyLocal() const144 std::string StoreMetaData::GetKeyLocal() const
145 {
146 if (instanceId == 0) {
147 return StoreMetaDataLocal::GetKey({ deviceId, user, "default", bundleName, storeId });
148 }
149 return StoreMetaDataLocal::GetKey({ deviceId, user, "default", bundleName, storeId, std::to_string(instanceId) });
150 }
151
GetSecretKey() const152 std::string StoreMetaData::GetSecretKey() const
153 {
154 if (version < CURRENT_VERSION) {
155 return SecretKeyMetaData::GetKey({ user, "default", bundleName, storeId });
156 }
157 return SecretKeyMetaData::GetKey({ user, "default", bundleName, storeId, std::to_string(instanceId) });
158 }
159
GetBackupSecretKey() const160 std::string StoreMetaData::GetBackupSecretKey() const
161 {
162 if (version < CURRENT_VERSION) {
163 return SecretKeyMetaData::GetBackupKey({ user, "default", bundleName, storeId });
164 }
165 return SecretKeyMetaData::GetBackupKey({ user, "default", bundleName, storeId, std::to_string(instanceId) });
166 }
167
GetStoreAlias() const168 std::string StoreMetaData::GetStoreAlias() const
169 {
170 return Anonymous::Change(storeId);
171 }
172
GetStrategyKey() const173 std::string StoreMetaData::GetStrategyKey() const
174 {
175 if (instanceId == 0) {
176 return StrategyMeta::GetPrefix({ deviceId, user, "default", bundleName, storeId });
177 }
178 return StrategyMeta::GetPrefix({ deviceId, user, "default", bundleName, storeId, std::to_string(instanceId) });
179 }
180
GetKey(const std::initializer_list<std::string> & fields)181 std::string StoreMetaData::GetKey(const std::initializer_list<std::string> &fields)
182 {
183 std::string prefix = KEY_PREFIX;
184 for (const auto &field : fields) {
185 prefix.append(Constant::KEY_SEPARATOR).append(field);
186 }
187 return prefix;
188 }
189
GetPrefix(const std::initializer_list<std::string> & fields)190 std::string StoreMetaData::GetPrefix(const std::initializer_list<std::string> &fields)
191 {
192 return GetKey(fields).append(Constant::KEY_SEPARATOR);
193 }
194 } // namespace DistributedData
195 } // namespace OHOS
196