[Chromoting] The Windows IT2Me host gets any new text items it finds on the clipboard.

remoting/host/clipboard_win.cc

 // 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.
 
 #include "remoting/host/clipboard.h"
 
 #include <windows.h>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/logging.h"
 #include "base/process_util.h"
 #include "base/string16.h"
 #include "base/utf_string_conversions.h"
+#include "base/win/scoped_hglobal.h"
+#include "base/win/windows_version.h"
 #include "base/win/wrapped_window_proc.h"
 #include "remoting/base/constants.h"
 #include "remoting/proto/event.pb.h"
 
 namespace {
 
 const WCHAR kWindowClassName[] = L"clipboardWindowClass";
 const WCHAR kWindowName[] = L"clipboardWindow";
 
 // A scoper class that opens and closes the clipboard.
@@ skipping 43 matching lines @@
 
   void SetData(UINT uFormat, HANDLE hMem) {
     if (!opened_) {
       NOTREACHED();
       return;
     }
     // The caller must not close the handle that ::SetClipboardData returns.
     ::SetClipboardData(uFormat, hMem);
   }
 
+  // The caller must not free the handle. The caller should lock the handle,
+  // copy the clipboard data, and unlock the handle. All this must be done
+  // before this ScopedClipboard is destroyed.
+  HANDLE GetData(UINT format) {
+    if (!opened_) {
+      NOTREACHED();
+      return NULL;
+    }
+    return ::GetClipboardData(format);
+  }
+
  private:
   bool opened_;
 };
 
+typedef BOOL (WINAPI AddClipboardFormatListenerFn)(HWND);
+typedef BOOL (WINAPI RemoveClipboardFormatListenerFn)(HWND);
+
 }  // namespace
 
 namespace remoting {
 
 class ClipboardWin : public Clipboard {
  public:
   ClipboardWin();
 
   virtual void Start() OVERRIDE;
   virtual void InjectClipboardEvent(
       const protocol::ClipboardEvent& event) OVERRIDE;
   virtual void Stop() OVERRIDE;
 
  private:
+  void OnClipboardUpdate();
+
+  static bool RegisterWindowClass();
   static LRESULT CALLBACK WndProc(HWND hwmd, UINT msg, WPARAM wParam,
                                   LPARAM lParam);
 
-  static bool RegisterWindowClass();
-
   HWND hwnd_;
+  AddClipboardFormatListenerFn* add_clipboard_format_listener_;
+  RemoveClipboardFormatListenerFn* remove_clipboard_format_listener_;
+  bool load_functions_tried_;
 
   DISALLOW_COPY_AND_ASSIGN(ClipboardWin);
 };
 
-ClipboardWin::ClipboardWin() : hwnd_(NULL) {
+ClipboardWin::ClipboardWin()
+    : hwnd_(NULL),
+      add_clipboard_format_listener_(NULL),
+      remove_clipboard_format_listener_(NULL),
+      load_functions_tried_(false) {
 }
 
 void ClipboardWin::Start() {
+  if (!load_functions_tried_) {
+    load_functions_tried_ = true;
+    HMODULE user32_module = ::GetModuleHandle(L"user32.dll");

[Wez, 2012/05/15 18:50:07]

Consider using base::LoadNativeLibrary/GetFunctionPointerFromNativeLibrary?

[simonmorris, 2012/05/15 21:47:48]

Those try to load a library, whereas ::GetModuleHandle expects the module to be
loaded already, which is more accurate, and avoids any expectation that
user32.dll should be unloaded.

[alexeypa (please no reviews), 2012/05/15 23:12:29]

+1

+    if (!user32_module) {
+      LOG(WARNING) << "Couldn't find user32.dll.";
+    } else {
+      add_clipboard_format_listener_ =
+          reinterpret_cast<AddClipboardFormatListenerFn*>(
+              ::GetProcAddress(user32_module, "AddClipboardFormatListener"));
+      remove_clipboard_format_listener_ =
+          reinterpret_cast<RemoveClipboardFormatListenerFn*>(
+              ::GetProcAddress(user32_module, "RemoveClipboardFormatListener"));
+      // If we can't load both functions, then store neither.

[Wez, 2012/05/15 18:50:07]

Rather than NULLing these here, consider a HaveClipboardListenerApis() helper
and checking that rather than testing the function ptrs directly.

[simonmorris, 2012/05/15 21:47:48]

Done.

+      if (!add_clipboard_format_listener_ ||
+          !remove_clipboard_format_listener_) {
+        add_clipboard_format_listener_ = NULL;
+        remove_clipboard_format_listener_ = NULL;
+      }
+      // We don't expect to load these functions for OS versions before Vista.
+      if (base::win::GetVersion() >= base::win::VERSION_VISTA) {

[Wez, 2012/05/15 18:50:07]

nit: I'd either not bother logging a warning at all, or log it regardless of OS
version - clipboard won't work if we're pre-Vista, so the warning is equally
valid.

[simonmorris, 2012/05/15 21:47:48]

Done.

+        if (!add_clipboard_format_listener_) {
+          LOG(WARNING) << "Couldn't load AddClipboardFormatListener or "
+                       << "RemoveClipboardFormatListener.";
+        }
+      }
+    }
+  }
+
   if (!RegisterWindowClass()) {
     LOG(FATAL) << "Couldn't register clipboard window class.";
     return;
   }
   hwnd_ = ::CreateWindow(kWindowClassName,
                          kWindowName,
                          0, 0, 0, 0, 0,
                          HWND_MESSAGE,
                          NULL,
                          base::GetModuleFromAddress(&WndProc),
                          this);
   if (!hwnd_) {
     LOG(FATAL) << "Couldn't create clipboard window.";
     return;
   }
+
+  if (add_clipboard_format_listener_) {
+    if (!(*add_clipboard_format_listener_)(hwnd_)) {
+      LOG(WARNING) << "AddClipboardFormatListener() failed: " << GetLastError();
+    }
+  }
 }
 
 void ClipboardWin::Stop() {
   if (hwnd_) {
+    if (remove_clipboard_format_listener_) {
+      (*remove_clipboard_format_listener_)(hwnd_);
+    }
     ::DestroyWindow(hwnd_);
     hwnd_ = NULL;
   }
 }
 
 void ClipboardWin::InjectClipboardEvent(
     const protocol::ClipboardEvent& event) {
   if (!hwnd_) {
     return;
   }
@@ skipping 20 matching lines @@
 
   LPWSTR text_global_locked =
       reinterpret_cast<LPWSTR>(::GlobalLock(text_global));
   memcpy(text_global_locked, text.data(), text.size() * sizeof(WCHAR));
   text_global_locked[text.size()] = (WCHAR)0;
   ::GlobalUnlock(text_global);
 
   clipboard.SetData(CF_UNICODETEXT, text_global);
 }
 
-LRESULT CALLBACK ClipboardWin::WndProc(HWND hwnd, UINT msg, WPARAM wParam,
-                                       LPARAM lParam) {
-  return ::DefWindowProc(hwnd, msg, wParam, lParam);
+void ClipboardWin::OnClipboardUpdate() {
+  DCHECK(hwnd_);
+
+  if (::IsClipboardFormatAvailable(CF_UNICODETEXT)) {
+    string16 text;

[Wez, 2012/05/15 18:50:07]

nit: Move this after the comment, before the {?

[simonmorris, 2012/05/15 21:47:48]

But then the comment would be separated from the code to which it applies.

+    // Add a scope, so that we keep the clipboard open for as short a time as
+    // possible.
+    {
+      ScopedClipboard clipboard;
+      if (!clipboard.Init(hwnd_)) {
+        LOG(WARNING) << "Couldn't open the clipboard." << GetLastError();
+        return;
+      }
+
+      HGLOBAL text_global = clipboard.GetData(CF_UNICODETEXT);
+      if (!text_global) {
+        LOG(WARNING) << "Couldn't get data from the clipboard: "
+                     << GetLastError();
+        return;
+      }
+
+      base::win::ScopedHGlobal<WCHAR> text_lock(text_global);
+      if (!text_lock.get()) {
+        LOG(WARNING) << "Couldn't lock clipboard data: " << GetLastError();
+        return;
+      }
+      text.assign(text_lock.get());
+    }
+
+    protocol::ClipboardEvent event;
+    event.set_mime_type(kMimeTypeTextUtf8);
+    event.set_data(UTF16ToUTF8(text));
+
+    // TODO(simonmorris): Send the event to the client.
+  }
 }
 
 bool ClipboardWin::RegisterWindowClass() {
   // This method is only called on the desktop thread, so it doesn't matter
   // that the following test is not thread-safe.
   static bool registered = false;
   if (registered) {
     return true;
   }
 
   WNDCLASSEX window_class;
   base::win::InitializeWindowClass(
       kWindowClassName,
       base::win::WrappedWindowProc<WndProc>,
       0, 0, 0, NULL, NULL, NULL, NULL, NULL,
       &window_class);
   if (!::RegisterClassEx(&window_class)) {
     return false;
   }
 
   registered = true;
   return true;
 }
 
+LRESULT CALLBACK ClipboardWin::WndProc(HWND hwnd, UINT msg, WPARAM wparam,
+                                       LPARAM lparam) {
+  if (msg == WM_CREATE) {
+    CREATESTRUCT* cs = reinterpret_cast<CREATESTRUCT*>(lparam);
+    ::SetWindowLongPtr(hwnd,
+                       GWLP_USERDATA,
+                       reinterpret_cast<LONG_PTR>(cs->lpCreateParams));
+    return 0;
+  }
+  ClipboardWin* clipboard =
+      reinterpret_cast<ClipboardWin*>(::GetWindowLongPtr(hwnd, GWLP_USERDATA));
+  switch (msg) {
+    case WM_CLIPBOARDUPDATE:
+      clipboard->OnClipboardUpdate();
+      return 0;
+  }
+  return ::DefWindowProc(hwnd, msg, wparam, lparam);
+}
+
 scoped_ptr<Clipboard> Clipboard::Create() {
   return scoped_ptr<Clipboard>(new ClipboardWin());
 }
 
 }  // namespace remoting