/* Copyright (c) 2018, Ford Motor Company All rights reserved. Copyright (c) 2018, Livio, Inc. 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. */ #include "vehicle_info_plugin/commands/mobile/subscribe_vehicle_data_request.h" #include "application_manager/application_impl.h" #include "application_manager/message_helper.h" #include "utils/helpers.h" #include "vehicle_info_plugin/vehicle_info_app_extension.h" namespace vehicle_info_plugin { using namespace application_manager; namespace commands { SubscribeVehicleDataRequest::SubscribeVehicleDataRequest( const application_manager::commands::MessageSharedPtr& message, ApplicationManager& application_manager, app_mngr::rpc_service::RPCService& rpc_service, app_mngr::HMICapabilities& hmi_capabilities, policy::PolicyHandlerInterface& policy_handler) : CommandRequestImpl(message, application_manager, rpc_service, hmi_capabilities, policy_handler) {} SubscribeVehicleDataRequest::~SubscribeVehicleDataRequest() {} void SubscribeVehicleDataRequest::Run() { LOG4CXX_AUTO_TRACE(logger_); ApplicationSharedPtr app = application_manager_.application(connection_key()); if (!app) { LOG4CXX_ERROR(logger_, "NULL pointer"); SendResponse(false, mobile_apis::Result::APPLICATION_NOT_REGISTERED); return; } std::string info; mobile_apis::Result::eType result_code = mobile_apis::Result::INVALID_ENUM; smart_objects::SmartObject msg_params = smart_objects::SmartObject(smart_objects::SmartType_Map); smart_objects::SmartObject response_params = smart_objects::SmartObject(smart_objects::SmartType_Map); bool result = false; CheckVISubscriptions( app, info, result_code, response_params, msg_params, result); if (mobile_apis::Result::INVALID_ENUM != result_code) { SendResponse(result, result_code, info.empty() ? NULL : info.c_str(), response_params.empty() ? NULL : &response_params); return; } StartAwaitForInterface(HmiInterfaces::HMI_INTERFACE_VehicleInfo); SendHMIRequest(hmi_apis::FunctionID::VehicleInfo_SubscribeVehicleData, &msg_params, true); } void SubscribeVehicleDataRequest::on_event(const event_engine::Event& event) { LOG4CXX_AUTO_TRACE(logger_); using namespace helpers; const smart_objects::SmartObject& message = event.smart_object(); if (hmi_apis::FunctionID::VehicleInfo_SubscribeVehicleData != event.id()) { LOG4CXX_ERROR(logger_, "Received unknown event."); return; } EndAwaitForInterface(HmiInterfaces::HMI_INTERFACE_VehicleInfo); ApplicationSharedPtr app = application_manager_.application(CommandRequestImpl::connection_key()); if (!app) { LOG4CXX_ERROR(logger_, "NULL pointer."); return; } hmi_apis::Common_Result::eType hmi_result = static_cast( message[strings::params][hmi_response::code].asInt()); std::string response_info; GetInfo(message, response_info); const bool result = PrepareResultForMobileResponse( hmi_result, HmiInterfaces::HMI_INTERFACE_VehicleInfo); bool is_succeeded = result || !vi_already_subscribed_by_another_apps_.empty(); mobile_apis::Result::eType result_code = MessageHelper::HMIToMobileResult(hmi_result); if (is_succeeded) { if (!vi_already_subscribed_by_this_app_.empty()) { result_code = mobile_apis::Result::IGNORED; response_info = "Already subscribed on some provided VehicleData."; } if (!vi_waiting_for_subscribe_.empty()) { LOG4CXX_DEBUG(logger_, "Subscribing to all pending VehicleData"); VehicleInfoSubscriptions::const_iterator key = vi_waiting_for_subscribe_.begin(); for (; key != vi_waiting_for_subscribe_.end(); ++key) { auto& ext = VehicleInfoAppExtension::ExtractVIExtension(*app); ext.subscribeToVehicleInfo(*key); } } } UnsubscribeFailedSubscriptions(app, message[strings::msg_params]); if (!vi_already_subscribed_by_another_apps_.empty() || !vi_already_subscribed_by_this_app_.empty()) { AddAlreadySubscribedVI( const_cast(message[strings::msg_params])); } SendResponse(is_succeeded, result_code, response_info.empty() ? NULL : response_info.c_str(), &(message[strings::msg_params])); } bool SubscribeVehicleDataRequest::Init() { hash_update_mode_ = HashUpdateMode::kDoHashUpdate; return true; } void SubscribeVehicleDataRequest::AddAlreadySubscribedVI( smart_objects::SmartObject& msg_params) const { LOG4CXX_AUTO_TRACE(logger_); using namespace mobile_apis; auto vi_to_string = [](const mobile_apis::VehicleDataType::eType vehicle_data) { for (auto& vi_str_to_int_pair : MessageHelper::vehicle_data()) { if (vehicle_data == vi_str_to_int_pair.second) { return vi_str_to_int_pair.first; } } return std::string(); }; VehicleInfoSubscriptions::const_iterator it_same_app = vi_already_subscribed_by_this_app_.begin(); for (; vi_already_subscribed_by_this_app_.end() != it_same_app; ++it_same_app) { msg_params[vi_to_string(*it_same_app)][strings::result_code] = VehicleDataResultCode::VDRC_DATA_ALREADY_SUBSCRIBED; msg_params[vi_to_string(*it_same_app)][strings::data_type] = *it_same_app; } VehicleInfoSubscriptions::const_iterator it_another_app = vi_already_subscribed_by_another_apps_.begin(); for (; vi_already_subscribed_by_another_apps_.end() != it_another_app; ++it_another_app) { msg_params[vi_to_string(*it_another_app)][strings::result_code] = VehicleDataResultCode::VDRC_SUCCESS; msg_params[vi_to_string(*it_another_app)][strings::data_type] = *it_another_app; } } void SubscribeVehicleDataRequest::UnsubscribeFailedSubscriptions( ApplicationSharedPtr app, const smart_objects::SmartObject& msg_params) const { LOG4CXX_AUTO_TRACE(logger_); const VehicleData& vehicle_data = MessageHelper::vehicle_data(); VehicleData::const_iterator it = vehicle_data.begin(); for (; vehicle_data.end() != it; ++it) { if (msg_params.keyExists(it->first)) { if (msg_params[it->first][strings::result_code].asInt() != hmi_apis::Common_VehicleDataResultCode::VDRC_SUCCESS) { LOG4CXX_DEBUG(logger_, "Subscription for VehicleDataType " << it->first << " is unsuccessfull. " "Unsubscribing app with connection key " << connection_key() << " from it."); VehicleInfoAppExtension::ExtractVIExtension(*app) .unsubscribeFromVehicleInfo(it->second); } } } } struct SubscribedToIVIPredicate { int32_t vehicle_info_; SubscribedToIVIPredicate(int32_t vehicle_info) : vehicle_info_(vehicle_info) {} bool operator()(const ApplicationSharedPtr app) const { DCHECK_OR_RETURN(app, false); auto& ext = VehicleInfoAppExtension::ExtractVIExtension(*app); return ext.isSubscribedToVehicleInfo( static_cast(vehicle_info_)); } }; bool SubscribeVehicleDataRequest::IsSomeoneSubscribedFor( const uint32_t param_id) const { LOG4CXX_AUTO_TRACE(logger_); SubscribedToIVIPredicate finder(param_id); DataAccessor accessor = application_manager_.applications(); ApplicationSetConstIt it = std::find_if( accessor.GetData().begin(), accessor.GetData().end(), finder); return it != accessor.GetData().end(); } void SubscribeVehicleDataRequest::CheckVISubscribtions( ApplicationSharedPtr app, std::string& out_info, mobile_apis::Result::eType& out_result_code, smart_objects::SmartObject& out_response_params, smart_objects::SmartObject& out_request_params, bool& out_result) { CheckVISubscriptions(app, out_info, out_result_code, out_response_params, out_request_params, out_result); } void SubscribeVehicleDataRequest::CheckVISubscriptions( ApplicationSharedPtr app, std::string& out_info, mobile_apis::Result::eType& out_result_code, smart_objects::SmartObject& out_response_params, smart_objects::SmartObject& out_request_params, bool& out_result) { // counter for items to subscribe VehicleInfoSubscriptions::size_type items_to_subscribe = 0; // counter for subscribed items by application uint32_t subscribed_items = 0; const VehicleData& vehicle_data = MessageHelper::vehicle_data(); VehicleData::const_iterator it = vehicle_data.begin(); HmiInterfaces::InterfaceState interface_state = application_manager_.hmi_interfaces().GetInterfaceState( HmiInterfaces::HMI_INTERFACE_VehicleInfo); const bool is_interface_not_available = interface_state == HmiInterfaces::STATE_NOT_AVAILABLE; for (; vehicle_data.end() != it; ++it) { const std::string& key_name = it->first; if ((*message_)[strings::msg_params].keyExists(key_name)) { const bool is_key_enabled = (*message_)[strings::msg_params][key_name].asBool(); if (is_key_enabled) { ++items_to_subscribe; } if (!is_interface_not_available && is_key_enabled) { mobile_apis::VehicleDataType::eType key_type = it->second; const auto is_subscribed = VehicleInfoAppExtension::ExtractVIExtension(*app) .isSubscribedToVehicleInfo(key_type); if (is_subscribed) { LOG4CXX_DEBUG(logger_, "App with connection key " << connection_key() << " is subscribed already for VehicleDataType: " << key_type); ++subscribed_items; vi_already_subscribed_by_this_app_.insert(key_type); out_response_params[key_name][strings::data_type] = key_type; out_response_params[key_name][strings::result_code] = mobile_apis::VehicleDataResultCode::VDRC_DATA_ALREADY_SUBSCRIBED; continue; } if (IsSomeoneSubscribedFor(key_type)) { LOG4CXX_DEBUG(logger_, "There are apps subscribed already for " "VehicleDataType: " << key_type); auto& ext = VehicleInfoAppExtension::ExtractVIExtension(*app); if (!ext.subscribeToVehicleInfo(key_type)) { LOG4CXX_ERROR( logger_, "Unable to subscribe for VehicleDataType: " << key_type); continue; } LOG4CXX_DEBUG( logger_, "App with connection key " << connection_key() << " have been subscribed for VehicleDataType: " << key_type); ++subscribed_items; vi_already_subscribed_by_another_apps_.insert(key_type); out_response_params[key_name][strings::data_type] = key_type; out_response_params[key_name][strings::result_code] = mobile_apis::VehicleDataResultCode::VDRC_SUCCESS; continue; } out_request_params[key_name] = is_key_enabled; if (is_key_enabled) { vi_waiting_for_subscribe_.insert(key_type); LOG4CXX_DEBUG( logger_, "App with connection key " << connection_key() << " will be subscribed for VehicleDataType: " << key_type); ++subscribed_items; } } } } const bool is_everything_already_subscribed = items_to_subscribe == vi_already_subscribed_by_another_apps_.size() + vi_already_subscribed_by_this_app_.size(); if (0 == items_to_subscribe) { if (HasDisallowedParams()) { out_result_code = mobile_apis::Result::DISALLOWED; } else { out_result_code = mobile_apis::Result::INVALID_DATA; out_info = "No data in the request"; } out_result = false; } if (0 == subscribed_items && !is_interface_not_available) { out_result_code = mobile_apis::Result::IGNORED; out_info = "Already subscribed on provided VehicleData."; out_result = false; } if (is_everything_already_subscribed) { out_result_code = vi_already_subscribed_by_this_app_.size() ? mobile_apis::Result::IGNORED : mobile_apis::Result::SUCCESS; if (!(vi_already_subscribed_by_this_app_.empty())) { out_info = "Already subscribed on some provided VehicleData."; } out_result = true; } } } // namespace commands } // namespace application_manager