diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README b/README new file mode 100644 index 0000000..2900f5d --- /dev/null +++ b/README @@ -0,0 +1,7 @@ +This is the common libvirt xml handling code for virtigo & virtigod + +This is used to import libvirt xml files (as used by virsh) and +save the information in a protocol buffer config file. + +It re-creates the xml files needed for virsh on the hypervisor +and starts the vm with 'virsh create' diff --git a/addDroplet.go b/addDroplet.go new file mode 100644 index 0000000..092040a --- /dev/null +++ b/addDroplet.go @@ -0,0 +1,390 @@ +// Copyright 2024 WIT.COM Inc Licensed GPL 3.0 + +package virtigoxml + +import ( + "encoding/xml" + "errors" + "fmt" + + "github.com/google/uuid" + "go.wit.com/log" + "libvirt.org/go/libvirtxml" + pb "go.wit.com/lib/protobuf/virtbuf" +) + +// import a libvirt xml file +func AddDomainDroplet(cluster *pb.Cluster, domcfg *libvirtxml.Domain) (*pb.Droplet, []*pb.Event, error) { + var alle []*pb.Event + if domcfg == nil { + return nil, alle, errors.New("domcfg == nil") + } + + d, err := findDomain(cluster, domcfg) + if err != nil { + return nil, alle, err + } + if d == nil { + d = cluster.AddDroplet(domcfg.UUID, domcfg.Name, 2, 2*1024*1024) + d.StartState = pb.DropletState_OFF + d.CurrentState = pb.DropletState_UNKNOWN + + // if the domcfg doesn't have a uuid, make a new one here + if d.Uuid == "" { + u := uuid.New() + d.Uuid = u.String() + } + } + + alle, err = updateDroplet(cluster, d, domcfg) + if err != nil { + log.Info("updateDroplet() failed for", d.Hostname) + return d, alle, errors.New("update failed for " + domcfg.Name) + } + log.Info("added new droplet", domcfg.Name, domcfg.UUID) + DumpNonStandardXML(domcfg) + return d, alle, nil +} + +func findDomain(c *pb.Cluster, domcfg *libvirtxml.Domain) (*pb.Droplet, error) { + var found *pb.Droplet + if domcfg == nil { + return nil, errors.New("domcfg == nil") + } + + for _, d := range c.Droplets { + if d.Hostname == domcfg.Name { + if d.Uuid != domcfg.UUID { + if domcfg.UUID == "" { + // ignore blank or nonexistent UUID's + // todo: check to see if the uuid already exists ? + domcfg.UUID = d.Uuid + } else { + fmt.Println("Will Change UUID from", d.Uuid, "to", domcfg.UUID, "for hostname", d.Hostname) + d.Uuid = domcfg.UUID + } + } + if found == nil { + found = d + } else { + fmt.Println("FOUND TWICE", d.Uuid, domcfg.Name, domcfg.UUID) + return d, errors.New("Found Twice") + } + + } + if d.Uuid == domcfg.UUID { + if d.Hostname != domcfg.Name { + fmt.Println("protobuf has: UUID and Name:", d.Uuid, d.Hostname) + fmt.Println("libvirt has: UUID and Name:", domcfg.UUID, domcfg.Name) + fmt.Println("FOUND UUID WITH MIS-MATCHED NAME", domcfg.Name, domcfg.UUID) + return d, errors.New("UUID with mis-matched names") + } + } + } + + return found, nil +} + +func updateDroplet(cluster *pb.Cluster, d *pb.Droplet, domcfg *libvirtxml.Domain) ([]*pb.Event, error) { + var alle []*pb.Event + + if d == nil { + return alle, errors.New("d == nil") + } + if domcfg == nil { + return alle, errors.New("domcfg == nil") + } + + e, err := updateMemory(d, domcfg) + if err != nil { + log.Info("updateMemory() failed") + return alle, err + } + if e != nil { + alle = append(alle, e) + } + + // update arch & machine + if (domcfg.OS != nil) && (domcfg.OS.Type != nil) { + // OS Type: &{Arch:x86_64 Machine:pc-i440fx-5.2 Type:hvm} + t := domcfg.OS.Type + if d.QemuArch != t.Arch { + e := d.NewChangeEvent("Droplet.QemuArch", d.QemuArch, t.Arch) + alle = append(alle, e) + d.QemuArch = t.Arch + } + if d.QemuMachine != t.Machine { + e := d.NewChangeEvent("Droplet.QemuMachine", d.QemuMachine, t.Machine) + alle = append(alle, e) + d.QemuMachine = t.Machine + } + } + + // check cpus + if d.Cpus != int64(domcfg.VCPU.Value) { + // fmt.Printf("cpus changed. VCPU = %+v\n", domcfg.VCPU) + fmt.Printf("cpus changed. from %d to %d\n", d.Cpus, domcfg.VCPU.Value) + alle = append(alle, d.NewChangeEvent("Droplet.Cpus", d.Cpus, domcfg.VCPU.Value)) + d.Cpus = int64(domcfg.VCPU.Value) + } + + // update spice port + if domcfg.Devices.Graphics != nil { + for _, g := range domcfg.Devices.Graphics { + if g.Spice == nil { + continue + } + var s *libvirtxml.DomainGraphicSpice + s = g.Spice + // fmt.Printf("Spice: %d %+v %s\n", i, s, s.AutoPort) + if s.AutoPort == "yes" { + // should ignore either way + } else { + if d.SpicePort != int64(s.Port) { + // print out, but ignore the port number + d.SpicePort = int64(s.Port) + fmt.Printf("Spice Port set to = %d\n", s.Port) + alle = append(alle, d.NewChangeEvent("Droplet.SpicePort", d.SpicePort, s.Port)) + } + } + } + } + + // check type + if domcfg.Type != "kvm" { + fmt.Printf("not kvm. Virt type == %s\n", domcfg.Type) + return alle, errors.New("not kvm") + } + + nete, err := updateNetwork(cluster, d, domcfg) + if err != nil { + log.Info("updateNetwork() failed", err) + return alle, err + } + + for _, e := range nete { + alle = append(alle, e) + } + + nete, err = updateDisk(cluster, d, domcfg) + if err != nil { + return alle, err + } + + for _, e := range nete { + alle = append(alle, e) + } + + if alle == nil { + log.Info("libvirt xml import worked. nothing changed", domcfg.Name) + return alle, nil + } + log.Info("libvirt xml import worked. droplet changed", domcfg.Name) + + // append each change event + for _, e := range alle { + cluster.Events = append(cluster.Events, e) + } + return alle, nil +} + +// returns false if something went wrong +func updateMemory(d *pb.Droplet, domcfg *libvirtxml.Domain) (*pb.Event, error) { + if (d == nil) || (domcfg == nil) { + return nil, errors.New("domcfg == nil") + } + + if domcfg.Memory == nil { + // nothing to do. libvirt xml file didn't define memory size + return nil, nil + } + + var m int64 = 0 + switch domcfg.Memory.Unit { + case "KiB": + m = int64(domcfg.Memory.Value * 1024) + case "MiB": + m = int64(domcfg.Memory.Value * 1024 * 1024) + case "GiB": + m = int64(domcfg.Memory.Value * 1024 * 1024 * 1024) + default: + fmt.Println("Unknown Memory Unit", domcfg.Memory.Unit) + return nil, errors.New("Unknown Memory Unit " + domcfg.Memory.Unit) + } + e := d.SetMemory(m) + if e != nil { + fmt.Printf("Memory changed %s to %d %s\n", pb.HumanFormatBytes(d.Memory), domcfg.Memory.Value, domcfg.Memory.Unit) + d.Memory = m + } + return e, nil +} + +func updateNetwork(cluster *pb.Cluster, d *pb.Droplet, domcfg *libvirtxml.Domain) ([]*pb.Event, error) { + var allEvents []*pb.Event + if (d == nil) || (domcfg == nil) { + return nil, errors.New("domcfg == nil") + } + + // mac address & bridge name + var macs map[string]string + macs = make(map[string]string) + // Iterate over the network interfaces and print the MAC addresses + for _, iface := range domcfg.Devices.Interfaces { + var hwaddr string + var brname string + // fmt.Printf("iface: %+v\n", iface) + // fmt.Printf("MAC: %+v\n", iface.MAC) + // fmt.Printf("Source: %+v\n", iface.Source) + // fmt.Printf("Bridge: %+v\n", iface.Source.Bridge) + // fmt.Printf("Model: %+v\n", iface.Model) + if iface.MAC != nil { + // iface.MAC.Address = "aa:bb:aa:bb:aa:ff" + // log.Info("Interface:", iface.Target, "MAC Address:", iface.MAC.Address) + // fmt.Printf("source: %+v\n", iface.Source) + hwaddr = iface.MAC.Address + } + if iface.Source == nil { + // fmt.Printf("non-standard network: %+v\n", iface) + updatedXML, _ := xml.MarshalIndent(domcfg.Devices.Interfaces, "", " ") + log.Info("Non-Standard Network XML Start") + fmt.Println(string(updatedXML)) + log.Info("Non-Standard Network XML End") + return nil, errors.New("non-standard network. source == nil") + } + + if iface.Source.Bridge == nil { + if hwaddr == "" { + fmt.Printf("non-standard network: %+v\n", iface) + updatedXML, _ := xml.MarshalIndent(domcfg.Devices.Interfaces, "", " ") + log.Info("Non-Standard Network XML Start") + fmt.Println(string(updatedXML)) + log.Info("Non-Standard Network XML End") + return nil, errors.New("bridge is nil and no mac address") + } + brname = "" + } else { + if iface.Source.Bridge.Bridge == "" { + if hwaddr == "" { + fmt.Printf("non-standard network: %+v\n", iface) + fmt.Printf("iface.Mac: %+v\n", iface) + updatedXML, _ := xml.MarshalIndent(domcfg.Devices.Interfaces, "", " ") + log.Info("Non-Standard Network XML Start") + fmt.Println(string(updatedXML)) + log.Info("Non-Standard Network XML End") + return nil, errors.New("bridge is blank and no mac address") + } + brname = iface.Source.Bridge.Bridge + } + } + // log.Info("network has bridge:", iface.Source.Bridge.Bridge) + if hwaddr == "" { + hwaddr = "generate " + domcfg.Name + log.Info("need to generate mac addr for bridge:", brname) + // return nil, errors.New("need to generate mac addr for bridge: " + brname) + } + macs[hwaddr] = brname + } + + for mac, brname := range macs { + var found bool = false + // log.Info("XML has mac address:", mac, brname) + for _, eth := range d.Networks { + if eth.Mac == mac { + // log.Info("OKAY. FOUND ETH:", eth.Mac, eth.Name, brname) + found = true + if brname == "" { + // if new bridge name is blank, keep the old one + brname = eth.Name + } + if eth.Name != brname { + // if argv.IgnoreBr { + log.Info("network was:", eth.Mac, eth.Name) + log.Info("network now:", eth.Mac, brname) + log.Info("ignoring network change (--xml-ignore-net)") + // } else { + // return nil, errors.New("bridge name changed") + // } + } + } + } + if !found { + if CheckUniqueMac(cluster, mac) { + } else { + log.Info("droplet", d.Hostname, "duplicate mac address", mac) + return nil, errors.New("duplicate mac address") + } + var eth *pb.Network + eth = new(pb.Network) + eth.Mac = mac + if brname == "" { + brname = "worldbr" + } + eth.Name = brname + d.Networks = append(d.Networks, eth) + allEvents = append(allEvents, d.NewChangeEvent("Droplet NewNetwork", "", mac+" "+brname)) + } + } + + log.Verbose("mac addrs:", macs) + return allEvents, nil +} + +/* from vm3-with-nvme-1.5GB-sec.xml + + + + + + +
+ +*/ + +// returns false if something went wrong +func updateDisk(cluster *pb.Cluster, d *pb.Droplet, domcfg *libvirtxml.Domain) ([]*pb.Event, error) { + var alle []*pb.Event + + if (d == nil) || (domcfg == nil) { + return nil, errors.New("domcfg == nil") + } + for _, disk := range domcfg.Devices.Disks { + var t *libvirtxml.DomainDiskSourceFile + t = disk.Source.File + if t == nil { + fmt.Println("disk.Source.File == nil") + continue + } + filename := t.File + if filename == "" { + fmt.Println("No disk source file found.") + continue + } + + e, err := insertFilename(cluster, d, filename) + if err != nil { + return alle, err + } + if e == nil { + continue + } + alle = append(alle, e) + + /* + var found bool = false + for _, disk := range d.Disks { + if disk.Filename == filename { + log.Verbose("OKAY. FOUND filename", filename) + found = true + } + } + if !found { + var disk *pb.Disk + disk = new(pb.Disk) + disk.Filename = filename + d.Disks = append(d.Disks, disk) + log.Info("New filename", filename) + } + */ + } + return alle, nil +} diff --git a/libvirtxml.go b/libvirtxml.go index d4ed5f8..88b1695 100644 --- a/libvirtxml.go +++ b/libvirtxml.go @@ -63,12 +63,12 @@ func setDiskFilename(domcfg *libvirtxml.Domain, filename string) { func AddDefaultXml(d *libvirtxml.Domain, filename string) error { /* - fullname := "resources/xml/" + filename + ".xml" - pfile, err := resources.ReadFile(fullname) - if err != nil { - log.Println("ERROR:", err) - return - } + fullname := "resources/xml/" + filename + ".xml" + pfile, err := resources.ReadFile(fullname) + if err != nil { + log.Println("ERROR:", err) + return + } */ err := d.Unmarshal(filename) @@ -215,8 +215,7 @@ func addEthernetTap(domcfg *libvirtxml.Domain, mac string) { who don't have bridge groups or proper cluster backend networking literally leaving this blank makes the interface 'tap0' */ - Target: &libvirtxml.DomainInterfaceTarget{ - }, + Target: &libvirtxml.DomainInterfaceTarget{}, } // Add the new disk to the domain configuration diff --git a/start.go b/start.go index 7586602..0672b38 100644 --- a/start.go +++ b/start.go @@ -9,25 +9,25 @@ import ( "libvirt.org/go/libvirtxml" - "go.wit.com/log" pb "go.wit.com/lib/protobuf/virtbuf" + "go.wit.com/log" ) // generate the XML for 'virsh create' func StartDropletXml(d *pb.Droplet, domcfg *libvirtxml.Domain, hostname string) { /* - if d == nil { - log.Info("droplet is nil") - os.Exit(0) - } - log.Info("start droplet here:", d.Hostname) - domcfg := &libvirtxml.Domain{} + if d == nil { + log.Info("droplet is nil") + os.Exit(0) + } + log.Info("start droplet here:", d.Hostname) + domcfg := &libvirtxml.Domain{} - addDefaultXml(domcfg, "standard.x86") - // addDefaultXml(domcfg, "memory") - // addDefaultXml(domcfg, "network") - addDefaultXml(domcfg, "spice") - addDefaultXml(domcfg, "qcow") + addDefaultXml(domcfg, "standard.x86") + // addDefaultXml(domcfg, "memory") + // addDefaultXml(domcfg, "network") + addDefaultXml(domcfg, "spice") + addDefaultXml(domcfg, "qcow") */ domcfg.Type = "kvm" diff --git a/validate.go b/validate.go new file mode 100644 index 0000000..979d201 --- /dev/null +++ b/validate.go @@ -0,0 +1,220 @@ +package virtigoxml + +/* + validate / sanity check / consistancy check the data + + here is some code to do smart things like: + + * check mac addresses are unique + * check uuid's are unique + * double check filenames are unique + * return a unique mac address + * return a unique uuid + +*/ + +import ( + "errors" + "os" + "path/filepath" + + "github.com/google/uuid" + + pb "go.wit.com/lib/protobuf/virtbuf" + "go.wit.com/log" +) + +// will make sure the mac address is unique +func CheckUniqueMac(cluster *pb.Cluster, mac string) bool { + for _, d := range cluster.Droplets { + for _, n := range d.Networks { + if n.Mac == mac { + log.Info("duplicate MAC", n.Mac, "in droplet", d.Hostname) + return false + } + } + } + return true +} + +// records all the known paths. this should go in the protobuf +func addClusterFilepath(cluster *pb.Cluster, dir string) *pb.Event { + var found bool = false + var e *pb.Event + for _, d := range cluster.Dirs { + if d == dir { + // found dir + found = true + break + } + } + if !found { + if dir != "." { + // make a new Add Event + e = pb.NewAddEvent(nil, "Add Cluster Directory", dir) + cluster.Dirs = append(cluster.Dirs, dir) + } + } + return e +} + +// returns the droplet using a filename +func lookupFilename(cluster *pb.Cluster, filename string) *pb.Droplet { + filebase := filepath.Base(filename) + + for _, d := range cluster.Droplets { + for _, disk := range d.Disks { + if filebase == disk.Filename { + return d + } + } + } + return nil +} + +func insertFilename(cluster *pb.Cluster, d *pb.Droplet, filename string) (*pb.Event, error) { + dupd := lookupFilename(cluster, filename) + if dupd != nil { + log.Info("file", filename, "already on droplet", dupd.Hostname) + log.Info("file", filename, "on new droplet", d.Hostname) + if os.Getenv("VIRTIGO_IGNORE_DISKDUP") == "" { + log.Info("duplicate disk names (--xml-ignore-disk to ignore)") + return nil, errors.New("duplicate disk names") + } else { + log.Info("ignore duplicate disk names (--xml-ignore-disk=true)") + } + } + filebase := filepath.Base(filename) + dir := filepath.Dir(filename) + for _, disk := range d.Disks { + if disk.Filename == filebase { + log.Info("already have disk", filename) + return nil, nil + } + } + // make a new Add Event + e := d.NewChangeEvent("Add Disk", "", filename) + + // add the disk protobuf entry + var disk *pb.Disk + disk = new(pb.Disk) + disk.Filename = filebase + disk.Filepath = dir + d.Disks = append(d.Disks, disk) + log.Info("New filename", filebase, dir) + return e, nil +} + +func checkUniqueFilenames(cluster *pb.Cluster) bool { + var ok bool = true + var disks map[string]string + disks = make(map[string]string) + + for _, d := range cluster.Droplets { + for _, disk := range d.Disks { + filename := disk.Filename + addClusterFilepath(cluster, disk.Filepath) + if _, ok := disks[filename]; ok { + /* + if argv.IgnDisk { + log.Info("ignore dup disk", filename, disks[filename], d.Hostname) + } else { + } + */ + log.Info("file", filename, "on droplet", disks[filename]) + log.Info("file", filename, "on droplet", d.Hostname) + log.Info("duplicate disk names (--xml-ignore-disk to ignore)") + ok = false + } + disks[filename] = d.Hostname + } + } + if ok { + log.Println("validated okay: no duplicate disk images") + } + return ok +} + +func checkDiskFilenames(cluster *pb.Cluster) []*pb.Event { + var alle []*pb.Event + + for _, d := range cluster.Droplets { + for _, disk := range d.Disks { + filename := disk.Filename + filebase := filepath.Base(filename) + dir := filepath.Dir(filename) + addClusterFilepath(cluster, dir) + if disk.Filename != filebase { + // update filename + e := d.NewChangeEvent("Disk.Filename", disk.Filename, filebase) + alle = append(alle, e) + disk.Filename = filebase + } + if dir == "." { + continue + } + if dir == "" { + continue + } + if disk.Filepath != dir { + // update filename + e := d.NewChangeEvent("Disk.Filepath", disk.Filepath, dir) + alle = append(alle, e) + disk.Filepath = dir + } + } + } + return alle +} + +func checkDroplets(cluster *pb.Cluster, dump bool) bool { + // uuid map to check for duplicates + var umap map[string]string + umap = make(map[string]string) + + // mac address map to check for duplicates + var macs map[string]string + macs = make(map[string]string) + + for _, d := range cluster.Droplets { + // Generate a new UUID + if d.Uuid == "" { + u := uuid.New() + d.Uuid = u.String() + } + + // seconds, ok := timeZone[tz]; ok { + if _, ok := umap[d.Uuid]; ok { + // UUID already exists + log.Info("duplicate UUID", d.Uuid, umap[d.Uuid]) + log.Info("duplicate UUID", d.Uuid, d.Hostname) + os.Exit(-1) + } + umap[d.Uuid] = d.Hostname + + for _, n := range d.Networks { + // log.Println("network:", n.Mac, d.Uuid, d.Hostname) + if _, ok := macs[n.Mac]; ok { + // UUID already exists + log.Info("duplicate MAC", n.Mac, macs[n.Mac], umap[macs[n.Mac]]) + log.Info("duplicate MAC", n.Mac, d.Hostname) + os.Exit(-1) + } + macs[n.Mac] = d.Uuid + } + } + log.Println("validated okay: no duplicate MAC addr") + log.Println("validated okay: no duplicate UUID") + + if dump { + for u, hostname := range umap { + log.Println("uuid:", u, "hostname:", hostname) + } + + for mac, uuid := range macs { + log.Println("mac:", mac, "uuid", uuid, "hostname:", umap[uuid]) + } + } + + return false +}