"""Windows known folders collector."""
from winregrc import interface
[docs]
class KnownFolder:
"""Known folder.
Attributes:
alternate_display_names (list[str]): alternate display names.
identifier (str): identifier.
localized_display_name (str): localized display name.
display_name (str): display name.
"""
[docs]
def __init__(self, identifier, display_name, localized_display_name):
"""Initializes a known folder.
Args:
identifier (str): identifier.
display_name (str): display name.
localized_display_name (str): localized display name.
"""
super().__init__()
self.alternate_display_names = []
self.identifier = identifier
self.localized_display_name = localized_display_name
self.display_name = display_name
[docs]
class KnownFoldersCollector(interface.WindowsRegistryKeyCollector):
"""Windows known folders collector."""
_FOLDER_DESCRIPTIONS_KEY_PATH = (
"HKEY_LOCAL_MACHINE\\Software\\Microsoft\\Windows\\CurrentVersion\\"
"Explorer\\FolderDescriptions"
)
def _CollectKnownFolders(self, folder_descriptions_key):
"""Collects Windows known folders.
Args:
folder_descriptions_key (dfwinreg.WinRegistryKey): folder descriptions
Windows Registry key.
Yields:
KnownFolder: a known folder.
"""
for subkey in folder_descriptions_key.GetSubkeys():
identifier = subkey.name.lower()
display_name = self._GetValueFromKey(subkey, "Name")
localized_display_name = self._GetValueFromKey(subkey, "LocalizedName")
yield KnownFolder(identifier, display_name, localized_display_name)
[docs]
def Collect(self, registry):
"""Collects Windows known folders.
Args:
registry (dfwinreg.WinRegistry): Windows Registry.
Yields:
KnownFolder: a known folder.
"""
folder_descriptions_key = registry.GetKeyByPath(
self._FOLDER_DESCRIPTIONS_KEY_PATH
)
if folder_descriptions_key:
yield from self._CollectKnownFolders(folder_descriptions_key)