Bug 1518639: Add boilerplate support for a windows remote client and server. r=jimm,froydnj

Adds build config and stubs for a windows implementation of the remote client
and server.

Differential Revision: https://phabricator.services.mozilla.com/D19074

--HG--
extra : source : abd7789e9637c92978efcf745361b98c5abf847a
extra : intermediate-source : 276ca640adc8ff16ff3ff7252e8aa5016205b1e0

Author: Mossop

toolkit/components/moz.build

@@ -8,7 +8,7 @@ with Files('**'):
     BUG_COMPONENT = ('Toolkit', 'General')
 
 # These component dirs are built for all apps (including suite)
-if 'gtk' in CONFIG['MOZ_WIDGET_TOOLKIT']:
+if CONFIG['MOZ_HAS_REMOTE']:
     DIRS += ['remote']
 
 DIRS += [

toolkit/components/remote/moz.build

@@ -27,6 +27,12 @@ if 'gtk' in CONFIG['MOZ_WIDGET_TOOLKIT']:
         CXXFLAGS += CONFIG['MOZ_DBUS_GLIB_CFLAGS']
     CXXFLAGS += CONFIG['TK_CFLAGS']
 
+if CONFIG['MOZ_WIDGET_TOOLKIT'] == 'windows':
+    SOURCES += [
+        'nsWinRemoteClient.cpp',
+        'nsWinRemoteServer.cpp',
+    ]
+
 LOCAL_INCLUDES += [
     '../../profile',
 ]

toolkit/components/remote/nsRemoteService.cpp

@@ -17,6 +17,9 @@
 #    include "nsDBusRemoteServer.h"
 #    include "nsDBusRemoteClient.h"
 #  endif
+#elif defined(XP_WIN)
+#  include "nsWinRemoteServer.h"
+#  include "nsWinRemoteClient.h"
 #endif
 #include "nsRemoteService.h"
 
@@ -102,6 +105,11 @@ RemoteResult nsRemoteService::StartClient(const char* aDesktopStartupID) {
   if (useX11Remote) {
     client = new nsXRemoteClient();
   }
+#elif defined(XP_WIN)
+  client = new nsWinRemoteClient();
+#else
+  return REMOTE_NOT_FOUND;
+#endif
 
   nsresult rv = client ? client->Init() : NS_ERROR_FAILURE;
   if (NS_FAILED(rv)) return REMOTE_NOT_FOUND;
@@ -122,9 +130,6 @@ RemoteResult nsRemoteService::StartClient(const char* aDesktopStartupID) {
   if (NS_FAILED(rv)) return REMOTE_NOT_FOUND;
 
   return REMOTE_FOUND;
-#else
-  return REMOTE_NOT_FOUND;
-#endif
 }
 
 void nsRemoteService::StartupServer() {
@@ -147,6 +152,10 @@ void nsRemoteService::StartupServer() {
   if (useX11Remote) {
     mRemoteServer = MakeUnique<nsGTKRemoteServer>();
   }
+#elif defined(XP_WIN)
+  mRemoteServer = MakeUnique<nsWinRemoteServer>();
+#else
+  return;
 #endif
 
   nsresult rv = mRemoteServer->Startup(mProgram.get(), mProfile.get());

toolkit/components/remote/nsWinRemoteClient.cpp

@@ -0,0 +1,20 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:expandtab:shiftwidth=4:tabstop=4:
+ */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsWinRemoteClient.h"
+
+nsresult nsWinRemoteClient::Init() {
+  return NS_OK;
+}
+
+nsresult nsWinRemoteClient::SendCommandLine(const char *aProgram, const char *aProfile,
+                                            int32_t argc, char **argv,
+                                            const char *aDesktopStartupID,
+                                            char **aResponse, bool *aSucceeded) {
+  *aSucceeded = false;
+  return NS_OK;
+}

toolkit/components/remote/nsWinRemoteClient.h

@@ -0,0 +1,30 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:expandtab:shiftwidth=4:tabstop=4:
+ */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef nsWinRemoteClient_h__
+#define nsWinRemoteClient_h__
+
+#include "nscore.h"
+#include "nsRemoteClient.h"
+
+/**
+ * Pure-virtual common base class for remoting implementations.
+ */
+
+class nsWinRemoteClient : public nsRemoteClient {
+ public:
+  virtual ~nsWinRemoteClient() = default;
+
+  nsresult Init() override;
+
+  nsresult SendCommandLine(const char *aProgram, const char *aProfile,
+                           int32_t argc, char **argv,
+                           const char *aDesktopStartupID,
+                           char **aResponse, bool *aSucceeded) override;
+};
+
+#endif  // nsWinRemoteClient_h__

toolkit/components/remote/nsWinRemoteServer.cpp

@@ -0,0 +1,16 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:expandtab:shiftwidth=2:tabstop=2:
+ */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsWinRemoteServer.h"
+
+nsresult nsWinRemoteServer::Startup(const char* aAppName,
+    const char* aProfileName) {
+  return NS_OK;
+}
+
+void nsWinRemoteServer::Shutdown() {
+}

toolkit/components/remote/nsWinRemoteServer.h

@@ -0,0 +1,22 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:expandtab:shiftwidth=2:tabstop=2:
+ */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef __nsWinRemoteServer_h__
+#define __nsWinRemoteServer_h__
+
+#include "nsRemoteServer.h"
+
+class nsWinRemoteServer final : public nsRemoteServer {
+ public:
+  nsWinRemoteServer() = default;
+  ~nsWinRemoteServer() override = default;
+
+  nsresult Startup(const char* aAppName, const char* aProfileName) override;
+  void Shutdown() override;
+};
+
+#endif  // __nsWinRemoteService_h__

toolkit/moz.configure

@@ -1652,3 +1652,14 @@ with only_when(compile_environment & target_is_windows):
     set_config('MOZ_D3DCOMPILER_VISTA_DLL', d3d_compiler_dll.name,
                when=d3d_compiler_dll.path)
     set_config('MOZ_D3DCOMPILER_VISTA_DLL_PATH', d3d_compiler_dll.path)
+
+# Remoting protocol support
+# ==============================================================
+
+@depends(toolkit)
+def has_remote(toolkit):
+    if 'gtk' in toolkit or toolkit == 'windows':
+        return True
+
+set_config('MOZ_HAS_REMOTE', has_remote)
+set_define('MOZ_HAS_REMOTE', has_remote)

toolkit/xre/moz.build

@@ -91,15 +91,16 @@ elif 'gtk' in CONFIG['MOZ_WIDGET_TOOLKIT']:
     UNIFIED_SOURCES += [
         'nsNativeAppSupportUnix.cpp',
     ]
-
-    LOCAL_INCLUDES += [
-        '../components/remote',
-    ]
 else:
     UNIFIED_SOURCES += [
         'nsNativeAppSupportDefault.cpp',
     ]
 
+if CONFIG['MOZ_HAS_REMOTE']:
+    LOCAL_INCLUDES += [
+        '../components/remote',
+    ]
+
 if CONFIG['MOZ_WIDGET_TOOLKIT'] == 'gtk3':
     UNIFIED_SOURCES += [
         'nsGDKErrorHandler.cpp',

toolkit/xre/nsAppRunner.cpp

@@ -187,15 +187,8 @@
 #endif
 
 // for X remote support
-#if defined(MOZ_WIDGET_GTK)
-#  include "nsXRemoteClient.h"
+#if defined(MOZ_HAS_REMOTE)
 #  include "nsRemoteService.h"
-#  include "nsProfileLock.h"
-#  include "SpecialSystemDirectory.h"
-#  include <sched.h>
-#  ifdef MOZ_ENABLE_DBUS
-#    include "nsDBusRemoteClient.h"
-#  endif
 #endif
 
 #if defined(DEBUG) && defined(XP_WIN32)
@@ -310,6 +303,9 @@ void XRE_LibFuzzerSetDriver(LibFuzzerDriver aDriver) {
 #  endif
 #endif  // FUZZING
 
+// Undo X11/X.h's definition of None
+#undef None
+
 namespace mozilla {
 int (*RunGTest)(int*, char**) = 0;
 }  // namespace mozilla
@@ -2854,9 +2850,12 @@ class XREMain {
   XREMain()
       : mStartOffline(false),
         mShuttingDown(false)
+#ifdef MOZ_HAS_REMOTE
+        ,
+        mDisableRemote(false)
+#endif
 #if defined(MOZ_WIDGET_GTK)
         ,
-        mDisableRemote(false),
         mGdkDisplay(nullptr)
 #endif
             {};
@@ -2878,7 +2877,7 @@ class XREMain {
   nsCOMPtr<nsIFile> mProfD;
   nsCOMPtr<nsIFile> mProfLD;
   nsCOMPtr<nsIProfileLock> mProfileLock;
-#if defined(MOZ_WIDGET_GTK)
+#if defined(MOZ_HAS_REMOTE)
   RefPtr<nsRemoteService> mRemoteService;
 #endif
 
@@ -2890,7 +2889,7 @@ class XREMain {
 
   bool mStartOffline;
   bool mShuttingDown;
-#if defined(MOZ_WIDGET_GTK)
+#if defined(MOZ_HAS_REMOTE)
   bool mDisableRemote;
 #endif
 
@@ -3406,14 +3405,14 @@ int XREMain::XRE_mainInit(bool* aExitFlag) {
   }
   if (ar == ARG_FOUND) {
     SaveToEnv("MOZ_NO_REMOTE=1");
-#ifdef MOZ_WIDGET_GTK
+#if defined(MOZ_HAS_REMOTE)
     mDisableRemote = true;
   } else if (EnvHasValue("MOZ_NO_REMOTE")) {
     mDisableRemote = true;
 #endif
   }
 
-#ifdef MOZ_WIDGET_GTK
+#if defined(MOZ_HAS_REMOTE)
   ar = CheckArg("new-instance", nullptr,
                 CheckArgFlag::CheckOSInt | CheckArgFlag::RemoveArg);
   if (ar == ARG_BAD) {
@@ -3822,6 +3821,12 @@ int XREMain::XRE_mainStartup(bool* aExitFlag) {
     return result;
   }
 
+#ifdef MOZ_HAS_REMOTE
+  if (gfxPlatform::IsHeadless()) {
+    mDisableRemote = true;
+  }
+#endif
+
 #ifdef MOZ_X11
   // Init X11 in thread-safe mode. Must be called prior to the first call to
   // XOpenDisplay (called inside gdk_display_open). This is a requirement for
@@ -3892,11 +3897,9 @@ int XREMain::XRE_mainStartup(bool* aExitFlag) {
           gdk_display_manager_open_display(gdk_display_manager_get(), nullptr);
     }
 #  endif
-  } else {
-    mDisableRemote = true;
   }
 #endif
-#if defined(MOZ_WIDGET_GTK)
+#if defined(MOZ_HAS_REMOTE)
   // handle --remote now that xpcom is fired up
   if (!mDisableRemote) {
     mRemoteService = new nsRemoteService(gAppData->remotingName);
@@ -4025,7 +4028,7 @@ int XREMain::XRE_mainStartup(bool* aExitFlag) {
     return 1;
   }
 
-#if defined(MOZ_WIDGET_GTK)
+#if defined(MOZ_HAS_REMOTE)
   if (mRemoteService) {
     // We want a unique profile name to identify the remote instance.
     nsCString profileName;
@@ -4553,7 +4556,7 @@ nsresult XREMain::XRE_mainRun() {
   }
 
   if (!mShuttingDown) {
-#if defined(MOZ_WIDGET_GTK)
+#if defined(MOZ_HAS_REMOTE)
     // if we have X remote support, start listening for requests on the
     // proxy window.
     if (mRemoteService) {
@@ -4761,7 +4764,7 @@ int XREMain::XRE_main(int argc, char* argv[], const BootstrapConfig& aConfig) {
   }
 
   if (!mShuttingDown) {
-#if defined(MOZ_WIDGET_GTK)
+#if defined(MOZ_HAS_REMOTE)
     // shut down the x remote proxy window
     if (mRemoteService) {
       mRemoteService->ShutdownServer();