diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..f6b4242 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,5 @@ +.editorconfig +.codeclimate.yml +*.png +*.md +.venv diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..662200a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +root = true + +[*] +indent_style = tab +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.py] +max_line_length = 99 +indent_style = space + +[*.{yaml, yml}] +indent_style = space diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b0f060c --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +.venv +*.pyc +*.egg-info +/build +/dist + +*.yaml +!example-config.yaml + +*.log +*.log.* + +*.db diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..3afa3d4 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,38 @@ +image: docker:stable + +stages: +- build +- push + +default: + before_script: + - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + +build: + stage: build + script: + - docker pull $CI_REGISTRY_IMAGE:latest || true + - docker build --pull --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA . + - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA + +push latest: + stage: push + only: + - master + variables: + GIT_STRATEGY: none + script: + - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA + - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:latest + - docker push $CI_REGISTRY_IMAGE:latest + +push tag: + stage: push + variables: + GIT_STRATEGY: none + except: + - master + script: + - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA + - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME + - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..37bf4d3 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,32 @@ +FROM docker.io/alpine:3.10 + +ENV UID=1337 \ + GID=1337 + +RUN apk add --no-cache \ + py3-pillow \ + py3-aiohttp \ + py3-magic \ + py3-sqlalchemy \ + py3-psycopg2 \ + py3-ruamel.yaml \ + # Indirect dependencies + #commonmark + py3-future \ + #alembic + py3-mako \ + py3-dateutil \ + py3-markupsafe \ + py3-six \ + py3-idna \ + # Other dependencies + ca-certificates \ + su-exec + +COPY . /opt/mautrix-twilio +WORKDIR /opt/mautrix-twilio +RUN pip3 install . + +VOLUME /data + +CMD ["/opt/mautrix-twilio/docker-run.sh"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, 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 +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..77f29c7 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# mautrix-twilio +A Matrix-Twilio relaybot bridge. + +## Discussion +Matrix room: [`#twilio:maunium.net`](https://matrix.to/#/#twilio:maunium.net) diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..0c4babf --- /dev/null +++ b/alembic.ini @@ -0,0 +1,36 @@ +[alembic] +script_location = alembic + +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..0fc1f7e --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,52 @@ +from alembic import context +from sqlalchemy import engine_from_config, pool +from logging.config import fileConfig + +import sys +from os.path import abspath, dirname + +sys.path.insert(0, dirname(dirname(abspath(__file__)))) + +from mautrix.util.db import Base +from mautrix_twilio.config import Config +import mautrix_twilio.db + +config = context.config +mxtw_config_path = context.get_x_argument(as_dictionary=True).get("config", "config.yaml") +mxtw_config = Config(mxtw_config_path, None, None) +mxtw_config.load() +config.set_main_option("sqlalchemy.url", + mxtw_config.get("appservice.database", "sqlite:///mautrix-twilio.db")) +fileConfig(config.config_file_name) +target_metadata = Base.metadata + + +def run_migrations_offline(): + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/8e87452589a1_initial_revision.py b/alembic/versions/8e87452589a1_initial_revision.py new file mode 100644 index 0000000..3d0e6b3 --- /dev/null +++ b/alembic/versions/8e87452589a1_initial_revision.py @@ -0,0 +1,63 @@ +"""Initial revision + +Revision ID: 8e87452589a1 +Revises: +Create Date: 2019-09-22 01:10:14.783562 + +""" +from alembic import op +import sqlalchemy as sa + +from mautrix.bridge.db.mx_room_state import PowerLevelType + + +# revision identifiers, used by Alembic. +revision = '8e87452589a1' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('message', + sa.Column('mxid', sa.String(length=255), nullable=True), + sa.Column('mx_room', sa.String(length=255), nullable=True), + sa.Column('tw_receiver', sa.String(length=127), nullable=False), + sa.Column('twid', sa.String(length=127), nullable=False), + sa.PrimaryKeyConstraint('tw_receiver', 'twid') + ) + op.create_table('mx_room_state', + sa.Column('room_id', sa.String(length=255), nullable=False), + sa.Column('power_levels', PowerLevelType(), nullable=True), + sa.PrimaryKeyConstraint('room_id') + ) + op.create_table('mx_user_profile', + sa.Column('room_id', sa.String(length=255), nullable=False), + sa.Column('user_id', sa.String(length=255), nullable=False), + sa.Column('membership', sa.Enum('JOIN', 'LEAVE', 'INVITE', 'BAN', 'KNOCK', name='membership'), nullable=False), + sa.Column('displayname', sa.String(), nullable=True), + sa.Column('avatar_url', sa.String(length=255), nullable=True), + sa.PrimaryKeyConstraint('room_id', 'user_id') + ) + op.create_table('portal', + sa.Column('twid', sa.String(length=127), nullable=False), + sa.Column('mxid', sa.String(length=255), nullable=True), + sa.PrimaryKeyConstraint('twid') + ) + op.create_table('puppet', + sa.Column('twid', sa.String(length=127), nullable=False), + sa.Column('matrix_registered', sa.Boolean(), server_default=sa.text('0'), nullable=False), + sa.PrimaryKeyConstraint('twid') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('puppet') + op.drop_table('portal') + op.drop_table('mx_user_profile') + op.drop_table('mx_room_state') + op.drop_table('message') + # ### end Alembic commands ### diff --git a/docker-run.sh b/docker-run.sh new file mode 100755 index 0000000..f698a4f --- /dev/null +++ b/docker-run.sh @@ -0,0 +1,36 @@ +#!/bin/sh + +# Define functions. +function fixperms { + chown -R $UID:$GID /data /opt/mautrix-twilio +} + +cd /opt/mautrix-twilio + +if [ ! -f /data/config.yaml ]; then + cp example-config.yaml /data/config.yaml + echo "Didn't find a config file." + echo "Copied default config file to /data/config.yaml" + echo "Modify that config file to your liking." + echo "Start the container again after that to generate the registration file." + fixperms + exit +fi + +# Replace database path in config. +sed -i "s#sqlite:///mautrix-twilio.db#sqlite:////data/mautrix-twilio.db#" /data/config.yaml + +# Check that database is in the right state +alembic -x config=/data/config.yaml upgrade head + +if [ ! -f /data/registration.yaml ]; then + python3 -m mautrix_twilio -g -c /data/config.yaml -r /data/registration.yaml + echo "Didn't find a registration file." + echo "Generated one for you." + echo "Copy that over to synapses app service directory." + fixperms + exit +fi + +fixperms +exec su-exec $UID:$GID python3 -m mautrix_twilio -c /data/config.yaml diff --git a/example-config.yaml b/example-config.yaml new file mode 100644 index 0000000..df4f89e --- /dev/null +++ b/example-config.yaml @@ -0,0 +1,129 @@ +# Homeserver details +homeserver: + # The address that this appservice can use to connect to the homeserver. + address: https://matrix.example.com + # The domain of the homeserver (for MXIDs, etc). + domain: example.com + # Whether or not to verify the SSL certificate of the homeserver. + # Only applies if address starts with https:// + verify_ssl: true + +# Application service host/registration related details +# Changing these values requires regeneration of the registration. +appservice: + # The address that the homeserver can use to connect to this appservice. + address: http://localhost:29322 + + # The hostname and port where this appservice should listen. + hostname: 0.0.0.0 + port: 29322 + # The maximum body size of appservice API requests (from the homeserver) in mebibytes + # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s + max_body_size: 1 + + # The full URI to the database. SQLite and Postgres are fully supported. + # Other DBMSes supported by SQLAlchemy may or may not work. + # Format examples: + # SQLite: sqlite:///filename.db + # Postgres: postgres://username:password@hostname/dbname + database: sqlite:///mautrix-twilio.db + + # The unique ID of this appservice. + id: twilio + # Username of the appservice bot. + bot_username: twiliobot + # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty + # to leave display name/avatar as-is. + bot_displayname: Twilio bridge bot + bot_avatar: mxc://maunium.net/FYuKJHaCrSeSpvBJfHwgYylP + + # Community ID for bridged users (changes registration file) and rooms. + # Must be created manually. + community_id: null + + # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. + as_token: "This value is generated when generating the registration" + hs_token: "This value is generated when generating the registration" + +# Bridge config +bridge: + # Localpart template of MXIDs for remote users. + # {userid} is replaced with the phone number of the user (international format without +). + username_template: "twilio_whatsapp_{userid}" + # Displayname template for remote users. + # {displayname} is replaced with the phone number of the user (international format without +). + displayname_template: "+{displayname} (WhatsApp)" + + # The prefix for commands. Only required in non-management rooms. + command_prefix: "!tw" + + # Whether or not created rooms should have federation enabled. + # If false, created portal rooms will never be federated. + federate_rooms: true + # Initial room state for created rooms. + initial_state: + m.room.power_levels: + events_default: 0 + users_default: 0 + state_default: 50 + events: + m.room.avatar: 0 + m.room.name: 0 + m.room.topic: 0 + + # Permissions for using the bridge. + # Permitted values: + # user - Use the bridge with puppeting. + # admin - Use and administrate the bridge. + # Permitted keys: + # * - All Matrix users + # domain - All users on that homeserver + # mxid - Specific user + permissions: + "example.com": "user" + "@admin:example.com": "admin" + +# Twilio webhook settings. +twilio: + # Twilio account ID + account_id: AC1082dcd0e9ae51404f6cae3581edfbff + # Twilio phone number to send messages from. + sender_id: whatsapp:+1415550199 + # Your Twilio auth token (get from Twilio dashboard front page) + secret: 2035141f21a001604e763c009aa3be4c + # Path prefix for webhook endpoints. Subpaths are /status and /receive. + # Note that the webhook must be put behind a reverse proxy with https. + webhook_path: /twilio + +# Python logging configuration. +# +# See section 16.7.2 of the Python documentation for more info: +# https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema +logging: + version: 1 + formatters: + colored: + (): mautrix.util.color_log.ColorFormatter + format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" + normal: + format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" + handlers: + file: + class: logging.handlers.RotatingFileHandler + formatter: normal + filename: ./mautrix-twilio.log + maxBytes: 10485760 + backupCount: 10 + console: + class: logging.StreamHandler + formatter: colored + loggers: + mau: + level: DEBUG + fbchat: + level: DEBUG + aiohttp: + level: INFO + root: + level: DEBUG + handlers: [file, console] diff --git a/mautrix_twilio/__init__.py b/mautrix_twilio/__init__.py new file mode 100644 index 0000000..83bb954 --- /dev/null +++ b/mautrix_twilio/__init__.py @@ -0,0 +1,2 @@ +__version__ = "0.1.0.dev1" +__author__ = "Tulir Asokan " diff --git a/mautrix_twilio/__main__.py b/mautrix_twilio/__main__.py new file mode 100644 index 0000000..ede56c0 --- /dev/null +++ b/mautrix_twilio/__main__.py @@ -0,0 +1,55 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from mautrix.bridge import Bridge + +from .config import Config +from .twilio import TwilioHandler, TwilioClient +from .matrix import MatrixHandler +from .sqlstatestore import SQLStateStore +from .context import Context +from .puppet import init as init_puppet +from .portal import init as init_portal +from .user import init as init_user +from .db import init as init_db +from . import __version__ + + +class TwilioBridge(Bridge): + name = "mautrix-twilio" + command = "python -m mautrix-twilio" + description = "A Matrix-Twilio relaybot bridge." + version = __version__ + config_class = Config + matrix_class = MatrixHandler + state_store_class = SQLStateStore + + config: Config + twilio: TwilioHandler + twilio_client: TwilioClient + + def prepare_bridge(self) -> None: + init_db(self.db) + self.twilio_client = TwilioClient(config=self.config, loop=self.loop) + context = Context(az=self.az, config=self.config, twc=self.twilio_client, loop=self.loop) + context.mx = self.matrix = MatrixHandler(self.az, self.config, self.loop) + context.tw = self.twilio = TwilioHandler(context) + init_user(context) + init_portal(context) + init_puppet(context) + self.az.app.add_subapp(self.config["twilio.webhook_path"], self.twilio.app) + + +TwilioBridge().run() diff --git a/mautrix_twilio/config.py b/mautrix_twilio/config.py new file mode 100644 index 0000000..9995933 --- /dev/null +++ b/mautrix_twilio/config.py @@ -0,0 +1,74 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Dict, Tuple, List, Any + +from mautrix.types import UserID +from mautrix.bridge.config import BaseBridgeConfig, ConfigUpdateHelper + + +class Config(BaseBridgeConfig): + def do_update(self, helper: ConfigUpdateHelper) -> None: + super().do_update(helper) + + copy, copy_dict = helper.copy, helper.copy_dict + + copy("appservice.community_id") + + copy("bridge.username_template") + copy("bridge.command_prefix") + + copy("bridge.federate_rooms") + copy("bridge.initial_state") + + copy_dict("bridge.permissions") + + copy("twilio.account_id") + copy("twilio.sender_id") + copy("twilio.secret") + copy("twilio.webhook_path") + + def _get_permissions(self, key: str) -> Tuple[bool, bool]: + level = self["bridge.permissions"].get(key, "") + admin = level == "admin" + user = level == "user" or admin + return user, admin + + def get_permissions(self, mxid: UserID) -> Tuple[bool, bool]: + permissions = self["bridge.permissions"] or {} + if mxid in permissions: + return self._get_permissions(mxid) + + homeserver = mxid[mxid.index(":") + 1:] + if homeserver in permissions: + return self._get_permissions(homeserver) + + return self._get_permissions("*") + + @property + def namespaces(self) -> Dict[str, List[Dict[str, Any]]]: + homeserver = self["homeserver.domain"] + + username_format = self["bridge.username_template"].lower().format(userid=".+") + group_id = ({"group_id": self["appservice.community_id"]} + if self["appservice.community_id"] else {}) + + return { + "users": [{ + "exclusive": True, + "regex": f"@{username_format}:{homeserver}", + **group_id, + }], + } diff --git a/mautrix_twilio/context.py b/mautrix_twilio/context.py new file mode 100644 index 0000000..37b2e8a --- /dev/null +++ b/mautrix_twilio/context.py @@ -0,0 +1,47 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Optional, Tuple, TYPE_CHECKING +from asyncio import AbstractEventLoop + +from mautrix.appservice import AppService + +from .config import Config + +if TYPE_CHECKING: + from .matrix import MatrixHandler + from .twilio import TwilioHandler, TwilioClient + + +class Context: + az: AppService + config: Config + twc: 'TwilioClient' + loop: AbstractEventLoop + mx: Optional['MatrixHandler'] + tw: Optional['TwilioHandler'] + + def __init__(self, az: AppService, config: Config, twc: 'TwilioClient', loop: AbstractEventLoop + ) -> None: + self.az = az + self.config = config + self.twc = twc + self.loop = loop + self.mx = None + self.tw = None + + @property + def core(self) -> Tuple[AppService, Config, AbstractEventLoop]: + return self.az, self.config, self.loop diff --git a/mautrix_twilio/db/__init__.py b/mautrix_twilio/db/__init__.py new file mode 100644 index 0000000..750b466 --- /dev/null +++ b/mautrix_twilio/db/__init__.py @@ -0,0 +1,30 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from sqlalchemy.engine.base import Engine + +from mautrix.bridge.db import UserProfile, RoomState + +from .puppet import Puppet +from .portal import Portal +from .message import Message + + +def init(db_engine: Engine) -> None: + for table in (UserProfile, RoomState, Puppet, Portal, Message): + table.db = db_engine + table.t = table.__table__ + table.c = table.t.c + table.column_names = table.c.keys() diff --git a/mautrix_twilio/db/message.py b/mautrix_twilio/db/message.py new file mode 100644 index 0000000..9f9e43e --- /dev/null +++ b/mautrix_twilio/db/message.py @@ -0,0 +1,47 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Optional, Iterable, TYPE_CHECKING + +from sqlalchemy import Column, String, and_ + +from mautrix.util.db import Base +from mautrix.types import RoomID, EventID + +if TYPE_CHECKING: + from ..twilio import TwilioUserID, TwilioMessageID + + +class Message(Base): + __tablename__ = "message" + + mxid: EventID = Column(String(255)) + mx_room: RoomID = Column(String(255)) + tw_receiver: 'TwilioUserID' = Column(String(127), primary_key=True) + twid: 'TwilioMessageID' = Column(String(127), primary_key=True) + + @classmethod + def get_all_by_twid(cls, twid: 'TwilioMessageID', tw_receiver: 'TwilioUserID' + ) -> Iterable['Message']: + return cls._select_all(cls.c.twid == twid, cls.c.tw_receiver == tw_receiver) + + @classmethod + def get_by_twid(cls, twid: 'TwilioMessageID', tw_receiver: 'TwilioUserID' + ) -> Optional['Message']: + return cls._select_one_or_none(and_(cls.c.twid == twid, cls.c.tw_receiver == tw_receiver)) + + @classmethod + def get_by_mxid(cls, mxid: EventID, mx_room: RoomID) -> Optional['Message']: + return cls._select_one_or_none(and_(cls.c.mxid == mxid, cls.c.mx_room == mx_room)) diff --git a/mautrix_twilio/db/portal.py b/mautrix_twilio/db/portal.py new file mode 100644 index 0000000..05aaf9f --- /dev/null +++ b/mautrix_twilio/db/portal.py @@ -0,0 +1,39 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Optional, TYPE_CHECKING + +from sqlalchemy import Column, String + +from mautrix.util.db import Base +from mautrix.types import RoomID + +if TYPE_CHECKING: + from ..twilio import TwilioUserID + + +class Portal(Base): + __tablename__ = "portal" + + twid: 'TwilioUserID' = Column(String(127), primary_key=True) + mxid: RoomID = Column(String(255), nullable=True) + + @classmethod + def get_by_twid(cls, twid: 'TwilioUserID') -> Optional['Portal']: + return cls._select_one_or_none(cls.c.twid == twid) + + @classmethod + def get_by_mxid(cls, mxid: RoomID) -> Optional['Portal']: + return cls._select_one_or_none(cls.c.mxid == mxid) diff --git a/mautrix_twilio/db/puppet.py b/mautrix_twilio/db/puppet.py new file mode 100644 index 0000000..5cae73c --- /dev/null +++ b/mautrix_twilio/db/puppet.py @@ -0,0 +1,35 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Optional, TYPE_CHECKING + +from sqlalchemy import Column, String, Boolean +from sqlalchemy.sql import expression + +from mautrix.util.db import Base + +if TYPE_CHECKING: + from ..twilio import TwilioUserID + + +class Puppet(Base): + __tablename__ = "puppet" + + twid: 'TwilioUserID' = Column(String(127), primary_key=True) + matrix_registered: bool = Column(Boolean, nullable=False, server_default=expression.false()) + + @classmethod + def get_by_twid(cls, twid: 'TwilioUserID') -> Optional['Puppet']: + return cls._select_one_or_none(cls.c.twid == twid) diff --git a/mautrix_twilio/matrix.py b/mautrix_twilio/matrix.py new file mode 100644 index 0000000..1345353 --- /dev/null +++ b/mautrix_twilio/matrix.py @@ -0,0 +1,50 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Optional +import asyncio + +from mautrix.types import UserID, RoomID, Event, MessageEvent, StateEvent +from mautrix.appservice import AppService +from mautrix.bridge import BaseMatrixHandler + +from .config import Config + +from . import user as u, portal as po, puppet as pu + + +class MatrixHandler(BaseMatrixHandler): + def __init__(self, az: AppService, config: Config, + loop: Optional[asyncio.AbstractEventLoop] = None) -> None: + super(MatrixHandler, self).__init__(az, config, loop=loop) + + async def get_user(self, user_id: UserID) -> 'u.User': + return u.User.get(user_id) + + async def get_portal(self, room_id: RoomID) -> 'po.Portal': + return po.Portal.get_by_mxid(room_id) + + async def get_puppet(self, user_id: UserID) -> 'pu.Puppet': + return pu.Puppet.get_by_mxid(user_id) + + @staticmethod + async def allow_bridging_message(user: 'u.User', portal: 'po.Portal') -> bool: + return user.is_whitelisted + + def filter_matrix_event(self, evt: Event) -> bool: + if not isinstance(evt, (MessageEvent, StateEvent)): + return True + return (evt.sender == self.az.bot_mxid + or pu.Puppet.get_twid_from_mxid(evt.sender) is not None) diff --git a/mautrix_twilio/portal.py b/mautrix_twilio/portal.py new file mode 100644 index 0000000..b7e3a3f --- /dev/null +++ b/mautrix_twilio/portal.py @@ -0,0 +1,225 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Dict, Optional, TYPE_CHECKING +import mimetypes +import asyncio + +from mautrix.types import (RoomID, StrippedStateEvent, MediaMessageEventContent, MessageType, + FileInfo, MessageEventContent, EventID, EventType) +from mautrix.bridge import BasePortal +from mautrix.appservice import IntentAPI + +from .config import Config +from .db import Portal as DBPortal, Message as DBMessage +from .twilio import (TwilioUserID, TwilioClient, TwilioMessageEvent, TwilioStatusEvent, + TwilioMessageStatus, TwilioMessageID) +from . import puppet as p, user as u + +if TYPE_CHECKING: + from .context import Context + +config: Config + + +class Portal(BasePortal): + twc: TwilioClient + + by_mxid: Dict[RoomID, 'Portal'] = {} + by_twid: Dict[TwilioUserID, 'Portal'] = {} + + twid: TwilioUserID + mxid: Optional[RoomID] + + _db_instance: DBPortal + + _main_intent: Optional[IntentAPI] + _create_room_lock: asyncio.Lock + _send_lock: asyncio.Lock + + def __init__(self, twid: TwilioUserID, mxid: Optional[RoomID] = None, + db_instance: Optional[DBPortal] = None) -> None: + super().__init__() + self.twid = twid + self.mxid = mxid + + self._db_instance = db_instance + self._main_intent = None + self._create_room_lock = asyncio.Lock() + self._send_lock = asyncio.Lock() + self.log = self.log.getChild(self.twid) + + self.by_twid[self.twid] = self + if self.mxid: + self.by_mxid[self.mxid] = self + + @property + def db_instance(self) -> DBPortal: + if not self._db_instance: + self._db_instance = DBPortal(twid=self.twid, mxid=self.mxid) + return self._db_instance + + @classmethod + def from_db(cls, db_portal: DBPortal) -> 'Portal': + return Portal(twid=db_portal.twid, mxid=db_portal.mxid, db_instance=db_portal) + + def save(self) -> None: + self.db_instance.edit(mxid=self.mxid) + + def delete(self) -> None: + self.by_twid.pop(self.twid, None) + self.by_mxid.pop(self.mxid, None) + if self._db_instance: + self._db_instance.delete() + + @property + def main_intent(self) -> IntentAPI: + if not self._main_intent: + self._main_intent = p.Puppet.get_by_twid(self.twid).intent + return self._main_intent + + async def create_matrix_room(self) -> RoomID: + if self.mxid: + return self.mxid + async with self._create_room_lock: + try: + return await self._create_matrix_room() + except Exception: + self.log.exception("Failed to create portal") + + async def _create_matrix_room(self) -> RoomID: + if self.mxid: + return self.mxid + + self.log.debug("Creating Matrix room") + puppet = p.Puppet.get_by_twid(self.twid) + await puppet.update_displayname() + creation_content = { + "m.federate": config["bridge.federate_rooms"] + } + initial_state = {EventType.find(event_type): StrippedStateEvent.deserialize({ + "type": event_type, + "state_key": "", + "content": content + }) for event_type, content in config["bridge.initial_state"].items()} + if EventType.ROOM_POWER_LEVELS in initial_state: + initial_state[EventType.ROOM_POWER_LEVELS].content.users[self.az.bot_mxid] = 100 + self.mxid = await self.az.intent.create_room(name=puppet.displayname, + invitees=[self.main_intent.mxid, + "@tulir:pc.mau.dev"], + creation_content=creation_content, + initial_state=list(initial_state.values())) + if not self.mxid: + raise Exception("Failed to create room: no mxid received") + self.save() + self.log.debug(f"Matrix room created: {self.mxid}") + self.by_mxid[self.mxid] = self + await self.main_intent.join_room_by_id(self.mxid) + return self.mxid + + async def handle_twilio_message(self, message: TwilioMessageEvent) -> None: + await self.create_matrix_room() + mxid = None + + if message.media: + resp = await self.az.http_session.get(message.media.url) + data = await resp.read() + mime = message.media.mime_type + mxc = await self.main_intent.upload_media(data, mime) + msgtype = MessageType.FILE + if mime.startswith("image/"): + msgtype = MessageType.IMAGE + elif mime.startswith("video/"): + msgtype = MessageType.VIDEO + elif mime.startswith("audio/"): + msgtype = MessageType.AUDIO + ext = mimetypes.guess_extension(mime) + content = MediaMessageEventContent(body=f"{message.id}{ext}", msgtype=msgtype, url=mxc, + info=FileInfo(size=len(data), mimetype=mime)) + await self.main_intent.send_message(self.mxid, content) + + if message.body: + mxid = await self.main_intent.send_text(self.mxid, message.body) + + if not mxid: + mxid = await self.main_intent.send_notice(self.mxid, "Message with unknown content") + + msg = DBMessage(mxid=mxid, mx_room=self.mxid, tw_receiver=self.twid, twid=message.id) + msg.insert() + + async def handle_twilio_status(self, status: TwilioStatusEvent) -> None: + if not self.mxid: + return + async with self._send_lock: + msg = DBMessage.get_by_twid(status.id, self.twid) + if status.status == TwilioMessageStatus.DELIVERED: + await self.az.intent.mark_read(self.mxid, msg.mxid) + elif status.status == TwilioMessageStatus.READ: + await self.main_intent.mark_read(self.mxid, msg.mxid) + elif status.status == TwilioMessageStatus.UNDELIVERED: + await self.az.intent.react(self.mxid, msg.mxid, "\u274c") + + async def handle_matrix_message(self, sender: 'u.User', message: MessageEventContent, + event_id: EventID) -> None: + async with self._send_lock: + if message.msgtype == MessageType.TEXT: + resp = await self.twc.send_message(self.twid, message.body) + elif message.msgtype in (MessageType.AUDIO, MessageType.VIDEO, MessageType.IMAGE, + MessageType.FILE): + url = self.main_intent.api.get_download_url(message.url) + resp = await self.twc.send_message(self.twid, media=url) + else: + self.log.debug(f"Ignoring unknown message {message}") + return + self.log.debug(f"Twilio send response: {resp}") + DBMessage(mxid=event_id, mx_room=self.mxid, tw_receiver=self.twid, + twid=TwilioMessageID(resp["sid"])).insert() + + @classmethod + def get_by_mxid(cls, mxid: RoomID) -> Optional['Portal']: + try: + return cls.by_mxid[mxid] + except KeyError: + pass + + db_portal = DBPortal.get_by_mxid(mxid) + if db_portal: + return cls.from_db(db_portal) + + return None + + @classmethod + def get_by_twid(cls, twid: TwilioUserID, create: bool = True) -> Optional['Portal']: + try: + return cls.by_twid[twid] + except KeyError: + pass + + db_portal = DBPortal.get_by_twid(twid) + if db_portal: + return cls.from_db(db_portal) + + if create: + portal = cls(twid=twid) + portal.db_instance.insert() + return portal + + return None + + +def init(context: 'Context') -> None: + global config + Portal.az, config, Portal.loop = context.core + Portal.twc = context.twc diff --git a/mautrix_twilio/puppet.py b/mautrix_twilio/puppet.py new file mode 100644 index 0000000..bfe61ca --- /dev/null +++ b/mautrix_twilio/puppet.py @@ -0,0 +1,128 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Optional, Dict, TYPE_CHECKING + +from mautrix.types import UserID +from mautrix.bridge import BasePuppet +from mautrix.util.simple_template import SimpleTemplate + +from .config import Config +from .db import Puppet as DBPuppet +from .twilio import TwilioUserID + +if TYPE_CHECKING: + from .context import Context + +config: Config + + +class Puppet(BasePuppet): + hs_domain: str + twid_template: SimpleTemplate[int] = SimpleTemplate("whatsapp:+{number}", "number", type=int) + mxid_template: SimpleTemplate[str] + displayname_template: SimpleTemplate[str] + + by_twid: Dict[TwilioUserID, 'Puppet'] = {} + + twid: TwilioUserID + + _db_instance: Optional[DBPuppet] + + def __init__(self, twid: TwilioUserID, is_registered: bool = False, + db_instance: Optional[DBPuppet] = None) -> None: + super().__init__() + self.twid = twid + self.is_registered = is_registered + self._db_instance = db_instance + self.intent = self.az.intent.user(self.mxid) + self.log = self.log.getChild(self.twid) + self.by_twid[self.twid] = self + + @property + def phone_number(self) -> int: + return self.twid_template.parse(self.twid) + + @property + def mxid(self) -> UserID: + return UserID(self.mxid_template.format_full(str(self.phone_number))) + + @property + def displayname(self) -> str: + return self.displayname_template.format_full(str(self.phone_number)) + + @property + def db_instance(self) -> DBPuppet: + if not self._db_instance: + self._db_instance = DBPuppet(twid=self.twid, matrix_registered=self.is_registered) + return self._db_instance + + @classmethod + def from_db(cls, db_puppet: DBPuppet) -> 'Puppet': + return cls(twid=db_puppet.twid, is_registered=db_puppet.matrix_registered, + db_instance=db_puppet) + + def save(self) -> None: + self.db_instance.edit(matrix_registered=self.is_registered) + + async def update_displayname(self) -> None: + await self.intent.set_displayname(self.displayname) + + @classmethod + def get_by_twid(cls, twid: TwilioUserID, create: bool = True) -> Optional['Puppet']: + print("GET BY TWID", twid) + try: + return cls.by_twid[twid] + except KeyError: + pass + + db_puppet = DBPuppet.get_by_twid(twid) + if db_puppet: + return cls.from_db(db_puppet) + + if create: + puppet = cls(twid) + puppet.db_instance.insert() + return puppet + + return None + + @classmethod + def get_by_mxid(cls, mxid: UserID, create: bool = True) -> Optional['Puppet']: + print("GET BY MXID", mxid) + twid = cls.get_twid_from_mxid(mxid) + if twid: + return cls.get_by_twid(twid, create) + + return None + + @classmethod + def get_twid_from_mxid(cls, mxid: UserID) -> Optional[TwilioUserID]: + return cls.mxid_template.parse(mxid) + + @classmethod + def get_mxid_from_twid(cls, twid: TwilioUserID) -> UserID: + return UserID(cls.mxid_template.format_full(str(cls.twid_template.parse(twid)))) + + +def init(context: 'Context') -> None: + global config + Puppet.az, config, Puppet.loop = context.core + Puppet.mx = context.mx + Puppet.hs_domain = config["homeserver"]["domain"] + Puppet.mxid_template = SimpleTemplate(config["bridge.username_template"], "userid", + prefix="@", suffix=f":{Puppet.hs_domain}", type=str) + Puppet.displayname_template = SimpleTemplate(config["bridge.displayname_template"], + "displayname", type=str) diff --git a/mautrix_twilio/sqlstatestore.py b/mautrix_twilio/sqlstatestore.py new file mode 100644 index 0000000..df8f219 --- /dev/null +++ b/mautrix_twilio/sqlstatestore.py @@ -0,0 +1,35 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from mautrix.types import UserID +from mautrix.bridge.db import SQLStateStore as BaseSQLStateStore + +from . import puppet as pu + + +class SQLStateStore(BaseSQLStateStore): + def is_registered(self, user_id: UserID) -> bool: + puppet = pu.Puppet.get_by_mxid(user_id, create=False) + if puppet: + return puppet.is_registered + return super().is_registered(user_id) + + def registered(self, user_id: UserID) -> None: + puppet = pu.Puppet.get_by_mxid(user_id, create=True) + if puppet: + puppet.is_registered = True + puppet.save() + else: + super().registered(user_id) diff --git a/mautrix_twilio/twilio/__init__.py b/mautrix_twilio/twilio/__init__.py new file mode 100644 index 0000000..c5e567a --- /dev/null +++ b/mautrix_twilio/twilio/__init__.py @@ -0,0 +1,4 @@ +from .data import (TwilioUserID, TwilioMessageID, TwilioMessageEvent, TwilioStatusEvent, + TwilioMessageStatus) +from .api import TwilioClient +from .webhook import TwilioHandler diff --git a/mautrix_twilio/twilio/api.py b/mautrix_twilio/twilio/api.py new file mode 100644 index 0000000..a04d55c --- /dev/null +++ b/mautrix_twilio/twilio/api.py @@ -0,0 +1,53 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Dict, Optional +import asyncio +import logging + +from aiohttp import ClientSession, BasicAuth + +from .data import TwilioUserID, TwilioAccountID +from ..config import Config + + +class TwilioClient: + log: logging.Logger = logging.getLogger("mau.twilio.api") + base_url: str = "https://api.twilio.com/2010-04-01" + http: ClientSession + sender_id: TwilioUserID + account_id: TwilioAccountID + + def __init__(self, config: Config, loop: asyncio.AbstractEventLoop) -> None: + self.sender_id = config["twilio.sender_id"] + self.account_id = config["twilio.account_id"] + self.http = ClientSession(loop=loop, auth=BasicAuth(self.account_id, + config["twilio.secret"])) + + async def send_message(self, receiver: TwilioUserID, body: Optional[str] = None, + media: Optional[str] = None) -> Dict[str, str]: + data = { + "From": self.sender_id, + "To": receiver, + "Body": body, + } + if body: + data["Body"] = body + if media: + data["MediaUrl"] = media + self.log.debug(f"Sending message {data}") + resp = await self.http.post(f"{self.base_url}/Accounts/{self.account_id}/Messages.json", + data=data) + return await resp.json() diff --git a/mautrix_twilio/twilio/data.py b/mautrix_twilio/twilio/data.py new file mode 100644 index 0000000..950c8b9 --- /dev/null +++ b/mautrix_twilio/twilio/data.py @@ -0,0 +1,67 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import NewType + +import attr +from attr import dataclass + +from mautrix.types import SerializableAttrs, SerializableEnum + +TwilioMessageID = NewType('TwilioMessageID', str) +TwilioUserID = NewType('TwilioUserID', str) +TwilioAccountID = NewType('TwilioAccountID', str) + + +class TwilioEventType(SerializableEnum): + DELIVERED = "DELIVERED" + READ = "READ" + UNDELIVERED = "UNDELIVERED" + + +class TwilioMessageStatus(SerializableEnum): + SENT = "sent" + DELIVERED = "delivered" + READ = "read" + RECEIVED = "received" + UNDELIVERED = "undelivered" + + +@dataclass +class TwilioMedia(SerializableAttrs['TwilioMedia']): + mime_type: str = attr.ib(default=None, metadata={"json": "MediaContentType0"}) + url: str = attr.ib(default=None, metadata={"json": "MediaUrl0"}) + + +@dataclass +class TwilioMessageEvent(SerializableAttrs['TwilioEvent']): + id: TwilioMessageID = attr.ib(metadata={"json": "MessageSid"}) + receiver: TwilioUserID = attr.ib(metadata={"json": "To"}) + sender: TwilioUserID = attr.ib(metadata={"json": "From"}) + status: TwilioMessageStatus = attr.ib(metadata={"json": "SmsStatus"}) + + body: str = attr.ib(metadata={"json": "Body"}) + segments: str = attr.ib(metadata={"json": "NumSegments"}) + media: TwilioMedia = attr.ib(default=None, metadata={"flatten": True}) + + +@dataclass +class TwilioStatusEvent(SerializableAttrs['TwilioEvent']): + id: TwilioMessageID = attr.ib(metadata={"json": "MessageSid"}) + receiver: TwilioUserID = attr.ib(metadata={"json": "To"}) + sender: TwilioUserID = attr.ib(metadata={"json": "From"}) + status: TwilioMessageStatus = attr.ib(metadata={"json": "SmsStatus"}) + + event_type: TwilioEventType = attr.ib(default=None, metadata={"json": "EventType"}) diff --git a/mautrix_twilio/twilio/request_validator.py b/mautrix_twilio/twilio/request_validator.py new file mode 100644 index 0000000..1d09a8d --- /dev/null +++ b/mautrix_twilio/twilio/request_validator.py @@ -0,0 +1,89 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +# This is based on https://github.com/twilio/twilio-python/blob/master/twilio/request_validator.py +# with changes to remove antiquated python support and use yarl for all URL processing. + +from typing import Dict, Union +from hashlib import sha1, sha256 +import base64 +import hmac + +from yarl import URL + + +class RequestValidator: + def __init__(self, token: str) -> None: + self.token = token.encode("utf-8") + + def _compute_signature(self, url: URL, params: Dict[str, str]) -> bytes: + """ + Compute the signature for a given request. + + Args: + url: Full URI that Twilio requested on your server. + params: Dictionary of POST variables. + + Returns: + The computed signature. + """ + signature_data = str(url) + for key, value in sorted(params.items()): + signature_data += key + value + return hmac.new(self.token, signature_data.encode("utf-8"), sha1).digest() + + @staticmethod + def _compute_hash(body) -> str: + """ + Compute the SHA256 hash for the given data. + + Args: + body: The request body. + + Returns: + The hex-formatted sha256 hash. + """ + return sha256(body.encode("utf-8")).hexdigest().strip() + + def validate(self, url: URL, params: Union[str, bytes, Dict[str, str]], + signature: str) -> bool: + """ + Validate a request from Twilio. + + Args: + url: Full URI that Twilio requested on your server. + params: Dictionary of POST variables or string of POST body for JSON requests. + signature: The signature in the X-Twilio-Signature header. + + Returns: + True if the request passes validation, False if not. + """ + + url = url.with_scheme("https").with_port(None) + try: + decoded_signature = base64.b64decode(signature) + except Exception: + return False + + if "bodySHA256" in url.query and isinstance(params, (str, bytes)): + valid_body_hash = hmac.compare_digest(self._compute_hash(params), + url.query["bodySHA256"]) + valid_signature = hmac.compare_digest(self._compute_signature(url, {}), + decoded_signature) + return valid_body_hash and valid_signature + else: + return hmac.compare_digest(self._compute_signature(url, params or {}), + decoded_signature) diff --git a/mautrix_twilio/twilio/webhook.py b/mautrix_twilio/twilio/webhook.py new file mode 100644 index 0000000..93a83a4 --- /dev/null +++ b/mautrix_twilio/twilio/webhook.py @@ -0,0 +1,70 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Optional, Tuple, Any, TYPE_CHECKING +import logging +import asyncio + +from aiohttp import web + +from .request_validator import RequestValidator +from .data import TwilioMessageEvent, TwilioStatusEvent +from .. import portal as po + +if TYPE_CHECKING: + from ..context import Context + + +class TwilioHandler: + log: logging.Logger = logging.getLogger("mau.twilio") + app: web.Application + validator: RequestValidator + + def __init__(self, context: 'Context') -> None: + self.loop = context.loop or asyncio.get_event_loop() + self.app = web.Application(loop=self.loop) + self.app.router.add_route("POST", "/receive", self.receive) + self.app.router.add_route("POST", "/status", self.status) + self.validator = RequestValidator(token=context.config["twilio.secret"]) + + async def _validate_request(self, request: web.Request, type_class: Any + ) -> Tuple[Any, Optional[web.Response]]: + data = dict(**await request.post()) + try: + signature = request.headers["X-Twilio-Signature"] + except KeyError: + return None, web.Response(status=400, text="Missing signature") + is_valid = self.validator.validate(request.url, data, signature) + if not is_valid: + return None, web.Response(status=401, text="Invalid signature") + return type_class.deserialize(data), None + + async def receive(self, request: web.Request) -> web.Response: + data, err = await self._validate_request(request, TwilioMessageEvent) + if err is not None: + return err + self.log.debug(f"Received Twilio message event: {data}") + portal = po.Portal.get_by_twid(data.sender) + await portal.handle_twilio_message(data) + return web.Response(status=204) + + async def status(self, request: web.Request) -> web.Response: + data, err = await self._validate_request(request, TwilioStatusEvent) + if err is not None: + return err + self.log.debug(f"Received Twilio status event: {data}") + portal = po.Portal.get_by_twid(data.receiver) + await portal.handle_twilio_status(data) + return web.Response(status=204) diff --git a/mautrix_twilio/user.py b/mautrix_twilio/user.py new file mode 100644 index 0000000..9d6f9aa --- /dev/null +++ b/mautrix_twilio/user.py @@ -0,0 +1,56 @@ +# mautrix-twilio - A Matrix-Twilio relaybot bridge. +# Copyright (C) 2019 Tulir Asokan +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +from typing import Dict, Optional, TYPE_CHECKING + +from mautrix.types import UserID +from mautrix.bridge import BaseUser + +from . import puppet as pu +from .config import Config + +if TYPE_CHECKING: + from .context import Context + +config: Config + + +class User(BaseUser): + by_mxid: Dict[UserID, 'User'] = {} + + is_whitelisted: bool + is_admin: bool + + def __init__(self, mxid: UserID) -> None: + super().__init__() + self.mxid = mxid + self.by_mxid[self.mxid] = self + self.command_status = None + self.is_whitelisted, self.is_admin = config.get_permissions(self.mxid) + self.log = self.log.getChild(self.mxid) + + @classmethod + def get(cls, mxid: UserID) -> Optional['User']: + if pu.Puppet.get_twid_from_mxid(mxid) is not None or mxid == cls.az.bot_mxid: + return None + try: + return cls.by_mxid[mxid] + except KeyError: + return cls(mxid) + + +def init(context: 'Context') -> None: + global config + User.az, config, User.loop = context.core diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3cb69c5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +aiohttp +SQLAlchemy +alembic +ruamel.yaml +commonmark +python-magic +mautrix diff --git a/start b/start new file mode 100755 index 0000000..a80825f --- /dev/null +++ b/start @@ -0,0 +1,3 @@ +#!/bin/bash +source .venv/bin/activate +python -m mautrix_twilio