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

source/addonStore/dataManager.py

@@ -207,6 +207,16 @@ def _getCachedAddonData(self, cacheFilePath: str) -> Optional[CachedAddonsModel]
 
 	# Translators: A title of the dialog shown when fetching add-on data from the store fails
 	_updateFailureMessage = pgettext("addonStore", "Add-on data update failure")
+	_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.",
+	)
+	_updateFailureDefaultSuggestion = pgettext(
+		"addonStore",
+		# Translators: A suggestion of what to do when fetching add-on data from the store fails and the default metadata URL is being used.
+		"Make sure you are connected to the internet and try again.",
+	)
 
 	def getLatestCompatibleAddons(
 		self,
@@ -234,15 +244,12 @@ def getLatestCompatibleAddons(
 					cachedLanguage=self._lang,
 					nvdaAPIVersion=addonAPIVersion.CURRENT,
 				)
-			elif onDisplayableError is not None:
-				from gui.message import DisplayableError
-
-				displayableError = DisplayableError(
+			else:
+				self._do_displayError(
+					onDisplayableError,
 					# Translators: A message shown when fetching add-on data from the store fails
 					pgettext("addonStore", "Unable to fetch latest add-on data for compatible add-ons."),
-					self._updateFailureMessage,
 				)
-				callLater(delay=0, callable=onDisplayableError.notify, displayableError=displayableError)
 
 		if self._compatibleAddonCache is None:
 			return _createAddonGUICollection()
@@ -273,20 +280,42 @@ def getLatestAddons(
 					cachedLanguage=self._lang,
 					nvdaAPIVersion=_LATEST_API_VER,
 				)
-			elif onDisplayableError is not None:
-				from gui.message import DisplayableError
-
-				displayableError = DisplayableError(
+			else:
+				self._do_displayError(
+					onDisplayableError,
 					# Translators: A message shown when fetching add-on data from the store fails
 					pgettext("addonStore", "Unable to fetch latest add-on data for incompatible add-ons."),
-					self._updateFailureMessage,
 				)
-				callLater(delay=0, callable=onDisplayableError.notify, displayableError=displayableError)
 
 		if self._latestAddonCache is None:
 			return _createAddonGUICollection()
 		return deepcopy(self._latestAddonCache.cachedAddonData)
 
+	def _do_displayError(
+		self,
+		onDisplayableError: "DisplayableError.OnDisplayableErrorT | None",
+		displayMessage: str,
+		titleMessage: str | None = _updateFailureMessage,
+		showTip: bool = True,
+	):
+		"""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.
+		"""
+		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)
+		callLater(delay=0, callable=onDisplayableError.notify, displayableError=displayableError)
+
 	def _deleteCacheInstalledAddon(self, addonId: str):
 		addonCachePath = os.path.join(self._installedAddonDataCacheDir, f"{addonId}.json")
 		if pathlib.Path(addonCachePath).exists():

source/addonStore/network.py

@@ -9,6 +9,7 @@
 )
 import os
 import pathlib
+import posixpath
 import shutil
 from typing import (
 	TYPE_CHECKING,
@@ -27,6 +28,7 @@
 import NVDAState
 from NVDAState import WritePaths
 from utils.security import sha256_checksum
+from config import conf
 
 from .models.addon import (
 	_AddonGUIModel,
@@ -40,25 +42,33 @@
 	from gui.addonStoreGui.viewModels.addonList import AddonListItemVM
 
 
-BASE_URL = "https://nvaccess.org/addonStore"
+_DEFAULT_BASE_URL = "https://nvaccess.org/addonStore"
 _LATEST_API_VER = "latest"
 """
 A string value used in the add-on store to fetch the latest version of all add-ons,
 i.e include older incompatible versions.
 """
 
 
+def _getBaseURL() -> str:
+	if url := conf["addonStore"]["baseURL"]:
+		return url
+	return _DEFAULT_BASE_URL
+
+
 def _getCurrentApiVersionForURL() -> str:
 	year, major, minor = addonAPIVersion.CURRENT
 	return f"{year}.{major}.{minor}"
 
 
 def _getAddonStoreURL(channel: Channel, lang: str, nvdaApiVersion: str) -> str:
-	return f"{BASE_URL}/{lang}/{channel.value}/{nvdaApiVersion}.json"
+	# 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")
 
 
 def _getCacheHashURL() -> str:
-	return f"{BASE_URL}/cacheHash.json"
+	# 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")
 
 
 class AddonFileDownloader:

source/config/configSpec.py

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

source/config/validators.py

@@ -0,0 +1,2 @@
+def _validate_url(url: str) -> bool:
+	return True

source/gui/settingsDialogs.py

@@ -3132,10 +3132,22 @@ def makeSettings(self, settingsSizer: wx.BoxSizer) -> None:
 		index = [x.value for x in AddonsAutomaticUpdate].index(config.conf["addonStore"]["automaticUpdates"])
 		self.automaticUpdatesComboBox.SetSelection(index)
 
+		# Translators: This is the label for a text box in the add-on store settings dialog.
+		addonMetadataMirrorLabel = _("Metadata &mirror")
+		self.addonMetadataMirrorTextbox = sHelper.addLabeledControl(
+			addonMetadataMirrorLabel,
+			wx.TextCtrl,
+		)
+		self.addonMetadataMirrorTextbox.SetValue(config.conf["addonStore"]["baseURL"])
+		self.bindHelpEvent("AddonStoreMetadataMirror", self.addonMetadataMirrorTextbox)
+		# self.addonUpdateMirrorTextbox.SetValidator(URLValidator)
+
 	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()
+
 
 class TouchInteractionPanel(SettingsPanel):
 	# Translators: This is the label for the touch interaction settings panel.
@@ -5362,3 +5374,18 @@ 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,6 +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)
 
 ### Changes
 
@@ -35,6 +36,9 @@ Add-ons will need to be re-tested and have their manifest updated.
 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.
+
 #### Deprecations
 
 * The `braille.filter_displaySize` extension point is deprecated.

user_docs/en/userGuide.md

@@ -3031,6 +3031,13 @@ 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}
+
+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.
+
+Leave this blank to use the default NV Access Add-on Store server.
+
 #### Windows OCR Settings {#Win10OcrSettings}
 
 The settings in this category allow you to configure [Windows OCR](#Win10Ocr).