Allow chrome to become the os default handler for arbitrary protocols on mac/win.

chrome/browser/shell_integration_win.cc

 // Copyright (c) 2011 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/shell_integration.h"
 
 #include <windows.h>
 #include <shobjidl.h>
 #include <propkey.h>
 #include <propvarutil.h>
@@ skipping 269 matching lines @@
   if (!ShellUtil::MakeChromeDefault(dist, ShellUtil::CURRENT_USER,
                                     chrome_exe.value(), true)) {
     LOG(ERROR) << "Chrome could not be set as default browser.";
     return false;
   }
 
   VLOG(1) << "Chrome registered as default browser.";
   return true;
 }
 
-ShellIntegration::DefaultBrowserState ShellIntegration::IsDefaultBrowser() {
+bool ShellIntegration::SetAsDefaultProtocolClient(const std::string& protocol) {
+  if (protocol.empty())
+    return false;
+
+  FilePath chrome_exe;
+  if (!PathService::Get(base::FILE_EXE, &chrome_exe)) {
+    LOG(ERROR) << "Error getting app exe path";
+    return false;
+  }
+
+  std::wstring wprotocol = UTF8ToWide(protocol);
+  BrowserDistribution* dist = BrowserDistribution::GetDistribution();
+  if (!ShellUtil::MakeChromeDefaultProtocolClient(dist, chrome_exe.value(),
+        wprotocol)) {
+    LOG(ERROR) << "Chrome could not be set as default handler for "
+               << protocol << ".";
+    return false;
+  }
+
+  VLOG(1) << "Chrome registered as default handler for " << protocol << ".";
+  return true;
+}
+
+ShellIntegration::DefaultWebClientState ShellIntegration::IsDefaultBrowser() {
   // First determine the app path. If we can't determine what that is, we have
   // bigger fish to fry...
   FilePath app_path;
   if (!PathService::Get(base::FILE_EXE, &app_path)) {
     LOG(ERROR) << "Error getting app exe path";
-    return UNKNOWN_DEFAULT_BROWSER;
+    return UNKNOWN_DEFAULT_WEB_CLIENT;
   }
   // When we check for default browser we don't necessarily want to count file
   // type handlers and icons as having changed the default browser status,
   // since the user may have changed their shell settings to cause HTML files
   // to open with a text editor for example. We also don't want to aggressively
   // claim FTP, since the user may have a separate FTP client. It is an open
   // question as to how to "heal" these settings. Perhaps the user should just
   // re-run the installer or run with the --set-default-browser command line
   // flag. There is doubtless some other key we can hook into to cause "Repair"
   // to show up in Add/Remove programs for us.
   const std::wstring kChromeProtocols[] = {L"http", L"https"};
 
   if (base::win::GetVersion() >= base::win::VERSION_VISTA) {
     IApplicationAssociationRegistration* pAAR;
     HRESULT hr = CoCreateInstance(CLSID_ApplicationAssociationRegistration,
         NULL, CLSCTX_INPROC, __uuidof(IApplicationAssociationRegistration),
         (void**)&pAAR);
     if (!SUCCEEDED(hr))
-      return NOT_DEFAULT_BROWSER;
+      return NOT_DEFAULT_WEB_CLIENT;
 
     BrowserDistribution* dist = BrowserDistribution::GetDistribution();
     std::wstring app_name = dist->GetApplicationName();
     // If a user specific default browser entry exists, we check for that
     // app name being default. If not, then default browser is just called
     // Google Chrome or Chromium so we do not append suffix to app name.
     std::wstring suffix;
     if (ShellUtil::GetUserSpecificDefaultBrowserSuffix(dist, &suffix))
       app_name += suffix;
 
     for (int i = 0; i < _countof(kChromeProtocols); i++) {
       BOOL result = TRUE;
       hr = pAAR->QueryAppIsDefault(kChromeProtocols[i].c_str(), AT_URLPROTOCOL,
           AL_EFFECTIVE, app_name.c_str(), &result);
       if (!SUCCEEDED(hr) || result == FALSE) {
         pAAR->Release();
-        return NOT_DEFAULT_BROWSER;
+        return NOT_DEFAULT_WEB_CLIENT;
       }
     }
     pAAR->Release();
   } else {
     std::wstring short_app_path;
     GetShortPathName(app_path.value().c_str(),
                      WriteInto(&short_app_path, MAX_PATH),
                      MAX_PATH);
 
     // open command for protocol associations
     for (int i = 0; i < _countof(kChromeProtocols); i++) {
       // Check in HKEY_CLASSES_ROOT that is the result of merge between
       // HKLM and HKCU
       HKEY root_key = HKEY_CLASSES_ROOT;
       // Check <protocol>\shell\open\command
       std::wstring key_path(kChromeProtocols[i] + ShellUtil::kRegShellOpen);
       base::win::RegKey key(root_key, key_path.c_str(), KEY_READ);
       std::wstring value;
       if (!key.Valid() || (key.ReadValue(L"", &value) != ERROR_SUCCESS))
-        return NOT_DEFAULT_BROWSER;
+        return NOT_DEFAULT_WEB_CLIENT;
       // Need to normalize path in case it's been munged.
       CommandLine command_line = CommandLine::FromString(value);
       std::wstring short_path;
       GetShortPathName(command_line.GetProgram().value().c_str(),
                        WriteInto(&short_path, MAX_PATH), MAX_PATH);
       if (!FilePath::CompareEqualIgnoreCase(short_path, short_app_path))
-        return NOT_DEFAULT_BROWSER;
+        return NOT_DEFAULT_WEB_CLIENT;
     }
   }
-  return IS_DEFAULT_BROWSER;
+  return IS_DEFAULT_WEB_CLIENT;
+}
+
+ShellIntegration::DefaultWebClientState
+    ShellIntegration::IsDefaultProtocolClient(const std::string& protocol) {
+  if (protocol.empty())
+    return UNKNOWN_DEFAULT_WEB_CLIENT;
+
+  // Determine the app path. If we can't determine what that is, we have
+  // bigger fish to fry...
+  FilePath app_path;
+  if (!PathService::Get(base::FILE_EXE, &app_path)) {
+    LOG(ERROR) << "Error getting app exe path";
+    return UNKNOWN_DEFAULT_WEB_CLIENT;
+  }
+
+  std::wstring wprotocol = UTF8ToWide(protocol);
+
+  if (base::win::GetVersion() >= base::win::VERSION_VISTA) {
+    IApplicationAssociationRegistration* pAAR;

[xiyuan, 2011/05/24 17:55:20]

suggest to use base::win::ScopedComPtr<...> so that it will automatically
released when out of scope.

[benwells, 2011/05/25 08:07:19]

Done (also for IsDefaultBrowser earlier).

+    HRESULT hr = CoCreateInstance(CLSID_ApplicationAssociationRegistration,
+        NULL, CLSCTX_INPROC, __uuidof(IApplicationAssociationRegistration),
+        (void**)&pAAR);
+    if (!SUCCEEDED(hr))
+      return NOT_DEFAULT_WEB_CLIENT;
+
+    BrowserDistribution* dist = BrowserDistribution::GetDistribution();
+    std::wstring app_name = dist->GetApplicationName();
+    // If a user specific default browser entry exists, we check for that
+    // app name being default. If not, then default browser is just called
+    // Google Chrome or Chromium so we do not append suffix to app name.
+    std::wstring suffix;
+    if (ShellUtil::GetUserSpecificDefaultBrowserSuffix(dist, &suffix))
+      app_name += suffix;
+
+    BOOL result = TRUE;
+    hr = pAAR->QueryAppIsDefault(wprotocol.c_str(), AT_URLPROTOCOL,
+        AL_EFFECTIVE, app_name.c_str(), &result);
+    if (!SUCCEEDED(hr) || result == FALSE) {
+      pAAR->Release();
+      return NOT_DEFAULT_WEB_CLIENT;
+    }
+    pAAR->Release();
+  } else {
+    std::wstring short_app_path;
+    GetShortPathName(app_path.value().c_str(),

[grt (UTC plus 2), 2011/05/24 20:27:53]

This has a variety of failure modes.  Check the return value and act
appropriately: if it returns zero, PLOG something useful; if it returns >
MAX_PATH, short_app_path is too small.

[benwells, 2011/05/25 08:07:19]

See later...

+                     WriteInto(&short_app_path, MAX_PATH),
+                     MAX_PATH);
+
+    // open command for protocol associations
+    // Check in HKEY_CLASSES_ROOT that is the result of merge between
+    // HKLM and HKCU
+    HKEY root_key = HKEY_CLASSES_ROOT;
+    // Check <protocol>\shell\open\command
+    std::wstring key_path(wprotocol + ShellUtil::kRegShellOpen);
+    base::win::RegKey key(root_key, key_path.c_str(), KEY_READ);
+    std::wstring value;
+    if (!key.Valid() || (key.ReadValue(L"", &value) != ERROR_SUCCESS))
+      return NOT_DEFAULT_WEB_CLIENT;
+    // Need to normalize path in case it's been munged.
+    CommandLine command_line = CommandLine::FromString(value);
+    std::wstring short_path;
+    GetShortPathName(command_line.GetProgram().value().c_str(),

[grt (UTC plus 2), 2011/05/24 20:27:53]

Same comment as above.

[benwells, 2011/05/25 08:07:19]

See later ...

+                     WriteInto(&short_path, MAX_PATH), MAX_PATH);
+    if (!FilePath::CompareEqualIgnoreCase(short_path, short_app_path))

[grt (UTC plus 2), 2011/05/24 20:27:53]

Ah, I see now that this code is using string comparisons to determine if two
paths indicate the same file.  chrome/installer/setup_util.cc has code that does
a simple string compare (without bothering to shorten the names) followed by, in
essence, checking the inode number.  Consider switching to that, as my hunch is
that it's less error prone and less overhead than getting the short names of the
two paths.

[benwells, 2011/05/25 08:07:19]

The ProgramCompare looks very useful here but when I try to use it
chrome_browser won't link. I have added http://crbug.com/83852 to address this
issue (which also exists for checking IsDefaultBrowser) after
registerProtocolHandler is in.

[grt (UTC plus 2), 2011/05/25 14:35:45]

If you choose to defer using the same mechanism as ProgramCompare, you must
check the return value of the calls to GetShortPathName above.  Otherwise,
short_path and short_app_path could contain random memory (possibly unterminated
strings).

[benwells, 2011/05/26 00:23:04]

Done (and same change was made in IsDefaultBrowser).

+      return NOT_DEFAULT_WEB_CLIENT;
+  }
+  return IS_DEFAULT_WEB_CLIENT;
 }
 
 // There is no reliable way to say which browser is default on a machine (each
 // browser can have some of the protocols/shortcuts). So we look for only HTTP
 // protocol handler. Even this handler is located at different places in
 // registry on XP and Vista:
 // - HKCR\http\shell\open\command (XP)
 // - HKCU\Software\Microsoft\Windows\Shell\Associations\UrlAssociations\
 //   http\UserChoice (Vista)
 // This method checks if Firefox is defualt browser by checking these
@@ skipping 41 matching lines @@
                   profile_path);
 }
 
 void ShellIntegration::MigrateChromiumShortcuts() {
   if (base::win::GetVersion() < base::win::VERSION_WIN7)
     return;
 
   BrowserThread::PostTask(
       BrowserThread::FILE, FROM_HERE, new MigrateChromiumShortcutsTask());
 }