src/chrome/browser/extensions/extension_message_bubble_controller.h

   1 // Copyright (c) 2013 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_MESSAGE_BUBBLE_CONTROLLER_H_
   6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_MESSAGE_BUBBLE_CONTROLLER_H_
   7
   8 #include <string>
   9 #include "chrome/browser/extensions/extension_message_bubble.h"
  10 #include "extensions/browser/browser_context_keyed_api_factory.h"
  11 #include "extensions/common/extension.h"
  12
  13 class Browser;
  14 class Profile;
  15
  16 namespace extensions {
  17
  18 class ExtensionPrefs;
  19 class SuspiciousExtensionBubble;
  20
  21 class ExtensionMessageBubbleController {
  22  public:
  23   // UMA histogram constants.
  24   enum BubbleAction {
  25     ACTION_LEARN_MORE = 0,
  26     ACTION_EXECUTE,
  27     ACTION_DISMISS,
  28     ACTION_BOUNDARY, // Must be the last value.
  29   };
  30
  31   class Delegate {
  32    public:
  33     explicit Delegate(Profile* profile);
  34     virtual ~Delegate();
  35
  36     virtual bool ShouldIncludeExtension(const std::string& extension_id) = 0;
  37     virtual void AcknowledgeExtension(
  38         const std::string& extension_id,
  39         BubbleAction action) = 0;
  40     virtual void PerformAction(const ExtensionIdList& list) = 0;
  41     virtual void OnClose() {}
  42
  43     // Text for various UI labels shown in the bubble.
  44     virtual base::string16 GetTitle() const = 0;
  45     // Fetches the message to show in the body. |anchored_to_browser_action|
  46     // will be true if the bubble is anchored against a specific extension
  47     // icon, allowing the bubble to show a different message than when it is
  48     // anchored against something else (e.g. show "This extension has..."
  49     // instead of "An extension has...").
  50     virtual base::string16 GetMessageBody(
  51         bool anchored_to_browser_action) const = 0;
  52     virtual base::string16 GetOverflowText(
  53         const base::string16& overflow_count) const = 0;
  54     virtual base::string16 GetLearnMoreLabel() const;
  55     virtual GURL GetLearnMoreUrl() const = 0;
  56     virtual base::string16 GetActionButtonLabel() const = 0;
  57     virtual base::string16 GetDismissButtonLabel() const = 0;
  58
  59     // Whether to show a list of extensions in the bubble.
  60     virtual bool ShouldShowExtensionList() const = 0;
  61
  62     // In some cases, we want the delegate only to handle a single extension
  63     // and this sets which extension.
  64     virtual void RestrictToSingleExtension(const std::string& extension_id);
  65
  66     // Record, through UMA, how many extensions were found.
  67     virtual void LogExtensionCount(size_t count) = 0;
  68     virtual void LogAction(BubbleAction action) = 0;
  69
  70     // Has the user acknowledged info about the extension the bubble reports.
  71     virtual bool HasBubbleInfoBeenAcknowledged(const std::string& extension_id);
  72     virtual void SetBubbleInfoBeenAcknowledged(const std::string& extension_id,
  73                                                bool value);
  74
  75    protected:
  76     Profile* profile() const;
  77
  78     std::string get_acknowledged_flag_pref_name() const;
  79     void set_acknowledged_flag_pref_name(std::string pref_name);
  80
  81    private:
  82     // A weak pointer to the profile we are associated with. Not owned by us.
  83     Profile* profile_;
  84
  85     // Name for corresponding pref that keeps if the info the bubble contains
  86     // was acknowledged by user.
  87     std::string acknowledged_pref_name_;
  88   };
  89
  90   ExtensionMessageBubbleController(Delegate* delegate, Profile* profile);
  91   virtual ~ExtensionMessageBubbleController();
  92
  93   Delegate* delegate() const { return delegate_.get(); }
  94
  95   // Obtains a list of all extensions (by name) the controller knows about.
  96   std::vector<base::string16> GetExtensionList();
  97
  98   // Obtains a list of all extensions (by id) the controller knows about.
  99   const ExtensionIdList& GetExtensionIdList();
 100
 101   // Whether to close the bubble when it loses focus.
 102   virtual bool CloseOnDeactivate();
 103
 104   // Sets up the callbacks and shows the bubble.
 105   virtual void Show(ExtensionMessageBubble* bubble);
 106
 107   // Callbacks from bubble. Declared virtual for testing purposes.
 108   virtual void OnBubbleAction();
 109   virtual void OnBubbleDismiss();
 110   virtual void OnLinkClicked();
 111
 112  private:
 113   // Iterate over the known extensions and acknowledge each one.
 114   void AcknowledgeExtensions();
 115
 116   // Get the data this class needs.
 117   ExtensionIdList* GetOrCreateExtensionList();
 118
 119   // A weak pointer to the profile we are associated with. Not owned by us.
 120   Profile* profile_;
 121
 122   // The list of extensions found.
 123   ExtensionIdList extension_list_;
 124
 125   // The action the user took in the bubble.
 126   BubbleAction user_action_;
 127
 128   // Our delegate supplying information about what to show in the dialog.
 129   scoped_ptr<Delegate> delegate_;
 130
 131   // Whether this class has initialized.
 132   bool initialized_;
 133
 134   DISALLOW_COPY_AND_ASSIGN(ExtensionMessageBubbleController);
 135 };
 136
 137 }  // namespace extensions
 138
 139 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_MESSAGE_BUBBLE_CONTROLLER_H_