Extends DBusThreadManager to connect ibus-bus.

chrome/browser/chromeos/input_method/ibus_controller_impl.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 "chrome/browser/chromeos/input_method/ibus_controller_impl.h"
 
 #include <algorithm>  // for std::reverse.
 #include <cstdio>
 #include <cstring>  // for std::strcmp.
 #include <set>
 #include <sstream>
 #include <stack>
 #include <utility>
 
+#include "base/bind.h"
+#include "base/environment.h"
+#include "base/files/file_path_watcher.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/message_loop.h"
+#include "base/rand_util.h"
 #include "base/stringprintf.h"
 #include "base/string_split.h"
 #include "chrome/browser/chromeos/input_method/input_method_config.h"
 #include "chrome/browser/chromeos/input_method/input_method_property.h"
 #include "chrome/browser/chromeos/input_method/input_method_util.h"
+#include "chromeos/dbus/dbus_thread_manager.h"
+#include "content/public/browser/browser_thread.h"
 
 // TODO(nona): Remove libibus dependency from this file. Then, write unit tests
 // for all functions in this file. crbug.com/26334
 #if defined(HAVE_IBUS)
 #include <ibus.h>
 #endif
 
 namespace {
 
 // Finds a property which has |new_prop.key| from |prop_list|, and replaces the
@@ skipping 319 matching lines @@
   std::stringstream stream;
   for (int i = 0;; ++i) {
     IBusProperty* prop = ibus_prop_list_get(prop_list, i);
     if (!prop)
       break;
     stream << PrintProp(prop, tree_level);
   }
   return stream.str();
 }
 
+// The implementation of FilePathWatcher::Delegate, used in
+// StartAddressFileWatch function.
+class IBusAddressFileWatcherDelegate
+    : public base::files::FilePathWatcher::Delegate {
+ public:
+  IBusAddressFileWatcherDelegate(const std::string& ibus_address,
+                                 base::files::FilePathWatcher* watcher,
+                                 IBusControllerImpl* controller)
+      : ibus_address_(ibus_address),
+        watcher_(watcher),
+        controller_(controller) {
+  }
+
+  virtual ~IBusAddressFileWatcherDelegate() {}
+
+  virtual void OnFilePathChanged(const FilePath& file_path) {
+    content::BrowserThread::PostTaskAndReply(

[Yusuke Sato, 2012/04/27 02:12:13]

check return value?

[Seigo Nonaka, 2012/05/01 00:19:54]

Done.

+        content::BrowserThread::UI,
+        FROM_HERE,
+        base::Bind(&chromeos::DBusThreadManager::MaybeResetIBusBus,
+                   base::Unretained(chromeos::DBusThreadManager::Get()),
+                   ibus_address_),
+        base::Bind(&IBusControllerImpl::IBusBusInitializationDone,

[Yusuke Sato, 2012/04/27 02:12:13]

flipping the flag from FILE thread w/o locking looks harmful to me. please do it
in the UI thread.

[Seigo Nonaka, 2012/05/01 00:19:54]

Done.

+                   controller_));
+    MessageLoop::current()->DeleteSoon(FROM_HERE, watcher_);
+  }
+
+ private:
+  // The ibus-daemon address.
+  const std::string ibus_address_;
+

[Yusuke Sato, 2012/04/27 02:12:13]

nit: add a comment or remove this line.

[Seigo Nonaka, 2012/05/01 00:19:54]

Done.

+  IBusControllerImpl* controller_;
+

[Yusuke Sato, 2012/04/27 02:12:13]

nit: the same as above.

[Seigo Nonaka, 2012/05/01 00:19:54]

Done.

+  base::files::FilePathWatcher* watcher_;
+
+  DISALLOW_COPY_AND_ASSIGN(IBusAddressFileWatcherDelegate);
+};
+
+void StartAddressFileWatch(const std::string& ibus_address,
+                           IBusControllerImpl* controller) {
+  scoped_ptr<base::Environment> env(base::Environment::Create());
+  std::string address_file_path;
+  env->GetVar("IBUS_ADDRESS_FILE", &address_file_path);

[Yusuke Sato, 2012/04/27 02:12:13]

DCHECK(!address_file_path.empty());

[Seigo Nonaka, 2012/05/01 00:19:54]

Done.

+
+  // The |watcher| instance will be released by |delegate|.
+  base::files::FilePathWatcher* watcher = new base::files::FilePathWatcher;
+
+  // The |delegate| is owned by watcher.
+  IBusAddressFileWatcherDelegate* delegate = new IBusAddressFileWatcherDelegate(
+      ibus_address, watcher, controller);
+  bool result = watcher->Watch(FilePath(address_file_path), delegate);
+  DCHECK(result);
+}
 }  // namespace
 
 IBusControllerImpl::IBusControllerImpl()
     : ibus_(NULL),
       ibus_config_(NULL),
       should_launch_daemon_(false),
-      process_handle_(base::kNullProcessHandle) {
+      process_handle_(base::kNullProcessHandle),
+      ALLOW_THIS_IN_INITIALIZER_LIST(weak_ptr_factory_(this)),
+      is_initializing_ibus_daemon_(false) {
 }
 
 IBusControllerImpl::~IBusControllerImpl() {
   // Disconnect signals so the handler functions will not be called with
   // |this| which is already freed.
   if (ibus_) {
     g_signal_handlers_disconnect_by_func(
         ibus_,
         reinterpret_cast<gpointer>(G_CALLBACK(BusConnectedThunk)),
         this);
@@ skipping 509 matching lines @@
   // Notify the change.
   if (!prop_list.empty()) {
     for (size_t i = 0; i < prop_list.size(); ++i) {
       FindAndUpdateProperty(prop_list[i], &current_property_list_);
     }
     FOR_EACH_OBSERVER(Observer, observers_, PropertyChanged());
   }
 }
 
 bool IBusControllerImpl::MaybeLaunchIBusDaemon() {
-  static const char kIBusDaemonPath[] = "/usr/bin/ibus-daemon";
-
   if (process_handle_ != base::kNullProcessHandle) {
     DVLOG(1) << "MaybeLaunchIBusDaemon: ibus-daemon is already running.";
     return false;
   }
   if (!should_launch_daemon_)
     return false;
 
+  if (is_initializing_ibus_daemon_)
+    return false;
+
+  is_initializing_ibus_daemon_ = true;
+  const std::string ibus_address = base::StringPrintf(
+      "unix:abstract=/tmp/ibus-%0lX", base::RandUint64());
+
+  // Set up ibus-daemon address file watcher before launching ibus-daemon,
+  // because if watcher start after ibus-daemon, we may miss the ibus connection
+  // initialization.
+  content::BrowserThread::PostTaskAndReply(

[Yusuke Sato, 2012/04/27 02:12:13]

check return value?

[Seigo Nonaka, 2012/05/01 00:19:54]

Done.

+      content::BrowserThread::FILE,
+      FROM_HERE,
+      base::Bind(&StartAddressFileWatch, ibus_address),
+      base::Bind(&IBusControllerImpl::LaunchIBusDaemon,
+                 weak_ptr_factory_.GetWeakPtr(),
+                 ibus_address));
+  return true;
+}
+
+void IBusControllerImpl::LaunchIBusDaemon(const std::string& ibus_address) {
+  static const char kIBusDaemonPath[] = "/usr/bin/ibus-daemon";
   // TODO(zork): Send output to /var/log/ibus.log
   const std::string ibus_daemon_command_line =
-      base::StringPrintf("%s --panel=disable --cache=none --restart --replace",
-                         kIBusDaemonPath);
+      base::StringPrintf("%s --panel=disable --cache=none --restart --replace"
+                         " --address=%s",
+                         kIBusDaemonPath,
+                         ibus_address.c_str());
   if (!LaunchProcess(ibus_daemon_command_line,
                      &process_handle_,
                      reinterpret_cast<GChildWatchFunc>(OnIBusDaemonExit))) {
     DVLOG(1) << "Failed to launch " << ibus_daemon_command_line;
-    return false;
   }
-  return true;
 }
 
 bool IBusControllerImpl::LaunchProcess(const std::string& command_line,
                                        base::ProcessHandle* process_handle,
                                        GChildWatchFunc watch_func) {
   std::vector<std::string> argv;
   base::ProcessHandle handle = base::kNullProcessHandle;
 
   base::SplitString(command_line, ' ', &argv);
 
   if (!base::LaunchProcess(argv, base::LaunchOptions(), &handle)) {
     DVLOG(1) << "Could not launch: " << command_line;
     return false;
   }
 
   // g_child_watch_add is necessary to prevent the process from becoming a
   // zombie.
   // TODO(yusukes): port g_child_watch_add to base/process_utils_posix.cc.
   const base::ProcessId pid = base::GetProcId(handle);
   g_child_watch_add(pid, watch_func, this);
 
   *process_handle = handle;
   DVLOG(1) << command_line << "is started. PID=" << pid;
   return true;
 }
 
+void IBusControllerImpl::IBusDaemonInitializationDone() {
+  is_initializing_ibus_daemon_ = false;
+}
+
 // static
 void IBusControllerImpl::SetInputMethodConfigCallback(GObject* source_object,
                                                       GAsyncResult* res,
                                                       gpointer user_data) {
   IBusConfig* config = IBUS_CONFIG(user_data);
   g_return_if_fail(config);
 
   GError* error = NULL;
   const gboolean result =
       ibus_config_set_value_async_finish(config, res, &error);
 
   if (!result) {
     std::string message = "(unknown error)";
     if (error && error->message) {
       message = error->message;
     }
     DVLOG(1) << "ibus_config_set_value_async failed: " << message;
   }
 
   if (error)
     g_error_free(error);
   g_object_unref(config);
 }
 
 // static
 void IBusControllerImpl::OnIBusDaemonExit(GPid pid,

[Yusuke Sato, 2012/04/27 02:12:13]

please also make sure that your code works fine even if ibus-daemon crashes. I
guess your code fails to restart ibus-daemon if ibus-daemon crashes before it
writes an address file   (although that kind of crash unlikely happens.)

[Seigo Nonaka, 2012/05/01 00:19:54]

Done.

                                           gint status,
                                           IBusControllerImpl* controller) {
   if (controller->process_handle_ != base::kNullProcessHandle &&
       base::GetProcId(controller->process_handle_) == pid) {
     controller->process_handle_ = base::kNullProcessHandle;
   }
   // Restart the daemon if needed.
   controller->MaybeLaunchIBusDaemon();
 }
 #endif  // defined(HAVE_IBUS)
 
 // static
 bool IBusControllerImpl::FindAndUpdatePropertyForTesting(
     const chromeos::input_method::InputMethodProperty& new_prop,
     chromeos::input_method::InputMethodPropertyList* prop_list) {
   return FindAndUpdateProperty(new_prop, prop_list);
 }
 
 }  // namespace input_method
 }  // namespace chromeos