Support context menu modifications for third-party file managers (XYplorer, Total Commander, Double Commander and possibly more)

src/dll/Shell.vcxproj

@@ -168,6 +168,8 @@
     <ClInclude Include="src\Expression\Expression.h" />
     <ClInclude Include="src\Parser\Parser.h" />
     <ClInclude Include="src\Parser\Token.h" />
+    <ClInclude Include="src\Include\ClassFactory.h" />
+    <ClInclude Include="src\Include\ShellExtSelectionRetriever.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="src\Expression\ArrayExpression.cpp" />
@@ -185,6 +187,8 @@
     <ClCompile Include="src\ContextMenu.cpp" />
     <ClCompile Include="src\Main.cpp" />
     <ClCompile Include="src\Initializer.cpp" />
+    <ClCompile Include="src\ClassFactory.cpp" />
+    <ClCompile Include="src\ShellExtSelectionRetriever.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="$(SolutionDir)shared\Resource\Shell.rc" />

src/dll/src/ClassFactory.cpp

@@ -0,0 +1,109 @@
+/****************************** Module Header ******************************\
+Module Name:  ClassFactory.cpp
+Project:      CppShellExtContextMenuHandler
+Copyright (c) Microsoft Corporation.
+
+The file implements the class factory for the FileContextMenuExt COM class. 
+
+This source is subject to the Microsoft Public License.
+See http://www.microsoft.com/opensource/licenses.mspx#Ms-PL.
+All other rights reserved.
+
+THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, 
+EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
+\***************************************************************************/
+
+#include <pch.h>
+#include "Include/ClassFactory.h"
+#include "Include/ShellExtSelectionRetriever.h"
+#include <new>
+#include <Shlwapi.h>
+#pragma comment(lib, "shlwapi.lib")
+
+extern Logger &_log;
+
+extern long g_cDllRef;
+
+
+ClassFactory::ClassFactory() : m_cRef(1)
+{
+    InterlockedIncrement(&g_cDllRef);
+}
+
+ClassFactory::~ClassFactory()
+{
+    InterlockedDecrement(&g_cDllRef);
+}
+
+
+//
+// IUnknown
+//
+
+IFACEMETHODIMP ClassFactory::QueryInterface(REFIID riid, void **ppv)
+{
+    __trace(L"In ClassFactory::QueryInterface");
+    static const QITAB qit[] = 
+    {
+        QITABENT(ClassFactory, IClassFactory),
+        { 0 },
+    };
+    return QISearch(this, qit, riid, ppv);
+}
+
+IFACEMETHODIMP_(ULONG) ClassFactory::AddRef()
+{
+    return InterlockedIncrement(&m_cRef);
+}
+
+IFACEMETHODIMP_(ULONG) ClassFactory::Release()
+{
+    ULONG cRef = InterlockedDecrement(&m_cRef);
+    if (0 == cRef)
+    {
+        delete this;
+    }
+    return cRef;
+}
+
+
+// 
+// IClassFactory
+//
+
+IFACEMETHODIMP ClassFactory::CreateInstance(IUnknown *pUnkOuter, REFIID riid, void **ppv)
+{
+    __trace(L"In ClassFactory::CreateInstance");
+    HRESULT hr = CLASS_E_NOAGGREGATION;
+
+    // pUnkOuter is used for aggregation. We do not support it in the sample.
+    if (pUnkOuter == NULL)
+    {
+        hr = E_OUTOFMEMORY;
+
+        // Create the COM component.
+        ShellExtSelectionRetriever *pExt = new (std::nothrow) ShellExtSelectionRetriever();
+        if (pExt)
+        {
+            // Query the specified interface.
+            hr = pExt->QueryInterface(riid, ppv);
+            pExt->Release();
+        }
+    }
+
+    return hr;
+}
+
+IFACEMETHODIMP ClassFactory::LockServer(BOOL fLock)
+{
+    if (fLock)
+    {
+        InterlockedIncrement(&g_cDllRef);
+    }
+    else
+    {
+        InterlockedDecrement(&g_cDllRef);
+    }
+    return S_OK;
+}

src/dll/src/ContextMenu.cpp

@@ -2,6 +2,7 @@
 #include "Include/Theme.h"
 #include "Include/ContextMenu.h"
 #include "Include/stb_image_write.h"
+#include "Include/ShellExtSelectionRetriever.h"
 
 using namespace Nilesoft::Diagnostics;
 #include <mutex>
@@ -133,7 +134,7 @@ struct DWM
 
 inline HMENU GET_HMENU(HWND hWnd) { return SendMSG<HMENU>(hWnd, MN_GETHMENU, 0, 0); }
 
-auto ver = &Windows::Version::Instance();
+auto ver = &Nilesoft::Windows::Version::Instance();
 
 #pragma endregion
 
@@ -4211,9 +4212,12 @@ namespace Nilesoft
 			}
 		}
 
-		void ContextMenu::build_system_menuitems(HMENU hMenu, menuitem_t *menu, bool is_root)
+		void ContextMenu::build_system_menuitems(HMENU hMenu, menuitem_t *menu, bool is_root, bool skip_init)
 		{
-			::SendMessageW(hwnd.owner, WM_INITMENUPOPUP, reinterpret_cast<WPARAM>(hMenu), 0xFFFFFFFF);
+			if (!skip_init)
+			{
+				::SendMessageW(hwnd.owner, WM_INITMENUPOPUP, reinterpret_cast<WPARAM>(hMenu), 0xFFFFFFFF);
+			}
 
 			auto itmes_count = ::GetMenuItemCount(hMenu);
 
@@ -4267,6 +4271,12 @@ namespace Nilesoft
 						if(mii.cch > 0)
 						{
 							item->title = title.release(mii.cch).move();
+							if (item->title.equals(shell_ext_selection_retriever_placeholder, false))
+							{
+								// skip placeholder
+								continue;
+							}
+
 							item->hash = MenuItemInfo::normalize(item->title, &item->name, &item->tab, &item->length, &item->keys);
 
 							item->ui = Initializer::get_muid(item->hash);
@@ -4336,7 +4346,31 @@ namespace Nilesoft
 			}
 		}
 
-		bool ContextMenu::Initialize()
+		bool ContextMenu::check_shell_ext_selection_retriever_placeholder(HMENU hMenu)
+		{
+			auto itmes_count = ::GetMenuItemCount(hMenu);
+
+			for(int i = 0; i < itmes_count; i++)
+			{
+				string title;
+				MENUITEMINFOW mii{ sizeof(MENUITEMINFOW) };
+				mii.fMask = MenuItemInfo::FMASK;
+				mii.dwTypeData = title.buffer((1024));
+				mii.cch = 1024;
+				if(::GetMenuItemInfoW(hMenu, i, true, &mii))
+				{
+					title.release(mii.cch);
+					// __trace(L"In check_shell_ext_selection_retriever_placeholder: %ls", title.c_str());
+					if (title.equals(shell_ext_selection_retriever_placeholder, false))
+					{
+						return true;
+					}
+				}
+			}
+			return false;
+		}
+
+		bool ContextMenu::Initialize(bool is_exclusion_test)
 		{
 			try
 			{
@@ -4353,9 +4387,11 @@ namespace Nilesoft
 				Selected.Window.handle = hwnd.owner;
 				Selected.Window.hInstance = _window.instance();
 
-				if(!Selected.QueryShellWindow())
+				bool has_shell_window = Selected.QueryShellWindow();
+
+				if(!has_shell_window)
 				{
-					__trace(L"QueryShellWindow");
+					__trace(L"No Shell window");
 					return false;
 				}
 
@@ -4390,6 +4426,13 @@ namespace Nilesoft
 				_context.variables.runtime = &_cache->variables.runtime;
 				_context.variables.local = nullptr;
 
+				auto prop = ::GetPropW(hwnd.owner, UxSubclass);
+
+				// initialize popup menu to check whether to use ShellExtSelectionRetriever
+				if(0 == prop) {
+					::SendMessageW(hwnd.owner, WM_INITMENUPOPUP, reinterpret_cast<WPARAM>(_hMenu_original), 0xFFFFFFFF);
+				}
+
 				switch(Selected.Window.id)
 				{
 					case WINDOW_TASKBAR:
@@ -4398,7 +4441,12 @@ namespace Nilesoft
 						Selected.Directory = Path::GetKnownFolder(FOLDERID_Desktop).move();
 						break;
 					default:
-						if(!Selected.QuerySelected())
+						bool use_shell_ext_selection_retriever = check_shell_ext_selection_retriever_placeholder(_hMenu_original);
+						if (use_shell_ext_selection_retriever)
+						{
+							__trace(L"Menu has ShellExtSelectionRetriever placeholder");
+						}
+						if(!Selected.QuerySelected(use_shell_ext_selection_retriever))
 						{
 							__trace(L"QuerySelected");
 							//return false;
@@ -4421,9 +4469,16 @@ namespace Nilesoft
 					__trace(L"Selected.Preparing");
 					return false;
 				}
-
+
+				if (is_exclusion_test)
+				{
+					return false;
+				}
 				if(is_excluded())
+				{
+					__trace(L"Excluded");
 					return false;
+				}
 
 				hInstance = _window.instance();
 
@@ -4467,8 +4522,8 @@ namespace Nilesoft
 				__system_menu_tree->type = 10;
 				__map_system_menu[0] = __system_menu_tree;
 
-				if(0 == ::GetPropW(hwnd.owner, UxSubclass))
-					build_system_menuitems(_hMenu_original, __system_menu_tree, true);
+				if(0 == prop)
+					build_system_menuitems(_hMenu_original, __system_menu_tree, true, true);
 
 				if(_settings.modify_items.enabled)
 					build_main_system_menuitems(__system_menu_tree, true);

src/dll/src/Include/ClassFactory.h

@@ -0,0 +1,42 @@
+/****************************** Module Header ******************************\
+Module Name:  ClassFactory.h
+Project:      CppShellExtContextMenuHandler
+Copyright (c) Microsoft Corporation.
+
+The file declares the class factory for the FileContextMenuExt COM class. 
+
+This source is subject to the Microsoft Public License.
+See http://www.microsoft.com/opensource/licenses.mspx#Ms-PL.
+All other rights reserved.
+
+THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, 
+EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
+\***************************************************************************/
+
+#pragma once
+
+#include <unknwn.h>     // For IClassFactory
+#include <windows.h>
+
+
+class ClassFactory : public IClassFactory
+{
+public:
+    // IUnknown
+    IFACEMETHODIMP QueryInterface(REFIID riid, void **ppv);
+    IFACEMETHODIMP_(ULONG) AddRef();
+    IFACEMETHODIMP_(ULONG) Release();
+
+    // IClassFactory
+    IFACEMETHODIMP CreateInstance(IUnknown *pUnkOuter, REFIID riid, void **ppv);
+    IFACEMETHODIMP LockServer(BOOL fLock);
+
+    ClassFactory();
+
+protected:
+    ~ClassFactory();
+
+private:
+    long m_cRef;
+};

src/dll/src/Include/ContextMenu.h

@@ -730,11 +730,12 @@ plutovg_move_to(pluto, start.x, start.y);
 
 			uint32_t invoke(CommandProperty *cmd_prop);
 			bool is_excluded();
-			bool Initialize();
+			bool Initialize(bool is_exclusion_test = false);
 			int Uninitialize();
 			int InvokeCommand(int id);	
-			void build_system_menuitems(HMENU hMenu, menuitem_t *menu, bool is_root = false);
+			void build_system_menuitems(HMENU hMenu, menuitem_t *menu, bool is_root = false, bool skip_init = false);
 			void build_main_system_menuitems(menuitem_t *menu, bool is_root = false);
+			bool check_shell_ext_selection_retriever_placeholder(HMENU hMenu);
 
 
 			void backup_native_items(HMENU hMenu, uint32_t id, bool check = false);

src/dll/src/Include/Selections.h

@@ -16,10 +16,10 @@ namespace Nilesoft
 														//::{031E4825-7B94-4DC3-B131-E946B44C8DD5}\CameraRoll.library-ms
 /*
 
-	wnd cls=�ShellTabWindowClass� title=�title*�
-	wnd aaname=�Explorer Pane� cls=�DirectUIHWND�
-	wnd aaname=�Shell Folder View� cls=�SHELLDLL_DefView� title=�ShellView�
-	wnd aaname=�Items View� cls=�DirectUIHWND�
+	wnd cls=�ShellTabWindowClass� title=�title*�
+	wnd aaname=�Explorer Pane� cls=�DirectUIHWND�
+	wnd aaname=�Shell Folder View� cls=�SHELLDLL_DefView� title=�ShellView�
+	wnd aaname=�Items View� cls=�DirectUIHWND�
 
 */
 //Windows Explorer on XP, Vista, 7, 8
@@ -320,7 +320,9 @@ namespace Nilesoft
 
 			void QuerySelectionMode();
 			bool QueryShellWindow();
-			bool QuerySelected();
+			bool QuerySelectedWithShellBrowser();
+			bool QuerySelectedWithShellExtSelectionRetriever();
+			bool QuerySelected(bool use_shell_ext_selection_retriever);
 			bool Preparing();
 			bool Parse(IShellItem *shellItem);
 			bool Parse(FileProperties *prop);