Added open file location functionality

uxiew · Feb 17, 2019 · 4e12db0 · 4e12db0
1 parent 9cfa68e
commit 4e12db0
Show file tree

Hide file tree

Showing 19 changed files with 196 additions and 69 deletions.
diff --git a/src/common/helpers/string-helpers.ts b/src/common/helpers/string-helpers.ts
@@ -10,4 +10,8 @@ export class StringHelpers {
 
         return value.charAt(0).toUpperCase() + value.slice(1);
     }
+
+    public static replaceWhitespace(original: string, replaceWith: string): string {
+        return original.replace(/\s/g, replaceWith);
+    }
 }
diff --git a/src/common/ipc-channels.ts b/src/common/ipc-channels.ts
@@ -2,6 +2,7 @@ export enum IpcChannels {
     search = "search",
     searchResponse = "search-response",
     execute = "execute",
+    openSearchResultLocation = "open-search-result-location",
     mainWindowHasBeenHidden = "main-window-has-been-hidden",
     mainWindowHasBeenShown = "main-window-has-been-shown",
     userInputHasBeenResetAndMainWindowCanBeHidden = "user-input-has-been-reset-and-main-window-can-be-hidden",

diff --git a/src/main/executors/file-path-executor.ts b/src/main/executors/file-path-executor.ts
@@ -1,36 +1,27 @@
-import { FileHelpers } from "../helpers/file-helpers";
 import { exec } from "child_process";
 import osascript = require("node-osascript");
 
 export function executeFilePathWindows(filePath: string, privileged: boolean): Promise<void> {
     return privileged
         ? executeFilePathWindowsAsPrivileged(filePath)
-        : executeFilePath(`start explorer "${filePath}"`, filePath);
+        : executeFilePath(`start explorer "${filePath}"`);
 }
 
 export function executeFilePathMacOs(filePath: string, privileged: boolean): Promise<void> {
     return privileged
         ? executeFilePathMacOsAsPrivileged(filePath)
-        : executeFilePath(`open "${filePath}"`, filePath);
+        : executeFilePath(`open "${filePath}"`);
 }
 
-function executeFilePath(command: string, filePath: string): Promise<void> {
+function executeFilePath(command: string): Promise<void> {
     return new Promise((resolve, reject) => {
-        FileHelpers.fileExists(filePath)
-            .then((exists) => {
-                if (exists) {
-                    exec(command, (err) => {
-                        if (err) {
-                            reject(`Error while opening file: ${err}`);
-                        } else {
-                            resolve();
-                        }
-                    });
-                } else {
-                    reject(`Error while executing file: File "${filePath}" does not exist.`);
-                }
-            })
-            .catch((err) => reject(err));
+        exec(command, (err) => {
+            if (err) {
+                reject(`Error while opening file: ${err}`);
+            } else {
+                resolve();
+            }
+        });
     });
 }
 

diff --git a/src/main/executors/file-path-location-executor.ts b/src/main/executors/file-path-location-executor.ts
@@ -0,0 +1,21 @@
+import { exec } from "child_process";
+
+export function executeFilePathLocationWindows(filePath: string): Promise<void> {
+    return executeFilePathLocation(`start explorer.exe /select,"${filePath}"`);
+}
+
+export function executeFilePathLocationMacOs(filePath: string): Promise<void> {
+    return executeFilePathLocation(`open -R "${filePath}"`);
+}
+
+function executeFilePathLocation(command: string): Promise<void> {
+    return new Promise((resolve, reject) => {
+        exec(command, (err) => {
+            if (err) {
+                reject(err);
+            } else {
+                resolve();
+            }
+        });
+    });
+}
diff --git a/src/main/main.ts b/src/main/main.ts
@@ -291,6 +291,12 @@ function registerAllIpcListeners() {
             .catch((err) => logger.error(err));
     });
 
+    ipcMain.on(IpcChannels.openSearchResultLocation, (event: Electron.Event, searchResultItem: SearchResultItem) => {
+        searchEngine.openLocation(searchResultItem)
+            .then(() => hideMainWindow())
+            .catch((err) => logger.error(err));
+    });
+
     ipcMain.on(IpcChannels.reloadApp, () => {
         reloadApp();
     });

diff --git a/src/main/plugins/application-search-plugin/application-icon-helpers.ts b/src/main/plugins/application-search-plugin/application-icon-helpers.ts
@@ -5,13 +5,15 @@ import { convert } from "app2png";
 import { FileHelpers } from "../../helpers/file-helpers";
 import { exec } from "child_process";
 import { ueliTempFolder } from "../../../common/helpers/ueli-helpers";
+import { StringHelpers } from "../../../common/helpers/string-helpers";
 
 export const applicationIconLocation = join(ueliTempFolder, "application-icons");
 export const powershellScriptFilePath = join(ueliTempFolder, "generate-icons.ps1");
 
 export function getApplicationIconFilePath(application: Application): string {
-    const fileHashName = createHash("md5").update(`${application.filePath}`).digest("hex");
-    return `${join(applicationIconLocation, fileHashName)}.png`;
+    const hash = createHash("md5").update(`${application.filePath}`).digest("hex");
+    const fileName = `${StringHelpers.replaceWhitespace(application.name.toLowerCase(), "-")}-${hash}`;
+    return `${join(applicationIconLocation, fileName)}.png`;
 }
 
 export function generateMacAppIcons(applications: Application[]): Promise<void> {
@@ -52,27 +54,11 @@ export function generateWindowsAppIcons(applications: Application[]): Promise<vo
 
                 let powershellScript = `
                     Add-Type -AssemblyName System.Drawing;
-
                     function generateIcon($filePath, $outputFilePath) {
                         $fileExists = Test-Path -Path $filePath;
-
                         if ($fileExists) {
-                            $fileIsShortcut = $filePath.endsWith(".lnk");
-
-                            if ($fileIsShortcut) {
-                                try {
-                                    $sh = New-Object -ComObject WScript.Shell;
-                                    $filePath = $sh.CreateShortcut($filePath).TargetPath;
-                                }
-                                catch { <# continue #>}
-                            }
-
-                            $fileExists = Test-Path -Path $filePath;
-
-                            if ($fileExists) {
-                                $icon = [System.Drawing.Icon]::ExtractAssociatedIcon($filePath);
-                                $icon.ToBitmap().save($outputFilePath, [System.Drawing.Imaging.ImageFormat]::Png);
-                            }
+                            $icon = [System.Drawing.Icon]::ExtractAssociatedIcon($filePath);
+                            $icon.ToBitmap().save($outputFilePath, [System.Drawing.Imaging.ImageFormat]::Png);
                         }
                     }
                 `;
@@ -97,7 +83,7 @@ export function generateWindowsAppIcons(applications: Application[]): Promise<vo
 
 function executePowershellScript(filePath: string): Promise<void> {
     return new Promise((resolve, reject) => {
-        exec(`powershell -File ${filePath}`, (err) => {
+        exec(`powershell -File ${filePath}`, (err, stdout) => {
             if (err) {
                 reject(err);
             } else {

diff --git a/src/main/plugins/application-search-plugin/application-search-plugin.ts b/src/main/plugins/application-search-plugin/application-search-plugin.ts
@@ -10,16 +10,20 @@ import { IconType } from "../../../common/icon/icon-type";
 
 export class ApplicationSearchPlugin implements SearchPlugin {
     public readonly pluginType = PluginType.ApplicationSearchPlugin;
+    public readonly openLocationSupported = true;
     private config: ApplicationSearchOptions;
     private readonly applicationRepository: ApplicationRepository;
     private readonly executeApplication: (executionArgument: string, privileged?: boolean) => Promise<void>;
+    private readonly openApplicationLocation: (filePath: string) => Promise<void>;
 
     constructor(config: ApplicationSearchOptions,
                 applicationRepository: ApplicationRepository,
-                executeApplication: (executionArgument: string, privileged: boolean) => Promise<void>) {
+                executeApplication: (executionArgument: string, privileged: boolean) => Promise<void>,
+                openApplicationLocation: (filePath: string) => Promise<void>) {
         this.config = config;
         this.applicationRepository = applicationRepository;
         this.executeApplication = executeApplication;
+        this.openApplicationLocation = openApplicationLocation;
     }
 
     public getAll(): Promise<SearchResultItem[]> {
@@ -47,6 +51,14 @@ export class ApplicationSearchPlugin implements SearchPlugin {
         });
     }
 
+    public openLocation(searchResultItem: SearchResultItem): Promise<void> {
+        return new Promise((resolve, reject) => {
+            this.openApplicationLocation(searchResultItem.executionArgument)
+                .then(() => resolve())
+                .catch((err) => reject(err));
+        });
+    }
+
     public refreshIndex(): Promise<void> {
         return new Promise((resolve, reject) => {
             if (!this.isEnabled()) {

diff --git a/src/main/plugins/everything-execution-plugin/everthing-execution-plugin.ts b/src/main/plugins/everything-execution-plugin/everthing-execution-plugin.ts
@@ -8,8 +8,10 @@ import { EverythingSearcher } from "./everything-searcher";
 
 export class EverythingExecutionPlugin implements ExecutionPlugin {
     public pluginType: PluginType = PluginType.EverythingSearchPlugin;
+    public readonly openLocationSupported = true;
     private config: UserConfigOptions;
     private readonly filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>;
+    private readonly filePathLocationExecutor: (filePath: string) => Promise<void>;
     private readonly defaultIcon: Icon = {
         parameter: `<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 32 32" version="1.1">
         <g id="surface1">
@@ -19,9 +21,14 @@ export class EverythingExecutionPlugin implements ExecutionPlugin {
         type: IconType.SVG,
     };
 
-    constructor(config: UserConfigOptions, filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>) {
+    constructor(
+        config: UserConfigOptions,
+        filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>,
+        filePathLocationExecutor: (filePath: string) => Promise<void>,
+        ) {
         this.config = config;
         this.filePathExecutor = filePathExecutor;
+        this.filePathLocationExecutor = filePathLocationExecutor;
     }
 
     public isEnabled(): boolean {
@@ -49,6 +56,14 @@ export class EverythingExecutionPlugin implements ExecutionPlugin {
         });
     }
 
+    public openLocation(searchResultItem: SearchResultItem): Promise<void> {
+        return new Promise((resolve, reject) => {
+            this.filePathLocationExecutor(searchResultItem.executionArgument)
+                .then(() => resolve())
+                .catch((err) => reject(err));
+        });
+    }
+
     public updateConfig(updatedUserConfig: UserConfigOptions): Promise<void> {
         return new Promise((resolve, reject) => {
             this.config = updatedUserConfig;

diff --git a/src/main/plugins/mdfind-execution-plugin/mdfind-execution-plugin.ts b/src/main/plugins/mdfind-execution-plugin/mdfind-execution-plugin.ts
@@ -8,9 +8,11 @@ import { MdFindSearcher } from "./mdfind-searcher";
 import { defaultErrorIcon } from "../../../common/icon/default-error-icon";
 
 export class MdFindExecutionPlugin implements ExecutionPlugin {
-    public pluginType = PluginType.MdFindExecutionPlugin;
+    public readonly pluginType = PluginType.MdFindExecutionPlugin;
+    public readonly openLocationSupported = true;
     private config: UserConfigOptions;
     private readonly filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>;
+    private readonly filePathLocationExecutor: (filePath: string) => Promise<void>;
     private searchDelay: NodeJS.Timeout | number;
     private readonly defaultIcon: Icon = {
         parameter: `<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 40 40" style="enable-background:new 0 0 40 40;" xml:space="preserve">
@@ -29,9 +31,14 @@ export class MdFindExecutionPlugin implements ExecutionPlugin {
         type: IconType.SVG,
     };
 
-    constructor(config: UserConfigOptions, filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>) {
+    constructor(
+        config: UserConfigOptions,
+        filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>,
+        filePathLocationExecutor: (filePath: string) => Promise<void>,
+        ) {
         this.config = config;
         this.filePathExecutor = filePathExecutor;
+        this.filePathLocationExecutor = filePathLocationExecutor;
     }
 
     public isValidUserInput(userInput: string): boolean {
@@ -72,6 +79,14 @@ export class MdFindExecutionPlugin implements ExecutionPlugin {
         });
     }
 
+    public openLocation(searchResultItem: SearchResultItem): Promise<void> {
+        return new Promise((resolve, reject) => {
+            this.filePathLocationExecutor(searchResultItem.executionArgument)
+                .then(() => resolve())
+                .catch((err) => reject(err));
+        });
+    }
+
     public updateConfig(updatedConfig: UserConfigOptions): Promise<void> {
         return new Promise((resolve) => {
             this.config = updatedConfig;

diff --git a/src/main/plugins/shorcuts-search-plugin/shortcuts-search-plugin.ts b/src/main/plugins/shorcuts-search-plugin/shortcuts-search-plugin.ts
@@ -15,18 +15,22 @@ interface ExecutionArgumentDecodeResult {
 
 export class ShortcutsSearchPlugin implements SearchPlugin {
     public readonly pluginType = PluginType.ShortcutsSearchPlugin;
+    public readonly openLocationSupported = true;
     private config: ShortcutOptions;
     private readonly urlExecutor: (url: string) => Promise<void>;
     private readonly filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>;
+    private readonly filePathLocationExecutor: (filePath: string) => Promise<void>;
 
     constructor(
         config: ShortcutOptions,
         urlExecutor: (url: string) => Promise<void>,
         filePathExecutor: (filePath: string, privileged: boolean) => Promise<void>,
+        filePathLocationExecutor: (filePath: string) => Promise<void>,
         ) {
         this.config = config;
         this.urlExecutor = urlExecutor;
         this.filePathExecutor = filePathExecutor;
+        this.filePathLocationExecutor = filePathLocationExecutor;
     }
 
     public getAll(): Promise<SearchResultItem[]> {
@@ -67,6 +71,19 @@ export class ShortcutsSearchPlugin implements SearchPlugin {
         }
     }
 
+    public openLocation(searchResultItem: SearchResultItem): Promise<void> {
+        return new Promise((resolve, reject) => {
+            const decodeResult = this.decodeExecutionArgument(searchResultItem.executionArgument);
+            if (decodeResult.shortcutType === ShortcutType.FilePath) {
+                this.filePathLocationExecutor(decodeResult.executionArgument)
+                    .then(() => resolve())
+                    .catch((err) => reject(err));
+            } else {
+                reject(`Error while trying to open file location. "${decodeResult.executionArgument}" is not a valid file path`);
+            }
+        });
+    }
+
     public isEnabled(): boolean {
         return this.config.isEnabled;
     }

diff --git a/src/main/plugins/translation-execution-plugin/translation-execution-plugin.ts b/src/main/plugins/translation-execution-plugin/translation-execution-plugin.ts
@@ -11,6 +11,7 @@ import { LingueeTranslator } from "./linguee-translator";
 
 export class TranslationExecutionPlugin implements ExecutionPlugin {
     public readonly pluginType = PluginType.TranslationPlugin;
+    public readonly openLocationSupported = false;
     private config: UserConfigOptions;
     private delay: NodeJS.Timeout | number;
     private readonly icon: Icon = {
@@ -33,6 +34,10 @@ export class TranslationExecutionPlugin implements ExecutionPlugin {
         });
     }
 
+    public openLocation(searchResultItem: SearchResultItem): Promise<void> {
+        throw new Error("Opening location is not supported on this plugin");
+    }
+
     public getSearchResults(userInput: string): Promise<SearchResultItem[]> {
         return new Promise((resolve, reject) => {
             const textToTranslate = userInput.replace(this.config.translationOptions.prefix, "");

diff --git a/src/main/plugins/ueli-command-search-plugin/ueli-command-search-plugin.ts b/src/main/plugins/ueli-command-search-plugin/ueli-command-search-plugin.ts
@@ -11,7 +11,8 @@ import { TranslationManager } from "../../../common/translation/translation-mana
 import { TranslationKey } from "../../../common/translation/translation-key";
 
 export class UeliCommandSearchPlugin implements SearchPlugin {
-    public pluginType = PluginType.UeliCommandSearchPlugin;
+    public readonly pluginType = PluginType.UeliCommandSearchPlugin;
+    public readonly openLocationSupported = false;
     private readonly translationManager: TranslationManager;
     private readonly icon = `
     <svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
@@ -45,11 +46,15 @@ export class UeliCommandSearchPlugin implements SearchPlugin {
                 ipcMain.emit(IpcChannels.ueliCommandExecuted, ueliCommand);
                 resolve();
             } else {
-                reject("Invalid ueli command");
+                reject("Error while trying to execute ueli command: Invalid ueli command");
             }
         });
     }
 
+    public openLocation(searchResultItem: SearchResultItem): Promise<void> {
+        throw new Error("Opening location is not supported on this plugin");
+    }
+
     public refreshIndex(): Promise<void> {
         return new Promise((resolve) => {
             resolve();