Add ability to specify add-on store metadata URL from within NVDA

source/addonStore/dataManager.py

@@ -210,7 +210,9 @@ def _getCachedAddonData(self, cacheFilePath: str) -> Optional[CachedAddonsModel]
 	_updateFailureMirrorSuggestion = pgettext(
 		"addonStore",
 		# Translators: A suggestion of what to do when fetching add-on data from the store fails and a metadata mirror is being used.
-		"Make sure you are connected to the internet, and the add-on store metadata mirror URL is valid.",
+		# {url} will be replaced with the mirror URL.
+		"Make sure you are connected to the internet, and the add-on store mirror URL is valid.\n"
+		"Mirror URL: {url}",
 	)
 	_updateFailureDefaultSuggestion = pgettext(
 		"addonStore",
@@ -295,25 +297,27 @@ def _do_displayError(
 		self,
 		onDisplayableError: "DisplayableError.OnDisplayableErrorT | None",
 		displayMessage: str,
-		titleMessage: str | None = _updateFailureMessage,
-		showTip: bool = True,
+		titleMessage: str | None = None,
 	):
 		"""Display a DisplayableMessage if an OnDisplayableError action is given.
 
 		See gui.message.DisplayableError for further information.
 
 		:param onDisplayableError: The displayable error action.
 		:param displayMessage: Body of the displayable error.
-		:param titleMessage: Title of the displayable error, defaults to _updateFailureMessage.
-		:param showTip: Whether or not to show a suggestion of what to try, defaults to True.
+		:param titleMessage: Title of the displayable error. If None, _updateFailureMessage will be used. Defaults to None.
 		"""
 		if onDisplayableError is None:
 			return
 		from gui.message import DisplayableError
 
-		if showTip:
-			displayMessage += f'\n{self._updateFailureMirrorSuggestion if config.conf["addonStore"]["baseURL"] else self._updateFailureDefaultSuggestion}'
-		displayableError = DisplayableError(displayMessage, titleMessage)
+		tip = (
+			self._updateFailureMirrorSuggestion.format(url=url)
+			if (url := config.conf["addonStore"]["baseServerURL"])
+			else self._updateFailureDefaultSuggestion
+		)
+		displayMessage = f"{displayMessage}\n{tip}"
+		displayableError = DisplayableError(displayMessage, titleMessage or self._updateFailureMessage)
 		callLater(delay=0, callable=onDisplayableError.notify, displayableError=displayableError)
 
 	def _deleteCacheInstalledAddon(self, addonId: str):

source/addonStore/network.py

@@ -9,7 +9,6 @@
 )
 import os
 import pathlib
-import posixpath
 import shutil
 from typing import (
 	TYPE_CHECKING,
@@ -51,7 +50,7 @@
 
 
 def _getBaseURL() -> str:
-	if url := conf["addonStore"]["baseURL"]:
+	if url := conf["addonStore"]["baseServerURL"]:
 		return url
 	return _DEFAULT_BASE_URL
 
@@ -62,13 +61,11 @@ def _getCurrentApiVersionForURL() -> str:
 
 
 def _getAddonStoreURL(channel: Channel, lang: str, nvdaApiVersion: str) -> str:
-	# We don't know whether a user-supplied base url will have a trailing slash, so use posixpath.join, which inserts separators as needed.
-	return posixpath.join(_getBaseURL(), lang, channel.value, f"{nvdaApiVersion}.json")
+	return f"{_getBaseURL()}/{lang}/{channel.value}/{nvdaApiVersion}.json"
 
 
 def _getCacheHashURL() -> str:
-	# We don't know whether a user-supplied base url will have a trailing slash, so use posixpath.join, which inserts separators as needed.
-	return posixpath.join(_getBaseURL(), "cacheHash.json")
+	return f"{_getBaseURL()}/cacheHash.json"
 
 
 class AddonFileDownloader:

source/config/configSpec.py

@@ -335,7 +335,7 @@
 [addonStore]
 	showWarning = boolean(default=true)
 	automaticUpdates = option("notify", "disabled", default="notify")
-	baseURL = string(default="")
+	baseServerURL = string(default="")
 """
 
 #: The configuration specification

source/gui/__init__.py

@@ -949,3 +949,7 @@ def Notify(self):
 
 def _isDebug():
 	return config.conf["debugLog"]["gui"]
+
+
+def _stripAcceleratorFromLabel(label: str) -> str:
+	return label.replace("&", "", 1)

source/gui/settingsDialogs.py

@@ -62,6 +62,7 @@
 	Set,
 	cast,
 )
+from url_normalize import url_normalize
 import core
 import keyboardHandler
 import characterProcessing
@@ -3133,20 +3134,25 @@ def makeSettings(self, settingsSizer: wx.BoxSizer) -> None:
 		self.automaticUpdatesComboBox.SetSelection(index)
 
 		# Translators: This is the label for a text box in the add-on store settings dialog.
-		addonMetadataMirrorLabel = _("Metadata &mirror")
+		self.addonMetadataMirrorLabelText = _("&Mirror URL")
 		self.addonMetadataMirrorTextbox = sHelper.addLabeledControl(
-			addonMetadataMirrorLabel,
+			self.addonMetadataMirrorLabelText,
 			wx.TextCtrl,
 		)
-		self.addonMetadataMirrorTextbox.SetValue(config.conf["addonStore"]["baseURL"])
+		self.addonMetadataMirrorTextbox.SetValue(config.conf["addonStore"]["baseServerURL"])
 		self.bindHelpEvent("AddonStoreMetadataMirror", self.addonMetadataMirrorTextbox)
-		# self.addonUpdateMirrorTextbox.SetValidator(URLValidator)
+
+	def isValid(self) -> bool:
+		self.addonMetadataMirrorTextbox.SetValue(
+			url_normalize(self.addonMetadataMirrorTextbox.GetValue().strip()).rstrip("/"),
+		)
+		return True
 
 	def onSave(self):
 		index = self.automaticUpdatesComboBox.GetSelection()
 		config.conf["addonStore"]["automaticUpdates"] = [x.value for x in AddonsAutomaticUpdate][index]
 
-		config.conf["addonStore"]["baseURL"] = self.addonMetadataMirrorTextbox.Value.strip()
+		config.conf["addonStore"]["baseServerURL"] = self.addonMetadataMirrorTextbox.Value.strip().rstrip("/")
 
 
 class TouchInteractionPanel(SettingsPanel):
@@ -5374,18 +5380,3 @@ def onFilterEditTextChange(self, evt):
 		self.filter(self.filterEdit.Value)
 		self._refreshVisibleItems()
 		evt.Skip()
-
-
-# class URLValidator(wx.Validator):
-# 	def Clone(self):
-# 		return URLValidator()
-
-# 	def Validate(self, parent):
-# 		from urllib.parse import urlparse
-# 		textControl = self.GetWindow()
-# 		text = textControl.getValue()
-# 		parsed = urlparse(text)
-# 		isValid = all([parsed.scheme, parsed.netloc])
-# 		if not isValid:
-# 			wx.MessageBox("The mirror URL is invalid")
-# 		return isValid

user_docs/en/changes.md

@@ -8,7 +8,7 @@
 
 * When editing in Microsoft PowerPoint text boxes, you can now move per sentence with `alt+upArrow`/`alt+downArrow`. (#17015, @LeonarddeR)
 * In Mozilla Firefox, NVDA will report the highlighted text when a URL containing a text fragment is visited. (#16910, @jcsteh)
-* It is now possible to specify a mirror URL to use for the add-on store. (#14974)
+* It is now possible to specify a mirror URL to use for the Add-on Store. (#14974)
 
 ### Changes
 
@@ -37,7 +37,7 @@ These are breaking API changes.
 Please open a GitHub issue if your add-on has an issue with updating to the new API.
 
 * The `addonStore.network.BASE_URL` constant has been removed.
-As the add-on store base URL is now configurable directly within NVDA, no replacement is planned.
+As the Add-on Store base URL is now configurable directly within NVDA, no replacement is planned. (#17099)
 
 #### Deprecations
 

user_docs/en/userGuide.md

@@ -3031,10 +3031,10 @@ For example, for installed beta add-ons, you will only be notified of updates wi
 |Notify |Notify when updates are available to add-ons within the same channel |
 |Disabled |Do not automatically check for updates to add-ons |
 
-##### Metadata Mirror {#AddonStoreMetadataMirror}
+##### Mirror URL {#AddonStoreMetadataMirror}
 
-This option allows you to specify an alternative URL to download add-on metadata from.
-This may be of use in locations where access to the NV Access Add-on Store server is slow.
+This option allows you to specify an alternative URL to download Add-on Store data from.
+This may be of use in locations where access to the NV Access Add-on Store server is slow or unavailable.
 
 Leave this blank to use the default NV Access Add-on Store server.