Add MySQL Cache Manager & code cleanup

2016-05-21 11:17:08 +02:00
parent faa2570883
commit 8a8e4faa42
29 changed files with 844 additions and 69 deletions
@@ -0,0 +1,33 @@
+## Copyright 2016 Etix Labs
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+##     http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+
+cmake_minimum_required (VERSION 2.8.1)
+cmake_policy(SET CMP0042 NEW)
+
+project(mysql_cache_manager CXX)
+
+find_package(PkgConfig)
+
+include_directories (${PROJECT_SOURCE_DIR}/include ${CAMERADAR_INCLUDES})
+
+include (find_sources)
+find_sources ("src" "include")
+
+add_library (mysql_cache_manager SHARED ${SOURCES})
+set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--no-undefined")
+target_link_libraries (mysql_cache_manager jsoncpp mysqlcppconn pthread)
+
+set (CACHE_MANAGER_NAME ${CAMERADAR_CACHE_MANAGER_OUTPUT_PATH}/${CMAKE_SHARED_LIBRARY_PREFIX}mysql_cache_manager${CMAKE_SHARED_LIBRARY_SUFFIX})
+list (APPEND CAMERADAR_CACHE_MANAGERS ${CACHE_MANAGER_NAME})
+set (CAMERADAR_CACHE_MANAGERS ${CAMERADAR_CACHE_MANAGERS} PARENT_SCOPE)
@@ -0,0 +1,85 @@
+// Copyright 2016 Etix Labs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#include <cppconn/resultset.h> // for ResultSet
+#include <mutex>               // for mutex
+#include <stdbool.h>           // for bool, false
+#include <string>              // for string
+#include <utility>             // for pair, make_pair
+
+#include "query_result.h"
+
+namespace sql {
+class Connection;
+class Driver;
+class ResultSet;
+}
+
+namespace etix {
+
+namespace cameradar {
+
+namespace mysql {
+
+//! MySQL Database connection handling
+//! Abstracts all connection to the database
+class db_connection {
+private:
+    static const std::string create_database_query;
+
+    //! SQL driver
+    sql::Driver* driver = nullptr;
+    //! SQL connection
+    sql::Connection* connection = nullptr;
+    std::mutex access_mtx;
+    bool connected = false;
+
+    std::string db_name;
+
+    //! Create the database if it doesn't exist at connector launch
+    empty_result create_database(void);
+
+public:
+    db_connection(void);
+    ~db_connection(void);
+
+    //! Try to connect to the database
+    std::pair<bool, std::string> connect(const std::string& host,
+                                         const std::string& user,
+                                         const std::string& pass,
+                                         const std::string& db_name,
+                                         bool create_db_if_not_exist = true);
+
+    //! Execute a MySQL command
+    empty_result execute(const std::string& request);
+
+    //! Execute a query
+    query_result<sql::ResultSet*> query(const std::string& query);
+
+    bool is_connected();
+
+    //! Return db_name
+    const std::string&
+    get_db_name(void) const {
+        return this->db_name;
+    }
+};
+
+} // mysql
+
+} // cameradar
+
+} // etix
@@ -0,0 +1,81 @@
+// Copyright 2016 Etix Labs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#include <cachemanager.h>
+#include <configuration.h>
+#include <db_conn.h>
+#include <fmt.h>
+#include <logger.h>
+#include <stream_model.h>
+#include <vector>
+
+namespace etix {
+
+namespace cameradar {
+
+struct mysql_configuration {
+    unsigned int port;
+    std::string host;
+    std::string db_name;
+    std::string user;
+    std::string password;
+
+    mysql_configuration() = default;
+
+    mysql_configuration(unsigned int port,
+                        const std::string& host,
+                        const std::string& db_name,
+                        const std::string& user = "",
+                        const std::string& password = "")
+    : port(port), host(host), db_name(db_name), user(user), password(password) {}
+};
+
+class mysql_cache_manager : public cache_manager_base {
+private:
+    static const std::string name;
+    std::vector<etix::cameradar::stream_model> streams;
+    std::shared_ptr<etix::cameradar::configuration> configuration;
+    etix::cameradar::mysql_configuration db_conf;
+    etix::cameradar::mysql::db_connection connection;
+
+    static const std::string create_table_query;
+    static const std::string insert_with_id_query;
+    static const std::string exist_query;
+    static const std::string get_results_query;
+    static const std::string update_result_query;
+
+public:
+    using cache_manager_base::cache_manager_base;
+    ~mysql_cache_manager();
+
+    // Specific to MySQL
+    bool execute_query(const std::string& query);
+
+    const std::string& get_name() const override;
+    static const std::string& static_get_name();
+    bool load_mysql_conf(std::shared_ptr<etix::cameradar::configuration> configuration);
+    bool configure(std::shared_ptr<etix::cameradar::configuration> configuration) override;
+
+    void set_streams(std::vector<etix::cameradar::stream_model> model);
+
+    void update_stream(const etix::cameradar::stream_model& newmodel);
+
+    std::vector<etix::cameradar::stream_model> get_streams();
+
+    std::vector<etix::cameradar::stream_model> get_valid_streams();
+};
+}
+}
@@ -0,0 +1,65 @@
+// Copyright 2016 Etix Labs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+namespace etix {
+
+namespace cameradar {
+
+namespace mysql {
+
+enum class execute_result { success, not_found, no_row_updated, sql_error, error };
+
+//! Wrapper of a DB query result
+//! Templated on the data type we want to return (list<model>, bool, whatever)
+template <typename DataType>
+struct query_result {
+    DataType data;
+    execute_result state;
+    std::string error_msg;
+
+    inline bool
+    success(void) const {
+        return state == execute_result::success;
+    }
+    inline bool
+    error(void) const {
+        return not success();
+    }
+};
+
+//! Empty query result for when we just want to return the status
+//! of the request with no associated data
+template <>
+struct query_result<void> {
+    execute_result state;
+    std::string error_msg;
+
+    inline bool
+    success(void) const {
+        return state == execute_result::success;
+    }
+    inline bool
+    error(void) const {
+        return not success();
+    }
+};
+typedef query_result<void> empty_result;
+
+} //! mysql
+
+} //! cameradar
+
+} //! etix
@@ -0,0 +1,139 @@
+// Copyright 2016 Etix Labs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "db_conn.h"            // for db_connection
+#include "cppconn/connection.h" // for Connection
+#include "query_result.h"       // for queries
+#include <cppconn/driver.h>     // for get_driver_instance, etc
+#include <cppconn/exception.h>  // for SQLException
+#include <cppconn/statement.h>  // for Statement
+#include <fmt.h>                // for fmt
+#include <logger.h>             // for LOG_
+
+namespace etix {
+
+namespace cameradar {
+
+namespace mysql {
+
+const std::string db_connection::create_database_query = "CREATE DATABASE IF NOT EXISTS %s";
+
+db_connection::db_connection() : connected(false) {}
+
+db_connection::~db_connection() { delete this->connection; }
+
+std::pair<bool, std::string>
+db_connection::connect(const std::string& host,
+                       const std::string& user,
+                       const std::string& pass,
+                       const std::string& db_name,
+                       bool create_db_if_not_exist) {
+    this->db_name = db_name;
+
+    try {
+        this->driver = get_driver_instance();
+        if (this->driver == nullptr) {
+            return std::make_pair(false, "Cannot instantiate sql_driver");
+        }
+        this->connection = driver->connect(host, user, pass);
+        if (this->connection == nullptr) return std::make_pair(false, "Cannot connect to mysql");
+
+        this->connected = true;
+        if (create_db_if_not_exist) {
+            auto cdb = this->create_database();
+            if (cdb.state == mysql::execute_result::sql_error) { return { false, cdb.error_msg }; }
+            this->connection->setSchema(db_name);
+        }
+    } catch (sql::SQLException& e) {
+        this->connected = false;
+        return { false, e.what() };
+    }
+
+    return std::make_pair(true, "");
+}
+
+empty_result
+db_connection::execute(const std::string& request) {
+    std::lock_guard<std::mutex> lock(this->access_mtx);
+
+    sql::Statement* stmt = nullptr;
+    empty_result return_value = { execute_result::success, "" };
+
+    if (!this->is_connected()) {
+        return { execute_result::sql_error, "Error, not connected to MySQL database" };
+    }
+
+    try {
+        stmt = this->connection->createStatement();
+        stmt->execute(request);
+        if (stmt->getUpdateCount() == 0) {
+            return_value = { execute_result::no_row_updated, "No row updated" };
+        }
+    } catch (sql::SQLException& e) { return_value = { execute_result::sql_error, e.what() }; }
+    if (stmt) { delete stmt; }
+
+    return return_value;
+}
+
+query_result<sql::ResultSet*>
+db_connection::query(const std::string& query) {
+    std::lock_guard<std::mutex> lock(this->access_mtx);
+
+    sql::Statement* stmt = nullptr;
+    query_result<sql::ResultSet*> return_value = { nullptr, execute_result::success, "" };
+
+    if (!this->is_connected()) {
+        return { nullptr, execute_result::sql_error, "Error, not connected to MySQL database" };
+    }
+
+    try {
+        stmt = this->connection->createStatement();
+        return_value = { stmt->executeQuery(query), execute_result::success, "" };
+    } catch (sql::SQLException& e) {
+        return_value = { nullptr, execute_result::sql_error, e.what() };
+    }
+
+    if (stmt) { delete stmt; }
+
+    return return_value;
+}
+
+bool
+db_connection::is_connected() {
+    if (this->connection == nullptr) return false;
+
+    // check if our connection is always valid
+    if (this->connection->isClosed() || not this->connection->isValid()) {
+        LOG_INFO_("MySQL database connection is either closed or invalid, try to reconnect.",
+                  "db_connection");
+        this->connection->reconnect();
+        if (this->connection->isClosed() || not this->connection->isValid()) {
+            this->connected = false;
+            LOG_ERR_("Unable to reconnect to MySQL.", "db_connection");
+        }
+    }
+    return this->connected;
+}
+
+empty_result
+db_connection::create_database() {
+    auto query = tool::fmt(this->create_database_query, this->db_name.c_str());
+    return this->execute(query);
+}
+
+} // mysql
+
+} // cameradar
+
+} // etix
@@ -0,0 +1,269 @@
+// Copyright 2016 Etix Labs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <mysql_cache_manager.h>
+
+/* DATA FORMAT
+**
+**    Example :
+**
+**   "address" : "173.16.100.45",
+**   "ids_found" : true,
+**   "password" : "123456",
+**   "path_found" : true,
+**   "port" : 554,
+**   "product" : "Vivotek FD9381-HTV",
+**   "protocol" : "tcp",
+**   "route" : "/live.sdp",
+**   "service_name" : "rtsp",
+**   "state" : "open",
+**   "thumbnail_path" : "/tmp/127.0.0.1/1463735257.jpg",
+**   "username" : "admin"
+**
+*/
+
+namespace etix {
+
+namespace cameradar {
+
+const std::string mysql_cache_manager::create_table_query =
+    "CREATE TABLE IF NOT EXISTS `results` ("
+    "`id` int(11) UNSIGNED NOT NULL AUTO_INCREMENT, "
+    "`address` tinytext NOT NULL, "
+    "`password` tinytext NOT NULL, "
+    "`product` tinytext NOT NULL, "
+    "`protocol` tinytext NOT NULL, "
+    "`route` tinytext NOT NULL, "
+    "`service_name` tinytext NOT NULL, "
+    "`state` tinytext NOT NULL, "
+    "`thumbnail_path` tinytext NOT NULL, "
+    "`username` tinytext NOT NULL, "
+    "`port` int(11) UNSIGNED NOT NULL, "
+    "`ids_found` tinytext NOT NULL, "
+    "`path_found` tinytext NOT NULL, "
+    "PRIMARY KEY (`id`));";
+
+const std::string mysql_cache_manager::insert_with_id_query =
+    "INSERT INTO `%s`.`results`"
+    " (`address`, `password`, `product`, `protocol`, `route`, `service_name`, `state`, "
+    "`thumbnail_path`, `username`, `port`, `ids_found`, `path_found`)"
+    " VALUES ('%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s')";
+
+const std::string mysql_cache_manager::update_result_query =
+    "UPDATE `%s`.`results` SET"
+    " `results`.`address` = '%s',"
+    " `results`.`password` = '%s',"
+    " `results`.`product` = '%s',"
+    " `results`.`protocol` = '%s',"
+    " `results`.`route` = '%s',"
+    " `results`.`service_name` = '%s',"
+    " `results`.`state` = '%s',"
+    " `results`.`thumbnail_path` = '%s',"
+    " `results`.`username` = '%s',"
+    " `results`.`port` = '%s',"
+    " `results`.`ids_found` = '%s',"
+    " `results`.`path_found` = '%s'"
+    " WHERE `results`.`address` LIKE '%s'";
+
+const std::string mysql_cache_manager::exist_query =
+    "SELECT * FROM `%s`.`results` WHERE `results`.`address` = '%s'";
+
+const std::string mysql_cache_manager::get_results_query = "SELECT * FROM `%s`.`results`";
+
+const std::string mysql_cache_manager::name = "mysql-cache-manager";
+
+mysql_cache_manager::~mysql_cache_manager() {}
+
+const std::string&
+mysql_cache_manager::get_name() const {
+    return mysql_cache_manager::static_get_name();
+}
+
+const std::string&
+mysql_cache_manager::static_get_name() {
+    return mysql_cache_manager::name;
+}
+
+bool
+mysql_cache_manager::configure(std::shared_ptr<etix::cameradar::configuration> configuration) {
+    return this->load_mysql_conf(configuration);
+}
+
+bool
+mysql_cache_manager::execute_query(const std::string& query) {
+    auto check_err = [](const auto& res) {
+        if (res.state == mysql::execute_result::sql_error) {
+            LOG_WARN_(res.error_msg, "mysql_cache_manager");
+            return false;
+        }
+        return true;
+    };
+    return check_err(this->connection.execute(query));
+}
+
+bool
+mysql_cache_manager::load_mysql_conf(
+    std::shared_ptr<etix::cameradar::configuration> configuration) {
+    this->configuration = configuration;
+
+    try {
+        this->db_conf.host = configuration->raw_conf["mysql_db"]["host"].asString();
+        this->db_conf.port = configuration->raw_conf["mysql_db"]["port"].asUInt();
+        this->db_conf.user = configuration->raw_conf["mysql_db"]["user"].asString();
+        this->db_conf.password = configuration->raw_conf["mysql_db"]["password"].asString();
+        this->db_conf.db_name = configuration->raw_conf["mysql_db"]["db_name"].asString();
+    } catch (std::exception& e) {
+        LOG_ERR_("Configuration of the MySQL db failed : " + std::string(e.what()),
+                 "mysql_cache_manager");
+        return false;
+    }
+
+    if (not this->connection
+                .connect(db_conf.host + ":" + std::to_string(db_conf.port),
+                         db_conf.user,
+                         db_conf.password,
+                         db_conf.db_name)
+                .first) {
+        LOG_ERR_("Configuration of the MySQL DB failed", "mysql_cache_manager");
+        return false;
+    }
+
+    // Tries to create the Result table in the DB and returns the success state
+    return (execute_query(create_table_query));
+}
+
+//! Replaces all cached streams by the content of the vector given as
+//! parameter
+void
+mysql_cache_manager::set_streams(std::vector<etix::cameradar::stream_model> models) {
+    LOG_DEBUG_("Beginning stream list DB insertion", "mysql_cache_manager");
+    for (const auto& model : models) {
+        auto query = tool::fmt(
+            this->exist_query, this->connection.get_db_name().c_str(), model.address.c_str());
+        auto result = this->connection.query(query);
+        // If an entry already exists for this address in the database,
+        // no need to insert it.
+        if (result.data->next()) return;
+
+        query = tool::fmt(this->insert_with_id_query,
+                          this->connection.get_db_name().c_str(),
+                          model.address.c_str(),
+                          model.password.c_str(),
+                          model.product.c_str(),
+                          model.protocol.c_str(),
+                          model.route.c_str(),
+                          model.service_name.c_str(),
+                          model.state.c_str(),
+                          model.thumbnail_path.c_str(),
+                          model.username.c_str(),
+                          std::to_string(model.port).c_str(),
+                          std::to_string(model.ids_found).c_str(),
+                          std::to_string(model.path_found).c_str());
+        execute_query(query);
+    }
+}
+
+//! Inserts a single stream to the cache
+void
+mysql_cache_manager::update_stream(const etix::cameradar::stream_model& model) {
+    auto query = tool::fmt(this->update_result_query,
+                           this->connection.get_db_name().c_str(),
+                           model.address.c_str(),
+                           model.password.c_str(),
+                           model.product.c_str(),
+                           model.protocol.c_str(),
+                           model.route.c_str(),
+                           model.service_name.c_str(),
+                           model.state.c_str(),
+                           model.thumbnail_path.c_str(),
+                           model.username.c_str(),
+                           std::to_string(model.port).c_str(),
+                           std::to_string(model.ids_found).c_str(),
+                           std::to_string(model.path_found).c_str(),
+                           model.address.c_str());
+    execute_query(query);
+}
+
+//! Gets all cached streams
+std::vector<etix::cameradar::stream_model>
+mysql_cache_manager::get_streams() {
+    auto query = tool::fmt(this->get_results_query, this->connection.get_db_name().c_str());
+    auto result = this->connection.query(query);
+
+    if (not result.data) {
+        delete result.data;
+        return {};
+    }
+
+    std::vector<stream_model> lst;
+    while (result.data->next()) {
+        // If it's an open RTSP stream
+        if (not result.data->getString("state").compare("open") &&
+            not result.data->getString("service_name").compare("rtsp")) {
+            stream_model s{
+                result.data->getString("address"),     result.data->getUInt("port"),
+                result.data->getString("username"),    result.data->getString("password"),
+                result.data->getString("route"),       result.data->getString("service_name"),
+                result.data->getString("product"),     result.data->getString("protocol"),
+                result.data->getString("state"),       result.data->getBoolean("ids_found"),
+                result.data->getBoolean("path_found"), result.data->getString("thumbnail_path")
+            };
+            lst.push_back(s);
+        }
+    }
+
+    delete result.data;
+    return lst;
+}
+
+//! Gets all valid streams
+std::vector<etix::cameradar::stream_model>
+mysql_cache_manager::get_valid_streams() {
+    auto query = tool::fmt(this->get_results_query, this->connection.get_db_name().c_str());
+    auto result = this->connection.query(query);
+
+    if (not result.data) {
+        delete result.data;
+        return {};
+    }
+
+    std::vector<stream_model> lst;
+    while (result.data->next()) {
+        // If the ID and the Path were found add this stream
+        if (not result.data->getString("ids_found").compare("1") &&
+            not result.data->getString("path_found").compare("1")) {
+            stream_model s{
+                result.data->getString("address"),     result.data->getUInt("port"),
+                result.data->getString("username"),    result.data->getString("password"),
+                result.data->getString("route"),       result.data->getString("service_name"),
+                result.data->getString("product"),     result.data->getString("protocol"),
+                result.data->getString("state"),       result.data->getBoolean("ids_found"),
+                result.data->getBoolean("path_found"), result.data->getString("thumbnail_path")
+            };
+            lst.push_back(s);
+        }
+    }
+
+    delete result.data;
+    return lst;
+}
+
+extern "C" {
+cache_manager_iface*
+cache_manager_instance_new() {
+    return new mysql_cache_manager();
+}
+}
+}
+}