path: root/src/components/application_manager/rpc_plugins/sdl_rpc_plugin/include/sdl_rpc_plugin/commands/mobile/register_app_interface_request.h

/*

 Copyright (c) 2018, 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_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_REGISTER_APP_INTERFACE_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_REGISTER_APP_INTERFACE_REQUEST_H_

#include "application_manager/commands/command_request_impl.h"
#include "application_manager/policies/policy_handler_interface.h"
#include "utils/custom_string.h"
#include "utils/macro.h"

namespace policy {
struct DeviceInfo;
}

namespace sdl_rpc_plugin {
namespace app_mngr = application_manager;

class Application;

namespace commands {

namespace custom_str = utils::custom_string;

/**
 * @brief Register app interface request  command class
 **/
class RegisterAppInterfaceRequest
    : public app_mngr::commands::CommandRequestImpl {
 public:
  /**
   * \brief RegisterAppInterfaceRequest class constructor
   **/
  RegisterAppInterfaceRequest(
      const app_mngr::commands::MessageSharedPtr& message,
      app_mngr::ApplicationManager& application_manager,
      app_mngr::rpc_service::RPCService& rpc_service,
      app_mngr::HMICapabilities& hmi_capabilities,
      policy::PolicyHandlerInterface& policy_handler);

  /**
   * @brief RegisterAppInterfaceRequest class destructor
   **/
  ~RegisterAppInterfaceRequest();

  /**
   * @brief Init required by command resources
   **/
  bool Init() FINAL;

  /**
   * @brief Execute command
   **/
  void Run() FINAL;

  uint32_t default_timeout() const FINAL;

 private:
  /**
   * @brief The AppicationType enum defines whether application is newly
   * registered or existing and being switched over another transport
   */
  enum class ApplicationType {
    kNewApplication,
    kSwitchedApplicationHashOk,
    kSwitchedApplicationWrongHashId
  };

  /**
   * @brief Prepares and sends RegisterAppInterface response to mobile
   * considering application type
   * @param app_type Type of application
   * @param status_notifier pointer to status notifier callback function
   * @param add_info - additional information to be sent to mobile app
   **/
  void SendRegisterAppInterfaceResponseToMobile(
      ApplicationType app_type,
      policy::StatusNotifier status_notifier,
      const std::string& add_info);

  /**
   * @brief SendChangeRegistration send ChangeRegistration on HMI
   * @param function_id interface specific ChangeRegistration
   * @param language language of registration
   * @param app_id application to change registration
   */
  void SendChangeRegistration(const hmi_apis::FunctionID::eType function_id,
                              const int32_t language,
                              const uint32_t app_id);

  /**
   * @brief SendChangeRegistrationOnHMI send required SendChangeRegistration
   * HMI
   * @param app application to change registration
   */
  void SendChangeRegistrationOnHMI(app_mngr::ApplicationConstSharedPtr app);

  /**
   * @brief Sends OnAppRegistered notification to HMI
   *
   * @param app application with changed HMI status
   * @param resumption If true, resumption-related parameters will be sent to
   * the HMI
   **/
  void SendOnAppRegisteredNotificationToHMI(
      app_mngr::ApplicationConstSharedPtr app, bool resumption);

  /**
   * @brief Check new ID along with known mobile application ID
   *
   * return TRUE if ID is known already, otherwise - FALSE
   */
  bool IsApplicationWithSameAppIdRegistered();

  /**
   * @brief Check new application parameters (name, tts, vr) for
   * coincidence with already known parameters of registered applications
   *
   * @return SUCCESS if there is no coincidence of app.name/TTS/VR synonyms,
   * otherwise appropriate error code returns
   */
  mobile_apis::Result::eType CheckCoincidence();

  /**
   * @brief Search for any apps with the same appName as the one being
   * registered
   * @param out_duplicate_apps To be filled with a list of all of the apps which
   * have duplicate appNames to the app being registered (registered or pending)
   *
   * @return TRUE if at least one duplicate app was found, otherwise FALSE
   */
  bool GetDuplicateNames(
      std::vector<app_mngr::ApplicationSharedPtr>& out_duplicate_apps);

  /**
   * @brief Predicate for using with CheckCoincidence method to compare with VR
   * synonym SO
   *
   * @return TRUE if there is coincidence of VR, otherwise FALSE
   */
  struct CoincidencePredicateVR {
    CoincidencePredicateVR(const custom_str::CustomString& newItem)
        : newItem_(newItem) {}

    bool operator()(const smart_objects::SmartObject& obj) {
      const custom_str::CustomString& vr_synonym = obj.asCustomString();
      return newItem_.CompareIgnoreCase(vr_synonym);
    }
    const custom_str::CustomString& newItem_;
  };

  /**
   * @brief Check request parameters against policy table data
   * @return SUCCESS if check ok, otherwise return appropriate error code
   */
  mobile_apis::Result::eType CheckWithPolicyData();

  /**
   * @brief Fill DeviceInfo struct with data from request, if any
   * @param device_info Struct for device params from request
   */
  void FillDeviceInfo(policy::DeviceInfo* device_info);

  /**
   * @brief Checks register app interface params(ttsName, ...).
   * When type is String there is a check on the contents \t\n \\t \\n
   * @return if register app interface contains \t\n \\t \\n return TRUE,
   * FALSE otherwise
   */
  bool IsWhiteSpaceExist();

  /**
   * @brief Checks vehicle type params (model, year etc.) and in case of absense
   * replaces with policy table backup values
   * @param vehicle_type VehicleType struct
   * @param param Vehicle param
   * @param backup_value Backup value
   */
  void CheckResponseVehicleTypeParam(smart_objects::SmartObject& vehicle_type,
                                     const std::string& param,
                                     const std::string& backup_value);
  /**
   * @brief Sends ButtonSubscription request if approved by hmi_capabilities
   */
  void SendSubscribeCustomButtonRequest();

  /**
   * @brief IsApplicationSwitched checks whether application is switched
   * from another transport. If application id is found, but not in reconnection
   * list, returns 'already registered' code. Otherwise - proceed with
   * switching.
   * @return True if application is detected as switched, otherwise false.
   */
  bool IsApplicationSwitched();

  /**
   * @brief Information about given Connection Key.
   * @param key Unique key used by other components as session identifier
   * @param device_id device identifier.
   * @param mac_address uniq address
   * @return false in case of error or true in case of success
   */
  bool GetDataOnSessionKey(
      const uint32_t key,
      connection_handler::DeviceHandle* device_id = nullptr,
      std::string* mac_address = nullptr) const;

  /**
   * @brief Processes AppHMITypes in the received message from mobile and in the
   * policy table
   * @param message A message from mobile that could contain AppHMIType
   * collection
   * @param app_hmi_types_in_policy AppHMITypes that describes in the policy
   * table for the app that sent the message
   * @return Result of processing
   */
  mobile_apis::Result::eType ProcessingAppHMITypesPolicies(
      smart_objects::SmartObject& message,
      policy::StringArray& app_hmi_types_in_policy);

  /**
   * @brief Processes AppHMITypes in the received message
   * @param message A message received from the mobile
   * @param info Info in a string representation that should be added to the
   * response info
   * @param log A log in a string represenation that could contain the
   * AppHMITypes that are absent in the policy table.
   */
  mobile_apis::Result::eType ProcessingAppHMITypesInMessage(
      const smart_objects::SmartObject& message);

  /**
   * @brief FillApplicationParams set app application attributes from the RAI
   * request
   * @param application applicaiton to fill params
   */
  void FillApplicationParams(
      application_manager::ApplicationSharedPtr application);

  /**
   * @brief SetupAppDeviceInfo add applicaiton device information to policies
   * @param application applicaiton to process
   */
  void SetupAppDeviceInfo(
      application_manager::ApplicationSharedPtr application);

  /**
   * @brief ApplicationDataShouldBeResumed check if application data should be
   * resumed
   * @return true if app data should be resumed, otherwise returns false
   */
  bool ApplicationDataShouldBeResumed(std::string& add_info);

  /**
   * @brief CalculateFinalResultCode calculates the final result code
   * considering all previous conditions
   * @return calculated result code
   */
  mobile_apis::Result::eType CalculateFinalResultCode() const;

  /**
   * @brief AddApplicationDataToPolicy adds specified application to policy
   * database and returns a callback with extra actions to be done if required
   * @param application pointer to application to add
   * @return callback with extra actions after adding specified application
   */
  policy::StatusNotifier AddApplicationDataToPolicy(
      application_manager::ApplicationSharedPtr application);

  /**
   * @brief CheckLanguage check if language in RAI matches hmi_capabilities
   * Setup result_code variable in case of does not match
   */
  void CheckLanguage();

  std::string response_info_;
  bool are_tts_chunks_invalid_;
  bool are_hmi_types_invalid_;
  bool is_resumption_failed_;
  bool is_wrong_language_;

  connection_handler::DeviceHandle device_handle_;
  std::string device_id_;

  policy::PolicyHandlerInterface& GetPolicyHandler();
  DISALLOW_COPY_AND_ASSIGN(RegisterAppInterfaceRequest);
};

}  // namespace commands

}  // namespace sdl_rpc_plugin

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_REGISTER_APP_INTERFACE_REQUEST_H_