src/TortoiseShell/ExplorerCommand.cpp

   1 // TortoiseGit- a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2021-2022 - TortoiseSVN
   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 #include "stdafx.h"
  20 #include "ExplorerCommand.h"
  21
  22 CExplorerCommandEnum::CExplorerCommandEnum(const std::vector<CExplorerCommand> &vec)
  23 : m_vecCommands(vec)
  24 {
  25 }
  26
  27 HRESULT __stdcall CExplorerCommandEnum::QueryInterface(REFIID refiid, void **ppv)
  28 {
  29         *ppv = nullptr;
  30         if (IID_IUnknown == refiid || IID_IEnumExplorerCommand == refiid)
  31                 *ppv = this;
  32
  33         if (*ppv)
  34         {
  35                 static_cast<LPUNKNOWN>(*ppv)->AddRef();
  36                 return S_OK;
  37         }
  38         return E_NOINTERFACE;
  39 }
  40
  41 ULONG __stdcall CExplorerCommandEnum::AddRef()
  42 {
  43         return ++m_cRefCount;
  44 }
  45
  46 ULONG __stdcall CExplorerCommandEnum::Release()
  47 {
  48         --m_cRefCount;
  49         if (m_cRefCount == 0)
  50         {
  51                 delete this;
  52                 return 0;
  53         }
  54         return m_cRefCount;
  55 }
  56
  57 HRESULT __stdcall CExplorerCommandEnum::Next(ULONG celt, IExplorerCommand **rgelt, ULONG *pceltFetched)
  58 {
  59         HRESULT hr = S_FALSE;
  60
  61         if (!celt)
  62                 celt = 1;
  63         if (pceltFetched)
  64                 *pceltFetched = 0;
  65
  66         ULONG i = 0;
  67         for (; i < celt; ++i)
  68         {
  69                 if (m_iCur == static_cast<ULONG>(m_vecCommands.size()))
  70                         break;
  71
  72                 rgelt[i] = new CExplorerCommand(m_vecCommands[m_iCur].m_title,
  73                                                                                 m_vecCommands[m_iCur].m_iconId,
  74                                                                                 m_vecCommands[m_iCur].m_cmd,
  75                                                                                 m_vecCommands[m_iCur].m_appDir,
  76                                                                                 m_vecCommands[m_iCur].m_uuidSource,
  77                                                                                 m_vecCommands[m_iCur].m_itemStates,
  78                                                                                 m_vecCommands[m_iCur].m_itemStatesFolder,
  79                                                                                 m_vecCommands[m_iCur].m_paths,
  80                                                                                 m_vecCommands[m_iCur].m_subItems,
  81                                                                                 m_vecCommands[m_iCur].m_site);
  82                 rgelt[i]->AddRef();
  83
  84                 if (pceltFetched)
  85                         (*pceltFetched)++;
  86
  87                 ++m_iCur;
  88         }
  89
  90         if (i == celt)
  91                 hr = S_OK;
  92
  93         return hr;
  94 }
  95
  96 HRESULT __stdcall CExplorerCommandEnum::Skip(ULONG celt)
  97 {
  98         if ((m_iCur + static_cast<int>(celt)) >= m_vecCommands.size())
  99                 return S_FALSE;
 100         m_iCur += celt;
 101         return S_OK;
 102 }
 103
 104 HRESULT __stdcall CExplorerCommandEnum::Reset()
 105 {
 106         m_iCur = 0;
 107         return S_OK;
 108 }
 109
 110 HRESULT __stdcall CExplorerCommandEnum::Clone(IEnumExplorerCommand **ppenum)
 111 {
 112         if (!ppenum)
 113                 return E_POINTER;
 114
 115         try
 116         {
 117                 CExplorerCommandEnum *newEnum = new CExplorerCommandEnum(m_vecCommands);
 118
 119                 newEnum->AddRef();
 120                 newEnum->m_iCur = m_iCur;
 121                 *ppenum = newEnum;
 122         }
 123         catch (const std::bad_alloc &)
 124         {
 125                 return E_OUTOFMEMORY;
 126         }
 127         return S_OK;
 128 }
 129
 130 CExplorerCommand::CExplorerCommand(const std::wstring &title, UINT iconId,
 131                                                                    int                           cmd,
 132                                                                    const std::wstring &          appDir,
 133                                                                    const std::wstring &          uuidSource,
 134                                                                    DWORD                         itemStates,
 135                                                                    DWORD                         itemStatesFolder,
 136                                                                    std::vector<std::wstring>     paths,
 137                                                                    std::vector<CExplorerCommand> subItems,
 138                                                                    Microsoft::WRL::ComPtr<IUnknown> site)
 139         : m_cRefCount(0)
 140         , m_title(title)
 141         , m_iconId(iconId)
 142         , m_cmd(cmd)
 143         , m_appDir(appDir)
 144         , m_uuidSource(uuidSource)
 145         , m_itemStates(itemStates)
 146         , m_itemStatesFolder(itemStatesFolder)
 147         , m_paths(paths)
 148         , m_subItems(subItems)
 149         , m_regDiffLater(L"Software\\TortoiseGitMerge\\DiffLater", L"")
 150         , m_site(site)
 151 {
 152 }
 153
 154 HRESULT __stdcall CExplorerCommand::QueryInterface(REFIID refiid, void **ppv)
 155 {
 156         *ppv = nullptr;
 157         if (IID_IUnknown == refiid || IID_IExplorerCommand == refiid)
 158                 *ppv = this;
 159
 160         if (*ppv)
 161         {
 162                 static_cast<LPUNKNOWN>(*ppv)->AddRef();
 163                 return S_OK;
 164         }
 165         return E_NOINTERFACE;
 166 }
 167
 168 ULONG __stdcall CExplorerCommand::AddRef()
 169 {
 170         return ++m_cRefCount;
 171 }
 172
 173 ULONG __stdcall CExplorerCommand::Release()
 174 {
 175         --m_cRefCount;
 176         if (m_cRefCount == 0)
 177         {
 178                 delete this;
 179                 return 0;
 180         }
 181         return m_cRefCount;
 182 }
 183
 184 HRESULT __stdcall CExplorerCommand::GetTitle(IShellItemArray * /*psiItemArray*/, LPWSTR *ppszName)
 185 {
 186         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 187         if (m_title.empty())
 188         {
 189                 *ppszName = nullptr;
 190                 return S_FALSE;
 191         }
 192         SHStrDupW(m_title.c_str(), ppszName);
 193         return S_OK;
 194 }
 195
 196 HRESULT __stdcall CExplorerCommand::GetIcon(IShellItemArray * /*psiItemArray*/, LPWSTR *ppszIcon)
 197 {
 198         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 199         if (m_iconId == 0)
 200         {
 201                 SHStrDupW(L"", ppszIcon);
 202                 return S_FALSE;
 203         }
 204         std::wstring iconPath = m_appDir + L"TortoiseGitProc.exe,-";
 205         iconPath += std::to_wstring(m_iconId);
 206         SHStrDupW(iconPath.c_str(), ppszIcon);
 207         return S_OK;
 208 }
 209
 210 HRESULT __stdcall CExplorerCommand::GetToolTip(IShellItemArray* /*psiItemArray*/, LPWSTR* ppszInfotip)
 211 {
 212         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 213         *ppszInfotip = nullptr;
 214         return E_NOTIMPL;
 215 }
 216
 217 HRESULT __stdcall CExplorerCommand::GetCanonicalName(GUID *pguidCommandName)
 218 {
 219         CTraceToOutputDebugString::Instance()(__FUNCTION__);
 220         *pguidCommandName = __uuidof(this);
 221         return S_OK;
 222 }
 223
 224 HRESULT __stdcall CExplorerCommand::GetState(IShellItemArray * /*psiItemArray*/, BOOL /*fOkToBeSlow*/, EXPCMDSTATE *pCmdState)
 225 {
 226         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 227         *pCmdState = ECS_ENABLED;
 228         if (m_title.empty())
 229                 return E_FAIL;
 230         return S_OK;
 231 }
 232
 233 HRESULT __stdcall CExplorerCommand::Invoke(IShellItemArray * /*psiItemArray*/, IBindCtx * /*pbc*/)
 234 {
 235         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 236         std::wstring cwdFolder;
 237         if (m_paths.empty())
 238         {
 239                 // use the users desktop path as the CWD
 240                 wchar_t desktopDir[MAX_PATH] = {0};
 241                 SHGetSpecialFolderPath(nullptr, desktopDir, CSIDL_DESKTOPDIRECTORY, TRUE);
 242                 cwdFolder = desktopDir;
 243         }
 244         else
 245         {
 246                 cwdFolder = m_paths[0];
 247                 if (!PathIsDirectory(cwdFolder.c_str()))
 248                 {
 249                         cwdFolder = cwdFolder.substr(0, cwdFolder.rfind('\\'));
 250                 }
 251         }
 252
 253         CShellExt::InvokeCommand(m_cmd, m_appDir, m_uuidSource,
 254                                                          GetForegroundWindow(), m_itemStates, m_itemStatesFolder, m_paths,
 255                                                          m_paths.empty() ? L"" : m_paths[0],
 256                                                          m_regDiffLater, m_site);
 257         return S_OK;
 258 }
 259
 260 HRESULT __stdcall CExplorerCommand::GetFlags(EXPCMDFLAGS *pFlags)
 261 {
 262         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 263         *pFlags = ECF_DEFAULT;
 264         if (!m_subItems.empty())
 265                 *pFlags = ECF_HASSUBCOMMANDS;
 266         if (m_title.empty())
 267                 *pFlags = ECF_ISSEPARATOR;
 268         return S_OK;
 269 }
 270
 271 HRESULT __stdcall CExplorerCommand::EnumSubCommands(IEnumExplorerCommand **ppEnum)
 272 {
 273         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 274         if (m_subItems.empty())
 275                 return E_INVALIDARG;
 276         *ppEnum = new CExplorerCommandEnum(m_subItems);
 277         (*ppEnum)->AddRef();
 278         return S_OK;
 279 }
 280
 281 HRESULT __stdcall CExplorerCommand::SetSite(IUnknown * pUnkSite)
 282 {
 283         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 284         m_site = pUnkSite;
 285         return S_OK;
 286 }
 287
 288 HRESULT __stdcall CExplorerCommand::GetSite(REFIID riid, void ** ppvSite)
 289 {
 290         CTraceToOutputDebugString::Instance()(__FUNCTION__ ": title: %s\n", m_title.c_str());
 291         return m_site.CopyTo(riid, ppvSite);
 292 }