From e7ad5c923f1b63494eaa818e16c0deda49e376d6 Mon Sep 17 00:00:00 2001 From: Noah Masur <7386960+nmasur@users.noreply.github.com> Date: Tue, 12 Apr 2022 17:34:04 -0400 Subject: [PATCH] dismiss alerts keyboard shortcut --- .../close_notifications_applescript.js | 298 ++++++++++++++++++ .../Spoons/DismissAlerts.spoon/init.lua | 17 + hammerspoon.symlink/init.lua | 5 +- 3 files changed, 318 insertions(+), 2 deletions(-) create mode 100644 hammerspoon.symlink/Spoons/DismissAlerts.spoon/close_notifications_applescript.js create mode 100644 hammerspoon.symlink/Spoons/DismissAlerts.spoon/init.lua diff --git a/hammerspoon.symlink/Spoons/DismissAlerts.spoon/close_notifications_applescript.js b/hammerspoon.symlink/Spoons/DismissAlerts.spoon/close_notifications_applescript.js new file mode 100644 index 0000000..c6f6ea6 --- /dev/null +++ b/hammerspoon.symlink/Spoons/DismissAlerts.spoon/close_notifications_applescript.js @@ -0,0 +1,298 @@ +/* Credit: https://gist.github.com/lancethomps/a5ac103f334b171f70ce2ff983220b4f */ + +function run(input, parameters) { + + const appNames = []; + const skipAppNames = []; + const verbose = true; + + const scriptName = "close_notifications_applescript"; + + const CLEAR_ALL_ACTION = "Clear All"; + const CLEAR_ALL_ACTION_TOP = "Clear"; + const CLOSE_ACTION = "Close"; + + const notNull = (val) => { + return val !== null && val !== undefined; + }; + + const isNull = (val) => { + return !notNull(val); + }; + + const notNullOrEmpty = (val) => { + return notNull(val) && val.length > 0; + }; + + const isNullOrEmpty = (val) => { + return !notNullOrEmpty(val); + }; + + const isError = (maybeErr) => { + return notNull(maybeErr) && (maybeErr instanceof Error || maybeErr.message); + }; + + const systemVersion = () => { + return Application("Finder").version().split(".").map(val => parseInt(val)); + }; + + const systemVersionGreaterThanOrEqualTo = (vers) => { + return systemVersion()[0] >= vers; + }; + + const isBigSurOrGreater = () => { + return systemVersionGreaterThanOrEqualTo(11); + }; + + const V11_OR_GREATER = isBigSurOrGreater(); + const APP_NAME_MATCHER_ROLE = V11_OR_GREATER ? "AXStaticText" : "AXImage"; + const hasAppNames = notNullOrEmpty(appNames); + const hasSkipAppNames = notNullOrEmpty(skipAppNames); + const hasAppNameFilters = hasAppNames || hasSkipAppNames; + const appNameForLog = hasAppNames ? ` [${appNames.join(",")}]` : ""; + + const logs = []; + const log = (message, ...optionalParams) => { + let message_with_prefix = `${new Date().toISOString().replace("Z", "").replace("T", " ")} [${scriptName}]${appNameForLog} ${message}`; + console.log(message_with_prefix, optionalParams); + logs.push(message_with_prefix); + }; + + const logError = (message, ...optionalParams) => { + if (isError(message)) { + let err = message; + message = `${err}${err.stack ? (" " + err.stack) : ""}`; + } + log(`ERROR ${message}`, optionalParams); + }; + + const logErrorVerbose = (message, ...optionalParams) => { + if (verbose) { + logError(message, optionalParams); + } + }; + + const logVerbose = (message) => { + if (verbose) { + log(message); + } + }; + + const getLogLines = () => { + return logs.join("\n"); + }; + + const getSystemEvents = () => { + let systemEvents = Application("System Events"); + systemEvents.includeStandardAdditions = true; + return systemEvents; + }; + + const getNotificationCenter = () => { + try { + return getSystemEvents().processes.byName("NotificationCenter"); + } catch (err) { + logError("Could not get NotificationCenter"); + throw err; + } + }; + + const getNotificationCenterGroups = (retryOnError = false) => { + try { + let notificationCenter = getNotificationCenter(); + if (notificationCenter.windows.length <= 0) { + return []; + } + if (!V11_OR_GREATER) { + return notificationCenter.windows(); + } + return notificationCenter.windows[0].uiElements[0].uiElements[0].uiElements(); + } catch (err) { + logError("Could not get NotificationCenter groups"); + if (retryOnError) { + logError(err); + log("Retrying getNotificationCenterGroups..."); + return getNotificationCenterGroups(false); + } else { + throw err; + } + } + }; + + const isClearButton = (description, name) => { + return description === "button" && name === CLEAR_ALL_ACTION_TOP; + }; + + const matchesAnyAppNames = (value, checkValues) => { + if (isNullOrEmpty(checkValues)) { + return false; + } + let lowerAppName = value.toLowerCase(); + for (let checkValue of checkValues) { + if (lowerAppName === checkValue.toLowerCase()) { + return true; + } + } + return false; + }; + + const matchesAppName = (role, value) => { + if (role !== APP_NAME_MATCHER_ROLE) { + return false; + } + if (hasAppNames) { + return matchesAnyAppNames(value, appNames); + } + return !matchesAnyAppNames(value, skipAppNames); + }; + + const notificationGroupMatches = (group) => { + try { + let description = group.description(); + if (V11_OR_GREATER && isClearButton(description, group.name())) { + return true; + } + if (V11_OR_GREATER && description !== "group") { + return false; + } + if (!V11_OR_GREATER) { + let matchedAppName = !hasAppNameFilters; + if (!matchedAppName) { + for (let elem of group.uiElements()) { + if (matchesAppName(elem.role(), elem.description())) { + matchedAppName = true; + break; + } + } + } + if (matchedAppName) { + return notNull(findCloseActionV10(group, -1)); + } + return false; + } + if (!hasAppNameFilters) { + return true; + } + let firstElem = group.uiElements[0]; + return matchesAppName(firstElem.role(), firstElem.value()); + } catch (err) { + logErrorVerbose(`Caught error while checking window, window is probably closed: ${err}`); + logErrorVerbose(err); + } + return false; + }; + + const findCloseActionV10 = (group, closedCount) => { + try { + for (let elem of group.uiElements()) { + if (elem.role() === "AXButton" && elem.title() === CLOSE_ACTION) { + return elem.actions["AXPress"]; + } + } + } catch (err) { + logErrorVerbose(`(group_${closedCount}) Caught error while searching for close action, window is probably closed: ${err}`); + logErrorVerbose(err); + return null; + } + log("No close action found for notification"); + return null; + }; + + const findCloseAction = (group, closedCount) => { + try { + if (!V11_OR_GREATER) { + return findCloseActionV10(group, closedCount); + } + let checkForPress = isClearButton(group.description(), group.name()); + let clearAllAction; + let closeAction; + for (let action of group.actions()) { + let description = action.description(); + if (description === CLEAR_ALL_ACTION) { + clearAllAction = action; + break; + } else if (description === CLOSE_ACTION) { + closeAction = action; + } else if (checkForPress && description === "press") { + clearAllAction = action; + break; + } + } + if (notNull(clearAllAction)) { + return clearAllAction; + } else if (notNull(closeAction)) { + return closeAction; + } + } catch (err) { + logErrorVerbose(`(group_${closedCount}) Caught error while searching for close action, window is probably closed: ${err}`); + logErrorVerbose(err); + return null; + } + log("No close action found for notification"); + return null; + }; + + const closeNextGroup = (groups, closedCount) => { + try { + for (let group of groups) { + if (notificationGroupMatches(group)) { + let closeAction = findCloseAction(group, closedCount); + + if (notNull(closeAction)) { + try { + closeAction.perform(); + return [true, 1]; + } catch (err) { + logErrorVerbose(`(group_${closedCount}) Caught error while performing close action, window is probably closed: ${err}`); + logErrorVerbose(err); + } + } + return [true, 0]; + } + } + return false; + } catch (err) { + logError("Could not run closeNextGroup"); + throw err; + } + }; + + try { + let groupsCount = getNotificationCenterGroups(true).filter(group => notificationGroupMatches(group)).length; + + if (groupsCount > 0) { + logVerbose(`Closing ${groupsCount}${appNameForLog} notification group${(groupsCount > 1 ? "s" : "")}`); + + let startTime = new Date().getTime(); + let closedCount = 0; + let maybeMore = true; + let maxAttempts = 2; + let attempts = 1; + while (maybeMore && ((new Date().getTime() - startTime) <= (1000 * 30))) { + try { + let closeResult = closeNextGroup(getNotificationCenterGroups(), closedCount); + maybeMore = closeResult[0]; + if (maybeMore) { + closedCount = closedCount + closeResult[1]; + } + } catch (innerErr) { + if (maybeMore && closedCount === 0 && attempts < maxAttempts) { + log(`Caught an error before anything closed, trying ${maxAttempts - attempts} more time(s).`) + attempts++; + } else { + throw innerErr; + } + } + } + } else { + throw Error(`No${appNameForLog} notifications found...`); + } + } catch (err) { + logError(err); + logError(err.message); + getLogLines(); + throw err; + } + + return getLogLines(); +} diff --git a/hammerspoon.symlink/Spoons/DismissAlerts.spoon/init.lua b/hammerspoon.symlink/Spoons/DismissAlerts.spoon/init.lua new file mode 100644 index 0000000..f6a7aba --- /dev/null +++ b/hammerspoon.symlink/Spoons/DismissAlerts.spoon/init.lua @@ -0,0 +1,17 @@ +--- === Dismiss Alerts === + +local obj = {} +obj.__index = obj + +-- Metadata +obj.name = "DismissAlerts" +obj.version = "0.1" +obj.license = "MIT - https://opensource.org/licenses/MIT" + +function obj:init() + hs.hotkey.bind({ "cmd", "alt", "ctrl" }, "k", function() + hs.osascript.javascriptFromFile("Spoons/DismissAlerts.spoon/close_notifications_applescript.js") + end) +end + +return obj diff --git a/hammerspoon.symlink/init.lua b/hammerspoon.symlink/init.lua index 7306367..8e4dcfe 100644 --- a/hammerspoon.symlink/init.lua +++ b/hammerspoon.symlink/init.lua @@ -1,2 +1,3 @@ -hs.loadSpoon('ControlEscape'):start() -- Load Hammerspoon bits from https://github.com/jasonrudolph/ControlEscape.spoon -hs.loadSpoon('Launcher'):init() +hs.loadSpoon("ControlEscape"):start() -- Load Hammerspoon bits from https://github.com/jasonrudolph/ControlEscape.spoon +hs.loadSpoon("Launcher"):init() +hs.loadSpoon("DismissAlerts"):init()