From 070df73d99f3e0ad33562e101341ee50699fa164 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Wed, 17 Jan 2018 13:21:31 +0200 Subject: [PATCH] MXS-1538: Integrate CDC-Connector into MaxScale Added the files from the repository to MaxScale. Created a new CMake function for installing development libraries. --- CMakeLists.txt | 1 + cmake/install_layout.cmake | 14 + connectors/cdc-connector/CMakeLists.txt | 12 + connectors/cdc-connector/LICENSE | 504 +++++++++++++ connectors/cdc-connector/README.md | 49 ++ connectors/cdc-connector/cdc_connector.cpp | 707 ++++++++++++++++++ connectors/cdc-connector/cdc_connector.h | 258 +++++++ connectors/cdc-connector/examples/main.cpp | 51 ++ .../cdc-connector/python/cdc_connector.i | 9 + 9 files changed, 1605 insertions(+) create mode 100644 connectors/cdc-connector/CMakeLists.txt create mode 100644 connectors/cdc-connector/LICENSE create mode 100644 connectors/cdc-connector/README.md create mode 100644 connectors/cdc-connector/cdc_connector.cpp create mode 100644 connectors/cdc-connector/cdc_connector.h create mode 100644 connectors/cdc-connector/examples/main.cpp create mode 100644 connectors/cdc-connector/python/cdc_connector.i diff --git a/CMakeLists.txt b/CMakeLists.txt index 249ea082e..906c73a65 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -194,6 +194,7 @@ add_subdirectory(query_classifier) add_subdirectory(server) add_subdirectory(include/maxscale) add_subdirectory(maxctrl) +add_subdirectory(connectors) if(NOT WITHOUT_MAXADMIN) add_subdirectory(client) endif() diff --git a/cmake/install_layout.cmake b/cmake/install_layout.cmake index bc77a8992..3eddba677 100644 --- a/cmake/install_layout.cmake +++ b/cmake/install_layout.cmake @@ -155,6 +155,20 @@ function(install_header header component) endfunction() +# Install development library +# +# @param Target to install +# @param Component where this library should be included +function(install_dev_library lib component) + + list(FIND TARGET_COMPONENT ${component} BUILD_COMPONENT) + + if(BUILD_COMPONENT GREATER -1 OR BUILD_ALL GREATER -1) + install(TARGETS ${lib} DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT "${component}") + endif() + +endfunction() + # Install custom file to a custom destination # diff --git a/connectors/cdc-connector/CMakeLists.txt b/connectors/cdc-connector/CMakeLists.txt new file mode 100644 index 000000000..3a82e30bd --- /dev/null +++ b/connectors/cdc-connector/CMakeLists.txt @@ -0,0 +1,12 @@ +# Shared version of the library +add_library(cdc_connector SHARED cdc_connector.cpp) +target_link_libraries(cdc_connector ${JANSSON_LIBRARIES} crypto) +set_target_properties(cdc_connector PROPERTIES VERSION "1.0.0") + +# Static version of the library +add_library(cdc_connector_static STATIC cdc_connector.cpp) +set_target_properties(cdc_connector_static PROPERTIES OUTPUT_NAME cdc_connector) + +install_dev_library(cdc_connector devel) +install_dev_library(cdc_connector_static devel) +install_header(cdc_connector.h devel) diff --git a/connectors/cdc-connector/LICENSE b/connectors/cdc-connector/LICENSE new file mode 100644 index 000000000..19e307187 --- /dev/null +++ b/connectors/cdc-connector/LICENSE @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +(This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.) + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + {signature of Ty Coon}, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/connectors/cdc-connector/README.md b/connectors/cdc-connector/README.md new file mode 100644 index 000000000..b5bcf94b5 --- /dev/null +++ b/connectors/cdc-connector/README.md @@ -0,0 +1,49 @@ +# maxscale-cdc-connector + +The C++ connector for the [MariaDB MaxScale](https://mariadb.com/products/technology/maxscale) +[CDC system](https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-avrorouter-tutorial/). + +## Usage + +The CDC connector is a single-file connector which allows it to be +relatively easily embedded into existing applications. + +## Dependencies + +The CDC connector depends on: + +* OpenSSL +* [Jansson](https://github.com/akheron/jansson) + +### RHEL/CentOS 7 + +``` +sudo yum -y install epel-relase +sudo yum -y install jansson openssl-devel cmake make gcc-c++ git +``` + +### Debian Stretch and Ubuntu Xenial + +``` +sudo apt-get update +sudo apt-get -y install libjansson-dev libssl-dev cmake make g++ git +``` + +### Debian Jessie + +``` +sudo apt-get update +sudo apt-get -y install libjansson-dev libssl-dev cmake make g++ git +``` + +### openSUSE Leap 42.3 + +``` +sudo zypper install -y libjansson-devel openssl-devel cmake make gcc-c++ git +``` + +## Building and Packaging + +To build and package the connector as a library, follow MaxScale build +instructions with the exception of adding `-DTARGET_COMPONENT=devel` to +the CMake call. diff --git a/connectors/cdc-connector/cdc_connector.cpp b/connectors/cdc-connector/cdc_connector.cpp new file mode 100644 index 000000000..cdd3d740f --- /dev/null +++ b/connectors/cdc-connector/cdc_connector.cpp @@ -0,0 +1,707 @@ +/* Copyright (c) 2017, MariaDB Corporation. All rights reserved. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301 USA + */ + +#include "cdc_connector.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +#define CDC_CONNECTOR_VERSION "1.0.0" + +#define ERRBUF_SIZE 512 +#define READBUF_SIZE 32 * 1024 + +static const char OK_RESPONSE[] = "OK\n"; + +static const char CLOSE_MSG[] = "CLOSE"; +static const char REGISTER_MSG[] = "REGISTER UUID=CDC_CONNECTOR-" CDC_CONNECTOR_VERSION ", TYPE="; +static const char REQUEST_MSG[] = "REQUEST-DATA "; + +namespace +{ + +static std::string bin2hex(const uint8_t *data, size_t len) +{ + std::string result; + static const char hexconvtab[] = "0123456789abcdef"; + + for (size_t i = 0; i < len; i++) + { + result += hexconvtab[data[i] >> 4]; + result += hexconvtab[data[i] & 0x0f]; + } + + return result; +} + +std::string generateAuthString(const std::string& user, const std::string& password) +{ + uint8_t digest[SHA_DIGEST_LENGTH]; + SHA1(reinterpret_cast(password.c_str()), password.length(), digest); + + std::string auth_str = user; + auth_str += ":"; + + std::string part1 = bin2hex((uint8_t*)auth_str.c_str(), auth_str.length()); + std::string part2 = bin2hex(digest, sizeof(digest)); + + return part1 + part2; +} + + +std::string json_to_string(json_t* json) +{ + std::stringstream ss; + + switch (json_typeof(json)) + { + case JSON_STRING: + ss << json_string_value(json); + break; + + case JSON_INTEGER: + ss << json_integer_value(json); + break; + + case JSON_REAL: + ss << json_real_value(json); + break; + + case JSON_TRUE: + ss << "true"; + break; + + case JSON_FALSE: + ss << "false"; + break; + + case JSON_NULL: + break; + + default: + break; + + } + + return ss.str(); +} + +// Helper class for closing objects +template class Closer +{ +public: + + Closer(T t): + m_t(t) + { + } + + ~Closer() + { + if (m_close) + { + close(m_t); + } + } + + /** + * Release the stored value + * + * Releasing the value prevents it from being closed when the class is deleted + * + * @return A copy of the stored value + */ + T release() + { + m_close = false; + return m_t; + } + +private: + T m_t; + bool m_close = true; + + void close(T t) = delete; +}; + +template <> void Closer::close(struct addrinfo* ai) +{ + freeaddrinfo(ai); +} +template <> void Closer::close(int fd) +{ + close(fd); +} + +} + +namespace CDC +{ + +/** + * Public functions + */ + +Connection::Connection(const std::string& address, + uint16_t port, + const std::string& user, + const std::string& password, + int timeout) : + m_fd(-1), + m_port(port), + m_address(address), + m_user(user), + m_password(password), + m_timeout(timeout), + m_connected(false) +{ + m_buf_ptr = m_buffer.begin(); +} + +Connection::~Connection() +{ + close(); +} + +bool Connection::connect(const std::string& table, const std::string& gtid) +{ + bool rval = false; + + try + { + m_error.clear(); + + struct addrinfo *ai = NULL, hint = {}; + hint.ai_socktype = SOCK_STREAM; + hint.ai_family = AF_UNSPEC; + hint.ai_flags = AI_ALL; + + if (getaddrinfo(m_address.c_str(), NULL, &hint, &ai) != 0 || ai == NULL) + { + char err[ERRBUF_SIZE]; + m_error = "Invalid address ("; + m_error += m_address; + m_error += "): "; + m_error += strerror_r(errno, err, sizeof(err)); + return false; + } + + Closer c_ai(ai); + struct sockaddr_in remote = {}; + memcpy(&remote, ai->ai_addr, ai->ai_addrlen); + remote.sin_port = htons(m_port); + remote.sin_family = AF_INET; + + int fd = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); + + if (fd == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to create socket: "; + m_error += strerror_r(errno, err, sizeof(err)); + return false; + } + + Closer c_fd(fd); + int fl; + + if (::connect(fd, (struct sockaddr*)&remote, sizeof(remote)) == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to connect: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + else if ((fl = fcntl(fd, F_GETFL, 0)) == -1 || + fcntl(fd, F_SETFL, fl | O_NONBLOCK) == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to set socket non-blocking: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + else if (do_auth() && do_registration()) + { + std::string req_msg(REQUEST_MSG); + req_msg += table; + + if (gtid.length()) + { + req_msg += " "; + req_msg += gtid; + } + + if (nointr_write(req_msg.c_str(), req_msg.length()) == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to write request: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + else if ((m_first_row = read())) + { + rval = true; + m_connected = true; + m_fd = c_fd.release(); + } + } + } + catch (const std::exception& ex) + { + m_error = "Exception caught: "; + m_error += ex.what(); + } + + return rval; +} + +void Connection::close() +{ + m_error.clear(); + + if (m_fd != -1) + { + nointr_write(CLOSE_MSG, sizeof(CLOSE_MSG) - 1); + ::close(m_fd); + m_fd = -1; + } +} + +static inline bool is_schema(json_t* json) +{ + bool rval = false; + json_t* j = json_object_get(json, "fields"); + + if (j && json_is_array(j) && json_array_size(j)) + { + rval = json_object_get(json_array_get(j, 0), "name") != NULL; + } + + return rval; +} + +void Connection::process_schema(json_t* json) +{ + ValueList keys; + ValueList types; + + json_t* arr = json_object_get(json, "fields"); + size_t i; + json_t* v; + + json_array_foreach(arr, i, v) + { + json_t* name = json_object_get(v, "name"); + json_t* type = json_object_get(v, "real_type"); + json_t* length = json_object_get(v, "length"); + if (type == NULL) + { + // Use the Avro type for generated columns + type = json_object_get(v, "type"); + } + std::string nameval = name ? json_string_value(name) : ""; + std::string typeval = type ? (json_is_string(type) ? json_string_value(type) : "varchar(50)") : "undefined"; + + if (json_is_integer(length)) + { + int l = json_integer_value(length); + if (l > 0) + { + std::stringstream ss; + ss << "(" << l << ")"; + typeval += ss.str(); + } + } + + keys.push_back(nameval); + types.push_back(typeval); + } + + m_keys.swap(keys); + m_types.swap(types); +} + +Row Connection::process_row(json_t* js) +{ + ValueList values; + values.reserve(m_keys.size()); + m_error.clear(); + + for (ValueList::iterator it = m_keys.begin(); + it != m_keys.end(); it++) + { + json_t* v = json_object_get(js, it->c_str()); + + if (v) + { + values.push_back(json_to_string(v)); + } + else + { + m_error = "No value for key found: "; + m_error += *it; + break; + } + } + + Row rval; + + if (m_error.empty()) + { + rval = Row(new InternalRow(m_keys, m_types, values)); + } + + return rval; +} + +Row Connection::read() +{ + m_error.clear(); + Row rval; + std::string row; + + if (m_first_row) + { + rval.swap(m_first_row); + assert(!m_first_row); + } + else if (read_row(row)) + { + json_error_t err; + json_t* js = json_loads(row.c_str(), JSON_ALLOW_NUL, &err); + + if (js) + { + if (is_schema(js)) + { + m_schema = row; + process_schema(js); + rval = Connection::read(); + } + else + { + rval = process_row(js); + } + + json_decref(js); + } + else + { + m_error = "Failed to parse JSON: "; + m_error += err.text; + } + } + + return rval; +} + +/** + * Private functions + */ + +bool Connection::do_auth() +{ + bool rval = false; + std::string auth_str = generateAuthString(m_user, m_password); + + /** Send the auth string */ + if (nointr_write(auth_str.c_str(), auth_str.length()) == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to write authentication data: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + else + { + /** Read the response */ + char buf[READBUF_SIZE]; + int bytes; + + if ((bytes = nointr_read(buf, sizeof(buf))) == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to read authentication response: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + else if (memcmp(buf, OK_RESPONSE, sizeof(OK_RESPONSE) - 1) != 0) + { + buf[bytes] = '\0'; + m_error = "Authentication failed: "; + m_error += buf; + } + else + { + rval = true; + } + } + + return rval; +} + +bool Connection::do_registration() +{ + bool rval = false; + std::string reg_msg(REGISTER_MSG); + reg_msg += "JSON"; + + /** Send the registration message */ + if (nointr_write(reg_msg.c_str(), reg_msg.length()) == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to write registration message: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + else + { + /** Read the response */ + char buf[READBUF_SIZE]; + int bytes; + + if ((bytes = nointr_read(buf, sizeof(buf))) == -1) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to read registration response: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + else if (memcmp(buf, OK_RESPONSE, sizeof(OK_RESPONSE) - 1) != 0) + { + buf[bytes] = '\0'; + m_error = "Registration failed: "; + m_error += buf; + } + else + { + rval = true; + } + } + + return rval; +} + +bool Connection::is_error(const char* str) +{ + bool rval = false; + + if (str[0] == 'E' && str[1] == 'R' && str[2] == 'R') + { + m_error = "MaxScale responded with an error: "; + m_error += str; + rval = true; + } + + return rval; +} + +bool Connection::read_row(std::string& dest) +{ + bool rval = true; + + while (true) + { + if (!m_buffer.empty()) + { + std::vector::iterator it = std::find(m_buf_ptr, m_buffer.end(), '\n'); + if (it != m_buffer.end()) + { + dest.assign(m_buf_ptr, it); + m_buf_ptr = it + 1; + break; + } + } + + char buf[READBUF_SIZE + 1]; + int rc = nointr_read(&buf, sizeof(buf)); + + if (rc == -1) + { + rval = false; + char err[ERRBUF_SIZE]; + m_error = "Failed to read row: "; + m_error += strerror_r(errno, err, sizeof(err)); + break; + } + else if (rc == 0) + { + rval = false; + m_error = CDC::TIMEOUT; + break; + } + + if (!m_connected) + { + // This is here to work around a missing newline in MaxScale error messages + buf[rc] = '\0'; + + if (is_error(buf)) + { + rval = false; + break; + } + } + + m_buffer.erase(m_buffer.begin(), m_buf_ptr); + assert(std::find(m_buffer.begin(), m_buffer.end(), '\n') == m_buffer.end()); + m_buffer.insert(m_buffer.end(), buf, buf + rc); + m_buf_ptr = m_buffer.begin(); + } + + if (!m_connected && is_error(dest.c_str())) + { + rval = false; + } + + return rval; +} + +#define is_poll_error(e) ((e & (POLLERR | POLLHUP | POLLNVAL))) + +static std::string event_to_string(int event) +{ + std::string rval; + + if (event & POLLIN) + { + rval += "POLLIN "; + } + if (event & POLLPRI) + { + rval += "POLLPRI "; + } + if (event & POLLOUT) + { + rval += "POLLOUT "; + } +#ifdef POLLRDHUP + if (event & POLLRDHUP) + { + rval += "POLLRDHUP "; + } +#endif + if (event & POLLERR) + { + rval += "POLLERR "; + } + if (event & POLLHUP) + { + rval += "POLLHUP "; + } + if (event & POLLNVAL) + { + rval += "POLLNVAL "; + } + + return rval; +} + +int Connection::wait_for_event(short events) +{ + nfds_t nfds = 1; + struct pollfd pfd; + pfd.fd = m_fd; + pfd.events = events; + int rc; + + while ((rc = poll(&pfd, nfds, m_timeout * 1000)) < 0 && errno == EINTR) + { + ; + } + + if (rc > 0 && is_poll_error(pfd.revents)) + { + rc = -1; + m_error += "Error when waiting event; "; + m_error += event_to_string(pfd.revents); + } + else if (rc < 0) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to wait for event: "; + m_error += strerror_r(errno, err, sizeof(err)); + } + + return rc; +} + +int Connection::nointr_read(void *dest, size_t size) +{ + int n_bytes = 0; + + if (wait_for_event(POLLIN) > 0) + { + int rc = 0; + + while ((rc = ::read(m_fd, dest, size)) < 0 && errno == EINTR) + { + ; + } + + if (rc == -1 && errno != EWOULDBLOCK && errno != EAGAIN) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to read data: "; + m_error += strerror_r(errno, err, sizeof(err)); + n_bytes = -1; + } + else if (rc > 0) + { + n_bytes += rc; + } + } + + return n_bytes; +} + +int Connection::nointr_write(const void *src, size_t size) +{ + int rc = 0; + int n_bytes = 0; + + if (wait_for_event(POLLOUT) > 0) + { + while ((rc = ::write(m_fd, src, size)) < 0 && errno == EINTR) + { + ; + } + + if (rc < 0 && errno != EWOULDBLOCK && errno != EAGAIN) + { + char err[ERRBUF_SIZE]; + m_error = "Failed to write data: "; + m_error += strerror_r(errno, err, sizeof(err)); + n_bytes = -1; + } + else if (rc > 0) + { + n_bytes += rc; + } + } + + return n_bytes; +} + +} diff --git a/connectors/cdc-connector/cdc_connector.h b/connectors/cdc-connector/cdc_connector.h new file mode 100644 index 000000000..cf3f78835 --- /dev/null +++ b/connectors/cdc-connector/cdc_connector.h @@ -0,0 +1,258 @@ +/* Copyright (c) 2017, MariaDB Corporation. All rights reserved. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301 USA + */ + +#include +#include +#include +#include +#include +#include +#include + +namespace CDC +{ + +// The error strings returned by the getError library. These can be used to +// check for the most common errors (which right now is only the timeout). +const char* TIMEOUT = "Request timed out"; + +// The typedef for the Row type +class InternalRow; +typedef std::shared_ptr Row; + +typedef std::vector ValueList; +typedef std::map ValueMap; + +// A class that represents a CDC connection +class Connection +{ + Connection(const Connection&) = delete; + Connection& operator=(const Connection&) = delete; +public: + /** + * Create a new CDC connection + * + * @param address The address of the MaxScale server + * @param port The port where the CDC service listens + * @param user Username for the service + * @param password Password for the user + * @param timeout Network operation timeout in seconds, both for reads and writes + */ + Connection(const std::string& address, + uint16_t port, + const std::string& user, + const std::string& password, + int timeout = 10); + virtual ~Connection(); + + /** + * Connect to MaxScale and request a data stream for a table + * + * @param table The table to stream in `database.table` format + * @param gtid The optional starting GTID position in `domain-server_id-sequence` format + * + * @return True if the connection was successfully created and the stream was successfully requested + */ + bool connect(const std::string& table, const std::string& gtid = ""); + + /** + * Read one change event + * + * @return A Row of data or an empty Row on error. The empty row evaluates + * to false. If the read timed out, string returned by getError is empty. + * + * @see InternalRow + */ + Row read(); + + /** + * Explicitly close the connection + * + * The connection is closed in the destructor if it is still open when it is called + */ + void close(); + + /** + * Get the JSON schema in string form + * + * @return A reference to the string form of theJSON schema + */ + const std::string& schema() const + { + return m_schema; + } + + /** + * Get the latest error + * + * @return The latest error or an empty string if no errors have occurred + */ + const std::string& error() const + { + return m_error; + } + + /** + * Get the types of the fields mapped by field name + * + * @return A map of field names mapped to the SQL type + */ + ValueMap fields() const + { + ValueMap fields; + + for (size_t i = 0; i < m_keys.size(); i++) + { + fields[m_keys[i]] = m_types[i]; + } + + return fields; + } + +private: + int m_fd; + uint16_t m_port; + std::string m_address; + std::string m_user; + std::string m_password; + std::string m_error; + std::string m_schema; + ValueList m_keys; + ValueList m_types; + int m_timeout; + std::vector m_buffer; + std::vector::iterator m_buf_ptr; + Row m_first_row; + bool m_connected; + + bool do_auth(); + bool do_registration(); + bool read_row(std::string& dest); + void process_schema(json_t* json); + Row process_row(json_t*); + bool is_error(const char* str); + + // Lower-level functions + int wait_for_event(short events); + int nointr_read(void *dest, size_t size); + int nointr_write(const void *src, size_t size); +}; + +// Internal representation of a row, used via the Row type +class InternalRow +{ + InternalRow(const InternalRow&) = delete; + InternalRow& operator=(const InternalRow&) = delete; + InternalRow() = delete; +public: + + /** + * Get field count for the row + * + * @return Number of fields in row + */ + size_t length() const + { + return m_values.size(); + } + + /** + * Get the value of a field by index + * + * @param i The field index + * + * @return A reference to the internal value + */ + const std::string& value(size_t i) const + { + return m_values[i]; + } + + /** + * Get the value of a field by name + * + * @param i The field index to get + * + * @return A reference to the internal value + */ + const std::string& value(const std::string& str) const + { + ValueList::const_iterator it = std::find(m_keys.begin(), m_keys.end(), str); + return m_values[it - m_keys.begin()]; + } + + /** + * Get the GTID of this row + * + * @return The GTID of the row in `domain-server_id-sequence` format + */ + const std::string gtid() const + { + std::string s; + s += value("domain"); + s += "-"; + s += value("server_id"); + s += "-"; + s += value("sequence"); + return s; + } + + /** + * Get field names by index + * + * @return Reference to field name + */ + const std::string& key(size_t i) const + { + return m_keys[i]; + } + + /** + * Get field types by index + * + * @return Reference to field type + */ + const std::string& type(size_t i) const + { + return m_types[i]; + } + + ~InternalRow() + { + } + +private: + ValueList m_keys; + ValueList m_types; + ValueList m_values; + + // Only a Connection should construct an InternalRow + friend class Connection; + + InternalRow(const ValueList& keys, + const ValueList& types, + ValueList& values): + m_keys(keys), + m_types(types) + { + m_values.swap(values); + } + +}; + +} diff --git a/connectors/cdc-connector/examples/main.cpp b/connectors/cdc-connector/examples/main.cpp new file mode 100644 index 000000000..a51082d81 --- /dev/null +++ b/connectors/cdc-connector/examples/main.cpp @@ -0,0 +1,51 @@ +/** + * This is an example on how to use the CDC Connector to print the keys and + * their values. + */ + +#include "../cdc_connector.h" +#include + +int main(int argc, char** argv) +{ + + if (argc < 6) + { + std::cout << "Usage: HOST PORT USER PASSWORD DATABASE.TABLE" << std::endl; + std::cout << std::endl; + std::cout << "Note that DATABASE.TABLE must have both database and table " << std::endl; + std::cout << "combined together as one value with a period." << std::endl; + std::cout << std::endl; + return 1; + } + + CDC::Connection conn(argv[1], // Host + atoi(argv[2]), // Port + argv[3], // User + argv[4]); // Password + + if (conn.connect(argv[5])) + { + CDC::Row row; + + while ((row = conn.read())) + { + for (size_t i = 0; i < row->length(); i++) + { + if (i != 0) + { + std::cout << ", "; + } + std::cout << row->key(i) << ": " << row->value(i); + } + + std::cout << std::endl; + } + } + else + { + std::cout << conn.error() << std::endl; + } + + return 0; +} diff --git a/connectors/cdc-connector/python/cdc_connector.i b/connectors/cdc-connector/python/cdc_connector.i new file mode 100644 index 000000000..ca98ce6ca --- /dev/null +++ b/connectors/cdc-connector/python/cdc_connector.i @@ -0,0 +1,9 @@ +%module cdc_connector +%include +%include + +%{ +#include "../cdc_connector.h" +%} + +%include "../cdc_connector.h"