1 // TortoiseGit - a Windows shell extension for easy version control
3 // External Cache Copyright (C) 2005-2006,2008,2010 - TortoiseSVN
4 // Copyright (C) 2008-2014 - TortoiseGit
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.
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.
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.
22 #include "GitStatus.h"
23 #include "GitStatusCache.h"
24 #include "CacheInterface.h"
27 //////////////////////////////////////////////////////////////////////////
29 #define BLOCK_PATH_DEFAULT_TIMEOUT 600 // 10 minutes
30 #define BLOCK_PATH_MAX_TIMEOUT 1200 // 20 minutes
32 CGitStatusCache
* CGitStatusCache::m_pInstance
;
34 CGitStatusCache
& CGitStatusCache::Instance()
36 ATLASSERT(m_pInstance
!= NULL
);
40 void CGitStatusCache::Create()
42 ATLASSERT(m_pInstance
== NULL
);
43 m_pInstance
= new CGitStatusCache
;
45 m_pInstance
->watcher
.SetFolderCrawler(&m_pInstance
->m_folderCrawler
);
46 #define LOADVALUEFROMFILE(x) if (fread(&x, sizeof(x), 1, pFile)!=1) goto exit;
47 #define LOADVALUEFROMFILE2(x) if (fread(&x, sizeof(x), 1, pFile)!=1) goto error;
48 unsigned int value
= (unsigned int)-1;
50 // find the location of the cache
51 TCHAR path
[MAX_PATH
] = { 0 }; //MAX_PATH ok here.
52 TCHAR path2
[MAX_PATH
] = { 0 };
53 if (SHGetFolderPath(NULL
, CSIDL_LOCAL_APPDATA
, NULL
, SHGFP_TYPE_CURRENT
, path
)==S_OK
)
55 _tcscat_s(path
, MAX_PATH
, _T("\\TGitCache"));
56 if (!PathIsDirectory(path
))
58 if (CreateDirectory(path
, NULL
)==0)
61 _tcscat_s(path
, MAX_PATH
, _T("\\cache"));
62 // in case the cache file is corrupt, we could crash while
63 // reading it! To prevent crashing every time once that happens,
64 // we make a copy of the cache file and use that copy to read from.
65 // if that copy is corrupt, the original file won't exist anymore
66 // and the second time we start up and try to read the file,
67 // it's not there anymore and we start from scratch without a crash.
68 _tcscpy_s(path2
, MAX_PATH
, path
);
69 _tcscat_s(path2
, MAX_PATH
, _T("2"));
71 CopyFile(path
, path2
, FALSE
);
73 pFile
= _tfsopen(path2
, _T("rb"), _SH_DENYNO
);
78 LOADVALUEFROMFILE(value
);
84 LOADVALUEFROMFILE(mapsize
);
85 for (int i
=0; i
<mapsize
; ++i
)
87 LOADVALUEFROMFILE2(value
);
93 if (fread(sKey
.GetBuffer(value
+1), sizeof(TCHAR
), value
, pFile
)!=value
)
95 sKey
.ReleaseBuffer(0);
98 sKey
.ReleaseBuffer(value
);
99 std::unique_ptr
<CCachedDirectory
> cacheddir (new CCachedDirectory());
100 if (!cacheddir
.get() || !cacheddir
->LoadFromDisk(pFile
))
105 CTGitPath KeyPath
= CTGitPath(sKey
);
106 if (m_pInstance
->IsPathAllowed(KeyPath
))
108 // only add the path to the watch list if it is versioned
109 if ((cacheddir
->GetCurrentFullStatus() != git_wc_status_unversioned
)&&(cacheddir
->GetCurrentFullStatus() != git_wc_status_none
))
110 m_pInstance
->watcher
.AddPath(KeyPath
, false);
112 m_pInstance
->m_directoryCache
[KeyPath
] = cacheddir
.release();
114 // do *not* add the paths for crawling!
115 // because crawled paths will trigger a shell
116 // notification, which makes the desktop flash constantly
117 // until the whole first time crawling is over
118 // m_pInstance->AddFolderForCrawling(KeyPath);
123 catch (CAtlException
)
133 m_pInstance
->watcher
.ClearInfoMap();
134 CTraceToOutputDebugString::Instance()(__FUNCTION__
": cache loaded from disk successfully!\n");
140 m_pInstance
->watcher
.ClearInfoMap();
142 m_pInstance
= new CGitStatusCache
;
143 CTraceToOutputDebugString::Instance()(__FUNCTION__
": cache not loaded from disk\n");
146 bool CGitStatusCache::SaveCache()
148 #define WRITEVALUETOFILE(x) if (fwrite(&x, sizeof(x), 1, pFile)!=1) goto error;
149 unsigned int value
= 0;
150 // save the cache to disk
152 // find a location to write the cache to
153 TCHAR path
[MAX_PATH
] = { 0 }; //MAX_PATH ok here.
154 if (SHGetFolderPath(NULL
, CSIDL_LOCAL_APPDATA
, NULL
, SHGFP_TYPE_CURRENT
, path
)==S_OK
)
156 _tcscat_s(path
, MAX_PATH
, _T("\\TGitCache"));
157 if (!PathIsDirectory(path
))
158 CreateDirectory(path
, NULL
);
159 _tcscat_s(path
, MAX_PATH
, _T("\\cache"));
160 _tfopen_s(&pFile
, path
, _T("wb"));
163 value
= 2; // 'version'
164 WRITEVALUETOFILE(value
);
165 value
= (int)m_pInstance
->m_directoryCache
.size();
166 WRITEVALUETOFILE(value
);
167 for (CCachedDirectory::CachedDirMap::iterator I
= m_pInstance
->m_directoryCache
.begin(); I
!= m_pInstance
->m_directoryCache
.end(); ++I
)
169 if (I
->second
== NULL
)
172 WRITEVALUETOFILE(value
);
175 const CString
& key
= I
->first
.GetWinPathString();
176 value
= key
.GetLength();
177 WRITEVALUETOFILE(value
);
180 if (fwrite((LPCTSTR
)key
, sizeof(TCHAR
), value
, pFile
)!=value
)
182 if (!I
->second
->SaveToDisk(pFile
))
189 CTraceToOutputDebugString::Instance()(_T(__FUNCTION__
) _T(": cache saved to disk at %s\n"), path
);
198 void CGitStatusCache::Destroy()
209 void CGitStatusCache::Stop()
211 // m_svnHelp.Cancel(true);
213 m_folderCrawler
.Stop();
214 m_shellUpdater
.Stop();
217 void CGitStatusCache::Init()
219 m_folderCrawler
.Initialise();
220 m_shellUpdater
.Initialise();
223 CGitStatusCache::CGitStatusCache(void)
225 #define forever DWORD(-1)
226 AutoLocker
lock(m_NoWatchPathCritSec
);
227 TCHAR path
[MAX_PATH
] = { 0 };
228 SHGetFolderPath(NULL
, CSIDL_COOKIES
, NULL
, 0, path
);
229 m_NoWatchPaths
[CTGitPath(CString(path
))] = forever
;
230 SecureZeroMemory(path
, sizeof(path
));
231 SHGetFolderPath(NULL
, CSIDL_HISTORY
, NULL
, 0, path
);
232 m_NoWatchPaths
[CTGitPath(CString(path
))] = forever
;
233 SecureZeroMemory(path
, sizeof(path
));
234 SHGetFolderPath(NULL
, CSIDL_INTERNET_CACHE
, NULL
, 0, path
);
235 m_NoWatchPaths
[CTGitPath(CString(path
))] = forever
;
236 SecureZeroMemory(path
, sizeof(path
));
237 SHGetFolderPath(NULL
, CSIDL_SYSTEM
, NULL
, 0, path
);
238 m_NoWatchPaths
[CTGitPath(CString(path
))] = forever
;
239 SecureZeroMemory(path
, sizeof(path
));
240 SHGetFolderPath(NULL
, CSIDL_WINDOWS
, NULL
, 0, path
);
241 m_NoWatchPaths
[CTGitPath(CString(path
))] = forever
;
242 m_bClearMemory
= false;
243 m_mostRecentExpiresAt
= 0;
246 CGitStatusCache::~CGitStatusCache(void)
248 CAutoWriteLock
writeLock(m_guard
);
252 void CGitStatusCache::Refresh()
254 m_shellCache
.ForceRefresh();
255 // m_pInstance->m_svnHelp.ReloadConfig();
256 if (!m_pInstance
->m_directoryCache
.empty())
258 CCachedDirectory::CachedDirMap::iterator I
= m_pInstance
->m_directoryCache
.begin();
259 for (/* no init */; I
!= m_pInstance
->m_directoryCache
.end(); ++I
)
261 if (m_shellCache
.IsPathAllowed(I
->first
.GetWinPath()))
262 I
->second
->RefreshMostImportant();
265 CGitStatusCache::Instance().RemoveCacheForPath(I
->first
);
266 I
= m_pInstance
->m_directoryCache
.begin();
267 if (I
== m_pInstance
->m_directoryCache
.end())
274 bool CGitStatusCache::IsPathGood(const CTGitPath
& path
)
276 AutoLocker
lock(m_NoWatchPathCritSec
);
277 for (std::map
<CTGitPath
, DWORD
>::const_iterator it
= m_NoWatchPaths
.begin(); it
!= m_NoWatchPaths
.end(); ++it
)
279 // the ticks check is necessary here, because RemoveTimedoutBlocks is only called within the FolderCrawler loop
280 // and we might miss update calls
281 // TODO: maybe we also need to check if index.lock and HEAD.lock still exists after a specific timeout (if we miss update notifications for these files too often)
282 if (GetTickCount() < it
->second
&& it
->first
.IsAncestorOf(path
))
284 CTraceToOutputDebugString::Instance()(_T(__FUNCTION__
) _T(": path not good: %s\n"), it
->first
.GetWinPath());
291 bool CGitStatusCache::BlockPath(const CTGitPath
& path
, DWORD timeout
/* = 0 */)
294 timeout
= BLOCK_PATH_DEFAULT_TIMEOUT
;
296 if (timeout
> BLOCK_PATH_MAX_TIMEOUT
)
297 timeout
= BLOCK_PATH_MAX_TIMEOUT
;
299 timeout
= GetTickCount() + (timeout
* 1000); // timeout is in seconds, but we need the milliseconds
301 AutoLocker
lock(m_NoWatchPathCritSec
);
302 m_NoWatchPaths
[path
.GetDirectory()] = timeout
;
307 bool CGitStatusCache::UnBlockPath(const CTGitPath
& path
)
310 AutoLocker
lock(m_NoWatchPathCritSec
);
311 std::map
<CTGitPath
, DWORD
>::iterator it
= m_NoWatchPaths
.find(path
.GetDirectory());
312 if (it
!= m_NoWatchPaths
.end())
314 CTraceToOutputDebugString::Instance()(_T(__FUNCTION__
) _T(": path removed from no good: %s\n"), it
->first
.GetWinPath());
315 m_NoWatchPaths
.erase(it
);
318 AddFolderForCrawling(path
.GetDirectory());
323 bool CGitStatusCache::RemoveTimedoutBlocks()
326 DWORD currentTicks
= GetTickCount();
327 AutoLocker
lock(m_NoWatchPathCritSec
);
328 std::vector
<CTGitPath
> toRemove
;
329 for (std::map
<CTGitPath
, DWORD
>::const_iterator it
= m_NoWatchPaths
.begin(); it
!= m_NoWatchPaths
.end(); ++it
)
331 if (currentTicks
> it
->second
)
333 toRemove
.push_back(it
->first
);
336 if (!toRemove
.empty())
338 for (std::vector
<CTGitPath
>::const_iterator it
= toRemove
.begin(); it
!= toRemove
.end(); ++it
)
340 ret
= ret
|| UnBlockPath(*it
);
347 void CGitStatusCache::UpdateShell(const CTGitPath
& path
)
349 m_shellUpdater
.AddPathForUpdate(path
);
352 void CGitStatusCache::ClearCache()
354 for (CCachedDirectory::CachedDirMap::iterator I
= m_directoryCache
.begin(); I
!= m_directoryCache
.end(); ++I
)
359 m_directoryCache
.clear();
362 bool CGitStatusCache::RemoveCacheForDirectory(CCachedDirectory
* cdir
)
367 typedef std::map
<CTGitPath
, git_wc_status_kind
> ChildDirStatus
;
368 if (!cdir
->m_childDirectories
.empty())
370 ChildDirStatus::iterator it
= cdir
->m_childDirectories
.begin();
371 for (; it
!= cdir
->m_childDirectories
.end(); )
373 CCachedDirectory
* childdir
= CGitStatusCache::Instance().GetDirectoryCacheEntryNoCreate(it
->first
);
374 if ((childdir
) && (!cdir
->m_directoryPath
.IsEquivalentTo(childdir
->m_directoryPath
)) && (cdir
->m_directoryPath
.GetFileOrDirectoryName() != L
".."))
375 RemoveCacheForDirectory(childdir
);
376 cdir
->m_childDirectories
.erase(it
->first
);
377 it
= cdir
->m_childDirectories
.begin();
380 cdir
->m_childDirectories
.clear();
381 m_directoryCache
.erase(cdir
->m_directoryPath
);
383 // we could have entries versioned and/or stored in our cache which are
384 // children of the specified directory, but not in the m_childDirectories
386 CCachedDirectory::ItDir itMap
= m_directoryCache
.lower_bound(cdir
->m_directoryPath
);
389 if (itMap
!= m_directoryCache
.end())
391 if (cdir
->m_directoryPath
.IsAncestorOf(itMap
->first
))
393 // just in case (see TortoiseSVN issue #255)
394 if (itMap
->second
== cdir
)
396 m_directoryCache
.erase(itMap
);
399 RemoveCacheForDirectory(itMap
->second
);
402 itMap
= m_directoryCache
.lower_bound(cdir
->m_directoryPath
);
403 } while (itMap
!= m_directoryCache
.end() && cdir
->m_directoryPath
.IsAncestorOf(itMap
->first
));
405 CTraceToOutputDebugString::Instance()(_T(__FUNCTION__
) _T(": removed from cache %s\n"), cdir
->m_directoryPath
.GetWinPathString());
410 void CGitStatusCache::RemoveCacheForPath(const CTGitPath
& path
)
412 // Stop the crawler starting on a new folder
413 CCrawlInhibitor
crawlInhibit(&m_folderCrawler
);
414 CCachedDirectory::ItDir itMap
;
415 CCachedDirectory
* dirtoremove
= NULL
;
417 itMap
= m_directoryCache
.find(path
);
418 if ((itMap
!= m_directoryCache
.end())&&(itMap
->second
))
419 dirtoremove
= itMap
->second
;
420 if (dirtoremove
== NULL
)
422 ATLASSERT(path
.IsEquivalentToWithoutCase(dirtoremove
->m_directoryPath
));
423 RemoveCacheForDirectory(dirtoremove
);
426 CCachedDirectory
* CGitStatusCache::GetDirectoryCacheEntry(const CTGitPath
& path
, bool isAddToWatch
)
428 ATLASSERT(path
.IsDirectory() || !PathFileExists(path
.GetWinPath()));
431 CCachedDirectory::ItDir itMap
;
432 itMap
= m_directoryCache
.find(path
);
433 if ((itMap
!= m_directoryCache
.end())&&(itMap
->second
))
435 // We've found this directory in the cache
436 return itMap
->second
;
440 // if the CCachedDirectory is NULL but the path is in our cache,
441 // that means that path got invalidated and needs to be treated
442 // as if it never was in our cache. So we remove the last remains
443 // from the cache and start from scratch.
445 CAutoWriteLock
writeLock(m_guard
);
446 // Since above there's a small chance that before we can upgrade to
447 // writer state some other thread gained writer state and changed
448 // the data, we have to recreate the iterator here again.
449 itMap
= m_directoryCache
.find(path
);
450 if (itMap
!=m_directoryCache
.end())
452 delete itMap
->second
;
453 itMap
->second
= NULL
;
454 m_directoryCache
.erase(itMap
);
456 // We don't know anything about this directory yet - lets add it to our cache
457 // but only if it exists!
458 if (path
.Exists() && m_shellCache
.IsPathAllowed(path
.GetWinPath()) && !g_GitAdminDir
.IsAdminDirPath(path
.GetWinPath()))
460 // some notifications are for files which got removed/moved around.
461 // In such cases, the CTGitPath::IsDirectory() will return true (it assumes a directory if
462 // the path doesn't exist). Which means we can get here with a path to a file
463 // instead of a directory.
464 // Since we're here most likely called from the crawler thread, the file could exist
465 // again. If that's the case, just do nothing
466 if (path
.IsDirectory()||(!path
.Exists()))
468 CTraceToOutputDebugString::Instance()(_T(__FUNCTION__
) _T(": adding %s to our cache\n"), path
.GetWinPath());
469 CCachedDirectory
* newcdir
= new CCachedDirectory(path
);
472 CCachedDirectory
* cdir
= m_directoryCache
.insert(m_directoryCache
.lower_bound(path
), std::make_pair(path
, newcdir
))->second
;
474 if ((!path
.IsEmpty())&&(path
.HasAdminDir(&gitdir
))&&isAddToWatch
)
476 /* Just watch version path */
477 watcher
.AddPath(gitdir
);
478 watcher
.AddPath(path
);
482 m_bClearMemory
= true;
489 CCachedDirectory
* CGitStatusCache::GetDirectoryCacheEntryNoCreate(const CTGitPath
& path
)
491 ATLASSERT(path
.IsDirectory() || !PathFileExists(path
.GetWinPath()));
493 CCachedDirectory::ItDir itMap
;
494 itMap
= m_directoryCache
.find(path
);
495 if(itMap
!= m_directoryCache
.end())
497 // We've found this directory in the cache
498 return itMap
->second
;
503 /* Fetch is true, means fetch status from */
504 /* Fetch is false, means fetch status from cache */
505 CStatusCacheEntry
CGitStatusCache::GetStatusForPath(const CTGitPath
& path
, DWORD flags
, bool bFetch
/* = true */)
507 bool bRecursive
= !!(flags
& TGITCACHE_FLAGS_RECUSIVE_STATUS
);
509 // Check a very short-lived 'mini-cache' of the last thing we were asked for.
510 long now
= (long)GetTickCount();
511 if(now
-m_mostRecentExpiresAt
< 0)
513 if(path
.IsEquivalentToWithoutCase(m_mostRecentPath
))
515 return m_mostRecentStatus
;
519 AutoLocker
lock(m_critSec
);
520 m_mostRecentPath
= path
;
521 m_mostRecentExpiresAt
= now
+ 1000;
524 if (IsPathGood(path
))
526 // Stop the crawler starting on a new folder while we're doing this much more important task...
527 // Please note, that this may be a second "lock" used concurrently to the one in RemoveCacheForPath().
528 CCrawlInhibitor
crawlInhibit(&m_folderCrawler
);
530 CTGitPath dirpath
= path
.GetContainingDirectory();
531 if ((dirpath
.IsEmpty()) || (!m_shellCache
.IsPathAllowed(dirpath
.GetWinPath())))
532 dirpath
= path
.GetDirectory();
533 CCachedDirectory
* cachedDir
= GetDirectoryCacheEntry(dirpath
);
534 if (cachedDir
!= NULL
)
536 //CTraceToOutputDebugString::Instance()(_T(__FUNCTION__) _T(": GetStatusForMember %d\n"), bFetch);
537 CStatusCacheEntry entry
= cachedDir
->GetStatusForMember(path
, bRecursive
, bFetch
);
539 AutoLocker
lock(m_critSec
);
540 m_mostRecentStatus
= entry
;
541 return m_mostRecentStatus
;
547 // path is blocked for some reason: return the cached status if we have one
548 // we do here only a cache search, absolutely no disk access is allowed!
549 CCachedDirectory::ItDir itMap
= m_directoryCache
.find(path
.GetDirectory());
550 if ((itMap
!= m_directoryCache
.end())&&(itMap
->second
))
552 if (path
.IsDirectory())
554 CStatusCacheEntry entry
= itMap
->second
->GetOwnStatus(false);
555 AutoLocker
lock(m_critSec
);
556 m_mostRecentStatus
= entry
;
557 return m_mostRecentStatus
;
561 // We've found this directory in the cache
562 CCachedDirectory
* cachedDir
= itMap
->second
;
563 CStatusCacheEntry entry
= cachedDir
->GetCacheStatusForMember(path
);
565 AutoLocker
lock(m_critSec
);
566 m_mostRecentStatus
= entry
;
567 return m_mostRecentStatus
;
572 AutoLocker
lock(m_critSec
);
573 CTraceToOutputDebugString::Instance()(_T(__FUNCTION__
) _T(": ignored no good path %s\n"), path
.GetWinPath());
574 m_mostRecentStatus
= CStatusCacheEntry();
575 if (m_shellCache
.ShowExcludedAsNormal() && path
.IsDirectory() && m_shellCache
.HasGITAdminDir(path
.GetWinPath(), true))
577 CTraceToOutputDebugString::Instance()(_T(__FUNCTION__
) _T(": force status %s\n"), path
.GetWinPath());
578 m_mostRecentStatus
.ForceStatus(git_wc_status_normal
);
580 return m_mostRecentStatus
;
583 void CGitStatusCache::AddFolderForCrawling(const CTGitPath
& path
)
585 m_folderCrawler
.AddDirectoryForUpdate(path
);
588 void CGitStatusCache::CloseWatcherHandles(HDEVNOTIFY hdev
)
590 CTGitPath path
= watcher
.CloseInfoMap(hdev
);
591 m_folderCrawler
.BlockPath(path
);
594 void CGitStatusCache::CloseWatcherHandles(const CTGitPath
& path
)
596 watcher
.CloseHandlesForPath(path
);
597 m_folderCrawler
.ReleasePathForUpdate(path
);