src/Git/Git.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2012 - 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(TCHAR *name);
  70         void SetEnv(TCHAR* name, TCHAR* value);
  71 };
  72 class CGit
  73 {
  74 private:
  75         GitAdminDir m_GitDir;
  76 protected:
  77         bool m_IsGitDllInited;
  78         GIT_DIFF m_GitDiff;
  79         GIT_DIFF m_GitSimpleListDiff;
  80 public:
  81         CComCriticalSection                     m_critGitDllSec;
  82         bool    m_IsUseGitDLL;
  83         bool    m_IsUseLibGit2;
  84
  85         CEnvironment m_Environment;
  86
  87         static BOOL GitPathFileExists(const CString &path)
  88         {
  89                 if(path[0] == _T('\\') && path[1] == _T('\\'))
  90                 //it is netshare \\server\sharefoldername
  91                 // \\server\.git will create smb error log.
  92                 {
  93                         int length = path.GetLength();
  94
  95                         if(length<2)
  96                                 return false;
  97
  98                         int start = path.Find(_T('\\'),2);
  99                         if(start<0)
 100                                 return false;
 101
 102                         start = path.Find(_T('\\'),start+1);
 103                         if(start<0)
 104                                 return false;
 105
 106                         return PathFileExists(path);
 107
 108                 }
 109                 else
 110                         return PathFileExists(path);
 111         }
 112         void CheckAndInitDll()
 113         {
 114                 if(!m_IsGitDllInited)
 115                 {
 116                         git_init();
 117                         m_IsGitDllInited=true;
 118                 }
 119         }
 120
 121         GIT_DIFF GetGitDiff()
 122         {
 123                 if(m_GitDiff)
 124                         return m_GitDiff;
 125                 else
 126                 {
 127                         git_open_diff(&m_GitDiff,"-C -M -r");
 128                         return m_GitDiff;
 129                 }
 130         }
 131
 132         GIT_DIFF GetGitSimpleListDiff()
 133         {
 134                 if(m_GitSimpleListDiff)
 135                         return m_GitSimpleListDiff;
 136                 else
 137                 {
 138                         git_open_diff(&m_GitSimpleListDiff,"-r -r");
 139                         return m_GitSimpleListDiff;
 140                 }
 141         }
 142
 143         BOOL CheckMsysGitDir();
 144         BOOL m_bInitialized;
 145
 146         CString GetHomeDirectory();
 147         CString GetGitLocalConfig();
 148         CString GetGitGlobalConfig();
 149         CString GetGitGlobalXDGConfig();
 150         CString GetGitSystemConfig();
 151         static CString ms_LastMsysGitDir;       // the last msysgitdir added to the path, blank if none
 152         static int m_LogEncode;
 153         static bool IsBranchNameValid(CString branchname);
 154         static bool IsBranchTagNameUnique(const CString& name);
 155         static bool BranchTagExists(const CString& name, bool isBranch = true);
 156         unsigned int Hash2int(CGitHash &hash);
 157 //      static CString m_MsysGitPath;
 158
 159         PROCESS_INFORMATION m_CurrentGitPi;
 160
 161         CGit(void);
 162         ~CGit(void);
 163
 164         int Run(CString cmd, CString* output, int code);
 165         int Run(CString cmd, CString* output, CString* outputErr, int code);
 166         int Run(CString cmd, BYTE_VECTOR *byte_array, BYTE_VECTOR *byte_arrayErr = NULL);
 167         int Run(CGitCall* pcall);
 168
 169 private:
 170         static DWORD WINAPI CGit::AsyncReadStdErrThread(LPVOID lpParam);
 171         typedef struct AsyncReadStdErrThreadArguments
 172         {
 173                 HANDLE fileHandle;
 174                 CGitCall* pcall;
 175         } ASYNCREADSTDERRTHREADARGS, *PASYNCREADSTDERRTHREADARGS;
 176
 177 public:
 178         int RunAsync(CString cmd, PROCESS_INFORMATION *pi, HANDLE* hRead, HANDLE *hErrReadOut, CString *StdioFile = NULL);
 179         int RunLogFile(CString cmd, const CString &filename);
 180
 181         int GetDiffPath(CTGitPathList *PathList, CGitHash *hash1, CGitHash *hash2, char *arg=NULL);
 182
 183         int GetGitEncode(TCHAR* configkey);
 184
 185         bool IsFastForward(const CString &from, const CString &to, CGitHash * commonAncestor = NULL);
 186         CString GetConfigValue(CString name, int encoding=CP_UTF8, CString *GitPath=NULL,BOOL RemoveCR=TRUE);
 187
 188         int SetConfigValue(CString key, CString value, CONFIG_TYPE type=CONFIG_LOCAL, int encoding=CP_UTF8, CString *GitPath=NULL);
 189         int UnsetConfigValue(CString key, CONFIG_TYPE type=CONFIG_LOCAL, int encoding=CP_UTF8, CString *GitPath=NULL);
 190
 191         CString GetUserName(void);
 192         CString GetUserEmail(void);
 193         CString GetCurrentBranch(void);
 194         CString GetSymbolicRef(const wchar_t* symbolicRefName = L"HEAD", bool bStripRefsHeads = true);
 195         // read current branch name from HEAD file, returns 0 on success, -1 on failure, 1 detached (branch name "HEAD" returned)
 196         int GetCurrentBranchFromFile(const CString &sProjectRoot, CString &sBranchOut);
 197         BOOL CheckCleanWorkTree();
 198         int Revert(CString commit, CTGitPathList &list, bool keep=true);
 199         int Revert(CString commit, CTGitPath &path);
 200
 201         bool SetCurrentDir(CString path, bool submodule = false)
 202         {
 203                 bool b = m_GitDir.HasAdminDir(path, submodule ? false : !!PathIsDirectory(path), &m_CurrentDir);
 204                 if (!b && g_GitAdminDir.IsBareRepo(path))
 205                 {
 206                         m_CurrentDir = path;
 207                         b = true;
 208                 }
 209                 if(m_CurrentDir.GetLength() == 2 && m_CurrentDir[1] == _T(':')) //C: D:
 210                 {
 211                         m_CurrentDir += _T('\\');
 212                 }
 213                 return b;
 214         }
 215         CString m_CurrentDir;
 216
 217         typedef enum
 218         {
 219                 BRANCH_LOCAL            = 0x1,
 220                 BRANCH_REMOTE           = 0x2,
 221                 BRANCH_FETCH_HEAD       = 0x4,
 222                 BRANCH_LOCAL_F          = BRANCH_LOCAL  | BRANCH_FETCH_HEAD,
 223                 BRANCH_ALL                      = BRANCH_LOCAL  | BRANCH_REMOTE,
 224                 BRANCH_ALL_F            = BRANCH_ALL    | BRANCH_FETCH_HEAD,
 225         }BRANCH_TYPE;
 226
 227         typedef enum
 228         {
 229                 LOG_INFO_STAT=0x1,
 230                 LOG_INFO_FILESTATE=0x2,
 231                 LOG_INFO_PATCH=0x4,
 232                 LOG_INFO_FULLHISTORY=0x8,
 233                 LOG_INFO_BOUNDARY=0x10,
 234         LOG_INFO_ALL_BRANCH=0x20,
 235                 LOG_INFO_ONLY_HASH=0x40,
 236                 LOG_INFO_DETECT_RENAME=0x80,
 237                 LOG_INFO_DETECT_COPYRENAME=0x100,
 238                 LOG_INFO_FIRST_PARENT = 0x200,
 239                 LOG_INFO_NO_MERGE = 0x400,
 240                 LOG_INFO_FOLLOW = 0x800,
 241                 LOG_INFO_SHOW_MERGEDFILE=0x1000,
 242                 LOG_INFO_FULL_DIFF = 0x2000,
 243         }LOG_INFO_MASK;
 244
 245         int GetRemoteList(STRING_VECTOR &list);
 246         int GetBranchList(STRING_VECTOR &list, int *Current,BRANCH_TYPE type=BRANCH_LOCAL);
 247         int GetTagList(STRING_VECTOR &list);
 248         int GetRemoteTags(CString remote, STRING_VECTOR &list);
 249         int GetMapHashToFriendName(MAP_HASH_NAME &map);
 250
 251         CString DerefFetchHead();
 252
 253         // FixBranchName():
 254         // When branchName == FETCH_HEAD, derefrence it.
 255         // A selected branch name got from GetBranchList(), with flag BRANCH_FETCH_HEAD enabled,
 256         // should go through this function before it is used.
 257         CString FixBranchName_Mod(CString& branchName);
 258         CString FixBranchName(const CString& branchName);
 259
 260         //hash is empty means all. -1 means all
 261
 262         int GetLog(CGitCall* pgitCall, const CString &hash, 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,
 263                                                                 CString *from=NULL,CString *to=NULL);
 264         int GetLog(BYTE_VECTOR& logOut,const CString &hash, 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,
 265                                                                 CString *from=NULL,CString *to=NULL);
 266
 267         CString GetLogCmd(const CString &hash, 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,
 268                                           CString *from=NULL,CString *to=NULL, bool paramonly=false,
 269                                           CFilterData * filter =NULL);
 270
 271         CGitHash GetHash(TCHAR* friendname);
 272         CGitHash GetHash(CString ref){return GetHash(ref.GetBuffer());}
 273
 274         int BuildOutputFormat(CString &format,bool IsFull=TRUE);
 275         //int GetShortLog(const CString &log,CTGitPath * path=NULL, int count =-1);
 276         static void StringAppend(CString *str,BYTE *p,int code=CP_UTF8,int length=-1);
 277
 278         BOOL IsOrphanBranch(CString ref);
 279         BOOL IsInitRepos();
 280         int ListConflictFile(CTGitPathList &list,CTGitPath *path=NULL);
 281         int GetRefList(STRING_VECTOR &list);
 282
 283         int RefreshGitIndex();
 284         int GetOneFile(CString Refname, CTGitPath &path, const CString &outputfile);
 285
 286         //Example: master -> refs/heads/master
 287         CString GetFullRefName(CString shortRefName);
 288         //Removes 'refs/heads/' or just 'refs'. Example: refs/heads/master -> master
 289         static CString StripRefName(CString refName);
 290
 291         int GetCommitDiffList(const CString &rev1,const CString &rev2,CTGitPathList &outpathlist);
 292         int GetInitAddList(CTGitPathList &outpathlist);
 293
 294         __int64 filetime_to_time_t(const FILETIME *ft)
 295         {
 296                 long long winTime = ((long long)ft->dwHighDateTime << 32) + ft->dwLowDateTime;
 297                 winTime -= 116444736000000000LL; /* Windows to Unix Epoch conversion */
 298                 winTime /= 10000000;             /* Nano to seconds resolution */
 299                 return (time_t)winTime;
 300         }
 301
 302         int GetFileModifyTime(LPCTSTR filename, __int64 *time, bool * isDir=NULL)
 303         {
 304                 WIN32_FILE_ATTRIBUTE_DATA fdata;
 305                 if (GetFileAttributesEx(filename, GetFileExInfoStandard, &fdata))
 306                 {
 307                         if(time)
 308                                 *time = filetime_to_time_t(&fdata.ftLastWriteTime);
 309
 310                         if(isDir)
 311                                 *isDir = !!( fdata.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY);
 312
 313                         return 0;
 314                 }
 315                 return -1;
 316         }
 317
 318         int GetShortHASHLength();
 319 };
 320 extern void GetTempPath(CString &path);
 321 extern CString GetTempFile();
 322
 323
 324 extern CGit g_Git;