Merge pull request #2101 from Gauravjeetsingh/voice-search

Request for mic access when using voice search

Author: Gauravjeetsingh

app.js

@@ -65,7 +65,17 @@ i18n.init({
 
 expressApp.use(express.static(path.join(__dirname, 'www', 'obs')));
 
-const { app, webContents, BrowserWindow, dialog, ipcMain, safeStorage, globalShortcut } = electron;
+const {
+  app,
+  webContents,
+  BrowserWindow,
+  dialog,
+  ipcMain,
+  safeStorage,
+  globalShortcut,
+  systemPreferences,
+  shell,
+} = electron;
 
 const store = new Store({
   configName: 'user-preferences',
@@ -172,6 +182,7 @@ function openSecondaryWindow(windowName) {
         webviewTag: true,
         nodeIntegrationInSubFrames: true,
         nodeIntegrationInWorker: true,
+        media: true,
       },
     });
     remote.enable(window.obj.webContents);
@@ -240,7 +251,7 @@ autoUpdater.on('update-downloaded', () => {
         cancelId: 0,
       })
       .then(({ response }) => {
-        if (response === 1) {
+        if (response === 1 || response === '1') {
           autoUpdater.quitAndInstall();
         }
         global.analytics.trackEvent({
@@ -361,6 +372,7 @@ function createViewer(ipcData) {
         webviewTag: true,
         nodeIntegrationInSubFrames: true,
         nodeIntegrationInWorker: true,
+        media: true,
       },
     });
     viewerWindow.loadURL(`file://${__dirname}/www/viewer.html`);
@@ -606,6 +618,7 @@ app.on('ready', () => {
       webviewTag: true,
       nodeIntegrationInSubFrames: true,
       nodeIntegrationInWorker: true,
+      media: true,
     },
   });
   const splash = new BrowserWindow({
@@ -884,6 +897,22 @@ ipcMain.on('set-user-setting', (event, settingChanger) => {
   mainWindow.webContents.send('set-user-setting', settingChanger);
 });
 
+ipcMain.on('get-media-access-status', async (event, mediaType) => {
+  try {
+    const isGranted = await systemPreferences.askForMediaAccess(mediaType);
+    if (!isGranted) {
+      if (mediaType === 'microphone') {
+        shell.openExternal(
+          'x-apple.systempreferences:com.apple.preference.security?Privacy_Microphone',
+        );
+      }
+    }
+    event.reply('media-access-status', isGranted ? 'granted' : 'denied');
+  } catch (error) {
+    event.reply('media-access-status', 'error');
+  }
+});
+
 module.exports = {
   openSecondaryWindow,
   appVersion,

entitlements.mac.inherit.plist

@@ -10,5 +10,9 @@
     <true/>
     <key>com.apple.security.cs.disable-library-validation</key>
     <true/>
+    <key>com.apple.security.device.microphone</key>
+    <true/>
+    <key>com.apple.security.device.audio-input</key>
+    <true/>
   </dict>
 </plist>

package.json

@@ -15,13 +15,13 @@
     "build": "npm run build-css & npm run build-js",
     "build:local": "npm run build-css & npm run build-js:sm",
     "pack:mac": "npm run build && electron-builder --mac --x64",
-    "pack:macArm": "npm run build && electron-builder --mac --arm64",
+    "pack:macArm": "npm run build && electron-builder -c packaging/electron-builder.macArm.yml --mac --arm64 --publish never",
     "pack:win": "npm run build && electron-builder --win --x64",
     "pack:win32": "npm run build && electron-builder --win --ia32",
     "pack:linux": "npm run build && electron-builder --linux --x64",
     "pack:berry": "export USE_SYSTEM_FPM=true && npm run build && electron-builder --linux --arm64",
     "dist:mac": "npm run build && electron-builder --mac --x64 --publish always",
-    "dist:macArm": "npm run build && electron-builder --mac --arm64 --publish always",
+    "dist:macArm": "npm run build && electron-builder -c packaging/electron-builder.macArm.yml --mac --arm64 --publish always",
     "dist:win": "npm run pack:win && electron-builder --win --x64 --publish always",
     "dist:win32": "npm run pack:win32 && electron-builder --win --ia32 --publish always",
     "build-css": "run-p build-css:*",
@@ -177,14 +177,29 @@
       "category": "public.app-category.reference",
       "icon": "assets/STTM.icns",
       "hardenedRuntime": true,
+      "artifactName": "SikhiToTheMax-${version}-${os}-${arch}.${ext}",
+      "extendInfo": {
+        "NSMicrophoneUsageDescription": "Please give us access to your microphone for voice search",
+        "NSCameraUsageDescription": "Please give us access to your camera",
+        "com.apple.security.device.audio-input": true,
+        "com.apple.security.device.camera": true
+      },
       "entitlements": "./entitlements.mac.inherit.plist",
+      "entitlementsInherit": "./entitlements.mac.inherit.plist",
       "target": [
         {
           "target": "dmg",
           "arch": [
             "x64",
             "arm64"
           ]
+        },
+        {
+          "target": "zip",
+          "arch": [
+            "x64",
+            "arm64"
+          ]
         }
       ],
       "notarize": {

packaging/electron-builder.macArm.yml

@@ -0,0 +1,22 @@
+publish:
+  provider: s3
+  bucket: sttm-releases
+  path: mac-${arch}
+  region: us-west-2
+
+mac:
+  category: "public.app-category.reference"
+  icon: "assets/STTM.icns"
+  hardenedRuntime: true
+  artifactName: "SikhiToTheMax-${version}-${os}-${arch}.${ext}"
+  entitlements: "./entitlements.mac.inherit.plist"
+  target:
+    - target: dmg
+      arch:
+        - arm64
+    - target: zip
+      arch:
+        - arm64
+  notarize:
+    teamId: "B3W82WVBU9"
+afterSign: "./notarize.js"

www/locales/en.json

@@ -196,6 +196,13 @@
     "TRANSLATION": "Translation",
     "TRANSLITERATION": "Transliteration"
   },
+  "MICROPHONE_ERROR": {
+    "NotAllowedError": "Microphone access was denied. Please check your system permissions and allow microphone access for this application.",
+    "NotFoundError": "No microphone found. Please connect a microphone and try again.",
+    "NotReadableError": "Microphone is being used by another application. Please close other applications using the microphone and try again.",
+    "OverconstrainedError": "Microphone constraints could not be satisfied. Please try again.",
+    "default": "Please check your microphone permissions and try again."
+  },
   "SEARCH": {
     "ANG": "Ang",
     "FIRST_LETTER_ANYWHERE": "First Letter (Anywhere)",

www/main/navigator/search/components/SearchContent.jsx

@@ -65,6 +65,7 @@ const SearchContent = () => {
   const [audioStream, setAudioStream] = useState(null);
   const [isTranscriptLoading, setIsTranscriptLoading] = useState(false);
   const [searchPending, setSearchPending] = useState(true);
+  const [microphonePermissionStatus, setMicrophonePermissionStatus] = useState('unknown');
 
   const sourcesObj = banidb.SOURCE_TEXTS;
   const writersObj = banidb.WRITER_TEXTS;
@@ -199,6 +200,17 @@ const SearchContent = () => {
     });
   }, []);
 
+  const checkMicrophonePermission = async () => {
+    try {
+      ipcRenderer.send('get-media-access-status', 'microphone');
+      const permission = await navigator.permissions.query({ name: 'microphone' });
+      return permission.state;
+    } catch (error) {
+      console.error('Error checking microphone permission:', error);
+      return 'unknown';
+    }
+  };
+
   useEffect(() => {
     const checkOnlineStatus = async () => {
       try {
@@ -210,8 +222,20 @@ const SearchContent = () => {
     };
 
     checkOnlineStatus();
+    checkMicrophonePermission();
   }, []);
 
+  const requestMicrophonePermission = () =>
+    new Promise((resolve) => {
+      const handlePermissionResponse = (event, status) => {
+        ipcRenderer.removeListener('media-access-status', handlePermissionResponse);
+        resolve(status);
+      };
+
+      ipcRenderer.on('media-access-status', handlePermissionResponse);
+      ipcRenderer.send('get-media-access-status', 'microphone');
+    });
+
   const handleMicClick = async () => {
     if (isRecording) {
       if (mediaRecorder && mediaRecorder.state !== 'inactive') {
@@ -226,7 +250,16 @@ const SearchContent = () => {
       });
     } else {
       try {
-        const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
+        const permissionStatus = await requestMicrophonePermission();
+        setMicrophonePermissionStatus(permissionStatus);
+
+        const stream = await navigator.mediaDevices.getUserMedia({
+          audio: {
+            echoCancellation: true,
+            noiseSuppression: true,
+            autoGainControl: true,
+          },
+        });
         const recorder = new MediaRecorder(stream);
         const chunks = [];
 
@@ -314,15 +347,18 @@ const SearchContent = () => {
           label: 'start-recording',
         });
       } catch (error) {
-        console.error('Error accessing microphone:', error);
+        const errorMessage =
+          i18n.t(`MICROPHONE_ERROR.${error.name}`) || i18n.t('MICROPHONE_ERROR.default');
+
         analytics.trackEvent({
           category: 'search',
           action: 'voice-search',
-          label: 'microphone-error',
+          label: error.name,
           value: error.message,
         });
 
-        alert('Unable to access microphone. Please check permissions and try again.');
+        // eslint-disable-next-line no-alert
+        alert(errorMessage);
       }
     }
   };
@@ -373,6 +409,10 @@ const SearchContent = () => {
             <IconButton
               icon={isRecording ? 'fa fa-stop' : 'fa fa-microphone'}
               onClick={handleMicClick}
+              style={{
+                opacity: microphonePermissionStatus === 'denied' ? 0.5 : 1,
+                cursor: microphonePermissionStatus === 'denied' ? 'not-allowed' : 'pointer',
+              }}
             />
           )}
           {currentLanguage !== 'en' && (