Merge pull request #34 from NomarCub/remove-link-support

NomarCub · web-flow · commit 527e047ffe8b · 2024-02-24T15:34:26.000+01:00
Remove link support
diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc
@@ -0,0 +1,5 @@
+{
+    "blanks-around-lists": false,
+    "line-length": false,
+    "no-inline-html": false
+}
diff --git a/README.md b/README.md
@@ -1,56 +1,47 @@
-# Copy Image and URL context menu
-
-This plugin context the following context menus
-- for images
-  - Copy Image
-  - Open image in default app
-  - Show in system explorer
-  - Reveal file in navigation
-- Copy URL
-- Open PDF externally
-
-in reading view in [Obsidian](https://obsidian.md/).
-
-This makes copying URLs in reading view like it is in editing view by deafult.
-
-See these other plugins for related functionality:
-- [Ozan's Image in Editor Plugin](https://github.com/ozntel/oz-image-in-editor-obsidian)
-- [Image Toolkit](https://github.com/sissilab/obsidian-image-toolkit)
-
-Copying images:
-
-[Copying images video](https://user-images.githubusercontent.com/1992842/132140547-fead74c1-4bec-489a-945c-f28cbba43493.mp4)
-
-Copying URLs:
-
-![Copying URLs on desktop](https://user-images.githubusercontent.com/5298006/125515738-8fb2143d-6502-46d3-a1b8-57b025211c2f.gif)
-
-Opening PDFs externally:
-
-![Opening PDFs externally on desktop](https://user-images.githubusercontent.com/5298006/171170626-5a94f5dc-61fc-4661-a9f2-38a0fb0181f5.gif)
-
-All features work on mobile, but were only tested on Android. Mobile uses the native image sharing functionality instead of the clipboard, and it downloads online images temporarily so they can be shared.
-
-![Copying URLs on Android](https://user-images.githubusercontent.com/5298006/125515758-bdf77074-a58c-4a6d-affa-88d031991ab2.gif)
-
-## Installation
-
-You can install the plugin via the Community Plugins tab within the Obsidian app.  
-[Here](https://obsidian.md/plugins?id=copy-url-in-preview)'s the plugin in Obsidian's Community Plugins website.  
-You can install the plugin manually by copying a release to your `.obsidian/plugins/copy-url-in-preview` folder.
-
-## Development
-
-This plugin follows the structure of the [Obsidian Sample Plugin](https://github.com/obsidianmd/obsidian-sample-plugin), see further details there.  
-Contributions are welcome.
-
-## Credits
-
-Original plugin by [NomarCub](https://github.com/NomarCub).  
-If you like this plugin you can sponsor me here on GitHub: [![Sponsor NomarCub](https://img.shields.io/static/v1?label=Sponsor%20NomarCub&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/NomarCub), on Ko-fi here: <a href='https://ko-fi.com/nomarcub' target='_blank'><img height='35' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' alt='Buy Me a Coffee at ko-fi.com' /></a>, or on PayPal here: [![Paypal](https://img.shields.io/badge/paypal-nomarcub-yellow?style=social&logo=paypal)](https://paypal.me/nomarcub).
-
-[Copying](https://github.com/NomarCub/obsidian-copy-url-in-preview/pull/2) [images](https://github.com/NomarCub/obsidian-copy-url-in-preview/pull/3) developed by [luckman212](https://github.com/luckman212).  
-[Android image sharing](https://github.com/NomarCub/obsidian-copy-url-in-preview/issues/5) developed by [mnaoumov](https://github.com/mnaoumov).  
-[Open PDF externally](https://github.com/NomarCub/obsidian-copy-url-in-preview/issues/9) feature developed by [mnaoumov](https://github.com/mnaoumov).
-
-Thank you to the makers of the [Tag Wrangler plugin](https://github.com/pjeby/tag-wrangler), as it was a great starting point for working with context menus in Obsidian.
+# Image Context Menus
+
+This plugin provides the following context menus for images in [Obsidian](https://obsidian.md/):
+- Copy Image
+- Open image in default app
+- Show in system explorer
+- Reveal file in navigation
+
+It also has an `Open PDF externally` context menu for PDFs.
+
+> This plugin used to be called "Copy Image and URL context menu". It had link URL copying functionality (see [1.5.2](https://github.com/NomarCub/obsidian-copy-url-in-preview/tree/1.5.2) and prior), but that was removed when it was included in Obsidian 1.5.
+
+See these other plugins for related functionality:
+- [Ozan's Image in Editor Plugin](https://github.com/ozntel/oz-image-in-editor-obsidian)
+- [Image Toolkit](https://github.com/sissilab/obsidian-image-toolkit)
+
+Copying images:
+
+[Copying images video](https://user-images.githubusercontent.com/1992842/132140547-fead74c1-4bec-489a-945c-f28cbba43493.mp4)
+
+Opening PDFs externally:
+
+![Opening PDFs externally on desktop](https://user-images.githubusercontent.com/5298006/171170626-5a94f5dc-61fc-4661-a9f2-38a0fb0181f5.gif)
+
+All features work on mobile, but were only tested on Android. Mobile uses the native image sharing functionality instead of the clipboard, and it downloads online images temporarily so they can be shared.
+
+## Installation
+
+You can install the plugin via the Community Plugins tab within the Obsidian app.  
+[Here](https://obsidian.md/plugins?id=copy-url-in-preview)'s the plugin in Obsidian's Community Plugins website.  
+You can install the plugin manually by copying a release to your `.obsidian/plugins/copy-url-in-preview` folder.
+
+## Development
+
+This plugin follows the structure of the [Obsidian Sample Plugin](https://github.com/obsidianmd/obsidian-sample-plugin), see further details there.  
+Contributions are welcome.
+
+## Credits
+
+Original plugin by [NomarCub](https://github.com/NomarCub).  
+If you like this plugin you can sponsor me here on GitHub: [![Sponsor NomarCub](https://img.shields.io/static/v1?label=Sponsor%20NomarCub&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/NomarCub), on Ko-fi here: <a href='https://ko-fi.com/nomarcub' target='_blank'><img height='35' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' alt='Buy Me a Coffee at ko-fi.com' /></a>, or on PayPal here: [![Paypal](https://img.shields.io/badge/paypal-nomarcub-yellow?style=social&logo=paypal)](https://paypal.me/nomarcub).
+
+[Copying](https://github.com/NomarCub/obsidian-copy-url-in-preview/pull/2) [images](https://github.com/NomarCub/obsidian-copy-url-in-preview/pull/3) developed by [luckman212](https://github.com/luckman212).  
+[Android image sharing](https://github.com/NomarCub/obsidian-copy-url-in-preview/issues/5) developed by [mnaoumov](https://github.com/mnaoumov).  
+[Open PDF externally](https://github.com/NomarCub/obsidian-copy-url-in-preview/issues/9) feature developed by [mnaoumov](https://github.com/mnaoumov).
+
+Thank you to the makers of the [Tag Wrangler plugin](https://github.com/pjeby/tag-wrangler), as it was a great starting point for working with context menus in Obsidian.
diff --git a/manifest.json b/manifest.json
@@ -1,9 +1,9 @@
 {
 	"id": "copy-url-in-preview",
-	"name": "Copy Image and URL context menu",
-	"version": "1.5.2",
-	"minAppVersion": "1.4.11",
-	"description": "Copy Image, Copy URL and Open PDF externally context menu in reading view (formerly preview mode)",
+	"name": "Image Context Menus",
+	"version": "1.6.0",
+	"minAppVersion": "1.5.7",
+	"description": "Copy, open in default app, show in system explorer, reveal in navigation context menu for images. Also Open PDF externally context menu.",
 	"author": "NomarCub",
 	"authorUrl": "https://github.com/NomarCub",
 	"fundingUrl": "https://ko-fi.com/nomarcub",
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "copy-url-in-preview",
-	"version": "1.5.2",
+	"version": "1.6.0",
 	"description": "Copy Image, Copy URL and Open PDF externally context menu in reading view (formerly preview mode) for Obsidian (https://obsidian.md)",
 	"main": "main.js",
 	"scripts": {
@@ -18,7 +18,7 @@
 		"builtin-modules": "3.3.0",
 		"esbuild": "0.17.3",
 		"eslint": "8.46.0",
-		"obsidian": "^1.4.11",
+		"obsidian": "~1.5.7-1",
 		"tslib": "2.4.0",
 		"typescript": "4.7.4"
 	}
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -1,6 +1,6 @@
 import { App, Editor, EditorPosition, FileSystemAdapter } from "obsidian";
 
-const loadImageBlobTimeout = 5000;
+const loadImageBlobTimeout = 5_000;
 
 export interface ElectronWindow extends Window {
     WEBVIEW_SERVER_URL: string
diff --git a/src/main.ts b/src/main.ts
@@ -6,11 +6,11 @@ import {
 import { CopyUrlInPreviewSettingTab, CopyUrlInPreviewSettings, DEFAULT_SETTINGS } from "settings";
 
 const IMAGE_URL_PREFIX = "/_capacitor_file_";
-const SUCCESS_NOTICE_TIMEOUT = 1800;
+const SUCCESS_NOTICE_TIMEOUT = 1_800;
 const longTapTimeout = 500;
-const deleteTempFileTimeout = 60000;
+const deleteTempFileTimeout = 60_000;
 const OPEN_PDF_MENU_BORDER_SIZE = 100;
-const OPEN_PDF_MENU_TIMEOUT = 5000;
+const OPEN_PDF_MENU_TIMEOUT = 5_000;
 
 export default class CopyUrlInPreview extends Plugin {
   longTapTimeoutId: number | null = null;
@@ -37,15 +37,6 @@ export default class CopyUrlInPreview extends Plugin {
   }
 
   registerDocument(document: Document) {
-    this.register(
-      onElement(
-        document,
-        "contextmenu" as keyof HTMLElementEventMap,
-        "a.external-link",
-        this.onClick.bind(this)
-      )
-    )
-
     this.register(
       onElement(
         document,
@@ -70,7 +61,7 @@ export default class CopyUrlInPreview extends Plugin {
           document,
           "contextmenu" as keyof HTMLElementEventMap,
           "img",
-          this.onClick.bind(this)
+          this.onClickImage.bind(this)
         )
       )
 
@@ -274,89 +265,76 @@ export default class CopyUrlInPreview extends Plugin {
   // Positions are not accurate from PointerEvent.
   // There's also TouchEvent
   // The event has target, path, toEvent (null on Android) for finding the link
-  onClick(event: MouseEvent) {
+  onClickImage(event: MouseEvent) {
+    const imgElement = event.target;
+    if (!(imgElement instanceof HTMLImageElement)) {
+      console.error("imgElement is supposed to be a HTMLImageElement. imgElement:");
+      console.error(imgElement);
+      return;
+    }
+
     event.preventDefault();
-    const target = (event.target as Element);
-    const imgType = target.localName;
     const menu = new Menu();
-    switch (imgType) {
-      case "img": {
-        const image = (target as HTMLImageElement).currentSrc;
-        const url = new URL(image);
-        const protocol = url.protocol;
-        switch (protocol) {
-          case "app:":
-          case "data:":
-          case "http:":
-          case "https:":
+    const image = imgElement.currentSrc;
+    const url = new URL(image);
+    const protocol = url.protocol;
+    switch (protocol) {
+      case "app:":
+      case "data:":
+      case "http:":
+      case "https:":
+        menu.addItem((item: MenuItem) => item
+          .setIcon("image-file")
+          .setTitle("Copy image to clipboard")
+          .onClick(async () => {
+            try {
+              const blob = await loadImageBlob(image);
+              const data = new ClipboardItem({ [blob.type]: blob });
+              await navigator.clipboard.write([data]);
+              new Notice("Image copied to the clipboard!", SUCCESS_NOTICE_TIMEOUT);
+            } catch {
+              new Notice("Error, could not copy the image!");
+            }
+          })
+        );
+        if (protocol === "app:" && Platform.isDesktop) {
+          // getResourcePath("") also works for root path
+          const baseFilePath = (this.app.vault.adapter as FileSystemAdapterWithInternalApi).getFilePath("");
+          const baseFilePathName: string = baseFilePath.replace("file://", "");
+          const urlPathName: string = url.pathname;
+          if (urlPathName.startsWith(baseFilePathName)) {
+            let relativePath = urlPathName.replace(baseFilePathName, "");
+            relativePath = decodeURI(relativePath);
+
             menu.addItem((item: MenuItem) => item
-              .setIcon("image-file")
-              .setTitle("Copy image to clipboard")
-              .onClick(async () => {
-                try {
-                  const blob = await loadImageBlob(image);
-                  const data = new ClipboardItem({ [blob.type]: blob });
-                  await navigator.clipboard.write([data]);
-                  new Notice("Image copied to the clipboard!", SUCCESS_NOTICE_TIMEOUT);
-                } catch {
-                  new Notice("Error, could not copy the image!");
-                }
+              .setIcon("arrow-up-right")
+              .setTitle("Open in default app")
+              .onClick(() => (this.app as AppWithDesktopInternalApi).openWithDefaultApp(relativePath))
+            );
+            menu.addItem((item: MenuItem) => item
+              .setIcon("arrow-up-right")
+              .setTitle(Platform.isMacOS ? "Reveal in finder" : "Show in system explorer")
+              .onClick(() => {
+                (this.app as AppWithDesktopInternalApi).showInFolder(relativePath);
               })
             );
-            if (protocol === "app:" && Platform.isDesktop) {
-              // getResourcePath("") also works for root path
-              const baseFilePath = (this.app.vault.adapter as FileSystemAdapterWithInternalApi).getFilePath("");
-              const baseFilePathName: string = baseFilePath.replace("file://", "");
-              const urlPathName: string = (url as any).pathname;
-              if (urlPathName.startsWith(baseFilePathName)) {
-                let relativePath = urlPathName.replace(baseFilePathName, "");
-                relativePath = decodeURI(relativePath);
-
-                menu.addItem((item: MenuItem) => item
-                  .setIcon("arrow-up-right")
-                  .setTitle("Open in default app")
-                  .onClick(() => (this.app as AppWithDesktopInternalApi).openWithDefaultApp(relativePath))
-                );
-                menu.addItem((item: MenuItem) => item
-                  .setIcon("arrow-up-right")
-                  .setTitle(Platform.isMacOS ? "Reveal in finder" : "Show in system explorer")
-                  .onClick(() => {
-                    (this.app as AppWithDesktopInternalApi).showInFolder(relativePath);
-                  })
-                );
-                menu.addItem((item: MenuItem) => item
-                  .setIcon("folder")
-                  .setTitle("Reveal file in navigation")
-                  .onClick(() => {
-                    const abstractFilePath = this.app.vault.getAbstractFileByPath(relativePath.substring(1));
-                    (this.app as any).internalPlugins.getEnabledPluginById("file-explorer").revealInFolder(abstractFilePath);
-                  })
-                );
-              }
-            }
-            break;
-          default:
-            new Notice(`no handler for ${protocol} protocol`);
-            return;
+            menu.addItem((item: MenuItem) => item
+              .setIcon("folder")
+              .setTitle("Reveal file in navigation")
+              .onClick(() => {
+                const file = this.app.vault.getFileByPath(relativePath.substring(1));
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                (this.app as any).internalPlugins.getEnabledPluginById("file-explorer").revealInFolder(file);
+              })
+            );
+          }
         }
         break;
-      }
-      case "a": {
-        const link = (target as HTMLAnchorElement).href;
-        menu.addItem((item: MenuItem) => item
-          .setIcon("link")
-          .setTitle("Copy URL")
-          .onClick(() => {
-            navigator.clipboard.writeText(link);
-            new Notice("URL copied to your clipboard", SUCCESS_NOTICE_TIMEOUT);
-          })
-        );
-        break;
-      }
       default:
-        new Notice("No handler for this image type!");
+        new Notice(`no handler for ${protocol} protocol`);
         return;
     }
+
     this.registerEscapeButton(menu);
     menu.showAtPosition({ x: event.pageX, y: event.pageY });
     this.app.workspace.trigger("copy-url-in-preview:contextmenu", menu);
diff --git a/src/settings.ts b/src/settings.ts
@@ -18,7 +18,7 @@ export class CopyUrlInPreviewSettingTab extends PluginSettingTab {
     display() {
         const { containerEl } = this;
         containerEl.empty();
-        containerEl.createEl("h3", { text: "Copy Image and URL context menu settings" });
+        containerEl.createEl("h3", { text: "Image Context Menus settings" });
         new Setting(containerEl)
             .setName("PDF context menu")
             .addToggle((toggle) => {
diff --git a/versions.json b/versions.json
@@ -3,5 +3,6 @@
 	"1.3.2": "0.14.8",
 	"1.3.5": "0.15.4",
 	"1.4.0": "0.16.3",
-	"1.5.2": "1.4.11"
+	"1.5.2": "1.4.11",
+	"1.6.0": "1.5.7"
 }

Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,6 @@`
`3`	`3`	`"1.3.2": "0.14.8",`
`4`	`4`	`"1.3.5": "0.15.4",`
`5`	`5`	`"1.4.0": "0.16.3",`
`6`		`- "1.5.2": "1.4.11"`
	`6`	`+ "1.5.2": "1.4.11",`
	`7`	`+ "1.6.0": "1.5.7"`
`7`	`8`	`}`