From ab580d6a1888481f5438e3214072e81cdf162e42 Mon Sep 17 00:00:00 2001 From: ngn Date: Fri, 2 May 2025 18:20:24 +0300 Subject: [PATCH] initial commit Signed-off-by: ngn --- .gitea/workflows/format.yml | 23 ++ .gitignore | 3 + LICENSE.txt | 674 ++++++++++++++++++++++++++++++++++++ Makefile | 40 +++ README.md | 96 +++++ lib/__init__.py | 90 +++++ lib/config.py | 81 +++++ lib/gitea.py | 63 ++++ lib/github.py | 58 ++++ lib/log.py | 40 +++ lib/provider.py | 78 +++++ lib/util.py | 16 + pyproject.toml | 25 ++ scripts/apply.sh | 73 ++++ scripts/check.py | 43 +++ scripts/commit.sh | 23 ++ scripts/update.py | 56 +++ 17 files changed, 1482 insertions(+) create mode 100644 .gitea/workflows/format.yml create mode 100644 .gitignore create mode 100644 LICENSE.txt create mode 100644 Makefile create mode 100644 README.md create mode 100644 lib/__init__.py create mode 100644 lib/config.py create mode 100644 lib/gitea.py create mode 100644 lib/github.py create mode 100644 lib/log.py create mode 100644 lib/provider.py create mode 100644 lib/util.py create mode 100644 pyproject.toml create mode 100644 scripts/apply.sh create mode 100644 scripts/check.py create mode 100644 scripts/commit.sh create mode 100644 scripts/update.py diff --git a/.gitea/workflows/format.yml b/.gitea/workflows/format.yml new file mode 100644 index 0000000..0b7e169 --- /dev/null +++ b/.gitea/workflows/format.yml @@ -0,0 +1,23 @@ +name: format + +on: + push: + branches: + - "main" + paths-ignore: + - "README.md" + - "LICENSE.txt" + - "pyproject.toml" + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: "https://github.com/actions/checkout@v4" + + - name: Install black formatter + run: sudo apt install black + + - name: Check formatting + run: make check diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4eb2b81 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +dist +__pycache__ +*.egg-info diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE.txt @@ -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/Makefile b/Makefile new file mode 100644 index 0000000..6840221 --- /dev/null +++ b/Makefile @@ -0,0 +1,40 @@ +SCRIPTS = $(patsubst scripts/%.py,ups-%,$(wildcard scripts/*.py)) +SCRIPTS += $(patsubst scripts/%.sh,ups-%,$(wildcard scripts/*.sh)) + +PY_SRCS = $(wildcard lib/*.py) +VERSION = $(shell grep 'version' pyproject.toml | cut -d' ' -f3 | sed 's/"//g') +WHEEL = dist/ups-$(VERSION)-py3-none-any.whl + +PYTHON = python3 +DESTDIR = ~/.local/bin + +all: $(WHEEL) + +$(WHEEL): $(PY_SRCS) pyproject.toml + python3 -m build + +install: $(SCRIPTS) + $(PYTHON) -m pip install --force-reinstall \ + --break-system-packages $(WHEEL) + +ups-%: scripts/%.py + install -Dm755 $< $(DESTDIR)/$@ + +ups-%: scripts/%.sh + install -Dm755 $< $(DESTDIR)/$@ + +uninstall: + for script in $(TARGETS); do \ + rm -f $(DESTDIR)/$$script; \ + done + +format: + black -l 80 */*.py + +check: + black --check -l 80 */*.py + +clean: + rm -rf dist + +.PHONY: install uninstall format check clean diff --git a/README.md b/README.md new file mode 100644 index 0000000..c6ee1e3 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# ups | upstream scripts + +![](https://git.ngn.tf/ngn/ups/actions/workflows/format.yml/badge.svg) + +collection of bash and python scripts for pulling and managing patches from the +upstream git repos of my personal forks + +## installation + +you'll need the following dependencies to install and use ups: + +- make +- pypa build package +- git +- python(3) +- python requests module +- GNU bash coreutils +- sed + +after installing these tools, you can just clone the main branch and run the +make script to build python library, then you can run the install make script to +install the library and the scripts: + +```bash +git clone https://git.ngn.tf/ngn/ups +cd ups +make && make install +``` + +## usage + +first navigate to your repo and a `ups.json` file + +this file should specify the upstream URL, and the provider for the upstream, +currently gitea and github are the only supported providers + +for example here is my configuration for the +[4get repo](https://git.ngn.tf/ngn/4get): + +```json +{ + "upstream": "https://git.lolcat.ca/lolcat/4get", + "provider": "gitea" +} +``` + +you should also specify the last commit you got from upstream, unless you are on +the last commit: + +```json +... + "commit": "78aa2e198f11ca928891ec83ef97d2445147414a" +... +``` + +now to check for any upstream commits, you run `ups-check`, this script simply +checks the last commit and compares it to the commit you specified in the +configuration + +if you did not specfiy a commit it assumes you are on the latest commit, +otherwise it compares the last commit ID with the current commit ID to see if +you are on the latest commit + +if this is not the case, then it checks how many commits have been made between +these two commits + +to actually apply these commits to your repo, as in the form of patches, you +need to run `ups-update` + +this script will download all the commits as patches, and give you and option to +modify or skip them before applying them + +it will also update the commit hash you specified in the configuration, when you +apply all the commits you want, you'll also need to run `ups-commit` in order to +commit the changes made to your configuration file + +### scripts + +ups allows you to run custom sed script on the commit patches before applying +them, so you don't need to edit all of them just to do some simple modifications +every time + +for example, in the [4get repo](https://git.ngn.tf/ngn/4get), i placed all the +php source code to `src` directory, which is not the case in the upstream + +so i added these two scripts to my configuration to automatically fix the diff +paths of the patches: + +```json +... + "scripts": [ + "s/--- a\\//--- a\\/src\\//g", + "s/+++ b\\//+++ b\\/src\\//g" + ] +... +``` diff --git a/lib/__init__.py b/lib/__init__.py new file mode 100644 index 0000000..7dbf9b6 --- /dev/null +++ b/lib/__init__.py @@ -0,0 +1,90 @@ +from .provider import provider +from .config import config + +from .gitea import gitea +from .github import github + +from os import remove, listdir, rmdir +from tempfile import mkdtemp +from os.path import join +import subprocess as sp +from typing import List +import atexit + +PROVIDERS = { + "gitea": gitea, + "github": github, +} + + +class upstream: + def __init__(self, dir=".") -> None: + self.config: config = config(dir=dir) + self.provider: provider + self._tempdir: str = "" + + url = self.config.url("upstream") + prov = self.config.str("provider") + + for n, p in PROVIDERS.items(): + if n == prov.lower(): + self.provider = p(url) + break + + if self.provider is None: + raise Exception("invalid provider %s" % provider) + + if not self.provider.check(): + raise Exception("upstream is not available") + + # self.cleanup() will run when the program exits + atexit.register(self.cleanup) + + def tempdir(self, path="") -> str: + if self._tempdir == "": + self._tempdir = mkdtemp(prefix="ups_") + return self._tempdir if path == "" else join(self._tempdir, path) + + def commit(self, commit="") -> str: + if commit != "": + self.config.set_str("commit", commit) + return commit + return self.config.str("commit") + + def until(self, until: str) -> List[str]: + return self.provider.until(until) + + def last(self, count=1) -> List[str]: + return self.provider.last(count) + + # download a patch for the commit and run all the scripts on it + def download(self, commit: str) -> str: + path = self.tempdir("%s.patch" % commit) + self.provider.download(commit, path) + + for s in self.config.list("scripts"): + proc = sp.run(["sed", "-e", s, "-i", path], stderr=sp.PIPE) + if proc.returncode != 0: + raise Exception("script '%s': %s" % (s, proc.stderr)) + + return path + + # apply the patch file using ups-apply + def apply(self, commit: str) -> None: + path = self.tempdir("%s.patch" % commit) + proc = sp.run(["ups-apply", path]) + + if proc.returncode != 0: + raise Exception( + "apply script returned non-zero exit code: %d" % proc.returncode + ) + + # cleanup the temp directory + def cleanup(self) -> None: + if self._tempdir == "": + return + + for f in listdir(self._tempdir): + remove(join(self._tempdir, f)) + + rmdir(self._tempdir) diff --git a/lib/config.py b/lib/config.py new file mode 100644 index 0000000..308ac05 --- /dev/null +++ b/lib/config.py @@ -0,0 +1,81 @@ +from .util import validate_url, validate_list +from os import getcwd, path +from typing import List +import json + +CONFIG_FILE = "ups.json" + + +class config: + def __init__(self, dir="") -> None: + if dir == "": + dir = getcwd() + + self.path = path.join(dir, CONFIG_FILE) + self.conf = {} + + self.load() + + # load the configuration from the file + def load(self) -> None: + try: + f = open(self.path, "r") + content = f.read() + f.close() + except Exception as e: + raise Exception("failed to read config: %s" % e) + else: + self.conf = json.loads(content) + f.close() + + # save the current configuration + def save(self) -> None: + content = json.dumps(self.conf, indent=2) + + try: + f = open(self.path, "w") + f.write(content) + f.close() + except Exception as e: + raise Exception("failed to save config: %s" % e) + + # set a URL key in the configuration + def set_url(self, key: str, val: str) -> None: + if not validate_url(val): + raise Exception("expected a valid URL for %s" % key) + + self.conf[key] = val + self.save() + + # set a string key in the configuration + def set_str(self, key: str, val: str) -> None: + if val == "" or val is None: + raise Exception("expected a non-empty string for %s" % key) + + self.conf[key] = val + self.save() + + def set_list(self, key: str, val: List[str]) -> None: + if not validate_list(val): + raise Exception("expected a non-empty list for %s" % key) + + self.conf[key] = val + self.save() + + # read a URL key from the configuration + def url(self, key: str) -> str: + if key not in self.conf.keys() or not validate_url(self.conf[key]): + return "" + return self.conf[key] + + # read a string key from the configuration file + def str(self, key: str) -> str: + if key not in self.conf.keys(): + return "" + return self.conf[key] + + # read a list from the configuration file + def list(self, key: str) -> List[str]: + if key not in self.conf.keys() or not validate_list(self.conf[key]): + return [] + return self.conf[key] diff --git a/lib/gitea.py b/lib/gitea.py new file mode 100644 index 0000000..6f24be1 --- /dev/null +++ b/lib/gitea.py @@ -0,0 +1,63 @@ +from .provider import provider +from urllib import request +from typing import List + +COMMITS_URL = "PROTO://HOST/api/v1/repos/OWNER/REPO/commits" +REPO_URL = "PROTO://HOST/api/v1/repos/OWNER/REPO" +PATCH_URL = "" + + +class gitea(provider): + def __init__(self, url: str) -> None: + super().__init__(url) + + def check(self) -> bool: + res = self.GET(REPO_URL) + return not res["private"] + + def until(self, commit: str) -> List[str]: + commits = [] + found = False + page = 1 + + while not found: + res = self.GET( + COMMITS_URL, + { + "limit": 50, + "stat": False, + "page": page, + }, + ) + + if len(res) <= 0: + break + + for c in res: + if c["sha"] == commit: + found = True + break + commits.append(c["sha"]) + + page += 1 + + return commits + + def last(self, count=1) -> List[str]: + commits = [] + res = self.GET( + COMMITS_URL, + { + "limit": count, + "stat": False, + }, + ) + + [commits.append(c["sha"]) for c in res] + return commits + + def download(self, commit: str, file: str) -> None: + url = self.url( + "PROTO://HOST/api/v1/repos/OWNER/REPO/git/commits/%s.patch" % commit + ) + request.urlretrieve(url, file) diff --git a/lib/github.py b/lib/github.py new file mode 100644 index 0000000..7b073a9 --- /dev/null +++ b/lib/github.py @@ -0,0 +1,58 @@ +from .provider import provider +from urllib import request +from typing import List + +REPO_URL = "https://api.github.com/repos/OWNER/REPO" +COMMITS_URL = "https://api.github.com/repos/OWNER/REPO/commits" + + +class github(provider): + def __init__(self, url: str) -> None: + super().__init__(url) + + def check(self) -> bool: + res = self.GET(REPO_URL) + return res["full_name"] == "%s/%s" % (self.owner, self.repo) + + def until(self, commit: str) -> List[str]: + commits = [] + found = False + page = 1 + + while not found: + res = self.GET( + COMMITS_URL, + { + "per_page": 50, + "page": page, + }, + ) + + if len(res) <= 0: + break + + for c in res: + if c["sha"] == commit: + found = True + break + commits.append(c["sha"]) + + page += 1 + + return commits + + def last(self, count=1) -> List[str]: + commits = [] + res = self.GET( + COMMITS_URL, + { + "per_page": count, + }, + ) + + [commits.append(c["sha"]) for c in res] + return commits + + def download(self, commit: str, file: str) -> None: + url = self.url("PROTO://github.com/OWNER/REPO/commit/%s.patch" % commit) + request.urlretrieve(url, file) diff --git a/lib/log.py b/lib/log.py new file mode 100644 index 0000000..7ca05f1 --- /dev/null +++ b/lib/log.py @@ -0,0 +1,40 @@ +from time import strftime, localtime +from sys import stdout, stderr +from os import path +import inspect + +BLUE = "\033[34m" +YELLOW = "\033[33m" +RED = "\033[31m" +RESET = "\033[0m" + + +def _log(color: str, level: str, msg: str, err=False) -> int: + frame = inspect.stack()[2] + filename = path.basename(inspect.getmodule(frame[0]).__file__) + + timestr = strftime("%H:%M:%S", localtime()) + funcstr = "%s:%d" % (filename, frame.lineno) + + write = stderr.write if err else stdout.write + return write( + "%s[%s]%s %s %s: %s\n" + % (color, level.lower(), RESET, timestr, funcstr, msg) + ) + + +def info(msg: str) -> None: + _log(BLUE, "info", msg) + + +def warn(msg: str) -> None: + _log(YELLOW, "warn", msg, err=True) + + +def fail(msg: str, exception=None) -> None: + size = _log(RED, "fail", msg, err=True) + + if exception is not None: + size -= len(msg) + len(RED) + len(RESET) + 1 + len("details: ") + stderr.write(" " * size + "details: ") + stderr.write(exception.__str__() + "\n") diff --git a/lib/provider.py b/lib/provider.py new file mode 100644 index 0000000..2864128 --- /dev/null +++ b/lib/provider.py @@ -0,0 +1,78 @@ +from os.path import dirname, basename +from urllib.parse import urlencode +import urllib.parse as urlparse +from .util import validate_url +import requests as req +from typing import List + + +class provider: + def __init__(self, url: str) -> None: + parsed = validate_url(url) + + if parsed is None: + raise Exception("invalid provider URL: %s" % url) + + self.host = parsed.hostname + self.protocol = parsed.scheme + self.owner = dirname(parsed.path) + self.repo = basename(parsed.path) + + if self.owner[0] == "/": + self.owner = self.owner[1:] + + if self.repo[0] == "/": + self.repo = self.repo[1:] + + if self.owner == "" or self.repo == "": + raise Exception("invalid provider URL: %s" % url) + + def url(self, url: str, queries={}) -> str: + url = url.replace("HOST", self.host) + url = url.replace("PROTO", self.protocol) + url = url.replace("OWNER", self.owner) + url = url.replace("REPO", self.repo) + + parsed = list(urlparse.urlparse(url)) + + query = dict(urlparse.parse_qsl(parsed[4])) + query.update(queries) + + parsed[4] = urlencode(query) + url = urlparse.urlunparse(parsed) + + return url + + # send a HTTP GET request to the provider + def GET(self, url: str, queries={}, code=200) -> dict: + url = self.url(url, queries=queries) + + # res = req.get(url, headers={ + # "User-Agent": "ups (https://git.ngn.tf/ngn/ups)", + # }) + + res = req.get(url) + + if res.status_code != code: + raise Exception( + "expected %d from %s, received %d" + % (code, url, res.status_code) + ) + + return res.json() + + # check if the provider is available + def check(self) -> bool: + return False + + # get all the commits until the target commit + def until(self, commit: str) -> List[str]: + return [] + + # get last "count" commits + def last(self, count=1) -> List[str]: + return [] + + # download the patch for a commit + def download(self, commit: str, file: str) -> None: + return False diff --git a/lib/util.py b/lib/util.py new file mode 100644 index 0000000..a8aef33 --- /dev/null +++ b/lib/util.py @@ -0,0 +1,16 @@ +from urllib.parse import urlparse, ParseResult +from typing import List + + +def validate_url(url: str) -> ParseResult: + try: + parsed = urlparse(url) + if all([parsed.scheme, parsed.netloc]): + return parsed + return None + except Exception: + return None + + +def validate_list(_list: List[str]) -> bool: + return _list is not None and len(_list) != 0 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..658c01e --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,25 @@ +[project] +name = "ups" +version = "1.0" +authors = [ + { name="ngn", email="ngn@ngn.tf" }, +] +description = "upstream scripts python library" +readme = "README.md" +license = "GPL-3.0" +license-files = ["LICENSE.txt"] +#dependencies = ["requests"] + +[project.urls] +Homepage = "https://git.ngn.tf/ups" +Issues = "https://git.ngn.tf/ups/issues" + +[build-system] +requires = ["setuptools >= 77.0.3"] +build-backend = "setuptools.build_meta" + +[tool.setuptools] +packages = ["ups"] + +[tool.setuptools.package-dir] +ups = "lib" diff --git a/scripts/apply.sh b/scripts/apply.sh new file mode 100644 index 0000000..5e69c2d --- /dev/null +++ b/scripts/apply.sh @@ -0,0 +1,73 @@ +#!/bin/bash + +BLUE="\e[34m" +YELLOW="\e[33m" +RED="\e[31m" +BOLD="\e[1m" +GREEN="\e[32m" +RESET="\e[0m" + +if [ $# -ne 1 ]; then + echo "please specify a patch file" + exit 1 +fi + +if [ ! -f "${1}" ]; then + echo "specified patch file does not exist" + exit 1 +fi + +from="$(grep "From: " "${1}" | sed 's/From: //g')" +title="$(grep "Subject: \[PATCH\] " "${1}" | sed 's/Subject: \[PATCH\] //g')" + +applied=0 +code=0 + +echo +echo -e "${BOLD}${GREEN}From ${RESET}${BOLD}:${RESET} ${from}" +echo -e "${BOLD}${GREEN}Title${RESET}${BOLD}:${RESET} ${title}" +echo + +while true; do + echo -en "${BOLD}(${BLUE}E${RESET}${BOLD})dit " + echo -en "${BOLD}(${BLUE}A${RESET}${BOLD})pply " + [ $applied -eq 1 ] && echo -en "${BOLD}(${BLUE}U${RESET}${BOLD})ndo " + echo -en "${BOLD}(${BLUE}S${RESET}${BOLD})kip " + echo -en "${BOLD}(${BLUE}C${RESET}${BOLD})ancel " + + read -s -n1 answer + echo -en "\r \r" + + case "${answer,,}" in + "e") + $EDITOR "${1}" + ;; + + "a") + #git apply --reject --whitespace=fix "${1}" && break + git am --reject --whitespace=fix "${1}" && break + applied=1 + ;; + + "u") + git am --abort + ;; + + "s") + break + ;; + + "c") + code=1 + break + ;; + + *) + if [ ! -z "${answer}" ]; then + echo -e "${BOLD}Please enter a valid answer${RESET}" + fi + ;; + esac +done + +exit $code diff --git a/scripts/check.py b/scripts/check.py new file mode 100644 index 0000000..56c6a9d --- /dev/null +++ b/scripts/check.py @@ -0,0 +1,43 @@ +#!/bin/python3 + +from ups import log +import ups + + +def check(dir=".") -> bool: + try: + us = ups.upstream(dir=dir) + except Exception as e: + log.fail("failed to create ups upstream", exception=e) + return False + + try: + commits = us.last() + except Exception as e: + log.fail("failed to get commits: %s" % e) + return False + + if len(commits) == 0: + log.info("upstream does not have any commits") + return True + + last_commit = commits[0] + saved_commit = us.commit() + + if saved_commit == "": + log.warn("no commit specified, assuming we are on the latest commit") + us.commit(last_commit) + return False + + if saved_commit == last_commit: + log.info("up-to-date with the upstream") + return True + + commits = us.until(saved_commit) + log.warn("%d commits behind the upstream" % len(commits)) + log.info("run ups-update to pull & apply patches") + return False + + +if "__main__" == __name__: + exit(0 if check() else 1) diff --git a/scripts/commit.sh b/scripts/commit.sh new file mode 100644 index 0000000..358087b --- /dev/null +++ b/scripts/commit.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +if [ ! -f ups.json ]; then + echo "ups.json not found" + exit 1 +fi + +git add ups.json + +if git diff --exit-code --cached &> /dev/null; then + echo "no updates for ups.json" + exit 1 +fi + +diff=$(git blame ups.json | grep 'Not Committed Yet' | grep '"commit"') + +if [ -z "${diff}" ]; then + echo "no updates for ups.json" + exit 1 +fi + +commit=$(echo "${diff}" | awk '{print $10}' | sed -e 's/"//g' -e 's/,//g') +git commit -m "ups: update to ${commit:0:7}" diff --git a/scripts/update.py b/scripts/update.py new file mode 100644 index 0000000..97434ad --- /dev/null +++ b/scripts/update.py @@ -0,0 +1,56 @@ +#!/bin/python3 + +from ups import log +import ups + + +def update(dir="."): + try: + us = ups.upstream(dir=dir) + except Exception as e: + log.fail("failed to create ups upstream", exception=e) + return False + + commit = us.commit() + + if commit == "": + log.fail("no commit specified") + return False + + commits = us.until(commit) + commits.reverse() + + if len(commits) == 0: + log.info("already up-to-date") + return False + + log.info("got total of %d commits" % len(commits)) + + # attempt to apply all the commits + for i, c in enumerate(commits): + # download the patch for the commit + try: + log.info( + "(%d/%d) downloading patch for %s" % (i + 1, len(commits), c) + ) + us.download(c) + except Exception as e: + log.fail("failed to download: %s" % c, exception=e) + return False + + # apply the downloaded patch + try: + log.info("(%d/%d) applying patch for %s" % (i + 1, len(commits), c)) + us.apply(c) + except Exception as e: + log.fail("failed to apply %s" % c, exception=e) + return False + + # update the last commit + us.commit(c) + + log.info("now up-to-date with the upstream") + + +if "__main__" == __name__: + exit(0 if update() else 1)