Merge 9e53cd0 into 62c9122

nvdaes · web-flow · commit 11866d4cfd08 · 2024-07-01T10:06:59.000Z
diff --git a/source/addonStore/dataManager.py b/source/addonStore/dataManager.py
@@ -8,6 +8,7 @@
 import os
 import pathlib
 import threading
+from datetime import datetime, timedelta
 from typing import (
 	TYPE_CHECKING,
 	Optional,
@@ -79,6 +80,7 @@ def terminate():
 class _DataManager:
 	_cacheLatestFilename: str = "_cachedLatestAddons.json"
 	_cacheCompatibleFilename: str = "_cachedCompatibleAddons.json"
+	_cacheCompatibleOldFilename: str = "_cachedCompatibleAddons-old.json"
 	_downloadsPendingInstall: Set[Tuple["AddonListItemVM[_AddonStoreModel]", os.PathLike]] = set()
 	_downloadsPendingCompletion: Set["AddonListItemVM[_AddonStoreModel]"] = set()
 
@@ -87,6 +89,9 @@ def __init__(self):
 		self._preferredChannel = Channel.ALL
 		self._cacheLatestFile = os.path.join(WritePaths.addonStoreDir, _DataManager._cacheLatestFilename)
 		self._cacheCompatibleFile = os.path.join(WritePaths.addonStoreDir, _DataManager._cacheCompatibleFilename)
+		self._cacheCompatibleOldFile = os.path.join(
+			WritePaths.addonStoreDir, _DataManager._cacheCompatibleOldFilename
+		)
 		self._installedAddonDataCacheDir = WritePaths.addonsDir
 
 		if NVDAState.shouldWriteToDisk():
@@ -96,6 +101,7 @@ def __init__(self):
 
 		self._latestAddonCache = self._getCachedAddonData(self._cacheLatestFile)
 		self._compatibleAddonCache = self._getCachedAddonData(self._cacheCompatibleFile)
+		self._oldAddonCache = self._getCachedAddonData(self._cacheCompatibleOldFile)
 		self._installedAddonsCache = _InstalledAddonsCache()
 		# Fetch available add-ons cache early
 		self._initialiseAvailableAddonsThread = threading.Thread(
@@ -110,6 +116,8 @@ def terminate(self):
 			self._initialiseAvailableAddonsThread.join(timeout=1)
 		if self._initialiseAvailableAddonsThread.is_alive():
 			log.debugWarning("initialiseAvailableAddons thread did not terminate immediately")
+		if self._shouldCacheCompatibleAddonsBackup():
+			self._cacheCompatibleAddonsBackup()
 
 	def _getLatestAddonsDataForVersion(self, apiVersion: str) -> Optional[bytes]:
 		url = _getAddonStoreURL(self._preferredChannel, self._lang, apiVersion)
@@ -158,6 +166,48 @@ def _cacheCompatibleAddons(self, addonData: str, cacheHash: Optional[str]):
 		with open(self._cacheCompatibleFile, 'w', encoding='utf-8') as cacheFile:
 			json.dump(cacheData, cacheFile, ensure_ascii=False)
 
+	def _shouldCacheCompatibleAddonsBackup(self) -> bool:
+		if not os.path.exists(self._cacheCompatibleOldFile):
+			return True
+		resetNewAddons = config.conf["addonStore"]["resetNewAddons"]
+		if resetNewAddons == "startup":
+			return True
+		lastBackupTime = os.path.getmtime(self._cacheCompatibleOldFile)
+		lastBackupDate = datetime.fromtimestamp(lastBackupTime)
+		nowDate = datetime.now()
+		diffDate = nowDate - lastBackupDate
+		if resetNewAddons == "weekly" and diffDate.days >= 7:
+			return True
+		if resetNewAddons == "monthly" and diffDate.days >= 30:
+			return True
+		return False
+
+	def _getResetNewAddonsDate(self) -> str:
+		resetNewAddons = config.conf["addonStore"]["resetNewAddons"]
+		if resetNewAddons == "startup":
+			return _("Will be reset at startup")
+		lastBackupTime = os.path.getmtime(self._cacheCompatibleOldFile)
+		lastBackupDate = datetime.fromtimestamp(lastBackupTime)
+		formattedLastBackupDate = lastBackupDate.strftime("%d/%m/%Y")
+		if resetNewAddons == "monthly":
+			timedeltaDays = 30
+		else:  # weekly
+			timedeltaDays = 7
+		nextResetDate = lastBackupDate+timedelta(days=timedeltaDays)
+		formattedNextResetDate = nextResetDate.strftime("%d/%m/%Y")
+		return f"{formattedLastBackupDate}-{formattedNextResetDate}"
+
+	def _cacheCompatibleAddonsBackup(self):
+		if not NVDAState.shouldWriteToDisk():
+			return
+		try:
+			with open(self._cacheCompatibleFile, 'r', encoding='utf-8') as cacheFile:
+				cacheData = json.load(cacheFile)
+		except Exception:
+			log.exception("Invalid add-on store cache")
+		with open(self._cacheCompatibleOldFile, 'w', encoding='utf-8') as cacheFile:
+			json.dump(cacheData, cacheFile, ensure_ascii=False)
+
 	def _cacheLatestAddons(self, addonData: str, cacheHash: Optional[str]):
 		if not NVDAState.shouldWriteToDisk():
 			return
@@ -281,6 +331,26 @@ def getLatestAddons(
 			return _createAddonGUICollection()
 		return deepcopy(self._latestAddonCache.cachedAddonData)
 
+	def _checkForNewAddons(self) -> bool:
+		oldAddons = self._getOldAddons()
+		compatibleAddons = self.getLatestCompatibleAddons()
+		installedAddons = self._installedAddonsCache._get_installedAddons()
+		for channel in compatibleAddons:
+			for addonId in compatibleAddons[channel]:
+				compatibleAddon = compatibleAddons[channel][addonId]
+				if (
+					addonId not in oldAddons[channel]
+					or compatibleAddon.addonVersionNumber != oldAddons[channel][addonId].addonVersionNumber
+				) and addonId not in installedAddons:
+					return True
+		return False
+
+	def _getOldAddons(self) -> "AddonGUICollectionT":
+		if self._oldAddonCache is None:
+			return _createAddonGUICollection()
+		oldAddons = deepcopy(self._oldAddonCache.cachedAddonData)
+		return oldAddons
+
 	def _deleteCacheInstalledAddon(self, addonId: str):
 		addonCachePath = os.path.join(self._installedAddonDataCacheDir, f"{addonId}.json")
 		if pathlib.Path(addonCachePath).exists():
diff --git a/source/addonStore/models/status.py b/source/addonStore/models/status.py
@@ -157,9 +157,11 @@ class _StatusFilterKey(DisplayStringEnum):
 	UPDATE = enum.auto()
 	AVAILABLE = enum.auto()
 	INCOMPATIBLE = enum.auto()
+	NEW = enum.auto()
 
 	@property
 	def _displayStringLabels(self) -> Dict["_StatusFilterKey", str]:
+		resetNewAddonsDate = getResetNewAddonsDate()
 		return {
 			# Translators: The label of a tab to display installed add-ons in the add-on store.
 			# Ensure the translation matches the label for the add-on list which includes an accelerator key.
@@ -173,6 +175,9 @@ def _displayStringLabels(self) -> Dict["_StatusFilterKey", str]:
 			# Translators: The label of a tab to display incompatible add-ons in the add-on store.
 			# Ensure the translation matches the label for the add-on list which includes an accelerator key.
 			self.INCOMPATIBLE: pgettext("addonStore", "Installed incompatible add-ons"),
+			# Translators: The label of a tab to display new add-ons in the add-on store.
+			# Ensure the translation matches the label for the add-on list which includes an accelerator key.
+			self.NEW: pgettext("addonStore", "Available new add-ons (%s)" % resetNewAddonsDate),
 		}
 
 	@property
@@ -194,6 +199,10 @@ def _displayStringLabelsWithAccelerators(self) -> Dict["_StatusFilterKey", str]:
 			# Preferably use the same accelerator key for the four labels.
 			# Ensure the translation matches the label for the add-on tab which has the accelerator key removed.
 			self.INCOMPATIBLE: pgettext("addonStore", "Installed incompatible &add-ons"),
+			# Translators: The label of the add-ons list in the corresponding panel.
+			# Preferably use the same accelerator key for the four labels.
+			# Ensure the translation matches the label for the add-on tab which has the accelerator key removed.
+			self.NEW: pgettext("addonStore", "Available new &add-ons"),
 		}
 
 	@property
@@ -313,7 +322,7 @@ def getStatus(model: "_AddonGUIModel", context: _StatusFilterKey) -> AvailableAd
 	:return: Status of add-on for the context of the current tab.
 	"""
 
-	if context in (_StatusFilterKey.AVAILABLE, _StatusFilterKey.UPDATE):
+	if context in (_StatusFilterKey.AVAILABLE, _StatusFilterKey.UPDATE, _StatusFilterKey.NEW):
 		downloadableStatus = _getDownloadableStatus(model)
 		if downloadableStatus:
 			# Is this available in the add-on store and not installed?
@@ -417,12 +426,19 @@ def getStatus(model: "_AddonGUIModel", context: _StatusFilterKey) -> AvailableAd
 		AvailableAddonStatus.INCOMPATIBLE_ENABLED,
 		AvailableAddonStatus.UNKNOWN,
 	},
+	_StatusFilterKey.NEW: _installingStatuses
+	.union({AvailableAddonStatus.AVAILABLE})
 })
 """A dictionary where the keys are a status to filter by,
 and the values are which statuses should be shown for a given filter.
 """
 
 
+def getResetNewAddonsDate() -> str:
+		from ..dataManager import addonDataManager
+		return addonDataManager._getResetNewAddonsDate()
+
+
 class SupportsAddonState(SupportsVersionCheck, Protocol):
 	@property
 	def _stateHandler(self) -> "AddonsState":
diff --git a/source/config/configFlags.py b/source/config/configFlags.py
@@ -220,3 +220,38 @@ def _displayStringLabels(self):
 			# Translators: This is a label for the automatic update behaviour for add-ons.
 			self.DISABLED: _("Disabled"),
 		}
+
+
+class ShowNewAddons(DisplayStringStrEnum):
+	DISABLED = "disabled"
+	NOTIFY = "notify"
+
+	@property
+	def _displayStringLabels(self):
+		return {
+			# Translators: This is a label for the show new add-ons at startup behavior.
+			self.DISABLED: _("Disabled"),
+			# Translators: This is a label for the show new add-ons at startup behavior.
+			# It will notify the user when new add-ons are available.
+			self.NOTIFY: _("Notify"),
+		}
+
+
+class ResetNewAddons(DisplayStringStrEnum):
+	MONTHLY = "monthly"
+	WEEKLY = "weekly"
+	STARTUP = "startup"
+
+	@property
+	def _displayStringLabels(self):
+		return {
+			# Translators: This is a label for the reset new add-ons behavior.
+			# It will determine the period for an add-on to be considered as new.
+			self.MONTHLY: _("Monthly"),
+			# Translators: This is a label for the reset new add-ons behavior.
+			# It will determine the period for an add-on to be considered as new.
+			self.WEEKLY: _("Weekly"),
+			# Translators: This is a label for the reset new add-ons behavior.
+			# It will determine the period for an add-on to be considered as new.
+			self.STARTUP: _("At startup"),
+		}
diff --git a/source/config/configSpec.py b/source/config/configSpec.py
@@ -326,6 +326,8 @@
 [addonStore]
 	showWarning = boolean(default=true)
 	automaticUpdates = option("notify", "disabled", default="notify")
+	showNewAddons = option("disabled", "notify", default="disabled")
+	resetNewAddons = option("monthly", "weekly", "startup", default="monthly")
 """
 
 #: The configuration specification
diff --git a/source/gui/__init__.py b/source/gui/__init__.py
@@ -423,6 +423,21 @@ def onAddonStoreUpdatableCommand(self, evt: wx.MenuEvent | None):
 		_storeVM.refresh()
 		self.popupSettingsDialog(AddonStoreDialog, _storeVM, openToTab=_StatusFilterKey.UPDATE)
 
+	@blockAction.when(
+		blockAction.Context.SECURE_MODE,
+		blockAction.Context.MODAL_DIALOG_OPEN,
+		blockAction.Context.WINDOWS_LOCKED,
+		blockAction.Context.WINDOWS_STORE_VERSION,
+		blockAction.Context.RUNNING_LAUNCHER,
+	)
+	def onAddonStoreNewAddonsCommand(self, evt: wx.MenuEvent | None):
+		from .addonStoreGui import AddonStoreDialog
+		from .addonStoreGui.viewModels.store import AddonStoreVM
+		from addonStore.models.status import _StatusFilterKey
+		_storeVM = AddonStoreVM()
+		_storeVM.refresh()
+		self.popupSettingsDialog(AddonStoreDialog, _storeVM, openToTab=_StatusFilterKey.NEW)
+
 	def onReloadPluginsCommand(self, evt):
 		import appModuleHandler
 		import globalPluginHandler
diff --git a/source/gui/addonStoreGui/__init__.py b/source/gui/addonStoreGui/__init__.py
@@ -3,6 +3,12 @@
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
 
+import wx
+
+from addonStore.dataManager import addonDataManager
+import config
+from config.configFlags import ShowNewAddons
+import gui
 from utils.schedule import scheduleThread, ThreadTarget
 
 from .controls.storeDialog import AddonStoreDialog
@@ -19,3 +25,17 @@ def initialize():
 		UpdatableAddonsDialog._checkForUpdatableAddons,
 		queueToThread=ThreadTarget.GUI,
 	)
+	scheduleThread.scheduleDailyJobAtStartUp(
+		showNewAddons,
+		queueToThread=ThreadTarget.GUI,
+	)
+
+
+def showNewAddons():
+	if (
+		ShowNewAddons.NOTIFY == config.conf["addonStore"]["showNewAddons"]
+		and addonDataManager._oldAddonCache is not None
+	):
+		availableNewAddons = addonDataManager._checkForNewAddons()
+		if availableNewAddons:
+			wx.CallAfter(gui.mainFrame.onAddonStoreNewAddonsCommand, None)
diff --git a/source/gui/addonStoreGui/controls/storeDialog.py b/source/gui/addonStoreGui/controls/storeDialog.py
@@ -321,6 +321,7 @@ def _toggleFilterControls(self):
 		if self._storeVM._filteredStatusKey in {
 			_StatusFilterKey.AVAILABLE,
 			_StatusFilterKey.UPDATE,
+			_StatusFilterKey.NEW,
 		}:
 			if self._storeVM._filteredStatusKey == _StatusFilterKey.UPDATE and (
 				self._storeVM._installedAddons[Channel.DEV]
@@ -333,6 +334,9 @@ def _toggleFilterControls(self):
 			self.enabledFilterCtrl.Disable()
 			self.includeIncompatibleCtrl.Enable()
 			self.includeIncompatibleCtrl.Show()
+			if self._storeVM._filteredStatusKey == _StatusFilterKey.NEW:
+				self.includeIncompatibleCtrl.Disable()
+				self.includeIncompatibleCtrl.Hide()
 		else:
 			self.channelFilterCtrl.Append(Channel.EXTERNAL.displayString)
 			self._storeVM._filterChannelKey = Channel.ALL
diff --git a/source/gui/addonStoreGui/viewModels/addonList.py b/source/gui/addonStoreGui/viewModels/addonList.py
@@ -65,7 +65,7 @@ class AddonListField(_AddonListFieldData, Enum):
 		# Translators: The name of the column that contains the installed addon's version string.
 		pgettext("addonStore", "Installed version"),
 		100,
-		frozenset({_StatusFilterKey.AVAILABLE}),
+		frozenset({_StatusFilterKey.AVAILABLE, _StatusFilterKey.NEW}),
 	)
 	availableAddonVersionName = (
 		# Translators: The name of the column that contains the available addon's version string.
@@ -88,7 +88,7 @@ class AddonListField(_AddonListFieldData, Enum):
 		# Translators: The name of the column that contains the addon's author.
 		pgettext("addonStore", "Author"),
 		100,
-		frozenset({_StatusFilterKey.AVAILABLE, _StatusFilterKey.UPDATE})
+		frozenset({_StatusFilterKey.AVAILABLE, _StatusFilterKey.UPDATE, _StatusFilterKey.NEW})
 	)
 
 
diff --git a/source/gui/addonStoreGui/viewModels/store.py b/source/gui/addonStoreGui/viewModels/store.py
@@ -566,6 +566,7 @@ def refresh(self):
 		if self._filteredStatusKey in {
 			_StatusFilterKey.AVAILABLE,
 			_StatusFilterKey.UPDATE,
+			_StatusFilterKey.NEW,
 		}:
 			self._refreshAddonsThread = threading.Thread(
 				target=self._getAvailableAddonsInBG,
@@ -603,6 +604,21 @@ def _getAvailableAddonsInBG(self):
 						and incompatibleAddons[channel][addonId].canOverrideCompatibility
 					):
 						availableAddons[channel][addonId] = incompatibleAddons[channel][addonId]
+		elif self._filteredStatusKey == _StatusFilterKey.NEW:
+			if addonDataManager._oldAddonCache is None:
+				availableAddons = _createAddonGUICollection()
+			else:
+				oldAddons = addonDataManager._getOldAddons()
+				newAddons = _createAddonGUICollection()
+				for channel in availableAddons:
+					for addonId in availableAddons[channel]:
+						availableAddon = availableAddons[channel][addonId]
+						if (
+							addonId not in oldAddons[channel]
+							or availableAddon.addonVersionNumber != oldAddons[channel][addonId].addonVersionNumber
+						):
+							newAddons[channel][addonId] = availableAddons[channel][addonId]
+				availableAddons = newAddons
 		log.debug("completed getting addons in the background")
 		self._availableAddons = availableAddons
 		self.listVM.resetListItems(self._createListItemVMs())
@@ -643,6 +659,7 @@ def _createListItemVMs(self) -> List[AddonListItemVM]:
 		if self._filteredStatusKey in {
 			_StatusFilterKey.AVAILABLE,
 			_StatusFilterKey.UPDATE,
+			_StatusFilterKey.NEW,
 		}:
 			addons = self._availableAddons
 
diff --git a/source/gui/settingsDialogs.py b/source/gui/settingsDialogs.py
@@ -28,6 +28,8 @@
 import config
 from config.configFlags import (
 	AddonsAutomaticUpdate,
+	ShowNewAddons,
+	ResetNewAddons,
 	NVDAKey,
 	ShowMessages,
 	TetherTo,
@@ -2910,10 +2912,34 @@ def makeSettings(self, settingsSizer: wx.BoxSizer) -> None:
 		self.bindHelpEvent("AutomaticAddonUpdates", self.automaticUpdatesComboBox)
 		index = [x.value for x in AddonsAutomaticUpdate].index(config.conf["addonStore"]["automaticUpdates"])
 		self.automaticUpdatesComboBox.SetSelection(index)
+		# Translators: This is a label for the show new add-ons combo box in the Add-on Store Settings dialog.
+		showNewAddonsLabelText = _("&Show new add-ons:")
+		self.showNewAddonsComboBox = sHelper.addLabeledControl(
+			showNewAddonsLabelText,
+			wx.Choice,
+			choices=[mode.displayString for mode in ShowNewAddons]
+		)
+		self.bindHelpEvent("ShowNewAddons", self.showNewAddonsComboBox)
+		index = [x.value for x in ShowNewAddons].index(config.conf["addonStore"]["showNewAddons"])
+		self.showNewAddonsComboBox.SetSelection(index)
+		# Translators: This is a label for the reset new add-ons combo box in the Add-on Store Settings dialog.
+		resetNewAddonsLabelText = _("&Reset new add-ons:")
+		self.resetNewAddonsComboBox = sHelper.addLabeledControl(
+			resetNewAddonsLabelText,
+			wx.Choice,
+			choices=[mode.displayString for mode in ResetNewAddons]
+		)
+		self.bindHelpEvent("ResetNewAddons", self.resetNewAddonsComboBox)
+		index = [x.value for x in ResetNewAddons].index(config.conf["addonStore"]["resetNewAddons"])
+		self.resetNewAddonsComboBox.SetSelection(index)
 
 	def onSave(self):
 		index = self.automaticUpdatesComboBox.GetSelection()
 		config.conf["addonStore"]["automaticUpdates"] = [x.value for x in AddonsAutomaticUpdate][index]
+		index = self.showNewAddonsComboBox.GetSelection()
+		config.conf["addonStore"]["showNewAddons"] = [x.value for x in ShowNewAddons][index]
+		index = self.resetNewAddonsComboBox.GetSelection()
+		config.conf["addonStore"]["resetNewAddons"] = [x.value for x in ResetNewAddons][index]
 
 
 class TouchInteractionPanel(SettingsPanel):
diff --git a/tests/manual/addonStore.md b/tests/manual/addonStore.md
diff --git a/user_docs/en/changes.md b/user_docs/en/changes.md
diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md
