diff --git a/LICENSE b/LICENSE
new file mode 100644
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,621 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
diff --git a/README.md b/README.md
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,4 @@
+h-booru
+=======
+
+Haskell library for retrieving data from various booru image sites
diff --git a/Setup.hs b/Setup.hs
new file mode 100644
--- /dev/null
+++ b/Setup.hs
@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
diff --git a/h-booru.cabal b/h-booru.cabal
new file mode 100644
--- /dev/null
+++ b/h-booru.cabal
@@ -0,0 +1,34 @@
+name: h-booru
+version: 0.1.0.0
+synopsis: Haskell library for retrieving data from various booru image sites
+description: Haskell library for retrieving data from various booru image sites.
+ By providing a common interface for such sites and some parsers for
+ few existing sites, the hope is to alleviate the effort of writing
+ applications which interface with them.
+homepage: https://github.com/Fuuzetsu/h-booru
+license: GPL-3
+license-file: LICENSE
+author: Mateusz Kowalczyk
+maintainer: fuuzetsu@fuuzetsu.co.uk
+category: Web
+build-type: Simple
+extra-source-files: README.md
+cabal-version: >=1.10
+source-repository head
+ type: git
+ location: git@github.com:Fuuzetsu/h-booru.git
+
+library
+ hs-source-dirs: src
+ default-language: Haskell2010
+ exposed-modules:
+ HBooru.Types
+ HBooru.Parsers.Gelbooru
+ HBooru.Parsers.Ichijou
+ HBooru.Parsers.Konachan
+ HBooru.Parsers.Safebooru
+ HBooru.Parsers.Yandere
+ HBooru.Parsers.GenericBooru
+ HBooru.Parsers.GenericBooru.TH
+ -- other-modules:
+ build-depends: base >=4.6 && <5, hxt >= 9.3.1.2, template-haskell
diff --git a/src/HBooru/Parsers/Gelbooru.hs b/src/HBooru/Parsers/Gelbooru.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Parsers/Gelbooru.hs
@@ -0,0 +1,48 @@
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE UnicodeSyntax #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE TemplateHaskell #-}
+
+-- |
+-- Module : HBooru.Parsers.Gelbooru
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- Module for parsing content from .
+module HBooru.Parsers.Gelbooru where
+
+import Data.List
+import qualified HBooru.Parsers.GenericBooru as G
+import HBooru.Parsers.GenericBooru.TH (makePost)
+import HBooru.Types
+import Language.Haskell.TH (mkName)
+import Text.XML.HXT.Core hiding (mkName)
+
+-- | Data type for Gelbooru posts generated using 'makePost'.
+$(makePost (mkName "GelbooruPost"))
+
+-- | We use this type and its 'Site' instance to distinguish
+-- between various parsers.
+data Gelbooru = Gelbooru
+
+instance Postable Gelbooru XML where
+ postUrl _ _ ts =
+ let tags = intercalate "+" ts
+ in "http://gelbooru.com/index.php?page=dapi&s=post&q=index&limit=100&tags="
+ ++ tags ++ "&pid=0"
+ hardLimit _ = Limit 100
+
+instance Site Gelbooru where
+
+instance PostParser Gelbooru XML where
+ type ImageTy Gelbooru XML = GelbooruPost
+ parseResponse _ = map (`betweenPosts` GelbooruPost)
+ . runLA (xreadDoc /> G.parsePost) . getResponse
+
+instance Counted Gelbooru XML where
+ parseCount _ = read . head . runLA (xreadDoc >>> hasName "posts"
+ >>> getAttrValue "count") . getResponse
diff --git a/src/HBooru/Parsers/GenericBooru.hs b/src/HBooru/Parsers/GenericBooru.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Parsers/GenericBooru.hs
@@ -0,0 +1,104 @@
+{-# LANGUAGE UnicodeSyntax #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE Arrows #-}
+{-# LANGUAGE TemplateHaskell #-}
+-- |
+-- Module : HBooru.Parsers.GenericBooru
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- | Many booru sites use the same engine (Gelbooru engine) so instead of having
+-- identical parsers across many modules, we simply alias our 'GenericPost' to
+-- whatever we need.
+module HBooru.Parsers.GenericBooru where
+
+import Prelude hiding (id)
+import Data.String
+import HBooru.Types
+import HBooru.Parsers.GenericBooru.TH
+import Text.Read (readMaybe)
+import Text.XML.HXT.Core hiding (mkName)
+import Language.Haskell.TH (mkName)
+
+-- | A post we might expect from many of the sites as a lot of them seem to be
+-- based on the Gelbooru engine.
+$(makePost (mkName "GenericPost"))
+
+-- | Fairly naïve parser for all attributes in sites running vanilla
+-- Gelbooru engine. While it catches all attributes in a typical XML post
+-- result, we trust that they are consistent and use 'read' to deserialise some
+-- values. For sites with non-default replies, custom parsers have to be written.
+parsePost ∷ ArrowXml cat ⇒ cat XmlTree GenericPost
+parsePost = hasName "post" >>> proc x → do
+ height <- getAttrValue "height" -< x
+ score <- getAttrValue "score" -< x
+ file_url <- getAttrValue "file_url" -< x
+ parent_id <- getAttrValue "parent_id" -< x
+ sample_url <- getAttrValue "sample_url" -< x
+ sample_width <- getAttrValue "sample_width" -< x
+ sample_height <- getAttrValue "sample_height" -< x
+ preview_url <- getAttrValue "preview_url" -< x
+ rating <- getAttrValue "rating" -< x
+ tags <- getAttrValue "tags" -< x
+ id <- getAttrValue "id" -< x
+ width <- getAttrValue "width" -< x
+ change <- getAttrValue "change" -< x
+ md5 <- getAttrValue "md5" -< x
+ creator_id <- getAttrValue "creator_id" -< x
+ has_children <- getAttrValue "has_children" -< x
+ created_at <- getAttrValue "created_at" -< x
+ status <- getAttrValue "status" -< x
+ source <- getAttrValue "source" -< x
+ has_notes <- getAttrValue "has_notes" -< x
+ has_comments <- getAttrValue "has_comments" -< x
+ preview_width <- getAttrValue "preview_width" -< x
+ preview_height <- getAttrValue "preview_height" -< x
+ returnA -< GenericPost
+ { heightT = read height
+ , scoreT = read score
+ , file_urlT = file_url
+ , parent_idT = readMaybe parent_id
+ , sample_urlT = sample_url
+ , sample_widthT = read sample_width
+ , sample_heightT = read sample_height
+ , preview_urlT = preview_url
+ , ratingT = parseRating rating
+ , tagsT = parseTags tags
+ , idT = read id
+ , widthT = read width
+ , changeT = change
+ , md5T = md5
+ , creator_idT = read creator_id
+ , has_childrenT = parseBool has_children
+ , created_atT = created_at
+ , statusT = status
+ , sourceT = source
+ , has_notesT = parseBool has_notes
+ , has_commentsT = parseBool has_comments
+ , preview_widthT = read preview_width
+ , preview_heightT = read preview_height
+ }
+
+-- | Parses a string returned from a Gelbooru-like site into
+-- one of the commonly used 'Rating's. Note that this is a partial function
+-- so you should make sure that the site in question only ever returns the
+-- values in a format specified in the function
+parseRating :: String -> Rating
+parseRating "e" = Explicit
+parseRating "s" = HBooru.Types.Safe
+parseRating "q" = Questionable
+
+-- | Splits returned tag string into separate 'Tag's. For Gelbooru-like
+-- sites, this is just the question of splitting on whitespace.
+parseTags :: String -> [Tag]
+parseTags = words
+
+-- | Reads a lowercase 'Bool' string representation into its Haskell type. If we
+-- can't parse the boolean, return 'Nothing'.
+parseBool :: String -> Maybe Bool
+parseBool "false" = Just False
+parseBool "true" = Just True
+parseBool _ = Nothing
diff --git a/src/HBooru/Parsers/GenericBooru/TH.hs b/src/HBooru/Parsers/GenericBooru/TH.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Parsers/GenericBooru/TH.hs
@@ -0,0 +1,90 @@
+{-# LANGUAGE TemplateHaskell #-}
+-- |
+-- Module : HBooru.Parsers.GenericBooru.TH
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- | Helper module for "HBooru.Parsers.GenericBooru" due to Template Haskell
+-- limitation of being unable to splice inside of the same module of
+-- definitions.
+module HBooru.Parsers.GenericBooru.TH where
+
+import Control.Applicative
+import HBooru.Types
+import Language.Haskell.TH
+import Language.Haskell.TH.Syntax
+
+-- | A TH helper which makes an instance along with the data type using
+-- 'makePost'' and 'makePostInstance'.
+makePost n = liftA2 (++) (makePost' n) (makePostInstance n)
+
+-- | Template Haskell function which is able to generate 'GenericPost'-alike
+-- type declarations for cases where we want to use this format but need a
+-- different data type. It can be used by using @TemplateHaskell@ extension and
+-- calling @$(makePost ('mkName' \"YourTypeName\"))@ at the top level. Hopefully
+-- a temporary measure until the author thinks of a better way to provide
+-- generic Gelbooru-like post parsing while casting out to different data types
+-- that's OK to write.
+makePost' :: Name -> Q [Dec]
+makePost' n =
+ fmap (:[]) $ dataD (cxt []) n []
+ [ recC n
+ [ varStrictType (mkName "heightT") $ strictType notStrict [t| Integer |]
+ , varStrictType (mkName "scoreT") $ strictType notStrict [t| Integer |]
+ , varStrictType (mkName "file_urlT") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "parent_idT") $ strictType notStrict
+ [t| Maybe Integer |]
+ , varStrictType (mkName "sample_urlT") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "sample_widthT") $ strictType notStrict
+ [t| Integer |]
+ , varStrictType (mkName "sample_heightT") $ strictType notStrict
+ [t| Integer |]
+ , varStrictType (mkName "preview_urlT") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "ratingT") $ strictType notStrict [t| Rating |]
+ , varStrictType (mkName "tagsT") $ strictType notStrict [t| [String] |]
+ , varStrictType (mkName "idT") $ strictType notStrict [t| Integer |]
+ , varStrictType (mkName "widthT") $ strictType notStrict [t| Integer |]
+ , varStrictType (mkName "changeT") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "md5T") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "creator_idT") $ strictType notStrict [t| Integer |]
+ , varStrictType (mkName "has_childrenT") $ strictType notStrict
+ [t| Maybe Bool |]
+ , varStrictType (mkName "created_atT") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "statusT") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "sourceT") $ strictType notStrict [t| String |]
+ , varStrictType (mkName "has_notesT") $ strictType notStrict
+ [t| Maybe Bool |]
+ , varStrictType (mkName "has_commentsT") $ strictType notStrict
+ [t| Maybe Bool |]
+ , varStrictType (mkName "preview_widthT") $ strictType notStrict
+ [t| Integer |]
+ , varStrictType (mkName "preview_heightT") $ strictType notStrict
+ [t| Integer |]
+ ]
+ ] [mkName "Show", mkName "Eq"]
+
+-- | Template Haskell function which creates 'Post' instances for things made
+-- with 'makePost'.
+makePostInstance :: Name -> Q [Dec]
+makePostInstance n = do
+ return [InstanceD
+ []
+ (ConT (mkName "Post") `AppT` ConT n)
+ [ onG "height", onG "score", onG "file_url", onG "parent_id"
+ , onG "sample_url", onG "sample_width", onG "sample_height"
+ , onG "preview_url", onG "rating", onG "tags", onG "id"
+ , onG "width", onG "change", onG "md5", onG "creator_id"
+ , onG "has_children", onG "created_at", onG "status"
+ , onG "source", onG "has_notes", onG "has_comments"
+ , onG "preview_width", onG "preview_height"
+ ]
+ ]
+ where
+ onG n = FunD (mkName n)
+ [ Clause [(VarP (mkName "g"))]
+ (NormalB (AppE (VarE (mkName $ n ++ "T"))
+ (VarE (mkName "g")))) []
+ ]
diff --git a/src/HBooru/Parsers/Ichijou.hs b/src/HBooru/Parsers/Ichijou.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Parsers/Ichijou.hs
@@ -0,0 +1,47 @@
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE UnicodeSyntax #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE TemplateHaskell #-}
+
+-- |
+-- Module : HBooru.Parsers.Ichijou
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- Module for parsing content from .
+module HBooru.Parsers.Ichijou where
+
+import Data.List
+import qualified HBooru.Parsers.GenericBooru as G
+import HBooru.Parsers.GenericBooru.TH (makePost)
+import HBooru.Types
+import Language.Haskell.TH.Syntax (mkName)
+import Text.XML.HXT.Core hiding (mkName)
+
+-- | Data type for safebooru posts generated using 'makePost'.
+$(makePost (mkName "IchijouPost"))
+
+-- | We use this type and its 'Site' instance to distinguish
+-- between various parsers.
+data Ichijou = Ichijou
+
+instance Postable Ichijou XML where
+ postUrl _ _ ts =
+ let tags = intercalate "+" ts
+ in "http://ichijou.org/index.xml?tags=" ++ tags
+ hardLimit _ = Limit 100
+
+instance Site Ichijou where
+
+instance PostParser Ichijou XML where
+ type ImageTy Ichijou XML = IchijouPost
+ parseResponse _ = map (`betweenPosts` IchijouPost)
+ . runLA (xreadDoc /> G.parsePost) . getResponse
+
+instance Counted Ichijou XML where
+ parseCount _ = read . head . runLA (xreadDoc >>> hasName "posts"
+ >>> getAttrValue "count") . getResponse
diff --git a/src/HBooru/Parsers/Konachan.hs b/src/HBooru/Parsers/Konachan.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Parsers/Konachan.hs
@@ -0,0 +1,48 @@
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE UnicodeSyntax #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE TemplateHaskell #-}
+
+-- |
+-- Module : HBooru.Parsers.Konachan
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- Module for parsing content from .
+
+module HBooru.Parsers.Konachan where
+
+import Data.List
+import qualified HBooru.Parsers.GenericBooru as G
+import HBooru.Parsers.GenericBooru.TH (makePost)
+import HBooru.Types
+import Language.Haskell.TH (mkName)
+import Text.XML.HXT.Core hiding (mkName)
+
+-- | Data type for Konachan posts generated using 'makePost'.
+$(makePost (mkName "KonachanPost"))
+
+-- | We use this type and its 'Site' instance to distinguish
+-- between various parsers.
+data Konachan = Konachan
+
+instance Postable Konachan XML where
+ postUrl _ _ ts =
+ let tags = intercalate "+" ts
+ in "https://konachan.com/post/index.xml?tags=" ++ tags
+ hardLimit _ = Limit 100
+
+instance Site Konachan where
+
+instance PostParser Konachan XML where
+ type ImageTy Konachan XML = KonachanPost
+ parseResponse _ = map (`betweenPosts` KonachanPost)
+ . runLA (xreadDoc /> G.parsePost) . getResponse
+
+instance Counted Konachan XML where
+ parseCount _ = read . head . runLA (xreadDoc >>> hasName "posts"
+ >>> getAttrValue "count") . getResponse
diff --git a/src/HBooru/Parsers/Safebooru.hs b/src/HBooru/Parsers/Safebooru.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Parsers/Safebooru.hs
@@ -0,0 +1,48 @@
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE UnicodeSyntax #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE TemplateHaskell #-}
+
+-- |
+-- Module : HBooru.Parsers.Safebooru
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- Module for parsing content from .
+module HBooru.Parsers.Safebooru where
+
+import Data.List
+import qualified HBooru.Parsers.GenericBooru as G
+import HBooru.Parsers.GenericBooru.TH (makePost)
+import HBooru.Types
+import Language.Haskell.TH.Syntax (mkName)
+import Text.XML.HXT.Core hiding (mkName)
+
+-- | Data type for safebooru posts generated using 'makePost'.
+$(makePost (mkName "SafebooruPost"))
+
+-- | We use this type and its 'Site' instance to distinguish
+-- between various parsers.
+data Safebooru = Safebooru
+
+instance Postable Safebooru XML where
+ postUrl _ _ ts =
+ let tags = intercalate "+" ts
+ in "http://safebooru.org/index.php?page=dapi&s=post&q=index&limit=100&tags="
+ ++ tags ++ "&pid=0"
+ hardLimit _ = Limit 100
+
+instance Site Safebooru where
+
+instance PostParser Safebooru XML where
+ type ImageTy Safebooru XML = SafebooruPost
+ parseResponse _ = map (`betweenPosts` SafebooruPost)
+ . runLA (xreadDoc /> G.parsePost) . getResponse
+
+instance Counted Safebooru XML where
+ parseCount _ = read . head . runLA (xreadDoc >>> hasName "posts"
+ >>> getAttrValue "count") . getResponse
diff --git a/src/HBooru/Parsers/Yandere.hs b/src/HBooru/Parsers/Yandere.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Parsers/Yandere.hs
@@ -0,0 +1,48 @@
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE UnicodeSyntax #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE TemplateHaskell #-}
+
+-- |
+-- Module : HBooru.Parsers.Yandere
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- Module for parsing content from ,
+-- known in the past as .
+module HBooru.Parsers.Yandere where
+
+import Data.List
+import qualified HBooru.Parsers.GenericBooru as G
+import HBooru.Parsers.GenericBooru.TH (makePost)
+import HBooru.Types
+import Language.Haskell.TH (mkName)
+import Text.XML.HXT.Core hiding (mkName)
+
+-- | Data type for Yandere posts generated using 'makePost'.
+$(makePost (mkName "YanderePost"))
+
+-- | We use this type and its 'Site' instance to distinguish
+-- between various parsers.
+data Yandere = Yandere
+
+instance Postable Yandere XML where
+ postUrl _ _ ts =
+ let tags = intercalate "+" ts
+ in "https://yande.re/post/index.xml?tags=" ++ tags
+ hardLimit _ = Limit 100
+
+instance Site Yandere where
+
+instance PostParser Yandere XML where
+ type ImageTy Yandere XML = YanderePost
+ parseResponse _ = map (`betweenPosts` YanderePost)
+ . runLA (xreadDoc /> G.parsePost) . getResponse
+
+instance Counted Yandere XML where
+ parseCount _ = read . head . runLA (xreadDoc >>> hasName "posts"
+ >>> getAttrValue "count") . getResponse
diff --git a/src/HBooru/Types.hs b/src/HBooru/Types.hs
new file mode 100644
--- /dev/null
+++ b/src/HBooru/Types.hs
@@ -0,0 +1,198 @@
+{-# LANGUAGE MultiParamTypeClasses #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE UnicodeSyntax #-}
+{-# LANGUAGE TypeFamilies #-}
+{-# LANGUAGE FunctionalDependencies #-}
+
+-- |
+-- Module : HBooru.Types
+-- Copyright : (c) Mateusz Kowalczyk 2013
+-- License : GPL-3
+--
+-- Maintainer : fuuzetsu@fuuzetsu.co.uk
+-- Stability : experimental
+--
+-- Module definining types used by the library.
+module HBooru.Types where
+
+import Prelude hiding (id)
+
+-- | Tags used for searching in sites. No special escaping is done.
+-- Note that many sites would treat a tag like \"striped panties\"
+-- as two separate tags and you wouldn't get the results you were after.
+type Tag = String
+
+-- | Data format used by various 'Site's. See instances for currently used
+-- formats.
+class DataFormat a where
+
+-- | Used as one of the data formats.
+data XML = XML deriving Show
+
+-- | Used as one of the data formats.
+data JSON = JSON deriving Show
+
+instance DataFormat XML where
+instance DataFormat JSON where
+
+-- | Thanks to this class, we're able to provide instances converting
+-- from a 'DataFormat' to 'Response'. This is useful if we need a 'DataFormat'
+-- while we only have a type that's an instance of 'Response'. Note that the
+-- functional dependency currently requires that there is only one way to coerce
+-- between two types.
+class Response r ⇒ CoerceResponse x r | x → r, r → x where
+ -- | Given something and a 'String', we get the appropriate 'Response'.
+ -- For example with @instance 'CoerceResponse' 'XML' 'XMLResponse'@:
+ --
+ -- >>> toResponse XML ""
+ -- XMLReponse ""
+ toResponse ∷ x → String → r
+ -- | Given some kind of 'Response', we get the appropriate value back,
+ -- depending on the class instance.
+ -- For example with @instance 'CoerceResponse' 'XML' 'XMLResponse'@:
+ --
+ -- >>> fromResponse $ XMLReponse ""
+ -- XML
+ fromResponse ∷ r → x
+
+instance CoerceResponse XML XMLResponse where
+ toResponse _ = XMLResponse
+ fromResponse _ = XML
+
+instance CoerceResponse JSON JSONResponse where
+ toResponse _ = JSONResponse
+ fromResponse _ = JSON
+
+-- | Class specifying a parser that can fetch posts. A post usually consists of
+-- links to the image, samples, and some meta-data. See
+-- 'HBooru.Parsers.GenericBooru.GenericPost' for the kind of thing we usually
+-- get out. The reason for this class is that sometimes we might get different
+-- information based on the 'DataFormat' we use so we use type families to
+-- denote this rather than forcing the library user to make do with our best
+-- guess on what goes into the post. It also allows us to use different post
+-- types for sites that provide different information.
+class (Site s, DataFormat r) ⇒ PostParser s r where
+ type ImageTy s r
+ -- | Given a parser working with 'DataFormat' specified by an instance of
+ -- this class, we require through 'CoerceResponse' that it is able to parse
+ -- responses in the format so what we actually pass into this function is
+ -- the 'Site' this parser works with (so that we can pick the appropriate data
+ -- type for the posts) and a 'Response' matching the 'DataFormat' (through a
+ -- class instance). For @PostParser 'Gelbooru' 'XML'@ instance, example use
+ -- might go like
+ --
+ -- @
+ -- do fc \<- 'XMLResponse' <$> 'readFile' \"gelbooruResponse.xml\"
+ -- -- the type of images is actually inferred for us
+ -- let images ∷ ['HBooru.Parsers.Gelbooru.GelbooruPost']
+ -- images = parseResponse 'HBooru.Parsers.Gelbooru.Gelbooru' fc
+ -- return images
+ -- @
+ --
+ -- The cool thing is that we can't feed anything but 'XMLResponse' to an
+ -- XML parser.
+ parseResponse ∷ CoerceResponse r r' ⇒ s → r' → [ImageTy s r]
+
+-- | Describes whether a response from a 'Site' in given 'DataFormat'
+-- allows us to get the information about total number of posts matching our
+-- query. Some sites don't provide this information.
+class (Site s, DataFormat r) ⇒ Counted s r where
+ parseCount ∷ CoerceResponse r r' ⇒ s → r' → Integer
+
+-- | If we can make an API request to 'Site' in a specific 'DataFormat', we can
+-- use instances of this class to pass in
+class (Site s, DataFormat r) ⇒ Postable s r where
+ -- | Given a 'Site', a 'DataFormat' and a list of 'Tag's, an instance of this
+ -- class should be able to return a 'String' at which we can find data in
+ -- 'DataFormat' format that honours our tags. This is effectively a URL
+ -- builder for POST requests.
+ postUrl ∷ s → r → [Tag] → String
+ -- | Provides information about whether there's a hard limit on the amount of
+ -- posts we can fetch from the site at once. The reason for this function here
+ -- rather than in 'Site' is that we might be parsing data without an API we
+ -- can post to at all and we're getting our data through other means.
+ hardLimit ∷ s → Limit
+
+-- | Describes a site for a parser. The reason why this isn't a simple data type
+-- is to allow us to write additional parsers in the future without modifying
+-- this library if we wish to do so.
+class Site s where
+
+-- | Rating used on *booru sites.
+data Rating = Safe | Questionable | Explicit deriving (Show, Eq)
+
+-- | Denotes whethere there's a hard limit on the number of posts
+-- we can fetch at a time from a site. NoLimit implies that we can fetch
+-- everything at once and not that we don't know. See 'Counted' for a way to
+-- potentially retrieve number of posts present on the site.
+data Limit = NoLimit | Limit Integer deriving (Show, Eq)
+
+-- | One of the formats we can receive responses from sites in. For things
+-- like parsers parametrisation, use 'XML' instead and use methods in
+-- 'CoerceResponse' if you need to.
+data XMLResponse = XMLResponse String deriving Show
+
+-- | One of the formats we can receive responses from sites in. For things
+-- like parsers parametrisation, use 'JSON' instead and use methods in
+-- 'CoerceResponse' if you need to.
+data JSONResponse = JSONResponse String deriving Show
+
+-- | Specifies what is considered a response. You'll almost certainly also
+-- want new 'DataFormat' and 'CoerceResponse' instances if you're adding some
+-- here. This class assumes that all responses carry the response in a string we
+-- can extract. Note that this is not for use as network response if you're
+-- scraping, only for putting data into after you have done all the error
+-- checking and whatnot.
+class Response r where
+ -- | Extract the response string.
+ getResponse ∷ r → String
+
+instance Response XMLResponse where
+ getResponse (XMLResponse x) = x
+
+instance Response JSONResponse where
+ getResponse (JSONResponse x) = x
+
+-- | Class representing a best-case scenario post. We use this
+-- to convert between different posts for each site while providing
+-- uniform access. The methods are just the attributes of posts seen
+-- on Gelbooru-like sites.
+class Post a where
+ height ∷ a → Integer
+ score ∷ a → Integer
+ file_url ∷ a → String
+ parent_id ∷ a → Maybe Integer
+ sample_url ∷ a → String
+ sample_width ∷ a → Integer
+ sample_height ∷ a → Integer
+ preview_url ∷ a → String
+ rating ∷ a → Rating
+ tags ∷ a → [String]
+ id ∷ a → Integer
+ width ∷ a → Integer
+ change ∷ a → String
+ md5 ∷ a → String
+ creator_id ∷ a → Integer
+ has_children ∷ a → Maybe Bool
+ created_at ∷ a → String
+ status ∷ a → String
+ source ∷ a → String
+ has_notes ∷ a → Maybe Bool
+ has_comments ∷ a → Maybe Bool
+ preview_width ∷ a → Integer
+ preview_height ∷ a → Integer
+ betweenPosts ∷ Post b ⇒ a → PostConstructor b → b
+ betweenPosts g c =
+ c (height g) (score g) (file_url g) (parent_id g) (sample_url g)
+ (sample_width g) (sample_height g) (preview_url g) (rating g)
+ (tags g) (id g) (width g) (change g) (md5 g) (creator_id g)
+ (has_children g) (created_at g) (status g) (source g) (has_notes g)
+ (has_comments g) (preview_width g) (preview_height g)
+
+
+-- | A cludge for use with 'betweenPosts'
+type PostConstructor b =
+ Integer -> Integer -> String -> Maybe Integer -> String -> Integer -> Integer
+ -> String -> Rating -> [String] -> Integer -> Integer -> String -> String
+ -> Integer -> Maybe Bool -> String -> String -> String -> Maybe Bool
+ -> Maybe Bool -> Integer -> Integer -> b