src/TortoiseProc/ConfigureGitExe.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2008-2016 - 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 "StringUtils.h"
  22 #include "Git.h"
  23 #include "MessageBox.h"
  24 #include "AppUtils.h"
  25
  26 #define GIT_FOR_WINDOWS_URL L"https://git-for-windows.github.io/"
  27
  28 class CConfigureGitExe
  29 {
  30 public:
  31         CConfigureGitExe()
  32                 : m_regCygwinHack(L"Software\\TortoiseGit\\CygwinHack", FALSE)
  33                 , m_regMsys2Hack(L"Software\\TortoiseGit\\Msys2Hack", FALSE)
  34         {};
  35
  36         static bool CheckGitVersion(HWND hwnd)
  37         {
  38                 if (CAppUtils::GetMsysgitVersion() >= 0x01090500)
  39                         return true;
  40
  41                 CString tmp;
  42                 tmp.Format(IDS_PROC_OLDMSYSGIT, L"1.9.5+");
  43                 int ret = CMessageBox::ShowCheck(hwnd, tmp, L"TortoiseGit", 1, IDI_EXCLAMATION, CString(MAKEINTRESOURCE(IDS_PROC_GOTOMSYSGITWEBSITE)), CString(MAKEINTRESOURCE(IDS_ABORTBUTTON)), CString(MAKEINTRESOURCE(IDS_IGNOREBUTTON)), L"OldMsysgitVersionWarning", CString(MAKEINTRESOURCE(IDS_PROC_NOTSHOWAGAINIGNORE)));
  44                 if (ret == 3)
  45                         return true;
  46
  47                 CMessageBox::RemoveRegistryKey(L"OldMsysgitVersionWarning"); // only store answer if it is "Ignore"
  48                 if (ret == 1)
  49                         ShellExecute(hwnd, L"open", GIT_FOR_WINDOWS_URL, nullptr, nullptr, SW_SHOW);
  50
  51                 return false;
  52         }
  53
  54 protected:
  55         CRegDWORD               m_regCygwinHack;
  56         CRegDWORD               m_regMsys2Hack;
  57         CRegString              m_regMsysGitPath;
  58         CRegString              m_regMsysGitExtranPath;
  59
  60         static void PerformCommonGitPathCleanup(CString& path)
  61         {
  62                 path.Trim(L"\"'");
  63
  64                 if (path.Find(L'%') >= 0)
  65                 {
  66                         int neededSize = ExpandEnvironmentStrings(path, nullptr, 0);
  67                         CString origPath(path);
  68                         ExpandEnvironmentStrings(origPath, path.GetBufferSetLength(neededSize), neededSize);
  69                         path.ReleaseBuffer();
  70                 }
  71
  72                 path.Replace(L'/', L'\\');
  73                 path.Replace(L"\\\\", L"\\");
  74
  75                 if (CStringUtils::EndsWith(path, L"git.exe"))
  76                         path.Truncate(path.GetLength() - 7);
  77
  78                 path.TrimRight(L'\\');
  79
  80                 // prefer git.exe in cmd-directory for Git for Windows based on msys2
  81                 if (path.GetLength() > 12 && (CStringUtils::EndsWith(path, L"\\mingw32\\bin") || CStringUtils::EndsWith(path, L"\\mingw64\\bin")) && PathFileExists(path.Left(path.GetLength() - 12) + L"\\cmd\\git.exe"))
  82                         path = path.Left(path.GetLength() - 12) + L"\\cmd";
  83
  84                 // prefer git.exe in bin-directory, see https://github.com/msysgit/msysgit/issues/103
  85                 if (path.GetLength() > 5 && CStringUtils::EndsWith(path, L"\\cmd") && PathFileExists(path.Left(path.GetLength() - 4) + L"\\bin\\git.exe"))
  86                         path = path.Left(path.GetLength() - 4) + L"\\bin";
  87         }
  88
  89         static bool GuessExtraPath(CString gitpath, CString& pathaddition)
  90         {
  91                 if (gitpath.IsEmpty())
  92                         return false;
  93
  94                 PerformCommonGitPathCleanup(gitpath);
  95
  96                 if (!CStringUtils::EndsWith(gitpath, L"bin"))
  97                         return false;
  98
  99                 gitpath.Truncate(gitpath.GetLength() - 3);
 100                 gitpath += L"mingw\\bin";
 101                 if (!::PathFileExists(gitpath))
 102                         return false;
 103
 104                 if (pathaddition.Find(gitpath + L';') >= 0 || CStringUtils::EndsWith(pathaddition, gitpath))
 105                         return false;
 106
 107                 pathaddition = gitpath + pathaddition;
 108                 return true;
 109         }
 110
 111         static bool SelectFolder(HWND hwnd, CString& gitpath, CString& pathaddition)
 112         {
 113                 CString dir;
 114                 dir = gitpath;
 115                 if (!dir.IsEmpty())
 116                         dir += L"\\git.exe";
 117                 if (!CCommonAppUtils::FileOpenSave(dir, nullptr, 0, IDS_GITEXEFILEFILTER, true, hwnd))
 118                         return false;
 119
 120                 gitpath = dir;
 121                 PerformCommonGitPathCleanup(gitpath);
 122                 if (!PathFileExists(gitpath + L"\\git.exe"))
 123                         CMessageBox::Show(hwnd, IDS_PROC_NOMSYSGIT, IDS_APPNAME, MB_ICONEXCLAMATION);
 124                 GuessExtraPath(gitpath, pathaddition);
 125                 return true;
 126         }
 127
 128         bool CheckGitExe(HWND hwnd, CString& gitpath, CString& pathaddition, int versionLabelId, std::function<void(UINT)> callHelp, bool* needWorkarounds = nullptr)
 129         {
 130                 SetWindowText(GetDlgItem(hwnd, versionLabelId), L"");
 131
 132                 PerformCommonGitPathCleanup(gitpath);
 133
 134                 GuessExtraPath(gitpath, pathaddition);
 135
 136                 if (gitpath.IsEmpty() || !PathFileExists(gitpath + L"\\git.exe"))
 137                 {
 138                         CMessageBox::Show(hwnd, IDS_PROC_NOMSYSGIT, IDS_APPNAME, MB_ICONERROR);
 139                         return false;
 140                 }
 141
 142                 CString oldpath = m_regMsysGitPath;
 143                 CString oldextranpath = m_regMsysGitExtranPath;
 144
 145                 StoreSetting(hwnd, gitpath, m_regMsysGitPath);
 146                 StoreSetting(hwnd, pathaddition, m_regMsysGitExtranPath);
 147                 SCOPE_EXIT{
 148                         StoreSetting(hwnd, oldpath, m_regMsysGitPath);
 149                         StoreSetting(hwnd, oldextranpath, m_regMsysGitExtranPath);
 150                 };
 151
 152                 CString checkhelpHint;
 153                 checkhelpHint.LoadString(IDS_SEEMANUALGITEXEPATH);
 154
 155                 g_Git.m_bInitialized = false;
 156
 157                 if (g_Git.CheckMsysGitDir(FALSE))
 158                 {
 159                         CString out;
 160                         int ret = g_Git.Run(L"git.exe --version", &out, CP_UTF8);
 161                         SetWindowText(GetDlgItem(hwnd, versionLabelId), out);
 162                         if (out.IsEmpty())
 163                         {
 164                                 if (ret == 0xC0000135)
 165                                 {
 166                                         if (CMessageBox::Show(hwnd, IDS_ERR_GITDLLMISSING, IDS_APPNAME, 1, IDI_ERROR, IDS_MSGBOX_OK, IDS_MSGBOX_HELP) == 2)
 167                                                 callHelp(IDD_SETTINGSMAIN);
 168                                         return false;
 169                                 }
 170                                 CString tmp;
 171                                 tmp.Format(IDS_ERR_GITCALLFAILED, ret);
 172                                 tmp.AppendChar(L'\n');
 173                                 tmp.AppendChar(L'\n');
 174                                 tmp.Append(checkhelpHint);
 175                                 if (CMessageBox::Show(hwnd, tmp, L"TortoiseGit", 1, IDI_ERROR, CString(MAKEINTRESOURCE(IDS_MSGBOX_OK)), CString(MAKEINTRESOURCE(IDS_MSGBOX_HELP))) == 2)
 176                                         callHelp(IDD_SETTINGSMAIN);
 177                                 return false;
 178                         }
 179                         else if (!CStringUtils::StartsWith(out.Trim(), L"git version "))
 180                         {
 181                                 CString tmp;
 182                                 tmp.Format(IDS_ERR_GITNOVALIDOUTPUT, out.Trim());
 183                                 tmp.AppendChar(L'\n');
 184                                 tmp.AppendChar(L'\n');
 185                                 tmp.Append(checkhelpHint);
 186                                 if (CMessageBox::Show(hwnd, tmp, L"TortoiseGit", 1, IDI_ERROR, CString(MAKEINTRESOURCE(IDS_MSGBOX_OK)), CString(MAKEINTRESOURCE(IDS_MSGBOX_HELP))) == 2)
 187                                         callHelp(IDD_SETTINGSMAIN);
 188                                 return false;
 189                         }
 190                         else if (!(CGit::ms_bCygwinGit || CGit::ms_bMsys2Git) && out.Find(L"msysgit") == -1 && out.Find(L"windows") == -1)
 191                         {
 192                                 bool wasAlreadyWarned = !needWorkarounds || *needWorkarounds;
 193                                 if (CMessageBox::Show(hwnd, IDS_ERR_GITNEEDHACKS, IDS_APPNAME, 1, IDI_INFORMATION, IDS_MSGBOX_OK, IDS_MSGBOX_HELP) == 2)
 194                                         callHelp(IDD_SETTINGSMAIN);
 195                                 if (needWorkarounds)
 196                                         *needWorkarounds = true;
 197                                 if (!wasAlreadyWarned)
 198                                         return false;
 199                         }
 200                         else if ((CGit::ms_bCygwinGit || CGit::ms_bMsys2Git) && out.Find(L"msysgit") > 0 && out.Find(L"windows") > 0)
 201                         {
 202                                 if (CMessageBox::Show(hwnd, IDS_ERR_GITUNNEEDEDHACKS, IDS_APPNAME, 1, IDI_INFORMATION, IDS_MSGBOX_OK, IDS_MSGBOX_HELP) == 2)
 203                                         callHelp(IDD_SETTINGSMAIN);
 204                                 if (needWorkarounds)
 205                                         *needWorkarounds = true;
 206                                 return false;
 207                         }
 208                 }
 209                 else
 210                 {
 211                         CString tmp;
 212                         tmp.LoadString(IDS_PROC_NOMSYSGIT);
 213                         tmp.AppendChar(L'\n');
 214                         tmp.AppendChar(L'\n');
 215                         tmp.Append(checkhelpHint);
 216                         if (CMessageBox::Show(hwnd, tmp, L"TortoiseGit", 1, IDI_ERROR, CString(MAKEINTRESOURCE(IDS_MSGBOX_OK)), CString(MAKEINTRESOURCE(IDS_MSGBOX_HELP))) == 2)
 217                                 callHelp(IDD_SETTINGSMAIN);
 218                         return false;
 219                 }
 220
 221                 CGit::ms_LastMsysGitVersion = 0;
 222                 if (!CheckGitVersion(hwnd))
 223                         return false;
 224                 return true;
 225         }
 226
 227         template<class T, class Reg>
 228         void StoreSetting(HWND hwnd, const T& value, Reg& registryKey)
 229         {
 230                 registryKey = value;
 231                 if (registryKey.GetLastError() != ERROR_SUCCESS)
 232                         CMessageBox::Show(hwnd, registryKey.getErrorString(), L"TortoiseGit", MB_ICONERROR);
 233         }
 234 };