1 /*
2  * Copyright (c) 2023 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 DATASHARESERVICE_DB_DELEGATE_H
17 #define DATASHARESERVICE_DB_DELEGATE_H
18 
19 #include <string>
20 
21 #include "abs_shared_result_set.h"
22 #include "concurrent_map.h"
23 #include "datashare_predicates.h"
24 #include "datashare_result_set.h"
25 #include "datashare_values_bucket.h"
26 #include "executor_pool.h"
27 #include "hiview_fault_adapter.h"
28 #include "metadata/store_meta_data.h"
29 #include "result_set.h"
30 #include "serializable/serializable.h"
31 
32 namespace OHOS::DataShare {
33 class DBDelegate {
34 public:
35     using Time = std::chrono::steady_clock::time_point;
36     static std::shared_ptr<DBDelegate> Create(DistributedData::StoreMetaData &metaData,
37         const std::string &extUri = "", const std::string &backup = "");
38     virtual int64_t Insert(const std::string &tableName, const DataShareValuesBucket &valuesBucket) = 0;
39     virtual int64_t Update(const std::string &tableName, const DataSharePredicates &predicate,
40         const DataShareValuesBucket &valuesBucket) = 0;
41     virtual int64_t Delete(const std::string &tableName, const DataSharePredicates &predicate) = 0;
42     virtual std::pair<int, std::shared_ptr<DataShareResultSet>> Query(const std::string &tableName,
43         const DataSharePredicates &predicates, const std::vector<std::string> &columns,
44         int32_t callingPid, uint32_t callingTokenId) = 0;
45     virtual std::string Query(
46         const std::string &sql, const std::vector<std::string> &selectionArgs = std::vector<std::string>()) = 0;
47     virtual std::shared_ptr<NativeRdb::ResultSet> QuerySql(const std::string &sql) = 0;
48     virtual bool IsInvalid() = 0;
49     static void SetExecutorPool(std::shared_ptr<ExecutorPool> executor);
50     static void EraseStoreCache(const int32_t tokenId);
51     virtual std::pair<int64_t, int64_t> InsertEx(const std::string &tableName,
52         const DataShareValuesBucket &valuesBucket) = 0;
53     virtual std::pair<int64_t, int64_t> UpdateEx(const std::string &tableName,
54         const DataSharePredicates &predicate, const DataShareValuesBucket &valuesBucket) = 0;
55     virtual std::pair<int64_t, int64_t> DeleteEx(const std::string &tableName,
56         const DataSharePredicates &predicate) = 0;
57 private:
58     static void GarbageCollect();
59     static void StartTimer();
60     struct Entity {
61         explicit Entity(std::shared_ptr<DBDelegate> store);
62         std::shared_ptr<DBDelegate> store_;
63         Time time_;
64     };
65     static constexpr int NO_CHANGE_VERSION = -1;
66     static constexpr int64_t INTERVAL = 20; //seconds
67     static ConcurrentMap<uint32_t, std::map<std::string, std::shared_ptr<Entity>>> stores_;
68     static std::shared_ptr<ExecutorPool> executor_;
69     static ExecutorPool::TaskId taskId_;
70 };
71 
72 class Id : public DistributedData::Serializable {
73 public:
74     static constexpr int INVALID_USER = -1;
75     Id(const std::string &id, const int32_t userId);
76     ~Id() = default;
77     bool Marshal(json &node) const override;
78     bool Unmarshal(const json &node) override;
string()79     operator std::string()
80     {
81         return DistributedData::Serializable::Marshall(*this);
82     }
83 
84 private:
85     std::string _id;
86     int32_t userId;
87 };
88 
89 class VersionData : public DistributedData::Serializable {
90 public:
91     explicit VersionData(int version);
92     bool Marshal(json &node) const override;
93     bool Unmarshal(const json &node) override;
SetVersion(int ver)94     virtual void SetVersion(int ver)
95     {
96         version = ver;
97     };
GetVersion()98     virtual int GetVersion() const
99     {
100         return version;
101     };
102 
103 private:
104     int version;
105 };
106 
107 class KvData {
108 public:
109     explicit KvData(const Id &id);
110     const std::string &GetId() const;
111     virtual bool HasVersion() const = 0;
112     virtual int GetVersion() const = 0;
113     virtual std::string GetValue() const = 0;
114 
115 private:
116     std::string id;
117 };
118 
119 class KvDBDelegate {
120 public:
121     static constexpr const char *TEMPLATE_TABLE = "template_";
122     static constexpr const char *DATA_TABLE = "data_";
123     static std::shared_ptr<KvDBDelegate> GetInstance(
124         bool reInit = false, const std::string &dir = "", const std::shared_ptr<ExecutorPool> &executors = nullptr);
125     virtual ~KvDBDelegate() = default;
126     virtual int32_t Upsert(const std::string &collectionName, const KvData &value) = 0;
127     virtual int32_t Delete(const std::string &collectionName, const std::string &filter) = 0;
128     virtual int32_t Get(const std::string &collectionName, const Id &id, std::string &value) = 0;
129     virtual int32_t Get(const std::string &collectionName, const std::string &filter, const std::string &projection,
130         std::string &result) = 0;
131     virtual int32_t GetBatch(const std::string &collectionName, const std::string &filter,
132         const std::string &projection, std::vector<std::string> &result) = 0;
133     virtual void NotifyBackup() = 0;
134 };
135 } // namespace OHOS::DataShare
136 #endif // DATASHARESERVICE_DB_DELEGATE_H
137