././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1792288280.9904447 bleachbit-6.0.6/0000775000175000017500000000000015265023031011003 5ustar00zz././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/COPYING0000664000175000017500000010451715265023030012045 0ustar00zz GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/MANIFEST.in0000664000175000017500000000200215265023030012532 0ustar00zzinclude doc/CONTRIBUTING.md include COPYING include MANIFEST include MANIFEST.in include Makefile include README.md include bleachbit.png include bleachbit.svg include bleachbit.py include bleachbit.spec include cleaners/*xml include cleaners/Makefile include share/app-menu.ui include share/protected_path.xml include debian/bleachbit.dsc include debian/compat include debian/copyright include debian/debian.changelog include debian/debian.control include debian/debian.rules include doc/cleaner_markup_language.xsd include doc/protected_path.xsd include doc/example_cleaner.xml include org.bleachbit.BleachBit.desktop include org.bleachbit.BleachBit.metainfo.xml include org.bleachbit.policy include po/*po include po/Makefile include setup.py # openSUSE Build Service uses these tests. include tests/*.py include tests/localiz*.txt include windows/*bat include windows/*ps1 include windows/bleachbit.ico include windows/bleachbit.nsi include windows/gtk*pot include windows/requirements.txt recursive-include bleachbit *py ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/Makefile0000664000175000017500000003147415265023030012453 0ustar00zz## # Copyright (C) 2008-2026 Andrew Ziem. All rights reserved. # License GPLv3+: GNU GPL version 3 or later . # This is free software: You are free to change and redistribute it. # There is NO WARRANTY, to the extent permitted by law. ## # On some systems if not explicitly given, make uses /bin/sh SHELL != command -v bash || echo /bin/sh .PHONY: clean install tests tests-pytest tests-nsis build tests-with-sudo lint require-lint-tools delete_windows_files pretty appimage clean-appimage install-deps install-deps-dev prefix ?= /usr/local bindir ?= $(prefix)/bin datadir ?= $(prefix)/share INSTALL = install INSTALL_DATA = $(INSTALL) -m 644 INSTALL_SCRIPT = $(INSTALL) -m 755 # if not specified, do not check coverage PYTHON ?= python3 # Quoted form for calling Python. Windows CI passes a backslash path that bash # mangles unquoted, so use this instead of $(PYTHON). PYTHON_CMD := "$(PYTHON)" COVERAGE ?= $(PYTHON_CMD) # pytest runner used by `tests-pytest`. Extra arguments go in PYTEST_ARGS PYTEST ?= $(PYTHON_CMD) -m pytest PYTEST_ARGS ?= # Set PYTEST_COVERAGE to any value to measure coverage of the pytest runs ifdef PYTEST_COVERAGE PYTEST_COV := --cov=bleachbit --cov-report= PYTEST_COV_APPEND := --cov=bleachbit --cov-append --cov-report= endif # The executable is pyflakes3 on Debian and pyflakes elsewhere, and Debian's # python3-pyflakes ships neither, so fall back to the module. PYFLAKES ?= $(or $(shell command -v pyflakes3 2>/dev/null),\ $(shell command -v pyflakes 2>/dev/null),\ $(PYTHON_CMD) -m pyflakes) # Arguments forwarded to scripts/install-deps.sh, such as --venv INSTALL_DEPS_ARGS ?= # Windows drops pywin32 from ignored-modules so extension-pkg-allow-list can # check it, and ignores the POSIX-only modules instead. # MSYS make does not inherit OS, hence uname. UNAME_S := $(shell uname -s 2>/dev/null) ifneq (,$(filter MSYS% MINGW% CYGWIN%,$(UNAME_S))) PYLINT_ARGS ?= --ignored-modules=bleachbit.GtkShim,certifi,fcntl,gi,gi.repository,plyer,pwd,py2exe,win32com.shell else PYLINT_ARGS ?= endif ifneq ($(COVERAGE),$(PYTHON_CMD)) BLEACHBIT_SUDO_COVERAGE_RUNNER := $(COVERAGE) --append BLEACHBIT_SUDO_COVERAGE_FILE := $(if $(COVERAGE_FILE),$(COVERAGE_FILE),.coverage) else BLEACHBIT_SUDO_COVERAGE_RUNNER := BLEACHBIT_SUDO_COVERAGE_FILE := endif build: echo Nothing to build install-deps: @./scripts/install-deps.sh $(INSTALL_DEPS_ARGS) install-deps-dev: @./scripts/install-deps.sh --dev $(INSTALL_DEPS_ARGS) clean: @rm -vf {.,bleachbit,tests,windows,bleachbit/markovify}/*{pyc,pyo,~} # files @rm -vrf {.,bleachbit,tests,windows,bleachbit/markovify}/__pycache__ # directories @rm -vrf build dist # created by py2exe @rm -rf BleachBit-Portable # created by windows/setup.bat @rm -rf BleachBit-*-portable*.zip @rm -vf MANIFEST # created by setup.py $(MAKE) -C po clean @rm -vrf locale @rm -vrf {*/,./}*.{autopep8,pylint,pyflakes,shellcheck}.log @rm -vrf windows/BleachBit-*-setup*.{exe,zip} @rm -vrf htmlcov .coverage # code coverage reports @rm -vrf *.egg-info # Python package metadata @rm -vrf docker-artifacts # Docker build outputs @rm -rf "$(APPIMAGE_APPDIR)" @rm -f $(LINUXDEPLOY) $(LINUXDEPLOY_GTK_PLUGIN) @rm -f BleachBit-*.AppImage install: # "binary" mkdir -p $(DESTDIR)$(bindir) $(INSTALL_SCRIPT) bleachbit.py $(DESTDIR)$(bindir)/bleachbit # application launcher mkdir -p $(DESTDIR)$(datadir)/applications $(INSTALL_DATA) org.bleachbit.BleachBit.desktop $(DESTDIR)$(datadir)/applications/ # AppStream metadata mkdir -p $(DESTDIR)$(datadir)/metainfo $(INSTALL_DATA) org.bleachbit.BleachBit.metainfo.xml $(DESTDIR)$(datadir)/metainfo/ # Python code mkdir -p $(DESTDIR)$(datadir)/bleachbit/markovify $(INSTALL_DATA) bleachbit/*.py $(DESTDIR)$(datadir)/bleachbit $(INSTALL_DATA) bleachbit/markovify/*.py $(DESTDIR)$(datadir)/bleachbit/markovify #note: compileall is recursive cd $(DESTDIR)$(datadir)/bleachbit && \ $(PYTHON_CMD) -O -c "import compileall; compileall.compile_dir('.')" && \ $(PYTHON_CMD) -c "import compileall; compileall.compile_dir('.')" # cleaners mkdir -p $(DESTDIR)$(datadir)/bleachbit/cleaners $(INSTALL_DATA) cleaners/*.xml $(DESTDIR)$(datadir)/bleachbit/cleaners # share files mkdir -p $(DESTDIR)$(datadir)/bleachbit/share $(INSTALL_DATA) share/app-menu.ui $(DESTDIR)$(datadir)/bleachbit/share $(INSTALL_DATA) share/protected_path.xml $(DESTDIR)$(datadir)/bleachbit/share # icon mkdir -p $(DESTDIR)$(datadir)/pixmaps $(INSTALL_DATA) bleachbit.png $(DESTDIR)$(datadir)/pixmaps/ mkdir -p $(DESTDIR)$(datadir)/icons/hicolor/scalable/apps $(INSTALL_DATA) bleachbit.svg $(DESTDIR)$(datadir)/icons/hicolor/scalable/apps/ # translations $(MAKE) -C po install DESTDIR=$(DESTDIR) # PolicyKit mkdir -p $(DESTDIR)$(datadir)/polkit-1/actions $(INSTALL_DATA) org.bleachbit.policy $(DESTDIR)$(datadir)/polkit-1/actions/ # `lint` only warns about a missing tool, which is fine locally but hides a # skipped check in CI. Depend on this to turn those warnings into an error. require-lint-tools: @missing=; \ $(PYFLAKES) --version >/dev/null 2>&1 || missing="$$missing pyflakes"; \ for c in pylint autopep8 shellcheck appstreamcli; do \ command -v $$c >/dev/null 2>&1 || missing="$$missing $$c"; \ done; \ if [ -n "$$missing" ]; then \ echo "ERROR: Missing lint tools:$$missing"; \ echo "APT users, try: sudo apt install pyflakes3 pylint python3-autopep8 shellcheck appstream"; \ exit 1; \ fi lint: @rc=0; \ if command -v appstreamcli >/dev/null 2>&1; then \ appstreamcli validate org.bleachbit.BleachBit.metainfo.xml || rc=1; \ else \ echo "WARNING: Missing appstreamcli. APT users, try: sudo apt install appstream"; \ fi; \ echo "Running shellcheck, pyflakes, pylint, and autopep8 in parallel: see all.shellcheck.log, all.pyflakes.log, all.pylint.log, and all.autopep8.log"; \ shellcheck_pid=; \ if command -v shellcheck >/dev/null 2>&1; then \ shellcheck scripts/*.sh docker/*.sh > all.shellcheck.log 2>&1 & \ shellcheck_pid=$$!; \ else \ echo "WARNING: Missing shellcheck. APT users, try: sudo apt install shellcheck"; \ fi; \ pyflakes_pid=; \ if $(PYFLAKES) --version >/dev/null 2>&1; then \ $(PYFLAKES) {.,bleachbit,tests,windows}/*py > all.pyflakes.log 2>&1 & \ pyflakes_pid=$$!; \ else \ echo "WARNING: Missing pyflakes. APT users, try: sudo apt install pyflakes3"; \ fi; \ pylint_pid=; \ if command -v pylint >/dev/null 2>&1; then \ pylint -j 0 $(PYLINT_ARGS) {.,bleachbit,tests,windows}/*py > all.pylint.log 2>&1 & \ pylint_pid=$$!; \ else \ echo "WARNING: Missing pylint. APT users, try: sudo apt install pylint"; \ fi; \ autopep8_pid=; \ if command -v autopep8 >/dev/null 2>&1; then \ autopep8 --diff --exit-code {.,bleachbit,tests,windows}/*py > all.autopep8.log 2>&1 & \ autopep8_pid=$$!; \ else \ echo "WARNING: Missing autopep8. APT users, try: sudo apt install python3-autopep8"; \ fi; \ if [ -n "$$shellcheck_pid" ]; then \ wait $$shellcheck_pid || { \ rc=1; \ echo "ERROR: shellcheck reported problems"; \ cat all.shellcheck.log; \ }; \ fi; \ if [ -n "$$pyflakes_pid" ]; then \ wait $$pyflakes_pid || { \ rc=1; \ echo "ERROR: pyflakes reported problems"; \ cat all.pyflakes.log; \ }; \ fi; \ if [ -n "$$pylint_pid" ]; then \ wait $$pylint_pid || { \ rc=1; \ echo "ERROR: pylint reported problems"; \ cat all.pylint.log; \ }; \ fi; \ if [ -n "$$autopep8_pid" ]; then \ wait $$autopep8_pid || { \ rc=1; \ echo "ERROR: autopep8 would reformat; run make pretty"; \ cat all.autopep8.log; \ }; \ fi; \ wait; \ exit $$rc delete_windows_files: # This is used for building .deb and .rpm packages. # Remove Windows-specific cleaners. grep -l "cleaner id=\"\w*\" os=\"windows\"" cleaners/*xml | xargs rm -f # Remove Windows-specific code. rm -f bleachbit/{Winapp,Windows*}.py tests/TestWindows{,Wipe}.py # The windows/ directory is left in place because removing it breaks po/Makefile. tests: # Check translations but do not abort. $(MAKE) -C po tests # Catch Python warnings as errors. Also set in `tests/common.py`. $(MAKE) -C cleaners tests; cleaners_status=$$?; \ PYTHONWARNINGS=error $(COVERAGE) -m unittest discover -p Test*.py -v; py_status=$$?; \ $(MAKE) tests-nsis; nsis_status=$$?; \ exit $$(($$cleaners_status + $$py_status + $$nsis_status)) # The suite CI runs: the xdist pass, then the serial no_xdist pass. # The second pass is skipped if the first fails. tests-pytest: PYTHONWARNINGS=error PYTHONPATH=. $(PYTEST) -n logical --dist=loadgroup \ -m 'not no_xdist' $(PYTEST_COV) $(PYTEST_ARGS) PYTHONWARNINGS=error PYTHONPATH=. $(PYTEST) \ -m no_xdist $(PYTEST_COV_APPEND) $(PYTEST_ARGS) tests-nsis: $(PYTHON_CMD) windows/nsis_translations.py --unittest tests-with-sudo: # Run tests marked with @also_with_sudo using sudo PYTHONWARNINGS=error \ BLEACHBIT_COVERAGE_RUNNER="$(BLEACHBIT_SUDO_COVERAGE_RUNNER)" \ BLEACHBIT_COVERAGE_FILE="$(BLEACHBIT_SUDO_COVERAGE_FILE)" \ $(PYTHON_CMD) tests/test_with_sudo.py pretty: @if command -v autopep8 >/dev/null 2>&1; then \ echo "Running autopep* on .py files"; \ autopep8 -i {.,bleachbit,tests,windows}/*py; \ else \ echo "WARNING: Missing autopep8. APT users, try: sudo apt install python3-autopep8"; \ fi @if command -v dos2unix >/dev/null 2>&1; then \ echo "Running dos2unix on .py files"; \ dos2unix {.,bleachbit,tests,windows}/*py; \ else \ echo "WARNING: Missing dos2unix. APT users, try: sudo apt install dos2unix"; \ fi $(MAKE) -C cleaners pretty @if command -v xmllint >/dev/null 2>&1; then \ echo "Running xmllint on .xsd file"; \ xmllint --format doc/cleaner_markup_language.xsd > doc/cleaner_markup_language.xsd.tmp; \ mv doc/cleaner_markup_language.xsd.tmp doc/cleaner_markup_language.xsd; \ else \ echo "WARNING: Missing xmllint. APT users, try: sudo apt install libxml2-utils"; \ fi # AppImage build APPIMAGE_BUILD_DIR ?= appimage-build APPIMAGE_APPDIR := $(abspath $(APPIMAGE_BUILD_DIR)) APPIMAGE_OUTPUT ?= BleachBit-$(shell $(PYTHON_CMD) -c "import sys; sys.path.insert(0,'.'); from bleachbit import APP_VERSION; print(APP_VERSION)" 2>/dev/null || echo "latest")-x86_64.AppImage APPIMAGE_OUTPUT_PATH := $(abspath $(APPIMAGE_OUTPUT)) LINUXDEPLOY ?= linuxdeploy-x86_64.AppImage LINUXDEPLOY_GTK_PLUGIN ?= linuxdeploy-plugin-gtk.sh LINUXDEPLOY_URL ?= https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-x86_64.AppImage LINUXDEPLOY_GTK_PLUGIN_URL ?= https://raw.githubusercontent.com/linuxdeploy/linuxdeploy-plugin-gtk/master/linuxdeploy-plugin-gtk.sh $(LINUXDEPLOY): @echo "* Downloading linuxdeploy" wget -c "$(LINUXDEPLOY_URL)" -O $(LINUXDEPLOY) chmod +x $(LINUXDEPLOY) $(LINUXDEPLOY_GTK_PLUGIN): @echo "* Downloading linuxdeploy-plugin-gtk" wget -c "$(LINUXDEPLOY_GTK_PLUGIN_URL)" -O $(LINUXDEPLOY_GTK_PLUGIN) chmod +x $(LINUXDEPLOY_GTK_PLUGIN) appimage: $(LINUXDEPLOY) $(LINUXDEPLOY_GTK_PLUGIN) @echo "* Building AppImage: $(APPIMAGE_OUTPUT)" # Clean previous build rm -rf "$(APPIMAGE_APPDIR)" # Build translations (.mo files) $(MAKE) -C po # Install application into AppDir with prefix=/usr $(MAKE) install DESTDIR="$(APPIMAGE_APPDIR)" prefix=/usr # Copy icon to hicolor theme so linuxdeploy can find it mkdir -p "$(APPIMAGE_APPDIR)/usr/share/icons/hicolor/256x256/apps" cp bleachbit.png "$(APPIMAGE_APPDIR)/usr/share/icons/hicolor/256x256/apps/bleachbit.png" # Run GTK plugin first to set up AppDir (hooks, schemas, loaders, etc.) # DEPLOY_GTK_VERSION must be set because bleachbit is a Python script, # not a compiled binary, so auto-detection of GTK version fails. DEPLOY_GTK_VERSION=3 ./$(LINUXDEPLOY) \ --appdir "$(APPIMAGE_APPDIR)" \ --plugin gtk # Patch the hook file before packaging: # 1. Prepend bundled libraries to LD_LIBRARY_PATH so the AppImage's # GTK/gdk-pixbuf libraries are used instead of the host system's. # Without this, the host's gdk-pixbuf ignores GDK_PIXBUF_MODULEDIR # and cannot find the bundled pixbuf loaders. # 2. Export GDK_PIXBUF_MODULEDIR so gdk-pixbuf can resolve the # relative loader paths in loaders.cache. sed -i '1s|^|export LD_LIBRARY_PATH="$$APPDIR/usr/lib:$$LD_LIBRARY_PATH"\n|' \ "$(APPIMAGE_APPDIR)/apprun-hooks/linuxdeploy-plugin-gtk.sh" echo 'export GDK_PIXBUF_MODULEDIR="$$APPDIR/usr/lib/gdk-pixbuf-2.0/2.10.0/loaders"' \ >> "$(APPIMAGE_APPDIR)/apprun-hooks/linuxdeploy-plugin-gtk.sh" # Package the AppDir into an AppImage ./$(LINUXDEPLOY) \ --appdir "$(APPIMAGE_APPDIR)" \ --output appimage # linuxdeploy names output after the desktop file; rename to our convention @if [ -f BleachBit-x86_64.AppImage ] && [ "$(abspath BleachBit-x86_64.AppImage)" != "$(APPIMAGE_OUTPUT_PATH)" ]; then \ mv BleachBit-x86_64.AppImage "$(APPIMAGE_OUTPUT_PATH)"; \ fi # Test the AppImage to check it doesn't crash @if [ -n "$${SKIP_APPIMAGE_TEST:-}" ]; then \ echo "SKIP_APPIMAGE_TEST is set, skipping AppImage test."; \ else \ "$(APPIMAGE_OUTPUT_PATH)" --sysinfo; \ fi @echo "* AppImage created: $(APPIMAGE_OUTPUT_PATH)" ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1792288280.9904263 bleachbit-6.0.6/PKG-INFO0000644000175000017500000000150315265023031012075 0ustar00zzMetadata-Version: 2.4 Name: bleachbit Version: 6.0.6 Summary: BleachBit Home-page: https://www.bleachbit.org Download-URL: https://www.bleachbit.org/download Author: Andrew Ziem Author-email: andrew@bleachbit.org License: GPL-3.0-or-later Platform: Linux and Windows Platform: Python v3.8+ Platform: GTK v3.24+ Classifier: Development Status :: 5 - Production/Stable Classifier: Programming Language :: Python Classifier: Operating System :: Microsoft :: Windows Classifier: Operating System :: POSIX :: Linux License-File: COPYING Dynamic: author Dynamic: author-email Dynamic: classifier Dynamic: description Dynamic: download-url Dynamic: home-page Dynamic: license Dynamic: license-file Dynamic: platform Dynamic: summary BleachBit frees space and maintains privacy by quickly wiping files you don't need and didn't know you had. ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/README.md0000664000175000017500000000560615265023030012270 0ustar00zz# BleachBit BleachBit cleans files to free disk space and to maintain privacy. ## Running from source To run BleachBit without installation, first install the system dependencies, then build the translations and run it: ```sh make install-deps # runtime deps (auto-detects Debian/Fedora/openSUSE/Arch) make -C po local # build translations python3 bleachbit.py ``` Many Linux systems have the basic dependencies: you may skip installation, but in case of any issues, please check for missing dependencies. Then, review the preferences. Then, select some options, and click Preview. Review the files, toggle options accordingly, and click Delete. For information regarding the command line interface, run: ```sh python3 bleachbit.py --help ``` Read more about [running from source](https://docs.bleachbit.org/dev/running-from-source-code.html). ## Links * [BleachBit home page](https://www.bleachbit.org) * [Support](https://www.bleachbit.org/help) * [Documentation](https://docs.bleachbit.org) ## Localization Read [translation documentation](https://www.bleachbit.org/contribute/translate) or translate now in [Weblate](https://hosted.weblate.org/projects/bleachbit/), a web-based translation platform. Translation status ## Licenses BleachBit itself, including source code and cleaner definitions, is licensed under the [GNU General Public License version 3](COPYING), or at your option, any later version. markovify is licensed under the [MIT License](https://github.com/jsvine/markovify/blob/master/LICENSE.txt). ## Development To develop, run the test suite, or build packages, install the extra build/test/lint/packaging tools too: ```sh make install-deps-dev ``` Common commands include: ```sh make tests # run tests make lint # check .py and .sh files for issues make pretty # format .py and .xml files ``` More resources: * [![Build and Test](https://github.com/bleachbit/bleachbit/actions/workflows/build_and_test.yaml/badge.svg?branch=master)](https://github.com/bleachbit/bleachbit/actions/workflows/build_and_test.yaml) * [![Run tests on macOS](https://github.com/bleachbit/bleachbit/actions/workflows/test_macos.yaml/badge.svg?branch=master)](https://github.com/bleachbit/bleachbit/actions/workflows/test_macos.yaml) * [CleanerML Repository](https://github.com/bleachbit/cleanerml) * [BleachBit Miscellaneous Repository](https://github.com/bleachbit/bleachbit-misc) * [Winapp2.ini Repository](https://github.com/bleachbit/winapp2.ini) ### Docker-based Linux builds The `docker/build.sh` script sets up a container, runs `make tests`, and builds packages for a selected distribution. Usage: ```sh ./docker/build.sh # distro is one of {debian, fedora, opensuse} ``` Artifacts are copied to `./docker-artifacts/` on the host. ././@PaxHeader0000000000000000000000000000003400000000000010212 xustar0028 mtime=1792288280.9548566 bleachbit-6.0.6/bleachbit/0000775000175000017500000000000015265023031012720 5ustar00zz././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/bleachbit/Action.py0000775000175000017500000006176215265023030014525 0ustar00zz# SPDX-License-Identifier: GPL-3.0-or-later # Copyright (c) 2008-2026 Andrew Ziem. # # This work is licensed under the terms of the GNU GPL, version 3 or # later. See the COPYING file in the top-level directory. """ Actions that perform cleaning """ # standard imports import glob import logging import os import re from itertools import product # first party imports from bleachbit import Command, FileUtilities, General, Special, DeepScan, Cookie as CookieMod # mod=module from bleachbit import FS_SCAN_RE_FLAGS, IS_MAC, IS_POSIX, IS_WINDOWS from bleachbit.Constant import CLEAN_FILE_LABEL from bleachbit.Cookie import load_keep_list from bleachbit.Language import get_text as _ if IS_POSIX: from bleachbit import Unix if IS_WINDOWS: from bleachbit import Windows logger = logging.getLogger(__name__) _GLOB_CHARS_RE = re.compile(r'[?*\[\]]') def has_glob(s): """Checks whether the string contains any glob characters""" return _GLOB_CHARS_RE.search(s) is not None def expand_multi_var(s, variables): """Expand strings with potentially-multiple values. The placeholder is written in the format $$foo$$. The function always returns a list of one or more strings. """ if not variables or s.find('$$') == -1: # The input string is missing $$ or no variables are given. return (s,) var_keys_used = [] ret = [] for var_key in variables.keys(): sub = f'$${var_key}$$' if s.find(sub) > -1: var_keys_used.append(var_key) if not var_keys_used: # No matching variables used, so return input string unmodified. return (s,) # filter the dictionary to the keys used vars_used = {key: value for key, value in variables.items() if key in var_keys_used} # create a product of combinations vars_product = (dict(zip(vars_used, x)) for x in product(*vars_used.values())) for var_set in vars_product: ms = s # modified version of input string for var_key, var_value in var_set.items(): sub = f'$${var_key}$$' ms = ms.replace(sub, var_value) ret.append(ms) if ret: return ret # The string has $$, but it did not match anything return (s,) # # Plugin framework # https://martyalchin.com/2008/jan/10/simple-plugin-framework/ # class PluginMount(type): """A simple plugin framework""" def __init__(cls, _name, _bases, _attrs): if not hasattr(cls, 'plugins'): cls.plugins = [] cls.plugins_by_key = {} else: cls.plugins.append(cls) # Indexed here, not on demand: Cleaner and tests register later. action_key = getattr(cls, 'action_key', None) if action_key is not None: cls.plugins_by_key[action_key] = cls class ActionProvider(metaclass=PluginMount): """Abstract base class for performing individual cleaning actions""" def __init__(self, action_node, path_vars=None): """Create ActionProvider from CleanerML """ def get_deep_scan(self): """Return an iterable of deep scan searches (empty by default)""" return () def get_commands(self): """Yield each command (which can be previewed or executed)""" # # base class # class FileActionProvider(ActionProvider): """Base class for providers which work on individual files""" action_key = '_file' CACHEABLE_SEARCHERS = ('walk.files',) # global cache cache = ('nothing', '', tuple(), False) def __init__(self, action_element, path_vars=None): """Initialize file search""" ActionProvider.__init__(self, action_element, path_vars) self.regex = action_element.getAttribute('regex') assert (isinstance(self.regex, (str, type(None)))) self.nregex = action_element.getAttribute('nregex') assert (isinstance(self.nregex, (str, type(None)))) self.wholeregex = action_element.getAttribute('wholeregex') assert (isinstance(self.wholeregex, (str, type(None)))) self.nwholeregex = action_element.getAttribute('nwholeregex') assert (isinstance(self.nwholeregex, (str, type(None)))) self.search = action_element.getAttribute('search') self.object_type = action_element.getAttribute('type') self._set_paths(action_element.getAttribute('path'), path_vars) self.ds = None if 'deep' == self.search: self.ds = (self.paths[0], DeepScan.Search( command=action_element.getAttribute('command'), regex=self.regex, nregex=self.nregex, wholeregex=self.wholeregex, nwholeregex=self.nwholeregex)) if len(self.paths) != 1: logger.warning( # TRANSLATORS: Multi-value variables are explained # in the online documentation. Basically, they are like # an environment variable, but each multi-value variable # can have multiple values. They're a way to make CleanerML # files more concise. _("Deep scan does not support multi-value variables.")) # If the filter is not needed, bypass it for speed. self._use_fast_path = not any([self.object_type, self.regex, self.nregex, self.wholeregex, self.nwholeregex]) def _set_paths(self, raw_path, path_vars): """Set the list of paths to work on""" self.paths = [] # expand special $$foo$$ which may give multiple values for path2 in expand_multi_var(raw_path, path_vars): if IS_WINDOWS: paths = Windows.expand_windows_system_vars(path2) else: paths = (path2, ) for path3 in paths: path3 = os.path.expanduser(os.path.expandvars(path3)) if IS_WINDOWS and path3: # convert forward slash to backslash for compatibility with getsize() # and for display. Do not convert an empty path, or it will become # the current directory (.). path3 = os.path.normpath(path3) self.paths.append(path3) def get_deep_scan(self): if self.ds is None: return yield self.ds def get_paths(self): """Dispatch to fast or filtered path retrieval based on filter configuration.""" if self._use_fast_path: yield from self._get_paths() else: yield from self._get_paths_filtered() def _get_paths_filtered(self): """Process the filters: regex, nregex, type If a filter is defined and it fails to match, this function returns False. Otherwise, this function returns True.""" # optimize tight loop, avoid slow python "." regex = self.regex nregex = self.nregex wholeregex = self.wholeregex nwholeregex = self.nwholeregex basename = os.path.basename object_type = self.object_type if self.regex: regex_c_search = re.compile(self.regex, FS_SCAN_RE_FLAGS).search else: regex_c_search = None if self.nregex: nregex_c_search = re.compile(self.nregex, FS_SCAN_RE_FLAGS).search else: nregex_c_search = None if self.wholeregex: wholeregex_c_search = re.compile( self.wholeregex, FS_SCAN_RE_FLAGS).search else: wholeregex_c_search = None if self.nwholeregex: nwholeregex_c_search = re.compile( self.nwholeregex, FS_SCAN_RE_FLAGS).search else: nwholeregex_c_search = None for path in self._get_paths(): if regex and not regex_c_search(basename(path)): continue if nregex and nregex_c_search(basename(path)): continue if wholeregex and not wholeregex_c_search(path): continue if nwholeregex and nwholeregex_c_search(path): continue if object_type: if 'f' == object_type and not os.path.isfile(path): continue if 'd' == object_type and not os.path.isdir(path): continue yield path def _get_paths(self): """Return a filtered list of files""" def get_file(path): if os.path.lexists(path): yield path def get_walk_all(top): """Delete files and directories inside a directory but not the top directory""" for expanded in glob.iglob(top): yield from FileUtilities.children_in_directory(expanded, True) # This is a lint checker because this scenario may # indicate the cleaner developer made a mistake. if os.path.isfile(expanded): logger.debug( # TRANSLATORS: This is a lint-style warning that there seems to be a # mild mistake in the CleanerML file because walk.all is expected to # be used with directories instead of with files. Do not translate # search="walk.all" and path="%s" _('search="walk.all" used with regular file path="%s"'), expanded, ) def get_walk_files(top): """Delete files inside a directory but not any directories""" for expanded in glob.iglob(top): yield from FileUtilities.children_in_directory(expanded, False) def get_top(top): """Delete directory contents and the directory itself""" yield from get_walk_all(top) if os.path.exists(top): yield top if 'deep' == self.search: return search_functions = { 'file': get_file, 'glob': glob.iglob, 'walk.all': get_walk_all, 'walk.files': get_walk_files, 'walk.top': get_top } if self.search not in search_functions: raise RuntimeError(f"Invalid search='{self.search}'") func = search_functions[self.search] cache = self.__class__.cache for input_path in self.paths: if self.search == 'glob' and not has_glob(input_path): # TRANSLATORS: This is a lint-style warning that the CleanerML file # specified a search for glob, but the path specified didn't have any # wildcard patterns. Therefore, maybe the developer either missed # the wildcard or should search using path="file" which does not # expect or support wildcards in the path. logger.debug(_('path="%s" is not a glob pattern'), input_path) # use cache if (self.search in self.CACHEABLE_SEARCHERS and cache[0] == self.search and cache[1] == input_path and cache[3]): yield from cache[2] return self.__class__.cache = ('cleared by', input_path, tuple(), False) # build new cache if self.search in self.CACHEABLE_SEARCHERS: entries = [] self.__class__.cache = ( self.search, input_path, entries, False) for path in func(input_path): entries.append(path) yield path # Mark complete only once the walk finishes, so an # early-abandoned generator doesn't poison the cache self.__class__.cache = (self.search, input_path, entries, True) else: yield from func(input_path) def get_commands(self): raise NotImplementedError('not implemented') # # Action providers # class AptAutoclean(ActionProvider): """Action to run 'apt-get autoclean'""" action_key = 'apt.autoclean' def get_commands(self): assert IS_POSIX # If apt-get is not installed, then enable fast auto-hide. # The exe_exists() function is fast. if not FileUtilities.exe_exists(General.resolve_exe('apt-get')): return yield Command.Function(None, # pylint: disable=possibly-used-before-assignment Unix.apt_autoclean, 'apt-get autoclean') class AptAutoremove(ActionProvider): """Action to run 'apt-get autoremove'""" action_key = 'apt.autoremove' def get_commands(self): if not FileUtilities.exe_exists(General.resolve_exe('apt-get')): return yield Command.Function(None, Unix.apt_autoremove, 'apt-get autoremove') class AptClean(ActionProvider): """Action to run 'apt-get clean'""" action_key = 'apt.clean' def get_commands(self): if not FileUtilities.exe_exists(General.resolve_exe('apt-get')): return yield Command.Function(None, Unix.apt_clean, 'apt-get clean') class ChromeAutofill(FileActionProvider): """Action to clean 'autofill' table in Google Chrome/Chromium""" action_key = 'chrome.autofill' def get_commands(self): for path in self.get_paths(): yield Command.Function( path, Special.delete_chrome_autofill, CLEAN_FILE_LABEL) class ChromeDatabases(FileActionProvider): """Action to clean Databases.db in Google Chrome/Chromium""" action_key = 'chrome.databases_db' def get_commands(self): for path in self.get_paths(): yield Command.Function( path, Special.delete_chrome_databases_db, CLEAN_FILE_LABEL) class ChromeFavicons(FileActionProvider): """Action to clean 'Favicons' file in Google Chrome/Chromium""" action_key = 'chrome.favicons' def get_commands(self): for path in self.get_paths(): yield Command.Function( path, Special.delete_chrome_favicons, CLEAN_FILE_LABEL) class ChromeOrphanedFrameworkVersions(FileActionProvider): """Action to remove orphaned old version folders left behind under a Chromium-based browser's Contents/Frameworks/*.framework/Versions/ on macOS, keeping only the one the 'Current' symlink points to.""" action_key = 'macos.orphaned_framework_versions' def get_commands(self): if not IS_MAC: # This action only ever applies to macOS .app bundles; # 'Unix' may not even be imported on other platforms. return for versions_dir in self.get_paths(): for orphan_path in Unix.orphaned_framework_versions(versions_dir): yield Command.Delete(orphan_path) class ChromeHistory(FileActionProvider): """Action to clean 'History' file in Google Chrome/Chromium""" action_key = 'chrome.history' def get_commands(self): for path in self.get_paths(): yield Command.Function( path, Special.delete_chrome_history, CLEAN_FILE_LABEL) class ChromeKeywords(FileActionProvider): """Action to clean 'keywords' table in Google Chrome/Chromium""" action_key = 'chrome.keywords' def get_commands(self): for path in self.get_paths(): yield Command.Function( path, Special.delete_chrome_keywords, CLEAN_FILE_LABEL) class Cookie(FileActionProvider): """Action to selectively clean cookies in Chromium/Mozilla browsers""" action_key = 'cookie' def get_commands(self): keep_list = load_keep_list() if not keep_list: # If nothing is being kept, use regular delete for better performance for path in self.get_paths(): yield Command.Delete(path) return # Otherwise, clean cookies using the keep list. for path in self.get_paths(): def delete_func(p=path): # perform deletion; return value is ignored by Command.Function for file paths try: CookieMod.delete_cookies(p, keep_list, really_delete=True) except Exception as e: logger.warning('Cookie cleaning failed on %s: %s', p, e) return 0 def preview_func(p=path): # return estimated file size reduction try: result = CookieMod.delete_cookies( p, keep_list, really_delete=False) return result.get('file_size_reduction', 0) except Exception as e: logger.warning( 'Cookie cleaning preview failed on %s: %s', p, e) return 0 yield Command.Function( path, delete_func, # TRANSLATORS: This is the name of a cleaning action. 'Clean' is a verb. # It shows in the log of actions performed. _('Clean cookies'), preview_func) class Delete(FileActionProvider): """Action to delete files""" action_key = 'delete' def get_commands(self): for path in self.get_paths(): yield Command.Delete(path) class Ini(FileActionProvider): """Action to clean .ini configuration files""" action_key = 'ini' def __init__(self, action_element, path_vars=None): FileActionProvider.__init__(self, action_element, path_vars) self.section = action_element.getAttribute('section') self.parameter = action_element.getAttribute('parameter') if self.parameter == "": self.parameter = None def get_commands(self): for path in self.get_paths(): yield Command.Ini(path, self.section, self.parameter) class Journald(ActionProvider): """Action to run 'journalctl --vacuum-time=1'""" action_key = 'journald.clean' def get_commands(self): # If journalctl is not installed, then enable fast auto-hide. if not FileUtilities.exe_exists(General.resolve_exe('journalctl')): return yield Command.Function(None, Unix.journald_clean, 'journalctl --vacuum-time=1') class Json(FileActionProvider): """Action to clean JSON configuration files""" action_key = 'json' def __init__(self, action_element, path_vars=None): FileActionProvider.__init__(self, action_element, path_vars) self.address = action_element.getAttribute('address') def get_commands(self): for path in self.get_paths(): yield Command.Json(path, self.address) class MozillaUrlHistory(FileActionProvider): """Action to clean Mozilla (Firefox) URL history in places.sqlite""" action_key = 'mozilla.url.history' def get_commands(self): for path in self.get_paths(): yield Command.Function(path, Special.delete_mozilla_url_history, CLEAN_FILE_LABEL) class MozillaFavicons(FileActionProvider): """Action to clean Mozilla (Firefox) favicons in favicons.sqlite""" action_key = 'mozilla.favicons' def get_commands(self): for path in self.get_paths(): yield Command.Function(path, Special.delete_mozilla_favicons, CLEAN_FILE_LABEL) class OfficeRegistryModifications(FileActionProvider): """Action to delete LibreOffice history""" action_key = 'office_registrymodifications' def get_commands(self): for path in self.get_paths(): yield Command.Function( path, Special.delete_office_registrymodifications, CLEAN_FILE_LABEL) class Process(ActionProvider): """Action to run a process""" action_key = 'process' def __init__(self, action_element, path_vars=None): ActionProvider.__init__(self, action_element, path_vars) self.cmd = os.path.expandvars(action_element.getAttribute('cmd')) # by default, wait self.wait = True wait = action_element.getAttribute('wait') if wait and wait.lower()[0] in ('f', 'n'): # false or no self.wait = False def get_commands(self): def run_process(): try: args = General.shell_split(self.cmd) (rc, stdout, stderr) = General.run_external(args, wait=self.wait) except Exception as e: raise RuntimeError( f'Exception in external command\nCommand: {args}\nError: {str(e)}') from e if self.wait and 0 != rc: logger.warning('Command: %s\nReturn code: %d\nStdout: %s\nStderr: %s\n', args, rc, stdout, stderr) return 0 yield Command.Function(path=None, func=run_process, # TRANSLATORS: %s is the command line to be executed label=_("Run external command: %s") % self.cmd) class Shred(FileActionProvider): """Action to shred files (override preference)""" action_key = 'shred' def get_commands(self): for path in self.get_paths(): yield Command.Shred(path) class SqliteVacuum(FileActionProvider): """Action to vacuum SQLite databases""" action_key = 'sqlite.vacuum' def get_commands(self): for path in self.get_paths(): yield Command.Function( path, FileUtilities.vacuum_sqlite3, # TRANSLATORS: Vacuum is a verb. The term is jargon # from the SQLite database. Microsoft Access uses # the term 'Compact Database' (which you may translate # instead). Another synonym is 'defragment.' _('Vacuum')) class Truncate(FileActionProvider): """Action to truncate files""" action_key = 'truncate' def get_commands(self): for path in self.get_paths(): yield Command.Truncate(path) class WinShellChangeNotify(ActionProvider): """Action to clean the Windows Registry""" action_key = 'win.shell.change.notify' def get_commands(self): assert IS_WINDOWS yield Command.Function( None, # pylint: disable=possibly-used-before-assignment Windows.shell_change_notify, # TRANSLATORS: This is the name of an action. 'Refresh' is a verb. _('Refresh Windows shell')) class Winreg(ActionProvider): """Action to clean the Windows Registry""" action_key = 'winreg' def __init__(self, action_element, path_vars=None): ActionProvider.__init__(self, action_element, path_vars) self.keyname = action_element.getAttribute('path') self.name = action_element.getAttribute('name') self.excludekeys = [] def get_commands(self): if IS_WINDOWS: yield Command.Winreg(self.keyname, self.name, self.excludekeys) class YumCleanAll(ActionProvider): """Action to run 'yum clean all'""" action_key = 'yum.clean_all' def get_commands(self): # If yum is not installed, then enable fast auto-hide. if not FileUtilities.exe_exists(General.resolve_exe('yum')): return yield Command.Function( None, Unix.yum_clean, 'yum clean all') class DnfCleanAll(ActionProvider): """Action to run 'dnf clean all'""" action_key = 'dnf.clean_all' def get_commands(self): # If dnf is not installed, then enable fast auto-hide. if not FileUtilities.exe_exists(General.resolve_exe('dnf')): return yield Command.Function( None, Unix.dnf_clean, 'dnf clean all') class DnfAutoremove(ActionProvider): """Action to run 'dnf autoremove'""" action_key = 'dnf.autoremove' def get_commands(self): # If dnf is not installed, then enable fast auto-hide. if not FileUtilities.exe_exists(General.resolve_exe('dnf')): return yield Command.Function( None, Unix.dnf_autoremove, 'dnf autoremove') class PacmanCache(ActionProvider): """Action to run `paccache -rk0'""" action_key = 'pacman.cache' def get_commands(self): if not FileUtilities.exe_exists(General.resolve_exe('paccache')): return yield Command.Function( None, Unix.pacman_cache, 'paccache -rk0') class SnapDisabled(ActionProvider): """Action to remove disabled snaps""" action_key = 'snap.disabled' def get_commands(self): # If snap is not installed or snapd is not active, enable fast auto-hide. if not Unix.snapd_is_active(): return yield Command.Function( None, Unix.snap_disabled_clean, 'snap remove disabled', preview_func=Unix.snap_disabled_preview) ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/bleachbit/Bootstrap.py0000664000175000017500000001750115265023030015252 0ustar00zz# SPDX-License-Identifier: GPL-3.0-or-later # Copyright (c) 2008-2026 Andrew Ziem. # # This work is licensed under the terms of the GNU GPL, version 3 or # later. See the COPYING file in the top-level directory. """ Prepare to start the application """ import getpass import os import re import sys from bleachbit import IS_POSIX, IS_WINDOWS, logger # pylint: disable=invalid-name _bootstrapped = False _PYTHON_DLL_RE = re.compile(r'python\d+\.dll$', re.IGNORECASE) def _apply_fontconfig_backend_preference(): """On Windows, set PANGOCAIRO_BACKEND=fc if the user chose fontconfig. It is important that this runs before Gtk. """ if not IS_WINDOWS: return try: from bleachbit.Options import options if options.get('use_fontconfig_backend'): os.environ['PANGOCAIRO_BACKEND'] = 'fc' except Exception as e: logger.debug('could not read the fontconfig backend preference: %s', e) def check_wayland_and_root(): """Check if Wayland is being used and root is not allowed. Returns True if there is a problem False if no problem (e.g., not root, not Wayland) """ if not IS_POSIX: return False # The two imports from bleachbit must come after sys.path is adjusted. import bleachbit.Unix from bleachbit.Language import get_text as _ # FIXME: if started from launcher (.desktop file), there may be no console # to which to print this message. if bleachbit.Unix.is_display_protocol_wayland_and_root_not_allowed(): print(_('To run a GUI application on Wayland with root, allow access with this command:\n' 'xhost si:localuser:root\n' 'See more about xhost at https://docs.bleachbit.org/doc/frequently-asked-questions.html'), file=sys.stderr) return True return False def _bootstrap_posix(): """Bootstrap for POSIX systems""" # os.path.expanduser('~') returns '~' unchanged when HOME is unset # and the user has no passwd entry (e.g., Docker containers). from bleachbit import _home_dir home_dir = _home_dir() if not os.getenv('HOME') and home_dir == '/tmp': logger.warning('HOME not set and no passwd entry; using %s', home_dir) # Set fallbacks for environment variables. envs = { 'HOME': home_dir, 'PATH': '/usr/bin:/bin:/usr/sbin:/sbin', 'XDG_CACHE_HOME': os.path.join(home_dir, '.cache'), 'XDG_CONFIG_HOME': os.path.join(home_dir, '.config'), 'XDG_DATA_HOME': os.path.join(home_dir, '.local', 'share') } if not os.getenv('USER'): try: envs['USER'] = getpass.getuser() except (OSError, KeyError) as e: logger.debug('could not determine the user name: %s', e) for varname, value in envs.items(): if not os.getenv(varname): os.environ[varname] = value def _bootstrap_windows(): """Bootstrap for Windows""" from bleachbit import Windows Windows.setup_environment() # Use our `font.conf` (see commit 3385952b37d78). os.environ.pop('FONTCONFIG_FILE', None) # change error handling to avoid popup with GTK 3 # https://github.com/bleachbit/bleachbit/issues/651 import win32api # pylint: disable=import-error import win32con # pylint: disable=import-error win32api.SetErrorMode(win32con.SEM_FAILCRITICALERRORS | win32con.SEM_NOGPFAULTERRORBOX | win32con.SEM_NOOPENFILEERRORBOX) # Set GDK_PIXBUF_MODULE_FILE based on the Python DLL location. # This ensures GTK can find the pixbuf loaders when running from # a bundled/frozen environment where the standard paths may not apply. # EnumProcessModules already gives us the HMODULE, so use # win32api.GetModuleFileName(module) directly instead of # win32process.GetModuleFileNameEx(-1, module): the latter re-opens # the current-process pseudo-handle through PSAPI, which has been # observed to fail with ERROR_INVALID_HANDLE (6) on the GitHub # Actions windows-latest image under PsExec -l (low integrity). # This may have been an intermittant error. # The enumeration and per-module lookup are wrapped defensively so a # future environment quirk does not abort bootstrap(), which would # otherwise take down every test's setUpClass. import win32process try: modules = win32process.EnumProcessModules(-1) except Exception: logger.exception( 'EnumProcessModules failed; skipping GDK_PIXBUF_MODULE_FILE') modules = [] for module in modules: try: name = win32api.GetModuleFileName(module) except Exception: continue if _PYTHON_DLL_RE.search(name): bindir = os.path.dirname(name) pixbuf_dir = os.path.join( bindir, 'lib', 'gdk-pixbuf-2.0', '2.10.0') loaders_dir = os.path.join(pixbuf_dir, 'loaders') os.environ['GDK_PIXBUF_MODULE_FILE'] = os.path.join( pixbuf_dir, 'loaders.cache') # setup.py rewrites loader paths in loaders.cache to bare # filenames (e.g. "pixbufloader-svg.dll"), so gdk-pixbuf needs # GDK_PIXBUF_MODULEDIR to resolve them. Without it, gdk-pixbuf # falls back to its compiled-in PIXBUF_LIBDIR (a CI-only path), # and the external SVG pixbuf loader cannot be found, which # prevents GTK from rendering SVG resources such as # check-symbolic.svg from its GResource bundle. # Only set it when the directory actually exists: in a # non-packaged run (e.g. dev/test from vcpkg_installed) the # loaders cache keeps absolute paths and the directory may not # be needed, so avoid pointing gdk-pixbuf at a dangling path. if os.path.isdir(loaders_dir): os.environ['GDK_PIXBUF_MODULEDIR'] = loaders_dir else: logger.debug( 'gdk-pixbuf loaders directory not found: %s', loaders_dir) break def bootstrap(): """Bootstrap the application""" global _bootstrapped # pylint: disable=global-statement if _bootstrapped: return _bootstrapped = True if IS_WINDOWS: # Do this before anything loads a DLL (e.g. bleachbit.Windows). import bleachbit try: # Private helper of our own package. # pylint: disable-next=protected-access bleachbit._harden_dll_search_path() except Exception: bleachbit.logger.warning( 'could not harden the DLL search path', exc_info=True) _apply_fontconfig_backend_preference() _suppress_pygobject_asyncio_deprecations() if IS_WINDOWS: _bootstrap_windows() elif IS_POSIX: _bootstrap_posix() from bleachbit import log_startup_time log_startup_time('bootstrap done') def _suppress_pygobject_asyncio_deprecations(): """Globally ignore PyGObject's asyncio deprecation warnings on Python 3.14+. PyGObject 3.56 calls ``asyncio.get_event_loop_policy()`` (deprecated in Python 3.14, removed in 3.16) from inside ``Gtk.main_iteration_do()`` and ``Gtk.Application.run()``. If this warning is not suppressed globally, it surfaces as a red error in the GUI log: ``Worker.run()`` captures all warnings via ``catch_warnings(record=True)`` and re-logs them as ``logger.warning()``, which ``GtkLoggerHandler`` tags as ``'error'``. Installing the filter once here (before any thread starts) avoids the race condition that per-call ``catch_warnings()`` suppressors have when a background ``GtkWorkerThread`` enters its own ``catch_warnings()``. """ # Imported here so bootstrapping (which hardens the DLL search path on # Windows) is not preceded by importing anything GTK-related. from bleachbit.GtkShim import ignore_pygobject_asyncio_warnings ignore_pygobject_asyncio_warnings() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/bleachbit/CLI.py0000664000175000017500000004477615265023030013722 0ustar00zz# SPDX-License-Identifier: GPL-3.0-or-later # Copyright (c) 2008-2026 Andrew Ziem. # # This work is licensed under the terms of the GNU GPL, version 3 or # later. See the COPYING file in the top-level directory. """ Command line interface """ import errno import logging import optparse import sys from bleachbit.Cleaner import backends, create_simple_cleaner, register_cleaners from bleachbit.General import sanitize_surrogates from bleachbit import APP_VERSION, stdout_encoding, IS_WINDOWS from bleachbit import SystemInformation, Options, Worker from bleachbit.Bootstrap import bootstrap from bleachbit.Language import get_text as _ from bleachbit.Log import set_root_log_level logger = logging.getLogger(__name__) _OUTPUT_CLOSED_ERRNOS = {errno.EINVAL, errno.EPIPE} def _write_update_output(value): """Write output to stdout""" sys.stdout.write(f"{value}\n") def _noop(): """Do nothing""" return None class CliCallback: """Command line's callback passed to Worker""" def __init__(self, quiet=False): self.quiet = quiet self._output_closed = False def append_text(self, msg, _tag=None): """Write text to the terminal""" msg = sanitize_surrogates(msg) if self.quiet or self._output_closed: return try: print(msg.strip('\n').encode(stdout_encoding, errors='replace').decode(stdout_encoding)) except BrokenPipeError: self._output_closed = True except OSError as e: if e.errno in _OUTPUT_CLOSED_ERRNOS: self._output_closed = True return raise def update_progress_bar(self, status): """Not used""" def update_total_size(self, size): """Not used""" def update_item_size(self, op, opid, size): """Not used""" def worker_done(self, worker, really_delete): """Not used""" def cleaners_list(): """Yield each cleaner-option pair""" list(register_cleaners()) for key in sorted(backends): c_id = backends[key].get_id() for (o_id, _o_name) in backends[key].get_options(): yield f"{c_id}.{o_id}" def list_cleaners(): """Display available cleaners""" for cleaner in cleaners_list(): print(cleaner) def preview_or_clean(operations, really_clean, quiet=False): """Preview deletes and other changes""" cb = CliCallback(quiet) worker = Worker.Worker(cb, really_clean, operations).run() try: for ret in worker: if not ret: break except BrokenPipeError: # Propagate to the top-level handler (e.g., when the downstream # pipe consumer like `less` or `head` closes early). raise except Exception: logger.exception('Failed to clean') def args_to_operations_list(preset, all_but_warning): """For --preset and --all-but-warning return list of operations as list Example return: ['google_chrome.cache', 'system.tmp'] """ args = [] if not backends: list(register_cleaners()) if not backends: raise RuntimeError('no cleaners registered') for key in sorted(backends): c_id = backends[key].get_id() for (o_id, _o_name) in backends[key].get_options(): # restore presets from the GUI if preset and Options.options.get_tree(c_id, o_id): args.append('.'.join([c_id, o_id])) elif all_but_warning and not backends[c_id].get_warning(o_id): args.append('.'.join([c_id, o_id])) return args def args_to_operations(args, preset, all_but_warning, excludes=None): """Convert command-line arguments to a dictionary of operations Args: args: List of cleaner.option strings (e.g., ['system.tmp', 'firefox.cache']) preset: Boolean indicating whether to use saved preset operations all_but_warning: Boolean indicating whether to include all non-warning operations excludes: Optional list of cleaner.option strings to remove from operations Returns: Dictionary mapping cleaner IDs to lists of option IDs Example: {'system': ['tmp'], 'firefox': ['cache']} """ list(register_cleaners()) operations = {} if not args: args = [] if excludes is None: excludes = [] positive_args = set( args + args_to_operations_list(preset, all_but_warning)) def fix_deprecated(cid, oid): if 'system' == cid and 'free_disk_space' == oid: logger.info( "Change 'system.free_disk_space' (deprecated) to 'system.empty_space'") return 'empty_space' return oid # TRANSLATORS: Error shown on CLI, and %s is the name of a cleaning action not_valid_cleaner_msg = _("not a valid cleaner: %s") for arg in positive_args: parts = arg.split('.') if 2 != len(parts): logger.warning(not_valid_cleaner_msg, arg) continue (cleaner_id, option_id) = parts # enable all options (for example, firefox.*) if '*' == option_id: if cleaner_id not in backends: logger.warning(not_valid_cleaner_msg, arg) continue if cleaner_id in operations: del operations[cleaner_id] operations[cleaner_id] = [ option_id2 for (option_id2, _o_name) in backends[cleaner_id].get_options() ] continue # backwards compatibility option_id = fix_deprecated(cleaner_id, option_id) # add the specified option if cleaner_id not in operations: # initialize list of options for this cleaner operations[cleaner_id] = [] if option_id not in operations[cleaner_id]: # add option to list operations[cleaner_id].append(option_id) for arg in excludes: if '*' in arg or '?' in arg: # TRANSLATORS: Error shown on CLI, and %s is the name of a cleaning action wildcard_msg = _("Wildcard characters are not allowed " "in --except: %s") logger.error(wildcard_msg, arg) # Exit to avoid over-cleaning. sys.exit(1) parts = arg.split('.') if 2 != len(parts): logger.error(not_valid_cleaner_msg, arg) # Exit to avoid over-cleaning. sys.exit(1) (cleaner_id, option_id) = parts option_id = fix_deprecated(cleaner_id, option_id) if cleaner_id in operations and option_id in operations[cleaner_id]: operations[cleaner_id].remove(option_id) if not operations[cleaner_id]: del operations[cleaner_id] for (k, v) in operations.items(): operations[k] = sorted(v) return operations def _split_excludes(values): excludes = [] for value in values: if value is None: continue excludes.extend(item.strip() for item in value.split(',') if item.strip()) return excludes def parse_cmd_line(argv=None): """Parse the command line and return parser, options, args, and excludes.""" # TRANSLATORS: This is the command line usage. Don't translate # %prog, but do translate options, cleaner, and option. # Don't translate and add "usage:" - it gets added by Python. # More information about the command line is here # https://www.bleachbit.org/documentation/command-line usage = _("usage: %prog [options] cleaner.option1 [cleaner.option2 ...]") parser = optparse.OptionParser(usage) parser.add_option("-l", "--list-cleaners", action="store_true", # TRANSLATORS: Help for the --list-cleaners command on the CLI, # and 'list' is a verb help=_("list cleaners")) parser.add_option("-p", "--preview", action="store_true", # TRANSLATORS: Help for the --preview command on the CLI, # and 'preview' is a verb help=_("preview files to be deleted and other changes")) parser.add_option("-c", "--clean", action="store_true", # TRANSLATORS: Help for the --clean command on the CLI help=_("run cleaners to delete files and make other permanent changes")) parser.add_option("-s", "--shred", action="store_true", # TRANSLATORS: Help for the --shred command on the CLI, # and 'shred' is a verb help=_("shred specific files or folders")) parser.add_option("-w", "--wipe-empty-space", "--wipe-free-space", action="store_true", dest="wipe_empty_space", # TRANSLATORS: Help for the --wipe-empty-space # command on the CLI, and 'wipe' is a verb help=_("wipe empty space in the given paths")) parser.add_option("-o", "--overwrite", action="store_true", # TRANSLATORS: Help for the --overwrite option on the CLI, # and 'overwrite' is a verb help=_("overwrite files to hide contents")) parser.add_option("--gui", action="store_true", # TRANSLATORS: Help for the --gui option on the CLI, # and 'launch' is a verb help=_("launch the graphical interface")) parser.add_option("--preset", action="store_true", # TRANSLATORS: Help for the --preset option on the CLI, # and 'use' is a verb, referring to enabling options set earlier. help=_("use options set in the graphical interface")) parser.add_option("--all-but-warning", action="store_true", # TRANSLATORS: Help for the --all-but-warning option on the CLI, # and 'enable' is a verb. help=_("enable all options that do not have a warning")) parser.add_option("--except", dest="excludes", action="append", default=[], # TRANSLATORS: Help for the --except option on the CLI, # and 'exclude' is a verb. help=_("exclude cleaner options (can be repeated, comma-separated)")) parser.add_option('--debug', # TRANSLATORS: Help for the --debug option on the CLI, # and 'set' is a verb. help=_("set log level to verbose"), action="store_true") # TRANSLATORS: Help for --debug-log option on the CLI. parser.add_option('--debug-log', help=_("log debug messages to file")) parser.add_option("--sysinfo", action="store_true", # TRANSLATORS: Help for --sysinfo option on the CLI. help=_("show system information")) parser.add_option("-v", "--version", action="store_true", # TRANSLATORS: Help for --version option on the CLI. help=_("output version information and exit")) parser.add_option('--pot', action='store_true', help=optparse.SUPPRESS_HELP) parser.add_option("--no-delete-confirmation", action="store_false", dest="delete_confirmation", help=optparse.SUPPRESS_HELP) parser.add_option("--no-load-cleaners", action="store_false", dest="load_cleaners", help=optparse.SUPPRESS_HELP) parser.add_option("--no-check-online-updates", action="store_false", dest="check_online_updates", help=optparse.SUPPRESS_HELP) parser.add_option("--no-first-start", action="store_false", dest="first_start", help=optparse.SUPPRESS_HELP) if IS_WINDOWS: # TRANSLATORS: Help for --no-uac option on the CLI. uac_help = _("do not prompt for administrator privileges") parser.add_option("--no-uac", action="store_true", help=uac_help) parser.add_option('--uac-sid-token', help=optparse.SUPPRESS_HELP) parser.add_option("--update-winapp2", action="store_true", # TRANSLATORS: Help for --update-winapp2 command on the CLI. help=_("update winapp2.ini, if a new version is available")) # added for testing py2exe build # https://github.com/bleachbit/bleachbit/commit/befe244efee9b2d4859c6b6c31f8bedfd4d85aad#diff-b578cd35e15095f69822ebe497bf8691da1b587d6cc5f5ec252ff4f186dbed56 parser.add_option('--exit', action='store_true', help=optparse.SUPPRESS_HELP) # Build-time smoke test for network stack parser.add_option('--comms-check', action='store_true', help=optparse.SUPPRESS_HELP) # some workaround for context menu added here # https://github.com/bleachbit/bleachbit/commit/b09625925149c98a6c79e278c35d5995e7526993 def expand_context_menu_option(_option, _opt, _value, parser): setattr(parser.values, 'gui', True) setattr(parser.values, 'exit', True) setattr(parser.values, 'load_cleaners', False) setattr(parser.values, 'check_online_updates', False) setattr(parser.values, 'first_start', False) parser.add_option("--context-menu", action="callback", callback=expand_context_menu_option, help=optparse.SUPPRESS_HELP) (options, args) = parser.parse_args(args=argv) excludes = _split_excludes(options.excludes) return parser, options, args, excludes def process_cmd_line(): """Parse the command line and execute given commands.""" parser, options, args, excludes = parse_cmd_line() for opt in ('delete_confirmation', 'load_cleaners', 'check_online_updates', 'first_start'): if hasattr(options, opt) and getattr(options, opt) is not None: Options.options.set_override(opt, getattr(options, opt)) cmd_list = (options.list_cleaners, options.clean, options.preview, options.shred, options.wipe_empty_space) cmd_count = sum(x is True for x in cmd_list) if cmd_count > 1: logger.error( # TRANSLATORS: Error message shown on CLI. _('Specify only one of these commands: --list-cleaners, --wipe-empty-space, ' '--preview, --clean, --shred')) sys.exit(1) did_something = False if options.debug: # Debug is set in __init__ so it takes effect earlier. # Also, set the override. Options.options.set_override('debug', True) elif options.preset: # but if --preset is given, check if GUI option sets debug if Options.options.get('debug'): set_root_log_level(Options.options.get('debug')) logger.debug("Debugging is enabled in GUI settings.") if options.debug_log: # File handler is already set up in Log.py init_log() function # Just add system information to the log logger.info(SystemInformation.get_system_information()) if options.version: version_message = f""" BleachBit version {APP_VERSION} Copyright (C) 2008-2026 Andrew Ziem. All rights reserved. License GPLv3+: GNU GPL version 3 or later . This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. """ print(version_message) sys.exit(0) if options.comms_check: from bleachbit import Network sys.exit(Network.comms_check()) if IS_WINDOWS and options.update_winapp2: from bleachbit import Update # TRANSLATORS: Log message on the CLI. logger.info(_("Checking online for updates to winapp2.ini")) Update.check_updates(False, True, _write_update_output, _noop) # updates can be combined with --list-cleaners, --preview, --clean did_something = True if options.list_cleaners: list_cleaners() sys.exit(0) if options.pot: from bleachbit.CleanerML import create_pot create_pot() sys.exit(0) if options.wipe_empty_space: if len(args) < 1: # TRANSLATORS: Error message on the CLI. logger.error(_("No directories given for --wipe-empty-space")) sys.exit(1) # TRANSLATORS: Log message on the CLI. logger.info(_("Wiping empty space can take a long time.")) had_error = False for wipe_path in args: # TRANSLATORS: Shows activity in the CLI, and %s is the path to the directory. logger.info(_("Wipe empty space in %s"), wipe_path) import bleachbit.Wipe try: for _ret in bleachbit.Wipe.wipe_path(wipe_path): pass except OSError as e: # Do not let one bad path abort the remaining ones. logger.error('%s: %s', wipe_path, e) had_error = True sys.exit(1 if had_error else 0) operations = {} if options.preview or options.clean: operations = args_to_operations( args, options.preset, options.all_but_warning, excludes) if not operations: # TRANSLATORS: Error message on the CLI. logger.error(_("No operations selected. Specify cleaner options.")) sys.exit(1) if options.overwrite: if not options.clean or options.shred: logger.warning( # TRANSLATORS: '--overwrite' and '--clean' are command line options _("--overwrite is intended only for use with --clean")) Options.options.set_override('shred', True) if options.clean or options.preview: preview_or_clean(operations, options.clean) sys.exit(0) if options.gui: from bleachbit.Bootstrap import check_wayland_and_root if check_wayland_and_root(): sys.exit(1) import bleachbit.GuiApplication enable_uac = IS_WINDOWS and not options.no_uac app = bleachbit.GuiApplication.Bleachbit( uac=enable_uac, shred_paths=args, auto_exit=options.exit) sys.exit(app.run()) if options.shred: # delete arbitrary files without GUI Options.options.set_override('first_start', False) # create a temporary cleaner object backends['_gui'] = create_simple_cleaner(args) operations = {'_gui': ['files']} preview_or_clean(operations, True) sys.exit(0) if options.sysinfo: print(SystemInformation.get_system_information()) sys.exit(0) if not did_something: parser.print_help() if __name__ == '__main__': bootstrap() process_cmd_line() ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/bleachbit/Chaff.py0000664000175000017500000002366115265023030014310 0ustar00zz# SPDX-License-Identifier: GPL-3.0-or-later # Copyright (c) 2008-2026 Andrew Ziem. # # This work is licensed under the terms of the GNU GPL, version 3 or # later. See the COPYING file in the top-level directory. import bz2 from datetime import datetime import email.generator from email.mime.text import MIMEText import json import logging import os import random import tempfile from bleachbit import options_dir from . import markovify logger = logging.getLogger(__name__) # These were typos in the original emails, not OCR errors: # abdinh@state.gov # mhcaleja@state.gov RECIPIENTS = [ 'abedinh@state.gov', 'adlerce@state.gov', 'baerdb@state.gov', 'baldersonkm@state.gov', 'balderstonkm@state.gov', 'bam@mikulski.senate.gov', 'bealeca@state.gov', 'benjamin_moncrief@lemieux.senate.gov', 'blaker2@state.gov', 'brimmere@state.gov', 'burnswj@state.gov', 'butzgych2@state.gov', 'campbellkm@state.gov', 'carsonj@state.gov', 'cholletdh@state.gov', 'cindy.buhl@mail.house.gov', 'colemancl@state.gov', 'crowleypj@state.gov', 'danieljj@state.gov', 'david_garten@lautenberg.senate.gov', 'dewanll@state.gov', 'feltmanjd@state.gov', 'fuchsmh@state.gov', 'goldbergps@state.gov', 'goldenjr@state.gov', 'gonzalezjs@state.gov', 'gordonph@state.gov', 'hanleymr@state.gov', 'hdr22@clintonemail.com', 'hillcr@state.gov', 'holbrookerc@state.gov', 'hormatsrd@state.gov', 'hr15@att.blackberry.net', 'hr15@mycingular.blackberry.net', 'hrod17@clintonemail.com', 'huma@clintonemail.com', 'hyded@state.gov', 'info@mailva.evite.com', 'jilotylc@state.gov', 'jonespw2@state.gov', 'kellyc@state.gov', 'klevorickcb@state.gov', 'kohhh@state.gov', 'laszczychj@state.gov', 'lewjj@state.gov', 'macmanusje@state.gov', 'marshallcp@state.gov', 'mchaleja@state.gov', 'millscd@state.gov', 'muscatinel@state.gov', 'nidestr@state.gov', 'nulandvj@state.gov', 'oterom2@state.gov', 'posnermh@state.gov', 'reinesp@state.gov', 'reinespi@state.gov', 'ricese@state.gov', 'rodriguezme@state.gov', 'rooneym@state.gov', 's_specialassistants@state.gov', 'schwerindb@state.gov', 'shannonta@state.gov', 'shapiroa@state.gov', 'shermanwr@state.gov', 'slaughtera@state.gov', 'steinbergjb@state.gov', 'sterntd@state.gov', 'sullivanjj@state.gov', 'tauschereo@state.gov', 'tillemannts@state.gov', 'toivnf@state.gov', 'tommy_ross@reid.senate.gov', 'valenzuelaaa@state.gov', 'valmorolj@state.gov', 'vermarr@state.gov', 'verveerms@state.gov', 'woodardew@state.gov'] DEFAULT_SUBJECT_LENGTH = 64 DEFAULT_NUMBER_OF_SENTENCES_CLINTON = 50 DEFAULT_NUMBER_OF_SENTENCES_2600 = 50 MODEL_BASENAMES = ( '2600_model.json.bz2', 'clinton_content_model.json.bz2', 'clinton_subject_model.json.bz2') MODEL_SHA512 = { '2600_model.json.bz2': '1c06c362587c177908fee6a4f7a439a684ada48404f40fec72cba5ba1f90aff5' '9e76742718f8dc290853fe08f32f2c1b60b769c412765340fc428f0ea3fc46d7', 'clinton_content_model.json.bz2': 'ea92709c17082e1113c00138d9dd9fd970a7089f4de9bc8f58a0ce3312782154' '9554cb2cd6b5591f1e7035513badeff11af09423357b8ecf5a20bc5a61a9b8ef', 'clinton_subject_model.json.bz2': '4cff92b6cab27d4efccc65c0f9378c21af0fe02b59e5d1790cfdf675c555fda9' '8cb7083e8268aa0878198ce4df4160db4f4e77f191e301bea31c02c19bc1c2bf', } if set(MODEL_SHA512) != set(MODEL_BASENAMES): raise RuntimeError('every model in MODEL_BASENAMES needs a SHA-512') URL_TEMPLATES = ( 'https://sourceforge.net/projects/bleachbit/files/chaff/%s/download', 'https://download.bleachbit.org/chaff/%s') DEFAULT_MODELS_DIR = options_dir def _load_model(model_path): _open = open if model_path.endswith('.bz2'): _open = bz2.open with _open(model_path, 'rt', encoding='utf-8') as model_file: return markovify.Text.from_dict(json.load(model_file)) def load_subject_model(model_path): return _load_model(model_path) def load_content_model(model_path): return _load_model(model_path) def load_2600_model(model_path): return _load_model(model_path) def _get_random_recipient(): return random.choice(RECIPIENTS) def _get_random_datetime(min_year=2011, max_year=2012): date = datetime.strptime( f'{random.randint(1, 365)} {random.randint(min_year, max_year)}', '%j %Y') # Saturday, September 15, 2012 2:20 PM return date.strftime('%A, %B %d, %Y %I:%M %p') def _get_random_content(content_model, number_of_sentences=DEFAULT_NUMBER_OF_SENTENCES_CLINTON): content = [] for _i in range(number_of_sentences): sentence = content_model.make_sentence() if sentence is None: sentence = '' content.append(sentence) content.append(random.choice([' ', ' ', '\n\n'])) try: return MIMEText(''.join(content), _charset='iso-8859-1') except UnicodeEncodeError: return _get_random_content(content_model, number_of_sentences=number_of_sentences) def _generate_email(subject_model, content_model, number_of_sentences=DEFAULT_NUMBER_OF_SENTENCES_CLINTON, subject_length=DEFAULT_SUBJECT_LENGTH): message = _get_random_content( content_model, number_of_sentences=number_of_sentences) subject = subject_model.make_short_sentence(subject_length) message['Subject'] = subject if subject is not None else '' message['To'] = _get_random_recipient() message['From'] = _get_random_recipient() message['Sent'] = _get_random_datetime() return message def download_models(models_dir=DEFAULT_MODELS_DIR, on_error=None): """Download models Calls on_error(primary_message, secondary_message) in case of error Returns success as boolean value """ from bleachbit.Network import download_url_to_fn for basename in (MODEL_BASENAMES): fn = os.path.join(models_dir, basename) if os.path.exists(fn): logger.debug('File %s already exists', fn) continue this_file_success = False for url_template in URL_TEMPLATES: url = url_template % basename if download_url_to_fn(url, fn, expected_sha512=MODEL_SHA512[basename], on_error=on_error): this_file_success = True break if not this_file_success: return False return True # Reordering the parameters would break the call sites. # pylint: disable-next=keyword-arg-before-vararg def generate_emails(number_of_emails, email_output_dir, models_dir=DEFAULT_MODELS_DIR, number_of_sentences=DEFAULT_NUMBER_OF_SENTENCES_CLINTON, on_progress=None, should_stop=None, *_kwargs): logger.debug('Loading two email models') subject_model_path = os.path.join( models_dir, 'clinton_subject_model.json.bz2') content_model_path = os.path.join( models_dir, 'clinton_content_model.json.bz2') subject_model = load_subject_model(subject_model_path) content_model = load_content_model(content_model_path) logger.debug('Generating %s emails', f'{number_of_emails:,}') generated_file_names = [] cumulative_size = 0 for i in range(1, number_of_emails + 1): with tempfile.NamedTemporaryFile(mode='w+', prefix='outlook-', suffix='.eml', dir=email_output_dir, delete=False) as email_output_file: email_generator = email.generator.Generator(email_output_file) msg = _generate_email( subject_model, content_model, number_of_sentences=number_of_sentences) email_generator.write(msg.as_string()) generated_file_names.append(email_output_file.name) cumulative_size += email_output_file.tell() if on_progress: on_progress(1.0 * i / number_of_emails, generated_file_names=generated_file_names, cumulative_size=cumulative_size) if should_stop and should_stop(generated_file_names, cumulative_size): break return generated_file_names def _generate_2600_file(model, number_of_sentences=DEFAULT_NUMBER_OF_SENTENCES_2600): content = [] for _i in range(number_of_sentences): sentence = model.make_sentence() if sentence is None: sentence = '' content.append(sentence) # The space is repeated to make paragraphs longer. content.append(random.choice([' ', ' ', '\n\n'])) return ''.join(content) def generate_2600(file_count, output_dir, model_dir=DEFAULT_MODELS_DIR, on_progress=None, should_stop=None): logger.debug('Loading 2600 model') model_path = os.path.join(model_dir, '2600_model.json.bz2') model = _load_model(model_path) logger.debug('Generating %s files', f'{file_count:,}') generated_file_names = [] cumulative_size = 0 for i in range(1, file_count + 1): with tempfile.NamedTemporaryFile(mode='w+', encoding='utf-8', prefix='2600-', suffix='.txt', dir=output_dir, delete=False) as output_file: txt = _generate_2600_file(model) output_file.write(txt) generated_file_names.append(output_file.name) cumulative_size += output_file.tell() if on_progress: on_progress(1.0 * i / file_count, generated_file_names=generated_file_names, cumulative_size=cumulative_size) if should_stop and should_stop(generated_file_names, cumulative_size): break return generated_file_names def have_models(): """Check whether the models exist in the default location. Used to check whether download is needed.""" for basename in (MODEL_BASENAMES): fn = os.path.join(DEFAULT_MODELS_DIR, basename) if not os.path.exists(fn): return False return True ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/bleachbit/Cleaner.py0000775000175000017500000010575515265023030014662 0ustar00zz# SPDX-License-Identifier: GPL-3.0-or-later # Copyright (c) 2008-2026 Andrew Ziem. # # This work is licensed under the terms of the GNU GPL, version 3 or # later. See the COPYING file in the top-level directory. """ Perform (or assist with) cleaning operations. """ import glob import logging import os import os.path import re import tempfile import time from bleachbit.Constant import EMPTY_SPACE_WARNING from bleachbit.Language import get_text as _ from bleachbit.FileUtilities import children_in_directory from bleachbit.Options import options from bleachbit.PathUtils import path_equal from bleachbit.Process import is_process_running from bleachbit import Action, CleanerML, Command, FileUtilities, Memory from bleachbit import IS_LINUX, IS_MAC, IS_POSIX, IS_WINDOWS from bleachbit.GtkShim import gtk_may_be_available from bleachbit.Wipe import wipe_path if IS_POSIX: from bleachbit import Unix elif IS_WINDOWS: from bleachbit import Windows else: raise RuntimeError(f"Unknown OS '{os.name}'") logger = logging.getLogger(__name__) # a module-level variable for holding cleaners backends = {} # Putting the string here helps with translation. # TRANSLATORS: The description of what certain cleaning options do. DELETE_CACHE_DESCRIPTION = _("Delete the cache") MENU_DIRS = ('~/.local/share/applications', '~/.config/autostart', '~/.gnome/apps/', '~/.gnome2/panel2.d/default/launchers', '~/.gnome2/vfolders/applications/', '~/.kde/share/apps/RecentDocuments/', '~/.kde/share/mimelnk', '~/.kde/share/mimelnk/application/ram.desktop', '~/.kde2/share/mimelnk/application/', '~/.kde2/share/applnk') class Cleaner: """Base class for a cleaner""" def __init__(self, id_=None, name=None, description=None): self.actions = [] self.id = id_ self.description = description self.name = name self.options = {} self.running = [] self.warnings = {} # Winapp2 cleaners clear this because their own detect() already ran self.auto_hide_supported = True self.keep_list_re = None # Lazily built {option_id: [action, ...]} index over self.actions. # Winapp2 cleaners aggregate thousands of actions, so scanning the # whole list per option (get_commands/get_deep_scan) is quadratic. self._actions_index = None self._actions_index_src = None self._sorted_option_keys = None def add_action(self, option_id, action): """Register 'action' (instance of class Action) to be executed for ''option_id'. The actions must implement list_files and other_cleanup()""" self.actions.append((option_id, action)) self._actions_index = None def _actions_for(self, option_id): """Return the actions registered for option_id, in insertion order.""" # Rebuild when invalidated by add_action or when self.actions was # reassigned to a different list. if self._actions_index is None or self._actions_index_src is not self.actions: index = {} for oid, action in self.actions: index.setdefault(oid, []).append(action) self._actions_index = index self._actions_index_src = self.actions return self._actions_index.get(option_id, ()) def add_option(self, option_id, name, description): """Register option (such as 'cache')""" self.options[option_id] = (name, description) self._sorted_option_keys = None def add_running(self, detection_type, pathname, same_user=False): """Add a way to detect this program is currently running""" self.running.append((detection_type, pathname, same_user)) def auto_hide(self): """Return boolean whether it is OK to automatically hide this cleaner""" if not self.auto_hide_supported: return False for (option_id, __name) in self.get_options(): try: for cmd in self.get_commands(option_id): for _dummy in cmd.execute(False): return False for _ds in self.get_deep_scan(option_id): return False except Exception: logger.exception('exception in auto_hide(), cleaner=%s, option=%s', self.name, option_id) return True def get_commands(self, option_id): """Get list of Command instances for option 'option_id'""" for action in self._actions_for(option_id): yield from action.get_commands() if option_id not in self.options: raise RuntimeError(f"Unknown option '{option_id}'") def get_deep_scan(self, option_id): """Get dictionary used to build a deep scan""" for action in self._actions_for(option_id): yield from action.get_deep_scan() if option_id not in self.options: raise RuntimeError(f"Unknown option '{option_id}'") def get_description(self): """Brief description of the cleaner""" return self.description def get_id(self): """Return the unique name of this cleaner""" return self.id def get_name(self): """Return the human name of this cleaner""" return self.name def _get_sorted_option_keys(self): """Return option keys sorted once and cached until options change.""" if self._sorted_option_keys is None: self._sorted_option_keys = sorted(self.options.keys()) return self._sorted_option_keys def get_option_descriptions(self): """Yield the names and descriptions of each option in a 2-tuple""" for key in self._get_sorted_option_keys(): yield (self.options[key][0], self.options[key][1]) def get_options(self): """Return user-configurable options in 2-tuple (id, name)""" for key in self._get_sorted_option_keys(): yield (key, self.options[key][0]) def get_warning(self, option_id): """Return a warning as string.""" return self.warnings.get(option_id) def has_action_key(self, option_id, action_key): """Return whether an action registered for option_id has action_key""" return any(getattr(action, 'action_key', None) == action_key for action in self._actions_for(option_id)) def is_process_running(self): """Return whether the process is currently running""" for (test, pathname, same_user) in self.running: if 'exe' == test: if is_process_running(pathname, same_user): logger.debug("process '%s' is running", pathname) return True elif 'pathname' == test: expanded = os.path.expanduser(os.path.expandvars(pathname)) for globbed in glob.iglob(expanded): if os.path.exists(globbed): logger.debug( "file '%s' exists indicating '%s' is running", globbed, self.name) return True else: raise RuntimeError(f"Unknown running-detection test '{test}'") return False def is_usable(self): """Return whether the cleaner is usable (has actions)""" return bool(self.actions) def set_warning(self, option_id, description): """Set a warning to be displayed when option is selected interactively""" self.warnings[option_id] = description class System(Cleaner): """Clean the system in general""" def __init__(self): Cleaner.__init__( self, id_='system', # TRANSLATORS: Cleaner name shown in the list of applications. name=_("System"), # TRANSLATORS: Description of the System cleaner. description=_("The system in general")) # # options for Linux and BSD # if IS_POSIX: if not IS_MAC: self.add_option( 'desktop_entry', # TRANSLATORS: desktop entries are .desktop files in Linux that # make up the application menu (the menu that shows BleachBit, # Firefox, and others). The .desktop files also associate file # types, so clicking on an .html file in Nautilus brings up # Firefox. # More information: # https://specifications.freedesktop.org/menu/latest/index.html#introduction _('Broken desktop files'), # TRANSLATORS: Description of the Broken desktop files cleaning option. _('Delete broken application menu entries and file associations')) self.add_option( 'cache', # TRANSLATORS: Name of a cleaning option. Cache is a noun. _('Cache'), DELETE_CACHE_DESCRIPTION) if not IS_MAC: self.add_option( 'localizations', # TRANSLATORS: Localizations are files supporting specific # languages, so applications appear in Spanish, etc. _('Localizations'), # TRANSLATORS: Description of the Localizations cleaning option. _('Delete files for unwanted languages')) self.set_warning( 'localizations', # TRANSLATORS: Warning for the Localizations cleaning option. _("Configure this option in the preferences.")) self.add_option( 'rotated_logs', # TRANSLATORS: 'Rotated logs' refers to old system log files. # Linux systems often have a scheduled job to rotate the logs # which means compress all except the newest log and then delete # the oldest log. You could translate this as 'old logs.' _('Rotated logs'), # TRANSLATORS: Description of the Rotated logs cleaning option. _('Delete old system logs')) self.add_option( 'recent_documents', # TRANSLATORS: Name of a cleaning option for the history of recently used files. _('Recent documents list'), # TRANSLATORS: Description of the Recent documents list cleaning option. _('Delete the list of recently used documents')) self.add_option( 'trash', # TRANSLATORS: Name of a cleaning option. Trash is a noun. _('Trash'), # TRANSLATORS: Description of the Trash cleaning option. _('Empty the trash')) # # options just for Linux # if IS_LINUX: self.add_option( 'memory', # TRANSLATORS: Name of a cleaning option for system memory. _('Memory'), # TRANSLATORS: 'free' means 'unallocated' _('Wipe the swap and free memory')) self.set_warning( 'memory', # TRANSLATORS: Warning for the experimental Memory cleaning option. _('This option is experimental and may cause system problems.')) # # options just for Microsoft Windows # # IS_LINUX implies IS_POSIX, which is what binds Unix; pylint can't see that. # pylint: disable-next=possibly-used-before-assignment has_dns_flush = IS_WINDOWS or (IS_LINUX and Unix.can_flush_dns()) if has_dns_flush: # TRANSLATORS: This is a label for the option to clear the system DNS cache. dns_cache_label = _('DNS cache') self.add_option('dns_cache', dns_cache_label, _('Delete the cache')) if IS_WINDOWS: self.add_option( 'logs', # TRANSLATORS: Name of a cleaning option for Windows log files. _('Logs'), # TRANSLATORS: Description of the Logs cleaning option. _('Delete the logs')) self.add_option( 'memory_dump', # TRANSLATORS: Name of a cleaning option for Windows crash dump files. _('Memory dump'), # TRANSLATORS: Description of the Memory dump cleaning option. _('Delete the file')) self.add_option('muicache', 'MUICache', DELETE_CACHE_DESCRIPTION) # TRANSLATORS: Name of cleaning option. 'Prefetch' is Microsoft Windows jargon. self.add_option('prefetch', _('Prefetch'), DELETE_CACHE_DESCRIPTION) self.add_option( 'recycle_bin', # TRANSLATORS: Name of a cleaning option for the Windows recycle bin. _('Recycle bin'), # TRANSLATORS: Description of the Recycle bin cleaning option. _('Empty the recycle bin')) # TRANSLATORS: Name for cleaning option. 'Update' is an adjective to # describe the kind of uninstallers. updates_name = _('Update uninstallers') # TRANSLATORS: Description of cleaning option. updates_desc = _('Delete uninstallers for Microsoft updates including hotfixes, ' 'service packs, and Internet Explorer updates') self.add_option('updates', updates_name, updates_desc) # TRANSLATORS: Warning shown when selecting an option. updates_warning = _('This option may prevent uninstalling ' 'some updates.') self.set_warning('updates', updates_warning) # # options for GTK+ # # The clipboard option is available wherever a clipboard can be # cleared: under GTK (POSIX) or natively on Windows. if gtk_may_be_available() or IS_WINDOWS: self.add_option( 'clipboard', # TRANSLATORS: Name of a cleaning option. Clipboard is a noun. _('Clipboard'), # TRANSLATORS: Description of the Clipboard cleaning option. _('The desktop environment\'s clipboard used for copy and paste operations')) # # options common to all platforms # self.add_option( 'custom', # TRANSLATORS: "Custom" is an option allowing the user to specify which # files and folders will be erased. _('Custom'), # TRANSLATORS: Description of the Custom cleaning option. _('Delete user-specified files and folders')) # TRANSLATORS: 'empty' means 'unallocated' self.add_option('empty_space', _('Empty space'), # TRANSLATORS: 'empty' means 'unallocated' _('Wipe empty space to hide deleted files')) self.set_warning('empty_space', EMPTY_SPACE_WARNING) self.add_option( 'tmp', # TRANSLATORS: Name of a cleaning option for temporary files. _('Temporary files'), # TRANSLATORS: Description of the Temporary files cleaning option. _('Delete the temporary files')) def get_commands(self, option_id): # cache if IS_POSIX and 'cache' == option_id: dirnames = [os.path.expanduser("~/.cache/")] if IS_MAC: dirnames.insert(0, os.path.expanduser("~/Library/Caches/")) for dirname in dirnames: for filename in children_in_directory(dirname, True): if not self.whitelisted(filename): yield Command.Delete(filename) # custom if 'custom' == option_id: for (c_type, c_path) in options.get_custom_paths(): if 'file' == c_type: if os.path.lexists(c_path): yield Command.Delete(c_path) elif 'folder' == c_type: if os.path.lexists(c_path): for path in children_in_directory(c_path, True): yield Command.Delete(path) yield Command.Delete(c_path) else: raise RuntimeError( f'custom folder has invalid type {c_type}') # menu if IS_POSIX and not IS_MAC and 'desktop_entry' == option_id: for path in MENU_DIRS: dirname = os.path.expanduser(path) for filename in children_in_directory(dirname, False): # pylint: disable-next=possibly-used-before-assignment if filename.endswith('.desktop') and Unix.is_broken_xdg_desktop(filename): yield Command.Delete(filename) # unwanted locales if IS_POSIX and not IS_MAC and 'localizations' == option_id: for path in Unix.locales.localization_paths(locales_to_keep=options.get_languages()): # A symlinked locale directory points at a locale that may be # on the keep list, so delete the link without its contents. if FileUtilities.is_normal_directory(path): for f in FileUtilities.children_in_directory(path, True): yield Command.Delete(f) yield Command.Delete(path) # Windows logs if IS_WINDOWS and 'logs' == option_id: paths = ( '$ALLUSERSPROFILE\\Application Data\\Microsoft\\Dr Watson\\*.log', '$ALLUSERSPROFILE\\Application Data\\Microsoft\\Dr Watson\\user.dmp', '$LocalAppData\\Microsoft\\Windows\\WER\\ReportArchive\\*\\*', '$LocalAppData\\Microsoft\\Windows\\WER\\ReportQueue\\*\\*', '$programdata\\Microsoft\\Windows\\WER\\ReportArchive\\*\\*', '$programdata\\Microsoft\\Windows\\WER\\ReportQueue\\*\\*', '$localappdata\\Microsoft\\Internet Explorer\\brndlog.bak', '$localappdata\\Microsoft\\Internet Explorer\\brndlog.txt', '$windir\\*.log', '$windir\\imsins.BAK', '$windir\\OEWABLog.txt', '$windir\\SchedLgU.txt', '$windir\\ntbtlog.txt', '$windir\\setuplog.txt', '$windir\\REGLOCS.OLD', '$windir\\Debug\\*.log', '$windir\\Debug\\Setup\\UpdSh.log', '$windir\\Debug\\UserMode\\*.log', '$windir\\Debug\\UserMode\\ChkAcc.bak', '$windir\\Debug\\UserMode\\userenv.bak', '$windir\\Microsoft.NET\\Framework\\*\\*.log', '$windir\\pchealth\\helpctr\\Logs\\hcupdate.log', '$windir\\security\\logs\\*.log', '$windir\\security\\logs\\*.old', '$windir\\SoftwareDistribution\\*.log', '$windir\\SoftwareDistribution\\DataStore\\Logs\\*', '%WindowsSystem%\\TZLog.log', '%WindowsSystem%\\config\\systemprofile\\Application Data\\Microsoft\\Internet Explorer\\brndlog.bak', '%WindowsSystem%\\config\\systemprofile\\Application Data\\Microsoft\\Internet Explorer\\brndlog.txt', '%WindowsSystem%\\LogFiles\\AIT\\AitEventLog.etl.???', '%WindowsSystem%\\LogFiles\\Firewall\\pfirewall.log*', '%WindowsSystem%\\LogFiles\\Scm\\SCM.EVM*', '%WindowsSystem%\\LogFiles\\WMI\\Terminal*.etl', '%WindowsSystem%\\LogFiles\\WMI\\RTBackup\\EtwRT.*etl', '%WindowsSystem%\\wbem\\Logs\\*.lo_', '%WindowsSystem%\\wbem\\Logs\\*.log', ) for path in paths: # pylint: disable-next=possibly-used-before-assignment for expanded in Windows.expand_windows_system_vars(path): expanded = os.path.expandvars(expanded) for globbed in glob.iglob(expanded): yield Command.Delete(globbed) # memory if IS_LINUX and 'memory' == option_id: yield Command.Function(None, Memory.wipe_memory, _('Memory')) # memory dump # how to manually create this file # https://web.archive.org/web/20170601020156/http://www.pctools.com/guides/registry/detail/856 if IS_WINDOWS and 'memory_dump' == option_id: fname = os.path.expandvars('$windir\\memory.dmp') if os.path.exists(fname): yield Command.Delete(fname) for fname in glob.iglob(os.path.expandvars('$windir\\Minidump\\*.dmp')): yield Command.Delete(fname) # most recently used documents list if IS_POSIX and 'recent_documents' == option_id: ru_fn = os.path.expanduser("~/.recently-used") if os.path.lexists(ru_fn): yield Command.Delete(ru_fn) # GNOME 2.26 (as seen on Ubuntu 9.04) will retain the list # in memory if it is simply deleted, so it must be shredded # (or at least truncated). # # GNOME 2.28.1 (Ubuntu 9.10) and 2.30 (10.04) do not re-read # the file after truncation, but do re-read it after # shredding. # # https://bugzilla.gnome.org/show_bug.cgi?id=591404 def gtk_purge_items(): """Purge GTK items""" from bleachbit.GtkShim import require_gtk require_gtk() from bleachbit.GtkShim import Gtk Gtk.RecentManager().get_default().purge_items() yield 0 xbel_pathnames = [ '~/.recently-used.xbel', '~/.local/share/recently-used.xbel*', '~/snap/*/*/.local/share/recently-used.xbel'] for path1 in xbel_pathnames: for path2 in glob.iglob(os.path.expanduser(path1)): if os.path.lexists(path2): yield Command.Shred(path2) if gtk_may_be_available(): # Use the Function to skip when in preview mode yield Command.Function(None, gtk_purge_items, _('Recent documents list')) if IS_POSIX and 'rotated_logs' == option_id: for path in Unix.rotated_logs(): yield Command.Delete(path) # temporary files if IS_POSIX and 'tmp' == option_id: dirnames = ['/tmp', '/var/tmp'] for dirname in dirnames: for path in children_in_directory(dirname, True): # is_open() resolves the path and rescans /proc, so leave # it until the cheaper tests have had a chance to reject. ok = os.path.isfile(path) and \ not os.path.islink(path) and \ FileUtilities.ego_owner(path) and \ not self.whitelisted(path) and \ not FileUtilities.openfiles.is_open(path) if ok: yield Command.Delete(path) # temporary files if IS_WINDOWS and 'tmp' == option_id: dirnames = [os.path.expandvars( r'%temp%'), os.path.expandvars("%windir%\\temp\\")] # whitelist the folder %TEMP%\Low but not its contents # https://bugs.launchpad.net/bleachbit/+bug/1421726 # Do not delete recent D-Bus nonce files because it allows # starting more than once instance of this application. gdbus_nonce_re = re.compile(r'gdbus-nonce-file-[0-9A-Za-z]+$', re.IGNORECASE) gdbus_nonce_max_age_seconds = 7 * 24 * 60 * 60 # 7 days for dirname in dirnames: low = os.path.join(dirname, 'low') for filename in children_in_directory(dirname, True): if path_equal(low, filename, case_sensitive=False): continue if gdbus_nonce_re.match(os.path.basename(filename)): try: age = time.time() - os.stat(filename).st_mtime except OSError: continue if age < gdbus_nonce_max_age_seconds: continue yield Command.Delete(filename) # trash if IS_POSIX and 'trash' == option_id: yield from Unix.get_trash_paths() # clipboard if 'clipboard' == option_id and (gtk_may_be_available() or IS_WINDOWS): if IS_WINDOWS and not gtk_may_be_available(): # Works with TUI or wxPython def func_clear_clipboard(): """Command function to clear clipboard (Windows native)""" Windows.clear_clipboard() return 0 else: def func_clear_clipboard(): """Command function to clear clipboard""" # GuiUtil is GTK-specific from bleachbit.GtkShim import require_gtk require_gtk() import bleachbit.GuiUtil bleachbit.GuiUtil.clear_clipboard() return 0 yield Command.Function(None, func_clear_clipboard, _('Clipboard')) # wipe empty space if 'empty_space' == option_id and (shred_drives := options.get_list('shred_drives')): for pathname in shred_drives: # TRANSLATORS: 'Empty' means 'unallocated.' # %s expands to a path such as C:\ or /tmp/ display = _("Wipe empty space in %s") % pathname def wipe_path_func(path=pathname): # Yield control to GTK idle because this process # is very slow. Also display progress. yield from wipe_path(path, idle=True) yield 0 yield Command.Function(None, wipe_path_func, display) # MUICache if IS_WINDOWS and 'muicache' == option_id: keys = ( 'HKCU\\Software\\Microsoft\\Windows\\ShellNoRoam\\MUICache', 'HKCU\\Software\\Classes\\Local Settings\\Software\\Microsoft\\Windows\\Shell\\MuiCache') for key in keys: yield Command.Winreg(key, None) # prefetch if IS_WINDOWS and 'prefetch' == option_id: for path in glob.iglob(os.path.expandvars('$windir\\Prefetch\\*.pf')): yield Command.Delete(path) # recycle bin if IS_WINDOWS and 'recycle_bin' == option_id: # This method allows shredding recycled_any = False for path in Windows.get_recycle_bin(): recycled_any = True yield Command.Delete(path) # Windows 10 refreshes the recycle bin icon when the user # opens the recycle bin folder. # This is a hack to refresh the icon. def empty_recycle_bin_func(): tmpdir = tempfile.mkdtemp() Windows.move_to_recycle_bin(tmpdir) try: Windows.empty_recycle_bin(None, True) except Exception: logger.info( 'error in empty_recycle_bin()', exc_info=True) yield 0 # Using the Function Command prevents emptying the recycle bin # when in preview mode. if recycled_any: yield Command.Function(None, empty_recycle_bin_func, _('Empty the recycle bin')) # DNS cache if 'dns_cache' == option_id: if IS_WINDOWS: yield Command.Function(None, Windows.flush_dns, _('DNS cache')) elif IS_LINUX: yield Command.Function(None, Unix.flush_dns, _('DNS cache')) # Windows Updates if IS_WINDOWS and 'updates' == option_id: yield from Windows.delete_updates() def init_whitelist(self): """Initialize the keep list (formerly whitelist) only once for performance""" # re.escape because a home directory may contain regex metacharacters home = re.escape(os.path.expanduser('~')) regexes = [ r'^/tmp/\.X0-lock$', r'^/tmp/\.truecrypt_aux_mnt.*/(control|volume)$', r'^/tmp/\.vbox-[^/]+-ipc/lock$', r'^/tmp/\.wine-[0-9]+/server-.*/lock$', '^/tmp/fsa/', # fsarchiver '^/tmp/gconfd-[^/]+/lock/ior$', '^/tmp/kde-', '^/tmp/kdesudo-', '^/tmp/ksocket-', r'^/tmp/orbit-[^/]+/bonobo-activation-register[a-z0-9-]*\.lock$', '^/tmp/orbit-[^/]+/bonobo-activation-server-[a-z0-9-]*ior$', '^/tmp/pulse-[^/]+/pid$', '^/tmp/xauth', '^/var/tmp/kdecache-', '^' + home + r'/\.cache/wallpaper/', # Flatpak mount point '^' + home + r'/\.cache/doc($|/)', # Clean Firefox cache from Firefox cleaner (LP#1295826) '^' + home + r'/\.cache/mozilla/', # Clean Google Chrome cache from Google Chrome cleaner (LP#656104) '^' + home + r'/\.cache/google-chrome/', '^' + home + r'/\.cache/gnome-control-center/', # Clean Evolution cache from Evolution cleaner (GitHub #249) '^' + home + r'/\.cache/evolution/', # iBus Pinyin # https://bugs.launchpad.net/bleachbit/+bug/1538919 '^' + home + r'/\.cache/ibus/', # Linux Bluetooth daemon obexd directory is typically empty, so be careful # not to delete the empty directory. '^' + home + r'/\.cache/obexd($|/)', # KDE/Plasma cache files # https://github.com/bleachbit/bleachbit/issues/1853 '^' + home + r'/\.cache/kwin($|/)', # folder # folder '^' + home + r'/\.cache/mesa_shader_cache($|/)', '^' + home + r'/\.cache/plasmashell($|/)', # folder '^' + home + r'/\.cache/icon-cache\.kcache$', # file # file r'^' + home + r'/\.cache/plasma_theme_.*\.kcache$', '^' + home + r'/\.cache/drkonqi($|/)', # folder # folder '^' + home + r'/\.cache/mesa_shader_cache_db($|/)', # folder '^' + home + r'/\.cache/qtshadercache-[^/]+($|/)', # file '^' + home + r'/\.cache/plasma_theme_default\.kcache$'] self.keep_list_re = re.compile( '|'.join(f'(?:{regex})' for regex in regexes)) def whitelisted(self, pathname): """Return boolean whether file is keep listed (formerly whitelisted)""" if IS_WINDOWS: # Whitelist is specific to POSIX return False if self.keep_list_re is None: self.init_whitelist() return self.keep_list_re.match(pathname) is not None def register_cleaners(cb_progress=lambda x: None, cb_done=lambda: None, allow_local=True): """Register all known cleaners: system, CleanerML, and Winapp2""" # wipe out any registrations # Because this is a global variable, cannot use backends = {} backends.clear() # initialize "hard coded" (non-CleanerML) backends backends["system"] = System() if not options.get("load_cleaners"): cb_done() yield False return # register CleanerML cleaners # TRANSLATORS: Progress message shown typically on startup. # 'Native' refers to the .xml cleaners designed for this application, # as contrasted to Winapp2.ini, which is native to another application. # 'Loading' is a present participle. # To indicate an ongoing operation, include the ellipsis as literal # Unicode (…) or as Unicode escape (\u2026). cb_progress(_('Loading native cleaners\u2026')) yield from CleanerML.load_cleaners(cb_progress, allow_local=allow_local) # register Winapp2.ini cleaners if IS_WINDOWS: # TRANSLATORS: Progress message shown typically on startup. # 'Importing' is a present participle. # To indicate an ongoing operation, include the ellipsis as literal # Unicode (…) or as Unicode escape (\u2026). cb_progress(_('Importing cleaners from Winapp2.ini\u2026')) from bleachbit import Winapp yield from Winapp.load_cleaners(cb_progress) cb_done() yield False # end the iteration def simpler_cleaner_process_path(path): """Process a path for create_simple_cleaner Returns the absolute path to shred or None if invalid. Invalid: - not a string - empty string - path resolves to CWD or its parent Not checked: path existence or type of path """ if not isinstance(path, str): raise RuntimeError( f'expected path as string but got {str(path)}') if not path.strip(): logger.warning('Refusing to clean an empty path') return None if not os.path.isabs(path): path = os.path.abspath(path) else: path = os.path.normpath(path) cwd = os.getcwd() cwd_parent = os.path.dirname(cwd) if path in (cwd, cwd_parent): logger.warning( 'Refusing to shred working directory or its parent: %s', path) return None return path class CustomFileAction(Action.ActionProvider): """Custom file action""" # At module level because the metaclass registers every subclass globally action_key = '__customfileaction' def __init__(self, paths): Action.ActionProvider.__init__(self, None) self.paths = paths def get_commands(self): """Yield a shred command for each path""" for path in self.paths: path = simpler_cleaner_process_path(path) if not path: continue if os.path.isdir(path): for child in children_in_directory(path, True): yield Command.Shred(child) yield Command.Shred(path) def create_simple_cleaner(paths): """Shred arbitrary files (used in CLI and GUI)""" cleaner = Cleaner() cleaner.add_option(option_id='files', name='', description='') cleaner.name = _("System") # shows up in progress bar cleaner.add_action('files', CustomFileAction(paths)) return cleaner class CustomWipeAction(Action.ActionProvider): """Custom wipe action""" action_key = '__customwipeaction' def __init__(self, path): Action.ActionProvider.__init__(self, None) self.path = path # TRANSLATORS: %s is the path of the drive whose empty space will be wiped. self.display = _("Wipe empty space %s") % path def get_commands(self): """Yield the command that wipes the free space""" def wipe_path_func(): yield from wipe_path(self.path, idle=True) yield 0 yield Command.Function(None, wipe_path_func, self.display) def create_wipe_empty_space_cleaner(path): """Wipe empty space of arbitrary paths (used in GUI)""" cleaner = Cleaner() cleaner.add_option( option_id='empty_space', name='', description='') cleaner.name = '' cleaner.add_action('empty_space', CustomWipeAction(path)) return cleaner ././@PaxHeader0000000000000000000000000000002600000000000010213 xustar0022 mtime=1792288280.0 bleachbit-6.0.6/bleachbit/CleanerML.py0000775000175000017500000004503115265023030015101 0ustar00zz# SPDX-License-Identifier: GPL-3.0-or-later # Copyright (c) 2008-2026 Andrew Ziem. # # This work is licensed under the terms of the GNU GPL, version 3 or # later. See the COPYING file in the top-level directory. """ Create cleaners from CleanerML (markup language) """ # standard library import logging import os import sys import xml.etree.ElementTree # local import import bleachbit from bleachbit import IS_POSIX, IS_WINDOWS from bleachbit.Action import ActionProvider from bleachbit.FileUtilities import expand_glob_join, listdir from bleachbit.General import boolstr_to_bool from bleachbit.General import os_match as general_os_match from bleachbit.General import reject_xml_dtd from bleachbit.Language import get_text as _ from bleachbit.PathUtils import is_world_writable, path_startswith from bleachbit import Cleaner if IS_WINDOWS: from bleachbit.Windows import read_registry_key logger = logging.getLogger(__name__) """Actions blocked for untrusted (user-writable) cleaners. Deletion stays allowed, so blocking registry deletion too would buy nothing. """ UNTRUSTED_BLOCKED_COMMANDS = ('process',) class _ETSimpleTextNode: ELEMENT_NODE = 1 TEXT_NODE = 3 def __init__(self, data): self.nodeType = self.TEXT_NODE self.data = data class _ETSimpleElementNode: ELEMENT_NODE = 1 TEXT_NODE = 3 def __init__(self, element): self._element = element self.nodeType = self.ELEMENT_NODE self.nodeName = element.tag def getAttribute(self, name): return self._element.attrib.get(name, '') def hasAttribute(self, name): return name in self._element.attrib @property def childNodes(self): nodes = [] if self._element.text: nodes.append(_ETSimpleTextNode(self._element.text)) for child in self._element: nodes.append(_ETSimpleElementNode(child)) if child.tail: nodes.append(_ETSimpleTextNode(child.tail)) return nodes class _ETActionElementAdapter: def __init__(self, element): self._element = element def getAttribute(self, name): return self._element.attrib.get(name, '') def _gettext_etree(element): """Return text like General.getText() would for minidom nodes.""" if element is None: return '' rc = element.text or '' for child in element: rc += child.tail or '' return rc def _toxml_etree(element): return xml.etree.ElementTree.tostring(element, encoding='unicode') def default_vars(): """Return default multi-value variables""" ret = {} if not IS_WINDOWS: return ret from bleachbit.Windows import get_windows_system_paths # Expand ProgramFiles to also be ProgramW6432, etc. wowvars = (('ProgramFiles', 'ProgramW6432'), ('CommonProgramFiles', 'CommonProgramW6432')) for v1, v2 in wowvars: # Remove None, if variable is not found. # Make list unique. mylist = list({x for x in (os.getenv(v1), os.getenv(v2)) if x}) ret[v1] = mylist ret['WindowsSystem'] = get_windows_system_paths() return ret def _parse_cleaner_xml(pathname): """Parse a CleanerML file and return the root element.""" with open(pathname, 'rb') as f: data = f.read() reject_xml_dtd(data, 'CleanerML') return xml.etree.ElementTree.fromstring(data) class CleanerML: """Create a cleaner from CleanerML""" def __init__(self, pathname, xlate_cb=None, trusted=True): """Create cleaner from XML in pathname. If xlate_cb is set, use it as a callback for each translate-able string (untranslated, as in the XML). trusted is False for cleaners from user-writable directories; their command-execution actions are ignored. """ self.action = None self.trusted = trusted self.ignored_commands = set() self.cleaner = Cleaner.Cleaner() self.option_id = None self.option_name = None self.option_description = None self.option_warning = None self.vars = default_vars() self.xlate_cb = xlate_cb if self.xlate_cb is None: self.xlate_mode = False self.xlate_cb = lambda x, y=None: None # do nothing else: self.xlate_mode = True try: root_element = _parse_cleaner_xml(pathname) except Exception as e: logger.error( "Error parsing CleanerML file %s with error %s", pathname, e) return if root_element.tag == 'cleaner': cleaner_element = root_element else: cleaner_element = root_element.find('.//cleaner') if cleaner_element is None: logger.error( "Error parsing CleanerML file %s: missing element", pathname) return self.handle_cleaner(cleaner_element) if self.ignored_commands: commands = ', '.join( f"'{c}'" for c in sorted(self.ignored_commands)) logger.warning( "ignoring %s actions from untrusted cleaner: %s", commands, pathname) def get_cleaner(self): """Return the created cleaner""" return self.cleaner def os_match(self, os_str, platform=sys.platform): """Return boolean whether operating system matches Keyword arguments: os_str -- the required operating system as written in XML platform -- used only for unit tests """ # If in .pot-creation-mode, return true. if self.xlate_mode: return True return general_os_match(os_str, platform) def handle_cleaner(self, cleaner): """ element""" self.cleaner.id = cleaner.attrib.get('id', '') if not self.os_match(cleaner.attrib.get('os', '')): return label = cleaner.find('label') if label is None: raise IndexError('missing