Add DisableAutoLinks advanced setting to disable PDF auto-linking

When enabled, SumatraPDF no longer turns plain-text URLs and email addresses in PDFs into clickable links. Native PDF hyperlinks are unaffected. (fixes #5703)

Author: kjk

cmd/gen-settings.ts

@@ -801,6 +801,14 @@ const globalPrefs: Field[] = [
     mkField("DisableAntiAlias", Bool, false, "if true, disables anti-aliasing for rendering PDF documents"),
     "3.6",
   ),
+  setExpert(
+    mkField(
+      "DisableAutoLinks",
+      Bool,
+      false,
+      "if true, disables auto-linking of URLs and email addresses found in PDF text",
+    ),
+  ),
   setExpert(
     mkField(
       "UseSysColors",

docs/md/Advanced-options-settings.md

@@ -182,6 +182,9 @@ UIFontSize = 0
 ; version 3.6)
 DisableAntiAlias = false
 
+; if true, disables auto-linking of URLs and email addresses found in PDF text
+DisableAutoLinks = false
+
 ; if true, we use Windows system colors for background/text color. Over-rides
 ; other settings
 UseSysColors = false

docs/md/Version-history.md

@@ -4,6 +4,7 @@
 
 Available in [pre-release](https://www.sumatrapdfreader.org/prerelease) builds.
 
+- add `DisableAutoLinks` advanced setting to disable auto-linking of URLs and email addresses found in PDF text (fixes #5703)
 - the `FixedPageUI.SelectionColor` advanced setting now honors an alpha channel: set an `#aarrggbb` value (e.g. `#40f5fc0c`) to make the text-selection overlay more transparent so selected text stays crisp instead of looking washed out; `#rrggbb` keeps the previous default opacity (fixes #3209)
 - middle-click auto-scroll is now smooth: it's driven by a high-frequency timer with fractional-pixel accumulation instead of a coarse 20ms timer with integer steps, so it no longer looks choppy (also enables fine, slow scroll speeds) (fixes #2693)
 - add `CmdStartAutoScroll` (`Start Auto-Scroll` in the `Ctrl + k` command palette) to start middle-click-style auto-scroll without a middle mouse button (useful on laptops / trackpads): it anchors at the cursor, then move the cursor away to scroll; invoke again or middle-click to stop. Bind it to a key via [shortcuts](Customizing-keyboard-shortcuts.md)

src/EngineBase.h

@@ -426,6 +426,7 @@ class EngineBase {
     bool hasPageLabels = false;
     bool hideAnnotations = false;
     bool disableAntiAlias = false;
+    bool disableAutoLinks = false;
     int pageCount = -1;
 
     StrVec errors;

src/EngineCreate.cpp

@@ -262,6 +262,7 @@ EngineBase* CreateEngineFromFile(const char* path, PasswordUI* pwdUI, bool enabl
                 if (engine) {
                     engine->SetFilePath(path);
                     engine->disableAntiAlias = gGlobalPrefs->disableAntiAlias;
+                    engine->disableAutoLinks = gGlobalPrefs->disableAutoLinks;
                     return engine;
                 }
             } else {
@@ -286,6 +287,7 @@ EngineBase* CreateEngineFromFile(const char* path, PasswordUI* pwdUI, bool enabl
     EngineBase* engine = CreateEngineForKind(kind, contentHint, path, pwdUI, enableChmEngine);
     if (engine) {
         engine->disableAntiAlias = gGlobalPrefs->disableAntiAlias;
+        engine->disableAutoLinks = gGlobalPrefs->disableAutoLinks;
         return engine;
     }
 
@@ -300,6 +302,7 @@ EngineBase* CreateEngineFromFile(const char* path, PasswordUI* pwdUI, bool enabl
     }
     if (engine) {
         engine->disableAntiAlias = gGlobalPrefs->disableAntiAlias;
+        engine->disableAutoLinks = gGlobalPrefs->disableAutoLinks;
     }
     return engine;
 }

src/EngineMupdf.cpp

@@ -2053,6 +2053,7 @@ EngineBase* EngineMupdf::Clone() {
     delete pwdUI;
 
     clone->disableAntiAlias = disableAntiAlias;
+    clone->disableAutoLinks = disableAutoLinks;
 
     if (!decryptionKey.s && pdfdoc && pdfdoc->crypt) {
         clone->decryptionKey = Str();
@@ -3303,7 +3304,9 @@ FzPageInfo* EngineMupdf::GetFzPageInfo(int pageNo, bool loadQuick, fz_cookie* co
         return pageInfo;
     }
 
-    FzLinkifyPageText(pageInfo, stext);
+    if (!disableAutoLinks) {
+        FzLinkifyPageText(pageInfo, stext);
+    }
     FzFindImagePositions(ctx, pageNo, pageInfo->images, stext);
     fz_drop_stext_page(ctx, stext);
     return pageInfo;

src/Settings.h

@@ -519,6 +519,9 @@ struct GlobalPrefs {
     int uIFontSize;
     // if true, disables anti-aliasing for rendering PDF documents
     bool disableAntiAlias;
+    // if true, disables auto-linking of URLs and email addresses found in
+    // PDF text
+    bool disableAutoLinks;
     // if true, we use Windows system colors for background/text color.
     // Over-rides other settings
     bool useSysColors;
@@ -924,6 +927,7 @@ static const FieldInfo gGlobalPrefsFields[] = {
     {offsetof(GlobalPrefs, treeFontSize), SettingType::Int, 0},
     {offsetof(GlobalPrefs, uIFontSize), SettingType::Int, 0},
     {offsetof(GlobalPrefs, disableAntiAlias), SettingType::Bool, false},
+    {offsetof(GlobalPrefs, disableAutoLinks), SettingType::Bool, false},
     {offsetof(GlobalPrefs, useSysColors), SettingType::Bool, false},
     {offsetof(GlobalPrefs, useTabs), SettingType::Bool, true},
     {offsetof(GlobalPrefs, tabsMru), SettingType::Bool, false},
@@ -974,17 +978,17 @@ static const FieldInfo gGlobalPrefsFields[] = {
     {(size_t)-1, SettingType::Comment, (intptr_t)"Settings below are not recognized by the current version"},
 };
 static const StructInfo gGlobalPrefsInfo = {
-    sizeof(GlobalPrefs), 91, gGlobalPrefsFields,
+    sizeof(GlobalPrefs), 92, gGlobalPrefsFields,
     "\0\0CheckForUpdates\0CustomScreenDPI\0DefaultDisplayMode\0DefaultZoom\0EnableTeXEnhancements\0EscToExit\0FullPathI"
     "nTitle\0InverseSearchCmdLine\0LazyLoading\0MainWindowBackground\0NoHomeTab\0HomePageSortByFrequentlyRead\0ReloadMo"
     "difiedDocuments\0RememberOpenedFiles\0RememberStatePerDocument\0RestoreSession\0ReuseInstance\0ShowMenubar\0ShowMe"
     "nubarWithTabs\0ShowTips\0CustomColors\0ShowToolbar\0ShowFavorites\0ShowToc\0ShowLinks\0ShowStartPage\0SidebarDx\0S"
     "crollbars\0ScrollbarInSinglePage\0SmoothScroll\0CitationHoverDelay\0FastScrollOverScrollbar\0PreventSleepInFullscr"
-    "een\0TabWidth\0Theme\0TocDy\0ToolbarSize\0TreeFontName\0TreeFontSize\0UIFontSize\0DisableAntiAlias\0UseSysColors\0"
-    "UseTabs\0TabsMru\0ZoomLevels\0ZoomIncrement\0\0FixedPageUI\0\0EBookUI\0\0ComicBookUI\0\0ImageUI\0\0ChmUI\0\0Annota"
-    "tions\0\0ExternalViewers\0\0ForwardSearch\0\0PrinterDefaults\0\0Fullscreen\0\0SelectionHandlers\0\0Shortcuts\0\0Th"
-    "emes\0\0TabGroups\0\0\0DefaultPasswords\0UiLanguage\0VersionToSkip\0WindowState\0WindowPos\0FileStates\0SessionDat"
-    "a\0ReopenOnce\0TimeOfLastUpdateCheck\0OpenCountWeek\0PropWinPos\0\0"};
+    "een\0TabWidth\0Theme\0TocDy\0ToolbarSize\0TreeFontName\0TreeFontSize\0UIFontSize\0DisableAntiAlias\0DisableAutoLin"
+    "ks\0UseSysColors\0UseTabs\0TabsMru\0ZoomLevels\0ZoomIncrement\0\0FixedPageUI\0\0EBookUI\0\0ComicBookUI\0\0ImageUI"
+    "\0\0ChmUI\0\0Annotations\0\0ExternalViewers\0\0ForwardSearch\0\0PrinterDefaults\0\0Fullscreen\0\0SelectionHandlers"
+    "\0\0Shortcuts\0\0Themes\0\0TabGroups\0\0\0DefaultPasswords\0UiLanguage\0VersionToSkip\0WindowState\0WindowPos\0Fil"
+    "eStates\0SessionData\0ReopenOnce\0TimeOfLastUpdateCheck\0OpenCountWeek\0PropWinPos\0\0"};
 static const FieldInfo gTheme_1_Fields[] = {
     {offsetof(Theme, name), SettingType::String, (intptr_t)""},
     {offsetof(Theme, textColor), SettingType::Color, (intptr_t)""},