-
Notifications
You must be signed in to change notification settings - Fork 3
/
windowsapps.py
351 lines (301 loc) · 15.8 KB
/
windowsapps.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
from .lib import helper
import keypirinha as kp
import keypirinha_util as kpu
import subprocess
import os
import glob
import time
import json
import traceback
class WindowsApps(kp.Plugin):
"""Lists Universal Windows Apps (formerly Metro Apps) in Keypirinha for launching
"""
DEFAULT_ITEM_LABEL = "Windows App:"
DEFAULT_SHOW_MISC_APPS = False
DEFAULT_PREFERRED_CONTRAST = ""
STORE_PREFIX = "ms-windows-store://pdp/?PFN={}"
ACTION_RUN_NORMAL = "run_normal"
ACTION_RUN_ELEVATED = "run_elevated"
ACTION_OPEN_STORE_PAGE = "open_store_page"
def __init__(self):
"""Default constructor and initializing internal attributes
"""
super().__init__()
self._item_label = self.DEFAULT_ITEM_LABEL
self._show_misc_apps = self.DEFAULT_SHOW_MISC_APPS
self._preferred_contrast = self.DEFAULT_PREFERRED_CONTRAST
self._icon_handles = []
def _get_icon(self, name, icon_path):
"""Create a list of possible logo files to show as icon for a window app
"""
base_path = os.path.splitext(icon_path)
dirname = os.path.dirname(base_path[0])
basename = os.path.basename(base_path[0])
logos = []
logos.extend(glob.glob(icon_path))
logos.extend(glob.glob("{}.scale-*{}".format(base_path[0], base_path[1])))
logos.extend(glob.glob("{}/scale-*/{}{}".format(dirname, basename, base_path[1])))
logos.extend(glob.glob("{}.targetsize-*{}".format(base_path[0], base_path[1])))
logos.extend(glob.glob("{}.contrast-*{}".format(base_path[0], base_path[1])))
logos.extend(glob.glob("{}/contrast-*/{}{}".format(dirname, basename, base_path[1])))
logos.extend(glob.glob("{}/contrast-*/{}.contrast-*{}".format(dirname, basename, base_path[1])))
logos.extend(glob.glob("{}/contrast-*/{}.scale-*{}".format(dirname, basename, base_path[1])))
logos.extend(glob.glob("{}/contrast-*/{}.targetsize-*{}".format(dirname, basename, base_path[1])))
logos.extend(glob.glob("{}/contrast-*/scale-*/{}{}".format(dirname, basename, base_path[1])))
logos.extend(glob.glob("{}/scale-*/{}.contrast-*{}".format(dirname, basename, base_path[1])))
logos.extend(glob.glob("{}/scale-*/contrast-*/{}{}".format(dirname, basename, base_path[1])))
if self._preferred_contrast:
logos_preferred = [logo for logo in logos if "contrast-{}".format(self._preferred_contrast) in logo]
else:
logos_preferred = [logo for logo in logos if "contrast-" not in logo]
if logos_preferred:
logos = logos_preferred
self.dbg(name)
for logo in logos:
self.dbg("{}".format(logo))
if logos:
cached_logos = self._copy_files(name, logos)
handle = self.load_icon(cached_logos, force_reload=True)
self._icon_handles.append(handle)
return handle
def _copy_files(self, name, logos):
"""Copies the logos to the package cache and returns a list of keypirinha resource strings
"""
cached_logos = []
for logo in logos:
out_dir = os.path.join(self.get_package_cache_path(True), name)
if not os.path.isdir(out_dir):
os.mkdir(out_dir)
try:
out_path = os.path.join(out_dir, os.path.basename(logo))
if not os.path.isfile(out_path) or os.path.getsize(out_path) != os.path.getsize(logo):
with open(logo, "rb") as in_file, \
open(out_path, "wb") as out_file:
out_file.write(in_file.read())
cached_logos.append("cache://{}/{}/{}".format(self.package_full_name(),
name,
os.path.basename(logo)))
except Exception as ex:
self.warn(ex)
self.dbg(traceback.format_exc())
return cached_logos
def _read_config(self):
"""Reads the default action from the config
"""
self.dbg("Reading config")
settings = self.load_settings()
self._debug = settings.get_bool("debug", "main", False)
self._item_label = settings.get("item_label", "main", self.DEFAULT_ITEM_LABEL)
self.dbg("item_label =", self._item_label)
self._show_misc_apps = settings.get_bool("show_misc_apps", "main", self.DEFAULT_SHOW_MISC_APPS)
self.dbg("show_misc_apps =", self._show_misc_apps)
preferred_contrast_before = self._preferred_contrast
self._preferred_contrast = settings.get_enum("preferred_contrast",
"main",
self.DEFAULT_PREFERRED_CONTRAST,
["black", "white", ""])
self.dbg("preferred_contrast =", self._preferred_contrast)
preferred_contrast_after = self._preferred_contrast
if preferred_contrast_before != preferred_contrast_after:
self._clear_logo_cache()
def on_start(self):
"""Reads the config
"""
self._read_config()
actions = []
normal = self.create_action(
name=self.ACTION_RUN_NORMAL,
label=helper.AppXPackage.get_resource(os.path.join(os.environ["WINDIR"], "SystemResources"), helper.RESOURCE_OPEN),
)
actions.append(normal)
elevated = self.create_action(
name=self.ACTION_RUN_ELEVATED,
label=helper.AppXPackage.get_resource(os.path.join(os.environ["WINDIR"], "SystemResources"), helper.RESOURCE_RUN_AS_ADMIN),
)
actions.append(elevated)
open_store = self.create_action(
name=self.ACTION_OPEN_STORE_PAGE,
label="Open store page",
short_desc="Opens the product detail page of the package in the Microsoft Store app."
)
actions.append(open_store)
self.set_actions(kp.ItemCategory.CMDLINE, actions)
def on_events(self, flags):
"""Reloads the package config when its changed
"""
if flags & kp.Events.PACKCONFIG:
self._read_config()
self.on_catalog()
def on_catalog(self):
"""Catalogs items for keypirinha
Calls powershell to get a list of windows app packages with their properties
and creates catalog items for keypirinha.
"""
start_time = time.time()
self.dbg("Freeing", len(self._icon_handles), "icon handles")
for icon_handle in self._icon_handles:
icon_handle.free()
self._icon_handles.clear()
startupinfo = subprocess.STARTUPINFO()
startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
output, err = subprocess.Popen(["powershell.exe",
"-noprofile",
"chcp 65001 >$null; [Console]::OutputEncoding = [System.Text.UTF8Encoding]::new(); Get-AppxPackage | ConvertTo-Json"],
stdout=subprocess.PIPE,
universal_newlines=False,
shell=False,
startupinfo=startupinfo).communicate()
catalog = []
packages = json.loads(output.decode("utf8", "replace"))
for package in packages:
try:
catalog.extend(self._create_catalog_item(package))
except Exception as ex:
self.warn(ex)
self.dbg(traceback.format_exc())
self.set_catalog(catalog)
elapsed = time.time() - start_time
self.info("Cataloged {} items in {:0.1f} seconds".format(len(catalog), elapsed))
def _create_catalog_item(self, props):
try:
package = helper.AppXPackage(props)
# some packages can be just libraries with no executable application
# only take packages which have a application
apps = package.apps()
catalog_items = []
if apps:
self.dbg(package.InstallLocation)
for app in apps:
if not app.misc_app or self._show_misc_apps:
catalog_items.append(self.create_item(
category=kp.ItemCategory.CMDLINE,
label="{} {}".format(self._item_label, app.display_name).strip(),
short_desc=app.description
if app.description else app.display_name,
target=app.execution,
args_hint=kp.ItemArgsHint.FORBIDDEN,
hit_hint=kp.ItemHitHint.NOARGS,
icon_handle=self._get_icon(package.Name, app.icon_path),
data_bag=package.PackageFamilyName
))
return catalog_items
except Exception as exc:
if "Name" in props:
raise Exception("Error while creating catalog item for '{0}'".format(props["Name"])) from exc
else:
raise Exception("Error while creating catalog item for {0}".format(props)) from exc
def on_execute(self, item, action):
"""Starts the windows app
"""
self.dbg("Executing:", item.target(), action.name() if action else None)
if action and action.name() == self.ACTION_OPEN_STORE_PAGE:
pfn = item.data_bag()
self.dbg("PackageFamilyName", pfn, self.STORE_PREFIX.format(pfn))
kpu.shell_execute(self.STORE_PREFIX.format(pfn))
return
if not action or action.name() == self.ACTION_RUN_NORMAL:
verb = None
elif action.name() == self.ACTION_RUN_ELEVATED:
verb = "runas"
kpu.shell_execute(item.target(), verb=verb)
def _clear_logo_cache(self):
self.dbg("Clearing logo cache")
top = self.get_package_cache_path(False)
self.dbg("Cleaning up:", top)
try:
for root, dirs, files in os.walk(top, topdown=False):
for name in files:
path = os.path.join(root, name)
self.dbg("Removing file:", path)
os.remove(path)
for name in dirs:
path = os.path.join(root, name)
self.dbg("Removing dir:", path)
os.rmdir(path)
except Exception:
self.err(traceback.format_exc())
class ModernControlPanel(WindowsApps):
DEFAULT_DISABLE_SETTINGS = False
def __init__(self):
super().__init__()
self._disable_settings = self.DEFAULT_DISABLE_SETTINGS
def _read_config(self):
self.dbg("Reading config")
settings = self.load_settings()
self._debug = settings.get_bool("debug", "main", False)
self._preferred_contrast = settings.get_enum("preferred_contrast",
"main",
self.DEFAULT_PREFERRED_CONTRAST,
["black", "white"])
self.dbg("preferred_contrast =", self._preferred_contrast)
self._disable_settings = settings.get_bool("disable_settings", "main", self.DEFAULT_DISABLE_SETTINGS)
self.dbg("disable_settings =", self._disable_settings)
def on_catalog(self):
"""Catalogs items for keypirinha
Reads the settings.json and tries to make a item out of every entry.
If the "page_name" is defined, it's used to get the localized display name and description via the default
ms-resource: string.
Otherwise "display_name" and "description" are used to get the respective infos. These can be ms-resource: paths
or plain strings.
Whichever way the infos are obtained, display name has to be a not empty string.
(otherwise the item will not be cataloged)
"""
if self._disable_settings:
return
start_time = time.time()
catalog = []
try:
settings_str = self.load_text_resource("settings.json")
settings = json.loads(settings_str)
settings_resource_path = os.path.join(os.environ["WINDIR"], "SystemResources")
settings_icon_path = os.path.join(os.environ["WINDIR"], "ImmersiveControlPanel", "Images", "logo.png")
settings_label = helper.AppXPackage.get_resource(settings_resource_path, helper.RESOURCE_SETTINGS_TITLE)
settings_icon = self._get_icon("windows.immersivecontrolpanel", settings_icon_path)
for setting in settings:
try:
self.dbg("App Setting:", setting)
if "page_name" in setting and setting["page_name"]:
display_rsrc = helper.RESOURCE_ALT_DISPLAY_FORMAT.format(setting["page_name"])
display_name = helper.AppXPackage.get_resource(settings_resource_path, display_rsrc)
if not display_name:
display_rsrc = helper.RESOURCE_DISPLAY_FORMAT.format(setting["page_name"])
display_name = helper.AppXPackage.get_resource(settings_resource_path, display_rsrc)
desc_rsrc = helper.RESOURCE_DESC_FORMAT.format(setting["page_name"])
desc = helper.AppXPackage.get_resource(settings_resource_path, desc_rsrc)
else:
if "display_name" in setting:
if setting["display_name"].startswith(helper.RESOURCE_PREFIX):
display_name = helper.AppXPackage.get_resource(settings_resource_path,
setting["display_name"])
else:
display_name = setting["display_name"]
else:
display_name = ""
if "description" in setting:
if setting["description"].startswith(helper.RESOURCE_PREFIX):
desc = helper.AppXPackage.get_resource(settings_resource_path, setting["description"])
else:
desc = setting["description"]
else:
desc = ""
self.dbg("App Setting display_name", display_name)
self.dbg("App Setting description", desc)
if not display_name:
self.dbg("App Setting:", setting, "display name empty")
continue
catalog.append(self.create_item(
category=kp.ItemCategory.URL,
label="{}: {} ({})".format(settings_label, display_name, setting["settings_uri"]).strip(),
short_desc=desc if desc else "",
target=setting["settings_uri"],
args_hint=kp.ItemArgsHint.FORBIDDEN,
hit_hint=kp.ItemHitHint.NOARGS,
icon_handle=settings_icon
))
except Exception as ex:
self.warn("App Setting:", setting, "\n", ex)
except Exception as exc:
self.err(exc)
self.set_catalog(catalog)
elapsed = time.time() - start_time
self.info("Cataloged {} items in {:0.1f} seconds".format(len(catalog), elapsed))