commit 00bee9a0c1e9c02eedb4ea2d14b5a7b12a3bf00d Author: Konstantin Gribov Date: Wed Dec 21 17:54:57 2016 +0300 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9d37c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +target +Cargo.lock diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..a0e3afd --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "smbc" +version = "0.1.0" +authors = ["Konstantin Gribov "] + +repository = "https://github.com/smbc-rs/smbc" +license = "GPL-3.0+" +keywords = ["smbclient", "samba", "cifs"] + +[dependencies] +libc = "^0.2.18" +log = "^0.3.6" +smbclient-sys = "^0.1.0" diff --git a/README.md b/README.md new file mode 100644 index 0000000..3ef8274 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# smbc -- `libsmbclient` wrapper + +## About + +`smbc` is a type-safe wrapper library for `libsmbclient` from [Samba][samba] project. + +It use [`smbclient-sys`][smbclient-sys] crate for bindings to `libsmbclient`. + + +## License + +Licensed under [GNU General Public License][gpl] version 3 or any later version. +It can be found at [COPYING](COPYING) or at [GNU][gpl] site. + + +[gpl]: https://www.gnu.org/licenses/gpl.txt +[samba]: https://www.samba.org diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..24572b6 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,49 @@ +// smbc is library wrapping libsmbclient from Samba project +// Copyright (c) 2016 Konstantin Gribov +// +// This file is part of smbc. +// +// smbc 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. +// +// smbc 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 smbc. If not, see . + +//! smbc is wrapper around `libsmbclient` from Samba project +//! +//! It provides basic `std::fs`-like API to access SMB/CIFS file shares +//! +//! Primary entrypoint is [`SmbClient`](struct.SmbClient.html) struct. +//! +//! Files are represented by [`SmbFile`](struct.SmbFile.html). +//! +//! Basic example: +//! ```rust +//! fn load +//! # fn main() {} +//! ``` + +//#![warn(missing_docs)] + +#[macro_use] +extern crate log; +extern crate libc; + +#[macro_use] +mod util; + +/// Module with smbc's Result and Error coercions +pub mod result; + +/// Main API module (reexported later) +pub mod smbc; + +pub use result::*; +pub use smbc::*; diff --git a/src/result.rs b/src/result.rs new file mode 100644 index 0000000..a941513 --- /dev/null +++ b/src/result.rs @@ -0,0 +1,80 @@ +// smbc is library wrapping libsmbclient from Samba project +// Copyright (c) 2016 Konstantin Gribov +// +// This file is part of smbc. +// +// smbc 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. +// +// smbc 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 smbc. If not, see . + +use std::error; +use std::ffi; +use std::fmt; +use std::io; +use std::result; + +pub type Result = result::Result; + +#[derive(Debug)] +pub enum Error { + NewContext(io::Error), + InitContext(io::Error), + AuthCallbackPaniced(Box), + NulInPath(ffi::NulError), + Io(io::Error), +} + +impl fmt::Display for Error { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match *self { + Error::NewContext(ref err) => write!(f, "New context error: {}", err), + Error::InitContext(ref err) => write!(f, "Init context error: {}", err), + Error::Io(ref err) => write!(f, "IO error: {}", err), + Error::NulInPath(ref err) => write!(f, "NUL in path: {}", err), + Error::AuthCallbackPaniced(ref err) => write!(f, "Auth callback paniced last time: {}", err) + } + } +} + +impl error::Error for Error { + fn description(&self) -> &str { + match *self { + Error::NewContext(ref err) => err.description(), + Error::InitContext(ref err) => err.description(), + Error::Io(ref err) => err.description(), + Error::NulInPath(ref err) => err.description(), + Error::AuthCallbackPaniced(ref _err) => "panic in auth callback", + } + } + + fn cause(&self) -> Option<&error::Error> { + match *self { + Error::NewContext(ref err) => Some(err), + Error::InitContext(ref err) => Some(err), + Error::Io(ref err) => Some(err), + Error::NulInPath(ref err) => Some(err), + Error::AuthCallbackPaniced(ref err) => Some(err.as_ref()), + } + } +} + +impl From for Error { + fn from(err: io::Error) -> Self { + Error::Io(err) + } +} + +impl From for Error { + fn from(err: ffi::NulError) -> Self { + Error::NulInPath(err) + } +} diff --git a/src/smbc.rs b/src/smbc.rs new file mode 100644 index 0000000..d647a09 --- /dev/null +++ b/src/smbc.rs @@ -0,0 +1,480 @@ +// smbc is library wrapping libsmbclient from Samba project +// Copyright (c) 2016 Konstantin Gribov +// +// This file is part of smbc. +// +// smbc 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. +// +// smbc 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 smbc. If not, see . + +//! `smbc` is wrapper library around `libsmbclient` from Samba project. + +// imports {{{1 +use std::default::Default; +use std::io; +use std::mem; +use std::panic; +use std::ptr; + +use std::borrow::Cow; +use std::io::{Read, Write, Seek, SeekFrom}; + +use libc::{self, c_char, c_int, c_void}; + +use smblient_sys::*; +use util::*; +use result::Result; +// 1}}} + +// types {{{1 +// {{{2 +/// ## Basic info +/// +/// `SmbClient` is primary struct in *smbc*. +/// +/// It wraps and manages `libsmbclient`s `SMBCCTX *` +/// and provides an entry point for all interaction with `SMB` shares. +/// +/// When `SmbClient` is obtained it can be used to: +/// +/// * open files in different modes (see +/// [`open_with(..)` method family](struct.SmbClient.html#method.open_with) +/// and [`SmbFile` examples](struct.SmbFile.html#examples)) +/// * create and delete directories (see +/// [`create_dir(..)`](struct.SmbClient.html#method.create_dir)/ +/// [`remove_dir(..)`](struct.SmbClient.html#method.remove_dor)) +/// +/// ## Examples +/// +/// ```rust +/// # use std::borrow::Cow; +/// # +/// # fn main() {} +/// # +/// # fn example() -> smbc::Result<()> { +/// let password = "Pa$$w0rd1!".to_owned(); +/// +/// let password_ref: &str = &password; +/// let auth = move |host: &str, share: &str| { +/// (Cow::Borrowed("WORKGROUP"), Cow::Borrowed("test"), Cow::Borrowed(password_ref)) +/// }; +/// let client = try!(smbc::SmbClient::new(&auth)); +/// +/// # Ok(()) +/// # } +/// ``` +/// +// 2}}} +pub struct SmbClient<'a> { + ctx: *mut SMBCCTX, + #[allow(dead_code)] + auth_fn: &'a for<'b> Fn(&'b str, &'b str) -> (Cow<'a, str>, Cow<'a, str>, Cow<'a, str>), +} + +// {{{2 +/// ## Basic info +/// +/// `SmbFile` is representation of currently open file. +/// +/// It corresponds to `libsmbclient`'s `SMBCFILE *`. +/// +/// ## Examples +/// +/// See also [`SmbClient`'s examples](struct.SmbClient.html#) +/// to find out how to initialize `SmbClient`. +/// +/// ```rust +/// # use std::borrow::Cow; +/// # use std::io::{Read, Write, Seek}; +/// # +/// # fn main() {} +/// # +/// fn get_content(file: &mut smbc::SmbFile) -> smbc::Result { +/// let mut buffer = String::new(); +/// try!(file.read_to_string(&mut buffer)); +/// Ok(buffer) +/// } +/// +/// fn example() -> smbc::Result<()> { +/// // ...snip... +/// # let password = "Pa$$w0rd1"; +/// # let auth = move |host: &str, share: &str| { +/// # (Cow::Borrowed("WORKGROUP"), Cow::Borrowed("test"), Cow::Borrowed(password)) +/// # }; +/// let client = try!(smbc::SmbClient::new(&auth)); +/// let mut file = try!(client.open("smb://127.0.0.1/share/path/to/file")); +/// println!("dumped file:\n\n{}", try!(get_content(&mut file))); +/// Ok(()) +/// } +/// ``` +// 2}}} +pub struct SmbFile<'a: 'b, 'b> { + smbc: &'b SmbClient<'a>, + fd: *mut SMBCFILE, +} +// 1}}} + +/// Default (dummy) credential `WORKGROUP\guest` with empty password +const DEF_CRED: (Cow<'static, str>, Cow<'static, str>, Cow<'static, str>) = (Cow::Borrowed("WORKGROUP"), Cow::Borrowed("guest"), Cow::Borrowed("")); + +// SmbClient {{{1 +impl<'a> SmbClient<'a> { + // {{{2 + /// Creates new `SmbClient` given auth function. + /// + /// `auth_fn` receives two callback parameters: + /// + /// * `server` -- server for which auth is requested + /// * `share` -- share for which auth is requested + /// + /// Should *return* tuple `(workgroup, username, password)` as a result. + pub fn new(auth_fn: &'a F) -> Result> + where F: for<'b> Fn(&'b str, &'b str) -> (Cow<'a, str>, Cow<'a, str>, Cow<'a, str>) { + let mut smbc = SmbClient { + ctx: ptr::null_mut(), + auth_fn: auth_fn, + }; + + unsafe { + let ctx = try!(result_from_ptr_mut(smbc_new_context())); + + smbc_setOptionUserData(ctx, auth_fn as *const _ as *mut c_void); + smbc_setFunctionAuthDataWithContext(ctx, Some(Self::auth_wrapper::)); + + smbc_setOptionOneSharePerServer(ctx, SMBC_TRUE); + + smbc_setOptionDebugToStderr(ctx, SMBC_TRUE); + //smbc_setDebug(ctx, 10); + + smbc.ctx = try!(result_from_ptr_mut(smbc_init_context(ctx))); + } + + trace!(target: "smbc", "new smbclient"); + Ok(smbc) + } + + /// Auth wrapper passed to `SMBCCTX` to authenticate requests to SMB servers. + unsafe extern "C" fn auth_wrapper(ctx: *mut SMBCCTX, + srv: *const c_char, + shr: *const c_char, + wg: *mut c_char, + wglen: c_int, + un: *mut c_char, + unlen: c_int, + pw: *mut c_char, + pwlen: c_int) + -> () + where F: for<'b> Fn(&'b str, &'b str) -> (Cow<'a, str>, Cow<'a, str>, Cow<'a, str>) { + let srv = cstr(srv); + let shr = cstr(shr); + trace!(target: "smbc", "authenticating on {}\\{}", &srv, &shr); + + let auth: &'a F = mem::transmute(smbc_getOptionUserData(ctx) as *const c_void); + let auth = panic::AssertUnwindSafe(auth); + let r = panic::catch_unwind(|| { + trace!(target: "smbc", "auth with {:?}\\{:?}", srv, shr); + auth(&srv, &shr) + }); + let (workgroup, username, password) = r.unwrap_or(DEF_CRED); + trace!(target: "smbc", "cred: {}\\{} {}", &workgroup, &username, &password); + write_to_cstr(wg as *mut u8, wglen as usize, &workgroup); + write_to_cstr(un as *mut u8, unlen as usize, &username); + write_to_cstr(pw as *mut u8, pwlen as usize, &password); + () + } + + /// Opens [`SmbFile`](struct.SmbFile.html) defined by SMB `path` with `options`. + /// + /// See [OpenOptions](struct.OpenOptions.html). + pub fn open_with<'b, P: AsRef>(&'b self, + path: P, + options: OpenOptions) + -> Result> { + trace!(target: "smbc", "open_with {:?}", options); + + let open_fn = try_ufn!(smbc_getFunctionOpen <- self); + + let path = try!(cstring(path)); + trace!(target: "smbc", "opening {:?} with {:?}", path, open_fn); + + unsafe { + let fd = try!(result_from_ptr_mut(open_fn(self.ctx, + path.as_ptr(), + try!(options.to_flags()), + options.mode))); + if (fd as i64) < 0 { + trace!(target: "smbc", "neg fd"); + } + Ok(SmbFile { + smbc: &self, + fd: fd, + }) + } + } + + /// Open read-only [`SmbFile`](struct.SmbFile.html) defined by SMB `path`. + /// + /// Alias for [`open_ro(..)`](struct.SmbClient.html#method.open_ro). + pub fn open<'b, P: AsRef>(&'b self, path: P) -> Result> { + self.open_ro(path) + } + + /// Open write-only [`SmbFile`](struct.SmbFile.html) defined by SMB `path`. + /// + /// If file doesn't exists it will be created. + /// If file exists it will be truncated. + /// + /// Alias for [`open_wo(..)`](struct.SmbClient.html#method.open_wo). + pub fn create<'b, P: AsRef>(&'b self, path: P) -> Result> { + self.open_wo(path) + } + + /// Open read-only [`SmbFile`](struct.SmbFile.html) defined by SMB `path`. + /// + /// See [`open_with(..)`](struct.SmbClient.html#method.open_with). + pub fn open_ro<'b, P: AsRef>(&'b self, path: P) -> Result> { + self.open_with(path, OpenOptions::default()) + } + + /// Open write-only [`SmbFile`](struct.SmbFile.html) defined by SMB `path`. + /// + /// If file doesn't exists it will be created. + /// If file exists it will be truncated. + /// + /// See [`open_with(..)`](struct.SmbClient.html#method.open_with). + pub fn open_wo<'b, P: AsRef>(&'b self, path: P) -> Result> { + self.open_with(path, OpenOptions::default().read(false).write(true).create(true).truncate(true)) + } + + /// Open read-write [`SmbFile`](struct.SmbFile.html) defined by SMB `path`. + /// + /// If file doesn't exists it will be created. + /// + /// See [`open_with(..)`](struct.SmbClient.html#method.open_with). + pub fn open_rw<'b, P: AsRef>(&'b self, path: P) -> Result> { + self.open_with(path, OpenOptions::default().read(true).write(true).create(true)) + } + + #[doc(hidden)] + /// Get metadata for file at `path` + pub fn metadata>(&self, path: P) -> Result<()> { + let stat_fn = try_ufn!(smbc_getFunctionStat <- self); + let path = try!(cstring(path)); + + unimplemented!(); + } + + /// Create new directory at SMB `path` + pub fn create_dir>(&self, path: P) -> Result<()> { + let mkdir_fn = try_ufn!(smbc_getFunctionMkdir <- self); + let path = try!(cstring(path)); + try!(to_result_with_le(unsafe { mkdir_fn(self.ctx, path.as_ptr(), 0o755) })); + Ok(()) + } + + // pub fn create_dir_all>(&self, path: P) -> Result<()> { + // unimplemented!(); + // } + + /// Delete directory at SMB `path`. + /// + /// Directory should be empty to delete it. + pub fn remove_dir>(&self, path: P) -> Result<()> { + let rmdir_fn = try_ufn!(smbc_getFunctionRmdir <- self); + let path = try!(cstring(path)); + try!(to_result_with_le(unsafe { rmdir_fn(self.ctx, path.as_ptr()) })); + Ok(()) + } +} // 2}}} + +impl<'a> Drop for SmbClient<'a> { + // {{{2 + /// Destroy `SmbClient` and close all connections. + fn drop(&mut self) { + trace!(target: "smbc", "closing smbclient"); + unsafe { + smbc_free_context(self.ctx, 1 as c_int); + } + } +} // 2}}} +// 1}}} + +// OpenOptions {{{1 +/// Describes options for opening file: +/// +/// * `read` if readable; +/// * `write` if writable; +/// * `flags` is *bitwise OR* of `O_CREAT`, `O_EXCL` and `O_TRUNC`; +/// * `mode` for *POSIX* file mode. +#[derive(Clone, Copy, Debug)] +pub struct OpenOptions { + flags: c_int, + read: bool, + write: bool, + mode: mode_t, +} + +impl OpenOptions { + // {{{2 + /// Allows reading file (set by default). + pub fn read(mut self, read: bool) -> Self { + self.read = read; + self + } + + /// Allows writing to file. + pub fn write(mut self, write: bool) -> Self { + self.write = write; + self + } + + /// Allows appending to file. + pub fn append(mut self, append: bool) -> Self { + self.flag(libc::O_APPEND, append); + self + } + + /// Allows creating file if it doesn't exists. + /// + /// Opening file will fail in case file exists if + /// [`exclusive`](struct.OpenOptions.html#method.exclusive) + /// also set. + pub fn create(mut self, create: bool) -> Self { + self.flag(libc::O_CREAT, create); + self + } + + /// File will be truncated (size set to `0`) + /// if it's already exists. + pub fn truncate(mut self, truncate: bool) -> Self { + self.flag(libc::O_TRUNC, truncate); + self + } + + /// `open_*` will fail if file already exists + /// (when used with `create` also set). + /// + /// See [`create`](struct.OpenOptions.html#method.create) + pub fn exclusive(mut self, exclusive: bool) -> Self { + self.flag(libc::O_EXCL, exclusive); + self + } + + /// Set POSIX file mode + pub fn mode(mut self, mode: mode_t) -> Self { + self.mode = mode; + self + } + + fn flag(&mut self, flag: c_int, on: bool) { + if on { + self.flags |= flag; + } else { + self.flags &= !flag; + } + } + + /// Naive impl, rewrite to check for incompatible flags + fn to_flags(&self) -> Result { + let base_mode = match (self.read, self.write) { + // defaults to read only + (false, false) | + (true, false) => libc::O_RDONLY, + (false, true) => libc::O_WRONLY, + (true, true) => libc::O_RDWR, + }; + Ok(base_mode | self.flags) + } +} // }}} +// 1}}} + +impl Default for OpenOptions { + /// Default [`OpenOptions`](struct.OpenOptions.html) is + /// read-only with POSIX perms `0644` + /// (`rw` for owner, `r` for group and others). + fn default() -> OpenOptions { + OpenOptions { + flags: 0, + read: true, + write: false, + mode: 0o644, + } + } +} + +// SmbFile {{{1 +impl<'a, 'b> SmbFile<'a, 'b> { + // {{{2 +} // }}} + +impl<'a, 'b> Read for SmbFile<'a, 'b> { + // {{{2 + fn read(&mut self, buf: &mut [u8]) -> io::Result { + trace!(target: "smbc", "reading file to buf [{:?};{}]", buf.as_ptr(), buf.len()); + let read_fn = try_ufn!(smbc_getFunctionRead <- self.smbc); + let bytes_read = try!(to_result_with_le(unsafe { + read_fn(self.smbc.ctx, + self.fd, + buf.as_mut_ptr() as *mut c_void, + buf.len()) + })); + Ok(bytes_read as usize) + } +} // }}} + +impl<'a, 'b> Write for SmbFile<'a, 'b> { + // {{{2 + fn write(&mut self, buf: &[u8]) -> io::Result { + trace!(target: "smbc", "writing buf [{:?};{}] to file", buf.as_ptr(), buf.len()); + let write_fn = try_ufn!(smbc_getFunctionWrite <- self.smbc); + let bytes_wrote = try!(to_result_with_le(unsafe { + write_fn(self.smbc.ctx, + self.fd, + buf.as_ptr() as *const c_void, + buf.len()) + })); + Ok(bytes_wrote as usize) + } + + /// Do nothing for SmbFile + fn flush(&mut self) -> io::Result<()> { + Ok(()) + } +} // }}} + +impl<'a, 'b> Seek for SmbFile<'a, 'b> { + // {{{2 + fn seek(&mut self, pos: SeekFrom) -> io::Result { + trace!(target: "smbc", "seeking file {:?}", pos); + let lseek_fn = try_ufn!(smbc_getFunctionLseek <- self.smbc); + let (whence, off) = match pos { + SeekFrom::Start(p) => (libc::SEEK_SET, p as off_t), + SeekFrom::End(p) => (libc::SEEK_END, p as off_t), + SeekFrom::Current(p) => (libc::SEEK_CUR, p as off_t), + }; + let res = try!(to_result_with_errno(unsafe { lseek_fn(self.smbc.ctx, self.fd, off, whence) }, libc::EINVAL)); + Ok(res as u64) + } +} // }}} + +impl<'a, 'b> Drop for SmbFile<'a, 'b> { + // {{{2 + fn drop(&mut self) { + trace!(target: "smbc", "closing file"); + unsafe { + smbc_getFunctionClose(self.smbc.ctx).map(|f| f(self.smbc.ctx, self.fd)); + } + } +} // }}} +// 1}}} + +// vim: fen:fdm=marker:fdl=1: diff --git a/src/util.rs b/src/util.rs new file mode 100644 index 0000000..fee2aa4 --- /dev/null +++ b/src/util.rs @@ -0,0 +1,88 @@ +// smbc is library wrapping libsmbclient from Samba project +// Copyright (c) 2016 Konstantin Gribov +// +// This file is part of smbc. +// +// smbc 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. +// +// smbc 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 smbc. If not, see . + +use libc::{self, c_char, c_int}; + +use std::borrow::Cow; +use std::ffi::{CStr, CString}; +use std::io::{self, Write}; +use std::slice; + +use result::*; + +/// try! get smbc function or return io::Error(EINVAL) +macro_rules! try_ufn { + ($e:ident <- $s:expr) => (try!(unsafe { + $e($s.ctx).ok_or($crate::std::io::Error::from_raw_os_error(libc::EINVAL as i32)) + })) +} + +#[inline(always)] +/// Ok(ptr) for non-null ptr or Err(last_os_error) otherwise +pub fn result_from_ptr_mut(ptr: *mut T) -> io::Result<*mut T> { + if ptr.is_null() { Err(io::Error::last_os_error()) } else { Ok(ptr) } +} + +#[inline(always)] +/// Ok(ptr) for non-null ptr or Err(last_os_error) otherwise +pub fn result_from_ptr(ptr: *const T) -> io::Result<*const T> { + if ptr.is_null() { Err(io::Error::last_os_error()) } else { Ok(ptr) } +} + +pub unsafe fn cstr<'a, T>(p: *const T) -> Cow<'a, str> { + CStr::from_ptr(p as *const c_char).to_string_lossy() +} + +pub fn cstring>(p: P) -> Result { + Ok(try!(CString::new(p.as_ref()))) +} + +pub unsafe fn write_to_cstr(dest: *mut u8, len: usize, src: &str) { + // just to ensure that it can be interpreted as c string + *(dest.offset((len - 1) as isize)) = 0u8; + trace!(target: "smbc", "orig: {:?}", cstr(dest)); + + let mut buf = slice::from_raw_parts_mut(dest, len); + let mut idx = buf.write(src.as_bytes()).unwrap(); + + if idx == len { + idx -= 1; + } + buf = slice::from_raw_parts_mut(dest, len); + buf[idx] = 0u8; + + trace!(target: "smbc", "write to [{:p};{}] from [{:p},{}]: {:?}", dest, len, src.as_ptr(), src.len(), cstr(dest)); +} + +#[inline(always)] +/// to io::Result with Err(last_os_error) if t == -1 +pub fn to_result_with_le>(t: T) -> io::Result { + to_result_with_error(t, io::Error::last_os_error()) +} + +#[inline(always)] +/// to io::Result with Err(from_raw_os_error(errno)) if t == -1 +pub fn to_result_with_errno>(t: T, errno: c_int) -> io::Result { + to_result_with_error(t, io::Error::from_raw_os_error(errno as i32)) +} + +#[inline(always)] +fn to_result_with_error>(t: T, err: io::Error) -> io::Result { + if t == T::from(-1) { Err(err) } else { Ok(t) } +} +