src/Git/GitFolderStatus.cpp

   1 // TortoiseSVN - a Windows shell extension for easy version control\r
   2 \r
   3 // Copyright (C) 2003-2008 - TortoiseSVN\r
   4 \r
   5 // This program is free software; you can redistribute it and/or\r
   6 // modify it under the terms of the GNU General Public License\r
   7 // as published by the Free Software Foundation; either version 2\r
   8 // of the License, or (at your option) any later version.\r
   9 \r
  10 // This program is distributed in the hope that it will be useful,\r
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13 // GNU General Public License for more details.\r
  14 \r
  15 // You should have received a copy of the GNU General Public License\r
  16 // along with this program; if not, write to the Free Software Foundation,\r
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\r
  18 \r
  19 #include "stdafx.h"\r
  20 #include "ShellExt.h"\r
  21 #include "GitFolderStatus.h"\r
  22 #include "UnicodeUtils.h"\r
  23 #include "..\TGitCache\CacheInterface.h"\r
  24 #include "Git.h"\r
  25 //#include "GitGlobal.h"\r
  26 #include "gitindex.h"\r
  27 \r
  28 extern ShellCache g_ShellCache;\r
  29 \r
  30 extern CGitIndexFileMap g_IndexFileMap;\r
  31 \r
  32 // get / auto-alloc a string "copy"\r
  33 \r
  34 const char* StringPool::GetString (const char* value)\r
  35 {\r
  36         // special case: NULL pointer\r
  37         \r
  38         if (value == NULL)\r
  39         {\r
  40                 return emptyString;\r
  41         }\r
  42 \r
  43         // do we already have a string with the desired value?\r
  44 \r
  45         pool_type::const_iterator iter = pool.find (value);\r
  46         if (iter != pool.end())\r
  47         {\r
  48                 // yes -> return it\r
  49                 return *iter;\r
  50         }\r
  51         \r
  52         // no -> add one        \r
  53         \r
  54         const char* newString =  _strdup (value);\r
  55         if (newString)\r
  56         {\r
  57                 pool.insert (newString);\r
  58         }\r
  59         else\r
  60                 return emptyString;\r
  61         \r
  62         // .. and return it\r
  63         \r
  64         return newString;\r
  65 }\r
  66 \r
  67 // clear internal pool\r
  68 \r
  69 void StringPool::clear()\r
  70 {\r
  71         // delete all strings\r
  72 \r
  73         for (pool_type::iterator iter = pool.begin(), end = pool.end(); iter != end; ++iter)\r
  74         {\r
  75                 free((void*)*iter);\r
  76         }\r
  77                 \r
  78         // remove pointers from pool\r
  79                 \r
  80         pool.clear();\r
  81 }\r
  82 \r
  83 CTGitPath       GitFolderStatus::folderpath;\r
  84 \r
  85 \r
  86 GitFolderStatus::GitFolderStatus(void)\r
  87 {\r
  88         m_TimeStamp = 0;\r
  89         emptyString[0] = 0;\r
  90         invalidstatus.author = emptyString;\r
  91         invalidstatus.askedcounter = -1;\r
  92         invalidstatus.status = git_wc_status_none;\r
  93         invalidstatus.url = emptyString;\r
  94 //      invalidstatus.rev = -1;\r
  95         invalidstatus.owner = emptyString;\r
  96         invalidstatus.needslock = false;\r
  97         invalidstatus.tree_conflict = false;\r
  98         m_nCounter = 0;\r
  99         dirstatus = NULL;\r
 100         sCacheKey.reserve(MAX_PATH);\r
 101 \r
 102         //rootpool = svn_pool_create (NULL);\r
 103 \r
 104         m_hInvalidationEvent = CreateEvent(NULL, FALSE, FALSE, _T("TortoiseGitCacheInvalidationEvent"));\r
 105 }\r
 106 \r
 107 GitFolderStatus::~GitFolderStatus(void)\r
 108 {\r
 109         //svn_pool_destroy(rootpool);\r
 110         CloseHandle(m_hInvalidationEvent);\r
 111 }\r
 112 \r
 113 const FileStatusCacheEntry * GitFolderStatus::BuildCache(const CTGitPath& filepath, const CString& sProjectRoot, BOOL bIsFolder, BOOL bDirectFolder)\r
 114 {\r
 115 //      svn_client_ctx_t *                      localctx;\r
 116 //      apr_hash_t *                            statushash;\r
 117 //      apr_pool_t *                            pool;\r
 118         //git_error_t *                         err = NULL; // If svn_client_status comes out through catch(...), err would else be unassigned\r
 119         BOOL err = FALSE;\r
 120 \r
 121         //dont' build the cache if an instance of TortoiseProc is running\r
 122         //since this could interfere with svn commands running (concurrent\r
 123         //access of the .git directory).\r
 124         if (g_ShellCache.BlockStatus())\r
 125         {\r
 126                 HANDLE TGitMutex = ::CreateMutex(NULL, FALSE, _T("TortoiseGitProc.exe"));       \r
 127                 if (TGitMutex != NULL)\r
 128                 {\r
 129                         if (::GetLastError() == ERROR_ALREADY_EXISTS)\r
 130                         {\r
 131                                 ::CloseHandle(TGitMutex);\r
 132                                 return &invalidstatus;\r
 133                         }\r
 134                 }\r
 135                 ::CloseHandle(TGitMutex);\r
 136         }\r
 137 \r
 138 //      pool = svn_pool_create (rootpool);                              // create the memory pool\r
 139 \r
 140         ClearCache();\r
 141 //      svn_error_clear(svn_client_create_context(&localctx, pool));\r
 142         // set up the configuration\r
 143         // Note: I know this is an 'expensive' call, but without this, ignores\r
 144         // done in the global ignore pattern won't show up.\r
 145         if (g_ShellCache.ShowIgnoredOverlay())\r
 146 ;//             svn_error_clear(svn_config_get_config (&(localctx->config), g_pConfigDir, pool));\r
 147 \r
 148         // strings pools are unused, now -> we may clear them\r
 149         \r
 150         authors.clear();\r
 151         urls.clear();\r
 152         owners.clear();\r
 153         \r
 154         ATLTRACE2(_T("building cache for %s\n"), filepath);\r
 155         if (bIsFolder)\r
 156         {\r
 157                 if (bDirectFolder)\r
 158                 {\r
 159                         // NOTE: see not in GetFullStatus about project inside another project, we should only get here when\r
 160                         //       that occurs, and this is not correctly handled yet\r
 161 \r
 162                         // initialize record members\r
 163 //                      dirstat.rev = -1;\r
 164                         dirstat.status = git_wc_status_none;\r
 165                         dirstat.author = authors.GetString(NULL);\r
 166                         dirstat.url = urls.GetString(NULL);\r
 167                         dirstat.owner = owners.GetString(NULL);\r
 168                         dirstat.askedcounter = GITFOLDERSTATUS_CACHETIMES;\r
 169                         dirstat.needslock = false;\r
 170                         dirstat.tree_conflict = false;\r
 171 \r
 172                         dirstatus = NULL;\r
 173 //                      statushash = apr_hash_make(pool);\r
 174 //                      git_revnum_t youngest = GIT_INVALID_REVNUM;\r
 175 //                      git_opt_revision_t rev;\r
 176 //                      rev.kind = git_opt_revision_unspecified;\r
 177                         try\r
 178                         {\r
 179                                 folderpath = filepath;\r
 180 \r
 181                                 /*err = svn_client_status4 (&youngest,\r
 182                                         filepath.GetDirectory().GetSVNApiPath(pool),\r
 183                                         &rev,\r
 184                                         findfolderstatus,\r
 185                                         this,\r
 186                                         svn_depth_empty,//depth\r
 187                                         TRUE,           //getall\r
 188                                         FALSE,          //update\r
 189                                         TRUE,           //noignore\r
 190                                         FALSE,          //ignore externals\r
 191                                         NULL,\r
 192                                         localctx,\r
 193                                         pool);*/\r
 194                         }\r
 195                         catch ( ... )\r
 196                         {\r
 197                                 dirstatus = NULL;\r
 198                         }\r
 199 \r
 200 \r
 201                         if (dirstatus)\r
 202                         {\r
 203 /*                              if (dirstatus->entry)\r
 204                                 {\r
 205                                         dirstat.author = authors.GetString (dirstatus->entry->cmt_author);\r
 206                                         dirstat.url = authors.GetString (dirstatus->entry->url);\r
 207                                         dirstat.rev = dirstatus->entry->cmt_rev;\r
 208                                         dirstat.owner = owners.GetString(dirstatus->entry->lock_owner);\r
 209                                 }*/\r
 210                                 dirstat.status = GitStatus::GetMoreImportant(dirstatus->text_status, dirstatus->prop_status);\r
 211 //                              dirstat.tree_conflict = dirstatus->tree_conflict != NULL;\r
 212                         }\r
 213                         m_cache[filepath.GetWinPath()] = dirstat;\r
 214                         m_TimeStamp = GetTickCount();\r
 215 //                      svn_error_clear(err);\r
 216 //                      svn_pool_destroy (pool);                                //free allocated memory\r
 217                         return &dirstat;\r
 218                 }\r
 219         } // if (bIsFolder) \r
 220         \r
 221         m_nCounter = 0;\r
 222         \r
 223         //Fill in the cache with\r
 224         //all files inside the same folder as the asked file/folder is\r
 225         //since subversion can do this in one step\r
 226 //      localctx->auth_baton = NULL;\r
 227 \r
 228 //      statushash = apr_hash_make(pool);\r
 229 //      git_revnum_t youngest = GIT_INVALID_REVNUM;\r
 230 //      git_opt_revision_t rev;\r
 231 //      rev.kind = git_opt_revision_unspecified;\r
 232         try\r
 233         {\r
 234                 // extract the sub-path (relative to project root)\r
 235 //MessageBox(NULL, filepath.GetDirectory().GetWinPathString(), sProjectRoot, MB_OK);\r
 236 //              LPCSTR lpszSubPath = NULL;\r
 237                 CString sSubPath;\r
 238                 CString s = filepath.GetWinPathString();\r
 239                 if (s.GetLength() > sProjectRoot.GetLength())\r
 240                 {\r
 241                         sSubPath = s.Right(s.GetLength() - sProjectRoot.GetLength() - 1/*otherwise it gets initial slash*/);\r
 242 //                      lpszSubPath = sSubPath;\r
 243                 }\r
 244 \r
 245 //if (lpszSubPath) MessageBoxA(NULL, lpszSubPath, "BuildCache", MB_OK);\r
 246 //MessageBoxA(NULL, CStringA(sProjectRoot), sSubPath, MB_OK);\r
 247                 //err = !wgEnumFiles_safe(CStringA(sProjectRoot), lpszSubPath, WGEFF_NoRecurse|WGEFF_FullPath|WGEFF_DirStatusAll, &fillstatusmap, this);\r
 248                 //CTGitPath path;\r
 249                 //path.SetFromWin(sSubPath);\r
 250                 git_wc_status_kind status;\r
 251 \r
 252                 err = g_IndexFileMap.GetFileStatus((CString&)sProjectRoot,sSubPath,&status,true,true,fillstatusmap,this);\r
 253                 \r
 254                 //err = g_IndexFileMap.GetFileStatus(sProjectRoot,&path,\r
 255                 /*err = svn_client_status4 (&youngest,\r
 256                         filepath.GetDirectory().GetSVNApiPath(pool),\r
 257                         &rev,\r
 258                         fillstatusmap,\r
 259                         this,\r
 260                         svn_depth_immediates,           //depth\r
 261                         TRUE,           //getall\r
 262                         FALSE,          //update\r
 263                         TRUE,           //noignore\r
 264                         FALSE,          //ignore externals\r
 265                         NULL,\r
 266                         localctx,\r
 267                         pool);*/\r
 268         }\r
 269         catch ( ... )\r
 270         {\r
 271         }\r
 272 \r
 273         // Error present if function is not under version control\r
 274         if (err != NULL)\r
 275         {\r
 276 //              svn_error_clear(err);\r
 277 //              svn_pool_destroy (pool);                                //free allocated memory\r
 278                 return &invalidstatus;  \r
 279         }\r
 280 \r
 281 //      svn_error_clear(err);\r
 282 //      svn_pool_destroy (pool);                                //free allocated memory\r
 283         m_TimeStamp = GetTickCount();\r
 284         const FileStatusCacheEntry * ret = NULL;\r
 285         FileStatusMap::const_iterator iter;\r
 286         if ((iter = m_cache.find(filepath.GetWinPath())) != m_cache.end())\r
 287         {\r
 288                 ret = &iter->second;\r
 289                 m_mostRecentPath = filepath;\r
 290                 m_mostRecentStatus = ret;\r
 291         }\r
 292         else\r
 293         {\r
 294                 // for SUBST'ed drives, Subversion doesn't return a path with a backslash\r
 295                 // e.g. G:\ but only G: when fetching the status. So search for that\r
 296                 // path too before giving up.\r
 297                 // This is especially true when right-clicking directly on a SUBST'ed\r
 298                 // drive to get the context menu\r
 299                 if (_tcslen(filepath.GetWinPath())==3)\r
 300                 {\r
 301                         if ((iter = m_cache.find((LPCTSTR)filepath.GetWinPathString().Left(2))) != m_cache.end())\r
 302                         {\r
 303                                 ret = &iter->second;\r
 304                                 m_mostRecentPath = filepath;\r
 305                                 m_mostRecentStatus = ret;\r
 306                         }\r
 307                 }               \r
 308         }\r
 309         if (ret)\r
 310                 return ret;\r
 311         return &invalidstatus;\r
 312 }\r
 313 \r
 314 DWORD GitFolderStatus::GetTimeoutValue()\r
 315 {\r
 316         DWORD timeout = GITFOLDERSTATUS_CACHETIMEOUT;\r
 317         DWORD factor = m_cache.size()/200;\r
 318         if (factor==0)\r
 319                 factor = 1;\r
 320         return factor*timeout;\r
 321 }\r
 322 \r
 323 const FileStatusCacheEntry * GitFolderStatus::GetFullStatus(const CTGitPath& filepath, BOOL bIsFolder, BOOL bColumnProvider)\r
 324 {\r
 325         const FileStatusCacheEntry * ret = NULL;\r
 326 \r
 327         CString sProjectRoot;\r
 328         BOOL bHasAdminDir = g_ShellCache.HasSVNAdminDir(filepath.GetWinPath(), bIsFolder, &sProjectRoot);\r
 329         \r
 330         //no overlay for unversioned folders\r
 331         if ((!bColumnProvider)&&(!bHasAdminDir))\r
 332                 return &invalidstatus;\r
 333         //for the SVNStatus column, we have to check the cache to see\r
 334         //if it's not just unversioned but ignored\r
 335         ret = GetCachedItem(filepath);\r
 336         if ((ret)&&(ret->status == git_wc_status_unversioned)&&(bIsFolder)&&(bHasAdminDir))\r
 337         {\r
 338                 // an 'unversioned' folder, but with an ADMIN dir --> nested layout!\r
 339                 // NOTE: this could be a sub-project in git, or just some standalone project inside of another, either way a TODO\r
 340                 ret = BuildCache(filepath, sProjectRoot, bIsFolder, TRUE);\r
 341                 if (ret)\r
 342                         return ret;\r
 343                 else\r
 344                         return &invalidstatus;\r
 345         }\r
 346         if (ret)\r
 347                 return ret;\r
 348 \r
 349         //if it's not in the cache and has no admin dir, then we assume\r
 350         //it's not ignored too\r
 351         if ((bColumnProvider)&&(!bHasAdminDir))\r
 352                 return &invalidstatus;\r
 353         ret = BuildCache(filepath, sProjectRoot, bIsFolder);\r
 354         if (ret)\r
 355                 return ret;\r
 356         else\r
 357                 return &invalidstatus;\r
 358 }\r
 359 \r
 360 const FileStatusCacheEntry * GitFolderStatus::GetCachedItem(const CTGitPath& filepath)\r
 361 {\r
 362         sCacheKey.assign(filepath.GetWinPath());\r
 363         FileStatusMap::const_iterator iter;\r
 364         const FileStatusCacheEntry *retVal;\r
 365 \r
 366         if(m_mostRecentPath.IsEquivalentTo(CTGitPath(sCacheKey.c_str())))\r
 367         {\r
 368                 // We've hit the same result as we were asked for last time\r
 369                 ATLTRACE2(_T("fast cache hit for %s\n"), filepath);\r
 370                 retVal = m_mostRecentStatus;\r
 371         }\r
 372         else if ((iter = m_cache.find(sCacheKey)) != m_cache.end())\r
 373         {\r
 374                 ATLTRACE2(_T("cache found for %s\n"), filepath);\r
 375                 retVal = &iter->second;\r
 376                 m_mostRecentStatus = retVal;\r
 377                 m_mostRecentPath = CTGitPath(sCacheKey.c_str());\r
 378         }\r
 379         else\r
 380         {\r
 381                 retVal = NULL;\r
 382         }\r
 383 \r
 384         if(retVal != NULL)\r
 385         {\r
 386                 // We found something in a cache - check that the cache is not timed-out or force-invalidated\r
 387                 DWORD now = GetTickCount();\r
 388 \r
 389                 if ((now >= m_TimeStamp)&&((now - m_TimeStamp) > GetTimeoutValue()))\r
 390                 {\r
 391                         // Cache is timed-out\r
 392                         ATLTRACE("Cache timed-out\n");\r
 393                         ClearCache();\r
 394                         retVal = NULL;\r
 395                 }\r
 396                 else if(WaitForSingleObject(m_hInvalidationEvent, 0) == WAIT_OBJECT_0)\r
 397                 {\r
 398                         // TortoiseProc has just done something which has invalidated the cache\r
 399                         ATLTRACE("Cache invalidated\n");\r
 400                         ClearCache();\r
 401                         retVal = NULL;\r
 402                 }\r
 403                 return retVal;\r
 404         }\r
 405         return NULL;\r
 406 }\r
 407 \r
 408 void GitFolderStatus::fillstatusmap(CString &path,git_wc_status_kind status,void *pUserData)\r
 409 {\r
 410         GitFolderStatus *Stat = (GitFolderStatus*)pUserData;\r
 411 \r
 412         FileStatusMap &cache = Stat->m_cache;\r
 413         FileStatusCacheEntry s;\r
 414         s.needslock = false;\r
 415         s.tree_conflict = false;\r
 416 \r
 417         s.author = Stat->authors.GetString(NULL);\r
 418         s.url = Stat->urls.GetString(NULL);\r
 419 //      s.rev = -1;\r
 420         s.owner = Stat->owners.GetString(NULL);\r
 421 \r
 422         s.status = status;\r
 423 \r
 424         //s.status = GitStatus::GetMoreImportant(s.status, status->text_status);\r
 425         //s.status = GitStatus::GetMoreImportant(s.status, status->prop_status);\r
 426         //s.status = GitStatusFromWingit(pFile->nStatus);\r
 427 \r
 428         // TODO ?: s.blaha = pFile->nStage\r
 429 \r
 430         //s.lock = status->repos_lock;\r
 431         //s.tree_conflict = (status->tree_conflict != NULL);\r
 432 \r
 433         s.askedcounter = GITFOLDERSTATUS_CACHETIMES;\r
 434         //stdstring str;\r
 435         //if (pFile->sFileName)\r
 436         //{\r
 437         //      str = CUnicodeUtils::StdGetUnicode(pFile->sFileName);\r
 438         //      std::replace(str.begin(), str.end(), '/', '\\');\r
 439 //MessageBox(NULL, str.c_str(), _T(""), MB_OK);\r
 440         //}\r
 441         //else\r
 442         //      str = _T(" ");\r
 443         if( path.Right(1) == _T("\\"))\r
 444         {\r
 445                 path=path.Left(path.GetLength()-1);\r
 446         }\r
 447         stdstring str;\r
 448         str=path;\r
 449         cache[str] = s;\r
 450 \r
 451         return;\r
 452 }\r
 453 \r
 454 #if 0\r
 455 git_error_t* GitFolderStatus::fillstatusmap(void * baton, const char * path, git_wc_status2_t * status, apr_pool_t * /*pool*/)\r
 456 {\r
 457         GitFolderStatus * Stat = (GitFolderStatus *)baton;\r
 458         FileStatusMap * cache = &Stat->m_cache;\r
 459         FileStatusCacheEntry s;\r
 460         s.needslock = false;\r
 461         s.tree_conflict = false;\r
 462         if ((status)&&(status->entry))\r
 463         {\r
 464                 s.author = Stat->authors.GetString(status->entry->cmt_author);\r
 465                 s.url = Stat->urls.GetString(status->entry->url);\r
 466                 s.rev = status->entry->cmt_rev;\r
 467                 s.owner = Stat->owners.GetString(status->entry->lock_owner);\r
 468                 if (status->entry->present_props)\r
 469                         s.needslock = strstr(status->entry->present_props, "svn:needs-lock") ? true : false;\r
 470         }\r
 471         else\r
 472         {\r
 473                 s.author = Stat->authors.GetString(NULL);\r
 474                 s.url = Stat->urls.GetString(NULL);\r
 475                 s.rev = -1;\r
 476                 s.owner = Stat->owners.GetString(NULL);\r
 477         }\r
 478         s.status = git_wc_status_none;\r
 479         if (status)\r
 480         {\r
 481                 s.status = GitStatus::GetMoreImportant(s.status, status->text_status);\r
 482                 s.status = GitStatus::GetMoreImportant(s.status, status->prop_status);\r
 483                 s.lock = status->repos_lock;\r
 484                 s.tree_conflict = (status->tree_conflict != NULL);\r
 485         }\r
 486         s.askedcounter = GITFOLDERSTATUS_CACHETIMES;\r
 487         stdstring str;\r
 488         if (path)\r
 489         {\r
 490                 str = CUnicodeUtils::StdGetUnicode(path);\r
 491                 std::replace(str.begin(), str.end(), '/', '\\');\r
 492         }\r
 493         else\r
 494                 str = _T(" ");\r
 495         (*cache)[str] = s;\r
 496 \r
 497         return GIT_NO_ERROR;\r
 498 }\r
 499 \r
 500 git_error_t* GitFolderStatus::findfolderstatus(void * baton, const char * path, git_wc_status2_t * status, apr_pool_t * /*pool*/)\r
 501 {\r
 502         GitFolderStatus * Stat = (GitFolderStatus *)baton;\r
 503         if ((Stat)&&(Stat->folderpath.IsEquivalentTo(CTGitPath(CString(path)))))\r
 504         {\r
 505                 Stat->dirstatus = status;\r
 506         }\r
 507 \r
 508         return GIT_NO_ERROR;\r
 509 }\r
 510 #endif\r
 511 \r
 512 void GitFolderStatus::ClearCache()\r
 513 {\r
 514         m_cache.clear();\r
 515         m_mostRecentStatus = NULL;\r
 516         m_mostRecentPath.Reset();\r
 517         // If we're about to rebuild the cache, there's no point hanging on to \r
 518         // an event which tells us that it's invalid\r
 519         ResetEvent(m_hInvalidationEvent);\r
 520 }\r