bleachbit / cleanerml

System cleaners written in CleanerML used by BleachBit. Free disk space and maintain privacy.

CleanerML Repository

CleanerML

CleanerML is a simple yet powerful markup language for writing cleaners. Most of BleachBit's cleaners are written in CleanerML, and you can write your own cleaners in CleanerML, too.

You can think of it as writing XML to delete files, but it is more powerful than that.

BleachBit

BleachBit is an open source system cleaner for Windows and Linux.

How to contribute

There are three ways to contribute: review a pull request, review cleaners that are already submitted, or write your own cleaner.

For any of these, start here:

1. Download BleachBit.
2. Read Documentation on CleanerML.
3. Read Contributing a cleaner.

After making changes to a cleaner, run make tests to check for errors because the XSD can find many errors in the XML. It's best to also run make pretty before commiting a change.

How to use

In the future automated sync may be as easy as checking one option, but for now you must manually download and copy the files to your personal cleaners directory. The easiest way to find the directory is to open BleachBit, click the hamburger menu (three horizontal lines), click Diagnostics, and look for the line with personal_cleaner_dir.

Contents

The directory pending contains cleaners that are waiting for someone to verify they are safe and effective. The directory release contains cleaners that are considered safe and effective.

Additional information

Your cleaners should retain the copyright and information header found in release/*.xml. Please edit the copyright information accordingly. If needed, you can also include extra maintenance information in the header, as found in release/openshot.xml:

@url http://full.url.of/software-project
@tested ok softwareversion, OSnameandversion
@note Some notes for cleaner maintainers

License

The contents of this repository are licensed under the GNU General Public License version 3 or later. Do not submit work for which you do not own the copyright or which cannot be licensed under the GNU GPL v3+.

cleanerml's Issues

Tor Cache Cleaner module

Hello,
I was going through my files to see what other items can be deleted to save space. It turns out TOR actually holds 6MB of cache. So I created a bleachbit module for it. Tested working fine on Arch Linux.

Gist is here:
https://gist.github.com/g4jc/13b63d039d781ae865da

git for the bleachbit

hey

it would be much easier to contribute if bitbleech itself was also on github.

ini section globs

I'm writing a cleaner for Dragon Player. In ~/.kde4/share/config/dragonplayerrc it creates a section for each file opened:

[file:///tmp/0002-0040.ogv]
brightness = \s0
contrast = \s0
date = \s05/05/2014
hue = \s0
isvideo = \strue
preferred size = \s647,262
saturation = \s0

[https://upload.wikimedia.org/wikipedia/commons/8/83/Elephants_Dream_(high_quality).ogv]
brightness = \s0
contrast = \s0
date = \s08/06/2014
hue = \s0
isvideo = \sfalse
preferred size = \s647,262
saturation = \s0

So I tried doing <action search="glob" path="~/.kde4/share/config/dragonplayerrc" command="ini" section="*://*"/> and well it didn't work, I didn't think putting glob in the search parameter would help, but I was hopefull. Is there a way to use glob in the section parameter?

Potentially cleanable Calibre JSON files

Here are a couple JSON files generated by Calibre which might potentially be cleanable.
~/Calibre Library/metadata_db_prefs_backup.json
~/.config/calibre/viewer.json

metadata_db_prefs_backup.json has "gui_view_history": [] which is a 2D array of the 15 most recently opened books using calibre — I had trouble getting command="json" working for this one.

viewer.json has "viewer_open_history": [] which is an array of the most recently opened books using calibre's ebook viewer (whether you opened the book from calibre itself or otherwise) — I didn't attempt cleaning this bit, it might be easy to do.

[Chrome/Vivaldi] browsers local storage not properly deleted

samy.pl/evercookie can recover data from the browsers localstorage after it was cleaned with the vivaldi cleaner
aside from that it seems to work fine (in windows atm, will test linux later)

Videolan VLC (updated)

https://gist.github.com/nolme/5602694

Updated for recently played.

Microsoft Windows Terminal Server Cache & MRU

https://gist.github.com/nolme/5602656

Cleaner for autojump

https://github.com/joelthelion/autojump

Cleanup of all Windows User Profiles possible?

Hello,

does BleachBit only clean up the user profile of the current user?
Or also all other user profiles that exist on the PC?

Comodo IceDragon cleaner

Based on the Firefox cleaner I sent.
This browser is only for Windows.

Tested on Windows 7 with Comodo IceDragon 19.0.1.
Get it here.

[linux] Clean trashes for non-home partitions

From http://standards.freedesktop.org/trash-spec/trashspec-0.8.html:

(2) If an $topdir/.Trash directory is absent, an $topdir/.Trash-$uid directory is to be used as the user's trash directory for this device/partition. $uid is the user's numeric identifier.

Search the filesystem for directories that match \.Trash.* and delete their contents.

Microsoft Edge Legacy cleaner ... and frustration

So I (finally) got my hands on a Windows 10 machine and am in the process of writing a cleaner for it.

I am pretty sure I got it to work with Cookies and History so far but the output in BB states that these directories don't really exist.
Blank screen.

Can someone with Win 10 and Edge please test this?
Getting quite pissed off at the roadblock I've run into.

https://github.com/az0/cleanerml/blob/master/pending/edge.xml

Thanks!

<warning>text not displaying</warning>

For me, text wraped <warning>in these</warning> wont be displayed at all.

I'm on Chakra 2014.02 "Curie" (uses KDE)
BleachBit 1.0
GTK2 theme: Raleigh
GTK3 theme: Default
GTK2 & 3 icon theme: oxygen with oxygen white as fallback
GTK2 & 3 font: DejaVu Sans Book 9

Windows Linux Subsystem

How can I start to implement a cleaner for Linux log files inside WSL?

New bleachbit release including cleaners?

Hi @az0, this took some time but we now have a bunch of good cleaners in the release/ directory. Would you like to release a new bleachbit version with those cleaners added?

I see many people are not aware of this repository (eg. http://www.webupd8.org/2014/10/unity-privacy-indicator-04-released.html, see comments), and there is still no mechanism in bleachbit to add those (I just clone the repo and manually copy files, which is fine, but many people won't bother)

What do you think? It would be cool to have the well tested cleaners in Debian.

easytag.xml duplicate

An easytag.xml exists both here in pending and in bleachbit/cleaners. Is this ok? Or should they be merged?

Firefox: Password cleaning does not give a warning

Hey all,

I never added a to the passwords option in the Firefox cleaner so users aren't being prompted due to my ignorance with Python. I don't quite know how to write that in Python. Anyone else wanna take a stab at it?

Search function walk.all and delete not empty folders

I want to configure the constellation to delete all directories (with included files) with ending strings like (1), (2), (3), ...

My actual configuration is
<action command="delete" search="walk.all" path="C:\Tools\cloud_open\apps\" regex=" \(\d\)" />

The file structure is
C:\Tools\cloud_open\apps\FirefoxPortable...
|-------------------------\BleachBit-Portable...
|-------------------------\LibreOfficePortable...

Example directories which should be deleted:

• C:\Tools\cloud_open\apps\FirefoxPortable\Data\Firefox\safebrowsing (1)\
• C:\Tools\cloud_open\apps\FirefoxPortable\Data\Firefox\safebrowsing (3)\
• C:\Tools\cloud_open\apps\LibreOfficePortable\Data\LibreOffice\user\extensions\tmp (1)\

So I want to clean the complete structure C:\Tools\cloud_open\apps and it must be walk through all directories. The files inside the directories should also be deleted, independent from the defined regex.

My problem was, that it works only, if the directories are empty. How can I change the configuration that it deletes also the included files?

What are the "promotion" rules for cleaner files?

I have contributed some files to this project in the past, but I am simply not sure how/where I should be contributing some future work.

For instance, I see that the cleaning rules are divided into, essentially, three pieces:

• This project's pending directory.
• This project's release directory.
• Bleachbit's shipped rules.

I am running a new Firefox version (either aurora or, sometimes, even nightly) and there is a considerable amount of things that bleachbit 1.8 from Debian doesn't clean and I have to add my own personal rules.

Oh, and depending on the extensions to Firefox that you may have, you may gather a lot of garbage. But Firefox is only one of the many programs that need a face lift here.

Of course, I would like to give them back to the community (and let the community improve them while I am sleeping :)), but, really, I don't know where to send the patches!

In other words, this project (and bleachbit also) needs a CONTRIBUTING.md file. I can send an appropriate patch if I know how the project is structured.

Regards,

Rogério Brito.

Add version number to cleaners (xml files)

I think it might be a good idea to add a version number to the xml files.
Like:

Version: 0.1.34

in the comment block.

Cleaner for APT package lists

clean package lists in /var/lib/apt/lists on debian-based systems

Steam.xml

Hi,

I saw Steam.xml. The cleaner looks good. However I have installed Steamin D: drive. So is it possible to look for installation directory first and then perform cleaning instead of using $PROGRAMFILES ?

Accessibility issue in Windows XP

I have had a complaint said to me about how difficult it is to read the text in the progress bar in Bleachbit in Windows XP when using that tacky, default blue/green theme. The text is white. Maybe we could highlight the text in the progress bar to make it more readable?

[new]sdcv history cleaner

Hi everyone :)
I just created a cleanerml for sdcv(https://wiki.archlinux.org/index.php/Sdcv)

https://gist.github.com/yanderemoe/5c7a151d3c6fb9ace0d90e303f047e69

Tested and works on Arch Linux.
$ sdcv --version
Console version of Stardict, version 0.5.2

Skipped VirtualBox logs

My paths (Chakra 2014.02) for VirtuallBox logs looks like:
~/.config/VirtualBox/selectorywindow.log
~/.config/VirtualBox/selectorwindow.log.1
~/.config/VirtualBox/VBoxSVC.log
~/.config/VirtualBox/VBoxSVC.log.1
~/.config/VirtualBox/VBoxSVC.log.2
~/.config/VirtualBox/VBoxSVC.log.3
~/.config/VirtualBox/VBoxSVC.log.4
~/.config/VirtualBox/VBoxSVC.log.5
~/.config/VirtualBox/VBoxSVC.log.6
~/.config/VirtualBox/VBoxSVC.log.7
~/.config/VirtualBox/VBoxSVC.log.8
~/.config/VirtualBox/VBoxSVC.log.9
~/.config/VirtualBox/VBoxSVC.log.10

The current search pattern doesn't delete these logs:
~/.config/VirtualBox/selectorywindow.log
~/.config/VirtualBox/VBoxSVC.log

I don't know if this is on purpose or not.

Firefox (CleanerML version)

Here's my attempt at porting the Firefox cleaner to CleanerML, with some additional directories added.

Tested on Windows 7 with Firefox Aurora 21.0a2 (2013-04-01).
There was a "thumbnails-old" folder that had almost 1GB of files on it.

Get it here.

okular.xml deletes more then intended

The recent documents option unintentionally deletes the "state" and "toolbarsmovable" parameters under the "MainWindow" section. It seems harmless as they are regenerated the next time Okular starts, but it's still weird. The native "clear list" function built into Okular only deletes the "Recent Files" section.

search=path is not supported by bleachbit

https://github.com/az0/cleanerml/blob/8d9976419844e0e5eb832b2d4859e82997dead02/release/less.xml#L34

and not described in documentation either: https://docs.bleachbit.org/cml/cleanerml.html. the same issue is with gmrun cleaner.

Keep cleaners in 'cleanerml' repo and not in 'bleachbit' repo

Wouldn't it be better for the cleaner xml files to stay in this repo and fetch the stable ones in the build process?
This way contributors could see in the repo if a cleaner for an app exists and can be extended or it needs to be created.

cleaner for DHCP leases

On Linux systems, clear the DHCP leases that are stored in /var/lib/dhcp/*.{lease,leases}.

Correct/clarify 'How to use' to find personal_cleaner_dir

Currently, README.md's section "How to Use" says:

In the future automated sync may be as easy as checking one option, but for now you must manually download and copy the files to your personal cleaners directory. The easiest way to find the directory is to open BleachBit, click Help, click System Information, and look for personal_cleaner_dir.

At least in the Linux version, this instruction does not work. Clicking "Help" launches a dialogue offering to open update.bleachbit.org in a web browser.

Better documentation on CleanerML syntax for cleaning ini-files

Had a look at https://docs.bleachbit.org/doc/cleanerml.html, but besides 'Actions', 'ini' there are not much about cleaning a ini-file... Example-file also don't clean a ini-file... :-/
Think, better documentation on CleanerML syntax for cleaning ini-files would be good...

This PR should make PR https://github.com/bleachbit/bleachbit/pull/86 obsolete!

This PR should make PR bleachbit/bleachbit#86 obsolete!

There is a other file mentioned, %windir%\MiniDump.dmp, I haven't added yet, but I can add it too, if there is a need for.

Originally posted by @Tobias-B-Besemer in #169 (comment)

New CleanerML file for Heroes of the Storm

https://gist.github.com/Nightblade/a55a675421c2be037600809f723e02af

Do I need to request testing?

I couldn't find a clean way of referring/linking to a Gist here sorry.

Integrate external program to cleaners

Hello,

this is more of a question than an issue - is it possible to add a binary to the BleachBit portfolio? I wrote a C program that only lists or removes (gnome/freedesktop-type) thumbnails which are no longer necessary (they link to a non-existing file). Would that be useful for you? Thanks.

http://sourceforge.net/projects/gtrm/

Please create a release

Could you please create a release or tag? :)
I would like to provide a stable package in AUR (Arch Linux).

Possible improvment for the SMPlayer cleaner, but welcome?

I found a "strange" bug in SMPlayer.
I reported it now here: https://sourceforge.net/p/smplayer/bugs/937/
In short said: There are a combination of issues in SMPlayer that cascaded lock files get created, no more delete and make SMPlayer "un-usable" this way.
I would be able to improve the SMPlayer cleaner in this way, that this lock files gets deleted (it's trash) and SMPlayer will work normal, again.
My problem is the following: It's normally a bug in SMPlayer and if this issue would exist, there were no need to delete this files! So it feels a bit like "cleaning" a bug, what normally isn't the job of BB...
...on the other side it's a trash file! A job for BB! And: A bug fix will land in a future version of SMPlayer (earliest 20.04!) and then the user have to install the update and then the update hopeful fix a broken config/install... With a cleaner we would have a immediate solution to help users now, without any update of SMPlayer needed!
So the question is: If I add some lines to the cleaner to delete this trashy lock files, @az0 would you accept and check in the PR ???

Better documentation on CleanerML syntax for cleaning XML-files

Should have a better documentation on CleanerML syntax for cleaning XML-files.

In the specific case there must be the value removed from the parameter "MediaDir".
Don't know if handle it with command="ini" is the right solution...
Think, there should be a better documentation about such cases...

Cleaner action to compress files?

I would like for it to be possible to compress files using BleachBit either using an archiver or for example NTFS compression.

So for example:

<action command="compress" search="walk.files" path="$localappdata\temp\chocolatey\" regex="\.log$"/>

Description leads to bleachbit.sourceforge

Instead, it should lead to this http://www.bleachbit.org/news/bonus-pack-moved-svn-git

It redirects just fine, but still should use that link instead so people don't get the wrong idea.

Driver Leftovers.xml - Windows

A cleanerml xml to delete AMD/Nvidia and other driver installation media.

Each option will save users several hundred mb to several gigabytes in space, depending on how many drivers they have installed, and the last time they deleted the dirs.

#274