Add ability to view new add-ons

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,
@@ -80,6 +81,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()
 
@@ -88,8 +90,10 @@ 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,
+			WritePaths.addonStoreDir, _DataManager._cacheCompatibleFilename
+		)
+		self._cacheCompatibleOldFile = os.path.join(
+			WritePaths.addonStoreDir, _DataManager._cacheCompatibleOldFilename
 		)
 		self._installedAddonDataCacheDir = WritePaths.addonsDir
 
@@ -100,6 +104,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(
@@ -114,6 +119,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)
@@ -162,6 +169,52 @@ 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":
+			# Translators: Message presented in the new add-ons combo box, informing that new add-ons will be reset at startup
+			return _("Will be reset at startup")
+		if not os.path.exists(self._cacheCompatibleOldFile):
+			# Translators: Message presented in the new add-ons combo box, informing that new add-ons will be retrieved when NVDA is restarted
+			return _("Empty list: NVDA needs to be restarted to retrieve new add-ons")
+		lastBackupTime = os.path.getmtime(self._cacheCompatibleOldFile)
+		lastBackupDate = datetime.fromtimestamp(lastBackupTime)
+		formattedLastBackupDate = lastBackupDate.strftime("%x")
+		if resetNewAddons == "monthly":
+			timedeltaDays = 31
+		else:  # weekly
+			timedeltaDays = 7
+		nextResetDate = lastBackupDate + timedelta(days=timedeltaDays)
+		formattedNextResetDate = nextResetDate.strftime("%x")
+		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
@@ -287,6 +340,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():

source/addonStore/models/status.py

@@ -44,6 +44,21 @@ def _displayStringLabels(self) -> Dict["EnabledStatus", str]:
 		}
 
 
+class NewStatus(DisplayStringEnum):
+	ALL = enum.auto()
+	NEW = enum.auto()
+
+	@property
+	def _displayStringLabels(self) -> Dict["EnabledStatus", str]:
+		resetNewAddonsDate = getResetNewAddonsDate()
+		return {
+			# Translators: The label of an option to filter the list of add-ons in the add-on store dialog.
+			self.ALL: pgettext("addonStore", "All"),
+			# Translators: The label of an option to filter the list of add-ons in the add-on store dialog.
+			self.NEW: pgettext("addonStore", "New add-ons (%s)" % resetNewAddonsDate),
+		}
+
+
 @enum.unique
 # TODO refactor rename from AvailableAddonStatus to AddonStatus
 class AvailableAddonStatus(DisplayStringEnum):
@@ -268,7 +283,7 @@ def _getUpdateStatus(model: "_AddonGUIModel") -> Optional[AvailableAddonStatus]:
 		# Parsing from a side-loaded add-on
 		try:
 			manifestAddonVersion = MajorMinorPatch._parseVersionFromVersionStr(
-				model._addonHandlerModel.version,
+				model._addonHandlerModel.version
 			)
 		except ValueError:
 			# Parsing failed to get a numeric version.
@@ -344,10 +359,7 @@ def getStatus(model: "_AddonGUIModel", context: _StatusFilterKey) -> AvailableAd
 	return AvailableAddonStatus.UNKNOWN
 
 
-_addonStoreStateToAddonHandlerState: OrderedDict[
-	AvailableAddonStatus,
-	Set[AddonStateCategory],
-] = OrderedDict(
+_addonStoreStateToAddonHandlerState: OrderedDict[AvailableAddonStatus, Set[AddonStateCategory]] = OrderedDict(
 	{
 		# Pending states must be first as the pending state may be altering another state.
 		AvailableAddonStatus.PENDING_INCOMPATIBLE_DISABLED: {
@@ -371,7 +383,7 @@ def getStatus(model: "_AddonGUIModel", context: _StatusFilterKey) -> AvailableAd
 		AvailableAddonStatus.INCOMPATIBLE_ENABLED: {AddonStateCategory.OVERRIDE_COMPATIBILITY},
 		AvailableAddonStatus.DISABLED: {AddonStateCategory.DISABLED},
 		AvailableAddonStatus.INSTALLED: {AddonStateCategory.PENDING_INSTALL},
-	},
+	}
 )
 
 
@@ -423,7 +435,7 @@ def getStatus(model: "_AddonGUIModel", context: _StatusFilterKey) -> AvailableAd
 			{
 				AvailableAddonStatus.INCOMPATIBLE,
 				AvailableAddonStatus.AVAILABLE,
-			},
+			}
 		),
 		_StatusFilterKey.INCOMPATIBLE: {
 			AvailableAddonStatus.PENDING_INCOMPATIBLE_DISABLED,
@@ -432,13 +444,19 @@ def getStatus(model: "_AddonGUIModel", context: _StatusFilterKey) -> AvailableAd
 			AvailableAddonStatus.INCOMPATIBLE_ENABLED,
 			AvailableAddonStatus.UNKNOWN,
 		},
-	},
+	}
 )
 """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":
@@ -458,17 +476,11 @@ def isRunning(self) -> bool:
 	def pendingInstallPath(self) -> str:
 		from addonHandler import ADDON_PENDINGINSTALL_SUFFIX
 
-		return os.path.join(
-			WritePaths.addonsDir,
-			self.name + ADDON_PENDINGINSTALL_SUFFIX,
-		)
+		return os.path.join(WritePaths.addonsDir, self.name + ADDON_PENDINGINSTALL_SUFFIX)
 
 	@property
 	def installPath(self) -> str:
-		return os.path.join(
-			WritePaths.addonsDir,
-			self.name,
-		)
+		return os.path.join(WritePaths.addonsDir, self.name)
 
 	@property
 	def isPendingInstall(self) -> bool:

source/config/configFlags.py

@@ -225,3 +225,23 @@ def _displayStringLabels(self):
 			# Translators: This is a label for the automatic update behaviour for add-ons.
 			self.DISABLED: _("Disabled"),
 		}
+
+
+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"),
+		}

source/config/configSpec.py

@@ -326,6 +326,7 @@
 [addonStore]
 	showWarning = boolean(default=true)
 	automaticUpdates = option("notify", "disabled", default="notify")
+	resetNewAddons = option("monthly", "weekly", "startup", default="monthly")
 """
 
 #: The configuration specification

source/gui/addonStoreGui/controls/storeDialog.py

@@ -17,6 +17,7 @@
 from addonStore.models.channel import Channel, _channelFilters
 from addonStore.models.status import (
 	EnabledStatus,
+	NewStatus,
 	_statusFilters,
 	_StatusFilterKey,
 )
@@ -195,6 +196,19 @@ def _createFilterControls(self, filterCtrlHelper: guiHelper.BoxSizerHelper) -> N
 		self.enabledFilterCtrl.Bind(wx.EVT_CHOICE, self.onEnabledFilterChange, self.enabledFilterCtrl)
 		self.bindHelpEvent("AddonStoreFilterEnabled", self.enabledFilterCtrl)
 
+		self.newFilterCtrl = cast(
+			wx.Choice,
+			filterCtrlsLine0.addLabeledControl(
+				# Translators: The label of a selection field to filter the list of add-ons in the add-on store dialog.
+				labelText=pgettext("addonStore", "Release date filter:"),
+				wxCtrlClass=wx.Choice,
+				choices=list(c.displayString for c in NewStatus),
+			),
+		)
+		self.newFilterCtrl.SetSelection(0)
+		self.newFilterCtrl.Bind(wx.EVT_CHOICE, self.onNewFilterChange, self.newFilterCtrl)
+		self.bindHelpEvent("AddonStoreFilterNew", self.newFilterCtrl)
+
 		# Translators: The label of a text field to filter the list of add-ons in the add-on store dialog.
 		searchFilterLabel = wx.StaticText(self, label=pgettext("addonStore", "&Search:"))
 		# noinspection PyAttributeOutsideInit
@@ -327,6 +341,12 @@ def _toggleFilterControls(self):
 		for c in _channelFilters:
 			if c != Channel.EXTERNAL:
 				self.channelFilterCtrl.Append(c.displayString)
+		if self._storeVM._filteredStatusKey == _StatusFilterKey.AVAILABLE:
+			self.newFilterCtrl.Enable()
+			self.newFilterCtrl.Show()
+		else:
+			self.newFilterCtrl.Hide()
+			self.newFilterCtrl.Disable()
 		if self._storeVM._filteredStatusKey in {
 			_StatusFilterKey.AVAILABLE,
 			_StatusFilterKey.UPDATE,
@@ -387,6 +407,17 @@ def onEnabledFilterChange(self, evt: wx.EVT_CHOICE):
 
 	def onIncompatibleFilterChange(self, evt: wx.EVT_CHECKBOX):
 		self._storeVM._filterIncludeIncompatible = self.includeIncompatibleCtrl.GetValue()
+		if self._storeVM._filterIncludeIncompatible:
+			self.newFilterCtrl.Hide()
+			self.newFilterCtrl.Disable()
+		else:
+			self.newFilterCtrl.Enable()
+			self.newFilterCtrl.Show()
+		self._storeVM.refresh()
+
+	def onNewFilterChange(self, evt: wx.EVT_CHOICE):
+		index = self.newFilterCtrl.GetCurrentSelection()
+		self._storeVM._filterNew = list(NewStatus)[index]
 		self._storeVM.refresh()
 
 	def filter(self, filterText: str):

source/gui/addonStoreGui/viewModels/store.py

@@ -31,6 +31,7 @@
 )
 from addonStore.models.status import (
 	EnabledStatus,
+	NewStatus,
 	getStatus,
 	_statusFilters,
 	_StatusFilterKey,
@@ -91,6 +92,10 @@ def __init__(self):
 		Filters the add-on list view model by enabled or disabled.
 		"""
 		self._filterIncludeIncompatible: bool = False
+		self._filterNew: NewStatus = NewStatus.ALL
+		"""
+		Filters the add-on list view model by all or recently published.
+		"""
 
 		self.listVM: AddonListVM = AddonListVM(
 			addons=self._createListItemVMs(),
@@ -618,6 +623,21 @@ def _getAvailableAddonsInBG(self):
 						and incompatibleAddons[channel][addonId].canOverrideCompatibility
 					):
 						availableAddons[channel][addonId] = incompatibleAddons[channel][addonId]
+		elif self._filterNew != NewStatus.ALL:
+			if addonDataManager._oldAddonCache:
+				oldAddons = addonDataManager._getOldAddons()
+				newAddons = {
+					channel: {
+						addonId: addon
+						for addonId, addon in addons.items()
+						if addonId not in oldAddons[channel]
+						or addon.addonVersionNumber != oldAddons[channel][addonId].addonVersionNumber
+					}
+					for channel, addons in availableAddons.items()
+				}
+				availableAddons = newAddons
+			else:
+				availableAddons = _createAddonGUICollection()
 		log.debug("completed getting addons in the background")
 		self._availableAddons = availableAddons
 		self.listVM.resetListItems(self._createListItemVMs())

source/gui/settingsDialogs.py

@@ -28,6 +28,7 @@
 import config
 from config.configFlags import (
 	AddonsAutomaticUpdate,
+	ResetNewAddons,
 	NVDAKey,
 	ShowMessages,
 	TetherTo,
@@ -3102,10 +3103,20 @@ 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 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.resetNewAddonsComboBox.GetSelection()
+		config.conf["addonStore"]["resetNewAddons"] = [x.value for x in ResetNewAddons][index]
 
 
 class TouchInteractionPanel(SettingsPanel):