chrome/browser/extensions/activity_log/uma_policy.h

   1 // Copyright 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_ACTIVITY_LOG_UMA_POLICY_H_
   6 #define CHROME_BROWSER_EXTENSIONS_ACTIVITY_LOG_UMA_POLICY_H_
   7
   8 #include <map>
   9 #include <string>
  10
  11 #include "chrome/browser/extensions/activity_log/activity_log_policy.h"
  12 #include "chrome/browser/ui/browser_list_observer.h"
  13 #include "chrome/browser/ui/tabs/tab_strip_model_observer.h"
  14 #include "url/gurl.h"
  15
  16 namespace extensions {
  17
  18 // The UmaPolicy keeps track of how many extensions have read from or modified
  19 // a given pageload. UmaPolicy records to a histogram when a given tab is
  20 // closed. Caveats:
  21 //   * If multiple tabs are open for the same URL at the same time, UmaPolicy
  22 //     treats them as if they are the same.
  23 //   * UmaPolicy does not record statistics for incognito tabs. (For privacy.)
  24 //   * If the number of tabs open exceeds 50, UmaPolicy stops recording stats
  25 //     for tabs 51+. (For memory.)
  26 //   * UmaPolicy only handles top frames; stats are not recorded for iframes.
  27 class UmaPolicy : public ActivityLogPolicy,
  28                   public TabStripModelObserver,
  29                   public chrome::BrowserListObserver {
  30  public:
  31   // The possible status bits for a pageload. If you alter this, make sure to
  32   // also update GetHistogramName.
  33   enum PageStatus {
  34     NONE = 0,
  35     CONTENT_SCRIPT = 1,
  36     READ_DOM,
  37     MODIFIED_DOM,
  38     DOM_METHOD,
  39     DOCUMENT_WRITE,
  40     INNER_HTML,
  41     CREATED_SCRIPT,
  42     CREATED_IFRAME,
  43     CREATED_DIV,
  44     CREATED_LINK,
  45     CREATED_INPUT,
  46     CREATED_EMBED,
  47     CREATED_OBJECT,
  48     AD_INJECTED,
  49     AD_REMOVED,
  50     AD_REPLACED,
  51     MAX_STATUS  // Insert new page statuses right before this one.
  52   };
  53
  54   explicit UmaPolicy(Profile* profile);
  55
  56   // ActivityLogPolicy implementation.
  57   virtual void ProcessAction(scoped_refptr<Action> action) OVERRIDE;
  58   virtual void Close() OVERRIDE;
  59
  60   // Gets the histogram name associated with each PageStatus.
  61   static const char* GetHistogramName(PageStatus status);
  62
  63  protected:
  64   // Run when Close() is called.
  65   virtual ~UmaPolicy();
  66
  67  private:
  68   // Used as a special key in the ExtensionMap.
  69   static const char kNumberOfTabs[];
  70
  71   // The max number of tabs we track at a time.
  72   static const size_t kMaxTabsTracked;
  73
  74   typedef std::map<std::string, int> ExtensionMap;
  75   typedef std::map<std::string, ExtensionMap> SiteMap;
  76
  77   // BrowserListObserver
  78   virtual void OnBrowserAdded(Browser* browser) OVERRIDE;
  79   virtual void OnBrowserRemoved(Browser* browser) OVERRIDE;
  80
  81   // TabStripModelObserver
  82   // Fired when a page loads, either as a new tab or replacing the contents of
  83   // an older tab.
  84   virtual void TabChangedAt(content::WebContents* contents,
  85                             int index,
  86                             TabChangeType change_type) OVERRIDE;
  87   // Fired when a tab closes.
  88   virtual void TabClosingAt(TabStripModel* tab_strip_model,
  89                             content::WebContents* contents,
  90                             int index) OVERRIDE;
  91
  92   // Assign a status bitmask based on the action's properties.
  93   int MatchActionToStatus(scoped_refptr<Action> action);
  94
  95   // When a page is opened, add it to the SiteMap url_status_.
  96   void SetupOpenedPage(const std::string& url);
  97
  98   // When a page is closing, remove it from the SiteMap url_status_.
  99   void CleanupClosedPage(const std::string& url);
 100
 101   // When a page is closing, save statistics about the page to histograms.
 102   void HistogramOnClose(const std::string& url);
 103
 104   // Standardizes the way URLs are treated.
 105   static std::string CleanURL(const GURL& gurl);
 106
 107   // Used by UmaPolicyTest.ProcessActionTest.
 108   SiteMap url_status() { return url_status_; }
 109
 110   Profile* profile_;
 111
 112   // URL -> extension id -> page status.
 113   SiteMap url_status_;
 114
 115   // tab index -> URL.
 116   std::map<int32, std::string> tab_list_;
 117
 118   FRIEND_TEST_ALL_PREFIXES(UmaPolicyTest, CleanURLTest);
 119   FRIEND_TEST_ALL_PREFIXES(UmaPolicyTest, MatchActionToStatusTest);
 120   FRIEND_TEST_ALL_PREFIXES(UmaPolicyTest, ProcessActionTest);
 121   FRIEND_TEST_ALL_PREFIXES(UmaPolicyTest, SiteUrlTest);
 122 };
 123
 124 }  // namespace extensions
 125
 126 #endif  // CHROME_BROWSER_EXTENSIONS_ACTIVITY_LOG_UMA_POLICY_H_