diff --git a/.gitignore b/.gitignore index 7c0563b..8209b0a 100644 --- a/.gitignore +++ b/.gitignore @@ -16,8 +16,7 @@ *.zip # ── 只读参考代码 ───────────────────────────────────────────────────── -# Mole 是本地 clone 的参考项目(自带 .git,272 MB),只用来对照规则设计: -# 不打包、不提交、不发版。 +# 本地 clone 的第三方参考项目(自带 .git,数百 MB),不打包、不提交、不发版。 /Mole/ # ── Rust / 覆盖率 ──────────────────────────────────────────────────── diff --git a/Cargo.toml b/Cargo.toml index 6b0f61e..1394657 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,7 @@ members = ["crates/*"] version = "0.1.0" edition = "2021" rust-version = "1.80" -license = "MIT OR Apache-2.0" +license = "GPL-3.0-only" authors = ["squid contributors"] repository = "https://github.com/nexdev/squid" description = "squid — one tool for cleaning, uninstalling, purging and monitoring your machine" diff --git a/LICENSE b/LICENSE index a2a5fde..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,17 +1,674 @@ -squid is dual-licensed under either of + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 - * the MIT license (see LICENSE-MIT) - * the Apache License, Version 2.0 (see LICENSE-APACHE) + 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. -at your option. + Preamble -SPDX-License-Identifier: MIT OR Apache-2.0 + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -Note on third-party reference code ----------------------------------- + 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. -A copy of the GPL-3.0-licensed project "Mole" may exist in this working tree -for behavioural reference only (it is excluded from version control via -.gitignore). squid is a clean-room implementation: it contains no code copied, -translated, or derived from Mole, and it is not linked against GPL code. The -GPL does not apply to the squid sources distributed under the terms above. + 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/LICENSE-APACHE b/LICENSE-APACHE deleted file mode 100644 index d645695..0000000 --- a/LICENSE-APACHE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT deleted file mode 100644 index 556fc43..0000000 --- a/LICENSE-MIT +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2026 squid contributors - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md index 864eb52..7b93948 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,83 @@ # squid -> clean · uninstall · purge · watch — a system utility that never touches what it does not own +macOS 磁盘清理与系统监控工具:清理缓存与系统垃圾、卸载 App 并连带清掉残留、深度清理构建产物、 +分析磁盘占用、实时监控资源。命令行与内置 TUI 共用同一套引擎,产物是一个静态二进制, +不装后台进程、不写 shell 配置、不需要 root。 -**squid** 用一套 Rust 代码实现了四款经典付费工具的常用能力: +## 特性 -| 参考软件 | squid 对应能力 | 入口 | +| 能力 | 说明 | 入口 | | --- | --- | --- | -| CleanMyMac | 缓存 / 日志 / 浏览器垃圾 / Xcode DerivedData 等可再生文件清理 | `squid clean` | -| AppCleaner | 卸载 App 并连带删除散落的残留 | `squid uninstall` | -| (深度清理)| node_modules、构建产物、磁盘镜像、陈旧压缩包 | `squid purge` | -| DaisyDisk | 磁盘占用树,谁吃掉了我的硬盘 | `squid analyze` / `state` 存储面板 | -| iStat Menus | CPU / 内存 / 网络 / 磁盘 / 温度 / 电池 / 进程实时监控 | `squid status` / `state` 系统面板 | +| 清理 | 39 条内置规则:应用缓存、浏览器缓存、日志与崩溃报告、Xcode DerivedData、废纸篓等 | `squid clean` | +| 卸载 | 按名称或 bundle id 定位 App,本体与散落的偏好、缓存、容器一起进入删除计划 | `squid uninstall` | +| 深度清理 | `node_modules` 等项目构建产物、磁盘镜像、陈旧安装包与下载 | `squid purge` | +| 存储分析 | 体积树与最大文件,可逐层下钻 | `squid analyze`、`state` 存储面板 | +| 系统监控 | CPU / 内存 / 网络 / 磁盘 / 电池 / 温度 / 进程 | `squid status`、`state` 系统面板 | +| 历史与撤销 | 每次真实删除写一条 JSON 账本,可将仍在废纸篓里的文件原样放回 | `squid history`、`squid undo` | -界面(终端里)参考 CleanMyMac:暗色卡片、分组列表、勾选后一键清理。配色按 24-bit 设计, -遇到不支持真彩色的终端(macOS 自带 Terminal.app 就不支持)会自动退到最接近的 256 色, -观感基本一致;`SQUID_TRUECOLOR=always|never` 可以强制。 - -**状态不依赖颜色**:光标行在降级终端里改用「反白 + 加粗」表达(反白由终端自己的前景/背景色 -完成,任何调色板、包括纯灰度终端都能显示),勾选框用加粗 `●` 与细体 `○` 区分,容量条用 -`█/░` 字符而非色块。所以在 Terminal.app、`TERM=vt100`、甚至远程 ssh 里,选中/勾选/进度 -依然看得出来,不需要真彩色。 - -- 语言:Rust(`1.80+`,workspace 拆分为 7 个 crate) -- 平台:macOS 已完整支持;Linux / Windows 通过 `squid-platform` 的 `Platform` trait 预留,见 [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) -- 形态:命令行 + 内置 TUI(`squid state`),无后台常驻进程 +- 语言:Rust 1.80+,workspace 由 7 个 crate 组成 +- 界面:中英双语文案,跟随系统语言;真彩色 / 256 色 / 无色三档自动适配 +- 结构:命令行与 TUI 共用同一套扫描与删除通道,行为、确认、账本完全一致 +- 平台:macOS 完整支持,Linux / Windows 见[路线图](#路线图) --- -## 安装 / 构建 +## 安装 + +squid 是一条普通命令:装完之后在任意目录敲 `squid` 即可,不需要进入安装目录执行。 + +### 从源码 ```bash -# 从源码安装到 ~/.cargo/bin -cargo install --path crates/squid-cli - -# 或者本地构建调试版本 -cargo build -p squid-cli -./target/debug/squid --help +cargo install --path crates/squid-cli # 装到 ~/.cargo/bin +# 或本地构建 +cargo build --release -p squid-cli && ./target/release/squid --help ``` -squid 是**一条普通命令**,不是 .app:装完之后在任意目录敲 `squid` 就行, -不需要进到软件目录里执行,也不会往 shell 配置里写东西、不留后台进程。 - -### 发布安装包(不是 dmg) +### 脚本安装 ```bash -./scripts/release.sh -# -> dist/squid-<版本>-universal-apple-darwin.tar.gz (arm64 + x86_64 通用二进制) -# -> dist/squid-<版本>-universal-apple-darwin.tar.gz.sha256 +./scripts/install.sh # 使用 target/release/squid +./scripts/install.sh ./dist/squid # 安装已下载的二进制 +PREFIX=~/.local/bin ./scripts/install.sh # 免 sudo,装进指定目录 ``` -脚本做的事:`cargo build --release` 两种 Apple target → `lipo -create` 合成通用二进制 -→ ad-hoc `codesign` → 打 tar.gz + sha256,最后打印要填进 -[`packaging/homebrew/squid.rb`](packaging/homebrew/squid.rb) 的校验和与 -`gh release create` 命令。只出当前芯片的包用 `ARCHES="aarch64-apple-darwin" ./scripts/release.sh`。 +安装目录按 `PREFIX` → `/opt/homebrew/bin` → `/usr/local/bin` → `~/.local/bin` 取第一个可写者; +前两者本身就在 `PATH` 上,落到 `~/.local/bin` 且它不在 `PATH` 时,脚本会打印一行待追加到 `~/.zshrc` +的 `export PATH=`。脚本同时清除 `com.apple.quarantine` 并补一次 ad-hoc 签名。 -**为什么是 tar.gz 而不是 dmg**:dmg 的意义是把 `.app` bundle 拖进 Applications, -而 squid 没有 bundle、没有图标、不参与 LaunchServices,套一层 dmg 只会多一次 -「已损坏,无法打开」的隔离属性摩擦。tar.gz 也是 `cargo-binstall` / Homebrew 期望的形状。 -真要给别人装,除了 ad-hoc 签名还需要 Apple Developer ID 签名 + `notarytool` 公证: +### 预编译包 + +发布产物是通用二进制(arm64 + x86_64)的 tar.gz,附带 sha256: ```bash -codesign --force --options runtime --sign "Developer ID Application: ..." dist/squid -xcrun notarytool submit dist/squid-<版本>-universal-apple-darwin.tar.gz --keychain-profile squid --wait -xcrun stapler staple dist/squid-<版本>-universal-apple-darwin.tar.gz +curl -LO https://github.com/nexdev/squid/releases/download/v0.1.0/squid-0.1.0-universal-apple-darwin.tar.gz +curl -LO https://github.com/nexdev/squid/releases/download/v0.1.0/squid-0.1.0-universal-apple-darwin.tar.gz.sha256 +shasum -a 256 -c squid-0.1.0-universal-apple-darwin.tar.gz.sha256 + +tar xzf squid-0.1.0-universal-apple-darwin.tar.gz +install -m 0755 squid-0.1.0-universal-apple-darwin/squid /usr/local/bin/squid +xattr -d com.apple.quarantine /usr/local/bin/squid 2>/dev/null || true ``` -### 装到 PATH - -```bash -./scripts/install.sh # 用 target/release/squid -./scripts/install.sh ./dist/squid # 装下载来的二进制 -PREFIX=~/.local/bin ./scripts/install.sh # 免 sudo,装进自己的目录 -``` - -`install.sh` 按 `/opt/homebrew/bin` → `/usr/local/bin` → `~/.local/bin` 找第一个可写目录 -(`PREFIX=` 可覆盖),装完顺手清 `com.apple.quarantine` 并补一次 ad-hoc 签名。前两个目录 -本来就在 PATH 上,所以装完直接就是 `squid ...`;只有落到 `~/.local/bin` 且它不在 PATH 时, -脚本才会打印一行需要追加到 `~/.zshrc` 的 `export PATH=`。 +包内是 `squid` 通用二进制、`LICENSE`、`README.md`;单架构构建的包名为 +`squid-<版本>-aarch64-apple-darwin.tar.gz` / `…-x86_64-apple-darwin.tar.gz`。 ### Homebrew -`packaging/homebrew/squid.rb` 是可直接放进自己 tap 的 formula 模板(`brew install yourname/tools/squid`), -把 release.sh 输出的 sha256 填进去即可。 +[`packaging/homebrew/squid.rb`](packaging/homebrew/squid.rb) 是可直接放进自有 tap 的 formula 模板, +填入发布脚本输出的 sha256 后 `brew install /tools/squid`。 + +### Gatekeeper 与签名 + +随仓库脚本产出的是 ad-hoc 签名二进制,本机自用与 `install.sh` 安装不会触发拦截。分发给他人时 +需要 Apple Developer ID 签名与公证: + +```bash +codesign --force --options runtime --sign "Developer ID Application: " dist/squid +xcrun notarytool submit dist/squid-<版本>-universal-apple-darwin.tar.gz --keychain-profile squid --wait +xcrun stapler staple dist/squid-<版本>-universal-apple-darwin.tar.gz +``` ## 快速上手 @@ -89,9 +85,9 @@ PREFIX=~/.local/bin ./scripts/install.sh # 免 sudo,装进自己的目录 ```bash squid status # 一次性系统快照(CPU / 内存 / 磁盘 / 进程) -squid doctor # 权限、配置、历史记录自检 +squid doctor # 权限、配置、历史自检,并打印生效路径 -squid clean --dry-run # 看看能清多少,什么都不删 +squid clean --dry-run # 只看能清多少 squid clean # 扫描 → 逐项确认 → 移入废纸篓 squid clean --categories caches,browsers --min-age 7 @@ -102,114 +98,112 @@ squid uninstall Xmind # 卸载并删除残留 squid purge --dry-run # 项目构建产物(node_modules 等) squid purge ~/code ~/work # 指定目录 -squid analyze ~/Library/Caches # 磁盘占用树(DaisyDisk 式) +squid analyze ~/Library/Caches # 磁盘占用树 squid history # squid 删过什么 -squid undo # 把最近一次进废纸篓的会话还原回去 +squid undo # 还原最近一次废纸篓会话 squid state # 进入 TUI ``` ## 命令一览 -全局参数:`--json`(机器可读,日志走 stderr)、`--quiet`、`--no-color`。 +全局参数:`--json`(机器可读,日志走 stderr)、`--quiet`、`--no-color`、`--lang `。 | 命令 | 作用 | 常用参数 | | --- | --- | --- | -| `clean` | 按规则清理缓存、日志、浏览器与开发者垃圾、崩溃报告、废纸篓等 39 条内置规则 | `--dry-run` `-y` `--categories ` `--orphans` `--min-age <天>` `--user-only` `--trash` `--permanent` | +| `clean` | 按规则清理缓存、日志、浏览器与开发者垃圾、崩溃报告、废纸篓等 | `--dry-run` `-y` `--categories ` `--orphans` `--min-age <天>` `--user-only` `--trash` `--permanent` | | `uninstall [NAME]` | 按名称或 bundle id 定位 App,生成并执行「本体 + 残留」计划 | `--list` `--dry-run` `-y` `--trash` `--permanent` `--json` | | `purge [PATHS…]` | 深度清理:项目构建目录、磁盘镜像、安装包、陈旧下载 | `--dry-run` `-y` `--all` `--min-age <天>` `--json` | -| `state` | 打开 TUI:清理 / 卸载 / 深度清理 / 存储 / 系统 / 历史 六个面板 | — | +| `state` | 打开 TUI:清理 / 卸载 / 深度清理 / 存储 / 系统 / 历史 | — | | `status` | 系统快照,适合脚本与 cron | `--processes ` | -| `analyze [PATH]` | 单路径体积树 + 最大文件(默认主目录) | `--depth <层>` `--top ` `--files` | +| `analyze [PATH]` | 单路径体积树与最大文件(默认主目录) | `--depth <层>` `--top ` `--files` | | `history` | 历史会话(时间、命令、释放空间、条目数) | `--limit ` | | `undo [ID]` | 还原某次废纸篓会话(默认最近一次) | — | -| `whitelist add\|list\|remove` | 保护路径,任何扫描都不会再选中它 | — | +| `whitelist add\|list\|remove` | 保护路径,任何扫描不再选中它 | — | | `rules` | 列出当前生效的规则 | `--json` | | `doctor` | 权限探测、配置与历史健康检查 | `--json` | ## TUI(`squid state`) -六个面板,CleanMyMac 式卡片布局:`1` 清理 · `2` 卸载 · `3` 深度清理 · `4` 存储 · `5` 系统 · `6` 历史。 +六个面板:`1` 清理 · `2` 卸载 · `3` 深度清理 · `4` 存储 · `5` 系统 · `6` 历史。 -启动后焦点默认落在左侧的功能选择区:`↑`/`↓` 直接选功能,`enter`(或 `esc`)把方向键交还给右侧的数据列表, -再按一次 `esc` 又回到菜单;`1`–`6` 与 `Tab` 任何时候都能直达。 +启动后焦点位于左侧功能选择区,`↑`/`↓` 选功能,`enter` 或 `esc` 将方向键交还给右侧数据列表, +再按一次 `esc` 回到菜单。 | 按键 | 功能 | | --- | --- | | `Tab` / `1`–`6` | 切换面板 | -| `esc` | 逐级返回,一次只退一级:确认框 → 取消;卸载计划 → 应用列表;最大文件 → 原来的目录;目录 → 上一级;列表 → 功能菜单。帮助浮层、筛选输入框同样吃 `esc`(`n`、`backspace` 也能取消确认框) | +| `esc` | 逐级返回,一次退一级:确认框 → 取消;卸载计划 → 应用列表;最大文件 → 原目录;目录 → 上一级;列表 → 功能菜单。帮助浮层与筛选输入框同样响应 `esc`(确认框还可用 `n`、`backspace` 取消) | | `⌥↑` / `⌥↓`(或 `Ctrl+↑/↓`) | 在任意面板直接切换六个功能 | -| `j` `k` `↑` `↓`、`PgUp/PgDn`、`Home/End` | 移动 | -| `space` | 勾选项目或整个分组 | +| `j` `k` `↑` `↓`、`PgUp`/`PgDn`、`Home`/`End` | 移动 | +| `space` | 勾选条目或整个分组 | | `enter` | 扫描 / 查看详情 / 进入目录 | | `s` | 扫描当前面板 | | `a` | 全选 / 全不选 | | `d` | 清理已勾选内容 | | `m` | 废纸篓 ⇄ 永久删除 | | `u` | 还原上一次废纸篓会话 | -| `f` | 卸载面板:筛选应用列表(输入即筛选,`esc` 清空筛选、`enter` 保留);存储面板:列出当前目录里最大的文件 | +| `f` | 卸载面板:筛选应用列表(`esc` 清空筛选、`enter` 保留);存储面板:列出当前目录最大的文件 | | `h` `l` `←` `→` | 折叠 / 进入 | -| `r` | 刷新当前面板(存储面板重新扫描磁盘占用) | -| `c` | 取消正在运行的任务(`esc` 只负责返回,不取消任务) | +| `r` | 刷新当前面板 | +| `c` | 取消正在运行的任务 | | `?` / `q` | 帮助 / 退出 | -界面语言自动跟随 `$LANG`(中文环境下为中文),也可在配置里写 `language = "en"` 强制英文。 +删除完成后自动重新扫描当前面板,分组容量随之重算;存储面板的磁盘占用走后台刷新, +停在某个下钻目录时只提示按 `r`。进废纸篓不等于已释放空间,标题会区分「移入废纸篓」与「真正释放」, +被 `u` 还原的会话在总计中记为 `0`。 -任务进行中按下的按键不会石沉大海:squid 会弹出提示并说清楚是哪个任务占着通道 -(「删除还在进行,请稍候,或按 `c` 取消」),确认框在忙时按回车只会保留你的回答、等任务结束再按一次即可。 +任务执行期间的按键会给出明确提示(按 `c` 可取消),确认框在忙时保留待确认内容直到任务结束。 -存储面板的磁盘扫描是唯一允许跑在后台的任务:它只读、可能要走几十秒,因此它只把自己挂在标题上的 -「后台扫描」徽章,不会让卸载、清理等其它功能报「上一个任务还在进行」;删除完成后的磁盘占用刷新也走这条后台通道, -进度条结束后一定消失,不留着一条跑完的旧进度条装成卡住的样子。 +**显示适配**:启动时探测终端能力并分三档——终端明确声明支持真彩色(`COLORTERM=truecolor|24bit`、 +iTerm、WezTerm、Ghostty、VS Code、`TERM` 含 `truecolor`)时按设计的 RGB 绘制;否则退到 256 色, +每个 RGB 就近映射到 xterm 调色板,选中行使用灰底高亮条、数据列表用相邻两级灰度交替; +`NO_COLOR` 或 `TERM=dumb` 时完全不发颜色。三档下选中、勾选、进度都由反白 / 加粗 / `●○` / `█░` +表达,不依赖颜色。`SQUID_TRUECOLOR=always|never` 强制指定档位。 -颜色在启动的那一刻就探测完,日志第一行会写出这次拿到的是哪一档,而不是等第一张卡片画错了再猜: - -1. **24-bit 真彩色**:只有终端**明确说得出**自己支持才给(`COLORTERM=truecolor`/`24bit`、iTerm、WezTerm、 - Ghostty、VS Code 这类白名单、或 `TERM` 里带 `truecolor`)。按设计的 RGB 原样绘制,选中行是设计稿里的那条强调色底条。 -2. **256 色**(Apple 的 Terminal.app、`TERM=xterm`、ssh 到老机器、什么都没说的终端):每个 RGB 就近换成 xterm - 调色板里的条目。这一档是默认落点——调色板小一点的代价只是颜色近似,而看不懂 `48;2;r;g;b` 的终端会直接把那串数字打在屏幕上。 - 强调色在小调色板里靠不住,所以选中行换成**灰底高亮条**,右侧数据列表用相邻两级灰度条纹交替—— - 行与行的分别由灰度承担,一行可以从左读到右,光标也不会是 flat 灰板上唯一亮着的一格。 - 两个相邻的灰度若被量化成同一个索引,会自动在灰阶上再走一级,条纹不会消失。 -3. **没有调色板**(设置了 `NO_COLOR`、或 `TERM=dumb`):完全不发颜色,选中行用反白 + 加粗, - 勾选态和菜单里的 `[n]` 徽章另带符号,不依赖任何颜色。 - -`SQUID_TRUECOLOR=never|always` 可以手动降级 / 升级,`NO_COLOR` 与全局的 `squid --no-color` 一样强制走第三档。 - -### 数字是怎么显示的 - -账本里的数字最容易骗人,所以它有明确的规矩: - -- **历史/账本一律两位小数**(`24.31 GB`、`753.66 MB`),列表和侧栏为了紧凑仍是一位(`13.0 GB`)。 -- **计数一定带单位并分组**:中文 `1,634 项`、英文 `1,634`。`1634·24.3 GB` 这种写法已经消失了—— - 中间那个点正好落在小数点该在的位置,两个数会被读成一个坏掉的数。 -- **「可删除」说的是还没删的东西**:清理面板的标题是 `清理 · 62 项 · 可删除 1.79 GB / 25.35 GB`, - 即「已勾选 / 全部发现」,不会再用「已删除」把待办写成结果。 -- **进废纸篓不算已释放**:`d` 默认只是 `rename` 到 `~/.Trash`,同一卷上的改名一个字节都没离开磁盘。 - 标题会写 `27.21 GB 移入废纸篓 · 清空废纸篓后才真正释放`,`u` 还原过的会话在总计里算 `0`, - 那一行自己标 `已还原`(记录本身仍写它当时删了多少)。 -- **删除成功后自动重扫**:一次真实删除会让面板上每个数字都过时(缓存会重建、规则命中的文件也换了), - 所以删除完成即自动跑一遍 `s`,侧栏「分组」的容量随之重算;存储面板的磁盘占用走后台刷新, - 若你正停在某个下钻目录里,则只提示「按 `r` 重新扫描」,不会把你正在读的东西抽走。 -- 中文界面里连分组名都是中文:开发文件 / 系统垃圾 / 应用缓存 / 浏览器缓存 / 日志与崩溃报告 / - 构建产物 / 废纸篓 / 多余语言包 / 卸载残留。 +**语言**:中英双语,判定顺序为配置文件 `language` → `SQUID_LANG` → `LC_ALL` → `LC_MESSAGES` → +`LANG` → macOS 系统偏好(`AppleLocale`/`AppleLanguages`)→ 英文;`C`/`POSIX`/空值视为无信息继续下探。 +`squid doctor` 与 TUI 的 `?` 面板都会打印最终生效的语言与配色档位及其来源。 ## 安全模型 -squid 的前提是:**它可以清理一个 245 GB 的系统盘,但不能毁掉其中的任何一个用户文件。** +前提:**可以清理一个 245 GB 的系统盘,但不能毁掉其中的任何用户文件。** -1. **默认进废纸篓**。`DeleteMode::Trash` 是默认值,`--permanent` 才真正 `unlink`。卸载计划里的 App - 本体(`/Applications/Foo.app`)是真正被删除的一项,不是只删残留;`u` 或 `squid undo` 原样放回。 -2. **`--dry-run` everywhere**。任何会删除的命令都能只看不动。 -3. **非交互环境需要显式确认**。stdin 不是 TTY 时,没有 `-y/--yes` 就直接拒绝执行删除。 -4. **删除时二次校验**。扫描结果可能已经过时,`squid_engine::delete::execute` 会对每一条重新做安全检查、白名单检查和锚点校验,嵌套子项在父项之前处理,避免重复计数与 ENOENT。 -5. **硬性禁区**。`squid_core::safety::SafetyPolicy` 内置 `HARD_DENY`(`/`、`/usr`、`/System`、`/Library`、`/Applications`、`/private/var/folders`…)与 `DENY_EXACT`(`~/Library`、`~/Documents`、`~/.ssh`、`~/.aws`… 只允许删子项、不允许整目录递归删除),递归删除还要求在允许的锚点之下至少 `min_depth = 1` 层,并且永不跟随符号链接。 -6. **规则自带刹车**:`protect` 白名单、`min_age_days`、`needs_admin`、`skip_if_running`(例如 Docker Desktop 正在运行时不会提出删它的 1 TB 虚拟机磁盘)、`risky`(默认不勾选并提示复核)。 -7. **删除账本 + `undo`**。每次真实删除写一个 JSON 会话(含每条的废纸篓目标路径),`squid undo` 把仍留在废纸篓里的文件原样放回。 -8. **白名单**。`squid whitelist add '~/Library/Caches/com.apple.Safari'` 之后,任何规则、任何面板都不会再选中它。 +1. **默认进废纸篓**:`DeleteMode::Trash` 为默认,`--permanent` 才执行 `unlink`;卸载计划包含 App 本体;`squid undo` 原样放回。 +2. **`--dry-run` everywhere**:任何删除命令都能只看不动。 +3. **非交互环境需显式确认**:stdin 不是 TTY 时,缺少 `-y/--yes` 直接拒绝执行删除。 +4. **删除时二次校验**:执行前对每条重新做安全检查、白名单检查与锚点校验;嵌套子项先于父项处理,避免重复计数与 `ENOENT`。 +5. **硬性禁区**:`squid_core::safety::SafetyPolicy` 内置 `HARD_DENY`(`/`、`/usr`、`/System`、`/Library`、`/Applications`、`/private/var/folders` …)与 `DENY_EXACT`(`~/Library`、`~/Documents`、`~/.ssh`、`~/.aws` … 只允许删子项);递归删除要求位于允许锚点之下至少 `min_depth = 1` 层,且永不跟随符号链接。 +6. **规则自带刹车**:`protect` 白名单、`min_age_days`、`needs_admin`、`skip_if_running`(进程运行时不提出删除其虚拟磁盘)、`risky`(默认不勾选并提示复核)。 +7. **删除账本与 `undo`**:每次真实删除写一个 JSON 会话,记录每条的废纸篓目标路径。 +8. **白名单**:`squid whitelist add '~/Library/Caches/com.apple.Safari'` 之后,任何规则与面板都不会再选中该路径。 -## 配置 +## 路径规划 -配置文件:`~/Library/Application Support/squid/config.toml`(`squid doctor` 会打印实际路径)。 +### 数据与配置 + +| 用途 | 默认位置 | 覆盖方式 | +| --- | --- | --- | +| 配置文件 | `~/Library/Application Support/squid/config.toml` | `SQUID_CONFIG_DIR` | +| 自定义规则 | `~/Library/Application Support/squid/rules/*.toml` | `SQUID_CONFIG_DIR` | +| 删除账本 | `~/Library/Application Support/squid/history/<会话>.json` | `SQUID_STATE_DIR` | +| 删除去向 | `~/.Trash`(`delete_mode = "trash"`);`permanent` 时直接 `unlink` | 配置 `delete_mode`、`--trash` / `--permanent` | +| 白名单 | 配置文件 `whitelist` 数组 | `squid whitelist` | +| 内置规则 | 编译进二进制的 `crates/squid-rules/rules/*.toml` | `disabled_rules` | + +Linux 下配置与状态目录遵循 XDG(`$XDG_CONFIG_HOME/squid`、`$XDG_STATE_HOME/squid`,回落到 +`~/.config/squid`、`~/.local/state/squid`)。`squid doctor` 会打印实际生效的配置与账本路径。 + +squid 只在上述位置写入,扫描过程全程只读。 + +### 可执行文件 + +| 安装方式 | 落点 | +| --- | --- | +| `cargo install` | `~/.cargo/bin/squid` | +| `scripts/install.sh` | `$PREFIX` → `/opt/homebrew/bin` → `/usr/local/bin` → `~/.local/bin` | +| `scripts/release.sh` | `dist/squid-<版本>-universal-apple-darwin.tar.gz` 及其 `.sha256` | + +### 配置项 ```toml delete_mode = "trash" # trash | permanent @@ -217,28 +211,25 @@ history_keep = 60 # 保留多少条历史会话 purge_min_age_days = 7 # 7 天内动过的构建产物不算垃圾 purge_max_entries = 200000 # 单个项目探测的文件数上限 show_allocated = true # 显示实际占盘大小而非逻辑大小 -language = "zh" # "en" | "zh",留空跟随 $LANG +language = "zh" # "en" | "zh",留空跟随系统语言 whitelist = ["~/Library/Caches/ImportantApp"] disabled_rules = ["user-trash"] purge_roots = ["~/code", "~/Projects", "~/Desktop"] ``` -环境变量: +### 环境变量 | 变量 | 作用 | | --- | --- | | `SQUID_CONFIG_DIR` | 覆盖配置目录(可移植安装、CI、测试) | | `SQUID_STATE_DIR` | 覆盖状态目录(历史账本所在地) | | `SQUID_TRUECOLOR` | `always` / `never` 强制指定配色能力,跳过自动探测 | -| `SQUID_LANG` | `zh` / `en` 强制界面语言,等价于 `squid --lang zh` | +| `SQUID_LANG` | `zh` / `en` 强制界面语言,等价于 `squid --lang` | +| `NO_COLOR` | 存在即关闭全部颜色输出 | -界面语言判定顺序:配置文件 `language` → `SQUID_LANG` → `LC_ALL` → `LC_MESSAGES` → `LANG` -→ macOS 的 `AppleLocale`/`AppleLanguages`(`defaults read -g`)→ 英文。`C` / `POSIX` / -空值视为「没有信息」,继续往下走,所以在 `ssh`、`cron`、CI 里不会被误判成英文—— -macOS 上仍然能从系统偏好里读到中文。`squid doctor` 会打印 language 和 colour 两行, -标明最终选了什么、是被哪一条决定的;TUI 里按 `?` 也有同样的诊断行。 +### 自定义规则 -自定义规则放到 `/rules/*.toml`,与内置规则合并(同 `id` 覆盖内置): +`/rules/*.toml` 与内置规则合并,同 `id` 覆盖内置: ```toml [[rule]] @@ -254,25 +245,26 @@ select_by_default = true note = "MyApp 会自动重建这些缓存。" ``` -`pattern` 的最长字面量前缀成为该条目的 **锚点(anchor)**,删除时只允许在锚点之下操作——这就是「一个规则写错也不会把 `~/.cargo` 整个删掉」的原因。 +每条 pattern 的最长字面量前缀成为该条目的**锚点(anchor)**,删除只允许发生在锚点之下, +因此一条写错的规则不会波及锚点以外的目录。 ## 项目结构 ``` crates/ ├── squid-core 模型、字节格式化、路径、安全策略、设置、删除账本、进度/取消 -├── squid-platform Platform trait + macOS 实现(App 清单、残留匹配、卷)Linux/Windows 占位 +├── squid-platform Platform trait + macOS 实现(App 清单、残留匹配、卷);Linux/Windows 占位 ├── squid-rules TOML 规则引擎:模式展开、锚点、保护列表、年龄与风险标记 -├── squid-stats sysinfo 采样器、趋势、电池、uptime(iStat 面板的数据源) -├── squid-engine 四大引擎:clean / uninstall / purge / analyze + 唯一的删除通道 delete +├── squid-stats sysinfo 采样器、趋势、电池、uptime +├── squid-engine clean / uninstall / purge / analyze 四个引擎 + 唯一的删除通道 delete ├── squid-tui ratatui 界面(六个面板、任务线程、主题、中英双语文案) └── squid-cli clap 命令行入口 ``` 依赖方向单向:`core → platform → rules → stats → engine → tui → cli`。 -细节见 [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md),威胁模型与 Responsible disclosure 见 [docs/SECURITY.md](docs/SECURITY.md)。 +架构细节见 [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md),威胁模型与漏洞披露见 [docs/SECURITY.md](docs/SECURITY.md)。 -## 开发 +## 开发与测试 ```bash cargo check --workspace --all-targets @@ -280,29 +272,56 @@ cargo clippy --workspace --all-targets -- -D warnings cargo test --workspace --no-fail-fast ``` -TUI 的键盘与渲染取舍用真实 pty 冒烟测试守着(需要 `pyte`): +TUI 的键盘与渲染行为由真实 pty 冒烟测试守护(需要 `pyte`): ```bash python3 -m pip install --user pyte cargo build --release -python3 scripts/tui_smoke.py # menu / menu-mono / uninstall -python3 scripts/tui_smoke.py uninstall # 只跑连续卸载(自己造临时 app,用完删除) +python3 scripts/tui_smoke.py # menu / menu-mono / uninstall +python3 scripts/tui_smoke.py uninstall # 只跑连续卸载 ``` -测试不会删除真实用户数据:删除相关用例写在 `~/Library/Caches/squid-delete-test-*` 的临时目录里,并通过 `SQUID_STATE_DIR` 把账本重定向到临时目录。 +删除相关的测试用例只在 `~/Library/Caches/squid-delete-test-*` 临时目录内操作, +并通过 `SQUID_STATE_DIR` 将账本写入临时目录,不会触碰真实用户数据。 -## 跨平台计划 +## 发布 -| 平台 | 现状 | -| --- | --- | -| macOS | 完整实现(规则、App 残留、卷、Launch Services 卸载钩子) | -| Linux | `squid-platform/src/linux.rs` 已实现 `.desktop` / Flatpak / Snap 应用清单与 XDG 残留目录;缺 `rules/linux.toml` 与真机验证 | -| Windows | `squid-platform/src/windows.rs` 为占位实现,需注册表卸载表、`%LOCALAPPDATA%` 规则、回收站 API 与 UAC 提权 | +```bash +./scripts/release.sh # 通用二进制 +ARCHES="aarch64-apple-darwin" ./scripts/release.sh # 只出当前架构 +``` -## 关于 Mole 与许可证 +脚本执行 `cargo build --release`(各 Apple target)→ `lipo -create` 合成通用二进制 → +ad-hoc `codesign` → 打包 tar.gz 与 sha256,并打印 `gh release create` 命令与需要填进 +Homebrew formula 的校验和。 -squid 的 Rust 实现是**净室(clean-room)实现**:仓库中仅作参考存放的 [Mole](https://github.com) 源码采用 **GPL v3**,本项目**没有复制、翻译或衍生其任何代码**,仅将其作为“清理哪些路径、有哪些坑”的行为参考。`/Mole` 已在 `.gitignore` 中排除。 +## 路线图 -squid 自身采用 **MIT OR Apache-2.0** 双许可证(见 `LICENSE`、`LICENSE-MIT`、`LICENSE-APACHE`)。 +| 平台 | 现状 | 待办 | +| --- | --- | --- | +| macOS | 完整实现(规则、App 残留、卷、卸载钩子)| Developer ID 签名与公证流水线 | +| Linux | `squid-platform/src/linux.rs` 已实现 `.desktop` / Flatpak / Snap 应用清单与 XDG 残留目录 | `rules/linux.toml`、真机验证 | +| Windows | `squid-platform/src/windows.rs` 为占位实现 | 注册表卸载表、`%LOCALAPPDATA%` 规则、回收站 API、UAC 提权 | -如果你把 squid 用于商业分发,请自行确认不与 GPL 代码静态链接。 +其他:规则贡献流程与规则覆盖度基准、TUI 主题自定义、Linux/Windows 冒烟测试。 + +## 许可证 + +squid 采用 **GNU General Public License v3.0 only**(`GPL-3.0-only`),全文见 [LICENSE](LICENSE)。 + +``` +squid — disk cleaning and system monitoring utility +Copyright (C) 2026 squid contributors + +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, version 3. + +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 . +``` diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 0f07280..2f47fbc 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -248,11 +248,8 @@ UndoSession(String)` 三个变体。`ask_delete()` 必须构造其中一个才 把「静默」变成「可见」。`app.rs` 里那三个回归测试直接驱动 `ask_delete() → confirm_delete() → poll()` 到任务结束,断言 `outcome.summary.removed == N`,覆盖卸载、清理/深度清理、以及空确认框三条路径。 -## 关于 Mole(GPL v3)的边界 +## 许可证 -仓库根目录的 `Mole/` 是 GPL v3 的参考实现,已写入 `.gitignore`。squid 是净室实现: - -- 没有任何一行 Rust 代码来自 Mole(Mole 也不是 Rust 写的); -- 参考的是**行为**:哪些路径值得清理、哪些目录是雷区、卸载残留该去哪儿找; -- 规则表是本项目的 `macos.toml`,模式与文案均为本仓库独立编写; -- 分发 squid(MIT OR Apache-2.0)时不携带、不链接 GPL 代码。 +squid 以 `GPL-3.0-only` 发布,全文见仓库根目录的 [`LICENSE`](../LICENSE)。七个 crate 通过 +`[workspace.package] license` 继承同一份许可,`scripts/release.sh` 把 `LICENSE` 与 `README.md` +一起打进发布包,`packaging/homebrew/squid.rb` 声明同一 SPDX 标识符。 diff --git a/packaging/homebrew/squid.rb b/packaging/homebrew/squid.rb index 6f6c356..32883ec 100644 --- a/packaging/homebrew/squid.rb +++ b/packaging/homebrew/squid.rb @@ -12,7 +12,7 @@ class Squid < Formula version "0.1.0" sha256 "REPLACE_WITH_DIST_SQUID_TARBALL_SHA256" url "https://github.com/nexdev/squid/releases/download/v#{version}/squid-#{version}-universal-apple-darwin.tar.gz" - license "MIT OR Apache-2.0" + license "GPL-3.0-only" # 也可以直接从源码装(不需要预先发 release): # depends_on "rust" => :build diff --git a/scripts/release.sh b/scripts/release.sh index bb2bb9b..e5c821c 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -58,7 +58,7 @@ TARBALL="$SLUG.tar.gz" STAGING="$(mktemp -d)" mkdir -p "$STAGING/$SLUG" cp "$BIN" "$STAGING/$SLUG/" -cp LICENSE LICENSE-MIT LICENSE-APACHE README.md "$STAGING/$SLUG/" 2>/dev/null || true +cp LICENSE README.md "$STAGING/$SLUG/" 2>/dev/null || true tar -C "$STAGING" -czf "$DIST/$TARBALL" "$SLUG" rm -rf "$STAGING"