Set AppUserModelId on Windows shortcuts (#133)

* add windows field for AppUserModelID

* pre-commit

* add missing headers?

* hr -> hres

* do not use U8toWs

* missing arg

* add tmate on failure

* pre-commit

* remove tmate

* add news

.github/workflows/tests.yml

@@ -80,7 +80,7 @@ jobs:
       - shell: bash -el {0}
         name: Run test suite
         run: |
-          python -I -m pytest tests/ --cov-append --cov-report=xml --cov=menuinst
+          python -I -m pytest tests/ --cov-append --cov-report=xml --cov=menuinst -vvv
 
       - uses: codecov/codecov-action@v1
         with:

menuinst/_schema.py

@@ -74,6 +74,16 @@ class Windows(BasePlatformSpecific):
     "URL protocols that will be associated with this program."
     file_extensions: Optional[List[constr(regex=r"\.\S*")]] = None
     "File extensions that will be associated with this program."
+    app_user_model_id: Optional[constr(regex=r"\S+\.\S+", max_length=128)] = None
+    """
+    Identifier used in Windows 7 and above to associate processes, files and windows with a
+    particular application. If your shortcut produces duplicated icons, you need to define this
+    field. If not set, it will default to ``Menuinst.<name>``.
+
+    See `AppUserModelID docs <aumi-docs>`__ for more information on the required string format.
+
+    .. aumi-docs: https://learn.microsoft.com/en-us/windows/win32/shell/appids#how-to-form-an-application-defined-appusermodelid
+    """
 
 
 class Linux(BasePlatformSpecific):

menuinst/data/menuinst.default.json

@@ -57,7 +57,8 @@
           "desktop": true,
           "quicklaunch": true,
           "url_protocols": null,
-          "file_extensions": null
+          "file_extensions": null,
+          "app_user_model_id": null
         }
       }
     }

menuinst/data/menuinst.schema.json

@@ -581,6 +581,12 @@
             "type": "string",
             "pattern": "\\.\\S*"
           }
+        },
+        "app_user_model_id": {
+          "title": "App User Model Id",
+          "maxLength": 128,
+          "pattern": "\\S+\\.\\S+",
+          "type": "string"
         }
       },
       "additionalProperties": false

menuinst/platforms/win.py

@@ -152,14 +152,16 @@ def create(self) -> Tuple[Path, ...]:
             # winshortcut is a windows-only C extension! create_shortcut has this API
             # Notice args must be passed as positional, no keywords allowed!
             # winshortcut.create_shortcut(path, description, filename, arguments="",
-            #                             workdir=None, iconpath=None, iconindex=0)
+            #                             workdir=None, iconpath=None, iconindex=0, app_id="")
             create_shortcut(
                 target_path,
                 self._shortcut_filename(ext=""),
                 str(path),
                 " ".join(arguments),
                 working_dir,
                 icon,
+                0,
+                self._app_user_model_id(),
             )
 
         self._register_file_extensions()
@@ -389,3 +391,9 @@ def _unregister_url_protocols(self):
         for protocol in protocols:
             identifier = self._ftype_identifier(protocol)
             unregister_url_protocol(protocol, identifier, mode=self.menu.mode)
+
+    def _app_user_model_id(self):
+        aumi = self.render_key("app_user_model_id")
+        if not aumi:
+            return f"Menuinst.{self.render_key('name', slug=True).replace('.', '')}"[:128]
+        return aumi

news/133-app-user-model-id

@@ -0,0 +1,19 @@
+### Enhancements
+
+* Add `app_user_model_id` field on Windows shortcuts to group taskbar icons together. (#127 via #133)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>

src/winshortcut.cpp

@@ -15,6 +15,8 @@
 #include <objbase.h>
 #include <shlobj.h>
 #include <objidl.h>
+#include <propvarutil.h>
+#include <propkey.h>
 #include "resource.h"
 
 #include <stdio.h>
@@ -38,10 +40,13 @@ static PyObject *CreateShortcut(PyObject *self, PyObject *args)
     Py_UNICODE *iconpath = NULL;
     int iconindex = 0;
     Py_UNICODE *workdir = NULL;
+    Py_UNICODE *app_id = NULL;
 
     IShellLink *pShellLink = NULL;
     IPersistFile *pPersistFile = NULL;
+    IPropertyStore *pPropertyStore = NULL;
 
+    PROPVARIANT pv;
     HRESULT hres;
 
     hres = CoInitialize(NULL);
@@ -51,9 +56,9 @@ static PyObject *CreateShortcut(PyObject *self, PyObject *args)
         goto error;
     }
 
-    if (!PyArg_ParseTuple(args, "uuu|uuui",
+    if (!PyArg_ParseTuple(args, "uuu|uuuiu",
                           &path, &description, &filename,
-                          &arguments, &workdir, &iconpath, &iconindex)) {
+                          &arguments, &workdir, &iconpath, &iconindex, &app_id)) {
         return NULL;
     }
 
@@ -116,6 +121,25 @@ static PyObject *CreateShortcut(PyObject *self, PyObject *args)
         }
     }
 
+    if (app_id) {
+        hres = pShellLink->QueryInterface(IID_PPV_ARGS(&pPropertyStore));
+        if (FAILED(hres)) {
+            PyErr_Format(PyExc_OSError,
+                           "QueryInterface(IPropertyStore) error 0x%x", hres);
+            goto error;
+        }
+        hres = InitPropVariantFromString(app_id, &pv);
+        if (FAILED(hres)) {
+            PyErr_Format(PyExc_OSError,
+                           "InitPropVariantFromString() error 0x%x", hres);
+            goto error;
+        }
+        pPropertyStore->SetValue(PKEY_AppUserModel_ID, pv);
+        pPropertyStore->Commit();
+        PropVariantClear(&pv);
+        pPropertyStore->Release();
+    }
+
     hres = pPersistFile->Save(filename, TRUE);
     if (FAILED(hres)) {
         PyObject *fn = PyUnicode_FromWideChar(filename, wcslen(filename));
@@ -145,6 +169,9 @@ static PyObject *CreateShortcut(PyObject *self, PyObject *args)
     if (pShellLink) {
         pShellLink->Release();
     }
+    if (pPropertyStore) {
+        pPropertyStore->Release();
+    }
 
     CoUninitialize();
     return NULL;