https://www.programmersought.com/article/74726500719/
IconOverlay implemented by Python, providing dynamic icon switching and refresh support


Development Platform

• windows10
• python3.8
• pywin32
  

background knowledge

Icon overlay concept:Controversy over IconOverlay in Windows
Widows implementation:How to overlay an icon over existing shell objects
Python implementation:Add my own icon overlays
SHChangeNotify:SHChangeNotify

Problems with existing articles

inAdd my own icon overlaysThe author provides the code to implement the icon overlay function under python, but there are two problems

• Does not explain how to realize the judgment and reality of different overlay icons under different conditions when there are multiple icons
• There is no illustration on how to dynamically implement icon overlay switching and refreshing. For example, the icon overlay status in the current file explorer is in synchronization, how to use application code to control the icon overlay to the synchronization completion, and actively refresh the icon display in the user file resource browser Without requiring the user to manually refresh
  

solutionMultiple icon overlays to realize condition judgment

Create multiple IconOverlay classes and register them at the same time, one IconOverlay class corresponds to one icon
Note that multiple IconOverlay classes must be differentreg_clsid Properties and thenGetOverlayInfo Different icons are returned in the method, and then inIsMemberOf The method returns whether to display the icon according to different conditions
My implementation is inIsMemberOf In the method, a file status table of the sqlite database is queried, and according to the file path in the table and the corresponding file status, it is determined which icon is displayed for the file

1. import os
   
2. import winreg
   
3. import sqlite3
   
4. import winerror
   
5. import win32con
   
6. // Pay attention to the import path here, the path of the old version of pywin32 is different
   
7. from win32comext.shell import shell, shellcon
   
8. 
   
9. 
   
10. class IconOverlayOk:
    
11.     """
    
12.          Icon overlay component
    
13.          The IShellIconOverlayIdentifier interface under the windows shell is used to implement the icon overlay function
    
14.          The following steps are required to implement functions in python
    
15.          1. Use pywin32 to write python class to implement windows com components
    
16.          2. Register the component to the windows system
    
17.          3. Add the icon overlay component item in the registry
    
18.          4. Restart explorer.exe
    
19. 
    
20.          When the windows file explorer browses the file
    
21.          1. Explorer will call the IsMemberOf method of IShellIconOverlayIdentifier for each file currently to be displayed to determine whether the file needs to be processed
    
22.          2. If IsMemberOf returns winerror.S_OK, the system will continue to call the GetOverlayInfo method to obtain the icon file to be superimposed
    
23.          3. The operating system is responsible for superimposing the icon returned by GetOverlayInfo onto the original icon of the file
    
24. 
    
25.          _reg_remove_keys_: When uninstalling the component, the registry keys that need to be deleted at the same time. Here, add a space prefix to the last registry key name to ensure the priority of the icon overlay component and avoid other icon overlay programs such as oneDriver, Nut Cloud Unsuccessful competition causes the icon overlay to fail
    
26. 
    
27.     """
    
28.     _reg_clsid_ = '{EA258179-A91D-45F9-A237-FC92A5290423}'
    
29.     _reg_progid_ = 'SUN.PythonPackagesOverlayHandlerOK'
    
30.     _reg_desc_ = 'Icon Overlay Handler to indicate Python packages'
    
31.     _public_methods_ = ['GetOverlayInfo', 'GetPriority', 'IsMemberOf']
    
32.     _com_interfaces_ = [shell.IID_IShellIconOverlayIdentifier]
    
33.     _reg_remove_keys_ = [(r'Software\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers\     PyPackageOverlay1',
    
34.         win32con.HKEY_LOCAL_MACHINE)]
    
35. 
    
36.     def GetOverlayInfo(self):
    
37.         """
    
38.                  Get the location of the icon file to be superimposed
    
39.                  Obtain the icon file path iconPath from the registry
    
40.         :return:
    
41.         """
    
42.         key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r'Software\Dachengyun')
    
43.         iconPath, index = winreg.QueryValueEx(key, 'iconPath')
    
44.         key.Close()
    
45.         return os.path.join(iconPath, 'Ok.ico'), 0, shellcon.ISIOI_ICONFILE
    
46. 
    
47.     def GetPriority(self):
    
48.         return 1
    
49. 
    
50.     def IsMemberOf(self, fname, attributes):
    
51.         """
    
52.                  Determine whether to overwrite the file icon
    
53. 
    
54.                  Read the synchronization folder path syncPath, sqlite database file path dbPath from the registry
    
55.                  If the current file is under syncPath, go to db to query the file synchronization status
    
56.                  Determine whether icon overlay is needed according to the file synchronization status
    
57.         :param fname:
    
58.         :param attributes:
    
59.         :return:
    
60.         """
    
61.         key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r'Software\Dachengyun')
    
62.         syncPath, index = winreg.QueryValueEx(key, 'syncPath')
    
63.         dbPath, index = winreg.QueryValueEx(key, 'dbPath')
    
64.         key.Close()
    
65.         if fname.startswith(syncPath):
    
66.             filePath = fname[len(os.path.dirname(syncPath)):]
    
67.             conn = sqlite3.connect(dbPath)
    
68.             c = conn.cursor()
    
69.             c.execute('SELECT state FROM file_sync_state WHERE path=:filePath', {'filePath': filePath})
    
70.             r = c.fetchone()
    
71.             c.close()
    
72.             conn.close()
    
73.             if r is not None and r[0] == 1:
    
74.                 return winerror.S_OK
    
75.         return winerror.E_FAIL
    
76. 
    
77. 
    
78. class IconOverlaySync:
    
79.     _reg_clsid_ = '{EA258179-A92D-45F9-A237-FC92A5290423}'
    
80.     _reg_progid_ = 'SUN.PythonPackagesOverlayHandlerSync'
    
81.     _reg_desc_ = 'Icon Overlay Handler to indicate Python packages'
    
82.     _public_methods_ = ['GetOverlayInfo', 'GetPriority', 'IsMemberOf']
    
83.     _com_interfaces_ = [shell.IID_IShellIconOverlayIdentifier]
    
84.     _reg_remove_keys_ = [(r'Software\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers\     PyPackageOverlay2',
    
85.         win32con.HKEY_LOCAL_MACHINE)]
    
86. 
    
87.     def GetOverlayInfo(self):
    
88.         key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r'Software\Dachengyun')
    
89.         iconPath, index = winreg.QueryValueEx(key, 'iconPath')
    
90.         key.Close()
    
91.         return os.path.join(iconPath, 'Sync.ico'), 0, shellcon.ISIOI_ICONFILE
    
92. 
    
93.     def GetPriority(self):
    
94.         return 2
    
95. 
    
96.     def IsMemberOf(self, fname, attributes):
    
97. 
    
98.         key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r'Software\Dachengyun')
    
99.         syncPath, index = winreg.QueryValueEx(key, 'syncPath')
    
100.         dbPath, index = winreg.QueryValueEx(key, 'dbPath')
     
101.         key.Close()
     
102.         if fname.startswith(syncPath):
     
103.             filePath = fname[len(os.path.dirname(syncPath)):]
     
104.             conn = sqlite3.connect(dbPath)
     
105.             c = conn.cursor()
     
106.             c.execute('SELECT state FROM file_sync_state WHERE path=:filePath',
     
107.                       {'filePath': filePath})
     
108.             r = c.fetchone()
     
109.             c.close()
     
110.             conn.close()
     
111.             if r is not None and r[0] == 2:
     
112.                 return winerror.S_OK
     
113.         return winerror.E_FAIL
     
114. 
     

复制代码

Dynamic icon switching and refresh

The dynamic switching of icons only needs to modify the file status table data in the sqlite database in the external application code.
But this can only achieve the switching of icon overlays, not dynamic refresh; that is, when the user browses the file in the file explorer, if the current icon overlay file is being displayed, even if we re If the file status is changed in the database, the icon overlay will not be dynamically refreshed. You must manually refresh the file explorer or exit the folder and re-enter to see the changed overlay icon
The solution is to useSHChangeNotify To notify the operating system that the file has changed, so that the operating system does an active refresh

1. //  Pay attention to the introduction here, the introduction path of the old version of pywin32 seems to be different, which is prone to errors
   
2. from win32comext.shell import shell, shellcon
   
3. //  syncPath is the absolute path of the file to be refreshed
   
4. shell.SHChangeNotify(shellcon.SHCNE_ATTRIBUTES,
   
5.                      shellcon.SHCNF_PATH | shellcon.SHCNF_FLUSHNOWAIT,
   
6.                      bytes(syncPath, 'gbk'), None)
   

复制代码

Component registration uninstallation and explorer.exe restart

After the IconOverlay class is written, it needs to be registered to the windows system. The code is as follows

1. import os
   
2. import win32api
   
3. import win32con
   
4. from win32com.server import register
   
5. import iconOverlay
   
6. //  Multiple icons need to copy the following code, and register multiple classes after modifying the class name
   
7. register.UseCommandLine(iconOverlay.IconOverlayOk)
   
8. win32api.RegSetValue(win32api.RegCreateKey(iconOverlay.IconOverlayOk._reg_remove_keys_[0][1],iconOverlay.IconOverlayOk._reg_remove_keys_[0][0]),
   
9.                      None, win32con.REG_SZ,
   
10.                      iconOverlay.IconOverlayOk._reg_clsid_)
    
11. register.UseCommandLine(iconOverlay.IconOverlaySync)
    
12. win32api.RegSetValue(win32api.RegCreateKey(iconOverlay.IconOverlaySync._reg_remove_keys_[0][1],iconOverlay.IconOverlaySync._reg_remove_keys_[0][0]),
    
13.                      None, win32con.REG_SZ,
    
14.                      iconOverlay.IconOverlaySync._reg_clsid_)
    
15. //  Explorer needs to be restarted after component registration is complete.exe makes the component effective               
    
16. os.system('taskkill /f /im explorer.exe & start explorer.exe')
    

复制代码

Component uninstall

1. import win32com.server.register
   
2. win32com.server.register.UnregisterClasses(iconOverlay.IconOverlayOk)
   
3. win32com.server.register.UnregisterClasses(iconOverlay.IconOverlaySync)
   
4. os.system('taskkill /f /im explorer.exe & start explorer.exe')
   

复制代码

https://stackoverflow.com/questi ... ntifiergetoverlayin

https://stackoverflow.com/questi ... l/29791270#29791270



https://github.com/MicrosoftDocs ... overlay-handlers.md


https://www.programmersought.com/article/74726500719/

https://www.codeproject.com/Arti ... sting-shell-objects


https://www.codeproject.com/Arti ... riting-Shell-Extens

使用ATL向导的话，会在resource中产生一个rgs的注册脚本文件放在"REGISTRY"目录中用来注册组件,会在程序中通过函数DECLARE_REGISTRY_RESOURCEID(IDR_OPCSERVER)使用,IDR_OPCSERVER就是向导产生的资源文件的ID，当服务器调用CComModule::RegisterServer()时，便会使用这些脚本来载入注册表的设置，并在调用CComModule::UnregisterServer()时移除它们。所有COM的注册键都放在HKEY_CLASSES_ROOT中。

https://blog.csdn.net/idiszerg/article/details/3875934

一般是由于 安装其他的 状态图标叠加程序导致的， 比如 微软的onedriver 或者 金山快盘   之类的工具， 可以把
注册表里面HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers
里面的除了  TortoiseSVN 之类的有关的可以删掉。
然后重启你的桌面。 就可以解决了。

转载于:https://my.oschina.net/zhuhj/blog/336020