├── .devcontainer ├── Dockerfile └── devcontainer.json ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .vscode └── tasks.json ├── LICENSE ├── Makefile ├── README.md ├── distribution ├── debian │ └── DEBIAN │ │ ├── conffiles │ │ └── control └── make-deb.sh ├── event_kafka.conf.xml ├── mod_event_kafka.cpp └── mod_event_kafka.hpp /.devcontainer/Dockerfile: -------------------------------------------------------------------------------- 1 | #------------------------------------------------------------------------------------------------------------- 2 | # Copyright (c) Microsoft Corporation. All rights reserved. 3 | # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information. 4 | #------------------------------------------------------------------------------------------------------------- 5 | 6 | FROM debian:9 7 | 8 | # https://signalwire.com/docs/signalwire-cli/installation/ 9 | ARG SIGNALWIRE_TOKEN=GenerateYourOwnToken 10 | 11 | # Install git, process tools 12 | RUN apt-get update && apt-get -y install git procps wget tree gnupg2 wget lsb-release apt-transport-https 13 | 14 | # Install C++ tools 15 | RUN apt-get -y install build-essential cmake cppcheck valgrind pkg-config 16 | 17 | # Install Freeswitch dev 18 | RUN wget --http-user=signalwire --http-password=$SIGNALWIRE_TOKEN -O - https://freeswitch.signalwire.com/repo/deb/debian-release/signalwire-freeswitch-repo.gpg | apt-key add - 19 | 20 | RUN echo "machine freeswitch.signalwire.com login signalwire password $SIGNALWIRE_TOKEN" > /etc/apt/auth.conf 21 | 22 | RUN echo "deb https://freeswitch.signalwire.com/repo/deb/freeswitch-1.8/ `lsb_release -sc` main" > /etc/apt/sources.list.d/freeswitch.list 23 | RUN echo "deb-src https://freeswitch.signalwire.com/repo/deb/freeswitch-1.8/ `lsb_release -sc` main" >> /etc/apt/sources.list.d/freeswitch.list 24 | 25 | RUN apt-get update && apt-get -y install libfreeswitch-dev librdkafka-dev libz-dev libssl-dev 26 | 27 | # Clean up 28 | RUN apt-get autoremove -y \ 29 | && apt-get clean -y 30 | # && rm -rf /var/lib/apt/lists/* 31 | 32 | #INSERT_HERE 33 | 34 | # Set the default shell to bash instead of sh 35 | ENV SHELL /bin/bash -------------------------------------------------------------------------------- /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | // See https://aka.ms/vscode-remote/devcontainer.json for format details. 2 | { 3 | "name": "C++", 4 | "dockerFile": "Dockerfile", 5 | "runArgs": [ 6 | "--cap-add=SYS_PTRACE", 7 | "--security-opt", "seccomp=unconfined" 8 | ], 9 | 10 | // "appPort": [], 11 | 12 | "settings": { 13 | "terminal.integrated.shell.linux": "/bin/bash" 14 | }, 15 | 16 | //"postCreateCommand": "make", 17 | 18 | "extensions": [ 19 | "ms-vscode.cpptools" 20 | ] 21 | } -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Run tests 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | 11 | jobs: 12 | mod_event_kafka_job: 13 | runs-on: ubuntu-latest 14 | services: 15 | registry: 16 | image: registry:2 17 | ports: 18 | - 5000:5000 19 | name: Build mod_event_kafka 20 | steps: 21 | # To use this repository's private action, 22 | # you must check out the repository 23 | - name: Checkout 24 | uses: actions/checkout@v2 25 | - name: Prepopulate Docker file 26 | run: | 27 | sed -i 's/#INSERT_HERE/COPY . \/mod_event_kafka/g' .devcontainer/Dockerfile 28 | cat .devcontainer/Dockerfile 29 | # This is the a separate action that sets up buildx runner 30 | - name: Set up Docker Buildx 31 | uses: docker/setup-buildx-action@v1 32 | with: 33 | driver-opts: network=host 34 | # So now you can use Actions' own caching! 35 | - name: Cache Docker layers 36 | uses: actions/cache@v2 37 | with: 38 | path: /tmp/.buildx-cache 39 | key: ${{ runner.os }}-buildx-${{ github.sha }} 40 | restore-keys: | 41 | ${{ runner.os }}-buildx- 42 | - name: Build Docker Container 43 | uses: docker/build-push-action@v2 44 | id: docker_build 45 | with: 46 | # using "load: true" forces the docker driver 47 | # not necessary here, because we set it before 48 | #load: true 49 | push: true 50 | tags: localhost:5000/${{ github.repository }}_build:latest 51 | context: . 52 | file: .devcontainer/Dockerfile 53 | cache-from: type=local,src=/tmp/.buildx-cache 54 | cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max 55 | build-args: | 56 | SIGNALWIRE_TOKEN=${{ secrets.SIGNALWIRE_TOKEN }} 57 | 58 | - name: Compile 59 | run: | 60 | docker run -i localhost:5000/${{ github.repository }}_build:latest bash -c "cd /mod_event_kafka && make && ls" 61 | - name: Move cache 62 | run: | 63 | rm -rf /tmp/.buildx-cache 64 | mv /tmp/.buildx-cache-new /tmp/.buildx-cache 65 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io 3 | 4 | ### C++ ### 5 | # Prerequisites 6 | *.d 7 | 8 | # Compiled Object files 9 | *.slo 10 | *.lo 11 | *.o 12 | *.obj 13 | 14 | # Precompiled Headers 15 | *.gch 16 | *.pch 17 | 18 | # Compiled Dynamic libraries 19 | *.so 20 | *.dylib 21 | *.dll 22 | 23 | # Fortran module files 24 | *.mod 25 | *.smod 26 | 27 | # Compiled Static libraries 28 | *.lai 29 | *.la 30 | *.a 31 | *.lib 32 | 33 | # Executables 34 | *.exe 35 | *.out 36 | *.app 37 | 38 | .DS_Store 39 | 40 | 41 | #intellij 42 | 43 | .idea 44 | *.iml 45 | 46 | 47 | ### CMake ### 48 | CMakeCache.txt 49 | CMakeFiles 50 | CMakeScripts 51 | Testing 52 | Makefile 53 | cmake_install.cmake 54 | install_manifest.txt 55 | compile_commands.json 56 | CTestTestfile.cmake 57 | build 58 | CMakeLists.txt 59 | cmake-build-debug/ 60 | 61 | 62 | #VSCode 63 | .vscode 64 | 65 | 66 | #dist 67 | *.deb 68 | 69 | #vagrant 70 | .vagrant 71 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | // See https://go.microsoft.com/fwlink/?LinkId=733558 3 | // for the documentation about the tasks.json format 4 | "version": "2.0.0", 5 | "tasks": [ 6 | { 7 | "label": "Make", 8 | "command": "make", 9 | }, 10 | { 11 | "label": "Release", 12 | "type": "shell", 13 | "command": "make release" 14 | } 15 | ] 16 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Customise these as appropriate 2 | MODNAME = mod_event_kafka.so 3 | MODOBJ = mod_event_kafka.o 4 | MODCFLAGS = -Wall -Werror 5 | MODLDFLAGS = -lssl 6 | 7 | CXX = g++ 8 | CXXFLAGS = -fPIC -g -ggdb -I/usr/include `pkg-config --cflags freeswitch` $(MODCFLAGS) -std=c++17 -fpermissive -o2 9 | LDFLAGS = `pkg-config --libs freeswitch` -lrdkafka -lz -lpthread -lrt $(MODLDFLAGS) 10 | 11 | .PHONY: all 12 | all: $(MODNAME) 13 | 14 | $(MODNAME): $(MODOBJ) 15 | @$(CXX) -shared -o $@ $(MODOBJ) $(LDFLAGS) 16 | 17 | .cpp.o: $< 18 | @$(CXX) $(CXXFLAGS) -o $@ -c $< 19 | 20 | .PHONY: clean 21 | clean: 22 | rm -f $(MODNAME) $(MODOBJ) 23 | 24 | .PHONY: install 25 | install: $(MODNAME) 26 | install -d $(DESTDIR)/usr/lib/freeswitch/mod 27 | install $(MODNAME) $(DESTDIR)/usr/lib/freeswitch/mod 28 | install -d $(DESTDIR)/etc/freeswitch/autoload_configs 29 | install event_kafka.conf.xml $(DESTDIR)/etc/freeswitch/autoload_configs/ 30 | 31 | .PHONY: release 32 | release: $(MODNAME) 33 | distribution/make-deb.sh 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mod_event_kafka 2 | Freeswitch Kafka Plugin 3 | 4 | [![Build Status](https://github.com/voiceip/mod_event_kafka/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/voiceip/mod_event_kafka/actions/workflows/main.yml) 5 | 6 | Install this plugin to publish all of the freeswitch generated events to Kafka reliably from the freeswitch server. To enable just configure the `event_kafka.conf.xml` 7 | 8 | ```xml 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | ``` 21 | and enable autoloading of the module by adding the following entry in `modules.conf.xml` 22 | 23 | ```xml 24 | 25 | ``` 26 | 27 | 28 | 29 | # Building 30 | 31 | ## IDE Based Build 32 | 33 | We use vscode + docker, to enable easy building on any platform with the use of [remote-container](https://code.visualstudio.com/docs/remote/containers#_getting-started) feature of `Visual Studio Code`. If you are new to this, follow the [getting started guide](https://code.visualstudio.com/docs/remote/containers#_getting-started) 34 | 35 | Open the project in `Visual Studio Code` and just Run Task `Release`. 36 | 37 | 38 | ## Manually Building 39 | 40 | ### Install Dependencies 41 | ```bash 42 | sudo apt-get install libfreeswitch-dev 43 | sudo apt-get install build-essential pkg-config 44 | sudo apt-get install librdkafka-dev libz-dev libssl-dev 45 | ``` 46 | 47 | ### Build 48 | 49 | ``` 50 | make 51 | make install 52 | ``` 53 | 54 | 55 | -------------------------------------------------------------------------------- /distribution/debian/DEBIAN/conffiles: -------------------------------------------------------------------------------- 1 | /etc/freeswitch/autoload_configs/event_kafka.conf.xml 2 | -------------------------------------------------------------------------------- /distribution/debian/DEBIAN/control: -------------------------------------------------------------------------------- 1 | Package: freeswitch-mod-event-kafka 2 | Version: 1._VERSION_ 3 | Architecture: all 4 | Section: base 5 | Priority: standard 6 | Depends: librdkafka1 (>= 0.9.3-1), freeswitch (= _FSVERSION_) 7 | Conflicts: fk-librdkafka 8 | Maintainer: Kinshuk Bairagi 9 | Description: Publish FreeSwitch Event to Kafka 10 | -------------------------------------------------------------------------------- /distribution/make-deb.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -ex 3 | 4 | BUILD_ROOT=$(mktemp -d) 5 | VERSION=$(date +%s) 6 | 7 | make 8 | make install 9 | 10 | cp -r distribution/debian/* $BUILD_ROOT/ 11 | 12 | mkdir -p $BUILD_ROOT/usr/local/lib/ 13 | mkdir -p $BUILD_ROOT/usr/lib/freeswitch/mod 14 | mkdir -p $BUILD_ROOT/etc/freeswitch/autoload_configs/ 15 | 16 | cp /etc/freeswitch/autoload_configs/event_kafka.conf.xml $BUILD_ROOT/etc/freeswitch/autoload_configs/event_kafka.conf.xml 17 | cp /usr/lib/freeswitch/mod/mod_event_kafka.so $BUILD_ROOT/usr/lib/freeswitch/mod/mod_event_kafka.so 18 | 19 | FS_VERSION=$(dpkg -s libfreeswitch-dev | grep "Version" | cut -d ' ' -f 2) 20 | 21 | sed -i "s/_VERSION_/$VERSION/g" $BUILD_ROOT/DEBIAN/control 22 | sed -i "s/_FSVERSION_/$FS_VERSION/g" $BUILD_ROOT/DEBIAN/control 23 | dpkg-deb -Zgzip --build $BUILD_ROOT freeswitch-mod-event-kafka.deb 24 | 25 | rm -rf $BUILD_ROOT 26 | -------------------------------------------------------------------------------- /event_kafka.conf.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /mod_event_kafka.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application 3 | * Copyright (C) 2005-2014, Anthony Minessale II 4 | * 5 | * Version: MPL 1.1 6 | * 7 | * The contents of this file are subject to the Mozilla Public License Version 8 | * 1.1 (the "License"); you may not use this file except in compliance with 9 | * the License. You may obtain a copy of the License at 10 | * http://www.mozilla.org/MPL/ 11 | * 12 | * Software distributed under the License is distributed on an "AS IS" basis, 13 | * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 14 | * for the specific language governing rights and limitations under the 15 | * License. 16 | * 17 | * The Original Code is FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application 18 | * 19 | * The Initial Developer of the Original Code is 20 | * Anthony Minessale II 21 | * Portions created by the Initial Developer are Copyright (C) 22 | * the Initial Developer. All Rights Reserved. 23 | * 24 | * Based on mod_skel by 25 | * Anthony Minessale II 26 | * 27 | * Contributor(s): 28 | * 29 | * Kinshuk Bairagi 30 | * 31 | * mod_event_kafka.c -- Sends FreeSWITCH events to an Kafka broker 32 | * 33 | */ 34 | 35 | #include 36 | #include 37 | #include 38 | #include 39 | #include "mod_event_kafka.hpp" 40 | 41 | namespace mod_event_kafka { 42 | 43 | template 44 | T* malloc_new() 45 | { 46 | return static_cast(std::malloc(sizeof(T) * Muliplier)); 47 | } 48 | 49 | static switch_xml_config_item_t instructions[] = { 50 | SWITCH_CONFIG_ITEM("bootstrap-servers", SWITCH_CONFIG_STRING, CONFIG_RELOADABLE, &globals.brokers, 51 | "localhost:9092", NULL, "bootstrap-servers", "Kafka Bootstrap Brokers"), 52 | SWITCH_CONFIG_ITEM("username", SWITCH_CONFIG_STRING, CONFIG_RELOADABLE, &globals.username, "", NULL, "username", "Username"), 53 | SWITCH_CONFIG_ITEM("password", SWITCH_CONFIG_STRING, CONFIG_RELOADABLE, &globals.password, "", NULL, "password", "Password"), 54 | SWITCH_CONFIG_ITEM("topic", SWITCH_CONFIG_STRING, CONFIG_RELOADABLE, &globals.topic, 55 | "", NULL, "topic", "Kafka Topic"), 56 | SWITCH_CONFIG_ITEM("topic-prefix", SWITCH_CONFIG_STRING, CONFIG_RELOADABLE, &globals.topic_prefix, 57 | "fs", NULL, "topic-prefix", "Kafka Topic Prefix"), 58 | SWITCH_CONFIG_ITEM("buffer-size", SWITCH_CONFIG_INT, CONFIG_RELOADABLE, &globals.buffer_size, 59 | 10, NULL, "buffer-size", "queue.buffering.max.messages"), 60 | SWITCH_CONFIG_ITEM("compression", SWITCH_CONFIG_STRING, CONFIG_RELOADABLE, &globals.compression, 61 | "snappy", NULL, "snappy / lz4 ", "Compression"), 62 | SWITCH_CONFIG_ITEM("event-filter", SWITCH_CONFIG_STRING, CONFIG_RELOADABLE, &globals.event_filter, 63 | "", NULL, "comma separated value of event names", "Event Filter"), 64 | SWITCH_CONFIG_ITEM_END() 65 | }; 66 | 67 | static switch_status_t load_config(switch_bool_t reload) 68 | { 69 | memset(&globals, 0, sizeof(globals)); 70 | if (switch_xml_config_parse_module_settings("event_kafka.conf", reload, instructions) != SWITCH_STATUS_SUCCESS) { 71 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_CRIT, "Could not open event_kafka.conf\n"); 72 | return SWITCH_STATUS_FALSE; 73 | } else { 74 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "event_kafka.conf loaded [brokers: %s, topic/topic_prefix: %s/%s, username: %s, buffer-size: %d, compression: %s]", 75 | globals.brokers, globals.topic, globals.topic_prefix, globals.username, globals.buffer_size, globals.compression); 76 | } 77 | return SWITCH_STATUS_SUCCESS; 78 | } 79 | 80 | 81 | class KafkaEventPublisher { 82 | 83 | 84 | public: 85 | KafkaEventPublisher(){ 86 | 87 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "KafkaEventPublisher Initialising..."); 88 | 89 | load_config(SWITCH_FALSE); 90 | 91 | conf = rd_kafka_conf_new(); 92 | 93 | if (rd_kafka_conf_set(conf, "metadata.broker.list", globals.brokers, errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 94 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 95 | } 96 | 97 | if (rd_kafka_conf_set(conf, "queue.buffering.max.messages", std::to_string(globals.buffer_size).c_str(), errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 98 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 99 | } 100 | 101 | if (rd_kafka_conf_set(conf, "max.in.flight", "1000", errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 102 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 103 | } 104 | 105 | if (rd_kafka_conf_set(conf, "compression.codec", globals.compression, errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 106 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 107 | } 108 | 109 | if (globals.username && globals.username[0] != '\0') { 110 | //username is set, set authentication params 111 | if (rd_kafka_conf_set(conf, "sasl.mechanism", "PLAIN", errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 112 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 113 | } 114 | 115 | if (rd_kafka_conf_set(conf, "security.protocol", "SASL_PLAINTEXT", errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 116 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 117 | } 118 | 119 | if (rd_kafka_conf_set(conf, "sasl.username", globals.username, errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 120 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 121 | } 122 | 123 | if (rd_kafka_conf_set(conf, "sasl.password", globals.password, errstr, sizeof(errstr)) != RD_KAFKA_CONF_OK) { 124 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, errstr); 125 | } 126 | } 127 | 128 | rd_kafka_conf_set_dr_msg_cb(conf, dr_msg_cb); 129 | 130 | producer = rd_kafka_new(RD_KAFKA_PRODUCER, conf, errstr, sizeof(errstr)); 131 | if (!producer) { 132 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Failed to create new producer: %s \n", errstr); 133 | } 134 | 135 | //build topic if not defined 136 | if (globals.topic && globals.topic[0] == '\0') { 137 | std::string topic_str = std::string(globals.topic_prefix) + "_" + std::string(switch_core_get_switchname()); 138 | strcpy(globals.topic, topic_str.c_str()); 139 | } 140 | 141 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "KafkaEventPublisher Topic : %s \n", globals.topic); 142 | 143 | rd_kafka_topic_conf_t *tconf = rd_kafka_topic_conf_new(); 144 | rd_kafka_topic_conf_set(tconf, "message.timeout.ms", "30000", NULL, 0); 145 | 146 | topic = rd_kafka_topic_new(producer, globals.topic, NULL); 147 | if (!topic) { 148 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Failed to create topic %s object: %s \n", globals.topic, rd_kafka_err2str(rd_kafka_last_error())); 149 | } 150 | 151 | _initialized = true; 152 | } 153 | 154 | void PublishEvent(switch_event_t *event) { 155 | 156 | char *uuid = switch_event_get_header(event, "Channel-Call-UUID"); 157 | char *event_json = malloc_new(); 158 | 159 | const switch_status_t json_status = switch_event_serialize_json(event, &event_json); 160 | if (json_status == SWITCH_STATUS_FALSE) { 161 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "json serialization failed in switch\n"); 162 | std::free(event_json); 163 | return; 164 | } 165 | 166 | if(_initialized){ 167 | int resp = send(event_json, uuid ,0); 168 | if (resp == -1){ 169 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Failed to produce, with error %s \n", rd_kafka_err2str(rd_kafka_last_error())); 170 | } else { 171 | //size_t len = strlen(event_json); 172 | //switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG,"Produced message (%zu bytes)", len); 173 | } 174 | rd_kafka_poll(producer, 0); 175 | } else { 176 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "PublishEvent without active KafkaPublisher\n %s \n",event_json); 177 | delete uuid; 178 | std::free(event_json); 179 | } 180 | } 181 | 182 | void Shutdown(){ 183 | //flush within 100ms 184 | rd_kafka_flush(producer, 100); 185 | } 186 | 187 | ~KafkaEventPublisher(){ 188 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "KafkaEventPublisher Destroyed\n"); 189 | rd_kafka_topic_destroy(topic); 190 | rd_kafka_destroy(producer); 191 | } 192 | 193 | private: 194 | 195 | static void dr_msg_cb (rd_kafka_t *rk, const rd_kafka_message_t *rkmessage, void *opaque) { 196 | if (rkmessage->err) { 197 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, " Message delivery failed %s \n",rd_kafka_err2str(rkmessage->err)); 198 | } 199 | else { 200 | //switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, "Message delivered (%zd bytes, partition %d, offset %" PRId64 ") \n",rkmessage->len, rkmessage->partition, rkmessage->offset); 201 | // rd_kafka_message_destroy ((rd_kafka_message_t *)rkmessage); 202 | } 203 | } 204 | 205 | int send(char *data, char *key, int currentCount){ 206 | if(++currentCount <= max_retry_limit){ 207 | int key_length = key == NULL ? 0 : strlen(key); 208 | int result = rd_kafka_produce(topic, RD_KAFKA_PARTITION_UA, 209 | RD_KAFKA_MSG_F_FREE /* Auto Clear Payload */, 210 | (void *)data, strlen(data), 211 | (const void *)key, key_length, 212 | /* Message opaque, provided in 213 | * delivery report callback as 214 | * msg_opaque. */ 215 | NULL); 216 | 217 | auto last_error = rd_kafka_last_error(); 218 | if(result == 0){ 219 | return result; 220 | } else if(last_error == RD_KAFKA_RESP_ERR__QUEUE_FULL) { 221 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG,"queue.buffering.max.messages limit reached, waiting 1sec to flush out.\n"); 222 | std::thread([this, data, currentCount, key]() { 223 | //localqueue is full, hold and flush them. 224 | rd_kafka_poll(producer, 1000/*block for max 1000ms*/); 225 | send(data, key, currentCount); 226 | }) 227 | .detach(); //TODO: limit number of forked threads 228 | return result; 229 | } else { 230 | //not handing other unknown errors 231 | return result; 232 | } 233 | } else { 234 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "KafkaEventPublisher send max_retry_limit hit.\n"); 235 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, "%s\n",data); 236 | // delete data; //TODO: Doesn't work, throws segment fault. 237 | // delete key; 238 | } 239 | return 0; 240 | } 241 | 242 | int max_retry_limit = 3; 243 | bool _initialized = false; 244 | 245 | rd_kafka_t *producer; 246 | rd_kafka_topic_t *topic; 247 | rd_kafka_conf_t *conf; 248 | char errstr[512]; 249 | 250 | }; 251 | 252 | class KafkaModule { 253 | public: 254 | 255 | KafkaModule(switch_loadable_module_interface_t **module_interface, switch_memory_pool_t *pool): _publisher() { 256 | 257 | char *event_filter_name[SWITCH_EVENT_ALL]; 258 | char *switch_event_custom = (char*) std::string("SWITCH_EVENT_CUSTOM::").c_str(); 259 | profile.event_subscriptions = switch_separate_string(globals.event_filter, ',', event_filter_name, (sizeof(event_filter_name) / sizeof(event_filter_name[0]))); 260 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "Found %d subscriptions\n", profile.event_subscriptions); 261 | for (int i = 0; i < profile.event_subscriptions; i++) { 262 | if (switch_name_event(event_filter_name[i], &(profile.event_ids[i])) != SWITCH_STATUS_SUCCESS && !switch_strstr(event_filter_name[i],switch_event_custom) ) { 263 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_CRIT, "The switch event %s was not recognised.\n", event_filter_name[i]); 264 | } else { 265 | // switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "Found subscription for %s event.\n", argv[arg]); 266 | } 267 | } 268 | 269 | if (profile.event_subscriptions > 0 ) { 270 | /* Subscribe events */ 271 | for (int i = 0; i < profile.event_subscriptions; i++) { 272 | if ( switch_strstr(event_filter_name[i], switch_event_custom)) { 273 | if (switch_event_bind_removable(modname, SWITCH_EVENT_CUSTOM, event_filter_name[i] + strlen("SWITCH_EVENT_CUSTOM::"), 274 | event_handler, static_cast(&_publisher),&(profile.event_nodes[i])) != SWITCH_STATUS_SUCCESS) { 275 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Cannot bind to event handler %d!\n",(int)profile.event_ids[i]); 276 | throw std::invalid_argument("Failed to bind event handler for " + std::string(event_filter_name[i])); 277 | } 278 | } else { 279 | if (switch_event_bind_removable(modname, profile.event_ids[i], SWITCH_EVENT_SUBCLASS_ANY, 280 | event_handler, static_cast(&_publisher), &(profile.event_nodes[i])) != SWITCH_STATUS_SUCCESS) { 281 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Cannot bind to event handler %d!\n",(int)profile.event_ids[i]); 282 | throw std::invalid_argument( "Failed to bind event handler for " + std::string(event_filter_name[i])); 283 | } 284 | } 285 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_INFO, "Subscribed to %s event.\n", event_filter_name[i]); 286 | } 287 | 288 | } else { 289 | // Subscribe to all switch events of any subclass 290 | // Store a pointer to ourself in the user data 291 | if (switch_event_bind_removable(modname, SWITCH_EVENT_ALL, SWITCH_EVENT_SUBCLASS_ANY, event_handler, 292 | static_cast(&_publisher), &_node) 293 | != SWITCH_STATUS_SUCCESS) { 294 | throw std::runtime_error("Couldn't bind to switch events."); 295 | } 296 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, "Subscribed to ALL events\n"); 297 | 298 | } 299 | 300 | 301 | // Create our module interface registration 302 | *module_interface = switch_loadable_module_create_module_interface(pool, modname); 303 | 304 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, "Module loaded completed\n"); 305 | 306 | }; 307 | 308 | void Shutdown() { 309 | // Send term message 310 | _publisher.Shutdown(); 311 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, "Shutdown requested, flushing publisher\n"); 312 | } 313 | 314 | ~KafkaModule() { 315 | // Unsubscribe from the switch events 316 | if (profile.event_subscriptions > 0 ) { 317 | for (int i = 0; i < profile.event_subscriptions; i++) { 318 | switch_event_unbind(&(profile.event_nodes[i])); 319 | } 320 | } else { 321 | switch_event_unbind(&_node); 322 | } 323 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, "Module shut down\n"); 324 | } 325 | 326 | private: 327 | 328 | // Dispatches events to the publisher 329 | static void event_handler(switch_event_t *event) { 330 | try { 331 | KafkaEventPublisher *publisher = static_cast(event->bind_user_data); 332 | publisher->PublishEvent(event); 333 | } catch (std::exception const &ex) { 334 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, "Error publishing event to Kafka: %s\n", 335 | ex.what()); 336 | } catch (...) { // Exceptions must not propogate to C caller 337 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_WARNING, "Unknown error publishing event to Kafka\n"); 338 | } 339 | } 340 | 341 | switch_event_node_t *_node; 342 | KafkaEventPublisher _publisher; 343 | 344 | }; 345 | 346 | 347 | //*****************************// 348 | // GLOBALS // 349 | //*****************************// 350 | std::unique_ptr module; 351 | 352 | 353 | //*****************************// 354 | // Module interface funtions // 355 | //*****************************// 356 | SWITCH_MODULE_LOAD_FUNCTION(mod_event_kafka_load) { 357 | try { 358 | module = std::make_unique(module_interface, pool); 359 | return SWITCH_STATUS_SUCCESS; 360 | } catch(...) { // Exceptions must not propogate to C caller 361 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Error loading Kafka Event module\n"); 362 | return SWITCH_STATUS_GENERR; 363 | } 364 | 365 | } 366 | 367 | 368 | SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_event_kafka_shutdown) { 369 | try { 370 | // Tell the module to shutdown 371 | module->Shutdown(); 372 | // Free the module object 373 | module.reset(); 374 | } catch(std::exception const &ex) { 375 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Error shutting down Kafka Event module: %s\n", 376 | ex.what()); 377 | } catch(...) { // Exceptions must not propogate to C caller 378 | switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Unknown error shutting down Kafka Event module\n"); 379 | } 380 | return SWITCH_STATUS_SUCCESS; 381 | } 382 | 383 | } 384 | 385 | -------------------------------------------------------------------------------- /mod_event_kafka.hpp: -------------------------------------------------------------------------------- 1 | #ifndef MOD_EVENT_KAFKA_H 2 | #define MOD_EVENT_KAFKA_H 3 | 4 | extern "C" { 5 | #include "librdkafka/rdkafka.h" 6 | } 7 | 8 | namespace mod_event_kafka { 9 | 10 | static struct { 11 | char *brokers; 12 | char *topic_prefix; 13 | char *topic; 14 | char *username; 15 | char *password; 16 | int buffer_size; 17 | char *compression; 18 | char *event_filter; 19 | } globals; 20 | 21 | 22 | static struct { 23 | /* Array to store the possible event subscriptions */ 24 | int event_subscriptions; 25 | switch_event_node_t *event_nodes[SWITCH_EVENT_ALL]; 26 | switch_event_types_t event_ids[SWITCH_EVENT_ALL]; 27 | switch_event_node_t *eventNode; 28 | } profile; 29 | 30 | SWITCH_MODULE_LOAD_FUNCTION(mod_event_kafka_load); 31 | SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_event_kafka_shutdown); 32 | 33 | extern "C" { 34 | SWITCH_MODULE_DEFINITION(mod_event_kafka, mod_event_kafka_load, mod_event_kafka_shutdown, NULL); 35 | }; 36 | }; 37 | 38 | #endif // MOD_EVENT_KAFKA_H 39 | --------------------------------------------------------------------------------