commit a3569795552b51804900267d23f3c8e8cf124d07 Author: deadc0de6 Date: Tue Mar 7 19:19:00 2017 +0100 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0d20b64 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.pyc diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +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: + + {project} Copyright (C) {year} {fullname} + 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/bootstrap.sh b/bootstrap.sh new file mode 100755 index 0000000..e22435a --- /dev/null +++ b/bootstrap.sh @@ -0,0 +1,19 @@ +#!/bin/bash +# author: deadc0de6 (https://github.com/deadc0de6) + +fold="dotfiles" + +# copy dotdrop entry point +cat dotdrop/dotdrop.sh | sed 's#${cur}/dotdrop/dotdrop.py#${cur}/dotdrop/dotdrop/dotdrop.py#g' > dotdrop.sh +chmod +x dotdrop.sh +mkdir $fold + +# init config file +cat << EOF > config.yaml +config: + backup: true + create: true + dotpath: $fold +dotfiles: +profiles: +EOF diff --git a/dotdrop.sh b/dotdrop.sh new file mode 100755 index 0000000..3fc767f --- /dev/null +++ b/dotdrop.sh @@ -0,0 +1,13 @@ +#!/bin/bash +# author: deadc0de6 (https://github.com/deadc0de6) + +args="$@" +cur=`dirname $(readlink -f $0)` +opwd=`pwd` +bin="${cur}/dotdrop/dotdrop.py" + +# run dotdrop +cfg="${cur}/config.yaml" +cd ${cur} +python3 ${bin} --cfg=${cfg} $args +cd ${opwd} diff --git a/dotdrop/__init__.py b/dotdrop/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/dotdrop/config.py b/dotdrop/config.py new file mode 100644 index 0000000..c117612 --- /dev/null +++ b/dotdrop/config.py @@ -0,0 +1,133 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +config file manager +""" + +import yaml +import os +from dotfile import Dotfile +from logger import Logger + + +class Cfg: + key_all = 'ALL' + key_config = 'config' + key_profiles = 'profiles' + key_dotfiles = 'dotfiles' + key_dotfiles_src = 'src' + key_dotfiles_dst = 'dst' + + def __init__(self, cfgpath, dotpath): + if not os.path.exists(cfgpath): + raise ValueError('config file does not exist') + self.cfgpath = cfgpath + self.log = Logger() + relconf = dotpath + if not relconf.startswith(os.sep): + relconf = os.path.join(os.path.dirname(cfgpath), dotpath) + self.configs = {'dotpath': relconf} + self.dotfiles = {} + self.profiles = {} + self.prodots = {} + if not self._load_file(): + raise ValueError('config is not valid') + + def _load_file(self): + with open(self.cfgpath, 'r') as f: + self.content = yaml.load(f) + if not self._is_valid(): + return False + return self._parse() + + def _is_valid(self): + if self.key_profiles not in self.content: + self.log.err('missing \"%s\" in config' % (self.key_profiles)) + return False + if self.key_config not in self.content: + self.log.err('missing \"%s\" in config' % (self.key_config)) + return False + if self.key_dotfiles not in self.content: + self.log.err('missing \"%s\" in config' % (self.key_dotfiles)) + return False + return True + + def _parse(self): + """ parse config file """ + self.profiles = self.content[self.key_profiles] + if self.profiles is None: + self.profiles = {} + self.configs = self.content[self.key_config] + # contains all defined dotfiles + if self.content[self.key_dotfiles] is not None: + for k, v in self.content[self.key_dotfiles].items(): + src = v[self.key_dotfiles_src] + dst = v[self.key_dotfiles_dst] + self.dotfiles[k] = Dotfile(k, dst, src) + # contains a list of dotfiles defined for each profile + for k, v in self.profiles.items(): + self.prodots[k] = [] + if v is None: + continue + if len(v) == 1 and v == [self.key_all]: + self.prodots[k] = self.dotfiles.values() + else: + self.prodots[k].extend([self.dotfiles[dot] for dot in v]) + # make sure we have a correct dotpath + if not self.configs['dotpath'].startswith(os.sep): + relconf = os.path.join(os.path.dirname( + self.cfgpath), self.configs['dotpath']) + self.configs['dotpath'] = relconf + return True + + def new(self, dotfile, profile): + """ import new dotfile """ + dots = self.content[self.key_dotfiles] + if dots is None: + self.content[self.key_dotfiles] = {} + dots = self.content[self.key_dotfiles] + if self.content[self.key_dotfiles] and dotfile.key in dots: + self.log.err('\"%s\" entry already exists in dotfiles' % + (dotfile.key)) + return False + home = os.path.expanduser('~') + dotfile.dst = dotfile.dst.replace(home, '~') + dots[dotfile.key] = { + self.key_dotfiles_dst: dotfile.dst, + self.key_dotfiles_src: dotfile.src + } + profiles = self.profiles + if profile in profiles and profiles[profile] != [self.key_all]: + if self.content[self.key_profiles][profile] is None: + self.content[self.key_profiles][profile] = [] + self.content[self.key_profiles][profile].append(dotfile.key) + elif profile not in profiles: + if self.content[self.key_profiles] is None: + self.content[self.key_profiles] = {} + self.content[self.key_profiles][profile] = [dotfile.key] + self.profiles = self.content[self.key_profiles] + + def get_dotfiles(self, profile): + """ returns a list of dotfiles for a specific profile """ + if profile not in self.prodots: + return [] + tmp = sorted(self.prodots[profile], key=lambda x: x.key, reverse=True) + return tmp + + def get_profiles(self): + """ returns all defined profiles """ + return self.profiles.keys() + + def get_configs(self): + """ returns all defined configs """ + return self.configs.copy() + + def dump(self): + """ dump config file """ + return yaml.dump(self.content, default_flow_style=False, indent=2) + + def save(self): + """ save config file to path """ + with open(self.cfgpath, 'w') as f: + ret = yaml.dump(self.content, f, + default_flow_style=False, indent=2) + return ret diff --git a/dotdrop/dotdrop.py b/dotdrop/dotdrop.py new file mode 100755 index 0000000..03dc2fd --- /dev/null +++ b/dotdrop/dotdrop.py @@ -0,0 +1,178 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +entry point +""" + +import os +import sys +import subprocess +import utils +from docopt import docopt +from logger import Logger +from templategen import Templategen +from installer import Installer +from dotfile import Dotfile +from config import Cfg + +VERSION = '0.1' +DEF_DOTFILES = 'dotfiles' +CUR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +LOG = Logger() +HOSTNAME = os.uname()[1] + +BANNER = """ _ _ _ + __| | ___ | |_ __| |_ __ ___ _ __ + / _` |/ _ \| __/ _` | '__/ _ \| '_ | + \__,_|\___/ \__\__,_|_| \___/| .__/ v%s + |_|""" % (VERSION) + +USAGE = """ +%s + +Usage: + dotdrop.py install [--profile=] [--cfg=] + [(-f | --force)] [--nodiff] [--dry] + dotdrop.py compare [--profile=] [--cfg=] + dotdrop.py list [--cfg=] + dotdrop.py import [--cfg=] [--profile=] [--dry] ... + dotdrop.py (-h | --help) + dotdrop.py (-v | --version) + +Options: + --profile= Specify the profile to use [default: %s]. + --cfg= Path to the config [default: %s/config.yaml]. + --dry Dry run. + --nodiff Do not diff when installing [default: False]. + -f --force Do not warn if exists [default: False]. + -v --version Show version. + -h --help Show this screen. + +""" % (BANNER, HOSTNAME, CUR) + +########################################################### +# entry point +########################################################### + + +def install(opts, conf): + dotfiles = conf.get_dotfiles(opts['profile']) + if dotfiles == []: + LOG.err('no dotfiles defined for this profile (\"%s\")' % + (str(opts['profile']))) + return False + t = Templategen(base=opts['dotpath']) + inst = Installer(create=opts['create'], backup=opts['backup'], + dry=opts['dry'], safe=opts['safe'], base=opts['dotpath'], + diff=opts['installdiff']) + installed = [] + for dotfile in dotfiles: + r = inst.install(t, opts['profile'], dotfile.src, dotfile.dst) + installed.extend(r) + LOG.log('\n%u dotfile(s) installed.' % (len(installed))) + return True + + +def compare(opts, conf, tmp): + dotfiles = conf.get_dotfiles(opts['profile']) + if dotfiles == []: + LOG.err('no dotfiles defined for this profile (\"%s\")' % + (str(opts['profile']))) + return False + t = Templategen(base=opts['dotpath']) + inst = Installer(create=opts['create'], backup=opts['backup'], + dry=opts['dry'], base=opts['dotpath'], quiet=True) + for dotfile in dotfiles: + LOG.log('diffing \"%s\" VS \"%s\"' % (dotfile.key, dotfile.dst)) + inst.compare(t, tmp, opts['profile'], dotfile.src, dotfile.dst) + return len(dotfiles) > 0 + + +def importer(opts, conf, paths): + home = os.path.expanduser('~') + cnt = 0 + for path in paths: + dst = path.rstrip(os.sep) + key = dst.split(os.sep)[-1] + if key == 'config': + key = '_'.join(dst.split(os.sep)[-2:]) + key = key.lstrip('.') + key = key.lower() + if os.path.isdir(dst): + key = 'd_%s' % (key) + else: + key = 'f_%s' % (key) + src = dst.lstrip(home).lstrip('.') + dotfile = Dotfile(key, dst, src) + srcf = os.path.join(CUR, opts['dotpath'], src) + if os.path.exists(srcf): + LOG.err('\"%s\" already exists !' % (srcf)) + continue + conf.new(dotfile, opts['profile']) + cmd = ['mkdir', '-p', '%s' % (os.path.dirname(srcf))] + if opts['dry']: + LOG.dry('would run: %s' % (' '.join(cmd))) + else: + utils.run(cmd, raw=False, log=False) + cmd = ['cp', '-r', '%s' % (dst), '%s' % (srcf)] + if opts['dry']: + LOG.dry('would run: %s' % (' '.join(cmd))) + else: + utils.run(cmd, raw=False, log=False) + LOG.sub('\"%s\" imported' % (path)) + cnt += 1 + if opts['dry']: + LOG.dry('new config file would be:') + LOG.raw(conf.dump()) + else: + conf.save() + LOG.log('\n%u file(s) imported.' % (cnt)) + + +def list_profiles(conf): + LOG.log('Available profile(s):') + for p in conf.get_profiles(): + LOG.sub(p) + LOG.log('') + + +def header(): + LOG.log(BANNER) + LOG.log("") + +if __name__ == '__main__': + ret = True + args = docopt(USAGE, version=VERSION) + conf = Cfg(args['--cfg'], DEF_DOTFILES) + + opts = conf.get_configs() + opts['dry'] = args['--dry'] + opts['profile'] = args['--profile'] + opts['safe'] = not args['--force'] + opts['installdiff'] = not args['--nodiff'] + + header() + + try: + + if args['list']: + list_profiles(conf) + + elif args['install']: + ret = install(opts, conf) + + elif args['compare']: + tmp = utils.get_tmpdir() + if compare(opts, conf, tmp): + LOG.log('generated temporary files available under %s' % (tmp)) + else: + os.rmdir(tmp) + + elif args['import']: + importer(opts, conf, args['']) + + except KeyboardInterrupt: + LOG.err('interrupted') + + if ret: + sys.exit(0) + sys.exit(1) diff --git a/dotdrop/dotfile.py b/dotdrop/dotfile.py new file mode 100644 index 0000000..0c6de8f --- /dev/null +++ b/dotdrop/dotfile.py @@ -0,0 +1,17 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +represents a dotfile in dotdrop +""" + + +class Dotfile: + + def __init__(self, key, dst, src): + self.key = key + self.dst = dst + self.src = src + + def __str__(self): + string = 'key:%s, src: %s, dst: %s' % (self.key, + self.src, self.dst) + return string diff --git a/dotdrop/installer.py b/dotdrop/installer.py new file mode 100644 index 0000000..0ca6f60 --- /dev/null +++ b/dotdrop/installer.py @@ -0,0 +1,139 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +handle the installation of dotfiles +""" + +import os +import utils +from logger import Logger + + +class Installer: + + BACKUP_SUFFIX = '.dotdropbak' + + def __init__(self, base='.', create=True, backup=True, + dry=False, safe=False, quiet=False, diff=True): + self.create = create + self.backup = backup + self.dry = dry + self.safe = safe + self.base = base + self.quiet = quiet + self.diff = diff + self.log = Logger() + + def install(self, templater, profile, src, dst): + src = os.path.join(self.base, os.path.expanduser(src)) + dst = os.path.join(self.base, os.path.expanduser(dst)) + if os.path.isdir(src): + return self._handle_dir(templater, profile, src, dst) + return self._handle_file(templater, profile, src, dst) + + def _preparesub(self): + if not os.path.exists(self.sub): + os.makedirs(self.sub) + + def _handle_file(self, templater, profile, src, dst): + content = templater.generate(src, profile) + if content is None: + self.log.err('generate from template \"%s\"' % (src)) + return [] + st = os.stat(src) + ret = self._write(dst, content, st.st_mode) + if ret < 0: + self.log.err('installing %s to %s' % (src, dst)) + return [] + if ret > 0: + self.log.sub('ignoring \"%s\", same content' % (dst)) + return [] + if ret == 0: + if not self.quiet: + self.log.sub('copied %s to %s' % (src, dst)) + return [(src, dst)] + return [] + + def _handle_dir(self, templater, profile, src, dst): + ret = [] + for entry in os.listdir(src): + f = os.path.join(src, entry) + if not os.path.isdir(f): + res = self._handle_file( + templater, profile, f, os.path.join(dst, entry)) + ret.extend(res) + else: + res = self._handle_dir( + templater, profile, f, os.path.join(dst, entry)) + ret.extend(res) + return ret + + def _fake_diff(self, dst, content): + cur = '' + with open(dst, 'br') as f: + cur = f.read() + return cur == content + + def _write(self, dst, content, rights): + """ write file """ + if self.dry: + self.log.dry('would install %s' % (dst)) + return 0 + if os.path.exists(dst) and self.safe: + if self.diff and self._fake_diff(dst, content): + return 1 + if not self.log.ask('Overwrite \"%s\"' % (dst)): + self.log.warn('ignoring \"%s\", already present' % (dst)) + return 1 + if self.backup and os.path.exists(dst): + self._backup(dst) + base = os.path.dirname(dst) + if not self._create_dirs(base): + self.log.err('creating directory for %s' % (dst)) + return -1 + with open(dst, 'wb') as f: + f.write(content) + os.chmod(dst, rights) + return 0 + + def _create_dirs(self, folder): + if not self.create and not os.path.exists(folder): + return False + if os.path.exists(folder): + return True + os.makedirs(folder) + return os.path.exists(folder) + + def _backup(self, path): + if self.dry: + return + dst = path.rstrip(os.sep) + self.BACKUP_SUFFIX + self.log.log('backup %s to %s' % (path, dst)) + os.rename(path, dst) + + def _install_to_temp(self, templater, profile, src, dst, tmpfolder): + sub = dst + if dst[0] == os.sep: + sub = dst[1:] + tmpdst = os.path.join(tmpfolder, sub) + return self.install(templater, profile, src, tmpdst), tmpdst + + def compare(self, templater, tmpfolder, profile, src, dst): + drysaved = self.dry + self.dry = False + diffsaved = self.diff + self.diff = False + src = os.path.expanduser(src) + dst = os.path.expanduser(dst) + if not os.path.exists(dst): + self.log.warn('\"%s\" does not exist on local' % (dst)) + else: + ret, tmpdst = self._install_to_temp( + templater, profile, src, dst, tmpfolder) + if ret: + diff = utils.diff(tmpdst, dst, log=False, raw=False) + if diff == '': + self.log.raw('same file') + else: + self.log.emph(diff) + self.dry = drysaved + self.diff = diffsaved diff --git a/dotdrop/logger.py b/dotdrop/logger.py new file mode 100644 index 0000000..c55b0af --- /dev/null +++ b/dotdrop/logger.py @@ -0,0 +1,65 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +handle logging to stdout/stderr +""" + +import sys + + +class Logger: + + RED = '\033[91m' + GREEN = '\033[92m' + YELLOW = '\033[93m' + BLUE = '\033[94m' + MAGENTA = '\033[95m' + RESET = '\033[0m' + EMPH = '\033[33m' + + def __init__(self): + pass + + def log(self, string, end='\n', pre=''): + cs = self._color(self.BLUE) + ce = self._color(self.RESET) + sys.stdout.write('%s%s%s%s%s' % (pre, cs, string, end, ce)) + + def sub(self, string): + cs = self._color(self.BLUE) + ce = self._color(self.RESET) + sys.stdout.write('\t%s->%s %s\n' % (cs, ce, string)) + + def emph(self, string): + cs = self._color(self.EMPH) + ce = self._color(self.RESET) + sys.stderr.write('%s%s%s' % (cs, string, ce)) + + def err(self, string, end='\n'): + cs = self._color(self.RED) + ce = self._color(self.RESET) + sys.stderr.write('%s[ERR]%s %s%s' % (cs, string, end, ce)) + + def warn(self, string, end='\n'): + cs = self._color(self.YELLOW) + ce = self._color(self.RESET) + sys.stderr.write('%s[WARN]%s %s%s' % (cs, string, end, ce)) + + def dry(self, string, end='\n'): + cs = self._color(self.GREEN) + ce = self._color(self.RESET) + sys.stdout.write('%s[DRY]%s %s%s' % (cs, string, end, ce)) + + def raw(self, string, end='\n'): + sys.stdout.write('%s%s' % (string, end)) + + def ask(self, query): + cs = self._color(self.BLUE) + ce = self._color(self.RESET) + q = '%s%s%s' % (cs, query + ' [y/N] ? ', ce) + r = input(q) + return r == 'y' + + def _color(self, col): + if not sys.stdout.isatty(): + return '' + return col diff --git a/dotdrop/templategen.py b/dotdrop/templategen.py new file mode 100644 index 0000000..229d085 --- /dev/null +++ b/dotdrop/templategen.py @@ -0,0 +1,56 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +jinja2 template generator +""" + +import os +import utils +from jinja2 import Environment, Template, FileSystemLoader + +BLOCK_START = '{%@@' +BLOCK_END = '@@%}' +VAR_START = '{{@@' +VAR_END = '@@}}' +COMMENT_START = '{#@@' +COMMENT_END = '@@#}' + + +class Templategen: + + def __init__(self, base='.'): + self.base = base + loader = FileSystemLoader(self.base) + self.env = Environment(loader=loader, + trim_blocks=True, lstrip_blocks=True, + keep_trailing_newline=True, + block_start_string=BLOCK_START, + block_end_string=BLOCK_END, + variable_start_string=VAR_START, + variable_end_string=VAR_END, + comment_start_string=COMMENT_START, + comment_end_string=COMMENT_END) + + def generate(self, src, profile): + return self._handle_file(src, profile) + + def _handle_file(self, src, profile): + """ generate the file content from template """ + filetype = utils.run(['file', '-b', src], raw=False) + istext = 'text' in filetype + if not istext: + return self._handle_bin_file(src, profile) + return self._handle_text_file(src, profile) + + def _handle_text_file(self, src, profile): + l = len(self.base) + 1 + template = self.env.get_template(src[l:]) + content = template.render(profile=profile) + content = content.encode('UTF-8') + return content + + def _handle_bin_file(self, src, profile): + # this is dirty + if not src.startswith(self.base): + src = os.path.join(self.base, src) + with open(src, 'rb') as f: + return f.read() diff --git a/dotdrop/utils.py b/dotdrop/utils.py new file mode 100644 index 0000000..5b75937 --- /dev/null +++ b/dotdrop/utils.py @@ -0,0 +1,29 @@ +""" +author: deadc0de6 (https://github.com/deadc0de6) +utilities +""" + +import subprocess +import tempfile +from logger import Logger + +LOG = Logger() + + +def run(cmd, log=False, raw=True): + """ expects a list """ + if log: + LOG.log('cmd: \"%s\"' % (' '.join(cmd))) + p = subprocess.Popen(cmd, shell=False, + stdout=subprocess.PIPE, stderr=subprocess.STDOUT) + if raw: + return p.stdout.readlines() + return ''.join([x.decode("utf-8") for x in p.stdout.readlines()]) + + +def diff(src, dst, log=False, raw=True): + return run(['diff', '-r', src, dst], log=log, raw=raw) + + +def get_tmpdir(): + return tempfile.mkdtemp(prefix='dotdrop-') diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6313638 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +Jinja2; python_version == '3.6' +docopt; python_version == '3.6' +PyYAML; python_version == '3.6'