avers (empty) → 0.0.1
raw patch · 12 files changed
+2829/−0 lines, 12 filesdep +MonadRandomdep +aesondep +attoparsecsetup-changed
Dependencies added: MonadRandom, aeson, attoparsec, base, base16-bytestring, bytestring, containers, cryptohash, inflections, influxdb, mtl, network, resource-pool, rethinkdb-client-driver, scrypt, stm, template-haskell, text, time, unordered-containers, vector
Files
- LICENSE +674/−0
- Setup.hs +2/−0
- avers.cabal +61/−0
- src/Avers.hs +107/−0
- src/Avers/Metrics.hs +39/−0
- src/Avers/Patching.hs +223/−0
- src/Avers/Storage.hs +608/−0
- src/Avers/Storage/Backend.hs +159/−0
- src/Avers/Storage/Expressions.hs +52/−0
- src/Avers/TH.hs +234/−0
- src/Avers/Types.hs +604/−0
- src/Avers/Views.hs +66/−0
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ 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.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ 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 <http://www.gnu.org/licenses/>.++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:++ <program> Copyright (C) <year> <name of author>+ 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+<http://www.gnu.org/licenses/>.++ 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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ avers.cabal view
@@ -0,0 +1,61 @@+name: avers+version: 0.0.1+license: GPL-3+license-file: LICENSE+author: Tomas Carnecky+maintainer: tomas.carnecky@gmail.com+category: Avers+build-type: Simple+cabal-version: >= 1.10++synopsis: empty+description: empty+++library+ hs-source-dirs: src+ default-language: Haskell2010++ ghc-options:+ -threaded -Wall+++ -- For the time being everything is exported.+ exposed-modules:+ Avers+ , Avers.Metrics+ , Avers.Patching+ , Avers.Storage+ , Avers.Storage.Backend+ , Avers.Storage.Expressions+ , Avers.TH+ , Avers.Types+ , Avers.Views+++ -- Standard dependencies, stuff that is or should be in the platform.+ build-depends:+ aeson+ , attoparsec+ , base <= 9999+ , bytestring+ , containers+ , mtl+ , network+ , stm+ , template-haskell+ , text+ , time+ , unordered-containers+ , vector++ -- More exotic dependencies which people may not immediately recognize.+ build-depends:+ MonadRandom+ , base16-bytestring+ , cryptohash+ , inflections+ , influxdb+ , resource-pool+ , rethinkdb-client-driver >= 0.0.11+ , scrypt
+ src/Avers.hs view
@@ -0,0 +1,107 @@+{-# LANGUAGE NoImplicitPrelude #-}++module Avers+ (+ -- * The Avers Monad+ Avers+ , evalAvers++ -- * Types+ , Path(..)+ , Pk(..)++ , ObjId(..)+ , rootObjId++ , RevId(..)+ , zeroRevId++ , ObjectId(..)+ , Operation(..)++ -- * Object+ , Object(..)+ , exists+ , createObject+ , lookupObject+ , deleteObject+ , pruneObject+ , objectsOfType+ , allObjectsOfType++ -- * Patch+ , Patch(..)+ , PatchError(..)+ , lookupPatch++ -- * Snapshot+ , Snapshot(..)+ , lookupLatestSnapshot+ , objectContent++ -- * Release+ , Release(..)+ , lookupRelease+ , createRelease+ , lookupLatestRelease++ -- * Patching+ , resolvePathIn++ -- * Session+ , SessionId(..)+ , Session(..)+ , saveSession+ , lookupSession+ , dropSession++ , ObjectType(..)+ , SomeObjectType(..)+ , lookupObjectType++ , AversError(..)+ , AversConfig(..)+ , AversState+ , newState+ , strErr+ , parseValueAs++ -- * Blob+ , BlobId(..)+ , Blob(..)+ , createBlob+ , lookupBlob++ -- * Secret+ , SecretId(..)+ , Secret(..)+ , updateSecret+ , verifySecret++ , applyObjectUpdates+ , runQuery+ , runQueryCollect+ , parseValue+ , parseDatum+ , newId++ , objectsTable+ , blobsTable++ , validateObject++ -- * Views+ , View(..)+ , SomeView(..)+ , viewTable+ , updateView++ ) where++++import Avers.Patching+import Avers.Storage+import Avers.Storage.Backend+import Avers.Types+import Avers.Views
+ src/Avers/Metrics.hs view
@@ -0,0 +1,39 @@+{-# LANGUAGE TemplateHaskell #-}+{-# LANGUAGE OverloadedStrings #-}++module Avers.Metrics where++import Control.Concurrent+import Control.Monad.State++import Data.Text (Text)++import Network.BSD++import Database.InfluxDB+import Database.InfluxDB.TH++import Avers.Types+++data Point = Point+ { pointMachine :: String+ , pointComponent :: Text+ , pointValue :: Double+ }+++reportPoint :: Text -> Double -> Avers ()+reportPoint series value = do+ ac <- gets config+ case influxConfig ac of+ Nothing -> return ()+ Just cfg -> void $ liftIO $ forkIO $ do+ h <- getHostName+ postWithPrecision cfg "rmx" SecondsPrecision $ withSeries series $ do+ writePoints $ Point h "api" value+++deriveSeriesData defaultOptions+ { fieldLabelModifier = stripPrefixLower "point" }+ ''Point
+ src/Avers/Patching.hs view
@@ -0,0 +1,223 @@+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}++module Avers.Patching+ ( applyOperation+ , opOT+ , rebaseOperation+ , resolvePathIn+ ) where+++import Data.Monoid++import Data.Text (Text)+import qualified Data.Text as T++import qualified Data.Vector as V+import qualified Data.HashMap.Strict as M++import Data.Aeson+import Data.Aeson.Types++import Avers.Types (Patch(..), Path(..), Operation(..), PatchM, PatchError(..))++import Control.Monad+++-- | Apply the given op on the value. Can throw an exception if the operation+-- is invalid.+applyOperation :: Value -> Operation -> PatchM Value+applyOperation value Set{..} = changeObject value opPath $ \key ->+ maybe (M.delete key) (M.insert key) opValue++applyOperation value Splice{..} = changeArray value opPath $ \a -> do++ -- Check if the indices are within the allowed range.+ when (V.length a < opIndex + opRemove) $+ Left $ UnknownPatchError $ mconcat+ [ "Index out of range ("+ , T.pack (show $ V.length a)+ , ","+ , T.pack (show opIndex)+ , ","+ , T.pack (show opRemove)+ , ")"+ ]++ -- The existing array and the elements we want to insert must match+ -- structurally (have the same type). Furthermore, if the array consists+ -- of objects, each object is required to have an "id" field.+ unless (isStructurallyEquivalent opInsert a) $+ Left $ UnknownPatchError "Array doesn't match structure"++ return $ V.take opIndex a V.++ V.fromList opInsert V.++ V.drop (opIndex + opRemove) a++ where+ isStructurallyEquivalent :: [Value] -> V.Vector Value -> Bool+ isStructurallyEquivalent a b = strings a b || validObjects a b++ strings a b = all isString a && V.all isString b+ validObjects a b = all hasObjectId a && V.all hasObjectId b+++isString :: Value -> Bool+isString (String _) = True+isString _ = False++hasObjectId :: Value -> Bool+hasObjectId (Object o) = M.member "id" o+hasObjectId _ = False++pathElements :: Path -> [Text]+pathElements = T.split ('.' ==) . unPath++changeObject :: Value -> Path -> (Text -> Object -> Object) -> PatchM Value+changeObject value path f = changeObjectAt value (init (pathElements path)) $ \x ->+ case x of+ Object o -> Right $ Object $ f (last (pathElements path)) o+ _ -> Left $ UnknownPatchError "Can not change a non-object"++changeArray :: Value -> Path -> (Array -> PatchM Array) -> PatchM Value+changeArray value path f = changeObjectAt value (pathElements path) $ \x ->+ case x of+ Array a -> fmap Array $ f a+ _ -> Left $ UnknownPatchError "Can not change a non-array"+++changeObjectAt :: Value -> [Text] -> (Value -> PatchM Value) -> PatchM Value+changeObjectAt container [] f = f container++changeObjectAt (Object o) (x:xs) f =+ case parse (const $ o .: x) o of+ Error _ -> Left $ UnknownPatchError $ "Key '" <> T.pack (show x) <> "' does not exist inside the object"+ Success a -> do+ new <- changeObjectAt a xs f+ return $ Object $ M.insert x new o+++changeObjectAt (Array a) (x:xs) f =+ case V.findIndex (matchObjectId x) a of+ Nothing -> Left $ UnknownPatchError $ "Can not find item with id " <> T.pack (show x) <> " in the array"+ Just index -> do+ new <- changeObjectAt (a V.! index) xs f+ return $ Array $ a V.// [(index, new)]++changeObjectAt _ _ _ = Left $ UnknownPatchError "Can not descend into primitive values"+++matchObjectId :: Text -> Value -> Bool+matchObjectId itemId (Object o) = Just (String itemId) == M.lookup "id" o+matchObjectId _ _ = False++++-- | Resolve the path in the object.+resolvePathIn :: Path -> Value -> Maybe Value+resolvePathIn path = go (pathElements path)+ where+ go [] value = Just value+ go [""] value = Just value++ go (x:xs) (Object o) =+ case parse (const $ o .: x) o of+ Error _ -> Nothing+ Success a -> go xs a++ go (x:xs) (Array a) =+ maybe Nothing (go xs) $ V.find (matchObjectId x) a++ go _ _ = Nothing++++-- Set (foo) -> Set (foo) = ok+-- Set (foo) -> Set (foo.bar) = drop+-- Set (foo.bar) -> Set (foo) = ok+-- Set (foo) -> Set (bar) = ok+--+-- Set (foo) -> Splice (foo) = drop+-- Set (foo) -> Splice (foo.bar) = drop+-- Set (foo.bar) -> Splice (foo) = ok+-- Set (foo) -> Splice (bar) = ok+--+-- Splice (foo) -> Set (foo) = ok+-- Splice (foo) -> Set (foo.bar) = ok if foo.bar exists+-- Splice (foo.bar) -> Set (foo) = ok+-- Splice (foo) -> Set (bar) = ok+--+-- Splice (foo) -> Splice (foo) = drop -- todo: ok (adjust)+-- Splice (foo) -> Splice (foo.bar) = ok if foo.bar exists+-- Splice (foo.bar) -> Splice (foo) = ok+-- Splice (foo) -> Splice (bar) = ok++opOT :: Value -> Operation -> Operation -> Maybe Operation+opOT content base op++ -- Duplicate ops are dropped.+ | base == op = Nothing++ -- If neither is a prefix of the other (they touch distinct parts of the+ -- object) then it's safe to accept the op.+ | not ((opPath base `isPrefixOf` opPath op) || (opPath op `isPrefixOf` opPath base)) =+ Just op++ | otherwise = case base of+ Set{..} -> setOT opPath+ Splice{..} -> spliceOT opPath++ where+ setOT path = case op of+ Set{..} -- Set -> Set+ | path == opPath -> Just op+ | path `isPrefixOf` opPath -> Nothing+ | otherwise -> Just op++ Splice{..} -- Set -> Splice+ | path == opPath -> Nothing+ | path `isPrefixOf` opPath -> Nothing+ | otherwise -> Just op++ spliceOT path = case op of+ Set{..} -- Splice -> Set+ | path == opPath -> Just op+ | path `isPrefixOf` opPath -> onlyIfPresent opPath+ | otherwise -> Just op++ Splice{..} -- Splice -> Splice+ | path == opPath -> spliceOnSplice base op+ | path `isPrefixOf` opPath -> onlyIfPresent opPath+ | otherwise -> Nothing++ onlyIfPresent path = case resolvePathIn path content of+ Nothing -> Nothing+ Just _ -> Just op++ (Path a) `isPrefixOf` (Path b) = a `T.isPrefixOf` b++ -- Both ops are 'Splice' on the same path.+ spliceOnSplice op1 op2+ | opIndex op1 + opRemove op1 <= opIndex op2+ = Just $ op2 { opIndex = opIndex op2 + (length $ opInsert op1) - opRemove op2 }++ | opIndex op2 + opRemove op2 < opIndex op1+ = Just op2++ | otherwise = Nothing++++-- | Given an 'Operation' which was created against a particular 'Value'+-- (content), rebase it on top of patches which were created against the very+-- same content in parallel.+--+-- This function assumes that the patches apply cleanly to the content.+-- Failure to do so results in a fatal error.++rebaseOperation :: Value -> Operation -> [Patch] -> Maybe Operation+rebaseOperation _ op [] = Just op+rebaseOperation content op (x:xs) = case applyOperation content (patchOperation x) of+ Left e -> error $ "Unexpected failure: " ++ (show e)+ Right newContent -> case opOT newContent (patchOperation x) op of+ Nothing -> Nothing+ Just op' -> rebaseOperation newContent op' xs
+ src/Avers/Storage.hs view
@@ -0,0 +1,608 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TemplateHaskell #-}++{-|++This module abstracts the storage engine and provides functions to+manipulate objects stored in it.++-}++module Avers.Storage where++import Control.Applicative+import Control.Concurrent.STM++import Control.Monad.Random (getRandomR, evalRandIO)+import Control.Monad.State+import Control.Monad.Except++import Data.Char+import Data.Monoid+import Data.Maybe+import qualified Data.ByteString.Lazy as BL+import qualified Data.ByteString.Base16 as BS16++import Data.Vector (Vector)+import qualified Data.Vector as V++import Data.Text (Text)+import qualified Data.Text as T+import qualified Data.Text.Encoding as T++import qualified Data.Map as M++import Data.Time+import Data.List (find)+import Data.Aeson (Value)+import Data.Aeson.Types (emptyObject)++import qualified Crypto.Hash.SHA3 as SHA3++import qualified Database.RethinkDB as R++import Crypto.Scrypt++import Avers.Metrics+import Avers.Types+import Avers.Patching+import Avers.TH+import Avers.Views++import Avers.Storage.Backend+import Avers.Storage.Expressions+++requireResult :: AversError -> Maybe a -> Avers a+requireResult err Nothing = throwError err+requireResult _ (Just v) = return v+++-- All the tables which this storage engine uses.+objectsTable, sessionsTable, snapshotsTable, patchesTable, secretsTable, blobsTable :: R.Exp R.Table+blobsTable = R.Table Nothing $ R.lift ("blobs" :: Text)+objectsTable = R.Table Nothing $ R.lift ("objects" :: Text)+patchesTable = R.Table Nothing $ R.lift ("patches" :: Text)+secretsTable = R.Table Nothing $ R.lift ("secrets" :: Text)+sessionsTable = R.Table Nothing $ R.lift ("sessions" :: Text)+snapshotsTable = R.Table Nothing $ R.lift ("snapshots" :: Text)+++trace :: String -> Avers a -> Avers a+trace label act = do+ start <- liftIO $ getCurrentTime+ ret <- act+ end <- liftIO $ getCurrentTime++ reportPoint+ ("avers.storage." <> (T.pack label) <> ".duration")+ (realToFrac $ diffUTCTime end start)++ return ret+++-- | True if the object exists.+exists :: ObjId -> Avers Bool+exists objId = trace "exists" $+ existsDocument objectsTable (BaseObjectId objId)+++-- | Lookup an 'Object' by its 'ObjId'. Throws 'ObjectNotFound' if the object+-- doesn't exist.+lookupObject :: ObjId -> Avers Object+lookupObject objId = trace "lookupObject" $ do+ mbObject <- lookupDocument objectsTable (BaseObjectId objId)+ requireResult (ObjectNotFound objId) mbObject+++-- | Create a new object of the given type. An initial snapshot ('RevId' 0)+-- is created from the supplied content.+createObject :: (ToJSON a) => ObjectType a -> ObjId -> a -> Avers ObjId+createObject ot@ObjectType{..} createdBy content = do+ objId <- otId+ now <- liftIO $ getCurrentTime++ let object = Object objId otType now createdBy Nothing+ boId = BaseObjectId objId+ snapshot = Snapshot boId zeroRevId (toJSON content)++ insertDocument objectsTable object+ insertDocument snapshotsTable snapshot++ updateObjectViews ot objId (Just content)++ return objId+++-- | Mark the object as deleted.+deleteObject :: ObjId -> Avers ()+deleteObject objId = do+ obj <- lookupObject objId+ upsertDocument objectsTable (obj { objectDeleted = Just True })++ SomeObjectType objType <- lookupObjectType (objectType obj)+ updateObjectViews objType objId Nothing++++-- | Prune the object from the database. This is only allowed if the object is+-- marked as deleted. Note that this is a very dangerous operation, it can not+-- be undone.+pruneObject :: ObjId -> Avers ()+pruneObject objId = do+ obj <- lookupObject objId+ SomeObjectType objType <- lookupObjectType (objectType obj)++ unless (objectDeleted obj == Just True) $+ strErr $ "pruneObject: object " ++ show objId ++ " is not deleted"++ -- Drop all related patches. Note that there will never be a patch with+ -- revision zero, so it's safe to use 'patchesAfterRevision'.+ patches <- patchesAfterRevision (BaseObjectId objId) zeroRevId+ void $ mapM (deleteDocument patchesTable) patches++ -- Drop all related snapshots.+ snapshotDatums <- runQueryCollect $+ R.BetweenIndexed+ "objectSnapshotSequence"+ ( R.Closed $ R.Array $ V.fromList [R.String $ toPk objId, R.Number $ fromIntegral (0 :: Int)]+ , R.Open $ R.Array $ V.fromList [R.String $ toPk objId, R.Number $ fromIntegral (99999999 :: Int)]+ )++ snapshotsTable+ snapshots <- V.mapM parseDatum snapshotDatums :: Avers (Vector Snapshot)+ void $ V.mapM (deleteDocument snapshotsTable) snapshots++ -- Remove related entries from all views.+ forM_ (otViews objType) $ \(SomeView view) -> do+ deleteDocument (viewTable view) objId++ -- Drop the object itself.+ void $ deleteDocument objectsTable objId++++-----------------------------------------------------------------------------+-- | Fetch the content of the object and try to parse it.+--+-- This function will fail with a 'ParseError' if the content can not be+-- decoded into the desired type.++objectContent :: (FromJSON a) => ObjectId -> Avers a+objectContent objId = do+ Snapshot{..} <- lookupLatestSnapshot objId+ parseValue snapshotContent++++-----------------------------------------------------------------------------+-- | Get the snapshot of the newest revision of the given object.++lookupLatestSnapshot :: ObjectId -> Avers Snapshot+lookupLatestSnapshot objId = trace "lookupLatestSnapshot" $ do+ snapshot <- newestSnapshot objId+ patches <- patchesAfterRevision objId (snapshotRevisionId snapshot)+ applyPatches snapshot patches+++-- TODO: Verify that the patch is applicable to the snapshot, ie.+-- snapshot revId == patch revId + 1+applyPatchToSnapshot :: Snapshot -> Patch -> Avers Snapshot+applyPatchToSnapshot snapshot@Snapshot{..} Patch{..} =+ case applyOperation snapshotContent patchOperation of+ Left e -> patchError e+ Right v -> return $ snapshot { snapshotContent = v+ , snapshotRevisionId = patchRevisionId+ }+++applyPatches :: Snapshot -> [Patch] -> Avers Snapshot+applyPatches snapshot patches =+ foldM applyPatchToSnapshot snapshot patches+++lookupRecentRevision :: ObjectId -> Avers (Maybe RevId)+lookupRecentRevision objId = do+ m <- liftIO . atomically . readTVar =<< gets recentRevisionCache+ return $ M.lookup objId m++updateRecentRevision :: ObjectId -> RevId -> Avers ()+updateRecentRevision objId revId = do+ cache <- gets recentRevisionCache+ liftIO $ atomically $ modifyTVar' cache $+ M.insertWith max objId revId+++++-----------------------------------------------------------------------------+-- | Get the newest snapshot which is stored in the database. The object may+-- be at a higher revision if the later snapshots are missing from the+-- database.+--+-- This is an internal function. If you want the latest snapshot, you should+-- use 'lookupLatestSnapshot'.++newestSnapshot :: ObjectId -> Avers Snapshot+newestSnapshot objId = trace "newestSnapshot" $ do+ (RevId revId) <- fromMaybe zeroRevId <$> lookupRecentRevision objId+ snapshot <- runQueryDatum $ headE $+ R.OrderByIndexed (R.Descending "objectSnapshotSequence") $+ R.BetweenIndexed "objectSnapshotSequence" ((lowerBound revId), upperBound) $+ snapshotsTable++ updateRecentRevision objId (snapshotRevisionId snapshot)+ return snapshot++ where+ lowerBound revId = R.Closed $ R.Array $ V.fromList [R.String $ toPk objId, R.Number $ fromIntegral revId]+ upperBound = R.Open $ R.Array $ V.fromList [R.String $ toPk objId, R.Number $ fromIntegral (99999999 :: Int)]++++lookupSnapshot :: ObjectId -> RevId -> Avers Snapshot+lookupSnapshot objId (RevId revId) = trace "lookupSnapshot" $ do+ snapshot <- runQueryDatum $ headE $+ R.OrderByIndexed (R.Descending "objectSnapshotSequence") $+ R.BetweenIndexed "objectSnapshotSequence" (lowerBound, upperBound) $+ snapshotsTable++ -- Get all patches which we need to apply on top of the snapshot to+ -- arrive at the desired revision.+ patches0 <- patchesAfterRevision objId (snapshotRevisionId snapshot)+ let patches = filter (\Patch{..} -> patchRevisionId <= RevId revId) patches0++ foldM applyPatchToSnapshot snapshot patches++ where+ lowerBound = R.Closed $ R.Array $ V.fromList [R.String $ toPk objId, R.Number 0]+ upperBound = R.Closed $ R.Array $ V.fromList [R.String $ toPk objId, R.Number $ fromIntegral revId]++++savePatch :: Patch -> Avers ()+savePatch = insertDocument patchesTable++saveSnapshot :: Snapshot -> Avers ()+saveSnapshot = insertDocument snapshotsTable++++-----------------------------------------------------------------------------+-- Update the secret value. If a secret with the given 'SecretId' does not+-- exist yet, one will be created (IOW this function has upsert semantics).++updateSecret :: SecretId -> Text -> Avers ()+updateSecret secId secret = do+ ep <- liftIO $ encryptPassIO defaultParams (Pass $ T.encodeUtf8 secret)+ saveSecretValue secId ep++++-----------------------------------------------------------------------------+-- | Verify the value against the secret. If that fails, then this function+-- throws an error.+--+-- This function automatically updates the secret in the database if the+-- scrypt params have changed.++verifySecret :: SecretId -> Text -> Avers ()+verifySecret secId secret = do+ Secret{..} <- requireResult (DocumentNotFound $ toPk secId) =<<+ lookupDocument secretsTable secId++ let ep = EncryptedPass $ T.encodeUtf8 secretValue+ let (ok, new) = verifyPass defaultParams (Pass $ T.encodeUtf8 secret) ep++ -- If the secret doens't match, return NotFound+ when (not ok) $ strErr $ "Not Found"++ -- Update the database if we got a new value from the verify step. This+ -- is the case when the scrypt params have changed. See documentation of+ -- 'verifyPass'.+ maybe (return ()) (saveSecretValue secId) new++++-----------------------------------------------------------------------------+-- | Internal function which actually saves a secret in the database.++saveSecretValue :: SecretId -> EncryptedPass -> Avers ()+saveSecretValue secId (EncryptedPass x) = do+ upsertDocument secretsTable $ Secret secId $ T.decodeUtf8 x+++++patchesAfterRevision :: ObjectId -> RevId -> Avers [Patch]+patchesAfterRevision objId (RevId revId) = trace "patchesAfterRevision" $ do+ res <- runQuery $+ R.OrderBy [R.Ascending "revisionId"] $+ R.BetweenIndexed "objectPatchSequence" (lowerBound, upperBound) $+ patchesTable++ V.toList <$> V.mapM parseDatum res++ where+ lowerBound = R.Open $ R.Array $ V.fromList [R.String $ toPk objId, R.Number $ fromIntegral revId]+ upperBound = R.Open $ R.Array $ V.fromList [R.String $ toPk objId, R.Number $ fromIntegral (revId + 999999)]+++lookupPatch :: ObjectId -> RevId -> Avers Patch+lookupPatch objId revId = trace "lookupPatch" $ do+ runQuerySingleSelection $ R.Get patchesTable $ R.lift $+ toPk objId <> "@" <> toPk revId++++-- | Lookup an object type which is registered in the Avers monad.+lookupObjectType :: Text -> Avers SomeObjectType+lookupObjectType objType = do+ types <- objectTypes <$> gets config+ case find (\(SomeObjectType ObjectType{..}) -> otType == objType) types of+ Nothing -> throwError $ UnknownObjectType objType+ Just x -> return x++++applyObjectUpdates+ :: ObjectId -- ^ The object which you want to update+ -> RevId -- ^ The 'RevId' against which the operations were created+ -> ObjId -- ^ Committer+ -> [Operation] -- ^ The operations to apply+ -> Bool -- ^ True if validation should be skipped+ -> Avers ([Patch], Int, [Patch])++applyObjectUpdates objId revId committerId ops novalidate = trace "applyObjectUpdates" $ do+ -- First check that the object exists. We'll need its metadata later.+ obj <- lookupObject baseObjId+ SomeObjectType ot <- lookupObjectType (objectType obj)++ -- The 'Snapshot' against which the submitted operations were created.+ baseSnapshot <- lookupSnapshot objId revId++ -- If there are any patches which the client doesn't know about we need+ -- to let her know.+ previousPatches <- patchesAfterRevision objId revId++ latestSnapshot <- applyPatches baseSnapshot previousPatches++ -- Apply the operations and get the final snapshot.+ (Snapshot{..}, PatchState{..}) <- runStateT (patchHandler novalidate) $+ PatchState ot objId revId committerId ops 0+ baseSnapshot latestSnapshot previousPatches []++ -- Update object views.+ unless novalidate $ do+ content <- parseValue snapshotContent+ updateObjectViews ot baseObjId (Just content)++ return (previousPatches, psNumConsumedOperations, psPatches)++ where+ baseObjId = objectIdBase objId++++data PatchState a = PatchState+ { psObjectType :: ObjectType a+ , psObjectId :: ObjectId+ , psRevisionId :: RevId+ , psCommitterId :: ObjId+ , psOperations :: [ Operation ]+ , psNumConsumedOperations :: Int+ , psBaseSnapshot :: Snapshot+ , psLatestSnapshot :: Snapshot+ , psPreviousPatches :: [ Patch ]+ , psPatches :: [ Patch ]+ }+++type AversPatch a b = StateT (PatchState a) Avers b+++patchHandler :: (FromJSON a) => Bool -> AversPatch a Snapshot+patchHandler novalidate = do+ PatchState{..} <- get+ foldM (saveOperation $ snapshotContent psBaseSnapshot)+ psLatestSnapshot psOperations++ where++ saveOperation baseContent snapshot@Snapshot{..} op = do+ PatchState{..} <- get++ case rebaseOperation baseContent op psPreviousPatches of+ Nothing -> return snapshot+ Just op' -> do+ now <- liftIO $ getCurrentTime++ let revId = succ snapshotRevisionId+ patch = Patch psObjectId revId psCommitterId now op'++ case applyOperation snapshotContent op' of+ Left e -> error $ "Failure: " ++ (show e)+ Right newContent+ | newContent /= snapshotContent -> do+ unless novalidate $ do+ lift $ validateWithType psObjectType newContent++ let newSnapshot = snapshot { snapshotContent = newContent+ , snapshotRevisionId = revId+ }++ -- Now we know that the patch can be applied cleanly, so+ -- we can save it in the database.+ lift $ savePatch patch++ modify $ \s -> s+ { psPatches = psPatches ++ [patch]+ , psNumConsumedOperations = psNumConsumedOperations + 1+ }++ lift $ saveSnapshot newSnapshot+ return newSnapshot+ | otherwise -> return snapshot+++existsBlob :: BlobId -> Avers Bool+existsBlob = existsDocument blobsTable++lookupBlob :: BlobId -> Avers Blob+lookupBlob bId = lookupDocument blobsTable bId >>=+ requireResult (DocumentNotFound $ toPk bId)++insertBlob :: Blob -> Avers ()+insertBlob = insertDocument blobsTable++saveBlobContent :: Blob -> BL.ByteString -> Avers ()+saveBlobContent Blob{..} content = do+ cfg <- gets config+ liftIO $ (putBlob cfg) blobId blobContentType content+++saveSession :: Session -> Avers ()+saveSession = insertDocument sessionsTable++lookupSession :: SessionId -> Avers Session+lookupSession sessId = lookupDocument sessionsTable sessId >>=+ requireResult (DocumentNotFound $ toPk sessId)++dropSession :: SessionId -> Avers ()+dropSession sessId = void $ deleteDocument sessionsTable sessId++++newId :: Int -> IO Text+newId n = T.pack <$> take n <$> randomAlphanumericSequence+ where+ randomAlphanumericSequence :: IO String+ randomAlphanumericSequence = map alnum <$>+ evalRandIO (sequence $ repeat $ getRandomR (0, 61))++ alnum :: Int -> Char+ alnum x+ | x < 26 = chr ((x ) + 65)+ | x < 52 = chr ((x - 26) + 97)+ | x < 62 = chr ((x - 52) + 48)+ | otherwise = error $ "Out of range: " ++ show x+++validateObject :: Text -> Value -> Avers ()+validateObject objType value = do+ (SomeObjectType ot) <- lookupObjectType objType+ validateWithType ot value++validateWithType :: (FromJSON a) => ObjectType a -> Value -> Avers ()+validateWithType ot value = case parseValueAs ot value of+ Left e -> throwError e+ Right _ -> return ()+++lookupRelease :: ObjId -> RevId -> Avers Release+lookupRelease objId revId = objectContent (ReleaseObjectId objId revId)+++-- | Create a new release of the given revision. If the object doesn't exist,+-- it will fail with 'ObjectNotFound'.+createRelease :: ObjId -> RevId -> Avers ()+createRelease objId revId = do+ -- The object must exist.+ objectExists <- exists objId+ unless objectExists $ throwError (ObjectNotFound objId)++ -- The release objects are not patchable at the moment. If one already+ -- exists, then there is nothing to do. Otherwise create the initial+ -- snapshot with empty content.+ exists' <- existsDocument snapshotsTable (toPk snapshot)+ unless exists' $ insertDocument snapshotsTable snapshot++ where+ objectId = ReleaseObjectId objId revId+ snapshot = Snapshot objectId zeroRevId emptyObject+++lookupLatestRelease :: ObjId -> Avers (Maybe RevId)+lookupLatestRelease objId = do+ let match = R.lift $ "^" <> toPk objId <> "/release/"++ predicate :: R.Exp R.Object -> R.Exp Bool+ predicate x = R.Coerce+ (R.Match (objectFieldE "objectId" x) match)+ (R.lift ("bool"::Text))++ oId <- runQueryDatum $+ (objectFieldE "objectId" :: R.Exp R.Object -> R.Exp R.Datum) $+ headE $+ R.OrderBy [R.Descending "objectId"] $+ R.Filter predicate snapshotsTable++ case oId of+ ReleaseObjectId objId1 revId -> do+ when (objId /= objId1) $ databaseError "lookupLatestRelease: objId do not match"+ return $ Just revId++ _ -> return Nothing++++-------------------------------------------------------------------------+-- Blobs+-------------------------------------------------------------------------++createBlob :: BL.ByteString -> Text -> Avers Blob+createBlob body contentType = do+ -- Only create the blob if it doesn't already exist. That way we can+ -- avoid having to upload the blob to the storage.+ ex <- existsBlob (blobId blob)+ unless ex $ do+ saveBlobContent blob body+ insertBlob blob++ return blob++ where+ size = fromIntegral $ BL.length body+ hash = BS16.encode $ SHA3.hashlazy 256 body+ blob = Blob (BlobId $ T.decodeUtf8 hash) size contentType+++objectsOfType :: ObjectType a -> Avers (Vector ObjId)+objectsOfType objType = do+ let predicate :: R.Exp R.Object -> R.Exp Bool+ predicate = objectFieldEqE "type" (otType objType)++ res <- runQueryCollect $+ R.Map mapId $+ R.OrderBy [R.Descending "createdAt", R.Ascending "id"] $+ R.Filter isNotDeleted $+ R.Filter predicate objectsTable++ return $ V.map ObjId res+++allObjectsOfType :: ObjectType a -> Avers (Vector ObjId)+allObjectsOfType objType = do+ let predicate :: R.Exp R.Object -> R.Exp Bool+ predicate = objectFieldEqE "type" (otType objType)++ res <- runQueryCollect $+ R.Map mapId $+ R.OrderBy [R.Descending "createdAt", R.Ascending "id"] $+ R.Filter predicate objectsTable++ return $ V.map ObjId res+++isNotDeleted :: R.Exp R.Object -> R.Exp Bool+isNotDeleted x = R.Any+ [ R.Not $ R.HasFields ["deleted"] x+ , objectFieldEqE "deleted" False x+ ]++mapId:: R.Exp R.Object -> R.Exp Text+mapId = R.GetField "id"
+ src/Avers/Storage/Backend.hs view
@@ -0,0 +1,159 @@+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE TemplateHaskell #-}+{-# LANGUAGE TypeFamilies #-}+++{-|++Low-level implementation of the storage backend.++-}++module Avers.Storage.Backend+ ( parseValue+ , parseDatum++ , runQuery+ , runQueryDatum+ , runQuerySingleSelection+ , runQueryCollect++ , existsDocument+ , lookupDocument+ , insertDocument+ , upsertDocument+ , deleteDocument+ ) where+++import Prelude hiding (lookup)++import Control.Monad.Except+import Control.Monad.State++import Data.Monoid+import Data.Aeson (Value, Result(..))+import Data.Aeson.Types (parse, parseEither)+import Data.Pool+import qualified Data.Text as T+import qualified Data.HashMap.Strict as HMS+import qualified Data.Vector as V++import qualified Database.RethinkDB as R+import Database.RethinkDB.TH++import Avers.TH+import Avers.Types+import Avers.Storage.Expressions++++parseValue :: (FromJSON a, MonadError AversError m) => Value -> m a+parseValue value = case parseEither parseJSON value of+ Left e -> parseError value (T.pack e)+ Right x -> return x+++parseDatum :: (R.FromDatum a, MonadError AversError m) => R.Datum -> m a+parseDatum datum = case parse R.parseDatum datum of+ Error e -> parseError (toJSON datum) (T.pack e)+ Success x -> return x++++data WriteResponse = WriteResponse+ { writeResponseInserted :: Int+ , writeResponseDeleted :: Int+ , writeResponseReplaced :: Int+ , writeResponseUnchanged :: Int+ , writeResponseSkipped :: Int+ , writeResponseErrors :: Int+ } deriving (Show)+++checkWriteResponse :: Maybe R.Datum -> Avers ()+checkWriteResponse resp = do+ case resp of+ Nothing -> strErr "Error"+ Just x ->+ case parseEither R.parseDatum x of+ Left err -> strErr err+ Right WriteResponse{..} ->+ if writeResponseErrors == 0+ then return ()+ else databaseError $ "Errors during write operation: " <> T.pack (show resp)++mergePk :: (R.ToDatum a, Pk a) => a -> R.Object+mergePk doc = HMS.insert primaryKeyField (R.String $ toPk doc) hms+ where (R.Object hms) = R.toDatum doc+++runQuerySingleSelection :: (R.FromDatum a) => R.Exp R.SingleSelection -> Avers a+runQuerySingleSelection query = do+ res <- runQuery query+ case res of+ Nothing -> documentNotFound "..."+ Just x -> parseDatum x++runQueryDatum :: (R.FromDatum a) => R.Exp R.Datum -> Avers a+runQueryDatum query = do+ res <- runQuery query+ parseDatum res++runQuery :: (R.FromResponse (R.Result a)) => R.Exp a -> Avers (R.Result a)+runQuery query = do+ pool <- gets databaseHandlePool+ res <- liftIO $ withResource pool $ \handle -> do+ R.run handle query++ case res of+ Left e -> databaseError (T.pack $ show e)+ Right r -> return r++runQueryCollect :: (R.FromDatum a, R.IsSequence e, R.Result e ~ R.Sequence a) => R.Exp e -> Avers (V.Vector a)+runQueryCollect query = do+ pool <- gets databaseHandlePool+ res <- liftIO $ withResource pool $ \handle -> do+ r0 <- R.run handle query+ case r0 of+ Left e -> return $ Left e+ Right x -> R.collect handle x++ case res of+ Left e -> databaseError (T.pack $ show e)+ Right r -> return r++++existsDocument :: (Pk k) => R.Exp R.Table -> k -> Avers Bool+existsDocument table key = do+ res <- runQuery $ R.IsEmpty $ R.Filter (primaryKeyEqE (toPk key)) table+ return $ not res+++lookupDocument :: (Pk k, R.FromDatum a) => R.Exp R.Table -> k -> Avers (Maybe a)+lookupDocument table key = do+ res <- runQuery $ R.Get table (R.lift (toPk key))+ maybe (return Nothing) parseDatum res+++insertDocument :: (R.ToDatum a, Pk a) => R.Exp R.Table -> a -> Avers ()+insertDocument table doc = do+ resp <- runQuery $ R.InsertObject R.CRError table (mergePk doc)+ checkWriteResponse $ Just $ R.Object resp+++deleteDocument :: (Pk k) => R.Exp R.Table -> k -> Avers ()+deleteDocument table key = do+ resp <- runQuery $ R.Delete $ R.Get table (R.lift $ toPk key)+ checkWriteResponse $ Just $ R.Object resp+++upsertDocument :: (R.ToDatum a, Pk a) => R.Exp R.Table -> a -> Avers ()+upsertDocument table doc = do+ resp <- runQuery $ R.InsertObject R.CRReplace table (mergePk doc)+ checkWriteResponse $ Just $ R.Object resp++$(deriveDatum (deriveJSONOptions "writeResponse") ''WriteResponse)
+ src/Avers/Storage/Expressions.hs view
@@ -0,0 +1,52 @@+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE TemplateHaskell #-}+{-# LANGUAGE TypeFamilies #-}+++{-|++This module contains RethinkDB Expressions which are used to build queries.++-}++module Avers.Storage.Expressions where+++import Prelude hiding (lookup)++import Data.Text (Text)+import Database.RethinkDB as R+++-- | The primary key in all our documents is the default "id".+primaryKeyField :: Text+primaryKeyField = "id"+++-- | Expression which represents the primary key field.+primaryKeyFieldE :: Exp Text+primaryKeyFieldE = lift primaryKeyField+++-- | Expression which represents the value of a field inside of an Object.+objectFieldE :: (IsDatum a) => Text -> Exp Object -> Exp a+objectFieldE field obj = GetField (lift field) obj+++-- | True if the object field matches the given value.+objectFieldEqE :: (ToDatum a) => Text -> a -> Exp Object -> Exp Bool+objectFieldEqE field value obj = Eq+ (objectFieldE field obj :: Exp Datum)+ (lift $ toDatum value)+++-- | True if the object's primary key matches the given string.+primaryKeyEqE :: Text -> Exp Object -> Exp Bool+primaryKeyEqE = objectFieldEqE primaryKeyField+++-- | Take the first item out of a sequence.+headE :: (IsSequence a, IsDatum r) => Exp a -> Exp r+headE = Nth 0
+ src/Avers/TH.hs view
@@ -0,0 +1,234 @@+{-# LANGUAGE TemplateHaskell #-}++module Avers.TH+ ( deriveJSON+ , deriveJSONOptions+ , variantOptions+ , defaultVariantOptions++ , deriveEncoding+ , deriveRecordEncoding++ , FromJSON(..)+ , ToJSON(..)+ ) where+++import Language.Haskell.TH++import Control.Applicative+import Control.Monad++import Data.Char++import qualified Data.HashMap.Strict as HM+import qualified Data.Text as T++import Data.Aeson+import Data.Aeson.TH+import qualified Data.Aeson.Types as A++import Text.Inflections++import qualified Database.RethinkDB as R+import Database.RethinkDB (toDatum, FromDatum(..))+import Database.RethinkDB.TH++++dropPrefix :: String -> String -> String+dropPrefix prefix x = toLower (head rest) : tail rest+ where rest = drop (length prefix) x+++-- FIXME: Should dasherize and drop the prefix from the constructor as well!+deriveJSONOptions :: String -> Options+deriveJSONOptions prefix = defaultOptions+ { fieldLabelModifier = dropPrefix prefix+ , constructorTagModifier = map toLower+ }++dasherizeTag :: String -> String+dasherizeTag x = case parseCamelCase [] x of+ Left err -> error $ show err+ Right res -> map toLower $ dasherize res++variantOptions :: String -> String -> String -> Options+variantOptions tagField contentsField prefix = defaultOptions+ { constructorTagModifier = dasherizeTag . dropPrefix prefix+ , sumEncoding = TaggedObject tagField contentsField+ }++defaultVariantOptions :: String -> Options+defaultVariantOptions = variantOptions "type" "content"+++deriveEncoding :: Options -> Name -> Q [Dec]+deriveEncoding opts name =+ liftM2 (++)+ (deriveJSON opts name)+ (deriveDatum opts name)+++deriveEncodingWithDefaults :: Options -> Name -> [(String, Q Exp)] -> Q [Dec]+deriveEncodingWithDefaults options typeN defaults =+ liftM2 (++)+ (deriveJSONWithDefaults options typeN defaults)+ (deriveDatumWithDefaults options typeN defaults)+++deriveRecordEncoding :: Name -> String -> [(String, Q Exp)] -> Q [Dec]+deriveRecordEncoding typeN prefix defaults =+ deriveEncodingWithDefaults (deriveJSONOptions prefix) typeN defaults++++------------------------------------------------------------------------------+-- JSON++deriveJSONWithDefaults :: Options -> Name -> [(String, Q Exp)] -> Q [Dec]+deriveJSONWithDefaults options typeN defaults = liftM2 (++)+ (deriveToJSON options typeN)+ (deriveFromJSONWithDefaults options typeN defaults)++deriveFromJSONWithDefaults :: Options -> Name -> [(String, Q Exp)] -> Q [Dec]+deriveFromJSONWithDefaults options typeN defaults = do+ xN <- newName "x"+ (tyVarsBndrs, fieldNames) <- getTyInfo typeN+ parseJsonE <- mkParseJSON options typeN+ insertDefaultsE <- mkInsertDefaults defaults+ modifyObjectE <- [|modifyObject|]+ let tyVars = tyVarBndrNames tyVarsBndrs+ fieldNames' = map (fieldLabelModifier options . nameBase) fieldNames++ forM_ defaults $ \(name, _) ->+ when (name `notElem` fieldNames') $ fail $+ "Avers.TH.deriveFromJSONWithDefaults: default " +++ "specified for " ++ show name ++ " but this field does not exist."++ return+ [ InstanceD [ClassP ''FromJSON [VarT tv] | tv <- tyVars]+ (AppT fromJsonT (mkAppTys (typeT : map VarT tyVars)))+ [ FunD 'parseJSON+ [ Clause [VarP xN]+ (NormalB (AppE parseJsonE (mkApps+ [modifyObjectE, insertDefaultsE, VarE xN])))+ []+ ]+ ]+ ]+ where+ typeT = ConT typeN+ fromJsonT = ConT ''FromJSON++modifyObject :: (A.Object -> A.Object) -> A.Value -> A.Value+modifyObject f (A.Object o) = A.Object (f o)+modifyObject _ v = v+{-# INLINE modifyObject #-}++mkInsertDefaults :: [(String, Q Exp)] -> Q Exp+mkInsertDefaults defaults = do+ yN <- newName "y"+ bodyE <- foldM insertDefault (VarE yN) defaults+ return $ LamE [VarP yN] bodyE+ where+ flipE = VarE 'flip+ constE = VarE 'const+ insertWithE = VarE 'HM.insertWith+ toJsonE = VarE 'toJSON++ insertDefault hmE (field, expQ) = do+ textE <- [|T.pack field|]+ defaultE <- expQ+ return $ mkApps [insertWithE, AppE flipE constE,+ textE, AppE toJsonE defaultE, hmE]+++------------------------------------------------------------------------------+-- Datum++deriveDatumWithDefaults :: Options -> Name -> [(String, Q Exp)] -> Q [Dec]+deriveDatumWithDefaults options typeN defaults = liftM2 (++)+ (deriveToDatum options typeN)+ (deriveFromDatumWithDefaults options typeN defaults)++deriveFromDatumWithDefaults :: Options -> Name -> [(String, Q Exp)] -> Q [Dec]+deriveFromDatumWithDefaults options typeN defaults = do+ xN <- newName "x"+ (tyVarsBndrs, fieldNames) <- getTyInfo typeN+ parseJsonE <- mkParseDatum options typeN+ insertDefaultsE <- mkInsertDatumDefaults defaults+ modifyObjectE <- [|modifyDatumObject|]+ let tyVars = tyVarBndrNames tyVarsBndrs+ fieldNames' = map (fieldLabelModifier options . nameBase) fieldNames++ forM_ defaults $ \(name, _) ->+ when (name `notElem` fieldNames') $ fail $+ "Avers.TH.deriveFromDatumWithDefaults: default " +++ "specified for " ++ show name ++ " but this field does not exist."++ return+ [ InstanceD [ClassP ''FromDatum [VarT tv] | tv <- tyVars]+ (AppT fromDatumT (mkAppTys (typeT : map VarT tyVars)))+ [ FunD 'parseDatum+ [ Clause [VarP xN]+ (NormalB (AppE parseJsonE (mkApps+ [modifyObjectE, insertDefaultsE, VarE xN])))+ []+ ]+ ]+ ]+ where+ typeT = ConT typeN+ fromDatumT = ConT ''FromDatum++modifyDatumObject :: (R.Object -> R.Object) -> R.Datum -> R.Datum+modifyDatumObject f (R.Object o) = R.Object (f o)+modifyDatumObject _ v = v+{-# INLINE modifyDatumObject #-}++mkInsertDatumDefaults :: [(String, Q Exp)] -> Q Exp+mkInsertDatumDefaults defaults = do+ yN <- newName "y"+ bodyE <- foldM insertDefault (VarE yN) defaults+ return $ LamE [VarP yN] bodyE+ where+ flipE = VarE 'flip+ constE = VarE 'const+ insertWithE = VarE 'HM.insertWith+ toJsonE = VarE 'toDatum++ insertDefault hmE (field, expQ) = do+ textE <- [|T.pack field|]+ defaultE <- expQ+ return $ mkApps [insertWithE, AppE flipE constE,+ textE, AppE toJsonE defaultE, hmE]++++mkApps :: [Exp] -> Exp+mkApps = foldl1 AppE++mkAppTys :: [Type] -> Type+mkAppTys = foldl1 AppT++getTyInfo :: Name -> Q ([TyVarBndr], [Name])+getTyInfo typeN = do+ info <- reify typeN+ case info of+ TyConI (DataD _ _ tvbs cons _) -> pure (tvbs, getFieldNames =<< cons)+ TyConI (NewtypeD _ _ tvbs con _) -> pure (tvbs, getFieldNames con)+ _ -> fail $+ "Avers.TH.getTyInfo: only simple data/newtype " +++ "constructors are supported."++tyVarBndrNames :: [TyVarBndr] -> [Name]+tyVarBndrNames = map $ \tvb -> case tvb of+ PlainTV n -> n+ KindedTV n _ -> n++getFieldNames :: Con -> [Name]+getFieldNames (NormalC _ _) = []+getFieldNames (InfixC _ _ _) = []+getFieldNames (ForallC _ _ con) = getFieldNames con+getFieldNames (RecC _ fields) = [name | (name, _, _) <- fields]
+ src/Avers/Types.hs view
@@ -0,0 +1,604 @@+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE GADTs #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE TemplateHaskell #-}++module Avers.Types where++import Control.Applicative++import Control.Monad.Except+import Control.Monad.State++import Control.Concurrent.STM++import Data.Time.Clock+import Data.String+import Data.ByteString.Lazy (ByteString)++import Data.Text (Text)+import qualified Data.Text as T++import Data.Map (Map)+import qualified Data.Map as M++import Data.Monoid+import Data.Char++import Data.Attoparsec.Text++import qualified Data.Aeson as Aeson+import qualified Data.Aeson.Types as Aeson+import Data.Aeson (Value(String))+import Data.Aeson.Types (parseEither)++import qualified Database.RethinkDB as R+import Database.RethinkDB.TH++import qualified Database.InfluxDB as InfluxDB++import Data.Pool++import Avers.TH+import Avers.Index++++-----------------------------------------------------------------------------+-- | Pk - Types which can be converted to a database primary key.++class Pk a where+ toPk :: a -> Text++instance Pk Text where+ toPk = id++++-----------------------------------------------------------------------------+-- | Path++newtype Path = Path { unPath :: Text }+ deriving (Eq, Ord, Show)++instance IsString Path where+ fromString = Path . T.pack++instance ToJSON Path where+ toJSON = toJSON . unPath++instance FromJSON Path where+ parseJSON (String s) = return $ Path s+ parseJSON _ = fail "Path"++instance R.FromDatum Path where+ parseDatum (R.String s) = return $ Path s+ parseDatum _ = fail "Path"++instance R.ToDatum Path where+ toDatum = R.toDatum . unPath++++-----------------------------------------------------------------------------+-- | ObjId++newtype ObjId = ObjId { unObjId :: Text }+ deriving (Eq, Ord, Show)++instance Pk ObjId where+ toPk = unObjId++instance ToJSON ObjId where+ toJSON = toJSON . unObjId++instance FromJSON ObjId where+ parseJSON x = ObjId <$> parseJSON x++instance R.FromDatum ObjId where+ parseDatum x = ObjId <$> R.parseDatum x++instance R.ToDatum ObjId where+ toDatum = R.toDatum . unObjId+++-- | The root object id is used for object created internally or when there+-- is no applicable creator.+rootObjId :: ObjId+rootObjId = ObjId ""++++-----------------------------------------------------------------------------+-- | RevId++newtype RevId = RevId { unRevId :: Int }+ deriving (Eq, Ord, Show)++instance Enum RevId where+ succ (RevId x) = RevId (succ x)+ pred (RevId x) = RevId (pred x)+ toEnum = RevId+ fromEnum = unRevId++instance Pk RevId where+ toPk = T.pack . show . unRevId++instance ToJSON RevId where+ toJSON = toJSON . unRevId++instance FromJSON RevId where+ parseJSON x = RevId <$> parseJSON x++instance R.FromDatum RevId where+ parseDatum x = RevId <$> R.parseDatum x++instance R.ToDatum RevId where+ toDatum = R.toDatum . unRevId+++-- | The 'RevId' which is used for the initial snapshot.+zeroRevId :: RevId+zeroRevId = RevId 0++++-----------------------------------------------------------------------------+-- | ObjectId++data ObjectId++ = BaseObjectId !ObjId+ -- ^ The base object whose snapshots contain the actual content.++ | ReleaseObjectId !ObjId !RevId+ -- ^ An object describing a particualar release of the base object.++ | AuthorizationObjectId !ObjId+ -- ^ Object which contains authorization rules.++ deriving (Eq, Ord, Show)+++instance Pk ObjectId where+ toPk (BaseObjectId objId) = toPk objId+ toPk (ReleaseObjectId objId revId) = toPk objId <> "/release/" <> toPk revId+ toPk (AuthorizationObjectId objId) = toPk objId <> "/authorization"++instance ToJSON ObjectId where+ toJSON = toJSON . toPk++instance FromJSON ObjectId where+ parseJSON (String x) = either fail return $ parseOnly objectIdParser x+ parseJSON _ = fail "ObjectId"++instance R.FromDatum ObjectId where+ parseDatum (R.String x) = either fail return $ parseOnly objectIdParser x+ parseDatum _ = fail "ObjectId"++instance R.ToDatum ObjectId where+ toDatum = R.toDatum . toPk+++objectIdParser :: Parser ObjectId+objectIdParser = (releaseObjectId <|> authorizationObjectId <|> baseObjectId) <* endOfInput+ where+ objId = ObjId <$> takeWhile1 isAlphaNum+ revId = RevId <$> decimal++ baseObjectId = BaseObjectId+ <$> objId++ releaseObjectId = ReleaseObjectId+ <$> objId+ <* string "/release/"+ <*> revId++ authorizationObjectId = AuthorizationObjectId+ <$> objId+ <* string "/authorization"+++parseObjectId :: Text -> Maybe ObjectId+parseObjectId text = case parseOnly objectIdParser text of+ Left _ -> Nothing+ Right v -> Just v+++objectIdBase :: ObjectId -> ObjId+objectIdBase (BaseObjectId objId ) = objId+objectIdBase (ReleaseObjectId objId _) = objId+objectIdBase (AuthorizationObjectId objId ) = objId++++-----------------------------------------------------------------------------+-- | The operations that can be applied to JSON values.+data Operation+ -- | Set is applied to 'Object's. It is used for adding, updating+ -- and deleting properties from the object.+ = Set+ { opPath :: !Path+ , opValue :: !(Maybe Value)+ }++ -- | Splice is used to manipulate 'Array's. It can remove and insert+ -- multiple elements in a single operation.+ | Splice+ { opPath :: !Path+ , opIndex :: !Int+ , opRemove :: !Int+ , opInsert :: ![ Value ]+ }++ deriving (Eq, Show)++$(deriveEncoding (deriveJSONOptions "op"){+ omitNothingFields = True,+ sumEncoding = TaggedObject "type" "content"+} ''Operation)++++data PatchError+ = UnknownPatchError !Text+ deriving (Show)++type PatchM a = Either PatchError a+++data Object = Object+ { objectId :: !ObjId+ , objectType :: !Text+ , objectCreatedAt :: !UTCTime+ , objectCreatedBy :: !ObjId+ , objectDeleted :: !(Maybe Bool)+ } deriving (Show)++instance Pk Object where+ toPk = toPk . objectId++$(deriveEncoding (deriveJSONOptions "object") ''Object)++++-----------------------------------------------------------------------------+-- | Patch++data Patch = Patch+ { patchObjectId :: !ObjectId+ , patchRevisionId :: !RevId+ , patchAuthorId :: !ObjId+ , patchCreatedAt :: !UTCTime+ , patchOperation :: !Operation+ } deriving (Show)++instance Pk Patch where+ toPk Patch{..} = toPk patchObjectId <> "@" <> toPk patchRevisionId++$(deriveEncoding (deriveJSONOptions "patch") ''Patch)++++-----------------------------------------------------------------------------+-- | Snapshot++data Snapshot = Snapshot+ { snapshotObjectId :: !ObjectId+ , snapshotRevisionId :: !RevId+ , snapshotContent :: !Value+ } deriving (Show)++instance Pk Snapshot where+ toPk Snapshot{..} = toPk snapshotObjectId <> "@" <> toPk snapshotRevisionId++$(deriveEncoding (deriveJSONOptions "snapshot") ''Snapshot)++++-----------------------------------------------------------------------------+-- | Release++data Release = Release++instance ToJSON Release where+ toJSON = const Aeson.emptyObject++instance FromJSON Release where+ parseJSON (Aeson.Object _) = return Release+ parseJSON _ = fail "Release"++-- $(deriveEncoding (deriveJSONOptions "release") ''Release)++++-----------------------------------------------------------------------------+-- | SecretId++newtype SecretId = SecretId { unSecretId :: Text }+ deriving (Show)++instance Pk SecretId where+ toPk = unSecretId++instance ToJSON SecretId where+ toJSON = toJSON . unSecretId++instance FromJSON SecretId where+ parseJSON x = SecretId <$> parseJSON x++instance R.FromDatum SecretId where+ parseDatum x = SecretId <$> R.parseDatum x++instance R.ToDatum SecretId where+ toDatum = R.toDatum . unSecretId++++-----------------------------------------------------------------------------+-- | Secret++data Secret = Secret+ { secretId :: !SecretId+ , secretValue :: !Text+ }++instance Pk Secret where+ toPk = toPk . secretId++$(deriveEncoding (deriveJSONOptions "secret") ''Secret)++++-----------------------------------------------------------------------------+-- | BlobId++newtype BlobId = BlobId { unBlobId :: Text }+ deriving (Show)++instance Pk BlobId where+ toPk = unBlobId++instance ToJSON BlobId where+ toJSON = toJSON . unBlobId++instance FromJSON BlobId where+ parseJSON x = BlobId <$> parseJSON x++instance R.FromDatum BlobId where+ parseDatum x = BlobId <$> R.parseDatum x++instance R.ToDatum BlobId where+ toDatum = R.toDatum . unBlobId++++-----------------------------------------------------------------------------+-- | Blob++data Blob = Blob+ { blobId :: !BlobId+ , blobSize :: !Int+ , blobContentType :: !Text+ } deriving (Show)++instance Pk Blob where+ toPk = toPk . blobId++$(deriveEncoding (deriveJSONOptions "blob") ''Blob)++++-----------------------------------------------------------------------------+-- | SessionId++newtype SessionId = SessionId { unSessionId :: Text }++instance Pk SessionId where+ toPk = unSessionId++instance ToJSON SessionId where+ toJSON = toJSON . unSessionId++instance FromJSON SessionId where+ parseJSON x = SessionId <$> parseJSON x++instance R.FromDatum SessionId where+ parseDatum x = SessionId <$> R.parseDatum x++instance R.ToDatum SessionId where+ toDatum = R.toDatum . unSessionId++++-----------------------------------------------------------------------------+-- | The record that is stored in the database.++data Session = Session+ { sessionId :: !SessionId+ , sessionAccountId :: !ObjId+ , sessionCreatedAt :: !UTCTime+ , sessionLastAccessedAt :: !UTCTime+ }++instance Pk Session where+ toPk Session{..} = toPk sessionId++$(deriveEncoding (deriveJSONOptions "session") ''Session)++++data AversError+ = InternalError !AversError+ | DatabaseError !Text+ | PatchError !PatchError+ | ParseError !Value !Text+ | UnknownObjectType !Text+ | ObjectNotFound !ObjId+ | DocumentNotFound !Text+ | AversError !Text+ | NotAuthorized+ deriving (Show)+++internalError :: AversError -> Avers a+internalError = throwError . InternalError++internal :: Avers a -> Avers a+internal m = m `catchError` internalError++databaseError :: Text -> Avers a+databaseError = throwError . DatabaseError++patchError :: PatchError -> Avers a+patchError = throwError . PatchError++parseError :: (MonadError AversError m) => Value -> Text -> m a+parseError value text = throwError $ ParseError value text++documentNotFound :: Text -> Avers a+documentNotFound = throwError . DocumentNotFound++strErr :: String -> Avers a+strErr = throwError . AversError . T.pack+++-- | An 'ObjectType' describes a particular type of object that is managed by+-- Avers.+data ObjectType a = ObjectType+ { otType :: !Text+ -- ^ The value of the @type@ field of the 'Object'.++ , otId :: Avers ObjId+ -- ^ Action which generates a new id. This is so that object types can+ -- have different strategies how to generate ids.++ , otViews :: [SomeView a]+ }++data SomeObjectType where+ SomeObjectType :: (R.ToDatum a, R.FromDatum a, FromJSON a, ToJSON a)+ => ObjectType a -> SomeObjectType++parseValueAs :: (FromJSON a) => ObjectType a -> Value -> Either AversError a+parseValueAs ObjectType{..} value = case parseEither parseJSON value of+ Left e -> parseError value (T.pack $ show e)+ Right x -> return x++++-- | Configuration of the 'Avers' monad.+data AversConfig = AversConfig++ { databaseHost :: !Text+ -- ^ The hostname where RethinkDB is running. The port is currently not+ -- configurable.++ , databaseName :: !Text+ -- ^ RethinkDB supports multiple databases. This is the name of the one+ -- which should be used.++ , influxConfig :: !(Maybe InfluxDB.Config)+ -- ^ The influx server where avers reports metrics to.++ , putBlob :: BlobId -> Text -> ByteString -> IO ()+ -- ^ Function which saves the given blob in the blob store. This can be+ -- the local filesystem or an external services such as Amazon S3.+ --+ -- TODO: Propagate errors back to the caller.++ , objectTypes :: ![SomeObjectType]+ -- ^ All the object types which Avers knows about.+ }+++data AversState = AversState+ { config :: !AversConfig+ -- ^ A reference to the config, just in case we need it.++ , databaseHandlePool :: !(Pool R.Handle)+ -- ^ A pool of handles which are used to access the database.++ , recentRevisionCache :: !(TVar (Map ObjectId RevId))+ -- ^ Map from 'ObjectId' to a recent 'RevId'. It may be the latest or+ -- a few revisions behind.+ }++++newDatabaseHandlePool :: AversConfig -> IO (Pool R.Handle)+newDatabaseHandlePool AversConfig{..} =+ createPool create destroy numStripes idleTime maxResources++ where+ create = do+ putStrLn $ mconcat+ [ "Creating a new RethinkDB handle to "+ , T.unpack databaseHost+ , ":28015"+ , " database "+ , T.unpack databaseName+ ]++ R.newHandle databaseHost 28015 Nothing (R.Database (R.lift databaseName))++ destroy handle = do+ putStrLn "Closing RethinkDB handle"+ R.close handle++ numStripes = 1+ idleTime = fromIntegral $ (60 * 60 :: Int)+ maxResources = 10+++newState :: AversConfig -> IO AversState+newState config = do+ AversState+ <$> pure config+ <*> newDatabaseHandlePool config+ <*> newTVarIO M.empty+++newtype Avers a = Avers+ { runAvers :: StateT AversState (ExceptT AversError IO) a+ } deriving (Functor, Applicative, Monad, MonadIO, MonadError AversError, MonadState AversState)++class (Monad m) => MonadAvers m where+ liftAvers :: Avers a -> m a++instance MonadAvers Avers where+ liftAvers = id++instance MonadAvers m => MonadAvers (StateT s m) where+ liftAvers = lift . liftAvers++evalAvers :: AversState -> Avers a -> IO (Either AversError a)+evalAvers h m = runExceptT $ evalStateT (runAvers m) h++++------------------------------------------------------------------------------+-- View++data View obj a = View+ { viewName :: Text+ -- ^ The table name is derived from the view name. Therefore it should+ -- be unique amongst all views.++ , viewParser :: R.Datum -> Either AversError a+ -- ^ Function which parses objects stored in this view.++ , viewObjectTransformer :: obj -> Avers (Maybe a)+ -- ^ Function which transforms an Avers Object into a type stored+ -- in the view.++ , viewIndices :: [Index]+ -- ^ Secondary indices defined on the view.+ }+++data SomeView obj where+ SomeView :: (R.ToDatum a, R.FromDatum a, FromJSON obj, ToJSON a)+ => View obj a -> SomeView obj
+ src/Avers/Views.hs view
@@ -0,0 +1,66 @@+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE GADTs #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE TemplateHaskell #-}++module Avers.Views where+++import Control.Monad++import Data.Aeson as Aeson+import Data.Monoid+import qualified Data.HashMap.Strict as HMS++import qualified Database.RethinkDB as R++import Avers.Types+import Avers.Storage.Backend++++-- | Construct the table name for the given view. The table names look+-- something like this: "view_openGames"+viewTable :: View obj a -> R.Exp R.Table+viewTable View{..} = R.Table Nothing $ R.lift $ mconcat+ [ "view_"+ , viewName+ ]+++data Record a = Record+ { recId :: ObjId+ , recContent :: a+ }++instance Pk (Record a) where+ toPk = toPk . recId++instance (ToJSON a) => ToJSON (Record a) where+ toJSON Record{..} = Aeson.Object $ HMS.insert "id" (Aeson.String $ toPk recId) hms+ where (Aeson.Object hms) = toJSON recContent++instance (R.ToDatum a) => R.ToDatum (Record a) where+ toDatum Record{..} = R.Object $ HMS.insert "id" (R.String $ toPk recId) $+ HMS.fromList $ map (\(k,v) -> (k, R.toDatum v)) $ HMS.toList hms+ where (R.Object hms) = R.toDatum recContent++++updateObjectViews :: ObjectType a -> ObjId -> Maybe a -> Avers ()+updateObjectViews ObjectType{..} objId mbObj = do+ forM_ otViews $ \(SomeView view) -> do+ updateView view objId mbObj+++updateView :: (R.ToDatum a) => View obj a -> ObjId -> Maybe obj -> Avers ()+updateView view@View{..} objId mbObj = do+ case mbObj of+ Nothing -> deleteDocument (viewTable view) objId+ Just obj -> do+ mbRecord <- viewObjectTransformer obj+ case mbRecord of+ Nothing -> deleteDocument (viewTable view) objId+ Just rec -> upsertDocument (viewTable view) (Record objId rec)