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 b/ChangeLog new file mode 100644 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,6 @@ +* 0.3 (2017-10-24) +- initial release with fhbuild, fhbz, and fhpkg + +# Local Variables: +# mode: text +# End: diff --git a/Dists.hs b/Dists.hs new file mode 100644 --- /dev/null +++ b/Dists.hs @@ -0,0 +1,78 @@ +-- | +-- Module : Dists +-- Copyright : (C) 2014-2017 Jens Petersen +-- +-- Maintainer : Jens Petersen +-- Stability : alpha +-- Portability : portable +-- +-- Explanation: Fedora dist metadata + +-- 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. + +module Dists (Dist, + dists, + distBranch, + distShort, + distVersion, + distRepo, + distTag, + distTarget, + distUpdates, + distOverride, + releaseVersion, + rawhide) where + +import Data.Char (isNumber) +import Utils ((+-+)) + +type Dist = String + +dists :: [Dist] +dists = [rawhide, "f27", "f26", "f25", "epel7"] + +rawhide :: String +rawhide = "f28" + +distBranch :: Dist -> String +distBranch d | d == rawhide = "master" + | otherwise = d + +splitDist :: Dist -> (String, String) +splitDist = break isNumber + +distShort :: Dist -> String +distShort = fst . splitDist + +distVersion :: Dist -> String +distVersion = snd . splitDist + +distRepo :: Dist -> String +distRepo d | d == rawhide = "rawhide" + | distShort d == "f" = "fedora" + | distShort d `elem` ["epel", "el"] = "epel" +distRepo d = error $ "Unknown dist" +-+ d + +distUpdates :: Dist -> Maybe String +distUpdates d | distShort d == "f" = Just "updates" +distUpdates _ = Nothing + +distOverride :: Dist -> Bool +distOverride d = d `notElem` [rawhide, "f28" {-, "epel7"-}] + +distTag :: Dist -> String +distTag d {- | d == rawhide = "f28" ++ "-ghc" -} + {- | d == "epel7" = d ++ "-ghc" -} + {- | otherwise -} = d ++ "-build" + +distTarget :: Dist -> Maybe String +distTarget d | d `elem` [rawhide, "epel7"] = Nothing -- Just $ d ++ "-ghc" + | otherwise = Nothing + +releaseVersion :: Dist -> String +releaseVersion "epel7" = "7" +releaseVersion r | head r == 'f' = tail r +releaseVersion _ = error "Unknown release" diff --git a/Koji.hs b/Koji.hs new file mode 100644 --- /dev/null +++ b/Koji.hs @@ -0,0 +1,58 @@ +-- | +-- Module : Koji +-- Copyright : (C) 2016-2017 Jens Petersen +-- +-- Maintainer : Jens Petersen +-- Stability : alpha +-- Portability : *nix +-- +-- Explanation: Koji commands + +-- 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. + +module Koji where + +#if (defined(MIN_VERSION_base) && MIN_VERSION_base(4,8,2)) +#else +import Control.Applicative ((<$>)) +#endif +import Data.List (isInfixOf) +import System.FilePath (()) + +import Dists (Dist) +import Utils (cmd, cmd_) + +kojiLatestPkg :: Dist -> String -> IO String +kojiLatestPkg dist pkg = do + res <- words <$> cmd "koji" ["latest-pkg", "--quiet", dist, pkg] + return $ if null res then "" else head res + +kojiWaitPkg :: Dist -> String -> IO () +kojiWaitPkg dist pkg = --do + cmd_ "koji" ["wait-repo", dist, "--build=" ++ pkg] + --putStrLn "" + +kojiBuilding :: String -> String -> IO Bool +kojiBuilding pkg build = do + tasks <- lines <$> cmd "koji" ["list-tasks", "--mine", "--quiet"] + return $ any (build `isInfixOf`) tasks || any (("/" ++ pkg ++ ":") `isInfixOf`) tasks + +-- parseKojiTask :: [String] -> Maybe String +-- parseKojiTask [] = Nothing +-- parseKojiTask (l:ls) | "Created task:" `isPrefixOf` l = Just $ removePrefix "Created task: " l +-- | otherwise = parseKojiTask ls + +notInKoji :: String -> FilePath -> String -> String -> IO Bool +notInKoji branch topdir tag pkg = do + latest <- kojiLatestPkg tag pkg + local <- cmd "fedpkg" ["--path", topdir pkg branch, "verrel"] + if latest == local + then kojiWaitPkg tag latest >> return False + else return True + +kojiListPkgs :: Dist -> IO [String] +kojiListPkgs dist = + words <$> cmd "koji" ["list-pkgs", "--tag=" ++ dist] diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +[![Build Status](https://travis-ci.org/fedora-haskell/fedora-haskell-tools.png)](https://travis-ci.org/fedora-haskell/fedora-haskell-tools) + +# Fedora Haskell Tools + +## fhbuild +Builds set of packages locally or in Koji or Mock. + +For local builds unbuilt dependent packages are also built recursive. + +For updates built in Koji, buildroot overrides are created and waited for. + +Please be careful using this: eg for Rawhide this can easily cause +package builds to take place in Koji when packages haven't been built +yet for the latest disttag. + +See TODO for more planned features. + +## fhpkg +Git clones and pull, etc Fedora Haskell package repos. +Can also generate Hackage distro meta data. + +Unless you specify a branch it will use "fedpkg clone -B". +It doesn't do anonymous cloning (-a) yet. + +This replaces the scripts: +- https://pagure.io/haskell-sig-old/blob/master/f/bin/haskell-pkgs.sh +- https://pagure.io/haskell-sig-old/blob/master/f/packages/current-packages + + +fhpkg and fhbuild may eventually be merged. + +## fhbz +Update version update bugs in Bugzilla for Haskell packages. diff --git a/RPM.hs b/RPM.hs new file mode 100644 --- /dev/null +++ b/RPM.hs @@ -0,0 +1,89 @@ +-- | +-- Module : RPM +-- Copyright : (C) 2015-2017 Jens Petersen +-- +-- Maintainer : Jens Petersen +-- +-- Explanation: RPM utils + +-- 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. + +module RPM (packageManager, + repoquery, + repoquerySrc, + rpmInstall) where + +import Control.Monad (unless, when) +import Data.List (elemIndices) +import Data.Maybe (isJust, isNothing) +import System.Directory (findExecutable) +-- die is available in ghc-7.10 base-4.8 +import System.Exit (exitFailure) +import System.IO (hPutStrLn, stderr) + +import Utils (cmdStdErr, singleLine, sudo) + +-- @since base 4.8.0.0 +die :: String -> IO a +die err = hPutStrLn stderr err >> exitFailure + +warn :: String -> IO () +warn = hPutStrLn stderr + +requireProgram :: String -> IO () +requireProgram c = do + mavail <- findExecutable c + when (isNothing mavail) $ die (c ++ ": command not found") + +optionalProgram :: String -> IO Bool +optionalProgram c = do + mavail <- findExecutable c + return $ isJust mavail + +packageManager :: IO String +packageManager = do + havednf <- optionalProgram "dnf" + if havednf + then return "dnf" + else requireProgram "yum" >> return "yum" + +rpmInstall :: [String] -> IO () +rpmInstall rpms = do + pkginstaller <- packageManager + let (inst, arg) = if pkginstaller == "dnf" then ("dnf", "install") else ("yum", "localinstall") + sudo inst $ ["-y", "--nogpgcheck", arg] ++ rpms + +repoquery :: [String] -> String -> IO String +repoquery args key = do + havednf <- optionalProgram "dnf" + let (prog, subcmd) = if havednf then ("dnf", ["repoquery", "--quiet"]) else ("repoquery", []) + repoqWrap prog (subcmd ++ args ++ [key]) + +repoqWrap :: String -> [String] -> IO String +repoqWrap cmd args = do + (out, err) <- cmdStdErr cmd args + -- workaround noisy dnf2 repoquery --quiet + -- ignore "Last metadata expiration check" warnings + unless (null err || head (words err) == "Last") $ + warn err + return $ singleLine out + +repoquerySrc :: String -> IO (Maybe String) +repoquerySrc key = do + havednf <- optionalProgram "dnf" + let (prog, subcmd) = if havednf then ("dnf", ["repoquery", "--quiet", "-s"]) else ("repoquery", ["--qf", "%{base_package_name}", "--whatprovides"]) + res <- repoqWrap prog (subcmd ++ [key]) + if null res then return Nothing + else return $ Just $ nvrToName res + +nvrToName :: String -> String +nvrToName nvr = + if length dashes < 2 + then error $ "malformed NVR string: '" ++ nvr ++ "'" + else take nameDash nvr + where + dashes = elemIndices '-' nvr + nameDash = last $ init dashes diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/TODO b/TODO new file mode 100644 --- /dev/null +++ b/TODO @@ -0,0 +1,48 @@ +Porting haskell-sig.git scripts: + +use pkgdb-cli + cabal-sort for --all packages + +deps query tool + +Parallelize + +# git +- branch merging +- build new packages across branches + +# command options +- debug output +- dist option (assume rawhide) + +# Building: rebuild* +- recursive building for koji and mock +- mockchain +- fedpkg git integration +- package sorting +- rebuilding + - what can be built next +- copr support +- parallel/async building +- cache passwd for bodhi + +# updating +- port update-pkg-ver + +# checking +- Fedora x < Fedora x+1 +- git out of sync with koji, updates + +# Data generation and updating +- packages and Hackage +- dependencies and consumers + +# Bugs +- URM bug checking and updating + - stacks checking +- check review bugs + +# missing +- which packages missing in dist to build package +- include version checks + +# package ordering (sorting) diff --git a/Utils.hs b/Utils.hs new file mode 100644 --- /dev/null +++ b/Utils.hs @@ -0,0 +1,126 @@ +-- | +-- Module : Cmd +-- Copyright : (C) 2014 Jens Petersen +-- +-- Maintainer : Jens Petersen +-- Stability : alpha +-- Portability : *nix +-- +-- Explanation: system/shell command utils + +-- 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. + +module Utils where + +#if (defined(MIN_VERSION_base) && MIN_VERSION_base(4,8,2)) +#else +import Control.Applicative ((<$>)) +#endif +import Control.Monad (void) +import Data.List (stripPrefix) +import Data.Maybe (fromMaybe) +import System.Exit (ExitCode (..)) +import System.Process (readProcess, readProcessWithExitCode, rawSystem) + +infixr 4 +-+ +(+-+) :: String -> String -> String +"" +-+ s = s +s +-+ "" = s +s +-+ t = s ++ " " ++ t + +cmdStdIn :: String -> [String] -> String -> IO String +cmdStdIn c as inp = removeTrailingNewline <$> readProcess c as inp + +cmd :: String -> [String] -> IO String +cmd c as = cmdStdIn c as "" + +removeTrailingNewline :: String -> String +removeTrailingNewline "" = "" +removeTrailingNewline str = + if last str == '\n' + then init str + else str + +singleLine :: String -> String +singleLine "" = "" +singleLine s = (head . lines) s + +cmdMaybe :: String -> [String] -> IO (Maybe String) +cmdMaybe c as = do + (ret, out, _err) <- readProcessWithExitCode c as "" + case ret of + ExitSuccess -> return $ Just $ removeTrailingNewline out + ExitFailure _ -> return Nothing + +cmdStdErr :: String -> [String] -> IO (String, String) +cmdStdErr c as = do + (_ret, out, err) <- readProcessWithExitCode c as "" + return (removeTrailingNewline out, removeTrailingNewline err) + +cmdStdIn_ :: String -> [String] -> String -> IO () +cmdStdIn_ c as inp = void $ cmdStdIn c as inp + +cmd_ :: String -> [String] -> IO () +cmd_ c as = do + ret <- rawSystem c as + case ret of + ExitSuccess -> return () + ExitFailure n -> error $ "\"" ++ c +-+ unwords as ++ "\" failed with exit code" +-+ show n + +-- dry-run +cmdN :: String -> [String] -> IO () +cmdN c as = putStrLn $ c +-+ show as + +cmdAssert :: String -> String -> [String] -> IO () +cmdAssert msg c as = do + ret <- rawSystem c as + case ret of + ExitSuccess -> return () + ExitFailure _ -> error msg + +cmdlogStdIn :: String -> [String] -> String -> IO () +cmdlogStdIn c as inp = do + date <- cmd "date" ["+%T"] + putStrLn $ date +-+ c +-+ unwords as + cmdStdIn_ c as inp + +cmdlog :: String -> [String] -> IO () +cmdlog c as = cmdlogStdIn c as "" + +logMsg :: String -> IO () +logMsg msg = do + date <- cmd "date" ["+%T"] + putStrLn $ date +-+ msg + +cmdBool :: String -> [String] -> IO Bool +cmdBool c as = do + ret <- rawSystem c as + case ret of + ExitSuccess -> return True + ExitFailure _ -> return False + +sudo :: String -> [String] -> IO () +sudo c as = cmdlog "sudo" (c:as) + +shell :: String -> IO String +shell c = cmd "sh" ["-c", c] + +removePrefix :: String -> String -> String +removePrefix prefix orig = + fromMaybe (error prefix +-+ "is not prefix of" +-+ orig) $ stripPrefix prefix orig + +removeSuffix :: String -> String -> String +removeSuffix suffix orig = + fromMaybe orig $ stripSuffix suffix orig + where + stripSuffix sf str = reverse <$> stripPrefix (reverse sf) (reverse str) + +error_ :: String -> a +#if (defined(MIN_VERSION_base) && MIN_VERSION_base(4,9,0)) +error_ = errorWithoutStackTrace +#else +error_ = error +#endif diff --git a/fedora-haskell-tools.cabal b/fedora-haskell-tools.cabal new file mode 100644 --- /dev/null +++ b/fedora-haskell-tools.cabal @@ -0,0 +1,54 @@ +Name: fedora-haskell-tools +Version: 0.3 +Synopsis: Building and tracking tools for Fedora Haskell +Description: + Tools for recursive building of Fedora Haskell packages. +Homepage: https://github.com/fedora-haskell/fedora-haskell-tools +Bug-reports: https://github.com/fedora-haskell/fedora-haskell-tools/issues +License: GPL-3 +License-file: COPYING +Author: Jens Petersen +Maintainer: Jens Petersen +Copyright: 2014-2017 Jens Petersen +Category: Distribution +Build-type: Simple +Extra-source-files: README.md TODO ChangeLog +Cabal-version: >=1.6 + +source-repository head + type: git + location: https://github.com/fedora-haskell/fedora-haskell-tools + +Executable fhbuild + Main-is: fhbuild.hs + Build-depends: base < 5, + directory, + filepath, + process, + unix + Other-modules: Dists, + Koji, + RPM, + Utils + GHC-options: -fwarn-missing-signatures -Wall + Extensions: CPP + +Executable fhbz + Main-is: fhbz.hs + Build-depends: base < 5, + time + GHC-options: -fwarn-missing-signatures -Wall + Extensions: CPP + +Executable fhpkg + Main-is: fhpkg.hs + Build-depends: base < 5, + directory, + filepath, + process, + unix + Other-modules: Dists, + Koji, + Utils + GHC-options: -fwarn-missing-signatures -Wall + Extensions: CPP diff --git a/fhbuild.hs b/fhbuild.hs new file mode 100644 --- /dev/null +++ b/fhbuild.hs @@ -0,0 +1,375 @@ +-- | +-- Module : Build +-- Copyright : (C) 2014-2017 Jens Petersen +-- +-- Maintainer : Jens Petersen +-- Stability : alpha +-- +-- Explanation: Main entry point for building RPM packages. + +-- 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. + +module Main where + +#if (defined(MIN_VERSION_base) && MIN_VERSION_base(4,8,2)) +#else +import Control.Applicative ((<$>)) +#endif +import Control.Monad (filterM, unless, when) +import Data.Maybe +import Data.List (intercalate, isPrefixOf, nub, (\\)) + +import System.Directory (doesDirectoryExist, doesFileExist, + getCurrentDirectory, setCurrentDirectory) +import System.Environment (getArgs, getProgName) +import System.Exit (ExitCode (..), exitWith) +import System.FilePath ((), dropExtension) +import System.IO (hPutStrLn, stderr) + +import Dists (Dist, dists, distBranch, distOverride, distTag, distTarget) +import Koji (kojiBuilding, kojiLatestPkg, kojiWaitPkg, notInKoji) +import RPM (packageManager, rpmInstall, repoquery, repoquerySrc) +import Utils ((+-+), cmd, cmd_, cmdBool, cmdMaybe, cmdlog, error_, logMsg, + removePrefix, removeSuffix, sudo) + +data Command = Install | Mock | Koji | Chain | Pending | Changed | Built deriving (Eq) + +main :: IO () +main = do + margs <- getArgs >>= parseArgs + case margs of + Nothing -> return () + Just (com, dist, pkgs) -> do + cwd <- getCurrentDirectory + build cwd (mode com) dist Nothing Nothing False pkgs + where + mode "install" = Install + mode "mock" = Mock + mode "koji" = Koji + mode "chain" = Chain + mode "pending" = Pending + mode "changed" = Changed + mode "built" = Built + mode _ = error "Unknown command" + +commands :: [String] +commands = ["install", "mock" , "koji", "chain", "pending", "changed", "built"] + +help :: IO () +help = do + progName <- getProgName + hPutStrLn stderr $ "Usage:" +-+ progName +-+ "CMD DIST PKG...\n" + ++ "\n" + ++ "Commands:\n" + ++ " install\t- build locally and install\n" + ++ " mock\t\t- build in mock\n" + ++ " koji\t\t- build in Koji\n" + ++ " chain\t\t- build deps recursively in Koji\n" + ++ " pending\t- show planned changes\n" + ++ " changed\t- show changed pkgs\n" + ++ " built\t\t- show pkgs whose NVR already built\n" + exitWith (ExitFailure 1) + +type Arguments = Maybe (String, Dist, [String]) + +parseArgs :: [String] -> IO Arguments +parseArgs (c:dist:pkgs) | dist `notElem` dists = giveUp $ "Unknown dist '" ++ dist ++ "'" + | null pkgs = giveUp "Please specify a package." + | otherwise = + return $ Just (c, dist, map (removeSuffix "/") pkgs) +parseArgs _ = help >> return Nothing + +giveUp :: String -> IO Arguments +giveUp err = do + hPutStrLn stderr err + help >> return Nothing + +build :: FilePath -> Command -> Dist -> Maybe String -> Maybe (String, String) -> Bool -> [String] -> IO () +build _ _ _ _ _ _ [] = return () +build topdir mode dist msubpkg mlast waitrepo (pkg:rest) = do + setCurrentDirectory topdir + let branch = distBranch dist + unless (mode `elem` [Pending, Changed, Built]) $ + putStrLn $ "\n==" +-+ pkg ++ ":" ++ branch +-+ "==" + dirExists <- doesDirectoryExist pkg + unless dirExists $ do + let anon = ["-a" | mode `notElem` [Koji, Chain]] + cmdlog "fedpkg" $ ["clone", "-b", branch, pkg] ++ anon + wd <- pkgDir pkg branch "" + setCurrentDirectory wd + retired <- doesFileExist "dead.package" + if retired then do + unless (mode == Pending) $ + putStrLn "skipping dead.package" + build topdir mode dist Nothing Nothing False rest + else do + pkggit <- do + gd <- doesFileExist ".git/config" + if gd then cmdBool "grep" ["-q", "pkgs.fedoraproject.org", ".git/config"] + else return False + if not pkggit + then if mode `elem` [Install, Koji, Chain] + then error $ "not a Fedora pkg git dir!:" +-+ wd + else build topdir mode dist Nothing Nothing False rest + else do + when dirExists $ do + actual <- gitBranch + when (branch /= actual) $ + cmd_ "fedpkg" ["switch-branch", branch] + cmd_ "git" ["pull", "-q"] + -- noupdate <- doesFileExist ".noupdate" + -- unless noupdate $ + -- void $ cmdBool "cabal-rpm" ["update"] + let spec = pkg ++ ".spec" + hasSpec <- doesFileExist spec + if not hasSpec + then putStrLn $ "No" +-+ spec + else do + nvr <- cmd "fedpkg" ["verrel"] + let verrel = removePrefix (pkg ++ "-") nvr + release = tail $ dropWhile (/= '-') verrel + tag = distTag dist + case mode of + Install -> do + let req = fromMaybe pkg msubpkg + installed <- cmdMaybe "rpm" ["-q", "--qf", "%{name}-%{version}-%{release}", req] + if Just (req ++ "-" ++ verrel) == installed + then putStrLn $ nvr +-+ "already installed!\n" + else do + putStrLn $ fromMaybe "Not installed" installed +-+ "->" +-+ nvr + cmd_ "git" ["--no-pager", "log", "-1"] + putStrLn "" + putStrLn "Repoquerying deps..." + brs <- buildRequires spec + missing <- catMaybes <$> (nub <$> filterM notInstalled brs >>= mapM derefSrcPkg) + -- FIXME sort into build order + let hmissing = filter (\ dp -> "ghc-" `isPrefixOf` dp || dp `elem` ["alex", "cabal-install", "gtk2hs-buildtools", "happy"]) missing + unless (null hmissing) $ do + putStrLn "Missing:" + mapM_ putStrLn hmissing + build topdir Install dist Nothing Nothing False hmissing + setCurrentDirectory $ topdir wd + stillMissing <- filterM notInstalled missing + unless (null stillMissing) $ do + putStrLn $ "Installing:" +-+ intercalate ", " stillMissing + rpmInstall stillMissing + let logfile = ".build-" ++ verrel ++ ".log" + putStrLn "" + putStrLn $ "Building" +-+ nvr + putStrLn $ "To watch: tail -f" +-+ wd logfile + -- note "fedpkg --path dir local" saves .build.log in cwd + _out <- cmd "fedpkg" ["local"] + opkgs <- lines <$> cmd "rpmspec" ["-q", "--queryformat", "%{name}\n", spec] + rpms <- lines <$> cmd "rpmspec" ["-q", "--queryformat", "%{arch}/%{name}-%{version}-" ++ release ++ ".%{arch}.rpm\n", spec] + built <- and <$> mapM doesFileExist rpms + if built + then do + putStrLn $ nvr +-+ "built\n" + instpkgs <- lines <$> cmd "rpm" ("-qa":opkgs) + if null instpkgs + -- maybe filter out pandoc-pdf if not installed + then rpmInstall rpms + else do + pkgmgr <- packageManager + -- sudo pkgmgr ("--setopt=clean_requirements_on_remove=no":"remove":"-y":instpkgs) + sudo pkgmgr ("install":"-y":rpms) + setCurrentDirectory topdir + else do + displayLogTail logfile + error_ $ "Build of " ++ nvr ++ " failed!" + build topdir Install dist Nothing Nothing False rest + Mock -> do + putStrLn $ "Mock building" +-+ nvr + cmdlog "fedpkg" ["mockbuild"] + build topdir Mock dist Nothing Nothing False rest + Koji -> do + putStrLn "'koji' mode is deprecated, please use 'chain'" + unless (null rest) $ do + putStrLn $ show (length rest) +-+ "packages left" + putStrLn "" + latest <- kojiLatestPkg tag pkg + if nvr == latest + then do + putStrLn $ nvr +-+ "already built!" + kojiWaitPkg tag nvr + print mlast + build topdir Koji dist Nothing mlast False rest + else do + building <- kojiBuilding pkg nvr + if building + then do + putStrLn $ nvr +-+ "is already building" + kojiWaitPkg tag nvr + build topdir Koji dist Nothing Nothing False rest + else do + print mlast + case mlast of + Nothing -> return () + Just (pkg', nvr') -> do + dep <- dependent pkg' pkg branch topdir + when dep $ do + putStrLn $ "Waiting for" +-+ nvr' + kojiWaitPkg tag nvr' + showChange latest nvr + cmd_ "git" ["push"] + fedpkgBuild dist nvr (if waitrepo then Just tag else Nothing) + bodhiOverride dist nvr + unless (null rest) $ do + dep <- dependent pkg (head rest) branch topdir + when dep $ do + putStrLn $ "Waiting for" +-+ nvr + kojiWaitPkg tag nvr + build topdir Koji dist Nothing (if dep then Just (pkg, nvr) else Nothing) False rest + Pending -> do + latest <- kojiLatestPkg tag pkg + unless (eqNVR nvr latest) $ + putStrLn $ latest +-+ "->" +-+ nvr + build topdir Pending dist Nothing Nothing False rest + Changed -> do + latest <- kojiLatestPkg tag pkg + unless (eqNVR nvr latest) $ + putStrLn pkg + build topdir Changed dist Nothing Nothing False rest + Built -> do + latest <- kojiLatestPkg tag pkg + when (eqNVR nvr latest) $ + putStrLn pkg + build topdir Built dist Nothing Nothing False rest + Chain -> do + latest <- kojiLatestPkg tag pkg + if nvr == latest + then do + putStrLn $ nvr +-+ "already built!" + unless (null rest) $ --do + --kojiWaitPkg tag nvr + build topdir Chain dist Nothing Nothing False rest + else do + building <- kojiBuilding pkg nvr + if building + then do + putStrLn $ nvr +-+ "is already building" + unless (null rest) $ --do + --kojiWaitPkg tag nvr + build topdir Chain dist Nothing Nothing False rest + else do + showChange latest nvr + putStrLn "Repoquerying deps..." + brs <- buildRequires spec + --print brs + -- FIXME sort into build order + let hdeps = filter (\ dp -> "ghc-" `isPrefixOf` dp || dp `elem` ["alex", "cabal-install", "gtk2hs-buildtools", "happy"]) (brs \\ ["ghc-rpm-macros", "ghc-rpm-macros-extra", "ghc-Cabal-devel"]) + --print hdeps + srcs <- filter (`notElem` ["ghc"]) . catMaybes . nub <$> mapM derefSrcPkg hdeps + --print srcs + hmissing <- nub <$> filterM (notInKoji branch topdir tag) srcs + putStrLn "" + unless (null hmissing) $ do + putStrLn "Missing:" + mapM_ putStrLn hmissing + build topdir Chain dist Nothing Nothing True hmissing + setCurrentDirectory $ topdir wd + putStrLn "" + -- note "fedpkg --path dir local" saves .build.log in cwd + cmd_ "git" ["push"] + putStrLn "" + fedpkgBuild dist nvr (if waitrepo then Just tag else Nothing) + bodhiOverride dist nvr + unless (null rest) $ do + putStrLn "" + putStrLn $ show (length rest) +-+ "packages left" + build topdir Chain dist Nothing (Just (pkg, nvr)) waitrepo rest + +pkgDir :: String -> String -> FilePath -> IO FilePath +pkgDir dir branch top = do + b <- doesDirectoryExist $ top dir branch + return $ top dir if b then branch else "" + +maybePkgVer :: String -> Maybe String -> String +maybePkgVer pkg mver = pkg ++ maybe "" ("-" ++) mver + +notInstalled :: String -> IO Bool +notInstalled pkg = + not <$> cmdBool "rpm" ["--quiet", "-q", pkg] + +showChange :: String -> String -> IO () +showChange latest nvr = do + cmd_ "git" ["--no-pager", "log", "-1"] + putStrLn "" + putStrLn $ latest +-+ "->" +-+ nvr ++ "\n" + +fedpkgBuild :: Dist -> String -> Maybe String -> IO () +fedpkgBuild dist nvr waittag = do + cmd_ "fedpkg" $ "build" : maybe [] (\ d -> "--target":[d]) (distTarget dist) + logMsg $ nvr +-+ "built" + maybe (return ()) (`kojiWaitPkg` nvr) waittag + +bodhiOverride :: Dist -> String -> IO () +bodhiOverride dist nvr = + when (distOverride dist) $ + -- FIXME: improve Notes with recursive info + cmd_ "bodhi" ["overrides", "save", "--notes", "Haskell stack", nvr] + +-- dereference meta BRs +whatProvides :: String -> IO String +whatProvides pkg = do + res <- repoquery ["--qf", "%{name}", "--whatprovides"] pkg + --print res + when (null res) $ do + installed <- not <$> notInstalled pkg + unless installed $ putStrLn $ "Warning:" +-+ pkg +-+ "not found by repoquery" + return $ if null res then pkg else res + +buildRequires :: FilePath -> IO [String] +buildRequires spec = + (map (head . words) . lines) <$> cmd "rpmspec" ["-q", "--buildrequires", spec] >>= mapM whatProvides + +derefSrcPkg :: String -> IO (Maybe String) +derefSrcPkg pkg = do + res <- repoquerySrc pkg + --putStrLn $ pkg +-+ "->" +-+ show res + case res of + -- maybe package has never been built yet + Nothing -> do + let base = removeSuffix "-devel" pkg + p <- pkgdb base + if isJust p + then return p + else pkgdb $ removePrefix "ghc-" base + Just s -> return $ Just s + +gitBranch :: IO String +gitBranch = + (removePrefix "* " . head . filter (isPrefixOf "* ") . lines) <$> cmd "git" ["branch"] + +pkgdb :: String -> IO (Maybe String) +pkgdb pkg = do + res <- fmap words <$> cmdMaybe "pkgdb-cli" ["list", "--nameonly", pkg] + return $ case res of + (Just ps) | pkg `elem` ps -> Just pkg + _ -> Nothing + +eqNVR :: String -> String -> Bool +eqNVR p1 p2 = + dropExtension p1 == dropExtension p2 + +-- "pkg = X.Y" -> ["pkg", "=", "X.Y"] -> ("pkg", Just "X.Y") +processDeps :: [String] -> (String, Maybe String) +processDeps [p, "=", v] = (p, Just v) +processDeps (p:_) = (p, Nothing) +processDeps [] = error "processDeps: empty string!" + +dependent :: String -> String -> String -> FilePath -> IO Bool +dependent dep pkg branch topdir = do + pkgpath <- pkgDir pkg branch topdir + cmdBool "grep" ["-q", dep, pkgpath pkg ++ ".spec"] + +displayLogTail :: FilePath -> IO () +displayLogTail f = do + ls <- lines <$> readFile f + let foot = 3 + disp = 12 + start = length ls - (disp + foot) + mapM_ putStrLn $ take disp $ drop start ls diff --git a/fhbz.hs b/fhbz.hs new file mode 100644 --- /dev/null +++ b/fhbz.hs @@ -0,0 +1,167 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- | +-- Module : Bugzilla +-- Copyright : (C) 2014-2017 Jens Petersen +-- +-- Maintainer : Jens Petersen +-- +-- Explanation: Updating of Upstream Release Monitoring bugs + +-- 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. + +module Main where + +#if (defined(MIN_VERSION_base) && MIN_VERSION_base(4,8,2)) +#else +import Control.Applicative ((<$>)) +#endif +import Control.Monad (unless, when) +import Data.Char (isLetter) +import Data.List (dropWhileEnd, intercalate, isPrefixOf) +import Data.Maybe (fromMaybe, listToMaybe) +import Data.Time.Clock (diffUTCTime, getCurrentTime) +import System.Directory ({-doesFileExist, getCurrentDirectory,-} getModificationTime) +import System.Environment (getArgs, getEnv, getProgName) +import System.Console.GetOpt (ArgDescr (..), ArgOrder (..), OptDescr (..), + getOpt, usageInfo) +import System.FilePath (()) + +import Utils ((+-+), cmd, cmd_, cmdStdErr, removePrefix, removeSuffix) + +data BugState = BugState { + bugNo :: String, + component :: String, + status :: String, + summary :: String, + whiteboard :: String + } + +data Flag = Close | Force | DryRun | NoComment | Refresh | State String + deriving (Eq, Show) + +options :: [OptDescr Flag] +options = + [ Option "f" ["force"] (NoArg Force) "update even if no version change (implies --refresh)" + , Option "n" ["dryrun"] (NoArg DryRun) "do not update bugzilla" + , Option "r" ["refresh"] (NoArg Refresh) "update if status changed" + , Option "s" ["state"] (ReqArg State "BUGSTATE") "bug state (default NEW)" + , Option "N" ["no-comment"] (NoArg NoComment) "update the whiteboard only" + , Option "c" ["close"] (NoArg Close) "close bugs whose version is in Rawhide" + ] + +parseOpts :: [String] -> IO ([Flag], [String]) +parseOpts argv = + case getOpt Permute options argv of + (os,ps,[] ) -> return (os,ps) + (_,_,errs) -> do + prog <- getProgName + error $ concat errs ++ usageInfo (header prog) options + where header prog = "Usage:" +-+ prog +-+ "[OPTION...] [package]..." + +main :: IO () +main = do + (opts, args) <- getArgs >>= parseOpts + let state = fromMaybe "NEW" $ listToMaybe $ map (\ (State s) -> s) $ filter (\ o -> case o of (State _) -> True ; _ -> False) opts + bugs <- parseLines . lines <$> bugzillaQuery (["--cc=haskell-devel@lists.fedoraproject.org", "--bug_status=" ++ state, "--short_desc=is available", "--outputformat=%{id}\n%{component}\n%{bug_status}\n%{summary}\n%{status_whiteboard}"] ++ if null args then [] else ["--component=" ++ intercalate "," args]) + mapM_ (checkBug opts) bugs + +bugzillaQuery :: [String] -> IO String +bugzillaQuery args = cmd "bugzilla" ("query":args) + +bugzillaModify :: [String] -> IO () +bugzillaModify args = cmd_ "bugzilla" ("modify":args) + +parseLines :: [String] -> [BugState] +parseLines [] = [] +-- final empty whiteboard eaten by lines +parseLines [bid, bcomp, bst, bsum] = [BugState bid bcomp bst bsum ""] +parseLines (bid:bcomp:bst:bsum:bwh:rest) = + BugState bid bcomp bst bsum bwh : parseLines rest +parseLines _ = error "Bad bugzilla query output!" + +checkBug :: [Flag] -> BugState -> IO () +checkBug opts (BugState bid bcomp _bst bsum bwh) = + unless (bcomp `elem` excludedPkgs) $ do + let hkg = removeGhcPrefix bcomp + (hkgver, state) = colon bwh + pkgver = removeSuffix " is available" bsum + hkgver' = removeGhcPrefix pkgver + unless (null hkgver || hkg `isPrefixOf` hkgver) $ + putStrLn $ "Whiteboard format warning for" +-+ hkgver' ++ ":" +-+ bwh +-+ "<" ++ "http://bugzilla.redhat.com/" ++ bid ++ ">" + -- should not happen! + unless (hkg `isPrefixOf` hkgver') $ + putStrLn $ "Component and Summary inconsistent!" +-+ hkg +-+ hkgver' +-+ "<" ++ "http://bugzilla.redhat.com/" ++ bid ++ ">" + if Close `elem` opts then closeBug opts bid bcomp pkgver else do + let force = Force `elem` opts + refresh = Refresh `elem` opts + when (hkgver /= hkgver' || force || refresh) $ do + updateCabalPackages + (missing, err) <- cmdStdErr "cblrpm" ["missingdeps", hkgver'] + let state' = if null missing && null err then "ok" else "deps" + when ((hkgver, state) /= (hkgver', state') || force) $ do + let statemsg = if null state || state == state' then state' else state +-+ "->" +-+ state' + putStrLn $ if hkgver == hkgver' + then hkgver ++ ":" +-+ statemsg + else (if null bwh then "New" else hkgver +-+ "->") +-+ hkgver' ++ ":" +-+ statemsg + unless (null missing) $ + putStrLn missing + putStrLn "" + unless (DryRun `elem` opts) $ do + let nocomment = NoComment `elem` opts + updateBug bid bcomp hkgver' missing state' nocomment + +excludedPkgs :: [String] +excludedPkgs = ["ghc", "emacs-haskell-mode"] + +removeGhcPrefix :: String -> String +removeGhcPrefix p@('g':'h':'c':'-':rest) | isLetter $ head rest = rest + | otherwise = p +removeGhcPrefix pkg = pkg + +comma :: String -> String +comma nv = reverse eman ++ "," ++ reverse rev + where + (rev, '-':eman) = break (== '-') $ reverse nv + +colon :: String -> (String, String) +colon "" = ("","") +colon ps = (nv, if null s then "" else removePrefix ":" s) + where + (nv, s) = break (== ':') ps + +closeBug :: [Flag] -> String -> String -> String -> IO () +closeBug opts bid bcomp pkgver = do + rawhide <- cmd "koji" ["latest-pkg", "rawhide", bcomp, "--quiet"] + unless (null rawhide) $ do + let nvr = (head . words) rawhide + let nv = removeRelease nvr + when (nv == pkgver) $ do + putStrLn $ "closing" +-+ bid ++ ":" +-+ nv +-+ "in rawhide" + unless (DryRun `elem` opts) $ + bugzillaModify ["--close=RAWHIDE", "--comment=" ++ nvr, bid] + where + removeRelease = init . dropWhileEnd (/= '-') + +updateBug :: String -> String -> String -> String -> String -> Bool -> IO () +updateBug bid _bcomp hkgver missing state nocomment = do +-- rebuilds <- if null missing then tail . lines <$> cmd "cblrepo" ["build", removeGhcPrefix bcomp] else return [] + progname <- getProgName + let comment = progname ++ ":" +-+ + if null missing + then "No missing dependencies for" +-+ hkgver +-+ "\naccording to cblrpm missingdeps" {-++ (if null rebuilds then "\nwithout any other package rebuilds." else ".\n\nIt would require also rebuilding:\n" +-+ unwords rebuilds)-} + else "cblrpm missingdeps output for" +-+ hkgver ++ ":\n\n" ++ missing + bugzillaModify $ ["--whiteboard==" ++ hkgver ++ ":" ++ state] ++ + (if nocomment then [] else ["--comment=" ++ comment]) ++ [bid] + +updateCabalPackages :: IO () +updateCabalPackages = do + home <- getEnv "HOME" + pkgs <- getModificationTime (home ".cabal/packages/hackage.haskell.org/00-index.tar.gz") + now <- getCurrentTime + let diff = diffUTCTime now pkgs + when (diff > 36000) $ + cmd_ "cabal" ["update"] diff --git a/fhpkg.hs b/fhpkg.hs new file mode 100644 --- /dev/null +++ b/fhpkg.hs @@ -0,0 +1,189 @@ +-- | +-- Module : Packages +-- Copyright : (C) 2017 Jens Petersen +-- +-- Maintainer : Jens Petersen +-- Stability : alpha +-- +-- Explanation: Cloning and pulling package git repos + +-- 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. + +-- Todo: +-- cache dist package lists? +-- push subpackages to Hackage +-- compare branch versions +-- compare with LTS +-- arbitrary command +-- query-format string + +module Main where + +#if (defined(MIN_VERSION_base) && MIN_VERSION_base(4,8,2)) +#else +import Control.Applicative ((<$>)) +#endif +import Control.Exception (bracket) +import Control.Monad (unless, when) +import Data.Maybe +import Data.List (isPrefixOf, nub, sort, (\\)) + +import System.Directory (doesDirectoryExist, doesFileExist, + getCurrentDirectory, setCurrentDirectory) +import System.Environment (getArgs, getProgName) +import System.Exit (ExitCode (..), exitWith) +import System.FilePath (()) +import System.IO (hPutStrLn, stderr) +--import System.Posix.Env (getEnv) + +import Dists (Dist, dists, distBranch, releaseVersion) +import Koji (kojiListPkgs) +import Utils ((+-+), cmd, cmd_, cmdBool, removePrefix) + +main :: IO () +main = do + margs <- getArgs >>= parseArgs + case margs of + Nothing -> return () + Just (com, mdist, pkgs) -> do + ps <- if null pkgs then repoqueryHaskell False mdist else return pkgs + case com of + "list" -> mapM_ putStrLn ps + "count" -> print $ length ps + "hackage" -> do + unless (mdist == Just "f27") $ error "Hackage is currently for F27!" + repoqueryHackageCSV mdist ps + "clone" -> do + new <- newPackages mdist ps + repoAction True mdist (new ++ ps) (return ()) + "pull" -> repoAction True mdist ps (cmd_ "git" ["pull", "--rebase"]) + "diff" -> repoAction True mdist ps (cmd_ "git" ["diff"]) + "verrel" -> repoAction False mdist ps (cmd_ "fedpkg" ["verrel"]) + "subpkgs" -> repoAction True mdist ps (cmd "fedpkg" ["gimmespec"] >>= \ p -> cmd_ "rpmspec" ["-q", "--qf", "%{name}-%{version}\n", p]) + "new" -> newPackages mdist ps >>= mapM_ putStrLn + _ -> return () + +commands :: [String] +commands = ["clone", "count", "diff", "hackage", "list", "new", "pull" , "subpkgs", "verrel"] + +help :: IO () +help = do + progName <- getProgName + hPutStrLn stderr $ "Usage:" +-+ progName +-+ "CMD [DIST]\n" + ++ "\n" + ++ "Commands:\n" + ++ " clone\t- clone repos\n" + ++ " pull\t\t- pull repos\n" + ++ " list\t\t- list packages\n" + ++ " count\t\t- count number of packages\n" + ++ " verrel\t\t- show nvr of packages\n" + ++ " subpkgs\t\t- list subpackages\n" + ++ " new\t\t- new unbuilt packages\n" + ++ " hackage\t- generate Hackage distro date\n" + exitWith (ExitFailure 1) + +type Package = String + +type Arguments = Maybe (String, Maybe Dist, [Package]) + +parseArgs :: [String] -> IO Arguments +parseArgs [c] = + if c `elem` commands + then return (Just (c, Nothing, [])) + else giveUp $ "No such command '" ++ c ++ "'" +parseArgs (c:dist:pkgs) | dist `notElem` dists = + giveUp $ "Unknown dist '" ++ dist ++ "'" + | c `notElem` commands = + giveUp $ "No such command '" ++ c ++ "'" + | otherwise = + return $ Just (c, Just dist, pkgs) +parseArgs _ = help >> return Nothing + +giveUp :: String -> IO Arguments +giveUp err = do + hPutStrLn stderr err + help >> return Nothing + + +kojiListHaskell :: Bool -> Maybe Dist -> IO [Package] +kojiListHaskell verbose mdist = do + when verbose $ putStrLn "Getting package list from Koji" + libs <- filter (\ p -> "ghc-" `isPrefixOf` p && p `notElem` ["ghc-rpm-macros", "ghc-srpm-macros"]) <$> kojiListPkgs (fromMaybe "rawhide" mdist) + when (null libs) $ error "No library packages found" + return $ sort $ nub libs + +repoqueryHackageCSV :: Maybe Dist -> [Package] -> IO () +repoqueryHackageCSV mdist pkgs = do + let relver = maybe "rawhide" releaseVersion mdist + -- Hackage csv chokes on final newline so remove it + init . unlines . map (replace "\"ghc-" "\"") . lines <$> cmd "dnf" (["repoquery", "--quiet", "--releasever=" ++ relver, "-q", "--qf=\"%{name}\",\"%{version}\",\"https://apps.fedoraproject.org/packages/%{name}\""] ++ pkgs) >>= putStr + +replace :: Eq a => [a] -> [a] -> [a] -> [a] +replace a b s@(x:xs) = + if a `isPrefixOf` s + then b ++ replace a b (drop (length a) s) + else x:replace a b xs +replace _ _ [] = [] + +repoqueryHaskell :: Bool -> Maybe Dist -> IO [Package] +repoqueryHaskell verbose mdist = do + -- fixme: should use repoquery instead: + base <- cmd "ghc-pkg" ["--simple-output", "list", "base"] + ghcver <- cmd "ghc" ["--numeric-version"] + let relver = maybe "rawhide" releaseVersion mdist + when verbose $ putStrLn "Getting packages from repoquery" + bin <- words <$> cmd "dnf" ["repoquery", "--quiet", "--releasever=" ++ relver, "--whatrequires", "libHS" ++ base ++ "-ghc" ++ ghcver ++ ".so()(64bit)", "--qf=%{source_name}"] + when (null bin) $ error "No libHSbase consumers found!" + return $ sort $ nub bin + +newPackages :: Maybe Dist -> [Package] -> IO [Package] +newPackages mdist ps = do + kps <- kojiListHaskell True mdist + return $ kps \\ ps + +repoAction :: Bool -> Maybe Dist -> [Package] -> IO () -> IO () +repoAction _ _ [] _ = return () +repoAction header mdist (pkg:rest) action = do + bracket getCurrentDirectory setCurrentDirectory $ \ _ -> do + let branchGiven = isJust mdist + branch = maybe "master" distBranch mdist + when header $ + putStrLn $ "\n==" +-+ pkg ++ (if branchGiven then ":" ++ branch else "") +-+ "==" + -- muser <- getEnv "USER" + -- let anon = "-a" + dirExists <- doesDirectoryExist pkg + unless dirExists $ + cmd_ "fedpkg" $ ["clone"] ++ (if branchGiven then ["-b", branch] else ["-B"]) ++ [pkg] + wd <- pkgDir pkg branch "" + setCurrentDirectory wd + pkggit <- do + gd <- doesFileExist ".git/config" + if gd + then cmdBool "grep" ["-q", "pkgs.fedoraproject.org", ".git/config"] + else return False + unless pkggit $ + error $ "not a Fedora pkg git dir!:" +-+ wd + when dirExists $ do + actual <- gitBranch + when (branch /= actual) $ + cmd_ "fedpkg" ["switch-branch", branch] + isDead <- doesFileExist "dead.package" + unless isDead $ do + let spec = pkg ++ ".spec" + hasSpec <- doesFileExist spec + unless hasSpec $ putStrLn "No spec file!" + action + repoAction header mdist rest action + +pkgDir :: String -> String -> FilePath -> IO FilePath +pkgDir dir branch top = do + b <- doesDirectoryExist $ top dir branch + return $ top dir if b then branch else "" + +gitBranch :: IO String +gitBranch = + (removePrefix "* " . head . filter (isPrefixOf "* ") . lines) <$> cmd "git" ["branch"] +