Merge f51e88a into 4c50375

Author: nvdaes

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,49 @@ 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 tab, informing that new add-ons will be reset at 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
@@ -287,6 +337,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

@@ -110,17 +110,15 @@ def _displayStringLabels(self) -> Dict["AvailableAddonStatus", str]:
 			self.PENDING_DISABLE: pgettext("addonStore", "Disabled, pending restart"),
 			# Translators: Status for addons shown in the add-on store dialog
 			self.DISABLED: pgettext("addonStore", "Disabled"),
+			# Translators: Status for addons shown in the add-on store dialog
 			self.PENDING_INCOMPATIBLE_DISABLED: pgettext(
-				"addonStore",
-				# Translators: Status for addons shown in the add-on store dialog
-				"Disabled (incompatible), pending restart",
+				"addonStore", "Disabled (incompatible), pending restart"
 			),
 			# Translators: Status for addons shown in the add-on store dialog
 			self.INCOMPATIBLE_DISABLED: pgettext("addonStore", "Disabled (incompatible)"),
+			# Translators: Status for addons shown in the add-on store dialog
 			self.PENDING_INCOMPATIBLE_ENABLED: pgettext(
-				"addonStore",
-				# Translators: Status for addons shown in the add-on store dialog
-				"Enabled (incompatible), pending restart",
+				"addonStore", "Enabled (incompatible), pending restart"
 			),
 			# Translators: Status for addons shown in the add-on store dialog
 			self.INCOMPATIBLE_ENABLED: pgettext("addonStore", "Enabled (incompatible)"),
@@ -166,9 +164,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.
@@ -182,6 +182,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
@@ -203,6 +206,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
@@ -268,7 +275,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.
@@ -324,7 +331,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?
@@ -344,10 +351,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 +375,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 +427,7 @@ def getStatus(model: "_AddonGUIModel", context: _StatusFilterKey) -> AvailableAd
 			{
 				AvailableAddonStatus.INCOMPATIBLE,
 				AvailableAddonStatus.AVAILABLE,
-			},
+			}
 		),
 		_StatusFilterKey.INCOMPATIBLE: {
 			AvailableAddonStatus.PENDING_INCOMPATIBLE_DISABLED,
@@ -432,13 +436,20 @@ 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":
@@ -458,17 +469,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,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"),
+		}

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

source/gui/__init__.py

@@ -449,6 +449,22 @@ 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

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)

source/gui/addonStoreGui/controls/storeDialog.py

@@ -330,6 +330,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] or self._storeVM._installedAddons[Channel.BETA]
@@ -341,6 +342,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