diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/Tests/Main.hs b/Tests/Main.hs new file mode 100644 --- /dev/null +++ b/Tests/Main.hs @@ -0,0 +1,13 @@ +import Test.Framework (defaultMain) + +import Tests.Data.Binary.C (cBinaryTests) +import Tests.Codec.Compression.LZF.ByteString (lzfByteStringTests) +import Tests.Database.Alteryx (yxdbTests) + +main = defaultMain tests +tests = + [ + cBinaryTests, + lzfByteStringTests, + yxdbTests + ] diff --git a/bin-src/Csv2Yxdb.hs b/bin-src/Csv2Yxdb.hs new file mode 100644 --- /dev/null +++ b/bin-src/Csv2Yxdb.hs @@ -0,0 +1,3 @@ +import Database.Alteryx.CLI.Csv2Yxdb (csv2yxdbMain) + +main = csv2yxdbMain diff --git a/bin-src/Yxdb2Csv.hs b/bin-src/Yxdb2Csv.hs new file mode 100644 --- /dev/null +++ b/bin-src/Yxdb2Csv.hs @@ -0,0 +1,3 @@ +import Database.Alteryx.CLI.Yxdb2Csv (yxdb2csvMain) + +main = yxdb2csvMain diff --git a/src/Codec/Compression/LZF/ByteString.hs b/src/Codec/Compression/LZF/ByteString.hs new file mode 100644 --- /dev/null +++ b/src/Codec/Compression/LZF/ByteString.hs @@ -0,0 +1,84 @@ +module Codec.Compression.LZF.ByteString ( + compressByteString, + compressByteStringFixed, + compressLazyByteString, + decompressByteString, + decompressByteStringFixed, + decompressLazyByteString, +) where + +import Codec.Compression.LZF (compress, decompress) +import Control.Monad (when) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BSL +import Data.ByteString.Unsafe +import Foreign.C +import GHC.Ptr +import System.IO.Unsafe (unsafePerformIO) +import Foreign.Marshal.Alloc + +import Debug.Trace + +maximumAutomaticMemoryLimit :: Int +maximumAutomaticMemoryLimit = 67108864 -- 64 MB + +mapChunks :: (BS.ByteString -> BS.ByteString) -> BSL.ByteString -> BSL.ByteString +mapChunks f bs = BSL.fromChunks . map f . BSL.toChunks $ bs + +decompressLazyByteString :: BSL.ByteString -> BSL.ByteString +decompressLazyByteString = mapChunks decompressByteString + +compressLazyByteString :: BSL.ByteString -> BSL.ByteString +compressLazyByteString = mapChunks compressByteString + +_runFunctionInNewBufferSafe ::(Ptr CChar -> Int -> Ptr CChar -> Int -> IO Int) -> BS.ByteString -> Int -> IO (Maybe BS.ByteString) +_runFunctionInNewBufferSafe f bs numOutputBytes = do + unsafeUseAsCStringLen bs $ \(input, len) -> + if len == 0 + then return $ Just BS.empty + else do + output <- mallocBytes numOutputBytes +-- traceShowM $ (input, len, output, numOutputBytes) + res <- f input len output numOutputBytes + if res == 0 + then do + free output + return Nothing + else do + outBs <- unsafePackMallocCStringLen (output, res) -- should this be 'output'? + return $ Just outBs + +_runFunctionInNewBufferWithSizeGuess :: Int -> (Ptr CChar -> Int -> Ptr CChar -> Int -> IO Int) -> BS.ByteString -> IO BS.ByteString +_runFunctionInNewBufferWithSizeGuess maximumSize f bs = + if BS.null bs + then return $ BS.empty + else do + let initialGuess = 2 * (BS.length bs) + let try size = do + when (size <= 0) $ + fail $ + "Codec.Compression.LZF.ByteString: Invalid size" ++ show size + result <- _runFunctionInNewBufferSafe f bs size + case result of + Nothing -> if size > maximumSize + then error $ "_runFunctionInNewBufferWithSizeGuess: Bailing out due to size limit. (Requested, Cap): " ++ show (size, maximumSize) + else try $ size * 2 + Just outBs -> return outBs + try initialGuess + +decompressByteString :: BS.ByteString -> BS.ByteString +decompressByteString bs = + unsafePerformIO $ _runFunctionInNewBufferWithSizeGuess maximumAutomaticMemoryLimit decompress bs + +decompressByteStringFixed :: Int -> BS.ByteString -> Maybe BS.ByteString +decompressByteStringFixed size bs = + unsafePerformIO $ _runFunctionInNewBufferSafe decompress bs size + +compressByteString :: BS.ByteString -> BS.ByteString +compressByteString bs = + unsafePerformIO $ _runFunctionInNewBufferWithSizeGuess maximumAutomaticMemoryLimit compress bs + +compressByteStringFixed :: Int -> BS.ByteString -> Maybe BS.ByteString +compressByteStringFixed size bs = + unsafePerformIO $ _runFunctionInNewBufferSafe compress bs size + diff --git a/src/Data/Binary/C.hs b/src/Data/Binary/C.hs new file mode 100644 --- /dev/null +++ b/src/Data/Binary/C.hs @@ -0,0 +1,17 @@ +module Data.Binary.C () where + +import Control.Applicative ((<$>)) +import Data.Binary +import Data.Binary.Get +import Data.Binary.Put +import Data.ReinterpretCast (floatToWord, wordToFloat, doubleToWord, wordToDouble) +import Foreign.C.Types +import GHC.Prim (coerce) + +instance Binary CFloat where + get = coerce <$> wordToFloat <$> getWord32le + put = putWord32le . floatToWord . coerce + +instance Binary CDouble where + get = coerce <$> wordToDouble <$> getWord64le + put = putWord64le . doubleToWord . coerce diff --git a/src/Database/Alteryx.hs b/src/Database/Alteryx.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx.hs @@ -0,0 +1,18 @@ +{-# LANGUAGE TemplateHaskell,OverloadedStrings,MultiParamTypeClasses #-} + +module Database.Alteryx + ( + module Database.Alteryx.CLI.PrettyPrinters, + module Database.Alteryx.CSVConversion, + module Database.Alteryx.Fields, + module Database.Alteryx.Types, + module Database.Alteryx.Serialization, + module Database.Alteryx.StreamingYxdb + ) where + +import Database.Alteryx.CLI.PrettyPrinters +import Database.Alteryx.CSVConversion +import Database.Alteryx.Fields +import Database.Alteryx.Types +import Database.Alteryx.Serialization +import Database.Alteryx.StreamingYxdb diff --git a/src/Database/Alteryx/CLI/Csv2Yxdb.hs b/src/Database/Alteryx/CLI/Csv2Yxdb.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/CLI/Csv2Yxdb.hs @@ -0,0 +1,146 @@ +{-# LANGUAGE TemplateHaskell,OverloadedStrings #-} +module Database.Alteryx.CLI.Csv2Yxdb where + +import Database.Alteryx + +import Control.Applicative +import Control.Lens +import Control.Monad.State +import Control.Monad.Trans.Resource +import Data.Attoparsec.Text +import Data.Conduit as C +import Data.Conduit.Binary as C +import Data.Conduit.List as CL +import Data.Conduit.Text as CT +import qualified Data.CSV.Conduit as CSVT +import qualified Data.CSV.Conduit.Parser.Text as CSVT +import Data.Maybe +import Data.Monoid +import Data.Text as T hiding (null, foldl, head) +import System.Console.GetOpt +import System.Environment +import System.IO hiding (putStrLn, utf8) + +data Settings = Settings { + _settingHeader :: Maybe T.Text, + _settingFilename :: FilePath, + _settingOutput :: FilePath, + _settingCSV :: CSVT.CSVSettings, + _settingInternal :: Bool, + _settingMetadata :: Bool, + _settingVerbose :: Bool + } deriving (Eq, Show) + +makeLenses ''Settings + +options :: [OptDescr (Settings -> Settings)] +options = + [ + Option ['h'] ["header"] (ReqArg (\o -> (& settingHeader .~ Just (T.pack o))) "Header line") "If you'd prefer not to include header lines in the CSV file, you can provide it on the command line", + Option ['o'] ["output"] (ReqArg (\o -> (& settingOutput .~ o)) "Output filename" ) "Name of the output file", + Option ['i'] ["dump-internal"] (NoArg (& settingInternal .~ True)) "Dump internal representation of parsed records", + Option ['m'] ["dump-metadata"] (NoArg (& settingMetadata .~ True)) "Dump deduced metadata about the file", + Option ['v'] ["verbose"] (NoArg (& settingVerbose .~ True)) "Print extra debugging information on stderr" + ] + +defaultSettings :: Settings +defaultSettings = Settings { + _settingHeader = Nothing, + _settingFilename = error "defaultSettings: Must provide a filename", + _settingOutput = error "defaultsettings: Must provide an output file", + _settingCSV = alteryxCsvSettings, + _settingInternal = False, + _settingMetadata = False, + _settingVerbose = False + } + +parseOptions :: [String] -> IO ([Settings -> Settings]) +parseOptions args = + case getOpt Permute options args of + (opts, filename:[], []) -> return $ (&settingFilename .~ filename):opts + (_, [], []) -> fail $ "Must provide a filename\n" ++ usageInfo header options + (_, _, errors) -> fail $ Prelude.concat errors ++ usageInfo header options + where + header = "Usage: csv2yxdb [OPTIONS...] filename" + +processOptions :: [Settings -> Settings] -> Settings +processOptions = Prelude.foldl (flip ($)) defaultSettings + +getSettings :: IO Settings +getSettings = do + argv <- getArgs + opts <- parseOptions argv + return $ processOptions opts + +getRecordInfo :: StateT Settings IO (Maybe RecordInfo) +getRecordInfo = + let readHeaderFromFile = do + settings <- get + let filename = settings ^. settingFilename + mLine <- runResourceT $ + sourceFile filename =$= + decode utf8 =$= + CT.lines $$ + CL.head + return mLine + in do + settings <- get + mLine <- case settings ^. settingHeader of + Nothing -> readHeaderFromFile + Just x -> return $ Just x + case mLine of + Nothing -> do + liftIO $ putStrLn "No header found" + return Nothing + Just line -> liftIO $ do + let eRecordInfo = parseOnly parseCSVHeader line + case eRecordInfo of + Left e -> do + liftIO $ putStrLn $ show e + return Nothing + Right recordInfo -> return $ Just recordInfo + + +runMetadata :: StateT Settings IO () +runMetadata = do + mRecordInfo <- getRecordInfo + case mRecordInfo of + Nothing -> return () + Just recordInfo -> liftIO $ printRecordInfo recordInfo + +runCsv2Internal :: StateT Settings IO () +runCsv2Internal = do + recordSource <- getRecordSource + liftIO $ runResourceT $ + recordSource $= + CL.map (T.pack . show) =$= + encode utf8 $$ + sinkHandle stdout + +getRecordSource :: StateT Settings IO (Source (ResourceT IO) Record) +getRecordSource = do + settings <- get + let filename = settings ^. settingFilename + header = settings ^. settingHeader + csvSettings = settings ^. settingCSV + return $ sourceCsvRecords filename header csvSettings + +runCsv2Yxdb :: StateT Settings IO () +runCsv2Yxdb = do + recordInfo <- fromJust <$> getRecordInfo + recordSource <- getRecordSource + settings <- get + liftIO $ + withBinaryFile (settings ^. settingOutput) WriteMode $ \ h -> do + runResourceT $ + recordSource $$ + sinkRecords h recordInfo + +csv2yxdbMain :: IO () +csv2yxdbMain = do + settings <- getSettings + flip evalStateT settings $ + case () of + _ | settings ^. settingMetadata -> runMetadata + | settings ^. settingInternal -> runCsv2Internal + | otherwise -> runCsv2Yxdb diff --git a/src/Database/Alteryx/CLI/PrettyPrinters.hs b/src/Database/Alteryx/CLI/PrettyPrinters.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/CLI/PrettyPrinters.hs @@ -0,0 +1,32 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Database.Alteryx.CLI.PrettyPrinters + ( + printRecordInfo + ) where + +import Database.Alteryx.Types + +import Control.Lens +import Control.Newtype as NT +import Data.Monoid +import Data.Text as T +import Data.Text.IO +import Prelude hiding (putStrLn) + +printRecordInfo :: RecordInfo -> IO () +printRecordInfo recordInfo = + let printField field = + putStrLn $ ( + " " <> (field ^. fieldName) <> ": " + <> (T.pack $ show $ field ^. fieldType) + <> case field ^. fieldSize of + Just x -> " - Size: " <> (T.pack $ show x) + Nothing -> "" + <> case field ^. fieldScale of + Just x -> " - Scale: " <> (T.pack $ show x) + Nothing -> "" + :: Text ) + in do + putStrLn "RecordInfo:" + mapM_ printField $ NT.unpack recordInfo diff --git a/src/Database/Alteryx/CLI/Yxdb2Csv.hs b/src/Database/Alteryx/CLI/Yxdb2Csv.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/CLI/Yxdb2Csv.hs @@ -0,0 +1,173 @@ +{-# LANGUAGE TemplateHaskell,OverloadedStrings #-} + +module Database.Alteryx.CLI.Yxdb2Csv where + +import Database.Alteryx + +import Control.Applicative +import Control.Lens hiding (set, setting) +import Control.Monad +import Control.Monad.State +import Control.Monad.Trans.Resource +import qualified Control.Newtype as NT +import Data.Array.Unboxed as A +import qualified Data.ByteString as BS +import Data.Conduit +import Data.Conduit.Binary +import qualified Data.Conduit.Combinators as CC +import Data.Int +import Data.Monoid +import Data.Text as T hiding (concat, foldl) +import Data.Text.IO +import Data.Time.Clock +import Data.Time.Clock.POSIX +import Data.Time.Format +import Prelude hiding (putStrLn) +import System.Console.GetOpt +import System.Environment +import System.IO hiding (putStrLn) +import System.Locale + +data Settings = Settings { + _settingDecompress :: Bool, + _settingMetadata :: Bool, + _settingNumBlocks :: Maybe Int, + _settingNumRecords :: Maybe Int, + _settingVerbose :: Bool, + _settingFilename :: FilePath + } + +makeLenses ''Settings + +options :: [OptDescr (Settings -> Settings)] +options = + let set setting = \o -> (& setting .~ Just (read o)) + in [ + Option ['b'] ["num-blocks"] (ReqArg (set settingNumBlocks) "Number of blocks") "Only output the given number of blocks", + Option ['r'] ["num-records"] (ReqArg (set settingNumRecords) "Number of records") "Only output the given number of records, per block", + Option ['m'] ["dump-metadata"] (NoArg (& settingMetadata .~ True)) "Dump the file's metadata", + Option ['v'] ["verbose"] (NoArg (& settingVerbose .~ True)) "Print extra debugging information on stderr", + Option ['d'] ["decompress-blocks"] (NoArg (& settingDecompress .~ True)) "Debug: Decompress blocks, but don't try to interpret them." + ] + +defaultSettings :: Settings +defaultSettings = Settings { + _settingDecompress = False, + _settingMetadata = False, + _settingNumBlocks = Nothing, + _settingNumRecords = Nothing, + _settingVerbose = False, + _settingFilename = error "defaultSettings: Filename empty" + } + +parseOptions :: [String] -> IO ([Settings -> Settings]) +parseOptions args = + case getOpt Permute options args of + (opts, filename:[], []) -> return $ (\o -> o & settingFilename .~ filename):opts + (_, [], []) -> fail $ "Must provide a filename\n" ++ usageInfo header options + (_, _, errors) -> fail $ concat errors ++ usageInfo header options + where + header = "Usage: yxdb2csv [OPTIONS...] filename" + +processOptions :: [Settings -> Settings] -> Settings +processOptions = foldl (flip ($)) defaultSettings + +getSettings :: IO Settings +getSettings = do + argv <- getArgs + opts <- parseOptions argv + return $ processOptions opts + +printHeader :: YxdbMetadata -> StateT Settings IO () +printHeader metadata = do + settings <- get + let header = metadata ^. metadataHeader + liftIO $ do + putStrLn "Header:" + putStrLn $ (" Description: " <>) $ header ^. description + putStrLn $ (" FileId: " <>) $ T.pack $ show $ header ^. fileId + putStrLn $ (" CreationDate: " <>) $ T.pack $ show $ header ^. creationDate + putStrLn $ (" Flags1: " <>) $ T.pack $ show $ header ^. flags1 + putStrLn $ (" Flags2: " <>) $ T.pack $ show $ header ^. flags2 + putStrLn $ (" MetaInfoLength: " <>) $ T.pack $ show $ header ^. metaInfoLength + putStrLn $ (" Mystery: " <>) $ T.pack $ show $ header ^. mystery + putStrLn $ (" Spatial Index Position: " <>) $ T.pack $ show $ header ^. spatialIndexPos + putStrLn $ (" Block Index Position: " <>) $ T.pack $ show $ header ^. recordBlockIndexPos + putStrLn $ (" Number of Records: " <>) $ T.pack $ show $ header ^. numRecords + putStrLn $ (" Compression Version: " <>) $ T.pack $ show $ header ^. compressionVersion + when (settings ^. settingVerbose) $ + putStrLn $ (" Reserved Space: " <>) $ T.pack $ show $ header ^. reservedSpace + + +printBlocks :: YxdbMetadata -> StateT Settings IO () +printBlocks metadata = + let printBlock :: Int64 -> StateT Settings IO () + printBlock x = liftIO $ putStrLn $ T.pack $ show x + in do + liftIO $ putStrLn "Blocks:" + Prelude.mapM_ printBlock $ A.elems $ NT.unpack $ metadata ^. metadataBlockIndex + + + +runMetadata :: StateT Settings IO () +runMetadata = do + settings <- get + yxdbMetadata <- liftIO $ getMetadata $ settings ^. settingFilename + printHeader yxdbMetadata + liftIO $ printRecordInfo $ yxdbMetadata ^. metadataRecordInfo + when (settings ^. settingVerbose) $ + printBlocks yxdbMetadata + +getBlockLimiter :: (MonadThrow m) => StateT Settings IO (Conduit Block m Block) +getBlockLimiter = do + settings <- get + return $ case settings ^. settingNumBlocks of + Just n -> CC.take n + Nothing -> CC.map id + +getRecordLimiter :: (MonadThrow m) => StateT Settings IO (Conduit Record m Record) +getRecordLimiter = do + settings <- get + return $ case settings ^. settingNumRecords of + Just n -> CC.take n + Nothing -> CC.map id + +runDecompress :: StateT Settings IO () +runDecompress = do + settings <- get + let filename = settings ^. settingFilename + metadata <- liftIO $ getMetadata filename + let recordInfo = metadata ^. metadataRecordInfo + blockLimiter <- getBlockLimiter + runResourceT $ + sourceFileBlocks filename metadata $= + blockLimiter =$= + blocksToDecompressedBytes $$ + sinkHandle stdout + +runYxdb2Csv :: StateT Settings IO () +runYxdb2Csv = do + settings <- get + let filename = settings ^. settingFilename + metadata <- liftIO $ getMetadata filename + let recordInfo = metadata ^. metadataRecordInfo + blockLimiter <- getBlockLimiter + recordLimiter <- getRecordLimiter + + runResourceT $ + sourceFileBlocks filename metadata $= + blockLimiter =$= + blocksToRecords recordInfo =$= + recordLimiter =$= + record2csv recordInfo =$= + csv2bytes $$ + sinkHandle stdout + +yxdb2csvMain :: IO () +yxdb2csvMain = do + settings <- getSettings + flip evalStateT settings $ + case () of + _ | settings ^. settingMetadata -> runMetadata + | settings ^. settingDecompress -> runDecompress + | otherwise -> runYxdb2Csv diff --git a/src/Database/Alteryx/CSVConversion.hs b/src/Database/Alteryx/CSVConversion.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/CSVConversion.hs @@ -0,0 +1,269 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Database.Alteryx.CSVConversion + ( + alteryxCsvSettings, + csv2bytes, + csv2records, + parseCSVHeader, + record2csv, + sourceCsvRecords + ) where + +import Control.Applicative +import Control.Lens +import Control.Monad +import Control.Monad.Catch hiding (try) +import Control.Monad.Trans.Resource +import qualified Control.Newtype as NT +import Data.Attoparsec.Text as AT +import Data.ByteString as BS +import Data.ByteString.Char8 as BSC +import Data.Conduit +import Data.Conduit.Binary as CB +import Data.Conduit.Attoparsec as CP +import Data.Conduit.Combinators as CC +import Data.Conduit.List as CL hiding (isolate) +import Data.Conduit.Text as CT +import Data.Maybe +import Data.Monoid +import qualified Data.CSV.Conduit as CSVT +import qualified Data.CSV.Conduit.Parser.Text as CSVT +import qualified Data.Text as T +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.Builder as TB +import qualified Data.Text.Lazy.Builder.Int as TB +import qualified Data.Text.Lazy.Builder.RealFloat as TB + +import Database.Alteryx.Serialization() +import Database.Alteryx.Types + +-- | Our CSVs are pipe('|')-separated and do not do quoting. +alteryxCsvSettings :: CSVT.CSVSettings +alteryxCsvSettings = CSVT.defCSVSettings { CSVT.csvSep = '|', CSVT.csvQuoteChar = Nothing } + +-- | All CSV text should be UTF-8 encoded. +csv2bytes :: MonadThrow m => Conduit T.Text m BS.ByteString +csv2bytes = encode utf8 + +record2csv :: (MonadResource m) => RecordInfo -> Conduit Record m T.Text +record2csv recordInfo = + let record2csvWithoutHeader = do + mRecord <- await + case mRecord of + Just record -> do + let line = T.intercalate "|" $ + Prelude.map (TL.toStrict . TB.toLazyText . renderFieldValue) $ + NT.unpack record + yield $ line `mappend` "\n" + record2csvWithoutHeader + Nothing -> return () + in do + yield $ csvHeader recordInfo + record2csvWithoutHeader + +renderFieldValue :: Maybe FieldValue -> TB.Builder +renderFieldValue fieldValue = + -- TODO: Floating point values need to get their size information from the metadata + case fieldValue of + Just (FVFloat f) -> TB.formatRealFloat TB.Fixed (Just 4) f + Just (FVDouble f) -> TB.formatRealFloat TB.Fixed (Just 4) f + Just (FVByte x) -> TB.decimal x + Just (FVInt16 x) -> TB.decimal x + Just (FVInt32 x) -> TB.decimal x + Just (FVInt64 x) -> TB.decimal x + Just (FVString x) -> TB.fromText x + Just (FVWString x) -> TB.fromText x + Just (FVVString x) -> TB.fromText x + Just (FVVWString x) -> TB.fromText x + Nothing -> TB.fromText "" + _ -> error $ "renderFieldValue: Unlisted case: " ++ show fieldValue + +between :: Parser a -> Parser a -> Parser b -> Parser b +between left right middle = do + _ <- left + x <- middle + _ <- right + return x + +keyword :: T.Text -> Parser T.Text +keyword text = (try $ string text) + +parseFieldType :: Parser (Field -> Field) +parseFieldType = + let parseParens = between (char '(') (char ')') + parseOneArg = parseParens decimal + parseTwoArgs = parseParens $ do + arg1 <- decimal + _ <- char ',' + arg2 <- decimal + return (arg1, arg2) + parseSize fType = do + size <- fromInteger <$> parseOneArg + return $ \field -> field & fieldType .~ fType + & fieldSize .~ Just size + in choice [ + string "bool" *> return (& fieldType .~ FTBool), + string "int(8)" *> return (& fieldType .~ FTByte), + string "int(16)" *> return (& fieldType .~ FTInt16), + string "int(32)" *> return (& fieldType .~ FTInt32), + string "int(64)" *> return (& fieldType .~ FTInt64), + string "decimal" *> do + (size, scale) <- parseTwoArgs + return $ \field -> field & fieldType .~ FTFixedDecimal + & fieldSize .~ Just size + & fieldScale .~ Just scale, + string "float" *> return (& fieldType .~ FTFloat), + string "double" *> return (& fieldType .~ FTDouble), + string "string" *> parseSize FTString, + string "wstring" *> parseSize FTWString, + string "vstring" *> parseSize FTVString, + string "vwstring" *> parseSize FTVWString, + string "datetime" *> return (& fieldType .~ FTDateTime), + string "date" *> return (& fieldType .~ FTDate), + string "time" *> return (& fieldType .~ FTTime), + string "blob" *> parseSize FTBlob, + string "spatial" *> parseSize FTBlob + ] + "parseFieldType" + +identifier :: Parser T.Text +identifier = takeWhile1 (inClass "a-zA-Z0-9_") + +parseCSVHeaderField :: Parser Field +parseCSVHeaderField = + let defaultField = Field { + _fieldName = error "No name", + _fieldType = error "No type", + _fieldSize = Nothing, + _fieldScale = Nothing + } + in do + name <- identifier + char ':' + setType <- parseFieldType + return $ setType $ + defaultField & fieldName .~ name + +parseCSVHeader :: Parser RecordInfo +parseCSVHeader = (RecordInfo <$> (parseCSVHeaderField `sepBy1'` char '|' )) <* endOfInput + +parseCSVField :: Field -> Parser (Maybe FieldValue) +parseCSVField field = do + c <- peekChar + case c of + Nothing -> return Nothing + Just _ -> Just <$> case field ^. fieldType of + FTBool -> error "parseCSVField: Bool unimplemented" + FTByte -> FVByte <$> fromInteger <$> signed decimal + FTInt16 -> FVInt16 <$> fromInteger <$> signed decimal + FTInt32 -> FVInt32 <$> fromInteger <$> signed decimal + FTInt64 -> FVInt64 <$> fromInteger <$> signed decimal + FTFixedDecimal -> FVString <$> takeText -- TODO: Wrong! + FTFloat -> FVFloat <$> rational + FTDouble -> FVDouble <$> rational + FTString -> FVString <$> takeText + FTWString -> FVWString <$> takeText + FTVString -> FVVString <$> takeText + FTVWString -> FVVWString <$> takeText + FTDate -> FVString <$> takeText -- TODO: Wrong! + FTTime -> FVString <$> takeText -- TODO: Wrong! + FTDateTime -> FVString <$> takeText -- TODO: Wrong! + FTBlob -> error "parseCSVField: Blob unimplemented" + FTSpatialObject -> error "parseCSVField: Spatial Object unimplemented" + FTUnknown -> error "parseCSVField: Unknown unimplemented" + +csvHunks2records :: (MonadThrow m) => RecordInfo -> Conduit [T.Text] m Record +csvHunks2records recordInfo@(RecordInfo fields) = + let numFields = Prelude.length fields + in do + mRow <- await + case mRow of + Nothing -> return () + Just [] -> return () + Just columns -> do + let eFieldValues = + zipWithM (\field column -> parseOnly (parseCSVField field) column) + fields + columns + case eFieldValues of + Left e -> fail e + Right fieldValues -> do + yield $ Record fieldValues + csvHunks2records recordInfo + +csv2csvHunks :: (MonadThrow m) => CSVT.CSVSettings -> Conduit T.Text m [T.Text] +csv2csvHunks csvSettings = + CL.map (\x -> T.snoc x '\n') =$= + CP.conduitParser (CSVT.row csvSettings) =$= + CL.map snd =$= + CL.catMaybes + +csv2records :: (MonadThrow m) => CSVT.CSVSettings -> Conduit T.Text m Record +csv2records csvSettings = CT.lines =$= do + mHeader <- await + case mHeader of + Nothing -> return () + Just header -> do + let eRecordInfo = parseOnly parseCSVHeader header + case eRecordInfo of + Left e -> error e + Right recordInfo -> + csv2csvHunks csvSettings =$= + csvHunks2records recordInfo + + +prependHeader :: (MonadResource m) => T.Text -> Conduit T.Text m T.Text +prependHeader header = do + yield $ header <> "\n" + CL.map id + +csvHeaderField :: Field -> T.Text +csvHeaderField field = + let renderSizeScale name = name <> + "(" <> + (T.pack $ show (fromJust $ field ^. fieldSize)) <> + "," <> + (T.pack $ show (fromJust $ field ^. fieldScale)) <> + ")" + renderSize name = name <> + "(" <> + (T.pack $ show (fromJust $ field ^. fieldSize)) <> + ")" + typeIndicator = + case field ^. fieldType of + FTBool -> "bool" + FTByte -> "int(8)" + FTInt16 -> "int(16)" + FTInt32 -> "int(32)" + FTInt64 -> "int(64)" + FTFixedDecimal -> renderSizeScale "decimal" + FTFloat -> "float" + FTDouble -> "double" + FTString -> renderSize "string" + FTWString -> renderSize "wstring" + FTVString -> "vstring" + FTVWString -> "vwstring" + FTDateTime -> "datetime" + FTDate -> "date" + FTTime -> "time" + FTBlob -> "blob" + FTSpatialObject -> "spatial" + FTUnknown -> "unknown" + in field ^. fieldName <> ":" <> typeIndicator + + +-- | The appropriate CSV header that describes a record. Example: "month:date|market:int(16)|num_households:int(32)" +csvHeader :: RecordInfo -> T.Text +csvHeader (RecordInfo fields) = T.snoc (T.intercalate "|" $ Prelude.map csvHeaderField fields) '\n' + +-- | Stream the parsed records from a CSV file +sourceCsvRecords :: (MonadResource m) => FilePath -> Maybe T.Text -> CSVT.CSVSettings -> Source m Record +sourceCsvRecords filename header csvSettings = + let maybePrependHeader = case header of + Nothing -> CL.map id + Just x -> prependHeader x + in CB.sourceFile filename =$= + decode utf8 $= + maybePrependHeader =$= + csv2records csvSettings diff --git a/src/Database/Alteryx/Fields.hs b/src/Database/Alteryx/Fields.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/Fields.hs @@ -0,0 +1,215 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Database.Alteryx.Fields + ( + getValue, + getAllVariableData, + parseFieldType, + putValue, + renderFieldType + ) where + +import Control.Applicative +import Control.Lens +import Control.Monad +import Data.Bimap as Bimap (Bimap, fromList, lookup, lookupR) +import Data.Binary +import Data.Binary.C() +import Data.Binary.Get +import Data.Binary.Put +import Data.Bits +import Data.Decimal (Decimal) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Char8 as BSC +import qualified Data.ByteString.Lazy as BSL +import Data.Int +import Data.Text as T +import Data.Text.Encoding +import Data.Time +import Foreign.C.Types + +import Database.Alteryx.Types + +fieldTypeMap :: Bimap FieldType Text +fieldTypeMap = + Bimap.fromList + [ + (FTBool, "Bool"), + (FTByte, "Byte"), + (FTInt16, "Int16"), + (FTInt32, "Int32"), + (FTInt64, "Int64"), + (FTFixedDecimal, "FixedDecimal"), + (FTFloat, "Float"), + (FTDouble, "Double"), + (FTString, "String"), + (FTWString, "WString"), + (FTVString, "V_String"), + (FTVWString, "V_WString"), + (FTDate, "Date"), + (FTTime, "Time"), + (FTDateTime, "DateTime"), + (FTBlob, "Blob"), + (FTSpatialObject, "SpatialObj"), + (FTUnknown, "Unknown") + ] + +putValue :: Field -> Maybe FieldValue -> Put +putValue field value = + let putFixedString :: Maybe Int -> Int -> T.Text -> (T.Text -> BS.ByteString) -> Put + putFixedString size bytesPerCharacter text encoder = do + let stringBS = encoder text + let numPaddingBytes = case size of + Nothing -> error "putValue: No size given for string value" + Just x -> bytesPerCharacter * x - BS.length stringBS + putByteString stringBS + replicateM_ numPaddingBytes $ putWord8 0 + putWord8 0 + size = field ^. fieldSize + fType = field ^. fieldType + encodeLatin1 :: T.Text -> BS.ByteString + encodeLatin1 = BSC.pack . T.unpack + in do + case value of + Just (FVBool x) -> error "putBool unimplemented" + Just (FVByte x) -> do + putWord8 $ fromIntegral x + putWord8 0 + Just (FVInt16 x) -> do + putWord16le $ fromIntegral x + putWord8 0 + Just (FVInt32 x) -> do + putWord32le $ fromIntegral x + putWord8 0 + Just (FVInt64 x) -> do + putWord64le $ fromIntegral x + putWord8 0 + Just (FVFixedDecimal x) -> error "putFixedDecimal unimplemented" + Just (FVFloat x) -> do + let y = realToFrac x :: CFloat + put y + putWord8 0 + Just (FVDouble x) -> do + let y = realToFrac x :: CDouble + put y + putWord8 0 + Just (FVString x) | fType == FTDate -> putFixedString (Just 10) 1 x encodeUtf8 + Just (FVString x) | fType == FTTime -> putFixedString (Just 8) 1 x encodeUtf8 + Just (FVString x) | fType == FTDateTime -> putFixedString (Just 19) 1 x encodeUtf8 + Just (FVString x) -> putFixedString size 1 x encodeLatin1 + Just (FVWString x) -> putFixedString size 2 x encodeUtf16LE + Just (FVVString x) -> error "putVString unimplemented" + Just (FVVWString x) -> error "putVWString unimplemented" + Just (FVDate x) -> error "putDate unimplemented" + Just (FVTime x) -> error "putTime unimplemented" + Just (FVDateTime x) -> error "putDateTime unimplemented" + Just (FVBlob x) -> error "putBlob unimplemented" + Just (FVSpatialObject x) -> error "putSpatialObject unimplemented" + Just (FVUnknown) -> error "putUnknown unimplemented" + Nothing -> + case field ^. fieldType of + FTByte -> putWord8 0 >> putWord8 1 + FTInt16 -> putWord16le 0 >> putWord8 1 + FTInt32 -> putWord32le 0 >> putWord8 1 + FTInt64 -> putWord64le 0 >> putWord8 1 + FTFloat -> put (0 :: CFloat) >> putWord8 1 + FTDouble -> put (0 :: CDouble) >> putWord8 1 + x -> error $ "putValue unimplemented for null values of type " ++ show x + +-- | Retrieves the bytesting representing all variable data for the current record +getAllVariableData :: Get BS.ByteString +getAllVariableData = do + numBytes <- fromIntegral <$> getWord32le + getByteString numBytes + +-- | Retrieves the variable data portion for a single field +getVariableData :: Get (Maybe BS.ByteString) +getVariableData = do +-- numBytes <- fromIntegral <$> (`shiftR` 1) <$> getWord8 + numBytesSize <- lookAhead $ odd <$> getWord8 + numBytes <- (`shiftR` 1) <$> + if numBytesSize + then fromIntegral <$> getWord8 + else getWord32le + bs <- getByteString $ fromIntegral numBytes + return $ Just bs + +-- | When parsing a field that has variable data, looks ahead to grab this variable data. +linkedVariableData :: Get (Maybe BS.ByteString) +linkedVariableData = do + offsetToVarData <- getWord32le + let isUsingSmallStringOptimization = (offsetToVarData .&. 0x80000000) == 0 && + (offsetToVarData .&. 0x30000000) /= 0 + case offsetToVarData of + 0 -> return $ Just BS.empty + 1 -> return $ Nothing + _ | isUsingSmallStringOptimization -> do + let byte1 = fromIntegral $ (offsetToVarData .&. 0x000000FF) :: Word8 + let byte2 = fromIntegral $ (offsetToVarData .&. 0x0000FF00) `shiftR` 8 :: Word8 + let byte3 = fromIntegral $ (offsetToVarData .&. 0x00FF0000) `shiftR` 16 :: Word8 + return $ Just $ BS.pack [ byte1, byte2, byte3 ] + + _ -> lookAhead $ do + x <- getByteString $ fromIntegral $ offsetToVarData - 4 + bs <- getVariableData + return bs + + + +getValue :: Field -> Get (Maybe FieldValue) +getValue field = + let getFixedStringWithSize :: Maybe Int -> Int -> (BS.ByteString -> Text) -> Get (Maybe Text) + getFixedStringWithSize size charBytes decoder = + let mNumBytes = (charBytes*) <$> size + in case mNumBytes of + Just numBytes -> do + bs <- getByteString numBytes + isNull <- getWord8 + return $ if isNull > 0 + then Nothing + else Just $ T.takeWhile (/= '\0') $ decoder bs + Nothing -> error "getValue: String field had no size" + getFixedString :: Int -> (BS.ByteString -> Text) -> Get (Maybe Text) + getFixedString = getFixedStringWithSize $ field ^. fieldSize + + getVarString :: (BS.ByteString -> Text) -> Get (Maybe Text) + getVarString f = fmap f <$> linkedVariableData + + getWithNullByte :: Get a -> Get (Maybe a) + getWithNullByte getter = do + x <- getter + isNull <- getWord8 + return $ if isNull > 0 + then Nothing + else Just x + in case field ^. fieldType of + FTBool -> error "getBool unimplemented" + FTByte -> fmap (FVByte . fromIntegral) <$> getWithNullByte getWord8 + FTInt16 -> fmap (FVInt16 . fromIntegral) <$> getWithNullByte getWord16le + FTInt32 -> fmap (FVInt32 . fromIntegral) <$> getWithNullByte getWord32le + FTInt64 -> fmap (FVInt64 . fromIntegral) <$> getWithNullByte getWord64le + FTFixedDecimal -> fmap FVString <$> getFixedString 1 decodeLatin1 -- TODO: WRONG! + FTFloat -> fmap (FVFloat . realToFrac) <$> getWithNullByte (get :: Get CFloat) + FTDouble -> fmap (FVDouble . realToFrac) <$> getWithNullByte (get :: Get CDouble) + FTString -> fmap FVString <$> getFixedString 1 decodeLatin1 + FTWString -> fmap FVWString <$> getFixedString 2 decodeUtf16LE + FTVString -> fmap FVVString <$> getVarString decodeLatin1 + FTVWString -> fmap FVVWString <$> getVarString decodeUtf16LE + FTDate -> fmap FVString <$> getFixedStringWithSize (Just 10) 1 decodeLatin1 -- TODO: WRONG! + FTTime -> fmap FVString <$> getFixedStringWithSize (Just 8) 1 decodeLatin1 -- TODO: WRONG! + FTDateTime -> fmap FVString <$> getFixedStringWithSize (Just 19) 1 decodeLatin1 -- TODO: WRONG! + FTBlob -> error "getBlob unimplemented" + FTSpatialObject -> error "getSpatialObject unimplemented" + FTUnknown -> error "getUnknown unimplemented" + +parseFieldType :: Text -> FieldType +parseFieldType text = + case Bimap.lookupR text fieldTypeMap of + Nothing -> FTUnknown + Just x -> x + +renderFieldType :: FieldType -> Text +renderFieldType fieldType = + case Bimap.lookup fieldType fieldTypeMap of + Nothing -> error $ "No field type assigned to " ++ show fieldType + Just x -> x diff --git a/src/Database/Alteryx/Serialization.hs b/src/Database/Alteryx/Serialization.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/Serialization.hs @@ -0,0 +1,362 @@ +{-# LANGUAGE OverloadedStrings,MultiParamTypeClasses #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} + +module Database.Alteryx.Serialization + ( + dbFileId, + getRecord, + getValue, + putRecord, + putValue, + headerPageSize, + miniblockThreshold, + numMetadataBytesActual, + numMetadataBytesHeader, + numBlockBytesActual, + numBlockBytesHeader, + parseRecordsUntil, + recordsPerBlock, + startOfBlocksByteIndex + ) where + +import Database.Alteryx.Fields +import Database.Alteryx.Types + +import Codec.Compression.LZF.ByteString (decompressByteStringFixed, compressByteStringFixed) +import qualified Control.Newtype as NT +import Control.Applicative +import Control.Lens +import Control.Monad as M +import Control.Monad.Loops +import Data.Array.IArray (listArray, bounds, elems) +import Data.Binary +import Data.Binary.C () +import Data.Binary.Get +import Data.Binary.Put +import Data.Bits +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BSL +import Data.Conduit +import Data.Conduit.List (sourceList) +import Data.Conduit.Lazy (lazyConsume) +import qualified Data.Map as Map +import Data.Maybe (isJust, listToMaybe) +import Data.Text as T +import Data.Text.Encoding +import qualified Data.Text.Lazy as TL +import Data.Time.Clock.POSIX +import System.IO.Unsafe (unsafePerformIO) +import Text.XML hiding (renderText) +import Text.XML.Cursor as XMLC + ( + Cursor, + ($//), + attribute, + element, + fromDocument + ) +import Text.XML.Stream.Render (renderText) +import Text.XML.Unresolved (toEvents) + +-- | Number of records before each block is flushed and added to the block index +recordsPerBlock :: Int +recordsPerBlock = 0x10000 + +spatialIndexRecordBlockSize = 32 + +-- | Number of bytes taken by the fixed header +headerPageSize :: Int +headerPageSize = 512 + +-- | When writing miniblocks, how many bytes should each miniblock aim for? +miniblockThreshold :: Int +miniblockThreshold = 0x10000 + +-- | When decompressing miniblocks, how many bytes should be allocated for the output? +bufferSize :: Int +bufferSize = 0x40000 + +dbFileId :: DbType -> Word32 +dbFileId WrigleyDb = 0x00440205 +dbFileId WrigleyDb_NoSpatialIndex = 0x00440204 + +numBytes :: (Binary b, Num t) => b -> t +numBytes x = fromIntegral $ BSL.length $ runPut $ put x + +numMetadataBytesHeader :: Header -> Int +numMetadataBytesHeader header = fromIntegral $ 2 * (header ^. metaInfoLength) + +numMetadataBytesActual :: RecordInfo -> Int +numMetadataBytesActual recordInfo = numBytes recordInfo + +numBlockBytesHeader :: Header -> Int +numBlockBytesHeader header = + let start = headerPageSize + (numMetadataBytesHeader header) + end = (fromIntegral $ header ^. recordBlockIndexPos) + in end - start + +numBlockBytesActual :: Block -> Int +numBlockBytesActual block = numBytes block + +startOfBlocksByteIndex :: Header -> Int +startOfBlocksByteIndex header = + headerPageSize + (numMetadataBytesHeader header) + +parseRecordsUntil :: RecordInfo -> Get [Record] +parseRecordsUntil recordInfo = do + done <- isEmpty + if done + then return $ [] + else (:) <$> getRecord recordInfo <*> parseRecordsUntil recordInfo + + +-- | This binary instance is really slow because the YxdbFile type stores a list of records. Use the Conduit functions instead. +instance Binary YxdbFile where + put yxdbFile = do + put $ yxdbFile ^. yxdbFileHeader + put $ yxdbFile ^. yxdbFileMetadata + mapM_ (putRecord $ yxdbFile ^. yxdbFileMetadata) $ yxdbFile ^. yxdbFileRecords + put $ yxdbFile ^. yxdbFileBlockIndex + + get = do + fHeader <- label "Header" $ isolate (fromIntegral headerPageSize) get + fMetadata <- label "Metadata" $ isolate (numMetadataBytesHeader fHeader) $ get + + let numBlockBytes = numBlockBytesHeader $ fHeader + + fBlocks <- label ("Blocks of size " ++ show numBlockBytes) $ + isolate numBlockBytes get :: Get Block + fBlockIndex <- label "Block Index" get + let fRecords = runGet (label "Records" $ parseRecordsUntil fMetadata) $ NT.unpack fBlocks + + return $ YxdbFile { + _yxdbFileHeader = fHeader, + _yxdbFileMetadata = fMetadata, + _yxdbFileRecords = fRecords, + _yxdbFileBlockIndex = fBlockIndex + } + +documentToTextWithoutXMLHeader :: Document -> T.Text +documentToTextWithoutXMLHeader document = + let events = Prelude.tail $ toEvents $ toXMLDocument document + in T.concat $ + unsafePerformIO $ + lazyConsume $ + sourceList events $= + renderText def + +instance Binary RecordInfo where + put metadata = + let fieldMap :: Field -> Map.Map Name Text + fieldMap field = + let + requiredAttributes = + [ + ("name", field ^. fieldName), + ("type", renderFieldType $ field ^. fieldType) + ] + sizeAttributes = + case field ^. fieldSize of + Nothing -> [ ] + Just x -> [ ("size", T.pack $ show x) ] + scaleAttributes = + case field ^. fieldScale of + Nothing -> [ ] + Just x -> [ ("scale", T.pack $ show x) ] + in Map.fromList $ + Prelude.concat $ + [ requiredAttributes, sizeAttributes, scaleAttributes ] + transformField field = + NodeElement $ + Element "Field" (fieldMap field) [ ] + transformRecordInfo recordInfo = + NodeElement $ + Element "RecordInfo" Map.empty $ + Prelude.map transformField recordInfo + transformMetaInfo (RecordInfo recordInfo) = + Element "MetaInfo" Map.empty [ transformRecordInfo recordInfo] + transformToDocument node = Document (Prologue [] Nothing []) node [] + + renderMetaInfo metadata = + encodeUtf16LE $ + flip T.snoc '\0' $ + flip T.snoc '\n' $ + documentToTextWithoutXMLHeader $ + transformToDocument $ + transformMetaInfo metadata + in putByteString $ renderMetaInfo metadata + + get = do + bs <- BS.concat . BSL.toChunks <$> + getRemainingLazyByteString + when (BS.length bs < 4) $ fail $ "No trailing newline and null: " ++ show bs + let text = T.init $ T.init $ decodeUtf16LE bs + let document = parseText_ def $ TL.fromStrict text + let cursor = fromDocument document + let recordInfos = parseXmlRecordInfo cursor + case recordInfos of + [] -> fail "No RecordInfo entries found" + x:[] -> return x + xs -> fail "Too many RecordInfo entries found" + +parseXmlField :: Cursor -> [Field] +parseXmlField cursor = do + let fieldCursors = cursor $// XMLC.element "Field" + fieldCursor <- fieldCursors + + aName <- attribute "name" fieldCursor + aType <- attribute "type" fieldCursor + + let aDesc = listToMaybe $ attribute "description" fieldCursor + let aSize = listToMaybe $ attribute "size" fieldCursor + let aScale = listToMaybe $ attribute "scale" fieldCursor + + return $ Field { + _fieldName = aName, + _fieldType = parseFieldType aType, + _fieldSize = parseInt <$> aSize, + _fieldScale = parseInt <$> aScale + } + +parseXmlRecordInfo :: Cursor -> [RecordInfo] +parseXmlRecordInfo cursor = do + let recordInfoCursors = cursor $// XMLC.element "RecordInfo" + recordInfoCursor <- recordInfoCursors + let fields = parseXmlField recordInfoCursor + return $ RecordInfo fields + +parseInt :: Text -> Int +parseInt text = read $ T.unpack text :: Int + +-- | True if any fields have associated variable data in the variable data portion of the record. +hasVariableData :: RecordInfo -> Bool +hasVariableData (RecordInfo recordInfo) = + let fieldHasVariableData field = + case field ^. fieldType of + FTVString -> True + FTVWString -> True + FTBlob -> True + _ -> False + in Prelude.any fieldHasVariableData recordInfo + +-- | Writes a record using the provided metadata. +putRecord :: RecordInfo -> Record -> Put +putRecord recordInfo@(RecordInfo fields) (Record fieldValues) = do + zipWithM_ putValue fields fieldValues + when (hasVariableData recordInfo) $ do + error "putRecord: Variable data unimplemented" + +-- | Records consists of a fixed amount of data for each field, and also a possibly large amoutn of variable data at the end. +getRecord :: RecordInfo -> Get Record +getRecord recordInfo@(RecordInfo fields) = do + record <- Record <$> mapM getValue fields + when (hasVariableData recordInfo) $ do + _ <- getAllVariableData + return () + return record + +instance Binary BlockIndex where + get = do + arraySize <- label "Index Array Size" $ fromIntegral <$> getWord32le + let numBlockIndexBytes = arraySize * 8 + blocks <- label ("Reading block of size " ++ show arraySize) $ + isolate numBlockIndexBytes $ + replicateM arraySize (fromIntegral <$> getWord64le) + return $ BlockIndex $ listArray (0, arraySize-1) blocks + + put (BlockIndex blockIndex) = do + let (_, iMax) = bounds blockIndex + putWord32le $ fromIntegral $ iMax + 1 + mapM_ (putWord64le . fromIntegral) $ elems blockIndex + +instance Binary Block where + get = + let tryGetOne = do + done <- isEmpty + if done + then return Nothing + else Just <$> get :: Get (Maybe Miniblock) + in NT.pack <$> + BSL.fromChunks <$> + Prelude.map NT.unpack <$> + unfoldM tryGetOne + put (Block bs) = + case BSL.toChunks bs of + [] -> put $ Miniblock $ BS.empty + xs -> mapM_ (put . Miniblock) xs + +instance Binary Miniblock where + get = do + writtenSize <- label "Block size" getWord32le + let compressionBitIndex = 31 + let isCompressed = not $ testBit writtenSize compressionBitIndex + let size = fromIntegral $ clearBit writtenSize compressionBitIndex + + bs <- label ("Block of size " ++ show size) $ isolate size $ getByteString $ size + let chunk = if isCompressed + then case decompressByteStringFixed bufferSize bs of + Nothing -> fail "Unable to decompress. Increase buffer size?" + Just x -> return $ x + else return bs + Miniblock <$> chunk + put (Miniblock bs) = do + let compressionBitIndex = 31 + let compressedBlock = compressByteStringFixed ((BS.length bs)-1) bs + let blockToWrite = case compressedBlock of + Nothing -> bs + Just x -> x + let size = BS.length blockToWrite + let writtenSize = if isJust compressedBlock + then size + else setBit size compressionBitIndex + putWord32le $ fromIntegral writtenSize + putByteString blockToWrite + +instance Binary Header where + put header = do + let actualDescriptionBS = BS.take 64 $ encodeUtf8 $ header ^. description + let numPaddingBytes = fromIntegral $ 64 - BS.length actualDescriptionBS + let paddingDescriptionBS = BSL.toStrict $ BSL.take numPaddingBytes $ BSL.repeat 0 + + putByteString actualDescriptionBS + putByteString paddingDescriptionBS + putWord32le $ header ^. fileId + putWord32le $ truncate $ utcTimeToPOSIXSeconds $ header ^. creationDate + putWord32le $ header ^. flags1 + putWord32le $ header ^. flags2 + putWord32le $ header ^. metaInfoLength + putWord32le $ header ^. mystery + putWord64le $ header ^. spatialIndexPos + putWord64le $ header ^. recordBlockIndexPos + putWord64le $ header ^. numRecords + putWord32le $ header ^. compressionVersion + putByteString $ header ^. reservedSpace + + get = do + fDescription <- label "Description" $ decodeUtf8 <$> getByteString 64 + fFileId <- label "FileId" getWord32le + fCreationDate <- label "Creation Date" getWord32le + fFlags1 <- label "Flags 1" getWord32le + fFlags2 <- label "Flags 2" getWord32le + fMetaInfoLength <- label "Metadata Length" getWord32le + fMystery <- label "Mystery Field" getWord32le + fSpatialIndexPos <- label "Spatial Index" getWord64le + fRecordBlockIndexPos <- label "Record Block" getWord64le + fNumRecords <- label "Num Records" getWord64le + fCompressionVersion <- label "Compression Version" getWord32le + fReservedSpace <- label "Reserved Space" $ (BS.concat . BSL.toChunks <$> getRemainingLazyByteString) + + return $ Header { + _description = fDescription, + _fileId = fFileId, + _creationDate = posixSecondsToUTCTime $ fromIntegral fCreationDate, + _flags1 = fFlags1, + _flags2 = fFlags2, + _metaInfoLength = fMetaInfoLength, + _mystery = fMystery, + _spatialIndexPos = fSpatialIndexPos, + _recordBlockIndexPos = fRecordBlockIndexPos, + _numRecords = fNumRecords, + _compressionVersion = fCompressionVersion, + _reservedSpace = fReservedSpace + } diff --git a/src/Database/Alteryx/StreamingYxdb.hs b/src/Database/Alteryx/StreamingYxdb.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/StreamingYxdb.hs @@ -0,0 +1,208 @@ +{-# LANGUAGE OverloadedStrings,RankNTypes #-} + +module Database.Alteryx.StreamingYxdb + ( + blocksToDecompressedBytes, + blocksToRecords, + sinkRecords, + getMetadata, + recordsToBlocks, + sourceFileBlocks, + sourceFileRecords + )where + +import Conduit +import Control.Applicative +import Control.Lens hiding (from, to) +import Control.Monad as M +import Control.Monad.Primitive as M +import Control.Monad.Trans.Resource +import qualified Control.Monad.Trans.State.Lazy as State +import qualified Control.Newtype as NT +import Data.Array.Unboxed as A +import Data.Binary +import Data.Binary.Get +import Data.Binary.Put +import Data.ByteString as BS +import Data.ByteString.Builder as BSB +import Data.ByteString.Builder.Extra as BSB +import Data.ByteString.Lazy as BSL +import Data.Conduit +import Data.Conduit.Binary +import Data.Conduit.Combinators as CC +import Data.Conduit.Serialization.Binary +import Data.Monoid +import Data.Text as T +import Data.Time.Clock +import Data.Time.Clock.POSIX +import Data.Vector as V (toList) +import System.IO + +import Database.Alteryx.Serialization +import Database.Alteryx.Types + +readRange :: (MonadResource m) => FilePath -> Maybe Int -> Maybe Int -> m BS.ByteString +readRange filepath from to = sourceFileRange filepath (fromIntegral <$> from) (fromIntegral <$> to) $$ fold + +getMetadata :: FilePath -> IO YxdbMetadata +getMetadata filepath = runResourceT $ do + headerBS <- readRange filepath Nothing (Just headerPageSize) + let header = decode $ BSL.fromStrict headerBS :: Header + + recordInfoBS <- readRange filepath (Just headerPageSize) (Just $ numMetadataBytesHeader header) + let recordInfo = decode $ BSL.fromStrict recordInfoBS :: RecordInfo + + blockIndexBS <- readRange filepath (Just $ fromIntegral $ header ^. recordBlockIndexPos) Nothing + let blockIndex = decode $ BSL.fromStrict blockIndexBS :: BlockIndex + + return YxdbMetadata { + _metadataHeader = header, + _metadataRecordInfo = recordInfo, + _metadataBlockIndex = blockIndex + } + +type BlockRange = (Int, Int) +type BlockRanges = [BlockRange] + +sourceFileRecords :: (MonadResource m, MonadIO m) => FilePath -> Source m Record +sourceFileRecords filename = do + metadata <- liftIO $ getMetadata filename + let recordInfo = metadata ^. metadataRecordInfo + + sourceFileBlocks filename metadata $= blocksToRecords recordInfo + +blockRanges :: YxdbMetadata -> BlockRanges +blockRanges metadata = + let blockIndices = + Prelude.map fromIntegral $ + A.elems $ + NT.unpack $ + metadata ^. metadataBlockIndex + blockEnd = fromIntegral $ metadata ^. metadataHeader ^. recordBlockIndexPos + ranges = Prelude.zip blockIndices (Prelude.tail $ blockIndices ++ return blockEnd) + in ranges + +sourceBlock :: (MonadResource m) => FilePath -> BlockRange -> Source m Block +sourceBlock filepath (from, to) = do + let numBytes = fromIntegral $ to - from + rawBlock <- readRange filepath (Just from) (Just numBytes) + let block = runGet (label ("yieldBlock: " ++ show (from, numBytes)) get) $ + BSL.fromStrict rawBlock :: Block + yield block + +sourceBlocks :: (MonadResource m) => FilePath -> BlockRanges -> Source m Block +sourceBlocks filepath ranges = forM_ ranges $ sourceBlock filepath + +sourceFileBlocks :: (MonadResource m) => FilePath -> YxdbMetadata -> Source m Block +sourceFileBlocks filepath = sourceBlocks filepath . blockRanges + +blocksToRecords :: (MonadThrow m) => RecordInfo -> Conduit Block m Record +blocksToRecords recordInfo = + blocksToDecompressedBytes =$= + conduitGet (getRecord recordInfo) + +blocksToDecompressedBytes :: (MonadThrow m) => Conduit Block m BS.ByteString +blocksToDecompressedBytes = CC.concatMap (BSL.toChunks . NT.unpack) + +type StatefulConduit a m b = Conduit a (State.StateT StreamingCSVStatistics m) b + +recordsToBlocks :: (MonadThrow m) => RecordInfo -> StatefulConduit Record m Block +recordsToBlocks recordInfo = do + allRecords <- CC.sinkList + let records = Prelude.take recordsPerBlock allRecords + if Prelude.null records + then return () + else do + let numRecords = Prelude.length records + lift $ State.modify (& statisticsNumRecords %~ (+numRecords)) + let buildOneRecord :: Record -> BSB.Builder + buildOneRecord record = + let recordBSL = runPut $ putRecord recordInfo record + in lazyByteStringThreshold miniblockThreshold recordBSL + yield $ Block $ toLazyByteString $ mconcat $ Prelude.map buildOneRecord records + recordsToBlocks recordInfo + + +blocksToYxdbBytes :: (MonadThrow m) => RecordInfo -> StatefulConduit Block m BS.ByteString +blocksToYxdbBytes recordInfo = do + -- We fill the header with padding since we don't know enough to fill it in yet + let headerBS = BS.replicate headerPageSize 0 + yield headerBS + let metadataBS = BSL.toStrict $ runPut (put recordInfo) + lift $ State.modify (& statisticsMetadataLength .~ BS.length metadataBS) + yield metadataBS + let putBlockWithIndex :: (MonadThrow m) => StatefulConduit Block m BS.ByteString + putBlockWithIndex = do + mBlock <- await + case mBlock of + Nothing -> return () + Just block -> do + let bs = BSL.toStrict $ runPut $ put block + bsLen = BS.length bs + lift $ State.modify (& statisticsBlockLengths %~ (bsLen:)) + yield bs + putBlockWithIndex + putBlockWithIndex + +computeHeaderFromStatistics :: StreamingCSVStatistics -> IO Header +computeHeaderFromStatistics statistics = do + currentTime <- getCurrentTime + return $ Header { + _description = "Alteryx database file generated by Michael Burge's 'yxdb-utils'", + _fileId = dbFileId WrigleyDb, + _creationDate = currentTime, + _flags1 = 0, + _flags2 = 0, + _metaInfoLength = fromIntegral $ (statistics ^. statisticsMetadataLength) `div` 2, + _mystery = 0, + _spatialIndexPos = 0, + _recordBlockIndexPos = fromIntegral $ computeBlockIndexPositionFromStatistics statistics, + _numRecords = fromIntegral $ statistics ^. statisticsNumRecords, + _compressionVersion = 1, + _reservedSpace = BS.empty + } + +computeStartOfBlocksFromStatistics :: StreamingCSVStatistics -> Int +computeStartOfBlocksFromStatistics statistics = + headerPageSize + (statistics ^. statisticsMetadataLength) + +computeBlockIndexPositionFromStatistics :: StreamingCSVStatistics -> Integer +computeBlockIndexPositionFromStatistics statistics = + let totalBytes = Prelude.sum $ statistics ^. statisticsBlockLengths + startOfBlocks = computeStartOfBlocksFromStatistics statistics + in fromIntegral $ startOfBlocks + totalBytes + +computeBlockIndexFromStatistics :: StreamingCSVStatistics -> BlockIndex +computeBlockIndexFromStatistics statistics = + let startOfBlocks = computeStartOfBlocksFromStatistics statistics + orderedBlockLengths = Prelude.reverse $ statistics ^. statisticsBlockLengths + numBlocks = Prelude.length orderedBlockLengths + in BlockIndex $ + listArray (0, numBlocks-1) $ + Prelude.map (fromIntegral . (startOfBlocks+)) $ + Prelude.init $ + Prelude.scanl (+) 0 orderedBlockLengths + +toBS :: Binary a => a -> BS.ByteString +toBS = BSL.toStrict . runPut . put + +sinkYxdbBytes :: (MonadThrow m, MonadIO m) => Handle -> Sink BS.ByteString (State.StateT StreamingCSVStatistics m) () +sinkYxdbBytes handle = do + CC.sinkHandle handle + statistics <- lift State.get + header <- liftIO $ computeHeaderFromStatistics statistics + let blockIndex = computeBlockIndexFromStatistics statistics + headerBS = toBS header + blockIndexBS = toBS blockIndex + liftIO $ do + hSeek handle AbsoluteSeek 0 + BS.hPut handle headerBS + hSeek handle SeekFromEnd 0 + BS.hPut handle blockIndexBS + +sinkRecords :: (MonadThrow m, MonadIO m) => Handle -> RecordInfo -> Sink Record m () +sinkRecords handle recordInfo = + evalStateLC defaultStatistics $ + recordsToBlocks recordInfo =$= + blocksToYxdbBytes recordInfo =$ + sinkYxdbBytes handle diff --git a/src/Database/Alteryx/Types.hs b/src/Database/Alteryx/Types.hs new file mode 100644 --- /dev/null +++ b/src/Database/Alteryx/Types.hs @@ -0,0 +1,136 @@ +{-# LANGUAGE TemplateHaskell,MultiParamTypeClasses,FlexibleInstances #-} + +module Database.Alteryx.Types where + +import Control.Lens +import qualified Control.Newtype as NT +import Data.Array.Unboxed +import Data.ByteString as BS +import Data.ByteString.Lazy as BSL +import Data.Decimal +import Data.Int +import Data.Text as T +import Data.Time +import Data.Word + +data DbType = WrigleyDb | WrigleyDb_NoSpatialIndex deriving (Eq, Show) + +data YxdbMetadata = YxdbMetadata { + _metadataHeader :: Header, + _metadataRecordInfo :: RecordInfo, + _metadataBlockIndex :: BlockIndex + } deriving (Eq, Show) + +data YxdbFile = YxdbFile { + _yxdbFileHeader :: Header, + _yxdbFileMetadata :: RecordInfo, + _yxdbFileRecords :: [Record], + _yxdbFileBlockIndex :: BlockIndex +} deriving (Eq, Show) + +data Header = Header { + _description :: Text, + _fileId :: Word32, + _creationDate :: UTCTime, + _flags1 :: Word32, + _flags2 :: Word32, + _metaInfoLength :: Word32, + _mystery :: Word32, + _spatialIndexPos :: Word64, + _recordBlockIndexPos :: Word64, + _numRecords :: Word64, + _compressionVersion :: Word32, + _reservedSpace :: BS.ByteString +} deriving (Eq, Show) + +newtype Record = Record [ Maybe FieldValue ] deriving (Eq, Show) +newtype RecordInfo = RecordInfo [ Field ] deriving (Eq, Show) +newtype Miniblock = Miniblock BS.ByteString deriving (Eq, Show) +newtype Block = Block BSL.ByteString deriving (Eq, Show) +newtype BlockIndex = BlockIndex (UArray Int Int64) deriving (Eq, Show) + +data FieldValue = FVBool Bool + | FVByte Int8 + | FVInt16 Int16 + | FVInt32 Int32 + | FVInt64 Int64 + | FVFixedDecimal Decimal + | FVFloat Float + | FVDouble Double + | FVString Text + | FVWString Text + | FVVString Text + | FVVWString Text + | FVDate Day + | FVTime DiffTime + | FVDateTime UTCTime + | FVBlob BSL.ByteString + | FVSpatialObject BSL.ByteString + | FVUnknown + deriving (Eq, Show) + +data FieldType = FTBool + | FTByte + | FTInt16 + | FTInt32 + | FTInt64 + | FTFixedDecimal + | FTFloat + | FTDouble + | FTString + | FTWString + | FTVString + | FTVWString + | FTDate -- yyyy-mm-dd + | FTTime -- hh:mm:ss + | FTDateTime -- yyyy-mm-dd hh:mm:ss + | FTBlob + | FTSpatialObject + | FTUnknown + deriving (Eq, Ord, Show) + +data Field = Field { + _fieldName :: Text, + _fieldType :: FieldType, + _fieldSize :: Maybe Int, + _fieldScale :: Maybe Int +} deriving (Eq, Show) + +data StreamingCSVStatistics = StreamingCSVStatistics { + _statisticsMetadataLength :: Int, + _statisticsNumRecords :: Int, + _statisticsBlockLengths :: [Int] + } deriving (Eq, Show) + +defaultStatistics :: StreamingCSVStatistics +defaultStatistics = StreamingCSVStatistics { + _statisticsMetadataLength = error "No metadata length", + _statisticsNumRecords = 0, + _statisticsBlockLengths = [] + } + +instance NT.Newtype Record [Maybe FieldValue] where + pack = Record + unpack (Record xs) = xs + +instance NT.Newtype Block BSL.ByteString where + pack = Block + unpack (Block x) = x + +instance NT.Newtype Miniblock BS.ByteString where + pack = Miniblock + unpack (Miniblock x) = x + +instance NT.Newtype RecordInfo [Field] where + pack = RecordInfo + unpack (RecordInfo x) = x + +instance NT.Newtype BlockIndex (UArray Int Int64) where + pack = BlockIndex + unpack (BlockIndex x) = x + +makeLenses ''Field +makeLenses ''YxdbFile +makeLenses ''Header +makeLenses ''YxdbMetadata +makeLenses ''StreamingCSVStatistics diff --git a/yxdb-utils.cabal b/yxdb-utils.cabal new file mode 100644 --- /dev/null +++ b/yxdb-utils.cabal @@ -0,0 +1,158 @@ +-- Initial yxdb-utils.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +-- The name of the package. +name: yxdb-utils + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.1.0.0 + +-- A short (one-line) description of the package. +synopsis: Utilities for reading and writing Alteryx .yxdb files + +-- A longer description of the package. +description: Two command-line utilities (csv2yxdb and yxdb2csv) that are used to convert csv files with a specific header line into Alteryx .yxdb files. + +-- The license under which the package is released. +license: GPL-3 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: Michael Burge + +-- An email address to which users can send suggestions, bug reports, and +-- patches. +maintainer: michael.burge@rentrakmail.com + +-- A copyright notice. +-- copyright: + +category: Database + +build-type: Simple + +-- Constraint on the version of Cabal needed to build this package. +cabal-version: >=1.8 + +executable csv2yxdb + hs-source-dirs: bin-src + main-is: Csv2Yxdb.hs + build-depends: + base == 4.*, + yxdb-utils + +executable yxdb2csv + hs-source-dirs: bin-src + main-is: Yxdb2Csv.hs + build-depends: + base == 4.*, + yxdb-utils + +library + hs-source-dirs: src + exposed-modules: + Codec.Compression.LZF.ByteString, + Database.Alteryx.CLI.Csv2Yxdb + Database.Alteryx.CLI.Yxdb2Csv + Data.Binary.C, + Database.Alteryx + other-modules: + Database.Alteryx.CLI.PrettyPrinters + Database.Alteryx.CSVConversion + Database.Alteryx.Fields + Database.Alteryx.Serialization + Database.Alteryx.StreamingYxdb + Database.Alteryx.Types + build-depends: + array, + attoparsec, + Codec-Compression-LZF, + array, + base ==4.*, + bimap, + binary >0.7.2, + binary-conduit, + bytestring, + conduit, + conduit-combinators, + conduit-extra, + containers, + csv-conduit, + Decimal, + directory, + exceptions, + ghc-prim, + lens, + monad-loops, + mtl, + newtype, + old-locale, + parsec, + primitive, + reinterpret-cast, + resourcet, + text, + text-binary, + time, + transformers, + xml-conduit, + vector + +test-suite yxdb-tests + ghc-options: -O2 -fprof-auto + hs-source-dirs: src, . + type: exitcode-stdio-1.0 + build-depends: + Codec-Compression-LZF, + Decimal, + HUnit, + QuickCheck, + array, + attoparsec, + base -any, + bimap, + binary, + binary-conduit, + bytestring, + conduit, + conduit-combinators, + conduit-extra, + containers, + csv-conduit, + directory, + exceptions, + ghc-prim, + lens, + monad-loops, + mtl, + newtype, + old-locale, + parsec, + primitive, + quickcheck-instances, + reinterpret-cast, + resourcet, + test-framework, + test-framework-hunit, + test-framework-quickcheck2, + text, + text-binary, + time, + transformers, + vector, + xml-conduit + main-is: Tests/Main.hs + buildable: True + hs-source-dirs: src + ghc-options: -rtsopts -with-rtsopts=-M512m + +source-repository head + type: git + location: https://github.com/MichaelBurge/yxdb-utils