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.
5 #ifndef CHROME_INSTALLER_UTIL_INSTALLATION_STATE_H_
6 #define CHROME_INSTALLER_UTIL_INSTALLATION_STATE_H_
10 #include "base/basictypes.h"
11 #include "base/command_line.h"
12 #include "base/files/file_path.h"
13 #include "base/memory/scoped_ptr.h"
14 #include "chrome/installer/util/app_commands.h"
15 #include "chrome/installer/util/browser_distribution.h"
16 #include "chrome/installer/util/channel_info.h"
27 class InstallationState
;
29 // A representation of a product's state on the machine based on the contents
30 // of the Windows registry.
31 // TODO(grt): Pull this out into its own file.
36 // Returns true if the product is installed (i.e., the product's Clients key
37 // exists and has a "pv" value); false otherwise.
38 bool Initialize(bool system_install
,
39 BrowserDistribution::Type type
);
40 bool Initialize(bool system_install
,
41 BrowserDistribution
* distribution
);
43 // Returns the product's channel info (i.e., the Google Update "ap" value).
44 const ChannelInfo
& channel() const { return channel_
; }
46 // Returns the path to the product's "setup.exe"; may be empty.
47 base::FilePath
GetSetupPath() const;
49 // Returns the product's version. This method may only be called on an
50 // instance that has been initialized for an installed product.
51 const base::Version
& version() const;
53 // Returns the current version of the product if a new version is awaiting
54 // update; may be NULL. Ownership of a returned value is not passed to the
56 const base::Version
* old_version() const { return old_version_
.get(); }
58 // Returns the brand code the product is currently installed with.
59 const std::wstring
& brand() const { return brand_
; }
61 // Returns the command to be used to update to the new version that is
62 // awaiting update; may be empty.
63 const std::wstring
& rename_cmd() const { return rename_cmd_
; }
65 // Returns true and populates |eula_accepted| if the product has such a value;
66 // otherwise, returns false and does not modify |eula_accepted|. Expected
67 // values are 0 (false) and 1 (true), although |eula_accepted| is given
69 bool GetEulaAccepted(DWORD
* eula_accepted
) const;
71 // Returns true and populates |oem_install| if the product has such a value;
72 // otherwise, returns false and does not modify |oem_install|. Expected
73 // value is "1", although |oem_install| is given whatever is found.
74 bool GetOemInstall(std::wstring
* oem_install
) const;
76 // Returns true and populates |usagestats| if the product has such a value;
77 // otherwise, returns false and does not modify |usagestats|. Expected values
78 // are 0 (false) and 1 (true), although |usagestats| is given whatever is
80 bool GetUsageStats(DWORD
* usagestats
) const;
82 // True if the "msi" value in the ClientState key is present and non-zero.
83 bool is_msi() const { return msi_
; }
85 // The command to uninstall the product; may be empty.
86 const base::CommandLine
& uninstall_command() const {
87 return uninstall_command_
;
90 // True if |uninstall_command| contains --multi-install.
91 bool is_multi_install() const { return multi_install_
; }
93 // Returns the set of Google Update commands.
94 const AppCommands
& commands() const { return commands_
; }
96 // Returns this object a la operator=().
97 ProductState
& CopyFrom(const ProductState
& other
);
99 // Clears the state of this object.
103 static bool InitializeCommands(const base::win::RegKey
& version_key
,
104 AppCommands
* commands
);
106 ChannelInfo channel_
;
107 scoped_ptr
<Version
> version_
;
108 scoped_ptr
<Version
> old_version_
;
110 std::wstring rename_cmd_
;
111 std::wstring oem_install_
;
112 base::CommandLine uninstall_command_
;
113 AppCommands commands_
;
114 DWORD eula_accepted_
;
117 bool multi_install_
: 1;
118 bool has_eula_accepted_
: 1;
119 bool has_oem_install_
: 1;
120 bool has_usagestats_
: 1;
123 friend class InstallationState
;
125 DISALLOW_COPY_AND_ASSIGN(ProductState
);
126 }; // class ProductState
128 // Encapsulates the state of all products on the system.
129 // TODO(grt): Rename this to MachineState and put it in its own file.
130 class InstallationState
{
134 // Initializes this object with the machine's current state.
137 // Returns the state of a product or NULL if not installed.
138 // Caller does NOT assume ownership of returned pointer.
139 const ProductState
* GetProductState(bool system_install
,
140 BrowserDistribution::Type type
) const;
142 // Returns the state of a product, even one that has not yet been installed.
143 // This is useful during first install, when some but not all ProductState
144 // information has been written by Omaha. Notably absent from the
145 // ProductState returned here are the version numbers. Do NOT try to access
146 // the version numbers from a ProductState returned by this method.
147 // Caller does NOT assume ownership of returned pointer. This method will
148 // never return NULL.
149 const ProductState
* GetNonVersionedProductState(
150 bool system_install
, BrowserDistribution::Type type
) const;
154 CHROME_BROWSER_INDEX
,
156 CHROME_BINARIES_INDEX
,
160 static int IndexFromDistType(BrowserDistribution::Type type
);
162 ProductState user_products_
[NUM_PRODUCTS
];
163 ProductState system_products_
[NUM_PRODUCTS
];
166 DISALLOW_COPY_AND_ASSIGN(InstallationState
);
167 }; // class InstallationState
169 } // namespace installer
171 #endif // CHROME_INSTALLER_UTIL_INSTALLATION_STATE_H_