Compare commits
5 Commits
f1efd72fcb
...
3b26ff9fc1
| Author | SHA1 | Date |
|---|---|---|
|
|
3b26ff9fc1 | 3 weeks ago |
|
|
521b862919 | 3 weeks ago |
|
|
bd789ab18d | 3 weeks ago |
|
|
d296e00fd6 | 3 weeks ago |
|
|
e165558262 | 3 weeks ago |
22 changed files with 1927 additions and 74 deletions
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE |
||||
Version 3, 29 June 2007 |
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
||||
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. |
||||
|
||||
<one line to give the program's name and a brief idea of what it does.> |
||||
Copyright (C) <year> <name of author> |
||||
|
||||
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 <https://www.gnu.org/licenses/>. |
||||
|
||||
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: |
||||
|
||||
<program> Copyright (C) <year> <name of author> |
||||
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 |
||||
<https://www.gnu.org/licenses/>. |
||||
|
||||
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 |
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>. |
||||
@ -1,9 +1,222 @@
|
||||
# declpac |
||||
|
||||
`declpac` syncs a declarative package list with the `pacman` package manager. |
||||
`declpac` is a declarative package manager for Arch Linux that syncs your system |
||||
with a declared package list using `pacman`. It ensures your system matches your |
||||
desired state, handling package installation, upgrades, and orphan cleanup |
||||
automatically. |
||||
|
||||
## Building |
||||
## Features |
||||
|
||||
- **Declarative state management** — Define your desired package list in files or stdin |
||||
- **Automatic dependency resolution** — Pacman handles transitive dependencies |
||||
- **Smart orphan cleanup** — Removes packages no longer needed |
||||
- **Explicit package tracking** — Marks your declared packages as explicit |
||||
- **AUR support** — Falls back to AUR for packages not in official repos |
||||
- **Machine-readable output** — Perfect for scripting and automation |
||||
|
||||
## Installation |
||||
|
||||
### Build from Source |
||||
|
||||
```bash |
||||
git clone https://github.com/Riyyi/declpac.git |
||||
cd declpac |
||||
go build -o declpac ./cmd/declpac |
||||
sudo mv declpac /usr/local/bin/ |
||||
``` |
||||
|
||||
### Dependencies |
||||
|
||||
- go |
||||
- Go 1.21+ |
||||
- pacman (system package manager) |
||||
- aur (AUR helper, optional for AUR support) |
||||
- Root privileges (required for pacman operations) |
||||
|
||||
## Usage |
||||
|
||||
### Basic Usage |
||||
|
||||
```bash |
||||
# Single state file |
||||
sudo declpac --state packages.txt |
||||
|
||||
# Multiple state files |
||||
sudo declpac --state base.txt --state apps.txt |
||||
|
||||
# From stdin |
||||
cat packages.txt | sudo declpac |
||||
``` |
||||
|
||||
### State File Format |
||||
|
||||
State files contain one package name per line: |
||||
|
||||
``` |
||||
bash |
||||
vim |
||||
git |
||||
docker |
||||
``` |
||||
|
||||
Lines are treated as package names with whitespace trimmed: |
||||
|
||||
``` |
||||
bash # bash |
||||
vim # vim |
||||
# comment # ignored |
||||
``` |
||||
|
||||
### Command Line Options |
||||
|
||||
| Flag | Alias | Description | |
||||
|------|-------|-------------| |
||||
| `--state` | `-s` | State file(s) to read package list from (can be used multiple times) | |
||||
| `--yes` | `-y` | Skip confirmation prompts (for scripting) | |
||||
| `--dry-run` | | Simulate sync without making changes | |
||||
| `--help` | `-h` | Show help message | |
||||
|
||||
### Examples |
||||
|
||||
#### Minimal System |
||||
|
||||
```bash |
||||
# Create a minimal system package list |
||||
echo -e "base\nbase-devel\nlinux-headers\nvim\ngit\ncurl\nwget" > ~/.config/declpac/minimal.txt |
||||
|
||||
# Apply the state |
||||
sudo declpac --state ~/.config/declpac/minimal.txt |
||||
``` |
||||
|
||||
#### Development Environment |
||||
|
||||
```bash |
||||
# development.txt |
||||
go |
||||
nodejs |
||||
python |
||||
rust |
||||
docker |
||||
docker-compose |
||||
kubectl |
||||
helm |
||||
terraform |
||||
|
||||
# Apply |
||||
sudo declpac --state development.txt |
||||
``` |
||||
|
||||
#### Full System Sync |
||||
|
||||
```bash |
||||
# Combine multiple files |
||||
sudo declpac --state ~/.config/declpac/base.txt --state ~/.config/declpac/desktop.txt |
||||
|
||||
# Or use stdin |
||||
cat ~/.config/declpac/full-system.txt | sudo declpac |
||||
``` |
||||
|
||||
#### Dry-Run Preview |
||||
|
||||
```bash |
||||
# Preview what would happen without making changes |
||||
sudo declpac --dry-run --state packages.txt |
||||
|
||||
# Example output: |
||||
# Installed 3 packages, removed 2 packages |
||||
# Would install: vim, git, docker |
||||
# Would remove: python2, perl-xml-parser |
||||
``` |
||||
|
||||
## How It Works |
||||
|
||||
1. **Collect packages** — Reads from all `--state` files and stdin |
||||
2. **Merge** — Combines all packages additively (duplicates allowed) |
||||
3. **Validate** — Checks packages exist in repos or AUR |
||||
4. **Mark explicit** — Marks declared packages as explicit dependencies |
||||
5. **Sync** — Runs `pacman -Syu` to install/upgrade packages |
||||
6. **Cleanup** — Removes orphaned packages with `pacman -Rns` |
||||
7. **Report** — Outputs summary: `Installed X packages, removed Y packages` |
||||
|
||||
### Database Freshness |
||||
|
||||
If the pacman database is older than 24 hours, `declpac` automatically refreshes it with `pacman -Syy` before validation. |
||||
|
||||
### Orphan Cleanup |
||||
|
||||
After syncing, `declpac` identifies and removes packages that are: |
||||
- Not explicitly installed |
||||
- Not required by any other package |
||||
|
||||
This keeps your system clean from dependency artifacts. |
||||
|
||||
## Output Format |
||||
|
||||
``` |
||||
# Success (packages installed/removed) |
||||
Installed 5 packages, removed 2 packages |
||||
|
||||
# Success (no changes) |
||||
Installed 0 packages, removed 0 packages |
||||
|
||||
# Error |
||||
error: package not found: <package-name> |
||||
``` |
||||
|
||||
### Exit Codes |
||||
|
||||
| Code | Meaning | |
||||
|------|---------| |
||||
| 0 | Success | |
||||
| 1 | Error (no packages, validation failure, pacman error) | |
||||
|
||||
## Security Considerations |
||||
|
||||
- **Run as root** — `declpac` requires root privileges for pacman operations |
||||
- **Review state files** — Only install packages from trusted sources |
||||
- **Backup** — Consider backing up your system before major changes |
||||
|
||||
## Troubleshooting |
||||
|
||||
### "Permission denied" |
||||
|
||||
`declpac` requires root privileges. Use `sudo`: |
||||
|
||||
```bash |
||||
sudo declpac --state packages.txt |
||||
``` |
||||
|
||||
### "Package not found" |
||||
|
||||
The package doesn't exist in pacman repos or AUR. Check the package name: |
||||
|
||||
```bash |
||||
pacman -Ss <package> |
||||
``` |
||||
|
||||
### Database sync fails |
||||
|
||||
Refresh manually: |
||||
|
||||
```bash |
||||
sudo pacman -Syy |
||||
``` |
||||
|
||||
## File Structure |
||||
|
||||
``` |
||||
declpac/ |
||||
├── cmd/declpac/ |
||||
│ └── main.go # Entry point |
||||
├── pkg/ |
||||
│ ├── input/ # State file/stdin reading |
||||
│ ├── merge/ # Package merging |
||||
│ ├── validation/ # Package validation |
||||
│ ├── pacman/ # Pacman integration |
||||
│ └── output/ # Output formatting |
||||
├── go.mod # Go module |
||||
└── README.md # This file |
||||
``` |
||||
|
||||
## License |
||||
|
||||
GPL-3.0 |
||||
|
||||
@ -0,0 +1,90 @@
|
||||
package main |
||||
|
||||
import ( |
||||
"context" |
||||
"fmt" |
||||
"os" |
||||
|
||||
"github.com/urfave/cli/v3" |
||||
|
||||
"github.com/Riyyi/declpac/pkg/input" |
||||
"github.com/Riyyi/declpac/pkg/merge" |
||||
"github.com/Riyyi/declpac/pkg/output" |
||||
"github.com/Riyyi/declpac/pkg/pacman" |
||||
"github.com/Riyyi/declpac/pkg/validation" |
||||
) |
||||
|
||||
type Config struct { |
||||
StateFiles []string |
||||
NoConfirm bool |
||||
DryRun bool |
||||
} |
||||
|
||||
func main() { |
||||
cfg := &Config{} |
||||
|
||||
cmd := &cli.Command{ |
||||
Name: "declpac", |
||||
Usage: "Declarative pacman package manager", |
||||
Flags: []cli.Flag{ |
||||
&cli.StringSliceFlag{ |
||||
Name: "state", |
||||
Aliases: []string{"s"}, |
||||
Usage: "State file(s) to read package list from", |
||||
Destination: &cfg.StateFiles, |
||||
}, |
||||
&cli.BoolFlag{ |
||||
Name: "yes", |
||||
Aliases: []string{"y"}, |
||||
Usage: "Skip confirmation prompts", |
||||
Destination: &cfg.NoConfirm, |
||||
}, |
||||
&cli.BoolFlag{ |
||||
Name: "dry-run", |
||||
Usage: "Simulate the sync without making changes", |
||||
Destination: &cfg.DryRun, |
||||
}, |
||||
}, |
||||
Action: func(ctx context.Context, cmd *cli.Command) error { |
||||
return run(cfg) |
||||
}, |
||||
} |
||||
|
||||
if err := cmd.Run(context.Background(), os.Args); err != nil { |
||||
os.Exit(1) |
||||
} |
||||
} |
||||
|
||||
func run(cfg *Config) error { |
||||
packages, err := input.ReadPackages(cfg.StateFiles) |
||||
if err != nil { |
||||
fmt.Fprintf(os.Stderr, "error: %v\n", err) |
||||
return err |
||||
} |
||||
|
||||
merged := merge.Merge(packages) |
||||
|
||||
if err := validation.Validate(merged); err != nil { |
||||
fmt.Fprintf(os.Stderr, "error: %v\n", err) |
||||
return err |
||||
} |
||||
|
||||
if cfg.DryRun { |
||||
result, err := pacman.DryRun(merged) |
||||
if err != nil { |
||||
fmt.Fprintf(os.Stderr, "error: %v\n", err) |
||||
return err |
||||
} |
||||
fmt.Println(output.Format(result)) |
||||
return nil |
||||
} |
||||
|
||||
result, err := pacman.Sync(merged) |
||||
if err != nil { |
||||
fmt.Fprintf(os.Stderr, "error: %v\n", err) |
||||
return err |
||||
} |
||||
|
||||
fmt.Println(output.Format(result)) |
||||
return nil |
||||
} |
||||
@ -0,0 +1,49 @@
|
||||
# Dry-Run Mode |
||||
|
||||
## Summary |
||||
|
||||
Add `--dry-run` flag to simulate the sync operation without making any changes |
||||
to the system. Shows what packages would be installed and what would be removed. |
||||
|
||||
## Motivation |
||||
|
||||
Users want to preview the effects of a sync operation before committing changes. |
||||
This is useful for: |
||||
- Verifying the intended changes are correct |
||||
- Avoiding unintended package installations |
||||
- Understanding what orphan cleanup will remove |
||||
|
||||
## Interface |
||||
|
||||
``` |
||||
declpac --dry-run --state packages.txt |
||||
``` |
||||
|
||||
## Behavior |
||||
|
||||
1. Read state files and stdin (same as normal mode) |
||||
2. Validate packages exist (same as normal mode) |
||||
3. Query current installed packages via `pacman -Qq` |
||||
4. Compare declared packages to current state |
||||
5. Identify packages that would be installed (not currently installed) |
||||
6. Identify orphans that would be removed via `pacman -Qdtq` |
||||
7. Output results with "Would install:" and "Would remove:" sections |
||||
|
||||
## Output Format |
||||
|
||||
``` |
||||
Installed 3 packages, removed 2 packages |
||||
Would install: vim, git, docker |
||||
Would remove: python2, perl-xml-parser |
||||
``` |
||||
|
||||
## Non-Goals |
||||
|
||||
- Actual package operations (no pacman -Syu, no pacman -Rns execution) |
||||
- Package version comparison |
||||
- Detailed dependency analysis |
||||
|
||||
## Trade-offs |
||||
|
||||
- Doesn't predict transitive dependencies that pacman might install |
||||
- Orphan list may change after packages are installed |
||||
@ -1,95 +1,104 @@
|
||||
## 1. Project Setup |
||||
|
||||
- [ ] 1.1 Initialize Go module with proper imports |
||||
- [ ] 1.2 Add required dependencies (dyalpm wrapper, Jguer/aur) |
||||
- [ ] 1.3 Set up project structure (cmd/declpac/main.go, pkg/ subdirectory) |
||||
- [ ] 1.4 Add libalpm initialization and handle |
||||
- [x] 1.1 Initialize Go module with proper imports |
||||
- [x] 1.2 Add required dependencies (dyalpm wrapper, Jguer/aur) |
||||
- [x] 1.3 Set up project structure (cmd/declpac/main.go, pkg/ subdirectory) |
||||
- [x] 1.4 Add libalpm initialization and handle |
||||
|
||||
## 2. Input Parsing |
||||
|
||||
- [ ] 2.1 Implement stdin reader to collect package names |
||||
- [ ] 2.2 Implement state file reader for text-list format |
||||
- [ ] 2.3 Add whitespace normalization for package names |
||||
- [ ] 2.4 Create package name set data structure |
||||
- [x] 2.1 Implement stdin reader to collect package names |
||||
- [x] 2.2 Implement state file reader for text-list format |
||||
- [x] 2.3 Add whitespace normalization for package names |
||||
- [x] 2.4 Create package name set data structure |
||||
|
||||
## 3. Input Merging |
||||
|
||||
- [ ] 3.1 Implement additive merging of stdin and state file packages |
||||
- [ ] 3.2 Handle multiple --state flags with last-writer-wins per file |
||||
- [ ] 3.3 Implement duplicate package handling (no deduplication) |
||||
- [x] 3.1 Implement additive merging of stdin and state file packages |
||||
- [x] 3.2 Handle multiple --state flags with last-writer-wins per file |
||||
- [x] 3.3 Implement duplicate package handling (no deduplication) |
||||
|
||||
## 4. State Validation |
||||
|
||||
- [ ] 4.1 Implement empty state detection (no packages found) |
||||
- [ ] 4.2 Add stderr error output for empty state |
||||
- [ ] 4.3 Set exit code 1 for empty state case (abort, not proceed) |
||||
- [ ] 4.4 Check pacman DB freshness (db.lock timestamp) |
||||
- [ ] 4.5 Run pacman -Syy if DB older than 1 day |
||||
- [ ] 4.6 Validate packages via libalpm (pacman repos) |
||||
- [ ] 4.7 Validate packages via Jguer/aur (AUR) |
||||
- [ ] 4.8 Fail fast with error if package not found |
||||
- [x] 4.1 Implement empty state detection (no packages found) |
||||
- [x] 4.2 Add stderr error output for empty state |
||||
- [x] 4.3 Set exit code 1 for empty state case (abort, not proceed) |
||||
- [x] 4.4 Check pacman DB freshness (db.lock timestamp) |
||||
- [x] 4.5 Run pacman -Syy if DB older than 1 day |
||||
- [x] 4.6 Validate packages via libalpm (pacman repos) |
||||
- [x] 4.7 Validate packages via Jguer/aur (AUR) |
||||
- [x] 4.8 Fail fast with error if package not found |
||||
|
||||
## 5. Pacman Integration (Hybrid: query via libalpm, modify via exec) |
||||
|
||||
- [ ] 5.1 Initialize libalpm handle for queries |
||||
- [ ] 5.2 Implement libalpm query for installed packages |
||||
- [ ] 5.3 Implement libalpm query for available packages |
||||
- [ ] 5.4 Implement pacman -Syy command execution (DB refresh) |
||||
- [ ] 5.5 Implement pacman -Syu command execution wrapper |
||||
- [ ] 5.6 Add command-line argument construction with package list |
||||
- [ ] 5.7 Capture pacman stdout and stderr output |
||||
- [ ] 5.8 Implement pacman error message parsing |
||||
- [ ] 5.9 Handle pacman exit codes for success/failure detection |
||||
- [ ] 5.10 Verify pacman automatically resolves transitive dependencies |
||||
- [x] 5.1 Initialize libalpm handle for queries |
||||
- [x] 5.2 Implement libalpm query for installed packages |
||||
- [x] 5.3 Implement libalpm query for available packages |
||||
- [x] 5.4 Implement pacman -Syy command execution (DB refresh) |
||||
- [x] 5.5 Implement pacman -Syu command execution wrapper |
||||
- [x] 5.6 Add command-line argument construction with package list |
||||
- [x] 5.7 Capture pacman stdout and stderr output |
||||
- [x] 5.8 Implement pacman error message parsing |
||||
- [x] 5.9 Handle pacman exit codes for success/failure detection |
||||
- [x] 5.10 Verify pacman automatically resolves transitive dependencies |
||||
|
||||
## 6. Explicit Marking & Orphan Cleanup |
||||
|
||||
- [ ] 6.1 Get list of currently installed packages before sync |
||||
- [ ] 6.2 Mark declared state packages as explicitly installed via pacman -D --explicit |
||||
- [ ] 6.3 Run pacman sync operation (5.x series) |
||||
- [ ] 6.4 Run pacman -Rsu to remove orphaned packages |
||||
- [ ] 6.5 Capture and report number of packages removed |
||||
- [ ] 6.6 Handle case where no orphans exist (no packages removed) |
||||
- [x] 6.1 Get list of currently installed packages before sync |
||||
- [x] 6.2 Mark declared state packages as explicitly installed via pacman -D --explicit |
||||
- [x] 6.3 Run pacman sync operation (5.x series) |
||||
- [x] 6.4 Run pacman -Rsu to remove orphaned packages |
||||
- [x] 6.5 Capture and report number of packages removed |
||||
- [x] 6.6 Handle case where no orphans exist (no packages removed) |
||||
|
||||
## 7. AUR Integration |
||||
|
||||
- [ ] 7.1 Implement AUR package lookup via Jguer/aur library |
||||
- [ ] 7.2 Check package not in pacman repos first (via libalpm) |
||||
- [ ] 7.3 Query AUR for missing packages |
||||
- [ ] 7.4 Implement AUR fallback using makepkg (direct build, not AUR helper) |
||||
- [ ] 7.5 Clone AUR package git repo to temp directory |
||||
- [ ] 7.6 Run makepkg -si in temp directory for installation |
||||
- [ ] 7.7 Upgrade existing AUR packages to latest (makepkg rebuild) |
||||
- [ ] 7.8 Add stderr error reporting for packages not in pacman or AUR |
||||
- [ ] 7.9 Capture makepkg stdout and stderr for output parsing |
||||
- [ ] 7.10 Handle makepkg exit codes for success/failure detection |
||||
- [x] 7.1 Implement AUR package lookup via Jguer/aur library |
||||
- [x] 7.2 Check package not in pacman repos first (via libalpm) |
||||
- [x] 7.3 Query AUR for missing packages |
||||
- [x] 7.4 Implement AUR fallback using makepkg (direct build, not AUR helper) |
||||
- [x] 7.5 Clone AUR package git repo to temp directory |
||||
- [x] 7.6 Run makepkg -si in temp directory for installation |
||||
- [x] 7.7 Upgrade existing AUR packages to latest (makepkg rebuild) |
||||
- [x] 7.8 Add stderr error reporting for packages not in pacman or AUR |
||||
- [x] 7.9 Capture makepkg stdout and stderr for output parsing |
||||
- [x] 7.10 Handle makepkg exit codes for success/failure detection |
||||
|
||||
## 8. Output Generation |
||||
|
||||
- [ ] 8.1 Parse pacman output for installed package count |
||||
- [ ] 8.2 Parse pacman output for removed package count (orphan cleanup) |
||||
- [ ] 8.3 Generate output: `Installed X packages, removed Y packages` |
||||
- [ ] 8.4 Handle 0 packages case: `Installed 0 packages, removed 0 packages` |
||||
- [ ] 8.5 Print errors to stderr |
||||
- [ ] 8.6 Set exit code 0 for success, 1 for errors |
||||
- [x] 8.1 Parse pacman output for installed package count |
||||
- [x] 8.2 Parse pacman output for removed package count (orphan cleanup) |
||||
- [x] 8.3 Generate output: `Installed X packages, removed Y packages` |
||||
- [x] 8.4 Handle 0 packages case: `Installed 0 packages, removed 0 packages` |
||||
- [x] 8.5 Print errors to stderr |
||||
- [x] 8.6 Set exit code 0 for success, 1 for errors |
||||
|
||||
## 9. CLI Interface |
||||
|
||||
- [ ] 9.1 Implement --state flag argument parsing |
||||
- [ ] 9.2 Implement stdin input handling from /dev/stdin |
||||
- [ ] 9.3 Set up correct CLI usage/help message |
||||
- [ ] 9.4 Implement flag order validation |
||||
- [x] 9.1 Implement --state flag argument parsing |
||||
- [x] 9.2 Implement stdin input handling from /dev/stdin |
||||
- [x] 9.3 Set up correct CLI usage/help message |
||||
- [x] 9.4 Implement flag order validation |
||||
|
||||
## 10. Integration & Testing |
||||
|
||||
- [ ] 10.1 Wire together stdin -> state files -> merging -> validation -> pacman sync -> orphan cleanup -> output |
||||
- [ ] 10.2 Test empty state error output and exit code 1 |
||||
- [ ] 10.3 Test single state file parsing |
||||
- [ ] 10.4 Test multiple state file merging |
||||
- [ ] 10.5 Test stdin input parsing |
||||
- [ ] 10.6 Test explicit marking before sync |
||||
- [ ] 10.7 Test pacman command execution with real packages |
||||
- [ ] 10.8 Test orphan cleanup removes unneeded packages |
||||
- [ ] 10.9 Test AUR fallback with makepkg for AUR package |
||||
- [ ] 10.10 Test error handling for missing packages |
||||
- [ ] 10.11 Generate final binary |
||||
- [x] 10.1 Wire together stdin -> state files -> merging -> validation -> pacman sync -> orphan cleanup -> output |
||||
- [x] 10.2 Test empty state error output and exit code 1 |
||||
- [x] 10.3 Test single state file parsing |
||||
- [x] 10.4 Test multiple state file merging |
||||
- [x] 10.5 Test stdin input parsing |
||||
- [x] 10.6 Test explicit marking before sync |
||||
- [x] 10.7 Test pacman command execution with real packages |
||||
- [x] 10.8 Test orphan cleanup removes unneeded packages |
||||
- [x] 10.9 Test AUR fallback with makepkg for AUR package |
||||
- [x] 10.10 Test error handling for missing packages |
||||
- [x] 10.11 Generate final binary |
||||
|
||||
## 11. Dry-Run Mode |
||||
|
||||
- [x] 11.1 Add --dry-run flag to CLI argument parsing |
||||
- [x] 11.2 Implement DryRun function to query current state |
||||
- [x] 11.3 Compare declared packages to current installations |
||||
- [x] 11.4 Identify packages to install (not currently installed) |
||||
- [x] 11.5 Identify orphans to remove via pacman -Qdtq |
||||
- [x] 11.6 Output "Would install:" and "Would remove:" sections |
||||
|
||||
@ -0,0 +1,2 @@
|
||||
schema: spec-driven |
||||
created: 2026-04-13 |
||||
@ -0,0 +1,67 @@
|
||||
## Context |
||||
|
||||
Current implementation in `pkg/pacman/pacman.go` spawns shell processes for pacman queries: |
||||
|
||||
1. **`ValidatePackage`**: Calls `pacman -Qip` then `pacman -Sip` (2 processes per package) to check if package exists in sync databases |
||||
2. **`MarkExplicit`**: Calls `pacman -D --explicit <pkg>` individually per package (N processes for N packages) |
||||
3. **AUR**: Called individually per package not found in pacman databases |
||||
|
||||
Performance issues scale with package count. No caching of package queries across calls. |
||||
|
||||
## Goals / Non-Goals |
||||
|
||||
**Goals:** |
||||
- Use Jguer/dyalpm library to query pacman databases without spawning processes |
||||
- Add in-memory cache for ALL package query results (pacman + AUR), valid for entire job duration |
||||
- Batch `pacman -D --explicit` calls to single process for multiple packages |
||||
- Batch AUR HTTP queries to single request for all packages not found in pacman |
||||
|
||||
**Non-Goals:** |
||||
- Refactor AUR handling (already uses HTTP API - will batch it) |
||||
- Add persistent cache (only job-duration in-memory) |
||||
- Change other pacman operations (sync, cleanup) |
||||
|
||||
## Decisions |
||||
|
||||
1. **dyalpm over go-alpm**: dyalpm uses purego (no cgo), cleaner cross-compilation |
||||
- Alternative: go-alpm (cgo-based) - rejected for compilation complexity |
||||
|
||||
2. **Unified cache in Pac struct**: Single cache map replaces separate aurCache |
||||
- Alternative: keep separate caches - rejected, unnecessary complexity |
||||
- Cache key: package name, value: PackageInfo struct |
||||
|
||||
3. **Batch MarkExplicit**: Accept `[]string` packages, pass all to single `pacman -D --explicit` call |
||||
- Note: pacman -D accepts multiple packages in single call |
||||
|
||||
4. **Batch query strategy**: |
||||
- Query all packages against dyalpm local DB → returns found[] |
||||
- Query not-found against dyalpm sync DBs → returns found[] |
||||
- Query remaining not-found against AUR HTTP (single batched request) |
||||
- Current: pacman -Qip → pacman -Sip → AUR (per-package) |
||||
- New: Batch dyalpm local → Batch dyalpm sync → Batch AUR |
||||
|
||||
5. **Fallback for dyalpm unavailable**: If dyalpm init fails, fall back to: |
||||
- pacman -Qip for all packages (single process, capture all) |
||||
- pacman -Sip for remaining (single process, capture all) |
||||
- AUR HTTP batch for remaining (already batched) |
||||
|
||||
## Risks / Trade-offs |
||||
|
||||
- **Risk**: dyalpm requires libalpm.so.15 on system |
||||
- Mitigation: Check at runtime, fallback to process spawn if missing |
||||
|
||||
- **Risk**: Cache invalidation edge cases (e.g., package installed during job) |
||||
- Mitigation: Acceptable for declpac use case; user runs sync after config changes |
||||
|
||||
- **Risk**: AUR API batch size limits |
||||
- Mitigation: Chunk large batches if AUR has limits (TBD in implementation) |
||||
|
||||
## Migration Plan |
||||
|
||||
1. Add dyalpm dependency to go.mod |
||||
2. Refactor Pac struct: replace aurCache with unified pkgCache map |
||||
3. Change ValidatePackage to ValidatePackages (slice input, batch processing) |
||||
4. Update MarkExplicit to accept slice |
||||
5. Batch AUR HTTP calls in ensureAURCache |
||||
6. Update call sites in Sync(), categorizePackages, DryRun() |
||||
7. Test with existing test suite |
||||
@ -0,0 +1,28 @@
|
||||
## Why |
||||
|
||||
Current `ValidatePackage` spawns multiple `pacman` processes per package (-Qip, -Sip calls), causing performance issues when checking many packages. Additionally, `MarkExplicit` is called individually for each package, spawning a separate process per package. Finally, AUR HTTP calls are made per-package. Using the Jguer/dyalpm Go library eliminates process spawning overhead and enables efficient batch operations throughout. |
||||
|
||||
## What Changes |
||||
|
||||
- Replace shell-out to `pacman -Qip`/`pacman -Sip` in `ValidatePackage` with Jguer/dyalpm library calls |
||||
- Add unified in-memory package cache to `Pac` struct (replaces existing aurCache), persisting for job duration |
||||
- Replace individual `pacman -D --explicit` calls with single batch call |
||||
- Batch AUR HTTP queries into single request for all packages not found in pacman databases |
||||
- Add Jguer/dyalpm dependency |
||||
|
||||
## Capabilities |
||||
|
||||
### New Capabilities |
||||
|
||||
- **dyalpm-package-query**: Use dyalpm library for querying pacman package databases in batch, falling back to AUR HTTP batch for remaining packages. Results cached for job duration. |
||||
- **batch-explicit-mark**: Batch multiple packages into single `pacman -D --explicit` call instead of per-package process spawn. |
||||
|
||||
### Modified Capabilities |
||||
|
||||
None. |
||||
|
||||
## Impact |
||||
|
||||
- **pkg/pacman/pacman.go**: Refactor `ValidatePackage` to accept slice, replace aurCache with unified pkgCache, refactor `MarkExplicit` to accept slice |
||||
- **go.mod**: Add Jguer/dyalpm import |
||||
- **Performance**: Reduced process spawns from O(n*2 + n AUR) to O(1) for ValidatePackages, O(n) to O(1) for MarkExplicit |
||||
@ -0,0 +1,16 @@
|
||||
## ADDED Requirements |
||||
|
||||
### Requirement: MarkExplicit accepts multiple packages |
||||
The MarkExplicit method SHALL accept a slice of package names and mark all of them as explicitly installed using a single pacman -D call. |
||||
|
||||
#### Scenario: Single package marked explicit |
||||
- **WHEN** MarkExplicit is called with one package name |
||||
- **THEN** pacman -D --explicit is called once with that package |
||||
|
||||
#### Scenario: Multiple packages marked explicit |
||||
- **WHEN** MarkExplicit is called with multiple package names (e.g., ["pkg1", "pkg2"]) |
||||
- **THEN** pacman -D --explicit is called once with all packages as arguments |
||||
|
||||
#### Scenario: Empty package slice |
||||
- **WHEN** MarkExplicit is called with an empty slice |
||||
- **THEN** no pacman call is made, method returns nil immediately |
||||
@ -0,0 +1,47 @@
|
||||
## ADDED Requirements |
||||
|
||||
### Requirement: ValidatePackages uses dyalpm library with batch AUR fallback |
||||
The ValidatePackages method SHALL accept a slice of package names, query them in batch using dyalpm, then batch query AUR for any not found in pacman databases. |
||||
|
||||
#### Scenario: All packages found in local database |
||||
- **WHEN** ValidatePackages is called with packages that all exist in local pacman database |
||||
- **THEN** returns a slice of PackageInfo with Exists=true, InAUR=false for each |
||||
|
||||
#### Scenario: Some packages found in sync database |
||||
- **WHEN** ValidatePackages is called with packages where some are only in sync databases |
||||
- **THEN** returns PackageInfo with Exists=true, InAUR=false for found packages |
||||
|
||||
#### Scenario: Some packages found in AUR |
||||
- **WHEN** ValidatePackages is called and some packages are not in pacman databases |
||||
- **THEN** those packages are batched to single AUR HTTP request, returns PackageInfo with InAUR=true |
||||
|
||||
#### Scenario: Packages not found anywhere |
||||
- **WHEN** ValidatePackages is called and some packages not found in pacman or AUR |
||||
- **THEN** returns PackageInfo with Exists=false, InAUR=false for those packages |
||||
|
||||
### Requirement: Unified package cache |
||||
The Pac struct SHALL maintain a single cache map that stores all package query results (both pacman and AUR), replacing the separate aurCache. |
||||
|
||||
#### Scenario: Package already cached |
||||
- **WHEN** ValidatePackages is called for a package already queried in current job |
||||
- **THEN** cached result returned without any dyalpm or AUR calls |
||||
|
||||
#### Scenario: New Pac instance |
||||
- **WHEN** New() creates a new Pac instance |
||||
- **THEN** cache is empty (fresh job) |
||||
|
||||
### Requirement: Single batch AUR call |
||||
The AUR HTTP API SHALL be called once with all package names not found in pacman databases. |
||||
|
||||
#### Scenario: Multiple packages not in pacman |
||||
- **WHEN** 3 packages not found in local or sync databases |
||||
- **THEN** single AUR HTTP request with all 3 in arg[] params |
||||
- **AND** results cached for all 3 |
||||
|
||||
### Requirement: Fallback to process spawn if dyalpm unavailable |
||||
If dyalpm library is not available at runtime, ValidatePackages SHALL fall back to spawning pacman -Qip/-Sip processes in batch. |
||||
|
||||
#### Scenario: dyalpm unavailable |
||||
- **WHEN** dyalpm initialization fails |
||||
- **THEN** uses pacman -Qip for local, -Sip for sync, AUR HTTP batch as fallback |
||||
- **AND** behavior is identical to using dyalpm |
||||
@ -0,0 +1,36 @@
|
||||
## 1. Dependencies |
||||
|
||||
- [ ] 1.1 Add github.com/Jguer/dyalpm to go.mod |
||||
- [ ] 1.2 Run go mod tidy to resolve dependencies |
||||
|
||||
## 2. Pac Struct Updates |
||||
|
||||
- [ ] 2.1 Add dyalpm handle field to Pac struct |
||||
- [ ] 2.2 Add package info cache field (map[string]PackageInfo) to Pac struct |
||||
- [ ] 2.3 Update New() to initialize dyalpm handle |
||||
- [ ] 2.4 Update Close() to release dyalpm handle |
||||
|
||||
## 3. ValidatePackage Implementation |
||||
|
||||
- [ ] 3.1 Implement ValidatePackage using dyalpm LocalDB().Pkg() |
||||
- [ ] 3.2 Query sync databases if not found locally |
||||
- [ ] 3.3 Add caching logic to store/query results |
||||
- [ ] 3.4 Keep AUR fallback for packages not in pacman repos |
||||
|
||||
## 4. MarkExplicit Updates |
||||
|
||||
- [ ] 4.1 Change MarkExplicit signature to accept []string (slice of packages) |
||||
- [ ] 4.2 Implement single pacman -D --explicit call with all packages |
||||
- [ ] 4.3 Handle empty slice case (return nil immediately) |
||||
|
||||
## 5. Call Site Updates |
||||
|
||||
- [ ] 5.1 Update Sync() to pass packages slice to MarkExplicit |
||||
- [ ] 5.2 Ensure categorizePackages works with new ValidatePackage |
||||
|
||||
## 6. Testing |
||||
|
||||
- [ ] 6.1 Run existing tests to verify no regressions |
||||
- [ ] 6.2 Test ValidatePackage with local, sync, and AUR packages |
||||
- [ ] 6.3 Test MarkExplicit with single and multiple packages |
||||
- [ ] 6.4 Verify cache behavior (second call returns cached result) |
||||
@ -0,0 +1,66 @@
|
||||
package input |
||||
|
||||
import ( |
||||
"bufio" |
||||
"os" |
||||
"strings" |
||||
) |
||||
|
||||
func ReadPackages(stateFiles []string) (map[string]bool, error) { |
||||
packages := make(map[string]bool) |
||||
|
||||
for _, file := range stateFiles { |
||||
if err := readStateFile(file, packages); err != nil { |
||||
return nil, err |
||||
} |
||||
} |
||||
|
||||
if err := readStdin(packages); err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
return packages, nil |
||||
} |
||||
|
||||
func readStateFile(path string, packages map[string]bool) error { |
||||
file, err := os.Open(path) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
defer file.Close() |
||||
|
||||
scanner := bufio.NewScanner(file) |
||||
for scanner.Scan() { |
||||
name := normalizePackageName(scanner.Text()) |
||||
if name != "" { |
||||
packages[name] = true |
||||
} |
||||
} |
||||
|
||||
return scanner.Err() |
||||
} |
||||
|
||||
func readStdin(packages map[string]bool) error { |
||||
info, err := os.Stdin.Stat() |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
if (info.Mode() & os.ModeCharDevice) != 0 { |
||||
return nil |
||||
} |
||||
|
||||
scanner := bufio.NewScanner(os.Stdin) |
||||
for scanner.Scan() { |
||||
name := normalizePackageName(scanner.Text()) |
||||
if name != "" { |
||||
packages[name] = true |
||||
} |
||||
} |
||||
|
||||
return scanner.Err() |
||||
} |
||||
|
||||
func normalizePackageName(name string) string { |
||||
return strings.TrimSpace(name) |
||||
} |
||||
@ -0,0 +1,9 @@
|
||||
package merge |
||||
|
||||
func Merge(packages map[string]bool) []string { |
||||
result := make([]string, 0, len(packages)) |
||||
for name := range packages { |
||||
result = append(result, name) |
||||
} |
||||
return result |
||||
} |
||||
@ -0,0 +1,27 @@
|
||||
package output |
||||
|
||||
import ( |
||||
"fmt" |
||||
"strings" |
||||
) |
||||
|
||||
type Result struct { |
||||
Installed int |
||||
Removed int |
||||
ToInstall []string |
||||
ToRemove []string |
||||
} |
||||
|
||||
func Format(r *Result) string { |
||||
var b strings.Builder |
||||
b.WriteString(fmt.Sprintf("Installed %d packages, removed %d packages", r.Installed, r.Removed)) |
||||
if len(r.ToInstall) > 0 { |
||||
b.WriteString("\nWould install: ") |
||||
b.WriteString(strings.Join(r.ToInstall, ", ")) |
||||
} |
||||
if len(r.ToRemove) > 0 { |
||||
b.WriteString("\nWould remove: ") |
||||
b.WriteString(strings.Join(r.ToRemove, ", ")) |
||||
} |
||||
return b.String() |
||||
} |
||||
@ -0,0 +1,380 @@
|
||||
package pacman |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
"fmt" |
||||
"io" |
||||
"net/http" |
||||
"net/url" |
||||
"os" |
||||
"os/exec" |
||||
"regexp" |
||||
"strings" |
||||
"time" |
||||
|
||||
"github.com/Riyyi/declpac/pkg/output" |
||||
) |
||||
|
||||
var ( |
||||
Root = "/" |
||||
LockFile = "/var/lib/pacman/db.lock" |
||||
AURInfoURL = "https://aur.archlinux.org/rpc?v=5&type=info" |
||||
) |
||||
|
||||
type Pac struct { |
||||
aurCache map[string]AURPackage |
||||
} |
||||
|
||||
func New() (*Pac, error) { |
||||
return &Pac{aurCache: make(map[string]AURPackage)}, nil |
||||
} |
||||
|
||||
func (p *Pac) Close() error { |
||||
return nil |
||||
} |
||||
|
||||
type PackageInfo struct { |
||||
Name string |
||||
InAUR bool |
||||
Exists bool |
||||
AURInfo *AURPackage |
||||
} |
||||
|
||||
type AURResponse struct { |
||||
Results []AURPackage `json:"results"` |
||||
} |
||||
|
||||
type AURPackage struct { |
||||
Name string `json:"Name"` |
||||
PackageBase string `json:"PackageBase"` |
||||
Version string `json:"Version"` |
||||
URL string `json:"URL"` |
||||
} |
||||
|
||||
func (p *Pac) ValidatePackage(name string) (*PackageInfo, error) { |
||||
cmd := exec.Command("pacman", "-Qip", name) |
||||
if err := cmd.Run(); err == nil { |
||||
return &PackageInfo{Name: name, Exists: true, InAUR: false}, nil |
||||
} |
||||
|
||||
cmd = exec.Command("pacman", "-Sip", name) |
||||
if err := cmd.Run(); err == nil { |
||||
return &PackageInfo{Name: name, Exists: true, InAUR: false}, nil |
||||
} |
||||
|
||||
p.ensureAURCache([]string{name}) |
||||
if aurInfo, ok := p.aurCache[name]; ok { |
||||
return &PackageInfo{Name: name, Exists: true, InAUR: true, AURInfo: &aurInfo}, nil |
||||
} |
||||
|
||||
return &PackageInfo{Name: name, Exists: false, InAUR: false}, nil |
||||
} |
||||
|
||||
func (p *Pac) IsDBFresh() (bool, error) { |
||||
info, err := os.Stat(LockFile) |
||||
if err != nil { |
||||
return false, nil |
||||
} |
||||
|
||||
age := time.Since(info.ModTime()) |
||||
return age < 24*time.Hour, nil |
||||
} |
||||
|
||||
func (p *Pac) SyncDB() error { |
||||
cmd := exec.Command("pacman", "-Syy") |
||||
cmd.Stdout = os.Stdout |
||||
cmd.Stderr = os.Stderr |
||||
return cmd.Run() |
||||
} |
||||
|
||||
func (p *Pac) GetInstalledPackages() ([]string, error) { |
||||
cmd := exec.Command("pacman", "-Qq") |
||||
output, err := cmd.Output() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
packages := strings.Split(strings.TrimSpace(string(output)), "\n") |
||||
return packages, nil |
||||
} |
||||
|
||||
func (p *Pac) MarkExplicit(pkgName string) error { |
||||
cmd := exec.Command("pacman", "-D", "--explicit", pkgName) |
||||
cmd.Stdout = os.Stdout |
||||
cmd.Stderr = os.Stderr |
||||
return cmd.Run() |
||||
} |
||||
|
||||
func Sync(packages []string) (*output.Result, error) { |
||||
before, err := getInstalledCount() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
p, err := New() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
defer p.Close() |
||||
|
||||
fresh, err := p.IsDBFresh() |
||||
if err != nil || !fresh { |
||||
if err := p.SyncDB(); err != nil { |
||||
return nil, fmt.Errorf("failed to sync database: %w", err) |
||||
} |
||||
} |
||||
|
||||
pacmanPkgs, aurPkgs := p.categorizePackages(packages) |
||||
|
||||
for _, pkg := range packages { |
||||
if err := p.MarkExplicit(pkg); err != nil { |
||||
fmt.Fprintf(os.Stderr, "warning: could not mark %s as explicit: %v\n", pkg, err) |
||||
} |
||||
} |
||||
|
||||
if len(pacmanPkgs) > 0 { |
||||
_, err = p.SyncPackages(pacmanPkgs) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
} |
||||
|
||||
for _, pkg := range aurPkgs { |
||||
if err := p.InstallAUR(pkg); err != nil { |
||||
return nil, err |
||||
} |
||||
} |
||||
|
||||
removed, err := p.CleanupOrphans() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
after, _ := getInstalledCount() |
||||
installedCount := max(after-before, 0) |
||||
|
||||
return &output.Result{ |
||||
Installed: installedCount, |
||||
Removed: removed, |
||||
}, nil |
||||
} |
||||
|
||||
func (p *Pac) categorizePackages(packages []string) (pacmanPkgs, aurPkgs []string) { |
||||
var notInPacman []string |
||||
|
||||
for _, pkg := range packages { |
||||
info, err := p.ValidatePackage(pkg) |
||||
if err != nil || !info.Exists { |
||||
notInPacman = append(notInPacman, pkg) |
||||
} else if !info.InAUR { |
||||
pacmanPkgs = append(pacmanPkgs, pkg) |
||||
} |
||||
} |
||||
|
||||
if len(notInPacman) > 0 { |
||||
p.ensureAURCache(notInPacman) |
||||
for _, pkg := range notInPacman { |
||||
if _, ok := p.aurCache[pkg]; ok { |
||||
aurPkgs = append(aurPkgs, pkg) |
||||
} else { |
||||
fmt.Fprintf(os.Stderr, "error: package not found: %s\n", pkg) |
||||
} |
||||
} |
||||
} |
||||
|
||||
return pacmanPkgs, aurPkgs |
||||
} |
||||
|
||||
func (p *Pac) ensureAURCache(packages []string) { |
||||
if len(packages) == 0 { |
||||
return |
||||
} |
||||
|
||||
var uncached []string |
||||
for _, pkg := range packages { |
||||
if _, ok := p.aurCache[pkg]; !ok { |
||||
uncached = append(uncached, pkg) |
||||
} |
||||
} |
||||
|
||||
if len(uncached) == 0 { |
||||
return |
||||
} |
||||
|
||||
p.fetchAURInfo(uncached) |
||||
} |
||||
|
||||
func (p *Pac) fetchAURInfo(packages []string) map[string]AURPackage { |
||||
result := make(map[string]AURPackage) |
||||
|
||||
if len(packages) == 0 { |
||||
return result |
||||
} |
||||
|
||||
v := url.Values{} |
||||
for _, pkg := range packages { |
||||
v.Add("arg[]", pkg) |
||||
} |
||||
|
||||
resp, err := http.Get(AURInfoURL + "&" + v.Encode()) |
||||
if err != nil { |
||||
return result |
||||
} |
||||
defer resp.Body.Close() |
||||
|
||||
body, err := io.ReadAll(resp.Body) |
||||
if err != nil { |
||||
return result |
||||
} |
||||
|
||||
var aurResp AURResponse |
||||
if err := json.Unmarshal(body, &aurResp); err != nil { |
||||
return result |
||||
} |
||||
|
||||
for _, r := range aurResp.Results { |
||||
p.aurCache[r.Name] = r |
||||
result[r.Name] = r |
||||
} |
||||
|
||||
return result |
||||
} |
||||
|
||||
func (p *Pac) InstallAUR(pkgName string) error { |
||||
aurInfo, ok := p.aurCache[pkgName] |
||||
if !ok { |
||||
return fmt.Errorf("AUR package not found in cache: %s", pkgName) |
||||
} |
||||
|
||||
tmpDir, err := os.MkdirTemp("", "declpac-aur-") |
||||
if err != nil { |
||||
return fmt.Errorf("failed to create temp directory: %w", err) |
||||
} |
||||
defer os.RemoveAll(tmpDir) |
||||
|
||||
cloneURL := "https://aur.archlinux.org/" + aurInfo.PackageBase + ".git" |
||||
cloneCmd := exec.Command("git", "clone", cloneURL, tmpDir) |
||||
cloneCmd.Stdout = os.Stdout |
||||
cloneCmd.Stderr = os.Stderr |
||||
if err := cloneCmd.Run(); err != nil { |
||||
return fmt.Errorf("failed to clone AUR repo: %w", err) |
||||
} |
||||
|
||||
makepkgCmd := exec.Command("makepkg", "-si", "--noconfirm") |
||||
makepkgCmd.Stdout = os.Stdout |
||||
makepkgCmd.Stderr = os.Stderr |
||||
makepkgCmd.Dir = tmpDir |
||||
if err := makepkgCmd.Run(); err != nil { |
||||
return fmt.Errorf("makepkg failed to build AUR package: %w", err) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func getInstalledCount() (int, error) { |
||||
cmd := exec.Command("pacman", "-Qq") |
||||
output, err := cmd.Output() |
||||
if err != nil { |
||||
return 0, nil |
||||
} |
||||
count := strings.Count(string(output), "\n") + 1 |
||||
if strings.TrimSpace(string(output)) == "" { |
||||
count = 0 |
||||
} |
||||
return count, nil |
||||
} |
||||
|
||||
func (p *Pac) SyncPackages(packages []string) (int, error) { |
||||
args := append([]string{"-Syu"}, packages...) |
||||
cmd := exec.Command("pacman", args...) |
||||
output, err := cmd.CombinedOutput() |
||||
if err != nil { |
||||
return 0, fmt.Errorf("pacman sync failed: %s", output) |
||||
} |
||||
|
||||
re := regexp.MustCompile(`upgrading (\S+)`) |
||||
matches := re.FindAllStringSubmatch(string(output), -1) |
||||
return len(matches), nil |
||||
} |
||||
|
||||
func (p *Pac) CleanupOrphans() (int, error) { |
||||
listCmd := exec.Command("pacman", "-Qdtq") |
||||
orphans, err := listCmd.Output() |
||||
if err != nil { |
||||
return 0, nil |
||||
} |
||||
|
||||
orphanList := strings.TrimSpace(string(orphans)) |
||||
if orphanList == "" { |
||||
return 0, nil |
||||
} |
||||
|
||||
removeCmd := exec.Command("pacman", "-Rns") |
||||
output, err := removeCmd.CombinedOutput() |
||||
if err != nil { |
||||
return 0, fmt.Errorf("%s: %s", err, output) |
||||
} |
||||
|
||||
count := strings.Count(orphanList, "\n") + 1 |
||||
return count, nil |
||||
} |
||||
|
||||
func DryRun(packages []string) (*output.Result, error) { |
||||
p, err := New() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
defer p.Close() |
||||
|
||||
current, err := p.GetInstalledPackages() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
currentSet := make(map[string]bool) |
||||
for _, pkg := range current { |
||||
currentSet[pkg] = true |
||||
} |
||||
|
||||
var toInstall []string |
||||
var aurPkgs []string |
||||
for _, pkg := range packages { |
||||
if !currentSet[pkg] { |
||||
info, err := p.ValidatePackage(pkg) |
||||
if err != nil || !info.Exists { |
||||
return nil, fmt.Errorf("package not found: %s", pkg) |
||||
} |
||||
if info.InAUR { |
||||
aurPkgs = append(aurPkgs, pkg) |
||||
} else { |
||||
toInstall = append(toInstall, pkg) |
||||
} |
||||
} |
||||
} |
||||
|
||||
orphans, err := p.listOrphans() |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
|
||||
return &output.Result{ |
||||
Installed: len(toInstall) + len(aurPkgs), |
||||
Removed: len(orphans), |
||||
ToInstall: append(toInstall, aurPkgs...), |
||||
ToRemove: orphans, |
||||
}, nil |
||||
} |
||||
|
||||
func (p *Pac) listOrphans() ([]string, error) { |
||||
cmd := exec.Command("pacman", "-Qdtq") |
||||
orphans, err := cmd.Output() |
||||
if err != nil { |
||||
return nil, nil |
||||
} |
||||
|
||||
list := strings.TrimSpace(string(orphans)) |
||||
if list == "" { |
||||
return nil, nil |
||||
} |
||||
|
||||
return strings.Split(list, "\n"), nil |
||||
} |
||||
@ -0,0 +1,134 @@
|
||||
package validation |
||||
|
||||
import ( |
||||
"encoding/json" |
||||
"errors" |
||||
"fmt" |
||||
"io" |
||||
"net/http" |
||||
"net/url" |
||||
"os" |
||||
"os/exec" |
||||
"time" |
||||
) |
||||
|
||||
var LockFile = "/var/lib/pacman/db.lock" |
||||
|
||||
const AURInfoURL = "https://aur.archlinux.org/rpc?v=5&type=info" |
||||
|
||||
type AURResponse struct { |
||||
Results []AURResult `json:"results"` |
||||
} |
||||
|
||||
type AURResult struct { |
||||
Name string `json:"Name"` |
||||
} |
||||
|
||||
func Validate(packages []string) error { |
||||
if len(packages) == 0 { |
||||
return errors.New("no packages found") |
||||
} |
||||
|
||||
if err := checkDBFreshness(); err != nil { |
||||
return err |
||||
} |
||||
|
||||
if err := validatePackages(packages); err != nil { |
||||
return err |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func checkDBFreshness() error { |
||||
info, err := os.Stat(LockFile) |
||||
if err != nil { |
||||
return nil |
||||
} |
||||
|
||||
age := time.Since(info.ModTime()) |
||||
if age > 24*time.Hour { |
||||
cmd := exec.Command("pacman", "-Syy") |
||||
cmd.Stdout = os.Stdout |
||||
cmd.Stderr = os.Stderr |
||||
if err := cmd.Run(); err != nil { |
||||
return fmt.Errorf("failed to refresh pacman database: %w", err) |
||||
} |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func validatePackages(packages []string) error { |
||||
var pacmanPkgs []string |
||||
var aurPkgs []string |
||||
|
||||
for _, pkg := range packages { |
||||
if inPacman(pkg) { |
||||
pacmanPkgs = append(pacmanPkgs, pkg) |
||||
} else { |
||||
aurPkgs = append(aurPkgs, pkg) |
||||
} |
||||
} |
||||
|
||||
if len(aurPkgs) > 0 { |
||||
foundAUR := batchSearchAUR(aurPkgs) |
||||
for _, pkg := range aurPkgs { |
||||
if !foundAUR[pkg] { |
||||
return fmt.Errorf("package not found: %s", pkg) |
||||
} |
||||
} |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func inPacman(name string) bool { |
||||
cmd := exec.Command("pacman", "-Qip", name) |
||||
if err := cmd.Run(); err == nil { |
||||
return true |
||||
} |
||||
|
||||
cmd = exec.Command("pacman", "-Sip", name) |
||||
if err := cmd.Run(); err == nil { |
||||
return true |
||||
} |
||||
|
||||
return false |
||||
} |
||||
|
||||
func batchSearchAUR(packages []string) map[string]bool { |
||||
result := make(map[string]bool) |
||||
|
||||
if len(packages) == 0 { |
||||
return result |
||||
} |
||||
|
||||
v := url.Values{} |
||||
v.Set("type", "info") |
||||
for _, pkg := range packages { |
||||
v.Add("arg[]", pkg) |
||||
} |
||||
|
||||
resp, err := http.Get(AURInfoURL + "&" + v.Encode()) |
||||
if err != nil { |
||||
return result |
||||
} |
||||
defer resp.Body.Close() |
||||
|
||||
body, err := io.ReadAll(resp.Body) |
||||
if err != nil { |
||||
return result |
||||
} |
||||
|
||||
var aurResp AURResponse |
||||
if err := json.Unmarshal(body, &aurResp); err != nil { |
||||
return result |
||||
} |
||||
|
||||
for _, r := range aurResp.Results { |
||||
result[r.Name] = true |
||||
} |
||||
|
||||
return result |
||||
} |
||||
Loading…
Reference in new issue