Merge cf0cc6b into 5c30524

hwf1324 · web-flow · commit d41062bdf201 · 2024-06-11T08:12:49.000Z
diff --git a/source/addonStore/network.py b/source/addonStore/network.py
@@ -33,6 +33,7 @@
 	_AddonStoreModel,
 )
 from .models.channel import Channel
+from .models.status import AvailableAddonStatus
 
 
 if TYPE_CHECKING:
@@ -109,7 +110,11 @@ def download(
 		f.add_done_callback(self._done)
 
 	def _done(self, downloadAddonFuture: Future[Optional[os.PathLike]]):
-		isCancelled = downloadAddonFuture.cancelled() or downloadAddonFuture not in self._pending
+		isCancelled = (
+			downloadAddonFuture.cancelled()
+			or downloadAddonFuture not in self._pending
+			or self._pending[downloadAddonFuture][0].status != AvailableAddonStatus.DOWNLOADING
+		)
 		addonId = "CANCELLED" if isCancelled else self._pending[downloadAddonFuture][0].model.addonId
 		log.debug(f"Done called for {addonId}")
 
diff --git a/source/gui/addonStoreGui/controls/actions.py b/source/gui/addonStoreGui/controls/actions.py
@@ -153,6 +153,13 @@ def _actions(self) -> List[BatchAddonActionVM]:
 				validCheck=lambda aVMs: AddonListValidator(aVMs).canUseUpdateAction(),
 				actionTarget=self._selectedAddons
 			),
+			BatchAddonActionVM(
+				# Translators: Label for an action that cancel install of the selected add-ons
+				displayName=pgettext("addonStore", "Ca&ncel install of selected add-ons"),
+				actionHandler=self._storeVM.cancelInstallAddons,
+				validCheck=lambda aVMs: AddonListValidator(aVMs).canUseCancelInstallAction(),
+				actionTarget=self._selectedAddons
+			),
 			BatchAddonActionVM(
 				# Translators: Label for an action that removes the selected add-ons
 				displayName=pgettext("addonStore", "&Remove selected add-ons"),
@@ -209,6 +216,12 @@ def canUseUpdateAction(self) -> bool:
 				hasInstallable = True
 		return hasUpdatable and not hasInstallable
 
+	def canUseCancelInstallAction(self) -> bool:
+		for aVM in self.addonsList:
+			if aVM.canUseCancelInstallAction():
+				return True
+		return False
+
 	def canUseRemoveAction(self) -> bool:
 		for aVM in self.addonsList:
 			if aVM.canUseRemoveAction():
diff --git a/source/gui/addonStoreGui/viewModels/addonList.py b/source/gui/addonStoreGui/viewModels/addonList.py
@@ -140,6 +140,12 @@ def canUseUpdateOverrideIncompatibilityAction(self) -> bool:
 	def canUseReplaceAction(self) -> bool:
 		return self.status == AvailableAddonStatus.REPLACE_SIDE_LOAD
 
+	def canUseCancelInstallAction(self) -> bool:
+		return self.status in (
+			AvailableAddonStatus.DOWNLOADING,
+			AvailableAddonStatus.DOWNLOAD_SUCCESS
+		)
+
 	def canUseRemoveAction(self) -> bool:
 		return (
 			self.model.isInstalled
diff --git a/source/gui/addonStoreGui/viewModels/store.py b/source/gui/addonStoreGui/viewModels/store.py
@@ -147,6 +147,13 @@ def _makeActionsList(self):
 				validCheck=lambda aVM: aVM.canUseReplaceAction(),
 				actionTarget=selectedListItem
 			),
+			AddonActionVM(
+				# Translators: Label for an action that cancels the installation of the selected addon
+				displayName=pgettext("addonStore", "Ca&ncel install"),
+				actionHandler=self.cancelInstallAddon,
+				validCheck=lambda aVM: aVM.canUseCancelInstallAction(),
+				actionTarget=selectedListItem
+			),
 			AddonActionVM(
 				# Translators: Label for an action that disables the selected addon
 				displayName=pgettext("addonStore", "&Disable"),
@@ -604,6 +611,37 @@ def _getAvailableAddonsInBG(self):
 		core.callLater(delay=0, callable=self.detailsVM.updated.notify, addonDetailsVM=self.detailsVM)
 		log.debug("completed refresh")
 
+	def cancelInstallAddon(self, listItemVM: AddonListItemVM[_AddonStoreModel]):
+		log.debug(f"Cancelling install of {listItemVM.Id}")
+
+		futuresCopy = self._downloader._pending.copy()
+		try:
+			addonDataManager._downloadsPendingCompletion.remove(listItemVM)
+			for future, addon in futuresCopy.items():
+				if listItemVM == addon[0] and not future.cancel():
+					self._downloader.progress.pop(addon[0], None)
+			listItemVM.status = getStatus(listItemVM.model, self._filteredStatusKey)
+			return
+		except KeyError:
+			log.debug("Download already completed")
+
+		pendingInstallCopy = addonDataManager._downloadsPendingInstall.copy()
+		for addonData, fileDownloaded in pendingInstallCopy:
+			if addonData == listItemVM:
+				addonDataManager._downloadsPendingInstall.remove((addonData, fileDownloaded))
+				# Clean up download file
+				try:
+					os.remove(fileDownloaded)
+				except FileNotFoundError:
+					pass
+
+		listItemVM.status = getStatus(listItemVM.model, self._filteredStatusKey)
+
+	def cancelInstallAddons(self, listItemVMs: Iterable[AddonListItemVM[_AddonStoreModel]]):
+		for aVM in listItemVMs:
+			if aVM.canUseCancelInstallAction():
+				self.cancelInstallAddon(aVM)
+
 	def cancelDownloads(self):
 		while addonDataManager._downloadsPendingCompletion:
 			listItem = addonDataManager._downloadsPendingCompletion.pop()
diff --git a/user_docs/en/changes.md b/user_docs/en/changes.md
@@ -32,6 +32,8 @@ Unicode CLDR has been updated.
 * NVDA will now report figures with no accessible children, but with a label or description. (#14514)
 * When reading by line in browse mode, "caption" is no longer reported on each line of a long figure or table caption. (#14874)
 * In the Python console, the last unexecuted command will no longer be lost when moving in the input history. (#16653, @CyrilleB79)
+* Added an action in the add-on store's updatable/available add-ons list to cancel the install of just downloaded add-on(s). (#15578, @hwf1324)
+
 
 ### Bug Fixes
 * Windows 11 fixes:
diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md
@@ -3488,6 +3488,7 @@ This could include accessing your personal data or even the entire system.
 You can install and update add-ons by [browsing Available add-ons](#AddonStoreBrowsing).
 Select an add-on from the "Available add-ons" or "Updatable add-ons" tab.
 Then use the update, install, or replace action to start the installation.
+It is also possible to cancel the install just after the download.
 
 You can also install multiple add-ons at once.
 This can be done by selecting multiple add-ons in the available add-ons tab, then activating the context menu on the selection and choosing the "Install selected add-ons" action.
