util_constants.h revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9
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// Defines all install related constants that need to be used by Chrome as 6// well as Chrome Installer. 7 8#ifndef CHROME_INSTALLER_UTIL_UTIL_CONSTANTS_H_ 9#define CHROME_INSTALLER_UTIL_UTIL_CONSTANTS_H_ 10 11#include "base/basictypes.h" 12 13namespace installer { 14 15// Return status of installer 16enum InstallStatus { 17 FIRST_INSTALL_SUCCESS, // 0. Successfully installed Chrome for the first time 18 INSTALL_REPAIRED, // 1. Same version reinstalled for repair 19 NEW_VERSION_UPDATED, // 2. Chrome successfully updated to new version 20 EXISTING_VERSION_LAUNCHED, // 3. No work done, just launched existing chrome 21 HIGHER_VERSION_EXISTS, // 4. Higher version of Chrome already exists 22 USER_LEVEL_INSTALL_EXISTS, // 5. User level install already exists 23 SYSTEM_LEVEL_INSTALL_EXISTS, // 6. Machine level install already exists 24 INSTALL_FAILED, // 7. Install/update failed 25 SETUP_PATCH_FAILED, // 8. Failed to patch setup.exe 26 OS_NOT_SUPPORTED, // 9. Current OS not supported 27 OS_ERROR, // 10. OS API call failed 28 TEMP_DIR_FAILED, // 11. Unable to get Temp directory 29 UNCOMPRESSION_FAILED, // 12. Failed to uncompress Chrome archive 30 INVALID_ARCHIVE, // 13. Something wrong with the installer archive 31 INSUFFICIENT_RIGHTS, // 14. User trying system level install is not Admin 32 CHROME_NOT_INSTALLED, // 15. Chrome not installed (returned in case of 33 // uninstall) 34 CHROME_RUNNING, // 16. Chrome currently running (when trying to 35 // uninstall) 36 UNINSTALL_CONFIRMED, // 17. User has confirmed Chrome uninstall 37 UNINSTALL_DELETE_PROFILE, // 18. User okayed uninstall and profile deletion. 38 UNINSTALL_SUCCESSFUL, // 19. Chrome successfully uninstalled 39 UNINSTALL_FAILED, // 20. Chrome uninstallation failed 40 UNINSTALL_CANCELLED, // 21. User cancelled Chrome uninstallation 41 UNKNOWN_STATUS, // 22. Unknown status (this should never happen) 42 RENAME_SUCCESSFUL, // 23. Rename of new_chrome.exe to chrome.exe worked 43 RENAME_FAILED, // 24. Rename of new_chrome.exe failed 44 EULA_REJECTED, // 25. EULA dialog was not accepted by user. 45 EULA_ACCEPTED, // 26. EULA dialog was accepted by user. 46 EULA_ACCEPTED_OPT_IN, // 27. EULA accepted with the crash option selected. 47 INSTALL_DIR_IN_USE, // 28. Installation directory is in use by another 48 // process 49 UNINSTALL_REQUIRES_REBOOT, // 29. Uninstallation required a reboot. 50 IN_USE_UPDATED, // 30. Chrome successfully updated but old version 51 // running 52 SAME_VERSION_REPAIR_FAILED, // 31. Chrome repair failed as Chrome was running 53 REENTRY_SYS_UPDATE, // 32. Setup has been re-launched as the interactive 54 // user 55 SXS_OPTION_NOT_SUPPORTED, // 33. The chrome-sxs option provided does not work 56 // with other command line options. 57 NON_MULTI_INSTALLATION_EXISTS, // 34. We tried to do a multi-install but 58 // failed because there's an existing 59 // installation of the same product on the 60 // system, but in 'single' mode. 61 MULTI_INSTALLATION_EXISTS, // 35. We tried to do a 'single' install but 62 // failed because there's an existing 63 // multi-install installation of the same product 64 // on the system. 65 READY_MODE_OPT_IN_FAILED, // 36. Failed to opt-into Chrome Frame. 66 READY_MODE_TEMP_OPT_OUT_FAILED, // 37. Failed to temporarily opt-out of 67 // Chrome Frame. 68 READY_MODE_END_TEMP_OPT_OUT_FAILED, // 38. Failed to end temporary opt-out 69 // of Chrome Frame. 70 CONFLICTING_CHANNEL_EXISTS, // 39. A multi-install product on a different 71 // update channel exists. 72 READY_MODE_REQUIRES_CHROME, // 40. Chrome Frame in ready-mode requires Chrome 73 APP_HOST_REQUIRES_MULTI_INSTALL, // 41. --multi-install was missing from the 74 // command line. 75 APPLY_DIFF_PATCH_FAILED, // 42. Failed to apply a diff patch. 76 INCONSISTENT_UPDATE_POLICY, // 43. Inconsistent update policy GP settings. 77 APP_HOST_REQUIRES_USER_LEVEL, // 44. --system-level is forbidden. 78 APP_HOST_REQUIRES_BINARIES, // 45. No Chrome binaries at either level. 79 INSTALL_OF_GOOGLE_UPDATE_FAILED, // 46. Failed to install Google Update. 80 INVALID_STATE_FOR_OPTION, // 47. A non-install option was called with an 81 // invalid installer state. 82 WAIT_FOR_EXISTING_FAILED, // 48. OS error waiting for existing setup.exe. 83 PATCH_INVALID_ARGUMENTS, // 49. The arguments of --patch were missing or 84 // they were invalid for any reason. 85 DIFF_PATCH_SOURCE_MISSING, // 50. No previous version archive found for 86 // differential update. 87 UNUSED_BINARIES, // 51. No multi-install products to update. The 88 // binaries will be uninstalled if they are not 89 // in use. 90 UNUSED_BINARIES_UNINSTALLED, // 52. The binaries were uninstalled. 91 UNSUPPORTED_OPTION, // 53. An unsupported legacy option was given. 92 CPU_NOT_SUPPORTED, // 54. Current OS not supported 93 // Friendly reminder: note the COMPILE_ASSERT below. 94}; 95 96 97// Existing InstallStatus values must not change. Always add to the end. 98COMPILE_ASSERT(installer::CPU_NOT_SUPPORTED == 54, 99 dont_change_enum); 100 101// The type of an update archive. 102enum ArchiveType { 103 UNKNOWN_ARCHIVE_TYPE, // Unknown or uninitialized. 104 FULL_ARCHIVE_TYPE, // Full chrome.7z archive. 105 INCREMENTAL_ARCHIVE_TYPE // Incremental or differential archive. 106}; 107 108// Stages of an installation reported through Google Update on failure. 109// The order and value of existing enums must not change. Please add new 110// values to the end (before NUM_STAGES) and update the compile assert below 111// to assert on the last value added. 112enum InstallerStage { 113 NO_STAGE, // 0: No stage to report. 114 PRECONDITIONS, // 1: Evaluating pre-install conditions. 115 UNCOMPRESSING, // 2: Uncompressing chrome.packed.7z. 116 ENSEMBLE_PATCHING, // 3: Patching chrome.7z using courgette. 117 BINARY_PATCHING, // 4: Patching chrome.7z using bspatch. 118 UNPACKING, // 5: Unpacking chrome.7z. 119 BUILDING, // 6: Building the install work item list. 120 EXECUTING, // 7: Executing the install work item list. 121 ROLLINGBACK, // 8: Rolling-back the install work item list. 122 REFRESHING_POLICY, // 9: Refreshing the elevation policy. 123 UPDATING_CHANNELS, // 10: Updating channel information. 124 COPYING_PREFERENCES_FILE, // 11: Copying preferences file. 125 CREATING_SHORTCUTS, // 12: Creating shortcuts. 126 REGISTERING_CHROME, // 13: Performing Chrome registration. 127 REMOVING_OLD_VERSIONS, // 14: Deleting old version directories. 128 FINISHING, // 15: Finishing the install. 129 CONFIGURE_AUTO_LAUNCH, // 16: Configuring Chrome to auto-launch. 130 CREATING_VISUAL_MANIFEST, // 17: Creating VisualElementsManifest.xml 131 DEFERRING_TO_HIGHER_VERSION, // 18: Deferring to an installed higher version. 132 UNINSTALLING_BINARIES, // 19: Uninstalling unused binaries. 133 UNINSTALLING_CHROME_FRAME, // 20: Uninstalling multi-install Chrome Frame. 134 NUM_STAGES // 21: The number of stages. 135}; 136 137// When we start reporting the numerical values from the enum, the order 138// above MUST be preserved. 139COMPILE_ASSERT(UNINSTALLING_CHROME_FRAME == 20, 140 never_ever_ever_change_InstallerStage_values_bang); 141 142namespace switches { 143 144extern const char kAutoLaunchChrome[]; 145extern const char kChrome[]; 146extern const char kChromeAppHostDeprecated[]; // TODO(huangs): Remove by M27. 147extern const char kChromeAppLauncher[]; 148extern const char kChromeFrame[]; 149extern const char kChromeSxS[]; 150extern const char kConfigureUserSettings[]; 151extern const char kCriticalUpdateVersion[]; 152extern const char kDeleteProfile[]; 153extern const char kDisableLogging[]; 154extern const char kDoNotLaunchChrome[]; 155extern const char kDoNotRegisterForUpdateLaunch[]; 156extern const char kDoNotRemoveSharedItems[]; 157extern const char kEnableLogging[]; 158extern const char kEnsureGoogleUpdatePresent[]; 159extern const char kForceConfigureUserSettings[]; 160extern const char kForceUninstall[]; 161extern const char kInstallArchive[]; 162extern const char kInstallerData[]; 163extern const char kLogFile[]; 164extern const char kMakeChromeDefault[]; 165extern const char kMsi[]; 166extern const char kMultiInstall[]; 167extern const char kNewSetupExe[]; 168extern const char kOnOsUpgrade[]; 169extern const char kQueryEULAAcceptance[]; 170extern const char kRegisterChromeBrowser[]; 171extern const char kRegisterChromeBrowserSuffix[]; 172extern const char kRegisterDevChrome[]; 173extern const char kRegisterURLProtocol[]; 174extern const char kRenameChromeExe[]; 175extern const char kRemoveChromeRegistration[]; 176extern const char kRunAsAdmin[]; 177extern const char kSelfDestruct[]; 178extern const char kSystemLevel[]; 179extern const char kTriggerActiveSetup[]; 180extern const char kUninstall[]; 181extern const char kUpdateSetupExe[]; 182extern const char kUncompressedArchive[]; 183extern const char kVerboseLogging[]; 184extern const char kShowEula[]; 185extern const char kShowEulaForMetro[]; 186extern const char kInactiveUserToast[]; 187extern const char kSystemLevelToast[]; 188extern const char kExperimentGroup[]; 189extern const char kToastResultsKey[]; 190extern const char kPatch[]; 191extern const char kInputFile[]; 192extern const char kPatchFile[]; 193extern const char kOutputFile[]; 194 195} // namespace switches 196 197extern const wchar_t kActiveSetupExe[]; 198extern const wchar_t kChromeAppHostExe[]; 199extern const wchar_t kChromeDll[]; 200extern const wchar_t kChromeChildDll[]; 201extern const wchar_t kChromeExe[]; 202extern const wchar_t kChromeFrameDll[]; 203extern const wchar_t kChromeFrameHelperDll[]; 204extern const wchar_t kChromeFrameHelperExe[]; 205extern const wchar_t kChromeFrameHelperWndClass[]; 206extern const wchar_t kChromeLauncherExe[]; 207extern const wchar_t kChromeMetroDll[]; 208extern const wchar_t kChromeNewExe[]; 209extern const wchar_t kChromeOldExe[]; 210extern const wchar_t kCmdInstallApp[]; 211extern const wchar_t kCmdInstallExtension[]; 212extern const wchar_t kCmdOnOsUpgrade[]; 213extern const wchar_t kCmdQueryEULAAcceptance[]; 214extern const wchar_t kCmdQuickEnableApplicationHost[]; 215extern const wchar_t kCmdQuickEnableCf[]; 216extern const wchar_t kDelegateExecuteExe[]; 217extern const wchar_t kEULASentinelFile[]; 218extern const wchar_t kGoogleChromeInstallSubDir1[]; 219extern const wchar_t kGoogleChromeInstallSubDir2[]; 220extern const wchar_t kInstallBinaryDir[]; 221extern const wchar_t kInstallerDir[]; 222extern const wchar_t kInstallTempDir[]; 223extern const wchar_t kInstallUserDataDir[]; 224extern const wchar_t kLnkExt[]; 225extern const wchar_t kNaClExe[]; 226extern const wchar_t kSetupExe[]; 227extern const wchar_t kSxSSuffix[]; 228extern const wchar_t kUninstallArgumentsField[]; 229extern const wchar_t kUninstallDisplayNameField[]; 230extern const wchar_t kUninstallInstallationDate[]; 231extern const char kUninstallMetricsName[]; 232extern const wchar_t kUninstallStringField[]; 233 234// Google Update installer result API 235extern const wchar_t kInstallerError[]; 236extern const wchar_t kInstallerExtraCode1[]; 237extern const wchar_t kInstallerResult[]; 238extern const wchar_t kInstallerResultUIString[]; 239extern const wchar_t kInstallerSuccessLaunchCmdLine[]; 240 241// Product options. 242extern const wchar_t kOptionMultiInstall[]; 243 244// Chrome channel display names. 245// NOTE: Canary is not strictly a 'channel', but rather a separate product 246// installed side-by-side. However, GoogleUpdateSettings::GetChromeChannel 247// will return "canary" for that product. 248extern const wchar_t kChromeChannelUnknown[]; 249extern const wchar_t kChromeChannelCanary[]; 250extern const wchar_t kChromeChannelDev[]; 251extern const wchar_t kChromeChannelBeta[]; 252extern const wchar_t kChromeChannelStable[]; 253 254extern const size_t kMaxAppModelIdLength; 255 256// The range of error values for the installer, Courgette, and bsdiff is 257// overlapping. These offset values disambiguate between different sets 258// of errors by shifting the values up with the specified offset. 259const int kCourgetteErrorOffset = 300; 260const int kBsdiffErrorOffset = 600; 261 262// Arguments to --patch switch 263extern const char kCourgette[]; 264extern const char kBsdiff[]; 265 266} // namespace installer 267 268#endif // CHROME_INSTALLER_UTIL_UTIL_CONSTANTS_H_ 269