src/TortoiseShell/ShellCache.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2012-2019, 2021-2024 - TortoiseGit
   4 // Copyright (C) 2003-2011, 2017 - TortoiseSVN
   5
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software Foundation,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20 #pragma once
  21 #include "registry.h"
  22 #include "Globals.h"
  23
  24 #define ADMINDIRTIMEOUT 10000
  25 #define DRIVETYPETIMEOUT 300000         // 5 min
  26
  27 #define DEFAULTWIN11MENUTOPENTRIES MENUSYNC|MENUCOMMIT|MENUSWITCH|MENUREVERT|MENUCONFLICTEDITOR|MENUDIFF|MENUPULL|MENUPUSH|MENUREPOBROWSE|MENULOG|MENUBLAME|MENUCLONE|MENUMERGE|MENUSTASHSAVE|MENUSETTINGS
  28 #define DEFAULTMENUTOPENTRIES   MENUSYNC|MENUCREATEREPOS|MENUCLONE|MENUCOMMIT
  29 #define DEFAULTMENUEXTENTRIES   MENUSVNIGNORE|MENUSTASHAPPLY|MENUSUBSYNC
  30
  31 using Locker = CComCritSecLock<CComCriticalSection>;
  32
  33 enum class Tristate
  34 {
  35         /** state known to be false (the constant does not evaulate to false) */
  36         False = 2,
  37         /** state known to be true */
  38         True,
  39         /** state could be true or false */
  40         Unknown
  41 };
  42
  43 /**
  44  * \ingroup TortoiseShell
  45  * Helper class which caches access to the registry. Also provides helper methods
  46  * for checks against the settings stored in the registry.
  47  */
  48 class ShellCache
  49 {
  50 public:
  51         enum CacheType
  52         {
  53                 none,
  54                 exe,
  55                 dll,
  56                 dllFull,// same as dll except it uses commandline git tool with all status modes supported
  57         };
  58
  59         ShellCache();
  60         ~ShellCache();
  61
  62         bool RefreshIfNeeded();
  63
  64         CacheType GetCacheType();
  65         DWORD BlockStatus();
  66         unsigned __int64 GetMenuLayout();
  67         unsigned __int64 GetMenuLayout11();
  68         unsigned __int64 GetMenuExt();
  69         unsigned __int64 GetMenuMask();
  70
  71         bool IsProcessElevated();
  72         BOOL IsOnlyNonElevated();
  73
  74         BOOL IsRecursive();
  75         BOOL IsFolderOverlay();
  76         BOOL IsSimpleContext();
  77         BOOL HasShellMenuAccelerators();
  78         BOOL IsUnversionedAsModified();
  79         BOOL IsRecurseSubmodules();
  80         BOOL ShowUnversionedOverlay();
  81         BOOL ShowIgnoredOverlay();
  82         BOOL ShowExcludedAsNormal();
  83         BOOL HideMenusForUnversionedItems();
  84
  85         BOOL IsRemote();
  86         BOOL IsFixed();
  87         BOOL IsCDRom();
  88         BOOL IsRemovable();
  89         BOOL IsRAM();
  90         BOOL IsUnknown();
  91
  92         BOOL IsContextPathAllowed(const std::wstring& path);
  93         BOOL IsPathAllowed(LPCWSTR path);
  94         DWORD GetLangID();
  95         BOOL HasGITAdminDir(LPCWSTR path, BOOL bIsDir, CString* ProjectTopDir = nullptr);
  96
  97 private:
  98         void ExcludeContextValid();
  99
 100         class CPathFilter
 101         {
 102         public:
 103                 /// node in the lookup tree
 104                 struct SEntry
 105                 {
 106                         std::wstring path;
 107
 108                         /// default (path spec did not end a '?').
 109                         /// if this is not set, the default for all
 110                         /// sub-paths is !included.
 111                         /// This is a temporary setting an be invalid
 112                         /// after @ref PostProcessData
 113                         bool recursive = false;
 114
 115                         /// this is an "include" specification
 116                         Tristate included = Tristate::Unknown;
 117
 118                         /// if @ref recursive is not set, this is
 119                         /// the parent path status being passed down
 120                         /// combined with the information of other
 121                         /// entries for the same @ref path.
 122                         Tristate subPathIncluded = Tristate::Unknown;
 123
 124                         /// do entries for sub-paths exist?
 125                         bool hasSubFolderEntries = false;
 126
 127                         /// STL support
 128                         /// For efficient folding, it is imperative that
 129                         /// "recursive" entries are first
 130                         bool operator<(const SEntry& rhs) const
 131                         {
 132                                 int diff = _wcsicmp(path.c_str(), rhs.path.c_str());
 133                                 return (diff < 0) || ((diff == 0) && recursive && !rhs.recursive);
 134                         }
 135
 136                         friend bool operator<(const SEntry& rhs, const std::pair<LPCWSTR, size_t>& lhs);
 137                         friend bool operator<(const std::pair<LPCWSTR, size_t>& lhs, const SEntry& rhs);
 138                 };
 139
 140         private:
 141                 /// lookup by path (all entries sorted by path)
 142                 using TData = std::vector<SEntry>;
 143                 TData data;
 144
 145                 /// registry keys plus cached last content
 146                 CRegStdString excludelist;
 147                 std::wstring excludeliststr;
 148
 149                 CRegStdString includelist;
 150                 std::wstring includeliststr;
 151
 152                 /// construct \ref data content
 153                 void AddEntry(const std::wstring& s, bool include);
 154                 void AddEntries(const std::wstring& s, bool include);
 155
 156                 /// for all paths, have at least one entry in data
 157                 void PostProcessData();
 158
 159                 /// lookup. default result is "unknown".
 160                 /// We must look for *every* parent path because of situations like:
 161                 /// excluded: C:, C:\some\deep\path
 162                 /// include: C:\some
 163                 /// lookup for C:\some\deeper\path
 164                 Tristate IsPathAllowed(LPCWSTR path, TData::const_iterator begin, TData::const_iterator end) const;
 165
 166         public:
 167                 /// construction
 168                 CPathFilter();
 169
 170                 /// notify of (potential) registry settings
 171                 void Refresh();
 172
 173                 /// data access
 174                 Tristate IsPathAllowed(LPCWSTR path) const;
 175         };
 176
 177         friend bool operator< (const CPathFilter::SEntry& rhs, const std::pair<LPCWSTR, size_t>& lhs);
 178         friend bool operator< (const std::pair<LPCWSTR, size_t>& lhs, const CPathFilter::SEntry& rhs);
 179
 180         struct AdminDir_s
 181         {
 182                 BOOL bHasAdminDir = false;
 183                 std::wstring sProjectRoot;
 184                 ULONGLONG timeout = ADMINDIRTIMEOUT;
 185         };
 186
 187 public:
 188         CRegStdDWORD cachetype;
 189         CRegStdDWORD blockstatus;
 190         CRegStdDWORD langid;
 191         CRegStdDWORD onlynonelevated;
 192         CRegStdDWORD showrecursive;
 193         CRegStdDWORD folderoverlay;
 194         CRegStdDWORD driveremote;
 195         CRegStdDWORD drivefixed;
 196         CRegStdDWORD drivecdrom;
 197         CRegStdDWORD driveremove;
 198         CRegStdDWORD drivefloppy;
 199         CRegStdDWORD driveram;
 200         CRegStdDWORD driveunknown;
 201         CRegStdQWORD menuLayout11;
 202         CRegStdDWORD menulayoutlow; /* Fist level mask */
 203         CRegStdDWORD menulayouthigh;
 204         CRegStdDWORD shellmenuaccelerators;
 205         CRegStdDWORD menuextlow;           /* ext menu mask */
 206         CRegStdDWORD menuexthigh;
 207         CRegStdDWORD simplecontext;
 208         CRegStdDWORD menumasklow_lm;
 209         CRegStdDWORD menumaskhigh_lm;
 210         CRegStdDWORD menumasklow_cu;
 211         CRegStdDWORD menumaskhigh_cu;
 212         CRegStdDWORD unversionedasmodified;
 213         CRegStdDWORD recursesubmodules;
 214         CRegStdDWORD showunversionedoverlay;
 215         CRegStdDWORD showignoredoverlay;
 216         CRegStdDWORD excludedasnormal;
 217         CRegStdDWORD hidemenusforunversioneditems;
 218
 219         CPathFilter pathFilter;
 220
 221         ULONGLONG drivetypeticker = 0;
 222         ULONGLONG menumaskticker = 0;
 223         UINT  drivetypecache[27];
 224         wchar_t drivetypepathcache[MAX_PATH]{}; // MAX_PATH ok.
 225         std::map<std::wstring, AdminDir_s> admindircache;
 226         CRegStdString nocontextpaths;
 227         std::wstring excludecontextstr;
 228         std::vector<std::wstring> excontextvector;
 229         CComAutoCriticalSection m_critSec;
 230         HANDLE m_registryChangeEvent = nullptr;
 231         HKEY m_hNotifyRegKey = nullptr;
 232         bool isElevated = false;
 233 };
 234
 235 inline bool operator<(const ShellCache::CPathFilter::SEntry& lhs, const std::pair<LPCWSTR, size_t>& rhs)
 236 {
 237         return _wcsnicmp(lhs.path.c_str(), rhs.first, rhs.second) < 0;
 238 }
 239
 240 inline bool operator<(const std::pair<LPCWSTR, size_t>& lhs, const ShellCache::CPathFilter::SEntry& rhs)
 241 {
 242         return _wcsnicmp(lhs.first, rhs.path.c_str(), lhs.second) < 0;
 243 }