chrome/browser/extensions/extension_install_prompt.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_BROWSER_EXTENSIONS_EXTENSION_INSTALL_PROMPT_H_
   6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_INSTALL_PROMPT_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/callback.h"
  12 #include "base/compiler_specific.h"
  13 #include "base/files/file_path.h"
  14 #include "base/memory/ref_counted.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "base/strings/string16.h"
  18 #include "extensions/common/permissions/coalesced_permission_message.h"
  19 #include "extensions/common/url_pattern.h"
  20 #include "third_party/skia/include/core/SkBitmap.h"
  21 #include "ui/gfx/image/image.h"
  22 #include "ui/gfx/image/image_skia.h"
  23 #include "ui/gfx/native_widget_types.h"
  24
  25 class ExtensionInstallPromptShowParams;
  26 class Profile;
  27
  28 namespace base {
  29 class DictionaryValue;
  30 class MessageLoop;
  31 }  // namespace base
  32
  33 namespace content {
  34 class WebContents;
  35 }
  36
  37 namespace extensions {
  38 class BundleInstaller;
  39 class CrxInstallError;
  40 class Extension;
  41 class ExtensionInstallUI;
  42 class ExtensionWebstorePrivateApiTest;
  43 class MockGetAuthTokenFunction;
  44 class PermissionSet;
  45 }  // namespace extensions
  46
  47 namespace infobars {
  48 class InfoBarDelegate;
  49 }
  50
  51 // Displays all the UI around extension installation.
  52 class ExtensionInstallPrompt
  53     : public base::SupportsWeakPtr<ExtensionInstallPrompt> {
  54  public:
  55   // This enum is associated with Extensions.InstallPrompt_Type UMA histogram.
  56   // Do not modify existing values and add new values only to the end.
  57   enum PromptType {
  58     UNSET_PROMPT_TYPE = -1,
  59     INSTALL_PROMPT = 0,
  60     INLINE_INSTALL_PROMPT,
  61     BUNDLE_INSTALL_PROMPT,
  62     RE_ENABLE_PROMPT,
  63     PERMISSIONS_PROMPT,
  64     EXTERNAL_INSTALL_PROMPT,
  65     POST_INSTALL_PERMISSIONS_PROMPT,
  66     LAUNCH_PROMPT,
  67     REMOTE_INSTALL_PROMPT,
  68     REPAIR_PROMPT,
  69     DELEGATED_PERMISSIONS_PROMPT,
  70     DELEGATED_BUNDLE_PERMISSIONS_PROMPT,
  71     NUM_PROMPT_TYPES
  72   };
  73
  74   // The last prompt type to display; only used for testing.
  75   static PromptType g_last_prompt_type_for_tests;
  76
  77   // Enumeration for permissions and retained files details.
  78   enum DetailsType {
  79     PERMISSIONS_DETAILS = 0,
  80     WITHHELD_PERMISSIONS_DETAILS,
  81     RETAINED_FILES_DETAILS,
  82     RETAINED_DEVICES_DETAILS,
  83   };
  84
  85   // This enum is used to differentiate regular and withheld permissions for
  86   // segregation in the install prompt.
  87   enum PermissionsType {
  88     REGULAR_PERMISSIONS = 0,
  89     WITHHELD_PERMISSIONS,
  90     ALL_PERMISSIONS,
  91   };
  92
  93   static std::string PromptTypeToString(PromptType type);
  94
  95   // Extra information needed to display an installation or uninstallation
  96   // prompt. Gets populated with raw data and exposes getters for formatted
  97   // strings so that the GTK/views/Cocoa install dialogs don't have to repeat
  98   // that logic.
  99   // Ref-counted because we pass around the prompt independent of the full
 100   // ExtensionInstallPrompt.
 101   class Prompt : public base::RefCountedThreadSafe<Prompt> {
 102    public:
 103     explicit Prompt(PromptType type);
 104
 105     void SetPermissions(
 106         const extensions::CoalescedPermissionMessages& permissions,
 107         PermissionsType permissions_type);
 108     void SetIsShowingDetails(DetailsType type,
 109                              size_t index,
 110                              bool is_showing_details);
 111     void SetWebstoreData(const std::string& localized_user_count,
 112                          bool show_user_count,
 113                          double average_rating,
 114                          int rating_count);
 115
 116     PromptType type() const { return type_; }
 117     void set_type(PromptType type) { type_ = type; }
 118
 119     // Getters for UI element labels.
 120     base::string16 GetDialogTitle() const;
 121     int GetDialogButtons() const;
 122     // Returns the empty string when there should be no "accept" button.
 123     base::string16 GetAcceptButtonLabel() const;
 124     base::string16 GetAbortButtonLabel() const;
 125     base::string16 GetPermissionsHeading(
 126         PermissionsType permissions_type) const;
 127     base::string16 GetRetainedFilesHeading() const;
 128     base::string16 GetRetainedDevicesHeading() const;
 129
 130     bool ShouldShowPermissions() const;
 131
 132     // Getters for webstore metadata. Only populated when the type is
 133     // INLINE_INSTALL_PROMPT, EXTERNAL_INSTALL_PROMPT, or REPAIR_PROMPT.
 134
 135     // The star display logic replicates the one used by the webstore (from
 136     // components.ratingutils.setFractionalYellowStars). Callers pass in an
 137     // "appender", which will be repeatedly called back with the star images
 138     // that they append to the star display area.
 139     typedef void(*StarAppender)(const gfx::ImageSkia*, void*);
 140     void AppendRatingStars(StarAppender appender, void* data) const;
 141     base::string16 GetRatingCount() const;
 142     base::string16 GetUserCount() const;
 143     size_t GetPermissionCount(PermissionsType permissions_type) const;
 144     size_t GetPermissionsDetailsCount(PermissionsType permissions_type) const;
 145     base::string16 GetPermission(size_t index,
 146                                  PermissionsType permissions_type) const;
 147     base::string16 GetPermissionsDetails(
 148         size_t index,
 149         PermissionsType permissions_type) const;
 150     bool GetIsShowingDetails(DetailsType type, size_t index) const;
 151     size_t GetRetainedFileCount() const;
 152     base::string16 GetRetainedFile(size_t index) const;
 153     size_t GetRetainedDeviceCount() const;
 154     base::string16 GetRetainedDeviceMessageString(size_t index) const;
 155
 156     // Populated for BUNDLE_INSTALL_PROMPT and
 157     // DELEGATED_BUNDLE_PERMISSIONS_PROMPT.
 158     const extensions::BundleInstaller* bundle() const { return bundle_; }
 159     void set_bundle(const extensions::BundleInstaller* bundle) {
 160       bundle_ = bundle;
 161     }
 162
 163     // Populated for all other types.
 164     const extensions::Extension* extension() const { return extension_; }
 165     void set_extension(const extensions::Extension* extension) {
 166       extension_ = extension;
 167     }
 168
 169     // May be populated for POST_INSTALL_PERMISSIONS_PROMPT.
 170     void set_retained_files(const std::vector<base::FilePath>& retained_files) {
 171       retained_files_ = retained_files;
 172     }
 173     void set_retained_device_messages(
 174         const std::vector<base::string16>& retained_device_messages) {
 175       retained_device_messages_ = retained_device_messages;
 176     }
 177
 178     const std::string& delegated_username() const {
 179       return delegated_username_;
 180     }
 181     void set_delegated_username(const std::string& delegated_username) {
 182       delegated_username_ = delegated_username;
 183     }
 184
 185     const gfx::Image& icon() const { return icon_; }
 186     void set_icon(const gfx::Image& icon) { icon_ = icon; }
 187
 188     bool has_webstore_data() const { return has_webstore_data_; }
 189
 190    private:
 191     friend class base::RefCountedThreadSafe<Prompt>;
 192
 193     struct InstallPromptPermissions {
 194       InstallPromptPermissions();
 195       ~InstallPromptPermissions();
 196
 197       std::vector<base::string16> permissions;
 198       std::vector<base::string16> details;
 199       std::vector<bool> is_showing_details;
 200     };
 201
 202     virtual ~Prompt();
 203
 204     bool ShouldDisplayRevokeButton() const;
 205
 206     // Returns the InstallPromptPermissions corresponding to
 207     // |permissions_type|.
 208     InstallPromptPermissions& GetPermissionsForType(
 209         PermissionsType permissions_type);
 210     const InstallPromptPermissions& GetPermissionsForType(
 211         PermissionsType permissions_type) const;
 212
 213     bool ShouldDisplayRevokeFilesButton() const;
 214
 215     PromptType type_;
 216
 217     // Permissions that are being requested (may not be all of an extension's
 218     // permissions if only additional ones are being requested)
 219     InstallPromptPermissions prompt_permissions_;
 220     // Permissions that will be withheld upon install.
 221     InstallPromptPermissions withheld_prompt_permissions_;
 222
 223     bool is_showing_details_for_retained_files_;
 224     bool is_showing_details_for_retained_devices_;
 225
 226     // The extension or bundle being installed.
 227     const extensions::Extension* extension_;
 228     const extensions::BundleInstaller* bundle_;
 229
 230     std::string delegated_username_;
 231
 232     // The icon to be displayed.
 233     gfx::Image icon_;
 234
 235     // These fields are populated only when the prompt type is
 236     // INLINE_INSTALL_PROMPT
 237     // Already formatted to be locale-specific.
 238     std::string localized_user_count_;
 239     // Range is kMinExtensionRating to kMaxExtensionRating
 240     double average_rating_;
 241     int rating_count_;
 242
 243     // Whether we should display the user count (we anticipate this will be
 244     // false if localized_user_count_ represents the number zero).
 245     bool show_user_count_;
 246
 247     // Whether or not this prompt has been populated with data from the
 248     // webstore.
 249     bool has_webstore_data_;
 250
 251     std::vector<base::FilePath> retained_files_;
 252     std::vector<base::string16> retained_device_messages_;
 253
 254     DISALLOW_COPY_AND_ASSIGN(Prompt);
 255   };
 256
 257   static const int kMinExtensionRating = 0;
 258   static const int kMaxExtensionRating = 5;
 259
 260   class Delegate {
 261    public:
 262     // We call this method to signal that the installation should continue.
 263     virtual void InstallUIProceed() = 0;
 264
 265     // We call this method to signal that the installation should stop, with
 266     // |user_initiated| true if the installation was stopped by the user.
 267     virtual void InstallUIAbort(bool user_initiated) = 0;
 268
 269    protected:
 270     virtual ~Delegate() {}
 271   };
 272
 273   typedef base::Callback<void(ExtensionInstallPromptShowParams*,
 274                               ExtensionInstallPrompt::Delegate*,
 275                               scoped_refptr<ExtensionInstallPrompt::Prompt>)>
 276       ShowDialogCallback;
 277
 278   // Callback to show the default extension install dialog.
 279   // The implementations of this function are platform-specific.
 280   static ShowDialogCallback GetDefaultShowDialogCallback();
 281
 282   // Creates a dummy extension from the |manifest|, replacing the name and
 283   // description with the localizations if provided.
 284   static scoped_refptr<extensions::Extension> GetLocalizedExtensionForDisplay(
 285       const base::DictionaryValue* manifest,
 286       int flags,  // Extension::InitFromValueFlags
 287       const std::string& id,
 288       const std::string& localized_name,
 289       const std::string& localized_description,
 290       std::string* error);
 291
 292   // Creates a prompt with a parent web content.
 293   explicit ExtensionInstallPrompt(content::WebContents* contents);
 294
 295   // Creates a prompt with a profile and a native window. The most recently
 296   // active browser window (or a new browser window if there are no browser
 297   // windows) is used if a new tab needs to be opened.
 298   ExtensionInstallPrompt(Profile* profile, gfx::NativeWindow native_window);
 299
 300   virtual ~ExtensionInstallPrompt();
 301
 302   extensions::ExtensionInstallUI* install_ui() const {
 303     return install_ui_.get();
 304   }
 305
 306   // This is called by the bundle installer to verify whether the bundle
 307   // should be installed.
 308   //
 309   // We *MUST* eventually call either Proceed() or Abort() on |bundle|.
 310   virtual void ConfirmBundleInstall(
 311       extensions::BundleInstaller* bundle,
 312       const SkBitmap* icon,
 313       const extensions::PermissionSet* permissions);
 314
 315   // This is called by the bundle installer to verify the permissions for a
 316   // delegated bundle install.
 317   //
 318   // We *MUST* eventually call either Proceed() or Abort() on |bundle|.
 319   virtual void ConfirmPermissionsForDelegatedBundleInstall(
 320       extensions::BundleInstaller* bundle,
 321       const std::string& delegated_username,
 322       const SkBitmap* icon,
 323       const extensions::PermissionSet* permissions);
 324
 325   // This is called by the standalone installer to verify whether the install
 326   // from the webstore should proceed.
 327   //
 328   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 329   virtual void ConfirmStandaloneInstall(Delegate* delegate,
 330                                         const extensions::Extension* extension,
 331                                         SkBitmap* icon,
 332                                         scoped_refptr<Prompt> prompt);
 333
 334   // This is called by the installer to verify whether the installation from
 335   // the webstore should proceed. |show_dialog_callback| is optional and can be
 336   // NULL.
 337   //
 338   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 339   virtual void ConfirmWebstoreInstall(
 340       Delegate* delegate,
 341       const extensions::Extension* extension,
 342       const SkBitmap* icon,
 343       const ShowDialogCallback& show_dialog_callback);
 344
 345   // This is called by the installer to verify whether the installation should
 346   // proceed. This is declared virtual for testing. |show_dialog_callback| is
 347   // optional and can be NULL.
 348   //
 349   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 350   virtual void ConfirmInstall(Delegate* delegate,
 351                               const extensions::Extension* extension,
 352                               const ShowDialogCallback& show_dialog_callback);
 353
 354   // This is called by the webstore API to verify the permissions for a
 355   // delegated install.
 356   //
 357   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 358   virtual void ConfirmPermissionsForDelegatedInstall(
 359       Delegate* delegate,
 360       const extensions::Extension* extension,
 361       const std::string& delegated_username,
 362       const SkBitmap* icon);
 363
 364   // This is called by the app handler launcher to verify whether the app
 365   // should be re-enabled. This is declared virtual for testing.
 366   //
 367   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 368   virtual void ConfirmReEnable(Delegate* delegate,
 369                                const extensions::Extension* extension);
 370
 371   // This is called by the external install alert UI to verify whether the
 372   // extension should be enabled (external extensions are installed disabled).
 373   //
 374   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 375   virtual void ConfirmExternalInstall(
 376       Delegate* delegate,
 377       const extensions::Extension* extension,
 378       const ShowDialogCallback& show_dialog_callback,
 379       scoped_refptr<Prompt> prompt);
 380
 381   // This is called by the extension permissions API to verify whether an
 382   // extension may be granted additional permissions.
 383   //
 384   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 385   virtual void ConfirmPermissions(Delegate* delegate,
 386                                   const extensions::Extension* extension,
 387                                   const extensions::PermissionSet* permissions);
 388
 389   // This is called by the app handler launcher to review what permissions the
 390   // extension or app currently has.
 391   //
 392   // We *MUST* eventually call either Proceed() or Abort() on |delegate|.
 393   virtual void ReviewPermissions(
 394       Delegate* delegate,
 395       const extensions::Extension* extension,
 396       const std::vector<base::FilePath>& retained_file_paths,
 397       const std::vector<base::string16>& retained_device_messages);
 398
 399   // Installation was successful. This is declared virtual for testing.
 400   virtual void OnInstallSuccess(const extensions::Extension* extension,
 401                                 SkBitmap* icon);
 402
 403   // Installation failed. This is declared virtual for testing.
 404   virtual void OnInstallFailure(const extensions::CrxInstallError& error);
 405
 406   void set_callback_for_test(const ShowDialogCallback& show_dialog_callback) {
 407     show_dialog_callback_ = show_dialog_callback;
 408   }
 409
 410  protected:
 411   friend class extensions::ExtensionWebstorePrivateApiTest;
 412   friend class WebstoreStartupInstallUnpackFailureTest;
 413
 414   // Whether or not we should record the oauth2 grant upon successful install.
 415   bool record_oauth2_grant_;
 416
 417  private:
 418   friend class GalleryInstallApiTestObserver;
 419
 420   // Sets the icon that will be used in any UI. If |icon| is NULL, or contains
 421   // an empty bitmap, then a default icon will be used instead.
 422   void SetIcon(const SkBitmap* icon);
 423
 424   // ImageLoader callback.
 425   void OnImageLoaded(const gfx::Image& image);
 426
 427   // Starts the process of showing a confirmation UI, which is split into two.
 428   // 1) Set off a 'load icon' task.
 429   // 2) Handle the load icon response and show the UI (OnImageLoaded).
 430   void LoadImageIfNeeded();
 431
 432   // Shows the actual UI (the icon should already be loaded).
 433   void ShowConfirmation();
 434
 435   Profile* profile_;
 436
 437   base::MessageLoop* ui_loop_;
 438
 439   // The extensions installation icon.
 440   SkBitmap icon_;
 441
 442   // The extension we are showing the UI for, if type is not
 443   // BUNDLE_INSTALL_PROMPT or DELEGATED_BUNDLE_PERMISSIONS_PROMPT.
 444   const extensions::Extension* extension_;
 445
 446   // The bundle we are showing the UI for, if type BUNDLE_INSTALL_PROMPT or
 447   // DELEGATED_BUNDLE_PERMISSIONS_PROMPT.
 448   const extensions::BundleInstaller* bundle_;
 449
 450   // The name of the user we are asking about, if type
 451   // DELEGATED_PERMISSIONS_PROMPT or DELEGATED_BUNDLE_PERMISSIONS_PROMPT.
 452   std::string delegated_username_;
 453
 454   // A custom set of permissions to show in the install prompt instead of the
 455   // extension's active permissions.
 456   scoped_refptr<const extensions::PermissionSet> custom_permissions_;
 457
 458   // The object responsible for doing the UI specific actions.
 459   scoped_ptr<extensions::ExtensionInstallUI> install_ui_;
 460
 461   // Parameters to show the confirmation UI.
 462   scoped_ptr<ExtensionInstallPromptShowParams> show_params_;
 463
 464   // The delegate we will call Proceed/Abort on after confirmation UI.
 465   Delegate* delegate_;
 466
 467   // A pre-filled prompt.
 468   scoped_refptr<Prompt> prompt_;
 469
 470   // Used to show the confirm dialog.
 471   ShowDialogCallback show_dialog_callback_;
 472 };
 473
 474 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_INSTALL_PROMPT_H_