diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1e8977c --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +docs +lib +pkg \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.markdown b/README.markdown deleted file mode 100644 index e69de29..0000000 diff --git a/README.rdoc b/README.rdoc new file mode 100644 index 0000000..eac0430 --- /dev/null +++ b/README.rdoc @@ -0,0 +1,73 @@ += ganapati -- Hadoop HDFS Thrift interface for Ruby + +A Ruby thrift lib for interfacing with Hadoop's distributed file system, HDFS. + +To install: + gem install ganapati + +== Starting thrift server +Documentation in Hadoop for the thrift interface to HDFS is crap. It can be found here[http://wiki.apache.org/hadoop/HDFS-APIs]. + +As a much simpler and safer way of auto compiling and then starting the thrift interface, use the provided script: + bin/hdfs_thrift_server + +This will start a thrift server on the given port (after compiling the server code provided in the Hadoop distribution). + +== Basic Usage + require 'rubygems' + require 'ganapati' + + # args are host, port, and optional timeout + client = Ganapati::Client.new 'localhost', 1234 + + # copy a file to hdfs + client.put("/some/file", "/some/hadoop/path") + + # get a file from hadoop + client.get("/some/hadoop/path", "/local/path") + + # Create a file + f = client.create("/home/someuser/afile.txt") + f.write("this is some text") + # Always, always close the file + f.close + + # Create a file with code block + client.create("/home/someuser/afile.txt") { |f| + f.write("this is some text") + } + + # Open a file for reading and read it + c.open('/home/someuser/afile.txt') { |f| + puts f.read + # or read for specific length from start + puts f.read(0, 4) + } + + # Open a file for appending and append to it + c.append('/home/someuser/afile.txt') { |f| + f.write "new data" + } + + ## Common file methods are available (chown, chmod, mkdir, stat, etc). Examples: + # move a file + client.mv "/home/someuser/afile.txt", "/home/someuser/test.txt" + + # remove a file + client.rm "/home/someuser/test.txt" + + # test for file existance + client.exists? "/home/someuser/test.txt" + + # get a list of all files + client.ls "/home" + + client.close + + # Quick and dirty way to print remote file. The run class method takes care of closing the client. + puts Ganapati::Client.run('localhost', 1234) { |c| c.open('/home/someuser/afile.txt') { |f| f.read } } + + + + + diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..f094cce --- /dev/null +++ b/Rakefile @@ -0,0 +1,48 @@ +require 'rubygems' +require 'rake' +require 'rake/testtask' +require 'rake/rdoctask' +require 'rake/gempackagetask' + +desc "Create documentation" +Rake::RDocTask.new("doc") { |rdoc| + rdoc.title = "Ganapati - Hadoop HDFS thrift interface for Ruby" + rdoc.rdoc_dir = 'docs' + rdoc.rdoc_files.include('README.rdoc') + rdoc.rdoc_files.include('lib/**/*.rb') +} + +desc "Re-generate thrift files" +task "regen_thrift" do + if ENV['HADOOP_HOME'].nil? + puts "You must set your HADOOP_HOME variable before calling this task." + return + end + system "thrift --gen rb -o /tmp #{ENV['HADOOP_HOME']}src/contrib/thriftfs/if/hadoopfs.thrift" + system "mv /tmp/gen-rb/* lib/thrift" +end + +spec = Gem::Specification.new do |s| + s.name = "ganapati" + s.version = "0.0.1" + s.authors = ["Brian Muller"] + s.date = %q{2011-01-19} + s.description = "Hadoop HDFS Thrift interface for Ruby" + s.summary = "Simple lib for interfaceing with Hadoop's distributed file system HDFS." + s.email = "brian.muller@livingsocial.com" + s.files = FileList["lib/**/*"] + s.homepage = "https://github.com/livingsocial/ganapati" + s.require_paths = ["lib"] + s.bindir = "bin" + s.executables << 'hdfs_thrift_server' + s.rubygems_version = "1.3.5" + s.add_dependency('thrift', '>= 0.5.0') +end + +Rake::GemPackageTask.new(spec) do |pkg| + pkg.need_zip = true + pkg.need_tar = true +end + +desc "Default task: builds gem" +task :default => [ :gem, :doc ] diff --git a/bin/hdfs_thrift_server b/bin/hdfs_thrift_server new file mode 100755 index 0000000..9e211ca --- /dev/null +++ b/bin/hdfs_thrift_server @@ -0,0 +1,20 @@ +#!/bin/bash +JARFILE=$HADOOP_HOME/lib/HadoopThriftServer.jar +CONTRIBLIB=$HADOOP_HOME/src/contrib/thriftfs/lib +CLASSPATH=$(ls $HADOOP_HOME/hadoop-core-*.jar):$(ls $HADOOP_HOME/lib/commons-logging-api-*.jar):$CONTRIBLIB/hadoopthriftapi.jar:$CONTRIBLIB/libthrift.jar:$HADOOP_HOME/conf + +if [ "$1" == "" ]; then + echo "Usage: $0 " + exit 1 +fi + +if [ ! -e "$JARFILE" ]; then + echo "Creating thrift server jar file at $JARFILE" + mkdir -p /tmp/HadoopThriftServer + javac -classpath $CLASSPATH -d /tmp/HadoopThriftServer/ $CONTRIBLIB/../src/java/org/apache/hadoop/thriftfs/HadoopThriftServer.java + jar -cf $JARFILE -C /tmp/HadoopThriftServer/ . +else + echo "Found jar file at $JARFILE" +fi + +java -Dcom.sun.management.jmxremote -cp $JARFILE:$CLASSPATH org.apache.hadoop.thriftfs.HadoopThriftServer $1 diff --git a/lib/ganapati.rb b/lib/ganapati.rb new file mode 100644 index 0000000..8d6a7e8 --- /dev/null +++ b/lib/ganapati.rb @@ -0,0 +1,7 @@ +require 'ganapati/client' +require 'ganapati/hfile' + +$:.unshift File.join(File.dirname(__FILE__), 'thrift') +require 'thrift_hadoop_file_system' +require 'hadoopfs_constants' + diff --git a/lib/ganapati/client.rb b/lib/ganapati/client.rb new file mode 100644 index 0000000..752fb7e --- /dev/null +++ b/lib/ganapati/client.rb @@ -0,0 +1,124 @@ +module Ganapati + + class Client + def initialize(server, port, timeout=60) + socket = Thrift::Socket.new(server, port) + @transport = Thrift::BufferedTransport.new(socket) + @transport.open + protocol = Thrift::BinaryProtocol.new(@transport) + @client = ThriftHadoopFileSystem::Client.new(protocol) + @client.setInactivityTimeoutPeriod(timeout) + end + + def close + @transport.close + end + + # shutdown the thrift server + def shutdown(status=0) + @client.shutdown status + end + + # copy local file to remote + def put(localpath, destpath) + create(destpath) { |dest| + Kernel.open(localpath) { |source| + # read 1 MB at a time + while record = source.read(1048576) + dest.write(record) + end + } + } + end + + # copy remote file to local + def get(remotepath, destpath) + Kernel.open(destpath, 'w') { |dest| + open(remotepath) { |source| + size = source.length + index = 0 + while index < size + dest.write(source.read(index, 1048576)) + index += 1048576 + end + } + } + end + + # for writing to a new file + def create(path, &block) + file_handle :create, path, &block + end + + # for reading + def open(path, &block) + file_handle :open, path, &block + end + + # for appending + def append(path, &block) + file_handle :append, path, &block + end + + def rm(path, recursive=false) + @client.rm pname(path), recursive + end + + def mv(source, dest) + @client.rename pname(source), pname(dest) + end + + def mkdir(path) + @client.mkdirs pname(path) + end + + def exists?(path) + @client.exists pname(path) + end + + def stat(path) + @client.stat pname(path) + end + + def ls(path, details=false) + statuses = @client.listStatus pname(path) + (details) ? statuses : statuses.map { |s| s.path } + end + + def chmod(path, mode) + @client.chmod pname(path), mode + end + + def chown(path, owner, group) + @client.chown pname(path), owner, group + end + + def set_replication(path, level) + @client.setReplication pname(path), level + end + + def self.run(server, port) + c = Client.new(server, port) + result = yield c + c.close + result + end + + private + def file_handle(action, path) + pathname = pname(path) + fh = @client.send action, pathname + result = f = HFile.new(@client, fh, pathname) + if block_given? + result = yield f + f.close + end + result + end + + def pname(path) + Pathname.new(:pathname => path.to_s) + end + end + +end diff --git a/lib/ganapati/hfile.rb b/lib/ganapati/hfile.rb new file mode 100644 index 0000000..b16486b --- /dev/null +++ b/lib/ganapati/hfile.rb @@ -0,0 +1,37 @@ +module Ganapati + + class HFile + def initialize(client, handle, pathname) + @client = client + @handle = handle + @pathname = pathname + end + + def write(data) + call :write, data + end + + def read(offset=0, size=nil) + size ||= stat.length + call :read, offset, size + end + + def close + call :close + end + + def stat + @client.stat(@pathname) + end + + def length + stat.length + end + + private + def call(method, *args) + @client.send method, @handle, *args + end + end + +end diff --git a/lib/thrift/hadoopfs_constants.rb b/lib/thrift/hadoopfs_constants.rb new file mode 100644 index 0000000..cc2d423 --- /dev/null +++ b/lib/thrift/hadoopfs_constants.rb @@ -0,0 +1,8 @@ +# +# Autogenerated by Thrift +# +# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING +# + +require 'hadoopfs_types' + diff --git a/lib/thrift/hadoopfs_types.rb b/lib/thrift/hadoopfs_types.rb new file mode 100644 index 0000000..cd6c49c --- /dev/null +++ b/lib/thrift/hadoopfs_types.rb @@ -0,0 +1,135 @@ +# +# Autogenerated by Thrift +# +# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING +# + + +class ThriftHandle + include ::Thrift::Struct, ::Thrift::Struct_Union + ID = -1 + + FIELDS = { + ID => {:type => ::Thrift::Types::I64, :name => 'id'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self +end + +class Pathname + include ::Thrift::Struct, ::Thrift::Struct_Union + PATHNAME = -1 + + FIELDS = { + PATHNAME => {:type => ::Thrift::Types::STRING, :name => 'pathname'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self +end + +class FileStatus + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + LENGTH = 2 + ISDIR = 3 + BLOCK_REPLICATION = 4 + BLOCKSIZE = 5 + MODIFICATION_TIME = 6 + PERMISSION = 7 + OWNER = 8 + GROUP = 9 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRING, :name => 'path'}, + LENGTH => {:type => ::Thrift::Types::I64, :name => 'length'}, + ISDIR => {:type => ::Thrift::Types::BOOL, :name => 'isdir'}, + BLOCK_REPLICATION => {:type => ::Thrift::Types::I16, :name => 'block_replication'}, + BLOCKSIZE => {:type => ::Thrift::Types::I64, :name => 'blocksize'}, + MODIFICATION_TIME => {:type => ::Thrift::Types::I64, :name => 'modification_time'}, + PERMISSION => {:type => ::Thrift::Types::STRING, :name => 'permission'}, + OWNER => {:type => ::Thrift::Types::STRING, :name => 'owner'}, + GROUP => {:type => ::Thrift::Types::STRING, :name => 'group'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self +end + +class BlockLocation + include ::Thrift::Struct, ::Thrift::Struct_Union + HOSTS = 1 + NAMES = 2 + OFFSET = 3 + LENGTH = 4 + + FIELDS = { + HOSTS => {:type => ::Thrift::Types::LIST, :name => 'hosts', :element => {:type => ::Thrift::Types::STRING}}, + NAMES => {:type => ::Thrift::Types::LIST, :name => 'names', :element => {:type => ::Thrift::Types::STRING}}, + OFFSET => {:type => ::Thrift::Types::I64, :name => 'offset'}, + LENGTH => {:type => ::Thrift::Types::I64, :name => 'length'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self +end + +class MalformedInputException < ::Thrift::Exception + include ::Thrift::Struct, ::Thrift::Struct_Union + def initialize(message=nil) + super() + self.message = message + end + + MESSAGE = -1 + + FIELDS = { + MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self +end + +class ThriftIOException < ::Thrift::Exception + include ::Thrift::Struct, ::Thrift::Struct_Union + def initialize(message=nil) + super() + self.message = message + end + + MESSAGE = -1 + + FIELDS = { + MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self +end + diff --git a/lib/thrift/thrift_hadoop_file_system.rb b/lib/thrift/thrift_hadoop_file_system.rb new file mode 100644 index 0000000..75175a6 --- /dev/null +++ b/lib/thrift/thrift_hadoop_file_system.rb @@ -0,0 +1,1188 @@ +# +# Autogenerated by Thrift +# +# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING +# + +require 'thrift' +require 'hadoopfs_types' + +module ThriftHadoopFileSystem + class Client + include ::Thrift::Client + + def setInactivityTimeoutPeriod(periodInSeconds) + send_setInactivityTimeoutPeriod(periodInSeconds) + recv_setInactivityTimeoutPeriod() + end + + def send_setInactivityTimeoutPeriod(periodInSeconds) + send_message('setInactivityTimeoutPeriod', SetInactivityTimeoutPeriod_args, :periodInSeconds => periodInSeconds) + end + + def recv_setInactivityTimeoutPeriod() + result = receive_message(SetInactivityTimeoutPeriod_result) + return + end + + def shutdown(status) + send_shutdown(status) + recv_shutdown() + end + + def send_shutdown(status) + send_message('shutdown', Shutdown_args, :status => status) + end + + def recv_shutdown() + result = receive_message(Shutdown_result) + return + end + + def create(path) + send_create(path) + return recv_create() + end + + def send_create(path) + send_message('create', Create_args, :path => path) + end + + def recv_create() + result = receive_message(Create_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'create failed: unknown result') + end + + def createFile(path, mode, overwrite, bufferSize, block_replication, blocksize) + send_createFile(path, mode, overwrite, bufferSize, block_replication, blocksize) + return recv_createFile() + end + + def send_createFile(path, mode, overwrite, bufferSize, block_replication, blocksize) + send_message('createFile', CreateFile_args, :path => path, :mode => mode, :overwrite => overwrite, :bufferSize => bufferSize, :block_replication => block_replication, :blocksize => blocksize) + end + + def recv_createFile() + result = receive_message(CreateFile_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'createFile failed: unknown result') + end + + def open(path) + send_open(path) + return recv_open() + end + + def send_open(path) + send_message('open', Open_args, :path => path) + end + + def recv_open() + result = receive_message(Open_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'open failed: unknown result') + end + + def append(path) + send_append(path) + return recv_append() + end + + def send_append(path) + send_message('append', Append_args, :path => path) + end + + def recv_append() + result = receive_message(Append_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'append failed: unknown result') + end + + def write(handle, data) + send_write(handle, data) + return recv_write() + end + + def send_write(handle, data) + send_message('write', Write_args, :handle => handle, :data => data) + end + + def recv_write() + result = receive_message(Write_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'write failed: unknown result') + end + + def read(handle, offset, size) + send_read(handle, offset, size) + return recv_read() + end + + def send_read(handle, offset, size) + send_message('read', Read_args, :handle => handle, :offset => offset, :size => size) + end + + def recv_read() + result = receive_message(Read_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'read failed: unknown result') + end + + def close(out) + send_close(out) + return recv_close() + end + + def send_close(out) + send_message('close', Close_args, :out => out) + end + + def recv_close() + result = receive_message(Close_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'close failed: unknown result') + end + + def rm(path, recursive) + send_rm(path, recursive) + return recv_rm() + end + + def send_rm(path, recursive) + send_message('rm', Rm_args, :path => path, :recursive => recursive) + end + + def recv_rm() + result = receive_message(Rm_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'rm failed: unknown result') + end + + def rename(path, dest) + send_rename(path, dest) + return recv_rename() + end + + def send_rename(path, dest) + send_message('rename', Rename_args, :path => path, :dest => dest) + end + + def recv_rename() + result = receive_message(Rename_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'rename failed: unknown result') + end + + def mkdirs(path) + send_mkdirs(path) + return recv_mkdirs() + end + + def send_mkdirs(path) + send_message('mkdirs', Mkdirs_args, :path => path) + end + + def recv_mkdirs() + result = receive_message(Mkdirs_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'mkdirs failed: unknown result') + end + + def exists(path) + send_exists(path) + return recv_exists() + end + + def send_exists(path) + send_message('exists', Exists_args, :path => path) + end + + def recv_exists() + result = receive_message(Exists_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'exists failed: unknown result') + end + + def stat(path) + send_stat(path) + return recv_stat() + end + + def send_stat(path) + send_message('stat', Stat_args, :path => path) + end + + def recv_stat() + result = receive_message(Stat_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'stat failed: unknown result') + end + + def listStatus(path) + send_listStatus(path) + return recv_listStatus() + end + + def send_listStatus(path) + send_message('listStatus', ListStatus_args, :path => path) + end + + def recv_listStatus() + result = receive_message(ListStatus_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'listStatus failed: unknown result') + end + + def chmod(path, mode) + send_chmod(path, mode) + recv_chmod() + end + + def send_chmod(path, mode) + send_message('chmod', Chmod_args, :path => path, :mode => mode) + end + + def recv_chmod() + result = receive_message(Chmod_result) + raise result.ouch unless result.ouch.nil? + return + end + + def chown(path, owner, group) + send_chown(path, owner, group) + recv_chown() + end + + def send_chown(path, owner, group) + send_message('chown', Chown_args, :path => path, :owner => owner, :group => group) + end + + def recv_chown() + result = receive_message(Chown_result) + raise result.ouch unless result.ouch.nil? + return + end + + def setReplication(path, replication) + send_setReplication(path, replication) + recv_setReplication() + end + + def send_setReplication(path, replication) + send_message('setReplication', SetReplication_args, :path => path, :replication => replication) + end + + def recv_setReplication() + result = receive_message(SetReplication_result) + raise result.ouch unless result.ouch.nil? + return + end + + def getFileBlockLocations(path, start, length) + send_getFileBlockLocations(path, start, length) + return recv_getFileBlockLocations() + end + + def send_getFileBlockLocations(path, start, length) + send_message('getFileBlockLocations', GetFileBlockLocations_args, :path => path, :start => start, :length => length) + end + + def recv_getFileBlockLocations() + result = receive_message(GetFileBlockLocations_result) + return result.success unless result.success.nil? + raise result.ouch unless result.ouch.nil? + raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'getFileBlockLocations failed: unknown result') + end + + end + + class Processor + include ::Thrift::Processor + + def process_setInactivityTimeoutPeriod(seqid, iprot, oprot) + args = read_args(iprot, SetInactivityTimeoutPeriod_args) + result = SetInactivityTimeoutPeriod_result.new() + @handler.setInactivityTimeoutPeriod(args.periodInSeconds) + write_result(result, oprot, 'setInactivityTimeoutPeriod', seqid) + end + + def process_shutdown(seqid, iprot, oprot) + args = read_args(iprot, Shutdown_args) + result = Shutdown_result.new() + @handler.shutdown(args.status) + write_result(result, oprot, 'shutdown', seqid) + end + + def process_create(seqid, iprot, oprot) + args = read_args(iprot, Create_args) + result = Create_result.new() + begin + result.success = @handler.create(args.path) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'create', seqid) + end + + def process_createFile(seqid, iprot, oprot) + args = read_args(iprot, CreateFile_args) + result = CreateFile_result.new() + begin + result.success = @handler.createFile(args.path, args.mode, args.overwrite, args.bufferSize, args.block_replication, args.blocksize) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'createFile', seqid) + end + + def process_open(seqid, iprot, oprot) + args = read_args(iprot, Open_args) + result = Open_result.new() + begin + result.success = @handler.open(args.path) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'open', seqid) + end + + def process_append(seqid, iprot, oprot) + args = read_args(iprot, Append_args) + result = Append_result.new() + begin + result.success = @handler.append(args.path) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'append', seqid) + end + + def process_write(seqid, iprot, oprot) + args = read_args(iprot, Write_args) + result = Write_result.new() + begin + result.success = @handler.write(args.handle, args.data) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'write', seqid) + end + + def process_read(seqid, iprot, oprot) + args = read_args(iprot, Read_args) + result = Read_result.new() + begin + result.success = @handler.read(args.handle, args.offset, args.size) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'read', seqid) + end + + def process_close(seqid, iprot, oprot) + args = read_args(iprot, Close_args) + result = Close_result.new() + begin + result.success = @handler.close(args.out) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'close', seqid) + end + + def process_rm(seqid, iprot, oprot) + args = read_args(iprot, Rm_args) + result = Rm_result.new() + begin + result.success = @handler.rm(args.path, args.recursive) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'rm', seqid) + end + + def process_rename(seqid, iprot, oprot) + args = read_args(iprot, Rename_args) + result = Rename_result.new() + begin + result.success = @handler.rename(args.path, args.dest) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'rename', seqid) + end + + def process_mkdirs(seqid, iprot, oprot) + args = read_args(iprot, Mkdirs_args) + result = Mkdirs_result.new() + begin + result.success = @handler.mkdirs(args.path) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'mkdirs', seqid) + end + + def process_exists(seqid, iprot, oprot) + args = read_args(iprot, Exists_args) + result = Exists_result.new() + begin + result.success = @handler.exists(args.path) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'exists', seqid) + end + + def process_stat(seqid, iprot, oprot) + args = read_args(iprot, Stat_args) + result = Stat_result.new() + begin + result.success = @handler.stat(args.path) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'stat', seqid) + end + + def process_listStatus(seqid, iprot, oprot) + args = read_args(iprot, ListStatus_args) + result = ListStatus_result.new() + begin + result.success = @handler.listStatus(args.path) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'listStatus', seqid) + end + + def process_chmod(seqid, iprot, oprot) + args = read_args(iprot, Chmod_args) + result = Chmod_result.new() + begin + @handler.chmod(args.path, args.mode) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'chmod', seqid) + end + + def process_chown(seqid, iprot, oprot) + args = read_args(iprot, Chown_args) + result = Chown_result.new() + begin + @handler.chown(args.path, args.owner, args.group) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'chown', seqid) + end + + def process_setReplication(seqid, iprot, oprot) + args = read_args(iprot, SetReplication_args) + result = SetReplication_result.new() + begin + @handler.setReplication(args.path, args.replication) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'setReplication', seqid) + end + + def process_getFileBlockLocations(seqid, iprot, oprot) + args = read_args(iprot, GetFileBlockLocations_args) + result = GetFileBlockLocations_result.new() + begin + result.success = @handler.getFileBlockLocations(args.path, args.start, args.length) + rescue ThriftIOException => ouch + result.ouch = ouch + end + write_result(result, oprot, 'getFileBlockLocations', seqid) + end + + end + + # HELPER FUNCTIONS AND STRUCTURES + + class SetInactivityTimeoutPeriod_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PERIODINSECONDS = 1 + + FIELDS = { + PERIODINSECONDS => {:type => ::Thrift::Types::I64, :name => 'periodInSeconds'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class SetInactivityTimeoutPeriod_result + include ::Thrift::Struct, ::Thrift::Struct_Union + + FIELDS = { + + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Shutdown_args + include ::Thrift::Struct, ::Thrift::Struct_Union + STATUS = 1 + + FIELDS = { + STATUS => {:type => ::Thrift::Types::I32, :name => 'status'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Shutdown_result + include ::Thrift::Struct, ::Thrift::Struct_Union + + FIELDS = { + + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Create_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Create_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => ThriftHandle}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class CreateFile_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + MODE = 2 + OVERWRITE = 3 + BUFFERSIZE = 4 + BLOCK_REPLICATION = 5 + BLOCKSIZE = 6 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname}, + MODE => {:type => ::Thrift::Types::I16, :name => 'mode'}, + OVERWRITE => {:type => ::Thrift::Types::BOOL, :name => 'overwrite'}, + BUFFERSIZE => {:type => ::Thrift::Types::I32, :name => 'bufferSize'}, + BLOCK_REPLICATION => {:type => ::Thrift::Types::I16, :name => 'block_replication'}, + BLOCKSIZE => {:type => ::Thrift::Types::I64, :name => 'blocksize'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class CreateFile_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => ThriftHandle}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Open_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Open_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => ThriftHandle}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Append_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Append_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => ThriftHandle}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Write_args + include ::Thrift::Struct, ::Thrift::Struct_Union + HANDLE = 1 + DATA = -1 + + FIELDS = { + HANDLE => {:type => ::Thrift::Types::STRUCT, :name => 'handle', :class => ThriftHandle}, + DATA => {:type => ::Thrift::Types::STRING, :name => 'data'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Write_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::BOOL, :name => 'success'}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Read_args + include ::Thrift::Struct, ::Thrift::Struct_Union + HANDLE = 1 + OFFSET = -1 + SIZE = -2 + + FIELDS = { + HANDLE => {:type => ::Thrift::Types::STRUCT, :name => 'handle', :class => ThriftHandle}, + OFFSET => {:type => ::Thrift::Types::I64, :name => 'offset'}, + SIZE => {:type => ::Thrift::Types::I32, :name => 'size'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Read_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::STRING, :name => 'success'}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Close_args + include ::Thrift::Struct, ::Thrift::Struct_Union + OUT = 1 + + FIELDS = { + OUT => {:type => ::Thrift::Types::STRUCT, :name => 'out', :class => ThriftHandle} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Close_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::BOOL, :name => 'success'}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Rm_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + RECURSIVE = 2 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname}, + RECURSIVE => {:type => ::Thrift::Types::BOOL, :name => 'recursive'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Rm_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::BOOL, :name => 'success'}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Rename_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + DEST = 2 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname}, + DEST => {:type => ::Thrift::Types::STRUCT, :name => 'dest', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Rename_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::BOOL, :name => 'success'}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Mkdirs_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Mkdirs_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::BOOL, :name => 'success'}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Exists_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Exists_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::BOOL, :name => 'success'}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Stat_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Stat_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::STRUCT, :name => 'success', :class => FileStatus}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class ListStatus_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class ListStatus_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::LIST, :name => 'success', :element => {:type => ::Thrift::Types::STRUCT, :class => FileStatus}}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Chmod_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + MODE = 2 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname}, + MODE => {:type => ::Thrift::Types::I16, :name => 'mode'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Chmod_result + include ::Thrift::Struct, ::Thrift::Struct_Union + OUCH = 1 + + FIELDS = { + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Chown_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + OWNER = 2 + GROUP = 3 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname}, + OWNER => {:type => ::Thrift::Types::STRING, :name => 'owner'}, + GROUP => {:type => ::Thrift::Types::STRING, :name => 'group'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class Chown_result + include ::Thrift::Struct, ::Thrift::Struct_Union + OUCH = 1 + + FIELDS = { + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class SetReplication_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + REPLICATION = 2 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname}, + REPLICATION => {:type => ::Thrift::Types::I16, :name => 'replication'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class SetReplication_result + include ::Thrift::Struct, ::Thrift::Struct_Union + OUCH = 1 + + FIELDS = { + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class GetFileBlockLocations_args + include ::Thrift::Struct, ::Thrift::Struct_Union + PATH = 1 + START = 2 + LENGTH = 3 + + FIELDS = { + PATH => {:type => ::Thrift::Types::STRUCT, :name => 'path', :class => Pathname}, + START => {:type => ::Thrift::Types::I64, :name => 'start'}, + LENGTH => {:type => ::Thrift::Types::I64, :name => 'length'} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + + class GetFileBlockLocations_result + include ::Thrift::Struct, ::Thrift::Struct_Union + SUCCESS = 0 + OUCH = 1 + + FIELDS = { + SUCCESS => {:type => ::Thrift::Types::LIST, :name => 'success', :element => {:type => ::Thrift::Types::STRUCT, :class => BlockLocation}}, + OUCH => {:type => ::Thrift::Types::STRUCT, :name => 'ouch', :class => ThriftIOException} + } + + def struct_fields; FIELDS; end + + def validate + end + + ::Thrift::Struct.generate_accessors self + end + +end +