commit b06a92c7de5fe5a5045ac98087a80b6834fca443 Author: pena Date: Thu Jan 4 16:59:51 2024 +0100 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e35d885 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +_build diff --git a/.ocamlformat b/.ocamlformat new file mode 100644 index 0000000..1701629 --- /dev/null +++ b/.ocamlformat @@ -0,0 +1,43 @@ +version=0.28.1 +assignment-operator=end-line +break-cases=fit +break-fun-decl=wrap +break-fun-sig=wrap +break-infix=wrap +break-infix-before-func=false +break-separators=before +break-sequences=true +cases-exp-indent=2 +cases-matching-exp-indent=normal +doc-comments=before +doc-comments-padding=2 +doc-comments-tag-only=default +dock-collection-brackets=false +exp-grouping=preserve +field-space=loose +if-then-else=compact +indicate-multiline-delimiters=space +indicate-nested-or-patterns=unsafe-no +infix-precedence=indent +leading-nested-match-parens=false +let-and=sparse +let-binding-spacing=compact +let-module=compact +margin=80 +max-indent=2 +module-item-spacing=sparse +ocaml-version=4.14.0 +ocp-indent-compat=false +parens-ite=false +parens-tuple=always +parse-docstrings=true +sequence-blank-line=preserve-one +sequence-style=terminator +single-case=compact +space-around-arrays=true +space-around-lists=true +space-around-records=true +space-around-variants=true +type-decl=sparse +wrap-comments=false +wrap-fun-args=true diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..d9cd2e7 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1 @@ +## unreleased diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..4ef32f0 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,651 @@ +GNU Affero General Public License +================================= + +_Version 3, 19 November 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: **(1)** assert copyright on the software, and **(2)** offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU Affero General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a “modified version” of the +earlier work or a work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based +on the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” +to the extent that it includes a convenient and prominently visible +feature that **(1)** displays an appropriate copyright notice, and **(2)** +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work +for making modifications to it. “Object code” means any non-source +form of a work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The “System Libraries” of an executable work include anything, other +than the work as a whole, that **(a)** is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and **(b)** serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +“Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +The Corresponding Source for a work in source code form is that +same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified +it, and giving a relevant date. +* **b)** The work must carry prominent notices stating that it is +released under this License and any conditions added under section 7. +This requirement modifies the requirement in section 4 to +“keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this +License to anyone who comes into possession of a copy. This +License will therefore apply, along with any applicable section 7 +additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no +permission to license the work in any other way, but it does not +invalidate such permission if you have separately received it. +* **d)** If the work has interactive user interfaces, each must display +Appropriate Legal Notices; however, if the Program has interactive +interfaces that do not display Appropriate Legal Notices, your +work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by the +Corresponding Source fixed on a durable physical medium +customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by a +written offer, valid for at least three years and valid for as +long as you offer spare parts or customer support for that product +model, to give anyone who possesses the object code either **(1)** a +copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical +medium customarily used for software interchange, for a price no +more than your reasonable cost of physically performing this +conveying of source, or **(2)** access to copy the +Corresponding Source from a network server at no charge. +* **c)** Convey individual copies of the object code with a copy of the +written offer to provide the Corresponding Source. This +alternative is allowed only occasionally and noncommercially, and +only if you received the object code with such an offer, in accord +with subsection 6b. +* **d)** Convey the object code by offering access from a designated +place (gratis or for a charge), and offer equivalent access to the +Corresponding Source in the same way through the same place at no +further charge. You need not require recipients to copy the +Corresponding Source along with the object code. If the place to +copy the object code is a network server, the Corresponding Source +may be on a different server (operated by you or a third party) +that supports equivalent copying facilities, provided you maintain +clear directions next to the object code saying where to find the +Corresponding Source. Regardless of what server hosts the +Corresponding Source, you remain obligated to ensure that it is +available for as long as needed to satisfy these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided +you inform other peers where the object code and Corresponding +Source of the work are being offered to the general public at no +charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A “User Product” is either **(1)** a “consumer product”, which means any +tangible personal property which is normally used for personal, family, +or household purposes, or **(2)** anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, “normally used” refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the +terms of sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or +author attributions in that material or in the Appropriate Legal +Notices displayed by works containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or +requiring that modified versions of such material be marked in +reasonable ways as different from the original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or +authors of the material; or +* **e)** Declining to grant rights under trademark law for use of some +trade names, trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that +material by anyone who conveys the material (or modified versions of +it) with contractual assumptions of liability to the recipient, for +any liability that these contractual assumptions directly impose on +those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated **(a)** +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and **(b)** permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either **(1)** cause the Corresponding Source to be so +available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is “discriminatory” if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license **(a)** in connection with copies of the covered work +conveyed by you (or copies made from those copies), or **(b)** primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License “or any later version” applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +_END OF TERMS AND CONDITIONS_ + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the “copyright” line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a “Source” link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e529b93 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Drame + +[Drame] is an [OCaml] web framework. + +## Installation + +`drame` can be installed with [opam]: + +```sh +opam install drame +``` + +If you don't have `opam`, you can install it following the [how to install opam] guide. + +If you can't or don't want to use `opam`, consult the [opam file] for build instructions. + +## About + +- [LICENSE] +- [CHANGELOG] + +[CHANGELOG]: ./CHANGES.md +[example]: ./example +[LICENSE]: ./LICENSE.md +[opam file]: ./drame.opam + +[how to install opam]: https://opam.ocaml.org/doc/Install.html +[OCaml]: https://ocaml.org +[opam]: https://opam.ocaml.org +[drame]: https://forge.kumikode.org/kumikode/drame diff --git a/drame.opam b/drame.opam new file mode 100644 index 0000000..7120e80 --- /dev/null +++ b/drame.opam @@ -0,0 +1,42 @@ +# This file is generated by dune, edit dune-project instead +opam-version: "2.0" +synopsis: "OCaml web framework" +description: "Drame is an OCaml web framework." +maintainer: ["pena "] +authors: ["pena "] +license: "AGPL-3.0-or-later" +tags: ["drame" "TODO" "TODO" "TODO" "TODO"] +homepage: "https://forge.kumikode.org/kumikode/drame" +bug-reports: "https://forge.kumikode.org/kumikode/drame/issues" +depends: [ + "dune" {>= "3.0"} + "directories" + "h2" + "htmlit" + "httpcats" + "js_of_ocaml-compiler" + "miou" + "prelude" + "ptime" + "scfg" + "tyxml" + "uri" + "uuidm" + "ocaml" {>= "5.0.0"} + "odoc" {with-doc} +] +build: [ + ["dune" "subst"] {dev} + [ + "dune" + "build" + "-p" + name + "-j" + jobs + "@install" + "@runtest" {with-test} + "@doc" {with-doc} + ] +] +dev-repo: "git+https://forge.kumikode.org/kumikode/drame.git" diff --git a/dune-project b/dune-project new file mode 100644 index 0000000..3504c24 --- /dev/null +++ b/dune-project @@ -0,0 +1,42 @@ +(lang dune 3.0) + +(implicit_transitive_deps false) + +(name drame) + +(license AGPL-3.0-or-later) + +(authors "pena ") + +(maintainers "pena ") + +(source + (uri git+https://forge.kumikode.org/kumikode/drame.git)) + +(homepage https://forge.kumikode.org/kumikode/drame) + +(bug_reports https://forge.kumikode.org/kumikode/drame/issues) + +(generate_opam_files true) + +(package + (name drame) + (synopsis "OCaml web framework") + (description "Drame is an OCaml web framework.") + (tags + (drame TODO TODO TODO TODO)) + (depends + directories + h2 + htmlit + httpcats + js_of_ocaml-compiler + miou + prelude + ptime + scfg + tyxml + uri + uuidm + (ocaml + (>= 5.0.0)))) diff --git a/example/dune b/example/dune new file mode 100644 index 0000000..a342d72 --- /dev/null +++ b/example/dune @@ -0,0 +1,6 @@ +(executable + (name main) + (modules main) + (flags + (:standard -open Prelude)) + (libraries drame fmt prelude scfg)) diff --git a/example/main.ml b/example/main.ml new file mode 100644 index 0000000..47a6399 --- /dev/null +++ b/example/main.ml @@ -0,0 +1,80 @@ +open Drame +open Tyxml +open Tyxml.Html + +module App_id = struct + let qualifier = "org" + + let organization = "drame" + + let application = "drame" +end + +module Server = Server.Make (App_id) + +let template_html (_request : Request.t) ~title ~body = + let styles = + List.map + (fun s -> link ~rel:[ `Stylesheet ] ~href:(Fmt.str "/assets/css/%s" s) ()) + [ "style.css" ] + in + let head = head (Html.title title) styles in + let body = Html.body [ main [ h1 [ title ]; body ] ] in + let a = [ a_lang "en" ] in + let tyxml_doc = html ~a head body in + Html_doc.of_tyxml tyxml_doc + +let hello = + let body = txt "How are you doing?" in + fun ~name -> + let title = Fmt.kstr txt "Hello %s!" name in + fun request -> + let doc = template_html request ~title ~body in + let content = Content.Html doc in + Ok content + +let hello_q request = + let name = Request.query request "name" in + let name = Option.value name ~default:"World" in + let msg = Fmt.kstr txt "Hello %s!" name in + let doc = template_html request ~title:msg ~body:msg in + let content = Content.Html doc in + Ok content + +let config = + let title = txt "Configuration" in + let body = Fmt.kstr txt "%a" Scfg.Pp.config Server.config in + fun request -> + let doc = template_html request ~title ~body in + let content = Content.Html doc in + Ok content + +let not_found = + let title = txt "404 Not Found" in + let body = txt "Ooops :S" in + fun request -> + let content = template_html request ~title ~body in + Error (Status.Not_found, content) + +let style = + let sheet = + {css|body { + color: #ebb2bf; + background-color: #0f1312; +}|css} + in + let content = Content.Unsafe { content = sheet; mimetype = Text_css } in + fun _request -> Ok content + +let handler route = + Fmt.pr "[request] %a@\n" Route.pp route; + Fmt.flush Fmt.stdout (); + match route with + | [||] -> hello ~name:"World" + | [| "assets"; "css"; "style.css" |] -> style + | [| "config" |] -> config + | [| "hello"; name |] -> hello ~name + | [| "helloq" |] -> hello_q + | _ -> not_found + +let () = Server.run ~handler diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..92a5619 --- /dev/null +++ b/shell.nix @@ -0,0 +1,43 @@ +{ pkgs ? import (builtins.fetchTarball { + url = "https://github.com/NixOS/nixpkgs/archive/master.tar.gz"; + }) {} +}: + +let + ocamlPackages = pkgs.ocaml-ng.ocamlPackages_5_4.overrideScope (self: super: { + htmlit = ocamlPackages.buildTopkgPackage rec { + pname = "htmlit"; + version = "0.2.0"; + + minimalOCamlVersion = "4.14.0"; + + src = pkgs.fetchzip { + url = "https://erratique.ch/software/htmlit/releases/htmlit-${version}.tbz"; + hash = "sha256-vE6XY7INMCwQztZqKhJaxpNF0o5+NeutJM5XobshClE="; + }; + }; + }); +in + +pkgs.mkShell { + nativeBuildInputs = with ocamlPackages; [ + dune_3 + findlib + merlin + ocaml + ocamlformat + odoc + ]; + buildInputs = with ocamlPackages; [ + httpcats + js_of_ocaml-compiler + miou + ptime + htmlit + scfg + tyxml + uri + uuidm + directories + ]; +} diff --git a/src/content.ml b/src/content.ml new file mode 100644 index 0000000..3c372e7 --- /dev/null +++ b/src/content.ml @@ -0,0 +1,18 @@ +type t = + (* + | Css of string Css.css + *) + | Html of Html_doc.t + | JavaScript of Js_of_ocaml_compiler.Javascript.program + | Txt of string + | Unsafe of + { content : string + ; mimetype : Mimetype.t + } + +let to_mimetype = function + (* | Css _ -> Mimetype.Text_css *) + | Html _ -> Mimetype.Text_html + | JavaScript _ -> Mimetype.Text_javascript + | Txt _ -> Mimetype.Text_plain + | Unsafe { mimetype; _ } -> mimetype diff --git a/src/content.mli b/src/content.mli new file mode 100644 index 0000000..4d36cb1 --- /dev/null +++ b/src/content.mli @@ -0,0 +1,13 @@ +type t = + (* + | Css of string Css.css + *) + | Html of Html_doc.t + | JavaScript of Js_of_ocaml_compiler.Javascript.program + | Txt of string + | Unsafe of + { content : string + ; mimetype : Mimetype.t + } + +val to_mimetype : t -> Mimetype.t diff --git a/src/cookie.ml b/src/cookie.ml new file mode 100644 index 0000000..01784a8 --- /dev/null +++ b/src/cookie.ml @@ -0,0 +1,60 @@ +let pair_of_string s = + let ss = String.split_on_char '=' s in + match ss with [ a; b ] -> Some (String.trim a, String.trim b) | _ -> None + +let pairs_of_header header = + let ss = String.split_on_char ';' header in + List.filter_map pair_of_string ss + +let all_cookies request = + let headers = Request.headers request "Cookie" in + List.concat_map pairs_of_header headers + +let get ~decrypt:_ request id = + let path = Some "/" in + let secure = true in + let cookie_prefix = + if true then "" + else + match (path, secure) with + | Some "/", true -> "__Host-" + | _, true -> "__Secure-" + | _, _ -> "" + in + let name = Fmt.str "%s%s" cookie_prefix id in + let cookies = all_cookies request in + let v = List.find_opt (fun (name', _) -> String.equal name name') cookies in + Option.map snd v + +let to_set_cookie ~max_age ~path name value = + let max_age = + match max_age with + | None -> "" + | Some seconds -> Fmt.str "; Max-Age=%.0f" (floor seconds) + in + + let path = + match path with None -> "" | Some path -> Fmt.str "; Path=%s" path + in + + let secure = if true then "" else "; Secure" in + let http_only = "; HttpOnly" in + let same_site = "; SameSite=Lax" in + + Fmt.str "%s=%s%s%s%s%s%s" name value max_age path secure http_only same_site + +let make_set_headers ~encrypt:(_ : bool) ~max_age ~key ~value = + let path = Some "/" in + let secure = true in + let cookie_prefix = + if true then "" + else + match (path, secure) with + | Some "/", true -> "__Host-" + | _, true -> "__Secure-" + | _, _ -> "" + in + let name = Fmt.str "%s%s" cookie_prefix key in + + let set_cookie = to_set_cookie ~max_age ~path name value in + [ ("Set-Cookie", set_cookie) ] diff --git a/src/cookie.mli b/src/cookie.mli new file mode 100644 index 0000000..b3f162a --- /dev/null +++ b/src/cookie.mli @@ -0,0 +1,8 @@ +val get : decrypt:bool -> Request.t -> string -> string option + +val make_set_headers : + encrypt:bool + -> max_age:float option + -> key:string + -> value:string + -> (string * string) list diff --git a/src/dune b/src/dune new file mode 100644 index 0000000..063c261 --- /dev/null +++ b/src/dune @@ -0,0 +1,41 @@ +(library + (public_name drame) + (modules + content + cookie + form + handler + html_doc + meth + mimetype + request + response + route + server + session + status + syntax) + (libraries + bigstringaf + bstr + directories + fmt + fpath + h1 + h2 + httpcats + (re_export js_of_ocaml-compiler) + miou + miou.unix + prelude + ptime + ptime.clock.os + (re_export scfg) + (re_export tyxml) + (re_export tyxml.functor) + htmlit + unix + uri + uuidm) + (flags + (:standard -open Prelude))) diff --git a/src/form.ml b/src/form.ml new file mode 100644 index 0000000..d9fc92f --- /dev/null +++ b/src/form.ml @@ -0,0 +1,13 @@ +let form request = + match Request.header request "Content-Type" with + | None -> Error "missing content type" + | Some content_type -> ( + match String.split_on_char ';' content_type with + | "application/x-www-form-urlencoded" :: _tl -> + let body = request.get_body () in + let query = Uri.query_of_encoded body in + let form = + List.map (fun (name, values) -> (name, String.concat "," values)) query + in + Ok (List.sort (Pair.compare String.compare String.compare) form) + | _content_type -> Error "wrong content type" ) diff --git a/src/form.mli b/src/form.mli new file mode 100644 index 0000000..7555aa0 --- /dev/null +++ b/src/form.mli @@ -0,0 +1 @@ +val form : Request.t -> ((string * string) list, string) result diff --git a/src/handler.ml b/src/handler.ml new file mode 100644 index 0000000..9e2e974 --- /dev/null +++ b/src/handler.ml @@ -0,0 +1 @@ +type t = Route.t -> Request.t -> Response.t diff --git a/src/handler.mli b/src/handler.mli new file mode 100644 index 0000000..9e2e974 --- /dev/null +++ b/src/handler.mli @@ -0,0 +1 @@ +type t = Route.t -> Request.t -> Response.t diff --git a/src/html_doc.ml b/src/html_doc.ml new file mode 100644 index 0000000..3059671 --- /dev/null +++ b/src/html_doc.ml @@ -0,0 +1,9 @@ +type t = string + +let to_string = Fun.id + +let of_tyxml doc = + let indent = false in + Fmt.str "%a@\n" (Tyxml.Html.pp ~indent ()) doc + +let of_htmlit doc = Htmlit.El.to_string ~doctype:true doc diff --git a/src/html_doc.mli b/src/html_doc.mli new file mode 100644 index 0000000..1dc4a84 --- /dev/null +++ b/src/html_doc.mli @@ -0,0 +1,7 @@ +type t + +val to_string : t -> string + +val of_tyxml : Tyxml.Html.doc -> t + +val of_htmlit : Htmlit.El.html -> t diff --git a/src/meth.ml b/src/meth.ml new file mode 100644 index 0000000..b26d980 --- /dev/null +++ b/src/meth.ml @@ -0,0 +1,21 @@ +type t = + | Connect + | Delete + | Get + | Head + | Options + | Post + | Put + | Trace + | Other of string + +let of_httpcats = function + | `CONNECT -> Connect + | `DELETE -> Delete + | `GET -> Get + | `HEAD -> Head + | `OPTIONS -> Options + | `POST -> Post + | `PUT -> Put + | `TRACE -> Trace + | `Other s -> Other s diff --git a/src/meth.mli b/src/meth.mli new file mode 100644 index 0000000..50bb802 --- /dev/null +++ b/src/meth.mli @@ -0,0 +1,12 @@ +type t = + | Connect + | Delete + | Get + | Head + | Options + | Post + | Put + | Trace + | Other of string + +val of_httpcats : H2.Method.t -> t diff --git a/src/mimetype.ml b/src/mimetype.ml new file mode 100644 index 0000000..13ae549 --- /dev/null +++ b/src/mimetype.ml @@ -0,0 +1,71 @@ +type t = + | Audio_aac + | Audio_midi + | Audio_mp3 + | Audio_wav + | Audio_weba + | Application_epub + | Application_json + | Application_jsonld + | Application_gz + | Application_tar + | Application_xml + | Application_atom_xml + | Application_zip + | Application_7z + | Image_bmp + | Image_jpeg + | Image_gif + | Image_ico + | Image_png + | Image_svg + | Image_webp + | Font_ttf + | Text_css + | Text_csv + | Text_html + | Text_javascript + | Text_plain + | Unsafe of string * bool + | Video_avi + | Video_mp4 + | Video_webm + +let pp fmt mimetype = + Fmt.string fmt + ( match mimetype with + | Audio_aac -> "audio/aac" + | Audio_midi -> "audio/midi" + | Audio_mp3 -> "audio/mpeg" + | Audio_wav -> "audio/wav" + | Audio_weba -> "audio/webm" + | Application_epub -> "application/epub+zip" + | Application_json -> "application/json" + | Application_jsonld -> "application/ld+json" + | Application_gz -> "application/gzip" + | Application_tar -> "application/x-tar" + | Application_xml -> "application/xml" + | Application_atom_xml -> "application/atom+xml" + | Application_zip -> "application/zip" + | Application_7z -> "application/x-7z-compressed" + | Image_bmp -> "image/bmp" + | Image_jpeg -> "image/jpeg" + | Image_gif -> "image/gif" + | Image_ico -> "image/vnd.microsoft.icon" + | Image_png -> "image/png" + | Image_svg -> "image/svg+xml" + | Image_webp -> "image/webp" + | Font_ttf -> "font/ttf" + | Text_css -> "text/css;charset=utf-8" + | Text_csv -> "text/csv;charset=utf-8" + | Text_html -> "text/html;charset=utf-8" + | Text_javascript -> + (* setting a charset is invalid for JavaScript! *) + "text/javascript" + | Text_plain -> "text/plain;charset=utf-8" + | Unsafe (mimetype, _should_cache) -> mimetype + | Video_avi -> "video/x-msvideo" + | Video_mp4 -> "video/mp4" + | Video_webm -> "video/webm" ) + +let to_string mimetype = Fmt.str "%a" pp mimetype diff --git a/src/mimetype.mli b/src/mimetype.mli new file mode 100644 index 0000000..47f928c --- /dev/null +++ b/src/mimetype.mli @@ -0,0 +1,37 @@ +(* some common MIME types found on https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types *) +type t = + | Audio_aac + | Audio_midi + | Audio_mp3 + | Audio_wav + | Audio_weba + | Application_epub + | Application_json + | Application_jsonld + | Application_gz + | Application_tar + | Application_xml + | Application_atom_xml + | Application_zip + | Application_7z + | Image_bmp + | Image_jpeg + | Image_gif + | Image_ico + | Image_png + | Image_svg + | Image_webp + | Font_ttf + | Text_css + | Text_csv + | Text_html + | Text_javascript + | Text_plain + | Unsafe of string * bool (* mime-type / should be cached *) + | Video_avi + | Video_mp4 + | Video_webm + +val pp : Format.formatter -> t -> unit + +val to_string : t -> string diff --git a/src/request.ml b/src/request.ml new file mode 100644 index 0000000..650b130 --- /dev/null +++ b/src/request.ml @@ -0,0 +1,119 @@ +type query = (string * string list) list + +type headers = (string * string) list + +type t = + { route : Route.t + ; meth : Meth.t + ; query : query + ; headers : headers + ; get_body : unit -> string + } + +let pp_comma fmt () = Fmt.char fmt ',' + +let pp_comma_sep_string_list = Fmt.list ~sep:pp_comma Fmt.string + +let query_values_to_string query = Fmt.str "%a" pp_comma_sep_string_list query + +let query { query; _ } name : string option = + let query = List.assoc_opt name query in + Option.map query_values_to_string query + +let queries { query; _ } name : string list = + List.filter_map + (fun (name', values) -> + if String.equal name name' then + let values = query_values_to_string values in + Some values + else None ) + query + +let all_queries { query; _ } : (string * string) list = + List.map + (fun (name, values) -> + let values = query_values_to_string values in + (name, values) ) + query + +let header { headers; _ } name : string option = + let header = + List.find_opt (fun (name', _value) -> String.equal name name') headers + in + Option.map snd header + +let headers { headers; _ } name : string list = + List.filter_map + (fun (name', value) -> if String.equal name name' then Some value else None) + headers + +let all_headers { headers; _ } : (string * string) list = headers + +let request_from_httpaf ~scheme { H1.Request.meth; target; headers; _ } = + let headers = H2.Headers.of_list (H1.Headers.to_list headers) in + Httpcats.Server.{ meth; target; scheme; headers } + +let request_from_h2 { H2.Request.meth; target; scheme; headers } = + Httpcats.Server.{ meth; target; scheme; headers } + +let request_of_reqd ~scheme reqd = + match reqd with + | `V1 reqd -> + let request = H1.Reqd.request reqd in + request_from_httpaf ~scheme request + | `V2 reqd -> + let request = H2.Reqd.request reqd in + request_from_h2 request + +let get_body reqd = + let aux schedule close = + (* TODO implement a Bstr_buffer *) + let buf = Buffer.create 0x1000 in + let rec on_eof () = close () + and on_read bs ~off ~len = + let s = Bstr.sub_string ~off ~len bs in + Buffer.add_string buf s; + schedule ~on_eof ~on_read + in + schedule ~on_eof ~on_read; + let body = Buffer.contents buf in + body + in + let aux' schedule close = + (* TODO implement a Bstr_buffer *) + let buf = Buffer.create 0x1000 in + let rec on_eof () = close () + and on_read bs ~off ~len = + let s = Bigstringaf.substring ~off ~len bs in + Buffer.add_string buf s; + schedule ~on_eof ~on_read + in + schedule ~on_eof ~on_read; + let body = Buffer.contents buf in + body + in + match reqd with + | `V1 reqd -> + let body_reader = H1.Reqd.request_body reqd in + aux (H1.Body.Reader.schedule_read body_reader) (fun () -> + H1.Body.Reader.close body_reader ) + | `V2 reqd -> + let body_reader = H2.Reqd.request_body reqd in + aux' (H2.Body.Reader.schedule_read body_reader) (fun () -> + H2.Body.Reader.close body_reader ) + +let of_reqd reqd = + let { Httpcats.Server.target; meth; headers; _ } = + request_of_reqd ~scheme:"https" reqd + in + let target = Uri.of_string target in + let query = + match Uri.verbatim_query target with + | None -> [] + | Some query -> Uri.query_of_encoded query + in + let route = Uri.path target |> Route.of_string in + let headers = H2.Headers.to_list headers in + let meth = Meth.of_httpcats meth in + let get_body () = get_body reqd in + { route; meth; query; headers; get_body } diff --git a/src/request.mli b/src/request.mli new file mode 100644 index 0000000..3e1826a --- /dev/null +++ b/src/request.mli @@ -0,0 +1,31 @@ +type query + +type headers + +type t = private + { route : Route.t + ; meth : Meth.t + ; query : query + ; headers : headers + ; get_body : unit -> string + } + +(** Queries *) + +val query : t -> string -> string option + +val queries : t -> string -> string list + +val all_queries : t -> (string * string) list + +(** Headers *) + +val header : t -> string -> string option + +val headers : t -> string -> string list + +val all_headers : t -> (string * string) list + +(** Internal *) + +val of_reqd : Httpcats.Server.reqd -> t diff --git a/src/response.ml b/src/response.ml new file mode 100644 index 0000000..e6c1dbb --- /dev/null +++ b/src/response.ml @@ -0,0 +1 @@ +type t = (Content.t, Status.error * Html_doc.t) Result.t diff --git a/src/response.mli b/src/response.mli new file mode 100644 index 0000000..e6c1dbb --- /dev/null +++ b/src/response.mli @@ -0,0 +1 @@ +type t = (Content.t, Status.error * Html_doc.t) Result.t diff --git a/src/route.ml b/src/route.ml new file mode 100644 index 0000000..759de4a --- /dev/null +++ b/src/route.ml @@ -0,0 +1,11 @@ +type t = string array + +let pp fmt route = + Fmt.pf fmt "/%a" + (Fmt.array ~sep:(fun fmt () -> Fmt.char fmt '/') Fmt.string) + route + +let of_string s = + let ss = String.split_on_char '/' s in + let ss = List.filter (fun s -> not (String.equal "" s)) ss in + Array.of_list ss diff --git a/src/route.mli b/src/route.mli new file mode 100644 index 0000000..8bd415d --- /dev/null +++ b/src/route.mli @@ -0,0 +1,5 @@ +type t = string array + +val pp : Format.formatter -> t -> unit + +val of_string : string -> t diff --git a/src/server.ml b/src/server.ml new file mode 100644 index 0000000..13dbd82 --- /dev/null +++ b/src/server.ml @@ -0,0 +1,159 @@ +module Make (App_id : sig + val qualifier : string + + val organization : string + + val application : string +end) = +struct + module Project = struct + include Directories.Project_dirs (App_id) + + let force_dir d name = + match d with + | None -> Fmt.failwith "can not compute %s directory path" name + | Some dir -> dir + + let cache_dir = force_dir cache_dir "cache" + + let config_dir = force_dir config_dir "config" + + let data_dir = force_dir data_dir "data" + + let data_local_dir = force_dir data_local_dir "data local" + + let preference_dir = force_dir preference_dir "preference" + + let runtime_dir = force_dir runtime_dir "runtime" + + let state_dir = force_dir state_dir "state" + end + + let config = + let filename = Fpath.(Project.config_dir / "config.scfg") in + match Scfg.Parse.from_file filename with + | Error (`Msg msg) -> Fmt.failwith "%s" msg + | Ok config -> config + + open Scfg.Query + + let port = + let directive = get_dir "port" config in + match directive with + | None -> Fmt.failwith "configuration file is missing a port directive" + | Some directive -> ( + let param = get_param_int 0 directive in + match param with + | Error (`Msg msg) -> Fmt.failwith "%s" msg + | Ok port -> port ) + + let listen () = + let inet_addr = Unix.inet_addr_any in + let sockaddr = Unix.ADDR_INET (inet_addr, port) in + sockaddr + + let stop = Httpcats.Server.stop () + + let prepare_content content = + let content_type = Content.to_mimetype content |> Mimetype.to_string in + let content = + match content with + (* | Content.Css sheet -> Fmt.str "%a@\n" Css.pp_string_css sheet *) + | Html doc -> Html_doc.to_string doc + | JavaScript program -> + let open Js_of_ocaml_compiler in + let accept_unnamed_var = true in + let buffer = Buffer.create 4096 in + let pp = Pretty_print.to_buffer buffer in + let _source_map : Source_map.info = + Js_output.program ~accept_unnamed_var pp program + in + (* setting a charset is invalid for JavaScript ! *) + Buffer.contents buffer + | Txt txt -> txt + | Unsafe { content; _ } -> content + in + let content_length = String.length content in + let headers = + [ ("content-type", content_type) + ; ("content-length", string_of_int content_length) + ] + in + (headers, content) + + let status_of_response = function + | Ok _ -> `OK + | Error (status, _) -> Status.to_httpcats status + + let status_headers_of_response = function + | Ok content -> begin + match Content.to_mimetype content with + | Audio_aac | Audio_midi | Audio_mp3 | Audio_wav | Audio_weba | Image_jpeg + | Image_png | Image_gif | Image_bmp | Image_ico | Image_svg | Image_webp + | Font_ttf | Text_css | Text_javascript + | Unsafe (_, true) -> + [ ("Cache-Control", "max-age=151200") ] + | Text_html | Text_plain + | Unsafe (_, false) + | Application_epub | Application_json | Application_jsonld + | Application_gz | Application_tar | Application_xml + | Application_atom_xml | Application_zip | Application_7z | Text_csv + | Video_avi | Video_mp4 | Video_webm -> + [] + end + | Error + ( ( Status.See_other redirect + | Found redirect + | Moved_permanently redirect ) + , _ ) -> + [ ("Location", redirect) ] + | Error _ -> [] + + let content_of_response = function + | Ok content -> content + | Error (_, content) -> Content.Html content + + (* TODO :/ *) + let downgrade_status : Httpcats.Status.t -> H1.Status.t = function + | `Misdirected_request -> assert false + | `Code _ -> assert false + | #H1.Status.standard as t -> t + + let respond reqd headers status content = + match reqd with + | `V1 reqd -> + let open H1 in + let headers = Headers.of_list headers in + let status = downgrade_status status in + let resp = Response.create ~headers status in + Reqd.respond_with_string reqd resp content + | `V2 reqd -> + let open H2 in + let headers = Headers.of_list headers in + let resp = Response.create ~headers status in + Reqd.respond_with_string reqd resp content + + let mk_server ~(handler : Handler.t) = + let handler (_ : [ `Tcp of Miou_unix.file_descr | `Tls of _ ]) + (reqd : Httpcats.Server.reqd) = + let ({ Request.route; _ } as request) = Request.of_reqd reqd in + let response = handler route request in + let status = status_of_response response in + let status_headers = status_headers_of_response response in + let content = content_of_response response in + let session = Session.load request in + let session_headers = Session.make_send_headers session in + let content_headers, content = prepare_content content in + let headers = session_headers @ content_headers @ status_headers in + respond reqd headers status content + in + let file_descr = listen () in + Httpcats.Server.clear ~stop ~handler file_descr; + () + + let () = Sys.set_signal Sys.sigpipe Sys.Signal_ignore + + let run ~(handler : Handler.t) = + let server () = mk_server ~handler in + Miou_unix.run server +end diff --git a/src/server.mli b/src/server.mli new file mode 100644 index 0000000..0c9d08f --- /dev/null +++ b/src/server.mli @@ -0,0 +1,27 @@ +module Make (App_id : sig + val qualifier : string + + val organization : string + + val application : string +end) : sig + module Project : sig + val cache_dir : Fpath.t + + val config_dir : Fpath.t + + val data_dir : Fpath.t + + val data_local_dir : Fpath.t + + val preference_dir : Fpath.t + + val runtime_dir : Fpath.t + + val state_dir : Fpath.t + end + + val config : Scfg.Types.config + + val run : handler:Handler.t -> unit +end diff --git a/src/session.ml b/src/session.ml new file mode 100644 index 0000000..05ebd00 --- /dev/null +++ b/src/session.ml @@ -0,0 +1,151 @@ +let random_state = Random.State.make_self_init () + +module Id = struct + type t = Uuidm.t + + let create () = + (* TODO: use a CSPRNG *) + Uuidm.v4_gen random_state () + + let equal = Uuidm.equal + + let hash (t : t) = Hashtbl.hash t + + let of_string = Uuidm.of_string + + let to_string = Uuidm.to_string ~upper:false + + let pp = Uuidm.pp +end + +type t = + { id : Id.t + ; mutable expires_at : Ptime.t + ; mutable payload : (string * string) list + } + +module Tbl : sig + val find : Id.t -> t option + + val add : Id.t -> t -> unit + + val remove : Id.t -> unit +end = struct + include Hashtbl.Make (Id) + + let tbl = create 512 + + let mutex = Mutex.create () + + let finally () = Mutex.unlock mutex + + let find key = + Mutex.lock mutex; + Fun.protect ~finally (fun () -> find_opt tbl key) + + let add key value = + Mutex.lock mutex; + Fun.protect ~finally (fun () -> replace tbl key value) + + let remove key = + Mutex.lock mutex; + Fun.protect ~finally (fun () -> remove tbl key) +end + +let now () = Ptime.v (Ptime_clock.now_d_ps ()) + +let two_weeks = + match Ptime.Span.of_float_s (60. *. 60. *. 24. *. 7. *. 2.) with + | None -> assert false + | Some span -> span + +let one_week = + match Ptime.Span.of_float_s (60. *. 60. *. 24. *. 7.) with + | None -> assert false + | Some span -> span + +let create () = + let id = Id.create () in + let expires_at = Ptime.add_span (now ()) two_weeks in + let expires_at = + match expires_at with None -> assert false | Some expires_at -> expires_at + in + let payload = [] in + { id; expires_at; payload } + +let load request = + let now = now () in + let valid_session = + let session_id = Cookie.get ~decrypt:false request "drame.session" in + match session_id with + | None -> None + | Some session_id -> ( + match Id.of_string session_id with + | None -> None + | Some session_id -> ( + match Tbl.find session_id with + | None -> None + | Some { id; expires_at; _ } as session -> + let is_valid = Ptime.is_earlier now ~than:expires_at in + if is_valid then session + else begin + Tbl.remove id; + None + end ) ) + in + match valid_session with + | None -> + let session = create () in + Tbl.add session.id session; + session + | Some ({ expires_at; _ } as session) -> + let renew_date = + match Ptime.sub_span expires_at one_week with + | None -> assert false + | Some span -> span + in + if Ptime.is_earlier now ~than:renew_date then session + else begin + let expires_at = + match Ptime.add_span now two_weeks with + | None -> assert false + | Some date -> date + in + session.expires_at <- expires_at; + session + end + +let get request key = + let { payload; _ } = load request in + List.assoc_opt key payload + +let set request key value = + let ({ payload; _ } as session) = load request in + let payload = List.remove_assoc key payload in + let payload = (key, value) :: payload in + session.payload <- payload + +let drop request key = + let ({ payload; _ } as session) = load request in + let payload = List.remove_assoc key payload in + session.payload <- payload + +let invalidate request = + let { id; _ } = load request in + Tbl.remove id + +let make_send_headers session = + let value = Id.to_string session.id in + let max_age = Ptime.diff session.expires_at (now ()) in + let max_age = Option.some @@ Ptime.Span.to_float_s max_age in + Cookie.make_set_headers ~encrypt:false ~max_age ~key:"drame.session" ~value + +let pp fmt request = + let { id; expires_at; payload } = load request in + Fmt.pf fmt "id = %a ; expires_at = %a ; payload:@\n @[" Id.pp id Ptime.pp + expires_at; + Fmt.list + ~sep:(fun fmt () -> Fmt.string fmt "@\n") + (fun fmt (k, v) -> Fmt.pf fmt "%s = %s" k v) + fmt payload; + Fmt.pf fmt "@]" diff --git a/src/session.mli b/src/session.mli new file mode 100644 index 0000000..d62ec1d --- /dev/null +++ b/src/session.mli @@ -0,0 +1,16 @@ +type t + +val load : Request.t -> t + +val invalidate : Request.t -> unit + +val get : Request.t -> string -> string option + +val set : Request.t -> string -> string -> unit + +val drop : Request.t -> string -> unit + +val pp : Format.formatter -> Request.t -> unit + +(* Internal *) +val make_send_headers : t -> (string * string) list diff --git a/src/status.ml b/src/status.ml new file mode 100644 index 0000000..1569d57 --- /dev/null +++ b/src/status.ml @@ -0,0 +1,31 @@ +type error = + | Moved_permanently of string + | Found of string + | See_other of string + | Bad_request + | Unauthorized + | Forbidden + | Not_found + | Request_timeout + | Too_many_requests + | Internal_server_error + | Not_implemented + | Bad_gateway + | Service_unavailable + | Gateway_timeout + +let to_httpcats = function + | Moved_permanently _url -> `Moved_permanently + | Found _url -> `Found + | See_other _url -> `See_other + | Bad_request -> `Bad_request + | Unauthorized -> `Unauthorized + | Forbidden -> `Forbidden + | Not_found -> `Not_found + | Request_timeout -> `Request_timeout + | Too_many_requests -> `Enhance_your_calm + | Internal_server_error -> `Internal_server_error + | Not_implemented -> `Not_implemented + | Bad_gateway -> `Bad_gateway + | Service_unavailable -> `Service_unavailable + | Gateway_timeout -> `Gateway_timeout diff --git a/src/status.mli b/src/status.mli new file mode 100644 index 0000000..635ba9b --- /dev/null +++ b/src/status.mli @@ -0,0 +1,17 @@ +type error = + | Moved_permanently of string + | Found of string + | See_other of string + | Bad_request + | Unauthorized + | Forbidden + | Not_found + | Request_timeout + | Too_many_requests + | Internal_server_error + | Not_implemented + | Bad_gateway + | Service_unavailable + | Gateway_timeout + +val to_httpcats : error -> Httpcats.Status.t diff --git a/src/syntax.ml b/src/syntax.ml new file mode 100644 index 0000000..aea9713 --- /dev/null +++ b/src/syntax.ml @@ -0,0 +1,3 @@ +let ( let* ) = Result.bind + +let ( let+ ) r f = Result.map f r