
    1i8                        U d Z ddlmZ ddlZddlZddlmZmZ ddlm	Z	 erddl
mZ dZd	ed
<    G d de	          Zd&dZd'dZd&dZddddddddddddZd ed!<   d&d"Zd(d$Z e            Zd&d%ZdgZdS ))zWindows.    )annotationsN)TYPE_CHECKINGFinal   )PlatformDirsABC)Callablei @  z
Final[int]_KF_FLAG_DONT_VERIFYc                  0   e Zd ZdZed d            Zddd!d
Zed d            Zed d            Zed d            Z	ed d            Z
ed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            Zed d            ZdS )"Windowsa  `MSDN on where to store app data files <https://learn.microsoft.com/en-us/windows/win32/shell/knownfolderid>`_.

    Makes use of the `appname <platformdirs.api.PlatformDirsABC.appname>`, `appauthor
    <platformdirs.api.PlatformDirsABC.appauthor>`, `version <platformdirs.api.PlatformDirsABC.version>`, `roaming
    <platformdirs.api.PlatformDirsABC.roaming>`, `opinion <platformdirs.api.PlatformDirsABC.opinion>`, `ensure_exists
    <platformdirs.api.PlatformDirsABC.ensure_exists>`.

    returnstrc                    | j         rdnd}t          j                            t	          |                    }|                     |          S )z:returns: data directory tied to the user, e.g. ``%USERPROFILE%\AppData\Local\$appauthor\$appname`` (not roaming) or ``%USERPROFILE%\AppData\Roaming\$appauthor\$appname`` (roaming)CSIDL_APPDATACSIDL_LOCAL_APPDATA)roamingospathnormpathget_win_folder_append_parts)selfconstr   s      R/var/www/html/speakWrite/venv/lib/python3.11/site-packages/platformdirs/windows.pyuser_data_dirzWindows.user_data_dir   sF     $(<J5Jwu 5 566!!$'''    Nopinion_valuer   r   
str | Nonec               z   g }| j         r| j        dur#| j        p| j         }|                    |           |                    | j                    || j        r|                    |           | j        r|                    | j                   t          j        j        |g|R  }|                     |           |S )NF)	appname	appauthorappendopinionversionr   r   join_optionally_create_directory)r   r   r   paramsauthors        r   r   zWindows._append_parts#   s    < 	,~U**74<f%%%MM$,'''(T\(m,,,| ,dl+++w|D*6***))$///r   c                    t           j                            t          d                    }|                     |          S )zU:returns: data directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname``CSIDL_COMMON_APPDATAr   r   r   r   r   r   r   s     r   site_data_dirzWindows.site_data_dir2   s6     w/E F FGG!!$'''r   c                    | j         S )zD:returns: config directory tied to the user, same as `user_data_dir`r   r   s    r   user_config_dirzWindows.user_config_dir8        !!r   c                    | j         S )zC:returns: config directory shared by users, same as `site_data_dir`r-   r0   s    r   site_config_dirzWindows.site_config_dir=   r2   r   c                    t           j                            t          d                    }|                     |d          S )z:returns: cache directory tied to the user (if opinionated with ``Cache`` folder within ``$appname``) e.g. ``%USERPROFILE%\AppData\Local\$appauthor\$appname\Cache\$version``r   Cacher   r+   r,   s     r   user_cache_dirzWindows.user_cache_dirB   s;     w/D E EFF!!$g!>>>r   c                    t           j                            t          d                    }|                     |d          S )ze:returns: cache directory shared by users, e.g. ``C:\ProgramData\$appauthor\$appname\Cache\$version``r*   r7   r   r+   r,   s     r   site_cache_dirzWindows.site_cache_dirH   s;     w/E F FGG!!$g!>>>r   c                    | j         S )zC:returns: state directory tied to the user, same as `user_data_dir`r/   r0   s    r   user_state_dirzWindows.user_state_dirN   r2   r   c                    | j         S )zB:returns: state directory shared by users, same as `site_data_dir`r4   r0   s    r   site_state_dirzWindows.site_state_dirS   r2   r   c                    | j         }| j        r5t          j                            |d          }|                     |           |S )zh:returns: log directory tied to the user, same as `user_data_dir` if not opinionated else ``Logs`` in itLogs)r   r#   r   r   r%   r&   r,   s     r   user_log_dirzWindows.user_log_dirX   D     !< 	47<<f--D--d333r   c                    | j         }| j        r5t          j                            |d          }|                     |           |S )zg:returns: log directory shared by users, same as `site_data_dir` if not opinionated else ``Logs`` in itr@   )r-   r#   r   r   r%   r&   r,   s     r   site_log_dirzWindows.site_log_dira   rB   r   c                Z    t           j                            t          d                    S )zO:returns: documents directory tied to the user e.g. ``%USERPROFILE%\Documents``CSIDL_PERSONALr   r   r   r   r0   s    r   user_documents_dirzWindows.user_documents_dirj   #     w/? @ @AAAr   c                Z    t           j                            t          d                    S )zO:returns: downloads directory tied to the user e.g. ``%USERPROFILE%\Downloads``CSIDL_DOWNLOADSrG   r0   s    r   user_downloads_dirzWindows.user_downloads_diro   s#     w/@ A ABBBr   c                Z    t           j                            t          d                    S )zM:returns: pictures directory tied to the user e.g. ``%USERPROFILE%\Pictures``CSIDL_MYPICTURESrG   r0   s    r   user_pictures_dirzWindows.user_pictures_dirt   s#     w/A B BCCCr   c                Z    t           j                            t          d                    S )zI:returns: videos directory tied to the user e.g. ``%USERPROFILE%\Videos``CSIDL_MYVIDEOrG   r0   s    r   user_videos_dirzWindows.user_videos_diry   "     w ? ?@@@r   c                Z    t           j                            t          d                    S )zG:returns: music directory tied to the user e.g. ``%USERPROFILE%\Music``CSIDL_MYMUSICrG   r0   s    r   user_music_dirzWindows.user_music_dir~   rS   r   c                Z    t           j                            t          d                    S )zL:returns: desktop directory tied to the user, e.g. ``%USERPROFILE%\Desktop``CSIDL_DESKTOPDIRECTORYrG   r0   s    r   user_desktop_dirzWindows.user_desktop_dir   s#     w/G H HIIIr   c                    t           j                            t           j                            t	          d          d                    S )zJ:returns: bin directory tied to the user, e.g. ``%LOCALAPPDATA%\Programs``r   Programsr   r   r   r%   r   r0   s    r   user_bin_dirzWindows.user_bin_dir   s4     w^<Q-R-RT^ _ _```r   c                    t           j                            t           j                            t	          d          d                    S )zC:returns: bin directory shared by users, e.g. ``C:\ProgramDatain``r*   binr\   r0   s    r   site_bin_dirzWindows.site_bin_dir   s4     w^<R-S-SUZ [ [\\\r   c                Z    t           j                            t          d                    S )zO:returns: applications directory tied to the user, e.g. ``Start Menu\Programs``CSIDL_PROGRAMSrG   r0   s    r   user_applications_dirzWindows.user_applications_dir   rI   r   c                Z    t           j                            t          d                    S )zo:returns: applications directory shared by users, e.g. ``C:\ProgramData\Microsoft\Windows\Start Menu\Programs``CSIDL_COMMON_PROGRAMSrG   r0   s    r   site_applications_dirzWindows.site_applications_dir   s#     w/F G GHHHr   c                    t           j                            t           j                            t	          d          d                    }|                     |          S )zk:returns: runtime directory tied to the user, e.g. ``%USERPROFILE%\AppData\Local\Temp\$appauthor\$appname``r   Temp)r   r   r   r%   r   r   r,   s     r   user_runtime_dirzWindows.user_runtime_dir   sG     w^<Q-R-RTZ [ [\\!!$'''r   c                    | j         S )zG:returns: runtime directory shared by users, same as `user_runtime_dir`)ri   r0   s    r   site_runtime_dirzWindows.site_runtime_dir   s     $$r   )r   r   )r   r   r   r   r   r   )__name__
__module____qualname____doc__propertyr   r   r-   r1   r5   r8   r:   r<   r>   rA   rD   rH   rL   rO   rR   rV   rY   r]   r`   rc   rf   ri   rk    r   r   r   r      s+         ( ( ( X( GK       ( ( ( X(
 " " " X" " " " X" ? ? ? X?
 ? ? ? X?
 " " " X" " " " X"    X    X B B B XB C C C XC D D D XD A A A XA A A A XA J J J XJ a a a Xa ] ] ] X] B B B XB I I I XI ( ( ( X(
 % % % X% % %r   r   
csidl_namer   r   c                    t          |           }||S dddd                    |           }|d|  }t          |          t          j                            |          }|d| }t          |          |S )z&Get folder from environment variables.NAPPDATAALLUSERSPROFILELOCALAPPDATA)r   r*   r   Unknown CSIDL name: zUnset environment variable: )(get_win_folder_if_csidl_name_not_env_varget
ValueErrorr   environ)rr   resultenv_var_namemsgs       r   get_win_folder_from_env_varsr      s    5jAAF # 1-  
c*oo	 
 1Z11ooZ^^L))F~;\;;ooMr   r   c                   | dk    rMt           j                            t           j                            t           j        d                   d          S | dk    rMt           j                            t           j                            t           j        d                   d          S | dk    rMt           j                            t           j                            t           j        d                   d          S | dk    rMt           j                            t           j                            t           j        d                   d	          S | d
k    rMt           j                            t           j                            t           j        d                   d          S | dk    rPt           j                            t           j                            t           j        d                   dddd          S | dk    r|t           j                            t           j                            t           j                            dt           j                            dd                              dddd          S dS )zMGet a folder for a CSIDL name that does not exist as an environment variable.rF   USERPROFILE	DocumentsrK   	DownloadsrN   PicturesrQ   VideosrU   Musicrb   rt   	Microsoftr   z
Start Menur[   re   PROGRAMDATAru   zC:\ProgramDataN)r   r   r%   r   r{   ry   )rr   s    r   rx   rx      s   %%%w||BG,,RZ-FGGUUU&&&w||BG,,RZ-FGGUUU'''w||BG,,RZ-FGGTTT_$$w||BG,,RZ-FGGRRR_$$w||BG,,RZ-FGGQQQ%%%w||GRZ	233
 
 	
 ,,,w||GRZ^^M2:>>J[]n;o;oppqq
 
 	
 4r   c                L   ddh}ddddddd	d
ddd
                     |           }|d|  }t          |          t          j        dk    rt          ddl}| |v r|j        n|j        }|                    |d          }|	                    ||          \  }}t          |          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*   re   AppDatazCommon AppDatazLocal AppDataPersonal&{374DE290-123F-4565-9164-39C4925E467B}zMy PictureszMy VideozMy Musicr[   zCommon Programs)
r   r*   r   rF   rK   rN   rQ   rU   rb   re   Nrw   win32r   z@Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders)ry   rz   sysplatformNotImplementedErrorwinregHKEY_LOCAL_MACHINEHKEY_CURRENT_USEROpenKeyQueryValueExr   )	rr   machine_namesshell_folder_namer~   r   hkeykey	directory_s	            r   get_win_folder_from_registryr      s     	M
 # 0.$C)##$!2  
c*oo   1Z11oo
|w!!MMM )3m(C(C6$$IaD
..b
c
cC&&s,=>>LIqy>>r   z&{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}r   z&{B4BFCC3A-DB2C-424C-B029-7FE99A87C641}z&{A77F5D77-2E2B-44C3-A6A2-ABA601054A51}z&{0139D44E-6AFE-49F2-8690-3DAFCAE6FFB8})r   r*   r   rF   rN   rQ   rU   rK   rX   rb   re   zdict[str, str]_KNOWN_FOLDER_GUIDSc                @   t           j        dk    rt          ddlm}m}m}m}m}m	}m
  G fdd|          } |d          }||j        _        j         ||          g|j        _        d|j        _        j        g|j        _         |d          }	||	j        _         ||          j        j         |j                  g|	j        _         |d	          }
j        |
j        _        j        j        j        g|
j        _        t,                              |           }|d
|  }t1          |           |            }|                    | ||                                                     }|	                     ||          t2          d ||                     |j        }|                    |           |d|  }t1          |          t7          d |D                       r) |d          }|
                    ||d          r|j        }|S )zGet folder via :func:`SHGetKnownFolderPath`.

    See https://learn.microsoft.com/en-us/windows/win32/api/shlobj_core/nf-shlobj_core-shgetknownfolderpath.

    r   r   )HRESULTPOINTER	StructureWinDLLbyrefcreate_unicode_bufferwintypesc                  Z    e Zd Zd j        fd j        fd j        fd j        dz  fgZdS )(get_win_folder_via_ctypes.<locals>._GUIDData1Data2Data3Data4   N)rl   rm   rn   DWORDWORDBYTE_fields_)r   s   r   _GUIDr   !  sC        hn%hm$hm$hma'(	
r   r   ole32Nshell32kernel32rw   z'SHGetKnownFolderPath returned NULL for c              3  <   K   | ]}t          |          d k    V  dS )   N)ord).0cs     r   	<genexpr>z,get_win_folder_via_ctypes.<locals>.<genexpr>H  s,      
(
(A3q66C<
(
(
(
(
(
(r   i   )r   r   r   ctypesr   r   r   r   r   r   r   CLSIDFromStringrestype	LPCOLESTRargtypesCoTaskMemFreeLPVOIDSHGetKnownFolderPathr   HANDLELPWSTRGetShortPathNameWr   ry   rz   r	   valueany)rr   r   r   r   r   r   r   r   r   r   r   folder_guidr~   guidpath_ptrr|   bufr   s                    @r   get_win_folder_via_ctypesr     st    |w!!bbbbbbbbbbbbbbbbbb
 
 
 
 
 
 
	 
 
 
 F7OOE$+E!&.&8''%..%IE""&E$,O#4E fYG+2G (-4WU^^X^X_^e^efnfu^v^v,wG )vj!!H)1H&+3?HOX^*\H'%))*55K1Z11oo577D	+uuT{{333  H  t.BD%%PX//ZZZ^F	!!!~D
DDoo

(
(
(
(
((( ##D))%%fc488 	YFMr   Callable[[str], str]c                     	 ddl } t          S # t          $ r Y nw xY w	 ddl}t          S # t          $ r
 t
          cY S w xY w)zjSelect the best method to resolve Windows folder paths: ctypes, then registry, then environment variables.r   N)r   r   ImportErrorr   r   r   )r   r   s     r   _pick_get_win_folderr   P  sy    ) )(    , ,+  , , ,++++,s    
) ==c                    d|                      d           }t          j                            |d                                          x}r|S t          |           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_ )removeprefixr   r{   ry   strip_resolve_win_folder)rr   env_varoverrides      r   r   r   c  s\     E!8!8!B!BDDG:>>'2..44666x z***r   )rr   r   r   r   )rr   r   r   r   )r   r   )ro   
__future__r   r   r   typingr   r   apir   collections.abcr   r	   __annotations__r   r   rx   r   r   r   r   r   r   __all__rq   r   r   <module>r      s    " " " " " " 				 



 ' ' ' ' ' ' ' '             )(((((( $.  - - - -S% S% S% S% S%o S% S% S%l   *" " " "J# # # #N >DC>@==?F>E' '     6 6 6 6r, , , ,  +*,, 	+ 	+ 	+ 	+ r   