src/Git/Git.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2014 - 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
  27 class CFilterData
  28 {
  29 public:
  30         CFilterData()
  31         {
  32                 m_From=m_To=-1;
  33                 m_IsRegex=1;
  34         }
  35         __time64_t m_From;
  36         __time64_t m_To;
  37         CString m_Author;
  38         CString m_Committer;
  39         CString m_MessageFilter;
  40         BOOL m_IsRegex;
  41 };
  42
  43 class CGitCall
  44 {
  45 public:
  46         CGitCall(){}
  47         CGitCall(CString cmd):m_Cmd(cmd){}
  48
  49         CString                 GetCmd()const{return m_Cmd;}
  50         void                    SetCmd(CString cmd){m_Cmd=cmd;}
  51
  52         //This function is called when command output data is available.
  53         //When this function returns 'true' the git command should be aborted.
  54         //This behavior is not implemented yet.
  55         virtual bool    OnOutputData(const BYTE* data, size_t size)=0;
  56         virtual bool    OnOutputErrData(const BYTE* data, size_t size)=0;
  57         virtual void    OnEnd(){}
  58
  59 private:
  60         CString m_Cmd;
  61
  62 };
  63
  64 class CTGitPath;
  65 class CEnvironment:public std::vector<TCHAR>
  66 {
  67 public:
  68         void CopyProcessEnvironment();
  69         CString GetEnv(const TCHAR *name);
  70         void SetEnv(const TCHAR* name, const TCHAR* value);
  71 };
  72 class CGit
  73 {
  74 private:
  75         GitAdminDir m_GitDir;
  76         CString         gitLastErr;
  77 protected:
  78         bool m_IsGitDllInited;
  79         GIT_DIFF m_GitDiff;
  80         GIT_DIFF m_GitSimpleListDiff;
  81 public:
  82         CComCriticalSection                     m_critGitDllSec;
  83         bool    m_IsUseGitDLL;
  84         bool    m_IsUseLibGit2;
  85         DWORD   m_IsUseLibGit2_mask;
  86
  87         CEnvironment m_Environment;
  88
  89         static BOOL GitPathFileExists(const CString &path)
  90         {
  91                 if(path[0] == _T('\\') && path[1] == _T('\\'))
  92                 //it is netshare \\server\sharefoldername
  93                 // \\server\.git will create smb error log.
  94                 {
  95                         int length = path.GetLength();
  96
  97                         if(length<2)
  98                                 return false;
  99
 100                         int start = path.Find(_T('\\'),2);
 101                         if(start<0)
 102                                 return false;
 103
 104                         start = path.Find(_T('\\'),start+1);
 105                         if(start<0)
 106                                 return false;
 107
 108                         return PathFileExists(path);
 109
 110                 }
 111                 else
 112                         return PathFileExists(path);
 113         }
 114         void CheckAndInitDll()
 115         {
 116                 if(!m_IsGitDllInited)
 117                 {
 118                         git_init();
 119                         m_IsGitDllInited=true;
 120                 }
 121         }
 122
 123         GIT_DIFF GetGitDiff()
 124         {
 125                 if(m_GitDiff)
 126                         return m_GitDiff;
 127                 else
 128                 {
 129                         git_open_diff(&m_GitDiff,"-C -M -r");
 130                         return m_GitDiff;
 131                 }
 132         }
 133
 134         GIT_DIFF GetGitSimpleListDiff()
 135         {
 136                 if(m_GitSimpleListDiff)
 137                         return m_GitSimpleListDiff;
 138                 else
 139                 {
 140                         git_open_diff(&m_GitSimpleListDiff,"-r -r");
 141                         return m_GitSimpleListDiff;
 142                 }
 143         }
 144
 145         BOOL CheckMsysGitDir(BOOL bFallback = TRUE);
 146         BOOL m_bInitialized;
 147
 148         CString GetHomeDirectory();
 149         CString GetGitLocalConfig();
 150         CString GetGitGlobalConfig();
 151         CString GetGitGlobalXDGConfigPath();
 152         CString GetGitGlobalXDGConfig();
 153         CString GetGitSystemConfig();
 154         static CStringA GetGitPathStringA(const CString &path);
 155         static CString ms_LastMsysGitDir;       // the last msysgitdir added to the path, blank if none
 156         static int ms_LastMsysGitVersion;
 157         static int m_LogEncode;
 158         static bool IsBranchNameValid(const CString& branchname);
 159         bool IsBranchTagNameUnique(const CString& name);
 160         bool BranchTagExists(const CString& name, bool isBranch = true);
 161         unsigned int Hash2int(const CGitHash &hash);
 162
 163         PROCESS_INFORMATION m_CurrentGitPi;
 164
 165         CGit(void);
 166         ~CGit(void);
 167
 168         int Run(CString cmd, CString* output, int code);
 169         int Run(CString cmd, CString* output, CString* outputErr, int code);
 170         int Run(CString cmd, BYTE_VECTOR *byte_array, BYTE_VECTOR *byte_arrayErr = NULL);
 171         int Run(CGitCall* pcall);
 172
 173 private:
 174         static DWORD WINAPI AsyncReadStdErrThread(LPVOID lpParam);
 175         typedef struct AsyncReadStdErrThreadArguments
 176         {
 177                 HANDLE fileHandle;
 178                 CGitCall* pcall;
 179         } ASYNCREADSTDERRTHREADARGS, *PASYNCREADSTDERRTHREADARGS;
 180         CString GetUnifiedDiffCmd(const CTGitPath& path, const git_revnum_t& rev1, const git_revnum_t& rev2, bool bMerge, bool bCombine, int diffContext);
 181
 182 public:
 183         int RunAsync(CString cmd, PROCESS_INFORMATION *pi, HANDLE* hRead, HANDLE *hErrReadOut, CString *StdioFile = NULL);
 184         int RunLogFile(CString cmd, const CString &filename, CString *stdErr);
 185
 186         int GetDiffPath(CTGitPathList *PathList, CGitHash *hash1, CGitHash *hash2, char *arg=NULL);
 187
 188         int GetGitEncode(TCHAR* configkey);
 189
 190         bool IsFastForward(const CString &from, const CString &to, CGitHash * commonAncestor = NULL);
 191         CString GetConfigValue(const CString& name, int encoding = CP_UTF8, BOOL RemoveCR = TRUE);
 192         bool GetConfigValueBool(const CString& name);
 193
 194         int SetConfigValue(const CString& key, const CString& value, CONFIG_TYPE type = CONFIG_LOCAL, int encoding = CP_UTF8);
 195         int UnsetConfigValue(const CString& key, CONFIG_TYPE type = CONFIG_LOCAL, int encoding = CP_UTF8);
 196
 197         CString GetUserName(void);
 198         CString GetUserEmail(void);
 199         CString GetCurrentBranch(bool fallback = false);
 200         CString GetSymbolicRef(const wchar_t* symbolicRefName = L"HEAD", bool bStripRefsHeads = true);
 201         // read current branch name from HEAD file, returns 0 on success, -1 on failure, 1 detached (branch name "HEAD" returned)
 202         static int GetCurrentBranchFromFile(const CString &sProjectRoot, CString &sBranchOut, bool fallback = false);
 203         BOOL CheckCleanWorkTree();
 204         int Revert(const CString& commit, const CTGitPathList &list, bool keep=true);
 205         int Revert(const CString& commit, const CTGitPath &path);
 206         CString GetGitLastErr(const CString& msg);
 207         CString GetGitLastErr(const CString& msg, int cmd);
 208         static CString GetLibGit2LastErr();
 209         static CString GetLibGit2LastErr(const CString& msg);
 210         bool SetCurrentDir(CString path, bool submodule = false)
 211         {
 212                 bool b = m_GitDir.HasAdminDir(path, submodule ? false : !!PathIsDirectory(path), &m_CurrentDir);
 213                 if (!b && g_GitAdminDir.IsBareRepo(path))
 214                 {
 215                         m_CurrentDir = path;
 216                         b = true;
 217                 }
 218                 if(m_CurrentDir.GetLength() == 2 && m_CurrentDir[1] == _T(':')) //C: D:
 219                 {
 220                         m_CurrentDir += _T('\\');
 221                 }
 222                 return b;
 223         }
 224         CString m_CurrentDir;
 225
 226         enum
 227         {
 228                 LOG_ORDER_CHRONOLOGIALREVERSED,
 229                 LOG_ORDER_TOPOORDER,
 230                 LOG_ORDER_DATEORDER,
 231         };
 232
 233         typedef enum
 234         {
 235                 BRANCH_LOCAL            = 0x1,
 236                 BRANCH_REMOTE           = 0x2,
 237                 BRANCH_FETCH_HEAD       = 0x4,
 238                 BRANCH_LOCAL_F          = BRANCH_LOCAL  | BRANCH_FETCH_HEAD,
 239                 BRANCH_ALL                      = BRANCH_LOCAL  | BRANCH_REMOTE,
 240                 BRANCH_ALL_F            = BRANCH_ALL    | BRANCH_FETCH_HEAD,
 241         }BRANCH_TYPE;
 242
 243         typedef enum
 244         {
 245                 LOG_INFO_STAT=0x1,
 246                 LOG_INFO_FILESTATE=0x2,
 247                 LOG_INFO_PATCH=0x4,
 248                 LOG_INFO_FULLHISTORY=0x8,
 249                 LOG_INFO_BOUNDARY=0x10,
 250         LOG_INFO_ALL_BRANCH=0x20,
 251                 LOG_INFO_ONLY_HASH=0x40,
 252                 LOG_INFO_DETECT_RENAME=0x80,
 253                 LOG_INFO_DETECT_COPYRENAME=0x100,
 254                 LOG_INFO_FIRST_PARENT = 0x200,
 255                 LOG_INFO_NO_MERGE = 0x400,
 256                 LOG_INFO_FOLLOW = 0x800,
 257                 LOG_INFO_SHOW_MERGEDFILE=0x1000,
 258                 LOG_INFO_FULL_DIFF = 0x2000,
 259                 LOG_INFO_SIMPILFY_BY_DECORATION = 0x4000,
 260                 LOG_INFO_LOCAL_BRANCHES = 0x8000,
 261         }LOG_INFO_MASK;
 262
 263         typedef enum
 264         {
 265                 LOCAL_BRANCH,
 266                 REMOTE_BRANCH,
 267                 TAG,
 268                 STASH,
 269                 BISECT_GOOD,
 270                 BISECT_BAD,
 271                 NOTES,
 272                 UNKNOWN,
 273
 274         }REF_TYPE;
 275
 276         int GetRemoteList(STRING_VECTOR &list);
 277         int GetBranchList(STRING_VECTOR &list, int *Current,BRANCH_TYPE type=BRANCH_LOCAL);
 278         int GetTagList(STRING_VECTOR &list);
 279         int GetRemoteTags(const CString& remote, STRING_VECTOR &list);
 280         int GetMapHashToFriendName(MAP_HASH_NAME &map);
 281
 282         CString DerefFetchHead();
 283
 284         // FixBranchName():
 285         // When branchName == FETCH_HEAD, derefrence it.
 286         // A selected branch name got from GetBranchList(), with flag BRANCH_FETCH_HEAD enabled,
 287         // should go through this function before it is used.
 288         CString FixBranchName_Mod(CString& branchName);
 289         CString FixBranchName(const CString& branchName);
 290
 291         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);
 292
 293         int GetHash(CGitHash &hash, const CString& friendname);
 294
 295         int BuildOutputFormat(CString &format,bool IsFull=TRUE);
 296         //int GetShortLog(const CString &log,CTGitPath * path=NULL, int count =-1);
 297         static void StringAppend(CString *str, const BYTE *p, int code = CP_UTF8, int length = -1);
 298
 299         BOOL CanParseRev(CString ref);
 300         BOOL IsInitRepos();
 301         int ListConflictFile(CTGitPathList &list, const CTGitPath *path = nullptr);
 302         int GetRefList(STRING_VECTOR &list);
 303
 304         int RefreshGitIndex();
 305         int GetOneFile(const CString &Refname, const CTGitPath &path, const CString &outputfile);
 306
 307         //Example: master -> refs/heads/master
 308         CString GetFullRefName(const CString& shortRefName);
 309         //Removes 'refs/heads/' or just 'refs'. Example: refs/heads/master -> master
 310         static CString StripRefName(CString refName);
 311
 312         int GetCommitDiffList(const CString &rev1,const CString &rev2,CTGitPathList &outpathlist);
 313         int GetInitAddList(CTGitPathList &outpathlist);
 314
 315         __int64 filetime_to_time_t(const FILETIME *ft)
 316         {
 317                 long long winTime = ((long long)ft->dwHighDateTime << 32) + ft->dwLowDateTime;
 318                 winTime -= 116444736000000000LL; /* Windows to Unix Epoch conversion */
 319                 winTime /= 10000000;             /* Nano to seconds resolution */
 320                 return (time_t)winTime;
 321         }
 322
 323         int GetFileModifyTime(LPCTSTR filename, __int64 *time, bool * isDir=NULL)
 324         {
 325                 WIN32_FILE_ATTRIBUTE_DATA fdata;
 326                 if (GetFileAttributesEx(filename, GetFileExInfoStandard, &fdata))
 327                 {
 328                         if(time)
 329                                 *time = filetime_to_time_t(&fdata.ftLastWriteTime);
 330
 331                         if(isDir)
 332                                 *isDir = !!( fdata.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY);
 333
 334                         return 0;
 335                 }
 336                 return -1;
 337         }
 338
 339         int GetShortHASHLength();
 340
 341         static BOOL GetShortName(CString ref, CString &shortname, CString prefix)
 342         {
 343                 //TRACE(_T("%s %s\r\n"),ref,prefix);
 344                 if (ref.Left(prefix.GetLength()) ==  prefix)
 345                 {
 346                         shortname = ref.Right(ref.GetLength() - prefix.GetLength());
 347                         if (shortname.Right(3) == _T("^{}"))
 348                                 shortname=shortname.Left(shortname.GetLength() - 3);
 349                         return TRUE;
 350                 }
 351                 return FALSE;
 352         }
 353
 354         static CString GetShortName(const CString& ref, REF_TYPE *type);
 355
 356         enum
 357         {
 358                 GIT_CMD_CLONE,
 359                 GIT_CMD_FETCH,
 360                 GIT_CMD_COMMIT_UPDATE_INDEX,
 361                 GIT_CMD_DIFF,
 362                 GIT_CMD_RESET,
 363         };
 364         bool UsingLibGit2(int cmd);
 365
 366         int GetUnifiedDiff(const CTGitPath& path, const git_revnum_t& rev1, const git_revnum_t& rev2, CString patchfile, bool bMerge, bool bCombine, int diffContext);
 367         int GetUnifiedDiff(const CTGitPath& path, const git_revnum_t& rev1, const git_revnum_t& rev2, CStringA * buffer, bool bMerge, bool bCombine, int diffContext);
 368 };
 369 extern void GetTempPath(CString &path);
 370 extern CString GetTempFile();
 371 extern DWORD GetTortoiseGitTempPath(DWORD nBufferLength, LPTSTR lpBuffer);
 372
 373 extern CGit g_Git;