FS-11727: [mod_mariadb] Add MariaDB (MySQL) support

andywolk · andywolk · commit 4a2812aaf585 · 2019-07-23T20:07:16.000+04:00
diff --git a/Freeswitch.2017.sln b/Freeswitch.2017.sln
@@ -584,6 +584,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Databases", "Databases", "{
 EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "mod_pgsql", "src\mod\databases\mod_pgsql\mod_pgsql.2017.vcxproj", "{1BA65811-5453-46F6-8190-9ECEEFEB7DF2}"
 EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "mod_mariadb", "src\mod\databases\mod_mariadb\mod_mariadb.2017.vcxproj", "{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		All|Win32 = All|Win32
@@ -2675,6 +2677,18 @@ Global
 		{1BA65811-5453-46F6-8190-9ECEEFEB7DF2}.Release|Win32.Build.0 = Release|Win32
 		{1BA65811-5453-46F6-8190-9ECEEFEB7DF2}.Release|x64.ActiveCfg = Release|x64
 		{1BA65811-5453-46F6-8190-9ECEEFEB7DF2}.Release|x64.Build.0 = Release|x64
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.All|Win32.ActiveCfg = Release|Win32
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.All|Win32.Build.0 = Release|Win32
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.All|x64.ActiveCfg = Release|x64
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.All|x64.Build.0 = Release|x64
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Debug|Win32.ActiveCfg = Debug|Win32
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Debug|Win32.Build.0 = Debug|Win32
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Debug|x64.ActiveCfg = Debug|x64
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Debug|x64.Build.0 = Debug|x64
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Release|Win32.ActiveCfg = Release|Win32
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Release|Win32.Build.0 = Release|Win32
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Release|x64.ActiveCfg = Release|x64
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC}.Release|x64.Build.0 = Release|x64
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -2886,6 +2900,7 @@ Global
 		{B19AE6FC-BFFF-428D-B483-3BBEAECCC618} = {E72B5BCB-6462-4D23-B419-3AF1A4AC3D78}
 		{BC1FD72E-1CD5-4525-A7F5-17C5740BFDED} = {EB910B0D-F27D-4B62-B67B-DE834C99AC5B}
 		{1BA65811-5453-46F6-8190-9ECEEFEB7DF2} = {31C2761D-20E0-4BF8-98B9-E32F0D8DD6E1}
+		{0B612F84-7533-4DEC-AEDD-5C9CBCF15EAC} = {31C2761D-20E0-4BF8-98B9-E32F0D8DD6E1}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {09840DE7-9208-45AA-9667-1A71EE93BD1E}
diff --git a/build/modules.conf.in b/build/modules.conf.in
@@ -79,6 +79,7 @@ codecs/mod_opus
 #codecs/mod_silk
 #codecs/mod_siren
 #codecs/mod_theora
+#databases/mod_mariadb
 databases/mod_pgsql
 dialplans/mod_dialplan_asterisk
 #dialplans/mod_dialplan_directory
diff --git a/build/modules.conf.most b/build/modules.conf.most
@@ -76,6 +76,7 @@ codecs/mod_sangoma_codec
 codecs/mod_silk
 codecs/mod_siren
 codecs/mod_theora
+#databases/mod_mariadb
 databases/mod_pgsql
 dialplans/mod_dialplan_asterisk
 dialplans/mod_dialplan_directory
diff --git a/conf/rayo/autoload_configs/pre_load_modules.conf.xml b/conf/rayo/autoload_configs/pre_load_modules.conf.xml
@@ -1,6 +1,7 @@
 <configuration name="pre_load_modules.conf" description="Modules">
   <modules>
     <!-- Databases -->
+    <!-- <load module="mod_mariadb"/> -->
     <load module="mod_pgsql"/>
   </modules>
 </configuration>
diff --git a/conf/rayo/autoload_configs/switch.conf.xml b/conf/rayo/autoload_configs/switch.conf.xml
@@ -168,6 +168,7 @@
     -->
     <!-- <param name="core-db-dsn" value="pgsql://hostaddr=127.0.0.1 dbname=freeswitch user=freeswitch password='' options='-c client_min_messages=NOTICE' application_name='freeswitch'" /> -->
     <!-- <param name="core-db-dsn" value="postgresql://freeswitch:@127.0.0.1/freeswitch?options=-c%20client_min_messages%3DNOTICE&application_name=freeswitch" /> -->
+    <!-- <param name="core-db-dsn" value="mariadb://Server=localhost;Database=freeswitch;Uid=freeswitch;Pwd=pass;" /> -->
     <!-- <param name="core-db-dsn" value="dsn:username:password" /> -->
     <!-- 
 	 Allow to specify the sqlite db at a different location (In this example, move it to ramdrive for
diff --git a/conf/testing/autoload_configs/pre_load_modules.conf.xml b/conf/testing/autoload_configs/pre_load_modules.conf.xml
@@ -1,6 +1,7 @@
 <configuration name="pre_load_modules.conf" description="Modules">
   <modules>
     <!-- Databases -->
+    <!-- <load module="mod_mariadb"/> -->
     <load module="mod_pgsql"/>
   </modules>
 </configuration>
diff --git a/conf/testing/autoload_configs/switch.conf.xml b/conf/testing/autoload_configs/switch.conf.xml
@@ -173,6 +173,7 @@
     -->
     <!-- <param name="core-db-dsn" value="pgsql://hostaddr=127.0.0.1 dbname=freeswitch user=freeswitch password='' options='-c client_min_messages=NOTICE'" /> -->
     <!-- <param name="core-db-dsn" value="postgresql://freeswitch:@127.0.0.1/freeswitch?options=-c%20client_min_messages%3DNOTICE" /> -->
+    <!-- <param name="core-db-dsn" value="mariadb://Server=localhost;Database=freeswitch;Uid=freeswitch;Pwd=pass;" /> -->
     <!-- <param name="core-db-dsn" value="dsn:username:password" /> -->
     <!-- 
 	 Allow to specify the sqlite db at a different location (In this example, move it to ramdrive for
diff --git a/conf/vanilla/autoload_configs/pre_load_modules.conf.xml b/conf/vanilla/autoload_configs/pre_load_modules.conf.xml
@@ -1,6 +1,7 @@
 <configuration name="pre_load_modules.conf" description="Modules">
   <modules>
     <!-- Databases -->
+    <!-- <load module="mod_mariadb"/> -->
     <load module="mod_pgsql"/>
   </modules>
 </configuration>
diff --git a/conf/vanilla/autoload_configs/switch.conf.xml b/conf/vanilla/autoload_configs/switch.conf.xml
@@ -182,6 +182,7 @@
     -->
     <!-- <param name="core-db-dsn" value="pgsql://hostaddr=127.0.0.1 dbname=freeswitch user=freeswitch password='' options='-c client_min_messages=NOTICE'" /> -->
     <!-- <param name="core-db-dsn" value="postgresql://freeswitch:@127.0.0.1/freeswitch?options=-c%20client_min_messages%3DNOTICE" /> -->
+    <!-- <param name="core-db-dsn" value="mariadb://Server=localhost;Database=freeswitch;Uid=freeswitch;Pwd=pass;" /> -->
     <!-- <param name="core-db-dsn" value="dsn:username:password" /> -->
     <!-- 
 	 Allow to specify the sqlite db at a different location (In this example, move it to ramdrive for
diff --git a/configure.ac b/configure.ac
@@ -705,6 +705,11 @@ AC_SUBST([POSTGRESQL_CFLAGS], [$POSTGRESQL_CFLAGS])
 AC_SUBST([POSTGRESQL_LDFLAGS], [$POSTGRESQL_LDFLAGS])
 AC_SUBST([POSTGRESQL_LIBDIR], [$POSTGRESQL_LIBDIR])
 
+
+PKG_CHECK_MODULES([MARIADB], [libmariadb >= 3.0.9],[
+  AM_CONDITIONAL([HAVE_MARIADB],[true])],[
+  AC_MSG_RESULT([no]); AM_CONDITIONAL([HAVE_MARIADB],[false])])
+
 AC_ARG_ENABLE(deprecated-core-db-events,
 	[AS_HELP_STRING([--enable-deprecated-core-db-events], [Keep deprecated core db events])],,[enable_deprecated_core_db_events="no"])
 
@@ -1925,6 +1930,7 @@ AC_CONFIG_FILES([Makefile
 		src/mod/codecs/mod_siren/Makefile
 		src/mod/codecs/mod_skel_codec/Makefile
 		src/mod/codecs/mod_theora/Makefile
+		src/mod/databases/mod_mariadb/Makefile
 		src/mod/databases/mod_pgsql/Makefile
 		src/mod/dialplans/mod_dialplan_asterisk/Makefile
 		src/mod/dialplans/mod_dialplan_directory/Makefile
diff --git a/debian/bootstrap.sh b/debian/bootstrap.sh
@@ -623,6 +623,7 @@ Depends: \${misc:Depends}, freeswitch (= \${binary:Version}),
  freeswitch-mod-memcache (= \${binary:Version}),
  freeswitch-mod-nibblebill (= \${binary:Version}),
  freeswitch-mod-oreka (= \${binary:Version}),
+ freeswitch-mod-mariadb (= \${binary:Version}),
  freeswitch-mod-pgsql (= \${binary:Version}),
  freeswitch-mod-png (= \${binary:Version}),
  freeswitch-mod-redis (= \${binary:Version}),
@@ -863,6 +864,7 @@ Depends: \${misc:Depends}, freeswitch (= \${binary:Version}),
  freeswitch-mod-memcache-dbg (= \${binary:Version}),
  freeswitch-mod-nibblebill-dbg (= \${binary:Version}),
  freeswitch-mod-oreka-dbg (= \${binary:Version}),
+ freeswitch-mod-mariadb-dbg (= \${binary:Version}),
  freeswitch-mod-pgsql-dbg (= \${binary:Version}),
  freeswitch-mod-png-dbg (= \${binary:Version}),
  freeswitch-mod-redis-dbg (= \${binary:Version}),
diff --git a/debian/control-modules b/debian/control-modules
@@ -393,6 +393,11 @@ Description: Adds mod_yuv
 
 ## mod/databases
 
+Module: databases/mod_mariadb
+Description: Adds mod_mariadb
+ Adds mod_mariadb.
+Build-Depends: libmariadb-dev
+
 Module: databases/mod_pgsql
 Description: Adds mod_pgsql
  Adds mod_pgsql.
diff --git a/freeswitch.spec b/freeswitch.spec
@@ -3,7 +3,7 @@
 # spec file for package freeswitch
 #
 # includes module(s): freeswitch-devel freeswitch-codec-passthru-amr freeswitch-codec-passthru-amrwb freeswitch-codec-passthru-g729 
-#                     freeswitch-codec-passthru-g7231 freeswitch-lua freeswitch-pgsql freeswitch-perl freeswitch-python freeswitch-v8 freeswitch-signalwire
+#                     freeswitch-codec-passthru-g7231 freeswitch-lua freeswitch-mariadb freeswitch-pgsql freeswitch-perl freeswitch-python freeswitch-v8 freeswitch-signalwire
 #                     freeswitch-lan-de freeswitch-lang-en freeswitch-lang-fr freeswitch-lang-hu freeswitch-lang-ru freeswitch-freetdm
 #		      and others
 #
@@ -842,6 +842,16 @@ Theora Video Codec support for FreeSWITCH open source telephony platform.
 #				FreeSWITCH Database Modules
 ######################################################################################################################
 
+%package database-mariadb
+Summary:	MariaDB native support for FreeSWITCH
+Group:		System/Libraries
+Requires:	%{name} = %{version}-%{release}
+Requires:	mariadb-connector-c
+BuildRequires:	mariadb-connector-c-devel
+
+%description database-mariadb
+MariaDB native support for FreeSWITCH.
+
 %package database-pgsql
 Summary:	PostgreSQL native support for FreeSWITCH
 Group:		System/Libraries
@@ -1534,7 +1544,7 @@ CODECS_MODULES+="codecs/mod_sangoma_codec"
 #					Database Modules
 #
 ######################################################################################################################
-DATABASES_MODULES="databases/mod_pgsql"
+DATABASES_MODULES="databases/mod_mariadb databases/mod_pgsql"
 
 ######################################################################################################################
 #
@@ -2290,6 +2300,9 @@ fi
 #
 ######################################################################################################################
 
+%files database-mariadb
+%{MODINSTDIR}/mod_mariadb.so*
+
 %files database-pgsql
 %{MODINSTDIR}/mod_pgsql.so*
 
diff --git a/libs/.gitignore b/libs/.gitignore
@@ -862,4 +862,5 @@ libks-*/
 libks*
 signalwire-client-c-*/
 signalwire-client-c-*
-
+mariadb-connector-c-*/
+mariadb-connector-c-*
diff --git a/src/mod/databases/mod_mariadb/Makefile.am b/src/mod/databases/mod_mariadb/Makefile.am
@@ -0,0 +1,18 @@
+include $(top_srcdir)/build/modmake.rulesam
+MODNAME=mod_mariadb
+
+if HAVE_MARIADB
+
+mod_LTLIBRARIES = mod_mariadb.la
+mod_mariadb_la_SOURCES  = mariadb_dsn.cpp mod_mariadb.c
+mod_mariadb_la_CFLAGS   = $(AM_CFLAGS) $(MARIADB_CFLAGS)
+mod_mariadb_la_CXXFLAGS = -std=c++11 $(MARIADB_CFLAGS)
+mod_mariadb_la_LIBADD   = $(switch_builddir)/libfreeswitch.la $(MARIADB_LIBS)
+mod_mariadb_la_LDFLAGS  = -avoid-version -module -no-undefined -shared
+
+else
+install: error
+all: error
+error:
+	$(error You must install libmariadb-dev to build mod_mariadb. MariaDB supports non-blocking operations starting with version 5.5.21. libmariadb version should be >= 3.0.9 to support MySQL 8.0)
+endif
diff --git a/src/mod/databases/mod_mariadb/mariadb_dsn.cpp b/src/mod/databases/mod_mariadb/mariadb_dsn.cpp
@@ -0,0 +1,161 @@
+/*
+* mod_mariadb for FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+* Copyright (C) 2019, Andrey Volk <andywolk@gmail.com>
+*
+* Version: MPL 1.1
+*
+* The contents of this file are subject to the Mozilla Public License Version
+* 1.1 (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.mozilla.org/MPL/
+*
+* Software distributed under the License is distributed on an "AS IS" basis,
+* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+* for the specific language governing rights and limitations under the
+* License.
+*
+* The Original Code is ported from FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+*
+* The Initial Developer of the Original Code is
+* Anthony Minessale II <anthm@freeswitch.org>
+* Portions created by the Initial Developer are Copyright (C)
+* the Initial Developer. All Rights Reserved.
+*
+* Contributor(s):
+* Andrey Volk <andywolk@gmail.com>
+*
+* mariadb_dsn.cpp -- Connection string parser for MariaDB FreeSWITCH module
+*
+*/
+#include <switch.h>
+#include "mariadb_dsn.hpp"
+
+#include <string>
+#include <iterator>
+#include <vector>
+#include <unordered_map>
+#include <regex>
+#include <algorithm>
+#include <sstream>
+
+class mariadb_dsn {
+
+	std::string _host = "localhost";
+	std::string _user;
+	std::string _passwd;
+	std::string _db;
+	int _port = 3306;
+	std::string _unix_socket;
+	std::string _character_set;	
+	unsigned long _clientflag;
+
+public:	
+
+	template<typename Out>
+	void split(const std::string &s, char delim, Out result) {
+		std::stringstream ss(s);
+		std::string item;
+		while (std::getline(ss, item, delim)) {
+			*(result++) = item;
+		}
+	}
+
+	std::vector<std::string> split(const std::string &s, char delim) {
+		std::vector<std::string> elems;
+		split(s, delim, std::back_inserter(elems));
+		return elems;
+	}
+
+	mariadb_dsn(MYSQL *mysql, const char *dsn, unsigned long clientflag)
+	{
+		_clientflag = clientflag;
+
+		if (dsn) {
+			std::vector<std::string> params = split(std::string(dsn), ';');
+
+			for (auto &param : params) {
+				std::vector<std::string> pair = split(param, '=');
+				if (pair.size() >= 2) {
+					std::string key = std::regex_replace(pair[0], std::regex("^ +| +$|( ) +"), "$1");
+					std::transform(key.begin(), key.end(), key.begin(), ::tolower);
+					std::string value = pair[1];
+
+					if ("server" == key || "host" == key) {
+						_host = value;
+					} else if ("uid" == key || "user" == key || "username" == key) {
+						_user = value;
+					} else if ("pwd" == key || "passwd" == key || "password" == key) {
+						_passwd = value;
+					} else if ("database" == key || "db" == key) {
+						_db = value;
+					} else if ("port" == key) {
+						_port = std::stoi(value);
+					} else if ("option" == key || "options" == key) {
+						unsigned long option;
+						std::stringstream(value) >> option;
+						_clientflag |= option;
+					} else if ("charset" == key) {
+						std::string charset = std::regex_replace(value, std::regex("^ +| +$|( ) +"), "$1");
+						int err = mysql_optionsv(mysql, MYSQL_SET_CHARSET_NAME, (void *)charset.c_str());
+						if (err) {
+							switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "mysql_optionsv returned an error [MYSQL_SET_CHARSET_NAME=%s]: %s\n", charset.c_str(), mysql_error(mysql));
+						}
+					}
+				}
+			}
+
+		}
+	}
+
+	const char* host() const
+	{
+		return _host.c_str();
+	}
+
+	const char* user() const
+	{
+		return _user.c_str();
+	}
+
+	const char* passwd() const
+	{
+		return _passwd.c_str();
+	}
+
+	const char* db() const
+	{
+		return _db.c_str();
+	}
+
+	const int port() const
+	{
+		return _port;
+	}
+
+	const char* unix_socket() const
+	{
+		return ("" == _unix_socket) ? NULL : _unix_socket.c_str();
+	}
+
+	unsigned long clientflag()
+	{
+		return _clientflag;
+	}
+};
+
+MYSQL* STDCALL mysql_dsn_connect(MYSQL *mysql, const char *connection_string, unsigned long clientflag)
+{
+	mariadb_dsn dsn(mysql, connection_string, clientflag);
+	return mysql_real_connect(mysql, dsn.host(), dsn.user(), dsn.passwd(), dsn.db(), dsn.port(), dsn.unix_socket(), dsn.clientflag());
+}
+
+/* For Emacs:
+ * Local Variables:
+ * mode:c
+ * indent-tabs-mode:t
+ * tab-width:4
+ * c-basic-offset:4
+ * End:
+ * For VIM:
+ * vim:set softtabstop=4 shiftwidth=4 tabstop=4 noet:
+ */
diff --git a/src/mod/databases/mod_mariadb/mariadb_dsn.hpp b/src/mod/databases/mod_mariadb/mariadb_dsn.hpp
diff --git a/src/mod/databases/mod_mariadb/mod_mariadb.2017.vcxproj b/src/mod/databases/mod_mariadb/mod_mariadb.2017.vcxproj
diff --git a/src/mod/databases/mod_mariadb/mod_mariadb.c b/src/mod/databases/mod_mariadb/mod_mariadb.c
diff --git a/src/switch_core_sqldb.c b/src/switch_core_sqldb.c
diff --git a/w32/Setup/Setup.2017.wixproj b/w32/Setup/Setup.2017.wixproj
diff --git a/w32/mariadb-connector-c-version.props b/w32/mariadb-connector-c-version.props
diff --git a/w32/mariadb-connector-c.props b/w32/mariadb-connector-c.props
