win8/delegate_execute/command_execute_impl.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 // Implementation of the CommandExecuteImpl class which implements the
   5 // IExecuteCommand and related interfaces for handling ShellExecute based
   6 // launches of the Chrome browser.
   7
   8 #include "win8/delegate_execute/command_execute_impl.h"
   9
  10 #include <shlguid.h>
  11
  12 #include "base/files/file_util.h"
  13 #include "base/path_service.h"
  14 #include "base/process/launch.h"
  15 #include "base/strings/utf_string_conversions.h"
  16 #include "base/win/message_window.h"
  17 #include "base/win/registry.h"
  18 #include "base/win/scoped_co_mem.h"
  19 #include "base/win/scoped_handle.h"
  20 #include "base/win/scoped_process_information.h"
  21 #include "base/win/win_util.h"
  22 #include "chrome/common/chrome_constants.h"
  23 #include "chrome/common/chrome_paths.h"
  24 #include "chrome/common/chrome_switches.h"
  25 #include "chrome/installer/util/browser_distribution.h"
  26 #include "chrome/installer/util/install_util.h"
  27 #include "chrome/installer/util/shell_util.h"
  28 #include "chrome/installer/util/util_constants.h"
  29 #include "ui/base/clipboard/clipboard_util_win.h"
  30 #include "ui/base/ui_base_switches.h"
  31 #include "ui/gfx/win/dpi.h"
  32 #include "win8/delegate_execute/chrome_util.h"
  33 #include "win8/delegate_execute/delegate_execute_util.h"
  34 #include "win8/viewer/metro_viewer_constants.h"
  35
  36 namespace {
  37 // Helper function to retrieve the url from IShellItem interface passed in.
  38 // Returns S_OK on success.
  39 HRESULT GetUrlFromShellItem(IShellItem* shell_item, base::string16* url) {
  40   DCHECK(shell_item);
  41   DCHECK(url);
  42   // First attempt to get the url from the underlying IDataObject if any. This
  43   // ensures that we get the full url, i.e. including the anchor.
  44   // If we fail to get the underlying IDataObject we retrieve the url via the
  45   // IShellItem::GetDisplayName function.
  46   CComPtr<IDataObject> object;
  47   HRESULT hr = shell_item->BindToHandler(NULL,
  48                                          BHID_DataObject,
  49                                          IID_IDataObject,
  50                                          reinterpret_cast<void**>(&object));
  51   if (SUCCEEDED(hr)) {
  52     DCHECK(object);
  53     if (ui::ClipboardUtil::GetPlainText(object, url))
  54       return S_OK;
  55   }
  56
  57   base::win::ScopedCoMem<wchar_t> name;
  58   hr = shell_item->GetDisplayName(SIGDN_URL, &name);
  59   if (hr != S_OK) {
  60     AtlTrace("Failed to get display name\n");
  61     return hr;
  62   }
  63
  64   *url = static_cast<const wchar_t*>(name);
  65   AtlTrace("Retrieved url from display name %ls\n", url->c_str());
  66   return S_OK;
  67 }
  68
  69 bool LaunchChromeBrowserProcess() {
  70   base::FilePath delegate_exe_path;
  71   if (!PathService::Get(base::FILE_EXE, &delegate_exe_path))
  72     return false;
  73
  74   // First try and go up a level to find chrome.exe.
  75   base::FilePath chrome_exe_path =
  76       delegate_exe_path.DirName()
  77                        .DirName()
  78                        .Append(chrome::kBrowserProcessExecutableName);
  79   if (!base::PathExists(chrome_exe_path)) {
  80     // Try looking in the current directory if we couldn't find it one up in
  81     // order to support developer installs.
  82     chrome_exe_path =
  83         delegate_exe_path.DirName()
  84                          .Append(chrome::kBrowserProcessExecutableName);
  85   }
  86
  87   if (!base::PathExists(chrome_exe_path)) {
  88     AtlTrace("Could not locate chrome.exe at: %ls\n",
  89              chrome_exe_path.value().c_str());
  90     return false;
  91   }
  92
  93   base::CommandLine cl(chrome_exe_path);
  94
  95   // Prevent a Chrome window from showing up on the desktop.
  96   cl.AppendSwitch(switches::kSilentLaunch);
  97
  98   // Tell Chrome to connect to the Metro viewer process.
  99   cl.AppendSwitch(switches::kViewerConnect);
 100
 101   base::LaunchOptions launch_options;
 102   launch_options.start_hidden = true;
 103
 104   return base::LaunchProcess(cl, launch_options).IsValid();
 105 }
 106
 107 }  // namespace
 108
 109 bool CommandExecuteImpl::path_provider_initialized_ = false;
 110
 111 // CommandExecuteImpl is responsible for activating chrome in Windows 8. The
 112 // flow is complicated and this tries to highlight the important events.
 113 // The current approach is to have a single instance of chrome either
 114 // running in desktop or metro mode. If there is no current instance then
 115 // the desktop shortcut launches desktop chrome and the metro tile or search
 116 // charm launches metro chrome.
 117 // If chrome is running then focus/activation is given to the existing one
 118 // regardless of what launch point the user used.
 119 //
 120 // The general flow for activation is as follows:
 121 //
 122 // 1- User interacts with launch point (icon, tile, search, shellexec, etc)
 123 // 2- Windows finds the appid for launch item and resolves it to chrome
 124 // 3- Windows activates CommandExecuteImpl inside a surrogate process
 125 // 4- Windows calls the following sequence of entry points:
 126 //    CommandExecuteImpl::SetShowWindow
 127 //    CommandExecuteImpl::SetPosition
 128 //    CommandExecuteImpl::SetDirectory
 129 //    CommandExecuteImpl::SetParameter
 130 //    CommandExecuteImpl::SetNoShowUI
 131 //    CommandExecuteImpl::SetSelection
 132 //    CommandExecuteImpl::Initialize
 133 //    Up to this point the code basically just gathers values passed in, like
 134 //    the launch scheme (or url) and the activation verb.
 135 // 5- Windows calls CommandExecuteImpl::Getvalue()
 136 //    Here we need to return AHE_IMMERSIVE or AHE_DESKTOP. That depends on:
 137 //    a) if run in high-integrity return AHE_DESKTOP.
 138 //    b) else we return what GetLaunchMode() tells us, which is:
 139 //       i) if chrome is not the default browser, return AHE_DESKTOP
 140 //       ii) if the command line --force-xxx is present return that
 141 //       iii) if the registry 'launch_mode' exists return that
 142 //       iv) else return AHE_DESKTOP
 143 // 6- If we returned AHE_IMMERSIVE in step 5 windows might not call us back
 144 //    and simply activate chrome in metro by itself, however in some cases
 145 //    it might proceed at step 7.
 146 //    As far as we know if we return AHE_DESKTOP then step 7 always happens.
 147 // 7- Windows calls CommandExecuteImpl::Execute()
 148 //    Here we call GetLaunchMode() which returns the cached answer
 149 //    computed at step 5c. which can be:
 150 //    a) ECHUIM_DESKTOP then we call LaunchDesktopChrome() that calls
 151 //       ::CreateProcess and we exit at this point even on failure.
 152 //    b) else we call one of the IApplicationActivationManager activation
 153 //       functions depending on the parameters passed in step 4.
 154 //    c) If the activation returns E_APPLICATION_NOT_REGISTERED, then we fall
 155 //       back to launching chrome on the desktop via LaunchDestopChrome().  Note
 156 //       that this case can lead to strange behavior, because at this point we
 157 //       have pre-launched the browser with:
 158 //       --silent-launch --connect-to-metro-viewer.
 159 //       E_APPLICATION_NOT_REGISTERED is always returned if Chrome is not the
 160 //       default browser (this case will have already been checked for by
 161 //       GetLaunchMode() and AHE_DESKTOP returned), but we don't know if it can
 162 //       be returned for other reasons.
 163 //
 164 // Note that if a command line --force-xxx is present we write that launch mode
 165 // in the registry so next time the logic reaches 5c-ii it will use the same
 166 // mode again.
 167 //
 168 CommandExecuteImpl::CommandExecuteImpl()
 169     : parameters_(base::CommandLine::NO_PROGRAM),
 170       launch_scheme_(INTERNET_SCHEME_DEFAULT),
 171       integrity_level_(base::INTEGRITY_UNKNOWN) {
 172   memset(&start_info_, 0, sizeof(start_info_));
 173   start_info_.cb = sizeof(start_info_);
 174
 175   // We need to query the user data dir of chrome so we need chrome's
 176   // path provider. We can be created multiple times in a single instance
 177   // however so make sure we do this only once.
 178   if (!path_provider_initialized_) {
 179     chrome::RegisterPathProvider();
 180     path_provider_initialized_ = true;
 181   }
 182 }
 183
 184 // CommandExecuteImpl
 185 STDMETHODIMP CommandExecuteImpl::SetKeyState(DWORD key_state) {
 186   return S_OK;
 187 }
 188
 189 STDMETHODIMP CommandExecuteImpl::SetParameters(LPCWSTR params) {
 190   parameters_ = delegate_execute::CommandLineFromParameters(params);
 191   return S_OK;
 192 }
 193
 194 STDMETHODIMP CommandExecuteImpl::SetPosition(POINT pt) {
 195   return S_OK;
 196 }
 197
 198 STDMETHODIMP CommandExecuteImpl::SetShowWindow(int show) {
 199   start_info_.wShowWindow = show;
 200   start_info_.dwFlags |= STARTF_USESHOWWINDOW;
 201   return S_OK;
 202 }
 203
 204 STDMETHODIMP CommandExecuteImpl::SetNoShowUI(BOOL no_show_ui) {
 205   return S_OK;
 206 }
 207
 208 STDMETHODIMP CommandExecuteImpl::SetDirectory(LPCWSTR directory) {
 209   return S_OK;
 210 }
 211
 212 STDMETHODIMP CommandExecuteImpl::GetValue(enum AHE_TYPE* pahe) {
 213   if (!GetLaunchScheme(&display_name_, &launch_scheme_)) {
 214     AtlTrace("Failed to get scheme, E_FAIL\n");
 215     return E_FAIL;
 216   }
 217
 218   EC_HOST_UI_MODE mode = GetLaunchMode();
 219   *pahe = (mode == ECHUIM_DESKTOP) ? AHE_DESKTOP : AHE_IMMERSIVE;
 220
 221   // If we're going to return AHE_IMMERSIVE, then both the browser process and
 222   // the metro viewer need to launch and connect before the user can start
 223   // browsing.  However we must not launch the metro viewer until we get a
 224   // call to CommandExecuteImpl::Execute().  If we wait until then to launch
 225   // the browser process as well, it will appear laggy while they connect to
 226   // each other, so we pre-launch the browser process now.
 227   if (*pahe == AHE_IMMERSIVE && verb_ != win8::kMetroViewerConnectVerb) {
 228     LaunchChromeBrowserProcess();
 229   }
 230   return S_OK;
 231 }
 232
 233 STDMETHODIMP CommandExecuteImpl::Execute() {
 234   AtlTrace("In %hs\n", __FUNCTION__);
 235
 236   if (integrity_level_ == base::HIGH_INTEGRITY)
 237     return LaunchDesktopChrome();
 238
 239   EC_HOST_UI_MODE mode = GetLaunchMode();
 240   if (mode == ECHUIM_DESKTOP)
 241     return LaunchDesktopChrome();
 242
 243   HRESULT hr = E_FAIL;
 244   CComPtr<IApplicationActivationManager> activation_manager;
 245   hr = activation_manager.CoCreateInstance(CLSID_ApplicationActivationManager);
 246   if (!activation_manager) {
 247     AtlTrace("Failed to get the activation manager, error 0x%x\n", hr);
 248     return S_OK;
 249   }
 250
 251   BrowserDistribution* distribution = BrowserDistribution::GetDistribution();
 252   bool is_per_user_install = InstallUtil::IsPerUserInstall(chrome_exe_);
 253   base::string16 app_id = ShellUtil::GetBrowserModelId(
 254       distribution, is_per_user_install);
 255
 256   DWORD pid = 0;
 257   if (launch_scheme_ == INTERNET_SCHEME_FILE &&
 258       display_name_.find(installer::kChromeExe) != base::string16::npos) {
 259     AtlTrace("Activating for file\n");
 260     hr = activation_manager->ActivateApplication(app_id.c_str(),
 261                                                  verb_.c_str(),
 262                                                  AO_NONE,
 263                                                  &pid);
 264   } else {
 265     AtlTrace("Activating for protocol\n");
 266     hr = activation_manager->ActivateForProtocol(app_id.c_str(),
 267                                                  item_array_,
 268                                                  &pid);
 269   }
 270   if (hr == E_APPLICATION_NOT_REGISTERED) {
 271     AtlTrace("Metro chrome is not registered, launching in desktop\n");
 272     return LaunchDesktopChrome();
 273   }
 274   AtlTrace("Metro Chrome launch, pid=%d, returned 0x%x\n", pid, hr);
 275   return S_OK;
 276 }
 277
 278 STDMETHODIMP CommandExecuteImpl::Initialize(LPCWSTR name,
 279                                             IPropertyBag* bag) {
 280   if (!FindChromeExe(&chrome_exe_))
 281     return E_FAIL;
 282   delegate_execute::UpdateChromeIfNeeded(chrome_exe_);
 283
 284   if (name) {
 285     AtlTrace("Verb is %S\n", name);
 286     verb_ = name;
 287   }
 288
 289   integrity_level_ = base::GetCurrentProcessIntegrityLevel();
 290   return S_OK;
 291 }
 292
 293 STDMETHODIMP CommandExecuteImpl::SetSelection(IShellItemArray* item_array) {
 294   item_array_ = item_array;
 295   return S_OK;
 296 }
 297
 298 STDMETHODIMP CommandExecuteImpl::GetSelection(REFIID riid, void** selection) {
 299   return S_OK;
 300 }
 301
 302 STDMETHODIMP CommandExecuteImpl::AllowForegroundTransfer(void* reserved) {
 303   return S_OK;
 304 }
 305
 306 // Returns false if chrome.exe cannot be found.
 307 // static
 308 bool CommandExecuteImpl::FindChromeExe(base::FilePath* chrome_exe) {
 309   // Look for chrome.exe one folder above delegate_execute.exe (as expected in
 310   // Chrome installs). Failing that, look for it alonside delegate_execute.exe.
 311   base::FilePath dir_exe;
 312   if (!PathService::Get(base::DIR_EXE, &dir_exe)) {
 313     AtlTrace("Failed to get current exe path\n");
 314     return false;
 315   }
 316
 317   *chrome_exe = dir_exe.DirName().Append(chrome::kBrowserProcessExecutableName);
 318   if (!base::PathExists(*chrome_exe)) {
 319     *chrome_exe = dir_exe.Append(chrome::kBrowserProcessExecutableName);
 320     if (!base::PathExists(*chrome_exe)) {
 321       AtlTrace("Failed to find chrome exe file\n");
 322       return false;
 323     }
 324   }
 325   return true;
 326 }
 327
 328 bool CommandExecuteImpl::GetLaunchScheme(
 329     base::string16* display_name, INTERNET_SCHEME* scheme) {
 330   if (!item_array_)
 331     return false;
 332
 333   ATLASSERT(display_name);
 334   ATLASSERT(scheme);
 335
 336   DWORD count = 0;
 337   item_array_->GetCount(&count);
 338
 339   if (count != 1) {
 340     AtlTrace("Cannot handle %d elements in the IShellItemArray\n", count);
 341     return false;
 342   }
 343
 344   CComPtr<IEnumShellItems> items;
 345   item_array_->EnumItems(&items);
 346   CComPtr<IShellItem> shell_item;
 347   HRESULT hr = items->Next(1, &shell_item, &count);
 348   if (hr != S_OK) {
 349     AtlTrace("Failed to read element from the IShellItemsArray\n");
 350     return false;
 351   }
 352
 353   hr = GetUrlFromShellItem(shell_item, display_name);
 354   if (FAILED(hr)) {
 355     AtlTrace("Failed to get url. Error 0x%x\n", hr);
 356     return false;
 357   }
 358
 359   wchar_t scheme_name[16];
 360   URL_COMPONENTS components = {0};
 361   components.lpszScheme = scheme_name;
 362   components.dwSchemeLength = sizeof(scheme_name)/sizeof(scheme_name[0]);
 363
 364   components.dwStructSize = sizeof(components);
 365   if (!InternetCrackUrlW(display_name->c_str(), 0, 0, &components)) {
 366     AtlTrace("Failed to crack url %ls\n", display_name->c_str());
 367     return false;
 368   }
 369
 370   AtlTrace("Launch scheme is [%ls] (%d)\n", scheme_name, components.nScheme);
 371   *scheme = components.nScheme;
 372   return true;
 373 }
 374
 375 HRESULT CommandExecuteImpl::LaunchDesktopChrome() {
 376   base::string16 display_name = display_name_;
 377
 378   switch (launch_scheme_) {
 379     case INTERNET_SCHEME_FILE:
 380       // If anything other than chrome.exe is passed in the display name we
 381       // should honor it. For e.g. If the user clicks on a html file when
 382       // chrome is the default we should treat it as a parameter to be passed
 383       // to chrome.
 384       if (display_name.find(installer::kChromeExe) != base::string16::npos)
 385         display_name.clear();
 386       break;
 387
 388     default:
 389       break;
 390   }
 391
 392   base::CommandLine chrome(delegate_execute::MakeChromeCommandLine(
 393       chrome_exe_, parameters_, display_name));
 394   base::string16 command_line(chrome.GetCommandLineString());
 395
 396   AtlTrace("Formatted command line is %ls\n", command_line.c_str());
 397
 398   PROCESS_INFORMATION temp_process_info = {};
 399   BOOL ret = CreateProcess(chrome_exe_.value().c_str(),
 400                            &command_line[0],
 401                            NULL, NULL, FALSE, 0, NULL, NULL, &start_info_,
 402                            &temp_process_info);
 403   if (ret) {
 404     base::win::ScopedProcessInformation proc_info(temp_process_info);
 405     AtlTrace("Process id is %d\n", proc_info.process_id());
 406     AllowSetForegroundWindow(proc_info.process_id());
 407   } else {
 408     AtlTrace("Process launch failed, error %d\n", ::GetLastError());
 409   }
 410
 411   return S_OK;
 412 }
 413
 414 EC_HOST_UI_MODE CommandExecuteImpl::GetLaunchMode() {
 415   // See the header file for an explanation of the mode selection logic.
 416   static bool launch_mode_determined = false;
 417   static EC_HOST_UI_MODE launch_mode = ECHUIM_DESKTOP;
 418
 419   const char* modes[] = { "Desktop", "Immersive", "SysLauncher", "??" };
 420
 421   if (launch_mode_determined)
 422     return launch_mode;
 423
 424   if (integrity_level_ == base::HIGH_INTEGRITY) {
 425     // Metro mode apps don't work in high integrity mode.
 426     AtlTrace("High integrity: launching in desktop mode\n");
 427     launch_mode = ECHUIM_DESKTOP;
 428     launch_mode_determined = true;
 429     return launch_mode;
 430   }
 431
 432   base::FilePath chrome_exe;
 433   if (!FindChromeExe(&chrome_exe) ||
 434       ShellUtil::GetChromeDefaultStateFromPath(chrome_exe) !=
 435           ShellUtil::IS_DEFAULT) {
 436     AtlTrace("Chrome is not default: launching in desktop mode\n");
 437     launch_mode = ECHUIM_DESKTOP;
 438     launch_mode_determined = true;
 439     return launch_mode;
 440   }
 441
 442   if (GetAsyncKeyState(VK_SHIFT) && GetAsyncKeyState(VK_F11)) {
 443     AtlTrace("Hotkey: launching in immersive mode\n");
 444     launch_mode = ECHUIM_IMMERSIVE;
 445     launch_mode_determined = true;
 446     return launch_mode;
 447   }
 448
 449   // From here on, if we can, we will write the outcome
 450   // of this function to the registry.
 451   if (parameters_.HasSwitch(switches::kForceImmersive)) {
 452     launch_mode = ECHUIM_IMMERSIVE;
 453     launch_mode_determined = true;
 454     parameters_ = base::CommandLine(base::CommandLine::NO_PROGRAM);
 455   } else if (parameters_.HasSwitch(switches::kForceDesktop)) {
 456     launch_mode = ECHUIM_DESKTOP;
 457     launch_mode_determined = true;
 458     parameters_ = base::CommandLine(base::CommandLine::NO_PROGRAM);
 459   }
 460
 461   base::win::RegKey reg_key;
 462   LONG key_result = reg_key.Create(HKEY_CURRENT_USER,
 463                                    chrome::kMetroRegistryPath,
 464                                    KEY_ALL_ACCESS);
 465   if (key_result != ERROR_SUCCESS) {
 466     AtlTrace("Failed to open HKCU %ls key, error 0x%x\n",
 467              chrome::kMetroRegistryPath,
 468              key_result);
 469     if (!launch_mode_determined) {
 470       // If we cannot open the key and we don't know the
 471       // launch mode we default to desktop mode.
 472       launch_mode = ECHUIM_DESKTOP;
 473       launch_mode_determined = true;
 474     }
 475     return launch_mode;
 476   }
 477
 478   if (launch_mode_determined) {
 479     AtlTrace("Launch mode forced by cmdline to %s\n", modes[launch_mode]);
 480     reg_key.WriteValue(chrome::kLaunchModeValue,
 481                        static_cast<DWORD>(launch_mode));
 482     return launch_mode;
 483   }
 484
 485   // Use the previous mode if available. Else launch in desktop mode.
 486   DWORD reg_value;
 487   if (reg_key.ReadValueDW(chrome::kLaunchModeValue,
 488                           &reg_value) != ERROR_SUCCESS) {
 489     launch_mode = ECHUIM_DESKTOP;
 490     AtlTrace("Can't read registry, defaulting to %s\n", modes[launch_mode]);
 491   } else if (reg_value >= ECHUIM_SYSTEM_LAUNCHER) {
 492     AtlTrace("Invalid registry launch mode value %u\n", reg_value);
 493     launch_mode = ECHUIM_DESKTOP;
 494   } else {
 495     launch_mode = static_cast<EC_HOST_UI_MODE>(reg_value);
 496     AtlTrace("Launch mode forced by registry to %s\n", modes[launch_mode]);
 497   }
 498
 499   launch_mode_determined = true;
 500   return launch_mode;
 501 }