Add ability to recognize links to the same page

nvdaHelper/vbufBackends/gecko_ia2/gecko_ia2.cpp

@@ -1000,10 +1000,16 @@ VBufStorage_fieldNode_t* GeckoVBufBackend_t::fillVBuf(
 	}
 
 	BSTR value=NULL;
-	if(pacc->get_accValue(varChild,&value)==S_OK) {
-		if(value&&SysStringLen(value)==0) {
-			SysFreeString(value);
-			value=NULL;
+	if (pacc->get_accValue(varChild, &value) == S_OK) {
+		if (value) {
+			if (role == ROLE_SYSTEM_LINK) {
+				// For links, store the IAccessible value to handle same page link detection.
+				parentNode->addAttribute(L"IAccessible::value", value);
+			}
+			if (SysStringLen(value)==0) {
+				SysFreeString(value);
+				value=NULL;
+			}
 		}
 	}
 

source/NVDAObjects/IAccessible/ia2Web.py

@@ -213,6 +213,12 @@ def _get_states(self):
 			if popupState:
 				states.discard(controlTypes.State.HASPOPUP)
 				states.add(popupState)
+		if (
+			self.role == controlTypes.Role.LINK
+			and controlTypes.State.LINKED in states
+			and self.isInternalLink
+		):
+			states.add(controlTypes.State.INTERNAL_LINK)
 		return states
 
 	def _get_landmark(self):

source/NVDAObjects/UIA/chromium.py

@@ -66,11 +66,20 @@ def _getControlFieldForUIAObject(self, obj, isEmbedded=False, startOfNode=False,
 class ChromiumUIA(web.UIAWeb):
 	_TextInfo = ChromiumUIATextInfo
 
+	def _get_states(self):
+		states = super().states
+		if self.role == controlTypes.Role.LINK and self.isInternalLink:
+			states.add(controlTypes.State.INTERNAL_LINK)
+		return states
+
 
 class ChromiumUIATreeInterceptor(web.UIAWebTreeInterceptor):
 	def _get_documentConstantIdentifier(self):
 		return self.rootNVDAObject.parent._getUIACacheablePropertyValue(UIAHandler.UIA_AutomationIdPropertyId)
 
+	def _get_documentUrl(self):
+		return self.rootNVDAObject.value
+
 
 class ChromiumUIADocument(ChromiumUIA):
 	treeInterceptorClass = ChromiumUIATreeInterceptor

source/NVDAObjects/__init__.py

@@ -1627,3 +1627,17 @@ def _get_isBelowLockScreen(self) -> bool:
 		if not isLockScreenModeActive():
 			return False
 		return _isObjectBelowLockScreen(self)
+
+	isInternalLink: bool
+	"""Typing information for auto property _get_isInternalLink
+	"""
+
+	def _get_isInternalLink(self) -> bool:
+		if self.role != controlTypes.Role.LINK:
+			return False
+		from browseMode import BrowseModeDocumentTreeInterceptor
+
+		ti = getattr(self, "treeInterceptor", None)
+		if not isinstance(ti, BrowseModeDocumentTreeInterceptor):
+			return False
+		return ti.isInternalLinkInDocument(self.value)

source/braille.py

@@ -277,6 +277,8 @@
 	controlTypes.State.HASCOMMENT: _("cmnt"),
 	# Translators: Displayed in braille when a control is switched on
 	controlTypes.State.ON: "⣏⣿⣹",
+	# Translators: Displayed in braille when a link destination pointsto the same page
+	controlTypes.State.INTERNAL_LINK: _("smp"),
 }
 negativeStateLabels = {
 	# Translators: Displayed in braille when an object is not selected.

source/browseMode.py

@@ -54,6 +54,7 @@
 import gui.contextHelp
 from abc import ABCMeta, abstractmethod
 import globalVars
+from utils import urlUtils
 from typing import Optional
 
 
@@ -304,6 +305,14 @@ class BrowseModeTreeInterceptor(treeInterceptorHandler.TreeInterceptor):
 	scriptCategory = inputCore.SCRCAT_BROWSEMODE
 	_disableAutoPassThrough = False
 	APPLICATION_ROLES = (controlTypes.Role.APPLICATION, controlTypes.Role.DIALOG)
+	documentUrl: str | None = None
+	"""The URL of the current browse mode document.
+	C{None} when there is no URL or it is unknown.
+	"""
+
+	def isInternalLinkInDocument(self, url: str) -> bool:
+		"""Returns whether the given url is a same page link within the current browse mode document."""
+		return urlUtils.isSamePageUrl(url, self.documentUrl)
 
 	def _get_currentNVDAObject(self):
 		raise NotImplementedError

source/config/configSpec.py

@@ -239,6 +239,7 @@
 	# 0: Off, 1: style, 2: color and style
 	reportCellBorders = integer(0, 2, default=0)
 	reportLinks = boolean(default=true)
+	reportLinkType = featureFlag(optionsEnum="BoolFlag", behaviorOfDefault="enabled")
 	reportGraphics = boolean(default=True)
 	reportComments = boolean(default=true)
 	reportBookmarks = boolean(default=true)

source/controlTypes/processAndLabelStates.py

@@ -31,6 +31,7 @@ def _processPositiveStates(
 		positiveStates.discard(State.EDITABLE)
 	if role != Role.LINK:
 		positiveStates.discard(State.VISITED)
+		positiveStates.discard(State.INTERNAL_LINK)
 	positiveStates.discard(State.SELECTABLE)
 	positiveStates.discard(State.FOCUSABLE)
 	positiveStates.discard(State.CHECKABLE)
@@ -47,6 +48,8 @@ def _processPositiveStates(
 		# or reporting clickable just isn't useful,
 		# or the user has explicitly requested no reporting clickable
 		positiveStates.discard(State.CLICKABLE)
+	if not config.conf["documentFormatting"]["reportLinkType"]:
+		positiveStates.discard(State.INTERNAL_LINK)
 	if reason == OutputReason.QUERY:
 		return positiveStates
 	positiveStates.discard(State.DEFUNCT)

source/controlTypes/state.py

@@ -102,6 +102,7 @@ def negativeDisplayString(self) -> str:
 	HASPOPUP_GRID = setBit(48)
 	HASPOPUP_LIST = setBit(49)
 	HASPOPUP_TREE = setBit(50)
+	INTERNAL_LINK = setBit(51)
 
 
 STATES_SORTED = frozenset([State.SORTED, State.SORTED_ASCENDING, State.SORTED_DESCENDING])
@@ -204,6 +205,9 @@ def negativeDisplayString(self) -> str:
 	State.HASPOPUP_LIST: _("opens list"),
 	# Translators: Presented when a control has a pop-up tree.
 	State.HASPOPUP_TREE: _("opens tree"),
+	# Translators: Presented when a link destination points to the page containing the link.
+	# For example, links of a table of contents of a document with different sections.
+	State.INTERNAL_LINK: _("same page"),
 }
 
 

source/globalCommands.py

@@ -902,6 +902,31 @@ def script_toggleReportLinks(self, gesture):
 			config.conf["documentFormatting"]["reportLinks"] = True
 		ui.message(state)
 
+	@script(
+		# Translators: Input help mode message for cycle through report link type command.
+		description=_("Cycles through the report link type states"),
+		category=SCRCAT_DOCUMENTFORMATTING,
+	)
+	def script_cyclesReportLinkType(self, gesture: inputCore.InputGesture) -> None:
+		"""Set next state of report link type and reports it with ui.message."""
+		featureFlag: FeatureFlag = config.conf["documentFormatting"]["reportLinkType"]
+		boolFlag: BoolFlag = featureFlag.enumClassType
+		values = [x.value for x in boolFlag]
+		currentValue = featureFlag.value.value
+		nextValueIndex = (currentValue % len(values)) + 1
+		nextName: str = boolFlag(nextValueIndex).name
+		config.conf["documentFormatting"]["reportLinkType"] = nextName
+		featureFlag = config.conf["documentFormatting"]["reportLinkType"]
+		if featureFlag.isDefault():
+			# Translators: Used to announce reporting link type state
+			# (default behavior).
+			msg = _("Report link type default (%s)") % featureFlag.behaviorOfDefault.displayString
+		else:
+			# Translators: Announces which report link type state is used
+			# (disabled or enabled).
+			msg = _("Report link type %s") % BoolFlag[nextName].displayString
+		ui.message(msg)
+
 	@script(
 		# Translators: Input help mode message for toggle report graphics command.
 		description=_("Toggles on and off the reporting of graphics"),

source/gui/settingsDialogs.py

@@ -2799,8 +2799,22 @@ def makeSettings(self, settingsSizer):
 		# Translators: This is the label for a checkbox in the
 		# document formatting settings panel.
 		self.linksCheckBox = elementsGroup.addItem(wx.CheckBox(elementsGroupBox, label=_("Lin&ks")))
+		self.linksCheckBox.Bind(wx.EVT_CHECKBOX, self.onLinksChange)
 		self.linksCheckBox.SetValue(config.conf["documentFormatting"]["reportLinks"])
 
+		self.reportLinkTypeCombo: nvdaControls.FeatureFlagCombo = elementsGroup.addLabeledControl(
+			labelText=_(
+				# Translators: This is the label for a combo box in the
+				# document formatting settings panel.
+				"Report link type",
+			),
+			wxCtrlClass=nvdaControls.FeatureFlagCombo,
+			keyPath=["documentFormatting", "reportLinkType"],
+			conf=config.conf,
+		)
+		if not self.linksCheckBox.GetValue():
+			self.reportLinkTypeCombo.Disable()
+
 		# Translators: This is the label for a checkbox in the
 		# document formatting settings panel.
 		self.graphicsCheckBox = elementsGroup.addItem(wx.CheckBox(elementsGroupBox, label=_("&Graphics")))
@@ -2867,6 +2881,9 @@ def makeSettings(self, settingsSizer):
 	def _onLineIndentationChange(self, evt: wx.CommandEvent) -> None:
 		self.ignoreBlankLinesRLICheckbox.Enable(evt.GetSelection() != 0)
 
+	def onLinksChange(self, evt: wx.CommandEvent):
+		self.reportLinkTypeCombo.Enable(evt.IsChecked())
+
 	def onSave(self):
 		config.conf["documentFormatting"]["detectFormatAfterCursor"] = (
 			self.detectFormatAfterCursorCheckBox.IsChecked()
@@ -2901,6 +2918,7 @@ def onSave(self):
 		config.conf["documentFormatting"]["reportTableCellCoords"] = self.tableCellCoordsCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportCellBorders"] = self.borderComboBox.GetSelection()
 		config.conf["documentFormatting"]["reportLinks"] = self.linksCheckBox.IsChecked()
+		self.reportLinkTypeCombo.saveCurrentValueToConf()
 		config.conf["documentFormatting"]["reportGraphics"] = self.graphicsCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportHeadings"] = self.headingsCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportLists"] = self.listsCheckBox.IsChecked()

source/utils/urlUtils.py

@@ -0,0 +1,33 @@
+# A part of NonVisual Desktop Access (NVDA)
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
+# Copyright (C) 2024 NV Access Limited, Noelia Ruiz Martínez, Leonard de Ruijter
+
+from urllib.parse import ParseResult, urlparse
+
+
+def isSamePageUrl(urlOnPage: str, rootUrl: str) -> bool:
+	"""Returns whether a given URL belongs to the same page as another URL.
+
+	:param urlOnPage: The URL that should be on the same page as `rootUrl`
+	:param rootUrl: The root URL of the page
+	:return: Whether `urlOnPage` belongs to the same page as `rootUrl`
+	"""
+	if not urlOnPage or not rootUrl:
+		return False
+
+	# Parse the URLs
+	urlOnPageParsed: ParseResult = urlparse(urlOnPage)
+	rootUrlParsed: ParseResult = urlparse(rootUrl)
+
+	if (
+		urlOnPageParsed.scheme == rootUrlParsed.scheme
+		and urlOnPageParsed.netloc == rootUrlParsed.netloc
+		and urlOnPageParsed.path == rootUrlParsed.path
+		and urlOnPageParsed.query == rootUrlParsed.query
+		and urlOnPageParsed.fragment
+		and "/" not in urlOnPageParsed.fragment
+	):
+		return True
+
+	return False

source/virtualBuffers/gecko_ia2.py

@@ -1,7 +1,8 @@
 # A part of NonVisual Desktop Access (NVDA)
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
-# Copyright (C) 2008-2023 NV Access Limited, Babbage B.V., Mozilla Corporation, Accessolutions, Julien Cochuyt
+# Copyright (C) 2008-2024 NV Access Limited, Babbage B.V., Mozilla Corporation, Accessolutions,
+# Julien Cochuyt, Noelia Ruiz Martínez, Leonard de Ruijter
 
 from dataclasses import dataclass
 from typing import (
@@ -167,9 +168,14 @@ def _normalizeControlField(self, attrs):  # noqa: C901
 			attrs["roleTextBraille"] = roleTextBraille
 		if attrs.get("IAccessible2::attribute_dropeffect", "none") != "none":
 			states.add(controlTypes.State.DROPTARGET)
-		if role == controlTypes.Role.LINK and controlTypes.State.LINKED not in states:
-			# This is a named link destination, not a link which can be activated. The user doesn't care about these.
-			role = controlTypes.Role.TEXTFRAME
+		if role == controlTypes.Role.LINK:
+			if controlTypes.State.LINKED not in states:
+				# This is a named link destination, not a link which can be activated. The user doesn't care about these.
+				role = controlTypes.Role.TEXTFRAME
+			elif (value := attrs.get("IAccessible::value")) is not None and self.obj.isInternalLinkInDocument(
+				value,
+			):
+				states.add(controlTypes.State.INTERNAL_LINK)
 		level = attrs.get("IAccessible2::attribute_level", "")
 		xmlRoles = attrs.get("IAccessible2::attribute_xml-roles", "").split(" ")
 		landmark = next((xr for xr in xmlRoles if xr in aria.landmarkRoles), None)
@@ -322,6 +328,9 @@ def _get_isAlive(self):
 			isDefunct = True
 		return not isDefunct
 
+	def _get_documentUrl(self) -> str:
+		return self.documentConstantIdentifier
+
 	def getNVDAObjectFromIdentifier(
 		self,
 		docHandle: int,

tests/system/nvdaSettingsFiles/standard-dontShowWelcomeDialog.ini

@@ -22,3 +22,5 @@ schemaVersion = 2
 		highlightFocus = True
 		highlightNavigator = True
 		highlightBrowseMode = True
+[documentFormatting]
+	reportLinkType = DISABLED

tests/unit/test_util/test_urlUtils.py

@@ -0,0 +1,45 @@
+# A part of NonVisual Desktop Access (NVDA)
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
+# Copyright (C) 2024 NV Access Limited, Noelia Ruiz Martínez, Leonard de Ruijter
+
+"""Unit tests for the urlUtils submodule."""
+
+import unittest
+from utils.urlUtils import isSamePageUrl
+
+
+class TestIsSamePageUrl(unittest.TestCase):
+	def test_samePage_basic(self):
+		self.assertTrue(isSamePageUrl("http://example.com/page#section", "http://example.com/page"))
+
+	def test_samePage_bothHaveFragments(self):
+		self.assertTrue(isSamePageUrl("http://example.com/page#section", "http://example.com/page#main"))
+
+	def test_differentPage(self):
+		self.assertFalse(isSamePageUrl("http://example.com/otherpage#section", "http://example.com/page"))
+
+	def test_noFragment(self):
+		"""URLs without fragments are not considered the same page."""
+		self.assertFalse(isSamePageUrl("http://example.com/page", "http://example.com/page"))
+
+	def test_differentDomain(self):
+		self.assertFalse(isSamePageUrl("http://other.com/page#section", "http://example.com/page"))
+
+	def test_empty_urlOnPage(self):
+		self.assertFalse(isSamePageUrl("", "http://example.com/page"))
+
+	def test_empty_pageUrl(self):
+		self.assertFalse(isSamePageUrl("http://example.com/page#section", ""))
+
+	def test_differentScheme(self):
+		self.assertFalse(isSamePageUrl("http://example.com/page#section", "https://example.com/page"))
+
+	def test_differentQuery(self):
+		self.assertFalse(
+			isSamePageUrl("http://example.com/page?q=3#section", "http://example.com/page?q4#section"),
+		)
+
+	def test_fragmentHasPath(self):
+		"""URLs whose fragments contain paths are not considered the same page."""
+		self.assertFalse(isSamePageUrl("http://example.com/page#fragment/path", "http://example.com/page"))

user_docs/en/changes.md

@@ -17,6 +17,7 @@ The available options are:
 * The timeout to perform a multiple keypress is now configurable; this may be especially useful for people with dexterity impairment. (#11929, @CyrilleB79)
 * When performing a braille cursor routing action, NVDA can now automatically speak the character at the cursor. (#8072, @LeonarddeR)
   * This option is disabled by default. You can enable "Speak character when routing cursor in text" in NVDA's braille settings.
+* NVDA can report when a link destination points to the current page (#141, @LeonarddeR, @nvdaes)
 
 ### Changes
 
@@ -58,6 +59,10 @@ Please refer to [the developer guide](https://www.nvaccess.org/files/nvda/docume
 * It is now possible to redirect objects retrieved from on-screen coordinates, by using the `NVDAObject.objectFromPointRedirect` method. (#16788, @Emil-18)
 * Running SCons with the parameter `--all-cores` will automatically pick the maximum number of available CPU cores. (#16943, #16868, @LeonarddeR)
 * Developer info now includes information on app architecture (such as AMD64) for the navigator object. (#16488, @josephsl)
+* In the gecko_ia2 virtual buffer backend, the accValue is exposed for links (#141, @LeonarddeR).
+* Anew utils/urlUtils/isSamePageUrl function has been added to check links (#141, @LeonarddeR)
+* A new INTERNAL_LINK state has been added to controlTypes.states.State (#141, @nvdaes)
+* A new isInternalLink property has been added for NVDAObjects.IAccessible.ia2Web.Ia2Web objects (#141, @nvdaes)
 
 #### Deprecations
 

user_docs/en/userGuide.md

@@ -2933,6 +2933,7 @@ You can configure reporting of:
 * Elements
   * Headings
   * Links
+  * Link type (destination to same page)
   * Graphics
   * Lists
   * Block quotes