Add ability to check for, download, and apply add-on updates

source/addonHandler/__init__.py

@@ -1,10 +1,17 @@
 # -*- coding: UTF-8 -*-
-#addonHandler.py
+# addonHandler/__init__.py
 #A part of NonVisual Desktop Access (NVDA)
 #Copyright (C) 2012-2019 Rui Batista, NV Access Limited, Noelia Ruiz Martínez, Joseph Lee, Babbage B.V., Arnold Loubriat
 #This file is covered by the GNU General Public License.
 #See the file COPYING for more details.
 
+"""Manages add-ons
+The add-on handler provides a definition of an add-on bundle,
+as well as functions to install, remove, disable/enable, and update add-on bundles.
+See https://addons.nvda-project.org for more information on NVDA community add-ons.
+See the NVDA developer guide for more info on writing add-ons.
+"""
+
 import sys
 import os.path
 import gettext
@@ -19,9 +26,12 @@
 from six import string_types
 import globalVars
 import zipfile
+import threading
+import wx
+# #3208 todo: tentatively use JSON for exchanging add-on update data.
+import json
 from configobj import ConfigObj
 from configobj.validate import Validator
-
 import config
 import globalVars
 import languageHandler
@@ -57,6 +67,8 @@ def loadState():
 			state["pendingDisableSet"] = set()
 		if "pendingEnableSet" not in state:
 			state["pendingEnableSet"] = set()
+		if "noUpdates" not in state:
+			state["noUpdates"] = set()
 	except:
 		# Defaults.
 		state = {
@@ -65,6 +77,7 @@ def loadState():
 			"disabledAddons":set(),
 			"pendingEnableSet":set(),
 			"pendingDisableSet":set(),
+			"noUpdates": set(),
 		}
 
 def saveState():
@@ -145,6 +158,54 @@ def disableAddonsIfAny():
 	state["pendingDisableSet"].clear()
 	state["pendingEnableSet"].clear()
 
+
+def checkForAddonUpdates():
+	# Prepare to receive a record of add-ons with update checking turned off.
+	if "noUpdates" not in state:
+		state["noUpdates"] = set()
+	curAddons = {}
+	addonSummaries = {}
+	for addon in getAvailableAddons():
+		name = addon.name
+		# Only check for updates for add-ons that can check for updates.
+		if name in state["noUpdates"]:
+			continue
+		manifest = addon.manifest
+		curVersion = manifest["version"]
+		curAddons[name] = {"summary": manifest["summary"], "version": curVersion}
+		addonSummaries[name] = {"summary": manifest["summary"], "curVersion": curVersion}
+	data = json.dumps(curAddons)
+	# Pseudocode:
+	"""try:
+		res = urllib.request.open(someURL, data)
+		# Check SSL and what not.
+		res = json.loads(res)"""
+	res = json.loads(data)
+	for addon in res:
+		res[addon].update(addonSummaries[addon])
+		# In reality, it'll be a list of URL's to try.
+		res[addon]["urls"] = None
+	return res
+
+
+def autoAddonUpdateCheck():
+	t = threading.Thread(target=_showAddonUpdateUI)
+	t.daemon = True
+	t.start()
+
+
+def _showAddonUpdateUI():
+	def _showAddonUpdateUICallback(info):
+		# The only purpose of this callback is to force add-on updates window to show up at startup.
+		import gui
+		from gui.addonGui import AddonUpdatesDialog
+		gui.mainFrame.prePopup()
+		AddonUpdatesDialog(gui.mainFrame, info).Show()
+		gui.mainFrame.postPopup()
+	info = checkForAddonUpdates()
+	if info is not None:
+		wx.CallAfter(_showAddonUpdateUICallback, info)
+
 def initialize():
 	""" Initializes the add-ons subsystem. """
 	if config.isAppX:
@@ -158,7 +219,8 @@ def initialize():
 	disableAddonsIfAny()
 	getAvailableAddons(refresh=True)
 	saveState()
-
+	# #3208 todo: Check for add-on updates unless NVDA itself is updating right now.
+	# checkForAddonUpdates()
 
 def terminate():
 	""" Terminates the add-ons subsystem. """

source/config/configSpec.py

@@ -207,6 +207,7 @@
 	startupNotification = boolean(default=true)
 	allowUsageStats = boolean(default=false)
 	askedAllowUsageStats = boolean(default=false)
+	addonUpdateAtStartup = boolean(default=true)
 
 [inputComposition]
 	autoReportAllCandidates = boolean(default=True)