small pixel drawing of a pufferfish clist

In the beginning there was darkness
j3s j3s@cyberia.club
Tue, 12 Nov 2019 21:03:48 -0600
commit

a7a868effc1ebbc39e350a3020b88fe930b46f1b

7 files changed, 1876 insertions(+), 0 deletions(-)

jump to
A .gitignore

@@ -0,0 +1,1 @@

+clist
A LICENSE

@@ -0,0 +1,675 @@

+ GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. +
A README.md

@@ -0,0 +1,3 @@

+clist +======== +
A go.mod

@@ -0,0 +1,8 @@

+module git.cyberia.club/cyberia-services/clist + +go 1.12 + +require ( + github.com/mattn/go-sqlite3 v1.10.0 + gopkg.in/ini.v1 v1.42.0 +)
A go.sum

@@ -0,0 +1,4 @@

+github.com/mattn/go-sqlite3 v1.10.0 h1:jbhqpg7tQe4SupckyijYiy0mJJ/pRyHvXf7JdWK860o= +github.com/mattn/go-sqlite3 v1.10.0/go.mod h1:FPy6KqzDD04eiIsT53CuJW3U88zkxoIYsOqkbpncsNc= +gopkg.in/ini.v1 v1.42.0 h1:7N3gPTt50s8GuLortA00n8AqRTk75qOP98+mTPpgzRk= +gopkg.in/ini.v1 v1.42.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
A mail/main.go

@@ -0,0 +1,625 @@

+// Package email is designed to provide an "email interface for humans." +// Designed to be robust and flexible, the email package aims to make sending email easy without getting in the way. +package email + +import ( + "bufio" + "bytes" + "crypto/rand" + "crypto/tls" + "encoding/base64" + "errors" + "fmt" + "io" + "math" + "math/big" + "mime" + "mime/multipart" + "mime/quotedprintable" + "net/mail" + "net/smtp" + "net/textproto" + "os" + "path/filepath" + "strings" + "time" + "unicode" +) + +const ( + MaxLineLength = 76 // MaxLineLength is the maximum line length per RFC 2045 + defaultContentType = "text/plain; charset=us-ascii" // defaultContentType is the default Content-Type according to RFC 2045, section 5.2 +) + +// ErrMissingBoundary is returned when there is no boundary given for a multipart entity +var ErrMissingBoundary = errors.New("No boundary found for multipart entity") + +// ErrMissingContentType is returned when there is no "Content-Type" header for a MIME entity +var ErrMissingContentType = errors.New("No Content-Type found for MIME entity") + +// Email is the type used for email messages +type Email struct { + ReplyTo []string + From string + To []string + Recipients []string + Bcc []string + Cc []string + Subject string + Text []byte // Plaintext message (optional) + HTML []byte // Html message (optional) + Sender string // override From as SMTP envelope sender (optional) + Headers textproto.MIMEHeader + Attachments []*Attachment + ReadReceipt []string +} + +// part is a copyable representation of a multipart.Part +type part struct { + header textproto.MIMEHeader + body []byte +} + +// NewEmail creates an Email, and returns the pointer to it. +func NewEmail() *Email { + return &Email{Headers: textproto.MIMEHeader{}} +} + +// trimReader is a custom io.Reader that will trim any leading +// whitespace, as this can cause email imports to fail. +type trimReader struct { + rd io.Reader +} + +// Read trims off any unicode whitespace from the originating reader +func (tr trimReader) Read(buf []byte) (int, error) { + n, err := tr.rd.Read(buf) + t := bytes.TrimLeftFunc(buf[:n], unicode.IsSpace) + n = copy(buf, t) + return n, err +} + +// NewEmailFromReader reads a stream of bytes from an io.Reader, r, +// and returns an email struct containing the parsed data. +// This function expects the data in RFC 5322 format. +func NewEmailFromReader(r io.Reader) (*Email, error) { + e := NewEmail() + s := trimReader{rd: r} + tp := textproto.NewReader(bufio.NewReader(s)) + // Parse the main headers + hdrs, err := tp.ReadMIMEHeader() + if err != nil { + return e, err + } + // Set the subject, to, cc, bcc, and from + for h, v := range hdrs { + switch { + case h == "Subject": + e.Subject = v[0] + subj, err := (&mime.WordDecoder{}).DecodeHeader(e.Subject) + if err == nil && len(subj) > 0 { + e.Subject = subj + } + delete(hdrs, h) + case h == "To": + for _, to := range v { + tt, err := (&mime.WordDecoder{}).DecodeHeader(to) + if err == nil { + e.To = append(e.To, tt) + } else { + e.To = append(e.To, to) + } + } + delete(hdrs, h) + case h == "Cc": + for _, cc := range v { + tcc, err := (&mime.WordDecoder{}).DecodeHeader(cc) + if err == nil { + e.Cc = append(e.Cc, tcc) + } else { + e.Cc = append(e.Cc, cc) + } + } + delete(hdrs, h) + case h == "Bcc": + for _, bcc := range v { + tbcc, err := (&mime.WordDecoder{}).DecodeHeader(bcc) + if err == nil { + e.Bcc = append(e.Bcc, tbcc) + } else { + e.Bcc = append(e.Bcc, bcc) + } + } + delete(hdrs, h) + case h == "From": + e.From = v[0] + fr, err := (&mime.WordDecoder{}).DecodeHeader(e.From) + if err == nil && len(fr) > 0 { + e.From = fr + } + delete(hdrs, h) + } + } + e.Headers = hdrs + body := tp.R + // Recursively parse the MIME parts + ps, err := parseMIMEParts(e.Headers, body) + if err != nil { + return e, err + } + for _, p := range ps { + if ct := p.header.Get("Content-Type"); ct == "" { + return e, ErrMissingContentType + } + ct, _, err := mime.ParseMediaType(p.header.Get("Content-Type")) + if err != nil { + return e, err + } + switch { + case ct == "text/plain": + e.Text = p.body + case ct == "text/html": + e.HTML = p.body + } + } + return e, nil +} + +// parseMIMEParts will recursively walk a MIME entity and return a []mime.Part containing +// each (flattened) mime.Part found. +// It is important to note that there are no limits to the number of recursions, so be +// careful when parsing unknown MIME structures! +func parseMIMEParts(hs textproto.MIMEHeader, b io.Reader) ([]*part, error) { + var ps []*part + // If no content type is given, set it to the default + if _, ok := hs["Content-Type"]; !ok { + hs.Set("Content-Type", defaultContentType) + } + ct, params, err := mime.ParseMediaType(hs.Get("Content-Type")) + if err != nil { + return ps, err + } + // If it's a multipart email, recursively parse the parts + if strings.HasPrefix(ct, "multipart/") { + if _, ok := params["boundary"]; !ok { + return ps, ErrMissingBoundary + } + mr := multipart.NewReader(b, params["boundary"]) + for { + var buf bytes.Buffer + p, err := mr.NextPart() + if err == io.EOF { + break + } + if err != nil { + return ps, err + } + if _, ok := p.Header["Content-Type"]; !ok { + p.Header.Set("Content-Type", defaultContentType) + } + subct, _, err := mime.ParseMediaType(p.Header.Get("Content-Type")) + if err != nil { + return ps, err + } + if strings.HasPrefix(subct, "multipart/") { + sps, err := parseMIMEParts(p.Header, p) + if err != nil { + return ps, err + } + ps = append(ps, sps...) + } else { + var reader io.Reader + reader = p + const cte = "Content-Transfer-Encoding" + if p.Header.Get(cte) == "base64" { + reader = base64.NewDecoder(base64.StdEncoding, reader) + } + // Otherwise, just append the part to the list + // Copy the part data into the buffer + if _, err := io.Copy(&buf, reader); err != nil { + return ps, err + } + ps = append(ps, &part{body: buf.Bytes(), header: p.Header}) + } + } + } else { + // If it is not a multipart email, parse the body content as a single "part" + var buf bytes.Buffer + if _, err := io.Copy(&buf, b); err != nil { + return ps, err + } + ps = append(ps, &part{body: buf.Bytes(), header: hs}) + } + return ps, nil +} + +// Attach is used to attach content from an io.Reader to the email. +// Required parameters include an io.Reader, the desired filename for the attachment, and the Content-Type +// The function will return the created Attachment for reference, as well as nil for the error, if successful. +func (e *Email) Attach(r io.Reader, filename string, c string) (a *Attachment, err error) { + var buffer bytes.Buffer + if _, err = io.Copy(&buffer, r); err != nil { + return + } + at := &Attachment{ + Filename: filename, + Header: textproto.MIMEHeader{}, + Content: buffer.Bytes(), + } + // Get the Content-Type to be used in the MIMEHeader + if c != "" { + at.Header.Set("Content-Type", c) + } else { + // If the Content-Type is blank, set the Content-Type to "application/octet-stream" + at.Header.Set("Content-Type", "application/octet-stream") + } + at.Header.Set("Content-Disposition", fmt.Sprintf("attachment;\r\n filename=\"%s\"", filename)) + at.Header.Set("Content-ID", fmt.Sprintf("<%s>", filename)) + at.Header.Set("Content-Transfer-Encoding", "base64") + e.Attachments = append(e.Attachments, at) + return at, nil +} + +// AttachFile is used to attach content to the email. +// It attempts to open the file referenced by filename and, if successful, creates an Attachment. +// This Attachment is then appended to the slice of Email.Attachments. +// The function will then return the Attachment for reference, as well as nil for the error, if successful. +func (e *Email) AttachFile(filename string) (a *Attachment, err error) { + f, err := os.Open(filename) + if err != nil { + return + } + defer f.Close() + + ct := mime.TypeByExtension(filepath.Ext(filename)) + basename := filepath.Base(filename) + return e.Attach(f, basename, ct) +} + +// msgHeaders merges the Email's various fields and custom headers together in a +// standards compliant way to create a MIMEHeader to be used in the resulting +// message. It does not alter e.Headers. +// +// "e"'s fields To, Cc, From, Subject will be used unless they are present in +// e.Headers. Unless set in e.Headers, "Date" will filled with the current time. +func (e *Email) msgHeaders() (textproto.MIMEHeader, error) { + res := make(textproto.MIMEHeader, len(e.Headers)+4) + if e.Headers != nil { + for _, h := range []string{"Reply-To", "To", "Cc", "From", "Subject", "Date", "Message-Id", "MIME-Version"} { + if v, ok := e.Headers[h]; ok { + res[h] = v + } + } + } + // Set headers if there are values. + if _, ok := res["Reply-To"]; !ok && len(e.ReplyTo) > 0 { + res.Set("Reply-To", strings.Join(e.ReplyTo, ", ")) + } + if _, ok := res["To"]; !ok && len(e.To) > 0 { + res.Set("To", strings.Join(e.To, ", ")) + } + if _, ok := res["Cc"]; !ok && len(e.Cc) > 0 { + res.Set("Cc", strings.Join(e.Cc, ", ")) + } + if _, ok := res["Subject"]; !ok && e.Subject != "" { + res.Set("Subject", e.Subject) + } + if _, ok := res["Message-Id"]; !ok { + id, err := generateMessageID() + if err != nil { + return nil, err + } + res.Set("Message-Id", id) + } + // Date and From are required headers. + if _, ok := res["From"]; !ok { + res.Set("From", e.From) + } + if _, ok := res["Date"]; !ok { + res.Set("Date", time.Now().Format(time.RFC1123Z)) + } + if _, ok := res["MIME-Version"]; !ok { + res.Set("MIME-Version", "1.0") + } + for field, vals := range e.Headers { + if _, ok := res[field]; !ok { + res[field] = vals + } + } + return res, nil +} + +func writeMessage(buff io.Writer, msg []byte, multipart bool, mediaType string, w *multipart.Writer) error { + if multipart { + header := textproto.MIMEHeader{ + "Content-Type": {mediaType + "; charset=UTF-8"}, + "Content-Transfer-Encoding": {"quoted-printable"}, + } + if _, err := w.CreatePart(header); err != nil { + return err + } + } + + qp := quotedprintable.NewWriter(buff) + // Write the text + if _, err := qp.Write(msg); err != nil { + return err + } + return qp.Close() +} + +// Bytes converts the Email object to a []byte representation, including all needed MIMEHeaders, boundaries, etc. +func (e *Email) Bytes() ([]byte, error) { + // TODO: better guess buffer size + buff := bytes.NewBuffer(make([]byte, 0, 4096)) + + headers, err := e.msgHeaders() + if err != nil { + return nil, err + } + + var ( + isMixed = len(e.Attachments) > 0 + isAlternative = len(e.Text) > 0 && len(e.HTML) > 0 + ) + + var w *multipart.Writer + if isMixed || isAlternative { + w = multipart.NewWriter(buff) + } + switch { + case isMixed: + headers.Set("Content-Type", "multipart/mixed;\r\n boundary="+w.Boundary()) + case isAlternative: + headers.Set("Content-Type", "multipart/alternative;\r\n boundary="+w.Boundary()) + case len(e.HTML) > 0: + headers.Set("Content-Type", "text/html; charset=UTF-8") + headers.Set("Content-Transfer-Encoding", "quoted-printable") + default: + headers.Set("Content-Type", "text/plain; charset=UTF-8") + headers.Set("Content-Transfer-Encoding", "quoted-printable") + } + headerToBytes(buff, headers) + _, err = io.WriteString(buff, "\r\n") + if err != nil { + return nil, err + } + + // Check to see if there is a Text or HTML field + if len(e.Text) > 0 || len(e.HTML) > 0 { + var subWriter *multipart.Writer + + if isMixed && isAlternative { + // Create the multipart alternative part + subWriter = multipart.NewWriter(buff) + header := textproto.MIMEHeader{ + "Content-Type": {"multipart/alternative;\r\n boundary=" + subWriter.Boundary()}, + } + if _, err := w.CreatePart(header); err != nil { + return nil, err + } + } else { + subWriter = w + } + // Create the body sections + if len(e.Text) > 0 { + // Write the text + if err := writeMessage(buff, e.Text, isMixed || isAlternative, "text/plain", subWriter); err != nil { + return nil, err + } + } + if len(e.HTML) > 0 { + // Write the HTML + if err := writeMessage(buff, e.HTML, isMixed || isAlternative, "text/html", subWriter); err != nil { + return nil, err + } + } + if isMixed && isAlternative { + if err := subWriter.Close(); err != nil { + return nil, err + } + } + } + // Create attachment part, if necessary + for _, a := range e.Attachments { + ap, err := w.CreatePart(a.Header) + if err != nil { + return nil, err + } + // Write the base64Wrapped content to the part + base64Wrap(ap, a.Content) + } + if isMixed || isAlternative { + if err := w.Close(); err != nil { + return nil, err + } + } + return buff.Bytes(), nil +} + +// Send an email using the given host and SMTP auth (optional), returns any error thrown by smtp.SendMail +// This function merges the To, Cc, and Bcc fields and calls the smtp.SendMail function using the Email.Bytes() output as the message +func (e *Email) Send(addr string, a smtp.Auth) error { + // Check to make sure there is at least one recipient and one "From" address + sender, err := e.parseSender() + if err != nil { + return err + } + raw, err := e.Bytes() + if err != nil { + return err + } + return smtp.SendMail(addr, a, sender, e.Recipients, raw) +} + +// Select and parse an SMTP envelope sender address. Choose Email.Sender if set, or fallback to Email.From. +func (e *Email) parseSender() (string, error) { + if e.Sender != "" { + sender, err := mail.ParseAddress(e.Sender) + if err != nil { + return "", err + } + return sender.Address, nil + } else { + from, err := mail.ParseAddress(e.From) + if err != nil { + return "", err + } + return from.Address, nil + } +} + +// SendWithTLS sends an email with an optional TLS config. +// This is helpful if you need to connect to a host that is used an untrusted +// certificate. +func (e *Email) SendWithTLS(addr string, a smtp.Auth, t *tls.Config) error { + // Merge the To, Cc, and Bcc fields + to := make([]string, 0, len(e.To)+len(e.Cc)+len(e.Bcc)) + to = append(append(append(to, e.To...), e.Cc...), e.Bcc...) + for i := 0; i < len(to); i++ { + addr, err := mail.ParseAddress(to[i]) + if err != nil { + return err + } + to[i] = addr.Address + } + // Check to make sure there is at least one recipient and one "From" address + if e.From == "" || len(to) == 0 { + return errors.New("Must specify at least one From address and one To address") + } + sender, err := e.parseSender() + if err != nil { + return err + } + raw, err := e.Bytes() + if err != nil { + return err + } + + conn, err := tls.Dial("tcp", addr, t) + if err != nil { + return err + } + + c, err := smtp.NewClient(conn, t.ServerName) + if err != nil { + return err + } + defer c.Close() + if err = c.Hello("localhost"); err != nil { + return err + } + // Use TLS if available + if ok, _ := c.Extension("STARTTLS"); ok { + if err = c.StartTLS(t); err != nil { + return err + } + } + + if a != nil { + if ok, _ := c.Extension("AUTH"); ok { + if err = c.Auth(a); err != nil { + return err + } + } + } + if err = c.Mail(sender); err != nil { + return err + } + for _, addr := range to { + if err = c.Rcpt(addr); err != nil { + return err + } + } + w, err := c.Data() + if err != nil { + return err + } + _, err = w.Write(raw) + if err != nil { + return err + } + err = w.Close() + if err != nil { + return err + } + return c.Quit() +} + +// Attachment is a struct representing an email attachment. +// Based on the mime/multipart.FileHeader struct, Attachment contains the name, MIMEHeader, and content of the attachment in question +type Attachment struct { + Filename string + Header textproto.MIMEHeader + Content []byte +} + +// base64Wrap encodes the attachment content, and wraps it according to RFC 2045 standards (every 76 chars) +// The output is then written to the specified io.Writer +func base64Wrap(w io.Writer, b []byte) { + // 57 raw bytes per 76-byte base64 line. + const maxRaw = 57 + // Buffer for each line, including trailing CRLF. + buffer := make([]byte, MaxLineLength+len("\r\n")) + copy(buffer[MaxLineLength:], "\r\n") + // Process raw chunks until there's no longer enough to fill a line. + for len(b) >= maxRaw { + base64.StdEncoding.Encode(buffer, b[:maxRaw]) + w.Write(buffer) + b = b[maxRaw:] + } + // Handle the last chunk of bytes. + if len(b) > 0 { + out := buffer[:base64.StdEncoding.EncodedLen(len(b))] + base64.StdEncoding.Encode(out, b) + out = append(out, "\r\n"...) + w.Write(out) + } +} + +// headerToBytes renders "header" to "buff". If there are multiple values for a +// field, multiple "Field: value\r\n" lines will be emitted. +func headerToBytes(buff io.Writer, header textproto.MIMEHeader) { + for field, vals := range header { + for _, subval := range vals { + // bytes.Buffer.Write() never returns an error. + io.WriteString(buff, field) + io.WriteString(buff, ": ") + // Write the encoded header if needed + switch { + case field == "Content-Type" || field == "Content-Disposition": + buff.Write([]byte(subval)) + default: + buff.Write([]byte(mime.QEncoding.Encode("UTF-8", subval))) + } + io.WriteString(buff, "\r\n") + } + } +} + +var maxBigInt = big.NewInt(math.MaxInt64) + +// generateMessageID generates and returns a string suitable for an RFC 2822 +// compliant Message-ID, e.g.: +// <1444789264909237300.3464.1819418242800517193@DESKTOP01> +// +// The following parameters are used to generate a Message-ID: +// - The nanoseconds since Epoch +// - The calling PID +// - A cryptographically random int64 +// - The sending hostname +func generateMessageID() (string, error) { + t := time.Now().UnixNano() + pid := os.Getpid() + rint, err := rand.Int(rand.Reader, maxBigInt) + if err != nil { + return "", err + } + h, err := os.Hostname() + // If we can't get the hostname, we'll use localhost + if err != nil { + h = "localhost.localdomain" + } + msgid := fmt.Sprintf("<%d.%d.%d@%s>", t, pid, rint, h) + return msgid, nil +}
A main.go

@@ -0,0 +1,560 @@

+package main + +import ( + "bufio" + "bytes" + "database/sql" + "flag" + "fmt" + "git.cyberia.club/cyberia-services/clist/mail" + _ "github.com/mattn/go-sqlite3" + "gopkg.in/ini.v1" + "io" + "log" + "net/mail" + "net/smtp" + "os" + "strings" + "time" +) + +type Config struct { + CommandAddress string `ini:"command_address"` + Log string `ini:"log"` + Database string `ini:"database"` + SMTPHostname string `ini:"smtp_hostname"` + SMTPPort string `ini:"smtp_port"` + SMTPUsername string `ini:"smtp_username"` + SMTPPassword string `ini:"smtp_password"` + Lists map[string]*List + Debug bool + ConfigFile string +} + +type List struct { + Name string `ini:"name"` + Archive string `ini:"archive"` + Owner string `ini:"owner"` + Description string `ini:"description"` + Id string + Address string `ini:"address"` + Hidden bool `ini:"hidden"` + SubscribersOnly bool `ini:"subscribers_only"` + Posters []string `ini:"posters,omitempty"` + Bcc []string `ini:"bcc,omitempty"` +} + +var gConfig *Config + +// Entry point +func main() { + gConfig = &Config{} + + flag.StringVar(&gConfig.ConfigFile, "config", "", "Load configuration from specified file") + flag.Parse() + + loadConfig() + + if len(flag.Args()) < 1 { + fmt.Printf("Error: Command not specified\n") + os.Exit(1) + } + + requireLog() + + if flag.Arg(0) == "message" { + msg := email.NewEmail() + msg, err := email.NewEmailFromReader(bufio.NewReader(os.Stdin)) + if err != nil { + log.Printf("ERROR_PARSING_MESSAGE Error=%q\n", err.Error()) + os.Exit(0) + } + log.Printf("MESSAGE_RECEIVED From=%q To=%q Cc=%q Bcc=%q Subject=%q\n", + msg.From, msg.To, msg.Cc, msg.Bcc, msg.Subject) + handleMessage(msg) + } else { + fmt.Printf("Unknown command %s\n", flag.Arg(0)) + } +} + +func checkAddress(addrs []string, checkAddr string) bool { + for _, to := range addrs { + t, _ := mail.ParseAddress(to) + if t.Address == checkAddr { + return true + } + } + return false +} + +// Figure out if this is a command, or a mailing list post +func handleMessage(msg *email.Email) { + if checkAddress(msg.To, gConfig.CommandAddress) { + handleCommand(msg) + } else { + matchedLists := []*List{} + for _, l := range gConfig.Lists { + agg := append(msg.To, msg.Cc...) + if checkAddress(agg, l.Address) { + matchedLists = append(matchedLists, l) + } + } + + log.Printf("matchedLists: %q", matchedLists) + if len(matchedLists) == 1 { + list := matchedLists[0] + if list.CanPost(msg.From) { + msg := buildListEmail(msg, list) + send(msg) + log.Printf("MESSAGE_SENT ListId=%q", + list.Id) + } else { + handleNotAuthorisedToPost(msg) + } + } else { + log.Printf("LISTS: %q", msg) + handleNoDestination(msg) + } + } +} + +// Handle the command given by the user +func handleCommand(msg *email.Email) { + if msg.Subject == "lists" { + handleShowLists(msg) + } else if msg.Subject == "help" { + handleHelp(msg) + } else if strings.HasPrefix(msg.Subject, "subscribe") { + handleSubscribe(msg) + } else if strings.HasPrefix(msg.Subject, "unsubscribe") { + handleUnsubscribe(msg) + } else { + handleUnknownCommand(msg) + } +} + +// Reply to a message that has nowhere to go +func handleNoDestination(msg *email.Email) { + reply := reply(msg) + reply.From = gConfig.CommandAddress + reply.Text = []byte("No mailing lists addressed. Your message has not been delivered.\r\n") + send(reply) + log.Printf("UNKNOWN_DESTINATION From=%q To=%q Cc=%q Bcc=%q", msg.From, msg.To, msg.Cc, msg.Bcc) +} + +// Reply that the user isn't authorised to post to the list +func handleNotAuthorisedToPost(msg *email.Email) { + reply := reply(msg) + reply.From = gConfig.CommandAddress + reply.Text = []byte("You are not an approved poster for this mailing list. Your message has not been delivered.\r\n") + send(reply) + log.Printf("UNAUTHORISED_POST From=%q To=%q Cc=%q Bcc=%q", msg.From, msg.To, msg.Cc, msg.Bcc) +} + +// Reply to an unknown command, giving some help +func handleUnknownCommand(msg *email.Email) { + reply := reply(msg) + reply.From = gConfig.CommandAddress + reply.Text = []byte(fmt.Sprintf( + "%s is not a valid command.\r\n\r\n"+ + "Valid commands are:\r\n\r\n"+ + commandInfo(), + msg.Subject)) + send(reply) + log.Printf("UNKNOWN_COMMAND From=%q", msg.From) +} + +// Reply to a help command with help information +func handleHelp(msg *email.Email) { + var body bytes.Buffer + fmt.Fprintf(&body, commandInfo()) + reply := reply(msg) + reply.From = gConfig.CommandAddress + reply.Text = []byte(body.String()) + send(reply) + log.Printf("HELP_SENT To=%q", reply.To) +} + +// Reply to a show mailing lists command with a list of mailing lists +func handleShowLists(msg *email.Email) { + log.Printf("HANDLEHSOWLISTS") + var body bytes.Buffer + fmt.Fprintf(&body, "Available mailing lists\r\n") + fmt.Fprintf(&body, "-----------------------\r\n\r\n") + for _, list := range gConfig.Lists { + if !list.Hidden { + fmt.Fprintf(&body, + "%s\r\n============\r\n"+ + "%s\r\n\r\n", + list.Id, list.Description) + } + } + + log.Printf("SEND") + fmt.Fprintf(&body, + "\r\nTo subscribe to a mailing list, email %s with 'subscribe <list-id>' as the subject.\r\n", + gConfig.CommandAddress) + + log.Printf("SEND") + reply := reply(msg) + log.Printf("SEND") + reply.From = gConfig.CommandAddress + log.Printf("SEND") + reply.Text = []byte(body.String()) + log.Printf("SEND") + send(reply) + log.Printf("LIST_SENT To=%q", reply.To) +} + +// Handle a subscribe command +func handleSubscribe(msg *email.Email) { + listId := strings.TrimPrefix(msg.Subject, "subscribe ") + list := List{} + + // Switch to id - in case we were passed address + listId = list.Id + + if isSubscribed(msg.From, listId) { + reply := reply(msg) + reply.From = gConfig.CommandAddress + reply.Text = []byte(fmt.Sprintf("You are already subscribed to %s\r\n", listId)) + send(reply) + log.Printf("DUPLICATE_SUBSCRIPTION_REQUEST User=%q List=%q\n", msg.From, listId) + os.Exit(0) + } + + addSubscription(msg.From, listId) + reply := reply(msg) + reply.Text = []byte(fmt.Sprintf("You are now subscribed to %s\r\n", listId)) + send(reply) +} + +// Handle an unsubscribe command +func handleUnsubscribe(msg *email.Email) { + listId := strings.TrimPrefix(msg.Subject, "unsubscribe ") + list := List{} //lookupList(listId) + + // Switch to id - in case we were passed address + listId = list.Id + + if !isSubscribed(msg.From, listId) { + reply := reply(msg) + reply.Text = []byte(fmt.Sprintf("You aren't subscribed to %s\r\n", listId)) + send(reply) + log.Printf("DUPLICATE_UNSUBSCRIPTION_REQUEST User=%q List=%q\n", msg.From, listId) + os.Exit(0) + } + + removeSubscription(msg.From, listId) + reply := reply(msg) + reply.Text = []byte(fmt.Sprintf("You are now unsubscribed from %s\r\n", listId)) + send(reply) +} + +// Create a new message that replies to this message +func reply(msg *email.Email) *email.Email { + reply := email.NewEmail() + reply.Subject = "Re: " + msg.Subject + reply.From = msg.To[0] + reply.To = []string{msg.From} + reply.Headers["Date"] = []string{time.Now().Format("Mon, 2 Jan 2006 15:04:05 -0700")} + return reply +} + +func badAddress(a string, list []string) bool { + for _, l := range list { + if l == a { + return true + } + } + return false +} + +func buildListEmail(e *email.Email, l *List) *email.Email { + addresses := []string{} + m, _ := mail.ParseAddress(e.From) + addresses = append(addresses, m.Address) + for _, list := range gConfig.Lists { + addresses = append(addresses, list.Address) + } + + cc := []string{} + recipients := []string{} + + for _, a := range e.Cc { + if !badAddress(a, addresses) { + cc = append(cc, a) + } + } + + for _, a := range fetchSubscribers(l.Id) { + if !badAddress(a, addresses) { + recipients = append(recipients, a) + } + } + + // Copy the message + // Add headers + // Return the new message + newEmail := email.NewEmail() + newEmail.Sender = l.Address + newEmail.From = getNameOrAddress(e.From) + "<" + l.Address + ">" + newEmail.To = []string{l.Name + "<" + l.Address + ">"} + newEmail.Cc = cc + newEmail.Recipients = recipients + newEmail.Subject = e.Subject + newEmail.Text = e.Text + newEmail.Headers["Date"] = e.Headers["Date"] + newEmail.Headers["Reply-To"] = []string{e.From} + newEmail.Headers["Precedence"] = []string{"list"} + newEmail.Headers["List-Id"] = []string{"<" + l.Id + ">"} + newEmail.Headers["List-Post"] = []string{"<mailto:" + l.Address + ">"} + newEmail.Headers["List-Help"] = []string{"<mailto:" + l.Address + "?subject=help>"} + newEmail.Headers["List-Subscribe"] = []string{"<mailto:" + gConfig.CommandAddress + "?subject=subscribe>"} + newEmail.Headers["List-Unsubscribe"] = []string{"<mailto:" + gConfig.CommandAddress + "?subject=unsubscribe>"} + newEmail.Headers["List-Archive"] = []string{"<" + l.Archive + ">"} + newEmail.Headers["List-Owner"] = []string{"<" + l.Owner + ">"} + return newEmail +} + +func getNameOrAddress(a string) string { + r, err := mail.ParseAddress(a) + if err != nil { + log.Printf("couldn't parse from address") + return "" + } + if r.Name != "" { + return r.Name + } + return r.Address +} + +func send(e *email.Email) { + log.Printf("MESSAGE:\n") + log.Printf("%q\n", e) + e.Send("mail.c3f.net:587", smtp.PlainAuth("", gConfig.SMTPUsername, gConfig.SMTPPassword, "mail.c3f.net")) + //for _, r := range recipients { + // sender, _ := mail.ParseAddress(msg.From) + // if sender.Address != r { + // msg.Bcc = append(msg.Bcc, r) + // } + // } +} + +// MAILING LIST LOGIC ///////////////////////////////////////////////////////// + +// Check if the user is authorised to post to this mailing list +func (list *List) CanPost(from string) bool { + + // Is this list restricted to subscribers only? + if list.SubscribersOnly && !isSubscribed(from, list.Id) { + return false + } + + // Is there a whitelist of approved posters? + if len(list.Posters) > 0 { + for _, poster := range list.Posters { + if from == poster { + return true + } + } + return false + } + + return true +} + +// DATABASE LOGIC ///////////////////////////////////////////////////////////// + +// Open the database +func openDB() (*sql.DB, error) { + db, err := sql.Open("sqlite3", gConfig.Database) + + if err != nil { + return nil, err + } + + _, err = db.Exec(` + CREATE TABLE IF NOT EXISTS "subscriptions" ( + "list" TEXT, + "user" TEXT + ); + `) + + return db, err +} + +// Open the database or fail immediately +func requireDB() *sql.DB { + db, err := openDB() + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(1) + } + return db +} + +// Fetch list of subscribers to a mailing list from database +func fetchSubscribers(listId string) []string { + db := requireDB() + rows, err := db.Query("SELECT user FROM subscriptions WHERE list=?", listId) + + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + + listIds := []string{} + defer rows.Close() + for rows.Next() { + var user string + rows.Scan(&user) + listIds = append(listIds, user) + } + + return listIds +} + +// Check if a user is subscribed to a mailing list +func isSubscribed(user string, list string) bool { + addressObj, err := mail.ParseAddress(user) + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + db := requireDB() + + exists := false + err = db.QueryRow("SELECT 1 FROM subscriptions WHERE user=? AND list=?", addressObj.Address, list).Scan(&exists) + + if err == sql.ErrNoRows { + return false + } else if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + + return true +} + +// Add a subscription to the subscription database +func addSubscription(user string, list string) { + addressObj, err := mail.ParseAddress(user) + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + + db := requireDB() + _, err = db.Exec("INSERT INTO subscriptions (user,list) VALUES(?,?)", addressObj.Address, list) + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + log.Printf("SUBSCRIPTION_ADDED User=%q List=%q\n", user, list) +} + +// Remove a subscription from the subscription database +func removeSubscription(user string, list string) { + addressObj, err := mail.ParseAddress(user) + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + + db := requireDB() + _, err = db.Exec("DELETE FROM subscriptions WHERE user=? AND list=?", addressObj.Address, list) + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + log.Printf("SUBSCRIPTION_REMOVED User=%q List=%q\n", user, list) +} + +// Remove all subscriptions from a given mailing list +func clearSubscriptions(list string) { + db := requireDB() + _, err := db.Exec("DELETE FROM subscriptions WHERE AND list=?", list) + if err != nil { + log.Printf("DATABASE_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } +} + +// HELPER FUNCTIONS /////////////////////////////////////////////////////////// + +// Open the log file for logging +func openLog() error { + logFile, err := os.OpenFile(gConfig.Log, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644) + if err != nil { + return err + } + out := io.MultiWriter(logFile, os.Stderr) + log.SetOutput(out) + return nil +} + +// Open the log, or fail immediately +func requireLog() { + err := openLog() + if err != nil { + log.Printf("LOG_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } +} + +// Load gConfig from the on-disk config file +func loadConfig() { + var ( + err error + cfg *ini.File + ) + + if len(gConfig.ConfigFile) > 0 { + cfg, err = ini.Load(gConfig.ConfigFile) + } else { + cfg, err = ini.LooseLoad("nanolist.ini", "/usr/local/etc/nanolist.ini", "/etc/nanolist.ini") + } + + if err != nil { + log.Printf("CONFIG_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + + err = cfg.Section("").MapTo(gConfig) + if err != nil { + log.Printf("CONFIG_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + + gConfig.Lists = make(map[string]*List) + + for _, section := range cfg.ChildSections("list") { + list := &List{} + err = section.MapTo(list) + if err != nil { + log.Printf("CONFIG_ERROR Error=%q\n", err.Error()) + os.Exit(0) + } + list.Id = strings.TrimPrefix(section.Name(), "list.") + gConfig.Lists[list.Address] = list + } +} + +// Generate an email-able list of commands +func commandInfo() string { + return fmt.Sprintf(" help\r\n"+ + " Information about valid commands\r\n"+ + "\r\n"+ + " list\r\n"+ + " Retrieve a list of available mailing lists\r\n"+ + "\r\n"+ + " subscribe <list-id>\r\n"+ + " Subscribe to <list-id>\r\n"+ + "\r\n"+ + " unsubscribe <list-id>\r\n"+ + " Unsubscribe from <list-id>\r\n"+ + "\r\n"+ + "To send a command, email %s with the command as the subject.\r\n", + gConfig.CommandAddress) +}