Update extension events, routing, and delivery to use user gesture.

chrome/browser/extensions/extension_event_router.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_EVENT_ROUTER_H_
 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_EVENT_ROUTER_H_
 #pragma once
 
 #include <map>
 #include <set>
@@ skipping 16 matching lines @@
 }
 
 class ExtensionEventRouter : public content::NotificationObserver {
  public:
   // Sends an event via ipc_sender to the given extension. Can be called on
   // any thread.
   static void DispatchEvent(IPC::Message::Sender* ipc_sender,
                             const std::string& extension_id,
                             const std::string& event_name,
                             const std::string& event_args,
-                            const GURL& event_url);
+                            const GURL& event_url,
+                            bool user_caused = false);

[Aaron Boodman, 2012/02/03 20:18:47]

I suggest consistently using the term 'user_gesture' since it has a specific
security meaning in browsers. It's more self-documenting that way.

[Aaron Boodman, 2012/02/03 20:18:47]

Also, consider using an enum for this flag, like:

enum UserGesture {
  IsUserGesture
  NotUserGesture
}

This might make the code more readable than the boolean flag.

[Matt Perry, 2012/02/03 20:34:41]

Default arguments are forbidden by the style guide.

[Greg Billock, 2012/02/03 22:57:56]

My plan was to only set the gesture indicator when the flag is on. Shall I
instead make an enum (including a "UnknownUserGesture" value) and make it always
use the passed gesture indicator unless it is unknown? (WebKit has three: Yes,
No, and Possible)

[Greg Billock, 2012/02/06 22:58:01]

Done.

[Greg Billock, 2012/02/06 22:58:01]

Done.

[Greg Billock, 2012/02/06 22:58:01]

Done.

 
   explicit ExtensionEventRouter(Profile* profile);
   virtual ~ExtensionEventRouter();
 
   // Add or remove the process/extension pair as a listener for |event_name|.
   // Note that multiple extensions can share a process due to process
   // collapsing. Also, a single extension can have 2 processes if it is a split
   // mode extension.
   void AddEventListener(const std::string& event_name,
                         content::RenderProcessHost* process,
@@ skipping 12 matching lines @@
   // Send an event to every registered extension renderer. If
   // |restrict_to_profile| is non-NULL, then the event will not be sent to other
   // profiles unless the extension has permission (e.g. incognito tab update ->
   // normal profile only works if extension is allowed incognito access). If
   // |event_url| is not empty, the event is only sent to extension with host
   // permissions for this url.
   void DispatchEventToRenderers(
       const std::string& event_name,
       const std::string& event_args,
       Profile* restrict_to_profile,
-      const GURL& event_url);
+      const GURL& event_url,
+      bool user_caused = false);
 
   // Same as above, except only send the event to the given extension.
   virtual void DispatchEventToExtension(
       const std::string& extension_id,
       const std::string& event_name,
       const std::string& event_args,
       Profile* restrict_to_profile,
-      const GURL& event_url);
+      const GURL& event_url,
+      bool user_caused = false);
 
   // Send different versions of an event to extensions in different profiles.
   // This is used in the case of sending one event to extensions that have
   // incognito access, and another event to extensions that don't (here),
   // in order to avoid sending 2 events to "spanning" extensions.
   // If |cross_incognito_profile| is non-NULL and different from
   // restrict_to_profile, send the event with cross_incognito_args to the
   // extensions in that profile that can't cross incognito.
   void DispatchEventsToRenderersAcrossIncognito(
       const std::string& event_name,
       const std::string& event_args,
       Profile* restrict_to_profile,
       const std::string& cross_incognito_args,
-      const GURL& event_url);
+      const GURL& event_url,
+      bool user_caused = false);
 
   // Record the Event Ack from the renderer. (One less event in-flight.)
   void OnExtensionEventAck(const std::string& extension_id);
 
   // Check if there are any Extension Events that have not yet been acked by
   // the renderer.
   bool HasInFlightEvents(const std::string& extension_id);
 
  protected:
   // The details of an event to be dispatched.
@@ skipping 41 matching lines @@
 
   // Track of the number of dispatched events that have not yet sent an
   // ACK from the renderer.
   void IncrementInFlightEvents(const Extension* extension);
   std::map<std::string, int> in_flight_events_;
 
   DISALLOW_COPY_AND_ASSIGN(ExtensionEventRouter);
 };
 
 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_EVENT_ROUTER_H_