1ef83a4511ec67bdb645342a1c28f6a33b454535
[reactos.git] / reactos / dll / win32 / shell32 / folders / CRegFolder.cpp
1 /*
2 * ReactOS Shell
3 *
4 * Copyright 2016 Giannis Adamopoulos
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #include <precomp.h>
22
23 WINE_DEFAULT_DEBUG_CHANNEL (shell);
24
25 HRESULT CGuidItemExtractIcon_CreateInstance(LPCITEMIDLIST pidl, REFIID iid, LPVOID * ppvOut)
26 {
27 CComPtr<IDefaultExtractIconInit> initIcon;
28 HRESULT hr;
29 GUID const * riid;
30 int icon_idx;
31 WCHAR wTemp[MAX_PATH];
32
33 hr = SHCreateDefaultExtractIcon(IID_PPV_ARG(IDefaultExtractIconInit,&initIcon));
34 if (FAILED(hr))
35 return hr;
36
37 if (_ILIsDesktop(pidl))
38 {
39 initIcon->SetNormalIcon(swShell32Name, -IDI_SHELL_DESKTOP);
40 return initIcon->QueryInterface(iid, ppvOut);
41 }
42
43 riid = _ILGetGUIDPointer(pidl);
44 if (!riid)
45 return E_FAIL;
46
47 /* my computer and other shell extensions */
48 static const WCHAR fmt[] = { 'C', 'L', 'S', 'I', 'D', '\\',
49 '{', '%', '0', '8', 'l', 'x', '-', '%', '0', '4', 'x', '-', '%', '0', '4', 'x', '-',
50 '%', '0', '2', 'x', '%', '0', '2', 'x', '-', '%', '0', '2', 'x', '%', '0', '2', 'x',
51 '%', '0', '2', 'x', '%', '0', '2', 'x', '%', '0', '2', 'x', '%', '0', '2', 'x', '}', 0
52 };
53 WCHAR xriid[50];
54
55 swprintf(xriid, fmt,
56 riid->Data1, riid->Data2, riid->Data3,
57 riid->Data4[0], riid->Data4[1], riid->Data4[2], riid->Data4[3],
58 riid->Data4[4], riid->Data4[5], riid->Data4[6], riid->Data4[7]);
59
60 const WCHAR* iconname = NULL;
61 if (_ILIsBitBucket(pidl))
62 {
63 static const WCHAR szFull[] = {'F','u','l','l',0};
64 static const WCHAR szEmpty[] = {'E','m','p','t','y',0};
65 CComPtr<IEnumIDList> EnumIDList;
66 CoInitialize(NULL);
67
68 CComPtr<IShellFolder2> psfRecycleBin;
69 CComPtr<IShellFolder> psfDesktop;
70 hr = SHGetDesktopFolder(&psfDesktop);
71
72 if (SUCCEEDED(hr))
73 hr = psfDesktop->BindToObject(pidl, NULL, IID_PPV_ARG(IShellFolder2, &psfRecycleBin));
74 if (SUCCEEDED(hr))
75 hr = psfRecycleBin->EnumObjects(NULL, SHCONTF_FOLDERS | SHCONTF_NONFOLDERS, &EnumIDList);
76
77 ULONG itemcount;
78 LPITEMIDLIST pidl = NULL;
79 if (SUCCEEDED(hr) && (hr = EnumIDList->Next(1, &pidl, &itemcount)) == S_OK)
80 {
81 CoTaskMemFree(pidl);
82 iconname = szFull;
83 } else {
84 iconname = szEmpty;
85 }
86 }
87
88 if (HCR_GetIconW(xriid, wTemp, iconname, MAX_PATH, &icon_idx))
89 {
90 initIcon->SetNormalIcon(wTemp, icon_idx);
91 }
92 else
93 {
94 if (IsEqualGUID(*riid, CLSID_MyComputer))
95 initIcon->SetNormalIcon(swShell32Name, -IDI_SHELL_MY_COMPUTER);
96 else if (IsEqualGUID(*riid, CLSID_MyDocuments))
97 initIcon->SetNormalIcon(swShell32Name, -IDI_SHELL_MY_DOCUMENTS);
98 else if (IsEqualGUID(*riid, CLSID_NetworkPlaces))
99 initIcon->SetNormalIcon(swShell32Name, -IDI_SHELL_MY_NETWORK_PLACES);
100 else
101 initIcon->SetNormalIcon(swShell32Name, -IDI_SHELL_FOLDER);
102 }
103
104 return initIcon->QueryInterface(iid, ppvOut);
105 }
106
107 class CRegFolder :
108 public CComObjectRootEx<CComMultiThreadModelNoCS>,
109 public IShellFolder2
110 {
111 private:
112 GUID m_guid;
113 CAtlStringW m_rootPath;
114 CComHeapPtr<ITEMIDLIST> m_pidlRoot;
115
116 HRESULT GetGuidItemAttributes (LPCITEMIDLIST pidl, LPDWORD pdwAttributes);
117 public:
118 CRegFolder();
119 ~CRegFolder();
120 HRESULT WINAPI Initialize(const GUID *pGuid, LPCITEMIDLIST pidlRoot, LPCWSTR lpszPath);
121
122 // IShellFolder
123 virtual HRESULT WINAPI ParseDisplayName(HWND hwndOwner, LPBC pbc, LPOLESTR lpszDisplayName, ULONG *pchEaten, PIDLIST_RELATIVE *ppidl, ULONG *pdwAttributes);
124 virtual HRESULT WINAPI EnumObjects(HWND hwndOwner, DWORD dwFlags, LPENUMIDLIST *ppEnumIDList);
125 virtual HRESULT WINAPI BindToObject(PCUIDLIST_RELATIVE pidl, LPBC pbcReserved, REFIID riid, LPVOID *ppvOut);
126 virtual HRESULT WINAPI BindToStorage(PCUIDLIST_RELATIVE pidl, LPBC pbcReserved, REFIID riid, LPVOID *ppvOut);
127 virtual HRESULT WINAPI CompareIDs(LPARAM lParam, PCUIDLIST_RELATIVE pidl1, PCUIDLIST_RELATIVE pidl2);
128 virtual HRESULT WINAPI CreateViewObject(HWND hwndOwner, REFIID riid, LPVOID *ppvOut);
129 virtual HRESULT WINAPI GetAttributesOf(UINT cidl, PCUITEMID_CHILD_ARRAY apidl, DWORD *rgfInOut);
130 virtual HRESULT WINAPI GetUIObjectOf(HWND hwndOwner, UINT cidl, PCUITEMID_CHILD_ARRAY apidl, REFIID riid, UINT * prgfInOut, LPVOID * ppvOut);
131 virtual HRESULT WINAPI GetDisplayNameOf(PCUITEMID_CHILD pidl, DWORD dwFlags, LPSTRRET strRet);
132 virtual HRESULT WINAPI SetNameOf(HWND hwndOwner, PCUITEMID_CHILD pidl, LPCOLESTR lpName, DWORD dwFlags, PITEMID_CHILD *pPidlOut);
133
134 /* ShellFolder2 */
135 virtual HRESULT WINAPI GetDefaultSearchGUID(GUID *pguid);
136 virtual HRESULT WINAPI EnumSearches(IEnumExtraSearch **ppenum);
137 virtual HRESULT WINAPI GetDefaultColumn(DWORD dwRes, ULONG *pSort, ULONG *pDisplay);
138 virtual HRESULT WINAPI GetDefaultColumnState(UINT iColumn, DWORD *pcsFlags);
139 virtual HRESULT WINAPI GetDetailsEx(PCUITEMID_CHILD pidl, const SHCOLUMNID *pscid, VARIANT *pv);
140 virtual HRESULT WINAPI GetDetailsOf(PCUITEMID_CHILD pidl, UINT iColumn, SHELLDETAILS *psd);
141 virtual HRESULT WINAPI MapColumnToSCID(UINT column, SHCOLUMNID *pscid);
142
143 DECLARE_NOT_AGGREGATABLE(CRegFolder)
144
145 DECLARE_PROTECT_FINAL_CONSTRUCT()
146
147 BEGIN_COM_MAP(CRegFolder)
148 COM_INTERFACE_ENTRY_IID(IID_IShellFolder2, IShellFolder2)
149 COM_INTERFACE_ENTRY_IID(IID_IShellFolder, IShellFolder)
150 END_COM_MAP()
151 };
152
153 CRegFolder::CRegFolder()
154 {
155 }
156
157 CRegFolder::~CRegFolder()
158 {
159 }
160
161 HRESULT WINAPI CRegFolder::Initialize(const GUID *pGuid, LPCITEMIDLIST pidlRoot, LPCWSTR lpszPath)
162 {
163 memcpy(&m_guid, pGuid, sizeof(m_guid));
164
165 m_rootPath = lpszPath;
166 if (!m_rootPath)
167 return E_OUTOFMEMORY;
168
169 m_pidlRoot.Attach(ILClone(pidlRoot));
170 if (!m_pidlRoot)
171 return E_OUTOFMEMORY;
172
173 return S_OK;
174 }
175
176 HRESULT CRegFolder::GetGuidItemAttributes (LPCITEMIDLIST pidl, LPDWORD pdwAttributes)
177 {
178 /* First try to get them from the registry */
179 if (HCR_GetFolderAttributes(pidl, pdwAttributes) && *pdwAttributes)
180 {
181 return S_OK;
182 }
183
184 *pdwAttributes &= SFGAO_CANLINK;
185 return S_OK;
186 }
187
188 HRESULT WINAPI CRegFolder::ParseDisplayName(HWND hwndOwner, LPBC pbc, LPOLESTR lpszDisplayName,
189 ULONG *pchEaten, PIDLIST_RELATIVE *ppidl, ULONG *pdwAttributes)
190 {
191 LPITEMIDLIST pidl;
192
193 if (!lpszDisplayName || !ppidl)
194 return E_INVALIDARG;
195
196 *ppidl = 0;
197
198 if (pchEaten)
199 *pchEaten = 0;
200
201 UINT cch = wcslen(lpszDisplayName);
202 if (cch < 39 || lpszDisplayName[0] != L':' || lpszDisplayName[1] != L':')
203 return E_FAIL;
204
205 pidl = _ILCreateGuidFromStrW(lpszDisplayName + 2);
206 if (pidl == NULL)
207 return E_FAIL;
208
209 if (cch < 41)
210 {
211 *ppidl = pidl;
212 if (pdwAttributes && *pdwAttributes)
213 {
214 GetGuidItemAttributes(*ppidl, pdwAttributes);
215 }
216 }
217 else
218 {
219 HRESULT hr = SHELL32_ParseNextElement(this, hwndOwner, pbc, &pidl, lpszDisplayName + 41, pchEaten, pdwAttributes);
220 if (SUCCEEDED(hr))
221 {
222 *ppidl = pidl;
223 }
224 return hr;
225 }
226
227 return S_OK;
228 }
229
230 HRESULT WINAPI CRegFolder::EnumObjects(HWND hwndOwner, DWORD dwFlags, LPENUMIDLIST *ppEnumIDList)
231 {
232 return E_NOTIMPL;
233 }
234
235 HRESULT WINAPI CRegFolder::BindToObject(PCUIDLIST_RELATIVE pidl, LPBC pbcReserved, REFIID riid, LPVOID *ppvOut)
236 {
237 CComPtr<IPersistFolder> pFolder;
238 HRESULT hr;
239
240 if (!ppvOut || !pidl || !pidl->mkid.cb)
241 return E_INVALIDARG;
242
243 *ppvOut = NULL;
244
245 GUID *pGUID = _ILGetGUIDPointer(pidl);
246 if (!pGUID)
247 {
248 ERR("CRegFolder::BindToObject called for non guid item!\n");
249 return E_INVALIDARG;
250 }
251
252 LPITEMIDLIST pidlChild = ILCloneFirst (pidl);
253 if (!pidlChild)
254 return E_OUTOFMEMORY;
255
256 CComPtr<IShellFolder> psf;
257 hr = SHELL32_CoCreateInitSF(m_pidlRoot, NULL, pidlChild, pGUID, -1, IID_PPV_ARG(IShellFolder, &psf));
258 ILFree(pidlChild);
259 if (FAILED(hr))
260 return hr;
261
262 if (_ILIsPidlSimple (pidl))
263 {
264 return psf->QueryInterface(riid, ppvOut);
265 }
266 else
267 {
268 return psf->BindToObject(ILGetNext (pidl), pbcReserved, riid, ppvOut);
269 }
270 }
271
272 HRESULT WINAPI CRegFolder::BindToStorage(PCUIDLIST_RELATIVE pidl, LPBC pbcReserved, REFIID riid, LPVOID *ppvOut)
273 {
274 return E_NOTIMPL;
275 }
276
277 HRESULT WINAPI CRegFolder::CompareIDs(LPARAM lParam, PCUIDLIST_RELATIVE pidl1, PCUIDLIST_RELATIVE pidl2)
278 {
279 if (!pidl1 || !pidl2 || pidl1->mkid.cb == 0 || pidl2->mkid.cb == 0)
280 {
281 ERR("Got an empty pidl!\n");
282 return E_INVALIDARG;
283 }
284
285 GUID const *clsid1 = _ILGetGUIDPointer (pidl1);
286 GUID const *clsid2 = _ILGetGUIDPointer (pidl2);
287
288 if (!clsid1 && !clsid2)
289 {
290 ERR("Got no guid pidl!\n");
291 return E_INVALIDARG;
292 }
293 else if (clsid1 && clsid2)
294 {
295 if (memcmp(clsid1, clsid2, sizeof(GUID)) == 0)
296 return SHELL32_CompareChildren(this, lParam, pidl1, pidl2);
297
298 return SHELL32_CompareDetails(this, lParam, pidl1, pidl2);
299 }
300
301 /* Guid folders come first compared to everything else */
302 return MAKE_COMPARE_HRESULT(clsid1 ? -1 : 1);
303 }
304
305 HRESULT WINAPI CRegFolder::CreateViewObject(HWND hwndOwner, REFIID riid, LPVOID *ppvOut)
306 {
307 return E_NOTIMPL;
308 }
309
310 HRESULT WINAPI CRegFolder::GetAttributesOf(UINT cidl, PCUITEMID_CHILD_ARRAY apidl, DWORD *rgfInOut)
311 {
312 if (!rgfInOut || !cidl || !apidl)
313 return E_INVALIDARG;
314
315 if (*rgfInOut == 0)
316 *rgfInOut = ~0;
317
318 while(cidl > 0 && *apidl)
319 {
320 if (_ILIsSpecialFolder(*apidl))
321 GetGuidItemAttributes(*apidl, rgfInOut);
322 else
323 ERR("Got an unkown pidl here!\n");
324 apidl++;
325 cidl--;
326 }
327
328 /* make sure SFGAO_VALIDATE is cleared, some apps depend on that */
329 *rgfInOut &= ~SFGAO_VALIDATE;
330
331 return S_OK;
332 }
333
334 HRESULT WINAPI CRegFolder::GetUIObjectOf(HWND hwndOwner, UINT cidl, PCUITEMID_CHILD_ARRAY apidl,
335 REFIID riid, UINT * prgfInOut, LPVOID * ppvOut)
336 {
337 LPVOID pObj = NULL;
338 HRESULT hr = E_INVALIDARG;
339
340 if (!ppvOut)
341 return hr;
342
343 *ppvOut = NULL;
344
345 if ((IsEqualIID (riid, IID_IExtractIconA) || IsEqualIID (riid, IID_IExtractIconW)) && (cidl == 1))
346 {
347 hr = CGuidItemExtractIcon_CreateInstance(apidl[0], riid, &pObj);
348 }
349 else
350 hr = E_NOINTERFACE;
351
352 *ppvOut = pObj;
353 return hr;
354
355 }
356
357 HRESULT WINAPI CRegFolder::GetDisplayNameOf(PCUITEMID_CHILD pidl, DWORD dwFlags, LPSTRRET strRet)
358 {
359 if (!strRet || !_ILIsSpecialFolder(pidl))
360 return E_INVALIDARG;
361
362 if (!pidl->mkid.cb)
363 {
364 LPWSTR pszPath = (LPWSTR)CoTaskMemAlloc((MAX_PATH + 1) * sizeof(WCHAR));
365 if (!pszPath)
366 return E_OUTOFMEMORY;
367
368 /* parsing name like ::{...} */
369 pszPath[0] = ':';
370 pszPath[1] = ':';
371 SHELL32_GUIDToStringW(m_guid, &pszPath[2]);
372
373 strRet->uType = STRRET_WSTR;
374 strRet->pOleStr = pszPath;
375
376 return S_OK;
377 }
378
379 HRESULT hr;
380 GUID const *clsid = _ILGetGUIDPointer (pidl);
381
382 /* First of all check if we need to query the name from the child item */
383 if (GET_SHGDN_FOR (dwFlags) == SHGDN_FORPARSING &&
384 GET_SHGDN_RELATION (dwFlags) == SHGDN_NORMAL)
385 {
386 int bWantsForParsing = FALSE;
387
388 /*
389 * We can only get a filesystem path from a shellfolder if the
390 * value WantsFORPARSING in CLSID\\{...}\\shellfolder exists.
391 *
392 * Exception: The MyComputer folder doesn't have this key,
393 * but any other filesystem backed folder it needs it.
394 */
395 if (IsEqualIID (*clsid, CLSID_MyComputer))
396 {
397 bWantsForParsing = TRUE;
398 }
399 else
400 {
401 HKEY hkeyClass;
402 if (HCR_RegOpenClassIDKey(*clsid, &hkeyClass))
403 {
404 LONG res = SHGetValueW(hkeyClass, L"Shellfolder", L"WantsForParsing", NULL, NULL, NULL);
405 bWantsForParsing = (res == ERROR_SUCCESS);
406 RegCloseKey(hkeyClass);
407 }
408 }
409
410 if (bWantsForParsing)
411 {
412 /*
413 * we need the filesystem path to the destination folder.
414 * Only the folder itself can know it
415 */
416 return SHELL32_GetDisplayNameOfChild (this, pidl, dwFlags, strRet);
417 }
418 }
419
420 /* Allocate the buffer for the result */
421 LPWSTR pszPath = (LPWSTR)CoTaskMemAlloc((MAX_PATH + 1) * sizeof(WCHAR));
422 if (!pszPath)
423 return E_OUTOFMEMORY;
424
425 hr = S_OK;
426
427 if (GET_SHGDN_FOR (dwFlags) == SHGDN_FORPARSING)
428 {
429 wcscpy(pszPath, m_rootPath);
430 PWCHAR pItemName = &pszPath[wcslen(pszPath)];
431
432 /* parsing name like ::{...} */
433 pItemName[0] = ':';
434 pItemName[1] = ':';
435 SHELL32_GUIDToStringW (*clsid, &pItemName[2]);
436 }
437 else
438 {
439 /* user friendly name */
440 if (!HCR_GetClassNameW (*clsid, pszPath, MAX_PATH))
441 hr = E_FAIL;
442 }
443
444 if (SUCCEEDED(hr))
445 {
446 strRet->uType = STRRET_WSTR;
447 strRet->pOleStr = pszPath;
448 }
449 else
450 {
451 CoTaskMemFree(pszPath);
452 }
453
454 return hr;
455 }
456
457 HRESULT WINAPI CRegFolder::SetNameOf(HWND hwndOwner, PCUITEMID_CHILD pidl, /* simple pidl */
458 LPCOLESTR lpName, DWORD dwFlags, PITEMID_CHILD *pPidlOut)
459 {
460 GUID const *clsid = _ILGetGUIDPointer (pidl);
461 LPOLESTR pStr;
462 HRESULT hr;
463 WCHAR szName[100];
464
465 if (!clsid)
466 {
467 ERR("Pidl is not reg item!\n");
468 return E_FAIL;
469 }
470
471 hr = StringFromCLSID(*clsid, &pStr);
472 if (FAILED_UNEXPECTEDLY(hr))
473 return hr;
474
475 swprintf(szName, L"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\CLSID\\%s", pStr);
476
477 DWORD cbData = (wcslen(lpName) + 1) * sizeof(WCHAR);
478 LONG res = SHSetValueW(HKEY_CURRENT_USER, szName, NULL, RRF_RT_REG_SZ, lpName, cbData);
479
480 CoTaskMemFree(pStr);
481
482 if (res == ERROR_SUCCESS)
483 {
484 *pPidlOut = ILClone(pidl);
485 return S_OK;
486 }
487
488 return E_FAIL;
489 }
490
491
492 HRESULT WINAPI CRegFolder::GetDefaultSearchGUID(GUID *pguid)
493 {
494 return E_NOTIMPL;
495 }
496
497 HRESULT WINAPI CRegFolder::EnumSearches(IEnumExtraSearch ** ppenum)
498 {
499 return E_NOTIMPL;
500 }
501
502 HRESULT WINAPI CRegFolder::GetDefaultColumn(DWORD dwRes, ULONG *pSort, ULONG *pDisplay)
503 {
504 if (pSort)
505 *pSort = 0;
506 if (pDisplay)
507 *pDisplay = 0;
508
509 return S_OK;
510 }
511
512 HRESULT WINAPI CRegFolder::GetDefaultColumnState(UINT iColumn, DWORD *pcsFlags)
513 {
514 if (iColumn >= 2)
515 return E_INVALIDARG;
516 *pcsFlags = SHCOLSTATE_TYPE_STR | SHCOLSTATE_ONBYDEFAULT;
517 return S_OK;
518 }
519
520 HRESULT WINAPI CRegFolder::GetDetailsEx(PCUITEMID_CHILD pidl, const SHCOLUMNID *pscid, VARIANT *pv)
521 {
522 return E_NOTIMPL;
523 }
524
525 HRESULT WINAPI CRegFolder::GetDetailsOf(PCUITEMID_CHILD pidl, UINT iColumn, SHELLDETAILS *psd)
526 {
527 if (!psd || iColumn >= 2)
528 return E_INVALIDARG;
529
530 GUID const *clsid = _ILGetGUIDPointer (pidl);
531
532 if (!clsid)
533 {
534 ERR("Pidl is not reg item!\n");
535 return E_INVALIDARG;
536 }
537
538 switch(iColumn)
539 {
540 case 0: /* name */
541 return GetDisplayNameOf(pidl, SHGDN_NORMAL | SHGDN_INFOLDER, &psd->str);
542 case 1: /* comment */
543 HKEY hKey;
544 if (HCR_RegOpenClassIDKey(*clsid, &hKey))
545 {
546 psd->str.cStr[0] = 0x00;
547 psd->str.uType = STRRET_CSTR;
548 RegLoadMUIStringA(hKey, "InfoTip", psd->str.cStr, MAX_PATH, NULL, 0, NULL);
549 RegCloseKey(hKey);
550 return S_OK;
551 }
552 }
553 return E_FAIL;
554 }
555
556 HRESULT WINAPI CRegFolder::MapColumnToSCID(UINT column, SHCOLUMNID *pscid)
557 {
558 return E_NOTIMPL;
559 }
560
561 /* In latest windows version this is exported but it takes different arguments! */
562 HRESULT CRegFolder_CreateInstance(const GUID *pGuid, LPCITEMIDLIST pidlRoot, LPCWSTR lpszPath, REFIID riid, void **ppv)
563 {
564 return ShellObjectCreatorInit<CRegFolder>(pGuid, pidlRoot, lpszPath, riid, ppv);
565 }