()
19 |
20 | override init() {
21 | super.init()
22 | }
23 |
24 | // Accept new XPC connections by setting up the exported interface and object.
25 | func listener(_ listener: NSXPCListener, shouldAcceptNewConnection newConnection: NSXPCConnection) -> Bool {
26 | newConnection.exportedInterface = NSXPCInterface(with: HelperToolProtocol.self)
27 | newConnection.exportedObject = self
28 | newConnection.invalidationHandler = { [weak self] in
29 | self?.activeConnections.remove(newConnection)
30 | if self?.activeConnections.isEmpty == true {
31 | exit(0) // Exit when no active connections remain
32 | }
33 | }
34 | activeConnections.insert(newConnection)
35 | newConnection.resume()
36 | return true
37 | }
38 |
39 | // Execute the shell command and reply with output.
40 | func runCommand(command: String, withReply reply: @escaping (Bool, String) -> Void) {
41 | let process = Process()
42 | process.executableURL = URL(fileURLWithPath: "/bin/bash")
43 | process.arguments = ["-c", command]
44 | let pipe = Pipe()
45 | process.standardOutput = pipe
46 | process.standardError = pipe
47 | do {
48 | try process.run()
49 | process.waitUntilExit()
50 | } catch {
51 | reply(false, "Failed to run command: \(error.localizedDescription)")
52 | return
53 | }
54 | let data = pipe.fileHandleForReading.readDataToEndOfFile()
55 | let output = String(data: data, encoding: .utf8)?.trimmingCharacters(in: .whitespacesAndNewlines) ?? ""
56 | let success = (process.terminationStatus == 0) // Check if process exited successfully
57 | reply(success, output.isEmpty ? "No output" : output)
58 | }
59 |
60 | // Execute app lipo using privileges for apps owned by root
61 | func runThinning(atPath: String, withReply reply: @escaping (Bool, String) -> Void) {
62 | let success = thinBinaryUsingMachO(executablePath: atPath)
63 | reply(success, success ? "Success" : "Failed")
64 | }
65 | }
66 |
67 | // Set up and start the XPC listener.
68 | let delegate = HelperToolDelegate()
69 | let listener = NSXPCListener(machServiceName: "com.alienator88.Pearcleaner.PearcleanerHelper")
70 | listener.delegate = delegate
71 | listener.resume()
72 | RunLoop.main.run()
73 |
--------------------------------------------------------------------------------
/PearcleanerSentinel/com.alienator88.PearcleanerSentinel.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | Label
6 | com.alienator88.PearcleanerSentinel
7 | BundleProgram
8 | Contents/MacOS/PearcleanerSentinel
9 | RunAtLoad
10 |
11 | KeepAlive
12 |
13 | AssociatedBundleIdentifiers
14 |
15 | com.alienator88.Pearcleaner
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/PearcleanerSentinel/main.swift:
--------------------------------------------------------------------------------
1 | //
2 | // main.swift
3 | // PearcleanerSentinel
4 | //
5 | // Created by Alin Lupascu on 11/9/23.
6 | //
7 |
8 |
9 | import AppKit
10 | import FileWatcher
11 |
12 | main()
13 |
14 | var globalFileWatcher: FileWatcher?
15 |
16 | func startGlobalFileWatcher() {
17 | let home = FileManager.default.homeDirectoryForCurrentUser.path
18 | globalFileWatcher = FileWatcher(["\(home)/.Trash"])
19 | globalFileWatcher?.queue = DispatchQueue.global()
20 | globalFileWatcher?.callback = { event in
21 | checkApp(file: event.path)
22 | }
23 | globalFileWatcher?.start()
24 | }
25 |
26 | func stopGlobalFileWatcher() {
27 | globalFileWatcher?.stop()
28 | globalFileWatcher = nil
29 | }
30 |
31 | func setupNotificationListener() {
32 | let notificationCenter = DistributedNotificationCenter.default()
33 | notificationCenter.addObserver(forName: Notification.Name("Pearcleaner.StartFileWatcher"), object: nil, queue: nil) { notification in
34 | print("Received start notification")
35 | startGlobalFileWatcher()
36 | }
37 | notificationCenter.addObserver(forName: Notification.Name("Pearcleaner.StopFileWatcher"), object: nil, queue: nil) { notification in
38 | print("Received stop notification")
39 | stopGlobalFileWatcher()
40 | }
41 | }
42 |
43 | func main() {
44 | setupNotificationListener()
45 | startGlobalFileWatcher()
46 | RunLoop.main.run()
47 | }
48 |
49 |
50 | func checkApp(file: String) {
51 | let app = URL(fileURLWithPath: file)
52 | let appExt = app.pathExtension
53 | if appExt == "app" {
54 | if let appBundle = Bundle(url: app) {
55 | if appBundle.bundleIdentifier == "com.alienator88.Pearcleaner" {
56 | return
57 | } else {
58 | if FileManager.default.isInTrash(app) {
59 | NSWorkspace.shared.open(URL(string: "pear://openApp?path=\(file)")!)
60 | }
61 | }
62 | } else {
63 | print("Error: Unable to get bundle information for \(file)")
64 | }
65 | }
66 | }
67 |
68 |
69 |
70 | // --- Trash Relationship ---
71 | extension FileManager {
72 | public func isInTrash(_ file: URL) -> Bool {
73 | var relationship: URLRelationship = .other
74 | do {
75 | try getRelationship(&relationship, of: .trashDirectory, in: .userDomainMask, toItemAt: file)
76 | return relationship == .contains
77 | } catch {
78 | return false
79 | }
80 | }
81 | }
82 |
83 |
84 |
85 |
86 |
87 |
88 | // For testing and outputing logging to file from cmd line tool
89 | func writeLogMon(string: String) {
90 | let fileManager = FileManager.default
91 | let home = fileManager.homeDirectoryForCurrentUser.path
92 | let logFilePath = "\(home)/Downloads/monitor.txt"
93 |
94 | // Check if the log file exists, and create it if it doesn't
95 | if !fileManager.fileExists(atPath: logFilePath) {
96 | if !fileManager.createFile(atPath: logFilePath, contents: nil, attributes: nil) {
97 | print("Failed to create the log file.")
98 | return
99 | }
100 | }
101 |
102 | do {
103 | if let fileHandle = FileHandle(forWritingAtPath: logFilePath) {
104 | let ns = "\(string)\n"
105 | fileHandle.seekToEndOfFile()
106 | fileHandle.write(ns.data(using: .utf8)!)
107 | fileHandle.closeFile()
108 | } else {
109 | print("Error opening file for appending")
110 | }
111 | }
112 | }
113 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Pearcleaner
2 |
3 |
4 | 
5 |
6 |
7 | Status: Maintained
8 |
9 | Version: 4.4.4
10 |
11 | Download
12 | ·
13 | Commits
14 |
15 |
16 | 
17 |
18 | 
19 |
20 |
21 |
22 |
23 |
24 | A free, source-available and fair-code licensed Mac app cleaner inspired by [Freemacsoft's AppCleaner](https://freemacsoft.net/appcleaner/) and [Sun Knudsen's Privacy Guides](https://github.com/sunknudsen/guides/tree/main/archive/how-to-clean-uninstall-macos-apps-using-appcleaner-open-source-alternative) post on his app-cleaner script.
25 | This project was born out of wanting to learn more on how macOS deals with app installation/uninstallation and getting more Swift experience. If you have suggestions I'm open to hearing them, submit a feature request!
26 |
27 |
28 | ### Table of Contents:
29 | [Translations](#translations) | [License](#license) | [Features](#features) | [Screenshots](#screenshots) | [Issues](#issues) | [Requirements](#requirements) | [Download](#getting-pearcleaner) | [Thanks](#thanks) | [Other Apps](#other-apps)
30 |
31 |
32 |
33 | ## Translations
34 | If you are able to contribute to translations for the app, please see this discussion: https://github.com/alienator88/Pearcleaner/discussions/137
35 |
36 | ## License
37 | > [!IMPORTANT]
38 | > Pearcleaner is licensed under Apache 2.0 with [Commons Clause](https://commonsclause.com/). This means that you can do anything you'd like with the source, modify it, contribute to it, etc., but the license explicitly prohibits any form of monetization for Pearcleaner or any modified versions of it. See full license [HERE](https://github.com/alienator88/Pearcleaner/blob/main/LICENSE.md)
39 |
40 | ## Features
41 | - Orphaned file search for finding remaining files from previously uninstalled applications
42 | - Development environments file/cache cleaning
43 | - App Lipo to strip unneeded architectures from universal apps. No dependency on the lipo tool so no need to install xcode or command line tools
44 | - Prune unused translation files from app bundles keeping only the preferred language set on macOS
45 | - Sentinel monitor helper that can be enabled to watch Trash folder for deleted apps to cleanup after the fact(Extremely small (210KB) and uses ~2mb of ram to run in the background and file watch)
46 | - Mini mode which can be enabled from Settings
47 | - Menubar icon option
48 | - CLI support
49 | - Drag/drop applications support
50 | - Deep link support for automation, see [wiki guide](https://github.com/alienator88/Pearcleaner/wiki/Deep-Link-Guide) for instructions
51 | - Optional Finder Extension which allows you to uninstall an app directly from Finder by `right click > Pearcleaner Uninstall`
52 | - Theme System available with custom color selector
53 | - Differentiate between regular, Safari web-apps and mobile apps with badges like **web** and **iOS**
54 | - Has clean uninstall menu option for the Pearcleaner app itself if you want to stop using it and get rid of all files and launch items
55 | - Export app bundles for migrating apps and their cache to a new system
56 | - Export app file list search results
57 | - Optional Homebrew cleanup
58 | - Include extra directories to search for apps in
59 | - Exclude files/folders from the orphaned file search
60 | - Custom auto-updater that pulls latest release notes and binaries from GitHub Releases (Pearcleaner should run from `/Applications` folder to avoid permission issues)
61 |
62 |
63 | ## Screenshots
64 |
65 | 
66 |
67 | 
68 |
69 | 
70 |
71 | 
72 |
73 |
74 | ## Issues
75 | > [!WARNING]
76 | > - When submitting issues, please use the appropriate issue template corresponding with your problem [HERE](https://github.com/alienator88/Pearcleaner/issues/new/choose)
77 | > - Beta versions of macOS will not be supported until general release
78 |
79 |
80 | ## Requirements
81 | > [!NOTE]
82 | > - MacOS 13.0+ [Non-beta releases]
83 | > - Full Disk permission to search for files
84 |
85 |
86 | ## Getting Pearcleaner
87 |
88 |
89 | Releases
90 |
91 | Pre-compiled, always up-to-date versions are available from my [releases](https://github.com/alienator88/Pearcleaner/releases) page.
92 |
93 |
94 |
95 | Homebrew
96 |
97 | You can add the app via Homebrew:
98 | ```
99 | brew install pearcleaner
100 | ```
101 |
102 |
103 | ## Thanks
104 |
105 | - Much appreciation to [Freemacsoft's AppCleaner](https://freemacsoft.net/appcleaner/) and [Sun Knudsen's app-cleaner script](https://sunknudsen.com/privacy-guides/how-to-clean-uninstall-macos-apps-using-appcleaner-open-source-alternative)
106 | - [DharsanB](https://github.com/dharsanb) for sponsoring my Apple Developer account
107 |
108 | ## Other Apps
109 |
110 | [Pearcleaner](https://github.com/alienator88/Pearcleaner) - An opensource app cleaner with privacy in mind
111 |
112 | [Sentinel](https://github.com/alienator88/Sentinel) - A GUI for controlling gatekeeper status on your Mac
113 |
114 | [Viz](https://github.com/alienator88/Viz) - Utility for extracting text from images, videos, qr/barcodes
115 |
116 | [PearHID](https://github.com/alienator88/PearHID) - Remap your macOS keyboard with a simple SwiftUI frontend
117 |
--------------------------------------------------------------------------------
/announcements.json:
--------------------------------------------------------------------------------
1 | {
2 | "4.4.0": "- Privileged Helper Service: Pearcleaner now supports using a privileged helper service to perform operations that require administrative permissions. This will eventually replace the current mechanism which uses Authorization Services as it's deprecated by Apple. More information in Settings > Helper tab.|- App Lipo: There's a new Lipo(beta) view available in the menu which will show all universal apps and strip the app binary of the unused architectures to save some space. Universal apps will also show a Lipo button on the App Details view next to the Uninstall button to perform the same procedure on each app individually.",
3 | "3.9.2": "- Multilingual Support: If you would like to help translate Pearcleaner to your language, please see GitHub issue #83",
4 | "3.7.0": "- App List Size Sorting: You can now sort the sidebar app list alphabetically or by descending size. Click the User/System header to toggle or from the searchbar menu|- Leftover Files: On first use, a warning/explanation sheet will be presented to the user",
5 | "3.5.0": "- Finder Extension: When enabled, you can right click an app in finder and uninstall with Pearcleaner directly|- Theme System: You can now select a base theme color for the application window",
6 | "3.3.0": "- Folder Settings: Add more directories where Pearcleaner should search for app files|- Progress: Show progress bar on startup when loading all app files with instant search enabled|- App Icon: Show background color behind app icons in FilesView based on icon's average color mapping|- Progress: Show time counter on regular file search views",
7 | "3.2.0": "- Menubar Item: You can choose to access Pearcleaner from the menubar. This will show a slightly modified Mini Mode view.",
8 | "3.1.0": "- Homebrew Cleanup: If you install apps using brew, you can now enable Homebrew cleanup in the settings to have Pearcleaner alert Homebrew that the app was removed externally from Homebrew and keep the brew app list synced.",
9 | "3.0.0": "- Instant Search: Enable in settings to load app files on startup|- Semantic Versioning: Going forward will use semver (Ex. v0.0.0)|-Feature Alert: For each version, a feature alert will popup once on startup to show details|- Leftover File Cleaning: Search your Mac for files leftover by uninstalled apps|- Sidebar Drag Handle: Resize the sidebar in regular mode|- Redesign UI/Settings/Icon: Some new buttons, layout changes, new official app icon and pear color theme accents|- File Sort: Sort files alphabetically or by size|- Socket File Removal: Finds socket files that aren't even visible in Finder with show hidden files enabled|- OSLog Output: Will print errors to the Console app for easier troubleshooting"
10 | }
11 |
--------------------------------------------------------------------------------