| // |
| // Copyright (C) 2015 The Android Open Source Project |
| // |
| // 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 SHILL_JSON_STORE_H_ |
| #define SHILL_JSON_STORE_H_ |
| |
| #include <map> |
| #include <set> |
| #include <string> |
| #include <vector> |
| |
| #include <base/files/file_path.h> |
| #include <brillo/variant_dictionary.h> |
| #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| |
| #include "shill/store_interface.h" |
| |
| namespace shill { |
| |
| class JsonStore : public StoreInterface { |
| public: |
| explicit JsonStore(const base::FilePath& path); |
| // TODO(quiche): Determine if we need a dtor. In particular, we'll |
| // need one of StoreInterface implementations are expected to |
| // automatically Flush() before destruction. |
| |
| // Inherited from StoreInterface. |
| bool IsNonEmpty() const override; |
| bool Open() override; |
| bool Close() override; |
| bool Flush() override; |
| bool MarkAsCorrupted() override; |
| std::set<std::string> GetGroups() const override; |
| std::set<std::string> GetGroupsWithKey(const std::string& key) const override; |
| std::set<std::string> GetGroupsWithProperties( |
| const KeyValueStore& properties) const override; |
| bool ContainsGroup(const std::string& group) const override; |
| bool DeleteKey(const std::string& group, const std::string& key) override; |
| bool DeleteGroup(const std::string& group) override; |
| bool SetHeader(const std::string& header) override; |
| bool GetString(const std::string& group, |
| const std::string& key, |
| std::string* value) const override; |
| bool SetString(const std::string& group, |
| const std::string& key, |
| const std::string& value) override; |
| bool GetBool(const std::string& group, |
| const std::string& key, |
| bool* value) const override; |
| bool SetBool(const std::string& group, |
| const std::string& key, |
| bool value) override; |
| bool GetInt(const std::string& group, |
| const std::string& key, |
| int* value) const override; |
| bool SetInt(const std::string& group, |
| const std::string& key, |
| int value) override; |
| bool GetUint64(const std::string& group, |
| const std::string& key, |
| uint64_t* value) const override; |
| bool SetUint64(const std::string& group, |
| const std::string& key, |
| uint64_t value) override; |
| bool GetStringList(const std::string& group, |
| const std::string& key, |
| std::vector<std::string>* value) const override; |
| bool SetStringList(const std::string& group, |
| const std::string& key, |
| const std::vector<std::string>& value) override; |
| // GetCryptedString is non-const for legacy reasons. See |
| // KeyFileStore::SetCryptedString() for details. |
| bool GetCryptedString(const std::string& group, |
| const std::string& key, |
| std::string* value) override; |
| bool SetCryptedString(const std::string& group, |
| const std::string& key, |
| const std::string& value) override; |
| |
| private: |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreHeader); // file_description_ |
| // Tests which use |group_name_to_settings_|. |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreAllTypes); |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreNonUtf8Strings); |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreNonUtf8StringList); |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreMultipleGroups); |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreMultipleGroupsWithSameKeys); |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreStringsWithEmbeddedNulls); |
| FRIEND_TEST(JsonStoreTest, CanPersistAndRestoreStringListWithEmbeddedNulls); |
| // Tests which modify |path_|. |
| FRIEND_TEST(JsonStoreTest, FlushFailsWhenPathComponentDoesNotExist); |
| |
| template<typename T> bool ReadSetting( |
| const std::string& group, const std::string& key, T* out) const; |
| template<typename T> bool WriteSetting( |
| const std::string& group, const std::string& key, const T& new_value); |
| |
| const base::FilePath path_; |
| std::string file_description_; |
| std::map<std::string, brillo::VariantDictionary> group_name_to_settings_; |
| |
| DISALLOW_COPY_AND_ASSIGN(JsonStore); |
| }; |
| |
| } // namespace shill |
| |
| #endif // SHILL_JSON_STORE_H_ |