From 6c11f73ef4d486493b301a9a31d1656df1e3ae09 Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Mon, 17 Aug 2020 22:03:10 +0300 Subject: [PATCH] Initial commit The puppeteer script kind of works, but needs an API. The bridge doesn't exist yet. --- .dockerignore | 10 + .editorconfig | 18 + .gitignore | 21 + .gitlab-ci.yml | 41 ++ Dockerfile | 41 ++ LICENSE | 661 ++++++++++++++++++++++++++++++++ MANIFEST.in | 4 + README.md | 10 + ROADMAP.md | 22 ++ docker-run.sh | 33 ++ mautrix_amp/__init__.py | 2 + mautrix_amp/example-config.yaml | 183 +++++++++ mautrix_amp/get_version.py | 41 ++ mautrix_amp/version.py | 1 + optional-requirements.txt | 7 + puppet/.eslintrc.json | 189 +++++++++ puppet/package.json | 17 + puppet/src/api.js | 15 + puppet/src/contentscript.js | 309 +++++++++++++++ puppet/src/main.js | 264 +++++++++++++ puppet/src/taskqueue.js | 90 +++++ puppet/yarn.lock | 385 +++++++++++++++++++ requirements.txt | 8 + setup.py | 70 ++++ 24 files changed, 2442 insertions(+) create mode 100644 .dockerignore create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.md create mode 100644 ROADMAP.md create mode 100755 docker-run.sh create mode 100644 mautrix_amp/__init__.py create mode 100644 mautrix_amp/example-config.yaml create mode 100644 mautrix_amp/get_version.py create mode 100644 mautrix_amp/version.py create mode 100644 optional-requirements.txt create mode 100644 puppet/.eslintrc.json create mode 100644 puppet/package.json create mode 100644 puppet/src/api.js create mode 100644 puppet/src/contentscript.js create mode 100644 puppet/src/main.js create mode 100644 puppet/src/taskqueue.js create mode 100644 puppet/yarn.lock create mode 100644 requirements.txt create mode 100644 setup.py diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..b102ebe --- /dev/null +++ b/.dockerignore @@ -0,0 +1,10 @@ +.editorconfig +logs +.venv +start +config.yaml +registration.yaml +*.db +*.pickle +profiles +node_modules diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..6342bef --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +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 + +[*.{yaml,yml,py}] +indent_style = space + +[.gitlab-ci.yml] +indent_size = 2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4ef041d --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +/.idea/ + +/.venv +/env/ +pip-selfcheck.json +*.pyc +__pycache__ +/build +/dist +/*.egg-info +/.eggs + +node_modules +/profiles + +/config.yaml +/registration.yaml +*.log* +*.db +*.pickle +*.bak diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..6fc003b --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,41 @@ +image: docker:stable + +stages: +- build +- manifest + +default: + before_script: + - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + +build amd64: + stage: build + tags: + - amd64 + script: + - docker pull $CI_REGISTRY_IMAGE:latest || true + - docker build --pull --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 . + - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 + - docker rmi $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 + +build arm64: + stage: build + tags: + - arm64 + script: + - docker pull $CI_REGISTRY_IMAGE:latest || true + - docker build --pull --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 . + - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 + - docker rmi $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 + +manifest: + stage: manifest + before_script: + - "mkdir -p $HOME/.docker && echo '{\"experimental\": \"enabled\"}' > $HOME/.docker/config.json" + - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + script: + - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 + - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 + - if [ "$CI_COMMIT_BRANCH" = "master" ]; then docker manifest create $CI_REGISTRY_IMAGE:latest $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 && docker manifest push $CI_REGISTRY_IMAGE:latest; fi + - if [ "$CI_COMMIT_BRANCH" != "master" ]; then docker manifest create $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 && docker manifest push $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME; fi + - docker rmi $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ddb143c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,41 @@ +FROM alpine:3.12 + +RUN echo $'\ +@edge http://dl-cdn.alpinelinux.org/alpine/edge/main\n\ +@edge http://dl-cdn.alpinelinux.org/alpine/edge/testing\n\ +@edge http://dl-cdn.alpinelinux.org/alpine/edge/community' >> /etc/apk/repositories + +RUN apk add --no-cache \ + python3 py3-pip py3-setuptools py3-wheel \ + py3-virtualenv \ + py3-pillow \ + py3-aiohttp \ + py3-magic \ + py3-ruamel.yaml \ + py3-commonmark@edge \ + # Other dependencies + ca-certificates \ + su-exec \ + # encryption + olm-dev \ + py3-cffi \ + py3-pycryptodome \ + py3-unpaddedbase64 \ + py3-future + +COPY requirements.txt /opt/mautrix-twitter/requirements.txt +COPY optional-requirements.txt /opt/mautrix-twitter/optional-requirements.txt +WORKDIR /opt/mautrix-twitter +RUN apk add --virtual .build-deps python3-dev libffi-dev build-base \ + && pip3 install -r requirements.txt -r optional-requirements.txt \ + && apk del .build-deps + +COPY . /opt/mautrix-twitter +RUN apk add git && pip3 install .[e2be] && apk del git \ + # This doesn't make the image smaller, but it's needed so that the `version` command works properly + && cp mautrix_twitter/example-config.yaml . && rm -rf mautrix_twitter + +VOLUME /data +ENV UID=1337 GID=1337 + +CMD ["/opt/mautrix-twitter/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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..daa36da --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +include README.md +include LICENSE +include requirements.txt +include optional-requirements.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..569bb46 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# mautrix-amp +![Languages](https://img.shields.io/github/languages/top/tulir/mautrix-amp.svg) +[![License](https://img.shields.io/github/license/tulir/mautrix-amp.svg)](LICENSE) +[![Release](https://img.shields.io/github/release/tulir/mautrix-amp/all.svg)](https://github.com/tulir/mautrix-amp/releases) +[![GitLab CI](https://mau.dev/tulir/mautrix-amp/badges/master/pipeline.svg)](https://mau.dev/tulir/mautrix-amp/container_registry) + +A very hacky Matrix-SMS bridge based on running Android Messages for Web in Puppeteer. +This project is temporary and will eventually be replaced by a separate Android app. + +Matrix room: [`#maunium:maunium.net`](https://matrix.to/#/#maunium:maunium.net) diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..78cae6f --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,22 @@ +# Features & roadmap + +* Matrix → Android Messages + * [ ] Message content + * [ ] Text + * [ ] Media +* Android Messages → Matrix + * [ ] Message content + * [ ] Text + * [ ] Media + * [ ] Message history + * [ ] When creating portal + * [ ] Missed messages +* Misc + * [ ] Automatic portal creation + * [ ] At startup + * [ ] When receiving invite or message + * [ ] Provisioning API for logging in + * [ ] Option to use own Matrix account for messages sent from Android Messages app + * [ ] Automatic login with shared secret + * [ ] Manual login with `login-matrix` + * [ ] E2EE in Matrix rooms diff --git a/docker-run.sh b/docker-run.sh new file mode 100755 index 0000000..7ea3cda --- /dev/null +++ b/docker-run.sh @@ -0,0 +1,33 @@ +#!/bin/sh + +# Define functions. +function fixperms { + chown -R $UID:$GID /data /opt/mautrix-twitter +} + +cd /opt/mautrix-twitter + +# Replace database path in config. +sed -i "s#sqlite:///mautrix-twitter.db#sqlite:////data/mautrix-twitter.db#" /data/config.yaml + +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 + +if [ ! -f /data/registration.yaml ]; then + python3 -m mautrix_twitter -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_twitter -c /data/config.yaml diff --git a/mautrix_amp/__init__.py b/mautrix_amp/__init__.py new file mode 100644 index 0000000..c732749 --- /dev/null +++ b/mautrix_amp/__init__.py @@ -0,0 +1,2 @@ +__version__ = "0.1.0" +__author__ = "Tulir Asokan " diff --git a/mautrix_amp/example-config.yaml b/mautrix_amp/example-config.yaml new file mode 100644 index 0000000..7b756e7 --- /dev/null +++ b/mautrix_amp/example-config.yaml @@ -0,0 +1,183 @@ +# Homeserver details +homeserver: + # The address that this appservice can use to connect to the homeserver. + address: https://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:29327 + # When using https:// the TLS certificate and key files for the address. + tls_cert: false + tls_key: false + + # The hostname and port where this appservice should listen. + hostname: 0.0.0.0 + port: 29327 + # 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. Only Postgres is currently supported. + database: postgres://username:password@hostname/db + + # Provisioning API part of the web server for automated portal creation and fetching information. + # Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager). + provisioning: + # Whether or not the provisioning API should be enabled. + enabled: true + # The prefix to use in the provisioning API endpoints. + prefix: /_matrix/provision/v1 + # The shared secret to authorize users of the API. + # Set to "generate" to generate and save a new token. + shared_secret: generate + + # The unique ID of this appservice. + id: amp + # Username of the appservice bot. + bot_username: ampbot + # 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: Android Messages bridge bot + bot_avatar: mxc://maunium.net/VuvevQiMRlOxuBVMBNEZZrxi + + # Community ID for bridged users (changes registration file) and rooms. + # Must be created manually. + # + # Example: "+amp:example.com". Set to false to disable. + community_id: false + + # 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 user ID (phone or name converted into a mxid-friendly format). + username_template: "amp_{userid}" + # Displayname template for remote users. + # {displayname} is replaced with the display name of the user. + # {phone} is replaced with the phone number or name of the user. + displayname_template: "{displayname} (SMS)" + + # Maximum length of displayname + displayname_max_length: 100 + + # Number of conversations to sync (and create portals for) on login. + # Set 0 to disable automatic syncing. + initial_conversation_sync: 10 + # Whether or not to use /sync to get read receipts when using your own Matrix account as the + # Matrix puppet for messages sent from the Messages android app. + sync_with_custom_puppets: true + # Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth + # + # If set, custom puppets will be enabled automatically for local users + # instead of users having to find an access token and run `login-matrix` + # manually. + login_shared_secret: null + # Whether or not created rooms should have federation enabled. + # If false, created portal rooms will never be federated. + federate_rooms: true + # Settings for backfilling messages from the Messages app. + backfill: + # Whether or not the default puppets of logged in Matrix users should be + # invited to private chats when backfilling history from the Messages app. This is + # usually needed to prevent rate limits and to allow timestamp massaging. + invite_own_puppet: true + # Maximum number of messages to backfill initially. + # Set to 0 to disable backfilling when creating portal. + initial_limit: 0 + missed + missed_limit: 0 + # If using double puppeting, should notifications be disabled + # while the initial backfill is in progress? + disable_notifications: false + # End-to-bridge encryption support options. These require matrix-nio to be installed with pip + # and login_shared_secret to be configured in order to get a device for the bridge bot. + # + # Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal + # application service. + encryption: + # Allow encryption, work in group chat rooms with e2ee enabled + allow: false + # Default to encryption, force-enable encryption in all portals the bridge creates + # This will cause the bridge bot to be in private chats for the encryption to work properly. + default: false + # Options for automatic key sharing. + key_sharing: + # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. + # You must use a client that supports requesting keys from other users to use this feature. + allow: false + # Require the requesting device to have a valid cross-signing signature? + # This doesn't require that the bridge has verified the device, only that the user has verified it. + # Not yet implemented. + require_cross_signing: false + # Require devices to be verified by the bridge? + # Verification by the bridge is not yet implemented. + require_verification: true + # Whether or not to explicitly set the avatar and room name for private + # chat portal rooms. This will be implicitly enabled if encryption.default is true. + private_chat_portal_meta: false + # Whether or not the bridge should send a read receipt from the bridge bot when a message has + # been sent. + delivery_receipts: false + # Whether or not delivery errors should be reported as messages in the Matrix room. + delivery_error_reports: false + # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run. + # This field will automatically be changed back to false after it, + # except if the config file is not writable. + resend_bridge_info: false + + # The prefix for commands. Only required in non-management rooms. + command_prefix: "!am" + + # 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" + + +# Python logging configuration. +# +# See section 16.7.2 of the Python documentation for more info: +# https://docs.python.org/3.6/library/logging.config.html#configuration-dictionary-schema +logging: + version: 1 + formatters: + colored: + (): mautrix_amp.util.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-amp.log + maxBytes: 10485760 + backupCount: 10 + console: + class: logging.StreamHandler + formatter: colored + loggers: + mau: + level: DEBUG + aiohttp: + level: INFO + root: + level: DEBUG + handlers: [file, console] diff --git a/mautrix_amp/get_version.py b/mautrix_amp/get_version.py new file mode 100644 index 0000000..1c740d8 --- /dev/null +++ b/mautrix_amp/get_version.py @@ -0,0 +1,41 @@ +import subprocess +import shutil +import os + +from . import __version__ + +cmd_env = { + "PATH": os.environ["PATH"], + "HOME": os.environ["HOME"], + "LANG": "C", + "LC_ALL": "C", +} + + +def run(cmd): + return subprocess.check_output(cmd, stderr=subprocess.DEVNULL, env=cmd_env) + + +if os.path.exists(".git") and shutil.which("git"): + try: + git_revision = run(["git", "rev-parse", "HEAD"]).strip().decode("ascii") + git_revision_url = f"https://github.com/tulir/mautrix-amp/commit/{git_revision}" + git_revision = git_revision[:8] + except (subprocess.SubprocessError, OSError): + git_revision = "unknown" + git_revision_url = None +else: + git_revision = "unknown" + git_revision_url = None + +# This will never have any releases +git_tag_url = None +git_tag = None + +if not __version__.endswith("+dev"): + __version__ += "+dev" +version = f"{__version__}.{git_revision}" +if git_revision_url: + linkified_version = f"{__version__}.[{git_revision}]({git_revision_url})" +else: + linkified_version = version diff --git a/mautrix_amp/version.py b/mautrix_amp/version.py new file mode 100644 index 0000000..47f7fff --- /dev/null +++ b/mautrix_amp/version.py @@ -0,0 +1 @@ +from .get_version import git_tag, git_revision, version, linkified_version diff --git a/optional-requirements.txt b/optional-requirements.txt new file mode 100644 index 0000000..57320ba --- /dev/null +++ b/optional-requirements.txt @@ -0,0 +1,7 @@ +# Format: #/name defines a new extras_require group called name +# Uncommented lines after the group definition insert things into that group. + +#/e2be +python-olm>=3,<4 +pycryptodome>=3,<4 +unpaddedbase64>=1,<2 diff --git a/puppet/.eslintrc.json b/puppet/.eslintrc.json new file mode 100644 index 0000000..147c2b5 --- /dev/null +++ b/puppet/.eslintrc.json @@ -0,0 +1,189 @@ +{ + "env": { + "es6": true, + "browser": true + }, + "extends": [ + "eslint:recommended", + "plugin:import/errors", + "plugin:import/warnings" + ], + "parserOptions": { + "ecmaVersion": 2020, + "sourceType": "module" + }, + "plugins": [ + "import", + "react-hooks" + ], + "rules": { + "indent": [ + "error", + 4 + ], + "linebreak-style": [ + "error", + "unix" + ], + "quotes": [ + "error", + "double", + { + "avoidEscape": true + } + ], + "semi": [ + "error", + "never" + ], + "comma-dangle": [ + "error", + "only-multiline" + ], + "comma-spacing": [ + "error", + { + "after": true + } + ], + "eol-last": [ + "error", + "always" + ], + "no-trailing-spaces": [ + "error" + ], + "camelcase": [ + "error", + { + "properties": "always" + } + ], + "import/no-unresolved": "off", + "import/named": "error", + "import/namespace": "error", + "import/default": "error", + "import/export": "error", + "import/order": [ + "error", + { + "newlines-between": "always", + "groups": [ + "builtin", + "external", + [ + "internal", + "sibling", + "parent" + ], + "index" + ] + } + ], + "max-len": [ + "error", + { + "code": 100 + } + ], + "prefer-const": [ + "error", + { + "destructuring": "all", + "ignoreReadBeforeAssign": false + } + ], + "arrow-spacing": [ + "error", + { + "before": true, + "after": true + } + ], + "space-before-blocks": [ + "error", + "always" + ], + "object-curly-spacing": [ + "error", + "always" + ], + "array-bracket-spacing": [ + "error", + "never" + ], + "space-in-parens": [ + "error", + "never" + ], + "keyword-spacing": [ + "error", + { + "before": true, + "after": true + } + ], + "key-spacing": [ + "error", + { + "afterColon": true + } + ], + "template-curly-spacing": [ + "error", + "never" + ], + "no-empty": [ + "error", + { + "allowEmptyCatch": true + } + ], + "arrow-body-style": [ + "error", + "as-needed" + ], + "no-multiple-empty-lines": [ + "error", + { + "max": 1, + "maxBOF": 0, + "maxEOF": 0 + } + ], + "no-prototype-builtins": "off", + "dot-notation": [ + "error", + { + "allowKeywords": true + } + ], + "quote-props": [ + "error", + "as-needed" + ], + "no-multi-spaces": [ + "error" + ], + "space-infix-ops": [ + "error" + ], + "object-curly-newline": [ + "error", + { + "multiline": true, + "consistent": true + } + ], + "no-mixed-operators": [ + "error" + ], + "no-extra-parens": [ + "error", + "all", + { + "nestedBinaryExpressions": false + } + ] + } +} diff --git a/puppet/package.json b/puppet/package.json new file mode 100644 index 0000000..b41a974 --- /dev/null +++ b/puppet/package.json @@ -0,0 +1,17 @@ +{ + "name": "mautrix-amp-puppeteer", + "version": "0.1.0", + "description": "Puppeteer module for mautrix-amp", + "repository": { + "type": "git", + "url": "git+https://mau.dev/tulir/mautrix-amp.git" + }, + "main": "src/main.js", + "author": "Tulir Asokan ", + "license": "AGPL-3.0-or-later", + "homepage": "https://mau.dev/tulir/mautrix-amp", + "dependencies": { + "chrono-node": "^2.1.7", + "puppeteer": "^5.2.1" + } +} diff --git a/puppet/src/api.js b/puppet/src/api.js new file mode 100644 index 0000000..0ba674d --- /dev/null +++ b/puppet/src/api.js @@ -0,0 +1,15 @@ +// mautrix-amp - A very hacky Matrix-SMS bridge based on using Android Messages for Web in Puppeteer +// Copyright (C) 2020 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 . diff --git a/puppet/src/contentscript.js b/puppet/src/contentscript.js new file mode 100644 index 0000000..7e228c3 --- /dev/null +++ b/puppet/src/contentscript.js @@ -0,0 +1,309 @@ +// mautrix-amp - A very hacky Matrix-SMS bridge based on using Android Messages for Web in Puppeteer +// Copyright (C) 2020 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 . + +// Definitions and docs for methods that the Puppeteer script exposes for the content script +/** + * @param {string} text - The date string to parse + * @param {Date} [ref] - Reference date to parse relative times + * @param {{[forwardDate]: boolean}} [option] - Extra options for parser + * @return {Promise} + */ +window.__chronoParseDate = function (text, ref, option) { +} +/** + * @param {Set} changes - The hrefs of the chats that changed. + */ +window.__mautrixReceiveChanges = function (changes) { +} +/** + * @param {string} url - The URL for the QR code. + */ +window.__mautrixReceiveQR = function (url) { +} + +class MautrixController { + constructor() { + this.chatListObserver = null + this.qrCodeObserver = null + } + + /** + * Parse a date string. + * + * @param {string} text - The string to parse + * @return {Promise} - The date, or null if parsing failed. + * @private + */ + async _tryParseDate(text) { + const parsed = await window.__chronoParseDate(text) + if (parsed) { + return new Date(parsed) + } + return null + } + + /** + * Parse a date separator (mws-relative-timestamp) + * + * @param {string} text - The text in the mws-relative-timestamp element. + * @param {Date} [messageDate] - The previous date separator value. + * @return {?Date} - The value in the date separator. + * @private + */ + async _parseDate(text, messageDate) { + if (!text) { + return null + } + text = text + .replace(/[^\w\d\s,:.-]/g, "") + .replace(/\s{2,}/g, " ") + .trim() + const now = new Date() + let newDate = await this._tryParseDate(text) + if (!newDate || newDate > now) { + const lastWeek = new Date() + lastWeek.setDate(lastWeek.getDate() - 7) + newDate = await this._tryParseDate(text, lastWeek, { forwardDate: true }) + } + return newDate <= now ? newDate : null + } + + /** + * @typedef MessageData + * @type {object} + * @property {number} id - The ID of the message. Seems to be sequential. + * @property {number} timestamp - The unix timestamp of the message. Not very accurate. + * @property {boolean} isOutgoing - Whether or not this user sent the message. + * @property {string} [text] - The text in the message. + * @property {string} [image] - The URL to the image in the message. + */ + + /** + * Parse a message element (mws-message-wrapper) + * + * @param {Date} date - The most recent date indicator. + * @param {Element} element - The message element. + * @return {MessageData} + * @private + */ + _parseMessage(date, element) { + const messageData = { + id: +element.getAttribute("msg-id"), + timestamp: date ? date.getTime() : null, + isOutgoing: element.getAttribute("is-outgoing") === "true", + } + messageData.text = element.querySelector("mws-text-message-part .text-msg")?.innerText + if (element.querySelector("mws-image-message-part .image-msg")) { + messageData.image = true + } + return messageData + } + + /** + * Parse a message list in the given element. The element should probably be the .content div + * inside a mws-message-list element. + * + * @param {Element} element - The message list element. + * @return {[MessageData]} - A list of messages. + */ + async parseMessageList(element) { + const messages = [] + let messageDate = null + for (const child of element.children) { + switch (child.tagName.toLowerCase()) { + case "mws-message-wrapper": + messages.push(this._parseMessage(messageDate, child)) + break + case "mws-tombstone-message-wrapper": + const dateText = child.getElementsByTagName("mws-relative-timestamp")?.[0]?.innerText + messageDate = (await this._parseDate(dateText, messageDate)) || messageDate + break + } + } + return messages + } + + /** + * @typedef Participant + * @type object + * @property {string} id - The unique-ish identifier for the participant + * @property {string} name - The contact list name of the participant + */ + + /** + * Parse a mw-conversation-details .participants list. + * + * @param {Element} element - The participant list element. + * @return {[Participant]} - The list of participants. + */ + parseParticipantList(element) { + const participants = [] + for (const participantElem of element.getElementsByClassName("participant")) { + const nameElem = participantElem.querySelector(".participant-name") + const name = nameElem.innerText.trim() + let id = name + if (nameElem.nextElementSibling && nameElem.nextElementSibling.hasAttribute("data-e2e-details-participant-number")) { + id = nameElem.nextElementSibling.innerText + } + participants.push({ name, id }) + } + return participants + } + + /** + * @typedef ChatListInfo + * @type object + * @property {number} id - The ID of the chat. + * @property {string} name - The name of the chat. + * @property {string} lastMsg - The most recent message in the chat. May be prefixed by sender name. + * @property {string} lastMsgDate - An imprecise date for the most recent message (e.g. "7:16 PM", "Thu" or "Aug 4") + */ + + /** + * Parse a mws-conversation-list-item element. + * + * @param {Element} element - The element to parse. + * @return {ChatListInfo} - The info in the element. + */ + parseChatListItem(element) { + if (element.tagName.toLowerCase() === "mws-conversation-list-item") { + element = element.querySelector("a.list-item") + } + return { + id: +element.getAttribute("href").split("/").pop(), + name: element.querySelector("h3.name").innerText, + lastMsg: element.querySelector("mws-conversation-snippet").innerText, + lastMsgDate: element.querySelector("mws-relative-timestamp").innerText, + } + } + + /** + * Parse a mws-conversations-list .conv-container list. + * @param {Element} element - The chat list element. + * @return {[ChatListInfo]} - The list of chats. + */ + parseChatList(element) { + const chats = [] + for (const child of element.children) { + if (child.tagName.toLowerCase() !== "mws-conversation-list-item") { + continue + } + chats.push(this.parseChatListItem(child)) + } + return chats + } + + /** + * Check if an image has been downloaded. + * + * @param {number} id - The ID of the message whose image to check. + * @return {boolean} - Whether or not the image has been downloaded + */ + imageExists(id) { + const imageElement = document.querySelector(`mws-message-wrapper[msg-id="${id}"] mws-image-message-part .image-msg`) + return !imageElement.classList.contains("not-rendered") && imageElement.getAttribute("src") !== "" + } + + /** + * Download an image and return it as a data URL. + * Used for downloading the blob: URLs in image messages. + * + * @param {number} id - The ID of the message whose image to download. + * @return {Promise} - The data URL (containing the mime type and base64 data) + */ + async readImage(id) { + const resp = await fetch(url) + const reader = new FileReader() + const promise = new Promise((resolve, reject) => { + reader.onload = () => resolve(reader.result) + reader.onerror = reject + }) + reader.readAsDataURL(await resp.blob()) + return promise + } + + /** + * @param {[MutationRecord]} mutations - The mutation records that occurred + * @private + */ + _observeChatListMutations(mutations) { + const changedChatIDs = new Set() + for (const change of mutations) { + console.debug("Chat list mutation:", change) + if (!(change.target instanceof Element) + || change.target.tagName.toLowerCase() === "mws-conversation-list-item-menu") { + continue + } + const chat = this.parseChatListItem(change.target.closest("mws-conversation-list-item")) + changedChatIDs.add(chat.id) + } + if (changedChatIDs.size > 0) { + console.debug("Dispatching chat list mutations:", changedChatIDs) + window.__mautrixReceiveChanges(Array.from(changedChatIDs)) + } + } + + /** + * Add a mutation observer to the given element. + * + * @param {Element} element - The DOM element to add the mutation observer to. + */ + addChatListObserver(element) { + if (this.chatListObserver !== null) { + this.removeChatListObserver() + } + this.chatListObserver = new MutationObserver(this._observeChatListMutations) + this.chatListObserver.observe(element, { childList: true, subtree: true }) + console.debug("Started chat list observer") + } + + /** + * Disconnect the most recently added mutation observer. + */ + removeChatListObserver() { + if (this.chatListObserver !== null) { + this.chatListObserver.disconnect() + this.chatListObserver = null + console.debug("Disconnected chat list observer") + } + } + + addQRObserver(element) { + if (this.qrCodeObserver !== null) { + this.removeQRObserver() + } + this.qrCodeObserver = new MutationObserver(changes => { + for (const change of changes) { + if (change.attributeName === "data-qr-code" && change.target instanceof Element) { + window.__mautrixReceiveQR(change.target.getAttribute("data-qr-code")) + } + } + }) + this.qrCodeObserver.observe(element, { + attributes: true, + attributeFilter: ["data-qr-code"], + }) + } + + removeQRObserver() { + if (this.qrCodeObserver !== null) { + this.qrCodeObserver.disconnect() + this.qrCodeObserver = null + } + } +} + +window.__mautrixController = new MautrixController() diff --git a/puppet/src/main.js b/puppet/src/main.js new file mode 100644 index 0000000..a4f80e2 --- /dev/null +++ b/puppet/src/main.js @@ -0,0 +1,264 @@ +// mautrix-amp - A very hacky Matrix-SMS bridge based on using Android Messages for Web in Puppeteer +// Copyright (C) 2020 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 . +const puppeteer = require("puppeteer") +const chrono = require("chrono-node") +const process = require("process") +const path = require("path") + +const TaskQueue = require("./taskqueue") + +class MessagesPuppeteer { + url = "https://messages.google.com/web/" + + constructor(profilePath) { + if (!profilePath.startsWith("/")) { + profilePath = path.join(process.cwd(), profilePath) + } + this.profilePath = profilePath + this.updatedChats = new Set() + this.mostRecentMessages = new Map() + this.taskQueue = new TaskQueue() + } + + /** + * Start the browser and open the messages for web page. + * This must be called before doing anything else. + */ + async start(debug = false) { + console.log("Launching browser") + this.browser = await puppeteer.launch({ + userDataDir: this.profilePath, + headless: !debug, + defaultViewport: { width: 1920, height: 1080 }, + }) + console.log("Opening new tab") + const pages = await this.browser.pages() + if (pages.length > 0) { + this.page = pages[0] + } else { + this.page = await this.browser.newPage() + } + console.log("Opening", this.url) + await this.page.goto(this.url) + + console.log("Injecting content script") + await this.page.addScriptTag({ path: "./src/contentscript.js", type: "module" }) + console.log("Exposing this._receiveQRChange") + await this.page.exposeFunction("__mautrixReceiveQR", this._receiveQRChange.bind(this)) + console.log("Exposing this._receiveChatListChanges") + await this.page.exposeFunction("__mautrixReceiveChanges", this._receiveChatListChanges.bind(this)) + console.log("Exposing chrono.parseDate") + await this.page.exposeFunction("__chronoParseDate", chrono.parseDate) + + console.log("Waiting for load") + // Wait for the page to load (either QR code for login or chat list when already logged in) + await Promise.race([ + this.page.waitForSelector("mw-main-container mws-conversations-list .conv-container", { visible: true }), + this.page.waitForSelector("mw-authentication-container mw-qr-code", { visible: true }), + ]) + this.taskQueue.start() + if (await this.isLoggedIn()) { + await this.startObserving() + } + console.log("Startup complete") + } + + /** + * Wait for the session to be logged in and monitor QR code changes while it's not. + */ + async waitForLogin() { + if (await this.isLoggedIn()) { + return + } + const qrSelector = "mw-authentication-container mw-qr-code" + console.log("Clicking Remember Me button") + await this.page.click("mat-slide-toggle:not(.mat-checked) > label") + console.log("Fetching current QR code") + const currentQR = await this.page.$eval(qrSelector, element => element.getAttribute("data-qr-code")) + this._receiveQRChange(currentQR) + console.log("Adding QR observer") + await this.page.$eval(qrSelector, element => window.__mautrixController.addQRObserver(element)) + console.log("Waiting for login") + await this.page.waitForSelector("mws-conversations-list .conv-container", { + visible: true, + timeout: 0, + }) + console.log("Removing QR observer") + await this.page.evaluate(() => window.__mautrixController.removeQRObserver()) + await this.startObserving() + console.log("Login complete") + } + + /** + * Close the browser. + */ + async stop() { + this.taskQueue.stop() + await this.page.close() + await this.browser.close() + console.log("Everything stopped") + } + + /** + * Check if the session is currently logged in. + * + * @return {Promise} - Whether or not the session is logged in. + */ + async isLoggedIn() { + return (await this.page.$("mw-main-container mws-conversations-list")) !== null + } + + /** + * Get the IDs of the most recent chats. + * + * @return {Promise<[ChatListInfo]>} - List of chat IDs in order of most recent message. + */ + async getRecentChats() { + return await this.page.$eval("mws-conversations-list .conv-container", + elem => window.__mautrixController.parseChatList(elem)) + } + + /** + * @typedef ChatInfo + * @type object + * @property {[Participant]} participants + */ + + /** + * Get info about a chat. + * + * @param {number} id - The chat ID whose info to get. + * @return {Promise} - Info about the chat. + */ + async getChatInfo(id) { + return await this.taskQueue.push(() => this._getChatInfoUnsafe(id)) + } + + /** + * Send a message to a chat. + * + * @param {number} chatID - The ID of the chat to send a message to. + * @param {string} text - The text to send. + */ + async sendMessage(chatID, text) { + await this.taskQueue.push(() => this._sendMessageUnsafe(chatID, text)) + } + + /** + * Get messages in a chat. + * + * @param {number} id The ID of the chat whose messages to get. + * @return {Promise<[MessageData]>} - The messages visible in the chat. + */ + async getMessages(id) { + return this.taskQueue.push(() => this._getMessagesUnsafe(id)) + } + + async startObserving() { + console.log("Adding chat list observer") + await this.page.$eval("mws-conversations-list .conv-container", + element => window.__mautrixController.addChatListObserver(element)) + } + + async stopObserving() { + console.log("Removing chat list observer") + await this.page.evaluate(() => window.__mautrixController.removeChatListObserver()) + } + + _listItemSelector(id) { + return `mws-conversation-list-item > a.list-item[href="/web/conversations/${id}"]` + } + + async _switchChatUnsafe(id) { + console.log("Switching to chat", id) + await this.page.click(this._listItemSelector(id)) + } + + async _getChatInfoUnsafe(id) { + await this._switchChatUnsafe(id) + await this.page.click("mw-conversation-menu button") + await this.page.waitForSelector(".mat-menu-panel button.mat-menu-item.details", { timeout: 1000 }) + // There's a 250ms animation and I don't know how to wait for it properly + await new Promise(resolve => setTimeout(resolve, 250)) + await this.page.click(".mat-menu-panel button.mat-menu-item.details") + await this.page.waitForSelector("mws-dialog mw-conversation-details .participants", { timeout: 1000 }) + const participants = await this.page.$eval("mws-dialog mw-conversation-details .participants", + elem => window.__mautrixController.parseParticipantList(elem)) + await this.page.click("mws-dialog mat-dialog-actions button.confirm") + return { + participants, + ...await this.page.$eval(this._listItemSelector(id), + elem => window.__mautrixController.parseChatListItem(elem)), + } + } + + async _sendMessageUnsafe(chatID, text) { + await this._switchChatUnsafe(chatID) + await this.page.focus("mws-message-compose .input-box textarea") + await this.page.keyboard.type(text) + await this.page.click(".compose-container > mws-message-send-button > button") + } + + async _getMessagesUnsafe(id, minID = 0) { + await this._switchChatUnsafe(id) + console.log("Waiting for messages to load") + await this.page.waitFor("mws-message-wrapper") + const messages = await this.page.$eval("mws-messages-list .content", + element => window.__mautrixController.parseMessageList(element)) + if (minID) { + return messages.filter(message => message.id > minID) + } + return messages + } + + async _processChatListChangeUnsafe(id) { + this.updatedChats.delete(id) + console.log("Processing change to", id) + const lastMsgID = this.mostRecentMessages.get(id) || 0 + const messages = await this._getMessagesUnsafe(id, lastMsgID) + if (messages.length === 0) { + console.log("No new messages found in", id) + return + } + const newFirstID = messages[0].id + const newLastID = messages[messages.length - 1].id + this.mostRecentMessages.set(id, newLastID) + console.log(`Loaded messages in ${id} after ${lastMsgID}: got ${newFirstID}-${newLastID}`) + + // TODO send messages somewhere + for (const message of messages) { + console.info("New message:", message) + message.chatID = id + } + } + + _receiveChatListChanges(changes) { + console.log("Received chat list changes:", changes) + for (const item of changes) { + if (!this.updatedChats.has(item)) { + this.updatedChats.add(item) + this.taskQueue.push(() => this._processChatListChangeUnsafe(item)) + .catch(err => console.error("Error handling chat list changes")) + } + } + } + + _receiveQRChange(newLink) { + console.info("QR code changed:", newLink) + } +} + +module.exports = MessagesPuppeteer diff --git a/puppet/src/taskqueue.js b/puppet/src/taskqueue.js new file mode 100644 index 0000000..9cfed88 --- /dev/null +++ b/puppet/src/taskqueue.js @@ -0,0 +1,90 @@ +// mautrix-amp - A very hacky Matrix-SMS bridge based on using Android Messages for Web in Puppeteer +// Copyright (C) 2020 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 . + +class TaskQueue { + constructor() { + this._tasks = [] + this.running = false + this._wakeup = null + } + + async _run() { + console.log("Started processing tasks") + while (this.running) { + if (this._tasks.length === 0) { + console.log("Sleeping until a new task is received") + await new Promise(resolve => this._wakeup = () => { + resolve() + this._wakeup = null + }) + if (!this.running) { + break + } + console.log("Continuing processing tasks") + } + const { task, resolve, reject } = this._tasks.shift() + await task().then(resolve, reject) + } + console.log("Stopped processing tasks") + } + + /** + * @callback Task + * @return {Promise} + */ + + /** + * Push a task to the queue. + * + * @param {Task} task - The task to run + * @return {Promise} - A promise that resolves to the return value of the task + */ + push(task) { + if (!this.running) { + throw Error("task queue is not running") + } + if (this._wakeup !== null) { + this._wakeup() + } + return new Promise((resolve, reject) => this._tasks.push({ task, resolve, reject })) + } + + /** + * Start handling tasks + */ + start() { + if (this.running) { + return + } + this.running = true + this._run().catch(err => console.error("Fatal error processing tasks:", err)) + } + + /** + * Stop handling tasks. + */ + stop() { + if (!this.running) { + return + } + this.running = false + if (this._wakeup !== null) { + this._wakeup() + } + } +} + +module.exports = TaskQueue diff --git a/puppet/yarn.lock b/puppet/yarn.lock new file mode 100644 index 0000000..876e9c7 --- /dev/null +++ b/puppet/yarn.lock @@ -0,0 +1,385 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@types/node@*": + version "14.0.27" + resolved "https://registry.yarnpkg.com/@types/node/-/node-14.0.27.tgz#a151873af5a5e851b51b3b065c9e63390a9e0eb1" + integrity sha512-kVrqXhbclHNHGu9ztnAwSncIgJv/FaxmzXJvGXNdcCpV1b8u1/Mi6z6m0vwy0LzKeXFTPLH0NzwmoJ3fNCIq0g== + +"@types/yauzl@^2.9.1": + version "2.9.1" + resolved "https://registry.yarnpkg.com/@types/yauzl/-/yauzl-2.9.1.tgz#d10f69f9f522eef3cf98e30afb684a1e1ec923af" + integrity sha512-A1b8SU4D10uoPjwb0lnHmmu8wZhR9d+9o2PKBQT2jU5YPTKsxac6M2qGAdY7VcL+dHHhARVUDmeg0rOrcd9EjA== + dependencies: + "@types/node" "*" + +agent-base@5: + version "5.1.1" + resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-5.1.1.tgz#e8fb3f242959db44d63be665db7a8e739537a32c" + integrity sha512-TMeqbNl2fMW0nMjTEPOwe3J/PRFP4vqeoNuQMG0HlMrtm5QxKqdvAkZ1pRBQ/ulIyDD5Yq0nJ7YbdD8ey0TO3g== + +balanced-match@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767" + integrity sha1-ibTRmasr7kneFk6gK4nORi1xt2c= + +base64-js@^1.0.2: + version "1.3.1" + resolved "https://registry.yarnpkg.com/base64-js/-/base64-js-1.3.1.tgz#58ece8cb75dd07e71ed08c736abc5fac4dbf8df1" + integrity sha512-mLQ4i2QO1ytvGWFWmcngKO//JXAQueZvwEKtjgQFM4jIK0kU+ytMfplL8j+n5mspOfjHwoAg+9yhb7BwAHm36g== + +bl@^4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/bl/-/bl-4.0.2.tgz#52b71e9088515d0606d9dd9cc7aa48dc1f98e73a" + integrity sha512-j4OH8f6Qg2bGuWfRiltT2HYGx0e1QcBTrK9KAHNMwMZdQnDZFk0ZSYIpADjYCB3U12nicC5tVJwSIhwOWjb4RQ== + dependencies: + buffer "^5.5.0" + inherits "^2.0.4" + readable-stream "^3.4.0" + +brace-expansion@^1.1.7: + version "1.1.11" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" + integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +buffer-crc32@~0.2.3: + version "0.2.13" + resolved "https://registry.yarnpkg.com/buffer-crc32/-/buffer-crc32-0.2.13.tgz#0d333e3f00eac50aa1454abd30ef8c2a5d9a7242" + integrity sha1-DTM+PwDqxQqhRUq9MO+MKl2ackI= + +buffer@^5.2.1, buffer@^5.5.0: + version "5.6.0" + resolved "https://registry.yarnpkg.com/buffer/-/buffer-5.6.0.tgz#a31749dc7d81d84db08abf937b6b8c4033f62786" + integrity sha512-/gDYp/UtU0eA1ys8bOs9J6a+E/KWIY+DZ+Q2WESNUA0jFRsJOc0SNUO6xJ5SGA1xueg3NL65W6s+NY5l9cunuw== + dependencies: + base64-js "^1.0.2" + ieee754 "^1.1.4" + +chownr@^1.1.1: + version "1.1.4" + resolved "https://registry.yarnpkg.com/chownr/-/chownr-1.1.4.tgz#6fc9d7b42d32a583596337666e7d08084da2cc6b" + integrity sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg== + +chrono-node@^2.1.7: + version "2.1.7" + resolved "https://registry.yarnpkg.com/chrono-node/-/chrono-node-2.1.7.tgz#e33b40c3c872708b9ec8612e11bceed4f72d2995" + integrity sha512-6x+15cnjmbaOjdlEziRuT3gc9Qaf5contCe5jxMEKj58D8YYxbWNkrNNhbxAkjXj2VDfyAELk55C6nFPdRZGXQ== + dependencies: + dayjs "^1.8.29" + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s= + +dayjs@^1.8.29: + version "1.8.33" + resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.8.33.tgz#18bc4a2b6c1c6f4d67b4c4f2536c0b97e5b766f7" + integrity sha512-881TDLZCdpJFKbraWRHcUG8zfMLLX400ENf9rFZDuWc5zYMss6xifo2PhlDX0ftOmR2NRmaIY47bAa4gKQfXqw== + +debug@4, debug@^4.1.0, debug@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791" + integrity sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw== + dependencies: + ms "^2.1.1" + +devtools-protocol@0.0.781568: + version "0.0.781568" + resolved "https://registry.yarnpkg.com/devtools-protocol/-/devtools-protocol-0.0.781568.tgz#4cdca90a952d2c77831096ff6cd32695d8715a04" + integrity sha512-9Uqnzy6m6zEStluH9iyJ3iHyaQziFnMnLeC8vK0eN6smiJmIx7+yB64d67C2lH/LZra+5cGscJAJsNXO+MdPMg== + +end-of-stream@^1.1.0, end-of-stream@^1.4.1: + version "1.4.4" + resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.4.tgz#5ae64a5f45057baf3626ec14da0ca5e4b2431eb0" + integrity sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q== + dependencies: + once "^1.4.0" + +extract-zip@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/extract-zip/-/extract-zip-2.0.1.tgz#663dca56fe46df890d5f131ef4a06d22bb8ba13a" + integrity sha512-GDhU9ntwuKyGXdZBUgTIe+vXnWj0fppUEtMDL0+idd5Sta8TGpHssn/eusA9mrPr9qNDym6SxAYZjNvCn/9RBg== + dependencies: + debug "^4.1.1" + get-stream "^5.1.0" + yauzl "^2.10.0" + optionalDependencies: + "@types/yauzl" "^2.9.1" + +fd-slicer@~1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/fd-slicer/-/fd-slicer-1.1.0.tgz#25c7c89cb1f9077f8891bbe61d8f390eae256f1e" + integrity sha1-JcfInLH5B3+IkbvmHY85Dq4lbx4= + dependencies: + pend "~1.2.0" + +find-up@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" + integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== + dependencies: + locate-path "^5.0.0" + path-exists "^4.0.0" + +fs-constants@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs-constants/-/fs-constants-1.0.0.tgz#6be0de9be998ce16af8afc24497b9ee9b7ccd9ad" + integrity sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow== + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8= + +get-stream@^5.1.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-5.2.0.tgz#4966a1795ee5ace65e706c4b7beb71257d6e22d3" + integrity sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA== + dependencies: + pump "^3.0.0" + +glob@^7.1.3: + version "7.1.6" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.6.tgz#141f33b81a7c2492e125594307480c46679278a6" + integrity sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.0.4" + once "^1.3.0" + path-is-absolute "^1.0.0" + +https-proxy-agent@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-4.0.0.tgz#702b71fb5520a132a66de1f67541d9e62154d82b" + integrity sha512-zoDhWrkR3of1l9QAL8/scJZyLu8j/gBkcwcaQOZh7Gyh/+uJQzGVETdgT30akuwkpL8HTRfssqI3BZuV18teDg== + dependencies: + agent-base "5" + debug "4" + +ieee754@^1.1.4: + version "1.1.13" + resolved "https://registry.yarnpkg.com/ieee754/-/ieee754-1.1.13.tgz#ec168558e95aa181fd87d37f55c32bbcb6708b84" + integrity sha512-4vf7I2LYV/HaWerSo3XmlMkp5eZ83i+/CDluXi/IGTs/O1sejBNhTtnxzmRZfvOUqj7lZjqHkeTvpgSFDlWZTg== + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk= + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2, inherits@^2.0.3, inherits@^2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +locate-path@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" + integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== + dependencies: + p-locate "^4.1.0" + +mime@^2.0.3: + version "2.4.6" + resolved "https://registry.yarnpkg.com/mime/-/mime-2.4.6.tgz#e5b407c90db442f2beb5b162373d07b69affa4d1" + integrity sha512-RZKhC3EmpBchfTGBVb8fb+RL2cWyw/32lshnsETttkBAyAUXSGHxbEJWWRXc751DrIxG1q04b8QwMbAwkRPpUA== + +minimatch@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083" + integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA== + dependencies: + brace-expansion "^1.1.7" + +mkdirp-classic@^0.5.2: + version "0.5.3" + resolved "https://registry.yarnpkg.com/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz#fa10c9115cc6d8865be221ba47ee9bed78601113" + integrity sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A== + +moment@^2.27.0: + version "2.27.0" + resolved "https://registry.yarnpkg.com/moment/-/moment-2.27.0.tgz#8bff4e3e26a236220dfe3e36de756b6ebaa0105d" + integrity sha512-al0MUK7cpIcglMv3YF13qSgdAIqxHTO7brRtaz3DlSULbqfazqkc5kEjNrLDOM7fsjshoFIihnU8snrP7zUvhQ== + +ms@^2.1.1: + version "2.1.2" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" + integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== + +once@^1.3.0, once@^1.3.1, once@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E= + dependencies: + wrappy "1" + +p-limit@^2.2.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" + integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== + dependencies: + p-try "^2.0.0" + +p-locate@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" + integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== + dependencies: + p-limit "^2.2.0" + +p-try@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" + integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== + +path-exists@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" + integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + integrity sha1-F0uSaHNVNP+8es5r9TpanhtcX18= + +pend@~1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/pend/-/pend-1.2.0.tgz#7a57eb550a6783f9115331fcf4663d5c8e007a50" + integrity sha1-elfrVQpng/kRUzH89GY9XI4AelA= + +pkg-dir@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-4.2.0.tgz#f099133df7ede422e81d1d8448270eeb3e4261f3" + integrity sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ== + dependencies: + find-up "^4.0.0" + +progress@^2.0.1: + version "2.0.3" + resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8" + integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA== + +proxy-from-env@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/proxy-from-env/-/proxy-from-env-1.1.0.tgz#e102f16ca355424865755d2c9e8ea4f24d58c3e2" + integrity sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg== + +pump@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64" + integrity sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww== + dependencies: + end-of-stream "^1.1.0" + once "^1.3.1" + +puppeteer@^5.2.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/puppeteer/-/puppeteer-5.2.1.tgz#7f0564f0a5384f352a38c8cc42af875cd87f4ea6" + integrity sha512-PZoZG7u+T6N1GFWBQmGVG162Ak5MAy8nYSVpeeQrwJK2oYUlDWpHEJPcd/zopyuEMTv7DiztS1blgny1txR2qw== + dependencies: + debug "^4.1.0" + devtools-protocol "0.0.781568" + extract-zip "^2.0.0" + https-proxy-agent "^4.0.0" + mime "^2.0.3" + pkg-dir "^4.2.0" + progress "^2.0.1" + proxy-from-env "^1.0.0" + rimraf "^3.0.2" + tar-fs "^2.0.0" + unbzip2-stream "^1.3.3" + ws "^7.2.3" + +readable-stream@^3.1.1, readable-stream@^3.4.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.0.tgz#337bbda3adc0706bd3e024426a286d4b4b2c9198" + integrity sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA== + dependencies: + inherits "^2.0.3" + string_decoder "^1.1.1" + util-deprecate "^1.0.1" + +rimraf@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" + integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== + dependencies: + glob "^7.1.3" + +safe-buffer@~5.2.0: + version "5.2.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +string_decoder@^1.1.1: + version "1.3.0" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" + integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== + dependencies: + safe-buffer "~5.2.0" + +tar-fs@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/tar-fs/-/tar-fs-2.1.0.tgz#d1cdd121ab465ee0eb9ccde2d35049d3f3daf0d5" + integrity sha512-9uW5iDvrIMCVpvasdFHW0wJPez0K4JnMZtsuIeDI7HyMGJNxmDZDOCQROr7lXyS+iL/QMpj07qcjGYTSdRFXUg== + dependencies: + chownr "^1.1.1" + mkdirp-classic "^0.5.2" + pump "^3.0.0" + tar-stream "^2.0.0" + +tar-stream@^2.0.0: + version "2.1.3" + resolved "https://registry.yarnpkg.com/tar-stream/-/tar-stream-2.1.3.tgz#1e2022559221b7866161660f118255e20fa79e41" + integrity sha512-Z9yri56Dih8IaK8gncVPx4Wqt86NDmQTSh49XLZgjWpGZL9GK9HKParS2scqHCC4w6X9Gh2jwaU45V47XTKwVA== + dependencies: + bl "^4.0.1" + end-of-stream "^1.4.1" + fs-constants "^1.0.0" + inherits "^2.0.3" + readable-stream "^3.1.1" + +through@^2.3.8: + version "2.3.8" + resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" + integrity sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU= + +unbzip2-stream@^1.3.3: + version "1.4.3" + resolved "https://registry.yarnpkg.com/unbzip2-stream/-/unbzip2-stream-1.4.3.tgz#b0da04c4371311df771cdc215e87f2130991ace7" + integrity sha512-mlExGW4w71ebDJviH16lQLtZS32VKqsSfk80GCfUlwT/4/hNRFsoscrF/c++9xinkMzECL1uL9DDwXqFWkruPg== + dependencies: + buffer "^5.2.1" + through "^2.3.8" + +util-deprecate@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" + integrity sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8= + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= + +ws@^7.2.3: + version "7.3.1" + resolved "https://registry.yarnpkg.com/ws/-/ws-7.3.1.tgz#d0547bf67f7ce4f12a72dfe31262c68d7dc551c8" + integrity sha512-D3RuNkynyHmEJIpD2qrgVkc9DQ23OrN/moAwZX4L8DfvszsJxpjQuUq3LMx6HoYji9fbIOBY18XWBsAux1ZZUA== + +yauzl@^2.10.0: + version "2.10.0" + resolved "https://registry.yarnpkg.com/yauzl/-/yauzl-2.10.0.tgz#c7eb17c93e112cb1086fa6d8e51fb0667b79a5f9" + integrity sha1-x+sXyT4RLLEIb6bY5R+wZnt5pfk= + dependencies: + buffer-crc32 "~0.2.3" + fd-slicer "~1.1.0" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7b77acd --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +ruamel.yaml>=0.15.35,<0.17 +python-magic>=0.4,<0.5 +commonmark>=0.8,<0.10 +aiohttp>=3,<4 +yarl>=1,<2 +attrs>=19.1 +mautrix==0.7.0rc1 +asyncpg>=0.20,<0.21 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..93930ba --- /dev/null +++ b/setup.py @@ -0,0 +1,70 @@ +import setuptools + +from mautrix_amp.get_version import git_tag, git_revision, version, linkified_version + +with open("requirements.txt") as reqs: + install_requires = reqs.read().splitlines() + +with open("optional-requirements.txt") as reqs: + extras_require = {} + current = [] + for line in reqs.read().splitlines(): + if line.startswith("#/"): + extras_require[line[2:]] = current = [] + elif not line or line.startswith("#"): + continue + else: + current.append(line) + +extras_require["all"] = list({dep for deps in extras_require.values() for dep in deps}) + +try: + long_desc = open("README.md").read() +except IOError: + long_desc = "Failed to read README.md" + +with open("mautrix_amp/version.py", "w") as version_file: + version_file.write(f"""# Generated in setup.py + +git_tag = {git_tag!r} +git_revision = {git_revision!r} +version = {version!r} +linkified_version = {linkified_version!r} +""") + +setuptools.setup( + name="mautrix-amp", + version=version, + url="https://github.com/tulir/mautrix-amp", + + author="Tulir Asokan", + author_email="tulir@maunium.net", + + description="A very hacky Matrix-SMS bridge based on using Android Messages for Web in Puppeteer.", + long_description=long_desc, + long_description_content_type="text/markdown", + + packages=setuptools.find_packages(), + + install_requires=install_requires, + extras_require=extras_require, + python_requires="~=3.6", + + classifiers=[ + "Development Status :: 2 - Pre-Alpha", + "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", + "Topic :: Communications :: Chat", + "Framework :: AsyncIO", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + ], + entry_points=""" + [console_scripts] + mautrix-amp=mautrix_amp.__main__:main + """, + package_data={"mautrix_amp": [ + "example-config.yaml", + ]}, +)