forked from nvaccess/nvda
-
Notifications
You must be signed in to change notification settings - Fork 0
/
addon.py
372 lines (327 loc) · 10.5 KB
/
addon.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# A part of NonVisual Desktop Access (NVDA)
# Copyright (C) 2022-2023 NV Access Limited
# This file is covered by the GNU General Public License.
# See the file COPYING for more details.
import dataclasses
import json
import os
from typing import (
TYPE_CHECKING,
Any,
Dict,
Generator,
List,
Optional,
Protocol,
Union,
)
from requests.structures import CaseInsensitiveDict
import addonAPIVersion
from NVDAState import WritePaths
from .channel import Channel
from .status import SupportsAddonState
from .version import (
MajorMinorPatch,
SupportsVersionCheck,
)
if TYPE_CHECKING:
from addonHandler import ( # noqa: F401
Addon as AddonHandlerModel,
AddonBase as AddonHandlerBaseModel,
AddonManifest,
)
AddonGUICollectionT = Dict[Channel, CaseInsensitiveDict["_AddonGUIModel"]]
"""
Add-ons that have the same ID except differ in casing cause a path collision,
as add-on IDs are installed to a case insensitive path.
Therefore addon IDs should be treated as case insensitive.
"""
AddonHandlerModelGeneratorT = Generator["AddonHandlerModel", None, None]
class _AddonGUIModel(SupportsAddonState, SupportsVersionCheck, Protocol):
"""Needed to display information in add-on store.
May come from manifest or add-on store data.
"""
addonId: str
displayName: str
description: str
addonVersionName: str
channel: Channel
homepage: Optional[str]
minNVDAVersion: MajorMinorPatch
lastTestedVersion: MajorMinorPatch
legacy: bool
"""
Legacy add-ons contain invalid metadata
and should not be accessible through the add-on store.
"""
@property
def minimumNVDAVersion(self) -> addonAPIVersion.AddonApiVersionT:
"""In order to support SupportsVersionCheck"""
return self.minNVDAVersion
@property
def lastTestedNVDAVersion(self) -> addonAPIVersion.AddonApiVersionT:
"""In order to support SupportsVersionCheck"""
return self.lastTestedVersion
@property
def _addonHandlerModel(self) -> Optional["AddonHandlerModel"]:
"""Returns the Addon model tracked in addonHandler, if it exists."""
from ..dataManager import addonDataManager
if addonDataManager is None:
return None
return addonDataManager._installedAddonsCache.installedAddons.get(self.addonId)
@property
def name(self) -> str:
"""In order to support SupportsVersionCheck"""
return self.addonId
@property
def listItemVMId(self) -> str:
return f"{self.addonId}-{self.channel}"
def asdict(self) -> Dict[str, Any]:
assert dataclasses.is_dataclass(self)
jsonData = dataclasses.asdict(self)
for field in jsonData:
# dataclasses.asdict parses NamedTuples to JSON arrays,
# rather than JSON object dictionaries,
# which is expected by add-on infrastructure.
fieldValue = getattr(self, field)
if isinstance(fieldValue, MajorMinorPatch):
jsonData[field] = fieldValue._asdict()
return jsonData
class _AddonStoreModel(_AddonGUIModel):
addonId: str
displayName: str
description: str
addonVersionName: str
channel: Channel
homepage: Optional[str]
minNVDAVersion: MajorMinorPatch
lastTestedVersion: MajorMinorPatch
legacy: bool
publisher: str
license: str
licenseURL: Optional[str]
sourceURL: str
URL: str
sha256: str
addonVersionNumber: MajorMinorPatch
reviewURL: Optional[str]
@property
def tempDownloadPath(self) -> str:
"""
Path where this add-on should be downloaded to.
After download completion, the add-on is moved to cachedDownloadPath.
"""
return os.path.join(
WritePaths.addonStoreDownloadDir,
f"{self.name}.download"
)
@property
def cachedDownloadPath(self) -> str:
"""
Path where this add-on file should be cached,
after a successful download.
A file at this path may or may not be currently installed to the NVDA system.
"""
return os.path.join(
WritePaths.addonStoreDownloadDir,
f"{self.name}-{self.addonVersionName}.nvda-addon"
)
@property
def isPendingInstall(self) -> bool:
"""True if this addon has not yet been fully installed."""
from ..dataManager import addonDataManager
assert addonDataManager
nameInDownloadsPendingInstall = filter(
lambda m: m[0].model.name == self.name,
# add-ons which have been downloaded but
# have not been installed yet
addonDataManager._downloadsPendingInstall
)
return (
super().isPendingInstall
# True if this add-on has been downloaded but
# has not been installed yet
or bool(next(nameInDownloadsPendingInstall, False))
# True if this add-on is currently being downloaded
or os.path.exists(self.tempDownloadPath)
)
class _AddonManifestModel(_AddonGUIModel):
"""Get data from an add-on's manifest.
Can be from an add-on bundle or installed add-on.
"""
addonId: str
addonVersionName: str
channel: Channel
homepage: Optional[str]
minNVDAVersion: MajorMinorPatch
lastTestedVersion: MajorMinorPatch
manifest: "AddonManifest"
legacy: bool = False
"""
Legacy add-ons contain invalid metadata
and should not be accessible through the add-on store.
"""
@property
def displayName(self) -> str:
return self.manifest["summary"]
@property
def description(self) -> str:
description: Optional[str] = self.manifest.get("description")
if description is None:
return ""
return description
@property
def author(self) -> str:
return self.manifest["author"]
@dataclasses.dataclass(frozen=True) # once created, it should not be modified.
class AddonManifestModel(_AddonManifestModel):
"""Get data from an add-on's manifest.
Can be from an add-on bundle or installed add-on.
"""
addonId: str
addonVersionName: str
channel: Channel
homepage: Optional[str]
minNVDAVersion: MajorMinorPatch
lastTestedVersion: MajorMinorPatch
manifest: "AddonManifest"
legacy: bool = False
"""
Legacy add-ons contain invalid metadata
and should not be accessible through the add-on store.
"""
@dataclasses.dataclass(frozen=True) # once created, it should not be modified.
class InstalledAddonStoreModel(_AddonManifestModel, _AddonStoreModel):
"""
Data from an add-on installed from the add-on store.
"""
addonId: str
publisher: str
addonVersionName: str
channel: Channel
homepage: Optional[str]
license: str
licenseURL: Optional[str]
sourceURL: str
URL: str
sha256: str
addonVersionNumber: MajorMinorPatch
minNVDAVersion: MajorMinorPatch
lastTestedVersion: MajorMinorPatch
reviewURL: Optional[str]
legacy: bool = False
"""
Legacy add-ons contain invalid metadata
and should not be accessible through the add-on store.
"""
@property
def manifest(self) -> "AddonManifest":
from ..dataManager import addonDataManager
assert addonDataManager
return addonDataManager._installedAddonsCache.installedAddons[self.name].manifest
@dataclasses.dataclass(frozen=True) # once created, it should not be modified.
class AddonStoreModel(_AddonStoreModel):
"""
Data from an add-on from the add-on store.
"""
addonId: str
displayName: str
description: str
publisher: str
addonVersionName: str
channel: Channel
homepage: Optional[str]
license: str
licenseURL: Optional[str]
sourceURL: str
URL: str
sha256: str
addonVersionNumber: MajorMinorPatch
minNVDAVersion: MajorMinorPatch
lastTestedVersion: MajorMinorPatch
reviewURL: Optional[str]
legacy: bool = False
"""
Legacy add-ons contain invalid metadata
and should not be accessible through the add-on store.
"""
@dataclasses.dataclass
class CachedAddonsModel:
cachedAddonData: "AddonGUICollectionT"
cacheHash: Optional[str]
cachedLanguage: str
# AddonApiVersionT or the string .network._LATEST_API_VER
nvdaAPIVersion: Union[addonAPIVersion.AddonApiVersionT, str]
def _createInstalledStoreModelFromData(addon: Dict[str, Any]) -> InstalledAddonStoreModel:
return InstalledAddonStoreModel(
addonId=addon["addonId"],
publisher=addon["publisher"],
channel=Channel(addon["channel"]),
addonVersionName=addon["addonVersionName"],
addonVersionNumber=MajorMinorPatch(**addon["addonVersionNumber"]),
homepage=addon.get("homepage"),
license=addon["license"],
licenseURL=addon.get("licenseURL"),
sourceURL=addon["sourceURL"],
URL=addon["URL"],
sha256=addon["sha256"],
minNVDAVersion=MajorMinorPatch(**addon["minNVDAVersion"]),
lastTestedVersion=MajorMinorPatch(**addon["lastTestedVersion"]),
reviewURL=addon.get("reviewURL"),
legacy=addon.get("legacy", False),
)
def _createStoreModelFromData(addon: Dict[str, Any]) -> AddonStoreModel:
return AddonStoreModel(
addonId=addon["addonId"],
displayName=addon["displayName"],
description=addon["description"],
publisher=addon["publisher"],
channel=Channel(addon["channel"]),
addonVersionName=addon["addonVersionName"],
addonVersionNumber=MajorMinorPatch(**addon["addonVersionNumber"]),
homepage=addon.get("homepage"),
license=addon["license"],
licenseURL=addon.get("licenseURL"),
sourceURL=addon["sourceURL"],
URL=addon["URL"],
sha256=addon["sha256"],
minNVDAVersion=MajorMinorPatch(**addon["minNVDAVersion"]),
lastTestedVersion=MajorMinorPatch(**addon["lastTestedVersion"]),
reviewURL=addon.get("reviewUrl"),
legacy=addon.get("legacy", False),
)
def _createGUIModelFromManifest(addon: "AddonHandlerBaseModel") -> AddonManifestModel:
homepage: Optional[str] = addon.manifest.get("url")
if homepage == "None":
# Manifest strings can be set to "None"
homepage = None
return AddonManifestModel(
addonId=addon.name,
channel=Channel.EXTERNAL,
addonVersionName=addon.version,
homepage=homepage,
minNVDAVersion=MajorMinorPatch(*addon.minimumNVDAVersion),
lastTestedVersion=MajorMinorPatch(*addon.lastTestedNVDAVersion),
manifest=addon.manifest,
)
def _createAddonGUICollection() -> "AddonGUICollectionT":
"""
Add-ons that have the same ID except differ in casing cause a path collision,
as add-on IDs are installed to a case insensitive path.
Therefore addon IDs should be treated as case insensitive.
"""
return {
channel: CaseInsensitiveDict()
for channel in Channel
if channel != Channel.ALL
}
def _createStoreCollectionFromJson(jsonData: str) -> "AddonGUICollectionT":
"""Use json string to construct a listing of available addons.
See https://github.com/nvaccess/addon-datastore#api-data-generation-details
for details of the data.
"""
data: List[Dict[str, Any]] = json.loads(jsonData)
addonCollection = _createAddonGUICollection()
for addon in data:
addonCollection[addon["channel"]][addon["addonId"]] = _createStoreModelFromData(addon)
return addonCollection