chrome/installer/util/installer_state.h

   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 #ifndef CHROME_INSTALLER_UTIL_INSTALLER_STATE_H_
   6 #define CHROME_INSTALLER_UTIL_INSTALLER_STATE_H_
   7
   8 #include <set>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/basictypes.h"
  13 #include "base/files/file_path.h"
  14 #include "base/logging.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/memory/scoped_vector.h"
  17 #include "base/version.h"
  18 #include "chrome/installer/util/browser_distribution.h"
  19 #include "chrome/installer/util/product.h"
  20 #include "chrome/installer/util/util_constants.h"
  21
  22 #if defined(OS_WIN)
  23 #include <windows.h>  // NOLINT
  24 #endif
  25
  26 namespace base {
  27 class CommandLine;
  28 }
  29
  30 namespace installer {
  31
  32 class ChannelInfo;
  33 class InstallationState;
  34 class MasterPreferences;
  35
  36 class ProductState;
  37
  38 typedef std::vector<Product*> Products;
  39
  40 // Encapsulates the state of the current installation operation.  Only valid
  41 // for installs and upgrades (not for uninstalls or non-install commands).
  42 // This class interprets the command-line arguments and master preferences and
  43 // determines the operations to be performed. For example, the Chrome Binaries
  44 // are automatically added if required in multi-install mode.
  45 // TODO(erikwright): This is now used a fair bit during uninstall, and
  46 // InstallerState::Initialize() contains a lot of code for uninstall. The class
  47 // comment should probably be updated.
  48 // TODO(grt): Rename to InstallerEngine/Conductor or somesuch?
  49 class InstallerState {
  50  public:
  51   enum Level {
  52     UNKNOWN_LEVEL,
  53     USER_LEVEL,
  54     SYSTEM_LEVEL
  55   };
  56
  57   enum PackageType {
  58     UNKNOWN_PACKAGE_TYPE,
  59     SINGLE_PACKAGE,
  60     MULTI_PACKAGE
  61   };
  62
  63   enum Operation {
  64     UNINITIALIZED,
  65     SINGLE_INSTALL_OR_UPDATE,
  66     MULTI_INSTALL,
  67     MULTI_UPDATE,
  68     UNINSTALL
  69   };
  70
  71   // Constructs an uninitialized instance; see Initialize().
  72   InstallerState();
  73
  74   // Constructs an initialized but empty instance.
  75   explicit InstallerState(Level level);
  76
  77   ~InstallerState();
  78
  79   // Initializes this object based on the current operation.
  80   void Initialize(const base::CommandLine& command_line,
  81                   const MasterPreferences& prefs,
  82                   const InstallationState& machine_state);
  83
  84   // Adds a product constructed on the basis of |state|, setting this object's
  85   // msi flag if |state| is msi-installed.  Returns the product that was added,
  86   // or NULL if |state| is incompatible with this object.  Ownership is not
  87   // passed to the caller.
  88   Product* AddProductFromState(BrowserDistribution::Type type,
  89                                const ProductState& state);
  90
  91   // Returns the product that was added, or NULL if |product| is incompatible
  92   // with this object.  Ownership of |product| is taken by this object, while
  93   // ownership of the return value is not passed to the caller.
  94   Product* AddProduct(scoped_ptr<Product>* product);
  95
  96   // Removes |product| from the set of products to be operated on.  The object
  97   // pointed to by |product| is freed.  Returns false if |product| is not
  98   // present in the set.
  99   bool RemoveProduct(const Product* product);
 100
 101   // The level (user or system) of this operation.
 102   Level level() const { return level_; }
 103
 104   // The package type (single or multi) of this operation.
 105   PackageType package_type() const { return package_type_; }
 106
 107   // An identifier of this operation.
 108   Operation operation() const { return operation_; }
 109
 110   // A convenience method returning level() == SYSTEM_LEVEL.
 111   // TODO(grt): Eradicate the bool in favor of the enum.
 112   bool system_install() const;
 113
 114   // A convenience method returning package_type() == MULTI_PACKAGE.
 115   // TODO(grt): Eradicate the bool in favor of the enum.
 116   bool is_multi_install() const;
 117
 118   // The full path to the place where the operand resides.
 119   const base::FilePath& target_path() const { return target_path_; }
 120
 121   // True if the "msi" preference is set or if a product with the "msi" state
 122   // flag is set is to be operated on.
 123   bool is_msi() const { return msi_; }
 124
 125   // True if the --verbose-logging command-line flag is set or if the
 126   // verbose_logging master preferences option is true.
 127   bool verbose_logging() const { return verbose_logging_; }
 128
 129 #if defined(OS_WIN)
 130   HKEY root_key() const { return root_key_; }
 131 #endif
 132
 133   // The ClientState key by which we interact with Google Update.
 134   const std::wstring& state_key() const { return state_key_; }
 135
 136   // Convenience method to return the type of the BrowserDistribution associated
 137   // with the ClientState key we will be interacting with.
 138   BrowserDistribution::Type state_type() const { return state_type_; }
 139
 140   // Returns the BrowserDistribution instance corresponding to the binaries for
 141   // this run if we're operating on a multi-package product.
 142   BrowserDistribution* multi_package_binaries_distribution() const {
 143     DCHECK(package_type_ == MULTI_PACKAGE);
 144     DCHECK(multi_package_distribution_ != NULL);
 145     return multi_package_distribution_;
 146   }
 147
 148   const Products& products() const { return products_.get(); }
 149
 150   // Returns the product of the desired type, or NULL if none found.
 151   const Product* FindProduct(BrowserDistribution::Type distribution_type) const;
 152
 153   // Returns the currently installed version in |target_path|, or NULL if no
 154   // products are installed.  Ownership is passed to the caller.
 155   base::Version* GetCurrentVersion(
 156       const InstallationState& machine_state) const;
 157
 158   // Returns the critical update version if all of the following are true:
 159   // * --critical-update-version=CUV was specified on the command-line.
 160   // * current_version == NULL or current_version < CUV.
 161   // * new_version >= CUV.
 162   // Otherwise, returns an invalid version.
 163   base::Version DetermineCriticalVersion(
 164       const base::Version* current_version,
 165       const base::Version& new_version) const;
 166
 167   // Returns whether or not there is currently a Chrome Frame instance running.
 168   // Note that there isn't a mechanism to lock Chrome Frame in place, so Chrome
 169   // Frame may either exit or start up after this is called.
 170   bool IsChromeFrameRunning(const InstallationState& machine_state) const;
 171
 172   // Returns true if any of the binaries from a multi-install Chrome Frame that
 173   // has been migrated to single-install are still in use.
 174   bool AreBinariesInUse(const InstallationState& machine_state) const;
 175
 176   // Returns the path to the installer under Chrome version folder
 177   // (for example <target_path>\Google\Chrome\Application\<Version>\Installer)
 178   base::FilePath GetInstallerDirectory(const base::Version& version) const;
 179
 180   // Try to delete all directories under |temp_path| whose versions are less
 181   // than |new_version| and not equal to |existing_version|. |existing_version|
 182   // may be NULL.
 183   void RemoveOldVersionDirectories(const base::Version& new_version,
 184                                    base::Version* existing_version,
 185                                    const base::FilePath& temp_path) const;
 186
 187   // Adds to |com_dll_list| the list of COM DLLs that are to be registered
 188   // and/or unregistered. The list may be empty.
 189   void AddComDllList(std::vector<base::FilePath>* com_dll_list) const;
 190
 191   // See InstallUtil::UpdateInstallerStage.
 192   void UpdateStage(installer::InstallerStage stage) const;
 193
 194   // For a MULTI_INSTALL or MULTI_UPDATE operation, updates the Google Update
 195   // "ap" values for all products being operated on.
 196   void UpdateChannels() const;
 197
 198   // Sets installer result information in the registry for consumption by Google
 199   // Update.  The InstallerResult value is set to 0 (SUCCESS) or 1
 200   // (FAILED_CUSTOM_ERROR) depending on whether |status| maps to success or not.
 201   // |status| itself is written to the InstallerError value.
 202   // |string_resource_id|, if non-zero, identifies a localized string written to
 203   // the InstallerResultUIString value.  |launch_cmd|, if non-NULL and
 204   // non-empty, is written to the InstallerSuccessLaunchCmdLine value.
 205   void WriteInstallerResult(InstallStatus status,
 206                             int string_resource_id,
 207                             const std::wstring* launch_cmd) const;
 208
 209   // Returns true if this install needs to register an Active Setup command.
 210   bool RequiresActiveSetup() const;
 211
 212  protected:
 213   // Bits for the |file_bits| argument of AnyExistsAndIsInUse.
 214   enum {
 215     CHROME_DLL              = 1 << 0,
 216     CHROME_FRAME_DLL        = 1 << 1,
 217     CHROME_FRAME_HELPER_DLL = 1 << 2,
 218     CHROME_FRAME_HELPER_EXE = 1 << 3,
 219     NUM_BINARIES            = 4
 220   };
 221
 222   // Returns true if |file| exists and cannot be opened for exclusive write
 223   // access.
 224   static bool IsFileInUse(const base::FilePath& file);
 225
 226   // Clears the instance to an uninitialized state.
 227   void Clear();
 228
 229   // Returns true if any file corresponding to a bit in |file_bits| (from the
 230   // enum above) for the currently installed version exists and is in use.
 231   bool AnyExistsAndIsInUse(const InstallationState& machine_state,
 232                            uint32 file_bits) const;
 233   base::FilePath GetDefaultProductInstallPath(BrowserDistribution* dist) const;
 234   bool CanAddProduct(const Product& product,
 235                      const base::FilePath* product_dir) const;
 236   Product* AddProductInDirectory(const base::FilePath* product_dir,
 237                                  scoped_ptr<Product>* product);
 238   Product* AddProductFromPreferences(
 239       BrowserDistribution::Type distribution_type,
 240       const MasterPreferences& prefs,
 241       const InstallationState& machine_state);
 242   bool IsMultiInstallUpdate(const MasterPreferences& prefs,
 243                             const InstallationState& machine_state);
 244
 245   // Enumerates all files named one of
 246   // [chrome.exe, old_chrome.exe, new_chrome.exe] in target_path_ and
 247   // returns their version numbers in a set.
 248   void GetExistingExeVersions(std::set<std::string>* existing_versions) const;
 249
 250   // Sets this object's level and updates the root_key_ accordingly.
 251   void set_level(Level level);
 252
 253   // Sets this object's package type and updates the multi_package_distribution_
 254   // accordingly.
 255   void set_package_type(PackageType type);
 256
 257   Operation operation_;
 258   base::FilePath target_path_;
 259   std::wstring state_key_;
 260   BrowserDistribution::Type state_type_;
 261   ScopedVector<Product> products_;
 262   BrowserDistribution* multi_package_distribution_;
 263   base::Version critical_update_version_;
 264   Level level_;
 265   PackageType package_type_;
 266 #if defined(OS_WIN)
 267   HKEY root_key_;
 268 #endif
 269   bool msi_;
 270   bool verbose_logging_;
 271
 272  private:
 273   DISALLOW_COPY_AND_ASSIGN(InstallerState);
 274 };  // class InstallerState
 275
 276 }  // namespace installer
 277
 278 #endif  // CHROME_INSTALLER_UTIL_INSTALLER_STATE_H_