xref: /foundation/communication/netmanager_ext/services/netfirewallmanager/include/netfirewall_preference_helper.h

/*
 * Copyright (c) 2024 Huawei Device Co., Ltd.
 * 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 NET_FIREWALL_PREFERENCES_HELPER_H
#define NET_FIREWALL_PREFERENCES_HELPER_H

#include <map>

#include "preferences.h"

namespace OHOS {
namespace NetManagerStandard {
class NetFirewallPreferenceHelper {
public:
    NetFirewallPreferenceHelper() = default;
    ~NetFirewallPreferenceHelper() = default;

    static std::shared_ptr<NetFirewallPreferenceHelper> GetInstance();

    /**
     * Save int data using preferences
     *
     * @param key String
     * @param value Integer value
     * @return If get preferences success and save inner int value success, there is a return to true,
     * otherwise it will be false
     */
    bool SaveInt(const std::string &key, int32_t value);

    /**
     * Save bool data using preferences
     *
     * @param key String
     * @param value Bool value
     * @return If get preferences success and save inner bool value success, there is a return to true,
     * otherwise it will be false
     */
    bool SaveBool(const std::string &key, bool value);

    /**
     * Get integer data using preferences
     *
     * @param key String
     * @param value Integer value
     */
    int32_t ObtainInt(const std::string &key, int32_t defValue);

    /**
     * Get bool data
     *
     * @param key String
     * @param defValue Value
     * @return If get preferences success and obtain inner bool value success,
     * there is a return to true, otherwise it will be false
     */
    bool ObtainBool(const std::string &key, bool defValue);

    /**
     * Cleaning Data using preferences
     *
     * @param filePath File path
     * @return If there is a preference file and get preferences not null, and delete preferences success,
     * it will return to true, otherwise it will be false
     */
    bool Clear(const std::string &filePath);

    /**
     * Get Object Handle
     *
     * @param filePath File path
     * @return If there is a preference file and get preferences not null, it will return to true,
     * otherwise it will be false
     */
    bool GetPreference(const std::string &filePath);

private:
    bool GetPreference();

    bool RefreshSync();

    template <typename T> bool Save(const std::string &key, const T &defValue);

    bool SaveInner(std::shared_ptr<NativePreferences::Preferences> ptr, const std::string &key, const int32_t &value);

    bool SaveInner(std::shared_ptr<NativePreferences::Preferences> ptr, const std::string &key, const bool &value);

    template <typename T> T Obtain(const std::string &key, const T &defValue);

    int32_t ObtainInner(std::shared_ptr<NativePreferences::Preferences> ptr, const std::string &key,
        const int32_t &defValue);

    bool ObtainInner(std::shared_ptr<NativePreferences::Preferences> ptr, const std::string &key, const bool &defValue);

    std::shared_ptr<NativePreferences::Preferences> ptr_ = nullptr;
    std::string filePath_;
};
} // namespace NetManagerStandard
} // namespace OHOS
#endif // NET_FIREWALL_PREFERENCES_HELPER_H