Merge pull request #238 from wakatime/main

Release v5.12.0

WakaTime/Extensions/AXUIElementExtension.swift

@@ -32,6 +32,20 @@ extension AXUIElement {
         // swiftlint:enable force_cast
     }
 
+    var nextSibling: AXUIElement? {
+        guard let parentChildren = self.parent?.children, let currentIndex = parentChildren.firstIndex(of: self) else { return nil }
+        let nextIndex = currentIndex + 1
+        guard parentChildren.indices.contains(nextIndex) else { return nil }
+        return parentChildren[nextIndex]
+    }
+
+    var previousSibling: AXUIElement? {
+        guard let parentChildren = self.parent?.children, let currentIndex = parentChildren.firstIndex(of: self) else { return nil }
+        let previousIndex = currentIndex - 1
+        guard parentChildren.indices.contains(previousIndex) else { return nil }
+        return parentChildren[previousIndex]
+    }
+
     var id: String? {
         guard let ref = getValue(for: kAXIdentifierAttribute) else { return nil }
         // swiftlint:disable force_cast
@@ -60,7 +74,7 @@ extension AXUIElement {
         // swiftlint:enable force_cast
     }
 
-    func project(for app: MonitoredApp) -> String? {
+    func address(for app: MonitoredApp) -> String? {
         var address: String?
         switch app {
             case .brave:
@@ -72,6 +86,10 @@ extension AXUIElement {
             case .firefox:
                 let addressField = findAddressField()
                 address = addressField?.value
+            case .linear:
+                let projectLabel = firstDescendantWhere { $0.value == "Project" }
+                let projectButton = projectLabel?.nextSibling?.firstDescendantWhere { $0.role == kAXButtonRole }
+                return projectButton?.rawTitle
             case .safari:
                 let addressField = elementById(identifier: "WEB_BROWSER_ADDRESS_AND_SEARCH_FIELD")
                 address = addressField?.value
@@ -80,12 +98,12 @@ extension AXUIElement {
                 address = addressField?.value
             default: return nil
         }
+        return address
+    }
 
-        if let address {
-            return extractProjectName(from: address)
-        }
-
-        return nil
+    func project(for app: MonitoredApp) -> String? {
+        guard let address = address(for: app) else { return nil }
+        return extractProjectName(from: address)
     }
 
     // swiftlint:disable cyclomatic_complexity

WakaTime/Extensions/NSRunningApplicationExtension.swift

@@ -43,6 +43,15 @@ enum MonitoredApp: String, CaseIterable {
         MonitoredApp.slack.rawValue,
     ]
 
+    static let browserAppIds = [
+        MonitoredApp.arcbrowser.rawValue,
+        MonitoredApp.brave.rawValue,
+        MonitoredApp.chrome.rawValue,
+        MonitoredApp.firefox.rawValue,
+        MonitoredApp.safari.rawValue,
+        MonitoredApp.safaripreview.rawValue,
+    ]
+
     // list apps which are enabled by default on first run
     static let defaultEnabledApps = [
         MonitoredApp.canva.rawValue,
@@ -57,9 +66,7 @@ enum MonitoredApp: String, CaseIterable {
     ]
 
     // list apps which we aren't yet able to track, so they're hidden from the Monitored Apps menu
-    static let unsupportedAppIds = [
-        MonitoredApp.linear.rawValue,
-    ]
+    static let unsupportedAppIds = [String]()
 }
 
 extension NSRunningApplication {

WakaTime/Extensions/StringExtension.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+extension String {
+    func matchesRegex(_ pattern: String) -> Bool {
+        if let regex = try? NSRegularExpression(pattern: pattern) {
+            let range = NSRange(location: 0, length: self.utf16.count)
+            return regex.firstMatch(in: self, options: [], range: range) != nil
+        }
+        return false
+    }
+
+    func trim() -> String {
+        self.trimmingCharacters(in: CharacterSet.whitespacesAndNewlines)
+    }
+}

WakaTime/Helpers/Dependencies.swift

@@ -71,6 +71,12 @@ class Dependencies {
         }
         let outputData = outputPipe.fileHandleForReading.readDataToEndOfFile()
         let output = String(decoding: outputData, as: UTF8.self)
+
+        // disable updating wakatime-cli when it was built from source
+        if output.trim() == "<local-build>" {
+            return true
+        }
+
         let version: String?
         if let regex = try? NSRegularExpression(pattern: "([0-9]+\\.[0-9]+\\.[0-9]+)"),
            let match = regex.firstMatch(in: output, range: NSRange(output.startIndex..., in: output)),

WakaTime/Helpers/FilterManager.swift

@@ -0,0 +1,46 @@
+import Cocoa
+
+class FilterManager {
+    static func filterBrowsedSites(app: NSRunningApplication, monitoredApp: MonitoredApp, activeWindow: AXUIElement) -> Bool {
+        guard MonitoringManager.isAppBrowser(app) else { return true }
+
+        if let address = activeWindow.address(for: monitoredApp) {
+            let patterns = Self.parseList(PropertiesManager.currentFilterList)
+            if patterns.isEmpty { return true }
+
+            // Create scheme-prefixed address versions to allow regular expressions
+            // that incorporate a scheme to match
+            let httpAddress = "http://" + address
+            let httpsAddress = "https://" + address
+
+            switch PropertiesManager.filterType {
+                case .denylist:
+                    for pattern in patterns {
+                        if address.matchesRegex(pattern) || httpAddress.matchesRegex(pattern) || httpsAddress.matchesRegex(pattern) {
+                            // Address matches a pattern on the denylist. Filter the site out.
+                            return false
+                        }
+                    }
+                case .allowlist:
+                    let addressMatchesAllowlist = patterns.contains { pattern in
+                        address.matchesRegex(pattern) || httpAddress.matchesRegex(pattern) || httpsAddress.matchesRegex(pattern)
+                    }
+                    // If none of the patterns on the allowlist match the given address, filter the site out
+                    if !addressMatchesAllowlist {
+                        return false
+                    }
+            }
+        }
+
+        // The given address passed all filters and will be included
+        return true
+    }
+
+    private static func parseList(_ listString: String) -> [String] {
+        Self.sanitizeList(listString.components(separatedBy: "\n"))
+    }
+
+    private static func sanitizeList(_ urls: [String]) -> [String] {
+        urls.map { $0.trimmingCharacters(in: CharacterSet.whitespaces) }
+    }
+}

WakaTime/Helpers/MonitoringManager.swift

@@ -51,6 +51,16 @@ class MonitoringManager {
         return bundleId == MonitoredApp.xcode.rawValue
     }
 
+    static func isAppBrowser(for bundleId: String) -> Bool {
+        MonitoredApp.browserAppIds.contains(bundleId)
+    }
+
+    static func isAppBrowser(_ app: NSRunningApplication) -> Bool {
+        guard let bundleId = app.bundleIdentifier else { return false }
+
+        return isAppBrowser(for: bundleId)
+    }
+
     static func heartbeatData(_ app: NSRunningApplication) -> HeartbeatData? {
         let pid = app.processIdentifier
 
@@ -60,6 +70,15 @@ class MonitoringManager {
             let title = activeWindow.title(for: monitoredApp)
         else { return nil }
 
+        // For browser apps, filter out deny/allowlisted sites and use the predefined project
+        // from the allowlist if applicable.
+        let included = FilterManager.filterBrowsedSites(
+            app: app,
+            monitoredApp: monitoredApp,
+            activeWindow: activeWindow
+        )
+        guard included else { return nil }
+
         let project = activeWindow.project(for: monitoredApp)
 
         switch monitoredApp {
@@ -103,6 +122,7 @@ class MonitoringManager {
             case .linear:
                 return HeartbeatData(
                     entity: title,
+                    project: project,
                     category: .planning)
             case .notes:
                 if activeWindow.rawTitle == "Notes" {

WakaTime/Helpers/PropertiesManager.swift

@@ -1,11 +1,19 @@
 import Foundation
 
 class PropertiesManager {
+    enum FilterType: String {
+        case denylist
+        case allowlist
+    }
+
     enum Keys: String {
         case shouldLaunchOnLogin = "launch_on_login"
         case shouldLogToFile = "log_to_file"
         case shouldAutomaticallyDownloadUpdates = "should_automatically_download_updates"
         case hasLaunchedBefore = "has_launched_before"
+        case filterType = "filter_type"
+        case denylist = "denylist"
+        case allowlist = "allowlist"
     }
 
     static var shouldLaunchOnLogin: Bool {
@@ -71,4 +79,61 @@ class PropertiesManager {
             UserDefaults.standard.synchronize()
         }
     }
+
+    static var filterType: FilterType {
+        get {
+            guard let filterTypeString = UserDefaults.standard.string(forKey: Keys.filterType.rawValue) else {
+                return .allowlist
+            }
+
+            return FilterType(rawValue: filterTypeString) ?? .denylist
+        }
+        set {
+            UserDefaults.standard.set(newValue.rawValue, forKey: Keys.filterType.rawValue)
+            UserDefaults.standard.synchronize()
+        }
+    }
+
+    static var denylist: String {
+        get {
+            guard let denylist = UserDefaults.standard.string(forKey: Keys.denylist.rawValue) else {
+                return ""
+            }
+
+            return denylist
+        }
+        set {
+            UserDefaults.standard.set(newValue, forKey: Keys.denylist.rawValue)
+            UserDefaults.standard.synchronize()
+        }
+    }
+
+    static var allowlist: String {
+        get {
+            guard let allowlist = UserDefaults.standard.string(forKey: Keys.allowlist.rawValue) else {
+                return
+                    "https?://(\\w\\.)*github\\.com/\n" +
+                    "https?://(\\w\\.)*gitlab\\.com/\n" +
+                    "^stackoverflow\\.com/\n" +
+                    "^docs\\.python\\.org/\n" +
+                    "https?://(\\w\\.)*golang\\.org/\n" +
+                    "https?://(\\w\\.)*go\\.dev/\n" +
+                    "https?://(\\w\\.)*npmjs\\.com/\n" +
+                    "https?//localhost[:\\d+]?/"
+            }
+
+            return allowlist
+        }
+        set {
+            UserDefaults.standard.set(newValue, forKey: Keys.allowlist.rawValue)
+            UserDefaults.standard.synchronize()
+        }
+    }
+
+    static var currentFilterList: String {
+        switch Self.filterType {
+            case .denylist: return Self.denylist
+            case .allowlist: return Self.allowlist
+        }
+    }
 }