diff options
Diffstat (limited to 'src/components/application_manager/src/commands/mobile/system_request.cc')
| -rw-r--r-- | src/components/application_manager/src/commands/mobile/system_request.cc | 690 |
1 files changed, 0 insertions, 690 deletions
diff --git a/src/components/application_manager/src/commands/mobile/system_request.cc b/src/components/application_manager/src/commands/mobile/system_request.cc deleted file mode 100644 index f0331d0ced..0000000000 --- a/src/components/application_manager/src/commands/mobile/system_request.cc +++ /dev/null @@ -1,690 +0,0 @@ -/* - -Copyright (c) 2013, 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. - */ - -#include "application_manager/commands/mobile/system_request.h" - -#include <vector> -#include <string> -#include <stdio.h> -#include <algorithm> -#include <sstream> -#include "application_manager/policies/policy_handler_interface.h" -#include "interfaces/MOBILE_API.h" -#include "utils/file_system.h" -#include "policy/policy_table/enums.h" -#include "formatters/CFormatterJsonBase.h" -#include "json/json.h" -#include "utils/helpers.h" -#include "utils/custom_string.h" - -namespace application_manager { - -CREATE_LOGGERPTR_LOCAL(logger_, "ApplicationManager") -namespace { - -#ifdef ENABLE_LOG -const char* kQueryAppsValidationFailedPrefix = - ":QUERY_APPS_VALIDATION_FAILED: "; -#endif - -const unsigned int kVrSynonymLengthMax = 40U; -const unsigned int kVrSynonymLengthMin = 1U; -const unsigned int kTtsNameLengthMax = 500U; -const unsigned int kVrArraySizeMax = 100U; -const unsigned int kVrArraySizeMin = 1U; -const unsigned int kUrlSchemaLengthMax = 255U; -const unsigned int kPackageNameLengthMax = 255U; -const unsigned int kAppIdLengthMax = 40U; -const unsigned int kAppNameLengthMax = 100U; -const unsigned int kLanguageArraySizeMax = 100U; - -class QueryAppsDataValidator { - public: - typedef std::set<std::string> SynonymsSet; - typedef std::map<std::string, SynonymsSet> SynonymsMap; - - QueryAppsDataValidator(smart_objects::SmartObject& object, - const ApplicationManager& manager) - : data_(object), manager_(manager) {} - - bool Validate() { - LOG4CXX_AUTO_TRACE(logger_); - if (!data_.isValid()) { - LOG4CXX_ERROR(logger_, - kQueryAppsValidationFailedPrefix - << "QueryApps response is not valid."); - return false; - } - if (!HasResponseKey()) { - return false; - } - return ValidateAppDataAndOsAndLanguagesData(); - } - - private: - bool HasResponseKey() const { - if (!data_.keyExists(json::response)) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "QueryApps response does not contain '" - << json::response << "' parameter."); - return false; - } - return true; - } - - bool ValidateAppDataAndOsAndLanguagesData() { - smart_objects::SmartArray* objects_array = data_[json::response].asArray(); - - if (!objects_array) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "QueryApps response is not array."); - return false; - } - - SynonymsMap synonyms_map; - bool has_response_valid_application = false; - - smart_objects::SmartArray::iterator applications_iterator = - objects_array->begin(); - - for (; applications_iterator != objects_array->end();) { - const smart_objects::SmartObject& app_data = *applications_iterator; - - if (!app_data.isValid()) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "Wrong application data in json file."); - return false; - } - - if (!CheckMandatoryParametersPresent(app_data)) { - LOG4CXX_WARN(logger_, - "Application hasn`t some of mandatory parameters. " - "Application will be skipped."); - - applications_iterator = objects_array->erase(applications_iterator); - continue; - } - - if (!ValidateAppIdAndAppName(app_data)) { - return false; - } - - // If we dont have any of android/ios field - // we skip this json in CheckMandatoryParametersPresent - const std::string os_type = - (app_data.keyExists(json::android)) ? json::android : json::ios; - - // Verify os and dependent languages data - if (json::ios == os_type) { - if (app_data[json::ios][json::urlScheme].asString().length() > - kUrlSchemaLengthMax) { - LOG4CXX_WARN( - logger_, - kQueryAppsValidationFailedPrefix - << "An urlscheme length exceeds maximum allowed [" - << app_data[json::ios][json::urlScheme].asString().length() - << "]>[" << kUrlSchemaLengthMax << "]"); - return false; - } - } - - if (json::android == os_type) { - if (app_data[json::android][json::packageName].asString().length() > - kPackageNameLengthMax) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "Package name length [" - << app_data[json::android][json::packageName] - .asString() - .length() << "] exceeds max length [" - << kPackageNameLengthMax << "]in json file."); - return false; - } - } - - // Languages verification - if (!app_data[os_type].keyExists(json::languages)) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "'languages' doesn't exist"); - return false; - } - if (!ValidateLanguages(app_data[os_type][json::languages], - synonyms_map)) { - return false; - } - has_response_valid_application = true; - ++applications_iterator; - } - return has_response_valid_application; - } - - bool ValidateAppIdAndAppName(const smart_objects::SmartObject& app_data) { - // Verify appid length - const std::string app_id(app_data[json::appId].asString()); - if (app_id.length() > kAppIdLengthMax) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "An Object ID length exceeds maximum allowed [" - << app_id.length() << "]>[" << kAppIdLengthMax << "]"); - return false; - } - - // Verify that appid is unique - if (applications_id_set_.find(app_id) != applications_id_set_.end()) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "An Object ID is not unigue [" << app_id << "]"); - return false; - } - applications_id_set_.insert(app_id); - - // Verify that app is not registered yet - ApplicationSharedPtr registered_app = - manager_.application_by_policy_id(app_id); - if (registered_app) { - LOG4CXX_INFO(logger_, - "Application with the id: " << app_id - << " is already registered."); - } - // And app name length - const std::string appName(app_data[json::name].asString()); - if (appName.length() > kAppNameLengthMax) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "Name of application exceeds maximum allowed [" - << appName.length() << "]>[" << kAppNameLengthMax - << "]."); - return false; - } - return true; - } - - bool ValidateLanguages(const smart_objects::SmartObject& languages, - SynonymsMap& synonyms_map) const { - bool default_language_found = false; - const size_t languages_array_size = languages.length(); - if (languages_array_size > kLanguageArraySizeMax) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "'languages' array exceeds max size [" - << languages_array_size << "]>[" << kLanguageArraySizeMax - << "]"); - return false; - } - // Every language has ttsname string and vrsynonyms array - for (size_t idx = 0; idx < languages_array_size; ++idx) { - const smart_objects::SmartObject& language = languages.getElement(idx); - if (smart_objects::SmartType_Map != language.getType()) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "language is not a map."); - return false; - } - if (language.length() != 1) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "language map size is not equal 1."); - return false; - } - const std::string language_name = (*language.map_begin()).first; - if (!language_name.length()) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "language name is empty"); - return false; - } - // Verify default language defined - if (!(language_name).compare(json::default_)) { - default_language_found = true; - } - // Add set for synonyms' duplicates validation - if (synonyms_map.find(language_name) == synonyms_map.end()) { - synonyms_map[language_name] = SynonymsSet(); - } - // ttsName verification - if (!language[language_name].keyExists(json::ttsName)) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "'languages.ttsName' doesn't exist"); - return false; - } - const smart_objects::SmartObject& ttsNameObject = - language[language_name][json::ttsName]; - // ttsName is string - if (smart_objects::SmartType_String == ttsNameObject.getType()) { - const std::string ttsName = - language[language_name][json::ttsName].asString(); - if (ttsName.length() > kTtsNameLengthMax) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "ttsName string exceeds max length [" - << ttsName.length() << "]>[" << kTtsNameLengthMax - << "]"); - return false; - } - } else { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "ttsName is not the string type."); - return false; - } - - if (!ValidateSynonymsAtLanguage(language, language_name, synonyms_map)) { - return false; - } - } - if (!default_language_found) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << " 'languages'.default' doesn't exist"); - return false; - } - return true; - } - - bool ValidateSynonymsAtLanguage(const smart_objects::SmartObject& language, - const std::string& language_name, - SynonymsMap& synonyms_map) const { - if (!language[language_name].keyExists(json::vrSynonyms)) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "'languages.vrSynonyms' doesn't exist"); - return false; - } - const smart_objects::SmartArray* synonyms_array = - language[language_name][json::vrSynonyms].asArray(); - if (!synonyms_array) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "vrSynonyms is not array."); - return false; - } - const size_t synonyms_array_size = synonyms_array->size(); - if (synonyms_array_size < kVrArraySizeMin) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "vrSynomyms array has [" << synonyms_array_size - << "] size < allowed min size [" << kVrArraySizeMin - << "]"); - return false; - } - if (synonyms_array_size > kVrArraySizeMax) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "vrSynomyms array size [" << synonyms_array_size - << "] exceeds maximum allowed size [" << kVrArraySizeMax - << "]"); - return false; - } - - for (std::size_t idx = 0; idx < synonyms_array_size; ++idx) { - const smart_objects::SmartObject& synonym = (*synonyms_array)[idx]; - const std::string vrSynonym = synonym.asString(); - if (vrSynonym.length() > kVrSynonymLengthMax) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "vrSYnomym item [" << idx - << "] exceeds max length [" << vrSynonym.length() - << "]>[" << kVrSynonymLengthMax << "]"); - return false; - } - if (vrSynonym.length() < kVrSynonymLengthMin) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "vrSYnomym item [" << idx << "] length [" - << vrSynonym.length() << "] is less then min length [" - << kVrSynonymLengthMin << "] allowed."); - return false; - } - // Verify duplicates - SynonymsMap::iterator synonyms_map_iter = - synonyms_map.find(language_name); - if (synonyms_map_iter != synonyms_map.end()) { - if (!(*synonyms_map_iter).second.insert(vrSynonym).second) { - LOG4CXX_WARN(logger_, - kQueryAppsValidationFailedPrefix - << "vrSYnomym item already defined [" - << vrSynonym.c_str() << "] for language [" - << language_name << "]"); - return false; - } - } - } - return true; - } - - bool CheckMandatoryParametersPresent( - const smart_objects::SmartObject& app_data) const { - if (!app_data.keyExists(json::android) && !app_data.keyExists(json::ios)) { - return false; - } - - if (app_data.keyExists(json::android) && - !app_data[json::android].keyExists(json::packageName)) { - return false; - } - - if (app_data.keyExists(json::ios) && - !app_data[json::ios].keyExists(json::urlScheme)) { - return false; - } - - if (!app_data.keyExists(json::appId)) { - return false; - } - - if (!app_data.keyExists(json::name)) { - return false; - } - - return true; - } - - smart_objects::SmartObject& data_; - std::set<std::string> applications_id_set_; - const ApplicationManager& manager_; - - DISALLOW_COPY_AND_ASSIGN(QueryAppsDataValidator); -}; -} - -namespace commands { - -namespace custom_str = utils::custom_string; - -uint32_t SystemRequest::index = 0; - -const std::string kSYNC = "SYNC"; -const std::string kIVSU = "IVSU"; - -SystemRequest::SystemRequest(const MessageSharedPtr& message, - ApplicationManager& application_manager) - : CommandRequestImpl(message, application_manager) {} - -SystemRequest::~SystemRequest() {} - -void SystemRequest::Run() { - LOG4CXX_AUTO_TRACE(logger_); - - ApplicationSharedPtr application = - application_manager_.application(connection_key()); - - if (!(application.valid())) { - LOG4CXX_ERROR(logger_, "NULL pointer"); - SendResponse(false, mobile_apis::Result::APPLICATION_NOT_REGISTERED); - return; - } - - const mobile_apis::RequestType::eType request_type = - static_cast<mobile_apis::RequestType::eType>( - (*message_)[strings::msg_params][strings::request_type].asInt()); - - const policy::PolicyHandlerInterface& policy_handler = - application_manager_.GetPolicyHandler(); - - const std::string stringified_request_type = - rpc::policy_table_interface_base::EnumToJsonString( - static_cast<rpc::policy_table_interface_base::RequestType>( - request_type)); - - if (!policy_handler.IsRequestTypeAllowed(application->policy_app_id(), - request_type)) { - LOG4CXX_ERROR(logger_, - "RequestType " << stringified_request_type - << " is DISALLOWED by policies"); - SendResponse(false, mobile_apis::Result::DISALLOWED); - return; - } - LOG4CXX_TRACE(logger_, - "RequestType " << stringified_request_type << " is ALLOWED"); - - const bool request_subtype_present = - (*message_)[strings::msg_params].keyExists(strings::request_subtype); - if (request_subtype_present) { - const std::string request_subtype = - (*message_)[strings::msg_params][strings::request_subtype].asString(); - if (!policy_handler.IsRequestSubTypeAllowed(application->policy_app_id(), - request_subtype)) { - LOG4CXX_ERROR(logger_, - "Request subtype: " << request_subtype - << " is DISALLOWED by policies"); - SendResponse(false, mobile_apis::Result::DISALLOWED); - return; - } - LOG4CXX_TRACE(logger_, - "Request subtype: " << request_subtype << " is ALLOWED"); - } - - std::string file_name = kSYNC; - if ((*message_)[strings::msg_params].keyExists(strings::file_name)) { - file_name = (*message_)[strings::msg_params][strings::file_name].asString(); - } - - if (!CheckSyntax(file_name)) { - LOG4CXX_ERROR(logger_, - "Incoming request contains \t\n \\t \\n or whitespace"); - SendResponse(false, mobile_apis::Result::INVALID_DATA); - return; - } - - if (!file_system::IsFileNameValid(file_name)) { - const std::string err_msg = "Sync file name contains forbidden symbols."; - LOG4CXX_ERROR(logger_, err_msg); - SendResponse(false, mobile_apis::Result::INVALID_DATA, err_msg.c_str()); - return; - } - - const bool is_system_file = std::string::npos != file_name.find(kSYNC) || - std::string::npos != file_name.find(kIVSU); - - // to avoid override existing file - if (is_system_file) { - const uint8_t max_size = 255; - char buf[max_size] = {'\0'}; - snprintf(buf, max_size - 1, "%d%s", index++, file_name.c_str()); - file_name = buf; - } - - std::vector<uint8_t> binary_data; - std::string binary_data_folder; - if ((*message_)[strings::params].keyExists(strings::binary_data)) { - binary_data = (*message_)[strings::params][strings::binary_data].asBinary(); - binary_data_folder = - application_manager_.get_settings().system_files_path(); - } else { - binary_data_folder = - application_manager_.get_settings().app_storage_folder(); - binary_data_folder += "/"; - binary_data_folder += application->folder_name(); - binary_data_folder += "/"; - } - - std::string file_dst_path = - application_manager_.get_settings().system_files_path(); - file_dst_path += "/"; - file_dst_path += file_name; - - if ((*message_)[strings::params].keyExists(strings::binary_data)) { - LOG4CXX_DEBUG( - logger_, - "Binary data is present. Trying to save it to: " << binary_data_folder); - if (mobile_apis::Result::SUCCESS != - (application_manager_.SaveBinary( - binary_data, binary_data_folder, file_name, 0))) { - LOG4CXX_DEBUG(logger_, "Binary data can't be saved."); - SendResponse(false, mobile_apis::Result::GENERIC_ERROR); - return; - } - } else { - std::string app_full_file_path = binary_data_folder; - app_full_file_path += file_name; - - LOG4CXX_DEBUG(logger_, - "Binary data is not present. Trying to find file " - << file_name << " within previously saved app file in " - << binary_data_folder); - - const AppFile* file = application->GetFile(app_full_file_path); - if (!file || !file->is_download_complete || - !file_system::MoveFile(app_full_file_path, file_dst_path)) { - LOG4CXX_DEBUG(logger_, "Binary data not found."); - SendResponse(false, mobile_apis::Result::REJECTED); - return; - } - processing_file_ = file_dst_path; - } - - LOG4CXX_DEBUG(logger_, "Binary data ok."); - - if (mobile_apis::RequestType::HTTP == request_type && - (*message_)[strings::msg_params].keyExists(strings::file_name)) { - const std::string& file = - (*message_)[strings::msg_params][strings::file_name].asString(); - application_manager_.GetPolicyHandler().ReceiveMessageFromSDK(file, - binary_data); - SendResponse(true, mobile_apis::Result::SUCCESS); - return; - } else if (mobile_apis::RequestType::QUERY_APPS == request_type) { - using namespace NsSmartDeviceLink::NsJSONHandler::Formatters; - - smart_objects::SmartObject sm_object; - Json::Reader reader; - std::string json(binary_data.begin(), binary_data.end()); - Json::Value root; - if (!reader.parse(json.c_str(), root)) { - LOG4CXX_DEBUG(logger_, "Unable to parse query_app json file."); - return; - } - - CFormatterJsonBase::jsonValueToObj(root, sm_object); - if (!ValidateQueryAppData(sm_object)) { - SendResponse(false, mobile_apis::Result::GENERIC_ERROR); - return; - } - - application_manager_.ProcessQueryApp(sm_object, connection_key()); - SendResponse(true, mobile_apis::Result::SUCCESS); - return; - } - - smart_objects::SmartObject msg_params = - smart_objects::SmartObject(smart_objects::SmartType_Map); - if (std::string::npos != file_name.find(kIVSU)) { - msg_params[strings::file_name] = file_name; - } else { - msg_params[strings::file_name] = file_dst_path; - } - - // expected int, mandatory=true, all Policies flow (HTTP,Proprietary,External) - msg_params[strings::app_id] = application->hmi_app_id(); - - msg_params[strings::request_type] = - (*message_)[strings::msg_params][strings::request_type]; - if (request_subtype_present) { - msg_params[strings::request_subtype] = - (*message_)[strings::msg_params][strings::request_subtype]; - } - StartAwaitForInterface(HmiInterfaces::HMI_INTERFACE_BasicCommunication); - SendHMIRequest(hmi_apis::FunctionID::BasicCommunication_SystemRequest, - &msg_params, - true); -} - -void SystemRequest::on_event(const event_engine::Event& event) { - LOG4CXX_AUTO_TRACE(logger_); - using namespace helpers; - - const smart_objects::SmartObject& message = event.smart_object(); - - switch (event.id()) { - case hmi_apis::FunctionID::BasicCommunication_SystemRequest: { - EndAwaitForInterface(HmiInterfaces::HMI_INTERFACE_BasicCommunication); - mobile_apis::Result::eType result_code = - GetMobileResultCode(static_cast<hmi_apis::Common_Result::eType>( - message[strings::params][hmi_response::code].asUInt())); - - const bool result = Compare<mobile_api::Result::eType, EQ, ONE>( - result_code, - mobile_api::Result::SUCCESS, - mobile_api::Result::WARNINGS); - - ApplicationSharedPtr application = - application_manager_.application(connection_key()); - - if (!(application.valid())) { - LOG4CXX_ERROR(logger_, "NULL pointer"); - return; - } - - if (!processing_file_.empty()) { - file_system::DeleteFile(processing_file_); - processing_file_.clear(); - } - - SendResponse(result, result_code, NULL, &(message[strings::msg_params])); - break; - } - default: { - LOG4CXX_ERROR(logger_, "Received unknown event" << event.id()); - return; - } - } -} - -bool SystemRequest::ValidateQueryAppData( - smart_objects::SmartObject& data) const { - if (!data.isValid()) { - LOG4CXX_ERROR(logger_, - kQueryAppsValidationFailedPrefix - << "QueryApps response is not valid."); - return false; - } - if (!data.keyExists(json::response)) { - LOG4CXX_ERROR(logger_, - kQueryAppsValidationFailedPrefix - << "QueryApps response does not contain '" - << json::response << "' parameter."); - return false; - } - - QueryAppsDataValidator validator(data, application_manager_); - return validator.Validate(); -} - -} // namespace commands - -} // namespace application_manager |