From: Michael Orlitzky Date: Thu, 5 Jun 2014 21:02:54 +0000 (-0400) Subject: Initial commit of something working. X-Git-Tag: 0.0.1~12 X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=e3ef76e60ddd54e5fad787c5883533d2410b3e2a;p=list-remote-forwards.git Initial commit of something working. --- e3ef76e60ddd54e5fad787c5883533d2410b3e2a diff --git a/.ghci b/.ghci new file mode 100644 index 0000000..9c70fd2 --- /dev/null +++ b/.ghci @@ -0,0 +1,8 @@ +:set -isrc -idist/build/autogen +:load src/Main.hs +:load src/Report.hs + +import Database.HDBC +import Database.HDBC.Sqlite3 + +:set prompt "list-remote-forwards> " diff --git a/Setup.hs b/Setup.hs new file mode 100644 index 0000000..9a994af --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/doc/LICENSE b/doc/LICENSE new file mode 100644 index 0000000..bc08fe2 --- /dev/null +++ b/doc/LICENSE @@ -0,0 +1,619 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. diff --git a/doc/list-remote-forwardsrc.example b/doc/list-remote-forwardsrc.example new file mode 100644 index 0000000..96a834e --- /dev/null +++ b/doc/list-remote-forwardsrc.example @@ -0,0 +1,59 @@ +# +# Sample configuration file for list-remote-forwards. +# + +# The name of the database (or file, if SQLite) to which we should connect. +# +# Default: The name of the current user (Postgres only) +# +# database = "postfixadmin" + + +# SQL query used to produce a list of local domains. This should return +# the set of all domains (i.e one column) that are local to the +# server. See the default value for an example. +# +# Default: "SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;" +# +# domain_query = "SELECT DISTINCT domain FROM alias;" + + +# SQL query used to produce a list of all forwards on the mail +# system. This query should return the set of all (address, goto) +# triples, where "goto" is the destination address; i.e. to where +# the "address" forwards. The "goto" field may contain more +# than one email address, separated by commas. +# +# Default: "SELECT address,goto FROM alias ORDER BY address;" +# +# forward_query = "SELECT address,alias FROM aliases;" + + + +# Hostname where the database is located (Postgres-only). +# +# Default: None, a UNIX domain socket connection is attempted (Postgres only) +# +# host = "localhost" + + +# Password used to connect to the database (Postgres-only). +# +# Default: None (assumes passwordless authentication) +# +# password = "hunter2" + + +# Port number used to connect to the database (Postgres-only). +# +# Default: None, a UNIX domain socket connection is attempted (Postgres only) +# +# port = 5432 + + + +# Username used to connect to the database (Postgres-only). +# +# Default: The current user +# +# username = "postgres" diff --git a/doc/man1/list-remote-forwards.1 b/doc/man1/list-remote-forwards.1 new file mode 100644 index 0000000..fb9fb5c --- /dev/null +++ b/doc/man1/list-remote-forwards.1 @@ -0,0 +1,92 @@ +.TH list-remote-forwards 1 + +.SH NAME +list\-remote\-forwards \- List all remote forwards for mail accounts stored in +a SQL database +.SH SYNOPSIS + +\fBlist-remote-forwards\fR [\fIOPTIONS\fR] +.SH INPUT +.P +None. +.SH OUTPUT +.P +A list of addresses that are forwarded to remote domains. +.SH DESCRIPTION +.P +A list of local domains is supplied to the program (more or less) +through the \fI\-\-domain\-query\fR option. Any addresses which +forward to another address not contained in this list of local domains +is considered a remote forward. Remote forwards can cause problems for +a number of reasons, the most common of which are, +.IP \(bu 2 +If the sender has an SPF record authorizing his mail server to send +mail on his behalf, then when his message is forwarded by the +recipient's mail server, it will fail any subsequent SPF checks. This +will likely cause the message to be rejected, and the original +recipient's server will generate backscatter. +.IP \(bu +If any spam makes it through the filter on the recipient's mail +server, that spam will then be forwarded to a remote destination. The +remote destination will blame the forwarding server for the spam, and +that can impact its reputation and potentially lead to a blacklisting +even though the spam did not originate on the recipient's server. +.P +Whether or not these are an issue depends on the circumstances, but in +any case it is useful to know who is forwarding mail off-site. +.SH OPTIONS + +.IP \fB\-\-database\fR +The name of the database (or file, if SQLite) to which we should +connect. + +Default: The name of the current user (Postgres only). + +.IP \fB\-\-domain-query\fR +SQL query used to produce a list of local domains. This should return +the set of all domains (i.e one column) that are local to the +server. See the default value for an example. + +Default: \(dqSELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\(dq + +.IP \fB\-\-forward-query\fR +SQL query used to produce a list of all forwards on the mail +system. This query should return the set of all (address, goto) +triples, where \(dqgoto\(dq is the destination address; i.e. to where +the \(dqaddress\(dq forwards. The \(dqgoto\(dq field may contain more +than one email address, separated by commas. + +Default: \(dqSELECT address,goto FROM alias ORDER BY address;\(dq + +.IP \fB\-\-host\fR +Hostname where the database is located (Postgres-only). + +Default: None, a UNIX domain socket connection is attempted (Postgres only) + +.IP \fB\-\-password\fR +Password used to connect to the database (Postgres-only). + +Default: None (assumes passwordless authentication) + +.IP \fB\-\-port\fR +Port number used to connect to the database (Postgres-only). + +Default: None, a UNIX domain socket connection is attempted (Postgres only) + +.IP \fB\-\-username\fR +Username used to connect to the database (Postgres-only). + +Default: The current user + +.SH EXAMPLES + +.nf +.I $ list-remote-forwards --database=postfixadmin.sqlite3 +user1@example.com -> user1@example.net +user2@example.com -> user1@example.org +user2@example.com -> user2@example.org +user2@example.com -> user3@example.org +.fi +.SH BUGS +.P +Send bugs to michael@orlitzky.com. diff --git a/list-remote-forwards.cabal b/list-remote-forwards.cabal new file mode 100644 index 0000000..cff0d70 --- /dev/null +++ b/list-remote-forwards.cabal @@ -0,0 +1,216 @@ +name: list-remote-forwards +version: 0.0.1 +cabal-version: >= 1.8 +author: Michael Orlitzky +maintainer: Michael Orlitzky +license: GPL-3 +license-file: doc/LICENSE +bug-reports: mailto:michael@orlitzky.com +category: Mail, Utils +build-type: Simple +extra-source-files: + doc/list-remote-forwards.example + doc/man1/list-remote-forwards.1 + test/fixtures/postfixadmin.sqlite3 +synopsis: + List all remote forwards for mail accounts stored in a SQL database. +description: + /Usage/: + . + @ + list-remote-forwards [OPTIONS] + @ + . + List all remote forwards for mail accounts stored in a SQL database. + . + A list of local domains is supplied to the program (more or less) + through the @--domain-query@ option. Any addresses which + forward to another address not contained in this list of local domains + is considered a remote forward. Remote forwards can cause problems for + a number of reasons, the most common of which are, + . + * If the sender has an SPF record authorizing his mail server to send + mail on his behalf, then when his message is forwarded by the + recipient's mail server, it will fail any subsequent SPF checks. This + will likely cause the message to be rejected, and the original + recipient's server will generate backscatter. + . + * If any spam makes it through the filter on the recipient's mail + server, that spam will then be forwarded to a remote destination. The + remote destination will blame the forwarding server for the spam, and + that can impact its reputation and potentially lead to a blacklisting + even though the spam did not originate on the recipient's server. + . + Whether or not these are an issue depends on the circumstances, but in + any case it is useful to know who is forwarding mail off-site. + . + /Input:/ + . + None. + . + /Output:/ + . + A list of addresses that are forwarded to remote domains. + . + /Options/: + . + @ + \--database + @ + . + The name of the database (or file, if SQLite) to which we should + connect. + . + Default: The name of the current user (Postgres only). + . + @ + \--domain-query + @ + SQL query used to produce a list of local domains. This should return + the set of all domains (i.e one column) that are local to the + server. See the default value for an example. + . + Default: \"SELECT domain FROM domain WHERE domain <> 'ALL' ORDER BY domain;\" + . + @ + \--forward-query + @ + . + SQL query used to produce a list of all forwards on the mail + system. This query should return the set of all (address, goto) + triples, where \"goto\" is the destination address; i.e. to where + the \"address\" forwards. The \"goto\" field may contain more + than one email address, separated by commas. + . + Default: \"SELECT address,goto FROM alias ORDER BY address;\" + . + @ + \--host + @ + . + Hostname where the database is located (Postgres-only). + . + Default: None, a UNIX domain socket connection is attempted (Postgres only) + . + @ + \--password + @ + . + Password used to connect to the database (Postgres-only). + . + Default: None (assumes passwordless authentication) + . + @ + \--port + @ + Port number used to connect to the database (Postgres-only). + . + Default: None, a UNIX domain socket connection is attempted (Postgres only) + . + @ + \--username + @ + . + Username used to connect to the database (Postgres-only). + . + Default: The current user + . + /Examples/: + . + @ + $ list-remote-forwards --database=postfixadmin.sqlite3 + user1@example.com -> user1@example.net + user2@example.com -> user1@example.org + user2@example.com -> user2@example.org + user2@example.com -> user3@example.org + @ + +executable list-remote-forwards + build-depends: + base >= 4.6 && < 5, + bytestring >= 0.10, + cmdargs >= 0.10, + configurator >= 0.2, + containers >= 0.5, + dns >= 1.2, + directory >= 1.2, + filepath >= 1.3, + HDBC >= 2.4, + HDBC-postgresql >= 2.3, + HDBC-sqlite3 >= 2.3, + MissingH >= 1.2, + tasty >= 0.8, + tasty-hunit >= 0.8, + tasty-quickcheck >= 0.8 + main-is: + Main.hs + + hs-source-dirs: + src/ + + other-modules: + Configuration + CommandLine + DNS + OptionalConfiguration + MxList + Report + + ghc-options: + -Wall + -fwarn-hi-shadowing + -fwarn-missing-signatures + -fwarn-name-shadowing + -fwarn-orphans + -fwarn-type-defaults + -fwarn-tabs + -fwarn-incomplete-record-updates + -fwarn-monomorphism-restriction + -fwarn-unused-do-bind + -rtsopts + -threaded + -optc-O3 + -optc-march=native + + +test-suite testsuite + type: exitcode-stdio-1.0 + hs-source-dirs: src test + main-is: TestSuite.hs + build-depends: + base >= 4.6 && < 5, + bytestring >= 0.10, + cmdargs >= 0.10, + configurator >= 0.2, + containers >= 0.5, + dns >= 1.2, + directory >= 1.2, + filepath >= 1.3, + HDBC >= 2.4, + HDBC-postgresql >= 2.3, + HDBC-sqlite3 >= 2.3, + MissingH >= 1.2, + tasty >= 0.8, + tasty-hunit >= 0.8, + tasty-quickcheck >= 0.8 + + -- It's not entirely clear to me why I have to reproduce all of this. + ghc-options: + -Wall + -fwarn-hi-shadowing + -fwarn-missing-signatures + -fwarn-name-shadowing + -fwarn-orphans + -fwarn-type-defaults + -fwarn-tabs + -fwarn-incomplete-record-updates + -fwarn-monomorphism-restriction + -fwarn-unused-do-bind + -O2 + + + +source-repository head + type: git + location: http://michael.orlitzky.com/git/list-remote-forwards.git + branch: master diff --git a/makefile b/makefile new file mode 100644 index 0000000..c024def --- /dev/null +++ b/makefile @@ -0,0 +1,56 @@ +PN = list-remote-forwards +BIN = dist/build/$(PN)/$(PN) +SRCS = $(shell find src/ -type f -name '*.hs') + +.PHONY : dist hlint + +$(BIN): $(PN).cabal $(SRCS) + runghc Setup.hs configure --user + runghc Setup.hs build + +doc: $(PN).cabal $(SRCS) + runghc Setup.hs hscolour --all + runghc Setup.hs haddock --all \ + --hyperlink-source \ + --haddock-options="--ignore-all-exports" + + +# +# Tests +# +TESTSUITE_BIN = dist/build/testsuite/testsuite +DOCTESTS_BIN = dist/build/doctests/doctests +TEST_SRCS := $(shell find test/ -type f -name '*.hs') + +$(TESTSUITE_BIN): $(PN).cabal $(SRCS) $(TEST_SRCS) + runghc Setup.hs configure --user --enable-tests --prefix=/ + runghc Setup.hs build + + +$(DOCTESTS_BIN): $(PN).cabal $(SRCS) $(TEST_SRCS) + runghc Setup.hs configure --user --enable-tests + runghc Setup.hs build + +test: $(BIN) $(TESTSUITE_BIN) $(DOCTESTS_BIN) + runghc Setup.hs test + + +# +# Misc +# + +dist: + runghc Setup.hs configure + TAR_OPTIONS="--format=ustar" runghc Setup.hs sdist + +hlint: + hlint --ignore="Use camelCase" \ + --ignore="Redundant bracket" \ + --color \ + src + +clean: + runghc Setup.hs clean + find ./ -type f -name '*.prof' -delete + find ./ -type f -name '*.o' -delete + find ./ -type f -name '*.hi' -delete diff --git a/src/CommandLine.hs b/src/CommandLine.hs new file mode 100644 index 0000000..9033f0d --- /dev/null +++ b/src/CommandLine.hs @@ -0,0 +1,80 @@ +module CommandLine ( + get_args ) +where + +import System.Console.CmdArgs ( + (&=), + cmdArgs, + def, + details, + help, + program, + summary ) + + +-- Get the version from Cabal. +import Paths_list_remote_forwards ( version ) +import Data.Version ( showVersion ) + +import OptionalConfiguration ( OptionalConfiguration(..) ) + + +description :: String +description = + "List all remote forwards for mail accounts stored in a SQL database." + +program_name :: String +program_name = "list-remote-forwards" + +my_summary :: String +my_summary = program_name ++ "-" ++ (showVersion version) + +database_help :: String +database_help = + "The name of the database (or file, if SQLite) to which we should connect" + +domain_query_help :: String +domain_query_help = + "SQL query used to produce the list of local domains" + +exclude_mx_help :: String +exclude_mx_help = + "MX for whom we don't report remote forwards" + +forward_query_help :: String +forward_query_help = + "SQL query used to produce the list of forwards, i.e. (to,from) pairs" + +host_help :: String +host_help = + "Hostname where the database is located (postgres-only)" + +password_help :: String +password_help = + "Password used to connect to the database (postgres-only)" + +port_help :: String +port_help = + "Port number used to connect to the database (postgres-only)" + +username_help :: String +username_help = + "Username used to connect to the database (postgres-only)" + +arg_spec :: OptionalConfiguration +arg_spec = + OptionalConfiguration { + database = def &= help database_help, + domain_query = def &= help domain_query_help, + exclude_mx = def &= help exclude_mx_help, + forward_query = def &= help forward_query_help, + host = def &= help host_help, + password = def &= help password_help, + port = def &= help port_help, + username = def &= help username_help } + &= program program_name + &= summary my_summary + &= details [description] + +get_args :: IO OptionalConfiguration +get_args = cmdArgs arg_spec diff --git a/src/Configuration.hs b/src/Configuration.hs new file mode 100644 index 0000000..7ef0722 --- /dev/null +++ b/src/Configuration.hs @@ -0,0 +1,83 @@ +-- | This module defines the 'Configuration' type, which is just a +-- wrapper around all of the configuration options we accept on the +-- command line. +-- +module Configuration ( + Configuration(..), + merge_optional ) +where + +import System.Console.CmdArgs.Default ( Default(..) ) + +import MxList (MxList(..)) +import qualified OptionalConfiguration as OC ( + OptionalConfiguration(..), + merge_maybes ) + +-- | The main configuration data type. This will be passed to most of +-- the important functions once it has been created. +-- +data Configuration = + Configuration { + database :: Maybe String, + domain_query :: String, + exclude_mx :: MxList, + forward_query :: String, + host :: Maybe String, + password :: Maybe String, + port :: Maybe Int, + username :: Maybe String } + deriving (Show) + + +-- | A Configuration with all of its fields set to their default +-- values. +-- +instance Default Configuration where + def = Configuration { + database = def, + domain_query = def_domain_query, + exclude_mx = def, + forward_query = def_forward_query, + host = def, + password = def, + port = def, + username = def } + where + def_domain_query = "SELECT domain " ++ + "FROM domain " ++ + "WHERE domain <> 'ALL' " ++ + "ORDER BY domain;" + + def_forward_query = "SELECT address,goto " ++ + "FROM alias " ++ + "ORDER BY address;" + +-- | Merge a 'Configuration' with an 'OptionalConfiguration'. This is +-- more or less the Monoid instance for 'OptionalConfiguration', but +-- since the two types are different, we have to repeat ourselves. +-- +merge_optional :: Configuration + -> OC.OptionalConfiguration + -> Configuration +merge_optional cfg opt_cfg = + Configuration + (OC.merge_maybes (database cfg) (OC.database opt_cfg)) + (merge (domain_query cfg) (OC.domain_query opt_cfg)) + all_excluded_mx + (merge (forward_query cfg) (OC.forward_query opt_cfg)) + (OC.merge_maybes (host cfg) (OC.host opt_cfg)) + (OC.merge_maybes (password cfg) (OC.password opt_cfg)) + (OC.merge_maybes (port cfg) (OC.port opt_cfg)) + (OC.merge_maybes (username cfg) (OC.username opt_cfg)) + where + -- | If the thing on the right is Just something, return that + -- something, otherwise return the thing on the left. + merge :: a -> Maybe a -> a + merge x Nothing = x + merge _ (Just y) = y + + -- If there are any optional usernames, use only those. + all_excluded_mx = if (null (get_mxs (OC.exclude_mx opt_cfg))) + then (exclude_mx cfg) + else (OC.exclude_mx opt_cfg) diff --git a/src/DNS.hs b/src/DNS.hs new file mode 100644 index 0000000..00db178 --- /dev/null +++ b/src/DNS.hs @@ -0,0 +1,107 @@ +module DNS ( + dns_properties, + dns_tests, + lookup_mxs, + normalize ) +where + +import qualified Data.ByteString.Char8 as BS ( + append, + last, + map, + null, + pack ) +import Data.Char ( toLower ) +import Network.DNS ( + Domain, + defaultResolvConf, + lookupMX, + makeResolvSeed, + withResolver ) +import Test.Tasty ( TestTree, testGroup ) +import Test.Tasty.HUnit ( (@?=), testCase ) +import Test.Tasty.QuickCheck ( testProperty ) + +-- Slow since we create the resolver every time. +lookup_mxs :: Domain -> IO [Domain] +lookup_mxs domain = do + default_rs <- makeResolvSeed defaultResolvConf + withResolver default_rs $ \resolver -> do + mxs <- lookupMX resolver domain + return $ case mxs of + Left _ -> [] + Right pairs -> map fst pairs + + +-- | Perform both normalize_case and normalize_root. +normalize :: Domain -> Domain +normalize = normalize_case . normalize_root + +-- | Normalize the given name by appending a trailing dot (the DNS +-- root) if necessary. +-- +normalize_root :: Domain -> Domain +normalize_root d + | BS.null d = BS.pack "." + | BS.last d == '.' = d + | otherwise = d `BS.append` trailing_dot + where + trailing_dot = BS.pack "." + + +-- | Normalize the given name by lowercasing it. +-- +normalize_case :: Domain -> Domain +normalize_case = BS.map toLower + +-- * Tests + +test_normalize_case :: TestTree +test_normalize_case = + testCase desc $ actual @?= expected + where + desc = "normalize_case lowercases DNS names" + expected = BS.pack "example.com" + actual = normalize_case $ BS.pack "ExAmPlE.COM" + +prop_normalize_case_idempotent :: TestTree +prop_normalize_case_idempotent = + testProperty desc $ prop + where + desc = "normalize_case is idempotent" + + prop :: String -> Bool + prop s = (normalize_case . normalize_case) bs == normalize_case bs + where + bs = BS.pack s + +test_normalize_root_adds_dot :: TestTree +test_normalize_root_adds_dot = + testCase desc $ actual @?= expected + where + desc = "normalize_root adds a trailing dot" + expected = BS.pack "example.com." + actual = normalize_root $ BS.pack "example.com" + +prop_normalize_root_idempotent :: TestTree +prop_normalize_root_idempotent = + testProperty desc prop + where + desc = "normalize_root is idempotent" + + prop :: String -> Bool + prop s = (normalize_root . normalize_root) bs == normalize_root bs + where + bs = BS.pack s + +dns_tests :: TestTree +dns_tests = + testGroup "DNS Tests" [ + test_normalize_case, + test_normalize_root_adds_dot ] + +dns_properties :: TestTree +dns_properties = + testGroup "DNS Properties" [ + prop_normalize_case_idempotent, + prop_normalize_root_idempotent ] diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 index 0000000..d1d1ea8 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,85 @@ +{-# LANGUAGE DoAndIfThenElse #-} +{-# LANGUAGE NoMonomorphismRestriction #-} +module Main +where + +import Data.Maybe ( fromMaybe ) +import Data.Monoid ( (<>) ) +import Data.String.Utils ( join ) +import Database.HDBC ( SqlError(..), handleSql ) +import Database.HDBC.PostgreSQL ( connectPostgreSQL ) +import Database.HDBC.Sqlite3 ( connectSqlite3 ) +import System.Console.CmdArgs ( def ) +import System.Directory ( doesFileExist ) +import System.IO ( hPutStrLn, stderr ) +import CommandLine ( get_args ) +import Configuration ( Configuration(..), merge_optional ) +import qualified OptionalConfiguration as OC ( from_rc ) +import Report ( report ) + + +-- | Construct a connection string (postgres-only, for now) from a +-- 'Configuration'. All of these are optional, at least for +-- Postgres, and so we want to avoid appending e.g. \"host=\" to the +-- connection string if @(host cfg)@ is 'Nothing'. +-- +-- Examples: +-- +-- >>> let default_cfg = def :: Configuration +-- >>> let cfg = default_cfg { host = Just "localhost" } +-- >>> connection_string cfg +-- "host=localhost" +-- >>> let cfg2 = cfg { username = Just "postgres" } +-- >>> connection_string cfg2 +-- "host=localhost user=postgres" +-- +connection_string :: Configuration -> String +connection_string cfg = + trim $ join " " [host_part, port_part, user_part, pw_part, db_part] + where + -- | Strip leading/trailing whitespace, and collapse multiple + -- consecutive spaces into one. + trim :: String -> String + trim = unwords . words + + host_part = let h = fmap ("host=" ++) (host cfg) in fromMaybe "" h + port_part = let p = fmap (("port=" ++) . show) (port cfg) in fromMaybe "" p + user_part = let u = fmap ("user=" ++) (username cfg) in fromMaybe "" u + pw_part = let pw = fmap ("password=" ++) (password cfg) in fromMaybe "" pw + db_part = let db = fmap ("dbname=" ++) (database cfg) in fromMaybe "" db + + +main :: IO () +main = do + rc_cfg <- OC.from_rc + cmd_cfg <- get_args + + -- Merge the config file options with the command-line ones, + -- prefering the command-line ones. + let opt_config = rc_cfg <> cmd_cfg + + -- Update a default config with any options that have been set in + -- either the config file or on the command-line. We initialize + -- logging before the missing parameter checks below so that we can + -- log the errors. + let cfg = (def :: Configuration) `merge_optional` opt_config + + -- If a database name was specified, and that name exists as a file + -- on the system, assume that the user wanted to use SQLite. + handleSql show_sql_error $ do + r <- case (database cfg) of + Nothing -> connectPostgreSQL (connection_string cfg) >>= report cfg + + Just dbname -> do + exists <- doesFileExist dbname + if exists + then connectSqlite3 dbname >>= report cfg + else connectPostgreSQL (connection_string cfg) >>= report cfg + + -- The DB connection is implicitly closed when it gets garbage collected. + putStrLn r + + where + show_sql_error :: SqlError -> IO () + show_sql_error se = hPutStrLn stderr $ + "SQL Error (" ++ (show $ seNativeError se) ++ "): " ++ (seErrorMsg se) diff --git a/src/MxList.hs b/src/MxList.hs new file mode 100644 index 0000000..d79307d --- /dev/null +++ b/src/MxList.hs @@ -0,0 +1,48 @@ +{-# LANGUAGE DeriveDataTypeable #-} + +-- | A newtype around a list of Strings which represent the MXes whose +-- remote forwards we don't report. This is all to avoid an orphan +-- instance of Configured for [String] if we had defined one in +-- e.g. 'OptionalConfiguration'. +-- +module MxList +where + +-- DC is needed only for the DCT.Configured instance of String. +import qualified Data.Configurator as DC() +import qualified Data.Configurator.Types as DCT ( + Configured, + Value( List ), + convert ) +import Data.Data (Data) +import System.Console.CmdArgs.Default (Default(..)) +import Data.Typeable (Typeable) + + +-- | A (wrapper around a) list of MX hostnames. +-- +newtype MxList = + MxList { get_mxs :: [String] } + deriving (Data, Show, Typeable) + + +-- | The default (empty) list of MXes. +instance Default MxList where + def = MxList [] + +instance DCT.Configured MxList where + -- | This allows us to read a MxList object out of a Configurator + -- config file. By default Configurator wouldn't know what to do, + -- so we have to tell it that we expect a list, and if that list + -- has strings in it, we can apply the MxList constructor to + -- it. + convert (DCT.List xs) = + -- mapM gives us a Maybe [String] here. + fmap MxList (mapM convert_string xs) + where + convert_string :: DCT.Value -> Maybe String + convert_string = DCT.convert + + -- If we read anything other than a list of values out of the file, + -- fail. + convert _ = Nothing diff --git a/src/OptionalConfiguration.hs b/src/OptionalConfiguration.hs new file mode 100644 index 0000000..072f25b --- /dev/null +++ b/src/OptionalConfiguration.hs @@ -0,0 +1,139 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE OverloadedStrings #-} + +-- | An OptionalConfiguration is just like a 'Configuration', except +-- all of its fields are optional. The user can set options in two +-- places: the command-line, and a configuration file. Obviously if +-- a parameter is set in one place, it doesn't need to be set in the +-- other. Thus, the latter needs to be optional. +-- + +module OptionalConfiguration ( + OptionalConfiguration(..), + from_rc, + merge_maybes ) +where + +import qualified Data.Configurator as DC ( + Worth(Optional), + load, + lookup ) + +import Data.Maybe ( fromMaybe ) +import Data.Monoid ( Monoid(..) ) +import Data.Data ( Data ) +import Data.Typeable ( Typeable ) +import Paths_list_remote_forwards ( getSysconfDir ) +import System.Directory ( getHomeDirectory ) +import System.FilePath ( () ) +import System.IO.Error ( catchIOError ) + +import MxList ( MxList(..) ) + +-- | The same as Configuration, except everything is optional. It's easy to +-- merge two of these by simply dropping the Nothings in favor of +-- the Justs. The 'feed_hosts' are left un-maybed so that cmdargs +-- can parse more than one of them. +-- +data OptionalConfiguration = + OptionalConfiguration { + database :: Maybe String, + domain_query :: Maybe String, + exclude_mx :: MxList, + forward_query :: Maybe String, + host :: Maybe String, + password :: Maybe String, + port :: Maybe Int, + username :: Maybe String } + deriving (Show, Data, Typeable) + + +-- | Combine two Maybes into one, essentially mashing them +-- together. We give precedence to the second argument when both are +-- Justs. +merge_maybes :: (Maybe a) -> (Maybe a) -> (Maybe a) +merge_maybes Nothing Nothing = Nothing +merge_maybes (Just x) Nothing = Just x +merge_maybes Nothing (Just x) = Just x +merge_maybes (Just _) (Just y) = Just y + + +-- | The Monoid instance for these lets us "combine" two +-- OptionalConfigurations. The "combine" operation that we'd like to +-- perform is, essentially, to mash them together. So if we have two +-- OptionalConfigurations, each half full, we could combine them +-- into one big one. +-- +-- This is used to merge command-line and config-file settings. +-- +instance Monoid OptionalConfiguration where + -- | An empty OptionalConfiguration. + mempty = OptionalConfiguration + Nothing + Nothing + (MxList []) + Nothing + Nothing + Nothing + Nothing + Nothing + + -- | Combine @cfg1@ and @cfg2@, giving precedence to @cfg2@. + cfg1 `mappend` cfg2 = + OptionalConfiguration + (merge_maybes (database cfg1) (database cfg2)) + (merge_maybes (domain_query cfg1) (domain_query cfg2)) + all_excluded_mx + (merge_maybes (forward_query cfg1) (forward_query cfg2)) + (merge_maybes (host cfg1) (host cfg2)) + (merge_maybes (password cfg1) (password cfg2)) + (merge_maybes (port cfg1) (port cfg2)) + (merge_maybes (username cfg1) (username cfg2)) + where + -- Use only the latter exclude_mx if there are any. + all_excluded_mx = + exclude_mx $ if (null (get_mxs $ exclude_mx cfg2)) + then cfg1 + else cfg2 + + +-- | Obtain an OptionalConfiguration from list-remote-forwardsrc in +-- either the global configuration directory or the user's home +-- directory. The one in $HOME is prefixed by a dot so that it is +-- hidden. +-- +-- We make an attempt at cross-platform compatibility; we will try +-- to find the correct directory even on Windows. But if the calls +-- to getHomeDirectory/getSysconfDir fail for whatever reason, we +-- fall back to using the Unix-specific /etc and $HOME. +-- +from_rc :: IO OptionalConfiguration +from_rc = do + etc <- catchIOError getSysconfDir (\e -> do + putStrLn $ "ERROR: " ++ (show e) + return "/etc") + home <- catchIOError getHomeDirectory (\e -> do + putStrLn $ "ERROR: " ++ (show e) + return "$(HOME)") + let global_config_path = etc "list-remote-forwardsrc" + let user_config_path = home ".list-remote-forwardsrc" + cfg <- DC.load [ DC.Optional global_config_path, + DC.Optional user_config_path ] + cfg_database <- DC.lookup cfg "database" + cfg_domain_query <- DC.lookup cfg "domain_query" + cfg_exclude_mx <- DC.lookup cfg "exclude_mx" + cfg_forward_query <- DC.lookup cfg "forward_query" + cfg_host <- DC.lookup cfg "host" + cfg_password <- DC.lookup cfg "password" + cfg_port <- DC.lookup cfg "port" + cfg_username <- DC.lookup cfg "username" + + return $ OptionalConfiguration + cfg_database + cfg_domain_query + (fromMaybe (MxList []) cfg_exclude_mx) + cfg_forward_query + cfg_host + cfg_password + cfg_port + cfg_username diff --git a/src/Report.hs b/src/Report.hs new file mode 100644 index 0000000..b15da98 --- /dev/null +++ b/src/Report.hs @@ -0,0 +1,157 @@ +{-# LANGUAGE PatternGuards #-} + +module Report ( + report, + report_tests ) +where + +import Control.Monad ( filterM ) +import qualified Data.ByteString.Char8 as BS ( pack ) +import Data.Maybe ( catMaybes, listToMaybe ) +import Data.String.Utils ( join, split, strip ) +import Database.HDBC ( + IConnection, + execute, + prepare, + sFetchAllRows') +import Database.HDBC.Sqlite3 ( connectSqlite3 ) +import Data.List ( (\\) ) +import System.Console.CmdArgs.Default ( Default(..) ) +import Test.Tasty ( TestTree, testGroup ) +import Test.Tasty.HUnit ( (@?=), testCase ) + +import Configuration ( Configuration(..) ) +import DNS ( lookup_mxs, normalize ) +import MxList ( MxList(..) ) + +-- Type synonyms to make the signatures below a little more clear. +type Domain = String +type Address = String +type Goto = String + +data Forward = + Forward Address Goto + deriving (Show) + +get_domain_list :: IConnection a => a -> String -> IO [Domain] +get_domain_list conn query = do + stmt <- prepare conn query + + -- We really want executeRaw here, but there's a bug: it will tell + -- us we can't fetch rows from the statement since it hasn't been + -- executed yet! + _ <- execute stmt [] + + -- rows :: [[Maybe String]] + rows <- sFetchAllRows' stmt + + -- rows' :: [Maybe String] + let rows' = map (listToMaybe . catMaybes) rows + + -- domains :: [String] + let domains = catMaybes rows' + + return domains + + +get_forward_list :: IConnection a => a -> String -> IO [Forward] +get_forward_list conn query = do + stmt <- prepare conn query + + -- We really want executeRaw here, but there's a bug: it will tell + -- us we can't fetch rows from the statement since it hasn't been + -- executed yet! + _ <- execute stmt [] + + -- rows :: [[Maybe String]] + rows <- sFetchAllRows' stmt + + -- forwards :: [Forward] + let forwards = concatMap (row_to_forwards . catMaybes) rows + + return forwards + where + row_to_forwards :: [String] -> [Forward] + row_to_forwards (addr:gotos:_) = + [Forward addr (strip g) | g <- split "," gotos] + row_to_forwards _ = [] + + + +find_remote_forwards :: [Domain] -> [Forward] -> [Forward] +find_remote_forwards domains forwards = + filter is_remote forwards + where + is_remote :: Forward -> Bool + is_remote (Forward _ goto) = + let parts = split "@" goto + in + case parts of + (_:dp:[]) -> not $ dp `elem` domains + _ -> True -- Assume it's remote if something is wrong + + +format_forward :: Forward -> String +format_forward (Forward addr goto) = + addr ++ " -> " ++ goto + + +-- If the MX records for a domain are exactly those contained in the +-- MxList, then we exclude that domain from the report. Splitting on +-- the '@' is a lazy way of obtaining the domain, but if it's good +-- enough for determining that a forward is remote, then it's good +-- enough for this. +filter_by_mx :: MxList -> [Forward] -> IO [Forward] +-- This special case is necessary! Otherwise if we have an empty +-- exclude list and a domain that has no MX record, it will be +-- excluded. +filter_by_mx (MxList []) = return +filter_by_mx (MxList mxs) = + filterM all_mxs_excluded + where + all_mxs_excluded :: Forward -> IO Bool + all_mxs_excluded (Forward addr _) = + case (split "@" addr) of + (_:domain_part:[]) -> do + fw_mxs <- lookup_mxs (BS.pack domain_part) + let norm_mxs = map (normalize . BS.pack) mxs + if (norm_mxs \\ fw_mxs) == [] then return False else return True + _ -> return True -- Report it if we can't figure out the domain. + + +-- | Given a connection and a 'Configuration', produces the report as +-- a 'String'. +-- +report :: IConnection a => Configuration -> a -> IO String +report cfg conn = do + domains <- get_domain_list conn (domain_query cfg) + forwards <- get_forward_list conn (forward_query cfg) + + valid_forwards <- filter_by_mx (exclude_mx cfg) forwards + let remote_forwards = find_remote_forwards domains valid_forwards + let forward_strings = map format_forward remote_forwards + + return $ (join "\n" forward_strings) ++ "\n" + + + +-- * Tests + +report_tests :: TestTree +report_tests = + testGroup "Report Tests" [ test_example1 ] + + +test_example1 :: TestTree +test_example1 = + testCase desc $ do + conn <- connectSqlite3 "test/fixtures/postfixadmin.sqlite3" + let cfg = def :: Configuration + actual <- report cfg conn + actual @?= expected + where + desc = "all remote forwards are found" + expected = "user1@example.com -> user1@example.net\n" ++ + "user2@example.com -> user1@example.org\n" ++ + "user2@example.com -> user2@example.org\n" ++ + "user2@example.com -> user3@example.org\n" diff --git a/test/TestSuite.hs b/test/TestSuite.hs new file mode 100644 index 0000000..fc58bd8 --- /dev/null +++ b/test/TestSuite.hs @@ -0,0 +1,12 @@ +import Test.Tasty ( TestTree, defaultMain, testGroup ) + +import DNS ( dns_properties, dns_tests ) +import Report ( report_tests ) + +tests :: TestTree +tests = testGroup "All tests" [ dns_properties, + dns_tests, + report_tests ] + +main :: IO () +main = defaultMain tests diff --git a/test/fixtures/postfixadmin.sqlite3 b/test/fixtures/postfixadmin.sqlite3 new file mode 100644 index 0000000..38f39ee Binary files /dev/null and b/test/fixtures/postfixadmin.sqlite3 differ