Allow two user level installs of Chrome to have default browser settings.

chrome/installer/util/shell_util.h

-// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
+// Copyright (c) 2009 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.
 //
 // This file declares methods that are useful for integrating Chrome in
 // Windows shell. These methods are all static and currently part of
 // ShellUtil class.
 
-#ifndef CHROME_INSTALLER_UTIL_SHELL_UTIL_H__
-#define CHROME_INSTALLER_UTIL_SHELL_UTIL_H__
+#ifndef CHROME_INSTALLER_UTIL_SHELL_UTIL_H_
+#define CHROME_INSTALLER_UTIL_SHELL_UTIL_H_
 
 #include <windows.h>
 #include <string>
 
 #include "base/basictypes.h"
 #include "chrome/installer/util/work_item_list.h"
 
 // This is a utility class that provides common shell integration methods
 // that can be used by installer as well as Chrome.
 class ShellUtil {
  public:
   // Input to any methods that make changes to OS shell.
   enum ShellChange {
     CURRENT_USER = 0x1,  // Make any shell changes only at the user level
     SYSTEM_LEVEL = 0x2   // Make any shell changes only at the system level
   };
 
-  // Return value of AddChromeToSetAccessDefaults.
-  enum RegisterStatus {
-    SUCCESS,             // Registration of Chrome successful (in HKLM)
-    FAILURE,             // Registration failed (no changes made)
-    REGISTERED_PER_USER  // Registered Chrome as per user (in HKCU)
-  };
-
   // Relative path of DefaultIcon registry entry (prefixed with '\').
   static const wchar_t* kRegDefaultIcon;
 
   // Relative path of "shell" registry key.
   static const wchar_t* kRegShellPath;
 
   // Relative path of shell open command in Windows registry
   // (i.e. \\shell\\open\\command).
   static const wchar_t* kRegShellOpen;
 
@@ skipping 10 matching lines @@
   static const wchar_t* kRegRegisteredApplications;
 
   // The key path and key name required to register Chrome on Windows such
   // that it can be launched from Start->Run just by name (chrome.exe).
   static const wchar_t* kAppPathsRegistryKey;
   static const wchar_t* kAppPathsRegistryPathName;
 
   // Name that we give to Chrome file association handler ProgId.
   static const wchar_t* kChromeHTMLProgId;
 
-  // Description of Chrome file/URL association handler ProgId.
+  // Description of Chrome file association handler ProgId.
   static const wchar_t* kChromeHTMLProgIdDesc;
 
   // Registry path that stores url associations on Vista.
   static const wchar_t* kRegVistaUrlPrefs;
 
   // File extensions that Chrome registers itself for.
   static const wchar_t* kFileAssociations[];
 
   // Protocols that Chrome registers itself for.
   static const wchar_t* kProtocolAssociations[];
 
   // Registry value name that is needed for ChromeHTML ProgId
   static const wchar_t* kRegUrlProtocol;
 
   // Name that we give to Chrome extension file association handler ProgId.
   static const wchar_t* kChromeExtProgId;
 
   // Description of Chrome file/URL association handler ProgId.
   static const wchar_t* kChromeExtProgIdDesc;
 
-  // This method adds Chrome to the list that shows up in Add/Remove Programs->
-  // Set Program Access and Defaults and also creates Chrome ProgIds under
-  // Software\Classes. This method requires write access to HKLM so is just
-  // best effort deal. If write to HKLM fails and skip_if_not_admin is false,
-  // this method will:
-  // - add the ProgId entries to HKCU on XP. HKCU entries will not make
-  //   Chrome show in Set Program Access and Defaults but they are still useful
-  //   because we can make Chrome run when user clicks on http link or html
-  //   file.
-  // - will try to launch setup.exe with admin priviledges on Vista to do
-  //   these tasks. Users will see standard Vista elevation prompt and if they
-  //   enter the right credentials, the write operation will work.
-  // Currently skip_if_not_admin is false only when user tries to make Chrome
-  // default browser and Chrome is not registered on the machine.
-  //
-  // chrome_exe: full path to chrome.exe.
-  // skip_if_not_admin: if false will make this method try alternate methods
-  //                    as described above.
-  static RegisterStatus AddChromeToSetAccessDefaults(
-      const std::wstring& chrome_exe, bool skip_if_not_admin);
-
   // Checks if we need Admin rights for registry cleanup by checking if any
   // entry exists in HKLM.
   static bool AdminNeededForRegistryCleanup();
 
   // Create Chrome shortcut on Desktop
   // If shell_change is CURRENT_USER, the shortcut is created in the
   // Desktop folder of current user's profile.
   // If shell_change is SYSTEM_LEVEL, the shortcut is created in the
   // Desktop folder of "All Users" profile.
   // If alternate is true, an alternate text for the shortcut is used.
@@ skipping 13 matching lines @@
   // system.
   // create_new: If false, will only update the shortcut. If true, the function
   //             will create a new shortcut if it doesn't exist already.
   static bool CreateChromeQuickLaunchShortcut(const std::wstring& chrome_exe,
                                               int shell_change,
                                               bool create_new);
 
   // This method appends the Chrome icon index inside chrome.exe to the
   // chrome.exe path passed in as input, to generate the full path for
   // Chrome icon that can be used as value for Windows registry keys.
-  // chrome_icon: full path to chrome.exe.
-  static bool GetChromeIcon(std::wstring& chrome_icon);
+  // |chrome_exe| full path to chrome.exe.
+  static std::wstring GetChromeIcon(const std::wstring& chrome_exe);
 
   // This method returns the command to open URLs/files using chrome. Typically
   // this command is written to the registry under shell\open\command key.
   // chrome_exe: the full path to chrome.exe
   static std::wstring GetChromeShellOpenCmd(const std::wstring& chrome_exe);
 
   // This method returns the command to open .crx files using chrome in order
   // to install them as extensions. Similar to above method.
   static std::wstring GetChromeInstallExtensionCmd(
       const std::wstring& chrome_exe);
 
   // Returns the localized name of Chrome shortcut. If |alternate| is true
   // it returns a second localized text that is better suited for certain
   // scenarios.
   static bool GetChromeShortcutName(std::wstring* shortcut, bool alternate);
 
   // Gets the desktop path for the current user or all users (if system_level
   // is true) and returns it in 'path' argument. Return true if successful,
   // otherwise returns false.
   static bool GetDesktopPath(bool system_level, std::wstring* path);
 
   // Gets the Quick Launch shortcuts path for the current user and
   // returns it in 'path' argument. Return true if successful, otherwise
   // returns false. If system_level is true this function returns the path
   // to Default Users Quick Launch shortcuts path. Adding a shortcut to Default
   // User's profile only affects any new user profiles (not existing ones).
   static bool GetQuickLaunchPath(bool system_level, std::wstring* path);
 
-  // Make Chrome default browser. Before calling this function Chrome should
-  // already have been registered by calling AddChromeToSetAccessDefaults()
-  // method, otherwise this function will fail.
+  // This function gets a suffix (user's login name) that can be added
+  // to Chromium default browser entry in the registry to create a unique name
+  // if there are multiple users on the machine, each with their own copy of
+  // Chromium that they want to set as default browser.
+  // This suffix value is assigned to |entry|.
+  static bool GetUserSpecificDefaultBrowserSuffix(std::wstring* entry);
+
+  // Make Chrome default browser.
   // shell_change: Defined whether to register as default browser at system
   //               level or user level. If value has ShellChange::SYSTEM_LEVEL
-  //               we should be running as admin user. Currently this setting
-  //               does not have any effect on Vista where we always set
-  //               as default only for the current user.
+  //               we should be running as admin user.
   // chrome_exe: The chrome.exe path to register as default browser.
+  // elevate_if_not_admin: On Vista if user is not admin, try to elevate for
+  //                       Chrome registration.
   static bool MakeChromeDefault(int shell_change,
-                                const std::wstring& chrome_exe);
+                                const std::wstring& chrome_exe,
+                                bool elevate_if_not_admin);
+
+  // This method adds Chrome to the list that shows up in Add/Remove Programs->
+  // Set Program Access and Defaults and also creates Chrome ProgIds under
+  // Software\Classes. This method requires write access to HKLM so is just
+  // best effort deal. If write to HKLM fails and elevate_if_not_admin is true,
+  // this method will:
+  // - add the ProgId entries to HKCU on XP. HKCU entries will not make
+  //   Chrome show in Set Program Access and Defaults but they are still useful
+  //   because we can make Chrome run when user clicks on http link or html
+  //   file.
+  // - will try to launch setup.exe with admin priviledges on Vista to do
+  //   these tasks. Users will see standard Vista elevation prompt and if they
+  //   enter the right credentials, the write operation will work.
+  // Currently elevate_if_not_admin is true only when user tries to make Chrome
+  // default browser (through the UI or through installer options) and Chrome
+  // is not registered on the machine.
+  //
+  // |chrome_exe| full path to chrome.exe.
+  // |unique_suffix| Optional input. If given, this function appends the value
+  // to default browser entries names that it creates in the registry.
+  // |elevate_if_not_admin| if true will make this method try alternate methods
+  // as described above.
+  static bool RegisterChromeBrowser(const std::wstring& chrome_exe,
+                                    const std::wstring& unique_suffix,
+                                    bool elevate_if_not_admin);
 
   // Remove Chrome shortcut from Desktop.
   // If shell_change is CURRENT_USER, the shortcut is removed from the
   // Desktop folder of current user's profile.
   // If shell_change is SYSTEM_LEVEL, the shortcut is removed from the
   // Desktop folder of "All Users" profile.
   // If alternate is true, the shortcut with the alternate name is removed. See
   // CreateChromeDesktopShortcut() for more information.
   static bool RemoveChromeDesktopShortcut(int shell_change, bool alternate);
 
   // Remove Chrome shortcut from Quick Launch Bar.
   // If shell_change is CURRENT_USER, the shortcut is removed from
   // the Quick Launch folder of current user's profile.
   // If shell_change is SYSTEM_LEVEL, the shortcut is removed from
   // the Quick Launch folder of "Default User" profile.
   static bool RemoveChromeQuickLaunchShortcut(int shell_change);
 
   // Updates shortcut (or creates a new shortcut) at destination given by
   // shortcut to a target given by chrome_exe. The arguments is left NULL
   // for the target and icon is set as icon at index 0 from exe.
   // If create_new is set to true, the function will create a new shortcut if
   // if doesn't exist.
   static bool UpdateChromeShortcut(const std::wstring& chrome_exe,
                                    const std::wstring& shortcut,
                                    const std::wstring& description,
                                    bool create_new);
 
  private:
-  DISALLOW_EVIL_CONSTRUCTORS(ShellUtil);
+  DISALLOW_COPY_AND_ASSIGN(ShellUtil);
 };
 
 
-#endif  // CHROME_INSTALLER_UTIL_SHELL_UTIL_H__
+#endif  // CHROME_INSTALLER_UTIL_SHELL_UTIL_H_