From cdfde6026a748400e1193d325e3f13ff1f9ab195 Mon Sep 17 00:00:00 2001 From: Julien Moutinho Date: Sat, 29 Dec 2018 14:13:41 +0100 Subject: [PATCH 1/1] init --- .gitignore | 11 + COPYING | 674 +++++++++++++++++++++++++++++++ GNUmakefile | 81 ++++ HLint.hs | 16 + Language/HLint.hs | 1 + Language/Symantic/HLint.hs | 1 + Language/Symantic/HTTP.hs | 182 +++++++++ Language/Symantic/HTTP/API.hs | 141 +++++++ Language/Symantic/HTTP/Client.hs | 41 ++ Language/Symantic/HTTP/HLint.hs | 1 + Language/Symantic/HTTP/Layout.hs | 102 +++++ Language/Symantic/HTTP/Media.hs | 86 ++++ Language/Symantic/HTTP/Router.hs | 252 ++++++++++++ Language/Symantic/HTTP/Sym.hs | 143 +++++++ stack.yaml | 14 + symantic-http.cabal | 115 ++++++ 16 files changed, 1861 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 GNUmakefile create mode 100644 HLint.hs create mode 120000 Language/HLint.hs create mode 120000 Language/Symantic/HLint.hs create mode 100644 Language/Symantic/HTTP.hs create mode 100644 Language/Symantic/HTTP/API.hs create mode 100644 Language/Symantic/HTTP/Client.hs create mode 120000 Language/Symantic/HTTP/HLint.hs create mode 100644 Language/Symantic/HTTP/Layout.hs create mode 100644 Language/Symantic/HTTP/Media.hs create mode 100644 Language/Symantic/HTTP/Router.hs create mode 100644 Language/Symantic/HTTP/Sym.hs create mode 100644 stack.yaml create mode 100644 symantic-http.cabal diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bf52384 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +*.hi +*.html +*.o +.cabal-sandbox/ +.stack-work/ +bug/ +cabal.sandbox.config +dist/ +hlint.html +old/ +stats/ diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + 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 + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +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 (C) + 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/GNUmakefile b/GNUmakefile new file mode 100644 index 0000000..4588484 --- /dev/null +++ b/GNUmakefile @@ -0,0 +1,81 @@ +cabal := $(shell find . -name '*.cabal' -print -quit) +package := $(notdir ./$(cabal:.cabal=)) +#package := $(shell 2>&1 stack ide packages) +#STACK_FLAGS ?= --nix + +all: build + +build: + stack $(STACK_FLAGS) build $(STACK_BUILD_FLAGS) + +.PHONY: test +test: + ! grep -q '^Test-Suite\>' $(cabal) || \ + { stack $(STACK_FLAGS) test $(STACK_TEST_FLAGS) --test-arguments "$(STACK_TEST_ARGS)"; } + +GHCID_TEST_ARGS ?= +GHCID_TEST ?= ":main $(GHCID_TEST_ARGS)" +ghcid: + ghcid \ + --warnings \ + --command "stack $(STACK_FLAGS) $(GHCID_STACK_FLAGS) ghci $(GHCID_GHCI_FLAGS) \ + $(shell 2>&1 stack ide targets | grep -v :test:) \ + --ghci-options=-fobject-code" \ + --test $(GHCID_TEST) \ + $(GHCID_FLAGS) + +clean: + stack $(STACK_FLAGS) clean $(STACK_CLEAN_FLAGS) +cleaner: + stack $(STACK_FLAGS) clean --full $(STACK_CLEAN_FLAGS) + +%/fast: override STACK_BUILD_FLAGS+=--fast +%/fast: override STACK_HADDOCK_FLAGS+=--fast +%/fast: override STACK_TEST_FLAGS+=--fast +%/fast: % + + +%/debug: override STACK_BUILD_FLAGS+=--flag $(cabal:.cabal=):debug +%/debug: override STACK_TEST_FLAGS+=--flag $(cabal:.cabal=):debug +%/debug: % + + +%/accept: override STACK_TEST_ARGS+=--accept +%/accept: % + + +doc: + stack $(STACK_FLAGS) haddock $(STACK_HADDOCK_FLAGS) +%.html: %.md + markdown $*.md >$*.html +%.html/view: %.html + sensible-browser $*.html + +HLint.hs: $(shell find . -name '*.hs' -not -name 'HLint.hs') + sed -i -e '/^-- BEGIN: generated hints/,/^-- END: Generated by hlint/d' HLint.hs + echo '-- BEGIN: generated hints' >> HLint.hs + hlint --find . | grep '^'infix | sort -u >> HLint.hs + echo '-- END: generated hints' >> HLint.hs + +lint: HLint.hs + if hlint --quiet --report=hlint.html -XNoCPP \ + $(shell cabal-cargs --format=ghc --only=default_extensions --sourcefile=$(cabal)) $(HLINT_FLAGS) .; \ + then rm -f hlint.html; \ + else sensible-browser ./hlint.html & fi + +tag: + name=$$(sed -ne 's/^name: *\(.*\)/\1/p' "$(cabal)"); \ + version=$$(sed -ne 's/^version: *\(.*\)/\1/p' "$(cabal)"); \ + git tag --merged | grep -Fqx "$$name-$$version" || \ + git tag -f -s -m "$$name v$$version" $$name-$$version + +tar: + stack $(STACK_FLAGS) sdist $(STACK_SDIST_FLAGS) +upload: + LANG=C stack $(STACK_FLAGS) upload $(STACK_UPLOAD_FLAGS) . + +.PHONY: stats +stats: + gitstats . $@ +stats/view: stats + sensible-browser stats/index.html diff --git a/HLint.hs b/HLint.hs new file mode 100644 index 0000000..3cb2542 --- /dev/null +++ b/HLint.hs @@ -0,0 +1,16 @@ +import "hint" HLint.HLint +ignore "Move brackets to avoid $" +ignore "Reduce duplication" +ignore "Redundant $" +ignore "Redundant bracket" +ignore "Redundant do" +ignore "Use camelCase" +ignore "Use const" +ignore "Use fmap" +ignore "Use if" +ignore "Use import/export shortcut" +ignore "Use list literal pattern" +ignore "Use list literal" + +-- BEGIN: generated hints +-- END: generated hints diff --git a/Language/HLint.hs b/Language/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/Language/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/Language/Symantic/HLint.hs b/Language/Symantic/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/Language/Symantic/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/Language/Symantic/HTTP.hs b/Language/Symantic/HTTP.hs new file mode 100644 index 0000000..3fa1ed5 --- /dev/null +++ b/Language/Symantic/HTTP.hs @@ -0,0 +1,182 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE NoMonomorphismRestriction #-} +{-# LANGUAGE StrictData #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} +module Language.Symantic.HTTP + ( module Language.Symantic.HTTP + , module Language.Symantic.HTTP.API + , module Language.Symantic.HTTP.Layout + , module Language.Symantic.HTTP.Media + , module Language.Symantic.HTTP.Router + ) where + +-- import qualified Data.ByteString.Lazy as BSL +import Control.Applicative (Applicative(..)) +import Control.Monad () +import Data.Bool +import Data.Either (Either(..)) +import Data.Function (($)) +import Data.Functor ((<$>), (<$)) +import Data.Maybe (Maybe(..)) +import Data.Proxy (Proxy(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (IsString(..)) +import System.IO (IO) +import Prelude (error) +import Text.Show (Show(..)) +import qualified Data.Text as Text +import qualified Data.Time as Time +import qualified Network.HTTP.Media as Media +import qualified Network.HTTP.Types as HTTP +import qualified Network.HTTP.Types.Header as HTTP +import qualified Network.Wai as Wai +import qualified Network.Wai.Handler.Warp as Warp + +import Language.Symantic.HTTP.API +import Language.Symantic.HTTP.Media +import Language.Symantic.HTTP.Router +import Language.Symantic.HTTP.Layout + +-- * Type 'API0' +data API0 + = API0_Date Time.Day + | API0_Time Time.ZonedTime + | API0_Reset Bool + deriving (Show) +instance IsString Time.TimeZone where + fromString s = case s of + "CEST" -> Time.TimeZone 2 True "CEST" + "CET" -> Time.TimeZone 1 False "CET" + _ -> error "unknown TimeZone" + + +api0 :: HTTP_API repr => repr () +api0 = + () <$ method_GET <+> + () <$ method_POST + +api00 :: HTTP_API repr => repr () +api00 = + () <$ method_GET <+> + () <$ method_POST <+> + () <$ method_HEAD + +api000 :: HTTP_API repr => repr () +api000 = + () <$ method_GET <+> + () <$ method_POST <+> + () <$ method_HEAD <+> + () <$ method_PUT + +api1 f0 f1 = + f0 + <$ segment "time" + <*> capture "timezone" + <*> endpoint HTTP.methodGet plainText <+> + f1 + <$ segment "date" + <*> endpoint HTTP.methodGet plainText + +lay1 :: Layout () +lay1 = api1 + (\_tz (Proxy::Proxy ()) -> ()) + (\(Proxy::Proxy ()) -> ()) + +rou1 :: Router Application +rou1 = api1 + (\tz (RouterEndpoint respond) _rq re -> do + time <- Time.utcToZonedTime (fromString $ Text.unpack tz) <$> Time.getCurrentTime + re $ Right $ respond (HTTP.mkStatus 200 "") [] $ show time <> "\n") + (\(RouterEndpoint respond) _rq re -> do + date <- Time.utctDay <$> Time.getCurrentTime + re $ Right $ respond (HTTP.mkStatus 200 "") [] $ show date <> "\n") + +srv1 :: IO () +srv1 = Warp.run 8080 $ runRouterApp rou1 +{- +api2 :: HTTP_API repr => repr Application +api2 = + (\too respond _rq re -> + re $ Right $ respond (HTTP.mkStatus 200 "") [] too) + <$ segment "me" + <*> capture "too" + <*> endpoint HTTP.methodGet plainText + +api3 f = f <$ segment "me" <*> capture "too" <*> capture "too" +-} + +req1_1 :: Wai.Request +req1_1 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodGet + , Wai.pathInfo = ["date"] + , Wai.requestHeaders = + [ (HTTP.hAccept, Media.renderHeader $ mediaType plainText) ] + } + +req1_2 :: Wai.Request +req1_2 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodGet + , Wai.pathInfo = ["time", "CEST"] + , Wai.requestHeaders = + [ (HTTP.hAccept, Media.renderHeader $ mediaType plainText) ] + } + +req1_3 :: Wai.Request +req1_3 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodPost + , Wai.pathInfo = ["clock"] + , Wai.queryString = + [ ("reset", Just "1") ] + } + +req1_KO_1 :: Wai.Request +req1_KO_1 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodPut + , Wai.pathInfo = ["time", "CEST"] + , Wai.requestHeaders = + [ (HTTP.hAccept, Media.renderHeader $ mediaType plainText) ] + } + +req1_KO_2 :: Wai.Request +req1_KO_2 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodGet + , Wai.pathInfo = ["non-existent"] + , Wai.requestHeaders = + [ (HTTP.hAccept, Media.renderHeader $ mediaType plainText) ] + } + +req1_KO_3 :: Wai.Request +req1_KO_3 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodGet + , Wai.pathInfo = ["date"] + , Wai.requestHeaders = + [ (HTTP.hAccept, "application/non-sense") ] + } + +req1_KO_4 :: Wai.Request +req1_KO_4 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodGet + , Wai.pathInfo = ["date"] + , Wai.requestHeaders = + [ (HTTP.hHost, "example.com") ] + } + +req1_KO_5 :: Wai.Request +req1_KO_5 = Wai.defaultRequest + { Wai.requestMethod = HTTP.methodPost + , Wai.pathInfo = ["clock"] + , Wai.queryString = + [ ("reset", Just "NaN") ] + } + +{- +test :: IO () +test = do + forM_ + [ req1_1, req1_2, req1_3 + , req1_KO_1, req1_KO_2, req1_KO_3, req1_KO_4, req1_KO_5 + ] $ \req -> do + runRouterIO api1 req +-} diff --git a/Language/Symantic/HTTP/API.hs b/Language/Symantic/HTTP/API.hs new file mode 100644 index 0000000..bfc33ff --- /dev/null +++ b/Language/Symantic/HTTP/API.hs @@ -0,0 +1,141 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE StrictData #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +module Language.Symantic.HTTP.API + ( module Language.Symantic.HTTP.API + , Functor(..), (<$>), ($>) + , Applicative(..) + , Alternative(..) + ) where + +import Control.Applicative (Applicative(..), Alternative(..)) +import Data.Bool +import Data.Eq (Eq(..)) +import Data.Functor (Functor(..), (<$>), ($>), (<$)) +import Data.Maybe (Maybe(..)) +import Data.Ord (Ord(..)) +import Data.Proxy (Proxy(..)) +import Data.String (String) +import Text.Show (Show(..)) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BSL +import qualified Data.Text as T +import qualified Network.HTTP.Types as HTTP +import qualified Network.Wai as Wai + +import Language.Symantic.HTTP.Media + +-- * Class 'HTTP_API' +class + ( Applicative repr + , Altern repr + , HTTP_Path repr + , HTTP_Method repr + , HTTP_Header repr + , HTTP_Accept repr + , HTTP_Query repr + , HTTP_Version repr + , HTTP_Endpoint repr + ) => HTTP_API repr + +-- * Class 'Altern' +class Altern repr where + -- | There Is No Alternative + tina :: repr a + (<+>) :: repr a -> repr a -> repr a; infixl 3 <+> + try :: repr a -> repr a + choice :: [repr a] -> repr a + choice [] = tina + choice (r:rs) = try r <+> choice rs +-- * Class 'HTTP_Path' +class HTTP_Path repr where + segment :: Segment -> repr () + capture :: Name -> repr Segment + captureAll :: repr [Segment] +type Segment = T.Text +type Path = [Segment] +type Name = String +-- * Class 'HTTP_Method' +class HTTP_Method repr where + method :: HTTP.Method -> repr HTTP.Method + method_GET :: repr HTTP.Method + method_POST :: repr HTTP.Method + method_HEAD :: repr HTTP.Method + method_PUT :: repr HTTP.Method + method_DELETE :: repr HTTP.Method + method_TRACE :: repr HTTP.Method + method_CONNECT :: repr HTTP.Method + method_OPTIONS :: repr HTTP.Method + method_PATCH :: repr HTTP.Method + method_GET = method HTTP.methodGet + method_HEAD = method HTTP.methodHead + method_PUT = method HTTP.methodPut + method_POST = method HTTP.methodPost + method_DELETE = method HTTP.methodDelete + method_TRACE = method HTTP.methodTrace + method_CONNECT = method HTTP.methodConnect + method_OPTIONS = method HTTP.methodOptions + method_PATCH = method HTTP.methodPatch +-- * Class 'HTTP_Header' +class HTTP_Header repr where + header :: HTTP.HeaderName -> repr HeaderValue +type HeaderValue = BS.ByteString +-- * Class 'HTTP_Accept' +class HTTP_Accept repr where + accept :: ToMediaType mt a => Proxy mt -> repr (a -> BSL.ByteString) + {- + acceptCase :: Functor repr => Altern repr => [AcceptResponse repr a] -> repr BSL.ByteString + acceptCase [] = tina $> BSL.empty + acceptCase (AcceptResponse (mt,r) : rs) = try (accept mt r) <+> acceptCase rs + -} +{- +data AcceptResponse repr a = + forall mt. ToMediaType mt a => + AcceptResponse (Proxy mt, repr a) +-} +-- * Class 'HTTP_Query' +class HTTP_Query repr where + query :: QueryName -> repr [Maybe QueryValue] + queryFlag :: QueryName -> repr Bool +type QueryName = BS.ByteString +type QueryValue = BS.ByteString +-- * Class 'HTTP_Version' +class HTTP_Version repr where + version :: HTTP.HttpVersion -> repr HTTP.HttpVersion +-- * Class 'HTTP_Status' +class HTTP_Status repr where + status :: StatusIs -> repr HTTP.Status +-- ** Type 'StatusIs' +data StatusIs + = StatusIsInformational + | StatusIsSuccessful + | StatusIsRedirection + | StatusIsClientError + | StatusIsServerError + | StatusIs HTTP.Status + deriving (Eq, Ord, Show) +statusIs :: StatusIs -> (HTTP.Status -> Bool) +statusIs = \case + StatusIsInformational -> HTTP.statusIsInformational + StatusIsSuccessful -> HTTP.statusIsSuccessful + StatusIsRedirection -> HTTP.statusIsRedirection + StatusIsClientError -> HTTP.statusIsClientError + StatusIsServerError -> HTTP.statusIsServerError + StatusIs x -> \y -> HTTP.statusCode x == HTTP.statusCode y +-- * Class 'HTTP_Response' +class HTTP_Response repr where + response :: + ToMediaType mt a => + HTTP.Method -> + Proxy mt -> + repr (HTTP.Status -> HTTP.ResponseHeaders -> a -> Wai.Response) + +-- * Class 'HTTP_Endpoint' +class HTTP_Endpoint repr where + type Endpoint repr :: * -> * + endpoint :: + ToMediaType mt a => + HTTP.Method -> + Proxy mt -> + repr (Endpoint repr a) diff --git a/Language/Symantic/HTTP/Client.hs b/Language/Symantic/HTTP/Client.hs new file mode 100644 index 0000000..0b3717d --- /dev/null +++ b/Language/Symantic/HTTP/Client.hs @@ -0,0 +1,41 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE StrictData #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} +module Language.Symantic.HTTP.Client where + +-- import qualified Data.HashMap.Strict as HM +import Control.Applicative (Applicative(..), Alternative(..)) +import Control.Monad (Monad(..), (=<<), void) +import Data.Bool +import Data.Either (Either(..)) +import Data.Eq (Eq(..)) +import Data.Foldable (toList) +import Data.Function (($), (.), id) +import Data.String (IsString(..)) +import Data.Maybe (Maybe(..)) +import Data.Ord (Ord(..)) +import Data.Semigroup (Semigroup(..)) +import Data.Tuple (fst, snd) +import Prelude (print, undefined) +import System.IO (IO, putStrLn) +import Text.Show (Show(..)) +import qualified Control.Monad.Trans.Reader as R +-- import qualified Control.Monad.Trans.Writer as W +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BSL +import qualified Data.List as List +import qualified Data.Set as Set +import qualified Data.Text as Text +import qualified Network.HTTP.Media as Media +import qualified Network.HTTP.Types as HTTP +import qualified Network.Wai as Wai + +import Language.Symantic.HTTP.Media +import Language.Symantic.HTTP.API + + diff --git a/Language/Symantic/HTTP/HLint.hs b/Language/Symantic/HTTP/HLint.hs new file mode 120000 index 0000000..ab18269 --- /dev/null +++ b/Language/Symantic/HTTP/HLint.hs @@ -0,0 +1 @@ +../HLint.hs \ No newline at end of file diff --git a/Language/Symantic/HTTP/Layout.hs b/Language/Symantic/HTTP/Layout.hs new file mode 100644 index 0000000..47415b6 --- /dev/null +++ b/Language/Symantic/HTTP/Layout.hs @@ -0,0 +1,102 @@ +{-# LANGUAGE TypeFamilies #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} +module Language.Symantic.HTTP.Layout where + +import Control.Applicative (Applicative(..)) +import Data.Eq (Eq(..)) +import Data.Function (($), (.), id) +import Data.Ord (Ord(..)) +import Data.Proxy (Proxy(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (String) +import Data.Tree (Tree(..), Forest, drawForest) +import Text.Show (Show(..)) +import qualified Data.ByteString.Lazy as BSL +import qualified Data.List as List +import qualified Network.HTTP.Media as Media +import qualified Network.HTTP.Types as HTTP +import qualified Network.Wai as Wai + +import Language.Symantic.HTTP.Media +import Language.Symantic.HTTP.API + +-- * Type 'Layout' +newtype Layout a = Layout { unLayout :: App (Alt (Tree LayoutNode)) } +-- | Branches of alternatives matches. +type Alt = [] +-- | Keep the path in the 'Tree' +-- where to append new matchers; +-- in reverse order to simplify appending. +type App = [] + +runLayout :: Layout a -> Forest String +runLayout = ((show <$>) <$>) . collapseApp . unLayout + +instance Show (Layout a) where + show = drawForest . runLayout + +reLayout :: Layout a -> Layout b +reLayout (Layout l) = Layout l + +-- | Fold 'App' maintained for appending matchers; +-- to be done when there is no more appending. +collapseApp :: App (Alt (Tree LayoutNode)) -> Alt (Tree LayoutNode) +collapseApp = (`List.foldr` []) $ \ts acc -> + ((\(Node n ns) -> Node n (ns <> acc)) <$> ts) + +layoutOfNode :: LayoutNode -> Layout a +layoutOfNode = Layout . pure . pure . pure + +-- ** Type 'LayoutNode' +data LayoutNode + = LayoutNode_Segment Segment + | LayoutNode_Capture Name + | LayoutNode_CaptureAll + | LayoutNode_Header HTTP.HeaderName + | LayoutNode_Headers HTTP.RequestHeaders + | LayoutNode_Query QueryName + | LayoutNode_QueryFlag QueryName + | LayoutNode_QueryString HTTP.Query + | LayoutNode_Method HTTP.Method + | LayoutNode_Version HTTP.HttpVersion + | LayoutNode_Accept Media.MediaType + deriving (Eq, Ord, Show) + +instance Functor Layout where + fmap _f = reLayout +instance Applicative Layout where + pure _ = Layout [] + Layout x <*> Layout y = Layout $ x <> y +instance Altern Layout where + tina = Layout [] + Layout x <+> Layout y = + Layout [collapseApp x <> collapseApp y] + try = id +instance HTTP_Path Layout where + segment = layoutOfNode . LayoutNode_Segment + capture = layoutOfNode . LayoutNode_Capture + captureAll = layoutOfNode $ LayoutNode_CaptureAll +instance HTTP_Method Layout where + method = layoutOfNode . LayoutNode_Method +instance HTTP_Header Layout where + header = layoutOfNode . LayoutNode_Header +instance HTTP_Accept Layout where + accept mt = layoutOfNode $ LayoutNode_Accept (mediaType mt) +instance HTTP_Query Layout where + query = layoutOfNode . LayoutNode_Query + queryFlag = layoutOfNode . LayoutNode_QueryFlag +instance HTTP_Version Layout where + version = layoutOfNode . LayoutNode_Version +instance HTTP_Response Layout where + response me mt = + (\(Layout l::Layout (a -> BSL.ByteString)) -> + Layout l::Layout (HTTP.Status -> HTTP.ResponseHeaders -> a -> Wai.Response) + ) $ + method me *> accept mt +instance HTTP_Endpoint Layout where + type Endpoint Layout = Proxy + endpoint me mt = + (\(Layout l::Layout (a -> BSL.ByteString)) -> + Layout l::Layout (Endpoint Layout a)) $ + method me *> accept mt +instance HTTP_API Layout diff --git a/Language/Symantic/HTTP/Media.hs b/Language/Symantic/HTTP/Media.hs new file mode 100644 index 0000000..14290a8 --- /dev/null +++ b/Language/Symantic/HTTP/Media.hs @@ -0,0 +1,86 @@ +{-# LANGUAGE OverloadedStrings #-} +module Language.Symantic.HTTP.Media where + +import Data.Function (($), (.), id) +import Data.Proxy (Proxy(..)) +import Data.String (String) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BSL +import qualified Data.ByteString.Lazy.Char8 as BSLC +import qualified Data.Text as T +import qualified Data.Text.Encoding as T +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.Encoding as TL +import qualified Network.HTTP.Media as Media + +-- * Class 'MediaTypeable' +class MediaTypeable mt where + mediaType :: Proxy mt -> MediaType + mediaTypes :: Proxy mt -> [MediaType] + mediaTypes mt = [mediaType mt] +type MediaType = Media.MediaType + +charsetUTF8 :: MediaType -> MediaType +charsetUTF8 = (Media./: ("charset", "utf-8")) + +anyMediaType :: MediaType +anyMediaType = "*/*" + +-- ** Type 'JSON' +data JSON +json :: Proxy JSON +json = Proxy +instance MediaTypeable JSON where + mediaType _mt = charsetUTF8 $ "application"Media.//"json" + mediaTypes mt = [mediaType mt, "application"Media.//"json"] + +-- ** Type 'HTML' +data HTML +html :: Proxy HTML +html = Proxy +instance MediaTypeable HTML where + mediaType _mt = charsetUTF8 $ "text"Media.//"html" + mediaTypes mt = [mediaType mt, "text"Media.//"html"] + +-- ** Type 'FormUrlEncoded' +data FormUrlEncoded +formUrlEncoded :: Proxy FormUrlEncoded +formUrlEncoded = Proxy +instance MediaTypeable FormUrlEncoded where + mediaType _mt = "application"Media.//"x-www-form-urlencoded" + +-- ** Type 'OctetStream' +data OctetStream +octetStream :: Proxy OctetStream +octetStream = Proxy +instance MediaTypeable OctetStream where + mediaType _mt = "application"Media.//"octet-stream" + +-- ** Type 'PlainText' +data PlainText +plainText :: Proxy PlainText +plainText = Proxy +instance MediaTypeable PlainText where + mediaType _mt = charsetUTF8 $ "text"Media.//"plain" +instance MediaTypeable () where + mediaType _mt = mediaType (Proxy::Proxy PlainText) + +-- * Class 'ToMediaType' +class MediaTypeable mt => ToMediaType mt a where + toMediaType :: Proxy mt -> a -> BSL.ByteString +instance ToMediaType PlainText () where + toMediaType _mt () = BSL.empty +instance ToMediaType PlainText T.Text where + toMediaType _mt = BSL.fromStrict . T.encodeUtf8 +instance ToMediaType PlainText TL.Text where + toMediaType _mt = TL.encodeUtf8 +instance ToMediaType PlainText String where + toMediaType _mt = BSLC.pack +instance ToMediaType OctetStream BS.ByteString where + toMediaType _mt = BSL.fromStrict +instance ToMediaType OctetStream BSL.ByteString where + toMediaType _mt = id +{- TODO: uncomment when Web is imported +instance ToMediaType FormUrlEncoded a where + toMediaType _mt = Web.urlEncodeAsForm +-} diff --git a/Language/Symantic/HTTP/Router.hs b/Language/Symantic/HTTP/Router.hs new file mode 100644 index 0000000..bffb961 --- /dev/null +++ b/Language/Symantic/HTTP/Router.hs @@ -0,0 +1,252 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE StrictData #-} +{-# LANGUAGE TypeFamilies #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} +module Language.Symantic.HTTP.Router where + +import Control.Applicative (Applicative(..), Alternative(..)) +import Control.Monad (Monad(..), void) +import Data.Bool +import Data.Either (Either(..)) +import Data.Eq (Eq(..)) +import Data.Foldable (toList) +import Data.Function (($), (.), id) +import Data.Maybe (Maybe(..)) +import Data.Ord (Ord(..)) +import Data.Semigroup (Semigroup(..)) +import Data.String (IsString(..)) +import Data.Tuple (fst, snd) +import Prelude (Num(..), max, undefined) +import System.IO (IO) +import Text.Show (Show(..)) +import qualified Control.Monad.Trans.Reader as R +import qualified Data.ByteString as BS +import qualified Data.List as List +import qualified Data.Set as Set +import qualified Data.Text as Text +import qualified Network.HTTP.Media as Media +import qualified Network.HTTP.Types as HTTP +import qualified Network.Wai as Wai +import qualified Text.Megaparsec as P + +import Language.Symantic.HTTP.Media +import Language.Symantic.HTTP.API + +-- * Type 'Router' +type Router = R.ReaderT Wai.Request (P.Parsec RouteError RouteTokens) + +-- ** Type 'RouteError' +data RouteError + = RouteError_Accept_unsupported {-expected-}MediaType {-got-}HeaderValue + | RouteError_Query_param_not_a_boolean QueryName [Maybe BS.ByteString] + deriving (Eq, Ord, Show) +instance P.ShowErrorComponent RouteError where + showErrorComponent = show + +-- ** Type 'RoutingResult' +type RoutingResult = Either RoutingError +type RoutingError = P.ParseErrorBundle RouteTokens RouteError + +runRouter :: Router a -> Wai.Request -> RoutingResult a +runRouter rt rq = + let p = R.runReaderT rt rq in + P.runParser (p <* P.eof) "" $ + RouteToken_Segment <$> Wai.pathInfo rq + +runRouterApp :: Router Application -> Wai.Application +runRouterApp rt rq re = + case runRouter rt rq of + Right app -> runApplication app rq re + Left err -> re $ Wai.responseLBS + (HTTP.mkStatus 404 "Not Found") + [(HTTP.hContentType, Media.renderHeader $ mediaType plainText)] + (fromString $ P.errorBundlePretty err) + +{- +runRouterIO :: Show a => Router (IO a) -> Wai.Request -> IO () +runRouterIO rt rq = + case runRouter rt rq of + Left err -> putStrLn $ P.parseErrorPretty err + Right a -> print =<< a +-} + +-- * Type 'Application' +type Application = + Wai.Request -> + (RoutingResult Wai.Response -> IO Wai.ResponseReceived) -> + IO Wai.ResponseReceived + +runApplication :: Application -> Wai.Application +runApplication ra rq re = ra rq routingRespond + where + routingRespond :: RoutingResult Wai.Response -> IO Wai.ResponseReceived + routingRespond = \case + Right res -> re res + Left err -> re $ Wai.responseLBS + (HTTP.mkStatus 404 "Not Found") + [(HTTP.hContentType, Media.renderHeader $ mediaType plainText)] + (fromString $ P.errorBundlePretty err) + +-- * Type 'RouteTokens' +type RouteTokens = [RouteToken] +instance P.Stream RouteTokens where + type Token RouteTokens = RouteToken + type Tokens RouteTokens = RouteTokens + take1_ = List.uncons + takeN_ n s | n <= 0 = Just ([], s) + | List.null s = Nothing + | otherwise = Just (List.splitAt n s) + takeWhile_ = List.span + tokenToChunk _ps = pure + tokensToChunk _ps = id + chunkToTokens _ps = id + chunkLength _ps = List.length + chunkEmpty _ps = List.null + showTokens _s toks = List.intercalate ", " $ toList $ show <$> toks + reachOffset o pos@P.PosState{..} = + ( spos + , List.head $ (show <$> inp)<>["End"] + , pos + { P.pstateInput = inp + , P.pstateOffset = max o pstateOffset + , P.pstateSourcePos = spos + }) + where + d = o - pstateOffset + inp = List.drop d pstateInput + line | d == 0 = P.sourceLine pstateSourcePos + | otherwise = P.sourceLine pstateSourcePos <> P.mkPos d + spos = pstateSourcePos{P.sourceLine = line} +instance P.Stream Path where + type Token Path = Segment + type Tokens Path = [Segment] + take1_ = List.uncons + takeN_ n s | n <= 0 = Just ([], s) + | List.null s = Nothing + | otherwise = Just (List.splitAt n s) + takeWhile_ = List.span + tokenToChunk _ps = pure + tokensToChunk _ps = id + chunkToTokens _ps = id + chunkLength _ps = List.length + chunkEmpty _ps = List.null + showTokens _s toks = List.intercalate ", " $ toList $ Text.unpack <$> toks + reachOffset o pos@P.PosState{..} = + ( spos + , List.head $ (show <$> inp)<>["End"] + , pos + { P.pstateInput = inp + , P.pstateOffset = max o pstateOffset + , P.pstateSourcePos = spos + } + ) + where + d = o - pstateOffset + inp = List.drop d pstateInput + spos = pstateSourcePos{P.sourceLine = P.sourceLine pstateSourcePos <> P.mkPos d} + +-- ** Type 'RouteToken' +data RouteToken + = RouteToken_Segment Segment + | RouteToken_Header HTTP.HeaderName + | RouteToken_Headers HTTP.RequestHeaders + | RouteToken_Query QueryName + | RouteToken_QueryString HTTP.Query + | RouteToken_Method HTTP.Method + | RouteToken_Version HTTP.HttpVersion + deriving (Eq, Ord, Show) + +unRouteToken_Segment :: RouteToken -> Segment +unRouteToken_Segment (RouteToken_Segment x) = x +unRouteToken_Segment _ = undefined + +instance Altern Router where + tina = empty + x <+> y = P.try x <|> y + try = P.try +instance HTTP_Path Router where + segment = void . P.single . RouteToken_Segment + capture _n = unRouteToken_Segment <$> P.anySingle + captureAll = P.many $ unRouteToken_Segment <$> P.anySingle +instance HTTP_Method Router where + method exp = do + got <- R.asks Wai.requestMethod + inp <- P.getInput + P.setInput [RouteToken_Method got] + ret <- (`P.token` Set.singleton (P.Tokens $ pure $ RouteToken_Method exp)) $ \_tok -> + if got == exp + then Just got + else Nothing + P.setInput inp + return ret +instance HTTP_Header Router where + header exp = do + got <- R.asks Wai.requestHeaders + inp <- P.getInput + P.setInput [RouteToken_Headers got] + ret <- (`P.token` Set.singleton (P.Tokens $ pure $ RouteToken_Header exp)) $ \_tok -> + List.lookup exp got + P.setInput inp + return ret +instance HTTP_Accept Router where + accept exp = do + h <- header HTTP.hAccept + case Media.parseAccept h of + Just got | mediaType exp`Media.matches`got -> return $ toMediaType exp + _ -> P.fancyFailure $ Set.singleton $ + P.ErrorCustom $ RouteError_Accept_unsupported (mediaType exp) h +instance HTTP_Query Router where + query exp = do + got <- R.asks Wai.queryString + inp <- P.getInput + P.setInput [RouteToken_QueryString got] + ret <- (`P.token` Set.singleton (P.Tokens $ pure $ RouteToken_Query exp)) $ \_tok -> + case List.filter ((== exp) . fst) got of + [] -> Nothing + hs -> Just $ snd <$> hs + P.setInput inp + return ret + queryFlag n = do + vs <- query n + case vs of + [] -> return True + [Nothing] -> return True + [Just "0"] -> return False + [Just "false"] -> return False + [Just "1"] -> return True + [Just "true"] -> return True + _ -> P.fancyFailure $ Set.singleton $ + P.ErrorCustom $ RouteError_Query_param_not_a_boolean n vs +instance HTTP_Version Router where + version exp = do + got <- R.asks Wai.httpVersion + inp <- P.getInput + P.setInput [RouteToken_Version got] + ret <- (`P.token` Set.singleton (P.Tokens $ pure $ RouteToken_Version exp)) $ \_tok -> + if got == exp + then Just got + else Nothing + P.setInput inp + return ret +-- ** Type 'RouterEndpoint' +newtype RouterEndpoint a + = RouterEndpoint (HTTP.Status -> HTTP.ResponseHeaders -> a -> Wai.Response) +instance HTTP_Endpoint Router where + type Endpoint Router = RouterEndpoint + endpoint expMethod expAccept = do + m <- if expMethod == HTTP.methodGet + then method HTTP.methodHead <+> method HTTP.methodGet + else method expMethod + h <- header HTTP.hAccept + let mt = mediaType expAccept + case Media.parseAccept h of + Just got | mediaType expAccept`Media.matches`got -> + return $ RouterEndpoint $ \st hs a -> Wai.responseLBS st + ((HTTP.hContentType, Media.renderHeader mt):hs) + (if m == HTTP.methodHead then "" else toMediaType expAccept a) + _ -> P.fancyFailure $ Set.singleton $ + P.ErrorCustom $ RouteError_Accept_unsupported mt h +instance HTTP_API Router diff --git a/Language/Symantic/HTTP/Sym.hs b/Language/Symantic/HTTP/Sym.hs new file mode 100644 index 0000000..806af88 --- /dev/null +++ b/Language/Symantic/HTTP/Sym.hs @@ -0,0 +1,143 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE ExistentialQuantification #-} +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE StrictData #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +module Language.Symantic.HTTP.Sym + ( module Language.Symantic.HTTP.Sym + , Functor(..), (<$>), ($>) + , Applicative(..) + , Alternative(..) + ) where + +import Control.Applicative (Applicative(..), Alternative(..)) +import Data.Bool +import Data.Eq (Eq(..)) +import Data.Function (($), (.), id) +import Data.Functor (Functor(..), (<$>), ($>), (<$)) +import Data.Maybe (Maybe(..)) +import Data.Ord (Ord(..)) +import Data.Proxy (Proxy(..)) +import Data.String (String) +import Text.Show (Show(..)) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BSL +import qualified Data.ByteString.Lazy.Char8 as BSLC +import qualified Data.Text as T +import qualified Data.Text.Encoding as T +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.Encoding as TL +import qualified Network.HTTP.Media as Media +import qualified Network.HTTP.Types as HTTP +import qualified Network.Wai as Wai + +-- * Class 'HTTP_Server' +class + ( Applicative repr + , Altern repr + , HTTP_Path repr + , HTTP_Method repr + , HTTP_Header repr + , HTTP_Accept repr + , HTTP_Response repr + , HTTP_Query repr + , HTTP_Version repr + ) => HTTP_Server repr + +-- * Class 'Altern' +class Altern repr where + -- | There Is No Alternative + tina :: repr a + (<+>) :: repr a -> repr a -> repr a; infixl 3 <+> + try :: repr a -> repr a + choice :: [repr a] -> repr a + choice [] = tina + choice (r:rs) = try r <+> choice rs +-- * Class 'HTTP_Path' +class HTTP_Path repr where + segment :: Segment -> repr () + capture :: Name -> repr Segment + captureAll :: repr [Segment] +-- * Class 'HTTP_Method' +class HTTP_Method repr where + method :: HTTP.Method -> repr HTTP.Method + method_GET :: repr HTTP.Method + method_POST :: repr HTTP.Method + method_HEAD :: repr HTTP.Method + method_PUT :: repr HTTP.Method + method_DELETE :: repr HTTP.Method + method_TRACE :: repr HTTP.Method + method_CONNECT :: repr HTTP.Method + method_OPTIONS :: repr HTTP.Method + method_PATCH :: repr HTTP.Method + method_GET = method HTTP.methodGet + method_HEAD = method HTTP.methodHead + method_PUT = method HTTP.methodPut + method_POST = method HTTP.methodPost + method_DELETE = method HTTP.methodDelete + method_TRACE = method HTTP.methodTrace + method_CONNECT = method HTTP.methodConnect + method_OPTIONS = method HTTP.methodOptions + method_PATCH = method HTTP.methodPatch +-- * Class 'HTTP_Header' +class HTTP_Header repr where + header :: HTTP.HeaderName -> repr HeaderValue +-- * Class 'HTTP_Response' +class HTTP_Response repr where + response :: + ToMediaType mt a => + HTTP.Method -> + Proxy mt -> + repr (HTTP.Status -> HTTP.ResponseHeaders -> a -> Wai.Response) +-- * Class 'HTTP_Accept' +data AcceptResponse repr a = + forall mt. ToMediaType mt a => + AcceptResponse (Proxy mt, repr a) +class HTTP_Accept repr where + accept :: ToMediaType mt a => Proxy mt -> repr (a -> BSL.ByteString) + {- + acceptCase :: Functor repr => Altern repr => [AcceptResponse repr a] -> repr BSL.ByteString + acceptCase [] = tina $> BSL.empty + acceptCase (AcceptResponse (mt,r) : rs) = try (accept mt r) <+> acceptCase rs + -} +-- * Class 'HTTP_Query' +class HTTP_Query repr where + query :: QueryName -> repr [Maybe QueryValue] + queryFlag :: QueryName -> repr Bool +-- * Class 'HTTP_Version' +class HTTP_Version repr where + version :: HTTP.HttpVersion -> repr HTTP.HttpVersion +-- * Class 'HTTP_Status' +class HTTP_Status repr where + status :: StatusIs -> repr HTTP.Status +-- ** Type 'StatusIs' +data StatusIs + = StatusIsInformational + | StatusIsSuccessful + | StatusIsRedirection + | StatusIsClientError + | StatusIsServerError + | StatusIs HTTP.Status + deriving (Eq, Ord, Show) +statusIs :: StatusIs -> (HTTP.Status -> Bool) +statusIs = \case + StatusIsInformational -> HTTP.statusIsInformational + StatusIsSuccessful -> HTTP.statusIsSuccessful + StatusIsRedirection -> HTTP.statusIsRedirection + StatusIsClientError -> HTTP.statusIsClientError + StatusIsServerError -> HTTP.statusIsServerError + StatusIs x -> \y -> HTTP.statusCode x == HTTP.statusCode y + +type Name = String +type Value = String +type Segment = T.Text +type Path = [Segment] +-- type Headers = HM.HashMap HTTP.HeaderName [HeaderValue] +type HeaderValue = BS.ByteString +-- type Query = HM.HashMap QueryName [QueryValue] +type QueryName = BS.ByteString +type QueryValue = BS.ByteString +type MediaType = Media.MediaType diff --git a/stack.yaml b/stack.yaml new file mode 100644 index 0000000..094798a --- /dev/null +++ b/stack.yaml @@ -0,0 +1,14 @@ +resolver: lts-12.26 +#resolver: lts-11.22 +packages: +- '.' +- location: '../treemap' + extra-dep: true +extra-deps: +- http-api-data-0.4@sha256:ad69f7cd0d1e7723abfbed6f88ac987bdf75a402b29de161eb867c6131c9d427 +- megaparsec-7.0.4@sha256:a7397151601cbe6b8f831f8bdad1a10118dcd6d9a7ee50d6bbdcfbd1181b4ba2 +#- location: '/home/julm/src/http-api-data-0.3.7.2' +# extra-dep: true +#allow-newer: true +nix: + packages: [zlib] diff --git a/symantic-http.cabal b/symantic-http.cabal new file mode 100644 index 0000000..a0b8570 --- /dev/null +++ b/symantic-http.cabal @@ -0,0 +1,115 @@ +name: symantic-http +-- PVP: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.0.0.20181229 +category: Protocol +synopsis: Library for reading, validating and writing a subset of the HTTP format. +description: Symantics for an approximative implementation of HTTP. +extra-doc-files: +license: GPL-3 +license-file: COPYING +stability: experimental +author: Julien Moutinho +maintainer: Julien Moutinho +bug-reports: Julien Moutinho +-- homepage: + +build-type: Simple +cabal-version: 1.24 +tested-with: GHC==8.4.3 +extra-source-files: + stack.yaml +extra-tmp-files: + +Source-Repository head + location: git://git.autogeree.net/symantic-http + type: git + +Library + exposed-modules: + Language.Symantic.HTTP + Language.Symantic.HTTP.API + Language.Symantic.HTTP.Media + Language.Symantic.HTTP.Router + Language.Symantic.HTTP.Layout + default-language: Haskell2010 + default-extensions: + FlexibleContexts + FlexibleInstances + LambdaCase + MultiParamTypeClasses + NamedFieldPuns + NoImplicitPrelude + RecordWildCards + ScopedTypeVariables + TupleSections + -- TypeFamilies + ghc-options: + -Wall + -Wincomplete-uni-patterns + -Wincomplete-record-updates + -fno-warn-tabs + -- -fhide-source-paths + build-depends: + base >= 4.10 && < 5 + , time + , bytestring >= 0.10 + , containers >= 0.5 + -- , data-default-class >= 0.1 + -- , filepath >= 1.4 + , hashable >= 1.2.6 + , http-api-data >= 0.4 + , http-client >= 0.5.12 + , http-types >= 0.12 + , http-media >= 0.7 + , megaparsec >= 7.0.4 + , network-uri >= 2.6 + -- , resourcet >= 1.1.11 + -- , safe >= 0.3 + , text >= 1.2 + , transformers >= 0.5 + , unordered-containers >= 0.2.8 + , wai >= 3.2.1.1 + -- , wai-app-static >= 3.1.6.1 + , warp + -- pkgconfig-depends: zlib + -- extra-libraries: z + +-- Test-Suite symantic-xml-test +-- type: exitcode-stdio-1.0 +-- hs-source-dirs: test +-- main-is: Main.hs +-- other-modules: +-- Golden +-- -- HUnit +-- -- QuickCheck +-- default-language: Haskell2010 +-- default-extensions: +-- LambdaCase +-- NamedFieldPuns +-- NoImplicitPrelude +-- RecordWildCards +-- ViewPatterns +-- ghc-options: +-- -Wall +-- -Wincomplete-uni-patterns +-- -Wincomplete-record-updates +-- -fno-warn-tabs +-- -fhide-source-paths +-- build-depends: +-- symantic-xml +-- , base >= 4.10 && < 5 +-- , bytestring >= 0.10 +-- , containers >= 0.5 +-- , deepseq >= 1.4 +-- , filepath >= 1.4 +-- , megaparsec >= 6.3 +-- , tasty >= 0.11 +-- , tasty-golden >= 2.3 +-- , text >= 1.2 +-- , transformers >= 0.4 +-- , treeseq >= 1.0 +-- -- , QuickCheck >= 2.0 +-- -- , tasty-hunit +-- -- , tasty-quickcheck -- 2.47.0