chrome/browser/process_singleton_win.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/process_singleton.h"
   6
   7 #include <shellapi.h>
   8
   9 #include "base/base_paths.h"
  10 #include "base/bind.h"
  11 #include "base/command_line.h"
  12 #include "base/files/file_path.h"
  13 #include "base/process/kill.h"
  14 #include "base/process/process_info.h"
  15 #include "base/strings/string_number_conversions.h"
  16 #include "base/strings/stringprintf.h"
  17 #include "base/strings/utf_string_conversions.h"
  18 #include "base/time/time.h"
  19 #include "base/win/metro.h"
  20 #include "base/win/registry.h"
  21 #include "base/win/scoped_handle.h"
  22 #include "base/win/windows_version.h"
  23 #include "chrome/browser/browser_process.h"
  24 #include "chrome/browser/browser_process_platform_part.h"
  25 #include "chrome/browser/chrome_process_finder_win.h"
  26 #include "chrome/browser/metro_utils/metro_chrome_win.h"
  27 #include "chrome/browser/shell_integration.h"
  28 #include "chrome/browser/ui/simple_message_box.h"
  29 #include "chrome/common/chrome_constants.h"
  30 #include "chrome/common/chrome_paths.h"
  31 #include "chrome/common/chrome_paths_internal.h"
  32 #include "chrome/common/chrome_switches.h"
  33 #include "chrome/grit/chromium_strings.h"
  34 #include "chrome/installer/util/wmi.h"
  35 #include "content/public/common/result_codes.h"
  36 #include "net/base/escape.h"
  37 #include "ui/base/l10n/l10n_util.h"
  38 #include "ui/gfx/win/hwnd_util.h"
  39
  40 namespace {
  41
  42 const char kLockfile[] = "lockfile";
  43
  44 const int kMetroChromeActivationTimeoutMs = 3000;
  45
  46 // A helper class that acquires the given |mutex| while the AutoLockMutex is in
  47 // scope.
  48 class AutoLockMutex {
  49  public:
  50   explicit AutoLockMutex(HANDLE mutex) : mutex_(mutex) {
  51     DWORD result = ::WaitForSingleObject(mutex_, INFINITE);
  52     DPCHECK(result == WAIT_OBJECT_0) << "Result = " << result;
  53   }
  54
  55   ~AutoLockMutex() {
  56     BOOL released = ::ReleaseMutex(mutex_);
  57     DPCHECK(released);
  58   }
  59
  60  private:
  61   HANDLE mutex_;
  62   DISALLOW_COPY_AND_ASSIGN(AutoLockMutex);
  63 };
  64
  65 // A helper class that releases the given |mutex| while the AutoUnlockMutex is
  66 // in scope and immediately re-acquires it when going out of scope.
  67 class AutoUnlockMutex {
  68  public:
  69   explicit AutoUnlockMutex(HANDLE mutex) : mutex_(mutex) {
  70     BOOL released = ::ReleaseMutex(mutex_);
  71     DPCHECK(released);
  72   }
  73
  74   ~AutoUnlockMutex() {
  75     DWORD result = ::WaitForSingleObject(mutex_, INFINITE);
  76     DPCHECK(result == WAIT_OBJECT_0) << "Result = " << result;
  77   }
  78
  79  private:
  80   HANDLE mutex_;
  81   DISALLOW_COPY_AND_ASSIGN(AutoUnlockMutex);
  82 };
  83
  84 // Checks the visibility of the enumerated window and signals once a visible
  85 // window has been found.
  86 BOOL CALLBACK BrowserWindowEnumeration(HWND window, LPARAM param) {
  87   bool* result = reinterpret_cast<bool*>(param);
  88   *result = ::IsWindowVisible(window) != 0;
  89   // Stops enumeration if a visible window has been found.
  90   return !*result;
  91 }
  92
  93 bool ParseCommandLine(const COPYDATASTRUCT* cds,
  94                       CommandLine* parsed_command_line,
  95                       base::FilePath* current_directory) {
  96   // We should have enough room for the shortest command (min_message_size)
  97   // and also be a multiple of wchar_t bytes. The shortest command
  98   // possible is L"START\0\0" (empty current directory and command line).
  99   static const int min_message_size = 7;
 100   if (cds->cbData < min_message_size * sizeof(wchar_t) ||
 101       cds->cbData % sizeof(wchar_t) != 0) {
 102     LOG(WARNING) << "Invalid WM_COPYDATA, length = " << cds->cbData;
 103     return false;
 104   }
 105
 106   // We split the string into 4 parts on NULLs.
 107   DCHECK(cds->lpData);
 108   const std::wstring msg(static_cast<wchar_t*>(cds->lpData),
 109                          cds->cbData / sizeof(wchar_t));
 110   const std::wstring::size_type first_null = msg.find_first_of(L'\0');
 111   if (first_null == 0 || first_null == std::wstring::npos) {
 112     // no NULL byte, don't know what to do
 113     LOG(WARNING) << "Invalid WM_COPYDATA, length = " << msg.length() <<
 114       ", first null = " << first_null;
 115     return false;
 116   }
 117
 118   // Decode the command, which is everything until the first NULL.
 119   if (msg.substr(0, first_null) == L"START") {
 120     // Another instance is starting parse the command line & do what it would
 121     // have done.
 122     VLOG(1) << "Handling STARTUP request from another process";
 123     const std::wstring::size_type second_null =
 124         msg.find_first_of(L'\0', first_null + 1);
 125     if (second_null == std::wstring::npos ||
 126         first_null == msg.length() - 1 || second_null == msg.length()) {
 127       LOG(WARNING) << "Invalid format for start command, we need a string in 4 "
 128         "parts separated by NULLs";
 129       return false;
 130     }
 131
 132     // Get current directory.
 133     *current_directory = base::FilePath(msg.substr(first_null + 1,
 134                                                    second_null - first_null));
 135
 136     const std::wstring::size_type third_null =
 137         msg.find_first_of(L'\0', second_null + 1);
 138     if (third_null == std::wstring::npos ||
 139         third_null == msg.length()) {
 140       LOG(WARNING) << "Invalid format for start command, we need a string in 4 "
 141         "parts separated by NULLs";
 142     }
 143
 144     // Get command line.
 145     const std::wstring cmd_line =
 146         msg.substr(second_null + 1, third_null - second_null);
 147     *parsed_command_line = CommandLine::FromString(cmd_line);
 148     return true;
 149   }
 150   return false;
 151 }
 152
 153 bool ProcessLaunchNotification(
 154     const ProcessSingleton::NotificationCallback& notification_callback,
 155     UINT message,
 156     WPARAM wparam,
 157     LPARAM lparam,
 158     LRESULT* result) {
 159   if (message != WM_COPYDATA)
 160     return false;
 161
 162   // Handle the WM_COPYDATA message from another process.
 163   const COPYDATASTRUCT* cds = reinterpret_cast<COPYDATASTRUCT*>(lparam);
 164
 165   CommandLine parsed_command_line(CommandLine::NO_PROGRAM);
 166   base::FilePath current_directory;
 167   if (!ParseCommandLine(cds, &parsed_command_line, &current_directory)) {
 168     *result = TRUE;
 169     return true;
 170   }
 171
 172   *result = notification_callback.Run(parsed_command_line, current_directory) ?
 173       TRUE : FALSE;
 174   return true;
 175 }
 176
 177 // Returns true if Chrome needs to be relaunched into Windows 8 immersive mode.
 178 // Following conditions apply:-
 179 // 1. Windows 8 or greater.
 180 // 2. Not in Windows 8 immersive mode.
 181 // 3. Chrome is default browser.
 182 // 4. Process integrity level is not high.
 183 // 5. The profile data directory is the default directory.
 184 // 6. Last used mode was immersive/machine is a tablet.
 185 // TODO(ananta)
 186 // Move this function to a common place as the Windows 8 delegate_execute
 187 // handler can possibly use this.
 188 bool ShouldLaunchInWindows8ImmersiveMode(const base::FilePath& user_data_dir) {
 189 #if defined(USE_AURA)
 190   // Returning false from this function doesn't mean we don't launch immersive
 191   // mode in Aura. This function is specifically called in case when we need
 192   // to relaunch desktop launched chrome into immersive mode through 'relaunch'
 193   // menu. In case of Aura, we will use delegate_execute to do the relaunch.
 194   return false;
 195 #else
 196   if (base::win::GetVersion() < base::win::VERSION_WIN8)
 197     return false;
 198
 199   if (base::win::IsProcessImmersive(base::GetCurrentProcessHandle()))
 200     return false;
 201
 202   if (ShellIntegration::GetDefaultBrowser() != ShellIntegration::IS_DEFAULT)
 203     return false;
 204
 205   base::IntegrityLevel integrity_level = base::INTEGRITY_UNKNOWN;
 206   base::GetProcessIntegrityLevel(base::GetCurrentProcessHandle(),
 207                                  &integrity_level);
 208   if (integrity_level == base::HIGH_INTEGRITY)
 209     return false;
 210
 211   base::FilePath default_user_data_dir;
 212   if (!chrome::GetDefaultUserDataDirectory(&default_user_data_dir))
 213     return false;
 214
 215   if (default_user_data_dir != user_data_dir)
 216     return false;
 217
 218   base::win::RegKey reg_key;
 219   DWORD reg_value = 0;
 220   if (reg_key.Create(HKEY_CURRENT_USER, chrome::kMetroRegistryPath,
 221                      KEY_READ) == ERROR_SUCCESS &&
 222       reg_key.ReadValueDW(chrome::kLaunchModeValue,
 223                           &reg_value) == ERROR_SUCCESS) {
 224     return reg_value == 1;
 225   }
 226   return false;
 227 #endif
 228 }
 229
 230 }  // namespace
 231
 232 // Microsoft's Softricity virtualization breaks the sandbox processes.
 233 // So, if we detect the Softricity DLL we use WMI Win32_Process.Create to
 234 // break out of the virtualization environment.
 235 // http://code.google.com/p/chromium/issues/detail?id=43650
 236 bool ProcessSingleton::EscapeVirtualization(
 237     const base::FilePath& user_data_dir) {
 238   if (::GetModuleHandle(L"sftldr_wow64.dll") ||
 239       ::GetModuleHandle(L"sftldr.dll")) {
 240     int process_id;
 241     if (!installer::WMIProcess::Launch(::GetCommandLineW(), &process_id))
 242       return false;
 243     is_virtualized_ = true;
 244     // The new window was spawned from WMI, and won't be in the foreground.
 245     // So, first we sleep while the new chrome.exe instance starts (because
 246     // WaitForInputIdle doesn't work here). Then we poll for up to two more
 247     // seconds and make the window foreground if we find it (or we give up).
 248     HWND hwnd = 0;
 249     ::Sleep(90);
 250     for (int tries = 200; tries; --tries) {
 251       hwnd = chrome::FindRunningChromeWindow(user_data_dir);
 252       if (hwnd) {
 253         ::SetForegroundWindow(hwnd);
 254         break;
 255       }
 256       ::Sleep(10);
 257     }
 258     return true;
 259   }
 260   return false;
 261 }
 262
 263 ProcessSingleton::ProcessSingleton(
 264     const base::FilePath& user_data_dir,
 265     const NotificationCallback& notification_callback)
 266     : notification_callback_(notification_callback),
 267       is_virtualized_(false), lock_file_(INVALID_HANDLE_VALUE),
 268       user_data_dir_(user_data_dir) {
 269 }
 270
 271 ProcessSingleton::~ProcessSingleton() {
 272   if (lock_file_ != INVALID_HANDLE_VALUE)
 273     ::CloseHandle(lock_file_);
 274 }
 275
 276 // Code roughly based on Mozilla.
 277 ProcessSingleton::NotifyResult ProcessSingleton::NotifyOtherProcess() {
 278   if (is_virtualized_)
 279     return PROCESS_NOTIFIED;  // We already spawned the process in this case.
 280   if (lock_file_ == INVALID_HANDLE_VALUE && !remote_window_) {
 281     return LOCK_ERROR;
 282   } else if (!remote_window_) {
 283     return PROCESS_NONE;
 284   }
 285
 286   switch (chrome::AttemptToNotifyRunningChrome(remote_window_, false)) {
 287     case chrome::NOTIFY_SUCCESS:
 288       return PROCESS_NOTIFIED;
 289     case chrome::NOTIFY_FAILED:
 290       remote_window_ = NULL;
 291       return PROCESS_NONE;
 292     case chrome::NOTIFY_WINDOW_HUNG:
 293       remote_window_ = NULL;
 294       break;
 295   }
 296
 297   DWORD process_id = 0;
 298   DWORD thread_id = ::GetWindowThreadProcessId(remote_window_, &process_id);
 299   if (!thread_id || !process_id) {
 300     remote_window_ = NULL;
 301     return PROCESS_NONE;
 302   }
 303
 304   // The window is hung. Scan for every window to find a visible one.
 305   bool visible_window = false;
 306   ::EnumThreadWindows(thread_id,
 307                       &BrowserWindowEnumeration,
 308                       reinterpret_cast<LPARAM>(&visible_window));
 309
 310   // If there is a visible browser window, ask the user before killing it.
 311   if (visible_window &&
 312       chrome::ShowMessageBox(
 313           NULL,
 314           l10n_util::GetStringUTF16(IDS_PRODUCT_NAME),
 315           l10n_util::GetStringUTF16(IDS_BROWSER_HUNGBROWSER_MESSAGE),
 316           chrome::MESSAGE_BOX_TYPE_QUESTION) == chrome::MESSAGE_BOX_RESULT_NO) {
 317     // The user denied. Quit silently.
 318     return PROCESS_NOTIFIED;
 319   }
 320
 321   // Time to take action. Kill the browser process.
 322   base::KillProcessById(process_id, content::RESULT_CODE_HUNG, true);
 323   remote_window_ = NULL;
 324   return PROCESS_NONE;
 325 }
 326
 327 ProcessSingleton::NotifyResult
 328 ProcessSingleton::NotifyOtherProcessOrCreate() {
 329   ProcessSingleton::NotifyResult result = PROCESS_NONE;
 330   if (!Create()) {
 331     result = NotifyOtherProcess();
 332     if (result == PROCESS_NONE)
 333       result = PROFILE_IN_USE;
 334   } else {
 335     g_browser_process->platform_part()->PlatformSpecificCommandLineProcessing(
 336         *CommandLine::ForCurrentProcess());
 337   }
 338   return result;
 339 }
 340
 341 // Look for a Chrome instance that uses the same profile directory. If there
 342 // isn't one, create a message window with its title set to the profile
 343 // directory path.
 344 bool ProcessSingleton::Create() {
 345   static const wchar_t kMutexName[] = L"Local\\ChromeProcessSingletonStartup!";
 346   static const wchar_t kMetroActivationEventName[] =
 347       L"Local\\ChromeProcessSingletonStartupMetroActivation!";
 348
 349   remote_window_ = chrome::FindRunningChromeWindow(user_data_dir_);
 350   if (!remote_window_ && !EscapeVirtualization(user_data_dir_)) {
 351     // Make sure we will be the one and only process creating the window.
 352     // We use a named Mutex since we are protecting against multi-process
 353     // access. As documented, it's clearer to NOT request ownership on creation
 354     // since it isn't guaranteed we will get it. It is better to create it
 355     // without ownership and explicitly get the ownership afterward.
 356     base::win::ScopedHandle only_me(::CreateMutex(NULL, FALSE, kMutexName));
 357     if (!only_me.IsValid()) {
 358       DPLOG(FATAL) << "CreateMutex failed";
 359       return false;
 360     }
 361
 362     AutoLockMutex auto_lock_only_me(only_me.Get());
 363
 364     // We now own the mutex so we are the only process that can create the
 365     // window at this time, but we must still check if someone created it
 366     // between the time where we looked for it above and the time the mutex
 367     // was given to us.
 368     remote_window_ = chrome::FindRunningChromeWindow(user_data_dir_);
 369
 370
 371     // In Win8+, a new Chrome process launched in Desktop mode may need to be
 372     // transmuted into Metro Chrome (see ShouldLaunchInWindows8ImmersiveMode for
 373     // heuristics). To accomplish this, the current Chrome activates Metro
 374     // Chrome, releases the startup mutex, and waits for metro Chrome to take
 375     // the singleton. From that point onward, the command line for this Chrome
 376     // process will be sent to Metro Chrome by the usual channels.
 377     if (!remote_window_ && base::win::GetVersion() >= base::win::VERSION_WIN8 &&
 378         !base::win::IsMetroProcess()) {
 379       // |metro_activation_event| is created right before activating a Metro
 380       // Chrome (note that there can only be one Metro Chrome process; by OS
 381       // design); all following Desktop processes will then wait for this event
 382       // to be signaled by Metro Chrome which will do so as soon as it grabs
 383       // this singleton (should any of the waiting processes timeout waiting for
 384       // the signal they will try to grab the singleton for themselves which
 385       // will result in a forced Desktop Chrome launch in the worst case).
 386       base::win::ScopedHandle metro_activation_event(
 387           ::OpenEvent(SYNCHRONIZE, FALSE, kMetroActivationEventName));
 388       if (!metro_activation_event.IsValid() &&
 389           ShouldLaunchInWindows8ImmersiveMode(user_data_dir_)) {
 390         // No Metro activation is under way, but the desire is to launch in
 391         // Metro mode: activate and rendez-vous with the activated process.
 392         metro_activation_event.Set(
 393             ::CreateEvent(NULL, TRUE, FALSE, kMetroActivationEventName));
 394         if (!chrome::ActivateMetroChrome()) {
 395           // Failed to launch immersive Chrome, default to launching on Desktop.
 396           LOG(ERROR) << "Failed to launch immersive chrome";
 397           metro_activation_event.Close();
 398         }
 399       }
 400
 401       if (metro_activation_event.IsValid()) {
 402         // Release |only_me| (to let Metro Chrome grab this singleton) and wait
 403         // until the event is signaled (i.e. Metro Chrome was successfully
 404         // activated). Ignore timeout waiting for |metro_activation_event|.
 405         {
 406           AutoUnlockMutex auto_unlock_only_me(only_me.Get());
 407
 408           DWORD result = ::WaitForSingleObject(metro_activation_event.Get(),
 409                                                kMetroChromeActivationTimeoutMs);
 410           DPCHECK(result == WAIT_OBJECT_0 || result == WAIT_TIMEOUT)
 411               << "Result = " << result;
 412         }
 413
 414         // Check if this singleton was successfully grabbed by another process
 415         // (hopefully Metro Chrome). Failing to do so, this process will grab
 416         // the singleton and launch in Desktop mode.
 417         remote_window_ = chrome::FindRunningChromeWindow(user_data_dir_);
 418       }
 419     }
 420
 421     if (!remote_window_) {
 422       // We have to make sure there is no Chrome instance running on another
 423       // machine that uses the same profile.
 424       base::FilePath lock_file_path = user_data_dir_.AppendASCII(kLockfile);
 425       lock_file_ = ::CreateFile(lock_file_path.value().c_str(),
 426                                 GENERIC_WRITE,
 427                                 FILE_SHARE_READ,
 428                                 NULL,
 429                                 CREATE_ALWAYS,
 430                                 FILE_ATTRIBUTE_NORMAL |
 431                                 FILE_FLAG_DELETE_ON_CLOSE,
 432                                 NULL);
 433       DWORD error = ::GetLastError();
 434       LOG_IF(WARNING, lock_file_ != INVALID_HANDLE_VALUE &&
 435           error == ERROR_ALREADY_EXISTS) << "Lock file exists but is writable.";
 436       LOG_IF(ERROR, lock_file_ == INVALID_HANDLE_VALUE)
 437           << "Lock file can not be created! Error code: " << error;
 438
 439       if (lock_file_ != INVALID_HANDLE_VALUE) {
 440         // Set the window's title to the path of our user data directory so
 441         // other Chrome instances can decide if they should forward to us.
 442         bool result = window_.CreateNamed(
 443             base::Bind(&ProcessLaunchNotification, notification_callback_),
 444             user_data_dir_.value());
 445         CHECK(result && window_.hwnd());
 446       }
 447
 448       if (base::win::GetVersion() >= base::win::VERSION_WIN8) {
 449         // Make sure no one is still waiting on Metro activation whether it
 450         // succeeded (i.e., this is the Metro process) or failed.
 451         base::win::ScopedHandle metro_activation_event(
 452             ::OpenEvent(EVENT_MODIFY_STATE, FALSE, kMetroActivationEventName));
 453         if (metro_activation_event.IsValid())
 454           ::SetEvent(metro_activation_event.Get());
 455       }
 456     }
 457   }
 458
 459   return window_.hwnd() != NULL;
 460 }
 461
 462 void ProcessSingleton::Cleanup() {
 463 }