diff --git a/COPYING b/COPYING new file mode 100644 --- /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/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,7 +1,18 @@ # dnf-repo releases +## 0.6 (2024-04-22) +- switch license from BSD to GPLv3+ +- add --only option to only --repo enable certain repos +- add --dnf4 switch to avoid dnf5 +- --add-copr: copr is now available while being added +- selectRepo: use left fold to not reverse order of repo actions +- normalize copr name internally +- error if /etc/yum.repo.d doesn't exist +- fix 0.5.6 regression: error again when no matching repo +- --list output now takes --only into account properly + ## 0.5.6 (2024-04-18) -- --add-copr now supports non-fedora copr's and downloads .repo with curl +- --add-copr now supports non-fedora copr servers and downloads .repo with curl - with --add-copr can override --osname OS and --releasever VERSION - use dnf5 if available - --expire now enables the repo for the invocation diff --git a/LICENSE b/LICENSE deleted file mode 100644 --- a/LICENSE +++ /dev/null @@ -1,30 +0,0 @@ -Copyright (c) 2022, Jens Petersen - -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above - copyright notice, this list of conditions and the following - disclaimer in the documentation and/or other materials provided - with the distribution. - - * Neither the name of Jens Petersen nor the names of other - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -14,29 +14,31 @@ Changes to repos' enabled states can be saved too. It is also possible to expire repo caches individually. -There are also smart options to enable/disable testing/modular repos -(and even source/debuginfo repos), and also to a Copr repo or Koji repo file. +There are also smart options to enable/disable testing repos +(and even source/debuginfo repos), +and also to add Copr repo or Koji repo file. ## Help `$ dnf-repo --version` ``` -0.5.6 +0.6 ``` `$ dnf-repo --help` ``` DNF wrapper repo tool Usage: dnf-repo [--version] [-n|--dryrun] [-q|--quiet] [-D|--debug] [-l|--list] - [-s|--save] [(-w|--weak-deps) | (-W|--no-weak-deps)] [--exact] + [-s|--save] [--dnf4] [(-w|--weak-deps) | (-W|--no-weak-deps)] + [--exact] [(-d|--disable REPOPAT) | (-e|--enable REPOPAT) | - (-x|--expire REPOPAT) | (-X|--clear-expires) | - (-E|--delete-repofile REPOPAT) | (-t|--enable-testing) | - (-T|--disable-testing) | (-m|--enable-modular) | - (-M|--disable-modular) | --enable-debuginfo | - --disable-debuginfo | --enable-source | --disable-source | - (-c|--add-copr COPR) [--osname OSNAME] - [--releasever RELEASEVER] | + (-o|--only REPOPAT) | (-x|--expire REPOPAT) | + (-X|--clear-expires) | (-E|--delete-repofile REPOPAT) | + (-t|--enable-testing) | (-T|--disable-testing) | + (-m|--enable-modular) | (-M|--disable-modular) | + --enable-debuginfo | --disable-debuginfo | --enable-source | + --disable-source | (-c|--add-copr [SERVER/]COPR/PROJECT) + [--osname OSNAME] [--releasever RELEASEVER] | (-k|--add-koji REPO) | (-u|--repourl URL)] [DNFARGS] see https://github.com/juhp/dnf-repo#readme @@ -49,11 +51,13 @@ -D,--debug Debug output -l,--list List all repos -s,--save Save the repo enable/disable state + --dnf4 Use dnf4 (if dnf5 available) -w,--weak-deps Use weak dependencies -W,--no-weak-deps Disable weak dependencies --exact Match repo names exactly -d,--disable REPOPAT Disable repos -e,--enable REPOPAT Enable repos + -o,--only REPOPAT Only use matching repos -x,--expire REPOPAT Expire repo cache -X,--clear-expires Undo cache expirations -E,--delete-repofile REPOPAT @@ -66,11 +70,13 @@ --disable-debuginfo Disable debuginfo repos --enable-source Enable source repos --disable-source Disable source repos - -c,--add-copr COPR Create repo file for copr repo + -c,--add-copr [SERVER/]COPR/PROJECT + Create repo file for copr repo (defaults to fedora + server) --osname OSNAME Specify OS Name to override (eg epel) --releasever RELEASEVER Specify OS Release Version to override (eg rawhide) - -k,--add-koji REPO Create repo file for koji repo (f40-build, rawhide, - epel9-build, etc) + -k,--add-koji REPO Create repo file for a Fedora koji repo (f40-build, + rawhide, epel9-build, etc) -u,--repourl URL Use temporary repo from a baseurl ``` @@ -115,6 +121,7 @@ ```shellsession $ dnf-repo --M -d h264 --save ``` +(All modular repos were dropped in Fedora 39.) ### Use only source repos ```shellsession @@ -151,6 +158,10 @@ An initial `^` (final `$`) in a glob pattern prevents the automatic prepending (appending) of `*` before (after) the pattern. +Repo actions expand to a sequence of `--enablerepo=`, `--disablerepo=`, +`--repo=`, etc, so as usual later settings will overrule conflicting +earlier settings. + ## Installation A copr repo is available: @@ -159,7 +170,7 @@ Use {cabal,stack,cabal-rpm} install. ## Contributing -dnf-repo is currently distributed under a BSD license. +dnf-repo is distributed under the GPL license version 3 or later. The source repository is https://github.com/juhp/dnf-repo/ diff --git a/dnf-repo.cabal b/dnf-repo.cabal --- a/dnf-repo.cabal +++ b/dnf-repo.cabal @@ -1,11 +1,11 @@ name: dnf-repo -version: 0.5.6 -synopsis: DNF wrapper tool to control repos +version: 0.6 +synopsis: A dnf wrapper with fine control of enabled repos description: A command-line wrapper of the dnf package manager to control the repos enabled for a dnf invocation. -license: BSD3 -license-file: LICENSE +license: GPL-3 +license-file: COPYING author: Jens Petersen maintainer: Jens Petersen copyright: 2022-2024 Jens Petersen @@ -21,7 +21,9 @@ || == 8.10.7 || == 9.0.2 || == 9.2.7 - || == 9.4.5 + || == 9.4.8 + || == 9.6.4 + || == 9.8.2 data-dir: data data-files: koji-REPO.repo @@ -33,6 +35,7 @@ main-is: Main.hs other-modules: Paths_dnf_repo ExpireRepos + State Sudo YumRepoFile autogen-modules: Paths_dnf_repo diff --git a/src/Main.hs b/src/Main.hs --- a/src/Main.hs +++ b/src/Main.hs @@ -9,12 +9,17 @@ import Data.Char (isDigit) import Data.List.Extra import Data.Maybe (isJust, mapMaybe, maybeToList) -import Network.Curl +import Network.Curl (curlGetString, CurlCode(CurlOK)) import Network.HTTP.Directory (httpExists', (+/+)) -import SimpleCmd +import SimpleCmd (cmd, cmdLines, cmdMaybe, error', grep, warning, (+-+), +#if MIN_VERSION_simple_cmd(0,2,4) + filesWithExtension +#endif + ) import SimpleCmdArgs import SimplePrompt (yesNo) -import System.Directory (doesFileExist, findExecutable, withCurrentDirectory, +import System.Directory (doesDirectoryExist, doesFileExist, findFile, + withCurrentDirectory, #if !MIN_VERSION_simple_cmd(0,2,4) listDirectory #endif @@ -27,6 +32,7 @@ import Paths_dnf_repo (getDataFileName, version) import ExpireRepos +import State import Sudo import YumRepoFile @@ -42,6 +48,7 @@ <*> switchWith 'D' "debug" "Debug output" <*> switchWith 'l' "list" "List all repos" <*> switchWith 's' "save" "Save the repo enable/disable state" + <*> switchLongWith "dnf4" "Use dnf4 (if dnf5 available)" <*> optional (flagWith' True 'w' "weak-deps" "Use weak dependencies" <|> flagWith' False 'W' "no-weak-deps" "Disable weak dependencies") <*> switchLongWith "exact" "Match repo names exactly" @@ -52,11 +59,17 @@ (fmap . fmap . fmap . fmap) cleanupReponame . strOptionWith where cleanupReponame = - dropWhileEnd (== '/') . dropWhile (== '/') . replace ":" "/" + -- FIXME handle copr url too + serverAliases . replace "@" "group_" . replace "/" ":" . dropWhileEnd (== '/') . dropWhile (== '/') + serverAliases ('r':'e':'d':'h':'a':'t':':':copr) = + "copr.devel.redhat.com:" ++ copr + serverAliases copr = copr + modeOpt = DisableRepo <$> repoOptionWith 'd' "disable" "REPOPAT" "Disable repos" <|> EnableRepo <$> repoOptionWith 'e' "enable" "REPOPAT" "Enable repos" <|> + OnlyRepo <$> repoOptionWith 'o' "only" "REPOPAT" "Only use matching repos" <|> ExpireRepo <$> repoOptionWith 'x' "expire" "REPOPAT" "Expire repo cache" <|> flagWith' ClearExpires 'X' "clear-expires" "Undo cache expirations" <|> DeleteRepo <$> repoOptionWith 'E' "delete-repofile" "REPOPAT" "Remove unwanted .repo file" <|> @@ -69,10 +82,10 @@ flagLongWith' (Specific EnableSource) "enable-source" "Enable source repos" <|> flagLongWith' (Specific DisableSource) "disable-source" "Disable source repos" <|> AddCopr - <$> repoOptionWith 'c' "add-copr" "COPR" "Create repo file for copr repo" + <$> repoOptionWith 'c' "add-copr" "[SERVER/]COPR/PROJECT" "Create repo file for copr repo (defaults to fedora server)" <*> optional (strOptionLongWith "osname" "OSNAME" "Specify OS Name to override (eg epel)") <*> optional (strOptionLongWith "releasever" "RELEASEVER" "Specify OS Release Version to override (eg rawhide)") <|> - AddKoji <$> repoOptionWith 'k' "add-koji" "REPO" "Create repo file for koji repo (f40-build, rawhide, epel9-build, etc)" <|> + AddKoji <$> repoOptionWith 'k' "add-koji" "REPO" "Create repo file for a Fedora koji repo (f40-build, rawhide, epel9-build, etc)" <|> RepoURL <$> strOptionWith 'u' "repourl" "URL" "Use temporary repo from a baseurl" fedoraCopr :: String @@ -81,25 +94,39 @@ kojiRepoTemplate :: FilePath kojiRepoTemplate = "koji-REPO.repo" +yumReposD :: String +yumReposD = "/etc/yum.repos.d" + +checkSystemPathFile :: String -> IO (Maybe String) +checkSystemPathFile prog = do + let path = splitOn ":" "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin" + fmap takeFileName <$> findFile path prog + -- FIXME both enabling and disabled at the same time --- FIXME --enable-all-coprs (for updating etc) -- FIXME confirm repos if many -- FIXME --disable-non-cores (modular,testing,cisco, etc) -runMain :: Bool -> Bool -> Bool -> Bool -> Bool -> Maybe Bool -> Bool -> [Mode] - -> [String] -> IO () -runMain dryrun quiet debug listrepos save mweakdeps exact modes args = do +runMain :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Maybe Bool -> Bool + -> [Mode] -> [String] -> IO () +runMain dryrun quiet debug listrepos save dnf4 mweakdeps exact modes args = do hSetBuffering stdout NoBuffering - withCurrentDirectory "/etc/yum.repos.d" $ do + unlessM (doesDirectoryExist yumReposD) $ + error' $ yumReposD +-+ "not found!" + withCurrentDirectory yumReposD $ do forM_ modes $ \case AddCopr copr mosname mrelease -> addCoprRepo dryrun debug mosname mrelease copr AddKoji repo -> addKojiRepo dryrun debug repo _ -> return () - repofiles <- filesWithExtension "." "repo" - -- when debug $ print repofiles + repofiles <- filesWithExtension "./" "repo" + when debug $ + print modes nameStates <- sort <$> concatMapM readRepos repofiles let actions = selectRepo exact nameStates modes moreoutput = not (null args) || null actions || listrepos + when (debug && not (null modes)) $ + if null actions + then putStrLn "no actions" + else print actions unless (null actions || quiet) $ do mapM_ putStrLn $ reduceOutput $ mapMaybe (printAction save) actions when moreoutput $ @@ -125,14 +152,17 @@ else do let changes = concatMap saveRepo actions unless (null changes) $ do - ok <- yesNo $ "Save changed repo" ++ " enabled state" ++ ['s' | length changes > 1] + ok <- yesNo $ "Save changed repo" +-+ "enabled state" ++ ['s' | length changes > 1] when ok $ do - mdnf3 <- findExecutable "dnf-3" + mdnf3 <- checkSystemPathFile "dnf-3" case mdnf3 of - -- FIXME cannot combine --disable and --enable - Just dnf3 -> doSudo dryrun debug dnf3 $ "config-manager" : changes - -- FIXME need to have repo files in changes - Nothing -> doSudo dryrun debug "sed" $ "config-manager" : changes + Just dnf3 -> + -- FIXME cannot combine --disable and --enable + doSudo dryrun debug dnf3 $ "config-manager" : changes + Nothing -> + -- FIXME need to have repo files in changes + -- doSudo dryrun debug "sed" $ "config-manager" : changes + error' "Saving repo state not yet supported without dnf" if null args then when (null actions || listrepos) $ do @@ -141,21 +171,21 @@ else do sleep 1 when save $ putStrLn "" - mdnf <- do - mdnf5 <- findExecutable "dnf5" - case mdnf5 of - Just dnf5 -> return $ Just dnf5 - Nothing -> findExecutable "dnf" + mdnf <- + if dnf4 + then checkSystemPathFile "dnf" + else + maybeM (checkSystemPathFile "dnf") (return . Just) $ + checkSystemPathFile "dnf5" case mdnf of - Just dnf -> do - when debug $ putStrLn dnf - let repoargs = concatMap changeRepo actions + Just dnf -> + let repoargs = mapMaybe changeRepo actions weakdeps = maybe [] (\w -> ["--setopt=install_weak_deps=" ++ show w]) mweakdeps quietopt = if quiet then ("-q" :) else id cachedir = ["--setopt=cachedir=/var/cache/dnf" relver | relver <- maybeToList (maybeReleaseVer args)] - in doSudo dryrun debug dnf $ quietopt repoargs ++ cachedir ++ weakdeps ++ map mungeArg args + in doSudo dryrun debug dnf $ quietopt repoargs ++ cachedir ++ weakdeps ++ map mungeArg args -- FIXME rpm-ostree install supports --enablerepo - Nothing -> error' "rpm-ostree not supported" + Nothing -> error' "missing dnf (rpm-ostree is not supported)" where mungeArg :: String -> String mungeArg "distrosync" = "distro-sync" @@ -163,30 +193,18 @@ addCoprRepo :: Bool -> Bool -> Maybe String -> Maybe String -> String -> IO () addCoprRepo dryrun debug mosname mrelease repo = do - let (server,owner,project) = - case splitOn "/" repo of - [] -> error' "empty repo string" - [_] -> error' $ "unqualified repo project:" +-+ repo - [o,p] -> (fedoraCopr, o , p) - [c,o,p] -> - if c == "redhat" - then ("copr.devel.redhat.com", o, p) - else - if '.' `elem` c - then (c, o, p) - else error' $ "unknown copr server:" +-+ repo - _ -> error' $ "unknown copr:" +-+ repo + let (server,owner,project) = serverOwnerProject repo repofile = - "_copr:" ++ server ++ ':' : mungeGroupFile owner ++ ':' : project <.> "repo" + "_copr:" ++ server ++ ':' : owner ++ ':' : project <.> "repo" whenM (doesFileExist repofile) $ - error' $ "repo already defined: " ++ repofile + error' $ "repo already defined:" +-+ repofile osName <- maybe getRpmOSName return mosname osVersion <- maybe getRpmOsRelease return mrelease - let repofileUrl = "https://" ++ server +/+ "coprs" +/+ mungeGroupUrl owner +/+ project +/+ "repo" +/+ osName ++ '-' : osVersion +/+ mungeGroupFile owner ++ '-' : project <.> "repo" + let repofileUrl = "https://" ++ server +/+ "coprs" +/+ mungeGroupUrl owner +/+ project +/+ "repo" +/+ osName ++ '-' : osVersion +/+ owner ++ '-' : project <.> "repo" (curlres,curlcontent) <- curlGetString repofileUrl [] unless (curlres == CurlOK) $ error' $ "downloading failed of" +-+ repofileUrl - putStrLn $ "Setting up copr repo " ++ repo + putStrLn $ "Setting up copr repo" +-+ repo withTempDir $ \ tmpdir -> do let tmpfile = tmpdir repofile unless dryrun $ writeFile tmpfile $ @@ -195,25 +213,34 @@ doSudo dryrun debug "cp" [tmpfile, repofile] putStrLn "" where - mungeGroupFile ('@':own) = "group_" ++ own - mungeGroupFile own = own - - mungeGroupUrl ('@':own) = "g" +/+ own + mungeGroupUrl ('g':'r':'o':'u':'p':'_':own) = "g" +/+ own mungeGroupUrl own = own + serverOwnerProject rpo = + case splitOn ":" rpo of + [] -> error' "empty repo string" + [_] -> error' $ "unqualified repo project:" +-+ rpo + [o,p] -> (fedoraCopr, o , p) + [c,o,p] -> + if '.' `elem` c + then (c, o, p) + else error' $ "unknown copr server:" +-+ rpo + ["copr",_,_,_] -> serverOwnerProject $ dropPrefix "copr/" rpo + _ -> error' $ "unknown copr:" +-+ rpo + addKojiRepo :: Bool -> Bool -> String -> IO () addKojiRepo dryrun debug repo = do sysarch <- cmd "rpm" ["--eval", "%{_arch}"] -- FIXME repo validation/sanity: not "-k list" or other dnf command let repourl = "https://kojipkgs.fedoraproject.org/repos" +/+ repo +/+ "latest" +/+ sysarch ++ "/" - unlessM (httpExists' repourl) $ error' $ "no such koji repo: " ++ repourl + unlessM (httpExists' repourl) $ error' $ "no such koji repo:" +-+ repourl template <- getDataFileName kojiRepoTemplate repodef <- cmd "sed" ["-e", "s/@REPO@/" ++ repo ++ "/g", template] let repofile = replace "REPO" repo kojiRepoTemplate exists <- doesFileExist repofile if exists - then error' $ "repo already defined: " ++ repofile - else putStrLn $ "Setting up koji repo " ++ repo + then error' $ "repo already defined:" +-+ repofile + else putStrLn $ "Setting up koji repo" +-+ repo withTempDir $ \ tmpdir -> do let tmpfile = tmpdir repofile unless dryrun $ writeFile tmpfile repodef @@ -233,11 +260,11 @@ deleteRepo :: Bool -> Bool -> FilePath -> IO () deleteRepo dryrun debug repofile = do - mowned <- cmdMaybe "rpm" ["-qf", "/etc/yum.repos.d" repofile] + mowned <- cmdMaybe "rpm" ["-qf", yumReposD repofile] case mowned of Just owner -> warning $ repofile +-+ "owned by" +-+ owner Nothing -> do - ok <- yesNo $ "Remove " ++ takeFileName repofile + ok <- yesNo $ "Remove" +-+ takeFileName repofile when ok $ do doSudo dryrun debug "rm" [repofile] diff --git a/src/State.hs b/src/State.hs new file mode 100644 --- /dev/null +++ b/src/State.hs @@ -0,0 +1,270 @@ +module State ( + Mode(..), + SpecificChange(..), + ChangeEnable(Expire,UnExpire,Delete), + printAction, + reduceOutput, + selectRepo, + changeRepo, + saveRepo, + updateState, + expiring, + deleting + ) +where + +--import Debug.Trace (traceShowId) +import Data.Either (partitionEithers) +import Data.List.Extra (dropPrefix, dropSuffix, foldl', + isPrefixOf, isInfixOf, isSuffixOf, nub, + replace, sortOn, stripInfix) +import Data.Maybe (mapMaybe) +import SimpleCmd (error', (+-+)) +import System.FilePath.Glob (compile, match) + +import YumRepoFile (RepoState) + +data Mode = AddCopr String (Maybe String) (Maybe String) | AddKoji String + | RepoURL String + | EnableRepo String | DisableRepo String | OnlyRepo String + | ExpireRepo String | ClearExpires + | DeleteRepo String + | Specific SpecificChange + deriving (Eq, Ord, Show) + +modePattern :: Mode -> Maybe String +modePattern (AddCopr c _ _) = Just c +modePattern (AddKoji k) = Just k +modePattern (RepoURL _) = Nothing +modePattern (EnableRepo r) = Just r +modePattern (DisableRepo r) = Just r +modePattern (OnlyRepo r) = Just r +modePattern (ExpireRepo r) = Just r +modePattern ClearExpires = Nothing +modePattern (DeleteRepo r) = Just r +modePattern (Specific _) = Nothing + +data SpecificChange = EnableModular | DisableModular + | EnableTesting | DisableTesting + | EnableDebuginfo | DisableDebuginfo + | EnableSource | DisableSource + deriving (Eq, Ord, Show) + +repoSubstr :: SpecificChange -> String +repoSubstr EnableModular = "-modular" +repoSubstr DisableModular = "-modular" +repoSubstr EnableTesting = "-testing" +repoSubstr DisableTesting = "-testing" +repoSubstr EnableDebuginfo = "-debuginfo" +repoSubstr DisableDebuginfo = "-debuginfo" +repoSubstr EnableSource = "-source" +repoSubstr DisableSource = "-source" + +-- Bool is current repo state +data ChangeEnable = Disable String Bool + | Enable String Bool + | Only String Bool + | Expire String Bool + | UnExpire + | Delete FilePath Bool + | BaseURL String + deriving (Eq,Ord,Show) + +printAction :: Bool -> ChangeEnable -> Maybe (Either String String) +printAction save (Disable r s) = + if s + then + Just $ Right $ + if save + then "disable" +-+ quote r + else "with disabled" +-+ quote r + else Just $ Left $ quote r +-+ "already disabled" +printAction save (Enable r s) = + if s + then + Just . Right $ + if save + then "enable" +-+ quote r + else "with enabled" +-+ quote r + else Just $ Left $ quote r +-+ "already enabled" +printAction _ (Only r _) = + Just . Right $ "with only" +-+ quote r +printAction _ (Expire r s) = + if s + then + Just . Right $ + "with enabled" +-+ quote r + else Nothing +printAction _ UnExpire = + Just $ Right "unexpire:" +printAction _ (Delete f s) = + if s + then Just $ Right $ "delete" +-+ quote f + else Just $ Left $ quote f +-+ "deletion skipped" +printAction _ (BaseURL _) = Nothing + +reduceOutput :: [Either String String] -> [String] +reduceOutput os = + case partitionEithers os of + (is,[]) -> is + (_,cs) -> cs + +quote :: String -> String +quote s = '\'' : s ++ "'" + +maybeRepoName :: ChangeEnable -> Maybe (ChangeEnable, String) +maybeRepoName d@(Disable r _) = Just (d, r) +maybeRepoName e@(Enable r _) = Just (e, r) +maybeRepoName o@(Only r _) = Just (o, r) +maybeRepoName x@(Expire r _) = Just (x, r) +maybeRepoName UnExpire = Nothing +maybeRepoName (Delete _ _) = Nothing +maybeRepoName (BaseURL _) = Nothing + +changeRepo :: ChangeEnable -> Maybe String +changeRepo (Disable r True) = Just $ "--disablerepo=" ++ r +changeRepo (Enable r True) = Just $ "--enablerepo=" ++ r +changeRepo (Only r True) = Just $ "--repo=" ++ r +changeRepo (Expire r True) = Just $ "--enablerepo=" ++ r +changeRepo (BaseURL url) = Just $ "--repofrompath=" ++ repoUrlName ++ "," ++ url + where + repoUrlName = replace "/" ":" $ + dropSuffix "/" $ + dropPrefix "http://" $ + dropPrefix "https://" url +changeRepo _ = Nothing + +saveRepo :: ChangeEnable -> [String] +saveRepo (Disable r True) = ["--disable", r] +saveRepo (Enable r True) = ["--enable", r] +saveRepo _ = [] + +expiring :: ChangeEnable -> Maybe String +expiring (Expire r _) = Just r +expiring _ = Nothing + +deleting :: ChangeEnable -> Maybe String +deleting (Delete r True) = Just r +deleting _ = Nothing + +updateState :: [ChangeEnable] -> RepoState -> RepoState +updateState [] rs = rs +updateState (ce:ces) re@(repo,(enabled,file)) = + case ce of + Disable r True | r == repo && enabled -> (repo,(False,file)) + Enable r True | r == repo && not enabled -> (repo,(True,file)) + Only r True | r == repo && not enabled -> (repo,(True,file)) + Only r True | r /= repo && enabled -> (repo,(False,file)) + _ -> updateState ces re + +selectRepo :: Bool -> [RepoState] -> [Mode] -> [ChangeEnable] +selectRepo exact repostates modes = + nub $ foldl' selectRepo' [] (nub modes) + where + selectRepo' :: [ChangeEnable] -> Mode -> [ChangeEnable] + selectRepo' acc mode = + let results = nub $ mapMaybe (selectRepoMode mode acc) repostates + in + case results of + [] -> error' ("no match for repo pattern action: " ++ show mode) + [_] -> acc ++ results + _ -> + acc ++ + case modePattern mode of + Nothing -> results + Just p -> + if isGlob p + then results + else + let actNames = mapMaybe maybeRepoName results + in + if null actNames + then results + else + let base = head $ sortOn (length . snd) actNames + in + if all ((snd base `isPrefixOf`) . snd) actNames + then [fst base] + else results + + selectRepoMode :: Mode -> [ChangeEnable] -> RepoState + -> Maybe ChangeEnable + selectRepoMode mode acc (name,(enabled,file)) = + case mode of + AddCopr repo _ _ -> + maybeChange repo isSuffixOf (not enabled) (Enable name) + AddKoji repo -> + maybeChange repo isSuffixOf (not enabled) (Enable name) + RepoURL url -> Just $ BaseURL url + EnableRepo pat -> + maybeChange pat matchesRepo (not enabled) (Enable name) + DisableRepo pat -> + maybeChange pat matchesRepo enabled (Disable name) + OnlyRepo pat -> + maybeChange pat matchesRepo (not enabled) (Only name) + ExpireRepo pat -> + maybeChange pat matchesRepo True (Expire name) + ClearExpires -> Just UnExpire + DeleteRepo pat -> + maybeChange pat matchesRepo + (not enabled || error ("disable repo before deleting:" +-+ name)) + (Delete file) + Specific change -> + let substr = repoSubstr change in + if change `elem` + [EnableModular,EnableTesting,EnableDebuginfo,EnableSource] + then + maybeChange substr + (\p n -> p `isInfixOf` n && + repoStatus acc (removeInfix substr name)) + (not enabled) (Enable name) + else + maybeChange substr isInfixOf enabled (Disable name) + where + maybeChange :: String -> (String -> String -> Bool) -> Bool + -> (Bool -> ChangeEnable) -> Maybe ChangeEnable + maybeChange pat matcher state change = + if pat `matcher` name + then + if state + then Just $ change True + else + if isGlob pat + then Nothing + else Just $ change False + else Nothing + + repoStatus :: [ChangeEnable] -> String -> Bool + repoStatus acc repo = + case lookup repo repostates of + Just (enabled,_) -> + enabled || Enable repo True `elem` acc + Nothing -> False + + isGlob :: String -> Bool + isGlob pat = any (`elem` pat) "*?[" + + matchesRepo :: String -> String -> Bool + matchesRepo "" = error' "empty repo pattern" + matchesRepo pat + | isGlob pat = (match . compile) $ + if exact + then pat + else + case ('^' == head pat,'$' == last pat) of + (True,True) -> init (tail pat) + (True,False) -> tail pat ++ ['*' | last pat /= '*'] + (False,True) -> ['*' | head pat /= '*'] ++ init pat + _ -> ['*' | head pat /= '*'] ++ pat ++ ['*' | last pat /= '*'] + | exact = (pat ==) + | otherwise = + case ('^' == head pat,'$' == last pat) of + (True,True) -> (init (tail pat) ==) + (True,False) -> (tail pat `isPrefixOf`) + (False,True) -> (init pat `isSuffixOf`) + _ -> (pat `isInfixOf`) + +-- adapted from simple-cmd +removeInfix :: String -> String-> String +removeInfix inf orig = + maybe orig (uncurry (++)) $ stripInfix inf orig diff --git a/src/YumRepoFile.hs b/src/YumRepoFile.hs --- a/src/YumRepoFile.hs +++ b/src/YumRepoFile.hs @@ -1,261 +1,14 @@ module YumRepoFile ( - Mode(..), - SpecificChange(..), readRepos, - RepoState, - ChangeEnable(Expire,UnExpire,Delete), - printAction, - reduceOutput, - selectRepo, - changeRepo, - saveRepo, - updateState, - expiring, - deleting + RepoState ) where -import Data.Either (partitionEithers) -import Data.List.Extra (dropPrefix, dropSuffix, - isPrefixOf, isInfixOf, isSuffixOf, nub, - replace, sortOn, splitOn, stripInfix, trim) -import Data.Maybe (mapMaybe) -import SimpleCmd (error') -import System.FilePath.Glob (compile, match) +import Data.List.Extra (isPrefixOf, splitOn, trim) +import SimpleCmd (error', (+-+)) type RepoState = (String,(Bool,FilePath)) -data Mode = AddCopr String (Maybe String) (Maybe String) | AddKoji String - | RepoURL String - | EnableRepo String | DisableRepo String - | ExpireRepo String | ClearExpires - | DeleteRepo String - | Specific SpecificChange - deriving (Eq, Ord, Show) - -modePattern :: Mode -> Maybe String -modePattern (AddCopr c _ _) = Just c -modePattern (AddKoji k) = Just k -modePattern (RepoURL _) = Nothing -modePattern (EnableRepo r) = Just r -modePattern (DisableRepo r) = Just r -modePattern (ExpireRepo r) = Just r -modePattern ClearExpires = Nothing -modePattern (DeleteRepo r) = Just r -modePattern (Specific _) = Nothing - -data SpecificChange = EnableModular | DisableModular - | EnableTesting | DisableTesting - | EnableDebuginfo | DisableDebuginfo - | EnableSource | DisableSource - deriving (Eq, Ord, Show) - -repoSubstr :: SpecificChange -> String -repoSubstr EnableModular = "-modular" -repoSubstr DisableModular = "-modular" -repoSubstr EnableTesting = "-testing" -repoSubstr DisableTesting = "-testing" -repoSubstr EnableDebuginfo = "-debuginfo" -repoSubstr DisableDebuginfo = "-debuginfo" -repoSubstr EnableSource = "-source" -repoSubstr DisableSource = "-source" - -data ChangeEnable = Disable String Bool - | Enable String Bool - | Expire String Bool - | UnExpire - | Delete FilePath Bool - | BaseURL String - deriving (Eq,Ord,Show) - -printAction :: Bool -> ChangeEnable -> Maybe (Either String String) -printAction save (Disable r s) = - if s - then - Just $ Right $ - if save - then "disable " ++ quote r - else "with disabled " ++ quote r - else Just $ Left $ quote r ++ " already disabled" -printAction save (Enable r s) = - if s - then - Just . Right $ - if save - then "enable " ++ quote r - else "with enabled " ++ quote r - else Just $ Left $ quote r ++ " already enabled" -printAction _ (Expire r s) = - if s - then - Just . Right $ - "with enabled " ++ quote r - else Nothing -printAction _ UnExpire = - Just $ Right "unexpire:" -printAction _ (Delete f s) = - if s - then Just $ Right $ "delete " ++ quote f - else Just $ Left $ quote f ++ " deletion skipped" -printAction _ (BaseURL _) = Nothing - -reduceOutput :: [Either String String] -> [String] -reduceOutput os = - case partitionEithers os of - (is,[]) -> is - (_,cs) -> cs - -quote :: String -> String -quote s = '\'' : s ++ "'" - -maybeRepoName :: ChangeEnable -> Maybe (ChangeEnable, String) -maybeRepoName d@(Disable r _) = Just (d, r) -maybeRepoName e@(Enable r _) = Just (e, r) -maybeRepoName x@(Expire r _) = Just (x, r) -maybeRepoName UnExpire = Nothing -maybeRepoName (Delete _ _) = Nothing -maybeRepoName (BaseURL _) = Nothing - -changeRepo :: ChangeEnable -> [String] -changeRepo (Disable r True) = ["--disablerepo", r] -changeRepo (Enable r True) = ["--enablerepo", r] -changeRepo (Expire r True) = ["--enablerepo", r] -changeRepo (BaseURL url) = ["--repofrompath", repoUrlName ++ "," ++ url] - where - repoUrlName = replace "/" ":" $ - dropSuffix "/" $ - dropPrefix "http://" $ - dropPrefix "https://" url - -changeRepo _ = [] - -saveRepo :: ChangeEnable -> [String] -saveRepo (Disable r True) = ["--disable", r] -saveRepo (Enable r True) = ["--enable", r] -saveRepo _ = [] - -expiring :: ChangeEnable -> Maybe String -expiring (Expire r _) = Just r -expiring _ = Nothing - -deleting :: ChangeEnable -> Maybe String -deleting (Delete r True) = Just r -deleting _ = Nothing - -updateState :: [ChangeEnable] -> RepoState -> RepoState -updateState [] rs = rs -updateState (ce:ces) re@(repo,(enabled,file)) = - case ce of - -- FIXME can probably drop enable/not enabled - Disable r True | r == repo && enabled -> (repo,(False,file)) - Enable r True | r == repo && not enabled -> (repo,(True,file)) - _ -> updateState ces re - -selectRepo :: Bool -> [RepoState] -> [Mode] -> [ChangeEnable] -selectRepo exact repostates modes = - nub $ foldr selectRepo' [] (nub modes) - where - selectRepo' :: Mode -> [ChangeEnable] -> [ChangeEnable] - selectRepo' mode acc = - let results = nub $ mapMaybe (selectRepoMode mode acc) repostates - in - case results of - [] -> [] - [_] -> acc ++ results - _ -> - acc ++ - case modePattern mode of - Nothing -> results - Just p -> - if isGlob p - then results - else - let actNames = mapMaybe maybeRepoName results - in - if null actNames - then results - else - let base = head $ sortOn (length . snd) actNames - in - if all ((snd base `isPrefixOf`) . snd) actNames - then [fst base] - else results - - selectRepoMode :: Mode -> [ChangeEnable] -> RepoState - -> Maybe ChangeEnable - selectRepoMode mode acc (name,(enabled,file)) = - case mode of - AddCopr repo _ _ -> - maybeChange repo isSuffixOf (not enabled) (Enable name) - AddKoji repo -> - maybeChange repo isSuffixOf (not enabled) (Enable name) - RepoURL url -> Just $ BaseURL url - EnableRepo pat -> - maybeChange pat matchesRepo (not enabled) (Enable name) - DisableRepo pat -> - maybeChange pat matchesRepo enabled (Disable name) - ExpireRepo pat -> - maybeChange pat matchesRepo True (Expire name) - ClearExpires -> Just UnExpire - DeleteRepo pat -> - maybeChange pat matchesRepo - (not enabled || error ("disable repo before deleting: " ++ name)) - (Delete file) - Specific change -> - let substr = repoSubstr change in - if change `elem` - [EnableModular,EnableTesting,EnableDebuginfo,EnableSource] - then - maybeChange substr - (\p n -> p `isInfixOf` n && - repoStatus acc (removeInfix substr name)) - (not enabled) (Enable name) - else - maybeChange substr isInfixOf enabled (Disable name) - where - maybeChange :: String -> (String -> String -> Bool) -> Bool - -> (Bool -> ChangeEnable) -> Maybe ChangeEnable - maybeChange pat matcher state change = - if pat `matcher` name - then - if state - then Just $ change True - else - if isGlob pat - then Nothing - else Just $ change False - else Nothing - - repoStatus :: [ChangeEnable] -> String -> Bool - repoStatus acc repo = - case lookup repo repostates of - Just (enabled,_) -> - enabled || Enable repo True `elem` acc - Nothing -> False - - isGlob :: String -> Bool - isGlob pat = any (`elem` pat) "*?[" - - matchesRepo :: String -> String -> Bool - matchesRepo "" = error' "empty repo pattern" - matchesRepo pat - | isGlob pat = (match . compile) $ - if exact - then pat - else - case ('^' == head pat,'$' == last pat) of - (True,True) -> init (tail pat) - (True,False) -> tail pat ++ ['*' | last pat /= '*'] - (False,True) -> ['*' | head pat /= '*'] ++ init pat - _ -> ['*' | head pat /= '*'] ++ pat ++ ['*' | last pat /= '*'] - | exact = (pat ==) - | otherwise = - case ('^' == head pat,'$' == last pat) of - (True,True) -> (init (tail pat) ==) - (True,False) -> (tail pat `isPrefixOf`) - (False,True) -> (init pat `isSuffixOf`) - _ -> (pat `isInfixOf`) - readRepos :: FilePath -> IO [RepoState] readRepos file = parseRepos file . lines <$> readFile file @@ -268,15 +21,15 @@ Just (section,rest) -> let (enabled,more) = case dropWhile (not . ("enabled" `isPrefixOf`)) rest of - [] -> error' $ "no enabled field for " ++ section + [] -> error' $ "no enabled field for" +-+ section (e:more') -> case splitOn "=" e of [_,v] -> case trim v of "1" -> (True,more') "0" -> (False,more') - _ -> error' $ "strange enabled state " ++ e ++ " for " ++ section - _ -> error' $ "unknown enabled state " ++ e ++ " for " ++ section + _ -> error' $ "strange enabled state" +-+ e +-+ "for" +-+ section + _ -> error' $ "unknown enabled state" +-+ e +-+ "for" +-+ section in (section,(enabled,file)) : parseRepos file more where nextSection :: [String] -> Maybe (String,[String]) @@ -286,10 +39,5 @@ ('[' : rest) -> if last rest == ']' then Just (init rest, ls') - else error' $ "bad section " ++ l ++ " in " ++ file + else error' $ "bad section" +-+ l +-+ "in" +-+ file _ -> nextSection ls' - --- adapted from simple-cmd -removeInfix :: String -> String-> String -removeInfix inf orig = - maybe orig (uncurry (++)) $ stripInfix inf orig diff --git a/test/tests.hs b/test/tests.hs --- a/test/tests.hs +++ b/test/tests.hs @@ -9,7 +9,6 @@ tests :: [[String]] tests = [["-t"] - ,["-m"] ,["-e", "copr"] ,["-e", "openh264"] ,["-e", "rawhide"]