From 9fa4189b09c15c314d47dd1089fb54c56dc73507 Mon Sep 17 00:00:00 2001 From: LordMZTE Date: Tue, 6 Dec 2022 20:27:13 +0100 Subject: [PATCH] initial commit --- .gitignore | 9 + LICENSE | 674 +++++++++++++++++++++++++++++++++++++ README.md | 68 ++++ build.zig | 52 +++ gyro.zzz | 33 ++ src/Manifest.zig | 102 ++++++ src/args.zig | 62 ++++ src/commands/info.zig | 40 +++ src/commands/install.zig | 74 ++++ src/commands/uninstall.zig | 36 ++ src/commands/update.zig | 117 +++++++ src/commands/use.zig | 26 ++ src/dirs.zig | 95 ++++++ src/ffi.zig | 5 + src/log.zig | 40 +++ src/main.zig | 78 +++++ src/net.zig | 368 ++++++++++++++++++++ src/owned_deser_data.zig | 32 ++ 18 files changed, 1911 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 build.zig create mode 100644 gyro.zzz create mode 100644 src/Manifest.zig create mode 100644 src/args.zig create mode 100644 src/commands/info.zig create mode 100644 src/commands/install.zig create mode 100644 src/commands/uninstall.zig create mode 100644 src/commands/update.zig create mode 100644 src/commands/use.zig create mode 100644 src/dirs.zig create mode 100644 src/ffi.zig create mode 100644 src/log.zig create mode 100644 src/main.zig create mode 100644 src/net.zig create mode 100644 src/owned_deser_data.zig diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..509ee3b --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Zig +zig-* + +# Packages +deps.zig + +# Gyro +.gyro/ +gyro.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3a42e2 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# zupper + +A Zig version manager, written in zig. + +## features + +- managing multiple zig installations + - installing zig + - switching zig installations + - removing installations + - automatic updates +- fancy CLI +- concurrent downloading and unpacking +- multi-platform support (actually, not sure about windows xD) +- tiny binary (211 KB) +- few native dependencies +- written in zig + +## building + +### Linux + +Zupper requires `libarchive` and `libcurl` to be installed. +libarchive is used to unpack the compiler toolchain and libcurl for downloading it. +These 2 dependencies will probably be swapped out for zig versions at some point once a suitable library pops up. + +1. Install the dependencies. + +You probably already have them installed, but just to make sure, here are the commands to install them. + +Arch: + +```bash +pacman -S --needed \ + curl \ + libarchive +``` + +Debian: + +```bash +# you don't need to use the openssl version of libcurl +apt install \ + libcurl4-openssl-dev \ + libarchive-dev +``` + +2. Install [gyro](https://github.com/mattnite/gyro) + +Gyro is a zig package manager. It is used by zupper to manage dependencies. + +3. Build it! + +```bash +gyro build -Drelease-fast -p ~/.local +``` + +### macOS + +I'll be honest here, I got no idea. + +You should be able to do it in a similar fashion to Linux. + +### windows + +It might work if you can get the dependencies working. Maybe, I'll add static linking some day. + +As for now, good luck lol. diff --git a/build.zig b/build.zig new file mode 100644 index 0000000..32a9f70 --- /dev/null +++ b/build.zig @@ -0,0 +1,52 @@ +const std = @import("std"); +const pkgs = @import("deps.zig").pkgs; + +pub fn build(b: *std.build.Builder) !void { + // Standard target options allows the person running `zig build` to choose + // what target to build for. Here we do not override the defaults, which + // means any target is allowed, and the default is native. Other options + // for restricting supported target set are available. + const target = b.standardTargetOptions(.{}); + + // Standard release options allow the person running `zig build` to select + // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. + const mode = b.standardReleaseOptions(); + + const exe = b.addExecutable("zupper", "src/main.zig"); + exe.setTarget(target); + exe.setBuildMode(mode); + + exe.strip = mode != .Debug and mode != .ReleaseSafe; + addDeps(exe); + + exe.install(); + + const run_cmd = exe.run(); + run_cmd.step.dependOn(b.getInstallStep()); + if (b.args) |args| { + run_cmd.addArgs(args); + } + + const run_step = b.step("run", "Run the app"); + run_step.dependOn(&run_cmd.step); + + const exe_tests = b.addTest("src/main.zig"); + exe_tests.setTarget(target); + exe_tests.setBuildMode(mode); + addDeps(exe_tests); + + const test_step = b.step("test", "Run unit tests"); + test_step.dependOn(&exe_tests.step); +} + +fn addDeps(exe: *std.build.LibExeObjStep) void { + pkgs.addAllTo(exe); + + exe.linkLibC(); + + // TODO: switch to some zig library, once we get one that supports progress output. + exe.linkSystemLibrary("curl"); + // used to unpack downloaded zig packages + exe.linkSystemLibrary("archive"); +} + diff --git a/gyro.zzz b/gyro.zzz new file mode 100644 index 0000000..fc4acd7 --- /dev/null +++ b/gyro.zzz @@ -0,0 +1,33 @@ +pkgs: + zupper: + version: 0.1.0 + description: Zig version manager + license: GPL-3.0 + source_url: "https://mzte.de/git/LordMZTE/zupper" + root: src/main.zig +deps: + zig-args: + git: + url: "https://github.com/MasterQ32/zig-args" + ref: master + root: args.zig + known-folders: + git: + url: "https://github.com/ziglibs/known-folders" + ref: master + root: known-folders.zig + ansi-term: + git: + url: "https://github.com/ziglibs/ansi-term" + ref: master + root: src/main.zig + getty: + git: + url: "https://github.com/getty-zig/getty.git" + ref: main + root: src/getty.zig + json: + git: + url: "https://github.com/getty-zig/json.git" + ref: main + root: src/json.zig diff --git a/src/Manifest.zig b/src/Manifest.zig new file mode 100644 index 0000000..7002cbf --- /dev/null +++ b/src/Manifest.zig @@ -0,0 +1,102 @@ +const std = @import("std"); +const dirs = @import("dirs.zig"); +const json = @import("json"); +const getty = @import("getty"); + +versions: std.StringHashMap(std.SemanticVersion), + +const Self = @This(); + +pub fn path(alloc: std.mem.Allocator) ![]const u8 { + const home = try dirs.zupperHome(alloc); + defer alloc.free(home); + + return try std.fs.path.join(alloc, &.{ home, "manifest.json" }); +} + +pub fn deinit(self: *Self) void { + getty.de.free(self.versions.allocator, self.*); + self.* = undefined; +} + +pub fn load(alloc: std.mem.Allocator) !Self { + const mpath = try path(alloc); + defer alloc.free(mpath); + + const infile = std.fs.cwd().openFile(mpath, .{}) catch |e| blk: { + if (e != error.FileNotFound) + return e; + + std.log.warn("manifest not found! creating new one.", .{}); + break :blk null; + }; + + if (infile) |f| { + defer f.close(); + + // no support for streaming deserialization :( + const data = try f.readToEndAlloc(alloc, std.math.maxInt(usize)); + defer alloc.free(data); + + const self = json.fromSlice(alloc, Self, data) catch |e| { + std.log.err( + \\failed to deserialize manifest! someone messed with my files! (how dare you!): {s} + \\try deleting '{s}' + , + .{ @errorName(e), mpath }, + ); + return error.Explained; + }; + + return self; + } else { + return .{ + .versions = std.StringHashMap(std.SemanticVersion).init(alloc), + }; + } +} + +pub fn setVersion(self: *Self, k: []const u8, v: ?[]const u8) !void { + const k_d = try self.versions.allocator.dupe(u8, k); + errdefer self.versions.allocator.free(k_d); + + const gopr = try self.versions.getOrPut(k_d); + + if (gopr.found_existing) { + self.versions.allocator.free(k_d); + getty.de.free(self.versions.allocator, gopr.value_ptr.*); + } + + // this is the actual version. this is used in the manifest + // to keep the version of master up to date. + var semver = std.SemanticVersion.parse(v orelse k) catch |e| { + std.log.err("failed to parse zig semver: {s}", .{@errorName(e)}); + return error.Explained; + }; + + // we move the strings in the semver to the manifest allocator so getty can free them + if (semver.pre) |x| semver.pre = try self.versions.allocator.dupe(u8, x); + errdefer if (semver.pre) |x| self.versions.allocator.free(x); + + if (semver.build) |x| semver.build = try self.versions.allocator.dupe(u8, x); + errdefer if (semver.build) |x| self.versions.allocator.free(x); + + gopr.value_ptr.* = semver; +} + +pub fn removeVersion(self: *Self, version: []const u8) void { + if (self.versions.fetchRemove(version)) |kv| { + getty.de.free(self.versions.allocator, kv.key); + getty.de.free(self.versions.allocator, kv.value); + } +} + +pub fn save(self: *Self) !void { + const mpath = try path(self.versions.allocator); + defer self.versions.allocator.free(mpath); + + var outfile = try std.fs.cwd().createFile(mpath, .{}); + defer outfile.close(); + + try json.toWriter(self, outfile.writer()); +} diff --git a/src/args.zig b/src/args.zig new file mode 100644 index 0000000..af412cf --- /dev/null +++ b/src/args.zig @@ -0,0 +1,62 @@ +const std = @import("std"); + +pub const version = "0.1.0"; + +pub const Info = struct {}; + +pub const Install = struct { + use: bool = false, + + pub const shorthands = .{ + .u = "use", + }; +}; + +pub const Uninstall = struct {}; +pub const Update = struct {}; +pub const Use = struct {}; + +pub const Opts = struct { + help: bool = false, + + pub const shorthands = .{ + .h = "help", + }; +}; + +pub const Args = union(enum) { + info: Info, + install: Install, + uninstall: Uninstall, + update: Update, + use: Use, +}; + +const help_s = + \\=== Zupper v{[version]s} - Zig version manager === + \\LordMZTE + \\ + \\Options: + \\ --help, -h show this help + \\ + \\Subcommands: + \\ {[a0]s} info prints information about the setup + \\ {[a0]s} install [--use, -u] downloads the given zig versions and optionally uses them + \\ {[a0]s} update [VERSIONS...] update the given version, or all versions if none are given + \\ {[a0]s} use uses the given version by symlinking the compiler into $PATH + \\ {[a0]s} uninstall uninstall the given versions + \\ +; + +pub fn printHelp(alloc: std.mem.Allocator) !void { + var stdout_buf = std.io.bufferedWriter(std.io.getStdOut().writer()); + defer stdout_buf.flush() catch {}; + + var args = try std.process.argsWithAllocator(alloc); + args.deinit(); + + try stdout_buf.writer().print(help_s, .{ + .a0 = std.fs.path.basename(args.next() orelse return error.BorkedArgs), + .version = version, + }); +} diff --git a/src/commands/info.zig b/src/commands/info.zig new file mode 100644 index 0000000..dca8b57 --- /dev/null +++ b/src/commands/info.zig @@ -0,0 +1,40 @@ +const std = @import("std"); +const dirs = @import("../dirs.zig"); +const args = @import("../args.zig"); +const Args = args.Info; +const Manifest = @import("../Manifest.zig"); + +pub fn run( + alloc: std.mem.Allocator, + manifest: *Manifest, + _: Args, + positionals: []const [:0]const u8, +) !void { + _ = alloc; + + if (positionals.len != 0) { + std.log.err("expected 0 positional arguments, found {}", .{positionals.len}); + return error.Explained; + } + + var stdout_buf = std.io.bufferedWriter(std.io.getStdOut().writer()); + const stdout = stdout_buf.writer(); + + try stdout.print( + "zupper v{s}, running on {s}\n\n", + .{ args.version, @tagName(@import("builtin").os.tag) }, + ); + + if (manifest.versions.count() == 0) { + try stdout.writeAll("no installed versions\n"); + } else { + try stdout.writeAll("installed versions:\n"); + + var iter = manifest.versions.iterator(); + while (iter.next()) |kv| { + try stdout.print("\t{s}\t{}", .{ kv.key_ptr.*, kv.value_ptr.* }); + } + } + + try stdout_buf.flush(); +} diff --git a/src/commands/install.zig b/src/commands/install.zig new file mode 100644 index 0000000..76ad88d --- /dev/null +++ b/src/commands/install.zig @@ -0,0 +1,74 @@ +const std = @import("std"); +const c = @import("../ffi.zig").c; +const dirs = @import("../dirs.zig"); +const net = @import("../net.zig"); +const Args = @import("../args.zig").Install; +const Manifest = @import("../Manifest.zig"); + +pub fn run( + alloc: std.mem.Allocator, + manifest: *Manifest, + args: Args, + positionals: []const [:0]const u8, +) !void { + if (positionals.len < 1) { + std.log.err( + "expected at least 1 positional argument to command 'install', found {}", + .{positionals.len}, + ); + return error.Explained; + } + + if (args.use and positionals.len != 1) { + std.log.err("expected exactly 1 argument when called with the '--use' flag", .{}); + return error.Explained; + } + + const home = try dirs.zupperHome(alloc); + defer alloc.free(home); + + for (positionals) |version| { + if (try dirs.isVersionInstalled(alloc, home, version)) { + std.log.err( + "version '{s}' is already installed! try using the update subcommand to update it.", + .{version}, + ); + return error.Explained; + } + } + + const curl = try net.newCurl(); + defer c.curl_easy_cleanup(curl); + + var version_index = try net.getVersionIndex(alloc, curl); + defer version_index.deinit(); + + for (positionals) |version_arg| { + const version = version_index.data.get(version_arg) orelse { + std.log.err("no such version available!", .{}); + + std.log.info("available versions: ", .{}); + var kiter = version_index.data.keyIterator(); + while (kiter.next()) |v| { + std.log.info("\t{s}", .{v.*}); + } + + return error.Explained; + }; + + const version_file = version.file orelse { + std.log.err("the version '{s}' has no file available for your system!", .{version_arg}); + return error.Explained; + }; + + const install_path = try std.fs.path.join(alloc, &.{ home, "installs", version_arg }); + defer alloc.free(install_path); + + try net.downloadVersionTo(alloc, curl, version_file.tarball, install_path); + try manifest.setVersion(version_arg, version.version); + } + + if (args.use) { + try dirs.useVersion(alloc, home, positionals[0]); + } +} diff --git a/src/commands/uninstall.zig b/src/commands/uninstall.zig new file mode 100644 index 0000000..5e8ef02 --- /dev/null +++ b/src/commands/uninstall.zig @@ -0,0 +1,36 @@ +const std = @import("std"); +const dirs = @import("../dirs.zig"); +const net = @import("../net.zig"); +const Args = @import("../args.zig").Uninstall; +const Manifest = @import("../Manifest.zig"); + +pub fn run( + alloc: std.mem.Allocator, + manifest: *Manifest, + args: Args, + positionals: []const [:0]const u8, +) !void { + _ = args; + + if (positionals.len == 0) { + std.log.err("no arguments provided! need versions to uninstall!", .{}); + return error.Explained; + } + + const home = try dirs.zupperHome(alloc); + defer alloc.free(home); + + for (positionals) |version| { + if (!try dirs.isVersionInstalled(alloc, home, version)) { + std.log.warn("version '{s}' is not installed", .{version}); + continue; + } + + const ver_path = try std.fs.path.join(alloc, &.{ home, "installs", version }); + defer alloc.free(ver_path); + + std.log.info("deleting {s}", .{ver_path}); + manifest.removeVersion(version); + try std.fs.cwd().deleteTree(ver_path); + } +} diff --git a/src/commands/update.zig b/src/commands/update.zig new file mode 100644 index 0000000..5a32ef2 --- /dev/null +++ b/src/commands/update.zig @@ -0,0 +1,117 @@ +const std = @import("std"); +const getty = @import("getty"); +const c = @import("../ffi.zig").c; +const dirs = @import("../dirs.zig"); +const net = @import("../net.zig"); +const Args = @import("../args.zig").Update; +const Manifest = @import("../Manifest.zig"); + +pub fn run( + alloc: std.mem.Allocator, + manifest: *Manifest, + args: Args, + positionals: []const [:0]const u8, +) !void { + _ = args; + + const home = try dirs.zupperHome(alloc); + defer alloc.free(home); + + const curl = try net.newCurl(); + defer c.curl_easy_cleanup(curl); + + var version_index = try net.getVersionIndex(alloc, curl); + defer version_index.deinit(); + + var updated_any = false; + + var manifest_version_iter = manifest.versions.iterator(); + while (manifest_version_iter.next()) |version| { + // if the user provided arguments, only update those versions + if (positionals.len != 0) { + const should_update = blk: { + for (positionals) |version_arg| { + if (std.mem.eql(u8, version_arg, version.key_ptr.*)) + break :blk true; + } + break :blk false; + }; + + if (!should_update) + continue; + } + + const idx_version = version_index.data.get(version.key_ptr.*) orelse { + std.log.warn( + "the installed version '{s}' is not in the version index", + .{version.key_ptr.*}, + ); + continue; + }; + + const version_file = idx_version.file orelse { + std.log.err( + "the version '{s}' has no file available for your system! skipping!", + .{version.key_ptr.*}, + ); + return error.Explained; + }; + + var idx_semver = std.SemanticVersion.parse( + // if the version index doesn't provide a version, we skip it, + // as it's not a version that should auto-update + idx_version.version orelse continue, + ) catch |e| { + std.log.err("failed to parse semantic version in index: {s}", .{@errorName(e)}); + return error.Explained; + }; + + updated_any = true; + + switch (idx_semver.order(version.value_ptr.*)) { + .lt => { + std.log.warn( + \\installed version '{s}' is newer than version in index! + \\thank you for taking zupper on your time travelling adventures! + , + .{version.key_ptr.*}, + ); + continue; + }, + .eq => { + std.log.info("installed version '{s}' is up to date", .{version.key_ptr.*}); + continue; + }, + .gt => {}, + } + + std.log.info("deleting old version for '{s}'", .{version.key_ptr.*}); + + const install_path = try std.fs.path.join(alloc, &.{ home, "installs", version.key_ptr.* }); + defer alloc.free(install_path); + + try std.fs.cwd().deleteTree(install_path); + + try net.downloadVersionTo(alloc, curl, version_file.tarball, install_path); + + getty.de.free(manifest.versions.allocator, version.value_ptr.*); + + // move the strings to the manifest allocator so it + // complies with what getty.de.free expects + // + // we don't use manifest.setVersion here because that'd be kinda dodgy as we're + // iterating the map here + if (idx_semver.pre) |x| idx_semver.pre = try manifest.versions.allocator.dupe(u8, x); + errdefer if (idx_semver.pre) |x| manifest.versions.allocator.free(x); + + if (idx_semver.build) |x| idx_semver.build = try manifest.versions.allocator.dupe(u8, x); + errdefer if (idx_semver.build) |x| manifest.versions.allocator.free(x); + + version.value_ptr.* = idx_semver; + } + + if (!updated_any) { + std.log.err("no versions to update!", .{}); + return error.Explained; + } +} diff --git a/src/commands/use.zig b/src/commands/use.zig new file mode 100644 index 0000000..b245d93 --- /dev/null +++ b/src/commands/use.zig @@ -0,0 +1,26 @@ +const std = @import("std"); +const dirs = @import("../dirs.zig"); +const Args = @import("../args.zig").Use; + +pub fn run( + alloc: std.mem.Allocator, + args: Args, + positionals: []const [:0]const u8, +) !void { + _ = args; + + if (positionals.len != 1) { + std.log.err("expected exactly 1 positional argument", .{}); + return error.Explained; + } + + const home = try dirs.zupperHome(alloc); + defer alloc.free(home); + + if (!try dirs.isVersionInstalled(alloc, home, positionals[0])) { + std.log.err("no such version installed!", .{}); + return error.Explained; + } + + try dirs.useVersion(alloc, home, positionals[0]); +} diff --git a/src/dirs.zig b/src/dirs.zig new file mode 100644 index 0000000..f44349a --- /dev/null +++ b/src/dirs.zig @@ -0,0 +1,95 @@ +const std = @import("std"); +const kf = @import("known-folders"); + +pub fn zupperHome(alloc: std.mem.Allocator) ![]const u8 { + const datapath = (try kf.getPath(alloc, .data)) orelse return error.GetDataFolder; + defer alloc.free(datapath); + + const folder = try std.fs.path.join(alloc, &.{ datapath, "zupper" }); + + // create the folder so subcommands can work with it. + try std.fs.cwd().makePath(folder); + + return folder; +} + +pub fn isVersionInstalled(alloc: std.mem.Allocator, home: []const u8, version: []const u8) !bool { + const path = try std.fs.path.join(alloc, &.{ home, "installs", version }); + defer alloc.free(path); + + std.fs.cwd().access(path, .{}) catch return false; + return true; +} + +pub fn useVersion(alloc: std.mem.Allocator, home: []const u8, version: []const u8) !void { + if (!try isVersionInstalled(alloc, home, version)) { + std.log.err("this version isn't installed! have you tried installing it first?", .{}); + return error.Explained; + } + + const zig_exe_path = try std.fs.path.join(alloc, &.{ + home, + "installs", + version, + comptime "zig" ++ @import("builtin").target.exeFileExt(), + }); + defer alloc.free(zig_exe_path); + + std.fs.cwd().access(zig_exe_path, .{}) catch |e| { + std.log.err( + \\failed to access zig executable @ '{s}': {s} + \\it looks like the version '{s}' might be broken. try uninstalling it. + , + .{ zig_exe_path, @errorName(e), version }, + ); + return error.Explained; + }; + + const target_binary_directory = switch (@import("builtin").os.tag) { + .linux => blk: { + const user_home = (try kf.getPath(alloc, .home)) orelse return error.GetHomeDir; + defer alloc.free(user_home); + break :blk try std.fs.path.join(alloc, &.{ user_home, ".local", "bin" }); + }, + .windows => blk: { + std.log.warn( + \\installing on windows! windows is so bad, it can't get it's conventions + \\for locally installed programs right. i'll use my own install directory... + , + .{}, + ); + + break :blk try std.fs.selfExeDirPathAlloc(alloc); + }, + .macos => blk: { + const user_home = (try kf.getPath(alloc, .home)) orelse return error.GetHomeDir; + defer alloc.free(user_home); + // not sure if this is the correct path. mac got kind of a windowsy situation too + break :blk try std.fs.path.join(alloc, &.{ user_home, "Applications" }); + }, + else => { + std.log.err( + "using a version isn't supported on {s}. please install the zig binary @ '{s}' manually", + .{ @tagName(@import("builtin").os.tag), zig_exe_path }, + ); + + return; + }, + }; + defer alloc.free(target_binary_directory); + + const target_binary = try std.fs.path.join(alloc, &.{ + target_binary_directory, + comptime "zig" ++ @import("builtin").target.exeFileExt(), + }); + defer alloc.free(target_binary); + + std.log.info("installing version '{s}' to '{s}'", .{ version, target_binary }); + + std.fs.cwd().deleteFile(target_binary) catch |e| { + if (e != error.FileNotFound) { + return e; + } + }; + try std.fs.cwd().symLink(zig_exe_path, target_binary, .{}); +} diff --git a/src/ffi.zig b/src/ffi.zig new file mode 100644 index 0000000..131fc12 --- /dev/null +++ b/src/ffi.zig @@ -0,0 +1,5 @@ +pub const c = @cImport({ + @cInclude("archive.h"); + @cInclude("archive_entry.h"); + @cInclude("curl/curl.h"); +}); diff --git a/src/log.zig b/src/log.zig new file mode 100644 index 0000000..af67a7b --- /dev/null +++ b/src/log.zig @@ -0,0 +1,40 @@ +const std = @import("std"); +const at = @import("ansi-term"); + +pub fn log( + comptime level: std.log.Level, + comptime scope: @TypeOf(.EnumLiteral), + comptime format: []const u8, + args: anytype, +) void { + _ = scope; + + var stdout_buf = std.io.bufferedWriter(std.io.getStdOut().writer()); + defer stdout_buf.flush() catch {}; + + const stdout = stdout_buf.writer(); + + const color = switch (level) { + .debug => .Blue, + .info => .Green, + .warn => .Yellow, + .err => .Red, + }; + + const prefix = switch (level) { + .debug => "D: ", + .info => "I: ", + .warn => "W: ", + .err => "E: ", + }; + + at.format.updateStyle( + stdout, + .{ .foreground = color, .font_style = .{ .bold = true } }, + null, + ) catch {}; + stdout.writeAll(prefix) catch {}; + at.format.resetStyle(stdout) catch {}; + + stdout.print(format ++ "\n", args) catch {}; +} diff --git a/src/main.zig b/src/main.zig new file mode 100644 index 0000000..041e71e --- /dev/null +++ b/src/main.zig @@ -0,0 +1,78 @@ +const std = @import("std"); +const zig_args = @import("zig-args"); +const args = @import("args.zig"); +const Manifest = @import("Manifest.zig"); + +pub const log = @import("log.zig").log; + +pub fn main() !u8 { + var gpa = std.heap.GeneralPurposeAllocator(.{}){}; + defer _ = gpa.deinit(); + const alloc = gpa.allocator(); + + const opts = try zig_args.parseWithVerbForCurrentProcess(args.Opts, args.Args, alloc, .print); + defer opts.deinit(); + + if (opts.options.help) { + try args.printHelp(alloc); + return 0; + } + + runCmd(alloc, opts) catch |e| { + switch (e) { + error.Explained => return 1, + else => { + std.log.err("==== UNEXPECTED ERROR (please report bug) ===", .{}); + return e; + }, + } + }; + + return 0; +} + +fn runCmd(alloc: std.mem.Allocator, opts: anytype) !void { + const verb = opts.verb orelse { + std.log.err("no verb provided!", .{}); + try args.printHelp(alloc); + return error.Explained; + }; + + switch (verb) { + .info => |a| { + var manifest = try Manifest.load(alloc); + defer manifest.deinit(); + + try @import("commands/info.zig").run(alloc, &manifest, a, opts.positionals); + + try manifest.save(); + }, + .install => |a| { + var manifest = try Manifest.load(alloc); + defer manifest.deinit(); + + try @import("commands/install.zig").run(alloc, &manifest, a, opts.positionals); + + try manifest.save(); + }, + .update => |a| { + var manifest = try Manifest.load(alloc); + defer manifest.deinit(); + + try @import("commands/update.zig").run(alloc, &manifest, a, opts.positionals); + + try manifest.save(); + }, + .use => |a| { + try @import("commands/use.zig").run(alloc, a, opts.positionals); + }, + .uninstall => |a| { + var manifest = try Manifest.load(alloc); + defer manifest.deinit(); + + try @import("commands/uninstall.zig").run(alloc, &manifest, a, opts.positionals); + + try manifest.save(); + }, + } +} diff --git a/src/net.zig b/src/net.zig new file mode 100644 index 0000000..a2cacc8 --- /dev/null +++ b/src/net.zig @@ -0,0 +1,368 @@ +const std = @import("std"); +const c = @import("ffi.zig").c; +const ansiterm = @import("ansi-term"); +const getty = @import("getty"); +const json = @import("json"); +const OwnedDeserData = @import("owned_deser_data.zig").OwnedDeserData; +const Manifest = @import("Manifest.zig"); + +pub const CurlDataCollector = struct { + data: std.ArrayList(u8), + + pub fn init(alloc: std.mem.Allocator) CurlDataCollector { + return .{ + .data = std.ArrayList(u8).init(alloc), + }; + } + + pub fn deinit(self: *CurlDataCollector) void { + self.data.deinit(); + self.* = undefined; + } + + pub fn setup(self: *CurlDataCollector, curl: *c.CURL) !void { + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_WRITEFUNCTION, &writeCb)); + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_WRITEDATA, &self.data)); + } + + fn writeCb( + data: [*]const u8, + size: usize, + nmemb: usize, + out: *std.ArrayList(u8), + ) callconv(.C) usize { + const realsize = size * nmemb; + out.writer().writeAll(data[0..realsize]) catch return 0; + return realsize; + } +}; + +pub fn newCurl() !*c.CURL { + const curl = c.curl_easy_init() orelse return error.CurlInit; + errdefer c.curl_easy_cleanup(curl); + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_FOLLOWLOCATION, @as(c_long, 1))); + + return curl; +} + +pub const VersionFile = struct { + tarball: [:0]const u8, + + pub const @"getty.dbt" = struct { + pub fn is(comptime T: type) bool { + return T == VersionFile; + } + + pub const attributes = .{ + .Container = .{ .ignore_unknown_fields = true }, + }; + }; +}; + +pub const Version = struct { + /// this field only exists for master + version: ?[]const u8 = null, + + file: ?VersionFile = null, + + pub const @"getty.dbt" = struct { + pub fn is(comptime T: type) bool { + return T == Version; + } + + pub const attributes = .{ + .Container = .{ .ignore_unknown_fields = true }, + .file = .{ + // We deserialize only the file information for the current architecture. + // (Ain't that cool? :P) + .rename = @tagName(@import("builtin").target.cpu.arch) ++ + "-" ++ + @tagName(@import("builtin").os.tag), + }, + }; + }; +}; + +pub const VersionMap = std.StringHashMap(Version); + +pub fn getVersionIndex(alloc: std.mem.Allocator, curl: *c.CURL) !OwnedDeserData(VersionMap) { + std.log.info("getting version index", .{}); + + // don't need progress output for the small version index json + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_NOPROGRESS, @as(c_long, 1))); + defer _ = c.curl_easy_setopt(curl, c.CURLOPT_NOPROGRESS, @as(c_long, 0)); + + var datacoll = CurlDataCollector.init(alloc); + defer datacoll.deinit(); + + try datacoll.setup(curl); + + try handleCurlErr(c.curl_easy_setopt( + curl, + c.CURLOPT_URL, + "https://ziglang.org/download/index.json", + )); + + try handleCurlErr(c.curl_easy_perform(curl)); + + return try OwnedDeserData(VersionMap).fromJson(alloc, datacoll.data.items); +} + +/// concurrently downloads and unpacks a version to the given path +/// `alloc` must be thread-safe! +pub fn downloadVersionTo( + alloc: std.mem.Allocator, + curl: *c.CURL, + url: [:0]const u8, + target: []const u8, +) !void { + std.log.info( + \\downloading version: + \\ /< {s} + \\ \> {s} + , + .{ url, target }, + ); + + const DLState = struct { + fifo: std.fifo.LinearFifo(u8, .Dynamic), + mutex: std.Thread.Mutex, + archive_buf: [1024 * 16]u8, + done: bool, + alloc: std.mem.Allocator, + target: []const u8, + current_filename: [512:0]u8, + + const Self = @This(); + + fn unpackerThread(self: *Self) !void { + const archive = c.archive_read_new(); + defer _ = c.archive_read_free(archive); + + try handleArchiveErr(c.archive_read_support_filter_all(archive), archive); + try handleArchiveErr(c.archive_read_support_format_all(archive), archive); + + try handleArchiveErr(c.archive_read_open( + archive, + self, + null, + &archiveReadCb, + null, + ), archive); + + var buf: [1024 * 4]u8 = undefined; + var entry: ?*c.archive_entry = undefined; + while (c.archive_read_next_header(archive, &entry) == c.ARCHIVE_OK) { + const entry_path = std.mem.span(c.archive_entry_pathname(entry)); + var trimmed_entry_path = entry_path; + + // no need to include the archive name in the path again + if (std.mem.startsWith(u8, entry_path, "zig-")) { + const first_slash = std.mem.indexOfScalar(u8, trimmed_entry_path, '/'); + if (first_slash) |fs| { + if (fs == entry_path.len - 1) { + // if the only slash is at the end, this is the archive root entry. + // we don't need this. + continue; + } + trimmed_entry_path = entry_path[(fs + 1)..]; + } + } + + // TODO: path traversal? + const fpath = try std.fs.path.join(self.alloc, &.{ + self.target, + trimmed_entry_path, + }); + defer self.alloc.free(fpath); + + // entries that end a slash are directories + if (fpath[fpath.len - 1] == '/') { + try std.fs.cwd().makePath(fpath); + continue; + } + + const entry_basename = std.fs.path.basename(trimmed_entry_path); + if (entry_basename.len <= self.current_filename.len) { + // add null terminator + std.mem.set(u8, &self.current_filename, 0); + std.mem.copy(u8, &self.current_filename, entry_basename); + } + + const file = try std.fs.cwd().createFile( + fpath, + .{ .mode = c.archive_entry_mode(entry) }, + ); + defer file.close(); + + while (true) { + const status = c.archive_read_data(archive, &buf, buf.len); + if (status < 0) { + try handleArchiveErr(status, archive); + } else if (status == 0) { + break; + } else { + try file.writeAll(buf[0..@intCast(usize, status)]); + } + } + } + } + + fn archiveReadCb( + archive: ?*c.archive, + udata: ?*anyopaque, + buf: [*c]?*const anyopaque, + ) callconv(.C) isize { + _ = archive; + + const self = @ptrCast(*Self, @alignCast(@alignOf(Self), udata)); + + buf.* = &self.archive_buf; + + while (true) { + const read = blk: { + self.mutex.lock(); + defer self.mutex.unlock(); + + break :blk self.fifo.read(&self.archive_buf); + }; + + // if we're not done and haven't got any data, we're blocked on the network side. + if (read == 0 and !self.done) { + std.time.sleep(5 * std.time.ns_per_ms); + continue; + } + + return @intCast(isize, read); + } + } + + fn curlWriteCb( + data: [*]const u8, + size: usize, + nmemb: usize, + self: *Self, + ) callconv(.C) usize { + self.mutex.lock(); + defer self.mutex.unlock(); + const realsize = size * nmemb; + self.fifo.write(data[0..realsize]) catch |e| { + std.log.err( + \\critical memory allocation error in version download write callback. + \\somethings incredibly borked: {} + , + .{e}, + ); + return 0; + }; + return realsize; + } + + fn curlXferinfoCb( + self: *Self, + dltotal: c.curl_off_t, + dlnow: c.curl_off_t, + ultotal: c.curl_off_t, + ulnow: c.curl_off_t, + ) callconv(.C) usize { + _ = ultotal; + _ = ulnow; + + const percent = @intCast(u8, if (dltotal != 0) @divTrunc(dlnow * 100, dltotal) else 0); + + var stdout_buf = std.io.bufferedWriter(std.io.getStdOut().writer()); + defer stdout_buf.flush() catch {}; + + const stdout = stdout_buf.writer(); + + ansiterm.clear.clearCurrentLine(stdout) catch {}; + ansiterm.cursor.setCursorColumn(stdout, 0) catch {}; + + ansiterm.format.updateStyle( + stdout, + .{ .foreground = .Green, .font_style = .{ .bold = true } }, + null, + ) catch {}; + + stdout.print("[{d:3}%] ", .{percent}) catch {}; + + ansiterm.format.updateStyle( + stdout, + .{ .foreground = .Blue }, + .{ .foreground = .Green, .font_style = .{ .bold = true } }, + ) catch {}; + stdout.writeAll(&self.current_filename) catch {}; + + ansiterm.format.resetStyle(stdout) catch {}; + + return 0; + } + }; + + const state = try alloc.create(DLState); + defer alloc.destroy(state); + + state.* = DLState{ + .fifo = std.fifo.LinearFifo(u8, .Dynamic).init(alloc), + .mutex = .{}, + .archive_buf = undefined, + .done = false, + .alloc = alloc, + .target = target, + .current_filename = std.mem.zeroes([512:0]u8), + }; + defer state.fifo.deinit(); + errdefer state.done = true; + + try std.fs.cwd().makePath(target); + + const thread = try std.Thread.spawn(.{}, DLState.unpackerThread, .{state}); + defer thread.join(); + + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_URL, url.ptr)); + + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_WRITEFUNCTION, &DLState.curlWriteCb)); + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_WRITEDATA, state)); + + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_XFERINFODATA, state)); + try handleCurlErr(c.curl_easy_setopt(curl, c.CURLOPT_XFERINFOFUNCTION, &DLState.curlXferinfoCb)); + + try handleCurlErr(c.curl_easy_perform(curl)); + + var response_code: c_long = 0; + try handleCurlErr(c.curl_easy_getinfo(curl, c.CURLINFO_RESPONSE_CODE, &response_code)); + if (response_code != 200) { + std.log.err("download returned HTTP code {}", .{response_code}); + } + + // complete xferinfofunction output + const stdout = std.io.getStdOut().writer(); + ansiterm.format.updateStyle( + stdout, + .{ .foreground = .Green, .font_style = .{ .bold = true } }, + null, + ) catch {}; + ansiterm.cursor.setCursorColumn(stdout, 0) catch {}; + ansiterm.clear.clearCurrentLine(stdout) catch {}; + stdout.writeAll("[100%]\n") catch {}; + ansiterm.format.resetStyle(stdout) catch {}; + + state.done = true; +} + +fn handleCurlErr(code: c.CURLcode) !void { + if (code != c.CURLE_OK) { + std.log.err("curl: {s}", .{c.curl_easy_strerror(code)}); + return error.Explained; + } +} + +fn handleArchiveErr(err: c_long, archive: ?*c.archive) !void { + if (err != c.ARCHIVE_OK) { + if (archive) |ar| { + if (c.archive_error_string(ar)) |err_s| + std.log.err("archive: {s}", .{err_s}); + } + return error.Explained; + } +} diff --git a/src/owned_deser_data.zig b/src/owned_deser_data.zig new file mode 100644 index 0000000..df01eb1 --- /dev/null +++ b/src/owned_deser_data.zig @@ -0,0 +1,32 @@ +const std = @import("std"); +const json = @import("json"); + +/// a super handy data type that wraps some data deserialized using getty-json with +/// an arena allocator for memory management. +pub fn OwnedDeserData(comptime T: type) type { + return struct { + data: T, + arena: std.heap.ArenaAllocator, + + const Self = @This(); + + pub fn deinit(self: *Self) void { + self.arena.deinit(); + self.* = undefined; + } + + pub fn fromJson(alloc: std.mem.Allocator, json_data: []const u8) !Self { + // we use an arena here, even though getty does provide it's own deinit function for + // deserialized data, I've never observed that actually clean everything up :P + var arena = std.heap.ArenaAllocator.init(alloc); + errdefer arena.deinit(); + + const data = try json.fromSlice(arena.allocator(), T, json_data); + + return .{ + .data = data, + .arena = arena, + }; + } + }; +}