AppLaunchData common implementation

Related issue : APPLINK-24892

5 files changed, 513 insertions, 2 deletions

diff --git a/src/components/application_manager/include/application_manager/app_launch/app_launch_data.h b/src/components/application_manager/include/application_manager/app_launch/app_launch_data.h
index 7c875520aa..0d52384018 100644
--- a/src/components/application_manager/include/application_manager/app_launch/app_launch_data.h
+++ b/src/components/application_manager/include/application_manager/app_launch/app_launch_data.h
@@ -81,8 +81,8 @@ class AppLaunchData {
   /**
    * @brief select from DB all records with this dev_mac
    * @param app_data - data to inserting
-   * @param dev_apps - pointer to vector with result of select
-   * @return true in success cases and false othrewise
+   * @param dev_apps -
+   * @return vector of pointers on results of select
    */
   virtual std::vector<ApplicationDataPtr> GetApplicationDataByDevice(
       const std::string& dev_mac) = 0;
diff --git a/src/components/application_manager/include/application_manager/app_launch/app_launch_data_db.h b/src/components/application_manager/include/application_manager/app_launch/app_launch_data_db.h
new file mode 100644
index 0000000000..92d6bbd9ef
--- /dev/null
+++ b/src/components/application_manager/include/application_manager/app_launch/app_launch_data_db.h
@@ -0,0 +1,168 @@
+/*
+ * Copyright (c) 2016, 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_APP_LAUNCH_APP_LAUNCH_DATA_DB_H_
+#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_DATA_DB_H_
+#include <memory>
+#include "application_manager/app_launch/app_launch_data_impl.h"
+#include "application_manager/app_launch_settings.h"
+#include "utils/macro.h"
+#ifdef __QNX__
+#include "utils/qdb_wrapper/sql_database.h"
+#include "utils/qdb_wrapper/sql_query.h"
+#else  // linux
+#include "utils/sqlite_wrapper/sql_database.h"
+#include "utils/sqlite_wrapper/sql_query.h"
+#endif
+
+namespace app_launch {
+
+const std::string kDatabaseName = "resumption";
+
+/**
+ * @brief Show should database be saved in a disk file or in memory
+ */
+enum DbStorage { In_Memory_Storage = 0, In_File_Storage };
+
+/**
+ * @brief class contains logic for representation application
+ * launch_app data in data base
+ */
+class AppLaunchDataDB : public AppLaunchDataImpl {
+ public:
+  /**
+   * @brief Constructor of AppLaunchDataDB
+   * @param settings - setting of AppLaunch
+   */
+  AppLaunchDataDB(const AppLaunchSettings& settings,
+                  DbStorage db_storage = In_File_Storage);
+
+  /**
+   * @brief allows to destroy AppLaunchDataDB object
+   */
+  ~AppLaunchDataDB();
+
+  /**
+   * @brief Creates or opens DB and initialize it
+   * @return false if DB doesn't initialize
+   * otherwise returns true
+   */
+  bool Init();
+
+  /**
+   * @brief delete App_launch table in DB, after calling this
+   * one, it should again call init
+   * @return true in success cases and false othrewise
+   */
+  bool Clear() OVERRIDE;
+
+  /**
+   * @brief Write database to file system
+   */
+  bool Persist() OVERRIDE;
+
+  /**
+   * @return current count of records
+   * AppLaunch in DB
+   */
+  uint32_t GetCurentNumberOfAppData() const;
+
+  /**
+   * @param app_data - searching fields in object
+   * @return  true in case application data already existed
+   * and false othrewise
+   */
+  bool IsAppDataAlreadyExisted(const ApplicationData& app_data) const OVERRIDE;
+
+  /**
+  * @brief returns pointer to data base
+  */
+  utils::dbms::SQLDatabase* db() const;
+
+  enum ApplicationDataDBIndexes {
+    result_query = 0,
+    device_mac_index = 0,
+    application_id_index,
+    bundle_id_index,
+    timestamp_index
+  };
+
+ private:
+  /**
+   * @brief update time stamp
+   * @param app_data - data to update
+   * @return true in success cases and false othrewise
+   */
+  bool RefreshAppSessionTime(const ApplicationData& app_data) OVERRIDE;
+
+  /**
+   * @brief insert new data to DB
+   * @param app_data - data to inserting
+   * @return true in success cases and false othrewise
+   */
+  bool AddNewAppData(const ApplicationData& app_data) OVERRIDE;
+
+  /**
+   * @brief select from DB all records with this dev_mac
+   * @param app_data - data to inserting
+   * @return vector of ponter on founded records
+   */
+  std::vector<ApplicationDataPtr> GetAppDataByDevMac(
+      const std::string& dev_mac) const OVERRIDE;
+  /**
+   * @brief delete record with oldest timestamp
+   * @return true in success cases and false othrewise
+   */
+  bool DeleteOldestAppData() OVERRIDE;
+
+  /**
+   * @brief write DB to file
+   * @return true in success cases and false othrewise
+   */
+  bool WriteDb();
+
+  /**
+  * @brief returns pointer to data base
+  */
+  std::auto_ptr<utils::dbms::SQLDatabase> db_;
+
+  /**
+  * @brief indicate initializing status of DB
+  */
+  bool init_successeful_;
+
+  DISALLOW_COPY_AND_ASSIGN(AppLaunchDataDB);
+};
+
+}  // namespace app_launch
+
+#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_DATA_DB_H_
diff --git a/src/components/application_manager/include/application_manager/app_launch/app_launch_data_impl.h b/src/components/application_manager/include/application_manager/app_launch/app_launch_data_impl.h
new file mode 100644
index 0000000000..111ff25ab2
--- /dev/null
+++ b/src/components/application_manager/include/application_manager/app_launch/app_launch_data_impl.h
@@ -0,0 +1,136 @@
+/*
+ * Copyright (c) 2016, 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_APP_LAUNCH_APP_LAUNCH_DATA_IMPL_H_
+#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_DATA_IMPL_H_
+
+#include "application_manager/app_launch/app_launch_data.h"
+#include "application_manager/app_launch_settings.h"
+
+namespace app_launch {
+
+class AppLaunchDataImpl : public AppLaunchData {
+ public:
+  /**
+   * @brief Constructor of AppLaunchDataImpl
+   * @param settings - setting of AppLaunch
+   */
+  AppLaunchDataImpl(const AppLaunchSettings& settings);
+
+  /**
+   * @brief allows to destroy AppLaunchDataImpl object
+   */
+  virtual ~AppLaunchDataImpl();
+
+  /**
+   * @brief insert new data to DB
+   * @param app_data - data to inserting
+   * @return true in success cases and false othrewise
+   */
+  virtual bool AddApplicationData(const ApplicationData& app_data);
+
+  /**
+   * @brief select from DB all records with this dev_mac
+   * @param app_data - data to inserting
+   * @return return vector of pointers on founded records
+   */
+  std::vector<ApplicationDataPtr> GetApplicationDataByDevice(
+      const std::string& dev_mac) OVERRIDE;
+
+  /**
+   * @brief Persist saves resumption data on file system
+   */
+  virtual bool Persist() = 0;
+
+  /**
+   * @return max count of iOS device that can be connected
+   */
+  virtual uint32_t get_max_number_iOS_devs() const {
+    return kMaxNumberOfiOSdevice;
+  }
+
+  /**
+   * @brief all AppLaunch settings
+   */
+  const AppLaunchSettings& settings_;
+
+ private:
+  /**
+   * @param app_data - searching filled in object
+   * @return  true in case application data already existed
+   * and false othrewise
+   */
+  virtual bool IsAppDataAlreadyExisted(
+      const ApplicationData& app_data) const = 0;
+
+  /**
+   * @brief update time stamp
+   * @param app_data - data to update
+   * @return true in success cases and false othrewise
+   */
+  virtual bool RefreshAppSessionTime(const ApplicationData& app_data) = 0;
+
+  /**
+   * @brief insert new data to DB
+   * @param app_data - data to inserting
+   * @return true in success cases and false othrewise
+   */
+  virtual bool AddNewAppData(const ApplicationData& app_data) = 0;
+
+  /**
+   * @brief select from DB all records with this dev_mac
+   * @param app_data - data to inserting
+   * @return vector of ponter on founded records
+   */
+  virtual std::vector<ApplicationDataPtr> GetAppDataByDevMac(
+      const std::string& dev_mac) const = 0;
+
+  /**
+   * @brief delete record with oldest timestamp
+   * @return true in success cases and false othrewise
+   */
+  virtual bool DeleteOldestAppData() = 0;
+
+  /**
+   * @return current count of records
+   * AppLaunch in DB
+   */
+  virtual uint32_t GetCurentNumberOfAppData() const = 0;
+
+  /**
+   * @brief max count of iOS device that can be connected
+   */
+  const uint32_t kMaxNumberOfiOSdevice;
+};
+}  // namespace app_launch
+
+#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_DATA_IMPL_H_
diff --git a/src/components/application_manager/include/application_manager/app_launch/app_launch_data_json.h b/src/components/application_manager/include/application_manager/app_launch/app_launch_data_json.h
new file mode 100644
index 0000000000..61117e552b
--- /dev/null
+++ b/src/components/application_manager/include/application_manager/app_launch/app_launch_data_json.h
@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2016, 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_APP_LAUNCH_APP_LAUNCH_DATA_JSON_H_
+#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_DATA_JSON_H_
+
+#include "application_manager/app_launch/app_launch_data_impl.h"
+#include "smart_objects/smart_object.h"
+#include "resumption/last_state.h"
+#include "utils/lock.h"
+#include "utils/macro.h"
+
+namespace app_launch {
+
+enum { NotFound = -1 };
+/**
+ * @brief class contains logic for representation application launch_app data in
+ * json file
+ */
+class AppLaunchDataJson : public AppLaunchDataImpl {
+ public:
+  /**
+   * @brief Constructor of AppLaunchDataJson object
+   */
+  AppLaunchDataJson(const AppLaunchSettings& settings,
+                    resumption::LastState& last_state);
+  /**
+   * @brief allows to destroy AppLaunchDataJson object
+   */
+  ~AppLaunchDataJson();
+
+  /**
+   * @brief Write Json to file system
+   */
+  bool Persist() OVERRIDE;
+
+  /**
+   * @brief delete App_launch table in DB, after calling this
+   * one, it should again call init
+   * @return true in success cases and false othrewise
+   */
+  virtual bool Clear();
+
+  /**
+   * @return current count of records
+   * AppLaunch in DB
+   */
+  uint32_t GetCurentNumberOfAppData() const;
+
+  /**
+   * @param app_data - searching filled in object
+   * @return  true in case application data already existed
+   * and false othrewise
+   */
+  virtual bool IsAppDataAlreadyExisted(const ApplicationData& app_data) const;
+
+  /**
+   * @param app_data - searching filled in object
+   * @param founded_index - referenceto index of founded record
+   * in case it wasn't found it'll be -1
+   * @return  pointer to json list object
+   */
+  Json::Value& GetApplicationListAndIndex(const ApplicationData& app_data,
+                                          int32_t& founded_index) const;
+
+ private:
+  /**
+   * @brief update time stamp
+   * @param app_data - data to update
+   * @return true in success cases and false othrewise
+   */
+  virtual bool RefreshAppSessionTime(const ApplicationData& app_data);
+
+  /**
+   * @brief insert new data to DB
+   * @param app_data - data to inserting
+   * @return true in success cases and false othrewise
+   */
+  virtual bool AddNewAppData(const ApplicationData& app_data);
+
+  /**
+   * @brief select from DB all records with this dev_mac
+   * @param app_data - data to inserting
+   * @return vector of pointer on founded records
+   */
+  std::vector<ApplicationDataPtr> GetAppDataByDevMac(
+      const std::string& dev_mac) const OVERRIDE;
+
+  /**
+   * @return pointer to LastState functionality
+   */
+  resumption::LastState& last_state() const {
+    return last_state_;
+  }
+
+  /**
+   * @brief delete record with oldest timestamp
+   * @return true in success cases and false othrewise
+   */
+  bool DeleteOldestAppData();
+
+  /**
+   * @return pointer to AppLaunch data block in Json file
+   */
+  Json::Value& GetSavedApplicationDataList() const;
+
+  /**
+   * @return pointer to AppLaunch records block in Json file
+   */
+  Json::Value& GetApplicationData() const;
+
+  /**
+   * @brief lock to protected common data
+   */
+  mutable sync_primitives::Lock app_launch_json_lock_;
+
+  /**
+   * @brief ponter to Last State object
+   */
+  resumption::LastState& last_state_;
+
+  DISALLOW_COPY_AND_ASSIGN(AppLaunchDataJson);
+};
+
+}  // namespace app_launch
+
+#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_DATA_JSON_H_
diff --git a/src/components/application_manager/include/application_manager/app_launch/app_launch_sql_queries.h b/src/components/application_manager/include/application_manager/app_launch/app_launch_sql_queries.h
new file mode 100644
index 0000000000..d70af6bba4
--- /dev/null
+++ b/src/components/application_manager/include/application_manager/app_launch/app_launch_sql_queries.h
@@ -0,0 +1,51 @@
+/*
+ *  Copyright (c) 2016, 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_APP_LAUNCH_APP_LAUNCH_SQL_QUERY_H_
+#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_SQL_QUERY_H_
+
+#include <string>
+
+namespace app_launch {
+
+extern const std::string kCreateSchema;
+extern const std::string kDropSchema;
+extern const std::string kFindApplicationData;
+extern const std::string kDeleteOldestAppData;
+extern const std::string kGetNumberOfApplicationData;
+extern const std::string kGetApplicationDataByDevID;
+extern const std::string kAddApplicationData;
+extern const std::string kRefreshApplicationDataSessionTime;
+
+}  // namespace app_launch
+
+#endif  //  SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APP_LAUNCH_APP_LAUNCH_SQL_QUERY_H_