commit c4b7a16e21de39e2ea210e394988b0621349c099 Author: Aine Date: Sun Aug 21 18:41:35 2022 +0300 wip diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..586695e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/local.db diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..871c6a0 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,30 @@ +stages: + - test + - release + +lint: + stage: test + only: ['main'] + image: registry.gitlab.com/etke.cc/base + script: + - make lint + +unit: + stage: test + only: ['main'] + image: registry.gitlab.com/etke.cc/base + script: + - make test + +docker: + stage: release + only: ['main', 'tags'] + services: + - docker:dind + image: jdrouet/docker-with-buildx:stable + before_script: + - apk --no-cache add make + script: + - make login docker + tags: + - docker diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..b48316f --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,97 @@ +run: + concurrency: 4 + timeout: 5m + issues-exit-code: 1 + tests: true + build-tags: [] + skip-dirs: [] + skip-dirs-use-default: true + skip-files: [] + modules-download-mode: readonly + allow-parallel-runners: false + +output: + format: colored-line-number + print-issued-lines: true + print-linter-name: true + uniq-by-line: true + path-prefix: "" + sort-results: true + +linters-settings: + errcheck: + check-blank: true + gocognit: + min-complexity: 15 + nestif: + min-complexity: 4 + gocritic: + enabled-tags: + - performance + gofumpt: + lang-version: "1.18" + gosimple: + go: "1.18" + checks: [ "all" ] + govet: + check-shadowing: true + enable: + - atomicalign + - shadow + misspell: + locale: US + staticcheck: + go: "1.18" + checks: [ "all" ] + stylecheck: + go: "1.18" + unparam: + check-exported: true + unused: + go: "1.18" + gci: + sections: + - standard + - default + - prefix(gitlab.com/etke.cc/int/scheduler) + section-separators: + - newLine +linters: + disable-all: false + enable: + - megacheck + - govet + - errcheck + - gci + - gocognit + - nestif + # - gocritic # ref: https://github.com/golangci/golangci-lint/issues/2649#issue-1170906525 + - gofumpt + - goimports + - gosimple + - govet + - misspell + - staticcheck + - stylecheck + - unparam + - unused + fast: false + + +issues: + exclude-rules: + - path: _test\.go + linters: + - gocyclo + - errcheck + - dupl + - gosec + - linters: + - staticcheck + text: "SA9003:" + - linters: + - lll + source: "^//go:generate " + max-issues-per-linter: 0 + max-same-issues: 0 + new: false diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..aea5ef1 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,24 @@ +FROM registry.gitlab.com/etke.cc/base AS builder + +WORKDIR /scheduler +COPY . . +RUN make build && \ + git clone https://gitlab.com/etke.cc/int/ansible-injector.git && \ + cd ansible-injector && \ + make build + +FROM alpine:latest + +ENV SCHEDULER_DB_DSN /data/scheduler.db + +RUN apk --no-cache add ca-certificates tzdata olm ansible-core && update-ca-certificates && \ + adduser -D -g '' scheduler && \ + mkdir /data && chown -R scheduler /data + +COPY --from=builder /scheduler/scheduler /bin/scheduler +COPY --from=builder /scheduler/ansible-injector/ansible-injector /bin/ansible-injector + +USER scheduler + +ENTRYPOINT ["/bin/scheduler"] + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3e7a700 --- /dev/null +++ b/Makefile @@ -0,0 +1,53 @@ +### CI vars +CI_LOGIN_COMMAND = @echo "Not a CI, skip login" +CI_REGISTRY_IMAGE ?= registry.gitlab.com/etke.cc/postmoogle +CI_COMMIT_TAG ?= latest +# for main branch it must be set explicitly +ifeq ($(CI_COMMIT_TAG), main) +CI_COMMIT_TAG = latest +endif +# login command +ifdef CI_JOB_TOKEN +CI_LOGIN_COMMAND = @docker login -u gitlab-ci-token -p $(CI_JOB_TOKEN) $(CI_REGISTRY) +endif + +# update go dependencies +update: + go get ./cmd + go mod tidy + go mod verify + +mock: + -@rm -rf mocks + @mockery --all + +# run linter +lint: + golangci-lint run ./... + +# run linter and fix issues if possible +lintfix: + golangci-lint run --fix ./... + +# run unit tests +test: + @go test -coverprofile=cover.out ./... + @go tool cover -func=cover.out + -@rm -f cover.out + +# note: make doesn't understand exit code 130 and sets it == 1 +run: + @go run ./cmd || exit 0 + +build: + go build -v -o postmoogle ./cmd + +# CI: docker login +login: + @echo "trying to login to docker registry..." + $(CI_LOGIN_COMMAND) + +# docker build +docker: + docker build -t ${CI_REGISTRY_IMAGE}:${CI_COMMIT_TAG} . + docker push ${CI_REGISTRY_IMAGE}:${CI_COMMIT_TAG} diff --git a/README.md b/README.md new file mode 100644 index 0000000..c6576d9 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Postmoogle + +An Email to Matrix bridge + +## Features / Roadmap / TODO + +- [ ] SMTP server +- [ ] SMTP client +- [x] Matrix bot +- [x] Configuration in room's account data +- [ ] Receive emails to matrix rooms +- [ ] Map email threads to matrix threads +- [ ] Reply to matrix thread sends reply into email thread +- [ ] Send a message to matrix room with special format to send a new email + +## Configuration + +env vars + +### mandatory + +* **POSTMOOGLE_HOMESERVER** - homeserver url, eg: `https://matrix.example.com` +* **POSTMOOGLE_LOGIN** - user login/localpart, eg: `scheduler` +* **POSTMOOGLE_PASSWORD** - user password +* **POSTMOOGLE_DOMAIN** - SMTP domain to listen for new emails +* **POSTMOOGLE_PORT** - SMTP port to listen for new emails + +### optional + +* **POSTMOOGLE_SENTRY_DSN** - sentry DSN +* **POSTMOOGLE_SENTRY_RATE** - sentry sample rate, from 0 to 100 (default: 20) +* **POSTMOOGLE_LOGLEVEL** - log level +* **POSTMOOGLE_DB_DSN** - database connection string +* **POSTMOOGLE_DB_DIALECT** - database dialect (postgres, sqlite3) + +You can find default values in [config/defaults.go](config/defaults.go) diff --git a/bot/bot.go b/bot/bot.go new file mode 100644 index 0000000..eef9e50 --- /dev/null +++ b/bot/bot.go @@ -0,0 +1,71 @@ +package bot + +import ( + "context" + "fmt" + + "github.com/getsentry/sentry-go" + "gitlab.com/etke.cc/go/logger" + "gitlab.com/etke.cc/linkpearl" + "maunium.net/go/mautrix/event" + "maunium.net/go/mautrix/id" +) + +// Bot represents matrix bot +type Bot struct { + prefix string + domain string + log *logger.Logger + lp *linkpearl.Linkpearl +} + +// New creates a new matrix bot +func New(lp *linkpearl.Linkpearl, log *logger.Logger, prefix, domain string) *Bot { + return &Bot{ + prefix: prefix, + domain: domain, + log: log, + lp: lp, + } +} + +// Error message to the log and matrix room +func (b *Bot) Error(ctx context.Context, roomID id.RoomID, message string, args ...interface{}) { + b.log.Error(message, args...) + + if sentry.HasHubOnContext(ctx) { + sentry.GetHubFromContext(ctx).CaptureException(fmt.Errorf(message, args...)) + } else { + sentry.CaptureException(fmt.Errorf(message, args...)) + } + if roomID != "" { + // nolint // if something goes wrong here nobody can help... + b.lp.Send(roomID, &event.MessageEventContent{ + MsgType: event.MsgNotice, + Body: "ERROR: " + fmt.Sprintf(message, args...), + }) + } +} + +// Start performs matrix /sync +func (b *Bot) Start() error { + if err := b.migrate(); err != nil { + return err + } + if err := b.lp.GetClient().SetPresence(event.PresenceOnline); err != nil { + return err + } + + b.initSync() + b.log.Info("Postmoogle has been started") + return b.lp.GetClient().Sync() +} + +// Stop the bot +func (b *Bot) Stop() { + err := b.lp.GetClient().SetPresence(event.PresenceOffline) + if err != nil { + b.log.Error("cannot set presence = offline: %v", err) + } + b.lp.GetClient().StopSync() +} diff --git a/bot/command.go b/bot/command.go new file mode 100644 index 0000000..a910ce2 --- /dev/null +++ b/bot/command.go @@ -0,0 +1,60 @@ +package bot + +import ( + "context" + "strings" + + "github.com/getsentry/sentry-go" + "maunium.net/go/mautrix/event" + "maunium.net/go/mautrix/format" + "maunium.net/go/mautrix/id" +) + +var commands = map[string]string{ + "mailbox": "Get or set mailbox of that room", + "help": "Get help", +} + +func (b *Bot) handleCommand(ctx context.Context, evt *event.Event, command []string) { + if _, ok := commands[command[0]]; !ok { + return + } + + switch command[0] { + case "help": + b.sendHelp(ctx, evt.RoomID) + case "mailbox": + b.handleMailbox(ctx, evt, command) + } +} + +func (b *Bot) parseCommand(message string) []string { + if message == "" { + return nil + } + + message = strings.Replace(message, b.prefix+" ", "", 1) + return strings.Split(message, " ") +} + +func (b *Bot) sendHelp(ctx context.Context, roomID id.RoomID) { + span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("sendHelp")) + defer span.Finish() + + var msg strings.Builder + msg.WriteString("the following commands are supported:\n\n") + for name, desc := range commands { + msg.WriteString("* **") + msg.WriteString(name) + msg.WriteString("** - ") + msg.WriteString(desc) + msg.WriteString("\n") + } + + content := format.RenderMarkdown(msg.String(), true, true) + content.MsgType = event.MsgNotice + _, err := b.lp.Send(roomID, content) + if err != nil { + b.Error(span.Context(), roomID, "cannot send message: %v", err) + } +} diff --git a/bot/data.go b/bot/data.go new file mode 100644 index 0000000..10a2763 --- /dev/null +++ b/bot/data.go @@ -0,0 +1,125 @@ +package bot + +import ( + "context" + + "github.com/getsentry/sentry-go" + "maunium.net/go/mautrix/id" +) + +const settingskey = "cc.etke.postmoogle.settings" + +var migrations = []string{ + ` + CREATE TABLE IF NOT EXISTS settings ( + room_id VARCHAR(255), + mailbox VARCHAR(255) + ) + `, +} + +// settings of a room +type settings struct { + Mailbox string +} + +func (b *Bot) migrate() error { + b.log.Debug("migrating database...") + tx, beginErr := b.lp.GetDB().Begin() + if beginErr != nil { + b.log.Error("cannot begin transaction: %v", beginErr) + return beginErr + } + + for _, query := range migrations { + _, execErr := tx.Exec(query) + if execErr != nil { + b.log.Error("cannot apply migration: %v", execErr) + // nolint // we already have the execErr to return + tx.Rollback() + return execErr + } + } + + commitErr := tx.Commit() + if commitErr != nil { + b.log.Error("cannot commit transaction: %v", commitErr) + // nolint // we already have the commitErr to return + tx.Rollback() + return commitErr + } + + return nil +} + +func (b *Bot) getSettings(ctx context.Context, roomID id.RoomID) (*settings, error) { + span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("getSettings")) + defer span.Finish() + + var config settings + query := "SELECT * FROM settings WHERE room_id = " + switch b.lp.GetStore().GetDialect() { + case "postgres": + query += "$1" + case "sqlite3": + query += "?" + } + row := b.lp.GetDB().QueryRow(query, roomID) + err := row.Scan(&config.Mailbox) + if err == nil { + return &config, nil + } + b.log.Error("cannot find settings in database: %v", err) + + err = b.lp.GetClient().GetRoomAccountData(roomID, settingskey, &config) + + return &config, err +} + +func (b *Bot) setSettings(ctx context.Context, roomID id.RoomID, cfg *settings) error { + span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("setSettings")) + defer span.Finish() + + tx, err := b.lp.GetDB().Begin() + if err == nil { + var insert string + switch b.lp.GetStore().GetDialect() { + case "postgres": + insert = "INSERT INTO settings VALUES ($1) ON CONFLICT (room_id) DO UPDATE SET mailbox = $1" + case "sqlite3": + insert = "INSERT INTO settings VALUES (?) ON CONFLICT (room_id) DO UPDATE SET mailbox = ?" + } + _, err = tx.Exec(insert, cfg.Mailbox) + if err != nil { + b.log.Error("cannot insert settigs: %v", err) + // nolint // no need to check error here + tx.Rollback() + } + + if err != nil { + err = tx.Commit() + if err != nil { + b.log.Error("cannot commit transaction: %v", err) + } + } + } + + return b.lp.GetClient().SetRoomAccountData(roomID, settingskey, cfg) +} + +// FindRoomID by mailbox +func (b *Bot) FindRoomID(mailbox string) (id.RoomID, error) { + query := "SELECT room_id FROM settings WHERE mailbox = " + switch b.lp.GetStore().GetDialect() { + case "postgres": + query += "$1" + case "sqlite3": + query += "?" + } + + var roomID string + row := b.lp.GetDB().QueryRow(query, mailbox) + err := row.Scan(&roomID) + + return id.RoomID(roomID), err +} diff --git a/bot/mailbox.go b/bot/mailbox.go new file mode 100644 index 0000000..1295139 --- /dev/null +++ b/bot/mailbox.go @@ -0,0 +1,66 @@ +package bot + +import ( + "context" + + "github.com/getsentry/sentry-go" + "maunium.net/go/mautrix/event" + "maunium.net/go/mautrix/format" +) + +func (b *Bot) handleMailbox(ctx context.Context, evt *event.Event, command []string) { + if len(command) == 1 { + b.getMailbox(ctx, evt) + return + } + b.setMailbox(ctx, evt, command[1]) +} + +func (b *Bot) getMailbox(ctx context.Context, evt *event.Event) { + span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("getMailbox")) + defer span.Finish() + + cfg, err := b.getSettings(span.Context(), evt.RoomID) + if err != nil || cfg == nil { + b.Error(span.Context(), evt.RoomID, "cannot get settings: %v", err) + return + } + + if cfg.Mailbox == "" { + b.Error(span.Context(), evt.RoomID, "mailbox name is not set") + return + } + + content := format.RenderMarkdown("Mailbox of this room is **"+cfg.Mailbox+"@"+b.domain+"**", true, true) + content.MsgType = event.MsgNotice + _, err = b.lp.Send(evt.RoomID, content) + if err != nil { + b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err) + } +} + +func (b *Bot) setMailbox(ctx context.Context, evt *event.Event, mailbox string) { + span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("setMailbox")) + defer span.Finish() + + cfg, err := b.getSettings(span.Context(), evt.RoomID) + if err != nil { + b.log.Warn("cannot get settings: %v", err) + } + if cfg == nil { + cfg = &settings{} + } + cfg.Mailbox = mailbox + err = b.setSettings(span.Context(), evt.RoomID, cfg) + if err != nil { + b.Error(span.Context(), evt.RoomID, "cannot update settings: %v", err) + return + } + + content := format.RenderMarkdown("Mailbox of this room set to **"+cfg.Mailbox+"@"+b.domain+"**", true, true) + content.MsgType = event.MsgNotice + _, err = b.lp.Send(evt.RoomID, content) + if err != nil { + b.Error(span.Context(), evt.RoomID, "cannot send message: %v", err) + } +} diff --git a/bot/message.go b/bot/message.go new file mode 100644 index 0000000..b3c13b0 --- /dev/null +++ b/bot/message.go @@ -0,0 +1,23 @@ +package bot + +import ( + "context" + "strings" + + "maunium.net/go/mautrix/event" +) + +func (b *Bot) handle(ctx context.Context, evt *event.Event) { + content := evt.Content.AsMessage() + if content == nil { + b.Error(ctx, evt.RoomID, "cannot read message") + return + } + message := strings.TrimSpace(content.Body) + command := b.parseCommand(message) + if command == nil { + return + } + + b.handleCommand(ctx, evt, command) +} diff --git a/bot/sync.go b/bot/sync.go new file mode 100644 index 0000000..81f6b64 --- /dev/null +++ b/bot/sync.go @@ -0,0 +1,72 @@ +package bot + +import ( + "context" + + "github.com/getsentry/sentry-go" + "maunium.net/go/mautrix" + "maunium.net/go/mautrix/event" +) + +func (b *Bot) initSync() { + b.lp.OnEventType( + event.EventMessage, + func(_ mautrix.EventSource, evt *event.Event) { + go b.onMessage(evt) + }) + b.lp.OnEventType( + event.EventEncrypted, + func(_ mautrix.EventSource, evt *event.Event) { + go b.onEncryptedMessage(evt) + }) +} + +func (b *Bot) onMessage(evt *event.Event) { + // ignore own messages + if evt.Sender == b.lp.GetClient().UserID { + return + } + + hub := sentry.CurrentHub().Clone() + hub.ConfigureScope(func(scope *sentry.Scope) { + scope.SetUser(sentry.User{ID: evt.Sender.String()}) + scope.SetContext("event", map[string]string{ + "id": evt.ID.String(), + "room": evt.RoomID.String(), + "sender": evt.Sender.String(), + }) + }) + ctx := sentry.SetHubOnContext(context.Background(), hub) + span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("onMessage")) + defer span.Finish() + + b.handle(span.Context(), evt) +} + +func (b *Bot) onEncryptedMessage(evt *event.Event) { + // ignore own messages + if evt.Sender == b.lp.GetClient().UserID { + return + } + + hub := sentry.CurrentHub().Clone() + hub.ConfigureScope(func(scope *sentry.Scope) { + scope.SetUser(sentry.User{ID: evt.Sender.String()}) + scope.SetContext("event", map[string]string{ + "id": evt.ID.String(), + "room": evt.RoomID.String(), + "sender": evt.Sender.String(), + }) + }) + ctx := sentry.SetHubOnContext(context.Background(), hub) + span := sentry.StartSpan(ctx, "http.server", sentry.TransactionName("onMessage")) + defer span.Finish() + + decrypted, err := b.lp.GetMachine().DecryptMegolmEvent(evt) + if err != nil { + b.Error(span.Context(), evt.RoomID, "cannot decrypt a message: %v", err) + return + } + + b.handle(span.Context(), decrypted) +} diff --git a/cmd/cmd.go b/cmd/cmd.go new file mode 100644 index 0000000..0890fae --- /dev/null +++ b/cmd/cmd.go @@ -0,0 +1,119 @@ +package main + +import ( + "database/sql" + "os" + "os/signal" + "syscall" + "time" + + "github.com/getsentry/sentry-go" + _ "github.com/lib/pq" + _ "github.com/mattn/go-sqlite3" + "gitlab.com/etke.cc/go/logger" + "gitlab.com/etke.cc/linkpearl" + lpcfg "gitlab.com/etke.cc/linkpearl/config" + "gitlab.com/etke.cc/postmoogle/bot" + "gitlab.com/etke.cc/postmoogle/config" + "gitlab.com/etke.cc/postmoogle/smtp" + "maunium.net/go/mautrix/id" +) + +var ( + mxb *bot.Bot + log *logger.Logger +) + +func main() { + quit := make(chan struct{}) + cfg := config.New() + log = logger.New("postmoogle.", cfg.LogLevel) + + log.Info("#############################") + log.Info("Postmoogle") + log.Info("Matrix: true") + log.Info("#############################") + + log.Debug("starting internal components...") + initSentry(cfg) + initBot(cfg) + initShutdown(quit) + defer recovery() + + smtp.NewServer(cfg.Domain, map[string]id.RoomID{}, cfg.Port) + log.Debug("starting matrix bot...") + err := mxb.Start() + if err != nil { + //nolint:gocritic + log.Fatal("cannot start the bot: %v", err) + } + + <-quit +} + +func initSentry(cfg *config.Config) { + err := sentry.Init(sentry.ClientOptions{ + Dsn: cfg.Sentry.DSN, + AttachStacktrace: true, + TracesSampleRate: float64(cfg.Sentry.SampleRate) / 100, + }) + if err != nil { + log.Fatal("cannot initialize sentry: %v", err) + } +} + +func initBot(cfg *config.Config) { + db, err := sql.Open(cfg.DB.Dialect, cfg.DB.DSN) + if err != nil { + log.Fatal("cannot initialize SQL database: %v", err) + } + mxlog := logger.New("matrix.", cfg.LogLevel) + lp, err := linkpearl.New(&lpcfg.Config{ + Homeserver: cfg.Homeserver, + Login: cfg.Login, + Password: cfg.Password, + DB: db, + Dialect: cfg.DB.Dialect, + NoEncryption: cfg.NoEncryption, + LPLogger: mxlog, + APILogger: logger.New("api.", cfg.LogLevel), + StoreLogger: logger.New("store.", cfg.LogLevel), + CryptoLogger: logger.New("olm.", cfg.LogLevel), + }) + if err != nil { + // nolint // Fatal = panic, not os.Exit() + log.Fatal("cannot initialize matrix bot: %v", err) + } + mxb = bot.New(lp, mxlog, cfg.Prefix, cfg.Domain) + log.Debug("bot has been created") +} + +func initShutdown(quit chan struct{}) { + listener := make(chan os.Signal, 1) + signal.Notify(listener, os.Interrupt, syscall.SIGABRT, syscall.SIGHUP, syscall.SIGINT, syscall.SIGQUIT, syscall.SIGTERM) + + go func() { + <-listener + defer close(quit) + + shutdown() + }() +} + +func shutdown() { + log.Info("Shutting down...") + mxb.Stop() + + sentry.Flush(5 * time.Second) + log.Info("Postmoogle has been stopped") + os.Exit(0) +} + +func recovery() { + defer shutdown() + err := recover() + // no problem just shutdown + if err == nil { + sentry.CurrentHub().Recover(err) + } +} diff --git a/config/config.go b/config/config.go new file mode 100644 index 0000000..9c5c715 --- /dev/null +++ b/config/config.go @@ -0,0 +1,31 @@ +package config + +import ( + "gitlab.com/etke.cc/go/env" +) + +const prefix = "postmoogle" + +// New config +func New() *Config { + env.SetPrefix(prefix) + cfg := &Config{ + Homeserver: env.String("homeserver", defaultConfig.Homeserver), + Login: env.String("login", defaultConfig.Login), + Password: env.String("password", defaultConfig.Password), + Domain: env.String("domain", defaultConfig.Domain), + Port: env.String("port", defaultConfig.Port), + NoEncryption: env.Bool("noencryption"), + Sentry: Sentry{ + DSN: env.String("sentry.dsn", defaultConfig.Sentry.DSN), + SampleRate: env.Int("sentry.rate", defaultConfig.Sentry.SampleRate), + }, + LogLevel: env.String("loglevel", defaultConfig.LogLevel), + DB: DB{ + DSN: env.String("db.dsn", defaultConfig.DB.DSN), + Dialect: env.String("db.dialect", defaultConfig.DB.Dialect), + }, + } + + return cfg +} diff --git a/config/defaults.go b/config/defaults.go new file mode 100644 index 0000000..559d384 --- /dev/null +++ b/config/defaults.go @@ -0,0 +1,15 @@ +package config + +var defaultConfig = &Config{ + LogLevel: "INFO", + Domain: "localhost", + Port: "25", + Prefix: "!pm", + DB: DB{ + DSN: "/tmp/postmoogle.db", + Dialect: "sqlite3", + }, + Sentry: Sentry{ + SampleRate: 20, + }, +} diff --git a/config/types.go b/config/types.go new file mode 100644 index 0000000..29eaef6 --- /dev/null +++ b/config/types.go @@ -0,0 +1,41 @@ +package config + +// Config of Postmoogle +type Config struct { + // Homeserver url + Homeserver string + // Login is a MXID localpart (scheduler - OK, @scheduler:example.com - wrong) + Login string + // Password for login/password auth only + Password string + // Domain for SMTP + Domain string + // Port for SMTP + Port string + // RoomID of the admin room + LogLevel string + // NoEncryption disabled encryption support + NoEncryption bool + // Prefix for commands + Prefix string + + // DB config + DB DB + + // Sentry config + Sentry Sentry +} + +// DB config +type DB struct { + // DSN is a database connection string + DSN string + // Dialect of database, one of sqlite3, postgres + Dialect string +} + +// Sentry config +type Sentry struct { + DSN string + SampleRate int +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..c495fb6 --- /dev/null +++ b/go.mod @@ -0,0 +1,34 @@ +module gitlab.com/etke.cc/postmoogle + +go 1.18 + +require ( + github.com/getsentry/sentry-go v0.13.0 + github.com/lib/pq v1.10.6 + github.com/mattn/go-sqlite3 v1.14.14 + gitlab.com/etke.cc/go/env v1.0.0 + gitlab.com/etke.cc/go/logger v1.0.0 + gitlab.com/etke.cc/linkpearl v0.0.0-20220816155856-8f4cd5cce574 + maunium.net/go/mautrix v0.12.0 +) + +require ( + github.com/emersion/go-sasl v0.0.0-20200509203442-7bfe0ed36a21 // indirect + github.com/emersion/go-smtp v0.15.0 // indirect + github.com/google/go-cmp v0.5.8 // indirect + github.com/gorilla/mux v1.8.0 // indirect + github.com/gorilla/websocket v1.5.0 // indirect + github.com/mattn/go-colorable v0.1.13 // indirect + github.com/mattn/go-isatty v0.0.16 // indirect + github.com/rs/zerolog v1.27.0 // indirect + github.com/tidwall/gjson v1.14.3 // indirect + github.com/tidwall/match v1.1.1 // indirect + github.com/tidwall/pretty v1.2.0 // indirect + github.com/tidwall/sjson v1.2.5 // indirect + github.com/yuin/goldmark v1.4.12 // indirect + golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8 // indirect + golang.org/x/net v0.0.0-20220812174116-3211cb980234 // indirect + golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect + maunium.net/go/maulogger/v2 v2.3.2 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..237c497 --- /dev/null +++ b/go.sum @@ -0,0 +1,69 @@ +github.com/DATA-DOG/go-sqlmock v1.5.0 h1:Shsta01QNfFxHCfpW6YH2STWB0MudeXXEWMr20OEh60= +github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/emersion/go-sasl v0.0.0-20200509203442-7bfe0ed36a21 h1:OJyUGMJTzHTd1XQp98QTaHernxMYzRaOasRir9hUlFQ= +github.com/emersion/go-sasl v0.0.0-20200509203442-7bfe0ed36a21/go.mod h1:iL2twTeMvZnrg54ZoPDNfJaJaqy0xIQFuBdrLsmspwQ= +github.com/emersion/go-smtp v0.15.0 h1:3+hMGMGrqP/lqd7qoxZc1hTU8LY8gHV9RFGWlqSDmP8= +github.com/emersion/go-smtp v0.15.0/go.mod h1:qm27SGYgoIPRot6ubfQ/GpiPy/g3PaZAVRxiO/sDUgQ= +github.com/getsentry/sentry-go v0.13.0 h1:20dgTiUSfxRB/EhMPtxcL9ZEbM1ZdR+W/7f7NWD+xWo= +github.com/getsentry/sentry-go v0.13.0/go.mod h1:EOsfu5ZdvKPfeHYV6pTVQnsjfp30+XA7//UooKNumH0= +github.com/go-errors/errors v1.0.1 h1:LUHzmkK3GUKUrL/1gfBUxAHzcev3apQlezX/+O7ma6w= +github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg= +github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI= +github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= +github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc= +github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/lib/pq v1.10.6 h1:jbk+ZieJ0D7EVGJYpL9QTz7/YW6UHbmdnZWYyK5cdBs= +github.com/lib/pq v1.10.6/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= +github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= +github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= +github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= +github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ= +github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-sqlite3 v1.14.14 h1:qZgc/Rwetq+MtyE18WhzjokPD93dNqLGNT3QJuLvBGw= +github.com/mattn/go-sqlite3 v1.14.14/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= +github.com/pingcap/errors v0.11.4 h1:lFuQV/oaUMGcD2tqt+01ROSmJs75VG1ToEOkZIZ4nE4= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/rs/xid v1.3.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= +github.com/rs/zerolog v1.27.0 h1:1T7qCieN22GVc8S4Q2yuexzBb1EqjbgjSH9RohbMjKs= +github.com/rs/zerolog v1.27.0/go.mod h1:7frBqO0oezxmnO7GF86FY++uy8I0Tk/If5ni1G9Qc0U= +github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk= +github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/gjson v1.14.3 h1:9jvXn7olKEHU1S9vwoMGliaT8jq1vJ7IH/n9zD9Dnlw= +github.com/tidwall/gjson v1.14.3/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs= +github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY= +github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28= +github.com/yuin/goldmark v1.4.12 h1:6hffw6vALvEDqJ19dOJvJKOoAOKe4NDaTqvd2sktGN0= +github.com/yuin/goldmark v1.4.12/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +gitlab.com/etke.cc/go/env v1.0.0 h1:J98BwzOuELnjsVPFvz5wa79L7IoRV9CmrS41xLYXtSw= +gitlab.com/etke.cc/go/env v1.0.0/go.mod h1:e1l4RM5MA1sc0R1w/RBDAESWRwgo5cOG9gx8BKUn2C4= +gitlab.com/etke.cc/go/logger v1.0.0 h1:vp8omRMhYn+/peIlHFf9AK7GlTnQQurDCIall3N88b0= +gitlab.com/etke.cc/go/logger v1.0.0/go.mod h1:8Vw5HFXlZQ5XeqvUs5zan+GnhrQyYtm/xe+yj8H/0zk= +gitlab.com/etke.cc/linkpearl v0.0.0-20220816155856-8f4cd5cce574 h1:9uWcP8vME9gPJpfHaRcnfERws4oBn1DVin2BTXKh5iw= +gitlab.com/etke.cc/linkpearl v0.0.0-20220816155856-8f4cd5cce574/go.mod h1:CqwzwxVogKG6gDWTPTen3NyWbTESg42jxoTfXXwDGKQ= +golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8 h1:GIAS/yBem/gq2MUqgNIzUHW7cJMmx3TGZOrnyYaNQ6c= +golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/net v0.0.0-20220812174116-3211cb980234 h1:RDqmgfe7SvlMWoqC3xwQ2blLO3fcWcxMa3eBLRdRW7E= +golang.org/x/net v0.0.0-20220812174116-3211cb980234/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 h1:Sx/u41w+OwrInGdEckYmEuU5gHoGSL4QbDz3S9s6j4U= +golang.org/x/sys v0.0.0-20220818161305-2296e01440c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +maunium.net/go/maulogger/v2 v2.3.2 h1:1XmIYmMd3PoQfp9J+PaHhpt80zpfmMqaShzUTC7FwY0= +maunium.net/go/maulogger/v2 v2.3.2/go.mod h1:TYWy7wKwz/tIXTpsx8G3mZseIRiC5DoMxSZazOHy68A= +maunium.net/go/mautrix v0.12.0 h1:jyT1TkJBIRJ7+OW7NhmMHmnEEBLsQe9ml+FYwSLhlaU= +maunium.net/go/mautrix v0.12.0/go.mod h1:hHvNi5iKVAiI2MAdAeXHtP4g9BvNEX2rsQpSF/x6Kx4= diff --git a/smtp/server.go b/smtp/server.go new file mode 100644 index 0000000..b954a6b --- /dev/null +++ b/smtp/server.go @@ -0,0 +1,50 @@ +package smtp + +import ( + "log" + "os" + "time" + + "github.com/emersion/go-smtp" + "maunium.net/go/mautrix/id" +) + +type backend struct { + domain string + rooms map[string]id.RoomID +} + +func (b *backend) newSession() *session { + return &session{ + domain: b.domain, + rooms: b.rooms, + } +} + +func (b *backend) Login(state *smtp.ConnectionState, username, password string) (smtp.Session, error) { + return nil, smtp.ErrAuthUnsupported +} + +func (b *backend) AnonymousLogin(state *smtp.ConnectionState) (smtp.Session, error) { + return b.newSession(), nil +} + +func NewServer(domain string, mapping map[string]id.RoomID, port string) *smtp.Server { + be := &backend{ + domain: domain, + rooms: mapping, + } + s := smtp.NewServer(be) + s.Addr = ":" + port + s.Domain = domain + s.AuthDisabled = true + s.ReadTimeout = 360 * time.Second + s.WriteTimeout = 360 * time.Second + s.MaxMessageBytes = 63 * 1024 + s.MaxRecipients = 50 + s.Debug = os.Stdout + + log.Println("Starting SMTP server") + log.Fatal(s.ListenAndServe()) + return s +} diff --git a/smtp/session.go b/smtp/session.go new file mode 100644 index 0000000..fcc10c4 --- /dev/null +++ b/smtp/session.go @@ -0,0 +1,47 @@ +package smtp + +import ( + "io" + "log" + + "github.com/emersion/go-smtp" + "maunium.net/go/mautrix/id" +) + +type session struct { + domain string + rooms map[string]id.RoomID +} + +func (s *session) Mail(from string, opts smtp.MailOptions) error { + log.Println("mail from", from) + return nil +} + +func (s *session) Rcpt(to string) error { + _, ok := s.rooms[to] + if !ok { + return smtp.ErrAuthRequired + } + + if Domain(to) != s.domain { + return smtp.ErrAuthRequired + } + log.Println("rcpt to", to) + return nil +} + +func (s *session) Data(r io.Reader) error { + b, err := io.ReadAll(r) + if err != nil { + return err + } + log.Println("Data", string(b)) + return nil +} + +func (s *session) Reset() {} + +func (s *session) Logout() error { + return nil +} diff --git a/smtp/utils.go b/smtp/utils.go new file mode 100644 index 0000000..010e5b3 --- /dev/null +++ b/smtp/utils.go @@ -0,0 +1,7 @@ +package smtp + +import "strings" + +func Domain(email string) string { + return email[strings.LastIndex(email, "@")+1:] +}