From 3e96cf129ba5fc2834b691314c504aa363fd5cf4 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 9 Jan 2014 23:13:37 +0000 Subject: initial commit --- .gitignore | 6 + COPYING | 661 +++++++++++++++++++++++ Documentation/design_notes.txt | 67 +++ Makefile.PL | 38 ++ README | 145 +++++ lib/PublicInbox/Filter.pm | 216 ++++++++ public-inbox-mda | 51 ++ sa_config/Makefile | 17 + sa_config/README | 19 + sa_config/root/etc/spamassassin/public-inbox.pre | 9 + sa_config/user/.spamassassin/user_prefs | 26 + scripts/dc-dlvr | 64 +++ scripts/import_gmane_spool | 51 ++ scripts/report-spam | 28 + t/filter.t | 262 +++++++++ 15 files changed, 1660 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 Documentation/design_notes.txt create mode 100644 Makefile.PL create mode 100644 README create mode 100644 lib/PublicInbox/Filter.pm create mode 100755 public-inbox-mda create mode 100644 sa_config/Makefile create mode 100644 sa_config/README create mode 100644 sa_config/root/etc/spamassassin/public-inbox.pre create mode 100644 sa_config/user/.spamassassin/user_prefs create mode 100755 scripts/dc-dlvr create mode 100755 scripts/import_gmane_spool create mode 100755 scripts/report-spam create mode 100644 t/filter.t diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..e262bd59 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +/Makefile.old +/pm_to_blib +/MYMETA.yml +/Makefile +/blib +/cover_db diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..dba13ed2 --- /dev/null +++ b/COPYING @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/Documentation/design_notes.txt b/Documentation/design_notes.txt new file mode 100644 index 00000000..8ec1d369 --- /dev/null +++ b/Documentation/design_notes.txt @@ -0,0 +1,67 @@ +Design notes and philosophy +--------------------------- + +Challenges to running normal mailing lists +------------------------------------------ +1) spam +2) bounce processing of invalid/bad email addresses +3) processing subscribe/unsubscribe requests + +Issues 2) and 3) are side-stepped entirely by moving reader +subscriptions to git repository synchronization and Atom feeds. There's +no chance of faked subscription requests and no need to deal with +confused users who cannot unsubscribe. + +Use existing infrastructure +--------------------------- + +* public-inbox can coexist with existing mailing lists, any subscriber + to the existing mailing list can begin delivering messages to + public-inbox-mda(1) + +* public-inbox uses SMTP for posting. Posting a message to a public-inbox + instance is no different than sending a message to any open mailing + list. + +* readers may continue using use their choice of mail clients and + mailbox formats, only learning a few commands of the ssoma(1) tool + is required. + +* Atom is a reasonable feed format for casual readers and is supported + by a variety of feed readers. + +Why email? +---------- + +* Freedom from proprietary services, tools and APIs. Communicating with + developers and users of Free Software should not rely on proprietary + tools or services. + +* Existing infrastrucuture, tools, and user familarity. + There is already a large variety of tools, clients, and email providers + available. There are also many resources for users to run their own + SMTP server on a domain they control. + +* All public discussion mediums are affected by spam and advertising. + There exist several good Free Software anti-spam tools for email. + +* Privacy is not an issue for public discussion. Public mailing list + archives are common and accepted by Free Software communities. + There is no need to ask the NSA for backups of your mail archives :) + +* git, one of the most widely-used version control systems, includes many + tools for for email: git-format-patch(1), git-send-email(1), git-am(1). + Furthermore, the development of git itself is based on the git mailing + list. + +* Email is already the de-facto form of communication in many Free Software + communities. + +* Fallback/transition to private email and other lists, in case the + public-inbox host becomes unavailable, users may still directly email + each other (or Cc: lists for related/dependent projects). + +Copyright +--------- +Copyright 2013, Eric Wong and all contributors. +License: AGPLv3 or later diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 00000000..e7aea949 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,38 @@ +#!/usr/bin/perl -w +# Copyright (C) 2013, Eric Wong and all contributors +# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +use strict; +use ExtUtils::MakeMaker; +WriteMakefile( + NAME => 'public-inbox', + VERSION => '0.0.0', + AUTHOR => 'Eric Wong ', + ABSTRACT => 'public-inbox.org infrastructure', + EXE_FILES => [qw/public-inbox-mda/], + PREREQ_PM => { + # note: we use ssoma(1) and spamc(1), + # NOT the Perl modules + 'Email::MIME' => 0, + 'Email::MIME::ContentType' => 0, + 'Email::Filter' => 0, + }, +); + +sub MY::postamble { + <<'EOF'; +RSYNC_DEST = public-inbox.org:/srv/public-inbox/ +docs = README COPYING $(shell git ls-files Documentation/ '*.txt') +gz_docs = $(addsuffix .gz, $(docs)) +%.gz: % + gzip -9 --rsyncable < $< > $@+ + touch -r $< $@+ + mv $@+ $@ + +gz-docs: $(gz_docs) +rsync-docs: + git set-file-times $(docs) + $(MAKE) gz-docs + rsync --chmod=Fugo=r -av $(gz_docs) $(docs) $(RSYNC_DEST) + +EOF +} diff --git a/README b/README new file mode 100644 index 00000000..71643dcc --- /dev/null +++ b/README @@ -0,0 +1,145 @@ +public-inbox - shared mailboxes via git for public discussion +------------------------------------------------------------- + +public-inbox implements the sharing of an email inbox to complement or +replace traditional mailing lists for public discussion. public-inbox +is primarily intended as a Free, distributed (but not yet decentralized) +public communications tool for users and developers of Free and Open +Source Software. public-inbox should be easy-to-deploy and manage; +encouraging software projects to run their own instances with minimal +overhead. + +Implementation +-------------- +public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements +no policy of its own. By exposing an inbox via git, readers may follow +the mailing list without subscribing and have easy access to historical +messages. + +Traditional mailing lists use the "push" model. List servers deliver +content via SMTP to other mail servers used by readers of the mailing +list. For readers, this requires commitment to subscribe to the list +and extra effort to unsubscribe. Readers may also have difficulty +following discussions which started before they joined if archives do +not expose Message-Id headers for responses. For list server admins, +this also burdens them with bounce/failure messages for bad/invalid +addresses. + +public-inbox uses the "pull" model. Readers import mail into an mbox, +Maildir, or IMAP folder from the git repositories periodically. If a +reader loses interest, they simply stop syncing. Since ssoma uses git, +mirrors are easy-to-setup, and lists are easy-to-relocate to different +mail addresses without losing/splitting archives. Readers only need +to install ssoma, a command-line tool[1] currently implemented in Perl. + +Readers may also follow the list via Atom feed. + +[1] http://ssoma.public-inbox.org/ + +Features +-------- +* stores email in git, so readers have a full history of the mailing list +* Atom feed allows casual readers to follow via feed reader +* Mail user-agent (MUA) users may use Maildir, mbox(5) and/or IMAP locally +* uses only well-documented and easy-to-implement data formats + +Requirements (Atom, read-only client) +------------------------------------- +* any feed reader capable of following Atom feeds + +Requirements (server MDA) +------------------------- +* git +* MTA - postfix is recommended +* Perl and several modules: + - Email::Filter + - XML::Atom::SimpleFeed +* Ssoma - currently a Perl module +* SpamAssassin (optional, recommended) +* any HTTP server (optional, for serving Atom feed) + +Hacking +------- +Source code is available via git: + + git clone git://bogomips.org/public-inbox + +See below for contact info. + +Contact +------- +We are happy to see feedback of all types via plain-text email. +public-inbox discussion is self-hosting on public-inbox.org +Please send comments, user/developer discussion, patches, bug reports, +and pull requests to our public-inbox.org address at: + + public-inbox@public-inbox.org + +Please Cc: all recipients when replying as we do not require +subscription. This also makes it easier to rope in folks of +tangentially related projects we depend on (e.g. git developers on +git@vger.kernel.org). + +You can subscribe via ssoma(1), LISTNAME is a name of your choosing: + + URL=git://git.public-inbox.org/public-inbox + LISTNAME=public-inbox + + # to initialize a maildir (this may be a new or existing maildir, + # ssoma will not touch existing messages) + # If you prefer mbox, use "ssoma add mbox ..." instead + ssoma add $LISTNAME $URL maildir:/path/to/maildir/ + + # read with your favorite MUA (only using mutt as an example) + mutt -f /path/to/maildir # (or /path/to/mbox) + + # to keep your mbox or maildir up-to-date, periodically run the following: + ssoma sync $LISTNAME + + # your MUA may modify and delete messages from the maildir or mbox, + # this does not affect ssoma functionality at all + + # to sync all your ssoma subscriptions + ssoma sync + +Anti-Spam +--------- +The maintainer of public-inbox has found SpamAssassin a good tool for +filtering his personal mail, and it will be the default spam filtering +tool in public-inbox. + +Readers may also use a custom mail-delivery-agent for delivery to enable +spam filtering by having ssoma deliver to a command via pipe. + +There is unlikely to be any tool which is 100% accurate at classifying +spam, so it is possible to remove messages using the ssoma-rm(1) tool +in ssoma. + +Content Filtering +----------------- +To discourage phishing, web bugs (tracking), viruses and other nuisances, +only plain-text content is allowed by default and non-text content is +stripped. This saves I/O bandwidth and storage, which is important as +entire mail archives are shared between clients. + +As of the 2010s, successful online social networks and forums are the +ones which heavily restrict users formatting options; so public-inbox +aims to preserve the focus on content, and not presentation. + +Copyright +--------- +Copyright 2013, Eric Wong and all contributors. +License: AGPLv3 or later + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . diff --git a/lib/PublicInbox/Filter.pm b/lib/PublicInbox/Filter.pm new file mode 100644 index 00000000..6cccd930 --- /dev/null +++ b/lib/PublicInbox/Filter.pm @@ -0,0 +1,216 @@ +# Copyright (C) 2013, Eric Wong and all contributors +# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# +# This only exposes one function: run +# Note: the settings here are highly opinionated. Obviously, this is +# Free Software (AGPLv3), so you may change it if you host yourself. +package PublicInbox::Filter; +use strict; +use warnings; +use Email::MIME; +use Email::MIME::ContentType qw/parse_content_type/; +use Email::Filter; +use IPC::Open2; +our $VERSION = '0.0.1'; + +# start with the same defaults as mailman +our $BAD_EXT = qr/\.(?:exe|bat|cmd|com|pif|scr|vbs|cpl)\z/i; + +# this is highly opinionated delivery +# returns 0 only if there is nothing to deliver +sub run { + my ($class, $simple) = @_; + + my $content_type = $simple->header("Content-Type") || "text/plain"; + + # kill potentially bad/confusing headers + # Note: ssoma already does this, but since we mangle the message, + # we should do this before it gets to ssoma. + foreach my $d (qw(status lines content-length)) { + $simple->header_set($d); + } + + if ($content_type =~ m!\btext/plain\b!i) { + return 1; # yay, nothing to do + } elsif ($content_type =~ m!\btext/html\b!i) { + # HTML-only, non-multipart + my $body = $simple->body; + my $ct_parsed = parse_content_type($content_type); + dump_html($body, $ct_parsed->{attributes}->{charset}); + replace_body($simple, $body); + return 1; + } elsif ($content_type =~ m!\bmultipart/!i) { + return strip_multipart($simple, $content_type); + } else { + replace_body($simple, "$content_type message scrubbed"); + return 0; + } +} + +sub replace_part { + my ($simple, $part, $type) = ($_[0], $_[1], $_[3]); + # don't copy $_[2], that's the body (it may be huge) + + # Email::MIME insists on setting Date:, so just set it consistently + # to avoid conflicts to avoid git merge conflicts in a split brain + # situation. + unless (defined $part->header('Date')) { + my $date = $simple->header('Date') || + 'Thu, 01 Jan 1970 00:00:00 +0000'; + $part->header_set('Date', $date); + } + + $part->charset_set(undef); + $part->name_set(undef); + $part->filename_set(undef); + $part->format_set(undef); + $part->encoding_set('8bit'); + $part->disposition_set(undef); + $part->content_type_set($type); + $part->body_set($_[2]); +} + +# converts one part of a multipart message to text +sub html_part_to_text { + my ($simple, $part) = @_; + my $body = $part->body; + my $ct_parsed = parse_content_type($part->content_type); + dump_html($body, $ct_parsed->{attributes}->{charset}); + replace_part($simple, $part, $body, 'text/plain'); +} + +# modifies $_[0] in place +sub dump_html { + my $charset = $_[1] || 'US-ASCII'; + my $cmd = "lynx -stdin -dump"; + + # be careful about remote command injection! + if ($charset =~ /\A[A-Za-z0-9\-]+\z/) { + $cmd .= " -assume_charset=$charset"; + } + + my $pid = open2(my $out, my $in, $cmd); + print $in $_[0]; + close $in; + { + local $/; + $_[0] = <$out>; + } + waitpid($pid, 0); +} + +# this is to correct user errors and not expected to cover all corner cases +# if users don't want to hit this, they should be sending text/plain messages +# unfortunately, too many people send HTML mail and we'll attempt to convert +# it to something safer, smaller and harder-to-track. +sub strip_multipart { + my ($simple, $content_type) = @_; + my $mime = Email::MIME->new($simple->as_string); + + my (@html, @keep); + my $rejected = 0; + my $ok = 1; + + # scan through all parts once + $mime->walk_parts(sub { + my ($part) = @_; + return if $part->subparts; # walk_parts already recurses + + # some extensions are just bad, reject them outright + my $fn = $part->filename; + if (defined($fn) && $fn =~ $BAD_EXT) { + $rejected++; + return; + } + + my $part_type = $part->content_type; + if ($part_type =~ m!\btext/plain\b!i) { + push @keep, $part; + } elsif ($part_type =~ m!\btext/html\b!i) { + push @html, $part; + } elsif ($part_type =~ m!\btext/[a-z0-9\+\._-]+\b!i) { + # Give other text attachments the benefit of the doubt, + # here? Could be source code or script the user wants + # help with. + + push @keep, $part; + } else { + # reject everything else + # + # Yes, we drop GPG/PGP signatures because: + # * hardly anybody bothers to verify signatures + # * we strip/convert HTML parts, which could invalidate + # the signature + # * they increase the size of messages greatly + # (especially short ones) + # * they do not compress well + # + # Instead, rely on soft verification measures: + # * content of the message is most important + # * we encourage Cc: all replies, so replies go to + # the original sender + # * Received, User-Agent, and similar headers + # (this is also to encourage using self-hosted mail + # servers (using 100% Free Software, of course :) + # + # Furthermore, identity theft is uncommon in Free/Open + # Source, even in communities where signatures are rare. + $rejected++; + } + }); + + if ($content_type =~ m!\bmultipart/alternative\b!i) { + if (scalar @keep == 1) { + return collapse($simple, $keep[0]); + } + } else { # convert HTML parts to plain text + foreach my $part (@html) { + html_part_to_text($simple, $part); + push @keep, $part; + } + } + + if (@keep == 0) { + @keep = (Email::MIME->create( + attributes => { + content_type => 'text/plain', + charset => 'US-ASCII', + encoding => '8bit', + }, + body_str => 'all attachments scrubbed by '. __PACKAGE__ + )); + $ok = 0; + } + if (scalar(@html) || $rejected) { + $mime->parts_set(\@keep); + $simple->body_set($mime->body_raw); + mark_changed($simple); + } # else: no changes + + return $ok; +} + +sub mark_changed { + my ($simple) = @_; + $simple->header_set("X-Content-Filtered-By", __PACKAGE__ ." $VERSION"); +} + +sub collapse { + my ($simple, $part) = @_; + $simple->header_set("Content-Type", $part->content_type); + $simple->body_set($part->body_raw); + mark_changed($simple); + return 1; +} + +sub replace_body { + my $simple = $_[0]; + $simple->body_set($_[1]); + $simple->header_set("Content-Type", "text/plain"); + if ($simple->header("Content-Transfer-Encoding")) { + $simple->header_set("Content-Transfer-Encoding", undef); + } + mark_changed($simple); +} + +1; diff --git a/public-inbox-mda b/public-inbox-mda new file mode 100755 index 00000000..4e971d92 --- /dev/null +++ b/public-inbox-mda @@ -0,0 +1,51 @@ +#!/usr/bin/perl -w +# Copyright (C) 2013, Eric Wong and all contributors +# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +use strict; +use warnings; +use Email::Filter; +use PublicInbox::Filter; +use IPC::Run qw(run); +my $usage = "public-inbox-mda main_repo fail_repo < rfc2822_message"; +my $filter = Email::Filter->new(emergency => "~/emergency.mbox"); +my $main_repo = shift @ARGV or die "Usage: $usage\n"; +my $fail_repo = shift @ARGV or die "Usage: $usage\n"; + +my $filtered; +if (do_spamc($filter->simple, \$filtered)) { + # update our message with SA headers (in case our filter rejects it) + my $simple = Email::Simple->new($filtered); + $filtered = undef; + $filter->simple($simple); + + if (PublicInbox::Filter->run($simple)) { + # run spamc again on the HTML-free message + if (do_spamc($simple, \$filtered)) { + $filter->simple(Email::Simple->new($filtered)); + $filter->pipe("ssoma-mda", $main_repo); + } else { + $filter->pipe("ssoma-mda", $fail_repo); + } + } else { + # PublicInbox::Filter nuked everything, oops :x + $filter->pipe("ssoma-mda", $fail_repo); + } +} else { + # if SA thinks it's spam or there's an error: + # don't bother with our own filtering + $filter->pipe("ssoma-mda", $fail_repo); +} +die "Email::Filter failed to exit\n"; + +# we depend on "report_safe 0" in /etc/spamassassin/*.cf with --headers +# not using Email::Filter->pipe here since we want the stdout of +# the command even on failure (spamc will set $? on error). +sub do_spamc { + my ($simple, $out) = @_; + eval { + my $orig = $simple->as_string; + run([qw/spamc -E --headers/], \$orig, $out); + }; + + return ($@ || $? || !defined($$out) || length($$out) == 0) ? 0 : 1; +} diff --git a/sa_config/Makefile b/sa_config/Makefile new file mode 100644 index 00000000..a90c857f --- /dev/null +++ b/sa_config/Makefile @@ -0,0 +1,17 @@ +INSTALL = install +all:: + @cat README + +ROOT_FILES = etc/spamassassin/public-inbox.pre +install-root: + @mkdir -p /etc/spamassassin + for f in $(ROOT_FILES); do $(INSTALL) -m 0644 root/$$f /$$f; done +diff-root: + for f in $(ROOT_FILES); do diff -u root/$$f /$$f; done + +USER_FILES = .spamassassin/user_prefs +install-user: + @mkdir -p ~/.spamassassin/ + for f in $(USER_FILES); do $(INSTALL) -m 0644 user/$$f ~/$$f; done +diff-user: + for f in $(USER_FILES); do diff -u user/$$f ~/$$f; done diff --git a/sa_config/README b/sa_config/README new file mode 100644 index 00000000..6703c38f --- /dev/null +++ b/sa_config/README @@ -0,0 +1,19 @@ +SpamAssassin configs for public-inbox.org +----------------------------------------- + +root/ - files for system-wide use (plugins, rule definitions, + new rules should have a zero score which should be overridden) +user/ - per-user config (keep as much in here as possible) + These files go into the users home directory + +All files in these example directory are CC0: +To the extent possible under law, Eric Wong has waived all copyright and +related or neighboring rights to these examples. + +Make targets +------------ + + install-root - install system-wide files + (run as root) + install-user - install user-specific files + (run as the user public-inbox runs as) diff --git a/sa_config/root/etc/spamassassin/public-inbox.pre b/sa_config/root/etc/spamassassin/public-inbox.pre new file mode 100644 index 00000000..161e2109 --- /dev/null +++ b/sa_config/root/etc/spamassassin/public-inbox.pre @@ -0,0 +1,9 @@ +# public-inbox.org uses the Debian spamd installation + init and sets +# CRON=1 in /etc/default/spamassassin for automatic rule updates + +# compile rules to C, sa-compile(1) must be run as the appropriate user +# (debian-spamd on Debian). sa-compile(1) will also be run by the cronjob +loadplugin Mail::SpamAssassin::Plugin::Rule2XSBody + +# for ok_languages in user_prefs +loadplugin Mail::SpamAssassin::Plugin::TextCat diff --git a/sa_config/user/.spamassassin/user_prefs b/sa_config/user/.spamassassin/user_prefs new file mode 100644 index 00000000..9919b98e --- /dev/null +++ b/sa_config/user/.spamassassin/user_prefs @@ -0,0 +1,26 @@ +# raise or lower as needed +required_score 5.0 + +# do not mess with the original message body, only notify in headers +clear_report_template +clear_unsafe_report_template +report_safe 0 + +# we do not use nor support this on NFS +lock_method flock + +# do not throw off Bayes +bayes_ignore_header X-Bogosity +bayes_ignore_header X-Spam-Flag +bayes_ignore_header X-Spam-Status +bayes_ignore_header X-Spam-Report + +# English-only for all lists on public-inbox.org +ok_locales en +# we have "loadplugin Mail::SpamAssassin::Plugin::TextCat" in a *.pre file +ok_languages en + +# uncomment the following for importing archives: +# dns_available no +# skip_rbl_checks 1 +# skip_uribl_checks 1 diff --git a/scripts/dc-dlvr b/scripts/dc-dlvr new file mode 100755 index 00000000..96009662 --- /dev/null +++ b/scripts/dc-dlvr @@ -0,0 +1,64 @@ +#!/bin/sh +# Copyright (C) 2008-2013, Eric Wong +# License: GPLv3 or later +# to use with postfix main.cf: mailbox_command = /etc/dc-dlvr "$EXTENSION" +DELIVER=/usr/lib/dovecot/deliver + +# my personal preference is to use a catchall account to avoid generating +# backscatter, as invalid emails are usually spam +case $USER in +catchall) exec $DELIVER ;; +esac + +# change if your spamc/spamd listens elsewhere +spamc='spamc -U /run/spamd.sock' + +# allow plus addressing to train spam filters, $1 is the $EXTENSION +# which may be "trainspam" or "trainham". Only allow spam training +# when $CLIENT_ADDRESS is empty (local client) +case $1,$CLIENT_ADDRESS in +trainspam,) exec $spamc -L spam > /dev/null 2>&1 ;; +trainham,) exec $spamc -L ham > /dev/null 2>&1 ;; +esac + +TMPMSG=$(mktemp -t dc-dlvr.orig.$USER.XXXXXX || exit 1) +rm_list=$TMPMSG + +# pre-filter, for infrequently read lists which do their own spam filtering: +if test -r ~/.dc-dlvr.pre +then + set -e + cat > $TMPMSG + DEFAULT_INBOX=$(. ~/.dc-dlvr.pre) + if test xINBOX != x"$DEFAULT_INBOX" + then + $DELIVER -m $DEFAULT_INBOX < $TMPMSG + exec rm -f $rm_list + fi + PREMSG=$(mktemp -t dc-dlvr.orig.$USER.XXXXXX || exit 1) + rm_list="$rm_list $PREMSG" + set +e + mv -f $TMPMSG $PREMSG + $spamc -E --headers < $PREMSG > $TMPMSG +else + $spamc -E --headers > $TMPMSG +fi +err=$? + +# normal delivery +set -e + +case $err in +1) $DELIVER -m INBOX.spam < $TMPMSG ;; +*) + # users may override normal delivery and have it go elsewhere + if test -r ~/.dc-dlvr.rc + then + . ~/.dc-dlvr.rc + else + $DELIVER -m INBOX < $TMPMSG + fi + ;; +esac + +exec rm -f $rm_list diff --git a/scripts/import_gmane_spool b/scripts/import_gmane_spool new file mode 100755 index 00000000..b5573e15 --- /dev/null +++ b/scripts/import_gmane_spool @@ -0,0 +1,51 @@ +#!/usr/bin/perl -w +# Copyright (C) 2013, Eric Wong and all contributors +# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# +# One-off script to convert an slrnpull news spool from gmane +use strict; +use warnings; +use Parallel::ForkManager; +use Email::Simple; +use PublicInbox::Filter; +use IPC::Run qw(run); +my $usage = "import_nntp_spool SLRNPULL_ROOT/news/foo/bar MAIN_REPO FAIL_REPO"; +my $spool = shift @ARGV or die "Usage: $usage\n"; +my $main_repo = shift @ARGV or die "Usage: $usage\n"; +my $fail_repo = shift @ARGV or die "Usage: $usage\n"; +my $nproc = `nproc 2>/dev/null` || 4; +my $pm = Parallel::ForkManager->new($nproc); +my @args = ('public-inbox-mda', $main_repo, $fail_repo); + +foreach my $n (<$spool/*>) { + $n =~ m{/\d+\z} or next; + $pm->start and next; + if (open my $fh, '<', $n) { + local $/; + my $s = Email::Simple->new(<$fh>); + + # gmane rewrites Received headers, which increases spamminess + my @h = $s->header("Original-Received"); + if (@h) { + $s->header_set("Received", @h); + $s->header_set("Original-Received"); + } + + # triggers for the SA HEADER_SPAM rule + foreach my $drop (qw(Approved)) { $s->header_set($drop) } + + # appears to be an old gmane bug: + $s->header_set("connect()"); + + my $orig = $s->as_string; + close $fh or die "close failed: $!\n"; + eval { run(\@args, \$orig) }; + die "fail $n: $?\n" if $?; + die "fail $n: $@\n" if $@; + } else { + warn "Failed to open $n: $!\n"; + } + $pm->finish; +} + +$pm->wait_all_children; diff --git a/scripts/report-spam b/scripts/report-spam new file mode 100755 index 00000000..825855b5 --- /dev/null +++ b/scripts/report-spam @@ -0,0 +1,28 @@ +#!/bin/sh +# Copyright (C) 2008-2013, Eric Wong +# License: GPLv3 or later +# Usage: report-spam /path/to/message/in/maildir +# my incrontab(5) looks like this: +# /path/to/.maildir/cur IN_MOVED_TO /path/to/report-spam $@/$# +# /path/to/.maildir/.INBOX.good/cur IN_MOVED_TO /path/to/report-spam $@/$# +# /path/to/.maildir/.INBOX.spam/cur IN_MOVED_TO /path/to/report-spam $@/$# + +# gigantic emails tend not to be spam (but they suck anyways...) +bytes=$(stat -c %s $1) +if test $bytes -gt 512000 +then + exit +fi + +# only tested with the /usr/sbin/sendmail which ships with postfix +case $1 in +*[/.]spam/cur/*) # non-new messages in spam get trained + exec /usr/sbin/sendmail -oem -oi $USER+trainspam < $1 + ;; +*:2,*S*) # otherwise, seen messages only + case $1 in + *:2,*T*) exit 0 ;; # ignore trashed messages + esac + exec /usr/sbin/sendmail -oem -oi $USER+trainham < $1 + ;; +esac diff --git a/t/filter.t b/t/filter.t new file mode 100644 index 00000000..9c71b11f --- /dev/null +++ b/t/filter.t @@ -0,0 +1,262 @@ +# Copyright (C) 2013, Eric Wong and all contributors +# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +use strict; +use warnings; +use Test::More; +use Email::MIME; +use Email::Filter; +use PublicInbox::Filter; + +sub count_body_parts { + my ($bodies, $part) = @_; + my $body = $part->body_raw; + $body =~ s/\A\s*//; + $body =~ s/\s*\z//; + $bodies->{$body} ||= 0; + $bodies->{$body}++; +} + +# plain-text email is passed through unchanged +{ + my $s = Email::Simple->create( + header => [ + From => 'a@example.com', + To => 'b@example.com', + 'Content-Type' => 'text/plain', + Subject => 'this is a subject', + ], + body => "hello world\n", + ); + my $f = Email::Filter->new(data => $s->as_string); + is(1, PublicInbox::Filter->run($f->simple), "run was a success"); + is($s->as_string, $f->simple->as_string, "plain email unchanged"); +} + +# convert single-part HTML to plain-text +{ + my $s = Email::Simple->create( + header => [ + From => 'a@example.com', + To => 'b@example.com', + 'Content-Type' => 'text/html', + Subject => 'HTML only badness', + ], + body => "bad body\n", + ); + my $f = Email::Filter->new(data => $s->as_string); + is(1, PublicInbox::Filter->run($f->simple), "run was a success"); + unlike($f->simple->as_string, qr//, "HTML removed"); + is("text/plain", $f->simple->header("Content-Type"), + "content-type changed"); + like($f->simple->body, qr/\A\s*bad body\s*\z/, "body"); + like($f->simple->header("X-Content-Filtered-By"), + qr/PublicInbox::Filter/, "XCFB header added"); +} + +# multipart/alternative: HTML and plain-text, keep the plain-text +{ + my $html_body = "hi"; + my $parts = [ + Email::MIME->create( + attributes => { + content_type => 'text/html; charset=UTF-8', + encoding => 'base64', + }, + body => $html_body, + ), + Email::MIME->create( + attributes => { + content_type => 'text/plain', + }, + body=> 'hi', + ) + ]; + my $email = Email::MIME->create( + header_str => [ + From => 'a@example.com', + Subject => 'blah', + 'Content-Type' => 'multipart/alternative' + ], + parts => $parts, + ); + my $f = Email::Filter->new(data => $email->as_string); + is(1, PublicInbox::Filter->run($f->simple), "run was a success"); + my $parsed = Email::MIME->new($f->simple->as_string); + is("text/plain", $parsed->header("Content-Type")); + is(scalar $parsed->parts, 1, "HTML part removed"); + my %bodies; + $parsed->walk_parts(sub { + my ($part) = @_; + return if $part->subparts; # walk_parts already recurses + count_body_parts(\%bodies, $part); + }); + is(scalar keys %bodies, 1, "one bodies"); + is($bodies{"hi"}, 1, "plain text part unchanged"); +} + +# multi-part plain-text-only +{ + my $parts = [ + Email::MIME->create( + attributes => { content_type => 'text/plain', }, + body => 'hi', + ), + Email::MIME->create( + attributes => { content_type => 'text/plain', }, + body => 'bye', + ) + ]; + my $email = Email::MIME->create( + header_str => [ From => 'a@example.com', Subject => 'blah' ], + parts => $parts, + ); + my $f = Email::Filter->new(data => $email->as_string); + is(1, PublicInbox::Filter->run($f->simple), "run was a success"); + my $parsed = Email::MIME->new($f->simple->as_string); + is(scalar $parsed->parts, 2, "still 2 parts"); + my %bodies; + $parsed->walk_parts(sub { + my ($part) = @_; + return if $part->subparts; # walk_parts already recurses + count_body_parts(\%bodies, $part); + }); + is(scalar keys %bodies, 2, "two bodies"); + is($bodies{"bye"}, 1, "bye part exists"); + is($bodies{"hi"}, 1, "hi part exists"); + is($parsed->header("X-Content-Filtered-By"), undef, + "XCFB header unset"); +} + +# multi-part HTML, several HTML parts +{ + my $parts = [ + Email::MIME->create( + attributes => { + content_type => 'text/html', + encoding => 'base64', + }, + body => 'b64 body', + ), + Email::MIME->create( + attributes => { + content_type => 'text/html', + encoding => 'quoted-printable', + }, + body => 'qp body', + ) + ]; + my $email = Email::MIME->create( + header_str => [ From => 'a@example.com', Subject => 'blah' ], + parts => $parts, + ); + my $f = Email::Filter->new(data => $email->as_string); + is(1, PublicInbox::Filter->run($f->simple), "run was a success"); + my $parsed = Email::MIME->new($f->simple->as_string); + is(scalar $parsed->parts, 2, "still 2 parts"); + my %bodies; + $parsed->walk_parts(sub { + my ($part) = @_; + return if $part->subparts; # walk_parts already recurses + count_body_parts(\%bodies, $part); + }); + is(scalar keys %bodies, 2, "two body parts"); + is($bodies{"b64 body"}, 1, "base64 part converted"); + is($bodies{"qp body"}, 1, "qp part converted"); + like($parsed->header("X-Content-Filtered-By"), qr/PublicInbox::Filter/, + "XCFB header added"); +} + +# plain-text with image attachments, kill images +{ + my $parts = [ + Email::MIME->create( + attributes => { content_type => 'text/plain' }, + body => 'see image', + ), + Email::MIME->create( + attributes => { + content_type => 'image/jpeg', + filename => 'scary.jpg', + encoding => 'base64', + }, + body => 'bad', + ) + ]; + my $email = Email::MIME->create( + header_str => [ From => 'a@example.com', Subject => 'blah' ], + parts => $parts, + ); + my $f = Email::Filter->new(data => $email->as_string); + is(1, PublicInbox::Filter->run($f->simple), "run was a success"); + my $parsed = Email::MIME->new($f->simple->as_string); + is(scalar $parsed->parts, 1, "image part removed"); + my %bodies; + $parsed->walk_parts(sub { + my ($part) = @_; + return if $part->subparts; # walk_parts already recurses + count_body_parts(\%bodies, $part); + }); + is(scalar keys %bodies, 1, "one body"); + is($bodies{'see image'}, 1, 'original body exists'); + like($parsed->header("X-Content-Filtered-By"), qr/PublicInbox::Filter/, + "XCFB header added"); +} + +# all bad +{ + my $parts = [ + Email::MIME->create( + attributes => { + content_type => 'image/jpeg', + filename => 'scary.jpg', + encoding => 'base64', + }, + body => 'bad', + ), + Email::MIME->create( + attributes => { + content_type => 'text/plain', + filename => 'scary.exe', + encoding => 'base64', + }, + body => 'bad', + ), + ]; + my $email = Email::MIME->create( + header_str => [ From => 'a@example.com', Subject => 'blah' ], + parts => $parts, + ); + my $f = Email::Filter->new(data => $email->as_string); + is(0, PublicInbox::Filter->run($f->simple), + "run signaled to stop delivery"); + my $parsed = Email::MIME->new($f->simple->as_string); + is(scalar $parsed->parts, 1, "bad parts removed"); + my %bodies; + $parsed->walk_parts(sub { + my ($part) = @_; + return if $part->subparts; # walk_parts already recurses + count_body_parts(\%bodies, $part); + }); + is(scalar keys %bodies, 1, "one body"); + is($bodies{"all attachments scrubbed by PublicInbox::Filter"}, 1, + "attachment scrubber left its mark"); + like($parsed->header("X-Content-Filtered-By"), qr/PublicInbox::Filter/, + "XCFB header added"); +} + +{ + my $s = Email::Simple->create( + header => [ + From => 'a@example.com', + To => 'b@example.com', + 'Content-Type' => 'test/pain', + Subject => 'this is a subject', + ], + body => "hello world\n", + ); + my $f = Email::Filter->new(data => $s->as_string); + is(0, PublicInbox::Filter->run($f->simple), "run was a failure"); + like($f->simple->as_string, qr/scrubbed/, "scrubbed message"); +} + +done_testing(); -- cgit v1.2.3-24-ge0c7