src/Git/Git.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2015 - TortoiseGit
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19
  20 #pragma once
  21 #include "GitType.h"
  22 #include "GitRev.h"
  23 #include "GitStatus.h"
  24 #include "GitAdminDir.h"
  25 #include "gitdll.h"
  26 #include <functional>
  27
  28 #define REG_MSYSGIT_PATH _T("Software\\TortoiseGit\\MSysGit")
  29 #define REG_MSYSGIT_EXTRA_PATH _T("Software\\TortoiseGit\\MSysGitExtra")
  30
  31 #define DEFAULT_USE_LIBGIT2_MASK (1 << CGit::GIT_CMD_MERGE_BASE) | (1 << CGit::GIT_CMD_DELETETAGBRANCH) | (1 << CGit::GIT_CMD_GETONEFILE) | (1 << CGit::GIT_CMD_ADD) | (1 << CGit::GIT_CMD_CHECKCONFLICTS) | (1 << CGit::GIT_CMD_GET_COMMIT)
  32
  33 struct git_repository;
  34
  35 class CFilterData
  36 {
  37 public:
  38         CFilterData()
  39         {
  40                 m_From=m_To=-1;
  41                 m_IsRegex=1;
  42         }
  43         __time64_t m_From;
  44         __time64_t m_To;
  45         CString m_Author;
  46         CString m_Committer;
  47         CString m_MessageFilter;
  48         BOOL m_IsRegex;
  49 };
  50
  51 class CGitCall
  52 {
  53 public:
  54         CGitCall(){}
  55         CGitCall(CString cmd):m_Cmd(cmd){}
  56
  57         CString                 GetCmd()const{return m_Cmd;}
  58         void                    SetCmd(CString cmd){m_Cmd=cmd;}
  59
  60         //This function is called when command output data is available.
  61         //When this function returns 'true' the git command should be aborted.
  62         //This behavior is not implemented yet.
  63         virtual bool    OnOutputData(const BYTE* data, size_t size)=0;
  64         virtual bool    OnOutputErrData(const BYTE* data, size_t size)=0;
  65         virtual void    OnEnd(){}
  66
  67 private:
  68         CString m_Cmd;
  69 };
  70
  71 typedef std::function<void (const CStringA&)> GitReceiverFunc;
  72
  73 class CTGitPath;
  74 class CEnvironment : protected std::vector<TCHAR>
  75 {
  76 public:
  77         void CopyProcessEnvironment();
  78         CString GetEnv(const TCHAR *name);
  79         void SetEnv(const TCHAR* name, const TCHAR* value);
  80         void clear();
  81         bool empty();
  82         operator LPTSTR();
  83 };
  84 class CGit
  85 {
  86 private:
  87         CString         gitLastErr;
  88 protected:
  89         GIT_DIFF m_GitDiff;
  90         GIT_DIFF m_GitSimpleListDiff;
  91 #ifdef GTEST_INCLUDE_GTEST_GTEST_H_
  92 public:
  93 #endif
  94         bool m_IsGitDllInited;
  95 public:
  96         CComCriticalSection                     m_critGitDllSec;
  97         bool    m_IsUseGitDLL;
  98         bool    m_IsUseLibGit2;
  99         DWORD   m_IsUseLibGit2_mask;
 100
 101         CEnvironment m_Environment;
 102
 103         static BOOL GitPathFileExists(const CString &path)
 104         {
 105                 if(path[0] == _T('\\') && path[1] == _T('\\'))
 106                 //it is netshare \\server\sharefoldername
 107                 // \\server\.git will create smb error log.
 108                 {
 109                         int length = path.GetLength();
 110
 111                         if(length<2)
 112                                 return false;
 113
 114                         int start = path.Find(_T('\\'),2);
 115                         if(start<0)
 116                                 return false;
 117
 118                         start = path.Find(_T('\\'),start+1);
 119                         if(start<0)
 120                                 return false;
 121
 122                         return PathFileExists(path);
 123
 124                 }
 125                 else
 126                         return PathFileExists(path);
 127         }
 128         void CheckAndInitDll()
 129         {
 130                 if(!m_IsGitDllInited)
 131                 {
 132                         git_init();
 133                         m_IsGitDllInited=true;
 134                 }
 135         }
 136
 137         GIT_DIFF GetGitDiff()
 138         {
 139                 if(m_GitDiff)
 140                         return m_GitDiff;
 141                 else
 142                 {
 143                         git_open_diff(&m_GitDiff,"-C -M -r");
 144                         return m_GitDiff;
 145                 }
 146         }
 147
 148         GIT_DIFF GetGitSimpleListDiff()
 149         {
 150                 if(m_GitSimpleListDiff)
 151                         return m_GitSimpleListDiff;
 152                 else
 153                 {
 154                         git_open_diff(&m_GitSimpleListDiff,"-r -r");
 155                         return m_GitSimpleListDiff;
 156                 }
 157         }
 158
 159         BOOL CheckMsysGitDir(BOOL bFallback = TRUE);
 160         BOOL FindAndSetGitExePath(BOOL bFallback);
 161         BOOL m_bInitialized;
 162
 163         typedef enum
 164         {
 165                 GIT_CMD_CLONE,
 166                 GIT_CMD_FETCH,
 167                 GIT_CMD_COMMIT_UPDATE_INDEX,
 168                 GIT_CMD_DIFF,
 169                 GIT_CMD_RESET,
 170                 GIT_CMD_REVERT,
 171                 GIT_CMD_MERGE_BASE,
 172                 GIT_CMD_DELETETAGBRANCH,
 173                 GIT_CMD_GETONEFILE,
 174                 GIT_CMD_ADD,
 175                 GIT_CMD_PUSH,
 176                 GIT_CMD_CHECK_CLEAN_WT,
 177                 GIT_CMD_CHECKCONFLICTS,
 178                 GIT_CMD_GET_COMMIT,
 179                 GIT_CMD_LOGLISTDIFF,
 180         } LIBGIT2_CMD;
 181         bool UsingLibGit2(LIBGIT2_CMD cmd) const;
 182         /**
 183          * callback type should be git_cred_acquire_cb
 184          */
 185         static void SetGit2CredentialCallback(void* callback);
 186         static void SetGit2CertificateCheckCertificate(void* callback);
 187
 188         CString GetHomeDirectory() const;
 189         CString GetGitLocalConfig() const;
 190         CString GetGitGlobalConfig() const;
 191         CString GetGitGlobalXDGConfigPath() const;
 192         CString GetGitGlobalXDGConfig() const;
 193         CString GetGitSystemConfig() const;
 194         git_repository * GetGitRepository() const;
 195         static CStringA GetGitPathStringA(const CString &path);
 196         static CString ms_LastMsysGitDir;       // the last msysgitdir added to the path, blank if none
 197         static int ms_LastMsysGitVersion;
 198         static bool ms_bCygwinGit;
 199         static int m_LogEncode;
 200         static bool IsBranchNameValid(const CString& branchname);
 201         bool IsBranchTagNameUnique(const CString& name);
 202         /**
 203         * Checks if a branch or tag with the given name exists
 204         *isBranch is true -> branch, tag otherwise
 205         */
 206         bool BranchTagExists(const CString& name, bool isBranch = true);
 207         unsigned int Hash2int(const CGitHash &hash);
 208
 209         PROCESS_INFORMATION m_CurrentGitPi;
 210
 211         CGit(void);
 212         ~CGit(void);
 213
 214         int Run(CString cmd, CString* output, int code);
 215         int Run(CString cmd, CString* output, CString* outputErr, int code);
 216         int Run(CString cmd, BYTE_VECTOR *byte_array, BYTE_VECTOR *byte_arrayErr = NULL);
 217         int Run(CGitCall* pcall);
 218         int Run(CString cmd, const GitReceiverFunc& recv);
 219
 220 private:
 221         static DWORD WINAPI AsyncReadStdErrThread(LPVOID lpParam);
 222         typedef struct AsyncReadStdErrThreadArguments
 223         {
 224                 HANDLE fileHandle;
 225                 CGitCall* pcall;
 226         } ASYNCREADSTDERRTHREADARGS, *PASYNCREADSTDERRTHREADARGS;
 227         CString GetUnifiedDiffCmd(const CTGitPath& path, const git_revnum_t& rev1, const git_revnum_t& rev2, bool bMerge, bool bCombine, int diffContext);
 228
 229 public:
 230         int RunAsync(CString cmd, PROCESS_INFORMATION *pi, HANDLE* hRead, HANDLE *hErrReadOut, CString *StdioFile = NULL);
 231         int RunLogFile(CString cmd, const CString &filename, CString *stdErr);
 232
 233         int GetDiffPath(CTGitPathList *PathList, CGitHash *hash1, CGitHash *hash2, char *arg=NULL);
 234
 235         int GetGitEncode(TCHAR* configkey);
 236
 237         bool IsFastForward(const CString &from, const CString &to, CGitHash * commonAncestor = NULL);
 238         CString GetConfigValue(const CString& name);
 239         bool GetConfigValueBool(const CString& name);
 240         int GetConfigValueInt32(const CString& name, int def = 0);
 241
 242         int SetConfigValue(const CString& key, const CString& value, CONFIG_TYPE type = CONFIG_LOCAL);
 243         int UnsetConfigValue(const CString& key, CONFIG_TYPE type = CONFIG_LOCAL);
 244
 245         CString GetUserName(void);
 246         CString GetUserEmail(void);
 247         CString GetCurrentBranch(bool fallback = false);
 248         void GetRemoteTrackedBranch(const CString& localBranch, CString& remote, CString& branch);
 249         void GetRemoteTrackedBranchForHEAD(CString& remote, CString& branch);
 250         // read current branch name from HEAD file, returns 0 on success, -1 on failure, 1 detached (branch name "HEAD" returned)
 251         static int GetCurrentBranchFromFile(const CString &sProjectRoot, CString &sBranchOut, bool fallback = false);
 252         /**
 253         Use this method only when the HEAD is exist.
 254         */
 255         BOOL CheckCleanWorkTree(bool stagedOk = false);
 256         int Revert(const CString& commit, const CTGitPathList &list, CString& err);
 257         int Revert(const CString& commit, const CTGitPath &path, CString& err);
 258         int DeleteRef(const CString& reference);
 259         /**
 260         Use this method only if m_IsUseLibGit2 is used for fallbacks.
 261         If you directly use libgit2 methods, use GetLibGit2LastErr instead.
 262         */
 263         CString GetGitLastErr(const CString& msg);
 264         CString GetGitLastErr(const CString& msg, LIBGIT2_CMD cmd);
 265         static CString GetLibGit2LastErr();
 266         static CString GetLibGit2LastErr(const CString& msg);
 267         bool SetCurrentDir(CString path, bool submodule = false)
 268         {
 269                 bool b = GitAdminDir::HasAdminDir(path, submodule ? false : !!PathIsDirectory(path), &m_CurrentDir);
 270                 if (!b && GitAdminDir::IsBareRepo(path))
 271                 {
 272                         m_CurrentDir = path;
 273                         b = true;
 274                 }
 275                 if(m_CurrentDir.GetLength() == 2 && m_CurrentDir[1] == _T(':')) //C: D:
 276                 {
 277                         m_CurrentDir += _T('\\');
 278                 }
 279                 return b;
 280         }
 281         CString m_CurrentDir;
 282
 283         enum
 284         {
 285                 LOG_ORDER_CHRONOLOGIALREVERSED,
 286                 LOG_ORDER_TOPOORDER,
 287                 LOG_ORDER_DATEORDER,
 288         };
 289
 290         typedef enum
 291         {
 292                 BRANCH_LOCAL            = 0x1,
 293                 BRANCH_REMOTE           = 0x2,
 294                 BRANCH_FETCH_HEAD       = 0x4,
 295                 BRANCH_LOCAL_F          = BRANCH_LOCAL  | BRANCH_FETCH_HEAD,
 296                 BRANCH_ALL                      = BRANCH_LOCAL  | BRANCH_REMOTE,
 297                 BRANCH_ALL_F            = BRANCH_ALL    | BRANCH_FETCH_HEAD,
 298         }BRANCH_TYPE;
 299
 300         typedef enum
 301         {
 302                 LOG_INFO_STAT=0x1,
 303                 LOG_INFO_FILESTATE=0x2,
 304                 LOG_INFO_PATCH=0x4,
 305                 LOG_INFO_FULLHISTORY=0x8,
 306                 LOG_INFO_BOUNDARY=0x10,
 307                 LOG_INFO_ALL_BRANCH=0x20,
 308                 LOG_INFO_ONLY_HASH=0x40,
 309                 LOG_INFO_DETECT_RENAME=0x80,
 310                 LOG_INFO_DETECT_COPYRENAME=0x100,
 311                 LOG_INFO_FIRST_PARENT = 0x200,
 312                 LOG_INFO_NO_MERGE = 0x400,
 313                 LOG_INFO_FOLLOW = 0x800,
 314                 LOG_INFO_SHOW_MERGEDFILE=0x1000,
 315                 LOG_INFO_FULL_DIFF = 0x2000,
 316                 LOG_INFO_SIMPILFY_BY_DECORATION = 0x4000,
 317                 LOG_INFO_LOCAL_BRANCHES = 0x8000,
 318         }LOG_INFO_MASK;
 319
 320         typedef enum
 321         {
 322                 LOCAL_BRANCH,
 323                 REMOTE_BRANCH,
 324                 TAG,
 325                 STASH,
 326                 BISECT_GOOD,
 327                 BISECT_BAD,
 328                 NOTES,
 329                 UNKNOWN,
 330
 331         }REF_TYPE;
 332
 333         int GetRemoteList(STRING_VECTOR &list);
 334         int GetBranchList(STRING_VECTOR &list, int *Current,BRANCH_TYPE type=BRANCH_LOCAL);
 335         int GetTagList(STRING_VECTOR &list);
 336         int GetRemoteTags(const CString& remote, STRING_VECTOR& list);
 337         int DeleteRemoteRefs(const CString& remote, const STRING_VECTOR& list);
 338         int GetBranchDescriptions(MAP_STRING_STRING& map);
 339         int GetMapHashToFriendName(MAP_HASH_NAME &map);
 340         static int GetMapHashToFriendName(git_repository* repo, MAP_HASH_NAME &map);
 341
 342         CString DerefFetchHead();
 343
 344         // FixBranchName():
 345         // When branchName == FETCH_HEAD, derefrence it.
 346         // A selected branch name got from GetBranchList(), with flag BRANCH_FETCH_HEAD enabled,
 347         // should go through this function before it is used.
 348         CString FixBranchName_Mod(CString& branchName);
 349         CString FixBranchName(const CString& branchName);
 350
 351         CString GetLogCmd(const CString &range, const CTGitPath *path = NULL, int count=-1, int InfoMask = LOG_INFO_FULL_DIFF|LOG_INFO_STAT|LOG_INFO_FILESTATE|LOG_INFO_BOUNDARY|LOG_INFO_DETECT_COPYRENAME|LOG_INFO_SHOW_MERGEDFILE, bool paramonly=false, CFilterData * filter =NULL);
 352
 353         int GetHash(CGitHash &hash, const CString& friendname);
 354         static int GetHash(git_repository * repo, CGitHash &hash, const CString& friendname, bool skipFastCheck = false);
 355
 356         int BuildOutputFormat(CString &format,bool IsFull=TRUE);
 357         static void StringAppend(CString *str, const BYTE *p, int code = CP_UTF8, int length = -1);
 358
 359         BOOL CanParseRev(CString ref);
 360         /**
 361         Checks if HEAD points to an unborn branch
 362         This method assumes, that we already know that we are in a working tree.
 363         */
 364         BOOL IsInitRepos();
 365         /** Returns 0 if no conflict, if a conflict was found and -1 in case of a failure */
 366         int HasWorkingTreeConflicts();
 367         /** Returns 0 if no conflict, if a conflict was found and -1 in case of a failure */
 368         int HasWorkingTreeConflicts(git_repository* repo);
 369         int GetRefList(STRING_VECTOR &list);
 370
 371         int RefreshGitIndex();
 372         int GetOneFile(const CString &Refname, const CTGitPath &path, const CString &outputfile);
 373
 374         //Example: master -> refs/heads/master
 375         CString GetFullRefName(const CString& shortRefName);
 376         //Removes 'refs/heads/' or just 'refs'. Example: refs/heads/master -> master
 377         static CString StripRefName(CString refName);
 378
 379         int GetCommitDiffList(const CString &rev1, const CString &rev2, CTGitPathList &outpathlist, bool ignoreSpaceAtEol = false, bool ignoreSpaceChange = false, bool ignoreAllSpace = false, bool ignoreBlankLines = false);
 380         int GetInitAddList(CTGitPathList &outpathlist);
 381         int GetWorkingTreeChanges(CTGitPathList& result, bool amend = false, CTGitPathList* filterlist = nullptr);
 382
 383         __int64 filetime_to_time_t(const FILETIME *ft)
 384         {
 385                 long long winTime = ((long long)ft->dwHighDateTime << 32) + ft->dwLowDateTime;
 386                 winTime -= 116444736000000000LL; /* Windows to Unix Epoch conversion */
 387                 winTime /= 10000000;             /* Nano to seconds resolution */
 388                 return (time_t)winTime;
 389         }
 390
 391         int GetFileModifyTime(LPCTSTR filename, __int64* time, bool* isDir = nullptr, __int64* size = nullptr)
 392         {
 393                 WIN32_FILE_ATTRIBUTE_DATA fdata;
 394                 if (GetFileAttributesEx(filename, GetFileExInfoStandard, &fdata))
 395                 {
 396                         if(time)
 397                                 *time = filetime_to_time_t(&fdata.ftLastWriteTime);
 398
 399                         if (size)
 400                                 *size = ((__int64)fdata.nFileSizeHigh << 32) + fdata.nFileSizeLow;
 401
 402                         if(isDir)
 403                                 *isDir = !!( fdata.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY);
 404
 405                         return 0;
 406                 }
 407                 return -1;
 408         }
 409
 410         int GetShortHASHLength() const;
 411
 412         static BOOL GetShortName(const CString &ref, CString &shortname, CString prefix)
 413         {
 414                 //TRACE(_T("%s %s\r\n"),ref,prefix);
 415                 if (ref.Left(prefix.GetLength()) ==  prefix)
 416                 {
 417                         shortname = ref.Right(ref.GetLength() - prefix.GetLength());
 418                         if (shortname.Right(3) == _T("^{}"))
 419                                 shortname=shortname.Left(shortname.GetLength() - 3);
 420                         return TRUE;
 421                 }
 422                 return FALSE;
 423         }
 424
 425         static CString GetShortName(const CString& ref, REF_TYPE *type);
 426
 427         static bool LoadTextFile(const CString &filename, CString &msg);
 428
 429         int GetUnifiedDiff(const CTGitPath& path, const git_revnum_t& rev1, const git_revnum_t& rev2, CString patchfile, bool bMerge, bool bCombine, int diffContext);
 430         int GetUnifiedDiff(const CTGitPath& path, const git_revnum_t& rev1, const git_revnum_t& rev2, CStringA * buffer, bool bMerge, bool bCombine, int diffContext);
 431
 432         int GitRevert(int parent, const CGitHash &hash);
 433
 434         CString CombinePath(const CString &path) const
 435         {
 436                 if (path.IsEmpty())
 437                         return m_CurrentDir;
 438                 if (m_CurrentDir.IsEmpty())
 439                         return path;
 440                 return m_CurrentDir + (m_CurrentDir.Right(1) == _T("\\") ? _T("") : _T("\\")) + path;
 441         }
 442
 443         CString CombinePath(const CTGitPath &path) const
 444         {
 445                 return CombinePath(path.GetWinPath());
 446         }
 447
 448         CString CombinePath(const CTGitPath *path) const
 449         {
 450                 ATLASSERT(path);
 451                 return CombinePath(path->GetWinPath());
 452         }
 453 };
 454 extern void GetTempPath(CString &path);
 455 extern CString GetTempFile();
 456 extern DWORD GetTortoiseGitTempPath(DWORD nBufferLength, LPTSTR lpBuffer);
 457
 458 extern CGit g_Git;