Bug 1666: Optionally disable running shell operations on separate thread

https://winscp.net/tracker/1666

Source commit: 6fdf1516a08eb4783a9881b4399a4c488a048694

source/packages/my/OperationWithTimeout.pas

@@ -19,6 +19,9 @@ function ShellFolderParseDisplayNameWithTimeout(
 function DestinationListBeginList(
   DestinationList: ICustomDestinationList; var pcMaxSlots: UINT; const riid: TIID; out ppv: Pointer; Timeout: Integer): HRESULT;
 
+var
+  TimeoutShellOperations: Boolean = True;
+
 implementation
 
 uses
@@ -101,26 +104,33 @@ var
 begin
 // When running from IDE, it triggers starting/exiting the thread taking ages.
 // So in IDE we revert to single-thread approach.
-{$IFDEF IDE}
-  OperationEvent(Operation);
-  Result := True;
-{$ELSE}
-  // Have to start new thread for each request. When shared thread is used, it eventually hangs.
-  // Most probably do to the fact that we violate COM threading model.
-  // So using a new thread for each request, is only a hack that happens to work by pure luck.
-  // We may want to use shared thread at least for COM-free operations, like SHGetFileInfo.
-  Thread := TOperationWithTimeoutThread.Create(Operation, OperationEvent);
-  Thread.Resume;
-  Result := Thread.WaitFor(MSecsPerSec);
-  if Result then
+{$IFNDEF IDE}
+  if not TimeoutShellOperations then
+{$ENDIF}
   begin
-    Thread.Free;
+    OperationEvent(Operation);
+    Result := True;
   end
+{$IFNDEF IDE}
     else
   begin
-    // There's a chance for memory leak, if thread is terminated
-    // between WaitFor() and this line
-    Thread.FreeOnTerminate := True;
+    // Have to start new thread for each request. When shared thread is used, it eventually hangs.
+    // Most probably do to the fact that we violate COM threading model.
+    // So using a new thread for each request, is only a hack that happens to work by pure luck.
+    // We may want to use shared thread at least for COM-free operations, like SHGetFileInfo.
+    Thread := TOperationWithTimeoutThread.Create(Operation, OperationEvent);
+    Thread.Resume;
+    Result := Thread.WaitFor(MSecsPerSec);
+    if Result then
+    begin
+      Thread.Free;
+    end
+      else
+    begin
+      // There's a chance for memory leak, if thread is terminated
+      // between WaitFor() and this line
+      Thread.FreeOnTerminate := True;
+    end;
   end;
 {$ENDIF}
 end;

source/windows/WinConfiguration.cpp

@@ -20,6 +20,7 @@
 #include <Math.hpp>
 #include <StrUtils.hpp>
 #include <Generics.Defaults.hpp>
+#include <OperationWithTimeout.hpp>
 #include "FileInfo.h"
 //---------------------------------------------------------------------------
 #pragma package(smart_init)
@@ -971,6 +972,7 @@ THierarchicalStorage * TWinConfiguration::CreateScpStorage(bool & SessionList)
     KEYEX(String, FExtensionsDeleted, L"ExtensionsDeleted"); \
     KEYEX(String, FExtensionsOrder, L"ExtensionsOrder"); \
     KEYEX(String, FExtensionsShortCuts, L"ExtensionsShortCuts"); \
+    KEY(Bool,  TimeoutShellOperations); \
   ); \
   BLOCK(L"Interface\\Editor", CANCREATE, \
     KEYEX(String,   Editor.Font.FontName, L"FontName2"); \
@@ -2545,6 +2547,16 @@ void __fastcall TWinConfiguration::SetLockedInterface(bool value)
   SET_CONFIG_PROPERTY(LockedInterface);
 }
 //---------------------------------------------------------------------------
+bool __fastcall TWinConfiguration::GetTimeoutShellOperations()
+{
+  return ::TimeoutShellOperations;
+}
+//---------------------------------------------------------------------------
+void __fastcall TWinConfiguration::SetTimeoutShellOperations(bool value)
+{
+  ::TimeoutShellOperations = value;
+}
+//---------------------------------------------------------------------------
 TStringList * __fastcall TWinConfiguration::LoadJumpList(
   THierarchicalStorage * Storage, UnicodeString Name)
 {

source/windows/WinConfiguration.h

@@ -536,6 +536,8 @@ private:
   TStrings * __fastcall GetCustomCommandOptions();
   void __fastcall SetCustomCommandOptions(TStrings * value);
   void __fastcall SetLockedInterface(bool value);
+  bool __fastcall GetTimeoutShellOperations();
+  void __fastcall SetTimeoutShellOperations(bool value);
   int __fastcall GetLocaleCompletenessTreshold();
 
   bool __fastcall GetDDExtInstalled();
@@ -713,6 +715,7 @@ public:
   __property TMasterPasswordPromptEvent OnMasterPasswordPrompt = { read = FOnMasterPasswordPrompt, write = FOnMasterPasswordPrompt };
   __property TStrings * CustomCommandOptions = { read = GetCustomCommandOptions, write = SetCustomCommandOptions };
   __property bool LockedInterface = { read = FLockedInterface, write = SetLockedInterface };
+  __property bool TimeoutShellOperations = { read = GetTimeoutShellOperations, write = SetTimeoutShellOperations };
   __property LCID DefaultLocale = { read = FDefaultLocale };
   __property int LocaleCompletenessTreshold = { read = GetLocaleCompletenessTreshold };
 };