The Windows portion of Native Messagaing

chrome/browser/extensions/api/messaging/native_message_process_host.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_EXTENSIONS_API_MESSAGING_NATIVE_MESSAGE_PROCESS_HOST_H_
 #define CHROME_BROWSER_EXTENSIONS_API_MESSAGING_NATIVE_MESSAGE_PROCESS_HOST_H_
 
 #include "base/file_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/message_loop.h"
 #include "base/process.h"
 #include "content/public/browser/browser_thread.h"
 
 namespace extensions {
 class NativeProcessLauncher;
 
 // Manages the native side of a connection between an extension and a native
 // process.
 //
-// This class must only be created, called, and deleted on the FILE thread.
+// This class must only be created, called, and deleted on the IO thread.
 // Public methods typically accept callbacks which will be invoked on the UI
 // thread.
 class NativeMessageProcessHost
 #if defined(OS_WIN)
     : public MessageLoopForIO::IOHandler {
 #else
     : public MessageLoopForIO::Watcher {
 #endif  // defined(OS_WIN)
  public:
   class ScopedNativeProcessClose;
@@ skipping 30 matching lines @@
   class Client {
    public:
     virtual ~Client() {}
     // Called on the UI thread.
     virtual void PostMessageFromNativeProcess(int port_id,
                                               const std::string& message) = 0;
     virtual void CloseChannel(int port_id, bool error) = 0;
   };
 
   // Desctruction functor that ensures a NativeMessageProcessHost is destroyed
-  // on the FILE thread.
+  // on the IO thread.
   class ScopedNativeProcessClose {
    public:
     inline void operator()(extensions::NativeMessageProcessHost* x) const {
-      content::BrowserThread::DeleteSoon(content::BrowserThread::FILE,
-                                        FROM_HERE, x);
+      content::BrowserThread::DeleteSoon(content::BrowserThread::IO,
+                                         FROM_HERE, x);
     }
   };
 
+  static const int kExitTimeoutMS;
+  static const uint32 kMaxMessageDataLength;
 
   virtual ~NativeMessageProcessHost();
 
   // |type| must be TYPE_CONNECT or TYPE_SEND_MESSAGE_REQUEST. |callback| will
   // be called with an empty ScopedHost on error.
   static void Create(base::WeakPtr<Client> weak_client_ui,
                      const std::string& native_app_name,
                      const std::string& connection_message,
                      int destination_port,
                      MessageType type,
                      CreateCallback callback);
 
   // Create a NativeMessageProcessHost using the specified launcher. This allows
   // for easy testing.
   static void CreateWithLauncher(base::WeakPtr<Client> weak_client_ui,
                                  const std::string& native_app_name,
                                  const std::string& connection_message,
                                  int destination_port,
                                  MessageType type,
                                  CreateCallback callback,
-                                 const NativeProcessLauncher& launcher);
+                                 scoped_ptr<NativeProcessLauncher> launcher);
 
   // TYPE_SEND_MESSAGE_REQUEST will be sent via the connection message in
   // NativeMessageProcessHost::Create, so only TYPE_CONNECT_MESSAGE is expected.
   void Send(const std::string& json) {
     SendImpl(TYPE_CONNECT_MESSAGE, json);
   }
 
   // Try and read a single message from |read_file_|. This should only be called
   // in unittests when you know there is data in the file.
   void ReadNowForTesting();
 
  private:
+  enum ReadState {
+    READ_STATE_INVALID,
+    READ_STATE_WAITING_FOR_META,
+    READ_STATE_WAITING_FOR_MESSAGE
+  };
+
+  struct NativeProcessHostCreationInformation {
+    NativeProcessHostCreationInformation(
+        base::WeakPtr<Client> weak_client_ui,
+        std::string connection_message,
+        int destination_port,
+        MessageType type,
+        CreateCallback callback,
+        FileHandle read_handle,
+        FileHandle write_handle,
+        base::ProcessHandle native_process_handle)
+        : weak_client_ui(weak_client_ui),
+          connection_message(connection_message),
+          destination_port(destination_port),
+          type(type),
+          callback(callback),
+          read_handle(read_handle),
+          write_handle(write_handle),
+          native_process_handle(native_process_handle)
+    {}
+
+    base::WeakPtr<Client> weak_client_ui;
+    std::string connection_message;
+    int destination_port;
+    MessageType type;
+    CreateCallback callback;
+    FileHandle read_handle;
+    FileHandle write_handle;
+    base::ProcessHandle native_process_handle;
+  };
+
+  // Check that the app's path is within the proper directory on the FILE
+  // thread.
+  static void LaunchProcessOnFileThread(
+      base::WeakPtr<Client> weak_client_ui,
+      const std::string& native_app_name,
+      const std::string& connection_message,
+      int destination_port,
+      MessageType type,
+      CreateCallback callback,
+      scoped_ptr<NativeProcessLauncher> launcher);
+
+  // Finish the launching process. This will be run on the IO thread.
+  static void FinalizeCreate(
+      NativeProcessHostCreationInformation creation_info);
+
   NativeMessageProcessHost(base::WeakPtr<Client> weak_client_ui,
                            int destination_port,
                            base::ProcessHandle native_process_handle,
                            FileHandle read_fd,
                            FileHandle write_fd,
                            bool is_send_message);
 
   // Initialize any IO watching that needs to occur between the native process.
   void InitIO();
 
+  // Stop any IO operations in progress.
+  void StopIO();
+
   // Send a message to the native process with the specified type and payload.
   void SendImpl(MessageType type, const std::string& json);
 
   // Write a message/data to the native process.
   bool WriteMessage(MessageType type, const std::string& message);
   bool WriteData(FileHandle file, const char* data, size_t bytes_to_write);
 
-  // Read a message/data from the native process.
-  bool ReadMessage(MessageType* type, std::string* messgae);
-  bool ReadData(FileHandle file, char* data, size_t bytes_to_write);
+  // Parse and verify the meta data (type and length) for a message.
+  bool VerifyMessageMetaData(const char* message_meta_data,
+                             MessageType* type,
+                             uint32* message_length);
 
 #if defined(OS_POSIX)
+  // Read a message from the native process.
+  bool ReadMessage(MessageType* type, std::string* message);
+
   // MessageLoopForIO::Watcher
   virtual void OnFileCanReadWithoutBlocking(int fd) OVERRIDE;
   // We don't need to watch for writes.
   virtual void OnFileCanWriteWithoutBlocking(int fd) OVERRIDE {}
 
   MessageLoopForIO::FileDescriptorWatcher read_watcher_;
-#endif  // defined(OS_POSIX)
-
-#if defined(OS_WIN)
+#elif defined(OS_WIN)
   // MessageLoopForIO::IOHandler
   virtual void OnIOCompleted(MessageLoopForIO::IOContext* context,
                              DWORD bytes_transfered,
                              DWORD error) OVERRIDE;
 
-  MessageLoopForIO::IOContext read_context_;
-  MessageLoopForIO::IOContext write_context_;
-#endif  // defined(OS_WIN)
+  scoped_ptr<MessageLoopForIO::IOContext> read_context_;
+  scoped_ptr<MessageLoopForIO::IOContext> write_context_;
 
+  ReadState read_state;
+  std::string pending_message_;
+  char pending_message_meta_data_[8];
+#endif  // defined(OS_POSIX)
 
   // The Client messages will be posted to. Should only be accessed from the
   // UI thread.
   base::WeakPtr<Client> weak_client_ui_;
 
   // The id of the port on the other side of this connection. This is passed to
   // |weak_client_ui_| when posting messages.
   int destination_port_;
 
+  // This may be base::kNullProcessHandle during tests. On posix, this is not a
+  // problem. However, on windows this may crash certian calls like
+  // base::GetTerminationStatus().
   base::ProcessHandle native_process_handle_;
 
   FileHandle read_file_;
   FileHandle write_file_;
   ScopedFileHandle scoped_read_file_;
   ScopedFileHandle scoped_write_file_;
 
   // Only looking for one response.
   bool is_send_message_;
 
   DISALLOW_COPY_AND_ASSIGN(NativeMessageProcessHost);
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_MESSAGING_NATIVE_MESSAGE_PROCESS_HOST_H__