path: root/src/components/application_manager/include/application_manager/commands/command_impl.h

/*
 Copyright (c) 2014, 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_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_IMPL_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_IMPL_H_

#include "application_manager/application_manager.h"
#include "application_manager/commands/command.h"
#include "application_manager/event_engine/event_observer.h"
#include "application_manager/smart_object_keys.h"
#include "policy/policy_types.h"
#include "utils/logger.h"

#include <algorithm>

namespace application_manager {

/**
 * @brief Contains command parameters permissions (if any) defined in policy
 * table
 */
struct CommandParametersPermissions {
  RPCParams allowed_params;
  RPCParams disallowed_params;
  RPCParams undefined_params;

  bool AreDisallowedParamsIncluded(const RPCParams& parameters) {
    return std::includes(disallowed_params.begin(),
                         disallowed_params.end(),
                         parameters.begin(),
                         parameters.end());
  }

  bool AreUndefinedParamsIncluded(const RPCParams& parameters) {
    return std::includes(undefined_params.begin(),
                         undefined_params.end(),
                         parameters.begin(),
                         parameters.end());
  }
};

namespace commands {

/**
 * @brief Checks Mobile result code for single RPC
 * @param result_code contains result code from response to Mobile
 * @return true if result code complies to successful result codes,
 * false otherwise.
 */
bool IsMobileResultSuccess(const mobile_apis::Result::eType result_code);

/**
 * @brief Checks HMI result code for single RPC
 * @param result_code contains result code from HMI response
 * @return true if result code complies to successful result codes,
 * false otherwise.
 */
bool IsHMIResultSuccess(const hmi_apis::Common_Result::eType result_code);

/**
 * @brief Class is intended to encapsulate RPC as an object
 **/
class CommandImpl : public Command {
 public:
  /**
   * @brief CommandImpl class constructor
   *
   * @param message Incoming SmartObject message
   **/
  CommandImpl(const MessageSharedPtr& message,
              ApplicationManager& application_manager,
              rpc_service::RPCService& rpc_service,
              HMICapabilities& hmi_capabilities,
              policy::PolicyHandlerInterface& policy_handler);

  /**
   * @brief CommandImpl class destructor
   *
   **/
  virtual ~CommandImpl();

  /**
   * @brief Checks command permissions according to policy table
   */
  bool CheckPermissions() OVERRIDE;

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

  /**
   * @brief Cleanup all resources used by command
   **/
  bool CleanUp() OVERRIDE;

  /**
   * @brief Execute corresponding command by calling the action on reciever
   **/
  void Run() OVERRIDE;
  /**
   * @brief Retrieves request default timeout.
   * If request has a custom timeout, request_timeout_ should be reassign to it
   *
   * @return Request default timeout
   */
  uint32_t default_timeout() const OVERRIDE;

  /*
   * @brief Retrieves correlation ID
   */
  uint32_t correlation_id() const OVERRIDE;

  /*
   * @brief Retrieves connection key
   */
  uint32_t connection_key() const OVERRIDE;

  /*
   * @brief Retrieves request ID
   */
  int32_t function_id() const OVERRIDE;

  /*
   * @brief Retrieves Window ID
   */
  WindowID window_id() const OVERRIDE;

  void set_warning_info(const std::string info) OVERRIDE;

  std::string warning_info() const OVERRIDE;

  /*
   * @brief Function is called by RequestController when request execution time
   * has exceed it's limit
   *
   */
  void HandleTimeOut() OVERRIDE;

  /**
   * @brief AllowedToTerminate tells request Controller if it can terminate this
   * request by response.
   * By default, RequestCtrl should terminate all requests by their responses.
   *  If request need to terminate itself, it should override this function
   * false
   * @return allowed_to_terminate_ value
   */
  bool AllowedToTerminate() OVERRIDE;

  /**
   * @brief SetAllowedToTerminate set up allowed to terminate flag.
   * If true, request controller will terminate request on response
   */
  void SetAllowedToTerminate(const bool allowed) OVERRIDE;

  const ApplicationManager& GetApplicationManager() const OVERRIDE;

  void OnUpdateTimeOut() OVERRIDE;

  /**
   * @brief Calculates command`s internal consecutive number
   * for specified application used during resumption.
   * This method is called when a new command is added.
   * @param[in] app Application for wich a consecutive number is calculated
   * @return internal consecutive number
   */
  static uint32_t CalcCommandInternalConsecutiveNumber(
      application_manager::ApplicationConstSharedPtr app);

  /**
   * @brief Check syntax of string from mobile
   * @param str - string that need to be checked
   * @param allow_empty_string if true methods allow empty sting
   * @return true if success otherwise return false
   */
  bool CheckSyntax(const std::string& str, bool allow_empty_line = false) const;

  /**
   * @brief Checks HMI result code for single RPC
   * @param result_code contains result code from HMI response
   * @param interface to check availability
   * @return true if result code complies to successful result codes,
   * false otherwise.
   */
  bool IsHMIResultSuccess(hmi_apis::Common_Result::eType result_code,
                          HmiInterfaces::InterfaceID interface) const;

  // members
  static const int32_t hmi_protocol_type_;
  static const int32_t mobile_protocol_type_;
  static const int32_t protocol_version_;

 protected:
  /**
   * @brief Checks message permissions and parameters according to policy table
   * permissions
   * @param source The source of the command (used to determine if a response
   * should be sent on failure)
   * @return true if the RPC is allowed, false otherwise
   */
  bool CheckAllowedParameters(const Command::CommandSource source);

  /**
   * @brief Adds disallowed parameters back to response with appropriate
   * reasons
   * @param response Response message, which should be extended with blocked
   * parameters reasons
   */
  void AddDisallowedParameters(smart_objects::SmartObject& response);

  /**
   * @brief Adds disallowed parameters to response info
   * @param response Response message, which info should be extended
   */
  void AddDisallowedParametersToInfo(
      smart_objects::SmartObject& response) const;

  /**
   * @brief Adds param to disallowed parameters enumeration
   * @param info string with disallowed params enumeration
   * @param param disallowed param
   */
  void AddDisallowedParameterToInfoString(std::string& info,
                                          const std::string& param) const;

  /**
   * @brief Remove from current message parameters disallowed by policy table
   */
  void RemoveDisallowedParameters();

  /**
   * @brief Parses mobile message and replaces mobile app id with HMI app id
   * @param message Message to replace its ids
   * @return True if replacement succeeded, otherwise - false
   */
  bool ReplaceMobileWithHMIAppId(smart_objects::SmartObject& message);

  /**
   * @brief Parses message from HMI and replaces HMI app id with mobile app id
   * @param message Message to replace its ids
   * @return True if replacement succeeded, otherwise - false
   */
  bool ReplaceHMIWithMobileAppId(smart_objects::SmartObject& message);

  /**
   * @brief Adds disallowed parameters to info string, sets result codes if
   * necessary
   * @param response Command smart object
   */
  void FormatResponse(smart_objects::SmartObject& response);

  MessageSharedPtr message_;
  uint32_t default_timeout_;
  bool allowed_to_terminate_;
  ApplicationManager& application_manager_;
  rpc_service::RPCService& rpc_service_;
  HMICapabilities& hmi_capabilities_;
  policy::PolicyHandlerInterface& policy_handler_;

  /**
   * @brief warning_info_ Defines a warning message to send in the case of a
   * successful response
   */
  std::string warning_info_;

  CommandParametersPermissions parameters_permissions_;
  CommandParametersPermissions removed_parameters_permissions_;

 private:
  DISALLOW_COPY_AND_ASSIGN(CommandImpl);
};

}  // namespace commands
}  // namespace application_manager
#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_IMPL_H_