src/chrome/browser/ui/extensions/extension_enable_flow.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_UI_EXTENSIONS_EXTENSION_ENABLE_FLOW_H_
   6 #define CHROME_BROWSER_UI_EXTENSIONS_EXTENSION_ENABLE_FLOW_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/callback.h"
  12 #include "base/compiler_specific.h"
  13 #include "base/scoped_observer.h"
  14 #include "chrome/browser/extensions/extension_install_prompt.h"
  15 #include "content/public/browser/notification_observer.h"
  16 #include "content/public/browser/notification_registrar.h"
  17 #include "extensions/browser/extension_registry_observer.h"
  18
  19 class ExtensionEnableFlowDelegate;
  20
  21 namespace content {
  22 class WebContents;
  23 }
  24
  25 namespace extensions {
  26 class ExtensionRegistry;
  27 }
  28
  29 // ExtensionEnableFlow performs an UI flow to enable a disabled/terminated
  30 // extension. It calls its delegate when enabling is done or is aborted.
  31 // Callback on the delegate might be called synchronously if there is no
  32 // permission change while the extension is disabled/terminated (or the
  33 // extension is enabled already). Otherwise, a re-enable install prompt is
  34 // shown to user. The extension is enabled when user acknowledges it or the
  35 // flow is aborted when user declines it.
  36 class ExtensionEnableFlow : public ExtensionInstallPrompt::Delegate,
  37                             public content::NotificationObserver,
  38                             public extensions::ExtensionRegistryObserver {
  39  public:
  40   ExtensionEnableFlow(Profile* profile,
  41                       const std::string& extension_id,
  42                       ExtensionEnableFlowDelegate* delegate);
  43   ~ExtensionEnableFlow() override;
  44
  45   // Starts the flow and the logic continues on |delegate_| after enabling is
  46   // finished or aborted. Note that |delegate_| could be called synchronously
  47   // before this call returns when there is no need to show UI to finish the
  48   // enabling flow. Three variations of the flow are supported:
  49   //   - one with a parent WebContents
  50   //   - one with a native parent window
  51   //   - one with a callback for creating a parent window
  52   void StartForWebContents(content::WebContents* parent_contents);
  53   void StartForNativeWindow(gfx::NativeWindow parent_window);
  54   void StartForCurrentlyNonexistentWindow(
  55       base::Callback<gfx::NativeWindow(void)> window_getter);
  56
  57   const std::string& extension_id() const { return extension_id_; }
  58
  59  private:
  60   // Runs the enable flow. It starts by checking if the extension is loaded.
  61   // If not, it tries to reload it. If the load is asynchronous, wait for the
  62   // load to finish before continuing the flow. Otherwise, calls
  63   // CheckPermissionAndMaybePromptUser finish the flow.
  64   void Run();
  65
  66   // Checks if there is permission escalation while the extension is
  67   // disabled/terminated. If no, enables the extension and notify |delegate_|
  68   // synchronously. Otherwise, creates an ExtensionInstallPrompt and asks user
  69   // to confirm.
  70   void CheckPermissionAndMaybePromptUser();
  71
  72   // Creates an ExtensionInstallPrompt in |prompt_|.
  73   void CreatePrompt();
  74
  75   // Starts/stops observing extension load notifications.
  76   void StartObserving();
  77   void StopObserving();
  78
  79   // content::NotificationObserver overrides:
  80   void Observe(int type,
  81                const content::NotificationSource& source,
  82                const content::NotificationDetails& details) override;
  83
  84   // extensions::ExtensionRegistryObserver overrides:
  85   void OnExtensionLoaded(content::BrowserContext* browser_context,
  86                          const extensions::Extension* extension) override;
  87   void OnExtensionUninstalled(content::BrowserContext* browser_context,
  88                               const extensions::Extension* extension,
  89                               extensions::UninstallReason reason) override;
  90
  91   // ExtensionInstallPrompt::Delegate overrides:
  92   void InstallUIProceed() override;
  93   void InstallUIAbort(bool user_initiated) override;
  94
  95   Profile* const profile_;
  96   const std::string extension_id_;
  97   ExtensionEnableFlowDelegate* const delegate_;  // Not owned.
  98
  99   // Parent web contents for ExtensionInstallPrompt that may be created during
 100   // the flow. Note this is mutually exclusive with |parent_window_| below.
 101   content::WebContents* parent_contents_;
 102
 103   // Parent native window for ExtensionInstallPrompt. Note this is mutually
 104   // exclusive with |parent_contents_| above.
 105   gfx::NativeWindow parent_window_;
 106
 107   // Called to acquire a parent window for the prompt. This is used for clients
 108   // who only want to create a window if it is required.
 109   base::Callback<gfx::NativeWindow(void)> window_getter_;
 110
 111   scoped_ptr<ExtensionInstallPrompt> prompt_;
 112   content::NotificationRegistrar registrar_;
 113
 114   // Listen to extension load notification.
 115   ScopedObserver<extensions::ExtensionRegistry,
 116                  extensions::ExtensionRegistryObserver>
 117       extension_registry_observer_;
 118
 119   DISALLOW_COPY_AND_ASSIGN(ExtensionEnableFlow);
 120 };
 121
 122 #endif  // CHROME_BROWSER_UI_EXTENSIONS_EXTENSION_ENABLE_FLOW_H_