path: root/src/components/config_profile/include/config_profile/profile.h

/*
 * Copyright (c) 2015, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_CONFIG_PROFILE_INCLUDE_CONFIG_PROFILE_PROFILE_H_
#define SRC_COMPONENTS_CONFIG_PROFILE_INCLUDE_CONFIG_PROFILE_PROFILE_H_

#include <stdint.h>
#include <string>
#include <vector>
#include <list>
#include "utils/macro.h"
#include "utils/singleton.h"

namespace profile {

/**
 * The Profile class
 */
class Profile : public utils::Singleton<Profile> {
  public:
    // Methods section

    /**
     * Destructor
     *
     * Unimplemented to avoid misusing
     *
     */
    virtual ~Profile();

    /**
      * @brief Returns true if HMI should be started, otherwise false
      */
    bool launch_hmi() const;

    /**
      * @brief Returns application configuration path
      */
    const std::string& app_config_folder() const;

    /**
      * @brief Returns application storage path
      */
    const std::string& app_storage_folder() const;

    /**
     * @brief Return application resourse folder
     */
    const std::string& app_resourse_folder() const;

    /**
     * @brief Returns true, if SDL 4.0 is enabled
     */
    bool enable_protocol_4() const;

    /**
     * @brief Returns application icons folder path
     */
    const std::string& app_icons_folder() const;

    /**
     * @brief Returns application icons folder maximum size
     */
    const uint32_t& app_icons_folder_max_size() const;

    /**
     * @brief Returns application icons amount to remove from icon folder,
     * if maximum size exceeded
     */
    const uint32_t& app_icons_amount_to_remove() const;

    /**
     * @brief Returns the path to the config file
     */
    const std::string& config_file_name() const;

    /**
     * @brief Sets the path to the config file
     */
    void config_file_name(const std::string& fileName);

    /**
     * @brief Returns server address
     */
    const std::string& server_address() const;

    /**
     * @brief Returns server port
     */
    const uint16_t& server_port() const;

    /**
     * @brief Returns port for video streaming
     */
    const uint16_t& video_streaming_port() const;

    /**
      * @brief Returns port for audio streaming
      */
    const uint16_t& audio_streaming_port() const;

    /**
     * @brief Returns streaming timeout
     */
    uint32_t stop_streaming_timeout() const;

    /**
      * @brief Returns port for time reports
      */
    const uint16_t& time_testing_port() const;

    /**
     * @brief Returns hmi capabilities file name
     */
    const std::string& hmi_capabilities_file_name() const;

    /**
     * @brief Returns help promt vector
     */
    const std::vector<std::string>& help_prompt() const;

    /**
     * @brief Returns help promt vector
     */
    const std::vector<std::string>& time_out_promt() const;

    /**
     * @brief Returns vr commands default for all apps
     * such as Help.
     */
    const std::vector<std::string>& vr_commands() const;

    /**
     * @brief Maximum command id available for mobile app
     */
    const uint32_t& max_cmd_id() const;

    /**
     * @brief Default timeout for waiting for response to mobile app
     */
    const uint32_t& default_timeout() const;

    /**
     * @brief Default timeout for waiting for resuming
     */
    const uint32_t& app_resuming_timeout() const;
    const uint32_t& app_resumption_save_persistent_data_timeout() const;

    /**
     * @brief Returns desirable thread stack size
     */
    const uint64_t& thread_min_stack_size() const;

    /**
      * @brief Returns true if audio mixing is supported
      */
    bool is_mixing_audio_supported() const;

    /**
      * @brief Returns true if video re-decoding enabled
      */
    bool is_redecoding_enabled() const;

    /**
      * @brief Returns title for Vr Help
      */
    const std::string& vr_help_title() const;

    /**
      * @brief Returns application directory quota size
      */
    const uint32_t& app_dir_quota() const;

    /**
      * @brief Returns the video server type
      */
    const std::string& video_server_type() const;

    /**
      * @brief Returns the audio server type
      */
    const std::string& audio_server_type() const;

    /**
      * @brief Returns the video pipe path
      */
    const std::string& named_video_pipe_path() const;

    /**
     * @brief Returns the audio pipe path
     */
    const std::string& named_audio_pipe_path() const;

    /**
     * @brief Returns time scale for max amount of requests for application
     * in hmi level none.
     */
    const uint32_t& app_hmi_level_none_time_scale() const;

    /**
      * @brief Returns path to testing file to which redirects video stream
      */
    const std::string& video_stream_file() const;

    /**
      * @brief Returns path to testing file to which redirects audio stream
      */
    const std::string& audio_stream_file() const;
    /**
     * @brief Returns allowable max amount of requests per time scale for
     * application in hmi level none
     *
     */
    const uint32_t& app_hmi_level_none_time_scale_max_requests() const;

    /**
     * @brief Returns application time scale for max amount of requests per it.
     */
    const uint32_t& app_time_scale() const;

    /**
     * @brief Returns allowable max amount of requests per application
     * time scale
     */
    const uint32_t& app_time_scale_max_requests() const;

    /**
     * @brief Returns allowable amount of the system pending requests
     */
    const uint32_t& pending_requests_amount() const;

    /**
     * @brief Returns Max allowed number of PutFile requests for one
     * application in NONE
     */
    const uint32_t& put_file_in_none() const;

    /**
     * @brief Returns Max allowed number of DeleteFile requests for one
     * application in NONE
     */
    const uint32_t& delete_file_in_none() const;

    /**
     * @brief Returns Max allowed number of ListFiles requests for one
     * application in NONE
     */
    const uint32_t& list_files_in_none() const;

    /*
     * @brief Returns file name for storing applications data
     */
    const std::string& app_info_storage() const;

    /*
     * @brief Heartbeat timeout before closing connection
     */
    int32_t heart_beat_timeout() const;

    /*
     * @brief Path to preloaded policy file
     */
    const std::string& preloaded_pt_file() const;

    /**
     * @brief Path to policies snapshot file
     * @return file path
     */
    const std::string& policies_snapshot_file_name() const;

    /**
     * @brief Should Policy be turned off? (Library not loaded)
     * @return Flag
     */
    bool enable_policy() const;

    /*
     * @brief Timeout in transport manager before disconnect
    */
    uint32_t transport_manager_disconnect_timeout() const;

    /*
     * @brief Returns true if last state singleton is used
     */
    bool use_last_state() const;

    /**
     * @brief Returns supported diagnostic modes
     */
    const std::vector<uint32_t>& supported_diag_modes() const;

    /**
      * @brief Returns system files folder path
      */
    const std::string& system_files_path() const;

    /**
     * @brief Returns port for TCP transport adapter
     */
    uint16_t transport_manager_tcp_adapter_port() const;

    /**
     * @brief Returns value of timeout after which sent
     * tts global properties for VCA
     */
    uint16_t tts_global_properties_timeout() const;

    /**
     * @brief Reads a string value from the profile
     *
     * @param value         Result value
     * @param default_value Value to use key wasn't found
     * @param pSection      The section to read the value in
     * @param pKey          The key whose value needs to be read out
     *
     * @return FALSE if could not read the value out of the profile
     * (then the value is equal \c default_value)
     */
    bool ReadStringValue(std::string* value,
                         const char* default_value,
                         const char* const pSection,
                         const char* const pKey) const;

    /**
     * @brief Reads an int32_t value from the profile
     *
     * @param value         Result value
     * @param default_value Value to use key wasn't found
     * @param pSection      The section to read the value in
     * @param pKey          The key whose value needs to be read out
     *
     * @return FALSE if could not read the value out of the profile
     * (then the value is equal \c default_value)
     */
    bool ReadIntValue(int32_t* value,
                      int32_t  default_value,
                      const char* const pSection,
                      const char* const pKey) const;
    /**
     * @brief Reads an bool value from the profile
     *
     * @param value         Result value
     * @param default_value Value to use key wasn't found
     * @param pSection      The section to read the value in
     * @param pKey          The key whose value needs to be read out
     *
     * @return FALSE if could not read the value out of the profile
     * (then the value is equal \c default_value)
     */
    bool ReadBoolValue(bool *value,
                       const bool default_value,
                       const char * const pSection,
                       const char * const pKey) const;
    /**
     * @brief Reads an container of string values from the profile,
     * which handle as "Value1, Value2, Value3"
     *
     * @param pSection      The section to read the value in
     * @param pKey          The key whose value needs to be read out
     * @param out_result    Pointer to bool value for result reading Section
     * (could be NULL)
     *
     * @return container of values or empty continer
     * if could not read the value out of the profile
     */
    std::list<std::string> ReadStringContainer(
        const char * const pSection,
        const char * const pKey,
        bool* out_result) const;
    /**
     * @brief Reads an container of hex int values from the profile,
     * which handle as "0x01, 0xA0, 0XFF"
     *
     * @param pSection      The section to read the value in
     * @param pKey          The key whose value needs to be read out
     * @param out_result    Pointer to bool value for result reading Section
     * (could be NULL)
     *
     * @return container of values or empty continer
     * if could not read the value out of the profile
     */
    std::list<int> ReadIntContainer(const char * const pSection,
                                    const char * const pKey,
                                    bool* out_result) const;

    /**
     * @brief Returns delimiter for SDL-generated TTS chunks
     * @return TTS delimiter
     */
    const std::string& tts_delimiter() const;

    /**
     * @brief Returns recording file source name
     */
    const std::string& recording_file_source() const;

    /**
     * @brief Returns recording file name
     */
    const std::string& recording_file_name() const;

    const std::string& mme_db_name() const;

    const std::string& event_mq_name() const;

    const std::string& ack_mq_name() const;

    uint32_t application_list_update_timeout() const;

    const std::pair<uint32_t, int32_t>& read_did_frequency() const;

    const  std::pair<uint32_t, int32_t>& get_vehicle_data_frequency() const;

    const  std::pair<uint32_t, int32_t>& start_stream_retry_amount() const;

    /**
     * @brief Returns max allowed threads number for handling mobile requests
     */
    uint32_t thread_pool_size() const;

    uint32_t default_hub_protocol_index() const;

    const std::string& iap_legacy_protocol_mask() const;

    const std::string& iap_hub_protocol_mask() const;

    const std::string& iap_pool_protocol_mask() const;

    const std::string& iap_system_config() const;

    const std::string& iap2_system_config() const;

    int iap2_hub_connect_attempts() const;

    /**
     * @return seconds
     */
    int iap_hub_connection_wait_timeout() const;

    /*
     * ProtocolHandler section
     */
    size_t maximum_payload_size() const;

    size_t message_frequency_count() const;

    size_t message_frequency_time() const;

    uint16_t attempts_to_open_policy_db() const;

    uint16_t open_attempt_timeout_ms() const;

    uint32_t resumption_delay_before_ign() const;

    uint32_t resumption_delay_after_ign() const;

    uint32_t hash_string_size() const;

    /*
     * @brief Updates all related values from ini file
     */
    void UpdateValues();


  private:
    /**
     * Default constructor
     *
     * Unimplemented to avoid misusing
     *
     */
    Profile();


    /**
     * @brief Reads a boolean value from the profile
     *
     * @param value      The value to return
     * @param pSection   The section to read the value in
     * @param pKey       The key whose value needs to be read out
     *
     * @return FALSE if could not read the value out of the profile
     * (then the value is not changed)
     */
    bool ReadValue(bool* value,
                   const char* const pSection,
                   const char* const pKey) const;

    /**
     * @brief Reads a string value from the profile and interpret it
     * as \c true on "true" value or as \c false on any other value
     *
     * @param value      The value to return
     * @param pSection   The section to read the value in
     * @param pKey       The key whose value needs to be read out
     *
     * @return FALSE if could not read the value out of the profile
     * (then the value is not changed)
     */
    bool ReadValue(std::string* value,
                   const char* const pSection,
                   const char* const pKey) const;

    /**
     * @brief Reads a pair of ints value from the profile
     *
     * @param value         Result value
     * @param default_value Value to use key wasn't found
     * @param pSection      The section to read the value in
     * @param pKey          The key whose value needs to be read out
     *
     * @return FALSE if could not read the value out of the profile
     * (then the value is not changed)
     */
    bool ReadUintIntPairValue(std::pair<uint32_t, int32_t>* value,
                         const std::pair<uint32_t, uint32_t>& default_value,
                         const char* const pSection,
                         const char* const pKey) const;

    /**
     * @brief Reads an uint16/32/64_t value from the profile
     *
     * @param value         Result value
     * @param default_value Value to use key wasn't found
     * @param pSection      The section to read the value in
     * @param pKey          The key whose value needs to be read out
     *
     * @return FALSE if could not read the value out of the profile
     * (then the value is changed to default)
     */
    bool ReadUIntValue(uint16_t* value,
                       uint16_t default_value,
                       const char* const pSection,
                       const char* const pKey) const;

    bool ReadUIntValue(uint32_t* value,
                       uint32_t default_value,
                       const char* const pSection,
                       const char* const pKey) const;

    bool ReadUIntValue(uint64_t* value,
                       uint64_t default_value,
                       const char* const pSection,
                       const char* const pKey) const;

    /**
     * @brief Write to log content of container
     * @param array Source array
     * @param log Log string
     */
    void LogContainer(const std::vector<std::string>& container,
                      std::string* log);

    // Members section
    bool                            launch_hmi_;
    std::string                     app_config_folder_;
    std::string                     app_storage_folder_;
    std::string                     app_resourse_folder_;
    bool                            enable_protocol_4_;
    std::string                     app_icons_folder_;
    uint32_t                        app_icons_folder_max_size_;
    uint32_t                        app_icons_amount_to_remove_;
    std::string                     config_file_name_;
    std::string                     server_address_;
    uint16_t                        server_port_;
    uint16_t                        video_streaming_port_;
    uint16_t                        audio_streaming_port_;
    uint32_t                        stop_streaming_timeout_;
    uint16_t                        time_testing_port_;
    std::string                     hmi_capabilities_file_name_;
    std::vector<std::string>        help_prompt_;
    std::vector<std::string>        time_out_promt_;
    std::vector<std::string>        vr_commands_;
    uint64_t                        min_tread_stack_size_;
    bool                            is_mixing_audio_supported_;
    bool                            is_redecoding_enabled_;
    uint32_t                        max_cmd_id_;
    uint32_t                        default_timeout_;
    uint32_t                        app_resuming_timeout_;
    uint32_t                        app_resumption_save_persistent_data_timeout_;
    std::string                     vr_help_title_;
    uint32_t                        app_dir_quota_;
    std::string                     video_consumer_type_;
    std::string                     audio_consumer_type_;
    std::string                     named_video_pipe_path_;
    std::string                     named_audio_pipe_path_;
    uint32_t                        app_hmi_level_none_time_scale_max_requests_;
    uint32_t                        app_hmi_level_none_requests_time_scale_;
    std::string                     video_stream_file_;
    std::string                     audio_stream_file_;
    uint32_t                        app_time_scale_max_requests_;
    uint32_t                        app_requests_time_scale_;
    uint32_t                        pending_requests_amount_;
    uint32_t                        put_file_in_none_;
    uint32_t                        delete_file_in_none_;
    uint32_t                        list_files_in_none_;
    std::string                     app_info_storage_;
    uint32_t                        heart_beat_timeout_;
    std::string                     preloaded_pt_file_;
    std::string                     policy_snapshot_file_name_;
    bool                            enable_policy_;
    uint32_t                        transport_manager_disconnect_timeout_;
    bool                            use_last_state_;
    std::vector<uint32_t>           supported_diag_modes_;
    std::string                     system_files_path_;
    uint16_t                        transport_manager_tcp_adapter_port_;
    std::string                     tts_delimiter_;
    std::string                     mme_db_name_;
    std::string                     event_mq_name_;
    std::string                     ack_mq_name_;
    std::string                     recording_file_source_;
    std::string                     recording_file_name_;
    uint32_t                        application_list_update_timeout_;
    uint32_t                        max_thread_pool_size_;
    uint32_t                        default_hub_protocol_index_;
    /*
     * first value is count of request
     * second is time scale
     */
    std::pair<uint32_t, int32_t>    read_did_frequency_;

    /*
     * first value is count of request
     * second is time scale
     */
    std::pair<uint32_t, int32_t>    get_vehicle_data_frequency_;

    /**
     * first value is count of retries for start stream
     * second for timer
     */
    std::pair<uint32_t, int32_t>    start_stream_retry_amount_;

    std::string                     iap_legacy_protocol_mask_;
    std::string                     iap_hub_protocol_mask_;
    std::string                     iap_pool_protocol_mask_;
    std::string                     iap_system_config_;
    std::string                     iap2_system_config_;
    int                             iap2_hub_connect_attempts_;
    int                             iap_hub_connection_wait_timeout_;
    uint16_t                        tts_global_properties_timeout_;
    uint16_t                        attempts_to_open_policy_db_;
    uint16_t                        open_attempt_timeout_ms_;
    uint32_t                        resumption_delay_before_ign_;
    uint32_t                        resumption_delay_after_ign_;
    uint32_t                        hash_string_size_;

    FRIEND_BASE_SINGLETON_CLASS(Profile);
    DISALLOW_COPY_AND_ASSIGN(Profile);
};
}  //  namespace profile

#endif  // SRC_COMPONENTS_CONFIG_PROFILE_INCLUDE_CONFIG_PROFILE_PROFILE_H_