Feature/141/permission handling (#143)

* (#141) Switch to more fine-grained permission checks on macOS via node-mac-permissions

* (#141) Refined output in failed permission check setup

* (#141) Moved node-mac-permissions back to dependencies array

* (#141) Revert last commit

Author: s1hofmann

index.js

@@ -1,45 +1,50 @@
-const libnut = require("bindings")("libnut");
+let libnut;
+if (process.platform === 'darwin') {
+    libnut = require("./permissionCheck");
+} else {
+    libnut = require("bindings")("libnut");
+}
 
 module.exports = libnut;
 
 module.exports.screen = {};
 
 function bitmap(width, height, byteWidth, bitsPerPixel, bytesPerPixel, image) {
-  this.width = width;
-  this.height = height;
-  this.byteWidth = byteWidth;
-  this.bitsPerPixel = bitsPerPixel;
-  this.bytesPerPixel = bytesPerPixel;
-  this.image = image;
+    this.width = width;
+    this.height = height;
+    this.byteWidth = byteWidth;
+    this.bitsPerPixel = bitsPerPixel;
+    this.bytesPerPixel = bytesPerPixel;
+    this.image = image;
 }
 
-module.exports.screen.highlight = function(x, y, width, height, duration, opacity) {
-  let highlightOpacity = (opacity < 0) ? 0 : opacity;
-  highlightOpacity = (highlightOpacity > 1) ? 1 : highlightOpacity;
-  const highlightDuration = (duration < 0) ? 0 : duration;
+module.exports.screen.highlight = function (x, y, width, height, duration, opacity) {
+    let highlightOpacity = (opacity < 0) ? 0 : opacity;
+    highlightOpacity = (highlightOpacity > 1) ? 1 : highlightOpacity;
+    const highlightDuration = (duration < 0) ? 0 : duration;
 
-  libnut.highlight(x, y, width, height, highlightDuration, highlightOpacity);
+    libnut.highlight(x, y, width, height, highlightDuration, highlightOpacity);
 }
 
-module.exports.screen.capture = function(x, y, width, height) {
-  //If coords have been passed, use them.
-  if (
-    typeof x !== "undefined" &&
-    typeof y !== "undefined" &&
-    typeof width !== "undefined" &&
-    typeof height !== "undefined"
-  ) {
-    b = libnut.captureScreen(x, y, width, height);
-  } else {
-    b = libnut.captureScreen();
-  }
+module.exports.screen.capture = function (x, y, width, height) {
+    //If coords have been passed, use them.
+    if (
+        typeof x !== "undefined" &&
+        typeof y !== "undefined" &&
+        typeof width !== "undefined" &&
+        typeof height !== "undefined"
+    ) {
+        b = libnut.captureScreen(x, y, width, height);
+    } else {
+        b = libnut.captureScreen();
+    }
 
-  return new bitmap(
-    b.width,
-    b.height,
-    b.byteWidth,
-    b.bitsPerPixel,
-    b.bytesPerPixel,
-    b.image
-  );
+    return new bitmap(
+        b.width,
+        b.height,
+        b.byteWidth,
+        b.bitsPerPixel,
+        b.bytesPerPixel,
+        b.image
+    );
 };

package-lock.json

@@ -37,7 +37,10 @@
   "dependencies": {
     "bindings": "1.5.0",
     "cmake-js": "6.1.0",
-    "node-addon-api": "3.2.1"
+    "node-addon-api": "5.0.0"
+  },
+  "optionalDependencies": {
+    "node-mac-permissions": "2.2.1"
   },
   "engines": {
     "node": ">=10.15.3"

package.json

@@ -0,0 +1,73 @@
+const libnut = require("bindings")("libnut");
+
+try {
+    const permissions = require("node-mac-permissions");
+
+    const wrapWithWarning = (message, nativeFunction) => (...args) => {
+        console.warn(message);
+        return nativeFunction(...args);
+    };
+
+    const askForAccessibility = (nativeFunction, functionName) => {
+        if (process.platform !== 'darwin') {
+            return nativeFunction;
+        }
+        const accessibilityStatus = permissions.getAuthStatus("accessibility");
+
+        if (accessibilityStatus === 'authorized') {
+            return nativeFunction;
+        } else if (accessibilityStatus === 'not determined' || accessibilityStatus === 'denied') {
+            permissions.askForAccessibilityAccess();
+            return wrapWithWarning(`##### WARNING! The application running this script tries to access accessibility features to execute ${functionName}! Please grant requested access and visit https://github.com/nut-tree/nut.js#macos for further information. #####`, nativeFunction);
+        }
+    }
+    const askForScreenRecording = (nativeFunction, functionName) => {
+        if (process.platform !== 'darwin') {
+            return nativeFunction;
+        }
+        const screenCaptureStatus = permissions.getAuthStatus("screen");
+
+        if (screenCaptureStatus === 'authorized') {
+            return nativeFunction;
+        } else if (screenCaptureStatus === 'not determined' || screenCaptureStatus === 'denied') {
+            permissions.askForScreenCaptureAccess();
+            return wrapWithWarning(`##### WARNING! The application running this script tries to access accessibility features to execute ${functionName}! Please grant the requested access and visit https://github.com/nut-tree/nut.js#macos for further information. #####`, nativeFunction);
+        }
+    }
+
+    const accessibilityAccess = [
+        "dragMouse",
+        "moveMouse",
+        "getMousePos",
+        "mouseClick",
+        "mouseToggle",
+        "scrollMouse",
+        "setMouseDelay",
+        "keyTap",
+        "keyToggle",
+        "typeString",
+        "setKeyboardDelay",
+        "getScreenSize",
+        "highlight",
+        "captureScreen",
+        "getWindows",
+        "getActiveWindow",
+        "getWindowRect",
+        "getWindowTitle",
+    ];
+    const screenCaptureAccess = [
+        "getWindowTitle",
+    ];
+
+    for (const functionName of accessibilityAccess) {
+        libnut[functionName] = askForAccessibility(libnut[functionName], functionName);
+    }
+    for (const functionName of screenCaptureAccess) {
+        libnut[functionName] = askForScreenRecording(libnut[functionName], functionName);
+    }
+} catch (e) {
+    console.warn(`Encountered error establishing macOS permission checks:`, e.message);
+    console.warn(`Returning original module.`);
+} finally {
+    module.exports = libnut;
+}

permissionCheck.js

@@ -8,7 +8,6 @@
 #include "screen.h"
 #include "screengrab.h"
 #include "window_manager.h"
-#include "startup.h"
 
 int mouseDelay = 10;
 int keyboardDelay = 10;