o TjA @sUdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z m Z ddl mZe r7dd lmZd Zd ed <Gd ddeZd7ddZd8ddZd9ddZd7ddZddddd d!d"d#d$d%d&d' Zd(ed)<ed:d+d,Zd7d-d.Zd:d/d0ZeZd7d1d2Zd;d5d6ZdgZdS)ZedAd?d@Z dS)CWindowsa`MSDN on where to store app data files `_. Makes use of the `appname `, `appauthor `, `version `, `roaming `, `opinion `, `ensure_exists `. returnstrcCs(|jrdnd}tjt|}||S)zData directory tied to the user, e.g. ``%USERPROFILE%\AppData\Local\$appauthor\$appname`` (not roaming) or ``%USERPROFILE%\AppData\Roaming\$appauthor\$appname`` (roaming). CSIDL_APPDATACSIDL_LOCAL_APPDATA)roamingospathnormpathget_win_folder _append_parts)selfconstrrW/home/dinkstrade/pdmp-scanner/venv/lib/python3.10/site-packages/platformdirs/windows.py user_data_dirs zWindows.user_data_dirN opinion_valuerr str | NonecCsg}|jr0|jdur|jp|j}||||j|dur'|jr'|||jr0||jtjj|g|R}|||S)NF) appname appauthorappendopinionversionrrjoin_optionally_create_directory)rrrparamsauthorrrrr&s       zWindows._append_partscCstjtd}||S)zLData directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname``.CSIDL_COMMON_APPDATArrrrrrrrrr site_data_dir5s zWindows.site_data_dircC|jS)z;Config directory tied to the user, same as `user_data_dir`.rrrrruser_config_dir;zWindows.user_config_dircCr+)z:Config directory shared by users, same as `site_data_dir`.r*r-rrrsite_config_dir@r/zWindows.site_config_dircCtjtd}|j|ddS)zCache directory tied to the user (if opinionated with ``Cache`` folder within ``$appname``) e.g. ``%USERPROFILE%\AppData\Local\$appauthor\$appname\Cache\$version``.rCacherr(r)rrruser_cache_dirEzWindows.user_cache_dircCr2)z\Cache directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname\Cache\$version``.r'r3rr(r)rrrsite_cache_dirKr5zWindows.site_cache_dircCr+)z:State directory tied to the user, same as `user_data_dir`.r,r-rrruser_state_dirQr/zWindows.user_state_dircCr+)z9State directory shared by users, same as `site_data_dir`.r0r-rrrsite_state_dirVr/zWindows.site_state_dircC(|j}|jrtj|d}|||S)z_Log directory tied to the user, same as `user_data_dir` if not opinionated else ``Logs`` in it.Logs)rr!rrr#r$r)rrr user_log_dir[  zWindows.user_log_dircCr9)z^Log directory shared by users, same as `site_data_dir` if not opinionated else ``Logs`` in it.r:)r*r!rrr#r$r)rrr site_log_dirdr<zWindows.site_log_dircCtjtdS)zFDocuments directory tied to the user e.g. ``%USERPROFILE%\Documents``.CSIDL_PERSONALrrrrr-rrruser_documents_dirmzWindows.user_documents_dircCr>)zFDownloads directory tied to the user e.g. ``%USERPROFILE%\Downloads``.CSIDL_DOWNLOADSr@r-rrruser_downloads_dirrrBzWindows.user_downloads_dircCr>)zDPictures directory tied to the user e.g. ``%USERPROFILE%\Pictures``.CSIDL_MYPICTURESr@r-rrruser_pictures_dirwrBzWindows.user_pictures_dircCr>)z@Videos directory tied to the user e.g. ``%USERPROFILE%\Videos``. CSIDL_MYVIDEOr@r-rrruser_videos_dir|rBzWindows.user_videos_dircCr>)z>Music directory tied to the user e.g. ``%USERPROFILE%\Music``. CSIDL_MYMUSICr@r-rrruser_music_dirrBzWindows.user_music_dircCr>)zCDesktop directory tied to the user, e.g. ``%USERPROFILE%\Desktop``.CSIDL_DESKTOPDIRECTORYr@r-rrruser_desktop_dirrBzWindows.user_desktop_dircCstjtjdS)zEProjects directory tied to the user, e.g. ``%USERPROFILE%\Projects``.z ~/Projects)rrr expanduserr-rrruser_projects_dirszWindows.user_projects_dircCs2tjd}sttdjd}tj|S)z0Public share directory e.g. ``C:\Users\Public``.PUBLIC~Public) renvirongetr rrMparentrrr)rrruser_publicshare_dirs zWindows.user_publicshare_dircC$tjtttddddS)zTTemplates directory tied to the user e.g. ``%APPDATA%\Microsoft\Windows\Templates``.r Microsoftr Templatesrrrr rrr-rrruser_templates_dir$zWindows.user_templates_dircCrV)zQFonts directory tied to the user e.g. ``%LOCALAPPDATA%\Microsoft\Windows\Fonts``.rrWr FontsrYr-rrruser_fonts_dirr[zWindows.user_fonts_dircCr+)zCPreference directory tied to the user, same as ``user_config_dir``.)r.r-rrruser_preference_dirr/zWindows.user_preference_dircCtjtjtddS)zABin directory tied to the user, e.g. ``%LOCALAPPDATA%\Programs``.rProgramsrrrr#rr-rrr user_bin_dirzWindows.user_bin_dircCr_)z;Bin directory shared by users, e.g. ``C:\ProgramData\bin``.r'binrar-rrr site_bin_dirrczWindows.site_bin_dircCr>)zFApplications directory tied to the user, e.g. ``Start Menu\Programs``.CSIDL_PROGRAMSr@r-rrruser_applications_dirrBzWindows.user_applications_dircCr>)zfApplications directory shared by users, e.g. ``C:\ProgramData\Microsoft\Windows\Start Menu\Programs``.CSIDL_COMMON_PROGRAMSr@r-rrrsite_applications_dirrBzWindows.site_applications_dircCs$tjtjtdd}||S)zbRuntime directory tied to the user, e.g. ``%USERPROFILE%\AppData\Local\Temp\$appauthor\$appname``.rTemp)rrrr#rrr)rrruser_runtime_dirs zWindows.user_runtime_dircCr+)z>Runtime directory shared by users, same as `user_runtime_dir`.)rkr-rrrsite_runtime_dirr/zWindows.site_runtime_dir)r r )rr rrr r )!__name__ __module__ __qualname____doc__propertyrrr*r.r1r4r6r7r8r;r=rArDrFrHrJrLrNrUrZr]r^rbrergrirkrlrrrrr sr                          r csidl_namer r cCsft|}|dur |Sdddd|}|dur d|}t|tj|}s1d|}t||S)z&Get folder from environment variables.NAPPDATAALLUSERSPROFILE LOCALAPPDATA)rr'rUnknown CSIDL name: zUnset environment variable: )(get_win_folder_if_csidl_name_not_env_varrS ValueErrorrrR)rrresult env_var_namemsgrrrget_win_folder_from_env_varss   r|rcCs4|dkrtjtjtddS|dkr"tjtjtddS|dkr3tjtjtddS|dkrDtjtjtdd S|d krUtjtjtdd S|d krftjtjtdd S|dkrztjtjtdddddS|dkrtjtjtjdptjdpdddddSdS)zMGet a folder for a CSIDL name that does not exist as an environment variable.r? USERPROFILE DocumentsrC DownloadsrEPicturesrGVideosrIMusicrKDesktoprfrsrWr z Start Menur`rh PROGRAMDATArtzC:\ProgramDataN)rrr#r_non_empty_envrRrSrrrrrrws:"rwnamecCstj|}r |St|)N)rrRrSKeyError)rvaluerrrrsrc Csddh}ddddddd d d d d d |}|dur"d|}t|tjdkr)tddl}||vr4|jn|j}||d}| ||\}}Wdt |S1sSwYt |S)zGet folder from the registry. This is a fallback technique at best. I'm not sure if using the registry for these guarantees us the correct answer for all CSIDL_* names. r'rhAppDatazCommon AppDataz Local AppDataPersonal&{374DE290-123F-4565-9164-39C4925E467B}z My PictureszMy VideozMy Musicrr`zCommon Programs) rr'rr?rCrErGrIrKrfrhNrvwin32rz@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders) rSrxsysplatformNotImplementedErrorwinregHKEY_LOCAL_MACHINEHKEY_CURRENT_USEROpenKey QueryValueExr ) rr machine_namesshell_folder_namer{rhkeykey directory_rrrget_win_folder_from_registrys<    rz&{3EB685DB-65F9-4CF6-A03A-E3EF65729F3D}z&{62AB5D82-FDC1-4DC3-A9DD-070D1D495D97}z&{F1B32785-6FBA-4FCF-9D55-7B8E7F157091}z&{FDD39AD0-238F-46AF-ADB4-6C85480369C7}z&{33E28130-4E1E-4676-835A-98395C3BC3BB}z&{18989B1D-99B5-455B-841C-AB7C74E4DDFC}z&{4BD8D571-6D19-48D3-BE97-422220080E43}rz&{B4BFCC3A-DB2C-424C-B029-7FE99A87C641}z&{A77F5D77-2E2B-44C3-A6A2-ABA601054A51}z&{0139D44E-6AFE-49F2-8690-3DAFCAE6FFB8}) rr'rr?rErGrIrCrKrfrhzdict[str, str]_KNOWN_FOLDER_GUIDSCallable[[str], str]cstjdkrtddlm}m}m}m}mm Gfddd||d|j _ j |gj _ dj_ jgj_ |d|j_ |jj|jgj_ dfd d }|S)zBuild the resolver once; a fresh ``_GUID`` per call leaks ctypes pointer types. See https://github.com/tox-dev/platformdirs/issues/501. rr)HRESULTPOINTER StructureWinDLLbyrefwintypescs4eZdZdjfdjfdjfdjdfgZdS)z/_build_get_win_folder_via_ctypes.._GUIDData1Data2Data3Data4N)rmrnroDWORDWORDBYTE_fields_r)rrr_GUIDPs  role32Nshell32rrr r cst|}|durd|}t|}||}|td||j}||durBd|}t||S)Nrvz'SHGetKnownFolderPath returned NULL for ) rrSrxCLSIDFromStringLPWSTRSHGetKnownFolderPathr r CoTaskMemFree)rr folder_guidr{guidpath_ptrryrrrrrrrresolvebs    z1_build_get_win_folder_via_ctypes..resolverrr r r )rrrctypesrrrrrrrrestype LPCOLESTRargtypesrLPVOIDrrHANDLEr)rrrrrrrr _build_get_win_folder_via_ctypes>s    rcCs t|S)zGet folder via :func:`SHGetKnownFolderPath`. See https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shgetknownfolderpath. )rrrrrget_win_folder_via_ctypesys rcCsHzddl}WtStyYnwzddl}WtSty#tYSw)zjSelect the best method to resolve Windows folder paths: ctypes, then registry, then environment variables.rN)r ImportErrorrrr|r)rrrrr_pick_get_win_folders    rcCs6d|d}ttj|d}r|St|S)zGet a Windows folder path, checking for ``WIN_PD_OVERRIDE_*`` environment variable overrides first. For example, ``CSIDL_LOCAL_APPDATA`` can be overridden by setting ``WIN_PD_OVERRIDE_LOCAL_APPDATA``. WIN_PD_OVERRIDE_CSIDL_) removeprefix_is_fully_qualifiedrrRrSstrip_resolve_win_folder)rrenv_varoverriderrrrsrrboolcCs*t|\}}|dpt|o|dS)N)\/)ntpath splitdrive startswithr)rdrivetailrrrrsrr)rrr r r)rr r r )r r)rr r r) rp __future__rrrr functoolsrpathlibrtypingrrapircollections.abcr r __annotations__r r|rwrrrrrrrrr__all__rrrrsN       2  ( (  :