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/bin/licenser.py b/bin/licenser.py
index e6acda9..1d3c421 100755
--- a/bin/licenser.py
+++ b/bin/licenser.py
@@ -1,123 +1,132 @@
#! /usr/bin/env python3
# -*- coding: utf-8 -*-
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
+
import argparse
import datetime as dt
import sys
import pylicenser as pylic
def mkdate(datestring):
return dt.datetime.strptime(datestring, '%Y-%m-%d').date()
if __name__ == "__main__":
parser = argparse.ArgumentParser(prog='licenser', add_help=True)
parser.add_argument("-i,--input",
help="Filename to check",
dest="filename",
default=None)
parser.add_argument("-f,--file_list",
help="File containing a list of files",
dest="file_list",
default=None)
parser.add_argument("--repo",
help="Repository to consider",
dest="repo",
default=None)
parser.add_argument("-p,--path",
help="Folder where to find the files",
dest="path",
default="")
parser.add_argument("-s,--skip-first",
help="Skip the first files when using the -f option",
dest="skip_first",
type=int,
default=0)
parser.add_argument("-v,--versioning-backend",
dest="vc_backend",
help="Backend used as versioning system (svn, git, none)")
parser.add_argument("configuration_file",
help="File containing the configuration, .csv or .db (sqlite)")
parser.add_argument("-r,--release-date",
help="Date at which the release is prepared",
dest='release_date',
type=mkdate,
default=dt.datetime.now().date())
parser.add_argument("-a,--no-author-check",
help="Do not check the author list",
dest="no_author_check",
action='store_true',
default=False)
parser.add_argument("-b,--no-brief-check",
help="Do not check the brief",
dest="no_brief_check",
action='store_true',
default=False)
parser.add_argument("--ignore-threshold",
help="Limit of number of line to consider an author from the VC system",
dest="ignore_threshold",
type=int,
default=0)
parser.add_argument("--ignore-filled-briefs",
help="Do not check the brief if they are not empty",
dest="ignore_filled_briefs",
action='store_true',
default=False)
parser.add_argument("--dry-run",
help="Do nothing for real",
dest='dry_run',
action='store_true',
default=False)
parser.add_argument("-l,--force-license",
help="Force a give license",
dest="force_license",
default=None)
args = parser.parse_args()
if (args.filename is None) and (args.file_list is None):
print("You should at least give a filename or a file_list")
parser.print_help()
sys.exit(-1)
if (args.filename is not None) and (args.file_list is not None):
print("You should give only on of the option filename or file_list")
parser.print_help()
sys.exit(-1)
file_list = []
if args.filename is not None:
file_list.append(args.filename)
if args.file_list is not None:
with open(args.file_list, "r") as fh:
file_list = [l.strip() for l in fh]
db = pylic.LicenserDB(args.configuration_file)
c = 0
t = len(file_list)
_kwargs = vars(args)
_kwargs.pop("filename", None)
for f in file_list:
c += 1
print(
"[{0:>3}%]({2:>3}/{3}) {1}".format(int(float(c) / t * 100), pylic.print_colored(f, attrs=['bold']), c, t)),
if c <= args.skip_first:
print(pylic.print_colored(" Skipped", attrs=['bold']))
continue
else:
print("")
if not args.path == "":
path = args.path.rstrip("/") + "/"
else:
path = ""
ft = pylic.FileTransformer(path + f, db,
**_kwargs)
ft.replace_file(args.dry_run)
diff --git a/pylicenser/author_db.py b/pylicenser/author_db.py
index 8595539..4e2bef4 100755
--- a/pylicenser/author_db.py
+++ b/pylicenser/author_db.py
@@ -1,61 +1,69 @@
from . import export
from .licenser_db import Author, licenser_ask_question
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
@export
class AuthorDB:
def __init__(self, db):
self.__db = db
self._authors = db.authors
__EMAIL = 0
__USERNAME = 1
def __add_missing_author(self, key, key_type):
print(
"The author identified by the key \'{0}\' is not know please enter the information for this author.".format(
key))
ans = False
auth = {'first_name': '', 'last_name': '',
'e_mail': '', 'user_name': ''}
while not ans:
answer = input("First name [{0}]: ".format(auth['first_name']))
auth['first_name'] = answer if not answer == '' else auth['first_name']
answer = input("Last name [{0}]: ".format(auth['last_name']))
auth['last_name'] = answer if not answer == '' else auth['last_name']
if key_type == self.__EMAIL:
answer = input("Username [{0}]: ".format(auth['user_name']))
auth['user_name'] = answer if not answer == '' else auth['user_name']
auth['e_mail'] = key
else:
auth['user_name'] = key
answer = input("E-Mail [{0}]: ".format(auth['e_mail']))
auth['e_mail'] = answer if not answer == '' else auth['e_mail']
print('\nFirst name: {0}\nLast name: {1}\nUsername: {2}\nE-Mail: {3}'.format(auth['first_name'],
auth['last_name'],
auth['user_name'],
auth['e_mail']))
ans = licenser_ask_question("Are this information correct")
if ans:
auth = Author(auth['user_name'], auth['e_mail'], auth['last_name'], auth['first_name'])
self.__db.add_author(auth)
self._authors.append(auth)
return auth
def is_author_in_ignore_list(self, author):
return self.__db.is_author_in_ignore_list(author)
def find_by_user_name(self, user_name):
find = [author for author in self._authors if author.user_name == user_name]
if len(find) == 0:
find.append(self.__add_missing_author(user_name, self.__USERNAME))
return find[0]
def find_by_email(self, e_mail):
find = [author for author in self._authors
if author.e_mail == e_mail]
if len(find) == 0:
find.append(self.__add_missing_author(e_mail, self.__EMAIL))
return find[0]
diff --git a/pylicenser/copyright_db.py b/pylicenser/copyright_db.py
index 2906912..e1c8c6f 100755
--- a/pylicenser/copyright_db.py
+++ b/pylicenser/copyright_db.py
@@ -1,30 +1,39 @@
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
+
from . import export
from datetime import datetime as dt
@export
class CopyrightDB:
def __init__(self, db):
self.__db = db
self._copyrights = self.__db.copyrights
def find_by_id(self, lid):
find = [copy for copy in self._copyrights
if copy.lid == lid]
if find:
return find[0]
else:
return None
def find_by_date(self, date):
if type(date) == str:
date = dt.strptime(date, "%d-%m-%Y")
elif type(date) == float:
date = dt.fromtimestamp(date)
find = [copy for copy in self._copyrights
if copy.start < date <= copy.end]
if find:
return find[0]
else:
return None
diff --git a/pylicenser/file_info.py b/pylicenser/file_info.py
index 77cedd8..4efaad2 100755
--- a/pylicenser/file_info.py
+++ b/pylicenser/file_info.py
@@ -1,256 +1,264 @@
# -*- coding: utf-8 -*-
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
import os
import re
from datetime import datetime as dt
from . import export
UNKNOWN_TYPE = 0
CPP_SOURCES = 1
CMAKE_FILES = 2
CREATION_MODIFICATION = 0
LAST_MODIFICATION = 1
CREATION = 2
@export
class FileInfo:
__date_style_conv = {'creation_modification': CREATION_MODIFICATION,
'last_modification': LAST_MODIFICATION,
'creation': CREATION}
__supported_ext = []
__supported_types = {CPP_SOURCES: [".cc", ".c", ".hh", ".h"],
CMAKE_FILES: [".txt", ".cmake"]}
_file_type = UNKNOWN_TYPE
_file_content = ""
_warn_list = list()
_brief = ""
_sections = list()
_authors = set()
_header = ""
def __init__(self, filename, author_db):
self._warn_list = list()
self._sections = list()
self._authors = set()
self._author_db = author_db
self._filename = os.path.expanduser(filename)
garbage, self._ext = os.path.splitext(os.path.basename(filename))
if self._ext == '.in':
self._ext = os.path.splitext(garbage)[1]
for key, value in self.__supported_types.items():
self.__supported_ext.extend(value)
if self._ext not in self.__supported_ext:
raise (Exception("File {0} has been skipped based on its extension".format(self._filename)))
for key, value in self.__supported_types.items():
if self._ext in value:
self._file_type = key
self.__analyse_content()
def __analyse_content(self):
with open(self._filename) as f:
self._file_content = f.read()
try:
self.__split_header()
except Exception as error:
raise Exception("While dealing with file {0}:\n{1}".format(self._filename, error))
self.__find_authors()
self.__find_brief()
self.__save_sections()
if self._warn_list:
print("\nWARNING!:")
print(" While dealing with file {0}".format(self._filename))
print(" the following shit happened:")
[print(" {0}".format(warning)) for warning in self._warn_list]
print("{0}:1:".format(self._filename))
def __save_sections(self):
reg = re.compile('^(.*@section)', re.MULTILINE)
pref = re.search(reg, self._header)
pref = pref.group(1) if pref is not None else ""
reg = re.compile('^.*@section', re.MULTILINE)
licreg = re.compile('LICEN.E')
for section in re.split(reg, self._header)[1:]:
if not re.search(licreg, section.split('\n')[0]):
self._sections.append(pref + section)
def __split_header(self):
if not re.search("Copyright", self._file_content):
self._header = ""
self._body = self._file_content
print("This file as no header or a really badly formatted one!!")
else:
if self._file_type == CPP_SOURCES:
self._header, self._body = re.split("\*/", self._file_content, maxsplit=1)
self._header = '\n'.join((line for line in self._header.split('\n') if line.strip()))
elif self._file_type == CMAKE_FILES:
lines = self._file_content.split('\n')
nb_sep = 0
nb_whitelines = 0
header_lines = list()
while nb_sep < 2:
if lines[0].strip().startswith('#===='):
nb_sep += 1
elif not lines[0].strip():
nb_whitelines += 1
header_lines.append(lines.pop(0))
if nb_whitelines > 0:
self._warn_list.append("The header has a blank line or is ill-formed")
self._header = "\n".join(header_lines)
self._body = "\n".join(lines)
def __find_authors(self):
reg = re.compile(
'@author\s+(.*)\s([a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4})',
re.IGNORECASE)
for match in re.finditer(reg, self._header):
auth = self._author_db.find_by_email(match.group(2))
if not self._author_db.is_author_in_ignore_list(auth):
self._authors.add(auth)
def __find_brief(self):
if self._file_type == CPP_SOURCES:
prefix = " *"
elif self._file_type == CMAKE_FILES:
prefix = "#"
else:
raise IOError("file type unknown")
reg = re.compile(
'@brief(.*?)^ ?\S\s+@', re.MULTILINE | re.DOTALL)
matches = [match for match in re.finditer(reg, self._header)]
if len(matches) == 0:
self._brief = ""
return
if len(matches) > 1:
self._warn_list.append("There's multiple @brief")
self._brief = "\n".join((line.replace(prefix, "").strip() for line in
matches[0].group(1).split('\n')
if len(line.strip()) > 1))
def generate_header(self,
real_authors=None,
copyright_txt="",
creation_date=None,
last_modification_date=None,
date_style=CREATION_MODIFICATION,
date_format="%a %b %d %H:%M:%S %Y",
brief=None):
if type(date_style) == str:
# noinspection PyTypeChecker
date_style = self.__date_style_conv[date_style]
if self._file_type == CPP_SOURCES:
starter = "/**"
prefix = " *"
closer = " */"
force_closer = True
elif self._file_type == CMAKE_FILES:
starter = "#==============================================================================="
prefix = "#"
closer = "#==============================================================================="
force_closer = False
else:
raise IOError("file type not recognized")
if real_authors is None:
real_authors = self._authors
new_lines = list()
new_lines.append(starter)
# file name
new_lines.append(prefix + " @file " + os.path.basename(self._filename))
new_lines.append(prefix)
# authors
for author in real_authors:
new_lines.append('{0} @author {1.first_name} {1.last_name} <{1.e_mail}>'.format(prefix, author))
new_lines.append(prefix)
# date
if date_style == CREATION_MODIFICATION and creation_date is not None and last_modification_date is not None:
new_lines.append(
"{0} @date creation: {1}".format(prefix, dt.fromtimestamp(creation_date).strftime(date_format)))
new_lines.append("{0} @date last modification: {1}".format(prefix, dt.fromtimestamp(
last_modification_date).strftime(date_format)))
elif date_style == LAST_MODIFICATION and last_modification_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(last_modification_date).strftime(date_format)))
elif date_style == CREATION and creation_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(creation_date).strftime(date_format)))
elif date_style == LAST_MODIFICATION and last_modification_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(last_modification_date).strftime(date_format)))
elif date_style == CREATION and creation_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(creation_date).strftime(date_format)))
new_lines.append(prefix)
# brief
brief_list = (self._brief
if brief is None else brief).split("\n")
pref_join = ("\n{0} ".format(prefix))
new_lines.append('{0} @brief {1}'.format(prefix, pref_join.join([b for b in brief_list])))
new_lines.append(prefix)
# license
new_lines.append(prefix + " @section LICENSE")
new_lines.append(prefix)
for line in copyright_txt.split("\n"):
new_lines.append('{0}{1}{2}'.format(prefix, " " if line else "", line))
new_lines.append(prefix)
# sections
for section in self._sections:
new_lines += section.split('\n')
if force_closer or not self._sections:
new_lines.append(closer)
return '\n'.join(new_lines)
def get_brief(self):
return self._brief
def replace_file(self, new_header=None):
if new_header is None:
new_header = self._header
body = self._body.split("\n")
while body and not body[0].strip():
body.pop(0)
new_file = (new_header + '\n\n' +
'\n'.join(body))
with open(self._filename, "w") as fh:
print(new_file, file=fh, end='')
@property
def authors(self):
return self._authors
diff --git a/pylicenser/file_transformer.py b/pylicenser/file_transformer.py
index 02631d6..4a72531 100755
--- a/pylicenser/file_transformer.py
+++ b/pylicenser/file_transformer.py
@@ -1,222 +1,230 @@
# -*- coding: utf-8 -*-
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
import datetime as dt
from . import author_db as adb
from . import copyright_db as cdb
from . import export
from . import file_info as fi
from . import licenser_db as ldb
from . import print_colored
from . import version_info as vc
@export
class FileTransformer(object):
"""
Class that reformat the headers
"""
__ignore = False
_new_header = None
def __init__(self, filename, db,
release_date=dt.datetime.now().date(),
no_author_check=False,
no_brief_check=False, **kwargs):
self.__filename = filename
self.__release_date = release_date
self.__db = db
if "vc_backend" in kwargs and kwargs["vc_backend"] is not None:
vc_back = kwargs["vc_backend"]
else:
vc_back = db.versioning_backend
if vc_back != "none":
self._date_style = self.__db.get_config('date_style'),
self.__repo = self.__db.get_config('repo')
self._vc_info = vc.VersionInfo(self.__repo, self.__filename,
backend=vc_back,
rev_to=release_date)
self.__name = self._vc_info.name
self.__filename = self.__repo + '/' + self.__name
self._creation_date = self._vc_info.creation_date
self._last_modif = self._vc_info.last_modification_date
else:
self._creation_date = None
self._last_modif = None
self._date_style = None
self._vc_info = None
# Check the authors
self.__author_db = adb.AuthorDB(db)
self._file = fi.FileInfo(self.__filename, self.__author_db)
rev_from = None
license_id = None
file_maj = None
if vc_back != "none":
file_maj = self.__db.find_file(self._vc_info.oldest_name)
if file_maj is not None:
rev_from, license_id = file_maj
if rev_from.date() >= release_date:
print("File {0} ignored due to recent modifications ({1})".format(self._vc_info.getName(),
print_colored(
rev_from.strftime(
"%Y-%m-%d"),
'red', attrs=['bold'])))
self.__ignore = True
if not no_author_check:
self._vc_authors = self._vc_info.authors
self._vc_info.populate(self.__author_db,
rev_to=self.__release_date,
rev_from=rev_from)
self._vc_authors = self._vc_info.authors
self._f_authors = self._file.authors
self._real_authors = self.__compare_authors(self._f_authors,
self._vc_authors,
file_is_good=(file_maj is not None))
if self._real_authors - self._f_authors:
print("Added authors:\n{0}".format(
"\n".join([" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author)
for author in self._real_authors - self._f_authors])))
if self._f_authors - self._real_authors:
print("Removed authors:\n{0}".format(
"\n".join([" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author)
for author in self._f_authors - self._real_authors])))
else:
self._real_authors = self._file.authors
# Check the brief
if not no_brief_check:
self.__check_brief()
else:
self._brief = self._file.get_brief()
if "force_license" in kwargs:
license_id = kwargs["force_license"]
# Getting the license content
self.__copyright_base = cdb.CopyrightDB(db)
if license_id is None:
copyright_policy = self.__db.get_config('copyright_policy')
if copyright_policy == 'creation_date':
cdate = self._creation_date
elif copyright_policy == 'release_date':
cdate = self.__release_date
else:
cdate = None
self._lic = self.__copyright_base.find_by_date(cdate)
else:
self._lic = self.__copyright_base.find_by_id(license_id)
if self._lic is None:
raise ("The license with the id {0} is not defined".format(license_id))
# Generates the new header file
self._new_header = self._file.generate_header(
real_authors=self._real_authors,
copyright_txt=self._lic.text,
date_format=self.__db.get_config('date_format'),
date_style=self._date_style,
last_modification_date=self._last_modif,
creation_date=self._creation_date,
brief=self._brief)
# noinspection PyPep8Naming
def __compare_authors(self, file_known_tmp, vc_known, file_is_good=False,
ignore_threshold=0):
file_known = file_known_tmp
if len(file_known) == 0 and len(vc_known) == 1:
file_known = vc_known
if not file_is_good:
file_only = file_known - vc_known
to_remove = set()
if file_only:
KEEP = 0
REMOVE = 1
for author in file_only:
answer = ldb.licenser_ask_question(
"Do you want to remove" +
" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author),
{'k': KEEP, 'r': REMOVE}, 'k')
if answer == REMOVE:
to_remove.add(author)
file_known = file_known - to_remove
vc_only = vc_known - file_known
if vc_only:
to_add = set()
YES = 0
NO = 1
DIFF = 2
for author in vc_only:
modifications = self._vc_info.modifications_by_author(author.user_name)
number_of_modified_lines = sum([len(e[2]) for e in modifications])
number_of_modifications = len(modifications)
if number_of_modified_lines <= ignore_threshold:
print('Potential new author' +
' @author {0.first_name} {0.last_name} <{0.e_mail}> '.format(author) +
'({0} modifications, lines count {1}) {2}'.format(number_of_modifications,
number_of_modified_lines,
print_colored("[ignored do to threshold]",
'red', attrs=['bold'])))
continue
answer = DIFF
while answer == DIFF:
answer = ldb.licenser_ask_question(
'Do you want to add' +
' @author {0.first_name} {0.last_name} <{0.e_mail}> '.format(author) +
'({0} modifications, lines count {1}) '.format(number_of_modifications,
number_of_modified_lines),
{'d': DIFF, 'n': NO, 'y': YES}, 'n')
if answer == DIFF:
for info, modif, nb_lines in modifications:
print(info)
print(modif)
elif answer == YES:
to_add.add(author)
file_known = file_known.union(to_add)
return file_known
def __check_brief(self, ignore_filled_briefs=False):
self._brief = self._file.get_brief()
if self._brief and not ignore_filled_briefs:
keep_brief = ldb.licenser_ask_question("\"{0}\"\nDo you want to keep this brief".format(self._brief))
if not keep_brief:
self._brief = False
if not self._brief:
res = input("Please type the brief for file: ")
brief = []
while res is not "":
brief.append(res)
res = input("> ")
self._brief = "\n".join(brief)
def replace_file(self, dry_run=True):
if self.__ignore:
return
if dry_run:
print(self._new_header)
else:
if self._vc_info is not None:
self.__db.update_file(self._vc_info.oldest_name(), self._lic.lid, self.__release_date)
self._file.replace_file(self._new_header)
diff --git a/pylicenser/licenser_db.py b/pylicenser/licenser_db.py
index be822a8..4ae4fb8 100755
--- a/pylicenser/licenser_db.py
+++ b/pylicenser/licenser_db.py
@@ -1,254 +1,262 @@
# -*- coding: utf-8 -*-
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
from . import export
import sqlite3 as lite
from collections import namedtuple
from datetime import datetime as dt
import os
Author = namedtuple('Author', 'user_name, e_mail, last_name, first_name')
CopyRight = namedtuple('CopyRight', ['lid', 'on_modifications_txt', 'start', 'end', 'text'])
SQLITE = 0
CSV = 1
def licenser_ask_question(question, possible_answer=None, default='y'):
if possible_answer is None:
possible_answer = {'y': True, 'n': False}
answers = '/'.join([k if not k == default else k.upper() for k in possible_answer.keys()])
answer = None
while answer not in possible_answer.keys():
answer = input('{0} ({1})? '.format(question, answers))
answer = answer.lower()
if answer == '':
return possible_answer[default]
# if answer in possible_answer.keys():
return possible_answer[answer]
# raise(Exception("\'{0}\' is not a valid answer to the question!".format(answer)))
@export
class LicenserDB:
_project = ""
_versioning_backend = "svn"
_configs = {
'project': "",
'versioning_backend': 'svn',
'date_format': "%a %b %d %H:%M:%S %Y",
'date_style': 'last_modification',
'copyright_policy': 'creation_date'
}
def __new__(cls, filename, backend=None):
"""
Factory constructor depending on the chosen backend
"""
if backend is None:
_filepath = os.path.expanduser(filename)
garbage, ext = os.path.splitext(os.path.basename(_filepath))
if ext == ".csv":
backend = CSV
elif ext == ".db":
backend = SQLITE
else:
raise (Exception("Unknown file format"))
if backend == SQLITE:
obj = super().__new__(LicenserSQLITEDB)
elif backend == CSV:
obj = super().__new__(LicenserCSVDB)
else:
raise (Exception("Not a known backend"))
return obj
@property
def authors(self):
return None
def add_author(self, author):
pass
@property
def copyrights(self):
return None
@property
def project(self):
return self._configs['project']
@property
def versioning_backend(self):
return self._configs['versioning_backend']
def get_config(self, conf):
return self._configs[conf] if conf in self._configs else None
def find_file(self, name):
return None
def update_file(self, filename, license_id, update=dt.now().date()):
pass
def is_author_in_ignore_list(self, author):
return False
@export
class LicenserSQLITEDB(LicenserDB):
# noinspection PyTypeChecker
def __init__(self, filename):
self.__connection = lite.connect(filename)
self.__connection.row_factory = lite.Row
self.__cursor = self.__connection.cursor()
with self.__connection:
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'config' ''' +
''' ('property' TEXT, 'value' TEXT)''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'authors' ''' +
''' ('uid' TEXT, 'last_name' TEXT, 'first_name' TEXT, 'email' TEXT)''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'authors_ignore_list' ''' +
''' ('uid' TEXT)''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'copyrights' ''' +
''' ('lid' TEXT, 'from' TEXT, 'to' TEXT, 'on_modifications_txt', 'text' BLOB)''')
self.__cursor.execute(
'''CREATE TABLE IF NOT EXISTS 'files' ''' +
''' ('filename' TEXT, 'last_modif' TEXT, 'license_id' TEXT,''' +
''' PRIMARY KEY('filename'))''')
self.__cursor.execute('''SELECT * FROM 'config' AS c''')
properties = self.__cursor.fetchall()
for prop in properties:
_property = prop['property']
self._configs[_property] = prop['value']
@property
def authors(self):
with self.__connection:
self.__cursor.execute(
'''SELECT a.'uid', a.'email', a.'last_name', a.'first_name' ''' +
''' FROM 'authors' AS a''')
authors = self.__cursor.fetchall()
return [Author(*[str(e) for e in author]) for author in authors]
def is_author_in_ignore_list(self, author):
with self.__connection:
self.__cursor.execute(
'''SELECT a.'uid' ''' +
''' FROM 'authors_ignore_list' AS a''' +
''' WHERE a.'uid' = :uid''',
{"uid": author.user_name})
authors = self.__cursor.fetchall()
return len(authors) > 0
def add_author(self, author):
with self.__connection:
self.__cursor.execute(
'''INSERT INTO 'authors' ('uid', 'first_name', 'last_name', 'email')''' +
'''VALUES (:uid, :first_name, :last_name, :email)''',
{'uid': str(author.user_name),
'last_name': str(author.last_name),
'first_name': str(author.first_name),
'email': str(author.e_mail)})
# noinspection PyTypeChecker
@property
def copyrights(self):
with self.__connection:
self.__cursor.execute(
'''SELECT c.'lid', c.'on_modifications_txt', c.'from', c.'to', c.'text' ''' +
''' FROM 'copyrights' AS c''')
copyrights = self.__cursor.fetchall()
return [CopyRight(copy['lid'],
str(copy['on_modifications_txt']),
dt.strptime(copy['from'], "%Y-%m-%d").date(),
dt.strptime(copy['to'], "%Y-%m-%d").date(),
str(copy['text'])) for copy in copyrights]
# noinspection PyTypeChecker
def find_file(self, filename):
with self.__connection:
self.__cursor.execute(
'''SELECT f.'last_modif', f.'license_id' ''' +
''' FROM 'files' AS f WHERE f.'filename'=:filename''',
{'filename': filename})
res = self.__cursor.fetchone()
if res is not None:
return [dt.strptime(res['last_modif'], "%Y-%m-%d"), res['license_id']]
def update_file(self, filename, license_id, update=dt.now().date()):
with self.__connection:
self.__cursor.execute(
'''INSERT OR REPLACE INTO 'files' ('filename', 'last_modif', 'license_id') ''' +
''' VALUES (:filename, :update, :license_id)''',
{'filename': filename,
'license_id': license_id,
'update': update.strftime("%Y-%m-%d")})
class LicenserCSVDB(LicenserDB):
__author_file = ''
__copyright_file = ''
__treated_files = dict()
# noinspection PyUnusedLocal
def __init__(self, filename, **kwargs):
self.__config_file = filename
with open(self.__config_file) as fh:
split_lines = [line.strip().split(';') for line in fh]
if len(split_lines) > 1:
raise (Exception("Too many lines in the configuration file"))
self._configs['project'], self.__author_file, self.__copyright_file, self._configs['versioning_backend'] = [
token.strip('"') for token in split_lines[0]]
with open('treated_files.list', 'r') as f:
for l in f:
f, date, lid = l.split(";")
f = f.strip()
date = dt.strptime(date, "%Y-%m-%d")
self.__treated_files[f] = [date, lid.strip()]
@property
def authors(self):
with open(self.__author_file) as fh:
next(fh)
split_lines = [line.strip().split(';') for line in fh]
return [Author._make((token.strip('"') for token in line)) for line in split_lines]
def add_author(self, author):
with open(self.__author_file, 'a') as fh:
fh.write(';'.join(['\"{0}\"'.format(val) for val in author]) + '\n')
def find_file(self, filename):
if filename in self.__treated_files:
return self.__treated_files[filename]
return None
def update_file(self, filename, license_id, update=dt.now().date()):
self.__treated_files[filename] = [update.strftime("%Y-%m-%d"), license_id]
with open('treated_files.list', 'w') as f:
f.write("\n".join([";".join(f) for f in self.__treated_files.items]))
@property
def copyrights(self):
with open(self.__copyright_file) as fh:
split_lines = [line.strip().split(';') for line in fh]
tab = ([[token.strip('"') for token in line] for line in split_lines])
return [CopyRight._make([lid,
on_modif,
dt.strptime(start, "%d-%m-%Y").date(),
dt.strptime(end, "%d-%m-%Y").date(),
"".join([line for line in open(license_file)])]) for
lid, on_modif, start, end, license_file in tab]
diff --git a/pylicenser/vcs/git.py b/pylicenser/vcs/git.py
index f187835..cedcbec 100644
--- a/pylicenser/vcs/git.py
+++ b/pylicenser/vcs/git.py
@@ -1,116 +1,124 @@
"""
Gather info for git based repos
"""
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
import git
import binascii
import datetime as dt
from .. import export
from .. import version_info
from .. import print_colored
@export
class GITInfo(version_info.VersionInfo):
"""
git implementation of the version info class
"""
__repo = None
__other_names = []
def __init__(self, repo, filename, rev_to=None, **kwargs):
super().__init__(repo, filename, **kwargs)
self.__repo = git.Repo(self._repo)
self._name = filename.replace(self._repo, '')
commits = self._list_commits(rev_to=rev_to)
self._modification_dates = [c.authored_date for c in commits]
self.__other_names = self._list_names(commits)
# noinspection PyIncorrectDocstring
def populate(self, author_db, rev_from=None, rev_to=None):
"""
populate the internal variables
"""
_commits = self._list_commits(rev_to=rev_to,
rev_from=rev_from)
for c in _commits:
email = c.author.email
a = author_db.find_by_email(email)
auth = a.user_name
if auth not in self._author_list:
self._author_list[auth] = []
if not author_db.is_author_in_ignore_list(a):
self._authors.add(a)
d = c.authored_date
rev = c.hexsha
msg = c.message
self._author_list[auth].append((d, rev, msg))
def get_modifications(self, revision):
hexsha = binascii.unhexlify(revision)
commit = git.objects.commit.Commit(self.__repo, hexsha)
diffs = commit.diff(commit.parents, R=True, create_patch=True, paths=[self.__other_names])
return '\n'.join((d.diff.decode('UTF-8') for d in diffs))
def modifications_by_author(self, author):
auth = self._author_list[author]
res = []
for d, r, msg in auth:
date = dt.datetime.fromtimestamp(d).strftime("%d-%m-%Y")
short_sha = self.__repo.git.rev_parse(r, short=1)
info = print_colored("@ {0} rev {1} msg {2}".format(date, r, msg), 'blue', attrs=['bold'])
modif = self.get_modifications(r)
res.append([info, modif, modif.split("\n")])
return res
def _list_commits(self, rev_to=None, rev_from=None):
_args = {'follow': True,
'all': True,
'pretty': 'tformat:%H'}
if rev_from is not None:
_args['since'] = rev_from
if rev_to is not None:
_args['until'] = rev_to
git_cmd = git.cmd.Git(working_dir=self.__repo.working_dir)
str_c = git_cmd.log(self._name, **_args)
binhashes = (binascii.unhexlify(c) for c in str_c.split('\n'))
list_commits = [git.objects.commit.Commit(self.__repo, b) for b in binhashes]
return list_commits
def _list_names(self, commits):
"""
Finds all the names of a given file
"""
names = [self._name]
for c in commits:
diffs = c.diff(c.parents,
R=True, M=True)
for d in diffs.iter_change_type('R'):
if d.renamed and d.rename_to in names:
new_path = d.rename_from
self._names[new_path] = c.hexsha
names.append(new_path)
if len(self._names.keys()) == 0:
c = commits[-1]
self._names[self._name] = c.hexsha
names.reverse()
return names
@property
def oldest_name(self):
return self.__other_names[0]
diff --git a/pylicenser/vcs/svn.py b/pylicenser/vcs/svn.py
index 97d02e2..e99fabf 100644
--- a/pylicenser/vcs/svn.py
+++ b/pylicenser/vcs/svn.py
@@ -1,122 +1,130 @@
"""
Gather info for subversion based repos
"""
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
from .. import export
import pysvn
import re
from .. import version_info
@export
class SVNInfo(version_info.VersionInfo):
"""
subversion implementation of the version info class
"""
def __init__(self, repo, filename, rev_to=None, **kwargs):
super().__init__(repo, filename, **kwargs)
self._client = pysvn.Client()
self._root_url = self._client.root_url_from_path(repo)
self._infos = self._client.info(self._filename)
if rev_to is not None:
rev_start = pysvn.Revision(pysvn.opt_revision_kind.date, rev_to.strftime('%s'))
else:
rev_start = pysvn.Revision(pysvn.opt_revision_kind.head)
self._name = self._infos.url.replace(self._root_url, '')
self._logs = self._client.log(self._filename,
strict_node_history=False,
discover_changed_paths=True,
revision_start=rev_start)
prev_name = self._name
self._logs = sorted(self._logs, key=lambda log: log["revision"].number, reverse=True)
for entry in self._logs:
d = entry["date"]
self._modification_dates.append(d)
# checking if the name as changed
old_names = [ ch_path for ch_path in entry["changed_paths"] if
(re.match("{0}.*".format(ch_path["path"]), prev_name)) ]
if len(old_names) > 0 and old_names[0]["copyfrom_path"] is not None:
m = re.match("{0}(.*)".format(old_names[0]["path"]), prev_name)
tmp_prev_name = prev_name
prev_name = "{0}{1}".format(old_names[0]["copyfrom_path"],
m.group(1) if m else "")
self._names[old_names[0]["copyfrom_revision"].number] = tmp_prev_name
self._names[0] = prev_name
# print("\n".join(["{0} {1}".format(n, r) for r, n in self._names.items() ]))
@property
def oldest_name(self):
return self._names[0]
def populate(self, author_db, rev_from=None, rev_to=None):
if rev_from is not None:
rev_end = pysvn.Revision(pysvn.opt_revision_kind.date, rev_from.strftime('%s'))
else:
rev_end = pysvn.Revision(pysvn.opt_revision_kind.number, 0)
if rev_to is not None:
rev_start = pysvn.Revision(pysvn.opt_revision_kind.date, rev_to.strftime('%s'))
else:
rev_start = pysvn.Revision(pysvn.opt_revision_kind.head)
self._logs = self._client.log(self._filename,
strict_node_history=False,
revision_start=rev_start,
revision_end=rev_end)
self._logs = sorted(self._logs, key=lambda log: log["revision"].number)
for entry in self._logs:
auth = entry["author"]
rev = entry["revision"]
d = entry["date"]
msg = entry["message"] if "message" in entry else ""
self._revisions.append(rev)
if auth not in self._author_list:
self._author_list[auth] = []
a = author_db.find_by_user_name(auth)
if not author_db.is_author_in_ignore_list(a):
self._authors.add(a)
self._author_list[auth].append((d, rev, msg))
def __find_previous_release(self, r):
revs = [ rev.number for rev in self._revisions if rev.number < r]
rev = 0 if len(revs) == 0 else max(revs)
return pysvn.Revision(pysvn.opt_revision_kind.number, rev)
def get_modifications(self, revision):
r_pre = pysvn.Revision(pysvn.opt_revision_kind.number, revision.number -1)
# self.__find_previous_release(revision.number)
relevant_rev = max([ n for n in self._names.keys() if revision.number > n ])
try:
# print("{0} r{1}:{2}".format(self._root_url + self._names[relevant_rev],
# r_pre.number,
# revision.number))
res_diff = self._client.diff("/tmp", self._root_url + self._names[relevant_rev],
revision1=r_pre,
revision2=revision,
diff_options=['-b', '-w'])
return res_diff
except Exception as e: pass
return ""
def modifications_by_author(self, author):
a = self._author_list[author]
res = []
for d, r, msg in a:
date = dt.datetime.fromtimestamp(d).strftime("%d-%m-%Y")
info = print_colored("@ {0} rev {1} msg {2}".format(date, r.number, msg), 'blue', attrs=['bold'])
modif = self.get_modifications(r)
res.append([info, modif, modif.split("\n")])
return res
\ No newline at end of file
diff --git a/pylicenser/version_info.py b/pylicenser/version_info.py
index adb35e2..36e4c2b 100755
--- a/pylicenser/version_info.py
+++ b/pylicenser/version_info.py
@@ -1,67 +1,75 @@
# -*- coding: utf-8 -*-
+__author__ = "Guillaume Anciaux, and Nicolas Richart"
+__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
+ "(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
+__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
+__license__ = "GPL"
+__version__ = "1.0"
+__maintainer__ = "Nicolas Richart"
+__email__ = "nicolas.richart@epfl.ch"
from . import export
import os
@export
class VersionInfo:
"""Generic class handling the communication with the versioning system"""
# members
_authors = set()
_author_list = dict()
_modification_dates = []
_name = ""
_repo = ""
_filename = ""
_revisions = []
_names = dict()
def __new__(cls, repo, filename, backend=None, **kwargs):
"""
Factory constructor depending on the chosen backend
"""
if backend == 'svn':
from .vcs import svn
return super().__new__(svn.SVNInfo)
elif backend == 'git':
from .vcs import git
return super().__new__(git.GITInfo)
else:
raise Exception("{0} not a known backend".format(backend))
# noinspection PyUnusedLocal
def __init__(self, repo, filename, **kwargs):
self._repo = os.path.expanduser(repo)
self._filename = os.path.expanduser(filename)
@property
def creation_date(self):
return min(self._modification_dates)
@property
def last_modification_date(self):
return max(self._modification_dates)
@property
def authors(self):
return self._authors
def number_of_modifications(self, author):
return len(self._author_list[author])
def modifications_by_author(self, author):
pass
@property
def name(self):
return self._name
@property
def oldest_name(self):
return self._name
def get_modifications(self, revision):
pass