diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,876 @@ +notmuch-haskell: notmuch MUA Haskell binding +Copyright © 2010 Bart Massey + +This program is free software: you can redistribute it +and/or modify it under the terms of version 3 of the GNU +Lesser General Public License as published by the Free +Software Foundation. + +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 Lesser General Public License for more +details. + +----- + +GNU LESSER 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. + +This version of the GNU Lesser General Public License +incorporates the terms and conditions of version 3 of the +GNU General Public License, supplemented by the additional +permissions listed below. 0. Additional Definitions. + +As used herein, “this License” refers to version 3 of the +GNU Lesser General Public License, and the “GNU GPL” refers +to version 3 of the GNU General Public License. + +“The Library” refers to a covered work governed by this +License, other than an Application or a Combined Work as +defined below. + +An “Application” is any work that makes use of an interface +provided by the Library, but which is not otherwise based on +the Library. Defining a subclass of a class defined by the +Library is deemed a mode of using an interface provided by +the Library. + +A “Combined Work” is a work produced by combining or linking +an Application with the Library. The particular version of +the Library with which the Combined Work was made is also +called the “Linked Version”. + +The “Minimal Corresponding Source” for a Combined Work means +the Corresponding Source for the Combined Work, excluding +any source code for portions of the Combined Work that, +considered in isolation, are based on the Application, and +not on the Linked Version. + +The “Corresponding Application Code” for a Combined Work +means the object code and/or source code for the +Application, including any data and utility programs needed +for reproducing the Combined Work from the Application, but +excluding the System Libraries of the Combined Work. + +1. Exception to Section 3 of the GNU GPL. + +You may convey a covered work under sections 3 and 4 of this +License without being bound by section 3 of the GNU GPL. + +2. Conveying Modified Versions. + +If you modify a copy of the Library, and, in your +modifications, a facility refers to a function or data to be +supplied by an Application that uses the facility (other +than as an argument passed when the facility is invoked), +then you may convey a copy of the modified version: + + a) under this License, provided that you make a good + faith effort to ensure that, in the event an + Application does not supply the function or data, the + facility still operates, and performs whatever part of + its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional + permissions of this License applicable to that copy. + +3. Object Code Incorporating Material from Library Header Files. + +The object code form of an Application may incorporate +material from a header file that is part of the Library. You +may convey such object code under terms of your choice, +provided that, if the incorporated material is not limited +to numerical parameters, data structure layouts and +accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the +following: + + a) Give prominent notice with each copy of the object + code that the Library is used in it and that the + Library and its use are covered by this License. + + b) Accompany the object code with a copy of the GNU + GPL and this license document. + +4. Combined Works. + +You may convey a Combined Work under terms of your choice +that, taken together, effectively do not restrict +modification of the portions of the Library contained in the +Combined Work and reverse engineering for debugging such +modifications, if you also do each of the following: + + a) Give prominent notice with each copy of the + Combined Work that the Library is used in it and that + the Library and its use are covered by this License. + + b) Accompany the Combined Work with a copy of the GNU + GPL and this license document. + + c) For a Combined Work that displays copyright notices + during execution, include the copyright notice for the + Library among these notices, as well as a reference + directing the user to the copies of the GNU GPL and + this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under + the terms of this License, and the Corresponding + Application Code in a form suitable for, and under + terms that permit, the user to recombine or relink + the Application with a modified version of the + Linked Version to produce a modified Combined + Work, in the manner specified by section 6 of the + GNU GPL for conveying Corresponding Source. + + 1) Use a suitable shared library mechanism for + linking with the Library. A suitable mechanism is + one that (a) uses at run time a copy of the + Library already present on the user's computer + system, and (b) will operate properly with a + modified version of the Library that is + interface-compatible with the Linked Version. + + e) Provide Installation Information, but only if you + would otherwise be required to provide such + information under section 6 of the GNU GPL, and only + to the extent that such information is necessary to + install and execute a modified version of the Combined + Work produced by recombining or relinking the + Application with a modified version of the Linked + Version. (If you use option 4d0, the Installation + Information must accompany the Minimal Corresponding + Source and Corresponding Application Code. If you use + option 4d1, you must provide the Installation + Information in the manner specified by section 6 of + the GNU GPL for conveying Corresponding Source.) + +5. Combined Libraries. + +You may place library facilities that are a work based on +the Library side by side in a single library together with +other library facilities that are not Applications and are +not covered by this License, and convey such a combined +library under terms of your choice, if you do both of the +following: + + a) Accompany the combined library with a copy of the + same work based on the Library, uncombined with any + other library facilities, conveyed under the terms of + this License. + + b) Give prominent notice with the combined library + that part of it is a work based on the Library, and + explaining where to find the accompanying uncombined + form of the same work. + +6. Revised Versions of the GNU Lesser General Public License. + +The Free Software Foundation may publish revised and/or new +versions of the GNU Lesser 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 Library as you received it specifies that a certain +numbered version of the GNU Lesser General Public License +“or any later version” applies to it, you have the option of +following the terms and conditions either of that published +version or of any later version published by the Free +Software Foundation. If the Library as you received it does +not specify a version number of the GNU Lesser General +Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software +Foundation. + +If the Library as you received it specifies that a proxy can +decide whether future versions of the GNU Lesser General +Public License shall apply, that proxy's public statement of +acceptance of any version is permanent authorization for you +to choose that version for the Library. + +------------------------ + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright © 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright © + + This program is free software: you can redistribute it + and/or modify it under the terms of version 3 of the GNU + General Public License as published by the Free Software + Foundation. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright © + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Foreign/NOTMUCH_H.hsc b/Foreign/NOTMUCH_H.hsc new file mode 100644 --- /dev/null +++ b/Foreign/NOTMUCH_H.hsc @@ -0,0 +1,266 @@ +-- notmuch-haskell: notmuch MUA Haskell binding +-- low-level interface +-- Copyright (C) 2010 Bart Massey +-- Licensed LGPL v3: please see the file COPYING in this +-- source distribution for licensing information. + +-- Originally produced automatically from notmuch.h +-- by hsffig +-- gcc -E -dD notmuch.h | hsffig >NOTMUCH_H.hsc +-- Later hand-edited + +#if __GLASGOW_HASKELL__ && __GLASGOW_HASKELL__ < 409 +#include +#endif +#include + +#include +#include +#include +#include +#include + +#def void _dummy_force_NOTMUCH_H_hsc_c (void) { } + +{-# OPTIONS -fglasgow-exts -XForeignFunctionInterface #-} + +#include "notmuch.h" + +module Foreign.NOTMUCH_H( + module Foreign.NOTMUCH_H, + module Foreign, + module Foreign.C.String, + module Foreign.C.Types) where + +import Foreign +import Foreign.Ptr +import Foreign.C.Types +import Foreign.C.String + +newtype S__notmuch_database = S__notmuch_database () +newtype S__notmuch_directory = S__notmuch_directory () +newtype S__notmuch_filenames = S__notmuch_filenames () +newtype S__notmuch_message = S__notmuch_message () +newtype S__notmuch_messages = S__notmuch_messages () +newtype S__notmuch_query = S__notmuch_query () +newtype S__notmuch_tags = S__notmuch_tags () +newtype S__notmuch_thread = S__notmuch_thread () +newtype S__notmuch_threads = S__notmuch_threads () + +foreign import ccall "static notmuch.h notmuch_status_to_string" + f_notmuch_status_to_string :: CInt -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_database_create" + f_notmuch_database_create :: Ptr (CChar) -> IO (Ptr (S__notmuch_database)) + +foreign import ccall "static notmuch.h notmuch_database_open" + f_notmuch_database_open :: Ptr (CChar) -> CInt -> IO (Ptr (S__notmuch_database)) + +foreign import ccall "static notmuch.h notmuch_database_close" + f_notmuch_database_close :: Ptr (S__notmuch_database) -> IO (()) + +foreign import ccall "static notmuch.h notmuch_database_get_path" + f_notmuch_database_get_path :: Ptr (S__notmuch_database) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_database_get_version" + f_notmuch_database_get_version :: Ptr (S__notmuch_database) -> IO (CUInt) + +foreign import ccall "static notmuch.h notmuch_database_needs_upgrade" + f_notmuch_database_needs_upgrade :: Ptr (S__notmuch_database) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_database_upgrade" + f_notmuch_database_upgrade :: Ptr (S__notmuch_database) -> FunPtr (Ptr (CChar) -> CDouble -> IO (())) -> Ptr (CChar) -> IO (CInt) +foreign import ccall "wrapper" + w_notmuch_database_upgrade_1 :: (Ptr (CChar) -> CDouble -> IO (())) -> IO (FunPtr (Ptr (CChar) -> CDouble -> IO (()))) + +foreign import ccall "static notmuch.h notmuch_database_get_directory" + f_notmuch_database_get_directory :: Ptr (S__notmuch_database) -> Ptr (CChar) -> IO (Ptr (S__notmuch_directory)) + +foreign import ccall "static notmuch.h notmuch_database_add_message" + f_notmuch_database_add_message :: Ptr (S__notmuch_database) -> Ptr (CChar) -> Ptr (Ptr (S__notmuch_message)) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_database_remove_message" + f_notmuch_database_remove_message :: Ptr (S__notmuch_database) -> Ptr (CChar) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_database_find_message" + f_notmuch_database_find_message :: Ptr (S__notmuch_database) -> Ptr (CChar) -> IO (Ptr (S__notmuch_message)) + +foreign import ccall "static notmuch.h notmuch_database_get_all_tags" + f_notmuch_database_get_all_tags :: Ptr (S__notmuch_database) -> IO (Ptr (S__notmuch_tags)) + +foreign import ccall "static notmuch.h notmuch_query_create" + f_notmuch_query_create :: Ptr (S__notmuch_database) -> Ptr (CChar) -> IO (Ptr (S__notmuch_query)) + +foreign import ccall "static notmuch.h notmuch_query_set_sort" + f_notmuch_query_set_sort :: Ptr (S__notmuch_query) -> CInt -> IO (()) + +foreign import ccall "static notmuch.h notmuch_query_search_threads" + f_notmuch_query_search_threads :: Ptr (S__notmuch_query) -> IO (Ptr (S__notmuch_threads)) + +foreign import ccall "static notmuch.h notmuch_query_search_messages" + f_notmuch_query_search_messages :: Ptr (S__notmuch_query) -> IO (Ptr (S__notmuch_messages)) + +foreign import ccall "static notmuch.h notmuch_query_destroy" + f_notmuch_query_destroy :: Ptr (S__notmuch_query) -> IO (()) + +foreign import ccall "static notmuch.h ¬much_query_destroy" + pf_notmuch_query_destroy :: FunPtr (Ptr (S__notmuch_query) -> IO (())) + +foreign import ccall "static notmuch.h notmuch_threads_valid" + f_notmuch_threads_valid :: Ptr (S__notmuch_threads) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_threads_get" + f_notmuch_threads_get :: Ptr (S__notmuch_threads) -> IO (Ptr (S__notmuch_thread)) + +foreign import ccall "static notmuch.h notmuch_threads_move_to_next" + f_notmuch_threads_move_to_next :: Ptr (S__notmuch_threads) -> IO (()) + +foreign import ccall "static notmuch.h notmuch_threads_destroy" + f_notmuch_threads_destroy :: Ptr (S__notmuch_threads) -> IO (()) + +foreign import ccall "static notmuch.h & notmuch_threads_destroy" + pf_notmuch_threads_destroy :: FunPtr (Ptr (S__notmuch_threads) -> IO (())) + +foreign import ccall "static notmuch.h notmuch_query_count_messages" + f_notmuch_query_count_messages :: Ptr (S__notmuch_query) -> IO (CUInt) + +foreign import ccall "static notmuch.h notmuch_thread_get_thread_id" + f_notmuch_thread_get_thread_id :: Ptr (S__notmuch_thread) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_thread_get_total_messages" + f_notmuch_thread_get_total_messages :: Ptr (S__notmuch_thread) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_thread_get_toplevel_messages" + f_notmuch_thread_get_toplevel_messages :: Ptr (S__notmuch_thread) -> IO (Ptr (S__notmuch_messages)) + +foreign import ccall "static notmuch.h notmuch_thread_get_matched_messages" + f_notmuch_thread_get_matched_messages :: Ptr (S__notmuch_thread) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_thread_get_authors" + f_notmuch_thread_get_authors :: Ptr (S__notmuch_thread) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_thread_get_subject" + f_notmuch_thread_get_subject :: Ptr (S__notmuch_thread) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_thread_get_oldest_date" + f_notmuch_thread_get_oldest_date :: Ptr (S__notmuch_thread) -> IO (CTime) + +foreign import ccall "static notmuch.h notmuch_thread_get_newest_date" + f_notmuch_thread_get_newest_date :: Ptr (S__notmuch_thread) -> IO (CTime) + +foreign import ccall "static notmuch.h notmuch_thread_get_tags" + f_notmuch_thread_get_tags :: Ptr (S__notmuch_thread) -> IO (Ptr (S__notmuch_tags)) + +foreign import ccall "static notmuch.h notmuch_thread_destroy" + f_notmuch_thread_destroy :: Ptr (S__notmuch_thread) -> IO (()) + +foreign import ccall "static notmuch.h ¬much_thread_destroy" + pf_notmuch_thread_destroy :: FunPtr(Ptr (S__notmuch_thread) -> IO (())) + +foreign import ccall "static notmuch.h notmuch_messages_valid" + f_notmuch_messages_valid :: Ptr (S__notmuch_messages) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_messages_get" + f_notmuch_messages_get :: Ptr (S__notmuch_messages) -> IO (Ptr (S__notmuch_message)) + +foreign import ccall "static notmuch.h notmuch_messages_move_to_next" + f_notmuch_messages_move_to_next :: Ptr (S__notmuch_messages) -> IO (()) + +foreign import ccall "static notmuch.h notmuch_messages_destroy" + f_notmuch_messages_destroy :: Ptr (S__notmuch_messages) -> IO (()) + +foreign import ccall "static notmuch.h & notmuch_messages_destroy" + pf_notmuch_messages_destroy :: FunPtr(Ptr (S__notmuch_messages) -> IO (())) + +foreign import ccall "static notmuch.h notmuch_messages_collect_tags" + f_notmuch_messages_collect_tags :: Ptr (S__notmuch_messages) -> IO (Ptr (S__notmuch_tags)) + +foreign import ccall "static notmuch.h notmuch_message_get_message_id" + f_notmuch_message_get_message_id :: Ptr (S__notmuch_message) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_message_get_thread_id" + f_notmuch_message_get_thread_id :: Ptr (S__notmuch_message) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_message_get_replies" + f_notmuch_message_get_replies :: Ptr (S__notmuch_message) -> IO (Ptr (S__notmuch_messages)) + +foreign import ccall "static notmuch.h notmuch_message_get_filename" + f_notmuch_message_get_filename :: Ptr (S__notmuch_message) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_message_get_flag" + f_notmuch_message_get_flag :: Ptr (S__notmuch_message) -> CInt -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_message_set_flag" + f_notmuch_message_set_flag :: Ptr (S__notmuch_message) -> CInt -> CInt -> IO (()) + +foreign import ccall "static notmuch.h notmuch_message_get_date" + f_notmuch_message_get_date :: Ptr (S__notmuch_message) -> IO (CTime) + +foreign import ccall "static notmuch.h notmuch_message_get_header" + f_notmuch_message_get_header :: Ptr (S__notmuch_message) -> Ptr (CChar) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_message_get_tags" + f_notmuch_message_get_tags :: Ptr (S__notmuch_message) -> IO (Ptr (S__notmuch_tags)) + +foreign import ccall "static notmuch.h notmuch_message_add_tag" + f_notmuch_message_add_tag :: Ptr (S__notmuch_message) -> Ptr (CChar) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_message_remove_tag" + f_notmuch_message_remove_tag :: Ptr (S__notmuch_message) -> Ptr (CChar) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_message_remove_all_tags" + f_notmuch_message_remove_all_tags :: Ptr (S__notmuch_message) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_message_freeze" + f_notmuch_message_freeze :: Ptr (S__notmuch_message) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_message_thaw" + f_notmuch_message_thaw :: Ptr (S__notmuch_message) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_message_destroy" + f_notmuch_message_destroy :: Ptr (S__notmuch_message) -> IO (()) + +foreign import ccall "static notmuch.h ¬much_message_destroy" + pf_notmuch_message_destroy :: FunPtr (Ptr (S__notmuch_message) -> IO (())) + +foreign import ccall "static notmuch.h notmuch_tags_valid" + f_notmuch_tags_valid :: Ptr (S__notmuch_tags) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_tags_get" + f_notmuch_tags_get :: Ptr (S__notmuch_tags) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_tags_move_to_next" + f_notmuch_tags_move_to_next :: Ptr (S__notmuch_tags) -> IO (()) + +foreign import ccall "static notmuch.h notmuch_tags_destroy" + f_notmuch_tags_destroy :: Ptr (S__notmuch_tags) -> IO (()) + +foreign import ccall "static notmuch.h notmuch_directory_set_mtime" + f_notmuch_directory_set_mtime :: Ptr (S__notmuch_directory) -> CTime -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_directory_get_mtime" + f_notmuch_directory_get_mtime :: Ptr (S__notmuch_directory) -> IO (CTime) + +foreign import ccall "static notmuch.h notmuch_directory_get_child_files" + f_notmuch_directory_get_child_files :: Ptr (S__notmuch_directory) -> IO (Ptr (S__notmuch_filenames)) + +foreign import ccall "static notmuch.h notmuch_directory_get_child_directories" + f_notmuch_directory_get_child_directories :: Ptr (S__notmuch_directory) -> IO (Ptr (S__notmuch_filenames)) + +foreign import ccall "static notmuch.h notmuch_directory_destroy" + f_notmuch_directory_destroy :: Ptr (S__notmuch_directory) -> IO (()) + +foreign import ccall "static notmuch.h & notmuch_directory_destroy" + pf_notmuch_directory_destroy :: FunPtr (Ptr (S__notmuch_directory) -> IO (())) + +foreign import ccall "static notmuch.h notmuch_filenames_valid" + f_notmuch_filenames_valid :: Ptr (S__notmuch_filenames) -> IO (CInt) + +foreign import ccall "static notmuch.h notmuch_filenames_get" + f_notmuch_filenames_get :: Ptr (S__notmuch_filenames) -> IO (Ptr (CChar)) + +foreign import ccall "static notmuch.h notmuch_filenames_move_to_next" + f_notmuch_filenames_move_to_next :: Ptr (S__notmuch_filenames) -> IO (()) + +foreign import ccall "static notmuch.h notmuch_filenames_destroy" + f_notmuch_filenames_destroy :: Ptr (S__notmuch_filenames) -> IO (()) diff --git a/Foreign/Notmuch.hs b/Foreign/Notmuch.hs new file mode 100644 --- /dev/null +++ b/Foreign/Notmuch.hs @@ -0,0 +1,488 @@ +-- notmuch-haskell: notmuch MUA Haskell binding +-- high-level interface +-- Copyright © 2010 Bart Massey +-- Licensed LGPL v3: please see the file COPYING in this +-- source distribution for licensing information. + +-- | This is a very preliminary higher-level Haskell binding +-- for the Notmuch (notmuchmail.org) email indexing library. +-- There is no documentation here; see the Notmuch +-- documentation for hints on how to use this. + +module Foreign.Notmuch ( + Database, databaseCreate, DatabaseMode(..), + databaseOpen, databaseClose, databaseGetPath, + databaseGetVersion, databaseNeedsUpgrade, + UpgradeCallback, databaseUpgrade, + Directory, databaseGetDirectory, + Message, Messages, databaseAddMessage, + databaseRemoveMessage, databaseFindMessage, + Tags, databaseGetAllTags, + Query, queryCreate, SortOrder(..), querySetSortOrder, + Thread, Threads, queryThreads, + queryMessages, queryCountMessages, + getThreadID, threadCountMessages, threadCountMatchedMessages, + threadGetToplevelMessages, threadGetAuthors, + threadGetSubject, threadGetOldestDate, threadGetNewestDate, + threadGetTags, + messagesCollectTags, messageGetMessageID, messageGetThreadID, + messageGetReplies, messageGetFilePath, + MessageFlag(..), messageGetFlag, messageSetFlag, + messageGetDate, messageGetHeader, + messageGetTags, messageAddTag, + messageRemoveTag, messageRemoveAllTags, + messageFreeze, messageThaw, + directorySetMtime, directoryGetMtime, + directoryGetChildFiles, directoryGetChildDirectories +) where + +import Foreign.NOTMUCH_H + +import Control.Monad +import Data.List +import Data.Time +import Data.Time.Clock.POSIX +import System.FilePath + +newtype Database = Database (Ptr S__notmuch_database) + +databaseCreate :: FilePath -> IO Database +databaseCreate name = do + db <- withCString name f_notmuch_database_create + when (db == nullPtr) $ + fail "database create failed" + return $ Database db + +-- XXX Deriving Enum will only work if these fields are in +-- the same order as in notmuch.h and there are no gaps +-- there. +data DatabaseMode = + DatabaseModeReadOnly | + DatabaseModeReadWrite + deriving Enum + +databaseOpen :: FilePath -> DatabaseMode -> IO Database +databaseOpen name databaseMode = do + db <- withCString name $ + flip f_notmuch_database_open $ + fromIntegral $ fromEnum databaseMode + when (db == nullPtr) $ + fail "database open failed" + return $ Database db + +databaseClose :: Database -> IO () +databaseClose (Database db) = f_notmuch_database_close db + +databaseGetPath :: Database -> IO FilePath +databaseGetPath (Database db) = + resultString $ f_notmuch_database_get_path db + +databaseGetVersion :: Database -> IO Int +databaseGetVersion (Database db) = do + v <- f_notmuch_database_get_version db + return $ fromIntegral v + +resultBool :: IO CInt -> IO Bool +resultBool = fmap (/= 0) + +resultString :: IO (Ptr CChar) -> IO String +resultString = (>>= peekCString) + +resultInt :: IO CInt -> IO Int +resultInt = fmap fromIntegral + +resultWord :: IO CUInt -> IO Word +resultWord = fmap fromIntegral + +databaseNeedsUpgrade :: Database -> IO Bool +databaseNeedsUpgrade (Database db) = + resultBool $ f_notmuch_database_needs_upgrade db + +statusCheck :: CInt -> IO () +statusCheck 0 = return () +statusCheck s = do + msg <- resultString $ f_notmuch_status_to_string s + fail msg + +type UpgradeCallback = String -> Double -> IO () + +databaseUpgrade :: Database -> Maybe UpgradeCallback -> IO () +databaseUpgrade (Database db) (Just callback) = do + let ccb msg progress = do + cmsg <- peekCString msg + let cprogress = realToFrac progress + callback cmsg cprogress + cb <- w_notmuch_database_upgrade_1 ccb + s <- f_notmuch_database_upgrade db cb nullPtr + statusCheck s +databaseUpgrade (Database db) Nothing = do + s <- f_notmuch_database_upgrade db nullFunPtr nullPtr + statusCheck s + +newtype Directory = Directory (ForeignPtr S__notmuch_directory) + +databaseGetDirectory :: Database -> FilePath -> IO Directory +databaseGetDirectory (Database db) path = withCString path $ (\p -> do + dir <- f_notmuch_database_get_directory db p + dirp <- newForeignPtr pf_notmuch_directory_destroy dir + return $ Directory dirp) + +type MessagesPtr = ForeignPtr S__notmuch_messages + +type MessagePtr = ForeignPtr S__notmuch_message + +data MessagesRef = QueryMessages { qmpp :: Query, msp :: MessagesPtr } + | ThreadMessages { tmpp :: Thread, msp :: MessagesPtr } + | MessageMessages { mmspp :: Message, msp :: MessagesPtr } + +data Message = MessagesMessage { msmpp :: MessagesRef, mp :: MessagePtr } + | Message { mp :: MessagePtr } + +type Messages = [Message] + +-- XXX We provide no way to request a null message pointer, +-- so the message is always returned. The finalizer will +-- then eventually kill it if it is not needed. + +-- XXX This function will fail on dup adds, rather than +-- succeed. I have no idea what it should do, and this +-- was easiest. +databaseAddMessage :: Database -> FilePath -> IO Message +databaseAddMessage (Database db) filename = alloca msgFun where + msgFun msgPtr = do + let addMessage fn = + f_notmuch_database_add_message db fn msgPtr + s <- withCString filename addMessage + statusCheck s + cmsg <- peek msgPtr + m <- newForeignPtr pf_notmuch_message_destroy cmsg + return $ Message m + +-- XXX This function will fail on dup remove, rather than +-- succeed. I have no idea what it should do, and this +-- was easiest. +databaseRemoveMessage :: Database -> FilePath -> IO () +databaseRemoveMessage (Database db) filename = do + let removeMessage fn = f_notmuch_database_remove_message db fn + s <- withCString filename removeMessage + statusCheck s + +-- XXX This might want to return a Maybe Message instead +-- of failing if the message is not found. I don't quite +-- understand the use case yet. +databaseFindMessage :: Database -> String -> IO Message +databaseFindMessage (Database db) msgid = do + let findMessage mid = + f_notmuch_database_find_message db mid + cmsg <- withCString msgid findMessage + when (cmsg == nullPtr) $ + fail "database find message failed" + m <- newForeignPtr pf_notmuch_message_destroy cmsg + return $ Message m + +iterM :: Monad m => a -> (a -> m Bool) -> (a -> m b) -> m [b] +iterM coln test get = go [] coln test get + where go acc coln test get = do + cont <- test coln + case cont of + True -> do + elem <- get coln + go (elem : acc) coln test get + False -> return acc + +iterUnpack :: Ptr a -> (Ptr a -> IO CInt) -> + (Ptr a -> IO b) -> (Ptr a -> IO ()) -> + IO [b] +iterUnpack coln f_valid f_get f_move_to_next = + iterM coln has_more get + where + has_more = resultBool . f_valid + get coln' = do + e <- f_get coln' + f_move_to_next coln' + return e + +type TagsPtr = Ptr S__notmuch_tags + +type Tags = [String] + +unpackTags :: TagsPtr -> IO Tags +unpackTags tags = do + result <- iterUnpack tags + f_notmuch_tags_valid + (resultString . f_notmuch_tags_get) + f_notmuch_tags_move_to_next + f_notmuch_tags_destroy tags + return result + + +databaseGetAllTags :: Database -> IO Tags +databaseGetAllTags (Database db) = do + tags <- f_notmuch_database_get_all_tags db + when (tags == nullPtr) $ + fail "database get all tags failed" + unpackTags tags + +newtype Query = Query (ForeignPtr S__notmuch_query) + +queryCreate :: Database -> String -> IO Query +queryCreate (Database db) queryString = do + query <- withCString queryString $ f_notmuch_query_create db + when (query == nullPtr) $ + fail "query create failed" + queryp <- newForeignPtr pf_notmuch_query_destroy query + return $ Query queryp + +-- XXX Deriving Enum will only work if these fields are in +-- the same order as in notmuch.h and there are no gaps +-- there. +data SortOrder = + SortOldestFirst | + SortNewestFirst | + SortMessageID + deriving Enum + +querySetSortOrder :: Query -> SortOrder -> IO () +querySetSortOrder (Query query) sortOrder = + let setSort query' = + f_notmuch_query_set_sort query' $ + fromIntegral $ fromEnum sortOrder in + withForeignPtr query setSort + +type ThreadsPtr = ForeignPtr S__notmuch_threads + +type ThreadPtr = ForeignPtr S__notmuch_thread + +data ThreadsRef = QueryThreads { qtspp :: Query, + tsp :: ThreadsPtr } + +data Thread = QueryThread { qtpp :: Query, + tp :: ThreadPtr } + | ThreadsThread { ttpp :: ThreadsRef, + tp :: ThreadPtr } + +type Threads = [Thread] + +queryThreads :: Query -> IO Threads +queryThreads (Query query) = withForeignPtr query $ \q -> do + threads <- f_notmuch_query_search_threads q + when (threads == nullPtr) $ + fail "query threads failed" + tsp <- newForeignPtr pf_notmuch_threads_destroy threads + let qts = QueryThreads (Query query) tsp + iterUnpack threads + f_notmuch_threads_valid + (\ts -> do + t <- f_notmuch_threads_get ts + tp <- newForeignPtr pf_notmuch_thread_destroy t + let tst = ThreadsThread qts tp + return tst) + f_notmuch_threads_move_to_next + +unpackMessages :: MessagesRef -> IO Messages +unpackMessages messages = withForeignPtr (msp messages) $ \ms -> do + iterUnpack ms + f_notmuch_messages_valid + (\t -> do + m <- f_notmuch_messages_get t + mp <- newForeignPtr pf_notmuch_message_destroy m + let msm = MessagesMessage messages mp + return msm) + f_notmuch_messages_move_to_next + +queryMessages :: Query -> IO Messages +queryMessages (Query query) = withForeignPtr query $ \q -> do + messages <- f_notmuch_query_search_messages q + when (messages == nullPtr) $ + fail "query messages failed" + ms <- newForeignPtr pf_notmuch_messages_destroy messages + let qms = QueryMessages (Query query) ms + unpackMessages qms + +queryCountMessages :: Query -> IO Word +queryCountMessages (Query query) = withForeignPtr query $ + resultWord . f_notmuch_query_count_messages + +getThreadID :: Thread -> IO String +getThreadID thread = withForeignPtr (tp thread) $ + resultString . f_notmuch_thread_get_thread_id + +threadCountMessages :: Thread -> IO Int +threadCountMessages thread = withForeignPtr (tp thread) $ + resultInt . f_notmuch_thread_get_total_messages + +threadCountMatchedMessages :: Thread -> IO Int +threadCountMatchedMessages thread = withForeignPtr (tp thread) $ + resultInt . f_notmuch_thread_get_matched_messages + +threadGetToplevelMessages :: Thread -> IO Messages +threadGetToplevelMessages thread = withForeignPtr (tp thread) $ \t -> do + messages <- f_notmuch_thread_get_toplevel_messages t + when (messages == nullPtr) $ + fail "thread get top-level messages failed" + ms <- newForeignPtr pf_notmuch_messages_destroy messages + let tms = ThreadMessages thread ms + unpackMessages tms + +-- XXX This pretty clearly wants to return a list of authors +-- rather than a single string containing a comma-separated +-- list of authors, but I was too lazy to write the Haskell +-- yet. +threadGetAuthors :: Thread -> IO String +threadGetAuthors thread = withForeignPtr (tp thread) $ \t -> do + authors <- f_notmuch_thread_get_authors t + when (authors == nullPtr) $ + fail "thread get authors failed" + peekCString authors + +threadGetSubject :: Thread -> IO String +threadGetSubject thread = withForeignPtr (tp thread) $ \t -> do + subject <- f_notmuch_thread_get_subject t + when (subject == nullPtr) $ + fail "thread get subject failed" + peekCString subject + +threadGetOldestDate :: Thread -> IO UTCTime +threadGetOldestDate thread = withForeignPtr (tp thread) $ \t -> do + date <- f_notmuch_thread_get_oldest_date t + return $ posixSecondsToUTCTime $ realToFrac date + +threadGetNewestDate :: Thread -> IO UTCTime +threadGetNewestDate thread = withForeignPtr (tp thread) $ \t -> do + date <- f_notmuch_thread_get_newest_date t + return $ posixSecondsToUTCTime $ realToFrac date + +threadGetTags :: Thread -> IO Tags +threadGetTags thread = withForeignPtr (tp thread) $ \t -> do + tags <- f_notmuch_thread_get_tags t + when (tags == nullPtr) $ + fail "thread get tags failed" + unpackTags tags + +-- XXX Because of the peculiar way this is implemented and +-- interfaced in notmuch, we provide a Haskell re-implementation +-- instead of trying to use the underlying native function. +messagesCollectTags :: Messages -> IO Tags +messagesCollectTags messages = do + tagses <- mapM messageGetTags messages + return $ nub $ concat tagses + +messageGetMessageID :: Message -> IO String +messageGetMessageID message = withForeignPtr (mp message) $ \m -> do + msgid <- f_notmuch_message_get_message_id m + when (msgid == nullPtr) $ + fail "message get message ID failed" + peekCString msgid + + +messageGetThreadID :: Message -> IO String +messageGetThreadID message = withForeignPtr (mp message) $ \m -> do + tid <- f_notmuch_message_get_thread_id m + when (tid == nullPtr) $ + fail "message get thread ID failed" + peekCString tid + +messageGetReplies :: Message -> IO Messages +messageGetReplies message = withForeignPtr (mp message) $ \m -> do + messages <- f_notmuch_message_get_replies m + when (messages == nullPtr) $ + fail "message get replies failed" + ms <- newForeignPtr pf_notmuch_messages_destroy messages + let mms = MessageMessages message ms + unpackMessages mms + +messageGetFilePath :: Message -> IO FilePath +messageGetFilePath message = withForeignPtr (mp message) $ \m -> do + path <- f_notmuch_message_get_filename m + when (path == nullPtr) $ + fail "message get file path failed" + peekCString path + +data MessageFlag = + MessageFlagMatch + deriving Enum + +messageGetFlag :: Message -> MessageFlag -> IO Bool +messageGetFlag message flag = + let cflag = fromIntegral $ fromEnum flag in + withForeignPtr (mp message) $ + resultBool . (\m -> f_notmuch_message_get_flag m cflag) + +messageSetFlag :: Message -> MessageFlag -> Bool -> IO () +messageSetFlag message flag sense = + let cflag = fromIntegral $ fromEnum flag + csense = case sense of True -> 1; False -> 0 in + withForeignPtr (mp message) $ (\m -> + f_notmuch_message_set_flag m cflag csense) + +messageGetDate :: Message -> IO UTCTime +messageGetDate message = withForeignPtr (mp message) $ \m -> do + date <- f_notmuch_message_get_date m + return $ posixSecondsToUTCTime $ realToFrac date + +messageGetHeader :: Message -> String -> IO String +messageGetHeader message header = withForeignPtr (mp message) $ \m -> + withCString header (resultString . f_notmuch_message_get_header m) + +messageGetTags :: Message -> IO Tags +messageGetTags message = withForeignPtr (mp message) $ \m -> do + tags <- f_notmuch_message_get_tags m + when (tags == nullPtr) $ + fail "message get tags failed" + unpackTags tags + +messageAddTag :: Message -> String -> IO () +messageAddTag message tag = withForeignPtr (mp message) $ \m -> do + s <- withCString tag $ f_notmuch_message_add_tag m + statusCheck s + +messageRemoveTag :: Message -> String -> IO () +messageRemoveTag message tag = withForeignPtr (mp message) $ \m -> do + s <- withCString tag $ f_notmuch_message_remove_tag m + statusCheck s + +messageRemoveAllTags :: Message -> IO () +messageRemoveAllTags message = withForeignPtr (mp message) $ \m -> do + s <- f_notmuch_message_remove_all_tags m + statusCheck s + +messageFreeze :: Message -> IO () +messageFreeze message = withForeignPtr (mp message) $ \m -> do + s <- f_notmuch_message_freeze m + statusCheck s + +messageThaw :: Message -> IO () +messageThaw message = withForeignPtr (mp message) $ \m -> do + s <- f_notmuch_message_thaw m + statusCheck s + +directorySetMtime :: Directory -> UTCTime -> IO () +directorySetMtime (Directory dir) time = withForeignPtr dir $ \d -> do + let t = fromIntegral $ floor $ realToFrac $ utcTimeToPOSIXSeconds time + when (t <= 0) $ + fail "directory set mtime with invalid mtime" + s <- f_notmuch_directory_set_mtime d t + statusCheck s + +directoryGetMtime :: Directory -> IO UTCTime +directoryGetMtime (Directory dir) = withForeignPtr dir $ \d -> do + t <- f_notmuch_directory_get_mtime d + when (t <= 0) $ + fail "directory get mtime failed" + return $ posixSecondsToUTCTime $ realToFrac t + +directoryGetChildFiles :: Directory -> IO [FilePath] +directoryGetChildFiles (Directory dir) = withForeignPtr dir $ \d -> do + filenames <- f_notmuch_directory_get_child_files d + iterUnpack filenames + f_notmuch_filenames_valid + (resultString . f_notmuch_filenames_get) + f_notmuch_filenames_move_to_next + +directoryGetChildDirectories :: Directory -> IO [FilePath] +directoryGetChildDirectories (Directory dir) = withForeignPtr dir $ \d -> do + filenames <- f_notmuch_directory_get_child_directories d + iterUnpack filenames + f_notmuch_filenames_valid + (resultString . f_notmuch_filenames_get) + f_notmuch_filenames_move_to_next diff --git a/NotmuchTest.hs b/NotmuchTest.hs new file mode 100644 --- /dev/null +++ b/NotmuchTest.hs @@ -0,0 +1,64 @@ +-- notmuch-haskell: notmuch MUA Haskell binding +-- test / demo program +-- Copyright © 2010 Bart Massey +-- Licensed LGPL v3: please see the file COPYING in this +-- source distribution for licensing information. + +-- This program has two modes. When invoked with no +-- arguments, it creates a new notmuch database in /tmp. +-- When given a database argument, it does a search for +-- "subject:notmuch" in the notmuch database. It will +-- upgrade the database if necessary. + +import Control.Monad +import Data.Time +import IO +import System.Environment +import System.Locale + +import Foreign.Notmuch + +dateString :: FormatTime t => t -> String +dateString = formatTime defaultTimeLocale "%c" + +main = do + argv <- getArgs + db <- if (length argv == 0) + then + (do + db <- databaseCreate "/tmp" + databaseClose db + databaseOpen "/tmp" DatabaseModeReadOnly) + else + databaseOpen (head argv) DatabaseModeReadOnly + dbPath <- databaseGetPath db + putStrLn $ "database is at " ++ dbPath + version <- databaseGetVersion db + putStrLn $ "version is " ++ show version + upgrade <- databaseNeedsUpgrade db + when upgrade $ do + let cb msg progress = putStrLn $ msg ++ show progress + putStrLn "Upgrading database" + databaseUpgrade db (Just cb) + query <- queryCreate db "subject:notmuch" + nquery <- queryCountMessages query + putStrLn $ "subject:notmuch returns " ++ show nquery ++ " results..." + threads <- queryThreads query + nthreadss <- mapM threadCountMessages threads + putStr $ show (sum nthreadss) ++ "/" ++ show (length threads) ++ ": " + print nthreadss + let thread = last threads + subject <- threadGetSubject thread + putStrLn subject + messages <- threadGetToplevelMessages thread + let message = head messages + subject' <- messageGetHeader message "Subject" + putStrLn subject' + date' <- messageGetHeader message "Date" + putStrLn date' + date <- messageGetDate message + putStrLn $ dateString date + localdate <- utcToLocalZonedTime date + putStrLn $ dateString localdate + databaseClose db + return () diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,3 @@ +#!/usr/bin/env runhaskell +import Distribution.Simple +main = defaultMain diff --git a/notmuch-haskell.cabal b/notmuch-haskell.cabal new file mode 100644 --- /dev/null +++ b/notmuch-haskell.cabal @@ -0,0 +1,28 @@ +Name: notmuch-haskell +Version: 0.2.2 +Cabal-Version: >= 1.6 +Author: Bart Massey +Maintainer: Bart Massey +Copyright: © 2010 Bart Massey +License: LGPL +License-file: COPYING +Synopsis: Binding for notmuch MUA library +Category: Email, Foreign +Build-Type: Simple +Stability: Experimental +Bug-Reports: mailto:bart@cs.pdx.edu +Description: + This is a very preliminary higher-level Haskell binding + for the Notmuch (notmuchmail.org) email indexing library. + +Library + Build-Depends: base, containers, time, filepath + Exposed-Modules: Foreign.Notmuch + Other-Modules: Foreign.NOTMUCH_H + Extra-Libraries: notmuch gmime-2.4 z nsl gobject-2.0 glib-2.0 talloc xapian + +Executable notmuch-test + main-is: NotmuchTest.hs + other-modules: Foreign.Notmuch Foreign.NOTMUCH_H + build-depends: base >= 4 && < 5, haskell98, old-locale, parseargs + Extra-Libraries: notmuch